@servicetitan/titan-chat-ui-common 3.0.0

package/dist/stores/chat-ui.store.d.ts

@@ -0,0 +1,153 @@
+import { ChatConfiguration, ChatCustomizations, ChatEndReason, ChatError, ChatErrorOptions, ChatMessageModelBase, ChatMessageModelFile, ChatMessageModelText, ChatMessageModelTimeout, ChatMessageModelWelcome, ChatMessageState, ChatParticipantIcon, ChatParticipantModel, ChatRunState, ChatTimer } from '../models';
+import { FileDescriptor } from '../models/file-descriptor';
+export declare const symbolAgent: unique symbol;
+export declare const symbolUser: unique symbol;
+export declare enum ChatUiEvent {
+    eventRun = "eventRun",
+    eventDestroy = "eventDestroy",
+    eventRestart = "eventRestart",
+    eventCancel = "eventCancel",
+    eventEndChat = "eventEndChat",
+    eventRecover = "eventRecover",
+    eventChasitorTyping = "eventChasitorTyping",
+    eventTimerRestart = "eventTimerRestart",
+    eventMessageSend = "eventMessageSend",
+    eventMessageSendRetry = "eventMessageSendRetry",
+    eventMessageSendFile = "eventMessageSendFile",
+    eventMessageSendFileRetry = "eventMessageSendFileRetry"
+}
+export type ChatUiEventListener<T = void> = (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, ...args: unknown[]) => void;
+export interface IChatUiStore<T extends ChatCustomizations = ChatCustomizations> {
+    scrollCounter: number;
+    status: ChatRunState;
+    get isStarting(): boolean;
+    get isStarted(): boolean;
+    get isError(): boolean;
+    get isEnded(): boolean;
+    get customizations(): T;
+    timer?: ChatTimer;
+    endReason?: ChatEndReason;
+    participants: {
+        [key: symbol]: ChatParticipantModel;
+    };
+    messages: ChatMessageModelBase[];
+    isAgentTyping: boolean;
+    isFilePickerEnabled: boolean;
+    file?: FileDescriptor;
+    error?: ChatError;
+    get agent(): ChatParticipantModel;
+    get user(): ChatParticipantModel;
+    on<T>(event: string, listener: ChatUiEventListener<T>): void;
+    off<T>(event: string, listener: ChatUiEventListener<T>): void;
+    setCustomizationContext(customizationContext?: T): void;
+    setIncomingSound(soundUrl: string): void;
+    setTimer(timer?: ChatTimer): void;
+    setFile(file: FileDescriptor | undefined): void;
+    setFilePickerEnabled(isEnabled: boolean): void;
+    setAgentTyping(typing: boolean): void;
+    setMessageState(message: ChatMessageModelBase, state: ChatMessageState, data?: any): void;
+    setMessages(messages: ChatMessageModelBase[]): void;
+    setAgentName(name: string): void;
+    setAgentIcon(icon: ChatParticipantIcon): void;
+    setChatError(chatError: ChatError): void;
+    setError<T = any>(message: string, options?: ChatErrorOptions<T>): void;
+    setStatus(status: ChatRunState): void;
+    resetError(runState: ChatRunState): void;
+    reset(resetStatus?: boolean): void;
+    resetFile(): void;
+    triggerScroll(): void;
+    configure(configuration?: ChatConfiguration): void;
+    run(configuration?: ChatConfiguration, data?: unknown): Promise<void>;
+    recover(): Promise<void>;
+    destroy(): Promise<void>;
+    chasitorTyping(isTyping: boolean): Promise<void>;
+    restartTimers(): Promise<void>;
+    restart(): Promise<void>;
+    cancelChat(): Promise<void>;
+    endChat(endReason?: ChatEndReason): Promise<void>;
+    sendMessageText(messageText: string): Promise<void>;
+    sendMessageRetry(message: ChatMessageModelBase): Promise<void>;
+    addMessage(isAgent: boolean, message: string, data?: any): void;
+    addMessageWelcome(message: string): void;
+}
+export declare const CHAT_UI_STORE_TOKEN: import("@servicetitan/react-ioc").SymbolToken<IChatUiStore<Partial<{
+    messageTemplates: import("..").ChatMessageTemplateCustomizations;
+    messages: import("..").ChatMessageCustomization[];
+    messageTyping: import("..").ChatMessageTypingCustomization;
+    input: import("..").ChatInputCustomization;
+    footerComponent: import("react").ReactNode;
+    loadingComponent: import("react").ReactNode;
+}>>>;
+export declare class ChatUiStore<T extends ChatCustomizations> implements IChatUiStore<T> {
+    isAgentTyping: boolean;
+    status: ChatRunState;
+    isFilePickerEnabled: boolean;
+    file?: FileDescriptor;
+    error?: ChatError;
+    endReason?: ChatEndReason;
+    messages: ChatMessageModelBase[];
+    currentFileMessage?: ChatMessageModelFile;
+    scrollCounter: number;
+    timer?: ChatTimer;
+    participants: {
+        [key: symbol]: ChatParticipantModel;
+    };
+    get agent(): ChatParticipantModel;
+    get user(): ChatParticipantModel;
+    get isStarted(): boolean;
+    get isError(): boolean;
+    get isEnded(): boolean;
+    get isStarting(): boolean;
+    get customizations(): T;
+    protected customizationContext: T;
+    private eventEmitter;
+    private incomingMessageSound?;
+    private incomingMessageSoundPromise?;
+    constructor();
+    on: <T>(event: string, listener: ChatUiEventListener<T_1>) => void;
+    off: <T>(event: string, listener: ChatUiEventListener<T_1>) => void;
+    setCustomizationContext(customizationContext?: T): void;
+    setIncomingSound(soundUrl: string): void;
+    setFile(file?: FileDescriptor): void;
+    setFilePickerEnabled(isEnabled: boolean): void;
+    setTimer(timer?: ChatTimer): void;
+    resetError(runState: ChatRunState): void;
+    setChatError(chatError: ChatError): void;
+    setError<T = any>(message: string, options?: ChatErrorOptions<T>): void;
+    setStatus(status: ChatRunState): void;
+    setMessages(messages: ChatMessageModelBase[]): void;
+    setAgentName(name: string): void;
+    setAgentIcon(icon: ChatParticipantIcon): void;
+    setAgentTyping(isAgentTyping: boolean): void;
+    setEndReason(reason?: ChatEndReason): void;
+    setEndedChatState(endReason: ChatEndReason): void;
+    configure(configuration?: ChatConfiguration): void;
+    run(configuration?: ChatConfiguration, data?: unknown): Promise<void>;
+    recover(): Promise<void>;
+    destroy(): Promise<void>;
+    restart(): Promise<void>;
+    cancelChat(): Promise<void>;
+    endChat(endReason?: ChatEndReason): Promise<void>;
+    chasitorTyping(isTyping: boolean): Promise<void>;
+    sendMessageText(message: string): Promise<void>;
+    sendMessageRetry(messageModel: ChatMessageModelBase): Promise<void>;
+    sendMessageFileRetry(messageModel: ChatMessageModelFile): Promise<void>;
+    getParticipant(participantKey: symbol): ChatParticipantModel;
+    addMessage(isAgent: boolean, message: string, data?: any): ChatMessageModelText;
+    addMessageTimeout(): ChatMessageModelTimeout | undefined;
+    addMessageWelcome(message: string): ChatMessageModelWelcome;
+    addMessageFile(file: FileDescriptor): ChatMessageModelFile;
+    restartTimers(): Promise<void>;
+    setMessageState(message: ChatMessageModelBase, state: ChatMessageState, data?: any): void;
+    resetFile(): void;
+    reset(resetStatus?: boolean): void;
+    getLastFailedMessages(): ChatMessageModelText[];
+    triggerScroll(): void;
+    protected emitAsync<T>(event: string, ...args: unknown[]): Promise<void | T>;
+    protected addMessageInternal<T extends ChatMessageModelBase>(message: Omit<T, 'id' | 'timestamp'>): T;
+    protected removeMessageByType(type: string): void;
+    private sendMessageTextInternal;
+    private createMessage;
+    private beepIncoming;
+}
+//# sourceMappingURL=chat-ui.store.d.ts.map

