commandbar 1.6.8 → 1.6.11

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

@@ -1,7 +1,7 @@
 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 {
     debug?: boolean;
     environment?: string;

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

@@ -30,6 +30,10 @@ export interface AddContextOptions {
         quickFind?: boolean;
         /** Turn on unfurling for `key`. */
         unfurl?: boolean;
+        /** Show records by default with no input */
+        showInDefaultEmptyState?: boolean;
+        /** Sort key */
+        categorySortKey?: number;
     };
     /** Options to customize the style of `key` objects. */
     renderOptions?: {
@@ -49,7 +53,10 @@ export interface AddContextOptions {
          * A list of object fields to be searched. If a custom `searchFunction` is provided, matches will be highlighted in
          * these fields. Field names will be transformed from _camelCase_ or _snake_case_ into _Sentence case_.
          */
-        fields?: string[];
+        fields?: (string | {
+            key: string;
+            label: string;
+        })[];
         /**
          * 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.
          *
@@ -81,7 +88,10 @@ export interface ArgumentOptions {
      * A list of object fields to be searched. If a custom `searchFunction` is provided, matches will be highlighted in
      * these fields. Field names will be transformed from _camelCase_ or _snake_case_ into _Sentence case_.
      */
-    searchableFields?: string[];
+    searchableFields?: (string | {
+        key: string;
+        label: string;
+    })[];
     onInputChange?: SearchFunction | SearchFunctionPaginated;
 }
 export interface RecordOptions extends ArgumentOptions {
@@ -90,5 +100,9 @@ export interface RecordOptions extends ArgumentOptions {
         categoryName?: string;
         /** Turn on unfurling for `key`. */
         unfurl?: boolean;
+        /** Show records by default with no input */
+        showInDefaultEmptyState?: boolean;
+        /** Sort key */
+        categorySortKey?: number;
     };
 }

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

@@ -2,7 +2,9 @@ import { AddContextOptions, ArgumentOptions, DataRow, RecordOptions } from './Ad
 import { EventHandler } from './EventHandler';
 import { ICommandFromClientType } from '../middleware/ICommandFromClientType';
 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>;
 export declare type BootOptions = string | (UserAttributes & {
     id: string;
@@ -181,6 +183,14 @@ export declare type CommandBarClientSDK = Readonly<{
      * @param id The command id to execute. For commands defined via the Editor, you can find this id in the Editor by selecting "Copy code" in the command's ellipsis menu. For commands defined via the SDK, this is the `name` field.
      */
     execute(id: number | string): void;
+    /**
+     * 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
      * @param filter A function that filters out commands based on its properties. These are:
@@ -237,7 +247,7 @@ export declare type CommandBarClientSDK = Readonly<{
      * @param slug Component slug
      * @param getHTML Function that returns an html string to be rendered as the component
      */
-    setCustomComponent(slug: 'header' | 'input' | 'sidepanel' | 'footer', getHTML: (step?: 'base' | 'multiselect' | 'longtextinput' | 'textinput' | 'select') => string): void;
+    setCustomComponent(slug: 'header' | 'input' | 'sidepanel' | 'footer' | 'navPaneHeader' | 'navPaneFooter', getHTML: (step?: 'base' | 'multiselect' | 'longtextinput' | 'textinput' | 'select') => string): void;
     /**
      * Similar to `addContext`, but also removes any keys that are omitted from the supplied `ctx` from context. It may be
      * helpful to use this to make large context changes, such as when a user logs out.

package/build/internal/src/client/EventHandler.d.ts

@@ -15,6 +15,8 @@ export interface AbandonedSearchEvent {
         numCommands: number;
         numRecords: number;
     };
+    /** command_ids of previously executed commands in the session */
+    previousCommands?: string[];
 }
 export interface ClosedEvent {
     /** Event data passed for `command_execution` events. */
@@ -38,8 +40,16 @@ export interface CommandExecutionEvent {
     source: string;
     /** DEPRECATED. The text input.*/
     ['inputText[*]']: string;
-    /** The text input. */
-    inputText: string;
+    /** The text input.*/
+    inputText?: string;
+    /** True if this command was triggered by a shortcut. */
+    shortcut?: boolean;
+    /** Ranking order of the command option */
+    ranking?: number;
+    /** command_ids of previously executed commands in the session */
+    previousCommands?: string[];
+    /** Command types, as defined at: https://www.commandbar.com/docs/commands/types/overview */
+    commandType?: 'admin' | 'link' | 'script' | 'clickByXpath' | 'clickBySelector' | 'click' | 'callback' | 'builtin' | 'webhook' | 'request' | 'appcues';
 }
 export interface EndUserShortcutChangedEvent {
     /** Event data passed for `command_execution` events. */

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

@@ -33,6 +33,31 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
         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<"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]>;
     }>]>]>]>;
     text: t.StringC;
 }>, t.PartialC<{
@@ -217,4 +242,11 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
         value: t.StringC;
         reason: t.StringC;
     }>]>]>>;
