@remoteoss/json-schema-form 0.3.0-beta.0 → 0.4.1-beta.0

package/CHANGELOG.md

@@ -1,22 +1,37 @@
+#### 0.4.1-beta.0 (2023-07-03)
+
+##### Bug Fixes
+
+* **fieldset:**  support root conditionals for fieldsets ([#23](https://github.com/remoteoss/json-schema-form/pull/23)) ([65d87b3a](https://github.com/remoteoss/json-schema-form/commit/65d87b3a93018f0729aed565000eb2a2ce1f2ce7))
+* **select/radio:**  Accept just the values in options (plus `''` and `null` for backward-compatibility) ([#18](https://github.com/remoteoss/json-schema-form/pull/18)) ([37501d2d](https://github.com/remoteoss/json-schema-form/commit/37501d2ddafdd5e207b34d2ca3f6b7b7a1006e9d))
+
+#### 0.4.0-beta.0 (2023-06-22)
+
+##### New Features
+
+BREAKING CHANGES:
+
+- **Radio/Select:** In each option, spread `x-jsf-presentation` value to option root ([#17](https://github.com/remoteoss/json-schema-form/pull/17)) ([367688c2](https://github.com/remoteoss/json-schema-form/commit/367688c24e212c1a0a1d2e7b19cbd7efa7021a15))
+
 #### 0.3.0-beta.0 (2023-06-21)
 
 ##### Fixes
 
-- Fix validation for text schema to only validate strings ([#12](https://github.com/remoteoss/json-schema-form/pull/12)) ([00017c0](https://github.com/remoteoss/json-schema-form/commit/00017c056d8a3583d56d9fefc4d3c7e0f4c1dd99))
+- **Text:** Fix validation to only accept strings ([#12](https://github.com/remoteoss/json-schema-form/pull/12)) ([00017c0](https://github.com/remoteoss/json-schema-form/commit/00017c056d8a3583d56d9fefc4d3c7e0f4c1dd99))
 
 ##### Chores
 
-- Update yup version to v.0.30.0 ([#12](https://github.com/remoteoss/json-schema-form/pull/12)) ([00017c0](https://github.com/remoteoss/json-schema-form/commit/00017c056d8a3583d56d9fefc4d3c7e0f4c1dd99))
+- Update Yup to v.0.30.0 ([#12](https://github.com/remoteoss/json-schema-form/pull/12)) ([00017c0](https://github.com/remoteoss/json-schema-form/commit/00017c056d8a3583d56d9fefc4d3c7e0f4c1dd99))
 
 #### 0.2.0-beta.0 (2023-06-20)
 
 ##### New Features
 
-- Add typescript declarations to the library ([2404188c](https://github.com/remoteoss/json-schema-form/commit/2404188cba52a5a665f257430a65a0ebb938dd44))
+- Add Typescript declarations to the library ([2404188c](https://github.com/remoteoss/json-schema-form/commit/2404188cba52a5a665f257430a65a0ebb938dd44))
 
 ##### Fixes
 
-- Support maximum 0 ([#10](https://github.com/remoteoss/json-schema-form/pull/10)) ([1e9d6cf9](https://github.com/remoteoss/json-schema-form/commit/1e9d6cf96436cf16018e045b351567c643e10dac))
+- **Number:** Support maximum 0 ([#10](https://github.com/remoteoss/json-schema-form/pull/10)) ([1e9d6cf9](https://github.com/remoteoss/json-schema-form/commit/1e9d6cf96436cf16018e045b351567c643e10dac))
 
 ##### Chores
 

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.3.0-beta.0
- Generated: Wed, 21 Jun 2023 11:17:55 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.1-beta.0
+ Generated: Mon, 03 Jul 2023 22:21:10 GMT
 
  MIT License
 
@@ -383,8 +383,17 @@ var validateOnlyStrings = (0, import_yup.string)().trim().nullable().test(
 );
 var yupSchemas = {
   text: validateOnlyStrings,
-  select: (0, import_yup.string)().trim().nullable(),
-  radio: (0, import_yup.string)().trim().nullable(),
+  radioOrSelect: (options) => (0, import_yup.string)().nullable().transform((value) => {
+    if (value === "") {
+      return void 0;
+    }
+    if (options?.includes(null)) {
+      return value;
+    }
+    return value === null ? void 0 : value;
+  }).oneOf(options, ({ value }) => {
+    return `The option ${JSON.stringify(value)} is not valid.`;
+  }),
   date: (0, import_yup.string)().nullable().trim().matches(
     /(?:\d){4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-9]|3[0-1])/,
     `Must be a valid date in ${DEFAULT_DATE_FORMAT.toLocaleLowerCase()} format. e.g. ${todayDateHint}`
@@ -419,18 +428,33 @@ function getRequiredErrorMessage(inputType, { inlineError, configError }) {
   return "Required field";
 }
 var getJsonTypeInArray = (jsonType) => Array.isArray(jsonType) ? jsonType.find((val) => val !== "null") : jsonType;
+var getOptions = (field) => {
+  const allValues = field.options?.map((option) => option.value);
+  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;
+};
+var getYupSchema = ({ inputType, ...field }) => {
+  const jsonType = getJsonTypeInArray(field.jsonType);
+  if (field.options?.length > 0) {
+    const optionValues = getOptions(field);
+    return yupSchemas.radioOrSelect(optionValues);
+  }
+  return yupSchemas[inputType] || yupSchemasToJsonTypes[jsonType];
+};
 function buildYupSchema(field, config) {
   const { inputType, jsonType: jsonTypeValue, errorMessage = {}, ...propertyFields } = field;
   const isCheckboxBoolean = typeof propertyFields.checkboxValue === "boolean";
   let baseSchema;
-  const jsonType = getJsonTypeInArray(jsonTypeValue);
   const errorMessageFromConfig = config?.inputTypes?.[inputType]?.errorMessage || {};
   if (propertyFields.multiple) {
     baseSchema = yupSchemas.multiple[inputType] || yupSchemasToJsonTypes.array;
   } else if (isCheckboxBoolean) {
     baseSchema = yupSchemas.checkboxBool;
   } else {
-    baseSchema = yupSchemas[inputType] || yupSchemasToJsonTypes[jsonType];
+    baseSchema = getYupSchema(field);
   }
   if (!baseSchema) {
     return import_noop.default;
@@ -630,8 +654,17 @@ function checkIfConditionMatches(node, formValues, formFields) {
     if (currentProperty.enum) {
       return currentProperty.enum.includes(value);
     }
-    const { inputType } = getField(name, formFields);
-    return validateFieldSchema({ ...currentProperty, inputType, required: true }, value);
+    const field = getField(name, formFields);
+    return validateFieldSchema(
+      {
+        options: field.options,
+        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
+        ...currentProperty,
+        inputType: field.inputType,
+        required: true
+      },
+      value
+    );
   });
 }
 function isFieldFilled(fieldValue) {
@@ -804,12 +837,26 @@ function updateFieldsProperties(fields, formValues, jsonSchema) {
   clearValuesIfNotVisible(fields, formValues);
 }
 var notNullOption = (opt) => opt.const !== null;
+function flatPresentation(item) {
+  return Object.entries(item).reduce((newItem, [key, value]) => {
+    if (key === "x-jsf-presentation") {
+      return {
+        ...newItem,
+        ...value
+      };
+    }
+    return {
+      ...newItem,
+      [key]: value
+    };
+  }, {});
+}
 function getFieldOptions(node, presentation) {
   function convertToOptions(nodeOptions) {
     return nodeOptions.filter(notNullOption).map(({ title, const: cons, ...item }) => ({
       label: title,
       value: cons,
-      ...item
+      ...flatPresentation(item)
     }));
   }
   if (presentation.options) {
@@ -925,30 +972,38 @@ var handleValuesChange = (fields, jsonSchema, config) => (values) => {
 };
 
 // src/calculateConditionalProperties.js
-function isFieldRequired(node, inputName) {
-  if (node?.required) {
-    return node.required.includes(inputName);
-  }
-  return false;
+function isFieldRequired(node, field) {
+  return (
+    // Check base root required
+    field.scopedJsonSchema?.required?.includes(field.name) || // Check conditional required
+    node?.required?.includes(field.name)
+  );
 }
-function rebuildInnerFieldsRequiredProperty(fields, property) {
+function rebuildFieldset(fields, property) {
   if (property?.properties) {
     return fields.map((field) => {
+      const propertyConditionals = property.properties[field.name];
+      if (!propertyConditionals) {
+        return field;
+      }
+      const newFieldParams = extractParametersFromNode(propertyConditionals);
       if (field.fields) {
         return {
           ...field,
-          fields: rebuildInnerFieldsRequiredProperty(field.fields, property.properties[field.name])
+          ...newFieldParams,
+          fields: rebuildFieldset(field.fields, propertyConditionals)
         };
       }
       return {
         ...field,
-        required: isFieldRequired(property, field.name)
+        ...newFieldParams,
+        required: isFieldRequired(property, field)
       };
     });
   }
   return fields.map((field) => ({
     ...field,
-    required: isFieldRequired(property, field.name)
+    required: isFieldRequired(property, field)
   }));
 }
 function calculateConditionalProperties(fieldParams, customProperties) {
@@ -963,10 +1018,7 @@ function calculateConditionalProperties(fieldParams, customProperties) {
       });
       let fieldSetFields;
       if (fieldParams.inputType === supportedTypes.FIELDSET) {
-        fieldSetFields = rebuildInnerFieldsRequiredProperty(
-          fieldParams.fields,
-          conditionalProperty
-        );
+        fieldSetFields = rebuildFieldset(fieldParams.fields, conditionalProperty);
         newFieldParams.fields = fieldSetFields;
       }
       const base = {

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2023 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.3.0-beta.0
- Generated: Wed, 21 Jun 2023 11:17:55 GMT
+ NPM Package: @remoteoss/json-schema-form@0.4.1-beta.0
+ Generated: Mon, 03 Jul 2023 22:21:10 GMT
 
  MIT License
 
@@ -347,8 +347,17 @@ var validateOnlyStrings = string().trim().nullable().test(
 );
 var yupSchemas = {
   text: validateOnlyStrings,
-  select: string().trim().nullable(),
-  radio: string().trim().nullable(),
+  radioOrSelect: (options) => string().nullable().transform((value) => {
+    if (value === "") {
+      return void 0;
+    }
+    if (options?.includes(null)) {
+      return value;
+    }
+    return value === null ? void 0 : value;
+  }).oneOf(options, ({ value }) => {
+    return `The option ${JSON.stringify(value)} is not valid.`;
+  }),
   date: string().nullable().trim().matches(
     /(?:\d){4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-9]|3[0-1])/,
     `Must be a valid date in ${DEFAULT_DATE_FORMAT.toLocaleLowerCase()} format. e.g. ${todayDateHint}`
@@ -383,18 +392,33 @@ function getRequiredErrorMessage(inputType, { inlineError, configError }) {
   return "Required field";
 }
 var getJsonTypeInArray = (jsonType) => Array.isArray(jsonType) ? jsonType.find((val) => val !== "null") : jsonType;
+var getOptions = (field) => {
+  const allValues = field.options?.map((option) => option.value);
+  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;
+};
+var getYupSchema = ({ inputType, ...field }) => {
+  const jsonType = getJsonTypeInArray(field.jsonType);
+  if (field.options?.length > 0) {
+    const optionValues = getOptions(field);
+    return yupSchemas.radioOrSelect(optionValues);
+  }
+  return yupSchemas[inputType] || yupSchemasToJsonTypes[jsonType];
+};
 function buildYupSchema(field, config) {
   const { inputType, jsonType: jsonTypeValue, errorMessage = {}, ...propertyFields } = field;
   const isCheckboxBoolean = typeof propertyFields.checkboxValue === "boolean";
   let baseSchema;
-  const jsonType = getJsonTypeInArray(jsonTypeValue);
   const errorMessageFromConfig = config?.inputTypes?.[inputType]?.errorMessage || {};
   if (propertyFields.multiple) {
     baseSchema = yupSchemas.multiple[inputType] || yupSchemasToJsonTypes.array;
   } else if (isCheckboxBoolean) {
     baseSchema = yupSchemas.checkboxBool;
   } else {
-    baseSchema = yupSchemas[inputType] || yupSchemasToJsonTypes[jsonType];
+    baseSchema = getYupSchema(field);
   }
   if (!baseSchema) {
     return noop;
@@ -594,8 +618,17 @@ function checkIfConditionMatches(node, formValues, formFields) {
     if (currentProperty.enum) {
       return currentProperty.enum.includes(value);
     }
-    const { inputType } = getField(name, formFields);
-    return validateFieldSchema({ ...currentProperty, inputType, required: true }, value);
+    const field = getField(name, formFields);
+    return validateFieldSchema(
+      {
+        options: field.options,
+        // @TODO/CODE SMELL. We are passing the property (raw field), but buildYupSchema() expected the output field.
+        ...currentProperty,
+        inputType: field.inputType,
+        required: true
+      },
+      value
+    );
   });
 }
 function isFieldFilled(fieldValue) {
@@ -768,12 +801,26 @@ function updateFieldsProperties(fields, formValues, jsonSchema) {
   clearValuesIfNotVisible(fields, formValues);
 }
 var notNullOption = (opt) => opt.const !== null;
+function flatPresentation(item) {
+  return Object.entries(item).reduce((newItem, [key, value]) => {
+    if (key === "x-jsf-presentation") {
+      return {
+        ...newItem,
+        ...value
+      };
+    }
+    return {
+      ...newItem,
+      [key]: value
+    };
+  }, {});
+}
 function getFieldOptions(node, presentation) {
   function convertToOptions(nodeOptions) {
     return nodeOptions.filter(notNullOption).map(({ title, const: cons, ...item }) => ({
       label: title,
       value: cons,
-      ...item
+      ...flatPresentation(item)
     }));
   }
   if (presentation.options) {
@@ -889,30 +936,38 @@ var handleValuesChange = (fields, jsonSchema, config) => (values) => {
 };
 
 // src/calculateConditionalProperties.js
-function isFieldRequired(node, inputName) {
-  if (node?.required) {
-    return node.required.includes(inputName);
-  }
-  return false;
+function isFieldRequired(node, field) {
+  return (
+    // Check base root required
+    field.scopedJsonSchema?.required?.includes(field.name) || // Check conditional required
+    node?.required?.includes(field.name)
+  );
 }
-function rebuildInnerFieldsRequiredProperty(fields, property) {
+function rebuildFieldset(fields, property) {
   if (property?.properties) {
     return fields.map((field) => {
+      const propertyConditionals = property.properties[field.name];
+      if (!propertyConditionals) {
+        return field;
+      }
+      const newFieldParams = extractParametersFromNode(propertyConditionals);
       if (field.fields) {
         return {
           ...field,
-          fields: rebuildInnerFieldsRequiredProperty(field.fields, property.properties[field.name])
+          ...newFieldParams,
+          fields: rebuildFieldset(field.fields, propertyConditionals)
         };
       }
       return {
         ...field,
-        required: isFieldRequired(property, field.name)
+        ...newFieldParams,
+        required: isFieldRequired(property, field)
       };
     });
   }
   return fields.map((field) => ({
     ...field,
-    required: isFieldRequired(property, field.name)
+    required: isFieldRequired(property, field)
   }));
 }
 function calculateConditionalProperties(fieldParams, customProperties) {
@@ -927,10 +982,7 @@ function calculateConditionalProperties(fieldParams, customProperties) {
       });
       let fieldSetFields;
       if (fieldParams.inputType === supportedTypes.FIELDSET) {
-        fieldSetFields = rebuildInnerFieldsRequiredProperty(
-          fieldParams.fields,
-          conditionalProperty
-        );
+        fieldSetFields = rebuildFieldset(fieldParams.fields, conditionalProperty);
         newFieldParams.fields = fieldSetFields;
       }
       const base = {