commandbar 1.8.7 → 1.10.0

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

@@ -8,7 +8,18 @@ export declare const DetailPreviewObjectV: t.IntersectionC<[t.TypeC<{
     position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
 }>]>;
 export type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV> & unknown;
-export type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
+export declare const DetailPreviewV: t.UnionC<[t.StringC, t.IntersectionC<[t.TypeC<{
+    type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
+    value: t.StringC;
+}>, t.PartialC<{
+    position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
+}>]>, t.ArrayC<t.UnionC<[t.IntersectionC<[t.TypeC<{
+    type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.LiteralC<"component">]>;
+    value: t.StringC;
+}>, t.PartialC<{
+    position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
+}>]>, t.StringC]>>]>;
+export type DetailPreviewType = t.TypeOf<typeof DetailPreviewV> & unknown;
 export type DataRowMetadata = {
     type: 'command' | 'parameter';
     label: string;

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

@@ -0,0 +1,132 @@
+import * as t from 'io-ts';
+import { UserProperties } from '../client/CommandBarClientSDK';
+import { IDecideResponseType, IEndUserType } from './types';
+export declare const ChecklistInteractionStateV: t.IntersectionC<[t.PartialC<{
+    isSkipped: t.BooleanC;
+    isCompleted: t.BooleanC;
+    isExpanded: t.BooleanC;
+    isSeen: t.BooleanC;
+    items: t.RecordC<t.StringC, t.TypeC<{
+        completedTS: t.StringC;
+    }>>;
+}>, t.PartialC<{}>]>;
+export declare const NudgeInteractionStateV: t.IntersectionC<[t.PartialC<{
+    currentStep: t.NumberC;
+    nudgeSeen: t.BooleanC;
+    nudgeInteracted: t.BooleanC;
+    seenTs: t.ArrayC<t.NumberC>;
+    snoozedUntilTs: t.NumberC;
+    nudgeDismissed: t.BooleanC;
+    nudgeCompleted: t.BooleanC;
+    nudgeDismissedTs: t.ArrayC<t.NumberC>;
+    nudgeCompletedTs: t.ArrayC<t.NumberC>;
+}>, t.PartialC<{
+    stepIndexStack: t.ArrayC<t.NumberC>;
+}>]>;
+export declare const ChecklistInteractionsV: t.RecordC<t.NumberC, t.IntersectionC<[t.PartialC<{
+    isSkipped: t.BooleanC;
+    isCompleted: t.BooleanC;
+    isExpanded: t.BooleanC;
+    isSeen: t.BooleanC;
+    items: t.RecordC<t.StringC, t.TypeC<{
+        completedTS: t.StringC;
+    }>>;
+}>, t.PartialC<{}>]>>;
+export declare const NudgeInteractionsV: t.RecordC<t.NumberC, t.IntersectionC<[t.PartialC<{
+    currentStep: t.NumberC;
+    nudgeSeen: t.BooleanC;
+    nudgeInteracted: t.BooleanC;
+    seenTs: t.ArrayC<t.NumberC>;
+    snoozedUntilTs: t.NumberC;
+    nudgeDismissed: t.BooleanC;
+    nudgeCompleted: t.BooleanC;
+    nudgeDismissedTs: t.ArrayC<t.NumberC>;
+    nudgeCompletedTs: t.ArrayC<t.NumberC>;
+}>, t.PartialC<{
+    stepIndexStack: t.ArrayC<t.NumberC>;
+}>]>>;
+export declare const UserRemotePropertiesV: t.RecordC<t.StringC, t.AnyC>;
+export declare const EndUserStoreDataV: t.TypeC<{
+    hotkeys: t.AnyC;
+    checklist_interactions: t.PartialC<{
+        activeChecklistId: t.UnionC<[t.NumberC, t.NullC]>;
+        checklists: t.RecordC<t.NumberC, t.IntersectionC<[t.PartialC<{
+            isSkipped: t.BooleanC;
+            isCompleted: t.BooleanC;
+            isExpanded: t.BooleanC;
+            isSeen: t.BooleanC;
+            items: t.RecordC<t.StringC, t.TypeC<{
+                completedTS: t.StringC;
+            }>>;
+        }>, t.PartialC<{}>]>>;
+    }>;
+    nudges_interactions: t.UnionC<[t.RecordC<t.NumberC, t.IntersectionC<[t.PartialC<{
+        currentStep: t.NumberC;
+        nudgeSeen: t.BooleanC;
+        nudgeInteracted: t.BooleanC;
+        seenTs: t.ArrayC<t.NumberC>;
+        snoozedUntilTs: t.NumberC;
+        nudgeDismissed: t.BooleanC;
+        nudgeCompleted: t.BooleanC;
+        nudgeDismissedTs: t.ArrayC<t.NumberC>;
+        nudgeCompletedTs: t.ArrayC<t.NumberC>;
+    }>, t.PartialC<{
+        stepIndexStack: t.ArrayC<t.NumberC>;
+    }>]>>, t.UndefinedC]>;
+    analytics: t.UnionC<[t.TypeC<{
+        num_command_executions: t.NumberC;
+        num_shortcut_command_executions: t.NumberC;
+        num_sessions: t.NumberC;
+        num_opens: t.NumberC;
+        num_deadends: t.NumberC;
+        first_seen_at: t.StringC;
+        last_seen_at: t.StringC;
+    }>, t.UndefinedC, t.NullC]>;
+    properties: t.RecordC<t.StringC, t.AnyC>;
+}>;
+export declare const EndUserV: t.TypeC<{
+    username: t.StringC;
+    slug: t.StringC;
+    organization: t.StringC;
+    has_access: t.BooleanC;
+    has_opened: t.BooleanC;
+    hotkeys_debug: t.BooleanC;
+    hmac: t.UnionC<[t.StringC, t.UndefinedC]>;
+    identifier: t.StringC;
+}>;
+export declare const DecideExperienceResponseV: t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>;
+export declare const DecideResponseV: t.UnionC<[t.TypeC<{
+    user_property_targeting: t.UnionC<[t.BooleanC, t.UndefinedC, t.NullC]>;
+    nudges: t.UnionC<[t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>, t.UndefinedC, t.NullC]>;
+    checklists: t.UnionC<[t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>, t.UndefinedC, t.NullC]>;
+    recommendation_sets: t.UnionC<[t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>, t.UndefinedC, t.NullC]>;
+}>, t.UndefinedC, t.NullC]>;
+export declare const EndUser: {
+    preferences: (_identifier: string | null | undefined, _hmac: string) => Promise<never>;
+    decide: (orgId: string | number, distinctId: string | null | undefined, options: {
+        properties?: UserProperties;
+        envOverride: {
+            env: string;
+        } | {
+            version: string;
+        } | null;
+        env: string | null;
+        version?: string;
+    }) => Promise<IDecideResponseType | null>;
+    identify: (orgId: string | number, distinctId: string, options: {
+        properties?: UserProperties;
+    }, hmac?: string) => Promise<IEndUserType | null>;
+};
+export declare function getEnvOrVersion({ envOverride, env, version, }: {
+    envOverride?: {
+        env: string;
+    } | {
+        version: string;
+    } | null;
+    env?: string | null;
+    version?: string | null;
+}): {
+    env: string;
+} | {
+    version: string;
+};

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

@@ -0,0 +1,17 @@
+import * as t from 'io-ts';
+export declare const EntityChangeV: t.IntersectionC<[t.TypeC<{
+    id: t.NumberC;
+    organization: t.StringC;
+    description: t.StringC;
+}>, t.PartialC<{
+    changed_by: t.StringC;
+    created: t.StringC;
+}>]>;
+export declare const listEntityChanges: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
+    id: number;
+    organization: string;
+    description: string;
+} & {
+    changed_by?: string | undefined;
+    created?: string | undefined;
+})[]>;

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

@@ -0,0 +1,59 @@
+import * as t from 'io-ts';
+export declare const ExperienceTemplateV: t.TypeC<{
+    id: t.NumberC;
+    type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">]>;
+    data: t.RecordC<t.StringC, t.AnyC>;
+}>;
+export declare class ExperienceTemplate {
+    static decode: (data: any) => {
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    };
+    static create: (object: {
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    }>;
+    static update: (object: {
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    }>;
+    static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    }[]>;
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: number;
+        type: "announcement" | "product_tour" | "survey";
+        data: {
+            [x: string]: any;
+        };
+    }>;
+}