Use x- prefix for read/write schema name

Author: Rycochet

src/transform/index.ts

@@ -74,23 +74,23 @@ export function transformAll(schema: any, ctx: GlobalContext): Record<string, st
           const required = new Set(Object.keys(schema.components.schemas));
 
           if (splitSchema) {
-            output.components += `  ${readonly}requestSchemas: {\n    ${transformSchemaObjMap(
+            output.components += `  ${readonly}"x-requestSchemas": {\n    ${transformSchemaObjMap(
               schema.components.schemas,
               {
                 ...ctx,
                 required,
                 requestResponse: "request",
               }
             )}\n  }\n`;
-            output.components += `  ${readonly}responseSchemas: {\n    ${transformSchemaObjMap(
+            output.components += `  ${readonly}"x-responseSchemas": {\n    ${transformSchemaObjMap(
               schema.components.schemas,
               {
                 ...ctx,
                 required,
                 requestResponse: "response",
               }
             )}\n  }\n`;
-            output.components += `  ${readonly}schemas: {\n    ${transformSchemaRefMap(
+            output.components += `  ${readonly}"schemas": {\n    ${transformSchemaRefMap(
               schema.components.schemas,
               ctx
             )}\n  }\n`;

src/transform/operation.ts

@@ -1,5 +1,5 @@
 import { GlobalContext, OperationObject, ParameterObject, PathItemObject } from "../types";
-import { comment, isRef, tsReadonly } from "../utils";
+import { comment, isRef, transformRequestResponseRef, tsReadonly } from "../utils";
 import { transformParametersArray } from "./parameters";
 import { transformRequestBodyObj } from "./request";
 import { transformResponsesObj } from "./responses";
@@ -34,7 +34,10 @@ export function transformOperationObj(operation: OperationObject, options: Trans
     const requestResponse = options.splitSchema ? "request" : undefined;
 
     if (isRef(operation.requestBody)) {
-      output += `  ${readonly}requestBody: ${transformRef(operation.requestBody.$ref, undefined, requestResponse)};\n`;
+      output += `  ${readonly}requestBody: ${transformRequestResponseRef(
+        operation.requestBody.$ref,
+        requestResponse
+      )};\n`;
     } else {
       if (operation.requestBody.description) output += comment(operation.requestBody.description);
       output += `  ${readonly}requestBody: {\n  ${transformRequestBodyObj(operation.requestBody, {

src/transform/schema.ts

@@ -1,5 +1,15 @@
 import { GlobalContext } from "../types";
-import { comment, nodeType, tsArrayOf, tsIntersectionOf, tsPartial, tsReadonly, tsTupleOf, tsUnionOf } from "../utils";
+import {
+  comment,
+  nodeType,
+  transformRequestResponseRef,
+  tsArrayOf,
+  tsIntersectionOf,
+  tsPartial,
+  tsReadonly,
+  tsTupleOf,
+  tsUnionOf,
+} from "../utils";
 
 interface TransformSchemaObjOptions extends GlobalContext {
   required: Set<string>;
@@ -52,7 +62,7 @@ export function transformSchemaRefMap(obj: Record<string, any>, options: GlobalC
 
   for (const k of Object.keys(obj)) {
     // name (with “?” if optional property)
-    output += `${readonly}"${k}": components["requestSchemas"]["${k}"] | components["responseSchemas"]["${k}"];\n`;
+    output += `${readonly}"${k}": components["x-requestSchemas"]["${k}"] | components["x-responseSchemas"]["${k}"];\n`;
   }
 
   return output.replace(/\n+$/, "\n"); // replace repeat line endings with only one
@@ -87,7 +97,8 @@ export function transformSchemaObj(node: any, options: TransformSchemaObjOptions
     // transform core type
     switch (nodeType(node)) {
       case "ref": {
-        output += transformRef(node.$ref, undefined, options.requestResponse);
+        // these were transformed at load time when remote schemas were resolved; only transform if read/write only
+        output += transformRequestResponseRef(node.$ref, options.requestResponse);
         break;
       }
       case "string":

src/utils.ts

@@ -97,17 +97,13 @@ export function swaggerVersion(definition: OpenAPI2 | OpenAPI3): 2 | 3 {
   );
 }
 
-/** Convert $ref to TS ref */
-export function transformRef(ref: string, root = "", requestResponse?: RequestResponse): string {
-  // TODO: load external file
-  const isExternalRef = !ref.startsWith("#"); // if # isn’t first character, we can assume this is a remote schema
-  if (isExternalRef) return "any";
-
-  const parts = ref.replace(/^#\//, root).split("/");
-  if (requestResponse && parts[0] === "components" && parts[1] === "schemas") {
-    parts[1] = requestResponse + "Schemas";
+/** Convert transformed $ref to TS ref if it's an internal one */
+export function transformRequestResponseRef(ref: string, requestResponse?: RequestResponse): string {
+  if (requestResponse && ref.startsWith('components["schemas"]')) {
+    return ref.replace("schemas", `x-${requestResponse}Schemas`);
   }
-  return `${parts[0]}["${parts.slice(1).join('"]["')}"]`;
+
+  return ref;
 }
 
 /** Decode $ref (https://swagger.io/docs/specification/using-ref/#escape) */

tests/schema.test.ts

@@ -52,8 +52,8 @@ describe("SchemaObject", () => {
       properties: {
         object: {
           properties: {
-            string: { $ref: "#/components/schemas/object_ref", readOnly: true },
-            number: { $ref: "#/components/schemas/object_ref", writeOnly: true },
+            string: { $ref: 'components["schemas"]["object_ref"]', readOnly: true },
+            number: { $ref: 'components["schemas"]["object_ref"]', writeOnly: true },
           },
           type: "object",
         },
@@ -81,10 +81,10 @@ describe("SchemaObject", () => {
 
     it("object (splitSchema)", () => {
       expect(transform(objReadWrite, { ...defaults, splitSchema: true, requestResponse: "request" })).toBe(
-        `{\n"object"?: {\n"string"?: components["requestSchemas"]["object_ref"]; // GET requests only\n\n};\n\n}`
+        `{\n"object"?: {\n"string"?: components["x-requestSchemas"]["object_ref"]; // GET requests only\n\n};\n\n}`
       );
       expect(transform(objReadWrite, { ...defaults, splitSchema: true, requestResponse: "response" })).toBe(
-        `{\n"object"?: {\n"number"?: components["responseSchemas"]["object_ref"]; // POST/PUT/PATCH responses only\n\n};\n\n}`
+        `{\n"object"?: {\n"number"?: components["x-responseSchemas"]["object_ref"]; // POST/PUT/PATCH responses only\n\n};\n\n}`
       );
     });