commandbar 1.6.7 → 1.6.10

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

@@ -0,0 +1,425 @@
+/*******************************************************************************/
+import * as t from 'io-ts';
+import { BatchEditorCommandResponseV, BatchOperationV, CommandV, HelpSyncCommandV, EditorCommandV } from './command';
+import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
+import { GenericBatchRequest } from './generics';
+import { OptionGroupRenderAsV } from './helpers/optionGroup';
+import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } 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 { HelpDocsSyncV } from './helpDocsSync';
+import { HelpDocsIntegrationV } from './helpDocsIntegration';
+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 declare type IHelpSyncCommandType = t.TypeOf<typeof HelpSyncCommandV>;
+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 declare type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV>;
+export declare type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrationV>;
+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 GenericBatchRequest>;
+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 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 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 declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderAsV>;
+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 type { DetailPreviewObjectType, DetailPreviewType, DataRowMedata } from './detailPreview';
+/*******************************************************************************/
+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" | "clickByXpath" | "clickBySelector";
+        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;
+    }) | ({
+        type: "request";
+        value: {
+            method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
+            url: string;
+        } & {
+            headers?: {
+                [key: string]: unknown;
+            } | undefined;
+            body?: {
+                [key: string]: unknown;
+            } | undefined;
+            onSend?: string | undefined;
+            onSuccess?: string | undefined;
+            onError?: string | undefined;
+        };
+    } & {} & {
+        commandType?: "object" | "independent" | "help" | undefined;
+        object?: string | undefined;
+        hoverTooltip?: boolean | undefined;
+        operation?: "self" | "router" | "blank" | undefined;
+    }) | ({
+        type: "appcues";
+        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;
+    detail: string | {
+        type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+        value: string;
+    } | (string | {
+        type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
+        value: string;
+    })[] | null;
+};
+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;
+};

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

@@ -0,0 +1,12 @@
+import * as t from 'io-ts';
+export declare const UserV: t.IntersectionC<[t.TypeC<{
+    id: t.UnionC<[t.NumberC, t.StringC]>;
+}>, t.TypeC<{
+    token: t.StringC;
+    email: t.StringC;
+    organization: t.StringC;
+    api_token: t.UnionC<[t.StringC, t.NullC]>;
+    profile: t.NumberC;
+    has_updated_password: t.BooleanC;
+    is_active: t.BooleanC;
+}>, t.PartialC<{}>]>;

package/build/internal/src/util/Disposable.d.ts

@@ -0,0 +1,17 @@
+import { _dispose, _disposed } from '../client/symbols';
+export declare type PublicDisposable = {
+    dispose: VoidFunction;
+    _disposed?: boolean;
+};
+export declare type PrivateDisposable = {
+    [_dispose]: VoidFunction;
+    [_disposed]?: boolean;
+};
+export declare type Disposable = undefined | PublicDisposable | PrivateDisposable;
+export declare const isDisposable: (x: unknown) => x is Disposable;
+/**
+ * Determines if the provided value is "disposed". A value is considered "disposed" if it is an object with the
+ * _disposed property or symbol symbol set to true, or if the actual value is undefined.
+ */
+export declare const isDisposed: (x: unknown) => boolean;
+export declare function dispose(x: Disposable): void;

package/build/internal/src/util/LocalStorage.d.ts

@@ -0,0 +1,6 @@
+declare const LocalStorage: {
+    set: (label: string, value: string | boolean | number) => string | number | boolean;
+    get: (label: string, defaultValue: string | boolean | number) => string | number | boolean;
+    remove: (label: string) => void;
+};
+export default LocalStorage;

package/build/internal/src/util/Logger.d.ts

@@ -0,0 +1,18 @@
+import Debug from 'debug';
+declare const Logger: {
+    debug: Debug.Debugger;
+    log: Debug.Debugger;
+    info: Debug.Debugger;
+    warn: Debug.Debugger;
+    error: Debug.Debugger;
+    red: (...args: any[]) => void;
+    green: (...args: any[]) => void;
+    blue: (...args: any[]) => void;
+    orange: (...args: any[]) => void;
+    yellow: (...args: any[]) => void;
+    purple: (...args: any[]) => void;
+    black: (...args: any[]) => void;
+    portalsend: (...args: any[]) => void;
+    portalreceive: (...args: any[]) => void;
+};
+export default Logger;

package/build/internal/src/util/dispatchCustomEvent.d.ts

@@ -0,0 +1,2 @@
+export declare function dispatchCustomEvent<T>(eventType: string, detail: T, canBubble?: boolean, cancelable?: boolean): CustomEvent<T>;
+export default dispatchCustomEvent;

package/package.json

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

package/src/init.ts

@@ -3,7 +3,7 @@ import 'es6-object-assign/auto';
 import 'es6-symbol/implement';
 import { getProxySDK } from '../../internal/src/client/proxy';
 import { _configuration } from '../../internal/src/client/symbols';
-import { IConfigEndpointResponse } from '@commandbar/internal/middleware/types';
+import { IConfigEndpointResponse } from '../../internal/src/middleware/types';
 
 interface IInitOptions {
   debug?: boolean;