@haddowg/json-api-codegen 1.15.0 → 1.16.0

package/dist/cli.d.mts

@@ -1,4 +1,4 @@
-import { r as CodegenConfig } from "./index-FaJ8Xx6v.mjs";
+import { r as CodegenConfig } from "./index-D5vT2VuM.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-i5j2I9fk.mjs";
+import { i as generateFiles, t as check } from "./src-CuoXrhki.mjs";
 import { realpathSync } from "node:fs";
 import { fileURLToPath } from "node:url";
 //#region src/cli.ts

package/dist/{index-FaJ8Xx6v.d.mts → index-D5vT2VuM.d.mts}

@@ -23,6 +23,11 @@ interface SchemaObject {
   oneOf?: readonly SchemaObject[];
   'x-enum-varnames'?: readonly string[];
   'x-enum-descriptions'?: readonly string[];
+  /** On a `sort` array: the families of keys it accepts by prefix beside its fixed enum. */
+  'x-sort-families'?: readonly {
+    prefix?: unknown;
+    suffixPattern?: unknown;
+  }[];
   [key: string]: unknown;
 }
 /** A property entry: either a schema, or the literal `false` (a forbidden member). */
@@ -301,11 +306,18 @@ declare class DescriptorBuilder {
    */
   private includable;
   /**
-   * The sort tokens the COLLECTION read accepts — the `sort` query parameter's
-   * `schema.items.enum` (signed field names) on the collection GET. Returns `undefined` when
-   * the collection advertises no `sort` parameter (sorting unsupported).
+   * The sort tokens the COLLECTION read accepts — the `sort` query parameter's fixed enum
+   * (signed field names) on the collection GET: `schema.items.enum`, or the enum branch of
+   * `schema.items.anyOf` when the parameter also accepts sort families. Returns `undefined` when
+   * the collection advertises no `sort` parameter or no fixed keys.
    */
   private sortable;
+  /**
+   * The sort families the COLLECTION read accepts, from the `sort` parameter's
+   * `x-sort-families`: each a key prefix and the pattern its suffix must match. Returns
+   * `undefined` when the parameter lists none.
+   */
+  private sortFamilies;
   /**
    * The filter keys the COLLECTION read accepts in `filter[...]` (the `filter[<key>]` parameter
    * names, `<key>` extracted), sorted for deterministic output. Returns `undefined` when the
@@ -342,7 +354,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 = 19;
+declare const MAXIMUM_CONTRACT = 20;
 /**
  * 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
@@ -763,4 +775,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, SecurityRequirement as G, ResponseObject as H, MediaTypeObject as I, SecuritySchemeObject as K, 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-FaJ8Xx6v.d.mts.map
+//# sourceMappingURL=index-D5vT2VuM.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index-D5vT2VuM.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;EAP4B;EAS5B,iBAAA;IAA+B,MAAA;IAAkB,aAAA;EAAA;EAAA,CAChD,GAAA;AAAA;;KAIS,YAAA,GAAe,YAAY;AAAA,UAEtB,eAAA;EACf,MAAA,GAAS,YAAY;EAVrB;EAYA,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;EApBS;EAsBT,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;EAzBF;EA2BzB,UAAA;IAAe,QAAA;IAAoB,WAAA;IAAuB,UAAA;EAAA;;EAE1D,QAAA,YAAoB,mBAAA;AAAA;;KAIV,mBAAA,GAAsB,QAAQ,CAAC,MAAA;;UAG1B,oBAAA;EACf,IAAI;AAAA;AAAA,KAGM,UAAA;AAAA,KAEA,cAAA,GAAiB,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,eAAA;AAAA,UAEvC,UAAA;EACf,KAAA;EACA,OAAA;EAlCA;EAoCA,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;EA9BI;EAgC3B,QAAA,YAAoB,mBAAA;EACpB,UAAA;IACE,OAAA,GAAU,MAAA,SAAe,YAAA;IACzB,eAAA,GAAkB,MAAA,SAAe,oBAAA;EAAA;AAAA;;;cClBxB,iBAAA;EAAA,iBACM,OAAA;EAAA,iBACA,KAAA;;UAET,cAAA;EDrEK;EAAA,iBCuEI,YAAA;EDpEA;EAAA,iBCsEA,eAAA;cAEL,MAAA,EAAQ,eAAA;EDtES;;;;EAAA,QCsFrB,MAAA;ED9FR;;;;;EAAA,QCoHQ,eAAA;EDhHR;;;;;EAAA,QCoJQ,aAAA;EAaR,KAAA,IAAS,aAAA;ED7JT;;;;;ECoOA,WAAA,IAAe,gBAAA;EDhOkC;;;AACrC;AAId;EALmD,QCgPzC,YAAA;;UAYA,YAAA;EAAA,QASA,UAAA;ED9PO;;;;;;;EAAA,QCoRP,SAAA;EDjRD;AAGT;;;EAHS,QC+UC,kBAAA;ED3UR;;;;;AACQ;EADR,QCkWQ,iBAAA;ED9VqB;;;;;;;EAAA,QC2YrB,iBAAA;EDvYO;;;;;;;;;;EAAA,QC0aP,oBAAA;EDlaR;;AAAW;AAGb;;;;;EAHE,QCqeQ,OAAA;ED5dI;EAAA,QC0gBJ,MAAA;EDtgB+B;;;;EAAA,QCmlB/B,SAAA;EDzlBR;;;;;EAAA,QC8mBQ,YAAA;ED5mBmB;EAAA,QC2nBnB,cAAA;EDznBO;EAAA,QCuoBP,aAAA;EDvoBkD;;;;AAEnB;EAFmB,QCopBlD,eAAA;ED9oBqB;EAAA,QCmqBrB,SAAA;EDnqBwB;AAAe;AAGjD;;;EAHkC,QCgrBxB,aAAA;ED5qBJ;EAAA,QCurBI,iBAAA;EDprBY;EAAA,QCosBZ,qBAAA;EDpsBY;AAAA;AAEtB;;;EAFsB,QC6xBZ,UAAA;ED3xB8C;;;;;;;EAAA,QC0yB9C,eAAA;ED1yB8C;EAAA,QCi1B9C,cAAA;EDj1B6D;AAEvE;;;;EAFuE,QCk2B7D,UAAA;ED91BR;EAAA,QCi3BQ,cAAA;EAAA,QAaA,QAAA;ED53BkB;AAAA;AAG5B;;;EAH4B,QC64BlB,cAAA;EAAA,QAmCA,cAAA;EDz6BA;EAAA,QC+7BA,cAAA;EAAA,QAWA,mBAAA;EDt8BI;EAAA,QC88BJ,SAAA;ED78BY;;;;;;;EAAA,QCy9BZ,WAAA;ED99BR;;;;;;;EAAA,QC4gCQ,WAAA;EDxgCmB;;;;;AAC4B;;;;AClBzD;;;;EDiB6B,QC8iCnB,SAAA;EAv5BO;;;;;;;;;EAAA,QAu6BP,UAAA;EArkCI;;;;;;EAAA,QAmlCJ,QAAA;EAr7BO;;;;;EAAA,QAw8BP,YAAA;EAxzBA;;;;;;EAAA,QAi1BA,UAAA;EAAA,QAeA,SAAA;EAAA,QAIA,cAAA;EAAA,QAIA,aAAA;AAAA;;iBAkSM,eAAA,CAAgB,GAAA,EAAK,eAAA,GAAkB,aAAa;;iBAKpD,WAAA,CAAY,GAAA,EAAK,eAAA,GAAkB,gBAAgB;;;;AD/gDnE;;;;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,cA6WjE,OAAA;EAAA,iBAwCQ,UAAA;EAAA,iBACA,MAAA;EAAA,iBAxCF,OAAA;EJ1ZjB;EAAA,iBI4ZiB,UAAA;EJ1ZjB;EAAA,iBI4ZiB,SAAA;EJ5ZW;;;;;;EAAA,iBImaX,iBAAA;EJ/ZA;EAAA,iBIiaA,SAAA;EJhaA;EAAA,iBIkaA,UAAA;EJhajB;EAAA,iBIkaiB,SAAA;EJhac;;;;AACnB;EADmB,iBIsad,gBAAA;EJjaK;EAAA,iBImaL,cAAA;EJnaoB;EAAA,iBIqapB,WAAA;EJnaF;EAAA,iBIsaE,aAAA;;mBAGA,UAAA;EAAA,iBAEA,GAAA;cAGf,MAAA,EAAQ,eAAA,EACS,UAAA,EAAY,aAAA,EACZ,MAAA,EAAQ,gBAAA;EJ7a3B;;AAAO;AAGT;EAHE,QIofQ,QAAA;;UA0BA,UAAA;EAcR,IAAA;EAAA,QAwCQ,MAAA;EAAA,QAWA,OAAA;EJ1kBR;;AAAQ;AAGV;EAHE,QIgmBQ,eAAA;;;;;;;UA6BA,cAAA;EJtnBO;;;;EAAA,QIuoBP,cAAA;EJroBR;EAAA,QI8oBQ,gBAAA;EJ5oBR;EAAA,QIoqBQ,WAAA;EJnqBR;EAAA,QIyqBQ,kBAAA;EJtqBR;;AAAW;AAGb;;;;EAHE,QIsrBQ,wBAAA;EJ7qBmB;;;;;;;EAAA,QIqtBnB,iBAAA;EJvtBR;;;;;EAAA,QI+yBQ,YAAA;EJ7yBmB;;;;;EAAA,QIs0BnB,cAAA;EJl0BY;;AAAmB;AAIzC;;EAJsB,QI62BZ,aAAA;EJz2BwB;EAAA,QI+3BxB,kBAAA;EJ53BO;;;;AACX;AAGN;;;EAJiB,QI24BP,cAAA;EJv4BY;AAEtB;;;;;;;;;EAFsB,QIi7BZ,cAAA;EJ/6B2B;EAAA,QI87B3B,WAAA;EJ97B8C;;AAAe;AAEvE;;;EAFwD,QIi9B9C,eAAA;EJ98BR;;;;;EAAA,QIy+BQ,sBAAA;EJn+BO;;;;EAAA,QIs/BP,cAAA;EJl/BA;;;;EAAA,QIwgCA,qBAAA;EJngCY;;;;EAAA,QIkhCZ,UAAA;EJzhCD;EAAA,QImjCC,UAAA;EJljCa;;;;EAAA,QI2jCb,cAAA;EJxjCY;EAAA,QI4kCZ,gBAAA;EJ1kCN;;;;;EAAA,QIumCM,eAAA;EJtmC+C;EAAA,QIgoC/C,MAAA;;UAiDA,UAAA;EAAA,QAaA,iBAAA;EHhtCG;EAAA,QGyuCH,UAAA;EAAA,QAoBA,SAAA;EHnvCY;EAAA,QG8vCZ,WAAA;EHhmCO;;;;;EAAA,QGunCP,OAAA;EHzxCS;;;;;;EAAA,QG0yCT,aAAA;EH5tCA;;;;;;EAAA,QGyuCA,QAAA;EHhnCA;;;;;;EAAA,QGgoCA,kBAAA;EHp1BA;EAAA,QG82BA,WAAA;EH5wBA;EAAA,QGkxBA,OAAA;EAAA,QA6BA,YAAA;AAAA;;;;;iBAwBM,IAAA,CACd,GAAA,EAAK,eAAA,EACL,UAAA,EAAY,aAAA,EACZ,MAAA,GAAQ,gBAAA;;;;UC9+CO,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;EVtB+B;;;;EU2B/B,QAAA;EVtBU;;;;AAA2B;EU4BrC,KAAA;AAAA;;UAIe,aAAA;EV7Bf;EU+BA,IAAA;EV7BA;EU+BA,QAAQ;AAAA;AV5BV;AAAA,UUgCiB,WAAA;EACf,EAAA;EACA,SAAA,EAAW,aAAa;AAAA;;;;;iBAOV,iBAAA,CAAkB,MAAc;AVpChD;AAAA,iBU+CgB,kBAAA,CAAmB,MAAc;;;;;;;AV9CP;AAG1C;;;;;;;;iBU+HsB,QAAA,CAAS,MAAA,EAAQ,aAAA,GAAgB,OAAO;;iBAMxC,aAAA,CAAc,MAAA,EAAQ,aAAA,GAAgB,OAAO;;;AV7HtD;AAGb;;;iBU6IsB,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, G as SecurityRequirement, H as ResponseObject, I as MediaTypeObject, K as SecuritySchemeObject, 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-FaJ8Xx6v.mjs";
+import { A as operationExamples, B as PathItemObject, C as VerbCollision, D as MINIMUM_CONTRACT, E as MAXIMUM_CONTRACT, F as InfoObject, G as SecurityRequirement, H as ResponseObject, I as MediaTypeObject, K as SecuritySchemeObject, 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-D5vT2VuM.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 SecurityRequirement, type SecuritySchemeObject, 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-i5j2I9fk.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-CuoXrhki.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-i5j2I9fk.mjs → src-CuoXrhki.mjs}

@@ -177,6 +177,8 @@ var DescriptorBuilder = class {
 			if (included !== void 0) descriptor.included = included;
 			const sortable = this.sortable(collection);
 			if (sortable !== void 0) descriptor.sortable = sortable;
+			const sortFamilies = this.sortFamilies(collection);
+			if (sortFamilies !== void 0) descriptor.sortFamilies = sortFamilies;
 			const filterable = this.filterable(collection);
 			if (filterable !== void 0) descriptor.filterable = filterable;
 			if (Object.keys(actions).length > 0) descriptor.actions = actions;
@@ -829,14 +831,32 @@ var DescriptorBuilder = class {
 		return tokens !== void 0 && tokens.length > 0 ? tokens : void 0;
 	}
 	/**
-	* The sort tokens the COLLECTION read accepts — the `sort` query parameter's
-	* `schema.items.enum` (signed field names) on the collection GET. Returns `undefined` when
-	* the collection advertises no `sort` parameter (sorting unsupported).
+	* The sort tokens the COLLECTION read accepts — the `sort` query parameter's fixed enum
+	* (signed field names) on the collection GET: `schema.items.enum`, or the enum branch of
+	* `schema.items.anyOf` when the parameter also accepts sort families. Returns `undefined` when
+	* the collection advertises no `sort` parameter or no fixed keys.
 	*/
 	sortable(collection) {
 		if (collection === void 0) return;
-		const tokens = paramItemsEnum(this.operation(collection, "get"), "sort");
-		return tokens !== void 0 && tokens.length > 0 ? tokens : void 0;
+		const items = paramSchema(this.operation(collection, "get"), "sort")?.items;
+		const tokens = (items?.anyOf ?? (items === void 0 ? [] : [items])).flatMap((branch) => Array.isArray(branch.enum) ? branch.enum.filter((v) => typeof v === "string") : []);
+		return tokens.length > 0 ? tokens : void 0;
+	}
+	/**
+	* The sort families the COLLECTION read accepts, from the `sort` parameter's
+	* `x-sort-families`: each a key prefix and the pattern its suffix must match. Returns
+	* `undefined` when the parameter lists none.
+	*/
+	sortFamilies(collection) {
+		if (collection === void 0) return;
+		const declared = paramSchema(this.operation(collection, "get"), "sort")?.["x-sort-families"];
+		if (!Array.isArray(declared)) return;
+		const families = [];
+		for (const family of declared) if (typeof family.prefix === "string" && typeof family.suffixPattern === "string") families.push({
+			prefix: family.prefix,
+			suffixPattern: family.suffixPattern
+		});
+		return families.length > 0 ? families : void 0;
 	}
 	/**
 	* The filter keys the COLLECTION read accepts in `filter[...]` (the `filter[<key>]` parameter
@@ -930,17 +950,18 @@ function withCountParam(op) {
 		};
 	}
 }
+/** The schema of the operation's parameter of that name, if it carries one. */
+function paramSchema(op, paramName) {
+	return op?.parameters?.find((param) => param.name === paramName)?.schema;
+}
 /**
 * The string members of an array-valued query parameter's `schema.items.enum` (the shape the
-* `include` and `sort` parameters use). Returns `undefined` when the operation carries no
-* parameter of that name, or one whose schema declares no enum.
+* `include` parameter uses). Returns `undefined` when the operation carries no parameter of
+* that name, or one whose schema declares no enum.
 */
 function paramItemsEnum(op, paramName) {
-	for (const param of op?.parameters ?? []) {
-		if (param.name !== paramName) continue;
-		const enumValues = param.schema?.items?.enum;
-		return Array.isArray(enumValues) ? enumValues.filter((v) => typeof v === "string") : void 0;
-	}
+	const enumValues = paramSchema(op, paramName)?.items?.enum;
+	return Array.isArray(enumValues) ? enumValues.filter((v) => typeof v === "string") : void 0;
 }
 /**
 * True for the Atomic Operations ext media type — `application/vnd.api+json` carrying the
@@ -1230,7 +1251,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 = 19;
+const MAXIMUM_CONTRACT = 20;
 /**
 * 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
@@ -1240,8 +1261,8 @@ const MAXIMUM_CONTRACT = 19;
 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 19). Use an older codegen release, or regenerate the document from a newer server.`);
-	if (contract > 19) return `the document declares contract ${contract} and this codegen reads up to 19. 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 20). Use an older codegen release, or regenerate the document from a newer server.`);
+	if (contract > 20) return `the document declares contract ${contract} and this codegen reads up to 20. It describes capabilities that were not generated; upgrade the codegen to pick them up.`;
 }
 //#endregion
 //#region src/declared-links.ts
@@ -2875,4 +2896,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-i5j2I9fk.mjs.map
+//# sourceMappingURL=src-CuoXrhki.mjs.map