@zeroxsolutions/response 0.12.2 → 0.14.0

package/CHANGELOG.md

@@ -1,3 +1,75 @@
+## 0.14.0 (2026-09-28)
+
+### 🚀 Features
+
+- **response:** answer a created resource with its location ([e9c0086](https://github.com/zeroxsolutions/zeroxsolutions/commit/e9c0086))
+- ⚠️  **response:** refuse a declaration the standard's field rules forbid ([30e6b77](https://github.com/zeroxsolutions/zeroxsolutions/commit/30e6b77))
+
+### 🩹 Fixes
+
+- ⚠️  **response:** walk a pipe's input when checking member names ([0949d22](https://github.com/zeroxsolutions/zeroxsolutions/commit/0949d22))
+- **response:** match link types to their schemas ([0f7c79b](https://github.com/zeroxsolutions/zeroxsolutions/commit/0f7c79b))
+- ⚠️  **response:** refuse a resource id that is not a string ([57f60ab](https://github.com/zeroxsolutions/zeroxsolutions/commit/57f60ab))
+- **response:** keep a primary resource out of included ([c38859f](https://github.com/zeroxsolutions/zeroxsolutions/commit/c38859f))
+- ⚠️  **response:** read only the document members the standard defines ([fc5c51a](https://github.com/zeroxsolutions/zeroxsolutions/commit/fc5c51a))
+- ⚠️  **response:** refuse an error object that carries no member ([7d888ed](https://github.com/zeroxsolutions/zeroxsolutions/commit/7d888ed))
+
+### ⚠️  Breaking Changes
+
+- **response:** walk a pipe's input when checking member names  ([0949d22](https://github.com/zeroxsolutions/zeroxsolutions/commit/0949d22))
+  a nested attribute member name that breaks the
+  standard's member-name rule, and sits behind a .transform() or
+  .pipe(), now throws at jsonApiResource's own declaration where it
+  previously passed unchecked.
+- **response:** refuse a declaration the standard's field rules forbid  ([30e6b77](https://github.com/zeroxsolutions/zeroxsolutions/commit/30e6b77))
+  jsonApiResource throws, and fails to compile, on a field named type or id, a name shared by an attribute and a relationship, an illegal member name, or a foreign-key attribute beside its relationship.
+- **response:** refuse a resource id that is not a string  ([57f60ab](https://github.com/zeroxsolutions/zeroxsolutions/commit/57f60ab))
+  Row['id'] is typed string, and serializing a row, embedded row or foreign key whose id is not a string throws TypeError.
+- **response:** read only the document members the standard defines  ([fc5c51a](https://github.com/zeroxsolutions/zeroxsolutions/commit/fc5c51a))
+  a data document carrying errors, an error document carrying data, and an empty relationship object are refused.
+- **response:** refuse an error object that carries no member  ([7d888ed](https://github.com/zeroxsolutions/zeroxsolutions/commit/7d888ed))
+  toErrorDocument throws on an empty error object.
+
+### ❤️ Thank You
+
+- Claude Opus 5.5 (1M context)
+- Lương Văn Tú
+
+## 0.13.0 (2026-09-27)
+
+### 🚀 Features
+
+- ⚠️  **response:** type the fieldsets and include paths a document answers ([98bbb58](https://github.com/zeroxsolutions/zeroxsolutions/commit/98bbb58))
+- ⚠️  **response:** keep a resource's type, attributes and relationships as literals ([738889e](https://github.com/zeroxsolutions/zeroxsolutions/commit/738889e))
+
+### 🩹 Fixes
+
+- ⚠️  **response:** pin an include path stopping at a wide edge ([515a3e9](https://github.com/zeroxsolutions/zeroxsolutions/commit/515a3e9))
+
+### ⚠️  Breaking Changes
+
+- **response:** pin an include path stopping at a wide edge  ([515a3e9](https://github.com/zeroxsolutions/zeroxsolutions/commit/515a3e9))
+  jsonApiResource's type parameters moved from <A, C> to
+  <T, A, R, C>, so an explicit `jsonApiResource<typeof attrs, Ctx>` no
+  longer compiles; remove the type arguments and let inference type it.
+  The exported ResourceOptions<C> is now ResourceOptions<R>.
+  BREAKING CHANGE: an explicit toOne<Ctx> or toMany<Ctx> no longer
+  compiles; remove the type argument.
+- **response:** type the fieldsets and include paths a document answers  ([98bbb58](https://github.com/zeroxsolutions/zeroxsolutions/commit/98bbb58))
+  declaredDocumentShape answers typed fieldsets and include
+  paths, walks at most three relationships by default, and answers a fieldset
+  only for a type a kept path reaches. DeclaredDocumentShape is removed;
+  TypedDocumentShape replaces it.
+- **response:** keep a resource's type, attributes and relationships as literals  ([738889e](https://github.com/zeroxsolutions/zeroxsolutions/commit/738889e))
+  toOne and toMany take the related resource as their first type
+  parameter and infer the loader context; a call passing the context explicitly,
+  toOne<Ctx>(...), no longer compiles and drops the explicit argument.
+
+### ❤️ Thank You
+
+- Claude Opus 5.5 (1M context)
+- Lương Văn Tú
+
 ## 0.12.2 (2026-09-27)
 
 ### 🚀 Features

package/README.md

@@ -134,6 +134,7 @@ app.onError(
     namespace: 'academics',   // every code THESE handlers mint carries it, so one surface has one vocabulary
     category: ['academics', 'http'],
     resolve: createDomainErrorResolver(academicsErrors),
+    authenticationChallenge: 'Bearer',
   }),
 );
 ```

package/dist/created-response.d.ts

@@ -0,0 +1,23 @@
+import type { Link } from './primitives.js';
+/**
+ * The arguments of a 201 that created `document`'s resource: the document, the status, and the `Location` the standard
+ * asks a 201 to carry. Spread into `c.json(...)`.
+ *
+ * `type` and `id` sit in the bound alongside `links`, both of which every `ResourceObject` carries: a document
+ * whose resource has no `links` at all would otherwise share no property with a bound of `links` alone, which
+ * is a "weak type" TypeScript refuses to accept a value for - and a resource with no self link is the common case.
+ *
+ * @throws Error when the resource's `self` link names another location, since the standard requires the two to match
+ */
+export declare function createdResponse<D extends {
+    data: {
+        type: string;
+        id: string;
+        links?: {
+            self?: Link;
+        };
+    };
+}>(document: D, location: string): readonly [D, 201, {
+    Location: string;
+}];
+//# sourceMappingURL=created-response.d.ts.map

package/dist/created-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"created-response.d.ts","sourceRoot":"","sources":["../src/created-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAM5C;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,EACvG,QAAQ,EAAE,CAAC,EACX,QAAQ,EAAE,MAAM,GACf,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAMzC"}

package/dist/created-response.js

@@ -0,0 +1,19 @@
+/** Where a link points, whichever of the standard's forms it takes. */
+const hrefOf = (link) => link === null || link === undefined ? undefined : typeof link === 'string' ? link : link.href;
+/**
+ * The arguments of a 201 that created `document`'s resource: the document, the status, and the `Location` the standard
+ * asks a 201 to carry. Spread into `c.json(...)`.
+ *
+ * `type` and `id` sit in the bound alongside `links`, both of which every `ResourceObject` carries: a document
+ * whose resource has no `links` at all would otherwise share no property with a bound of `links` alone, which
+ * is a "weak type" TypeScript refuses to accept a value for - and a resource with no self link is the common case.
+ *
+ * @throws Error when the resource's `self` link names another location, since the standard requires the two to match
+ */
+export function createdResponse(document, location) {
+    const self = hrefOf(document.data.links?.self);
+    if (self !== undefined && self !== location) {
+        throw new Error(`The created resource's self link "${self}" differs from its Location "${location}".`);
+    }
+    return [document, 201, { Location: location }];
+}

package/dist/document-graph.d.ts

@@ -0,0 +1,58 @@
+import type { ZodObject } from 'zod';
+import type { RelatedResource } from './relationship.js';
+/** Counts a depth down by one; index 0 is where a walk stops. */
+type Down = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8];
+type NoMembers = Record<never, never>;
+/**
+ * A resource's relationship map. One declaring none carries `Record<string, never>`, whose keys are every string, so
+ * it is read as having no keys at all.
+ */
+type RelationshipsOf<R> = R extends {
+    readonly relationships: infer M;
+} ? [M[keyof M]] extends [never] ? NoMembers : M : NoMembers;
+type RelatedOf<D> = D extends {
+    readonly related: () => infer X;
+} ? X : never;
+type TypeOf<X> = X extends {
+    readonly type: infer T extends string;
+} ? T : never;
+type AttributesOf<X> = X extends {
+    readonly attributes: ZodObject<infer S>;
+} ? S : NoMembers;
+/** True where an edge was declared against the wide `RelatedResource`, which knows no type name. */
+type IsWide<X> = string extends TypeOf<X> ? true : false;
+/**
+ * Every dotted relationship path from `R`, at most `Depth` relationships long. A path never revisits a type,
+ * which is the rule `declaredDocumentShape` walks by, and a wide edge contributes its own name and nothing below.
+ *
+ * It names a resource's relationship paths, not the drizzle relation paths `@zeroxsolutions/db` exports under the same
+ * name `IncludePath`; a module importing both must alias one.
+ */
+export type IncludePath<R, Depth extends number = 3, Seen extends string = TypeOf<R>> = Depth extends 0 ? never : {
+    [K in keyof RelationshipsOf<R> & string]: RelatedOf<RelationshipsOf<R>[K]> extends infer X ? IsWide<X> extends true ? K : TypeOf<X> extends Seen ? never : K | `${K}.${IncludePath<X, Down[Depth], Seen | TypeOf<X>>}` : never;
+}[keyof RelationshipsOf<R> & string];
+/** The resources those paths reach, `R` first. A wide edge reaches nothing a type could name. */
+export type ReachableResource<R, Depth extends number = 3, Seen extends string = TypeOf<R>> = R | (Depth extends 0 ? never : {
+    [K in keyof RelationshipsOf<R> & string]: RelatedOf<RelationshipsOf<R>[K]> extends infer X ? IsWide<X> extends true ? never : TypeOf<X> extends Seen ? never : ReachableResource<X, Down[Depth], Seen | TypeOf<X>> : never;
+}[keyof RelationshipsOf<R> & string]);
+/** The type names a document rooted at `R` can carry. */
+export type ReachableType<R, Depth extends number = 3> = TypeOf<ReachableResource<R, Depth>>;
+/** What a fieldset of `X` may name: its attributes and its relationships, which the standard calls its fields. */
+export type FieldName<X> = (keyof AttributesOf<X> | keyof RelationshipsOf<X>) & string;
+/** A sparse fieldset per reachable type. */
+export type Fieldsets<R, Depth extends number = 3> = {
+    [X in ReachableResource<R, Depth> as TypeOf<X>]?: readonly FieldName<X>[];
+};
+/** What `declaredDocumentShape` answers, typed off the same graph. */
+export interface TypedDocumentShape<R, Depth extends number> {
+    /** Every reachable type with the fields it publishes: its attribute names, then its relationship names. */
+    fields: {
+        [X in ReachableResource<R, Depth> as TypeOf<X>]: FieldName<X>[];
+    };
+    /** Every relationship path from the root, dotted for a nested one. */
+    include: IncludePath<R, Depth>[];
+}
+/** A resource as far as the graph types care; `RelatedResource` already is one. */
+export type GraphRoot = RelatedResource<never>;
+export {};
+//# sourceMappingURL=document-graph.d.ts.map

package/dist/document-graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-graph.d.ts","sourceRoot":"","sources":["../src/document-graph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AACrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,iEAAiE;AACjE,KAAK,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAE/C,KAAK,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAEtC;;;GAGG;AACH,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;CAAE,GACnE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1B,SAAS,GACT,CAAC,GACH,SAAS,CAAC;AACd,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAC9E,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AACjF,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,SAAS,CAAC;AAE7F,oGAAoG;AACpG,KAAK,MAAM,CAAC,CAAC,IAAI,MAAM,SAAS,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEzD;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,GACnG,KAAK,GACL;KACG,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,GACtF,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GACpB,CAAC,GACD,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GACpB,KAAK,GACL,CAAC,GAAG,GAAG,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAC/D,KAAK;CACV,CAAC,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AAEzC,iGAAiG;AACjG,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IACtF,CAAC,GACD,CAAC,KAAK,SAAS,CAAC,GACZ,KAAK,GACL;KACG,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,GACtF,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GACpB,KAAK,GACL,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GACpB,KAAK,GACL,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GACvD,KAAK;CACV,CAAC,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;AAE9C,yDAAyD;AACzD,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AAE7F,kHAAkH;AAClH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;AAEvF,4CAA4C;AAC5C,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,CAAC,IAAI;KAClD,CAAC,IAAI,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE;CAC1E,CAAC;AAEF,sEAAsE;AACtE,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM;IACzD,2GAA2G;IAC3G,MAAM,EAAE;SAAG,CAAC,IAAI,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE;KAAE,CAAC;IAC5E,sEAAsE;IACtE,OAAO,EAAE,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;CAClC;AAED,mFAAmF;AACnF,MAAM,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC"}

package/dist/document-graph.js

@@ -0,0 +1 @@
+export {};

package/dist/document-load.d.ts

@@ -4,7 +4,7 @@
  * relationship declares belongs to `relationship.ts`.
  */
 import type { RelatedResource, RelationshipDef } from './relationship.js';
-import type { LoadedRows, RequestedDocumentShape, Row } from './serialize.js';
+import { type LoadedRows, type RequestedDocumentShape, type Row } from './serialize.js';
 /**
  * What one loaded relationship hands the serializer for a row: the row its loader answered, or the
  * identifier alone where it answered none.

package/dist/document-load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-load.d.ts","sourceRoot":"","sources":["../src/document-load.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,sBAAsB,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AA0B9E;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,EACvB,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,UAAU,GAAG,SAAS,GAC7B,GAAG,GAAG,GAAG,EAAE,GAAG,IAAI,CAIpB;AA0BD;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAAC,CAAC,EACtC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,SAAS,GAAG,EAAE,EACpB,SAAS,EAAE,sBAAsB,GAAG,SAAS,EAC7C,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CA8BjC"}
+{"version":3,"file":"document-load.d.ts","sourceRoot":"","sources":["../src/document-load.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAe,KAAK,UAAU,EAAE,KAAK,sBAAsB,EAAE,KAAK,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAmCrG;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,EACvB,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,UAAU,GAAG,SAAS,GAC7B,GAAG,GAAG,GAAG,EAAE,GAAG,IAAI,CAKpB;AA2BD;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAAC,CAAC,EACtC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,SAAS,GAAG,EAAE,EACpB,SAAS,EAAE,sBAAsB,GAAG,SAAS,EAC7C,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CA8BjC"}

package/dist/document-load.js

@@ -1,7 +1,18 @@
-/** The ids one row carries for a loaded relationship. A null or absent key asks for nothing. */
-function readIds(value) {
+import { assertRowId } from './serialize.js';
+/**
+ * The ids one row carries for a loaded relationship. A null or absent key asks for nothing; any other
+ * non-string is refused rather than silently dropped, naming the relationship's own related `type`.
+ */
+function readIds(value, type) {
     const values = Array.isArray(value) ? value : [value];
-    return values.filter((one) => typeof one === 'string');
+    const ids = [];
+    for (const one of values) {
+        if (one === null || one === undefined)
+            continue;
+        assertRowId(type, { id: one });
+        ids.push(one);
+    }
+    return ids;
 }
 /** The rows one row already carries for a relationship that declares no loader. */
 function readRows(value) {
@@ -16,8 +27,9 @@ function readRows(value) {
  * linkage a client reads - only what lands under `included`.
  */
 export function loadedRelated(def, row, loaded) {
-    const answered = loaded?.get(def.related().type);
-    const rows = readIds(def.read(row)).map((id) => answered?.get(id) ?? { id });
+    const type = def.related().type;
+    const answered = loaded?.get(type);
+    const rows = readIds(def.read(row), type).map((id) => answered?.get(id) ?? { id });
     return def.cardinality === 'many' ? rows : (rows.at(0) ?? null);
 }
 /** Runs one relationship's loader, and answers the rows the next depth reads its ids off. */
@@ -29,13 +41,13 @@ async function loadRelated(def, rows, loaded, context) {
     const type = def.related().type;
     const answered = loaded.get(type) ?? new Map();
     loaded.set(type, answered);
-    const ids = [...new Set(rows.flatMap((row) => readIds(def.read(row))))];
+    const ids = [...new Set(rows.flatMap((row) => readIds(def.read(row), type)))];
     if (ids.length === 0)
         return [];
     const related = await load(ids, context);
     for (const row of related) {
-        if (typeof row.id === 'string')
-            answered.set(row.id, row);
+        assertRowId(type, row);
+        answered.set(row.id, row);
     }
     return related;
 }

package/dist/document-shape.d.ts

@@ -1,17 +1,19 @@
-import { type RelatedResource } from './relationship.js';
-/** The fieldsets and relationship paths one resource declaration can answer. */
-export interface DeclaredDocumentShape {
-    /** Every reachable type with the fields it publishes: its attribute names, then its relationship names. */
-    fields: Record<string, string[]>;
-    /** Every relationship path from the root, dotted for a nested one. */
-    include: string[];
-}
+import type { GraphRoot, TypedDocumentShape } from './document-graph.js';
 /**
- * What a client may ask a document to be shaped as, read off the declaration itself - the permit-list a query guard
+ * What a client may ask a document to be shaped as, read off the declaration itself - the permit list a query guard
  * needs, without a second copy of it.
  *
  * The attribute keys ARE the projection, so a list written by hand beside them permits a column the resource stopped
  * publishing, or refuses one it started, with both halves compiling and both suites green.
+ *
+ * `maxIncludeDepth` bounds a path in relationships, 3 by default: the depth a route's own relation load reaches. A
+ * fieldset is answered only for a type some kept path reaches, the root included.
+ *
+ * The answer's type is bounded by `maxIncludeDepth` only where it is a literal; a `number` variable leaves the type
+ * at its default depth of 3. Below an edge whose thunk is annotated as the wide `RelatedResource`, the walk still
+ * descends while the type stops at that edge, so the value can permit paths and types the type does not offer.
  */
-export declare function declaredDocumentShape<C>(root: RelatedResource<C>): DeclaredDocumentShape;
+export declare function declaredDocumentShape<R extends GraphRoot, const D extends number = 3>(root: R, options?: {
+    maxIncludeDepth?: D;
+}): TypedDocumentShape<R, D>;
 //# sourceMappingURL=document-shape.d.ts.map

package/dist/document-shape.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-shape.d.ts","sourceRoot":"","sources":["../src/document-shape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7E,gFAAgF;AAChF,MAAM,WAAW,qBAAqB;IACpC,2GAA2G;IAC3G,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACjC,sEAAsE;IACtE,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAuBxF"}
+{"version":3,"file":"document-shape.d.ts","sourceRoot":"","sources":["../src/document-shape.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAGzE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EACnF,IAAI,EAAE,CAAC,EACP,OAAO,GAAE;IAAE,eAAe,CAAC,EAAE,CAAC,CAAA;CAAO,GACpC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAyB1B"}

package/dist/document-shape.js

@@ -1,29 +1,40 @@
-import { reachableResources } from './relationship.js';
 /**
- * What a client may ask a document to be shaped as, read off the declaration itself - the permit-list a query guard
+ * What a client may ask a document to be shaped as, read off the declaration itself - the permit list a query guard
  * needs, without a second copy of it.
  *
  * The attribute keys ARE the projection, so a list written by hand beside them permits a column the resource stopped
  * publishing, or refuses one it started, with both halves compiling and both suites green.
+ *
+ * `maxIncludeDepth` bounds a path in relationships, 3 by default: the depth a route's own relation load reaches. A
+ * fieldset is answered only for a type some kept path reaches, the root included.
+ *
+ * The answer's type is bounded by `maxIncludeDepth` only where it is a literal; a `number` variable leaves the type
+ * at its default depth of 3. Below an edge whose thunk is annotated as the wide `RelatedResource`, the walk still
+ * descends while the type stops at that edge, so the value can permit paths and types the type does not offer.
  */
-export function declaredDocumentShape(root) {
-    const fields = Object.fromEntries(reachableResources(root).map((resource) => [
-        resource.type,
-        [...Object.keys(resource.attributes.shape), ...Object.keys(resource.relationships)],
-    ]));
+export function declaredDocumentShape(root, options = {}) {
+    const maxDepth = options.maxIncludeDepth ?? 3;
+    const reached = new Map([[root.type, root]]);
     const include = [];
     // A path never revisits a type: two resources naming each other make `class.subject.class...` infinite, and the
     // second lap addresses the same rows the first one already compounded.
-    const walk = (resource, prefix, seen) => {
+    const walk = (resource, prefix, seen, depth) => {
+        if (depth >= maxDepth)
+            return;
         for (const [name, def] of Object.entries(resource.relationships)) {
             const related = def.related();
             if (seen.has(related.type))
                 continue;
             const path = prefix === '' ? name : `${prefix}.${name}`;
             include.push(path);
-            walk(related, path, new Set([...seen, related.type]));
+            reached.set(related.type, related);
+            walk(related, path, new Set([...seen, related.type]), depth + 1);
         }
     };
-    walk(root, '', new Set([root.type]));
+    walk(root, '', new Set([root.type]), 0);
+    const fields = Object.fromEntries([...reached.values()].map((resource) => [
+        resource.type,
+        [...Object.keys(resource.attributes.shape), ...Object.keys(resource.relationships)],
+    ]));
     return { fields, include };
 }

package/dist/document.d.ts

@@ -1,10 +1,10 @@
 import type { ZodObject, ZodType } from 'zod';
-import { type JsonApiObject, type Meta, type PaginationLinks, type ResourceIdentifier, type ResourceLinks } from './primitives.js';
+import { type JsonApiObject, type Meta, type PaginationLinks, type RelationshipLinks, type ResourceIdentifier, type ResourceLinks, type TopLevelLinks } from './primitives.js';
 import { type RelatedResource, type RelationshipDef } from './relationship.js';
 /** One relationship as a document carries it - the linkage, plus its own links and meta. */
 export interface Relationship {
     data?: ResourceIdentifier | ResourceIdentifier[] | null;
-    links?: ResourceLinks;
+    links?: RelationshipLinks;
     meta?: Meta;
 }
 /** A resource object, with `attributes` carrying the declared attribute type. */
@@ -20,7 +20,7 @@ export interface ResourceObject<A> {
 export interface ResourceDocument<A> {
     data: ResourceObject<A>;
     included?: ResourceObject<unknown>[];
-    links?: ResourceLinks;
+    links?: TopLevelLinks;
     meta?: Meta;
     jsonapi?: JsonApiObject;
 }
@@ -32,7 +32,12 @@ export interface CollectionDocument<A> {
     meta?: Meta;
     jsonapi?: JsonApiObject;
 }
-/** Wraps `attributes` into a resource object - `{ type, id, attributes, relationships?, links?, meta? }`. */
+/**
+ * Wraps `attributes` into a resource object - `{ type, id, attributes?, relationships?, links?, meta? }`.
+ *
+ * `attributes` parses as absent here, unlike {@link ResourceObject}'s own required member: this schema
+ * also validates a document read off another server, which may publish a resource with none.
+ */
 export declare function resourceObjectSchema<C>(type: string, attributes: ZodObject, relationships?: Readonly<Record<string, RelationshipDef<C>>>): ZodType;
 /**
  * The document for a SINGLE resource - `{ data, included?, links?, meta?, jsonapi? }`.
@@ -40,8 +45,15 @@ export declare function resourceObjectSchema<C>(type: string, attributes: ZodObj
  * `A` is asserted rather than inferred: the schema is assembled from a relationship graph reached
  * through thunks, so nothing static carries the attribute type, and a client typing a route off this
  * schema would otherwise read every member as `unknown`.
+ *
+ * Strict at the top level: the standard forbids any top-level member beyond these (extension members
+ * aside), which is what refuses a `data` document that also carries `errors`.
  */
 export declare function resourceDocumentSchema<A = unknown, C = unknown>(root: RelatedResource<C>): ZodType<ResourceDocument<A>>;
-/** The document for a COLLECTION - the same members, with `data` an array and paginated `links`. */
+/**
+ * The document for a COLLECTION - the same members, with `data` an array and paginated `links`.
+ *
+ * Strict at the top level for the same reason as {@link resourceDocumentSchema}.
+ */
 export declare function collectionDocumentSchema<A = unknown, C = unknown>(root: RelatedResource<C>): ZodType<CollectionDocument<A>>;
 //# sourceMappingURL=document.d.ts.map

package/dist/document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAC9C,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,IAAI,EACT,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAA2C,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAExH,4FAA4F;AAC5F,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;IACxD,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,iFAAiF;AACjF,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,yGAAyG;AACzG,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,2FAA2F;AAC3F,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,6GAA6G;AAC7G,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,SAAS,EACrB,aAAa,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAM,GAC/D,OAAO,CAUT;AAgBD;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAC7D,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAQ9B;AAED,oGAAoG;AACpG,wBAAgB,wBAAwB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAC/D,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAQhC"}
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAC9C,OAAO,EAML,KAAK,aAAa,EAClB,KAAK,IAAI,EACT,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,aAAa,EACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAA2C,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAExH,4FAA4F;AAC5F,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;IACxD,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,iFAAiF;AACjF,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IAGX,UAAU,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,yGAAyG;AACzG,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,2FAA2F;AAC3F,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,SAAS,EACrB,aAAa,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAM,GAC/D,OAAO,CAUT;AAgBD;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAC7D,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAQ9B;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAC/D,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAQhC"}

package/dist/document.js

@@ -1,13 +1,18 @@
 import { z } from 'zod';
-import { jsonApiObjectSchema, metaSchema, paginationLinksSchema, resourceLinksSchema, } from './primitives.js';
+import { jsonApiObjectSchema, metaSchema, paginationLinksSchema, resourceLinksSchema, topLevelLinksSchema, } from './primitives.js';
 import { relationshipsSchema, reachableResources } from './relationship.js';
-/** Wraps `attributes` into a resource object - `{ type, id, attributes, relationships?, links?, meta? }`. */
+/**
+ * Wraps `attributes` into a resource object - `{ type, id, attributes?, relationships?, links?, meta? }`.
+ *
+ * `attributes` parses as absent here, unlike {@link ResourceObject}'s own required member: this schema
+ * also validates a document read off another server, which may publish a resource with none.
+ */
 export function resourceObjectSchema(type, attributes, relationships = {}) {
     const linkage = relationshipsSchema(relationships);
     return z.object({
         type: z.literal(type),
         id: z.string(),
-        attributes,
+        attributes: attributes.optional(),
         ...(linkage ? { relationships: linkage.optional() } : {}),
         links: resourceLinksSchema.optional(),
         meta: metaSchema.optional(),
@@ -32,19 +37,26 @@ function includedSchema(root) {
  * `A` is asserted rather than inferred: the schema is assembled from a relationship graph reached
  * through thunks, so nothing static carries the attribute type, and a client typing a route off this
  * schema would otherwise read every member as `unknown`.
+ *
+ * Strict at the top level: the standard forbids any top-level member beyond these (extension members
+ * aside), which is what refuses a `data` document that also carries `errors`.
  */
 export function resourceDocumentSchema(root) {
-    return z.object({
+    return z.strictObject({
         data: root.resourceObject,
         included: includedSchema(root).optional(),
-        links: resourceLinksSchema.optional(),
+        links: topLevelLinksSchema.optional(),
         meta: metaSchema.optional(),
         jsonapi: jsonApiObjectSchema.optional(),
     });
 }
-/** The document for a COLLECTION - the same members, with `data` an array and paginated `links`. */
+/**
+ * The document for a COLLECTION - the same members, with `data` an array and paginated `links`.
+ *
+ * Strict at the top level for the same reason as {@link resourceDocumentSchema}.
+ */
 export function collectionDocumentSchema(root) {
-    return z.object({
+    return z.strictObject({
         data: z.array(root.resourceObject),
         included: includedSchema(root).optional(),
         links: paginationLinksSchema.optional(),

package/dist/errors/error-document.d.ts

@@ -42,7 +42,7 @@ export declare const errorLinksSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodNull]>>;
 }, z.core.$strip>;
 export type ErrorLinks = z.infer<typeof errorLinksSchema>;
-/** A single JSON:API error object; every member is optional, and nothing here enforces the spec's at-least-one. */
+/** A single JSON:API error object: every member is optional, and at least one is present. */
 export declare const errorObjectSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     links: z.ZodOptional<z.ZodObject<{
@@ -94,6 +94,9 @@ export type ErrorObject = z.infer<typeof errorObjectSchema>;
 /**
  * A JSON:API error document - a top-level `errors` array of at least one member, which never carries `data`.
  *
+ * Strict at the top level: the standard forbids any top-level member beyond these (extension members
+ * aside), which is what refuses a document that carries both `errors` and `data`.
+ *
  * Nothing here renders the top-level `meta` or `links`. They are declared so the schema `errorResponse` publishes is
  * the whole document, and a client parsing another server's document keeps them.
  */
@@ -182,8 +185,10 @@ export declare const errorDocumentSchema: z.ZodObject<{
     }, z.core.$strip>>;
     jsonapi: z.ZodOptional<z.ZodObject<{
         version: z.ZodOptional<z.ZodString>;
+        ext: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        profile: z.ZodOptional<z.ZodArray<z.ZodString>>;
         meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, z.core.$strip>>;
-}, z.core.$strip>;
+}, z.core.$strict>;
 export type ErrorDocument = z.infer<typeof errorDocumentSchema>;
 //# sourceMappingURL=error-document.d.ts.map

package/dist/errors/error-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-document.d.ts","sourceRoot":"","sources":["../../src/errors/error-document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,sFAAsF;AACtF,eAAO,MAAM,iBAAiB;;;;iBAMlB,CAAC;AACb,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,qGAAqG;AACrG,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA8D,CAAC;AAC5F,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,mHAAmH;AACnH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAWlB,CAAC;AACb,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}
+{"version":3,"file":"error-document.d.ts","sourceRoot":"","sources":["../../src/errors/error-document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,sFAAsF;AACtF,eAAO,MAAM,iBAAiB;;;;iBAMlB,CAAC;AACb,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,qGAAqG;AACrG,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA8D,CAAC;AAC5F,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,6FAA6F;AAC7F,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAYoF,CAAC;AACnH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAK9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/errors/error-document.js

@@ -10,7 +10,7 @@ export const errorSourceSchema = z
     .partial();
 /** An error object's `links`: a page about this occurrence, and a page about its type of problem. */
 export const errorLinksSchema = z.object({ about: linkSchema, type: linkSchema }).partial();
-/** A single JSON:API error object; every member is optional, and nothing here enforces the spec's at-least-one. */
+/** A single JSON:API error object: every member is optional, and at least one is present. */
 export const errorObjectSchema = z
     .object({
     id: z.string(),
@@ -22,14 +22,18 @@ export const errorObjectSchema = z
     source: errorSourceSchema,
     meta: metaSchema,
 })
-    .partial();
+    .partial()
+    .refine((object) => Object.keys(object).length > 0, { message: 'An error object carries at least one member.' });
 /**
  * A JSON:API error document - a top-level `errors` array of at least one member, which never carries `data`.
  *
+ * Strict at the top level: the standard forbids any top-level member beyond these (extension members
+ * aside), which is what refuses a document that carries both `errors` and `data`.
+ *
  * Nothing here renders the top-level `meta` or `links`. They are declared so the schema `errorResponse` publishes is
  * the whole document, and a client parsing another server's document keeps them.
  */
-export const errorDocumentSchema = z.object({
+export const errorDocumentSchema = z.strictObject({
     errors: z.array(errorObjectSchema).min(1),
     meta: metaSchema.optional(),
     links: z.object({ self: linkSchema, describedby: linkSchema }).partial().optional(),

package/dist/index.d.ts

@@ -2,13 +2,15 @@
  * The response half of the HTTP contract, in the one wire spelling this house answers: a JSON:API document.
  */
 export { errorResponse, listResponse, okResponse, type JsonApiResponse, type RetryAfterHeader, } from './api-response.js';
+export { createdResponse } from './created-response.js';
 export type { CollectionDocument, Relationship, ResourceDocument, ResourceObject } from './document.js';
-export { declaredDocumentShape, type DeclaredDocumentShape } from './document-shape.js';
+export * from './document-graph.js';
+export { declaredDocumentShape } from './document-shape.js';
 export { createDomainErrorResolver, defineErrorMap, errorEntry, type DomainErrorAnswer, type DomainErrorEntry, } from './domain-error-resolver.js';
 export type { DomainErrorMap, ErrorClass, UpstreamErrorMap } from './error-map.js';
 export { BASE_ERROR_CODES, errorDocumentSchema, JsonApiError, toErrorDocument, toErrorObject, type ErrorDocument, type ErrorLinks, type ErrorObject, type ErrorSource, type ErrorStatus, type JsonApiErrorInit, type ResolvedError, } from './errors/index.js';
 export { JSON_API_MEDIA_TYPE } from './media-type.js';
-export type { JsonApiObject, Link, Meta, PaginationLinks, ResourceIdentifier, ResourceLinks } from './primitives.js';
+export type { JsonApiObject, Link, Meta, PaginationLinks, RelationshipLinks, ResourceIdentifier, ResourceLinks, TopLevelLinks, } from './primitives.js';
 export { toMany, toOne, type LoadContextArguments, type RelatedResource, type RelationshipDef, type RelationshipLoader, type RelationshipOptions, } from './relationship.js';
 export { jsonApiResource, type JsonApiResource, type ResourceOptions } from './resource.js';
 export type { CollectionExtras, LoadedRows, RequestedDocumentShape, ResourceSerializer, Row } from './serialize.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,aAAa,EACb,YAAY,EACZ,UAAU,EACV,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACxG,OAAO,EAAE,qBAAqB,EAAE,KAAK,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EACL,yBAAyB,EACzB,cAAc,EACd,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACtB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,aAAa,GACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrH,OAAO,EACL,MAAM,EACN,KAAK,EACL,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAC5F,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,EAAE,6BAA6B,EAAE,KAAK,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,aAAa,EACb,YAAY,EACZ,UAAU,EACV,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACxG,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EACL,yBAAyB,EACzB,cAAc,EACd,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACtB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,aAAa,GACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,YAAY,EACV,aAAa,EACb,IAAI,EACJ,IAAI,EACJ,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,aAAa,GACd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,MAAM,EACN,KAAK,EACL,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAC5F,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,EAAE,6BAA6B,EAAE,KAAK,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -2,6 +2,8 @@
  * The response half of the HTTP contract, in the one wire spelling this house answers: a JSON:API document.
  */
 export { errorResponse, listResponse, okResponse, } from './api-response.js';
+export { createdResponse } from './created-response.js';
+export * from './document-graph.js';
 export { declaredDocumentShape } from './document-shape.js';
 export { createDomainErrorResolver, defineErrorMap, errorEntry, } from './domain-error-resolver.js';
 export { BASE_ERROR_CODES, errorDocumentSchema, JsonApiError, toErrorDocument, toErrorObject, } from './errors/index.js';

package/dist/member-name.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Whether a string is a legal JSON:API member name.
+ *
+ * Copied rather than imported at `packages/query/src/bracket-params.ts`'s own `isMemberName`: this
+ * package may not import `@zeroxsolutions/query` (nor the reverse), so each side of that boundary
+ * keeps its own copy of the one rule instead.
+ */
+export declare function isMemberName(name: string): boolean;
+//# sourceMappingURL=member-name.d.ts.map

package/dist/member-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"member-name.d.ts","sourceRoot":"","sources":["../src/member-name.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAElD"}

package/dist/member-name.js

@@ -0,0 +1,15 @@
+/** Characters a member name may start or end with: the standard's globally allowed characters. */
+const GLOBAL = 'a-zA-Z0-9\\u0080-\\u{10FFFF}';
+/** Additionally allowed between the first and last character: hyphen, low line and space. */
+const MIDDLE = '\\-_ ';
+const MEMBER_NAME = new RegExp(`^[${GLOBAL}](?:[${GLOBAL}${MIDDLE}]*[${GLOBAL}])?$`, 'u');
+/**
+ * Whether a string is a legal JSON:API member name.
+ *
+ * Copied rather than imported at `packages/query/src/bracket-params.ts`'s own `isMemberName`: this
+ * package may not import `@zeroxsolutions/query` (nor the reverse), so each side of that boundary
+ * keeps its own copy of the one rule instead.
+ */
+export function isMemberName(name) {
+    return MEMBER_NAME.test(name);
+}