@telia-ace/widget-conversation 1.0.10 → 1.0.13

package/lib-esm/conversation-platform.js

@@ -1,292 +0,0 @@
-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 __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-import { ComponentPlatform } from '@telia-ace/widget-core';
-import { createStorageWriter, readStorage, StorageCategory, StorageMedium, } from '@telia-ace/widget-services';
-import { lock } from '@telia-ace/widget-utilities';
-import { ConversationController } from './conversation-controller';
-import { navigateToConversation, openChatWidget, shouldPreventDefault } from './utils';
-var STORAGE_KEY = 'conversations';
-export var ConversationEndedBehavior;
-(function (ConversationEndedBehavior) {
-    ConversationEndedBehavior["Deactivate"] = "deactivate";
-    ConversationEndedBehavior["Navigate"] = "navigate";
-    ConversationEndedBehavior["None"] = "none";
-})(ConversationEndedBehavior || (ConversationEndedBehavior = {}));
-var ConversationPlatform = /** @class */ (function () {
-    function ConversationPlatform(container, components) {
-        this.container = container;
-        this.components = components;
-        this.controllers = [];
-        this.providers = [];
-        this.disposeProviders = {};
-        this.subscriptions = [];
-        this.storageWriter = null;
-        this.router = null;
-        this.buttonQuery = null;
-        this.sessionInfo = null;
-        var widget = container.get('$widget');
-        this.events = widget.events.createChild(this);
-    }
-    ConversationPlatform.prototype.initialize = function () {
-        var _this = this;
-        createStorageWriter(this.container, STORAGE_KEY, StorageCategory.Necessary, {
-            medium: StorageMedium.Local,
-        }).then(function (writer) { return (_this.storageWriter = writer); });
-        readStorage(this.container, STORAGE_KEY, StorageMedium.Local).then(function (storedSession) {
-            _this.buttonQuery = _this.components
-                .components()
-                .ofType('conversation-return-button');
-            if (storedSession) {
-                _this.sessionInfo = storedSession;
-                if (storedSession.id && storedSession.route) {
-                    _this.writeToComponents({ active: true, alert: { show: false } });
-                }
-            }
-        });
-        this.container.getAsync('router').then(function (router) { return (_this.router = router); });
-        this.events.subscribe('conversation:ended', function (event, data) {
-            var _a, _b, _c;
-            switch ((_a = _this.sessionInfo) === null || _a === void 0 ? void 0 : _a.conversationEndedBehavior) {
-                case ConversationEndedBehavior.Deactivate:
-                    var widget = _this.container.get('$widget');
-                    widget.deactivate();
-                    break;
-                case ConversationEndedBehavior.Navigate:
-                    var initialRoute = (_b = _this.router) === null || _b === void 0 ? void 0 : _b.getInitialRoute();
-                    if (initialRoute) {
-                        (_c = _this.router) === null || _c === void 0 ? void 0 : _c.navigate(initialRoute.name);
-                    }
-                    break;
-                case ConversationEndedBehavior.None:
-                default:
-                    break;
-            }
-            _this.writeToComponents({ active: false });
-            _this.sessionInfo = null;
-            _this.storageWriter && _this.storageWriter();
-        });
-    };
-    ConversationPlatform.prototype.addSubscription = function (sub) {
-        this.subscriptions.push(sub);
-    };
-    ConversationPlatform.getInstance = function (container, key) {
-        if (key === void 0) { key = 'conversation'; }
-        return lock(container)(function () {
-            return container.getAsync(key).then(function (value) {
-                var conversation = value;
-                if (!conversation) {
-                    return ComponentPlatform.getInstance(container).then(function (components) {
-                        conversation = new ConversationPlatform(container, components);
-                        conversation.initialize();
-                        container.registerAsync(key, function () { return conversation; });
-                        return conversation;
-                    });
-                }
-                return conversation;
-            });
-        });
-    };
-    ConversationPlatform.prototype.navigateToConversationIfActive = function (id) {
-        var _this = this;
-        return readStorage(this.container, STORAGE_KEY, StorageMedium.Local).then(function (storedSession) {
-            var _a;
-            if (storedSession && storedSession.id === id) {
-                if (storedSession.route) {
-                    var _b = storedSession.route, name_1 = _b.name, params = _b.params;
-                    (_a = _this.router) === null || _a === void 0 ? void 0 : _a.navigate(name_1, params);
-                }
-            }
-        });
-    };
-    ConversationPlatform.prototype.setConversationEndedBehavior = function (behavior) {
-        var _this = this;
-        return readStorage(this.container, STORAGE_KEY, StorageMedium.Local).then(function (stored) {
-            var storedSession = stored;
-            if (storedSession) {
-                storedSession.conversationEndedBehavior = behavior;
-            }
-            else {
-                storedSession = { conversationEndedBehavior: behavior };
-            }
-            _this.sessionInfo = storedSession;
-            return ((_this.storageWriter && _this.storageWriter(_this.sessionInfo)) ||
-                Promise.resolve());
-        });
-    };
-    ConversationPlatform.prototype.createController = function (id) {
-        var index = this.controllers.findIndex(function (c) { return c.conversation.id === id; });
-        if (index > -1) {
-            return this.controllers[index].conversation;
-        }
-        return new ConversationController(this.container, id);
-    };
-    ConversationPlatform.prototype.registerProvider = function (name, handler) {
-        var _this = this;
-        var provider = {
-            name: name,
-            handler: handler,
-        };
-        this.providers.push(provider);
-        // execute provider for all matching controllers
-        this.controllers
-            .filter(function (controller) { return controller.conversation.providers.indexOf(name) > -1; })
-            .forEach(function (controller) {
-            _this.invokeHandler(provider, controller);
-        });
-    };
-    ConversationPlatform.prototype.registerController = function (conversation, component) {
-        var _this = this;
-        var index = this.controllers.findIndex(function (c) { return c.conversation.id === conversation.id; });
-        var controller;
-        if (index < 0) {
-            controller = { conversation: conversation, component: component };
-            this.controllers.push(controller);
-            var invokeHandlers_1 = function (providers) {
-                if (providers) {
-                    _this.providers
-                        .filter(function (provider) { return providers.indexOf(provider.name) > -1; })
-                        .forEach(function (provider) {
-                        _this.invokeHandler(provider, controller);
-                    });
-                }
-            };
-            this.subscriptions.push(conversation.onDispose(function (event, data) {
-                var index = _this.controllers.findIndex(function (c) { return c.conversation === data; });
-                index > -1 && _this.controllers.splice(index, 1);
-                _this.components
-                    .components()
-                    .ofType('conversation-return-button')
-                    .select()
-                    .writeProperties({ active: false });
-                _this.events.dispatch('conversation:ended', {}, { bubbles: true });
-            }));
-            this.subscriptions.push(conversation.onProvidersChange(function (event, data) {
-                var added = data.added, removed = data.removed;
-                removed.forEach(function (removedProvider) {
-                    _this.disposeProviders[removedProvider].forEach(function (dispose) {
-                        dispose();
-                    });
-                });
-                invokeHandlers_1(added);
-            }));
-            this.subscriptions.push(conversation.onStarted(function (event, isActive) {
-                var _a, _b;
-                var session = {
-                    id: conversation.id,
-                    route: (_a = _this.router) === null || _a === void 0 ? void 0 : _a.getRouteData(),
-                    conversationEndedBehavior: (_b = _this.sessionInfo) === null || _b === void 0 ? void 0 : _b.conversationEndedBehavior,
-                };
-                _this.sessionInfo = session;
-                _this.storageWriter && _this.storageWriter(session);
-                _this.writeToComponents({ active: isActive });
-            }));
-            this.subscriptions.push(conversation.onUnreadMessage(function (event, data) {
-                _this.events.dispatch('conversation:unread-message', data);
-                _this.writeToComponents({ alert: { show: data } });
-            }));
-            invokeHandlers_1(conversation.providers);
-            return true;
-        }
-        controller = this.controllers[index];
-        return false;
-    };
-    ConversationPlatform.prototype.writeToComponents = function (properties, key) {
-        if (key === void 0) { key = 'conversationReturnButtonState'; }
-        if (this.buttonQuery) {
-            this.components.write({
-                key: 'conversationReturnButtonState',
-                attributes: { properties: properties },
-                target: this.buttonQuery,
-                provider: 'localStorage',
-            });
-        }
-    };
-    ConversationPlatform.prototype.invokeHandler = function (provider, controller) {
-        var dispose = provider.handler(controller.conversation.createProvider(provider.name), controller.component);
-        if (dispose) {
-            if (!this.disposeProviders[provider.name]) {
-                this.disposeProviders[provider.name] = [];
-            }
-            this.disposeProviders[provider.name].push(dispose);
-        }
-    };
-    ConversationPlatform.prototype.getComponentRoute = function () {
-        return readStorage(this.container, STORAGE_KEY, StorageMedium.Local).then(function (stored) { return stored === null || stored === void 0 ? void 0 : stored.route; });
-    };
-    ConversationPlatform.prototype.dispose = function () {
-        var _this = this;
-        Object.keys(this.disposeProviders).forEach(function (key) {
-            _this.disposeProviders[key].forEach(function (dispose) {
-                dispose();
-            });
-        });
-        this.subscriptions.forEach(function (unsubscribe) {
-            unsubscribe();
-        });
-        this.controllers = [];
-        this.providers = [];
-    };
-    ConversationPlatform.handleContactMethodClick = function (event, container, contactMethod, callback) {
-        return __awaiter(this, void 0, void 0, function () {
-            var triggerEl;
-            return __generator(this, function (_a) {
-                if (shouldPreventDefault(container)) {
-                    event.preventDefault();
-                    triggerEl = document.getElementById('humany-dynamic-anchor');
-                    if (!triggerEl) {
-                        triggerEl = document.createElement('a');
-                        triggerEl.setAttribute('href', '#');
-                        triggerEl.id = 'humany-dynamic-anchor';
-                        document.body.appendChild(triggerEl);
-                    }
-                    openChatWidget(container, contactMethod, triggerEl);
-                }
-                openChatWidget(container, contactMethod);
-                return [2 /*return*/];
-            });
-        });
-    };
-    ConversationPlatform.handleContactMethodSubmit = function (container, contactMethod) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, navigateToConversation(container, contactMethod)];
-            });
-        });
-    };
-    return ConversationPlatform;
-}());
-export { ConversationPlatform };

