@opencx/widget 3.0.86 → 3.0.88

package/dist/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./widget.ctx-oIT8sGvJ.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-HuLTTMAM.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-DFFwNHvy.js";
-import { i as s } from "./is-exhaustive-DGJzQK69.js";
+import { P as s, W as a } from "./widget.ctx-CC3c7FPb.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("./useWidgetTrigger-Bplu_1C-.cjs");function g(t,i,s){const{widgetCtx:{api:u}}=e.useWidget();return e._default(async r=>u.vote({action:r==="up"?"upvote":"downvote",messagePublicId:t,sessionId:i}).then(s),[u,t,i,s])}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.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=g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useModes-DSFNdOy3.cjs"),o=require("react-use/lib/useAsyncFn");function g(s,t,i){const{widgetCtx:{api:u}}=e.useWidget();return o(async r=>u.vote({action:r==="up"?"upvote":"downvote",messagePublicId:s,sessionId:t}).then(i),[u,s,t,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=g;
 //# sourceMappingURL=react.cjs.map

package/dist/react.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"react.cjs","sources":["../src/headless/react/hooks/useVote.ts"],"sourcesContent":["import useAsyncFn from 'react-use/lib/useAsyncFn';\nimport { useWidget } from '../WidgetProvider';\n\n/**\n * @param id\n * @param onSuccess\n * @returns\n */\nexport function useVote(id: string, sessionId: string, onSuccess?: () => void) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async (action: 'up' | 'down') => {\n      return api\n        .vote({\n          action: action === 'up' ? 'upvote' : 'downvote',\n          messagePublicId: id,\n          sessionId,\n        })\n        .then(onSuccess);\n    },\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useUpvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'upvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useDownvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'downvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n"],"names":["useVote","id","sessionId","onSuccess","api","useWidget","useAsyncFn","action"],"mappings":"mIAQgB,SAAAA,EAAQC,EAAYC,EAAmBC,EAAwB,CACvE,KAAA,CACJ,UAAW,CAAE,IAAAC,CAAI,GACfC,EAAU,UAAA,EACP,OAAAC,EAAA,SACL,MAAOC,GACEH,EACJ,KAAK,CACJ,OAAQG,IAAW,KAAO,SAAW,WACrC,gBAAiBN,EACjB,UAAAC,CAAA,CACD,EACA,KAAKC,CAAS,EAEnB,CAACC,EAAKH,EAAIC,EAAWC,CAAS,CAAA,CAElC"}
+{"version":3,"file":"react.cjs","sources":["../src/headless/react/hooks/useVote.ts"],"sourcesContent":["import useAsyncFn from 'react-use/lib/useAsyncFn';\nimport { useWidget } from '../WidgetProvider';\n\n/**\n * @param id\n * @param onSuccess\n * @returns\n */\nexport function useVote(id: string, sessionId: string, onSuccess?: () => void) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async (action: 'up' | 'down') => {\n      return api\n        .vote({\n          action: action === 'up' ? 'upvote' : 'downvote',\n          messagePublicId: id,\n          sessionId,\n        })\n        .then(onSuccess);\n    },\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useUpvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'upvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useDownvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'downvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n"],"names":["useVote","id","sessionId","onSuccess","api","useWidget","useAsyncFn","action"],"mappings":"iKAQgB,SAAAA,EAAQC,EAAYC,EAAmBC,EAAwB,CACvE,KAAA,CACJ,UAAW,CAAE,IAAAC,CAAI,GACfC,EAAU,UAAA,EACP,OAAAC,EACL,MAAOC,GACEH,EACJ,KAAK,CACJ,OAAQG,IAAW,KAAO,SAAW,WACrC,gBAAiBN,EACjB,UAAAC,CAAA,CACD,EACA,KAAKC,CAAS,EAEnB,CAACC,EAAKH,EAAIC,EAAWC,CAAS,CAAA,CAElC"}

package/dist/react.js

@@ -1,9 +1,10 @@
-import { u, _ as r } from "./useWidgetTrigger-Bi12WVrs.js";
-import { W as p, k as f, a as l, b as v, c as W, d as c, e as m, f as P, g as w, i as x, h as C, j as b } from "./useWidgetTrigger-Bi12WVrs.js";
-function g(e, s, t) {
+import { u as o } from "./useModes-DleBrdDK.js";
+import { W as m, k as c, a as f, b as l, c as v, d as W, l as P, e as w, f as x, g as y, i as C, h as b, j as h } from "./useModes-DleBrdDK.js";
+import r from "react-use/lib/useAsyncFn";
+function n(e, s, t) {
   const {
     widgetCtx: { api: a }
-  } = u();
+  } = o();
   return r(
     async (i) => a.vote({
       action: i === "up" ? "upvote" : "downvote",
@@ -14,19 +15,20 @@ function g(e, s, t) {
   );
 }
 export {
-  p as WidgetProvider,
-  f as WidgetTriggerProvider,
-  l as useConfig,
-  v as useContact,
-  W as useIsAwaitingBotReply,
-  c as useMessages,
-  m as usePreludeData,
-  P as usePrimitiveState,
-  w as useSessions,
-  x as useUploadFiles,
-  g as useVote,
-  u as useWidget,
-  C as useWidgetRouter,
-  b as useWidgetTrigger
+  m as WidgetProvider,
+  c as WidgetTriggerProvider,
+  f as useConfig,
+  l as useContact,
+  v as useIsAwaitingBotReply,
+  W as useMessages,
+  P as useModes,
+  w as usePreludeData,
+  x as usePrimitiveState,
+  y as useSessions,
+  C as useUploadFiles,
+  n as useVote,
+  o as useWidget,
+  b as useWidgetRouter,
+  h as useWidgetTrigger
 };
 //# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -1 +1 @@
-{"version":3,"file":"react.js","sources":["../src/headless/react/hooks/useVote.ts"],"sourcesContent":["import useAsyncFn from 'react-use/lib/useAsyncFn';\nimport { useWidget } from '../WidgetProvider';\n\n/**\n * @param id\n * @param onSuccess\n * @returns\n */\nexport function useVote(id: string, sessionId: string, onSuccess?: () => void) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async (action: 'up' | 'down') => {\n      return api\n        .vote({\n          action: action === 'up' ? 'upvote' : 'downvote',\n          messagePublicId: id,\n          sessionId,\n        })\n        .then(onSuccess);\n    },\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useUpvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'upvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useDownvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'downvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n"],"names":["useVote","id","sessionId","onSuccess","api","useWidget","useAsyncFn","action"],"mappings":";;AAQgB,SAAAA,EAAQC,GAAYC,GAAmBC,GAAwB;AACvE,QAAA;AAAA,IACJ,WAAW,EAAE,KAAAC,EAAI;AAAA,MACfC,EAAU;AACP,SAAAC;AAAAA,IACL,OAAOC,MACEH,EACJ,KAAK;AAAA,MACJ,QAAQG,MAAW,OAAO,WAAW;AAAA,MACrC,iBAAiBN;AAAA,MACjB,WAAAC;AAAA,IAAA,CACD,EACA,KAAKC,CAAS;AAAA,IAEnB,CAACC,GAAKH,GAAIC,GAAWC,CAAS;AAAA,EAAA;AAElC;"}
+{"version":3,"file":"react.js","sources":["../src/headless/react/hooks/useVote.ts"],"sourcesContent":["import useAsyncFn from 'react-use/lib/useAsyncFn';\nimport { useWidget } from '../WidgetProvider';\n\n/**\n * @param id\n * @param onSuccess\n * @returns\n */\nexport function useVote(id: string, sessionId: string, onSuccess?: () => void) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async (action: 'up' | 'down') => {\n      return api\n        .vote({\n          action: action === 'up' ? 'upvote' : 'downvote',\n          messagePublicId: id,\n          sessionId,\n        })\n        .then(onSuccess);\n    },\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useUpvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'upvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n\n/**\n * @param id\n * @param onSuccess\n * @deprecated use useVote instead\n */\nexport function useDownvote(\n  id: string,\n  sessionId: string,\n  onSuccess?: () => void,\n) {\n  const {\n    widgetCtx: { api },\n  } = useWidget();\n  return useAsyncFn(\n    async () =>\n      api\n        .vote({ action: 'downvote', messagePublicId: id, sessionId })\n        .then(onSuccess),\n    [api, id, sessionId, onSuccess],\n  );\n}\n"],"names":["useVote","id","sessionId","onSuccess","api","useWidget","useAsyncFn","action"],"mappings":";;;AAQgB,SAAAA,EAAQC,GAAYC,GAAmBC,GAAwB;AACvE,QAAA;AAAA,IACJ,WAAW,EAAE,KAAAC,EAAI;AAAA,MACfC,EAAU;AACP,SAAAC;AAAA,IACL,OAAOC,MACEH,EACJ,KAAK;AAAA,MACJ,QAAQG,MAAW,OAAO,WAAW;AAAA,MACrC,iBAAiBN;AAAA,MACjB,WAAAC;AAAA,IAAA,CACD,EACA,KAAKC,CAAS;AAAA,IAEnB,CAACC,GAAKH,GAAIC,GAAWC,CAAS;AAAA,EAAA;AAElC;"}

package/dist/src/designs/react/hooks/useCanvas.d.ts

@@ -0,0 +1,3 @@
+export declare function useCanvas(): {
+    isCanvasOpen: boolean;
+};

package/dist/src/designs/react/hooks/useTheme.d.ts

@@ -43,6 +43,12 @@ export declare function useTheme(): {
             chat: {
                 width: string;
                 height: string;
+                withCanvas: {
+                    width: string;
+                    height: string;
+                    transitionTimingFunction: string;
+                    transitionDuration: string;
+                };
             };
         };
     };

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

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

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

@@ -133,7 +133,7 @@ export declare const TestUtils: {
                 };
                 requestBody: {
                     content: {
-                        "application/json": import('../api/schema').components["schemas"]["SendWidgetMessageDto"];
+                        "application/json": import('../api/schema').components["schemas"]["WidgetSendMessageInputDto"];
                     };
                 };
                 responses: {
@@ -142,7 +142,7 @@ export declare const TestUtils: {
                             [name: string]: unknown;
                         };
                         content: {
-                            "application/json": import('../api/schema').components["schemas"]["HandleContactMessageOutputDto"];
+                            "application/json": import('../api/schema').components["schemas"]["WidgetSendMessageOutputDto"];
                         };
                     };
                     500: {
@@ -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

@@ -90,7 +90,7 @@ export declare class ApiCaller {
         };
         requestBody: {
             content: {
-                "application/json": import('./schema').components["schemas"]["SendWidgetMessageDto"];
+                "application/json": import('./schema').components["schemas"]["WidgetSendMessageInputDto"];
             };
         };
         responses: {
@@ -99,7 +99,7 @@ export declare class ApiCaller {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": import('./schema').components["schemas"]["HandleContactMessageOutputDto"];
+                    "application/json": import('./schema').components["schemas"]["WidgetSendMessageOutputDto"];
                 };
             };
             500: {
@@ -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

@@ -115,6 +115,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/backend/widget/v2/checkpoint': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations['createStateCheckpoint'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/backend/widget/v2/upload': {
         parameters: {
             query?: never;
@@ -199,42 +215,6 @@ export interface components {
             /** Format: binary */
             file: string;
         };
-        HandleContactMessageOutputDto: {
-            /** @enum {boolean} */
-            success: true;
-            code?: string | 'session_assigned_to_human_agent' | 'response_cancelled';
-            autopilotResponse?: {
-                /** @enum {string} */
-                type: 'text';
-                value: {
-                    error: boolean;
-                    content: string;
-                };
-                id?: string;
-                mightSolveUserIssue: boolean;
-                completelyAndFullyCoveredUserIssue: boolean;
-            };
-            uiResponse?: {
-                /** @enum {string} */
-                type: 'ui';
-                value: {
-                    /** @enum {string} */
-                    type: 'ui_component';
-                    request_response?: unknown;
-                    name: string;
-                    content?: string;
-                };
-                mightSolveUserIssue: boolean;
-            };
-            sessionIsHandedOff?: boolean;
-        } | {
-            /** @enum {boolean} */
-            success: false;
-            error: {
-                code?: string;
-                message?: string;
-            };
-        };
         /** @description Paginated response. */
         PaginatedWidgetSessionsDto: {
             items: {
@@ -253,45 +233,14 @@ export interface components {
                 channel: string;
                 isVerified: boolean;
                 lastMessage: string | null;
+                modeId: string | null;
+                latestStateCheckpointPayload: {
+                    [key: string]: unknown;
+                } | null;
             }[];
             /** @description The `cursor` for the request to get the next set of items. Null if there is no more data. */
             next: string | null;
         };
-        SendWidgetMessageDto: {
-            /** Format: uuid */
-            uuid: string;
-            content: string;
-            session_id: string;
-            bot_token: string;
-            /** @description Additional headers to be included in the request of action calls */
-            headers?: {
-                [key: string]: string;
-            } | null;
-            /** @description Additional query parameters to be included in the query of action calls */
-            query_params?: {
-                [key: string]: string;
-            } | null;
-            /** @description Additional body properties to be included in the body of action calls */
-            body_properties?: {
-                [key: string]: unknown;
-            } | null;
-            language?: string | null;
-            attachments?: {
-                id: string;
-                name: string;
-                size: number;
-                type: string;
-                url: string;
-            }[] | null;
-            /** @description Context for the AI to be sent with each contact message */
-            clientContext?: {
-                [key: string]: unknown;
-            } | null;
-            /** @description Custom data to be sent with each contact message */
-            custom_data?: {
-                [key: string]: unknown;
-            } | null;
-        };
         UploadWidgetFileResponseDto: {
             fileName: string;
             fileUrl: string;
@@ -299,15 +248,29 @@ export interface components {
         WidgetConfigDto: {
             sessionsPollingIntervalSeconds: number;
             sessionPollingIntervalSeconds: number;
+            modes: {
+                id: string;
+                name: string;
+                slug?: string | null;
+            }[];
         };
         WidgetContactTokenResponseDto: {
             /** @description The JWT token to use for further requests */
             token: string;
         };
+        WidgetCreateStateCheckpointInputDto: {
+            session_id: string;
+            payload: {
+                [key: string]: unknown;
+            };
+        };
+        WidgetCreateStateCheckpointOutputDto: {
+            success: boolean;
+        };
         WidgetHistoryDto: {
             publicId: string;
             /** @enum {string} */
-            type: 'message' | 'handoff' | 'handoff_to_zendesk' | 'agent_message' | 'agent_joined' | 'agent_comment' | 'agent_took_session_from_ai' | 'agent_reopened_session' | 'ai_decided_to_resolve_the_issue' | 'email_draft_message' | 'followup' | 'ai_assumed_the_session_resolved' | 'user_confirmed_the_session_resolved' | 'system_message';
+            type: 'message' | 'agent_message' | 'agent_joined' | 'agent_comment' | 'agent_took_session_from_ai' | 'agent_reopened_session' | 'handoff' | 'handoff_to_zendesk' | 'handoff_to_salesforce_miaw' | 'ai_decided_to_resolve_the_issue' | 'ai_assumed_the_session_resolved' | 'user_confirmed_the_session_resolved' | 'state_checkpoint' | 'email_draft_message' | 'followup' | 'system_message';
             content: {
                 text?: string | null;
             };
@@ -378,6 +341,107 @@ export interface components {
         WidgetResolveSessionInputDto: {
             session_id: string;
         };
+        WidgetSendMessageInputDto: {
+            /** Format: uuid */
+            uuid: string;
+            content: string;
+            session_id: string;
+            bot_token: string;
+            /** @description Additional headers to be included in the request of action calls */
+            headers?: {
+                [key: string]: string;
+            } | null;
+            /** @description Additional query parameters to be included in the query of action calls */
+            query_params?: {
+                [key: string]: string;
+            } | null;
+            /** @description Additional body properties to be included in the body of action calls */
+            body_properties?: {
+                [key: string]: unknown;
+            } | null;
+            language?: string | null;
+            attachments?: {
+                id: string;
+                name: string;
+                size: number;
+                type: string;
+                url: string;
+            }[] | null;
+            /** @description Context for the AI to be sent with each contact message */
+            clientContext?: {
+                [key: string]: unknown;
+            } | null;
+            /** @description Custom data to be sent with each contact message */
+            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} */
+            success: true;
+            code?: string | 'session_assigned_to_human_agent' | 'response_cancelled';
+            autopilotResponse?: {
+                /** @enum {string} */
+                type: 'text';
+                value: {
+                    error: boolean;
+                    content: string;
+                };
+                id?: string;
+                mightSolveUserIssue: boolean;
+                completelyAndFullyCoveredUserIssue: boolean;
+                mode?: {
+                    id: string;
+                    name: string;
+                    slug?: string;
+                };
+                didExitMode?: boolean;
+            };
+            uiResponse?: {
+                /** @enum {string} */
+                type: 'ui';
+                value: {
+                    /** @enum {string} */
+                    type: 'ui_component';
+                    request_response?: unknown;
+                    name: string;
+                    content?: string;
+                };
+                mightSolveUserIssue: boolean;
+            };
+            sessionIsHandedOff?: boolean;
+            /** @description WidgetSession */
+            session?: {
+                /** Format: uuid */
+                id: string;
+                createdAt: string;
+                updatedAt: string;
+                isHandedOff: boolean;
+                isOpened: boolean;
+                assignee: {
+                    /** @enum {string} */
+                    kind: 'human' | 'ai' | 'none' | 'unknown';
+                    name: string | null;
+                    avatarUrl: string | null;
+                };
+                channel: string;
+                isVerified: boolean;
+                lastMessage: string | null;
+                modeId: string | null;
+                latestStateCheckpointPayload: {
+                    [key: string]: unknown;
+                } | null;
+            };
+        } | {
+            /** @enum {boolean} */
+            success: false;
+            error: {
+                code?: string;
+                message?: string;
+            };
+        };
         WidgetSessionAndHistoryDto: {
             /** @description WidgetSession */
             session: {
@@ -396,11 +460,15 @@ export interface components {
                 channel: string;
                 isVerified: boolean;
                 lastMessage: string | null;
+                modeId: string | null;
+                latestStateCheckpointPayload: {
+                    [key: string]: unknown;
+                } | null;
             };
             history: {
                 publicId: string;
                 /** @enum {string} */
-                type: 'message' | 'handoff' | 'handoff_to_zendesk' | 'agent_message' | 'agent_joined' | 'agent_comment' | 'agent_took_session_from_ai' | 'agent_reopened_session' | 'ai_decided_to_resolve_the_issue' | 'email_draft_message' | 'followup' | 'ai_assumed_the_session_resolved' | 'user_confirmed_the_session_resolved' | 'system_message';
+                type: 'message' | 'agent_message' | 'agent_joined' | 'agent_comment' | 'agent_took_session_from_ai' | 'agent_reopened_session' | 'handoff' | 'handoff_to_zendesk' | 'handoff_to_salesforce_miaw' | 'ai_decided_to_resolve_the_issue' | 'ai_assumed_the_session_resolved' | 'user_confirmed_the_session_resolved' | 'state_checkpoint' | 'email_draft_message' | 'followup' | 'system_message';
                 content: {
                     text?: string | null;
                 };
@@ -442,6 +510,10 @@ export interface components {
             channel: string;
             isVerified: boolean;
             lastMessage: string | null;
+            modeId: string | null;
+            latestStateCheckpointPayload: {
+                [key: string]: unknown;
+            } | null;
         };
         WidgetVoteDto: {
             /** @enum {string} */
@@ -667,7 +739,39 @@ export interface operations {
         };
         requestBody: {
             content: {
-                'application/json': components['schemas']['SendWidgetMessageDto'];
+                'application/json': components['schemas']['WidgetSendMessageInputDto'];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['WidgetSendMessageOutputDto'];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['ErrorDto'];
+                };
+            };
+        };
+    };
+    createStateCheckpoint: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['WidgetCreateStateCheckpointInputDto'];
             };
         };
         responses: {
@@ -676,7 +780,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['HandleContactMessageOutputDto'];
+                    'application/json': components['schemas']['WidgetCreateStateCheckpointOutputDto'];
                 };
             };
             /** @description Internal Server Error */

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;