@formspec/validator 0.1.0-alpha.12 → 0.1.0-alpha.26

package/README.md

@@ -1,94 +1,41 @@
 # @formspec/validator
 
-JSON Schema validation for FormSpec, powered by [@cfworker/json-schema](https://github.com/nicolo-ribaudo/cfworker-json-schema). Designed for secure runtime environments that prohibit `new Function()` and `eval()`.
+Runtime JSON Schema validation for FormSpec, backed by `@cfworker/json-schema`.
 
-## Installation
+This package is intended for environments where code-generating validators are a bad fit, including workers and CSP-restricted runtimes.
+
+## Install
 
 ```bash
-npm install @formspec/validator
-# or
 pnpm add @formspec/validator
 ```
 
-## Requirements
-
-This package is ESM-only and requires:
-
-```json
-// package.json
-{
-  "type": "module"
-}
-```
-
-```json
-// tsconfig.json
-{
-  "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext"
-  }
-}
-```
-
-## Quick Start
+## Usage
 
-```typescript
+```ts
 import { createFormSpecValidator } from "@formspec/validator";
-import { buildFormSchemas, formspec, field } from "formspec";
-
-const form = formspec(
-  field.text("name", { required: true }),
-  field.number("age", { min: 0 })
-);
-
-const { jsonSchema } = buildFormSchemas(form);
-
-// Create a validator that ignores x-formspec-* extension keywords
-const validator = createFormSpecValidator(jsonSchema);
-
-const result = validator.validate({ name: "Alice", age: 30 });
-console.log(result.valid); // true
-```
-
-## Why This Package?
-
-Standard JSON Schema validators like Ajv use `new Function()` internally, which is blocked in:
-
-- Cloudflare Workers
-- Deno Deploy
-- Browser extensions (CSP restrictions)
-- Any environment with strict Content Security Policy
-
-`@formspec/validator` wraps `@cfworker/json-schema`, which implements JSON Schema validation without code generation. It also pre-configures the validator to silently ignore `x-formspec-*` vendor extension keywords that FormSpec adds to generated schemas.
-
-## API Reference
-
-### Functions
-
-| Function | Description |
-| --- | --- |
-| `createFormSpecValidator(schema, options?)` | Create a validator instance for a JSON Schema |
 
-### Options
+const validator = createFormSpecValidator({
+  type: "object",
+  required: ["name"],
+  properties: {
+    name: { type: "string" },
+    country: { type: "string", "x-formspec-source": "countries" },
+  },
+});
 
-```typescript
-interface CreateValidatorOptions {
-  draft?: SchemaDraft;    // JSON Schema draft version (default: "2020-12")
-  shortCircuit?: boolean; // Stop on first error (default: true)
-}
+const result = validator.validate({ name: "Alice", country: "us" });
 ```
 
-### Re-exports
+Unknown `x-formspec-*` keywords are ignored by the underlying validator, so generated schemas work without extra vocabulary registration.
 
-This package re-exports key types from `@cfworker/json-schema`:
+## Main Exports
 
-| Export | Description |
-| --- | --- |
-| `Validator` | The validator class |
-| `ValidationResult` | Result of `validator.validate()` |
-| `OutputUnit` | Individual validation error detail |
-| `SchemaDraft` | Supported JSON Schema draft versions |
+- `createFormSpecValidator(schema, options?)`
+- `Validator`
+- `ValidationResult`
+- `OutputUnit`
+- `SchemaDraft`
 
 ## License
 

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * `@formspec/validator` — JSON Schema validator for FormSpec\n *\n * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},\n * this package validates data against FormSpec-generated JSON Schemas in any\n * JavaScript runtime — including secure environments that disallow `new Function()`\n * (e.g., Cloudflare Workers).\n *\n * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so\n * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.\n *\n * @example\n * ```typescript\n * import { createFormSpecValidator } from \"@formspec/validator\";\n *\n * const validator = createFormSpecValidator({\n *   type: \"object\",\n *   required: [\"name\"],\n *   properties: {\n *     name: { type: \"string\" },\n *     country: { type: \"string\", \"x-formspec-source\": \"countries\" },\n *   },\n * });\n *\n * const result = validator.validate({ name: \"Alice\", country: \"US\" });\n * // result.valid === true\n * ```\n *\n * @packageDocumentation\n */\n\nimport { Validator } from \"@cfworker/json-schema\";\nimport type { OutputUnit, Schema, SchemaDraft, ValidationResult } from \"@cfworker/json-schema\";\n\nexport { Validator };\nexport type { OutputUnit, SchemaDraft, ValidationResult };\n\n/**\n * Options for `createFormSpecValidator`.\n *\n * @public\n */\nexport interface CreateValidatorOptions {\n  /**\n   * The JSON Schema draft version to validate against.\n   *\n   * FormSpec generates schemas targeting JSON Schema 2020-12.\n   *\n   * @defaultValue `\"2020-12\"`\n   */\n  draft?: SchemaDraft;\n\n  /**\n   * When `true`, validation stops after the first error.\n   * When `false`, all errors are collected.\n   *\n   * @defaultValue `true`\n   */\n  shortCircuit?: boolean;\n}\n\n/**\n * Creates a `Validator` configured for FormSpec-generated JSON Schemas.\n *\n * The returned `Validator` uses JSON Schema draft 2020-12 by default and\n * silently ignores `x-formspec-*` extension keywords — no vocabulary\n * registration is needed.\n *\n * @param schema - A JSON Schema object (typically generated by `@formspec/build`).\n * @param options - Optional configuration for draft version and error collection behavior.\n * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.\n *\n * @public\n */\nexport function createFormSpecValidator(\n  schema: Record<string, unknown>,\n  options?: CreateValidatorOptions,\n): Validator {\n  const draft = options?.draft ?? \"2020-12\";\n  const shortCircuit = options?.shortCircuit ?? true;\n  // Safe cast: Schema has `[key: string]: any`, so every Record<string, unknown>\n  // structurally satisfies it. We keep the public parameter as Record<string, unknown>\n  // to avoid coupling consumers to @cfworker/json-schema's Schema type.\n  return new Validator(schema as Schema, draft, shortCircuit);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA+BA,yBAA0B;AA2CnB,SAAS,wBACd,QACA,SACW;AACX,QAAM,QAAQ,SAAS,SAAS;AAChC,QAAM,eAAe,SAAS,gBAAgB;AAI9C,SAAO,IAAI,6BAAU,QAAkB,OAAO,YAAY;AAC5D;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * `@formspec/validator` — JSON Schema validator for FormSpec\n *\n * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},\n * this package validates data against FormSpec-generated JSON Schemas in any\n * JavaScript runtime — including secure environments that disallow `new Function()`\n * (e.g., Cloudflare Workers).\n *\n * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so\n * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.\n *\n * @example\n * ```typescript\n * import { createFormSpecValidator } from \"@formspec/validator\";\n *\n * const validator = createFormSpecValidator({\n *   type: \"object\",\n *   required: [\"name\"],\n *   properties: {\n *     name: { type: \"string\" },\n *     country: { type: \"string\", \"x-formspec-source\": \"countries\" },\n *   },\n * });\n *\n * const result = validator.validate({ name: \"Alice\", country: \"US\" });\n * // result.valid === true\n * ```\n *\n * @packageDocumentation\n */\n\nimport { Validator } from \"@cfworker/json-schema\";\nimport type { OutputUnit, Schema, SchemaDraft, ValidationResult } from \"@cfworker/json-schema\";\n\nexport { Validator };\nexport type { OutputUnit, SchemaDraft, ValidationResult };\n\n/**\n * Options for `createFormSpecValidator`.\n *\n * @public\n */\nexport interface CreateValidatorOptions {\n  /**\n   * The JSON Schema draft version to validate against.\n   *\n   * FormSpec generates schemas targeting JSON Schema 2020-12.\n   *\n   * @defaultValue `\"2020-12\"`\n   */\n  draft?: SchemaDraft;\n\n  /**\n   * When `true`, validation stops after the first error.\n   * When `false`, all errors are collected.\n   *\n   * @defaultValue `true`\n   */\n  shortCircuit?: boolean;\n}\n\n/**\n * Creates a `Validator` configured for FormSpec-generated JSON Schemas.\n *\n * The returned `Validator` uses JSON Schema draft 2020-12 by default and\n * silently ignores `x-formspec-*` extension keywords — no vocabulary\n * registration is needed.\n *\n * @param schema - A JSON Schema object (typically generated by `@formspec/build`).\n * @param options - Optional configuration for draft version and error collection behavior.\n * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.\n *\n * @public\n */\nexport function createFormSpecValidator(\n  schema: Record<string, unknown>,\n  options?: CreateValidatorOptions\n): Validator {\n  const draft = options?.draft ?? \"2020-12\";\n  const shortCircuit = options?.shortCircuit ?? true;\n  // Safe cast: Schema has `[key: string]: any`, so every Record<string, unknown>\n  // structurally satisfies it. We keep the public parameter as Record<string, unknown>\n  // to avoid coupling consumers to @cfworker/json-schema's Schema type.\n  return new Validator(schema as Schema, draft, shortCircuit);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA+BA,yBAA0B;AA2CnB,SAAS,wBACd,QACA,SACW;AACX,QAAM,QAAQ,SAAS,SAAS;AAChC,QAAM,eAAe,SAAS,gBAAgB;AAI9C,SAAO,IAAI,6BAAU,QAAkB,OAAO,YAAY;AAC5D;","names":[]}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * `@formspec/validator` — JSON Schema validator for FormSpec\n *\n * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},\n * this package validates data against FormSpec-generated JSON Schemas in any\n * JavaScript runtime — including secure environments that disallow `new Function()`\n * (e.g., Cloudflare Workers).\n *\n * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so\n * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.\n *\n * @example\n * ```typescript\n * import { createFormSpecValidator } from \"@formspec/validator\";\n *\n * const validator = createFormSpecValidator({\n *   type: \"object\",\n *   required: [\"name\"],\n *   properties: {\n *     name: { type: \"string\" },\n *     country: { type: \"string\", \"x-formspec-source\": \"countries\" },\n *   },\n * });\n *\n * const result = validator.validate({ name: \"Alice\", country: \"US\" });\n * // result.valid === true\n * ```\n *\n * @packageDocumentation\n */\n\nimport { Validator } from \"@cfworker/json-schema\";\nimport type { OutputUnit, Schema, SchemaDraft, ValidationResult } from \"@cfworker/json-schema\";\n\nexport { Validator };\nexport type { OutputUnit, SchemaDraft, ValidationResult };\n\n/**\n * Options for `createFormSpecValidator`.\n *\n * @public\n */\nexport interface CreateValidatorOptions {\n  /**\n   * The JSON Schema draft version to validate against.\n   *\n   * FormSpec generates schemas targeting JSON Schema 2020-12.\n   *\n   * @defaultValue `\"2020-12\"`\n   */\n  draft?: SchemaDraft;\n\n  /**\n   * When `true`, validation stops after the first error.\n   * When `false`, all errors are collected.\n   *\n   * @defaultValue `true`\n   */\n  shortCircuit?: boolean;\n}\n\n/**\n * Creates a `Validator` configured for FormSpec-generated JSON Schemas.\n *\n * The returned `Validator` uses JSON Schema draft 2020-12 by default and\n * silently ignores `x-formspec-*` extension keywords — no vocabulary\n * registration is needed.\n *\n * @param schema - A JSON Schema object (typically generated by `@formspec/build`).\n * @param options - Optional configuration for draft version and error collection behavior.\n * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.\n *\n * @public\n */\nexport function createFormSpecValidator(\n  schema: Record<string, unknown>,\n  options?: CreateValidatorOptions,\n): Validator {\n  const draft = options?.draft ?? \"2020-12\";\n  const shortCircuit = options?.shortCircuit ?? true;\n  // Safe cast: Schema has `[key: string]: any`, so every Record<string, unknown>\n  // structurally satisfies it. We keep the public parameter as Record<string, unknown>\n  // to avoid coupling consumers to @cfworker/json-schema's Schema type.\n  return new Validator(schema as Schema, draft, shortCircuit);\n}\n"],"mappings":";AA+BA,SAAS,iBAAiB;AA2CnB,SAAS,wBACd,QACA,SACW;AACX,QAAM,QAAQ,SAAS,SAAS;AAChC,QAAM,eAAe,SAAS,gBAAgB;AAI9C,SAAO,IAAI,UAAU,QAAkB,OAAO,YAAY;AAC5D;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * `@formspec/validator` — JSON Schema validator for FormSpec\n *\n * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},\n * this package validates data against FormSpec-generated JSON Schemas in any\n * JavaScript runtime — including secure environments that disallow `new Function()`\n * (e.g., Cloudflare Workers).\n *\n * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so\n * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.\n *\n * @example\n * ```typescript\n * import { createFormSpecValidator } from \"@formspec/validator\";\n *\n * const validator = createFormSpecValidator({\n *   type: \"object\",\n *   required: [\"name\"],\n *   properties: {\n *     name: { type: \"string\" },\n *     country: { type: \"string\", \"x-formspec-source\": \"countries\" },\n *   },\n * });\n *\n * const result = validator.validate({ name: \"Alice\", country: \"US\" });\n * // result.valid === true\n * ```\n *\n * @packageDocumentation\n */\n\nimport { Validator } from \"@cfworker/json-schema\";\nimport type { OutputUnit, Schema, SchemaDraft, ValidationResult } from \"@cfworker/json-schema\";\n\nexport { Validator };\nexport type { OutputUnit, SchemaDraft, ValidationResult };\n\n/**\n * Options for `createFormSpecValidator`.\n *\n * @public\n */\nexport interface CreateValidatorOptions {\n  /**\n   * The JSON Schema draft version to validate against.\n   *\n   * FormSpec generates schemas targeting JSON Schema 2020-12.\n   *\n   * @defaultValue `\"2020-12\"`\n   */\n  draft?: SchemaDraft;\n\n  /**\n   * When `true`, validation stops after the first error.\n   * When `false`, all errors are collected.\n   *\n   * @defaultValue `true`\n   */\n  shortCircuit?: boolean;\n}\n\n/**\n * Creates a `Validator` configured for FormSpec-generated JSON Schemas.\n *\n * The returned `Validator` uses JSON Schema draft 2020-12 by default and\n * silently ignores `x-formspec-*` extension keywords — no vocabulary\n * registration is needed.\n *\n * @param schema - A JSON Schema object (typically generated by `@formspec/build`).\n * @param options - Optional configuration for draft version and error collection behavior.\n * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.\n *\n * @public\n */\nexport function createFormSpecValidator(\n  schema: Record<string, unknown>,\n  options?: CreateValidatorOptions\n): Validator {\n  const draft = options?.draft ?? \"2020-12\";\n  const shortCircuit = options?.shortCircuit ?? true;\n  // Safe cast: Schema has `[key: string]: any`, so every Record<string, unknown>\n  // structurally satisfies it. We keep the public parameter as Record<string, unknown>\n  // to avoid coupling consumers to @cfworker/json-schema's Schema type.\n  return new Validator(schema as Schema, draft, shortCircuit);\n}\n"],"mappings":";AA+BA,SAAS,iBAAiB;AA2CnB,SAAS,wBACd,QACA,SACW;AACX,QAAM,QAAQ,SAAS,SAAS;AAChC,QAAM,eAAe,SAAS,gBAAgB;AAI9C,SAAO,IAAI,UAAU,QAAkB,OAAO,YAAY;AAC5D;","names":[]}

