@adobe/helix-md2jcr 1.0.0

package/src/mdast2jcr/domain/Models.js

@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+
+/**
+ * @typedef {import('../mdast2jcr/index.d.ts').ModelDef} Model
+ * @typedef {import('../mdast2jcr/index.d.ts').DefinitionDef} Definition
+ * @typedef {import('../mdast2jcr/index.d.ts').CollapsedFields} CollapsedFields
+ * @typedef {import('../mdast2jcr/index.d.ts').FieldDef} Field
+ */
+
+/**
+ * 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}
+ */
+function findModelById(models, modelId) {
+  if (!models || Object.keys(models)?.length === 0) {
+    throw new Error('No models are provided. Check your model\'s JSON file.');
+  }
+  return models.find((model) => model.id === modelId);
+}
+
+/**
+ * Given a model, return the field with the given name.
+ * @param {Model} model The model.
+ * @param {string} fieldName The name of the field to get.
+ * @return {Field} field The field or undefined if not found.
+ */
+function getField(model, fieldName) {
+  return model.fields.find((field) => field.name === fieldName);
+}
+
+export {
+  getField,
+  findModelById,
+};

package/src/mdast2jcr/hast-table-cell-handler.js

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/*
+   copied and adapted (adding align) from
+   https://github.com/syntax-tree/hast-util-to-mdast/blob/main/lib/handlers/table-cell.js
+ */
+
+'use strict';
+
+export default function cell(state, node) {
+  const wrap = state.wrapText;
+
+  // eslint-disable-next-line no-param-reassign
+  state.wrapText = false;
+
+  const result = {
+    type: 'tableCell',
+    children: state.all(node),
+  };
+  state.patch(node, result);
+
+  if (node.properties?.rowSpan || node.properties?.colSpan || node.properties?.align) {
+    const data = result.data || (result.data = {});
+    if (node.properties.rowSpan) {
+      data.rowSpan = node.properties.rowSpan;
+    }
+    if (node.properties.colSpan) {
+      data.colSpan = node.properties.colSpan;
+    }
+    if (node.properties.align) {
+      data.align = node.properties.align;
+    }
+  }
+  // eslint-disable-next-line no-param-reassign
+  state.wrapText = wrap;
+
+  return result;
+}

package/src/mdast2jcr/hast-table-handler.js

@@ -0,0 +1,126 @@
+/*
+ * Copyright 2021 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.
+ */
+
+'use strict';
+
+/*
+   copied and adapted from
+   https://github.com/syntax-tree/hast-util-to-mdast/blob/main/lib/handlers/table.js
+ */
+
+// Ensure the cells in a row are properly structured.
+function toCells(children) {
+  const nodes = [];
+  let queue;
+
+  children.forEach((node) => {
+    if (node.type === 'tableCell') {
+      if (queue) {
+        // eslint-disable-next-line no-param-reassign
+        node.children = queue.concat(node.children);
+        queue = undefined;
+      }
+
+      nodes.push(node);
+    } else {
+      if (!queue) {
+        queue = [];
+      }
+      queue.push(node);
+    }
+  });
+
+  if (queue) {
+    let node = nodes[nodes.length - 1];
+
+    if (!node) {
+      node = { type: 'tableCell', children: [] };
+      nodes.push(node);
+    }
+
+    node.children = node.children.concat(queue);
+  }
+
+  return nodes;
+}
+
+// Ensure the rows are properly structured.
+function toRows(children) {
+  const nodes = [];
+  let queue;
+
+  children.forEach((node) => {
+    if (node.type === 'tableRow') {
+      if (queue) {
+        // eslint-disable-next-line no-param-reassign
+        node.children = queue.concat(node.children);
+        queue = undefined;
+      }
+
+      nodes.push(node);
+    } else {
+      if (!queue) queue = [];
+      queue.push(node);
+    }
+  });
+
+  if (queue) {
+    const node = nodes[nodes.length - 1];
+    node.children = node.children.concat(queue);
+  }
+  nodes.forEach((node) => {
+    // eslint-disable-next-line no-param-reassign
+    node.children = toCells(node.children);
+  });
+
+  return nodes;
+}
+
+export default function table(state, node) {
+  const mdNode = {
+    type: 'table',
+    children: toRows(state.all(node)),
+    // clean up table in respect to row and colspan and compute alignments
+    align: [],
+    maxCols: 0,
+  };
+
+  // compute the number of cells in each row, respecting the row and col spans.
+  const pendingRowSpans = [];
+  for (const row of mdNode.children) {
+    row.numCols = pendingRowSpans.shift() || 0;
+    for (const cell of row.children) {
+      const rowSpan = Number.parseInt(cell.data?.rowSpan || '1', 10);
+      const colSpan = Number.parseInt(cell.data?.colSpan || '1', 10);
+      if (cell.data?.align && !mdNode.align[row.numCols]) {
+        mdNode.align[row.numCols] = cell.data.align;
+      }
+      row.numCols += colSpan;
+      if (rowSpan > 1) {
+        for (let i = 0; i < rowSpan - 1; i += 1) {
+          pendingRowSpans[i] = (pendingRowSpans[i] || 0) + colSpan;
+        }
+      }
+    }
+    mdNode.maxCols = Math.max(mdNode.maxCols, row.numCols);
+  }
+
+  // add empty cells if needed
+  for (const row of mdNode.children) {
+    for (let i = row.numCols; i < mdNode.maxCols; i += 1) {
+      row.children.push({ type: 'tableCell', children: [] });
+    }
+    delete row.numCols;
+  }
+
+  return mdNode;
+}

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

