commandbar 1.8.7 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
  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 +8 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
  7. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  8. package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
  9. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  10. package/build/internal/src/client/globals.d.ts +6 -0
  11. package/build/internal/src/client/symbols.d.ts +13 -6
  12. package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
  13. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  14. package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
  15. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  16. package/build/internal/src/middleware/additionalResource.d.ts +270 -27
  17. package/build/internal/src/middleware/billing.d.ts +31 -0
  18. package/build/internal/src/middleware/chat.d.ts +12933 -0
  19. package/build/internal/src/middleware/checklist.d.ts +589 -70
  20. package/build/internal/src/middleware/command.d.ts +5433 -677
  21. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  22. package/build/internal/src/middleware/endUser.d.ts +132 -0
  23. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  24. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  25. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  26. package/build/internal/src/middleware/flags.d.ts +20 -0
  27. package/build/internal/src/middleware/generics.d.ts +12 -11
  28. package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
  29. package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
  30. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  31. package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
  32. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
  33. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  34. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  35. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +28 -0
  36. package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
  37. package/build/internal/src/middleware/network.d.ts +27 -3
  38. package/build/internal/src/middleware/nudge.d.ts +2220 -91
  39. package/build/internal/src/middleware/organization.d.ts +2289 -152
  40. package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
  41. package/build/internal/src/middleware/profile.d.ts +2 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
  43. package/build/internal/src/middleware/releases.d.ts +1 -1
  44. package/build/internal/src/middleware/theme.d.ts +425 -0
  45. package/build/internal/src/middleware/types.d.ts +88 -34
  46. package/build/internal/src/middleware/user.d.ts +1 -0
  47. package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
  48. package/build/internal/src/util/operatingSystem.d.ts +11 -0
  49. package/build/internal/src/util/sentry.d.ts +23 -0
  50. package/package.json +3 -3
  51. package/src/index.ts +2 -2
  52. package/src/init.ts +11 -6
  53. package/src/snippet.ts +2 -2
  54. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  55. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  56. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  57. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  58. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
  59. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  60. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  61. package/build/internal/src/util/integrations.d.ts +0 -1
@@ -1,5 +1,5 @@
1
1
  import * as t from 'io-ts';
2
- export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
2
+ export { RecordSettingsV, RecordSettingsByContextKeyV } from './RecordSettingsV';
3
3
  export { OrganizationV } from './OrganizationV';
4
4
  export declare const ReleaseV: t.TypeC<{
5
5
  created_by: t.UnionC<[t.StringC, t.NullC]>;
@@ -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, LabeledActionV, 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,31 +15,44 @@ 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 { EndUserV } from './helpers/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';
23
24
  import { EnvironmentV } from './environment';
24
- import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV, NudgeContentImageBlockV, NudgeContentMarkdownBlockV, NudgeContentVideoBlockV, NudgeContentSurveyTextBlockV, NudgeContentSurveyRatingBlockV, NudgeStepV, NudgeV, OldNudgeV } from './nudge';
25
- import { InstantAnswerV } from './qaPair';
25
+ import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV, NudgeContentImageBlockV, NudgeContentMarkdownBlockV, NudgeContentVideoBlockV, NudgeContentSurveyTextBlockV, NudgeStepContentSurveyTextShortBlockTypeV, NudgeContentSurveyRatingBlockV, NudgeContentListBlockV, NudgeStepV, NudgeV, OldNudgeV, NudgeButtonActionV, NudgeConditionalActionV } from './nudge';
26
26
  import { TabV } from './tab';
27
27
  import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
28
28
  import { ChecklistItemV, ChecklistV } from './checklist';
29
- import { DashboardFlagsV } from './dashboardFlags';
30
29
  import { PushTriggerV } from './helpers/pushTrigger';
31
30
  import { FrequencyLimitV } from './helpers/frequencyLimit';
32
31
  import { AudienceV } from './helpers/audience';
33
32
  import { AdditionalResourceV } from './additionalResource';
34
- import { EditorRecommendationSetV, RecommendationSetV } from './recommendationSet';
35
- import { UsageV } from './billing';
36
- import { UserMessageV, AIMessageV, MessageV } from './chatAnalytics';
33
+ import { RecommendationSetV } from './recommendationSet';
34
+ import { BillingProfileV, UsageV } from './billing';
35
+ import { UserMessageV, AIMessageV, MessageV, AIAnswerPayloadV, AIAnswerV, ContinuationsPayloadV, ContinuationV, CreateAnswerFeedbackPayloadV, QuestionSuggestionsPayloadV, QuestionSuggestionsV, ExperienceV, CreateChatPayloadV, ChatV, CopilotSettingsPreviewV } from './chat';
36
+ import { HelpDocHitV, SearchHelpDocsPayloadV, SearchHelpDocsResponseV } from './helpDocsSearch';
37
+ import { ExperienceHitV, ExperienceTypeOptions, SearchExperiencesPayloadV, SearchExperiencesResponseV } from './experiencesSearch';
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';
37
43
  /*******************************************************************************/
