@adobe/helix-md2jcr 1.1.24 → 1.1.25

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.1.25](https://github.com/adobe/helix-md2jcr/compare/v1.1.24...v1.1.25) (2025-06-27)
+
+
+### Bug Fixes
+
+* **108:** support columns block ([#111](https://github.com/adobe/helix-md2jcr/issues/111)) ([7792a12](https://github.com/adobe/helix-md2jcr/commit/7792a12f5178c16f13e15e92b0970f6c826e23ad))
+
 ## [1.1.24](https://github.com/adobe/helix-md2jcr/compare/v1.1.23...v1.1.24) (2025-06-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.1.24",
+  "version": "1.1.25",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",
@@ -55,7 +55,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.9",
-    "@adobe/helix-mediahandler": "2.7.11",
+    "@adobe/helix-mediahandler": "2.7.13",
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
     "@semantic-release/changelog": "6.0.3",
@@ -67,7 +67,7 @@
     "eslint": "8.57.1",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-import": "2.32.0",
     "husky": "^9.1.7",
     "junit-report-builder": "5.1.1",
     "lint-staged": "15.5.2",

package/src/mdast2jcr/hb/helpers/name-helper.js

@@ -32,20 +32,22 @@ const nameCounter = [];
  * or an empty string if the node is unique.
  */
 function nameHelper(name) {
+  // Support for per-context nameCounter
+  const context = this || {};
+  const counter = context.nameCounter || nameCounter;
+
   // reset the name counter if the node is a section or if the name counter is empty
-  // we could reset the name counter and empty all the counters, but it's cool
-  // to see the counts for debugging
-  if (name === 'section' || !nameCounter.length) {
-    nameCounter.push({});
+  if (name === 'section' || !counter.length) {
+    counter.push({});
   }
 
   // treat sections as a top level node and return the length of the name counter
   if (name === 'section') {
-    return nameCounter.length > 1 ? `_${nameCounter.length - 1}` : '';
+    return counter.length > 1 ? `_${counter.length - 1}` : '';
   }
 
   // get the current counter
-  const currentCounter = nameCounter[nameCounter.length - 1];
+  const currentCounter = counter[counter.length - 1];
 
   // increment the counter for the node name
   currentCounter[name] = (currentCounter[name] || 0) + 1;

package/src/mdast2jcr/hb/partials/columns.js

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import Handlebars from 'handlebars';
+import { toString } from 'mdast-util-to-string';
+import { find } from 'unist-util-find';
+import { findAllDeep } from '../../utils/mdast.js';
+import whichPartialHelper from '../helpers/which-partial-helper.js';
+import { getModelId } from '../../domain/Definitions.js';
+import {
+  findModelById,
+  getField,
+} from '../../domain/Models.js';
+
+// eslint-disable-next-line no-unused-vars
+function columnsPartial(context) {
+  const {
+    children: [tHeader, tBody],
+    models,
+    definition,
+  } = context;
+
+  const uniqueName = Handlebars.helpers.nameHelper.call(context, 'columns');
+
+  const rows = findAllDeep(tBody, (node) => node.type === 'gtRow');
+  const columns = findAllDeep(rows[0], (node) => node.type === 'gtCell');
+
+  const textNode = find(tHeader, { type: 'text' });
+  const regex = /^(?<blockName>[^(]+)\s*(\((?<classes>[^)]+)\))?$/;
+  const match = toString(textNode).match(regex);
+
+  let headerProps = {};
+
+  if (match) {
+    const blockName = match.groups.blockName.trim();
+    const modelId = getModelId(definition, blockName);
+    const blockClasses = match.groups.classes ? match.groups.classes.split(',').map((c) => c.trim()) : [];
+
+    const model = findModelById(models, modelId);
+    const classesField = getField(model, 'classes');
+    let classes = [];
+
+    if (blockClasses.length > 0 && classesField) {
+      classes = (classesField.multi === true) ? `[${blockClasses.join(',')}]` : blockClasses.join(',');
+    }
+
+    headerProps = {
+      // name: match.groups.blockName.trim(),
+      // modelFields: `[${getModelFieldNames(model).join(',')}]`,
+      classes,
+      rows: rows.length,
+      columns: columns.length,
+    };
+
+    // remove properties that are empty
+    headerProps = Object.fromEntries(Object.entries(headerProps).filter(([_, v]) => v !== '' && (Array.isArray(v) ? v.length > 0 : v !== null)));
+  }
+
+  const attributes = {
+    'sling:resourceType': 'core/franklin/components/columns/v1/columns',
+    'jcr:primaryType': 'nt:unstructured',
+    ...headerProps,
+  };
+
+  const rowEls = rows.map((row, rowIndex) => {
+    const cells = findAllDeep(row, (node) => node.type === 'gtCell');
+    const columnEls = cells.map((cell, cellIndex) => {
+      // custom naming counter for columns
+      const nameCounter = [{}];
+
+      // const columnFilter = filters.find((f) => f.id === 'column');
+      // const components = columnFilter?.components || [];
+
+      // render the children of the cell by calling the associated default content partial function
+      // eg. text, image, title, link
+      const childrenEls = cell.children.map((child) => {
+        const partial = whichPartialHelper(child.type);
+        // we shouldn't get a unsupported partial as the mdast should have been cleaned up earlier
+        // see mdast-columns-block.js how it cleans up the mdast tree
+        if (partial === Handlebars.partials.unsupported) {
+          throw new Error(`Unsupported node type in columns: ${child.type}`);
+        }
+
+        // call the partial to render the xml for this node, pass the name counter
+        // to keep track of the unique names
+        return partial({ ...child, nameCounter });
+      });
+      return `<col${cellIndex + 1} jcr:primaryType="nt:unstructured">${childrenEls.join('\n')}</col${cellIndex + 1}>`;
+    });
+    return `<row${rowIndex + 1} jcr:primaryType="nt:unstructured">${columnEls.join('\n')}</row${rowIndex + 1}>`;
+  });
+
+  const attributesStr = Object.entries(attributes).map(([k, v]) => `${k}="${v}"`).join(' ');
+  return `<columns${uniqueName} ${attributesStr}>${rowEls.join('\n')}</columns${uniqueName}>`;
+}
+
+export default columnsPartial;

package/src/mdast2jcr/index.js

@@ -13,11 +13,16 @@
 /* eslint-disable no-param-reassign */
 import Handlebars from 'handlebars';
 import xmlFormatter from 'xml-formatter';
-import { splitSection, unwrapImages as unwrapElements, wrapParagraphs } from './utils.js';
+import {
+  splitSection,
+  unwrapImages as unwrapElements,
+  wrapParagraphs,
+} from './utils.js';
 import sanitizeHtml from './mdast-sanitize-html.js';
 import headingPartial from './hb/partials/heading.js';
 import stringPartial from './hb/partials/strong.js';
 import emphasisPartial from './hb/partials/emphasis.js';
+import columnsPartial from './hb/partials/columns.js';
 import linkPartial from './hb/partials/link.js';
 import paragraphWrapperPartial from './hb/partials/paragraph.js';
 import nameHelper, { nameReset } from './hb/helpers/name-helper.js';
@@ -30,6 +35,7 @@ import pageHelper from './hb/helpers/page-helper.js';
 import pageTemplate from './templates/page-template.js';
 import unsupportedPartial from './hb/partials/unsupported.js';
 import sanitizeEds from './mdast-sanitize-eds.js';
+import { splitColumns } from './mdast-columns-block.js';
 
 /**
  * Converts a markdown AST to JCR XML.  This function is the main entry point
@@ -46,6 +52,7 @@ export default async function mdast2jcr(mdast, options = {}) {
   mdast = splitSection(mdast);
   mdast = unwrapElements(mdast);
   mdast = wrapParagraphs(mdast);
+  mdast = splitColumns(mdast);
 
   Handlebars.registerPartial('heading', headingPartial);
   Handlebars.registerPartial('image', imagePartial);
@@ -53,6 +60,7 @@ export default async function mdast2jcr(mdast, options = {}) {
   Handlebars.registerPartial('strong', stringPartial);
   Handlebars.registerPartial('emphasis', emphasisPartial);
   Handlebars.registerPartial('paragraphWrapper', paragraphWrapperPartial);
+  Handlebars.registerPartial('columns', columnsPartial);
   Handlebars.registerPartial('gridTable', gridTablePartial);
   Handlebars.registerPartial('unsupported', unsupportedPartial);
 

package/src/mdast2jcr/mdast-columns-block.js

@@ -0,0 +1,91 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import { toString } from 'mdast-util-to-string';
+import { findAllDeep } from './utils/mdast.js';
+import link from './hb/partials/supports/link.js';
+import image from './hb/partials/supports/image.js';
+
+export function splitColumns(mdast) {
+  const tables = findAllDeep(mdast, (node) => node.type === 'gridTable');
+
+  tables.map((table) => {
+    const header = findAllDeep(table, (node) => node.type === 'gtHeader');
+    const value = toString(header);
+    if (value.toLowerCase().startsWith('columns')) {
+      // eslint-disable-next-line no-param-reassign
+      table.type = 'columns';
+    }
+    return table;
+  });
+
+  // now that we have columns, we need to merge their children
+  findAllDeep(mdast, (node) => node.type === 'columns').forEach((column) => {
+    // find all rows of the table body
+    const rows = findAllDeep(column.children[1], (node) => node.type === 'gtRow');
+
+    rows.forEach((row) => {
+      const cells = findAllDeep(row, (node) => node.type === 'gtCell');
+
+      cells.forEach((cell) => {
+        const newChildren = [];
+        let paragraphGroup = [];
+
+        const { children } = cell;
+
+        // group elements that are not links or images into a paragraphWrapper
+        // until the next link or image
+        for (let i = 0; i < children.length; i += 1) {
+          const node = children[i];
+          // if we are a liink image, or heading we need to push the node to the new children
+          // otherwise we need to group the node and its children into a paragraphWrapper
+          if (node?.children?.length === 1
+            && (node.children[0].type === 'link'
+              || node.children[0].type === 'image'
+              || node.type === 'heading')
+          ) {
+            // if we had previously grouped nodes we need to close them off and reset
+            if (paragraphGroup.length > 0) {
+              newChildren.push({
+                type: 'paragraphWrapper',
+                children: paragraphGroup,
+              });
+              // reset the paragraphGroup
+              paragraphGroup = [];
+            }
+
+            // push the node as a new child
+            if (image.supports(node) || link.supports(node)) {
+              newChildren.push(node.children[0]);
+            } else {
+              newChildren.push(node);
+            }
+          } else {
+            // we have something that needs to be grouped into a paragraphWrapper
+            paragraphGroup.push(node);
+
+            // if it's the last node, we need to add the paragraphWrapper to the newChildren
+            if (i === children.length - 1) {
+              newChildren.push({
+                type: 'paragraphWrapper',
+                children: paragraphGroup,
+              });
+            }
+          }
+        }
+        // eslint-disable-next-line no-param-reassign
+        cell.children = newChildren;
+      });
+    });
+  });
+
+  return mdast;
+}

package/src/mdast2jcr/utils/mdast.js

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { visit } from 'unist-util-visit';
+
 /**
  * findAll goes through the children of a node searching for nodes that match a
  * test function.
@@ -42,6 +44,21 @@ function findAll(node, test, flatten = false) {
   }
 }
 
+/**
+ * Find all nodes that match the test condition
+ * @param {Node} tree - Node(s) to search
+ * @param {Function|string} test - Test function or node type
+ * @returns {Array} Array of matching nodes
+ */
+function findAllDeep(tree, test) {
+  const results = [];
+  visit(tree, test, (node) => {
+    results.push(node);
+  });
+  return results;
+}
+
 export {
   findAll,
+  findAllDeep,
 };