npm - commandbar - Versions diffs - 1.6.11 → 1.6.14 - Mend

commandbar 1.6.11 → 1.6.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

package/build/internal/src/middleware/nudge.d.ts ADDED Viewed

@@ -0,0 +1,189 @@
+import * as t from 'io-ts';
+export declare const NudgeV: t.IntersectionC<[t.TypeC<{
+    id: t.NumberC;
+    organization: t.StringC;
+    slug: t.StringC;
+    content: t.StringC;
+    show_expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
+    trigger: t.UnionC<[t.TypeC<{
+        type: t.LiteralC<"when_conditions_pass">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"on_command_execution">;
+        meta: t.TypeC<{
+            command: t.StringC;
+        }>;
+    }>]>;
+    on_select: t.TypeC<{
+        type: t.LiteralC<"execute_command">;
+        meta: t.TypeC<{
+            command: t.StringC;
+        }>;
+    }>;
+    timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
+    frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">]>;
+}>, t.PartialC<{}>]>;
+export declare class Nudge {
+    static decode: (data: any) => {
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {};
+    static create: (object: {
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {}>;
+    static update: (object: {
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {}>;
+    static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {})[]>;
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        content: string;
+        show_expression: import("./helpers/rules").RuleExpression;
+        trigger: {
+            type: "when_conditions_pass";
+        } | {
+            type: "on_command_execution";
+            meta: {
+                command: string;
+            };
+        };
+        on_select: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        };
+        timeout_ms: number | null;
+        frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
+    } & {}>;
+}

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

@@ -34,6 +34,13 @@ export declare const OrganizationSettingsV: t.TypeC<{
     end_user_shortcuts_enabled: t.BooleanC;
     fallback_commands: t.ArrayC<t.NumberC>;
     end_user_recents_enabled: t.BooleanC;
+    tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
+    recommended_tab_enabled: t.BooleanC;
+    recents_tab_enabled: t.BooleanC;
+    recommended_tab_instruction: t.StringC;
+    recents_tab_instruction: t.StringC;
+    hotload_help_docs: t.BooleanC;
+    slash_filters_enabled: t.BooleanC;
 }>;
 export declare class Organization {
     static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -78,6 +85,8 @@ export declare class Organization {
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
+                slash_filter_enabled?: boolean | undefined;
+                slash_filter_keyword?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
@@ -100,6 +109,12 @@ export declare class Organization {
         releases_enabled: boolean;
         fallback_commands: number[];
         tab_direction: "horizontal" | "vertical";
+        recommended_tab_enabled: boolean;
+        recents_tab_enabled: boolean;
+        recommended_tab_instruction: string;
+        recents_tab_instruction: string;
+        hotload_help_docs: boolean;
+        slash_filters_enabled: boolean;
     }>;
     static update: (object: {
         id: string | number;
@@ -140,6 +155,8 @@ export declare class Organization {
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
+                slash_filter_enabled?: boolean | undefined;
+                slash_filter_keyword?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
@@ -162,6 +179,12 @@ export declare class Organization {
         releases_enabled: boolean;
         fallback_commands: number[];
         tab_direction: "horizontal" | "vertical";
+        recommended_tab_enabled: boolean;
+        recents_tab_enabled: boolean;
+        recommended_tab_instruction: string;
+        recents_tab_instruction: string;
+        hotload_help_docs: boolean;
+        slash_filters_enabled: boolean;
     }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: string | number;
         name: string;
@@ -201,6 +224,8 @@ export declare class Organization {
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
+                slash_filter_enabled?: boolean | undefined;
+                slash_filter_keyword?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
@@ -223,6 +248,12 @@ export declare class Organization {
         releases_enabled: boolean;
         fallback_commands: number[];
         tab_direction: "horizontal" | "vertical";
+        recommended_tab_enabled: boolean;
+        recents_tab_enabled: boolean;
+        recommended_tab_instruction: string;
+        recents_tab_instruction: string;
+        hotload_help_docs: boolean;
+        slash_filters_enabled: boolean;
     }>;
     static listCommands: (orgUID: string) => Promise<({
         id: number;
@@ -313,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;
@@ -343,6 +390,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[] | {
@@ -364,6 +413,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";
@@ -384,6 +435,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;
@@ -403,6 +456,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;
@@ -422,6 +477,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[];
@@ -432,25 +516,60 @@ 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;
+        heading: string;
         is_live: boolean;
         category: number | null;
         sort_key: number | null;
@@ -474,13 +593,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;
@@ -495,6 +622,8 @@ export declare class Organization {
         setting_pin_to_bottom: boolean;
         search_tab_enabled: boolean;
         search_tab_name: string;
+        slash_filter_enabled: boolean;
+        slash_filter_keyword: string | null;
         search_tab_instruction: string;
         track_recents: boolean;
     })[]>;
@@ -522,14 +651,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;
@@ -600,6 +722,13 @@ export declare class Organization {
         end_user_shortcuts_enabled: boolean;
         fallback_commands: number[];
         end_user_recents_enabled: boolean;
+        tab_direction: "horizontal" | "vertical";
+        recommended_tab_enabled: boolean;
+        recents_tab_enabled: boolean;
+        recommended_tab_instruction: string;
+        recents_tab_instruction: string;
+        hotload_help_docs: boolean;
+        slash_filters_enabled: boolean;
     }>;
     static updateSetting: (object: {
         end_user_limit?: number | undefined;
@@ -621,6 +750,13 @@ export declare class Organization {
         end_user_shortcuts_enabled?: boolean | undefined;
         fallback_commands?: number[] | undefined;
         end_user_recents_enabled?: boolean | undefined;
+        tab_direction?: "horizontal" | "vertical" | undefined;
+        recommended_tab_enabled?: boolean | undefined;
+        recents_tab_enabled?: boolean | undefined;
+        recommended_tab_instruction?: string | undefined;
+        recents_tab_instruction?: string | undefined;
+        hotload_help_docs?: boolean | undefined;
+        slash_filters_enabled?: boolean | undefined;
     }, params?: Record<string, string> | undefined, callbacks?: {
         onSuccess?: (() => void) | undefined;
         onError?: ((err: string) => void) | undefined;
@@ -644,6 +780,13 @@ export declare class Organization {
         end_user_shortcuts_enabled: boolean;
         fallback_commands: number[];
         end_user_recents_enabled: boolean;
+        tab_direction: "horizontal" | "vertical";
+        recommended_tab_enabled: boolean;
+        recents_tab_enabled: boolean;
+        recommended_tab_instruction: string;
+        recents_tab_instruction: string;
+        hotload_help_docs: boolean;
+        slash_filters_enabled: boolean;
     }>;
     static decode: (data: any) => {
         id: string | number;
@@ -684,6 +827,8 @@ export declare class Organization {
                 show_with_no_results?: boolean | undefined;
                 search_tab_enabled?: boolean | undefined;
                 search_tab_name?: string | null | undefined;
+                slash_filter_enabled?: boolean | undefined;
+                slash_filter_keyword?: string | null | undefined;
                 search_tab_instruction?: string | null | undefined;
                 setting_pin_to_bottom?: boolean | undefined;
                 track_recents?: boolean | undefined;
@@ -706,5 +851,11 @@ export declare class Organization {
         releases_enabled: boolean;
         fallback_commands: number[];
         tab_direction: "horizontal" | "vertical";
+        recommended_tab_enabled: boolean;
+        recents_tab_enabled: boolean;
+        recommended_tab_instruction: string;
+        recents_tab_instruction: string;
+        hotload_help_docs: boolean;
+        slash_filters_enabled: boolean;
     };
 }

package/build/internal/src/middleware/releases.d.ts CHANGED Viewed

@@ -224,7 +224,7 @@ export declare class Releases {
             tags: string[];
         };
     }>;
-    static readDiff: (fromId: string, toId: string) => Promise<any>;
+    static readDiff: (fromId: string, toId: string) => Promise<unknown>;
     static promoteReleaseStep: (releaseStepId: number) => Promise<any>;
     static promoteReleaseToFirstEnv: (releaseId: number) => Promise<{
         created_by: string;