package/lib-esm/conversation-provider.js

@@ -1,70 +0,0 @@
-import { Agent } from './agent';
-var ConversationProvider = /** @class */ (function () {
-    function ConversationProvider(name, container, controller) {
-        this.name = name;
-        this.container = container;
-        this.controller = controller;
-        this.subscriptions = [];
-        this.user = controller === null || controller === void 0 ? void 0 : controller.user;
-    }
-    ConversationProvider.create = function (name, container, controller) {
-        return new ConversationProvider(name, container, controller);
-    };
-    ConversationProvider.prototype.createAgent = function (settings) {
-        if (settings === void 0) { settings = {}; }
-        if (this.controller) {
-            return new Agent(this, settings);
-        }
-    };
-    ConversationProvider.prototype.print = function (settings) {
-        var _a;
-        return (_a = this.controller) === null || _a === void 0 ? void 0 : _a.print(settings);
-    };
-    ConversationProvider.prototype.setTypingState = function (sender, type) {
-        var _a;
-        return (_a = this.controller) === null || _a === void 0 ? void 0 : _a.setTypingState(sender, type);
-    };
-    ConversationProvider.prototype.loading = function () {
-        if (!this.controller) {
-            return function () { return function () { }; };
-        }
-        return this.controller.loader();
-    };
-    ConversationProvider.prototype.createEntry = function (key, content, type, sender, timestamp) {
-        var _a;
-        return (_a = this.controller) === null || _a === void 0 ? void 0 : _a.createEntry(key, content, type, sender, timestamp);
-    };
-    ConversationProvider.prototype.dispose = function () {
-        var _a;
-        if (process.env.NODE_ENV !== 'production') {
-            console.log("conversation-provider: dispose (".concat(this.name, ")"));
-        }
-        (_a = this.controller) === null || _a === void 0 ? void 0 : _a.disposeProvider(this);
-        this.controller = null;
-        this.subscriptions.forEach(function (unsub) { return unsub(); });
-    };
-    ConversationProvider.prototype.onUnreadMessage = function (fn) {
-        var _a;
-        if (this.controller) {
-            var unsubscribe_1 = (_a = this.controller) === null || _a === void 0 ? void 0 : _a.onUnreadMessage(fn);
-            this.subscriptions.push(unsubscribe_1);
-            return function () {
-                unsubscribe_1();
-            };
-        }
-    };
-    ConversationProvider.prototype.onMounted = function (fn) {
-        var _a;
-        if (this.controller) {
-            var unsubscribe_2 = (_a = this.controller) === null || _a === void 0 ? void 0 : _a.events.subscribe('conversation:component-mount-changed', fn);
-            this.subscriptions.push(unsubscribe_2);
-            fn({}, this.controller.getComponentMountedState());
-            return function () {
-                unsubscribe_2();
-            };
-        }
-    };
-    return ConversationProvider;
-}());
-export { ConversationProvider };
-export default ConversationProvider;

