Merge pull request #2 from cloudflare/celso/oneOf-fix

oneOf defaults support

Author: celso

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.
-

demo/app/editor.tsx

@@ -10,16 +10,15 @@ const codeValidators: any = {
 };
 
 export const Editor = (props: any = {}) => {
-  useEffect(() => {
-  }, []);
+  useEffect(() => {}, []);
 
   return (
     <>
       <div className={`code overflow-auto`}>
         <ReactEditor
           value={props.content || ""}
           onValueChange={(code) => {
-            props.setContent(code);
+            props.setContent && props.setContent(code);
           }}
           highlight={(code) => {
             return props.validation && languages[props.validation]

demo/app/index.tsx

@@ -1,7 +1,7 @@
 import "~/common/styles/index.scss";
 import React, { useContext, useEffect, useState } from "react";
 import ReactDOM from "react-dom/client";
-import { Cabidela } from "@cloudflare/cabidela";
+import { Cabidela } from "../..";
 import { Editor } from "./editor";
 import { isJSON } from "./tools";
 import { payloadExamples } from "./payloads";
@@ -14,6 +14,8 @@ const Validator = () => {
     select: 0,
   }) as any;
 
+  const [modified, setModified] = useState(false);
+
   const [error, setError] = useState([] as Array<string>);
 
   useEffect(() => {
@@ -24,10 +26,18 @@ const Validator = () => {
     if (!isJSON(forms.payload)) {
       errors.push("Payload is not valid JSON");
     }
+    let payload;
     try {
-      const cabidela = new Cabidela(JSON5.parse(forms.schema));
-      cabidela.validate(JSON5.parse(forms.payload));
+      payload = JSON5.parse(forms.payload);
+      const cabidela = new Cabidela(JSON5.parse(forms.schema), { applyDefaults: true });
+      cabidela.validate(payload);
+      if (JSON.stringify(payload) !== JSON.stringify(JSON5.parse(forms.payload))) {
+        setModified(payload);
+      } else {
+        setModified(false);
+      }
     } catch (e: any) {
+      setModified(false);
       errors.push(e.message);
     }
     setError(errors);
@@ -95,7 +105,6 @@ const Validator = () => {
                 validation="json"
                 content={forms.schema}
                 setContent={(c: string) => {
-                  console.log("setting schema");
                   setForms({ ...forms, schema: c });
                 }}
               />
@@ -108,11 +117,20 @@ const Validator = () => {
                 validation="json"
                 content={forms.payload}
                 setContent={(c: string) => {
-                  console.log("setting schema");
                   setForms({ ...forms, payload: c });
                 }}
               />
             </label>
+            {modified && (
+              <label>
+                <span>Modified payload</span>
+                <Editor
+                  validation="json"
+                  content={JSON5.stringify(modified, { replacer: null, space: 2, quote: '"' })}
+                  setContent={false}
+                />
+              </label>
+            )}
           </div>
         </div>
 
@@ -132,8 +150,6 @@ const Validator = () => {
             <a href="https://github.com/cloudflare/cabidela">https://github.com/cloudflare/cabidela</a>
           </p>
         </div>
-
-
       </div>
     </>
   );

demo/app/payloads.ts

@@ -22,7 +22,7 @@ export const payloadExamples = [
         { type: "number", multipleOf: 3 },
       ],
     },
-    payload: 5
+    payload: 5,
   },
   {
     title: "Two required properties",
@@ -134,4 +134,42 @@ export const payloadExamples = [
       prompt: "this doesn't make sense",
     },
   },
+  {
+    title: "oneOf defaults",
+    schema: {
+      type: "object",
+      oneOf: [
+        {
+          properties: {
+            sun: {
+              type: "number",
+            },
+            moon: {
+              type: "number",
+              default: 9000,
+            },
+            flowers: {
+              type: "number",
+              default: 9000,
+            },
+          },
+          required: ["sun"],
+        },
+        {
+          properties: {
+            sun: {
+              type: "number",
+              default: 9000,
+            },
+            moon: {
+              type: "number",
+              default: 9000,
+            },
+          },
+          required: ["moon"],
+        },
+      ],
+    },
+    payload: { sun: 10 },
+  },
 ];

demo/package.json

@@ -16,7 +16,6 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@cloudflare/cabidela": "^0.0.17",
     "@headlessui/tailwindcss": "^0.2.1",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.1.0",

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",

src/helpers.ts

@@ -1,7 +1,7 @@
 export type metaData = {
   types: Set<string>;
   size: number;
-  properties: Set<string>;
+  properties: Array<string>;
 };
 
 export type resolvedResponse = {
@@ -56,8 +56,8 @@ export const pathToString = (path: Array<string | number>) => {
 
 export const getMetaData = (value: any): metaData => {
   let size = 0;
-  let types = new Set([]);
-  let properties = new Set([]);
+  let types:any = new Set([]);
+  let properties:any = [];
   if (value === null) {
     types.add("null");
   } else if (typeof value == "string") {
@@ -81,7 +81,7 @@ export const getMetaData = (value: any): metaData => {
   } 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 };
 };