@haddowg/json-api-client 1.0.0 → 1.1.0

package/README.md

@@ -289,6 +289,10 @@ const client = createClient({ baseUrl: 'https://music.example', transport })
 
 Retries are deliberately out of scope here — the transport (or the TanStack layer) owns them.
 
+`req.signal` is set when the caller passed a `signal` to a read (`client.albums.list({ signal })`
+or `$next({ signal })`). Forward it to your HTTP library so the request can be cancelled; the
+default `fetch` transport passes it to `fetch`.
+
 ## Opt-in validation
 
 The core runtime trusts the wire (you own both ends; the envelope is invariant) and only runs the

package/dist/ajv.d.cts

@@ -1,4 +1,4 @@
-import { a as Validator, n as SchemaMap } from "./validate-BmyPbJCK.cjs";
+import { a as Validator, n as SchemaMap } from "./validate-CfrCMZkA.cjs";
 import { ValidateFunction } from "ajv";
 
 //#region src/ajv.d.ts

package/dist/ajv.d.mts

@@ -1,4 +1,4 @@
-import { a as Validator, n as SchemaMap } from "./validate-BmyPbJCK.mjs";
+import { a as Validator, n as SchemaMap } from "./validate-CfrCMZkA.mjs";
 import { ValidateFunction } from "ajv";
 
 //#region src/ajv.d.ts

package/dist/index.cjs

@@ -395,10 +395,13 @@ function attachPage(arr, kind, meta, links, ctx, linkage) {
 	};
 	if (meta !== void 0) page.meta = meta;
 	defineGetter(arr, "$page", () => page);
-	define(arr, "$next", () => navigateLink(page.links.next, ctx, linkage, kind));
-	define(arr, "$prev", () => navigateLink(page.links.prev, ctx, linkage, kind));
+	define(arr, "$next", (options) => navigateLink(page.links.next, ctx, linkage, kind, options?.signal));
+	define(arr, "$prev", (options) => navigateLink(page.links.prev, ctx, linkage, kind, options?.signal));
 }
