feat: add ability to use in paths

Author: js2me

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "editor.defaultFormatter": "biomejs.biome",
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.biome": "explicit",
+    "source.organizeImports.biome": "explicit"
+  }
+}

package.json

@@ -46,6 +46,7 @@
     "typedoc": "typedoc"
   },
   "dependencies": {
+    "@apidevtools/swagger-parser": "12.0.0",
     "@biomejs/js-api": "3.0.0",
     "@biomejs/wasm-nodejs": "2.2.4",
     "@types/lodash": "^4.17.20",

src/code-gen-process.ts

@@ -1,3 +1,4 @@
+import SwaggerParser, { type resolve } from "@apidevtools/swagger-parser";
 import { consola } from "consola";
 import lodash from "lodash";
 import * as typescript from "typescript";
@@ -46,9 +47,12 @@ export class CodeGenProcess {
   templatesWorker: TemplatesWorker;
   schemaWalker: SchemaWalker;
   javascriptTranslator: JavascriptTranslator;
+  swaggerParser: SwaggerParser;
+  swaggerRefs: Awaited<ReturnType<typeof resolve>> | undefined | null;
 
   constructor(config: Partial<GenerateApiConfiguration["config"]>) {
     this.config = new CodeGenConfig(config);
+    this.swaggerParser = new SwaggerParser();
     this.fileSystem = new FileSystem();
     this.swaggerSchemaResolver = new SwaggerSchemaResolver(
       this.config,
@@ -58,7 +62,7 @@ export class CodeGenProcess {
       this.config,
       this.swaggerSchemaResolver,
     );
-    this.schemaComponentsMap = new SchemaComponentsMap(this.config);
+    this.schemaComponentsMap = new SchemaComponentsMap(this.config, this);
     this.typeNameFormatter = new TypeNameFormatter(this.config);
     this.templatesWorker = new TemplatesWorker(
       this.config,
@@ -75,6 +79,7 @@ export class CodeGenProcess {
     );
     this.schemaRoutes = new SchemaRoutes(
       this.config,
+      this,
       this.schemaParserFabric,
       this.schemaComponentsMap,
       this.templatesWorker,
@@ -98,6 +103,42 @@ export class CodeGenProcess {
 
     this.swaggerSchemaResolver.fixSwaggerSchema(swagger);
 
+    try {
+      this.swaggerRefs = await this.swaggerParser.resolve(
+        this.config.url || this.config.input || (this.config.spec as any),
+        {
+          continueOnError: true,
+          mutateInputSchema: true,
+          validate: {
+            schema: false,
+            spec: false,
+          },
+          resolve: {
+            external: true,
+            http: {
+              ...this.config.requestOptions,
+              headers: Object.assign(
+                {},
+                this.config.authorizationToken
+                  ? {
+                      Authorization: this.config.authorizationToken,
+                    }
+                  : {},
+                this.config.requestOptions?.headers ?? {},
+              ),
+            },
+          },
+        },
+      );
+      this.swaggerRefs.set("fixed-swagger-schema", swagger.usageSchema as any);
+      this.swaggerRefs.set(
+        "original-swagger-schema",
+        swagger.originalSchema as any,
+      );
+    } catch (e) {
+      consola.error(e);
+    }
+
     this.config.update({
       swaggerSchema: swagger.usageSchema,
       originalSchema: swagger.originalSchema,

src/configuration.ts

@@ -13,6 +13,7 @@ import type { MonoSchemaParser } from "./schema-parser/mono-schema-parser.js";
 import type { SchemaParser } from "./schema-parser/schema-parser.js";
 import type { Translator } from "./translators/translator.js";
 import { objectAssign } from "./util/object-assign.js";
+import SwaggerParser from "@apidevtools/swagger-parser";
 
 const TsKeyword = {
   Number: "number",
@@ -167,7 +168,7 @@ export class CodeGenConfig {
   spec: OpenAPI.Document | null = null;
   fileName = "Api.ts";
   authorizationToken: string | undefined;
-  requestOptions = null;
+  requestOptions: Record<string, any> | null = null;
 
   jsPrimitiveTypes: string[] = [];
   jsEmptyTypes: string[] = [];

src/schema-components-map.ts

@@ -1,11 +1,16 @@
+import consola from "consola";
 import type { SchemaComponent } from "../types/index.js";
+import type { CodeGenProcess } from "./code-gen-process.js";
 import type { CodeGenConfig } from "./configuration.js";
 
 export class SchemaComponentsMap {
   _data: SchemaComponent[] = [];
   config: CodeGenConfig;
 
-  constructor(config: CodeGenConfig) {
+  constructor(
+    config: CodeGenConfig,
+    private codegenProcess: CodeGenProcess,
+  ) {
     this.config = config;
   }
 
@@ -66,7 +71,20 @@ export class SchemaComponentsMap {
   }
 
   get = ($ref: string) => {
-    return this._data.find((c) => c.$ref === $ref) || null;
+    const localFound = this._data.find((c) => c.$ref === $ref) || null;
+
+    if (localFound != null) {
+      return localFound;
+    }
+
+    if (this.codegenProcess.swaggerRefs) {
+      try {
+        return this.codegenProcess.swaggerRefs.get($ref) as Record<string, any>;
+      } catch (e) {
+        consola.error(e);
+        return null;
+      }
+    }
   };
 
   // Ensure enums are at the top of components list

src/schema-routes/schema-routes.ts

@@ -4,6 +4,7 @@ import type {
   GenerateApiConfiguration,
   ParsedRoute,
 } from "../../types/index.js";
+import type { CodeGenProcess } from "../code-gen-process.js";
 import type { CodeGenConfig } from "../configuration.js";
 import {
   DEFAULT_BODY_ARG_NAME,
@@ -32,6 +33,7 @@ const CONTENT_KIND = {
 
 export class SchemaRoutes {
   config: CodeGenConfig;
+  codegenProcess: CodeGenProcess;
   schemaParserFabric: SchemaParserFabric;
   schemaUtils: SchemaUtils;
   typeNameFormatter: TypeNameFormatter;
@@ -47,12 +49,14 @@ export class SchemaRoutes {
 
   constructor(
     config: CodeGenConfig,
+    codegenProcess: CodeGenProcess,
     schemaParserFabric: SchemaParserFabric,
     schemaComponentsMap: SchemaComponentsMap,
     templatesWorker: TemplatesWorker,
     typeNameFormatter: TypeNameFormatter,
   ) {
     this.config = config;
+    this.codegenProcess = codegenProcess;
     this.schemaParserFabric = schemaParserFabric;
     this.schemaUtils = this.schemaParserFabric.schemaUtils;
     this.typeNameFormatter = typeNameFormatter;
@@ -71,10 +75,21 @@ export class SchemaRoutes {
     return lodash.reduce(
       routeInfoByMethodsMap,
       (acc, requestInfo, method) => {
-        if (
-          method.startsWith("x-") ||
-          ["parameters", "$ref"].includes(method)
-        ) {
+        if (method.startsWith("x-") || ["parameters"].includes(method)) {
+          return acc;
+        }
+
+        if (method === "$ref") {
+          if (this.codegenProcess.swaggerRefs) {
+            try {
+              const resolved = this.codegenProcess.swaggerRefs.get(requestInfo);
+              Object.assign(acc, this.createRequestsMap(resolved));
+              return acc;
+            } catch (e) {
+              consola.error(e);
+              return acc;
+            }
+          }
           return acc;
         }
 
@@ -209,7 +224,11 @@ export class SchemaRoutes {
 
       let routeParam = null;
 
-      if (refTypeInfo?.rawTypeData.in && refTypeInfo.rawTypeData) {
+      if (
+        !!refTypeInfo?.rawTypeData &&
+        typeof refTypeInfo === "object" &&
+        refTypeInfo?.rawTypeData.in
+      ) {
         if (!routeParams[refTypeInfo.rawTypeData.in]) {
           routeParams[refTypeInfo.rawTypeData.in] = [];
         }