@botpress/webchat 1.1.1 → 1.2.0

package/dist/gen/signals/messageCreatedSignal.z.d.ts

@@ -0,0 +1,515 @@
+import { z } from "zod";
+declare const _default: z.ZodObject<{
+    type: z.ZodLiteral<"message_created">;
+    data: z.ZodObject<{
+        id: z.ZodString;
+        createdAt: z.ZodString;
+        payload: z.ZodUnion<[z.ZodObject<{
+            audioUrl: z.ZodString;
+            type: z.ZodLiteral<"audio">;
+        }, "strip", z.ZodTypeAny, {
+            type: "audio";
+            audioUrl: string;
+        }, {
+            type: "audio";
+            audioUrl: string;
+        }>, 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: "url" | "postback" | "say";
+                label: string;
+            }, {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }>, "many">;
+            type: z.ZodLiteral<"card">;
+        }, "strip", z.ZodTypeAny, {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        }, {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        }>, 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: "url" | "postback" | "say";
+                    label: string;
+                }, {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }, {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }>, "many">;
+            type: z.ZodLiteral<"carousel">;
+        }, "strip", z.ZodTypeAny, {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        }, {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        }>, 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">;
+            type: z.ZodLiteral<"choice">;
+        }, "strip", z.ZodTypeAny, {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>, 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">;
+            type: z.ZodLiteral<"dropdown">;
+        }, "strip", z.ZodTypeAny, {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>, z.ZodObject<{
+            fileUrl: z.ZodString;
+            title: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"file">;
+        }, "strip", z.ZodTypeAny, {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        }, {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        }>, z.ZodObject<{
+            imageUrl: z.ZodString;
+            type: z.ZodLiteral<"image">;
+        }, "strip", z.ZodTypeAny, {
+            type: "image";
+            imageUrl: string;
+        }, {
+            type: "image";
+            imageUrl: string;
+        }>, z.ZodObject<{
+            latitude: z.ZodNumber;
+            longitude: z.ZodNumber;
+            address: z.ZodOptional<z.ZodString>;
+            title: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"location">;
+        }, "strip", z.ZodTypeAny, {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        }, {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        }>, z.ZodObject<{
+            markdown: z.ZodString;
+            type: z.ZodLiteral<"markdown">;
+        }, "strip", z.ZodTypeAny, {
+            type: "markdown";
+            markdown: string;
+        }, {
+            type: "markdown";
+            markdown: string;
+        }>, z.ZodObject<{
+            text: z.ZodString;
+            type: z.ZodLiteral<"text">;
+        }, "strip", z.ZodTypeAny, {
+            type: "text";
+            text: string;
+        }, {
+            type: "text";
+            text: string;
+        }>, z.ZodObject<{
+            videoUrl: z.ZodString;
+            type: z.ZodLiteral<"video">;
+        }, "strip", z.ZodTypeAny, {
+            type: "video";
+            videoUrl: string;
+        }, {
+            type: "video";
+            videoUrl: string;
+        }>]>;
+        userId: z.ZodString;
+        conversationId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        payload: {
+            type: "audio";
+            audioUrl: string;
+        } | {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        } | {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        } | {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        } | {
+            type: "image";
+            imageUrl: string;
+        } | {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        } | {
+            type: "markdown";
+            markdown: string;
+        } | {
+            type: "text";
+            text: string;
+        } | {
+            type: "video";
+            videoUrl: string;
+        };
+        id: string;
+        userId: string;
+        conversationId: string;
+        createdAt: string;
+    }, {
+        payload: {
+            type: "audio";
+            audioUrl: string;
+        } | {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        } | {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        } | {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        } | {
+            type: "image";
+            imageUrl: string;
+        } | {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        } | {
+            type: "markdown";
+            markdown: string;
+        } | {
+            type: "text";
+            text: string;
+        } | {
+            type: "video";
+            videoUrl: string;
+        };
+        id: string;
+        userId: string;
+        conversationId: string;
+        createdAt: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "message_created";
+    data: {
+        payload: {
+            type: "audio";
+            audioUrl: string;
+        } | {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        } | {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        } | {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        } | {
+            type: "image";
+            imageUrl: string;
+        } | {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        } | {
+            type: "markdown";
+            markdown: string;
+        } | {
+            type: "text";
+            text: string;
+        } | {
+            type: "video";
+            videoUrl: string;
+        };
+        id: string;
+        userId: string;
+        conversationId: string;
+        createdAt: string;
+    };
+}, {
+    type: "message_created";
+    data: {
+        payload: {
+            type: "audio";
+            audioUrl: string;
+        } | {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        } | {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        } | {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        } | {
+            type: "image";
+            imageUrl: string;
+        } | {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        } | {
+            type: "markdown";
+            markdown: string;
+        } | {
+            type: "text";
+            text: string;
+        } | {
+            type: "video";
+            videoUrl: string;
+        };
+        id: string;
+        userId: string;
+        conversationId: string;
+        createdAt: string;
+    };
+}>;
+export default _default;

