commandbar 1.6.3 → 1.6.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/commandbar-js/src/init.d.ts +3 -0
  3. package/build/internal/src/client/{Reporting.d.ts → AnalyticsEventTypes.d.ts} +1 -1
  4. package/build/internal/src/client/CommandBarClientSDK.d.ts +44 -6
  5. package/build/internal/src/client/CommandBarSDK.d.ts +2 -2
  6. package/build/internal/src/client/EventHandler.d.ts +19 -1
  7. package/build/internal/src/client/SDKConfig.d.ts +5 -0
  8. package/build/internal/src/client/globals.d.ts +18 -0
  9. package/build/internal/src/middleware/CommandFromClientV.d.ts +11 -4
  10. package/build/internal/src/middleware/OrganizationV.d.ts +6 -0
  11. package/build/internal/src/middleware/ResourceSettingsV.d.ts +6 -0
  12. package/build/internal/src/middleware/command.d.ts +2852 -0
  13. package/build/internal/src/middleware/commandCategory.d.ts +87 -0
  14. package/build/internal/src/middleware/context.d.ts +40 -0
  15. package/build/internal/src/middleware/environment.d.ts +11 -0
  16. package/build/internal/src/middleware/generics.d.ts +32 -0
  17. package/build/internal/src/middleware/guide.d.ts +37 -0
  18. package/build/internal/src/middleware/helpers/endUser.d.ts +10 -0
  19. package/build/internal/src/middleware/helpers/rules.d.ts +154 -3
  20. package/build/internal/src/middleware/historyEvent.d.ts +40 -0
  21. package/build/internal/src/middleware/network.d.ts +4 -0
  22. package/build/internal/src/middleware/organization.d.ts +589 -0
  23. package/build/internal/src/middleware/placeholder.d.ts +47 -0
  24. package/build/internal/src/middleware/profile.d.ts +11 -0
  25. package/build/internal/src/middleware/releases.d.ts +261 -0
  26. package/build/internal/src/middleware/skin.d.ts +66 -0
  27. package/build/internal/src/middleware/types.d.ts +359 -0
  28. package/build/internal/src/middleware/user.d.ts +12 -0
  29. package/build/internal/src/util/LocalStorage.d.ts +6 -0
  30. package/build/internal/src/util/Logger.d.ts +18 -0
  31. package/build/internal/src/util/dispatchCustomEvent.d.ts +2 -0
  32. package/package.json +2 -2
  33. package/src/init.ts +10 -2
  34. package/src/snippet.ts +1 -1
