@yourgpt/copilot-sdk 2.1.8 → 2.1.9-alpha.0

package/dist/experimental/index.d.cts

@@ -1,191 +1,7 @@
+import * as React from 'react';
 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;
@@ -202,309 +18,7 @@ declare const HtmlPayloadSchema: z.ZodObject<{
     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<{
+declare const GenerativeUIPayloadSchema: z.ZodObject<{
     type: z.ZodLiteral<"html">;
     html: z.ZodString;
     title: z.ZodOptional<z.ZodString>;
@@ -519,406 +33,228 @@ declare const GenerativeUIPayloadSchema: z.ZodDiscriminatedUnion<"type", [z.ZodO
     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">>]>;
+}, 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 */
+type GenerativeUIPayload = HtmlPayload;
+/**
+ * Action handler called when the AI-generated iframe triggers
+ * `copilot.action(name, data)` via the bridge API.
+ */
+type GenUIActionHandler = (data: unknown) => unknown | Promise<unknown>;
+/**
+ * Config for the `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.
+     * Custom actions available inside the iframe.
+     * The AI can call these via `copilot.action('name', data)` in onclick handlers.
      *
      * @example
      * ```tsx
-     * chartRenderer={({ payload }) => (
-     *   <BarChart data={payload.datasets} xLabels={payload.labels} />
-     * )}
+     * useGenerativeUI({
+     *   actions: {
+     *     addToCart: (data) => cartStore.add(data.itemId),
+     *     navigate: (data) => router.push(data.url),
+     *   },
+     * })
      * ```
      */
-    chartRenderer?: React__default.ComponentType<ChartRendererProps>;
+    actions?: Record<string, GenUIActionHandler>;
     /**
-     * Override any built-in renderer per type.
-     * Useful when you want custom styling while keeping the SDK's schema validation.
+     * Max width of the iframe (CSS value).
+     * @default undefined (takes full available width)
      */
-    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;
-        }>;
-    }>;
+    maxWidth?: string;
+}
+/**
+ * A processed message that may contain a `<GENUI>` block.
+ */
+interface GenUIMessage {
+    id: string;
+    role: string;
+    content: string | null;
+    _genui?: {
+        html: string;
+        streaming: boolean;
+        textBefore: string;
+        textAfter: string;
+    };
+    [key: string]: unknown;
 }
 
 /**
- * Register the generative UI tool and attach built-in renderers for all payload types.
+ * Hook that enables generative UI rendering in CopilotChat.
  *
- * Must be called inside a `CopilotProvider`. The `name` must match
- * the key used for `generativeUITool()` in your backend `streamText` tools map.
+ * Detects `<GENUI>...</GENUI>` blocks in assistant messages and
+ * renders them as interactive HTML in sandboxed iframes with
+ * Tailwind CSS and Chart.js.
+ *
+ * Returns a `wrapMessage` function to pass to `<CopilotChat>`.
  *
  * @example
  * ```tsx
  * import { useGenerativeUI } from "@yourgpt/copilot-sdk/experimental";
  *
  * function App() {
- *   useGenerativeUI({
- *     chartRenderer: ({ payload }) => (
- *       <BarChart labels={payload.labels} datasets={payload.datasets} />
- *     ),
- *   });
- *   return <CopilotChat />;
+ *   const { wrapMessage } = useGenerativeUI();
+ *   return <CopilotChat wrapMessage={wrapMessage} />;
  * }
  * ```
  *
+ * @example With actions (interactive iframe → parent communication)
+ * ```tsx
+ * const { wrapMessage } = useGenerativeUI({
+ *   actions: {
+ *     addToCart: (data) => cartStore.add(data.itemId),
+ *     navigate: (data) => router.push(data.url),
+ *   },
+ * });
+ * ```
+ *
  * @experimental This API may change without a semver major bump.
  */
-declare function useGenerativeUI(config?: UseGenerativeUIConfig): void;
+declare function useGenerativeUI(config?: UseGenerativeUIConfig): {
+    wrapMessage: (content: React.ReactNode, message: {
+        id: string;
+        role: string;
+    }) => React.ReactNode;
+};
 
