commandbar 1.12.0 → 1.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +2 -0
  2. package/build/commandbar-js/src/index.js +1 -1
  3. package/build/commandbar-js/src/init.d.ts +10 -1
  4. package/build/commandbar-js/src/snippet.d.ts +0 -1
  5. package/build/internal/src/client/CommandBarClientSDK.d.ts +5 -0
  6. package/build/internal/src/client/CommandBarProxySDK.d.ts +2 -3
  7. package/build/internal/src/client/SDKConfig.d.ts +1 -0
  8. package/build/internal/src/client/symbols.d.ts +2 -0
  9. package/build/internal/src/middleware/CommandFromClientV.d.ts +7 -0
  10. package/build/internal/src/middleware/OrganizationV.d.ts +104 -12
  11. package/build/internal/src/middleware/additionalResource.d.ts +208 -118
  12. package/build/internal/src/middleware/api.d.ts +7 -7
  13. package/build/internal/src/middleware/chat.d.ts +23641 -12011
  14. package/build/internal/src/middleware/checklist.d.ts +221 -121
  15. package/build/internal/src/middleware/command.d.ts +2611 -2021
  16. package/build/internal/src/middleware/endUser.d.ts +0 -32
  17. package/build/internal/src/middleware/experienceTemplate.d.ts +407 -223
  18. package/build/internal/src/middleware/experiencesSearch.d.ts +818 -657
  19. package/build/internal/src/middleware/flags.d.ts +9 -8
  20. package/build/internal/src/middleware/helpDocsSearch.d.ts +586 -471
  21. package/build/internal/src/middleware/helpers/actions.d.ts +83 -30
  22. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +32 -6
  23. package/build/internal/src/middleware/helpers/rules.d.ts +19 -4
  24. package/build/internal/src/middleware/keyword.d.ts +82 -0
  25. package/build/internal/src/middleware/network.d.ts +2 -2
  26. package/build/internal/src/middleware/nudge.d.ts +520 -247
  27. package/build/internal/src/middleware/organization.d.ts +886 -607
  28. package/build/internal/src/middleware/organizationSettings.d.ts +282 -114
  29. package/build/internal/src/middleware/profile.d.ts +1 -1
  30. package/build/internal/src/middleware/recommendationSet.d.ts +208 -118
  31. package/build/internal/src/middleware/theme.d.ts +7 -0
  32. package/build/internal/src/middleware/types.d.ts +21 -20
  33. package/package.json +1 -1
  34. package/src/init.ts +13 -2
  35. package/src/snippet.ts +1 -14
  36. package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +0 -13
  37. package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +0 -54
  38. package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +0 -6
  39. package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +0 -152
  40. package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +0 -4
  41. package/build/internal/src/client/CommandBarSDK.d.ts +0 -99
  42. package/build/internal/src/client/globals.d.ts +0 -27
  43. package/build/internal/src/util/dispatchCustomEvent.d.ts +0 -14
  44. package/build/internal/src/util/sentry.d.ts +0 -23
@@ -42,8 +42,14 @@ export declare const OrganizationSettingsV: t.TypeC<{
42
42
  helphub_suggested_queries_enabled: t.BooleanC;
43
43
  helphub_continuations_enabled: t.BooleanC;
44
44
  helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
45
+ helphub_custom_theme: t.UnionC<[t.StringC, t.NullC]>;
45
46
  copilot_name: t.StringC;
46
47
  copilot_avatar: t.StringC;
48
+ copilot_avatar_v2: t.UnionC<[t.TypeC<{
49
+ src: t.StringC;
50
+ file_name: t.StringC;
51
+ size: t.StringC;
52
+ }>, t.NullC]>;
47
53
  copilot_personality: t.UnionC<[t.TypeC<{
48
54
  template: t.UnionC<[t.LiteralC<"professional">, t.LiteralC<"friendly">, t.LiteralC<"confident">, t.LiteralC<"serious">, t.LiteralC<"empathetic">]>;
49
55
  }>, t.TypeC<{
@@ -52,6 +58,7 @@ export declare const OrganizationSettingsV: t.TypeC<{
52
58
  response_length: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
53
59
  response_format: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
54
60
  }>]>;
61
+ copilot_chat_history_enabled: t.BooleanC;
55
62
  helphub_enabled: t.BooleanC;
56
63
  helphub_launcher_type: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"askAI">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
57
64
  helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
@@ -86,10 +93,18 @@ export declare const OrganizationSettingsV: t.TypeC<{
86
93
  value: t.StringC;
87
94
  }>, t.PartialC<{
88
95
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
96
+ meta: t.TypeC<{
97
+ command: t.StringC;
98
+ }>;
89
99
  }>]>, t.TypeC<{
90
100
  type: t.LiteralC<"open_chat">;
91
101
  meta: t.TypeC<{
92
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
102
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
103
+ }>;
104
+ }>, t.TypeC<{
105
+ type: t.LiteralC<"chat_handoff">;
106
+ meta: t.TypeC<{
107
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
93
108
  }>;
94
109
  }>, t.TypeC<{
95
110
  type: t.LiteralC<"dismiss">;
@@ -113,9 +128,11 @@ export declare const OrganizationSettingsV: t.TypeC<{
113
128
  categoryFilter: t.NumberC;
114
129
  }>]>, t.TypeC<{
115
130
  type: t.LiteralC<"open_helphub">;
116
- }>, t.TypeC<{
131
+ }>, t.IntersectionC<[t.TypeC<{
117
132
  type: t.LiteralC<"open_copilot">;
118
- }>]>;
133
+ }>, t.PartialC<{
134
+ query: t.StringC;
135
+ }>]>]>;
119
136
  }>>;
