@adobe/helix-md2jcr 1.1.31 → 1.1.33

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.1.33](https://github.com/adobe/helix-md2jcr/compare/v1.1.32...v1.1.33) (2025-09-03)
+
+
+### Bug Fixes
+
+* container blocks fail to parse correctly when no class is provided ([#147](https://github.com/adobe/helix-md2jcr/issues/147)) ([846f281](https://github.com/adobe/helix-md2jcr/commit/846f281509f47ddeb228a6cda9d6252e42861b74))
+
+## [1.1.32](https://github.com/adobe/helix-md2jcr/compare/v1.1.31...v1.1.32) (2025-08-27)
+
+
+### Bug Fixes
+
+* **143:** support for field name hints ([8dbe511](https://github.com/adobe/helix-md2jcr/commit/8dbe511651f2d3f6e1b4a322eeb1ea91a83048a9))
+
 ## [1.1.31](https://github.com/adobe/helix-md2jcr/compare/v1.1.30...v1.1.31) (2025-08-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.1.31",
+  "version": "1.1.33",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",
@@ -55,14 +55,14 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "3.0.9",
-    "@adobe/helix-mediahandler": "2.7.23",
+    "@adobe/helix-mediahandler": "2.8.2",
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "7.1.0",
     "@semantic-release/git": "10.0.1",
     "c8": "10.1.3",
-    "chai": "^5.2.0",
+    "chai": "^6.0.0",
     "dotenv": "17.2.1",
     "eslint": "^9.0.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
@@ -70,8 +70,8 @@
     "eslint-plugin-import": "2.32.0",
     "husky": "^9.1.7",
     "junit-report-builder": "5.1.1",
-    "lint-staged": "16.1.5",
-    "mocha": "11.7.1",
+    "lint-staged": "16.1.6",
+    "mocha": "11.7.2",
     "mocha-multi-reporters": "1.5.1",
     "nock": "13.5.6",
     "semantic-release": "24.2.7",

package/src/mdast2jcr/domain/FieldGroupFieldResolver.js

@@ -47,13 +47,23 @@ class FieldGroupFieldResolver {
    * @param {{isGrouped: boolean, name: string, fields: [],
    * collapsed: [{isGrouped: boolean, name: string, fields: []}]}} fieldGroup - the field group
    */
-  resolve(node, fieldGroup) {
+  resolve(node, fieldGroup, hint) {
     const { fields } = fieldGroup;
     if (fields === undefined) {
       // throw an Error indicating the issue
       throw new Error(`Field group ${fieldGroup.name} does not have any fields defined.`);
     }
 
+    // if a hint is provided, then we need to find the field that matches the hint
+    if (hint) {
+      const fieldIndex = fields.findIndex((field) => field.name === hint);
+      if (fieldIndex !== -1) {
+        const field = fields[fieldIndex];
+        fields.splice(0, fieldIndex + 1);
+        return field;
+      }
+    }
+
     let foundField = fields.find((field) => {
       if (node.type === 'heading' && field.collapsed?.find((c) => c.name.endsWith('Type'))) {
         // try to find a field that matches the heading depth, if we have one

package/src/mdast2jcr/hb/partials/grid-table.js

@@ -197,14 +197,19 @@ function extractKeyValueProperties(row, model, fieldResolver, fieldGroup, proper
   }
 }
 
+function isFieldNameHint(node) {
+  return node.type === 'html' && node.value?.startsWith('<!-- field:') && node.value?.endsWith(' -->');
+}
+
 function processCell(cell, fieldGroup, fieldResolver, properties) {
   const cellChildren = cell.children;
 
   if (cellChildren.length !== 0) {
-    // while the cell has children we need to process the fields in the fieldGroup
-    // if we run out of fields but there are still more nodes, then we need to throw an error
-    // because the model does not map correctly to the content
+    let nextFieldName;
     while (cellChildren.length > 0) {
+      // while the cell has children we need to process the fields in the fieldGroup
+      // if we run out of fields but there are still more nodes, then we need to throw an error
+      // because the model does not map correctly to the content
       const node = cellChildren.shift();
 
       // have we run out of fields?
@@ -216,7 +221,14 @@ function processCell(cell, fieldGroup, fieldResolver, properties) {
         throw new Error(errorMsg);
       }
 
-      const field = fieldResolver.resolve(node, fieldGroup);
+      // if we see a property name hint, parse it and continue, unset it if not
+      if (isFieldNameHint(node)) {
+        nextFieldName = node.value.split('<!-- field:')[1].split(' -->')[0].trim();
+        // eslint-disable-next-line no-continue
+        continue;
+      }
+
+      const field = fieldResolver.resolve(node, fieldGroup, nextFieldName);
 
       let pWrapper;
       if (field.component === 'richtext') {
@@ -231,7 +243,9 @@ function processCell(cell, fieldGroup, fieldResolver, properties) {
           const n = cellChildren.shift();
           if (!n) break;
 
-          if (find(n, { type: 'image' })) {
+          // richtexts are greedy:
+          // they will consume all the children until they hit an image or a named field
+          if (find(n, { type: 'image' }) || isFieldNameHint(n)) {
             cellChildren.unshift(n);
             searching = false;
           }
@@ -243,15 +257,36 @@ function processCell(cell, fieldGroup, fieldResolver, properties) {
         pWrapper = node;
       }
       extractPropertiesForNode(field, pWrapper, properties);
+
+      nextFieldName = null;
     }
   }
 }
 
-function extractProperties(mdast, model, mode, component, fields, properties) {
+/**
+ * Extract the properties for the block item.
+ * @param {*} mdast - The mdast tree.
+ * @param {*} model - The model.
+ * @param {*} mode - The mode, either 'blockItem' or 'keyValue' or 'simple'.
+ * @param {*} component - The component.
+ * @param {*} fields - The fields.
+ * @param {*} properties - The properties.
+ * @param {*} skipFirstCell - Use to tell the function to skip the first cell when
+ * processing the block item.  This is only applicable when mode is 'blockItem' and
+ * when there is a component id specified in the first cell of the row for the block item.
+ */
+function extractProperties(
+  mdast,
+  model,
+  mode,
+  component,
+  fields,
+  properties,
+  skipFirstCell,
+) {
   const fieldsCloned = structuredClone(fields);
 
   // the first cells is the header row, so we skip it
-  // const nodes = findAll(mdast, (node) => node.type === 'gtCell', true);
   const rows = findAll(mdast, (node) => node.type === 'gtRow', false);
   let classesField;
   if (mode === 'blockItem') {
@@ -298,7 +333,7 @@ function extractProperties(mdast, model, mode, component, fields, properties) {
     // We then want to throw away the first cell as it is the class field
     // EC currently does not add the classes field therefore more cells than model fields
     // See container-block.md for an example of more cells than model fields (second table)
-    if (mode === 'blockItem' && classesField && (cells.length > modelFields.length)) {
+    if (mode === 'blockItem' && (skipFirstCell) && (cells.length > modelFields.length)) {
       cells.shift();
     }
 
@@ -366,12 +401,14 @@ function getBlockItems(mdast, modelHelper, definitions, allowedComponents) {
 
     // the first cell may be defined as the component id (with optional classes)
     let componentId = cellText.split(',').shift().trim();
-
+    let skipFirstCell = false;
     // if we can't find the component id in the allowed components it means
     // the user has not specified what component to use therefore we fall back
     // to the first allowed component.
     if (allowedComponents.indexOf(componentId) === -1) {
       [componentId] = allowedComponents;
+    } else {
+      skipFirstCell = true;
     }
 
     // check to see if we can use this component
@@ -384,7 +421,7 @@ function getBlockItems(mdast, modelHelper, definitions, allowedComponents) {
           modelFields: `[${getModelFieldNames(fieldGroup.model).join(',')}]`,
         };
 
-        extractProperties(row, fieldGroup.model, 'blockItem', component, fieldGroup.fields, properties);
+        extractProperties(row, fieldGroup.model, 'blockItem', component, fieldGroup.fields, properties, skipFirstCell);
         items.push(`<item_${items.length} jcr:primaryType="nt:unstructured" sling:resourceType="core/franklin/components/block/v1/block/item" name="${fieldGroup.model.id}" ${Object.entries(properties).map(([k, v]) => `${k}="${v}"`).join(' ')}></item_${items.length}>`);
       }
     }