commandbar 1.9.0 → 1.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +32 -10
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +4 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +46 -13
  7. package/build/internal/src/client/CommandBarSDK.d.ts +17 -10
  8. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  9. package/build/internal/src/client/symbols.d.ts +5 -1
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +22 -10
  11. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  12. package/build/internal/src/middleware/OrganizationV.d.ts +200 -6
  13. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  14. package/build/internal/src/middleware/additionalResource.d.ts +96 -15
  15. package/build/internal/src/middleware/billing.d.ts +0 -2
  16. package/build/internal/src/middleware/chat.d.ts +2196 -176
  17. package/build/internal/src/middleware/checklist.d.ts +504 -63
  18. package/build/internal/src/middleware/command.d.ts +1809 -385
  19. package/build/internal/src/middleware/endUser.d.ts +33 -5
  20. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  21. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  22. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  23. package/build/internal/src/middleware/flags.d.ts +20 -0
  24. package/build/internal/src/middleware/helpDocsIntegration.d.ts +9 -0
  25. package/build/internal/src/middleware/helpDocsSearch.d.ts +371 -35
  26. package/build/internal/src/middleware/helpers/actions.d.ts +66 -16
  27. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +70 -8
  28. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  29. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  30. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +22 -0
  31. package/build/internal/src/middleware/helpers/rules.d.ts +45 -36
  32. package/build/internal/src/middleware/network.d.ts +15 -0
  33. package/build/internal/src/middleware/nudge.d.ts +1103 -124
  34. package/build/internal/src/middleware/organization.d.ts +1288 -61
  35. package/build/internal/src/middleware/organizationSettings.d.ts +320 -12
  36. package/build/internal/src/middleware/profile.d.ts +2 -0
  37. package/build/internal/src/middleware/recommendationSet.d.ts +96 -15
  38. package/build/internal/src/middleware/releases.d.ts +1 -1
  39. package/build/internal/src/middleware/theme.d.ts +431 -0
  40. package/build/internal/src/middleware/types.d.ts +52 -15
  41. package/build/internal/src/middleware/user.d.ts +1 -0
  42. package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -3
  43. package/build/internal/src/util/operatingSystem.d.ts +2 -4
  44. package/package.json +1 -1
  45. package/src/index.ts +2 -2
  46. package/src/init.ts +12 -6
  47. package/src/snippet.ts +2 -2
  48. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  49. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  50. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
