commandbar 1.7.2 → 1.8.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) 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/package.json +3 -4
  4. package/src/init.ts +1 -1
  5. package/src/snippet.ts +1 -0
  6. package/build/internal/src/client/AddContextOptions.d.ts +0 -124
  7. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  8. package/build/internal/src/client/CommandBarClientSDK.d.ts +0 -387
  9. package/build/internal/src/client/CommandBarProxySDK.d.ts +0 -49
  10. package/build/internal/src/client/CommandBarSDK.d.ts +0 -51
  11. package/build/internal/src/client/EventHandler.d.ts +0 -142
  12. package/build/internal/src/client/OrgConfig.d.ts +0 -5
  13. package/build/internal/src/client/SDKConfig.d.ts +0 -13
  14. package/build/internal/src/client/SentryReporter.d.ts +0 -62
  15. package/build/internal/src/client/globals.d.ts +0 -19
  16. package/build/internal/src/client/proxy.d.ts +0 -15
  17. package/build/internal/src/client/symbols.d.ts +0 -35
  18. package/build/internal/src/middleware/CommandFromClientV.d.ts +0 -307
  19. package/build/internal/src/middleware/ICommandFromClientType.d.ts +0 -5
  20. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  21. package/build/internal/src/middleware/OrganizationV.d.ts +0 -170
  22. package/build/internal/src/middleware/ResourceSettingsV.d.ts +0 -89
  23. package/build/internal/src/middleware/command.d.ts +0 -6975
  24. package/build/internal/src/middleware/commandCategory.d.ts +0 -192
  25. package/build/internal/src/middleware/confetti.d.ts +0 -16
  26. package/build/internal/src/middleware/context.d.ts +0 -40
  27. package/build/internal/src/middleware/detailPreview.d.ts +0 -21
  28. package/build/internal/src/middleware/environment.d.ts +0 -11
  29. package/build/internal/src/middleware/generics.d.ts +0 -40
  30. package/build/internal/src/middleware/guide.d.ts +0 -37
  31. package/build/internal/src/middleware/helpDocsIntegration.d.ts +0 -66
  32. package/build/internal/src/middleware/helpDocsSync.d.ts +0 -42
  33. package/build/internal/src/middleware/helpers/argument.d.ts +0 -568
  34. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +0 -225
  35. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -10
  36. package/build/internal/src/middleware/helpers/optionGroup.d.ts +0 -2
  37. package/build/internal/src/middleware/helpers/rules.d.ts +0 -234
  38. package/build/internal/src/middleware/historyEvent.d.ts +0 -40
  39. package/build/internal/src/middleware/network.d.ts +0 -4
  40. package/build/internal/src/middleware/nudge.d.ts +0 -261
  41. package/build/internal/src/middleware/organization.d.ts +0 -946
  42. package/build/internal/src/middleware/placeholder.d.ts +0 -47
  43. package/build/internal/src/middleware/profile.d.ts +0 -11
  44. package/build/internal/src/middleware/releases.d.ts +0 -261
  45. package/build/internal/src/middleware/skin.d.ts +0 -83
  46. package/build/internal/src/middleware/tab.d.ts +0 -27
  47. package/build/internal/src/middleware/types.d.ts +0 -137
  48. package/build/internal/src/middleware/user.d.ts +0 -14
  49. package/build/internal/src/util/Disposable.d.ts +0 -17
  50. package/build/internal/src/util/LocalStorage.d.ts +0 -6
  51. package/build/internal/src/util/Logger.d.ts +0 -18
  52. package/build/internal/src/util/dispatchCustomEvent.d.ts +0 -2
@@ -1,946 +0,0 @@
1
- import * as t from 'io-ts';
2
- export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
3
- export { OrganizationV } from './OrganizationV';
4
- export declare const OrganizationStatusV: t.TypeC<{
5
- id: t.UnionC<[t.NumberC, t.StringC]>;
6
- uuid: t.StringC;
7
- errors_72h: t.NumberC;
8
- suggestions_72h: t.NumberC;
9
- executions_total: t.NumberC;
10
- users_total: t.NumberC;
11
- }>;
12
- export declare const KeyEventV: t.UnionC<[t.LiteralC<"Client-Error">, t.LiteralC<"Command execution">, t.LiteralC<"Command suggestion">, t.LiteralC<"Abandoned search">, t.LiteralC<"Search miss">]>;
13
- export declare const InternalSettingsV: t.TypeC<{
14
- id: t.StringC;
15
- integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.StringC>>;
16
- }>;
17
- export declare const OrganizationSettingsV: t.TypeC<{
18
- end_user_limit: t.NumberC;
19
- user_seat_limit: t.NumberC;
20
- analytics_dashboard_execution_limit: t.NumberC;
21
- analytics_dashboard_deadend_limit: t.NumberC;
22
- silent_mode: t.BooleanC;
23
- allow_event_handlers: t.BooleanC;
24
- event_attribute_block_list: t.ArrayC<t.StringC>;
25
- skins_limit: t.NumberC;
26
- skins_field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
27
- show_countdown_banner: t.BooleanC;
28
- can_install_foobar: t.BooleanC;
29
- releases_available: t.BooleanC;
30
- releases_enabled: t.BooleanC;
31
- releases_environments: t.ArrayC<t.StringC>;
32
- in_bar_feedback: t.BooleanC;
33
- summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
34
- end_user_shortcuts_enabled: t.BooleanC;
35
- fallback_commands: t.ArrayC<t.NumberC>;
36
- end_user_recents_enabled: t.BooleanC;
37
- tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
38
- recommended_tab_enabled: t.BooleanC;
39
- recents_tab_enabled: t.BooleanC;
40
- recommended_tab_instruction: t.StringC;
41
- recents_tab_instruction: t.StringC;
42
- hotload_help_docs: t.BooleanC;
43
- slash_filters_enabled: t.BooleanC;
44
- recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
45
- recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
46
- }>;
47
- export declare class Organization {
48
- static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
49
- onSuccess?: (() => void) | undefined;
50
- onError?: ((err: string) => void) | undefined;
51
- } | undefined) => Promise<{
52
- id: string | number;
53
- name: string;
54
- created: string;
55
- } & {} & {
56
- launcher_type: "alternate" | "none" | "prompt" | "minimal";
57
- launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
58
- show_launcher_recommendations: boolean;
59
- recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
60
- launcher_offset_x: number;
61
- launcher_offset_y: number;
62
- theme: object;
63
- icon: string;
64
- icon_suggest: string;
65
- icon_tutorial: string;
66
- icon_go_forward: string;
67
- resource_options: {
68
- [x: string]: {
69
- name?: string | undefined;
70
- search?: boolean | undefined;
71
- label_field?: string | undefined;
72
- useCategory?: boolean | undefined;
73
- search_fields?: (string | {
74
- key: string;
75
- label: string;
76
- })[] | undefined;
77
- auto_execute?: boolean | undefined;
78
- unfurl?: boolean | undefined;
79
- description_field?: string | undefined;
80
- icon?: string | undefined;
81
- icon_color?: string | undefined;
82
- image_color?: string | undefined;
83
- image?: string | undefined;
84
- sort_key?: number | undefined;
85
- max_options_count?: number | null | undefined;
86
- sortFunction?: any;
87
- default_command_id?: string | number | undefined;
88
- render_as?: "grid" | "list" | undefined;
89
- showResources?: boolean | undefined;
90
- show_with_no_results?: boolean | undefined;
91
- search_tab_enabled?: boolean | undefined;
92
- search_tab_name?: string | null | undefined;
93
- slash_filter_enabled?: boolean | undefined;
94
- slash_filter_keyword?: string | null | undefined;
95
- search_tab_instruction?: string | null | undefined;
96
- setting_pin_to_bottom?: boolean | undefined;
97
- track_recents?: boolean | undefined;
98
- detail?: string | ({
99
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
100
- value: string;
101
- } & {
102
- position?: "inline" | "popover" | undefined;
103
- }) | (string | ({
104
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
105
- value: string;
106
- } & {
107
- position?: "inline" | "popover" | undefined;
108
- }))[] | null | undefined;
109
- };
110
- };
111
- should_show_onboarding: boolean;
112
- last_snippet_request: string | null;
113
- last_snippet_request_in_production: string | null;
114
- branding: string;
115
- custom_call_to_action: string;
116
- search_fuzzy_threshold: number | null;
117
- show_skin_editor: boolean;
118
- allow_event_handlers: boolean;
119
- in_bar_feedback: boolean;
120
- summon_hotkey_override: string | null;
121
- end_user_hotkeys: boolean | undefined;
122
- end_user_shortcuts_enabled: boolean;
123
- end_user_recents_enabled: boolean;
124
- releases_available: boolean;
125
- releases_enabled: boolean;
126
- fallback_commands: number[];
127
- tab_direction: "horizontal" | "vertical";
128
- recommended_tab_enabled: boolean;
129
- recents_tab_enabled: boolean;
130
- recommended_tab_instruction: string;
131
- recents_tab_instruction: string;
132
- hotload_help_docs: boolean;
133
- slash_filters_enabled: boolean;
134
- recents_sort_key: number | null;
135
- recommended_sort_key: number | null;
136
- has_hotloaded_help_docs: boolean;
137
- }>;
138
- static update: (object: {
139
- id: string | number;
140
- name: string;
141
- created: string;
142
- } & {} & {
143
- launcher_type: "alternate" | "none" | "prompt" | "minimal";
144
- launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
145
- show_launcher_recommendations: boolean;
146
- recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
147
- launcher_offset_x: number;
148
- launcher_offset_y: number;
149
- theme: object;
150
- icon: string;
151
- icon_suggest: string;
152
- icon_tutorial: string;
153
- icon_go_forward: string;
154
- resource_options: {
155
- [x: string]: {
156
- name?: string | undefined;
157
- search?: boolean | undefined;
158
- label_field?: string | undefined;
159
- useCategory?: boolean | undefined;
160
- search_fields?: (string | {
161
- key: string;
162
- label: string;
163
- })[] | undefined;
164
- auto_execute?: boolean | undefined;
165
- unfurl?: boolean | undefined;
166
- description_field?: string | undefined;
167
- icon?: string | undefined;
168
- icon_color?: string | undefined;
169
- image_color?: string | undefined;
170
- image?: string | undefined;
171
- sort_key?: number | undefined;
172
- max_options_count?: number | null | undefined;
173
- sortFunction?: any;
174
- default_command_id?: string | number | undefined;
175
- render_as?: "grid" | "list" | undefined;
176
- showResources?: boolean | undefined;
177
- show_with_no_results?: boolean | undefined;
178
- search_tab_enabled?: boolean | undefined;
179
- search_tab_name?: string | null | undefined;
180
- slash_filter_enabled?: boolean | undefined;
181
- slash_filter_keyword?: string | null | undefined;
182
- search_tab_instruction?: string | null | undefined;
183
- setting_pin_to_bottom?: boolean | undefined;
184
- track_recents?: boolean | undefined;
185
- detail?: string | ({
186
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
187
- value: string;
188
- } & {
189
- position?: "inline" | "popover" | undefined;
190
- }) | (string | ({
191
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
192
- value: string;
193
- } & {
194
- position?: "inline" | "popover" | undefined;
195
- }))[] | null | undefined;
196
- };
197
- };
198
- should_show_onboarding: boolean;
199
- last_snippet_request: string | null;
200
- last_snippet_request_in_production: string | null;
201
- branding: string;
202
- custom_call_to_action: string;
203
- search_fuzzy_threshold: number | null;
204
- show_skin_editor: boolean;
205
- allow_event_handlers: boolean;
206
- in_bar_feedback: boolean;
207
- summon_hotkey_override: string | null;
208
- end_user_hotkeys: boolean | undefined;
209
- end_user_shortcuts_enabled: boolean;
210
- end_user_recents_enabled: boolean;
211
- releases_available: boolean;
212
- releases_enabled: boolean;
213
- fallback_commands: number[];
214
- tab_direction: "horizontal" | "vertical";
215
- recommended_tab_enabled: boolean;
216
- recents_tab_enabled: boolean;
217
- recommended_tab_instruction: string;
218
- recents_tab_instruction: string;
219
- hotload_help_docs: boolean;
220
- slash_filters_enabled: boolean;
221
- recents_sort_key: number | null;
222
- recommended_sort_key: number | null;
223
- has_hotloaded_help_docs: boolean;
224
- }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
225
- id: string | number;
226
- name: string;
227
- created: string;
228
- } & {} & {
229
- launcher_type: "alternate" | "none" | "prompt" | "minimal";
230
- launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
231
- show_launcher_recommendations: boolean;
232
- recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
233
- launcher_offset_x: number;
234
- launcher_offset_y: number;
235
- theme: object;
236
- icon: string;
237
- icon_suggest: string;
238
- icon_tutorial: string;
239
- icon_go_forward: string;
240
- resource_options: {
241
- [x: string]: {
242
- name?: string | undefined;
243
- search?: boolean | undefined;
244
- label_field?: string | undefined;
245
- useCategory?: boolean | undefined;
246
- search_fields?: (string | {
247
- key: string;
248
- label: string;
249
- })[] | undefined;
250
- auto_execute?: boolean | undefined;
251
- unfurl?: boolean | undefined;
252
- description_field?: string | undefined;
253
- icon?: string | undefined;
254
- icon_color?: string | undefined;
255
- image_color?: string | undefined;
256
- image?: string | undefined;
257
- sort_key?: number | undefined;
258
- max_options_count?: number | null | undefined;
259
- sortFunction?: any;
260
- default_command_id?: string | number | undefined;
261
- render_as?: "grid" | "list" | undefined;
262
- showResources?: boolean | undefined;
263
- show_with_no_results?: boolean | undefined;
264
- search_tab_enabled?: boolean | undefined;
265
- search_tab_name?: string | null | undefined;
266
- slash_filter_enabled?: boolean | undefined;
267
- slash_filter_keyword?: string | null | undefined;
268
- search_tab_instruction?: string | null | undefined;
269
- setting_pin_to_bottom?: boolean | undefined;
270
- track_recents?: boolean | undefined;
271
- detail?: string | ({
272
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
273
- value: string;
274
- } & {
275
- position?: "inline" | "popover" | undefined;
276
- }) | (string | ({
277
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
278
- value: string;
279
- } & {
280
- position?: "inline" | "popover" | undefined;
281
- }))[] | null | undefined;
282
- };
283
- };
284
- should_show_onboarding: boolean;
285
- last_snippet_request: string | null;
286
- last_snippet_request_in_production: string | null;
287
- branding: string;
288
- custom_call_to_action: string;
289
- search_fuzzy_threshold: number | null;
290
- show_skin_editor: boolean;
291
- allow_event_handlers: boolean;
292
- in_bar_feedback: boolean;
293
- summon_hotkey_override: string | null;
294
- end_user_hotkeys: boolean | undefined;
295
- end_user_shortcuts_enabled: boolean;
296
- end_user_recents_enabled: boolean;
297
- releases_available: boolean;
298
- releases_enabled: boolean;
299
- fallback_commands: number[];
300
- tab_direction: "horizontal" | "vertical";
301
- recommended_tab_enabled: boolean;
302
- recents_tab_enabled: boolean;
303
- recommended_tab_instruction: string;
304
- recents_tab_instruction: string;
305
- hotload_help_docs: boolean;
306
- slash_filters_enabled: boolean;
307
- recents_sort_key: number | null;
308
- recommended_sort_key: number | null;
309
- has_hotloaded_help_docs: boolean;
310
- }>;
311
- static listCommands: (orgUID: string) => Promise<({
312
- id: number;
313
- organization: string | number;
314
- text: string;
315
- template: ({
316
- type: "admin";
317
- value: string;
318
- } & {} & {
319
- commandType?: "object" | "help" | "independent" | undefined;
320
- object?: string | undefined;
321
- hoverTooltip?: boolean | undefined;
322
- operation?: "self" | "router" | "blank" | undefined;
323
- }) | ({
324
- type: "callback";
325
- value: string;
326
- } & {} & {
327
- commandType?: "object" | "help" | "independent" | undefined;
328
- object?: string | undefined;
329
- hoverTooltip?: boolean | undefined;
330
- operation?: "self" | "router" | "blank" | undefined;
331
- }) | ({
332
- type: "link";
333
- value: string;
334
- } & {} & {
335
- commandType?: "object" | "help" | "independent" | undefined;
336
- object?: string | undefined;
337
- hoverTooltip?: boolean | undefined;
338
- operation?: "self" | "router" | "blank" | undefined;
339
- }) | ({
340
- type: "click" | "clickByXpath" | "clickBySelector";
341
- value: string[];
342
- } & {} & {
343
- commandType?: "object" | "help" | "independent" | undefined;
344
- object?: string | undefined;
345
- hoverTooltip?: boolean | undefined;
346
- operation?: "self" | "router" | "blank" | undefined;
347
- }) | ({
348
- type: "builtin";
349
- value: string;
350
- } & {} & {
351
- commandType?: "object" | "help" | "independent" | undefined;
352
- object?: string | undefined;
353
- hoverTooltip?: boolean | undefined;
354
- operation?: "self" | "router" | "blank" | undefined;
355
- }) | ({
356
- type: "webhook";
357
- value: string;
358
- } & {} & {
359
- commandType?: "object" | "help" | "independent" | undefined;
360
- object?: string | undefined;
361
- hoverTooltip?: boolean | undefined;
362
- operation?: "self" | "router" | "blank" | undefined;
363
- }) | ({
364
- type: "script";
365
- value: string;
366
- } & {} & {
367
- commandType?: "object" | "help" | "independent" | undefined;
368
- object?: string | undefined;
369
- hoverTooltip?: boolean | undefined;
370
- operation?: "self" | "router" | "blank" | undefined;
371
- }) | ({
372
- type: "request";
373
- value: {
374
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
375
- url: string;
376
- } & {
377
- headers?: {
378
- [key: string]: unknown;
379
- } | undefined;
380
- body?: {
381
- [key: string]: unknown;
382
- } | undefined;
383
- onSend?: string | undefined;
384
- onSuccess?: string | undefined;
385
- onError?: string | undefined;
386
- };
387
- } & {} & {
388
- commandType?: "object" | "help" | "independent" | undefined;
389
- object?: string | undefined;
390
- hoverTooltip?: boolean | undefined;
391
- operation?: "self" | "router" | "blank" | undefined;
392
- }) | ({
393
- type: "appcues";
394
- value: string;
395
- } & {} & {
396
- commandType?: "object" | "help" | "independent" | undefined;
397
- object?: string | undefined;
398
- hoverTooltip?: boolean | undefined;
399
- operation?: "self" | "router" | "blank" | undefined;
400
- }) | ({
401
- type: "video";
402
- value: string;
403
- } & {} & {
404
- commandType?: "object" | "help" | "independent" | undefined;
405
- object?: string | undefined;
406
- hoverTooltip?: boolean | undefined;
407
- operation?: "self" | "router" | "blank" | undefined;
408
- }) | ({
409
- type: "helpdoc";
410
- value: string;
411
- } & {} & {
412
- commandType?: "object" | "help" | "independent" | undefined;
413
- object?: string | undefined;
414
- hoverTooltip?: boolean | undefined;
415
- operation?: "self" | "router" | "blank" | undefined;
416
- });
417
- } & {
418
- disabledReason?: string | undefined;
419
- source?: string | undefined;
420
- name?: string | undefined;
421
- last_available?: string | null | undefined;
422
- modified?: string | undefined;
423
- isAsync?: boolean | undefined;
424
- } & {
425
- arguments: {
426
- [x: string]: ({
427
- type: "context";
428
- value: string;
429
- order_key: number;
430
- } & {
431
- label?: string | undefined;
432
- chosen?: string | number | undefined;
433
- selected?: any[] | undefined;
434
- input_type?: string | undefined;
435
- preselected_key?: string | undefined;
436
- label_field?: string | undefined;
437
- availability_condition?: {
438
- field: string;
439
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
440
- value: string | undefined;
441
- }[] | undefined;
442
- loaded?: any[] | undefined;
443
- allow_create?: boolean | undefined;
444
- allow_create_label?: string | undefined;
445
- show_in_record_action_list?: boolean | undefined;
446
- show_in_default_list?: boolean | undefined;
447
- auto_choose?: boolean | undefined;
448
- is_private?: boolean | undefined;
449
- }) | ({
450
- type: "set";
451
- value: string[] | number[] | {
452
- [key: string]: unknown;
453
- }[];
454
- order_key: number;
455
- } & {
456
- label?: string | undefined;
457
- chosen?: string | number | undefined;
458
- selected?: any[] | undefined;
459
- input_type?: string | undefined;
460
- preselected_key?: string | undefined;
461
- label_field?: string | undefined;
462
- availability_condition?: {
463
- field: string;
464
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
465
- value: string | undefined;
466
- }[] | undefined;
467
- loaded?: any[] | undefined;
468
- allow_create?: boolean | undefined;
469
- allow_create_label?: string | undefined;
470
- auto_choose?: boolean | undefined;
471
- is_private?: boolean | undefined;
472
- }) | ({
473
- type: "provided";
474
- value: "time" | "text";
475
- order_key: number;
476
- } & {
477
- label?: string | undefined;
478
- chosen?: string | number | undefined;
479
- selected?: any[] | undefined;
480
- input_type?: string | undefined;
481
- preselected_key?: string | undefined;
482
- label_field?: string | undefined;
483
- availability_condition?: {
484
- field: string;
485
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
486
- value: string | undefined;
487
- }[] | undefined;
488
- loaded?: any[] | undefined;
489
- dateTimeArgumentTypeId?: number | undefined;
490
- allow_create?: boolean | undefined;
491
- allow_create_label?: string | undefined;
492
- auto_choose?: boolean | undefined;
493
- is_private?: boolean | undefined;
494
- }) | ({
495
- type: "dependent";
496
- value: string;
497
- order_key: number;
498
- } & {
499
- label?: string | undefined;
500
- chosen?: string | number | undefined;
501
- selected?: any[] | undefined;
502
- input_type?: string | undefined;
503
- preselected_key?: string | undefined;
504
- label_field?: string | undefined;
505
- availability_condition?: {
506
- field: string;
507
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
508
- value: string | undefined;
509
- }[] | undefined;
510
- loaded?: any[] | undefined;
511
- allow_create?: boolean | undefined;
512
- allow_create_label?: string | undefined;
513
- auto_choose?: boolean | undefined;
514
- is_private?: boolean | undefined;
515
- }) | ({
516
- type: "function";
517
- value: string;
518
- order_key: number;
519
- } & {
520
- label?: string | undefined;
521
- chosen?: string | number | undefined;
522
- selected?: any[] | undefined;
523
- input_type?: string | undefined;
524
- preselected_key?: string | undefined;
525
- label_field?: string | undefined;
526
- availability_condition?: {
527
- field: string;
528
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
529
- value: string | undefined;
530
- }[] | undefined;
531
- loaded?: any[] | undefined;
532
- allow_create?: boolean | undefined;
533
- allow_create_label?: string | undefined;
534
- auto_choose?: boolean | undefined;
535
- is_private?: boolean | undefined;
536
- }) | ({
537
- type: "html" | "video";
538
- value: {
539
- source: string;
540
- } & {
541
- title?: string | undefined;
542
- description?: string | undefined;
543
- url?: string | undefined;
544
- };
545
- order_key: number;
546
- } & {
547
- label?: string | undefined;
548
- chosen?: string | number | undefined;
549
- selected?: any[] | undefined;
550
- input_type?: string | undefined;
551
- preselected_key?: string | undefined;
552
- label_field?: string | undefined;
553
- availability_condition?: {
554
- field: string;
555
- operator: "==" | "!=" | "isTruthy" | "isFalsy";
556
- value: string | undefined;
557
- }[] | undefined;
558
- loaded?: any[] | undefined;
559
- allow_create?: boolean | undefined;
560
- allow_create_label?: string | undefined;
561
- is_private?: boolean | undefined;
562
- auto_choose?: boolean | undefined;
563
- });
564
- };
565
- tags: string[];
566
- 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";
569
- } & {
570
- field?: string | undefined;
571
- value?: string | undefined;
572
- reason?: string | undefined;
573
- })[] | (({
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";
576
- } & {
577
- field?: string | undefined;
578
- value?: string | undefined;
579
- reason?: string | undefined;
580
- }) | ({
581
- type: "named_rule";
582
- rule_id: number;
583
- } & {
584
- reason?: string | undefined;
585
- }))[];
586
- 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";
589
- } & {
590
- field?: string | undefined;
591
- value?: string | undefined;
592
- reason?: string | undefined;
593
- }) | ({
594
- type: "always";
595
- } & {
596
- operator?: null | undefined;
597
- field?: null | undefined;
598
- value?: null | undefined;
599
- reason?: null | undefined;
600
- }))[] | (({
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";
603
- } & {
604
- field?: string | undefined;
605
- value?: string | undefined;
606
- reason?: string | undefined;
607
- }) | ({
608
- type: "always";
609
- } & {
610
- operator?: null | undefined;
611
- field?: null | undefined;
612
- value?: null | undefined;
613
- reason?: null | undefined;
614
- }) | ({
615
- type: "named_rule";
616
- rule_id: number;
617
- } & {
618
- reason?: string | undefined;
619
- }))[];
620
- availability_expression: import("./helpers/rules").RuleExpression;
621
- recommend_expression: import("./helpers/rules").RuleExpression;
622
- always_recommend: boolean;
623
- confirm: string;
624
- shortcut: string[];
625
- explanation: string;
626
- heading: string;
627
- is_live: boolean;
628
- category: number | null;
629
- sort_key: number | null;
630
- icon: string | null;
631
- icon_color: string | null;
632
- image_color: string | null;
633
- image: string | null;
634
- celebrate: boolean | {
635
- angle?: number | undefined;
636
- spread?: number | undefined;
637
- width?: string | undefined;
638
- height?: string | undefined;
639
- duration?: number | undefined;
640
- dragFriction?: number | undefined;
641
- stagger?: number | undefined;
642
- startVelocity?: number | undefined;
643
- elementCount?: number | undefined;
644
- decay?: number | undefined;
645
- colors?: string[] | undefined;
646
- random?: any;
647
- } | null;
648
- recommend_sort_key: number | null;
649
- shortcut_mac: string[];
650
- shortcut_win: string[];
651
- hotkey_mac: string;
652
- hotkey_win: string;
653
- detail: string | ({
654
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
655
- value: string;
656
- } & {
657
- position?: "inline" | "popover" | undefined;
658
- }) | (string | ({
659
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
660
- value: string;
661
- } & {
662
- position?: "inline" | "popover" | undefined;
663
- }))[] | null;
664
- next_steps: (string | number)[];
665
- } & {
666
- third_party_source?: string | null | undefined;
667
- third_party_id?: string | null | undefined;
668
- })[]>;
669
- static listCommandCategories: (orgUID: string) => Promise<({
670
- id: number;
671
- organization: string | number;
672
- name: string;
673
- } & {} & {
674
- sort_key: number | null;
675
- icon: string | null;
676
- icon_color: string | null;
677
- image_color: string | null;
678
- image: string | null;
679
- render_as: "grid" | "list";
680
- setting_hide_before_search: boolean;
681
- setting_max_options_count: number | null;
682
- setting_pin_to_bottom: boolean;
683
- search_tab_enabled: boolean;
684
- search_tab_name: string;
685
- slash_filter_enabled: boolean;
686
- slash_filter_keyword: string | null;
687
- search_tab_instruction: string;
688
- track_recents: boolean;
689
- } & {
690
- contains_hotloaded_commands?: boolean | undefined;
691
- })[]>;
692
- static listGuides: (orgUID: string) => Promise<({
693
- id: number;
694
- organization: string;
695
- event: string;
696
- nudge: string;
697
- guidance: string;
698
- } & {})[]>;
699
- static listContexts: (orgUID: string) => Promise<({
700
- id: number;
701
- name: string;
702
- organization: string;
703
- value: {
704
- [x: string]: any;
705
- };
706
- } & {})[]>;
707
- static listPlaceholders: (orgUID: string) => Promise<({
708
- id: number;
709
- organization: string;
710
- slug: string;
711
- text: string;
712
- } & {})[]>;
713
- static listRules: (orgUID: string) => Promise<{
714
- id: number;
715
- name: string;
716
- expression: import("./helpers/rules").RuleExpression;
717
- }[]>;
718
- static userHasAccess: (uuid: string, user: string) => Promise<{
719
- username: string;
720
- slug: string;
721
- organization: string;
722
- has_access: boolean;
723
- has_opened: boolean;
724
- hotkeys_debug: boolean;
725
- hmac: string | undefined;
726
- }>;
727
- static readHealth: (arg0: string, urlArgs?: {
728
- [arg: string]: string;
729
- } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
730
- id: string | number;
731
- uuid: string;
732
- errors_72h: number;
733
- suggestions_72h: number;
734
- executions_total: number;
735
- users_total: number;
736
- }>;
737
- static readInternal: (arg0: string, urlArgs?: {
738
- [arg: string]: string;
739
- } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
740
- id: string;
741
- integrations: {
742
- [x: string]: {
743
- [x: string]: string;
744
- };
745
- };
746
- }>;
747
- static updateInternal: (object: {
748
- id: string;
749
- integrations: {
750
- [x: string]: {
751
- [x: string]: string;
752
- };
753
- };
754
- }, urlArgs?: {
755
- [arg: string]: string;
756
- } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
757
- id: string;
758
- integrations: {
759
- [x: string]: {
760
- [x: string]: string;
761
- };
762
- };
763
- }>;
764
- static readSettings: (params?: Record<string, string> | undefined, callbacks?: {
765
- onSuccess?: (() => void) | undefined;
766
- onError?: ((err: string) => void) | undefined;
767
- } | undefined) => Promise<{
768
- end_user_limit: number;
769
- user_seat_limit: number;
770
- analytics_dashboard_execution_limit: number;
771
- analytics_dashboard_deadend_limit: number;
772
- silent_mode: boolean;
773
- allow_event_handlers: boolean;
774
- event_attribute_block_list: string[];
775
- skins_limit: number;
776
- skins_field_set: "basic" | "pro";
777
- show_countdown_banner: boolean;
778
- can_install_foobar: boolean;
779
- releases_available: boolean;
780
- releases_enabled: boolean;
781
- releases_environments: string[];
782
- in_bar_feedback: boolean;
783
- summon_hotkey_override: string | null;
784
- end_user_shortcuts_enabled: boolean;
785
- fallback_commands: number[];
786
- end_user_recents_enabled: boolean;
787
- tab_direction: "horizontal" | "vertical";
788
- recommended_tab_enabled: boolean;
789
- recents_tab_enabled: boolean;
790
- recommended_tab_instruction: string;
791
- recents_tab_instruction: string;
792
- hotload_help_docs: boolean;
793
- slash_filters_enabled: boolean;
794
- recents_sort_key: number | null;
795
- recommended_sort_key: number | null;
796
- }>;
797
- static updateSetting: (object: {
798
- end_user_limit?: number | undefined;
799
- user_seat_limit?: number | undefined;
800
- analytics_dashboard_execution_limit?: number | undefined;
801
- analytics_dashboard_deadend_limit?: number | undefined;
802
- silent_mode?: boolean | undefined;
803
- allow_event_handlers?: boolean | undefined;
804
- event_attribute_block_list?: string[] | undefined;
805
- skins_limit?: number | undefined;
806
- skins_field_set?: "basic" | "pro" | undefined;
807
- show_countdown_banner?: boolean | undefined;
808
- can_install_foobar?: boolean | undefined;
809
- releases_available?: boolean | undefined;
810
- releases_enabled?: boolean | undefined;
811
- releases_environments?: string[] | undefined;
812
- in_bar_feedback?: boolean | undefined;
813
- summon_hotkey_override?: string | null | undefined;
814
- end_user_shortcuts_enabled?: boolean | undefined;
815
- fallback_commands?: number[] | undefined;
816
- end_user_recents_enabled?: boolean | undefined;
817
- tab_direction?: "horizontal" | "vertical" | undefined;
818
- recommended_tab_enabled?: boolean | undefined;
819
- recents_tab_enabled?: boolean | undefined;
820
- recommended_tab_instruction?: string | undefined;
821
- recents_tab_instruction?: string | undefined;
822
- hotload_help_docs?: boolean | undefined;
823
- slash_filters_enabled?: boolean | undefined;
824
- recents_sort_key?: number | null | undefined;
825
- recommended_sort_key?: number | null | undefined;
826
- }, params?: Record<string, string> | undefined, callbacks?: {
827
- onSuccess?: (() => void) | undefined;
828
- onError?: ((err: string) => void) | undefined;
829
- } | undefined) => Promise<{
830
- end_user_limit: number;
831
- user_seat_limit: number;
832
- analytics_dashboard_execution_limit: number;
833
- analytics_dashboard_deadend_limit: number;
834
- silent_mode: boolean;
835
- allow_event_handlers: boolean;
836
- event_attribute_block_list: string[];
837
- skins_limit: number;
838
- skins_field_set: "basic" | "pro";
839
- show_countdown_banner: boolean;
840
- can_install_foobar: boolean;
841
- releases_available: boolean;
842
- releases_enabled: boolean;
843
- releases_environments: string[];
844
- in_bar_feedback: boolean;
845
- summon_hotkey_override: string | null;
846
- end_user_shortcuts_enabled: boolean;
847
- fallback_commands: number[];
848
- end_user_recents_enabled: boolean;
849
- tab_direction: "horizontal" | "vertical";
850
- recommended_tab_enabled: boolean;
851
- recents_tab_enabled: boolean;
852
- recommended_tab_instruction: string;
853
- recents_tab_instruction: string;
854
- hotload_help_docs: boolean;
855
- slash_filters_enabled: boolean;
856
- recents_sort_key: number | null;
857
- recommended_sort_key: number | null;
858
- }>;
859
- static decode: (data: any) => {
860
- id: string | number;
861
- name: string;
862
- created: string;
863
- } & {} & {
864
- launcher_type: "alternate" | "none" | "prompt" | "minimal";
865
- launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
866
- show_launcher_recommendations: boolean;
867
- recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
868
- launcher_offset_x: number;
869
- launcher_offset_y: number;
870
- theme: object;
871
- icon: string;
872
- icon_suggest: string;
873
- icon_tutorial: string;
874
- icon_go_forward: string;
875
- resource_options: {
876
- [x: string]: {
877
- name?: string | undefined;
878
- search?: boolean | undefined;
879
- label_field?: string | undefined;
880
- useCategory?: boolean | undefined;
881
- search_fields?: (string | {
882
- key: string;
883
- label: string;
884
- })[] | undefined;
885
- auto_execute?: boolean | undefined;
886
- unfurl?: boolean | undefined;
887
- description_field?: string | undefined;
888
- icon?: string | undefined;
889
- icon_color?: string | undefined;
890
- image_color?: string | undefined;
891
- image?: string | undefined;
892
- sort_key?: number | undefined;
893
- max_options_count?: number | null | undefined;
894
- sortFunction?: any;
895
- default_command_id?: string | number | undefined;
896
- render_as?: "grid" | "list" | undefined;
897
- showResources?: boolean | undefined;
898
- show_with_no_results?: boolean | undefined;
899
- search_tab_enabled?: boolean | undefined;
900
- search_tab_name?: string | null | undefined;
901
- slash_filter_enabled?: boolean | undefined;
902
- slash_filter_keyword?: string | null | undefined;
903
- search_tab_instruction?: string | null | undefined;
904
- setting_pin_to_bottom?: boolean | undefined;
905
- track_recents?: boolean | undefined;
906
- detail?: string | ({
907
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
908
- value: string;
909
- } & {
910
- position?: "inline" | "popover" | undefined;
911
- }) | (string | ({
912
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
913
- value: string;
914
- } & {
915
- position?: "inline" | "popover" | undefined;
916
- }))[] | null | undefined;
917
- };
918
- };
919
- should_show_onboarding: boolean;
920
- last_snippet_request: string | null;
921
- last_snippet_request_in_production: string | null;
922
- branding: string;
923
- custom_call_to_action: string;
924
- search_fuzzy_threshold: number | null;
925
- show_skin_editor: boolean;
926
- allow_event_handlers: boolean;
927
- in_bar_feedback: boolean;
928
- summon_hotkey_override: string | null;
929
- end_user_hotkeys: boolean | undefined;
930
- end_user_shortcuts_enabled: boolean;
931
- end_user_recents_enabled: boolean;
932
- releases_available: boolean;
933
- releases_enabled: boolean;
934
- fallback_commands: number[];
935
- tab_direction: "horizontal" | "vertical";
936
- recommended_tab_enabled: boolean;
937
- recents_tab_enabled: boolean;
938
- recommended_tab_instruction: string;
939
- recents_tab_instruction: string;
940
- hotload_help_docs: boolean;
941
- slash_filters_enabled: boolean;
942
- recents_sort_key: number | null;
943
- recommended_sort_key: number | null;
944
- has_hotloaded_help_docs: boolean;
945
- };
946
- }