commandbar 1.9.0 → 1.10.0

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 +15 -10
  8. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  9. package/build/internal/src/client/symbols.d.ts +3 -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 +9 -0
  33. package/build/internal/src/middleware/nudge.d.ts +1103 -124
  34. package/build/internal/src/middleware/organization.d.ts +1295 -68
  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 +425 -0
  40. package/build/internal/src/middleware/types.d.ts +51 -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 +11 -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
@@ -24,14 +24,19 @@ export declare const RecommendationSetAdditionalV: t.TypeC<{
24
24
  actions: t.ArrayC<t.TypeC<{
25
25
  action: t.UnionC<[t.TypeC<{
26
26
  type: t.LiteralC<"execute_command">;
27
- meta: t.TypeC<{
27
+ meta: t.IntersectionC<[t.TypeC<{
28
28
  command: t.StringC;
29
- }>;
29
+ }>, t.PartialC<{
30
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
31
+ }>]>;
30
32
  }>, t.TypeC<{
31
33
  type: t.LiteralC<"no_action">;
32
34
  }>, t.TypeC<{
33
35
  type: t.LiteralC<"click">;
34
36
  value: t.StringC;
37
+ }>, t.TypeC<{
38
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
39
+ value: t.ArrayC<t.StringC>;
35
40
  }>, t.IntersectionC<[t.TypeC<{
36
41
  type: t.LiteralC<"link">;
37
42
  value: t.StringC;
@@ -40,7 +45,7 @@ export declare const RecommendationSetAdditionalV: t.TypeC<{
40
45
  }>]>, t.TypeC<{
41
46
  type: t.LiteralC<"open_chat">;
42
47
  meta: t.TypeC<{
43
- type: t.StringC;
48
+ 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<"">]>;
44
49
  }>;
45
50
  }>, t.TypeC<{
46
51
  type: t.LiteralC<"dismiss">;
@@ -62,7 +67,11 @@ export declare const RecommendationSetAdditionalV: t.TypeC<{
62
67
  }>, t.PartialC<{
63
68
  value: t.StringC;
64
69
  categoryFilter: t.NumberC;
65
- }>]>]>;
70
+ }>]>, t.TypeC<{
71
+ type: t.LiteralC<"open_helphub">;
72
+ }>, t.TypeC<{
73
+ type: t.LiteralC<"open_copilot">;
74
+ }>]>;
66
75
  cta: t.StringC;
67
76
  }>>;
68
77
  }>;
@@ -90,14 +99,19 @@ export declare const RecommendationSetV: t.IntersectionC<[t.TypeC<{
90
99
  actions: t.ArrayC<t.TypeC<{
91
100
  action: t.UnionC<[t.TypeC<{
92
101
  type: t.LiteralC<"execute_command">;
93
- meta: t.TypeC<{
102
+ meta: t.IntersectionC<[t.TypeC<{
94
103
  command: t.StringC;
95
- }>;
104
+ }>, t.PartialC<{
105
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
106
+ }>]>;
96
107
  }>, t.TypeC<{
97
108
  type: t.LiteralC<"no_action">;
98
109
  }>, t.TypeC<{
99
110
  type: t.LiteralC<"click">;
100
111
  value: t.StringC;
112
+ }>, t.TypeC<{
113
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
114
+ value: t.ArrayC<t.StringC>;
101
115
  }>, t.IntersectionC<[t.TypeC<{
102
116
  type: t.LiteralC<"link">;
103
117
  value: t.StringC;
@@ -106,7 +120,7 @@ export declare const RecommendationSetV: t.IntersectionC<[t.TypeC<{
106
120
  }>]>, t.TypeC<{
107
121
  type: t.LiteralC<"open_chat">;
108
122
  meta: t.TypeC<{
109
- type: t.StringC;
123
+ 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<"">]>;
110
124
  }>;
111
125
  }>, t.TypeC<{
112
126
  type: t.LiteralC<"dismiss">;
@@ -128,7 +142,11 @@ export declare const RecommendationSetV: t.IntersectionC<[t.TypeC<{
128
142
  }>, t.PartialC<{
129
143
  value: t.StringC;
130
144
  categoryFilter: t.NumberC;
131
- }>]>]>;
145
+ }>]>, t.TypeC<{
146
+ type: t.LiteralC<"open_helphub">;
147
+ }>, t.TypeC<{
148
+ type: t.LiteralC<"open_copilot">;
149
+ }>]>;
132
150
  cta: t.StringC;
133
151
  }>>;
134
152
  }>]>;
