@adobe/helix-importer 3.3.7 → 3.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.4.0](https://github.com/adobe/helix-importer/compare/v3.3.8...v3.4.0) (2024-05-22)
+
+
+### Features
+
+* simplify block creation [#350](https://github.com/adobe/helix-importer/issues/350) ([#351](https://github.com/adobe/helix-importer/issues/351)) ([b766954](https://github.com/adobe/helix-importer/commit/b766954210d30bd9385ea7a785dee006efcd625a))
+
+## [3.3.8](https://github.com/adobe/helix-importer/compare/v3.3.7...v3.3.8) (2024-04-27)
+
+
+### Bug Fixes
+
+* **deps:** update adobe fixes ([#344](https://github.com/adobe/helix-importer/issues/344)) ([9495d94](https://github.com/adobe/helix-importer/commit/9495d949131a13e963517195f94e89f4f193090a))
+
 ## [3.3.7](https://github.com/adobe/helix-importer/compare/v3.3.6...v3.3.7) (2024-04-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-importer",
-  "version": "3.3.7",
+  "version": "3.4.0",
   "description": "Helix Importer tool: create md / docx from html",
   "main": "src/index.js",
   "type": "module",
@@ -28,16 +28,16 @@
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.6",
     "@adobe/helix-docx2md": "1.6.0",
-    "@adobe/helix-mediahandler": "2.5.0",
+    "@adobe/helix-mediahandler": "2.5.4",
     "@esm-bundle/chai": "4.3.4-fix.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@web/test-runner": "0.18.1",
+    "@web/test-runner": "0.18.2",
     "@web/test-runner-commands": "0.9.0",
     "@web/test-runner-mocha": "0.9.0",
     "c8": "9.1.0",
-    "chai": "5.1.0",
+    "chai": "5.1.1",
     "dirname-filename-esm": "1.1.1",
     "eslint": "8.57.0",
     "husky": "9.0.11",
@@ -47,13 +47,13 @@
     "mocha-multi-reporters": "1.5.1",
     "mock-fs": "5.2.0",
     "remark-parse": "11.0.0",
-    "semantic-release": "23.0.8",
+    "semantic-release": "23.1.1",
     "unist-util-inspect": "8.0.0"
   },
   "license": "Apache-2.0",
   "dependencies": {
     "@adobe/helix-markdown-support": "7.1.2",
-    "@adobe/helix-md2docx": "2.1.55",
+    "@adobe/helix-md2docx": "2.1.56",
     "@adobe/mdast-util-gridtables": "4.0.4",
     "@adobe/remark-gridtables": "3.0.4",
     "form-data": "4.0.0",

package/src/importer/defaults/rules/createMetadata.js

@@ -12,86 +12,8 @@
 
 import Blocks from '../../../utils/Blocks.js';
 
-function getMetadata(name, document) {
-  const attr = name && name.includes(':') ? 'property' : 'name';
-  const meta = [...document.head.querySelectorAll(`meta[${attr}="${name}"]`)]
-    .map((m) => m.content)
-    .join(', ');
-  return meta || '';
-}
-
 export default function createMetadata(main, document) {
-  const meta = {};
-
-  const title = document.querySelector('title');
-  if (title) {
-    meta.Title = title.textContent.replace(/[\n\t]/gm, '');
-  }
-
-  const desc = getMetadata('description', document);
-  if (desc) {
-    meta.Description = desc;
-  }
-
-  const img = getMetadata('og:image', document);
-  if (img) {
-    const el = document.createElement('img');
-    el.src = img;
-    meta.Image = el;
-
-    const imgAlt = getMetadata('og:image:alt', document);
-    if (imgAlt) {
-      el.alt = imgAlt;
-    }
-  }
-
-  const ogtitle = getMetadata('og:title', document);
-  if (ogtitle && ogtitle !== meta.Title) {
-    if (meta.Title) {
-      meta['og:title'] = ogtitle;
-    } else {
-      meta.Title = ogtitle;
-    }
-  }
-
-  const ogdesc = getMetadata('og:description', document);
-  if (ogdesc && ogdesc !== meta.Description) {
-    if (meta.Description) {
-      meta['og:description'] = ogdesc;
-    } else {
-      meta.Description = ogdesc;
-    }
-  }
-
-  const ttitle = getMetadata('twitter:title', document);
-  if (ttitle && ttitle !== meta.Title) {
-    if (meta.Title) {
-      meta['twitter:title'] = ttitle;
-    } else {
-      meta.Title = ttitle;
-    }
-  }
-
-  const tdesc = getMetadata('twitter:description', document);
-  if (tdesc && tdesc !== meta.Description) {
-    if (meta.Description) {
-      meta['twitter:description'] = tdesc;
-    } else {
-      meta.Description = tdesc;
-    }
-  }
-
-  const timg = getMetadata('twitter:image', document);
-  if (timg && timg !== img) {
-    const el = document.createElement('img');
-    el.src = timg;
-    meta['twitter:image'] = el;
-
-    const imgAlt = getMetadata('twitter:image:alt', document);
-    if (imgAlt) {
-      el.alt = imgAlt;
-    }
-  }
+  const meta = Blocks.getMetadata(document);
 
   if (Object.keys(meta).length > 0) {
     const block = Blocks.getMetadataBlock(document, meta);

package/src/utils/Blocks.js

@@ -11,47 +11,117 @@
  */
 import DOMUtils from './DOMUtils.js';
 
-const DEFAULT_COLSPAN = 2;
+function getDocumentMetadata(name, document) {
+  const attr = name && name.includes(':') ? 'property' : 'name';
+  const meta = [...document.head.querySelectorAll(`meta[${attr}="${name}"]`)]
+    .map((m) => m.content)
+    .join(', ');
+  return meta || '';
+}
 
 export default class Blocks {
-  static getMetadataBlock(document, metadata) {
-    const table = document.createElement('table');
-
-    let row = document.createElement('tr');
-    table.append(row);
-
-    const hCell = document.createElement('th');
-    row.append(hCell);
-
-    hCell.innerHTML = 'Metadata';
-    hCell.setAttribute('colspan', DEFAULT_COLSPAN);
-
-    // eslint-disable-next-line no-restricted-syntax, guard-for-in
-    for (const key in metadata) {
-      row = document.createElement('tr');
-      table.append(row);
-      const keyCell = document.createElement('td');
-      row.append(keyCell);
-      keyCell.textContent = key;
-      const valueCell = document.createElement('td');
-      row.append(valueCell);
-      const value = metadata[key];
-      if (value) {
+  static createBlock(document, { name, variants = [], cells: data }) {
+    const headerRow = variants.length ? [`${Blocks.computeBlockName(name)} (${variants.join(', ')})`] : [Blocks.computeBlockName(name)];
+    let blockRows = data;
+    if (!Array.isArray(data)) {
+      blockRows = Object.entries(data).map(([key, value]) => {
+        let colItems = [];
         if (Array.isArray(value)) {
-          value.forEach((v) => {
+          colItems = value.map((v) => {
             const p = document.createElement('p');
             p.innerHTML = v;
-            valueCell.append(p);
+            return p;
           });
-        } else if (typeof value === 'string') {
-          valueCell.textContent = value;
         } else {
-          valueCell.append(value);
+          colItems = [value];
         }
+        return [key, colItems];
+      });
+    }
+    return DOMUtils.createTable([headerRow, ...blockRows], document);
+  }
+
+  static getMetadataBlock(document, metadata) {
+    return Blocks.createBlock(document, {
+      name: 'Metadata',
+      cells: metadata,
+    });
+  }
+
+  static getMetadata(document) {
+    const meta = {};
+
+    const title = document.querySelector('title');
+    if (title) {
+      meta.Title = title.textContent.replace(/[\n\t]/gm, '');
+    }
+
+    const desc = getDocumentMetadata('description', document);
+    if (desc) {
+      meta.Description = desc;
+    }
+
+    const img = getDocumentMetadata('og:image', document);
+    if (img) {
+      const el = document.createElement('img');
+      el.src = img;
+      meta.Image = el;
+
+      const imgAlt = getDocumentMetadata('og:image:alt', document);
+      if (imgAlt) {
+        el.alt = imgAlt;
+      }
+    }
+
+    const ogtitle = getDocumentMetadata('og:title', document);
+    if (ogtitle && ogtitle !== meta.Title) {
+      if (meta.Title) {
+        meta['og:title'] = ogtitle;
+      } else {
+        meta.Title = ogtitle;
+      }
+    }
+
+    const ogdesc = getDocumentMetadata('og:description', document);
+    if (ogdesc && ogdesc !== meta.Description) {
+      if (meta.Description) {
+        meta['og:description'] = ogdesc;
+      } else {
+        meta.Description = ogdesc;
+      }
+    }
+
+    const ttitle = getDocumentMetadata('twitter:title', document);
+    if (ttitle && ttitle !== meta.Title) {
+      if (meta.Title) {
+        meta['twitter:title'] = ttitle;
+      } else {
+        meta.Title = ttitle;
+      }
+    }
+
+    const tdesc = getDocumentMetadata('twitter:description', document);
+    if (tdesc && tdesc !== meta.Description) {
+      if (meta.Description) {
+        meta['twitter:description'] = tdesc;
+      } else {
+        meta.Description = tdesc;
+      }
+    }
+
+    const timg = getDocumentMetadata('twitter:image', document);
+    if (timg && timg !== img) {
+      const el = document.createElement('img');
+      el.src = timg;
+      meta['twitter:image'] = el;
+
+      const imgAlt = getDocumentMetadata('twitter:image:alt', document);
+      if (imgAlt) {
+        el.alt = imgAlt;
       }
     }
 
-    return table;
+    return meta;
   }
 
   static computeBlockName(str) {

package/src/utils/DOMUtils.js

@@ -180,9 +180,7 @@ export default class DOMUtils {
         if (typeof cell === 'string') {
           t.innerHTML = cell;
         } else if (Array.isArray(cell)) {
-          cell.forEach((c) => {
-            t.append(c);
-          });
+          t.append(...cell);
         } else {
           t.append(cell);
         }

package/test/utils/Blocks.spec.js

@@ -140,3 +140,34 @@ describe('Blocks#getMetadataBlock tests', () => {
     test({ title: 'Some title', Tags: ['Creative', 'Experience Cloud', 'Photography'] }, '<table><tr><th colspan="2">Metadata</th></tr><tr><td>title</td><td>Some title</td></tr><tr><td>Tags</td><td><p>Creative</p><p>Experience Cloud</p><p>Photography</p></td></tr></table>');
   });
 });
+
+describe('Blocks#createBlock tests', () => {
+  const test = (name, variants = [], cells = [], expected = '') => {
+    const { document } = (new JSDOM()).window;
+    const table = Blocks.createBlock(document, { name, variants, cells });
+    strictEqual(trim(table.outerHTML), trim(expected));
+  };
+
+  it('createBlock empty block', () => {
+    test('test block', [], [], '<table><tr><th>Test Block</th></tr></table>');
+    test('Test Block', [], [], '<table><tr><th>Test Block</th></tr></table>');
+  });
+
+  it('createBlock with variants', () => {
+    test('test block', ['variant-1'], [], '<table><tr><th>Test Block (variant-1)</th></tr></table>');
+    test('test block', ['variant-1', 'variant-2'], [], '<table><tr><th>Test Block (variant-1, variant-2)</th></tr></table>');
+  });
+
+  it('createBlock block config', () => {
+    test('Test Block', [], { title: 'Some title' }, '<table><tr><th colspan="2">Test Block</th></tr><tr><td>title</td><td>Some title</td></tr></table>');
+    test('Test Block', [], { Author: 'Name of the author', 'Creation Date': '2022/01/01' }, '<table><tr><th colspan="2">Test Block</th></tr><tr><td>Author</td><td>Name of the author</td></tr><tr><td>Creation Date</td><td>2022/01/01</td></tr></table>');
+  });
+
+  it('createBlock cell array', () => {
+    const cells = [
+      ['Row 1 - Col 1', 'Row 1 - Col 2'],
+      ['Row 2 - Col 1', 'Row 2 - Col 2'],
+    ];
+    test('Test Block', [], cells, '<table><tr><th colspan="2">Test Block</th></tr><tr><td>Row 1 - Col 1</td><td>Row 1 - Col 2</td></tr><tr><td>Row 2 - Col 1</td><td>Row 2 - Col 2</td></tr></table>');
+  });
+});