commandbar 1.8.7 → 1.9.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,104 @@
+import * as t from 'io-ts';
+import { UserProperties } from '../client/CommandBarClientSDK';
+import { IDecideResponseType, IEndUserType } from './types';
+export declare const QuestlistInteractionStateV: 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<{}>]>;
+export declare const QuestlistInteractionsV: 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<{}>]>>;
+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<{}>]>>, 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<{
+    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]>;
+}>, 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;
+    }) => Promise<IDecideResponseType | null>;
+    identify: (orgId: string | number, distinctId: string, options: {
+        properties?: UserProperties;
+    }, hmac?: string) => Promise<IEndUserType | null>;
+};

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

@@ -1,4 +1,5 @@
 import * as t from 'io-ts';
+import * as axiosInstance from './network';
 declare function decodeToPromise<T, O, I>(validator: t.Type<T, O, I>, input: I): Promise<T>;
 export declare function decodeToPromiseExact<T, O, I>(validator: t.Type<T, O, I> & t.HasProps, input: I): Promise<T>;
 declare function decodeThrowing<T, O, I>(validator: t.Type<T, O, I>, input: I): T;
@@ -10,32 +11,32 @@ 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> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
-declare function createObjectWithDecoder<T, Q, O, I>(decode: (result: any) => T, input: t.Type<Q, O, I> & t.HasProps, 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> & t.HasProps, url: string): (arg0: string, params?: Record<string, string>, callbacks?: {
+declare function createObject<T, Q, O, I>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
+declare function createObjectWithDecoder<T, Q, O, I>(decode: (result: any) => T, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
+declare function readObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (arg0: string, params?: Record<string, string>, callbacks?: {
     onSuccess?: () => void;
     onError?: (err: string) => void;
 }) => Promise<T>;
-declare function listObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, obj: string): (onSuccess?: () => void, onError?: (err: string) => void) => Promise<T[]>;
-declare function updateObject<T, O, I, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
-declare function deleteObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string): (id: number | string, params?: Record<string, string>, onSuccess?: () => void, onError?: (err: string) => void) => Promise<void>;
-declare function readObjectDetail<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, detail: string): (arg0: string, urlArgs?: {
+declare function listObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, obj: string, options?: axiosInstance.FetchOptions): (onSuccess?: () => void, onError?: (err: string) => void) => Promise<T[]>;
+declare function updateObject<T, O, I, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
+declare function deleteObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (id: number | string, params?: Record<string, string>, onSuccess?: () => void, onError?: (err: string) => void) => Promise<void>;
+declare function readObjectDetail<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, detail: string, options?: axiosInstance.FetchOptions): (arg0: string, urlArgs?: {
     [arg: string]: string;
 }, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
-declare function updateObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string): (object: Q, urlArgs?: {
+declare function updateObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string, options?: axiosInstance.FetchOptions): (object: Q, urlArgs?: {
     [arg: string]: string;
 }, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
-declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string): (object: Q, onSuccess?: () => void, onError?: (err: string) => void, urlArgs?: {
+declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void, urlArgs?: {
     [arg: string]: string;
 }) => Promise<T>;
 declare function loadIDList(ids: number[], klass: any, method?: string, urlArgs?: {
     [arg: string]: string;
 }): Promise<any[]>;
-declare function read<T, O, I>(output: t.Type<T, O, I> & t.HasProps, url: string): (params?: Record<string, string>, callbacks?: {
+declare function read<T, O, I>(output: t.Type<T, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (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> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string): (object: Q, params?: Record<string, string>, callbacks?: {
+declare function update<T, O, I, Q>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (object: Q, params?: Record<string, string>, callbacks?: {
     onSuccess?: () => void;
     onError?: (err: string) => void;
 }) => Promise<T>;

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

@@ -5,7 +5,12 @@ export declare const HelpDocsIntegrationV: t.IntersectionC<[t.TypeC<{
     type: t.StringC;
     schedule: t.StringC;
     meta: t.UnionC<[t.RecordC<t.StringC, t.AnyC>, t.NullC]>;
-}>, t.PartialC<{}>]>;
+}>, t.PartialC<{
+    title: t.StringC;
+    icon: t.StringC;
+    commands_count: t.NumberC;
+    recent_sync_date: t.UnionC<[t.StringC, t.NullC]>;
+}>]>;
 export declare class HelpDocsIntegration {
     static create: (object: {
         id: number;
@@ -15,7 +20,12 @@ export declare class HelpDocsIntegration {
         meta: {
             [x: string]: any;
         } | null;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+    } & {
+        title?: string | undefined;
+        icon?: string | undefined;
+        commands_count?: number | undefined;
+        recent_sync_date?: string | null | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: number;
         organization: string;
         type: string;
@@ -23,7 +33,12 @@ export declare class HelpDocsIntegration {
         meta: {
             [x: string]: any;
         } | null;
-    } & {}>;
+    } & {
+        title?: string | undefined;
+        icon?: string | undefined;
+        commands_count?: number | undefined;
+        recent_sync_date?: string | null | undefined;
+    }>;
     static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
         onSuccess?: (() => void) | undefined;
         onError?: ((err: string) => void) | undefined;
@@ -35,7 +50,12 @@ export declare class HelpDocsIntegration {
         meta: {
             [x: string]: any;
         } | null;
-    } & {}>;
+    } & {
+        title?: string | undefined;
+        icon?: string | undefined;
+        commands_count?: number | undefined;
+        recent_sync_date?: string | null | undefined;
+    }>;
     static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
         id: number;
         organization: string;
@@ -44,7 +64,12 @@ export declare class HelpDocsIntegration {
         meta: {
             [x: string]: any;
         } | null;
-    } & {})[]>;
+    } & {
+        title?: string | undefined;
+        icon?: string | undefined;
+        commands_count?: number | undefined;
+        recent_sync_date?: string | null | undefined;
+    })[]>;
     static update: (object: {
         id: number;
         organization: string;
@@ -53,7 +78,12 @@ export declare class HelpDocsIntegration {
         meta: {
             [x: string]: any;
         } | null;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+    } & {
+        title?: string | undefined;
+        icon?: string | undefined;
+        commands_count?: number | undefined;
+        recent_sync_date?: string | null | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: number;
         organization: string;
         type: string;
@@ -61,12 +91,28 @@ export declare class HelpDocsIntegration {
         meta: {
             [x: string]: any;
         } | null;
-    } & {}>;
+    } & {
+        title?: string | undefined;
+        icon?: string | undefined;
+        commands_count?: number | undefined;
+        recent_sync_date?: string | null | undefined;
+    }>;
     static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
     /** Get the status of the latest currently running sync for an integration */
-    static readSyncStatus: (integrationName: string) => Promise<{
+    static readSyncStatus: (integrationId: string) => Promise<{
         running: boolean;
         numFetched: number;
         numProcessed: number;
     }>;
 }
+declare const IntercomCreateConversationPayloadV: t.TypeC<{
+    message_id: t.StringC;
+    intercom_user_type: t.UnionC<[t.LiteralC<"visitor">, t.LiteralC<"user">]>;
+    intercom_user_id: t.UnionC<[t.StringC, t.UndefinedC]>;
+}>;
+export declare class IntercomIntegration {
+    static createConversation: (payload: t.TypeOf<typeof IntercomCreateConversationPayloadV>) => Promise<{
+        conversation_id?: string | undefined;
+    }>;
+}
+export {};