commandbar 1.9.0 → 1.10.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 (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
@@ -10,14 +10,19 @@ export declare const AdditionalResourceV: t.IntersectionC<[t.TypeC<{}>, t.Inters
10
10
  label: t.StringC;
11
11
  action: t.UnionC<[t.TypeC<{
12
12
  type: t.LiteralC<"execute_command">;
13
- meta: t.TypeC<{
13
+ meta: t.IntersectionC<[t.TypeC<{
14
14
  command: t.StringC;
15
- }>;
15
+ }>, t.PartialC<{
16
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
17
+ }>]>;
16
18
  }>, t.TypeC<{
17
19
  type: t.LiteralC<"no_action">;
18
20
  }>, t.TypeC<{
19
21
  type: t.LiteralC<"click">;
20
22
  value: t.StringC;
23
+ }>, t.TypeC<{
24
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
25
+ value: t.ArrayC<t.StringC>;
21
26
  }>, t.IntersectionC<[t.TypeC<{
22
27
  type: t.LiteralC<"link">;
23
28
  value: t.StringC;
@@ -26,7 +31,7 @@ export declare const AdditionalResourceV: t.IntersectionC<[t.TypeC<{}>, t.Inters
26
31
  }>]>, t.TypeC<{
27
32
  type: t.LiteralC<"open_chat">;
28
33
  meta: t.TypeC<{
29
- type: t.StringC;
34
+ 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<"">]>;
30
35
  }>;
31
36
  }>, t.TypeC<{
32
37
  type: t.LiteralC<"dismiss">;
@@ -48,7 +53,11 @@ export declare const AdditionalResourceV: t.IntersectionC<[t.TypeC<{}>, t.Inters
48
53
  }>, t.PartialC<{
49
54
  value: t.StringC;
50
55
  categoryFilter: t.NumberC;
51
- }>]>]>;
56
+ }>]>, t.TypeC<{
57
+ type: t.LiteralC<"open_helphub">;
58
+ }>, t.TypeC<{
59
+ type: t.LiteralC<"open_copilot">;
60
+ }>]>;
52
61
  show_as_primary_cta: t.BooleanC;
53
62
  }>, t.PartialC<{}>]>]>;
54
63
  export declare const BatchAdditionalResourceResponseV: t.TypeC<{
@@ -62,14 +71,19 @@ export declare const BatchAdditionalResourceResponseV: t.TypeC<{
62
71
  label: t.StringC;
63
72
  action: t.UnionC<[t.TypeC<{
64
73
  type: t.LiteralC<"execute_command">;
65
- meta: t.TypeC<{
74
+ meta: t.IntersectionC<[t.TypeC<{
66
75
  command: t.StringC;
67
- }>;
76
+ }>, t.PartialC<{
77
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
78
+ }>]>;
68
79
  }>, t.TypeC<{
69
80
  type: t.LiteralC<"no_action">;
70
81
  }>, t.TypeC<{
71
82
  type: t.LiteralC<"click">;
72
83
  value: t.StringC;
84
+ }>, t.TypeC<{
85
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
86
+ value: t.ArrayC<t.StringC>;
73
87
  }>, t.IntersectionC<[t.TypeC<{
74
88
  type: t.LiteralC<"link">;
75
89
  value: t.StringC;
@@ -78,7 +92,7 @@ export declare const BatchAdditionalResourceResponseV: t.TypeC<{
78
92
  }>]>, t.TypeC<{
79
93
  type: t.LiteralC<"open_chat">;
80
94
  meta: t.TypeC<{
81
- type: t.StringC;
95
+ 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<"">]>;
82
96
  }>;
83
97
  }>, t.TypeC<{
84
98
  type: t.LiteralC<"dismiss">;
@@ -100,7 +114,11 @@ export declare const BatchAdditionalResourceResponseV: t.TypeC<{
100
114
  }>, t.PartialC<{
101
115
  value: t.StringC;
102
116
  categoryFilter: t.NumberC;
103
- }>]>]>;
117
+ }>]>, t.TypeC<{
118
+ type: t.LiteralC<"open_helphub">;
119
+ }>, t.TypeC<{
120
+ type: t.LiteralC<"open_copilot">;
121
+ }>]>;
104
122
  show_as_primary_cta: t.BooleanC;
105
123
  }>, t.PartialC<{}>]>]>>;
106
124
  }>;