-const navigateLink = (link, ctx, linkage, paginator) => link === void 0 ? Promise.resolve(void 0) : ctx.navigate(link, linkage, paginator);
+const navigateLink = (link, ctx, linkage, paginator, signal) => {
+	if (link === void 0) return Promise.resolve(void 0);
+	return signal === void 0 ? ctx.navigate(link, linkage, paginator) : ctx.navigate(link, linkage, paginator, signal);
+};
 /** Extract the navigation links (a link may be a string or a `{href}` object). */
 function pageLinks(links) {
 	const out = {};
@@ -531,6 +534,7 @@ async function execute(ctx, req) {
 		url,
 		headers
 	};
+	if (req.signal !== void 0) transportReq.signal = req.signal;
 	if (req.body !== void 0) {
 		headers["Content-Type"] = req.contentType ?? negotiated;
 		transportReq.body = req.raw && typeof req.body === "string" ? req.body : JSON.stringify(req.body);
@@ -928,6 +932,7 @@ const fetchTransport = async (req) => {
 		headers: req.headers
 	};
 	if (req.body !== void 0) init.body = req.body;
+	if (req.signal !== void 0) init.signal = req.signal;
 	const res = await fetch(req.url, init);
 	const headers = {};
 	res.headers.forEach((value, key) => {
@@ -959,8 +964,10 @@ async function run(ctx, type, operation, vars, query, linkage = false, relationF
 		path: fill(template, vars)
 	};
 	if (query !== void 0) {
-		req.query = query;
-		negotiateProfiles(ctx, type, query, req, relationForCount);
+		const { signal, ...params } = query;
+		req.query = params;
+		if (signal !== void 0) req.signal = signal;
+		negotiateProfiles(ctx, type, params, req, relationForCount);
 	}
 	const doc = await execute(ctx.request, req);
 	const primaryType = operation === "fetchMany" ? type : void 0;
@@ -1195,10 +1202,11 @@ function createClient(descriptor, options) {
 		descriptor,
 		materialise: {
 			descriptor,
-			navigate: async (url, linkage = false, paginator) => {
+			navigate: async (url, linkage = false, paginator, signal) => {
 				const doc = await execute(request, {
 					method: "GET",
-					path: url
+					path: url,
+					...signal !== void 0 ? { signal } : {}
 				});
 				return doc === void 0 ? void 0 : materialise(doc, ctx.materialise, linkage, void 0, paginator);
 			},

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { $ as SortQuery, A as DefaultActionTypes, At as RelationView, B as IncludePath, Bt as AtomicDescriptor, C as fetchTransport, Ct as mediaType, D as Collection, Dt as EdgeEnvelope, E as Client, Et as Edge, F as FieldsMap, Ft as ActionDescriptor, G as ReadResult, Gt as RelationDescriptor, H as LinkageRef, Ht as ClientIdPolicy, I as FilterKey, It as ActionInput, J as RelationshipAccessor, K as RelationName, Kt as RelationMutations, L as FilterQuery, Lt as ActionOutput, M as DefaultWriteAttributes, Mt as ResourceLinks, N as EdgeMembers, Nt as materialise, O as CountToken, Ot as MaterialiseContext, P as FieldSelectionMap, Pt as relatedPaginatorKind, Q as SingleReadQuery, R as HydratedMember, Rt as ActionScope, S as TransportResponse, St as ResourceIdentifier, T as AtomicResultOf, Tt as DocumentEnvelope, U as MemberName, Ut as CountableDescriptor, V as IncludedRelations, Vt as Cardinality, W as PivotInput, Wt as PaginatorKind, X as ResourceHandle, Y as ResourceAccessors, Z as ResourceObjectView, _ as HANDLE_RESERVED, _t as ATOMIC_EXT, a as Validator, at as WriteOptions, b as JsonApiTransport, bt as LocalIdentifier, c as resolveValidator, ct as AtomicDeleteHandle, d as JsonApiContext, dt as AtomicRef, et as SortToken, f as JsonApiRequest, ft as AtomicResult, g as ClientOptions, gt as runAtomic, h as serializeQuery, ht as AtomicUpdateInput, i as ValidationOption, it as UpdateInput, j as DefaultAttributes, jt as ResourceEnvelope, k as CreateInput, kt as Page, l as validateDocument, lt as AtomicHandle, m as execute, mt as AtomicUpdateHandle, n as SchemaMap, nt as TypeName, o as WireResource, ot as AtomicCreateHandle, p as ReadQuery, pt as AtomicResults, q as RelationReadQuery, qt as ResourceDescriptor, r as ValidationConfig, rt as TypedReadQuery, s as assertJsonApiDocument, st as AtomicCreateInput, t as ResolvedValidator, tt as TypeAccessor, u as Document, ut as AtomicRecorder, v as HeadersInit, vt as ATOMIC_MEDIA_TYPE, w as ActionsAccessor, wt as ArrayEnvelope, x as TransportRequest, xt as MediaTypeParams, y as createClient, yt as JSON_API_MEDIA_TYPE, z as IdentifierMember, zt as ApiDescriptor } from "./validate-BmyPbJCK.cjs";
+import { $ as SortQuery, A as DefaultActionTypes, At as Page, B as IncludePath, Bt as ApiDescriptor, C as fetchTransport, Ct as mediaType, D as Collection, Dt as EdgeEnvelope, E as Client, Et as Edge, F as FieldsMap, Ft as relatedPaginatorKind, G as ReadResult, Gt as PaginatorKind, H as LinkageRef, Ht as Cardinality, I as FilterKey, It as ActionDescriptor, J as RelationshipAccessor, Jt as ResourceDescriptor, K as RelationName, Kt as RelationDescriptor, L as FilterQuery, Lt as ActionInput, M as DefaultWriteAttributes, Mt as ResourceEnvelope, N as EdgeMembers, Nt as ResourceLinks, O as CountToken, Ot as MaterialiseContext, P as FieldSelectionMap, Pt as materialise, Q as SingleReadQuery, R as HydratedMember, Rt as ActionOutput, S as TransportResponse, St as ResourceIdentifier, T as AtomicResultOf, Tt as DocumentEnvelope, U as MemberName, Ut as ClientIdPolicy, V as IncludedRelations, Vt as AtomicDescriptor, W as PivotInput, Wt as CountableDescriptor, X as ResourceHandle, Y as ResourceAccessors, Z as ResourceObjectView, _ as HANDLE_RESERVED, _t as ATOMIC_EXT, a as Validator, at as WriteOptions, b as JsonApiTransport, bt as LocalIdentifier, c as resolveValidator, ct as AtomicDeleteHandle, d as JsonApiContext, dt as AtomicRef, et as SortToken, f as JsonApiRequest, ft as AtomicResult, g as ClientOptions, gt as runAtomic, h as serializeQuery, ht as AtomicUpdateInput, i as ValidationOption, it as UpdateInput, j as DefaultAttributes, jt as RelationView, k as CreateInput, kt as NavigateOptions, l as validateDocument, lt as AtomicHandle, m as execute, mt as AtomicUpdateHandle, n as SchemaMap, nt as TypeName, o as WireResource, ot as AtomicCreateHandle, p as ReadQuery, pt as AtomicResults, q as RelationReadQuery, qt as RelationMutations, r as ValidationConfig, rt as TypedReadQuery, s as assertJsonApiDocument, st as AtomicCreateInput, t as ResolvedValidator, tt as TypeAccessor, u as Document, ut as AtomicRecorder, v as HeadersInit, vt as ATOMIC_MEDIA_TYPE, w as ActionsAccessor, wt as ArrayEnvelope, x as TransportRequest, xt as MediaTypeParams, y as createClient, yt as JSON_API_MEDIA_TYPE, z as IdentifierMember, zt as ActionScope } from "./validate-CfrCMZkA.cjs";
 
 //#region src/errors.d.ts
 /** A single JSON:API error object (spec: error objects). */
@@ -194,5 +194,5 @@ declare function withRemappedRelationshipPaths(error: JsonApiError, rel: string,
  */
 declare function withRemappedAtomicPaths(error: JsonApiError, descriptor: ApiDescriptor, typeForOp: (opIndex: number) => string | undefined): JsonApiError;
 //#endregion
-export { ATOMIC_EXT, ATOMIC_MEDIA_TYPE, ActionDescriptor, ActionInput, ActionOutput, ActionScope, ActionsAccessor, ApiDescriptor, ArrayEnvelope, AtomicCreateHandle, AtomicCreateInput, AtomicDeleteHandle, AtomicDescriptor, AtomicHandle, AtomicRecorder, AtomicRef, AtomicResult, AtomicResultOf, AtomicResults, AtomicUpdateHandle, AtomicUpdateInput, Cardinality, Client, ClientIdPolicy, ClientOptions, Collection, CountToken, CountableDescriptor, CreateInput, DefaultActionTypes, DefaultAttributes, DefaultWriteAttributes, Document, DocumentEnvelope, Edge, EdgeEnvelope, EdgeMembers, FieldSelectionMap, FieldsMap, FilterKey, FilterQuery, HANDLE_RESERVED, HeadersInit, HydratedMember, IdentifierMember, IncludePath, IncludedRelations, JSON_API_MEDIA_TYPE, JsonApiContext, JsonApiError, JsonApiErrorObject, JsonApiRequest, JsonApiTransport, LinkageRef, LocalIdentifier, MaterialiseContext, MediaTypeParams, MemberName, Page, PaginatorKind, PivotInput, ReadQuery, ReadResult, RelationDescriptor, RelationMutations, RelationName, RelationReadQuery, RelationView, RelationshipAccessor, RelationshipDocument, ResolvedValidator, ResourceAccessors, ResourceDescriptor, ResourceEnvelope, ResourceHandle, ResourceIdentifier, ResourceLinks, ResourceObjectView, SchemaMap, SingleReadQuery, SortQuery, SortToken, StructuralGuardError, ToDocumentOptions, TransportRequest, TransportResponse, TypeAccessor, TypeName, TypedReadQuery, UpdateInput, ValidationConfig, ValidationOption, Validator, WireResource, WriteDocument, WriteOptions, assertJsonApiDocument, createClient, execute, fetchTransport, materialise, mediaType, relatedPaginatorKind, remapPointer, remapRelationshipPointer, resolveValidator, runAtomic, serializeQuery, toDocument, toRelationshipDocument, validateDocument, withRemappedAtomicPaths, withRemappedPaths, withRemappedRelationshipPaths };
+export { ATOMIC_EXT, ATOMIC_MEDIA_TYPE, ActionDescriptor, ActionInput, ActionOutput, ActionScope, ActionsAccessor, ApiDescriptor, ArrayEnvelope, AtomicCreateHandle, AtomicCreateInput, AtomicDeleteHandle, AtomicDescriptor, AtomicHandle, AtomicRecorder, AtomicRef, AtomicResult, AtomicResultOf, AtomicResults, AtomicUpdateHandle, AtomicUpdateInput, Cardinality, Client, ClientIdPolicy, ClientOptions, Collection, CountToken, CountableDescriptor, CreateInput, DefaultActionTypes, DefaultAttributes, DefaultWriteAttributes, Document, DocumentEnvelope, Edge, EdgeEnvelope, EdgeMembers, FieldSelectionMap, FieldsMap, FilterKey, FilterQuery, HANDLE_RESERVED, HeadersInit, HydratedMember, IdentifierMember, IncludePath, IncludedRelations, JSON_API_MEDIA_TYPE, JsonApiContext, JsonApiError, JsonApiErrorObject, JsonApiRequest, JsonApiTransport, LinkageRef, LocalIdentifier, MaterialiseContext, MediaTypeParams, MemberName, NavigateOptions, Page, PaginatorKind, PivotInput, ReadQuery, ReadResult, RelationDescriptor, RelationMutations, RelationName, RelationReadQuery, RelationView, RelationshipAccessor, RelationshipDocument, ResolvedValidator, ResourceAccessors, ResourceDescriptor, ResourceEnvelope, ResourceHandle, ResourceIdentifier, ResourceLinks, ResourceObjectView, SchemaMap, SingleReadQuery, SortQuery, SortToken, StructuralGuardError, ToDocumentOptions, TransportRequest, TransportResponse, TypeAccessor, TypeName, TypedReadQuery, UpdateInput, ValidationConfig, ValidationOption, Validator, WireResource, WriteDocument, WriteOptions, assertJsonApiDocument, createClient, execute, fetchTransport, materialise, mediaType, relatedPaginatorKind, remapPointer, remapRelationshipPointer, resolveValidator, runAtomic, serializeQuery, toDocument, toRelationshipDocument, validateDocument, withRemappedAtomicPaths, withRemappedPaths, withRemappedRelationshipPaths };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { $ as SortQuery, A as DefaultActionTypes, At as RelationView, B as IncludePath, Bt as AtomicDescriptor, C as fetchTransport, Ct as mediaType, D as Collection, Dt as EdgeEnvelope, E as Client, Et as Edge, F as FieldsMap, Ft as ActionDescriptor, G as ReadResult, Gt as RelationDescriptor, H as LinkageRef, Ht as ClientIdPolicy, I as FilterKey, It as ActionInput, J as RelationshipAccessor, K as RelationName, Kt as RelationMutations, L as FilterQuery, Lt as ActionOutput, M as DefaultWriteAttributes, Mt as ResourceLinks, N as EdgeMembers, Nt as materialise, O as CountToken, Ot as MaterialiseContext, P as FieldSelectionMap, Pt as relatedPaginatorKind, Q as SingleReadQuery, R as HydratedMember, Rt as ActionScope, S as TransportResponse, St as ResourceIdentifier, T as AtomicResultOf, Tt as DocumentEnvelope, U as MemberName, Ut as CountableDescriptor, V as IncludedRelations, Vt as Cardinality, W as PivotInput, Wt as PaginatorKind, X as ResourceHandle, Y as ResourceAccessors, Z as ResourceObjectView, _ as HANDLE_RESERVED, _t as ATOMIC_EXT, a as Validator, at as WriteOptions, b as JsonApiTransport, bt as LocalIdentifier, c as resolveValidator, ct as AtomicDeleteHandle, d as JsonApiContext, dt as AtomicRef, et as SortToken, f as JsonApiRequest, ft as AtomicResult, g as ClientOptions, gt as runAtomic, h as serializeQuery, ht as AtomicUpdateInput, i as ValidationOption, it as UpdateInput, j as DefaultAttributes, jt as ResourceEnvelope, k as CreateInput, kt as Page, l as validateDocument, lt as AtomicHandle, m as execute, mt as AtomicUpdateHandle, n as SchemaMap, nt as TypeName, o as WireResource, ot as AtomicCreateHandle, p as ReadQuery, pt as AtomicResults, q as RelationReadQuery, qt as ResourceDescriptor, r as ValidationConfig, rt as TypedReadQuery, s as assertJsonApiDocument, st as AtomicCreateInput, t as ResolvedValidator, tt as TypeAccessor, u as Document, ut as AtomicRecorder, v as HeadersInit, vt as ATOMIC_MEDIA_TYPE, w as ActionsAccessor, wt as ArrayEnvelope, x as TransportRequest, xt as MediaTypeParams, y as createClient, yt as JSON_API_MEDIA_TYPE, z as IdentifierMember, zt as ApiDescriptor } from "./validate-BmyPbJCK.mjs";
+import { $ as SortQuery, A as DefaultActionTypes, At as Page, B as IncludePath, Bt as ApiDescriptor, C as fetchTransport, Ct as mediaType, D as Collection, Dt as EdgeEnvelope, E as Client, Et as Edge, F as FieldsMap, Ft as relatedPaginatorKind, G as ReadResult, Gt as PaginatorKind, H as LinkageRef, Ht as Cardinality, I as FilterKey, It as ActionDescriptor, J as RelationshipAccessor, Jt as ResourceDescriptor, K as RelationName, Kt as RelationDescriptor, L as FilterQuery, Lt as ActionInput, M as DefaultWriteAttributes, Mt as ResourceEnvelope, N as EdgeMembers, Nt as ResourceLinks, O as CountToken, Ot as MaterialiseContext, P as FieldSelectionMap, Pt as materialise, Q as SingleReadQuery, R as HydratedMember, Rt as ActionOutput, S as TransportResponse, St as ResourceIdentifier, T as AtomicResultOf, Tt as DocumentEnvelope, U as MemberName, Ut as ClientIdPolicy, V as IncludedRelations, Vt as AtomicDescriptor, W as PivotInput, Wt as CountableDescriptor, X as ResourceHandle, Y as ResourceAccessors, Z as ResourceObjectView, _ as HANDLE_RESERVED, _t as ATOMIC_EXT, a as Validator, at as WriteOptions, b as JsonApiTransport, bt as LocalIdentifier, c as resolveValidator, ct as AtomicDeleteHandle, d as JsonApiContext, dt as AtomicRef, et as SortToken, f as JsonApiRequest, ft as AtomicResult, g as ClientOptions, gt as runAtomic, h as serializeQuery, ht as AtomicUpdateInput, i as ValidationOption, it as UpdateInput, j as DefaultAttributes, jt as RelationView, k as CreateInput, kt as NavigateOptions, l as validateDocument, lt as AtomicHandle, m as execute, mt as AtomicUpdateHandle, n as SchemaMap, nt as TypeName, o as WireResource, ot as AtomicCreateHandle, p as ReadQuery, pt as AtomicResults, q as RelationReadQuery, qt as RelationMutations, r as ValidationConfig, rt as TypedReadQuery, s as assertJsonApiDocument, st as AtomicCreateInput, t as ResolvedValidator, tt as TypeAccessor, u as Document, ut as AtomicRecorder, v as HeadersInit, vt as ATOMIC_MEDIA_TYPE, w as ActionsAccessor, wt as ArrayEnvelope, x as TransportRequest, xt as MediaTypeParams, y as createClient, yt as JSON_API_MEDIA_TYPE, z as IdentifierMember, zt as ActionScope } from "./validate-CfrCMZkA.mjs";
 
 //#region src/errors.d.ts
 /** A single JSON:API error object (spec: error objects). */
@@ -194,5 +194,5 @@ declare function withRemappedRelationshipPaths(error: JsonApiError, rel: string,
  */
 declare function withRemappedAtomicPaths(error: JsonApiError, descriptor: ApiDescriptor, typeForOp: (opIndex: number) => string | undefined): JsonApiError;
 //#endregion
-export { ATOMIC_EXT, ATOMIC_MEDIA_TYPE, ActionDescriptor, ActionInput, ActionOutput, ActionScope, ActionsAccessor, ApiDescriptor, ArrayEnvelope, AtomicCreateHandle, AtomicCreateInput, AtomicDeleteHandle, AtomicDescriptor, AtomicHandle, AtomicRecorder, AtomicRef, AtomicResult, AtomicResultOf, AtomicResults, AtomicUpdateHandle, AtomicUpdateInput, Cardinality, Client, ClientIdPolicy, ClientOptions, Collection, CountToken, CountableDescriptor, CreateInput, DefaultActionTypes, DefaultAttributes, DefaultWriteAttributes, Document, DocumentEnvelope, Edge, EdgeEnvelope, EdgeMembers, FieldSelectionMap, FieldsMap, FilterKey, FilterQuery, HANDLE_RESERVED, HeadersInit, HydratedMember, IdentifierMember, IncludePath, IncludedRelations, JSON_API_MEDIA_TYPE, JsonApiContext, JsonApiError, JsonApiErrorObject, JsonApiRequest, JsonApiTransport, LinkageRef, LocalIdentifier, MaterialiseContext, MediaTypeParams, MemberName, Page, PaginatorKind, PivotInput, ReadQuery, ReadResult, RelationDescriptor, RelationMutations, RelationName, RelationReadQuery, RelationView, RelationshipAccessor, RelationshipDocument, ResolvedValidator, ResourceAccessors, ResourceDescriptor, ResourceEnvelope, ResourceHandle, ResourceIdentifier, ResourceLinks, ResourceObjectView, SchemaMap, SingleReadQuery, SortQuery, SortToken, StructuralGuardError, ToDocumentOptions, TransportRequest, TransportResponse, TypeAccessor, TypeName, TypedReadQuery, UpdateInput, ValidationConfig, ValidationOption, Validator, WireResource, WriteDocument, WriteOptions, assertJsonApiDocument, createClient, execute, fetchTransport, materialise, mediaType, relatedPaginatorKind, remapPointer, remapRelationshipPointer, resolveValidator, runAtomic, serializeQuery, toDocument, toRelationshipDocument, validateDocument, withRemappedAtomicPaths, withRemappedPaths, withRemappedRelationshipPaths };
+export { ATOMIC_EXT, ATOMIC_MEDIA_TYPE, ActionDescriptor, ActionInput, ActionOutput, ActionScope, ActionsAccessor, ApiDescriptor, ArrayEnvelope, AtomicCreateHandle, AtomicCreateInput, AtomicDeleteHandle, AtomicDescriptor, AtomicHandle, AtomicRecorder, AtomicRef, AtomicResult, AtomicResultOf, AtomicResults, AtomicUpdateHandle, AtomicUpdateInput, Cardinality, Client, ClientIdPolicy, ClientOptions, Collection, CountToken, CountableDescriptor, CreateInput, DefaultActionTypes, DefaultAttributes, DefaultWriteAttributes, Document, DocumentEnvelope, Edge, EdgeEnvelope, EdgeMembers, FieldSelectionMap, FieldsMap, FilterKey, FilterQuery, HANDLE_RESERVED, HeadersInit, HydratedMember, IdentifierMember, IncludePath, IncludedRelations, JSON_API_MEDIA_TYPE, JsonApiContext, JsonApiError, JsonApiErrorObject, JsonApiRequest, JsonApiTransport, LinkageRef, LocalIdentifier, MaterialiseContext, MediaTypeParams, MemberName, NavigateOptions, Page, PaginatorKind, PivotInput, ReadQuery, ReadResult, RelationDescriptor, RelationMutations, RelationName, RelationReadQuery, RelationView, RelationshipAccessor, RelationshipDocument, ResolvedValidator, ResourceAccessors, ResourceDescriptor, ResourceEnvelope, ResourceHandle, ResourceIdentifier, ResourceLinks, ResourceObjectView, SchemaMap, SingleReadQuery, SortQuery, SortToken, StructuralGuardError, ToDocumentOptions, TransportRequest, TransportResponse, TypeAccessor, TypeName, TypedReadQuery, UpdateInput, ValidationConfig, ValidationOption, Validator, WireResource, WriteDocument, WriteOptions, assertJsonApiDocument, createClient, execute, fetchTransport, materialise, mediaType, relatedPaginatorKind, remapPointer, remapRelationshipPointer, resolveValidator, runAtomic, serializeQuery, toDocument, toRelationshipDocument, validateDocument, withRemappedAtomicPaths, withRemappedPaths, withRemappedRelationshipPaths };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -394,10 +394,13 @@ function attachPage(arr, kind, meta, links, ctx, linkage) {
 	};
 	if (meta !== void 0) page.meta = meta;
 	defineGetter(arr, "$page", () => page);
-	define(arr, "$next", () => navigateLink(page.links.next, ctx, linkage, kind));
-	define(arr, "$prev", () => navigateLink(page.links.prev, ctx, linkage, kind));
+	define(arr, "$next", (options) => navigateLink(page.links.next, ctx, linkage, kind, options?.signal));
+	define(arr, "$prev", (options) => navigateLink(page.links.prev, ctx, linkage, kind, options?.signal));
 }
-const navigateLink = (link, ctx, linkage, paginator) => link === void 0 ? Promise.resolve(void 0) : ctx.navigate(link, linkage, paginator);
+const navigateLink = (link, ctx, linkage, paginator, signal) => {
+	if (link === void 0) return Promise.resolve(void 0);
+	return signal === void 0 ? ctx.navigate(link, linkage, paginator) : ctx.navigate(link, linkage, paginator, signal);
+};
 /** Extract the navigation links (a link may be a string or a `{href}` object). */
 function pageLinks(links) {
 	const out = {};
@@ -530,6 +533,7 @@ async function execute(ctx, req) {
 		url,
 		headers
 	};
+	if (req.signal !== void 0) transportReq.signal = req.signal;
 	if (req.body !== void 0) {
 		headers["Content-Type"] = req.contentType ?? negotiated;
 		transportReq.body = req.raw && typeof req.body === "string" ? req.body : JSON.stringify(req.body);
@@ -927,6 +931,7 @@ const fetchTransport = async (req) => {
 		headers: req.headers
 	};
 	if (req.body !== void 0) init.body = req.body;
+	if (req.signal !== void 0) init.signal = req.signal;
 	const res = await fetch(req.url, init);
 	const headers = {};
 	res.headers.forEach((value, key) => {
@@ -958,8 +963,10 @@ async function run(ctx, type, operation, vars, query, linkage = false, relationF
 		path: fill(template, vars)
 	};
 	if (query !== void 0) {
-		req.query = query;
-		negotiateProfiles(ctx, type, query, req, relationForCount);
+		const { signal, ...params } = query;
+		req.query = params;
+		if (signal !== void 0) req.signal = signal;
+		negotiateProfiles(ctx, type, params, req, relationForCount);
 	}
 	const doc = await execute(ctx.request, req);
 	const primaryType = operation === "fetchMany" ? type : void 0;
@@ -1194,10 +1201,11 @@ function createClient(descriptor, options) {
 		descriptor,
 		materialise: {
 			descriptor,
-			navigate: async (url, linkage = false, paginator) => {
+			navigate: async (url, linkage = false, paginator, signal) => {
 				const doc = await execute(request, {
 					method: "GET",
-					path: url
+					path: url,
+					...signal !== void 0 ? { signal } : {}
 				});
 				return doc === void 0 ? void 0 : materialise(doc, ctx.materialise, linkage, void 0, paginator);
 			},