@opencx/widget 3.0.99 → 4.0.17

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

@@ -1,25 +0,0 @@
-import { ApiCaller } from '../api/api-caller';
-import { MessageType } from '../types/messages';
-import { ActionCallDto, MessageDto } from '../types/dtos';
-import { WidgetConfig } from '../types/widget-config';
-import { MessageCtx } from './message.ctx';
-import { SessionCtx } from './session.ctx';
-export declare class ActiveSessionPollingCtx {
-    private api;
-    private config;
-    private sessionCtx;
-    private messageCtx;
-    private sessionPollingIntervalSeconds;
-    private poller;
-    constructor({ api, config, sessionCtx, messageCtx, sessionPollingIntervalSeconds, }: {
-        api: ApiCaller;
-        config: WidgetConfig;
-        sessionCtx: SessionCtx;
-        messageCtx: MessageCtx;
-        sessionPollingIntervalSeconds: number;
-    });
-    private registerPolling;
-    private hackAndSlash;
-    mapHistoryToMessage: (history: MessageDto) => MessageType;
-    extractActionResult: (action: ActionCallDto) => any;
-}

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

@@ -1,30 +0,0 @@
-import { PrimitiveState } from '../utils/PrimitiveState';
-import { ApiCaller } from '../api/api-caller';
-import { WidgetConfig } from '../types/widget-config';
-import { Dto } from '../api/client';
-import { StorageCtx } from './storage.ctx';
-type ContactState = {
-    contact: {
-        token: string;
-        externalId: string | undefined;
-    } | null;
-    extraCollectedData: Record<string, string> | undefined;
-    isCreatingUnverifiedContact: boolean;
-    isErrorCreatingUnverifiedContact: boolean;
-};
-export declare class ContactCtx {
-    private config;
-    private storageCtx?;
-    private api;
-    state: PrimitiveState<ContactState>;
-    constructor({ config, api, storageCtx, }: {
-        api: ApiCaller;
-        config: WidgetConfig;
-        storageCtx?: StorageCtx;
-    });
-    shouldCollectData: () => boolean;
-    private autoCreateUnverifiedUserIfNotExists;
-    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,38 +0,0 @@
-import { ApiCaller } from '../api/api-caller';
-import { WidgetConfig } from '../types/widget-config';
-import { MessageType } from '../types/messages';
-import { SendMessageDto } from '../types/dtos';
-import { PrimitiveState } from '../utils/PrimitiveState';
-import { SessionCtx } from './session.ctx';
-import { ContactCtx } from './contact.ctx';
-type MessageCtxState = {
-    messages: MessageType[];
-    isSendingMessage: boolean;
-    lastAIResMightSolveUserIssue: boolean;
-    isInitialFetchLoading: boolean;
-};
-export declare class MessageCtx {
-    private config;
-    private api;
-    private contactCtx;
-    private sessionCtx;
-    state: PrimitiveState<MessageCtxState>;
-    private sendMessageAbortController;
-    constructor({ config, api, sessionCtx, contactCtx, }: {
-        config: WidgetConfig;
-        api: ApiCaller;
-        sessionCtx: SessionCtx;
-        contactCtx: ContactCtx;
-    });
-    reset: () => void;
-    sendMessage: (input: {
-        content: SendMessageDto["content"];
-        attachments?: SendMessageDto["attachments"];
-        customData?: SendMessageDto["custom_data"];
-        exitModePrompt?: string;
-    }) => Promise<void>;
-    private toUserMessage;
-    private toBotMessage;
-    private toBotErrorMessage;
-}
-export {};

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

@@ -1,33 +0,0 @@
-import { WidgetConfig } from '../types/widget-config';
-import { PrimitiveState } from '../utils/PrimitiveState';
-import { ContactCtx } from './contact.ctx';
-import { SessionCtx } from './session.ctx';
-import { WidgetCtx } from './widget.ctx';
-export type ScreenU = /** 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'
-/** Self-explanatory */
- | 'chat';
-type RouterState = {
-    screen: ScreenU;
-};
-export declare class RouterCtx {
-    state: PrimitiveState<RouterState>;
-    private config;
-    private contactCtx;
-    private sessionCtx;
-    private resetChat;
-    constructor({ config, contactCtx, sessionCtx, resetChat, }: {
-        config: WidgetConfig;
-        contactCtx: ContactCtx;
-        sessionCtx: SessionCtx;
-        resetChat: WidgetCtx['resetChat'];
-    });
-    private registerRoutingListener;
-    toSessionsScreen: () => void;
-    /**
-     * @param sessionId The ID of the session to open, or `undefined` if it is a new chat session
-     */
-    toChatScreen: (sessionId?: string) => void;
-}
-export {};

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

@@ -1,119 +0,0 @@
-import { ApiCaller } from '../api/api-caller';
-import { Dto } from '../api/client';
-import { SessionDto } from '../types/dtos';
-import { WidgetConfig } from '../types/widget-config';
-import { PrimitiveState } from '../utils/PrimitiveState';
-import { ContactCtx } from './contact.ctx';
-type SessionState = {
-    /**
-     * The currently selected session.
-     * Can be null if no session is selected, or if in chat screen and the session is not created yet.
-     */
-    session: SessionDto | null;
-    isCreatingSession: boolean;
-    isResolvingSession: boolean;
-};
-type SessionsState = {
-    /** 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 */
-    didStartInitialFetch: boolean;
-    isInitialFetchLoading: boolean;
-};
-export declare class SessionCtx {
-    private config;
-    private api;
-    private contactCtx;
-    private sessionsPollingIntervalSeconds;
-    private sessionsRefresher;
-    sessionState: PrimitiveState<SessionState>;
-    sessionsState: PrimitiveState<SessionsState>;
-    constructor({ config, api, contactCtx, sessionsPollingIntervalSeconds, }: {
-        config: WidgetConfig;
-        api: ApiCaller;
-        contactCtx: ContactCtx;
-        sessionsPollingIntervalSeconds: number;
-    });
-    /** Clears the session and stops polling */
-    reset: () => Promise<void>;
-    private registerSessionsRefresherWrapper;
-    private registerSessionsRefresher;
-    createSession: () => Promise<{
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        isHandedOff: boolean;
-        isOpened: boolean;
-        assignee: {
-            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;
-    } | null>;
-    loadMoreSessions: () => Promise<void>;
-    private getSessions;
-    setSessions: (data: SessionDto[]) => void;
-    refreshSessions: () => Promise<void>;
-    resolveSession: () => Promise<{
-        readonly success: false;
-        readonly error: "Session is not opened";
-        readonly data?: undefined;
-    } | {
-        readonly success: true;
-        readonly data: {
-            id: string;
-            createdAt: string;
-            updatedAt: string;
-            isHandedOff: boolean;
-            isOpened: boolean;
-            assignee: {
-                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;
-        };
-        readonly error?: undefined;
-    } | {
-        readonly success: false;
-        readonly error: {
-            statusCode?: number;
-            message?: string;
-            error?: string;
-        };
-        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/context/storage.ctx.d.ts

@@ -1,15 +0,0 @@
-import { ExternalStorage } from '../types/external-storage';
-import { WidgetConfig } from '../types/widget-config';
-export declare class StorageCtx {
-    private storage;
-    private config;
-    private KEYS;
-    constructor({ storage, config, }: {
-        storage: ExternalStorage;
-        config: WidgetConfig;
-    });
-    setContactToken: (token: string) => Promise<void>;
-    getContactToken: () => Promise<string | null>;
-    setExternalContactId: (id: string) => Promise<void>;
-    getExternalContactId: () => Promise<string | null>;
-}

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

@@ -1,27 +0,0 @@
-import { ApiCaller } from '../api/api-caller';
-import { ModeDto } from '../types/dtos';
-import { ExternalStorage } from '../types/external-storage';
-import { WidgetConfig } from '../types/widget-config';
-import { ContactCtx } from './contact.ctx';
-import { MessageCtx } from './message.ctx';
-import { RouterCtx } from './router.ctx';
-import { SessionCtx } from './session.ctx';
-import { StorageCtx } from './storage.ctx';
-export declare class WidgetCtx {
-    config: WidgetConfig;
-    api: ApiCaller;
-    contactCtx: ContactCtx;
-    sessionCtx: SessionCtx;
-    messageCtx: MessageCtx;
-    routerCtx: RouterCtx;
-    storageCtx?: StorageCtx;
-    modes: ModeDto[];
-    private static pollingIntervalsSeconds;
-    private activeSessionPollingCtx;
-    private constructor();
-    static initialize: ({ config, storage, }: {
-        config: WidgetConfig;
-        storage?: ExternalStorage;
-    }) => Promise<WidgetCtx>;
-    resetChat: () => void;
-}

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

@@ -1,15 +0,0 @@
-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, ModeDto, } from './types/dtos';
-export type { WidgetConfig, HeaderButtonU, ModeComponent, ModeComponentProps, } from './types/widget-config';
-export type { ExternalStorage } from './types/external-storage';
-export type { OpenCxComponentNameU } from './types/component-name';
-export type { IconNameU } from './types/icons';
-export { WidgetCtx } from './context/widget.ctx';
-export type { ContactCtx } from './context/contact.ctx';
-export type { SessionCtx } from './context/session.ctx';
-export type { MessageCtx } from './context/message.ctx';
-export type { RouterCtx, ScreenU } from './context/router.ctx';
-export { PrimitiveState } from './utils/PrimitiveState';
-export { isExhaustive } from './utils/is-exhaustive';

package/dist/src/headless/core/types/agent-or-bot.d.ts

@@ -1,6 +0,0 @@
-export type AgentOrBotType = {
-    isAi: boolean;
-    id: string | null;
-    name: string;
-    avatar: string | null;
-};

package/dist/src/headless/core/types/component-name.d.ts

@@ -1 +0,0 @@
-export type OpenCxComponentNameU = 'ui_lib/btn' | 'trigger/btn' | 'sessions/root' | 'sessions/header' | 'sessions/new_conversation_btn' | 'chat/root' | 'chat/header' | 'chat/main/root' | 'chat/canvas/root' | 'chat/msgs/root' | 'chat/agent_msg_group/root' | 'chat/agent_msg_group/avatar_and_msgs/root' | 'chat/agent_msg_group/avatar_and_msgs/avatar' | 'chat/agent_msg_group/avatar_and_msgs/msgs' | 'chat/agent_msg_group/root/avatar' | 'chat/agent_msg_group/suggestions' | 'chat/agent_msg/root' | 'chat/agent_msg/msg' | 'chat/persistent_initial_msgs/root' | 'chat/persistent_initial_msg/root' | 'chat/persistent_initial_msg/msg' | 'chat/user_msg_group/root' | 'chat/user_msg_group/avatar/root' | 'chat/user_msg/root' | 'chat/user_msg/msg' | 'chat/input_box/root' | 'chat/input_box/inner_root' | 'chat/input_box/textarea_and_attachments_container' | 'chat/input_box/textarea' | 'chat/input_box/attachments_container' | 'chat/bot_loading/root' | 'chat/bot_loading/bouncing_dots_container' | 'chat/suggested_reply_btn' | 'chat/might_solve_user_issue_suggested_replies_container';

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

@@ -1,12 +0,0 @@
-import { Dto } from '../api/client';
-export type VoteInputDto = Dto['WidgetVoteDto'];
-export type VoteOutputDto = Dto['WidgetVoteResponseDto'];
-export type SendMessageDto = Dto['WidgetSendMessageInputDto'];
-export type SendMessageOutputDto = Dto['WidgetSendMessageOutputDto'];
-export type ResolveSessionDto = Dto['WidgetResolveSessionInputDto'];
-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 ModeDto = Dto['WidgetConfigDto']['modes'][number];

package/dist/src/headless/core/types/external-storage.d.ts

@@ -1,5 +0,0 @@
-export type ExternalStorage = {
-    get: (key: string) => Promise<string | null>;
-    set: (key: string, value: string) => Promise<void>;
-    remove: (key: string) => Promise<void>;
-};

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

@@ -1,2 +0,0 @@
-export type SafeExtract<T, K extends T> = Extract<T, K>;
-export type StringOrLiteral<T extends string> = T | (string & {});

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

@@ -1,3 +0,0 @@
-import { icons } from 'lucide';
-import { SafeExtract } from './helpers';
-export type IconNameU = SafeExtract<keyof typeof icons, 'Maximize' | 'Maximize2' | 'Minimize' | 'Minimize2' | 'Expand' | 'Shrink' | 'X' | 'SquareX' | 'CircleX' | 'Check' | 'CheckCheck' | 'CircleCheck' | 'CircleCheckBig' | 'SquareCheck' | 'SquareCheckBig'>;

package/dist/src/headless/core/types/json-value.d.ts

@@ -1,7 +0,0 @@
-type JsonArray = JsonValue[];
-type JsonObject = {
-    [x: string]: JsonValue | undefined;
-};
-type JsonPrimitive = boolean | number | string | null;
-export type JsonValue = JsonArray | JsonObject | JsonPrimitive;
-export {};

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

@@ -1,55 +0,0 @@
-import { MessageAttachmentType, MessageDto } from './dtos';
-import { SafeExtract, StringOrLiteral } from './helpers';
-import { AgentOrBotType } from './agent-or-bot';
-export type LiteralWidgetComponentKey = 'bot_message' | 'agent_message' | 'loading' | 'fallback';
-export type WidgetComponentKey = StringOrLiteral<LiteralWidgetComponentKey>;
-export type UserMessageType = {
-    id: string;
-    type: 'FROM_USER';
-    content: string;
-    deliveredAt: string | null;
-    attachments?: MessageAttachmentType[] | null;
-    timestamp: string;
-    user?: {
-        name?: string;
-        email?: string;
-        phone?: string;
-        customData?: Record<string, string>;
-        avatarUrl?: string;
-    };
-};
-export type BotMessageType<TActionData = unknown> = {
-    id: string;
-    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'>>;
-    data: {
-        message: string;
-        variant?: 'default' | 'error';
-        action?: {
-            name: string;
-            data: TActionData;
-        } | null;
-    };
-    timestamp: string;
-    original?: MessageDto;
-    agent?: AgentOrBotType;
-    attachments?: MessageAttachmentType[];
-};
-export type AgentMessageType = {
-    id: string;
-    type: 'FROM_AGENT';
-    component: SafeExtract<LiteralWidgetComponentKey, 'agent_message'>;
-    data: {
-        message: string;
-        variant?: 'default' | 'error';
-        action?: undefined;
-    };
-    timestamp?: string;
-    original?: MessageDto;
-    agent?: AgentOrBotType;
-    attachments?: MessageAttachmentType[];
-};
-export type MessageType = UserMessageType | BotMessageType | AgentMessageType;