commandbar 1.8.7 → 1.9.0

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 (41) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/internal/src/client/AddContextOptions.d.ts +4 -0
  3. package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
  4. package/build/internal/src/client/CommandBarClientSDK.d.ts +25 -7
  5. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  6. package/build/internal/src/client/CommandBarSDK.d.ts +23 -12
  7. package/build/internal/src/client/EventHandler.d.ts +19 -5
  8. package/build/internal/src/client/globals.d.ts +6 -0
  9. package/build/internal/src/client/symbols.d.ts +11 -6
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +68 -10
  11. package/build/internal/src/middleware/OrganizationV.d.ts +124 -20
  12. package/build/internal/src/middleware/additionalResource.d.ts +178 -16
  13. package/build/internal/src/middleware/billing.d.ts +33 -0
  14. package/build/internal/src/middleware/chat.d.ts +10913 -0
  15. package/build/internal/src/middleware/checklist.d.ts +106 -28
  16. package/build/internal/src/middleware/command.d.ts +3778 -446
  17. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  18. package/build/internal/src/middleware/endUser.d.ts +104 -0
  19. package/build/internal/src/middleware/generics.d.ts +12 -11
  20. package/build/internal/src/middleware/helpDocsIntegration.d.ts +54 -8
  21. package/build/internal/src/middleware/helpDocsSearch.d.ts +2204 -0
  22. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  23. package/build/internal/src/middleware/helpers/actions.d.ts +116 -8
  24. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +82 -2
  25. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +6 -0
  26. package/build/internal/src/middleware/helpers/rules.d.ts +285 -26
  27. package/build/internal/src/middleware/network.d.ts +18 -3
  28. package/build/internal/src/middleware/nudge.d.ts +1193 -43
  29. package/build/internal/src/middleware/organization.d.ts +1051 -141
  30. package/build/internal/src/middleware/organizationSettings.d.ts +129 -22
  31. package/build/internal/src/middleware/recommendationSet.d.ts +408 -1007
  32. package/build/internal/src/middleware/types.d.ts +43 -25
  33. package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -1
  34. package/build/internal/src/util/operatingSystem.d.ts +13 -0
  35. package/build/internal/src/util/sentry.d.ts +23 -0
  36. package/package.json +3 -3
  37. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  38. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  39. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  40. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  41. package/build/internal/src/util/integrations.d.ts +0 -1
package/build/internal/src/middleware/checklist.d.ts CHANGED
@@ -78,6 +78,12 @@ export declare const ChecklistBaseV: t.IntersectionC<[t.TypeC<{
78
78
  meta: t.TypeC<{
79
79
  selector: t.StringC;
80
80
  }>;
81
+ }>, t.TypeC<{
82
+ type: t.LiteralC<"on_user_confusion">;
83
+ }>, t.TypeC<{
84
+ type: t.LiteralC<"on_rage_click">;
85
+ }>, t.TypeC<{
86
+ type: t.LiteralC<"smart_delay">;
81
87
  }>, t.TypeC<{
82
88
  type: t.LiteralC<"when_share_link_viewed">;
83
89
  }>]>;
@@ -178,6 +184,12 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
178
184
  meta: t.TypeC<{
179
185
  selector: t.StringC;
180
186
  }>;
187
+ }>, t.TypeC<{
188
+ type: t.LiteralC<"on_user_confusion">;
189
+ }>, t.TypeC<{
190
+ type: t.LiteralC<"on_rage_click">;
191
+ }>, t.TypeC<{
192
+ type: t.LiteralC<"smart_delay">;
181
193
  }>, t.TypeC<{
182
194
  type: t.LiteralC<"when_share_link_viewed">;
183
195
  }>]>;
@@ -258,6 +270,9 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
258
270
  skippable: t.BooleanC;
259
271
  open_by_default: t.BooleanC;
260
272
  share_page_url: t.StringC;
273
+ copilot_suggest: t.BooleanC;
274
+ copilot_cta_label: t.StringC;
275
+ copilot_description: t.StringC;
261
276
  }>]>;
262
277
  export declare class Checklist {
263
278
  static decode: (data: any) => {
@@ -286,6 +301,12 @@ export declare class Checklist {
286
301
  meta: {
287
302
  selector: string;
288
303
  };
304
+ } | {
305
+ type: "on_user_confusion";
306
+ } | {
307
+ type: "on_rage_click";
308
+ } | {
309
+ type: "smart_delay";
289
310
  } | {
290
311
  type: "when_share_link_viewed";
291
312
  };
@@ -325,9 +346,6 @@ export declare class Checklist {
325
346
  } & {
326
347
  operation?: "self" | "router" | "blank" | undefined;
327
348
  }) | {
328
- type: "click" | "clickByXpath" | "clickBySelector";
329
- value: string[];
330
- } | {
331
349
  type: "nudge";
332
350
  value: number;
333
351
  } | ({
@@ -335,7 +353,10 @@ export declare class Checklist {
335
353
  } & {
336
354
  value?: string | undefined;
337
355
  categoryFilter?: number | undefined;
338
- });
356
+ }) | {
357
+ type: "click" | "clickByXpath" | "clickBySelector";
358
+ value: string[];
359
+ };
339
360
  celebrate: boolean;