@@ -116,10 +134,15 @@ export declare const decode: (data: any) => {} & {
116
134
  type: "execute_command";
117
135
  meta: {
118
136
  command: string;
137
+ } & {
138
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
119
139
  };
120
140
  } | {
121
141
  type: "click";
122
142
  value: string;
143
+ } | {
144
+ type: "click" | "clickBySelector" | "clickByXpath";
145
+ value: string[];
123
146
  } | ({
124
147
  type: "link";
125
148
  value: string;
@@ -128,7 +151,7 @@ export declare const decode: (data: any) => {} & {
128
151
  }) | {
129
152
  type: "open_chat";
130
153
  meta: {
131
- type: string;
154
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
132
155
  };
133
156
  } | {
134
157
  type: "dismiss";
@@ -151,6 +174,10 @@ export declare const decode: (data: any) => {} & {
151
174
  value?: string | undefined;
152
175
  categoryFilter?: number | undefined;
153
176
  }) | {
177
+ type: "open_helphub";
178
+ } | {
179
+ type: "open_copilot";
180
+ } | {
154
181
  type: "no_action";
155
182
  };
156
183
  show_as_primary_cta: boolean;
@@ -167,10 +194,15 @@ export declare const list: (onSuccess?: (() => void) | undefined, onError?: ((er
167
194
  type: "execute_command";
168
195
  meta: {
169
196
  command: string;
197
+ } & {
198
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
170
199
  };
171
200
  } | {
172
201
  type: "click";
173
202
  value: string;
203
+ } | {
204
+ type: "click" | "clickBySelector" | "clickByXpath";
205
+ value: string[];
174
206
  } | ({
175
207
  type: "link";
176
208
  value: string;
@@ -179,7 +211,7 @@ export declare const list: (onSuccess?: (() => void) | undefined, onError?: ((er
179
211
  }) | {
180
212
  type: "open_chat";
181
213
  meta: {
182
- type: string;
214
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
183
215
  };
184
216
  } | {
185
217
  type: "dismiss";
@@ -202,6 +234,10 @@ export declare const list: (onSuccess?: (() => void) | undefined, onError?: ((er
202
234
  value?: string | undefined;
203
235
  categoryFilter?: number | undefined;
204
236
  }) | {
237
+ type: "open_helphub";
238
+ } | {
239
+ type: "open_copilot";
240
+ } | {
205
241
  type: "no_action";
206
242
  };
207
243
  show_as_primary_cta: boolean;
@@ -218,10 +254,15 @@ export declare const create: (object: {} & {
218
254
  type: "execute_command";
219
255
  meta: {
220
256
  command: string;
257
+ } & {
258
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
221
259
  };
222
260
  } | {
223
261
  type: "click";
224
262
  value: string;
263
+ } | {
264
+ type: "click" | "clickBySelector" | "clickByXpath";
265
+ value: string[];
225
266
  } | ({
226
267
  type: "link";
227
268
  value: string;
@@ -230,7 +271,7 @@ export declare const create: (object: {} & {
230
271
  }) | {
231
272
  type: "open_chat";
232
273
  meta: {
233
- type: string;
274
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
234
275
  };
235
276
  } | {
236
277
  type: "dismiss";
@@ -253,6 +294,10 @@ export declare const create: (object: {} & {
253
294
  value?: string | undefined;
254
295
  categoryFilter?: number | undefined;
255
296
  }) | {
297
+ type: "open_helphub";
298
+ } | {
299
+ type: "open_copilot";
300
+ } | {
256
301
  type: "no_action";
257
302
  };
258
303
  show_as_primary_cta: boolean;
@@ -268,10 +313,15 @@ export declare const create: (object: {} & {
268
313
  type: "execute_command";
269
314
  meta: {
270
315
  command: string;
316
+ } & {
317
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
271
318
  };
272
319
  } | {
273
320
  type: "click";
274
321
  value: string;
322
+ } | {
323
+ type: "click" | "clickBySelector" | "clickByXpath";
324
+ value: string[];
275
325
  } | ({
276
326
  type: "link";
277
327
  value: string;
@@ -280,7 +330,7 @@ export declare const create: (object: {} & {
280
330
  }) | {
281
331
  type: "open_chat";
282
332
  meta: {
283
- type: string;
333
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
284
334
  };
285
335
  } | {
286
336
  type: "dismiss";
@@ -303,6 +353,10 @@ export declare const create: (object: {} & {
303
353
  value?: string | undefined;
304
354
  categoryFilter?: number | undefined;
305
355
  }) | {
356
+ type: "open_helphub";
357
+ } | {
358
+ type: "open_copilot";
359
+ } | {
306
360
  type: "no_action";
307
361
  };
308
362
  show_as_primary_cta: boolean;
@@ -320,10 +374,15 @@ export declare const update: (object: {} & {
320
374
  type: "execute_command";
321
375
  meta: {
322
376
  command: string;
377
+ } & {
378
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
323
379
  };
324
380
  } | {
325
381
  type: "click";
326
382
  value: string;
383
+ } | {
384
+ type: "click" | "clickBySelector" | "clickByXpath";
385
+ value: string[];
327
386
  } | ({
328
387
  type: "link";
329
388
  value: string;
@@ -332,7 +391,7 @@ export declare const update: (object: {} & {
332
391
  }) | {
333
392
  type: "open_chat";
334
393
  meta: {
335
- type: string;
394
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
336
395
  };
337
396
  } | {
338
397
  type: "dismiss";
@@ -355,6 +414,10 @@ export declare const update: (object: {} & {
355
414
  value?: string | undefined;
356
415
  categoryFilter?: number | undefined;
357
416
  }) | {
417
+ type: "open_helphub";
418
+ } | {
419
+ type: "open_copilot";
420
+ } | {
358
421
  type: "no_action";
359
422
  };
360
423
  show_as_primary_cta: boolean;
@@ -370,10 +433,15 @@ export declare const update: (object: {} & {
370
433
  type: "execute_command";
371
434
  meta: {
372
435
  command: string;
436
+ } & {
437
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
373
438
  };
374
439
  } | {
375
440
  type: "click";
376
441
  value: string;
442
+ } | {
443
+ type: "click" | "clickBySelector" | "clickByXpath";
444
+ value: string[];
377
445
  } | ({
378
446
  type: "link";
379
447
  value: string;
@@ -382,7 +450,7 @@ export declare const update: (object: {} & {
382
450
  }) | {
383
451
  type: "open_chat";
384
452
  meta: {
385
- type: string;
453
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
386
454
  };
387
455
  } | {
388
456
  type: "dismiss";
@@ -405,6 +473,10 @@ export declare const update: (object: {} & {
405
473
  value?: string | undefined;
406
474
  categoryFilter?: number | undefined;
407
475
  }) | {
476
+ type: "open_helphub";
477
+ } | {
478
+ type: "open_copilot";
479
+ } | {
408
480
  type: "no_action";
409
481
  };
410
482
  show_as_primary_cta: boolean;
@@ -422,10 +494,15 @@ export declare const batch: (request: t.TypeOf<typeof GenericBatchRequest>) => P
422
494
  type: "execute_command";
423
495
  meta: {
424
496
  command: string;
497
+ } & {
498
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
425
499
  };
426
500
  } | {
427
501
  type: "click";
428
502
  value: string;
503
+ } | {
504
+ type: "click" | "clickBySelector" | "clickByXpath";
505
+ value: string[];
429
506
  } | ({
430
507
  type: "link";
431
508
  value: string;
@@ -434,7 +511,7 @@ export declare const batch: (request: t.TypeOf<typeof GenericBatchRequest>) => P
434
511
  }) | {
435
512
  type: "open_chat";
436
513
  meta: {
437
- type: string;
514
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
438
515
  };
439
516
  } | {
440
517
  type: "dismiss";
@@ -457,6 +534,10 @@ export declare const batch: (request: t.TypeOf<typeof GenericBatchRequest>) => P
457
534
  value?: string | undefined;
458
535
  categoryFilter?: number | undefined;
459
536
  }) | {
537
+ type: "open_helphub";
538
+ } | {
539
+ type: "open_copilot";
540
+ } | {
460
541
  type: "no_action";
461
542
  };
462
543
  show_as_primary_cta: boolean;
@@ -1,7 +1,6 @@
1
1
  import * as t from 'io-ts';
2
2
  export declare const BillingProfileV: t.TypeC<{
3
3
  organization: t.StringC;
4
- price_cents: t.NumberC;
5
4
  tier: t.StringC;
6
5
  discount_cents: t.NumberC;
7
6
  name: t.StringC;
@@ -58,7 +57,6 @@ export declare class Billing {
58
57
  onError?: ((err: string) => void) | undefined;
59
58
  } | undefined) => Promise<{
60
59
  organization: string;
61
- price_cents: number;
62
60
  tier: string;
63
61
  discount_cents: number;
64
62
  name: string;