Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ node_modules/

# Production build files
build/
/dist
# Environment variables
.env
.env.local
Expand Down
7 changes: 7 additions & 0 deletions dist/components/Copilot.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { type ToolDefinition } from '../types/CopilotTypes';
type Props = {
tools?: ToolDefinition | ToolDefinition[];
botName?: string | number;
};
export declare const Copilot: ({ tools, botName }: Props) => null;
export {};
16 changes: 16 additions & 0 deletions dist/components/CopilotProvider.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import React from 'react';
interface SharedProps {
children: React.ReactNode;
}
interface SingleInstance {
token: string;
config?: Record<string, any>;
scriptUrl?: string;
botName?: string;
}
interface MultiInstance {
instances: SingleInstance[];
}
type CopilotProviderProps = (SingleInstance | MultiInstance) & SharedProps;
export declare const CopilotProvider: (props: CopilotProviderProps) => import("react/jsx-runtime").JSX.Element;
export {};
2 changes: 2 additions & 0 deletions dist/core/CopilotInstanceManager.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import type { CopilotAPI } from '../types/CopilotTypes';
export declare const copilotInstances: Map<string, CopilotAPI>;
11 changes: 11 additions & 0 deletions dist/core/hooks/useCopilot.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import type { CopilotAPI, ToolDefinition } from '../../types/CopilotTypes';
export declare const useCopilot: (idOrIndex?: string | number) => {
show: () => void | undefined;
hide: () => void | undefined;
addTool: (toolOrTools: ToolDefinition | ToolDefinition[]) => void;
removeTool: (name: string) => void | undefined;
removeAllTools: () => void | undefined;
setUser: (user: Record<string, any>) => void | undefined;
unsetUser: () => void | undefined;
raw: CopilotAPI | undefined;
};
7 changes: 7 additions & 0 deletions dist/core/hooks/useCopilotTools.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type { ToolDefinition } from '../../types/CopilotTypes';
interface Options {
removeOnUnmount?: boolean;
idOrIndex?: string | number;
}
export declare const useCopilotTool: (toolOrTools: ToolDefinition | ToolDefinition[], options?: Options) => void;
export {};
6 changes: 6 additions & 0 deletions dist/core/hooks/useCopilotUser.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
interface Options {
unsetOnUnmount?: boolean;
idOrIndex?: string | number;
}
export declare const useCopilotUser: (user: Record<string, any>, options?: Options) => void;
export {};
2 changes: 2 additions & 0 deletions dist/core/waitForCopilot.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import type { CopilotAPI } from '../types/CopilotTypes';
export declare const waitForCopilot: (botName: string, timeout?: number, interval?: number) => Promise<CopilotAPI | null>;
219 changes: 219 additions & 0 deletions dist/index.cjs.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions dist/index.cjs.js.map

Large diffs are not rendered by default.

83 changes: 83 additions & 0 deletions dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import * as react_jsx_runtime from 'react/jsx-runtime';
import React from 'react';

interface SharedProps {
children: React.ReactNode;
}
interface SingleInstance {
token: string;
config?: Record<string, any>;
scriptUrl?: string;
botName?: string;
}
interface MultiInstance {
instances: SingleInstance[];
}
type CopilotProviderProps = (SingleInstance | MultiInstance) & SharedProps;
declare const CopilotProvider: (props: CopilotProviderProps) => react_jsx_runtime.JSX.Element;

type ToolParameter = {
type: string;
description?: string;
};
type ToolDefinition = {
name: string;
description: string;
parameters?: {
type: 'object';
properties: Record<string, ToolParameter>;
required?: string[];
};
timeout?: number;
handler: (args: Record<string, any>) => Promise<any> | any;
};
type CopilotAPI = {
show: () => void;
hide: () => void;
tools: {
add: (tool: ToolDefinition | ToolDefinition[]) => void;
remove: (name: string) => void;
removeAll?: () => void;
};
users: {
set: (user: Record<string, any>) => void;
unset: () => void;
};
};

type Props = {
tools?: ToolDefinition | ToolDefinition[];
botName?: string | number;
};
declare const Copilot: ({ tools, botName }: Props) => null;

/**
* Type-safe botName constraint — must match /^[a-zA-Z_$][a-zA-Z0-9_$]*$/
*/
type SafeBotName<T extends string> = T extends `${infer First}${infer Rest}` ? First extends Lowercase<First> | Uppercase<First> | '_' | '$' ? Rest extends `${string}` ? T extends `${string}-${string}` | `${string}.${string}` | `${string} ${string}` ? never : T : never : never : never;

declare const useCopilot: (idOrIndex?: string | number) => {
show: () => void | undefined;
hide: () => void | undefined;
addTool: (toolOrTools: ToolDefinition | ToolDefinition[]) => void;
removeTool: (name: string) => void | undefined;
removeAllTools: () => void | undefined;
setUser: (user: Record<string, any>) => void | undefined;
unsetUser: () => void | undefined;
raw: CopilotAPI | undefined;
};

interface Options$1 {
removeOnUnmount?: boolean;
idOrIndex?: string | number;
}
declare const useCopilotTool: (toolOrTools: ToolDefinition | ToolDefinition[], options?: Options$1) => void;

interface Options {
unsetOnUnmount?: boolean;
idOrIndex?: string | number;
}
declare const useCopilotUser: (user: Record<string, any>, options?: Options) => void;

export { Copilot, CopilotProvider, useCopilot, useCopilotTool, useCopilotUser };
export type { CopilotAPI, SafeBotName, ToolDefinition };
Loading