fix: schemas key double quote replace (#915) (#916)

Author: liangskyli

src/load.ts

@@ -7,7 +7,7 @@ import path from "path";
 import { Readable } from "stream";
 import { request } from "undici";
 import { URL } from "url";
-import { parseRef } from "./utils.js";
+import { parseRef, replaceKeys } from "./utils.js";
 
 type PartialSchema = Record<string, any>; // not a very accurate type, but this is easier to deal with before we know we’re dealing with a valid spec
 type SchemaMap = { [url: string]: PartialSchema };
@@ -184,6 +184,9 @@ export default async function load(
     }
   }
 
+  // schemas key double quote replace
+  schemas[schemaID] = replaceKeys(schemas[schemaID]);
+
   // scan $refs, but don’t transform (load everything in parallel)
   const refPromises: Promise<any>[] = [];
   schemas[schemaID] = JSON.parse(JSON.stringify(schemas[schemaID]), (k, v) => {

src/utils.ts

@@ -266,3 +266,24 @@ export function tsUnionOf(types: Array<string | number | boolean>): string {
   if (types.length === 1) return `${types[0]}`; // don’t add parentheses around one thing
   return `(${types.join(") | (")})`;
 }
+
+export function replaceKeys(obj: Record<string, any>): Record<string, any> {
+  if (typeof obj === "object" && obj !== undefined && obj !== null) {
+    if (Array.isArray(obj)) {
+      return obj.map((item) => replaceKeys(item));
+    } else {
+      const keyValues = Object.keys(obj).map((key) => {
+        const newKey = key.replace(DOUBLE_QUOTE_RE, '\\"');
+        const newValue = obj[key];
+        if (typeof newValue === "object") {
+          return { [newKey]: replaceKeys(newValue) };
+        } else {
+          return { [newKey]: newValue };
+        }
+      });
+      return Object.assign({}, ...keyValues);
+    }
+  } else {
+    return obj;
+  }
+}

test/v3/expected/jsdoc2.additional.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  '/v1/getUser2': {
+    /** UserController.getUser2 */
+    get: operations['UserController.getUser2.DjHhjSamaD']
+  }
+}
+
+export interface components {
+  schemas: {
+    IUserWithId: (components['schemas']['Partial<Pick<IUser,"id">>'] | string) & { [key: string]: unknown }
+    'Partial<Pick<IUser,"id">>': {
+      id?: number
+    } & { [key: string]: unknown }
+    IUserWithName: {
+      name: string
+    } & { [key: string]: unknown }
+    IUser: {
+      id: number
+      name?: string
+    } & { [key: string]: unknown }
+  }
+}
+
+export interface operations {
+  /** UserController.getUser2 */
+  'UserController.getUser2.DjHhjSamaD': {
+    parameters: {
+      query: {
+        param1?: number
+        param2?: (string | components['schemas']['IUserWithId']) & { [key: string]: unknown }
+        param3?: (string | components['schemas']['IUserWithName']) & { [key: string]: unknown }
+      }
+    }
+    responses: {
+      /** Successful response */
+      200: {
+        content: {
+          'application/json': unknown
+        }
+      }
+    }
+  }
+}
+
+export interface external {}

test/v3/expected/jsdoc2.exported-type.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export type paths = {
+  '/v1/getUser2': {
+    /** UserController.getUser2 */
+    get: operations['UserController.getUser2.DjHhjSamaD']
+  }
+}
+
+export type components = {
+  schemas: {
+    IUserWithId: components['schemas']['Partial<Pick<IUser,"id">>'] | string
+    'Partial<Pick<IUser,"id">>': {
+      id?: number
+    }
+    IUserWithName: {
+      name: string
+    }
+    IUser: {
+      id: number
+      name?: string
+    }
+  }
+}
+
+export type operations = {
+  /** UserController.getUser2 */
+  'UserController.getUser2.DjHhjSamaD': {
+    parameters: {
+      query: {
+        param1?: number
+        param2?: string | components['schemas']['IUserWithId']
+        param3?: string | components['schemas']['IUserWithName']
+      }
+    }
+    responses: {
+      /** Successful response */
+      200: {
+        content: {
+          'application/json': unknown
+        }
+      }
+    }
+  }
+}
+
+export type external = {}

test/v3/expected/jsdoc2.immutable.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  readonly '/v1/getUser2': {
+    /** UserController.getUser2 */
+    readonly get: operations['UserController.getUser2.DjHhjSamaD']
+  }
+}
+
+export interface components {
+  readonly schemas: {
+    readonly IUserWithId: components['schemas']['Partial<Pick<IUser,"id">>'] | string
+    readonly 'Partial<Pick<IUser,"id">>': {
+      readonly id?: number
+    }
+    readonly IUserWithName: {
+      readonly name: string
+    }
+    readonly IUser: {
+      readonly id: number
+      readonly name?: string
+    }
+  }
+}
+
+export interface operations {
+  /** UserController.getUser2 */
+  readonly 'UserController.getUser2.DjHhjSamaD': {
+    readonly parameters: {
+      readonly query: {
+        readonly param1?: number
+        readonly param2?: string | components['schemas']['IUserWithId']
+        readonly param3?: string | components['schemas']['IUserWithName']
+      }
+    }
+    readonly responses: {
+      /** Successful response */
+      readonly 200: {
+        readonly content: {
+          readonly 'application/json': unknown
+        }
+      }
+    }
+  }
+}
+
+export interface external {}

test/v3/expected/jsdoc2.support-array-length.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  '/v1/getUser2': {
+    /** UserController.getUser2 */
+    get: operations['UserController.getUser2.DjHhjSamaD']
+  }
+}
+
+export interface components {
+  schemas: {
+    IUserWithId: components['schemas']['Partial<Pick<IUser,"id">>'] | string
+    'Partial<Pick<IUser,"id">>': {
+      id?: number
+    }
+    IUserWithName: {
+      name: string
+    }
+    IUser: {
+      id: number
+      name?: string
+    }
+  }
+}
+
+export interface operations {
+  /** UserController.getUser2 */
+  'UserController.getUser2.DjHhjSamaD': {
+    parameters: {
+      query: {
+        param1?: number
+        param2?: string | components['schemas']['IUserWithId']
+        param3?: string | components['schemas']['IUserWithName']
+      }
+    }
+    responses: {
+      /** Successful response */
+      200: {
+        content: {
+          'application/json': unknown
+        }
+      }
+    }
+  }
+}
+
+export interface external {}

test/v3/expected/jsdoc2.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  '/v1/getUser2': {
+    /** UserController.getUser2 */
+    get: operations['UserController.getUser2.DjHhjSamaD']
+  }
+}
+
+export interface components {
+  schemas: {
+    IUserWithId: components['schemas']['Partial<Pick<IUser,"id">>'] | string
+    'Partial<Pick<IUser,"id">>': {
+      id?: number
+    }
+    IUserWithName: {
+      name: string
+    }
+    IUser: {
+      id: number
+      name?: string
+    }
+  }
+}
+
+export interface operations {
+  /** UserController.getUser2 */
+  'UserController.getUser2.DjHhjSamaD': {
+    parameters: {
+      query: {
+        param1?: number
+        param2?: string | components['schemas']['IUserWithId']
+        param3?: string | components['schemas']['IUserWithName']
+      }
+    }
+    responses: {
+      /** Successful response */
+      200: {
+        content: {
+          'application/json': unknown
+        }
+      }
+    }
+  }
+}
+
+export interface external {}