@remoteoss/json-schema-form 0.7.0-beta.0 → 0.7.1-beta.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### 0.7.1-beta.0 (2023-10-31)
+
+##### Bug Fixes
+
+- **select:** support string type ([#54](https://github.com/remoteoss/json-schema-form/pull/54)) ([b00f8776](https://github.com/remoteoss/json-schema-form/commit/b00f8776aa244803375ba64fbdd52c8fff9b9bd8))
+
 #### 0.7.0-beta.0 (2023-10-23)
 
 ##### Chores
@@ -27,10 +33,8 @@ BREAKING CHANGES:
 
 - json-logic: Add conditional logic checking. ([#41](https://github.com/remoteoss/json-schema-form/pull/41)) ([6292b01e](https://github.com/remoteoss/json-schema-form/commit/6292b01e3f77a9038328d7375080ffc4cb30dbc8))
 
-
 ###### Full API additions now supported from 0.6.5 onwards.
 
-
 - New custom JSON Schema keyword `x-jsf-logic` added to support cross-field validations. Built on top of [JsonLogic](https://jsonlogic.com/).
 
 - `x-jsf-logic` can contain:
@@ -49,16 +53,11 @@ While docs are underway, you can read examples from all the [tests](https://gith
 
 In short: `x-jsf-logic` is added to support complex conditional cross-field validations. Properties like `x-jsf-logic-validations` allow hooking those up to individual fields.
 
-
 #### 0.6.4-beta.0 (2023-09-15)
 
-
-
 ##### Changes
-- json-logic: computedAttrs - handle inline rules ([#40](https://github.com/remoteoss/json-schema-form/pull/40)) ([860ad91b](https://github.com/remoteoss/json-schema-form/commit/860ad91b034ab35d4d4bc51c0c04675f102bf278))
-
-
 
+- json-logic: computedAttrs - handle inline rules ([#40](https://github.com/remoteoss/json-schema-form/pull/40)) ([860ad91b](https://github.com/remoteoss/json-schema-form/commit/860ad91b034ab35d4d4bc51c0c04675f102bf278))
 
 #### 0.6.1-beta.0 (2023-09-13)
 
@@ -66,50 +65,43 @@ In short: `x-jsf-logic` is added to support complex conditional cross-field vali
 
 - json-logic: Computed string based values ([#37](https://github.com/remoteoss/json-schema-form/pull/37)) ([6e042ea5](https://github.com/remoteoss/json-schema-form/commit/6e042ea579497ea573710c307a6ff7ee2f19b931))
 
-
-
-
 #### 0.5.0-beta.0 (2023-09-12)
 
 ##### Changes
+
 - json-logic: Computed Attributes ([#36](https://github.com/remoteoss/json-schema-form/pull/36)) ([80c29589](https://github.com/remoteoss/json-schema-form/commit/80c29589ac0972e0f33add70a59df15a46db1b43))
 - json-logic: Initial skeleton implementation ([#35](https://github.com/remoteoss/json-schema-form/pull/35)) ([63149ae8](https://github.com/remoteoss/json-schema-form/commit/63149ae863cf1b5ad76a3b2a49c7f343e55ce07b))
 
-
-
-
 #### 0.4.5-beta.0 (2023-08-31)
+
 ##### Bug fixes
 
 - Validate values based on `const` key ([#34](https://github.com/remoteoss/json-schema-form/pull/34)) ([bf07870d](https://github.com/remoteoss/json-schema-form/commit/bf07870d407d9b9b078882a078b9e4c7928df868))
 
-
-
-
 #### 0.4.4-beta.0 (2023-08-30)
 
 ##### Chores
 
-* **fieldset:**  ignore values not matching the field type ([#44](https://github.com/remoteoss/json-schema-form/pull/44)) ([f0af54e5](https://github.com/remoteoss/json-schema-form/commit/f0af54e5d425fb78524ab150bb31629d00369a61))
+- **fieldset:** ignore values not matching the field type ([#44](https://github.com/remoteoss/json-schema-form/pull/44)) ([f0af54e5](https://github.com/remoteoss/json-schema-form/commit/f0af54e5d425fb78524ab150bb31629d00369a61))
 
 #### 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))
+- **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
 
-* **date:**  Validate based on minDate and maxDate ([#30](https://github.com/remoteoss/json-schema-form/pull/30)) ([01c0143e](https://github.com/remoteoss/json-schema-form/commit/01c0143ea4a3775f9489ae6cb8fd99a90b3f1394))
+- **date:** Validate based on minDate and maxDate ([#30](https://github.com/remoteoss/json-schema-form/pull/30)) ([01c0143e](https://github.com/remoteoss/json-schema-form/commit/01c0143ea4a3775f9489ae6cb8fd99a90b3f1394))
 
 #### 0.4.1-beta.0 (2023-07-03)
 
 ##### Bug Fixes
 
-* **fieldset:**  support root conditionals for fieldsets ([#23](https://github.com/remoteoss/json-schema-form/pull/23)) ([65d87b3a](https://github.com/remoteoss/json-schema-form/commit/65d87b3a93018f0729aed565000eb2a2ce1f2ce7))
-* **select/radio:**  Accept just the values in options (plus `''` and `null` for backward-compatibility) ([#18](https://github.com/remoteoss/json-schema-form/pull/18)) ([37501d2d](https://github.com/remoteoss/json-schema-form/commit/37501d2ddafdd5e207b34d2ca3f6b7b7a1006e9d))
+- **fieldset:** support root conditionals for fieldsets ([#23](https://github.com/remoteoss/json-schema-form/pull/23)) ([65d87b3a](https://github.com/remoteoss/json-schema-form/commit/65d87b3a93018f0729aed565000eb2a2ce1f2ce7))
+- **select/radio:** Accept just the values in options (plus `''` and `null` for backward-compatibility) ([#18](https://github.com/remoteoss/json-schema-form/pull/18)) ([37501d2d](https://github.com/remoteoss/json-schema-form/commit/37501d2ddafdd5e207b34d2ca3f6b7b7a1006e9d))
 
 #### 0.4.0-beta.0 (2023-06-22)
 

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.7.0-beta.0
- Generated: Mon, 23 Oct 2023 10:15:24 GMT
+ NPM Package: @remoteoss/json-schema-form@0.7.1-beta.0
+ Generated: Tue, 31 Oct 2023 14:25:25 GMT
 
  MIT License
 
@@ -461,17 +461,22 @@ var validateMaxDate = (value, minDate) => {
 };
 var yupSchemas = {
   text: validateOnlyStrings,
-  radioOrSelect: (options) => (0, import_yup.string)().nullable().transform((value) => {
-    if (value === "") {
-      return void 0;
+  radioOrSelect: (options, isString) => {
+    if (isString) {
+      return (0, import_yup.string)().nullable();
     }
-    if (options?.includes(null)) {
-      return value;
-    }
-    return value === null ? void 0 : value;
-  }).oneOf(options, ({ value }) => {
-    return `The option ${JSON.stringify(value)} is not valid.`;
-  }),
+    return (0, import_yup.string)().nullable().transform((value) => {
+      if (value === "") {
+        return void 0;
+      }
+      if (options?.includes(null)) {
+        return value;
+      }
+      return value === null ? void 0 : value;
+    }).oneOf(options, ({ value }) => {
+      return `The option ${JSON.stringify(value)} is not valid.`;
+    });
+  },
   date: ({ minDate, maxDate }) => {
     let dateString = (0, import_yup.string)().nullable().transform((value) => {
       if (value === "") {
@@ -539,8 +544,9 @@ var getOptions = (field) => {
 var getYupSchema = ({ inputType, ...field }) => {
   const jsonType = getJsonTypeInArray(field.jsonType);
   if (field.options?.length > 0) {
+    const isString = field.options?.findIndex((option) => option.type === "string") > -1;
     const optionValues = getOptions(field);
-    return yupSchemas.radioOrSelect(optionValues);
+    return yupSchemas.radioOrSelect(optionValues, isString);
   }
   if (field.format === "date") {
     return yupSchemas.date({ minDate: field.minDate, maxDate: field.maxDate });

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.7.0-beta.0
- Generated: Mon, 23 Oct 2023 10:15:24 GMT
+ NPM Package: @remoteoss/json-schema-form@0.7.1-beta.0
+ Generated: Tue, 31 Oct 2023 14:25:25 GMT
 
  MIT License
 
@@ -425,17 +425,22 @@ var validateMaxDate = (value, minDate) => {
 };
 var yupSchemas = {
   text: validateOnlyStrings,
-  radioOrSelect: (options) => string().nullable().transform((value) => {
-    if (value === "") {
-      return void 0;
+  radioOrSelect: (options, isString) => {
+    if (isString) {
+      return string().nullable();
     }
-    if (options?.includes(null)) {
-      return value;
-    }
-    return value === null ? void 0 : value;
-  }).oneOf(options, ({ value }) => {
-    return `The option ${JSON.stringify(value)} is not valid.`;
-  }),
+    return string().nullable().transform((value) => {
+      if (value === "") {
+        return void 0;
+      }
+      if (options?.includes(null)) {
+        return value;
+      }
+      return value === null ? void 0 : value;
+    }).oneOf(options, ({ value }) => {
+      return `The option ${JSON.stringify(value)} is not valid.`;
+    });
+  },
   date: ({ minDate, maxDate }) => {
     let dateString = string().nullable().transform((value) => {
       if (value === "") {
@@ -503,8 +508,9 @@ var getOptions = (field) => {
 var getYupSchema = ({ inputType, ...field }) => {
   const jsonType = getJsonTypeInArray(field.jsonType);
   if (field.options?.length > 0) {
+    const isString = field.options?.findIndex((option) => option.type === "string") > -1;
     const optionValues = getOptions(field);
-    return yupSchemas.radioOrSelect(optionValues);
+    return yupSchemas.radioOrSelect(optionValues, isString);
   }
   if (field.format === "date") {
     return yupSchemas.date({ minDate: field.minDate, maxDate: field.maxDate });

package/dist/standalone.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.7.0-beta.0
- Generated: Mon, 23 Oct 2023 10:15:24 GMT
+ NPM Package: @remoteoss/json-schema-form@0.7.1-beta.0
+ Generated: Tue, 31 Oct 2023 14:25:25 GMT
 
  MIT License
 
@@ -3577,7 +3577,7 @@ var require_property_expr = __commonJS({
       );
     }
     function split2(path) {
-      return path.match(SPLIT_REGEX) || [""];
+      return path.match(SPLIT_REGEX);
     }
     function forEach2(parts, iter, thisArg) {
       var len = parts.length, part, idx, isArray2, isBracket;
@@ -6898,13 +6898,13 @@ function _extends() {
 }
 
 // node_modules/@babel/runtime/helpers/esm/typeof.js
-function _typeof(o) {
+function _typeof(obj) {
   "@babel/helpers - typeof";
-  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o2) {
-    return typeof o2;
-  } : function(o2) {
-    return o2 && "function" == typeof Symbol && o2.constructor === Symbol && o2 !== Symbol.prototype ? "symbol" : typeof o2;
-  }, _typeof(o);
+  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(obj2) {
+    return typeof obj2;
+  } : function(obj2) {
+    return obj2 && "function" == typeof Symbol && obj2.constructor === Symbol && obj2 !== Symbol.prototype ? "symbol" : typeof obj2;
+  }, _typeof(obj);
 }
 
 // node_modules/@babel/runtime/helpers/esm/toPrimitive.js
@@ -11779,17 +11779,22 @@ var validateMaxDate = (value, minDate) => {
 };
 var yupSchemas = {
   text: validateOnlyStrings,
-  radioOrSelect: (options) => StringSchema().nullable().transform((value) => {
-    if (value === "") {
-      return void 0;
+  radioOrSelect: (options, isString2) => {
+    if (isString2) {
+      return StringSchema().nullable();
     }
-    if (options?.includes(null)) {
-      return value;
-    }
-    return value === null ? void 0 : value;
-  }).oneOf(options, ({ value }) => {
-    return `The option ${JSON.stringify(value)} is not valid.`;
-  }),
+    return StringSchema().nullable().transform((value) => {
+      if (value === "") {
+        return void 0;
+      }
+      if (options?.includes(null)) {
+        return value;
+      }
+      return value === null ? void 0 : value;
+    }).oneOf(options, ({ value }) => {
+      return `The option ${JSON.stringify(value)} is not valid.`;
+    });
+  },
   date: ({ minDate, maxDate }) => {
     let dateString = StringSchema().nullable().transform((value) => {
       if (value === "") {
@@ -11857,8 +11862,9 @@ var getOptions = (field) => {
 var getYupSchema = ({ inputType, ...field }) => {
   const jsonType = getJsonTypeInArray(field.jsonType);
   if (field.options?.length > 0) {
+    const isString2 = field.options?.findIndex((option) => option.type === "string") > -1;
     const optionValues = getOptions(field);
-    return yupSchemas.radioOrSelect(optionValues);
+    return yupSchemas.radioOrSelect(optionValues, isString2);
   }
   if (field.format === "date") {
     return yupSchemas.date({ minDate: field.minDate, maxDate: field.maxDate });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "0.7.0-beta.0",
+  "version": "0.7.1-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

@@ -15,6 +15,7 @@ import {
   schemaInputTypeRadioOptionsWithDetails,
   schemaInputTypeSelectSoloDeprecated,
   schemaInputTypeSelectSolo,
+  schemaInputTypeSelectString,
   schemaInputTypeSelectMultipleDeprecated,
   schemaInputTypeSelectMultiple,
   schemaInputTypeSelectMultipleOptional,
@@ -430,7 +431,7 @@ describe('createHeadlessForm', () => {
   });
 
   describe('field support', () => {
-    function assertOptionsAllowed({ handleValidation, fieldName, validOptions }) {
+    function assertOptionsAllowed({ handleValidation, fieldName, validOptions, isString = false }) {
       const validateForm = (vals) => friendlyError(handleValidation(vals));
 
       // All allowed options are valid
@@ -438,27 +439,34 @@ describe('createHeadlessForm', () => {
         expect(validateForm({ [fieldName]: value })).toBeUndefined();
       });
 
-      // Any other arbitrary value is not valid.
-      expect(validateForm({ [fieldName]: 'blah-blah' })).toEqual({
-        [fieldName]: 'The option "blah-blah" is not valid.',
-      });
+      if (!isString) {
+        // Any other arbitrary value is not valid.
+        expect(validateForm({ [fieldName]: 'blah-blah' })).toEqual({
+          [fieldName]: 'The option "blah-blah" is not valid.',
+        });
 
-      // Given undefined, it says it's a  required field.
-      expect(validateForm({})).toEqual({
-        [fieldName]: 'Required field',
-      });
+        // Given undefined, it says it's a  required field.
+        expect(validateForm({})).toEqual({
+          [fieldName]: 'Required field',
+        });
 
-      // As required field, empty string ("") is also considered empty. @BUG RMT-518
-      // Expectation: The error to be "The option '' is not valid."
-      expect(validateForm({ [fieldName]: '' })).toEqual({
-        [fieldName]: 'Required field',
-      });
+        // As required field, empty string ("") is also considered empty. @BUG RMT-518
+        // Expectation: The error to be "The option '' is not valid."
+        expect(validateForm({ [fieldName]: '' })).toEqual({
+          [fieldName]: 'Required field',
+        });
 
-      // As required field, null is also considered empty @BUG RMT-518
-      // Expectation: The error to be "The option null is not valid."
-      expect(validateForm({ [fieldName]: null })).toEqual({
-        [fieldName]: 'Required field',
-      });
+        // As required field, null is also considered empty @BUG RMT-518
+        // Expectation: The error to be "The option null is not valid."
+        expect(validateForm({ [fieldName]: null })).toEqual({
+          [fieldName]: 'Required field',
+        });
+      }
+
+      if (isString) {
+        // Any other arbitrary value is valid.
+        expect(validateForm({ [fieldName]: 'blah-blah' })).toBeUndefined();
+      }
     }
 
     it('support "text" field type', () => {
@@ -630,6 +638,41 @@ describe('createHeadlessForm', () => {
       });
     });
 
+    it('supports "select" field type with string option', () => {
+      const { fields, handleValidation } = createHeadlessForm(schemaInputTypeSelectString);
+      const fieldSelect = fields[0];
+      expect(fieldSelect).toMatchObject({
+        name: 'browsers',
+        label: 'Browsers (solo)',
+        description: 'This solo select also includes a disabled option.',
+        options: [
+          {
+            value: 'chr',
+            label: 'Chrome',
+          },
+          {
+            value: 'ff',
+            label: 'Firefox',
+          },
+          {
+            value: 'ie',
+            label: 'Internet Explorer',
+            disabled: true,
+          },
+          { value: undefined, type: 'string', label: '{Create another}' },
+        ],
+      });
+
+      expect(fieldSelect).not.toHaveProperty('multiple');
+
+      assertOptionsAllowed({
+        handleValidation,
+        fieldName: 'browsers',
+        validOptions: ['chr', 'ff', 'ie'],
+        isString: true,
+      });
+    });
+
     it('supports "select" field type with multiple options @deprecated', () => {
       const result = createHeadlessForm(schemaInputTypeSelectMultipleDeprecated);
       expect(result).toMatchObject({
@@ -1947,9 +1990,9 @@ describe('createHeadlessForm', () => {
             },
           },
           {
-            name: 'a_or_b',
-            label: 'A dropdown',
-            type: 'select',
+            name: 'role',
+            label: 'Role',
+            type: 'text',
             statement: {
               description: 'This is another statement message, but more severe.',
               inputType: 'statement',

package/src/tests/helpers.js

@@ -238,6 +238,11 @@ export const mockSelectInputSolo = {
   },
 };
 
+export const mockSelectInputSoloCreatable = {
+  ...mockSelectInputSolo,
+  oneOf: [...mockSelectInputSolo.oneOf, { type: 'string', title: '{Create another}' }],
+};
+
 export const mockSelectInputMultiple = {
   title: 'Browsers (multiple)',
   description: 'This multi-select also includes a disabled option.',
@@ -463,6 +468,12 @@ export const mockCheckboxInput = {
     })
     .build();
  */
+
+/**
+ * @deprecated in favor of normal JSON schema.
+ * Why? This adds extra complexity to read and to
+ * copy-paste into the Playground, validators, etc
+ * */
 export function JSONSchemaBuilder() {
   return {
     addInput: function addInput(input) {
@@ -658,15 +669,15 @@ export const schemaWithoutTypes = {
   },
 };
 
-export const schemaInputTypeText = JSONSchemaBuilder()
-  .addInput({
+export const schemaInputTypeText = {
+  properties: {
     id_number: mockTextInput,
-  })
-  .setRequiredFields(['id_number'])
-  .build();
+  },
+  required: ['id_number'],
+};
 
-export const schemaInputWithStatement = JSONSchemaBuilder()
-  .addInput({
+export const schemaInputWithStatement = {
+  properties: {
     bonus: {
       title: 'Bonus',
       'x-jsf-presentation': {
@@ -678,71 +689,10 @@ export const schemaInputWithStatement = JSONSchemaBuilder()
         },
       },
     },
-  })
-  .addInput({
-    a_or_b: {
-      title: 'A dropdown',
-      description: 'Some options to chose from',
-      items: {
-        enum: ['A', 'B'],
-      },
+    role: {
+      title: 'Role',
       'x-jsf-presentation': {
-        inputType: 'select',
-        options: [
-          {
-            label: 'A',
-            value: 'A',
-          },
-          {
-            label: 'B',
-            value: 'B',
-          },
-        ],
-        placeholder: 'Select...',
-        statement: {
-          description: 'This is another statement message, but more severe.',
-          inputType: 'statement',
-          severity: 'warning',
-        },
-      },
-    },
-  })
-  .build();
-
-export const schemaInputWithStatementDeprecated = JSONSchemaBuilder()
-  .addInput({
-    bonus: {
-      title: 'Bonus',
-      presentation: {
         inputType: 'text',
-        statement: {
-          description: 'This is a custom statement message.',
-          inputType: 'statement',
-          severity: 'info',
-        },
-      },
-    },
-  })
-  .addInput({
-    a_or_b: {
-      title: 'A dropdown',
-      description: 'Some options to chose from',
-      items: {
-        enum: ['A', 'B'],
-      },
-      presentation: {
-        inputType: 'select',
-        options: [
-          {
-            label: 'A',
-            value: 'A',
-          },
-          {
-            label: 'B',
-            value: 'B',
-          },
-        ],
-        placeholder: 'Select...',
         statement: {
           description: 'This is another statement message, but more severe.',
           inputType: 'statement',
@@ -750,11 +700,11 @@ export const schemaInputWithStatementDeprecated = JSONSchemaBuilder()
         },
       },
     },
-  })
-  .build();
+  },
+};
 
-export const schemaInputWithExtra = JSONSchemaBuilder()
-  .addInput({
+export const schemaInputWithExtra = {
+  properties: {
     bonus: {
       title: 'Bonus',
       'x-jsf-presentation': {
@@ -772,11 +722,11 @@ export const schemaInputWithExtra = JSONSchemaBuilder()
         `,
       },
     },
-  })
-  .build();
+  },
+};
 
-export const schemaInputWithCustomDescription = JSONSchemaBuilder()
-  .addInput({
+export const schemaInputWithCustomDescription = {
+  properties: {
     other: {
       title: 'Other',
       'x-jsf-presentation': {
@@ -785,8 +735,8 @@ export const schemaInputWithCustomDescription = JSONSchemaBuilder()
       },
       type: 'string',
     },
-  })
-  .build();
+  },
+};
 
 export const schemaInputDeprecated = JSONSchemaBuilder()
   .addInput({
@@ -952,6 +902,10 @@ export const schemaInputTypeSelectSolo = JSONSchemaBuilder()
   .setRequiredFields(['browsers'])
   .build();
 
+export const schemaInputTypeSelectString = JSONSchemaBuilder().addInput({
+  browsers: mockSelectInputSoloCreatable,
+});
+
 /** @deprecated */
 export const schemaInputTypeSelectMultipleDeprecated = JSONSchemaBuilder()
   .addInput({