package/dist/gen/signals/webchatConfigSignal.j.d.ts

@@ -0,0 +1,24 @@
+declare const _default: {
+    type: string;
+    properties: {
+        type: {
+            type: string;
+            const: string;
+        };
+        data: {
+            type: string;
+            properties: {
+                config: {
+                    type: string;
+                    additionalProperties: {};
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+    $schema: string;
+};
+export default _default;

package/dist/gen/signals/webchatConfigSignal.t.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export interface WebchatConfigSignal {
+    type: "webchat_config";
+    data: {
+        config: {
+            [k: string]: any;
+        };
+    };
+}

package/dist/gen/signals/webchatConfigSignal.z.d.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+declare const _default: z.ZodObject<{
+    type: z.ZodLiteral<"webchat_config">;
+    data: z.ZodObject<{
+        config: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        config: Record<string, any>;
+    }, {
+        config: Record<string, any>;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "webchat_config";
+    data: {
+        config: Record<string, any>;
+    };
+}, {
+    type: "webchat_config";
+    data: {
+        config: Record<string, any>;
+    };
+}>;
+export default _default;

package/dist/gen/signals/webchatVisibilitySignal.j.d.ts

@@ -0,0 +1,24 @@
+declare const _default: {
+    type: string;
+    properties: {
+        type: {
+            type: string;
+            const: string;
+        };
+        data: {
+            type: string;
+            properties: {
+                visibility: {
+                    type: string;
+                    enum: string[];
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+    $schema: string;
+};
+export default _default;

package/dist/gen/signals/webchatVisibilitySignal.t.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export interface WebchatVisibilitySignal {
+    type: "webchat_visibility";
+    data: {
+        visibility: "show" | "hide" | "toggle";
+    };
+}

package/dist/gen/signals/webchatVisibilitySignal.z.d.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+declare const _default: z.ZodObject<{
+    type: z.ZodLiteral<"webchat_visibility">;
+    data: z.ZodObject<{
+        visibility: z.ZodEnum<["show", "hide", "toggle"]>;
+    }, "strip", z.ZodTypeAny, {
+        visibility: "show" | "hide" | "toggle";
+    }, {
+        visibility: "show" | "hide" | "toggle";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "webchat_visibility";
+    data: {
+        visibility: "show" | "hide" | "toggle";
+    };
+}, {
+    type: "webchat_visibility";
+    data: {
+        visibility: "show" | "hide" | "toggle";
+    };
+}>;
+export default _default;

package/dist/hooks/useClient.d.ts

@@ -1,8 +1,8 @@
-import { MessagingClient, WebChatClient } from '../client';
+import { MessagingClient, WebchatClient } from '../client';
 type UseClientOptions = {
-    mode: 'messaging' | 'chat';
+    mode: 'messaging' | 'pushpin';
     clientId: string;
     apiUrl: string;
 };
-export declare const useClient: ({ clientId, apiUrl, mode }: UseClientOptions) => WebChatClient | MessagingClient | undefined;
+export declare const useClient: ({ clientId, apiUrl, mode }: UseClientOptions) => WebchatClient | MessagingClient | undefined;
 export {};

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export * from './components';
 export * from './providers';
 export * from './types';
 export * from './themes';
-export { MessagingClient as Client } from './client/MessagingClient/client';
+export { MessagingClient, PushpinClient, type WebchatClient as WebChatClient } from './client';
 export { useWebchatContext } from './contexts';
 export { mergeThemes } from './utils';
 export { useClient } from './hooks';