@botonic/plugin-hubtype-analytics 0.26.0 → 0.27.0-alpha.1

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 (177) hide show
  1. package/README.md +38 -5
  2. package/lib/cjs/event-models/ht-event-custom.d.ts +11 -0
  3. package/lib/cjs/event-models/ht-event-custom.js +14 -0
  4. package/lib/cjs/event-models/ht-event-custom.js.map +1 -0
  5. package/lib/cjs/event-models/ht-event-fallback.d.ts +12 -0
  6. package/lib/cjs/event-models/ht-event-fallback.js +15 -0
  7. package/lib/cjs/event-models/ht-event-fallback.js.map +1 -0
  8. package/lib/cjs/event-models/ht-event-feedback.d.ts +17 -0
  9. package/lib/cjs/event-models/ht-event-feedback.js +20 -0
  10. package/lib/cjs/event-models/ht-event-feedback.js.map +1 -0
  11. package/lib/cjs/event-models/ht-event-flow.d.ts +16 -0
  12. package/lib/cjs/event-models/ht-event-flow.js +19 -0
  13. package/lib/cjs/event-models/ht-event-flow.js.map +1 -0
  14. package/lib/cjs/event-models/ht-event-handoff.d.ts +16 -0
  15. package/lib/cjs/event-models/ht-event-handoff.js +19 -0
  16. package/lib/cjs/event-models/ht-event-handoff.js.map +1 -0
  17. package/lib/cjs/event-models/ht-event-intent-smart.d.ts +13 -0
  18. package/lib/cjs/event-models/ht-event-intent-smart.js +16 -0
  19. package/lib/cjs/event-models/ht-event-intent-smart.js.map +1 -0
  20. package/lib/cjs/event-models/ht-event-intent.d.ts +14 -0
  21. package/lib/cjs/event-models/ht-event-intent.js +17 -0
  22. package/lib/cjs/event-models/ht-event-intent.js.map +1 -0
  23. package/lib/cjs/event-models/ht-event-keyword.d.ts +14 -0
  24. package/lib/cjs/event-models/ht-event-keyword.js +17 -0
  25. package/lib/cjs/event-models/ht-event-keyword.js.map +1 -0
  26. package/lib/cjs/event-models/ht-event-knowledge-base.d.ts +15 -0
  27. package/lib/cjs/event-models/ht-event-knowledge-base.js +18 -0
  28. package/lib/cjs/event-models/ht-event-knowledge-base.js.map +1 -0
  29. package/lib/cjs/event-models/ht-event-webview.d.ts +15 -0
  30. package/lib/cjs/event-models/ht-event-webview.js +18 -0
  31. package/lib/cjs/event-models/ht-event-webview.js.map +1 -0
  32. package/lib/cjs/event-models/ht-event.d.ts +11 -4
  33. package/lib/cjs/event-models/ht-event.js +6 -10
  34. package/lib/cjs/event-models/ht-event.js.map +1 -1
  35. package/lib/cjs/event-models/index.d.ts +11 -0
  36. package/lib/cjs/event-models/index.js +26 -0
  37. package/lib/cjs/event-models/index.js.map +1 -0
  38. package/lib/cjs/index.d.ts +3 -2
  39. package/lib/cjs/index.js +12 -6
  40. package/lib/cjs/index.js.map +1 -1
  41. package/lib/cjs/types.d.ts +125 -115
  42. package/lib/cjs/types.js +31 -18
  43. package/lib/cjs/types.js.map +1 -1
  44. package/lib/cjs/utils.d.ts +1 -1
  45. package/lib/cjs/utils.js +29 -33
  46. package/lib/cjs/utils.js.map +1 -1
  47. package/lib/esm/event-models/ht-event-custom.d.ts +11 -0
  48. package/lib/esm/event-models/ht-event-custom.js +10 -0
  49. package/lib/esm/event-models/ht-event-custom.js.map +1 -0
  50. package/lib/esm/event-models/ht-event-fallback.d.ts +12 -0
  51. package/lib/esm/event-models/ht-event-fallback.js +11 -0
  52. package/lib/esm/event-models/ht-event-fallback.js.map +1 -0
  53. package/lib/esm/event-models/ht-event-feedback.d.ts +17 -0
  54. package/lib/esm/event-models/ht-event-feedback.js +16 -0
  55. package/lib/esm/event-models/ht-event-feedback.js.map +1 -0
  56. package/lib/esm/event-models/ht-event-flow.d.ts +16 -0
  57. package/lib/esm/event-models/ht-event-flow.js +15 -0
  58. package/lib/esm/event-models/ht-event-flow.js.map +1 -0
  59. package/lib/esm/event-models/ht-event-handoff.d.ts +16 -0
  60. package/lib/esm/event-models/ht-event-handoff.js +15 -0
  61. package/lib/esm/event-models/ht-event-handoff.js.map +1 -0
  62. package/lib/esm/event-models/ht-event-intent-smart.d.ts +13 -0
  63. package/lib/esm/event-models/ht-event-intent-smart.js +12 -0
  64. package/lib/esm/event-models/ht-event-intent-smart.js.map +1 -0
  65. package/lib/esm/event-models/ht-event-intent.d.ts +14 -0
  66. package/lib/esm/event-models/ht-event-intent.js +13 -0
  67. package/lib/esm/event-models/ht-event-intent.js.map +1 -0
  68. package/lib/esm/event-models/ht-event-keyword.d.ts +14 -0
  69. package/lib/esm/event-models/ht-event-keyword.js +13 -0
  70. package/lib/esm/event-models/ht-event-keyword.js.map +1 -0
  71. package/lib/esm/event-models/ht-event-knowledge-base.d.ts +15 -0
  72. package/lib/esm/event-models/ht-event-knowledge-base.js +14 -0
  73. package/lib/esm/event-models/ht-event-knowledge-base.js.map +1 -0
  74. package/lib/esm/event-models/ht-event-webview.d.ts +15 -0
  75. package/lib/esm/event-models/ht-event-webview.js +14 -0
  76. package/lib/esm/event-models/ht-event-webview.js.map +1 -0
  77. package/lib/esm/event-models/ht-event.d.ts +11 -4
  78. package/lib/esm/event-models/ht-event.js +6 -10
  79. package/lib/esm/event-models/ht-event.js.map +1 -1
  80. package/lib/esm/event-models/index.d.ts +11 -0
  81. package/lib/esm/event-models/index.js +12 -0
  82. package/lib/esm/event-models/index.js.map +1 -0
  83. package/lib/esm/index.d.ts +3 -2
  84. package/lib/esm/index.js +12 -6
  85. package/lib/esm/index.js.map +1 -1
  86. package/lib/esm/types.d.ts +125 -115
  87. package/lib/esm/types.js +30 -17
  88. package/lib/esm/types.js.map +1 -1
  89. package/lib/esm/utils.d.ts +1 -1
  90. package/lib/esm/utils.js +29 -33
  91. package/lib/esm/utils.js.map +1 -1
  92. package/package.json +4 -4
  93. package/src/event-models/ht-event-custom.ts +17 -0
  94. package/src/event-models/ht-event-fallback.ts +19 -0
  95. package/src/event-models/ht-event-feedback.ts +33 -0
  96. package/src/event-models/ht-event-flow.ts +27 -0
  97. package/src/event-models/ht-event-handoff.ts +30 -0
  98. package/src/event-models/ht-event-intent-smart.ts +21 -0
  99. package/src/event-models/ht-event-intent.ts +23 -0
  100. package/src/event-models/ht-event-keyword.ts +23 -0
  101. package/src/event-models/ht-event-knowledge-base.ts +30 -0
  102. package/src/event-models/ht-event-webview.ts +25 -0
  103. package/src/event-models/ht-event.ts +17 -14
  104. package/src/event-models/index.ts +11 -0
  105. package/src/index.ts +14 -5
  106. package/src/types.ts +128 -113
  107. package/src/utils.ts +41 -33
  108. package/lib/cjs/event-models/ht-event-agent-rating.d.ts +0 -6
  109. package/lib/cjs/event-models/ht-event-agent-rating.js +0 -14
  110. package/lib/cjs/event-models/ht-event-agent-rating.js.map +0 -1
  111. package/lib/cjs/event-models/ht-event-bot-ai-model.d.ts +0 -6
  112. package/lib/cjs/event-models/ht-event-bot-ai-model.js +0 -15
  113. package/lib/cjs/event-models/ht-event-bot-ai-model.js.map +0 -1
  114. package/lib/cjs/event-models/ht-event-bot-faq.d.ts +0 -6
  115. package/lib/cjs/event-models/ht-event-bot-faq.js +0 -12
  116. package/lib/cjs/event-models/ht-event-bot-faq.js.map +0 -1
  117. package/lib/cjs/event-models/ht-event-bot-keyword-model.d.ts +0 -6
  118. package/lib/cjs/event-models/ht-event-bot-keyword-model.js +0 -13
  119. package/lib/cjs/event-models/ht-event-bot-keyword-model.js.map +0 -1
  120. package/lib/cjs/event-models/ht-event-bot-knowledge-base.d.ts +0 -6
  121. package/lib/cjs/event-models/ht-event-bot-knowledge-base.js +0 -13
  122. package/lib/cjs/event-models/ht-event-bot-knowledge-base.js.map +0 -1
  123. package/lib/cjs/event-models/ht-event-bot-rating.d.ts +0 -6
  124. package/lib/cjs/event-models/ht-event-bot-rating.js +0 -14
  125. package/lib/cjs/event-models/ht-event-bot-rating.js.map +0 -1
  126. package/lib/cjs/event-models/ht-event-channel-rating.d.ts +0 -6
  127. package/lib/cjs/event-models/ht-event-channel-rating.js +0 -12
  128. package/lib/cjs/event-models/ht-event-channel-rating.js.map +0 -1
  129. package/lib/cjs/event-models/ht-event-faq-useful.d.ts +0 -6
  130. package/lib/cjs/event-models/ht-event-faq-useful.js +0 -13
  131. package/lib/cjs/event-models/ht-event-faq-useful.js.map +0 -1
  132. package/lib/cjs/event-models/ht-event-handoff-fail.d.ts +0 -6
  133. package/lib/cjs/event-models/ht-event-handoff-fail.js +0 -15
  134. package/lib/cjs/event-models/ht-event-handoff-fail.js.map +0 -1
  135. package/lib/cjs/event-models/ht-event-handoff-success.d.ts +0 -6
  136. package/lib/cjs/event-models/ht-event-handoff-success.js +0 -15
  137. package/lib/cjs/event-models/ht-event-handoff-success.js.map +0 -1
  138. package/lib/esm/event-models/ht-event-agent-rating.d.ts +0 -6
  139. package/lib/esm/event-models/ht-event-agent-rating.js +0 -10
  140. package/lib/esm/event-models/ht-event-agent-rating.js.map +0 -1
  141. package/lib/esm/event-models/ht-event-bot-ai-model.d.ts +0 -6
  142. package/lib/esm/event-models/ht-event-bot-ai-model.js +0 -11
  143. package/lib/esm/event-models/ht-event-bot-ai-model.js.map +0 -1
  144. package/lib/esm/event-models/ht-event-bot-faq.d.ts +0 -6
  145. package/lib/esm/event-models/ht-event-bot-faq.js +0 -8
  146. package/lib/esm/event-models/ht-event-bot-faq.js.map +0 -1
  147. package/lib/esm/event-models/ht-event-bot-keyword-model.d.ts +0 -6
  148. package/lib/esm/event-models/ht-event-bot-keyword-model.js +0 -9
  149. package/lib/esm/event-models/ht-event-bot-keyword-model.js.map +0 -1
  150. package/lib/esm/event-models/ht-event-bot-knowledge-base.d.ts +0 -6
  151. package/lib/esm/event-models/ht-event-bot-knowledge-base.js +0 -9
  152. package/lib/esm/event-models/ht-event-bot-knowledge-base.js.map +0 -1
  153. package/lib/esm/event-models/ht-event-bot-rating.d.ts +0 -6
  154. package/lib/esm/event-models/ht-event-bot-rating.js +0 -10
  155. package/lib/esm/event-models/ht-event-bot-rating.js.map +0 -1
  156. package/lib/esm/event-models/ht-event-channel-rating.d.ts +0 -6
  157. package/lib/esm/event-models/ht-event-channel-rating.js +0 -8
  158. package/lib/esm/event-models/ht-event-channel-rating.js.map +0 -1
  159. package/lib/esm/event-models/ht-event-faq-useful.d.ts +0 -6
  160. package/lib/esm/event-models/ht-event-faq-useful.js +0 -9
  161. package/lib/esm/event-models/ht-event-faq-useful.js.map +0 -1
  162. package/lib/esm/event-models/ht-event-handoff-fail.d.ts +0 -6
  163. package/lib/esm/event-models/ht-event-handoff-fail.js +0 -11
  164. package/lib/esm/event-models/ht-event-handoff-fail.js.map +0 -1
  165. package/lib/esm/event-models/ht-event-handoff-success.d.ts +0 -6
  166. package/lib/esm/event-models/ht-event-handoff-success.js +0 -11
  167. package/lib/esm/event-models/ht-event-handoff-success.js.map +0 -1
  168. package/src/event-models/ht-event-agent-rating.ts +0 -18
  169. package/src/event-models/ht-event-bot-ai-model.ts +0 -19
  170. package/src/event-models/ht-event-bot-faq.ts +0 -16
  171. package/src/event-models/ht-event-bot-keyword-model.ts +0 -17
  172. package/src/event-models/ht-event-bot-knowledge-base.ts +0 -17
  173. package/src/event-models/ht-event-bot-rating.ts +0 -18
  174. package/src/event-models/ht-event-channel-rating.ts +0 -16
  175. package/src/event-models/ht-event-faq-useful.ts +0 -17
  176. package/src/event-models/ht-event-handoff-fail.ts +0 -19
  177. package/src/event-models/ht-event-handoff-success.ts +0 -19
