commandbar 1.6.8 → 1.6.11

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

@@ -1,5 +1,6 @@
 /*******************************************************************************/
 import * as t from 'io-ts';
+import { GenericBatchRequest } from './generics';
 export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
     id: t.NumberC;
     organization: t.UnionC<[t.NumberC, t.StringC]>;
@@ -7,13 +8,33 @@ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC
 }>, t.PartialC<{}>]>, t.TypeC<{
     sort_key: t.UnionC<[t.NumberC, t.NullC]>;
     icon: t.UnionC<[t.StringC, t.NullC]>;
+    render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
     setting_hide_before_search: t.BooleanC;
     setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
     setting_pin_to_bottom: t.BooleanC;
     search_tab_enabled: t.BooleanC;
     search_tab_name: t.StringC;
     search_tab_instruction: t.StringC;
+    track_recents: t.BooleanC;
 }>]>;
+export declare const BatchEditorCategoryResponseV: t.TypeC<{
+    batch: t.ArrayC<t.IntersectionC<[t.IntersectionC<[t.TypeC<{
+        id: t.NumberC;
+        organization: t.UnionC<[t.NumberC, t.StringC]>;
+        name: t.StringC;
+    }>, t.PartialC<{}>]>, t.TypeC<{
+        sort_key: t.UnionC<[t.NumberC, t.NullC]>;
+        icon: t.UnionC<[t.StringC, t.NullC]>;
+        render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
+        setting_hide_before_search: t.BooleanC;
+        setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
+        setting_pin_to_bottom: t.BooleanC;
+        search_tab_enabled: t.BooleanC;
+        search_tab_name: t.StringC;
+        search_tab_instruction: t.StringC;
+        track_recents: t.BooleanC;
+    }>]>>;
+}>;
 export declare class CommandCategory {
     static create: (object: {
         id: number;
@@ -22,12 +43,14 @@ export declare class CommandCategory {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         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;
+        track_recents: boolean;
     }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: number;
         organization: string | number;
@@ -35,12 +58,14 @@ export declare class CommandCategory {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         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;
+        track_recents: boolean;
     }>;
     static update: (object: {
         id: number;
@@ -49,12 +74,14 @@ export declare class CommandCategory {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         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;
+        track_recents: boolean;
     }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: number;
         organization: string | number;
@@ -62,12 +89,14 @@ export declare class CommandCategory {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         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;
+        track_recents: boolean;
     }>;
     static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
     static decode: (data: any) => {
@@ -77,11 +106,31 @@ export declare class CommandCategory {
     } & {} & {
         sort_key: number | null;
         icon: string | null;
+        render_as: "grid" | "list";
         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;
+        track_recents: boolean;
     };
+    static batch: (request: t.TypeOf<typeof GenericBatchRequest>) => Promise<{
+        batch: ({
+            id: number;
+            organization: string | number;
+            name: string;
+        } & {} & {
+            sort_key: number | null;
+            icon: string | null;
+            render_as: "grid" | "list";
+            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;
+            track_recents: boolean;
+        })[];
+    }>;
 }

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

@@ -0,0 +1,21 @@
+/*******************************************************************************/
+import * as t from 'io-ts';
+export declare const DetailPreviewObjectV: t.TypeC<{
+    type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
+    value: t.StringC;
+}>;
+export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV>;
+export declare type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
+export declare type DataRowMedata = {
+    type: 'command' | 'parameter';
+    label: string;
+    value: any;
+    contextKey?: string;
+    uid?: string;
+};
+export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
+export declare const standardize: (item: undefined | null | DetailPreviewType) => null | DetailPreviewObjectType[];
+export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType | {
+    type: null;
+    value: null;
+};

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

@@ -5,6 +5,10 @@ declare const GenericObject: t.TypeC<{
     id: t.UnionC<[t.NumberC, t.StringC]>;
 }>;
 export declare type GenericObjectType = t.TypeOf<typeof GenericObject>;
+export declare const GenericBatchRequest: t.TypeC<{
+    batch: t.ArrayC<t.UnknownC>;
+    note: t.StringC;
+}>;
 declare function createObject<T, Q, O, I>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
 declare function readObject<T, O, I>(arg: t.Type<T, O, I>, url: string): (arg0: string, params?: Record<string, string>, callbacks?: {
     onSuccess?: () => void;
@@ -25,8 +29,12 @@ declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(
 declare function loadIDList(ids: number[], klass: any, method?: string, urlArgs?: {
     [arg: string]: string;
 }): Promise<any[]>;
-declare function read<T, O, I>(arg: t.Type<T, O, I>, url: string): (params?: Record<string, string>, callbacks?: {
+declare function read<T, O, I>(output: t.Type<T, O, I>, url: string): (params?: Record<string, string>, callbacks?: {
+    onSuccess?: () => void;
+    onError?: (err: string) => void;
+}) => Promise<T>;
+declare function update<T, O, I, Q>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string): (object: Q, params?: Record<string, string>, callbacks?: {
     onSuccess?: () => void;
     onError?: (err: string) => void;
 }) => Promise<T>;
-export { createObject, createObjectDetail, read, readObject, listObject, updateObject, deleteObject, GenericObject, readObjectDetail, updateObjectDetail, loadIDList, decodeToPromise, decodeThrowing, };
+export { createObject, createObjectDetail, read, readObject, listObject, update, updateObject, deleteObject, GenericObject, readObjectDetail, updateObjectDetail, loadIDList, decodeToPromise, decodeThrowing, };

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

@@ -0,0 +1,66 @@
+import * as t from 'io-ts';
+export declare const HelpDocsIntegrationV: t.IntersectionC<[t.TypeC<{
+    id: t.NumberC;
+    organization: t.StringC;
+    type: t.StringC;
+    schedule: t.StringC;
+    meta: t.UnionC<[t.RecordC<t.StringC, t.AnyC>, t.NullC]>;
+}>, t.PartialC<{}>]>;
+export declare class HelpDocsIntegration {
+    static create: (object: {
+        id: number;
+        organization: string;
+        type: string;
+        schedule: string;
+        meta: {
+            [x: string]: any;
+        } | null;
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        type: string;
+        schedule: string;
+        meta: {
+            [x: string]: any;
+        } | null;
+    } & {}>;
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: number;
+        organization: string;
+        type: string;
+        schedule: string;
+        meta: {
+            [x: string]: any;
+        } | null;
+    } & {}>;
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
+        id: number;
+        organization: string;
+        type: string;
+        schedule: string;
+        meta: {
+            [x: string]: any;
+        } | null;
+    } & {})[]>;
+    static update: (object: {
+        id: number;
+        organization: string;
+        type: string;
+        schedule: string;
+        meta: {
+            [x: string]: any;
+        } | null;
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        type: string;
+        schedule: string;
+        meta: {
+            [x: string]: any;
+        } | null;
+    } & {}>;
+    static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
+}

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

@@ -0,0 +1,42 @@
+import * as t from 'io-ts';
+export declare const HelpDocsSyncV: t.IntersectionC<[t.TypeC<{
+    id: t.NumberC;
+    integration: t.NumberC;
+    scheduled: t.BooleanC;
+}>, t.PartialC<{
+    commands: t.ArrayC<t.NumberC>;
+    started: t.StringC;
+    ended: t.StringC;
+    log: t.ArrayC<t.ArrayC<t.AnyC>>;
+}>]>;
+export declare class HelpDocsSync {
+    static create: (object: {
+        id: number;
+        integration: number;
+        scheduled: boolean;
+    } & {
+        commands?: number[] | undefined;
+        started?: string | undefined;
+        ended?: string | undefined;
+        log?: any[][] | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        integration: number;
+        scheduled: boolean;
+    } & {
+        commands?: number[] | undefined;
+        started?: string | undefined;
+        ended?: string | undefined;
+        log?: any[][] | undefined;
+    }>;
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
+        id: number;
+        integration: number;
+        scheduled: boolean;
+    } & {
+        commands?: number[] | undefined;
+        started?: string | undefined;
+        ended?: string | undefined;
+        log?: any[][] | undefined;
+    })[]>;
+}

package/build/internal/src/middleware/helpers/commandTemplate.d.ts

@@ -61,6 +61,15 @@ export declare const WebhookTemplateV: t.IntersectionC<[t.TypeC<{
     hoverTooltip: t.BooleanC;
     operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
 }>]>]>;
+export declare const AppCuesTemplateV: t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"appcues">;
+    value: t.StringC;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>;
 export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
     type: t.LiteralC<"script">;
     value: t.StringC;
@@ -70,6 +79,34 @@ export declare const ScriptTemplateV: t.IntersectionC<[t.TypeC<{
     hoverTooltip: t.BooleanC;
     operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
 }>]>]>;
+export declare const RequestV: t.IntersectionC<[t.TypeC<{
+    method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+    url: t.StringC;
+}>, t.PartialC<{
+    headers: t.UnknownRecordC;
+    body: t.UnknownRecordC;
+    onSend: t.StringC;
+    onSuccess: t.StringC;
+    onError: t.StringC;
+}>]>;
+export declare const RequestTemplateV: t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"request">;
+    value: t.IntersectionC<[t.TypeC<{
+        method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+        url: t.StringC;
+    }>, t.PartialC<{
+        headers: t.UnknownRecordC;
+        body: t.UnknownRecordC;
+        onSend: t.StringC;
+        onSuccess: t.StringC;
+        onError: t.StringC;
+    }>]>;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>;
 export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
     type: t.LiteralC<"admin">;
     value: t.StringC;
@@ -126,4 +163,29 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
     object: t.StringC;
     hoverTooltip: t.BooleanC;
     operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>, t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"request">;
+    value: t.IntersectionC<[t.TypeC<{
+        method: t.UnionC<[t.LiteralC<"get">, t.LiteralC<"delete">, t.LiteralC<"head">, t.LiteralC<"options">, t.LiteralC<"post">, t.LiteralC<"put">, t.LiteralC<"patch">]>;
+        url: t.StringC;
+    }>, t.PartialC<{
+        headers: t.UnknownRecordC;
+        body: t.UnknownRecordC;
+        onSend: t.StringC;
+        onSuccess: t.StringC;
+        onError: t.StringC;
+    }>]>;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+}>]>]>, t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"appcues">;
+    value: t.StringC;
+}>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
+    commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
+    object: t.StringC;
+    hoverTooltip: t.BooleanC;
+    operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
 }>]>]>]>;

package/build/internal/src/middleware/helpers/optionGroup.d.ts

@@ -0,0 +1,2 @@
+import * as t from 'io-ts';
+export declare const OptionGroupRenderAsV: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;