@@ -30,6 +30,7 @@ export declare const OrganizationSettingsV: t.TypeC<{
30
30
  slash_filters_enabled: t.BooleanC;
31
31
  recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
32
32
  recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
33
+ experiences_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
33
34
  num_live_commands: t.NumberC;
34
35
  help_center_sync: t.UnionC<[t.LiteralC<"upload-once">, t.LiteralC<"manual">, t.LiteralC<"automatic">]>;
35
36
  show_suggested_synonyms: t.BooleanC;
@@ -41,6 +42,16 @@ export declare const OrganizationSettingsV: t.TypeC<{
41
42
  helphub_suggested_queries_enabled: t.BooleanC;
42
43
  helphub_continuations_enabled: t.BooleanC;
43
44
  helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
45
+ copilot_name: t.StringC;
46
+ copilot_avatar: t.StringC;
47
+ copilot_personality: t.UnionC<[t.TypeC<{
48
+ template: t.UnionC<[t.LiteralC<"professional">, t.LiteralC<"friendly">, t.LiteralC<"confident">, t.LiteralC<"serious">, t.LiteralC<"empathetic">]>;
49
+ }>, t.TypeC<{
50
+ template: t.LiteralC<"custom">;
51
+ adjectives: t.ArrayC<t.UnionC<[t.LiteralC<"abrasive">, t.LiteralC<"adventurous">, t.LiteralC<"affable">, t.LiteralC<"arrogant">, t.LiteralC<"assertive">, t.LiteralC<"assured">, t.LiteralC<"belligerent">, t.LiteralC<"brave">, t.LiteralC<"cheerful">, t.LiteralC<"compassionate">, t.LiteralC<"condescending">, t.LiteralC<"courteous">, t.LiteralC<"creative">, t.LiteralC<"cynical">, t.LiteralC<"decisive">, t.LiteralC<"detached">, t.LiteralC<"diligent">, t.LiteralC<"eloquent">, t.LiteralC<"empathetic">, t.LiteralC<"evasive">, t.LiteralC<"formal">, t.LiteralC<"frivolous">, t.LiteralC<"garrulous">, t.LiteralC<"generous">, t.LiteralC<"impulsive">, t.LiteralC<"innovative">, t.LiteralC<"intense">, t.LiteralC<"judgmental">, t.LiteralC<"jovial">, t.LiteralC<"manipulative">, t.LiteralC<"obstinate">, t.LiteralC<"optimistic">, t.LiteralC<"perceptive">, t.LiteralC<"pessimistic">, t.LiteralC<"quarrelsome">, t.LiteralC<"respectful">, t.LiteralC<"resourceful">, t.LiteralC<"sarcastic">, t.LiteralC<"sincere">, t.LiteralC<"sociable">, t.LiteralC<"solemn">, t.LiteralC<"supportive">, t.LiteralC<"tactful">, t.LiteralC<"thoughtful">, t.LiteralC<"understanding">, t.LiteralC<"unreliable">, t.LiteralC<"vain">, t.LiteralC<"vivacious">, t.LiteralC<"warm">, t.LiteralC<"withdrawn">, t.LiteralC<"witty">, t.LiteralC<"zealous">]>>;
52
+ response_length: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
53
+ response_format: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
54
+ }>]>;
44
55
  helphub_enabled: t.BooleanC;
45
56
  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">]>;
46
57
  helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
@@ -57,14 +68,74 @@ export declare const OrganizationSettingsV: t.TypeC<{
57
68
  cta: t.StringC;
58
69
  action: t.UnionC<[t.TypeC<{
59
70
  type: t.LiteralC<"execute_command">;
60
- meta: t.TypeC<{
71
+ meta: t.IntersectionC<[t.TypeC<{
61
72
  command: t.StringC;
73
+ }>, t.PartialC<{
74
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
75
+ }>]>;
76
+ }>, t.TypeC<{
77
+ type: t.LiteralC<"no_action">;
78
+ }>, t.TypeC<{
79
+ type: t.LiteralC<"click">;
80
+ value: t.StringC;
81
+ }>, t.TypeC<{
82
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
83
+ value: t.ArrayC<t.StringC>;
84
+ }>, t.IntersectionC<[t.TypeC<{
85
+ type: t.LiteralC<"link">;
86
+ value: t.StringC;
87
+ }>, t.PartialC<{
88
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
89
+ }>]>, t.TypeC<{
90
+ type: t.LiteralC<"open_chat">;
91
+ meta: t.TypeC<{
92
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
62
93
  }>;
94
+ }>, t.TypeC<{
95
+ type: t.LiteralC<"dismiss">;
96
+ }>, t.TypeC<{
97
+ type: t.LiteralC<"snooze">;
98
+ }>, t.TypeC<{
99
+ type: t.LiteralC<"questlist">;
100
+ value: t.NumberC;
101
+ }>, t.TypeC<{
102
+ type: t.LiteralC<"nudge">;
103
+ value: t.NumberC;
104
+ }>, t.TypeC<{
105
+ type: t.LiteralC<"go_to_step">;
106
+ value: t.NumberC;
107
+ }>, t.TypeC<{
108
+ type: t.LiteralC<"step_back">;
109
+ }>, t.IntersectionC<[t.TypeC<{
110
+ type: t.LiteralC<"open_bar">;
111
+ }>, t.PartialC<{
112
+ value: t.StringC;
113
+ categoryFilter: t.NumberC;
114
+ }>]>, t.TypeC<{
115
+ type: t.LiteralC<"open_helphub">;
116
+ }>, t.TypeC<{
117
+ type: t.LiteralC<"open_copilot">;
118
+ }>]>;
119
+ }>>;
120
+ copilot_negative_feedback_fallback_enabled: t.BooleanC;
121
+ copilot_negative_feedback_fallback_message: t.UnionC<[t.StringC, t.NullC]>;
122
+ copilot_negative_feedback_fallback_actions: t.ArrayC<t.TypeC<{
123
+ cta: t.StringC;
124
+ action: t.UnionC<[t.TypeC<{
125
+ type: t.LiteralC<"execute_command">;
126
+ meta: t.IntersectionC<[t.TypeC<{
127
+ command: t.StringC;
128
+ }>, t.PartialC<{
129
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
130
+ }>]>;
63
131
  }>, t.TypeC<{
64
132
  type: t.LiteralC<"no_action">;
65
133
  }>, t.TypeC<{
66
134
  type: t.LiteralC<"click">;
67
135
  value: t.StringC;
136
+ }>, t.TypeC<{
137
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
138
+ value: t.ArrayC<t.StringC>;
68
139
  }>, t.IntersectionC<[t.TypeC<{
69
140
  type: t.LiteralC<"link">;
70
141
  value: t.StringC;
@@ -73,7 +144,7 @@ export declare const OrganizationSettingsV: t.TypeC<{
73
144
  }>]>, t.TypeC<{
74
145
  type: t.LiteralC<"open_chat">;
75
146
  meta: t.TypeC<{
76
- type: t.StringC;
147
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
77
148
  }>;
78
149
  }>, t.TypeC<{
79
150
  type: t.LiteralC<"dismiss">;
@@ -95,12 +166,18 @@ export declare const OrganizationSettingsV: t.TypeC<{
95
166
  }>, t.PartialC<{
96
167
  value: t.StringC;
97
168
  categoryFilter: t.NumberC;
98
- }>]>]>;
169
+ }>]>, t.TypeC<{
170
+ type: t.LiteralC<"open_helphub">;
171
+ }>, t.TypeC<{
172
+ type: t.LiteralC<"open_copilot">;
173
+ }>]>;
99
174
  }>>;
100
175
  nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
101
176
  bar_hide_completed_nudges_questlists: t.BooleanC;
102
177
  nudge_rate_period: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"session">]>;