@@ -0,0 +1,87 @@
1
+ /*******************************************************************************/
2
+ import * as t from 'io-ts';
3
+ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
4
+ id: t.NumberC;
5
+ organization: t.UnionC<[t.NumberC, t.StringC]>;
6
+ name: t.StringC;
7
+ }>, t.PartialC<{}>]>, t.TypeC<{
8
+ sort_key: t.UnionC<[t.NumberC, t.NullC]>;
9
+ icon: t.UnionC<[t.StringC, t.NullC]>;
10
+ setting_hide_before_search: t.BooleanC;
11
+ setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
12
+ setting_pin_to_bottom: t.BooleanC;
13
+ search_tab_enabled: t.BooleanC;
14
+ search_tab_name: t.StringC;
15
+ search_tab_instruction: t.StringC;
16
+ }>]>;
17
+ export declare class CommandCategory {
18
+ static create: (object: {
19
+ id: number;
20
+ organization: string | number;
21
+ name: string;
22
+ } & {} & {
23
+ sort_key: number | null;
24
+ icon: string | null;
25
+ setting_hide_before_search: boolean;
26
+ setting_max_options_count: number | null;
27
+ setting_pin_to_bottom: boolean;
28
+ search_tab_enabled: boolean;
29
+ search_tab_name: string;
30
+ search_tab_instruction: string;
31
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
32
+ id: number;
33
+ organization: string | number;
34
+ name: string;
35
+ } & {} & {
36
+ sort_key: number | null;
37
+ icon: string | null;
38
+ setting_hide_before_search: boolean;
39
+ setting_max_options_count: number | null;
40
+ setting_pin_to_bottom: boolean;
41
+ search_tab_enabled: boolean;
42
+ search_tab_name: string;
43
+ search_tab_instruction: string;
44
+ }>;
45
+ static update: (object: {
46
+ id: number;
47
+ organization: string | number;
48
+ name: string;
49
+ } & {} & {
50
+ sort_key: number | null;
51
+ icon: string | null;
52
+ setting_hide_before_search: boolean;
53
+ setting_max_options_count: number | null;
54
+ setting_pin_to_bottom: boolean;
55
+ search_tab_enabled: boolean;
56
+ search_tab_name: string;
57
+ search_tab_instruction: string;
58
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
59
+ id: number;
60
+ organization: string | number;
61
+ name: string;
62
+ } & {} & {
63
+ sort_key: number | null;
64
+ icon: string | null;
65
+ setting_hide_before_search: boolean;
66
+ setting_max_options_count: number | null;
67
+ setting_pin_to_bottom: boolean;
68
+ search_tab_enabled: boolean;
69
+ search_tab_name: string;
70
+ search_tab_instruction: string;
71
+ }>;
72
+ static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
73
+ static decode: (data: any) => {
74
+ id: number;
75
+ organization: string | number;
76
+ name: string;
77
+ } & {} & {
78
+ sort_key: number | null;
79
+ icon: string | null;
80
+ setting_hide_before_search: boolean;
81
+ setting_max_options_count: number | null;
82
+ setting_pin_to_bottom: boolean;
83
+ search_tab_enabled: boolean;
84
+ search_tab_name: string;
85
+ search_tab_instruction: string;
86
+ };
87
+ }
@@ -0,0 +1,40 @@
1
+ import * as t from 'io-ts';
2
+ export declare const ContextV: t.IntersectionC<[t.TypeC<{
3
+ id: t.NumberC;
4
+ name: t.StringC;
5
+ organization: t.StringC;
6
+ value: t.RecordC<t.StringC, t.AnyC>;
7
+ }>, t.PartialC<{}>]>;
8
+ export declare class Context {
9
+ static create: (object: {
10
+ id: number;
11
+ name: string;
12
+ organization: string;
13
+ value: {
14
+ [x: string]: any;
15
+ };
16
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
17
+ id: number;
18
+ name: string;
19
+ organization: string;
20
+ value: {
21
+ [x: string]: any;
22
+ };
23
+ } & {}>;
24
+ static update: (object: {
25
+ id: number;
26
+ name: string;
27
+ organization: string;
28
+ value: {
29
+ [x: string]: any;
30
+ };
31
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
32
+ id: number;
33
+ name: string;
34
+ organization: string;
35
+ value: {
36
+ [x: string]: any;
37
+ };
38
+ } & {}>;
39
+ static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
40
+ }
@@ -0,0 +1,11 @@
1
+ import * as t from 'io-ts';
2
+ export declare const EnvironmentV: t.TypeC<{
3
+ env: t.StringC;
4
+ version: t.UnionC<[t.NumberC, t.StringC, t.NullC, t.UndefinedC]>;
5
+ }>;
6
+ export declare class Environment {
7
+ static decode: (data: any) => {
8
+ env: string;
9
+ version: string | number | null | undefined;
10
+ };
11
+ }
@@ -0,0 +1,32 @@
1
+ import * as t from 'io-ts';
2
+ declare function decodeToPromise<T, O, I>(validator: t.Type<T, O, I>, input: I): Promise<T>;
3
+ declare function decodeThrowing<T, O, I>(validator: t.Type<T, O, I>, input: I): T;
4
+ declare const GenericObject: t.TypeC<{
5
+ id: t.UnionC<[t.NumberC, t.StringC]>;
6
+ }>;
7
+ export declare type GenericObjectType = t.TypeOf<typeof GenericObject>;
8
+ declare function createObject<T, Q, O, I>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
9
+ declare function readObject<T, O, I>(arg: t.Type<T, O, I>, url: string): (arg0: string, params?: Record<string, string>, callbacks?: {
10
+ onSuccess?: () => void;
11
+ onError?: (err: string) => void;
12
+ }) => Promise<T>;
13
+ declare function listObject<T, O, I>(arg: t.Type<T, O, I>, obj: string): (onSuccess?: () => void, onError?: (err: string) => void) => Promise<T[]>;
14
+ declare function updateObject<T, O, I, Q extends GenericObjectType>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
15
+ declare function deleteObject<T, O, I>(arg: t.Type<T, O, I>, url: string, params?: Record<string, string>): (id: number | string, onSuccess?: () => void, onError?: (err: string) => void) => Promise<void>;
16
+ declare function readObjectDetail<T, O, I>(arg: t.Type<T, O, I>, url: string, detail: string): (arg0: string, urlArgs?: {
17
+ [arg: string]: string;
18
+ }, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
19
+ declare function updateObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I>, input: t.Type<Q, K, J>, url: string, detail: string): (object: Q, urlArgs?: {
20
+ [arg: string]: string;
21
+ }, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
22
+ declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I>, input: t.Type<Q, K, J>, url: string, detail: string): (object: Q, onSuccess?: () => void, onError?: (err: string) => void, urlArgs?: {
23
+ [arg: string]: string;
24
+ }) => Promise<T>;
25
+ declare function loadIDList(ids: number[], klass: any, method?: string, urlArgs?: {
26
+ [arg: string]: string;
27
+ }): Promise<any[]>;
28
+ declare function read<T, O, I>(arg: t.Type<T, O, I>, url: string): (params?: Record<string, string>, callbacks?: {
29
+ onSuccess?: () => void;
30
+ onError?: (err: string) => void;
31
+ }) => Promise<T>;
32
+ export { createObject, createObjectDetail, read, readObject, listObject, updateObject, deleteObject, GenericObject, readObjectDetail, updateObjectDetail, loadIDList, decodeToPromise, decodeThrowing, };
@@ -0,0 +1,37 @@
1
+ import * as t from 'io-ts';
2
+ export declare const GuideV: t.IntersectionC<[t.TypeC<{
3
+ id: t.NumberC;
4
+ organization: t.StringC;
5
+ event: t.StringC;
6
+ nudge: t.StringC;
7
+ guidance: t.StringC;
8
+ }>, t.PartialC<{}>]>;
9
+ export declare class Guide {
10
+ static create: (object: {
11
+ id: number;
12
+ organization: string;
13
+ event: string;
14
+ nudge: string;
15
+ guidance: string;
16
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
17
+ id: number;
18
+ organization: string;
19
+ event: string;
20
+ nudge: string;
21
+ guidance: string;
22
+ } & {}>;
23
+ static update: (object: {
24
+ id: number;
25
+ organization: string;
26
+ event: string;
27
+ nudge: string;
28
+ guidance: string;
29
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
30
+ id: number;
31
+ organization: string;
32
+ event: string;
33
+ nudge: string;
34
+ guidance: string;
35
+ } & {}>;
36
+ static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
37
+ }
@@ -0,0 +1,10 @@
1
+ import * as t from 'io-ts';
2
+ export declare const EndUserV: t.TypeC<{
3
+ username: t.StringC;
4
+ slug: t.StringC;
5
+ organization: t.StringC;
6
+ has_access: t.BooleanC;
7
+ has_opened: t.BooleanC;
8
+ hotkeys_debug: t.BooleanC;
9
+ hmac: t.UnionC<[t.StringC, t.UndefinedC]>;
10
+ }>;
@@ -19,7 +19,7 @@ declare const OperatorV: t.KeyofC<{
19
19
  classnameOnPage: null;
20
20
  idOnPage: null;
21
21
  }>;
22
- export declare const AvailabilityRuleV: t.IntersectionC<[t.TypeC<{
22
+ export declare const ConditionV: t.IntersectionC<[t.TypeC<{
23
23
  type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
24
24
  operator: t.KeyofC<{
25
25
  includes: null;
@@ -45,9 +45,22 @@ export declare const AvailabilityRuleV: t.IntersectionC<[t.TypeC<{
45
45
  value: t.StringC;
46
46
  reason: t.StringC;
47
47
  }>]>;
48
- export declare const RecommendationRuleV: t.IntersectionC<[t.TypeC<{
49
- type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"always">]>;
48
+ export declare const NamedRuleReferenceV: t.IntersectionC<[t.TypeC<{
49
+ type: t.LiteralC<"named_rule">;
50
+ rule_id: t.NumberC;
51
+ }>, t.PartialC<{
52
+ reason: t.StringC;
53
+ }>]>;
54
+ export declare const RecommendationRuleAlwaysV: t.IntersectionC<[t.TypeC<{
55
+ type: t.LiteralC<"always">;
50
56
  }>, t.PartialC<{
57
+ operator: t.UnionC<[t.UndefinedC, t.NullC]>;
58
+ field: t.UnionC<[t.UndefinedC, t.NullC]>;
59
+ value: t.UnionC<[t.UndefinedC, t.NullC]>;
60
+ reason: t.UnionC<[t.UndefinedC, t.NullC]>;
61
+ }>]>;
62
+ export declare const AvailabilityRuleV: t.IntersectionC<[t.TypeC<{
63
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
51
64
  operator: t.KeyofC<{
52
65
  includes: null;
53
66
  endsWith: null;
@@ -67,14 +80,152 @@ export declare const RecommendationRuleV: t.IntersectionC<[t.TypeC<{
67
80
  classnameOnPage: null;
68
81
  idOnPage: null;
69
82
  }>;
83
+ }>, t.PartialC<{
70
84
  field: t.StringC;
71
85
  value: t.StringC;
72
86
  reason: t.StringC;
73
87
  }>]>;
88
+ export declare const RecommendationRuleV: t.UnionC<[t.IntersectionC<[t.TypeC<{
89
+ type: t.LiteralC<"always">;
90
+ }>, t.PartialC<{
91
+ operator: t.UnionC<[t.UndefinedC, t.NullC]>;
92
+ field: t.UnionC<[t.UndefinedC, t.NullC]>;
93
+ value: t.UnionC<[t.UndefinedC, t.NullC]>;
94
+ reason: t.UnionC<[t.UndefinedC, t.NullC]>;
95
+ }>]>, t.IntersectionC<[t.TypeC<{
96
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
97
+ operator: t.KeyofC<{
98
+ includes: null;
99
+ endsWith: null;
100
+ startsWith: null;
101
+ is: null;
102
+ isTruthy: null;
103
+ isFalsy: null;
104
+ isNot: null;
105
+ isTrue: null;
106
+ isFalse: null;
107
+ doesNotInclude: null;
108
+ matchesRegex: null;
109
+ isGreaterThan: null;
110
+ isLessThan: null;
111
+ isDefined: null;
112
+ isNotDefined: null;
113
+ classnameOnPage: null;
114
+ idOnPage: null;
115
+ }>;
116
+ }>, t.PartialC<{
117
+ field: t.StringC;
118
+ value: t.StringC;
119
+ reason: t.StringC;
120
+ }>]>]>;
121
+ export declare const EditorAvailabilityRuleV: t.UnionC<[t.IntersectionC<[t.TypeC<{
122
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
123
+ operator: t.KeyofC<{
124
+ includes: null;
125
+ endsWith: null;
126
+ startsWith: null;
127
+ is: null;
128
+ isTruthy: null;
129
+ isFalsy: null;
130
+ isNot: null;
131
+ isTrue: null;
132
+ isFalse: null;
133
+ doesNotInclude: null;
134
+ matchesRegex: null;
135
+ isGreaterThan: null;
136
+ isLessThan: null;
137
+ isDefined: null;
138
+ isNotDefined: null;
139
+ classnameOnPage: null;
140
+ idOnPage: null;
141
+ }>;
142
+ }>, t.PartialC<{
143
+ field: t.StringC;
144
+ value: t.StringC;
145
+ reason: t.StringC;
146
+ }>]>, t.IntersectionC<[t.TypeC<{
147
+ type: t.LiteralC<"named_rule">;
148
+ rule_id: t.NumberC;
149
+ }>, t.PartialC<{
150
+ reason: t.StringC;
151
+ }>]>]>;
152
+ export declare const EditorRecommendationRuleV: t.UnionC<[t.UnionC<[t.IntersectionC<[t.TypeC<{
153
+ type: t.LiteralC<"always">;
154
+ }>, t.PartialC<{
155
+ operator: t.UnionC<[t.UndefinedC, t.NullC]>;
156
+ field: t.UnionC<[t.UndefinedC, t.NullC]>;
157
+ value: t.UnionC<[t.UndefinedC, t.NullC]>;
158
+ reason: t.UnionC<[t.UndefinedC, t.NullC]>;
159
+ }>]>, t.IntersectionC<[t.TypeC<{
160
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
161
+ operator: t.KeyofC<{
162
+ includes: null;
163
+ endsWith: null;
164
+ startsWith: null;
165
+ is: null;
166
+ isTruthy: null;
167
+ isFalsy: null;
168
+ isNot: null;
169
+ isTrue: null;
170
+ isFalse: null;
171
+ doesNotInclude: null;
172
+ matchesRegex: null;
173
+ isGreaterThan: null;
174
+ isLessThan: null;
175
+ isDefined: null;
176
+ isNotDefined: null;
177
+ classnameOnPage: null;
178
+ idOnPage: null;
179
+ }>;
180
+ }>, t.PartialC<{
181
+ field: t.StringC;
182
+ value: t.StringC;
183
+ reason: t.StringC;
184
+ }>]>]>, t.IntersectionC<[t.TypeC<{
185
+ type: t.LiteralC<"named_rule">;
186
+ rule_id: t.NumberC;
187
+ }>, t.PartialC<{
188
+ reason: t.StringC;
189
+ }>]>]>;
190
+ export declare const NamedRuleV: t.TypeC<{
191
+ id: t.NumberC;
192
+ name: t.StringC;
193
+ conditions: t.ArrayC<t.IntersectionC<[t.TypeC<{
194
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">]>;
195
+ operator: t.KeyofC<{
196
+ includes: null;
197
+ endsWith: null;
198
+ startsWith: null;
199
+ is: null;
200
+ isTruthy: null;
201
+ isFalsy: null;
202
+ isNot: null;
203
+ isTrue: null;
204
+ isFalse: null;
205
+ doesNotInclude: null;
206
+ matchesRegex: null;
207
+ isGreaterThan: null;
208
+ isLessThan: null;
209
+ isDefined: null;
210
+ isNotDefined: null;
211
+ classnameOnPage: null;
212
+ idOnPage: null;
213
+ }>;
214
+ }>, t.PartialC<{
215
+ field: t.StringC;
216
+ value: t.StringC;
217
+ reason: t.StringC;
218
+ }>]>>;
219
+ }>;
74
220
  export declare type IRuleOperator = t.TypeOf<typeof OperatorV>;
75
221
  export declare type IAvailabilityRule = t.TypeOf<typeof AvailabilityRuleV>;
222
+ export declare type IEditorAvailabilityRule = t.TypeOf<typeof EditorAvailabilityRuleV>;
76
223
  export declare type IRecommendationRule = t.TypeOf<typeof RecommendationRuleV>;
224
+ export declare type IEditorRecommendationRule = t.TypeOf<typeof EditorRecommendationRuleV>;
225
+ export declare type ICondition = t.TypeOf<typeof ConditionV>;
77
226
  export declare type IAvailabilityRuleType = IAvailabilityRule['type'];
78
227
  export declare type IRecommendationRuleType = IRecommendationRule['type'];
79
228
  export declare type IRule = IAvailabilityRule | IRecommendationRule;
229
+ export declare type IEditorRule = IEditorAvailabilityRule | IEditorRecommendationRule;
230
+ export declare type INamedRule = t.TypeOf<typeof NamedRuleV>;
80
231
  export {};
@@ -0,0 +1,40 @@
1
+ import * as t from 'io-ts';
2
+ export declare const HistoryEventV: t.IntersectionC<[t.TypeC<{
3
+ id: t.NumberC;
4
+ organization: t.StringC;
5
+ changed_by: t.StringC;
6
+ description: t.StringC;
7
+ created: t.StringC;
8
+ sha1: t.StringC;
9
+ version_num: t.NumberC;
10
+ }>, t.PartialC<{}>]>;
11
+ export declare class HistoryEvent {
12
+ static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
13
+ id: number;
14
+ organization: string;
15
+ changed_by: string;
16
+ description: string;
17
+ created: string;
18
+ sha1: string;
19
+ version_num: number;
20
+ } & {})[]>;
21
+ static revert: (object: {
22
+ id: number;
23
+ organization: string;
24
+ changed_by: string;
25
+ description: string;
26
+ created: string;
27
+ sha1: string;
28
+ version_num: number;
29
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined, urlArgs?: {
30
+ [arg: string]: string;
31
+ } | undefined) => Promise<{
32
+ id: number;
33
+ organization: string;
34
+ changed_by: string;
35
+ description: string;
36
+ created: string;
37
+ sha1: string;
38
+ version_num: number;
39
+ } & {}>;
40
+ }
@@ -0,0 +1,4 @@
1
+ export declare const baseURL: string;
2
+ export declare const authorizationHeader: string | null;
3
+ declare const axiosInstance: import("axios").AxiosInstance;
4
+ export default axiosInstance;