package/dist/validator-alpha.d.ts

@@ -0,0 +1,83 @@
+/**
+ * `@formspec/validator` — JSON Schema validator for FormSpec
+ *
+ * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},
+ * this package validates data against FormSpec-generated JSON Schemas in any
+ * JavaScript runtime — including secure environments that disallow `new Function()`
+ * (e.g., Cloudflare Workers).
+ *
+ * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so
+ * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.
+ *
+ * @example
+ * ```typescript
+ * import { createFormSpecValidator } from "@formspec/validator";
+ *
+ * const validator = createFormSpecValidator({
+ *   type: "object",
+ *   required: ["name"],
+ *   properties: {
+ *     name: { type: "string" },
+ *     country: { type: "string", "x-formspec-source": "countries" },
+ *   },
+ * });
+ *
+ * const result = validator.validate({ name: "Alice", country: "US" });
+ * // result.valid === true
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+import type { OutputUnit } from '@cfworker/json-schema';
+import type { SchemaDraft } from '@cfworker/json-schema';
+import type { ValidationResult } from '@cfworker/json-schema';
+import { Validator } from '@cfworker/json-schema';
+
+/**
+ * Creates a `Validator` configured for FormSpec-generated JSON Schemas.
+ *
+ * The returned `Validator` uses JSON Schema draft 2020-12 by default and
+ * silently ignores `x-formspec-*` extension keywords — no vocabulary
+ * registration is needed.
+ *
+ * @param schema - A JSON Schema object (typically generated by `@formspec/build`).
+ * @param options - Optional configuration for draft version and error collection behavior.
+ * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.
+ *
+ * @public
+ */
+export declare function createFormSpecValidator(schema: Record<string, unknown>, options?: CreateValidatorOptions): Validator;
+
+/**
+ * Options for `createFormSpecValidator`.
+ *
+ * @public
+ */
+export declare interface CreateValidatorOptions {
+    /**
+     * The JSON Schema draft version to validate against.
+     *
+     * FormSpec generates schemas targeting JSON Schema 2020-12.
+     *
+     * @defaultValue `"2020-12"`
+     */
+    draft?: SchemaDraft;
+    /**
+     * When `true`, validation stops after the first error.
+     * When `false`, all errors are collected.
+     *
+     * @defaultValue `true`
+     */
+    shortCircuit?: boolean;
+}
+
+export { OutputUnit }
+
+export { SchemaDraft }
+
+export { ValidationResult }
+
+export { Validator }
+
+export { }