103
178
  share_link_param: t.StringC;
179
+ spotlight_ask_copilot_enabled: t.BooleanC;
180
+ spotlight_ask_copilot_label: t.UnionC<[t.StringC, t.NullC]>;
104
181
  copilot_enabled: t.BooleanC;
105
182
  /** @deprecated Replaced by the `copilot_enabled` field */
106
183
  helphub_ai_enabled: t.BooleanC;
@@ -143,6 +220,7 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
143
220
  slash_filters_enabled: boolean;
144
221
  recents_sort_key: number | null;
145
222
  recommended_sort_key: number | null;
223
+ experiences_sort_key: number | null;
146
224
  num_live_commands: number;
147
225
  help_center_sync: "manual" | "upload-once" | "automatic";
148
226
  show_suggested_synonyms: boolean;
@@ -154,13 +232,23 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
154
232
  helphub_suggested_queries_enabled: boolean;
155
233
  helphub_continuations_enabled: boolean;
156
234
  helphub_manual_suggested_queries: string[];
235
+ copilot_name: string;
236
+ copilot_avatar: string;
237
+ copilot_personality: {
238
+ template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
239
+ } | {
240
+ template: "custom";
241
+ adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
242
+ response_length: "long" | "short" | "conversational";
243
+ response_format: "mixed" | "lists" | "paragraphs";
244
+ };
157
245
  helphub_enabled: boolean;
158
- helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
246
+ helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
159
247
  helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
160
248
  helphub_launcher_offset_x: number;
161
249
  helphub_launcher_offset_y: number;
162
250
  helphub_launcher_anchor: string;
163
- helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
251
+ helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
164
252
  helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
165
253
  helphub_mobile_launcher_offset_x: number;
166
254
  helphub_mobile_launcher_offset_y: number;
@@ -172,10 +260,15 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
172
260
  type: "execute_command";
173
261
  meta: {
174
262
  command: string;
263
+ } & {
264
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
175
265
  };
