commandbar 1.7.0 → 1.7.2

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.
Files changed (25) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/commandbar-js/src/init.d.ts +1 -7
  3. package/build/internal/src/client/AddContextOptions.d.ts +5 -0
  4. package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
  5. package/build/internal/src/client/CommandBarClientSDK.d.ts +19 -5
  6. package/build/internal/src/client/CommandBarSDK.d.ts +5 -3
  7. package/build/internal/src/client/EventHandler.d.ts +26 -2
  8. package/build/internal/src/client/globals.d.ts +1 -0
  9. package/build/internal/src/client/symbols.d.ts +1 -0
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +4 -2
  11. package/build/internal/src/middleware/ICommandFromClientType.d.ts +1 -1
  12. package/build/internal/src/middleware/IResourceSettings.d.ts +1 -1
  13. package/build/internal/src/middleware/OrganizationV.d.ts +13 -3
  14. package/build/internal/src/middleware/ResourceSettingsV.d.ts +4 -0
  15. package/build/internal/src/middleware/command.d.ts +150 -112
  16. package/build/internal/src/middleware/commandCategory.d.ts +32 -0
  17. package/build/internal/src/middleware/detailPreview.d.ts +2 -1
  18. package/build/internal/src/middleware/helpers/rules.d.ts +5 -5
  19. package/build/internal/src/middleware/nudge.d.ts +64 -8
  20. package/build/internal/src/middleware/organization.d.ts +47 -13
  21. package/build/internal/src/middleware/types.d.ts +65 -441
  22. package/package.json +4 -3
  23. package/src/init.ts +1 -8
  24. package/src/snippet.ts +2 -2
  25. package/webpack.config.js +5 -0
package/build/internal/src/middleware/commandCategory.d.ts CHANGED
@@ -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
  }
package/build/internal/src/middleware/detailPreview.d.ts CHANGED
@@ -6,7 +6,7 @@ export declare const DetailPreviewObjectV: t.IntersectionC<[t.TypeC<{
6
6
  }>, t.PartialC<{
7
7
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
8
8
  }>]>;
9
- export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV>;
9
+ export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV> & unknown;
10
10
  export declare type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
11
11
  export declare type DataRowMetadata = {
12
12
  type: 'command' | 'parameter';
@@ -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[];
package/build/internal/src/middleware/helpers/rules.d.ts CHANGED
@@ -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;
package/build/internal/src/middleware/nudge.d.ts CHANGED
@@ -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,8 +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<{
30
+ title: t.StringC;
31
+ cta: t.StringC;
25
32
  is_live: t.BooleanC;
26
33
  }>]>;
27
34
  export declare class Nudge {
@@ -38,6 +45,11 @@ export declare class Nudge {
38
45
  meta: {
39
46
  command: string;
40
47
  };
48
+ } | {
49
+ type: "on_event";
50
+ meta: {
51
+ event: string;
52
+ };
41
53
  };
42
54
  on_select: {
43
55
  type: "execute_command";
@@ -46,8 +58,10 @@ export declare class Nudge {
46
58
  };
47
59
  };
48
60
  timeout_ms: number | null;
49
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
61
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
50
62
  } & {
63
+ title?: string | undefined;
64
+ cta?: string | undefined;
51
65
  is_live?: boolean | undefined;
52
66
  };
