@botonic/plugin-hubtype-analytics 0.27.0-alpha.5 → 0.27.0-alpha.6

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 (104) hide show
  1. package/lib/cjs/event-models/ht-event-custom.d.ts +2 -7
  2. package/lib/cjs/event-models/ht-event-custom.js +2 -1
  3. package/lib/cjs/event-models/ht-event-custom.js.map +1 -1
  4. package/lib/cjs/event-models/ht-event-fallback.d.ts +2 -7
  5. package/lib/cjs/event-models/ht-event-fallback.js +3 -2
  6. package/lib/cjs/event-models/ht-event-fallback.js.map +1 -1
  7. package/lib/cjs/event-models/ht-event-feedback.d.ts +2 -5
  8. package/lib/cjs/event-models/ht-event-feedback.js +9 -7
  9. package/lib/cjs/event-models/ht-event-feedback.js.map +1 -1
  10. package/lib/cjs/event-models/ht-event-flow.d.ts +2 -7
  11. package/lib/cjs/event-models/ht-event-flow.js +7 -6
  12. package/lib/cjs/event-models/ht-event-flow.js.map +1 -1
  13. package/lib/cjs/event-models/ht-event-handoff-option.d.ts +8 -0
  14. package/lib/cjs/event-models/ht-event-handoff-option.js +15 -0
  15. package/lib/cjs/event-models/ht-event-handoff-option.js.map +1 -0
  16. package/lib/cjs/event-models/ht-event-handoff.d.ts +5 -9
  17. package/lib/cjs/event-models/ht-event-handoff.js +7 -6
  18. package/lib/cjs/event-models/ht-event-handoff.js.map +1 -1
  19. package/lib/cjs/event-models/ht-event-intent-smart.d.ts +2 -7
  20. package/lib/cjs/event-models/ht-event-intent-smart.js +4 -3
  21. package/lib/cjs/event-models/ht-event-intent-smart.js.map +1 -1
  22. package/lib/cjs/event-models/ht-event-intent.d.ts +2 -7
  23. package/lib/cjs/event-models/ht-event-intent.js +5 -4
  24. package/lib/cjs/event-models/ht-event-intent.js.map +1 -1
  25. package/lib/cjs/event-models/ht-event-keyword.d.ts +2 -7
  26. package/lib/cjs/event-models/ht-event-keyword.js +5 -4
  27. package/lib/cjs/event-models/ht-event-keyword.js.map +1 -1
  28. package/lib/cjs/event-models/ht-event-knowledge-base.d.ts +2 -7
  29. package/lib/cjs/event-models/ht-event-knowledge-base.js +6 -5
  30. package/lib/cjs/event-models/ht-event-knowledge-base.js.map +1 -1
  31. package/lib/cjs/event-models/ht-event-webview.d.ts +1 -5
  32. package/lib/cjs/event-models/ht-event-webview.js +6 -5
  33. package/lib/cjs/event-models/ht-event-webview.js.map +1 -1
  34. package/lib/cjs/event-models/ht-event.d.ts +2 -2
  35. package/lib/cjs/event-models/ht-event.js +1 -2
  36. package/lib/cjs/event-models/ht-event.js.map +1 -1
  37. package/lib/cjs/event-models/index.d.ts +1 -0
  38. package/lib/cjs/event-models/index.js +3 -1
  39. package/lib/cjs/event-models/index.js.map +1 -1
  40. package/lib/cjs/types.d.ts +8 -33
  41. package/lib/cjs/types.js +0 -1
  42. package/lib/cjs/types.js.map +1 -1
  43. package/lib/cjs/utils.js +1 -0
  44. package/lib/cjs/utils.js.map +1 -1
  45. package/lib/esm/event-models/ht-event-custom.d.ts +2 -7
  46. package/lib/esm/event-models/ht-event-custom.js +3 -2
  47. package/lib/esm/event-models/ht-event-custom.js.map +1 -1
  48. package/lib/esm/event-models/ht-event-fallback.d.ts +2 -7
  49. package/lib/esm/event-models/ht-event-fallback.js +4 -3
  50. package/lib/esm/event-models/ht-event-fallback.js.map +1 -1
  51. package/lib/esm/event-models/ht-event-feedback.d.ts +2 -5
  52. package/lib/esm/event-models/ht-event-feedback.js +9 -7
  53. package/lib/esm/event-models/ht-event-feedback.js.map +1 -1
  54. package/lib/esm/event-models/ht-event-flow.d.ts +2 -7
  55. package/lib/esm/event-models/ht-event-flow.js +8 -7
  56. package/lib/esm/event-models/ht-event-flow.js.map +1 -1
  57. package/lib/esm/event-models/ht-event-handoff-option.d.ts +8 -0
  58. package/lib/esm/event-models/ht-event-handoff-option.js +11 -0
  59. package/lib/esm/event-models/ht-event-handoff-option.js.map +1 -0
  60. package/lib/esm/event-models/ht-event-handoff.d.ts +5 -9
  61. package/lib/esm/event-models/ht-event-handoff.js +7 -6
  62. package/lib/esm/event-models/ht-event-handoff.js.map +1 -1
  63. package/lib/esm/event-models/ht-event-intent-smart.d.ts +2 -7
  64. package/lib/esm/event-models/ht-event-intent-smart.js +5 -4
  65. package/lib/esm/event-models/ht-event-intent-smart.js.map +1 -1
  66. package/lib/esm/event-models/ht-event-intent.d.ts +2 -7
  67. package/lib/esm/event-models/ht-event-intent.js +6 -5
  68. package/lib/esm/event-models/ht-event-intent.js.map +1 -1
  69. package/lib/esm/event-models/ht-event-keyword.d.ts +2 -7
  70. package/lib/esm/event-models/ht-event-keyword.js +6 -5
  71. package/lib/esm/event-models/ht-event-keyword.js.map +1 -1
  72. package/lib/esm/event-models/ht-event-knowledge-base.d.ts +2 -7
  73. package/lib/esm/event-models/ht-event-knowledge-base.js +7 -6
  74. package/lib/esm/event-models/ht-event-knowledge-base.js.map +1 -1
  75. package/lib/esm/event-models/ht-event-webview.d.ts +1 -5
  76. package/lib/esm/event-models/ht-event-webview.js +6 -5
  77. package/lib/esm/event-models/ht-event-webview.js.map +1 -1
  78. package/lib/esm/event-models/ht-event.d.ts +2 -2
  79. package/lib/esm/event-models/ht-event.js +1 -2
  80. package/lib/esm/event-models/ht-event.js.map +1 -1
  81. package/lib/esm/event-models/index.d.ts +1 -0
  82. package/lib/esm/event-models/index.js +1 -0
  83. package/lib/esm/event-models/index.js.map +1 -1
  84. package/lib/esm/types.d.ts +8 -33
  85. package/lib/esm/types.js +0 -1
  86. package/lib/esm/types.js.map +1 -1
  87. package/lib/esm/utils.js +2 -1
  88. package/lib/esm/utils.js.map +1 -1
  89. package/package.json +1 -1
  90. package/src/event-models/ht-event-custom.ts +3 -7
  91. package/src/event-models/ht-event-fallback.ts +4 -8
  92. package/src/event-models/ht-event-feedback.ts +11 -12
  93. package/src/event-models/ht-event-flow.ts +8 -12
  94. package/src/event-models/ht-event-handoff-option.ts +20 -0
  95. package/src/event-models/ht-event-handoff.ts +12 -18
  96. package/src/event-models/ht-event-intent-smart.ts +5 -9
  97. package/src/event-models/ht-event-intent.ts +6 -10
  98. package/src/event-models/ht-event-keyword.ts +6 -10
  99. package/src/event-models/ht-event-knowledge-base.ts +7 -11
  100. package/src/event-models/ht-event-webview.ts +7 -10
  101. package/src/event-models/ht-event.ts +3 -4
  102. package/src/event-models/index.ts +1 -0
  103. package/src/types.ts +9 -45
  104. package/src/utils.ts +3 -0
