@formspec/build 0.1.0-alpha.26 → 0.1.0-alpha.28

package/dist/build.d.ts

@@ -27,9 +27,7 @@ import { AnyField } from '@formspec/core';
 import { ArrayField } from '@formspec/core';
 import { BooleanField } from '@formspec/core';
 import { BuiltinConstraintBroadeningRegistration } from '@formspec/core';
-import { BuiltinConstraintName } from '@formspec/core';
 import { Conditional } from '@formspec/core';
-import { ConstraintSemanticRole } from '@formspec/core';
 import { ConstraintTagRegistration } from '@formspec/core';
 import { CustomAnnotationRegistration } from '@formspec/core';
 import { CustomConstraintRegistration } from '@formspec/core';
@@ -38,10 +36,7 @@ import { DynamicEnumField } from '@formspec/core';
 import { DynamicSchemaField } from '@formspec/core';
 import { EnumOption } from '@formspec/core';
 import { EnumOptionValue } from '@formspec/core';
-import { ExtensionApplicableType } from '@formspec/core';
 import { ExtensionDefinition } from '@formspec/core';
-import { ExtensionPayloadValue } from '@formspec/core';
-import { ExtensionTypeKind } from '@formspec/core';
 import { FormElement } from '@formspec/core';
 import { FormSpec } from '@formspec/core';
 import { Group } from '@formspec/core';
@@ -49,7 +44,8 @@ import { NumberField } from '@formspec/core';
 import { ObjectField } from '@formspec/core';
 import { StaticEnumField } from '@formspec/core';
 import { TextField } from '@formspec/core';
-import { VocabularyKeywordRegistration } from '@formspec/core';
+import * as ts from 'typescript';
+import { z } from 'zod';
 
 export { AnyField }
 
