commandbar 1.13.0 → 1.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +2 -0
  2. package/build/commandbar-js/src/index.js +1 -1
  3. package/build/commandbar-js/src/init.d.ts +10 -1
  4. package/build/internal/src/client/CommandBarClientSDK.d.ts +4 -0
  5. package/build/internal/src/client/CommandBarProxySDK.d.ts +2 -3
  6. package/build/internal/src/client/SDKConfig.d.ts +1 -0
  7. package/build/internal/src/client/symbols.d.ts +2 -0
  8. package/build/internal/src/middleware/CommandFromClientV.d.ts +4 -0
  9. package/build/internal/src/middleware/OrganizationV.d.ts +56 -8
  10. package/build/internal/src/middleware/additionalResource.d.ts +200 -137
  11. package/build/internal/src/middleware/api.d.ts +7 -7
  12. package/build/internal/src/middleware/chat.d.ts +22868 -11601
  13. package/build/internal/src/middleware/checklist.d.ts +209 -139
  14. package/build/internal/src/middleware/command.d.ts +2547 -2170
  15. package/build/internal/src/middleware/endUser.d.ts +0 -32
  16. package/build/internal/src/middleware/experienceTemplate.d.ts +399 -263
  17. package/build/internal/src/middleware/experiencesSearch.d.ts +816 -718
  18. package/build/internal/src/middleware/flags.d.ts +6 -3
  19. package/build/internal/src/middleware/helpDocsSearch.d.ts +584 -514
  20. package/build/internal/src/middleware/helpers/actions.d.ts +66 -28
  21. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +18 -4
  22. package/build/internal/src/middleware/helpers/rules.d.ts +19 -4
  23. package/build/internal/src/middleware/nudge.d.ts +482 -281
  24. package/build/internal/src/middleware/organization.d.ts +825 -670
  25. package/build/internal/src/middleware/organizationSettings.d.ts +210 -130
  26. package/build/internal/src/middleware/profile.d.ts +1 -1
  27. package/build/internal/src/middleware/recommendationSet.d.ts +200 -137
  28. package/build/internal/src/middleware/theme.d.ts +7 -0
  29. package/build/internal/src/middleware/types.d.ts +16 -20
  30. package/package.json +1 -1
  31. package/src/init.ts +13 -2
  32. package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +0 -13
  33. package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +0 -53
  34. package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +0 -6
  35. package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +0 -152
  36. package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +0 -4
  37. package/build/internal/src/client/CommandBarSDK.d.ts +0 -99
  38. package/build/internal/src/client/globals.d.ts +0 -27
  39. package/build/internal/src/util/dispatchCustomEvent.d.ts +0 -14
  40. package/build/internal/src/util/sentry.d.ts +0 -23
@@ -1,5 +1,5 @@
1
1
  import * as t from 'io-ts';
