@botpress/webchat 0.5.0 → 1.0.0

package/dist/store/index.js

@@ -1,576 +0,0 @@
-"use strict";
-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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RootStore = void 0;
-const axios_1 = __importDefault(require("axios"));
-const is_before_1 = __importDefault(require("date-fns/is_before"));
-const is_valid_1 = __importDefault(require("date-fns/is_valid"));
-const merge_1 = __importDefault(require("lodash/merge"));
-const orderBy_1 = __importDefault(require("lodash/orderBy"));
-const mobx_1 = require("mobx");
-const api_1 = __importDefault(require("../core/api"));
-const main_1 = require("../main");
-const translations_1 = require("../translations");
-const utils_1 = require("../utils");
-const analytics_1 = require("../utils/analytics");
-const webchatEvents_1 = require("../utils/webchatEvents");
-const composer_1 = __importDefault(require("./composer"));
-const view_1 = __importDefault(require("./view"));
-class RootStore {
-    constructor(options, config) {
-        this.conversations = [];
-        this.isBotTyping = mobx_1.observable.box(false);
-        this.delayedMessages = [];
-        this.composer = new composer_1.default(this);
-        this.view = new view_1.default(this, options.fullscreen);
-        if (config) {
-            this.updateConfig(config);
-        }
-        this.botUILanguage = (0, translations_1.getUserLocale)();
-    }
-    setIntlProvider(provider) {
-        this.intl = provider;
-    }
-    setSocket(socket) {
-        this.api = new api_1.default(socket);
-    }
-    setSelectedMessage(messageId) {
-        this.selectedMessageId = messageId;
-    }
-    get isConversationStarted() {
-        var _a;
-        return !!((_a = this.currentConversation) === null || _a === void 0 ? void 0 : _a.messages.length);
-    }
-    get botName() {
-        var _a, _b;
-        return ((_a = this.config) === null || _a === void 0 ? void 0 : _a.botName) || ((_b = this.botInfo) === null || _b === void 0 ? void 0 : _b.name) || 'Bot';
-    }
-    get hasBotInfoDescription() {
-        var _a;
-        return !!((_a = this.config.botConversationDescription) === null || _a === void 0 ? void 0 : _a.length);
-    }
-    get botAvatarUrl() {
-        var _a, _b, _c;
-        return ((_b = (_a = this.botInfo) === null || _a === void 0 ? void 0 : _a.details) === null || _b === void 0 ? void 0 : _b.avatarUrl) || ((_c = this.config) === null || _c === void 0 ? void 0 : _c.avatarUrl) || undefined;
-    }
-    get rtl() {
-        return (0, translations_1.isRTLLocale)(this.preferredLanguage);
-    }
-    get escapeHTML() {
-        var _a, _b;
-        return (_b = (_a = this.botInfo) === null || _a === void 0 ? void 0 : _a.security) === null || _b === void 0 ? void 0 : _b.escapeHTML;
-    }
-    get currentMessages() {
-        var _a;
-        return ((_a = this.currentConversation) === null || _a === void 0 ? void 0 : _a.messages) || [];
-    }
-    get currentConversationId() {
-        var _a;
-        return (_a = this.currentConversation) === null || _a === void 0 ? void 0 : _a.id;
-    }
-    updateMessages(messages) {
-        if (this.currentConversation) {
-            this.currentConversation.messages = messages;
-        }
-    }
-    updateLastMessage(conversationId, message) {
-        for (const conversation of this.conversations) {
-            if (conversation.id === conversationId) {
-                conversation.lastMessage = message;
-                return;
-            }
-        }
-    }
-    clearMessages() {
-        if (this.currentConversation) {
-            this.currentConversation.messages = [];
-        }
-    }
-    deleteConversation() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.currentConversationId) {
-                yield this.api.deleteConversation(this.currentConversationId);
-                const index = this.conversations.findIndex((c) => c.id === this.currentConversationId);
-                if (index > -1) {
-                    this.conversations.splice(index, 1);
-                }
-                this.resetConversation();
-                yield this.fetchConversation();
-            }
-        });
-    }
-    addEventToConversation(event) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.currentConversation || (this.isInitialized && this.currentConversationId !== event.conversationId)) {
-                yield this.fetchConversations();
-                yield this.fetchConversation(event.conversationId);
-                return;
-            }
-            // Autoplay bot voice messages
-            if (((_a = event.payload) === null || _a === void 0 ? void 0 : _a.type) === 'voice' && !event.authorId) {
-                event.payload.autoPlay = true;
-            }
-            const message = Object.assign(Object.assign({}, event), { conversationId: event.conversationId });
-            if (this.isBotTyping.get() && !event.authorId) {
-                this.delayedMessages.push({ message, showAt: this.currentConversation.typingUntil });
-            }
-            else {
-                this.currentConversation.messages.push(message);
-            }
-        });
-    }
-    updateTyping(event) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.currentConversation || (this.isInitialized && this.currentConversationId !== event.conversationId)) {
-                yield this.fetchConversations();
-                yield this.fetchConversation(event.conversationId);
-                return;
-            }
-            let start = new Date();
-            if ((0, is_before_1.default)(start, this.currentConversation.typingUntil)) {
-                start = this.currentConversation.typingUntil;
-            }
-            this.currentConversation.typingUntil = new Date(+start + (event.timeInMs || main_1.DEFAULT_TYPING_DELAY));
-            this._startTypingTimer();
-        });
-    }
-    /** Loads the initial state, for the first time or when the user ID is changed. */
-    initializeChat() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.fetchConversations();
-                yield this.fetchConversation();
-                (0, mobx_1.runInAction)('-> setInitialized', () => {
-                    this.isInitialized = true;
-                    (0, webchatEvents_1.postMessageToParent)('LIFECYCLE.READY', undefined, this.config.chatId);
-                });
-            }
-            catch (err) {
-                console.error('Error while fetching data, creating new conversation...', err);
-                yield this.createConversation();
-            }
-            this.fetchLanguage();
-        });
-    }
-    fetchBotInfo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.config.mediaFileServiceUrl) {
-                return;
-            }
-            try {
-                const { data } = yield axios_1.default.get(this.config.mediaFileServiceUrl);
-                if (!data) {
-                    return;
-                }
-                (0, mobx_1.runInAction)('-> setBotInfo', () => {
-                    this.botInfo = data;
-                });
-                this.mergeConfig({
-                    disableNotificationSound: data.disableNotificationSound
-                });
-            }
-            catch (err) {
-                console.error('Error while loading bot info', err);
-            }
-        });
-    }
-    fetchLanguage() {
-        const language = (0, translations_1.getUserLocale)(this.config.locale);
-        (0, mobx_1.runInAction)('-> setPreferredLanguage', () => {
-            this.updateBotUILanguage(language);
-        });
-    }
-    /** Fetches the list of conversation, and update the corresponding config values */
-    fetchConversations() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const conversations = yield this.api.fetchConversations();
-            (0, mobx_1.runInAction)('-> setConversations', () => {
-                if (!(conversations === null || conversations === void 0 ? void 0 : conversations.length)) {
-                    this.view.showBotInfo();
-                }
-                this.conversations = conversations;
-            });
-        });
-    }
-    /** Fetch the specified conversation ID, or try to fetch a valid one from the list */
-    fetchConversation(convoId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const conversationId = convoId || this._getCurrentConvoId();
-            if (!conversationId) {
-                return this.createConversation();
-            }
-            const conversation = (yield this.api.fetchConversation(convoId || this._getCurrentConvoId()));
-            if (conversation === null || conversation === void 0 ? void 0 : conversation.messages) {
-                conversation.messages = conversation.messages.sort((a, b) => new Date(a.sentOn).getTime() - new Date(b.sentOn).getTime());
-                yield this.extractFeedback(conversation.messages);
-            }
-            (0, mobx_1.runInAction)('-> setConversation', () => {
-                this.currentConversation = conversation;
-                this.view.hideConversations();
-            });
-        });
-    }
-    /** Sends the specified message, or fetch the message in the composer */
-    sendMessage(textMessage) {
-        return __awaiter(this, void 0, void 0, function* () {
-            textMessage = textMessage || this.composer.message;
-            if (!textMessage) {
-                return;
-            }
-            this.composer.updateMessage('');
-            try {
-                const message = yield this.sendData({ type: 'text', text: textMessage });
-                (0, analytics_1.trackMessage)('sent');
-                if (message) {
-                    (0, webchatEvents_1.postMessageToParent)('MESSAGE.SENT', message, this.config.chatId);
-                }
-                this.composer.addMessageToHistory(textMessage);
-            }
-            catch (e) {
-                this.composer.updateMessage(textMessage);
-                console.error('Webchat cloud not send message');
-                throw e;
-            }
-        });
-    }
-    /** Sends an event to start conversation & hide the bot info page */
-    startConversation() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.sendData({ type: 'request_start_conversation' });
-            this.view.toggleBotInfo();
-        });
-    }
-    /** Creates a new conversation and switches to it */
-    createConversation() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const newId = yield this.api.createConversation();
-            yield this.api.startConversation();
-            yield this.fetchConversations();
-            yield this.fetchConversation(newId);
-            return newId;
-        });
-    }
-    resetConversation() {
-        this.currentConversation = undefined;
-    }
-    extractFeedback(messages) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const feedbackMessageIds = messages.filter((x) => x.payload && x.payload.collectFeedback).map((x) => x.id);
-            const feedbackInfo = feedbackMessageIds.map((x) => ({ messageId: x, feedback: 1 }));
-            (0, mobx_1.runInAction)('-> setFeedbackInfo', () => {
-                this.messageFeedbacks = feedbackInfo;
-            });
-        });
-    }
-    sendFeedback(feedback, messageId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.api.sendFeedback(feedback, messageId);
-        });
-    }
-    downloadConversation() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const formatDate = (date) => {
-                    return new Date(date).toLocaleString();
-                };
-                const conversation = this.currentConversation;
-                if (!conversation) {
-                    console.warn('Cannot download the current conversation as it is undefined.');
-                    return;
-                }
-                let info = `Conversation Id: ${conversation.id}\nCreated on: ${formatDate(conversation.createdOn)}\nUser: ${conversation.userId}\n-----------------`;
-                const messages = yield this.api.listCurrentConversationMessages(500);
-                for (const message of (0, orderBy_1.default)(messages, 'sentOn', 'desc')) {
-                    const payload = message.payload;
-                    if (payload.type === 'session_reset') {
-                        continue;
-                    }
-                    info += `\n[${formatDate(message.sentOn)}] ${message.authorId ? 'User' : this.config.botName || 'Bot'}: Event (${payload.type}): ${payload.text ||
-                        payload.audio ||
-                        payload.image ||
-                        payload.video ||
-                        payload.file ||
-                        payload.message ||
-                        payload.title ||
-                        ''}`;
-                }
-                const blobFile = new Blob([info]);
-                (0, utils_1.downloadFile)(`conversation-${conversation.id}`, blobFile);
-            }
-            catch (err) {
-                console.error('Error trying to download conversation', err);
-            }
-        });
-    }
-    /** Sends an event or a message, depending on how the backend manages those types */
-    sendData(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.isInitialized || !this.currentConversationId) {
-                console.warn('[webchat] Cannot send data until the webchat is ready');
-                return;
-            }
-            const message = yield this.api.sendMessage(data, this.currentConversationId);
-            this.updateLastMessage(this.currentConversationId, message);
-            return message;
-        });
-    }
-    /** Sends a message of type voice */
-    sendVoiceMessage(voice, ext) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.currentConversationId) {
-                return this.api.sendVoiceMessage(voice, ext, this.currentConversationId);
-            }
-        });
-    }
-    /** Use this method to replace a value or add a new config */
-    mergeConfig(config) {
-        this.config = (0, merge_1.default)(this.config, config);
-        this._applyConfig();
-    }
-    /** This replaces all the configurations by this object */
-    updateConfig(config) {
-        this.config = config;
-        this._applyConfig();
-    }
-    _applyConfig() {
-        window.BP_STORAGE.config = this.config;
-        this.config.layoutWidth && this.view.setLayoutWidth(this.config.layoutWidth);
-        this.config.containerWidth && this.view.setContainerWidth(this.config.containerWidth);
-        this.view.disableAnimations = !!this.config.disableAnimations;
-        this.config.showPoweredBy ? this.view.showPoweredBy() : this.view.hidePoweredBy();
-        document.title = this.config.botName || 'Botpress Webchat';
-        if (!this.isInitialized) {
-            window.USE_SESSION_STORAGE = !!this.config.useSessionStorage;
-        }
-        else if (window.USE_SESSION_STORAGE !== this.config.useSessionStorage) {
-            console.warn('[WebChat] "useSessionStorage" value cannot be altered once the webchat is initialized');
-        }
-        const locale = (0, translations_1.getUserLocale)(this.config.locale);
-        this.updateBotUILanguage(locale);
-        document.documentElement.setAttribute('lang', locale);
-        (0, webchatEvents_1.postMessageToParent)('CONFIG.SET', Object.assign({}, this.config), this.config.chatId);
-    }
-    updatePreferredLanguage(lang) {
-        this.preferredLanguage = lang;
-        (0, translations_1.setUserLocale)(lang);
-    }
-    /** Starts a timer to remove the typing animation when it's completed */
-    _startTypingTimer() {
-        if (this._typingInterval) {
-            return;
-        }
-        this.isBotTyping.set(true);
-        this._typingInterval = setInterval(() => {
-            var _a;
-            const typeUntil = new Date((_a = this.currentConversation) === null || _a === void 0 ? void 0 : _a.typingUntil);
-            if (!typeUntil || !(0, is_valid_1.default)(typeUntil) || (0, is_before_1.default)(typeUntil, new Date())) {
-                this._expireTyping();
-            }
-            else {
-                this.emptyDelayedMessagesQueue(false);
-            }
-        }, 50);
-    }
-    _expireTyping() {
-        this.emptyDelayedMessagesQueue(true);
-        this.isBotTyping.set(false);
-        if (this.currentConversation) {
-            this.currentConversation.typingUntil = undefined;
-        }
-        clearInterval(this._typingInterval);
-        this._typingInterval = undefined;
-    }
-    updateBotUILanguage(lang) {
-        lang = (0, translations_1.getUserLocale)(lang); // Ensure language is supported
-        (0, mobx_1.runInAction)('-> setBotUILanguage', () => {
-            this.botUILanguage = lang;
-            this.preferredLanguage = lang;
-            (0, translations_1.setUserLocale)(lang);
-        });
-    }
-    emptyDelayedMessagesQueue(removeAll) {
-        if (!this.currentConversation) {
-            return;
-        }
-        while (this.delayedMessages.length) {
-            const message = this.delayedMessages[0];
-            if (removeAll || (0, is_before_1.default)(message.showAt, new Date())) {
-                this.currentConversation.messages.push(message.message);
-                this.delayedMessages.shift();
-            }
-            else {
-                break;
-            }
-        }
-    }
-    /** Returns the current conversation ID, or the last one. */
-    _getCurrentConvoId() {
-        if (this.currentConversationId) {
-            return this.currentConversationId;
-        }
-        if (!this.conversations.length) {
-            return;
-        }
-        return this.conversations[0].id;
-    }
-}
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "conversations", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "currentConversation", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "selectedMessageId", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "botInfo", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "config", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "preferredLanguage", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "isInitialized", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "messageFeedbacks", void 0);
-__decorate([
-    mobx_1.observable
-], RootStore.prototype, "botUILanguage", void 0);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "setIntlProvider", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "setSocket", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "setSelectedMessage", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "isConversationStarted", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "botName", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "hasBotInfoDescription", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "botAvatarUrl", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "rtl", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "escapeHTML", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "currentMessages", null);
-__decorate([
-    mobx_1.computed
-], RootStore.prototype, "currentConversationId", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "updateMessages", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "updateLastMessage", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "clearMessages", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "deleteConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "addEventToConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "updateTyping", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "initializeChat", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "fetchBotInfo", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "fetchLanguage", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "fetchConversations", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "fetchConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "sendMessage", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "startConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "createConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "resetConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "extractFeedback", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "sendFeedback", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "downloadConversation", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "sendData", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "sendVoiceMessage", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "mergeConfig", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "updateConfig", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "updatePreferredLanguage", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "_startTypingTimer", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "_expireTyping", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "updateBotUILanguage", null);
-__decorate([
-    mobx_1.action.bound
-], RootStore.prototype, "emptyDelayedMessagesQueue", null);
-exports.RootStore = RootStore;

