commandbar 1.6.4 → 1.6.5-alpha.1

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

@@ -0,0 +1,589 @@
+import * as t from 'io-ts';
+export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
+export { OrganizationV } from './OrganizationV';
+export declare const OrganizationStatusV: t.TypeC<{
+    id: t.UnionC<[t.NumberC, t.StringC]>;
+    uuid: t.StringC;
+    errors_72h: t.NumberC;
+    suggestions_72h: t.NumberC;
+    executions_total: t.NumberC;
+    users_total: t.NumberC;
+}>;
+export declare const KeyEventV: t.UnionC<[t.LiteralC<"Client-Error">, t.LiteralC<"Command execution">, t.LiteralC<"Command suggestion">, t.LiteralC<"Abandoned search">, t.LiteralC<"Search miss">]>;
+export declare const InternalSettingsV: t.TypeC<{
+    id: t.StringC;
+    integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.StringC>>;
+}>;
+export declare const OrganizationSettingsV: t.TypeC<{
+    analytics: t.TypeC<{
+        execution_limit: t.NumberC;
+        deadend_limit: t.NumberC;
+    }>;
+    analytics_control: t.TypeC<{
+        silent_enabled: t.BooleanC;
+        allow_event_handlers: t.BooleanC;
+    }>;
+    skins: t.TypeC<{
+        limit: t.NumberC;
+        field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">]>;
+    }>;
+    deployment: t.TypeC<{
+        show_countdown_banner: t.BooleanC;
+    }>;
+    view: t.TypeC<{
+        in_bar_feedback: t.BooleanC;
+    }>;
+    end_user_limit: t.NumberC;
+    user_seat_limit: t.NumberC;
+    releases: t.TypeC<{
+        available: t.BooleanC;
+        environments: t.ArrayC<t.StringC>;
+    }>;
+}>;
+export declare class Organization {
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: string | number;
+        name: string;
+        created: string;
+    } & {} & {
+        launcher_type: "alternate" | "none" | "prompt" | "minimal";
+        launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
+        show_launcher_recommendations: boolean;
+        recommendations_type: "None" | "Custom" | "Algorithm";
+        launcher_offset_x: number;
+        launcher_offset_y: number;
+        theme: object;
+        icon: string;
+        icon_suggest: string;
+        icon_tutorial: string;
+        icon_go_forward: string;
+        resource_options: {
+            [x: string]: {
+                name?: string | undefined;
+                search?: boolean | undefined;
+                label_field?: string | undefined;
+                useCategory?: boolean | undefined;
+                search_fields?: string[] | undefined;
+                auto_execute?: boolean | undefined;
+                unfurl?: boolean | undefined;
+                description_field?: string | undefined;
+                icon?: string | undefined;
+                sort_key?: number | undefined;
+                max_options_count?: number | null | undefined;
+                sortFunction?: any;
+                default_command_id?: number | undefined;
+                showResources?: boolean | undefined;
+                show_with_no_results?: boolean | undefined;
+                search_tab_enabled?: boolean | undefined;
+                search_tab_name?: string | null | undefined;
+                search_tab_instruction?: string | null | undefined;
+                setting_pin_to_bottom?: boolean | undefined;
+            };
+        };
+        should_show_onboarding: boolean;
+        last_snippet_request: string | null;
+        last_snippet_request_in_production: string | null;
+        branding: string;
+        custom_call_to_action: string;
+        search_fuzzy_threshold: number | null;
+        show_skin_editor: boolean;
+        allow_event_handlers: boolean;
+        in_bar_feedback: boolean;
+        summon_hotkey_override: string | null;
+        end_user_hotkeys: boolean;
+        releases_available: boolean;
+        releases_enabled: boolean;
+    }>;
+    static update: (object: {
+        id: string | number;
+        name: string;
+        created: string;
+    } & {} & {
+        launcher_type: "alternate" | "none" | "prompt" | "minimal";
+        launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
+        show_launcher_recommendations: boolean;
+        recommendations_type: "None" | "Custom" | "Algorithm";
+        launcher_offset_x: number;
+        launcher_offset_y: number;
+        theme: object;
+        icon: string;
+        icon_suggest: string;
+        icon_tutorial: string;
+        icon_go_forward: string;
+        resource_options: {
+            [x: string]: {
+                name?: string | undefined;
+                search?: boolean | undefined;
+                label_field?: string | undefined;
+                useCategory?: boolean | undefined;
+                search_fields?: string[] | undefined;
+                auto_execute?: boolean | undefined;
+                unfurl?: boolean | undefined;
+                description_field?: string | undefined;
+                icon?: string | undefined;
+                sort_key?: number | undefined;
+                max_options_count?: number | null | undefined;
+                sortFunction?: any;
+                default_command_id?: number | undefined;
+                showResources?: boolean | undefined;
+                show_with_no_results?: boolean | undefined;
+                search_tab_enabled?: boolean | undefined;
+                search_tab_name?: string | null | undefined;
+                search_tab_instruction?: string | null | undefined;
+                setting_pin_to_bottom?: boolean | undefined;
+            };
+        };
+        should_show_onboarding: boolean;
+        last_snippet_request: string | null;
+        last_snippet_request_in_production: string | null;
+        branding: string;
+        custom_call_to_action: string;
+        search_fuzzy_threshold: number | null;
+        show_skin_editor: boolean;
+        allow_event_handlers: boolean;
+        in_bar_feedback: boolean;
+        summon_hotkey_override: string | null;
+        end_user_hotkeys: boolean;
+        releases_available: boolean;
+        releases_enabled: boolean;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: string | number;
+        name: string;
+        created: string;
+    } & {} & {
+        launcher_type: "alternate" | "none" | "prompt" | "minimal";
+        launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
+        show_launcher_recommendations: boolean;
+        recommendations_type: "None" | "Custom" | "Algorithm";
+        launcher_offset_x: number;
+        launcher_offset_y: number;
+        theme: object;
+        icon: string;
+        icon_suggest: string;
+        icon_tutorial: string;
+        icon_go_forward: string;
+        resource_options: {
+            [x: string]: {
+                name?: string | undefined;
+                search?: boolean | undefined;
+                label_field?: string | undefined;
+                useCategory?: boolean | undefined;
+                search_fields?: string[] | undefined;
+                auto_execute?: boolean | undefined;
+                unfurl?: boolean | undefined;
+                description_field?: string | undefined;
+                icon?: string | undefined;
+                sort_key?: number | undefined;
+                max_options_count?: number | null | undefined;
+                sortFunction?: any;
+                default_command_id?: number | undefined;
+                showResources?: boolean | undefined;
+                show_with_no_results?: boolean | undefined;
+                search_tab_enabled?: boolean | undefined;
+                search_tab_name?: string | null | undefined;
+                search_tab_instruction?: string | null | undefined;
+                setting_pin_to_bottom?: boolean | undefined;
+            };
+        };
+        should_show_onboarding: boolean;
+        last_snippet_request: string | null;
+        last_snippet_request_in_production: string | null;
+        branding: string;
+        custom_call_to_action: string;
+        search_fuzzy_threshold: number | null;
+        show_skin_editor: boolean;
+        allow_event_handlers: boolean;
+        in_bar_feedback: boolean;
+        summon_hotkey_override: string | null;
+        end_user_hotkeys: boolean;
+        releases_available: boolean;
+        releases_enabled: boolean;
+    }>;
+    static listCommands: (orgUID: string) => Promise<({
+        id: number;
+        organization: string | number;
+        text: string;
+        template: ({
+            type: "admin";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "callback";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "link";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "click" | "clickBySelector" | "clickByXpath";
+            value: string[];
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "builtin";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "webhook";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | ({
+            type: "script";
+            value: string;
+        } & {} & {
+            commandType?: "object" | "independent" | "help" | undefined;
+            object?: string | undefined;
+            hoverTooltip?: boolean | undefined;
+            operation?: "self" | "router" | "blank" | undefined;
+        });
+    } & {
+        disabledReason?: string | undefined;
+        source?: string | undefined;
+        name?: string | undefined;
+        last_available?: string | null | undefined;
+        modified?: string | undefined;
+    } & {
+        arguments: {
+            [x: string]: ({
+                type: "context";
+                value: string;
+                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;
+            }) | ({
+                type: "set";
+                value: string[] | number[] | {
+                    [key: string]: unknown;
+                }[];
+                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;
+            }) | ({
+                type: "provided";
+                value: "time" | "text";
+                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;
+                dateTimeArgumentTypeId?: number | undefined;
+                allow_create?: boolean | undefined;
+                allow_create_label?: string | undefined;
+            }) | ({
+                type: "dependent";
+                value: string;
+                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;
+            }) | ({
+                type: "function";
+                value: string;
+                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;
+            });
+        };
+        tags: string[];
+        availability_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;
+        })[];
+        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;
+        }))[];
+        confirm: string;
+        shortcut: string[];
+        explanation: string;
+        is_live: boolean;
+        category: number | null;
+        sort_key: number | null;
+        icon: string | null;
+        celebrate: {
+            [x: string]: any;
+        } | null;
+        recommend_sort_key: number | null;
+        shortcut_mac: string[];
+        shortcut_win: string[];
+        hotkey_mac: string;
+        hotkey_win: string;
+    })[]>;
+    static listCommandCategories: (orgUID: string) => Promise<({
+        id: number;
+        organization: string | number;
+        name: string;
+    } & {} & {
+        sort_key: number | null;
+        icon: string | null;
+        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;
+    })[]>;
+    static listGuides: (orgUID: string) => Promise<({
+        id: number;
+        organization: string;
+        event: string;
+        nudge: string;
+        guidance: string;
+    } & {})[]>;
+    static listContexts: (orgUID: string) => Promise<({
+        id: number;
+        name: string;
+        organization: string;
+        value: {
+            [x: string]: any;
+        };
+    } & {})[]>;
+    static listPlaceholders: (orgUID: string) => Promise<({
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {})[]>;
+    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;
+        })[];
+    }[]>;
+    static userHasAccess: (uuid: string, user: string) => Promise<{
+        username: string;
+        slug: string;
+        organization: string;
+        has_access: boolean;
+        has_opened: boolean;
+        hotkeys_debug: boolean;
+        hmac: string | undefined;
+    }>;
+    static readHealth: (arg0: string, urlArgs?: {
+        [arg: string]: string;
+    } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: string | number;
+        uuid: string;
+        errors_72h: number;
+        suggestions_72h: number;
+        executions_total: number;
+        users_total: number;
+    }>;
+    static readInternal: (arg0: string, urlArgs?: {
+        [arg: string]: string;
+    } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: string;
+        integrations: {
+            [x: string]: {
+                [x: string]: string;
+            };
+        };
+    }>;
+    static updateInternal: (object: {
+        id: string;
+        integrations: {
+            [x: string]: {
+                [x: string]: string;
+            };
+        };
+    }, urlArgs?: {
+        [arg: string]: string;
+    } | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: string;
+        integrations: {
+            [x: string]: {
+                [x: string]: string;
+            };
+        };
+    }>;
+    static readSettings: (params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        analytics: {
+            execution_limit: number;
+            deadend_limit: number;
+        };
+        analytics_control: {
+            silent_enabled: boolean;
+            allow_event_handlers: boolean;
+        };
+        skins: {
+            limit: number;
+            field_set: "basic" | "pro";
+        };
+        deployment: {
+            show_countdown_banner: boolean;
+        };
+        view: {
+            in_bar_feedback: boolean;
+        };
+        end_user_limit: number;
+        user_seat_limit: number;
+        releases: {
+            available: boolean;
+            environments: string[];
+        };
+    }>;
+    static decode: (data: any) => {
+        id: string | number;
+        name: string;
+        created: string;
+    } & {} & {
+        launcher_type: "alternate" | "none" | "prompt" | "minimal";
+        launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
+        show_launcher_recommendations: boolean;
+        recommendations_type: "None" | "Custom" | "Algorithm";
+        launcher_offset_x: number;
+        launcher_offset_y: number;
+        theme: object;
+        icon: string;
+        icon_suggest: string;
+        icon_tutorial: string;
+        icon_go_forward: string;
+        resource_options: {
+            [x: string]: {
+                name?: string | undefined;
+                search?: boolean | undefined;
+                label_field?: string | undefined;
+                useCategory?: boolean | undefined;
+                search_fields?: string[] | undefined;
+                auto_execute?: boolean | undefined;
+                unfurl?: boolean | undefined;
+                description_field?: string | undefined;
+                icon?: string | undefined;
+                sort_key?: number | undefined;
+                max_options_count?: number | null | undefined;
+                sortFunction?: any;
+                default_command_id?: number | undefined;
+                showResources?: boolean | undefined;
+                show_with_no_results?: boolean | undefined;
+                search_tab_enabled?: boolean | undefined;
+                search_tab_name?: string | null | undefined;
+                search_tab_instruction?: string | null | undefined;
+                setting_pin_to_bottom?: boolean | undefined;
+            };
+        };
+        should_show_onboarding: boolean;
+        last_snippet_request: string | null;
+        last_snippet_request_in_production: string | null;
+        branding: string;
+        custom_call_to_action: string;
+        search_fuzzy_threshold: number | null;
+        show_skin_editor: boolean;
+        allow_event_handlers: boolean;
+        in_bar_feedback: boolean;
+        summon_hotkey_override: string | null;
+        end_user_hotkeys: boolean;
+        releases_available: boolean;
+        releases_enabled: boolean;
+    };
+}

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

@@ -0,0 +1,47 @@
+import * as t from 'io-ts';
+export declare const PlaceholderV: t.IntersectionC<[t.TypeC<{
+    id: t.NumberC;
+    organization: t.StringC;
+    slug: t.StringC;
+    text: t.StringC;
+}>, t.PartialC<{}>]>;
+export declare class Placeholder {
+    static create: (object: {
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}>;
+    static update: (object: {
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}>;
+    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;
+        text: string;
+    } & {})[]>;
+    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;
+        text: string;
+    } & {}>;
+}

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

@@ -0,0 +1,11 @@
+import * as t from 'io-ts';
+export declare const ProfileV: t.TypeC<{
+    user: t.StringC;
+    organization: t.StringC;
+}>;
+export declare class Profile {
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        user: string;
+        organization: string;
+    }[]>;
+}