@opencx/widget 3.0.42 → 3.0.44

package/dist/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./widget.ctx-DB_VxiMQ.cjs");exports.PrimitiveState=t.PrimitiveState;exports.WidgetCtx=t.WidgetCtx;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./widget.ctx-Z3nrC8tP.cjs");exports.PrimitiveState=t.PrimitiveState;exports.WidgetCtx=t.WidgetCtx;
 //# sourceMappingURL=index.cjs.map

package/dist/index.js

@@ -1,4 +1,4 @@
-import { P as i, W as a } from "./widget.ctx-DIcAO9ZA.js";
+import { P as i, W as a } from "./widget.ctx-Db_LSB7d.js";
 export {
   i as PrimitiveState,
   a as WidgetCtx

package/dist/react.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useUploadFiles-eYRjtkaZ.cjs");function a(t,s,u){const{widgetCtx:{api:i}}=e.useWidget();return e._default(async o=>i.vote({action:o==="up"?"upvote":"downvote",messagePublicId:t,sessionId:s}).then(u),[i,t,s,u])}exports.WidgetProvider=e.WidgetProvider;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.useVote=a;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useUploadFiles-Bt32Tf5N.cjs");function a(t,s,u){const{widgetCtx:{api:i}}=e.useWidget();return e._default(async o=>i.vote({action:o==="up"?"upvote":"downvote",messagePublicId:t,sessionId:s}).then(u),[i,t,s,u])}exports.WidgetProvider=e.WidgetProvider;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.useVote=a;
 //# sourceMappingURL=react.cjs.map

package/dist/react.js

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

package/dist/src/designs/translation/translation.types.d.ts

@@ -1,4 +1,4 @@
-export type TranslationKeysU = "ok" | "yes" | "no" | "agree" | "cancel" | "yes-exit" | "yes-reset" | "no-cancel" | "are-you-sure" | "recording" | "thank-you" | "sorry-try-again" | "error-occurred" | "please-try-again" | "write-a-message" | "send-message" | "connected" | "connecting" | "reconnecting" | "reconnected" | "disconnecting" | "disconnected" | "error" | "persist-session" | "settings" | "close" | "help" | "chat" | "send" | "copy" | "copied" | "sound-effects" | "language" | "select" | "agent" | "user" | "bot" | "close-widget" | "got-any-questions" | "typical-response-time" | "session-closed-lead" | "create-new-ticket" | "exit" | "reset-conversation" | "new-conversation" | "welcome-title" | "welcome-description" | "your-name" | "your-email" | "start-chat" | "starting-chat" | "hello-greeting" | "i-need-more-help" | "this-was-helpful";
+export type TranslationKeysU = "ok" | "yes" | "no" | "agree" | "cancel" | "yes-exit" | "yes-reset" | "no-cancel" | "are-you-sure" | "recording" | "thank-you" | "sorry-try-again" | "error-occurred" | "please-try-again" | "write-a-message" | "send-message" | "connected" | "connecting" | "reconnecting" | "reconnected" | "disconnecting" | "disconnected" | "error" | "persist-session" | "settings" | "close" | "help" | "chat" | "send" | "copy" | "copied" | "sound-effects" | "language" | "select" | "agent" | "user" | "bot" | "close-widget" | "got-any-questions" | "typical-response-time" | "session-closed-lead" | "create-new-ticket" | "exit" | "reset-conversation" | "new-conversation" | "welcome-title" | "welcome-description" | "your-name" | "your-email" | "start-chat" | "starting-chat" | "hello-greeting" | "i-need-more-help" | "this-was-helpful" | "optional";
 export type TranslationInterface = {
     [K in TranslationKeysU]: string;
 };

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

@@ -8,6 +8,7 @@ type ContactState = {
         token: string;
         externalId: string | undefined;
     } | null;
+    extraCollectedData: Record<string, string> | undefined;
     isCreatingUnverifiedContact: boolean;
     isErrorCreatingUnverifiedContact: boolean;
 };
