@adobe/helix-md2jcr 1.0.6 → 1.0.8

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.0.8](https://github.com/adobe/helix-md2jcr/compare/v1.0.7...v1.0.8) (2025-02-04)
+
+
+### Bug Fixes
+
+* **sites-28652:** include model fields property into the generated xml node structure ([#45](https://github.com/adobe/helix-md2jcr/issues/45)) ([7699250](https://github.com/adobe/helix-md2jcr/commit/769925099ccb7edb37544dc5767aec857297ed4a))
+* **sites-28737:** title should use title and not jcr:title ([#47](https://github.com/adobe/helix-md2jcr/issues/47)) ([e843c08](https://github.com/adobe/helix-md2jcr/commit/e843c0876e3a40473e06b40b999977ce6bee3422))
+
+## [1.0.7](https://github.com/adobe/helix-md2jcr/compare/v1.0.6...v1.0.7) (2025-02-03)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#44](https://github.com/adobe/helix-md2jcr/issues/44)) ([61fe813](https://github.com/adobe/helix-md2jcr/commit/61fe8134caba1f43b85264a2692cc478e3e09866))
+
 ## [1.0.6](https://github.com/adobe/helix-md2jcr/compare/v1.0.5...v1.0.6) (2025-02-03)
 
 

package/baseline-tests.sh

@@ -65,7 +65,7 @@ for MD_FILE in $MD_FILES; do
   # if VERBOSE is true then echo a new line
   [ "$VERBOSE" = "true" ] && echo
 
-  node "$NODE_SCRIPT" "$MD_FILE" $ARGS
+  node "$NODE_SCRIPT" "$MD_FILE" $ARGS 2>/dev/null
 
   # Check if the Node.js script executed successfully
   if [ $? -ne 0 ]; then

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",
@@ -37,7 +37,7 @@
     "handlebars": "^4.7.8",
     "hast-util-is-element": "3.0.0",
     "hast-util-to-html": "^9.0.3",
-    "hast-util-to-mdast": "10.1.1",
+    "hast-util-to-mdast": "10.1.2",
     "image-size": "1.2.0",
     "mdast-util-to-hast": "^13.2.0",
     "mdast-util-to-string": "^4.0.0",
@@ -55,7 +55,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.8",
-    "@adobe/helix-mediahandler": "2.5.48",
+    "@adobe/helix-mediahandler": "2.5.49",
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
     "@semantic-release/changelog": "6.0.3",

package/src/mdast2jcr/domain/Models.js

@@ -21,13 +21,14 @@
  * Get the model id from the array of models.
  * @param {Array<Model>} models The array of models.
  * @param {string} modelId The model id.
- * @return {Model}
+ * @return {Model|null} The model or undefined if not found.
  */
 function findModelById(models, modelId) {
-  if (!models || Object.keys(models)?.length === 0) {
-    throw new Error('No models are provided. Check your model\'s JSON file.');
+  if (models && Object.keys(models)?.length > 0) {
+    return models.find((model) => model.id === modelId);
+  } else {
+    return undefined;
   }
-  return models.find((model) => model.id === modelId);
 }
 
 /**
@@ -40,7 +41,21 @@ function getField(model, fieldName) {
   return model.fields.find((field) => field.name === fieldName);
 }
 
+/**
+ * Return a comma-separated list of fields in the model. If no fields are found,
+ * return an empty string.
+ * @param model
+ * @return {string}
+ */
+function getModelFields(model) {
+  return model.fields
+    .map((f) => f.name)
+    .filter((f) => f !== 'classes')
+    .join(',');
+}
+
 export {
   getField,
   findModelById,
+  getModelFields,
 };

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

@@ -11,7 +11,7 @@
  */
 import { find } from 'unist-util-find';
 import { toString } from 'mdast-util-to-string';
-import { findModelById, getField } from '../../domain/Models.js';
+import { findModelById, getField, getModelFields } from '../../domain/Models.js';
 import { findAll } from '../../utils/mdast.js';
 import { encodeHTMLEntities, stripNewlines } from '../../utils.js';
 import link from '../partials/supports/link.js';
@@ -66,6 +66,11 @@ function buildPageMetadata(table, models) {
     mappedMetadata[mappedKey] = value;
   });
 
+  if (model) {
+    const fields = getModelFields(model);
+    mappedMetadata.modelFields = `[${fields}]`;
+  }
+
   return mappedMetadata;
 }
 

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

@@ -13,13 +13,24 @@ import Handlebars from 'handlebars';
 import { find } from 'unist-util-find';
 import { toString } from 'mdast-util-to-string';
 import { findAll } from '../../utils/mdast.js';
+import { findModelById, getModelFields } from '../../domain/Models.js';
 
 function sectionHelper(index, children, options) {
+  const {
+    models,
+  } = options.data.root;
+
   const attributes = {
     'sling:resourceType': 'core/franklin/components/section/v1/section',
     'jcr:primaryType': 'nt:unstructured',
   };
 
+  const model = findModelById(models, 'section-metadata');
+  if (model) {
+    const fields = getModelFields(model);
+    attributes.modelFields = `[${fields}]`;
+  }
+
   const uniqueName = Handlebars.helpers.nameHelper.call(this, 'section');
 
   // find the table that has a gtHeader that has a header value that contains 'section-metadata'

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

@@ -18,7 +18,7 @@ import { toHast } from 'mdast-util-to-hast';
 import { toHtml } from 'hast-util-to-html';
 import { getComponentById, getComponentByTitle, getModelId } from '../../domain/Definitions.js';
 import {
-  findModelById, getField,
+  findModelById, getField, getModelFields,
 } from '../../domain/Models.js';
 import { findAll } from '../../utils/mdast.js';
 import link from './supports/link.js';
@@ -371,8 +371,13 @@ function getBlockItems(mdast, modelHelper, definitions, allowedComponents) {
       const fieldGroup = modelHelper.getModelFieldGroup(componentId);
       if (fieldGroup) {
         const component = getComponentById(definitions, componentId);
-        const properties = { ...component.defaultFields };
+        const properties = {
+          ...component.defaultFields,
+          modelFields: `[${getModelFields(fieldGroup.model)}]`,
+        };
+
         extractProperties(row, fieldGroup.model, 'blockItem', component, fieldGroup.fields, properties);
+
         items.push(`<item_${items.length} 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}>`);
       }
     } else {
@@ -442,6 +447,10 @@ function gridTablePartial(context) {
     ...blockHeaderProperties,
   };
 
+  if (model) {
+    properties.modelFields = `[${getModelFields(model)}]`;
+  }
+
   let blockProperties = '';
   let fieldGroup;
 

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

@@ -47,7 +47,7 @@ function heading(context) {
 
   title = Handlebars.Utils.escapeExpression(context.children.map(parseInlineElements).join(''));
 
-  return `<title${uniqueName} sling:resourceType="core/franklin/components/title/v1/title" jcr:primaryType="nt:unstructured" jcr:title="${title}" type="h${depth}"/>\n`;
+  return `<title${uniqueName} sling:resourceType="core/franklin/components/title/v1/title" jcr:primaryType="nt:unstructured" title="${title}" type="h${depth}"/>\n`;
 }
 
 export default heading;