@botpress/webchat 2.3.1 → 2.3.5

package/dist/adapters/sdk.d.ts

@@ -1,472 +0,0 @@
-import { z } from 'zod';
-export declare const defaults: {
-    readonly text: {
-        readonly schema: z.ZodObject<{
-            text: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-        }, {
-            text: string;
-        }>;
-    };
-    readonly markdown: {
-        readonly schema: z.ZodObject<{
-            markdown: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            markdown: string;
-        }, {
-            markdown: string;
-        }>;
-    };
-    readonly image: {
-        readonly schema: z.ZodObject<{
-            imageUrl: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            imageUrl: string;
-        }, {
-            imageUrl: string;
-        }>;
-    };
-    readonly audio: {
-        readonly schema: z.ZodObject<{
-            audioUrl: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            audioUrl: string;
-        }, {
-            audioUrl: string;
-        }>;
-    };
-    readonly video: {
-        readonly schema: z.ZodObject<{
-            videoUrl: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            videoUrl: string;
-        }, {
-            videoUrl: string;
-        }>;
-    };
-    readonly file: {
-        readonly schema: z.ZodObject<{
-            fileUrl: z.ZodString;
-            title: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            fileUrl: string;
-            title?: string | undefined;
-        }, {
-            fileUrl: string;
-            title?: string | undefined;
-        }>;
-    };
-    readonly location: {
-        readonly schema: z.ZodObject<{
-            latitude: z.ZodNumber;
-            longitude: z.ZodNumber;
-            address: z.ZodOptional<z.ZodString>;
-            title: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            latitude: number;
-            longitude: number;
-            address?: string | undefined;
-            title?: string | undefined;
-        }, {
-            latitude: number;
-            longitude: number;
-            address?: string | undefined;
-            title?: string | undefined;
-        }>;
-    };
-    readonly carousel: {
-        readonly schema: z.ZodObject<{
-            items: z.ZodArray<z.ZodObject<{
-                title: z.ZodString;
-                subtitle: z.ZodOptional<z.ZodString>;
-                imageUrl: z.ZodOptional<z.ZodString>;
-                actions: z.ZodArray<z.ZodObject<{
-                    action: z.ZodEnum<["postback", "url", "say"]>;
-                    label: z.ZodString;
-                    value: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    value: string;
-                    action: "postback" | "url" | "say";
-                    label: string;
-                }, {
-                    value: string;
-                    action: "postback" | "url" | "say";
-                    label: string;
-                }>, "many">;
-            }, "strip", z.ZodTypeAny, {
-                title: string;
-                actions: {
-                    value: string;
-                    action: "postback" | "url" | "say";
-                    label: string;
-                }[];
-                subtitle?: string | undefined;
-                imageUrl?: string | undefined;
-            }, {
-                title: string;
-                actions: {
-                    value: string;
-                    action: "postback" | "url" | "say";
-                    label: string;
-                }[];
-                subtitle?: string | undefined;
-                imageUrl?: string | undefined;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            items: {
-                title: string;
-                actions: {
-                    value: string;
-                    action: "postback" | "url" | "say";
-                    label: string;
-                }[];
-                subtitle?: string | undefined;
-                imageUrl?: string | undefined;
-            }[];
-        }, {
-            items: {
-                title: string;
-                actions: {
-                    value: string;
-                    action: "postback" | "url" | "say";
-                    label: string;
-                }[];
-                subtitle?: string | undefined;
-                imageUrl?: string | undefined;
-            }[];
-        }>;
-    };
-    readonly card: {
-        readonly schema: z.ZodObject<{
-            title: z.ZodString;
-            subtitle: z.ZodOptional<z.ZodString>;
-            imageUrl: z.ZodOptional<z.ZodString>;
-            actions: z.ZodArray<z.ZodObject<{
-                action: z.ZodEnum<["postback", "url", "say"]>;
-                label: z.ZodString;
-                value: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                value: string;
-                action: "postback" | "url" | "say";
-                label: string;
-            }, {
-                value: string;
-                action: "postback" | "url" | "say";
-                label: string;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            title: string;
-            actions: {
-                value: string;
-                action: "postback" | "url" | "say";
-                label: string;
-            }[];
-            subtitle?: string | undefined;
-            imageUrl?: string | undefined;
-        }, {
-            title: string;
-            actions: {
-                value: string;
-                action: "postback" | "url" | "say";
-                label: string;
-            }[];
-            subtitle?: string | undefined;
-            imageUrl?: string | undefined;
-        }>;
-    };
-    readonly dropdown: {
-        readonly schema: z.ZodObject<{
-            text: z.ZodString;
-            options: z.ZodArray<z.ZodObject<{
-                label: z.ZodString;
-                value: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                value: string;
-                label: string;
-            }, {
-                value: string;
-                label: string;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            options: {
-                value: string;
-                label: string;
-            }[];
-        }, {
-            text: string;
-            options: {
-                value: string;
-                label: string;
-            }[];
-        }>;
-    };
-    readonly choice: {
-        readonly schema: z.ZodObject<{
-            text: z.ZodString;
-            options: z.ZodArray<z.ZodObject<{
-                label: z.ZodString;
-                value: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                value: string;
-                label: string;
-            }, {
-                value: string;
-                label: string;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            options: {
-                value: string;
-                label: string;
-            }[];
-        }, {
-            text: string;
-            options: {
-                value: string;
-                label: string;
-            }[];
-        }>;
-    };
-    readonly bloc: {
-        readonly schema: z.ZodObject<{
-            items: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-                type: z.ZodLiteral<"text">;
-                payload: z.ZodObject<{
-                    text: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    text: string;
-                }, {
-                    text: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "text";
-                payload: {
-                    text: string;
-                };
-            }, {
-                type: "text";
-                payload: {
-                    text: string;
-                };
-            }>, z.ZodObject<{
-                type: z.ZodLiteral<"markdown">;
-                payload: z.ZodObject<{
-                    markdown: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    markdown: string;
-                }, {
-                    markdown: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "markdown";
-                payload: {
-                    markdown: string;
-                };
-            }, {
-                type: "markdown";
-                payload: {
-                    markdown: string;
-                };
-            }>, z.ZodObject<{
-                type: z.ZodLiteral<"image">;
-                payload: z.ZodObject<{
-                    imageUrl: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    imageUrl: string;
-                }, {
-                    imageUrl: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "image";
-                payload: {
-                    imageUrl: string;
-                };
-            }, {
-                type: "image";
-                payload: {
-                    imageUrl: string;
-                };
-            }>, z.ZodObject<{
-                type: z.ZodLiteral<"audio">;
-                payload: z.ZodObject<{
-                    audioUrl: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    audioUrl: string;
-                }, {
-                    audioUrl: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "audio";
-                payload: {
-                    audioUrl: string;
-                };
-            }, {
-                type: "audio";
-                payload: {
-                    audioUrl: string;
-                };
-            }>, z.ZodObject<{
-                type: z.ZodLiteral<"video">;
-                payload: z.ZodObject<{
-                    videoUrl: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    videoUrl: string;
-                }, {
-                    videoUrl: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "video";
-                payload: {
-                    videoUrl: string;
-                };
-            }, {
-                type: "video";
-                payload: {
-                    videoUrl: string;
-                };
-            }>, z.ZodObject<{
-                type: z.ZodLiteral<"file">;
-                payload: z.ZodObject<{
-                    fileUrl: z.ZodString;
-                    title: z.ZodOptional<z.ZodString>;
-                }, "strip", z.ZodTypeAny, {
-                    fileUrl: string;
-                    title?: string | undefined;
-                }, {
-                    fileUrl: string;
-                    title?: string | undefined;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "file";
-                payload: {
-                    fileUrl: string;
-                    title?: string | undefined;
-                };
-            }, {
-                type: "file";
-                payload: {
-                    fileUrl: string;
-                    title?: string | undefined;
-                };
-            }>, z.ZodObject<{
-                type: z.ZodLiteral<"location">;
-                payload: z.ZodObject<{
-                    latitude: z.ZodNumber;
-                    longitude: z.ZodNumber;
-                    address: z.ZodOptional<z.ZodString>;
-                    title: z.ZodOptional<z.ZodString>;
-                }, "strip", z.ZodTypeAny, {
-                    latitude: number;
-                    longitude: number;
-                    address?: string | undefined;
-                    title?: string | undefined;
-                }, {
-                    latitude: number;
-                    longitude: number;
-                    address?: string | undefined;
-                    title?: string | undefined;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                type: "location";
-                payload: {
-                    latitude: number;
-                    longitude: number;
-                    address?: string | undefined;
-                    title?: string | undefined;
-                };
-            }, {
-                type: "location";
-                payload: {
-                    latitude: number;
-                    longitude: number;
-                    address?: string | undefined;
-                    title?: string | undefined;
-                };
-            }>]>, "many">;
-        }, "strip", z.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;
-                    address?: string | undefined;
-                    title?: 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;
-                    address?: string | undefined;
-                    title?: string | undefined;
-                };
-            })[];
-        }>;
-    };
-};

package/dist/client/inner-client/event-emitter.d.ts

@@ -1,10 +0,0 @@
-export type ListenStatus = 'keep-listening' | 'stop-listening';
-export declare class EventEmitter<E extends object> {
-    private listeners;
-    emit<K extends keyof E>(type: K, event: E[K]): void;
-    onceOrMore<K extends keyof E>(type: K, listener: (event: E[K]) => ListenStatus): void;
-    once<K extends keyof E>(type: K, listener: (event: E[K]) => void): void;
-    on<K extends keyof E>(type: K, listener: (event: E[K]) => void): void;
-    off<K extends keyof E>(type: K, listener: (event: E[K]) => void): void;
-    cleanup(): void;
-}

package/dist/client/inner-client/eventsource.d.ts

@@ -1,22 +0,0 @@
-import EventSource from 'event-source-polyfill';
-import { EventEmitter } from './event-emitter';
-type OnOpen = NonNullable<EventSource.EventSourcePolyfill['onopen']>;
-type OnMessage = NonNullable<EventSource.EventSourcePolyfill['onmessage']>;
-type OnError = NonNullable<EventSource.EventSourcePolyfill['onerror']>;
-export type OpenEvent = Parameters<OnOpen>[0];
-export type MessageEvent = Parameters<OnMessage>[0];
-export type ErrorEvent = Parameters<OnError>[0];
-export type Events = {
-    open: OpenEvent;
-    message: MessageEvent;
-    error: ErrorEvent;
-};
-export type Props = {
-    headers?: Record<string, string>;
-};
-export type EvSource = {
-    on: EventEmitter<Events>['on'];
-    close: () => void;
-};
-export declare const listenEventSource: (url: string, props?: Props) => Promise<EvSource>;
-export {};

package/dist/client/inner-client/index.d.ts

@@ -1,42 +0,0 @@
-import { Client as AutoGeneratedClient } from '../../gen/client';
-import { SignalListener } from './signal-listener';
-export type { Message, Conversation, User } from '../../gen/client';
-export * from '../../gen/client/errors';
-export type Headers = Record<string, string>;
-export type ClientProps = {
-    apiUrl: string;
-    timeout?: number;
-    headers?: Headers;
-};
-type IOf<T extends object> = {
-    [K in keyof T]: T[K];
-};
-type IAutoClient = IOf<AutoGeneratedClient>;
-type IClient = Omit<IAutoClient, 'listenConversation'>;
-type ListenConversationOperation = IAutoClient['listenConversation'];
-type ListenConversationArgs = Parameters<ListenConversationOperation>[0];
-export declare class Client implements IClient {
-    readonly props: Readonly<ClientProps>;
-    private _auto;
-    constructor(props: Readonly<ClientProps>);
-    readonly createConversation: IAutoClient['createConversation'];
-    readonly getConversation: IAutoClient['getConversation'];
-    readonly deleteConversation: IAutoClient['deleteConversation'];
-    readonly listConversations: IAutoClient['listConversations'];
-    readonly listConversationMessages: IAutoClient['listConversationMessages'];
-    readonly addParticipant: IAutoClient['addParticipant'];
-    readonly removeParticipant: IAutoClient['removeParticipant'];
-    readonly getParticipant: IAutoClient['getParticipant'];
-    readonly listParticipants: IAutoClient['listParticipants'];
-    readonly createMessage: IAutoClient['createMessage'];
-    readonly getMessage: IAutoClient['getMessage'];
-    readonly deleteMessage: IAutoClient['deleteMessage'];
-    readonly createFile: IAutoClient['createFile'];
-    readonly createUser: IAutoClient['createUser'];
-    readonly getUser: IAutoClient['getUser'];
-    readonly updateUser: IAutoClient['updateUser'];
-    readonly deleteUser: IAutoClient['deleteUser'];
-    readonly createEvent: IAutoClient['createEvent'];
-    readonly getEvent: IAutoClient['getEvent'];
-    readonly listenConversation: ({ id, "x-user-key": userKey, }: ListenConversationArgs) => Promise<SignalListener>;
-}

package/dist/client/inner-client/signal-listener.d.ts

@@ -1,47 +0,0 @@
-import { EventEmitter } from './event-emitter';
-import { EvSource } from './eventsource';
-import { Types } from '../../gen/signals';
-type Signals = Types & {
-    unknown: {
-        type: 'unknown';
-        data: unknown;
-    };
-};
-type SignalMap = {
-    [K in keyof Signals as Signals[K]['type']]: Signals[K]['data'];
-};
-type Events = SignalMap & {
-    error: Error;
-};
-type SignalListenerState = {
-    status: 'disconnected';
-} | {
-    status: 'connecting';
-    connectionPromise: Promise<EvSource>;
-} | {
-    status: 'connected';
-    source: EvSource;
-};
-export type SignalListenerStatus = SignalListenerState['status'];
-export type SignalListenerProps = {
-    url: string;
-    userKey: string;
-    conversationId: string;
-};
-export declare class SignalListener extends EventEmitter<Events> {
-    private _props;
-    private _state;
-    constructor(_props: SignalListenerProps);
-    static listen: (props: SignalListenerProps) => Promise<SignalListener>;
-    get status(): SignalListenerStatus;
-    readonly connect: () => Promise<void>;
-    readonly disconnect: () => Promise<void>;
-    private _connect;
-    private _disconnectSync;
-    private _handleMessage;
-    private _handleError;
-    private _parseSignal;
-    private _safeJsonParse;
-    private _toError;
-}
-export {};

package/openapi.ts

@@ -1,35 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-import type { default as yargs } from '@bpinternal/yargs-extra'
-import { parseEnv, YargsSchema } from '@bpinternal/yargs-extra'
-import { api } from 'webchat-api'
-import pathlib from 'path'
-
-const yargsExtra = require('@bpinternal/yargs-extra') // running script from an esm module
-const yargz = yargsExtra.default as ReturnType<typeof yargs>
-
-const configSchema = {
-  outDir: {
-    type: 'string' as const,
-  },
-} satisfies YargsSchema
-
-const description = 'Generate OpenAPI client'
-
-void yargz
-  .command('$0', description, configSchema, async (argv) => {
-    const config = { ...argv, ...parseEnv(configSchema) }
-    if (!config.outDir) {
-      throw new Error('outDir is required')
-    }
-
-    const clientDir = pathlib.join(config.outDir, 'client')
-    await api.exportClient(clientDir, {
-      generator: 'opapi',
-    })
-
-    const signalsDir = pathlib.join(config.outDir, 'signals')
-    await api.signals.exportSchemas(signalsDir, { includeJsonSchemas: false })
-  })
-  .showHelpOnFail(false)
-  .help()
-  .parse()