package/dist/validator-beta.d.ts

@@ -0,0 +1,83 @@
+/**
+ * `@formspec/validator` — JSON Schema validator for FormSpec
+ *
+ * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},
+ * this package validates data against FormSpec-generated JSON Schemas in any
+ * JavaScript runtime — including secure environments that disallow `new Function()`
+ * (e.g., Cloudflare Workers).
+ *
+ * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so
+ * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.
+ *
+ * @example
+ * ```typescript
+ * import { createFormSpecValidator } from "@formspec/validator";
+ *
+ * const validator = createFormSpecValidator({
+ *   type: "object",
+ *   required: ["name"],
+ *   properties: {
+ *     name: { type: "string" },
+ *     country: { type: "string", "x-formspec-source": "countries" },
+ *   },
+ * });
+ *
+ * const result = validator.validate({ name: "Alice", country: "US" });
+ * // result.valid === true
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+import type { OutputUnit } from '@cfworker/json-schema';
+import type { SchemaDraft } from '@cfworker/json-schema';
+import type { ValidationResult } from '@cfworker/json-schema';
+import { Validator } from '@cfworker/json-schema';
+
+/**
+ * Creates a `Validator` configured for FormSpec-generated JSON Schemas.
+ *
+ * The returned `Validator` uses JSON Schema draft 2020-12 by default and
+ * silently ignores `x-formspec-*` extension keywords — no vocabulary
+ * registration is needed.
+ *
+ * @param schema - A JSON Schema object (typically generated by `@formspec/build`).
+ * @param options - Optional configuration for draft version and error collection behavior.
+ * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.
+ *
+ * @public
+ */
+export declare function createFormSpecValidator(schema: Record<string, unknown>, options?: CreateValidatorOptions): Validator;
+
+/**
+ * Options for `createFormSpecValidator`.
+ *
+ * @public
+ */
+export declare interface CreateValidatorOptions {
+    /**
+     * The JSON Schema draft version to validate against.
+     *
+     * FormSpec generates schemas targeting JSON Schema 2020-12.
+     *
+     * @defaultValue `"2020-12"`
+     */
+    draft?: SchemaDraft;
+    /**
+     * When `true`, validation stops after the first error.
+     * When `false`, all errors are collected.
+     *
+     * @defaultValue `true`
+     */
+    shortCircuit?: boolean;
+}
+
+export { OutputUnit }
+
+export { SchemaDraft }
+
+export { ValidationResult }
+
+export { Validator }
+
+export { }