176
266
  } | {
177
267
  type: "click";
178
268
  value: string;
269
+ } | {
270
+ type: "click" | "clickBySelector" | "clickByXpath";
271
+ value: string[];
179
272
  } | ({
180
273
  type: "link";
181
274
  value: string;
@@ -184,7 +277,7 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
184
277
  }) | {
185
278
  type: "open_chat";
186
279
  meta: {
187
- type: string;
280
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
188
281
  };
189
282
  } | {
190
283
  type: "dismiss";
@@ -207,6 +300,65 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
207
300
  value?: string | undefined;
208
301
  categoryFilter?: number | undefined;
209
302
  }) | {
303
+ type: "open_helphub";
304
+ } | {
305
+ type: "open_copilot";
306
+ } | {
307
+ type: "no_action";
308
+ };
309
+ }[];
310
+ copilot_negative_feedback_fallback_enabled: boolean;
311
+ copilot_negative_feedback_fallback_message: string | null;
312
+ copilot_negative_feedback_fallback_actions: {
313
+ cta: string;
314
+ action: {
315
+ type: "execute_command";
316
+ meta: {
317
+ command: string;
318
+ } & {
319
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
320
+ };
321
+ } | {
322
+ type: "click";
323
+ value: string;
324
+ } | {
325
+ type: "click" | "clickBySelector" | "clickByXpath";
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: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
336
+ };
337
+ } | {
338
+ type: "dismiss";
339
+ } | {
340
+ type: "snooze";
341
+ } | {
342
+ type: "questlist";
343
+ value: number;
344
+ } | {
345
+ type: "step_back";
346
+ } | {
347
+ type: "nudge";
348
+ value: number;
349
+ } | {
350
+ type: "go_to_step";
351
+ value: number;
352
+ } | ({
353
+ type: "open_bar";
354
+ } & {
355
+ value?: string | undefined;
356
+ categoryFilter?: number | undefined;
357
+ }) | {
358
+ type: "open_helphub";
359
+ } | {
360
+ type: "open_copilot";
361
+ } | {
210
362
  type: "no_action";
211
363
  };
212
364
  }[];
@@ -214,6 +366,8 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
214
366
  bar_hide_completed_nudges_questlists: boolean;
215
367
  nudge_rate_period: "day" | "week" | "session";
216
368
  share_link_param: string;
369
+ spotlight_ask_copilot_enabled: boolean;
370
+ spotlight_ask_copilot_label: string | null;
217
371
  copilot_enabled: boolean;
218
372
  helphub_ai_enabled: boolean;
219
373
  copilot_experiences_enabled: boolean;
