commandbar 1.9.0 → 1.10.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +32 -10
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +4 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +46 -13
  7. package/build/internal/src/client/CommandBarSDK.d.ts +17 -10
  8. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  9. package/build/internal/src/client/symbols.d.ts +5 -1
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +22 -10
  11. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  12. package/build/internal/src/middleware/OrganizationV.d.ts +200 -6
  13. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  14. package/build/internal/src/middleware/additionalResource.d.ts +96 -15
  15. package/build/internal/src/middleware/billing.d.ts +0 -2
  16. package/build/internal/src/middleware/chat.d.ts +2196 -176
  17. package/build/internal/src/middleware/checklist.d.ts +504 -63
  18. package/build/internal/src/middleware/command.d.ts +1809 -385
  19. package/build/internal/src/middleware/endUser.d.ts +33 -5
  20. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  21. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  22. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  23. package/build/internal/src/middleware/flags.d.ts +20 -0
  24. package/build/internal/src/middleware/helpDocsIntegration.d.ts +9 -0
  25. package/build/internal/src/middleware/helpDocsSearch.d.ts +371 -35
  26. package/build/internal/src/middleware/helpers/actions.d.ts +66 -16
  27. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +70 -8
  28. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  29. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  30. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +22 -0
  31. package/build/internal/src/middleware/helpers/rules.d.ts +45 -36
  32. package/build/internal/src/middleware/network.d.ts +15 -0
  33. package/build/internal/src/middleware/nudge.d.ts +1103 -124
  34. package/build/internal/src/middleware/organization.d.ts +1288 -61
  35. package/build/internal/src/middleware/organizationSettings.d.ts +320 -12
  36. package/build/internal/src/middleware/profile.d.ts +2 -0
  37. package/build/internal/src/middleware/recommendationSet.d.ts +96 -15
  38. package/build/internal/src/middleware/releases.d.ts +1 -1
  39. package/build/internal/src/middleware/theme.d.ts +431 -0
  40. package/build/internal/src/middleware/types.d.ts +52 -15
  41. package/build/internal/src/middleware/user.d.ts +1 -0
  42. package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -3
  43. package/build/internal/src/util/operatingSystem.d.ts +2 -4
  44. package/package.json +1 -1
  45. package/src/index.ts +2 -2
  46. package/src/init.ts +12 -6
  47. package/src/snippet.ts +2 -2
  48. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  49. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  50. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
@@ -14,16 +14,23 @@ export declare const OpenBarAction: t.IntersectionC<[t.TypeC<{
14
14
  value: t.StringC;
15
15
  categoryFilter: t.NumberC;
16
16
  }>]>;
17
+ export declare const OpenHelpHubAction: t.TypeC<{
18
+ type: t.LiteralC<"open_helphub">;
19
+ }>;
20
+ export declare const OpenCopilotAction: t.TypeC<{
21
+ type: t.LiteralC<"open_copilot">;
22
+ }>;
17
23
  export declare const LinkAction: t.IntersectionC<[t.TypeC<{
18
24
  type: t.LiteralC<"link">;
19
25
  value: t.StringC;
20
26
  }>, t.PartialC<{
21
27
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
22
28
  }>]>;
29
+ export declare const OpenChatActionTypeV: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
23
30
  export declare const OpenChatActionV: t.TypeC<{
24
31
  type: t.LiteralC<"open_chat">;
25
32
  meta: t.TypeC<{
26
- type: t.StringC;
33
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
27
34
  }>;
28
35
  }>;