38
44
  export type IInitOptions = {
39
45
  debug?: boolean;
40
46
  environment?: string;
41
47
  version?: string;
42
- config?: IConfigEndpointResponse;
48
+ config?: any;
49
+ nonce?: string;
50
+ };
51
+ /** Additional foobar init options */
52
+ export declare const SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS: readonly ["dev", "labs", "prod"];
53
+ export type IInitOptionsFoobar = IInitOptions & {
54
+ deployment?: (typeof SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS)[number];
55
+ disable_analytics?: boolean;
43
56
  };
44
57
  /*******************************************************************************/
45
58
  export type IContextType = t.TypeOf<typeof ContextV> & unknown;
@@ -48,26 +61,29 @@ export type ICommandType = t.TypeOf<typeof CommandV> & unknown;
48
61
  export type IEditorCommandType = t.TypeOf<typeof EditorCommandV> & unknown;
49
62
  export type IEditorCommandTypeLite = t.TypeOf<typeof EditorCommandLiteV> & unknown;
50
63
  export type ICommandTypeLite = t.TypeOf<typeof CommandLiteV> & unknown;
51
- export type IHelpSyncCommandType = t.TypeOf<typeof HelpSyncCommandV> & unknown;
52
64
  export type { ICommandFromClientType } from './ICommandFromClientType';
53
65
  export type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV> & unknown;
54
66
  export type IGuideType = t.TypeOf<typeof GuideV> & {
55
67
  preview?: boolean;
56
68
  } & unknown;
57
69
  export type IHistoryEventType = t.TypeOf<typeof HistoryEventV> & unknown;
70
+ export type IEntityChangeType = t.TypeOf<typeof EntityChangeV> & unknown;
58
71
  export type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV> & unknown;
59
72
  export type IHelpDocsSyncLogMessageType = t.TypeOf<typeof HelpDocSyncLogMessageV> & unknown;
60
73
  export type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrationV> & unknown;
74
+ export type IHelpHubLauncherSettingsType = t.TypeOf<typeof HelpHubLauncherSettingsV> & unknown;
61
75
  export type IOrganizationType = t.TypeOf<typeof OrganizationV> & unknown;
62
76
  export type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV> & unknown;
63
77
  export type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV> & unknown;
64
- export type IDashboardFlagsType = t.TypeOf<typeof DashboardFlagsV> & unknown;
65
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;
66
81
  export type IProfileType = t.TypeOf<typeof ProfileV> & unknown;
67
82
  export type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV> & unknown;
68
83
  export type IPlaceholderType = t.TypeOf<typeof PlaceholderV> & unknown;
69
84
  export type ITabType = t.TypeOf<typeof TabV> & unknown;
70
85
  export type IEnvironmentType = t.TypeOf<typeof EnvironmentV> & unknown;
86
+ export type IChatType = t.TypeOf<typeof ChatV> & unknown;
71
87
  export type IReleaseStep = t.TypeOf<typeof ReleaseStepV> & unknown;
72
88
  export type IRelease = t.TypeOf<typeof ReleaseV> & unknown;
73
89
  export type IEnvReleaseInfo = t.TypeOf<typeof EnvReleaseInfoV> & unknown;
@@ -83,10 +99,10 @@ export type IArgumentMap = t.TypeOf<typeof ArgumentMapV> & unknown;
83
99
  export type IArgumentType = t.TypeOf<typeof ArgumentTypeV> & unknown;
84
100
  export type IStepArgumentType = t.TypeOf<typeof StepArgumentTypeV> & unknown;
85
101
  export type ITemplate = t.TypeOf<typeof TemplateV> & unknown;
102
+ export type IVideoTemplate = t.TypeOf<typeof VideoTemplateV> & unknown;
86
103
  export type RequestTemplateType = t.TypeOf<typeof RequestTemplateV> & unknown;
87
104
  export type RequestType = t.TypeOf<typeof RequestV> & unknown;
88
105
  export type ITemplateOptions = t.TypeOf<typeof TemplateOptionsV> & unknown;
89
- export type IEndUserType = t.TypeOf<typeof EndUserV> & unknown;
90
106
  export type IRuleExpression = t.TypeOf<typeof RuleExpressionV> & unknown;
91
107
  export type IRuleExpressionAnd = t.TypeOf<typeof RuleExpressionAndV> & unknown;
92
108
  export type IRuleExpressionOr = t.TypeOf<typeof RuleExpressionOrV> & unknown;
@@ -102,36 +118,39 @@ export type IAudienceType = t.TypeOf<typeof AudienceV> & unknown;
102
118
  export type IPushTrigger = t.TypeOf<typeof PushTriggerV> & unknown;