@@ -250,6 +404,7 @@ export declare const update: (object: {
250
404
  slash_filters_enabled?: boolean | undefined;
251
405
  recents_sort_key?: number | null | undefined;
252
406
  recommended_sort_key?: number | null | undefined;
407
+ experiences_sort_key?: number | null | undefined;
253
408
  num_live_commands?: number | undefined;
254
409
  help_center_sync?: "manual" | "upload-once" | "automatic" | undefined;
255
410
  show_suggested_synonyms?: boolean | undefined;
@@ -261,13 +416,23 @@ export declare const update: (object: {
261
416
  helphub_suggested_queries_enabled?: boolean | undefined;
262
417
  helphub_continuations_enabled?: boolean | undefined;
263
418
  helphub_manual_suggested_queries?: string[] | undefined;
419
+ copilot_name?: string | undefined;
420
+ copilot_avatar?: string | undefined;
421
+ copilot_personality?: {
422
+ template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
423
+ } | {
424
+ template: "custom";
425
+ adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
426
+ response_length: "long" | "short" | "conversational";
427
+ response_format: "mixed" | "lists" | "paragraphs";
428
+ } | undefined;
264
429
  helphub_enabled?: boolean | undefined;
265
- helphub_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
430
+ helphub_launcher_type?: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI" | undefined;
266
431
  helphub_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
267
432
  helphub_launcher_offset_x?: number | undefined;
268
433
  helphub_launcher_offset_y?: number | undefined;
269
434
  helphub_launcher_anchor?: string | undefined;
270
- helphub_mobile_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
435
+ helphub_mobile_launcher_type?: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI" | undefined;
271
436
  helphub_mobile_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
272
437
  helphub_mobile_launcher_offset_x?: number | undefined;
273
438
  helphub_mobile_launcher_offset_y?: number | undefined;
@@ -279,10 +444,15 @@ export declare const update: (object: {
279
444
  type: "execute_command";
280
445
  meta: {
281
446
  command: string;
447
+ } & {
448
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
282
449
  };
283
450
  } | {
284
451
  type: "click";
285
452
  value: string;
453
+ } | {
454
+ type: "click" | "clickBySelector" | "clickByXpath";
455
+ value: string[];
286
456
  } | ({
287
457
  type: "link";
288
458
  value: string;
@@ -291,7 +461,7 @@ export declare const update: (object: {
291
461
  }) | {
292
462
  type: "open_chat";
293
463
  meta: {
294
- type: string;
464
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
295
465
  };
296
466
  } | {
297
467
  type: "dismiss";
@@ -314,6 +484,65 @@ export declare const update: (object: {
314
484
  value?: string | undefined;
315
485
  categoryFilter?: number | undefined;
316
486
  }) | {
487
+ type: "open_helphub";
488
+ } | {
489
+ type: "open_copilot";
490
+ } | {
491
+ type: "no_action";
492
+ };
493
+ }[] | undefined;
494
+ copilot_negative_feedback_fallback_enabled?: boolean | undefined;
495
+ copilot_negative_feedback_fallback_message?: string | null | undefined;
496
+ copilot_negative_feedback_fallback_actions?: {
497
+ cta: string;
498
+ action: {
499
+ type: "execute_command";
500
+ meta: {
501
+ command: string;
502
+ } & {
503
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
504
+ };
505
+ } | {
506
+ type: "click";
507
+ value: string;
508
+ } | {
509
+ type: "click" | "clickBySelector" | "clickByXpath";
510
+ value: string[];
511
+ } | ({
512
+ type: "link";
513
+ value: string;
514
+ } & {
515
+ operation?: "self" | "router" | "blank" | undefined;
516
+ }) | {
517
+ type: "open_chat";
518
+ meta: {
519
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
520
+ };
521
+ } | {
522
+ type: "dismiss";
523
+ } | {
524
+ type: "snooze";
525
+ } | {
526
+ type: "questlist";
527
+ value: number;
528
+ } | {
529
+ type: "step_back";
530
+ } | {
531
+ type: "nudge";
532
+ value: number;
533
+ } | {
534
+ type: "go_to_step";
535
+ value: number;
536
+ } | ({
537
+ type: "open_bar";
538
+ } & {
539
+ value?: string | undefined;
540
+ categoryFilter?: number | undefined;
541
+ }) | {
542
+ type: "open_helphub";
543
+ } | {
544
+ type: "open_copilot";
545
+ } | {
317
546
  type: "no_action";
318
547
  };
319
548
  }[] | undefined;
@@ -321,6 +550,8 @@ export declare const update: (object: {
321
550
  bar_hide_completed_nudges_questlists?: boolean | undefined;
322
551
  nudge_rate_period?: "day" | "week" | "session" | undefined;
323
552
  share_link_param?: string | undefined;
553
+ spotlight_ask_copilot_enabled?: boolean | undefined;
554
+ spotlight_ask_copilot_label?: string | null | undefined;
324
555
  copilot_enabled?: boolean | undefined;
325
556
  helphub_ai_enabled?: boolean | undefined;
326
557
  copilot_experiences_enabled?: boolean | undefined;
@@ -359,6 +590,7 @@ export declare const update: (object: {
359
590
  slash_filters_enabled: boolean;
360
591
  recents_sort_key: number | null;
361
592
  recommended_sort_key: number | null;
593
+ experiences_sort_key: number | null;
362
594
  num_live_commands: number;
363
595
  help_center_sync: "manual" | "upload-once" | "automatic";
364
596
  show_suggested_synonyms: boolean;
@@ -370,13 +602,23 @@ export declare const update: (object: {
370
602
  helphub_suggested_queries_enabled: boolean;
371
603
  helphub_continuations_enabled: boolean;
372
604
  helphub_manual_suggested_queries: string[];
605
+ copilot_name: string;
606
+ copilot_avatar: string;
607
+ copilot_personality: {
608
+ template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
609
+ } | {
610
+ template: "custom";
611
+ adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
612
+ response_length: "long" | "short" | "conversational";
613
+ response_format: "mixed" | "lists" | "paragraphs";
614
+ };
373
615
  helphub_enabled: boolean;
374
- helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
616
+ helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
375
617
  helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
376
618
  helphub_launcher_offset_x: number;
377
619
  helphub_launcher_offset_y: number;
378
620
  helphub_launcher_anchor: string;
379
- helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
621
+ helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
380
622
  helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
381
623
  helphub_mobile_launcher_offset_x: number;
382
624
  helphub_mobile_launcher_offset_y: number;
@@ -388,10 +630,70 @@ export declare const update: (object: {
388
630
  type: "execute_command";
389
631
  meta: {
390
632
  command: string;
633
+ } & {
634
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
635
+ };
636
+ } | {
637
+ type: "click";
638
+ value: string;
639
+ } | {
640
+ type: "click" | "clickBySelector" | "clickByXpath";
641
+ value: string[];
642
+ } | ({
643
+ type: "link";
644
+ value: string;
645
+ } & {
646
+ operation?: "self" | "router" | "blank" | undefined;
647
+ }) | {
648
+ type: "open_chat";
649
+ meta: {
650
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
651
+ };
652
+ } | {
653
+ type: "dismiss";
654
+ } | {
655
+ type: "snooze";
656
+ } | {
657
+ type: "questlist";
658
+ value: number;
659
+ } | {
660
+ type: "step_back";
661
+ } | {
662
+ type: "nudge";
663
+ value: number;
664
+ } | {
665
+ type: "go_to_step";
666
+ value: number;
667
+ } | ({
668
+ type: "open_bar";
669
+ } & {
670
+ value?: string | undefined;
671
+ categoryFilter?: number | undefined;
672
+ }) | {
673
+ type: "open_helphub";
674
+ } | {
675
+ type: "open_copilot";
676
+ } | {
677
+ type: "no_action";
678
+ };
679
+ }[];
680
+ copilot_negative_feedback_fallback_enabled: boolean;
681
+ copilot_negative_feedback_fallback_message: string | null;
682
+ copilot_negative_feedback_fallback_actions: {
683
+ cta: string;
684
+ action: {
685
+ type: "execute_command";
686
+ meta: {
687
+ command: string;
688
+ } & {
689
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
391
690
  };
392
691
  } | {
393
692
  type: "click";
394
693
  value: string;
694
+ } | {
695
+ type: "click" | "clickBySelector" | "clickByXpath";
696
+ value: string[];
395
697
  } | ({
396
698
  type: "link";
397
699
  value: string;
@@ -400,7 +702,7 @@ export declare const update: (object: {
400
702
  }) | {
401
703
  type: "open_chat";
402
704
  meta: {
403
- type: string;
705
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
404
706
  };
405
707
  } | {
406
708
  type: "dismiss";
@@ -423,6 +725,10 @@ export declare const update: (object: {
423
725
  value?: string | undefined;
424
726
  categoryFilter?: number | undefined;
425
727
  }) | {
728
+ type: "open_helphub";
729
+ } | {
730
+ type: "open_copilot";
731
+ } | {
426
732
  type: "no_action";
427
733
  };
428
734
  }[];
@@ -430,6 +736,8 @@ export declare const update: (object: {
430
736
  bar_hide_completed_nudges_questlists: boolean;
431
737
  nudge_rate_period: "day" | "week" | "session";
432
738
  share_link_param: string;
739
+ spotlight_ask_copilot_enabled: boolean;
740
+ spotlight_ask_copilot_label: string | null;
433
741
  copilot_enabled: boolean;
434
742
  helphub_ai_enabled: boolean;
435
743
  copilot_experiences_enabled: boolean;
@@ -2,10 +2,12 @@ import * as t from 'io-ts';
2
2
  export declare const ProfileV: t.TypeC<{
3
3
  user: t.StringC;
4
4
  organization: t.StringC;
5
+ is_active: t.BooleanC;
5
6
  }>;
6
7
  export declare class Profile {
7
8
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
8
9
  user: string;
9
10
  organization: string;
11
+ is_active: boolean;
10
12
  }[]>;
11
13
  }