29
36
  export declare const DismissAction: t.TypeC<{
@@ -51,6 +58,10 @@ export declare const AppcuesAction: t.TypeC<{
51
58
  type: t.LiteralC<"appcues">;
52
59
  value: t.StringC;
53
60
  }>;
61
+ export declare const PendoGuideAction: t.TypeC<{
62
+ type: t.LiteralC<"pendo_guide">;
63
+ value: t.StringC;
64
+ }>;
54
65
  export declare const ScriptAction: t.TypeC<{
55
66
  type: t.LiteralC<"script">;
56
67
  value: t.StringC;
@@ -69,11 +80,14 @@ export declare const HelpDocAction: t.IntersectionC<[t.TypeC<{
69
80
  date: t.StringC;
70
81
  }>;
71
82
  }>]>;
83
+ export declare const CommandActionMetaTypeV: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
72
84
  export declare const CommandActionV: t.TypeC<{
73
85
  type: t.LiteralC<"execute_command">;
74
- meta: t.TypeC<{
86
+ meta: t.IntersectionC<[t.TypeC<{
75
87
  command: t.StringC;
76
- }>;
88
+ }>, t.PartialC<{
89
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
90
+ }>]>;
77
91
  }>;
78
92
  export declare const NoAction: t.TypeC<{
79
93
  type: t.LiteralC<"no_action">;
@@ -96,14 +110,19 @@ export declare const QuestlistActionV: t.TypeC<{
96
110
  }>;
97
111
  export declare const ActionV: t.UnionC<[t.TypeC<{
98
112
  type: t.LiteralC<"execute_command">;
99
- meta: t.TypeC<{
113
+ meta: t.IntersectionC<[t.TypeC<{
100
114
  command: t.StringC;
101
- }>;
115
+ }>, t.PartialC<{
116
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
117
+ }>]>;
102
118
  }>, t.TypeC<{
103
119
  type: t.LiteralC<"no_action">;
104
120
  }>, t.TypeC<{
105
121
  type: t.LiteralC<"click">;
106
122
  value: t.StringC;
123
+ }>, t.TypeC<{
124
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
125
+ value: t.ArrayC<t.StringC>;
107
126
  }>, t.IntersectionC<[t.TypeC<{
108
127
  type: t.LiteralC<"link">;
109
128
  value: t.StringC;
@@ -112,7 +131,7 @@ export declare const ActionV: t.UnionC<[t.TypeC<{
112
131
  }>]>, t.TypeC<{
113
132
  type: t.LiteralC<"open_chat">;
114
133
  meta: t.TypeC<{
115
- type: t.StringC;
134
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
116
135
  }>;
117
136
  }>, t.TypeC<{
118
137
  type: t.LiteralC<"dismiss">;
@@ -134,19 +153,28 @@ export declare const ActionV: t.UnionC<[t.TypeC<{
134
153
  }>, t.PartialC<{
135
154
  value: t.StringC;
136
155
  categoryFilter: t.NumberC;
137
- }>]>]>;
156
+ }>]>, t.TypeC<{
157
+ type: t.LiteralC<"open_helphub">;
158
+ }>, t.TypeC<{
159
+ type: t.LiteralC<"open_copilot">;
160
+ }>]>;
138
161
  export declare const LabeledActionV: t.TypeC<{
139
162
  cta: t.StringC;
140
163
  action: t.UnionC<[t.TypeC<{
141
164
  type: t.LiteralC<"execute_command">;
142
- meta: t.TypeC<{
165
+ meta: t.IntersectionC<[t.TypeC<{
143
166
  command: t.StringC;
144
- }>;
167
+ }>, t.PartialC<{
168
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
169
+ }>]>;
145
170
  }>, t.TypeC<{
146
171
  type: t.LiteralC<"no_action">;
147
172
  }>, t.TypeC<{
148
173
  type: t.LiteralC<"click">;
149
174
  value: t.StringC;
175
+ }>, t.TypeC<{
176
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
177
+ value: t.ArrayC<t.StringC>;
150
178
  }>, t.IntersectionC<[t.TypeC<{
151
179
  type: t.LiteralC<"link">;
152
180
  value: t.StringC;
@@ -155,7 +183,7 @@ export declare const LabeledActionV: t.TypeC<{
155
183
  }>]>, t.TypeC<{
156
184
  type: t.LiteralC<"open_chat">;
157
185
  meta: t.TypeC<{
158
- type: t.StringC;
186
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
159
187
  }>;
160
188
  }>, t.TypeC<{
161
189
  type: t.LiteralC<"dismiss">;
@@ -177,7 +205,11 @@ export declare const LabeledActionV: t.TypeC<{
177
205
  }>, t.PartialC<{
178
206
  value: t.StringC;
179
207
  categoryFilter: t.NumberC;
180
- }>]>]>;
208
+ }>]>, t.TypeC<{
209
+ type: t.LiteralC<"open_helphub">;
210
+ }>, t.TypeC<{
211
+ type: t.LiteralC<"open_copilot">;
212
+ }>]>;
181
213
  }>;
