@botpress/webchat 0.5.0 → 1.0.0

package/dist/translations/pt.json

@@ -1,19 +0,0 @@
-{
-    "composer.placeholder": "Fale com {name}",
-    "composer.placeholderInit": "Diga alguma coisa para {name}",
-    "composer.send": "Mandar",
-    "header.conversations": "Conversas",
-    "header.deleteConversation": "Tem certeza de que deseja excluir toda esta conversa?",
-    "header.deleteConversationYes": "Excluir",
-    "header.deleteConversationNo": "Cancelar",
-    "conversationList.untitledConversation": "Conversa sem título",
-    "conversationList.title": "Conversa {id}",
-    "botInfo.backToConversation": "De volta à conversa",
-    "botInfo.startConversation": "Iniciar conversa",
-    "botInfo.privacyPolicy": "Ver política de privacidade",
-    "botInfo.termsAndConditions": "Ver termos de serviço",
-    "botInfo.preferredLanguage": "Preferred Language",
-    "store.resetSessionMessage": "Redefinir a conversa",
-    "messages.newMessage": "Nova mensagem",
-    "messages.newMessages": "Novas mensagens"
-}

package/dist/translations/ru.json

@@ -1,24 +0,0 @@
-{
-    "composer.placeholder": "Ответить {name}",
-    "composer.placeholderInit": "Скажи что-нибудь {name}",
-    "composer.send": "Отправить",
-    "header.conversations": "Разговоры",
-    "header.deleteConversation": "Вы уверены, что хотите удалить всю беседу?",
-    "header.deleteConversationYes": "удалять",
-    "header.deleteConversationNo": "отменить",
-    "conversationList.untitledConversation": "Разговор без названия",
-    "conversationList.title": "Разговор {id}",
-    "botInfo.backToConversation": "Назад к разговору",
-    "botInfo.startConversation": "Начать разговор",
-    "botInfo.privacyPolicy": "Показать Политику конфиденцеальности",
-    "botInfo.termsAndConditions": "Показать Условия использования",
-    "botInfo.preferredLanguage": "Предпочитаемый язык",
-    "store.resetSessionMessage": "Начать разговор заново",
-    "loginForm.userName": "Логин",
-    "loginForm.password": "Пароль",
-    "loginForm.submit": "Отправить",
-    "loginForm.formTitle": "Форма для входа",
-    "loginForm.providedCredentials": "Введенные данные",
-    "messages.newMessage": "Новое сообщение",
-    "messages.newMessages": "новые сообщения"
-}

package/dist/translations/uk.json

@@ -1,24 +0,0 @@
-{
-    "composer.placeholder": "Відповісти {name}",
-    "composer.placeholderInit": "Скажи щось {name}",
-    "composer.send": "Надіслати",
-    "header.conversations": "Розмови",
-    "header.deleteConversation": "Ви впевнені, що хочете видалити всю цю розмову?",
-    "header.deleteConversationYes": "Видалити",
-    "header.deleteConversationNo": "Скасувати",
-    "conversationList.untitledConversation": "Розмова без назви",
-    "conversationList.title": "Розмова {id}",
-    "botInfo.backToConversation": "Повернутись до розмови",
-    "botInfo.startConversation": "Розпочати розмову",
-    "botInfo.privacyPolicy": "Показати Політику конфіденційності",
-    "botInfo.termsAndConditions": "Показати Умови користування",
-    "botInfo.preferredLanguage": "Бажана мова",
-    "store.resetSessionMessage": "Розпочати розмову заново",
-    "loginForm.userName": "Логін",
-    "loginForm.password": "Пароль",
-    "loginForm.submit": "Надіслати",
-    "loginForm.formTitle": "Форма для входу",
-    "loginForm.providedCredentials": "Введені дані",
-    "messages.newMessage": "Нове повідомлення",
-    "messages.newMessages": "нові повідомлення"
-}

package/dist/typings.d.ts

