schema-components 1.28.2 → 1.29.0

package/dist/themes/shadcn.d.mts

@@ -1,6 +1,27 @@
-import { r as ComponentResolver } from "../renderer-Ul9taFYp.mjs";
+import { r as ComponentResolver } from "../renderer-OaOz-n6-.mjs";
 
 //#region src/themes/shadcn.d.ts
+/**
+ * Component resolver mapping schema field types to shadcn/ui components.
+ *
+ * Pass to `SchemaProvider` to render every `<SchemaComponent>` /
+ * `<SchemaView>` in the subtree with shadcn/ui inputs, selects, and
+ * cards. Built on top of the headless resolver so any field types the
+ * theme does not override fall back to plain HTML.
+ *
+ * Requires `shadcn/ui` components installed in the consuming project.
+ *
+ * @group Themes
+ * @example
+ * ```tsx
+ * import { SchemaProvider } from "schema-components/react/SchemaComponent";
+ * import { shadcnResolver } from "schema-components/themes/shadcn";
+ *
+ * <SchemaProvider resolver={shadcnResolver}>
+ *   <SchemaComponent schema={userSchema} value={user} onChange={setUser} />
+ * </SchemaProvider>
+ * ```
+ */
 declare const shadcnResolver: ComponentResolver;
 //#endregion
 export { shadcnResolver };

package/dist/themes/shadcn.mjs

@@ -185,6 +185,27 @@ function buildResolver() {
 	if (headlessResolver.unknown !== void 0) resolver.unknown = headlessResolver.unknown;
 	return resolver;
 }
+/**
+* Component resolver mapping schema field types to shadcn/ui components.
+*
+* Pass to `SchemaProvider` to render every `<SchemaComponent>` /
+* `<SchemaView>` in the subtree with shadcn/ui inputs, selects, and
+* cards. Built on top of the headless resolver so any field types the
+* theme does not override fall back to plain HTML.
+*
+* Requires `shadcn/ui` components installed in the consuming project.
+*
+* @group Themes
+* @example
+* ```tsx
+* import { SchemaProvider } from "schema-components/react/SchemaComponent";
+* import { shadcnResolver } from "schema-components/themes/shadcn";
+*
+* <SchemaProvider resolver={shadcnResolver}>
+*   <SchemaComponent schema={userSchema} value={user} onChange={setUser} />
+* </SchemaProvider>
+* ```
+*/
 const shadcnResolver = buildResolver();
 //#endregion
 export { shadcnResolver };

package/dist/{types-BTB73MB8.d.mts → types-C2Ay1FEh.d.mts}

@@ -26,6 +26,12 @@ interface SchemaMeta {
   /** Arbitrary UI hints passed through to theme adapters. */
   [key: string]: unknown;
 }
+/**
+ * Resolved editability state for a walked field. `presentation` renders
+ * as a read-only value, `input` as a write-only input (e.g. password
+ * fields), `editable` as a full input that round-trips through
+ * `onChange`. Produced by {@link resolveEditability}.
+ */
 type Editability = "presentation" | "input" | "editable";
 /**
  * Resolved editability state for a single field.
@@ -285,22 +291,39 @@ interface UnknownField extends FieldBase {
  * Use `field.type` to narrow to a specific variant.
  */
 type WalkedField = StringField | NumberField | BooleanField | NullField | EnumField | LiteralField | ObjectField | ArrayField | TupleField | RecordField | UnionField | DiscriminatedUnionField | ConditionalField | NegationField | NeverField | FileField | UnknownField;
+/** Type guard: narrows a `WalkedField` to its `string` variant. */
 declare function isStringField(field: WalkedField): field is StringField;
+/** Type guard: narrows a `WalkedField` to its `number` variant. */
 declare function isNumberField(field: WalkedField): field is NumberField;
+/** Type guard: narrows a `WalkedField` to its `boolean` variant. */
 declare function isBooleanField(field: WalkedField): field is BooleanField;
+/** Type guard: narrows a `WalkedField` to its `null` variant. */
 declare function isNullField(field: WalkedField): field is NullField;
+/** Type guard: narrows a `WalkedField` to its `enum` variant. */
 declare function isEnumField(field: WalkedField): field is EnumField;
+/** Type guard: narrows a `WalkedField` to its `literal` variant. */
 declare function isLiteralField(field: WalkedField): field is LiteralField;
+/** Type guard: narrows a `WalkedField` to its `object` variant. */
 declare function isObjectField(field: WalkedField): field is ObjectField;
+/** Type guard: narrows a `WalkedField` to its `array` variant. */
 declare function isArrayField(field: WalkedField): field is ArrayField;