@@ -0,0 +1,18 @@
+/*
+ * 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';
+
+function encodeHelper(options) {
+  return Handlebars.Utils.escapeExpression(options.fn(this));
+}
+
+export default encodeHelper;

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

@@ -0,0 +1,61 @@
+/*
+ * 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.
+ */
+
+/**
+ * An object that keeps track of the number of times a certain node has been
+ * added.  Each time a node is added, the counter is incremented, thereby
+ * generating a unique name for the node.
+ */
+const nameCounter = [];
+
+/**
+ * The name helper function keeps track of the number of times a certain node
+ * has been created, and returns a unique name for it.  The format of the name
+ * is the name of the node followed by an underscore and a number.  For example,
+ * if the name of the node is 'title', the first node will have no underscore or
+ * number.  A second occurrence of the node will have the name '_1', and so on.
+ *
+ * Special handling is done for the 'section' node.  The 'section' node is treated
+ * as a top level node, and the name counter is reset each time a 'section' node.
+ *
+ * @param name The node name (e.g. 'title', 'section')
+ * @returns {string} The unique name for the node (e.g. '', '_1', '_2')
+ * or an empty string if the node is unique.
+ */
+function nameHelper(name) {
+  // 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({});
+  }
+
+  // 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}` : '';
+  }
+
+  // get the current counter
+  const currentCounter = nameCounter[nameCounter.length - 1];
+
+  // increment the counter for the node name
+  currentCounter[name] = (currentCounter[name] || 0) + 1;
+
+  // return the counter value if it is greater than 1 (the node is not unique)
+  return currentCounter[name] > 1 ? `_${currentCounter[name] - 1}` : '';
+}
+
+export function nameReset() {
+  nameCounter.length = 0;
+}
+
+export default nameHelper;

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