2
- import { LabeledAction } from '../types';
2
+ import { ChatHandoffActionType, IOrganizationType, LabeledAction } from '../types';
3
3
  export declare const AdminAction: t.TypeC<{
4
4
  type: t.LiteralC<"admin">;
5
5
  value: t.StringC;
@@ -17,9 +17,11 @@ export declare const OpenBarAction: t.IntersectionC<[t.TypeC<{
17
17
  export declare const OpenHelpHubAction: t.TypeC<{
18
18
  type: t.LiteralC<"open_helphub">;
19
19
  }>;
20
- export declare const OpenCopilotAction: t.TypeC<{
20
+ export declare const OpenCopilotAction: t.IntersectionC<[t.TypeC<{
21
21
  type: t.LiteralC<"open_copilot">;
22
- }>;
22
+ }>, t.PartialC<{
23
+ query: t.StringC;
24
+ }>]>;
23
25
  export declare const LinkAction: t.IntersectionC<[t.TypeC<{
24
26
  type: t.LiteralC<"link">;
25
27
  value: t.StringC;
@@ -36,6 +38,14 @@ export declare const OpenChatActionV: t.TypeC<{
36
38
  type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
37
39
  }>;
38
40
  }>;
41
+ export declare const ChatHandoffActionTypeV: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
42
+ export declare const ChatHandoffActionV: t.TypeC<{
43
+ type: t.LiteralC<"chat_handoff">;
44
+ meta: t.TypeC<{
45
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
46
+ }>;
47
+ }>;
48
+ export declare const handoffNameToOrgKey: Record<Exclude<ChatHandoffActionType, ''>, keyof IOrganizationType['integrations']>;
39
49
  export declare const DismissAction: t.TypeC<{
40
50
  type: t.LiteralC<"dismiss">;
41
51
  }>;
@@ -139,6 +149,11 @@ export declare const ActionV: t.UnionC<[t.TypeC<{
139
149
  meta: t.TypeC<{
140
150
  type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
141
151
  }>;
152
+ }>, t.TypeC<{
153
+ type: t.LiteralC<"chat_handoff">;
154
+ meta: t.TypeC<{
155
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
156
+ }>;
142
157
  }>, t.TypeC<{
143
158
  type: t.LiteralC<"dismiss">;
144
159
  }>, t.TypeC<{
@@ -161,9 +176,11 @@ export declare const ActionV: t.UnionC<[t.TypeC<{
161
176
  categoryFilter: t.NumberC;
162
177
  }>]>, t.TypeC<{
163
178
  type: t.LiteralC<"open_helphub">;
164
- }>, t.TypeC<{
179
+ }>, t.IntersectionC<[t.TypeC<{
165
180
  type: t.LiteralC<"open_copilot">;
166
- }>]>;
181
+ }>, t.PartialC<{
182
+ query: t.StringC;
183
+ }>]>]>;
167
184
  export declare const LabeledActionV: t.TypeC<{
168
185
  cta: t.StringC;
169
186
  action: t.UnionC<[t.TypeC<{
@@ -194,6 +211,11 @@ export declare const LabeledActionV: t.TypeC<{
194
211
  meta: t.TypeC<{
195
212
  type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
196
213
  }>;
214
+ }>, t.TypeC<{
215
+ type: t.LiteralC<"chat_handoff">;
216
+ meta: t.TypeC<{
217
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
218
+ }>;
197
219
  }>, t.TypeC<{
198
220
  type: t.LiteralC<"dismiss">;
199
221
  }>, t.TypeC<{
@@ -216,37 +238,46 @@ export declare const LabeledActionV: t.TypeC<{
216
238
  categoryFilter: t.NumberC;
217
239
  }>]>, t.TypeC<{
218
240
  type: t.LiteralC<"open_helphub">;
219
- }>, t.TypeC<{
241
+ }>, t.IntersectionC<[t.TypeC<{
220
242
  type: t.LiteralC<"open_copilot">;
221
- }>]>;
243
+ }>, t.PartialC<{
244
+ query: t.StringC;
245
+ }>]>]>;
222
246
  }>;
223
247
  export declare const isAction: (o: string | number | LabeledAction) => o is {
224
248
  cta: string;
225
- action: {
249
+ action: ({
250
+ type: "link";
251
+ value: string;
252
+ } & {
253
+ operation?: "self" | "router" | "blank" | undefined;
254
+ meta?: {
255
+ command: string;
256
+ } | undefined;
257
+ }) | {
258
+ type: "click" | "clickBySelector" | "clickByXpath";
259
+ value: string[];
260
+ } | {
226
261
  type: "execute_command";
227
262
  meta: {
228
263
  command: string;
229
264
  } & {
230
265
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
231
266
  };
267
+ } | {
268
+ type: "no_action";
232
269
  } | {
233
270
  type: "click";
234
271
  value: string;
235
272
  } | {
236
- type: "click" | "clickBySelector" | "clickByXpath";
237
- value: string[];
238
- } | ({
239
- type: "link";
240
- value: string;
241
- } & {
242
- operation?: "self" | "router" | "blank" | undefined;
243
- meta?: {
244
- command: string;
245
- } | undefined;
246
- }) | {
247
273
  type: "open_chat";
248
274
  meta: {
249
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
275
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
276
+ };
277
+ } | {
278
+ type: "chat_handoff";
279
+ meta: {
280
+ type: "" | "intercom" | "freshchat" | "zendesk";
250
281
  };
251
282
  } | {
252
283
  type: "dismiss";
@@ -255,14 +286,14 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
255
286
  } | {
256
287
  type: "questlist";
257
288
  value: number;
258
- } | {
259
- type: "step_back";
260
289
  } | {
261
290
  type: "nudge";
262
291
  value: number;
263
292
  } | {
264
293
  type: "go_to_step";
265
294
  value: number;
295
+ } | {
296
+ type: "step_back";
266
297
  } | ({
267
298
  type: "open_bar";
268
299
  } & {
@@ -270,11 +301,11 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
270
301
  categoryFilter?: number | undefined;
271
302
  }) | {
272
303
  type: "open_helphub";
273
- } | {
304
+ } | ({
274
305
  type: "open_copilot";
275
- } | {
276
- type: "no_action";
277
- };
306
+ } & {
307
+ query?: string | undefined;
308
+ });
278
309
  };
279
310
  export declare const RequestV: t.IntersectionC<[t.TypeC<{
280
311
  method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
@@ -329,6 +360,11 @@ export declare const TriggerAction: t.TypeC<{
329
360
  meta: t.TypeC<{
330
361
  type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
331
362
  }>;
363
+ }>, t.TypeC<{
364
+ type: t.LiteralC<"chat_handoff">;
365
+ meta: t.TypeC<{
366
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
367
+ }>;
332
368
  }>, t.TypeC<{
333
369
  type: t.LiteralC<"dismiss">;
334
370
  }>, t.TypeC<{
@@ -351,7 +387,9 @@ export declare const TriggerAction: t.TypeC<{
351
387
  categoryFilter: t.NumberC;
352
388
  }>]>, t.TypeC<{
353
389
  type: t.LiteralC<"open_helphub">;
354
- }>, t.TypeC<{
390
+ }>, t.IntersectionC<[t.TypeC<{
355
391
  type: t.LiteralC<"open_copilot">;
356
- }>]>;
392
+ }>, t.PartialC<{
393
+ query: t.StringC;
394
+ }>]>]>;
357
395
  }>;
