@botpress/sdk 2.0.4 → 2.0.5

package/dist/integration/types/generic.d.ts

@@ -0,0 +1,52 @@
+import * as utils from '../../utils/type-utils';
+export type BaseMessage = {
+    tags: Record<string, any>;
+};
+export type BaseConversation = {
+    tags: Record<string, any>;
+};
+export type BaseChannel = {
+    messages: Record<string, any>;
+    message: BaseMessage;
+    conversation: BaseConversation;
+};
+export type BaseUser = {
+    tags: Record<string, any>;
+};
+export type BaseAction = {
+    input: any;
+    output: any;
+};
+export type BaseIntegration = {
+    name: string;
+    version: string;
+    configuration: any;
+    configurations: Record<string, any>;
+    actions: Record<string, BaseAction>;
+    channels: Record<string, BaseChannel>;
+    events: Record<string, any>;
+    states: Record<string, any>;
+    user: BaseUser;
+    entities: Record<string, any>;
+};
+export type InputBaseChannel = utils.DeepPartial<BaseChannel>;
+export type DefaultChannel<C extends InputBaseChannel> = {
+    messages: utils.Default<C['messages'], BaseChannel['messages']>;
+    message: utils.Default<C['message'], BaseChannel['message']>;
+    conversation: utils.Default<C['conversation'], BaseChannel['conversation']>;
+};
+export type InputBaseIntegration = utils.DeepPartial<BaseIntegration>;
+export type DefaultIntegration<I extends InputBaseIntegration> = {
+    name: utils.Default<I['name'], BaseIntegration['name']>;
+    version: utils.Default<I['version'], BaseIntegration['version']>;
+    configuration: utils.Default<I['configuration'], BaseIntegration['configuration']>;
+    configurations: utils.Default<I['configurations'], BaseIntegration['configurations']>;
+    actions: utils.Default<I['actions'], BaseIntegration['actions']>;
+    events: utils.Default<I['events'], BaseIntegration['events']>;
+    states: utils.Default<I['states'], BaseIntegration['states']>;
+    user: utils.Default<I['user'], BaseIntegration['user']>;
+    entities: utils.Default<I['entities'], BaseIntegration['entities']>;
+    channels: undefined extends I['channels'] ? BaseIntegration['channels'] : {
+        [K in keyof I['channels']]: DefaultChannel<utils.Cast<I['channels'][K], InputBaseChannel>>;
+    };
+};

package/dist/integration/types/generic.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/integration/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generic';
+export * from './common';

package/dist/interface/definition.d.ts

@@ -0,0 +1,70 @@
+import { ActionDefinition, ChannelDefinition, EntityDefinition, EventDefinition } from '../integration/definition';
+import { ZuiObjectSchema, GenericZuiSchema, ZodRef } from '../zui';
+type BaseEvents = Record<string, ZuiObjectSchema>;
+type BaseActions = Record<string, ZuiObjectSchema>;
+type BaseMessages = Record<string, ZuiObjectSchema>;
+type BaseChannels = Record<string, BaseMessages>;
+type BaseEntities = Record<string, ZuiObjectSchema>;
+type EntityReferences<TEntities extends BaseEntities> = {
+    [K in keyof TEntities]: ZodRef;
+};
+type GenericEventDefinition<TEntities extends BaseEntities, TEvent extends BaseEvents[string] = BaseEvents[string]> = {
+    schema: GenericZuiSchema<EntityReferences<TEntities>, TEvent>;
+};
+type GenericChannelDefinition<TEntities extends BaseEntities, TChannel extends BaseChannels[string] = BaseChannels[string]> = {
+    messages: {
+        [K in keyof TChannel]: {
+            schema: GenericZuiSchema<EntityReferences<TEntities>, TChannel[K]>;
+        };
+    };
+};
+type GenericActionDefinition<TEntities extends BaseEntities, TAction extends BaseActions[string] = BaseActions[string]> = {
+    title?: string;
+    description?: string;
+    billable?: boolean;
+    cacheable?: boolean;
+    input: {
+        schema: GenericZuiSchema<EntityReferences<TEntities>, TAction>;
+    };
+    output: {
+        schema: GenericZuiSchema<EntityReferences<TEntities>, ZuiObjectSchema>;
+    };
+};
+export type InterfaceDefinitionProps<TName extends string = string, TVersion extends string = string, TEntities extends BaseEntities = BaseEntities, TActions extends BaseActions = BaseActions, TEvents extends BaseEntities = BaseEntities, TChannels extends BaseChannels = BaseChannels> = {
+    name: TName;
+    version: TVersion;
+    entities?: {
+        [K in keyof TEntities]: EntityDefinition<TEntities[K]>;
+    };
+    events?: {
+        [K in keyof TEvents]: GenericEventDefinition<TEntities, TEvents[K]>;
+    };
+    actions?: {
+        [K in keyof TActions]: GenericActionDefinition<TEntities, TActions[K]>;
+    };
+    channels?: {
+        [K in keyof TChannels]: GenericChannelDefinition<TEntities, TChannels[K]>;
+    };
+    templateName?: string;
+};
+export declare class InterfaceDefinition<TName extends string = string, TVersion extends string = string, TEntities extends BaseEntities = BaseEntities, TActions extends BaseActions = BaseActions, TEvents extends BaseEvents = BaseEvents, TChannels extends BaseChannels = BaseChannels> {
+    readonly props: InterfaceDefinitionProps<TName, TVersion, TEntities, TActions, TEvents, TChannels>;
+    readonly name: this['props']['name'];
+    readonly version: this['props']['version'];
+    readonly entities: {
+        [K in keyof TEntities]: EntityDefinition<TEntities[K]>;
+    };
+    readonly events: {
+        [K in keyof TEvents]: EventDefinition<TEvents[K]>;
+    };
+    readonly actions: {
+        [K in keyof TActions]: ActionDefinition<TActions[K]>;
+    };
+    readonly channels: {
+        [K in keyof TChannels]: ChannelDefinition<TChannels[K]>;
+    };
+    readonly templateName: this['props']['templateName'];
+    constructor(props: InterfaceDefinitionProps<TName, TVersion, TEntities, TActions, TEvents, TChannels>);
+    private _getEntityReference;
+}
+export {};

