@botonic/webchat-core 2.23.0

package/src/lib/machines/webchat.d.ts

@@ -0,0 +1,641 @@
+import { type HubtypeUser, type WebchatMessage } from '@botonic/shared';
+import { ActorRefFrom } from 'xstate';
+import { ConnectionStatus, WebchatConfig } from '../domain';
+import { type StorageRepository, type StoredMessage } from '../infra/repositories';
+import { WebchatService } from '../services/webchat-service';
+import { WebchatMessageMachine, WebchatMessageStatus } from './message';
+import { OverlayMachineActor } from './overlay';
+export interface WebchatConnectionConfig {
+    appId: string;
+    apiUrl?: string;
+    pusherAppKey?: string;
+    pusherCluster?: string;
+}
+export interface ConnectedWebchatContext {
+    user: HubtypeUser;
+    messages: StoredMessage[];
+    messageActors: Map<string, ActorRefFrom<typeof WebchatMessageMachine>>;
+    storageRepository: StorageRepository;
+    webchatService: WebchatService;
+    appId: string;
+    config: WebchatConnectionConfig;
+}
+type InitializedWebchatContext = ConnectedWebchatContext;
+export interface WebchatControllerContext extends Partial<ConnectedWebchatContext> {
+    config: WebchatConfig;
+    isOpen: boolean;
+    connectionStatus: ConnectionStatus;
+    messageActors: Map<string, ActorRefFrom<typeof WebchatMessageMachine>>;
+    reconnectAttempt?: number;
+    isTypingOn: boolean;
+    overlayActor: OverlayMachineActor;
+}
+/**
+ * Main webchat machine that handles the complete lifecycle
+ *
+ * Flow:
+ * 1. idle → initializing (setup services, load session)
+ * 2. initializing → operational (ready for messaging)
+ * 3. operational → (handle messages, connections, UI state)
+ */
+export declare const WebchatMachine: import("xstate").StateMachine<WebchatControllerContext, {
+    type: "INITIALIZE";
+} | {
+    type: "RETRY_INITIALIZATION";
+} | {
+    type: "RETRY_CONNECTION";
+} | {
+    type: "CONNECTION_STATUS_CHANGED";
+    status: string;
+} | {
+    type: "RECONNECT";
+} | {
+    type: "CANCEL_RECONNECT";
+} | {
+    type: "SET_ONLINE";
+    online: boolean;
+} | {
+    type: "SET_TYPING";
+    isTypingOn: boolean;
+} | {
+    type: "TOGGLE_WEBCHAT";
+    isOpen?: boolean;
+} | {
+    type: "SEND_MESSAGE";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_RECEIVED";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_STATUS_CHANGED";
+    messageId: string;
+    status: WebchatMessageStatus;
+    message: WebchatMessage;
+} | {
+    type: "UPDATE_USER";
+    user: Partial<HubtypeUser>;
+} | {
+    type: "CLEAR_MESSAGES";
+} | {
+    type: "UPDATE_MESSAGE";
+    messageId: string;
+    updates: Partial<WebchatMessage>;
+} | {
+    type: "DELETE_MESSAGE";
+    messageId: string;
+} | {
+    type: "PERSISTENCE.SAVE_MESSAGE";
+} | {
+    type: "WEBVIEW.OPEN";
+    url: string;
+    title?: string;
+}, {
+    [x: string]: import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<{
+        webchatService: WebchatService;
+        storageRepository: StorageRepository;
+    }, {
+        config: WebchatConfig;
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<StoredMessage[], {
+        storageRepository: StorageRepository;
+        appId: string;
+        userId: string;
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<HubtypeUser | null, {
+        storageRepository: StorageRepository;
+        appId: string;
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+        attempt: number;
+    }, import("xstate").EventObject>> | undefined;
+}, {
+    src: "initializeWebchatService";
+    logic: import("xstate").PromiseActorLogic<{
+        webchatService: WebchatService;
+        storageRepository: StorageRepository;
+    }, {
+        config: WebchatConfig;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "loadMessages";
+    logic: import("xstate").PromiseActorLogic<StoredMessage[], {
+        storageRepository: StorageRepository;
+        appId: string;
+        userId: string;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "loadLastUser";
+    logic: import("xstate").PromiseActorLogic<HubtypeUser | null, {
+        storageRepository: StorageRepository;
+        appId: string;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "initializeRealtimeConnection";
+    logic: import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "reconnectToRealtime";
+    logic: import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+        attempt: number;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+}, {
+    type: "assignWebchatService";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "assignLoadedUser";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "createAnonymousUser";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "assignLoadedMessages";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "spawnPersistedMessageActors";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "saveUser";
+    params: unknown;
+} | {
+    type: "forwardWebviewOpenToOverlay";
+    params: unknown;
+} | {
+    type: "subscribeToWebchatService";
+    params: unknown;
+} | {
+    type: "cleanupWebchatServiceSubscriptions";
+    params: unknown;
+} | {
+    type: "toggleWebchat";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitWebchatToggled";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "updateConnectionStatus";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "addMessage";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "saveMessages";
+    params: unknown;
+} | {
+    type: "emitMessageAdded";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageSent";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageReceived";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageUpdated";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessagesCleared";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitUserUpdated";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitWebchatOpened";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitWebchatClosed";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitInitializationStarted";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitInitializationCompleted";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitInitializationFailed";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitConnectionChanged";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageDeleted";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "updateUser";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "clearMessages";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "updateMessage";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "deleteMessage";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "setTyping";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "setTypingExternal";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "setOnline";
+    params: unknown;
+}, {
+    type: "isInitialized";
+    params: unknown;
+} | {
+    type: "hasLoadedUser";
+    params: unknown;
+} | {
+    type: "isMaxReconnectAttempts";
+    params: unknown;
+} | {
+    type: "isTypingEvent";
+    params: unknown;
+}, never, "idle" | "connectionFailed" | "reconnecting" | "operational" | {
+    initializing: "initializingServices" | "loadingSession" | "loadingMessages" | "connectingToRealtime" | "spawningPersistedMessages";
+}, string, WebchatConfig, import("xstate").NonReducibleUnknown, {
+    type: "INITIALIZATION_STARTED";
+} | {
+    type: "INITIALIZATION_COMPLETED";
+    context: InitializedWebchatContext;
+} | {
+    type: "INITIALIZATION_FAILED";
+    error: string;
+} | {
+    type: "MESSAGE_ADDED";
+    message: WebchatMessage;
+    actor: any;
+} | {
+    type: "MESSAGE_SENT";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_RECEIVED";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_UPDATED";
+    messageId: string;
+    updates: Partial<WebchatMessage>;
+} | {
+    type: "MESSAGE_DELETED";
+    messageId: string;
+} | {
+    type: "MESSAGES_CLEARED";
+} | {
+    type: "USER_UPDATED";
+    user: Partial<HubtypeUser>;
+} | {
+    type: "TYPING_CHANGED";
+    isTyping: boolean;
+} | {
+    type: "WEBCHAT_OPENED";
+} | {
+    type: "WEBCHAT_CLOSED";
+} | {
+    type: "CONNECTION_CHANGED";
+    status: ConnectionStatus;
+} | {
+    type: "STATUS_CHANGED";
+    status: ConnectionStatus;
+}, import("xstate").MetaObject, {
+    id: "webchat";
+    states: {
+        readonly idle: {};
+        readonly initializing: {
+            states: {
+                readonly initializingServices: {};
+                readonly loadingSession: {};
+                readonly loadingMessages: {};
+                readonly spawningPersistedMessages: {};
+                readonly connectingToRealtime: {};
+            };
+        };
+        readonly connectionFailed: {};
+        readonly reconnecting: {};
+        readonly operational: {};
+    };
+}>;
+export declare function createWebchatMachine(webchatConfig: WebchatConfig): import("xstate").Actor<import("xstate").StateMachine<WebchatControllerContext, {
+    type: "INITIALIZE";
+} | {
+    type: "RETRY_INITIALIZATION";
+} | {
+    type: "RETRY_CONNECTION";
+} | {
+    type: "CONNECTION_STATUS_CHANGED";
+    status: string;
+} | {
+    type: "RECONNECT";
+} | {
+    type: "CANCEL_RECONNECT";
+} | {
+    type: "SET_ONLINE";
+    online: boolean;
+} | {
+    type: "SET_TYPING";
+    isTypingOn: boolean;
+} | {
+    type: "TOGGLE_WEBCHAT";
+    isOpen?: boolean;
+} | {
+    type: "SEND_MESSAGE";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_RECEIVED";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_STATUS_CHANGED";
+    messageId: string;
+    status: WebchatMessageStatus;
+    message: WebchatMessage;
+} | {
+    type: "UPDATE_USER";
+    user: Partial<HubtypeUser>;
+} | {
+    type: "CLEAR_MESSAGES";
+} | {
+    type: "UPDATE_MESSAGE";
+    messageId: string;
+    updates: Partial<WebchatMessage>;
+} | {
+    type: "DELETE_MESSAGE";
+    messageId: string;
+} | {
+    type: "PERSISTENCE.SAVE_MESSAGE";
+} | {
+    type: "WEBVIEW.OPEN";
+    url: string;
+    title?: string;
+}, {
+    [x: string]: import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<{
+        webchatService: WebchatService;
+        storageRepository: StorageRepository;
+    }, {
+        config: WebchatConfig;
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<StoredMessage[], {
+        storageRepository: StorageRepository;
+        appId: string;
+        userId: string;
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<HubtypeUser | null, {
+        storageRepository: StorageRepository;
+        appId: string;
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+    }, import("xstate").EventObject>> | import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+        attempt: number;
+    }, import("xstate").EventObject>> | undefined;
+}, {
+    src: "initializeWebchatService";
+    logic: import("xstate").PromiseActorLogic<{
+        webchatService: WebchatService;
+        storageRepository: StorageRepository;
+    }, {
+        config: WebchatConfig;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "loadMessages";
+    logic: import("xstate").PromiseActorLogic<StoredMessage[], {
+        storageRepository: StorageRepository;
+        appId: string;
+        userId: string;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "loadLastUser";
+    logic: import("xstate").PromiseActorLogic<HubtypeUser | null, {
+        storageRepository: StorageRepository;
+        appId: string;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "initializeRealtimeConnection";
+    logic: import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+} | {
+    src: "reconnectToRealtime";
+    logic: import("xstate").PromiseActorLogic<{
+        success: boolean;
+    }, {
+        webchatService: WebchatService;
+        user: HubtypeUser;
+        messages: WebchatMessage[];
+        attempt: number;
+    }, import("xstate").EventObject>;
+    id: string | undefined;
+}, {
+    type: "assignWebchatService";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "assignLoadedUser";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "createAnonymousUser";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "assignLoadedMessages";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "spawnPersistedMessageActors";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "saveUser";
+    params: unknown;
+} | {
+    type: "forwardWebviewOpenToOverlay";
+    params: unknown;
+} | {
+    type: "subscribeToWebchatService";
+    params: unknown;
+} | {
+    type: "cleanupWebchatServiceSubscriptions";
+    params: unknown;
+} | {
+    type: "toggleWebchat";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitWebchatToggled";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "updateConnectionStatus";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "addMessage";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "saveMessages";
+    params: unknown;
+} | {
+    type: "emitMessageAdded";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageSent";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageReceived";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageUpdated";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessagesCleared";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitUserUpdated";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitWebchatOpened";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitWebchatClosed";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitInitializationStarted";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitInitializationCompleted";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitInitializationFailed";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitConnectionChanged";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "emitMessageDeleted";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "updateUser";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "clearMessages";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "updateMessage";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "deleteMessage";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "setTyping";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "setTypingExternal";
+    params: import("xstate").NonReducibleUnknown;
+} | {
+    type: "setOnline";
+    params: unknown;
+}, {
+    type: "isInitialized";
+    params: unknown;
+} | {
+    type: "hasLoadedUser";
+    params: unknown;
+} | {
+    type: "isMaxReconnectAttempts";
+    params: unknown;
+} | {
+    type: "isTypingEvent";
+    params: unknown;
+}, never, "idle" | "connectionFailed" | "reconnecting" | "operational" | {
+    initializing: "initializingServices" | "loadingSession" | "loadingMessages" | "connectingToRealtime" | "spawningPersistedMessages";
+}, string, WebchatConfig, import("xstate").NonReducibleUnknown, {
+    type: "INITIALIZATION_STARTED";
+} | {
+    type: "INITIALIZATION_COMPLETED";
+    context: InitializedWebchatContext;
+} | {
+    type: "INITIALIZATION_FAILED";
+    error: string;
+} | {
+    type: "MESSAGE_ADDED";
+    message: WebchatMessage;
+    actor: any;
+} | {
+    type: "MESSAGE_SENT";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_RECEIVED";
+    message: WebchatMessage;
+} | {
+    type: "MESSAGE_UPDATED";
+    messageId: string;
+    updates: Partial<WebchatMessage>;
+} | {
+    type: "MESSAGE_DELETED";
+    messageId: string;
+} | {
+    type: "MESSAGES_CLEARED";
+} | {
+    type: "USER_UPDATED";
+    user: Partial<HubtypeUser>;
+} | {
+    type: "TYPING_CHANGED";
+    isTyping: boolean;
+} | {
+    type: "WEBCHAT_OPENED";
+} | {
+    type: "WEBCHAT_CLOSED";
+} | {
+    type: "CONNECTION_CHANGED";
+    status: ConnectionStatus;
+} | {
+    type: "STATUS_CHANGED";
+    status: ConnectionStatus;
+}, import("xstate").MetaObject, {
+    id: "webchat";
+    states: {
+        readonly idle: {};
+        readonly initializing: {
+            states: {
+                readonly initializingServices: {};
+                readonly loadingSession: {};
+                readonly loadingMessages: {};
+                readonly spawningPersistedMessages: {};
+                readonly connectingToRealtime: {};
+            };
+        };
+        readonly connectionFailed: {};
+        readonly reconnecting: {};
+        readonly operational: {};
+    };
+}>>;
+export {};