package/dist/stores/chat-ui.store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-ui.store.d.ts","sourceRoot":"","sources":["../../src/stores/chat-ui.store.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,EACvB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,eAAO,MAAM,WAAW,eAA6B,CAAC;AACtD,eAAO,MAAM,UAAU,eAA4B,CAAC;AAEpD,oBAAY,WAAW;IACnB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,gBAAgB,qBAAqB;IACrC,qBAAqB,0BAA0B;IAC/C,oBAAoB,yBAAyB;IAC7C,yBAAyB,8BAA8B;CAC1D;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,IAAI,IAAI,CACxC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,EAC9B,GAAG,IAAI,EAAE,OAAO,EAAE,KACjB,IAAI,CAAC;AAEV,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB;IAC3E,aAAa,EAAE,MAAM,CAAC;IAEtB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,UAAU,IAAI,OAAO,CAAC;IAC1B,IAAI,SAAS,IAAI,OAAO,CAAC;IACzB,IAAI,OAAO,IAAI,OAAO,CAAC;IACvB,IAAI,OAAO,IAAI,OAAO,CAAC;IACvB,IAAI,cAAc,IAAI,CAAC,CAAC;IACxB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,CAAA;KAAE,CAAC;IACtD,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB,IAAI,KAAK,IAAI,oBAAoB,CAAC;IAClC,IAAI,IAAI,IAAI,oBAAoB,CAAC;IAEjC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC7D,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE9D,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IACxD,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAClC,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI,CAAC;IAChD,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/C,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAC1F,WAAW,CAAC,QAAQ,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IACpD,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC9C,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IACzC,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACxE,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IACtC,UAAU,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IACzC,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,SAAS,IAAI,IAAI,CAAC;IAElB,aAAa,IAAI,IAAI,CAAC;IACtB,SAAS,CAAC,aAAa,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACnD,GAAG,CAAC,aAAa,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,CAAC,SAAS,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAChE,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AACD,eAAO,MAAM,mBAAmB;;;;;;;IAAmD,CAAC;AAEpF,qBACa,WAAW,CAAC,CAAC,SAAS,kBAAkB,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IACjE,aAAa,UAAS;IAEtB,MAAM,eAAwB;IAE9B,mBAAmB,UAAS;IAExC,IAAI,CAAC,EAAE,cAAc,CAAC;IAEN,KAAK,CAAC,EAAE,SAAS,CAAC;IAEtB,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B,QAAQ,EAAE,oBAAoB,EAAE,CAAM;IAEtC,kBAAkB,CAAC,EAAE,oBAAoB,CAAC;IAE1C,aAAa,SAAK;IAElB,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,CAAA;KAAE,CAW/D;IAEF,IACI,KAAK,yBAER;IAED,IACI,IAAI,yBAEP;IAED,IACI,SAAS,YAEZ;IAED,IACI,OAAO,YAEV;IAED,IACI,OAAO,YAEV;IAED,IACI,UAAU,YAEb;IAED,IACI,cAAc,MAEjB;IAGD,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAW;IAC5C,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,oBAAoB,CAAC,CAAmB;IAChD,OAAO,CAAC,2BAA2B,CAAC,CAAgB;;IAMpD,EAAE,GAAI,CAAC,EAAE,OAAO,MAAM,EAAE,UAAU,mBAAmB,CAAC,GAAC,CAAC,UAEtD;IAEF,GAAG,GAAI,CAAC,EAAE,OAAO,MAAM,EAAE,UAAU,mBAAmB,CAAC,GAAC,CAAC,UAEvD;IAGF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAKhD,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAOjC,OAAO,CAAC,IAAI,CAAC,EAAE,cAAc;IAK7B,oBAAoB,CAAC,SAAS,EAAE,OAAO;IAOvC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS;IAK1B,UAAU,CAAC,QAAQ,EAAE,YAAY;IAOjC,YAAY,CAAC,SAAS,EAAE,SAAS;IAOjC,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAKhE,SAAS,CAAC,MAAM,EAAE,YAAY;IAK9B,WAAW,CAAC,QAAQ,EAAE,oBAAoB,EAAE;IAM5C,YAAY,CAAC,IAAI,EAAE,MAAM;IAKzB,YAAY,CAAC,IAAI,EAAE,mBAAmB;IAKtC,cAAc,CAAC,aAAa,EAAE,OAAO;IAMrC,YAAY,CAAC,MAAM,CAAC,EAAE,aAAa;IAMnC,iBAAiB,CAAC,SAAS,EAAE,aAAa;IAS1C,SAAS,CAAC,aAAa,CAAC,EAAE,iBAAiB;IAYrC,GAAG,CAAC,aAAa,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,OAAO;IAQrD,OAAO;IAIP,OAAO;IAKP,OAAO;IAKP,UAAU;IAIV,OAAO,CAAC,SAAS,CAAC,EAAE,aAAa;IAIjC,cAAc,CAAC,QAAQ,EAAE,OAAO;IAKhC,eAAe,CAAC,OAAO,EAAE,MAAM;IAwB/B,gBAAgB,CAAC,YAAY,EAAE,oBAAoB;IAQnD,oBAAoB,CAAC,YAAY,EAAE,oBAAoB;IAM7D,cAAc,CAAC,cAAc,EAAE,MAAM,GAAG,oBAAoB;IAM5D,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWxD,iBAAiB;IAcjB,iBAAiB,CAAC,OAAO,EAAE,MAAM;IAUjC,cAAc,CAAC,IAAI,EAAE,cAAc;IAU7B,aAAa;IAMnB,eAAe,CAAC,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,GAAG;IAWlF,SAAS;IAQT,KAAK,CAAC,WAAW,UAAO;IAWxB,qBAAqB;IAcrB,aAAa;cAQG,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAS9D,SAAS,CAAC,kBAAkB,CAAC,CAAC,SAAS,oBAAoB,EACvD,OAAO,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC,GACrC,CAAC;IAaJ,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM;YAM5B,uBAAuB;IAQrC,OAAO,CAAC,aAAa;YAQP,YAAY;CAa7B"}