Merge pull request #11 from cloudflare/dev

fixes a bug where root level $ref's weren't being resolved correctly

Author: celso

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.4] - 2025-03-24
+
+### Changed
+
+- Fixed a bug where root level $ref's were not being resolved correctly
+
 ## [0.2.3] - 2025-03-19
 
 ### Changed

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudflare/cabidela",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Cabidela is a small, fast, eval-less, Cloudflare Workers compatible, dynamic JSON Schema validator",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

src/helpers.ts

@@ -51,7 +51,8 @@ export const traverseSchema = (options: CabidelaOptions, definitions: any, obj:
             if (cb) {
               cb(merge);
             } else {
-              // root level merge
+              // root level
+              hits++;
               Object.assign(obj, merge);
               delete obj[key];
             }
@@ -61,7 +62,14 @@ export const traverseSchema = (options: CabidelaOptions, definitions: any, obj:
             const { $id, $path } = parse$ref(obj[key]);
             const { resolvedObject } = resolvePayload($path, definitions[$id]);
             if (resolvedObject) {
-              cb(resolvedObject);
+              if (cb) {
+                cb(resolvedObject);
+              } else {
+                // root level
+                hits++;
+                Object.assign(obj, resolvedObject);
+                delete obj[key];
+              }
             } else {
               throw new Error(`Could not resolve '${obj[key]}' $ref`);
             }

tests/05-id-refs.test.ts

@@ -3,7 +3,7 @@ import { FakeCabidela } from "./lib/fake-cabidela";
 import { getMetaData } from "../src/helpers";
 
 describe("ref and subschema", () => {
-  let schema:any;
+  let schema: any;
   if (process.env.AJV) {
     schema = {
       $id: "http://example.com/schemas/main",
@@ -68,6 +68,73 @@ describe("ref and subschema", () => {
   test.skipIf(process.env.AJV)("consolidated schema", () => {
     const cabidela = new FakeCabidela(schema, { subSchemas: [contactSchema] });
     const cs = cabidela.getSchema();
+    expect(cs).toStrictEqual({
+      $id: "http://example.com/schemas/main",
+      type: "object",
+      properties: {
+        name: {
+          type: "string",
+        },
+        contacts: {
+          type: "object",
+          properties: {
+            email: {
+              type: "string",
+            },
+            phone: {
+              type: "string",
+            },
+          },
+          required: ["email", "phone"],
+        },
+        address: {
+          type: "object",
+          properties: {
+            street: {
+              type: "string",
+            },
+            city: {
+              type: "string",
+            },
+            zip: {
+              type: "string",
+            },
+            country: {
+              type: "string",
+            },
+          },
+          required: ["street", "city", "zip", "country"],
+        },
+        balance: {
+          type: "object",
+          properties: {
+            currency: {
+              type: "string",
+            },
+            amount: {
+              type: "number",
+            },
+          },
+          required: ["currency", "amount"],
+        },
+      },
+      required: ["name", "contacts", "address"],
+    });
+  });
+
+  test.skipIf(process.env.AJV)("consolidated root schema", () => {
+    const cabidela = new FakeCabidela(
+      {
+        $ref: "customer#/contacts",
+      },
+      { subSchemas: [contactSchema] },
+    );
+    const cs = cabidela.getSchema();
+    expect(cs).toStrictEqual({
+      type: "object",
+      properties: { email: { type: "string" }, phone: { type: "string" } },
+      required: ["email", "phone"],
+    });
   });
 
   test.skipIf(process.env.AJV)("$defs", () => {