@@ -0,0 +1,14 @@
1
+ import { EventAction, EventIntent, RequestData } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ interface EventDataIntent {
4
+ action: EventAction.Intent;
5
+ nlu_intent_label: string;
6
+ nlu_intent_confidence: number;
7
+ nlu_intent_threshold: number;
8
+ nlu_intent_message_id: string;
9
+ }
10
+ export declare class HtEventIntent extends HtEvent {
11
+ data: EventDataIntent;
12
+ constructor(event: EventIntent, requestData: RequestData);
13
+ }
14
+ export {};
@@ -0,0 +1,13 @@
1
+ import { EventType } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ export class HtEventIntent extends HtEvent {
4
+ constructor(event, requestData) {
5
+ super(event, requestData);
6
+ this.type = EventType.Botevent;
7
+ this.data.nlu_intent_label = event.data.nluIntentLabel;
8
+ this.data.nlu_intent_confidence = event.data.nluIntentConfidence;
9
+ this.data.nlu_intent_threshold = event.data.nluIntentThreshold;
10
+ this.data.nlu_intent_message_id = event.data.nluIntentMessageId;
11
+ }
12
+ }
13
+ //# sourceMappingURL=ht-event-intent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ht-event-intent.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-intent.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,SAAS,EAAe,MAAM,UAAU,CAAA;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAUpC,MAAM,OAAO,aAAc,SAAQ,OAAO;IAGxC,YAAY,KAAkB,EAAE,WAAwB;QACtD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAA;QACtD,IAAI,CAAC,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAA;QAChE,IAAI,CAAC,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAA;QAC9D,IAAI,CAAC,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAA;IACjE,CAAC;CACF"}
@@ -0,0 +1,14 @@
1
+ import { EventAction, EventKeyword, RequestData } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ interface EventDataKeyword {
4
+ action: EventAction.Keyword;
5
+ nlu_keyword_id: string;
6
+ nlu_keyword_name: string;
7
+ nlu_keyword_is_regex: boolean;
8
+ nlu_keyword_message_id: string;
9
+ }
10
+ export declare class HtEventKeyword extends HtEvent {
11
+ data: EventDataKeyword;
12
+ constructor(event: EventKeyword, requestData: RequestData);
13
+ }
14
+ export {};
@@ -0,0 +1,13 @@
1
+ import { EventType } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ export class HtEventKeyword extends HtEvent {
4
+ constructor(event, requestData) {
5
+ super(event, requestData);
6
+ this.type = EventType.Botevent;
7
+ this.data.nlu_keyword_id = event.data.nluKeywordId;
8
+ this.data.nlu_keyword_name = event.data.nluKeywordName;
9
+ this.data.nlu_keyword_is_regex = event.data.nluKeywordIsRegex || false;
10
+ this.data.nlu_keyword_message_id = event.data.nluKeywordMessageId;
11
+ }
12
+ }
13
+ //# sourceMappingURL=ht-event-keyword.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ht-event-keyword.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-keyword.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,SAAS,EAAe,MAAM,UAAU,CAAA;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAUpC,MAAM,OAAO,cAAe,SAAQ,OAAO;IAGzC,YAAY,KAAmB,EAAE,WAAwB;QACvD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAA;QAClD,IAAI,CAAC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAA;QACtD,IAAI,CAAC,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,KAAK,CAAA;QACtE,IAAI,CAAC,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAA;IACnE,CAAC;CACF"}
@@ -0,0 +1,15 @@
1
+ import { EventAction, EventKnowledgeBase, RequestData } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ interface EventDataKnowledgeBase {
4
+ action: EventAction.Knowledgebase;
5
+ knowledgebase_inference_id: string;
6
+ knowledgebase_fail_reason?: string;
7
+ knowledgebase_sources_ids: string[];
8
+ knowledgebase_chunks_ids: string[];
9
+ knowledgebase_message_id: string;
10
+ }
11
+ export declare class HtEventKnowledgeBase extends HtEvent {
12
+ data: EventDataKnowledgeBase;
13
+ constructor(event: EventKnowledgeBase, requestData: RequestData);
14
+ }
15
+ export {};
@@ -0,0 +1,14 @@
1
+ import { EventType, } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ export class HtEventKnowledgeBase extends HtEvent {
4
+ constructor(event, requestData) {
5
+ super(event, requestData);
6
+ this.type = EventType.Botevent;
7
+ this.data.knowledgebase_inference_id = event.data.knowledgebaseInferenceId;
8
+ this.data.knowledgebase_fail_reason = event.data.knowledgebaseFailReason;
9
+ this.data.knowledgebase_sources_ids = event.data.knowledgebaseSourcesIds;
10
+ this.data.knowledgebase_chunks_ids = event.data.knowledgebaseChunksIds;
11
+ this.data.knowledgebase_message_id = event.data.knowledgebaseMessageId;
12
+ }
13
+ }
14
+ //# sourceMappingURL=ht-event-knowledge-base.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ht-event-knowledge-base.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-knowledge-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,SAAS,GAEV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAWpC,MAAM,OAAO,oBAAqB,SAAQ,OAAO;IAG/C,YAAY,KAAyB,EAAE,WAAwB;QAC7D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAA;QAC1E,IAAI,CAAC,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAA;QACxE,IAAI,CAAC,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAA;QACxE,IAAI,CAAC,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAA;QACtE,IAAI,CAAC,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAA;IACxE,CAAC;CACF"}
@@ -0,0 +1,15 @@
1
+ import { EventAction, EventWebview, RequestData } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ interface EventDataWebview {
4
+ action: EventAction.WebviewStep | EventAction.WebviewEnd;
5
+ webview_thread_id: string;
6
+ webview_name: string;
7
+ webview_step_name?: string;
8
+ webview_end_fail_type?: string;
9
+ webview_end_fail_message?: string;
10
+ }
11
+ export declare class HtEventWebview extends HtEvent {
12
+ data: EventDataWebview;
13
+ constructor(event: EventWebview, requestData: RequestData);
14
+ }
15
+ export {};
@@ -0,0 +1,14 @@
1
+ import { EventType } from '../types';
2
+ import { HtEvent } from './ht-event';
3
+ export class HtEventWebview extends HtEvent {
4
+ constructor(event, requestData) {
5
+ super(event, requestData);
6
+ this.type = EventType.Webevent;
7
+ this.data.webview_thread_id = event.data.webviewThreadId;
8
+ this.data.webview_name = event.data.webviewName;
9
+ this.data.webview_step_name = event.data.webviewStepName;
10
+ this.data.webview_end_fail_type = event.data.webviewEndFailType;
11
+ this.data.webview_end_fail_message = event.data.webviewEndFailMessage;
12
+ }
13
+ }
14
+ //# sourceMappingURL=ht-event-webview.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ht-event-webview.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-webview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,SAAS,EAA6B,MAAM,UAAU,CAAA;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAWpC,MAAM,OAAO,cAAe,SAAQ,OAAO;IAGzC,YAAY,KAAmB,EAAE,WAAwB;QACvD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAA;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAA;QAC/C,IAAI,CAAC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAA;QACxD,IAAI,CAAC,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAA;QAC/D,IAAI,CAAC,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAA;IACvE,CAAC;CACF"}
@@ -1,7 +1,14 @@
1
- import { BaseEventData, EventName, HtEventProps, RequestData } from '../types';
1
+ import { EventType, HtEventProps, RequestData } from '../types';
2
2
  export declare class HtEvent {
3
- chat: string;
4
- event_type: EventName;
5
- event_data: BaseEventData;
3
+ chat_id: string;
4
+ type: EventType;
5
+ channel: string;
6
+ created_at: string;
7
+ chat_language: string;
8
+ chat_country?: string;
9
+ format_version?: number;
10
+ bot_version?: string;
11
+ flow_version?: string;
12
+ data: any;
6
13
  constructor(event: HtEventProps, requestData: RequestData);
7
14
  }