@@ -159,10 +177,15 @@ export declare class RecommendationSet {
159
177
  type: "execute_command";
160
178
  meta: {
161
179
  command: string;
180
+ } & {
181
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
162
182
  };
163
183
  } | {
164
184
  type: "click";
165
185
  value: string;
186
+ } | {
187
+ type: "click" | "clickBySelector" | "clickByXpath";
188
+ value: string[];
166
189
  } | ({
167
190
  type: "link";
168
191
  value: string;
@@ -171,7 +194,7 @@ export declare class RecommendationSet {
171
194
  }) | {
172
195
  type: "open_chat";
173
196
  meta: {
174
- type: string;
197
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
175
198
  };
176
199
  } | {
177
200
  type: "dismiss";
@@ -194,6 +217,10 @@ export declare class RecommendationSet {
194
217
  value?: string | undefined;
195
218
  categoryFilter?: number | undefined;
196
219
  }) | {
220
+ type: "open_helphub";
221
+ } | {
222
+ type: "open_copilot";
223
+ } | {
197
224
  type: "no_action";
198
225
  };
199
226
  cta: string;
@@ -225,10 +252,15 @@ export declare class RecommendationSet {
225
252
  type: "execute_command";
226
253
  meta: {
227
254
  command: string;
255
+ } & {
256
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
228
257
  };
229
258
  } | {
230
259
  type: "click";
231
260
  value: string;
261
+ } | {
262
+ type: "click" | "clickBySelector" | "clickByXpath";
263
+ value: string[];
232
264
  } | ({
233
265
  type: "link";
234
266
  value: string;
@@ -237,7 +269,7 @@ export declare class RecommendationSet {
237
269
  }) | {
238
270
  type: "open_chat";
239
271
  meta: {
240
- type: string;
272
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
241
273
  };
242
274
  } | {
243
275
  type: "dismiss";
@@ -260,6 +292,10 @@ export declare class RecommendationSet {
260
292
  value?: string | undefined;
261
293
  categoryFilter?: number | undefined;
262
294
  }) | {
295
+ type: "open_helphub";
296
+ } | {
297
+ type: "open_copilot";
298
+ } | {
263
299
  type: "no_action";
264
300
  };
265
301
  cta: string;
@@ -290,10 +326,15 @@ export declare class RecommendationSet {
290
326
  type: "execute_command";
291
327
  meta: {
292
328
  command: string;
329
+ } & {
330
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
293
331
  };
294
332
  } | {
295
333
  type: "click";
296
334
  value: string;
335
+ } | {
336
+ type: "click" | "clickBySelector" | "clickByXpath";
337
+ value: string[];
297
338
  } | ({
298
339
  type: "link";
299
340
  value: string;
@@ -302,7 +343,7 @@ export declare class RecommendationSet {
302
343
  }) | {
303
344
  type: "open_chat";
304
345
  meta: {
305
- type: string;
346
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
306
347
  };
307
348
  } | {
308
349
  type: "dismiss";
@@ -325,6 +366,10 @@ export declare class RecommendationSet {
325
366
  value?: string | undefined;
326
367
  categoryFilter?: number | undefined;
327
368
  }) | {
369
+ type: "open_helphub";
370
+ } | {
371
+ type: "open_copilot";
372
+ } | {
328
373
  type: "no_action";
329
374
  };
330
375
  cta: string;
@@ -356,10 +401,15 @@ export declare class RecommendationSet {
356
401
  type: "execute_command";
357
402
  meta: {
358
403
  command: string;
404
+ } & {
405
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
359
406
  };
360
407
  } | {
361
408
  type: "click";
362
409
  value: string;
410
+ } | {
411
+ type: "click" | "clickBySelector" | "clickByXpath";
412
+ value: string[];
363
413
  } | ({
364
414
  type: "link";
365
415
  value: string;
@@ -368,7 +418,7 @@ export declare class RecommendationSet {
368
418
  }) | {
369
419
  type: "open_chat";
370
420
  meta: {
371
- type: string;
421
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
372
422
  };
373
423
  } | {
374
424
  type: "dismiss";
@@ -391,6 +441,10 @@ export declare class RecommendationSet {
391
441
  value?: string | undefined;
392
442
  categoryFilter?: number | undefined;
393
443
  }) | {
444
+ type: "open_helphub";
445
+ } | {
446
+ type: "open_copilot";
447
+ } | {
394
448
  type: "no_action";
395
449
  };
396
450
  cta: string;
@@ -421,10 +475,15 @@ export declare class RecommendationSet {
421
475
  type: "execute_command";
422
476
  meta: {
423
477
  command: string;
478
+ } & {
479
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
424
480
  };
425
481
  } | {
426
482
  type: "click";
427
483
  value: string;
484
+ } | {
485
+ type: "click" | "clickBySelector" | "clickByXpath";
486
+ value: string[];
428
487
  } | ({
429
488
  type: "link";
430
489
  value: string;
@@ -433,7 +492,7 @@ export declare class RecommendationSet {
433
492
  }) | {
434
493
  type: "open_chat";
435
494
  meta: {
436
- type: string;
495
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
437
496
  };
438
497
  } | {
439
498
  type: "dismiss";
@@ -456,6 +515,10 @@ export declare class RecommendationSet {
456
515
  value?: string | undefined;
457
516
  categoryFilter?: number | undefined;
458
517
  }) | {
518
+ type: "open_helphub";
519
+ } | {
520
+ type: "open_copilot";
521
+ } | {
459
522
  type: "no_action";
460
523
  };
461
524
  cta: string;
@@ -488,10 +551,15 @@ export declare class RecommendationSet {
488
551
  type: "execute_command";
489
552
  meta: {
490
553
  command: string;
554
+ } & {
555
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
491
556
  };
492
557
  } | {
493
558
  type: "click";
494
559
  value: string;
560
+ } | {
561
+ type: "click" | "clickBySelector" | "clickByXpath";
562
+ value: string[];
495
563
  } | ({
496
564
  type: "link";
497
565
  value: string;
@@ -500,7 +568,7 @@ export declare class RecommendationSet {
500
568
  }) | {
501
569
  type: "open_chat";
502
570
  meta: {
503
- type: string;
571
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
504
572
  };
505
573
  } | {
506
574
  type: "dismiss";
@@ -523,6 +591,10 @@ export declare class RecommendationSet {
523
591
  value?: string | undefined;
524
592
  categoryFilter?: number | undefined;
525
593
  }) | {
594
+ type: "open_helphub";
595
+ } | {
596
+ type: "open_copilot";
597
+ } | {
526
598
  type: "no_action";
527
599
  };
528
600
  cta: string;
@@ -557,10 +629,15 @@ export declare class RecommendationSet {
557
629
  type: "execute_command";
558
630
  meta: {
559
631
  command: string;
632
+ } & {
633
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
560
634
  };
561
635
  } | {
562
636
  type: "click";
563
637
  value: string;
638
+ } | {
639
+ type: "click" | "clickBySelector" | "clickByXpath";
640
+ value: string[];
564
641
  } | ({
565
642
  type: "link";
566
643
  value: string;
@@ -569,7 +646,7 @@ export declare class RecommendationSet {
569
646
  }) | {
570
647
  type: "open_chat";
571
648
  meta: {
572
- type: string;
649
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
573
650
  };
574
651
  } | {
575
652
  type: "dismiss";
@@ -592,6 +669,10 @@ export declare class RecommendationSet {
592
669
  value?: string | undefined;
593
670
  categoryFilter?: number | undefined;
594
671
  }) | {
672
+ type: "open_helphub";
673
+ } | {
674
+ type: "open_copilot";
675
+ } | {
595
676
  type: "no_action";
596
677
  };
597
678
  cta: string;
@@ -1,5 +1,5 @@
1
1
  import * as t from 'io-ts';
2
- export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
2
+ export { RecordSettingsV, RecordSettingsByContextKeyV } from './RecordSettingsV';
3
3
  export { OrganizationV } from './OrganizationV';
4
4
  export declare const ReleaseV: t.TypeC<{
5
5
  created_by: t.UnionC<[t.StringC, t.NullC]>;