@effect/openapi-generator 4.0.0-beta.8 → 4.0.0-beta.81

package/dist/JsonSchemaGenerator.js

@@ -1,7 +1,39 @@
+/**
+ * Generate TypeScript source for JSON Schema declarations extracted from
+ * OpenAPI documents.
+ *
+ * This module is the schema-rendering stage of the OpenAPI generator. Callers
+ * register named OpenAPI 3.0 or 3.1 schemas, provide the reusable component
+ * definitions for the document, and receive source text containing exported
+ * TypeScript aliases plus Effect Schema runtime values. The generator first
+ * normalizes OpenAPI-specific schema shapes into Effect's JSON Schema model,
+ * then delegates recursive analysis and runtime expression construction to
+ * `SchemaRepresentation`.
+ *
+ * The renderer keeps the emitted module usable for both human maintainers and
+ * automated code-generation consumers by grouping recursive declarations,
+ * reusable references, and locally registered schemas. It also contains the
+ * HttpApi-specific multipart file substitutions that map generated schemas to
+ * Effect's multipart runtime types.
+ *
+ * @since 4.0.0
+ */
 import * as Arr from "effect/Array";
 import * as JsonSchema from "effect/JsonSchema";
 import * as Rec from "effect/Record";
 import * as SchemaRepresentation from "effect/SchemaRepresentation";