package/lib-esm/index.js

@@ -1,6 +0,0 @@
-import { ConversationEndedBehavior, ConversationPlatform, } from './conversation-platform';
-export { ConversationController, ConversationEntry, ConversationMessageType, } from './conversation-controller';
-export { ConversationMessageListItemType } from './types';
-export { ConversationComponent, ConversationReturnButtonComponent } from './ui';
-export { registerCustomMessageComponent } from './utils/custom-message';
-export { ConversationPlatform, ConversationEndedBehavior };

package/lib-esm/resolve-entity-value.js

@@ -1,18 +0,0 @@
-/**
- * Registers a handler to resolve entity values initiated by the backend service.
- * @param widget Widget to resolve the entity value for.
- * @param name Name of entity to resolve.
- * @param handler Handler for resolving value.
- */
-export var resolveEntityValue = function (widget, name, handler) {
-    return widget.events.subscribe('data:resolve-entity-value', function (event, data) {
-        if (data.name === name) {
-            return new Promise(function (resolve) {
-                handler(function (value) {
-                    data.value = value;
-                    resolve();
-                }, data.value);
-            });
-        }
-    });
-};

package/lib-esm/types.js

@@ -1,16 +0,0 @@
-export var ConversationMessageListType;
-(function (ConversationMessageListType) {
-    ConversationMessageListType["Ordinary"] = "ordinary";
-    ConversationMessageListType["Seperator"] = "seperator";
-})(ConversationMessageListType || (ConversationMessageListType = {}));
-export var ConversationMessageListItemType;
-(function (ConversationMessageListItemType) {
-    ConversationMessageListItemType["Header"] = "header";
-    ConversationMessageListItemType["LinkList"] = "link-list";
-    ConversationMessageListItemType["Separator"] = "separator";
-    ConversationMessageListItemType["NoGoodAlternative"] = "no-good-alternative";
-    ConversationMessageListItemType["ButtonList"] = "button-list";
-    ConversationMessageListItemType["Text"] = "text";
-    ConversationMessageListItemType["HTML"] = "html";
-    ConversationMessageListItemType["FeedbackList"] = "feedback-list";
-})(ConversationMessageListItemType || (ConversationMessageListItemType = {}));