package/src/types.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  export enum EventType {
2
- Feedback = 'feedback',
3
2
  BotEvent = 'botevent',
4
3
  WebEvent = 'webevent',
5
4
  }
@@ -33,10 +32,6 @@ export interface EventFeedback extends HtBaseEventProps {
33
32
  | EventAction.FeedbackConversation
34
33
  | EventAction.FeedbackMessage
35
34
  | EventAction.FeedbackWebview
36
- data: EventPropsFeedback
37
- }
38
-
39
- export interface EventPropsFeedback {
40
35
  messageGeneratedBy?: string
41
36
  feedbackTargetId?: string
42
37
  feedbackGroupId?: string
@@ -44,14 +39,11 @@ export interface EventPropsFeedback {
44
39
  possibleValues: number[]
45
40
  option: string
46
41
  value: number
42
+ comment?: string
47
43
  }
48
44
 
49
45
  export interface EventFlow extends HtBaseEventProps {
50
46
  action: EventAction.FlowNode
51
- data: EventPropsFlow
52
- }
53
-
54
- export interface EventPropsFlow {
55
47
  flowThreadId: string
56
48
  flowId: string
57
49
  flowName: string
@@ -61,14 +53,7 @@ export interface EventPropsFlow {
61
53
  }
62
54
 
63
55
  export interface EventHandoff extends HtBaseEventProps {
64
- action:
65
- | EventAction.HandoffOption
66
- | EventAction.HandoffSuccess
67
- | EventAction.HandoffFail
68
- data: EventPropsHandoff
69
- }
70
-
71
- export interface EventPropsHandoff {
56
+ action: EventAction.HandoffSuccess | EventAction.HandoffFail
72
57
  queueId: string
73
58
  queueName: string
74
59
  caseId?: string
@@ -77,12 +62,14 @@ export interface EventPropsHandoff {
77
62
  isThresholdReached?: boolean
78
63
  }
79
64
 
80
- export interface EventIntent extends HtBaseEventProps {
81
- action: EventAction.Intent
82
- data: EventPropsIntent
65
+ export interface EventHandoffOption extends HtBaseEventProps {
66
+ action: EventAction.HandoffOption
67
+ queueId: string
68
+ queueName: string
83
69
  }
84
70
 
85
- export interface EventPropsIntent {
71
+ export interface EventIntent extends HtBaseEventProps {
72
+ action: EventAction.Intent
86
73
  nluIntentLabel: string
87
74
  nluIntentConfidence: number
88
75
  nluIntentThreshold: number
@@ -91,10 +78,6 @@ export interface EventPropsIntent {
91
78
 
92
79
  export interface EventKeyword extends HtBaseEventProps {
93
80
  action: EventAction.Keyword
94
- data: EventPropsKeyword
95
- }
96
-
97
- export interface EventPropsKeyword {
98
81
  nluKeywordId: string
99
82
  nluKeywordName: string
100
83
  nluKeywordIsRegex?: boolean
@@ -103,10 +86,6 @@ export interface EventPropsKeyword {
103
86
 
104
87
  export interface EventIntentSmart extends HtBaseEventProps {
105
88
  action: EventAction.IntentSmart
106
- data: EventPropsIntentSmart
107
- }
108
-
109
- export interface EventPropsIntentSmart {
110
89
  nluIntentSmartTitle: string
111
90
  nluIntentSmartNumUsed: number
112
91
  nluIntentSmartMessageId: string
@@ -114,10 +93,6 @@ export interface EventPropsIntentSmart {
114
93
 
115
94
  export interface EventKnowledgeBase extends HtBaseEventProps {
116
95
  action: EventAction.Knowledgebase
117
- data: EventPropsKnowledgeBase
118
- }
119
-
120
- export interface EventPropsKnowledgeBase {
121
96
  knowledgebaseInferenceId: string
122
97
  knowledgebaseFailReason?: KnowledgebaseFailReason
123
98
  knowledgebaseSourcesIds: string[]
@@ -132,20 +107,12 @@ export enum KnowledgebaseFailReason {
132
107
 
133
108
  export interface EventFallback extends HtBaseEventProps {
134
109
  action: EventAction.Fallback
135
- data: EventPropsFallbackBase
136
- }
137
-
138
- export interface EventPropsFallbackBase {
139
110
  fallbackOut: number
140
111
  fallbackMessageId: string
141
112
  }
142
113
 
143
114
  export interface EventWebview extends HtBaseEventProps {
144
115
  action: EventAction.WebviewStep | EventAction.WebviewEnd
145
- data: EventPropsWebview
146
- }
147
-
148
- export interface EventPropsWebview {
149
116
  webviewThreadId: string
150
117
  webviewName: string
151
118
  webviewStepName?: string
@@ -155,10 +122,6 @@ export interface EventPropsWebview {
155
122
 
156
123
  export interface EventCustom extends HtBaseEventProps {
157
124
  action: EventAction.Custom
158
- data: EventPropsCustom
159
- }
160
-
161
- export interface EventPropsCustom {
162
125
  customFields: Record<string, any>
163
126
  }
164
127
 
@@ -166,6 +129,7 @@ export type HtEventProps =
166
129
  | EventFeedback
167
130
  | EventFlow
168
131
  | EventHandoff
132
+ | EventHandoffOption
169
133
  | EventIntent
170
134
  | EventKeyword
171
135
  | EventIntentSmart
package/src/utils.ts CHANGED
@@ -5,6 +5,7 @@ import {
5
5
  HtEventFeedback,
6
6
  HtEventFlow,
7
7
  HtEventHandoff,
8
+ HtEventHandoffOption,
8
9
  HtEventIntent,
9
10
  HtEventIntentSmart,
10
11
  HtEventKeyword,
@@ -28,6 +29,8 @@ export function createHtEvent(
28
29
  return new HtEventFlow(htEventProps, requestData)
29
30
 
30
31
  case EventAction.HandoffOption:
32
+ return new HtEventHandoffOption(htEventProps, requestData)
33
+
31
34
  case EventAction.HandoffSuccess:
32
35
  case EventAction.HandoffFail:
33
36
  return new HtEventHandoff(htEventProps, requestData)