@telia-ace/knowledge-widget-bot-provider 0.0.1-alpha.6 → 0.0.1-alpha.9

package/LICENSE.txt

@@ -1,6 +1,6 @@
-Copyright © 2021, Telia Company AB. All rights reserved.
-
-THIS PACKAGE AND CONTAINING SOFTWARE IS PART OF
-THE HUMANY SERVICE. BY USING THIS SOFTWARE YOU
-AGREE TO THE FOLLOWING TERMS AND CONDITIONS:
+Copyright © 2021, Telia Company AB. All rights reserved.
+
+THIS PACKAGE AND CONTAINING SOFTWARE IS PART OF
+THE HUMANY SERVICE. BY USING THIS SOFTWARE YOU
+AGREE TO THE FOLLOWING TERMS AND CONDITIONS:
 http://www.humany.com/legal

package/README.md

@@ -1,12 +1,12 @@
-# `@telia-ace/knowledge-widget-bot-provider`
-
-Provider for the ACE Knowledge chat bot.
-
-For this provider to work, the "chat.bot" provider must be registered in the widget config file.
-
-In addition, these plugins are also required:
-WidgetHeaderComponent
-AreaComponent
-ConversationComponent
-DefaultContactMethodsPlugin
-ConversationPlugin
+# `@telia-ace/knowledge-widget-bot-provider`
+
+Provider for the ACE Knowledge chat bot.
+
+For this provider to work, the "chat.bot" provider must be registered in the widget config file.
+
+In addition, these plugins are also required:
+WidgetHeaderComponent
+AreaComponent
+ConversationComponent
+DefaultContactMethodsPlugin
+ConversationPlugin

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

@@ -1,15 +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;
-}
+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/client/chat.client.js

@@ -1,80 +1,79 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var uuid_1 = require("uuid");
-var server_entry_type_enum_1 = require("../contract/enum/server-entry-type.enum");
-var chat_helper_1 = require("../helper/chat.helper");
-var store_helper_1 = require("../helper/store.helper");
-var entry_interface_1 = __importDefault(require("../interface/entry.interface"));
-var ChatClient = /** @class */ (function () {
-    function ChatClient() {
-        this.entryInterface = new entry_interface_1.default();
-    }
-    ChatClient.initialize = function (user, agent) {
-        chat_helper_1.ChatHelper.setUser(user);
-        chat_helper_1.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);
-        });
-        store_helper_1.StoreHelper.insertOrUpdateMessageArrayStore(messages);
-    };
-    ChatClient.prototype.updateMessageArrayAndStoreIt = function (messages) {
-        var conversationEntry = undefined;
-        messages.forEach(function (o) {
-            var message = store_helper_1.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;
-        });
-        store_helper_1.StoreHelper.insertOrUpdateMessageArrayStore(messages, conversationEntry);
-    };
-    ChatClient.prototype.printUserMessageAndStoreIt = function (action) {
-        if (action == 'next' || action == 'help')
-            return;
-        var entry = store_helper_1.StoreHelper.getEntry(action);
-        var message = {
-            id: (0, uuid_1.v4)(),
-            message: !entry ? action : this.getTitleFromEntry(entry, action),
-            isUser: true,
-        };
-        this.postUserMessage(message);
-        store_helper_1.StoreHelper.insertOrUpdateMessageArrayStore([message]);
-    };
-    ChatClient.prototype.postUserMessage = function (message) {
-        chat_helper_1.ChatHelper.getUser().print(message.message);
-    };
-    ChatClient.prototype.postAgentMessage = function (message) {
-        message.conversationEntry = chat_helper_1.ChatHelper.getAgent().print(message.message);
-    };
-    ChatClient.prototype.getTitleFromEntry = function (entry, action) {
-        var entryType = server_entry_type_enum_1.ServerEntryTypeEnum[entry.type];
-        switch (entryType) {
-            case server_entry_type_enum_1.ServerEntryTypeEnum.List:
-                return this.getTitleFromList(entry, action);
-            case server_entry_type_enum_1.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;
-}());
-exports.default = ChatClient;
+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();
+    }
+    // Initialize from setting the user and agent for the Helper
+    ChatClient.initialize = function (user, agent) {
+        ChatHelper.setUser(user);
+        ChatHelper.setAgent(agent);
+    };
+    // function for posting the messages
+    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);
+    };
+    // function for updating current 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);
+    };
+    // function for posting a message for the user actions, such as button clicks
+    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/client/contact-method.client.d.ts

@@ -1,22 +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;
-}
+import { ContactMethodPlatform } from '@humany/widget-adapters';
+import { DataClient } from '@humany/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;
+}