@@ -1,378 +0,0 @@
-/// <reference types="react" />
-import { UserCredentials } from '@botpress/messaging-socket';
-import { RootStore } from './store';
-import { BPStorage } from './utils/storage';
-declare global {
-    interface Window {
-        __BP_VISITOR_SOCKET_ID: string;
-        __BP_VISITOR_ID: string;
-        botpressWebChat: any;
-        store: RootStore;
-        BOT_ID: string;
-        SEND_USAGE_STATS: boolean;
-        USE_SESSION_STORAGE: boolean;
-        BP_STORAGE: BPStorage;
-        botpress: {
-            [moduleName: string]: any;
-        };
-    }
-}
-export declare namespace Renderer {
-    interface Message {
-        type?: string;
-        className?: string;
-        payload?: any;
-        store?: RootStore;
-        bp?: StudioConnector;
-        fromLabel?: string;
-        messageId?: uuid;
-        /** When true, the message isn't wrapped by its bubble */
-        noBubble?: boolean;
-        keyboard?: any;
-        eventId?: string;
-        isLastGroup?: boolean;
-        isLastOfGroup?: boolean;
-        isBotMessage?: boolean;
-        isLastMessage?: boolean;
-        sentOn?: Date;
-        inlineFeedback?: any;
-        onSendData?: (data: any) => Promise<Message | void>;
-        onFileUpload?: (label: string, payload: any, file: File) => Promise<void>;
-        /** Allows to autoplay voice messages coming from the bot */
-        onAudioEnded?: () => void;
-        shouldPlay?: boolean;
-    }
-    type Button = {
-        label: string;
-        payload: any;
-        preventDoubleClick: boolean;
-        onButtonClick: (title: any, payload: any) => void;
-    } & Pick<Message, 'onFileUpload'>;
-    type Text = {
-        text: string;
-        markdown: boolean;
-        escapeHTML: boolean;
-        intl?: any;
-        maxLength?: number;
-    } & Message;
-    interface Option {
-        label: string;
-        value: string;
-    }
-    type Dropdown = {
-        options: Option[];
-        buttonText?: string;
-        escapeHTML: boolean;
-        allowCreation?: boolean;
-        placeholderText?: string;
-        allowMultiple?: boolean;
-        width?: number;
-        markdown: boolean;
-        message: string;
-        displayInKeyboard?: boolean;
-    } & Message;
-    type QuickReply = {
-        buttons: any;
-        quick_replies: any;
-        disableFreeText: boolean;
-    } & Message;
-    type QuickReplyButton = {
-        allowMultipleClick: boolean;
-        title: string;
-    } & Button;
-    interface FileMessage {
-        file: {
-            url: string;
-            title: string;
-            storage: string;
-            text: string;
-        };
-        escapeTextHTML: boolean;
-    }
-    interface VoiceMessage {
-        file: {
-            type: string;
-            audio: string;
-            autoPlay?: boolean;
-        };
-        shouldPlay: boolean;
-        onAudioEnded: () => void;
-    }
-    interface FileInput {
-        onFileChanged: (event: HTMLInputEvent) => void;
-        name: string;
-        className: string;
-        accept: string;
-        placeholder: string;
-        disabled?: boolean;
-    }
-    interface Carousel {
-        elements: Card[];
-        settings: any;
-    }
-    interface Card {
-        picture: string;
-        title: string;
-        subtitle: string;
-        buttons: CardButton[];
-    }
-    interface CardButton {
-        url: string;
-        title: string;
-        type: string;
-        payload: any;
-        text: string;
-    }
-}
-export declare namespace View {
-    type MenuAnimations = 'fadeIn' | 'fadeOut' | undefined;
-}
-/** These are the functions exposed by the studio to the modules */
-export interface StudioConnector {
-    /** Event emitter */
-    events: any;
-    /** An axios instance */
-    axios: any;
-    getModuleInjector: any;
-    loadModuleView: any;
-}
-export declare type WebchatEventType = 'LIFECYCLE.LOADED' | 'LIFECYCLE.READY' | 'UI.OPENED' | 'UI.CLOSED' | 'UI.RESIZE' | 'UI.SET-CLASS' | 'CONFIG.SET' | 'MESSAGE.SENT' | 'MESSAGE.RECEIVED' | 'MESSAGE.SELECTED' | 'USER.CONNECTED';
-export interface WebchatEvent {
-    type: WebchatEventType;
-    value: any;
-    chatId: string;
-}
-export interface Config {
-    /** Url of the messaging server */
-    messagingUrl: string;
-    /** Id of your messaging client */
-    clientId: string;
-    /**
-     * Refers to a specific webchat reference in parent window. Useful when using multiple chat window
-     * @default 'bp-web-widget'
-     */
-    chatId: string;
-    /**
-     * Url where the webchat bundle is hosted
-     * @default: '/'
-     */
-    hostUrl?: string;
-    /**
-     * Url of the Media File Service where we fetch the bot info
-     * @default ''
-     */
-    mediaFileServiceUrl?: string;
-    /**
-     * Key used to encrypt data in the localStorage
-     * @default '''
-     */
-    encryptionKey?: string;
-    /**
-     * Provide a path to a stylesheet to customize the webchat
-     * @default '''
-     */
-    stylesheet?: string;
-    /**
-     * If false, will hide the conversation list pane
-     * @default true
-     */
-    showConversationsButton?: boolean;
-    /**
-     * If true, will display a timestamp under each messages
-     * @default false
-     */
-    showTimestamp?: boolean;
-    /**
-     * Allows the user to download the conversation history
-     * @default true
-     */
-    enableTranscriptDownload?: boolean;
-    /**
-     * Allows the user to delete its conversation history
-     * @default false
-     */
-    enableConversationDeletion?: boolean;
-    /**
-     * Close the webchat when pressing the Esc key
-     * @default true
-     */
-    closeOnEscape?: boolean;
-    /**
-     * Displays the bot name to the right of its avatar
-     * @default ''
-     */
-    botName?: string;
-    /**
-     * Allows to set a custom composer placeholder
-     * @default 'Reply to {name}'
-     */
-    composerPlaceholder?: string;
-    /**
-     * Allow to specify a custom URL for the bot's avatar
-     * @default '''
-     */
-    avatarUrl?: string;
-    /** Force the display language of the webchat (en, fr, ar, ru, etc..)
-     * Defaults to the user's browser language if not set
-     * Set to 'browser' to force use the browser's language
-     * @default 'browser'
-     */
-    locale?: 'browser' | string;
-    /**
-     * Small description written under the bot's name
-     * @default ''
-     */
-    botConversationDescription?: string;
-    /**
-     * When true, the widget button to open the chat is hidden
-     * @default false
-     */
-    hideWidget?: boolean;
-    /**
-     * Disable the slide in / out animations of the webchat
-     * @default false
-     */
-    disableAnimations?: boolean;
-    /**
-     * When true, webchat displays a voice icon in the composer to send voice messages (must use Google Speech integration)
-     * @default false
-     */
-    enableVoiceComposer?: boolean;
-    /**
-     * Use sessionStorage instead of localStorage, which means the session expires when tab is closed
-     * @default false
-     */
-    useSessionStorage?: boolean;
-    /**
-     * Sends an event to the parent container with the width provided
-     * @default 360
-     */
-    containerWidth?: string | number;
-    /**
-     * Sets the width of the webchat
-     * @default 360
-     */
-    layoutWidth?: string | number;
-    /**
-     * Show Powered By Botpress in the footer
-     * @default false
-     */
-    showPoweredBy?: boolean;
-    /**
-     * When enabled, sent messages are persisted to local storage (recall previous messages)
-     * @default true
-     */
-    enablePersistHistory?: boolean;
-    /**
-     * Experimental: expose the store to the parent frame for more control on the webchat's behavior
-     * @default false
-     */
-    lazySocket?: boolean;
-    /**
-     * If true, chat will no longer play the notification sound for new messages.
-     * @default false
-     */
-    disableNotificationSound?: boolean;
-    /**
-     * CSS class to be applied to iframe
-     * @default ''
-     */
-    className?: string;
-    /**
-     * Google Maps API Key required to display the map.
-     * Will display a link to Google Maps otherwise
-     * @default ''
-     */
-    googleMapsAPIKey?: string;
-    /**
-     * Allows setting a custom user id
-     */
-    customUser?: UserCredentials;
-}
-export interface BotDetails {
-    website?: string;
-    phoneNumber?: string;
-    termsConditions?: string;
-    privacyPolicy?: string;
-    emailAddress?: string;
-    avatarUrl?: string;
-    coverPictureUrl?: string;
-}
-export interface BotInfo {
-    name: string;
-    description: string;
-    details: BotDetails;
-    showBotInfoPage: boolean;
-    languages: string[];
-    security: {
-        escapeHTML: boolean;
-    };
-    lazySocket: boolean;
-    extraStylesheet?: string;
-    disableNotificationSound?: boolean;
-}
-export declare type uuid = string;
-export interface Conversation {
-    id: uuid;
-    clientId: uuid;
-    userId: uuid;
-    createdOn: Date;
-}
-export interface RecentConversation extends Conversation {
-    lastMessage?: Message;
-}
-/** Represents the current conversation with all messages */
-export declare type CurrentConversation = {
-    botId: string;
-    messages: Message[];
-    userId: string;
-    user_last_seen_on: Date | undefined;
-    /** Event ?  */
-    typingUntil: any;
-} & Conversation;
-export interface Message {
-    id: uuid;
-    conversationId: uuid;
-    authorId: uuid | undefined;
-    sentOn: Date;
-    payload: any;
-    timeInMs?: number;
-}
-export interface QueuedMessage {
-    message: Message;
-    showAt: Date;
-}
-export interface HTMLInputEvent extends Event {
-    target: HTMLInputElement & EventTarget;
-}
-export interface ChatDimensions {
-    /**
-     * The container is the frame around the webchat.
-     * Setting the container bigger than the layout makes it possible to add components
-     */
-    container: string | number;
-    /** The layout is the zone where the user speaks with the bot */
-    layout: string | number;
-}
-export interface CustomButton {
-    /** An ID to identify your button. It is required to remove it */
-    id: string;
-    /** This text will be displayed when the mouse is over the button */
-    label?: string;
-    /** Supply either a function or an element which will render the button */
-    icon: Function | JSX.Element;
-    /** The event triggered when the button is clicked */
-    onClick: (buttonId: string, headerComponent: JSX.Element, event: React.MouseEvent) => void;
-}
-export interface CustomAction {
-    /** An ID to identify your action. It is required to remove it */
-    id: string;
-    /** This text will be displayed in the context menu */
-    label: string;
-    /** The event triggered when the action is clicked */
-    onClick: (actionId: string, messageProps: any, event: React.MouseEvent) => void;
-}
-export interface EventFeedback {
-    messageId: uuid;
-    feedback?: number;
-}

