@cloudflare/cabidela 0.0.18 → 0.0.19

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.19] - 2025-02-26
+
+### Added
+
+- Added support for applying defaults with anyOf/oneOf and tests
+
+### Changed
+
+- Minor code refactoring for better readability
+
+## [0.0.18] - 2025-02-20
+
+### Added
+
+- Constant values support https://json-schema.org/understanding-json-schema/reference/const
+- CHANGELOG.md file

package/README.md

@@ -4,7 +4,6 @@
   </a>
 </div>
 
-
 <p align="center">
     <em>Small, fast, eval-less, <a href="https://developers.cloudflare.com/workers/">Cloudflare Workers</a> compatible, dynamic JSON Schema validator.</em>
 </p>
@@ -136,6 +135,51 @@ console.log(payload);
 
 ```
 
+### oneOf defaults
+
+Using `applyDefaults` with `oneOf` will one apply the default value of the sub-schema that matches the condition. For
+example, using this schema:
+
+```javascript
+  {
+    type: "object",
+    oneOf: [
+      {
+        type: "object",
+        properties: {
+          sun: {
+            type: "number",
+            default: 9000,
+          },
+          moon: {
+            type: "number",
+            default: 9000,
+          },
+        },
+        required: ["sun"],
+      },
+      {
+        type: "object",
+        properties: {
+          sun: {
+            type: "number",
+            default: 9000,
+          },
+          moon: {
+            type: "number",
+            default: 9000,
+          },
+        },
+        required: ["moon"],
+      },
+    ],
+  };
+```
+
+- The payload `{ sun: 10}` will be modified to `{ sun: 10, moon: 9000 }`.
+- The payload `{ moon: 10}` will be modified to `{ sun: 9000, moon: 10 }`.
+- The payload `{ saturn: 10}` will throw an error because no condition is met.
+
 ## 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.
@@ -160,7 +204,7 @@ const payload = {
 
 cabidela.validate(payload);
 // throws "Error: prompt required"
-```
+````
 
 ## Tests
 
