commandbar 1.6.15 → 1.7.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.d.ts +2 -0
- package/build/commandbar-js/src/index.js +2 -1
- package/build/commandbar-js/src/index.js.LICENSE.txt +14 -0
- package/build/internal/src/client/AddContextOptions.d.ts +4 -0
- package/build/internal/src/client/CommandBarClientSDK.d.ts +32 -12
- package/build/internal/src/client/CommandBarProxySDK.d.ts +2 -1
- package/build/internal/src/client/CommandBarSDK.d.ts +3 -1
- package/build/internal/src/client/EventHandler.d.ts +19 -2
- package/build/internal/src/client/symbols.d.ts +1 -0
- package/build/internal/src/middleware/CommandFromClientV.d.ts +11 -2
- package/build/internal/src/middleware/OrganizationV.d.ts +24 -0
- package/build/internal/src/middleware/ResourceSettingsV.d.ts +24 -0
- package/build/internal/src/middleware/command.d.ts +293 -259
- package/build/internal/src/middleware/commandCategory.d.ts +8 -0
- package/build/internal/src/middleware/detailPreview.d.ts +3 -6
- package/build/internal/src/middleware/nudge.d.ts +24 -8
- package/build/internal/src/middleware/organization.d.ts +67 -17
- package/build/internal/src/middleware/tab.d.ts +27 -0
- package/build/internal/src/middleware/types.d.ts +24 -17
- package/build/internal/src/middleware/user.d.ts +1 -1
- package/package.json +7 -3
- package/src/commandbar-launcher.d.ts +7 -0
- package/src/index.ts +2 -0
- package/src/snippet.ts +5 -1
@@ -8,6 +8,7 @@ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC
|
|
8
8
|
}>, t.PartialC<{}>]>, t.TypeC<{
|
9
9
|
sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
10
10
|
icon: t.UnionC<[t.StringC, t.NullC]>;
|
11
|
+
image: t.UnionC<[t.StringC, t.NullC]>;
|
11
12
|
render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
|
12
13
|
setting_hide_before_search: t.BooleanC;
|
13
14
|
setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
|
@@ -27,6 +28,7 @@ export declare const BatchEditorCategoryResponseV: t.TypeC<{
|
|
27
28
|
}>, t.PartialC<{}>]>, t.TypeC<{
|
28
29
|
sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
29
30
|
icon: t.UnionC<[t.StringC, t.NullC]>;
|
31
|
+
image: t.UnionC<[t.StringC, t.NullC]>;
|
30
32
|
render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
|
31
33
|
setting_hide_before_search: t.BooleanC;
|
32
34
|
setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
|
@@ -47,6 +49,7 @@ export declare class CommandCategory {
|
|
47
49
|
} & {} & {
|
48
50
|
sort_key: number | null;
|
49
51
|
icon: string | null;
|
52
|
+
image: string | null;
|
50
53
|
render_as: "grid" | "list";
|
51
54
|
setting_hide_before_search: boolean;
|
52
55
|
setting_max_options_count: number | null;
|
@@ -64,6 +67,7 @@ export declare class CommandCategory {
|
|
64
67
|
} & {} & {
|
65
68
|
sort_key: number | null;
|
66
69
|
icon: string | null;
|
70
|
+
image: string | null;
|
67
71
|
render_as: "grid" | "list";
|
68
72
|
setting_hide_before_search: boolean;
|
69
73
|
setting_max_options_count: number | null;
|
@@ -82,6 +86,7 @@ export declare class CommandCategory {
|
|
82
86
|
} & {} & {
|
83
87
|
sort_key: number | null;
|
84
88
|
icon: string | null;
|
89
|
+
image: string | null;
|
85
90
|
render_as: "grid" | "list";
|
86
91
|
setting_hide_before_search: boolean;
|
87
92
|
setting_max_options_count: number | null;
|
@@ -99,6 +104,7 @@ export declare class CommandCategory {
|
|
99
104
|
} & {} & {
|
100
105
|
sort_key: number | null;
|
101
106
|
icon: string | null;
|
107
|
+
image: string | null;
|
102
108
|
render_as: "grid" | "list";
|
103
109
|
setting_hide_before_search: boolean;
|
104
110
|
setting_max_options_count: number | null;
|
@@ -118,6 +124,7 @@ export declare class CommandCategory {
|
|
118
124
|
} & {} & {
|
119
125
|
sort_key: number | null;
|
120
126
|
icon: string | null;
|
127
|
+
image: string | null;
|
121
128
|
render_as: "grid" | "list";
|
122
129
|
setting_hide_before_search: boolean;
|
123
130
|
setting_max_options_count: number | null;
|
@@ -137,6 +144,7 @@ export declare class CommandCategory {
|
|
137
144
|
} & {} & {
|
138
145
|
sort_key: number | null;
|
139
146
|
icon: string | null;
|
147
|
+
image: string | null;
|
140
148
|
render_as: "grid" | "list";
|
141
149
|
setting_hide_before_search: boolean;
|
142
150
|
setting_max_options_count: number | null;
|
@@ -1,14 +1,14 @@
|
|
1
1
|
/*******************************************************************************/
|
2
2
|
import * as t from 'io-ts';
|
3
3
|
export declare const DetailPreviewObjectV: t.IntersectionC<[t.TypeC<{
|
4
|
-
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.
|
4
|
+
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
|
5
5
|
value: t.StringC;
|
6
6
|
}>, t.PartialC<{
|
7
7
|
position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
|
8
8
|
}>]>;
|
9
9
|
export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV>;
|
10
10
|
export declare type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
|
11
|
-
export declare type
|
11
|
+
export declare type DataRowMetadata = {
|
12
12
|
type: 'command' | 'parameter';
|
13
13
|
label: string;
|
14
14
|
value: any;
|
@@ -17,7 +17,4 @@ export declare type DataRowMedata = {
|
|
17
17
|
};
|
18
18
|
export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
|
19
19
|
export declare const standardize: (item: undefined | null | DetailPreviewType) => null | DetailPreviewObjectType[];
|
20
|
-
export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType |
|
21
|
-
type: null;
|
22
|
-
value: null;
|
23
|
-
};
|
20
|
+
export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType | null;
|
@@ -21,7 +21,9 @@ export declare const NudgeV: t.IntersectionC<[t.TypeC<{
|
|
21
21
|
}>;
|
22
22
|
timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
|
23
23
|
frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">]>;
|
24
|
-
}>, t.PartialC<{
|
24
|
+
}>, t.PartialC<{
|
25
|
+
is_live: t.BooleanC;
|
26
|
+
}>]>;
|
25
27
|
export declare class Nudge {
|
26
28
|
static decode: (data: any) => {
|
27
29
|
id: number;
|
@@ -45,7 +47,9 @@ export declare class Nudge {
|
|
45
47
|
};
|
46
48
|
timeout_ms: number | null;
|
47
49
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
48
|
-
} & {
|
50
|
+
} & {
|
51
|
+
is_live?: boolean | undefined;
|
52
|
+
};
|
49
53
|
static create: (object: {
|
50
54
|
id: number;
|
51
55
|
organization: string;
|
@@ -68,7 +72,9 @@ export declare class Nudge {
|
|
68
72
|
};
|
69
73
|
timeout_ms: number | null;
|
70
74
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
71
|
-
} & {
|
75
|
+
} & {
|
76
|
+
is_live?: boolean | undefined;
|
77
|
+
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
72
78
|
id: number;
|
73
79
|
organization: string;
|
74
80
|
slug: string;
|
@@ -90,7 +96,9 @@ export declare class Nudge {
|
|
90
96
|
};
|
91
97
|
timeout_ms: number | null;
|
92
98
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
93
|
-
} & {
|
99
|
+
} & {
|
100
|
+
is_live?: boolean | undefined;
|
101
|
+
}>;
|
94
102
|
static update: (object: {
|
95
103
|
id: number;
|
96
104
|
organization: string;
|
@@ -113,7 +121,9 @@ export declare class Nudge {
|
|
113
121
|
};
|
114
122
|
timeout_ms: number | null;
|
115
123
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
116
|
-
} & {
|
124
|
+
} & {
|
125
|
+
is_live?: boolean | undefined;
|
126
|
+
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
117
127
|
id: number;
|
118
128
|
organization: string;
|
119
129
|
slug: string;
|
@@ -135,7 +145,9 @@ export declare class Nudge {
|
|
135
145
|
};
|
136
146
|
timeout_ms: number | null;
|
137
147
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
138
|
-
} & {
|
148
|
+
} & {
|
149
|
+
is_live?: boolean | undefined;
|
150
|
+
}>;
|
139
151
|
static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
|
140
152
|
static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
|
141
153
|
id: number;
|
@@ -159,7 +171,9 @@ export declare class Nudge {
|
|
159
171
|
};
|
160
172
|
timeout_ms: number | null;
|
161
173
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
162
|
-
} & {
|
174
|
+
} & {
|
175
|
+
is_live?: boolean | undefined;
|
176
|
+
})[]>;
|
163
177
|
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
164
178
|
onSuccess?: (() => void) | undefined;
|
165
179
|
onError?: ((err: string) => void) | undefined;
|
@@ -185,5 +199,7 @@ export declare class Nudge {
|
|
185
199
|
};
|
186
200
|
timeout_ms: number | null;
|
187
201
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
188
|
-
} & {
|
202
|
+
} & {
|
203
|
+
is_live?: boolean | undefined;
|
204
|
+
}>;
|
189
205
|
}
|
@@ -76,6 +76,7 @@ export declare class Organization {
|
|
76
76
|
unfurl?: boolean | undefined;
|
77
77
|
description_field?: string | undefined;
|
78
78
|
icon?: string | undefined;
|
79
|
+
image?: string | undefined;
|
79
80
|
sort_key?: number | undefined;
|
80
81
|
max_options_count?: number | null | undefined;
|
81
82
|
sortFunction?: any;
|
@@ -90,6 +91,17 @@ export declare class Organization {
|
|
90
91
|
search_tab_instruction?: string | null | undefined;
|
91
92
|
setting_pin_to_bottom?: boolean | undefined;
|
92
93
|
track_recents?: boolean | undefined;
|
94
|
+
detail?: string | ({
|
95
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
96
|
+
value: string;
|
97
|
+
} & {
|
98
|
+
position?: "inline" | "popover" | undefined;
|
99
|
+
}) | (string | ({
|
100
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
101
|
+
value: string;
|
102
|
+
} & {
|
103
|
+
position?: "inline" | "popover" | undefined;
|
104
|
+
}))[] | null | undefined;
|
93
105
|
};
|
94
106
|
};
|
95
107
|
should_show_onboarding: boolean;
|
@@ -146,6 +158,7 @@ export declare class Organization {
|
|
146
158
|
unfurl?: boolean | undefined;
|
147
159
|
description_field?: string | undefined;
|
148
160
|
icon?: string | undefined;
|
161
|
+
image?: string | undefined;
|
149
162
|
sort_key?: number | undefined;
|
150
163
|
max_options_count?: number | null | undefined;
|
151
164
|
sortFunction?: any;
|
@@ -160,6 +173,17 @@ export declare class Organization {
|
|
160
173
|
search_tab_instruction?: string | null | undefined;
|
161
174
|
setting_pin_to_bottom?: boolean | undefined;
|
162
175
|
track_recents?: boolean | undefined;
|
176
|
+
detail?: string | ({
|
177
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
178
|
+
value: string;
|
179
|
+
} & {
|
180
|
+
position?: "inline" | "popover" | undefined;
|
181
|
+
}) | (string | ({
|
182
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
183
|
+
value: string;
|
184
|
+
} & {
|
185
|
+
position?: "inline" | "popover" | undefined;
|
186
|
+
}))[] | null | undefined;
|
163
187
|
};
|
164
188
|
};
|
165
189
|
should_show_onboarding: boolean;
|
@@ -215,6 +239,7 @@ export declare class Organization {
|
|
215
239
|
unfurl?: boolean | undefined;
|
216
240
|
description_field?: string | undefined;
|
217
241
|
icon?: string | undefined;
|
242
|
+
image?: string | undefined;
|
218
243
|
sort_key?: number | undefined;
|
219
244
|
max_options_count?: number | null | undefined;
|
220
245
|
sortFunction?: any;
|
@@ -229,6 +254,17 @@ export declare class Organization {
|
|
229
254
|
search_tab_instruction?: string | null | undefined;
|
230
255
|
setting_pin_to_bottom?: boolean | undefined;
|
231
256
|
track_recents?: boolean | undefined;
|
257
|
+
detail?: string | ({
|
258
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
259
|
+
value: string;
|
260
|
+
} & {
|
261
|
+
position?: "inline" | "popover" | undefined;
|
262
|
+
}) | (string | ({
|
263
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
264
|
+
value: string;
|
265
|
+
} & {
|
266
|
+
position?: "inline" | "popover" | undefined;
|
267
|
+
}))[] | null | undefined;
|
232
268
|
};
|
233
269
|
};
|
234
270
|
should_show_onboarding: boolean;
|
@@ -263,7 +299,7 @@ export declare class Organization {
|
|
263
299
|
type: "admin";
|
264
300
|
value: string;
|
265
301
|
} & {} & {
|
266
|
-
commandType?: "object" | "
|
302
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
267
303
|
object?: string | undefined;
|
268
304
|
hoverTooltip?: boolean | undefined;
|
269
305
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -271,7 +307,7 @@ export declare class Organization {
|
|
271
307
|
type: "callback";
|
272
308
|
value: string;
|
273
309
|
} & {} & {
|
274
|
-
commandType?: "object" | "
|
310
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
275
311
|
object?: string | undefined;
|
276
312
|
hoverTooltip?: boolean | undefined;
|
277
313
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -279,7 +315,7 @@ export declare class Organization {
|
|
279
315
|
type: "link";
|
280
316
|
value: string;
|
281
317
|
} & {} & {
|
282
|
-
commandType?: "object" | "
|
318
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
283
319
|
object?: string | undefined;
|
284
320
|
hoverTooltip?: boolean | undefined;
|
285
321
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -287,7 +323,7 @@ export declare class Organization {
|
|
287
323
|
type: "click" | "clickByXpath" | "clickBySelector";
|
288
324
|
value: string[];
|
289
325
|
} & {} & {
|
290
|
-
commandType?: "object" | "
|
326
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
291
327
|
object?: string | undefined;
|
292
328
|
hoverTooltip?: boolean | undefined;
|
293
329
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -295,7 +331,7 @@ export declare class Organization {
|
|
295
331
|
type: "builtin";
|
296
332
|
value: string;
|
297
333
|
} & {} & {
|
298
|
-
commandType?: "object" | "
|
334
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
299
335
|
object?: string | undefined;
|
300
336
|
hoverTooltip?: boolean | undefined;
|
301
337
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -303,7 +339,7 @@ export declare class Organization {
|
|
303
339
|
type: "webhook";
|
304
340
|
value: string;
|
305
341
|
} & {} & {
|
306
|
-
commandType?: "object" | "
|
342
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
307
343
|
object?: string | undefined;
|
308
344
|
hoverTooltip?: boolean | undefined;
|
309
345
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -311,7 +347,7 @@ export declare class Organization {
|
|
311
347
|
type: "script";
|
312
348
|
value: string;
|
313
349
|
} & {} & {
|
314
|
-
commandType?: "object" | "
|
350
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
315
351
|
object?: string | undefined;
|
316
352
|
hoverTooltip?: boolean | undefined;
|
317
353
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -332,7 +368,7 @@ export declare class Organization {
|
|
332
368
|
onError?: string | undefined;
|
333
369
|
};
|
334
370
|
} & {} & {
|
335
|
-
commandType?: "object" | "
|
371
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
336
372
|
object?: string | undefined;
|
337
373
|
hoverTooltip?: boolean | undefined;
|
338
374
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -340,7 +376,7 @@ export declare class Organization {
|
|
340
376
|
type: "appcues";
|
341
377
|
value: string;
|
342
378
|
} & {} & {
|
343
|
-
commandType?: "object" | "
|
379
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
344
380
|
object?: string | undefined;
|
345
381
|
hoverTooltip?: boolean | undefined;
|
346
382
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -348,7 +384,7 @@ export declare class Organization {
|
|
348
384
|
type: "video";
|
349
385
|
value: string;
|
350
386
|
} & {} & {
|
351
|
-
commandType?: "object" | "
|
387
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
352
388
|
object?: string | undefined;
|
353
389
|
hoverTooltip?: boolean | undefined;
|
354
390
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -356,7 +392,7 @@ export declare class Organization {
|
|
356
392
|
type: "helpdoc";
|
357
393
|
value: string;
|
358
394
|
} & {} & {
|
359
|
-
commandType?: "object" | "
|
395
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
360
396
|
object?: string | undefined;
|
361
397
|
hoverTooltip?: boolean | undefined;
|
362
398
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -511,14 +547,14 @@ export declare class Organization {
|
|
511
547
|
};
|
512
548
|
tags: string[];
|
513
549
|
availability_rules: ({
|
514
|
-
type: "url" | "
|
550
|
+
type: "url" | "element" | "context";
|
515
551
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
516
552
|
} & {
|
517
553
|
field?: string | undefined;
|
518
554
|
value?: string | undefined;
|
519
555
|
reason?: string | undefined;
|
520
556
|
})[] | (({
|
521
|
-
type: "url" | "
|
557
|
+
type: "url" | "element" | "context";
|
522
558
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
523
559
|
} & {
|
524
560
|
field?: string | undefined;
|
@@ -531,7 +567,7 @@ export declare class Organization {
|
|
531
567
|
reason?: string | undefined;
|
532
568
|
}))[];
|
533
569
|
recommend_rules: (({
|
534
|
-
type: "url" | "
|
570
|
+
type: "url" | "element" | "context";
|
535
571
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
536
572
|
} & {
|
537
573
|
field?: string | undefined;
|
@@ -545,7 +581,7 @@ export declare class Organization {
|
|
545
581
|
value?: null | undefined;
|
546
582
|
reason?: null | undefined;
|
547
583
|
}))[] | (({
|
548
|
-
type: "url" | "
|
584
|
+
type: "url" | "element" | "context";
|
549
585
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
550
586
|
} & {
|
551
587
|
field?: string | undefined;
|
@@ -575,6 +611,7 @@ export declare class Organization {
|
|
575
611
|
category: number | null;
|
576
612
|
sort_key: number | null;
|
577
613
|
icon: string | null;
|
614
|
+
image: string | null;
|
578
615
|
celebrate: boolean | {
|
579
616
|
angle?: number | undefined;
|
580
617
|
spread?: number | undefined;
|
@@ -595,12 +632,12 @@ export declare class Organization {
|
|
595
632
|
hotkey_mac: string;
|
596
633
|
hotkey_win: string;
|
597
634
|
detail: string | ({
|
598
|
-
type: "html" | "video" | "plaintext" | "markdown" | "react" |
|
635
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
599
636
|
value: string;
|
600
637
|
} & {
|
601
638
|
position?: "inline" | "popover" | undefined;
|
602
639
|
}) | (string | ({
|
603
|
-
type: "html" | "video" | "plaintext" | "markdown" | "react" |
|
640
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
604
641
|
value: string;
|
605
642
|
} & {
|
606
643
|
position?: "inline" | "popover" | undefined;
|
@@ -617,6 +654,7 @@ export declare class Organization {
|
|
617
654
|
} & {} & {
|
618
655
|
sort_key: number | null;
|
619
656
|
icon: string | null;
|
657
|
+
image: string | null;
|
620
658
|
render_as: "grid" | "list";
|
621
659
|
setting_hide_before_search: boolean;
|
622
660
|
setting_max_options_count: number | null;
|
@@ -819,6 +857,7 @@ export declare class Organization {
|
|
819
857
|
unfurl?: boolean | undefined;
|
820
858
|
description_field?: string | undefined;
|
821
859
|
icon?: string | undefined;
|
860
|
+
image?: string | undefined;
|
822
861
|
sort_key?: number | undefined;
|
823
862
|
max_options_count?: number | null | undefined;
|
824
863
|
sortFunction?: any;
|
@@ -833,6 +872,17 @@ export declare class Organization {
|
|
833
872
|
search_tab_instruction?: string | null | undefined;
|
834
873
|
setting_pin_to_bottom?: boolean | undefined;
|
835
874
|
track_recents?: boolean | undefined;
|
875
|
+
detail?: string | ({
|
876
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
877
|
+
value: string;
|
878
|
+
} & {
|
879
|
+
position?: "inline" | "popover" | undefined;
|
880
|
+
}) | (string | ({
|
881
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
882
|
+
value: string;
|
883
|
+
} & {
|
884
|
+
position?: "inline" | "popover" | undefined;
|
885
|
+
}))[] | null | undefined;
|
836
886
|
};
|
837
887
|
};
|
838
888
|
should_show_onboarding: boolean;
|
@@ -0,0 +1,27 @@
|
|
1
|
+
import * as t from 'io-ts';
|
2
|
+
export declare const TabV: t.TypeC<{
|
3
|
+
id: t.NumberC;
|
4
|
+
organization: t.UnionC<[t.NumberC, t.StringC]>;
|
5
|
+
category_ids: t.ArrayC<t.NumberC>;
|
6
|
+
sort_key: t.NumberC;
|
7
|
+
icon: t.UnionC<[t.StringC, t.NullC]>;
|
8
|
+
label: t.StringC;
|
9
|
+
header: t.UnionC<[t.StringC, t.NullC]>;
|
10
|
+
description: t.StringC;
|
11
|
+
placeholder: t.UnionC<[t.StringC, t.NullC]>;
|
12
|
+
render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
|
13
|
+
}>;
|
14
|
+
export declare class Tab {
|
15
|
+
static decode: (data: any) => {
|
16
|
+
id: number;
|
17
|
+
organization: string | number;
|
18
|
+
category_ids: number[];
|
19
|
+
sort_key: number;
|
20
|
+
icon: string | null;
|
21
|
+
label: string;
|
22
|
+
header: string | null;
|
23
|
+
description: string;
|
24
|
+
placeholder: string | null;
|
25
|
+
render_as: "grid" | "list";
|
26
|
+
};
|
27
|
+
}
|
@@ -20,6 +20,7 @@ import { PlaceholderV } from './placeholder';
|
|
20
20
|
import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
|
21
21
|
import { EnvironmentV } from './environment';
|
22
22
|
import { NudgeV } from './nudge';
|
23
|
+
import { TabV } from './tab';
|
23
24
|
import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
|
24
25
|
/*******************************************************************************/
|
25
26
|
export declare type IContextType = t.TypeOf<typeof ContextV>;
|
@@ -42,6 +43,7 @@ export declare type ISkinType = t.TypeOf<typeof SkinV>;
|
|
42
43
|
export declare type IProfileType = t.TypeOf<typeof ProfileV>;
|
43
44
|
export declare type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV>;
|
44
45
|
export declare type IPlaceholderType = t.TypeOf<typeof PlaceholderV>;
|
46
|
+
export declare type ITabType = t.TypeOf<typeof TabV>;
|
45
47
|
export declare type IEnvironmentType = t.TypeOf<typeof EnvironmentV>;
|
46
48
|
export declare type IReleaseStep = t.TypeOf<typeof ReleaseStepV>;
|
47
49
|
export declare type IRelease = t.TypeOf<typeof ReleaseV>;
|
@@ -93,7 +95,7 @@ export interface IUserContext {
|
|
93
95
|
[variable: string]: any;
|
94
96
|
}
|
95
97
|
export interface ICallbackMap {
|
96
|
-
[variable: string]: (...args: any[]) =>
|
98
|
+
[variable: string]: (...args: any[]) => unknown;
|
97
99
|
}
|
98
100
|
export interface IResourceType extends IUserContext {
|
99
101
|
_cbLinkedCommmands: Array<{
|
@@ -108,10 +110,11 @@ export declare type IConfigEndpointResponse = {
|
|
108
110
|
environments_with_versions?: any[];
|
109
111
|
placeholders?: any[];
|
110
112
|
nudges?: INudgeType[];
|
113
|
+
tabs?: ITabType[];
|
111
114
|
};
|
112
115
|
export type { IResourceSettings } from './IResourceSettings';
|
113
116
|
export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
|
114
|
-
export type { DetailPreviewObjectType, DetailPreviewType,
|
117
|
+
export type { DetailPreviewObjectType, DetailPreviewType, DataRowMetadata } from './detailPreview';
|
115
118
|
/*******************************************************************************/
|
116
119
|
export declare const isCommand: (command?: ICommandType | any) => command is {
|
117
120
|
id: number;
|
@@ -121,7 +124,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
121
124
|
type: "admin";
|
122
125
|
value: string;
|
123
126
|
} & {} & {
|
124
|
-
commandType?: "object" | "
|
127
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
125
128
|
object?: string | undefined;
|
126
129
|
hoverTooltip?: boolean | undefined;
|
127
130
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -129,7 +132,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
129
132
|
type: "callback";
|
130
133
|
value: string;
|
131
134
|
} & {} & {
|
132
|
-
commandType?: "object" | "
|
135
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
133
136
|
object?: string | undefined;
|
134
137
|
hoverTooltip?: boolean | undefined;
|
135
138
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -137,7 +140,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
137
140
|
type: "link";
|
138
141
|
value: string;
|
139
142
|
} & {} & {
|
140
|
-
commandType?: "object" | "
|
143
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
141
144
|
object?: string | undefined;
|
142
145
|
hoverTooltip?: boolean | undefined;
|
143
146
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -145,7 +148,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
145
148
|
type: "click" | "clickByXpath" | "clickBySelector";
|
146
149
|
value: string[];
|
147
150
|
} & {} & {
|
148
|
-
commandType?: "object" | "
|
151
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
149
152
|
object?: string | undefined;
|
150
153
|
hoverTooltip?: boolean | undefined;
|
151
154
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -153,7 +156,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
153
156
|
type: "builtin";
|
154
157
|
value: string;
|
155
158
|
} & {} & {
|
156
|
-
commandType?: "object" | "
|
159
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
157
160
|
object?: string | undefined;
|
158
161
|
hoverTooltip?: boolean | undefined;
|
159
162
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -161,7 +164,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
161
164
|
type: "webhook";
|
162
165
|
value: string;
|
163
166
|
} & {} & {
|
164
|
-
commandType?: "object" | "
|
167
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
165
168
|
object?: string | undefined;
|
166
169
|
hoverTooltip?: boolean | undefined;
|
167
170
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -169,7 +172,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
169
172
|
type: "script";
|
170
173
|
value: string;
|
171
174
|
} & {} & {
|
172
|
-
commandType?: "object" | "
|
175
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
173
176
|
object?: string | undefined;
|
174
177
|
hoverTooltip?: boolean | undefined;
|
175
178
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -190,7 +193,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
190
193
|
onError?: string | undefined;
|
191
194
|
};
|
192
195
|
} & {} & {
|
193
|
-
commandType?: "object" | "
|
196
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
194
197
|
object?: string | undefined;
|
195
198
|
hoverTooltip?: boolean | undefined;
|
196
199
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -198,7 +201,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
198
201
|
type: "appcues";
|
199
202
|
value: string;
|
200
203
|
} & {} & {
|
201
|
-
commandType?: "object" | "
|
204
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
202
205
|
object?: string | undefined;
|
203
206
|
hoverTooltip?: boolean | undefined;
|
204
207
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -206,7 +209,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
206
209
|
type: "video";
|
207
210
|
value: string;
|
208
211
|
} & {} & {
|
209
|
-
commandType?: "object" | "
|
212
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
210
213
|
object?: string | undefined;
|
211
214
|
hoverTooltip?: boolean | undefined;
|
212
215
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -214,7 +217,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
214
217
|
type: "helpdoc";
|
215
218
|
value: string;
|
216
219
|
} & {} & {
|
217
|
-
commandType?: "object" | "
|
220
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
218
221
|
object?: string | undefined;
|
219
222
|
hoverTooltip?: boolean | undefined;
|
220
223
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -369,7 +372,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
369
372
|
};
|
370
373
|
tags: string[];
|
371
374
|
availability_rules: ({
|
372
|
-
type: "url" | "
|
375
|
+
type: "url" | "element" | "context";
|
373
376
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
374
377
|
} & {
|
375
378
|
field?: string | undefined;
|
@@ -377,7 +380,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
377
380
|
reason?: string | undefined;
|
378
381
|
})[];
|
379
382
|
recommend_rules: (({
|
380
|
-
type: "url" | "
|
383
|
+
type: "url" | "element" | "context";
|
381
384
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
382
385
|
} & {
|
383
386
|
field?: string | undefined;
|
@@ -402,6 +405,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
402
405
|
category: number | null;
|
403
406
|
sort_key: number | null;
|
404
407
|
icon: string | null;
|
408
|
+
image: string | null;
|
405
409
|
celebrate: boolean | {
|
406
410
|
angle?: number | undefined;
|
407
411
|
spread?: number | undefined;
|
@@ -422,17 +426,20 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
422
426
|
hotkey_mac: string;
|
423
427
|
hotkey_win: string;
|
424
428
|
detail: string | ({
|
425
|
-
type: "html" | "video" | "plaintext" | "markdown" | "react" |
|
429
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
426
430
|
value: string;
|
427
431
|
} & {
|
428
432
|
position?: "inline" | "popover" | undefined;
|
429
433
|
}) | (string | ({
|
430
|
-
type: "html" | "video" | "plaintext" | "markdown" | "react" |
|
434
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
431
435
|
value: string;
|
432
436
|
} & {
|
433
437
|
position?: "inline" | "popover" | undefined;
|
434
438
|
}))[] | null;
|
435
439
|
next_steps: (string | number)[];
|
440
|
+
} & {
|
441
|
+
third_party_source?: string | null | undefined;
|
442
|
+
third_party_id?: string | null | undefined;
|
436
443
|
};
|
437
444
|
export declare const isResource: (option: any) => option is IResourceType;
|
438
445
|
export declare const isContextArgument: (argument: IArgumentType) => argument is {
|