commandbar - npm Package Compare versions

Comparing version 1.6.8 to 1.6.9

build/commandbar-js/src/init.d.ts

 import 'proxy-polyfill';
 import 'es6-object-assign/auto';
 import 'es6-symbol/implement';
-import { IConfigEndpointResponse } from '@commandbar/internal/middleware/types';
+import { IConfigEndpointResponse } from '../../internal/src/middleware/types';
 interface IInitOptions {
@@ -6,0 +6,0 @@ debug?: boolean;

build/internal/src/client/AddContextOptions.d.ts

@@ -33,2 +33,6 @@ export declare type DataRow = {
         unfurl?: boolean;
+        /** Show records by default with no input */
+        showInDefaultEmptyState?: boolean;
+        /** Sort key */
+        categorySortKey?: number;
     };
@@ -53,3 +57,6 @@ /** Options to customize the style of `key` objects. */
          */
-        fields?: string[];
+        fields?: (string | {
+            key: string;
+            label: string;
+        })[];
         /**
@@ -86,3 +93,6 @@ * Adds a custom search function to CommandBar for `key`. This custom search function should take a single argument `input` and return an array of results.
      */
-    searchableFields?: string[];
+    searchableFields?: (string | {
+        key: string;
+        label: string;
+    })[];
     onInputChange?: SearchFunction | SearchFunctionPaginated;
@@ -96,3 +106,7 @@ }
         unfurl?: boolean;
+        /** Show records by default with no input */
+        showInDefaultEmptyState?: boolean;
+        /** Sort key */
+        categorySortKey?: number;
     };
 }

build/internal/src/client/CommandBarClientSDK.d.ts

@@ -5,3 +5,5 @@ import { AddContextOptions, ArgumentOptions, DataRow, RecordOptions } from './AddContextOptions';
 import { IResourceSettings } from '../middleware/IResourceSettings';
-import { ICommandCategoryType } from '../middleware/types';
+import { ICommandCategoryType, DetailPreviewType, DataRowMedata } from '../middleware/types';
+export type { DataRow } from './AddContextOptions';
+export type { DataRowMedata } from '../middleware/types';
 export declare const ASYNC_METHODS: Array<keyof CommandBarClientSDK>;
@@ -186,2 +188,10 @@ export declare type BootOptions = string | (UserAttributes & {
     /**
+     * Defines a function
+     *
+     * @param fn The preview detail generator function. It should accept the following arguments:
+     * * `row` {any}
+     * * `node` {any}
+     */
+    generateDetailPreview(fn: (data: DataRow, metadata: DataRowMedata) => undefined | DetailPreviewType): void;
+    /**
      * Returns an array returning all commands that fit the optional filter function. By default, all commands are returned
@@ -188,0 +198,0 @@ * @param filter A function that filters out commands based on its properties. These are:

build/internal/src/middleware/commandCategory.d.ts

@@ -10,2 +10,3 @@ /*******************************************************************************/
     icon: t.UnionC<[t.StringC, t.NullC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
     setting_hide_before_search: t.BooleanC;
@@ -26,2 +27,3 @@ setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
@@ -40,2 +42,3 @@ setting_max_options_count: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
@@ -55,2 +58,3 @@ setting_max_options_count: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
@@ -69,2 +73,3 @@ setting_max_options_count: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
@@ -85,2 +90,3 @@ setting_max_options_count: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
@@ -87,0 +93,0 @@ setting_max_options_count: number | null;

build/internal/src/middleware/CommandFromClientV.d.ts

@@ -36,2 +36,27 @@ import * as t from 'io-ts';
         operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+    }>]>]>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"request">;