340
361
  } & {
341
362
  description?: string | undefined;
@@ -366,6 +387,9 @@ export declare class Checklist {
366
387
  skippable: boolean;
367
388
  open_by_default: boolean;
368
389
  share_page_url: string;
390
+ copilot_suggest: boolean;
391
+ copilot_cta_label: string;
392
+ copilot_description: string;
369
393
  };
370
394
  static create: (object: {
371
395
  id: number;
@@ -393,6 +417,12 @@ export declare class Checklist {
393
417
  meta: {
394
418
  selector: string;
395
419
  };
420
+ } | {
421
+ type: "on_user_confusion";
422
+ } | {
423
+ type: "on_rage_click";
424
+ } | {
425
+ type: "smart_delay";
396
426
  } | {
397
427
  type: "when_share_link_viewed";
398
428
  };
@@ -432,9 +462,6 @@ export declare class Checklist {
432
462
  } & {
433
463
  operation?: "self" | "router" | "blank" | undefined;
434
464
  }) | {
435
- type: "click" | "clickByXpath" | "clickBySelector";
436
- value: string[];
437
- } | {
438
465
  type: "nudge";
439
466
  value: number;
440
467
  } | ({
@@ -442,7 +469,10 @@ export declare class Checklist {
442
469
  } & {
443
470
  value?: string | undefined;
444
471
  categoryFilter?: number | undefined;
445
- });
472
+ }) | {
473
+ type: "click" | "clickByXpath" | "clickBySelector";
474
+ value: string[];
475
+ };
446
476
  celebrate: boolean;
447
477
  } & {
448
478
  description?: string | undefined;
@@ -473,6 +503,9 @@ export declare class Checklist {
473
503
  skippable: boolean;
474
504
  open_by_default: boolean;
475
505
  share_page_url: string;
506
+ copilot_suggest: boolean;
507
+ copilot_cta_label: string;
508
+ copilot_description: string;
476
509
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
477
510
  id: number;
478
511
  title: string;
@@ -499,6 +532,12 @@ export declare class Checklist {
499
532
  meta: {
500
533
  selector: string;
501
534
  };
535
+ } | {
536
+ type: "on_user_confusion";
537
+ } | {
538
+ type: "on_rage_click";
539
+ } | {
540
+ type: "smart_delay";
502
541
  } | {
503
542
  type: "when_share_link_viewed";
504
543
  };
@@ -538,9 +577,6 @@ export declare class Checklist {
538
577
  } & {
539
578
  operation?: "self" | "router" | "blank" | undefined;
540
579
  }) | {
541
- type: "click" | "clickByXpath" | "clickBySelector";
542
- value: string[];
543
- } | {
544
580
  type: "nudge";
545
581
  value: number;
546
582
  } | ({
@@ -548,7 +584,10 @@ export declare class Checklist {
548
584
  } & {
549
585
  value?: string | undefined;
550
586
  categoryFilter?: number | undefined;
551
- });
587
+ }) | {
588
+ type: "click" | "clickByXpath" | "clickBySelector";
589
+ value: string[];
590
+ };
552
591
  celebrate: boolean;
553
592
  } & {
554
593
  description?: string | undefined;
@@ -579,6 +618,9 @@ export declare class Checklist {
579
618
  skippable: boolean;
580
619
  open_by_default: boolean;
581
620
  share_page_url: string;
621
+ copilot_suggest: boolean;
622
+ copilot_cta_label: string;
623
+ copilot_description: string;
582
624
  }>;
583
625
  static update: (object: {
584
626
  id: number;
@@ -606,6 +648,12 @@ export declare class Checklist {
606
648
  meta: {
607
649
  selector: string;
608
650
  };
651
+ } | {
652
+ type: "on_user_confusion";
653
+ } | {
654
+ type: "on_rage_click";
655
+ } | {
656
+ type: "smart_delay";
609
657
  } | {
610
658
  type: "when_share_link_viewed";
611
659
  };
@@ -645,9 +693,6 @@ export declare class Checklist {
645
693
  } & {
646
694
  operation?: "self" | "router" | "blank" | undefined;
647
695
  }) | {
648
- type: "click" | "clickByXpath" | "clickBySelector";
649
- value: string[];
650
- } | {
651
696
  type: "nudge";
652
697
  value: number;
653
698
  } | ({
@@ -655,7 +700,10 @@ export declare class Checklist {
655
700
  } & {
656
701
  value?: string | undefined;
657
702
  categoryFilter?: number | undefined;
658
- });
703
+ }) | {
704
+ type: "click" | "clickByXpath" | "clickBySelector";
705
+ value: string[];
706
+ };
659
707
  celebrate: boolean;
660
708
  } & {
661
709
  description?: string | undefined;
@@ -686,6 +734,9 @@ export declare class Checklist {
686
734
  skippable: boolean;
687
735
  open_by_default: boolean;
688
736
  share_page_url: string;
737
+ copilot_suggest: boolean;
738
+ copilot_cta_label: string;
739
+ copilot_description: string;
689
740
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
690
741
  id: number;
691
742
  title: string;
@@ -712,6 +763,12 @@ export declare class Checklist {
712
763
  meta: {
713
764
  selector: string;
714
765
  };
766
+ } | {
767
+ type: "on_user_confusion";
768
+ } | {
769
+ type: "on_rage_click";
770
+ } | {
771
+ type: "smart_delay";
715
772
  } | {
716
773
  type: "when_share_link_viewed";
717
774
  };
@@ -751,9 +808,6 @@ export declare class Checklist {
751
808
  } & {
752
809
  operation?: "self" | "router" | "blank" | undefined;
753
810
  }) | {
754
- type: "click" | "clickByXpath" | "clickBySelector";
755
- value: string[];
756
- } | {
757
811
  type: "nudge";
758
812
  value: number;
759
813
  } | ({
@@ -761,7 +815,10 @@ export declare class Checklist {
761
815
  } & {
762
816
  value?: string | undefined;
763
817
  categoryFilter?: number | undefined;
764
- });
818
+ }) | {
819
+ type: "click" | "clickByXpath" | "clickBySelector";
820
+ value: string[];
821
+ };
765
822
  celebrate: boolean;
