commandbar 1.7.1 → 1.7.2
Sign up to get free protection for your applications and to get access to all the features.
- package/build/commandbar-js/src/index.js +1 -1
- package/build/commandbar-js/src/init.d.ts +1 -7
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
- package/build/internal/src/client/CommandBarClientSDK.d.ts +18 -5
- package/build/internal/src/client/CommandBarSDK.d.ts +5 -3
- package/build/internal/src/client/EventHandler.d.ts +26 -2
- package/build/internal/src/client/globals.d.ts +1 -0
- package/build/internal/src/client/symbols.d.ts +1 -0
- package/build/internal/src/middleware/CommandFromClientV.d.ts +4 -2
- package/build/internal/src/middleware/OrganizationV.d.ts +8 -2
- package/build/internal/src/middleware/ResourceSettingsV.d.ts +4 -0
- package/build/internal/src/middleware/command.d.ts +100 -62
- package/build/internal/src/middleware/commandCategory.d.ts +32 -0
- package/build/internal/src/middleware/detailPreview.d.ts +1 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +5 -5
- package/build/internal/src/middleware/nudge.d.ts +56 -8
- package/build/internal/src/middleware/organization.d.ts +26 -8
- package/build/internal/src/middleware/types.d.ts +15 -1
- package/package.json +3 -3
- package/src/init.ts +1 -8
- package/src/snippet.ts +2 -2
- package/webpack.config.js +5 -0
@@ -8,6 +8,8 @@ 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
|
+
icon_color: t.UnionC<[t.StringC, t.NullC]>;
|
12
|
+
image_color: t.UnionC<[t.StringC, t.NullC]>;
|
11
13
|
image: t.UnionC<[t.StringC, t.NullC]>;
|
12
14
|
render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
|
13
15
|
setting_hide_before_search: t.BooleanC;
|
@@ -19,6 +21,8 @@ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC
|
|
19
21
|
slash_filter_keyword: t.UnionC<[t.StringC, t.NullC]>;
|
20
22
|
search_tab_instruction: t.StringC;
|
21
23
|
track_recents: t.BooleanC;
|
24
|
+
}>, t.PartialC<{
|
25
|
+
contains_hotloaded_commands: t.BooleanC;
|
22
26
|
}>]>;
|
23
27
|
export declare const BatchEditorCategoryResponseV: t.TypeC<{
|
24
28
|
batch: t.ArrayC<t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
@@ -28,6 +32,8 @@ export declare const BatchEditorCategoryResponseV: t.TypeC<{
|
|
28
32
|
}>, t.PartialC<{}>]>, t.TypeC<{
|
29
33
|
sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
30
34
|
icon: t.UnionC<[t.StringC, t.NullC]>;
|
35
|
+
icon_color: t.UnionC<[t.StringC, t.NullC]>;
|
36
|
+
image_color: t.UnionC<[t.StringC, t.NullC]>;
|
31
37
|
image: t.UnionC<[t.StringC, t.NullC]>;
|
32
38
|
render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
|
33
39
|
setting_hide_before_search: t.BooleanC;
|
@@ -39,6 +45,8 @@ export declare const BatchEditorCategoryResponseV: t.TypeC<{
|
|
39
45
|
slash_filter_keyword: t.UnionC<[t.StringC, t.NullC]>;
|
40
46
|
search_tab_instruction: t.StringC;
|
41
47
|
track_recents: t.BooleanC;
|
48
|
+
}>, t.PartialC<{
|
49
|
+
contains_hotloaded_commands: t.BooleanC;
|
42
50
|
}>]>>;
|
43
51
|
}>;
|
44
52
|
export declare class CommandCategory {
|
@@ -49,6 +57,8 @@ export declare class CommandCategory {
|
|
49
57
|
} & {} & {
|
50
58
|
sort_key: number | null;
|
51
59
|
icon: string | null;
|
60
|
+
icon_color: string | null;
|
61
|
+
image_color: string | null;
|
52
62
|
image: string | null;
|
53
63
|
render_as: "grid" | "list";
|
54
64
|
setting_hide_before_search: boolean;
|
@@ -60,6 +70,8 @@ export declare class CommandCategory {
|
|
60
70
|
slash_filter_keyword: string | null;
|
61
71
|
search_tab_instruction: string;
|
62
72
|
track_recents: boolean;
|
73
|
+
} & {
|
74
|
+
contains_hotloaded_commands?: boolean | undefined;
|
63
75
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
64
76
|
id: number;
|
65
77
|
organization: string | number;
|
@@ -67,6 +79,8 @@ export declare class CommandCategory {
|
|
67
79
|
} & {} & {
|
68
80
|
sort_key: number | null;
|
69
81
|
icon: string | null;
|
82
|
+
icon_color: string | null;
|
83
|
+
image_color: string | null;
|
70
84
|
image: string | null;
|
71
85
|
render_as: "grid" | "list";
|
72
86
|
setting_hide_before_search: boolean;
|
@@ -78,6 +92,8 @@ export declare class CommandCategory {
|
|
78
92
|
slash_filter_keyword: string | null;
|
79
93
|
search_tab_instruction: string;
|
80
94
|
track_recents: boolean;
|
95
|
+
} & {
|
96
|
+
contains_hotloaded_commands?: boolean | undefined;
|
81
97
|
}>;
|
82
98
|
static update: (object: {
|
83
99
|
id: number;
|
@@ -86,6 +102,8 @@ export declare class CommandCategory {
|
|
86
102
|
} & {} & {
|
87
103
|
sort_key: number | null;
|
88
104
|
icon: string | null;
|
105
|
+
icon_color: string | null;
|
106
|
+
image_color: string | null;
|
89
107
|
image: string | null;
|
90
108
|
render_as: "grid" | "list";
|
91
109
|
setting_hide_before_search: boolean;
|
@@ -97,6 +115,8 @@ export declare class CommandCategory {
|
|
97
115
|
slash_filter_keyword: string | null;
|
98
116
|
search_tab_instruction: string;
|
99
117
|
track_recents: boolean;
|
118
|
+
} & {
|
119
|
+
contains_hotloaded_commands?: boolean | undefined;
|
100
120
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
101
121
|
id: number;
|
102
122
|
organization: string | number;
|
@@ -104,6 +124,8 @@ export declare class CommandCategory {
|
|
104
124
|
} & {} & {
|
105
125
|
sort_key: number | null;
|
106
126
|
icon: string | null;
|
127
|
+
icon_color: string | null;
|
128
|
+
image_color: string | null;
|
107
129
|
image: string | null;
|
108
130
|
render_as: "grid" | "list";
|
109
131
|
setting_hide_before_search: boolean;
|
@@ -115,6 +137,8 @@ export declare class CommandCategory {
|
|
115
137
|
slash_filter_keyword: string | null;
|
116
138
|
search_tab_instruction: string;
|
117
139
|
track_recents: boolean;
|
140
|
+
} & {
|
141
|
+
contains_hotloaded_commands?: boolean | undefined;
|
118
142
|
}>;
|
119
143
|
static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
|
120
144
|
static decode: (data: any) => {
|
@@ -124,6 +148,8 @@ export declare class CommandCategory {
|
|
124
148
|
} & {} & {
|
125
149
|
sort_key: number | null;
|
126
150
|
icon: string | null;
|
151
|
+
icon_color: string | null;
|
152
|
+
image_color: string | null;
|
127
153
|
image: string | null;
|
128
154
|
render_as: "grid" | "list";
|
129
155
|
setting_hide_before_search: boolean;
|
@@ -135,6 +161,8 @@ export declare class CommandCategory {
|
|
135
161
|
slash_filter_keyword: string | null;
|
136
162
|
search_tab_instruction: string;
|
137
163
|
track_recents: boolean;
|
164
|
+
} & {
|
165
|
+
contains_hotloaded_commands?: boolean | undefined;
|
138
166
|
};
|
139
167
|
static batch: (request: t.TypeOf<typeof GenericBatchRequest>) => Promise<{
|
140
168
|
batch: ({
|
@@ -144,6 +172,8 @@ export declare class CommandCategory {
|
|
144
172
|
} & {} & {
|
145
173
|
sort_key: number | null;
|
146
174
|
icon: string | null;
|
175
|
+
icon_color: string | null;
|
176
|
+
image_color: string | null;
|
147
177
|
image: string | null;
|
148
178
|
render_as: "grid" | "list";
|
149
179
|
setting_hide_before_search: boolean;
|
@@ -155,6 +185,8 @@ export declare class CommandCategory {
|
|
155
185
|
slash_filter_keyword: string | null;
|
156
186
|
search_tab_instruction: string;
|
157
187
|
track_recents: boolean;
|
188
|
+
} & {
|
189
|
+
contains_hotloaded_commands?: boolean | undefined;
|
158
190
|
})[];
|
159
191
|
}>;
|
160
192
|
}
|
@@ -14,6 +14,7 @@ export declare type DataRowMetadata = {
|
|
14
14
|
value: any;
|
15
15
|
contextKey?: string;
|
16
16
|
uid?: string;
|
17
|
+
inputText?: string;
|
17
18
|
};
|
18
19
|
export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
|
19
20
|
export declare const standardize: (item: undefined | null | DetailPreviewType) => null | DetailPreviewObjectType[];
|
@@ -20,7 +20,7 @@ declare const OperatorV: t.KeyofC<{
|
|
20
20
|
idOnPage: null;
|
21
21
|
}>;
|
22
22
|
export declare const ConditionV: t.IntersectionC<[t.TypeC<{
|
23
|
-
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
|
23
|
+
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
|
24
24
|
operator: t.KeyofC<{
|
25
25
|
includes: null;
|
26
26
|
endsWith: null;
|
@@ -88,7 +88,7 @@ export declare const RecommendationRuleAlwaysV: t.IntersectionC<[t.TypeC<{
|
|
88
88
|
reason: t.UnionC<[t.UndefinedC, t.NullC]>;
|
89
89
|
}>]>;
|
90
90
|
export declare const AvailabilityRuleV: t.IntersectionC<[t.TypeC<{
|
91
|
-
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
|
91
|
+
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
|
92
92
|
operator: t.KeyofC<{
|
93
93
|
includes: null;
|
94
94
|
endsWith: null;
|
@@ -121,7 +121,7 @@ export declare const RecommendationRuleV: t.UnionC<[t.IntersectionC<[t.TypeC<{
|
|
121
121
|
value: t.UnionC<[t.UndefinedC, t.NullC]>;
|
122
122
|
reason: t.UnionC<[t.UndefinedC, t.NullC]>;
|
123
123
|
}>]>, t.IntersectionC<[t.TypeC<{
|
124
|
-
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
|
124
|
+
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
|
125
125
|
operator: t.KeyofC<{
|
126
126
|
includes: null;
|
127
127
|
endsWith: null;
|
@@ -147,7 +147,7 @@ export declare const RecommendationRuleV: t.UnionC<[t.IntersectionC<[t.TypeC<{
|
|
147
147
|
reason: t.StringC;
|
148
148
|
}>]>]>;
|
149
149
|
export declare const EditorAvailabilityRuleV: t.UnionC<[t.IntersectionC<[t.TypeC<{
|
150
|
-
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
|
150
|
+
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
|
151
151
|
operator: t.KeyofC<{
|
152
152
|
includes: null;
|
153
153
|
endsWith: null;
|
@@ -185,7 +185,7 @@ export declare const EditorRecommendationRuleV: t.UnionC<[t.UnionC<[t.Intersecti
|
|
185
185
|
value: t.UnionC<[t.UndefinedC, t.NullC]>;
|
186
186
|
reason: t.UnionC<[t.UndefinedC, t.NullC]>;
|
187
187
|
}>]>, t.IntersectionC<[t.TypeC<{
|
188
|
-
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
|
188
|
+
type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
|
189
189
|
operator: t.KeyofC<{
|
190
190
|
includes: null;
|
191
191
|
endsWith: null;
|
@@ -12,6 +12,11 @@ export declare const NudgeV: t.IntersectionC<[t.TypeC<{
|
|
12
12
|
meta: t.TypeC<{
|
13
13
|
command: t.StringC;
|
14
14
|
}>;
|
15
|
+
}>, t.TypeC<{
|
16
|
+
type: t.LiteralC<"on_event">;
|
17
|
+
meta: t.TypeC<{
|
18
|
+
event: t.StringC;
|
19
|
+
}>;
|
15
20
|
}>]>;
|
16
21
|
on_select: t.TypeC<{
|
17
22
|
type: t.LiteralC<"execute_command">;
|
@@ -20,9 +25,10 @@ export declare const NudgeV: t.IntersectionC<[t.TypeC<{
|
|
20
25
|
}>;
|
21
26
|
}>;
|
22
27
|
timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
|
23
|
-
frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">]>;
|
28
|
+
frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
|
24
29
|
}>, t.PartialC<{
|
25
30
|
title: t.StringC;
|
31
|
+
cta: t.StringC;
|
26
32
|
is_live: t.BooleanC;
|
27
33
|
}>]>;
|
28
34
|
export declare class Nudge {
|
@@ -39,6 +45,11 @@ export declare class Nudge {
|
|
39
45
|
meta: {
|
40
46
|
command: string;
|
41
47
|
};
|
48
|
+
} | {
|
49
|
+
type: "on_event";
|
50
|
+
meta: {
|
51
|
+
event: string;
|
52
|
+
};
|
42
53
|
};
|
43
54
|
on_select: {
|
44
55
|
type: "execute_command";
|
@@ -47,9 +58,10 @@ export declare class Nudge {
|
|
47
58
|
};
|
48
59
|
};
|
49
60
|
timeout_ms: number | null;
|
50
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
61
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
51
62
|
} & {
|
52
63
|
title?: string | undefined;
|
64
|
+
cta?: string | undefined;
|
53
65
|
is_live?: boolean | undefined;
|
54
66
|
};
|
55
67
|
static create: (object: {
|
@@ -65,6 +77,11 @@ export declare class Nudge {
|
|
65
77
|
meta: {
|
66
78
|
command: string;
|
67
79
|
};
|
80
|
+
} | {
|
81
|
+
type: "on_event";
|
82
|
+
meta: {
|
83
|
+
event: string;
|
84
|
+
};
|
68
85
|
};
|
69
86
|
on_select: {
|
70
87
|
type: "execute_command";
|
@@ -73,9 +90,10 @@ export declare class Nudge {
|
|
73
90
|
};
|
74
91
|
};
|
75
92
|
timeout_ms: number | null;
|
76
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
93
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
77
94
|
} & {
|
78
95
|
title?: string | undefined;
|
96
|
+
cta?: string | undefined;
|
79
97
|
is_live?: boolean | undefined;
|
80
98
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
81
99
|
id: number;
|
@@ -90,6 +108,11 @@ export declare class Nudge {
|
|
90
108
|
meta: {
|
91
109
|
command: string;
|
92
110
|
};
|
111
|
+
} | {
|
112
|
+
type: "on_event";
|
113
|
+
meta: {
|
114
|
+
event: string;
|
115
|
+
};
|
93
116
|
};
|
94
117
|
on_select: {
|
95
118
|
type: "execute_command";
|
@@ -98,9 +121,10 @@ export declare class Nudge {
|
|
98
121
|
};
|
99
122
|
};
|
100
123
|
timeout_ms: number | null;
|
101
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
124
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
102
125
|
} & {
|
103
126
|
title?: string | undefined;
|
127
|
+
cta?: string | undefined;
|
104
128
|
is_live?: boolean | undefined;
|
105
129
|
}>;
|
106
130
|
static update: (object: {
|
@@ -116,6 +140,11 @@ export declare class Nudge {
|
|
116
140
|
meta: {
|
117
141
|
command: string;
|
118
142
|
};
|
143
|
+
} | {
|
144
|
+
type: "on_event";
|
145
|
+
meta: {
|
146
|
+
event: string;
|
147
|
+
};
|
119
148
|
};
|
120
149
|
on_select: {
|
121
150
|
type: "execute_command";
|
@@ -124,9 +153,10 @@ export declare class Nudge {
|
|
124
153
|
};
|
125
154
|
};
|
126
155
|
timeout_ms: number | null;
|
127
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
156
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
128
157
|
} & {
|
129
158
|
title?: string | undefined;
|
159
|
+
cta?: string | undefined;
|
130
160
|
is_live?: boolean | undefined;
|
131
161
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
132
162
|
id: number;
|
@@ -141,6 +171,11 @@ export declare class Nudge {
|
|
141
171
|
meta: {
|
142
172
|
command: string;
|
143
173
|
};
|
174
|
+
} | {
|
175
|
+
type: "on_event";
|
176
|
+
meta: {
|
177
|
+
event: string;
|
178
|
+
};
|
144
179
|
};
|
145
180
|
on_select: {
|
146
181
|
type: "execute_command";
|
@@ -149,9 +184,10 @@ export declare class Nudge {
|
|
149
184
|
};
|
150
185
|
};
|
151
186
|
timeout_ms: number | null;
|
152
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
187
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
153
188
|
} & {
|
154
189
|
title?: string | undefined;
|
190
|
+
cta?: string | undefined;
|
155
191
|
is_live?: boolean | undefined;
|
156
192
|
}>;
|
157
193
|
static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
|
@@ -168,6 +204,11 @@ export declare class Nudge {
|
|
168
204
|
meta: {
|
169
205
|
command: string;
|
170
206
|
};
|
207
|
+
} | {
|
208
|
+
type: "on_event";
|
209
|
+
meta: {
|
210
|
+
event: string;
|
211
|
+
};
|
171
212
|
};
|
172
213
|
on_select: {
|
173
214
|
type: "execute_command";
|
@@ -176,9 +217,10 @@ export declare class Nudge {
|
|
176
217
|
};
|
177
218
|
};
|
178
219
|
timeout_ms: number | null;
|
179
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
220
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
180
221
|
} & {
|
181
222
|
title?: string | undefined;
|
223
|
+
cta?: string | undefined;
|
182
224
|
is_live?: boolean | undefined;
|
183
225
|
})[]>;
|
184
226
|
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
@@ -197,6 +239,11 @@ export declare class Nudge {
|
|
197
239
|
meta: {
|
198
240
|
command: string;
|
199
241
|
};
|
242
|
+
} | {
|
243
|
+
type: "on_event";
|
244
|
+
meta: {
|
245
|
+
event: string;
|
246
|
+
};
|
200
247
|
};
|
201
248
|
on_select: {
|
202
249
|
type: "execute_command";
|
@@ -205,9 +252,10 @@ export declare class Nudge {
|
|
205
252
|
};
|
206
253
|
};
|
207
254
|
timeout_ms: number | null;
|
208
|
-
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
255
|
+
frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
|
209
256
|
} & {
|
210
257
|
title?: string | undefined;
|
258
|
+
cta?: string | undefined;
|
211
259
|
is_live?: boolean | undefined;
|
212
260
|
}>;
|
213
261
|
}
|
@@ -56,7 +56,7 @@ export declare class Organization {
|
|
56
56
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
57
57
|
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
58
58
|
show_launcher_recommendations: boolean;
|
59
|
-
recommendations_type: "None" | "Custom" | "Algorithm";
|
59
|
+
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
60
60
|
launcher_offset_x: number;
|
61
61
|
launcher_offset_y: number;
|
62
62
|
theme: object;
|
@@ -78,6 +78,8 @@ export declare class Organization {
|
|
78
78
|
unfurl?: boolean | undefined;
|
79
79
|
description_field?: string | undefined;
|
80
80
|
icon?: string | undefined;
|
81
|
+
icon_color?: string | undefined;
|
82
|
+
image_color?: string | undefined;
|
81
83
|
image?: string | undefined;
|
82
84
|
sort_key?: number | undefined;
|
83
85
|
max_options_count?: number | null | undefined;
|
@@ -131,6 +133,7 @@ export declare class Organization {
|
|
131
133
|
slash_filters_enabled: boolean;
|
132
134
|
recents_sort_key: number | null;
|
133
135
|
recommended_sort_key: number | null;
|
136
|
+
has_hotloaded_help_docs: boolean;
|
134
137
|
}>;
|
135
138
|
static update: (object: {
|
136
139
|
id: string | number;
|
@@ -140,7 +143,7 @@ export declare class Organization {
|
|
140
143
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
141
144
|
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
142
145
|
show_launcher_recommendations: boolean;
|
143
|
-
recommendations_type: "None" | "Custom" | "Algorithm";
|
146
|
+
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
144
147
|
launcher_offset_x: number;
|
145
148
|
launcher_offset_y: number;
|
146
149
|
theme: object;
|
@@ -162,6 +165,8 @@ export declare class Organization {
|
|
162
165
|
unfurl?: boolean | undefined;
|
163
166
|
description_field?: string | undefined;
|
164
167
|
icon?: string | undefined;
|
168
|
+
icon_color?: string | undefined;
|
169
|
+
image_color?: string | undefined;
|
165
170
|
image?: string | undefined;
|
166
171
|
sort_key?: number | undefined;
|
167
172
|
max_options_count?: number | null | undefined;
|
@@ -215,6 +220,7 @@ export declare class Organization {
|
|
215
220
|
slash_filters_enabled: boolean;
|
216
221
|
recents_sort_key: number | null;
|
217
222
|
recommended_sort_key: number | null;
|
223
|
+
has_hotloaded_help_docs: boolean;
|
218
224
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
219
225
|
id: string | number;
|
220
226
|
name: string;
|
@@ -223,7 +229,7 @@ export declare class Organization {
|
|
223
229
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
224
230
|
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
225
231
|
show_launcher_recommendations: boolean;
|
226
|
-
recommendations_type: "None" | "Custom" | "Algorithm";
|
232
|
+
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
227
233
|
launcher_offset_x: number;
|
228
234
|
launcher_offset_y: number;
|
229
235
|
theme: object;
|
@@ -245,6 +251,8 @@ export declare class Organization {
|
|
245
251
|
unfurl?: boolean | undefined;
|
246
252
|
description_field?: string | undefined;
|
247
253
|
icon?: string | undefined;
|
254
|
+
icon_color?: string | undefined;
|
255
|
+
image_color?: string | undefined;
|
248
256
|
image?: string | undefined;
|
249
257
|
sort_key?: number | undefined;
|
250
258
|
max_options_count?: number | null | undefined;
|
@@ -298,6 +306,7 @@ export declare class Organization {
|
|
298
306
|
slash_filters_enabled: boolean;
|
299
307
|
recents_sort_key: number | null;
|
300
308
|
recommended_sort_key: number | null;
|
309
|
+
has_hotloaded_help_docs: boolean;
|
301
310
|
}>;
|
302
311
|
static listCommands: (orgUID: string) => Promise<({
|
303
312
|
id: number;
|
@@ -555,14 +564,14 @@ export declare class Organization {
|
|
555
564
|
};
|
556
565
|
tags: string[];
|
557
566
|
availability_rules: ({
|
558
|
-
type: "url" | "element" | "context";
|
567
|
+
type: "url" | "element" | "context" | "event_count";
|
559
568
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
560
569
|
} & {
|
561
570
|
field?: string | undefined;
|
562
571
|
value?: string | undefined;
|
563
572
|
reason?: string | undefined;
|
564
573
|
})[] | (({
|
565
|
-
type: "url" | "element" | "context";
|
574
|
+
type: "url" | "element" | "context" | "event_count";
|
566
575
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
567
576
|
} & {
|
568
577
|
field?: string | undefined;
|
@@ -575,7 +584,7 @@ export declare class Organization {
|
|
575
584
|
reason?: string | undefined;
|
576
585
|
}))[];
|
577
586
|
recommend_rules: (({
|
578
|
-
type: "url" | "element" | "context";
|
587
|
+
type: "url" | "element" | "context" | "event_count";
|
579
588
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
580
589
|
} & {
|
581
590
|
field?: string | undefined;
|
@@ -589,7 +598,7 @@ export declare class Organization {
|
|
589
598
|
value?: null | undefined;
|
590
599
|
reason?: null | undefined;
|
591
600
|
}))[] | (({
|
592
|
-
type: "url" | "element" | "context";
|
601
|
+
type: "url" | "element" | "context" | "event_count";
|
593
602
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
594
603
|
} & {
|
595
604
|
field?: string | undefined;
|
@@ -619,6 +628,8 @@ export declare class Organization {
|
|
619
628
|
category: number | null;
|
620
629
|
sort_key: number | null;
|
621
630
|
icon: string | null;
|
631
|
+
icon_color: string | null;
|
632
|
+
image_color: string | null;
|
622
633
|
image: string | null;
|
623
634
|
celebrate: boolean | {
|
624
635
|
angle?: number | undefined;
|
@@ -662,6 +673,8 @@ export declare class Organization {
|
|
662
673
|
} & {} & {
|
663
674
|
sort_key: number | null;
|
664
675
|
icon: string | null;
|
676
|
+
icon_color: string | null;
|
677
|
+
image_color: string | null;
|
665
678
|
image: string | null;
|
666
679
|
render_as: "grid" | "list";
|
667
680
|
setting_hide_before_search: boolean;
|
@@ -673,6 +686,8 @@ export declare class Organization {
|
|
673
686
|
slash_filter_keyword: string | null;
|
674
687
|
search_tab_instruction: string;
|
675
688
|
track_recents: boolean;
|
689
|
+
} & {
|
690
|
+
contains_hotloaded_commands?: boolean | undefined;
|
676
691
|
})[]>;
|
677
692
|
static listGuides: (orgUID: string) => Promise<({
|
678
693
|
id: number;
|
@@ -849,7 +864,7 @@ export declare class Organization {
|
|
849
864
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
850
865
|
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
851
866
|
show_launcher_recommendations: boolean;
|
852
|
-
recommendations_type: "None" | "Custom" | "Algorithm";
|
867
|
+
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
853
868
|
launcher_offset_x: number;
|
854
869
|
launcher_offset_y: number;
|
855
870
|
theme: object;
|
@@ -871,6 +886,8 @@ export declare class Organization {
|
|
871
886
|
unfurl?: boolean | undefined;
|
872
887
|
description_field?: string | undefined;
|
873
888
|
icon?: string | undefined;
|
889
|
+
icon_color?: string | undefined;
|
890
|
+
image_color?: string | undefined;
|
874
891
|
image?: string | undefined;
|
875
892
|
sort_key?: number | undefined;
|
876
893
|
max_options_count?: number | null | undefined;
|
@@ -924,5 +941,6 @@ export declare class Organization {
|
|
924
941
|
slash_filters_enabled: boolean;
|
925
942
|
recents_sort_key: number | null;
|
926
943
|
recommended_sort_key: number | null;
|
944
|
+
has_hotloaded_help_docs: boolean;
|
927
945
|
};
|
928
946
|
}
|
@@ -23,6 +23,13 @@ import { NudgeV } from './nudge';
|
|
23
23
|
import { TabV } from './tab';
|
24
24
|
import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
|
25
25
|
/*******************************************************************************/
|
26
|
+
export declare type IInitOptions = {
|
27
|
+
debug?: boolean;
|
28
|
+
environment?: string;
|
29
|
+
version?: string;
|
30
|
+
config?: IConfigEndpointResponse;
|
31
|
+
};
|
32
|
+
/*******************************************************************************/
|
26
33
|
export declare type IContextType = t.TypeOf<typeof ContextV> & unknown;
|
27
34
|
export declare type IUserType = t.TypeOf<typeof UserV> & unknown;
|
28
35
|
export declare type ICommandType = t.TypeOf<typeof CommandV> & unknown;
|
@@ -76,7 +83,7 @@ export declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderA
|
|
76
83
|
export declare type INudgeType = t.TypeOf<typeof NudgeV> & unknown;
|
77
84
|
export interface INudgeClientType {
|
78
85
|
nudge: INudgeType;
|
79
|
-
|
86
|
+
passedConditionsInLastEvaluation: boolean;
|
80
87
|
lastTriggeredTs?: number;
|
81
88
|
}
|
82
89
|
export interface ICommandInput {
|
@@ -94,6 +101,13 @@ export declare type IHistoryType = Array<{
|
|
94
101
|
export interface IUserContext {
|
95
102
|
[variable: string]: any;
|
96
103
|
}
|
104
|
+
export interface EventWithTimestamp {
|
105
|
+
eventName: string;
|
106
|
+
properties: {
|
107
|
+
[prop: string]: any;
|
108
|
+
};
|
109
|
+
timestamp: number;
|
110
|
+
}
|
97
111
|
export interface ICallbackMap {
|
98
112
|
[variable: string]: (...args: any[]) => unknown;
|
99
113
|
}
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "commandbar",
|
3
|
-
"version": "1.7.
|
3
|
+
"version": "1.7.2",
|
4
4
|
"description": "Javascript Utility for CommandBar",
|
5
5
|
"main": "build/commandbar-js/src/index.js",
|
6
6
|
"types": "build/commandbar-js/src/index.d.ts",
|
@@ -20,12 +20,12 @@
|
|
20
20
|
"dependencies": {
|
21
21
|
"commandbar-launcher": "^1.1.9",
|
22
22
|
"fp-ts": "2.10.5",
|
23
|
-
"io-ts": "2.2.
|
23
|
+
"io-ts": "^2.2.14",
|
24
24
|
"react-hot-toast": "^2.3.0"
|
25
25
|
},
|
26
26
|
"devDependencies": {
|
27
27
|
"rimraf": "3.0.2",
|
28
28
|
"typescript": "4.6.2",
|
29
|
-
"webpack": "5.74.0"
|
29
|
+
"webpack": "^5.74.0"
|
30
30
|
}
|
31
31
|
}
|
package/src/init.ts
CHANGED
@@ -3,14 +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 {
|
7
|
-
|
8
|
-
interface IInitOptions {
|
9
|
-
debug?: boolean;
|
10
|
-
environment?: string;
|
11
|
-
version?: string;
|
12
|
-
config?: IConfigEndpointResponse;
|
13
|
-
}
|
6
|
+
import { IInitOptions } from '../../internal/src/middleware/types';
|
14
7
|
|
15
8
|
const getSrc = (org: string) => {
|
16
9
|
let origin = 'https://api.commandbar.com';
|
package/src/snippet.ts
CHANGED
@@ -46,7 +46,7 @@ export const snippet = (org: string) => {
|
|
46
46
|
w.CommandBar,
|
47
47
|
);
|
48
48
|
|
49
|
-
const
|
49
|
+
const ASYNC_METHODS_SNIPPET = ['addCommand', 'boot', 'addEventSubscriber', 'addRecordAction', 'setFormFactor'];
|
50
50
|
|
51
51
|
const sdk = proxy;
|
52
52
|
|
@@ -58,7 +58,7 @@ export const snippet = (org: string) => {
|
|
58
58
|
w.CommandBar = new Proxy(proxy, {
|
59
59
|
get: function (_, prop) {
|
60
60
|
if (prop in sdk) return proxy[prop];
|
61
|
-
if (
|
61
|
+
if (ASYNC_METHODS_SNIPPET.includes(prop as string)) {
|
62
62
|
return function () {
|
63
63
|
// eslint-disable-next-line prefer-rest-params
|
64
64
|
const a = Array.prototype.slice.call(arguments);
|
package/webpack.config.js
CHANGED
@@ -1,4 +1,5 @@
|
|
1
1
|
const path = require('path');
|
2
|
+
const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer');
|
2
3
|
|
3
4
|
module.exports = {
|
4
5
|
mode: 'production',
|
@@ -27,4 +28,8 @@ module.exports = {
|
|
27
28
|
extensions: ['.ts', '.js', '.json', '.tsx'],
|
28
29
|
},
|
29
30
|
stats: 'minimal',
|
31
|
+
plugins: [process.env.ENABLE_STATSFILE_GENERATION && new BundleAnalyzerPlugin({
|
32
|
+
analyzerMode: 'disabled',
|
33
|
+
generateStatsFile: true
|
34
|
+
})].filter(Boolean),
|
30
35
|
};
|