@opencx/widget 3.0.63 → 3.0.65

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

@@ -3,14 +3,14 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
-    "/backend/widget/v2/config": {
+    '/backend/widget/v2/config': {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["getWidgetConfig"];
+        get: operations['getWidgetConfig'];
         put?: never;
         post?: never;
         delete?: never;
@@ -19,14 +19,14 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/prelude": {
+    '/backend/widget/v2/prelude': {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["widgetPrelude"];
+        get: operations['widgetPrelude'];
         put?: never;
         post?: never;
         delete?: never;
@@ -35,14 +35,14 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/sessions": {
+    '/backend/widget/v2/sessions': {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["getSessions"];
+        get: operations['getSessions'];
         put?: never;
         post?: never;
         delete?: never;
@@ -51,14 +51,14 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/session/history/{sessionId}": {
+    '/backend/widget/v2/session/history/{sessionId}': {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["getSessionHistory"];
+        get: operations['getSessionHistory'];
         put?: never;
         post?: never;
         delete?: never;
@@ -67,14 +67,14 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/poll/{sessionId}": {
+    '/backend/widget/v2/poll/{sessionId}': {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["pollSessionAndHistory"];
+        get: operations['pollSessionAndHistory'];
         put?: never;
         post?: never;
         delete?: never;
@@ -83,7 +83,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/create-session": {
+    '/backend/widget/v2/create-session': {
         parameters: {
             query?: never;
             header?: never;
@@ -92,14 +92,14 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post: operations["createChatSession"];
+        post: operations['createChatSession'];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/chat/send": {
+    '/backend/widget/v2/chat/send': {
         parameters: {
             query?: never;
             header?: never;
@@ -108,14 +108,14 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post: operations["chatSend"];
+        post: operations['chatSend'];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/upload": {
+    '/backend/widget/v2/upload': {
         parameters: {
             query?: never;
             header?: never;
@@ -124,14 +124,14 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post: operations["uploadFile"];
+        post: operations['uploadFile'];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/chat/vote": {
+    '/backend/widget/v2/chat/vote': {
         parameters: {
             query?: never;
             header?: never;
@@ -140,14 +140,14 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post: operations["voteMessage"];
+        post: operations['voteMessage'];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/backend/widget/v2/contact/create-unverified": {
+    '/backend/widget/v2/contact/create-unverified': {
         parameters: {
             query?: never;
             header?: never;
@@ -156,7 +156,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post: operations["createUnverifiedContact"];
+        post: operations['createUnverifiedContact'];
         delete?: never;
         options?: never;
         head?: never;
@@ -186,10 +186,10 @@ export interface components {
         HandleContactMessageOutputDto: {
             /** @enum {boolean} */
             success: true;
-            code?: string | "session_assigned_to_human_agent";
+            code?: string | 'session_assigned_to_human_agent';
             autopilotResponse?: {
                 /** @enum {string} */
-                type: "text";
+                type: 'text';
                 value: {
                     error: boolean;
                     content: string;
@@ -199,10 +199,10 @@ export interface components {
             };
             uiResponse?: {
                 /** @enum {string} */
-                type: "ui";
+                type: 'ui';
                 value: {
                     /** @enum {string} */
-                    type: "ui_component";
+                    type: 'ui_component';
                     request_response?: unknown;
                     name: string;
                     content?: string;
@@ -229,7 +229,7 @@ export interface components {
                 isOpened: boolean;
                 assignee: {
                     /** @enum {string} */
-                    kind: "human" | "ai" | "none" | "unknown";
+                    kind: 'human' | 'ai' | 'none' | 'unknown';
                     name: string | null;
                     avatarUrl: string | null;
                 };
@@ -279,13 +279,13 @@ export interface components {
         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' | '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';
             content: {
                 text?: string | null;
             };
             sender: {
                 /** @enum {string} */
-                kind: "user" | "agent" | "ai" | "none" | "unknown";
+                kind: 'user' | 'agent' | 'ai' | 'none' | 'unknown';
                 name?: string | null;
                 avatar?: string | null;
             };
@@ -358,7 +358,7 @@ export interface components {
                 isOpened: boolean;
                 assignee: {
                     /** @enum {string} */
-                    kind: "human" | "ai" | "none" | "unknown";
+                    kind: 'human' | 'ai' | 'none' | 'unknown';
                     name: string | null;
                     avatarUrl: string | null;
                 };
@@ -369,13 +369,13 @@ export interface components {
             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' | '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';
                 content: {
                     text?: string | null;
                 };
                 sender: {
                     /** @enum {string} */
-                    kind: "user" | "agent" | "ai" | "none" | "unknown";
+                    kind: 'user' | 'agent' | 'ai' | 'none' | 'unknown';
                     name?: string | null;
                     avatar?: string | null;
                 };
@@ -404,7 +404,7 @@ export interface components {
             isOpened: boolean;
             assignee: {
                 /** @enum {string} */
-                kind: "human" | "ai" | "none" | "unknown";
+                kind: 'human' | 'ai' | 'none' | 'unknown';
                 name: string | null;
                 avatarUrl: string | null;
             };
@@ -414,7 +414,7 @@ export interface components {
         };
         WidgetVoteDto: {
             /** @enum {string} */
-            action: "upvote" | "downvote";
+            action: 'upvote' | 'downvote';
             sessionId: string;
             messagePublicId: string;
         };
@@ -440,7 +440,7 @@ export interface operations {
         parameters: {
             query?: never;
             header: {
-                "X-Bot-Token": string;
+                'X-Bot-Token': string;
             };
             path?: never;
             cookie?: never;
@@ -452,7 +452,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetConfigDto"];
+                    'application/json': components['schemas']['WidgetConfigDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -461,7 +461,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -470,7 +470,7 @@ export interface operations {
         parameters: {
             query?: never;
             header: {
-                "X-Bot-Token": string;
+                'X-Bot-Token': string;
             };
             path?: never;
             cookie?: never;
@@ -482,7 +482,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetPreludeDto"];
+                    'application/json': components['schemas']['WidgetPreludeDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -491,7 +491,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -515,7 +515,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PaginatedWidgetSessionsDto"];
+                    'application/json': components['schemas']['PaginatedWidgetSessionsDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -524,7 +524,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -548,7 +548,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetHistoryDto"][];
+                    'application/json': components['schemas']['WidgetHistoryDto'][];
                 };
             };
             /** @description Internal Server Error */
@@ -557,7 +557,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -581,7 +581,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetSessionAndHistoryDto"];
+                    'application/json': components['schemas']['WidgetSessionAndHistoryDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -590,7 +590,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -604,7 +604,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["CreateWidgetSessionDto"];
+                'application/json': components['schemas']['CreateWidgetSessionDto'];
             };
         };
         responses: {
@@ -613,7 +613,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetSessionDto"];
+                    'application/json': components['schemas']['WidgetSessionDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -622,7 +622,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -636,7 +636,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["SendWidgetMessageDto"];
+                'application/json': components['schemas']['SendWidgetMessageDto'];
             };
         };
         responses: {
@@ -645,7 +645,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["HandleContactMessageOutputDto"];
+                    'application/json': components['schemas']['HandleContactMessageOutputDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -654,7 +654,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -669,7 +669,7 @@ export interface operations {
         /** @description The file to upload */
         requestBody: {
             content: {
-                "multipart/form-data": components["schemas"]["FileUploadDto"];
+                'multipart/form-data': components['schemas']['FileUploadDto'];
             };
         };
         responses: {
@@ -678,7 +678,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["UploadWidgetFileResponseDto"];
+                    'application/json': components['schemas']['UploadWidgetFileResponseDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -687,7 +687,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -701,7 +701,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["WidgetVoteDto"];
+                'application/json': components['schemas']['WidgetVoteDto'];
             };
         };
         responses: {
@@ -710,7 +710,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetVoteResponseDto"];
+                    'application/json': components['schemas']['WidgetVoteResponseDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -719,7 +719,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };
@@ -728,14 +728,14 @@ export interface operations {
         parameters: {
             query?: never;
             header: {
-                "x-bot-token": string;
+                'x-bot-token': string;
             };
             path?: never;
             cookie?: never;
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["CreateUnverifiedContactDto"];
+                'application/json': components['schemas']['CreateUnverifiedContactDto'];
             };
         };
         responses: {
@@ -744,7 +744,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WidgetContactTokenResponseDto"];
+                    'application/json': components['schemas']['WidgetContactTokenResponseDto'];
                 };
             };
             /** @description Internal Server Error */
@@ -753,7 +753,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorDto"];
+                    'application/json': components['schemas']['ErrorDto'];
                 };
             };
         };

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

@@ -4,11 +4,11 @@ import { ContactCtx } from './contact.ctx';
 import { SessionCtx } from './session.ctx';
 import { WidgetCtx } from './widget.ctx';
 type RouterState = {
-    screen: /** A welcome screen to collect user data. Useful in public non-logged-in environments */ "welcome"
+    screen: /** A welcome screen to collect user data. Useful in public non-logged-in environments */ 'welcome'
     /** Show a list of the user's previous sessions */
-     | "sessions"
+     | 'sessions'
     /** Self-explanatory */
-     | "chat";
+     | 'chat';
 };
 export declare class RouterCtx {
     state: PrimitiveState<RouterState>;
@@ -20,7 +20,7 @@ export declare class RouterCtx {
         config: WidgetConfig;
         contactCtx: ContactCtx;
         sessionCtx: SessionCtx;
-        resetChat: WidgetCtx["resetChat"];
+        resetChat: WidgetCtx['resetChat'];
     });
     private registerRoutingListener;
     toSessionsScreen: () => void;

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

@@ -1,5 +1,5 @@
 export type { AgentOrBotType } from './types/agent-or-bot';
-export type { SafeExtract, StringOrLiteral, } from './types/helpers';
+export type { SafeExtract, StringOrLiteral } from './types/helpers';
 export type { WidgetComponentKey, UserMessageType, AgentMessageType, BotMessageType, MessageType, } from './types/messages';
 export type { MessageAttachmentType, MessageDto, PreludeDto, SendMessageDto, SendMessageOutputDto, SessionDto, VoteInputDto, VoteOutputDto, ActionCallDto, } from './types/schemas';
 export type { WidgetConfig } from './types/widget-config';

package/dist/src/headless/core/types/messages.d.ts

@@ -1,10 +1,10 @@
 import { MessageAttachmentType, MessageDto } from './schemas';
 import { SafeExtract, StringOrLiteral } from './helpers';
 import { AgentOrBotType } from './agent-or-bot';
-export type WidgetComponentKey = StringOrLiteral<"bot_message" | "agent_message" | "loading" | "fallback">;
+export type WidgetComponentKey = StringOrLiteral<'bot_message' | 'agent_message' | 'loading' | 'fallback'>;
 export type UserMessageType = {
     id: string;
-    type: "FROM_USER";
+    type: 'FROM_USER';
     content: string;
     deliveredAt: string | null;
     attachments?: MessageAttachmentType[] | null;
@@ -19,14 +19,14 @@ export type UserMessageType = {
 };
 export type BotMessageType<TActionData = unknown> = {
     id: string;
-    type: "FROM_BOT";
+    type: 'FROM_BOT';
     /**
      * The type is a bot_message literal string or other strings that correspond to the UI responses from AI action calls
      */
-    component: StringOrLiteral<SafeExtract<WidgetComponentKey, "bot_message">>;
+    component: StringOrLiteral<SafeExtract<WidgetComponentKey, 'bot_message'>>;
     data: {
         message: string;
-        variant?: "default" | "error";
+        variant?: 'default' | 'error';
         action?: {
             name: string;
             data: TActionData;
@@ -39,11 +39,11 @@ export type BotMessageType<TActionData = unknown> = {
 };
 export type AgentMessageType = {
     id: string;
-    type: "FROM_AGENT";
-    component: SafeExtract<WidgetComponentKey, "agent_message">;
+    type: 'FROM_AGENT';
+    component: SafeExtract<WidgetComponentKey, 'agent_message'>;
     data: {
         message: string;
-        variant?: "default" | "error";
+        variant?: 'default' | 'error';
         action?: undefined;
     };
     timestamp?: string;

package/dist/src/headless/core/types/schemas.d.ts

@@ -1,10 +1,10 @@
 import { Dto } from '../api/client';
-export type VoteInputDto = Dto["WidgetVoteDto"];
-export type VoteOutputDto = Dto["WidgetVoteResponseDto"];
-export type SendMessageDto = Dto["SendWidgetMessageDto"];
-export type SendMessageOutputDto = Dto["HandleContactMessageOutputDto"];
-export type SessionDto = Dto["WidgetSessionDto"];
-export type MessageDto = Dto["WidgetHistoryDto"];
-export type PreludeDto = Dto["WidgetPreludeDto"];
-export type MessageAttachmentType = NonNullable<Dto["WidgetHistoryDto"]["attachments"]>[number];
-export type ActionCallDto = NonNullable<Dto["WidgetHistoryDto"]["actionCalls"]>[number];
+export type VoteInputDto = Dto['WidgetVoteDto'];
+export type VoteOutputDto = Dto['WidgetVoteResponseDto'];
+export type SendMessageDto = Dto['SendWidgetMessageDto'];
+export type SendMessageOutputDto = Dto['HandleContactMessageOutputDto'];
+export type SessionDto = Dto['WidgetSessionDto'];
+export type MessageDto = Dto['WidgetHistoryDto'];
+export type PreludeDto = Dto['WidgetPreludeDto'];
+export type MessageAttachmentType = NonNullable<Dto['WidgetHistoryDto']['attachments']>[number];
+export type ActionCallDto = NonNullable<Dto['WidgetHistoryDto']['actionCalls']>[number];

package/dist/src/headless/core/types/widget-config.d.ts

@@ -34,7 +34,7 @@ export interface WidgetConfig {
     /**
      * A name and an avatar for the bot.
      */
-    bot?: Pick<AgentOrBotType, "name" | "avatar">;
+    bot?: Pick<AgentOrBotType, 'name' | 'avatar'>;
     theme?: {
         primaryColor?: string;
     };
@@ -116,11 +116,6 @@ export interface WidgetConfig {
      * Useful if you want to send data regarding the current page the user is viewing.
      */
     context?: Record<string, unknown>;
-    /**
-     * Turn on to see the debug info attached to the AI responses.
-     * @default false
-     */
-    debug?: boolean;
     /**
      * An apiUrl to override production backend.
      * This is for us to test the widget locally, you don't need to play with this option 😊.

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

@@ -29,7 +29,7 @@ declare function usePreludeData(): import('swr').SWRResponse<import('openapi-fet
 }, {
     params: {
         header: {
-            "X-Bot-Token": string;
+            'X-Bot-Token': string;
         };
     };
 }, `${string}/${string}`>, any, {

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

@@ -1,5 +1,5 @@
 interface FileWithProgress {
-    status: "pending" | "uploading" | "success" | "error";
+    status: 'pending' | 'uploading' | 'success' | 'error';
     id: string;
     file: File;
     fileUrl?: string;