53
67
  static create: (object: {
@@ -63,6 +77,11 @@ export declare class Nudge {
63
77
  meta: {
64
78
  command: string;
65
79
  };
80
+ } | {
81
+ type: "on_event";
82
+ meta: {
83
+ event: string;
84
+ };
66
85
  };
67
86
  on_select: {
68
87
  type: "execute_command";
@@ -71,8 +90,10 @@ export declare class Nudge {
71
90
  };
72
91
  };
73
92
  timeout_ms: number | null;
74
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
93
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
75
94
  } & {
95
+ title?: string | undefined;
96
+ cta?: string | undefined;
76
97
  is_live?: boolean | undefined;
77
98
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
78
99
  id: number;
@@ -87,6 +108,11 @@ export declare class Nudge {
87
108
  meta: {
88
109
  command: string;
89
110
  };
111
+ } | {
112
+ type: "on_event";
113
+ meta: {
114
+ event: string;
115
+ };
90
116
  };
91
117
  on_select: {
92
118
  type: "execute_command";
@@ -95,8 +121,10 @@ export declare class Nudge {
95
121
  };
96
122
  };
97
123
  timeout_ms: number | null;
98
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
124
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
99
125
  } & {
126
+ title?: string | undefined;
127
+ cta?: string | undefined;
100
128
  is_live?: boolean | undefined;
101
129
  }>;
102
130
  static update: (object: {
@@ -112,6 +140,11 @@ export declare class Nudge {
112
140
  meta: {
113
141
  command: string;
114
142
  };
143
+ } | {
144
+ type: "on_event";
145
+ meta: {
146
+ event: string;
147
+ };
115
148
  };
116
149
  on_select: {
117
150
  type: "execute_command";
@@ -120,8 +153,10 @@ export declare class Nudge {
120
153
  };
121
154
  };
122
155
  timeout_ms: number | null;
123
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
156
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
124
157
  } & {
158
+ title?: string | undefined;
159
+ cta?: string | undefined;
125
160
  is_live?: boolean | undefined;
126
161
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
127
162
  id: number;
@@ -136,6 +171,11 @@ export declare class Nudge {
136
171
  meta: {
137
172
  command: string;
138
173
  };
174
+ } | {
175
+ type: "on_event";
176
+ meta: {
177
+ event: string;
178
+ };
139
179
  };
140
180
  on_select: {
141
181
  type: "execute_command";
@@ -144,8 +184,10 @@ export declare class Nudge {
144
184
  };
145
185
  };
146
186
  timeout_ms: number | null;
147
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
187
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
148
188
  } & {
189
+ title?: string | undefined;
190
+ cta?: string | undefined;
149
191
  is_live?: boolean | undefined;
150
192
  }>;
151
193
  static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
@@ -162,6 +204,11 @@ export declare class Nudge {
162
204
  meta: {
163
205
  command: string;
164
206
  };
207
+ } | {
208
+ type: "on_event";
209
+ meta: {
210
+ event: string;
211
+ };
165
212
  };
166
213
  on_select: {
167
214
  type: "execute_command";
@@ -170,8 +217,10 @@ export declare class Nudge {
170
217
  };
171
218
  };
172
219
  timeout_ms: number | null;
173
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
220
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
174
221
  } & {
222
+ title?: string | undefined;
223
+ cta?: string | undefined;
175
224
  is_live?: boolean | undefined;
176
225
  })[]>;
177
226
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -190,6 +239,11 @@ export declare class Nudge {
190
239
  meta: {
191
240
  command: string;
192
241
  };
242
+ } | {
243
+ type: "on_event";
244
+ meta: {
245
+ event: string;
246
+ };
193
247
  };
194
248
  on_select: {
195
249
  type: "execute_command";
@@ -198,8 +252,10 @@ export declare class Nudge {
198
252
  };
199
253
  };
200
254
  timeout_ms: number | null;
201
- frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
255
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
202
256
  } & {
257
+ title?: string | undefined;
258
+ cta?: string | undefined;
203
259
  is_live?: boolean | undefined;
204
260
  }>;
205
261
  }
package/build/internal/src/middleware/organization.d.ts CHANGED
@@ -41,6 +41,8 @@ export declare const OrganizationSettingsV: t.TypeC<{
41
41
  recents_tab_instruction: t.StringC;
42
42
  hotload_help_docs: t.BooleanC;
43
43
  slash_filters_enabled: t.BooleanC;
44
+ recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
45
+ recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
44
46
  }>;
