@opencx/widget 3.0.87 → 3.0.89

package/dist/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./widget.ctx-BIrCsbNY.cjs"),e=require("./is-exhaustive-9o43S91P.cjs");exports.PrimitiveState=t.PrimitiveState;exports.WidgetCtx=t.WidgetCtx;exports.isExhaustive=e.isExhaustive;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./widget.ctx-RfaE5VPy.cjs");function r(e,i){console.error(`Missing case for ${e} in ${i}`)}exports.PrimitiveState=t.PrimitiveState;exports.WidgetCtx=t.WidgetCtx;exports.isExhaustive=r;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"index.cjs","sources":["../src/headless/core/utils/is-exhaustive.ts"],"sourcesContent":["export function isExhaustive(value: never, funcName: string) {\n  console.error(`Missing case for ${value} in ${funcName}`);\n}\n"],"names":["isExhaustive","value","funcName"],"mappings":"6HAAgB,SAAAA,EAAaC,EAAcC,EAAkB,CAC3D,QAAQ,MAAM,oBAAoBD,CAAK,OAAOC,CAAQ,EAAE,CAC1D"}

package/dist/index.js

@@ -1,8 +1,10 @@
-import { P as e, W as a } from "./widget.ctx-D-BdBFz5.js";
-import { i as s } from "./is-exhaustive-DGJzQK69.js";
+import { P as s, W as a } from "./widget.ctx-Db3DyLM5.js";
+function t(i, e) {
+  console.error(`Missing case for ${i} in ${e}`);
+}
 export {
-  e as PrimitiveState,
+  s as PrimitiveState,
   a as WidgetCtx,
-  s as isExhaustive
+  t as isExhaustive
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.js","sources":["../src/headless/core/utils/is-exhaustive.ts"],"sourcesContent":["export function isExhaustive(value: never, funcName: string) {\n  console.error(`Missing case for ${value} in ${funcName}`);\n}\n"],"names":["isExhaustive","value","funcName"],"mappings":";AAAgB,SAAAA,EAAaC,GAAcC,GAAkB;AAC3D,UAAQ,MAAM,oBAAoBD,CAAK,OAAOC,CAAQ,EAAE;AAC1D;"}

package/dist/react.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useModes-C5Jd3NZU.cjs");function o(t,s,i){const{widgetCtx:{api:u}}=e.useWidget();return e._default(async r=>u.vote({action:r==="up"?"upvote":"downvote",messagePublicId:t,sessionId:s}).then(i),[u,t,s,i])}exports.WidgetProvider=e.WidgetProvider;exports.WidgetTriggerProvider=e.WidgetTriggerProvider;exports.useConfig=e.useConfig;exports.useContact=e.useContact;exports.useIsAwaitingBotReply=e.useIsAwaitingBotReply;exports.useMessages=e.useMessages;exports.useModes=e.useModes;exports.usePreludeData=e.usePreludeData;exports.usePrimitiveState=e.usePrimitiveState;exports.useSessions=e.useSessions;exports.useUploadFiles=e.useUploadFiles;exports.useWidget=e.useWidget;exports.useWidgetRouter=e.useWidgetRouter;exports.useWidgetTrigger=e.useWidgetTrigger;exports.useVote=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useModes-C4Sdixy0.cjs");function o(t,s,i){const{widgetCtx:{api:u}}=e.useWidget();return e._default(async r=>u.vote({action:r==="up"?"upvote":"downvote",messagePublicId:t,sessionId:s}).then(i),[u,t,s,i])}exports.WidgetProvider=e.WidgetProvider;exports.WidgetTriggerProvider=e.WidgetTriggerProvider;exports.useConfig=e.useConfig;exports.useContact=e.useContact;exports.useIsAwaitingBotReply=e.useIsAwaitingBotReply;exports.useMessages=e.useMessages;exports.useModes=e.useModes;exports.usePreludeData=e.usePreludeData;exports.usePrimitiveState=e.usePrimitiveState;exports.useSessions=e.useSessions;exports.useUploadFiles=e.useUploadFiles;exports.useWidget=e.useWidget;exports.useWidgetRouter=e.useWidgetRouter;exports.useWidgetTrigger=e.useWidgetTrigger;exports.useVote=o;
 //# sourceMappingURL=react.cjs.map

package/dist/react.js

