commandbar 1.8.6 → 1.9.0
Sign up to get free protection for your applications and to get access to all the features.
- package/build/commandbar-js/src/index.js +1 -1
- package/build/internal/src/client/AddContextOptions.d.ts +4 -0
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
- package/build/internal/src/client/CommandBarClientSDK.d.ts +25 -7
- package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
- package/build/internal/src/client/CommandBarSDK.d.ts +23 -12
- package/build/internal/src/client/EventHandler.d.ts +19 -5
- package/build/internal/src/client/globals.d.ts +6 -0
- package/build/internal/src/client/symbols.d.ts +11 -6
- package/build/internal/src/middleware/CommandFromClientV.d.ts +68 -10
- package/build/internal/src/middleware/OrganizationV.d.ts +124 -20
- package/build/internal/src/middleware/additionalResource.d.ts +178 -16
- package/build/internal/src/middleware/billing.d.ts +33 -0
- package/build/internal/src/middleware/chat.d.ts +10913 -0
- package/build/internal/src/middleware/checklist.d.ts +106 -28
- package/build/internal/src/middleware/command.d.ts +3778 -446
- package/build/internal/src/middleware/detailPreview.d.ts +12 -1
- package/build/internal/src/middleware/endUser.d.ts +104 -0
- package/build/internal/src/middleware/generics.d.ts +12 -11
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +54 -8
- package/build/internal/src/middleware/helpDocsSearch.d.ts +2204 -0
- package/build/internal/src/middleware/helpHub.d.ts +26 -0
- package/build/internal/src/middleware/helpers/actions.d.ts +116 -8
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +82 -2
- package/build/internal/src/middleware/helpers/pushTrigger.d.ts +6 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +285 -26
- package/build/internal/src/middleware/network.d.ts +18 -3
- package/build/internal/src/middleware/nudge.d.ts +1193 -43
- package/build/internal/src/middleware/organization.d.ts +1051 -141
- package/build/internal/src/middleware/organizationSettings.d.ts +129 -22
- package/build/internal/src/middleware/recommendationSet.d.ts +408 -1007
- package/build/internal/src/middleware/types.d.ts +43 -25
- package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -1
- package/build/internal/src/util/operatingSystem.d.ts +13 -0
- package/build/internal/src/util/sentry.d.ts +23 -0
- package/package.json +4 -4
- package/build/internal/src/client/SentryReporter.d.ts +0 -63
- package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
- package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
- package/build/internal/src/middleware/qaPair.d.ts +0 -676
- package/build/internal/src/util/integrations.d.ts +0 -1
- package/src/commandbar-launcher.d.ts +0 -7
@@ -36,19 +36,22 @@ export declare const OrganizationSettingsV: t.TypeC<{
|
|
36
36
|
bar_enabled: t.BooleanC;
|
37
37
|
in_bar_doc_search: t.BooleanC;
|
38
38
|
featured_item_cards: t.BooleanC;
|
39
|
-
helphub_ai_enabled: t.BooleanC;
|
40
39
|
chat_system_prompt_modifier: t.StringC;
|
41
40
|
helphub_chat_welcome_message: t.StringC;
|
42
41
|
helphub_suggested_queries_enabled: t.BooleanC;
|
43
42
|
helphub_continuations_enabled: t.BooleanC;
|
44
43
|
helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
|
45
|
-
helphub_chat_only_mode: t.BooleanC;
|
46
44
|
helphub_enabled: t.BooleanC;
|
47
|
-
helphub_launcher_type: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
|
45
|
+
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">]>;
|
48
46
|
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
49
47
|
helphub_launcher_offset_x: t.NumberC;
|
50
48
|
helphub_launcher_offset_y: t.NumberC;
|
51
49
|
helphub_launcher_anchor: t.StringC;
|
50
|
+
helphub_mobile_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">]>;
|
51
|
+
helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
52
|
+
helphub_mobile_launcher_offset_x: t.NumberC;
|
53
|
+
helphub_mobile_launcher_offset_y: t.NumberC;
|
54
|
+
helphub_mobile_launcher_anchor: t.StringC;
|
52
55
|
helphub_chat_fallback_message: t.StringC;
|
53
56
|
helphub_chat_fallback_actions: t.ArrayC<t.TypeC<{
|
54
57
|
cta: t.StringC;
|
@@ -74,11 +77,37 @@ export declare const OrganizationSettingsV: t.TypeC<{
|
|
74
77
|
}>;
|
75
78
|
}>, t.TypeC<{
|
76
79
|
type: t.LiteralC<"dismiss">;
|
77
|
-
}
|
80
|
+
}>, t.TypeC<{
|
81
|
+
type: t.LiteralC<"snooze">;
|
82
|
+
}>, t.TypeC<{
|
83
|
+
type: t.LiteralC<"questlist">;
|
84
|
+
value: t.NumberC;
|
85
|
+
}>, t.TypeC<{
|
86
|
+
type: t.LiteralC<"nudge">;
|
87
|
+
value: t.NumberC;
|
88
|
+
}>, t.TypeC<{
|
89
|
+
type: t.LiteralC<"go_to_step">;
|
90
|
+
value: t.NumberC;
|
91
|
+
}>, t.TypeC<{
|
92
|
+
type: t.LiteralC<"step_back">;
|
93
|
+
}>, t.IntersectionC<[t.TypeC<{
|
94
|
+
type: t.LiteralC<"open_bar">;
|
95
|
+
}>, t.PartialC<{
|
96
|
+
value: t.StringC;
|
97
|
+
categoryFilter: t.NumberC;
|
98
|
+
}>]>]>;
|
78
99
|
}>>;
|
79
100
|
nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
|
80
101
|
bar_hide_completed_nudges_questlists: t.BooleanC;
|
81
102
|
nudge_rate_period: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"session">]>;
|
103
|
+
share_link_param: t.StringC;
|
104
|
+
copilot_enabled: t.BooleanC;
|
105
|
+
/** @deprecated Replaced by the `copilot_enabled` field */
|
106
|
+
helphub_ai_enabled: t.BooleanC;
|
107
|
+
/** @deprecated Removed entirely */
|
108
|
+
copilot_experiences_enabled: t.BooleanC;
|
109
|
+
/** @deprecated Replaced by the combination of `copilot_enabled` and `helphub_enabled` */
|
110
|
+
helphub_chat_only_mode: t.BooleanC;
|
82
111
|
}>;
|
83
112
|
export declare const read: (params?: Record<string, string> | undefined, callbacks?: {
|
84
113
|
onSuccess?: (() => void) | undefined;
|
@@ -120,19 +149,22 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
|
|
120
149
|
bar_enabled: boolean;
|
121
150
|
in_bar_doc_search: boolean;
|
122
151
|
featured_item_cards: boolean;
|
123
|
-
helphub_ai_enabled: boolean;
|
124
152
|
chat_system_prompt_modifier: string;
|
125
153
|
helphub_chat_welcome_message: string;
|
126
154
|
helphub_suggested_queries_enabled: boolean;
|
127
155
|
helphub_continuations_enabled: boolean;
|
128
156
|
helphub_manual_suggested_queries: string[];
|
129
|
-
helphub_chat_only_mode: boolean;
|
130
157
|
helphub_enabled: boolean;
|
131
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
132
|
-
helphub_launcher_position: "
|
158
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
159
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
133
160
|
helphub_launcher_offset_x: number;
|
134
161
|
helphub_launcher_offset_y: number;
|
135
162
|
helphub_launcher_anchor: string;
|
163
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
164
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
165
|
+
helphub_mobile_launcher_offset_x: number;
|
166
|
+
helphub_mobile_launcher_offset_y: number;
|
167
|
+
helphub_mobile_launcher_anchor: string;
|
136
168
|
helphub_chat_fallback_message: string;
|
137
169
|
helphub_chat_fallback_actions: {
|
138
170
|
cta: string;
|
@@ -141,8 +173,6 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
|
|
141
173
|
meta: {
|
142
174
|
command: string;
|
143
175
|
};
|
144
|
-
} | {
|
145
|
-
type: "no_action";
|
146
176
|
} | {
|
147
177
|
type: "click";
|
148
178
|
value: string;
|
@@ -158,11 +188,36 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
|
|
158
188
|
};
|
159
189
|
} | {
|
160
190
|
type: "dismiss";
|
191
|
+
} | {
|
192
|
+
type: "snooze";
|
193
|
+
} | {
|
194
|
+
type: "questlist";
|
195
|
+
value: number;
|
196
|
+
} | {
|
197
|
+
type: "step_back";
|
198
|
+
} | {
|
199
|
+
type: "nudge";
|
200
|
+
value: number;
|
201
|
+
} | {
|
202
|
+
type: "go_to_step";
|
203
|
+
value: number;
|
204
|
+
} | ({
|
205
|
+
type: "open_bar";
|
206
|
+
} & {
|
207
|
+
value?: string | undefined;
|
208
|
+
categoryFilter?: number | undefined;
|
209
|
+
}) | {
|
210
|
+
type: "no_action";
|
161
211
|
};
|
162
212
|
}[];
|
163
213
|
nudge_rate_limit: number | null;
|
164
214
|
bar_hide_completed_nudges_questlists: boolean;
|
165
215
|
nudge_rate_period: "day" | "week" | "session";
|
216
|
+
share_link_param: string;
|
217
|
+
copilot_enabled: boolean;
|
218
|
+
helphub_ai_enabled: boolean;
|
219
|
+
copilot_experiences_enabled: boolean;
|
220
|
+
helphub_chat_only_mode: boolean;
|
166
221
|
}>;
|
167
222
|
export declare const update: (object: {
|
168
223
|
end_user_limit?: number | undefined;
|
@@ -201,19 +256,22 @@ export declare const update: (object: {
|
|
201
256
|
bar_enabled?: boolean | undefined;
|
202
257
|
in_bar_doc_search?: boolean | undefined;
|
203
258
|
featured_item_cards?: boolean | undefined;
|
204
|
-
helphub_ai_enabled?: boolean | undefined;
|
205
259
|
chat_system_prompt_modifier?: string | undefined;
|
206
260
|
helphub_chat_welcome_message?: string | undefined;
|
207
261
|
helphub_suggested_queries_enabled?: boolean | undefined;
|
208
262
|
helphub_continuations_enabled?: boolean | undefined;
|
209
263
|
helphub_manual_suggested_queries?: string[] | undefined;
|
210
|
-
helphub_chat_only_mode?: boolean | undefined;
|
211
264
|
helphub_enabled?: boolean | undefined;
|
212
|
-
helphub_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | undefined;
|
213
|
-
helphub_launcher_position?: "
|
265
|
+
helphub_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
|
266
|
+
helphub_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
|
214
267
|
helphub_launcher_offset_x?: number | undefined;
|
215
268
|
helphub_launcher_offset_y?: number | undefined;
|
216
269
|
helphub_launcher_anchor?: string | undefined;
|
270
|
+
helphub_mobile_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
|
271
|
+
helphub_mobile_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
|
272
|
+
helphub_mobile_launcher_offset_x?: number | undefined;
|
273
|
+
helphub_mobile_launcher_offset_y?: number | undefined;
|
274
|
+
helphub_mobile_launcher_anchor?: string | undefined;
|
217
275
|
helphub_chat_fallback_message?: string | undefined;
|
218
276
|
helphub_chat_fallback_actions?: {
|
219
277
|
cta: string;
|
@@ -222,8 +280,6 @@ export declare const update: (object: {
|
|
222
280
|
meta: {
|
223
281
|
command: string;
|
224
282
|
};
|
225
|
-
} | {
|
226
|
-
type: "no_action";
|
227
283
|
} | {
|
228
284
|
type: "click";
|
229
285
|
value: string;
|
@@ -239,11 +295,36 @@ export declare const update: (object: {
|
|
239
295
|
};
|
240
296
|
} | {
|
241
297
|
type: "dismiss";
|
298
|
+
} | {
|
299
|
+
type: "snooze";
|
300
|
+
} | {
|
301
|
+
type: "questlist";
|
302
|
+
value: number;
|
303
|
+
} | {
|
304
|
+
type: "step_back";
|
305
|
+
} | {
|
306
|
+
type: "nudge";
|
307
|
+
value: number;
|
308
|
+
} | {
|
309
|
+
type: "go_to_step";
|
310
|
+
value: number;
|
311
|
+
} | ({
|
312
|
+
type: "open_bar";
|
313
|
+
} & {
|
314
|
+
value?: string | undefined;
|
315
|
+
categoryFilter?: number | undefined;
|
316
|
+
}) | {
|
317
|
+
type: "no_action";
|
242
318
|
};
|
243
319
|
}[] | undefined;
|
244
320
|
nudge_rate_limit?: number | null | undefined;
|
245
321
|
bar_hide_completed_nudges_questlists?: boolean | undefined;
|
246
322
|
nudge_rate_period?: "day" | "week" | "session" | undefined;
|
323
|
+
share_link_param?: string | undefined;
|
324
|
+
copilot_enabled?: boolean | undefined;
|
325
|
+
helphub_ai_enabled?: boolean | undefined;
|
326
|
+
copilot_experiences_enabled?: boolean | undefined;
|
327
|
+
helphub_chat_only_mode?: boolean | undefined;
|
247
328
|
}, params?: Record<string, string> | undefined, callbacks?: {
|
248
329
|
onSuccess?: (() => void) | undefined;
|
249
330
|
onError?: ((err: string) => void) | undefined;
|
@@ -284,19 +365,22 @@ export declare const update: (object: {
|
|
284
365
|
bar_enabled: boolean;
|
285
366
|
in_bar_doc_search: boolean;
|
286
367
|
featured_item_cards: boolean;
|
287
|
-
helphub_ai_enabled: boolean;
|
288
368
|
chat_system_prompt_modifier: string;
|
289
369
|
helphub_chat_welcome_message: string;
|
290
370
|
helphub_suggested_queries_enabled: boolean;
|
291
371
|
helphub_continuations_enabled: boolean;
|
292
372
|
helphub_manual_suggested_queries: string[];
|
293
|
-
helphub_chat_only_mode: boolean;
|
294
373
|
helphub_enabled: boolean;
|
295
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
296
|
-
helphub_launcher_position: "
|
374
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
375
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
297
376
|
helphub_launcher_offset_x: number;
|
298
377
|
helphub_launcher_offset_y: number;
|
299
378
|
helphub_launcher_anchor: string;
|
379
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
380
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
381
|
+
helphub_mobile_launcher_offset_x: number;
|
382
|
+
helphub_mobile_launcher_offset_y: number;
|
383
|
+
helphub_mobile_launcher_anchor: string;
|
300
384
|
helphub_chat_fallback_message: string;
|
301
385
|
helphub_chat_fallback_actions: {
|
302
386
|
cta: string;
|
@@ -305,8 +389,6 @@ export declare const update: (object: {
|
|
305
389
|
meta: {
|
306
390
|
command: string;
|
307
391
|
};
|
308
|
-
} | {
|
309
|
-
type: "no_action";
|
310
392
|
} | {
|
311
393
|
type: "click";
|
312
394
|
value: string;
|
@@ -322,9 +404,34 @@ export declare const update: (object: {
|
|
322
404
|
};
|
323
405
|
} | {
|
324
406
|
type: "dismiss";
|
407
|
+
} | {
|
408
|
+
type: "snooze";
|
409
|
+
} | {
|
410
|
+
type: "questlist";
|
411
|
+
value: number;
|
412
|
+
} | {
|
413
|
+
type: "step_back";
|
414
|
+
} | {
|
415
|
+
type: "nudge";
|
416
|
+
value: number;
|
417
|
+
} | {
|
418
|
+
type: "go_to_step";
|
419
|
+
value: number;
|
420
|
+
} | ({
|
421
|
+
type: "open_bar";
|
422
|
+
} & {
|
423
|
+
value?: string | undefined;
|
424
|
+
categoryFilter?: number | undefined;
|
425
|
+
}) | {
|
426
|
+
type: "no_action";
|
325
427
|
};
|
326
428
|
}[];
|
327
429
|
nudge_rate_limit: number | null;
|
328
430
|
bar_hide_completed_nudges_questlists: boolean;
|
329
431
|
nudge_rate_period: "day" | "week" | "session";
|
432
|
+
share_link_param: string;
|
433
|
+
copilot_enabled: boolean;
|
434
|
+
helphub_ai_enabled: boolean;
|
435
|
+
copilot_experiences_enabled: boolean;
|
436
|
+
helphub_chat_only_mode: boolean;
|
330
437
|
}>;
|