commandbar 1.8.5 → 1.8.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/internal/src/client/AddContextOptions.d.ts +141 -0
  3. package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -0
  4. package/build/internal/src/client/CommandBarClientSDK.d.ts +403 -0
  5. package/build/internal/src/client/CommandBarProxySDK.d.ts +49 -0
  6. package/build/internal/src/client/CommandBarSDK.d.ts +79 -0
  7. package/build/internal/src/client/EventHandler.d.ts +282 -0
  8. package/build/internal/src/client/OrgConfig.d.ts +5 -0
  9. package/build/internal/src/client/SDKConfig.d.ts +13 -0
  10. package/build/internal/src/client/SentryReporter.d.ts +63 -0
  11. package/build/internal/src/client/globals.d.ts +20 -0
  12. package/build/internal/src/client/proxy.d.ts +15 -0
  13. package/build/internal/src/client/symbols.d.ts +50 -0
  14. package/build/internal/src/middleware/CommandFromClientV.d.ts +283 -0
  15. package/build/internal/src/middleware/ICommandFromClientType.d.ts +5 -0
  16. package/build/internal/src/middleware/IResourceSettings.d.ts +3 -0
  17. package/build/internal/src/middleware/OrganizationV.d.ts +329 -0
  18. package/build/internal/src/middleware/ResourceSettingsV.d.ts +119 -0
  19. package/build/internal/src/middleware/additionalResource.d.ts +302 -0
  20. package/build/internal/src/middleware/billing.d.ts +41 -0
  21. package/build/internal/src/middleware/chatAnalytics.d.ts +2601 -0
  22. package/build/internal/src/middleware/checklist.d.ts +1014 -0
  23. package/build/internal/src/middleware/command.d.ts +8908 -0
  24. package/build/internal/src/middleware/commandCategory.d.ts +192 -0
  25. package/build/internal/src/middleware/confetti.d.ts +16 -0
  26. package/build/internal/src/middleware/context.d.ts +40 -0
  27. package/build/internal/src/middleware/dashboardFlags.d.ts +9 -0
  28. package/build/internal/src/middleware/detailPreview.d.ts +24 -0
  29. package/build/internal/src/middleware/environment.d.ts +11 -0
  30. package/build/internal/src/middleware/generics.d.ts +42 -0
  31. package/build/internal/src/middleware/guide.d.ts +37 -0
  32. package/build/internal/src/middleware/helpDocsIntegration.d.ts +72 -0
  33. package/build/internal/src/middleware/helpDocsSync.d.ts +63 -0
  34. package/build/internal/src/middleware/helpers/actions.d.ts +184 -0
  35. package/build/internal/src/middleware/helpers/argument.d.ts +318 -0
  36. package/build/internal/src/middleware/helpers/audience.d.ts +15 -0
  37. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +252 -0
  38. package/build/internal/src/middleware/helpers/endUser.d.ts +11 -0
  39. package/build/internal/src/middleware/helpers/frequencyLimit.d.ts +2 -0
  40. package/build/internal/src/middleware/helpers/goals.d.ts +26 -0
  41. package/build/internal/src/middleware/helpers/optionGroup.d.ts +2 -0
  42. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +26 -0
  43. package/build/internal/src/middleware/helpers/rules.d.ts +289 -0
  44. package/build/internal/src/middleware/helpers/tags.d.ts +7 -0
  45. package/build/internal/src/middleware/historyEvent.d.ts +21 -0
  46. package/build/internal/src/middleware/network.d.ts +3 -0
  47. package/build/internal/src/middleware/nudge.d.ts +1669 -0
  48. package/build/internal/src/middleware/organization.d.ts +1540 -0
  49. package/build/internal/src/middleware/organizationSettings.d.ts +330 -0
  50. package/build/internal/src/middleware/placeholder.d.ts +47 -0
  51. package/build/internal/src/middleware/profile.d.ts +11 -0
  52. package/build/internal/src/middleware/qaPair.d.ts +676 -0
  53. package/build/internal/src/middleware/recommendationSet.d.ts +1199 -0
  54. package/build/internal/src/middleware/releases.d.ts +261 -0
  55. package/build/internal/src/middleware/skin.d.ts +102 -0
  56. package/build/internal/src/middleware/tab.d.ts +27 -0
  57. package/build/internal/src/middleware/types.d.ts +218 -0
  58. package/build/internal/src/middleware/user.d.ts +15 -0
  59. package/build/internal/src/middleware/utils.d.ts +11 -0
  60. package/build/internal/src/util/Disposable.d.ts +17 -0
  61. package/build/internal/src/util/LocalStorage.d.ts +6 -0
  62. package/build/internal/src/util/Logger.d.ts +18 -0
  63. package/build/internal/src/util/dispatchCustomEvent.d.ts +12 -0
  64. package/build/internal/src/util/integrations.d.ts +1 -0
  65. package/package.json +3 -3
  66. package/jest.config.js +0 -4
  67. package/scripts/minify-snippet.ts +0 -36
  68. package/scripts/watch.ts +0 -5
  69. package/src/commandbar-launcher.d.ts +0 -7
  70. package/test/init.test.ts +0 -3
  71. package/tsconfig.json +0 -24
  72. package/webpack.config.js +0 -35