@@ -1,5 +1,5 @@
-import { u, _ as o } from "./useModes-CCwRYrkY.js";
-import { W as p, k as l, a as f, b as v, c as W, d as c, l as m, e as P, f as w, g as x, i as C, h as b, j as h } from "./useModes-CCwRYrkY.js";
+import { u, _ as o } from "./useModes-BAr0RJcP.js";
+import { W as p, k as l, a as f, b as v, c as W, d as c, l as m, e as P, f as w, g as x, i as C, h as b, j as h } from "./useModes-BAr0RJcP.js";
 function g(e, s, t) {
   const {
     widgetCtx: { api: a }

package/dist/src/designs/react/index.d.ts

@@ -1,9 +1,10 @@
 import { default as React } from 'react';
 import { WidgetConfig } from '../../headless/core';
-import { WidgetComponentType } from '../../headless/react';
-declare function WidgetWrapper({ options, components, loadingComponent, }: {
+import { WidgetComponentType, WidgetModeComponentType } from '../../headless/react';
+declare function WidgetWrapper({ options, components, modesComponents, loadingComponent, }: {
     options: WidgetConfig;
     components?: WidgetComponentType[];
+    modesComponents?: WidgetModeComponentType[];
     loadingComponent?: React.ReactNode;
 }): React.JSX.Element;
 export { WidgetWrapper as Widget };

package/dist/src/designs/react/screens/chat/ChatCanvas.d.ts

@@ -1,2 +1,2 @@
 import { default as React } from 'react';
-export declare function ChatCanvas(): React.JSX.Element;
+export declare function ChatCanvas(): React.JSX.Element | null;

package/dist/src/headless/core/__tests__/test-utils.d.ts

@@ -183,6 +183,7 @@ export declare const TestUtils: {
                     custom_data?: {
                         [key: string]: unknown;
                     } | null;
+                    exit_mode_prompt?: string;
                 };
                 signal: AbortSignal | undefined;
             }, `${string}/${string}`>> | undefined): void;
@@ -375,6 +376,44 @@ export declare const TestUtils: {
                 };
                 signal: AbortSignal | undefined;
             }, `${string}/${string}`>> | undefined): void;
+            createStateCheckpoint(target: typeof ApiCaller, returnValue: Partial<import('openapi-fetch').FetchResponse<{
+                parameters: {
+                    query?: never;
+                    header?: never;
+                    path?: never;
+                    cookie?: never;
+                };
+                requestBody: {
+                    content: {
+                        "application/json": import('../api/schema').components["schemas"]["WidgetCreateStateCheckpointInputDto"];
+                    };
+                };
+                responses: {
+                    200: {
+                        headers: {
+                            [name: string]: unknown;
+                        };
+                        content: {
+                            "application/json": import('../api/schema').components["schemas"]["WidgetCreateStateCheckpointOutputDto"];
+                        };
+                    };
+                    500: {
+                        headers: {
+                            [name: string]: unknown;
+                        };
+                        content: {
+                            "application/json": import('../api/schema').components["schemas"]["ErrorDto"];
+                        };
+                    };
+                };
+            }, {
+                body: {
+                    session_id: string;
+                    payload: {
+                        [key: string]: unknown;
+                    };
+                };
+            }, `${string}/${string}`>> | undefined): void;
         };
     };
 };

package/dist/src/headless/core/api/api-caller.d.ts

@@ -140,6 +140,7 @@ export declare class ApiCaller {
             custom_data?: {
                 [key: string]: unknown;
             } | null;
+            exit_mode_prompt?: string;
         };
         signal: AbortSignal | undefined;
     }, `${string}/${string}`>>;
@@ -395,4 +396,42 @@ export declare class ApiCaller {
         };
         signal: AbortSignal | undefined;
     }, `${string}/${string}`>>;
+    createStateCheckpoint: (body: Dto["WidgetCreateStateCheckpointInputDto"]) => Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": import('./schema').components["schemas"]["WidgetCreateStateCheckpointInputDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": import('./schema').components["schemas"]["WidgetCreateStateCheckpointOutputDto"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": import('./schema').components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    }, {
+        body: {
+            session_id: string;
+            payload: {
+                [key: string]: unknown;
+            };
+        };
+    }, `${string}/${string}`>>;
 }

package/dist/src/headless/core/api/schema.d.ts

@@ -375,6 +375,8 @@ export interface components {
             custom_data?: {
                 [key: string]: unknown;
             } | null;
+            /** @description If there is an active mode, it will be exited and the prompt will be given to the AI for a customized response */
+            exit_mode_prompt?: string;
         };
         WidgetSendMessageOutputDto: {
             /** @enum {boolean} */
@@ -395,6 +397,7 @@ export interface components {
                     name: string;
                     slug?: string;
                 };
+                didExitMode?: boolean;
             };
             uiResponse?: {
                 /** @enum {string} */

package/dist/src/headless/core/context/message.ctx.d.ts

@@ -29,6 +29,7 @@ export declare class MessageCtx {
         content: SendMessageDto["content"];
         attachments?: SendMessageDto["attachments"];
         customData?: SendMessageDto["custom_data"];
+        exitModePrompt?: string;
     }) => Promise<void>;
     private toUserMessage;
     private toBotMessage;

package/dist/src/headless/core/context/session.ctx.d.ts

@@ -1,4 +1,5 @@
 import { ApiCaller } from '../api/api-caller';
+import { Dto } from '../api/client';
 import { SessionDto } from '../types/dtos';
 import { PrimitiveState } from '../utils/PrimitiveState';
 import { ContactCtx } from './contact.ctx';
@@ -96,5 +97,20 @@ export declare class SessionCtx {
         };
         readonly data?: undefined;
     }>;
