@remoteoss/json-schema-form 0.6.5-beta.0 → 0.6.6-beta.0

package/CHANGELOG.md

@@ -1,37 +1,77 @@
+#### 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
 
-- Add conditional logic checking for json-logic ([#41](https://github.com/remoteoss/json-schema-form/pull/41)) ([6292b01e](https://github.com/remoteoss/json-schema-form/commit/6292b01e3f77a9038328d7375080ffc4cb30dbc8))
+- 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:
+
+  - `validations` - JsonLogic rules that validate fields and return booleans
+  - `computedValues` - JsonLogic rules that compute dynamic values
+  - `allOf.if/then/else` - Conditional logic using validations and computedValues
+
+- New property `x-jsf-logic-validations` added to individual schema properties. Lists the validation names that should run on that property.
+- New property `x-jsf-logic-computedAttrs` added to individual schema properties. Allows computed values to be used for attributes like `title`, `description`, `const`, etc.
+- Computed values and validations defined in `x-jsf-logic` can reference schema properties using `vars` and any syntax supported from [JsonLogic](https://jsonlogic.com/).
+
+- Conditional logic blocks allow selectively requiring fields or applying attributes based on validations/computed values.
+
+While docs are underway, you can read examples from all the [tests](https://github.com/remoteoss/json-schema-form/blob/main/src/tests/jsonLogic.test.js) along with the [sample schemas](https://github.com/remoteoss/json-schema-form/blob/main/src/tests/jsonLogic.fixtures.js).
+
+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))
+
+
 
-*  Inline rule handling for computedAttrs ([#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)
 
 ##### Changes
 
+- 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))
+
 
 
-- Computed string based values for json-logic ([#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))
+
+
 
-- Computed Attributes ([#36](https://github.com/remoteoss/json-schema-form/pull/36)) ([80c29589](https://github.com/remoteoss/json-schema-form/commit/80c29589ac0972e0f33add70a59df15a46db1b43))
-- JSON Logic Skeleton ([#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))
+
 
-##### 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)
 

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.6.5-beta.0
- Generated: Mon, 18 Sep 2023 10:09:01 GMT
+ NPM Package: @remoteoss/json-schema-form@0.6.6-beta.0
+ Generated: Tue, 17 Oct 2023 13:38:25 GMT
 
  MIT License
 
@@ -701,7 +701,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) {
@@ -1330,10 +1330,11 @@ function extractParametersFromNode(schemaNode) {
   const node = (0, import_omit.default)(schemaNode, ["x-jsf-presentation", "presentation"]);
   const description = presentation?.description || node.description;
   const statementDescription = containsHTML(presentation.statement?.description) ? wrapWithSpan(presentation.statement.description, { class: "jsf-statement" }) : 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.6.5-beta.0
- Generated: Mon, 18 Sep 2023 10:09:01 GMT
+ NPM Package: @remoteoss/json-schema-form@0.6.6-beta.0
+ Generated: Tue, 17 Oct 2023 13:38:25 GMT
 
  MIT License
 
@@ -665,7 +665,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) {
@@ -1294,10 +1294,11 @@ function extractParametersFromNode(schemaNode) {
   const node = omit(schemaNode, ["x-jsf-presentation", "presentation"]);
   const description = presentation?.description || node.description;
   const statementDescription = containsHTML(presentation.statement?.description) ? wrapWithSpan(presentation.statement.description, { class: "jsf-statement" }) : 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.6.5-beta.0
- Generated: Mon, 18 Sep 2023 10:09:01 GMT
+ NPM Package: @remoteoss/json-schema-form@0.6.6-beta.0
+ Generated: Tue, 17 Oct 2023 13:38:25 GMT
 
  MIT License
 
@@ -12019,7 +12019,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) {
@@ -12648,10 +12648,11 @@ function extractParametersFromNode(schemaNode) {
   const node = (0, import_omit.default)(schemaNode, ["x-jsf-presentation", "presentation"]);
   const description = presentation?.description || node.description;
   const statementDescription = containsHTML(presentation.statement?.description) ? wrapWithSpan(presentation.statement.description, { class: "jsf-statement" }) : 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.6.5-beta.0",
+  "version": "0.6.6-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

@@ -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();
+  });
+});