@cloudflare/cabidela 0.0.17 → 0.0.18

package/README.md

@@ -6,14 +6,14 @@
 
 
 <p align="center">
-    <em>Small, fast, eval-less, [Cloudflare Workers](https://developers.cloudflare.com/workers/) compatible, dynamic JSON Schema validator.</em>
+    <em>Small, fast, eval-less, <a href="https://developers.cloudflare.com/workers/">Cloudflare Workers</a> compatible, dynamic JSON Schema validator.</em>
 </p>
 
 <hr />
 
-# What is
+## What is
 
-Cabidela is a small, fast, eval-less, [Cloudflare Workers](https://developers.cloudflare.com/workers/) compatible, dynamic JSON Schema validator. It implements a large subset of <https://json-schema.org/draft/2020-12/json-schema-validation> that should cover most use-cases. But not all. See limitations below.
+Cabidela is a small, fast, eval-less, Cloudflare Workers compatible, dynamic JSON Schema validator. It implements a large subset of <https://json-schema.org/draft/2020-12/json-schema-validation> that should cover most use-cases. But not all. See limitations below.
 
 ## How to use
 
@@ -187,11 +187,11 @@ JSON Schema validators like Ajv tend to follow this pattern:
 2. Compile the schema.
 3. Validate one or more payloads against the (compiled) schema.
 
-All of these steps have a cost. Compiling the schema makes sense if you are going to validate multiple payloads in the same session. But in the case of a Workers applications we typically want to validate with the HTTP request, one payload at a time, and then we discard the validator.
+All of these steps have a cost. Compiling the schema makes sense if you are going to validate multiple payloads in the same session. But in the case of a Workers application we typically want to validate with the HTTP request, one payload at a time, and then we discard the validator.
 
 Cabidela skips the compilation step and validates the payload directly against the schema.
 
-In our benchmarks, Cabidela is significantly faster than Ajv on all operations if you don't reuse the validator. Even when we skip the instantiation and compilation steps from Ajv, Cabidela still performs on par or better than Ajv.
+In our benchmarks, Cabidela is significantly faster than Ajv on all operations if you don't reuse the validator. Even when we skip the instantiation and compilation steps from Ajv, Cabidela still performs relatively well.
 
 Here are some results:
 
@@ -239,7 +239,7 @@ npm run benchmark
 
 ## Current limitations
 
-Cabidela supports most of JSON Schema specification for most use-cases, we think. However it's not complete. **Currently** we do not support:
+Cabidela supports most of JSON Schema specification, and should be useful for many applications, but it's not complete. **Currently** we do not support:
 
 - Multiple (array of) types `{ "type": ["number", "string"] }`
 - Regular expressions

package/dist/index.js

@@ -87,19 +87,12 @@ var Cabidela = class {
   }
   throw(message, needle) {
     const error = `${message}${this.options.fullErrors && needle.absorvErrors !== true && needle.errors.size > 0 ? `: ${Array.from(needle.errors).join(", ")}` : ``}`;
-    throw new Error(
-      this.options.errorMessages ? needle.schema.errorMessage ?? error : error
-    );
+    throw new Error(this.options.errorMessages ? needle.schema.errorMessage ?? error : error);
   }
   parseAdditionalProperties(needle, contextAdditionalProperties, contextEvaluatedProperties) {
     let matchCount = 0;
-    const { metadata, resolvedObject } = resolvePayload(
-      needle.path,
-      needle.payload
-    );
-    const unevaluatedProperties = metadata.properties.difference(
-      contextEvaluatedProperties
-    );
+    const { metadata, resolvedObject } = resolvePayload(needle.path, needle.payload);
+    const unevaluatedProperties = metadata.properties.difference(contextEvaluatedProperties);
     if (contextAdditionalProperties === false) {
       if (unevaluatedProperties.size > 0) {
         this.throw(
@@ -167,10 +160,7 @@ var Cabidela = class {
       );
     }
     if (needle.schema.hasOwnProperty("unevaluatedProperties")) {
-      needle.evaluatedProperties = /* @__PURE__ */ new Set([
-        ...needle.evaluatedProperties,
-        ...localEvaluatedProperties
-      ]);
+      needle.evaluatedProperties = /* @__PURE__ */ new Set([...needle.evaluatedProperties, ...localEvaluatedProperties]);
       matchCount += this.parseAdditionalProperties(
         needle,
         needle.schema.unevaluatedProperties,
@@ -178,13 +168,8 @@ var Cabidela = class {
       );
     }
     if (needle.schema.hasOwnProperty("required")) {
-      if (new Set(needle.schema.required).difference(
-        needle.evaluatedProperties.union(localEvaluatedProperties)
-      ).size > 0) {
-        this.throw(
-          `required properties at '${pathToString(needle.path)}' is '${needle.schema.required}'`,
-          needle
-        );
+      if (new Set(needle.schema.required).difference(needle.evaluatedProperties.union(localEvaluatedProperties)).size > 0) {
+        this.throw(`required properties at '${pathToString(needle.path)}' is '${needle.schema.required}'`, needle);
       }
     }
     return matchCount ? true : false;
@@ -230,10 +215,7 @@ var Cabidela = class {
       return 1;
     }
     if (needle.schema.hasOwnProperty("allOf")) {
-      const conditions = needle.schema.allOf.reduce(
-        (r, c) => Object.assign(r, c),
-        {}
-      );
+      const conditions = needle.schema.allOf.reduce((r, c) => Object.assign(r, c), {});
       try {
         this.parseSubSchema({
           ...needle,
@@ -248,10 +230,7 @@ var Cabidela = class {
         return 0;
       }
     }
-    const { metadata, resolvedObject } = resolvePayload(
-      needle.path,
-      needle.payload
-    );
+    const { metadata, resolvedObject } = resolvePayload(needle.path, needle.payload);
     if (needle.schema.type === "array" && !metadata.types.has("binary") && !metadata.types.has("string")) {
       let matched = 0;
       for (let item in resolvedObject) {
@@ -265,6 +244,16 @@ var Cabidela = class {
     } else if (needle.schema.type === "object" || needle.schema.properties) {
       return this.parseObject(needle) ? 1 : 0;
     } else if (resolvedObject !== void 0) {
+      if (needle.schema.hasOwnProperty("const")) {
+        if (resolvedObject !== needle.schema.const) {
+          this.throw(
+            `const ${resolvedObject} doesn't match ${needle.schema.const} at '${pathToString(needle.path)}'`,
+            needle
+          );
+        } else {
+          if (needle.schema.type == void 0) return 1;
+        }
+      }
       if (needle.schema.hasOwnProperty("enum")) {
         if (Array.isArray(needle.schema.enum)) {
           if (!needle.schema.enum.includes(resolvedObject)) {
@@ -276,10 +265,7 @@ var Cabidela = class {
             if (needle.schema.type == void 0) return 1;
           }
         } else {
-          this.throw(
-            `enum should be an array at '${pathToString(needle.path)}'`,
-            needle
-          );
+          this.throw(`enum should be an array at '${pathToString(needle.path)}'`, needle);
         }
       }
       if (needle.schema.hasOwnProperty("type") && !metadata.types.has(needle.schema.type)) {
@@ -292,10 +278,7 @@ var Cabidela = class {
         switch (needle.schema.type) {
           case "string":
             if (needle.schema.hasOwnProperty("maxLength") && metadata.size > needle.schema.maxLength) {
-              this.throw(
-                `Length of '${pathToString(needle.path)}' must be <= ${needle.schema.maxLength}`,
-                needle
-              );
+              this.throw(`Length of '${pathToString(needle.path)}' must be <= ${needle.schema.maxLength}`, needle);
             }
             if (needle.schema.hasOwnProperty("minLength") && metadata.size < needle.schema.minLength) {
               this.throw(
@@ -307,34 +290,19 @@ var Cabidela = class {
           case "number":
           case "integer":
             if (needle.schema.hasOwnProperty("minimum") && resolvedObject < needle.schema.minimum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be >= ${needle.schema.minimum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be >= ${needle.schema.minimum}`, needle);
             }
             if (needle.schema.hasOwnProperty("exclusiveMinimum") && resolvedObject <= needle.schema.exclusiveMinimum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be > ${needle.schema.exclusiveMinimum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be > ${needle.schema.exclusiveMinimum}`, needle);
             }
             if (needle.schema.hasOwnProperty("maximum") && resolvedObject > needle.schema.maximum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be <= ${needle.schema.maximum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be <= ${needle.schema.maximum}`, needle);
             }
             if (needle.schema.hasOwnProperty("exclusiveMaximum") && resolvedObject >= needle.schema.exclusiveMaximum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be < ${needle.schema.exclusiveMaximum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be < ${needle.schema.exclusiveMaximum}`, needle);
             }
             if (needle.schema.hasOwnProperty("multipleOf") && resolvedObject % needle.schema.multipleOf !== 0) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be multiple of ${needle.schema.multipleOf}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be multiple of ${needle.schema.multipleOf}`, needle);
             }
             break;
         }

package/dist/index.mjs

@@ -61,19 +61,12 @@ var Cabidela = class {
   }
   throw(message, needle) {
     const error = `${message}${this.options.fullErrors && needle.absorvErrors !== true && needle.errors.size > 0 ? `: ${Array.from(needle.errors).join(", ")}` : ``}`;
-    throw new Error(
-      this.options.errorMessages ? needle.schema.errorMessage ?? error : error
-    );
+    throw new Error(this.options.errorMessages ? needle.schema.errorMessage ?? error : error);
   }
   parseAdditionalProperties(needle, contextAdditionalProperties, contextEvaluatedProperties) {
     let matchCount = 0;
-    const { metadata, resolvedObject } = resolvePayload(
-      needle.path,
-      needle.payload
-    );
-    const unevaluatedProperties = metadata.properties.difference(
-      contextEvaluatedProperties
-    );
+    const { metadata, resolvedObject } = resolvePayload(needle.path, needle.payload);
+    const unevaluatedProperties = metadata.properties.difference(contextEvaluatedProperties);
     if (contextAdditionalProperties === false) {
       if (unevaluatedProperties.size > 0) {
         this.throw(
@@ -141,10 +134,7 @@ var Cabidela = class {
       );
     }
     if (needle.schema.hasOwnProperty("unevaluatedProperties")) {
-      needle.evaluatedProperties = /* @__PURE__ */ new Set([
-        ...needle.evaluatedProperties,
-        ...localEvaluatedProperties
-      ]);
+      needle.evaluatedProperties = /* @__PURE__ */ new Set([...needle.evaluatedProperties, ...localEvaluatedProperties]);
       matchCount += this.parseAdditionalProperties(
         needle,
         needle.schema.unevaluatedProperties,
@@ -152,13 +142,8 @@ var Cabidela = class {
       );
     }
     if (needle.schema.hasOwnProperty("required")) {
-      if (new Set(needle.schema.required).difference(
-        needle.evaluatedProperties.union(localEvaluatedProperties)
-      ).size > 0) {
-        this.throw(
-          `required properties at '${pathToString(needle.path)}' is '${needle.schema.required}'`,
-          needle
-        );
+      if (new Set(needle.schema.required).difference(needle.evaluatedProperties.union(localEvaluatedProperties)).size > 0) {
+        this.throw(`required properties at '${pathToString(needle.path)}' is '${needle.schema.required}'`, needle);
       }
     }
     return matchCount ? true : false;
@@ -204,10 +189,7 @@ var Cabidela = class {
       return 1;
     }
     if (needle.schema.hasOwnProperty("allOf")) {
-      const conditions = needle.schema.allOf.reduce(
-        (r, c) => Object.assign(r, c),
-        {}
-      );
+      const conditions = needle.schema.allOf.reduce((r, c) => Object.assign(r, c), {});
       try {
         this.parseSubSchema({
           ...needle,
@@ -222,10 +204,7 @@ var Cabidela = class {
         return 0;
       }
     }
-    const { metadata, resolvedObject } = resolvePayload(
-      needle.path,
-      needle.payload
-    );
+    const { metadata, resolvedObject } = resolvePayload(needle.path, needle.payload);
     if (needle.schema.type === "array" && !metadata.types.has("binary") && !metadata.types.has("string")) {
       let matched = 0;
       for (let item in resolvedObject) {
@@ -239,6 +218,16 @@ var Cabidela = class {
     } else if (needle.schema.type === "object" || needle.schema.properties) {
       return this.parseObject(needle) ? 1 : 0;
     } else if (resolvedObject !== void 0) {
+      if (needle.schema.hasOwnProperty("const")) {
+        if (resolvedObject !== needle.schema.const) {
+          this.throw(
+            `const ${resolvedObject} doesn't match ${needle.schema.const} at '${pathToString(needle.path)}'`,
+            needle
+          );
+        } else {
+          if (needle.schema.type == void 0) return 1;
+        }
+      }
       if (needle.schema.hasOwnProperty("enum")) {
         if (Array.isArray(needle.schema.enum)) {
           if (!needle.schema.enum.includes(resolvedObject)) {
@@ -250,10 +239,7 @@ var Cabidela = class {
             if (needle.schema.type == void 0) return 1;
           }
         } else {
-          this.throw(
-            `enum should be an array at '${pathToString(needle.path)}'`,
-            needle
-          );
+          this.throw(`enum should be an array at '${pathToString(needle.path)}'`, needle);
         }
       }
       if (needle.schema.hasOwnProperty("type") && !metadata.types.has(needle.schema.type)) {
@@ -266,10 +252,7 @@ var Cabidela = class {
         switch (needle.schema.type) {
           case "string":
             if (needle.schema.hasOwnProperty("maxLength") && metadata.size > needle.schema.maxLength) {
-              this.throw(
-                `Length of '${pathToString(needle.path)}' must be <= ${needle.schema.maxLength}`,
-                needle
-              );
+              this.throw(`Length of '${pathToString(needle.path)}' must be <= ${needle.schema.maxLength}`, needle);
             }
             if (needle.schema.hasOwnProperty("minLength") && metadata.size < needle.schema.minLength) {
               this.throw(
@@ -281,34 +264,19 @@ var Cabidela = class {
           case "number":
           case "integer":
             if (needle.schema.hasOwnProperty("minimum") && resolvedObject < needle.schema.minimum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be >= ${needle.schema.minimum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be >= ${needle.schema.minimum}`, needle);
             }
             if (needle.schema.hasOwnProperty("exclusiveMinimum") && resolvedObject <= needle.schema.exclusiveMinimum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be > ${needle.schema.exclusiveMinimum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be > ${needle.schema.exclusiveMinimum}`, needle);
             }
             if (needle.schema.hasOwnProperty("maximum") && resolvedObject > needle.schema.maximum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be <= ${needle.schema.maximum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be <= ${needle.schema.maximum}`, needle);
             }
             if (needle.schema.hasOwnProperty("exclusiveMaximum") && resolvedObject >= needle.schema.exclusiveMaximum) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be < ${needle.schema.exclusiveMaximum}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be < ${needle.schema.exclusiveMaximum}`, needle);
             }
             if (needle.schema.hasOwnProperty("multipleOf") && resolvedObject % needle.schema.multipleOf !== 0) {
-              this.throw(
-                `'${pathToString(needle.path)}' must be multiple of ${needle.schema.multipleOf}`,
-                needle
-              );
+              this.throw(`'${pathToString(needle.path)}' must be multiple of ${needle.schema.multipleOf}`, needle);
             }
             break;
         }

package/package.json

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