@cloudflare/cabidela 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.3] - 2025-03-19
+
+### Changed
+
+- Documentation typos
+
+### Added
+
+- Benchmarking tests for $merge
+
 ## [0.1.2] - 2025-03-07
 
 ### Added

package/README.md

@@ -72,7 +72,7 @@ Cabidela takes a JSON-Schema and optional configuration flags:
 - `errorMessages`: boolean - If true, the validator will use custom `errorMessage` messages from the schema. Default is false.
 - `fullErrors`: boolean - If true, the validator will be more verbose when throwing errors for complex schemas (example: anyOf, oneOf's), set to false for shorter exceptions. Default is true.
 - `useMerge`: boolean - Set to true if you want to use the `$merge` keyword. Default is false. See below for more information.
-- `subSchema`: any[] - An optional array of sub-schemas that can be used with `$id` and `$ref`. See below for more information.
+- `subSchemas`: any[] - An optional array of sub-schemas that can be used with `$id` and `$ref`. See below for more information.
 
 Returns a validation object.
 
@@ -280,6 +280,9 @@ Resolves to:
 {
   "type": "object",
   "properties": {
+    "p": {
+      "type": "string" }
+    },
     "q": {
       "type": "number"
     }
@@ -294,6 +297,8 @@ To use `$merge` set the `useMerge` flag to true when creating the instance.
 new Cabidela(schema, { useMerge: true });
 ```
 
+You can combine `$merge` with `$id` and `$ref` keywords, which get resolved first, for even more flexibility.
+
 ## Custom errors
 
 If the new instance options has the `errorMessages` flag set to true, you can use the property `errorMessage` in the schema to define custom error messages.

package/dist/index.js

@@ -27,49 +27,53 @@ module.exports = __toCommonJS(index_exports);
 // src/helpers.ts
 var parse$ref = (ref) => {
   const parts = ref.split("#");
-  const $id = parts[0];
-  const $path = parts[1].split("/").filter((part) => part !== "");
-  return { $id, $path };
+  return {
+    $id: parts[0],
+    $path: parts[1].split("/").filter((part) => part != "")
+  };
 };
 function deepMerge(target, source) {
-  const result = Array.isArray(target) && Array.isArray(source) ? target.concat(source) : { ...target, ...source };
+  const result = Array(target) && Array.isArray(source) ? target.concat(source) : { ...target, ...source };
   for (const key of Object.keys(result)) {
     result[key] = typeof target[key] == "object" && typeof source[key] == "object" ? deepMerge(target[key], source[key]) : structuredClone(result[key]);
   }
   return result;
 }
-var traverseSchema = (options, definitions, obj, cb) => {
-  let hits;
-  do {
-    hits = 0;
-    Object.keys(obj).forEach((key) => {
-      if (obj[key] !== null && typeof obj[key] === "object") {
-        traverseSchema(options, definitions, obj[key], (value) => {
-          hits++;
-          obj[key] = value;
-        });
-        if (options.useMerge && key === "$merge") {
-          const merge = deepMerge(obj[key].source, obj[key].with);
-          if (cb) {
-            cb(merge);
-          } else {
-            Object.assign(obj, merge);
-            delete obj[key];
+var traverseSchema = (options, definitions, obj) => {
+  const ts = (obj2, cb) => {
+    let hits;
+    do {
+      hits = 0;
+      for (const key of Object.keys(obj2)) {
+        if (typeof obj2[key] == "object") {
+          ts(obj2[key], (value) => {
+            obj2[key] = value;
+            hits++;
+          });
+          if (options.useMerge && key == "$merge") {
+            const merge = deepMerge(obj2[key].source, obj2[key].with);
+            if (cb) {
+              cb(merge);
+            } else {
+              Object.assign(obj2, merge);
+              delete obj2[key];
+            }
           }
-        }
-      } else {
-        if (key === "$ref") {
-          const { $id, $path } = parse$ref(obj[key]);
-          const { resolvedObject } = resolvePayload($path, definitions[$id]);
-          if (resolvedObject) {
-            cb(resolvedObject);
-          } else {
-            throw new Error(`Could not resolve '${obj[key]}' $ref`);
+        } else {
+          if (key == "$ref") {
+            const { $id, $path } = parse$ref(obj2[key]);
+            const { resolvedObject } = resolvePayload($path, definitions[$id]);
+            if (resolvedObject) {
+              cb(resolvedObject);
+            } else {
+              throw new Error(`Could not resolve '${obj2[key]}' $ref`);
+            }
           }
         }
       }
-    });
-  } while (hits > 0);
+    } while (hits > 0);
+  };
+  ts(obj);
 };
 var resolvePayload = (path, obj) => {
   let resolvedObject = path.reduce(function(prev, curr) {

package/dist/index.mjs

@@ -1,49 +1,53 @@
 // src/helpers.ts
 var parse$ref = (ref) => {
   const parts = ref.split("#");
-  const $id = parts[0];
-  const $path = parts[1].split("/").filter((part) => part !== "");
-  return { $id, $path };
+  return {
+    $id: parts[0],
+    $path: parts[1].split("/").filter((part) => part != "")
+  };
 };
 function deepMerge(target, source) {
-  const result = Array.isArray(target) && Array.isArray(source) ? target.concat(source) : { ...target, ...source };
+  const result = Array(target) && Array.isArray(source) ? target.concat(source) : { ...target, ...source };
   for (const key of Object.keys(result)) {
     result[key] = typeof target[key] == "object" && typeof source[key] == "object" ? deepMerge(target[key], source[key]) : structuredClone(result[key]);
   }
   return result;
 }
-var traverseSchema = (options, definitions, obj, cb) => {
-  let hits;
-  do {
-    hits = 0;
-    Object.keys(obj).forEach((key) => {
-      if (obj[key] !== null && typeof obj[key] === "object") {
-        traverseSchema(options, definitions, obj[key], (value) => {
-          hits++;
-          obj[key] = value;
-        });
-        if (options.useMerge && key === "$merge") {
-          const merge = deepMerge(obj[key].source, obj[key].with);
-          if (cb) {
-            cb(merge);
-          } else {
-            Object.assign(obj, merge);
-            delete obj[key];
+var traverseSchema = (options, definitions, obj) => {
+  const ts = (obj2, cb) => {
+    let hits;
+    do {
+      hits = 0;
+      for (const key of Object.keys(obj2)) {
+        if (typeof obj2[key] == "object") {
+          ts(obj2[key], (value) => {
+            obj2[key] = value;
+            hits++;
+          });
+          if (options.useMerge && key == "$merge") {
+            const merge = deepMerge(obj2[key].source, obj2[key].with);
+            if (cb) {
+              cb(merge);
+            } else {
+              Object.assign(obj2, merge);
+              delete obj2[key];
+            }
           }
-        }
-      } else {
-        if (key === "$ref") {
-          const { $id, $path } = parse$ref(obj[key]);
-          const { resolvedObject } = resolvePayload($path, definitions[$id]);
-          if (resolvedObject) {
-            cb(resolvedObject);
-          } else {
-            throw new Error(`Could not resolve '${obj[key]}' $ref`);
+        } else {
+          if (key == "$ref") {
+            const { $id, $path } = parse$ref(obj2[key]);
+            const { resolvedObject } = resolvePayload($path, definitions[$id]);
+            if (resolvedObject) {
+              cb(resolvedObject);
+            } else {
+              throw new Error(`Could not resolve '${obj2[key]}' $ref`);
+            }
           }
         }
       }
-    });
-  } while (hits > 0);
+    } while (hits > 0);
+  };
+  ts(obj);
 };
 var resolvePayload = (path, obj) => {
   let resolvedObject = path.reduce(function(prev, curr) {

package/package.json

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