120
137
  helphub_search_action: t.UnionC<[t.LiteralC<"search">, t.LiteralC<"ask">]>;
121
138
  copilot_negative_feedback_fallback_enabled: t.BooleanC;
@@ -142,10 +159,18 @@ export declare const OrganizationSettingsV: t.TypeC<{
142
159
  value: t.StringC;
143
160
  }>, t.PartialC<{
144
161
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
162
+ meta: t.TypeC<{
163
+ command: t.StringC;
164
+ }>;
145
165
  }>]>, t.TypeC<{
146
166
  type: t.LiteralC<"open_chat">;
147
167
  meta: t.TypeC<{
148
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
168
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"pylon">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
169
+ }>;
170
+ }>, t.TypeC<{
171
+ type: t.LiteralC<"chat_handoff">;
172
+ meta: t.TypeC<{
173
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"freshchat">, t.LiteralC<"zendesk">, t.LiteralC<"">]>;
149
174
  }>;
150
175
  }>, t.TypeC<{
151
176
  type: t.LiteralC<"dismiss">;
@@ -169,9 +194,11 @@ export declare const OrganizationSettingsV: t.TypeC<{
169
194
  categoryFilter: t.NumberC;
170
195
  }>]>, t.TypeC<{
171
196
  type: t.LiteralC<"open_helphub">;
172
- }>, t.TypeC<{
197
+ }>, t.IntersectionC<[t.TypeC<{
173
198
  type: t.LiteralC<"open_copilot">;
174
- }>]>;
199
+ }>, t.PartialC<{
200
+ query: t.StringC;
201
+ }>]>]>;
175
202
  }>>;
176
203
  nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
177
204
  bar_hide_completed_nudges_questlists: t.BooleanC;