package/dist/store/view.d.ts

@@ -1,61 +0,0 @@
-import { ChatDimensions, CustomAction, CustomButton } from '../typings';
-import { RootStore } from '.';
-declare class ViewStore {
-    private rootStore;
-    /** If false, probably embedded on a website or on the studio */
-    isFullscreen: boolean;
-    unreadCount: number;
-    dimensions: ChatDimensions;
-    isConversationsDisplayed: boolean;
-    activeView: string;
-    private transitions;
-    private _isLoading;
-    private _showBotInfo;
-    isPoweredByDisplayed: boolean;
-    focusedArea: import("mobx").IObservableValue<string>;
-    /** These buttons are displayed in the header, and can point to actions on your custom components */
-    customButtons: CustomButton[];
-    customActions: CustomAction[];
-    disableAnimations: boolean;
-    constructor(rootStore: RootStore, fullscreen: boolean);
-    get showConversationsButton(): boolean | undefined;
-    get showBotInfoButton(): boolean;
-    get showDownloadButton(): boolean | undefined;
-    get showDeleteConversationButton(): boolean | undefined;
-    get showCloseButton(): boolean;
-    get showWidgetButton(): boolean;
-    get hasUnreadMessages(): boolean;
-    get isWebchatReady(): string | false;
-    get isBotInfoDisplayed(): boolean;
-    /** Returns the active transition for the side panel, like fade in or out */
-    get sideTransition(): any;
-    get widgetTransition(): any;
-    get displayWidgetView(): boolean;
-    /** Sets the current focus to that element */
-    setFocus(element: string): void;
-    focusPrevious(): void;
-    focusNext(): void;
-    incrementUnread(): void;
-    resetUnread(): void;
-    toggleBotInfo(): void;
-    showBotInfo(): void;
-    toggleConversations(): void;
-    hideConversations(): void;
-    setLoadingCompleted(): void;
-    showPoweredBy(): void;
-    hidePoweredBy(): void;
-    setLayoutWidth(width: string | number): void;
-    setContainerWidth(width: string | number): void;
-    addCustomAction(newAction: CustomAction): void;
-    removeCustomAction(actionId: string): void;
-    addHeaderButton(newButton: CustomButton): void;
-    /** Updates one or multiple properties of a specific button */
-    updateHeaderButton(buttonId: string, newProps: Partial<CustomButton>): void;
-    removeHeaderButton(buttonId: string): void;
-    showChat(): void;
-    hideChat(): void;
-    private _endAnimation;
-    private _updateTransitions;
-    private _getFocusOrder;
-}
-export default ViewStore;