@chatbotkit/react 1.11.0 → 1.13.0

package/dist/cjs/actions/complete.cjs

@@ -59,6 +59,9 @@ async function* complete({ client, messages, functions, maxRecusion = 3, ...opti
     }
     for await (const item of it) {
         yield item;
+        if (options.onItem) {
+            await options.onItem(item);
+        }
         const { type, data } = item;
         if (type === 'message') {
             const message = data;
@@ -184,6 +187,9 @@ async function* complete({ client, messages, functions, maxRecusion = 3, ...opti
             }
         }
     }
+    if (options.onFinish) {
+        await options.onFinish({ messages });
+    }
 }
 function streamComplete(options) {
     return (0, stream_js_1.stream)(complete(options));

package/dist/cjs/actions/complete.d.ts

@@ -2,6 +2,10 @@ export function streamComplete(options: Options): import('../utils/stream.cjs').
 export default complete;
 export type ReactElement = import('react').ReactElement;
 export type ReactNode = import('react').ReactNode;
+export type Item = {
+    type: string;
+    data: object;
+};
 export type BasicParametersSchema = Record<string, any>;
 export type ValidatingParametersSchema = {
     schema: BasicParametersSchema;
@@ -15,6 +19,12 @@ export type InputMessage = {
     text: string;
     meta?: Record<string, any>;
 };
+export type OutputMessage = {
+    type: 'bot' | 'activity';
+    text: string;
+    meta?: Record<string, any>;
+};
+export type Message = InputMessage | OutputMessage;
 export type RenderFunction = () => AsyncGenerator<ReactNode> | ReactNode | Promise<ReactNode>;
 export type HandlerArgs = any;
 export type HandlerOptions = {
@@ -39,10 +49,16 @@ export type InputFunction = {
     parameters: BasicParametersSchema | ValidatingParametersSchema;
     handler?: (args: HandlerArgs, options: HandlerOptions) => Promise<HandlerResult>;
 };
+export type OnItemHandler = (arg0: Item) => any;
+export type OnFinishHandler = (arg0: {
+    messages: Message[];
+}) => any;
 export type Options = Omit<any, 'messages' | 'functions'> & {
     client: import('@chatbotkit/sdk').ConversationClient;
     messages: InputMessage[];
     functions?: (InputFunction | (() => InputFunction | Promise<InputFunction>))[];
     maxRecusion?: number;
+    onItem?: OnItemHandler;
+    onFinish?: OnFinishHandler;
 };
 declare function complete({ client, messages, functions, maxRecusion, ...options }: Options): any;

package/dist/cjs/hooks/useWidgetInstance.cjs

@@ -0,0 +1,24 @@
+'use client';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useWidgetInstance = void 0;
+const react_1 = require("react");
+function useWidgetInstance() {
+    const [instance, setInstance] = (0, react_1.useState)(null);
+    (0, react_1.useEffect)(() => {
+        if (window.chatbotkitWidget) {
+            window.chatbotkitWidget.instancePromise.then((instance) => setInstance(instance));
+            return;
+        }
+        function onInit() {
+            window.chatbotkitWidget.instancePromise.then((instance) => setInstance(instance));
+        }
+        window.addEventListener('chatbotkitWidgetInit', onInit);
+        return () => {
+            window.removeEventListener('chatbotkitWidgetInit', onInit);
+        };
+    }, []);
+    return instance;
+}
+exports.useWidgetInstance = useWidgetInstance;
+exports.default = useWidgetInstance;

package/dist/cjs/hooks/useWidgetInstance.d.ts

@@ -0,0 +1,22 @@
+export function useWidgetInstance(): ChatBotKitWidgetInstance | null;
+export default useWidgetInstance;
+export type WidgetMessage = {
+    id: string;
+    type: string;
+    text: string;
+};
+export type WidgetNotification = {
+    text: string;
+};
+export type WidgetFunction = {
+    description: string;
+    parameters: Record<string, any>;
+    results: {
+        data: any;
+    };
+};
+export type ChatBotKitWidgetInstance = {
+    messages?: WidgetMessage[] | null;
+    notifications?: Record<string, WidgetNotification> | null;
+    functions?: Record<string, WidgetFunction> | null;
+};

package/dist/cjs/hooks/useWidgetInstanceFunctions.cjs

@@ -0,0 +1,23 @@
+'use client';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useWidgetInstanceFunctions = void 0;
+const tslib_1 = require("tslib");
+const react_1 = require("react");
+const useWidgetInstance_js_1 = tslib_1.__importDefault(require("./useWidgetInstance.cjs"));
+function useWidgetInstanceFunctions(params) {
+    const instance = (0, useWidgetInstance_js_1.default)();
+    (0, react_1.useEffect)(() => {
+        if (!instance) {
+            return;
+        }
+        if ((params === null || params === void 0 ? void 0 : params.functions) === undefined) {
+            return;
+        }
+        instance.functions = {
+            ...params === null || params === void 0 ? void 0 : params.functions,
+        };
+    }, [params === null || params === void 0 ? void 0 : params.functions, instance]);
+}
+exports.useWidgetInstanceFunctions = useWidgetInstanceFunctions;
+exports.default = useWidgetInstanceFunctions;

package/dist/cjs/hooks/useWidgetInstanceFunctions.d.ts

@@ -0,0 +1,5 @@
+export function useWidgetInstanceFunctions(params?: {
+    functions?: Record<string, WidgetFunction> | null;
+}): void;
+export default useWidgetInstanceFunctions;
+export type WidgetFunction = import('./useWidgetInstance.cjs').WidgetFunction;

package/dist/cjs/hooks/useWidgetInstanceNotifications.cjs

@@ -0,0 +1,23 @@
+'use client';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useWidgetInstanceNotifications = void 0;
+const tslib_1 = require("tslib");
+const react_1 = require("react");
+const useWidgetInstance_js_1 = tslib_1.__importDefault(require("./useWidgetInstance.cjs"));
+function useWidgetInstanceNotifications(params) {
+    const instance = (0, useWidgetInstance_js_1.default)();
+    (0, react_1.useEffect)(() => {
+        if (!instance) {
+            return;
+        }
+        if ((params === null || params === void 0 ? void 0 : params.notifications) == undefined) {
+            return;
+        }
+        instance.notifications = {
+            ...params === null || params === void 0 ? void 0 : params.notifications,
+        };
+    }, [params === null || params === void 0 ? void 0 : params.notifications, instance]);
+}
+exports.useWidgetInstanceNotifications = useWidgetInstanceNotifications;
+exports.default = useWidgetInstanceNotifications;

package/dist/cjs/hooks/useWidgetInstanceNotifications.d.ts

@@ -0,0 +1,5 @@
+export function useWidgetInstanceNotifications(params?: {
+    notifications?: Record<string, WidgetNotification> | null;
+}): void;
+export default useWidgetInstanceNotifications;
+export type WidgetNotification = import('./useWidgetInstance.cjs').WidgetNotification;

package/dist/cjs/utils/stream.cjs

@@ -1,31 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.consume = exports.stream = void 0;
-function stream(source) {
+function streamIt(source) {
     let it;
     if ('next' in source && typeof source.next === 'function') {
         it = source.next();
     }
     else if ('stream' in source && typeof source.stream === 'function') {
-        return stream(source.stream());
+        return streamIt(source.stream());
     }
     else {
         throw new Error('Invalid source');
     }
     return new Promise((resolve, reject) => {
-        it.then((res) => {
+        it.then(async (res) => {
             if (res.done) {
                 resolve({ iteratorResult: res });
             }
             else {
-                resolve({ iteratorResult: res, next: stream(source) });
+                resolve({ iteratorResult: res, next: streamIt(source) });
             }
         });
         it.catch((error) => reject(error));
     });
 }
+async function* stream(source, options) {
+    yield* streamIt(source);
+    if (options === null || options === void 0 ? void 0 : options.onFinish) {
+        await options.onFinish();
+    }
+}
 exports.stream = stream;
-function consume(source) {
+function consumeIt(source) {
     return {
         [Symbol.asyncIterator]: function () {
             return {
@@ -44,4 +50,10 @@ function consume(source) {
         },
     };
 }
+async function* consume(source, options) {
+    yield* consumeIt(source);
+    if (options === null || options === void 0 ? void 0 : options.onFinish) {
+        await options.onFinish();
+    }
+}
 exports.consume = consume;

package/dist/cjs/utils/stream.d.ts

@@ -1,6 +1,11 @@
-export function stream(source: StreamSource): StreamResult;
-export function consume(source: ConsumeSource): ConsumeResult;
+export function stream(source: StreamSource, options?: StreamOptions): StreamResult;
+export function consume(source: ConsumeSource, options?: ConsumeOptions): ConsumeResult;
+export type Handlers = {
+    onFinish?: () => any;
+};
 export type StreamSource = any;
 export type StreamResult = any;
+export type StreamOptions = {} & Handlers;
 export type ConsumeSource = any;
 export type ConsumeResult = any;
+export type ConsumeOptions = {} & Handlers;

package/dist/esm/actions/complete.d.ts

@@ -2,6 +2,10 @@ export function streamComplete(options: Options): import('../utils/stream.js').S
 export default complete;
 export type ReactElement = import('react').ReactElement;
 export type ReactNode = import('react').ReactNode;
+export type Item = {
+    type: string;
+    data: object;
+};
 export type BasicParametersSchema = Record<string, any>;
 export type ValidatingParametersSchema = {
     schema: BasicParametersSchema;
@@ -15,6 +19,12 @@ export type InputMessage = {
     text: string;
     meta?: Record<string, any>;
 };
+export type OutputMessage = {
+    type: 'bot' | 'activity';
+    text: string;
+    meta?: Record<string, any>;
+};
+export type Message = InputMessage | OutputMessage;
 export type RenderFunction = () => AsyncGenerator<ReactNode> | ReactNode | Promise<ReactNode>;
 export type HandlerArgs = any;
 export type HandlerOptions = {
@@ -39,10 +49,16 @@ export type InputFunction = {
     parameters: BasicParametersSchema | ValidatingParametersSchema;
     handler?: ((args: HandlerArgs, options: HandlerOptions) => Promise<HandlerResult>) | undefined;
 };
+export type OnItemHandler = (arg0: Item) => any;
+export type OnFinishHandler = (arg0: {
+    messages: Message[];
+}) => any;
 export type Options = Omit<import('@chatbotkit/sdk/conversation/v1.js').ConversationCompleteRequest, 'messages' | 'functions'> & {
     client: import('@chatbotkit/sdk').ConversationClient;
     messages: InputMessage[];
     functions?: (InputFunction | (() => InputFunction | Promise<InputFunction>))[];
     maxRecusion?: number;
+    onItem?: OnItemHandler;
+    onFinish?: OnFinishHandler;
 };
 declare function complete({ client, messages, functions, maxRecusion, ...options }: Options): any;

package/dist/esm/actions/complete.js

@@ -55,6 +55,9 @@ async function* complete({ client, messages, functions, maxRecusion = 3, ...opti
     }
     for await (const item of it) {
         yield item;
+        if (options.onItem) {
+            await options.onItem(item);
+        }
         const { type, data } = item;
         if (type === 'message') {
             const message = data;
@@ -180,6 +183,9 @@ async function* complete({ client, messages, functions, maxRecusion = 3, ...opti
             }
         }
     }
+    if (options.onFinish) {
+        await options.onFinish({ messages });
+    }
 }
 export function streamComplete(options) {
     return stream(complete(options));

package/dist/esm/hooks/useWidgetInstance.d.ts

@@ -0,0 +1,22 @@
+export function useWidgetInstance(): ChatBotKitWidgetInstance | null;
+export default useWidgetInstance;
+export type WidgetMessage = {
+    id: string;
+    type: string;
+    text: string;
+};
+export type WidgetNotification = {
+    text: string;
+};
+export type WidgetFunction = {
+    description: string;
+    parameters: Record<string, any>;
+    results: {
+        data: any;
+    };
+};
+export type ChatBotKitWidgetInstance = {
+    messages?: WidgetMessage[] | null;
+    notifications?: Record<string, WidgetNotification> | null;
+    functions?: Record<string, WidgetFunction> | null;
+};

package/dist/esm/hooks/useWidgetInstance.js

@@ -0,0 +1,20 @@
+'use client';
+import { useEffect, useState } from 'react';
+export function useWidgetInstance() {
+    const [instance, setInstance] = useState(null);
+    useEffect(() => {
+        if (window.chatbotkitWidget) {
+            window.chatbotkitWidget.instancePromise.then((instance) => setInstance(instance));
+            return;
+        }
+        function onInit() {
+            window.chatbotkitWidget.instancePromise.then((instance) => setInstance(instance));
+        }
+        window.addEventListener('chatbotkitWidgetInit', onInit);
+        return () => {
+            window.removeEventListener('chatbotkitWidgetInit', onInit);
+        };
+    }, []);
+    return instance;
+}
+export default useWidgetInstance;

package/dist/esm/hooks/useWidgetInstanceFunctions.d.ts

@@ -0,0 +1,5 @@
+export function useWidgetInstanceFunctions(params?: {
+    functions?: Record<string, import("./useWidgetInstance.js").WidgetFunction> | null | undefined;
+} | undefined): void;
+export default useWidgetInstanceFunctions;
+export type WidgetFunction = import('./useWidgetInstance.js').WidgetFunction;

package/dist/esm/hooks/useWidgetInstanceFunctions.js

@@ -0,0 +1,18 @@
+'use client';
+import { useEffect } from 'react';
+import useWidgetInstance from './useWidgetInstance.js';
+export function useWidgetInstanceFunctions(params) {
+    const instance = useWidgetInstance();
+    useEffect(() => {
+        if (!instance) {
+            return;
+        }
+        if (params?.functions === undefined) {
+            return;
+        }
+        instance.functions = {
+            ...params?.functions,
+        };
+    }, [params?.functions, instance]);
+}
+export default useWidgetInstanceFunctions;

package/dist/esm/hooks/useWidgetInstanceNotifications.d.ts

@@ -0,0 +1,5 @@
+export function useWidgetInstanceNotifications(params?: {
+    notifications?: Record<string, import("./useWidgetInstance.js").WidgetNotification> | null | undefined;
+} | undefined): void;
+export default useWidgetInstanceNotifications;
+export type WidgetNotification = import('./useWidgetInstance.js').WidgetNotification;

package/dist/esm/hooks/useWidgetInstanceNotifications.js

@@ -0,0 +1,18 @@
+'use client';
+import { useEffect } from 'react';
+import useWidgetInstance from './useWidgetInstance.js';
+export function useWidgetInstanceNotifications(params) {
+    const instance = useWidgetInstance();
+    useEffect(() => {
+        if (!instance) {
+            return;
+        }
+        if (params?.notifications == undefined) {
+            return;
+        }
+        instance.notifications = {
+            ...params?.notifications,
+        };
+    }, [params?.notifications, instance]);
+}
+export default useWidgetInstanceNotifications;

package/dist/esm/utils/stream.d.ts

@@ -1,6 +1,11 @@
-export function stream(source: StreamSource): StreamResult;
-export function consume(source: ConsumeSource): ConsumeResult;
+export function stream(source: StreamSource, options?: Handlers | undefined): StreamResult;
+export function consume(source: ConsumeSource, options?: Handlers | undefined): ConsumeResult;
+export type Handlers = {
+    onFinish?: () => any;
+};
 export type StreamSource = any;
 export type StreamResult = any;
+export type StreamOptions = {} & Handlers;
 export type ConsumeSource = any;
 export type ConsumeResult = any;
+export type ConsumeOptions = {} & Handlers;

package/dist/esm/utils/stream.js

@@ -1,27 +1,33 @@
-export function stream(source) {
+function streamIt(source) {
     let it;
     if ('next' in source && typeof source.next === 'function') {
         it = source.next();
     }
     else if ('stream' in source && typeof source.stream === 'function') {
-        return stream(source.stream());
+        return streamIt(source.stream());
     }
     else {
         throw new Error('Invalid source');
     }
     return new Promise((resolve, reject) => {
-        it.then((res) => {
+        it.then(async (res) => {
             if (res.done) {
                 resolve({ iteratorResult: res });
             }
             else {
-                resolve({ iteratorResult: res, next: stream(source) });
+                resolve({ iteratorResult: res, next: streamIt(source) });
             }
         });
         it.catch((error) => reject(error));
     });
 }
-export function consume(source) {
+export async function* stream(source, options) {
+    yield* streamIt(source);
+    if (options?.onFinish) {
+        await options.onFinish();
+    }
+}
+function consumeIt(source) {
     return {
         [Symbol.asyncIterator]: function () {
             return {
@@ -40,3 +46,9 @@ export function consume(source) {
         },
     };
 }
+export async function* consume(source, options) {
+    yield* consumeIt(source);
+    if (options?.onFinish) {
+        await options.onFinish();
+    }
+}