commandbar 1.9.0 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
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 +15 -10
  8. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  9. package/build/internal/src/client/symbols.d.ts +3 -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 +9 -0
  33. package/build/internal/src/middleware/nudge.d.ts +1103 -124
  34. package/build/internal/src/middleware/organization.d.ts +1295 -68
  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 +425 -0
  40. package/build/internal/src/middleware/types.d.ts +51 -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 +11 -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
@@ -0,0 +1,425 @@
1
+ import * as t from 'io-ts';
2
+ export declare const ThemeV2V: t.UnionC<[t.TypeC<{
3
+ light_mode: t.TypeC<{
4
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
5
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
6
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
7
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
8
+ }>;
9
+ dark_mode: t.TypeC<{
10
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
11
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
12
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
13
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
14
+ }>;
15
+ }>, t.NullC, t.UndefinedC]>;
16
+ export declare const ThemeV: t.TypeC<{
17
+ id: t.StringC;
18
+ slug: t.StringC;
19
+ name: t.StringC;
20
+ default: t.BooleanC;
21
+ themeV2: t.UnionC<[t.TypeC<{
22
+ light_mode: t.TypeC<{
23
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
24
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
25
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
26
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
27
+ }>;
28
+ dark_mode: t.TypeC<{
29
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
30
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
31
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
32
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
33
+ }>;
34
+ }>, t.NullC, t.UndefinedC]>;
35
+ themeV2_draft: t.UnionC<[t.TypeC<{
36
+ light_mode: t.TypeC<{
37
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
38
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
39
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
40
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
41
+ }>;
42
+ dark_mode: t.TypeC<{
43
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
44
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
45
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
46
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
47
+ }>;
48
+ }>, t.NullC, t.UndefinedC]>;
49
+ organization: t.StringC;
50
+ }>;
51
+ export declare const ThemePatchV: t.PartialC<{
52
+ id: t.StringC;
53
+ slug: t.StringC;
54
+ name: t.StringC;
55
+ default: t.BooleanC;
56
+ themeV2: t.UnionC<[t.TypeC<{
57
+ light_mode: t.TypeC<{
58
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
59
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
60
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
61
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
62
+ }>;
63
+ dark_mode: t.TypeC<{
64
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
65
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
66
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
67
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
68
+ }>;
69
+ }>, t.NullC, t.UndefinedC]>;
70
+ themeV2_draft: t.UnionC<[t.TypeC<{
71
+ light_mode: t.TypeC<{
72
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
73
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
74
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
75
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
76
+ }>;
77
+ dark_mode: t.TypeC<{
78
+ var_defaults: t.RecordC<t.StringC, t.StringC>;
79
+ var_overrides: t.RecordC<t.StringC, t.StringC>;
80
+ component_overrides: t.RecordC<t.StringC, t.AnyC>;
81
+ mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
82
+ }>;
83
+ }>, t.NullC, t.UndefinedC]>;
84
+ organization: t.StringC;
85
+ }>;
86
+ export declare class Theme {
87
+ static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
88
+ id: string;
89
+ slug: string;
90
+ name: string;
91
+ default: boolean;
92
+ themeV2: {
93
+ light_mode: {
94
+ var_defaults: {
95
+ [x: string]: string;
96
+ };
97
+ var_overrides: {
98
+ [x: string]: string;
99
+ };
100
+ component_overrides: {
101
+ [x: string]: any;
102
+ };
103
+ mobile_overrides: {
104
+ [x: string]: any;
105
+ };
106
+ };
107
+ dark_mode: {
108
+ var_defaults: {
109
+ [x: string]: string;
110
+ };
111
+ var_overrides: {
112
+ [x: string]: string;
113
+ };
114
+ component_overrides: {
115
+ [x: string]: any;
116
+ };
117
+ mobile_overrides: {
118
+ [x: string]: any;
119
+ };
120
+ };
121
+ } | null | undefined;
122
+ themeV2_draft: {
123
+ light_mode: {
124
+ var_defaults: {
125
+ [x: string]: string;
126
+ };
127
+ var_overrides: {
128
+ [x: string]: string;
129
+ };
130
+ component_overrides: {
131
+ [x: string]: any;
132
+ };
133
+ mobile_overrides: {
134
+ [x: string]: any;
135
+ };
136
+ };
137
+ dark_mode: {
138
+ var_defaults: {
139
+ [x: string]: string;
140
+ };
141
+ var_overrides: {
142
+ [x: string]: string;
143
+ };
144
+ component_overrides: {
145
+ [x: string]: any;
146
+ };
147
+ mobile_overrides: {
148
+ [x: string]: any;
149
+ };
150
+ };
151
+ } | null | undefined;
152
+ organization: string;
153
+ }[]>;
154
+ static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
155
+ onSuccess?: (() => void) | undefined;
156
+ onError?: ((err: string) => void) | undefined;
157
+ } | undefined) => Promise<{
158
+ id: string;
159
+ slug: string;
160
+ name: string;
161
+ default: boolean;
162
+ themeV2: {
163
+ light_mode: {
164
+ var_defaults: {
165
+ [x: string]: string;
166
+ };
167
+ var_overrides: {
168
+ [x: string]: string;
169
+ };
170
+ component_overrides: {
171
+ [x: string]: any;
172
+ };
173
+ mobile_overrides: {
174
+ [x: string]: any;
175
+ };
176
+ };
177
+ dark_mode: {
178
+ var_defaults: {
179
+ [x: string]: string;
180
+ };
181
+ var_overrides: {
182
+ [x: string]: string;
183
+ };
184
+ component_overrides: {
185
+ [x: string]: any;
186
+ };
187
+ mobile_overrides: {
188
+ [x: string]: any;
189
+ };
190
+ };
191
+ } | null | undefined;
192
+ themeV2_draft: {
193
+ light_mode: {
194
+ var_defaults: {
195
+ [x: string]: string;
196
+ };
197
+ var_overrides: {
198
+ [x: string]: string;
199
+ };
200
+ component_overrides: {
201
+ [x: string]: any;
202
+ };
203
+ mobile_overrides: {
204
+ [x: string]: any;
205
+ };
206
+ };
207
+ dark_mode: {
208
+ var_defaults: {
209
+ [x: string]: string;
210
+ };
211
+ var_overrides: {
212
+ [x: string]: string;
213
+ };
214
+ component_overrides: {
215
+ [x: string]: any;
216
+ };
217
+ mobile_overrides: {
218
+ [x: string]: any;
219
+ };
220
+ };
221
+ } | null | undefined;
222
+ organization: string;
223
+ }>;
224
+ static update: (theme: t.TypeOf<typeof ThemePatchV>) => Promise<{
225
+ id: string;
226
+ slug: string;
227
+ name: string;
228
+ default: boolean;
229
+ themeV2: {
230
+ light_mode: {
231
+ var_defaults: {
232
+ [x: string]: string;
233
+ };
234
+ var_overrides: {
235
+ [x: string]: string;
236
+ };
237
+ component_overrides: {
238
+ [x: string]: any;
239
+ };
240
+ mobile_overrides: {
241
+ [x: string]: any;
242
+ };
243
+ };
244
+ dark_mode: {
245
+ var_defaults: {
246
+ [x: string]: string;
247
+ };
248
+ var_overrides: {
249
+ [x: string]: string;
250
+ };
251
+ component_overrides: {
252
+ [x: string]: any;
253
+ };
254
+ mobile_overrides: {
255
+ [x: string]: any;
256
+ };
257
+ };
258
+ } | null | undefined;
259
+ themeV2_draft: {
260
+ light_mode: {
261
+ var_defaults: {
262
+ [x: string]: string;
263
+ };
264
+ var_overrides: {
265
+ [x: string]: string;
266
+ };
267
+ component_overrides: {
268
+ [x: string]: any;
269
+ };
270
+ mobile_overrides: {
271
+ [x: string]: any;
272
+ };
273
+ };
274
+ dark_mode: {
275
+ var_defaults: {
276
+ [x: string]: string;
277
+ };
278
+ var_overrides: {
279
+ [x: string]: string;
280
+ };
281
+ component_overrides: {
282
+ [x: string]: any;
283
+ };
284
+ mobile_overrides: {
285
+ [x: string]: any;
286
+ };
287
+ };
288
+ } | null | undefined;
289
+ organization: string;
290
+ }>;
291
+ static create: (object: {
292
+ id?: string | undefined;
293
+ slug?: string | undefined;
294
+ name?: string | undefined;
295
+ default?: boolean | undefined;
296
+ themeV2?: {
297
+ light_mode: {
298
+ var_defaults: {
299
+ [x: string]: string;
300
+ };
301
+ var_overrides: {
302
+ [x: string]: string;
303
+ };
304
+ component_overrides: {
305
+ [x: string]: any;
306
+ };
307
+ mobile_overrides: {
308
+ [x: string]: any;
309
+ };
310
+ };
311
+ dark_mode: {
312
+ var_defaults: {
313
+ [x: string]: string;
314
+ };
315
+ var_overrides: {
316
+ [x: string]: string;
317
+ };
318
+ component_overrides: {
319
+ [x: string]: any;
320
+ };
321
+ mobile_overrides: {
322
+ [x: string]: any;
323
+ };
324
+ };
325
+ } | null | undefined;
326
+ themeV2_draft?: {
327
+ light_mode: {
328
+ var_defaults: {
329
+ [x: string]: string;
330
+ };
331
+ var_overrides: {
332
+ [x: string]: string;
333
+ };
334
+ component_overrides: {
335
+ [x: string]: any;
336
+ };
337
+ mobile_overrides: {
338
+ [x: string]: any;
339
+ };
340
+ };
341
+ dark_mode: {
342
+ var_defaults: {
343
+ [x: string]: string;
344
+ };
345
+ var_overrides: {
346
+ [x: string]: string;
347
+ };
348
+ component_overrides: {
349
+ [x: string]: any;
350
+ };
351
+ mobile_overrides: {
352
+ [x: string]: any;
353
+ };
354
+ };
355
+ } | null | undefined;
356
+ organization?: string | undefined;
357
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
358
+ id: string;
359
+ slug: string;
360
+ name: string;
361
+ default: boolean;
362
+ themeV2: {
363
+ light_mode: {
364
+ var_defaults: {
365
+ [x: string]: string;
366
+ };
367
+ var_overrides: {
368
+ [x: string]: string;
369
+ };
370
+ component_overrides: {
371
+ [x: string]: any;
372
+ };
373
+ mobile_overrides: {
374
+ [x: string]: any;
375
+ };
376
+ };
377
+ dark_mode: {
378
+ var_defaults: {
379
+ [x: string]: string;
380
+ };
381
+ var_overrides: {
382
+ [x: string]: string;
383
+ };
384
+ component_overrides: {
385
+ [x: string]: any;
386
+ };
387
+ mobile_overrides: {
388
+ [x: string]: any;
389
+ };
390
+ };
391
+ } | null | undefined;
392
+ themeV2_draft: {
393
+ light_mode: {
394
+ var_defaults: {
395
+ [x: string]: string;
396
+ };
397
+ var_overrides: {
398
+ [x: string]: string;
399
+ };
400
+ component_overrides: {
401
+ [x: string]: any;
402
+ };
403
+ mobile_overrides: {
404
+ [x: string]: any;
405
+ };
406
+ };
407
+ dark_mode: {
408
+ var_defaults: {
409
+ [x: string]: string;
410
+ };
411
+ var_overrides: {
412
+ [x: string]: string;
413
+ };
414
+ component_overrides: {
415
+ [x: string]: any;
416
+ };
417
+ mobile_overrides: {
418
+ [x: string]: any;
419
+ };
420
+ };
421
+ } | null | undefined;
422
+ organization: string;
423
+ }>;
424
+ static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
425
+ }
@@ -1,13 +1,13 @@
1
1
  /*******************************************************************************/