766
823
  } & {
767
824
  description?: string | undefined;
@@ -792,6 +849,9 @@ export declare class Checklist {
792
849
  skippable: boolean;
793
850
  open_by_default: boolean;
794
851
  share_page_url: string;
852
+ copilot_suggest: boolean;
853
+ copilot_cta_label: string;
854
+ copilot_description: string;
795
855
  }>;
796
856
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
797
857
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
@@ -820,6 +880,12 @@ export declare class Checklist {
820
880
  meta: {
821
881
  selector: string;
822
882
  };
883
+ } | {
884
+ type: "on_user_confusion";
885
+ } | {
886
+ type: "on_rage_click";
887
+ } | {
888
+ type: "smart_delay";
823
889
  } | {
824
890
  type: "when_share_link_viewed";
825
891
  };
@@ -859,9 +925,6 @@ export declare class Checklist {
859
925
  } & {
860
926
  operation?: "self" | "router" | "blank" | undefined;
861
927
  }) | {
862
- type: "click" | "clickByXpath" | "clickBySelector";
863
- value: string[];
864
- } | {
865
928
  type: "nudge";
866
929
  value: number;
867
930
  } | ({
@@ -869,7 +932,10 @@ export declare class Checklist {
869
932
  } & {
870
933
  value?: string | undefined;
871
934
  categoryFilter?: number | undefined;
872
- });
935
+ }) | {
936
+ type: "click" | "clickByXpath" | "clickBySelector";
937
+ value: string[];
938
+ };
873
939
  celebrate: boolean;
874
940
  } & {
875
941
  description?: string | undefined;
@@ -900,6 +966,9 @@ export declare class Checklist {
900
966
  skippable: boolean;
901
967
  open_by_default: boolean;
902
968
  share_page_url: string;
969
+ copilot_suggest: boolean;
970
+ copilot_cta_label: string;
971
+ copilot_description: string;
903
972
  })[]>;
904
973
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
905
974
  onSuccess?: (() => void) | undefined;
@@ -930,6 +999,12 @@ export declare class Checklist {
930
999
  meta: {
931
1000
  selector: string;
932
1001
  };
1002
+ } | {
1003
+ type: "on_user_confusion";
1004
+ } | {
1005
+ type: "on_rage_click";
1006
+ } | {
1007
+ type: "smart_delay";
933
1008
  } | {
934
1009
  type: "when_share_link_viewed";
935
1010
  };
@@ -969,9 +1044,6 @@ export declare class Checklist {
969
1044
  } & {
970
1045
  operation?: "self" | "router" | "blank" | undefined;
971
1046
  }) | {
972
- type: "click" | "clickByXpath" | "clickBySelector";
973
- value: string[];
974
- } | {
975
1047
  type: "nudge";
976
1048
  value: number;
977
1049
  } | ({
@@ -979,7 +1051,10 @@ export declare class Checklist {
979
1051
  } & {
980
1052
  value?: string | undefined;
981
1053
  categoryFilter?: number | undefined;
982
- });
1054
+ }) | {
1055
+ type: "click" | "clickByXpath" | "clickBySelector";
1056
+ value: string[];
1057
+ };
983
1058
  celebrate: boolean;
984
1059
  } & {
985
1060
  description?: string | undefined;
@@ -1010,5 +1085,8 @@ export declare class Checklist {
1010
1085
  skippable: boolean;
1011
1086
  open_by_default: boolean;
1012
1087
  share_page_url: string;
1088
+ copilot_suggest: boolean;
1089
+ copilot_cta_label: string;
1090
+ copilot_description: string;
1013
1091
  }>;
1014
1092
  }