@remoteoss/json-schema-form 0.4.2-beta.0 → 0.4.3-beta.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### 0.4.3-beta.0 (2023-08-09)
+
+##### Bug fixes
+
+* **conditions:** Validate a deeply nested if (e.g. checking an object with a number property) in an if property now doesn't break the form. ([#33](https://github.com/remoteoss/json-schema-form/pull/33)) ([e34cfcc](https://github.com/remoteoss/json-schema-form/commit/e34cfccaf45f1460b346f3cff0c797b3d11259e3))
+
 #### 0.4.2-beta.0 (2023-07-20)
 
 ##### Bug Fixes

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.4.2-beta.0
- Generated: Thu, 20 Jul 2023 11:13:46 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.3-beta.0
+ Generated: Wed, 09 Aug 2023 08:39:30 GMT
 
  MIT License
 
@@ -84,6 +84,69 @@ var import_omitBy = __toESM(require("lodash/omitBy"));
 var import_set = __toESM(require("lodash/set"));
 var import_yup2 = require("yup");
 
+// src/utils.js
+function convertDiskSizeFromTo(from, to) {
+  const units = ["bytes", "kb", "mb"];
+  return function convert(value) {
+    return value * Math.pow(1024, units.indexOf(from.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
+  };
+}
+function containsHTML(str = "") {
+  return /<[a-z][\s\S]*>/i.test(str);
+}
+function wrapWithSpan(html, properties = {}) {
+  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
+  return `<span ${attributes}>${html}</span>`;
+}
+function hasProperty(object2, propertyName) {
+  return Object.prototype.hasOwnProperty.call(object2, propertyName);
+}
+
+// src/checkIfConditionMatches.js
+function checkIfConditionMatches(node, formValues, formFields) {
+  return Object.keys(node.if.properties).every((name) => {
+    const currentProperty = node.if.properties[name];
+    const value = formValues[name];
+    const hasEmptyValue = typeof value === "undefined" || // NOTE: This is a "Remote API" dependency, as empty fields are sent as "null".
+    value === null;
+    const hasIfExplicit = node.if.required?.includes(name);
+    if (hasEmptyValue && !hasIfExplicit) {
+      return true;
+    }
+    if (hasProperty(currentProperty, "const")) {
+      return compareFormValueWithSchemaValue(value, currentProperty.const);
+    }
+    if (currentProperty.contains?.pattern) {
+      const formValue = value || [];
+      if (Array.isArray(formValue)) {
+        const pattern = new RegExp(currentProperty.contains.pattern);
+        return (value || []).some((item) => pattern.test(item));
+      }
+    }
+    if (currentProperty.enum) {
+      return currentProperty.enum.includes(value);
+    }
+    if (currentProperty.properties) {
+      return checkIfConditionMatches(
+        { if: currentProperty },
+        formValues[name],
+        getField(name, formFields).fields
+      );
+    }
+    const field = getField(name, formFields);
+    return validateFieldSchema(
+      {
+        options: field.options,
+        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
+        ...currentProperty,
+        inputType: field.inputType,
+        required: true
+      },
+      value
+    );
+  });
+}
+
 // src/internals/helpers.js
 var import_merge = __toESM(require("lodash/fp/merge"));
 var import_get = __toESM(require("lodash/get"));
@@ -343,24 +406,6 @@ function _composeFieldCustomClosure(defaultComposeFn) {
   };
 }
 
-// src/utils.js
-function convertDiskSizeFromTo(from, to) {
-  const units = ["bytes", "kb", "mb"];
-  return function convert(value) {
-    return value * Math.pow(1024, units.indexOf(from.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
-  };
-}
-function containsHTML(str = "") {
-  return /<[a-z][\s\S]*>/i.test(str);
-}
-function wrapWithSpan(html, properties = {}) {
-  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
-  return `<span ${attributes}>${html}</span>`;
-}
-function hasProperty(object2, propertyName) {
-  return Object.prototype.hasOwnProperty.call(object2, propertyName);
-}
-
 // src/yupSchema.js
 var import_flow = __toESM(require("lodash/flow"));
 var import_noop = __toESM(require("lodash/noop"));
@@ -675,42 +720,6 @@ function compareFormValueWithSchemaValue(formValue, schemaValue) {
   const currentPropertyValue = typeof schemaValue === "number" ? schemaValue : schemaValue || void 0;
   return String(formValue) === String(currentPropertyValue);
 }
-function checkIfConditionMatches(node, formValues, formFields) {
-  return Object.keys(node.if.properties).every((name) => {
-    const currentProperty = node.if.properties[name];
-    const value = formValues[name];
-    const hasEmptyValue = typeof value === "undefined" || // NOTE: This is a "Remote API" dependency, as empty fields are sent as "null".
-    value === null;
-    const hasIfExplicit = node.if.required?.includes(name);
-    if (hasEmptyValue && !hasIfExplicit) {
-      return true;
-    }
-    if (hasProperty(currentProperty, "const")) {
-      return compareFormValueWithSchemaValue(value, currentProperty.const);
-    }
-    if (currentProperty.contains?.pattern) {
-      const formValue = value || [];
-      if (Array.isArray(formValue)) {
-        const pattern = new RegExp(currentProperty.contains.pattern);
-        return (value || []).some((item) => pattern.test(item));
-      }
-    }
-    if (currentProperty.enum) {
-      return currentProperty.enum.includes(value);
-    }
-    const field = getField(name, formFields);
-    return validateFieldSchema(
-      {
-        options: field.options,
-        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
-        ...currentProperty,
-        inputType: field.inputType,
-        required: true
-      },
-      value
-    );
-  });
-}
 function isFieldFilled(fieldValue) {
   return Array.isArray(fieldValue) ? fieldValue.length > 0 : !!fieldValue;
 }

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.4.2-beta.0
- Generated: Thu, 20 Jul 2023 11:13:46 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.3-beta.0
+ Generated: Wed, 09 Aug 2023 08:39:30 GMT
 
  MIT License
 
@@ -48,6 +48,69 @@ import omitBy from "lodash/omitBy";
 import set from "lodash/set";
 import { lazy } from "yup";
 
+// src/utils.js
+function convertDiskSizeFromTo(from, to) {
+  const units = ["bytes", "kb", "mb"];
+  return function convert(value) {
+    return value * Math.pow(1024, units.indexOf(from.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
+  };
+}
+function containsHTML(str = "") {
+  return /<[a-z][\s\S]*>/i.test(str);
+}
+function wrapWithSpan(html, properties = {}) {
+  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
+  return `<span ${attributes}>${html}</span>`;
+}
+function hasProperty(object2, propertyName) {
+  return Object.prototype.hasOwnProperty.call(object2, propertyName);
+}
+
+// src/checkIfConditionMatches.js
+function checkIfConditionMatches(node, formValues, formFields) {
+  return Object.keys(node.if.properties).every((name) => {
+    const currentProperty = node.if.properties[name];
+    const value = formValues[name];
+    const hasEmptyValue = typeof value === "undefined" || // NOTE: This is a "Remote API" dependency, as empty fields are sent as "null".
+    value === null;
+    const hasIfExplicit = node.if.required?.includes(name);
+    if (hasEmptyValue && !hasIfExplicit) {
+      return true;
+    }
+    if (hasProperty(currentProperty, "const")) {
+      return compareFormValueWithSchemaValue(value, currentProperty.const);
+    }
+    if (currentProperty.contains?.pattern) {
+      const formValue = value || [];
+      if (Array.isArray(formValue)) {
+        const pattern = new RegExp(currentProperty.contains.pattern);
+        return (value || []).some((item) => pattern.test(item));
+      }
+    }
+    if (currentProperty.enum) {
+      return currentProperty.enum.includes(value);
+    }
+    if (currentProperty.properties) {
+      return checkIfConditionMatches(
+        { if: currentProperty },
+        formValues[name],
+        getField(name, formFields).fields
+      );
+    }
+    const field = getField(name, formFields);
+    return validateFieldSchema(
+      {
+        options: field.options,
+        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
+        ...currentProperty,
+        inputType: field.inputType,
+        required: true
+      },
+      value
+    );
+  });
+}
+
 // src/internals/helpers.js
 import merge from "lodash/fp/merge";
 import get from "lodash/get";
@@ -307,24 +370,6 @@ function _composeFieldCustomClosure(defaultComposeFn) {
   };
 }
 
-// src/utils.js
-function convertDiskSizeFromTo(from, to) {
-  const units = ["bytes", "kb", "mb"];
-  return function convert(value) {
-    return value * Math.pow(1024, units.indexOf(from.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
-  };
-}
-function containsHTML(str = "") {
-  return /<[a-z][\s\S]*>/i.test(str);
-}
-function wrapWithSpan(html, properties = {}) {
-  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
-  return `<span ${attributes}>${html}</span>`;
-}
-function hasProperty(object2, propertyName) {
-  return Object.prototype.hasOwnProperty.call(object2, propertyName);
-}
-
 // src/yupSchema.js
 import flow from "lodash/flow";
 import noop from "lodash/noop";
@@ -639,42 +684,6 @@ function compareFormValueWithSchemaValue(formValue, schemaValue) {
   const currentPropertyValue = typeof schemaValue === "number" ? schemaValue : schemaValue || void 0;
   return String(formValue) === String(currentPropertyValue);
 }
-function checkIfConditionMatches(node, formValues, formFields) {
-  return Object.keys(node.if.properties).every((name) => {
-    const currentProperty = node.if.properties[name];
-    const value = formValues[name];
-    const hasEmptyValue = typeof value === "undefined" || // NOTE: This is a "Remote API" dependency, as empty fields are sent as "null".
-    value === null;
-    const hasIfExplicit = node.if.required?.includes(name);
-    if (hasEmptyValue && !hasIfExplicit) {
-      return true;
-    }
-    if (hasProperty(currentProperty, "const")) {
-      return compareFormValueWithSchemaValue(value, currentProperty.const);
-    }
-    if (currentProperty.contains?.pattern) {
-      const formValue = value || [];
-      if (Array.isArray(formValue)) {
-        const pattern = new RegExp(currentProperty.contains.pattern);
-        return (value || []).some((item) => pattern.test(item));
-      }
-    }
-    if (currentProperty.enum) {
-      return currentProperty.enum.includes(value);
-    }
-    const field = getField(name, formFields);
-    return validateFieldSchema(
-      {
-        options: field.options,
-        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
-        ...currentProperty,
-        inputType: field.inputType,
-        required: true
-      },
-      value
-    );
-  });
-}
 function isFieldFilled(fieldValue) {
   return Array.isArray(fieldValue) ? fieldValue.length > 0 : !!fieldValue;
 }

package/dist/standalone.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.4.2-beta.0
- Generated: Thu, 20 Jul 2023 11:13:46 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.3-beta.0
+ Generated: Wed, 09 Aug 2023 08:39:30 GMT
 
  MIT License
 
@@ -11025,6 +11025,69 @@ var lazy = function lazy2(fn) {
   return new Lazy_default(fn);
 };
 
+// src/utils.js
+function convertDiskSizeFromTo(from2, to) {
+  const units = ["bytes", "kb", "mb"];
+  return function convert(value) {
+    return value * Math.pow(1024, units.indexOf(from2.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
+  };
+}
+function containsHTML(str = "") {
+  return /<[a-z][\s\S]*>/i.test(str);
+}
+function wrapWithSpan(html, properties = {}) {
+  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
+  return `<span ${attributes}>${html}</span>`;
+}
+function hasProperty(object2, propertyName) {
+  return Object.prototype.hasOwnProperty.call(object2, propertyName);
+}
+
+// src/checkIfConditionMatches.js
+function checkIfConditionMatches(node, formValues, formFields) {
+  return Object.keys(node.if.properties).every((name) => {
+    const currentProperty = node.if.properties[name];
+    const value = formValues[name];
+    const hasEmptyValue = typeof value === "undefined" || // NOTE: This is a "Remote API" dependency, as empty fields are sent as "null".
+    value === null;
+    const hasIfExplicit = node.if.required?.includes(name);
+    if (hasEmptyValue && !hasIfExplicit) {
+      return true;
+    }
+    if (hasProperty(currentProperty, "const")) {
+      return compareFormValueWithSchemaValue(value, currentProperty.const);
+    }
+    if (currentProperty.contains?.pattern) {
+      const formValue = value || [];
+      if (Array.isArray(formValue)) {
+        const pattern = new RegExp(currentProperty.contains.pattern);
+        return (value || []).some((item) => pattern.test(item));
+      }
+    }
+    if (currentProperty.enum) {
+      return currentProperty.enum.includes(value);
+    }
+    if (currentProperty.properties) {
+      return checkIfConditionMatches(
+        { if: currentProperty },
+        formValues[name],
+        getField(name, formFields).fields
+      );
+    }
+    const field = getField(name, formFields);
+    return validateFieldSchema(
+      {
+        options: field.options,
+        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
+        ...currentProperty,
+        inputType: field.inputType,
+        required: true
+      },
+      value
+    );
+  });
+}
+
 // src/internals/helpers.js
 var import_merge = __toESM(require_merge2());
 var import_get2 = __toESM(require_get());
@@ -11284,24 +11347,6 @@ function _composeFieldCustomClosure(defaultComposeFn) {
   };
 }
 
-// src/utils.js
-function convertDiskSizeFromTo(from2, to) {
-  const units = ["bytes", "kb", "mb"];
-  return function convert(value) {
-    return value * Math.pow(1024, units.indexOf(from2.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
-  };
-}
-function containsHTML(str = "") {
-  return /<[a-z][\s\S]*>/i.test(str);
-}
-function wrapWithSpan(html, properties = {}) {
-  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
-  return `<span ${attributes}>${html}</span>`;
-}
-function hasProperty(object2, propertyName) {
-  return Object.prototype.hasOwnProperty.call(object2, propertyName);
-}
-
 // src/yupSchema.js
 var import_flow = __toESM(require_flow());
 var import_noop = __toESM(require_noop());
@@ -11615,42 +11660,6 @@ function compareFormValueWithSchemaValue(formValue, schemaValue) {
   const currentPropertyValue = typeof schemaValue === "number" ? schemaValue : schemaValue || void 0;
   return String(formValue) === String(currentPropertyValue);
 }
-function checkIfConditionMatches(node, formValues, formFields) {
-  return Object.keys(node.if.properties).every((name) => {
-    const currentProperty = node.if.properties[name];
-    const value = formValues[name];
-    const hasEmptyValue = typeof value === "undefined" || // NOTE: This is a "Remote API" dependency, as empty fields are sent as "null".
-    value === null;
-    const hasIfExplicit = node.if.required?.includes(name);
-    if (hasEmptyValue && !hasIfExplicit) {
-      return true;
-    }
-    if (hasProperty(currentProperty, "const")) {
-      return compareFormValueWithSchemaValue(value, currentProperty.const);
-    }
-    if (currentProperty.contains?.pattern) {
-      const formValue = value || [];
-      if (Array.isArray(formValue)) {
-        const pattern = new RegExp(currentProperty.contains.pattern);
-        return (value || []).some((item) => pattern.test(item));
-      }
-    }
-    if (currentProperty.enum) {
-      return currentProperty.enum.includes(value);
-    }
-    const field = getField(name, formFields);
-    return validateFieldSchema(
-      {
-        options: field.options,
-        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
-        ...currentProperty,
-        inputType: field.inputType,
-        required: true
-      },
-      value
-    );
-  });
-}
 function isFieldFilled(fieldValue) {
   return Array.isArray(fieldValue) ? fieldValue.length > 0 : !!fieldValue;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "0.4.2-beta.0",
+  "version": "0.4.3-beta.0",
   "description": "Headless UI form powered by JSON Schemas",
   "author": "Remote.com <engineering@remote.com> (https://remote.com/)",
   "license": "MIT",

package/src/tests/checkIfConditionMatches.test.js

@@ -0,0 +1,51 @@
+import { checkIfConditionMatches } from '../checkIfConditionMatches';
+
+it('Empty if is always going to be true', () => {
+  expect(checkIfConditionMatches({ if: { properties: {} } })).toBe(true);
+});
+
+it('Basic if check passes with correct value', () => {
+  expect(
+    checkIfConditionMatches(
+      { if: { properties: { a: { const: 'hello' } } } },
+      {
+        a: 'hello',
+      }
+    )
+  ).toBe(true);
+});
+
+it('Basic if check fails with incorrect value', () => {
+  expect(
+    checkIfConditionMatches(
+      { if: { properties: { a: { const: 'hello' } } } },
+      {
+        a: 'goodbye',
+      }
+    )
+  ).toBe(false);
+});
+
+it('Nested properties check passes with correct value', () => {
+  expect(
+    checkIfConditionMatches(
+      { if: { properties: { parent: { properties: { child: { const: 'hello from child' } } } } } },
+      {
+        parent: { child: 'hello from child' },
+      },
+      [{ name: 'parent', fields: [] }]
+    )
+  ).toBe(true);
+});
+
+it('Nested properties check passes with correct value', () => {
+  expect(
+    checkIfConditionMatches(
+      { if: { properties: { parent: { properties: { child: { const: 'hello from child' } } } } } },
+      {
+        parent: { child: 'goodbye from child' },
+      },
+      [{ name: 'parent', fields: [] }]
+    )
+  ).toBe(false);
+});

package/src/tests/conditions.test.js

@@ -0,0 +1,58 @@
+import { createHeadlessForm } from '../createHeadlessForm';
+
+it('Should allow check of a nested property in a conditional', () => {
+  const { handleValidation } = createHeadlessForm(
+    {
+      additionalProperties: false,
+      allOf: [
+        {
+          if: {
+            properties: {
+              parent: {
+                properties: {
+                  child: {
+                    const: 'yes',
+                  },
+                },
+                required: ['child'],
+              },
+            },
+            required: ['parent'],
+          },
+          then: { required: ['parent_sibling'] },
+        },
+      ],
+      properties: {
+        parent: {
+          additionalProperties: false,
+          properties: {
+            child: {
+              oneOf: [
+                {
+                  const: 'yes',
+                },
+                { const: 'no' },
+              ],
+              type: 'string',
+            },
+          },
+          required: ['child'],
+          type: 'object',
+        },
+        parent_sibling: {
+          type: 'integer',
+        },
+      },
+      required: ['parent'],
+      type: 'object',
+    },
+    { strictInputType: false }
+  );
+  expect(handleValidation({ parent: { child: 'no' } }).formErrors).toEqual(undefined);
+  expect(handleValidation({ parent: { child: 'yes' } }).formErrors).toEqual({
+    parent_sibling: 'Required field',
+  });
+  expect(handleValidation({ parent: { child: 'yes' }, parent_sibling: 1 }).formErrors).toEqual(
+    undefined
+  );
+});