package/dist/typings.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/analytics.d.ts

@@ -1,5 +0,0 @@
-export declare const initializeAnalytics: () => void;
-export declare type MessageDirection = 'sent' | 'received';
-export declare const trackMessage: (direction: MessageDirection) => void;
-export declare type WebchatState = 'show' | 'hide' | 'toggle';
-export declare const trackWebchatState: (state: WebchatState) => void;

package/dist/utils/analytics.js

@@ -1,37 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackWebchatState = exports.trackMessage = exports.initializeAnalytics = void 0;
-const react_ga_1 = __importDefault(require("react-ga"));
-const initializeAnalytics = () => {
-    if (window.SEND_USAGE_STATS) {
-        try {
-            react_ga_1.default.initialize('UA-90044826-2');
-            react_ga_1.default.pageview(`${window.location.pathname}${window.location.search}`);
-        }
-        catch (err) {
-            console.error('Error initializing analytics', err);
-        }
-    }
-};
-exports.initializeAnalytics = initializeAnalytics;
-const trackMessage = (direction) => {
-    if (window.SEND_USAGE_STATS) {
-        try {
-            react_ga_1.default.event({ category: 'Interactions', action: `message ${direction}` });
-        }
-        catch (_a) { }
-    }
-};
-exports.trackMessage = trackMessage;
-const trackWebchatState = (state) => {
-    if (window.SEND_USAGE_STATS) {
-        try {
-            react_ga_1.default.event({ category: 'Display', action: state });
-        }
-        catch (_a) { }
-    }
-};
-exports.trackWebchatState = trackWebchatState;