@@ -23,7 +24,7 @@ export declare class ContactCtx {
     });
     shouldCollectData: () => boolean;
     private autoCreateUnverifiedUserIfNotExists;
-    createUnverifiedContact: (payload: Dto["CreateUnverifiedContactDto"]) => Promise<void>;
+    createUnverifiedContact: (payload: Dto["CreateUnverifiedContactDto"], extraCollectedData?: Record<string, string>) => Promise<void>;
     setUnverifiedContact: (token: string) => Promise<void>;
 }
 export {};

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

@@ -1,10 +1,10 @@
 import { ApiCaller } from '../api/api-caller';
 import { WidgetConfig } from '../types/widget-config';
-import { SafeOmit, SomeOptional } from '../types/helpers';
 import { MessageType } from '../types/messages';
 import { SendMessageDto } from '../types/schemas';
 import { PrimitiveState } from '../utils/PrimitiveState';
 import { SessionCtx } from './session.ctx';
+import { ContactCtx } from './contact.ctx';
 type MessageCtxState = {
     messages: MessageType[];
     isSendingMessage: boolean;
@@ -14,16 +14,21 @@ type MessageCtxState = {
 export declare class MessageCtx {
     private config;
     private api;
+    private contactCtx;
     private sessionCtx;
     state: PrimitiveState<MessageCtxState>;
     private sendMessageAbortController;
-    constructor({ config, api, sessionCtx, }: {
+    constructor({ config, api, sessionCtx, contactCtx, }: {
         config: WidgetConfig;
         api: ApiCaller;
         sessionCtx: SessionCtx;
+        contactCtx: ContactCtx;
     });
     reset: () => void;
-    sendMessage: (input: SomeOptional<SafeOmit<SendMessageDto, "bot_token" | "uuid">, "session_id" | "user">) => Promise<void>;
+    sendMessage: (input: {
+        content: SendMessageDto["content"];
+        attachments?: SendMessageDto["attachments"];
+    }) => Promise<void>;
     private toUserMessage;
     private toBotMessage;
     private toBotErrorMessage;

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

@@ -1,5 +1,5 @@
 export type { AgentOrBotType } from './types/agent-or-bot';
-export type { SafeExtract, SafeOmit, SomeOptional, 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, } from './types/schemas';
 export type { WidgetConfig } from './types/widget-config';

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

@@ -1,4 +1,2 @@
-export type SomeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-export type SafeOmit<T, K extends keyof T> = Omit<T, K>;
 export type SafeExtract<T, K extends T> = Extract<T, K>;
 export type StringOrLiteral<T extends string> = T | (string & {});

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

@@ -20,28 +20,80 @@ export type UserConfig = UserBaseConfig & {
     externalId?: string;
 };
 export interface WidgetConfig {
+    /**
+     * Your organization's widget token.
+     * Can be found in the dashboard in the web widget page.
+     */
     token: string;
-    apiUrl?: string;
-    headers?: Record<string, string>;
-    queryParams?: Record<string, string>;
-    collectUserData?: boolean;
-    debug?: boolean;
-    initialMessages?: string[];
+    /**
+     * The language of the widget.
+     * Translations are available in the default non-headless widget.
+     * Check available translations in `src/designs/translation`
+     * @default en
+     */
     language?: string;
-    user?: UserConfig;
-    bot?: AgentOrBotType;
-    soundEffectsUrls?: {
-        messageArrived?: string;
-    };
+    /**
+     * A name and an avatar for the bot.
+     */
+    bot?: Pick<AgentOrBotType, "name" | "avatar">;
     theme?: {
         primaryColor?: string;
     };
-    settings?: {
-        persistSession?: boolean;
-        playSoundEffects?: boolean;
-    };
     assets?: {
         organizationLogo?: string;
     };
+    /**
+     * Initial messages that the contact sees in a new chat session.
+     * These messages will disappear once the contact sends their first message.
+     */
+    initialMessages?: string[];
+    /**
+     * If turned on, the widget will have a login-like screen to collect user's name and email.
+     * A non-verified contact will be created based on the provided information.
+     * @default false
+     */
+    collectUserData?: boolean;
+    /**
+     * Extra data collection fields besides `name` and `email`.
+     * For this setting to take effect, `collectUserData` must be set to `true`.
+     *
+     * Not to be confused with `WidgetConfig.user.data.customData`,
+     * the purpose of `extraDataCollectionFields` is to provide context to the session,
+     * the data collected will be prepended in the first contact message in a session.
+     *
+     * @default undefined
+     */
+    extraDataCollectionFields?: string[];
+    /**
+     * Verified or non-verified contact data.
+     * To know more, check the README
+     * @default undefined
+     */
+    user?: UserConfig;
+    /**
+     * Headers to be sent with each send-message request from the widget.
+     * These headers will be sent with each AI action (AI tools) that the LLM can call.
+     * This is useful if your AI actions require authentication specific to each contact.
+     * @default undefined
+     */
+    headers?: Record<string, string>;
+    /**
+     * Query params to be sent with each send-message request from the widget.
+     * These query params will be sent with each AI action (AI tools) that the LLM can call.
+     * This is useful if you want to send extra information with each AI action.
+     * @default undefined
+     */
+    queryParams?: Record<string, string>;
+    /**
+     * 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 😊.
+     * @default https://api.open.cx
+     */
+    apiUrl?: string;
 }
 export {};

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

@@ -4,8 +4,9 @@ export declare function useContact(): {
             token: string;
             externalId: string | undefined;
         } | null;
+        extraCollectedData: Record<string, string> | undefined;
         isCreatingUnverifiedContact: boolean;
         isErrorCreatingUnverifiedContact: boolean;
     };
-    createUnverifiedContact: (payload: import('../../core/api/client').Dto["CreateUnverifiedContactDto"]) => Promise<void>;
+    createUnverifiedContact: (payload: import('../../core/api/client').Dto["CreateUnverifiedContactDto"], extraCollectedData?: Record<string, string>) => Promise<void>;
 };

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

@@ -5,5 +5,8 @@ export declare function useMessages(): {
         lastAIResMightSolveUserIssue: boolean;
         isInitialFetchLoading: boolean;
     };
-    sendMessage: (input: import('../../core').SomeOptional<import('../../core').SafeOmit<import('../../core').SendMessageDto, "bot_token" | "uuid">, "session_id" | "user">) => Promise<void>;
+    sendMessage: (input: {
+        content: import('../../core').SendMessageDto["content"];
+        attachments?: import('../../core').SendMessageDto["attachments"];
+    }) => Promise<void>;
 };

package/dist/{useUploadFiles-BmEispgd.js → useUploadFiles-BPZLXbFK.js}

@@ -3,7 +3,7 @@ var Yt = (e, t, n) => t in e ? zt(e, t, { enumerable: !0, configurable: !0, writ
 var Je = (e, t, n) => Yt(e, typeof t != "symbol" ? t + "" : t, n);
 import z, { createContext as ot, useContext as st, useRef as H, useState as it, useMemo as Ve, useEffect as Me, useSyncExternalStore as kt, useLayoutEffect as Jt, useCallback as Ee, useDebugValue as Xt } from "react";
 import { jsx as Qt } from "react/jsx-runtime";
-import { W as Zt } from "./widget.ctx-DIcAO9ZA.js";
+import { W as Zt } from "./widget.ctx-Db_LSB7d.js";
 import { v4 as en } from "uuid";
 class tn {
   constructor(t) {
@@ -39,7 +39,7 @@ function nn(e) {
     return r;
   }, t.Provider];
 }
-const rn = "3.0.42", [Y, on] = nn();
+const rn = "3.0.44", [Y, on] = nn();
 function tr({
   options: e,
   children: t,
@@ -1339,4 +1339,4 @@ export {
   At as n,
   Y as u
 };
-//# sourceMappingURL=useUploadFiles-BmEispgd.js.map
+//# sourceMappingURL=useUploadFiles-BPZLXbFK.js.map