commandbar 1.6.7 → 1.6.8

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

@@ -0,0 +1,261 @@
+import * as t from 'io-ts';
+export { ResourceSettingsV, ResourceSettingsByContextKeyV } from './ResourceSettingsV';
+export { OrganizationV } from './OrganizationV';
+export declare const ReleaseV: t.TypeC<{
+    created_by: t.StringC;
+    created: t.StringC;
+    history_event: t.IntersectionC<[t.TypeC<{
+        id: t.NumberC;
+        organization: t.StringC;
+        changed_by: t.StringC;
+        description: t.StringC;
+        created: t.StringC;
+        sha1: t.StringC;
+        version_num: t.NumberC;
+    }>, t.PartialC<{}>]>;
+    id: t.NumberC;
+    notes: t.StringC;
+    tags: t.ArrayC<t.StringC>;
+}>;
+export declare const ReleaseStepV: t.TypeC<{
+    created: t.StringC;
+    created_by: t.StringC;
+    current: t.UnionC<[t.BooleanC, t.NullC]>;
+    env: t.StringC;
+    id: t.NumberC;
+    next_env: t.UnionC<[t.NullC, t.StringC]>;
+    release: t.TypeC<{
+        created_by: t.StringC;
+        created: t.StringC;
+        history_event: t.IntersectionC<[t.TypeC<{
+            id: t.NumberC;
+            organization: t.StringC;
+            changed_by: t.StringC;
+            description: t.StringC;
+            created: t.StringC;
+            sha1: t.StringC;
+            version_num: t.NumberC;
+        }>, t.PartialC<{}>]>;
+        id: t.NumberC;
+        notes: t.StringC;
+        tags: t.ArrayC<t.StringC>;
+    }>;
+}>;
+export declare const EnvReleaseInfoV: t.IntersectionC<[t.TypeC<{
+    environment: t.StringC;
+}>, t.PartialC<{
+    release_step: t.TypeC<{
+        created: t.StringC;
+        created_by: t.StringC;
+        current: t.UnionC<[t.BooleanC, t.NullC]>;
+        env: t.StringC;
+        id: t.NumberC;
+        next_env: t.UnionC<[t.NullC, t.StringC]>;
+        release: t.TypeC<{
+            created_by: t.StringC;
+            created: t.StringC;
+            history_event: t.IntersectionC<[t.TypeC<{
+                id: t.NumberC;
+                organization: t.StringC;
+                changed_by: t.StringC;
+                description: t.StringC;
+                created: t.StringC;
+                sha1: t.StringC;
+                version_num: t.NumberC;
+            }>, t.PartialC<{}>]>;
+            id: t.NumberC;
+            notes: t.StringC;
+            tags: t.ArrayC<t.StringC>;
+        }>;
+    }>;
+    release: t.TypeC<{
+        created_by: t.StringC;
+        created: t.StringC;
+        history_event: t.IntersectionC<[t.TypeC<{
+            id: t.NumberC;
+            organization: t.StringC;
+            changed_by: t.StringC;
+            description: t.StringC;
+            created: t.StringC;
+            sha1: t.StringC;
+            version_num: t.NumberC;
+        }>, t.PartialC<{}>]>;
+        id: t.NumberC;
+        notes: t.StringC;
+        tags: t.ArrayC<t.StringC>;
+    }>;
+}>]>;
+export declare class Releases {
+    static readView: (params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        environments: ({
+            environment: string;
+        } & {
+            release_step?: {
+                created: string;
+                created_by: string;
+                current: boolean | null;
+                env: string;
+                id: number;
+                next_env: string | null;
+                release: {
+                    created_by: string;
+                    created: string;
+                    history_event: {
+                        id: number;
+                        organization: string;
+                        changed_by: string;
+                        description: string;
+                        created: string;
+                        sha1: string;
+                        version_num: number;
+                    } & {};
+                    id: number;
+                    notes: string;
+                    tags: string[];
+                };
+            } | undefined;
+            release?: {
+                created_by: string;
+                created: string;
+                history_event: {
+                    id: number;
+                    organization: string;
+                    changed_by: string;
+                    description: string;
+                    created: string;
+                    sha1: string;
+                    version_num: number;
+                } & {};
+                id: number;
+                notes: string;
+                tags: string[];
+            } | undefined;
+        })[];
+        latest_history_event: ({
+            id: number;
+            organization: string;
+            changed_by: string;
+            description: string;
+            created: string;
+            sha1: string;
+            version_num: number;
+        } & {}) | null;
+        latest_release: {
+            created_by: string;
+            created: string;
+            history_event: {
+                id: number;
+                organization: string;
+                changed_by: string;
+                description: string;
+                created: string;
+                sha1: string;
+                version_num: number;
+            } & {};
+            id: number;
+            notes: string;
+            tags: string[];
+        } | null;
+    }>;
+    static createRelease: (historyEventId: number, notes: string, tags: string[]) => Promise<{
+        created_by: string;
+        created: string;
+        history_event: {
+            id: number;
+            organization: string;
+            changed_by: string;
+            description: string;
+            created: string;
+            sha1: string;
+            version_num: number;
+        } & {};
+        id: number;
+        notes: string;
+        tags: string[];
+    }>;
+    static readReleaseStepsForEnv: (env: string) => Promise<{
+        created: string;
+        created_by: string;
+        current: boolean | null;
+        env: string;
+        id: number;
+        next_env: string | null;
+        release: {
+            created_by: string;
+            created: string;
+            history_event: {
+                id: number;
+                organization: string;
+                changed_by: string;
+                description: string;
+                created: string;
+                sha1: string;
+                version_num: number;
+            } & {};
+            id: number;
+            notes: string;
+            tags: string[];
+        };
+    }[]>;
+    static rollback: (releaseStepId: number) => Promise<{
+        created: string;
+        created_by: string;
+        current: boolean | null;
+        env: string;
+        id: number;
+        next_env: string | null;
+        release: {
+            created_by: string;
+            created: string;
+            history_event: {
+                id: number;
+                organization: string;
+                changed_by: string;
+                description: string;
+                created: string;
+                sha1: string;
+                version_num: number;
+            } & {};
+            id: number;
+            notes: string;
+            tags: string[];
+        };
+    }>;
+    static readDiff: (fromId: string, toId: string) => Promise<any>;
+    static promoteReleaseStep: (releaseStepId: number) => Promise<any>;
+    static promoteReleaseToFirstEnv: (releaseId: number) => Promise<{
+        created_by: string;
+        created: string;
+        history_event: {
+            id: number;
+            organization: string;
+            changed_by: string;
+            description: string;
+            created: string;
+            sha1: string;
+            version_num: number;
+        } & {};
+        id: number;
+        notes: string;
+        tags: string[];
+    }>;
+    static listReleases: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        created_by: string;
+        created: string;
+        history_event: {
+            id: number;
+            organization: string;
+            changed_by: string;
+            description: string;
+            created: string;
+            sha1: string;
+            version_num: number;
+        } & {};
+        id: number;
+        notes: string;
+        tags: string[];
+    }[]>;
+}

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

