@zeroxsolutions/response 0.13.0 → 0.14.1

package/CHANGELOG.md

@@ -1,3 +1,92 @@
+## 0.14.1 (2026-09-28)
+
+### 🚀 Features
+
+- **response:** type a serialized collection by the members it was handed ([5f1a2f5](https://github.com/zeroxsolutions/zeroxsolutions/commit/5f1a2f5))
+- **response:** let a collection response declare its meta and links ([7286ca3](https://github.com/zeroxsolutions/zeroxsolutions/commit/7286ca3))
+- **response:** ship the counted meta and offset links a collection sends ([44adb03](https://github.com/zeroxsolutions/zeroxsolutions/commit/44adb03))
+
+### 🩹 Fixes
+
+- **response:** refuse a serialized collection that may lack a declared member ([f2e2c4f](https://github.com/zeroxsolutions/zeroxsolutions/commit/f2e2c4f))
+
+### ❤️ Thank You
+
+- Claude Opus 5.5 (1M context)
+- Lương Văn Tú
+
+## 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

@@ -5,21 +5,38 @@ of `@zeroxsolutions/query`, which owns the query-string half, and shaped the sam
 wire spelling.
 
 ```ts
-import { errorResponse, jsonApiResource, listResponse, okResponse, toOne } from '@zeroxsolutions/response';
+import {
+  countedCollectionMetaSchema,
+  errorResponse,
+  jsonApiResource,
+  listResponse,
+  offsetPaginationLinksSchema,
+  okResponse,
+  toOne,
+} from '@zeroxsolutions/response';
 
 export const subjects = jsonApiResource('subjects', subjectAttributesSchema, {
   relationships: { org: toOne(() => orgs, (row) => row.org) },
 });
 
 responses: {
-  200: listResponse('Subjects', subjects),       // { data: [...], included?, links? }
+  200: listResponse('Subjects', subjects, {      // { data: [...], included?, links, meta }
+    meta: countedCollectionMetaSchema,
+    links: offsetPaginationLinksSchema,
+  }),
   201: okResponse('Subject created', subjects),  // { data: {...}, included?, ... }
   401: errorResponse('Authentication required'), // { errors: [...] }
 }
 
-return c.json(await subjects.serializeMany(rows, { links }, c.req.valid('query')));
+return c.json(await subjects.serializeMany(rows, { links, meta: { total } }, c.req.valid('query')));
 ```
 
+A collection declares the `meta` and `links` it sends on every answer, and each one declared is published
+as required and typed. `serializeMany` types its document off what it is handed, so a handler that drops
+`total` does not compile. A collection that declares neither keeps the standard's optional, free-form
+members. `meta.total` is this house's own member: the cursor-pagination profile's `meta.page.total`
+describes cursor paging, and these collections page by offset.
+
 Both take the **item** on a list and wrap it, so no route restates the carrier. They take a resource
 DECLARATION rather than a bare schema, because a document carries a `type` and its relationships, which
 a schema alone has nowhere to put.
@@ -134,6 +151,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',
   }),
 );
 ```
@@ -258,8 +276,9 @@ those three members and none of them means a path segment, so borrowing one woul
 One root, no subpath, and `src/index.ts` lists every name it publishes:
 
 - `okResponse` / `listResponse` / `errorResponse`, the `JsonApiResponse` they return (exported so a
-  consumer's declaration emit can name it), and `errorDocumentSchema`, which `errorResponse` returns
-  inside it;
+  consumer's declaration emit can name it), `errorDocumentSchema`, which `errorResponse` returns
+  inside it, and `countedCollectionMetaSchema` / `offsetPaginationLinksSchema`, which a collection route
+  passes to `listResponse`;
 - the resource declaration - `jsonApiResource`, `toOne` / `toMany`, `declaredDocumentShape` - and the
   types their signatures name;
 - the error document's types, `JsonApiError`, `BASE_ERROR_CODES`, `toErrorObject` / `toErrorDocument`;
@@ -267,7 +286,7 @@ One root, no subpath, and `src/index.ts` lists every name it publishes:
   the answer, entry and map types they take;
 - `JSON_API_MEDIA_TYPE`.
 
-The document and resource-object schemas, the link and identifier primitives and the serializer
+The document and resource-object schemas, the other link and identifier primitives and the serializer
 functions are what `jsonApiResource` is built from, and the root does not publish them: a resource's own
 `document`, `collectionDocument`, `serialize` and `serializeMany` are the one way to declare and render a
 document.

package/dist/api-response.d.ts

@@ -1,7 +1,8 @@
 import type { output, ZodObject, ZodType } from 'zod';
-import type { CollectionDocument, ResourceDocument } from './document.js';
+import { type CollectionDocument, type ResourceDocument } from './document.js';
 import { errorDocumentSchema } from './errors/index.js';
 import { JSON_API_MEDIA_TYPE } from './media-type.js';
+import type { Meta, PaginationLinks } from './primitives.js';
 import type { JsonApiResource } from './resource.js';
 /**
  * An OpenAPI response object for this spelling - one media type, one schema, and the `Retry-After` a
@@ -45,6 +46,15 @@ export declare function errorResponse(description: string, options?: {
 }): JsonApiResponse<typeof errorDocumentSchema>;
 /** The response object for a single resource, off the resource's own declaration. */
 export declare function okResponse<A extends ZodObject, C = unknown>(description: string, resource: JsonApiResource<A, C>): JsonApiResponse<ZodType<ResourceDocument<output<A>>>>;
-/** The response object for a collection, off the resource's own declaration. */
-export declare function listResponse<A extends ZodObject, C = unknown>(description: string, resource: JsonApiResource<A, C>): JsonApiResponse<ZodType<CollectionDocument<output<A>>>>;
+/**
+ * The response object for a collection, off the resource's own declaration.
+ *
+ * @param members - the `meta` and `links` this route sends on every answer. Each one declared is published
+ *   as required and typed, so a client reads it without narrowing; one left out stays the standard's
+ *   optional, free-form member.
+ */
+export declare function listResponse<A extends ZodObject, C = unknown, M extends ZodType<Meta> = never, L extends ZodType<PaginationLinks> = never>(description: string, resource: JsonApiResource<A, C>, members?: {
+    meta?: M;
+    links?: L;
+}): JsonApiResponse<ZodType<CollectionDocument<output<A>, output<M>, output<L>>>>;
 //# sourceMappingURL=api-response.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"api-response.d.ts","sourceRoot":"","sources":["../src/api-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,OAAO;IAChD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,OAAO,mBAAmB,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;IAC3D,OAAO,CAAC,EAAE;QAAE,aAAa,EAAE,gBAAgB,CAAA;KAAE,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,CAAC,CAAA;KAAE,CAAC;CACzC,CAAC;AAOF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;IAAE,iBAAiB,EAAE,MAAM,CAAA;CAAE,GACtC,eAAe,CAAC,OAAO,mBAAmB,CAAC,CAqB7C;AAED,qFAAqF;AACrF,wBAAgB,UAAU,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,GAAG,OAAO,EACzD,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAC9B,eAAe,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAEvD;AAED,gFAAgF;AAChF,wBAAgB,YAAY,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,GAAG,OAAO,EAC3D,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAC9B,eAAe,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAEzD"}
+{"version":3,"file":"api-response.d.ts","sourceRoot":"","sources":["../src/api-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACtD,OAAO,EAA4B,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACzG,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,OAAO;IAChD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,OAAO,mBAAmB,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;IAC3D,OAAO,CAAC,EAAE;QAAE,aAAa,EAAE,gBAAgB,CAAA;KAAE,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,CAAC,CAAA;KAAE,CAAC;CACzC,CAAC;AAOF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;IAAE,iBAAiB,EAAE,MAAM,CAAA;CAAE,GACtC,eAAe,CAAC,OAAO,mBAAmB,CAAC,CAqB7C;AAED,qFAAqF;AACrF,wBAAgB,UAAU,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,GAAG,OAAO,EACzD,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAC9B,eAAe,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAEvD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,CAAC,SAAS,SAAS,EACnB,CAAC,GAAG,OAAO,EACX,CAAC,SAAS,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,EAC/B,CAAC,SAAS,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,EAE1C,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAC/B,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,CAAC,CAAA;CAAO,GACpC,eAAe,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAQ/E"}

package/dist/api-response.js

@@ -1,3 +1,4 @@
+import { collectionDocumentSchema } from './document.js';
 import { errorDocumentSchema } from './errors/index.js';
 import { JSON_API_MEDIA_TYPE } from './media-type.js';
 const answers = (description, schema) => ({
@@ -35,7 +36,16 @@ export function errorResponse(description, options) {
 export function okResponse(description, resource) {
     return answers(description, resource.document);
 }
-/** The response object for a collection, off the resource's own declaration. */
-export function listResponse(description, resource) {
-    return answers(description, resource.collectionDocument);
+/**
+ * The response object for a collection, off the resource's own declaration.
+ *
+ * @param members - the `meta` and `links` this route sends on every answer. Each one declared is published
+ *   as required and typed, so a client reads it without narrowing; one left out stays the standard's
+ *   optional, free-form member.
+ */
+export function listResponse(description, resource, members = {}) {
+    const declared = members.meta !== undefined || members.links !== undefined;
+    return answers(description, declared
+        ? collectionDocumentSchema(resource, members)
+        : resource.collectionDocument);
 }

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-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.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,19 +20,51 @@ export interface ResourceObject<A> {
 export interface ResourceDocument<A> {
     data: ResourceObject<A>;
     included?: ResourceObject<unknown>[];
-    links?: ResourceLinks;
+    links?: TopLevelLinks;
     meta?: Meta;
     jsonapi?: JsonApiObject;
 }
-/** A collection document - the same members with `data` an array and paginated `links`. */
-export interface CollectionDocument<A> {
+/**
+ * One top-level member of a collection document. A route that declared it sends it every time, so it is
+ * required and typed; one that did not keeps the standard's optional, free-form member.
+ */
+type CollectionMember<K extends 'links' | 'meta', Declared, Loose> = [Declared] extends [never] ? {
+    [P in K]?: Loose;
+} : {
+    [P in K]: Declared;
+};
+/**
+ * A collection document - the same members with `data` an array and paginated `links`.
+ *
+ * `M` and `L` are the `meta` and `links` a route declared, `never` where it declared none.
+ */
+export type CollectionDocument<A, M = never, L = never> = {
     data: ResourceObject<A>[];
     included?: ResourceObject<unknown>[];
-    links?: PaginationLinks;
-    meta?: Meta;
     jsonapi?: JsonApiObject;
-}
-/** Wraps `attributes` into a resource object - `{ type, id, attributes, relationships?, links?, meta? }`. */
+} & CollectionMember<'links', L, PaginationLinks> & CollectionMember<'meta', M, Meta>;
+/**
+ * The collection document `serializeMany` answers for `extras`: each member it was handed is present and
+ * typed as handed, which is what a route's declared members are checked against.
+ *
+ * Tuple-wrapped so it does not distribute: extras that carry `meta` on one branch of a union and not the
+ * other may send none, and must not type it as present.
+ */
+export type CollectionDocumentFor<A, X> = CollectionDocument<A, [
+    X
+] extends [{
+    meta: infer M;
+}] ? M : never, [
+    X
+] extends [{
+    links: infer L;
+}] ? L : never>;
+/**
+ * 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 +72,20 @@ 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`. */
-export declare function collectionDocumentSchema<A = unknown, C = unknown>(root: RelatedResource<C>): ZodType<CollectionDocument<A>>;
+/**
+ * The document for a COLLECTION - the same members, with `data` an array and paginated `links`.
+ *
+ * A member in `members` replaces the standard's optional one, so the route that declared it publishes it
+ * as required. Strict at the top level for the same reason as {@link resourceDocumentSchema}.
+ */
+export declare function collectionDocumentSchema<A = unknown, C = unknown, M = never, L = never>(root: RelatedResource<C>, members?: {
+    meta?: ZodType;
+    links?: ZodType;
+}): ZodType<CollectionDocument<A, M, L>>;
+export {};
 //# 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;;;GAGG;AACH,KAAK,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,MAAM,EAAE,QAAQ,EAAE,KAAK,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GAC3F;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK;CAAE,GACpB;KAAG,CAAC,IAAI,CAAC,GAAG,QAAQ;CAAE,CAAC;AAE3B;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI;IACxD,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,eAAe,CAAC,GAC/C,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,EAAE,CAAC,IAAI,kBAAkB,CAC1D,CAAC,EACD;IAAC,CAAC;CAAC,SAAS,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC,GAAG,CAAC,GAAG,KAAK,EAC3C;IAAC,CAAC;CAAC,SAAS,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAC7C,CAAC;AAEF;;;;;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;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EACrF,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EACxB,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAChD,OAAO,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAQtC"}

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,23 +37,31 @@ 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`. */
-export function collectionDocumentSchema(root) {
-    return z.object({
+/**
+ * The document for a COLLECTION - the same members, with `data` an array and paginated `links`.
+ *
+ * A member in `members` replaces the standard's optional one, so the route that declared it publishes it
+ * as required. Strict at the top level for the same reason as {@link resourceDocumentSchema}.
+ */
+export function collectionDocumentSchema(root, members = {}) {
+    return z.strictObject({
         data: z.array(root.resourceObject),
         included: includedSchema(root).optional(),
-        links: paginationLinksSchema.optional(),
-        meta: metaSchema.optional(),
+        links: members.links ?? paginationLinksSchema.optional(),
+        meta: members.meta ?? metaSchema.optional(),
         jsonapi: jsonApiObjectSchema.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,14 +2,16 @@
  * 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 type { CollectionDocument, Relationship, ResourceDocument, ResourceObject } from './document.js';
+export { createdResponse } from './created-response.js';
+export type { CollectionDocument, CollectionDocumentFor, Relationship, ResourceDocument, ResourceObject, } from './document.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 { countedCollectionMetaSchema, offsetPaginationLinksSchema } 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,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,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,EACV,kBAAkB,EAClB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,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,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAC3F,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,11 +2,13 @@
  * 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';
 export { JSON_API_MEDIA_TYPE } from './media-type.js';
+export { countedCollectionMetaSchema, offsetPaginationLinksSchema } from './primitives.js';
 export { toMany, toOne, } from './relationship.js';
 export { jsonApiResource } from './resource.js';
 export { createUpstreamErrorTranslator } from './upstream-error.js';