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

package/lib/client/chat.client.js

@@ -12,10 +12,12 @@ var ChatClient = /** @class */ (function () {
     function ChatClient() {
         this.entryInterface = new entry_interface_1.default();
     }
+    // Initialize from setting the user and agent for the Helper
     ChatClient.initialize = function (user, agent) {
         chat_helper_1.ChatHelper.setUser(user);
         chat_helper_1.ChatHelper.setAgent(agent);
     };
+    // function for posting the messages
     ChatClient.prototype.processMessageArrayAndStoreIt = function (messages) {
         var _this = this;
         messages
@@ -28,6 +30,7 @@ var ChatClient = /** @class */ (function () {
         });
         store_helper_1.StoreHelper.insertOrUpdateMessageArrayStore(messages);
     };
+    // function for updating current messages
     ChatClient.prototype.updateMessageArrayAndStoreIt = function (messages) {
         var conversationEntry = undefined;
         messages.forEach(function (o) {
@@ -37,6 +40,7 @@ var ChatClient = /** @class */ (function () {
         });
         store_helper_1.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;

package/lib/client/contact-method.client.js

@@ -60,6 +60,7 @@ var ContactMethodClient = /** @class */ (function () {
     function ContactMethodClient() {
         var _this = this;
         this.chatClient = new chat_client_1.default();
+        // function for handling forms as contact methods
         this.handleNewForm = function (errors, entry) { return __awaiter(_this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 this.updateForm(entry.contactMethods, {
@@ -74,6 +75,7 @@ var ContactMethodClient = /** @class */ (function () {
                 return [2 /*return*/];
             });
         }); };
+        // function for receiving the contact method based on the input
         this.handleContactMethod = function (input) {
             if (input === void 0) { input = ''; }
             return __awaiter(_this, void 0, void 0, function () {
@@ -144,6 +146,7 @@ var ContactMethodClient = /** @class */ (function () {
         this.contactMethodPlatform = contactMethodPlatform;
         this.agent = agent;
     };
+    // validation of the form provided
     ContactMethodClient.prototype.validate = function (form) {
         var _this = this;
         var entry = ContactMethodClient.contactMessageEntryArray.find(function (o) { return o.id == form.schema.id; });

package/lib/client/http.client.d.ts

@@ -1,4 +1,3 @@
-import { ServerEntry } from '../contract/model/http/server-entry.model';
 export declare class HttpClient {
     private endpointUrl;
     private clientId;
@@ -7,16 +6,17 @@ export declare class HttpClient {
     private options;
     private middlewareClient;
     private chatClient;
-    constructor(endpoint: string);
+    constructor(endpoint: string, clientId: string);
     firstHit(): void;
-    handleUpdate(action: string): Promise<ServerEntry[]>;
+    handleUpdate(action: string): void;
     handleInput(action: string): void;
     handlePhrase(phrase: string): void;
     private postAndHandleTheData;
-    private postAndReturnTheData;
+    private postAndHandleTheUpdateData;
     private getHttpOptions;
     private constructInputEnvelope;
     private constructPhraseEnvelope;
     private constructFirstHitEnvelope;
     private handleResponseData;
+    private handleUpdateResponseData;
 }

package/lib/client/http.client.js

@@ -10,10 +10,10 @@ var store_helper_1 = require("../helper/store.helper");
 var chat_client_1 = __importDefault(require("./chat.client"));
 var middleware_client_1 = __importDefault(require("./middleware.client"));
 var HttpClient = /** @class */ (function () {
-    function HttpClient(endpoint) {
+    function HttpClient(endpoint, clientId) {
         this.options = {
             credentials: http_helper_1.HttpHelper.getCredentials(),
-            clientId: '84d96a63-b8ba-33ec-22d5-515255f866f8',
+            clientId: clientId,
         };
         this.apiEndpoint = endpoint;
         this.projectionPath = window.location.href;
@@ -38,9 +38,10 @@ var HttpClient = /** @class */ (function () {
     // for updates, such as paging changes
     HttpClient.prototype.handleUpdate = function (action) {
         var envelope = this.constructInputEnvelope(action);
-        return this.postAndReturnTheData(envelope, action).then(function (o) {
-            return o.entries;
-        });
+        this.postAndHandleTheUpdateData(envelope, action);
+        // return this.postAndReturnTheData(envelope, action).then((o) => {
+        //     return o.entries;
+        // });
     };
     // for action clicks
     HttpClient.prototype.handleInput = function (action) {
@@ -65,7 +66,8 @@ var HttpClient = /** @class */ (function () {
         })
             .catch(function (err) { return console.log(err); });
     };
-    HttpClient.prototype.postAndReturnTheData = function (envelope, action) {
+    HttpClient.prototype.postAndHandleTheUpdateData = function (envelope, action) {
+        var _this = this;
         return fetch(this.apiEndpoint, this.getHttpOptions(envelope))
             .then(function (response) {
             if (response.ok)
@@ -73,7 +75,7 @@ var HttpClient = /** @class */ (function () {
             throw response;
         })
             .then(function (data) {
-            return data;
+            _this.handleUpdateResponseData(data, action);
         })
             .catch(function (err) { return console.log(err); });
     };
@@ -109,6 +111,9 @@ var HttpClient = /** @class */ (function () {
         store_helper_1.StoreHelper.setGlobalState(envelope.globalState);
         this.middlewareClient.handleEntries(envelope.entries, action);
     };
+    HttpClient.prototype.handleUpdateResponseData = function (envelope, action) {
+        this.middlewareClient.handleUpdate(envelope.entries, action);
+    };
     return HttpClient;
 }());
 exports.HttpClient = HttpClient;

package/lib/client/middleware.client.d.ts

@@ -7,7 +7,7 @@ export default class MiddlewareClient {
     constructor();
     static initialize(container: any, widget: any): void;
     handleEntries(entries: ServerEntry[], action?: string): void;
-    handleUpdate(input: string, endpoint: string): void;
+    handleUpdate(entries: ServerEntry[], action?: string): void;
     checkForUpdate(input: string): boolean;
     private executeMiddlewares;
 }

package/lib/client/middleware.client.js

@@ -6,16 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var middleware_helper_1 = require("../helper/middleware.helper");
 var store_helper_1 = require("../helper/store.helper");
 var entry_interface_1 = __importDefault(require("../interface/entry.interface"));
-// import ContactExpandedInterface from "../interface/middleware/contact-expanded.interface";
-// import ContactInterface from "../interface/middleware/legacy-contact-methods.interface";
 var paging_interface_1 = __importDefault(require("../interface/middleware/paging.interface"));
 var processor_interface_1 = __importDefault(require("../interface/middleware/processor.interface"));
 var chat_client_1 = __importDefault(require("./chat.client"));
-var http_client_1 = require("./http.client");
 var MiddlewareClient = /** @class */ (function () {
     function MiddlewareClient() {
-        // this.contactExpanded = new ContactExpandedInterface();
-        // this.legacyContact = new ContactInterface();
         this.paging = new paging_interface_1.default();
         this.processor = new processor_interface_1.default();
         this.entryInterface = new entry_interface_1.default();
@@ -33,14 +28,10 @@ var MiddlewareClient = /** @class */ (function () {
     };
     // called on situations such as paging changes
     // when no new entries will be printed
-    MiddlewareClient.prototype.handleUpdate = function (input, endpoint) {
-        var _this = this;
-        var httpClient = new http_client_1.HttpClient(endpoint);
-        httpClient.handleUpdate(input).then(function (entries) {
-            var o = _this.executeMiddlewares(entries, true, input);
-            var messageArray = _this.entryInterface.transformArray(o);
-            _this.chatClient.updateMessageArrayAndStoreIt(messageArray);
-        });
+    MiddlewareClient.prototype.handleUpdate = function (entries, action) {
+        var o = this.executeMiddlewares(entries, true, action);
+        var messageArray = this.entryInterface.transformArray(o);
+        this.chatClient.updateMessageArrayAndStoreIt(messageArray);
     };
     // checks whether the action was of an update type
     MiddlewareClient.prototype.checkForUpdate = function (input) {

package/lib/plugin.js

@@ -81,12 +81,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 uuid_1 = require("uuid");
 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;
+    var platform, contactMethodPlatform, dataClient, compPlatform, clientId, _a, component, endpoint;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0: return [4 /*yield*/, widget_conversation_1.ConversationPlatform.getInstance(container)];
@@ -101,6 +102,7 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                 return [4 /*yield*/, knowledge_widget_core_1.ComponentPlatform.getInstance(container)];
             case 4:
                 compPlatform = _b.sent();
+                clientId = (0, uuid_1.v4)();
                 _a = __read(compPlatform.nodes.query({ type: 'conversation' }), 1), component = _a[0];
                 endpoint = '';
                 setTimeout(function () {
@@ -119,7 +121,7 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                     // 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);
+                    var httpClient = new http_client_1.HttpClient(endpoint, clientId);
                     httpClient.firstHit();
                     component.actions.create('evaluate', function (input) {
                         var cmClient = new contact_method_client_1.ContactMethodClient();
@@ -137,7 +139,7 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                         return next(input);
                     });
                     component.actions.watch('conversation.user-submit', function (input, next) {
-                        var httpClient = new http_client_1.HttpClient(endpoint);
+                        var httpClient = new http_client_1.HttpClient(endpoint, clientId);
                         httpClient.handlePhrase(input.text);
                         return next(input);
                     });
@@ -152,14 +154,14 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                             return next(input);
                         }
                         var middlewareClient = new middleware_client_1.default();
+                        var httpClient = new http_client_1.HttpClient(endpoint, clientId);
                         // this is an update check, as it requires
                         // a lot different logic and no user message
                         if (middlewareClient.checkForUpdate(input)) {
-                            middlewareClient.handleUpdate(input, endpoint);
+                            httpClient.handleUpdate(input);
                             return next(input);
                         }
                         chatClient.printUserMessageAndStoreIt(input);
-                        var httpClient = new http_client_1.HttpClient(endpoint);
                         httpClient.handleInput(input);
                         return next(input);
                     });

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

@@ -7,10 +7,12 @@ 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
@@ -23,6 +25,7 @@ var ChatClient = /** @class */ (function () {
         });
         StoreHelper.insertOrUpdateMessageArrayStore(messages);
     };
+    // function for updating current messages
     ChatClient.prototype.updateMessageArrayAndStoreIt = function (messages) {
         var conversationEntry = undefined;
         messages.forEach(function (o) {
@@ -32,6 +35,7 @@ var ChatClient = /** @class */ (function () {
         });
         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;

package/lib-esm/client/contact-method.client.js

@@ -54,6 +54,7 @@ var ContactMethodClient = /** @class */ (function () {
     function ContactMethodClient() {
         var _this = this;
         this.chatClient = new ChatClient();
+        // function for handling forms as contact methods
         this.handleNewForm = function (errors, entry) { return __awaiter(_this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 this.updateForm(entry.contactMethods, {
@@ -68,6 +69,7 @@ var ContactMethodClient = /** @class */ (function () {
                 return [2 /*return*/];
             });
         }); };
+        // function for receiving the contact method based on the input
         this.handleContactMethod = function (input) {
             if (input === void 0) { input = ''; }
             return __awaiter(_this, void 0, void 0, function () {
@@ -138,6 +140,7 @@ var ContactMethodClient = /** @class */ (function () {
         this.contactMethodPlatform = contactMethodPlatform;
         this.agent = agent;
     };
+    // validation of the form provided
     ContactMethodClient.prototype.validate = function (form) {
         var _this = this;
         var entry = ContactMethodClient.contactMessageEntryArray.find(function (o) { return o.id == form.schema.id; });

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

@@ -1,4 +1,3 @@
-import { ServerEntry } from '../contract/model/http/server-entry.model';
 export declare class HttpClient {
     private endpointUrl;
     private clientId;
@@ -7,16 +6,17 @@ export declare class HttpClient {
     private options;
     private middlewareClient;
     private chatClient;
-    constructor(endpoint: string);
+    constructor(endpoint: string, clientId: string);
     firstHit(): void;
-    handleUpdate(action: string): Promise<ServerEntry[]>;
+    handleUpdate(action: string): void;
     handleInput(action: string): void;
     handlePhrase(phrase: string): void;
     private postAndHandleTheData;
-    private postAndReturnTheData;
+    private postAndHandleTheUpdateData;
     private getHttpOptions;
     private constructInputEnvelope;
     private constructPhraseEnvelope;
     private constructFirstHitEnvelope;
     private handleResponseData;
+    private handleUpdateResponseData;
 }

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

@@ -4,10 +4,10 @@ import { StoreHelper } from '../helper/store.helper';
 import ChatClient from './chat.client';
 import MiddlewareClient from './middleware.client';
 var HttpClient = /** @class */ (function () {
-    function HttpClient(endpoint) {
+    function HttpClient(endpoint, clientId) {
         this.options = {
             credentials: HttpHelper.getCredentials(),
-            clientId: '84d96a63-b8ba-33ec-22d5-515255f866f8',
+            clientId: clientId,
         };
         this.apiEndpoint = endpoint;
         this.projectionPath = window.location.href;
@@ -32,9 +32,10 @@ var HttpClient = /** @class */ (function () {
     // for updates, such as paging changes
     HttpClient.prototype.handleUpdate = function (action) {
         var envelope = this.constructInputEnvelope(action);
-        return this.postAndReturnTheData(envelope, action).then(function (o) {
-            return o.entries;
-        });
+        this.postAndHandleTheUpdateData(envelope, action);
+        // return this.postAndReturnTheData(envelope, action).then((o) => {
+        //     return o.entries;
+        // });
     };
     // for action clicks
     HttpClient.prototype.handleInput = function (action) {
@@ -59,7 +60,8 @@ var HttpClient = /** @class */ (function () {
         })
             .catch(function (err) { return console.log(err); });
     };
-    HttpClient.prototype.postAndReturnTheData = function (envelope, action) {
+    HttpClient.prototype.postAndHandleTheUpdateData = function (envelope, action) {
+        var _this = this;
         return fetch(this.apiEndpoint, this.getHttpOptions(envelope))
             .then(function (response) {
             if (response.ok)
@@ -67,7 +69,7 @@ var HttpClient = /** @class */ (function () {
             throw response;
         })
             .then(function (data) {
-            return data;
+            _this.handleUpdateResponseData(data, action);
         })
             .catch(function (err) { return console.log(err); });
     };
@@ -103,6 +105,9 @@ var HttpClient = /** @class */ (function () {
         StoreHelper.setGlobalState(envelope.globalState);
         this.middlewareClient.handleEntries(envelope.entries, action);
     };
+    HttpClient.prototype.handleUpdateResponseData = function (envelope, action) {
+        this.middlewareClient.handleUpdate(envelope.entries, action);
+    };
     return HttpClient;
 }());
 export { HttpClient };

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

@@ -7,7 +7,7 @@ export default class MiddlewareClient {
     constructor();
     static initialize(container: any, widget: any): void;
     handleEntries(entries: ServerEntry[], action?: string): void;
-    handleUpdate(input: string, endpoint: string): void;
+    handleUpdate(entries: ServerEntry[], action?: string): void;
     checkForUpdate(input: string): boolean;
     private executeMiddlewares;
 }

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

@@ -1,16 +1,11 @@
 import { MiddlewareHelper } from '../helper/middleware.helper';
 import { StoreHelper } from '../helper/store.helper';
 import EntryInterface from '../interface/entry.interface';
-// import ContactExpandedInterface from "../interface/middleware/contact-expanded.interface";
-// import ContactInterface from "../interface/middleware/legacy-contact-methods.interface";
 import PagingInterface from '../interface/middleware/paging.interface';
 import ProcessorInterface from '../interface/middleware/processor.interface';
 import ChatClient from './chat.client';
-import { HttpClient } from './http.client';
 var MiddlewareClient = /** @class */ (function () {
     function MiddlewareClient() {
-        // this.contactExpanded = new ContactExpandedInterface();
-        // this.legacyContact = new ContactInterface();
         this.paging = new PagingInterface();
         this.processor = new ProcessorInterface();
         this.entryInterface = new EntryInterface();
@@ -28,14 +23,10 @@ var MiddlewareClient = /** @class */ (function () {
     };
     // called on situations such as paging changes
     // when no new entries will be printed
-    MiddlewareClient.prototype.handleUpdate = function (input, endpoint) {
-        var _this = this;
-        var httpClient = new HttpClient(endpoint);
-        httpClient.handleUpdate(input).then(function (entries) {
-            var o = _this.executeMiddlewares(entries, true, input);
-            var messageArray = _this.entryInterface.transformArray(o);
-            _this.chatClient.updateMessageArrayAndStoreIt(messageArray);
-        });
+    MiddlewareClient.prototype.handleUpdate = function (entries, action) {
+        var o = this.executeMiddlewares(entries, true, action);
+        var messageArray = this.entryInterface.transformArray(o);
+        this.chatClient.updateMessageArrayAndStoreIt(messageArray);
     };
     // checks whether the action was of an update type
     MiddlewareClient.prototype.checkForUpdate = function (input) {

package/lib-esm/plugin.js

@@ -53,12 +53,13 @@ var __read = (this && this.__read) || function (o, n) {
 import { ComponentPlatform } from '@telia-ace/knowledge-widget-core';
 import { DataClient } from '@telia-ace/knowledge-widget-types-grid';
 import { ConversationPlatform, registerCustomMessageComponent, } from '@telia-ace/widget-conversation';
+import { v4 } from 'uuid';
 import ChatClient from './client/chat.client';
 import { ContactMethodClient } from './client/contact-method.client';
 import { HttpClient } from './client/http.client';
 import MiddlewareClient from './client/middleware.client';
 var ConversationPlugin = function (container) { return __awaiter(void 0, void 0, void 0, function () {
-    var platform, contactMethodPlatform, dataClient, compPlatform, _a, component, endpoint;
+    var platform, contactMethodPlatform, dataClient, compPlatform, clientId, _a, component, endpoint;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0: return [4 /*yield*/, ConversationPlatform.getInstance(container)];
@@ -73,6 +74,7 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                 return [4 /*yield*/, ComponentPlatform.getInstance(container)];
             case 4:
                 compPlatform = _b.sent();
+                clientId = v4();
                 _a = __read(compPlatform.nodes.query({ type: 'conversation' }), 1), component = _a[0];
                 endpoint = '';
                 setTimeout(function () {
@@ -91,7 +93,7 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                     // passes the container and the widget to the Middleware Store
                     MiddlewareClient.initialize(container, container.get('$widget'));
                     // executes to decide on what to do on first load
-                    var httpClient = new HttpClient(endpoint);
+                    var httpClient = new HttpClient(endpoint, clientId);
                     httpClient.firstHit();
                     component.actions.create('evaluate', function (input) {
                         var cmClient = new ContactMethodClient();
@@ -109,7 +111,7 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                         return next(input);
                     });
                     component.actions.watch('conversation.user-submit', function (input, next) {
-                        var httpClient = new HttpClient(endpoint);
+                        var httpClient = new HttpClient(endpoint, clientId);
                         httpClient.handlePhrase(input.text);
                         return next(input);
                     });
@@ -124,14 +126,14 @@ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0,
                             return next(input);
                         }
                         var middlewareClient = new MiddlewareClient();
+                        var httpClient = new HttpClient(endpoint, clientId);
                         // this is an update check, as it requires
                         // a lot different logic and no user message
                         if (middlewareClient.checkForUpdate(input)) {
-                            middlewareClient.handleUpdate(input, endpoint);
+                            httpClient.handleUpdate(input);
                             return next(input);
                         }
                         chatClient.printUserMessageAndStoreIt(input);
-                        var httpClient = new HttpClient(endpoint);
                         httpClient.handleInput(input);
                         return next(input);
                     });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@telia-ace/knowledge-widget-bot-provider",
-    "version": "0.0.1-alpha.6",
+    "version": "0.0.1-alpha.7",
     "description": "Bot Provider Plugin ACE Knowledge Widgets.",
     "license": "SEE LICENSE IN LICENSE.txt",
     "author": "Telia Company AB",