@telia-ace/knowledge-widget-bot-provider 0.0.1-alpha.2 → 0.0.1-alpha.5

package/lib/interface/middleware/processor.interface.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ProcessorInterface = /** @class */ (function () {
+    function ProcessorInterface() {
+    }
+    ProcessorInterface.prototype.process = function (entries) {
+        var processedEntries = entries;
+        processedEntries = this.deletePaging(processedEntries);
+        processedEntries = this.delete(processedEntries);
+        processedEntries = this.merge(processedEntries);
+        processedEntries = this.moveLoader(processedEntries);
+        return processedEntries;
+    };
+    ProcessorInterface.prototype.processUpdate = function (entry, updateEntryArray) {
+        var _this = this;
+        updateEntryArray
+            .filter(function (t) { return t.type == 'List'; })
+            .forEach(function (o) {
+            var _a;
+            (_a = o.content) === null || _a === void 0 ? void 0 : _a.items.forEach(function (t) {
+                if (!(entry === null || entry === void 0 ? void 0 : entry.content.items.find(function (p) { return p.actionKey == t.actionKey; })))
+                    entry === null || entry === void 0 ? void 0 : entry.content.items.push(t);
+            });
+            Object.keys(o.actions).forEach(function (t) {
+                _this.handleActionUpdateOrInsert(entry === null || entry === void 0 ? void 0 : entry.actions, t, o.actions);
+            });
+        });
+        //moves the show more and if it helped to the end if it is needed
+        var itemArray = entry === null || entry === void 0 ? void 0 : entry.content.items;
+        if (itemArray.find(function (o) { return o.actionKey == 'next'; })) {
+            itemArray.push(itemArray.splice(itemArray.indexOf(itemArray.find(function (o) { return o.actionKey == 'next'; })), 1)[0]);
+        }
+        if (itemArray.find(function (o) { return o.actionKey == 'help'; })) {
+            itemArray.push(itemArray.splice(itemArray.indexOf(itemArray.find(function (o) { return o.actionKey == 'help'; })), 1)[0]);
+        }
+        return entry ? [entry] : [];
+    };
+    ProcessorInterface.prototype.handleActionUpdateOrInsert = function (currentArray, actionKey, action) {
+        if (!!currentArray)
+            currentArray[actionKey] = action[actionKey];
+    };
+    ProcessorInterface.prototype.deletePaging = function (entries) {
+        return entries.filter(function (entry) {
+            var isEmptyPaging = entry.type === 'List' &&
+                entry.tags &&
+                entry.tags.indexOf('paging') > -1 &&
+                typeof entry.content === 'undefined';
+            return !isEmptyPaging;
+        });
+    };
+    ProcessorInterface.prototype.delete = function (entries) {
+        return entries.filter(function (entry) { return entry.content !== null; });
+    };
+    ProcessorInterface.prototype.merge = function (entries) {
+        var output = [];
+        var merge = function (source, target) {
+            if (target === void 0) { target = {}; }
+            var content = {};
+            if (source == null) {
+                return null;
+            }
+            if (target) {
+                Object.keys(target).forEach(function (key) {
+                    content[key] = target[key];
+                });
+            }
+            Object.keys(source).forEach(function (key) {
+                if (key == 'items') {
+                    if (!content[key])
+                        content[key] = [];
+                    content[key] = content[key].concat(source[key]);
+                }
+                else if (key == 'html')
+                    content[key] = content[key] + source[key];
+                else
+                    content[key] = source[key];
+            });
+            return content;
+        };
+        var mergeLocalState = function (source, target) {
+            if (source == null)
+                return null;
+            if (Object.keys(source.actions).length === 0)
+                return target.localState;
+            if (Object.keys(target.actions).length === 0)
+                return source.localState;
+            return target.localState;
+        };
+        entries.forEach(function (entry) {
+            if (entry.relation) {
+                var existingEntry = entries.find(function (o) { return o.id == entry.relation; });
+                if (existingEntry) {
+                    var existingIndex = output.indexOf(existingEntry);
+                    existingEntry.localState = mergeLocalState(entry, existingEntry);
+                    existingEntry.content = merge(entry.content, existingEntry.content);
+                    existingEntry.actions = merge(entry.actions, existingEntry.actions);
+                    output[existingIndex] = existingEntry;
+                }
+            }
+            else {
+                output.push(entry);
+            }
+        });
+        return output;
+    };
+    ProcessorInterface.prototype.moveLoader = function (entries) {
+        // Moves the loader component to last position in stream
+        var loaderEntry = entries.find(function (e) { return e.id === 'loader'; });
+        if (!loaderEntry) {
+            return entries;
+        }
+        var loaderIndex = entries.indexOf(loaderEntry);
+        if (loaderIndex > -1) {
+            entries.splice(entries.length - 1, 0, entries.splice(loaderIndex, 1)[0]);
+        }
+        return entries;
+    };
+    return ProcessorInterface;
+}());
+exports.default = ProcessorInterface;