+    createStateCheckpoint: (payload: Dto["WidgetCreateStateCheckpointInputDto"]["payload"]) => Promise<{
+        readonly data: {
+            success: boolean;
+        };
+        readonly success?: undefined;
+        readonly error?: undefined;
+    } | {
+        readonly success: false;
+        readonly error: {
+            statusCode?: number;
+            message?: string;
+            error?: string;
+        };
+        readonly data?: undefined;
+    } | undefined>;
 }
 export {};

package/dist/src/headless/core/index.d.ts

@@ -1,7 +1,7 @@
 export type { AgentOrBotType } from './types/agent-or-bot';
 export type { SafeExtract, StringOrLiteral } from './types/helpers';
 export type { LiteralWidgetComponentKey, WidgetComponentKey, UserMessageType, AgentMessageType, BotMessageType, MessageType, } from './types/messages';
-export type { MessageAttachmentType, MessageDto, PreludeDto, SendMessageDto, SendMessageOutputDto, ResolveSessionDto, SessionDto, VoteInputDto, VoteOutputDto, ActionCallDto, } from './types/dtos';
+export type { MessageAttachmentType, MessageDto, PreludeDto, SendMessageDto, SendMessageOutputDto, ResolveSessionDto, SessionDto, VoteInputDto, VoteOutputDto, ActionCallDto, ModeDto, } from './types/dtos';
 export type { WidgetConfig, HeaderButtonU } from './types/widget-config';
 export type { ExternalStorage } from './types/external-storage';
 export type { OpenCxComponentNameU } from './types/component-name';

package/dist/src/headless/react/WidgetProvider.d.ts

@@ -2,18 +2,21 @@ import { default as React } from 'react';
 import { ExternalStorage, WidgetConfig, WidgetCtx } from '../core';
 import { ComponentRegistry } from './ComponentRegistry';
 import { WidgetComponentType } from './types/components';
+import { WidgetModeComponentType } from './types/modes.components';
 interface WidgetProviderValue {
     widgetCtx: WidgetCtx;
     config: WidgetConfig;
     components?: WidgetComponentType[];
+    modesComponents?: WidgetModeComponentType[];
     componentStore: ComponentRegistry;
     version: string;
     contentIframeRef?: React.MutableRefObject<HTMLIFrameElement | null>;
 }
-export declare function WidgetProvider({ options: config, children, components, storage, loadingComponent, }: {
+export declare function WidgetProvider({ options: config, children, components, modesComponents, storage, loadingComponent, }: {
     options: WidgetConfig;
     children: React.ReactNode;
     components?: WidgetComponentType[];
+    modesComponents?: WidgetModeComponentType[];
     storage?: ExternalStorage;
     /**
      * Custom loading component while the widget is initializing

package/dist/src/headless/react/hooks/useMessages.d.ts

@@ -9,5 +9,6 @@ export declare function useMessages(): {
         content: import('../../core').SendMessageDto["content"];
         attachments?: import('../../core').SendMessageDto["attachments"];
         customData?: import('../../core').SendMessageDto["custom_data"];
+        exitModePrompt?: string;
     }) => Promise<void>;
 };

package/dist/src/headless/react/hooks/useModes.d.ts

@@ -4,9 +4,12 @@ export declare function useModes(): {
         name: string;
         slug?: string | null;
     }[];
+    modesComponents: import('..').WidgetModeComponentType[] | undefined;
+    activeModeId: string | null | undefined;
     activeMode: {
         id: string;
         name: string;
         slug?: string | null;
     } | undefined;
+    Component: import('react').FC<import('../types/modes.components').WidgetModeComponentProps> | undefined;
 };

package/dist/src/headless/react/hooks/useSessions.d.ts

@@ -47,6 +47,21 @@ export declare function useSessions(): {
         };
         readonly data?: undefined;
     }>;
+    createStateCheckpoint: (payload: import('../../core/api/client').Dto["WidgetCreateStateCheckpointInputDto"]["payload"]) => Promise<{
+        readonly data: {
+            success: boolean;
+        };
+        readonly success?: undefined;
+        readonly error?: undefined;
+    } | {
+        readonly success: false;
+        readonly error: {
+            statusCode?: number;
+            message?: string;
+            error?: string;
+        };
+        readonly data?: undefined;
+    } | undefined>;
     openSessions: {
         id: string;
         createdAt: string;

package/dist/src/headless/react/index.d.ts

@@ -1,4 +1,5 @@
 export type { WidgetComponentType, WidgetComponentProps, } from './types/components';
+export type { WidgetModeComponentType } from './types/modes.components';
 export { WidgetProvider, useWidget } from './WidgetProvider';
 export { useConfig } from './hooks/useConfig';
 export { useContact } from './hooks/useContact';

package/dist/src/headless/react/types/modes.components.d.ts

@@ -0,0 +1,11 @@
+import { MessageCtx, ModeDto, SessionCtx } from '../../core';
+export type WidgetModeComponentProps = {
+    mode: ModeDto;
+    createStateCheckpoint: SessionCtx['createStateCheckpoint'];
+    sendMessage: MessageCtx['sendMessage'];
+    isSendingMessage: boolean;
+};
+export type WidgetModeComponentType = {
+    key: string;
+    component: React.FC<WidgetModeComponentProps>;
+};