@@ -0,0 +1,109 @@
+/*
+ * 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 { find } from 'unist-util-find';
+import { toString } from 'mdast-util-to-string';
+import { findModelById, getField } from '../../domain/Models.js';
+import { findAll } from '../../utils/mdast.js';
+import { encodeHTMLEntities, stripNewlines } from '../../utils.js';
+import link from '../partials/supports/link.js';
+import image from '../partials/supports/image.js';
+
+function buildPageMetadata(table, models) {
+  const aemMapping = {
+    description: 'jcr:description',
+    canonical: 'cq:canonicalUrl',
+    robots: 'cq:robotsTags',
+    title: 'jcr:title',
+  };
+
+  const model = findModelById(models, 'page-metadata');
+
+  const isMultiField = (fieldName) => {
+    const field = getField(model, fieldName.name);
+    return field && (field.component === 'multiselect' || field.component === 'aem-tag' || field.component === 'checkbox-group' || field.multi);
+  };
+
+  const metadata = {};
+  const [, ...rows] = findAll(table, (node) => node.type === 'gtRow', false);
+  rows.forEach((row) => {
+    const cells = findAll(row, (node) => node.type === 'gtCell', true);
+    const key = toString(cells[0]);
+
+    // if the model has the field, then add it to the metadata
+    const field = getField(model, key);
+    if (field) {
+      // if the field is an image then we need to dig into the row to find the image
+      if (find(row.children[1], { type: 'image' })) {
+        const { url } = image.getProperties(row);
+        metadata['xwalk:imageReference'] = url;
+      } else if (link.supports(row)) {
+        const { href } = link.getProperties(row);
+        metadata[field.name] = href;
+      } else {
+        let value = stripNewlines(cells[1]);
+        if (isMultiField(field)) {
+          value = value.split(',').map((v) => encodeHTMLEntities(v.trim()));
+          value = value.length > 0 ? `[${value.join(',')}]` : '';
+        }
+        metadata[field.name] = value;
+      }
+    }
+  });
+
+  // now go through the metadata and map the fields to aem fields
+  const mappedMetadata = {};
+  Object.entries(metadata).forEach(([key, value]) => {
+    const mappedKey = aemMapping[key] || key;
+    mappedMetadata[mappedKey] = value;
+  });
+
+  return mappedMetadata;
+}
+
+function pageHelper(options) {
+  const {
+    models,
+    ...mdast
+  } = options.data.root;
+
+  const attributes = {
+    'cq:template': '/libs/core/franklin/templates/page',
+    'sling:resourceType': 'core/franklin/components/page/v1/page',
+    'jcr:primaryType': 'cq:PageContent',
+  };
+
+  const tables = findAll(mdast, (node) => node.type === 'gridTable', false);
+  if (tables) {
+    tables.forEach((table) => {
+      const cell = find(table, { type: 'gtCell' });
+      if (cell) {
+        const isMetadata = toString(cell).toLowerCase() === 'metadata';
+        if (isMetadata) {
+          const meta = buildPageMetadata(table, models, attributes);
+          Object.assign(attributes, meta);
+        }
+      }
+    });
+  }
+
+  // pull the image reference out of the attributes
+  const { 'xwalk:imageReference': imageRef, ...properties } = attributes;
+  const attributesStr = Object.entries(properties).map(([k, v]) => `${k}="${v}"`).join(' ');
+
+  return `<jcr:content ${attributesStr}>
+    ${options.fn(this)}
+    ${imageRef ? `<image jcr:primaryType="nt:unstructured" fileReference="${imageRef}" />` : ''}
+    </jcr:content>
+  `;
+}
+
+export default pageHelper;

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

@@ -0,0 +1,53 @@
+/*
+ * 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 { find } from 'unist-util-find';
+import { toString } from 'mdast-util-to-string';
+import { findAll } from '../../utils/mdast.js';
+
+function sectionHelper(index, children, options) {
+  const attributes = {
+    'sling:resourceType': 'core/franklin/components/section/v1/section',
+    'jcr:primaryType': 'nt:unstructured',
+  };
+
+  const uniqueName = Handlebars.helpers.nameHelper.call(this, 'section');
+
+  // find the table that has a gtHeader that has a header value that contains 'section-metadata'
+  for (const child of children) {
+    if (child.type === 'gridTable') {
+      const cell = find(child, { type: 'gtCell' });
+      if (cell) {
+        const isMetadata = toString(cell).toLowerCase().replaceAll(' ', '-') === 'section-metadata';
+        if (isMetadata) {
+          const [, ...rows] = findAll(child, (n) => n.type === 'gtRow', false);
+          for (const row of rows) {
+            const cells = findAll(row, (n) => n.type === 'gtCell', true);
+            const key = toString(cells[0]);
+            const value = toString(cells[1]);
+            if (key === 'Style') {
+              attributes.classes = value;
+            } else {
+              attributes[`data-${key.toLowerCase().replaceAll(' ', '-')}`] = value;
+            }
+          }
+          break;
+        }
+      }
+    }
+  }
+
+  const attributesStr = Object.entries(attributes).map(([k, v]) => `${k}="${v}"`).join(' ');
+  return `<section${uniqueName} ${attributesStr}>${options.fn(this)}</section${uniqueName}>`;
+}
+
+export default sectionHelper;

package/src/mdast2jcr/hb/helpers/which-partial-helper.js

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+/**
+ * Partial Resolver will return the partial helper that's associated with the
+ * type.
+ * @param type the type of partial
+ * @returns {string} the partial type
+ */
+function whichPartialHelper(type) {
+  return type;
+}
+
+export default whichPartialHelper;

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

@@ -0,0 +1,16 @@
+/*
+ * 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.
+ */
+function blockQuotePartial() {
+  return '<section></section>\n';
+}
+
+export default blockQuotePartial;

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

@@ -0,0 +1,34 @@
+/*
+ * 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';
+
+function emphasis(context) {
+  const uniqueName = Handlebars.helpers.nameHelper.call(context, 'button');
+  const { children: [child] } = context;
+  const { title, url, children: [{ value }] } = child;
+  const attributes = {
+    'sling:resourceType': 'core/franklin/components/button/v1/button',
+    'jcr:primaryType': 'nt:unstructured',
+    link: url,
+    linkText: value,
+    linkType: 'secondary',
+  };
+  if (title != null) {
+    attributes.linkTitle = title;
+  }
+
+  const attributesStr = Object.entries(attributes).map(([k, v]) => `${k}="${v}"`).join(' ');
+  return `<button${uniqueName} ${attributesStr}  />`;
+}
+
+export default emphasis;