182
214
  export declare const isAction: (o: string | number | LabeledAction) => o is {
183
215
  cta: string;
@@ -185,10 +217,15 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
185
217
  type: "execute_command";
186
218
  meta: {
187
219
  command: string;
220
+ } & {
221
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
188
222
  };
189
223
  } | {
190
224
  type: "click";
191
225
  value: string;
226
+ } | {
227
+ type: "click" | "clickBySelector" | "clickByXpath";
228
+ value: string[];
192
229
  } | ({
193
230
  type: "link";
194
231
  value: string;
@@ -197,7 +234,7 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
197
234
  }) | {
198
235
  type: "open_chat";
199
236
  meta: {
200
- type: string;
237
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
201
238
  };
202
239
  } | {
203
240
  type: "dismiss";
@@ -220,6 +257,10 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
220
257
  value?: string | undefined;
221
258
  categoryFilter?: number | undefined;
222
259
  }) | {
260
+ type: "open_helphub";
261
+ } | {
262
+ type: "open_copilot";
263
+ } | {
223
264
  type: "no_action";
224
265
  };
225
266
  };
@@ -250,14 +291,19 @@ export declare const TriggerAction: t.TypeC<{
250
291
  type: t.LiteralC<"trigger">;
251
292
  value: t.UnionC<[t.TypeC<{
252
293
  type: t.LiteralC<"execute_command">;
253
- meta: t.TypeC<{
294
+ meta: t.IntersectionC<[t.TypeC<{
254
295
  command: t.StringC;
255
- }>;
296
+ }>, t.PartialC<{
297
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
298
+ }>]>;
256
299
  }>, t.TypeC<{
257
300
  type: t.LiteralC<"no_action">;
258
301
  }>, t.TypeC<{
259
302
  type: t.LiteralC<"click">;
260
303
  value: t.StringC;
304
+ }>, t.TypeC<{
305
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
306
+ value: t.ArrayC<t.StringC>;
261
307
  }>, t.IntersectionC<[t.TypeC<{
262
308
  type: t.LiteralC<"link">;
263
309
  value: t.StringC;
@@ -266,7 +312,7 @@ export declare const TriggerAction: t.TypeC<{
266
312
  }>]>, t.TypeC<{
267
313
  type: t.LiteralC<"open_chat">;
268
314
  meta: t.TypeC<{
269
- type: t.StringC;
315
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
270
316
  }>;
271
317
  }>, t.TypeC<{
272
318
  type: t.LiteralC<"dismiss">;
@@ -288,5 +334,9 @@ export declare const TriggerAction: t.TypeC<{
288
334
  }>, t.PartialC<{
289
335
  value: t.StringC;
290
336
  categoryFilter: t.NumberC;
291
- }>]>]>;
337
+ }>]>, t.TypeC<{
338
+ type: t.LiteralC<"open_helphub">;
339
+ }>, t.TypeC<{
340
+ type: t.LiteralC<"open_copilot">;
341
+ }>]>;
292
342
  }>;
@@ -6,6 +6,7 @@ export declare const TemplateOptionsV: t.IntersectionC<[t.TypeC<{}>, t.PartialC<
6
6
  object: t.StringC;
7
7
  hoverTooltip: t.BooleanC;
8
8
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
9
+ metadata: t.UnknownRecordC;
9
10
  }>]>;
