@pebble-software/bonsai 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -13,7 +13,7 @@ declare interface BonsaiProps {
     template: Config;
     data?: any;
     status?: "pending" | "captured" | "completed" | "error" | "revoked";
-    render?: "web" | "pdf" | "preview";
+    render?: RenderMode;
     registry?: BonsaiRegistry;
 }
 
@@ -37,7 +37,6 @@ declare enum COMPONENT {
     OL = "ol",
     UL = "ul",
     LI = "li",
-    MAP = "map",
     DIV = "div",
     SPAN = "span",
     ACCORDION = "accordion",
@@ -156,7 +155,29 @@ export declare const EXTRACTOR_ALLOWLIST: Record<string, (eventOrValue: unknown)
  */
 export declare type JsonSchema = Record<string, unknown>;
 
-export declare function jsonSchemaToZod(schema: JsonSchema): z.ZodType<unknown>;
+export declare function jsonSchemaToZod(schema: JsonSchema, options?: JsonSchemaToZodOptions): z.ZodType<unknown>;
+
+declare interface JsonSchemaToZodOptions {
+    /**
+     * Accept a `"{{expression}}"` binding anywhere a typed value is declared.
+     *
+     * A template author writes `checked: "{{form.agree}}"` and the binding is resolved at
+     * render time, long after validation runs — so a schema saying `{"type":"boolean"}`
+     * rejects a template that would render perfectly. The hand-rolled registry has always
+     * worked around this by declaring `z.union([z.string(), z.boolean()])` by hand on every
+     * affected prop. This is that convention made available to manifests whose schemas were
+     * machine-derived from component sources and so cannot hand-write it.
+     *
+     * Opt-in rather than automatic: `bonsai.generated.json` doubles as an LLM tool
+     * definition, and a prop that reads "boolean" there is worth keeping precise.
+     *
+     * Narrower than the hand-rolled convention on purpose — only binding-*shaped* strings
+     * are admitted, not every string. `{"type":"string","minLength":1}` therefore still
+     * rejects `""`, and an `enum` still rejects a value outside it, both of which a blanket
+     * `z.string()` union would silently discard.
+     */
+    allowBindings?: boolean;
+}
 
 export declare interface LoadManifestOptions extends ResolveManifestOptions {
     allowedOrigins?: string[];
@@ -282,6 +303,8 @@ export declare interface RegistryValidationResult {
     warnings: string[];
 }
 
+declare type RenderMode = "web" | "pdf" | "preview";
+
 export declare function resolveManifest(manifest: RegistryManifest, options: ResolveManifestOptions): BonsaiRegistry;
 
 export declare interface ResolveManifestOptions {