+        value: t.IntersectionC<[t.TypeC<{
+            method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+            url: t.StringC;
+        }>, t.PartialC<{
+            headers: t.UnknownRecordC;
+            body: t.UnknownRecordC;
+            onSend: t.StringC;
+            onSuccess: t.StringC;
+            onError: t.StringC;
+        }>]>;
+    }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+        commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+        object: t.StringC;
+        hoverTooltip: t.BooleanC;
+        operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+    }>]>]>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"appcues">;
+        value: t.StringC;
+    }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+        commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+        object: t.StringC;
+        hoverTooltip: t.BooleanC;
+        operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
     }>]>]>]>;
@@ -221,2 +246,9 @@ text: t.StringC;
     }>]>]>>;
+    detail: t.UnionC<[t.StringC, t.TypeC<{
+        type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"reader">, t.LiteralC<"react">]>;
+        value: t.StringC;
+    }>, t.ArrayC<t.TypeC<{
+        type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"reader">, t.LiteralC<"react">]>;
+        value: t.StringC;
+    }>>]>;
 }>]>;

build/internal/src/middleware/generics.d.ts

@@ -28,6 +28,10 @@ import * as t from 'io-ts';
 }): Promise<any[]>;
-declare function read<T, O, I>(arg: t.Type<T, O, I>, url: string): (params?: Record<string, string>, callbacks?: {
+declare function read<T, O, I>(output: t.Type<T, O, I>, url: string): (params?: Record<string, string>, callbacks?: {
     onSuccess?: () => void;
     onError?: (err: string) => void;
 }) => Promise<T>;
-export { createObject, createObjectDetail, read, readObject, listObject, updateObject, deleteObject, GenericObject, readObjectDetail, updateObjectDetail, loadIDList, decodeToPromise, decodeThrowing, };
+declare function update<T, O, I, Q>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string): (object: Q, params?: Record<string, string>, callbacks?: {
+    onSuccess?: () => void;
+    onError?: (err: string) => void;
+}) => Promise<T>;
+export { createObject, createObjectDetail, read, readObject, listObject, update, updateObject, deleteObject, GenericObject, readObjectDetail, updateObjectDetail, loadIDList, decodeToPromise, decodeThrowing, };

build/internal/src/middleware/helpers/commandTemplate.d.ts

@@ -64,2 +64,11 @@ /*******************************************************************************/
 }>]>]>;
+export declare const AppCuesTemplateV: t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"appcues">;
+    value: t.StringC;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>;
 export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
@@ -74,2 +83,30 @@ type: t.LiteralC<"script">;
 }>]>]>;
+export declare const RequestV: t.IntersectionC<[t.TypeC<{
+    method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+    url: t.StringC;
+}>, t.PartialC<{
+    headers: t.UnknownRecordC;
+    body: t.UnknownRecordC;
+    onSend: t.StringC;
+    onSuccess: t.StringC;
+    onError: t.StringC;
+}>]>;
+export declare const RequestTemplateV: t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"request">;
+    value: t.IntersectionC<[t.TypeC<{
+        method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+        url: t.StringC;
+    }>, t.PartialC<{
+        headers: t.UnknownRecordC;
+        body: t.UnknownRecordC;
+        onSend: t.StringC;
+        onSuccess: t.StringC;
+        onError: t.StringC;
+    }>]>;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>;
 export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
@@ -131,2 +168,27 @@ type: t.LiteralC<"admin">;
     operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>, t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"request">;
+    value: t.IntersectionC<[t.TypeC<{
+        method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+        url: t.StringC;
+    }>, t.PartialC<{
+        headers: t.UnknownRecordC;
+        body: t.UnknownRecordC;
+        onSend: t.StringC;
+        onSuccess: t.StringC;
+        onError: t.StringC;
+    }>]>;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>, t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"appcues">;
+    value: t.StringC;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
 }>]>]>]>;

build/internal/src/middleware/ICommandFromClientType.d.ts

 import * as t from 'io-ts';
 import { CommandFromClientV } from './CommandFromClientV';
+import { ContextArgumentV } from './helpers/argument';
 export declare type ICommandFromClientType = t.TypeOf<typeof CommandFromClientV>;
+export declare type IContextArgument = t.TypeOf<typeof ContextArgumentV>;

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