+    detail: t.UnionC<[t.StringC, t.TypeC<{
+        type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
+        value: t.StringC;
+    }>, t.ArrayC<t.TypeC<{
+        type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
+        value: t.StringC;
+    }>>]>;
 }>]>;

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

@@ -1,3 +1,5 @@
 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>;

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

@@ -16,7 +16,10 @@ declare const OrganizationAdditionalV: t.TypeC<{
         search: t.BooleanC;
         label_field: 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;
         unfurl: t.BooleanC;
         description_field: t.StringC;
@@ -25,12 +28,14 @@ declare const OrganizationAdditionalV: t.TypeC<{
         max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
         sortFunction: t.AnyC;
         default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+        render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
         showResources: t.BooleanC;
         show_with_no_results: t.BooleanC;
         search_tab_enabled: t.BooleanC;
         search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
         search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
         setting_pin_to_bottom: t.BooleanC;
+        track_recents: t.BooleanC;
     }>>;
     should_show_onboarding: t.BooleanC;
     last_snippet_request: t.UnionC<[t.StringC, t.NullC]>;
@@ -42,9 +47,13 @@ declare const OrganizationAdditionalV: t.TypeC<{
     allow_event_handlers: t.BooleanC;
     in_bar_feedback: 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;
+    end_user_recents_enabled: t.BooleanC;
     releases_available: t.BooleanC;
     releases_enabled: t.BooleanC;
+    fallback_commands: t.ArrayC<t.NumberC>;
+    tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
 }>;
 export declare const defaults: t.TypeOf<typeof OrganizationAdditionalV>;
 export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
@@ -68,7 +77,10 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
         search: t.BooleanC;
         label_field: 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;
         unfurl: t.BooleanC;
         description_field: t.StringC;
@@ -77,12 +89,14 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
         max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
         sortFunction: t.AnyC;
         default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+        render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
         showResources: t.BooleanC;
         show_with_no_results: t.BooleanC;
         search_tab_enabled: t.BooleanC;
         search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
         search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
         setting_pin_to_bottom: t.BooleanC;
+        track_recents: t.BooleanC;
     }>>;
     should_show_onboarding: t.BooleanC;
     last_snippet_request: t.UnionC<[t.StringC, t.NullC]>;
@@ -94,9 +108,13 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
     allow_event_handlers: t.BooleanC;
     in_bar_feedback: 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;
+    end_user_recents_enabled: t.BooleanC;
     releases_available: t.BooleanC;
     releases_enabled: t.BooleanC;
+    fallback_commands: t.ArrayC<t.NumberC>;
+    tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
 }>]>;
 export declare type IOrganizationType = t.TypeOf<typeof OrganizationV>;
 export {};

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

@@ -1,10 +1,17 @@
 import * as t from 'io-ts';
+export declare const SearchFieldConfigV: t.TypeC<{
+    key: t.StringC;
+    label: t.StringC;
+}>;
 export declare const ResourceSettingsV: t.PartialC<{
     name: t.StringC;
     search: t.BooleanC;
     label_field: 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;
     unfurl: t.BooleanC;
     description_field: t.StringC;
@@ -13,19 +20,24 @@ export declare const ResourceSettingsV: t.PartialC<{
     max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
     sortFunction: t.AnyC;
     default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
     showResources: t.BooleanC;
     show_with_no_results: t.BooleanC;
     search_tab_enabled: t.BooleanC;
     search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
     search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
     setting_pin_to_bottom: t.BooleanC;
+    track_recents: t.BooleanC;
 }>;
 export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.PartialC<{
     name: t.StringC;
     search: t.BooleanC;
     label_field: 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;
     unfurl: t.BooleanC;
     description_field: t.StringC;
@@ -34,10 +46,12 @@ export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.Parti
     max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
     sortFunction: t.AnyC;
     default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
     showResources: t.BooleanC;
     show_with_no_results: t.BooleanC;
     search_tab_enabled: t.BooleanC;
     search_tab_name: t.UnionC<[t.StringC, t.NullC]>;
     search_tab_instruction: t.UnionC<[t.StringC, t.NullC]>;
     setting_pin_to_bottom: t.BooleanC;
+    track_recents: t.BooleanC;
 }>>;