package/dist/utils/index.d.ts

@@ -1,3 +0,0 @@
-export declare const isIE: boolean;
-export declare const downloadFile: (name: string, blob: Blob) => void;
-export declare const renderUnsafeHTML: (message: string | undefined, escaped: boolean) => string;

package/dist/utils/index.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderUnsafeHTML = exports.downloadFile = exports.isIE = void 0;
-const snarkdown_1 = __importDefault(require("snarkdown"));
-exports.isIE = window.navigator.userAgent.match(/MSIE|Trident/) !== null;
-const downloadFile = (name, blob) => {
-    const url = window.URL.createObjectURL(blob);
-    const link = document.createElement('a');
-    link.href = url;
-    link.setAttribute('download', name);
-    document.body.appendChild(link);
-    link.click();
-    document.body.removeChild(link);
-    window.URL.revokeObjectURL(url);
-};
-exports.downloadFile = downloadFile;
-const renderUnsafeHTML = (message = '', escaped) => {
-    if (escaped) {
-        message = message.replace(/</g, '&lt;').replace(/>/g, '&gt;');
-    }
-    const html = (0, snarkdown_1.default)(message);
-    return html.replace(/<a href/gi, '<a target="_blank" href');
-};
-exports.renderUnsafeHTML = renderUnsafeHTML;

package/dist/utils/storage.d.ts

@@ -1,16 +0,0 @@
-import { Config } from '../typings';
-export declare class BPStorage {
-    private _config?;
-    private _storage;
-    constructor(config?: Config);
-    get config(): Config | undefined;
-    set config(config: Config | undefined);
-    private serialize;
-    private deserialize;
-    private getStorageKey;
-    private getDriver;
-    set<T>(key: string, value: T): void;
-    get<T = string>(key: string): T | undefined;
-    del(key: string): void;
-}
-export default BPStorage;