103
119
  export type IFrequencyLimit = t.TypeOf<typeof FrequencyLimitV> & unknown;
104
120
  export type INudgeStepType = t.TypeOf<typeof NudgeStepV> & unknown;
121
+ export type INudgeTooltipStepType = INudgeStepType & {
122
+ form_factor: {
123
+ type: 'tooltip';
124
+ };
125
+ };
105
126
  export type INudgeStepContentBlockType = t.TypeOf<typeof NudgeContentBlockV> & unknown;
106
127
  export type INudgeStepContentMarkdownBlockType = t.TypeOf<typeof NudgeContentMarkdownBlockV> & unknown;
107
128
  export type INudgeStepContentImageBlockType = t.TypeOf<typeof NudgeContentImageBlockV> & unknown;
108
129
  export type INudgeStepContentVideoBlockType = t.TypeOf<typeof NudgeContentVideoBlockV> & unknown;
109
130
  export type INudgeStepContentHelpDocBlockType = t.TypeOf<typeof NudgeContentHelpDocBlockV> & unknown;
110
131
  export type INudgeStepContentSurveyTextBlockType = t.TypeOf<typeof NudgeContentSurveyTextBlockV> & unknown;
132
+ export type INudgeStepContentSurveyTextShortBlockType = t.TypeOf<typeof NudgeStepContentSurveyTextShortBlockTypeV> & unknown;
111
133
  export type INudgeContentSurveyRatingBlockType = t.TypeOf<typeof NudgeContentSurveyRatingBlockV> & unknown;
134
+ export type INudgeContentListBlock = t.TypeOf<typeof NudgeContentListBlockV> & unknown;
135
+ export type INudgeStepSurveyBlockType = INudgeStepContentSurveyTextBlockType | INudgeStepContentSurveyTextShortBlockType | INudgeContentSurveyRatingBlockType | INudgeContentListBlock;
112
136
  export type INudgeStepContentButtonBlockType = t.TypeOf<typeof NudgeContentButtonBlockV> & unknown;
137
+ export type INudgeButtonAction = t.TypeOf<typeof NudgeButtonActionV> & unknown;
138
+ export type INudgeButtonConditionalAction = t.TypeOf<typeof NudgeConditionalActionV> & unknown;
113
139
  export type INudgeClientType = {
114
140
  nudge: INudgeType;
115
141
  passedConditionsInLastEvaluation: boolean;
116
142
  lastTriggeredTs?: number;
117
143
  };
144
+ export type IExperienceTemplate = t.TypeOf<typeof ExperienceTemplateV> & unknown;
118
145
  export type LabeledAction = t.TypeOf<typeof LabeledActionV> & unknown;
146
+ export type OpenChatAction = t.TypeOf<typeof OpenChatActionV> & unknown;
147
+ export type OpenChatActionType = t.TypeOf<typeof OpenChatActionTypeV> & unknown;
148
+ export type QuestlistAction = t.TypeOf<typeof QuestlistActionV> & unknown;
149
+ export type NudgeAction = t.TypeOf<typeof NudgeActionV> & unknown;
150
+ export type CommandAction = t.TypeOf<typeof CommandActionV> & unknown;
151
+ export type CommandActionMetaType = t.TypeOf<typeof CommandActionMetaTypeV> & unknown;
119
152
  export type Action = t.TypeOf<typeof ActionV> & unknown;
