commandbar 1.6.9 → 1.6.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/internal/src/client/CommandBarClientSDK.d.ts +1 -1
- package/build/internal/src/client/EventHandler.d.ts +12 -2
- package/build/internal/src/middleware/CommandFromClientV.d.ts +2 -2
- package/build/internal/src/middleware/OrganizationV.d.ts +8 -0
- package/build/internal/src/middleware/ResourceSettingsV.d.ts +2 -0
- package/build/internal/src/middleware/command.d.ts +1484 -120
- package/build/internal/src/middleware/commandCategory.d.ts +43 -0
- package/build/internal/src/middleware/detailPreview.d.ts +6 -2
- package/build/internal/src/middleware/generics.d.ts +4 -0
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +66 -0
- package/build/internal/src/middleware/helpDocsSync.d.ts +42 -0
- package/build/internal/src/middleware/organization.d.ts +33 -8
- package/build/internal/src/middleware/types.d.ts +16 -10
- package/package.json +1 -1
@@ -247,7 +247,7 @@ export declare type CommandBarClientSDK = Readonly<{
|
|
247
247
|
* @param slug Component slug
|
248
248
|
* @param getHTML Function that returns an html string to be rendered as the component
|
249
249
|
*/
|
250
|
-
setCustomComponent(slug: 'header' | 'input' | 'sidepanel' | 'footer', getHTML: (step?: 'base' | 'multiselect' | 'longtextinput' | 'textinput' | 'select') => string): void;
|
250
|
+
setCustomComponent(slug: 'header' | 'input' | 'sidepanel' | 'footer' | 'navPaneHeader' | 'navPaneFooter', getHTML: (step?: 'base' | 'multiselect' | 'longtextinput' | 'textinput' | 'select') => string): void;
|
251
251
|
/**
|
252
252
|
* Similar to `addContext`, but also removes any keys that are omitted from the supplied `ctx` from context. It may be
|
253
253
|
* helpful to use this to make large context changes, such as when a user logs out.
|
@@ -15,6 +15,8 @@ export interface AbandonedSearchEvent {
|
|
15
15
|
numCommands: number;
|
16
16
|
numRecords: number;
|
17
17
|
};
|
18
|
+
/** command_ids of previously executed commands in the session */
|
19
|
+
previousCommands?: string[];
|
18
20
|
}
|
19
21
|
export interface ClosedEvent {
|
20
22
|
/** Event data passed for `command_execution` events. */
|
@@ -38,8 +40,16 @@ export interface CommandExecutionEvent {
|
|
38
40
|
source: string;
|
39
41
|
/** DEPRECATED. The text input.*/
|
40
42
|
['inputText[*]']: string;
|
41
|
-
/** The text input
|
42
|
-
inputText
|
43
|
+
/** The text input.*/
|
44
|
+
inputText?: string;
|
45
|
+
/** True if this command was triggered by a shortcut. */
|
46
|
+
shortcut?: boolean;
|
47
|
+
/** Ranking order of the command option */
|
48
|
+
ranking?: number;
|
49
|
+
/** command_ids of previously executed commands in the session */
|
50
|
+
previousCommands?: string[];
|
51
|
+
/** Command types, as defined at: https://www.commandbar.com/docs/commands/types/overview */
|
52
|
+
commandType?: 'admin' | 'link' | 'script' | 'clickByXpath' | 'clickBySelector' | 'click' | 'callback' | 'builtin' | 'webhook' | 'request' | 'appcues';
|
43
53
|
}
|
44
54
|
export interface EndUserShortcutChangedEvent {
|
45
55
|
/** Event data passed for `command_execution` events. */
|
@@ -243,10 +243,10 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
|
|
243
243
|
reason: t.StringC;
|
244
244
|
}>]>]>>;
|
245
245
|
detail: t.UnionC<[t.StringC, t.TypeC<{
|
246
|
-
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"
|
246
|
+
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
|
247
247
|
value: t.StringC;
|
248
248
|
}>, t.ArrayC<t.TypeC<{
|
249
|
-
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"
|
249
|
+
type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
|
250
250
|
value: t.StringC;
|
251
251
|
}>>]>;
|
252
252
|
}>]>;
|
@@ -35,6 +35,7 @@ declare const OrganizationAdditionalV: t.TypeC<{
|
|
35
35
|
search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
|
36
36
|
search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
|
37
37
|
setting_pin_to_bottom: t.BooleanC;
|
38
|
+
track_recents: t.BooleanC;
|
38
39
|
}>>;
|
39
40
|
should_show_onboarding: t.BooleanC;
|
40
41
|
last_snippet_request: t.UnionC<[t.StringC, t.NullC]>;
|
@@ -48,8 +49,11 @@ declare const OrganizationAdditionalV: t.TypeC<{
|
|
48
49
|
summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
|
49
50
|
end_user_hotkeys: t.UnionC<[t.UndefinedC, t.BooleanC]>;
|
50
51
|
end_user_shortcuts_enabled: t.BooleanC;
|
52
|
+
end_user_recents_enabled: t.BooleanC;
|
51
53
|
releases_available: t.BooleanC;
|
52
54
|
releases_enabled: t.BooleanC;
|
55
|
+
fallback_commands: t.ArrayC<t.NumberC>;
|
56
|
+
tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
|
53
57
|
}>;
|
54
58
|
export declare const defaults: t.TypeOf<typeof OrganizationAdditionalV>;
|
55
59
|
export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
@@ -92,6 +96,7 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
92
96
|
search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
|
93
97
|
search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
|
94
98
|
setting_pin_to_bottom: t.BooleanC;
|
99
|
+
track_recents: t.BooleanC;
|
95
100
|
}>>;
|
96
101
|
should_show_onboarding: t.BooleanC;
|
97
102
|
last_snippet_request: t.UnionC<[t.StringC, t.NullC]>;
|
@@ -105,8 +110,11 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
105
110
|
summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
|
106
111
|
end_user_hotkeys: t.UnionC<[t.UndefinedC, t.BooleanC]>;
|
107
112
|
end_user_shortcuts_enabled: t.BooleanC;
|
113
|
+
end_user_recents_enabled: t.BooleanC;
|
108
114
|
releases_available: t.BooleanC;
|
109
115
|
releases_enabled: t.BooleanC;
|
116
|
+
fallback_commands: t.ArrayC<t.NumberC>;
|
117
|
+
tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
|
110
118
|
}>]>;
|
111
119
|
export declare type IOrganizationType = t.TypeOf<typeof OrganizationV>;
|
112
120
|
export {};
|
@@ -27,6 +27,7 @@ export declare const ResourceSettingsV: t.PartialC<{
|
|
27
27
|
search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
|
28
28
|
search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
|
29
29
|
setting_pin_to_bottom: t.BooleanC;
|
30
|
+
track_recents: t.BooleanC;
|
30
31
|
}>;
|
31
32
|
export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.PartialC<{
|
32
33
|
name: t.StringC;
|
@@ -52,4 +53,5 @@ export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.Parti
|
|
52
53
|
search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
|
53
54
|
search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
|
54
55
|
setting_pin_to_bottom: t.BooleanC;
|
56
|
+
track_recents: t.BooleanC;
|
55
57
|
}>>;
|