commandbar 1.6.15 → 1.6.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. package/build/internal/src/client/AddContextOptions.d.ts +4 -0
  2. package/build/internal/src/client/CommandBarClientSDK.d.ts +26 -9
  3. package/build/internal/src/client/EventHandler.d.ts +9 -2
  4. package/build/internal/src/middleware/CommandFromClientV.d.ts +3 -2
  5. package/build/internal/src/middleware/OrganizationV.d.ts +24 -0
  6. package/build/internal/src/middleware/ResourceSettingsV.d.ts +24 -0
  7. package/build/internal/src/middleware/command.d.ts +64 -38
  8. package/build/internal/src/middleware/commandCategory.d.ts +8 -0
  9. package/build/internal/src/middleware/detailPreview.d.ts +3 -6
  10. package/build/internal/src/middleware/nudge.d.ts +8 -0
  11. package/build/internal/src/middleware/organization.d.ts +52 -2
  12. package/build/internal/src/middleware/tab.d.ts +27 -0
  13. package/build/internal/src/middleware/types.d.ts +11 -4
  14. package/build/internal/src/middleware/user.d.ts +1 -1
  15. package/package.json +1 -1
package/build/internal/src/client/AddContextOptions.d.ts CHANGED
@@ -1,9 +1,11 @@
1
+ import { DetailPreviewType } from '../middleware/detailPreview';
1
2
  export declare type DataRow = {
2
3
  icon?: string;
3
4
  category?: string;
4
5
  label?: string;
5
6
  description?: string;
6
7
  __actionIcon?: string;
8
+ __image?: string;
7
9
  __heading?: string;
8
10
  /** @deprecated Use \_\_heading */
9
11
  __breadcrumbs?: string;
@@ -49,6 +51,7 @@ export interface AddContextOptions {
49
51
  * specify a custom icon for every object by setting an `.icon` field.
50
52
  */
51
53
  defaultIcon?: string;
54
+ detail?: DetailPreviewType;
52
55
  /** The value key of `key` objects you want to use to display the object's description (subtext under label). */
53
56
  descriptionKey?: string;
54
57
  /** The value key of `key` objects you want to use to display the object's label. */
@@ -91,6 +94,7 @@ export interface ArgumentOptions {
91
94
  * specify a custom icon for every object by setting an `.icon` field.
92
95
  */
93
96
  defaultIcon?: string;
97
+ detail?: DetailPreviewType;
94
98
  /**
95
99
  * A list of object fields to be searched. If a custom `searchFunction` is provided, matches will be highlighted in
96
100
  * these fields. Field names will be transformed from _camelCase_ or _snake_case_ into _Sentence case_.
package/build/internal/src/client/CommandBarClientSDK.d.ts CHANGED
@@ -2,9 +2,10 @@ import { AddContextOptions, ArgumentOptions, DataRow, RecordOptions } from './Ad
2
2
  import { EventHandler } from './EventHandler';
3
3
  import { ICommandFromClientType } from '../middleware/ICommandFromClientType';
4
4
  import { IResourceSettings } from '../middleware/IResourceSettings';
5
- import { ICommandCategoryType, DetailPreviewType, DataRowMedata, ISkinType } from '../middleware/types';
5
+ import { ICommandCategoryType, DetailPreviewType, ISkinType } from '../middleware/types';
6
+ import { DataRowMetadata } from '../middleware/detailPreview';
6
7
  export type { DataRow } from './AddContextOptions';
7
- export type { DataRowMedata } from '../middleware/types';
8
+ export type { DataRowMetadata } from '../middleware/types';
8
9
  export declare const ASYNC_METHODS: Array<keyof CommandBarClientSDK>;
9
10
  export declare type BootOptions = string | (UserAttributes & {
10
11
  id: string;
@@ -47,6 +48,19 @@ export declare type RecordsOrArgumentListLoader = (chosenValues?: undefined | Re
47
48
  export declare type CallbackMap = {
48
49
  [name: string]: CallbackFunction<any, any>;
49
50
  };
51
+ export declare type CustomComponent = {
52
+ mount: (node: HTMLElement) => CustomComponentInstance;
53
+ };
54
+ export declare type CustomComponentInstance = {
55
+ render: (data: DataRow, metadata: DataRowMetadata) => void;
56
+ unmount: () => void;
57
+ };
58
+ export declare type NudgeHandler = ({ slug, content, onClick, timeout, }: {
59
+ slug: string;
60
+ content: string;
61
+ onClick: () => void;
62
+ timeout: number | null;
63
+ }) => void;
50
64
  export declare type CommandBarClientSDK = Readonly<{
51
65
  /**
52
66
  * Adds a callback function to CommandBar. The callback function provided is mapped to `callbackKey`, and can be
@@ -144,12 +158,7 @@ export declare type CommandBarClientSDK = Readonly<{
144
158
  * * `onClick`: The default on click behavior for the nudge. E.g., if a nudge is defined in the editor
145
159
  * to execute a command on click, then calling `onClick` will execute that command.
146
160
  **/
147
- addNudgeHandler(nudgeHandler: ({ slug, content, onClick, timeout, }: {
148
- slug: string;
149
- content: string;
150
- onClick: () => void;
151
- timeout: number | null;
152
- }) => void): void;
161
+ addNudgeHandler(nudgeHandler: NudgeHandler): void;
153
162
  /**
154
163
  * Add a record action for a key
155
164
  *
@@ -233,7 +242,9 @@ export declare type CommandBarClientSDK = Readonly<{
233
242
  * * `row` {any}
234
243
  * * `node` {any}
235
244
  */
236
- generateDetailPreview(fn: (data: DataRow, metadata: DataRowMedata) => undefined | DetailPreviewType): void;
245
+ generateDetailPreview(fn: (data: DataRow, metadata: DataRowMetadata) => undefined | DetailPreviewType): void;
246
+ addComponent(key: string, name: string, component: CustomComponent): void;
247
+ removeComponent(key: string): void;
237
248
  /**
238
249
  * Returns an array returning all commands that fit the optional filter function. By default, all commands are returned
239
250
  * @param filter A function that filters out commands based on its properties. These are:
@@ -323,6 +334,12 @@ export declare type CommandBarClientSDK = Readonly<{
323
334
  * callback keys, and the values are the supplied functions.
324
335
  */
325
336
  shareCallbacks(): Record<string, CallbackFunction<unknown>>;
337
+ /**
338
+ * Returns dictionary representing the Custom Components currently defined (via addComponent).
339
+ *
340
+ * The keys represent component keys, and the value is the name of the component.
341
+ */
342
+ shareComponentNamesByKey(): Record<string, string>;
326
343
  /** Returns the key value dictionary representing the current state of context */
327
344
  shareContext(): Metadata;
328
345
  /**
package/build/internal/src/client/EventHandler.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export interface AbandonedSearchEvent {
2
+ type: 'abandoned_search';
2
3
  /** Event data passed for `abandoned_search` events (deadends). */
3
4
  /** The id of the currently active command, if there is one. */
4
5
  command?: number;
@@ -9,7 +10,7 @@ export interface AbandonedSearchEvent {
9
10
  /** The context key of the currently active resource, if there is one. */
10
11
  resource?: string;
11
12
  /** The trigger for the deadend. */
12
- type: 'Backspaced' | 'Closed with text' | 'Resetting search';
13
+ trigger: 'Backspaced' | 'Closed with text' | 'Resetting search';
13
14
  /** The number of {CommandOptions, ParameterOptions}, if there are any. */
14
15
  results?: {
15
16
  numCommands: number;
@@ -19,6 +20,7 @@ export interface AbandonedSearchEvent {
19
20
  previousCommands?: string[];
20
21
  }
21
22
  export interface ClosedEvent {
23
+ type: 'closed';
22
24
  /** Event data passed for `command_execution` events. */
23
25
  /** The user's input text when the bar was closed. */
24
26
  inputText: string;
@@ -26,6 +28,7 @@ export interface ClosedEvent {
26
28
  shortcut?: boolean;
27
29
  }
28
30
  export interface CommandExecutionEvent {
31
+ type: 'command_execution';
29
32
  /** Event data passed for `command_execution` events. */
30
33
  /** The category id of the command. Only provided if the command has a category. */
31
34
  category?: string | number | null;
@@ -54,6 +57,7 @@ export interface CommandExecutionEvent {
54
57
  selections?: Record<string, unknown>;
55
58
  }
56
59
  export interface EndUserShortcutChangedEvent {
60
+ type: 'shortcut_edited';
57
61
  /** Event data passed for `command_execution` events. */
58
62
  /** The category id of the command. Only provided if the command has a category. */
59
63
  category?: number | null;
@@ -72,10 +76,12 @@ export interface EndUserShortcutChangedEvent {
72
76
  defaultShortcut: string;
73
77
  }
74
78
  export interface CommandSuggestionEvent {
79
+ type: 'command_suggestion';
75
80
  /** The text of the suggestion. */
76
81
  text: string;
77
82
  }
78
83
  export interface OpenedEvent {
84
+ type: 'opened';
79
85
  /** Event data passed for `command_execution` events. */
80
86
  /**
81
87
  * The entrypoint through which the bar was opened.
@@ -92,10 +98,11 @@ export interface OpenedEvent {
92
98
  }
93
99
  export declare type OpenedEventTrigger = OpenedEvent['trigger'];
94
100
  export interface NoResultsForQueryEvent {
101
+ type: 'no_results_for_query';
95
102
  /** Event data passed for `no_results_for_query` event */
96
103
  /** The user's input text when the no results state was reached. */
97
104
  inputText: string;
98
105
  }
99
- export declare type EventData = AbandonedSearchEvent | ClosedEvent | CommandExecutionEvent | CommandSuggestionEvent | OpenedEvent | NoResultsForQueryEvent;
106
+ export declare type EventData = AbandonedSearchEvent | ClosedEvent | CommandExecutionEvent | CommandSuggestionEvent | OpenedEvent | NoResultsForQueryEvent | EndUserShortcutChangedEvent;
100
107
  export declare type EventHandler = (eventName: EventType, eventData: EventData) => void;
101
108
  export declare type EventType = 'abandoned_search' | 'command_suggestion' | 'command_execution' | 'opened' | 'closed' | 'no_results_for_query' | 'client_error' | 'shortcut_edited';
package/build/internal/src/middleware/CommandFromClientV.d.ts CHANGED
@@ -207,6 +207,7 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
207
207
  }>]>]>>;
208
208
  category: t.UnionC<[t.NumberC, t.StringC, t.NullC]>;
209
209
  icon: t.UnionC<[t.StringC, t.NullC]>;
210
+ image: t.UnionC<[t.StringC, t.NullC]>;
210
211
  celebrate: t.UnionC<[t.BooleanC, t.PartialC<{
211
212
  angle: t.NumberC;
212
213
  spread: t.NumberC;
@@ -283,12 +284,12 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
283
284
  availability_expression: t.ArrayC<t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>>;
284
285
  recommend_expression: t.ArrayC<t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>>;
285
286
  detail: t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
286
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
287
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
287
288
  value: t.StringC;
288
289
  }>, t.PartialC<{
289
290
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
290
291
  }>]>, t.ArrayC<t.IntersectionC<[t.TypeC<{
291
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
292
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
292
293
  value: t.StringC;
293
294
  }>, t.PartialC<{
294
295
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
package/build/internal/src/middleware/OrganizationV.d.ts CHANGED
@@ -24,6 +24,7 @@ declare const OrganizationAdditionalV: t.TypeC<{
24
24
  unfurl: t.BooleanC;
25
25
  description_field: t.StringC;
26
26
  icon: t.StringC;
27
+ image: t.StringC;
27
28
  sort_key: t.NumberC;
28
29
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
29
30
  sortFunction: t.AnyC;
@@ -38,6 +39,17 @@ declare const OrganizationAdditionalV: t.TypeC<{
38
39
  search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
39
40
  setting_pin_to_bottom: t.BooleanC;
40
41
  track_recents: t.BooleanC;
42
+ detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
43
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
44
+ value: t.StringC;
45
+ }>, t.PartialC<{
46
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
47
+ }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
48
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
49
+ value: t.StringC;
50
+ }>, t.PartialC<{
51
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
52
+ }>]>]>>]>;
41
53
  }>>;
42
54
  should_show_onboarding: t.BooleanC;
43
55
  last_snippet_request: t.UnionC<[t.StringC, t.NullC]>;
@@ -93,6 +105,7 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
93
105
  unfurl: t.BooleanC;
94
106
  description_field: t.StringC;
95
107
  icon: t.StringC;
108
+ image: t.StringC;
96
109
  sort_key: t.NumberC;
97
110
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
98
111
  sortFunction: t.AnyC;
@@ -107,6 +120,17 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
107
120
  search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
108
121
  setting_pin_to_bottom: t.BooleanC;
109
122
  track_recents: t.BooleanC;
123
+ detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
124
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
125
+ value: t.StringC;
126
+ }>, t.PartialC<{
127
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
128
+ }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
129
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
130
+ value: t.StringC;
131
+ }>, t.PartialC<{
132
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
133
+ }>]>]>>]>;
110
134
  }>>;