@@ -1,15 +1,11 @@
1
1
  export class HtEvent {
2
2
  constructor(event, requestData) {
3
- this.chat = requestData.userId;
4
- this.event_type = event.event_type;
5
- this.event_data = {
6
- channel: requestData.provider,
7
- event_datetime: new Date().toISOString(),
8
- enduser_language: requestData.language,
9
- enduser_country: requestData.country,
10
- format_version: 1,
11
- // flow_version?: string
12
- };
3
+ this.chat_id = requestData.userId;
4
+ this.chat_language = requestData.language;
5
+ this.chat_country = requestData.country;
6
+ this.format_version = 2;
7
+ this.data = {};
8
+ this.data.action = event.action;
13
9
  }
14
10
  }
15
11
  //# sourceMappingURL=ht-event.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ht-event.js","sourceRoot":"","sources":["../../../src/event-models/ht-event.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,OAAO;IAKlB,YAAY,KAAmB,EAAE,WAAwB;QACvD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,MAAM,CAAA;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG;YAChB,OAAO,EAAE,WAAW,CAAC,QAAQ;YAC7B,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACxC,gBAAgB,EAAE,WAAW,CAAC,QAAQ;YACtC,eAAe,EAAE,WAAW,CAAC,OAAO;YACpC,cAAc,EAAE,CAAC;YACjB,wBAAwB;SACzB,CAAA;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"ht-event.js","sourceRoot":"","sources":["../../../src/event-models/ht-event.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,OAAO;IAYlB,YAAY,KAAmB,EAAE,WAAwB;QACvD,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,MAAM,CAAA;QACjC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,QAAQ,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,OAAO,CAAA;QACvC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QACd,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;IACjC,CAAC;CACF"}
