@adobe/helix-md2jcr 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.1.2](https://github.com/adobe/helix-md2jcr/compare/v1.1.1...v1.1.2) (2025-02-26)
+
+
+### Bug Fixes
+
+* **sites-29541:** allow model fields to be in mixed order ([#62](https://github.com/adobe/helix-md2jcr/issues/62)) ([c7592c4](https://github.com/adobe/helix-md2jcr/commit/c7592c4a6825bc9b2a53b48034a1691fef263001))
+
+## [1.1.1](https://github.com/adobe/helix-md2jcr/compare/v1.1.0...v1.1.1) (2025-02-25)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/remark-gridtables to v3.0.10 ([#61](https://github.com/adobe/helix-md2jcr/issues/61)) ([f6e113d](https://github.com/adobe/helix-md2jcr/commit/f6e113d532bc9e844c09744452a9a8e18c7e821b))
+
 # [1.1.0](https://github.com/adobe/helix-md2jcr/compare/v1.0.16...v1.1.0) (2025-02-25)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",
@@ -31,7 +31,7 @@
     "@adobe/fetch": "4.1.11",
     "@adobe/helix-markdown-support": "7.1.12",
     "@adobe/helix-shared-process-queue": "3.1.1",
-    "@adobe/remark-gridtables": "3.0.9",
+    "@adobe/remark-gridtables": "3.0.10",
     "entities": "^5.0.0",
     "github-slugger": "2.0.0",
     "handlebars": "^4.7.8",
@@ -62,6 +62,7 @@
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "c8": "10.1.3",
+    "chai": "^5.2.0",
     "dotenv": "16.4.7",
     "eslint": "8.57.1",
     "eslint-import-resolver-exports": "1.0.0-beta.5",

package/src/mdast2jcr/domain/Component.js

@@ -19,7 +19,7 @@ class Component {
    * Create a new Component.
    * @param {string} name
    * @param {string} id
-   * @param {object} template
+   * @param {Object} template
    */
   constructor(name, id, template) {
     this._template = template;
@@ -30,27 +30,50 @@ class Component {
     this._id = id;
   }
 
+  /**
+   * Get the ID for the component.
+   * @return {string}
+   */
   get id() {
     return this._id;
   }
 
+  /**
+   * Get the filter ID for the component.
+   * @return {string}
+   */
   get filterId() {
     return this._filterId;
   }
 
+  /**
+   * Get the model ID for the component.
+   * @return {string}
+   */
   get modelId() {
     return this._modelId;
   }
 
+  /**
+   * Return true or false if the component is a key-value component.
+   * @return {boolean}
+   */
   get keyValue() {
     return this._keyValue;
   }
 
+  /**
+   * Get the name of the component.
+   * @return {string}
+   */
   get name() {
     return this._name;
   }
 
-  /* eslint-disable no-unused-vars */
+  /**
+   * Return the component's default fields specified in the template section.
+   * @return {Object}
+   */
   get defaultFields() {
     return this._template;
   }

package/src/mdast2jcr/domain/ModelHelper.js

@@ -27,7 +27,7 @@ class ModelHelper {
    */
   constructor(blockName, models, definition, filters) {
     this.blockName = blockName;
-    this._checkFieldOrder(models);
+    this._fixFieldOrder(models);
     this.models = models;
     this.definition = definition;
     this.filters = filters;
@@ -35,37 +35,31 @@ class ModelHelper {
     this._groupModelFields();
   }
 
+  /**
+   * The field order in the models is not guaranteed to be correct.  This method will fix the order
+   * of the fields in the models so that the base field is followed by the suffix fields.
+   * @param {Array<Model>} models The models to fix the field order.
+   * @private {void}
+   */
   // eslint-disable-next-line class-methods-use-this
-  _checkFieldOrder(models) {
+  _fixFieldOrder(models) {
     const suffixes = ['Alt', 'MimeType', 'Type', 'Text', 'Title'];
 
     models.forEach((model) => {
-      const seenBaseFields = new Set();
-      let warningGenerated = false;
-      const warnings = [];
-
-      model.fields.forEach((field) => {
-        const suffixMatch = suffixes.find((suffix) => field.name.endsWith(suffix));
-        const baseName = suffixMatch ? field.name.slice(0, -suffixMatch.length) : field.name;
-
-        if (suffixMatch) {
-          // This is a suffix field, we need to check if its base field exists
-          if (!seenBaseFields.has(baseName)) {
-            if (!warningGenerated) {
-              warnings.push(`Warning in model '${model.id}': Fields with suffixes should follow their base field.`);
-              warningGenerated = true;
-            }
-            warnings.push(`  - Field '${field.name}' appears before its base field '${baseName}'.`);
-          }
-        } else {
-          // This is a base field, add it to seenBaseFields
-          seenBaseFields.add(baseName);
-        }
-      });
-
-      if (warningGenerated) {
-        throw new Error(warnings.join('\n'));
-      }
+      // collect the name of all the model fields that do not have a suffix
+      const baseFields = model.fields
+        .filter((field) => !suffixes.some((suffix) => field.name.endsWith(suffix)))
+        .map((field) => field.name);
+
+      // for each base field, find the associated fields with suffixes and update the model
+      // fixing the order so that we can later group things together
+      // eslint-disable-next-line no-param-reassign
+      model.fields = baseFields.flatMap((baseField) => [
+        // will return array with [field, fieldText, fieldType, etc]
+        model.fields.find((field) => field.name === baseField),
+        ...suffixes
+          .map((suffix) => model.fields.find((field) => field.name === `${baseField}${suffix}`))
+          .filter(Boolean)]);
     });
   }