@hey-api/json-schema-ref-parser 1.2.0 → 1.2.1

package/dist/lib/__tests__/bundle.test.js

@@ -11,7 +11,17 @@ const __1 = require("..");
         const refParser = new __1.$RefParser();
         const pathOrUrlOrSchema = path_1.default.resolve("lib", "__tests__", "spec", "circular-ref-with-description.json");
         const schema = await refParser.bundle({ pathOrUrlOrSchema });
-        (0, vitest_1.expect)(schema).not.toBeUndefined();
+        (0, vitest_1.expect)(schema).toEqual({
+            schemas: {
+                Bar: {
+                    $ref: '#/schemas/Foo',
+                    description: 'ok',
+                },
+                Foo: {
+                    $ref: '#/schemas/Bar',
+                },
+            },
+        });
     });
     (0, vitest_1.it)("bundles multiple references to the same file correctly", async () => {
         const refParser = new __1.$RefParser();

package/dist/lib/__tests__/pointer.test.js

@@ -11,7 +11,6 @@ const path_1 = __importDefault(require("path"));
         const refParser = new __1.$RefParser();
         const pathOrUrlOrSchema = path_1.default.resolve("lib", "__tests__", "spec", "openapi-paths-ref.json");
         const schema = (await refParser.bundle({ pathOrUrlOrSchema }));
-        console.log(JSON.stringify(schema, null, 2));
         // The GET endpoint should have its schema defined inline
         const getSchema = schema.paths["/foo"].get.responses["200"].content["application/json"].schema;
         (0, vitest_1.expect)(getSchema.$ref).toBeUndefined();

package/dist/lib/bundle.js

@@ -470,9 +470,11 @@ function remap(parser, inventory) {
             perf.warn(`Skipping invalid inventory entry:`, entry);
             continue;
         }
-        // Keep internal refs internal
+        // Keep internal refs internal. However, if the $ref extends the resolved value
+        // (i.e. it has additional properties in addition to "$ref"), then we must
+        // preserve the original $ref rather than rewriting it to the resolved hash.
         if (!entry.external) {
-            if (entry.$ref && typeof entry.$ref === "object") {
+            if (!entry.extended && entry.$ref && typeof entry.$ref === "object") {
                 entry.$ref.$ref = entry.hash;
             }
             continue;

package/lib/__tests__/bundle.test.ts

@@ -9,7 +9,17 @@ describe("bundle", () => {
     const refParser = new $RefParser();
     const pathOrUrlOrSchema = path.resolve("lib", "__tests__", "spec", "circular-ref-with-description.json");
     const schema = await refParser.bundle({ pathOrUrlOrSchema });
-    expect(schema).not.toBeUndefined();
+    expect(schema).toEqual({
+      schemas: {
+        Bar: {
+          $ref: '#/schemas/Foo',
+          description: 'ok',
+        },
+        Foo: {
+          $ref: '#/schemas/Bar',
+        },
+      },
+    });
   });
 
   it("bundles multiple references to the same file correctly", async () => {

package/lib/__tests__/pointer.test.ts

@@ -7,7 +7,6 @@ describe("pointer", () => {
     const refParser = new $RefParser();
     const pathOrUrlOrSchema = path.resolve("lib", "__tests__", "spec", "openapi-paths-ref.json");
     const schema = (await refParser.bundle({ pathOrUrlOrSchema })) as any;
-    console.log(JSON.stringify(schema, null, 2));
 
     // The GET endpoint should have its schema defined inline
     const getSchema = schema.paths["/foo"].get.responses["200"].content["application/json"].schema;

package/lib/bundle.ts

@@ -579,9 +579,11 @@ function remap(parser: $RefParser, inventory: InventoryEntry[]) {
       continue;
     }
 
-    // Keep internal refs internal
+    // Keep internal refs internal. However, if the $ref extends the resolved value
+    // (i.e. it has additional properties in addition to "$ref"), then we must
+    // preserve the original $ref rather than rewriting it to the resolved hash.
     if (!entry.external) {
-      if (entry.$ref && typeof entry.$ref === "object") {
+      if (!entry.extended && entry.$ref && typeof entry.$ref === "object") {
         entry.$ref.$ref = entry.hash;
       }
       continue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/json-schema-ref-parser",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "homepage": "https://heyapi.dev/",
   "repository": {