commandbar - npm Package Compare versions

Comparing version 1.6.9 to 1.6.10

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

@@ -250,3 +250,3 @@ import { AddContextOptions, ArgumentOptions, DataRow, RecordOptions } from './AddContextOptions';
      */
-    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;
     /**
@@ -253,0 +253,0 @@ * Similar to `addContext`, but also removes any keys that are omitted from the supplied `ctx` from context. It may be

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

@@ -18,2 +18,4 @@ export interface AbandonedSearchEvent {
     };
+    /** command_ids of previously executed commands in the session */
+    previousCommands?: string[];
 }
@@ -42,4 +44,12 @@ export interface ClosedEvent {
     ['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';
 }
@@ -46,0 +56,0 @@ export interface EndUserShortcutChangedEvent {

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

 /*******************************************************************************/
 import * as t from 'io-ts';
+import { GenericBatchRequest } from './generics';
 export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
@@ -17,3 +18,22 @@ id: t.NumberC;
     search_tab_instruction: t.StringC;
+    track_recents: t.BooleanC;
 }>]>;
+export declare const BatchEditorCategoryResponseV: t.TypeC<{
+    batch: t.ArrayC<t.IntersectionC<[t.IntersectionC<[t.TypeC<{
+        id: t.NumberC;
+        organization: t.UnionC<[t.NumberC, t.StringC]>;
+        name: t.StringC;
+    }>, t.PartialC<{}>]>, t.TypeC<{
+        sort_key: t.UnionC<[t.NumberC, t.NullC]>;
+        icon: t.UnionC<[t.StringC, t.NullC]>;
+        render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
+        setting_hide_before_search: t.BooleanC;
+        setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
+        setting_pin_to_bottom: t.BooleanC;
+        search_tab_enabled: t.BooleanC;
+        search_tab_name: t.StringC;
+        search_tab_instruction: t.StringC;
+        track_recents: t.BooleanC;
+    }>]>>;
+}>;
 export declare class CommandCategory {
@@ -34,2 +54,3 @@ static create: (object: {
         search_tab_instruction: string;
+        track_recents: boolean;
     }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
@@ -49,2 +70,3 @@ id: number;
         search_tab_instruction: string;
+        track_recents: boolean;
     }>;
@@ -65,2 +87,3 @@ static update: (object: {
         search_tab_instruction: string;
+        track_recents: boolean;
     }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
@@ -80,2 +103,3 @@ id: number;
         search_tab_instruction: string;
+        track_recents: boolean;
     }>;
@@ -97,3 +121,22 @@ static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
         search_tab_instruction: string;
+        track_recents: boolean;
     };
+    static batch: (request: t.TypeOf<typeof GenericBatchRequest>) => Promise<{
+        batch: ({
+            id: number;
+            organization: string | number;
+            name: string;
+        } & {} & {
+            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;
+        })[];
+    }>;
 }

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

@@ -246,8 +246,8 @@ import * as t from 'io-ts';
     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">]>;
+        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<"reader">, t.LiteralC<"react">]>;
+        type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
         value: t.StringC;
     }>>]>;
 }>]>;

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

 /*******************************************************************************/
 import * as t from 'io-ts';
 export declare const DetailPreviewObjectV: t.TypeC<{
-    type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"reader">, t.LiteralC<"react">]>;
+    type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
     value: t.StringC;
@@ -17,2 +17,6 @@ }>;
 export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
-export declare const standardize: (item: undefined | null | DetailPreviewType) => undefined | DetailPreviewObjectType[];
+export declare const standardize: (item: undefined | null | DetailPreviewType) => null | DetailPreviewObjectType[];
+export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType | {
+    type: null;
+    value: null;
+};

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

@@ -8,2 +8,6 @@ import * as t from 'io-ts';
 export declare type GenericObjectType = t.TypeOf<typeof GenericObject>;
+export declare const GenericBatchRequest: t.TypeC<{
+    batch: t.ArrayC<t.UnknownC>;
+    note: t.StringC;
+}>;
 declare function createObject<T, Q, O, I>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
@@ -10,0 +14,0 @@ declare function readObject<T, O, I>(arg: t.Type<T, O, I>, url: string): (arg0: string, params?: Record<string, string>, callbacks?: {

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

@@ -35,2 +35,4 @@ import * as t from 'io-ts';
     end_user_shortcuts_enabled: t.BooleanC;
+    fallback_commands: t.ArrayC<t.NumberC>;
+    end_user_recents_enabled: t.BooleanC;
 }>;
@@ -82,2 +84,3 @@ export declare class Organization {
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
@@ -97,4 +100,7 @@ };
         end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     }>;
@@ -142,2 +148,3 @@ static update: (object: {
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
@@ -157,4 +164,7 @@ };
         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<{
@@ -201,2 +211,3 @@ id: string | number;
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
@@ -216,4 +227,7 @@ };
         end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     }>;
