@remoteoss/json-schema-form 0.4.4-dev.20230830125207 → 0.4.5-beta.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+#### 0.4.5-beta.0 (2023-08-31)
+
+##### Changes
+
+* Allow validation of consts to support single values ([#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))
+
 #### 0.4.3-beta.0 (2023-08-09)
 
 ##### Bug fixes

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.4.4-dev.20230830125207
- Generated: Wed, 30 Aug 2023 12:52:17 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.5-beta.0
+ Generated: Thu, 31 Aug 2023 07:23:05 GMT
 
  MIT License
 
@@ -606,6 +606,13 @@ function buildYupSchema(field, config) {
       }) : true
     );
   }
+  function withConst(yupSchema) {
+    return yupSchema.test(
+      "isConst",
+      errorMessage.const ?? errorMessageFromConfig.const ?? `The only accepted value is ${propertyFields.const}.`,
+      (value) => propertyFields.required === false && value === void 0 || value === null || value === propertyFields.const
+    );
+  }
   function withBaseSchema() {
     const customErrorMsg = errorMessage.type || errorMessageFromConfig.type;
     if (customErrorMsg) {
@@ -673,6 +680,9 @@ function buildYupSchema(field, config) {
   if (propertyFields.accept) {
     validators.push(withFileFormat);
   }
+  if (propertyFields.const) {
+    validators.push(withConst);
+  }
   return (0, import_flow.default)(validators);
 }
 function getNoSortEdges(fields = []) {
@@ -943,6 +953,7 @@ function extractParametersFromNode(schemaNode) {
   const statementDescription = containsHTML(presentation.statement?.description) ? wrapWithSpan(presentation.statement.description, { class: "jsf-statement" }) : presentation.statement?.description;
   return (0, import_omitBy.default)(
     {
+      const: node.const,
       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.4.4-dev.20230830125207
- Generated: Wed, 30 Aug 2023 12:52:17 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.5-beta.0
+ Generated: Thu, 31 Aug 2023 07:23:05 GMT
 
  MIT License
 
@@ -570,6 +570,13 @@ function buildYupSchema(field, config) {
       }) : true
     );
   }
+  function withConst(yupSchema) {
+    return yupSchema.test(
+      "isConst",
+      errorMessage.const ?? errorMessageFromConfig.const ?? `The only accepted value is ${propertyFields.const}.`,
+      (value) => propertyFields.required === false && value === void 0 || value === null || value === propertyFields.const
+    );
+  }
   function withBaseSchema() {
     const customErrorMsg = errorMessage.type || errorMessageFromConfig.type;
     if (customErrorMsg) {
@@ -637,6 +644,9 @@ function buildYupSchema(field, config) {
   if (propertyFields.accept) {
     validators.push(withFileFormat);
   }
+  if (propertyFields.const) {
+    validators.push(withConst);
+  }
   return flow(validators);
 }
 function getNoSortEdges(fields = []) {
@@ -907,6 +917,7 @@ function extractParametersFromNode(schemaNode) {
   const statementDescription = containsHTML(presentation.statement?.description) ? wrapWithSpan(presentation.statement.description, { class: "jsf-statement" }) : presentation.statement?.description;
   return omitBy(
     {
+      const: node.const,
       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.4.4-dev.20230830125207
- Generated: Wed, 30 Aug 2023 12:52:17 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.5-beta.0
+ Generated: Thu, 31 Aug 2023 07:23:05 GMT
 
  MIT License
 
@@ -11546,6 +11546,13 @@ function buildYupSchema(field, config) {
       }) : true
     );
   }
+  function withConst(yupSchema) {
+    return yupSchema.test(
+      "isConst",
+      errorMessage.const ?? errorMessageFromConfig.const ?? `The only accepted value is ${propertyFields.const}.`,
+      (value) => propertyFields.required === false && value === void 0 || value === null || value === propertyFields.const
+    );
+  }
   function withBaseSchema() {
     const customErrorMsg = errorMessage.type || errorMessageFromConfig.type;
     if (customErrorMsg) {
@@ -11613,6 +11620,9 @@ function buildYupSchema(field, config) {
   if (propertyFields.accept) {
     validators.push(withFileFormat);
   }
+  if (propertyFields.const) {
+    validators.push(withConst);
+  }
   return (0, import_flow.default)(validators);
 }
 function getNoSortEdges(fields = []) {
@@ -11883,6 +11893,7 @@ function extractParametersFromNode(schemaNode) {
   const statementDescription = containsHTML(presentation.statement?.description) ? wrapWithSpan(presentation.statement.description, { class: "jsf-statement" }) : presentation.statement?.description;
   return (0, import_omitBy.default)(
     {
+      const: node.const,
       label: node.title,
       readOnly: node.readOnly,
       ...node.deprecated && {

package/package.json

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

@@ -0,0 +1,86 @@
+import { createHeadlessForm } from '../createHeadlessForm';
+
+describe('validations: const', () => {
+  it('Should work for number', () => {
+    const { handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          ten_only: { type: 'number', const: 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();
+    // 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();
+  });
+
+  it('Should work for text', () => {
+    const { handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          hello_only: { type: 'string', const: 'hello' },
+        },
+      },
+      { strictInputType: false }
+    );
+    expect(handleValidation({}).formErrors).toEqual(undefined);
+    expect(handleValidation({ hello_only: 'what' }).formErrors).toEqual({
+      hello_only: 'The only accepted value is hello.',
+    });
+    expect(handleValidation({ hello_only: 'hello' }).formErrors).toEqual(undefined);
+  });
+
+  it('Should work for a conditionally applied const', () => {
+    const { handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          answer: { type: 'string', oneOf: [{ const: 'yes' }, { const: 'no' }] },
+          amount: {
+            description: 'If you select yes, this needs to be exactly 10.',
+            type: 'number',
+          },
+        },
+        allOf: [
+          {
+            if: { properties: { answer: { const: 'yes' } }, required: ['answer'] },
+            then: { properties: { amount: { const: 10 } }, required: ['amount'] },
+          },
+        ],
+      },
+      { strictInputType: false }
+    );
+    expect(handleValidation({}).formErrors).toEqual(undefined);
+    expect(handleValidation({ answer: 'no' }).formErrors).toEqual(undefined);
+    expect(handleValidation({ answer: 'yes' }).formErrors).toEqual({ amount: 'Required field' });
+    expect(handleValidation({ answer: 'yes', amount: 1 }).formErrors).toEqual({
+      amount: 'The only accepted value is 10.',
+    });
+    expect(handleValidation({ answer: 'yes', amount: 10 }).formErrors).toEqual(undefined);
+  });
+
+  it('Should show the custom error message', () => {
+    const { handleValidation } = createHeadlessForm(
+      {
+        properties: {
+          string: {
+            type: 'string',
+            const: 'hello',
+            'x-jsf-errorMessage': { const: 'You must say hello!!!' },
+          },
+        },
+      },
+      { strictInputType: false }
+    );
+    expect(handleValidation({}).formErrors).toEqual(undefined);
+    expect(handleValidation({ string: 'hi' }).formErrors).toEqual({
+      string: 'You must say hello!!!',
+    });
+    expect(handleValidation({ string: 'hello' }).formErrors).toEqual(undefined);
+  });
+});

package/src/tests/helpers.custom.js

@@ -207,7 +207,6 @@ export const schemaInputTypeHidden = {
       title: 'Select multi hidden',
       default: ['Albania, Algeria'],
       'x-jsf-presentation': { inputType: 'hidden' },
-      const: ['Albania, Algeria'],
       type: 'array',
     },
   },