commandbar 1.6.7 → 1.6.10
Sign up to get free protection for your applications and to get access to all the features.
- package/build/commandbar-js/src/index.d.ts +10 -0
- package/build/commandbar-js/src/index.js +1 -0
- package/build/commandbar-js/src/init.d.ts +21 -0
- package/build/commandbar-js/src/snippet.d.ts +1 -0
- package/build/internal/src/client/AddContextOptions.d.ts +108 -0
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -0
- package/build/internal/src/client/CommandBarClientSDK.d.ts +303 -0
- package/build/internal/src/client/CommandBarProxySDK.d.ts +48 -0
- package/build/internal/src/client/CommandBarSDK.d.ts +50 -0
- package/build/internal/src/client/EventHandler.d.ts +99 -0
- package/build/internal/src/client/SDKConfig.d.ts +13 -0
- package/build/internal/src/client/SentryReporter.d.ts +41 -0
- package/build/internal/src/client/globals.d.ts +18 -0
- package/build/internal/src/client/proxy.d.ts +15 -0
- package/build/internal/src/client/symbols.d.ts +32 -0
- package/build/internal/src/middleware/CommandFromClientV.d.ts +252 -0
- package/build/internal/src/middleware/ICommandFromClientType.d.ts +5 -0
- package/build/internal/src/middleware/IResourceSettings.d.ts +3 -0
- package/build/internal/src/middleware/OrganizationV.d.ts +120 -0
- package/build/internal/src/middleware/ResourceSettingsV.d.ts +57 -0
- package/build/internal/src/middleware/command.d.ts +5464 -0
- package/build/internal/src/middleware/commandCategory.d.ts +136 -0
- package/build/internal/src/middleware/confetti.d.ts +16 -0
- package/build/internal/src/middleware/context.d.ts +40 -0
- package/build/internal/src/middleware/detailPreview.d.ts +21 -0
- package/build/internal/src/middleware/environment.d.ts +11 -0
- package/build/internal/src/middleware/generics.d.ts +40 -0
- package/build/internal/src/middleware/guide.d.ts +37 -0
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +66 -0
- package/build/internal/src/middleware/helpDocsSync.d.ts +42 -0
- package/build/internal/src/middleware/helpers/argument.d.ts +412 -0
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +191 -0
- package/build/internal/src/middleware/helpers/endUser.d.ts +10 -0
- package/build/internal/src/middleware/helpers/optionGroup.d.ts +2 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +231 -0
- package/build/internal/src/middleware/historyEvent.d.ts +40 -0
- package/build/internal/src/middleware/network.d.ts +4 -0
- package/build/internal/src/middleware/organization.d.ts +710 -0
- package/build/internal/src/middleware/placeholder.d.ts +47 -0
- package/build/internal/src/middleware/profile.d.ts +11 -0
- package/build/internal/src/middleware/releases.d.ts +261 -0
- package/build/internal/src/middleware/skin.d.ts +66 -0
- package/build/internal/src/middleware/types.d.ts +425 -0
- package/build/internal/src/middleware/user.d.ts +12 -0
- package/build/internal/src/util/Disposable.d.ts +17 -0
- package/build/internal/src/util/LocalStorage.d.ts +6 -0
- package/build/internal/src/util/Logger.d.ts +18 -0
- package/build/internal/src/util/dispatchCustomEvent.d.ts +2 -0
- package/package.json +1 -1
- package/src/init.ts +1 -1
@@ -0,0 +1,710 @@
|
|
1
|
+
import * as t from 'io-ts';
|
2
|
+
export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
|
3
|
+
export { OrganizationV } from './OrganizationV';
|
4
|
+
export declare const OrganizationStatusV: t.TypeC<{
|
5
|
+
id: t.UnionC<[t.NumberC, t.StringC]>;
|
6
|
+
uuid: t.StringC;
|
7
|
+
errors_72h: t.NumberC;
|
8
|
+
suggestions_72h: t.NumberC;
|
9
|
+
executions_total: t.NumberC;
|
10
|
+
users_total: t.NumberC;
|
11
|
+
}>;
|
12
|
+
export declare const KeyEventV: t.UnionC<[t.LiteralC<"Client-Error">, t.LiteralC<"Command execution">, t.LiteralC<"Command suggestion">, t.LiteralC<"Abandoned search">, t.LiteralC<"Search miss">]>;
|
13
|
+
export declare const InternalSettingsV: t.TypeC<{
|
14
|
+
id: t.StringC;
|
15
|
+
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.StringC>>;
|
16
|
+
}>;
|
17
|
+
export declare const OrganizationSettingsV: t.TypeC<{
|
18
|
+
end_user_limit: t.NumberC;
|
19
|
+
user_seat_limit: t.NumberC;
|
20
|
+
analytics_dashboard_execution_limit: t.NumberC;
|
21
|
+
analytics_dashboard_deadend_limit: t.NumberC;
|
22
|
+
silent_mode: t.BooleanC;
|
23
|
+
allow_event_handlers: t.BooleanC;
|
24
|
+
event_attribute_block_list: t.ArrayC<t.StringC>;
|
25
|
+
skins_limit: t.NumberC;
|
26
|
+
skins_field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
|
27
|
+
show_countdown_banner: t.BooleanC;
|
28
|
+
can_install_foobar: t.BooleanC;
|
29
|
+
releases_available: t.BooleanC;
|
30
|
+
releases_enabled: t.BooleanC;
|
31
|
+
releases_environments: t.ArrayC<t.StringC>;
|
32
|
+
in_bar_feedback: t.BooleanC;
|
33
|
+
summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
|
34
|
+
end_user_shortcuts_enabled: t.BooleanC;
|
35
|
+
fallback_commands: t.ArrayC<t.NumberC>;
|
36
|
+
end_user_recents_enabled: t.BooleanC;
|
37
|
+
}>;
|
38
|
+
export declare class Organization {
|
39
|
+
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
40
|
+
onSuccess?: (() => void) | undefined;
|
41
|
+
onError?: ((err: string) => void) | undefined;
|
42
|
+
} | undefined) => Promise<{
|
43
|
+
id: string | number;
|
44
|
+
name: string;
|
45
|
+
created: string;
|
46
|
+
} & {} & {
|
47
|
+
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
48
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
49
|
+
show_launcher_recommendations: boolean;
|
50
|
+
recommendations_type: "None" | "Custom" | "Algorithm";
|
51
|
+
launcher_offset_x: number;
|
52
|
+
launcher_offset_y: number;
|
53
|
+
theme: object;
|
54
|
+
icon: string;
|
55
|
+
icon_suggest: string;
|
56
|
+
icon_tutorial: string;
|
57
|
+
icon_go_forward: string;
|
58
|
+
resource_options: {
|
59
|
+
[x: string]: {
|
60
|
+
name?: string | undefined;
|
61
|
+
search?: boolean | undefined;
|
62
|
+
label_field?: string | undefined;
|
63
|
+
useCategory?: boolean | undefined;
|
64
|
+
search_fields?: (string | {
|
65
|
+
key: string;
|
66
|
+
label: string;
|
67
|
+
})[] | undefined;
|
68
|
+
auto_execute?: boolean | undefined;
|
69
|
+
unfurl?: boolean | undefined;
|
70
|
+
description_field?: string | undefined;
|
71
|
+
icon?: string | undefined;
|
72
|
+
sort_key?: number | undefined;
|
73
|
+
max_options_count?: number | null | undefined;
|
74
|
+
sortFunction?: any;
|
75
|
+
default_command_id?: string | number | undefined;
|
76
|
+
render_as?: "grid" | "list" | undefined;
|
77
|
+
showResources?: boolean | undefined;
|
78
|
+
show_with_no_results?: boolean | undefined;
|
79
|
+
search_tab_enabled?: boolean | undefined;
|
80
|
+
search_tab_name?: string | null | undefined;
|
81
|
+
search_tab_instruction?: string | null | undefined;
|
82
|
+
setting_pin_to_bottom?: boolean | undefined;
|
83
|
+
track_recents?: boolean | undefined;
|
84
|
+
};
|
85
|
+
};
|
86
|
+
should_show_onboarding: boolean;
|
87
|
+
last_snippet_request: string | null;
|
88
|
+
last_snippet_request_in_production: string | null;
|
89
|
+
branding: string;
|
90
|
+
custom_call_to_action: string;
|
91
|
+
search_fuzzy_threshold: number | null;
|
92
|
+
show_skin_editor: boolean;
|
93
|
+
allow_event_handlers: boolean;
|
94
|
+
in_bar_feedback: boolean;
|
95
|
+
summon_hotkey_override: string | null;
|
96
|
+
end_user_hotkeys: boolean | undefined;
|
97
|
+
end_user_shortcuts_enabled: boolean;
|
98
|
+
end_user_recents_enabled: boolean;
|
99
|
+
releases_available: boolean;
|
100
|
+
releases_enabled: boolean;
|
101
|
+
fallback_commands: number[];
|
102
|
+
tab_direction: "horizontal" | "vertical";
|
103
|
+
}>;
|
104
|
+
static update: (object: {
|
105
|
+
id: string | number;
|
106
|
+
name: string;
|
107
|
+
created: string;
|
108
|
+
} & {} & {
|
109
|
+
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
110
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
111
|
+
show_launcher_recommendations: boolean;
|
112
|
+
recommendations_type: "None" | "Custom" | "Algorithm";
|
113
|
+
launcher_offset_x: number;
|
114
|
+
launcher_offset_y: number;
|
115
|
+
theme: object;
|
116
|
+
icon: string;
|
117
|
+
icon_suggest: string;
|
118
|
+
icon_tutorial: string;
|
119
|
+
icon_go_forward: string;
|
120
|
+
resource_options: {
|
121
|
+
[x: string]: {
|
122
|
+
name?: string | undefined;
|
123
|
+
search?: boolean | undefined;
|
124
|
+
label_field?: string | undefined;
|
125
|
+
useCategory?: boolean | undefined;
|
126
|
+
search_fields?: (string | {
|
127
|
+
key: string;
|
128
|
+
label: string;
|
129
|
+
})[] | undefined;
|
130
|
+
auto_execute?: boolean | undefined;
|
131
|
+
unfurl?: boolean | undefined;
|
132
|
+
description_field?: string | undefined;
|
133
|
+
icon?: string | undefined;
|
134
|
+
sort_key?: number | undefined;
|
135
|
+
max_options_count?: number | null | undefined;
|
136
|
+
sortFunction?: any;
|
137
|
+
default_command_id?: string | number | undefined;
|
138
|
+
render_as?: "grid" | "list" | undefined;
|
139
|
+
showResources?: boolean | undefined;
|
140
|
+
show_with_no_results?: boolean | undefined;
|
141
|
+
search_tab_enabled?: boolean | undefined;
|
142
|
+
search_tab_name?: string | null | undefined;
|
143
|
+
search_tab_instruction?: string | null | undefined;
|
144
|
+
setting_pin_to_bottom?: boolean | undefined;
|
145
|
+
track_recents?: boolean | undefined;
|
146
|
+
};
|
147
|
+
};
|
148
|
+
should_show_onboarding: boolean;
|
149
|
+
last_snippet_request: string | null;
|
150
|
+
last_snippet_request_in_production: string | null;
|
151
|
+
branding: string;
|
152
|
+
custom_call_to_action: string;
|
153
|
+
search_fuzzy_threshold: number | null;
|
154
|
+
show_skin_editor: boolean;
|
155
|
+
allow_event_handlers: boolean;
|
156
|
+
in_bar_feedback: boolean;
|
157
|
+
summon_hotkey_override: string | null;
|
158
|
+
end_user_hotkeys: boolean | undefined;
|
159
|
+
end_user_shortcuts_enabled: boolean;
|
160
|
+
end_user_recents_enabled: boolean;
|
161
|
+
releases_available: boolean;
|
162
|
+
releases_enabled: boolean;
|
163
|
+
fallback_commands: number[];
|
164
|
+
tab_direction: "horizontal" | "vertical";
|
165
|
+
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
166
|
+
id: string | number;
|
167
|
+
name: string;
|
168
|
+
created: string;
|
169
|
+
} & {} & {
|
170
|
+
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
171
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
172
|
+
show_launcher_recommendations: boolean;
|
173
|
+
recommendations_type: "None" | "Custom" | "Algorithm";
|
174
|
+
launcher_offset_x: number;
|
175
|
+
launcher_offset_y: number;
|
176
|
+
theme: object;
|
177
|
+
icon: string;
|
178
|
+
icon_suggest: string;
|
179
|
+
icon_tutorial: string;
|
180
|
+
icon_go_forward: string;
|
181
|
+
resource_options: {
|
182
|
+
[x: string]: {
|
183
|
+
name?: string | undefined;
|
184
|
+
search?: boolean | undefined;
|
185
|
+
label_field?: string | undefined;
|
186
|
+
useCategory?: boolean | undefined;
|
187
|
+
search_fields?: (string | {
|
188
|
+
key: string;
|
189
|
+
label: string;
|
190
|
+
})[] | undefined;
|
191
|
+
auto_execute?: boolean | undefined;
|
192
|
+
unfurl?: boolean | undefined;
|
193
|
+
description_field?: string | undefined;
|
194
|
+
icon?: string | undefined;
|
195
|
+
sort_key?: number | undefined;
|
196
|
+
max_options_count?: number | null | undefined;
|
197
|
+
sortFunction?: any;
|
198
|
+
default_command_id?: string | number | undefined;
|
199
|
+
render_as?: "grid" | "list" | undefined;
|
200
|
+
showResources?: boolean | undefined;
|
201
|
+
show_with_no_results?: boolean | undefined;
|
202
|
+
search_tab_enabled?: boolean | undefined;
|
203
|
+
search_tab_name?: string | null | undefined;
|
204
|
+
search_tab_instruction?: string | null | undefined;
|
205
|
+
setting_pin_to_bottom?: boolean | undefined;
|
206
|
+
track_recents?: boolean | undefined;
|
207
|
+
};
|
208
|
+
};
|
209
|
+
should_show_onboarding: boolean;
|
210
|
+
last_snippet_request: string | null;
|
211
|
+
last_snippet_request_in_production: string | null;
|
212
|
+
branding: string;
|
213
|
+
custom_call_to_action: string;
|
214
|
+
search_fuzzy_threshold: number | null;
|
215
|
+
show_skin_editor: boolean;
|
216
|
+
allow_event_handlers: boolean;
|
217
|
+
in_bar_feedback: boolean;
|
218
|
+
summon_hotkey_override: string | null;
|
219
|
+
end_user_hotkeys: boolean | undefined;
|
220
|
+
end_user_shortcuts_enabled: boolean;
|
221
|
+
end_user_recents_enabled: boolean;
|
222
|
+
releases_available: boolean;
|
223
|
+
releases_enabled: boolean;
|
224
|
+
fallback_commands: number[];
|
225
|
+
tab_direction: "horizontal" | "vertical";
|
226
|
+
}>;
|
227
|
+
static listCommands: (orgUID: string) => Promise<({
|
228
|
+
id: number;
|
229
|
+
organization: string | number;
|
230
|
+
text: string;
|
231
|
+
template: ({
|
232
|
+
type: "admin";
|
233
|
+
value: string;
|
234
|
+
} & {} & {
|
235
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
236
|
+
object?: string | undefined;
|
237
|
+
hoverTooltip?: boolean | undefined;
|
238
|
+
operation?: "self" | "router" | "blank" | undefined;
|
239
|
+
}) | ({
|
240
|
+
type: "callback";
|
241
|
+
value: string;
|
242
|
+
} & {} & {
|
243
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
244
|
+
object?: string | undefined;
|
245
|
+
hoverTooltip?: boolean | undefined;
|
246
|
+
operation?: "self" | "router" | "blank" | undefined;
|
247
|
+
}) | ({
|
248
|
+
type: "link";
|
249
|
+
value: string;
|
250
|
+
} & {} & {
|
251
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
252
|
+
object?: string | undefined;
|
253
|
+
hoverTooltip?: boolean | undefined;
|
254
|
+
operation?: "self" | "router" | "blank" | undefined;
|
255
|
+
}) | ({
|
256
|
+
type: "click" | "clickByXpath" | "clickBySelector";
|
257
|
+
value: string[];
|
258
|
+
} & {} & {
|
259
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
260
|
+
object?: string | undefined;
|
261
|
+
hoverTooltip?: boolean | undefined;
|
262
|
+
operation?: "self" | "router" | "blank" | undefined;
|
263
|
+
}) | ({
|
264
|
+
type: "builtin";
|
265
|
+
value: string;
|
266
|
+
} & {} & {
|
267
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
268
|
+
object?: string | undefined;
|
269
|
+
hoverTooltip?: boolean | undefined;
|
270
|
+
operation?: "self" | "router" | "blank" | undefined;
|
271
|
+
}) | ({
|
272
|
+
type: "webhook";
|
273
|
+
value: string;
|
274
|
+
} & {} & {
|
275
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
276
|
+
object?: string | undefined;
|
277
|
+
hoverTooltip?: boolean | undefined;
|
278
|
+
operation?: "self" | "router" | "blank" | undefined;
|
279
|
+
}) | ({
|
280
|
+
type: "script";
|
281
|
+
value: string;
|
282
|
+
} & {} & {
|
283
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
284
|
+
object?: string | undefined;
|
285
|
+
hoverTooltip?: boolean | undefined;
|
286
|
+
operation?: "self" | "router" | "blank" | undefined;
|
287
|
+
}) | ({
|
288
|
+
type: "request";
|
289
|
+
value: {
|
290
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
291
|
+
url: string;
|
292
|
+
} & {
|
293
|
+
headers?: {
|
294
|
+
[key: string]: unknown;
|
295
|
+
} | undefined;
|
296
|
+
body?: {
|
297
|
+
[key: string]: unknown;
|
298
|
+
} | undefined;
|
299
|
+
onSend?: string | undefined;
|
300
|
+
onSuccess?: string | undefined;
|
301
|
+
onError?: string | undefined;
|
302
|
+
};
|
303
|
+
} & {} & {
|
304
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
305
|
+
object?: string | undefined;
|
306
|
+
hoverTooltip?: boolean | undefined;
|
307
|
+
operation?: "self" | "router" | "blank" | undefined;
|
308
|
+
}) | ({
|
309
|
+
type: "appcues";
|
310
|
+
value: string;
|
311
|
+
} & {} & {
|
312
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
313
|
+
object?: string | undefined;
|
314
|
+
hoverTooltip?: boolean | undefined;
|
315
|
+
operation?: "self" | "router" | "blank" | undefined;
|
316
|
+
});
|
317
|
+
} & {
|
318
|
+
disabledReason?: string | undefined;
|
319
|
+
source?: string | undefined;
|
320
|
+
name?: string | undefined;
|
321
|
+
last_available?: string | null | undefined;
|
322
|
+
modified?: string | undefined;
|
323
|
+
} & {
|
324
|
+
arguments: {
|
325
|
+
[x: string]: ({
|
326
|
+
type: "context";
|
327
|
+
value: string;
|
328
|
+
order_key: number;
|
329
|
+
} & {
|
330
|
+
label?: string | undefined;
|
331
|
+
chosen?: string | number | undefined;
|
332
|
+
selected?: any[] | undefined;
|
333
|
+
input_type?: string | undefined;
|
334
|
+
preselected_key?: string | undefined;
|
335
|
+
label_field?: string | undefined;
|
336
|
+
availability_condition?: {
|
337
|
+
field: string;
|
338
|
+
operator: "==" | "!=" | "isTruthy" | "isFalsy";
|
339
|
+
value: string | undefined;
|
340
|
+
}[] | undefined;
|
341
|
+
loaded?: any[] | undefined;
|
342
|
+
allow_create?: boolean | undefined;
|
343
|
+
allow_create_label?: string | undefined;
|
344
|
+
show_in_record_action_list?: boolean | undefined;
|
345
|
+
show_in_default_list?: boolean | undefined;
|
346
|
+
}) | ({
|
347
|
+
type: "set";
|
348
|
+
value: string[] | number[] | {
|
349
|
+
[key: string]: unknown;
|
350
|
+
}[];
|
351
|
+
order_key: number;
|
352
|
+
} & {
|
353
|
+
label?: string | undefined;
|
354
|
+
chosen?: string | number | undefined;
|
355
|
+
selected?: any[] | undefined;
|
356
|
+
input_type?: string | undefined;
|
357
|
+
preselected_key?: string | undefined;
|
358
|
+
label_field?: string | undefined;
|
359
|
+
availability_condition?: {
|
360
|
+
field: string;
|
361
|
+
operator: "==" | "!=" | "isTruthy" | "isFalsy";
|
362
|
+
value: string | undefined;
|
363
|
+
}[] | undefined;
|
364
|
+
loaded?: any[] | undefined;
|
365
|
+
allow_create?: boolean | undefined;
|
366
|
+
allow_create_label?: string | undefined;
|
367
|
+
}) | ({
|
368
|
+
type: "provided";
|
369
|
+
value: "time" | "text";
|
370
|
+
order_key: number;
|
371
|
+
} & {
|
372
|
+
label?: string | undefined;
|
373
|
+
chosen?: string | number | undefined;
|
374
|
+
selected?: any[] | undefined;
|
375
|
+
input_type?: string | undefined;
|
376
|
+
preselected_key?: string | undefined;
|
377
|
+
label_field?: string | undefined;
|
378
|
+
availability_condition?: {
|
379
|
+
field: string;
|
380
|
+
operator: "==" | "!=" | "isTruthy" | "isFalsy";
|
381
|
+
value: string | undefined;
|
382
|
+
}[] | undefined;
|
383
|
+
loaded?: any[] | undefined;
|
384
|
+
dateTimeArgumentTypeId?: number | undefined;
|
385
|
+
allow_create?: boolean | undefined;
|
386
|
+
allow_create_label?: string | undefined;
|
387
|
+
}) | ({
|
388
|
+
type: "dependent";
|
389
|
+
value: string;
|
390
|
+
order_key: number;
|
391
|
+
} & {
|
392
|
+
label?: string | undefined;
|
393
|
+
chosen?: string | number | undefined;
|
394
|
+
selected?: any[] | undefined;
|
395
|
+
input_type?: string | undefined;
|
396
|
+
preselected_key?: string | undefined;
|
397
|
+
label_field?: string | undefined;
|
398
|
+
availability_condition?: {
|
399
|
+
field: string;
|
400
|
+
operator: "==" | "!=" | "isTruthy" | "isFalsy";
|
401
|
+
value: string | undefined;
|
402
|
+
}[] | undefined;
|
403
|
+
loaded?: any[] | undefined;
|
404
|
+
allow_create?: boolean | undefined;
|
405
|
+
allow_create_label?: string | undefined;
|
406
|
+
}) | ({
|
407
|
+
type: "function";
|
408
|
+
value: string;
|
409
|
+
order_key: number;
|
410
|
+
} & {
|
411
|
+
label?: string | undefined;
|
412
|
+
chosen?: string | number | undefined;
|
413
|
+
selected?: any[] | undefined;
|
414
|
+
input_type?: string | undefined;
|
415
|
+
preselected_key?: string | undefined;
|
416
|
+
label_field?: string | undefined;
|
417
|
+
availability_condition?: {
|
418
|
+
field: string;
|
419
|
+
operator: "==" | "!=" | "isTruthy" | "isFalsy";
|
420
|
+
value: string | undefined;
|
421
|
+
}[] | undefined;
|
422
|
+
loaded?: any[] | undefined;
|
423
|
+
allow_create?: boolean | undefined;
|
424
|
+
allow_create_label?: string | undefined;
|
425
|
+
});
|
426
|
+
};
|
427
|
+
tags: string[];
|
428
|
+
availability_rules: ({
|
429
|
+
type: "url" | "context" | "element";
|
430
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
431
|
+
} & {
|
432
|
+
field?: string | undefined;
|
433
|
+
value?: string | undefined;
|
434
|
+
reason?: string | undefined;
|
435
|
+
})[];
|
436
|
+
recommend_rules: (({
|
437
|
+
type: "always";
|
438
|
+
} & {
|
439
|
+
operator?: null | undefined;
|
440
|
+
field?: null | undefined;
|
441
|
+
value?: null | undefined;
|
442
|
+
reason?: null | undefined;
|
443
|
+
}) | ({
|
444
|
+
type: "url" | "context" | "element";
|
445
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
446
|
+
} & {
|
447
|
+
field?: string | undefined;
|
448
|
+
value?: string | undefined;
|
449
|
+
reason?: string | undefined;
|
450
|
+
}))[];
|
451
|
+
confirm: string;
|
452
|
+
shortcut: string[];
|
453
|
+
explanation: string;
|
454
|
+
is_live: boolean;
|
455
|
+
category: number | null;
|
456
|
+
sort_key: number | null;
|
457
|
+
icon: string | null;
|
458
|
+
celebrate: boolean | {
|
459
|
+
angle?: number | undefined;
|
460
|
+
spread?: number | undefined;
|
461
|
+
width?: string | undefined;
|
462
|
+
height?: string | undefined;
|
463
|
+
duration?: number | undefined;
|
464
|
+
dragFriction?: number | undefined;
|
465
|
+
stagger?: number | undefined;
|
466
|
+
startVelocity?: number | undefined;
|
467
|
+
elementCount?: number | undefined;
|
468
|
+
decay?: number | undefined;
|
469
|
+
colors?: string[] | undefined;
|
470
|
+
random?: any;
|
471
|
+
} | null;
|
472
|
+
recommend_sort_key: number | null;
|
473
|
+
shortcut_mac: string[];
|
474
|
+
shortcut_win: string[];
|
475
|
+
hotkey_mac: string;
|
476
|
+
hotkey_win: string;
|
477
|
+
detail: string | {
|
478
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
|
479
|
+
value: string;
|
480
|
+
} | (string | {
|
481
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
|
482
|
+
value: string;
|
483
|
+
})[] | null;
|
484
|
+
})[]>;
|
485
|
+
static listCommandCategories: (orgUID: string) => Promise<({
|
486
|
+
id: number;
|
487
|
+
organization: string | number;
|
488
|
+
name: string;
|
489
|
+
} & {} & {
|
490
|
+
sort_key: number | null;
|
491
|
+
icon: string | null;
|
492
|
+
render_as: "grid" | "list";
|
493
|
+
setting_hide_before_search: boolean;
|
494
|
+
setting_max_options_count: number | null;
|
495
|
+
setting_pin_to_bottom: boolean;
|
496
|
+
search_tab_enabled: boolean;
|
497
|
+
search_tab_name: string;
|
498
|
+
search_tab_instruction: string;
|
499
|
+
track_recents: boolean;
|
500
|
+
})[]>;
|
501
|
+
static listGuides: (orgUID: string) => Promise<({
|
502
|
+
id: number;
|
503
|
+
organization: string;
|
504
|
+
event: string;
|
505
|
+
nudge: string;
|
506
|
+
guidance: string;
|
507
|
+
} & {})[]>;
|
508
|
+
static listContexts: (orgUID: string) => Promise<({
|
509
|
+
id: number;
|
510
|
+
name: string;
|
511
|
+
organization: string;
|
512
|
+
value: {
|
513
|
+
[x: string]: any;
|
514
|
+
};
|
515
|
+
} & {})[]>;
|
516
|
+
static listPlaceholders: (orgUID: string) => Promise<({
|
517
|
+
id: number;
|
518
|
+
organization: string;
|
519
|
+
slug: string;
|
520
|
+
text: string;
|
521
|
+
} & {})[]>;
|
522
|
+
static listRules: (orgUID: string) => Promise<{
|
523
|
+
id: number;
|
524
|
+
name: string;
|
525
|
+
conditions: ({
|
526
|
+
type: "url" | "context" | "element";
|
527
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
528
|
+
} & {
|
529
|
+
field?: string | undefined;
|
530
|
+
value?: string | undefined;
|
531
|
+
reason?: string | undefined;
|
532
|
+
})[];
|
533
|
+
}[]>;
|
534
|
+
static userHasAccess: (uuid: string, user: string) => Promise<{
|
535
|
+
username: string;
|
536
|
+
slug: string;
|
537
|
+
organization: string;
|
538
|
+
has_access: boolean;
|
539
|
+
has_opened: boolean;
|
540
|
+
hotkeys_debug: boolean;
|
541
|
+
hmac: string | undefined;
|
542
|
+
}>;
|
543
|
+
static readHealth: (arg0: string, urlArgs?: {
|
544
|
+
[arg: string]: string;
|
545
|
+
} | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
546
|
+
id: string | number;
|
547
|
+
uuid: string;
|
548
|
+
errors_72h: number;
|
549
|
+
suggestions_72h: number;
|
550
|
+
executions_total: number;
|
551
|
+
users_total: number;
|
552
|
+
}>;
|
553
|
+
static readInternal: (arg0: string, urlArgs?: {
|
554
|
+
[arg: string]: string;
|
555
|
+
} | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
556
|
+
id: string;
|
557
|
+
integrations: {
|
558
|
+
[x: string]: {
|
559
|
+
[x: string]: string;
|
560
|
+
};
|
561
|
+
};
|
562
|
+
}>;
|
563
|
+
static updateInternal: (object: {
|
564
|
+
id: string;
|
565
|
+
integrations: {
|
566
|
+
[x: string]: {
|
567
|
+
[x: string]: string;
|
568
|
+
};
|
569
|
+
};
|
570
|
+
}, urlArgs?: {
|
571
|
+
[arg: string]: string;
|
572
|
+
} | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
573
|
+
id: string;
|
574
|
+
integrations: {
|
575
|
+
[x: string]: {
|
576
|
+
[x: string]: string;
|
577
|
+
};
|
578
|
+
};
|
579
|
+
}>;
|
580
|
+
static readSettings: (params?: Record<string, string> | undefined, callbacks?: {
|
581
|
+
onSuccess?: (() => void) | undefined;
|
582
|
+
onError?: ((err: string) => void) | undefined;
|
583
|
+
} | undefined) => Promise<{
|
584
|
+
end_user_limit: number;
|
585
|
+
user_seat_limit: number;
|
586
|
+
analytics_dashboard_execution_limit: number;
|
587
|
+
analytics_dashboard_deadend_limit: number;
|
588
|
+
silent_mode: boolean;
|
589
|
+
allow_event_handlers: boolean;
|
590
|
+
event_attribute_block_list: string[];
|
591
|
+
skins_limit: number;
|
592
|
+
skins_field_set: "basic" | "pro";
|
593
|
+
show_countdown_banner: boolean;
|
594
|
+
can_install_foobar: boolean;
|
595
|
+
releases_available: boolean;
|
596
|
+
releases_enabled: boolean;
|
597
|
+
releases_environments: string[];
|
598
|
+
in_bar_feedback: boolean;
|
599
|
+
summon_hotkey_override: string | null;
|
600
|
+
end_user_shortcuts_enabled: boolean;
|
601
|
+
fallback_commands: number[];
|
602
|
+
end_user_recents_enabled: boolean;
|
603
|
+
}>;
|
604
|
+
static updateSetting: (object: {
|
605
|
+
end_user_limit?: number | undefined;
|
606
|
+
user_seat_limit?: number | undefined;
|
607
|
+
analytics_dashboard_execution_limit?: number | undefined;
|
608
|
+
analytics_dashboard_deadend_limit?: number | undefined;
|
609
|
+
silent_mode?: boolean | undefined;
|
610
|
+
allow_event_handlers?: boolean | undefined;
|
611
|
+
event_attribute_block_list?: string[] | undefined;
|
612
|
+
skins_limit?: number | undefined;
|
613
|
+
skins_field_set?: "basic" | "pro" | undefined;
|
614
|
+
show_countdown_banner?: boolean | undefined;
|
615
|
+
can_install_foobar?: boolean | undefined;
|
616
|
+
releases_available?: boolean | undefined;
|
617
|
+
releases_enabled?: boolean | undefined;
|
618
|
+
releases_environments?: string[] | undefined;
|
619
|
+
in_bar_feedback?: boolean | undefined;
|
620
|
+
summon_hotkey_override?: string | null | undefined;
|
621
|
+
end_user_shortcuts_enabled?: boolean | undefined;
|
622
|
+
fallback_commands?: number[] | undefined;
|
623
|
+
end_user_recents_enabled?: boolean | undefined;
|
624
|
+
}, params?: Record<string, string> | undefined, callbacks?: {
|
625
|
+
onSuccess?: (() => void) | undefined;
|
626
|
+
onError?: ((err: string) => void) | undefined;
|
627
|
+
} | undefined) => Promise<{
|
628
|
+
end_user_limit: number;
|
629
|
+
user_seat_limit: number;
|
630
|
+
analytics_dashboard_execution_limit: number;
|
631
|
+
analytics_dashboard_deadend_limit: number;
|
632
|
+
silent_mode: boolean;
|
633
|
+
allow_event_handlers: boolean;
|
634
|
+
event_attribute_block_list: string[];
|
635
|
+
skins_limit: number;
|
636
|
+
skins_field_set: "basic" | "pro";
|
637
|
+
show_countdown_banner: boolean;
|
638
|
+
can_install_foobar: boolean;
|
639
|
+
releases_available: boolean;
|
640
|
+
releases_enabled: boolean;
|
641
|
+
releases_environments: string[];
|
642
|
+
in_bar_feedback: boolean;
|
643
|
+
summon_hotkey_override: string | null;
|
644
|
+
end_user_shortcuts_enabled: boolean;
|
645
|
+
fallback_commands: number[];
|
646
|
+
end_user_recents_enabled: boolean;
|
647
|
+
}>;
|
648
|
+
static decode: (data: any) => {
|
649
|
+
id: string | number;
|
650
|
+
name: string;
|
651
|
+
created: string;
|
652
|
+
} & {} & {
|
653
|
+
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
654
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
655
|
+
show_launcher_recommendations: boolean;
|
656
|
+
recommendations_type: "None" | "Custom" | "Algorithm";
|
657
|
+
launcher_offset_x: number;
|
658
|
+
launcher_offset_y: number;
|
659
|
+
theme: object;
|
660
|
+
icon: string;
|
661
|
+
icon_suggest: string;
|
662
|
+
icon_tutorial: string;
|
663
|
+
icon_go_forward: string;
|
664
|
+
resource_options: {
|
665
|
+
[x: string]: {
|
666
|
+
name?: string | undefined;
|
667
|
+
search?: boolean | undefined;
|
668
|
+
label_field?: string | undefined;
|
669
|
+
useCategory?: boolean | undefined;
|
670
|
+
search_fields?: (string | {
|
671
|
+
key: string;
|
672
|
+
label: string;
|
673
|
+
})[] | undefined;
|
674
|
+
auto_execute?: boolean | undefined;
|
675
|
+
unfurl?: boolean | undefined;
|
676
|
+
description_field?: string | undefined;
|
677
|
+
icon?: string | undefined;
|
678
|
+
sort_key?: number | undefined;
|
679
|
+
max_options_count?: number | null | undefined;
|
680
|
+
sortFunction?: any;
|
681
|
+
default_command_id?: string | number | undefined;
|
682
|
+
render_as?: "grid" | "list" | undefined;
|
683
|
+
showResources?: boolean | undefined;
|
684
|
+
show_with_no_results?: boolean | undefined;
|
685
|
+
search_tab_enabled?: boolean | undefined;
|
686
|
+
search_tab_name?: string | null | undefined;
|
687
|
+
search_tab_instruction?: string | null | undefined;
|
688
|
+
setting_pin_to_bottom?: boolean | undefined;
|
689
|
+
track_recents?: boolean | undefined;
|
690
|
+
};
|
691
|
+
};
|
692
|
+
should_show_onboarding: boolean;
|
693
|
+
last_snippet_request: string | null;
|
694
|
+
last_snippet_request_in_production: string | null;
|
695
|
+
branding: string;
|
696
|
+
custom_call_to_action: string;
|
697
|
+
search_fuzzy_threshold: number | null;
|
698
|
+
show_skin_editor: boolean;
|
699
|
+
allow_event_handlers: boolean;
|
700
|
+
in_bar_feedback: boolean;
|
701
|
+
summon_hotkey_override: string | null;
|
702
|
+
end_user_hotkeys: boolean | undefined;
|
703
|
+
end_user_shortcuts_enabled: boolean;
|
704
|
+
end_user_recents_enabled: boolean;
|
705
|
+
releases_available: boolean;
|
706
|
+
releases_enabled: boolean;
|
707
|
+
fallback_commands: number[];
|
708
|
+
tab_direction: "horizontal" | "vertical";
|
709
|
+
};
|
710
|
+
}
|