@@ -249,3 +263,3 @@ static listCommands: (orgUID: string) => Promise<({
         }) | ({
-            type: "click" | "clickBySelector" | "clickByXpath";
+            type: "click" | "clickByXpath" | "clickBySelector";
             value: string[];
@@ -317,9 +331,2 @@ } & {} & {
         modified?: string | undefined;
-        detail?: string | {
-            type: "html" | "plaintext" | "markdown" | "reader" | "react";
-            value: string;
-        } | {
-            type: "html" | "plaintext" | "markdown" | "reader" | "react";
-            value: string;
-        }[] | undefined;
     } & {
@@ -479,2 +486,9 @@ arguments: {
         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;
     })[]>;
@@ -495,2 +509,3 @@ static listCommandCategories: (orgUID: string) => Promise<({
         search_tab_instruction: string;
+        track_recents: boolean;
     })[]>;
@@ -597,2 +612,4 @@ static listGuides: (orgUID: string) => Promise<({
         end_user_shortcuts_enabled: boolean;
+        fallback_commands: number[];
+        end_user_recents_enabled: boolean;
     }>;
@@ -617,2 +634,4 @@ static updateSetting: (object: {
         end_user_shortcuts_enabled?: boolean | undefined;
+        fallback_commands?: number[] | undefined;
+        end_user_recents_enabled?: boolean | undefined;
     }, params?: Record<string, string> | undefined, callbacks?: {
@@ -639,2 +658,4 @@ onSuccess?: (() => void) | undefined;
         end_user_shortcuts_enabled: boolean;
+        fallback_commands: number[];
+        end_user_recents_enabled: boolean;
     }>;
@@ -682,2 +703,3 @@ static decode: (data: any) => {
                 setting_pin_to_bottom?: boolean | undefined;
+                track_recents?: boolean | undefined;
             };
@@ -697,5 +719,8 @@ };
         end_user_shortcuts_enabled: boolean;
+        end_user_recents_enabled: boolean;
         releases_available: boolean;
         releases_enabled: boolean;
+        fallback_commands: number[];
+        tab_direction: "horizontal" | "vertical";
     };
 }

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

@@ -38,2 +38,3 @@ import * as t from 'io-ts';
         setting_pin_to_bottom: t.BooleanC;
+        track_recents: t.BooleanC;
     }>>;
@@ -52,4 +53,7 @@ should_show_onboarding: 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">]>;
 }>;
@@ -97,2 +101,3 @@ export declare const defaults: t.TypeOf<typeof OrganizationAdditionalV>;
         setting_pin_to_bottom: t.BooleanC;
+        track_recents: t.BooleanC;
     }>>;
@@ -111,6 +116,9 @@ should_show_onboarding: 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 {};

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

@@ -30,2 +30,3 @@ import * as t from 'io-ts';
     setting_pin_to_bottom: t.BooleanC;
+    track_recents: t.BooleanC;
 }>;
@@ -56,2 +57,3 @@ export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.PartialC<{
     setting_pin_to_bottom: t.BooleanC;
+    track_recents: t.BooleanC;
 }>>;

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

 /*******************************************************************************/
 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 { GenericBatchRequest } from './generics';
 import { OptionGroupRenderAsV } from './helpers/optionGroup';
@@ -13,2 +14,4 @@ import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
 import { HistoryEventV } from './historyEvent';
+import { HelpDocsSyncV } from './helpDocsSync';
+import { HelpDocsIntegrationV } from './helpDocsIntegration';
 import { EndUserV } from './helpers/endUser';
@@ -25,2 +28,3 @@ import { SkinV } from './skin';
 export declare type IEditorCommandType = t.TypeOf<typeof EditorCommandV>;
+export declare type IHelpSyncCommandType = t.TypeOf<typeof HelpSyncCommandV>;
 export type { ICommandFromClientType } from './ICommandFromClientType';
@@ -32,2 +36,4 @@ export declare type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV>;
 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';
@@ -46,3 +52,3 @@ export declare type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV>;
 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>;
@@ -131,3 +137,3 @@ /*******************************************************************************/
     }) | ({
-        type: "click" | "clickBySelector" | "clickByXpath";
+        type: "click" | "clickByXpath" | "clickBySelector";
         value: string[];
@@ -199,9 +205,2 @@ } & {} & {
     modified?: string | undefined;
-    detail?: string | {
-        type: "html" | "plaintext" | "markdown" | "reader" | "react";
-        value: string;
-    } | {
-        type: "html" | "plaintext" | "markdown" | "reader" | "react";
-        value: string;
-    }[] | undefined;
 } & {
@@ -361,2 +360,9 @@ arguments: {
     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;
 };
@@ -363,0 +369,0 @@ export declare const isResource: (option: any) => option is IResourceType;

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

422158

increased by18.06%

Number of package files

60

increased by3.45%

Lines of code

9787

increased by19.16%

No dependency changes