commandbar 1.7.3 → 1.8.2

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