@@ -0,0 +1,66 @@
+import * as t from 'io-ts';
+export declare const SkinV: t.IntersectionC<[t.TypeC<{
+    id: t.StringC;
+    slug: t.StringC;
+    name: t.StringC;
+    default: t.BooleanC;
+    skin: t.AnyC;
+    organization: t.StringC;
+}>, t.PartialC<{
+    logo: t.UnionC<[t.StringC, t.NullC]>;
+}>]>;
+export declare class Skin {
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
+        id: string;
+        slug: string;
+        name: string;
+        default: boolean;
+        skin: any;
+        organization: string;
+    } & {
+        logo?: string | null | undefined;
+    })[]>;
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: string;
+        slug: string;
+        name: string;
+        default: boolean;
+        skin: any;
+        organization: string;
+    } & {
+        logo?: string | null | undefined;
+    }>;
+    static update: (object: {
+        id: string;
+        slug: string;
+        name: string;
+        default: boolean;
+        skin: any;
+        organization: string;
+    } & {
+        logo?: string | null | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: string;
+        slug: string;
+        name: string;
+        default: boolean;
+        skin: any;
+        organization: string;
+    } & {
+        logo?: string | null | undefined;
+    }>;
+    static create: (object: {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: string;
+        slug: string;
+        name: string;
+        default: boolean;
+        skin: any;
+        organization: string;
+    } & {
+        logo?: string | null | undefined;
+    }>;
+    static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
+}

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

@@ -0,0 +1,378 @@
+/*******************************************************************************/
+import * as t from 'io-ts';
+import { BatchEditorCommandRequestV, BatchEditorCommandResponseV, BatchOperationV, CommandV, EditorCommandV } from './command';
+import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
+import { TemplateV, TemplateOptionsV } from './helpers/commandTemplate';
+import { CommandCategoryV } from './commandCategory';
+import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationSettingsV } from './organization';
+import { UserV } from './user';
+import { ContextV } from './context';
+import { GuideV } from './guide';
+import { HistoryEventV } from './historyEvent';
+import { EndUserV } from './helpers/endUser';
+import { SkinV } from './skin';
+import { ProfileV } from './profile';
+import { PlaceholderV } from './placeholder';
+import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
+import { EnvironmentV } from './environment';
+/*******************************************************************************/
+export declare type IContextType = t.TypeOf<typeof ContextV>;
+export declare type IUserType = t.TypeOf<typeof UserV>;
+export declare type ICommandType = t.TypeOf<typeof CommandV>;
+export declare type IEditorCommandType = t.TypeOf<typeof EditorCommandV>;
+export type { ICommandFromClientType } from './ICommandFromClientType';
+export declare type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV>;
+export declare type IGuideType = t.TypeOf<typeof GuideV> & {
+    preview?: boolean;
+};
+export declare type IHistoryEventType = t.TypeOf<typeof HistoryEventV>;
+export type { IOrganizationType } from './OrganizationV';
+export declare type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV>;
+export declare type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV>;
+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 IEnvironmentType = t.TypeOf<typeof EnvironmentV>;
+export declare type IReleaseStep = t.TypeOf<typeof ReleaseStepV>;
+export declare type IRelease = t.TypeOf<typeof ReleaseV>;
+export declare type IEnvReleaseInfo = t.TypeOf<typeof EnvReleaseInfoV>;
+/*******************************************************************************/
+export declare type IBatchOperation = t.TypeOf<typeof BatchOperationV>;
+export declare type IBatchEditorCommandRequst = t.TypeOf<typeof BatchEditorCommandRequestV>;
+export declare type IBatchEditorCommandResponse = t.TypeOf<typeof BatchEditorCommandResponseV>;
+/*******************************************************************************/
+export declare type IKeyEventCategory = t.TypeOf<typeof KeyEventV>;
+export declare type IArgumentMap = t.TypeOf<typeof ArgumentMapV>;
+export declare type IArgumentType = t.TypeOf<typeof ArgumentTypeV>;
+export declare type IStepArgumentType = t.TypeOf<typeof StepArgumentTypeV>;
+export declare type ITemplate = t.TypeOf<typeof TemplateV>;
+export declare type ITemplateOptions = t.TypeOf<typeof TemplateOptionsV>;
+export declare type IEndUserType = t.TypeOf<typeof EndUserV>;
+export declare type IConditionType = t.TypeOf<typeof ConditionV>;
+export declare type IConditionOperatorType = t.TypeOf<typeof ConditionOperatorV>;
+export declare type IContextArgumentType = t.TypeOf<typeof ContextArgumentV>;
+export declare type ISetArgumentType = t.TypeOf<typeof SetArgumentV>;
+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 interface ICommandInput {
+    text: string;
+    command: ICommandType;
+    context: IUserContext;
+}
+export interface IArgValues {
+    [arg: string]: string | number | undefined;
+}
+export declare type IHistoryType = Array<{
+    activeCommand: ICommandType;
+    options: ICommandType[];
+}>;
+export interface IUserContext {
+    [variable: string]: any;
+}
+export interface ICallbackMap {
+    [variable: string]: (...args: any[]) => any;
+}
+export interface IResourceType extends IUserContext {
+    _cbLinkedCommmands: Array<{
+        command: number;
+        arg: string;
+    }>;
+}
+export declare type IConfigEndpointResponse = {
+    commands: any[];
+    categories: any[];
+    organization: any;
+    environments_with_versions?: any[];
+    placeholders?: any[];
+};
+export type { IResourceSettings } from './IResourceSettings';
+export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV>;
+/*******************************************************************************/
+export declare const isCommand: (command?: ICommandType | any) => command is {
+    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;
+            show_in_record_action_list?: boolean | undefined;
+            show_in_default_list?: boolean | 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: boolean | {
+        angle?: number | undefined;
+        spread?: number | undefined;
+        width?: string | undefined;
+        height?: string | undefined;
+        duration?: number | undefined;
+        dragFriction?: number | undefined;
+        stagger?: number | undefined;
+        startVelocity?: number | undefined;
+        elementCount?: number | undefined;
+        decay?: number | undefined;
+        colors?: string[] | undefined;
+        random?: any;
+    } | null;
+    recommend_sort_key: number | null;
+    shortcut_mac: string[];
+    shortcut_win: string[];
+    hotkey_mac: string;
+    hotkey_win: string;
+};
+export declare const isResource: (option: any) => option is IResourceType;
+export declare const isContextArgument: (argument: IArgumentType) => argument is {
+    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;
+    show_in_record_action_list?: boolean | undefined;
+    show_in_default_list?: boolean | undefined;
+};
+export declare const isTimeArgument: (argument: IArgumentType) => argument is {
+    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;
+};
+export declare const isFunctionArgument: (argument: IArgumentType) => argument is {
+    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;
+};