45
47
  export declare class Organization {
46
48
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -54,7 +56,7 @@ export declare class Organization {
54
56
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
55
57
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
56
58
  show_launcher_recommendations: boolean;
57
- recommendations_type: "None" | "Custom" | "Algorithm";
59
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
58
60
  launcher_offset_x: number;
59
61
  launcher_offset_y: number;
60
62
  theme: object;
@@ -76,6 +78,8 @@ export declare class Organization {
76
78
  unfurl?: boolean | undefined;
77
79
  description_field?: string | undefined;
78
80
  icon?: string | undefined;
81
+ icon_color?: string | undefined;
82
+ image_color?: string | undefined;
79
83
  image?: string | undefined;
80
84
  sort_key?: number | undefined;
81
85
  max_options_count?: number | null | undefined;
@@ -127,6 +131,9 @@ export declare class Organization {
127
131
  recents_tab_instruction: string;
128
132
  hotload_help_docs: boolean;
129
133
  slash_filters_enabled: boolean;
134
+ recents_sort_key: number | null;
135
+ recommended_sort_key: number | null;
136
+ has_hotloaded_help_docs: boolean;
130
137
  }>;
131
138
  static update: (object: {
132
139
  id: string | number;
@@ -136,7 +143,7 @@ export declare class Organization {
136
143
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
137
144
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
138
145
  show_launcher_recommendations: boolean;
139
- recommendations_type: "None" | "Custom" | "Algorithm";
146
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
140
147
  launcher_offset_x: number;
141
148
  launcher_offset_y: number;
142
149
  theme: object;
@@ -158,6 +165,8 @@ export declare class Organization {
158
165
  unfurl?: boolean | undefined;
159
166
  description_field?: string | undefined;
160
167
  icon?: string | undefined;
168
+ icon_color?: string | undefined;
169
+ image_color?: string | undefined;
161
170
  image?: string | undefined;
162
171
  sort_key?: number | undefined;
163
172
  max_options_count?: number | null | undefined;
@@ -209,6 +218,9 @@ export declare class Organization {
209
218
  recents_tab_instruction: string;
210
219
  hotload_help_docs: boolean;
211
220
  slash_filters_enabled: boolean;
221
+ recents_sort_key: number | null;
222
+ recommended_sort_key: number | null;
223
+ has_hotloaded_help_docs: boolean;
212
224
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
213
225
  id: string | number;
214
226
  name: string;
@@ -217,7 +229,7 @@ export declare class Organization {
217
229
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
218
230
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
219
231
  show_launcher_recommendations: boolean;
220
- recommendations_type: "None" | "Custom" | "Algorithm";
232
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
221
233
  launcher_offset_x: number;
222
234
  launcher_offset_y: number;
223
235
  theme: object;
@@ -239,6 +251,8 @@ export declare class Organization {
239
251
  unfurl?: boolean | undefined;
240
252
  description_field?: string | undefined;
241
253
  icon?: string | undefined;
254
+ icon_color?: string | undefined;
255
+ image_color?: string | undefined;
242
256
  image?: string | undefined;
243
257
  sort_key?: number | undefined;
244
258
  max_options_count?: number | null | undefined;
@@ -290,6 +304,9 @@ export declare class Organization {
290
304
  recents_tab_instruction: string;
291
305
  hotload_help_docs: boolean;
292
306
  slash_filters_enabled: boolean;
307
+ recents_sort_key: number | null;
308
+ recommended_sort_key: number | null;
309
+ has_hotloaded_help_docs: boolean;
293
310
  }>;
294
311
  static listCommands: (orgUID: string) => Promise<({
295
312
  id: number;
@@ -547,14 +564,14 @@ export declare class Organization {
547
564
  };
548
565
  tags: string[];
549
566
  availability_rules: ({
550
- type: "url" | "element" | "context";
567
+ type: "url" | "element" | "context" | "event_count";
551
568
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
552
569
  } & {
553
570
  field?: string | undefined;
554
571
  value?: string | undefined;
555
572
  reason?: string | undefined;
556
573
  })[] | (({
557
- type: "url" | "element" | "context";
574
+ type: "url" | "element" | "context" | "event_count";
558
575
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
559
576
  } & {
560
577
  field?: string | undefined;
@@ -567,7 +584,7 @@ export declare class Organization {
567
584
  reason?: string | undefined;
568
585
  }))[];
569
586
  recommend_rules: (({
570
- type: "url" | "element" | "context";
587
+ type: "url" | "element" | "context" | "event_count";
571
588
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
572
589
  } & {
573
590
  field?: string | undefined;
@@ -581,17 +598,12 @@ export declare class Organization {
581
598
  value?: null | undefined;
582
599
  reason?: null | undefined;
583
600
  }))[] | (({
584
- type: "url" | "element" | "context";
601
+ type: "url" | "element" | "context" | "event_count";
585
602
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
586
603
  } & {
587
604
  field?: string | undefined;
588
605
  value?: string | undefined;
589
606
  reason?: string | undefined;
590
- }) | ({
591
- type: "named_rule";
592
- rule_id: number;
593
- } & {
594
- reason?: string | undefined;
595
607
  }) | ({
596
608
  type: "always";
597
609
  } & {
@@ -599,6 +611,11 @@ export declare class Organization {
599
611
  field?: null | undefined;
600
612
  value?: null | undefined;
601
613
  reason?: null | undefined;
614
+ }) | ({
615
+ type: "named_rule";
616
+ rule_id: number;
617
+ } & {
618
+ reason?: string | undefined;
602
619
  }))[];
603
620
  availability_expression: import("./helpers/rules").RuleExpression;
604
621
  recommend_expression: import("./helpers/rules").RuleExpression;
@@ -611,6 +628,8 @@ export declare class Organization {
611
628
  category: number | null;
612
629
  sort_key: number | null;
613
630
  icon: string | null;
631
+ icon_color: string | null;
632
+ image_color: string | null;
614
633
  image: string | null;
615
634
  celebrate: boolean | {
616
635
  angle?: number | undefined;
@@ -654,6 +673,8 @@ export declare class Organization {
654
673
  } & {} & {
655
674
  sort_key: number | null;
656
675
  icon: string | null;
676
+ icon_color: string | null;
677
+ image_color: string | null;
657
678
  image: string | null;
658
679
  render_as: "grid" | "list";
659
680
  setting_hide_before_search: boolean;
@@ -665,6 +686,8 @@ export declare class Organization {
665
686
  slash_filter_keyword: string | null;
666
687
  search_tab_instruction: string;
667
688
  track_recents: boolean;
689
+ } & {
690
+ contains_hotloaded_commands?: boolean | undefined;
668
691
  })[]>;
669
692
  static listGuides: (orgUID: string) => Promise<({
670
693
  id: number;
@@ -768,6 +791,8 @@ export declare class Organization {
768
791
  recents_tab_instruction: string;
769
792
  hotload_help_docs: boolean;
770
793
  slash_filters_enabled: boolean;
794
+ recents_sort_key: number | null;
795
+ recommended_sort_key: number | null;
771
796
  }>;
772
797
  static updateSetting: (object: {
773
798
  end_user_limit?: number | undefined;
@@ -796,6 +821,8 @@ export declare class Organization {
796
821
  recents_tab_instruction?: string | undefined;
797
822
  hotload_help_docs?: boolean | undefined;
798
823
  slash_filters_enabled?: boolean | undefined;
824
+ recents_sort_key?: number | null | undefined;
825
+ recommended_sort_key?: number | null | undefined;
799
826
  }, params?: Record<string, string> | undefined, callbacks?: {
800
827
  onSuccess?: (() => void) | undefined;
801
828
  onError?: ((err: string) => void) | undefined;
@@ -826,6 +853,8 @@ export declare class Organization {
826
853
  recents_tab_instruction: string;
827
854
  hotload_help_docs: boolean;
828
855
  slash_filters_enabled: boolean;
856
+ recents_sort_key: number | null;
857
+ recommended_sort_key: number | null;
829
858
  }>;
830
859
  static decode: (data: any) => {
831
860
  id: string | number;
@@ -835,7 +864,7 @@ export declare class Organization {
835
864
  launcher_type: "alternate" | "none" | "prompt" | "minimal";
836
865
  launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
837
866
  show_launcher_recommendations: boolean;
838
- recommendations_type: "None" | "Custom" | "Algorithm";
867
+ recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
839
868
  launcher_offset_x: number;
840
869
  launcher_offset_y: number;
841
870
  theme: object;
@@ -857,6 +886,8 @@ export declare class Organization {
857
886
  unfurl?: boolean | undefined;
858
887
  description_field?: string | undefined;
859
888
  icon?: string | undefined;
889
+ icon_color?: string | undefined;
890
+ image_color?: string | undefined;
860
891
  image?: string | undefined;
861
892
  sort_key?: number | undefined;
862
893
  max_options_count?: number | null | undefined;
@@ -908,5 +939,8 @@ export declare class Organization {
908
939
  recents_tab_instruction: string;
909
940
  hotload_help_docs: boolean;
910
941
  slash_filters_enabled: boolean;
942
+ recents_sort_key: number | null;
943
+ recommended_sort_key: number | null;
944
+ has_hotloaded_help_docs: boolean;
911
945
  };
912
946
  }