+/** Type guard: narrows a `WalkedField` to its `tuple` variant. */
 declare function isTupleField(field: WalkedField): field is TupleField;
+/** Type guard: narrows a `WalkedField` to its `record` variant. */
 declare function isRecordField(field: WalkedField): field is RecordField;
+/** Type guard: narrows a `WalkedField` to its plain `union` variant. */
 declare function isUnionField(field: WalkedField): field is UnionField;
+/** Type guard: narrows a `WalkedField` to its `discriminatedUnion` variant. */
 declare function isDiscriminatedUnionField(field: WalkedField): field is DiscriminatedUnionField;
+/** Type guard: narrows a `WalkedField` to its `conditional` (if/then/else) variant. */
 declare function isConditionalField(field: WalkedField): field is ConditionalField;
+/** Type guard: narrows a `WalkedField` to its `negation` (`not`) variant. */
 declare function isNegationField(field: WalkedField): field is NegationField;
+/** Type guard: narrows a `WalkedField` to its `file` variant. */
 declare function isFileField(field: WalkedField): field is FileField;
+/** Type guard: narrows a `WalkedField` to its `never` variant (false schema). */
 declare function isNeverField(field: WalkedField): field is NeverField;
+/** Type guard: narrows a `WalkedField` to its `unknown` variant (permissive). */
 declare function isUnknownField(field: WalkedField): field is UnknownField;
 //#endregion
 export { UnknownField as A, isNeverField as B, RecordField as C, StringField as D, StringConstraints as E, isDiscriminatedUnionField as F, isStringField as G, isNumberField as H, isEnumField as I, isUnknownField as J, isTupleField as K, isFileField as L, isArrayField as M, isBooleanField as N, TupleField as O, isConditionalField as P, isLiteralField as R, ObjectField as S, SchemaType as T, isObjectField as U, isNullField as V, isRecordField as W, resolveEditability as Y, NeverField as _, DiscriminatedUnionField as a, NumberField as b, FieldBase as c, FieldOverrides as d, FileConstraints as f, NegationField as g, LiteralField as h, ConditionalField as i, WalkedField as j, UnionField as k, FieldConstraints as l, JsonObject as m, ArrayField as n, Editability as o, FileField as p, isUnionField as q, BooleanField as r, EnumField as s, ArrayConstraints as t, FieldOverride as u, NullField as v, SchemaMeta as w, ObjectConstraints as x, NumberConstraints as y, isNegationField as z };

package/dist/{version-ZzL5R6cS.d.mts → version-DL8U5RuA.d.mts}

@@ -49,6 +49,12 @@ declare function inferJsonSchemaDraft(schema: Record<string, unknown>): JsonSche
  * triggered the inference, for diagnostic emission.
  */
 declare function inferJsonSchemaDraftWithReason(schema: Record<string, unknown>): InferredDraft;
+/**
+ * Parsed OpenAPI version triple (e.g. `{ major: 3, minor: 1, patch: 0 }`).
+ * Produced by `detectOpenApiVersion` so downstream helpers can switch on
+ * the canonical numeric form rather than re-parsing the raw `openapi` /
+ * `swagger` string.
+ */
 interface OpenApiVersionInfo {
   major: number;
   minor: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "schema-components",
-    "version": "1.28.2",
+    "version": "1.29.0",
     "description": "React components that render UI from Zod schemas, JSON Schema, and OpenAPI documents",
     "type": "module",
     "exports": {
@@ -41,6 +41,7 @@
         "_test:coverage": "vitest run --project=unit --coverage",
         "_build": "tsdown && cp src/html/styles.css dist/html/styles.css",
         "_typedoc": "typedoc",
+        "_api-urls": "node scripts/build-api-urls.mjs",
         "_readme": "node scripts/build-readme-inventory.mjs",
         "typecheck": "turbo run _typecheck",
         "lint": "turbo run _lint",
@@ -51,6 +52,7 @@
         "validate": "turbo run _validate",
         "build": "turbo run _build",
         "typedoc": "turbo run _typedoc",
+        "api-urls": "turbo run _api-urls",
         "readme": "turbo run _readme"
     },
     "keywords": [
@@ -96,6 +98,8 @@
         "tsdown": "0.22.0",
         "tslib": "2.8.1",
         "typedoc": "0.28.19",
+        "typedoc-material-theme": "1.4.1",
+        "typedoc-plugin-mermaid": "1.12.0",
         "typedoc-plugin-missing-exports": "4.1.3",
         "typescript": "6.0.3",
         "typescript-eslint": "8.59.2",