package/dist/utils/storage.js

@@ -1,129 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BPStorage = void 0;
-const aes_1 = __importDefault(require("crypto-js/aes"));
-const enc_utf8_1 = __importDefault(require("crypto-js/enc-utf8"));
-const sha256_1 = __importDefault(require("crypto-js/sha256"));
-const js_cookie_1 = __importDefault(require("js-cookie"));
-class BPStorage {
-    constructor(config) {
-        this.serialize = (value) => {
-            var _a, _b;
-            if (value === null || value === undefined) {
-                throw new Error('[Storage] Cannot store null or undefined values');
-            }
-            try {
-                let str = '';
-                if (typeof value === 'string') {
-                    str = value;
-                }
-                else {
-                    str = JSON.stringify(value);
-                }
-                if ((_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.encryptionKey) === null || _b === void 0 ? void 0 : _b.length) {
-                    str = aes_1.default.encrypt(str, this.config.encryptionKey).toString();
-                }
-                return str;
-            }
-            catch (_c) {
-                console.error('[Storage] Error parsing value', value);
-                return '';
-            }
-        };
-        this.deserialize = (strValue) => {
-            var _a, _b;
-            if (strValue === null || strValue === undefined) {
-                return undefined;
-            }
-            try {
-                if ((_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.encryptionKey) === null || _b === void 0 ? void 0 : _b.length) {
-                    strValue = aes_1.default.decrypt(strValue, this.config.encryptionKey).toString(enc_utf8_1.default);
-                }
-                return JSON.parse(strValue);
-            }
-            catch (_c) {
-                return undefined;
-            }
-        };
-        this.getStorageKey = (key) => {
-            var _a, _b, _c;
-            const rawKey = `bp-chat-${key}`;
-            if ((_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.encryptionKey) === null || _b === void 0 ? void 0 : _b.length) {
-                return `${rawKey}-${(0, sha256_1.default)(`${this.config.clientId}-${this.config.encryptionKey}`).toString()}`;
-            }
-            else {
-                return `${rawKey}-${(_c = this.config) === null || _c === void 0 ? void 0 : _c.clientId}`;
-            }
-        };
-        this.getDriver = () => {
-            var _a;
-            if (this._storage) {
-                return this._storage;
-            }
-            try {
-                const storage = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.useSessionStorage) === true && typeof sessionStorage !== 'undefined' ? sessionStorage : localStorage;
-                const tempKey = '__storage_test__';
-                storage.setItem(tempKey, tempKey);
-                storage.removeItem(tempKey);
-                return (this._storage = storage);
-            }
-            catch (e) {
-                return (this._storage = 'cookie');
-            }
-        };
-        if (config) {
-            this._config = config;
-        }
-    }
-    get config() {
-        return this._config;
-    }
-    set config(config) {
-        this._config = config;
-    }
-    set(key, value) {
-        if (!this.config) {
-            return;
-        }
-        try {
-            const driver = this.getDriver();
-            driver !== 'cookie'
-                ? driver.setItem(this.getStorageKey(key), this.serialize(value))
-                : js_cookie_1.default.set(this.getStorageKey(key), this.serialize(value));
-        }
-        catch (err) {
-            console.error('Error while setting data into storage.', err.message);
-        }
-    }
-    get(key) {
-        if (!this.config) {
-            return;
-        }
-        try {
-            const driver = this.getDriver();
-            return driver !== 'cookie'
-                ? this.deserialize(driver.getItem(this.getStorageKey(key)))
-                : this.deserialize(js_cookie_1.default.get(this.getStorageKey(key)));
-        }
-        catch (err) {
-            console.error('Error while getting data from storage.', err.message);
-        }
-    }
-    del(key) {
-        if (!this.config) {
-            return;
-        }
-        try {
-            const driver = this.getDriver();
-            driver !== 'cookie' ? driver.removeItem(this.getStorageKey(key)) : js_cookie_1.default.remove(this.getStorageKey(key));
-        }
-        catch (err) {
-            console.error('Error while deleting data from storage.', err.message);
-        }
-    }
-}
-exports.BPStorage = BPStorage;
-exports.default = BPStorage;

package/dist/utils/webchatEvents.d.ts

@@ -1,2 +0,0 @@
-import { WebchatEventType } from '../typings';
-export declare const postMessageToParent: (type: WebchatEventType, value: any, chatId: string) => void;