111
135
  should_show_onboarding: t.BooleanC;
112
136
  last_snippet_request: t.UnionC<[t.StringC, t.NullC]>;
package/build/internal/src/middleware/ResourceSettingsV.d.ts CHANGED
@@ -16,6 +16,7 @@ export declare const ResourceSettingsV: t.PartialC<{
16
16
  unfurl: t.BooleanC;
17
17
  description_field: t.StringC;
18
18
  icon: t.StringC;
19
+ image: t.StringC;
19
20
  sort_key: t.NumberC;
20
21
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
21
22
  sortFunction: t.AnyC;
@@ -30,6 +31,17 @@ export declare const ResourceSettingsV: t.PartialC<{
30
31
  search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
31
32
  setting_pin_to_bottom: t.BooleanC;
32
33
  track_recents: t.BooleanC;
34
+ detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
35
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
36
+ value: t.StringC;
37
+ }>, t.PartialC<{
38
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
39
+ }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
40
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
41
+ value: t.StringC;
42
+ }>, t.PartialC<{
43
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
44
+ }>]>]>>]>;
33
45
  }>;
34
46
  export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.PartialC<{
35
47
  name: t.StringC;
@@ -44,6 +56,7 @@ export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.Parti
44
56
  unfurl: t.BooleanC;
45
57
  description_field: t.StringC;
46
58
  icon: t.StringC;
59
+ image: t.StringC;
47
60
  sort_key: t.NumberC;
48
61
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
49
62
  sortFunction: t.AnyC;
@@ -58,4 +71,15 @@ export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.Parti
58
71
  search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
59
72
  setting_pin_to_bottom: t.BooleanC;
60
73
  track_recents: t.BooleanC;
74
+ detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
75
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
76
+ value: t.StringC;
77
+ }>, t.PartialC<{
78
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
79
+ }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
80
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
81
+ value: t.StringC;
82
+ }>, t.PartialC<{
83
+ position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
84
+ }>]>]>>]>;
61
85
  }>>;
