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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/lib/client/chat.client.d.ts +15 -0
  2. package/lib/client/chat.client.js +80 -0
  3. package/lib/client/contact-method.client.d.ts +22 -0
  4. package/lib/client/contact-method.client.js +276 -0
  5. package/lib/client/http.client.d.ts +22 -0
  6. package/lib/client/http.client.js +114 -0
  7. package/lib/client/middleware.client.d.ts +13 -0
  8. package/lib/client/middleware.client.js +60 -0
  9. package/lib/contract/custom-component/contact-method-item.d.ts +8 -0
  10. package/lib/contract/custom-component/contact-method-item.js +76 -0
  11. package/lib/contract/custom-component/contact-method-list.d.ts +7 -0
  12. package/lib/contract/custom-component/contact-method-list.js +41 -0
  13. package/lib/contract/custom-component/contact-method.d.ts +3 -0
  14. package/lib/contract/custom-component/contact-method.js +38 -0
  15. package/lib/contract/enum/server-entry-type.enum.d.ts +6 -0
  16. package/lib/contract/enum/server-entry-type.enum.js +10 -0
  17. package/lib/contract/model/conversation-api-model/list.model.d.ts +5 -0
  18. package/lib/contract/model/conversation-api-model/list.model.js +2 -0
  19. package/lib/contract/model/conversation-api-model/message.model.d.ts +7 -0
  20. package/lib/contract/model/conversation-api-model/message.model.js +2 -0
  21. package/lib/contract/model/http/action.model.d.ts +3 -0
  22. package/lib/contract/model/http/action.model.js +2 -0
  23. package/lib/contract/model/http/client-action.model.d.ts +4 -0
  24. package/lib/contract/model/http/client-action.model.js +3 -0
  25. package/lib/contract/model/http/client-envelope.model.d.ts +9 -0
  26. package/lib/contract/model/http/client-envelope.model.js +2 -0
  27. package/lib/contract/model/http/connect-options.model.d.ts +5 -0
  28. package/lib/contract/model/http/connect-options.model.js +2 -0
  29. package/lib/contract/model/http/global-state.model.d.ts +8 -0
  30. package/lib/contract/model/http/global-state.model.js +2 -0
  31. package/lib/contract/model/http/http-client-options.model.d.ts +5 -0
  32. package/lib/contract/model/http/http-client-options.model.js +2 -0
  33. package/lib/contract/model/http/server-entry.model.d.ts +11 -0
  34. package/lib/contract/model/http/server-entry.model.js +2 -0
  35. package/lib/contract/model/http/server-envelope.model.d.ts +10 -0
  36. package/lib/contract/model/http/server-envelope.model.js +2 -0
  37. package/lib/contract/model/middleware/aggregator-state.model.d.ts +4 -0
  38. package/lib/contract/model/middleware/aggregator-state.model.js +3 -0
  39. package/lib/contract/model/shared/loose-object.model.d.ts +3 -0
  40. package/lib/contract/model/shared/loose-object.model.js +2 -0
  41. package/lib/helper/chat.helper.d.ts +8 -0
  42. package/lib/helper/chat.helper.js +21 -0
  43. package/lib/helper/http.helper.d.ts +13 -0
  44. package/lib/helper/http.helper.js +33 -0
  45. package/lib/helper/middleware.helper.d.ts +12 -0
  46. package/lib/helper/middleware.helper.js +72 -0
  47. package/lib/helper/store.helper.d.ts +22 -0
  48. package/lib/helper/store.helper.js +80 -0
  49. package/lib/index.d.ts +2 -0
  50. package/lib/index.js +8 -0
  51. package/lib/interface/entry.interface.d.ts +17 -0
  52. package/lib/interface/entry.interface.js +138 -0
  53. package/lib/interface/middleware/contact-expanded.interface.d.ts +0 -0
  54. package/lib/interface/middleware/contact-expanded.interface.js +50 -0
  55. package/lib/interface/middleware/legacy-contact-methods.interface.d.ts +0 -0
  56. package/lib/interface/middleware/legacy-contact-methods.interface.js +394 -0
  57. package/lib/interface/middleware/paging.interface.d.ts +4 -0
  58. package/lib/interface/middleware/paging.interface.js +55 -0
  59. package/lib/interface/middleware/processor.interface.d.ts +10 -0
  60. package/lib/interface/middleware/processor.interface.js +120 -0
  61. package/lib/plugin.d.ts +3 -0
  62. package/lib/plugin.js +172 -0
  63. package/lib-esm/client/chat.client.d.ts +15 -0
  64. package/lib-esm/client/chat.client.js +75 -0
  65. package/lib-esm/client/contact-method.client.d.ts +22 -0
  66. package/lib-esm/client/contact-method.client.js +270 -0
  67. package/lib-esm/client/http.client.d.ts +22 -0
  68. package/lib-esm/client/http.client.js +108 -0
  69. package/lib-esm/client/middleware.client.d.ts +13 -0
  70. package/lib-esm/client/middleware.client.js +55 -0
  71. package/lib-esm/contract/custom-component/contact-method-item.d.ts +8 -0
  72. package/lib-esm/contract/custom-component/contact-method-item.js +51 -0
  73. package/lib-esm/contract/custom-component/contact-method-list.d.ts +7 -0
  74. package/lib-esm/contract/custom-component/contact-method-list.js +13 -0
  75. package/lib-esm/contract/custom-component/contact-method.d.ts +3 -0
  76. package/lib-esm/contract/custom-component/contact-method.js +33 -0
  77. package/lib-esm/contract/enum/server-entry-type.enum.d.ts +6 -0
  78. package/lib-esm/contract/enum/server-entry-type.enum.js +7 -0
  79. package/lib-esm/contract/model/conversation-api-model/list.model.d.ts +5 -0
  80. package/lib-esm/contract/model/conversation-api-model/list.model.js +1 -0
  81. package/lib-esm/contract/model/conversation-api-model/message.model.d.ts +7 -0
  82. package/lib-esm/contract/model/conversation-api-model/message.model.js +1 -0
  83. package/lib-esm/contract/model/http/action.model.d.ts +3 -0
  84. package/lib-esm/contract/model/http/action.model.js +1 -0
  85. package/lib-esm/contract/model/http/client-action.model.d.ts +4 -0
  86. package/lib-esm/contract/model/http/client-action.model.js +2 -0
  87. package/lib-esm/contract/model/http/client-envelope.model.d.ts +9 -0
  88. package/lib-esm/contract/model/http/client-envelope.model.js +1 -0
  89. package/lib-esm/contract/model/http/connect-options.model.d.ts +5 -0
  90. package/lib-esm/contract/model/http/connect-options.model.js +1 -0
  91. package/lib-esm/contract/model/http/global-state.model.d.ts +8 -0
  92. package/lib-esm/contract/model/http/global-state.model.js +1 -0
  93. package/lib-esm/contract/model/http/http-client-options.model.d.ts +5 -0
  94. package/lib-esm/contract/model/http/http-client-options.model.js +1 -0
  95. package/lib-esm/contract/model/http/server-entry.model.d.ts +11 -0
  96. package/lib-esm/contract/model/http/server-entry.model.js +1 -0
  97. package/lib-esm/contract/model/http/server-envelope.model.d.ts +10 -0
  98. package/lib-esm/contract/model/http/server-envelope.model.js +1 -0
  99. package/lib-esm/contract/model/middleware/aggregator-state.model.d.ts +4 -0
  100. package/lib-esm/contract/model/middleware/aggregator-state.model.js +2 -0
  101. package/lib-esm/contract/model/shared/loose-object.model.d.ts +3 -0
  102. package/lib-esm/contract/model/shared/loose-object.model.js +1 -0
  103. package/lib-esm/helper/chat.helper.d.ts +8 -0
  104. package/lib-esm/helper/chat.helper.js +18 -0
  105. package/lib-esm/helper/http.helper.d.ts +13 -0
  106. package/lib-esm/helper/http.helper.js +30 -0
  107. package/lib-esm/helper/middleware.helper.d.ts +12 -0
  108. package/lib-esm/helper/middleware.helper.js +69 -0
  109. package/lib-esm/helper/store.helper.d.ts +22 -0
  110. package/lib-esm/helper/store.helper.js +77 -0
  111. package/lib-esm/index.d.ts +2 -0
  112. package/lib-esm/index.js +2 -0
  113. package/lib-esm/interface/entry.interface.d.ts +17 -0
  114. package/lib-esm/interface/entry.interface.js +136 -0
  115. package/lib-esm/interface/middleware/paging.interface.d.ts +4 -0
  116. package/lib-esm/interface/middleware/paging.interface.js +53 -0
  117. package/lib-esm/interface/middleware/processor.interface.d.ts +10 -0
  118. package/lib-esm/interface/middleware/processor.interface.js +118 -0
  119. package/lib-esm/plugin.d.ts +3 -0
  120. package/lib-esm/plugin.js +144 -0
  121. package/package.json +1 -1
