@formspec/build 0.1.0-alpha.2 → 0.1.0-alpha.21

package/dist/build.d.ts

@@ -0,0 +1,1144 @@
+/**
+ * `@formspec/build` - Build tools for FormSpec
+ *
+ * This package provides generators to compile FormSpec forms into:
+ * - JSON Schema 2020-12 (for validation)
+ * - JSON Forms UI Schema (for rendering)
+ *
+ * @example
+ * ```typescript
+ * import { buildFormSchemas } from "@formspec/build";
+ * import { formspec, field, group } from "@formspec/dsl";
+ *
+ * const form = formspec(
+ *   group("Customer",
+ *     field.text("name", { label: "Name", required: true }),
+ *     field.text("email", { label: "Email" }),
+ *   ),
+ * );
+ *
+ * const { jsonSchema, uiSchema } = buildFormSchemas(form);
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+import type { BuiltinConstraintBroadeningRegistration } from '@formspec/core';
+import type { ConstraintTagRegistration } from '@formspec/core';
+import type { CustomAnnotationRegistration } from '@formspec/core';
+import type { CustomConstraintRegistration } from '@formspec/core';
+import type { CustomTypeRegistration } from '@formspec/core';
+import type { ExtensionDefinition } from '@formspec/core';
+import type { FormElement } from '@formspec/core';
+import type { FormIR } from '@formspec/core';
+import type { FormSpec } from '@formspec/core';
+import type { JsonValue } from '@formspec/core';
+import { z } from 'zod';
+
+/**
+ * Builds both JSON Schema and UI Schema from a FormSpec.
+ *
+ * This is a convenience function that combines `generateJsonSchema`
+ * and `generateUiSchema`.
+ *
+ * @example
+ * ```typescript
+ * const form = formspec(
+ *   field.text("name", { required: true }),
+ *   field.number("age", { min: 0 }),
+ * );
+ *
+ * const { jsonSchema, uiSchema } = buildFormSchemas(form);
+ *
+ * // Use with JSON Forms renderer
+ * <JsonForms
+ *   schema={jsonSchema}
+ *   uischema={uiSchema}
+ *   data={formData}
+ *   renderers={materialRenderers}
+ * />
+ * ```
+ *
+ * @param form - The FormSpec to build schemas from
+ * @returns Object containing both jsonSchema and uiSchema
+ *
+ * @public
+ */
+export declare function buildFormSchemas<E extends readonly FormElement[]>(form: FormSpec<E>, options?: BuildFormSchemasOptions): BuildResult;
+
+/**
+ * Options for building schemas from a FormSpec.
+ *
+ * Currently identical to `GenerateJsonSchemaOptions`. Defined separately so the
+ * Chain DSL surface can grow independently in the future if needed.
+ *
+ * @public
+ */
+export declare type BuildFormSchemasOptions = GenerateJsonSchemaOptions;
+
+/**
+ * Builds JSON Schema and UI Schema from a TSDoc-derived model with ChainDSL
+ * field overlays.
+ *
+ * Overlays are matched by field name. The static model wins for structure,
+ * ordering, and constraints; ChainDSL overlays may contribute dynamic runtime
+ * field metadata such as dynamic enum or dynamic schema keywords, and may fill
+ * in missing annotations.
+ *
+ * @public
+ */
+export declare function buildMixedAuthoringSchemas(options: BuildMixedAuthoringSchemasOptions): MixedAuthoringSchemas;
+
+/**
+ * Options for generating mixed-authoring schemas.
+ *
+ * The `typeName` can resolve to a class, interface, or object type alias, just
+ * like `generateSchemas()`.
+ *
+ * @public
+ */
+export declare interface BuildMixedAuthoringSchemasOptions extends GenerateJsonSchemaFromIROptions {
+    /** Path to the TypeScript source file. */
+    readonly filePath: string;
+    /** Name of the class, interface, or type alias to analyze. */
+    readonly typeName: string;
+    /** ChainDSL overlays to apply to the static model. Groups and conditionals are flattened by field name. */
+    readonly overlays: FormSpec<readonly FormElement[]>;
+}
+
+/**
+ * Result of building form schemas.
+ *
+ * @public
+ */
+export declare interface BuildResult {
+    /** JSON Schema 2020-12 for validation */
+    readonly jsonSchema: JsonSchema2020;
+    /** JSON Forms UI Schema for rendering */
+    readonly uiSchema: UISchema;
+}
+
+/**
+ * A Categorization element (tab-based layout).
+ *
+ * @public
+ */
+export declare interface Categorization {
+    type: "Categorization";
+    elements: Category[];
+    label?: string | undefined;
+    rule?: Rule | undefined;
+    options?: Record<string, unknown> | undefined;
+    [k: string]: unknown;
+}
+
+/**
+ * Zod schema for a categorization element.
+ *
+ * @public
+ */
+export declare const categorizationSchema: z.ZodType<Categorization>;
+
+/**
+ * A Category element, used inside a Categorization layout.
+ *
+ * @public
+ */
+export declare interface Category {
+    type: "Category";
+    label: string;
+    elements: UISchemaElement[];
+    rule?: Rule | undefined;
+    options?: Record<string, unknown> | undefined;
+    [k: string]: unknown;
+}
+
+/**
+ * Zod schema for a category element.
+ *
+ * @public
+ */
+export declare const categorySchema: z.ZodType<Category>;
+
+/**
+ * Generated schemas for a class.
+ *
+ * @public
+ */
+export declare interface ClassSchemas {
+    /** JSON Schema 2020-12 for validation */
+    jsonSchema: JsonSchema2020;
+    /** JSON Forms UI Schema for rendering */
+    uiSchema: UISchema;
+}
+
+/**
+ * A Control element that binds to a JSON Schema property.
+ *
+ * @public
+ */
+export declare type ControlElement = z.infer<typeof controlSchema>;
+
+/**
+ * Zod schema for a Control element.
+ *
+ * @public
+ */
+export declare const controlSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Control">;
+    scope: z.ZodString;
+    label: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<false>]>>;
+    rule: z.ZodOptional<z.ZodObject<{
+        effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+        condition: z.ZodObject<{
+            scope: z.ZodString;
+            schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+        }, "strict", z.ZodTypeAny, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"Control">;
+    scope: z.ZodString;
+    label: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<false>]>>;
+    rule: z.ZodOptional<z.ZodObject<{
+        effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+        condition: z.ZodObject<{
+            scope: z.ZodString;
+            schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+        }, "strict", z.ZodTypeAny, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"Control">;
+    scope: z.ZodString;
+    label: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<false>]>>;
+    rule: z.ZodOptional<z.ZodObject<{
+        effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+        condition: z.ZodObject<{
+            scope: z.ZodString;
+            schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+        }, "strict", z.ZodTypeAny, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.ZodTypeAny, "passthrough">>;
+
+/**
+ * Creates an extension registry from a list of extension definitions.
+ *
+ * The registry indexes all types, constraints, and annotations by their
+ * fully-qualified IDs (`<extensionId>/<name>`) for O(1) lookup during
+ * generation and validation.
+ *
+ * @param extensions - The extension definitions to register.
+ * @returns An {@link ExtensionRegistry} instance.
+ * @throws If duplicate type/constraint/annotation IDs are detected across extensions.
+ *
+ * @public
+ */
+export declare function createExtensionRegistry(extensions: readonly ExtensionDefinition[]): ExtensionRegistry;
+
+/**
+ * JSON Schema with FormSpec extension properties for arbitrary `x-formspec-*` keys.
+ *
+ * @public
+ */
+export declare type ExtendedJSONSchema7 = JSONSchema7 & FormSpecSchemaExtensions;
+
+/**
+ * A registry of extensions that provides lookup by fully-qualified ID.
+ *
+ * Type IDs follow the format: `<extensionId>/<typeName>`
+ * Constraint IDs follow the format: `<extensionId>/<constraintName>`
+ * Annotation IDs follow the format: `<extensionId>/<annotationName>`
+ *
+ * @public
+ */
+export declare interface ExtensionRegistry {
+    /** The extensions registered in this registry (in registration order). */
+    readonly extensions: readonly ExtensionDefinition[];
+    /**
+     * Look up a custom type registration by its fully-qualified type ID.
+     *
+     * @param typeId - The fully-qualified type ID (e.g., "x-stripe/monetary/Decimal").
+     * @returns The registration if found, otherwise `undefined`.
+     */
+    findType(typeId: string): CustomTypeRegistration | undefined;
+    /**
+     * Look up a custom type registration by a TypeScript-facing type name.
+     *
+     * This is used during TSDoc/class analysis to resolve extension-defined
+     * custom types from source-level declarations.
+     */
+    findTypeByName(typeName: string): {
+        readonly extensionId: string;
+        readonly registration: CustomTypeRegistration;
+    } | undefined;
+    /**
+     * Look up a custom constraint registration by its fully-qualified constraint ID.
+     *
+     * @param constraintId - The fully-qualified constraint ID.
+     * @returns The registration if found, otherwise `undefined`.
+     */
+    findConstraint(constraintId: string): CustomConstraintRegistration | undefined;
+    /**
+     * Look up a TSDoc custom constraint-tag registration by tag name.
+     */
+    findConstraintTag(tagName: string): {
+        readonly extensionId: string;
+        readonly registration: ConstraintTagRegistration;
+    } | undefined;
+    /**
+     * Look up built-in tag broadening for a given custom type ID.
+     */
+    findBuiltinConstraintBroadening(typeId: string, tagName: string): {
+        readonly extensionId: string;
+        readonly registration: BuiltinConstraintBroadeningRegistration;
+    } | undefined;
+    /**
+     * Look up a custom annotation registration by its fully-qualified annotation ID.
+     *
+     * @param annotationId - The fully-qualified annotation ID.
+     * @returns The registration if found, otherwise `undefined`.
+     */
+    findAnnotation(annotationId: string): CustomAnnotationRegistration | undefined;
+}
+
+/**
+ * Extension properties for custom FormSpec constraint tags.
+ *
+ * @public
+ */
+export declare type FormSpecSchemaExtensions = Record<`x-formspec-${string}`, unknown>;
+
+/**
+ * Options for generating schemas from a decorated class.
+ *
+ * @public
+ */
+export declare interface GenerateFromClassOptions extends GenerateJsonSchemaFromIROptions {
+    /** Path to the TypeScript source file */
+    filePath: string;
+    /** Class name to analyze */
+    className: string;
+}
+
+/**
+ * Result of generating schemas from a decorated class.
+ *
+ * @public
+ */
+export declare interface GenerateFromClassResult {
+    /** JSON Schema 2020-12 for validation */
+    jsonSchema: JsonSchema2020;
+    /** JSON Forms UI Schema for rendering */
+    uiSchema: UISchema;
+}
+
+/**
+ * Generates a JSON Schema 2020-12 from a FormSpec.
+ *
+ * All generation routes through the canonical IR. The chain DSL is first
+ * canonicalized to a FormIR, then the IR-based generator produces the schema.
+ *
+ * @example
+ * ```typescript
+ * const form = formspec(
+ *   field.text("name", { label: "Name", required: true }),
+ *   field.number("age", { min: 0 }),
+ * );
+ *
+ * const schema = generateJsonSchema(form);
+ * // {
+ * //   $schema: "https://json-schema.org/draft/2020-12/schema",
+ * //   type: "object",
+ * //   properties: {
+ * //     name: { type: "string", title: "Name" },
+ * //     age: { type: "number", minimum: 0 }
+ * //   },
+ * //   required: ["name"]
+ * // }
+ * ```
+ *
+ * @param form - The FormSpec to convert
+ * @returns A JSON Schema 2020-12 object
+ *
+ * @public
+ */
+export declare function generateJsonSchema<E extends readonly FormElement[]>(form: FormSpec<E>, options?: GenerateJsonSchemaOptions): JsonSchema2020;
+
+/**
+ * Generates a JSON Schema 2020-12 object from a canonical FormIR.
+ *
+ * Groups and conditionals are flattened — they influence UI layout but do not
+ * affect the data schema. All fields appear at the level they would occupy in
+ * the output data.
+ *
+ * Named types in the `typeRegistry` are emitted as `$defs` entries and
+ * referenced via `$ref` (per PP7 — high-fidelity output).
+ *
+ * @example
+ * ```typescript
+ * import { canonicalizeDSL } from "./canonicalize/index.js";
+ * import { generateJsonSchemaFromIR } from "./json-schema/ir-generator.js";
+ * import { formspec, field } from "@formspec/dsl";
+ *
+ * const form = formspec(
+ *   field.text("name", { label: "Name", required: true }),
+ *   field.number("age", { min: 0 }),
+ * );
+ * const ir = canonicalizeDSL(form);
+ * const schema = generateJsonSchemaFromIR(ir);
+ * // {
+ * //   $schema: "https://json-schema.org/draft/2020-12/schema",
+ * //   type: "object",
+ * //   properties: {
+ * //     name: { type: "string", title: "Name" },
+ * //     age:  { type: "number", minimum: 0 }
+ * //   },
+ * //   required: ["name"]
+ * // }
+ * ```
+ *
+ * Advanced API — most consumers should use `generateJsonSchema()` or
+ * `buildFormSchemas()`, which canonicalize form definitions automatically.
+ * Callers of this function are responsible for providing pre-canonicalized IR.
+ *
+ * @param ir - The canonical FormIR produced by a canonicalizer
+ * @returns A plain JSON-serializable JSON Schema 2020-12 object
+ *
+ * @public
+ */
+export declare function generateJsonSchemaFromIR(ir: FormIR, options?: GenerateJsonSchemaFromIROptions): JsonSchema2020;
+
+/**
+ * Options for generating JSON Schema from a canonical FormIR.
+ *
+ * @public
+ */
+export declare interface GenerateJsonSchemaFromIROptions {
+    /**
+     * Registry used to resolve custom types, constraints, and annotations.
+     *
+     * JSON Schema generation throws when custom IR nodes are present without a
+     * matching registration in this registry.
+     */
+    readonly extensionRegistry?: ExtensionRegistry | undefined;
+    /**
+     * Vendor prefix passed to extension `toJsonSchema` hooks.
+     * @defaultValue "x-formspec"
+     */
+    readonly vendorPrefix?: string | undefined;
+}
+
+/**
+ * Options for generating JSON Schema from a Chain DSL form.
+ *
+ * These options are forwarded to the IR-based JSON Schema generator.
+ *
+ * @public
+ */
+export declare type GenerateJsonSchemaOptions = GenerateJsonSchemaFromIROptions;
+
+/**
+ * Generates JSON Schema and UI Schema from a named TypeScript
+ * type — a decorated class, an interface with TSDoc tags, or a type alias.
+ *
+ * This is the recommended entry point. It automatically detects whether
+ * the name resolves to a class, interface, or type alias and uses the
+ * appropriate IR analysis pipeline.
+ *
+ * @example
+ * ```typescript
+ * const result = generateSchemas({
+ *   filePath: "./src/config.ts",
+ *   typeName: "DiscountConfig",
+ * });
+ * ```
+ *
+ * @param options - File path and type name
+ * @returns Generated JSON Schema and UI Schema
+ *
+ * @public
+ */
+export declare function generateSchemas(options: GenerateSchemasOptions): GenerateFromClassResult;
+
+/**
+ * Generates JSON Schema and UI Schema from a decorated TypeScript class.
+ *
+ * This is a high-level entry point that handles the entire pipeline:
+ * creating a TypeScript program, finding the class, analyzing it to IR,
+ * and generating schemas — all in one call.
+ *
+ * @example
+ * ```typescript
+ * const result = generateSchemasFromClass({
+ *   filePath: "./src/forms.ts",
+ *   className: "UserForm",
+ * });
+ * console.log(result.jsonSchema);
+ * ```
+ *
+ * @param options - File path, class name, and optional compiler options
+ * @returns Generated JSON Schema and UI Schema
+ *
+ * @public
+ */
+export declare function generateSchemasFromClass(options: GenerateFromClassOptions): GenerateFromClassResult;
+
+/**
+ * Options for generating schemas from a named type (class, interface, or type alias).
+ *
+ * @public
+ */
+export declare interface GenerateSchemasOptions extends GenerateJsonSchemaFromIROptions {
+    /** Path to the TypeScript source file */
+    filePath: string;
+    /** Name of the exported class, interface, or type alias to analyze */
+    typeName: string;
+}
+
+/**
+ * Generates a JSON Forms UI Schema from a FormSpec.
+ *
+ * All generation routes through the canonical IR. The chain DSL is first
+ * canonicalized to a FormIR, then the IR-based generator produces the schema.
+ *
+ * @example
+ * ```typescript
+ * const form = formspec(
+ *   group("Customer",
+ *     field.text("name", { label: "Name" }),
+ *   ),
+ *   when("status", "draft",
+ *     field.text("notes", { label: "Notes" }),
+ *   ),
+ * );
+ *
+ * const uiSchema = generateUiSchema(form);
+ * // {
+ * //   type: "VerticalLayout",
+ * //   elements: [
+ * //     {
+ * //       type: "Group",
+ * //       label: "Customer",
+ * //       elements: [
+ * //         { type: "Control", scope: "#/properties/name", label: "Name" }
+ * //       ]
+ * //     },
+ * //     {
+ * //       type: "Control",
+ * //       scope: "#/properties/notes",
+ * //       label: "Notes",
+ * //       rule: {
+ * //         effect: "SHOW",
+ * //         condition: { scope: "#/properties/status", schema: { const: "draft" } }
+ * //       }
+ * //     }
+ * //   ]
+ * // }
+ * ```
+ *
+ * @param form - The FormSpec to convert
+ * @returns A JSON Forms UI Schema
+ *
+ * @public
+ */
+export declare function generateUiSchema<E extends readonly FormElement[]>(form: FormSpec<E>): UISchema;
+
+/**
+ * Reads a FormSpec extension property from a JSON Schema node.
+ *
+ * Accepts any schema object — `JSONSchema7`, `JsonSchema2020`, `ExtendedJSONSchema7`, etc.
+ *
+ * @param schema - Any JSON Schema node
+ * @param key - Extension key (must start with `x-formspec-`)
+ * @returns The extension value, or `undefined` if not present
+ *
+ * @public
+ */
+export declare function getSchemaExtension(schema: object, key: `x-formspec-${string}`): unknown;
+
+/**
+ * A group element with a label.
+ *
+ * @public
+ */
+export declare interface GroupLayout {
+    type: "Group";
+    label: string;
+    elements: UISchemaElement[];
+    rule?: Rule | undefined;
+    options?: Record<string, unknown> | undefined;
+    [k: string]: unknown;
+}
+
+/**
+ * Zod schema for a group layout element.
+ *
+ * @public
+ */
+export declare const groupLayoutSchema: z.ZodType<GroupLayout>;
+
+/**
+ * A horizontal layout element.
+ *
+ * @public
+ */
+export declare interface HorizontalLayout {
+    type: "HorizontalLayout";
+    elements: UISchemaElement[];
+    rule?: Rule | undefined;
+    options?: Record<string, unknown> | undefined;
+    [k: string]: unknown;
+}
+
+/**
+ * Zod schema for a horizontal layout element.
+ *
+ * @public
+ */
+export declare const horizontalLayoutSchema: z.ZodType<HorizontalLayout>;
+
+/**
+ * A JSON Schema 2020-12 document, sub-schema, or keyword collection.
+ *
+ * This interface covers the subset of JSON Schema 2020-12 that this generator
+ * emits, plus an index signature for custom `x-formspec-*` extension keywords.
+ *
+ * @public
+ */
+export declare interface JsonSchema2020 {
+    $schema?: string;
+    $ref?: string;
+    $defs?: Record<string, JsonSchema2020>;
+    type?: string;
+    properties?: Record<string, JsonSchema2020>;
+    required?: string[];
+    items?: JsonSchema2020;
+    additionalProperties?: boolean | JsonSchema2020;
+    enum?: readonly (string | number)[];
+    const?: JsonValue;
+    allOf?: readonly JsonSchema2020[];
+    oneOf?: readonly JsonSchema2020[];
+    anyOf?: readonly JsonSchema2020[];
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    multipleOf?: number;
+    minLength?: number;
+    maxLength?: number;
+    minItems?: number;
+    maxItems?: number;
+    pattern?: string;
+    uniqueItems?: boolean;
+    format?: string;
+    title?: string;
+    description?: string;
+    default?: unknown;
+    deprecated?: boolean;
+    [key: `x-${string}`]: unknown;
+}
+
+/**
+ * A JSON Schema definition (legacy subset used by Zod validator and types.ts).
+ *
+ * @public
+ */
+export declare interface JSONSchema7 {
+    $schema?: string;
+    $id?: string;
+    $ref?: string;
+    title?: string;
+    description?: string;
+    deprecated?: boolean;
+    type?: JSONSchemaType | JSONSchemaType[];
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    enum?: readonly (string | number | boolean | null)[];
+    const?: string | number | boolean | null;
+    properties?: Record<string, JSONSchema7>;
+    required?: string[];
+    additionalProperties?: boolean | JSONSchema7;
+    items?: JSONSchema7 | JSONSchema7[];
+    minItems?: number;
+    maxItems?: number;
+    allOf?: JSONSchema7[];
+    anyOf?: JSONSchema7[];
+    oneOf?: JSONSchema7[];
+    not?: JSONSchema7;
+    if?: JSONSchema7;
+    then?: JSONSchema7;
+    else?: JSONSchema7;
+    format?: string;
+    default?: unknown;
+    /**
+     * Data source key for dynamic enum fields.
+     * Indicates that options should be fetched from a registered resolver.
+     */
+    "x-formspec-source"?: string;
+    /**
+     * Field names whose values are needed to fetch dynamic enum options.
+     * Used for dependent/cascading dropdowns.
+     */
+    "x-formspec-params"?: readonly string[];
+    /**
+     * Schema source identifier for dynamic schema fields.
+     * Indicates that the schema should be loaded dynamically at runtime.
+     */
+    "x-formspec-schemaSource"?: string;
+}
+
+/**
+ * Zod schema for the legacy JSON Schema 7 subset used by `@formspec/build`.
+ *
+ * @public
+ */
+export declare const jsonSchema7Schema: z.ZodType<JSONSchema7>;
+
+/**
+ * JSON Schema type definitions.
+ *
+ * These types are a subset of JSON Schema sufficient for form generation.
+ */
+/**
+ * JSON Schema primitive types.
+ *
+ * @public
+ */
+export declare type JSONSchemaType = "string" | "number" | "integer" | "boolean" | "object" | "array" | "null";
+
+/**
+ * Zod schema for JSON Schema primitive type strings.
+ *
+ * @public
+ */
+export declare const jsonSchemaTypeSchema: z.ZodEnum<["string", "number", "integer", "boolean", "object", "array", "null"]>;
+
+/**
+ * A Label element for displaying static text.
+ *
+ * @public
+ */
+export declare type LabelElement = z.infer<typeof labelElementSchema>;
+
+/**
+ * Zod schema for a Label element.
+ *
+ * @public
+ */
+export declare const labelElementSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Label">;
+    text: z.ZodString;
+    rule: z.ZodOptional<z.ZodObject<{
+        effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+        condition: z.ZodObject<{
+            scope: z.ZodString;
+            schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+        }, "strict", z.ZodTypeAny, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    type: z.ZodLiteral<"Label">;
+    text: z.ZodString;
+    rule: z.ZodOptional<z.ZodObject<{
+        effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+        condition: z.ZodObject<{
+            scope: z.ZodString;
+            schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+        }, "strict", z.ZodTypeAny, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    type: z.ZodLiteral<"Label">;
+    text: z.ZodString;
+    rule: z.ZodOptional<z.ZodObject<{
+        effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+        condition: z.ZodObject<{
+            scope: z.ZodString;
+            schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+        }, "strict", z.ZodTypeAny, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }, {
+            schema: RuleConditionSchema;
+            scope: string;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }, {
+        condition: {
+            schema: RuleConditionSchema;
+            scope: string;
+        };
+        effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+    }>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.ZodTypeAny, "passthrough">>;
+
+/**
+ * Result of generating schemas from a mixed-authoring composition.
+ *
+ * @public
+ */
+export declare interface MixedAuthoringSchemas {
+    /** JSON Schema 2020-12 for validation. */
+    readonly jsonSchema: JsonSchema2020;
+    /** JSON Forms UI Schema for rendering. */
+    readonly uiSchema: UISchema;
+}
+
+/**
+ * Rule for conditional element visibility/enablement.
+ *
+ * @public
+ */
+export declare type Rule = z.infer<typeof ruleSchema>;
+
+/**
+ * JSON Schema subset used in rule conditions.
+ *
+ * @public
+ */
+export declare interface RuleConditionSchema {
+    const?: unknown;
+    enum?: readonly unknown[];
+    type?: string;
+    not?: RuleConditionSchema;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    minLength?: number;
+    properties?: Record<string, RuleConditionSchema>;
+    required?: string[];
+    allOf?: RuleConditionSchema[];
+}
+
+/**
+ * Zod schema for the rule-condition JSON Schema subset.
+ *
+ * @public
+ */
+export declare const ruleConditionSchema: z.ZodType<RuleConditionSchema>;
+
+/**
+ * Rule effect types for conditional visibility.
+ *
+ * @public
+ */
+export declare type RuleEffect = z.infer<typeof ruleEffectSchema>;
+
+/**
+ * Zod schema for rule effect values.
+ *
+ * @public
+ */
+export declare const ruleEffectSchema: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+
+/**
+ * Zod schema for a UI Schema rule.
+ *
+ * @public
+ */
+export declare const ruleSchema: z.ZodObject<{
+    effect: z.ZodEnum<["SHOW", "HIDE", "ENABLE", "DISABLE"]>;
+    condition: z.ZodObject<{
+        scope: z.ZodString;
+        schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+    }, "strict", z.ZodTypeAny, {
+        schema: RuleConditionSchema;
+        scope: string;
+    }, {
+        schema: RuleConditionSchema;
+        scope: string;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    condition: {
+        schema: RuleConditionSchema;
+        scope: string;
+    };
+    effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+}, {
+    condition: {
+        schema: RuleConditionSchema;
+        scope: string;
+    };
+    effect: "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+}>;
+
+/**
+ * Condition for a rule.
+ *
+ * @public
+ */
+export declare type SchemaBasedCondition = z.infer<typeof schemaBasedConditionSchema>;
+
+/**
+ * Zod schema for a schema-based rule condition.
+ *
+ * @public
+ */
+export declare const schemaBasedConditionSchema: z.ZodObject<{
+    scope: z.ZodString;
+    schema: z.ZodType<RuleConditionSchema, z.ZodTypeDef, RuleConditionSchema>;
+}, "strict", z.ZodTypeAny, {
+    schema: RuleConditionSchema;
+    scope: string;
+}, {
+    schema: RuleConditionSchema;
+    scope: string;
+}>;
+
+/**
+ * Sets a FormSpec extension property on a JSON Schema node.
+ *
+ * Use this to safely add `x-formspec-*` properties to any schema,
+ * including nested schemas typed as `JSONSchema7` (which don't carry
+ * the extension index signature).
+ *
+ * @param schema - Any JSON Schema node
+ * @param key - Extension key (must start with `x-formspec-`)
+ * @param value - Extension value
+ *
+ * @public
+ */
+export declare function setSchemaExtension(schema: object, key: `x-formspec-${string}`, value: unknown): void;
+
+/**
+ * Root UI Schema (always a layout — not a Control, Category, or Label).
+ *
+ * @public
+ */
+export declare type UISchema = VerticalLayout | HorizontalLayout | GroupLayout | Categorization;
+
+/**
+ * Union of all UI Schema element types.
+ *
+ * @public
+ */
+export declare type UISchemaElement = ControlElement | VerticalLayout | HorizontalLayout | GroupLayout | Categorization | Category | LabelElement;
+
+/**
+ * Base interface for all UI Schema elements.
+ *
+ * This is a manually maintained interface representing the common shape
+ * shared by all element types. It is kept as an interface (rather than
+ * derived from Zod) because it is the base of a discriminated union, not
+ * a union member itself.
+ *
+ * @public
+ */
+export declare interface UISchemaElementBase {
+    type: UISchemaElementType;
+    rule?: Rule;
+    options?: Record<string, unknown>;
+}
+
+/**
+ * Zod schema for any UI Schema element.
+ *
+ * @public
+ */
+export declare const uiSchemaElementSchema: z.ZodType<UISchemaElement>;
+
+/**
+ * UI Schema element types.
+ *
+ * @public
+ */
+export declare type UISchemaElementType = z.infer<typeof uiSchemaElementTypeSchema>;
+
+/**
+ * Zod schema for UI Schema element type strings.
+ *
+ * @public
+ */
+export declare const uiSchemaElementTypeSchema: z.ZodEnum<["Control", "VerticalLayout", "HorizontalLayout", "Group", "Categorization", "Category", "Label"]>;
+
+/**
+ * Zod schema for the root UI Schema (layout types only).
+ *
+ * @public
+ */
+export declare const uiSchemaSchema: z.ZodType<UISchema>;
+
+/**
+ * A vertical layout element.
+ *
+ * @public
+ */
+export declare interface VerticalLayout {
+    type: "VerticalLayout";
+    elements: UISchemaElement[];
+    rule?: Rule | undefined;
+    options?: Record<string, unknown> | undefined;
+    [k: string]: unknown;
+}
+
+/**
+ * Zod schema for a vertical layout element.
+ *
+ * @public
+ */
+export declare const verticalLayoutSchema: z.ZodType<VerticalLayout>;
+
+/**
+ * Builds and writes both JSON Schema and UI Schema files to disk.
+ *
+ * This is a convenience function for build-time schema generation.
+ * It creates the output directory if it doesn't exist.
+ *
+ * @example
+ * ```typescript
+ * import { formspec, field } from "formspec";
+ * import { writeSchemas } from "@formspec/build";
+ *
+ * const ProductForm = formspec(
+ *   field.text("name", { required: true }),
+ *   field.enum("status", ["draft", "active"]),
+ * );
+ *
+ * // Write schemas to ./generated/product-schema.json and ./generated/product-uischema.json
+ * const { jsonSchemaPath, uiSchemaPath } = writeSchemas(ProductForm, {
+ *   outDir: "./generated",
+ *   name: "product",
+ * });
+ *
+ * console.log(`Generated: ${jsonSchemaPath}, ${uiSchemaPath}`);
+ * ```
+ *
+ * @param form - The FormSpec to build schemas from
+ * @param options - Output options (directory, file name, indentation)
+ * @returns Object containing paths to the generated files
+ *
+ * @public
+ */
+export declare function writeSchemas<E extends readonly FormElement[]>(form: FormSpec<E>, options: WriteSchemasOptions): WriteSchemasResult;
+
+/**
+ * Options for writing schemas to disk.
+ *
+ * @public
+ */
+export declare interface WriteSchemasOptions extends GenerateJsonSchemaFromIROptions {
+    /** Output directory for the schema files */
+    readonly outDir: string;
+    /** Base name for the output files (without extension). Defaults to "schema" */
+    readonly name?: string;
+    /** Number of spaces for JSON indentation. Defaults to 2 */
+    readonly indent?: number;
+}
+
+/**
+ * Result of writing schemas to disk.
+ *
+ * @public
+ */
+export declare interface WriteSchemasResult {
+    /** Path to the generated JSON Schema file */
+    readonly jsonSchemaPath: string;
+    /** Path to the generated UI Schema file */
+    readonly uiSchemaPath: string;
+}
+
+export { }