@yourgpt/copilot-sdk 2.1.5-alpha.3 → 2.1.5-alpha.5

package/dist/experimental/index.d.ts

@@ -0,0 +1,924 @@
+import { z } from 'zod';
+import React__default from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface GenerativeUIToolConfig {
+    /**
+     * Override the default LLM description.
+     * The default instructs the model when to use each UI type.
+     */
+    description?: string;
+}
+/**
+ * Returns a tool definition compatible with `streamText` for use in your backend route.
+ *
+ * Pass the returned object as a value in the `tools` map of `streamText`.
+ * The key you use becomes the tool name — use the same name in `useGenerativeUI({ name })` on the frontend.
+ *
+ * @example
+ * ```ts
+ * import { streamText } from "@yourgpt/llm-sdk";
+ * import { generativeUITool } from "@yourgpt/copilot-sdk/experimental";
+ *
+ * const result = await streamText({
+ *   model: openai("gpt-4o"),
+ *   messages,
+ *   tools: {
+ *     render_ui: generativeUITool(),
+ *     // ...your other tools
+ *   },
+ * });
+ * ```
+ */
+declare function generativeUITool(config?: GenerativeUIToolConfig): {
+    description: string;
+    parameters: {
+        type: "object";
+        properties: {
+            type: {
+                type: "string";
+                enum: string[];
+                description: string;
+            };
+            html: {
+                type: "string";
+                description: string;
+            };
+            height: {
+                type: "string";
+            };
+            chartType: {
+                type: "string";
+                enum: string[];
+                description: string;
+            };
+            labels: {
+                type: "array";
+                items: {
+                    type: "string";
+                };
+                description: string;
+            };
+            datasets: {
+                type: "array";
+                items: {
+                    type: "object";
+                    properties: {
+                        label: {
+                            type: "string";
+                        };
+                        data: {
+                            type: "array";
+                            items: {
+                                type: "number";
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+                description: string;
+            };
+            xLabel: {
+                type: "string";
+            };
+            yLabel: {
+                type: "string";
+            };
+            columns: {
+                type: "array";
+                items: {
+                    type: "object";
+                    properties: {
+                        key: {
+                            type: "string";
+                        };
+                        label: {
+                            type: "string";
+                        };
+                        align: {
+                            type: "string";
+                        };
+                    };
+                    required: string[];
+                };
+                description: string;
+            };
+            rows: {
+                type: "array";
+                items: {
+                    type: "object";
+                };
+                description: string;
+            };
+            caption: {
+                type: "string";
+            };
+            stats: {
+                type: "array";
+                items: {
+                    type: "object";
+                    properties: {
+                        label: {
+                            type: "string";
+                        };
+                        value: {
+                            type: "string";
+                        };
+                        change: {
+                            type: "string";
+                        };
+                        changeDirection: {
+                            type: "string";
+                            enum: string[];
+                        };
+                        description: {
+                            type: "string";
+                        };
+                    };
+                    required: string[];
+                };
+                description: string;
+            };
+            title: {
+                type: "string";
+                description: string;
+            };
+            subtitle: {
+                type: "string";
+            };
+            body: {
+                type: "string";
+            };
+            fields: {
+                type: "array";
+                items: {
+                    type: "object";
+                    properties: {
+                        label: {
+                            type: "string";
+                        };
+                        value: {
+                            type: "string";
+                        };
+                        badge: {
+                            type: "boolean";
+                        };
+                    };
+                    required: string[];
+                };
+                description: string;
+            };
+            cta: {
+                type: "object";
+                properties: {
+                    label: {
+                        type: "string";
+                    };
+                    url: {
+                        type: "string";
+                    };
+                };
+                required: string[];
+                description: string;
+            };
+        };
+        required: string[];
+    };
+};
+
+declare const HtmlPayloadSchema: z.ZodObject<{
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+declare const ChartPayloadSchema: z.ZodObject<{
+    type: z.ZodLiteral<"chart">;
+    chartType: z.ZodEnum<["bar", "line", "pie", "area", "scatter"]>;
+    title: z.ZodOptional<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    datasets: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        data: z.ZodArray<z.ZodNumber, "many">;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }>, "many">;
+    xLabel: z.ZodOptional<z.ZodString>;
+    yLabel: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"chart">;
+    chartType: z.ZodEnum<["bar", "line", "pie", "area", "scatter"]>;
+    title: z.ZodOptional<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    datasets: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        data: z.ZodArray<z.ZodNumber, "many">;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }>, "many">;
+    xLabel: z.ZodOptional<z.ZodString>;
+    yLabel: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"chart">;
+    chartType: z.ZodEnum<["bar", "line", "pie", "area", "scatter"]>;
+    title: z.ZodOptional<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    datasets: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        data: z.ZodArray<z.ZodNumber, "many">;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }>, "many">;
+    xLabel: z.ZodOptional<z.ZodString>;
+    yLabel: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+declare const TablePayloadSchema: z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    title: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    caption: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"table">;
+    title: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    caption: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"table">;
+    title: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    caption: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+declare const StatPayloadSchema: z.ZodObject<{
+    type: z.ZodLiteral<"stat">;
+    title: z.ZodOptional<z.ZodString>;
+    stats: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"stat">;
+    title: z.ZodOptional<z.ZodString>;
+    stats: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"stat">;
+    title: z.ZodOptional<z.ZodString>;
+    stats: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+}, z.ZodTypeAny, "passthrough">>;
+declare const CardPayloadSchema: z.ZodObject<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        badge: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }>, "many">>;
+    cta: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>, {
+        label: string;
+        url: string;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        badge: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }>, "many">>;
+    cta: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>, {
+        label: string;
+        url: string;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        badge: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }>, "many">>;
+    cta: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>, {
+        label: string;
+        url: string;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>>;
+}, z.ZodTypeAny, "passthrough">>;
+/** Full discriminated union of all generative UI payload types */
+declare const GenerativeUIPayloadSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
+    type: z.ZodLiteral<"chart">;
+    chartType: z.ZodEnum<["bar", "line", "pie", "area", "scatter"]>;
+    title: z.ZodOptional<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    datasets: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        data: z.ZodArray<z.ZodNumber, "many">;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }>, "many">;
+    xLabel: z.ZodOptional<z.ZodString>;
+    yLabel: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"chart">;
+    chartType: z.ZodEnum<["bar", "line", "pie", "area", "scatter"]>;
+    title: z.ZodOptional<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    datasets: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        data: z.ZodArray<z.ZodNumber, "many">;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }>, "many">;
+    xLabel: z.ZodOptional<z.ZodString>;
+    yLabel: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"chart">;
+    chartType: z.ZodEnum<["bar", "line", "pie", "area", "scatter"]>;
+    title: z.ZodOptional<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    datasets: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        data: z.ZodArray<z.ZodNumber, "many">;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }, {
+        label: string;
+        data: number[];
+        color?: string | undefined;
+    }>, "many">;
+    xLabel: z.ZodOptional<z.ZodString>;
+    yLabel: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    title: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    caption: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"table">;
+    title: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    caption: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"table">;
+    title: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        key: z.ZodString;
+        label: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<["left", "right", "center"]>>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    caption: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
+    type: z.ZodLiteral<"stat">;
+    title: z.ZodOptional<z.ZodString>;
+    stats: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"stat">;
+    title: z.ZodOptional<z.ZodString>;
+    stats: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"stat">;
+    title: z.ZodOptional<z.ZodString>;
+    stats: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        change: z.ZodOptional<z.ZodString>;
+        changeDirection: z.ZodOptional<z.ZodEnum<["positive", "negative", "neutral"]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+}, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        badge: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }>, "many">>;
+    cta: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>, {
+        label: string;
+        url: string;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        badge: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }>, "many">>;
+    cta: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>, {
+        label: string;
+        url: string;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        badge: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }, {
+        label: string;
+        value: string | number | boolean;
+        badge?: boolean | undefined;
+    }>, "many">>;
+    cta: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>, {
+        label: string;
+        url: string;
+        text?: string | undefined;
+    }, {
+        url: string;
+        label?: string | undefined;
+        text?: string | undefined;
+    }>>;
+}, z.ZodTypeAny, "passthrough">>]>;
+type HtmlPayload = z.infer<typeof HtmlPayloadSchema>;
+type ChartPayload = z.infer<typeof ChartPayloadSchema>;
+type TablePayload = z.infer<typeof TablePayloadSchema>;
+type StatPayload = z.infer<typeof StatPayloadSchema>;
+type CardPayload = z.infer<typeof CardPayloadSchema>;
+type GenerativeUIPayload = z.infer<typeof GenerativeUIPayloadSchema>;
+/** Props passed to user-supplied chart renderer */
+interface ChartRendererProps {
+    payload: ChartPayload;
+}
+/** Config for useGenerativeUI hook */
+interface UseGenerativeUIConfig {
+    /**
+     * Tool name — must match the key used in generativeUITool() on the server.
+     * @default "render_ui"
+     */
+    name?: string;
+    /**
+     * Renderer for chart payloads. The SDK does not bundle a chart library.
+     * Pass your own Recharts / Chart.js / Victory component here.
+     * If omitted, chart results show a JSON data fallback.
+     *
+     * @example
+     * ```tsx
+     * chartRenderer={({ payload }) => (
+     *   <BarChart data={payload.datasets} xLabels={payload.labels} />
+     * )}
+     * ```
+     */
+    chartRenderer?: React__default.ComponentType<ChartRendererProps>;
+    /**
+     * Override any built-in renderer per type.
+     * Useful when you want custom styling while keeping the SDK's schema validation.
+     */
+    overrideRenderers?: Partial<{
+        html: React__default.ComponentType<{
+            payload: HtmlPayload;
+        }>;
+        chart: React__default.ComponentType<ChartRendererProps>;
+        table: React__default.ComponentType<{
+            payload: TablePayload;
+        }>;
+        stat: React__default.ComponentType<{
+            payload: StatPayload;
+        }>;
+        card: React__default.ComponentType<{
+            payload: CardPayload;
+        }>;
+    }>;
+}
+
+/**
+ * Register the generative UI tool and attach built-in renderers for all payload types.
+ *
+ * Must be called inside a `CopilotProvider`. The `name` must match
+ * the key used for `generativeUITool()` in your backend `streamText` tools map.
+ *
+ * @example
+ * ```tsx
+ * import { useGenerativeUI } from "@yourgpt/copilot-sdk/experimental";
+ *
+ * function App() {
+ *   useGenerativeUI({
+ *     chartRenderer: ({ payload }) => (
+ *       <BarChart labels={payload.labels} datasets={payload.datasets} />
+ *     ),
+ *   });
+ *   return <CopilotChat />;
+ * }
+ * ```
+ *
+ * @experimental This API may change without a semver major bump.
+ */
+declare function useGenerativeUI(config?: UseGenerativeUIConfig): void;
+
+interface HtmlRendererProps {
+    payload: HtmlPayload;
+    className?: string;
+}
+/**
+ * Renders AI-generated HTML inside an isolated iframe.
+ * Tailwind CSS is loaded via CDN — iframes provide a full document context
+ * so the Tailwind Play CDN can scan and style classes correctly.
+ */
+declare function HtmlRenderer({ payload, className }: HtmlRendererProps): react_jsx_runtime.JSX.Element;
+
+interface TableRendererProps {
+    payload: TablePayload;
+    className?: string;
+}
+declare function TableRenderer({ payload, className }: TableRendererProps): react_jsx_runtime.JSX.Element;
+
+interface StatRendererProps {
+    payload: StatPayload;
+    className?: string;
+}
+declare function StatRenderer({ payload, className }: StatRendererProps): react_jsx_runtime.JSX.Element;
+
+interface CardRendererProps {
+    payload: CardPayload;
+    className?: string;
+}
+declare function CardRenderer({ payload, className }: CardRendererProps): react_jsx_runtime.JSX.Element;
+
+export { type CardPayload, CardPayloadSchema, CardRenderer, type ChartPayload, ChartPayloadSchema, type ChartRendererProps, type GenerativeUIPayload, GenerativeUIPayloadSchema, type GenerativeUIToolConfig, type HtmlPayload, HtmlPayloadSchema, HtmlRenderer, type StatPayload, StatPayloadSchema, StatRenderer, type TablePayload, TablePayloadSchema, TableRenderer, type UseGenerativeUIConfig, generativeUITool, useGenerativeUI };