package/lib-esm/ui/conversation/conversation-component.js

@@ -1,127 +0,0 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-import { createReactComponent } from '@telia-ace/widget-ui';
-import { ConversationMessageType } from '../../conversation-controller';
-import { ConversationPlatform } from '../../conversation-platform';
-/**
- * Group items by sender, type and time. Current grouping threshold is 2000 ms.
- * Put this as a property on either the component or on the provider?
- * Could possibly be implemented directly in the createEntry method
- * of the conversation controller to avoid iterating over the entire array on
- * each update.
- */
-var groupedMessages = function (messages, timeout) {
-    return messages.reduce(function (acc, current, index) {
-        var _a, _b;
-        var newItem = __assign(__assign({}, current), { content: [__assign(__assign({}, current.content), { key: current.key })] });
-        if (acc.length > 0 && current.type !== ConversationMessageType.System) {
-            var previous = acc[acc.length - 1];
-            if ((!timeout && timeout !== 0) ||
-                Math.abs(previous.timestamp - current.timestamp) < timeout) {
-                if (((_a = previous.sender) === null || _a === void 0 ? void 0 : _a.name) === ((_b = current.sender) === null || _b === void 0 ? void 0 : _b.name) &&
-                    previous.type === current.type) {
-                    previous.timestamp = current.timestamp;
-                    previous.content.push(__assign(__assign({}, current.content), { key: current.key }));
-                    return acc;
-                }
-            }
-        }
-        acc.push(newItem);
-        return acc;
-    }, []);
-};
-var ConversationComponent = function (container) {
-    return Promise.all([
-        ConversationPlatform.getInstance(container),
-        container.getAsync('router'),
-    ]).then(function (_a) {
-        var _b = __read(_a, 2), platform = _b[0], router = _b[1];
-        return createReactComponent(container, 'conversation', import('./conversation'), function (component) {
-            var routeData = router.getRouteData();
-            var name = routeData.params.id || component.node.name || 'component';
-            var conversation = platform.createController(name);
-            var isNewController = platform.registerController(conversation, component);
-            var messageGroupingTimeout = 3 * 60 * 1000;
-            var setProperties = function (properties) {
-                var _a = properties.providers, providers = _a === void 0 ? [] : _a;
-                if (providers) {
-                    var providerKeys = Array.isArray(providers) ? providers : [providers];
-                    conversation.setProviders(providerKeys);
-                    return providerKeys;
-                }
-            };
-            setProperties(component.properties(setProperties));
-            conversation.setComponentMountedState(true);
-            var writeMessages = function (messageStream) {
-                var loading = messageStream.loading, typingActors = messageStream.typingActors, messages = messageStream.messages;
-                component.writeProperties({
-                    loading: loading,
-                    typingActors: typingActors,
-                    messages: groupedMessages(messages, messageGroupingTimeout),
-                });
-            };
-            writeMessages(conversation.getMessageStream());
-            if (isNewController) {
-                // todo: dont create actions here, there will be duplicates due to reuseController = true
-                component.actions.create('user-submit', function (data, options) {
-                    if (options) {
-                        var preventDefault = options.preventDefault, validationPromise = options.validationPromise;
-                        if (preventDefault) {
-                            if (validationPromise) {
-                                validationPromise().then(function (text) {
-                                    if (text) {
-                                        conversation.user.print(text);
-                                    }
-                                });
-                            }
-                            return;
-                        }
-                    }
-                    conversation.user.print(data.text);
-                });
-                component.actions.create('user-typing', function (data, options) { });
-                component.actions.create('form', function (data, options) { });
-                component.actions.create('action', function (data, options) { });
-            }
-            var unsubscribe = conversation.events.subscribe('conversation:updated', function (e, conversationData) {
-                writeMessages(conversationData);
-            });
-            return function () {
-                conversation.setComponentMountedState(false);
-                unsubscribe();
-                if (!conversation.active) {
-                    // unregisterController();
-                    // todo: add possibility to dispose this through extendComponent()
-                    // component.dispose();
-                    writeMessages({ messages: [], typingActors: [], loading: false });
-                }
-            };
-        }, { reuseController: true });
-    });
-};
-export default ConversationComponent;