package/dist/interface/index.d.ts

@@ -0,0 +1 @@
+export * from './definition';

package/dist/interface/types/generic.d.ts

@@ -0,0 +1,34 @@
+import * as utils from '../../utils/type-utils';
+export type BaseChannel = {
+    messages: Record<string, any>;
+};
+export type BaseUser = {
+    tags: Record<string, any>;
+};
+export type BaseAction = {
+    input: any;
+    output: any;
+};
+export type BaseInterface = {
+    name: string;
+    version: string;
+    actions: Record<string, BaseAction>;
+    channels: Record<string, BaseChannel>;
+    events: Record<string, any>;
+    entities: Record<string, any>;
+};
+export type InputBaseChannel = utils.DeepPartial<BaseChannel>;
+export type DefaultChannel<C extends InputBaseChannel> = {
+    messages: utils.Default<C['messages'], BaseChannel['messages']>;
+};
+export type InputBaseInterface = utils.DeepPartial<BaseInterface>;
+export type DefaultInterface<I extends InputBaseInterface> = {
+    name: utils.Default<I['name'], BaseInterface['name']>;
+    version: utils.Default<I['version'], BaseInterface['version']>;
+    actions: utils.Default<I['actions'], BaseInterface['actions']>;
+    events: utils.Default<I['events'], BaseInterface['events']>;
+    entities: utils.Default<I['entities'], BaseInterface['entities']>;
+    channels: undefined extends I['channels'] ? BaseInterface['channels'] : {
+        [K in keyof I['channels']]: DefaultChannel<utils.Cast<I['channels'][K], InputBaseChannel>>;
+    };
+};

package/dist/interface/types/generic.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/log.d.ts

@@ -0,0 +1,7 @@
+export type Logger = {
+    debug(message: string, metadata?: any): void;
+    info(message: string, metadata?: any): void;
+    warn(message: string, metadata?: any): void;
+    error(message: string, metadata?: any): void;
+};
+export declare const log: Logger;

package/dist/message.d.ts