10
11
  export declare const AdminTemplateV: t.IntersectionC<[t.TypeC<{
11
12
  type: t.LiteralC<"admin">;
@@ -15,6 +16,7 @@ export declare const AdminTemplateV: t.IntersectionC<[t.TypeC<{
15
16
  object: t.StringC;
16
17
  hoverTooltip: t.BooleanC;
17
18
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
19
+ metadata: t.UnknownRecordC;
18
20
  }>]>]>;
19
21
  export declare const CallbackTemplateV: t.IntersectionC<[t.TypeC<{
20
22
  type: t.LiteralC<"callback">;
@@ -24,6 +26,7 @@ export declare const CallbackTemplateV: t.IntersectionC<[t.TypeC<{
24
26
  object: t.StringC;
25
27
  hoverTooltip: t.BooleanC;
26
28
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
29
+ metadata: t.UnknownRecordC;
27
30
  }>]>]>;
28
31
  export declare const LinkTemplateV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
29
32
  type: t.LiteralC<"link">;
@@ -35,6 +38,7 @@ export declare const LinkTemplateV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
35
38
  object: t.StringC;
36
39
  hoverTooltip: t.BooleanC;
37
40
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
41
+ metadata: t.UnknownRecordC;
38
42
  }>]>]>;
39
43
  export declare const ClickTemplateV: t.IntersectionC<[t.TypeC<{
40
44
  type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
@@ -44,6 +48,7 @@ export declare const ClickTemplateV: t.IntersectionC<[t.TypeC<{
44
48
  object: t.StringC;
45
49
  hoverTooltip: t.BooleanC;
46
50
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
51
+ metadata: t.UnknownRecordC;
47
52
  }>]>]>;
48
53
  export declare const BuiltInTemplateV: t.IntersectionC<[t.TypeC<{
49
54
  type: t.LiteralC<"builtin">;
@@ -53,6 +58,7 @@ export declare const BuiltInTemplateV: t.IntersectionC<[t.TypeC<{
53
58
  object: t.StringC;
54
59
  hoverTooltip: t.BooleanC;
55
60
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
61
+ metadata: t.UnknownRecordC;
56
62
  }>]>]>;
57
63
  export declare const WebhookTemplateV: t.IntersectionC<[t.TypeC<{
58
64
  type: t.LiteralC<"webhook">;
@@ -62,6 +68,7 @@ export declare const WebhookTemplateV: t.IntersectionC<[t.TypeC<{
62
68
  object: t.StringC;
63
69
  hoverTooltip: t.BooleanC;
64
70
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
71
+ metadata: t.UnknownRecordC;
65
72
  }>]>]>;
66
73
  export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
67
74
  type: t.LiteralC<"script">;
@@ -71,6 +78,7 @@ export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
71
78
  object: t.StringC;
72
79
  hoverTooltip: t.BooleanC;
73
80
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
81
+ metadata: t.UnknownRecordC;
74
82
  }>]>]>;
75
83
  export declare const RequestTemplateV: t.IntersectionC<[t.TypeC<{
76
84
  type: t.LiteralC<"request">;
@@ -89,6 +97,7 @@ export declare const RequestTemplateV: t.IntersectionC<[t.TypeC<{
89
97
  object: t.StringC;
90
98
  hoverTooltip: t.BooleanC;
91
99
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
100
+ metadata: t.UnknownRecordC;
92
101
  }>]>]>;
93
102
  export declare const AppcuesTemplateV: t.IntersectionC<[t.TypeC<{
94
103
  type: t.LiteralC<"appcues">;
@@ -98,6 +107,17 @@ export declare const AppcuesTemplateV: t.IntersectionC<[t.TypeC<{
98
107
  object: t.StringC;
99
108
  hoverTooltip: t.BooleanC;
100
109
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
110
+ metadata: t.UnknownRecordC;
111
+ }>]>]>;
112
+ export declare const PendoGuideTemplateV: t.IntersectionC<[t.TypeC<{
113
+ type: t.LiteralC<"pendo_guide">;
114
+ value: t.StringC;
115
+ }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
116
+ commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
117
+ object: t.StringC;
118
+ hoverTooltip: t.BooleanC;
119
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
120
+ metadata: t.UnknownRecordC;
101
121
  }>]>]>;
