@haddowg/json-api-codegen 1.6.0 → 1.7.0

package/dist/cli.d.mts

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

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { n as generate, r as schemasOutputPath, t as check } from "./src-C2INS1Wd.mjs";
+import { n as generate, r as schemasOutputPath, t as check } from "./src-DhZyiWge.mjs";
 import { realpathSync } from "node:fs";
 import { fileURLToPath } from "node:url";
 //#region src/cli.ts

package/dist/{index-CU-kUx70.d.mts → index-CeSU_OuC.d.mts}

@@ -49,6 +49,8 @@ interface ParameterObject {
 }
 interface OperationObject {
   operationId?: string;
+  summary?: string;
+  description?: string;
   parameters?: readonly ParameterObject[];
   requestBody?: RequestBodyObject;
   responses?: Record<string, ResponseObject>;
@@ -151,6 +153,21 @@ declare class DescriptorBuilder {
    * `output` is `document` (a 2xx returns a JSON:API document) or `none` (only `204`).
    */
   private actions;
+  /**
+   * The non-JSON:API media types an action answers with under its 2xx responses, each once, in
+   * the document's order, with how the client reads its body.
+   */
+  private rawOutput;
+  /**
+   * How the client reads or sends a non-JSON:API body: `binary` for `format: binary` (or no schema
+   * on a type that isn't text or JSON), `text` for any other string schema (or no schema on a
+   * `text/*` type), `json` for any other schema (or no schema on a JSON type).
+   */
+  private rawMediaKind;
+  /** How the client sends one of an action's several request media types. */
+  private inputMediaKind;
+  /** A schema with a component `$ref` followed, else the schema as is. */
+  private resolveSchema;
   /**
    * The wire type (and cardinality) of a document component's primary `data` — a `$ref` to a
    * resource, an inline object carrying `properties.type.const` (a create-request body), or an
@@ -260,7 +277,7 @@ declare function buildAtomic(doc: OpenApiDocument): AtomicDescriptor | null;
 /** 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 = 9;
+declare const MAXIMUM_CONTRACT = 11;
 /**
  * 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
@@ -295,6 +312,10 @@ declare class Emitter {
    * already-named attribute type. Populated as interfaces are emitted.
    */
   private readonly emittedInterfaces;
+  /** Enum component name -> the alias name it's emitted under. */
+  private readonly enumNames;
+  /** Type names already spoken for: the module's own, the per-type interfaces and enum aliases. */
+  private readonly takenNames;
   /** Component names mid-expansion in {@link tsType} — a cycle guard for self/mutually-referential `$ref`s. */
   private readonly expanding;
   /**
@@ -303,10 +324,21 @@ declare class Emitter {
    * type-map only references aliases that exist (a `none` input/output contributes neither).
    */
   private readonly actionAliasNames;
+  /** Raw body components already emitted as a named alias, by component name. */
+  private readonly rawBodyAliases;
+  /** JSDoc for entries of the `resourceMap` literal, keyed by their path joined with `/`. */
+  private readonly literalDocs;
   /** Provenance of the source document, stamped into the generated header for drift tracking. */
   private readonly provenance;
   private readonly doc;
   constructor(source: OpenApiDocument, descriptor: ApiDescriptor, atomic: AtomicDescriptor | null);
+  /** The operation an action is invoked over: its declared method, else `POST`. */
+  private actionOperation;
+  /**
+   * The alias an enum component is emitted under: its own name when that's a usable type name,
+   * else one derived from it (with a warning), kept clear of every other name in the module.
+   */
+  private enumName;
   /** Map each declared wire type back to the `Base` of its resource schema. */
   private indexBases;
   emit(): string;
@@ -330,6 +362,26 @@ declare class Emitter {
    * no alias. Deterministic order: types, then action names (the descriptor is sorted).
    */
   private actionTypeAliases;
+  /**
+   * The alias a JSON-like raw body is typed by. A `$ref` to a component is emitted once under the
+   * component's own name when that name is free; anything else gets `fallback`. The alias source
+   * is pushed onto `out` the first time.
+   */
+  private rawBodyAlias;
+  /**
+   * The typed fields of a multipart or URL-encoded request body whose object schema lists
+   * `properties`, which the client encodes into a `FormData` or `URLSearchParams`. `undefined`
+   * when the schema lists none, so the body stays a raw `FormData` or `URLSearchParams`.
+   */
+  private formFieldsType;
+  /**
+   * One form field's type: `Blob | File` for a binary part of a multipart body, an array of
+   * its item type for an array, else the scalar's own type. A field with no usable type takes
+   * any scalar a form can carry.
+   */
+  private formFieldType;
+  /** `export type Name = …` for a raw body schema, with its description as JSDoc. */
+  private rawBodyDeclaration;
   /**
    * Emit the `ActionTypes` interface wiring the emitted per-action aliases onto the typed
    * action surface — `type -> actionName -> { input?; output? }`, the client's fourth type
@@ -502,7 +554,7 @@ declare function hashJson(value: unknown): string;
 declare function deriveProvenance(doc: OpenApiDocument): Provenance;
 /**
  * Render the provenance record as the JSDoc header lines stamped into a generated artifact
- * (each already prefixed with ` * `). Deterministic: no timestamp, so re-generating from the
+ * (each already prefixed with ` * `), with the document's text kept to one comment line. Deterministic: no timestamp, so re-generating from the
  * same spec yields byte-identical output.
  */
 declare function provenanceLines(provenance: Provenance): string[];
@@ -565,4 +617,4 @@ declare function generate(config: CodegenConfig): Promise<string>;
 declare function check(config: CodegenConfig): Promise<CheckResult>;
 //#endregion
 export { InfoObject as A, MAXIMUM_CONTRACT as C, buildAtomic as D, DescriptorBuilder as E, PathItemObject as F, RequestBodyObject as I, ResponseObject as L, OpenApiDocument as M, OperationObject as N, buildDescriptor as O, ParameterObject as P, SchemaObject as R, emit as S, checkContract as T, emitErrorCodes as _, generate as a, VerbCollision as b, deriveProvenance as c, emitSchemas as d, SchemaBundle as f, ErrorCatalogue as g, DocumentedErrorCode as h, check as i, MediaTypeObject as j, HttpMethod as k, hashJson as l, readSchemas as m, CheckResult as n, schemasOutputPath as o, readDocument as p, CodegenConfig as r, Provenance as s, ArtifactDrift as t, provenanceLines as u, readErrorCatalogue as v, MINIMUM_CONTRACT as w, detectVerbCollisions as x, Emitter as y, SchemaOrBool as z };
-//# sourceMappingURL=index-CU-kUx70.d.mts.map
+//# sourceMappingURL=index-CeSU_OuC.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index-CeSU_OuC.d.mts","names":[],"sources":["../src/openapi.ts","../src/build-descriptor.ts","../src/contract.ts","../src/emit.ts","../src/error-codes.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;AAAA;AAAA,UAGN,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;EAnB8B;EAqB9B,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;;EAEA,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;;;cCDhB,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;;;AACT;AAGvB;;EAJgC,QCuRtB,iBAAA;EDlRQ;;;;;;AACR;EADQ,QC+TR,iBAAA;ED3TqB;;;;;;;AACW;AAG1C;;EAJ+B,QC8VrB,oBAAA;EDtVa;;;;;;;EAAA,QCoZb,OAAA;EDhZR;;AAAW;AAGb;EAHE,QCseQ,SAAA;;;;;;UAqBA,YAAA;EDlfU;EAAA,QCigBV,cAAA;EDrgBR;EAAA,QCmhBQ,aAAA;EDjhBR;;;;;EAAA,QC8hBQ,eAAA;ED5hBmB;EAAA,QCijBnB,SAAA;EDjjBiC;EAAA,QC0jBjC,iBAAA;EDvjBY;EAAA,QCqkBZ,qBAAA;EDrkBY;AAAA;AAEtB;;;EAFsB,QCopBZ,UAAA;EDlpB8C;;;;;;;EAAA,QCiqB9C,eAAA;EDjqB8C;EAAA,QCwsB9C,cAAA;EDxsB6D;EAAA,QCqtB7D,cAAA;EAAA,QAaA,QAAA;;;;;;UAiBA,cAAA;EAAA,QAmCA,cAAA;EDhxBkB;EAAA,QCsyBlB,cAAA;EAAA,QAWA,mBAAA;;UAQA,SAAA;EDlzBe;;;;;;;EAAA,QC8zBf,WAAA;EDh0BD;;;;;;;EAAA,QC82BC,WAAA;ED12BI;;;AAA2B;;;;ACDzC;;;;;;EDCc,QCg5BJ,SAAA;EA1zBuB;;;;;;;;;EAAA,QA00BvB,UAAA;EA10BR;;;;;EAAA,QAu1BQ,QAAA;EA/tBA;;;;;;EAAA,QA6uBA,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;;;;cC/uCtD,gBAAA;AFKb;AAAA,cEFa,gBAAA;;;;;;;iBAQG,aAAA,CAAc,GAAoB,EAAf,eAAe;;;;UCuBjC,aAAA;EACf,IAAA;EACA,QAAQ;AAAA;;;;;iBAsBM,oBAAA,CAAqB,UAAA,EAAY,aAAA,GAAgB,aAAa;AAAA,cAyLjE,OAAA;EAAA,iBAqCQ,UAAA;EAAA,iBACA,MAAA;EAAA,iBArCF,OAAA;EH5OjB;EAAA,iBG8OiB,UAAA;EH5OjB;EAAA,iBG8OiB,SAAA;EH5OjB;;;;;;EAAA,iBGmPiB,iBAAA;EHhPA;EAAA,iBGkPA,SAAA;EHjPA;EAAA,iBGmPA,UAAA;EHlPA;EAAA,iBGoPA,SAAA;EHlPjB;;;AACY;AAId;EALE,iBGwPiB,gBAAA;;mBAEA,cAAA;EHrPoB;EAAA,iBGuPpB,WAAA;EHrPa;EAAA,iBGwPb,UAAA;EAAA,iBAEA,GAAA;cAGf,MAAA,EAAQ,eAAA,EACS,UAAA,EAAY,aAAA,EACZ,MAAA,EAAQ,gBAAA;EH3PZ;EAAA,QGgSP,eAAA;;;;;UASA,QAAA;EHvSR;EAAA,QGiUQ,UAAA;EAcR,IAAA;EAAA,QA+BQ,MAAA;EAAA,QAWA,OAAA;;UAaA,kBAAA;EHlYR;;;;AAAwC;AAG1C;;EAHE,QGkZQ,wBAAA;EH3Ya;;;;;;;EAAA,QGmbb,iBAAA;EH/aR;;AAAW;AAGb;;EAHE,QGugBQ,YAAA;EHhgBc;;;;;EAAA,QGyhBd,cAAA;EH5hBR;;;;;EAAA,QGukBQ,aAAA;EHnkBM;EAAA,QGylBN,kBAAA;EHxlBI;;;AAA6B;AAG3C;;;;EAHc,QGumBJ,cAAA;EHlmBE;;;;;;;;;;EAAA,QG4oBF,cAAA;EH5oBkC;EAAA,QG2pBlC,WAAA;EH3pB6D;AAAA;AAEvE;;;;EAFuE,QG4qB7D,eAAA;EHxqBR;EAAA,QG8sBQ,gBAAA;EH5sBU;;AAAQ;AAG5B;;EAHoB,QGyuBV,eAAA;EHpuBD;EAAA,QG8vBC,MAAA;EH5vBA;EAAA,QG6yBA,UAAA;EAAA,QAaA,iBAAA;EHxzBU;EAAA,QGi1BV,UAAA;EAAA,QAoBA,SAAA;EHz2BR;EAAA,QGo3BQ,WAAA;EHn3BR;;;;;EAAA,QG04BQ,OAAA;EHv4BN;;;;AAAqC;;EAArC,QGw5BM,aAAA;;AFz5BV;;;;;UEs6BU,kBAAA;EF/0BuB;EAAA,QEy2BvB,WAAA;EF/7BS;EAAA,QEq8BT,OAAA;EAAA,QA6BA,YAAA;AAAA;;;;;iBAwBM,IAAA,CACd,GAAA,EAAK,eAAA,EACL,UAAA,EAAY,aAAA,EACZ,MAAA,GAAQ,gBAAA;;;;UCrkCO,mBAAA;EACf,IAAA;EJA2B;EIE3B,WAAA;EJK4B;EIH5B,QAAA;AAAA;;UAIe,cAAA;EJIE;EIFjB,KAAA,EAAO,mBAAA;EJEsB;;;;EIG7B,QAAA,EAAU,GAAG;AAAA;;;;;;;iBAuCC,kBAAA,CAAmB,GAAA,EAAK,eAAA,GAAkB,cAAc;;;;;;;;iBAiFxD,cAAA,CAAe,SAAyB,EAAd,cAAc;;;;KCzI5C,YAAA,GAAe,MAAM,SAAS,YAAA;;;;;iBA+CpB,YAAA,CAAa,KAAA,WAAgB,OAAO,CAAC,eAAA;;;;;;iBASrC,WAAA,CAAY,KAAA,WAAgB,OAAO,CAAC,YAAA;;;;;ALtD1D;;;;;;;;;;;;;iBMUgB,WAAA,CAAY,MAAoB,EAAZ,YAAY;;;;;ANVhD;;;;UOEiB,UAAA;EPMP;EAAA,SOJC,MAAA;EPOQ;EAAA,SOLR,MAAA;EPMoB;EAAA,SOJpB,IAAA;AAAA;;iBAwBK,QAAA,CAAS,KAAc;;;;;;iBAYvB,gBAAA,CAAiB,GAAA,EAAK,eAAA,GAAkB,UAAU;;;;;;iBAelD,eAAA,CAAgB,UAAsB,EAAV,UAAU;;;UCjCrC,aAAA;ERjBf;EQmBA,KAAA;ERlBiB;EQoBjB,MAAA;ERnBiB;EQqBjB,MAAA;ERpBiB;EQsBjB,OAAA;ERpBA;;;AACY;AAId;EQqBE,KAAA;AAAA;;UAIe,aAAA;ERvBA;EQyBf,IAAA;;EAEA,QAAQ;AAAA;ARvBV;AAAA,UQ2BiB,WAAA;EACf,EAAA;EACA,SAAA,EAAW,aAAa;AAAA;;;;;iBAOV,iBAAA,CAAkB,MAAc;AR/BhD;;;;;;;;AAC0C;AAG1C;;;;;AAJA,iBQmGsB,QAAA,CAAS,MAAA,EAAQ,aAAA,GAAgB,OAAO;;;;;;;iBAgBxC,KAAA,CAAM,MAAA,EAAQ,aAAA,GAAgB,OAAA,CAAQ,WAAA"}

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { A as InfoObject, C as MAXIMUM_CONTRACT, D as buildAtomic, E as DescriptorBuilder, F as PathItemObject, I as RequestBodyObject, L as ResponseObject, M as OpenApiDocument, N as OperationObject, O as buildDescriptor, P as ParameterObject, R as SchemaObject, S as emit, T as checkContract, _ as emitErrorCodes, a as generate, b as VerbCollision, c as deriveProvenance, d as emitSchemas, f as SchemaBundle, g as ErrorCatalogue, h as DocumentedErrorCode, i as check, j as MediaTypeObject, k as HttpMethod, l as hashJson, m as readSchemas, n as CheckResult, o as schemasOutputPath, p as readDocument, r as CodegenConfig, s as Provenance, t as ArtifactDrift, u as provenanceLines, v as readErrorCatalogue, w as MINIMUM_CONTRACT, x as detectVerbCollisions, y as Emitter, z as SchemaOrBool } from "./index-CU-kUx70.mjs";
+import { A as InfoObject, C as MAXIMUM_CONTRACT, D as buildAtomic, E as DescriptorBuilder, F as PathItemObject, I as RequestBodyObject, L as ResponseObject, M as OpenApiDocument, N as OperationObject, O as buildDescriptor, P as ParameterObject, R as SchemaObject, S as emit, T as checkContract, _ as emitErrorCodes, a as generate, b as VerbCollision, c as deriveProvenance, d as emitSchemas, f as SchemaBundle, g as ErrorCatalogue, h as DocumentedErrorCode, i as check, j as MediaTypeObject, k as HttpMethod, l as hashJson, m as readSchemas, n as CheckResult, o as schemasOutputPath, p as readDocument, r as CodegenConfig, s as Provenance, t as ArtifactDrift, u as provenanceLines, v as readErrorCatalogue, w as MINIMUM_CONTRACT, x as detectVerbCollisions, y as Emitter, z as SchemaOrBool } from "./index-CeSU_OuC.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, check, checkContract, deriveProvenance, detectVerbCollisions, emit, emitErrorCodes, emitSchemas, generate, hashJson, provenanceLines, readDocument, readErrorCatalogue, readSchemas, schemasOutputPath };

package/dist/index.mjs

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