commandbar 1.6.12 → 1.6.15

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

@@ -344,6 +344,22 @@ export declare class Organization {
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "video";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            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;
@@ -351,6 +367,7 @@ export declare class Organization {
         name?: string | undefined;
         last_available?: string | null | undefined;
         modified?: string | undefined;
+        isAsync?: boolean | undefined;
     } & {
         arguments: {
             [x: string]: ({
@@ -374,6 +391,8 @@ export declare class Organization {
                 allow_create_label?: string | undefined;
                 show_in_record_action_list?: boolean | undefined;
                 show_in_default_list?: boolean | undefined;
+                auto_choose?: boolean | undefined;
+                is_private?: boolean | undefined;
             }) | ({
                 type: "set";
                 value: string[] | number[] | {
@@ -395,6 +414,8 @@ export declare class Organization {
                 loaded?: any[] | undefined;
                 allow_create?: boolean | undefined;
                 allow_create_label?: string | undefined;
+                auto_choose?: boolean | undefined;
+                is_private?: boolean | undefined;
             }) | ({
                 type: "provided";
                 value: "time" | "text";
@@ -415,6 +436,8 @@ export declare class Organization {
                 dateTimeArgumentTypeId?: number | undefined;
                 allow_create?: boolean | undefined;
                 allow_create_label?: string | undefined;
+                auto_choose?: boolean | undefined;
+                is_private?: boolean | undefined;
             }) | ({
                 type: "dependent";
                 value: string;
@@ -434,6 +457,8 @@ export declare class Organization {
                 loaded?: any[] | undefined;
                 allow_create?: boolean | undefined;
                 allow_create_label?: string | undefined;
+                auto_choose?: boolean | undefined;
+                is_private?: boolean | undefined;
             }) | ({
                 type: "function";
                 value: string;
@@ -453,6 +478,35 @@ export declare class Organization {
                 loaded?: any[] | undefined;
                 allow_create?: boolean | undefined;
                 allow_create_label?: string | undefined;
+                auto_choose?: boolean | undefined;
+                is_private?: boolean | undefined;
+            }) | ({
+                type: "html" | "video";
+                value: {
+                    source: string;
+                } & {
+                    title?: string | undefined;
+                    description?: string | undefined;
+                    url?: string | undefined;
+                };
+                order_key: number;
+            } & {
+                label?: string | undefined;
+                chosen?: string | number | undefined;
+                selected?: any[] | undefined;
+                input_type?: string | undefined;
+                preselected_key?: string | undefined;
+                label_field?: string | undefined;
+                availability_condition?: {
+                    field: string;
+                    operator: "==" | "!=" | "isTruthy" | "isFalsy";
+                    value: string | undefined;
+                }[] | undefined;
+                loaded?: any[] | undefined;
+                allow_create?: boolean | undefined;
+                allow_create_label?: string | undefined;
+                is_private?: boolean | undefined;
+                auto_choose?: boolean | undefined;
             });
         };
         tags: string[];
@@ -463,22 +517,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;
@@ -506,13 +594,21 @@ export declare class Organization {
         shortcut_win: string[];
         hotkey_mac: string;
         hotkey_win: string;
-        detail: string | {
+        detail: string | ({
             type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
             value: string;
-        } | (string | {
+        } & {
+            position?: "inline" | "popover" | undefined;
+        }) | (string | ({
             type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
             value: string;
-        })[] | null;
+        } & {
+            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;
@@ -556,14 +652,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;

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/types.d.ts

@@ -19,6 +19,8 @@ import { ProfileV } from './profile';
 import { PlaceholderV } from './placeholder';
 import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
 import { EnvironmentV } from './environment';
+import { NudgeV } from './nudge';
+import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
 /*******************************************************************************/
 export declare type IContextType = t.TypeOf<typeof ContextV>;
 export declare type IUserType = t.TypeOf<typeof UserV>;
@@ -58,6 +60,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 +71,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;
@@ -96,6 +107,7 @@ export declare type IConfigEndpointResponse = {
     organization: any;
     environments_with_versions?: any[];
     placeholders?: any[];
+    nudges?: INudgeType[];
 };
 export type { IResourceSettings } from './IResourceSettings';
 export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
@@ -190,6 +202,22 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
+    }) | ({
+        type: "video";
+        value: string;
+    } & {} & {
+        commandType?: "object" | "independent" | "help" | undefined;
+        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;
@@ -197,6 +225,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]: ({
@@ -220,6 +249,8 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             allow_create_label?: string | undefined;
             show_in_record_action_list?: boolean | undefined;
             show_in_default_list?: boolean | undefined;
+            auto_choose?: boolean | undefined;
+            is_private?: boolean | undefined;
         }) | ({
             type: "set";
             value: string[] | number[] | {
@@ -241,6 +272,8 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             loaded?: any[] | undefined;
             allow_create?: boolean | undefined;
             allow_create_label?: string | undefined;
+            auto_choose?: boolean | undefined;
+            is_private?: boolean | undefined;
         }) | ({
             type: "provided";
             value: "time" | "text";
@@ -261,6 +294,8 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             dateTimeArgumentTypeId?: number | undefined;
             allow_create?: boolean | undefined;
             allow_create_label?: string | undefined;
+            auto_choose?: boolean | undefined;
+            is_private?: boolean | undefined;
         }) | ({
             type: "dependent";
             value: string;
@@ -280,6 +315,8 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             loaded?: any[] | undefined;
             allow_create?: boolean | undefined;
             allow_create_label?: string | undefined;
+            auto_choose?: boolean | undefined;
+            is_private?: boolean | undefined;
         }) | ({
             type: "function";
             value: string;
@@ -299,6 +336,35 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             loaded?: any[] | undefined;
             allow_create?: boolean | undefined;
             allow_create_label?: string | undefined;
+            auto_choose?: boolean | undefined;
+            is_private?: boolean | undefined;
+        }) | ({
+            type: "html" | "video";
+            value: {
+                source: string;
+            } & {
+                title?: string | undefined;
+                description?: string | undefined;
+                url?: string | undefined;
+            };
+            order_key: number;
+        } & {
+            label?: string | undefined;
+            chosen?: string | number | undefined;
+            selected?: any[] | undefined;
+            input_type?: string | undefined;
+            preselected_key?: string | undefined;
+            label_field?: string | undefined;
+            availability_condition?: {
+                field: string;
+                operator: "==" | "!=" | "isTruthy" | "isFalsy";
+                value: string | undefined;
+            }[] | undefined;
+            loaded?: any[] | undefined;
+            allow_create?: boolean | undefined;
+            allow_create_label?: string | undefined;
+            is_private?: boolean | undefined;
+            auto_choose?: boolean | undefined;
         });
     };
     tags: string[];
@@ -311,20 +377,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;
@@ -352,13 +421,18 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
     shortcut_win: string[];
     hotkey_mac: string;
     hotkey_win: string;
-    detail: string | {
+    detail: string | ({
         type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
         value: string;
-    } | (string | {
+    } & {
+        position?: "inline" | "popover" | undefined;
+    }) | (string | ({
         type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
         value: string;
-    })[] | null;
+    } & {
+        position?: "inline" | "popover" | undefined;
+    }))[] | null;
+    next_steps: (string | number)[];
 };
 export declare const isResource: (option: any) => option is IResourceType;
 export declare const isContextArgument: (argument: IArgumentType) => argument is {
@@ -382,6 +456,8 @@ export declare const isContextArgument: (argument: IArgumentType) => argument is
     allow_create_label?: string | undefined;
     show_in_record_action_list?: boolean | undefined;
     show_in_default_list?: boolean | undefined;
+    auto_choose?: boolean | undefined;
+    is_private?: boolean | undefined;
 };
 export declare const isTimeArgument: (argument: IArgumentType) => argument is {
     type: "provided";
@@ -403,6 +479,8 @@ export declare const isTimeArgument: (argument: IArgumentType) => argument is {
     dateTimeArgumentTypeId?: number | undefined;
     allow_create?: boolean | undefined;
     allow_create_label?: string | undefined;
+    auto_choose?: boolean | undefined;
+    is_private?: boolean | undefined;
 };
 export declare const isFunctionArgument: (argument: IArgumentType) => argument is {
     type: "function";
@@ -423,4 +501,6 @@ export declare const isFunctionArgument: (argument: IArgumentType) => argument i
     loaded?: any[] | undefined;
     allow_create?: boolean | undefined;
     allow_create_label?: string | undefined;
+    auto_choose?: boolean | undefined;
+    is_private?: boolean | undefined;
 };

package/package.json

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