@@ -179,6 +206,21 @@ export declare const OrganizationSettingsV: t.TypeC<{
179
206
  share_link_param: t.StringC;
180
207
  spotlight_ask_copilot_enabled: t.BooleanC;
181
208
  spotlight_ask_copilot_label: t.UnionC<[t.StringC, t.NullC]>;
209
+ spotlight_custom_theme: t.UnionC<[t.StringC, t.NullC]>;
210
+ spotlight_ask_copilot_audience: t.UnionC<[t.UnionC<[t.TypeC<{
211
+ type: t.LiteralC<"all_users">;
212
+ }>, t.TypeC<{
213
+ type: t.LiteralC<"rule_expression">;
214
+ expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
215
+ }>, t.TypeC<{
216
+ type: t.LiteralC<"named_rule_reference">;
217
+ rule_reference: t.IntersectionC<[t.TypeC<{
218
+ type: t.LiteralC<"named_rule">;
219
+ rule_id: t.UnionC<[t.NumberC, t.StringC]>;
220
+ }>, t.PartialC<{
221
+ reason: t.StringC;
222
+ }>]>;
223
+ }>]>, t.NullC]>;
182
224
  copilot_enabled: t.BooleanC;
183
225
  /** @deprecated Replaced by the `copilot_enabled` field */
184
226
  helphub_ai_enabled: t.BooleanC;
@@ -233,8 +275,14 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
233
275
  helphub_suggested_queries_enabled: boolean;
234
276
  helphub_continuations_enabled: boolean;
235
277
  helphub_manual_suggested_queries: string[];
278
+ helphub_custom_theme: string | null;
236
279
  copilot_name: string;
237
280
  copilot_avatar: string;
281
+ copilot_avatar_v2: {
282
+ src: string;
283
+ file_name: string;
284
+ size: string;
285
+ } | null;
238
286
  copilot_personality: {
239
287
  template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
240
288
  } | {
@@ -243,42 +291,53 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
243
291
  response_length: "long" | "short" | "conversational";
244
292
  response_format: "mixed" | "lists" | "paragraphs";
245
293
  };
294
+ copilot_chat_history_enabled: boolean;
246
295
  helphub_enabled: boolean;
247
- helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
248
- helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
296
+ helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
297
+ helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
249
298
  helphub_launcher_offset_x: number;
250
299
  helphub_launcher_offset_y: number;
251
300
  helphub_launcher_anchor: string;
252
- helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
253
- helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
301
+ helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
302
+ helphub_mobile_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
254
303
  helphub_mobile_launcher_offset_x: number;
255
304
  helphub_mobile_launcher_offset_y: number;
256
305
  helphub_mobile_launcher_anchor: string;
257
306
  helphub_chat_fallback_message: string;
258
307
  helphub_chat_fallback_actions: {
259
308
  cta: string;
260
- action: {
309
+ action: ({
310
+ type: "link";
311
+ value: string;
312
+ } & {
313
+ operation?: "self" | "router" | "blank" | undefined;
314
+ meta?: {
315
+ command: string;
316
+ } | undefined;
317
+ }) | {
318
+ type: "click" | "clickBySelector" | "clickByXpath";
319
+ value: string[];
320
+ } | {
261
321
  type: "execute_command";
262
322
  meta: {
263
323
  command: string;
264
324
  } & {
265
325
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
266
326
  };
327
+ } | {
328
+ type: "no_action";
267
329
  } | {
268
330
  type: "click";
269
331
  value: string;
270
332
  } | {
271
- type: "click" | "clickBySelector" | "clickByXpath";
272
- value: string[];
273
- } | ({
274
- type: "link";
275
- value: string;
276
- } & {
277
- operation?: "self" | "router" | "blank" | undefined;
278
- }) | {
279
333
  type: "open_chat";
280
334
  meta: {
281
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
335
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
336
+ };
337
+ } | {
338
+ type: "chat_handoff";
339
+ meta: {
340
+ type: "" | "intercom" | "freshchat" | "zendesk";
282
341
  };
283
342
  } | {
284
343
  type: "dismiss";
@@ -287,14 +346,14 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
287
346
  } | {
288
347
  type: "questlist";
289
348
  value: number;
290
- } | {
291
- type: "step_back";
292
349
  } | {
293
350
  type: "nudge";
294
351
  value: number;
295
352
  } | {
296
353
  type: "go_to_step";
297
354
  value: number;
355
+ } | {
356
+ type: "step_back";
298
357
  } | ({
299
358
  type: "open_bar";
300
359
  } & {
@@ -302,39 +361,49 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
302
361
  categoryFilter?: number | undefined;
303
362
  }) | {
304
363
  type: "open_helphub";
305
- } | {
364
+ } | ({
306
365
  type: "open_copilot";
307
- } | {
308
- type: "no_action";
309
- };
366
+ } & {
367
+ query?: string | undefined;
368
+ });
310
369
  }[];
311
370
  helphub_search_action: "search" | "ask";
312
371
  copilot_negative_feedback_fallback_enabled: boolean;
313
372
  copilot_negative_feedback_fallback_message: string | null;
314
373
  copilot_negative_feedback_fallback_actions: {
315
374
  cta: string;
316
- action: {
375
+ action: ({
376
+ type: "link";
377
+ value: string;
378
+ } & {
379
+ operation?: "self" | "router" | "blank" | undefined;
380
+ meta?: {
381
+ command: string;
382
+ } | undefined;
383
+ }) | {
384
+ type: "click" | "clickBySelector" | "clickByXpath";
385
+ value: string[];
386
+ } | {
317
387
  type: "execute_command";
318
388
  meta: {
319
389
  command: string;
320
390
  } & {
321
391
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
322
392
  };
393
+ } | {
394
+ type: "no_action";
323
395
  } | {
324
396
  type: "click";
325
397
  value: string;
326
398
  } | {
327
- type: "click" | "clickBySelector" | "clickByXpath";
328
- value: string[];
329
- } | ({
330
- type: "link";
331
- value: string;
332
- } & {
333
- operation?: "self" | "router" | "blank" | undefined;
334
- }) | {
335
399
  type: "open_chat";
336
400
  meta: {
337
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
401
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
402
+ };
403
+ } | {
404
+ type: "chat_handoff";
405
+ meta: {
406
+ type: "" | "intercom" | "freshchat" | "zendesk";
338
407
  };
339
408
  } | {
340
409
  type: "dismiss";
@@ -343,14 +412,14 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
343
412
  } | {
344
413
  type: "questlist";
345
414
  value: number;
346
- } | {
347
- type: "step_back";
348
415
  } | {
349
416
  type: "nudge";
350
417
  value: number;
351
418
  } | {
352
419
  type: "go_to_step";
353
420
  value: number;
421
+ } | {
422
+ type: "step_back";
354
423
  } | ({
355
424
  type: "open_bar";
356
425
  } & {
@@ -358,11 +427,11 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
358
427
  categoryFilter?: number | undefined;
359
428
  }) | {
360
429
  type: "open_helphub";
361
- } | {
430
+ } | ({
362
431
  type: "open_copilot";
363
- } | {
364
- type: "no_action";
365
- };
432
+ } & {
433
+ query?: string | undefined;
434
+ });
366
435
  }[];
367
436
  nudge_rate_limit: number | null;
368
437
  bar_hide_completed_nudges_questlists: boolean;
@@ -370,6 +439,21 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
370
439
  share_link_param: string;
371
440
  spotlight_ask_copilot_enabled: boolean;
372
441
  spotlight_ask_copilot_label: string | null;
442
+ spotlight_custom_theme: string | null;
443
+ spotlight_ask_copilot_audience: {
444
+ type: "all_users";
445
+ } | {
446
+ type: "rule_expression";
447
+ expression: import("./helpers/rules").RuleExpression;
448
+ } | {
449
+ type: "named_rule_reference";
450
+ rule_reference: {
451
+ type: "named_rule";
452
+ rule_id: string | number;
453
+ } & {
454
+ reason?: string | undefined;
455
+ };
456
+ } | null;
373
457
  copilot_enabled: boolean;
374
458
  helphub_ai_enabled: boolean;
375
459
  copilot_experiences_enabled: boolean;
@@ -418,8 +502,14 @@ export declare const update: (object: {
418
502
  helphub_suggested_queries_enabled?: boolean | undefined;
419
503
  helphub_continuations_enabled?: boolean | undefined;
420
504
  helphub_manual_suggested_queries?: string[] | undefined;
505
+ helphub_custom_theme?: string | null | undefined;
421
506
  copilot_name?: string | undefined;
422
507
  copilot_avatar?: string | undefined;
508
+ copilot_avatar_v2?: {
509
+ src: string;
510
+ file_name: string;
511
+ size: string;
512
+ } | null | undefined;
423
513
  copilot_personality?: {
424
514
  template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
425
515
  } | {
@@ -428,42 +518,53 @@ export declare const update: (object: {
428
518
  response_length: "long" | "short" | "conversational";
429
519
  response_format: "mixed" | "lists" | "paragraphs";
430
520
  } | undefined;
521
+ copilot_chat_history_enabled?: boolean | undefined;
431
522
  helphub_enabled?: boolean | undefined;
432
- helphub_launcher_type?: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI" | undefined;
433
- helphub_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
523
+ helphub_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
524
+ helphub_launcher_position?: "topRight" | "topLeft" | "bottomRight" | "bottomLeft" | undefined;
434
525
  helphub_launcher_offset_x?: number | undefined;
435
526
  helphub_launcher_offset_y?: number | undefined;
436
527
  helphub_launcher_anchor?: string | undefined;
437
- helphub_mobile_launcher_type?: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI" | undefined;
438
- helphub_mobile_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
528
+ helphub_mobile_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
529
+ helphub_mobile_launcher_position?: "topRight" | "topLeft" | "bottomRight" | "bottomLeft" | undefined;
439
530
  helphub_mobile_launcher_offset_x?: number | undefined;
440
531
  helphub_mobile_launcher_offset_y?: number | undefined;
441
532
  helphub_mobile_launcher_anchor?: string | undefined;
442
533
  helphub_chat_fallback_message?: string | undefined;
443
534
  helphub_chat_fallback_actions?: {
444
535
  cta: string;
445
- action: {
536
+ action: ({
537
+ type: "link";
538
+ value: string;
539
+ } & {
540
+ operation?: "self" | "router" | "blank" | undefined;
541
+ meta?: {
542
+ command: string;
543
+ } | undefined;
544
+ }) | {
545
+ type: "click" | "clickBySelector" | "clickByXpath";
546
+ value: string[];
547
+ } | {
446
548
  type: "execute_command";
447
549
  meta: {
448
550
  command: string;
449
551
  } & {
450
552
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
451
553
  };
554
+ } | {
555
+ type: "no_action";
452
556
  } | {
453
557
  type: "click";
454
558
  value: string;
455
559
  } | {
456
- type: "click" | "clickBySelector" | "clickByXpath";
457
- value: string[];
458
- } | ({
459
- type: "link";
460
- value: string;
461
- } & {
462
- operation?: "self" | "router" | "blank" | undefined;
463
- }) | {
464
560
  type: "open_chat";
465
561
  meta: {
466
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
562
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
563
+ };
564
+ } | {
565
+ type: "chat_handoff";
566
+ meta: {
567
+ type: "" | "intercom" | "freshchat" | "zendesk";
467
568
  };
468
569
  } | {
469
570
  type: "dismiss";
@@ -472,14 +573,14 @@ export declare const update: (object: {
472
573
  } | {
473
574
  type: "questlist";
474
575
  value: number;
475
- } | {
476
- type: "step_back";
477
576
  } | {
478
577
  type: "nudge";
479
578
  value: number;
480
579
  } | {
481
580
  type: "go_to_step";
482
581
  value: number;
582
+ } | {
583
+ type: "step_back";
483
584
  } | ({
484
585
  type: "open_bar";
485
586
  } & {
@@ -487,39 +588,49 @@ export declare const update: (object: {
487
588
  categoryFilter?: number | undefined;
488
589
  }) | {
489
590
  type: "open_helphub";
490
- } | {
591
+ } | ({
491
592
  type: "open_copilot";
492
- } | {
493
- type: "no_action";
494
- };
593
+ } & {
594
+ query?: string | undefined;
595
+ });
495
596
  }[] | undefined;
496
597
  helphub_search_action?: "search" | "ask" | undefined;
497
598
  copilot_negative_feedback_fallback_enabled?: boolean | undefined;
498
599
  copilot_negative_feedback_fallback_message?: string | null | undefined;
499
600
  copilot_negative_feedback_fallback_actions?: {
500
601
  cta: string;
501
- action: {
602
+ action: ({
603
+ type: "link";
604
+ value: string;
605
+ } & {
606
+ operation?: "self" | "router" | "blank" | undefined;
607
+ meta?: {
608
+ command: string;
609
+ } | undefined;
610
+ }) | {
611
+ type: "click" | "clickBySelector" | "clickByXpath";
612
+ value: string[];
613
+ } | {
502
614
  type: "execute_command";
503
615
  meta: {
504
616
  command: string;
505
617
  } & {
506
618
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
507
619
  };
620
+ } | {
621
+ type: "no_action";
508
622
  } | {
509
623
  type: "click";
510
624
  value: string;
511
625
  } | {
512
- type: "click" | "clickBySelector" | "clickByXpath";
513
- value: string[];
514
- } | ({
515
- type: "link";
516
- value: string;
517
- } & {
518
- operation?: "self" | "router" | "blank" | undefined;
519
- }) | {
520
626
  type: "open_chat";
521
627
  meta: {
522
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
628
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
629
+ };
630
+ } | {
631
+ type: "chat_handoff";
632
+ meta: {
633
+ type: "" | "intercom" | "freshchat" | "zendesk";
523
634
  };
524
635
  } | {
525
636
  type: "dismiss";
@@ -528,14 +639,14 @@ export declare const update: (object: {
528
639
  } | {
529
640
  type: "questlist";
530
641
  value: number;
531
- } | {
532
- type: "step_back";
533
642
  } | {
534
643
  type: "nudge";
535
644
  value: number;
536
645
  } | {
537
646
  type: "go_to_step";
538
647
  value: number;
648
+ } | {
649
+ type: "step_back";
539
650
  } | ({
540
651
  type: "open_bar";
541
652
  } & {
@@ -543,11 +654,11 @@ export declare const update: (object: {
543
654
  categoryFilter?: number | undefined;
544
655
  }) | {
545
656
  type: "open_helphub";
546
- } | {
657
+ } | ({
547
658
  type: "open_copilot";
548
- } | {
549
- type: "no_action";
550
- };
659
+ } & {
660
+ query?: string | undefined;
661
+ });
551
662
  }[] | undefined;
552
663
  nudge_rate_limit?: number | null | undefined;
553
664
  bar_hide_completed_nudges_questlists?: boolean | undefined;
@@ -555,6 +666,21 @@ export declare const update: (object: {
555
666
  share_link_param?: string | undefined;
556
667
  spotlight_ask_copilot_enabled?: boolean | undefined;
557
668
  spotlight_ask_copilot_label?: string | null | undefined;
669
+ spotlight_custom_theme?: string | null | undefined;
670
+ spotlight_ask_copilot_audience?: {
671
+ type: "all_users";
672
+ } | {
673
+ type: "rule_expression";
674
+ expression: import("./helpers/rules").RuleExpression;
675
+ } | {
676
+ type: "named_rule_reference";
677
+ rule_reference: {
678
+ type: "named_rule";
679
+ rule_id: string | number;
680
+ } & {
681
+ reason?: string | undefined;
682
+ };
683
+ } | null | undefined;
558
684
  copilot_enabled?: boolean | undefined;
559
685
  helphub_ai_enabled?: boolean | undefined;
560
686
  copilot_experiences_enabled?: boolean | undefined;
@@ -605,8 +731,14 @@ export declare const update: (object: {
605
731
  helphub_suggested_queries_enabled: boolean;
606
732
  helphub_continuations_enabled: boolean;
607
733
  helphub_manual_suggested_queries: string[];
734
+ helphub_custom_theme: string | null;
608
735
  copilot_name: string;
609
736
  copilot_avatar: string;
737
+ copilot_avatar_v2: {
738
+ src: string;
739
+ file_name: string;
740
+ size: string;
741
+ } | null;
610
742
  copilot_personality: {
611
743
  template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
612
744
  } | {
@@ -615,42 +747,53 @@ export declare const update: (object: {
615
747
  response_length: "long" | "short" | "conversational";
616
748
  response_format: "mixed" | "lists" | "paragraphs";
617
749
  };
750
+ copilot_chat_history_enabled: boolean;
618
751
  helphub_enabled: boolean;
619
- helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
620
- helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
752
+ helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
753
+ helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
621
754
  helphub_launcher_offset_x: number;
622
755
  helphub_launcher_offset_y: number;
623
756
  helphub_launcher_anchor: string;
624
- helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
625
- helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
757
+ helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
758
+ helphub_mobile_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
626
759
  helphub_mobile_launcher_offset_x: number;
627
760
  helphub_mobile_launcher_offset_y: number;
628
761
  helphub_mobile_launcher_anchor: string;
629
762
  helphub_chat_fallback_message: string;
630
763
  helphub_chat_fallback_actions: {
631
764
  cta: string;
632
- action: {
765
+ action: ({
766
+ type: "link";
767
+ value: string;
768
+ } & {
769
+ operation?: "self" | "router" | "blank" | undefined;
770
+ meta?: {
771
+ command: string;
772
+ } | undefined;
773
+ }) | {
774
+ type: "click" | "clickBySelector" | "clickByXpath";
775
+ value: string[];
776
+ } | {
633
777
  type: "execute_command";
634
778
  meta: {
635
779
  command: string;
636
780
  } & {
637
781
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
638
782
  };
783
+ } | {
784
+ type: "no_action";
639
785
  } | {
640
786
  type: "click";
641
787
  value: string;
642
788
  } | {
643
- type: "click" | "clickBySelector" | "clickByXpath";
644
- value: string[];
645
- } | ({
646
- type: "link";
647
- value: string;
648
- } & {
649
- operation?: "self" | "router" | "blank" | undefined;
650
- }) | {
651
789
  type: "open_chat";
652
790
  meta: {
653
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
791
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
792
+ };
793
+ } | {
794
+ type: "chat_handoff";
795
+ meta: {
796
+ type: "" | "intercom" | "freshchat" | "zendesk";
654
797
  };
655
798
  } | {
656
799
  type: "dismiss";
@@ -659,14 +802,14 @@ export declare const update: (object: {
659
802
  } | {
660
803
  type: "questlist";
661
804
  value: number;
662
- } | {
663
- type: "step_back";
664
805
  } | {
665
806
  type: "nudge";
666
807
  value: number;
667
808
  } | {
668
809
  type: "go_to_step";
669
810
  value: number;
811
+ } | {
812
+ type: "step_back";
670
813
  } | ({
671
814
  type: "open_bar";
672
815
  } & {
@@ -674,39 +817,49 @@ export declare const update: (object: {
674
817
  categoryFilter?: number | undefined;
675
818
  }) | {
676
819
  type: "open_helphub";
677
- } | {
820
+ } | ({
678
821
  type: "open_copilot";
679
- } | {
680
- type: "no_action";
681
- };
822
+ } & {
823
+ query?: string | undefined;
824
+ });
682
825
  }[];
683
826
  helphub_search_action: "search" | "ask";
684
827
  copilot_negative_feedback_fallback_enabled: boolean;
685
828
  copilot_negative_feedback_fallback_message: string | null;
686
829
  copilot_negative_feedback_fallback_actions: {
687
830
  cta: string;
688
- action: {
831
+ action: ({
832
+ type: "link";
833
+ value: string;
834
+ } & {
835
+ operation?: "self" | "router" | "blank" | undefined;
836
+ meta?: {
837
+ command: string;
838
+ } | undefined;
839
+ }) | {
840
+ type: "click" | "clickBySelector" | "clickByXpath";
841
+ value: string[];
842
+ } | {
689
843
  type: "execute_command";
690
844
  meta: {
691
845
  command: string;
692
846
  } & {
693
847
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
694
848
  };
849
+ } | {
850
+ type: "no_action";
695
851
  } | {
696
852
  type: "click";
697
853
  value: string;
698
854
  } | {
699
- type: "click" | "clickBySelector" | "clickByXpath";
700
- value: string[];
701
- } | ({
702
- type: "link";
703
- value: string;
704
- } & {
705
- operation?: "self" | "router" | "blank" | undefined;
706
- }) | {
707
855
  type: "open_chat";
708
856
  meta: {
709
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
857
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
858
+ };
859
+ } | {
860
+ type: "chat_handoff";
861
+ meta: {
862
+ type: "" | "intercom" | "freshchat" | "zendesk";
710
863
  };
711
864
  } | {
712
865
  type: "dismiss";
@@ -715,14 +868,14 @@ export declare const update: (object: {
715
868
  } | {
716
869
  type: "questlist";
717
870
  value: number;
718
- } | {
719
- type: "step_back";
720
871
  } | {
721
872
  type: "nudge";
722
873
  value: number;
723
874
  } | {
724
875
  type: "go_to_step";
725
876
  value: number;
877
+ } | {
878
+ type: "step_back";
726
879
  } | ({
727
880
  type: "open_bar";
728
881
  } & {
@@ -730,11 +883,11 @@ export declare const update: (object: {
730
883
  categoryFilter?: number | undefined;
731
884
  }) | {
732
885
  type: "open_helphub";
733
- } | {
886
+ } | ({
734
887
  type: "open_copilot";
735
- } | {
736
- type: "no_action";
737
- };
888
+ } & {
889
+ query?: string | undefined;
890
+ });
738
891
  }[];
739
892
  nudge_rate_limit: number | null;
740
893
  bar_hide_completed_nudges_questlists: boolean;
@@ -742,6 +895,21 @@ export declare const update: (object: {
742
895
  share_link_param: string;
743
896
  spotlight_ask_copilot_enabled: boolean;
744
897
  spotlight_ask_copilot_label: string | null;
898
+ spotlight_custom_theme: string | null;
899
+ spotlight_ask_copilot_audience: {
900
+ type: "all_users";
901
+ } | {
902
+ type: "rule_expression";
903
+ expression: import("./helpers/rules").RuleExpression;
904
+ } | {
905
+ type: "named_rule_reference";
906
+ rule_reference: {
907
+ type: "named_rule";
908
+ rule_id: string | number;
909
+ } & {
910
+ reason?: string | undefined;
911
+ };
912
+ } | null;
745
913
  copilot_enabled: boolean;
746
914
  helphub_ai_enabled: boolean;
747
915
  copilot_experiences_enabled: boolean;