commandbar 1.6.8 → 1.6.9
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/init.d.ts +1 -1
- package/build/internal/src/client/AddContextOptions.d.ts +16 -2
- package/build/internal/src/client/CommandBarClientSDK.d.ts +11 -1
- package/build/internal/src/middleware/CommandFromClientV.d.ts +32 -0
- package/build/internal/src/middleware/ICommandFromClientType.d.ts +2 -0
- package/build/internal/src/middleware/OrganizationV.d.ts +14 -4
- package/build/internal/src/middleware/ResourceSettingsV.d.ts +14 -2
- package/build/internal/src/middleware/command.d.ts +492 -0
- package/build/internal/src/middleware/commandCategory.d.ts +6 -0
- package/build/internal/src/middleware/detailPreview.d.ts +17 -0
- package/build/internal/src/middleware/generics.d.ts +6 -2
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +62 -0
- package/build/internal/src/middleware/helpers/optionGroup.d.ts +2 -0
- package/build/internal/src/middleware/organization.d.ts +135 -54
- package/build/internal/src/middleware/types.d.ts +42 -1
- package/package.json +1 -1
- package/src/init.ts +1 -1
@@ -7,6 +7,7 @@ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC
|
|
7
7
|
}>, t.PartialC<{}>]>, t.TypeC<{
|
8
8
|
sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
9
9
|
icon: t.UnionC<[t.StringC, t.NullC]>;
|
10
|
+
render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
|
10
11
|
setting_hide_before_search: t.BooleanC;
|
11
12
|
setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
|
12
13
|
setting_pin_to_bottom: t.BooleanC;
|
@@ -22,6 +23,7 @@ export declare class CommandCategory {
|
|
22
23
|
} & {} & {
|
23
24
|
sort_key: number | null;
|
24
25
|
icon: string | null;
|
26
|
+
render_as: "grid" | "list";
|
25
27
|
setting_hide_before_search: boolean;
|
26
28
|
setting_max_options_count: number | null;
|
27
29
|
setting_pin_to_bottom: boolean;
|
@@ -35,6 +37,7 @@ export declare class CommandCategory {
|
|
35
37
|
} & {} & {
|
36
38
|
sort_key: number | null;
|
37
39
|
icon: string | null;
|
40
|
+
render_as: "grid" | "list";
|
38
41
|
setting_hide_before_search: boolean;
|
39
42
|
setting_max_options_count: number | null;
|
40
43
|
setting_pin_to_bottom: boolean;
|
@@ -49,6 +52,7 @@ export declare class CommandCategory {
|
|
49
52
|
} & {} & {
|
50
53
|
sort_key: number | null;
|
51
54
|
icon: string | null;
|
55
|
+
render_as: "grid" | "list";
|
52
56
|
setting_hide_before_search: boolean;
|
53
57
|
setting_max_options_count: number | null;
|
54
58
|
setting_pin_to_bottom: boolean;
|
@@ -62,6 +66,7 @@ export declare class CommandCategory {
|
|
62
66
|
} & {} & {
|
63
67
|
sort_key: number | null;
|
64
68
|
icon: string | null;
|
69
|
+
render_as: "grid" | "list";
|
65
70
|
setting_hide_before_search: boolean;
|
66
71
|
setting_max_options_count: number | null;
|
67
72
|
setting_pin_to_bottom: boolean;
|
@@ -77,6 +82,7 @@ export declare class CommandCategory {
|
|
77
82
|
} & {} & {
|
78
83
|
sort_key: number | null;
|
79
84
|
icon: string | null;
|
85
|
+
render_as: "grid" | "list";
|
80
86
|
setting_hide_before_search: boolean;
|
81
87
|
setting_max_options_count: number | null;
|
82
88
|
setting_pin_to_bottom: boolean;
|
@@ -0,0 +1,17 @@
|
|
1
|
+
/*******************************************************************************/
|
2
|
+
import * as t from 'io-ts';
|
3
|
+
export declare const DetailPreviewObjectV: t.TypeC<{
|
4
|
+
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"reader">, t.LiteralC<"react">]>;
|
5
|
+
value: t.StringC;
|
6
|
+
}>;
|
7
|
+
export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV>;
|
8
|
+
export declare type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
|
9
|
+
export declare type DataRowMedata = {
|
10
|
+
type: 'command' | 'parameter';
|
11
|
+
label: string;
|
12
|
+
value: any;
|
13
|
+
contextKey?: string;
|
14
|
+
uid?: string;
|
15
|
+
};
|
16
|
+
export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
|
17
|
+
export declare const standardize: (item: undefined | null | DetailPreviewType) => undefined | DetailPreviewObjectType[];
|
@@ -25,8 +25,12 @@ declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(
|
|
25
25
|
declare function loadIDList(ids: number[], klass: any, method?: string, urlArgs?: {
|
26
26
|
[arg: string]: string;
|
27
27
|
}): Promise<any[]>;
|
28
|
-
declare function read<T, O, I>(
|
28
|
+
declare function read<T, O, I>(output: t.Type<T, O, I>, url: string): (params?: Record<string, string>, callbacks?: {
|
29
29
|
onSuccess?: () => void;
|
30
30
|
onError?: (err: string) => void;
|
31
31
|
}) => Promise<T>;
|
32
|
-
|
32
|
+
declare function update<T, O, I, Q>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string): (object: Q, params?: Record<string, string>, callbacks?: {
|
33
|
+
onSuccess?: () => void;
|
34
|
+
onError?: (err: string) => void;
|
35
|
+
}) => Promise<T>;
|
36
|
+
export { createObject, createObjectDetail, read, readObject, listObject, update, updateObject, deleteObject, GenericObject, readObjectDetail, updateObjectDetail, loadIDList, decodeToPromise, decodeThrowing, };
|
@@ -61,6 +61,15 @@ export declare const WebhookTemplateV: t.IntersectionC<[t.TypeC<{
|
|
61
61
|
hoverTooltip: t.BooleanC;
|
62
62
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
63
63
|
}>]>]>;
|
64
|
+
export declare const AppCuesTemplateV: t.IntersectionC<[t.TypeC<{
|
65
|
+
type: t.LiteralC<"appcues">;
|
66
|
+
value: t.StringC;
|
67
|
+
}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
|
68
|
+
commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
|
69
|
+
object: t.StringC;
|
70
|
+
hoverTooltip: t.BooleanC;
|
71
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
72
|
+
}>]>]>;
|
64
73
|
export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
|
65
74
|
type: t.LiteralC<"script">;
|
66
75
|
value: t.StringC;
|
@@ -70,6 +79,34 @@ export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
|
|
70
79
|
hoverTooltip: t.BooleanC;
|
71
80
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
72
81
|
}>]>]>;
|
82
|
+
export declare const RequestV: t.IntersectionC<[t.TypeC<{
|
83
|
+
method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
|
84
|
+
url: t.StringC;
|
85
|
+
}>, t.PartialC<{
|
86
|
+
headers: t.UnknownRecordC;
|
87
|
+
body: t.UnknownRecordC;
|
88
|
+
onSend: t.StringC;
|
89
|
+
onSuccess: t.StringC;
|
90
|
+
onError: t.StringC;
|
91
|
+
}>]>;
|
92
|
+
export declare const RequestTemplateV: t.IntersectionC<[t.TypeC<{
|
93
|
+
type: t.LiteralC<"request">;
|
94
|
+
value: t.IntersectionC<[t.TypeC<{
|
95
|
+
method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
|
96
|
+
url: t.StringC;
|
97
|
+
}>, t.PartialC<{
|
98
|
+
headers: t.UnknownRecordC;
|
99
|
+
body: t.UnknownRecordC;
|
100
|
+
onSend: t.StringC;
|
101
|
+
onSuccess: t.StringC;
|
102
|
+
onError: t.StringC;
|
103
|
+
}>]>;
|
104
|
+
}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
|
105
|
+
commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
|
106
|
+
object: t.StringC;
|
107
|
+
hoverTooltip: t.BooleanC;
|
108
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
109
|
+
}>]>]>;
|
73
110
|
export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
|
74
111
|
type: t.LiteralC<"admin">;
|
75
112
|
value: t.StringC;
|
@@ -126,4 +163,29 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
|
|
126
163
|
object: t.StringC;
|
127
164
|
hoverTooltip: t.BooleanC;
|
128
165
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
166
|
+
}>]>]>, t.IntersectionC<[t.TypeC<{
|
167
|
+
type: t.LiteralC<"request">;
|
168
|
+
value: t.IntersectionC<[t.TypeC<{
|
169
|
+
method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
|
170
|
+
url: t.StringC;
|
171
|
+
}>, t.PartialC<{
|
172
|
+
headers: t.UnknownRecordC;
|
173
|
+
body: t.UnknownRecordC;
|
174
|
+
onSend: t.StringC;
|
175
|
+
onSuccess: t.StringC;
|
176
|
+
onError: t.StringC;
|
177
|
+
}>]>;
|
178
|
+
}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
|
179
|
+
commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
|
180
|
+
object: t.StringC;
|
181
|
+
hoverTooltip: t.BooleanC;
|
182
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
183
|
+
}>]>]>, t.IntersectionC<[t.TypeC<{
|
184
|
+
type: t.LiteralC<"appcues">;
|
185
|
+
value: t.StringC;
|
186
|
+
}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
|
187
|
+
commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
|
188
|
+
object: t.StringC;
|
189
|
+
hoverTooltip: t.BooleanC;
|
190
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
129
191
|
}>]>]>]>;
|
@@ -15,31 +15,23 @@ export declare const InternalSettingsV: t.TypeC<{
|
|
15
15
|
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.StringC>>;
|
16
16
|
}>;
|
17
17
|
export declare const OrganizationSettingsV: t.TypeC<{
|
18
|
-
analytics: t.TypeC<{
|
19
|
-
execution_limit: t.NumberC;
|
20
|
-
deadend_limit: t.NumberC;
|
21
|
-
}>;
|
22
|
-
analytics_control: t.TypeC<{
|
23
|
-
silent_enabled: t.BooleanC;
|
24
|
-
allow_event_handlers: t.BooleanC;
|
25
|
-
event_attribute_block_list: t.ArrayC<t.StringC>;
|
26
|
-
}>;
|
27
|
-
skins: t.TypeC<{
|
28
|
-
limit: t.NumberC;
|
29
|
-
field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
|
30
|
-
}>;
|
31
|
-
deployment: t.TypeC<{
|
32
|
-
show_countdown_banner: t.BooleanC;
|
33
|
-
}>;
|
34
|
-
view: t.TypeC<{
|
35
|
-
in_bar_feedback: t.BooleanC;
|
36
|
-
}>;
|
37
18
|
end_user_limit: t.NumberC;
|
38
19
|
user_seat_limit: t.NumberC;
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
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;
|
43
35
|
}>;
|
44
36
|
export declare class Organization {
|
45
37
|
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
@@ -67,7 +59,10 @@ export declare class Organization {
|
|
67
59
|
search?: boolean | undefined;
|
68
60
|
label_field?: string | undefined;
|
69
61
|
useCategory?: boolean | undefined;
|
70
|
-
search_fields?: string
|
62
|
+
search_fields?: (string | {
|
63
|
+
key: string;
|
64
|
+
label: string;
|
65
|
+
})[] | undefined;
|
71
66
|
auto_execute?: boolean | undefined;
|
72
67
|
unfurl?: boolean | undefined;
|
73
68
|
description_field?: string | undefined;
|
@@ -76,6 +71,7 @@ export declare class Organization {
|
|
76
71
|
max_options_count?: number | null | undefined;
|
77
72
|
sortFunction?: any;
|
78
73
|
default_command_id?: string | number | undefined;
|
74
|
+
render_as?: "grid" | "list" | undefined;
|
79
75
|
showResources?: boolean | undefined;
|
80
76
|
show_with_no_results?: boolean | undefined;
|
81
77
|
search_tab_enabled?: boolean | undefined;
|
@@ -94,7 +90,8 @@ export declare class Organization {
|
|
94
90
|
allow_event_handlers: boolean;
|
95
91
|
in_bar_feedback: boolean;
|
96
92
|
summon_hotkey_override: string | null;
|
97
|
-
end_user_hotkeys: boolean;
|
93
|
+
end_user_hotkeys: boolean | undefined;
|
94
|
+
end_user_shortcuts_enabled: boolean;
|
98
95
|
releases_available: boolean;
|
99
96
|
releases_enabled: boolean;
|
100
97
|
}>;
|
@@ -120,7 +117,10 @@ export declare class Organization {
|
|
120
117
|
search?: boolean | undefined;
|
121
118
|
label_field?: string | undefined;
|
122
119
|
useCategory?: boolean | undefined;
|
123
|
-
search_fields?: string
|
120
|
+
search_fields?: (string | {
|
121
|
+
key: string;
|
122
|
+
label: string;
|
123
|
+
})[] | undefined;
|
124
124
|
auto_execute?: boolean | undefined;
|
125
125
|
unfurl?: boolean | undefined;
|
126
126
|
description_field?: string | undefined;
|
@@ -129,6 +129,7 @@ export declare class Organization {
|
|
129
129
|
max_options_count?: number | null | undefined;
|
130
130
|
sortFunction?: any;
|
131
131
|
default_command_id?: string | number | undefined;
|
132
|
+
render_as?: "grid" | "list" | undefined;
|
132
133
|
showResources?: boolean | undefined;
|
133
134
|
show_with_no_results?: boolean | undefined;
|
134
135
|
search_tab_enabled?: boolean | undefined;
|
@@ -147,7 +148,8 @@ export declare class Organization {
|
|
147
148
|
allow_event_handlers: boolean;
|
148
149
|
in_bar_feedback: boolean;
|
149
150
|
summon_hotkey_override: string | null;
|
150
|
-
end_user_hotkeys: boolean;
|
151
|
+
end_user_hotkeys: boolean | undefined;
|
152
|
+
end_user_shortcuts_enabled: boolean;
|
151
153
|
releases_available: boolean;
|
152
154
|
releases_enabled: boolean;
|
153
155
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
@@ -172,7 +174,10 @@ export declare class Organization {
|
|
172
174
|
search?: boolean | undefined;
|
173
175
|
label_field?: string | undefined;
|
174
176
|
useCategory?: boolean | undefined;
|
175
|
-
search_fields?: string
|
177
|
+
search_fields?: (string | {
|
178
|
+
key: string;
|
179
|
+
label: string;
|
180
|
+
})[] | undefined;
|
176
181
|
auto_execute?: boolean | undefined;
|
177
182
|
unfurl?: boolean | undefined;
|
178
183
|
description_field?: string | undefined;
|
@@ -181,6 +186,7 @@ export declare class Organization {
|
|
181
186
|
max_options_count?: number | null | undefined;
|
182
187
|
sortFunction?: any;
|
183
188
|
default_command_id?: string | number | undefined;
|
189
|
+
render_as?: "grid" | "list" | undefined;
|
184
190
|
showResources?: boolean | undefined;
|
185
191
|
show_with_no_results?: boolean | undefined;
|
186
192
|
search_tab_enabled?: boolean | undefined;
|
@@ -199,7 +205,8 @@ export declare class Organization {
|
|
199
205
|
allow_event_handlers: boolean;
|
200
206
|
in_bar_feedback: boolean;
|
201
207
|
summon_hotkey_override: string | null;
|
202
|
-
end_user_hotkeys: boolean;
|
208
|
+
end_user_hotkeys: boolean | undefined;
|
209
|
+
end_user_shortcuts_enabled: boolean;
|
203
210
|
releases_available: boolean;
|
204
211
|
releases_enabled: boolean;
|
205
212
|
}>;
|
@@ -263,6 +270,35 @@ export declare class Organization {
|
|
263
270
|
object?: string | undefined;
|
264
271
|
hoverTooltip?: boolean | undefined;
|
265
272
|
operation?: "self" | "router" | "blank" | undefined;
|
273
|
+
}) | ({
|
274
|
+
type: "request";
|
275
|
+
value: {
|
276
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
277
|
+
url: string;
|
278
|
+
} & {
|
279
|
+
headers?: {
|
280
|
+
[key: string]: unknown;
|
281
|
+
} | undefined;
|
282
|
+
body?: {
|
283
|
+
[key: string]: unknown;
|
284
|
+
} | undefined;
|
285
|
+
onSend?: string | undefined;
|
286
|
+
onSuccess?: string | undefined;
|
287
|
+
onError?: string | undefined;
|
288
|
+
};
|
289
|
+
} & {} & {
|
290
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
291
|
+
object?: string | undefined;
|
292
|
+
hoverTooltip?: boolean | undefined;
|
293
|
+
operation?: "self" | "router" | "blank" | undefined;
|
294
|
+
}) | ({
|
295
|
+
type: "appcues";
|
296
|
+
value: string;
|
297
|
+
} & {} & {
|
298
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
299
|
+
object?: string | undefined;
|
300
|
+
hoverTooltip?: boolean | undefined;
|
301
|
+
operation?: "self" | "router" | "blank" | undefined;
|
266
302
|
});
|
267
303
|
} & {
|
268
304
|
disabledReason?: string | undefined;
|
@@ -270,6 +306,13 @@ export declare class Organization {
|
|
270
306
|
name?: string | undefined;
|
271
307
|
last_available?: string | null | undefined;
|
272
308
|
modified?: string | undefined;
|
309
|
+
detail?: string | {
|
310
|
+
type: "html" | "plaintext" | "markdown" | "reader" | "react";
|
311
|
+
value: string;
|
312
|
+
} | {
|
313
|
+
type: "html" | "plaintext" | "markdown" | "reader" | "react";
|
314
|
+
value: string;
|
315
|
+
}[] | undefined;
|
273
316
|
} & {
|
274
317
|
arguments: {
|
275
318
|
[x: string]: ({
|
@@ -432,6 +475,7 @@ export declare class Organization {
|
|
432
475
|
} & {} & {
|
433
476
|
sort_key: number | null;
|
434
477
|
icon: string | null;
|
478
|
+
render_as: "grid" | "list";
|
435
479
|
setting_hide_before_search: boolean;
|
436
480
|
setting_max_options_count: number | null;
|
437
481
|
setting_pin_to_bottom: boolean;
|
@@ -522,31 +566,63 @@ export declare class Organization {
|
|
522
566
|
onSuccess?: (() => void) | undefined;
|
523
567
|
onError?: ((err: string) => void) | undefined;
|
524
568
|
} | undefined) => Promise<{
|
525
|
-
analytics: {
|
526
|
-
execution_limit: number;
|
527
|
-
deadend_limit: number;
|
528
|
-
};
|
529
|
-
analytics_control: {
|
530
|
-
silent_enabled: boolean;
|
531
|
-
allow_event_handlers: boolean;
|
532
|
-
event_attribute_block_list: string[];
|
533
|
-
};
|
534
|
-
skins: {
|
535
|
-
limit: number;
|
536
|
-
field_set: "basic" | "pro";
|
537
|
-
};
|
538
|
-
deployment: {
|
539
|
-
show_countdown_banner: boolean;
|
540
|
-
};
|
541
|
-
view: {
|
542
|
-
in_bar_feedback: boolean;
|
543
|
-
};
|
544
569
|
end_user_limit: number;
|
545
570
|
user_seat_limit: number;
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
571
|
+
analytics_dashboard_execution_limit: number;
|
572
|
+
analytics_dashboard_deadend_limit: number;
|
573
|
+
silent_mode: boolean;
|
574
|
+
allow_event_handlers: boolean;
|
575
|
+
event_attribute_block_list: string[];
|
576
|
+
skins_limit: number;
|
577
|
+
skins_field_set: "basic" | "pro";
|
578
|
+
show_countdown_banner: boolean;
|
579
|
+
can_install_foobar: boolean;
|
580
|
+
releases_available: boolean;
|
581
|
+
releases_enabled: boolean;
|
582
|
+
releases_environments: string[];
|
583
|
+
in_bar_feedback: boolean;
|
584
|
+
summon_hotkey_override: string | null;
|
585
|
+
end_user_shortcuts_enabled: boolean;
|
586
|
+
}>;
|
587
|
+
static updateSetting: (object: {
|
588
|
+
end_user_limit?: number | undefined;
|
589
|
+
user_seat_limit?: number | undefined;
|
590
|
+
analytics_dashboard_execution_limit?: number | undefined;
|
591
|
+
analytics_dashboard_deadend_limit?: number | undefined;
|
592
|
+
silent_mode?: boolean | undefined;
|
593
|
+
allow_event_handlers?: boolean | undefined;
|
594
|
+
event_attribute_block_list?: string[] | undefined;
|
595
|
+
skins_limit?: number | undefined;
|
596
|
+
skins_field_set?: "basic" | "pro" | undefined;
|
597
|
+
show_countdown_banner?: boolean | undefined;
|
598
|
+
can_install_foobar?: boolean | undefined;
|
599
|
+
releases_available?: boolean | undefined;
|
600
|
+
releases_enabled?: boolean | undefined;
|
601
|
+
releases_environments?: string[] | undefined;
|
602
|
+
in_bar_feedback?: boolean | undefined;
|
603
|
+
summon_hotkey_override?: string | null | undefined;
|
604
|
+
end_user_shortcuts_enabled?: boolean | undefined;
|
605
|
+
}, params?: Record<string, string> | undefined, callbacks?: {
|
606
|
+
onSuccess?: (() => void) | undefined;
|
607
|
+
onError?: ((err: string) => void) | undefined;
|
608
|
+
} | undefined) => Promise<{
|
609
|
+
end_user_limit: number;
|
610
|
+
user_seat_limit: number;
|
611
|
+
analytics_dashboard_execution_limit: number;
|
612
|
+
analytics_dashboard_deadend_limit: number;
|
613
|
+
silent_mode: boolean;
|
614
|
+
allow_event_handlers: boolean;
|
615
|
+
event_attribute_block_list: string[];
|
616
|
+
skins_limit: number;
|
617
|
+
skins_field_set: "basic" | "pro";
|
618
|
+
show_countdown_banner: boolean;
|
619
|
+
can_install_foobar: boolean;
|
620
|
+
releases_available: boolean;
|
621
|
+
releases_enabled: boolean;
|
622
|
+
releases_environments: string[];
|
623
|
+
in_bar_feedback: boolean;
|
624
|
+
summon_hotkey_override: string | null;
|
625
|
+
end_user_shortcuts_enabled: boolean;
|
550
626
|
}>;
|
551
627
|
static decode: (data: any) => {
|
552
628
|
id: string | number;
|
@@ -570,7 +646,10 @@ export declare class Organization {
|
|
570
646
|
search?: boolean | undefined;
|
571
647
|
label_field?: string | undefined;
|
572
648
|
useCategory?: boolean | undefined;
|
573
|
-
search_fields?: string
|
649
|
+
search_fields?: (string | {
|
650
|
+
key: string;
|
651
|
+
label: string;
|
652
|
+
})[] | undefined;
|
574
653
|
auto_execute?: boolean | undefined;
|
575
654
|
unfurl?: boolean | undefined;
|
576
655
|
description_field?: string | undefined;
|
@@ -579,6 +658,7 @@ export declare class Organization {
|
|
579
658
|
max_options_count?: number | null | undefined;
|
580
659
|
sortFunction?: any;
|
581
660
|
default_command_id?: string | number | undefined;
|
661
|
+
render_as?: "grid" | "list" | undefined;
|
582
662
|
showResources?: boolean | undefined;
|
583
663
|
show_with_no_results?: boolean | undefined;
|
584
664
|
search_tab_enabled?: boolean | undefined;
|
@@ -597,7 +677,8 @@ export declare class Organization {
|
|
597
677
|
allow_event_handlers: boolean;
|
598
678
|
in_bar_feedback: boolean;
|
599
679
|
summon_hotkey_override: string | null;
|
600
|
-
end_user_hotkeys: boolean;
|
680
|
+
end_user_hotkeys: boolean | undefined;
|
681
|
+
end_user_shortcuts_enabled: boolean;
|
601
682
|
releases_available: boolean;
|
602
683
|
releases_enabled: boolean;
|
603
684
|
};
|
@@ -2,7 +2,8 @@
|
|
2
2
|
import * as t from 'io-ts';
|
3
3
|
import { BatchEditorCommandRequestV, BatchEditorCommandResponseV, BatchOperationV, CommandV, EditorCommandV } from './command';
|
4
4
|
import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
|
5
|
-
import {
|
5
|
+
import { OptionGroupRenderAsV } from './helpers/optionGroup';
|
6
|
+
import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
|
6
7
|
import { CommandCategoryV } from './commandCategory';
|
7
8
|
import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationSettingsV } from './organization';
|
8
9
|
import { UserV } from './user';
|
@@ -47,6 +48,8 @@ export declare type IArgumentMap = t.TypeOf<typeof ArgumentMapV>;
|
|
47
48
|
export declare type IArgumentType = t.TypeOf<typeof ArgumentTypeV>;
|
48
49
|
export declare type IStepArgumentType = t.TypeOf<typeof StepArgumentTypeV>;
|
49
50
|
export declare type ITemplate = t.TypeOf<typeof TemplateV>;
|
51
|
+
export declare type RequestTemplateType = t.TypeOf<typeof RequestTemplateV>;
|
52
|
+
export declare type RequestType = t.TypeOf<typeof RequestV>;
|
50
53
|
export declare type ITemplateOptions = t.TypeOf<typeof TemplateOptionsV>;
|
51
54
|
export declare type IEndUserType = t.TypeOf<typeof EndUserV>;
|
52
55
|
export declare type IConditionType = t.TypeOf<typeof ConditionV>;
|
@@ -56,6 +59,7 @@ export declare type ISetArgumentType = t.TypeOf<typeof SetArgumentV>;
|
|
56
59
|
export declare type IDynamicArgumentType = t.TypeOf<typeof DynamicArgumentV>;
|
57
60
|
export declare type IDependentArgumentType = t.TypeOf<typeof DependentArgumentV>;
|
58
61
|
export declare type IFunctionArgumentType = t.TypeOf<typeof FunctionArgumentV>;
|
62
|
+
export declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderAsV>;
|
59
63
|
export interface ICommandInput {
|
60
64
|
text: string;
|
61
65
|
command: ICommandType;
|
@@ -89,6 +93,7 @@ export declare type IConfigEndpointResponse = {
|
|
89
93
|
};
|
90
94
|
export type { IResourceSettings } from './IResourceSettings';
|
91
95
|
export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
|
96
|
+
export type { DetailPreviewObjectType, DetailPreviewType, DataRowMedata } from './detailPreview';
|
92
97
|
/*******************************************************************************/
|
93
98
|
export declare const isCommand: (command?: ICommandType | any) => command is {
|
94
99
|
id: number;
|
@@ -150,6 +155,35 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
150
155
|
object?: string | undefined;
|
151
156
|
hoverTooltip?: boolean | undefined;
|
152
157
|
operation?: "self" | "router" | "blank" | undefined;
|
158
|
+
}) | ({
|
159
|
+
type: "request";
|
160
|
+
value: {
|
161
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
162
|
+
url: string;
|
163
|
+
} & {
|
164
|
+
headers?: {
|
165
|
+
[key: string]: unknown;
|
166
|
+
} | undefined;
|
167
|
+
body?: {
|
168
|
+
[key: string]: unknown;
|
169
|
+
} | undefined;
|
170
|
+
onSend?: string | undefined;
|
171
|
+
onSuccess?: string | undefined;
|
172
|
+
onError?: string | undefined;
|
173
|
+
};
|
174
|
+
} & {} & {
|
175
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
176
|
+
object?: string | undefined;
|
177
|
+
hoverTooltip?: boolean | undefined;
|
178
|
+
operation?: "self" | "router" | "blank" | undefined;
|
179
|
+
}) | ({
|
180
|
+
type: "appcues";
|
181
|
+
value: string;
|
182
|
+
} & {} & {
|
183
|
+
commandType?: "object" | "independent" | "help" | undefined;
|
184
|
+
object?: string | undefined;
|
185
|
+
hoverTooltip?: boolean | undefined;
|
186
|
+
operation?: "self" | "router" | "blank" | undefined;
|
153
187
|
});
|
154
188
|
} & {
|
155
189
|
disabledReason?: string | undefined;
|
@@ -157,6 +191,13 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
|
|
157
191
|
name?: string | undefined;
|
158
192
|
last_available?: string | null | undefined;
|
159
193
|
modified?: string | undefined;
|
194
|
+
detail?: string | {
|
195
|
+
type: "html" | "plaintext" | "markdown" | "reader" | "react";
|
196
|
+
value: string;
|
197
|
+
} | {
|
198
|
+
type: "html" | "plaintext" | "markdown" | "reader" | "react";
|
199
|
+
value: string;
|
200
|
+
}[] | undefined;
|
160
201
|
} & {
|
161
202
|
arguments: {
|
162
203
|
[x: string]: ({
|
package/package.json
CHANGED
package/src/init.ts
CHANGED
@@ -3,7 +3,7 @@ import 'es6-object-assign/auto';
|
|
3
3
|
import 'es6-symbol/implement';
|
4
4
|
import { getProxySDK } from '../../internal/src/client/proxy';
|
5
5
|
import { _configuration } from '../../internal/src/client/symbols';
|
6
|
-
import { IConfigEndpointResponse } from '
|
6
|
+
import { IConfigEndpointResponse } from '../../internal/src/middleware/types';
|
7
7
|
|
8
8
|
interface IInitOptions {
|
9
9
|
debug?: boolean;
|