Merge remote-tracking branch 'origin/inline-rule-handling' into conditionals-json-logic

Author: brennj

CHANGELOG.md

@@ -1,3 +1,18 @@
+#### 0.6.1-beta.0 (2023-09-13)
+
+##### Changes
+
+
+
+- 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
+
+- 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)
 
 ##### Changes

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "0.4.5-beta.0",
+  "version": "0.6.1-beta.0",
   "description": "Headless UI form powered by JSON Schemas",
   "author": "Remote.com <[email protected]> (https://remote.com/)",
   "license": "MIT",

package.json

@@ -497,6 +497,7 @@ export function extractParametersFromNode(schemaNode) {
   return omitBy(
     {
       const: node.const,
+      ...(node.const && node.default ? { value: node.const } : {}),
       label: node.title,
       readOnly: node.readOnly,
       ...(node.deprecated && {

src/helpers.js

@@ -16,10 +16,6 @@ import { buildYupSchema } from './yupSchema';
  * @returns {Object} An object containing:
  * - scopes {Map} - A Map of the validation scopes (with IDs as keys)
  * - getScope {Function} - Function to retrieve a scope by name/ID
- * - validate {Function} - Function to evaluate a validation rule
- * - applyValidationRuleInCondition {Function} - Evaluate a validation rule used in a condition
- * - applyComputedValueInField {Function} - Evaluate a computed value rule for a field
- * - applyComputedValueRuleInCondition {Function} - Evaluate a computed value rule used in a condition
  */
 export function createValidationChecker(schema) {
   const scopes = new Map();
@@ -50,6 +46,21 @@ export function createValidationChecker(schema) {
   };
 }
 
+/**
+ * Creates a validation scope object for a schema.
+ *
+ * Builds maps of validations and computed values defined in the schema's
+ * x-jsf-logic section. Includes functions to evaluate the rules.
+ *
+ * @param {Object} schema - The JSON schema
+ * @returns {Object} The validation scope object containing:
+ * - validationMap - Map of validation rules
+ * - computedValuesMap - Map of computed value rules
+ * - validate {Function} - Function to evaluate a validation rule
+ * - applyValidationRuleInCondition {Function} - Evaluate a validation rule used in a condition
+ * - applyComputedValueInField {Function} - Evaluate a computed value rule for a field
+ * - applyComputedValueRuleInCondition {Function} - Evaluate a computed value rule used in a condition
+ */
 function createValidationsScope(schema) {
   const validationMap = new Map();
   const computedValuesMap = new Map();
@@ -162,6 +173,20 @@ export function yupSchemaWithCustomJSONLogic({ field, logic, config, id }) {
 
 const HANDLEBARS_REGEX = /\{\{([^{}]+)\}\}/g;
 
+/**
+ * Replaces Handlebars templates in a value with computed values.
+ *
+ * Handles recursively replacing Handlebars templates "{{var}}" in strings
+ * with computed values looked up from the validation logic.
+ *
+ * @param {Object} options - Options object
+ * @param {*} options.value - The value to replace templates in
+ * @param {Object} options.logic - The validation logic object
+ * @param {Object} options.formValues - The current form values
+ * @param {string} options.parentID - The ID of the validation scope
+ * @param {string} options.name - The name of the field
+ * @returns {*} The value with templates replaced with computed values
+ */
 function replaceHandlebarsTemplates({
   value: toReplace,
   logic,
@@ -397,8 +422,18 @@ function throwIfUnknownOperator(operator, subRule, id) {
   }
 }
 
+const regexToGetIndices = /\.\d+\./g; // eg. .0., .10.
+
+/**
+ * Removes array indices from a json schema path string.
+ * Converts paths like "foo.0.bar" to "foo.bar".
+ * This allows checking if a variable exists in an array item schema without needing the specific index.
+ *
+ * @param {string} path - The json schema path potentially containing array indices
+ * @returns {string} The path with array indices removed
+ */
 function removeIndicesFromPath(path) {
-  const intermediatePath = path.replace(/\.\d+\./g, '.');
+  const intermediatePath = path.replace(regexToGetIndices, '.');
   return intermediatePath.replace(/\.\d+$/, '');
 }
 

src/jsonLogic.js

@@ -83,4 +83,16 @@ describe('validations: const', () => {
     });
     expect(handleValidation({ string: 'hello' }).formErrors).toEqual(undefined);
   });
+
+  it('Should have value attribute for when const & default is present', () => {
+    const { fields } = createHeadlessForm(
+      {
+        properties: {
+          ten_only: { type: 'number', const: 10, default: 10 },
+        },
+      },
+      { strictInputType: false }
+    );
+    expect(fields[0]).toMatchObject({ value: 10, const: 10, default: 10 });
+  });
 });

src/tests/const.test.js

@@ -227,6 +227,24 @@ export const schemaWithComputedAttributes = {
   },
 };
 
+export const schemaWithInlineRuleForComputedAttributeWithoutCopy = {
+  properties: {
+    field_a: {
+      type: 'number',
+    },
+    field_b: {
+      type: 'number',
+      'x-jsf-logic-computedAttrs': {
+        title: {
+          rule: {
+            '+': [{ var: 'field_a' }, 10],
+          },
+        },
+      },
+    },
+  },
+};
+
 export const schemaWithComputedAttributeThatDoesntExist = {
   properties: {
     field_a: {
@@ -463,7 +481,7 @@ export const schemaWithInlineMultipleRulesForComputedAttributes = {
   },
 };
 
-export const schemaSelfContainedValueForTitle = {
+export const schemaInlineComputedAttrForTitle = {
   properties: {
     field_a: {
       type: 'number',
@@ -482,7 +500,7 @@ export const schemaSelfContainedValueForTitle = {
   },
 };
 
-export const schemaSelfContainedValueForMaximumMinimumValues = {
+export const schemaInlineComputedAttrForMaximumMinimumValues = {
   properties: {
     field_a: {
       type: 'number',

src/tests/jsonLogic.fixtures.js

@@ -4,9 +4,9 @@ import {
   createSchemaWithRulesOnFieldA,
   createSchemaWithThreePropertiesWithRuleOnFieldA,
   multiRuleSchema,
-  schemaSelfContainedValueForMaximumMinimumValues,
-  schemaSelfContainedValueForTitle,
   schemaWhereValidationAndComputedValueIsAppliedOnNormalThenStatement,
+  schemaInlineComputedAttrForMaximumMinimumValues,
+  schemaInlineComputedAttrForTitle,
   schemaWithBadOperation,
   schemaWithChecksAndThenValidationsOnThen,
   schemaWithComputedAttributeThatDoesntExist,
@@ -384,18 +384,18 @@ describe('jsonLogic: cross-values validations', () => {
       expect(fieldB.description).toEqual('Must be between 5 and 20.');
     });
 
-    it('Use a self contained rule in a schema for a title but it just uses the value', () => {
-      const { fields, handleValidation } = createHeadlessForm(schemaSelfContainedValueForTitle, {
+    it('Use an inline rule in a schema for a title but it just uses the value', () => {
+      const { fields, handleValidation } = createHeadlessForm(schemaInlineComputedAttrForTitle, {
         strictInputType: false,
       });
       const [, fieldB] = fields;
       expect(handleValidation({ field_a: 10, field_b: null }).formErrors).toEqual(undefined);
       expect(fieldB.label).toEqual('20');
     });
 
-    it('Use a self contained rule for a minimum, maximum value', () => {
+    it('Use an inline rule for a minimum, maximum value', () => {
       const { fields, handleValidation } = createHeadlessForm(
-        schemaSelfContainedValueForMaximumMinimumValues,
+        schemaInlineComputedAttrForMaximumMinimumValues,
         {
           strictInputType: false,
         }