@@ -0,0 +1,118 @@
1
+ var ProcessorInterface = /** @class */ (function () {
2
+ function ProcessorInterface() {
3
+ }
4
+ ProcessorInterface.prototype.process = function (entries) {
5
+ var processedEntries = entries;
6
+ processedEntries = this.deletePaging(processedEntries);
7
+ processedEntries = this.delete(processedEntries);
8
+ processedEntries = this.merge(processedEntries);
9
+ processedEntries = this.moveLoader(processedEntries);
10
+ return processedEntries;
11
+ };
12
+ ProcessorInterface.prototype.processUpdate = function (entry, updateEntryArray) {
13
+ var _this = this;
14
+ updateEntryArray
15
+ .filter(function (t) { return t.type == 'List'; })
16
+ .forEach(function (o) {
17
+ var _a;
18
+ (_a = o.content) === null || _a === void 0 ? void 0 : _a.items.forEach(function (t) {
19
+ if (!(entry === null || entry === void 0 ? void 0 : entry.content.items.find(function (p) { return p.actionKey == t.actionKey; })))
20
+ entry === null || entry === void 0 ? void 0 : entry.content.items.push(t);
21
+ });
22
+ Object.keys(o.actions).forEach(function (t) {
23
+ _this.handleActionUpdateOrInsert(entry === null || entry === void 0 ? void 0 : entry.actions, t, o.actions);
24
+ });
25
+ });
26
+ //moves the show more and if it helped to the end if it is needed
27
+ var itemArray = entry === null || entry === void 0 ? void 0 : entry.content.items;
28
+ if (itemArray.find(function (o) { return o.actionKey == 'next'; })) {
29
+ itemArray.push(itemArray.splice(itemArray.indexOf(itemArray.find(function (o) { return o.actionKey == 'next'; })), 1)[0]);
30
+ }
31
+ if (itemArray.find(function (o) { return o.actionKey == 'help'; })) {
32
+ itemArray.push(itemArray.splice(itemArray.indexOf(itemArray.find(function (o) { return o.actionKey == 'help'; })), 1)[0]);
33
+ }
34
+ return entry ? [entry] : [];
35
+ };
36
+ ProcessorInterface.prototype.handleActionUpdateOrInsert = function (currentArray, actionKey, action) {
37
+ if (!!currentArray)
38
+ currentArray[actionKey] = action[actionKey];
39
+ };
40
+ ProcessorInterface.prototype.deletePaging = function (entries) {
41
+ return entries.filter(function (entry) {
42
+ var isEmptyPaging = entry.type === 'List' &&
43
+ entry.tags &&
44
+ entry.tags.indexOf('paging') > -1 &&
45
+ typeof entry.content === 'undefined';
46
+ return !isEmptyPaging;
47
+ });
48
+ };
49
+ ProcessorInterface.prototype.delete = function (entries) {
50
+ return entries.filter(function (entry) { return entry.content !== null; });
51
+ };
52
+ ProcessorInterface.prototype.merge = function (entries) {
53
+ var output = [];
54
+ var merge = function (source, target) {
55
+ if (target === void 0) { target = {}; }
56
+ var content = {};
57
+ if (source == null) {
58
+ return null;
59
+ }
60
+ if (target) {
61
+ Object.keys(target).forEach(function (key) {
62
+ content[key] = target[key];
63
+ });
64
+ }
65
+ Object.keys(source).forEach(function (key) {
66
+ if (key == 'items') {
67
+ if (!content[key])
68
+ content[key] = [];
69
+ content[key] = content[key].concat(source[key]);
70
+ }
71
+ else if (key == 'html')
72
+ content[key] = content[key] + source[key];
73
+ else
74
+ content[key] = source[key];
75
+ });
76
+ return content;
77
+ };
78
+ var mergeLocalState = function (source, target) {
79
+ if (source == null)
80
+ return null;
81
+ if (Object.keys(source.actions).length === 0)
82
+ return target.localState;
83
+ if (Object.keys(target.actions).length === 0)
84
+ return source.localState;
85
+ return target.localState;
86
+ };
87
+ entries.forEach(function (entry) {
88
+ if (entry.relation) {
89
+ var existingEntry = entries.find(function (o) { return o.id == entry.relation; });
90
+ if (existingEntry) {
91
+ var existingIndex = output.indexOf(existingEntry);
92
+ existingEntry.localState = mergeLocalState(entry, existingEntry);
93
+ existingEntry.content = merge(entry.content, existingEntry.content);
94
+ existingEntry.actions = merge(entry.actions, existingEntry.actions);
95
+ output[existingIndex] = existingEntry;
96
+ }
97
+ }
98
+ else {
99
+ output.push(entry);
100
+ }
101
+ });
102
+ return output;
103
+ };
104
+ ProcessorInterface.prototype.moveLoader = function (entries) {
105
+ // Moves the loader component to last position in stream
106
+ var loaderEntry = entries.find(function (e) { return e.id === 'loader'; });
107
+ if (!loaderEntry) {
108
+ return entries;
109
+ }
110
+ var loaderIndex = entries.indexOf(loaderEntry);
111
+ if (loaderIndex > -1) {
112
+ entries.splice(entries.length - 1, 0, entries.splice(loaderIndex, 1)[0]);
113
+ }
114
+ return entries;
115
+ };
116
+ return ProcessorInterface;
117
+ }());
118
+ export default ProcessorInterface;
@@ -0,0 +1,3 @@
1
+ import { Container } from '@webprovisions/platform';
2
+ declare const ConversationPlugin: (container: Container) => Promise<void>;
3
+ export default ConversationPlugin;
@@ -0,0 +1,144 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ var __generator = (this && this.__generator) || function (thisArg, body) {
11
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
12
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
13
+ function verb(n) { return function (v) { return step([n, v]); }; }
14
+ function step(op) {
15
+ if (f) throw new TypeError("Generator is already executing.");
16
+ while (_) try {
17
+ 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;
18
+ if (y = 0, t) op = [op[0] & 2, t.value];
19
+ switch (op[0]) {
20
+ case 0: case 1: t = op; break;
21
+ case 4: _.label++; return { value: op[1], done: false };
22
+ case 5: _.label++; y = op[1]; op = [0]; continue;
23
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
24
+ default:
25
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
26
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
27
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
28
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
29
+ if (t[2]) _.ops.pop();
30
+ _.trys.pop(); continue;
31
+ }
32
+ op = body.call(thisArg, _);
33
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
34
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
35
+ }
36
+ };
37
+ var __read = (this && this.__read) || function (o, n) {
38
+ var m = typeof Symbol === "function" && o[Symbol.iterator];
39
+ if (!m) return o;
40
+ var i = m.call(o), r, ar = [], e;
41
+ try {
42
+ while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
43
+ }
44
+ catch (error) { e = { error: error }; }
45
+ finally {
46
+ try {
47
+ if (r && !r.done && (m = i["return"])) m.call(i);
48
+ }
49
+ finally { if (e) throw e.error; }
50
+ }
51
+ return ar;
52
+ };
53
+ import { ContactMethodPlatform } from '@telia-ace/knowledge-widget-adapters';
54
+ import { ComponentPlatform } from '@telia-ace/knowledge-widget-core';
55
+ import { DataClient } from '@telia-ace/knowledge-widget-types-grid';
56
+ import { ConversationPlatform, registerCustomMessageComponent, } from '@telia-ace/widget-conversation';
57
+ import ChatClient from './client/chat.client';
58
+ import { ContactMethodClient } from './client/contact-method.client';
59
+ import { HttpClient } from './client/http.client';
60
+ import MiddlewareClient from './client/middleware.client';
61
+ var ConversationPlugin = function (container) { return __awaiter(void 0, void 0, void 0, function () {
62
+ var platform, contactMethodPlatform, dataClient, compPlatform, _a, component, endpoint;
63
+ return __generator(this, function (_b) {
64
+ switch (_b.label) {
65
+ case 0: return [4 /*yield*/, ConversationPlatform.getInstance(container)];
66
+ case 1:
67
+ platform = _b.sent();
68
+ return [4 /*yield*/, ContactMethodPlatform.getInstance(container)];
69
+ case 2:
70
+ contactMethodPlatform = _b.sent();
71
+ return [4 /*yield*/, DataClient.getInstance(container)];
72
+ case 3:
73
+ dataClient = _b.sent();
74
+ return [4 /*yield*/, ComponentPlatform.getInstance(container)];
75
+ case 4:
76
+ compPlatform = _b.sent();
77
+ _a = __read(compPlatform.nodes.query({ type: 'conversation' }), 1), component = _a[0];
78
+ endpoint = '';
79
+ setTimeout(function () {
80
+ endpoint = component.attributes.properties.knowledgeBotEndpoint;
81
+ });
82
+ platform.registerProvider('chat.bot', function (conversation, component) {
83
+ registerCustomMessageComponent(container, 'ace-knowledge-contact-method', import('./contract/custom-component/contact-method'));
84
+ var agent = conversation.createAgent({
85
+ name: 'John Doe',
86
+ avatar: 'https://www.site.com/avatar.jpg',
87
+ });
88
+ // pases the user and the agent to the Chat Helper
89
+ ChatClient.initialize(conversation.user, agent);
90
+ // passes the conversation provider to the Contact Method Client
91
+ ContactMethodClient.initialize(dataClient, contactMethodPlatform, agent);
92
+ // passes the container and the widget to the Middleware Store
93
+ MiddlewareClient.initialize(container, container.get('$widget'));
94
+ // executes to decide on what to do on first load
95
+ var httpClient = new HttpClient(endpoint);
96
+ httpClient.firstHit();
97
+ component.actions.create('evaluate', function (input) {
98
+ var cmClient = new ContactMethodClient();
99
+ cmClient.handleNewForm(input.form, input.form.id);
100
+ });
101
+ component.actions.create('validate', function (input) {
102
+ var cmClient = new ContactMethodClient();
103
+ cmClient.validate(input.form);
104
+ });
105
+ component.actions.create('submit', function (input) {
106
+ var cmClient = new ContactMethodClient();
107
+ cmClient.validate(input.form);
108
+ });
109
+ component.actions.watch('conversation.user-typing', function (input, next) {
110
+ return next(input);
111
+ });
112
+ component.actions.watch('conversation.user-submit', function (input, next) {
113
+ var httpClient = new HttpClient(endpoint);
114
+ httpClient.handlePhrase(input.text);
115
+ return next(input);
116
+ });
117
+ component.actions.watch('conversation.form', function (input, next) {
118
+ return next(input);
119
+ });
120
+ component.actions.watch('conversation.action', function (input, next) {
121
+ var chatClient = new ChatClient();
122
+ var cmClient = new ContactMethodClient();
123
+ if (input === 'contact' || input.split('/').length > 1) {
124
+ cmClient.handleContactMethod(input);
125
+ return next(input);
126
+ }
127
+ var middlewareClient = new MiddlewareClient();
128
+ // this is an update check, as it requires
129
+ // a lot different logic and no user message
130
+ if (middlewareClient.checkForUpdate(input)) {
131
+ middlewareClient.handleUpdate(input, endpoint);
132
+ return next(input);
133
+ }
134
+ chatClient.printUserMessageAndStoreIt(input);
135
+ var httpClient = new HttpClient(endpoint);
136
+ httpClient.handleInput(input);
137
+ return next(input);
138
+ });
139
+ });
140
+ return [2 /*return*/];
141
+ }
142
+ });
143
+ }); };
144
+ export default ConversationPlugin;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@telia-ace/knowledge-widget-bot-provider",
3
- "version": "0.0.1-alpha.2",
3
+ "version": "0.0.1-alpha.5",
4
4
  "description": "Bot Provider Plugin ACE Knowledge Widgets.",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "author": "Telia Company AB",