@@ -142,8 +138,6 @@ export declare interface BuildResult {
 
 export { BuiltinConstraintBroadeningRegistration }
 
-export { BuiltinConstraintName }
-
 /**
  * A Categorization element (tab-based layout).
  *
@@ -186,8 +180,6 @@ export declare interface Category {
 
 export { Conditional }
 
-export { ConstraintSemanticRole }
-
 export { ConstraintTagRegistration }
 
 /**
@@ -239,13 +231,15 @@ export { EnumOption }
 
 export { EnumOptionValue }
 
-/* Excluded from this release type: ExtendedJSONSchema7 */
-export { ExtensionApplicableType }
+/**
+ * JSON Schema with FormSpec extension properties for arbitrary `x-formspec-*` keys.
+ *
+ * @public
+ */
+export declare type ExtendedJSONSchema7 = JSONSchema7 & FormSpecSchemaExtensions;
 
 export { ExtensionDefinition }
 
-export { ExtensionPayloadValue }
-
 /**
  * A registry of extensions that provides lookup by fully-qualified ID.
  *
@@ -305,13 +299,16 @@ export declare interface ExtensionRegistry {
     findAnnotation(annotationId: string): CustomAnnotationRegistration | undefined;
 }
 
-export { ExtensionTypeKind }
-
 export { FormElement }
 
 export { FormSpec }
 
-/* Excluded from this release type: FormSpecSchemaExtensions */
+/**
+ * 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.
@@ -428,6 +425,34 @@ export declare function generateSchemas(options: GenerateSchemasOptions): Genera
  */
 export declare function generateSchemasFromClass(options: GenerateFromClassOptions): GenerateFromClassResult;
 
+/**
+ * Generates JSON Schema and UI Schema from a named type within an existing
+ * TypeScript program supplied by the caller.
+ *
+ * This low-level entry point lets downstream tooling reuse a host-owned
+ * `Program` for both FormSpec extraction and other TypeScript analysis.
+ *
+ * @param options - Host program, file path, type name, and optional schema generation options
+ * @returns Generated JSON Schema and UI Schema
+ *
+ * @public
+ */
+export declare function generateSchemasFromProgram(options: GenerateSchemasFromProgramOptions): GenerateFromClassResult;
+
+/**
+ * Options for generating schemas from a named type inside an existing TypeScript program.
+ *
+ * @public
+ */
+export declare interface GenerateSchemasFromProgramOptions extends StaticSchemaGenerationOptions {
+    /** Existing TypeScript program supplied by the caller. */
+    readonly program: ts.Program;
+    /** Path to the TypeScript source file */
+    readonly filePath: string;
+    /** Name of the exported class, interface, or type alias to analyze */
+    readonly typeName: string;
+}
+
 /**
  * Options for generating schemas from a named type (class, interface, or type alias).
  *
@@ -599,9 +624,109 @@ export declare interface JsonSchema2020 {
     [key: `x-${string}`]: unknown;
 }
 
-/* Excluded from this release type: JSONSchema7 */
+/**
+ * A JSON Schema definition (legacy subset used by Zod validator and types.ts).
+ *
+ * @public
+ */
+export declare interface JSONSchema7 {
+    /** Declared JSON Schema dialect URI for the document root. */
+    $schema?: string;
+    /** Stable identifier for the schema document or sub-schema. */
+    $id?: string;
+    /** Reference to another schema location. */
+    $ref?: string;
+    /** Human-readable title for the schema node. */
+    title?: string;
+    /** Human-readable description for the schema node. */
+    description?: string;
+    /** Whether the schema node is deprecated. */
+    deprecated?: boolean;
+    /** JSON Schema type keyword for the current node. */
+    type?: JSONSchemaType | JSONSchemaType[];
+    /** Inclusive minimum string length. */
+    minLength?: number;
+    /** Inclusive maximum string length. */
+    maxLength?: number;
+    /** Regular expression pattern applied to string values. */
+    pattern?: string;
+    /** Inclusive numeric lower bound. */
+    minimum?: number;
+    /** Inclusive numeric upper bound. */
+    maximum?: number;
+    /** Exclusive numeric lower bound. */
+    exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound. */
+    exclusiveMaximum?: number;
+    /** Closed set of allowed scalar values. */
+    enum?: readonly (string | number | boolean | null)[];
+    /** Literal value the instance must equal. */
+    const?: string | number | boolean | null;
+    /** Object properties keyed by property name. */
+    properties?: Record<string, JSONSchema7>;
+    /** Property names that must be present on object values. */
+    required?: string[];
+    /** Whether, or how, additional object properties are allowed. */
+    additionalProperties?: boolean | JSONSchema7;
+    /** Item schema or tuple schemas applied to array elements. */
+    items?: JSONSchema7 | JSONSchema7[];
+    /** Inclusive minimum array length. */
+    minItems?: number;
+    /** Inclusive maximum array length. */
+    maxItems?: number;
+    /** Schemas that must all validate successfully. */
+    allOf?: JSONSchema7[];
+    /** Schemas of which at least one may validate successfully. */
+    anyOf?: JSONSchema7[];
+    /** Schemas of which exactly one should validate successfully. */
+    oneOf?: JSONSchema7[];
+    /** Schema that must not validate successfully. */
+    not?: JSONSchema7;
+    /** Conditional branch predicate schema. */
+    if?: JSONSchema7;
+    /** Schema applied when the `if` branch matches. */
+    then?: JSONSchema7;
+    /** Schema applied when the `if` branch does not match. */
+    else?: JSONSchema7;
+    /** Format hint for downstream validators and tooling. */
+    format?: string;
+    /** Default value suggested for the schema node. */
+    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;
+}
 
-/* Excluded from this release type: JSONSchemaType */
+/**
+ * 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";
 
 /**
  * A Label element for displaying static text.
@@ -769,6 +894,13 @@ export declare interface UISchemaElementBase {
  */
 export declare type UISchemaElementType = "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.
  *
@@ -787,8 +919,6 @@ export declare interface VerticalLayout {
     readonly [k: string]: unknown;
 }
 
-export { VocabularyKeywordRegistration }
-
 /**
  * Builds and writes both JSON Schema and UI Schema files to disk.
  *