-interface HtmlRendererProps {
-    payload: HtmlPayload;
-    className?: string;
+/**
+ * Options for generating the generative UI system prompt.
+ */
+interface GenerativeUIPromptOptions {
+    /**
+     * Custom actions available inside the iframe via `copilot.action(name, data)`.
+     * Keys are action names, values are descriptions for the AI.
+     *
+     * @example
+     * ```ts
+     * generativeUISystemPrompt({
+     *   actions: {
+     *     addToCart: "Add an item to the shopping cart. Params: { itemId: string, qty: number }",
+     *     navigate: "Navigate to a URL. Params: { url: string }",
+     *   }
+     * })
+     * ```
+     */
+    actions?: Record<string, string>;
+    /**
+     * Additional design guidelines appended to the prompt.
+     */
+    designGuidelines?: 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.
+ * Returns a system prompt string that instructs the LLM to generate
+ * rich HTML UI wrapped in `<GENUI>` tags.
+ *
+ * The generated HTML renders in a sandboxed iframe with Tailwind CSS
+ * and Chart.js pre-loaded.
+ *
+ * @example
+ * ```ts
+ * import { generativeUISystemPrompt } from "@yourgpt/copilot-sdk/experimental";
+ *
+ * const runtime = createRuntime({
+ *   systemPrompt: `You are a helpful assistant. ${generativeUISystemPrompt()}`,
+ * });
+ * ```
+ *
+ * @experimental
  */
-declare function HtmlRenderer({ payload, className }: HtmlRendererProps): react_jsx_runtime.JSX.Element;
+declare function generativeUISystemPrompt(options?: GenerativeUIPromptOptions): string;
 
-interface TableRendererProps {
-    payload: TablePayload;
+interface GenUIFrameProps {
+    /** HTML content to render inside the iframe */
+    html: string;
+    /** Whether the content is still streaming (defers scripts, strips last incomplete line) */
+    streaming?: boolean;
+    /** CSS class applied to the iframe */
     className?: string;
+    /** Max width of the iframe (default: none) */
+    maxWidth?: string;
+    /** Theme CSS variables to inject into the iframe (e.g. from getComputedStyle(document.documentElement)) */
+    themeVars?: Record<string, string>;
+    /** Callback when a copilot.sendMessage() is called from inside the iframe */
+    onSendMessage?: (message: string) => void;
+    /** Callback when a copilot.action() is called from inside the iframe */
+    onAction?: (name: string, data: unknown) => unknown | Promise<unknown>;
 }
-declare function TableRenderer({ payload, className }: TableRendererProps): react_jsx_runtime.JSX.Element;
+/**
+ * Sandboxed iframe renderer for AI-generated HTML.
+ *
+ * Features:
+ * - Static shell loaded once (Tailwind CSS + Chart.js CDN)
+ * - Content pushed via postMessage (no iframe reloads on update)
+ * - Auto-height via ResizeObserver
+ * - Unique frame ID prevents cross-iframe interference
+ * - Scripts deferred during streaming, executed on completion
+ * - Theme vars injected via postMessage (not baked into srcDoc)
+ * - `window.copilot` bridge for iframe → parent communication
+ *
+ * @experimental
+ */
+declare function GenUIFrame({ html, streaming, className, maxWidth, themeVars, onSendMessage, onAction, }: GenUIFrameProps): react_jsx_runtime.JSX.Element;
 
-interface StatRendererProps {
-    payload: StatPayload;
-    className?: string;
+interface GenerativeUIToolConfig {
+    /**
+     * Override the default LLM description.
+     */
+    description?: string;
 }
-declare function StatRenderer({ payload, className }: StatRendererProps): react_jsx_runtime.JSX.Element;
+/**
+ * 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: {
+            html: {
+                type: "string";
+                description: string;
+            };
+            title: {
+                type: "string";
+                description: string;
+            };
+            height: {
+                type: "string";
+                description: string;
+            };
+        };
+        required: string[];
+    };
+};
 
-interface CardRendererProps {
-    payload: CardPayload;
+interface HtmlRendererProps {
+    payload: HtmlPayload;
     className?: string;
+    /** When true, defers script execution and strips the last incomplete line */
+    streaming?: boolean;
 }
-declare function CardRenderer({ payload, className }: CardRendererProps): react_jsx_runtime.JSX.Element;
+/**
+ * Renders AI-generated HTML inside an isolated iframe.
+ * Uses srcdoc for simplicity and reliability.
+ */
+declare function HtmlRenderer({ payload, className, streaming, }: HtmlRendererProps): 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 };
+export { type GenUIActionHandler, GenUIFrame, type GenUIFrameProps, type GenUIMessage, type GenerativeUIPayload, GenerativeUIPayloadSchema, type GenerativeUIPromptOptions, type GenerativeUIToolConfig, type HtmlPayload, HtmlPayloadSchema, HtmlRenderer, type UseGenerativeUIConfig, generativeUISystemPrompt, generativeUITool, useGenerativeUI };