package/build/internal/src/middleware/command.d.ts CHANGED
@@ -434,6 +434,7 @@ export declare const CommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
434
434
  category: t.UnionC<[t.NumberC, t.NullC]>;
435
435
  sort_key: t.UnionC<[t.NumberC, t.NullC]>;
436
436
  icon: t.UnionC<[t.StringC, t.NullC]>;
437
+ image: t.UnionC<[t.StringC, t.NullC]>;
437
438
  celebrate: t.UnionC<[t.BooleanC, t.PartialC<{
438
439
  angle: t.NumberC;
439
440
  spread: t.NumberC;
@@ -454,17 +455,20 @@ export declare const CommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
454
455
  hotkey_mac: t.StringC;
455
456
  hotkey_win: t.StringC;
456
457
  detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
457
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
458
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
458
459
  value: t.StringC;
459
460
  }>, t.PartialC<{
460
461
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
461
462
  }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
462
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
463
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
463
464
  value: t.StringC;
464
465
  }>, t.PartialC<{
465
466
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
466
467
  }>]>]>>]>;
467
468
  next_steps: t.ArrayC<t.UnionC<[t.StringC, t.NumberC]>>;
469
+ }>, t.PartialC<{
470
+ third_party_source: t.UnionC<[t.StringC, t.NullC]>;
471
+ third_party_id: t.UnionC<[t.StringC, t.NullC]>;
468
472
  }>]>;
469
473
  export declare const EditorCommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
470
474
  id: t.NumberC;
@@ -850,6 +854,7 @@ export declare const EditorCommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
850
854
  category: t.UnionC<[t.NumberC, t.NullC]>;
851
855
  sort_key: t.UnionC<[t.NumberC, t.NullC]>;
852
856
  icon: t.UnionC<[t.StringC, t.NullC]>;