2
2
  import * as t from 'io-ts';
3
- import { BatchEditorCommandResponseV, BatchOperationV, CommandV, HelpSyncCommandV, EditorCommandV, EditorCommandLiteV, CommandLiteV } from './command';
3
+ import { BatchEditorCommandResponseV, BatchOperationV, CommandV, EditorCommandV, EditorCommandLiteV, CommandLiteV, ContentTypeV } from './command';
4
4
  import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV } from './helpers/argument';
5
5
  import { GenericBatchRequest } from './generics';
6
6
  import { OptionGroupRenderAsV } from './helpers/optionGroup';
7
- import { TemplateV, TemplateOptionsV, RequestTemplateV } from './helpers/commandTemplate';
8
- import { ActionV, CommandActionV, LabeledActionV, OpenChatActionV, NudgeActionV, QuestlistActionV, RequestV } from './helpers/actions';
7
+ import { TemplateV, TemplateOptionsV, RequestTemplateV, VideoTemplateV } from './helpers/commandTemplate';
8
+ import { ActionV, CommandActionV, LabeledActionV, OpenChatActionV, NudgeActionV, QuestlistActionV, RequestV, OpenChatActionTypeV, CommandActionMetaTypeV } from './helpers/actions';
9
9
  import { CommandCategoryV } from './commandCategory';
10
- import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationV } from './organization';
10
+ import { OrganizationStatusV, KeyEventV, RecordSettingsByContextKeyV, InternalSettingsV, OrganizationV } from './organization';
11
11
  import { OrganizationSettingsV } from './organizationSettings';
12
12
  import { UserV } from './user';
13
13
  import { ContextV } from './context';
@@ -15,8 +15,9 @@ import { GuideV } from './guide';
15
15
  import { HistoryEventV } from './historyEvent';
16
16
  import { HelpDocSyncLogMessageV, HelpDocsSyncV } from './helpDocsSync';
17
17
  import { HelpDocsIntegrationV } from './helpDocsIntegration';
18
- import { EndUserStoreDataV, EndUserV, NudgeInteractionStateV, NudgeInteractionsV, QuestlistInteractionStateV, QuestlistInteractionsV, DecideResponseV } from './endUser';
18
+ import { EndUserStoreDataV, EndUserV, NudgeInteractionStateV, NudgeInteractionsV, ChecklistInteractionStateV, ChecklistInteractionsV, DecideResponseV } from './endUser';
19
19
  import { SkinV } from './skin';
20
+ import { ThemeV, ThemeV2V } from './theme';
20
21
  import { ProfileV } from './profile';
21
22
  import { PlaceholderV } from './placeholder';
22
23
  import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
@@ -25,25 +26,30 @@ import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV
25
26
  import { TabV } from './tab';
26
27
  import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
27
28
  import { ChecklistItemV, ChecklistV } from './checklist';
28
- import { DashboardFlagsV } from './dashboardFlags';
29
29
  import { PushTriggerV } from './helpers/pushTrigger';
30
30
  import { FrequencyLimitV } from './helpers/frequencyLimit';
31
31
  import { AudienceV } from './helpers/audience';
32
32
  import { AdditionalResourceV } from './additionalResource';
33
33
  import { RecommendationSetV } from './recommendationSet';
34
34
  import { BillingProfileV, UsageV } from './billing';
35
- import { UserMessageV, AIMessageV, MessageV, AIAnswerPayloadV, AIAnswerV, ContinuationsPayloadV, ContinuationV, CreateAnswerFeedbackPayloadV, QuestionSuggestionsPayloadV, QuestionSuggestionsV, ExperienceV, CreateChatPayloadV } from './chat';
35
+ import { UserMessageV, AIMessageV, MessageV, AIAnswerPayloadV, AIAnswerV, ContinuationsPayloadV, ContinuationV, CreateAnswerFeedbackPayloadV, QuestionSuggestionsPayloadV, QuestionSuggestionsV, ExperienceV, CreateChatPayloadV, ChatV, CopilotSettingsPreviewV } from './chat';
36
36
  import { HelpDocHitV, SearchHelpDocsPayloadV, SearchHelpDocsResponseV } from './helpDocsSearch';
37
+ import { ExperienceHitV, ExperienceTypeOptions, SearchExperiencesPayloadV, SearchExperiencesResponseV } from './experiencesSearch';
37
38
  import { HelpHubLauncherSettingsV } from './helpHub';
39
+ import { EntityChangeV } from './entityChanges';
40
+ import { Flags } from './flags';
41
+ import { CopilotPersonalityAdjectiveV, CopilotPersonalityResponseFormatV, CopilotPersonalityResponseLengthV, CopilotPersonalityV } from './helpers/copilotPersonality';
42
+ import { ExperienceTemplateV } from './experienceTemplate';
38
43
  /*******************************************************************************/
39
44
  export type IInitOptions = {
40
45
  debug?: boolean;
41
46
  environment?: string;
42
47
  version?: string;
43
- config?: IConfigEndpointResponse;
48
+ config?: any;
49
+ nonce?: string;
44
50
  };
45
51
  /** Additional foobar init options */
46
- export declare const SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS: readonly ["labs", "prod"];
52
+ export declare const SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS: readonly ["dev", "labs", "prod"];
47
53
  export type IInitOptionsFoobar = IInitOptions & {
48
54
  deployment?: (typeof SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS)[number];
49
55
  disable_analytics?: boolean;
@@ -55,13 +61,13 @@ export type ICommandType = t.TypeOf<typeof CommandV> & unknown;
55
61
  export type IEditorCommandType = t.TypeOf<typeof EditorCommandV> & unknown;
56
62
  export type IEditorCommandTypeLite = t.TypeOf<typeof EditorCommandLiteV> & unknown;
57
63
  export type ICommandTypeLite = t.TypeOf<typeof CommandLiteV> & unknown;
58
- export type IHelpSyncCommandType = t.TypeOf<typeof HelpSyncCommandV> & unknown;
59
64
  export type { ICommandFromClientType } from './ICommandFromClientType';
60
65
  export type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV> & unknown;
61
66
  export type IGuideType = t.TypeOf<typeof GuideV> & {
62
67
  preview?: boolean;
63
68
  } & unknown;
64
69
  export type IHistoryEventType = t.TypeOf<typeof HistoryEventV> & unknown;
70
+ export type IEntityChangeType = t.TypeOf<typeof EntityChangeV> & unknown;
65
71
  export type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV> & unknown;
66
72
  export type IHelpDocsSyncLogMessageType = t.TypeOf<typeof HelpDocSyncLogMessageV> & unknown;
67
73
  export type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrationV> & unknown;
@@ -69,13 +75,15 @@ export type IHelpHubLauncherSettingsType = t.TypeOf<typeof HelpHubLauncherSettin
69
75
  export type IOrganizationType = t.TypeOf<typeof OrganizationV> & unknown;
70
76
  export type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV> & unknown;
71
77
  export type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV> & unknown;
72
- export type IDashboardFlagsType = t.TypeOf<typeof DashboardFlagsV> & unknown;
73
78
  export type ISkinType = t.TypeOf<typeof SkinV> & unknown;
79
+ export type IThemeType = t.TypeOf<typeof ThemeV> & unknown;
80
+ export type IThemeV2Type = t.TypeOf<typeof ThemeV2V> & unknown;
74
81
  export type IProfileType = t.TypeOf<typeof ProfileV> & unknown;
75
82
  export type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV> & unknown;
76
83
  export type IPlaceholderType = t.TypeOf<typeof PlaceholderV> & unknown;
77
84
  export type ITabType = t.TypeOf<typeof TabV> & unknown;
78
85
  export type IEnvironmentType = t.TypeOf<typeof EnvironmentV> & unknown;
86
+ export type IChatType = t.TypeOf<typeof ChatV> & unknown;
79
87
  export type IReleaseStep = t.TypeOf<typeof ReleaseStepV> & unknown;
80
88
  export type IRelease = t.TypeOf<typeof ReleaseV> & unknown;
81
89
  export type IEnvReleaseInfo = t.TypeOf<typeof EnvReleaseInfoV> & unknown;
@@ -91,6 +99,7 @@ export type IArgumentMap = t.TypeOf<typeof ArgumentMapV> & unknown;
91
99
  export type IArgumentType = t.TypeOf<typeof ArgumentTypeV> & unknown;
92
100
  export type IStepArgumentType = t.TypeOf<typeof StepArgumentTypeV> & unknown;
93
101
  export type ITemplate = t.TypeOf<typeof TemplateV> & unknown;
102
+ export type IVideoTemplate = t.TypeOf<typeof VideoTemplateV> & unknown;
94
103
  export type RequestTemplateType = t.TypeOf<typeof RequestTemplateV> & unknown;
95
104
  export type RequestType = t.TypeOf<typeof RequestV> & unknown;
96
105
  export type ITemplateOptions = t.TypeOf<typeof TemplateOptionsV> & unknown;
@@ -109,6 +118,11 @@ export type IAudienceType = t.TypeOf<typeof AudienceV> & unknown;
109
118
  export type IPushTrigger = t.TypeOf<typeof PushTriggerV> & unknown;
110
119
  export type IFrequencyLimit = t.TypeOf<typeof FrequencyLimitV> & unknown;
111
120
  export type INudgeStepType = t.TypeOf<typeof NudgeStepV> & unknown;
121
+ export type INudgeTooltipStepType = INudgeStepType & {
122
+ form_factor: {
123
+ type: 'tooltip';
124
+ };
125
+ };
112
126
  export type INudgeStepContentBlockType = t.TypeOf<typeof NudgeContentBlockV> & unknown;
113
127
  export type INudgeStepContentMarkdownBlockType = t.TypeOf<typeof NudgeContentMarkdownBlockV> & unknown;
114
128
  export type INudgeStepContentImageBlockType = t.TypeOf<typeof NudgeContentImageBlockV> & unknown;
@@ -118,6 +132,7 @@ export type INudgeStepContentSurveyTextBlockType = t.TypeOf<typeof NudgeContentS
118
132
  export type INudgeStepContentSurveyTextShortBlockType = t.TypeOf<typeof NudgeStepContentSurveyTextShortBlockTypeV> & unknown;
119
133
  export type INudgeContentSurveyRatingBlockType = t.TypeOf<typeof NudgeContentSurveyRatingBlockV> & unknown;
120
134
  export type INudgeContentListBlock = t.TypeOf<typeof NudgeContentListBlockV> & unknown;
135
+ export type INudgeStepSurveyBlockType = INudgeStepContentSurveyTextBlockType | INudgeStepContentSurveyTextShortBlockType | INudgeContentSurveyRatingBlockType | INudgeContentListBlock;
121
136
  export type INudgeStepContentButtonBlockType = t.TypeOf<typeof NudgeContentButtonBlockV> & unknown;
122
137
  export type INudgeButtonAction = t.TypeOf<typeof NudgeButtonActionV> & unknown;
123
138
  export type INudgeButtonConditionalAction = t.TypeOf<typeof NudgeConditionalActionV> & unknown;
@@ -126,11 +141,14 @@ export type INudgeClientType = {
126
141
  passedConditionsInLastEvaluation: boolean;
127
142
  lastTriggeredTs?: number;
128
143
  };
144
+ export type IExperienceTemplate = t.TypeOf<typeof ExperienceTemplateV> & unknown;
129
145
  export type LabeledAction = t.TypeOf<typeof LabeledActionV> & unknown;
130
146
  export type OpenChatAction = t.TypeOf<typeof OpenChatActionV> & unknown;
147
+ export type OpenChatActionType = t.TypeOf<typeof OpenChatActionTypeV> & unknown;
131
148
  export type QuestlistAction = t.TypeOf<typeof QuestlistActionV> & unknown;
132
149
  export type NudgeAction = t.TypeOf<typeof NudgeActionV> & unknown;
133
150
  export type CommandAction = t.TypeOf<typeof CommandActionV> & unknown;
151
+ export type CommandActionMetaType = t.TypeOf<typeof CommandActionMetaTypeV> & unknown;
134
152
  export type Action = t.TypeOf<typeof ActionV> & unknown;
135
153
  export type IBillingProfile = t.TypeOf<typeof BillingProfileV> & unknown;
136
154
  export type IChecklist = t.TypeOf<typeof ChecklistV> & {
@@ -141,8 +159,8 @@ export type IChecklist = t.TypeOf<typeof ChecklistV> & {
141
159
  };
142
160
  } & unknown;
143
161
  export type IChecklistItem = t.TypeOf<typeof ChecklistItemV> & unknown;
144
- export type ChecklistInteractionState = t.TypeOf<typeof QuestlistInteractionStateV> & unknown;
145
- export type ChecklistInteractions = t.TypeOf<typeof QuestlistInteractionsV> & unknown;
162
+ export type ChecklistInteractionState = t.TypeOf<typeof ChecklistInteractionStateV> & unknown;
163
+ export type ChecklistInteractions = t.TypeOf<typeof ChecklistInteractionsV> & unknown;
146
164
  export type NudgeInteractionState = t.TypeOf<typeof NudgeInteractionStateV> & unknown;
147
165
  export type NudgeInteractions = t.TypeOf<typeof NudgeInteractionsV> & unknown;
148
166
  export type IMessageType = t.TypeOf<typeof MessageV> & unknown;
@@ -160,6 +178,16 @@ export type ICreateAnswerFeedbackPayloadType = t.TypeOf<typeof CreateAnswerFeedb
160
178
  export type ISearchHelpDocsPayloadType = t.TypeOf<typeof SearchHelpDocsPayloadV> & unknown;
161
179
  export type ISearchHelpDocsResponseType = t.TypeOf<typeof SearchHelpDocsResponseV> & unknown;
162
180
  export type IHelpDocHitType = t.TypeOf<typeof HelpDocHitV> & unknown;
181
+ export type ISearchExperiencesPayloadType = t.TypeOf<typeof SearchExperiencesPayloadV> & unknown;
182
+ export type ISearchExperiencesResponseType = t.TypeOf<typeof SearchExperiencesResponseV> & unknown;
183
+ export type IExperienceTypeOptions = t.TypeOf<typeof ExperienceTypeOptions> & unknown;
184
+ export type IExperienceHitType = t.TypeOf<typeof ExperienceHitV> & unknown;
185
+ export type ContentType = t.TypeOf<typeof ContentTypeV> & unknown;
186
+ export type ICopilotPersonalityType = t.TypeOf<typeof CopilotPersonalityV> & unknown;
187
+ export type ICopilotPersonalityAdjectivesType = t.TypeOf<typeof CopilotPersonalityAdjectiveV> & unknown;
188
+ export type ICopilotPersonalityResponseLengthType = t.TypeOf<typeof CopilotPersonalityResponseLengthV> & unknown;
189
+ export type ICopilotPersonalityResponseFormatType = t.TypeOf<typeof CopilotPersonalityResponseFormatV> & unknown;
190
+ export type ICopilotSettingsPreviewType = t.TypeOf<typeof CopilotSettingsPreviewV> & unknown;
163
191
  export interface ICommandInput {
164
192
  text: string;
165
193
  command: ICommandType;
@@ -213,6 +241,9 @@ export type IConfigEndpointResponse = {
213
241
  checklists?: IChecklist[];
214
242
  helphub_additional_resources?: IAdditionalResource[];
215
243
  helphub_recommendation_sets?: IRecommendationSet[];
244
+ __meta__?: {
245
+ latest_foobar_version?: string;
246
+ };
216
247
  };
217
248
  export type IConfigType = {
218
249
  commands: ICommandType[];
@@ -225,12 +256,17 @@ export type IConfigType = {
225
256
  checklists: IChecklist[];
226
257
  helphub_additional_resources: IAdditionalResource[];
227
258
  helphub_recommendation_sets: IRecommendationSet[];
259
+ __meta__?: {
260
+ latest_foobar_version?: string;
261
+ };
262
+ flags: Flags;
228
263
  };
229
- export type { IResourceSettings } from './IResourceSettings';
230
- export type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV> & unknown;
264
+ export type { IRecordSettings } from './IRecordSettings';
265
+ export type IRecordSettingsByContextKey = t.TypeOf<typeof RecordSettingsByContextKeyV> & unknown;
231
266
  export type { DetailPreviewObjectType, DetailPreviewType, DataRowMetadata } from './detailPreview';
232
267
  /*******************************************************************************/
233
268
  export declare const isCommand: (command?: ICommandType | any) => command is ICommandType;
234
269
  export declare const isResource: (option: any) => option is IResourceType;
235
270
  export declare const isContextArgument: (argument: IArgumentType) => argument is IContextArgumentType;
236
271
  export declare const isTimeArgument: (argument: IArgumentType) => argument is IDynamicArgumentType;
272
+ export declare const isSurveyBlock: (block: INudgeStepContentBlockType) => block is INudgeStepSurveyBlockType;
@@ -10,6 +10,7 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
10
10
  profile: t.NumberC;
11
11
  has_updated_password: t.BooleanC;
12
12
  is_active: t.BooleanC;
13
+ is_hijacked: t.BooleanC;
13
14
  }>, t.PartialC<{
14
15
  intercom_hash: t.StringC;
15
16
  }>]>;
@@ -1,14 +1,14 @@
1
- import { INudgeType } from '../middleware/types';
1
+ import type { INudgeType } from '../middleware/types';
2
2
  export type TUpdateEditorRouteDetails = {
3
3
  type: 'nudge';
4
4
  nudge: INudgeType;
5
- nudgeId: string | number;
6
- stepId: string | number;
5
+ stepIndex: number;
7
6
  } | {
8
7
  type: 'checklist';
9
8
  checklistId: string | number;
10
9
  } | {
11
10
  type: 'route';
12
11
  route_replacement: string;
12
+ action?: string;
13
13
  };
14
14
  export declare function dispatchCustomEvent<T>(eventType: string, detail: T, canBubble?: boolean, cancelable?: boolean): CustomEvent<T>;
@@ -1,10 +1,8 @@
1
1
  export type PlatformType = 'mac' | 'ios' | 'windows' | 'android' | 'linux';
2
2
  export type BrowserType = 'chrome' | 'firefox' | 'safari' | 'opera' | 'edge' | 'brave' | 'arc' | 'ie10' | 'ie11';
3
3
  export type DeviceType = 'mobile' | 'desktop';
4
- export declare const EDITOR_MOBILE_PREVIEW_SCREEN_HEIGHT: number;
5
- export declare const EDITOR_MOBILE_PREVIEW_SCREEN_WIDTH: number;
6
- export declare const EDITOR_MOBILE_PREVIEW_TOP_BAR_HEIGHT = 48;
7
- export declare const EDITOR_MOBILE_PREVIEW_BOTTOM_BAR_HEIGHT = 48;
4
+ export declare const EDITOR_MOBILE_PREVIEW_SCREEN_HEIGHT = 932;
5
+ export declare const EDITOR_MOBILE_PREVIEW_SCREEN_WIDTH = 430;
8
6
  export declare const isMobileDevice: () => boolean;
9
7
  export declare const getDeviceType: () => DeviceType;
10
8
  export declare const getBrowser: () => BrowserType | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "commandbar",
3
- "version": "1.9.0",
3
+ "version": "1.10.0",
4
4
  "description": "Javascript Utility for CommandBar",
5
5
  "main": "build/commandbar-js/src/index.js",
6
6
  "types": "build/commandbar-js/src/index.d.ts",
package/src/index.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import Launcher, { getControlKey } from 'commandbar-launcher';
2
- import { CommandBarClientSDK } from '../../internal/src/client/CommandBarClientSDK';
2
+ import type { CommandBarClientSDK } from '@commandbar/internal/src/client/CommandBarClientSDK';
3
3
 
4
4
  export { default as init } from './init';
5
- export { initProxySDK as initProxy } from '../../internal/src/client/proxy';
5
+ export { initProxySDK as initProxy } from '@commandbar/internal/src/client/proxy';
6
6
  export { snippet } from './snippet';
7
7
  export { CommandBarClientSDK };
8
8
  export { Launcher, getControlKey };