commandbar 1.6.8 → 1.6.11

package/build/internal/src/middleware/organization.d.ts

@@ -15,31 +15,25 @@ export declare const InternalSettingsV: t.TypeC<{
     integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.StringC>>;
 }>;
 export declare const OrganizationSettingsV: t.TypeC<{
-    analytics: t.TypeC<{
-        execution_limit: t.NumberC;
-        deadend_limit: t.NumberC;
-    }>;
-    analytics_control: t.TypeC<{
-        silent_enabled: t.BooleanC;
-        allow_event_handlers: t.BooleanC;
-        event_attribute_block_list: t.ArrayC<t.StringC>;
-    }>;
-    skins: t.TypeC<{
-        limit: t.NumberC;
-        field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
-    }>;
-    deployment: t.TypeC<{
-        show_countdown_banner: t.BooleanC;
-    }>;
-    view: t.TypeC<{
-        in_bar_feedback: t.BooleanC;
-    }>;
     end_user_limit: t.NumberC;
     user_seat_limit: t.NumberC;
-    releases: t.TypeC<{
-        available: t.BooleanC;
-        environments: t.ArrayC<t.StringC>;
-    }>;
+    analytics_dashboard_execution_limit: t.NumberC;
+    analytics_dashboard_deadend_limit: t.NumberC;
+    silent_mode: t.BooleanC;
+    allow_event_handlers: t.BooleanC;
+    event_attribute_block_list: t.ArrayC<t.StringC>;
+    skins_limit: t.NumberC;
+    skins_field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
+    show_countdown_banner: t.BooleanC;
+    can_install_foobar: t.BooleanC;
+    releases_available: t.BooleanC;
+    releases_enabled: t.BooleanC;
+    releases_environments: t.ArrayC<t.StringC>;
+    in_bar_feedback: t.BooleanC;
+    summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
+    end_user_shortcuts_enabled: t.BooleanC;
+    fallback_commands: t.ArrayC<t.NumberC>;
+    end_user_recents_enabled: t.BooleanC;
 }>;
 export declare class Organization {
     static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -67,7 +61,10 @@ export declare class Organization {
                 search?: boolean | undefined;
                 label_field?: string | undefined;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
@@ -76,12 +73,14 @@ export declare class Organization {
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -94,9 +93,13 @@ export declare class Organization {
         allow_event_handlers: boolean;
         in_bar_feedback: boolean;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     }>;
     static update: (object: {
         id: string | number;
@@ -120,7 +123,10 @@ export declare class Organization {
                 search?: boolean | undefined;
                 label_field?: string | undefined;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
@@ -129,12 +135,14 @@ export declare class Organization {
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -147,9 +155,13 @@ export declare class Organization {
         allow_event_handlers: boolean;
         in_bar_feedback: boolean;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: string | number;
         name: string;
@@ -172,7 +184,10 @@ export declare class Organization {
                 search?: boolean | undefined;
                 label_field?: string | undefined;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
@@ -181,12 +196,14 @@ export declare class Organization {
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -199,9 +216,13 @@ export declare class Organization {
         allow_event_handlers: boolean;
         in_bar_feedback: boolean;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     }>;
     static listCommands: (orgUID: string) => Promise<({
         id: number;
@@ -232,7 +253,7 @@ export declare class Organization {
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
         }) | ({
-            type: "click" | "clickBySelector" | "clickByXpath";
+            type: "click" | "clickByXpath" | "clickBySelector";
             value: string[];
         } & {} & {
             commandType?: "object" | "independent" | "help" | undefined;
@@ -263,6 +284,35 @@ export declare class Organization {
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "request";
+            value: {
+                method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
+                url: string;
+            } & {
+                headers?: {
+                    [key: string]: unknown;
+                } | undefined;
+                body?: {
+                    [key: string]: unknown;
+                } | undefined;
+                onSend?: string | undefined;
+                onSuccess?: string | undefined;
+                onError?: string | undefined;
+            };
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "appcues";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
         });
     } & {
         disabledReason?: string | undefined;
@@ -424,6 +474,13 @@ export declare class Organization {
         shortcut_win: string[];
         hotkey_mac: string;
         hotkey_win: string;
+        detail: string | {
+            type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+            value: string;
+        } | (string | {
+            type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+            value: string;
+        })[] | null;
     })[]>;
     static listCommandCategories: (orgUID: string) => Promise<({
         id: number;
@@ -432,12 +489,14 @@ export declare class Organization {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
         setting_max_options_count: number | null;
         setting_pin_to_bottom: boolean;
         search_tab_enabled: boolean;
         search_tab_name: string;
         search_tab_instruction: string;
+        track_recents: boolean;
     })[]>;
     static listGuides: (orgUID: string) => Promise<({
         id: number;
@@ -522,31 +581,69 @@ export declare class Organization {
         onSuccess?: (() => void) | undefined;
         onError?: ((err: string) => void) | undefined;
     } | undefined) => Promise<{
-        analytics: {
-            execution_limit: number;
-            deadend_limit: number;
-        };
-        analytics_control: {
-            silent_enabled: boolean;
-            allow_event_handlers: boolean;
-            event_attribute_block_list: string[];
-        };
-        skins: {
-            limit: number;
-            field_set: "basic" | "pro";
-        };
-        deployment: {
-            show_countdown_banner: boolean;
-        };
-        view: {
-            in_bar_feedback: boolean;
-        };
         end_user_limit: number;
         user_seat_limit: number;
-        releases: {
-            available: boolean;
-            environments: string[];
-        };
+        analytics_dashboard_execution_limit: number;
+        analytics_dashboard_deadend_limit: number;
+        silent_mode: boolean;
+        allow_event_handlers: boolean;
+        event_attribute_block_list: string[];
+        skins_limit: number;
+        skins_field_set: "basic" | "pro";
+        show_countdown_banner: boolean;
+        can_install_foobar: boolean;
+        releases_available: boolean;
+        releases_enabled: boolean;
+        releases_environments: string[];
+        in_bar_feedback: boolean;
+        summon_hotkey_override: string | null;
+        end_user_shortcuts_enabled: boolean;
+        fallback_commands: number[];
+        end_user_recents_enabled: boolean;
+    }>;
+    static updateSetting: (object: {
+        end_user_limit?: number | undefined;
+        user_seat_limit?: number | undefined;
+        analytics_dashboard_execution_limit?: number | undefined;
+        analytics_dashboard_deadend_limit?: number | undefined;
+        silent_mode?: boolean | undefined;
+        allow_event_handlers?: boolean | undefined;
+        event_attribute_block_list?: string[] | undefined;
+        skins_limit?: number | undefined;
+        skins_field_set?: "basic" | "pro" | undefined;
+        show_countdown_banner?: boolean | undefined;
+        can_install_foobar?: boolean | undefined;
+        releases_available?: boolean | undefined;
+        releases_enabled?: boolean | undefined;
+        releases_environments?: string[] | undefined;
+        in_bar_feedback?: boolean | undefined;
+        summon_hotkey_override?: string | null | undefined;
+        end_user_shortcuts_enabled?: boolean | undefined;
+        fallback_commands?: number[] | undefined;
+        end_user_recents_enabled?: boolean | undefined;
+    }, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        end_user_limit: number;
+        user_seat_limit: number;
+        analytics_dashboard_execution_limit: number;
+        analytics_dashboard_deadend_limit: number;
+        silent_mode: boolean;
+        allow_event_handlers: boolean;
+        event_attribute_block_list: string[];
+        skins_limit: number;
+        skins_field_set: "basic" | "pro";
+        show_countdown_banner: boolean;
+        can_install_foobar: boolean;
+        releases_available: boolean;
+        releases_enabled: boolean;
+        releases_environments: string[];
+        in_bar_feedback: boolean;
+        summon_hotkey_override: string | null;
+        end_user_shortcuts_enabled: boolean;
+        fallback_commands: number[];
+        end_user_recents_enabled: boolean;
     }>;
     static decode: (data: any) => {
         id: string | number;
@@ -570,7 +667,10 @@ export declare class Organization {
                 search?: boolean | undefined;
                 label_field?: string | undefined;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
@@ -579,12 +679,14 @@ export declare class Organization {
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -597,8 +699,12 @@ export declare class Organization {
         allow_event_handlers: boolean;
         in_bar_feedback: boolean;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     };
 }

package/build/internal/src/middleware/types.d.ts

@@ -1,14 +1,18 @@
 /*******************************************************************************/
 import * as t from 'io-ts';
-import { BatchEditorCommandRequestV, BatchEditorCommandResponseV, BatchOperationV, CommandV, EditorCommandV } from './command';
+import { BatchEditorCommandResponseV, BatchOperationV, CommandV, HelpSyncCommandV, EditorCommandV } from './command';
 import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
-import { TemplateV, TemplateOptionsV } from './helpers/commandTemplate';
+import { GenericBatchRequest } from './generics';
+import { OptionGroupRenderAsV } from './helpers/optionGroup';
+import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
 import { CommandCategoryV } from './commandCategory';
 import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationSettingsV } from './organization';
 import { UserV } from './user';
 import { ContextV } from './context';
 import { GuideV } from './guide';
 import { HistoryEventV } from './historyEvent';
+import { HelpDocsSyncV } from './helpDocsSync';
+import { HelpDocsIntegrationV } from './helpDocsIntegration';
 import { EndUserV } from './helpers/endUser';
 import { SkinV } from './skin';
 import { ProfileV } from './profile';
@@ -20,12 +24,15 @@ export declare type IContextType = t.TypeOf<typeof ContextV>;
 export declare type IUserType = t.TypeOf<typeof UserV>;
 export declare type ICommandType = t.TypeOf<typeof CommandV>;
 export declare type IEditorCommandType = t.TypeOf<typeof EditorCommandV>;
+export declare type IHelpSyncCommandType = t.TypeOf<typeof HelpSyncCommandV>;
 export type { ICommandFromClientType } from './ICommandFromClientType';
 export declare type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV>;
 export declare type IGuideType = t.TypeOf<typeof GuideV> & {
     preview?: boolean;
 };
 export declare type IHistoryEventType = t.TypeOf<typeof HistoryEventV>;
+export declare type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV>;
+export declare type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrationV>;
 export type { IOrganizationType } from './OrganizationV';
 export declare type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV>;
 export declare type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV>;
@@ -39,7 +46,7 @@ export declare type IRelease = t.TypeOf<typeof ReleaseV>;
 export declare type IEnvReleaseInfo = t.TypeOf<typeof EnvReleaseInfoV>;
 /*******************************************************************************/
 export declare type IBatchOperation = t.TypeOf<typeof BatchOperationV>;
-export declare type IBatchEditorCommandRequst = t.TypeOf<typeof BatchEditorCommandRequestV>;
+export declare type IBatchEditorCommandRequst = t.TypeOf<typeof GenericBatchRequest>;
 export declare type IBatchEditorCommandResponse = t.TypeOf<typeof BatchEditorCommandResponseV>;
 /*******************************************************************************/
 export declare type IKeyEventCategory = t.TypeOf<typeof KeyEventV>;
@@ -47,6 +54,8 @@ export declare type IArgumentMap = t.TypeOf<typeof ArgumentMapV>;
 export declare type IArgumentType = t.TypeOf<typeof ArgumentTypeV>;
 export declare type IStepArgumentType = t.TypeOf<typeof StepArgumentTypeV>;
 export declare type ITemplate = t.TypeOf<typeof TemplateV>;
+export declare type RequestTemplateType = t.TypeOf<typeof RequestTemplateV>;
+export declare type RequestType = t.TypeOf<typeof RequestV>;
 export declare type ITemplateOptions = t.TypeOf<typeof TemplateOptionsV>;
 export declare type IEndUserType = t.TypeOf<typeof EndUserV>;
 export declare type IConditionType = t.TypeOf<typeof ConditionV>;
@@ -56,6 +65,7 @@ export declare type ISetArgumentType = t.TypeOf<typeof SetArgumentV>;
 export declare type IDynamicArgumentType = t.TypeOf<typeof DynamicArgumentV>;
 export declare type IDependentArgumentType = t.TypeOf<typeof DependentArgumentV>;
 export declare type IFunctionArgumentType = t.TypeOf<typeof FunctionArgumentV>;
+export declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderAsV>;
 export interface ICommandInput {
     text: string;
     command: ICommandType;
@@ -89,6 +99,7 @@ export declare type IConfigEndpointResponse = {
 };
 export type { IResourceSettings } from './IResourceSettings';
 export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
+export type { DetailPreviewObjectType, DetailPreviewType, DataRowMedata } from './detailPreview';
 /*******************************************************************************/
 export declare const isCommand: (command?: ICommandType | any) => command is {
     id: number;
@@ -119,7 +130,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
     }) | ({
-        type: "click" | "clickBySelector" | "clickByXpath";
+        type: "click" | "clickByXpath" | "clickBySelector";
         value: string[];
     } & {} & {
         commandType?: "object" | "independent" | "help" | undefined;
@@ -150,6 +161,35 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
+    }) | ({
+        type: "request";
+        value: {
+            method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
+            url: string;
+        } & {
+            headers?: {
+                [key: string]: unknown;
+            } | undefined;
+            body?: {
+                [key: string]: unknown;
+            } | undefined;
+            onSend?: string | undefined;
+            onSuccess?: string | undefined;
+            onError?: string | undefined;
+        };
+    } & {} & {
+        commandType?: "object" | "independent" | "help" | undefined;
+        object?: string | undefined;
+        hoverTooltip?: boolean | undefined;
+        operation?: "self" | "router" | "blank" | undefined;
+    }) | ({
+        type: "appcues";
+        value: string;
+    } & {} & {
+        commandType?: "object" | "independent" | "help" | undefined;
+        object?: string | undefined;
+        hoverTooltip?: boolean | undefined;
+        operation?: "self" | "router" | "blank" | undefined;
     });
 } & {
     disabledReason?: string | undefined;
@@ -311,6 +351,13 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
     shortcut_win: string[];
     hotkey_mac: string;
     hotkey_win: string;
+    detail: string | {
+        type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+        value: string;
+    } | (string | {
+        type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+        value: string;
+    })[] | null;
 };
 export declare const isResource: (option: any) => option is IResourceType;
 export declare const isContextArgument: (argument: IArgumentType) => argument is {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commandbar",
-  "version": "1.6.8",
+  "version": "1.6.11",
   "description": "Javascript Utility for CommandBar",
   "main": "build/commandbar-js/src/index.js",
   "types": "build/commandbar-js/src/index.d.ts",

package/src/init.ts

@@ -3,7 +3,7 @@ import 'es6-object-assign/auto';
 import 'es6-symbol/implement';
 import { getProxySDK } from '../../internal/src/client/proxy';
 import { _configuration } from '../../internal/src/client/symbols';
-import { IConfigEndpointResponse } from '@commandbar/internal/middleware/types';
+import { IConfigEndpointResponse } from '../../internal/src/middleware/types';
 
 interface IInitOptions {
   debug?: boolean;