@@ -0,0 +1,474 @@
+/**
+ * @deprecated use `text` instead
+ */
+export declare const markdown: {
+    schema: import("@bpinternal/zui").ZodObject<{
+        markdown: import("@bpinternal/zui").ZodString;
+    }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+        markdown: string;
+    }, {
+        markdown: string;
+    }>;
+};
+export declare const defaults: {
+    readonly text: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            text: import("@bpinternal/zui").ZodString;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            text: string;
+        }, {
+            text: string;
+        }>;
+    };
+    readonly image: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            imageUrl: import("@bpinternal/zui").ZodString;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            imageUrl: string;
+        }, {
+            imageUrl: string;
+        }>;
+    };
+    readonly audio: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            audioUrl: import("@bpinternal/zui").ZodString;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            audioUrl: string;
+        }, {
+            audioUrl: string;
+        }>;
+    };
+    readonly video: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            videoUrl: import("@bpinternal/zui").ZodString;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            videoUrl: string;
+        }, {
+            videoUrl: string;
+        }>;
+    };
+    readonly file: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            fileUrl: import("@bpinternal/zui").ZodString;
+            title: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            fileUrl: string;
+            title?: string | undefined;
+        }, {
+            fileUrl: string;
+            title?: string | undefined;
+        }>;
+    };
+    readonly location: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            latitude: import("@bpinternal/zui").ZodNumber;
+            longitude: import("@bpinternal/zui").ZodNumber;
+            address: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            title: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            latitude: number;
+            longitude: number;
+            title?: string | undefined;
+            address?: string | undefined;
+        }, {
+            latitude: number;
+            longitude: number;
+            title?: string | undefined;
+            address?: string | undefined;
+        }>;
+    };
+    readonly carousel: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            items: import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+                title: import("@bpinternal/zui").ZodString;
+                subtitle: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                imageUrl: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                actions: import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+                    action: import("@bpinternal/zui").ZodEnum<["postback", "url", "say"]>;
+                    label: import("@bpinternal/zui").ZodString;
+                    value: import("@bpinternal/zui").ZodString;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    value: string;
+                    action: "postback" | "url" | "say";
+                    label: string;
+                }, {
+                    value: string;
+                    action: "postback" | "url" | "say";
+                    label: string;
+                }>, "many">;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                actions: {
+                    value: string;
+                    action: "postback" | "url" | "say";
+                    label: string;
+                }[];
+                title: string;
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+            }, {
+                actions: {
+                    value: string;
+                    action: "postback" | "url" | "say";
+                    label: string;
+                }[];
+                title: string;
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+            }>, "many">;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            items: {
+                actions: {
+                    value: string;
+                    action: "postback" | "url" | "say";
+                    label: string;
+                }[];
+                title: string;
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+            }[];
+        }, {
+            items: {
+                actions: {
+                    value: string;
+                    action: "postback" | "url" | "say";
+                    label: string;
+                }[];
+                title: string;
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+            }[];
+        }>;
+    };
+    readonly card: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            title: import("@bpinternal/zui").ZodString;
+            subtitle: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            imageUrl: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            actions: import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+                action: import("@bpinternal/zui").ZodEnum<["postback", "url", "say"]>;
+                label: import("@bpinternal/zui").ZodString;
+                value: import("@bpinternal/zui").ZodString;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                value: string;
+                action: "postback" | "url" | "say";
+                label: string;
+            }, {
+                value: string;
+                action: "postback" | "url" | "say";
+                label: string;
+            }>, "many">;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            actions: {
+                value: string;
+                action: "postback" | "url" | "say";
+                label: string;
+            }[];
+            title: string;
+            imageUrl?: string | undefined;
+            subtitle?: string | undefined;
+        }, {
+            actions: {
+                value: string;
+                action: "postback" | "url" | "say";
+                label: string;
+            }[];
+            title: string;
+            imageUrl?: string | undefined;
+            subtitle?: string | undefined;
+        }>;
+    };
+    readonly dropdown: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            text: import("@bpinternal/zui").ZodString;
+            options: import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+                label: import("@bpinternal/zui").ZodString;
+                value: import("@bpinternal/zui").ZodString;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>;
+    };
+    readonly choice: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            text: import("@bpinternal/zui").ZodString;
+            options: import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+                label: import("@bpinternal/zui").ZodString;
+                value: import("@bpinternal/zui").ZodString;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>;
+    };
+    readonly bloc: {
+        readonly schema: import("@bpinternal/zui").ZodObject<{
+            items: import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodUnion<[import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"text">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    text: import("@bpinternal/zui").ZodString;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    text: string;
+                }, {
+                    text: string;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            }, {
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            }>, import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"markdown">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    markdown: import("@bpinternal/zui").ZodString;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    markdown: string;
+                }, {
+                    markdown: string;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                };
+            }, {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                };
+            }>, import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"image">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    imageUrl: import("@bpinternal/zui").ZodString;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    imageUrl: string;
+                }, {
+                    imageUrl: string;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                };
+            }, {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                };
+            }>, import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"audio">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    audioUrl: import("@bpinternal/zui").ZodString;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    audioUrl: string;
+                }, {
+                    audioUrl: string;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                };
+            }, {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                };
+            }>, import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"video">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    videoUrl: import("@bpinternal/zui").ZodString;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    videoUrl: string;
+                }, {
+                    videoUrl: string;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                };
+            }, {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                };
+            }>, import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"file">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    fileUrl: import("@bpinternal/zui").ZodString;
+                    title: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    fileUrl: string;
+                    title?: string | undefined;
+                }, {
+                    fileUrl: string;
+                    title?: string | undefined;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string | undefined;
+                };
+            }, {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string | undefined;
+                };
+            }>, import("@bpinternal/zui").ZodObject<{
+                type: import("@bpinternal/zui").ZodLiteral<"location">;
+                payload: import("@bpinternal/zui").ZodObject<{
+                    latitude: import("@bpinternal/zui").ZodNumber;
+                    longitude: import("@bpinternal/zui").ZodNumber;
+                    address: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                    title: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                }, {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                }>;
+            }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                };
+            }, {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                };
+            }>]>, "many">;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            items: ({
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            } | {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                };
+            } | {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                };
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                };
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                };
+            } | {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                };
+            })[];
+        }, {
+            items: ({
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            } | {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                };
+            } | {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                };
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                };
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                };
+            } | {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                };
+            })[];
+        }>;
+    };
+};