@servicetitan/titan-chat-ui-common 3.0.0

package/dist/stores/chat-ui.store.js

@@ -0,0 +1,683 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { EventEmitter } from 'events';
+import { injectable, symbolToken } from '@servicetitan/react-ioc';
+import { action, computed, makeObservable, observable, runInAction } from 'mobx';
+import { nanoid } from 'nanoid';
+import { ChatEndReason, ChatError, ChatMessageState, ChatParticipantIcon, ChatRunState, } from '../models';
+export const symbolAgent = Symbol('SupportChatAgent');
+export const symbolUser = Symbol('SupportChatUser');
+export var ChatUiEvent;
+(function (ChatUiEvent) {
+    ChatUiEvent["eventRun"] = "eventRun";
+    ChatUiEvent["eventDestroy"] = "eventDestroy";
+    ChatUiEvent["eventRestart"] = "eventRestart";
+    ChatUiEvent["eventCancel"] = "eventCancel";
+    ChatUiEvent["eventEndChat"] = "eventEndChat";
+    ChatUiEvent["eventRecover"] = "eventRecover";
+    ChatUiEvent["eventChasitorTyping"] = "eventChasitorTyping";
+    ChatUiEvent["eventTimerRestart"] = "eventTimerRestart";
+    ChatUiEvent["eventMessageSend"] = "eventMessageSend";
+    ChatUiEvent["eventMessageSendRetry"] = "eventMessageSendRetry";
+    ChatUiEvent["eventMessageSendFile"] = "eventMessageSendFile";
+    ChatUiEvent["eventMessageSendFileRetry"] = "eventMessageSendFileRetry";
+})(ChatUiEvent || (ChatUiEvent = {}));
+export const CHAT_UI_STORE_TOKEN = symbolToken('CHAT_UI_STORE_TOKEN');
+let ChatUiStore = class ChatUiStore {
+    get agent() {
+        return this.participants[symbolAgent];
+    }
+    get user() {
+        return this.participants[symbolUser];
+    }
+    get isStarted() {
+        return this.status === ChatRunState.Started;
+    }
+    get isError() {
+        return this.status === ChatRunState.Error;
+    }
+    get isEnded() {
+        return this.status === ChatRunState.Ended;
+    }
+    get isStarting() {
+        return this.status === ChatRunState.Initializing;
+    }
+    get customizations() {
+        return this.customizationContext;
+    }
+    constructor() {
+        Object.defineProperty(this, "isAgentTyping", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ChatRunState.Offline
+        });
+        Object.defineProperty(this, "isFilePickerEnabled", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "file", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "error", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "endReason", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "messages", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "currentFileMessage", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "scrollCounter", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 1
+        });
+        Object.defineProperty(this, "timer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "participants", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {
+                [symbolAgent]: {
+                    isAgent: true,
+                    name: 'Agent',
+                    icon: ChatParticipantIcon.Initials,
+                },
+                [symbolUser]: {
+                    isAgent: false,
+                    name: 'User',
+                    icon: ChatParticipantIcon.Initials,
+                },
+            }
+        });
+        Object.defineProperty(this, "customizationContext", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        Object.defineProperty(this, "eventEmitter", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new EventEmitter()
+        });
+        Object.defineProperty(this, "incomingMessageSound", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "incomingMessageSoundPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "on", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (event, listener) => {
+                this.eventEmitter.on(event, listener);
+            }
+        });
+        Object.defineProperty(this, "off", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (event, listener) => {
+                this.eventEmitter.off(event, listener);
+            }
+        });
+        makeObservable(this);
+    }
+    setCustomizationContext(customizationContext) {
+        this.customizationContext = customizationContext !== null && customizationContext !== void 0 ? customizationContext : {};
+        this.triggerScroll();
+    }
+    setIncomingSound(soundUrl) {
+        if (this.incomingMessageSound) {
+            return;
+        }
+        this.incomingMessageSound = new Audio(soundUrl);
+    }
+    setFile(file) {
+        this.file = file;
+    }
+    setFilePickerEnabled(isEnabled) {
+        this.isFilePickerEnabled = isEnabled;
+        this.setFile();
+        this.triggerScroll();
+    }
+    setTimer(timer) {
+        this.timer = timer;
+    }
+    resetError(runState) {
+        this.error = undefined;
+        this.setStatus(runState);
+        this.triggerScroll();
+    }
+    setChatError(chatError) {
+        this.error = chatError;
+        this.setStatus(ChatRunState.Error);
+        this.triggerScroll();
+    }
+    setError(message, options) {
+        this.setChatError(new ChatError(message, options));
+    }
+    setStatus(status) {
+        this.status = status;
+    }
+    setMessages(messages) {
+        this.messages = messages;
+        this.triggerScroll();
+    }
+    setAgentName(name) {
+        this.agent.name = name;
+    }
+    setAgentIcon(icon) {
+        this.agent.icon = icon;
+    }
+    setAgentTyping(isAgentTyping) {
+        this.isAgentTyping = isAgentTyping;
+        this.triggerScroll();
+    }
+    setEndReason(reason) {
+        this.endReason = reason;
+        this.triggerScroll();
+    }
+    setEndedChatState(endReason) {
+        this.setEndReason(endReason);
+        this.setStatus(ChatRunState.Ended);
+        this.setAgentTyping(false);
+        this.resetFile();
+        this.triggerScroll();
+    }
+    configure(configuration) {
+        if (!configuration) {
+            return;
+        }
+        if (configuration.agentName) {
+            this.setAgentName(configuration.agentName);
+        }
+        if (configuration.agentIcon) {
+            this.setAgentIcon(configuration.agentIcon);
+        }
+    }
+    async run(configuration, data) {
+        this.configure(configuration);
+        if (!this.eventEmitter.listeners(ChatUiEvent.eventRun).length) {
+            throw new Error("No listeners for ChatUiEvent.eventRun ('eventRun')");
+        }
+        await this.emitAsync(ChatUiEvent.eventRun, data);
+    }
+    async recover() {
+        await this.emitAsync(ChatUiEvent.eventRecover, this.error);
+    }
+    async destroy() {
+        this.reset();
+        await this.emitAsync(ChatUiEvent.eventDestroy);
+    }
+    async restart() {
+        this.reset();
+        await this.emitAsync(ChatUiEvent.eventRestart);
+    }
+    async cancelChat() {
+        await this.emitAsync(ChatUiEvent.eventCancel);
+    }
+    async endChat(endReason) {
+        await this.emitAsync(ChatUiEvent.eventEndChat, endReason);
+    }
+    async chasitorTyping(isTyping) {
+        await this.emitAsync(ChatUiEvent.eventChasitorTyping, isTyping);
+    }
+    async sendMessageText(message) {
+        if (this.isFilePickerEnabled && this.file) {
+            // Send text message with file
+            runInAction(() => {
+                this.isFilePickerEnabled = false;
+                this.currentFileMessage = this.addMessageFile(this.file);
+            });
+            let messageModel;
+            if (message.trim() !== '') {
+                messageModel = this.addMessage(false, message);
+            }
+            await this.emitAsync(ChatUiEvent.eventMessageSendFile, this.currentFileMessage, this.file, messageModel);
+        }
+        else {
+            // Send plain text message
+            await this.sendMessageTextInternal(message);
+        }
+    }
+    async sendMessageRetry(messageModel) {
+        this.resetError(ChatRunState.Started);
+        this.setMessageState(messageModel, ChatMessageState.Delivering);
+        await this.emitAsync(ChatUiEvent.eventMessageSendRetry, messageModel);
+        await this.restartTimers();
+    }
+    async sendMessageFileRetry(messageModel) {
+        this.resetError(ChatRunState.Started);
+        this.setMessageState(messageModel, ChatMessageState.Delivering);
+        await this.emitAsync(ChatUiEvent.eventMessageSendFileRetry, messageModel);
+    }
+    getParticipant(participantKey) {
+        const participant = this.participants[participantKey];
+        return { ...participant };
+    }
+    addMessage(isAgent, message, data) {
+        return this.addMessageInternal({
+            type: 'message',
+            state: ChatMessageState.Delivering,
+            participant: this.getParticipant(isAgent ? symbolAgent : symbolUser),
+            data,
+            message,
+        });
+    }
+    addMessageTimeout() {
+        const isNewChat = this.messages.length === 0 || this.messages.every(m => m.type === 'welcome');
+        if (isNewChat) {
+            return;
+        }
+        return this.addMessageInternal({
+            type: 'timeout',
+            participant: this.agent,
+            state: ChatMessageState.Delivered,
+        });
+    }
+    addMessageWelcome(message) {
+        return this.addMessageInternal({
+            type: 'welcome',
+            state: ChatMessageState.Delivered,
+            participant: this.getParticipant(symbolAgent),
+            message,
+        });
+    }
+    addMessageFile(file) {
+        var _a;
+        return this.addMessageInternal({
+            fileName: (_a = file.displayName) !== null && _a !== void 0 ? _a : 'attachment',
+            type: 'file',
+            state: ChatMessageState.Delivering,
+            participant: this.user,
+        });
+    }
+    async restartTimers() {
+        this.removeMessageByType('timeout');
+        await this.emitAsync(ChatUiEvent.eventTimerRestart);
+    }
+    setMessageState(message, state, data) {
+        const foundMessage = this.messages.find(m => m.id === message.id);
+        if (foundMessage) {
+            foundMessage.state = state;
+            if (data) {
+                foundMessage.data = data;
+            }
+        }
+    }
+    resetFile() {
+        this.currentFileMessage = undefined;
+        this.file = undefined;
+        this.isFilePickerEnabled = false;
+        this.triggerScroll();
+    }
+    reset(resetStatus = true) {
+        this.setMessages([]);
+        if (resetStatus) {
+            this.status = ChatRunState.Offline;
+        }
+        this.error = undefined;
+        this.isAgentTyping = false;
+        this.endReason = undefined;
+        this.resetFile();
+    }
+    getLastFailedMessages() {
+        const result = [];
+        for (let i = this.messages.length - 1; i >= 0; i--) {
+            const message = this.messages[i];
+            if (message.type === 'message' && !message.participant.isAgent) {
+                if (message.state !== ChatMessageState.Failed) {
+                    break;
+                }
+                result.push(message);
+            }
+        }
+        return result;
+    }
+    triggerScroll() {
+        setTimeout(() => {
+            runInAction(() => {
+                this.scrollCounter++;
+            });
+        }, 0);
+    }
+    async emitAsync(event, ...args) {
+        if (!this.eventEmitter.listenerCount(event)) {
+            return Promise.resolve();
+        }
+        return new Promise((resolve, reject) => {
+            this.eventEmitter.emit(event, resolve, reject, ...args);
+        });
+    }
+    addMessageInternal(message) {
+        if (message.type === 'timeout') {
+            this.removeMessageByType('timeout'); // Remove previous timeout messages
+        }
+        else {
+            this.restartTimers().then(() => { });
+        }
+        this.setMessages([...this.messages, this.createMessage(message)]);
+        if (message.participant.isAgent) {
+            this.beepIncoming().catch(() => { });
+        }
+        return this.messages.at(-1);
+    }
+    removeMessageByType(type) {
+        if (this.messages.some(m => m.type === type)) {
+            this.setMessages(this.messages.filter(m => m.type !== type));
+        }
+    }
+    async sendMessageTextInternal(message) {
+        if (message.trim() === '') {
+            return;
+        }
+        const messageModel = this.addMessage(false, message);
+        await this.emitAsync(ChatUiEvent.eventMessageSend, messageModel);
+    }
+    createMessage(rest) {
+        return {
+            id: nanoid(),
+            timestamp: new Date(),
+            ...rest,
+        };
+    }
+    async beepIncoming() {
+        if (!this.incomingMessageSound) {
+            return;
+        }
+        try {
+            if (!this.incomingMessageSoundPromise) {
+                this.incomingMessageSoundPromise = this.incomingMessageSound.play();
+            }
+            await this.incomingMessageSoundPromise;
+        }
+        finally {
+            this.incomingMessageSoundPromise = undefined;
+        }
+    }
+};
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "isAgentTyping", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "status", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "isFilePickerEnabled", void 0);
+__decorate([
+    observable.ref,
+    __metadata("design:type", ChatError)
+], ChatUiStore.prototype, "error", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", String)
+], ChatUiStore.prototype, "endReason", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Array)
+], ChatUiStore.prototype, "messages", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "currentFileMessage", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "scrollCounter", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "timer", void 0);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "participants", void 0);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "agent", null);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "user", null);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "isStarted", null);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "isError", null);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "isEnded", null);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "isStarting", null);
+__decorate([
+    computed,
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [])
+], ChatUiStore.prototype, "customizations", null);
+__decorate([
+    observable,
+    __metadata("design:type", Object)
+], ChatUiStore.prototype, "customizationContext", void 0);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setCustomizationContext", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Boolean]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setFilePickerEnabled", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setTimer", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "resetError", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ChatError]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setChatError", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setError", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setStatus", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setMessages", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setAgentName", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setAgentIcon", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Boolean]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setAgentTyping", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setEndReason", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setEndedChatState", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "configure", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], ChatUiStore.prototype, "sendMessageText", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ChatUiStore.prototype, "sendMessageRetry", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ChatUiStore.prototype, "sendMessageFileRetry", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Boolean, String, Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "addMessage", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "addMessageTimeout", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "addMessageWelcome", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "addMessageFile", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], ChatUiStore.prototype, "restartTimers", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, String, Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "setMessageState", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "resetFile", null);
+__decorate([
+    action,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ChatUiStore.prototype, "reset", null);
+ChatUiStore = __decorate([
+    injectable(),
+    __metadata("design:paramtypes", [])
+], ChatUiStore);
+export { ChatUiStore };
+//# sourceMappingURL=chat-ui.store.js.map