@@ -236,7 +280,6 @@ We use Vitest's [bench](https://vitest.dev/api/#bench) feature to run the benchm
 npm run benchmark
 ```
 
-
 ## Current limitations
 
 Cabidela supports most of JSON Schema specification, and should be useful for many applications, but it's not complete. **Currently** we do not support:
@@ -249,4 +292,3 @@ Cabidela supports most of JSON Schema specification, and should be useful for ma
 - `$ref`, `$defs` and `$id`
 
 yet.
-

package/dist/index.d.mts

@@ -9,8 +9,10 @@ type SchemaNavigation = {
     payload: any;
     evaluatedProperties: Set<string>;
     carryProperties?: boolean;
+    deferredApplyDefaults?: boolean;
     absorvErrors?: boolean;
     errors: Set<string>;
+    defaultsCallbacks: Array<any>;
 };
 declare class Cabidela {
     schema: any;

package/dist/index.d.ts

@@ -9,8 +9,10 @@ type SchemaNavigation = {
     payload: any;
     evaluatedProperties: Set<string>;
     carryProperties?: boolean;
+    deferredApplyDefaults?: boolean;
     absorvErrors?: boolean;
     errors: Set<string>;
+    defaultsCallbacks: Array<any>;
 };
 declare class Cabidela {
     schema: any;

package/dist/index.js

@@ -37,7 +37,7 @@ var pathToString = (path) => {
 var getMetaData = (value) => {
   let size = 0;
   let types = /* @__PURE__ */ new Set([]);
-  let properties = /* @__PURE__ */ new Set([]);
+  let properties = [];
   if (value === null) {
     types.add("null");
   } else if (typeof value == "string") {
@@ -61,7 +61,7 @@ var getMetaData = (value) => {
   } else if (typeof value == "object") {
     types.add("object");
     size = Object.keys(value).length;
-    properties = new Set(Object.keys(value));
+    properties = Object.keys(value);
   }
   return { types, size, properties };
 };
@@ -92,7 +92,9 @@ var Cabidela = class {
   parseAdditionalProperties(needle, contextAdditionalProperties, contextEvaluatedProperties) {
     let matchCount = 0;
     const { metadata, resolvedObject } = resolvePayload(needle.path, needle.payload);
-    const unevaluatedProperties = metadata.properties.difference(contextEvaluatedProperties);
+    const unevaluatedProperties = new Set(
+      metadata.properties.map((r) => pathToString([...needle.path, r]))
+    ).difference(contextEvaluatedProperties);
     if (contextAdditionalProperties === false) {
       if (unevaluatedProperties.size > 0) {
         this.throw(
@@ -107,14 +109,15 @@ var Cabidela = class {
     } else {
       for (let property of unevaluatedProperties) {
         if (this.parseSubSchema({
-          path: [property],
+          path: [property.split(".").slice(-1)[0]],
           schema: contextAdditionalProperties,
           payload: resolvedObject,
           evaluatedProperties: /* @__PURE__ */ new Set(),
-          errors: /* @__PURE__ */ new Set()
+          errors: /* @__PURE__ */ new Set(),
+          defaultsCallbacks: []
         })) {
           matchCount++;
-          needle.evaluatedProperties.add(property);
+          needle.evaluatedProperties.add(pathToString([property]));
         }
       }
     }
@@ -142,12 +145,13 @@ var Cabidela = class {
     let matchCount = 0;
     if (needle.schema.hasOwnProperty("properties")) {
       for (let property in needle.schema.properties) {
-        if (this.parseSubSchema({
+        const matches = this.parseSubSchema({
           ...needle,
           path: [...needle.path, property],
           schema: needle.schema.properties[property]
-        })) {
-          localEvaluatedProperties.add(property);
+        });
+        if (matches > 0) {
+          localEvaluatedProperties.add(pathToString([...needle.path, property]));
           matchCount++;
         }
       }
@@ -168,7 +172,9 @@ var Cabidela = class {
       );
     }
     if (needle.schema.hasOwnProperty("required")) {
-      if (new Set(needle.schema.required).difference(needle.evaluatedProperties.union(localEvaluatedProperties)).size > 0) {
+      if (new Set(needle.schema.required.map((r) => pathToString([...needle.path, r]))).difference(
+        needle.evaluatedProperties.union(localEvaluatedProperties)
+      ).size > 0) {
         this.throw(`required properties at '${pathToString(needle.path)}' is '${needle.schema.required}'`, needle);
       }
     }
@@ -176,19 +182,27 @@ var Cabidela = class {
   }
   parseList(list, needle, breakCondition) {
     let rounds = 0;
+    const defaultsCallbacks = [];
     for (let option in list) {
       try {
-        rounds += this.parseSubSchema({
+        const matches = this.parseSubSchema({
           ...needle,
           schema: { type: needle.schema.type, ...list[option] },
-          carryProperties: true,
-          absorvErrors: true
+          carryProperties: false,
+          absorvErrors: true,
+          deferredApplyDefaults: true
         });
+        rounds += matches;
         if (breakCondition && breakCondition(rounds)) break;
+        defaultsCallbacks.push(...needle.defaultsCallbacks);
+        needle.defaultsCallbacks = [];
       } catch (e) {
         needle.errors.add(e.message);
+        needle.defaultsCallbacks = [];
       }
     }
+    for (const callback of defaultsCallbacks) callback();
+    needle.defaultsCallbacks = [];
     return rounds;
   }
   // Parses a JSON Schema sub-schema object - reentrant
@@ -197,9 +211,10 @@ var Cabidela = class {
       this.throw(`No schema for path '${pathToString(needle.path)}'`, needle);
     }
     if (needle.schema.hasOwnProperty("oneOf")) {
-      if (this.parseList(needle.schema.oneOf, needle) !== 1) {
+      const rounds = this.parseList(needle.schema.oneOf, needle, (r) => r !== 1);
+      if (rounds !== 1) {
         if (needle.path.length == 0) {
-          this.throw(`oneOf at '${pathToString(needle.path)}' not met`, needle);
+          this.throw(`oneOf at '${pathToString(needle.path)}' not met, ${rounds} matches`, needle);
         }
         return 0;
       }
@@ -270,7 +285,7 @@ var Cabidela = class {
       }
       if (needle.schema.hasOwnProperty("type") && !metadata.types.has(needle.schema.type)) {
         this.throw(
-          `Type mismatch of '${pathToString(needle.path)}', '${needle.schema.type}' not in ${JSON.stringify(Array.from(metadata.types))}`,
+          `Type mismatch of '${pathToString(needle.path)}', '${needle.schema.type}' not in ${Array.from(metadata.types).map((e) => `'${e}'`).join(",")}`,
           needle
         );
       }
@@ -308,27 +323,35 @@ var Cabidela = class {
         }
       }
       if (needle.carryProperties) {
-        needle.evaluatedProperties.add(needle.path[needle.path.length - 1]);
+        needle.evaluatedProperties.add(pathToString(needle.path));
       }
       return 1;
     }
     if (this.options.applyDefaults === true && needle.schema.hasOwnProperty("default")) {
-      needle.path.reduce(function(prev, curr, index) {
-        if (prev[curr] === void 0) {
-          prev[curr] = {};
-        }
-        if (index == needle.path.length - 1) {
-          prev[curr] = needle.schema.default;
-          needle.evaluatedProperties.add(needle.path[needle.path.length - 1]);
-        }
-        return prev ? prev[curr] : void 0;
-      }, needle.payload);
+      const applyDefaults = () => {
+        needle.path.reduce(function(prev, curr, index) {
+          if (prev[curr] === void 0) {
+            prev[curr] = {};
+          }
+          if (index == needle.path.length - 1) {
+            prev[curr] = needle.schema.default;
+            needle.evaluatedProperties.add(pathToString(needle.path));
+          }
+          return prev ? prev[curr] : void 0;
+        }, needle.payload);
+      };
+      if (needle.deferredApplyDefaults === true) {
+        needle.defaultsCallbacks.push(applyDefaults);
+      } else {
+        applyDefaults();
+      }
     }
     return 0;
   }
   validate(payload) {
     const needle = {
       errors: /* @__PURE__ */ new Set(),
+      defaultsCallbacks: [],
       evaluatedProperties: /* @__PURE__ */ new Set(),
       path: [],
       schema: this.schema,

package/dist/index.mjs

@@ -11,7 +11,7 @@ var pathToString = (path) => {
 var getMetaData = (value) => {
   let size = 0;
   let types = /* @__PURE__ */ new Set([]);
-  let properties = /* @__PURE__ */ new Set([]);
+  let properties = [];
   if (value === null) {
     types.add("null");
   } else if (typeof value == "string") {
@@ -35,7 +35,7 @@ var getMetaData = (value) => {
   } else if (typeof value == "object") {
     types.add("object");
     size = Object.keys(value).length;
-    properties = new Set(Object.keys(value));
+    properties = Object.keys(value);
   }
   return { types, size, properties };
 };
@@ -66,7 +66,9 @@ var Cabidela = class {
   parseAdditionalProperties(needle, contextAdditionalProperties, contextEvaluatedProperties) {
     let matchCount = 0;
     const { metadata, resolvedObject } = resolvePayload(needle.path, needle.payload);
-    const unevaluatedProperties = metadata.properties.difference(contextEvaluatedProperties);
+    const unevaluatedProperties = new Set(
+      metadata.properties.map((r) => pathToString([...needle.path, r]))
+    ).difference(contextEvaluatedProperties);
     if (contextAdditionalProperties === false) {
       if (unevaluatedProperties.size > 0) {
         this.throw(
@@ -81,14 +83,15 @@ var Cabidela = class {
     } else {
       for (let property of unevaluatedProperties) {
         if (this.parseSubSchema({
-          path: [property],
+          path: [property.split(".").slice(-1)[0]],
           schema: contextAdditionalProperties,
           payload: resolvedObject,
           evaluatedProperties: /* @__PURE__ */ new Set(),
-          errors: /* @__PURE__ */ new Set()
+          errors: /* @__PURE__ */ new Set(),
+          defaultsCallbacks: []
         })) {
           matchCount++;
-          needle.evaluatedProperties.add(property);
+          needle.evaluatedProperties.add(pathToString([property]));
         }
       }
     }
@@ -116,12 +119,13 @@ var Cabidela = class {
     let matchCount = 0;
     if (needle.schema.hasOwnProperty("properties")) {
       for (let property in needle.schema.properties) {
-        if (this.parseSubSchema({
+        const matches = this.parseSubSchema({
           ...needle,
           path: [...needle.path, property],
           schema: needle.schema.properties[property]
-        })) {
-          localEvaluatedProperties.add(property);
+        });
+        if (matches > 0) {
+          localEvaluatedProperties.add(pathToString([...needle.path, property]));
           matchCount++;
         }
       }
@@ -142,7 +146,9 @@ var Cabidela = class {
       );
     }
     if (needle.schema.hasOwnProperty("required")) {
-      if (new Set(needle.schema.required).difference(needle.evaluatedProperties.union(localEvaluatedProperties)).size > 0) {
+      if (new Set(needle.schema.required.map((r) => pathToString([...needle.path, r]))).difference(
+        needle.evaluatedProperties.union(localEvaluatedProperties)
+      ).size > 0) {
         this.throw(`required properties at '${pathToString(needle.path)}' is '${needle.schema.required}'`, needle);
       }
     }
@@ -150,19 +156,27 @@ var Cabidela = class {
   }
   parseList(list, needle, breakCondition) {
     let rounds = 0;
+    const defaultsCallbacks = [];
     for (let option in list) {
       try {
-        rounds += this.parseSubSchema({
+        const matches = this.parseSubSchema({
           ...needle,
           schema: { type: needle.schema.type, ...list[option] },
-          carryProperties: true,
-          absorvErrors: true
+          carryProperties: false,
+          absorvErrors: true,
+          deferredApplyDefaults: true
         });
+        rounds += matches;
         if (breakCondition && breakCondition(rounds)) break;
+        defaultsCallbacks.push(...needle.defaultsCallbacks);
+        needle.defaultsCallbacks = [];
       } catch (e) {
         needle.errors.add(e.message);
+        needle.defaultsCallbacks = [];
       }
     }
+    for (const callback of defaultsCallbacks) callback();
+    needle.defaultsCallbacks = [];
     return rounds;
   }
   // Parses a JSON Schema sub-schema object - reentrant
@@ -171,9 +185,10 @@ var Cabidela = class {
       this.throw(`No schema for path '${pathToString(needle.path)}'`, needle);
     }
     if (needle.schema.hasOwnProperty("oneOf")) {
-      if (this.parseList(needle.schema.oneOf, needle) !== 1) {
+      const rounds = this.parseList(needle.schema.oneOf, needle, (r) => r !== 1);
+      if (rounds !== 1) {
         if (needle.path.length == 0) {
-          this.throw(`oneOf at '${pathToString(needle.path)}' not met`, needle);
+          this.throw(`oneOf at '${pathToString(needle.path)}' not met, ${rounds} matches`, needle);
         }
         return 0;
       }
@@ -244,7 +259,7 @@ var Cabidela = class {
       }
       if (needle.schema.hasOwnProperty("type") && !metadata.types.has(needle.schema.type)) {
         this.throw(
-          `Type mismatch of '${pathToString(needle.path)}', '${needle.schema.type}' not in ${JSON.stringify(Array.from(metadata.types))}`,
+          `Type mismatch of '${pathToString(needle.path)}', '${needle.schema.type}' not in ${Array.from(metadata.types).map((e) => `'${e}'`).join(",")}`,
           needle
         );
       }
@@ -282,27 +297,35 @@ var Cabidela = class {
         }
       }
       if (needle.carryProperties) {
-        needle.evaluatedProperties.add(needle.path[needle.path.length - 1]);
+        needle.evaluatedProperties.add(pathToString(needle.path));
       }
       return 1;
     }
     if (this.options.applyDefaults === true && needle.schema.hasOwnProperty("default")) {
-      needle.path.reduce(function(prev, curr, index) {
-        if (prev[curr] === void 0) {
-          prev[curr] = {};
-        }
-        if (index == needle.path.length - 1) {
-          prev[curr] = needle.schema.default;
-          needle.evaluatedProperties.add(needle.path[needle.path.length - 1]);
-        }
-        return prev ? prev[curr] : void 0;
-      }, needle.payload);
+      const applyDefaults = () => {
+        needle.path.reduce(function(prev, curr, index) {
+          if (prev[curr] === void 0) {
+            prev[curr] = {};
+          }
+          if (index == needle.path.length - 1) {
+            prev[curr] = needle.schema.default;
+            needle.evaluatedProperties.add(pathToString(needle.path));
+          }
+          return prev ? prev[curr] : void 0;
+        }, needle.payload);
+      };
+      if (needle.deferredApplyDefaults === true) {
+        needle.defaultsCallbacks.push(applyDefaults);
+      } else {
+        applyDefaults();
+      }
     }
     return 0;
   }
   validate(payload) {
     const needle = {
       errors: /* @__PURE__ */ new Set(),
+      defaultsCallbacks: [],
       evaluatedProperties: /* @__PURE__ */ new Set(),
       path: [],
       schema: this.schema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudflare/cabidela",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "Cabidela is a small, fast, eval-less, Cloudflare Workers compatible, dynamic JSON Schema validator",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -24,7 +24,8 @@
   "files": [
     "dist",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "repository": {
     "type": "git",