@remoteoss/json-schema-form 0.10.1-beta.0 → 0.11.0-beta.0

package/CHANGELOG.md

@@ -1,8 +1,27 @@
+#### 0.11.0-beta.0 (2024-07-25)
+
+##### Breaking changes
+
+- **modify:**
+  - Change the return result to include warnings ([#83](https://github.com/remoteoss/json-schema-form/pull/83)) ([e07fcec8](https://github.com/remoteoss/json-schema-form/commit/e07fcec8e11cfcba2b477e5e6339cebbcc42038c))
+
+##### New Features
+
+- **modify:**
+  - Allow picking fields ([#79](https://github.com/remoteoss/json-schema-form/pull/79)) ([2e044021](https://github.com/remoteoss/json-schema-form/commit/2e044021f30292be81cede3805eefb4f1ea96dd9))
+  - Add x-jsf-presentation shorthand ([#81](https://github.com/remoteoss/json-schema-form/pull/81)) ([7cfaab0b](https://github.com/remoteoss/json-schema-form/commit/7cfaab0bdbb05a1555f6c1d74b26b1e6d7fa8c43))
+  - Allow creating fields ([#80](https://github.com/remoteoss/json-schema-form/pull/80)) ([8a82254d](https://github.com/remoteoss/json-schema-form/commit/8a82254d7cf5799471fa0bf2d3d09179f1327187))
+  - Allow customize fields order ([#78](https://github.com/remoteoss/json-schema-form/pull/78)) ([adc88179](https://github.com/remoteoss/json-schema-form/commit/adc88179a5d1e5bd85371c0cc581b35964bf6edf))
+
+##### Bug Fixes
+
+- **modify:** Customize attrs as Array now overrides the value ([#82](https://github.com/remoteoss/json-schema-form/pull/82)) ([7cc0853e](https://github.com/remoteoss/json-schema-form/commit/7cc0853e30f0c06ff160d8a3e4c4b4e402a1e520))
+
 #### 0.10.1-beta.0 (2024-07-23)
 
 ##### Chores
 
-* **Text field docs:**  Change naming of ID number property ([#74](https://github.com/remoteoss/json-schema-form/pull/74)) ([338ddd2a](https://github.com/remoteoss/json-schema-form/commit/338ddd2a5f008ec089f38db834f075100b856001))
+- **Text field docs:** Change naming of ID number property ([#74](https://github.com/remoteoss/json-schema-form/pull/74)) ([338ddd2a](https://github.com/remoteoss/json-schema-form/commit/338ddd2a5f008ec089f38db834f075100b856001))
 
 #### 0.10.0-beta.0 (2024-06-20)
 

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.10.1-beta.0
- Generated: Tue, 23 Jul 2024 21:13:09 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.0-beta.0
+ Generated: Thu, 25 Jul 2024 16:43:12 GMT
 
  MIT License
 
@@ -1834,37 +1834,78 @@ function createHeadlessForm(jsonSchema, customConfig = {}) {
 }
 
 // src/modify.js
+var import_difference = __toESM(require("lodash/difference"));
 var import_get4 = __toESM(require("lodash/get"));
+var import_intersection = __toESM(require("lodash/intersection"));
 var import_merge3 = __toESM(require("lodash/merge"));
+var import_mergeWith = __toESM(require("lodash/mergeWith"));
+var import_set2 = __toESM(require("lodash/set"));
+var WARNING_TYPES = {
+  FIELD_TO_CHANGE_NOT_FOUND: "FIELD_TO_CHANGE_NOT_FOUND",
+  ORDER_MISSING_FIELDS: "ORDER_MISSING_FIELDS",
+  FIELD_TO_CREATE_EXISTS: "FIELD_TO_CREATE_EXISTS",
+  PICK_MISSED_FIELD: "PICK_MISSED_FIELD"
+};
 function shortToFullPath(path) {
   return path.replace(".", ".properties.");
 }
+function mergeReplaceArray(_, newVal) {
+  return Array.isArray(newVal) ? newVal : void 0;
+}
 function standardizeAttrs(attrs) {
-  const { errorMessage, properties, ...rest } = attrs;
+  const { errorMessage, presentation, properties, ...rest } = attrs;
   return {
     ...rest,
+    ...presentation ? { "x-jsf-presentation": presentation } : {},
     ...errorMessage ? { "x-jsf-errorMessage": errorMessage } : {}
   };
 }
+function isConditionalReferencingAnyPickedField(condition, fieldsToPick) {
+  const { if: ifCondition, then: thenCondition, else: elseCondition } = condition;
+  const inIf = (0, import_intersection.default)(ifCondition.required, fieldsToPick);
+  if (inIf.length > 0) {
+    return true;
+  }
+  const inThen = (0, import_intersection.default)(thenCondition.required, fieldsToPick) || (0, import_intersection.default)(Object.keys(thenCondition.properties), fieldsToPick);
+  if (inThen.length > 0) {
+    return true;
+  }
+  const inElse = (0, import_intersection.default)(elseCondition.required, fieldsToPick) || (0, import_intersection.default)(Object.keys(elseCondition.properties), fieldsToPick);
+  if (inElse.length > 0) {
+    return true;
+  }
+  return false;
+}
 function rewriteFields(schema, fieldsConfig) {
   if (!fieldsConfig)
-    return null;
+    return { warnings: null };
+  const warnings = [];
   const fieldsToModify = Object.entries(fieldsConfig);
   fieldsToModify.forEach(([shortPath, mutation]) => {
     const fieldPath = shortToFullPath(shortPath);
     if (!(0, import_get4.default)(schema.properties, fieldPath)) {
+      warnings.push({
+        type: WARNING_TYPES.FIELD_TO_CHANGE_NOT_FOUND,
+        message: `Changing field "${shortPath}" was ignored because it does not exist.`
+      });
       return;
     }
     const fieldAttrs = (0, import_get4.default)(schema.properties, fieldPath);
     const fieldChanges = typeof mutation === "function" ? mutation(fieldAttrs) : mutation;
-    (0, import_merge3.default)((0, import_get4.default)(schema.properties, fieldPath), {
-      ...fieldAttrs,
-      ...standardizeAttrs(fieldChanges)
-    });
+    (0, import_mergeWith.default)(
+      (0, import_get4.default)(schema.properties, fieldPath),
+      {
+        ...fieldAttrs,
+        ...standardizeAttrs(fieldChanges)
+      },
+      mergeReplaceArray
+    );
     if (fieldChanges.properties) {
-      rewriteFields((0, import_get4.default)(schema.properties, fieldPath), fieldChanges.properties);
+      const result = rewriteFields((0, import_get4.default)(schema.properties, fieldPath), fieldChanges.properties);
+      warnings.push(result.warnings);
     }
   });
+  return { warnings: warnings.flat() };
 }
 function rewriteAllFields(schema, configCallback, context) {
   if (!configCallback)
@@ -1872,10 +1913,14 @@ function rewriteAllFields(schema, configCallback, context) {
   const parentName = context?.parent;
   Object.entries(schema.properties).forEach(([fieldName, fieldAttrs]) => {
     const fullName = parentName ? `${parentName}.${fieldName}` : fieldName;
-    (0, import_merge3.default)((0, import_get4.default)(schema.properties, fieldName), {
-      ...fieldAttrs,
-      ...configCallback(fullName, fieldAttrs)
-    });
+    (0, import_mergeWith.default)(
+      (0, import_get4.default)(schema.properties, fieldName),
+      {
+        ...fieldAttrs,
+        ...configCallback(fullName, fieldAttrs)
+      },
+      mergeReplaceArray
+    );
     if (fieldAttrs.properties) {
       rewriteAllFields(fieldAttrs, configCallback, {
         parent: fieldName
@@ -1883,9 +1928,152 @@ function rewriteAllFields(schema, configCallback, context) {
     }
   });
 }
+function reorderFields(schema, configOrder) {
+  if (!configOrder)
+    return { warnings: null };
+  const warnings = [];
+  const originalOrder = schema["x-jsf-order"] || [];
+  const orderConfig = typeof configOrder === "function" ? configOrder(originalOrder) : configOrder;
+  const remaining = (0, import_difference.default)(originalOrder, orderConfig);
+  if (remaining.length > 0) {
+    warnings.push({
+      type: WARNING_TYPES.ORDER_MISSING_FIELDS,
+      message: `Some fields got forgotten in the new order. They were automatically appended: ${remaining.join(
+        ", "
+      )}`
+    });
+  }
+  schema["x-jsf-order"] = [...orderConfig, ...remaining];
+  return { warnings };
+}
+function createFields(schema, fieldsConfig) {
+  if (!fieldsConfig)
+    return { warnings: null };
+  const warnings = [];
+  const fieldsToCreate = Object.entries(fieldsConfig);
+  fieldsToCreate.forEach(([shortPath, fieldAttrs]) => {
+    const fieldPath = shortToFullPath(shortPath);
+    if (fieldAttrs.properties) {
+      const result = createFields((0, import_get4.default)(schema.properties, fieldPath), fieldAttrs.properties);
+      warnings.push(result.warnings);
+    }
+    const fieldInSchema = (0, import_get4.default)(schema.properties, fieldPath);
+    if (fieldInSchema) {
+      warnings.push({
+        type: WARNING_TYPES.FIELD_TO_CREATE_EXISTS,
+        message: `Creating field "${shortPath}" was ignored because it already exists.`
+      });
+      return;
+    }
+    const fieldInObjectPath = (0, import_set2.default)({}, fieldPath, standardizeAttrs(fieldAttrs));
+    (0, import_merge3.default)(schema.properties, fieldInObjectPath);
+  });
+  return { warnings: warnings.flat() };
+}
+function pickFields(originalSchema, fieldsToPick) {
+  if (!fieldsToPick) {
+    return { schema: originalSchema, warnings: null };
+  }
+  const newSchema = {
+    properties: {}
+  };
+  Object.entries(originalSchema).forEach(([attrKey, attrValue]) => {
+    switch (attrKey) {
+      case "properties":
+        fieldsToPick.forEach((fieldPath) => {
+          (0, import_set2.default)(newSchema.properties, fieldPath, attrValue[fieldPath]);
+        });
+        break;
+      case "x-jsf-order":
+      case "required":
+        newSchema[attrKey] = attrValue.filter((fieldName) => fieldsToPick.includes(fieldName));
+        break;
+      case "allOf": {
+        const newAllOf = originalSchema.allOf.filter(
+          (condition) => isConditionalReferencingAnyPickedField(condition, fieldsToPick)
+        );
+        newSchema[attrKey] = newAllOf;
+        break;
+      }
+      default:
+        newSchema[attrKey] = attrValue;
+    }
+  });
+  let missingFields = {};
+  newSchema.allOf.forEach((condition) => {
+    const { if: ifCondition, then: thenCondition, else: elseCondition } = condition;
+    const index = originalSchema.allOf.indexOf(condition);
+    missingFields = {
+      ...missingFields,
+      ...findMissingFields(ifCondition, {
+        fields: fieldsToPick,
+        path: `allOf[${index}].if`
+      }),
+      ...findMissingFields(thenCondition, {
+        fields: fieldsToPick,
+        path: `allOf[${index}].then`
+      }),
+      ...findMissingFields(elseCondition, {
+        fields: fieldsToPick,
+        path: `allOf[${index}].else`
+      })
+    };
+  });
+  const warnings = [];
+  if (Object.keys(missingFields).length > 0) {
+    Object.entries(missingFields).forEach(([fieldName]) => {
+      (0, import_set2.default)(newSchema.properties, fieldName, originalSchema.properties[fieldName]);
+    });
+    warnings.push({
+      type: WARNING_TYPES.PICK_MISSED_FIELD,
+      message: `The picked fields are in conditionals that refeer other fields. They added automatically: ${Object.keys(
+        missingFields
+      ).map((name) => `"${name}"`).join(", ")}. Check "meta" for more details.`,
+      meta: missingFields
+    });
+  }
+  return { schema: newSchema, warnings };
+}
+function findMissingFields(conditional, { fields, path }) {
+  if (!conditional) {
+    return null;
+  }
+  let missingFields = {};
+  conditional.required?.forEach((fieldName) => {
+    if (!fields.includes(fieldName)) {
+      missingFields[fieldName] = {
+        path
+      };
+    }
+  });
+  Object.entries(conditional.properties || []).forEach(([fieldName]) => {
+    if (!fields.includes(fieldName)) {
+      missingFields[fieldName] = { path };
+    }
+  });
+  return missingFields;
+}
 function modify(originalSchema, config) {
   const schema = JSON.parse(JSON.stringify(originalSchema));
-  rewriteFields(schema, config.fields);
+  const resultRewrite = rewriteFields(schema, config.fields);
   rewriteAllFields(schema, config.allFields);
-  return schema;
+  const resultCreate = createFields(schema, config.create);
+  const resultPick = pickFields(schema, config.pick);
+  const finalSchema = resultPick.schema;
+  const resultReorder = reorderFields(finalSchema, config.orderRoot);
+  if (!config.muteLogging) {
+    console.warn(
+      "json-schema-form modify(): We highly recommend you to handle/report the returned `warnings` as they highlight possible bugs in your modifications. To mute this log, pass `muteLogging: true` to the config."
+    );
+  }
+  const warnings = [
+    resultRewrite.warnings,
+    resultCreate.warnings,
+    resultPick.warnings,
+    resultReorder.warnings
+  ].flat().filter(Boolean);
+  return {
+    schema: finalSchema,
+    warnings
+  };
 }

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.10.1-beta.0
- Generated: Tue, 23 Jul 2024 21:13:09 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.0-beta.0
+ Generated: Thu, 25 Jul 2024 16:43:12 GMT
 
  MIT License
 
@@ -1797,37 +1797,78 @@ function createHeadlessForm(jsonSchema, customConfig = {}) {
 }
 
 // src/modify.js
+import difference from "lodash/difference";
 import get4 from "lodash/get";
+import intersection from "lodash/intersection";
 import merge3 from "lodash/merge";
+import mergeWith from "lodash/mergeWith";
+import set2 from "lodash/set";
+var WARNING_TYPES = {
+  FIELD_TO_CHANGE_NOT_FOUND: "FIELD_TO_CHANGE_NOT_FOUND",
+  ORDER_MISSING_FIELDS: "ORDER_MISSING_FIELDS",
+  FIELD_TO_CREATE_EXISTS: "FIELD_TO_CREATE_EXISTS",
+  PICK_MISSED_FIELD: "PICK_MISSED_FIELD"
+};
 function shortToFullPath(path) {
   return path.replace(".", ".properties.");
 }
+function mergeReplaceArray(_, newVal) {
+  return Array.isArray(newVal) ? newVal : void 0;
+}
 function standardizeAttrs(attrs) {
-  const { errorMessage, properties, ...rest } = attrs;
+  const { errorMessage, presentation, properties, ...rest } = attrs;
   return {
     ...rest,
+    ...presentation ? { "x-jsf-presentation": presentation } : {},
     ...errorMessage ? { "x-jsf-errorMessage": errorMessage } : {}
   };
 }
+function isConditionalReferencingAnyPickedField(condition, fieldsToPick) {
+  const { if: ifCondition, then: thenCondition, else: elseCondition } = condition;
+  const inIf = intersection(ifCondition.required, fieldsToPick);
+  if (inIf.length > 0) {
+    return true;
+  }
+  const inThen = intersection(thenCondition.required, fieldsToPick) || intersection(Object.keys(thenCondition.properties), fieldsToPick);
+  if (inThen.length > 0) {
+    return true;
+  }
+  const inElse = intersection(elseCondition.required, fieldsToPick) || intersection(Object.keys(elseCondition.properties), fieldsToPick);
+  if (inElse.length > 0) {
+    return true;
+  }
+  return false;
+}
 function rewriteFields(schema, fieldsConfig) {
   if (!fieldsConfig)
-    return null;
+    return { warnings: null };
+  const warnings = [];
   const fieldsToModify = Object.entries(fieldsConfig);
   fieldsToModify.forEach(([shortPath, mutation]) => {
     const fieldPath = shortToFullPath(shortPath);
     if (!get4(schema.properties, fieldPath)) {
+      warnings.push({
+        type: WARNING_TYPES.FIELD_TO_CHANGE_NOT_FOUND,
+        message: `Changing field "${shortPath}" was ignored because it does not exist.`
+      });
       return;
     }
     const fieldAttrs = get4(schema.properties, fieldPath);
     const fieldChanges = typeof mutation === "function" ? mutation(fieldAttrs) : mutation;
-    merge3(get4(schema.properties, fieldPath), {
-      ...fieldAttrs,
-      ...standardizeAttrs(fieldChanges)
-    });
+    mergeWith(
+      get4(schema.properties, fieldPath),
+      {
+        ...fieldAttrs,
+        ...standardizeAttrs(fieldChanges)
+      },
+      mergeReplaceArray
+    );
     if (fieldChanges.properties) {
-      rewriteFields(get4(schema.properties, fieldPath), fieldChanges.properties);
+      const result = rewriteFields(get4(schema.properties, fieldPath), fieldChanges.properties);
+      warnings.push(result.warnings);
     }
   });
+  return { warnings: warnings.flat() };
 }
 function rewriteAllFields(schema, configCallback, context) {
   if (!configCallback)
@@ -1835,10 +1876,14 @@ function rewriteAllFields(schema, configCallback, context) {
   const parentName = context?.parent;
   Object.entries(schema.properties).forEach(([fieldName, fieldAttrs]) => {
     const fullName = parentName ? `${parentName}.${fieldName}` : fieldName;
-    merge3(get4(schema.properties, fieldName), {
-      ...fieldAttrs,
-      ...configCallback(fullName, fieldAttrs)
-    });
+    mergeWith(
+      get4(schema.properties, fieldName),
+      {
+        ...fieldAttrs,
+        ...configCallback(fullName, fieldAttrs)
+      },
+      mergeReplaceArray
+    );
     if (fieldAttrs.properties) {
       rewriteAllFields(fieldAttrs, configCallback, {
         parent: fieldName
@@ -1846,11 +1891,154 @@ function rewriteAllFields(schema, configCallback, context) {
     }
   });
 }
+function reorderFields(schema, configOrder) {
+  if (!configOrder)
+    return { warnings: null };
+  const warnings = [];
+  const originalOrder = schema["x-jsf-order"] || [];
+  const orderConfig = typeof configOrder === "function" ? configOrder(originalOrder) : configOrder;
+  const remaining = difference(originalOrder, orderConfig);
+  if (remaining.length > 0) {
+    warnings.push({
+      type: WARNING_TYPES.ORDER_MISSING_FIELDS,
+      message: `Some fields got forgotten in the new order. They were automatically appended: ${remaining.join(
+        ", "
+      )}`
+    });
+  }
+  schema["x-jsf-order"] = [...orderConfig, ...remaining];
+  return { warnings };
+}
+function createFields(schema, fieldsConfig) {
+  if (!fieldsConfig)
+    return { warnings: null };
+  const warnings = [];
+  const fieldsToCreate = Object.entries(fieldsConfig);
+  fieldsToCreate.forEach(([shortPath, fieldAttrs]) => {
+    const fieldPath = shortToFullPath(shortPath);
+    if (fieldAttrs.properties) {
+      const result = createFields(get4(schema.properties, fieldPath), fieldAttrs.properties);
+      warnings.push(result.warnings);
+    }
+    const fieldInSchema = get4(schema.properties, fieldPath);
+    if (fieldInSchema) {
+      warnings.push({
+        type: WARNING_TYPES.FIELD_TO_CREATE_EXISTS,
+        message: `Creating field "${shortPath}" was ignored because it already exists.`
+      });
+      return;
+    }
+    const fieldInObjectPath = set2({}, fieldPath, standardizeAttrs(fieldAttrs));
+    merge3(schema.properties, fieldInObjectPath);
+  });
+  return { warnings: warnings.flat() };
+}
+function pickFields(originalSchema, fieldsToPick) {
+  if (!fieldsToPick) {
+    return { schema: originalSchema, warnings: null };
+  }
+  const newSchema = {
+    properties: {}
+  };
+  Object.entries(originalSchema).forEach(([attrKey, attrValue]) => {
+    switch (attrKey) {
+      case "properties":
+        fieldsToPick.forEach((fieldPath) => {
+          set2(newSchema.properties, fieldPath, attrValue[fieldPath]);
+        });
+        break;
+      case "x-jsf-order":
+      case "required":
+        newSchema[attrKey] = attrValue.filter((fieldName) => fieldsToPick.includes(fieldName));
+        break;
+      case "allOf": {
+        const newAllOf = originalSchema.allOf.filter(
+          (condition) => isConditionalReferencingAnyPickedField(condition, fieldsToPick)
+        );
+        newSchema[attrKey] = newAllOf;
+        break;
+      }
+      default:
+        newSchema[attrKey] = attrValue;
+    }
+  });
+  let missingFields = {};
+  newSchema.allOf.forEach((condition) => {
+    const { if: ifCondition, then: thenCondition, else: elseCondition } = condition;
+    const index = originalSchema.allOf.indexOf(condition);
+    missingFields = {
+      ...missingFields,
+      ...findMissingFields(ifCondition, {
+        fields: fieldsToPick,
+        path: `allOf[${index}].if`
+      }),
+      ...findMissingFields(thenCondition, {
+        fields: fieldsToPick,
+        path: `allOf[${index}].then`
+      }),
+      ...findMissingFields(elseCondition, {
+        fields: fieldsToPick,
+        path: `allOf[${index}].else`
+      })
+    };
+  });
+  const warnings = [];
+  if (Object.keys(missingFields).length > 0) {
+    Object.entries(missingFields).forEach(([fieldName]) => {
+      set2(newSchema.properties, fieldName, originalSchema.properties[fieldName]);
+    });
+    warnings.push({
+      type: WARNING_TYPES.PICK_MISSED_FIELD,
+      message: `The picked fields are in conditionals that refeer other fields. They added automatically: ${Object.keys(
+        missingFields
+      ).map((name) => `"${name}"`).join(", ")}. Check "meta" for more details.`,
+      meta: missingFields
+    });
+  }
+  return { schema: newSchema, warnings };
+}
+function findMissingFields(conditional, { fields, path }) {
+  if (!conditional) {
+    return null;
+  }
+  let missingFields = {};
+  conditional.required?.forEach((fieldName) => {
+    if (!fields.includes(fieldName)) {
+      missingFields[fieldName] = {
+        path
+      };
+    }
+  });
+  Object.entries(conditional.properties || []).forEach(([fieldName]) => {
+    if (!fields.includes(fieldName)) {
+      missingFields[fieldName] = { path };
+    }
+  });
+  return missingFields;
+}
 function modify(originalSchema, config) {
   const schema = JSON.parse(JSON.stringify(originalSchema));
-  rewriteFields(schema, config.fields);
+  const resultRewrite = rewriteFields(schema, config.fields);
   rewriteAllFields(schema, config.allFields);
-  return schema;
+  const resultCreate = createFields(schema, config.create);
+  const resultPick = pickFields(schema, config.pick);
+  const finalSchema = resultPick.schema;
+  const resultReorder = reorderFields(finalSchema, config.orderRoot);
+  if (!config.muteLogging) {
+    console.warn(
+      "json-schema-form modify(): We highly recommend you to handle/report the returned `warnings` as they highlight possible bugs in your modifications. To mute this log, pass `muteLogging: true` to the config."
+    );
+  }
+  const warnings = [
+    resultRewrite.warnings,
+    resultCreate.warnings,
+    resultPick.warnings,
+    resultReorder.warnings
+  ].flat().filter(Boolean);
+  return {
+    schema: finalSchema,
+    warnings
+  };
 }
 export {
   buildCompleteYupSchema,