102
122
  export declare const VideoTemplateV: t.IntersectionC<[t.TypeC<{
103
123
  type: t.LiteralC<"video">;
@@ -107,6 +127,7 @@ export declare const VideoTemplateV: t.IntersectionC<[t.TypeC<{
107
127
  object: t.StringC;
108
128
  hoverTooltip: t.BooleanC;
109
129
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
130
+ metadata: t.UnknownRecordC;
110
131
  }>]>]>;
111
132
  export declare const HelpDocTemplateV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
112
133
  type: t.LiteralC<"helpdoc">;
@@ -124,19 +145,25 @@ export declare const HelpDocTemplateV: t.IntersectionC<[t.IntersectionC<[t.TypeC
124
145
  object: t.StringC;
125
146
  hoverTooltip: t.BooleanC;
126
147
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
148
+ metadata: t.UnknownRecordC;
127
149
  }>]>]>;
128
150
  export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
129
151
  type: t.LiteralC<"trigger">;
130
152
  value: t.UnionC<[t.TypeC<{
131
153
  type: t.LiteralC<"execute_command">;
132
- meta: t.TypeC<{
154
+ meta: t.IntersectionC<[t.TypeC<{
133
155
  command: t.StringC;
134
- }>;
156
+ }>, t.PartialC<{
157
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
158
+ }>]>;
135
159
  }>, t.TypeC<{
136
160
  type: t.LiteralC<"no_action">;
137
161
  }>, t.TypeC<{
138
162
  type: t.LiteralC<"click">;
139
163
  value: t.StringC;
164
+ }>, t.TypeC<{
165
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
166
+ value: t.ArrayC<t.StringC>;
140
167
  }>, t.IntersectionC<[t.TypeC<{
141
168
  type: t.LiteralC<"link">;
142
169
  value: t.StringC;
@@ -145,7 +172,7 @@ export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
145
172
  }>]>, t.TypeC<{
146
173
  type: t.LiteralC<"open_chat">;
147
174
  meta: t.TypeC<{
148
- type: t.StringC;
175
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
149
176
  }>;
150
177
  }>, t.TypeC<{
151
178
  type: t.LiteralC<"dismiss">;
@@ -167,12 +194,17 @@ export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
167
194
  }>, t.PartialC<{
168
195
  value: t.StringC;
169
196
  categoryFilter: t.NumberC;
170
- }>]>]>;
197
+ }>]>, t.TypeC<{
198
+ type: t.LiteralC<"open_helphub">;
199
+ }>, t.TypeC<{
200
+ type: t.LiteralC<"open_copilot">;
201
+ }>]>;
171
202
  }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
172
203
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
173
204
  object: t.StringC;
174
205
  hoverTooltip: t.BooleanC;
175
206
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
207
+ metadata: t.UnknownRecordC;
176
208
  }>]>]>;
177
209
  export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
178
210
  type: t.LiteralC<"admin">;
@@ -182,6 +214,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
182
214
  object: t.StringC;
183
215
  hoverTooltip: t.BooleanC;
184
216
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
217
+ metadata: t.UnknownRecordC;
185
218
  }>]>]>, t.IntersectionC<[t.TypeC<{
186
219
  type: t.LiteralC<"callback">;
187
220
  value: t.StringC;
@@ -190,6 +223,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
190
223
  object: t.StringC;
191
224
  hoverTooltip: t.BooleanC;
192
225
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
226
+ metadata: t.UnknownRecordC;
193
227
  }>]>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
194
228
  type: t.LiteralC<"link">;
195
229
  value: t.StringC;
@@ -200,6 +234,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
200
234
  object: t.StringC;
201
235
  hoverTooltip: t.BooleanC;