@@ -0,0 +1,11 @@
1
+ export { HtEvent } from './ht-event';
2
+ export { HtEventCustom } from './ht-event-custom';
3
+ export { HtEventFallback } from './ht-event-fallback';
4
+ export { HtEventFeedback } from './ht-event-feedback';
5
+ export { HtEventFlow } from './ht-event-flow';
6
+ export { HtEventHandoff } from './ht-event-handoff';
7
+ export { HtEventIntent } from './ht-event-intent';
8
+ export { HtEventIntentSmart } from './ht-event-intent-smart';
9
+ export { HtEventKeyword } from './ht-event-keyword';
10
+ export { HtEventKnowledgeBase } from './ht-event-knowledge-base';
11
+ export { HtEventWebview } from './ht-event-webview';
@@ -0,0 +1,12 @@
1
+ export { HtEvent } from './ht-event';
2
+ export { HtEventCustom } from './ht-event-custom';
3
+ export { HtEventFallback } from './ht-event-fallback';
4
+ export { HtEventFeedback } from './ht-event-feedback';
5
+ export { HtEventFlow } from './ht-event-flow';
6
+ export { HtEventHandoff } from './ht-event-handoff';
7
+ export { HtEventIntent } from './ht-event-intent';
8
+ export { HtEventIntentSmart } from './ht-event-intent-smart';
9
+ export { HtEventKeyword } from './ht-event-keyword';
10
+ export { HtEventKnowledgeBase } from './ht-event-knowledge-base';
11
+ export { HtEventWebview } from './ht-event-webview';
12
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/event-models/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA"}
@@ -1,6 +1,6 @@
1
1
  import { BotRequest, Plugin } from '@botonic/core';
