@remoteoss/json-schema-form 0.6.5-beta.0 → 0.7.0-dev.20230928101050

package/CHANGELOG.md

@@ -2,36 +2,66 @@
 
 ##### 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.7.0-dev.20230928101050
+ Generated: Thu, 28 Sep 2023 10:11:18 GMT
 
  MIT License
 
@@ -91,13 +91,6 @@ function convertDiskSizeFromTo(from, to) {
     return value * Math.pow(1024, units.indexOf(from.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
   };
 }
-function containsHTML(str = "") {
-  return /<[a-z][\s\S]*>/i.test(str);
-}
-function wrapWithSpan(html, properties = {}) {
-  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
-  return `<span ${attributes}>${html}</span>`;
-}
 function hasProperty(object2, propertyName) {
   return Object.prototype.hasOwnProperty.call(object2, propertyName);
 }
@@ -1329,7 +1322,7 @@ function extractParametersFromNode(schemaNode) {
   const decoratedComputedAttributes = getDecoratedComputedAttributes(computedAttributes);
   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 statementDescription = presentation.statement?.description;
   return (0, import_omitBy.default)(
     {
       const: node.const,
@@ -1370,10 +1363,8 @@ function extractParametersFromNode(schemaNode) {
       ...presentation,
       jsonLogicValidations,
       computedAttributes: decoratedComputedAttributes,
-      description: containsHTML(description) ? wrapWithSpan(description, {
-        class: "jsf-description"
-      }) : description,
-      extra: containsHTML(presentation.extra) ? wrapWithSpan(presentation.extra, { class: "jsf-extra" }) : presentation.extra,
+      description,
+      extra: presentation.extra,
       statement: presentation.statement && {
         ...presentation.statement,
         description: statementDescription

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.7.0-dev.20230928101050
+ Generated: Thu, 28 Sep 2023 10:11:18 GMT
 
  MIT License
 
@@ -55,13 +55,6 @@ function convertDiskSizeFromTo(from, to) {
     return value * Math.pow(1024, units.indexOf(from.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
   };
 }
-function containsHTML(str = "") {
-  return /<[a-z][\s\S]*>/i.test(str);
-}
-function wrapWithSpan(html, properties = {}) {
-  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
-  return `<span ${attributes}>${html}</span>`;
-}
 function hasProperty(object2, propertyName) {
   return Object.prototype.hasOwnProperty.call(object2, propertyName);
 }
@@ -1293,7 +1286,7 @@ function extractParametersFromNode(schemaNode) {
   const decoratedComputedAttributes = getDecoratedComputedAttributes(computedAttributes);
   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 statementDescription = presentation.statement?.description;
   return omitBy(
     {
       const: node.const,
@@ -1334,10 +1327,8 @@ function extractParametersFromNode(schemaNode) {
       ...presentation,
       jsonLogicValidations,
       computedAttributes: decoratedComputedAttributes,
-      description: containsHTML(description) ? wrapWithSpan(description, {
-        class: "jsf-description"
-      }) : description,
-      extra: containsHTML(presentation.extra) ? wrapWithSpan(presentation.extra, { class: "jsf-extra" }) : presentation.extra,
+      description,
+      extra: presentation.extra,
       statement: presentation.statement && {
         ...presentation.statement,
         description: statementDescription

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.7.0-dev.20230928101050
+ Generated: Thu, 28 Sep 2023 10:11:18 GMT
 
  MIT License
 
@@ -11410,13 +11410,6 @@ function convertDiskSizeFromTo(from2, to) {
     return value * Math.pow(1024, units.indexOf(from2.toLowerCase())) / Math.pow(1024, units.indexOf(to.toLowerCase()));
   };
 }
-function containsHTML(str = "") {
-  return /<[a-z][\s\S]*>/i.test(str);
-}
-function wrapWithSpan(html, properties = {}) {
-  const attributes = Object.entries(properties).reduce((acc, [key, value]) => `${acc}${key}="${value}" `, "").trim();
-  return `<span ${attributes}>${html}</span>`;
-}
 function hasProperty(object2, propertyName) {
   return Object.prototype.hasOwnProperty.call(object2, propertyName);
 }
@@ -12647,7 +12640,7 @@ function extractParametersFromNode(schemaNode) {
   const decoratedComputedAttributes = getDecoratedComputedAttributes(computedAttributes);
   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 statementDescription = presentation.statement?.description;
   return (0, import_omitBy.default)(
     {
       const: node.const,
@@ -12688,10 +12681,8 @@ function extractParametersFromNode(schemaNode) {
       ...presentation,
       jsonLogicValidations,
       computedAttributes: decoratedComputedAttributes,
-      description: containsHTML(description) ? wrapWithSpan(description, {
-        class: "jsf-description"
-      }) : description,
-      extra: containsHTML(presentation.extra) ? wrapWithSpan(presentation.extra, { class: "jsf-extra" }) : presentation.extra,
+      description,
+      extra: presentation.extra,
       statement: presentation.statement && {
         ...presentation.statement,
         description: statementDescription

package/package.json

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

@@ -2040,10 +2040,7 @@ describe('createHeadlessForm', () => {
       });
 
       expect(result).toMatchObject({
-        fields: [
-          { description: 'I am regular' },
-          { description: '<span class="jsf-description">I am <b>bold</b>.</span>' },
-        ],
+        fields: [{ description: 'I am regular' }, { description: 'I am <b>bold</b>.' }],
       });
     });
 
@@ -2502,7 +2499,7 @@ describe('createHeadlessForm', () => {
   });
 
   describe('when a field has conditional presentation properties', () => {
-    it('adds .jsf-statement to nested statement markup when visible', () => {
+    it('returns the nested properties when the conditional matches', () => {
       const { fields } = createHeadlessForm(schemaWithConditionalPresentationProperties, {
         initialValues: {
           // show the hidden statement
@@ -2510,9 +2507,7 @@ describe('createHeadlessForm', () => {
         },
       });
 
-      expect(fields[0].statement.description).toBe(
-        `<span class="jsf-statement"><a href="">conditional statement markup</a></span>`
-      );
+      expect(fields[0].statement.description).toBe(`<a href="">conditional statement markup</a>`);
     });
   });
 
@@ -3710,7 +3705,7 @@ describe('createHeadlessForm', () => {
       expect(fields).toMatchObject([
         {
           name: 'time',
-          description: '<span class="jsf-description">Write in <b>hh:ss</b> format</span>', // from presentation
+          description: 'Write in <b>hh:ss</b> format', // from presentation
           inputType: 'clock', // arbitrary type from presentation
           deprecated: {
             description: 'In favor of X', // from presentation