package/lib/plugin.d.ts

@@ -0,0 +1,3 @@
+import { Container } from '@webprovisions/platform';
+declare const ConversationPlugin: (container: Container) => Promise<void>;
+export default ConversationPlugin;

package/lib/plugin.js

@@ -0,0 +1,172 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 };
+    }
+};
+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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var knowledge_widget_adapters_1 = require("@telia-ace/knowledge-widget-adapters");
+var knowledge_widget_core_1 = require("@telia-ace/knowledge-widget-core");
+var knowledge_widget_types_grid_1 = require("@telia-ace/knowledge-widget-types-grid");
+var widget_conversation_1 = require("@telia-ace/widget-conversation");
+var chat_client_1 = __importDefault(require("./client/chat.client"));
+var contact_method_client_1 = require("./client/contact-method.client");
+var http_client_1 = require("./client/http.client");
+var middleware_client_1 = __importDefault(require("./client/middleware.client"));
+var ConversationPlugin = function (container) { return __awaiter(void 0, void 0, void 0, function () {
+    var platform, contactMethodPlatform, dataClient, compPlatform, _a, component, endpoint;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, widget_conversation_1.ConversationPlatform.getInstance(container)];
+            case 1:
+                platform = _b.sent();
+                return [4 /*yield*/, knowledge_widget_adapters_1.ContactMethodPlatform.getInstance(container)];
+            case 2:
+                contactMethodPlatform = _b.sent();
+                return [4 /*yield*/, knowledge_widget_types_grid_1.DataClient.getInstance(container)];
+            case 3:
+                dataClient = _b.sent();
+                return [4 /*yield*/, knowledge_widget_core_1.ComponentPlatform.getInstance(container)];
+            case 4:
+                compPlatform = _b.sent();
+                _a = __read(compPlatform.nodes.query({ type: 'conversation' }), 1), component = _a[0];
+                endpoint = '';
+                setTimeout(function () {
+                    endpoint = component.attributes.properties.knowledgeBotEndpoint;
+                });
+                platform.registerProvider('chat.bot', function (conversation, component) {
+                    (0, widget_conversation_1.registerCustomMessageComponent)(container, 'ace-knowledge-contact-method', Promise.resolve().then(function () { return __importStar(require('./contract/custom-component/contact-method')); }));
+                    var agent = conversation.createAgent({
+                        name: 'John Doe',
+                        avatar: 'https://www.site.com/avatar.jpg',
+                    });
+                    // pases the user and the agent to the Chat Helper
+                    chat_client_1.default.initialize(conversation.user, agent);
+                    // passes the conversation provider to the Contact Method Client
+                    contact_method_client_1.ContactMethodClient.initialize(dataClient, contactMethodPlatform, agent);
+                    // passes the container and the widget to the Middleware Store
+                    middleware_client_1.default.initialize(container, container.get('$widget'));
+                    // executes to decide on what to do on first load
+                    var httpClient = new http_client_1.HttpClient(endpoint);
+                    httpClient.firstHit();
+                    component.actions.create('evaluate', function (input) {
+                        var cmClient = new contact_method_client_1.ContactMethodClient();
+                        cmClient.handleNewForm(input.form, input.form.id);
+                    });
+                    component.actions.create('validate', function (input) {
+                        var cmClient = new contact_method_client_1.ContactMethodClient();
+                        cmClient.validate(input.form);
+                    });
+                    component.actions.create('submit', function (input) {
+                        var cmClient = new contact_method_client_1.ContactMethodClient();
+                        cmClient.validate(input.form);
+                    });
+                    component.actions.watch('conversation.user-typing', function (input, next) {
+                        return next(input);
+                    });
+                    component.actions.watch('conversation.user-submit', function (input, next) {
+                        var httpClient = new http_client_1.HttpClient(endpoint);
+                        httpClient.handlePhrase(input.text);
+                        return next(input);
+                    });
+                    component.actions.watch('conversation.form', function (input, next) {
+                        return next(input);
+                    });
+                    component.actions.watch('conversation.action', function (input, next) {
+                        var chatClient = new chat_client_1.default();
+                        var cmClient = new contact_method_client_1.ContactMethodClient();
+                        if (input === 'contact' || input.split('/').length > 1) {
+                            cmClient.handleContactMethod(input);
+                            return next(input);
+                        }
+                        var middlewareClient = new middleware_client_1.default();
+                        // this is an update check, as it requires
+                        // a lot different logic and no user message
+                        if (middlewareClient.checkForUpdate(input)) {
+                            middlewareClient.handleUpdate(input, endpoint);
+                            return next(input);
+                        }
+                        chatClient.printUserMessageAndStoreIt(input);
+                        var httpClient = new http_client_1.HttpClient(endpoint);
+                        httpClient.handleInput(input);
+                        return next(input);
+                    });
+                });
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.default = ConversationPlugin;

package/lib-esm/client/chat.client.d.ts

@@ -0,0 +1,15 @@
+import { Message } from '../contract/model/conversation-api-model/message.model';
+import EntryInterface from '../interface/entry.interface';
+export default class ChatClient {
+    entryInterface: EntryInterface;
+    constructor();
+    static initialize(user: any, agent: any): void;
+    processMessageArrayAndStoreIt(messages: Message[]): void;
+    updateMessageArrayAndStoreIt(messages: Message[]): void;
+    printUserMessageAndStoreIt(action: string): void;
+    private postUserMessage;
+    private postAgentMessage;
+    private getTitleFromEntry;
+    private getTitleFromText;
+    private getTitleFromList;
+}

package/lib-esm/client/chat.client.js

@@ -0,0 +1,75 @@
+import { v4 as newGuid } from 'uuid';
+import { ServerEntryTypeEnum } from '../contract/enum/server-entry-type.enum';
+import { ChatHelper } from '../helper/chat.helper';
+import { StoreHelper } from '../helper/store.helper';
+import EntryInterface from '../interface/entry.interface';
+var ChatClient = /** @class */ (function () {
+    function ChatClient() {
+        this.entryInterface = new EntryInterface();
+    }
+    ChatClient.initialize = function (user, agent) {
+        ChatHelper.setUser(user);
+        ChatHelper.setAgent(agent);
+    };
+    ChatClient.prototype.processMessageArrayAndStoreIt = function (messages) {
+        var _this = this;
+        messages
+            .filter(function (o) { return o && o != null; })
+            .forEach(function (o) {
+            if (o.isUser)
+                _this.postUserMessage(o);
+            else
+                _this.postAgentMessage(o);
+        });
+        StoreHelper.insertOrUpdateMessageArrayStore(messages);
+    };
+    ChatClient.prototype.updateMessageArrayAndStoreIt = function (messages) {
+        var conversationEntry = undefined;
+        messages.forEach(function (o) {
+            var message = StoreHelper.getMessage(o.id);
+            message === null || message === void 0 ? void 0 : message.conversationEntry.update(o.message);
+            conversationEntry = message === null || message === void 0 ? void 0 : message.conversationEntry;
+        });
+        StoreHelper.insertOrUpdateMessageArrayStore(messages, conversationEntry);
+    };
+    ChatClient.prototype.printUserMessageAndStoreIt = function (action) {
+        if (action == 'next' || action == 'help')
+            return;
+        var entry = StoreHelper.getEntry(action);
+        var message = {
+            id: newGuid(),
+            message: !entry ? action : this.getTitleFromEntry(entry, action),
+            isUser: true,
+        };
+        this.postUserMessage(message);
+        StoreHelper.insertOrUpdateMessageArrayStore([message]);
+    };
+    ChatClient.prototype.postUserMessage = function (message) {
+        ChatHelper.getUser().print(message.message);
+    };
+    ChatClient.prototype.postAgentMessage = function (message) {
+        message.conversationEntry = ChatHelper.getAgent().print(message.message);
+    };
+    ChatClient.prototype.getTitleFromEntry = function (entry, action) {
+        var entryType = ServerEntryTypeEnum[entry.type];
+        switch (entryType) {
+            case ServerEntryTypeEnum.List:
+                return this.getTitleFromList(entry, action);
+            case ServerEntryTypeEnum.Text:
+                return this.getTitleFromText(entry, action);
+            default:
+                return '';
+        }
+    };
+    ChatClient.prototype.getTitleFromText = function (entry, action) {
+        if (!!entry.content.items)
+            return this.getTitleFromList(entry, action);
+        else
+            return entry.content.html;
+    };
+    ChatClient.prototype.getTitleFromList = function (entry, action) {
+        return entry.content.items.find(function (o) { return o.actionKey == action; }).title;
+    };
+    return ChatClient;
+}());
+export default ChatClient;

package/lib-esm/client/contact-method.client.d.ts

@@ -0,0 +1,22 @@
+import { ContactMethodPlatform } from '@telia-ace/knowledge-widget-adapters';
+import { DataClient } from '@telia-ace/knowledge-widget-types-grid';
+export declare class ContactMethodClient {
+    private static dataClient;
+    private static contactMethodPlatform;
+    private static contactMessageEntryArray;
+    private static agent;
+    private chatClient;
+    static initialize(dataClient: DataClient, contactMethodPlatform: ContactMethodPlatform, agent: any): void;
+    handleNewForm: (errors: any, entry: any) => Promise<void>;
+    handleContactMethod: (input?: string) => Promise<void>;
+    validate(form: any): void;
+    private handleContactCategoryList;
+    private handleForm;
+    private handleContactMethodList;
+    private handleSingleContactMethod;
+    private submit;
+    private removeForm;
+    private printMessage;
+    private loadContactMethods;
+    private updateForm;
+}