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

package/dist/build.d.ts

@@ -61,6 +61,8 @@ import { z } from 'zod';
  *
  * @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;
 
@@ -69,6 +71,8 @@ export declare function buildFormSchemas<E extends readonly FormElement[]>(form:
  *
  * 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;
 
@@ -80,6 +84,8 @@ export declare type BuildFormSchemasOptions = GenerateJsonSchemaOptions;
  * 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;
 
@@ -88,6 +94,8 @@ export declare function buildMixedAuthoringSchemas(options: BuildMixedAuthoringS
  *
  * 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. */
@@ -100,6 +108,8 @@ export declare interface BuildMixedAuthoringSchemasOptions extends GenerateJsonS
 
 /**
  * Result of building form schemas.
+ *
+ * @public
  */
 export declare interface BuildResult {
     /** JSON Schema 2020-12 for validation */
@@ -110,6 +120,8 @@ export declare interface BuildResult {
 
 /**
  * A Categorization element (tab-based layout).
+ *
+ * @public
  */
 export declare interface Categorization {
     type: "Categorization";
@@ -120,10 +132,17 @@ export declare interface Categorization {
     [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";
@@ -134,10 +153,17 @@ export declare interface Category {
     [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 */
@@ -148,11 +174,15 @@ export declare interface ClassSchemas {
 
 /**
  * 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">;
@@ -256,10 +286,16 @@ export declare const controlSchema: z.ZodObject<{
  * @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. */
+/**
+ * JSON Schema with FormSpec extension properties for arbitrary `x-formspec-*` keys.
+ *
+ * @public
+ */
 export declare type ExtendedJSONSchema7 = JSONSchema7 & FormSpecSchemaExtensions;
 
 /**
@@ -268,6 +304,8 @@ export declare type ExtendedJSONSchema7 = JSONSchema7 & FormSpecSchemaExtensions
  * 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). */
@@ -319,11 +357,17 @@ export declare interface ExtensionRegistry {
     findAnnotation(annotationId: string): CustomAnnotationRegistration | undefined;
 }
 
-/** Extension properties for custom FormSpec constraint tags. */
+/**
+ * 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 */
@@ -334,6 +378,8 @@ export declare interface GenerateFromClassOptions extends GenerateJsonSchemaFrom
 
 /**
  * Result of generating schemas from a decorated class.
+ *
+ * @public
  */
 export declare interface GenerateFromClassResult {
     /** JSON Schema 2020-12 for validation */
@@ -369,6 +415,8 @@ export declare interface GenerateFromClassResult {
  *
  * @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;
 
@@ -411,11 +459,15 @@ export declare function generateJsonSchema<E extends readonly FormElement[]>(for
  *
  * @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 {
     /**
@@ -436,6 +488,8 @@ export declare interface GenerateJsonSchemaFromIROptions {
  * 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;
 
@@ -457,6 +511,8 @@ export declare type GenerateJsonSchemaOptions = GenerateJsonSchemaFromIROptions;
  *
  * @param options - File path and type name
  * @returns Generated JSON Schema and UI Schema
+ *
+ * @public
  */
 export declare function generateSchemas(options: GenerateSchemasOptions): GenerateFromClassResult;
 
@@ -478,11 +534,15 @@ export declare function generateSchemas(options: GenerateSchemasOptions): Genera
  *
  * @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 */
@@ -534,6 +594,8 @@ export declare interface GenerateSchemasOptions extends GenerateJsonSchemaFromIR
  *
  * @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;
 
@@ -545,11 +607,15 @@ export declare function generateUiSchema<E extends readonly FormElement[]>(form:
  * @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";
@@ -560,10 +626,17 @@ export declare interface GroupLayout {
     [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";
@@ -573,6 +646,11 @@ export declare interface HorizontalLayout {
     [k: string]: unknown;
 }
 
+/**
+ * Zod schema for a horizontal layout element.
+ *
+ * @public
+ */
 export declare const horizontalLayoutSchema: z.ZodType<HorizontalLayout>;
 
 /**
@@ -580,6 +658,8 @@ export declare const horizontalLayoutSchema: z.ZodType<HorizontalLayout>;
  *
  * 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;
@@ -616,6 +696,8 @@ export declare interface JsonSchema2020 {
 
 /**
  * A JSON Schema definition (legacy subset used by Zod validator and types.ts).
+ *
+ * @public
  */
 export declare interface JSONSchema7 {
     $schema?: string;
@@ -666,6 +748,11 @@ export declare interface JSONSchema7 {
     "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>;
 
 /**
@@ -675,21 +762,29 @@ export declare const jsonSchema7Schema: z.ZodType<JSONSchema7>;
  */
 /**
  * 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">;
@@ -782,6 +877,8 @@ export declare const labelElementSchema: z.ZodObject<{
 
 /**
  * Result of generating schemas from a mixed-authoring composition.
+ *
+ * @public
  */
 export declare interface MixedAuthoringSchemas {
     /** JSON Schema 2020-12 for validation. */
@@ -792,11 +889,15 @@ export declare interface MixedAuthoringSchemas {
 
 /**
  * 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;
@@ -813,20 +914,31 @@ export declare interface RuleConditionSchema {
     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"]>;
@@ -856,11 +968,15 @@ export declare const ruleSchema: z.ZodObject<{
 
 /**
  * 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;
@@ -883,16 +999,22 @@ export declare const schemaBasedConditionSchema: z.ZodObject<{
  * @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;
 
@@ -903,6 +1025,8 @@ export declare type UISchemaElement = ControlElement | VerticalLayout | Horizont
  * 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;
@@ -910,25 +1034,38 @@ export declare interface UISchemaElementBase {
     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";
@@ -938,6 +1075,11 @@ export declare interface VerticalLayout {
     [k: string]: unknown;
 }
 
+/**
+ * Zod schema for a vertical layout element.
+ *
+ * @public
+ */
 export declare const verticalLayoutSchema: z.ZodType<VerticalLayout>;
 
 /**
@@ -968,11 +1110,15 @@ export declare const verticalLayoutSchema: z.ZodType<VerticalLayout>;
  * @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 */
@@ -985,6 +1131,8 @@ export declare interface WriteSchemasOptions extends GenerateJsonSchemaFromIROpt
 
 /**
  * Result of writing schemas to disk.
+ *
+ * @public
  */
 export declare interface WriteSchemasResult {
     /** Path to the generated JSON Schema file */