@@ -180,6 +180,11 @@ export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
180
180
  meta: t.TypeC<{
181
181
  type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
182
182
  }>;
183
+ }>, t.TypeC<{
184
+ type: t.LiteralC<"chat_handoff">;
185
+ meta: t.TypeC<{
186
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
187
+ }>;
183
188
  }>, t.TypeC<{
184
189
  type: t.LiteralC<"dismiss">;
185
190
  }>, t.TypeC<{
@@ -202,9 +207,11 @@ export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
202
207
  categoryFilter: t.NumberC;
203
208
  }>]>, t.TypeC<{
204
209
  type: t.LiteralC<"open_helphub">;
205
- }>, t.TypeC<{
210
+ }>, t.IntersectionC<[t.TypeC<{
206
211
  type: t.LiteralC<"open_copilot">;
207
- }>]>;
212
+ }>, t.PartialC<{
213
+ query: t.StringC;
214
+ }>]>]>;
208
215
  }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
209
216
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
210
217
  object: t.StringC;
@@ -372,6 +379,11 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
372
379
  meta: t.TypeC<{
373
380
  type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
374
381
  }>;
382
+ }>, t.TypeC<{
383
+ type: t.LiteralC<"chat_handoff">;
384
+ meta: t.TypeC<{
385
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
386
+ }>;
375
387
  }>, t.TypeC<{
376
388
  type: t.LiteralC<"dismiss">;
377
389
  }>, t.TypeC<{
@@ -394,9 +406,11 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
394
406
  categoryFilter: t.NumberC;
395
407
  }>]>, t.TypeC<{
396
408
  type: t.LiteralC<"open_helphub">;
397
- }>, t.TypeC<{
409
+ }>, t.IntersectionC<[t.TypeC<{
398
410
  type: t.LiteralC<"open_copilot">;
399
- }>]>;
411
+ }>, t.PartialC<{
412
+ query: t.StringC;
413
+ }>]>]>;
400
414
  }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
401
415
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
402
416
  object: t.StringC;
@@ -1,14 +1,17 @@
1
1
  import * as t from 'io-ts';
2
2
  import { IRecommendationSet } from '../types';
3
- export declare const listOperators: readonly ["includes", "doesNotInclude"];
3
+ export declare const listOperators: readonly ["isInList", "isNotInList"];
4
+ export declare const legacyListOperators: readonly ["includes", "doesNotInclude"];
4
5
  export declare const equalityOperators: readonly ["is", "isNot"];
