@opencx/widget 3.0.8 → 3.0.11

package/dist/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./widget-DlAUwHzU.cjs");exports.PubSub=e.PubSub;exports.WidgetCtx=e.WidgetCtx;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./widget-6i5ISSQC.cjs");exports.PubSub=e.PubSub;exports.WidgetCtx=e.WidgetCtx;
 //# sourceMappingURL=index.cjs.map

package/dist/index.js

@@ -1,4 +1,4 @@
-import { P as b, W as e } from "./widget-BeNOCqB5.js";
+import { P as b, W as e } from "./widget-BOaF1U-p.js";
 export {
   b as PubSub,
   e as WidgetCtx

package/dist/react.cjs

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

package/dist/react.js

@@ -1,5 +1,5 @@
-import { u as o, _ as r } from "./useUploadFiles-Cw8s18uG.js";
-import { W as p, a as d, b as f, c as b, d as c, e as m, f as v, g as P, h } from "./useUploadFiles-Cw8s18uG.js";
+import { u as o, _ as r } from "./useUploadFiles-B-HZXbPR.js";
+import { W as p, a as d, b as f, c as b, d as c, e as m, f as v, g as P, h } from "./useUploadFiles-B-HZXbPR.js";
 function n(e, t, s) {
   const { widgetCtx: { api: a } } = o();
   return r(

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

@@ -1,9 +1,6 @@
+import { default as React } from 'react';
 import { WidgetConfig } from '../../headless/core';
-declare global {
-    interface Window {
-        initOpenScript: typeof initOpenScript;
-        openCXWidgetVersion: string;
-    }
-}
-declare function initOpenScript(options: WidgetConfig): void;
-export {};
+declare function WidgetWrapper({ options }: {
+    options: WidgetConfig;
+}): React.JSX.Element;
+export { WidgetWrapper as Widget };

package/dist/src/designs/react/{basic/utils → utils}/group-messages-by-type.d.ts

@@ -1,4 +1,4 @@
-import { AgentMessageType, BotMessageType, MessageType, UserMessageType } from '../../../../headless/core';
+import { AgentMessageType, BotMessageType, MessageType, UserMessageType } from '../../../headless/core';
 export declare function groupMessagesByType(messages: MessageType[]): MessageType[][];
 export declare function isUserMessageGroup(messages: MessageType[]): messages is UserMessageType[];
 export declare function isBotMessageGroup(messages: MessageType[]): messages is BotMessageType[];

package/dist/src/embedded/index.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+import { WidgetConfig } from '../headless/core';
+declare global {
+    interface Window {
+        initOpenScript: typeof initOpenScript;
+        openCXWidgetVersion: string;
+    }
+}
+declare function initOpenScript(options: WidgetConfig): void;
+export declare function render(rootId: string, component: React.JSX.Element): void;
+export {};

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

@@ -198,14 +198,18 @@ export declare class ApiCaller {
             name?: string;
         };
     }, `${string}/${string}`>>;
-    createSession: () => Promise<import('openapi-fetch').FetchResponse<{
+    createSession: (body: Dto["CreateWidgetChatSessionDto"]) => Promise<import('openapi-fetch').FetchResponse<{
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": import('./sdk/schema').components["schemas"]["CreateWidgetChatSessionDto"];
+            };
+        };
         responses: {
             200: {
                 headers: {
@@ -224,11 +228,23 @@ export declare class ApiCaller {
                 };
             };
         };
-    }, import('openapi-fetch').FetchOptions<{
+    }, {
+        body: {
+            customData?: {
+                [key: string]: string | number | boolean | unknown | unknown;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getSession: ({ sessionId, abortSignal, }: {
+        sessionId: string;
+        abortSignal: AbortSignal;
+    }) => Promise<import('openapi-fetch').FetchResponse<{
         parameters: {
             query?: never;
             header?: never;
-            path?: never;
+            path: {
+                sessionId: string;
+            };
             cookie?: never;
         };
         requestBody?: never;
@@ -250,17 +266,26 @@ export declare class ApiCaller {
                 };
             };
         };
-    }> | undefined, `${string}/${string}`>>;
-    getSession: ({ sessionId, abortSignal, }: {
-        sessionId: string;
-        abortSignal: AbortSignal;
-    }) => Promise<import('openapi-fetch').FetchResponse<{
-        parameters: {
-            query?: never;
-            header?: never;
+    }, {
+        params: {
             path: {
                 sessionId: string;
             };
+        };
+        signal: AbortSignal;
+    }, `${string}/${string}`>>;
+    getSessions: ({ cursor, filters, abortSignal, }: {
+        cursor: string | undefined;
+        filters: Record<string, string>;
+        abortSignal?: AbortSignal;
+    }) => Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query: {
+                filters: string;
+                cursor?: string;
+            };
+            header?: never;
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -270,7 +295,7 @@ export declare class ApiCaller {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": import('./sdk/schema').components["schemas"]["WidgetSessionDto"];
+                    "application/json": import('./sdk/schema').components["schemas"]["PaginatedWidgetSessionsDto"];
                 };
             };
             500: {
@@ -284,11 +309,12 @@ export declare class ApiCaller {
         };
     }, {
         params: {
-            path: {
-                sessionId: string;
+            query: {
+                cursor: string | undefined;
+                filters: string;
             };
         };
-        signal: AbortSignal;
+        signal: AbortSignal | undefined;
     }, `${string}/${string}`>>;
     uploadFile: (file: {
         id: string;

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

@@ -1,21 +1,38 @@
 import { ApiCaller } from '../api';
 import { SessionDto } from '../types/schemas';
+import { WidgetConfig } from '../types/WidgetConfig';
 import { PubSub } from '../utils/PubSub';
+import { ContactCtx } from './contact';
+type SessionCtxState = {
+    /** The currently selected session */
+    session: SessionDto | null;
+    sessions: {
+        /** List of all user sessions */
+        data: SessionDto[];
+        /** A cursor to get the next page of sessions */
+        cursor: string | undefined;
+        /** Indicates if no more pages are left */
+        isLastPage: boolean;
+        /** Did fetch for the first time */
+        didInitialFetch: boolean;
+    };
+    isCreatingSession: boolean;
+};
 export declare class SessionCtx {
+    private config;
     private api;
+    private contactCtx;
     private poller;
-    state: PubSub<{
-        session: SessionDto | null;
-        isCreatingSession: boolean;
-    }>;
-    constructor(api: ApiCaller);
+    state: PubSub<SessionCtxState>;
+    constructor({ config, api, contactCtx, }: {
+        config: WidgetConfig;
+        api: ApiCaller;
+        contactCtx: ContactCtx;
+    });
     /** Clears the session and stops polling */
     reset: () => Promise<void>;
     registerPolling: () => void;
-    /**
-     * Creates a new session
-     * @returns The session
-     */
+    registerInitialSessionsFetch: () => void;
     createSession: () => Promise<{
         id: string;
         createdAt: string;
@@ -30,45 +47,6 @@ export declare class SessionCtx {
         channel: string;
         isVerified: boolean;
     } | null>;
-    /**
-     * Fetches the session from the API
-     * @param id - The ID of the session to fetch
-     * @returns The session
-     */
-    fetch: (sessionId: string, abortSignal: AbortSignal) => Promise<import('openapi-fetch').FetchResponse<{
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                sessionId: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": import('../sdk/schema').components["schemas"]["WidgetSessionDto"];
-                };
-            };
-            500: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": import('../sdk/schema').components["schemas"]["ErrorDto"];
-                };
-            };
-        };
-    }, {
-        params: {
-            path: {
-                sessionId: string;
-            };
-        };
-        signal: AbortSignal;
-    }, `${string}/${string}`>>;
+    loadMoreSessions: () => Promise<void>;
 }
+export {};

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

@@ -10,7 +10,6 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get the prelude for the widget */
         get: operations["widgetPrelude"];
         put?: never;
         post?: never;
@@ -36,6 +35,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/backend/widget/v2/sessions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getSessions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/backend/widget/v2/session/history/{sessionId}": {
         parameters: {
             query?: never;
@@ -93,7 +108,6 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Upload file */
         post: operations["uploadFile"];
         delete?: never;
         options?: never;
@@ -126,7 +140,6 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Create an unverified contact for the widget */
         post: operations["createUnverifiedContact"];
         delete?: never;
         options?: never;
@@ -142,6 +155,11 @@ export interface components {
             email?: string;
             name?: string;
         };
+        CreateWidgetChatSessionDto: {
+            customData?: {
+                [key: string]: string | number | boolean | unknown | unknown;
+            };
+        };
         FileUploadDto: {
             /** Format: binary */
             file: string;
@@ -214,6 +232,27 @@ export interface components {
                 url: string;
             }[] | null;
         };
+        /** @description Paginated response. */
+        PaginatedWidgetSessionsDto: {
+            items: {
+                /** 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;
+            }[];
+            /** @description The `cursor` for the request to get the next set of items. Null if there is no more data. */
+            next: string | null;
+        };
         UploadWidgetFileResponseDto: {
             fileName: string;
             fileUrl: string;
@@ -398,6 +437,39 @@ export interface operations {
             };
         };
     };
+    getSessions: {
+        parameters: {
+            query: {
+                /** @description A JSON-stringified Record<string, string>. These filters will be compared against the sessions' custom_data */
+                filters: string;
+                /** @description Pagination cursor to fetch the next set of results */
+                cursor?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedWidgetSessionsDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
     getSessionHistory: {
         parameters: {
             query?: {
@@ -438,7 +510,11 @@ export interface operations {
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateWidgetChatSessionDto"];
+            };
+        };
         responses: {
             200: {
                 headers: {

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

@@ -1,4 +1,24 @@
 import { AgentOrBotType } from './agent-or-bot';
+type UserBaseConfig = {
+    token: string;
+    data?: never;
+} | {
+    token?: never;
+    data?: {
+        name?: string;
+        email?: string;
+        phone?: string;
+        customData?: Record<string, string>;
+        avatarUrl?: string;
+    };
+};
+export type UserConfig = UserBaseConfig & {
+    /**
+     * An external ID is useful to scope the sessions of a single user based on workspace.
+     * For example, if a user uses one email for multiple accounts (organizations) in your application.
+     */
+    externalId?: string;
+};
 export interface WidgetConfig {
     token: string;
     apiUrl?: string;
@@ -8,15 +28,7 @@ export interface WidgetConfig {
     debug?: boolean;
     initialMessages?: string[];
     language?: string;
-    user?: {
-        external_id?: string;
-        name?: string;
-        email?: string;
-        phone?: string;
-        customData?: Record<string, string>;
-        avatarUrl?: string;
-    };
-    contactToken?: string;
+    user?: UserConfig;
     bot?: AgentOrBotType;
     soundEffectsUrls?: {
         messageArrived?: string;
@@ -32,3 +44,4 @@ export interface WidgetConfig {
         organizationLogo?: string;
     };
 }
+export {};

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

@@ -1,2 +1,3 @@
-declare const useDocumentDir: () => string;
+import { StringOrLiteral } from '../../core';
+declare const useDocumentDir: () => StringOrLiteral<"ltr" | "rtl">;
 export { useDocumentDir };

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

@@ -1,6 +1,12 @@
 export declare function useSession(): {
     sessionState: {
         session: import('../../core').SessionDto | null;
+        sessions: {
+            data: import('../../core').SessionDto[];
+            cursor: string | undefined;
+            isLastPage: boolean;
+            didInitialFetch: boolean;
+        };
         isCreatingSession: boolean;
     };
     sessionCtx: import('../../core').SessionCtx;

package/dist/{useUploadFiles-Cw8s18uG.js → useUploadFiles-B-HZXbPR.js}

@@ -3,7 +3,7 @@ var kt = (e, t, n) => t in e ? Kt(e, t, { enumerable: !0, configurable: !0, writ
 var Ye = (e, t, n) => kt(e, typeof t != "symbol" ? t + "" : t, n);
 import k, { createContext as rt, useContext as ot, useMemo as le, useSyncExternalStore as zt, useEffect as st, useLayoutEffect as Yt, useRef as K, useCallback as Ee, useDebugValue as Jt, useState as Xt } from "react";
 import { jsx as Qt } from "react/jsx-runtime";
-import { W as Zt } from "./widget-BeNOCqB5.js";
+import { W as Zt } from "./widget-BOaF1U-p.js";
 import { v4 as en } from "uuid";
 class tn {
   constructor(t) {
@@ -50,7 +50,7 @@ function nn(e) {
     return r;
   }, t.Provider];
 }
-const rn = "3.0.8", [te, on] = nn();
+const rn = "3.0.11", [te, on] = nn();
 function tr({
   options: e,
   children: t,
@@ -1333,4 +1333,4 @@ export {
   ir as m,
   te as u
 };
-//# sourceMappingURL=useUploadFiles-Cw8s18uG.js.map
+//# sourceMappingURL=useUploadFiles-B-HZXbPR.js.map