@@ -18,27 +18,19 @@ import * as t from 'io-ts';
 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;
 }>;
@@ -71,3 +63,6 @@ export declare class Organization {
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
@@ -81,2 +76,3 @@ unfurl?: boolean | undefined;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
@@ -100,3 +96,4 @@ show_with_no_results?: boolean | undefined;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
         releases_available: boolean;
@@ -127,3 +124,6 @@ releases_enabled: boolean;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
@@ -137,2 +137,3 @@ unfurl?: boolean | undefined;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
@@ -156,3 +157,4 @@ show_with_no_results?: boolean | undefined;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
         releases_available: boolean;
@@ -182,3 +184,6 @@ releases_enabled: boolean;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
@@ -192,2 +197,3 @@ unfurl?: boolean | undefined;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
@@ -211,3 +217,4 @@ show_with_no_results?: boolean | undefined;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
         releases_available: boolean;
@@ -276,2 +283,31 @@ releases_enabled: boolean;
             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;
         });
@@ -284,2 +320,9 @@ } & {
         modified?: string | undefined;
+        detail?: string | {
+            type: "html" | "plaintext" | "markdown" | "reader" | "react";
+            value: string;
+        } | {
+            type: "html" | "plaintext" | "markdown" | "reader" | "react";
+            value: string;
+        }[] | undefined;
     } & {
@@ -447,2 +490,3 @@ arguments: {
         icon: string | null;
+        render_as: "grid" | "list";
         setting_hide_before_search: boolean;
@@ -538,28 +582,60 @@ setting_max_options_count: number | null;
     } | 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;
     }>;