120
- export type IBillingProfile = {
121
- organization: string;
122
- price_cents: number;
123
- tier: string;
124
- discount_cents: number;
125
- name: string;
126
- invoice_description: string;
127
- customer_id: string | null;
128
- publishable_key: string;
129
- balance: number | null;
130
- currency: string | null;
131
- on_free_trial: boolean;
132
- free_trial_end_date: string | null;
133
- appsumo_invoice_item_id: string | null;
134
- };
153
+ export type IBillingProfile = t.TypeOf<typeof BillingProfileV> & unknown;
135
154
  export type IChecklist = t.TypeOf<typeof ChecklistV> & {
136
155
  _editorState?: {
137
156
  timestamp?: number;
@@ -140,10 +159,35 @@ export type IChecklist = t.TypeOf<typeof ChecklistV> & {
140
159
  };
141
160
  } & unknown;
142
161
  export type IChecklistItem = t.TypeOf<typeof ChecklistItemV> & unknown;
143
- export type IInstantAnswerType = t.TypeOf<typeof InstantAnswerV> & unknown;
162
+ export type ChecklistInteractionState = t.TypeOf<typeof ChecklistInteractionStateV> & unknown;
163
+ export type ChecklistInteractions = t.TypeOf<typeof ChecklistInteractionsV> & unknown;
164
+ export type NudgeInteractionState = t.TypeOf<typeof NudgeInteractionStateV> & unknown;
165
+ export type NudgeInteractions = t.TypeOf<typeof NudgeInteractionsV> & unknown;
144
166
  export type IMessageType = t.TypeOf<typeof MessageV> & unknown;
145
167
  export type IUserMessageType = t.TypeOf<typeof UserMessageV> & unknown;
146
168
  export type IAIMessageType = t.TypeOf<typeof AIMessageV> & unknown;
169
+ export type IQuestionSuggestionsType = t.TypeOf<typeof QuestionSuggestionsV> & unknown;
170
+ export type IQuestionSuggestionsPayloadType = t.TypeOf<typeof QuestionSuggestionsPayloadV> & unknown;
171
+ export type ICreateChatPayloadType = t.TypeOf<typeof CreateChatPayloadV> & unknown;
172
+ export type IContinuationType = t.TypeOf<typeof ContinuationV> & unknown;
173
+ export type IExperienceType = t.TypeOf<typeof ExperienceV> & unknown;
174
+ export type IContinuationsPayloadType = t.TypeOf<typeof ContinuationsPayloadV> & unknown;
175
+ export type IAIAnswerType = t.TypeOf<typeof AIAnswerV> & unknown;
176
+ export type IAIAnswerPayloadType = t.TypeOf<typeof AIAnswerPayloadV> & unknown;
177
+ export type ICreateAnswerFeedbackPayloadType = t.TypeOf<typeof CreateAnswerFeedbackPayloadV> & unknown;
178
+ export type ISearchHelpDocsPayloadType = t.TypeOf<typeof SearchHelpDocsPayloadV> & unknown;
179
+ export type ISearchHelpDocsResponseType = t.TypeOf<typeof SearchHelpDocsResponseV> & unknown;
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;
147
191
  export interface ICommandInput {
148
192
  text: string;
149
193
  command: ICommandType;
@@ -162,6 +206,9 @@ export interface IUserContext {
162
206
  export interface IUserRemoteProperties {
163
207
  [variable: string]: any;
164
208
  }
209
+ export type IEndUserType = t.TypeOf<typeof EndUserV> & unknown;
210
+ export type IEndUserStoreData = t.TypeOf<typeof EndUserStoreDataV> & unknown;
211
+ export type IDecideResponseType = t.TypeOf<typeof DecideResponseV> & unknown;
165
212
  export interface IEndUserAnalytics {
166
213
  num_command_executions: number;
167
214
  num_shortcut_command_executions: number;
@@ -182,7 +229,6 @@ export interface IResourceType extends IUserContext {
182
229
  }
183
230
  export type IAdditionalResource = t.TypeOf<typeof AdditionalResourceV> & unknown;
184
231
  export type IRecommendationSet = t.TypeOf<typeof RecommendationSetV> & unknown;
185
- export type IEditorRecommendationSet = t.TypeOf<typeof EditorRecommendationSetV> & unknown;
186
232
  export type IConfigEndpointResponse = {
187
233
  commands: any[];
188
234
  categories: any[];
@@ -195,6 +241,9 @@ export type IConfigEndpointResponse = {
195
241
  checklists?: IChecklist[];
196
242
  helphub_additional_resources?: IAdditionalResource[];
197
243
  helphub_recommendation_sets?: IRecommendationSet[];
244
+ __meta__?: {
245
+ latest_foobar_version?: string;
246
+ };
198
247
  };
199
248
  export type IConfigType = {
200
249
  commands: ICommandType[];
@@ -207,12 +256,17 @@ export type IConfigType = {
207
256
  checklists: IChecklist[];
208
257
  helphub_additional_resources: IAdditionalResource[];
209
258
  helphub_recommendation_sets: IRecommendationSet[];
259
+ __meta__?: {
260
+ latest_foobar_version?: string;
261
+ };
262
+ flags: Flags;
210
263
  };
211
- export type { IResourceSettings } from './IResourceSettings';
212
- export type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV> & unknown;
264
+ export type { IRecordSettings } from './IRecordSettings';
265
+ export type IRecordSettingsByContextKey = t.TypeOf<typeof RecordSettingsByContextKeyV> & unknown;
213
266
  export type { DetailPreviewObjectType, DetailPreviewType, DataRowMetadata } from './detailPreview';
214
267
  /*******************************************************************************/
215
268
  export declare const isCommand: (command?: ICommandType | any) => command is ICommandType;
216
269
  export declare const isResource: (option: any) => option is IResourceType;
217
270
  export declare const isContextArgument: (argument: IArgumentType) => argument is IContextArgumentType;
218
271
  export declare const isTimeArgument: (argument: IArgumentType) => argument is IDynamicArgumentType;
272
+ export declare const isSurveyBlock: (block: INudgeStepContentBlockType) => block is INudgeStepSurveyBlockType;