+/**
+ * Create a stateful JSON Schema code generator for OpenAPI-derived schemas.
+ *
+ * **Details**
+ *
+ * Schemas registered with the returned generator are converted into TypeScript
+ * type aliases and Effect Schema runtime declarations, with reusable OpenAPI
+ * component definitions supplied at generation time.
+ *
+ * @category code generation
+ * @since 4.0.0
+ */
 export function make() {
   const store = {};
   function addSchema(name, schema) {
@@ -12,64 +44,163 @@ export function make() {
     return name;
   }
   function generate(source, components, typeOnly, options) {
-    const nameMap = [];
-    const schemas = [];
-    const definitions = Rec.map(components, js => fromSchemaOpenApi(js).schema);
-    for (const [name, js] of Object.entries(store)) {
-      nameMap.push(name);
-      schemas.push(fromSchemaOpenApi(js).schema);
+    const generated = makeCodeDocument(source, components, options);
+    if (generated === undefined) {
+      return "";
     }
-    if (Arr.isArrayNonEmpty(schemas)) {
-      const multiDocument = SchemaRepresentation.fromJsonSchemaMultiDocument({
-        dialect: "draft-2020-12",
-        schemas,
-        definitions
-      }, {
-        onEnter(js) {
-          const out = {
-            ...js
-          };
-          if (out.type === "object" && out.additionalProperties === undefined) {
-            out.additionalProperties = false;
-          }
-          return options?.onEnter?.(out) ?? out;
-        }
-      });
-      const codeDocument = SchemaRepresentation.toCodeDocument(multiDocument);
-      const nonRecursives = codeDocument.references.nonRecursives.map(({
-        $ref,
-        code
-      }) => renderSchema($ref, code));
-      const recursives = Object.entries(codeDocument.references.recursives).map(([$ref, code]) => renderSchema($ref, code));
-      const codes = codeDocument.codes.map((code, i) => renderSchema(nameMap[i], code));
-      const s = render("non-recursive definitions", nonRecursives) + render("recursive definitions", recursives) + render("schemas", codes);
-      return s;
+    const nonRecursiveReferences = generated.codeDocument.references.nonRecursives;
+    const recursiveReferences = Object.entries(generated.codeDocument.references.recursives);
+    const nonRecursives = nonRecursiveReferences.map(({
+      $ref,
+      code
+    }) => renderSchemaTypeAndRuntime($ref, code, typeOnly));
+    const recursiveDeclarations = [];
+    const recursives = [];
+    if (typeOnly) {
+      for (const [$ref, code] of recursiveReferences) {
+        recursives.push(renderSchemaTypeAndRuntime($ref, code, true));
+      }
     } else {
+      const recursivelyForwardReferenced = collectForwardReferencedRecursives(nonRecursiveReferences, recursiveReferences);
+      const recursiveInternalNames = makeRecursiveInternalNameMap(recursivelyForwardReferenced, [...nonRecursiveReferences.map(({
+        $ref
+      }) => $ref), ...recursiveReferences.map(([$ref]) => $ref), ...generated.nameMap]);
+      for (const [$ref, code] of recursiveReferences) {
+        if (recursivelyForwardReferenced.has($ref)) {
+          const internalName = recursiveInternalNames.get($ref);
+          recursiveDeclarations.push(renderRecursiveReferenceDeclaration($ref, code, internalName));
+          recursives.push(`const ${internalName} = ${code.runtime}`);
+          continue;
+        }
+        recursives.push(renderSchemaTypeAndRuntime($ref, code, false));
+      }
+    }
+    const codes = generated.codeDocument.codes.map((code, i) => renderSchemaTypeAndRuntime(generated.nameMap[i], code, typeOnly));
+    return render("recursive declarations", recursiveDeclarations) + render("non-recursive definitions", nonRecursives) + render("recursive definitions", recursives) + render("schemas", codes);
+  }
+  function generateHttpApi(source, components, options) {
+    const generated = makeCodeDocument(source, components, options);
+    if (generated === undefined) {
       return "";
     }
-    function fromSchemaOpenApi(jsonSchema) {
-      switch (source) {
-        case "openapi-3.1":
-          return JsonSchema.fromSchemaOpenApi3_1(jsonSchema);
-        case "openapi-3.0":
-          return JsonSchema.fromSchemaOpenApi3_0(jsonSchema);
+    const nonRecursiveReferences = generated.codeDocument.references.nonRecursives;
+    const recursiveReferences = Object.entries(generated.codeDocument.references.recursives);
+    const nonRecursives = nonRecursiveReferences.map(({
+      $ref,
+      code
+    }) => renderSchemaTypeAndRuntime($ref, code, false, options?.multipartSchemaRefs));
+    const recursivelyForwardReferenced = collectForwardReferencedRecursives(nonRecursiveReferences, recursiveReferences);
+    const recursiveInternalNames = makeRecursiveInternalNameMap(recursivelyForwardReferenced, [...nonRecursiveReferences.map(({
+      $ref
+    }) => $ref), ...recursiveReferences.map(([$ref]) => $ref), ...generated.nameMap]);
+    const recursiveDeclarations = [];
+    const recursives = [];
+    for (const [$ref, code] of recursiveReferences) {
+      if (recursivelyForwardReferenced.has($ref)) {
+        const internalName = recursiveInternalNames.get($ref);
+        recursiveDeclarations.push(renderRecursiveReferenceDeclaration($ref, code, internalName));
+        recursives.push(`const ${internalName} = ${code.runtime}`);
+        continue;
       }
+      recursives.push(renderSchemaTypeAndRuntime($ref, code, false, options?.multipartSchemaRefs));
     }
-    function renderSchema($ref, code) {
-      const strings = [`export type ${$ref} = ${code.Type}`];
-      if (!typeOnly) {
-        strings.push(`export const ${$ref} = ${code.runtime}`);
-      }
-      return strings.join("\n");
+    const codes = generated.codeDocument.codes.map((code, i) => renderSchemaTypeAndRuntime(generated.nameMap[i], code, false, options?.multipartSchemaRefs));
+    return render("recursive declarations", recursiveDeclarations) + render("non-recursive definitions", nonRecursives) + render("recursive definitions", recursives) + render("schemas", codes);
+  }
+  function makeCodeDocument(source, components, options) {
+    const nameMap = [];
+    const schemas = [];
+    const definitions = Rec.map(components, js => fromSchemaOpenApi(source, js).schema);
+    for (const [name, js] of Object.entries(store)) {
+      nameMap.push(name);
+      schemas.push(fromSchemaOpenApi(source, js).schema);
     }
-    function render(title, as) {
-      if (as.length === 0) return "";
-      return "// " + title + "\n" + as.join("\n") + "\n";
+    if (!Arr.isArrayNonEmpty(schemas)) {
+      return;
     }
+    const multiDocument = SchemaRepresentation.fromJsonSchemaMultiDocument({
+      dialect: "draft-2020-12",
+      schemas,
+      definitions
+    }, {
+      onEnter(js) {
+        const out = {
+          ...js
+        };
+        if (out.type === "object" && out.additionalProperties === undefined) {
+          out.additionalProperties = false;
+        }
+        return options?.onEnter?.(out) ?? out;
+      }
+    });
+    return {
+      nameMap,
+      codeDocument: SchemaRepresentation.toCodeDocument(multiDocument)
+    };
   }
   return {
     addSchema,
-    generate
+    generate,
+    generateHttpApi
   };
 }
+function fromSchemaOpenApi(source, jsonSchema) {
+  switch (source) {
+    case "openapi-3.1":
+      return JsonSchema.fromSchemaOpenApi3_1(jsonSchema);
+    case "openapi-3.0":
+      return JsonSchema.fromSchemaOpenApi3_0(jsonSchema);
+  }
+}
+function renderSchemaTypeAndRuntime($ref, code, typeOnly, multipartSchemaRefs) {
+  if (!typeOnly && multipartSchemaRefs !== undefined) {
+    if ($ref === multipartSchemaRefs.singleFile) {
+      return [`export type ${$ref} = Multipart.PersistedFile`, `export const ${$ref} = Multipart.SingleFileSchema`].join("\n");
+    }
+    if ($ref === multipartSchemaRefs.files) {
+      return [`export type ${$ref} = ReadonlyArray<Multipart.PersistedFile>`, `export const ${$ref} = Multipart.FilesSchema`].join("\n");
+    }
+  }
+  const strings = [`export type ${$ref} = ${code.Type}`];
+  if (!typeOnly) {
+    strings.push(`export const ${$ref} = ${code.runtime}`);
+  }
+  return strings.join("\n");
+}
+function renderRecursiveReferenceDeclaration($ref, code, internalName) {
+  return [`export type ${$ref} = ${code.Type}`, `export const ${$ref} = Schema.suspend((): Schema.Codec<${$ref}> => ${internalName})`].join("\n");
+}
+function render(title, as) {
+  if (as.length === 0) return "";
+  return "// " + title + "\n" + as.join("\n") + "\n";
+}
+const tokenPattern = /[A-Za-z_$][A-Za-z0-9_$]*/g;
+function collectForwardReferencedRecursives(nonRecursives, recursives) {
+  const recursiveNames = new Set(recursives.map(([name]) => name));
+  const referenced = new Set();
+  for (const {
+    code
+  } of nonRecursives) {
+    for (const token of code.runtime.matchAll(tokenPattern)) {
+      const identifier = token[0];
+      if (recursiveNames.has(identifier)) {
+        referenced.add(identifier);
+      }
+    }
+  }
+  return referenced;
+}
+function makeRecursiveInternalNameMap(recursiveNames, existingNames) {
+  const usedNames = new Set(existingNames);
+  const internalNames = new Map();
+  for (const name of recursiveNames) {
+    let candidate = `__recursive_${name}`;
+    while (usedNames.has(candidate)) {
+      candidate = `_${candidate}`;
+    }
+    usedNames.add(candidate);
+    internalNames.set(name, candidate);
+  }
+  return internalNames;
+}
 //# sourceMappingURL=JsonSchemaGenerator.js.map

package/dist/JsonSchemaGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonSchemaGenerator.js","names":["Arr","JsonSchema","Rec","SchemaRepresentation","make","store","addSchema","name","schema","Error","generate","source","components","typeOnly","options","nameMap","schemas","definitions","map","js","fromSchemaOpenApi","Object","entries","push","isArrayNonEmpty","multiDocument","fromJsonSchemaMultiDocument","dialect","onEnter","out","type","additionalProperties","undefined","codeDocument","toCodeDocument","nonRecursives","references","$ref","code","renderSchema","recursives","codes","i","s","render","jsonSchema","fromSchemaOpenApi3_1","fromSchemaOpenApi3_0","strings","Type","runtime","join","title","as","length"],"sources":["../src/JsonSchemaGenerator.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAKA,GAAG,MAAM,cAAc;AACnC,OAAO,KAAKC,UAAU,MAAM,mBAAmB;AAC/C,OAAO,KAAKC,GAAG,MAAM,eAAe;AACpC,OAAO,KAAKC,oBAAoB,MAAM,6BAA6B;AAEnE,OAAM,SAAUC,IAAIA,CAAA;EAClB,MAAMC,KAAK,GAA0C,EAAE;EAEvD,SAASC,SAASA,CAACC,IAAY,EAAEC,MAA6B;IAC5D,IAAID,IAAI,IAAIF,KAAK,EAAE;MACjB,MAAM,IAAII,KAAK,CAAC,UAAUF,IAAI,iBAAiB,CAAC;IAClD;IACAF,KAAK,CAACE,IAAI,CAAC,GAAGC,MAAM;IACpB,OAAOD,IAAI;EACb;EAEA,SAASG,QAAQA,CACfC,MAAqC,EACrCC,UAAkC,EAClCC,QAAiB,EACjBC,OAEC;IAED,MAAMC,OAAO,GAAkB,EAAE;IACjC,MAAMC,OAAO,GAAiC,EAAE;IAEhD,MAAMC,WAAW,GAA2Bf,GAAG,CAACgB,GAAG,CACjDN,UAAU,EACTO,EAAE,IAAKC,iBAAiB,CAACD,EAAE,CAAC,CAACX,MAAM,CACrC;IAED,KAAK,MAAM,CAACD,IAAI,EAAEY,EAAE,CAAC,IAAIE,MAAM,CAACC,OAAO,CAACjB,KAAK,CAAC,EAAE;MAC9CU,OAAO,CAACQ,IAAI,CAAChB,IAAI,CAAC;MAClBS,OAAO,CAACO,IAAI,CAACH,iBAAiB,CAACD,EAAE,CAAC,CAACX,MAAM,CAAC;IAC5C;IAEA,IAAIR,GAAG,CAACwB,eAAe,CAACR,OAAO,CAAC,EAAE;MAChC,MAAMS,aAAa,GAAuCtB,oBAAoB,CAACuB,2BAA2B,CAAC;QACzGC,OAAO,EAAE,eAAe;QACxBX,OAAO;QACPC;OACD,EAAE;QACDW,OAAOA,CAACT,EAAE;UACR,MAAMU,GAAG,GAAG;YAAE,GAAGV;UAAE,CAAE;UACrB,IAAIU,GAAG,CAACC,IAAI,KAAK,QAAQ,IAAID,GAAG,CAACE,oBAAoB,KAAKC,SAAS,EAAE;YACnEH,GAAG,CAACE,oBAAoB,GAAG,KAAK;UAClC;UACA,OAAOjB,OAAO,EAAEc,OAAO,GAAGC,GAAG,CAAC,IAAIA,GAAG;QACvC;OACD,CAAC;MAEF,MAAMI,YAAY,GAAG9B,oBAAoB,CAAC+B,cAAc,CAACT,aAAa,CAAC;MAEvE,MAAMU,aAAa,GAAGF,YAAY,CAACG,UAAU,CAACD,aAAa,CAACjB,GAAG,CAAC,CAAC;QAAEmB,IAAI;QAAEC;MAAI,CAAE,KAAKC,YAAY,CAACF,IAAI,EAAEC,IAAI,CAAC,CAAC;MAC7G,MAAME,UAAU,GAAGnB,MAAM,CAACC,OAAO,CAACW,YAAY,CAACG,UAAU,CAACI,UAAU,CAAC,CAACtB,GAAG,CAAC,CAAC,CAACmB,IAAI,EAAEC,IAAI,CAAC,KACrFC,YAAY,CAACF,IAAI,EAAEC,IAAI,CAAC,CACzB;MACD,MAAMG,KAAK,GAAGR,YAAY,CAACQ,KAAK,CAACvB,GAAG,CAAC,CAACoB,IAAI,EAAEI,CAAC,KAAKH,YAAY,CAACxB,OAAO,CAAC2B,CAAC,CAAC,EAAEJ,IAAI,CAAC,CAAC;MAEjF,MAAMK,CAAC,GAAGC,MAAM,CAAC,2BAA2B,EAAET,aAAa,CAAC,GAC1DS,MAAM,CAAC,uBAAuB,EAAEJ,UAAU,CAAC,GAC3CI,MAAM,CAAC,SAAS,EAAEH,KAAK,CAAC;MAE1B,OAAOE,CAAC;IACV,CAAC,MAAM;MACL,OAAO,EAAE;IACX;IAEA,SAASvB,iBAAiBA,CAACyB,UAAiC;MAC1D,QAAQlC,MAAM;QACZ,KAAK,aAAa;UAChB,OAAOV,UAAU,CAAC6C,oBAAoB,CAACD,UAAU,CAAC;QACpD,KAAK,aAAa;UAChB,OAAO5C,UAAU,CAAC8C,oBAAoB,CAACF,UAAU,CAAC;MACtD;IACF;IAEA,SAASN,YAAYA,CAACF,IAAY,EAAEC,IAA+B;MACjE,MAAMU,OAAO,GAAG,CAAC,eAAeX,IAAI,MAAMC,IAAI,CAACW,IAAI,EAAE,CAAC;MACtD,IAAI,CAACpC,QAAQ,EAAE;QACbmC,OAAO,CAACzB,IAAI,CAAC,gBAAgBc,IAAI,MAAMC,IAAI,CAACY,OAAO,EAAE,CAAC;MACxD;MACA,OAAOF,OAAO,CAACG,IAAI,CAAC,IAAI,CAAC;IAC3B;IAEA,SAASP,MAAMA,CAACQ,KAAa,EAAEC,EAAyB;MACtD,IAAIA,EAAE,CAACC,MAAM,KAAK,CAAC,EAAE,OAAO,EAAE;MAC9B,OAAO,KAAK,GAAGF,KAAK,GAAG,IAAI,GAAGC,EAAE,CAACF,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI;IACpD;EACF;EAEA,OAAO;IAAE7C,SAAS;IAAEI;EAAQ,CAAW;AACzC","ignoreList":[]}
+{"version":3,"file":"JsonSchemaGenerator.js","names":["Arr","JsonSchema","Rec","SchemaRepresentation","make","store","addSchema","name","schema","Error","generate","source","components","typeOnly","options","generated","makeCodeDocument","undefined","nonRecursiveReferences","codeDocument","references","nonRecursives","recursiveReferences","Object","entries","recursives","map","$ref","code","renderSchemaTypeAndRuntime","recursiveDeclarations","push","recursivelyForwardReferenced","collectForwardReferencedRecursives","recursiveInternalNames","makeRecursiveInternalNameMap","nameMap","has","internalName","get","renderRecursiveReferenceDeclaration","runtime","codes","i","render","generateHttpApi","multipartSchemaRefs","schemas","definitions","js","fromSchemaOpenApi","isArrayNonEmpty","multiDocument","fromJsonSchemaMultiDocument","dialect","onEnter","out","type","additionalProperties","toCodeDocument","jsonSchema","fromSchemaOpenApi3_1","fromSchemaOpenApi3_0","singleFile","join","files","strings","Type","title","as","length","tokenPattern","recursiveNames","Set","referenced","token","matchAll","identifier","add","existingNames","usedNames","internalNames","Map","candidate","set"],"sources":["../src/JsonSchemaGenerator.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKA,GAAG,MAAM,cAAc;AACnC,OAAO,KAAKC,UAAU,MAAM,mBAAmB;AAC/C,OAAO,KAAKC,GAAG,MAAM,eAAe;AACpC,OAAO,KAAKC,oBAAoB,MAAM,6BAA6B;AAenE;;;;;;;;;;;;AAYA,OAAM,SAAUC,IAAIA,CAAA;EAClB,MAAMC,KAAK,GAA0C,EAAE;EAEvD,SAASC,SAASA,CAACC,IAAY,EAAEC,MAA6B;IAC5D,IAAID,IAAI,IAAIF,KAAK,EAAE;MACjB,MAAM,IAAII,KAAK,CAAC,UAAUF,IAAI,iBAAiB,CAAC;IAClD;IACAF,KAAK,CAACE,IAAI,CAAC,GAAGC,MAAM;IACpB,OAAOD,IAAI;EACb;EAEA,SAASG,QAAQA,CACfC,MAAc,EACdC,UAAkC,EAClCC,QAAiB,EACjBC,OAAyB;IAEzB,MAAMC,SAAS,GAAGC,gBAAgB,CAACL,MAAM,EAAEC,UAAU,EAAEE,OAAO,CAAC;IAC/D,IAAIC,SAAS,KAAKE,SAAS,EAAE;MAC3B,OAAO,EAAE;IACX;IAEA,MAAMC,sBAAsB,GAAGH,SAAS,CAACI,YAAY,CAACC,UAAU,CAACC,aAAa;IAC9E,MAAMC,mBAAmB,GAAGC,MAAM,CAACC,OAAO,CAACT,SAAS,CAACI,YAAY,CAACC,UAAU,CAACK,UAAU,CAAC;IAExF,MAAMJ,aAAa,GAAGH,sBAAsB,CAACQ,GAAG,CAAC,CAAC;MAAEC,IAAI;MAAEC;IAAI,CAAE,KAC9DC,0BAA0B,CAACF,IAAI,EAAEC,IAAI,EAAEf,QAAQ,CAAC,CACjD;IAED,MAAMiB,qBAAqB,GAAkB,EAAE;IAC/C,MAAML,UAAU,GAAkB,EAAE;IAEpC,IAAIZ,QAAQ,EAAE;MACZ,KAAK,MAAM,CAACc,IAAI,EAAEC,IAAI,CAAC,IAAIN,mBAAmB,EAAE;QAC9CG,UAAU,CAACM,IAAI,CAACF,0BAA0B,CAACF,IAAI,EAAEC,IAAI,EAAE,IAAI,CAAC,CAAC;MAC/D;IACF,CAAC,MAAM;MACL,MAAMI,4BAA4B,GAAGC,kCAAkC,CACrEf,sBAAsB,EACtBI,mBAAmB,CACpB;MACD,MAAMY,sBAAsB,GAAGC,4BAA4B,CACzDH,4BAA4B,EAC5B,CACE,GAAGd,sBAAsB,CAACQ,GAAG,CAAC,CAAC;QAAEC;MAAI,CAAE,KAAKA,IAAI,CAAC,EACjD,GAAGL,mBAAmB,CAACI,GAAG,CAAC,CAAC,CAACC,IAAI,CAAC,KAAKA,IAAI,CAAC,EAC5C,GAAGZ,SAAS,CAACqB,OAAO,CACrB,CACF;MAED,KAAK,MAAM,CAACT,IAAI,EAAEC,IAAI,CAAC,IAAIN,mBAAmB,EAAE;QAC9C,IAAIU,4BAA4B,CAACK,GAAG,CAACV,IAAI,CAAC,EAAE;UAC1C,MAAMW,YAAY,GAAGJ,sBAAsB,CAACK,GAAG,CAACZ,IAAI,CAAE;UACtDG,qBAAqB,CAACC,IAAI,CAACS,mCAAmC,CAACb,IAAI,EAAEC,IAAI,EAAEU,YAAY,CAAC,CAAC;UACzFb,UAAU,CAACM,IAAI,CAAC,SAASO,YAAY,MAAMV,IAAI,CAACa,OAAO,EAAE,CAAC;UAC1D;QACF;QAEAhB,UAAU,CAACM,IAAI,CAACF,0BAA0B,CAACF,IAAI,EAAEC,IAAI,EAAE,KAAK,CAAC,CAAC;MAChE;IACF;IAEA,MAAMc,KAAK,GAAG3B,SAAS,CAACI,YAAY,CAACuB,KAAK,CAAChB,GAAG,CAAC,CAACE,IAAI,EAAEe,CAAC,KACrDd,0BAA0B,CAACd,SAAS,CAACqB,OAAO,CAACO,CAAC,CAAC,EAAEf,IAAI,EAAEf,QAAQ,CAAC,CACjE;IAED,OAAO+B,MAAM,CAAC,wBAAwB,EAAEd,qBAAqB,CAAC,GAC5Dc,MAAM,CAAC,2BAA2B,EAAEvB,aAAa,CAAC,GAClDuB,MAAM,CAAC,uBAAuB,EAAEnB,UAAU,CAAC,GAC3CmB,MAAM,CAAC,SAAS,EAAEF,KAAK,CAAC;EAC5B;EAEA,SAASG,eAAeA,CACtBlC,MAAc,EACdC,UAAkC,EAClCE,OAAgC;IAEhC,MAAMC,SAAS,GAAGC,gBAAgB,CAACL,MAAM,EAAEC,UAAU,EAAEE,OAAO,CAAC;IAC/D,IAAIC,SAAS,KAAKE,SAAS,EAAE;MAC3B,OAAO,EAAE;IACX;IAEA,MAAMC,sBAAsB,GAAGH,SAAS,CAACI,YAAY,CAACC,UAAU,CAACC,aAAa;IAC9E,MAAMC,mBAAmB,GAAGC,MAAM,CAACC,OAAO,CAACT,SAAS,CAACI,YAAY,CAACC,UAAU,CAACK,UAAU,CAAC;IAExF,MAAMJ,aAAa,GAAGH,sBAAsB,CAACQ,GAAG,CAAC,CAAC;MAAEC,IAAI;MAAEC;IAAI,CAAE,KAC9DC,0BAA0B,CAACF,IAAI,EAAEC,IAAI,EAAE,KAAK,EAAEd,OAAO,EAAEgC,mBAAmB,CAAC,CAC5E;IAED,MAAMd,4BAA4B,GAAGC,kCAAkC,CAACf,sBAAsB,EAAEI,mBAAmB,CAAC;IACpH,MAAMY,sBAAsB,GAAGC,4BAA4B,CACzDH,4BAA4B,EAC5B,CACE,GAAGd,sBAAsB,CAACQ,GAAG,CAAC,CAAC;MAAEC;IAAI,CAAE,KAAKA,IAAI,CAAC,EACjD,GAAGL,mBAAmB,CAACI,GAAG,CAAC,CAAC,CAACC,IAAI,CAAC,KAAKA,IAAI,CAAC,EAC5C,GAAGZ,SAAS,CAACqB,OAAO,CACrB,CACF;IAED,MAAMN,qBAAqB,GAAkB,EAAE;IAC/C,MAAML,UAAU,GAAkB,EAAE;IAEpC,KAAK,MAAM,CAACE,IAAI,EAAEC,IAAI,CAAC,IAAIN,mBAAmB,EAAE;MAC9C,IAAIU,4BAA4B,CAACK,GAAG,CAACV,IAAI,CAAC,EAAE;QAC1C,MAAMW,YAAY,GAAGJ,sBAAsB,CAACK,GAAG,CAACZ,IAAI,CAAE;QACtDG,qBAAqB,CAACC,IAAI,CAACS,mCAAmC,CAACb,IAAI,EAAEC,IAAI,EAAEU,YAAY,CAAC,CAAC;QACzFb,UAAU,CAACM,IAAI,CAAC,SAASO,YAAY,MAAMV,IAAI,CAACa,OAAO,EAAE,CAAC;QAC1D;MACF;MAEAhB,UAAU,CAACM,IAAI,CAACF,0BAA0B,CAACF,IAAI,EAAEC,IAAI,EAAE,KAAK,EAAEd,OAAO,EAAEgC,mBAAmB,CAAC,CAAC;IAC9F;IAEA,MAAMJ,KAAK,GAAG3B,SAAS,CAACI,YAAY,CAACuB,KAAK,CAAChB,GAAG,CAAC,CAACE,IAAI,EAAEe,CAAC,KACrDd,0BAA0B,CAACd,SAAS,CAACqB,OAAO,CAACO,CAAC,CAAC,EAAEf,IAAI,EAAE,KAAK,EAAEd,OAAO,EAAEgC,mBAAmB,CAAC,CAC5F;IAED,OAAOF,MAAM,CAAC,wBAAwB,EAAEd,qBAAqB,CAAC,GAC5Dc,MAAM,CAAC,2BAA2B,EAAEvB,aAAa,CAAC,GAClDuB,MAAM,CAAC,uBAAuB,EAAEnB,UAAU,CAAC,GAC3CmB,MAAM,CAAC,SAAS,EAAEF,KAAK,CAAC;EAC5B;EAEA,SAAS1B,gBAAgBA,CACvBL,MAAc,EACdC,UAAkC,EAClCE,OAAyB;IAKzB,MAAMsB,OAAO,GAAkB,EAAE;IACjC,MAAMW,OAAO,GAAiC,EAAE;IAEhD,MAAMC,WAAW,GAA2B9C,GAAG,CAACwB,GAAG,CACjDd,UAAU,EACTqC,EAAE,IAAKC,iBAAiB,CAACvC,MAAM,EAAEsC,EAAE,CAAC,CAACzC,MAAM,CAC7C;IAED,KAAK,MAAM,CAACD,IAAI,EAAE0C,EAAE,CAAC,IAAI1B,MAAM,CAACC,OAAO,CAACnB,KAAK,CAAC,EAAE;MAC9C+B,OAAO,CAACL,IAAI,CAACxB,IAAI,CAAC;MAClBwC,OAAO,CAAChB,IAAI,CAACmB,iBAAiB,CAACvC,MAAM,EAAEsC,EAAE,CAAC,CAACzC,MAAM,CAAC;IACpD;IAEA,IAAI,CAACR,GAAG,CAACmD,eAAe,CAACJ,OAAO,CAAC,EAAE;MACjC;IACF;IAEA,MAAMK,aAAa,GAAuCjD,oBAAoB,CAACkD,2BAA2B,CAAC;MACzGC,OAAO,EAAE,eAAe;MACxBP,OAAO;MACPC;KACD,EAAE;MACDO,OAAOA,CAACN,EAAE;QACR,MAAMO,GAAG,GAAG;UAAE,GAAGP;QAAE,CAAE;QACrB,IAAIO,GAAG,CAACC,IAAI,KAAK,QAAQ,IAAID,GAAG,CAACE,oBAAoB,KAAKzC,SAAS,EAAE;UACnEuC,GAAG,CAACE,oBAAoB,GAAG,KAAK;QAClC;QACA,OAAO5C,OAAO,EAAEyC,OAAO,GAAGC,GAAG,CAAC,IAAIA,GAAG;MACvC;KACD,CAAC;IAEF,OAAO;MACLpB,OAAO;MACPjB,YAAY,EAAEhB,oBAAoB,CAACwD,cAAc,CAACP,aAAa;KAChE;EACH;EAEA,OAAO;IAAE9C,SAAS;IAAEI,QAAQ;IAAEmC;EAAe,CAAW;AAC1D;AAEA,SAASK,iBAAiBA,CAACvC,MAAc,EAAEiD,UAAiC;EAC1E,QAAQjD,MAAM;IACZ,KAAK,aAAa;MAChB,OAAOV,UAAU,CAAC4D,oBAAoB,CAACD,UAAU,CAAC;IACpD,KAAK,aAAa;MAChB,OAAO3D,UAAU,CAAC6D,oBAAoB,CAACF,UAAU,CAAC;EACtD;AACF;AAEA,SAAS/B,0BAA0BA,CACjCF,IAAY,EACZC,IAA+B,EAC/Bf,QAAiB,EACjBiC,mBAGC;EAED,IAAI,CAACjC,QAAQ,IAAIiC,mBAAmB,KAAK7B,SAAS,EAAE;IAClD,IAAIU,IAAI,KAAKmB,mBAAmB,CAACiB,UAAU,EAAE;MAC3C,OAAO,CACL,eAAepC,IAAI,4BAA4B,EAC/C,gBAAgBA,IAAI,+BAA+B,CACpD,CAACqC,IAAI,CAAC,IAAI,CAAC;IACd;IACA,IAAIrC,IAAI,KAAKmB,mBAAmB,CAACmB,KAAK,EAAE;MACtC,OAAO,CACL,eAAetC,IAAI,2CAA2C,EAC9D,gBAAgBA,IAAI,0BAA0B,CAC/C,CAACqC,IAAI,CAAC,IAAI,CAAC;IACd;EACF;EAEA,MAAME,OAAO,GAAG,CAAC,eAAevC,IAAI,MAAMC,IAAI,CAACuC,IAAI,EAAE,CAAC;EACtD,IAAI,CAACtD,QAAQ,EAAE;IACbqD,OAAO,CAACnC,IAAI,CAAC,gBAAgBJ,IAAI,MAAMC,IAAI,CAACa,OAAO,EAAE,CAAC;EACxD;EACA,OAAOyB,OAAO,CAACF,IAAI,CAAC,IAAI,CAAC;AAC3B;AAEA,SAASxB,mCAAmCA,CAC1Cb,IAAY,EACZC,IAA+B,EAC/BU,YAAoB;EAEpB,OAAO,CACL,eAAeX,IAAI,MAAMC,IAAI,CAACuC,IAAI,EAAE,EACpC,gBAAgBxC,IAAI,sCAAsCA,IAAI,QAAQW,YAAY,GAAG,CACtF,CAAC0B,IAAI,CAAC,IAAI,CAAC;AACd;AAEA,SAASpB,MAAMA,CAACwB,KAAa,EAAEC,EAAyB;EACtD,IAAIA,EAAE,CAACC,MAAM,KAAK,CAAC,EAAE,OAAO,EAAE;EAC9B,OAAO,KAAK,GAAGF,KAAK,GAAG,IAAI,GAAGC,EAAE,CAACL,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI;AACpD;AAEA,MAAMO,YAAY,GAAG,2BAA2B;AAEhD,SAAStC,kCAAkCA,CACzCZ,aAGE,EACFI,UAAuE;EAEvE,MAAM+C,cAAc,GAAG,IAAIC,GAAG,CAAChD,UAAU,CAACC,GAAG,CAAC,CAAC,CAACnB,IAAI,CAAC,KAAKA,IAAI,CAAC,CAAC;EAChE,MAAMmE,UAAU,GAAG,IAAID,GAAG,EAAU;EAEpC,KAAK,MAAM;IAAE7C;EAAI,CAAE,IAAIP,aAAa,EAAE;IACpC,KAAK,MAAMsD,KAAK,IAAI/C,IAAI,CAACa,OAAO,CAACmC,QAAQ,CAACL,YAAY,CAAC,EAAE;MACvD,MAAMM,UAAU,GAAGF,KAAK,CAAC,CAAC,CAAC;MAC3B,IAAIH,cAAc,CAACnC,GAAG,CAACwC,UAAU,CAAC,EAAE;QAClCH,UAAU,CAACI,GAAG,CAACD,UAAU,CAAC;MAC5B;IACF;EACF;EAEA,OAAOH,UAAU;AACnB;AAEA,SAASvC,4BAA4BA,CACnCqC,cAAmC,EACnCO,aAAoC;EAEpC,MAAMC,SAAS,GAAG,IAAIP,GAAG,CAACM,aAAa,CAAC;EACxC,MAAME,aAAa,GAAG,IAAIC,GAAG,EAAkB;EAE/C,KAAK,MAAM3E,IAAI,IAAIiE,cAAc,EAAE;IACjC,IAAIW,SAAS,GAAG,eAAe5E,IAAI,EAAE;IACrC,OAAOyE,SAAS,CAAC3C,GAAG,CAAC8C,SAAS,CAAC,EAAE;MAC/BA,SAAS,GAAG,IAAIA,SAAS,EAAE;IAC7B;IACAH,SAAS,CAACF,GAAG,CAACK,SAAS,CAAC;IACxBF,aAAa,CAACG,GAAG,CAAC7E,IAAI,EAAE4E,SAAS,CAAC;EACpC;EAEA,OAAOF,aAAa;AACtB","ignoreList":[]}

package/dist/OpenApiGenerator.d.ts

@@ -1,32 +1,106 @@
+/**
+ * The `OpenApiGenerator` module orchestrates converting OpenAPI and Swagger
+ * documents into generated Effect source.
+ *
+ * It normalizes Swagger 2.0 input, resolves local references, builds the
+ * parsed operation model, registers request and response schemas, applies
+ * HttpApi-specific adaptations such as multipart helpers and security metadata,
+ * emits warnings for unsupported or lossy OpenAPI features, and then delegates
+ * final rendering to the HttpClient or HttpApi code generators.
+ *
+ * @since 4.0.0
+ */
+import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
 import type * as JsonSchema from "effect/JsonSchema";
 import * as Layer from "effect/Layer";
-import * as ServiceMap from "effect/ServiceMap";
-import type { OpenAPISpec } from "effect/unstable/httpapi/OpenApi";
-declare const OpenApiGenerator_base: ServiceMap.ServiceClass<OpenApiGenerator, "OpenApiGenerator", {
+import type { OpenAPISpec, OpenAPISpecMethodName } from "effect/unstable/httpapi/OpenApi";
+declare const OpenApiGenerator_base: Context.ServiceClass<OpenApiGenerator, "OpenApiGenerator", {
     readonly generate: (spec: OpenAPISpec, options: OpenApiGenerateOptions) => Effect.Effect<string>;
 }>;
+/**
+ * Service for turning OpenAPI or Swagger specifications into generated Effect
+ * HTTP client or HttpApi source code.
+ *
+ * @category services
+ * @since 4.0.0
+ */
 export declare class OpenApiGenerator extends OpenApiGenerator_base {
 }
+/**
+ * Output targets supported by the OpenAPI generator.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type OpenApiGeneratorFormat = "httpclient" | "httpclient-type-only" | "httpapi";
+/**
+ * Stable identifiers for non-fatal OpenAPI generation warnings.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type OpenApiGeneratorWarningCode = "cookie-parameter-dropped" | "additional-tags-dropped" | "sse-operation-skipped" | "response-headers-ignored" | "optional-request-body-approximated" | "default-response-remapped" | "security-and-downgraded" | "no-body-method-request-body-skipped" | "naming-collision";
+/**
+ * Describes a non-fatal issue encountered while mapping an OpenAPI operation to
+ * generated Effect source.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface OpenApiGeneratorWarning {
+    readonly code: OpenApiGeneratorWarningCode;
+    readonly message: string;
+    readonly path?: string | undefined;
+    readonly method?: OpenAPISpecMethodName | undefined;
+    readonly operationId?: string | undefined;
+}
+/**
+ * Options that control one OpenAPI generation run.
+ *
+ * @category options
+ * @since 4.0.0
+ */
 export interface OpenApiGenerateOptions {
     /**
-     * The name to give to the generated client.
+     * The name to give to the generated output.
      */
     readonly name: string;
     /**
-     * When `true`, will **only** generate types based on the provided OpenApi
-     * specification (without corresponding schemas).
+     * The output format to generate.
      */
-    readonly typeOnly: boolean;
+    readonly format: OpenApiGeneratorFormat;
     /**
      * Hook to transform each JSON Schema node before processing.
      */
     readonly onEnter?: ((js: JsonSchema.JsonSchema) => JsonSchema.JsonSchema) | undefined;
+    /**
+     * Callback to receive non-fatal generation warnings.
+     */
+    readonly onWarning?: ((warning: OpenApiGeneratorWarning) => void) | undefined;
 }
+/**
+ * Constructs the OpenAPI generator service implementation.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
 export declare const make: Effect.Effect<{
     readonly generate: (_: OpenAPISpec, options: OpenApiGenerateOptions) => Effect.Effect<string, never, never>;
 }, never, never>;
+/**
+ * Layer providing an OpenAPI generator for Schema-backed HTTP client and HttpApi output.
+ *
+ * @category layers
+ * @since 4.0.0
+ */
 export declare const layerTransformerSchema: Layer.Layer<OpenApiGenerator>;
+/**
+ * Layer providing an OpenAPI generator for type-only HTTP client output.
+ *
+ * @category layers
+ * @since 4.0.0
+ */
 export declare const layerTransformerTs: Layer.Layer<OpenApiGenerator>;
 export {};
 //# sourceMappingURL=OpenApiGenerator.d.ts.map

package/dist/OpenApiGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenApiGenerator.d.ts","sourceRoot":"","sources":["../src/OpenApiGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAA;AACpD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAErC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,EAAE,WAAW,EAA8C,MAAM,iCAAiC,CAAA;;uBASvF,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,sBAAsB,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;;AAFpG,qBAAa,gBAAiB,SAAQ,qBAGf;CAAG;AAE1B,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;CACtF;AAaD,eAAO,MAAM,IAAI;;gBA+Nf,CAAA;AAMF,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAwC,CAAA;AAEzG,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAwC,CAAA"}
+{"version":3,"file":"OpenApiGenerator.d.ts","sourceRoot":"","sources":["../src/OpenApiGenerator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAA;AACpD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAGrC,OAAO,KAAK,EAAyB,WAAW,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;;uBAiBzF,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,sBAAsB,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;;AATpG;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAGf;CAAG;AAE1B;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,CAAA;AAEtF;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GACnC,0BAA0B,GAC1B,yBAAyB,GACzB,uBAAuB,GACvB,0BAA0B,GAC1B,oCAAoC,GACpC,2BAA2B,GAC3B,yBAAyB,GACzB,qCAAqC,GACrC,kBAAkB,CAAA;AAEtB;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAA;IAC1C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IACnD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAA;IACvC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;IACrF;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAA;CAC9E;AAkBD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;gBA4Ef,CAAA;AAy7BF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAwC,CAAA;AAEzG;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAwC,CAAA"}