commandbar 1.7.2 → 1.7.3

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 (32) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/commandbar-js/src/init.d.ts +1 -1
  3. package/build/internal/src/client/AddContextOptions.d.ts +6 -7
  4. package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
  5. package/build/internal/src/client/CommandBarClientSDK.d.ts +18 -29
  6. package/build/internal/src/client/CommandBarSDK.d.ts +16 -2
  7. package/build/internal/src/client/EventHandler.d.ts +81 -16
  8. package/build/internal/src/client/globals.d.ts +1 -0
  9. package/build/internal/src/client/symbols.d.ts +6 -0
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +30 -47
  11. package/build/internal/src/middleware/OrganizationV.d.ts +7 -0
  12. package/build/internal/src/middleware/ResourceSettingsV.d.ts +2 -0
  13. package/build/internal/src/middleware/checklist.d.ts +740 -0
  14. package/build/internal/src/middleware/command.d.ts +680 -977
  15. package/build/internal/src/middleware/dashboardFlags.d.ts +9 -0
  16. package/build/internal/src/middleware/detailPreview.d.ts +3 -0
  17. package/build/internal/src/middleware/helpers/actions.d.ts +84 -0
  18. package/build/internal/src/middleware/helpers/argument.d.ts +0 -120
  19. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +60 -60
  20. package/build/internal/src/middleware/helpers/endUser.d.ts +1 -0
  21. package/build/internal/src/middleware/helpers/goals.d.ts +26 -0
  22. package/build/internal/src/middleware/helpers/rules.d.ts +48 -22
  23. package/build/internal/src/middleware/helpers/tags.d.ts +7 -0
  24. package/build/internal/src/middleware/historyEvent.d.ts +0 -19
  25. package/build/internal/src/middleware/nudge.d.ts +890 -94
  26. package/build/internal/src/middleware/organization.d.ts +88 -56
  27. package/build/internal/src/middleware/skin.d.ts +13 -2
  28. package/build/internal/src/middleware/types.d.ts +29 -11
  29. package/build/internal/src/middleware/user.d.ts +2 -1
  30. package/build/internal/src/util/LocalStorage.d.ts +1 -1
  31. package/package.json +2 -3
  32. package/src/init.ts +1 -1
package/build/internal/src/middleware/organization.d.ts CHANGED
@@ -23,13 +23,14 @@ export declare const OrganizationSettingsV: t.TypeC<{
23
23
  allow_event_handlers: t.BooleanC;
24
24
  event_attribute_block_list: t.ArrayC<t.StringC>;
25
25
  skins_limit: t.NumberC;
26
- skins_field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
26
+ skins_field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">, t.LiteralC<"none">]>;
27
27
  show_countdown_banner: t.BooleanC;
28
28
  can_install_foobar: t.BooleanC;
29
29
  releases_available: t.BooleanC;
30
30
  releases_enabled: t.BooleanC;
31
31
  releases_environments: t.ArrayC<t.StringC>;
32
32
  in_bar_feedback: t.BooleanC;
33
+ force_end_user_identity_verification: t.BooleanC;
33
34
  summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
34
35
  end_user_shortcuts_enabled: t.BooleanC;
35
36
  fallback_commands: t.ArrayC<t.NumberC>;
@@ -43,6 +44,9 @@ export declare const OrganizationSettingsV: t.TypeC<{
43
44
  slash_filters_enabled: t.BooleanC;
44
45
  recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
45
46
  recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
47
+ num_live_commands: t.NumberC;
48
+ help_center_sync: t.UnionC<[t.LiteralC<"upload-once">, t.LiteralC<"manual">, t.LiteralC<"automatic">]>;
49
+ show_suggested_synonyms: t.BooleanC;
46
50
  }>;
47
51
  export declare class Organization {
48
52
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -84,6 +88,7 @@ export declare class Organization {
84
88
  sort_key?: number | undefined;
85
89
  max_options_count?: number | null | undefined;
86
90
  sortFunction?: any;
91
+ hasSearchFunction?: boolean | undefined;
87
92
  default_command_id?: string | number | undefined;
88
93
  render_as?: "grid" | "list" | undefined;
89
94
  showResources?: boolean | undefined;
@@ -119,6 +124,7 @@ export declare class Organization {
119
124
  in_bar_feedback: boolean;
120
125
  summon_hotkey_override: string | null;
121
126
  end_user_hotkeys: boolean | undefined;
127
+ force_end_user_identity_verification: boolean;
122
128
  end_user_shortcuts_enabled: boolean;
123
129
  end_user_recents_enabled: boolean;
124
130
  releases_available: boolean;
@@ -133,6 +139,7 @@ export declare class Organization {
133
139
  slash_filters_enabled: boolean;
134
140
  recents_sort_key: number | null;
135
141
  recommended_sort_key: number | null;
142
+ show_suggested_synonyms: boolean;
136
143
  has_hotloaded_help_docs: boolean;
137
144
  }>;
138
145
  static update: (object: {
@@ -171,6 +178,7 @@ export declare class Organization {
171
178
  sort_key?: number | undefined;
172
179
  max_options_count?: number | null | undefined;
173
180
  sortFunction?: any;
181
+ hasSearchFunction?: boolean | undefined;
174
182
  default_command_id?: string | number | undefined;
175
183
  render_as?: "grid" | "list" | undefined;
176
184
  showResources?: boolean | undefined;
@@ -206,6 +214,7 @@ export declare class Organization {
206
214
  in_bar_feedback: boolean;
207
215
  summon_hotkey_override: string | null;
208
216
  end_user_hotkeys: boolean | undefined;
217
+ force_end_user_identity_verification: boolean;
209
218
  end_user_shortcuts_enabled: boolean;
210
219
  end_user_recents_enabled: boolean;
211
220
  releases_available: boolean;
@@ -220,6 +229,7 @@ export declare class Organization {
220
229
  slash_filters_enabled: boolean;
221
230
  recents_sort_key: number | null;
222
231
  recommended_sort_key: number | null;
232
+ show_suggested_synonyms: boolean;
223
233
  has_hotloaded_help_docs: boolean;
224
234
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
225
235
  id: string | number;
@@ -257,6 +267,7 @@ export declare class Organization {
257
267
  sort_key?: number | undefined;
258
268
  max_options_count?: number | null | undefined;
259
269
  sortFunction?: any;
270
+ hasSearchFunction?: boolean | undefined;
260
271
  default_command_id?: string | number | undefined;
261
272
  render_as?: "grid" | "list" | undefined;
262
273
  showResources?: boolean | undefined;
@@ -292,6 +303,7 @@ export declare class Organization {
292
303
  in_bar_feedback: boolean;
293
304
  summon_hotkey_override: string | null;
294
305
  end_user_hotkeys: boolean | undefined;
306
+ force_end_user_identity_verification: boolean;
295
307
  end_user_shortcuts_enabled: boolean;
296
308
  end_user_recents_enabled: boolean;
297
309
  releases_available: boolean;
@@ -306,6 +318,7 @@ export declare class Organization {
306
318
  slash_filters_enabled: boolean;
307
319
  recents_sort_key: number | null;
308
320
  recommended_sort_key: number | null;
321
+ show_suggested_synonyms: boolean;
309
322
  has_hotloaded_help_docs: boolean;
310
323
  }>;
311
324
  static listCommands: (orgUID: string) => Promise<({
@@ -319,7 +332,7 @@ export declare class Organization {
319
332
  commandType?: "object" | "help" | "independent" | undefined;
320
333
  object?: string | undefined;
321
334
  hoverTooltip?: boolean | undefined;
322
- operation?: "self" | "router" | "blank" | undefined;
335
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
323
336
  }) | ({
324
337
  type: "callback";
325
338
  value: string;
@@ -327,15 +340,17 @@ export declare class Organization {
327
340
  commandType?: "object" | "help" | "independent" | undefined;
328
341
  object?: string | undefined;
329
342
  hoverTooltip?: boolean | undefined;
330
- operation?: "self" | "router" | "blank" | undefined;
343
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
331
344
  }) | ({
332
345
  type: "link";
333
346
  value: string;
347
+ } & {
348
+ operation?: "self" | "router" | "blank" | undefined;
334
349
  } & {} & {
335
350
  commandType?: "object" | "help" | "independent" | undefined;
336
351
  object?: string | undefined;
337
352
  hoverTooltip?: boolean | undefined;
338
- operation?: "self" | "router" | "blank" | undefined;
353
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
339
354
  }) | ({
340
355
  type: "click" | "clickByXpath" | "clickBySelector";
341
356
  value: string[];
@@ -343,7 +358,7 @@ export declare class Organization {
343
358
  commandType?: "object" | "help" | "independent" | undefined;
344
359
  object?: string | undefined;
345
360
  hoverTooltip?: boolean | undefined;
346
- operation?: "self" | "router" | "blank" | undefined;
361
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
347
362
  }) | ({
348
363
  type: "builtin";
349
364
  value: string;
@@ -351,7 +366,7 @@ export declare class Organization {
351
366
  commandType?: "object" | "help" | "independent" | undefined;
352
367
  object?: string | undefined;
353
368
  hoverTooltip?: boolean | undefined;
354
- operation?: "self" | "router" | "blank" | undefined;
369
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
355
370
  }) | ({
356
371
  type: "webhook";
357
372
  value: string;
@@ -359,7 +374,7 @@ export declare class Organization {
359
374
  commandType?: "object" | "help" | "independent" | undefined;
360
375
  object?: string | undefined;
361
376
  hoverTooltip?: boolean | undefined;
362
- operation?: "self" | "router" | "blank" | undefined;
377
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
363
378
  }) | ({
364
379
  type: "script";
365
380
  value: string;
@@ -367,7 +382,7 @@ export declare class Organization {
367
382
  commandType?: "object" | "help" | "independent" | undefined;
368
383
  object?: string | undefined;
369
384
  hoverTooltip?: boolean | undefined;
370
- operation?: "self" | "router" | "blank" | undefined;
385
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
371
386
  }) | ({
372
387
  type: "request";
373
388
  value: {
@@ -388,7 +403,7 @@ export declare class Organization {
388
403
  commandType?: "object" | "help" | "independent" | undefined;
389
404
  object?: string | undefined;
390
405
  hoverTooltip?: boolean | undefined;
391
- operation?: "self" | "router" | "blank" | undefined;
406
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
392
407
  }) | ({
393
408
  type: "appcues";
394
409
  value: string;
@@ -396,7 +411,7 @@ export declare class Organization {
396
411
  commandType?: "object" | "help" | "independent" | undefined;
397
412
  object?: string | undefined;
398
413
  hoverTooltip?: boolean | undefined;
399
- operation?: "self" | "router" | "blank" | undefined;
414
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
400
415
  }) | ({
401
416
  type: "video";
402
417
  value: string;
@@ -404,15 +419,17 @@ export declare class Organization {
404
419
  commandType?: "object" | "help" | "independent" | undefined;
405
420
  object?: string | undefined;
406
421
  hoverTooltip?: boolean | undefined;
407
- operation?: "self" | "router" | "blank" | undefined;
422
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
408
423
  }) | ({
409
424
  type: "helpdoc";
410
425
  value: string;
426
+ } & {
427
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
411
428
  } & {} & {
412
429
  commandType?: "object" | "help" | "independent" | undefined;
413
430
  object?: string | undefined;
414
431
  hoverTooltip?: boolean | undefined;
415
- operation?: "self" | "router" | "blank" | undefined;
432
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
416
433
  });
417
434
  } & {
418
435
  disabledReason?: string | undefined;
@@ -434,11 +451,6 @@ export declare class Organization {
434
451
  input_type?: string | undefined;
435
452
  preselected_key?: string | undefined;
436
453
  label_field?: string | undefined;
437
- availability_condition?: {
438
- field: string;
439
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
440
- value: string | undefined;
441
- }[] | undefined;
442
454
  loaded?: any[] | undefined;
443
455
  allow_create?: boolean | undefined;
444
456
  allow_create_label?: string | undefined;
@@ -459,11 +471,6 @@ export declare class Organization {
459
471
  input_type?: string | undefined;
460
472
  preselected_key?: string | undefined;
461
473
  label_field?: string | undefined;
462
- availability_condition?: {
463
- field: string;
464
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
465
- value: string | undefined;
466
- }[] | undefined;
467
474
  loaded?: any[] | undefined;
468
475
  allow_create?: boolean | undefined;
469
476
  allow_create_label?: string | undefined;
@@ -480,11 +487,6 @@ export declare class Organization {
480
487
  input_type?: string | undefined;
481
488
  preselected_key?: string | undefined;
482
489
  label_field?: string | undefined;
483
- availability_condition?: {
484
- field: string;
485
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
486
- value: string | undefined;
487
- }[] | undefined;
488
490
  loaded?: any[] | undefined;
489
491
  dateTimeArgumentTypeId?: number | undefined;
490
492
  allow_create?: boolean | undefined;
@@ -502,11 +504,6 @@ export declare class Organization {
502
504
  input_type?: string | undefined;
503
505
  preselected_key?: string | undefined;
504
506
  label_field?: string | undefined;
505
- availability_condition?: {
506
- field: string;
507
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
508
- value: string | undefined;
509
- }[] | undefined;
510
507
  loaded?: any[] | undefined;
511
508
  allow_create?: boolean | undefined;
512
509
  allow_create_label?: string | undefined;
@@ -523,11 +520,6 @@ export declare class Organization {
523
520
  input_type?: string | undefined;
524
521
  preselected_key?: string | undefined;
525
522
  label_field?: string | undefined;
526
- availability_condition?: {
527
- field: string;
528
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
529
- value: string | undefined;
530
- }[] | undefined;
531
523
  loaded?: any[] | undefined;
532
524
  allow_create?: boolean | undefined;
533
525
  allow_create_label?: string | undefined;
@@ -550,11 +542,6 @@ export declare class Organization {
550
542
  input_type?: string | undefined;
551
543
  preselected_key?: string | undefined;
552
544
  label_field?: string | undefined;
553
- availability_condition?: {
554
- field: string;
555
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
556
- value: string | undefined;
557
- }[] | undefined;
558
545
  loaded?: any[] | undefined;
559
546
  allow_create?: boolean | undefined;
560
547
  allow_create_label?: string | undefined;
@@ -564,32 +551,35 @@ export declare class Organization {
564
551
  };
565
552
  tags: string[];
566
553
  availability_rules: ({
567
- type: "url" | "element" | "context" | "event_count";
568
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
554
+ type: "url" | "element" | "context" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
555
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage";
569
556
  } & {
570
557
  field?: string | undefined;
571
558
  value?: string | undefined;
572
559
  reason?: string | undefined;
560
+ rule_id?: string | number | undefined;
573
561
  })[] | (({
574
- type: "url" | "element" | "context" | "event_count";
575
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
562
+ type: "url" | "element" | "context" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
563
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage";
576
564
  } & {
577
565
  field?: string | undefined;
578
566
  value?: string | undefined;
579
567
  reason?: string | undefined;
568
+ rule_id?: string | number | undefined;
580
569
  }) | ({
581
570
  type: "named_rule";
582
- rule_id: number;
571
+ rule_id: string | number;
583
572
  } & {
584
573
  reason?: string | undefined;
585
574
  }))[];
586
575
  recommend_rules: (({
587
- type: "url" | "element" | "context" | "event_count";
588
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
576
+ type: "url" | "element" | "context" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
577
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage";
589
578
  } & {
590
579
  field?: string | undefined;
591
580
  value?: string | undefined;
592
581
  reason?: string | undefined;
582
+ rule_id?: string | number | undefined;
593
583
  }) | ({
594
584
  type: "always";
595
585
  } & {
@@ -597,13 +587,15 @@ export declare class Organization {
597
587
  field?: null | undefined;
598
588
  value?: null | undefined;
599
589
  reason?: null | undefined;
590
+ rule_id?: string | number | undefined;
600
591
  }))[] | (({
601
- type: "url" | "element" | "context" | "event_count";
602
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
592
+ type: "url" | "element" | "context" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
593
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage";
603
594
  } & {
604
595
  field?: string | undefined;
605
596
  value?: string | undefined;
606
597
  reason?: string | undefined;
598
+ rule_id?: string | number | undefined;
607
599
  }) | ({
608
600
  type: "always";
609
601
  } & {
@@ -611,9 +603,10 @@ export declare class Organization {
611
603
  field?: null | undefined;
612
604
  value?: null | undefined;
613
605
  reason?: null | undefined;
606
+ rule_id?: string | number | undefined;
614
607
  }) | ({
615
608
  type: "named_rule";
616
- rule_id: number;
609
+ rule_id: string | number;
617
610
  } & {
618
611
  reason?: string | undefined;
619
612
  }))[];
@@ -662,6 +655,11 @@ export declare class Organization {
662
655
  position?: "inline" | "popover" | undefined;
663
656
  }))[] | null;
664
657
  next_steps: (string | number)[];
658
+ generated_tags: {
659
+ automated?: string[] | null | undefined;
660
+ manual?: string[] | null | undefined;
661
+ deny?: string[] | null | undefined;
662
+ };
665
663
  } & {
666
664
  third_party_source?: string | null | undefined;
667
665
  third_party_id?: string | null | undefined;
@@ -711,7 +709,7 @@ export declare class Organization {
711
709
  text: string;
712
710
  } & {})[]>;
713
711
  static listRules: (orgUID: string) => Promise<{
714
- id: number;
712
+ id: string | number;
715
713
  name: string;
716
714
  expression: import("./helpers/rules").RuleExpression;
717
715
  }[]>;
@@ -723,6 +721,7 @@ export declare class Organization {
723
721
  has_opened: boolean;
724
722
  hotkeys_debug: boolean;
725
723
  hmac: string | undefined;
724
+ identifier: string;
726
725
  }>;
727
726
  static readHealth: (arg0: string, urlArgs?: {
728
727
  [arg: string]: string;
@@ -773,13 +772,14 @@ export declare class Organization {
773
772
  allow_event_handlers: boolean;
774
773
  event_attribute_block_list: string[];
775
774
  skins_limit: number;
776
- skins_field_set: "basic" | "pro";
775
+ skins_field_set: "basic" | "none" | "pro";
777
776
  show_countdown_banner: boolean;
778
777
  can_install_foobar: boolean;
779
778
  releases_available: boolean;
780
779
  releases_enabled: boolean;
781
780
  releases_environments: string[];
782
781
  in_bar_feedback: boolean;
782
+ force_end_user_identity_verification: boolean;
783
783
  summon_hotkey_override: string | null;
784
784
  end_user_shortcuts_enabled: boolean;
785
785
  fallback_commands: number[];
@@ -793,6 +793,9 @@ export declare class Organization {
793
793
  slash_filters_enabled: boolean;
794
794
  recents_sort_key: number | null;
795
795
  recommended_sort_key: number | null;
796
+ num_live_commands: number;
797
+ help_center_sync: "manual" | "upload-once" | "automatic";
798
+ show_suggested_synonyms: boolean;
796
799
  }>;
797
800
  static updateSetting: (object: {
798
801
  end_user_limit?: number | undefined;
@@ -803,13 +806,14 @@ export declare class Organization {
803
806
  allow_event_handlers?: boolean | undefined;
804
807
  event_attribute_block_list?: string[] | undefined;
805
808
  skins_limit?: number | undefined;
806
- skins_field_set?: "basic" | "pro" | undefined;
809
+ skins_field_set?: "basic" | "none" | "pro" | undefined;
807
810
  show_countdown_banner?: boolean | undefined;
808
811
  can_install_foobar?: boolean | undefined;
809
812
  releases_available?: boolean | undefined;
810
813
  releases_enabled?: boolean | undefined;
811
814
  releases_environments?: string[] | undefined;
812
815
  in_bar_feedback?: boolean | undefined;
816
+ force_end_user_identity_verification?: boolean | undefined;
813
817
  summon_hotkey_override?: string | null | undefined;
814
818
  end_user_shortcuts_enabled?: boolean | undefined;
815
819
  fallback_commands?: number[] | undefined;
@@ -823,6 +827,9 @@ export declare class Organization {
823
827
  slash_filters_enabled?: boolean | undefined;
824
828
  recents_sort_key?: number | null | undefined;
825
829
  recommended_sort_key?: number | null | undefined;
830
+ num_live_commands?: number | undefined;
831
+ help_center_sync?: "manual" | "upload-once" | "automatic" | undefined;
832
+ show_suggested_synonyms?: boolean | undefined;
826
833
  }, params?: Record<string, string> | undefined, callbacks?: {
827
834
  onSuccess?: (() => void) | undefined;
828
835
  onError?: ((err: string) => void) | undefined;
@@ -835,13 +842,14 @@ export declare class Organization {
835
842
  allow_event_handlers: boolean;
836
843
  event_attribute_block_list: string[];
837
844
  skins_limit: number;
838
- skins_field_set: "basic" | "pro";
845
+ skins_field_set: "basic" | "none" | "pro";
839
846
  show_countdown_banner: boolean;
840
847
  can_install_foobar: boolean;
841
848
  releases_available: boolean;
842
849
  releases_enabled: boolean;
843
850
  releases_environments: string[];
844
851
  in_bar_feedback: boolean;
852
+ force_end_user_identity_verification: boolean;
845
853
  summon_hotkey_override: string | null;
846
854
  end_user_shortcuts_enabled: boolean;
847
855
  fallback_commands: number[];
@@ -855,6 +863,26 @@ export declare class Organization {
855
863
  slash_filters_enabled: boolean;
856
864
  recents_sort_key: number | null;
857
865
  recommended_sort_key: number | null;
866
+ num_live_commands: number;
867
+ help_center_sync: "manual" | "upload-once" | "automatic";
868
+ show_suggested_synonyms: boolean;
869
+ }>;
870
+ static readDashboardFlags: (params?: Record<string, string> | undefined, callbacks?: {
871
+ onSuccess?: (() => void) | undefined;
872
+ onError?: ((err: string) => void) | undefined;
873
+ } | undefined) => Promise<{
874
+ show_onboarding: boolean;
875
+ show_appsumo_onboarding: boolean;
876
+ }>;
877
+ static updateDashboardFlags: (object: {
878
+ show_onboarding?: boolean | undefined;
879
+ show_appsumo_onboarding?: boolean | undefined;
880
+ }, params?: Record<string, string> | undefined, callbacks?: {
881
+ onSuccess?: (() => void) | undefined;
882
+ onError?: ((err: string) => void) | undefined;
883
+ } | undefined) => Promise<{
884
+ show_onboarding: boolean;
885
+ show_appsumo_onboarding: boolean;
858
886
  }>;
859
887
  static decode: (data: any) => {
860
888
  id: string | number;
@@ -892,6 +920,7 @@ export declare class Organization {
892
920
  sort_key?: number | undefined;
893
921
  max_options_count?: number | null | undefined;
894
922
  sortFunction?: any;
923
+ hasSearchFunction?: boolean | undefined;
895
924
  default_command_id?: string | number | undefined;
896
925
  render_as?: "grid" | "list" | undefined;
897
926
  showResources?: boolean | undefined;
@@ -927,6 +956,7 @@ export declare class Organization {
927
956
  in_bar_feedback: boolean;
928
957
  summon_hotkey_override: string | null;
929
958
  end_user_hotkeys: boolean | undefined;
959
+ force_end_user_identity_verification: boolean;
930
960
  end_user_shortcuts_enabled: boolean;
931
961
  end_user_recents_enabled: boolean;
932
962
  releases_available: boolean;
@@ -941,6 +971,8 @@ export declare class Organization {
941
971
  slash_filters_enabled: boolean;
942
972
  recents_sort_key: number | null;
943
973
  recommended_sort_key: number | null;
974
+ show_suggested_synonyms: boolean;
944
975
  has_hotloaded_help_docs: boolean;
945
976
  };
977
+ static unknownOrganization: import("./OrganizationV").IOrganizationType;
946
978
  }
package/build/internal/src/middleware/skin.d.ts CHANGED
@@ -8,6 +8,7 @@ export declare const SkinV: t.IntersectionC<[t.TypeC<{
8
8
  organization: t.StringC;
9
9
  }>, t.PartialC<{
10
10
  logo: t.UnionC<[t.StringC, t.NullC]>;
11
+ frozen: t.BooleanC;
11
12
  }>]>;
12
13
  export declare const SkinPatchV: t.PartialC<{
13
14
  id: t.StringC;
@@ -18,6 +19,10 @@ export declare const SkinPatchV: t.PartialC<{
18
19
  organization: t.StringC;
19
20
  logo: t.UnionC<[t.StringC, t.NullC]>;
20
21
  }>;
22
+ export declare const SkinPatchMetadataV: t.PartialC<{
23
+ name: t.StringC;
24
+ slug: t.StringC;
25
+ }>;
21
26
  export declare class Skin {
22
27
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
23
28
  id: string;
@@ -28,6 +33,7 @@ export declare class Skin {
28
33
  organization: string;
29
34
  } & {
30
35
  logo?: string | null | undefined;
36
+ frozen?: boolean | undefined;
31
37
  })[]>;
32
38
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
33
39
  onSuccess?: (() => void) | undefined;
@@ -41,8 +47,9 @@ export declare class Skin {
41
47
  organization: string;
42
48
  } & {
43
49
  logo?: string | null | undefined;
50
+ frozen?: boolean | undefined;
44
51
  }>;
45
- static update: (object: {
52
+ static update: (skin: t.TypeOf<typeof SkinPatchV>) => Promise<{
46
53
  id: string;
47
54
  slug: string;
48
55
  name: string;
@@ -51,7 +58,9 @@ export declare class Skin {
51
58
  organization: string;
52
59
  } & {
53
60
  logo?: string | null | undefined;
54
- }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
61
+ frozen?: boolean | undefined;
62
+ }>;
63
+ static updateMetadata: (slug: string, metadata: t.TypeOf<typeof SkinPatchMetadataV>) => Promise<{
55
64
  id: string;
56
65
  slug: string;
57
66
  name: string;
@@ -60,6 +69,7 @@ export declare class Skin {
60
69
  organization: string;
61
70
  } & {
62
71
  logo?: string | null | undefined;
72
+ frozen?: boolean | undefined;
63
73
  }>;
64
74
  static create: (object: {
65
75
  id?: string | undefined;
@@ -78,6 +88,7 @@ export declare class Skin {
78
88
  organization: string;
79
89
  } & {
80
90
  logo?: string | null | undefined;
91
+ frozen?: boolean | undefined;
81
92
  }>;
82
93
  static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
83
94
  }
package/build/internal/src/middleware/types.d.ts CHANGED
@@ -4,7 +4,8 @@ import { BatchEditorCommandResponseV, BatchOperationV, CommandV, HelpSyncCommand
4
4
  import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
5
5
  import { GenericBatchRequest } from './generics';
6
6
  import { OptionGroupRenderAsV } from './helpers/optionGroup';
7
- import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
7
+ import { TemplateV, TemplateOptionsV, RequestTemplateV } from './helpers/commandTemplate';
8
+ import { RequestV } from './helpers/actions';
8
9
  import { CommandCategoryV } from './commandCategory';
9
10
  import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationSettingsV } from './organization';
10
11
  import { UserV } from './user';
@@ -19,9 +20,11 @@ import { ProfileV } from './profile';
19
20
  import { PlaceholderV } from './placeholder';
20
21
  import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
21
22
  import { EnvironmentV } from './environment';
22
- import { NudgeV } from './nudge';
23
+ import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV, NudgeContentImageBlockV, NudgeContentMarkdownBlockV, NudgeContentVideoBlockV, NudgeStepV, NudgeV, OldNudgeV } from './nudge';
23
24
  import { TabV } from './tab';
24
25
  import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
26
+ import { ChecklistItemV, ChecklistV } from './checklist';
27
+ import { DashboardFlagsV } from './dashboardFlags';
25
28
  /*******************************************************************************/
26
29
  export declare type IInitOptions = {
27
30
  debug?: boolean;
@@ -46,6 +49,7 @@ export declare type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrati
46
49
  export type { IOrganizationType } from './OrganizationV';
47
50
  export declare type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV> & unknown;
48
51
  export declare type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV> & unknown;
52
+ export declare type IDashboardFlagsType = t.TypeOf<typeof DashboardFlagsV> & unknown;
49
53
  export declare type ISkinType = t.TypeOf<typeof SkinV> & unknown;
50
54
  export declare type IProfileType = t.TypeOf<typeof ProfileV> & unknown;
51
55
  export declare type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV> & unknown;
@@ -80,12 +84,22 @@ export declare type IDynamicArgumentType = t.TypeOf<typeof DynamicArgumentV> & u
80
84
  export declare type IDependentArgumentType = t.TypeOf<typeof DependentArgumentV> & unknown;
81
85
  export declare type IFunctionArgumentType = t.TypeOf<typeof FunctionArgumentV> & unknown;
82
86
  export declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderAsV> & unknown;
87
+ export declare type IOldNudgeType = t.TypeOf<typeof OldNudgeV> & unknown;
83
88
  export declare type INudgeType = t.TypeOf<typeof NudgeV> & unknown;
84
- export interface INudgeClientType {
89
+ export declare type INudgeStepType = t.TypeOf<typeof NudgeStepV> & unknown;
90
+ export declare type INudgeStepContentBlockType = t.TypeOf<typeof NudgeContentBlockV> & unknown;
91
+ export declare type INudgeStepContentMarkdownBlockType = t.TypeOf<typeof NudgeContentMarkdownBlockV> & unknown;
92
+ export declare type INudgeStepContentImageBlockType = t.TypeOf<typeof NudgeContentImageBlockV> & unknown;
93
+ export declare type INudgeStepContentVideoBlockType = t.TypeOf<typeof NudgeContentVideoBlockV> & unknown;
94
+ export declare type INudgeStepContentHelpDocBlockType = t.TypeOf<typeof NudgeContentHelpDocBlockV> & unknown;
95
+ export declare type INudgeStepContentButtonBlockType = t.TypeOf<typeof NudgeContentButtonBlockV> & unknown;
96
+ export declare type INudgeClientType = {
85
97
  nudge: INudgeType;
86
98
  passedConditionsInLastEvaluation: boolean;
87
99
  lastTriggeredTs?: number;
88
- }
100
+ };
101
+ export declare type IChecklist = t.TypeOf<typeof ChecklistV> & unknown;
102
+ export declare type IChecklistItem = t.TypeOf<typeof ChecklistItemV> & unknown;
89
103
  export interface ICommandInput {
90
104
  text: string;
91
105
  command: ICommandType;
@@ -101,12 +115,14 @@ export declare type IHistoryType = Array<{
101
115
  export interface IUserContext {
102
116
  [variable: string]: any;
103
117
  }
104
- export interface EventWithTimestamp {
105
- eventName: string;
106
- properties: {
107
- [prop: string]: any;
108
- };
109
- timestamp: number;
118
+ export interface IEndUserAnalytics {
119
+ num_command_executions: number;
120
+ num_shortcut_command_executions: number;
121
+ num_sessions: number;
122
+ num_opens: number;
123
+ num_deadends: number;
124
+ first_seen_at: string;
125
+ last_seen_at: string;
110
126
  }
111
127
  export interface ICallbackMap {
112
128
  [variable: string]: (...args: any[]) => unknown;
@@ -123,8 +139,10 @@ export declare type IConfigEndpointResponse = {
123
139
  organization: any;
124
140
  environments_with_versions?: any[];
125
141
  placeholders?: any[];
126
- nudges?: INudgeType[];
142
+ nudges?: IOldNudgeType[];
143
+ nudges_v2?: INudgeType[];
127
144
  tabs?: ITabType[];
145
+ checklists?: IChecklist[];
128
146
  };
129
147
  export type { IResourceSettings } from './IResourceSettings';
130
148
  export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV> & unknown;
package/build/internal/src/middleware/user.d.ts CHANGED
@@ -5,10 +5,11 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
5
5
  token: t.StringC;
6
6
  email: t.StringC;
7
7
  organization: t.StringC;
8
+ organization_name: t.StringC;
8
9
  api_token: t.UnionC<[t.StringC, t.NullC]>;
9
10
  profile: t.NumberC;
10
11
  has_updated_password: t.BooleanC;
11
12
  is_active: t.BooleanC;
12
13
  }>, t.PartialC<{
13
- atlas_hash: t.StringC;
14
+ intercom_hash: t.StringC;
14
15
  }>]>;
package/build/internal/src/util/LocalStorage.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  declare const LocalStorage: {
2
2
  set: (label: string, value: string | boolean | number) => string | number | boolean;
3
- get: (label: string, defaultValue: string | boolean | number) => string | number | boolean;
3
+ get: (label: string, defaultValue: string | boolean | number, prefixOverride?: string | undefined) => string | number | boolean;
4
4
  remove: (label: string) => void;
5
5
  };
6
6
  export default LocalStorage;