package/dist/validator-internal.d.ts

@@ -0,0 +1,83 @@
+/**
+ * `@formspec/validator` — JSON Schema validator for FormSpec
+ *
+ * Backed by {@link https://github.com/cfworker/cfworker/tree/main/packages/json-schema | @cfworker/json-schema},
+ * this package validates data against FormSpec-generated JSON Schemas in any
+ * JavaScript runtime — including secure environments that disallow `new Function()`
+ * (e.g., Cloudflare Workers).
+ *
+ * Unlike Ajv, `@cfworker/json-schema` silently ignores unknown keywords, so
+ * FormSpec's `x-formspec-*` extension keywords require no vocabulary registration.
+ *
+ * @example
+ * ```typescript
+ * import { createFormSpecValidator } from "@formspec/validator";
+ *
+ * const validator = createFormSpecValidator({
+ *   type: "object",
+ *   required: ["name"],
+ *   properties: {
+ *     name: { type: "string" },
+ *     country: { type: "string", "x-formspec-source": "countries" },
+ *   },
+ * });
+ *
+ * const result = validator.validate({ name: "Alice", country: "US" });
+ * // result.valid === true
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+import type { OutputUnit } from '@cfworker/json-schema';
+import type { SchemaDraft } from '@cfworker/json-schema';
+import type { ValidationResult } from '@cfworker/json-schema';
+import { Validator } from '@cfworker/json-schema';
+
+/**
+ * Creates a `Validator` configured for FormSpec-generated JSON Schemas.
+ *
+ * The returned `Validator` uses JSON Schema draft 2020-12 by default and
+ * silently ignores `x-formspec-*` extension keywords — no vocabulary
+ * registration is needed.
+ *
+ * @param schema - A JSON Schema object (typically generated by `@formspec/build`).
+ * @param options - Optional configuration for draft version and error collection behavior.
+ * @returns A `Validator` instance whose `validate()` method returns a `ValidationResult`.
+ *
+ * @public
+ */
+export declare function createFormSpecValidator(schema: Record<string, unknown>, options?: CreateValidatorOptions): Validator;
+
+/**
+ * Options for `createFormSpecValidator`.
+ *
+ * @public
+ */
+export declare interface CreateValidatorOptions {
+    /**
+     * The JSON Schema draft version to validate against.
+     *
+     * FormSpec generates schemas targeting JSON Schema 2020-12.
+     *
+     * @defaultValue `"2020-12"`
+     */
+    draft?: SchemaDraft;
+    /**
+     * When `true`, validation stops after the first error.
+     * When `false`, all errors are collected.
+     *
+     * @defaultValue `true`
+     */
+    shortCircuit?: boolean;
+}
+
+export { OutputUnit }
+
+export { SchemaDraft }
+
+export { ValidationResult }
+
+export { Validator }
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formspec/validator",
-  "version": "0.1.0-alpha.12",
+  "version": "0.1.0-alpha.26",
   "description": "JSON Schema validator for FormSpec — backed by @cfworker/json-schema, safe for secure runtimes",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -34,12 +34,12 @@
   ],
   "license": "UNLICENSED",
   "scripts": {
-    "build": "tsup && tsc --emitDeclarationOnly && api-extractor run --local",
+    "build": "tsup && tsc --emitDeclarationOnly && pnpm run api-extractor:local",
     "clean": "rm -rf dist temp",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
-    "api-extractor": "api-extractor run",
-    "api-extractor:local": "api-extractor run --local",
-    "api-documenter": "api-documenter markdown -i temp -o docs"
+    "api-extractor": "api-extractor run && node ../../scripts/normalize-generated-markdown.mjs api-report",
+    "api-extractor:local": "api-extractor run --local && node ../../scripts/normalize-generated-markdown.mjs api-report",
+    "api-documenter": "api-documenter markdown -i temp -o docs && node ../../scripts/normalize-generated-markdown.mjs docs"
   }
 }