Fix js-yaml $ref (#1146)

* Fix js-yaml $refs

* Add changeset

Author: drwpow

.changeset/gold-berries-kick.md

@@ -0,0 +1,5 @@
+---
+"openapi-typescript": patch
+---
+
+Fix js-yaml $refs

packages/openapi-typescript/src/utils.ts

@@ -106,15 +106,31 @@ export function comment(text: string, indentLv?: number): string {
 /** handle any valid $ref */
 export function parseRef(ref: string): { filename: string; path: string[] } {
   if (typeof ref !== "string") return { filename: ".", path: [] };
-  if (!ref.includes("#")) return { filename: ref, path: [] };
-  const [filename, path] = ref.split("#");
-  return {
-    filename: filename || ".",
-    path: path
-      .split("/") // split by special character
-      .filter((p) => !!p && p !== "properties") // remove empty parts and "properties" (gets flattened by TS)
-      .map(decodeRef), // decode encoded chars
-  };
+
+  // OpenAPI $ref
+  if (ref.includes("#/")) {
+    const [filename, pathStr] = ref.split("#");
+    const parts = pathStr.split("/");
+    const path: string[] = [];
+    for (const part of parts) {
+      if (!part || part === "properties") continue; // remove empty parts and "properties" (gets flattened by TS)
+      path.push(decodeRef(part));
+    }
+    return { filename: filename || ".", path };
+  }
+  // js-yaml $ref
+  else if (ref.includes('["')) {
+    const parts = ref.split('["');
+    const path: string[] = [];
+    for (const part of parts) {
+      const sanitized = part.replace('"]', "").trim();
+      if (!sanitized || sanitized === "properties") continue;
+      path.push(sanitized);
+    }
+    return { filename: ".", path };
+  }
+  // remote $ref
+  return { filename: ref, path: [] };
 }
 
 /** Parse TS index */

packages/openapi-typescript/test/utils.bench.ts

@@ -0,0 +1,6 @@
+import { bench } from "vitest";
+import { parseRef } from "../src/utils.js";
+
+bench("parseRef", () => {
+  parseRef("#/test/schema-object");
+});

packages/openapi-typescript/test/utils.test.ts

@@ -1,3 +1,4 @@
+import { bench } from "vitest";
 import { parseRef, tsIntersectionOf, tsUnionOf } from "../src/utils.js";
 
 describe("utils", () => {
@@ -48,11 +49,7 @@ describe("utils", () => {
       ["identity for unknown type", ["unknown"], "unknown"],
       ["unknown for no types passed", [], "unknown"],
       ["parentheses around types with union", ["4", `string | number`], "4 & (string | number)"],
-      [
-        "parentheses around types with intersection",
-        ["{ red: string }", "{ blue: string } & { green: string }"],
-        "{ red: string } & ({ blue: string } & { green: string })",
-      ],
+      ["parentheses around types with intersection", ["{ red: string }", "{ blue: string } & { green: string }"], "{ red: string } & ({ blue: string } & { green: string })"],
     ];
 
     tests.forEach(([name, input, output]) => {
@@ -64,19 +61,23 @@ describe("utils", () => {
 
   describe("parseRef", () => {
     it("basic", () => {
-        expect(parseRef("#/test/schema-object")).toStrictEqual({ filename: ".", path: [ "test", "schema-object" ] });
+      expect(parseRef("#/test/schema-object")).toStrictEqual({ filename: ".", path: ["test", "schema-object"] });
     });
 
     it("double quote", () => {
-        expect(parseRef("#/test/\"")).toStrictEqual({ filename: ".", path: [ "test", '\\\"' ] });
+      expect(parseRef('#/test/"')).toStrictEqual({ filename: ".", path: ["test", '\\"'] });
     });
 
     it("escaped double quote", () => {
-        expect(parseRef("#/test/\\\"")).toStrictEqual({ filename: ".", path: [ "test", '\\\"' ] });
+      expect(parseRef('#/test/\\"')).toStrictEqual({ filename: ".", path: ["test", '\\"'] });
     });
 
     it("tilde escapes", () => {
-        expect(parseRef("#/test/~1~0")).toStrictEqual({ filename: ".", path: [ "test", "/~" ] });
+      expect(parseRef("#/test/~1~0")).toStrictEqual({ filename: ".", path: ["test", "/~"] });
+    });
+
+    it("js-yaml $ref", () => {
+      expect(parseRef('components["schemas"]["SchemaObject"]')).toStrictEqual({ filename: ".", path: ["components", "schemas", "SchemaObject"] });
     });
   });
-});
+});