@remoteoss/json-schema-form 0.7.0-dev.20230928101050 → 0.7.1-dev.20231026204916

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+#### 0.7.0-beta.0 (2023-10-23)
+
+##### Chores
+
+BREAKING CHANGES:
+
+- **Description/Extra/Statement fields:** We have removed the sorrounding spans that we output in these fields ([#17](https://github.com/remoteoss/json-schema-form/pull/27)) ([6257533](https://github.com/remoteoss/json-schema-form/commit/6257533bead9c0f7391f240c2e5bacc801a90af7))
+
+```diff
+-description: '<span class="jsf-description">Write in <b>hh:ss</b> format</span>',
++description: 'Write in <b>hh:ss</b> format',
+```
+
+#### 0.6.6-beta.0 (2023-10-17)
+
+##### Chores
+
+- **github:** Add template for issues and pull requests ([#45](https://github.com/remoteoss/json-schema-form/pull/45)) ([621e3338](https://github.com/remoteoss/json-schema-form/commit/621e33389638541e771d2229c91655e430ea7ec4))
+
+##### Bug Fixes
+
+- allow 0 in const validation ([#48](https://github.com/remoteoss/json-schema-form/pull/48)) ([cde19fc9](https://github.com/remoteoss/json-schema-form/commit/cde19fc960c4eacdde476ddcdd8c650a4ff5ce96))
+
 #### 0.6.5-beta.0 (2023-09-18)
 
 ##### Changes

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.7.0-dev.20230928101050
- Generated: Thu, 28 Sep 2023 10:11:18 GMT
+ NPM Package: @remoteoss/json-schema-form@0.7.1-dev.20231026204916
+ Generated: Thu, 26 Oct 2023 20:49:34 GMT
 
  MIT License
 
@@ -465,13 +465,34 @@ var yupSchemas = {
     if (value === "") {
       return void 0;
     }
-    if (options?.includes(null)) {
+    if (options?.some((option) => option.value === null)) {
       return value;
     }
     return value === null ? void 0 : value;
-  }).oneOf(options, ({ value }) => {
-    return `The option ${JSON.stringify(value)} is not valid.`;
-  }),
+  }).test(
+    /* 
+      Custom test determines if the value either:
+       - Matches a specific option by value
+       - Matches a pattern
+      If the option is undefined do not test, to allow for optional fields. 
+     */
+    "matchesOptionOrPattern",
+    ({ value }) => `The option ${JSON.stringify(value)} is not valid.`,
+    (value) => {
+      if (value === void 0) {
+        return true;
+      }
+      const exactMatch = options.some((option) => option.value === value);
+      if (exactMatch) {
+        return true;
+      }
+      const patternMatch = options.some((option) => option.pattern?.test(value));
+      if (patternMatch) {
+        return true;
+      }
+      return false;
+    }
+  ),
   date: ({ minDate, maxDate }) => {
     let dateString = (0, import_yup.string)().nullable().transform((value) => {
       if (value === "") {
@@ -529,12 +550,15 @@ function getRequiredErrorMessage(inputType, { inlineError, configError }) {
 }
 var getJsonTypeInArray = (jsonType) => Array.isArray(jsonType) ? jsonType.find((val) => val !== "null") : jsonType;
 var getOptions = (field) => {
-  const allValues = field.options?.map((option) => option.value);
+  const allValues = field.options?.map((option) => ({
+    value: option.value,
+    pattern: option.pattern ? new RegExp(option.pattern) : null
+  }));
   const isOptionalWithNull = Array.isArray(field.jsonType) && // @TODO should also check the "oneOf" directly looking for "null"
   // option but we don't have direct access at this point.
   // Otherwise the JSON Schema validator will fail as explained in PR#18
   field.jsonType.includes("null");
-  return isOptionalWithNull ? [...allValues, null] : allValues;
+  return isOptionalWithNull ? [...allValues, { option: null }] : allValues;
 };
 var getYupSchema = ({ inputType, ...field }) => {
   const jsonType = getJsonTypeInArray(field.jsonType);
@@ -694,7 +718,7 @@ function buildYupSchema(field, config, logic) {
   if (propertyFields.accept) {
     validators.push(withFileFormat);
   }
-  if (propertyFields.const) {
+  if (typeof propertyFields.const !== "undefined") {
     validators.push(withConst);
   }
   if (propertyFields.jsonLogicValidations) {
@@ -1323,10 +1347,11 @@ function extractParametersFromNode(schemaNode) {
   const node = (0, import_omit.default)(schemaNode, ["x-jsf-presentation", "presentation"]);
   const description = presentation?.description || node.description;
   const statementDescription = presentation.statement?.description;
+  const value = typeof node.const !== "undefined" && typeof node.default !== "undefined" ? { value: node.const } : {};
   return (0, import_omitBy.default)(
     {
       const: node.const,
-      ...node.const && node.default ? { value: node.const } : {},
+      ...value,
       label: node.title,
       readOnly: node.readOnly,
       ...node.deprecated && {

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.7.0-dev.20230928101050
- Generated: Thu, 28 Sep 2023 10:11:18 GMT
+ NPM Package: @remoteoss/json-schema-form@0.7.1-dev.20231026204916
+ Generated: Thu, 26 Oct 2023 20:49:34 GMT
 
  MIT License
 
@@ -429,13 +429,34 @@ var yupSchemas = {
     if (value === "") {
       return void 0;
     }
-    if (options?.includes(null)) {
+    if (options?.some((option) => option.value === null)) {
       return value;
     }
     return value === null ? void 0 : value;
-  }).oneOf(options, ({ value }) => {
-    return `The option ${JSON.stringify(value)} is not valid.`;
-  }),
+  }).test(
+    /* 
+      Custom test determines if the value either:
+       - Matches a specific option by value
+       - Matches a pattern
+      If the option is undefined do not test, to allow for optional fields. 
+     */
+    "matchesOptionOrPattern",
+    ({ value }) => `The option ${JSON.stringify(value)} is not valid.`,
+    (value) => {
+      if (value === void 0) {
+        return true;
+      }
+      const exactMatch = options.some((option) => option.value === value);
+      if (exactMatch) {
+        return true;
+      }
+      const patternMatch = options.some((option) => option.pattern?.test(value));
+      if (patternMatch) {
+        return true;
+      }
+      return false;
+    }
+  ),
   date: ({ minDate, maxDate }) => {
     let dateString = string().nullable().transform((value) => {
       if (value === "") {
@@ -493,12 +514,15 @@ function getRequiredErrorMessage(inputType, { inlineError, configError }) {
 }
 var getJsonTypeInArray = (jsonType) => Array.isArray(jsonType) ? jsonType.find((val) => val !== "null") : jsonType;
 var getOptions = (field) => {
-  const allValues = field.options?.map((option) => option.value);
+  const allValues = field.options?.map((option) => ({
+    value: option.value,
+    pattern: option.pattern ? new RegExp(option.pattern) : null
+  }));
   const isOptionalWithNull = Array.isArray(field.jsonType) && // @TODO should also check the "oneOf" directly looking for "null"
   // option but we don't have direct access at this point.
   // Otherwise the JSON Schema validator will fail as explained in PR#18
   field.jsonType.includes("null");
-  return isOptionalWithNull ? [...allValues, null] : allValues;
+  return isOptionalWithNull ? [...allValues, { option: null }] : allValues;
 };
 var getYupSchema = ({ inputType, ...field }) => {
   const jsonType = getJsonTypeInArray(field.jsonType);
@@ -658,7 +682,7 @@ function buildYupSchema(field, config, logic) {
   if (propertyFields.accept) {
     validators.push(withFileFormat);
   }
-  if (propertyFields.const) {
+  if (typeof propertyFields.const !== "undefined") {
     validators.push(withConst);
   }
   if (propertyFields.jsonLogicValidations) {
@@ -1287,10 +1311,11 @@ function extractParametersFromNode(schemaNode) {
   const node = omit(schemaNode, ["x-jsf-presentation", "presentation"]);
   const description = presentation?.description || node.description;
   const statementDescription = presentation.statement?.description;
+  const value = typeof node.const !== "undefined" && typeof node.default !== "undefined" ? { value: node.const } : {};
   return omitBy(
     {
       const: node.const,
-      ...node.const && node.default ? { value: node.const } : {},
+      ...value,
       label: node.title,
       readOnly: node.readOnly,
       ...node.deprecated && {

package/dist/standalone.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.7.0-dev.20230928101050
- Generated: Thu, 28 Sep 2023 10:11:18 GMT
+ NPM Package: @remoteoss/json-schema-form@0.7.1-dev.20231026204916
+ Generated: Thu, 26 Oct 2023 20:49:34 GMT
 
  MIT License
 
@@ -11783,13 +11783,34 @@ var yupSchemas = {
     if (value === "") {
       return void 0;
     }
-    if (options?.includes(null)) {
+    if (options?.some((option) => option.value === null)) {
       return value;
     }
     return value === null ? void 0 : value;
-  }).oneOf(options, ({ value }) => {
-    return `The option ${JSON.stringify(value)} is not valid.`;
-  }),
+  }).test(
+    /* 
+      Custom test determines if the value either:
+       - Matches a specific option by value
+       - Matches a pattern
+      If the option is undefined do not test, to allow for optional fields. 
+     */
+    "matchesOptionOrPattern",
+    ({ value }) => `The option ${JSON.stringify(value)} is not valid.`,
+    (value) => {
+      if (value === void 0) {
+        return true;
+      }
+      const exactMatch = options.some((option) => option.value === value);
+      if (exactMatch) {
+        return true;
+      }
+      const patternMatch = options.some((option) => option.pattern?.test(value));
+      if (patternMatch) {
+        return true;
+      }
+      return false;
+    }
+  ),
   date: ({ minDate, maxDate }) => {
     let dateString = StringSchema().nullable().transform((value) => {
       if (value === "") {
@@ -11847,12 +11868,15 @@ function getRequiredErrorMessage(inputType, { inlineError, configError }) {
 }
 var getJsonTypeInArray = (jsonType) => Array.isArray(jsonType) ? jsonType.find((val) => val !== "null") : jsonType;
 var getOptions = (field) => {
-  const allValues = field.options?.map((option) => option.value);
+  const allValues = field.options?.map((option) => ({
+    value: option.value,
+    pattern: option.pattern ? new RegExp(option.pattern) : null
+  }));
   const isOptionalWithNull = Array.isArray(field.jsonType) && // @TODO should also check the "oneOf" directly looking for "null"
   // option but we don't have direct access at this point.
   // Otherwise the JSON Schema validator will fail as explained in PR#18
   field.jsonType.includes("null");
-  return isOptionalWithNull ? [...allValues, null] : allValues;
+  return isOptionalWithNull ? [...allValues, { option: null }] : allValues;
 };
 var getYupSchema = ({ inputType, ...field }) => {
   const jsonType = getJsonTypeInArray(field.jsonType);
@@ -12012,7 +12036,7 @@ function buildYupSchema(field, config, logic) {
   if (propertyFields.accept) {
     validators.push(withFileFormat);
   }
-  if (propertyFields.const) {
+  if (typeof propertyFields.const !== "undefined") {
     validators.push(withConst);
   }
   if (propertyFields.jsonLogicValidations) {
@@ -12641,10 +12665,11 @@ function extractParametersFromNode(schemaNode) {
   const node = (0, import_omit.default)(schemaNode, ["x-jsf-presentation", "presentation"]);
   const description = presentation?.description || node.description;
   const statementDescription = presentation.statement?.description;
+  const value = typeof node.const !== "undefined" && typeof node.default !== "undefined" ? { value: node.const } : {};
   return (0, import_omitBy.default)(
     {
       const: node.const,
-      ...node.const && node.default ? { value: node.const } : {},
+      ...value,
       label: node.title,
       readOnly: node.readOnly,
       ...node.deprecated && {

package/package.json

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

package/src/tests/const.test.js

@@ -20,6 +20,25 @@ describe('validations: const', () => {
     expect(handleValidation({ ten_only: null }).formErrors).toBeUndefined();
   });
 
+  it('Should work for when the number is 0', () => {
+    const { handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          zero_only: { type: 'number', const: 0 },
+        },
+      },
+      { strictInputType: false }
+    );
+    expect(handleValidation({}).formErrors).toEqual(undefined);
+    expect(handleValidation({ zero_only: 1 }).formErrors).toEqual({
+      zero_only: 'The only accepted value is 0.',
+    });
+    expect(handleValidation({ zero_only: 0 }).formErrors).toBeUndefined();
+    // null is also considered valid until we fix @BUG RMT-518
+    // Expectation: To fail with error "The only accepted value is 0."
+    expect(handleValidation({ zero_only: null }).formErrors).toBeUndefined();
+  });
+
   it('Should work for text', () => {
     const { handleValidation } = createHeadlessForm(
       {
@@ -96,3 +115,45 @@ describe('validations: const', () => {
     expect(fields[0]).toMatchObject({ value: 10, const: 10, default: 10 });
   });
 });
+
+describe('const/default with forced values', () => {
+  it('Should work for when the number is 0', () => {
+    const { fields, handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          zero_only: { type: 'number', const: 0, default: 0 },
+        },
+      },
+      { strictInputType: false }
+    );
+    expect(handleValidation({}).formErrors).toEqual(undefined);
+    expect(handleValidation({ zero_only: 1 }).formErrors).toEqual({
+      zero_only: 'The only accepted value is 0.',
+    });
+    expect(fields[0]).toMatchObject({ value: 0, const: 0, default: 0 });
+    expect(handleValidation({ zero_only: 0 }).formErrors).toBeUndefined();
+    // null is also considered valid until we fix @BUG RMT-518
+    // Expectation: To fail with error "The only accepted value is 0."
+    expect(handleValidation({ zero_only: null }).formErrors).toBeUndefined();
+  });
+
+  it('Should work for number', () => {
+    const { fields, handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          ten_only: { type: 'number', const: 10, default: 10 },
+        },
+      },
+      { strictInputType: false }
+    );
+    expect(handleValidation({}).formErrors).toEqual(undefined);
+    expect(handleValidation({ ten_only: 1 }).formErrors).toEqual({
+      ten_only: 'The only accepted value is 10.',
+    });
+    expect(handleValidation({ ten_only: 10 }).formErrors).toBeUndefined();
+    expect(fields[0]).toMatchObject({ value: 10, const: 10, default: 10 });
+    // null is also considered valid until we fix @BUG RMT-518
+    // Expectation: To fail with error "The only accepted value is 10."
+    expect(handleValidation({ ten_only: null }).formErrors).toBeUndefined();
+  });
+});

package/src/tests/createHeadlessForm.test.js

@@ -38,6 +38,7 @@ import {
   mockFileInput,
   mockRadioCardInput,
   mockRadioCardExpandableInput,
+  mockTelWithPattern,
   mockTextInput,
   mockTextInputDeprecated,
   mockNumberInput,
@@ -1442,6 +1443,51 @@ describe('createHeadlessForm', () => {
       });
     });
 
+    it('supports oneOf pattern validation', () => {
+      const result = createHeadlessForm(mockTelWithPattern);
+
+      expect(result).toMatchObject({
+        fields: [
+          {
+            label: 'Phone number',
+            name: 'phone_number',
+            type: 'tel',
+            required: false,
+            options: [
+              {
+                label: 'Portugal',
+                pattern: '^(\\+351)[0-9]{9,}$',
+              },
+              {
+                label: 'United Kingdom (UK)',
+                pattern: '^(\\+44)[0-9]{1,}$',
+              },
+              {
+                label: 'Bolivia',
+                pattern: '^(\\+591)[0-9]{9,}$',
+              },
+              {
+                label: 'Canada',
+                pattern: '^(\\+1)(206|224)[0-9]{1,}$',
+              },
+              {
+                label: 'United States',
+                pattern: '^(\\+1)[0-9]{1,}$',
+              },
+            ],
+          },
+        ],
+      });
+
+      const fieldValidator = result.fields[0].schema;
+
+      expect(fieldValidator.isValidSync('+351123123123')).toBe(true);
+      expect(() => fieldValidator.validateSync('+35100')).toThrowError(
+        'The option "+35100" is not valid.'
+      );
+      expect(fieldValidator.isValidSync(undefined)).toBe(true);
+    });
+
     describe('supports "fieldset" field type', () => {
       it('supports basic case', () => {
         const result = createHeadlessForm({
@@ -1947,9 +1993,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

@@ -453,6 +453,46 @@ export const mockCheckboxInput = {
   type: 'string',
 };
 
+export const mockTelWithPattern = {
+  properties: {
+    phone_number: {
+      title: 'Phone number',
+      description: 'Enter your telephone number',
+      type: 'string',
+      'x-jsf-presentation': {
+        inputType: 'tel',
+      },
+      oneOf: [
+        {
+          title: 'Portugal',
+          pattern: '^(\\+351)[0-9]{9,}$',
+          'x-jsf-presentation': { meta: { countryCode: '351' } },
+        },
+        {
+          title: 'United Kingdom (UK)',
+          pattern: '^(\\+44)[0-9]{1,}$',
+          'x-jsf-presentation': { meta: { countryCode: '44' } },
+        },
+        {
+          title: 'Bolivia',
+          pattern: '^(\\+591)[0-9]{9,}$',
+          'x-jsf-presentation': { meta: { countryCode: '591' } },
+        },
+        {
+          title: 'Canada',
+          pattern: '^(\\+1)(206|224)[0-9]{1,}$',
+          'x-jsf-presentation': { meta: { countryCode: '1' } },
+        },
+        {
+          title: 'United States',
+          pattern: '^(\\+1)[0-9]{1,}$',
+          'x-jsf-presentation': { meta: { countryCode: '1' } },
+        },
+      ],
+    },
+  },
+};
+
 /**
  * Compose a schema with lower chance of human error
  * @param {Object} schema version
@@ -463,6 +503,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 +704,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 +724,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 +735,11 @@ export const schemaInputWithStatementDeprecated = JSONSchemaBuilder()
         },
       },
     },
-  })
-  .build();
+  },
+};
 
-export const schemaInputWithExtra = JSONSchemaBuilder()
-  .addInput({
+export const schemaInputWithExtra = {
+  properties: {
     bonus: {
       title: 'Bonus',
       'x-jsf-presentation': {
@@ -772,11 +757,11 @@ export const schemaInputWithExtra = JSONSchemaBuilder()
         `,
       },
     },
-  })
-  .build();
+  },
+};
 
-export const schemaInputWithCustomDescription = JSONSchemaBuilder()
-  .addInput({
+export const schemaInputWithCustomDescription = {
+  properties: {
     other: {
       title: 'Other',
       'x-jsf-presentation': {
@@ -785,8 +770,8 @@ export const schemaInputWithCustomDescription = JSONSchemaBuilder()
       },
       type: 'string',
     },
-  })
-  .build();
+  },
+};
 
 export const schemaInputDeprecated = JSONSchemaBuilder()
   .addInput({