@haddowg/json-api-codegen 1.8.1 → 1.9.0

package/dist/cli.d.mts

@@ -1,4 +1,4 @@
-import { r as CodegenConfig } from "./index-COQQrn7a.mjs";
+import { r as CodegenConfig } from "./index-k_oATv7Q.mjs";
 
 //#region src/cli.d.ts
 declare const USAGE = "Usage: json-api-codegen --input <url|file> --output <file> [--server <name>] [--schemas <url|file>] [--examples] [--check]";

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { i as generateFiles, t as check } from "./src-AWTGjMiX.mjs";
+import { i as generateFiles, t as check } from "./src-py1RBWZr.mjs";
 import { realpathSync } from "node:fs";
 import { fileURLToPath } from "node:url";
 //#region src/cli.ts

package/dist/{index-COQQrn7a.d.mts → index-k_oATv7Q.d.mts}

@@ -295,7 +295,7 @@ declare function buildExamples(doc: OpenApiDocument, descriptor: ApiDescriptor):
 /** Below this the document predates the structures this codegen reads. */
 declare const MINIMUM_CONTRACT = 1;
 /** Above this the document carries structures this codegen does not read. */
-declare const MAXIMUM_CONTRACT = 13;
+declare const MAXIMUM_CONTRACT = 14;
 /**
  * Check the document's `info.x-generator.contract` against the range this codegen reads. A
  * document older than the range throws; a newer one returns a warning, because its new
@@ -346,6 +346,8 @@ declare class Emitter {
   private readonly rawBodyAliases;
   /** JSDoc for entries of the `resourceMap` literal, keyed by their path joined with `/`. */
   private readonly literalDocs;
+  /** Wire type -> the links it declares, for the types that declare any. */
+  private readonly declaredLinks;
   /** Provenance of the source document, stamped into the generated header for drift tracking. */
   private readonly provenance;
   private readonly doc;
