commandbar 1.6.13 → 1.6.16

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

@@ -76,6 +76,7 @@ export declare class Organization {
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
                 icon?: string | undefined;
+                image?: string | undefined;
                 sort_key?: number | undefined;
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
@@ -90,6 +91,17 @@ export declare class Organization {
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
+                detail?: string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }) | (string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }))[] | null | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -146,6 +158,7 @@ export declare class Organization {
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
                 icon?: string | undefined;
+                image?: string | undefined;
                 sort_key?: number | undefined;
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
@@ -160,6 +173,17 @@ export declare class Organization {
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
+                detail?: string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }) | (string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }))[] | null | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -215,6 +239,7 @@ export declare class Organization {
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
                 icon?: string | undefined;
+                image?: string | undefined;
                 sort_key?: number | undefined;
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
@@ -229,6 +254,17 @@ export declare class Organization {
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
+                detail?: string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }) | (string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }))[] | null | undefined;
             };
         };
         should_show_onboarding: boolean;
@@ -352,6 +388,14 @@ export declare class Organization {
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "helpdoc";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
         });
     } & {
         disabledReason?: string | undefined;
@@ -359,6 +403,7 @@ export declare class Organization {
         name?: string | undefined;
         last_available?: string | null | undefined;
         modified?: string | undefined;
+        isAsync?: boolean | undefined;
     } & {
         arguments: {
             [x: string]: ({
@@ -472,12 +517,13 @@ export declare class Organization {
                 auto_choose?: boolean | undefined;
                 is_private?: boolean | undefined;
             }) | ({
-                type: "video";
+                type: "html" | "video";
                 value: {
                     source: string;
                 } & {
                     title?: string | undefined;
                     description?: string | undefined;
+                    url?: string | undefined;
                 };
                 order_key: number;
             } & {
@@ -507,22 +553,56 @@ export declare class Organization {
             field?: string | undefined;
             value?: string | undefined;
             reason?: string | undefined;
-        })[];
+        })[] | (({
+            type: "url" | "context" | "element";
+            operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
+        } & {
+            field?: string | undefined;
+            value?: string | undefined;
+            reason?: string | undefined;
+        }) | ({
+            type: "named_rule";
+            rule_id: number;
+        } & {
+            reason?: string | undefined;
+        }))[];
         recommend_rules: (({
+            type: "url" | "context" | "element";
+            operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
+        } & {
+            field?: string | undefined;
+            value?: string | undefined;
+            reason?: string | undefined;
+        }) | ({
             type: "always";
         } & {
             operator?: null | undefined;
             field?: null | undefined;
             value?: null | undefined;
             reason?: null | undefined;
-        }) | ({
+        }))[] | (({
             type: "url" | "context" | "element";
             operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
         } & {
             field?: string | undefined;
             value?: string | undefined;
             reason?: string | undefined;
+        }) | ({
+            type: "named_rule";
+            rule_id: number;
+        } & {
+            reason?: string | undefined;
+        }) | ({
+            type: "always";
+        } & {
+            operator?: null | undefined;
+            field?: null | undefined;
+            value?: null | undefined;
+            reason?: null | undefined;
         }))[];
+        availability_expression: import("./helpers/rules").RuleExpression;
+        recommend_expression: import("./helpers/rules").RuleExpression;
+        always_recommend: boolean;
         confirm: string;
         shortcut: string[];
         explanation: string;
@@ -531,6 +611,7 @@ export declare class Organization {
         category: number | null;
         sort_key: number | null;
         icon: string | null;
+        image: string | null;
         celebrate: boolean | {
             angle?: number | undefined;
             spread?: number | undefined;
@@ -551,16 +632,20 @@ export declare class Organization {
         hotkey_mac: string;
         hotkey_win: string;
         detail: string | ({
-            type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+            type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
             value: string;
         } & {
             position?: "inline" | "popover" | undefined;
         }) | (string | ({
-            type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+            type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
             value: string;
         } & {
             position?: "inline" | "popover" | undefined;
         }))[] | null;
+        next_steps: (string | number)[];
+    } & {
+        third_party_source?: string | null | undefined;
+        third_party_id?: string | null | undefined;
     })[]>;
     static listCommandCategories: (orgUID: string) => Promise<({
         id: number;
@@ -569,6 +654,7 @@ export declare class Organization {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        image: string | null;
         render_as: "grid" | "list";
         setting_hide_before_search: boolean;
         setting_max_options_count: number | null;
@@ -604,14 +690,7 @@ export declare class Organization {
     static listRules: (orgUID: string) => Promise<{
         id: number;
         name: string;
-        conditions: ({
-            type: "url" | "context" | "element";
-            operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
-        } & {
-            field?: string | undefined;
-            value?: string | undefined;
-            reason?: string | undefined;
-        })[];
+        expression: import("./helpers/rules").RuleExpression;
     }[]>;
     static userHasAccess: (uuid: string, user: string) => Promise<{
         username: string;
@@ -778,6 +857,7 @@ export declare class Organization {
                 unfurl?: boolean | undefined;
                 description_field?: string | undefined;
                 icon?: string | undefined;
+                image?: string | undefined;
                 sort_key?: number | undefined;
                 max_options_count?: number | null | undefined;
                 sortFunction?: any;
@@ -792,6 +872,17 @@ export declare class Organization {
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
+                detail?: string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }) | (string | ({
+                    type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                    value: string;
+                } & {
+                    position?: "inline" | "popover" | undefined;
+                }))[] | null | undefined;
             };
         };
         should_show_onboarding: boolean;

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

@@ -9,6 +9,15 @@ export declare const SkinV: t.IntersectionC<[t.TypeC<{
 }>, t.PartialC<{
     logo: t.UnionC<[t.StringC, t.NullC]>;
 }>]>;
+export declare const SkinPatchV: t.PartialC<{
+    id: t.StringC;
+    slug: t.StringC;
+    name: t.StringC;
+    default: t.BooleanC;
+    skin: t.AnyC;
+    organization: t.StringC;
+    logo: t.UnionC<[t.StringC, t.NullC]>;
+}>;
 export declare class Skin {
     static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
         id: string;
@@ -52,7 +61,15 @@ export declare class Skin {
     } & {
         logo?: string | null | undefined;
     }>;
-    static create: (object: {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+    static create: (object: {
+        id?: string | undefined;
+        slug?: string | undefined;
+        name?: string | undefined;
+        default?: boolean | undefined;
+        skin?: any;
+        organization?: string | undefined;
+        logo?: string | null | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: string;
         slug: string;
         name: string;

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

@@ -0,0 +1,27 @@
+import * as t from 'io-ts';
+export declare const TabV: t.TypeC<{
+    id: t.NumberC;
+    organization: t.UnionC<[t.NumberC, t.StringC]>;
+    category_ids: t.ArrayC<t.NumberC>;
+    sort_key: t.NumberC;
+    icon: t.UnionC<[t.StringC, t.NullC]>;
+    label: t.StringC;
+    header: t.UnionC<[t.StringC, t.NullC]>;
+    description: t.StringC;
+    placeholder: t.UnionC<[t.StringC, t.NullC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
+}>;
+export declare class Tab {
+    static decode: (data: any) => {
+        id: number;
+        organization: string | number;
+        category_ids: number[];
+        sort_key: number;
+        icon: string | null;
+        label: string;
+        header: string | null;
+        description: string;
+        placeholder: string | null;
+        render_as: "grid" | "list";
+    };
+}

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

@@ -19,6 +19,9 @@ import { ProfileV } from './profile';
 import { PlaceholderV } from './placeholder';
 import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
 import { EnvironmentV } from './environment';
+import { NudgeV } from './nudge';
+import { TabV } from './tab';
+import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
 /*******************************************************************************/
 export declare type IContextType = t.TypeOf<typeof ContextV>;
 export declare type IUserType = t.TypeOf<typeof UserV>;
@@ -40,6 +43,7 @@ export declare type ISkinType = t.TypeOf<typeof SkinV>;
 export declare type IProfileType = t.TypeOf<typeof ProfileV>;
 export declare type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV>;
 export declare type IPlaceholderType = t.TypeOf<typeof PlaceholderV>;
+export declare type ITabType = t.TypeOf<typeof TabV>;
 export declare type IEnvironmentType = t.TypeOf<typeof EnvironmentV>;
 export declare type IReleaseStep = t.TypeOf<typeof ReleaseStepV>;
 export declare type IRelease = t.TypeOf<typeof ReleaseV>;
@@ -58,6 +62,9 @@ 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 IRuleExpression = t.TypeOf<typeof RuleExpressionV>;
+export declare type IRuleExpressionAnd = t.TypeOf<typeof RuleExpressionAndV>;
+export declare type IRuleExpressionOr = t.TypeOf<typeof RuleExpressionOrV>;
 export declare type IConditionType = t.TypeOf<typeof ConditionV>;
 export declare type IConditionOperatorType = t.TypeOf<typeof ConditionOperatorV>;
 export declare type IContextArgumentType = t.TypeOf<typeof ContextArgumentV>;
@@ -66,6 +73,12 @@ 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 declare type INudgeType = t.TypeOf<typeof NudgeV>;
+export interface INudgeClientType {
+    nudge: INudgeType;
+    active: boolean;
+    lastTriggeredTs?: number;
+}
 export interface ICommandInput {
     text: string;
     command: ICommandType;
@@ -82,7 +95,7 @@ export interface IUserContext {
     [variable: string]: any;
 }
 export interface ICallbackMap {
-    [variable: string]: (...args: any[]) => any;
+    [variable: string]: (...args: any[]) => unknown;
 }
 export interface IResourceType extends IUserContext {
     _cbLinkedCommmands: Array<{
@@ -96,10 +109,12 @@ export declare type IConfigEndpointResponse = {
     organization: any;
     environments_with_versions?: any[];
     placeholders?: any[];
+    nudges?: INudgeType[];
+    tabs?: ITabType[];
 };
 export type { IResourceSettings } from './IResourceSettings';
 export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
-export type { DetailPreviewObjectType, DetailPreviewType, DataRowMedata } from './detailPreview';
+export type { DetailPreviewObjectType, DetailPreviewType, DataRowMetadata } from './detailPreview';
 /*******************************************************************************/
 export declare const isCommand: (command?: ICommandType | any) => command is {
     id: number;
@@ -198,6 +213,14 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
+    }) | ({
+        type: "helpdoc";
+        value: string;
+    } & {} & {
+        commandType?: "object" | "independent" | "help" | undefined;
+        object?: string | undefined;
+        hoverTooltip?: boolean | undefined;
+        operation?: "self" | "router" | "blank" | undefined;
     });
 } & {
     disabledReason?: string | undefined;
@@ -205,6 +228,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
     name?: string | undefined;
     last_available?: string | null | undefined;
     modified?: string | undefined;
+    isAsync?: boolean | undefined;
 } & {
     arguments: {
         [x: string]: ({
@@ -318,12 +342,13 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             auto_choose?: boolean | undefined;
             is_private?: boolean | undefined;
         }) | ({
-            type: "video";
+            type: "html" | "video";
             value: {
                 source: string;
             } & {
                 title?: string | undefined;
                 description?: string | undefined;
+                url?: string | undefined;
             };
             order_key: number;
         } & {
@@ -355,20 +380,23 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         reason?: string | undefined;
     })[];
     recommend_rules: (({
-        type: "always";
-    } & {
-        operator?: null | undefined;
-        field?: null | undefined;
-        value?: null | undefined;
-        reason?: null | undefined;
-    }) | ({
         type: "url" | "context" | "element";
         operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
     } & {
         field?: string | undefined;
         value?: string | undefined;
         reason?: string | undefined;
+    }) | ({
+        type: "always";
+    } & {
+        operator?: null | undefined;
+        field?: null | undefined;
+        value?: null | undefined;
+        reason?: null | undefined;
     }))[];
+    availability_expression: import("./helpers/rules").RuleExpression | null;
+    recommend_expression: import("./helpers/rules").RuleExpression | null;
+    always_recommend: boolean;
     confirm: string;
     shortcut: string[];
     explanation: string;
@@ -377,6 +405,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
     category: number | null;
     sort_key: number | null;
     icon: string | null;
+    image: string | null;
     celebrate: boolean | {
         angle?: number | undefined;
         spread?: number | undefined;
@@ -397,16 +426,20 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
     hotkey_mac: string;
     hotkey_win: string;
     detail: string | ({
-        type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+        type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
         value: string;
     } & {
         position?: "inline" | "popover" | undefined;
     }) | (string | ({
-        type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+        type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
         value: string;
     } & {
         position?: "inline" | "popover" | undefined;
     }))[] | null;
+    next_steps: (string | number)[];
+} & {
+    third_party_source?: string | null | undefined;
+    third_party_id?: string | null | undefined;
 };
 export declare const isResource: (option: any) => option is IResourceType;
 export declare const isContextArgument: (argument: IArgumentType) => argument is {

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

@@ -10,5 +10,5 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
     has_updated_password: t.BooleanC;
     is_active: t.BooleanC;
 }>, t.PartialC<{
-    intercom_hash: t.StringC;
+    atlas_hash: t.StringC;
 }>]>;

package/package.json

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