commandbar 1.8.7 → 1.9.0
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.
- 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 +3 -3
- 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
@@ -0,0 +1,26 @@
|
|
1
|
+
import { DeviceType } from '../util/operatingSystem';
|
2
|
+
import * as t from 'io-ts';
|
3
|
+
import { IHelpHubLauncherSettingsType, IOrganizationType } from './types';
|
4
|
+
export declare const HelpHubLauncherPositionsV: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
5
|
+
export declare const HelpHubLauncherTypesV: 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">]>;
|
6
|
+
export declare const HelpHubLauncherSettingsV: t.TypeC<{
|
7
|
+
helphub_launcher_offset_x: t.NumberC;
|
8
|
+
helphub_launcher_offset_y: t.NumberC;
|
9
|
+
helphub_launcher_anchor: t.StringC;
|
10
|
+
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
11
|
+
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">]>;
|
12
|
+
helphub_mobile_launcher_offset_x: t.NumberC;
|
13
|
+
helphub_mobile_launcher_offset_y: t.NumberC;
|
14
|
+
helphub_mobile_launcher_anchor: t.StringC;
|
15
|
+
helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
16
|
+
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">]>;
|
17
|
+
}>;
|
18
|
+
export declare const getHelpHubLauncherSettingKeys: (deviceType: DeviceType) => Record<string, keyof IHelpHubLauncherSettingsType>;
|
19
|
+
export type HelpHubLauncherMergedSettings = {
|
20
|
+
type: IHelpHubLauncherSettingsType['helphub_launcher_type'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_type'];
|
21
|
+
anchor: IHelpHubLauncherSettingsType['helphub_launcher_anchor'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_anchor'];
|
22
|
+
position: IHelpHubLauncherSettingsType['helphub_launcher_position'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_position'];
|
23
|
+
offsetX: IHelpHubLauncherSettingsType['helphub_launcher_offset_x'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_offset_x'];
|
24
|
+
offsetY: IHelpHubLauncherSettingsType['helphub_launcher_offset_y'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_offset_y'];
|
25
|
+
};
|
26
|
+
export declare const getHelpHubLauncherSettings: (deviceType: DeviceType, organization: IOrganizationType) => HelpHubLauncherMergedSettings;
|
@@ -20,7 +20,7 @@ export declare const LinkAction: t.IntersectionC<[t.TypeC<{
|
|
20
20
|
}>, t.PartialC<{
|
21
21
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
22
22
|
}>]>;
|
23
|
-
export declare const
|
23
|
+
export declare const OpenChatActionV: t.TypeC<{
|
24
24
|
type: t.LiteralC<"open_chat">;
|
25
25
|
meta: t.TypeC<{
|
26
26
|
type: t.StringC;
|
@@ -29,6 +29,12 @@ export declare const OpenChatAction: t.TypeC<{
|
|
29
29
|
export declare const DismissAction: t.TypeC<{
|
30
30
|
type: t.LiteralC<"dismiss">;
|
31
31
|
}>;
|
32
|
+
export declare const StepBackAction: t.TypeC<{
|
33
|
+
type: t.LiteralC<"step_back">;
|
34
|
+
}>;
|
35
|
+
export declare const SnoozeAction: t.TypeC<{
|
36
|
+
type: t.LiteralC<"snooze">;
|
37
|
+
}>;
|
32
38
|
export declare const ClickAction: t.TypeC<{
|
33
39
|
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
34
40
|
value: t.ArrayC<t.StringC>;
|
@@ -63,7 +69,7 @@ export declare const HelpDocAction: t.IntersectionC<[t.TypeC<{
|
|
63
69
|
date: t.StringC;
|
64
70
|
}>;
|
65
71
|
}>]>;
|
66
|
-
export declare const
|
72
|
+
export declare const CommandActionV: t.TypeC<{
|
67
73
|
type: t.LiteralC<"execute_command">;
|
68
74
|
meta: t.TypeC<{
|
69
75
|
command: t.StringC;
|
@@ -76,10 +82,18 @@ export declare const ClickActionNew: t.TypeC<{
|
|
76
82
|
type: t.LiteralC<"click">;
|
77
83
|
value: t.StringC;
|
78
84
|
}>;
|
79
|
-
export declare const
|
85
|
+
export declare const NudgeActionV: t.TypeC<{
|
80
86
|
type: t.LiteralC<"nudge">;
|
81
87
|
value: t.NumberC;
|
82
88
|
}>;
|
89
|
+
export declare const GoToNudgeStepActionV: t.TypeC<{
|
90
|
+
type: t.LiteralC<"go_to_step">;
|
91
|
+
value: t.NumberC;
|
92
|
+
}>;
|
93
|
+
export declare const QuestlistActionV: t.TypeC<{
|
94
|
+
type: t.LiteralC<"questlist">;
|
95
|
+
value: t.NumberC;
|
96
|
+
}>;
|
83
97
|
export declare const ActionV: t.UnionC<[t.TypeC<{
|
84
98
|
type: t.LiteralC<"execute_command">;
|
85
99
|
meta: t.TypeC<{
|
@@ -102,7 +116,25 @@ export declare const ActionV: t.UnionC<[t.TypeC<{
|
|
102
116
|
}>;
|
103
117
|
}>, t.TypeC<{
|
104
118
|
type: t.LiteralC<"dismiss">;
|
105
|
-
}
|
119
|
+
}>, t.TypeC<{
|
120
|
+
type: t.LiteralC<"snooze">;
|
121
|
+
}>, t.TypeC<{
|
122
|
+
type: t.LiteralC<"questlist">;
|
123
|
+
value: t.NumberC;
|
124
|
+
}>, t.TypeC<{
|
125
|
+
type: t.LiteralC<"nudge">;
|
126
|
+
value: t.NumberC;
|
127
|
+
}>, t.TypeC<{
|
128
|
+
type: t.LiteralC<"go_to_step">;
|
129
|
+
value: t.NumberC;
|
130
|
+
}>, t.TypeC<{
|
131
|
+
type: t.LiteralC<"step_back">;
|
132
|
+
}>, t.IntersectionC<[t.TypeC<{
|
133
|
+
type: t.LiteralC<"open_bar">;
|
134
|
+
}>, t.PartialC<{
|
135
|
+
value: t.StringC;
|
136
|
+
categoryFilter: t.NumberC;
|
137
|
+
}>]>]>;
|
106
138
|
export declare const LabeledActionV: t.TypeC<{
|
107
139
|
cta: t.StringC;
|
108
140
|
action: t.UnionC<[t.TypeC<{
|
@@ -127,7 +159,25 @@ export declare const LabeledActionV: t.TypeC<{
|
|
127
159
|
}>;
|
128
160
|
}>, t.TypeC<{
|
129
161
|
type: t.LiteralC<"dismiss">;
|
130
|
-
}
|
162
|
+
}>, t.TypeC<{
|
163
|
+
type: t.LiteralC<"snooze">;
|
164
|
+
}>, t.TypeC<{
|
165
|
+
type: t.LiteralC<"questlist">;
|
166
|
+
value: t.NumberC;
|
167
|
+
}>, t.TypeC<{
|
168
|
+
type: t.LiteralC<"nudge">;
|
169
|
+
value: t.NumberC;
|
170
|
+
}>, t.TypeC<{
|
171
|
+
type: t.LiteralC<"go_to_step">;
|
172
|
+
value: t.NumberC;
|
173
|
+
}>, t.TypeC<{
|
174
|
+
type: t.LiteralC<"step_back">;
|
175
|
+
}>, t.IntersectionC<[t.TypeC<{
|
176
|
+
type: t.LiteralC<"open_bar">;
|
177
|
+
}>, t.PartialC<{
|
178
|
+
value: t.StringC;
|
179
|
+
categoryFilter: t.NumberC;
|
180
|
+
}>]>]>;
|
131
181
|
}>;
|
132
182
|
export declare const isAction: (o: string | number | LabeledAction) => o is {
|
133
183
|
cta: string;
|
@@ -136,8 +186,6 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
|
|
136
186
|
meta: {
|
137
187
|
command: string;
|
138
188
|
};
|
139
|
-
} | {
|
140
|
-
type: "no_action";
|
141
189
|
} | {
|
142
190
|
type: "click";
|
143
191
|
value: string;
|
@@ -153,6 +201,26 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
|
|
153
201
|
};
|
154
202
|
} | {
|
155
203
|
type: "dismiss";
|
204
|
+
} | {
|
205
|
+
type: "snooze";
|
206
|
+
} | {
|
207
|
+
type: "questlist";
|
208
|
+
value: number;
|
209
|
+
} | {
|
210
|
+
type: "step_back";
|
211
|
+
} | {
|
212
|
+
type: "nudge";
|
213
|
+
value: number;
|
214
|
+
} | {
|
215
|
+
type: "go_to_step";
|
216
|
+
value: number;
|
217
|
+
} | ({
|
218
|
+
type: "open_bar";
|
219
|
+
} & {
|
220
|
+
value?: string | undefined;
|
221
|
+
categoryFilter?: number | undefined;
|
222
|
+
}) | {
|
223
|
+
type: "no_action";
|
156
224
|
};
|
157
225
|
};
|
158
226
|
export declare const RequestV: t.IntersectionC<[t.TypeC<{
|
@@ -180,5 +248,45 @@ export declare const RequestAction: t.TypeC<{
|
|
180
248
|
}>;
|
181
249
|
export declare const TriggerAction: t.TypeC<{
|
182
250
|
type: t.LiteralC<"trigger">;
|
183
|
-
value: t.
|
251
|
+
value: t.UnionC<[t.TypeC<{
|
252
|
+
type: t.LiteralC<"execute_command">;
|
253
|
+
meta: t.TypeC<{
|
254
|
+
command: t.StringC;
|
255
|
+
}>;
|
256
|
+
}>, t.TypeC<{
|
257
|
+
type: t.LiteralC<"no_action">;
|
258
|
+
}>, t.TypeC<{
|
259
|
+
type: t.LiteralC<"click">;
|
260
|
+
value: t.StringC;
|
261
|
+
}>, t.IntersectionC<[t.TypeC<{
|
262
|
+
type: t.LiteralC<"link">;
|
263
|
+
value: t.StringC;
|
264
|
+
}>, t.PartialC<{
|
265
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
266
|
+
}>]>, t.TypeC<{
|
267
|
+
type: t.LiteralC<"open_chat">;
|
268
|
+
meta: t.TypeC<{
|
269
|
+
type: t.StringC;
|
270
|
+
}>;
|
271
|
+
}>, t.TypeC<{
|
272
|
+
type: t.LiteralC<"dismiss">;
|
273
|
+
}>, t.TypeC<{
|
274
|
+
type: t.LiteralC<"snooze">;
|
275
|
+
}>, t.TypeC<{
|
276
|
+
type: t.LiteralC<"questlist">;
|
277
|
+
value: t.NumberC;
|
278
|
+
}>, t.TypeC<{
|
279
|
+
type: t.LiteralC<"nudge">;
|
280
|
+
value: t.NumberC;
|
281
|
+
}>, t.TypeC<{
|
282
|
+
type: t.LiteralC<"go_to_step">;
|
283
|
+
value: t.NumberC;
|
284
|
+
}>, t.TypeC<{
|
285
|
+
type: t.LiteralC<"step_back">;
|
286
|
+
}>, t.IntersectionC<[t.TypeC<{
|
287
|
+
type: t.LiteralC<"open_bar">;
|
288
|
+
}>, t.PartialC<{
|
289
|
+
value: t.StringC;
|
290
|
+
categoryFilter: t.NumberC;
|
291
|
+
}>]>]>;
|
184
292
|
}>;
|
@@ -127,7 +127,47 @@ export declare const HelpDocTemplateV: t.IntersectionC<[t.IntersectionC<[t.TypeC
|
|
127
127
|
}>]>]>;
|
128
128
|
export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
|
129
129
|
type: t.LiteralC<"trigger">;
|
130
|
-
value: t.
|
130
|
+
value: t.UnionC<[t.TypeC<{
|
131
|
+
type: t.LiteralC<"execute_command">;
|
132
|
+
meta: t.TypeC<{
|
133
|
+
command: t.StringC;
|
134
|
+
}>;
|
135
|
+
}>, t.TypeC<{
|
136
|
+
type: t.LiteralC<"no_action">;
|
137
|
+
}>, t.TypeC<{
|
138
|
+
type: t.LiteralC<"click">;
|
139
|
+
value: t.StringC;
|
140
|
+
}>, t.IntersectionC<[t.TypeC<{
|
141
|
+
type: t.LiteralC<"link">;
|
142
|
+
value: t.StringC;
|
143
|
+
}>, t.PartialC<{
|
144
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
145
|
+
}>]>, t.TypeC<{
|
146
|
+
type: t.LiteralC<"open_chat">;
|
147
|
+
meta: t.TypeC<{
|
148
|
+
type: t.StringC;
|
149
|
+
}>;
|
150
|
+
}>, t.TypeC<{
|
151
|
+
type: t.LiteralC<"dismiss">;
|
152
|
+
}>, t.TypeC<{
|
153
|
+
type: t.LiteralC<"snooze">;
|
154
|
+
}>, t.TypeC<{
|
155
|
+
type: t.LiteralC<"questlist">;
|
156
|
+
value: t.NumberC;
|
157
|
+
}>, t.TypeC<{
|
158
|
+
type: t.LiteralC<"nudge">;
|
159
|
+
value: t.NumberC;
|
160
|
+
}>, t.TypeC<{
|
161
|
+
type: t.LiteralC<"go_to_step">;
|
162
|
+
value: t.NumberC;
|
163
|
+
}>, t.TypeC<{
|
164
|
+
type: t.LiteralC<"step_back">;
|
165
|
+
}>, t.IntersectionC<[t.TypeC<{
|
166
|
+
type: t.LiteralC<"open_bar">;
|
167
|
+
}>, t.PartialC<{
|
168
|
+
value: t.StringC;
|
169
|
+
categoryFilter: t.NumberC;
|
170
|
+
}>]>]>;
|
131
171
|
}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
|
132
172
|
commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
|
133
173
|
object: t.StringC;
|
@@ -243,7 +283,47 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
|
|
243
283
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
|
244
284
|
}>]>]>, t.IntersectionC<[t.TypeC<{
|
245
285
|
type: t.LiteralC<"trigger">;
|
246
|
-
value: t.
|
286
|
+
value: t.UnionC<[t.TypeC<{
|
287
|
+
type: t.LiteralC<"execute_command">;
|
288
|
+
meta: t.TypeC<{
|
289
|
+
command: t.StringC;
|
290
|
+
}>;
|
291
|
+
}>, t.TypeC<{
|
292
|
+
type: t.LiteralC<"no_action">;
|
293
|
+
}>, t.TypeC<{
|
294
|
+
type: t.LiteralC<"click">;
|
295
|
+
value: t.StringC;
|
296
|
+
}>, t.IntersectionC<[t.TypeC<{
|
297
|
+
type: t.LiteralC<"link">;
|
298
|
+
value: t.StringC;
|
299
|
+
}>, t.PartialC<{
|
300
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
301
|
+
}>]>, t.TypeC<{
|
302
|
+
type: t.LiteralC<"open_chat">;
|
303
|
+
meta: t.TypeC<{
|
304
|
+
type: t.StringC;
|
305
|
+
}>;
|
306
|
+
}>, t.TypeC<{
|
307
|
+
type: t.LiteralC<"dismiss">;
|
308
|
+
}>, t.TypeC<{
|
309
|
+
type: t.LiteralC<"snooze">;
|
310
|
+
}>, t.TypeC<{
|
311
|
+
type: t.LiteralC<"questlist">;
|
312
|
+
value: t.NumberC;
|
313
|
+
}>, t.TypeC<{
|
314
|
+
type: t.LiteralC<"nudge">;
|
315
|
+
value: t.NumberC;
|
316
|
+
}>, t.TypeC<{
|
317
|
+
type: t.LiteralC<"go_to_step">;
|
318
|
+
value: t.NumberC;
|
319
|
+
}>, t.TypeC<{
|
320
|
+
type: t.LiteralC<"step_back">;
|
321
|
+
}>, t.IntersectionC<[t.TypeC<{
|
322
|
+
type: t.LiteralC<"open_bar">;
|
323
|
+
}>, t.PartialC<{
|
324
|
+
value: t.StringC;
|
325
|
+
categoryFilter: t.NumberC;
|
326
|
+
}>]>]>;
|
247
327
|
}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
|
248
328
|
commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
|
249
329
|
object: t.StringC;
|
@@ -21,6 +21,12 @@ export declare const PushTriggerV: t.UnionC<[t.TypeC<{
|
|
21
21
|
meta: t.TypeC<{
|
22
22
|
selector: t.StringC;
|
23
23
|
}>;
|
24
|
+
}>, t.TypeC<{
|
25
|
+
type: t.LiteralC<"on_user_confusion">;
|
26
|
+
}>, t.TypeC<{
|
27
|
+
type: t.LiteralC<"on_rage_click">;
|
28
|
+
}>, t.TypeC<{
|
29
|
+
type: t.LiteralC<"smart_delay">;
|
24
30
|
}>, t.TypeC<{
|
25
31
|
type: t.LiteralC<"when_share_link_viewed">;
|
26
32
|
}>]>;
|