@@ -360,6 +362,22 @@ declare class Emitter {
   emit(): string;
   private header;
   private imports;
+  /**
+   * The links interface of a type that declares links, e.g. `ImagesLinks`: each declared link an
+   * optional member, since the server leaves a link out when its href resolves to `null`. It
+   * extends the loose `ResourceLinks`, so `self` and any link the type doesn't declare stay
+   * reachable as before.
+   */
+  private linksInterface;
+  /**
+   * A declared link object as a multi-line type: `href`, each static member as its `const`, and a
+   * `meta` object whose members are typed as attributes are, each with its own TSDoc.
+   */
+  private linkObjectType;
+  /** An object type with one line, and its TSDoc, per property. */
+  private documentedObject;
+  /** A static link member's `const` as a literal type, else its schema's type. */
+  private constOrType;
   /** Per-type attribute interface, e.g. `export interface AlbumsAttributes { ... }`. */
   private attributeInterface;
   /**
@@ -458,6 +476,13 @@ declare class Emitter {
    * argument to the runtime factory).
    */
   private attributesMap;
+  /**
+   * Emit the `Links` interface mapping each type that declares links to its links interface. The
+   * runtime threads it beside the `Attributes` map, so a read result's `$links` carries the
+   * declared links. A type absent from it keeps the loose `ResourceLinks`. Passed as the sixth
+   * type argument to the runtime factory.
+   */
+  private linksMap;
   /**
    * Emit the `WriteAttributes` interface mapping each writable wire type to its
    * `{ create; update }` attribute pair. A read-only type (no create/update component)
@@ -658,4 +683,4 @@ declare function generateFiles(config: CodegenConfig): Promise<string[]>;
 declare function check(config: CodegenConfig): Promise<CheckResult>;
 //#endregion
 export { operationExamples as A, PathItemObject as B, VerbCollision as C, MINIMUM_CONTRACT as D, MAXIMUM_CONTRACT as E, InfoObject as F, ResponseObject as H, MediaTypeObject as I, OpenApiDocument as L, buildAtomic as M, buildDescriptor as N, checkContract as O, HttpMethod as P, OperationObject as R, Emitter as S, emit as T, SchemaObject as U, RequestBodyObject as V, SchemaOrBool as W, emitExamples as _, examplesOutputPath as a, emitErrorCodes as b, schemasOutputPath as c, hashJson as d, provenanceLines as f, readSchemas as g, readDocument as h, check as i, DescriptorBuilder as j, buildExamples as k, Provenance as l, SchemaBundle as m, CheckResult as n, generate as o, emitSchemas as p, CodegenConfig as r, generateFiles as s, ArtifactDrift as t, deriveProvenance as u, DocumentedErrorCode as v, detectVerbCollisions as w, readErrorCatalogue as x, ErrorCatalogue as y, ParameterObject as z };
-//# sourceMappingURL=index-COQQrn7a.d.mts.map
+//# sourceMappingURL=index-k_oATv7Q.d.mts.map

package/dist/index-k_oATv7Q.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-k_oATv7Q.d.mts","names":[],"sources":["../src/openapi.ts","../src/build-descriptor.ts","../src/build-examples.ts","../src/contract.ts","../src/emit.ts","../src/error-codes.ts","../src/emit-examples.ts","../src/reader.ts","../src/emit-schemas.ts","../src/provenance.ts","../src/index.ts"],"mappings":";;;;;;AAQA;;;;UAAiB,YAAA;EACf,IAAA;EACA,IAAA;EACA,KAAA;EACA,MAAA;EACA,WAAA;EACA,IAAA;EACA,UAAA,GAAa,MAAA,SAAe,YAAA;EAC5B,KAAA,GAAQ,YAAA;EACR,QAAA;EACA,KAAA,YAAiB,YAAA;EACjB,KAAA,YAAiB,YAAA;EACjB,KAAA,YAAiB,YAAA;EACjB,iBAAA;EACA,qBAAA;EAAA,CACC,GAAA;AAAA;;KAIS,YAAA,GAAe,YAAY;AAAA,UAEtB,eAAA;EACf,MAAA,GAAS,YAAY;EAXrB;EAaA,OAAA;AAAA;AAAA,UAGe,iBAAA;EACf,OAAA,GAAU,MAAM,SAAS,eAAA;EACzB,QAAA;AAAA;AAAA,UAGe,cAAA;EACf,OAAA,GAAU,MAAM,SAAS,eAAA;AAAA;AAAA,UAGV,eAAA;EACf,IAAA;EACA,EAAA;EACA,IAAA;EACA,MAAA,GAAS,YAAY;EACrB,KAAA;EACA,OAAA;EApBqB;EAsBrB,WAAA;AAAA;AAAA,UAGe,eAAA;EACf,WAAA;EACA,OAAA;EACA,WAAA;EACA,UAAA,YAAsB,eAAA;EACtB,WAAA,GAAc,iBAAA;EACd,SAAA,GAAY,MAAA,SAAe,cAAA;AAAA;AAAA,KAGjB,UAAA;AAAA,KAEA,cAAA,GAAiB,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,eAAA;AAAA,UAEvC,UAAA;EACf,KAAA;EACA,OAAA;EA9Be;EAgCf,aAAA;IAAkB,QAAA;EAAA;AAAA;AAAA,UAGH,eAAA;EACf,OAAA;EACA,IAAA,GAAO,UAAA;EACP,OAAA;IAAqB,GAAA;EAAA;EACrB,KAAA,GAAQ,MAAA,SAAe,cAAA;EACvB,UAAA;IACE,OAAA,GAAU,MAAA,SAAe,YAAA;EAAA;AAAA;;;cCHhB,iBAAA;EAAA,iBACM,OAAA;EAAA,iBACA,KAAA;;UAET,cAAA;cAEI,MAAA,EAAQ,eAAA;EDpEZ;;;;;EAAA,QC+EA,aAAA;EAaR,KAAA,IAAS,aAAA;EDlGT;;;;;EC2JA,WAAA,IAAe,gBAAA;EDtJF;;;;;EAAA,QCqKL,YAAA;EDlKS;EAAA,QC8KT,YAAA;EAAA,QASA,UAAA;EDrLR;;;;;;AAGY;EAHZ,QC2MQ,SAAA;EDpMc;;;AAAe;EAAf,QCkQd,kBAAA;EDhQsB;;;;;;EAAA,QCuRtB,iBAAA;EDpRD;AAGT;;;;;;EAHS,QCiUC,iBAAA;ED5TR;;AAAQ;AAGV;;;;;;;EAHE,QC+VQ,oBAAA;ED3VgC;AAG1C;;;;;;EAH0C,QCyZhC,OAAA;EDlZR;;;;EAAA,QCweQ,SAAA;EDpeG;AAAA;AAGb;;;EAHa,QCyfH,YAAA;EDjfM;EAAA,QCggBN,cAAA;ED/fI;EAAA,QC6gBJ,aAAA;ED7gBU;;;;;EAAA,QC0hBV,eAAA;ED3hBR;EAAA,QCgjBQ,SAAA;ED/iBR;EAAA,QCwjBQ,iBAAA;EDxjBmB;EAAA,QCskBnB,qBAAA;EDtkBiC;AAG3C;;;;EAH2C,QCqpBjC,UAAA;EDhpBE;;;;;;;EAAA,QC+pBF,eAAA;ED/pB0B;EAAA,QCssB1B,cAAA;EDtsB2B;EAAA,QCmtB3B,cAAA;EAAA,QAaA,QAAA;EDhuB6D;AAAA;AAEvE;;;EAFuE,QCivB7D,cAAA;EAAA,QAmCA,cAAA;EDhxBR;EAAA,QCsyBQ,cAAA;EAAA,QAWA,mBAAA;ED/yBkB;EAAA,QCuzBlB,SAAA;EDpzBO;;;;;;;EAAA,QCg0BP,WAAA;ED1zBU;;;;;;;EAAA,QCw2BV,WAAA;ED12BA;;;;;;;AAE+B;;;;ACHzC;;EDCU,QCg5BA,SAAA;EA34BY;;;;;;;;;EAAA,QA25BZ,UAAA;EA35BI;;;;;EAAA,QAw6BJ,QAAA;EAx0BA;;;;;;EAAA,QAs1BA,UAAA;EAAA,QAeA,SAAA;EAAA,QAIA,cAAA;EAAA,QAIA,aAAA;AAAA;;iBA4MM,eAAA,CAAgB,GAAA,EAAK,eAAA,GAAkB,aAAa;;iBAKpD,WAAA,CAAY,GAAA,EAAK,eAAA,GAAkB,gBAAgB;;;;AD1uCnE;;;;iBEuBgB,iBAAA,CAAkB,EAAA,EAAI,eAAA,eAA8B,iBAAiB;;;;;;;;iBA4CrE,aAAA,CAAc,GAAA,EAAK,eAAA,EAAiB,UAAA,EAAY,aAAA,GAAgB,WAAA;;;;cCxEnE,gBAAA;AHKb;AAAA,cGFa,gBAAA;;;;;;;iBAQG,aAAA,CAAc,GAAoB,EAAf,eAAe;;;;UCmBjC,aAAA;EACf,IAAA;EACA,QAAQ;AAAA;;;;;iBAsBM,oBAAA,CAAqB,UAAA,EAAY,aAAA,GAAgB,aAAa;AAAA,cAqPjE,OAAA;EAAA,iBAwCQ,UAAA;EAAA,iBACA,MAAA;EAAA,iBAxCF,OAAA;EJlSjB;EAAA,iBIoSiB,UAAA;EJlSjB;EAAA,iBIoSiB,SAAA;EJpSW;;;;;;EAAA,iBI2SX,iBAAA;EJvSA;EAAA,iBIySA,SAAA;EJxSA;EAAA,iBI0SA,UAAA;EJxSjB;EAAA,iBI0SiB,SAAA;EJzSL;AAAA;AAId;;;EAJc,iBI+SK,gBAAA;EJ3SoB;EAAA,iBI6SpB,cAAA;EJ3Sa;EAAA,iBI6Sb,WAAA;EJ5SI;EAAA,iBI+SJ,aAAA;EJ/SR;EAAA,iBIkTQ,UAAA;EAAA,iBAEA,GAAA;cAGf,MAAA,EAAQ,eAAA,EACS,UAAA,EAAY,aAAA,EACZ,MAAA,EAAQ,gBAAA;EJpTZ;;;;EAAA,QIsWP,QAAA;EJrWE;EAAA,QI+XF,UAAA;EAcR,IAAA;EAAA,QAoCQ,MAAA;EAAA,QAWA,OAAA;EJxbO;;;;;;EAAA,QI2cP,cAAA;EJ1cgC;AAAA;AAG1C;;EAH0C,QI2dhC,cAAA;EJpda;EAAA,QI6db,gBAAA;EJ/dR;EAAA,QIufQ,WAAA;EJrfR;EAAA,QI2fQ,kBAAA;EJ1fR;;;;AAGW;AAGb;;EANE,QI0gBQ,wBAAA;EJhgBc;;;;;;;EAAA,QIwiBd,iBAAA;EJziBR;;;;;EAAA,QIioBQ,YAAA;EJ9nBI;;;AAA6B;AAG3C;EAHc,QIupBJ,cAAA;;;AJppBY;AAEtB;;UI6rBU,aAAA;EJ7rBkC;EAAA,QImtBlC,kBAAA;EJntB2B;;;;;;;;EAAA,QIkuB3B,cAAA;EJluB6D;AAEvE;;;;;;;;;EAFuE,QI4wB7D,cAAA;EJnwBO;EAAA,QIkxBP,WAAA;;;;;;;UAiBA,eAAA;EJ7xBU;EAAA,QIm0BV,gBAAA;EJv0BR;;;;;EAAA,QIo2BQ,eAAA;EJl2Be;EAAA,QI43Bf,MAAA;EJ13BN;EAAA,QI26BM,UAAA;EAAA,QAaA,iBAAA;EJx7B+B;EAAA,QIi9B/B,UAAA;EAAA,QAoBA,SAAA;;UAWA,WAAA;EHn/BG;;;;;EAAA,QG0gCH,OAAA;EHn7BuB;;;;;;EAAA,QGo8BvB,aAAA;EHrhCI;;;;;;EAAA,QGkiCJ,QAAA;EHt7BA;;;;;;EAAA,QGs8BA,kBAAA;EHpsBA;EAAA,QG8tBA,WAAA;EHnnBA;EAAA,QGynBA,OAAA;EAAA,QA6BA,YAAA;AAAA;;;;;iBAwBM,IAAA,CACd,GAAA,EAAK,eAAA,EACL,UAAA,EAAY,aAAA,EACZ,MAAA,GAAQ,gBAAA;;;;UCvtCO,mBAAA;EACf,IAAA;ELA2B;EKE3B,WAAA;ELK4B;EKH5B,QAAA;AAAA;;UAIe,cAAA;ELIE;EKFjB,KAAA,EAAO,mBAAA;ELEsB;;;;EKG7B,QAAA,EAAU,GAAG;AAAA;;;;;;;iBAuCC,kBAAA,CAAmB,GAAA,EAAK,eAAA,GAAkB,cAAc;;;;;;;;iBAiFxD,cAAA,CAAe,SAAyB,EAAd,cAAc;;;;ALvIxD;;;;;;;;;;;iBMSgB,YAAA,CAAa,GAAA,EAAK,eAAA,EAAiB,QAAA,EAAU,WAAW;;;;KCX5D,YAAA,GAAe,MAAM,SAAS,YAAA;;;;;iBA+CpB,YAAA,CAAa,KAAA,WAAgB,OAAO,CAAC,eAAA;;;;;;iBASrC,WAAA,CAAY,KAAA,WAAgB,OAAO,CAAC,YAAA;;;;;APtD1D;;;;;;;;;;;;;iBQWgB,WAAA,CAAY,MAAoB,EAAZ,YAAY;;;;;ARXhD;;;;USEiB,UAAA;ETMP;EAAA,SSJC,MAAA;ETOQ;EAAA,SSLR,MAAA;ETMoB;EAAA,SSJpB,IAAA;AAAA;;iBAwBK,QAAA,CAAS,KAAc;;;;;;iBAYvB,gBAAA,CAAiB,GAAA,EAAK,eAAA,GAAkB,UAAU;;;;;;iBAelD,eAAA,CAAgB,UAAsB,EAAV,UAAU;;;UC7BrC,aAAA;EVpBE;EUsBjB,KAAA;EVrBiB;EUuBjB,MAAA;EVtBiB;EUwBjB,MAAA;EVtBA;EUwBA,OAAA;EVvBY;AAAA;AAId;;EUwBE,QAAA;EVxBqC;AAAA;AAEvC;;;EU4BE,KAAA;AAAA;;UAIe,aAAA;EV7BR;EU+BP,IAAA;EV5Be;EU8Bf,QAAQ;AAAA;;UAIO,WAAA;EACf,EAAA;EACA,SAAA,EAAW,aAAa;AAAA;;AVlChB;AAGV;;iBUsCgB,iBAAA,CAAkB,MAAc;;iBAWhC,kBAAA,CAAmB,MAAc;;;;AVhDP;AAG1C;;;;;;;;;;;iBUiIsB,QAAA,CAAS,MAAA,EAAQ,aAAA,GAAgB,OAAO;;iBAMxC,aAAA,CAAc,MAAA,EAAQ,aAAA,GAAgB,OAAO;AV5HnE;;;;;;AAAA,iBU+IsB,KAAA,CAAM,MAAA,EAAQ,aAAA,GAAgB,OAAA,CAAQ,WAAA"}

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { A as operationExamples, B as PathItemObject, C as VerbCollision, D as MINIMUM_CONTRACT, E as MAXIMUM_CONTRACT, F as InfoObject, H as ResponseObject, I as MediaTypeObject, L as OpenApiDocument, M as buildAtomic, N as buildDescriptor, O as checkContract, P as HttpMethod, R as OperationObject, S as Emitter, T as emit, U as SchemaObject, V as RequestBodyObject, W as SchemaOrBool, _ as emitExamples, a as examplesOutputPath, b as emitErrorCodes, c as schemasOutputPath, d as hashJson, f as provenanceLines, g as readSchemas, h as readDocument, i as check, j as DescriptorBuilder, k as buildExamples, l as Provenance, m as SchemaBundle, n as CheckResult, o as generate, p as emitSchemas, r as CodegenConfig, s as generateFiles, t as ArtifactDrift, u as deriveProvenance, v as DocumentedErrorCode, w as detectVerbCollisions, x as readErrorCatalogue, y as ErrorCatalogue, z as ParameterObject } from "./index-COQQrn7a.mjs";
+import { A as operationExamples, B as PathItemObject, C as VerbCollision, D as MINIMUM_CONTRACT, E as MAXIMUM_CONTRACT, F as InfoObject, H as ResponseObject, I as MediaTypeObject, L as OpenApiDocument, M as buildAtomic, N as buildDescriptor, O as checkContract, P as HttpMethod, R as OperationObject, S as Emitter, T as emit, U as SchemaObject, V as RequestBodyObject, W as SchemaOrBool, _ as emitExamples, a as examplesOutputPath, b as emitErrorCodes, c as schemasOutputPath, d as hashJson, f as provenanceLines, g as readSchemas, h as readDocument, i as check, j as DescriptorBuilder, k as buildExamples, l as Provenance, m as SchemaBundle, n as CheckResult, o as generate, p as emitSchemas, r as CodegenConfig, s as generateFiles, t as ArtifactDrift, u as deriveProvenance, v as DocumentedErrorCode, w as detectVerbCollisions, x as readErrorCatalogue, y as ErrorCatalogue, z as ParameterObject } from "./index-k_oATv7Q.mjs";
 export { ArtifactDrift, CheckResult, CodegenConfig, DescriptorBuilder, type DocumentedErrorCode, Emitter, type ErrorCatalogue, type HttpMethod, type InfoObject, MAXIMUM_CONTRACT, MINIMUM_CONTRACT, type MediaTypeObject, type OpenApiDocument, type OperationObject, type ParameterObject, type PathItemObject, type Provenance, type RequestBodyObject, type ResponseObject, type SchemaBundle, type SchemaObject, type SchemaOrBool, type VerbCollision, buildAtomic, buildDescriptor, buildExamples, check, checkContract, deriveProvenance, detectVerbCollisions, emit, emitErrorCodes, emitExamples, emitSchemas, examplesOutputPath, generate, generateFiles, hashJson, operationExamples, provenanceLines, readDocument, readErrorCatalogue, readSchemas, schemasOutputPath };

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import { C as DescriptorBuilder, S as operationExamples, T as buildDescriptor, _ as readErrorCatalogue, a as schemasOutputPath, b as checkContract, c as emitSchemas, d as detectVerbCollisions, f as emit, g as emitErrorCodes, h as provenanceLines, i as generateFiles, l as emitExamples, m as hashJson, n as examplesOutputPath, o as readDocument, p as deriveProvenance, r as generate, s as readSchemas, t as check, u as Emitter, v as MAXIMUM_CONTRACT, w as buildAtomic, x as buildExamples, y as MINIMUM_CONTRACT } from "./src-AWTGjMiX.mjs";
+import { C as DescriptorBuilder, S as operationExamples, T as buildDescriptor, _ as readErrorCatalogue, a as schemasOutputPath, b as checkContract, c as emitSchemas, d as detectVerbCollisions, f as emit, g as emitErrorCodes, h as provenanceLines, i as generateFiles, l as emitExamples, m as hashJson, n as examplesOutputPath, o as readDocument, p as deriveProvenance, r as generate, s as readSchemas, t as check, u as Emitter, v as MAXIMUM_CONTRACT, w as buildAtomic, x as buildExamples, y as MINIMUM_CONTRACT } from "./src-py1RBWZr.mjs";
 export { DescriptorBuilder, Emitter, MAXIMUM_CONTRACT, MINIMUM_CONTRACT, buildAtomic, buildDescriptor, buildExamples, check, checkContract, deriveProvenance, detectVerbCollisions, emit, emitErrorCodes, emitExamples, emitSchemas, examplesOutputPath, generate, generateFiles, hashJson, operationExamples, provenanceLines, readDocument, readErrorCatalogue, readSchemas, schemasOutputPath };

package/dist/{src-AWTGjMiX.mjs → src-py1RBWZr.mjs}

@@ -74,7 +74,7 @@ function sortRecord(record) {
 function refName$1(ref) {
 	return ref.startsWith(REF_PREFIX$2) ? ref.slice(21) : void 0;
 }
-function isSchema$2(value) {
+function isSchema$3(value) {
 	return typeof value === "object" && value !== null;
 }
 /** The operationId prefixes of a relation's related read and its relationship endpoint. */
@@ -164,20 +164,20 @@ var DescriptorBuilder = class {
 	resourceType(name, schema) {
 		if (!name.endsWith("Resource") || name.endsWith("ResourceIdentifier")) return;
 		const constValue = schema.properties?.["type"];
-		if (isSchema$2(constValue) && typeof constValue.const === "string") return constValue.const;
+		if (isSchema$3(constValue) && typeof constValue.const === "string") return constValue.const;
 	}
 	/** Follow a `$ref` to its identifier/resource schema and read `properties.type.const`. */
 	resolveConst(ref) {
 		const target = refName$1(ref);
 		if (target === void 0) return;
 		const typeProp = this.schemas[target]?.properties?.["type"];
-		return isSchema$2(typeProp) && typeof typeProp.const === "string" ? typeProp.const : void 0;
+		return isSchema$3(typeProp) && typeof typeProp.const === "string" ? typeProp.const : void 0;
 	}
 	attributes(base) {
 		const props = this.schemas[`${base}Attributes`]?.properties;
 		if (props === void 0) return {};
 		const out = {};
-		for (const [name, prop] of Object.entries(props)) if (isSchema$2(prop)) out[name] = formatHint(prop);
+		for (const [name, prop] of Object.entries(props)) if (isSchema$3(prop)) out[name] = formatHint(prop);
 		return sortRecord(out);
 	}
 	/**
@@ -188,7 +188,7 @@ var DescriptorBuilder = class {
 	* request pivot off the write bodies.
 	*/
 	relations(wireType, base, resource, collection) {
-		const relProps = isSchema$2(resource.properties?.["relationships"]) ? resource.properties["relationships"].properties ?? {} : {};
+		const relProps = isSchema$3(resource.properties?.["relationships"]) ? resource.properties["relationships"].properties ?? {} : {};
 		const writes = this.writeRelationships(base);
 		const endpoints = this.relationEndpoints(wireType);
 		const out = {};
@@ -210,7 +210,7 @@ var DescriptorBuilder = class {
 			out[name] = collection === void 0 ? descriptor : this.withRelationExposure(descriptor, collection, name, endpoints.get(name));
 		};
 		for (const [name, prop] of Object.entries(relProps)) {
-			if (!isSchema$2(prop) || typeof prop.$ref !== "string" || writes.get(name)?.writeOnly) continue;
+			if (!isSchema$3(prop) || typeof prop.$ref !== "string" || writes.get(name)?.writeOnly) continue;
 			add(name, this.schemas[refName$1(prop.$ref) ?? ""], false);
 		}
 		for (const [name, write] of writes) if (write.writeOnly || !(name in relProps)) add(name, this.schemas[refName$1(write.ref) ?? ""], true);
@@ -224,10 +224,10 @@ var DescriptorBuilder = class {
 		const out = /* @__PURE__ */ new Map();
 		for (const request of [`${base}CreateRequest`, `${base}UpdateRequest`]) {
 			const data = this.schemas[request]?.properties?.["data"];
-			const relationships = isSchema$2(data) ? data.properties?.["relationships"] : void 0;
-			const props = isSchema$2(relationships) ? relationships.properties ?? {} : {};
+			const relationships = isSchema$3(data) ? data.properties?.["relationships"] : void 0;
+			const props = isSchema$3(relationships) ? relationships.properties ?? {} : {};
 			for (const [name, prop] of Object.entries(props)) {
-				if (!isSchema$2(prop) || typeof prop.$ref !== "string") continue;
+				if (!isSchema$3(prop) || typeof prop.$ref !== "string") continue;
 				const writeOnly = prop["writeOnly"] === true || out.get(name)?.writeOnly === true;
 				out.set(name, {
 					ref: out.get(name)?.ref ?? prop.$ref,
@@ -439,8 +439,8 @@ var DescriptorBuilder = class {
 		if (typeof ref !== "string") return;
 		const component = refName$1(ref);
 		const data = component === void 0 ? void 0 : this.schemas[component]?.properties?.["data"];
-		if (!isSchema$2(data)) return;
-		if (isSchema$2(data.items)) {
+		if (!isSchema$3(data)) return;
+		if (isSchema$3(data.items)) {
 			const itemRef = data.items.$ref;
 			const many = typeof itemRef === "string" ? this.resolveConst(itemRef) : void 0;
 			return many === void 0 ? void 0 : {
@@ -458,7 +458,7 @@ var DescriptorBuilder = class {
 	dataConst(data) {
 		if (typeof data.$ref === "string") return this.resolveConst(data.$ref);
 		const typeProp = data.properties?.["type"];
-		return isSchema$2(typeProp) && typeof typeProp.const === "string" ? typeProp.const : void 0;
+		return isSchema$3(typeProp) && typeof typeProp.const === "string" ? typeProp.const : void 0;
 	}
 	/** The `$ref` of the first 2xx JSON:API response body on an operation (the output document). */
 	firstOkJsonApiRef(op) {
@@ -471,7 +471,7 @@ var DescriptorBuilder = class {
 	/** Resolve a relationship component's `data` into a {@link RelationDescriptor}. */
 	relationFromComponent(component) {
 		const data = component.properties?.["data"];
-		if (!isSchema$2(data)) return;
+		if (!isSchema$3(data)) return;
 		if (data.type === "array") {
 			const items = data.items;
 			if (items === void 0) return;
@@ -550,7 +550,7 @@ var DescriptorBuilder = class {
 		const fields = {};
 		const nullable = [];
 		for (const [name, prop] of Object.entries(schema?.properties ?? {})) {
-			if (!isSchema$2(prop) || prop[side === "read" ? "writeOnly" : "readOnly"] === true) continue;
+			if (!isSchema$3(prop) || prop[side === "read" ? "writeOnly" : "readOnly"] === true) continue;
 			fields[name] = formatHint(prop);
 			if (isNullable(prop)) nullable.push(name);
 		}
@@ -580,7 +580,7 @@ var DescriptorBuilder = class {
 	}
 	clientId(base) {
 		const create = this.schemas[`${base}CreateRequest`];
-		const data = isSchema$2(create?.properties?.["data"]) ? create.properties["data"] : void 0;
+		const data = isSchema$3(create?.properties?.["data"]) ? create.properties["data"] : void 0;
 		if (data === void 0) return "forbidden";
 		if (data.properties?.["id"] === false) return "forbidden";
 		return data.required?.includes("id") ? "required" : "optional";
@@ -746,8 +746,8 @@ var DescriptorBuilder = class {
 function pivotNodeFromAllOf(allOf) {
 	for (const entry of allOf) {
 		const meta = entry.properties?.["meta"];
-		const pivot = isSchema$2(meta) ? meta.properties?.["pivot"] : void 0;
-		if (isSchema$2(pivot)) return pivot;
+		const pivot = isSchema$3(meta) ? meta.properties?.["pivot"] : void 0;
+		if (isSchema$3(pivot)) return pivot;
 	}
 }
 /**
@@ -756,7 +756,7 @@ function pivotNodeFromAllOf(allOf) {
 */
 function pivotNodeOf(component) {
 	const data = component.properties?.["data"];
-	if (!isSchema$2(data)) return;
+	if (!isSchema$3(data)) return;
 	if (Array.isArray(data.items?.allOf)) return pivotNodeFromAllOf(data.items.allOf);
 	for (const entry of data.anyOf ?? []) if (Array.isArray(entry.allOf)) return pivotNodeFromAllOf(entry.allOf);
 }
@@ -1044,7 +1044,7 @@ function buildExamples(doc, descriptor) {
 /** Below this the document predates the structures this codegen reads. */
 const MINIMUM_CONTRACT = 1;
 /** Above this the document carries structures this codegen does not read. */
-const MAXIMUM_CONTRACT = 13;
+const MAXIMUM_CONTRACT = 14;
 /**
 * Check the document's `info.x-generator.contract` against the range this codegen reads. A
 * document older than the range throws; a newer one returns a warning, because its new
@@ -1054,8 +1054,38 @@ const MAXIMUM_CONTRACT = 13;
 function checkContract(doc) {
 	const contract = doc.info?.["x-generator"]?.contract;
 	if (typeof contract !== "number") return;
-	if (contract < 1) throw new Error(`the document declares contract ${contract}, which predates what this codegen reads (it supports 1 to 13). Use an older codegen release, or regenerate the document from a newer server.`);
-	if (contract > 13) return `the document declares contract ${contract} and this codegen reads up to 13. It describes capabilities that were not generated; upgrade the codegen to pick them up.`;
+	if (contract < 1) throw new Error(`the document declares contract ${contract}, which predates what this codegen reads (it supports 1 to 14). Use an older codegen release, or regenerate the document from a newer server.`);
+	if (contract > 14) return `the document declares contract ${contract} and this codegen reads up to 14. It describes capabilities that were not generated; upgrade the codegen to pick them up.`;
+}
+//#endregion
+//#region src/declared-links.ts
+const LINK_OBJECT_REF = "#/components/schemas/LinkObject";
+function isSchema$2(value) {
+	return typeof value === "object" && value !== null;
+}
+/**
+* The declared links on a `<Type>ResourceLinks` component, in document order. `self` is never
+* declared, and a link the server builds itself, such as an action's link, points at
+* `RenderedLink`, so neither is read. A server that renders its links as strings points those at
+* `LinkObject` instead, so they read as bare links, which is the shape they render in. Expects
+* the document's single-entry `allOf` wrappers already read as their `$ref`.
+*/
+function readDeclaredLinks(component) {
+	const out = [];
+	for (const [name, schema] of Object.entries(component?.properties ?? {})) {
+		if (name === "self" || !isSchema$2(schema)) continue;
+		if (schema.$ref === LINK_OBJECT_REF) out.push({
+			name,
+			kind: "bare",
+			schema
+		});
+		else if (schema.$ref === void 0 && isSchema$2(schema.properties?.["href"])) out.push({
+			name,
+			kind: "object",
+			schema
+		});
+	}
+	return out;
 }
 //#endregion
 //#region src/source.ts
@@ -1397,7 +1427,9 @@ const MODULE_NAMES = [
 	"ErrorCodeByStatus",
 	"ErrorCodeGuard",
 	"ErrorCodes",
+	"Links",
 	"Record",
+	"ResourceLinks",
 	"ResourceMap",
 	"WriteAttributes"
 ];
@@ -1564,6 +1596,8 @@ var Emitter = class {
 	rawBodyAliases = /* @__PURE__ */ new Map();
 	/** JSDoc for entries of the `resourceMap` literal, keyed by their path joined with `/`. */
 	literalDocs = /* @__PURE__ */ new Map();
+	/** Wire type -> the links it declares, for the types that declare any. */
+	declaredLinks = /* @__PURE__ */ new Map();
 	/** Provenance of the source document, stamped into the generated header for drift tracking. */
 	provenance;
 	doc;
@@ -1575,12 +1609,18 @@ var Emitter = class {
 		this.baseByType = this.indexBases();
 		this.provenance = deriveProvenance(source);
 		this.takenNames = new Set(MODULE_NAMES);
+		for (const type of Object.keys(descriptor)) {
+			const base = this.baseByType.get(type);
+			const links = base === void 0 ? [] : readDeclaredLinks(this.schemas[`${base}ResourceLinks`]);
+			if (links.length > 0) this.declaredLinks.set(type, links);
+		}
 		for (const type of Object.keys(descriptor)) {
 			const stem = typeStem(type);
 			for (const suffix of [
 				"Attributes",
 				"CreateAttributes",
-				"UpdateAttributes"
+				"UpdateAttributes",
+				"Links"
 			]) this.takenNames.add(`${stem}${suffix}`);
 			for (const [name, action] of Object.entries(descriptor[type]?.actions ?? {})) {
 				this.takenNames.add(`${stem}${pascalCase(name)}Input`);
@@ -1629,6 +1669,7 @@ var Emitter = class {
 	emit() {
 		const interfaces = Object.keys(this.descriptor).map((type) => this.attributeInterface(type));
 		const writeInterfaces = Object.keys(this.descriptor).flatMap((type) => this.writeAttributeInterfaces(type));
+		const linkInterfaces = [...this.declaredLinks].map(([type, links]) => this.linksInterface(type, links));
 		const actionAliases = this.actionTypeAliases();
 		const enums = this.enumAliases();
 		return `${[
@@ -1637,9 +1678,11 @@ var Emitter = class {
 			...enums ? [enums] : [],
 			...interfaces,
 			...writeInterfaces,
+			...linkInterfaces,
 			...actionAliases,
 			this.attributesMap(),
 			this.writeAttributesMap(),
+			this.linksMap(),
 			this.actionTypesMap(),
 			this.resourceMap(),
 			"export type ResourceMap = typeof resourceMap",
@@ -1667,9 +1710,51 @@ var Emitter = class {
 			"  createClient as createClientRuntime,",
 			"  type ErrorCodeGuard,",
 			"  hasErrorCode as hasErrorCodeRuntime,",
+			...this.declaredLinks.size > 0 ? ["  type ResourceLinks,"] : [],
 			"} from '@haddowg/json-api-client'"
 		].join("\n");
 	}
+	/**
+	* The links interface of a type that declares links, e.g. `ImagesLinks`: each declared link an
+	* optional member, since the server leaves a link out when its href resolves to `null`. It
+	* extends the loose `ResourceLinks`, so `self` and any link the type doesn't declare stay
+	* reachable as before.
+	*/
+	linksInterface(type, links) {
+		const lines = [];
+		for (const link of links) {
+			const doc = jsDoc(memberDoc(link.schema), "  ");
+			if (doc !== void 0) lines.push(doc);
+			const value = link.kind === "bare" ? "string" : this.linkObjectType(link.schema, "  ");
+			lines.push(`  ${propertyKey(link.name)}?: ${value}`);
+		}
+		return `export interface ${typeStem(type)}Links extends ResourceLinks {\n${lines.join("\n")}\n}`;
+	}
+	/**
+	* A declared link object as a multi-line type: `href`, each static member as its `const`, and a
+	* `meta` object whose members are typed as attributes are, each with its own TSDoc.
+	*/
+	linkObjectType(schema, indent) {
+		return this.documentedObject(schema, indent, (name, member) => name === "meta" ? this.documentedObject(member, `${indent}  `, (_, field) => this.tsType(field)) : this.constOrType(member));
+	}
+	/** An object type with one line, and its TSDoc, per property. */
+	documentedObject(schema, indent, type) {
+		const required = new Set(schema.required ?? []);
+		const inner = `${indent}  `;
+		const lines = [];
+		for (const [name, member] of Object.entries(schema.properties ?? {})) {
+			if (!isSchema(member)) continue;
+			const doc = jsDoc(memberDoc(member), inner);
+			if (doc !== void 0) lines.push(doc);
+			lines.push(`${inner}${propertyKey(name)}${required.has(name) ? "" : "?"}: ${type(name, member)}`);
+		}
+		return lines.length === 0 ? "Record<string, unknown>" : `{\n${lines.join("\n")}\n${indent}}`;
+	}
+	/** A static link member's `const` as a literal type, else its schema's type. */
+	constOrType(schema) {
+		const value = schema["const"];
+		return typeof value === "string" ? stringLiteral(value) : this.tsType(schema);
+	}
 	/** Per-type attribute interface, e.g. `export interface AlbumsAttributes { ... }`. */
 	attributeInterface(type) {
 		const base = this.baseByType.get(type);
@@ -2067,6 +2152,17 @@ var Emitter = class {
 		return `export interface Attributes {\n${Object.keys(this.descriptor).map((type) => `  ${propertyKey(type)}: ${typeStem(type)}Attributes`).join("\n")}\n}`;
 	}
 	/**
+	* Emit the `Links` interface mapping each type that declares links to its links interface. The
+	* runtime threads it beside the `Attributes` map, so a read result's `$links` carries the
+	* declared links. A type absent from it keeps the loose `ResourceLinks`. Passed as the sixth
+	* type argument to the runtime factory.
+	*/
+	linksMap() {
+		const lines = [...this.declaredLinks.keys()].map((type) => `  ${propertyKey(type)}: ${typeStem(type)}Links`);
+		if (lines.length === 0) return "export interface Links {}";
+		return `export interface Links {\n${lines.join("\n")}\n}`;
+	}
+	/**
 	* Emit the `WriteAttributes` interface mapping each writable wire type to its
 	* `{ create; update }` attribute pair. A read-only type (no create/update component)
 	* contributes no entry, so the bound client only exposes writes where the API allows
@@ -2121,7 +2217,7 @@ var Emitter = class {
 			" * so bindings that only see the client (the Angular refs) type its errors.",
 			" */",
 			"export const createClient = (options: ClientOptions) =>",
-			"  createClientRuntime<typeof resourceMap, Attributes, WriteAttributes, ActionTypes, ErrorCode>(",
+			"  createClientRuntime<typeof resourceMap, Attributes, WriteAttributes, ActionTypes, ErrorCode, Links>(",
 			"    resourceMap,",
 			"    {",
 			"      atomic,",
@@ -2364,4 +2460,4 @@ async function check(config) {
 //#endregion
 export { DescriptorBuilder as C, operationExamples as S, buildDescriptor as T, readErrorCatalogue as _, schemasOutputPath as a, checkContract as b, emitSchemas as c, detectVerbCollisions as d, emit as f, emitErrorCodes as g, provenanceLines as h, generateFiles as i, emitExamples as l, hashJson as m, examplesOutputPath as n, readDocument as o, deriveProvenance as p, generate as r, readSchemas as s, check as t, Emitter as u, MAXIMUM_CONTRACT as v, buildAtomic as w, buildExamples as x, MINIMUM_CONTRACT as y };
 
-//# sourceMappingURL=src-AWTGjMiX.mjs.map
+//# sourceMappingURL=src-py1RBWZr.mjs.map