+    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;
+    }, 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;
+    }>;
     static decode: (data: any) => {
@@ -587,3 +663,6 @@ id: string | number;
                 useCategory?: boolean | undefined;
-                search_fields?: string[] | undefined;
+                search_fields?: (string | {
+                    key: string;
+                    label: string;
+                })[] | undefined;
                 auto_execute?: boolean | undefined;
@@ -597,2 +676,3 @@ unfurl?: boolean | undefined;
                 default_command_id?: string | number | undefined;
+                render_as?: "grid" | "list" | undefined;
                 showResources?: boolean | undefined;
@@ -616,3 +696,4 @@ show_with_no_results?: boolean | undefined;
         summon_hotkey_override: string | null;
-        end_user_hotkeys: boolean;
+        end_user_hotkeys: boolean | undefined;
+        end_user_shortcuts_enabled: boolean;
         releases_available: boolean;
@@ -619,0 +700,0 @@ releases_enabled: boolean;

build/internal/src/middleware/OrganizationV.d.ts

@@ -19,3 +19,6 @@ import * as t from 'io-ts';
         useCategory: t.BooleanC;
-        search_fields: t.ArrayC<t.StringC>;
+        search_fields: t.ArrayC<t.UnionC<[t.StringC, t.TypeC<{
+            key: t.StringC;
+            label: t.StringC;
+        }>]>>;
         auto_execute: t.BooleanC;
@@ -29,2 +32,3 @@ unfurl: t.BooleanC;
         default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+        render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
         showResources: t.BooleanC;
@@ -47,3 +51,4 @@ show_with_no_results: t.BooleanC;
     summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
-    end_user_hotkeys: t.BooleanC;
+    end_user_hotkeys: t.UnionC<[t.UndefinedC, t.BooleanC]>;
+    end_user_shortcuts_enabled: t.BooleanC;
     releases_available: t.BooleanC;
@@ -74,3 +79,6 @@ releases_enabled: t.BooleanC;
         useCategory: t.BooleanC;
-        search_fields: t.ArrayC<t.StringC>;
+        search_fields: t.ArrayC<t.UnionC<[t.StringC, t.TypeC<{
+            key: t.StringC;
+            label: t.StringC;
+        }>]>>;
         auto_execute: t.BooleanC;
@@ -84,2 +92,3 @@ unfurl: t.BooleanC;
         default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+        render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
         showResources: t.BooleanC;
@@ -102,3 +111,4 @@ show_with_no_results: t.BooleanC;
     summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
-    end_user_hotkeys: t.BooleanC;
+    end_user_hotkeys: t.UnionC<[t.UndefinedC, t.BooleanC]>;
+    end_user_shortcuts_enabled: t.BooleanC;
     releases_available: t.BooleanC;
@@ -105,0 +115,0 @@ releases_enabled: t.BooleanC;

build/internal/src/middleware/ResourceSettingsV.d.ts

 import * as t from 'io-ts';
+export declare const SearchFieldConfigV: t.TypeC<{
+    key: t.StringC;
+    label: t.StringC;
+}>;
 export declare const ResourceSettingsV: t.PartialC<{
@@ -7,3 +11,6 @@ name: t.StringC;
     useCategory: t.BooleanC;
-    search_fields: t.ArrayC<t.StringC>;
+    search_fields: t.ArrayC<t.UnionC<[t.StringC, t.TypeC<{
+        key: t.StringC;
+        label: t.StringC;
+    }>]>>;
     auto_execute: t.BooleanC;
@@ -17,2 +24,3 @@ unfurl: t.BooleanC;
     default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
     showResources: t.BooleanC;
@@ -30,3 +38,6 @@ show_with_no_results: t.BooleanC;
     useCategory: t.BooleanC;
-    search_fields: t.ArrayC<t.StringC>;
+    search_fields: t.ArrayC<t.UnionC<[t.StringC, t.TypeC<{
+        key: t.StringC;
+        label: t.StringC;
+    }>]>>;
     auto_execute: t.BooleanC;
@@ -40,2 +51,3 @@ unfurl: t.BooleanC;
     default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
     showResources: t.BooleanC;
@@ -42,0 +54,0 @@ show_with_no_results: t.BooleanC;

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

@@ -5,3 +5,4 @@ /*******************************************************************************/
 import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
-import { TemplateV, TemplateOptionsV } from './helpers/commandTemplate';
+import { OptionGroupRenderAsV } from './helpers/optionGroup';
+import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
 import { CommandCategoryV } from './commandCategory';
@@ -51,2 +52,4 @@ import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationSettingsV } from './organization';
 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>;
@@ -61,2 +64,3 @@ export declare type IEndUserType = t.TypeOf<typeof EndUserV>;
 export declare type IFunctionArgumentType = t.TypeOf<typeof FunctionArgumentV>;
+export declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderAsV>;
 export interface ICommandInput {
@@ -95,2 +99,3 @@ text: string;
 export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
+export type { DetailPreviewObjectType, DetailPreviewType, DataRowMedata } from './detailPreview';
 /*******************************************************************************/
@@ -157,2 +162,31 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         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;
     });
@@ -165,2 +199,9 @@ } & {
     modified?: string | undefined;
+    detail?: string | {
+        type: "html" | "plaintext" | "markdown" | "reader" | "react";
+        value: string;
+    } | {
+        type: "html" | "plaintext" | "markdown" | "reader" | "react";
+        value: string;
+    }[] | undefined;
 } & {
@@ -167,0 +208,0 @@ arguments: {

package.json

 {
   "name": "commandbar",
-  "version": "1.6.8",
+  "version": "1.6.9",
   "description": "Javascript Utility for CommandBar",
@@ -5,0 +5,0 @@ "main": "build/commandbar-js/src/index.js",

src/init.ts

@@ -6,3 +6,3 @@ import 'proxy-polyfill';
 import { _configuration } from '../../internal/src/client/symbols';
-import { IConfigEndpointResponse } from '@commandbar/internal/middleware/types';
+import { IConfigEndpointResponse } from '../../internal/src/middleware/types';
 
@@ -9,0 +9,0 @@ interface IInitOptions {

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

357569

increased by10.6%

Number of package files

58

increased by3.57%

Lines of code

8213

increased by10.57%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes