commandbar 1.7.1 → 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 (35) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/commandbar-js/src/init.d.ts +2 -8
  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 +33 -31
  6. package/build/internal/src/client/CommandBarSDK.d.ts +20 -4
  7. package/build/internal/src/client/EventHandler.d.ts +92 -3
  8. package/build/internal/src/client/globals.d.ts +2 -0
  9. package/build/internal/src/client/symbols.d.ts +7 -0
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +32 -47
  11. package/build/internal/src/middleware/OrganizationV.d.ts +15 -2
  12. package/build/internal/src/middleware/ResourceSettingsV.d.ts +6 -0
  13. package/build/internal/src/middleware/checklist.d.ts +740 -0
  14. package/build/internal/src/middleware/command.d.ts +718 -977
  15. package/build/internal/src/middleware/commandCategory.d.ts +32 -0
  16. package/build/internal/src/middleware/dashboardFlags.d.ts +9 -0
  17. package/build/internal/src/middleware/detailPreview.d.ts +4 -0
  18. package/build/internal/src/middleware/helpers/actions.d.ts +84 -0
  19. package/build/internal/src/middleware/helpers/argument.d.ts +0 -120
  20. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +60 -60
  21. package/build/internal/src/middleware/helpers/endUser.d.ts +1 -0
  22. package/build/internal/src/middleware/helpers/goals.d.ts +26 -0
  23. package/build/internal/src/middleware/helpers/rules.d.ts +48 -22
  24. package/build/internal/src/middleware/helpers/tags.d.ts +7 -0
  25. package/build/internal/src/middleware/historyEvent.d.ts +0 -19
  26. package/build/internal/src/middleware/nudge.d.ts +925 -81
  27. package/build/internal/src/middleware/organization.d.ts +110 -60
  28. package/build/internal/src/middleware/skin.d.ts +13 -2
  29. package/build/internal/src/middleware/types.d.ts +38 -6
  30. package/build/internal/src/middleware/user.d.ts +2 -1
  31. package/build/internal/src/util/LocalStorage.d.ts +1 -1
  32. package/package.json +3 -4
  33. package/src/init.ts +2 -9
  34. package/src/snippet.ts +2 -2
  35. package/webpack.config.js +5 -0
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?: {
@@ -56,7 +60,7 @@ export declare class Organization {
56
60
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
57
61
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
58
62
  show_launcher_recommendations: boolean;
59
- recommendations_type: "None" | "Custom" | "Algorithm";
63
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
60
64
  launcher_offset_x: number;
61
65
  launcher_offset_y: number;
62
66
  theme: object;
@@ -78,10 +82,13 @@ export declare class Organization {
78
82
  unfurl?: boolean | undefined;
79
83
  description_field?: string | undefined;
80
84
  icon?: string | undefined;
85
+ icon_color?: string | undefined;
86
+ image_color?: string | undefined;
81
87
  image?: string | undefined;
82
88
  sort_key?: number | undefined;
83
89
  max_options_count?: number | null | undefined;
84
90
  sortFunction?: any;
91
+ hasSearchFunction?: boolean | undefined;
85
92
  default_command_id?: string | number | undefined;
86
93
  render_as?: "grid" | "list" | undefined;
87
94
  showResources?: boolean | undefined;
@@ -117,6 +124,7 @@ export declare class Organization {
117
124
  in_bar_feedback: boolean;
118
125
  summon_hotkey_override: string | null;
119
126
  end_user_hotkeys: boolean | undefined;
127
+ force_end_user_identity_verification: boolean;
120
128
  end_user_shortcuts_enabled: boolean;
121
129
  end_user_recents_enabled: boolean;
122
130
  releases_available: boolean;
@@ -131,6 +139,8 @@ export declare class Organization {
131
139
  slash_filters_enabled: boolean;
132
140
  recents_sort_key: number | null;
133
141
  recommended_sort_key: number | null;
142
+ show_suggested_synonyms: boolean;
143
+ has_hotloaded_help_docs: boolean;
134
144
  }>;
135
145
  static update: (object: {
136
146
  id: string | number;
@@ -140,7 +150,7 @@ export declare class Organization {
140
150
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
141
151
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
142
152
  show_launcher_recommendations: boolean;
143
- recommendations_type: "None" | "Custom" | "Algorithm";
153
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
144
154
  launcher_offset_x: number;
145
155
  launcher_offset_y: number;
146
156
  theme: object;
@@ -162,10 +172,13 @@ export declare class Organization {
162
172
  unfurl?: boolean | undefined;
163
173
  description_field?: string | undefined;
164
174
  icon?: string | undefined;
175
+ icon_color?: string | undefined;
176
+ image_color?: string | undefined;
165
177
  image?: string | undefined;
166
178
  sort_key?: number | undefined;
167
179
  max_options_count?: number | null | undefined;
168
180
  sortFunction?: any;
181
+ hasSearchFunction?: boolean | undefined;
169
182
  default_command_id?: string | number | undefined;
170
183
  render_as?: "grid" | "list" | undefined;
171
184
  showResources?: boolean | undefined;
@@ -201,6 +214,7 @@ export declare class Organization {
201
214
  in_bar_feedback: boolean;
202
215
  summon_hotkey_override: string | null;
203
216
  end_user_hotkeys: boolean | undefined;
217
+ force_end_user_identity_verification: boolean;
204
218
  end_user_shortcuts_enabled: boolean;
205
219
  end_user_recents_enabled: boolean;
206
220
  releases_available: boolean;
@@ -215,6 +229,8 @@ export declare class Organization {
215
229
  slash_filters_enabled: boolean;
216
230
  recents_sort_key: number | null;
217
231
  recommended_sort_key: number | null;
232
+ show_suggested_synonyms: boolean;
233
+ has_hotloaded_help_docs: boolean;
218
234
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
219
235
  id: string | number;
220
236
  name: string;
@@ -223,7 +239,7 @@ export declare class Organization {
223
239
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
224
240
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
225
241
  show_launcher_recommendations: boolean;
226
- recommendations_type: "None" | "Custom" | "Algorithm";
242
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
227
243
  launcher_offset_x: number;
228
244
  launcher_offset_y: number;
229
245
  theme: object;
@@ -245,10 +261,13 @@ export declare class Organization {
245
261
  unfurl?: boolean | undefined;
246
262
  description_field?: string | undefined;
247
263
  icon?: string | undefined;
264
+ icon_color?: string | undefined;
265
+ image_color?: string | undefined;
248
266
  image?: string | undefined;
249
267
  sort_key?: number | undefined;
250
268
  max_options_count?: number | null | undefined;
251
269
  sortFunction?: any;
270
+ hasSearchFunction?: boolean | undefined;
252
271
  default_command_id?: string | number | undefined;
253
272
  render_as?: "grid" | "list" | undefined;
254
273
  showResources?: boolean | undefined;
@@ -284,6 +303,7 @@ export declare class Organization {
284
303
  in_bar_feedback: boolean;
285
304
  summon_hotkey_override: string | null;
286
305
  end_user_hotkeys: boolean | undefined;
306
+ force_end_user_identity_verification: boolean;
287
307
  end_user_shortcuts_enabled: boolean;
288
308
  end_user_recents_enabled: boolean;
289
309
  releases_available: boolean;
@@ -298,6 +318,8 @@ export declare class Organization {
298
318
  slash_filters_enabled: boolean;
299
319
  recents_sort_key: number | null;
300
320
  recommended_sort_key: number | null;
321
+ show_suggested_synonyms: boolean;
322
+ has_hotloaded_help_docs: boolean;
301
323
  }>;
302
324
  static listCommands: (orgUID: string) => Promise<({
303
325
  id: number;
@@ -310,7 +332,7 @@ export declare class Organization {
310
332
  commandType?: "object" | "help" | "independent" | undefined;
311
333
  object?: string | undefined;
312
334
  hoverTooltip?: boolean | undefined;
313
- operation?: "self" | "router" | "blank" | undefined;
335
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
314
336
  }) | ({
315
337
  type: "callback";
316
338
  value: string;
@@ -318,15 +340,17 @@ export declare class Organization {
318
340
  commandType?: "object" | "help" | "independent" | undefined;
319
341
  object?: string | undefined;
320
342
  hoverTooltip?: boolean | undefined;
321
- operation?: "self" | "router" | "blank" | undefined;
343
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
322
344
  }) | ({
323
345
  type: "link";
324
346
  value: string;
347
+ } & {
348
+ operation?: "self" | "router" | "blank" | undefined;
325
349
  } & {} & {
326
350
  commandType?: "object" | "help" | "independent" | undefined;
327
351
  object?: string | undefined;
328
352
  hoverTooltip?: boolean | undefined;
329
- operation?: "self" | "router" | "blank" | undefined;
353
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
330
354
  }) | ({
331
355
  type: "click" | "clickByXpath" | "clickBySelector";
332
356
  value: string[];
@@ -334,7 +358,7 @@ export declare class Organization {
334
358
  commandType?: "object" | "help" | "independent" | undefined;
335
359
  object?: string | undefined;
336
360
  hoverTooltip?: boolean | undefined;
337
- operation?: "self" | "router" | "blank" | undefined;
361
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
338
362
  }) | ({
339
363
  type: "builtin";
340
364
  value: string;
@@ -342,7 +366,7 @@ export declare class Organization {
342
366
  commandType?: "object" | "help" | "independent" | undefined;
343
367
  object?: string | undefined;
344
368
  hoverTooltip?: boolean | undefined;
345
- operation?: "self" | "router" | "blank" | undefined;
369
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
346
370
  }) | ({
347
371
  type: "webhook";
348
372
  value: string;
@@ -350,7 +374,7 @@ export declare class Organization {
350
374
  commandType?: "object" | "help" | "independent" | undefined;
351
375
  object?: string | undefined;
352
376
  hoverTooltip?: boolean | undefined;
353
- operation?: "self" | "router" | "blank" | undefined;
377
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
354
378
  }) | ({
355
379
  type: "script";
356
380
  value: string;
@@ -358,7 +382,7 @@ export declare class Organization {
358
382
  commandType?: "object" | "help" | "independent" | undefined;
359
383
  object?: string | undefined;
360
384
  hoverTooltip?: boolean | undefined;
361
- operation?: "self" | "router" | "blank" | undefined;
385
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
362
386
  }) | ({
363
387
  type: "request";
364
388
  value: {
@@ -379,7 +403,7 @@ export declare class Organization {
379
403
  commandType?: "object" | "help" | "independent" | undefined;
380
404
  object?: string | undefined;
381
405
  hoverTooltip?: boolean | undefined;
382
- operation?: "self" | "router" | "blank" | undefined;
406
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
383
407
  }) | ({
384
408
  type: "appcues";
385
409
  value: string;
@@ -387,7 +411,7 @@ export declare class Organization {
387
411
  commandType?: "object" | "help" | "independent" | undefined;
388
412
  object?: string | undefined;
389
413
  hoverTooltip?: boolean | undefined;
390
- operation?: "self" | "router" | "blank" | undefined;
414
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
391
415
  }) | ({
392
416
  type: "video";
393
417
  value: string;
@@ -395,15 +419,17 @@ export declare class Organization {
395
419
  commandType?: "object" | "help" | "independent" | undefined;
396
420
  object?: string | undefined;
397
421
  hoverTooltip?: boolean | undefined;
398
- operation?: "self" | "router" | "blank" | undefined;
422
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
399
423
  }) | ({
400
424
  type: "helpdoc";
401
425
  value: string;
426
+ } & {
427
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
402
428
  } & {} & {
403
429
  commandType?: "object" | "help" | "independent" | undefined;
404
430
  object?: string | undefined;
405
431
  hoverTooltip?: boolean | undefined;
406
- operation?: "self" | "router" | "blank" | undefined;
432
+ operation?: "self" | "router" | "blank" | "help_explorer" | undefined;
407
433
  });
408
434
  } & {
409
435
  disabledReason?: string | undefined;
@@ -425,11 +451,6 @@ export declare class Organization {
425
451
  input_type?: string | undefined;
426
452
  preselected_key?: string | undefined;
427
453
  label_field?: string | undefined;
428
- availability_condition?: {
429
- field: string;
430
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
431
- value: string | undefined;
432
- }[] | undefined;
433
454
  loaded?: any[] | undefined;
434
455
  allow_create?: boolean | undefined;
435
456
  allow_create_label?: string | undefined;
@@ -450,11 +471,6 @@ export declare class Organization {
450
471
  input_type?: string | undefined;
451
472
  preselected_key?: string | undefined;
452
473
  label_field?: string | undefined;
453
- availability_condition?: {
454
- field: string;
455
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
456
- value: string | undefined;
457
- }[] | undefined;
458
474
  loaded?: any[] | undefined;
459
475
  allow_create?: boolean | undefined;
460
476
  allow_create_label?: string | undefined;
@@ -471,11 +487,6 @@ export declare class Organization {
471
487
  input_type?: string | undefined;
472
488
  preselected_key?: string | undefined;
473
489
  label_field?: string | undefined;
474
- availability_condition?: {
475
- field: string;
476
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
477
- value: string | undefined;
478
- }[] | undefined;
479
490
  loaded?: any[] | undefined;
480
491
  dateTimeArgumentTypeId?: number | undefined;
481
492
  allow_create?: boolean | undefined;
@@ -493,11 +504,6 @@ export declare class Organization {
493
504
  input_type?: string | undefined;
494
505
  preselected_key?: string | undefined;
495
506
  label_field?: string | undefined;
496
- availability_condition?: {
497
- field: string;
498
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
499
- value: string | undefined;
500
- }[] | undefined;
501
507
  loaded?: any[] | undefined;
502
508
  allow_create?: boolean | undefined;
503
509
  allow_create_label?: string | undefined;
@@ -514,11 +520,6 @@ export declare class Organization {
514
520
  input_type?: string | undefined;
515
521
  preselected_key?: string | undefined;
516
522
  label_field?: string | undefined;
517
- availability_condition?: {
518
- field: string;
519
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
520
- value: string | undefined;
521
- }[] | undefined;
522
523
  loaded?: any[] | undefined;
523
524
  allow_create?: boolean | undefined;
524
525
  allow_create_label?: string | undefined;
@@ -541,11 +542,6 @@ export declare class Organization {
541
542
  input_type?: string | undefined;
542
543
  preselected_key?: string | undefined;
543
544
  label_field?: string | undefined;
544
- availability_condition?: {
545
- field: string;
546
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
547
- value: string | undefined;
548
- }[] | undefined;
549
545
  loaded?: any[] | undefined;
550
546
  allow_create?: boolean | undefined;
551
547
  allow_create_label?: string | undefined;
@@ -555,32 +551,35 @@ export declare class Organization {
555
551
  };
556
552
  tags: string[];
557
553
  availability_rules: ({
558
- type: "url" | "element" | "context";
559
- 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";
560
556
  } & {
561
557
  field?: string | undefined;
562
558
  value?: string | undefined;
563
559
  reason?: string | undefined;
560
+ rule_id?: string | number | undefined;
564
561
  })[] | (({
565
- type: "url" | "element" | "context";
566
- 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";
567
564
  } & {
568
565
  field?: string | undefined;
569
566
  value?: string | undefined;
570
567
  reason?: string | undefined;
568
+ rule_id?: string | number | undefined;
571
569
  }) | ({
572
570
  type: "named_rule";
573
- rule_id: number;
571
+ rule_id: string | number;
574
572
  } & {
575
573
  reason?: string | undefined;
576
574
  }))[];
577
575
  recommend_rules: (({
578
- type: "url" | "element" | "context";
579
- 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";
580
578
  } & {
581
579
  field?: string | undefined;
582
580
  value?: string | undefined;
583
581
  reason?: string | undefined;
582
+ rule_id?: string | number | undefined;
584
583
  }) | ({
585
584
  type: "always";
586
585
  } & {
@@ -588,13 +587,15 @@ export declare class Organization {
588
587
  field?: null | undefined;
589
588
  value?: null | undefined;
590
589
  reason?: null | undefined;
590
+ rule_id?: string | number | undefined;
591
591
  }))[] | (({
592
- type: "url" | "element" | "context";
593
- 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";
594
594
  } & {
595
595
  field?: string | undefined;
596
596
  value?: string | undefined;
597
597
  reason?: string | undefined;
598
+ rule_id?: string | number | undefined;
598
599
  }) | ({
599
600
  type: "always";
600
601
  } & {
@@ -602,9 +603,10 @@ export declare class Organization {
602
603
  field?: null | undefined;
603
604
  value?: null | undefined;
604
605
  reason?: null | undefined;
606
+ rule_id?: string | number | undefined;
605
607
  }) | ({
606
608
  type: "named_rule";
607
- rule_id: number;
609
+ rule_id: string | number;
608
610
  } & {
609
611
  reason?: string | undefined;
610
612
  }))[];
@@ -619,6 +621,8 @@ export declare class Organization {
619
621
  category: number | null;
620
622
  sort_key: number | null;
621
623
  icon: string | null;
624
+ icon_color: string | null;
625
+ image_color: string | null;
622
626
  image: string | null;
623
627
  celebrate: boolean | {
624
628
  angle?: number | undefined;
@@ -651,6 +655,11 @@ export declare class Organization {
651
655
  position?: "inline" | "popover" | undefined;
652
656
  }))[] | null;
653
657
  next_steps: (string | number)[];
658
+ generated_tags: {
659
+ automated?: string[] | null | undefined;
660
+ manual?: string[] | null | undefined;
661
+ deny?: string[] | null | undefined;
662
+ };
654
663
  } & {
655
664
  third_party_source?: string | null | undefined;
656
665
  third_party_id?: string | null | undefined;
@@ -662,6 +671,8 @@ export declare class Organization {
662
671
  } & {} & {
663
672
  sort_key: number | null;
664
673
  icon: string | null;
674
+ icon_color: string | null;
675
+ image_color: string | null;
665
676
  image: string | null;
666
677
  render_as: "grid" | "list";
667
678
  setting_hide_before_search: boolean;
@@ -673,6 +684,8 @@ export declare class Organization {
673
684
  slash_filter_keyword: string | null;
674
685
  search_tab_instruction: string;
675
686
  track_recents: boolean;
687
+ } & {
688
+ contains_hotloaded_commands?: boolean | undefined;
676
689
  })[]>;
677
690
  static listGuides: (orgUID: string) => Promise<({
678
691
  id: number;
@@ -696,7 +709,7 @@ export declare class Organization {
696
709
  text: string;
697
710
  } & {})[]>;
698
711
  static listRules: (orgUID: string) => Promise<{
699
- id: number;
712
+ id: string | number;
700
713
  name: string;
701
714
  expression: import("./helpers/rules").RuleExpression;
702
715
  }[]>;
@@ -708,6 +721,7 @@ export declare class Organization {
708
721
  has_opened: boolean;
709
722
  hotkeys_debug: boolean;
710
723
  hmac: string | undefined;
724
+ identifier: string;
711
725
  }>;
712
726
  static readHealth: (arg0: string, urlArgs?: {
713
727
  [arg: string]: string;
@@ -758,13 +772,14 @@ export declare class Organization {
758
772
  allow_event_handlers: boolean;
759
773
  event_attribute_block_list: string[];
760
774
  skins_limit: number;
761
- skins_field_set: "basic" | "pro";
775
+ skins_field_set: "basic" | "none" | "pro";
762
776
  show_countdown_banner: boolean;
763
777
  can_install_foobar: boolean;
764
778
  releases_available: boolean;
765
779
  releases_enabled: boolean;
766
780
  releases_environments: string[];
767
781
  in_bar_feedback: boolean;
782
+ force_end_user_identity_verification: boolean;
768
783
  summon_hotkey_override: string | null;
769
784
  end_user_shortcuts_enabled: boolean;
770
785
  fallback_commands: number[];
@@ -778,6 +793,9 @@ export declare class Organization {
778
793
  slash_filters_enabled: boolean;
779
794
  recents_sort_key: number | null;
780
795
  recommended_sort_key: number | null;
796
+ num_live_commands: number;
797
+ help_center_sync: "manual" | "upload-once" | "automatic";
798
+ show_suggested_synonyms: boolean;
781
799
  }>;
782
800
  static updateSetting: (object: {
783
801
  end_user_limit?: number | undefined;
@@ -788,13 +806,14 @@ export declare class Organization {
788
806
  allow_event_handlers?: boolean | undefined;
789
807
  event_attribute_block_list?: string[] | undefined;
790
808
  skins_limit?: number | undefined;
791
- skins_field_set?: "basic" | "pro" | undefined;
809
+ skins_field_set?: "basic" | "none" | "pro" | undefined;
792
810
  show_countdown_banner?: boolean | undefined;
793
811
  can_install_foobar?: boolean | undefined;
794
812
  releases_available?: boolean | undefined;
795
813
  releases_enabled?: boolean | undefined;
796
814
  releases_environments?: string[] | undefined;
797
815
  in_bar_feedback?: boolean | undefined;
816
+ force_end_user_identity_verification?: boolean | undefined;
798
817
  summon_hotkey_override?: string | null | undefined;
799
818
  end_user_shortcuts_enabled?: boolean | undefined;
800
819
  fallback_commands?: number[] | undefined;
@@ -808,6 +827,9 @@ export declare class Organization {
808
827
  slash_filters_enabled?: boolean | undefined;
809
828
  recents_sort_key?: number | null | undefined;
810
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;
811
833
  }, params?: Record<string, string> | undefined, callbacks?: {
812
834
  onSuccess?: (() => void) | undefined;
813
835
  onError?: ((err: string) => void) | undefined;
@@ -820,13 +842,14 @@ export declare class Organization {
820
842
  allow_event_handlers: boolean;
821
843
  event_attribute_block_list: string[];
822
844
  skins_limit: number;
823
- skins_field_set: "basic" | "pro";
845
+ skins_field_set: "basic" | "none" | "pro";
824
846
  show_countdown_banner: boolean;
825
847
  can_install_foobar: boolean;
826
848
  releases_available: boolean;
827
849
  releases_enabled: boolean;
828
850
  releases_environments: string[];
829
851
  in_bar_feedback: boolean;
852
+ force_end_user_identity_verification: boolean;
830
853
  summon_hotkey_override: string | null;
831
854
  end_user_shortcuts_enabled: boolean;
832
855
  fallback_commands: number[];
@@ -840,6 +863,26 @@ export declare class Organization {
840
863
  slash_filters_enabled: boolean;
841
864
  recents_sort_key: number | null;
842
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;
843
886
  }>;
844
887
  static decode: (data: any) => {
845
888
  id: string | number;
@@ -849,7 +892,7 @@ export declare class Organization {
849
892
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
850
893
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
851
894
  show_launcher_recommendations: boolean;
852
- recommendations_type: "None" | "Custom" | "Algorithm";
895
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
853
896
  launcher_offset_x: number;
854
897
  launcher_offset_y: number;
855
898
  theme: object;
@@ -871,10 +914,13 @@ export declare class Organization {
871
914
  unfurl?: boolean | undefined;
872
915
  description_field?: string | undefined;
873
916
  icon?: string | undefined;
917
+ icon_color?: string | undefined;
918
+ image_color?: string | undefined;
874
919
  image?: string | undefined;
875
920
  sort_key?: number | undefined;
876
921
  max_options_count?: number | null | undefined;
877
922
  sortFunction?: any;
923
+ hasSearchFunction?: boolean | undefined;
878
924
  default_command_id?: string | number | undefined;
879
925
  render_as?: "grid" | "list" | undefined;
880
926
  showResources?: boolean | undefined;
@@ -910,6 +956,7 @@ export declare class Organization {
910
956
  in_bar_feedback: boolean;
911
957
  summon_hotkey_override: string | null;
912
958
  end_user_hotkeys: boolean | undefined;
959
+ force_end_user_identity_verification: boolean;
913
960
  end_user_shortcuts_enabled: boolean;
914
961
  end_user_recents_enabled: boolean;
915
962
  releases_available: boolean;
@@ -924,5 +971,8 @@ export declare class Organization {
924
971
  slash_filters_enabled: boolean;
925
972
  recents_sort_key: number | null;
926
973
  recommended_sort_key: number | null;
974
+ show_suggested_synonyms: boolean;
975
+ has_hotloaded_help_docs: boolean;
927
976
  };
977
+ static unknownOrganization: import("./OrganizationV").IOrganizationType;
928
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
  }