@holocronlab/botruntime-sdk 6.13.3

package/dist/message.d.ts

@@ -0,0 +1,742 @@
+import { z } from './zui';
+/**
+ * @deprecated use `text` instead
+ */
+export declare const markdown: {
+    schema: z.ZodObject<{
+        markdown: z.ZodString;
+    }, "strip", {
+        markdown: string;
+    }, {
+        markdown: string;
+    }>;
+};
+/**
+ * Bloc message that still includes markdown as an item
+ *
+ * @deprecated use `bloc` instead
+ */
+export declare const markdownBloc: {
+    schema: z.ZodObject<{
+        items: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            payload: z.ZodObject<{
+                text: z.ZodString;
+            }, "strip", {
+                text: string;
+            }, {
+                text: string;
+            }>;
+        }, "strip", {
+            type: "text";
+            payload: {
+                text: string;
+            };
+        }, {
+            type: "text";
+            payload: {
+                text: string;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"image">;
+            payload: z.ZodObject<{
+                imageUrl: z.ZodString;
+                title: z.ZodOptional<z.ZodString>;
+            }, "strip", {
+                imageUrl: string;
+                title?: string | undefined;
+            }, {
+                imageUrl: string;
+                title?: string | undefined;
+            }>;
+        }, "strip", {
+            type: "image";
+            payload: {
+                imageUrl: string;
+                title?: string | undefined;
+            };
+        }, {
+            type: "image";
+            payload: {
+                imageUrl: string;
+                title?: string | undefined;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"audio">;
+            payload: z.ZodObject<{
+                audioUrl: z.ZodString;
+                title: z.ZodOptional<z.ZodString>;
+            }, "strip", {
+                audioUrl: string;
+                title?: string | undefined;
+            }, {
+                audioUrl: string;
+                title?: string | undefined;
+            }>;
+        }, "strip", {
+            type: "audio";
+            payload: {
+                audioUrl: string;
+                title?: string | undefined;
+            };
+        }, {
+            type: "audio";
+            payload: {
+                audioUrl: string;
+                title?: string | undefined;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"video">;
+            payload: z.ZodObject<{
+                videoUrl: z.ZodString;
+                title: z.ZodOptional<z.ZodString>;
+            }, "strip", {
+                videoUrl: string;
+                title?: string | undefined;
+            }, {
+                videoUrl: string;
+                title?: string | undefined;
+            }>;
+        }, "strip", {
+            type: "video";
+            payload: {
+                videoUrl: string;
+                title?: string | undefined;
+            };
+        }, {
+            type: "video";
+            payload: {
+                videoUrl: string;
+                title?: string | undefined;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"file">;
+            payload: z.ZodObject<{
+                fileUrl: z.ZodString;
+                title: z.ZodOptional<z.ZodString>;
+            }, "strip", {
+                fileUrl: string;
+                title?: string | undefined;
+            }, {
+                fileUrl: string;
+                title?: string | undefined;
+            }>;
+        }, "strip", {
+            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", {
+                latitude: number;
+                longitude: number;
+                title?: string | undefined;
+                address?: string | undefined;
+            }, {
+                latitude: number;
+                longitude: number;
+                title?: string | undefined;
+                address?: string | undefined;
+            }>;
+        }, "strip", {
+            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;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"markdown">;
+            payload: z.ZodObject<{
+                markdown: z.ZodString;
+            }, "strip", {
+                markdown: string;
+            }, {
+                markdown: string;
+            }>;
+        }, "strip", {
+            type: "markdown";
+            payload: {
+                markdown: string;
+            };
+        }, {
+            type: "markdown";
+            payload: {
+                markdown: string;
+            };
+        }>]>, "many">;
+    }, "strip", {
+        items: ({
+            type: "text";
+            payload: {
+                text: string;
+            };
+        } | {
+            type: "image";
+            payload: {
+                imageUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "audio";
+            payload: {
+                audioUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "video";
+            payload: {
+                videoUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "file";
+            payload: {
+                fileUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "location";
+            payload: {
+                latitude: number;
+                longitude: number;
+                title?: string | undefined;
+                address?: string | undefined;
+            };
+        } | {
+            type: "markdown";
+            payload: {
+                markdown: string;
+            };
+        })[];
+    }, {
+        items: ({
+            type: "text";
+            payload: {
+                text: string;
+            };
+        } | {
+            type: "image";
+            payload: {
+                imageUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "audio";
+            payload: {
+                audioUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "video";
+            payload: {
+                videoUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "file";
+            payload: {
+                fileUrl: string;
+                title?: string | undefined;
+            };
+        } | {
+            type: "location";
+            payload: {
+                latitude: number;
+                longitude: number;
+                title?: string | undefined;
+                address?: string | undefined;
+            };
+        } | {
+            type: "markdown";
+            payload: {
+                markdown: string;
+            };
+        })[];
+    }>;
+};
+export declare const defaults: {
+    readonly text: {
+        readonly schema: z.ZodObject<{
+            text: z.ZodString;
+        }, "strip", {
+            text: string;
+        }, {
+            text: string;
+        }>;
+    };
+    readonly image: {
+        readonly schema: z.ZodObject<{
+            imageUrl: z.ZodString;
+            title: z.ZodOptional<z.ZodString>;
+        }, "strip", {
+            imageUrl: string;
+            title?: string | undefined;
+        }, {
+            imageUrl: string;
+            title?: string | undefined;
+        }>;
+    };
+    readonly audio: {
+        readonly schema: z.ZodObject<{
+            audioUrl: z.ZodString;
+            title: z.ZodOptional<z.ZodString>;
+        }, "strip", {
+            audioUrl: string;
+            title?: string | undefined;
+        }, {
+            audioUrl: string;
+            title?: string | undefined;
+        }>;
+    };
+    readonly video: {
+        readonly schema: z.ZodObject<{
+            videoUrl: z.ZodString;
+            title: z.ZodOptional<z.ZodString>;
+        }, "strip", {
+            videoUrl: string;
+            title?: string | undefined;
+        }, {
+            videoUrl: string;
+            title?: string | undefined;
+        }>;
+    };
+    readonly file: {
+        readonly schema: z.ZodObject<{
+            fileUrl: z.ZodString;
+            title: z.ZodOptional<z.ZodString>;
+        }, "strip", {
+            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", {
+            latitude: number;
+            longitude: number;
+            title?: string | undefined;
+            address?: string | undefined;
+        }, {
+            latitude: number;
+            longitude: number;
+            title?: string | undefined;
+            address?: 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", {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }, {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }>, "many">;
+            }, "strip", {
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }, {
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }>, "many">;
+        }, "strip", {
+            items: {
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        }, {
+            items: {
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: 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", {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }, {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }>, "many">;
+        }, "strip", {
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            title: string;
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        }, {
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            title: 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", {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+        }, "strip", {
+            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", {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+        }, "strip", {
+            text: string;
+            options: {
+                value: string;
+                label: string;
+            }[];
+        }, {
+            text: string;
+            options: {
+                value: string;
+                label: string;
+            }[];
+        }>;
+    };
+    readonly bloc: {
+        readonly schema: z.ZodObject<{
+            items: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"text">;
+                payload: z.ZodObject<{
+                    text: z.ZodString;
+                }, "strip", {
+                    text: string;
+                }, {
+                    text: string;
+                }>;
+            }, "strip", {
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            }, {
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"image">;
+                payload: z.ZodObject<{
+                    imageUrl: z.ZodString;
+                    title: z.ZodOptional<z.ZodString>;
+                }, "strip", {
+                    imageUrl: string;
+                    title?: string | undefined;
+                }, {
+                    imageUrl: string;
+                    title?: string | undefined;
+                }>;
+            }, "strip", {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                    title?: string | undefined;
+                };
+            }, {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                    title?: string | undefined;
+                };
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"audio">;
+                payload: z.ZodObject<{
+                    audioUrl: z.ZodString;
+                    title: z.ZodOptional<z.ZodString>;
+                }, "strip", {
+                    audioUrl: string;
+                    title?: string | undefined;
+                }, {
+                    audioUrl: string;
+                    title?: string | undefined;
+                }>;
+            }, "strip", {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    title?: string | undefined;
+                };
+            }, {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    title?: string | undefined;
+                };
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"video">;
+                payload: z.ZodObject<{
+                    videoUrl: z.ZodString;
+                    title: z.ZodOptional<z.ZodString>;
+                }, "strip", {
+                    videoUrl: string;
+                    title?: string | undefined;
+                }, {
+                    videoUrl: string;
+                    title?: string | undefined;
+                }>;
+            }, "strip", {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    title?: string | undefined;
+                };
+            }, {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    title?: string | undefined;
+                };
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"file">;
+                payload: z.ZodObject<{
+                    fileUrl: z.ZodString;
+                    title: z.ZodOptional<z.ZodString>;
+                }, "strip", {
+                    fileUrl: string;
+                    title?: string | undefined;
+                }, {
+                    fileUrl: string;
+                    title?: string | undefined;
+                }>;
+            }, "strip", {
+                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", {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                }, {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                }>;
+            }, "strip", {
+                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", {
+            items: ({
+                type: "text";
+                payload: {
+                    text: string;
+                };
+            } | {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                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: "image";
+                payload: {
+                    imageUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string | undefined;
+                };
+            } | {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    title?: string | undefined;
+                    address?: string | undefined;
+                };
+            })[];
+        }>;
+    };
+};