@@ -0,0 +1,1540 @@
1
+ import * as t from 'io-ts';
2
+ export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
3
+ export { OrganizationV, unknownOrganization } 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.UnionC<[t.StringC, t.BooleanC, t.RecordC<t.StringC, t.StringC>]>>>;
16
+ }>;
17
+ export declare const read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
18
+ onSuccess?: (() => void) | undefined;
19
+ onError?: ((err: string) => void) | undefined;
20
+ } | undefined) => Promise<{
21
+ id: string | number;
22
+ name: string;
23
+ created: string;
24
+ } & {} & {
25
+ launcher_type: "alternate" | "none" | "prompt" | "minimal";
26
+ launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
27
+ show_launcher_recommendations: boolean;
28
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
29
+ launcher_offset_x: number;
30
+ launcher_offset_y: number;
31
+ helphub_launcher_offset_x: number;
32
+ helphub_launcher_offset_y: number;
33
+ helphub_launcher_anchor: string;
34
+ helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
35
+ helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
36
+ base_url: string;
37
+ theme: object;
38
+ icon: string;
39
+ icon_suggest: string;
40
+ icon_tutorial: string;
41
+ icon_go_forward: string;
42
+ chat_system_prompt_modifier: string;
43
+ helphub_chat_welcome_message: string;
44
+ helphub_chat_avatar: string;
45
+ resource_options: {
46
+ [x: string]: {
47
+ name?: string | undefined;
48
+ search?: boolean | undefined;
49
+ label_field?: string | undefined;
50
+ useCategory?: boolean | undefined;
51
+ search_fields?: (string | {
52
+ key: string;
53
+ label: string;
54
+ })[] | undefined;
55
+ auto_execute?: boolean | undefined;
56
+ unfurl?: boolean | undefined;
57
+ description_field?: string | undefined;
58
+ icon?: string | undefined;
59
+ icon_color?: string | undefined;
60
+ image_color?: string | undefined;
61
+ image?: string | undefined;
62
+ sort_key?: number | undefined;
63
+ max_options_count?: number | null | undefined;
64
+ sortFunction?: any;
65
+ onInputChangeOptions?: {
66
+ applySort?: boolean | undefined;
67
+ } | undefined;
68
+ default_command_id?: string | number | undefined;
69
+ render_as?: "grid" | "list" | undefined;
70
+ showResources?: boolean | undefined;
71
+ show_with_no_results?: boolean | undefined;
72
+ search_tab_enabled?: boolean | undefined;
73
+ search_tab_name?: string | null | undefined;
74
+ slash_filter_enabled?: boolean | undefined;
75
+ slash_filter_keyword?: string | null | undefined;
76
+ search_tab_instruction?: string | null | undefined;
77
+ setting_pin_to_bottom?: boolean | undefined;
78
+ track_recents?: boolean | undefined;
79
+ detail?: string | ({
80
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
81
+ value: string;
82
+ } & {
83
+ position?: "inline" | "popover" | undefined;
84
+ }) | (string | ({
85
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
86
+ value: string;
87
+ } & {
88
+ position?: "inline" | "popover" | undefined;
89
+ }))[] | null | undefined;
90
+ content?: string | ({
91
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
92
+ value: string;
93
+ } & {
94
+ position?: "inline" | "popover" | undefined;
95
+ }) | (string | ({
96
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
97
+ value: string;
98
+ } & {
99
+ position?: "inline" | "popover" | undefined;
100
+ }))[] | null | undefined;
101
+ show_preview?: boolean | undefined;
102
+ };
103
+ };
104
+ should_show_onboarding: boolean;
105
+ last_snippet_request: string | null;
106
+ last_snippet_request_in_production: string | null;
107
+ branding: string;
108
+ custom_call_to_action: string;
109
+ search_fuzzy_threshold: number | null;
110
+ show_skin_editor: boolean;
111
+ allow_event_handlers: boolean;
112
+ in_bar_feedback: boolean;
113
+ summon_hotkey_override: string | null;
114
+ end_user_hotkeys: boolean | undefined;
115
+ force_end_user_identity_verification: boolean;
116
+ force_end_user_identity_verification_for_helphub: boolean;
117
+ end_user_shortcuts_enabled: boolean;
118
+ end_user_recents_enabled: boolean;
119
+ releases_available: boolean;
120
+ releases_enabled: boolean;
121
+ fallback_commands: number[];
122
+ event_attribute_block_list: string[];
123
+ tab_direction: "horizontal" | "vertical";
124
+ recommended_tab_enabled: boolean;
125
+ recents_tab_enabled: boolean;
126
+ recommended_tab_instruction: string;
127
+ recents_tab_instruction: string;
128
+ hotload_help_docs: boolean;
129
+ slash_filters_enabled: boolean;
130
+ recents_sort_key: number | null;
131
+ recommended_sort_key: number | null;
132
+ show_suggested_synonyms: boolean;
133
+ has_hotloaded_help_docs: boolean;
134
+ bar_enabled: boolean;
135
+ in_bar_doc_search: boolean;
136
+ featured_item_cards: boolean;
137
+ helphub_ai_enabled: boolean;
138
+ helphub_suggested_queries_enabled: boolean;
139
+ helphub_continuations_enabled: boolean;
140
+ helphub_chat_only_mode: boolean;
141
+ helphub_enabled: boolean;
142
+ helphub_chat_fallback_message: string | null;
143
+ helphub_chat_fallback_actions: {
144
+ cta: string;
145
+ action: {
146
+ type: "execute_command";
147
+ meta: {
148
+ command: string;
149
+ };
150
+ } | {
151
+ type: "no_action";
152
+ } | {
153
+ type: "click";
154
+ value: string;
155
+ } | ({
156
+ type: "link";
157
+ value: string;
158
+ } & {
159
+ operation?: "self" | "router" | "blank" | undefined;
160
+ }) | {
161
+ type: "open_chat";
162
+ meta: {
163
+ type: string;
164
+ };
165
+ } | {
166
+ type: "dismiss";
167
+ };
168
+ }[];
169
+ helphub_manual_suggested_queries: string[];
170
+ nudge_rate_limit: number | null;
171
+ bar_hide_completed_nudges_questlists: boolean;
172
+ nudge_rate_period: "day" | "week" | "session";
173
+ installed_at: string | null;
174
+ integrations: {
175
+ algolia?: {
176
+ indexes: {
177
+ [x: string]: string | {
178
+ [x: string]: string;
179
+ };
180
+ };
181
+ applicationID: string | undefined;
182
+ apiKey: string | undefined;
183
+ } | undefined;
184
+ heap?: {
185
+ segments: {
186
+ [x: string]: string;
187
+ };
188
+ send_events_to_heap: boolean;
189
+ } | undefined;
190
+ };
191
+ }>;
192
+ export declare const update: (object: {
193
+ id: string | number;
194
+ name: string;
195
+ created: string;
196
+ } & {} & {
197
+ launcher_type: "alternate" | "none" | "prompt" | "minimal";
198
+ launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
199
+ show_launcher_recommendations: boolean;
200
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
201
+ launcher_offset_x: number;
202
+ launcher_offset_y: number;
203
+ helphub_launcher_offset_x: number;
204
+ helphub_launcher_offset_y: number;
205
+ helphub_launcher_anchor: string;
206
+ helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
207
+ helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
208
+ base_url: string;
209
+ theme: object;
210
+ icon: string;
211
+ icon_suggest: string;
212
+ icon_tutorial: string;
213
+ icon_go_forward: string;
214
+ chat_system_prompt_modifier: string;
215
+ helphub_chat_welcome_message: string;
216
+ helphub_chat_avatar: string;
217
+ resource_options: {
218
+ [x: string]: {
219
+ name?: string | undefined;
220
+ search?: boolean | undefined;
221
+ label_field?: string | undefined;
222
+ useCategory?: boolean | undefined;
223
+ search_fields?: (string | {
224
+ key: string;
225
+ label: string;
226
+ })[] | undefined;
227
+ auto_execute?: boolean | undefined;
228
+ unfurl?: boolean | undefined;
229
+ description_field?: string | undefined;
230
+ icon?: string | undefined;
231
+ icon_color?: string | undefined;
232
+ image_color?: string | undefined;
233
+ image?: string | undefined;
234
+ sort_key?: number | undefined;
235
+ max_options_count?: number | null | undefined;
236
+ sortFunction?: any;
237
+ onInputChangeOptions?: {
238
+ applySort?: boolean | undefined;
239
+ } | undefined;
240
+ default_command_id?: string | number | undefined;
241
+ render_as?: "grid" | "list" | undefined;
242
+ showResources?: boolean | undefined;
243
+ show_with_no_results?: boolean | undefined;
244
+ search_tab_enabled?: boolean | undefined;
245
+ search_tab_name?: string | null | undefined;
246
+ slash_filter_enabled?: boolean | undefined;
247
+ slash_filter_keyword?: string | null | undefined;
248
+ search_tab_instruction?: string | null | undefined;
249
+ setting_pin_to_bottom?: boolean | undefined;
250
+ track_recents?: boolean | undefined;
251
+ detail?: string | ({
252
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
253
+ value: string;
254
+ } & {
255
+ position?: "inline" | "popover" | undefined;
256
+ }) | (string | ({
257
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
258
+ value: string;
259
+ } & {
260
+ position?: "inline" | "popover" | undefined;
261
+ }))[] | null | undefined;
262
+ content?: string | ({
263
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
264
+ value: string;
265
+ } & {
266
+ position?: "inline" | "popover" | undefined;
267
+ }) | (string | ({
268
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
269
+ value: string;
270
+ } & {
271
+ position?: "inline" | "popover" | undefined;
272
+ }))[] | null | undefined;
273
+ show_preview?: boolean | undefined;
274
+ };
275
+ };
276
+ should_show_onboarding: boolean;
277
+ last_snippet_request: string | null;
278
+ last_snippet_request_in_production: string | null;
279
+ branding: string;
280
+ custom_call_to_action: string;
281
+ search_fuzzy_threshold: number | null;
282
+ show_skin_editor: boolean;
283
+ allow_event_handlers: boolean;
284
+ in_bar_feedback: boolean;
285
+ summon_hotkey_override: string | null;
286
+ end_user_hotkeys: boolean | undefined;
287
+ force_end_user_identity_verification: boolean;
288
+ force_end_user_identity_verification_for_helphub: boolean;
289
+ end_user_shortcuts_enabled: boolean;
290
+ end_user_recents_enabled: boolean;
291
+ releases_available: boolean;
292
+ releases_enabled: boolean;
293
+ fallback_commands: number[];
294
+ event_attribute_block_list: string[];
295
+ tab_direction: "horizontal" | "vertical";
296
+ recommended_tab_enabled: boolean;
297
+ recents_tab_enabled: boolean;
298
+ recommended_tab_instruction: string;
299
+ recents_tab_instruction: string;
300
+ hotload_help_docs: boolean;
301
+ slash_filters_enabled: boolean;
302
+ recents_sort_key: number | null;
303
+ recommended_sort_key: number | null;
304
+ show_suggested_synonyms: boolean;
305
+ has_hotloaded_help_docs: boolean;
306
+ bar_enabled: boolean;
307
+ in_bar_doc_search: boolean;
308
+ featured_item_cards: boolean;
309
+ helphub_ai_enabled: boolean;
310
+ helphub_suggested_queries_enabled: boolean;
311
+ helphub_continuations_enabled: boolean;
312
+ helphub_chat_only_mode: boolean;
313
+ helphub_enabled: boolean;
314
+ helphub_chat_fallback_message: string | null;
315
+ helphub_chat_fallback_actions: {
316
+ cta: string;
317
+ action: {
318
+ type: "execute_command";
319
+ meta: {
320
+ command: string;
321
+ };
322
+ } | {
323
+ type: "no_action";
324
+ } | {
325
+ type: "click";
326
+ value: string;
327
+ } | ({
328
+ type: "link";
329
+ value: string;
330
+ } & {
331
+ operation?: "self" | "router" | "blank" | undefined;
332
+ }) | {
333
+ type: "open_chat";
334
+ meta: {
335
+ type: string;
336
+ };
337
+ } | {
338
+ type: "dismiss";
339
+ };
340
+ }[];
341
+ helphub_manual_suggested_queries: string[];
342
+ nudge_rate_limit: number | null;
343
+ bar_hide_completed_nudges_questlists: boolean;
344
+ nudge_rate_period: "day" | "week" | "session";
345
+ installed_at: string | null;
346
+ integrations: {
347
+ algolia?: {
348
+ indexes: {
349
+ [x: string]: string | {
350
+ [x: string]: string;
351
+ };
352
+ };
353
+ applicationID: string | undefined;
354
+ apiKey: string | undefined;
355
+ } | undefined;
356
+ heap?: {
357
+ segments: {
358
+ [x: string]: string;
359
+ };
360
+ send_events_to_heap: boolean;
361
+ } | undefined;
362
+ };
363
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
364
+ id: string | number;
365
+ name: string;
366
+ created: string;
367
+ } & {} & {
368
+ launcher_type: "alternate" | "none" | "prompt" | "minimal";
369
+ launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
370
+ show_launcher_recommendations: boolean;
371
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
372
+ launcher_offset_x: number;
373
+ launcher_offset_y: number;
374
+ helphub_launcher_offset_x: number;
375
+ helphub_launcher_offset_y: number;
376
+ helphub_launcher_anchor: string;
377
+ helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
378
+ helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
379
+ base_url: string;
380
+ theme: object;
381
+ icon: string;
382
+ icon_suggest: string;
383
+ icon_tutorial: string;
384
+ icon_go_forward: string;
385
+ chat_system_prompt_modifier: string;
386
+ helphub_chat_welcome_message: string;
387
+ helphub_chat_avatar: string;
388
+ resource_options: {
389
+ [x: string]: {
390
+ name?: string | undefined;
391
+ search?: boolean | undefined;
392
+ label_field?: string | undefined;
393
+ useCategory?: boolean | undefined;
394
+ search_fields?: (string | {
395
+ key: string;
396
+ label: string;
397
+ })[] | undefined;
398
+ auto_execute?: boolean | undefined;
399
+ unfurl?: boolean | undefined;
400
+ description_field?: string | undefined;
401
+ icon?: string | undefined;
402
+ icon_color?: string | undefined;
403
+ image_color?: string | undefined;
404
+ image?: string | undefined;
405
+ sort_key?: number | undefined;
406
+ max_options_count?: number | null | undefined;
407
+ sortFunction?: any;
408
+ onInputChangeOptions?: {
409
+ applySort?: boolean | undefined;
410
+ } | undefined;
411
+ default_command_id?: string | number | undefined;
412
+ render_as?: "grid" | "list" | undefined;
413
+ showResources?: boolean | undefined;
414
+ show_with_no_results?: boolean | undefined;
415
+ search_tab_enabled?: boolean | undefined;
416
+ search_tab_name?: string | null | undefined;
417
+ slash_filter_enabled?: boolean | undefined;
418
+ slash_filter_keyword?: string | null | undefined;
419
+ search_tab_instruction?: string | null | undefined;
420
+ setting_pin_to_bottom?: boolean | undefined;
421
+ track_recents?: boolean | undefined;
422
+ detail?: string | ({
423
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
424
+ value: string;
425
+ } & {
426
+ position?: "inline" | "popover" | undefined;
427
+ }) | (string | ({
428
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
429
+ value: string;
430
+ } & {
431
+ position?: "inline" | "popover" | undefined;
432
+ }))[] | null | undefined;
433
+ content?: string | ({
434
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
435
+ value: string;
436
+ } & {
437
+ position?: "inline" | "popover" | undefined;
438
+ }) | (string | ({
439
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
440
+ value: string;
441
+ } & {
442
+ position?: "inline" | "popover" | undefined;
443
+ }))[] | null | undefined;
444
+ show_preview?: boolean | undefined;
445
+ };
446
+ };
447
+ should_show_onboarding: boolean;
448
+ last_snippet_request: string | null;
449
+ last_snippet_request_in_production: string | null;
450
+ branding: string;
451
+ custom_call_to_action: string;
452
+ search_fuzzy_threshold: number | null;
453
+ show_skin_editor: boolean;
454
+ allow_event_handlers: boolean;
455
+ in_bar_feedback: boolean;
456
+ summon_hotkey_override: string | null;
457
+ end_user_hotkeys: boolean | undefined;
458
+ force_end_user_identity_verification: boolean;
459
+ force_end_user_identity_verification_for_helphub: boolean;
460
+ end_user_shortcuts_enabled: boolean;
461
+ end_user_recents_enabled: boolean;
462
+ releases_available: boolean;
463
+ releases_enabled: boolean;
464
+ fallback_commands: number[];
465
+ event_attribute_block_list: string[];
466
+ tab_direction: "horizontal" | "vertical";
467
+ recommended_tab_enabled: boolean;
468
+ recents_tab_enabled: boolean;
469
+ recommended_tab_instruction: string;
470
+ recents_tab_instruction: string;
471
+ hotload_help_docs: boolean;
472
+ slash_filters_enabled: boolean;
473
+ recents_sort_key: number | null;
474
+ recommended_sort_key: number | null;
475
+ show_suggested_synonyms: boolean;
476
+ has_hotloaded_help_docs: boolean;
477
+ bar_enabled: boolean;
478
+ in_bar_doc_search: boolean;
479
+ featured_item_cards: boolean;
480
+ helphub_ai_enabled: boolean;
481
+ helphub_suggested_queries_enabled: boolean;
482
+ helphub_continuations_enabled: boolean;
483
+ helphub_chat_only_mode: boolean;
484
+ helphub_enabled: boolean;
485
+ helphub_chat_fallback_message: string | null;
486
+ helphub_chat_fallback_actions: {
487
+ cta: string;
488
+ action: {
489
+ type: "execute_command";
490
+ meta: {
491
+ command: string;
492
+ };
493
+ } | {
494
+ type: "no_action";
495
+ } | {
496
+ type: "click";
497
+ value: string;
498
+ } | ({
499
+ type: "link";
500
+ value: string;
501
+ } & {
502
+ operation?: "self" | "router" | "blank" | undefined;
503
+ }) | {
504
+ type: "open_chat";
505
+ meta: {
506
+ type: string;
507
+ };
508
+ } | {
509
+ type: "dismiss";
510
+ };
511
+ }[];
512
+ helphub_manual_suggested_queries: string[];
513
+ nudge_rate_limit: number | null;
514
+ bar_hide_completed_nudges_questlists: boolean;
515
+ nudge_rate_period: "day" | "week" | "session";
516
+ installed_at: string | null;
517
+ integrations: {
518
+ algolia?: {
519
+ indexes: {
520
+ [x: string]: string | {
521
+ [x: string]: string;
522
+ };
523
+ };
524
+ applicationID: string | undefined;
525
+ apiKey: string | undefined;
526
+ } | undefined;
527
+ heap?: {
528
+ segments: {
529
+ [x: string]: string;
530
+ };
531
+ send_events_to_heap: boolean;
532
+ } | undefined;
533
+ };
534
+ }>;
535
+ export declare const listCommands: (orgUID: string) => Promise<({
536
+ id: number;
537
+ organization: string | number;
538
+ text: string;
539
+ template: ({
540
+ type: "admin";
541
+ value: string;
542
+ } & {} & {
543
+ commandType?: "object" | "help" | "independent" | undefined;
544
+ object?: string | undefined;
545
+ hoverTooltip?: boolean | undefined;
546
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
547
+ }) | ({
548
+ type: "callback";
549
+ value: string;
550
+ } & {} & {
551
+ commandType?: "object" | "help" | "independent" | undefined;
552
+ object?: string | undefined;
553
+ hoverTooltip?: boolean | undefined;
554
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
555
+ }) | ({
556
+ type: "link";
557
+ value: string;
558
+ } & {
559
+ operation?: "self" | "router" | "blank" | undefined;
560
+ } & {} & {
561
+ commandType?: "object" | "help" | "independent" | undefined;
562
+ object?: string | undefined;
563
+ hoverTooltip?: boolean | undefined;
564
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
565
+ }) | ({
566
+ type: "click" | "clickByXpath" | "clickBySelector";
567
+ value: string[];
568
+ } & {} & {
569
+ commandType?: "object" | "help" | "independent" | undefined;
570
+ object?: string | undefined;
571
+ hoverTooltip?: boolean | undefined;
572
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
573
+ }) | ({
574
+ type: "builtin";
575
+ value: string;
576
+ } & {} & {
577
+ commandType?: "object" | "help" | "independent" | undefined;
578
+ object?: string | undefined;
579
+ hoverTooltip?: boolean | undefined;
580
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
581
+ }) | ({
582
+ type: "webhook";
583
+ value: string;
584
+ } & {} & {
585
+ commandType?: "object" | "help" | "independent" | undefined;
586
+ object?: string | undefined;
587
+ hoverTooltip?: boolean | undefined;
588
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
589
+ }) | ({
590
+ type: "script";
591
+ value: string;
592
+ } & {} & {
593
+ commandType?: "object" | "help" | "independent" | undefined;
594
+ object?: string | undefined;
595
+ hoverTooltip?: boolean | undefined;
596
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
597
+ }) | ({
598
+ type: "request";
599
+ value: {
600
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
601
+ url: string;
602
+ } & {
603
+ headers?: {
604
+ [key: string]: unknown;
605
+ } | undefined;
606
+ body?: {
607
+ [key: string]: unknown;
608
+ } | undefined;
609
+ onSend?: string | undefined;
610
+ onSuccess?: string | undefined;
611
+ onError?: string | undefined;
612
+ };
613
+ } & {} & {
614
+ commandType?: "object" | "help" | "independent" | undefined;
615
+ object?: string | undefined;
616
+ hoverTooltip?: boolean | undefined;
617
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
618
+ }) | ({
619
+ type: "appcues";
620
+ value: string;
621
+ } & {} & {
622
+ commandType?: "object" | "help" | "independent" | undefined;
623
+ object?: string | undefined;
624
+ hoverTooltip?: boolean | undefined;
625
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
626
+ }) | ({
627
+ type: "video";
628
+ value: string;
629
+ } & {} & {
630
+ commandType?: "object" | "help" | "independent" | undefined;
631
+ object?: string | undefined;
632
+ hoverTooltip?: boolean | undefined;
633
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
634
+ }) | ({
635
+ type: "helpdoc";
636
+ value: string;
637
+ } & {
638
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
639
+ doc_metadata?: {
640
+ content_type?: string | undefined;
641
+ date?: string | undefined;
642
+ } | undefined;
643
+ } & {
644
+ doc_type?: "answer" | "doc" | undefined;
645
+ } & {} & {
646
+ commandType?: "object" | "help" | "independent" | undefined;
647
+ object?: string | undefined;
648
+ hoverTooltip?: boolean | undefined;
649
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
650
+ }) | ({
651
+ type: "trigger";
652
+ value: any;
653
+ } & {} & {
654
+ commandType?: "object" | "help" | "independent" | undefined;
655
+ object?: string | undefined;
656
+ hoverTooltip?: boolean | undefined;
657
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
658
+ });
659
+ } & {
660
+ disabledReason?: string | undefined;
661
+ source?: string | undefined;
662
+ name?: string | undefined;
663
+ last_available?: string | null | undefined;
664
+ modified?: string | undefined;
665
+ isAsync?: boolean | undefined;
666
+ } & {
667
+ image: string | null;
668
+ confirm: string;
669
+ icon: string | null;
670
+ heading: string;
671
+ icon_color: string | null;
672
+ image_color: string | null;
673
+ sort_key: number | null;
674
+ show_preview: boolean;
675
+ is_live: boolean;
676
+ celebrate: boolean | {
677
+ angle?: number | undefined;
678
+ spread?: number | undefined;
679
+ width?: string | undefined;
680
+ height?: string | undefined;
681
+ duration?: number | undefined;
682
+ dragFriction?: number | undefined;
683
+ stagger?: number | undefined;
684
+ startVelocity?: number | undefined;
685
+ elementCount?: number | undefined;
686
+ decay?: number | undefined;
687
+ colors?: string[] | undefined;
688
+ random?: any;
689
+ } | null;
690
+ arguments: {
691
+ [x: string]: ({
692
+ type: "context";
693
+ value: string;
694
+ order_key: number;
695
+ } & {
696
+ label?: string | undefined;
697
+ chosen?: string | number | undefined;
698
+ selected?: any[] | undefined;
699
+ input_type?: string | undefined;
700
+ preselected_key?: string | undefined;
701
+ label_field?: string | undefined;
702
+ loaded?: any[] | undefined;
703
+ allow_create?: boolean | undefined;
704
+ allow_create_label?: string | undefined;
705
+ show_in_record_action_list?: boolean | undefined;
706
+ show_in_default_list?: boolean | undefined;
707
+ auto_choose?: boolean | undefined;
708
+ is_private?: boolean | undefined;
709
+ }) | ({
710
+ type: "set";
711
+ value: string[] | number[] | {
712
+ [key: string]: unknown;
713
+ }[];
714
+ order_key: number;
715
+ } & {
716
+ label?: string | undefined;
717
+ chosen?: string | number | undefined;
718
+ selected?: any[] | undefined;
719
+ input_type?: string | undefined;
720
+ preselected_key?: string | undefined;
721
+ label_field?: string | undefined;
722
+ loaded?: any[] | undefined;
723
+ allow_create?: boolean | undefined;
724
+ allow_create_label?: string | undefined;
725
+ auto_choose?: boolean | undefined;
726
+ is_private?: boolean | undefined;
727
+ }) | ({
728
+ type: "provided";
729
+ value: "time" | "text";
730
+ order_key: number;
731
+ } & {
732
+ label?: string | undefined;
733
+ chosen?: string | number | undefined;
734
+ selected?: any[] | undefined;
735
+ input_type?: string | undefined;
736
+ preselected_key?: string | undefined;
737
+ label_field?: string | undefined;
738
+ loaded?: any[] | undefined;
739
+ dateTimeArgumentTypeId?: number | undefined;
740
+ allow_create?: boolean | undefined;
741
+ allow_create_label?: string | undefined;
742
+ auto_choose?: boolean | undefined;
743
+ is_private?: boolean | undefined;
744
+ }) | ({
745
+ type: "html" | "video";
746
+ value: {
747
+ source: string;
748
+ } & {
749
+ title?: string | undefined;
750
+ description?: string | undefined;
751
+ url?: string | undefined;
752
+ };
753
+ order_key: number;
754
+ } & {
755
+ label?: string | undefined;
756
+ chosen?: string | number | undefined;
757
+ selected?: any[] | undefined;
758
+ input_type?: string | undefined;
759
+ preselected_key?: string | undefined;
760
+ label_field?: string | undefined;
761
+ loaded?: any[] | undefined;
762
+ allow_create?: boolean | undefined;
763
+ allow_create_label?: string | undefined;
764
+ is_private?: boolean | undefined;
765
+ auto_choose?: boolean | undefined;
766
+ });
767
+ };
768
+ tags: string[];
769
+ availability_rules: ({
770
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
771
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
772
+ } & {
773
+ field?: string | undefined;
774
+ value?: string | undefined;
775
+ reason?: string | undefined;
776
+ rule_id?: string | number | undefined;
777
+ })[] | (({
778
+ type: "named_rule";
779
+ rule_id: string | number;
780
+ } & {
781
+ reason?: string | undefined;
782
+ }) | ({
783
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
784
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
785
+ } & {
786
+ field?: string | undefined;
787
+ value?: string | undefined;
788
+ reason?: string | undefined;
789
+ rule_id?: string | number | undefined;
790
+ }))[];
791
+ recommend_rules: (({
792
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
793
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
794
+ } & {
795
+ field?: string | undefined;
796
+ value?: string | undefined;
797
+ reason?: string | undefined;
798
+ rule_id?: string | number | undefined;
799
+ }) | ({
800
+ type: "always";
801
+ } & {
802
+ operator?: null | undefined;
803
+ field?: null | undefined;
804
+ value?: null | undefined;
805
+ reason?: null | undefined;
806
+ rule_id?: string | number | undefined;
807
+ }))[] | (({
808
+ type: "named_rule";
809
+ rule_id: string | number;
810
+ } & {
811
+ reason?: string | undefined;
812
+ }) | ({
813
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
814
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
815
+ } & {
816
+ field?: string | undefined;
817
+ value?: string | undefined;
818
+ reason?: string | undefined;
819
+ rule_id?: string | number | undefined;
820
+ }) | ({
821
+ type: "always";
822
+ } & {
823
+ operator?: null | undefined;
824
+ field?: null | undefined;
825
+ value?: null | undefined;
826
+ reason?: null | undefined;
827
+ rule_id?: string | number | undefined;
828
+ }))[];
829
+ availability_expression: import("./helpers/rules").RuleExpression;
830
+ recommend_expression: import("./helpers/rules").RuleExpression;
831
+ always_recommend: boolean;
832
+ shortcut: string[];
833
+ category: number | null;
834
+ recommend_sort_key: number | null;
835
+ shortcut_mac: string[];
836
+ shortcut_win: string[];
837
+ hotkey_mac: string;
838
+ hotkey_win: string;
839
+ next_steps: (string | number | {
840
+ cta: string;
841
+ action: {
842
+ type: "execute_command";
843
+ meta: {
844
+ command: string;
845
+ };
846
+ } | {
847
+ type: "no_action";
848
+ } | {
849
+ type: "click";
850
+ value: string;
851
+ } | ({
852
+ type: "link";
853
+ value: string;
854
+ } & {
855
+ operation?: "self" | "router" | "blank" | undefined;
856
+ }) | {
857
+ type: "open_chat";
858
+ meta: {
859
+ type: string;
860
+ };
861
+ } | {
862
+ type: "dismiss";
863
+ };
864
+ })[];
865
+ thumbnail: {
866
+ src: string;
867
+ file_name: string;
868
+ size: string;
869
+ } | null;
870
+ generated_tags: {
871
+ automated?: string[] | null | undefined;
872
+ manual?: string[] | null | undefined;
873
+ deny?: string[] | null | undefined;
874
+ };
875
+ } & {
876
+ third_party_source?: string | null | undefined;
877
+ third_party_id?: string | null | undefined;
878
+ training_only?: boolean | undefined;
879
+ })[]>;
880
+ export declare const listAnswers: (orgUID: string) => Promise<({
881
+ id: number;
882
+ organization: string | number;
883
+ text: string;
884
+ template: ({
885
+ type: "admin";
886
+ value: string;
887
+ } & {} & {
888
+ commandType?: "object" | "help" | "independent" | undefined;
889
+ object?: string | undefined;
890
+ hoverTooltip?: boolean | undefined;
891
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
892
+ }) | ({
893
+ type: "callback";
894
+ value: string;
895
+ } & {} & {
896
+ commandType?: "object" | "help" | "independent" | undefined;
897
+ object?: string | undefined;
898
+ hoverTooltip?: boolean | undefined;
899
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
900
+ }) | ({
901
+ type: "link";
902
+ value: string;
903
+ } & {
904
+ operation?: "self" | "router" | "blank" | undefined;
905
+ } & {} & {
906
+ commandType?: "object" | "help" | "independent" | undefined;
907
+ object?: string | undefined;
908
+ hoverTooltip?: boolean | undefined;
909
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
910
+ }) | ({
911
+ type: "click" | "clickByXpath" | "clickBySelector";
912
+ value: string[];
913
+ } & {} & {
914
+ commandType?: "object" | "help" | "independent" | undefined;
915
+ object?: string | undefined;
916
+ hoverTooltip?: boolean | undefined;
917
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
918
+ }) | ({
919
+ type: "builtin";
920
+ value: string;
921
+ } & {} & {
922
+ commandType?: "object" | "help" | "independent" | undefined;
923
+ object?: string | undefined;
924
+ hoverTooltip?: boolean | undefined;
925
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
926
+ }) | ({
927
+ type: "webhook";
928
+ value: string;
929
+ } & {} & {
930
+ commandType?: "object" | "help" | "independent" | undefined;
931
+ object?: string | undefined;
932
+ hoverTooltip?: boolean | undefined;
933
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
934
+ }) | ({
935
+ type: "script";
936
+ value: string;
937
+ } & {} & {
938
+ commandType?: "object" | "help" | "independent" | undefined;
939
+ object?: string | undefined;
940
+ hoverTooltip?: boolean | undefined;
941
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
942
+ }) | ({
943
+ type: "request";
944
+ value: {
945
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
946
+ url: string;
947
+ } & {
948
+ headers?: {
949
+ [key: string]: unknown;
950
+ } | undefined;
951
+ body?: {
952
+ [key: string]: unknown;
953
+ } | undefined;
954
+ onSend?: string | undefined;
955
+ onSuccess?: string | undefined;
956
+ onError?: string | undefined;
957
+ };
958
+ } & {} & {
959
+ commandType?: "object" | "help" | "independent" | undefined;
960
+ object?: string | undefined;
961
+ hoverTooltip?: boolean | undefined;
962
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
963
+ }) | ({
964
+ type: "appcues";
965
+ value: string;
966
+ } & {} & {
967
+ commandType?: "object" | "help" | "independent" | undefined;
968
+ object?: string | undefined;
969
+ hoverTooltip?: boolean | undefined;
970
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
971
+ }) | ({
972
+ type: "video";
973
+ value: string;
974
+ } & {} & {
975
+ commandType?: "object" | "help" | "independent" | undefined;
976
+ object?: string | undefined;
977
+ hoverTooltip?: boolean | undefined;
978
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
979
+ }) | ({
980
+ type: "helpdoc";
981
+ value: string;
982
+ } & {
983
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
984
+ doc_metadata?: {
985
+ content_type?: string | undefined;
986
+ date?: string | undefined;
987
+ } | undefined;
988
+ } & {
989
+ doc_type?: "answer" | "doc" | undefined;
990
+ } & {} & {
991
+ commandType?: "object" | "help" | "independent" | undefined;
992
+ object?: string | undefined;
993
+ hoverTooltip?: boolean | undefined;
994
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
995
+ }) | ({
996
+ type: "trigger";
997
+ value: any;
998
+ } & {} & {
999
+ commandType?: "object" | "help" | "independent" | undefined;
1000
+ object?: string | undefined;
1001
+ hoverTooltip?: boolean | undefined;
1002
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1003
+ });
1004
+ } & {
1005
+ disabledReason?: string | undefined;
1006
+ source?: string | undefined;
1007
+ name?: string | undefined;
1008
+ last_available?: string | null | undefined;
1009
+ modified?: string | undefined;
1010
+ isAsync?: boolean | undefined;
1011
+ } & {
1012
+ arguments: {
1013
+ [x: string]: ({
1014
+ type: "context";
1015
+ value: string;
1016
+ order_key: number;
1017
+ } & {
1018
+ label?: string | undefined;
1019
+ chosen?: string | number | undefined;
1020
+ selected?: any[] | undefined;
1021
+ input_type?: string | undefined;
1022
+ preselected_key?: string | undefined;
1023
+ label_field?: string | undefined;
1024
+ loaded?: any[] | undefined;
1025
+ allow_create?: boolean | undefined;
1026
+ allow_create_label?: string | undefined;
1027
+ show_in_record_action_list?: boolean | undefined;
1028
+ show_in_default_list?: boolean | undefined;
1029
+ auto_choose?: boolean | undefined;
1030
+ is_private?: boolean | undefined;
1031
+ }) | ({
1032
+ type: "set";
1033
+ value: string[] | number[] | {
1034
+ [key: string]: unknown;
1035
+ }[];
1036
+ order_key: number;
1037
+ } & {
1038
+ label?: string | undefined;
1039
+ chosen?: string | number | undefined;
1040
+ selected?: any[] | undefined;
1041
+ input_type?: string | undefined;
1042
+ preselected_key?: string | undefined;
1043
+ label_field?: string | undefined;
1044
+ loaded?: any[] | undefined;
1045
+ allow_create?: boolean | undefined;
1046
+ allow_create_label?: string | undefined;
1047
+ auto_choose?: boolean | undefined;
1048
+ is_private?: boolean | undefined;
1049
+ }) | ({
1050
+ type: "provided";
1051
+ value: "time" | "text";
1052
+ order_key: number;
1053
+ } & {
1054
+ label?: string | undefined;
1055
+ chosen?: string | number | undefined;
1056
+ selected?: any[] | undefined;
1057
+ input_type?: string | undefined;
1058
+ preselected_key?: string | undefined;
1059
+ label_field?: string | undefined;
1060
+ loaded?: any[] | undefined;
1061
+ dateTimeArgumentTypeId?: number | undefined;
1062
+ allow_create?: boolean | undefined;
1063
+ allow_create_label?: string | undefined;
1064
+ auto_choose?: boolean | undefined;
1065
+ is_private?: boolean | undefined;
1066
+ }) | ({
1067
+ type: "html" | "video";
1068
+ value: {
1069
+ source: string;
1070
+ } & {
1071
+ title?: string | undefined;
1072
+ description?: string | undefined;
1073
+ url?: string | undefined;
1074
+ };
1075
+ order_key: number;
1076
+ } & {
1077
+ label?: string | undefined;
1078
+ chosen?: string | number | undefined;
1079
+ selected?: any[] | undefined;
1080
+ input_type?: string | undefined;
1081
+ preselected_key?: string | undefined;
1082
+ label_field?: string | undefined;
1083
+ loaded?: any[] | undefined;
1084
+ allow_create?: boolean | undefined;
1085
+ allow_create_label?: string | undefined;
1086
+ is_private?: boolean | undefined;
1087
+ auto_choose?: boolean | undefined;
1088
+ });
1089
+ };
1090
+ tags: string[];
1091
+ availability_rules: ({
1092
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1093
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1094
+ } & {
1095
+ field?: string | undefined;
1096
+ value?: string | undefined;
1097
+ reason?: string | undefined;
1098
+ rule_id?: string | number | undefined;
1099
+ })[] | (({
1100
+ type: "named_rule";
1101
+ rule_id: string | number;
1102
+ } & {
1103
+ reason?: string | undefined;
1104
+ }) | ({
1105
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1106
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1107
+ } & {
1108
+ field?: string | undefined;
1109
+ value?: string | undefined;
1110
+ reason?: string | undefined;
1111
+ rule_id?: string | number | undefined;
1112
+ }))[];
1113
+ recommend_rules: (({
1114
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1115
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1116
+ } & {
1117
+ field?: string | undefined;
1118
+ value?: string | undefined;
1119
+ reason?: string | undefined;
1120
+ rule_id?: string | number | undefined;
1121
+ }) | ({
1122
+ type: "always";
1123
+ } & {
1124
+ operator?: null | undefined;
1125
+ field?: null | undefined;
1126
+ value?: null | undefined;
1127
+ reason?: null | undefined;
1128
+ rule_id?: string | number | undefined;
1129
+ }))[] | (({
1130
+ type: "named_rule";
1131
+ rule_id: string | number;
1132
+ } & {
1133
+ reason?: string | undefined;
1134
+ }) | ({
1135
+ type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1136
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1137
+ } & {
1138
+ field?: string | undefined;
1139
+ value?: string | undefined;
1140
+ reason?: string | undefined;
1141
+ rule_id?: string | number | undefined;
1142
+ }) | ({
1143
+ type: "always";
1144
+ } & {
1145
+ operator?: null | undefined;
1146
+ field?: null | undefined;
1147
+ value?: null | undefined;
1148
+ reason?: null | undefined;
1149
+ rule_id?: string | number | undefined;
1150
+ }))[];
1151
+ availability_expression: import("./helpers/rules").RuleExpression;
1152
+ recommend_expression: import("./helpers/rules").RuleExpression;
1153
+ always_recommend: boolean;
1154
+ confirm: string;
1155
+ shortcut: string[];
1156
+ explanation: string;
1157
+ heading: string;
1158
+ is_live: boolean;
1159
+ category: number | null;
1160
+ sort_key: number | null;
1161
+ icon: string | null;
1162
+ icon_color: string | null;
1163
+ image_color: string | null;
1164
+ image: string | null;
1165
+ celebrate: boolean | {
1166
+ angle?: number | undefined;
1167
+ spread?: number | undefined;
1168
+ width?: string | undefined;
1169
+ height?: string | undefined;
1170
+ duration?: number | undefined;
1171
+ dragFriction?: number | undefined;
1172
+ stagger?: number | undefined;
1173
+ startVelocity?: number | undefined;
1174
+ elementCount?: number | undefined;
1175
+ decay?: number | undefined;
1176
+ colors?: string[] | undefined;
1177
+ random?: any;
1178
+ } | null;
1179
+ recommend_sort_key: number | null;
1180
+ shortcut_mac: string[];
1181
+ shortcut_win: string[];
1182
+ hotkey_mac: string;
1183
+ hotkey_win: string;
1184
+ detail: string | ({
1185
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1186
+ value: string;
1187
+ } & {
1188
+ position?: "inline" | "popover" | undefined;
1189
+ }) | (string | ({
1190
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1191
+ value: string;
1192
+ } & {
1193
+ position?: "inline" | "popover" | undefined;
1194
+ }))[] | null;
1195
+ content: string | ({
1196
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1197
+ value: string;
1198
+ } & {
1199
+ position?: "inline" | "popover" | undefined;
1200
+ }) | (string | ({
1201
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1202
+ value: string;
1203
+ } & {
1204
+ position?: "inline" | "popover" | undefined;
1205
+ }))[] | null;
1206
+ show_preview: boolean;
1207
+ thumbnail: {
1208
+ src: string;
1209
+ file_name: string;
1210
+ size: string;
1211
+ } | null;
1212
+ next_steps: (string | number | {
1213
+ cta: string;
1214
+ action: {
1215
+ type: "execute_command";
1216
+ meta: {
1217
+ command: string;
1218
+ };
1219
+ } | {
1220
+ type: "no_action";
1221
+ } | {
1222
+ type: "click";
1223
+ value: string;
1224
+ } | ({
1225
+ type: "link";
1226
+ value: string;
1227
+ } & {
1228
+ operation?: "self" | "router" | "blank" | undefined;
1229
+ }) | {
1230
+ type: "open_chat";
1231
+ meta: {
1232
+ type: string;
1233
+ };
1234
+ } | {
1235
+ type: "dismiss";
1236
+ };
1237
+ })[];
1238
+ generated_tags: {
1239
+ automated?: string[] | null | undefined;
1240
+ manual?: string[] | null | undefined;
1241
+ deny?: string[] | null | undefined;
1242
+ };
1243
+ } & {
1244
+ third_party_source?: string | null | undefined;
1245
+ third_party_id?: string | null | undefined;
1246
+ training_only?: boolean | undefined;
1247
+ })[]>;
1248
+ export declare const listCommandCategories: (orgUID: string) => Promise<({
1249
+ id: number;
1250
+ organization: string | number;
1251
+ name: string;
1252
+ } & {} & {
1253
+ sort_key: number | null;
1254
+ icon: string | null;
1255
+ icon_color: string | null;
1256
+ image_color: string | null;
1257
+ image: string | null;
1258
+ render_as: "grid" | "list";
1259
+ setting_hide_before_search: boolean;
1260
+ setting_max_options_count: number | null;
1261
+ setting_pin_to_bottom: boolean;
1262
+ search_tab_enabled: boolean;
1263
+ search_tab_name: string;
1264
+ slash_filter_enabled: boolean;
1265
+ slash_filter_keyword: string | null;
1266
+ search_tab_instruction: string;
1267
+ track_recents: boolean;
1268
+ } & {
1269
+ contains_hotloaded_commands?: boolean | undefined;
1270
+ })[]>;
1271
+ export declare const listGuides: (orgUID: string) => Promise<({
1272
+ id: number;
1273
+ organization: string;
1274
+ event: string;
1275
+ nudge: string;
1276
+ guidance: string;
1277
+ } & {})[]>;
1278
+ export declare const listContexts: (orgUID: string) => Promise<({
1279
+ id: number;
1280
+ name: string;
1281
+ organization: string;
1282
+ value: {
1283
+ [x: string]: any;
1284
+ };
1285
+ } & {})[]>;
1286
+ export declare const listPlaceholders: (orgUID: string) => Promise<({
1287
+ id: number;
1288
+ organization: string;
1289
+ slug: string;
1290
+ text: string;
1291
+ } & {})[]>;
1292
+ export declare const listRules: (orgUID: string) => Promise<({
1293
+ id: string | number;
1294
+ name: string;
1295
+ expression: import("./helpers/rules").RuleExpression;
1296
+ } & {
1297
+ is_audience: boolean;
1298
+ })[]>;
1299
+ export declare const userHasAccess: (uuid: string, user: string) => Promise<{
1300
+ username: string;
1301
+ slug: string;
1302
+ organization: string;
1303
+ has_access: boolean;
1304
+ has_opened: boolean;
1305
+ hotkeys_debug: boolean;
1306
+ hmac: string | undefined;
1307
+ identifier: string;
1308
+ }>;
1309
+ export declare const readHealth: (arg0: string, urlArgs?: {
1310
+ [arg: string]: string;
1311
+ } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1312
+ id: string | number;
1313
+ uuid: string;
1314
+ errors_72h: number;
1315
+ suggestions_72h: number;
1316
+ executions_total: number;
1317
+ users_total: number;
1318
+ }>;
1319
+ export declare const readInternal: (arg0: string, urlArgs?: {
1320
+ [arg: string]: string;
1321
+ } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1322
+ id: string;
1323
+ integrations: {
1324
+ [x: string]: {
1325
+ [x: string]: string | boolean | {
1326
+ [x: string]: string;
1327
+ };
1328
+ };
1329
+ };
1330
+ }>;
1331
+ export declare const updateInternal: (object: {
1332
+ id: string;
1333
+ integrations: {
1334
+ [x: string]: {
1335
+ [x: string]: string | boolean | {
1336
+ [x: string]: string;
1337
+ };
1338
+ };
1339
+ };
1340
+ }, urlArgs?: {
1341
+ [arg: string]: string;
1342
+ } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1343
+ id: string;
1344
+ integrations: {
1345
+ [x: string]: {
1346
+ [x: string]: string | boolean | {
1347
+ [x: string]: string;
1348
+ };
1349
+ };
1350
+ };
1351
+ }>;
1352
+ export declare const readDashboardFlags: (params?: Record<string, string> | undefined, callbacks?: {
1353
+ onSuccess?: (() => void) | undefined;
1354
+ onError?: ((err: string) => void) | undefined;
1355
+ } | undefined) => Promise<{
1356
+ show_onboarding: boolean;
1357
+ show_appsumo_onboarding: boolean;
1358
+ }>;
1359
+ export declare const updateDashboardFlags: (object: {
1360
+ show_onboarding?: boolean | undefined;
1361
+ show_appsumo_onboarding?: boolean | undefined;
1362
+ }, params?: Record<string, string> | undefined, callbacks?: {
1363
+ onSuccess?: (() => void) | undefined;
1364
+ onError?: ((err: string) => void) | undefined;
1365
+ } | undefined) => Promise<{
1366
+ show_onboarding: boolean;
1367
+ show_appsumo_onboarding: boolean;
1368
+ }>;
1369
+ export declare const decode: (data: any) => {
1370
+ id: string | number;
1371
+ name: string;
1372
+ created: string;
1373
+ } & {} & {
1374
+ launcher_type: "alternate" | "none" | "prompt" | "minimal";
1375
+ launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
1376
+ show_launcher_recommendations: boolean;
1377
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
1378
+ launcher_offset_x: number;
1379
+ launcher_offset_y: number;
1380
+ helphub_launcher_offset_x: number;
1381
+ helphub_launcher_offset_y: number;
1382
+ helphub_launcher_anchor: string;
1383
+ helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
1384
+ helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
1385
+ base_url: string;
1386
+ theme: object;
1387
+ icon: string;
1388
+ icon_suggest: string;
1389
+ icon_tutorial: string;
1390
+ icon_go_forward: string;
1391
+ chat_system_prompt_modifier: string;
1392
+ helphub_chat_welcome_message: string;
1393
+ helphub_chat_avatar: string;
1394
+ resource_options: {
1395
+ [x: string]: {
1396
+ name?: string | undefined;
1397
+ search?: boolean | undefined;
1398
+ label_field?: string | undefined;
1399
+ useCategory?: boolean | undefined;
1400
+ search_fields?: (string | {
1401
+ key: string;
1402
+ label: string;
1403
+ })[] | undefined;
1404
+ auto_execute?: boolean | undefined;
1405
+ unfurl?: boolean | undefined;
1406
+ description_field?: string | undefined;
1407
+ icon?: string | undefined;
1408
+ icon_color?: string | undefined;
1409
+ image_color?: string | undefined;
1410
+ image?: string | undefined;
1411
+ sort_key?: number | undefined;
1412
+ max_options_count?: number | null | undefined;
1413
+ sortFunction?: any;
1414
+ onInputChangeOptions?: {
1415
+ applySort?: boolean | undefined;
1416
+ } | undefined;
1417
+ default_command_id?: string | number | undefined;
1418
+ render_as?: "grid" | "list" | undefined;
1419
+ showResources?: boolean | undefined;
1420
+ show_with_no_results?: boolean | undefined;
1421
+ search_tab_enabled?: boolean | undefined;
1422
+ search_tab_name?: string | null | undefined;
1423
+ slash_filter_enabled?: boolean | undefined;
1424
+ slash_filter_keyword?: string | null | undefined;
1425
+ search_tab_instruction?: string | null | undefined;
1426
+ setting_pin_to_bottom?: boolean | undefined;
1427
+ track_recents?: boolean | undefined;
1428
+ detail?: string | ({
1429
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1430
+ value: string;
1431
+ } & {
1432
+ position?: "inline" | "popover" | undefined;
1433
+ }) | (string | ({
1434
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1435
+ value: string;
1436
+ } & {
1437
+ position?: "inline" | "popover" | undefined;
1438
+ }))[] | null | undefined;
1439
+ content?: string | ({
1440
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1441
+ value: string;
1442
+ } & {
1443
+ position?: "inline" | "popover" | undefined;
1444
+ }) | (string | ({
1445
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1446
+ value: string;
1447
+ } & {
1448
+ position?: "inline" | "popover" | undefined;
1449
+ }))[] | null | undefined;
1450
+ show_preview?: boolean | undefined;
1451
+ };
1452
+ };
1453
+ should_show_onboarding: boolean;
1454
+ last_snippet_request: string | null;
1455
+ last_snippet_request_in_production: string | null;
1456
+ branding: string;
1457
+ custom_call_to_action: string;
1458
+ search_fuzzy_threshold: number | null;
1459
+ show_skin_editor: boolean;
1460
+ allow_event_handlers: boolean;
1461
+ in_bar_feedback: boolean;
1462
+ summon_hotkey_override: string | null;
1463
+ end_user_hotkeys: boolean | undefined;
1464
+ force_end_user_identity_verification: boolean;
1465
+ force_end_user_identity_verification_for_helphub: boolean;
1466
+ end_user_shortcuts_enabled: boolean;
1467
+ end_user_recents_enabled: boolean;
1468
+ releases_available: boolean;
1469
+ releases_enabled: boolean;
1470
+ fallback_commands: number[];
1471
+ event_attribute_block_list: string[];
1472
+ tab_direction: "horizontal" | "vertical";
1473
+ recommended_tab_enabled: boolean;
1474
+ recents_tab_enabled: boolean;
1475
+ recommended_tab_instruction: string;
1476
+ recents_tab_instruction: string;
1477
+ hotload_help_docs: boolean;
1478
+ slash_filters_enabled: boolean;
1479
+ recents_sort_key: number | null;
1480
+ recommended_sort_key: number | null;
1481
+ show_suggested_synonyms: boolean;
1482
+ has_hotloaded_help_docs: boolean;
1483
+ bar_enabled: boolean;
1484
+ in_bar_doc_search: boolean;
1485
+ featured_item_cards: boolean;
1486
+ helphub_ai_enabled: boolean;
1487
+ helphub_suggested_queries_enabled: boolean;
1488
+ helphub_continuations_enabled: boolean;
1489
+ helphub_chat_only_mode: boolean;
1490
+ helphub_enabled: boolean;
1491
+ helphub_chat_fallback_message: string | null;
1492
+ helphub_chat_fallback_actions: {
1493
+ cta: string;
1494
+ action: {
1495
+ type: "execute_command";
1496
+ meta: {
1497
+ command: string;
1498
+ };
1499
+ } | {
1500
+ type: "no_action";
1501
+ } | {
1502
+ type: "click";
1503
+ value: string;
1504
+ } | ({
1505
+ type: "link";
1506
+ value: string;
1507
+ } & {
1508
+ operation?: "self" | "router" | "blank" | undefined;
1509
+ }) | {
1510
+ type: "open_chat";
1511
+ meta: {
1512
+ type: string;
1513
+ };
1514
+ } | {
1515
+ type: "dismiss";
1516
+ };
1517
+ }[];
1518
+ helphub_manual_suggested_queries: string[];
1519
+ nudge_rate_limit: number | null;
1520
+ bar_hide_completed_nudges_questlists: boolean;
1521
+ nudge_rate_period: "day" | "week" | "session";
1522
+ installed_at: string | null;
1523
+ integrations: {
1524
+ algolia?: {
1525
+ indexes: {
1526
+ [x: string]: string | {
1527
+ [x: string]: string;
1528
+ };
1529
+ };
1530
+ applicationID: string | undefined;
1531
+ apiKey: string | undefined;
1532
+ } | undefined;
1533
+ heap?: {
1534
+ segments: {
1535
+ [x: string]: string;
1536
+ };
1537
+ send_events_to_heap: boolean;
1538
+ } | undefined;
1539
+ };
1540
+ };