@remoteoss/json-schema-form 0.1.0-dev.20230517215258 → 0.1.1-dev.20230614173637

package/CHANGELOG.md

@@ -1,33 +1,5 @@
-# Changelog
+#### 0.1.0-beta.0 (2023-05-18)
 
-All notable changes to this project will be documented in this file.
+##### New Features
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-<!-- Type of changes:
-- Added
-- Changed
-- Deprecated
-- Removed
-- Fixed
-- Security
--->
-
-<!-- eg:
-### Added
-- Short description about it. ([#pr-id](https://github.com/remoteoss/jsf/pull/<pr-id>))
-
-### Deprecated
-- Deprecated `xxx` in favor of `yyy`. ([#pr-id](https://github.com/remoteoss/jsf/pull/<pr-id>))
--->
-
-## [1.0.0-beta.1] - 2023-XX-XX
-
-### Added
-
-- Initial public release. ([#1](https://github.com/remoteoss/jsf/pull/1))
-
----
+- Initial release ([#1](https://github.com/remoteoss/json-schema-form/pull/1)) ([9a687351](https://github.com/remoteoss/json-schema-form/commit/9a6873513445a7a53e9f9222d457c5ce585cbbd8) and ([#5](https://github.com/remoteoss/json-schema-form/pull/5)) ([ceb6f47b](https://github.com/remoteoss/json-schema-form/commit/ceb6f47b3d1ff031e1789a504af32ecc36834d8e))

package/README.md

@@ -14,6 +14,17 @@
 
 JSON Schemas are the SSoT (Single Source of Truth) that allows you to share form's _structure_ and _validations_ between frontend and backend, regardless of the language used.
 
+## Installation
+
+Available on [NPM](https://www.npmjs.com/package/@remoteoss/json-schema-form).
+
+```bash
+npm install @remoteoss/json-schema-form
+# or
+
+yarn install @remoteoss/json-schema-form
+```
+
 ## Documentation
 
 Check the 📚 **[JSF website](https://json-schema-form.vercel.app/)** for documentation and demos.

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.1.0-dev.20230517215258
- Generated: Wed, 17 May 2023 21:53:15 GMT
+ NPM Package: @remoteoss/json-schema-form@0.1.1-dev.20230614173637
+ Generated: Wed, 14 Jun 2023 17:37:05 GMT
 
  MIT License
 
@@ -591,7 +591,7 @@ function getField(fieldName, fields) {
 }
 function validateFieldSchema(field, value) {
   const validator = buildYupSchema(field);
-  return validator().isValidSync(value);
+  return validator().isValidSync(value, { strict: true });
 }
 function compareFormValueWithSchemaValue(formValue, schemaValue) {
   const currentPropertyValue = typeof schemaValue === "number" ? schemaValue : schemaValue || void 0;
@@ -899,7 +899,8 @@ var handleValuesChange = (fields, jsonSchema, config) => (values) => {
   let errors;
   try {
     lazySchema.validateSync(values, {
-      abortEarly: false
+      abortEarly: false,
+      strict: true
     });
   } catch (err) {
     if (err.name === "ValidationError") {

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.1.0-dev.20230517215258
- Generated: Wed, 17 May 2023 21:53:15 GMT
+ NPM Package: @remoteoss/json-schema-form@0.1.1-dev.20230614173637
+ Generated: Wed, 14 Jun 2023 17:37:05 GMT
 
  MIT License
 
@@ -555,7 +555,7 @@ function getField(fieldName, fields) {
 }
 function validateFieldSchema(field, value) {
   const validator = buildYupSchema(field);
-  return validator().isValidSync(value);
+  return validator().isValidSync(value, { strict: true });
 }
 function compareFormValueWithSchemaValue(formValue, schemaValue) {
   const currentPropertyValue = typeof schemaValue === "number" ? schemaValue : schemaValue || void 0;
@@ -863,7 +863,8 @@ var handleValuesChange = (fields, jsonSchema, config) => (values) => {
   let errors;
   try {
     lazySchema.validateSync(values, {
-      abortEarly: false
+      abortEarly: false,
+      strict: true
     });
   } catch (err) {
     if (err.name === "ValidationError") {

package/dist/standalone.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.1.0-dev.20230517215258
- Generated: Wed, 17 May 2023 21:53:15 GMT
+ NPM Package: @remoteoss/json-schema-form@0.1.1-dev.20230614173637
+ Generated: Wed, 14 Jun 2023 17:37:05 GMT
 
  MIT License
 
@@ -11959,7 +11959,7 @@ function getField(fieldName, fields) {
 }
 function validateFieldSchema(field, value) {
   const validator = buildYupSchema(field);
-  return validator().isValidSync(value);
+  return validator().isValidSync(value, { strict: true });
 }
 function compareFormValueWithSchemaValue(formValue, schemaValue) {
   const currentPropertyValue = typeof schemaValue === "number" ? schemaValue : schemaValue || void 0;
@@ -12267,7 +12267,8 @@ var handleValuesChange = (fields, jsonSchema, config) => (values2) => {
   let errors;
   try {
     lazySchema.validateSync(values2, {
-      abortEarly: false
+      abortEarly: false,
+      strict: true
     });
   } catch (err) {
     if (err.name === "ValidationError") {

package/json-schema-form.schema.json

@@ -0,0 +1,188 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "JSON json-schema-form-Schema",
+  "definitions": {
+    "schemaArray": {
+      "allOf": [
+        {
+          "$ref": "http://json-schema.org/draft-07/schema#/definitions/schemaArray"
+        },
+        {
+          "items": { "$ref": "#" }
+        }
+      ]
+    }
+  },
+  "allOf": [{ "$ref": "http://json-schema.org/draft-07/schema#" }],
+  "properties": {
+    "additionalItems": { "$ref": "#" },
+    "additionalProperties": { "$ref": "#" },
+    "dependencies": {
+      "additionalProperties": {
+        "anyOf": [{ "$ref": "#" }, { "type": "array" }]
+      }
+    },
+    "items": {
+      "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/schemaArray" }]
+    },
+    "definitions": {
+      "additionalProperties": { "$ref": "#" }
+    },
+    "patternProperties": {
+      "additionalProperties": { "$ref": "#" }
+    },
+    "properties": {
+      "additionalProperties": { "$ref": "#" }
+    },
+    "if": { "$ref": "#" },
+    "then": { "$ref": "#" },
+    "else": { "$ref": "#" },
+    "allOf": { "$ref": "#/definitions/schemaArray" },
+    "anyOf": { "$ref": "#/definitions/schemaArray" },
+    "oneOf": { "$ref": "#/definitions/schemaArray" },
+    "not": { "$ref": "#" },
+    "contains": { "$ref": "#" },
+    "propertyNames": { "$ref": "#" },
+    "x-jsf-order": {
+      "description": "This keyword defines the order of fields for a given form or fieldset. It's placed at the schema root and inside of each fieldset.",
+      "$ref": "http://json-schema.org/draft-07/schema#/definitions/stringArray"
+    },
+    "x-jsf-errorMessage": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Message shown when the value is not of the correct type."
+        },
+        "required": {
+          "type": "string",
+          "description": "Message shown when the value is required and not provided."
+        },
+        "minimum": {
+          "type": "string",
+          "description": "Message shown when the value is less than the minimum value."
+        },
+        "minLength": {
+          "type": "string",
+          "description": "Message shown when the value is less than the minimum length."
+        },
+        "maximum": {
+          "type": "string",
+          "description": "Message shown when the value is greater than the maximum value."
+        },
+        "maxLength": {
+          "type": "string",
+          "description": "Message shown when the value is greater than the maximum length."
+        },
+        "pattern": {
+          "type": "string",
+          "description": "Message shown when the value is not the correct format and does not match the pattern property."
+        },
+        "maxFileSize": {
+          "type": "string",
+          "description": "Message shown when the file size is greater than the maximum file size."
+        },
+        "accept": {
+          "type": "string",
+          "description": "Message shown when the file type is not accepted."
+        }
+      }
+    },
+    "x-jsf-presentation": {
+      "type": "object",
+      "description": "Presentation overrides for the schema",
+      "properties": {
+        "inputType": {
+          "description": "Input type for the generated UI field",
+          "type": "string",
+          "anyOf": [
+            {
+              "const": "text",
+              "description": "Similar to the native HTML input with text type."
+            },
+            {
+              "const": "select",
+              "description": "Similar to the native HTML select element."
+            },
+            {
+              "const": "radio",
+              "description": "Similar to a native HTML input with radio type."
+            },
+            {
+              "const": "number",
+              "description": "Similar to the native HTML input with number type."
+            },
+            {
+              "const": "date",
+              "description": "Expects a value with format YYY-MM-DD."
+            },
+            {
+              "const": "checkbox",
+              "description": "Similar to the native HTML input with checkbox type."
+            },
+            {
+              "const": "email",
+              "description": "Similar to the native HTML input with email type."
+            },
+            {
+              "const": "file",
+              "description": "Similar to the native HTML input with file type."
+            },
+            {
+              "const": "fieldset",
+              "description": "Groups multiple Fields inside. Its expected value is a nested object."
+            },
+            {
+              "const": "group-array",
+              "description": "A list of inputs that can be repeated. Its expected value is an array."
+            },
+            {
+              "type": "string",
+              "description": "Any arbitrary custom inputType you might want to represent your UI Field."
+            }
+          ]
+        },
+        "accept": {
+          "description": "For `inputType: \"file\"`. The accepted file types, as a comma separated string.",
+          "type": "string"
+        },
+        "description": {
+          "description": "Field description with HTML. If you don't need HTML, please use the native description keyword.",
+          "type": "string"
+        },
+        "statement": {
+          "description": "Special message about the field. Useful in cases where this message is based on the field value.",
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string"
+            },
+            "description": {
+              "description": "The sentence itself. Might include HTML.",
+              "type": "string"
+            },
+            "severity": {
+              "description": "Defines the type of message.",
+              "anyOf": [
+                { "type": "string", "const": "info" },
+                { "type": "string", "const": "warning" },
+                { "type": "string", "const": "error" },
+                { "type": "string", "const": "success" },
+                {}
+              ]
+            }
+          }
+        },
+        "maxFileSize": {
+          "description": "For `inputType: \"file\"`. The maximum file size in KB. It's used to enhanced Yup validation.",
+          "type": "number"
+        },
+        "addFieldText": {
+          "description": "Used in `group-array` fields. The button text to add a new field.",
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "0.1.0-dev.20230517215258",
+  "version": "0.1.1-dev.20230614173637",
   "description": "Headless UI form powered by JSON Schemas",
   "author": "Remote.com <engineering@remote.com> (https://remote.com/)",
   "license": "MIT",
@@ -14,6 +14,7 @@
   "files": [
     "dist",
     "src/tests",
+    "json-schema-form.schema.json",
     "README.md",
     "CHANGELOG.md",
     "LICENSE.md"
@@ -21,6 +22,7 @@
   "scripts": {
     "build": "node scripts/build.js",
     "test": "jest",
+    "test:watch": "jest --watchAll",
     "lint": "eslint \"src/**/*.{js,ts}\"",
     "format": "npm run format:prettier && npm run format:eslint",
     "prepare": "husky install",

package/src/tests/createHeadlessForm.test.js

@@ -419,7 +419,7 @@ describe('createHeadlessForm', () => {
 
   describe('field support', () => {
     it('support "text" field type', () => {
-      const { fields } = createHeadlessForm(schemaInputTypeText);
+      const { fields, handleValidation } = createHeadlessForm(schemaInputTypeText);
 
       expect(fields[0]).toMatchObject({
         description: 'The number of your national identification (max 10 digits)',
@@ -435,10 +435,14 @@ describe('createHeadlessForm', () => {
       });
 
       const fieldValidator = fields[0].schema;
-      expect(fieldValidator.isValidSync('CI007')).toBe(true);
-      expect(fieldValidator.isValidSync(true)).toBe(true); // @BUG RMT-446 - cannot be a bool
-      expect(fieldValidator.isValidSync(1)).toBe(true); // @BUG RMT-446 - cannot be a number
-      expect(fieldValidator.isValidSync(0)).toBe(true); // @BUG RMT-446 - cannot be a number
+      expect(fieldValidator.isValidSync('CI007', { strict: true })).toBe(true);
+      expect(fieldValidator.isValidSync(true, { strict: true })).toBe(false);
+      expect(fieldValidator.isValidSync(1, { strict: true })).toBe(false);
+      expect(fieldValidator.isValidSync(0, { strict: true })).toBe(false);
+
+      expect(handleValidation({ id_number: 1 }).formErrors).toEqual({
+        id_number: 'id_number must be a `string` type, but the final value was: `1`.',
+      });
 
       expect(() => fieldValidator.validateSync('')).toThrowError('Required field');
     });
@@ -1307,9 +1311,7 @@ describe('createHeadlessForm', () => {
 
       // The "child.has_child" is required
       expect(validateForm({})).toEqual({
-        child: {
-          has_child: 'Required field',
-        },
+        child: 'Required field',
       });
 
       // The "child.no" is valid
@@ -2313,7 +2315,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_tabs: 'no',
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
             mandatory_group_array: 'no',
           })
@@ -2328,7 +2330,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_tabs: 'yes',
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
             mandatory_group_array: 'no',
           })
@@ -2344,7 +2346,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_tabs: 'yes',
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
             mandatory_group_array: 'yes',
             a_group_array: [{ full_name: 'adfs' }],
@@ -2355,7 +2357,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_tabs: 'yes',
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
               tabs: 2,
             },
             mandatory_group_array: 'no',
@@ -2446,7 +2448,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_fieldset: ['id_number'],
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
           })
         ).toBeUndefined();
@@ -2455,7 +2457,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_fieldset: ['id_number', 'all'],
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
           })
         ).toEqual({
@@ -2468,7 +2470,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_fieldset: ['id_number', 'all'],
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
               tabs: 2,
             },
           })
@@ -2483,7 +2485,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_fieldset: ['id_number'],
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
           })
         ).toBeUndefined();
@@ -2492,7 +2494,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_fieldset: ['id_number', 'all'],
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
             },
           })
         ).toEqual({
@@ -2505,7 +2507,7 @@ describe('createHeadlessForm', () => {
           validateForm({
             validate_fieldset: ['id_number', 'all'],
             a_fieldset: {
-              id_number: 123,
+              id_number: '123',
               tabs: 2,
             },
           })