857
+ image: t.UnionC<[t.StringC, t.NullC]>;
853
858
  celebrate: t.UnionC<[t.BooleanC, t.PartialC<{
854
859
  angle: t.NumberC;
855
860
  spread: t.NumberC;
@@ -870,12 +875,12 @@ export declare const EditorCommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
870
875
  hotkey_mac: t.StringC;
871
876
  hotkey_win: t.StringC;
872
877
  detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
873
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
878
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
874
879
  value: t.StringC;
875
880
  }>, t.PartialC<{
876
881
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
877
882
  }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
878
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
883
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
879
884
  value: t.StringC;
880
885
  }>, t.PartialC<{
881
886
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
@@ -1281,6 +1286,7 @@ export declare const BatchEditorCommandResponseV: t.TypeC<{
1281
1286
  category: t.UnionC<[t.NumberC, t.NullC]>;
1282
1287
  sort_key: t.UnionC<[t.NumberC, t.NullC]>;
1283
1288
  icon: t.UnionC<[t.StringC, t.NullC]>;
1289
+ image: t.UnionC<[t.StringC, t.NullC]>;
1284
1290
  celebrate: t.UnionC<[t.BooleanC, t.PartialC<{
1285
1291
  angle: t.NumberC;
1286
1292
  spread: t.NumberC;
@@ -1301,12 +1307,12 @@ export declare const BatchEditorCommandResponseV: t.TypeC<{
1301
1307
  hotkey_mac: t.StringC;
1302
1308
  hotkey_win: t.StringC;
1303
1309
  detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
1304
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
1310
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
1305
1311
  value: t.StringC;
1306
1312
  }>, t.PartialC<{
1307
1313
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
1308
1314
  }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
1309
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
1315
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
1310
1316
  value: t.StringC;
1311
1317
  }>, t.PartialC<{
1312
1318
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
@@ -1638,6 +1644,7 @@ export declare class Command {
1638
1644
  category: number | null;
1639
1645
  sort_key: number | null;
1640
1646
  icon: string | null;
1647
+ image: string | null;
1641
1648
  celebrate: boolean | {
1642
1649
  angle?: number | undefined;
1643
1650
  spread?: number | undefined;
@@ -1658,12 +1665,12 @@ export declare class Command {
1658
1665
  hotkey_mac: string;
1659
1666
  hotkey_win: string;
1660
1667
  detail: string | ({
1661
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
1668
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1662
1669
  value: string;
1663
1670
  } & {
1664
1671
  position?: "inline" | "popover" | undefined;
1665
1672
  }) | (string | ({
1666
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
1673
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1667
1674
  value: string;
1668
1675
  } & {
1669
1676
  position?: "inline" | "popover" | undefined;
@@ -1992,6 +1999,7 @@ export declare class Command {
1992
1999
  category: number | null;
1993
2000
  sort_key: number | null;
1994
2001
  icon: string | null;
2002
+ image: string | null;
1995
2003
  celebrate: boolean | {
1996
2004
  angle?: number | undefined;
1997
2005
  spread?: number | undefined;
@@ -2012,12 +2020,12 @@ export declare class Command {
2012
2020
  hotkey_mac: string;
2013
2021
  hotkey_win: string;
2014
2022
  detail: string | ({
2015
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
2023
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2016
2024
  value: string;
2017
2025
  } & {
2018
2026
  position?: "inline" | "popover" | undefined;
2019
2027
  }) | (string | ({
2020
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
2028
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2021
2029
  value: string;
2022
2030
  } & {
2023
2031
  position?: "inline" | "popover" | undefined;
@@ -2347,6 +2355,7 @@ export declare class Command {
2347
2355
  category: number | null;
2348
2356
  sort_key: number | null;
2349
2357
  icon: string | null;
2358
+ image: string | null;
2350
2359
  celebrate: boolean | {
2351
2360
  angle?: number | undefined;
2352
2361
  spread?: number | undefined;
@@ -2367,12 +2376,12 @@ export declare class Command {
2367
2376
  hotkey_mac: string;
2368
2377
  hotkey_win: string;
2369
2378
  detail: string | ({
2370
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
2379
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2371
2380
  value: string;
2372
2381
  } & {
2373
2382
  position?: "inline" | "popover" | undefined;
2374
2383
  }) | (string | ({
2375
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
2384
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2376
2385
  value: string;
2377
2386
  } & {
2378
2387
  position?: "inline" | "popover" | undefined;
@@ -2701,6 +2710,7 @@ export declare class Command {
2701
2710
  category: number | null;
2702
2711
  sort_key: number | null;
2703
2712
  icon: string | null;
2713
+ image: string | null;
2704
2714
  celebrate: boolean | {
2705
2715
  angle?: number | undefined;
2706
2716
  spread?: number | undefined;
@@ -2721,12 +2731,12 @@ export declare class Command {
2721
2731
  hotkey_mac: string;
2722
2732
  hotkey_win: string;
2723
2733
  detail: string | ({
2724
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
2734
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2725
2735
  value: string;
2726
2736
  } & {
2727
2737
  position?: "inline" | "popover" | undefined;
2728
2738
  }) | (string | ({
2729
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
2739
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2730
2740
  value: string;
2731
2741
  } & {
2732
2742
  position?: "inline" | "popover" | undefined;
@@ -3058,6 +3068,7 @@ export declare class Command {
3058
3068
  category: number | null;
3059
3069
  sort_key: number | null;
3060
3070
  icon: string | null;
3071
+ image: string | null;
3061
3072
  celebrate: boolean | {
3062
3073
  angle?: number | undefined;
3063
3074
  spread?: number | undefined;
@@ -3078,12 +3089,12 @@ export declare class Command {
3078
3089
  hotkey_mac: string;
3079
3090
  hotkey_win: string;
3080
3091
  detail: string | ({
3081
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
3092
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
3082
3093
  value: string;
3083
3094
  } & {
3084
3095
  position?: "inline" | "popover" | undefined;
3085
3096
  }) | (string | ({
3086
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
3097
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
3087
3098
  value: string;
3088
3099
  } & {
3089
3100
  position?: "inline" | "popover" | undefined;
@@ -3310,6 +3321,7 @@ export declare class Command {
3310
3321
  } | undefined;
3311
3322
  category?: string | number | null | undefined;
3312
3323
  icon?: string | null | undefined;
3324
+ image?: string | null | undefined;
3313
3325
  celebrate?: boolean | {
3314
3326
  angle?: number | undefined;
3315
3327
  spread?: number | undefined;
@@ -3350,12 +3362,12 @@ export declare class Command {
3350
3362
  availability_expression?: import("./helpers/rules").RuleExpression[] | undefined;
3351
3363
  recommend_expression?: import("./helpers/rules").RuleExpression[] | undefined;
3352
3364
  detail?: string | ({
3353
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
3365
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
3354
3366
  value: string;
3355
3367
  } & {
3356
3368
  position?: "inline" | "popover" | undefined;
3357
3369
  }) | ({
3358
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
3370
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
3359
3371
  value: string;
3360
3372
  } & {
3361
3373
  position?: "inline" | "popover" | undefined;
@@ -3650,6 +3662,7 @@ export declare class Command {
3650
3662
  category: number | null;
3651
3663
  sort_key: number | null;
3652
3664
  icon: string | null;
3665
+ image: string | null;
3653
3666
  celebrate: boolean | {
3654
3667
  angle?: number | undefined;
3655
3668
  spread?: number | undefined;
@@ -3670,17 +3683,20 @@ export declare class Command {
3670
3683
  hotkey_mac: string;
3671
3684
  hotkey_win: string;
3672
3685
  detail: string | ({
3673
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
3686
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
3674
3687
  value: string;
3675
3688
  } & {
3676
3689
  position?: "inline" | "popover" | undefined;
3677
3690
  }) | (string | ({
3678
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
3691
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
3679
3692
  value: string;
3680
3693
  } & {
3681
3694
  position?: "inline" | "popover" | undefined;
3682
3695
  }))[] | null;
3683
3696
  next_steps: (string | number)[];
3697
+ } & {
3698
+ third_party_source?: string | null | undefined;
3699
+ third_party_id?: string | null | undefined;
3684
3700
  };
3685
3701
  static decodeEditorCommand: (data: {
3686
3702
  id: number;
@@ -4117,6 +4133,7 @@ export declare class Command {
4117
4133
  category: number | null;
4118
4134
  sort_key: number | null;
4119
4135
  icon: string | null;
4136
+ image: string | null;
4120
4137
  celebrate: boolean | {
4121
4138
  angle?: number | undefined;
4122
4139
  spread?: number | undefined;
@@ -4137,12 +4154,12 @@ export declare class Command {
4137
4154
  hotkey_mac: string;
4138
4155
  hotkey_win: string;
4139
4156
  detail: string | ({
4140
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
4157
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
4141
4158
  value: string;
4142
4159
  } & {
4143
4160
  position?: "inline" | "popover" | undefined;
4144
4161
  }) | (string | ({
4145
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
4162
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
4146
4163
  value: string;
4147
4164
  } & {
4148
4165
  position?: "inline" | "popover" | undefined;
@@ -4472,6 +4489,7 @@ export declare class Command {
4472
4489
  category: number | null;
4473
4490
  sort_key: number | null;
4474
4491
  icon: string | null;
4492
+ image: string | null;
4475
4493
  celebrate: boolean | {
4476
4494
  angle?: number | undefined;
4477
4495
  spread?: number | undefined;
@@ -4492,12 +4510,12 @@ export declare class Command {
4492
4510
  hotkey_mac: string;
4493
4511
  hotkey_win: string;
4494
4512
  detail: string | ({
4495
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
4513
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
4496
4514
  value: string;
4497
4515
  } & {
4498
4516
  position?: "inline" | "popover" | undefined;
4499
4517
  }) | (string | ({
4500
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
4518
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
4501
4519
  value: string;
4502
4520
  } & {
4503
4521
  position?: "inline" | "popover" | undefined;
@@ -4826,6 +4844,7 @@ export declare class Command {
4826
4844
  category: number | null;
4827
4845
  sort_key: number | null;
4828
4846
  icon: string | null;
4847
+ image: string | null;
4829
4848
  celebrate: boolean | {
4830
4849
  angle?: number | undefined;
4831
4850
  spread?: number | undefined;
@@ -4846,12 +4865,12 @@ export declare class Command {
4846
4865
  hotkey_mac: string;
4847
4866
  hotkey_win: string;
4848
4867
  detail: string | ({
4849
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
4868
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
4850
4869
  value: string;
4851
4870
  } & {
4852
4871
  position?: "inline" | "popover" | undefined;
4853
4872
  }) | (string | ({
4854
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
4873
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
4855
4874
  value: string;
4856
4875
  } & {
4857
4876
  position?: "inline" | "popover" | undefined;
@@ -5181,6 +5200,7 @@ export declare class Command {
5181
5200
  category: number | null;
5182
5201
  sort_key: number | null;
5183
5202
  icon: string | null;
5203
+ image: string | null;
5184
5204
  celebrate: boolean | {
5185
5205
  angle?: number | undefined;
5186
5206
  spread?: number | undefined;
@@ -5201,12 +5221,12 @@ export declare class Command {
5201
5221
  hotkey_mac: string;
5202
5222
  hotkey_win: string;
5203
5223
  detail: string | ({
5204
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
5224
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
5205
5225
  value: string;
5206
5226
  } & {
5207
5227
  position?: "inline" | "popover" | undefined;
5208
5228
  }) | (string | ({
5209
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
5229
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
5210
5230
  value: string;
5211
5231
  } & {
5212
5232
  position?: "inline" | "popover" | undefined;
@@ -5535,6 +5555,7 @@ export declare class Command {
5535
5555
  category: number | null;
5536
5556
  sort_key: number | null;
5537
5557
  icon: string | null;
5558
+ image: string | null;
5538
5559
  celebrate: boolean | {
5539
5560
  angle?: number | undefined;
5540
5561
  spread?: number | undefined;
@@ -5555,12 +5576,12 @@ export declare class Command {
5555
5576
  hotkey_mac: string;
5556
5577
  hotkey_win: string;
5557
5578
  detail: string | ({
5558
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
5579
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
5559
5580
  value: string;
5560
5581
  } & {
5561
5582
  position?: "inline" | "popover" | undefined;
5562
5583
  }) | (string | ({
5563
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
5584
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
5564
5585
  value: string;
5565
5586
  } & {
5566
5587
  position?: "inline" | "popover" | undefined;
@@ -5574,6 +5595,7 @@ export declare class Command {
5574
5595
  static commandUID: (cmd: t.TypeOf<typeof CommandV> | t.TypeOf<typeof EditorCommandV>) => string;
5575
5596
  static isProgrammatic: (cmd: t.TypeOf<typeof CommandV> | t.TypeOf<typeof EditorCommandV>) => boolean;
5576
5597
  static isRecordAction: (cmd: t.TypeOf<typeof CommandV> | t.TypeOf<typeof EditorCommandV>, recordKey?: string | undefined) => boolean;
5598
+ static isHelpSyncCommand: (cmd: t.TypeOf<typeof CommandV> | t.TypeOf<typeof EditorCommandV>) => boolean;
5577
5599
  static showInDefaultList: (cmd: t.TypeOf<typeof CommandV> | t.TypeOf<typeof EditorCommandV>) => boolean;
5578
5600
  }
5579
5601
  export declare const HelpSyncCommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
@@ -5893,6 +5915,7 @@ export declare const HelpSyncCommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC
5893
5915
  category: t.UnionC<[t.NumberC, t.NullC]>;
5894
5916
  sort_key: t.UnionC<[t.NumberC, t.NullC]>;
5895
5917
  icon: t.UnionC<[t.StringC, t.NullC]>;
5918
+ image: t.UnionC<[t.StringC, t.NullC]>;
5896
5919
  celebrate: t.UnionC<[t.BooleanC, t.PartialC<{
5897
5920
  angle: t.NumberC;
5898
5921
  spread: t.NumberC;
@@ -5913,12 +5936,12 @@ export declare const HelpSyncCommandV: t.IntersectionC<[t.IntersectionC<[t.TypeC
5913
5936
  hotkey_mac: t.StringC;
5914
5937
  hotkey_win: t.StringC;
5915
5938
  detail: t.UnionC<[t.NullC, t.StringC, t.IntersectionC<[t.TypeC<{
5916
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
5939
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
5917
5940
  value: t.StringC;
5918
5941
  }>, t.PartialC<{
5919
5942
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
5920
5943
  }>]>, t.ArrayC<t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
5921
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
5944
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
5922
5945
  value: t.StringC;
5923
5946
  }>, t.PartialC<{
5924
5947
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
@@ -6218,6 +6241,7 @@ export declare class HelpSyncCommand {
6218
6241
  category: number | null;
6219
6242
  sort_key: number | null;
6220
6243
  icon: string | null;
6244
+ image: string | null;
6221
6245
  celebrate: boolean | {
6222
6246
  angle?: number | undefined;
6223
6247
  spread?: number | undefined;
@@ -6238,12 +6262,12 @@ export declare class HelpSyncCommand {
6238
6262
  hotkey_mac: string;
6239
6263
  hotkey_win: string;
6240
6264
  detail: string | ({
6241
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
6265
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
6242
6266
  value: string;
6243
6267
  } & {
6244
6268
  position?: "inline" | "popover" | undefined;
6245
6269
  }) | (string | ({
6246
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
6270
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
6247
6271
  value: string;
6248
6272
  } & {
6249
6273
  position?: "inline" | "popover" | undefined;
@@ -6542,6 +6566,7 @@ export declare class HelpSyncCommand {
6542
6566
  category: number | null;
6543
6567
  sort_key: number | null;
6544
6568
  icon: string | null;
6569
+ image: string | null;
6545
6570
  celebrate: boolean | {
6546
6571
  angle?: number | undefined;
6547
6572
  spread?: number | undefined;
@@ -6562,12 +6587,12 @@ export declare class HelpSyncCommand {
6562
6587
  hotkey_mac: string;
6563
6588
  hotkey_win: string;
6564
6589
  detail: string | ({
6565
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
6590
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
6566
6591
  value: string;
6567
6592
  } & {
6568
6593
  position?: "inline" | "popover" | undefined;
6569
6594
  }) | (string | ({
6570
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
6595
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
6571
6596
  value: string;
6572
6597
  } & {
6573
6598
  position?: "inline" | "popover" | undefined;
@@ -6865,6 +6890,7 @@ export declare class HelpSyncCommand {
6865
6890
  category: number | null;
6866
6891
  sort_key: number | null;
6867
6892
  icon: string | null;
6893
+ image: string | null;
6868
6894
  celebrate: boolean | {
6869
6895
  angle?: number | undefined;
6870
6896
  spread?: number | undefined;
@@ -6885,12 +6911,12 @@ export declare class HelpSyncCommand {
6885
6911
  hotkey_mac: string;
6886
6912
  hotkey_win: string;
6887
6913
  detail: string | ({
6888
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
6914
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
6889
6915
  value: string;
6890
6916
  } & {
6891
6917
  position?: "inline" | "popover" | undefined;
6892
6918
  }) | (string | ({
6893
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
6919
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
6894
6920
  value: string;
6895
6921
  } & {
6896
6922
  position?: "inline" | "popover" | undefined;
package/build/internal/src/middleware/commandCategory.d.ts CHANGED
@@ -8,6 +8,7 @@ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC
8
8
  }>, t.PartialC<{}>]>, t.TypeC<{
9
9
  sort_key: t.UnionC<[t.NumberC, t.NullC]>;
10
10
  icon: t.UnionC<[t.StringC, t.NullC]>;
11
+ image: t.UnionC<[t.StringC, t.NullC]>;
11
12
  render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
12
13
  setting_hide_before_search: t.BooleanC;
13
14
  setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
@@ -27,6 +28,7 @@ export declare const BatchEditorCategoryResponseV: t.TypeC<{
27
28
  }>, t.PartialC<{}>]>, t.TypeC<{
28
29
  sort_key: t.UnionC<[t.NumberC, t.NullC]>;
29
30
  icon: t.UnionC<[t.StringC, t.NullC]>;
31
+ image: t.UnionC<[t.StringC, t.NullC]>;
30
32
  render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
31
33
  setting_hide_before_search: t.BooleanC;
32
34
  setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
@@ -47,6 +49,7 @@ export declare class CommandCategory {
47
49
  } & {} & {
48
50
  sort_key: number | null;
49
51
  icon: string | null;
52
+ image: string | null;
50
53
  render_as: "grid" | "list";
51
54
  setting_hide_before_search: boolean;
52
55
  setting_max_options_count: number | null;
@@ -64,6 +67,7 @@ export declare class CommandCategory {
64
67
  } & {} & {
65
68
  sort_key: number | null;
66
69
  icon: string | null;
70
+ image: string | null;
67
71
  render_as: "grid" | "list";
68
72
  setting_hide_before_search: boolean;
69
73
  setting_max_options_count: number | null;
@@ -82,6 +86,7 @@ export declare class CommandCategory {
82
86
  } & {} & {
83
87
  sort_key: number | null;
84
88
  icon: string | null;
89
+ image: string | null;
85
90
  render_as: "grid" | "list";
86
91
  setting_hide_before_search: boolean;
87
92
  setting_max_options_count: number | null;
@@ -99,6 +104,7 @@ export declare class CommandCategory {
99
104
  } & {} & {
100
105
  sort_key: number | null;
101
106
  icon: string | null;
107
+ image: string | null;
102
108
  render_as: "grid" | "list";
103
109
  setting_hide_before_search: boolean;
104
110
  setting_max_options_count: number | null;
@@ -118,6 +124,7 @@ export declare class CommandCategory {
118
124
  } & {} & {
119
125
  sort_key: number | null;
120
126
  icon: string | null;
127
+ image: string | null;
121
128
  render_as: "grid" | "list";
122
129
  setting_hide_before_search: boolean;
123
130
  setting_max_options_count: number | null;
@@ -137,6 +144,7 @@ export declare class CommandCategory {
137
144
  } & {} & {
138
145
  sort_key: number | null;
139
146
  icon: string | null;
147
+ image: string | null;
140
148
  render_as: "grid" | "list";
141
149
  setting_hide_before_search: boolean;
142
150
  setting_max_options_count: number | null;
package/build/internal/src/middleware/detailPreview.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  /*******************************************************************************/
2
2
  import * as t from 'io-ts';
3
3
  export declare const DetailPreviewObjectV: t.IntersectionC<[t.TypeC<{
4
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
4
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
5
5
  value: t.StringC;
6
6
  }>, t.PartialC<{
7
7
  position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
8
8
  }>]>;
9
9
  export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV>;
10
10
  export declare type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
11
- export declare type DataRowMedata = {
11
+ export declare type DataRowMetadata = {
12
12
  type: 'command' | 'parameter';
13
13
  label: string;
14
14
  value: any;
@@ -17,7 +17,4 @@ export declare type DataRowMedata = {
17
17
  };
18
18
  export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
19
19
  export declare const standardize: (item: undefined | null | DetailPreviewType) => null | DetailPreviewObjectType[];
20
- export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType | {
21
- type: null;
22
- value: null;
23
- };
20
+ export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType | null;
package/build/internal/src/middleware/nudge.d.ts CHANGED
@@ -21,6 +21,7 @@ export declare const NudgeV: t.IntersectionC<[t.TypeC<{
21
21
  }>;
22
22
  timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
23
23
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">]>;
24
+ is_live: t.BooleanC;
24
25
  }>, t.PartialC<{}>]>;
25
26
  export declare class Nudge {
26
27
  static decode: (data: any) => {
@@ -45,6 +46,7 @@ export declare class Nudge {
45
46
  };
46
47
  timeout_ms: number | null;
47
48
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
49
+ is_live: boolean;
48
50
  } & {};
49
51
  static create: (object: {
50
52
  id: number;
@@ -68,6 +70,7 @@ export declare class Nudge {
68
70
  };
69
71
  timeout_ms: number | null;
70
72
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
73
+ is_live: boolean;
71
74
  } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
72
75
  id: number;
73
76
  organization: string;
@@ -90,6 +93,7 @@ export declare class Nudge {
90
93
  };
91
94
  timeout_ms: number | null;
92
95
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
96
+ is_live: boolean;
93
97
  } & {}>;
94
98
  static update: (object: {
95
99
  id: number;
@@ -113,6 +117,7 @@ export declare class Nudge {
113
117
  };
114
118
  timeout_ms: number | null;
115
119
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
120
+ is_live: boolean;
116
121
  } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
117
122
  id: number;
118
123
  organization: string;
@@ -135,6 +140,7 @@ export declare class Nudge {
135
140
  };
136
141
  timeout_ms: number | null;
137
142
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
143
+ is_live: boolean;
138
144
  } & {}>;
139
145
  static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
140
146
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
@@ -159,6 +165,7 @@ export declare class Nudge {
159
165
  };
160
166
  timeout_ms: number | null;
161
167
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
168
+ is_live: boolean;
162
169
  } & {})[]>;
163
170
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
164
171
  onSuccess?: (() => void) | undefined;
@@ -185,5 +192,6 @@ export declare class Nudge {
185
192
  };
186
193
  timeout_ms: number | null;
187
194
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
195
+ is_live: boolean;
188
196
  } & {}>;
189
197
  }
package/build/internal/src/middleware/organization.d.ts CHANGED
@@ -76,6 +76,7 @@ export declare class Organization {
76
76
  unfurl?: boolean | undefined;
77
77
  description_field?: string | undefined;
78
78
  icon?: string | undefined;
79
+ image?: string | undefined;
79
80
  sort_key?: number | undefined;
80
81
  max_options_count?: number | null | undefined;
81
82
  sortFunction?: any;
@@ -90,6 +91,17 @@ export declare class Organization {
90
91
  search_tab_instruction?: string | null | undefined;
91
92
  setting_pin_to_bottom?: boolean | undefined;
92
93
  track_recents?: boolean | undefined;
94
+ detail?: string | ({
95
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
96
+ value: string;
97
+ } & {
98
+ position?: "inline" | "popover" | undefined;
99
+ }) | (string | ({
100
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
101
+ value: string;
102
+ } & {
103
+ position?: "inline" | "popover" | undefined;
104
+ }))[] | null | undefined;
93
105
  };
94
106
  };
95
107
  should_show_onboarding: boolean;
@@ -146,6 +158,7 @@ export declare class Organization {
146
158
  unfurl?: boolean | undefined;
147
159
  description_field?: string | undefined;
148
160
  icon?: string | undefined;
161
+ image?: string | undefined;
149
162
  sort_key?: number | undefined;
150
163
  max_options_count?: number | null | undefined;
151
164
  sortFunction?: any;
@@ -160,6 +173,17 @@ export declare class Organization {
160
173
  search_tab_instruction?: string | null | undefined;
161
174
  setting_pin_to_bottom?: boolean | undefined;
162
175
  track_recents?: boolean | undefined;
176
+ detail?: string | ({
177
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
178
+ value: string;
179
+ } & {
180
+ position?: "inline" | "popover" | undefined;
181
+ }) | (string | ({
182
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
183
+ value: string;
184
+ } & {
185
+ position?: "inline" | "popover" | undefined;
186
+ }))[] | null | undefined;
163
187
  };
164
188
  };
165
189
  should_show_onboarding: boolean;
@@ -215,6 +239,7 @@ export declare class Organization {
215
239
  unfurl?: boolean | undefined;
216
240
  description_field?: string | undefined;
217
241
  icon?: string | undefined;
242
+ image?: string | undefined;
218
243
  sort_key?: number | undefined;
219
244
  max_options_count?: number | null | undefined;
220
245
  sortFunction?: any;
@@ -229,6 +254,17 @@ export declare class Organization {
229
254
  search_tab_instruction?: string | null | undefined;
230
255
  setting_pin_to_bottom?: boolean | undefined;
231
256
  track_recents?: boolean | undefined;
257
+ detail?: string | ({
258
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
259
+ value: string;
260
+ } & {
261
+ position?: "inline" | "popover" | undefined;
262
+ }) | (string | ({
263
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
264
+ value: string;
265
+ } & {
266
+ position?: "inline" | "popover" | undefined;
267
+ }))[] | null | undefined;
232
268
  };
233
269
  };
234
270
  should_show_onboarding: boolean;
@@ -575,6 +611,7 @@ export declare class Organization {
575
611
  category: number | null;
576
612
  sort_key: number | null;
577
613
  icon: string | null;
614
+ image: string | null;
578
615
  celebrate: boolean | {
579
616
  angle?: number | undefined;
580
617
  spread?: number | undefined;
@@ -595,12 +632,12 @@ export declare class Organization {
595
632
  hotkey_mac: string;
596
633
  hotkey_win: string;
597
634
  detail: string | ({
598
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
635
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
599
636
  value: string;
600
637
  } & {
601
638
  position?: "inline" | "popover" | undefined;
602
639
  }) | (string | ({
603
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
640
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
604
641
  value: string;
605
642
  } & {
606
643
  position?: "inline" | "popover" | undefined;
@@ -617,6 +654,7 @@ export declare class Organization {
617
654
  } & {} & {
618
655
  sort_key: number | null;
619
656
  icon: string | null;
657
+ image: string | null;
620
658
  render_as: "grid" | "list";
621
659
  setting_hide_before_search: boolean;
622
660
  setting_max_options_count: number | null;
@@ -819,6 +857,7 @@ export declare class Organization {
819
857
  unfurl?: boolean | undefined;
820
858
  description_field?: string | undefined;
821
859
  icon?: string | undefined;
860
+ image?: string | undefined;
822
861
  sort_key?: number | undefined;
823
862
  max_options_count?: number | null | undefined;
824
863
  sortFunction?: any;
@@ -833,6 +872,17 @@ export declare class Organization {
833
872
  search_tab_instruction?: string | null | undefined;
834
873
  setting_pin_to_bottom?: boolean | undefined;
835
874
  track_recents?: boolean | undefined;
875
+ detail?: string | ({
876
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
877
+ value: string;
878
+ } & {
879
+ position?: "inline" | "popover" | undefined;
880
+ }) | (string | ({
881
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
882
+ value: string;
883
+ } & {
884
+ position?: "inline" | "popover" | undefined;
885
+ }))[] | null | undefined;
836
886
  };
837
887
  };
838
888
  should_show_onboarding: boolean;
package/build/internal/src/middleware/tab.d.ts ADDED
@@ -0,0 +1,27 @@
1
+ import * as t from 'io-ts';
2
+ export declare const TabV: t.TypeC<{
3
+ id: t.NumberC;
4
+ organization: t.UnionC<[t.NumberC, t.StringC]>;
5
+ category_ids: t.ArrayC<t.NumberC>;
6
+ sort_key: t.NumberC;
7
+ icon: t.UnionC<[t.StringC, t.NullC]>;
8
+ label: t.StringC;
9
+ header: t.UnionC<[t.StringC, t.NullC]>;
10
+ description: t.StringC;
11
+ placeholder: t.UnionC<[t.StringC, t.NullC]>;
12
+ render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
13
+ }>;
14
+ export declare class Tab {
15
+ static decode: (data: any) => {
16
+ id: number;
17
+ organization: string | number;
18
+ category_ids: number[];
19
+ sort_key: number;
20
+ icon: string | null;
21
+ label: string;
22
+ header: string | null;
23
+ description: string;
24
+ placeholder: string | null;
25
+ render_as: "grid" | "list";
26
+ };
27
+ }
package/build/internal/src/middleware/types.d.ts CHANGED
@@ -20,6 +20,7 @@ import { PlaceholderV } from './placeholder';
20
20
  import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
21
21
  import { EnvironmentV } from './environment';
22
22
  import { NudgeV } from './nudge';
23
+ import { TabV } from './tab';
23
24
  import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
24
25
  /*******************************************************************************/
25
26
  export declare type IContextType = t.TypeOf<typeof ContextV>;
@@ -42,6 +43,7 @@ export declare type ISkinType = t.TypeOf<typeof SkinV>;
42
43
  export declare type IProfileType = t.TypeOf<typeof ProfileV>;
43
44
  export declare type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV>;
44
45
  export declare type IPlaceholderType = t.TypeOf<typeof PlaceholderV>;
46
+ export declare type ITabType = t.TypeOf<typeof TabV>;
45
47
  export declare type IEnvironmentType = t.TypeOf<typeof EnvironmentV>;
46
48
  export declare type IReleaseStep = t.TypeOf<typeof ReleaseStepV>;
47
49
  export declare type IRelease = t.TypeOf<typeof ReleaseV>;
@@ -93,7 +95,7 @@ export interface IUserContext {
93
95
  [variable: string]: any;
94
96
  }
95
97
  export interface ICallbackMap {
96
- [variable: string]: (...args: any[]) => any;
98
+ [variable: string]: (...args: any[]) => unknown;
97
99
  }
98
100
  export interface IResourceType extends IUserContext {
99
101
  _cbLinkedCommmands: Array<{
@@ -108,10 +110,11 @@ export declare type IConfigEndpointResponse = {
108
110
  environments_with_versions?: any[];
109
111
  placeholders?: any[];
110
112
  nudges?: INudgeType[];
113
+ tabs?: ITabType[];
111
114
  };
112
115
  export type { IResourceSettings } from './IResourceSettings';
113
116
  export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
114
- export type { DetailPreviewObjectType, DetailPreviewType, DataRowMedata } from './detailPreview';
117
+ export type { DetailPreviewObjectType, DetailPreviewType, DataRowMetadata } from './detailPreview';
115
118
  /*******************************************************************************/
116
119
  export declare const isCommand: (command?: ICommandType | any) => command is {
117
120
  id: number;
@@ -402,6 +405,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
402
405
  category: number | null;
403
406
  sort_key: number | null;
404
407
  icon: string | null;
408
+ image: string | null;
405
409
  celebrate: boolean | {
406
410
  angle?: number | undefined;
407
411
  spread?: number | undefined;
@@ -422,17 +426,20 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
422
426
  hotkey_mac: string;
423
427
  hotkey_win: string;
424
428
  detail: string | ({
425
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
429
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
426
430
  value: string;
427
431
  } & {
428
432
  position?: "inline" | "popover" | undefined;
429
433
  }) | (string | ({
430
- type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
434
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
431
435
  value: string;
432
436
  } & {
433
437
  position?: "inline" | "popover" | undefined;
434
438
  }))[] | null;
435
439
  next_steps: (string | number)[];
440
+ } & {
441
+ third_party_source?: string | null | undefined;
442
+ third_party_id?: string | null | undefined;
436
443
  };
437
444
  export declare const isResource: (option: any) => option is IResourceType;
438
445
  export declare const isContextArgument: (argument: IArgumentType) => argument is {
package/build/internal/src/middleware/user.d.ts CHANGED
@@ -10,5 +10,5 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
10
10
  has_updated_password: t.BooleanC;
11
11
  is_active: t.BooleanC;
12
12
  }>, t.PartialC<{
13
- intercom_hash: t.StringC;
13
+ atlas_hash: t.StringC;
14
14
  }>]>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "commandbar",
3
- "version": "1.6.15",
3
+ "version": "1.6.16",
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",