202
236
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
237
+ metadata: t.UnknownRecordC;
203
238
  }>]>]>, t.IntersectionC<[t.TypeC<{
204
239
  type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
205
240
  value: t.ArrayC<t.StringC>;
@@ -208,6 +243,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
208
243
  object: t.StringC;
209
244
  hoverTooltip: t.BooleanC;
210
245
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
246
+ metadata: t.UnknownRecordC;
211
247
  }>]>]>, t.IntersectionC<[t.TypeC<{
212
248
  type: t.LiteralC<"builtin">;
213
249
  value: t.StringC;
@@ -216,6 +252,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
216
252
  object: t.StringC;
217
253
  hoverTooltip: t.BooleanC;
218
254
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
255
+ metadata: t.UnknownRecordC;
219
256
  }>]>]>, t.IntersectionC<[t.TypeC<{
220
257
  type: t.LiteralC<"webhook">;
221
258
  value: t.StringC;
@@ -224,6 +261,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
224
261
  object: t.StringC;
225
262
  hoverTooltip: t.BooleanC;
226
263
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
264
+ metadata: t.UnknownRecordC;
227
265
  }>]>]>, t.IntersectionC<[t.TypeC<{
228
266
  type: t.LiteralC<"script">;
229
267
  value: t.StringC;
@@ -232,6 +270,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
232
270
  object: t.StringC;
233
271
  hoverTooltip: t.BooleanC;
234
272
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
273
+ metadata: t.UnknownRecordC;
235
274
  }>]>]>, t.IntersectionC<[t.TypeC<{
236
275
  type: t.LiteralC<"request">;
237
276
  value: t.IntersectionC<[t.TypeC<{
@@ -249,6 +288,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
249
288
  object: t.StringC;
250
289
  hoverTooltip: t.BooleanC;
251
290
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
291
+ metadata: t.UnknownRecordC;
252
292
  }>]>]>, t.IntersectionC<[t.TypeC<{
253
293
  type: t.LiteralC<"appcues">;
254
294
  value: t.StringC;
@@ -257,6 +297,16 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
257
297
  object: t.StringC;
258
298
  hoverTooltip: t.BooleanC;
259
299
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
300
+ metadata: t.UnknownRecordC;
301
+ }>]>]>, t.IntersectionC<[t.TypeC<{
302
+ type: t.LiteralC<"pendo_guide">;
303
+ value: t.StringC;
304
+ }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
305
+ commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
306
+ object: t.StringC;
307
+ hoverTooltip: t.BooleanC;
308
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
309
+ metadata: t.UnknownRecordC;
260
310
  }>]>]>, t.IntersectionC<[t.TypeC<{
261
311
  type: t.LiteralC<"video">;
262
312
  value: t.StringC;
@@ -265,6 +315,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
265
315
  object: t.StringC;
266
316
  hoverTooltip: t.BooleanC;
267
317
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
318
+ metadata: t.UnknownRecordC;
268
319
  }>]>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
269
320
  type: t.LiteralC<"helpdoc">;
270
321
  value: t.StringC;
@@ -281,18 +332,24 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
281
332
  object: t.StringC;
282
333
  hoverTooltip: t.BooleanC;
283
334
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
335
+ metadata: t.UnknownRecordC;
284
336
  }>]>]>, t.IntersectionC<[t.TypeC<{
285
337
  type: t.LiteralC<"trigger">;
286
338
  value: t.UnionC<[t.TypeC<{
287
339
  type: t.LiteralC<"execute_command">;
288
- meta: t.TypeC<{
340
+ meta: t.IntersectionC<[t.TypeC<{
289
341
  command: t.StringC;
290
- }>;
342
+ }>, t.PartialC<{
343
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
344
+ }>]>;
291
345
  }>, t.TypeC<{
292
346
  type: t.LiteralC<"no_action">;
293
347
  }>, t.TypeC<{
294
348
  type: t.LiteralC<"click">;
295
349
  value: t.StringC;
350
+ }>, t.TypeC<{
351
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
352
+ value: t.ArrayC<t.StringC>;
296
353
  }>, t.IntersectionC<[t.TypeC<{
297
354
  type: t.LiteralC<"link">;
298
355
  value: t.StringC;
@@ -301,7 +358,7 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
301
358
  }>]>, t.TypeC<{
302
359
  type: t.LiteralC<"open_chat">;
303
360
  meta: t.TypeC<{
304
- type: t.StringC;
361
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
305
362
  }>;
306
363
  }>, t.TypeC<{
307
364
  type: t.LiteralC<"dismiss">;
@@ -323,10 +380,15 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
323
380
  }>, t.PartialC<{
324
381
  value: t.StringC;
325
382
  categoryFilter: t.NumberC;
326
- }>]>]>;
383
+ }>]>, t.TypeC<{
384
+ type: t.LiteralC<"open_helphub">;
385
+ }>, t.TypeC<{
386
+ type: t.LiteralC<"open_copilot">;
387
+ }>]>;
327
388
  }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