2
2
  import axios from 'axios';
3
- import { HtEventProps, RequestData } from './types';
3
+ import { EventType, HtEventProps, RequestData } from './types';
4
4
  export interface HubtypeAnalyticsOptions {
5
5
  getLanguage?: (request: BotRequest) => string;
6
6
  getCountry?: (request: BotRequest) => string;
@@ -11,9 +11,10 @@ export default class BotonicPluginHubtypeAnalytics implements Plugin {
11
11
  getCountry: (request: BotRequest) => string;
12
12
  constructor(options?: HubtypeAnalyticsOptions);
13
13
  post(): void;
14
- getUrl(request: BotRequest): string;
14
+ getUrl(request: BotRequest, eventType: EventType): string;
15
15
  getRequestData(request: BotRequest): RequestData;
16
16
  trackEvent(request: BotRequest, htEventProps: HtEventProps): Promise<axios.AxiosResponse<any, any>>;
17
+ private sendEvent;
17
18
  }
18
19
  export * from './types';
19
20
  export * from './utils';
package/lib/esm/index.js CHANGED
@@ -1,5 +1,6 @@
1
1
  import { __awaiter } from "tslib";
2
2
  import axios from 'axios';
3
+ import { EventType } from './types';
3
4
  import { createHtEvent } from './utils';
4
5
  function getDefaultLanguage(request) {
5
6
  return request.session.user.extra_data.language;
@@ -16,8 +17,10 @@ export default class BotonicPluginHubtypeAnalytics {
16
17
  post() {
17
18
  return;
18
19
  }
19
- getUrl(request) {
20
- return `${this.baseUrl}/external/v1/conversational_apps/${request.session.bot.id}/bot_event/`;
20
+ getUrl(request, eventType) {
21
+ const endpoint = eventType === EventType.Webevent ? 'web_event' : 'bot_event';
22
+ const botId = request.session.bot.id;
23
+ return `${this.baseUrl}/external/v2/conversational_apps/${botId}/${endpoint}/`;
21
24
  }
22
25
  getRequestData(request) {
23
26
  return {
@@ -29,14 +32,17 @@ export default class BotonicPluginHubtypeAnalytics {
29
32
  }
30
33
  trackEvent(request, htEventProps) {
31
34
  return __awaiter(this, void 0, void 0, function* () {
32
- const url = this.getUrl(request);
33
35
  const requestData = this.getRequestData(request);
34
36
  const event = createHtEvent(requestData, htEventProps);
35
- const headers = { Authorization: `Bearer ${request.session._access_token}` };
36
- const config = { headers };
37
- return axios.post(url, event, config);
37
+ return this.sendEvent(request, event);
38
38
  });
39
39
  }
40
+ sendEvent(request, event) {
41
+ const url = this.getUrl(request, event.type);
42
+ const headers = { Authorization: `Bearer ${request.session._access_token}` };
43
+ const config = event.type !== EventType.Webevent ? { headers } : undefined;
44
+ return axios.post(url, event, config);
45
+ }
40
46
  }
41
47
  export * from './types';
42
48
  export * from './utils';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAOvC,SAAS,kBAAkB,CAAC,OAAmB;IAC7C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAA;AACjD,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAmB;IAC5C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAA;AAChD,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,6BAA6B;IAIhD,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,yBAAyB,CAAA;QACvE,IAAI,CAAC,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,KAAI,kBAAkB,CAAA;QAC7D,IAAI,CAAC,UAAU,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,KAAI,iBAAiB,CAAA;IAC5D,CAAC;IAED,IAAI;QACF,OAAM;IACR,CAAC;IAED,MAAM,CAAC,OAAmB;QACxB,OAAO,GAAG,IAAI,CAAC,OAAO,oCAAoC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,aAAa,CAAA;IAC/F,CAAC;IAED,cAAc,CAAC,OAAmB;QAChC,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACjC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;YACvC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;SAChC,CAAA;IACH,CAAC;IAEK,UAAU,CAAC,OAAmB,EAAE,YAA0B;;YAC9D,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAChC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;YAChD,MAAM,KAAK,GAAG,aAAa,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;YACtD,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAA;YAC5E,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,CAAA;YAC1B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;QACvC,CAAC;KAAA;CACF;AAED,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,EAAE,SAAS,EAA6B,MAAM,SAAS,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAOvC,SAAS,kBAAkB,CAAC,OAAmB;IAC7C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAA;AACjD,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAmB;IAC5C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAA;AAChD,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,6BAA6B;IAIhD,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,yBAAyB,CAAA;QACvE,IAAI,CAAC,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,KAAI,kBAAkB,CAAA;QAC7D,IAAI,CAAC,UAAU,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,KAAI,iBAAiB,CAAA;IAC5D,CAAC;IAED,IAAI;QACF,OAAM;IACR,CAAC;IAED,MAAM,CAAC,OAAmB,EAAE,SAAoB;QAC9C,MAAM,QAAQ,GACZ,SAAS,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAA;QAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAA;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,oCAAoC,KAAK,IAAI,QAAQ,GAAG,CAAA;IAChF,CAAC;IAED,cAAc,CAAC,OAAmB;QAChC,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACjC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;YACvC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;SAChC,CAAA;IACH,CAAC;IAEK,UAAU,CAAC,OAAmB,EAAE,YAA0B;;YAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;YAChD,MAAM,KAAK,GAAG,aAAa,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;YAEtD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACvC,CAAC;KAAA;IAEO,SAAS,CAAC,OAAmB,EAAE,KAAc;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAC5C,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAA;QAC5E,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QAC1E,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;CACF;AAED,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
@@ -1,128 +1,138 @@
1
1
  import { PROVIDER } from '@botonic/core';
2
- export interface Event {
3
- chat: string;
4
- event_type: EventName;
5
- event_data: BaseEventData;
6
- }
7
- export declare enum EventName {
8
- botAgentRating = "bot_agent_rating",
9
- botChannelRating = "bot_channel_rating",
10
- botFaqUseful = "bot_faq_useful",
11
- botRating = "bot_rating",
12
- botFaq = "bot_faq",
13
- botStart = "bot_start",
14
- botOpen = "bot_open",
15
- botAiModel = "bot_ai_model",
16
- botAiKnowledgeBase = "bot_ai_knowledge_base",
17
- botKeywordsModel = "bot_keywords_model",
18
- fallback = "fallback",
19
- handoffOption = "handoff_option",
20
- handoffSuccess = "handoff_success",
21
- handoffFail = "handoff_fail"
22
- }
23
- export interface BaseEventData {
24
- channel: string;
25
- event_datetime: string;
26
- enduser_language: string;
27
- enduser_country?: string;
28
- format_version?: number;
29
- bot_version?: string;
30
- flow_version?: string;
2
+ export declare enum EventType {
3
+ Feedback = "feedback",
4
+ Botevent = "botevent",
5
+ Webevent = "webevent"
6
+ }
7
+ export declare enum EventAction {
8
+ FeedbackCase = "feedback_case",
9
+ FeedbackMessage = "feddback_message",
10
+ FeedbackConversation = "feddback_conversation",
11
+ FeedbackWebview = "feddback_webview",
12
+ FlowNode = "flow_node",
13
+ HandoffOption = "handoff_option",
14
+ HandoffSuccess = "handoff_success",
15
+ HandoffFail = "handoff_fail",
16
+ Keyword = "nlu_keyword",
17
+ Intent = "nlu_intent",
18
+ IntentSmart = "nlu_intent_smart",
19
+ Knowledgebase = "knowledgebase",
20
+ Fallback = "fallback",
21
+ WebviewStep = "webview_step",
22
+ WebviewEnd = "webview_end",
23
+ Custom = "custom"
31
24
  }
32
25
  export interface HtBaseEventProps {
33
- event_type: EventName;
34
- }
35
- export interface EventAgentRating extends HtBaseEventProps {
36
- event_type: EventName.botAgentRating;
37
- event_data: EventDataRating;
38
- }
39
- export interface EventDataRating {
40
- case_id: string;
41
- rating?: number;
42
- comment?: string;
43
- }
44
- export interface EventChannelRating extends HtBaseEventProps {
45
- event_type: EventName.botChannelRating;
46
- event_data: EventDataChannelRating;
47
- }
48
- export interface EventDataChannelRating {
49
- rating: number;
50
- }
51
- export interface EventFaqUseful extends HtBaseEventProps {
52
- event_type: EventName.botFaqUseful;
53
- event_data: EventDataUseful;
54
- }
55
- export interface EventDataUseful {
56
- faq_name: string;
57
- useful: boolean;
58
- }
59
- export interface EventBotRating extends HtBaseEventProps {
60
- event_type: EventName.botRating;
61
- event_data: EventDataBotRating;
62
- }
63
- export interface EventDataBotRating {
64
- rating: number;
65
- free_comment?: string;
66
- selected_options?: string[];
67
- }
68
- export interface EventBotFaq extends HtBaseEventProps {
69
- event_type: EventName.botFaq;
70
- event_data: EventDataBotFaq;
71
- }
72
- export interface EventDataBotFaq {
73
- faq_name: string;
74
- }
75
- export interface EventBotStart extends HtBaseEventProps {
76
- event_type: EventName.botStart;
77
- }
78
- export interface EventBotOpen {
79
- event_type: EventName.botOpen;
80
- }
81
- export interface EventBotAiModel {
82
- event_type: EventName.botAiModel;
83
- event_data: EventDataBotAiModel;
84
- }
85
- export interface EventDataBotAiModel {
86
- intent: string;
87
- confidence: number;
88
- confidence_successful: boolean;
89
- }
90
- export interface EventBotAiKnowledgeBase {
91
- event_type: EventName.botAiKnowledgeBase;
92
- event_data: EventDataBotAiKnowledgeBase;
93
- }
94
- export interface EventDataBotAiKnowledgeBase {
95
- answer: string;
96
- knowledge_source_ids: string[];
97
- }
98
- export interface EventBotKeywordModel extends HtBaseEventProps {
99
- event_type: EventName.botKeywordsModel;
100
- event_data: EventDataBotKeywordModel;
101
- }
102
- export interface EventDataBotKeywordModel {
103
- confidence_successful: boolean;
26
+ action: EventAction;
27
+ }
28
+ export interface EventFeedback extends HtBaseEventProps {
29
+ action: EventAction.FeedbackCase | EventAction.FeedbackConversation | EventAction.FeedbackMessage | EventAction.FeedbackWebview;
30
+ data: EventPropsFeedback;
31
+ }
32
+ export interface EventPropsFeedback {
33
+ messageGeneratedBy?: string;
34
+ feedbackTargetId?: string;
35
+ feedbackGroupId?: string;
36
+ possibleOptions: string[];
37
+ possibleValues: number[];
38
+ option: string;
39
+ value: number;
40
+ }
41
+ export interface EventFlow extends HtBaseEventProps {
42
+ action: EventAction.FlowNode;
43
+ data: EventPropsFlow;
44
+ }
45
+ export interface EventPropsFlow {
46
+ flowThreadId: string;
47
+ flowId: string;
48
+ flowName: string;
49
+ flowNodeId: string;
50
+ flowNodeContentId: string;
51
+ flowNodeIsMeaningful?: boolean;
52
+ }
53
+ export interface EventHandoff extends HtBaseEventProps {
54
+ action: EventAction.HandoffOption | EventAction.HandoffSuccess | EventAction.HandoffFail;
55
+ data: EventPropsHandoff;
56
+ }
57
+ export interface EventPropsHandoff {
58
+ queueId: string;
59
+ queueName: string;
60
+ caseId?: string;
61
+ isQueueOpen?: boolean;
62
+ isAvailableAgent?: boolean;
63
+ isThresholdReached?: boolean;
64
+ }
65
+ export interface EventIntent extends HtBaseEventProps {
66
+ action: EventAction.Intent;
67
+ data: EventPropsIntent;
68
+ }
69
+ export interface EventPropsIntent {
70
+ nluIntentLabel: string;
71
+ nluIntentConfidence: number;
72
+ nluIntentThreshold: number;
73
+ nluIntentMessageId: string;
74
+ }
75
+ export interface EventKeyword extends HtBaseEventProps {
76
+ action: EventAction.Keyword;
77
+ data: EventPropsKeyword;
78
+ }
79
+ export interface EventPropsKeyword {
80
+ nluKeywordId: string;
81
+ nluKeywordName: string;
82
+ nluKeywordIsRegex?: boolean;
83
+ nluKeywordMessageId: string;
84
+ }
85
+ export interface EventIntentSmart extends HtBaseEventProps {
86
+ action: EventAction.IntentSmart;
87
+ data: EventPropsIntentSmart;
88
+ }
89
+ export interface EventPropsIntentSmart {
90
+ nluIntentSmartTitle: string;
91
+ nluIntentSmartNumUsed: number;
92
+ nluIntentSmartMessageId: string;
93
+ }
94
+ export interface EventKnowledgeBase extends HtBaseEventProps {
95
+ action: EventAction.Knowledgebase;
96
+ data: EventPropsKnowledgeBase;
97
+ }
98
+ export interface EventPropsKnowledgeBase {
99
+ knowledgebaseInferenceId: string;
100
+ knowledgebaseFailReason?: KnowledgebaseFailReason;
101
+ knowledgebaseSourcesIds: string[];
102
+ knowledgebaseChunksIds: string[];
103
+ knowledgebaseMessageId: string;
104
+ }
105
+ export declare enum KnowledgebaseFailReason {
106
+ NoKnowledge = "no_knowledge",
107
+ Hallucination = "hallucination"
104
108
  }
105
109
  export interface EventFallback extends HtBaseEventProps {
106
- event_type: EventName.fallback;
110
+ action: EventAction.Fallback;
111
+ data: EventPropsFallbackBase;
112
+ }
113
+ export interface EventPropsFallbackBase {
114
+ fallbackOut: number;
115
+ fallbackMessageId: string;
107
116
  }
108
- export interface EventHandoffOption extends HtBaseEventProps {
109
- event_type: EventName.handoffOption;
117
+ export interface EventWebview extends HtBaseEventProps {
118
+ action: EventAction.WebviewStep | EventAction.WebviewEnd;
119
+ data: EventPropsWebview;
110
120
  }
111
- export interface EventHandoffSuccess extends HtBaseEventProps {
112
- event_type: EventName.handoffSuccess;
113
- event_data: EventDataHandoff;
121
+ export interface EventPropsWebview {
122
+ webviewThreadId: string;
123
+ webviewName: string;
124
+ webviewStepName?: string;
125
+ webviewEndFailType?: string;
126
+ webviewEndFailMessage?: string;
114
127
  }
115
- export interface EventHandoffFail extends HtBaseEventProps {
116
- event_type: EventName.handoffFail;
117
- event_data: EventDataHandoff;
128
+ export interface EventCustom extends HtBaseEventProps {
129
+ action: EventAction.Custom;
130
+ data: EventPropsCustom;
118
131
  }
119
- export interface EventDataHandoff {
120
- queue_open: boolean;
121
- queue_id: string;
122
- available_agents: boolean;
123
- threshold_reached: boolean;
132
+ export interface EventPropsCustom {
133
+ customFields: Record<string, any>;
124
134
  }
125
- export type HtEventProps = EventAgentRating | EventChannelRating | EventFaqUseful | EventBotRating | EventBotFaq | EventBotStart | EventBotOpen | EventBotAiModel | EventBotAiKnowledgeBase | EventBotKeywordModel | EventFallback | EventHandoffOption | EventHandoffSuccess | EventHandoffFail;
135
+ export type HtEventProps = EventFeedback | EventFlow | EventHandoff | EventIntent | EventKeyword | EventIntentSmart | EventKnowledgeBase | EventFallback | EventWebview | EventCustom;
126
136
  export interface RequestData {
127
137
  language: string;
128
138
  country: string;
package/lib/esm/types.js CHANGED
@@ -1,18 +1,31 @@
1
- export var EventName;
2
- (function (EventName) {
3
- EventName["botAgentRating"] = "bot_agent_rating";
4
- EventName["botChannelRating"] = "bot_channel_rating";
5
- EventName["botFaqUseful"] = "bot_faq_useful";
6
- EventName["botRating"] = "bot_rating";
7
- EventName["botFaq"] = "bot_faq";
8
- EventName["botStart"] = "bot_start";
9
- EventName["botOpen"] = "bot_open";
10
- EventName["botAiModel"] = "bot_ai_model";
11
- EventName["botAiKnowledgeBase"] = "bot_ai_knowledge_base";
12
- EventName["botKeywordsModel"] = "bot_keywords_model";
13
- EventName["fallback"] = "fallback";
14
- EventName["handoffOption"] = "handoff_option";
15
- EventName["handoffSuccess"] = "handoff_success";
16
- EventName["handoffFail"] = "handoff_fail";
17
- })(EventName || (EventName = {}));
1
+ export var EventType;
2
+ (function (EventType) {
3
+ EventType["Feedback"] = "feedback";
4
+ EventType["Botevent"] = "botevent";
5
+ EventType["Webevent"] = "webevent";
6
+ })(EventType || (EventType = {}));
7
+ export var EventAction;
8
+ (function (EventAction) {
9
+ EventAction["FeedbackCase"] = "feedback_case";
10
+ EventAction["FeedbackMessage"] = "feddback_message";
11
+ EventAction["FeedbackConversation"] = "feddback_conversation";
12
+ EventAction["FeedbackWebview"] = "feddback_webview";
13
+ EventAction["FlowNode"] = "flow_node";
14
+ EventAction["HandoffOption"] = "handoff_option";
15
+ EventAction["HandoffSuccess"] = "handoff_success";
16
+ EventAction["HandoffFail"] = "handoff_fail";
17
+ EventAction["Keyword"] = "nlu_keyword";
18
+ EventAction["Intent"] = "nlu_intent";
19
+ EventAction["IntentSmart"] = "nlu_intent_smart";
20
+ EventAction["Knowledgebase"] = "knowledgebase";
21
+ EventAction["Fallback"] = "fallback";
22
+ EventAction["WebviewStep"] = "webview_step";
23
+ EventAction["WebviewEnd"] = "webview_end";
24
+ EventAction["Custom"] = "custom";
25
+ })(EventAction || (EventAction = {}));
26
+ export var KnowledgebaseFailReason;
27
+ (function (KnowledgebaseFailReason) {
28
+ KnowledgebaseFailReason["NoKnowledge"] = "no_knowledge";
29
+ KnowledgebaseFailReason["Hallucination"] = "hallucination";
30
+ })(KnowledgebaseFailReason || (KnowledgebaseFailReason = {}));
18
31
  //# sourceMappingURL=types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAQA,MAAM,CAAN,IAAY,SAeX;AAfD,WAAY,SAAS;IACnB,gDAAmC,CAAA;IACnC,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,qCAAwB,CAAA;IACxB,+BAAkB,CAAA;IAClB,mCAAsB,CAAA;IACtB,iCAAoB,CAAA;IACpB,wCAA2B,CAAA;IAC3B,yDAA4C,CAAA;IAC5C,oDAAuC,CAAA;IACvC,kCAAqB,CAAA;IACrB,6CAAgC,CAAA;IAChC,+CAAkC,CAAA;IAClC,yCAA4B,CAAA;AAC9B,CAAC,EAfW,SAAS,KAAT,SAAS,QAepB"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAED,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACrB,6CAA8B,CAAA;IAC9B,mDAAoC,CAAA;IACpC,6DAA8C,CAAA;IAC9C,mDAAoC,CAAA;IACpC,qCAAsB,CAAA;IACtB,+CAAgC,CAAA;IAChC,iDAAkC,CAAA;IAClC,2CAA4B,CAAA;IAC5B,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,+CAAgC,CAAA;IAChC,8CAA+B,CAAA;IAC/B,oCAAqB,CAAA;IACrB,2CAA4B,CAAA;IAC5B,yCAA0B,CAAA;IAC1B,gCAAiB,CAAA;AACnB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAwGD,MAAM,CAAN,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,uDAA4B,CAAA;IAC5B,0DAA+B,CAAA;AACjC,CAAC,EAHW,uBAAuB,KAAvB,uBAAuB,QAGlC"}
@@ -1,3 +1,3 @@
1
- import { HtEvent } from './event-models/ht-event';
1
+ import { HtEvent } from './event-models';
2
2
  import { HtEventProps, RequestData } from './types';
3
3
  export declare function createHtEvent(requestData: RequestData, htEventProps: HtEventProps): HtEvent;