5
6
  export declare const numericOperators: readonly ["isGreaterThan", "isLessThan"];
6
- export declare const operators: readonly ["isTrue", "isFalse", "isTruthy", "isFalsy", "startsWith", "endsWith", "matchesRegex", "isDefined", "isNotDefined", "classnameOnPage", "idOnPage", "selectorOnPage", "classnameNotOnPage", "idNotOnPage", "selectorNotOnPage", "includes", "doesNotInclude", "is", "isNot", "isGreaterThan", "isLessThan"];
7
+ export declare const operators: readonly ["isInList", "isNotInList", "isTrue", "isFalse", "isTruthy", "isFalsy", "startsWith", "endsWith", "matchesRegex", "isDefined", "isNotDefined", "classnameOnPage", "idOnPage", "selectorOnPage", "classnameNotOnPage", "idNotOnPage", "selectorNotOnPage", "includes", "doesNotInclude", "is", "isNot", "isGreaterThan", "isLessThan"];
7
8
  export declare const OperatorV: t.KeyofC<{
8
9
  includes: null;
9
10
  endsWith: null;
10
11
  startsWith: null;
11
12
  is: null;
13
+ isInList: null;
14
+ isNotInList: null;
12
15
  isTrue: null;
13
16
  isFalse: null;
14
17
  isTruthy: null;
@@ -87,6 +90,8 @@ export declare const SingleValueConditionV: t.UnionC<[t.IntersectionC<[t.TypeC<{
87
90
  endsWith: null;
88
91
  startsWith: null;
89
92
  is: null;
93
+ isInList: null;
94
+ isNotInList: null;
90
95
  isTrue: null;
91
96
  isFalse: null;
92
97
  isTruthy: null;
@@ -138,6 +143,8 @@ export declare const ConditionV: t.UnionC<[t.UnionC<[t.IntersectionC<[t.TypeC<{
138
143
  endsWith: null;
139
144
  startsWith: null;
140
145
  is: null;
146
+ isInList: null;
147
+ isNotInList: null;
141
148
  isTrue: null;
142
149
  isFalse: null;
143
150
  isTruthy: null;
@@ -241,6 +248,8 @@ export declare const AvailabilityRuleV: t.UnionC<[t.UnionC<[t.IntersectionC<[t.T
241
248
  endsWith: null;
242
249
  startsWith: null;
243
250
  is: null;
251
+ isInList: null;
252
+ isNotInList: null;
244
253
  isTrue: null;
245
254
  isFalse: null;
246
255
  isTruthy: null;
@@ -309,6 +318,8 @@ export declare const RecommendationRuleV: t.UnionC<[t.IntersectionC<[t.TypeC<{
309
318
  endsWith: null;
310
319
  startsWith: null;
311
320
  is: null;
321
+ isInList: null;
322
+ isNotInList: null;
312
323
  isTrue: null;
313
324
  isFalse: null;
314
325
  isTruthy: null;
@@ -369,6 +380,8 @@ export declare const EditorAvailabilityRuleV: t.UnionC<[t.UnionC<[t.UnionC<[t.In
369
380
  endsWith: null;
370
381
  startsWith: null;
371
382
  is: null;
383
+ isInList: null;
384
+ isNotInList: null;
372
385
  isTrue: null;
373
386
  isFalse: null;
374
387
  isTruthy: null;
@@ -442,6 +455,8 @@ export declare const EditorRecommendationRuleV: t.UnionC<[t.UnionC<[t.Intersecti
442
455
  endsWith: null;
443
456
  startsWith: null;
444
457
  is: null;
458
+ isInList: null;
459
+ isNotInList: null;
445
460
  isTrue: null;
446
461
  isFalse: null;
447
462
  isTruthy: null;
@@ -542,8 +557,8 @@ export type ABTestCondition = ExpressionCondition & {
542
557
  value: string;
543
558
  };
544
559
  export declare const isABTestCondition: (condition: ExpressionCondition) => condition is {
545
- type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
546
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
560
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
561
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
547
562
  } & {
548
563
  field?: string | undefined;
549
564
  value?: string | undefined;