@remoteoss/json-schema-form 0.11.3-dev.20240816092154 → 0.11.4-beta.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+#### 0.11.4-beta.0 (2024-08-20)
+
+##### Bug Fixes
+
+* **file:**  Validate the value is an instance of File ([#87](https://github.com/remoteoss/json-schema-form/pull/87)) ([8361df0d](https://github.com/remoteoss/json-schema-form/commit/8361df0d4e9f7d83342cdc91c41efb493e391307))
+
+##### Chores
+
+* **tests:**  Move code in global test scope to inside beforeAll ([#90](https://github.com/remoteoss/json-schema-form/pull/90)) ([88f7d3c9](https://github.com/remoteoss/json-schema-form/commit/88f7d3c95330c828fc2539962b878c43b61ca8a0))
+
+#### 0.11.3-beta.0 (2024-08-19)
+
+##### Bug Fixes
+
+* **select/radio:**  Add support for options with boolean type ([#89](https://github.com/remoteoss/json-schema-form/pull/89)) ([127f70b3](https://github.com/remoteoss/json-schema-form/commit/127f70b3b19974a404e710548b83d4e4b17e1339))
+
 #### 0.11.2-beta.0 (2024-07-30)
 
 ##### Bug Fixes

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.11.3-dev.20240816092154
- Generated: Fri, 16 Aug 2024 09:22:10 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.4-beta.0
+ Generated: Tue, 20 Aug 2024 17:17:21 GMT
 
  MIT License
 
@@ -534,13 +534,13 @@ var yupSchemas = {
       return value === null ? void 0 : value;
     }).test(
       "matchesOptionOrPattern",
-      ({ value }) => {
-        return `The option ${JSON.stringify(value)} is not valid.`;
+      ({ originalValue }) => {
+        return `The option ${JSON.stringify(originalValue)} is not valid.`;
       },
-      (value) => {
-        if (value !== void 0 && typeof value !== "boolean")
+      (castValue, { originalValue }) => {
+        if (typeof originalValue !== "boolean" && castValue !== void 0)
           return false;
-        return validateRadioOrSelectOptions(value, options);
+        return validateRadioOrSelectOptions(castValue, options);
       }
     );
   },
@@ -668,18 +668,24 @@ function buildYupSchema(field, config, logic) {
       () => errorMessage.pattern ?? errorMessageFromConfig.pattern ?? `Must have a valid format. E.g. ${randomPlaceholder}`
     );
   }
+  function isFile(files) {
+    return Array.isArray(files) ? files.every((file) => file instanceof File) : files instanceof File;
+  }
+  function withFile(yupSchema) {
+    return yupSchema.test("isValidFile", "Not a valid file.", isFile);
+  }
   function withMaxFileSize(yupSchema) {
     return yupSchema.test(
       "isValidFileSize",
       errorMessage.maxFileSize ?? errorMessageFromConfig.maxFileSize ?? `File size too large. The limit is ${convertKbBytesToMB(propertyFields.maxFileSize)} MB.`,
-      (files) => !files?.some((file) => convertBytesToKB(file.size) > propertyFields.maxFileSize)
+      (files) => isFile(files) && !files?.some((file) => convertBytesToKB(file.size) > propertyFields.maxFileSize)
     );
   }
   function withFileFormat(yupSchema) {
     return yupSchema.test(
       "isSupportedFormat",
       errorMessage.accept ?? errorMessageFromConfig.accept ?? `Unsupported file format. The acceptable formats are ${propertyFields.accept}.`,
-      (files) => files && files?.length > 0 ? files.some((file) => {
+      (files) => isFile(files) && files.length > 0 ? files.some((file) => {
         const fileType = file.name.split(".").pop();
         return propertyFields.accept.includes(fileType.toLowerCase());
       }) : true
@@ -734,6 +740,8 @@ function buildYupSchema(field, config, logic) {
     validators[0] = () => withBaseSchema().of(buildGroupArraySchema());
   } else if (inputType === supportedTypes.FIELDSET) {
     validators[0] = () => withBaseSchema().shape(buildFieldSetSchema(propertyFields.fields));
+  } else if (inputType === supportedTypes.FILE) {
+    validators.push(withFile);
   }
   if (propertyFields.required) {
     validators.push(withRequired);

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.11.3-dev.20240816092154
- Generated: Fri, 16 Aug 2024 09:22:10 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.4-beta.0
+ Generated: Tue, 20 Aug 2024 17:17:21 GMT
 
  MIT License
 
@@ -497,13 +497,13 @@ var yupSchemas = {
       return value === null ? void 0 : value;
     }).test(
       "matchesOptionOrPattern",
-      ({ value }) => {
-        return `The option ${JSON.stringify(value)} is not valid.`;
+      ({ originalValue }) => {
+        return `The option ${JSON.stringify(originalValue)} is not valid.`;
       },
-      (value) => {
-        if (value !== void 0 && typeof value !== "boolean")
+      (castValue, { originalValue }) => {
+        if (typeof originalValue !== "boolean" && castValue !== void 0)
           return false;
-        return validateRadioOrSelectOptions(value, options);
+        return validateRadioOrSelectOptions(castValue, options);
       }
     );
   },
@@ -631,18 +631,24 @@ function buildYupSchema(field, config, logic) {
       () => errorMessage.pattern ?? errorMessageFromConfig.pattern ?? `Must have a valid format. E.g. ${randomPlaceholder}`
     );
   }
+  function isFile(files) {
+    return Array.isArray(files) ? files.every((file) => file instanceof File) : files instanceof File;
+  }
+  function withFile(yupSchema) {
+    return yupSchema.test("isValidFile", "Not a valid file.", isFile);
+  }
   function withMaxFileSize(yupSchema) {
     return yupSchema.test(
       "isValidFileSize",
       errorMessage.maxFileSize ?? errorMessageFromConfig.maxFileSize ?? `File size too large. The limit is ${convertKbBytesToMB(propertyFields.maxFileSize)} MB.`,
-      (files) => !files?.some((file) => convertBytesToKB(file.size) > propertyFields.maxFileSize)
+      (files) => isFile(files) && !files?.some((file) => convertBytesToKB(file.size) > propertyFields.maxFileSize)
     );
   }
   function withFileFormat(yupSchema) {
     return yupSchema.test(
       "isSupportedFormat",
       errorMessage.accept ?? errorMessageFromConfig.accept ?? `Unsupported file format. The acceptable formats are ${propertyFields.accept}.`,
-      (files) => files && files?.length > 0 ? files.some((file) => {
+      (files) => isFile(files) && files.length > 0 ? files.some((file) => {
         const fileType = file.name.split(".").pop();
         return propertyFields.accept.includes(fileType.toLowerCase());
       }) : true
@@ -697,6 +703,8 @@ function buildYupSchema(field, config, logic) {
     validators[0] = () => withBaseSchema().of(buildGroupArraySchema());
   } else if (inputType === supportedTypes.FIELDSET) {
     validators[0] = () => withBaseSchema().shape(buildFieldSetSchema(propertyFields.fields));
+  } else if (inputType === supportedTypes.FILE) {
+    validators.push(withFile);
   }
   if (propertyFields.required) {
     validators.push(withRequired);

package/dist/standalone.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.11.3-dev.20240816092154
- Generated: Fri, 16 Aug 2024 09:22:10 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.4-beta.0
+ Generated: Tue, 20 Aug 2024 17:17:21 GMT
 
  MIT License
 
@@ -12013,13 +12013,13 @@ var yupSchemas = {
       return value === null ? void 0 : value;
     }).test(
       "matchesOptionOrPattern",
-      ({ value }) => {
-        return `The option ${JSON.stringify(value)} is not valid.`;
+      ({ originalValue }) => {
+        return `The option ${JSON.stringify(originalValue)} is not valid.`;
       },
-      (value) => {
-        if (value !== void 0 && typeof value !== "boolean")
+      (castValue, { originalValue }) => {
+        if (typeof originalValue !== "boolean" && castValue !== void 0)
           return false;
-        return validateRadioOrSelectOptions(value, options);
+        return validateRadioOrSelectOptions(castValue, options);
       }
     );
   },
@@ -12147,18 +12147,24 @@ function buildYupSchema(field, config, logic) {
       () => errorMessage.pattern ?? errorMessageFromConfig.pattern ?? `Must have a valid format. E.g. ${randomPlaceholder}`
     );
   }
+  function isFile(files) {
+    return Array.isArray(files) ? files.every((file) => file instanceof File) : files instanceof File;
+  }
+  function withFile(yupSchema) {
+    return yupSchema.test("isValidFile", "Not a valid file.", isFile);
+  }
   function withMaxFileSize(yupSchema) {
     return yupSchema.test(
       "isValidFileSize",
       errorMessage.maxFileSize ?? errorMessageFromConfig.maxFileSize ?? `File size too large. The limit is ${convertKbBytesToMB(propertyFields.maxFileSize)} MB.`,
-      (files) => !files?.some((file) => convertBytesToKB(file.size) > propertyFields.maxFileSize)
+      (files) => isFile(files) && !files?.some((file) => convertBytesToKB(file.size) > propertyFields.maxFileSize)
     );
   }
   function withFileFormat(yupSchema) {
     return yupSchema.test(
       "isSupportedFormat",
       errorMessage.accept ?? errorMessageFromConfig.accept ?? `Unsupported file format. The acceptable formats are ${propertyFields.accept}.`,
-      (files) => files && files?.length > 0 ? files.some((file) => {
+      (files) => isFile(files) && files.length > 0 ? files.some((file) => {
         const fileType = file.name.split(".").pop();
         return propertyFields.accept.includes(fileType.toLowerCase());
       }) : true
@@ -12213,6 +12219,8 @@ function buildYupSchema(field, config, logic) {
     validators[0] = () => withBaseSchema().of(buildGroupArraySchema());
   } else if (inputType === supportedTypes.FIELDSET) {
     validators[0] = () => withBaseSchema().shape(buildFieldSetSchema(propertyFields.fields));
+  } else if (inputType === supportedTypes.FILE) {
+    validators.push(withFile);
   }
   if (propertyFields.required) {
     validators.push(withRequired);

package/package.json

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

package/src/tests/createHeadlessForm.test.js

@@ -783,6 +783,8 @@ describe('createHeadlessForm', () => {
     it('support "radio" field boolean type', () => {
       const { fields, handleValidation } = createHeadlessForm(schemaInputTypeRadioBoolean);
 
+      const validateForm = (vals) => friendlyError(handleValidation(vals));
+
       expect(fields).toMatchObject([
         {
           description: 'Are you over 18 years old?',
@@ -808,13 +810,19 @@ describe('createHeadlessForm', () => {
         handleValidation,
         fieldName: 'over_18',
         validOptions: [true, false],
-        type: 'boolean',
+        type: schemaInputTypeRadioBoolean.properties.over_18.type,
+      });
+
+      expect(validateForm({ over_18: 'true' })).toEqual({
+        over_18: 'The option "true" is not valid.',
       });
     });
 
     it('support "radio" field number type', () => {
       const { fields, handleValidation } = createHeadlessForm(schemaInputTypeRadioNumber);
 
+      const validateForm = (vals) => friendlyError(handleValidation(vals));
+
       expect(fields).toMatchObject([
         {
           description: 'How many siblings do you have?',
@@ -844,7 +852,11 @@ describe('createHeadlessForm', () => {
         handleValidation,
         fieldName: 'siblings_count',
         validOptions: [1, 2, 3],
-        type: 'number',
+        type: schemaInputTypeRadioNumber.properties.siblings_count.type,
+      });
+
+      expect(validateForm({ siblings_count: '3' })).toEqual({
+        siblings_count: 'The option "3" is not valid.',
       });
     });
 
@@ -1786,15 +1798,22 @@ describe('createHeadlessForm', () => {
         // Then the fieldset perks.food changes (the "no" option gets removed)
 
         // Setup (arrange)
-        const { fields, handleValidation } = createHeadlessForm(schemaWithConditionalToFieldset);
-
-        const validateForm = (vals) => friendlyError(handleValidation(vals));
-        const originalFood = getField(fields, 'perks', 'food');
-
-        const perksForLowWorkHours = {
-          food: 'no', // this option will be removed when the condition happens.
-          retirement: 'basic',
-        };
+        let validateForm;
+        let fields;
+        let originalFood;
+        let perksForLowWorkHours;
+
+        beforeAll(() => {
+          const form = createHeadlessForm(schemaWithConditionalToFieldset);
+          fields = form.fields;
+          validateForm = (vals) => friendlyError(form.handleValidation(vals));
+          originalFood = getField(fields, 'perks', 'food');
+
+          perksForLowWorkHours = {
+            food: 'no', // this option will be removed when the condition happens.
+            retirement: 'basic',
+          };
+        });
 
         it('by default, the Perks.food has 4 options', () => {
           expect(originalFood.options).toHaveLength(4);
@@ -2721,7 +2740,7 @@ describe('createHeadlessForm', () => {
       );
       fields = result.fields;
     });
-    describe('and file is of inccorrect format', () => {
+    describe('and file is of incorrect format', () => {
       const file = new File(['foo'], 'file.txt', {
         type: 'text/plain',
       });
@@ -2770,6 +2789,16 @@ describe('createHeadlessForm', () => {
             .validate({ fileInput: [file] })
         ).resolves.toEqual(assertObj));
     });
+    describe('and file is not instance of a File', () => {
+      it('should throw an error', async () =>
+        expect(
+          object()
+            .shape({
+              fileInput: fields[0].schema,
+            })
+            .validate({ fileInput: [{ path: 'foo.txt' }] })
+        ).rejects.toMatchObject({ errors: ['Not a valid file.'] }));
+    });
   });
 
   describe('when a field has conditional presentation properties', () => {