328
389
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
329
390
  object: t.StringC;
330
391
  hoverTooltip: t.BooleanC;
331
392
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
393
+ metadata: t.UnknownRecordC;
332
394
  }>]>]>]>;
@@ -0,0 +1,12 @@
1
+ import * as t from 'io-ts';
2
+ export declare const CopilotPersonalityAdjectiveV: t.UnionC<[t.LiteralC<"abrasive">, t.LiteralC<"adventurous">, t.LiteralC<"affable">, t.LiteralC<"arrogant">, t.LiteralC<"assertive">, t.LiteralC<"assured">, t.LiteralC<"belligerent">, t.LiteralC<"brave">, t.LiteralC<"cheerful">, t.LiteralC<"compassionate">, t.LiteralC<"condescending">, t.LiteralC<"courteous">, t.LiteralC<"creative">, t.LiteralC<"cynical">, t.LiteralC<"decisive">, t.LiteralC<"detached">, t.LiteralC<"diligent">, t.LiteralC<"eloquent">, t.LiteralC<"empathetic">, t.LiteralC<"evasive">, t.LiteralC<"formal">, t.LiteralC<"frivolous">, t.LiteralC<"garrulous">, t.LiteralC<"generous">, t.LiteralC<"impulsive">, t.LiteralC<"innovative">, t.LiteralC<"intense">, t.LiteralC<"judgmental">, t.LiteralC<"jovial">, t.LiteralC<"manipulative">, t.LiteralC<"obstinate">, t.LiteralC<"optimistic">, t.LiteralC<"perceptive">, t.LiteralC<"pessimistic">, t.LiteralC<"quarrelsome">, t.LiteralC<"respectful">, t.LiteralC<"resourceful">, t.LiteralC<"sarcastic">, t.LiteralC<"sincere">, t.LiteralC<"sociable">, t.LiteralC<"solemn">, t.LiteralC<"supportive">, t.LiteralC<"tactful">, t.LiteralC<"thoughtful">, t.LiteralC<"understanding">, t.LiteralC<"unreliable">, t.LiteralC<"vain">, t.LiteralC<"vivacious">, t.LiteralC<"warm">, t.LiteralC<"withdrawn">, t.LiteralC<"witty">, t.LiteralC<"zealous">]>;
3
+ export declare const CopilotPersonalityResponseLengthV: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
4
+ export declare const CopilotPersonalityResponseFormatV: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
5
+ export declare const CopilotPersonalityV: t.UnionC<[t.TypeC<{
6
+ template: t.UnionC<[t.LiteralC<"professional">, t.LiteralC<"friendly">, t.LiteralC<"confident">, t.LiteralC<"serious">, t.LiteralC<"empathetic">]>;
7
+ }>, t.TypeC<{
8
+ template: t.LiteralC<"custom">;
9
+ adjectives: t.ArrayC<t.UnionC<[t.LiteralC<"abrasive">, t.LiteralC<"adventurous">, t.LiteralC<"affable">, t.LiteralC<"arrogant">, t.LiteralC<"assertive">, t.LiteralC<"assured">, t.LiteralC<"belligerent">, t.LiteralC<"brave">, t.LiteralC<"cheerful">, t.LiteralC<"compassionate">, t.LiteralC<"condescending">, t.LiteralC<"courteous">, t.LiteralC<"creative">, t.LiteralC<"cynical">, t.LiteralC<"decisive">, t.LiteralC<"detached">, t.LiteralC<"diligent">, t.LiteralC<"eloquent">, t.LiteralC<"empathetic">, t.LiteralC<"evasive">, t.LiteralC<"formal">, t.LiteralC<"frivolous">, t.LiteralC<"garrulous">, t.LiteralC<"generous">, t.LiteralC<"impulsive">, t.LiteralC<"innovative">, t.LiteralC<"intense">, t.LiteralC<"judgmental">, t.LiteralC<"jovial">, t.LiteralC<"manipulative">, t.LiteralC<"obstinate">, t.LiteralC<"optimistic">, t.LiteralC<"perceptive">, t.LiteralC<"pessimistic">, t.LiteralC<"quarrelsome">, t.LiteralC<"respectful">, t.LiteralC<"resourceful">, t.LiteralC<"sarcastic">, t.LiteralC<"sincere">, t.LiteralC<"sociable">, t.LiteralC<"solemn">, t.LiteralC<"supportive">, t.LiteralC<"tactful">, t.LiteralC<"thoughtful">, t.LiteralC<"understanding">, t.LiteralC<"unreliable">, t.LiteralC<"vain">, t.LiteralC<"vivacious">, t.LiteralC<"warm">, t.LiteralC<"withdrawn">, t.LiteralC<"witty">, t.LiteralC<"zealous">]>>;
10
+ response_length: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
11
+ response_format: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
12
+ }>]>;
@@ -20,7 +20,9 @@ export declare const ConditionsMetGoal: t.TypeC<{
20
20
  export declare const CTAClickedGoal: t.TypeC<{
21
21
  type: t.LiteralC<"cta_clicked">;
22
22
  }>;
23
- export declare const EventTrackedGoal: t.TypeC<{
23
+ export declare const EventTrackedGoal: t.IntersectionC<[t.TypeC<{
24
24
  type: t.LiteralC<"event_tracked">;
25
25
  event: t.StringC;
26
- }>;
26
+ }>, t.PartialC<{
27
+ condition_group: t.UnionC<[t.Type<import("./rules").RuleExpression, import("./rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
28
+ }>]>;
@@ -1,4 +1,5 @@
1
1
  import * as t from 'io-ts';
2
+ import { IChecklist, INudgeType } from '../types';
2
3
  export declare const PushTriggerV: t.UnionC<[t.TypeC<{
3
4
  type: t.LiteralC<"when_conditions_pass">;
4
5
  }>, t.TypeC<{
@@ -15,6 +16,7 @@ export declare const PushTriggerV: t.UnionC<[t.TypeC<{
15
16
  type: t.LiteralC<"on_event">;
16
17
  meta: t.TypeC<{
17
18
  event: t.StringC;
19
+ condition_group: t.UnionC<[t.Type<import("./rules").RuleExpression, import("./rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
18
20
  }>;
19
21
  }>, t.TypeC<{
20
22
  type: t.LiteralC<"when_element_appears">;
@@ -27,6 +29,26 @@ export declare const PushTriggerV: t.UnionC<[t.TypeC<{
27
29
  type: t.LiteralC<"on_rage_click">;
28
30
  }>, t.TypeC<{
29
31
  type: t.LiteralC<"smart_delay">;
32
+ }>, t.TypeC<{
33
+ type: t.LiteralC<"after_time">;
34
+ meta: t.TypeC<{
35
+ unit: t.UnionC<[t.LiteralC<"minute">, t.LiteralC<"second">]>;
36
+ value: t.NumberC;
37
+ }>;
30
38
  }>, t.TypeC<{
31
39
  type: t.LiteralC<"when_share_link_viewed">;
40
+ }>, t.TypeC<{
41
+ type: t.LiteralC<"scheduled">;
42
+ meta: t.TypeC<{
43
+ interval: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"month">]>;
44
+ value: t.NumberC;
45
+ }>;
32
46
  }>]>;
47
+ export type TriggerableEntity = INudgeType | IChecklist;
48
+ export declare enum TriggerableEntityType {
49
+ NUDGE = "nudge",
50
+ CHECKLIST = "checklist"
51
+ }
52
+ export declare const isNudge: (triggerable: TriggerableEntity) => triggerable is INudgeType;
53
+ export type TriggerableEntityId = `${TriggerableEntityType}-${INudgeType['id'] | IChecklist['id']}`;
54
+ export declare const generateTriggerableEntityId: (triggerableEntity: TriggerableEntity) => TriggerableEntityId;