@adobe/helix-importer 2.4.0 → 2.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.5.0](https://github.com/adobe/helix-importer/compare/v2.4.1...v2.5.0) (2023-01-09)
+
+
+### Features
+
+* allow no element to be provided in transform returned object ([44e4167](https://github.com/adobe/helix-importer/commit/44e4167abd00e796a2b4f68a0384a9cdd8618c31))
+
+## [2.4.1](https://github.com/adobe/helix-importer/compare/v2.4.0...v2.4.1) (2023-01-07)
+
+
+### Bug Fixes
+
+* **deps:** update adobe fixes ([#61](https://github.com/adobe/helix-importer/issues/61)) ([82138df](https://github.com/adobe/helix-importer/commit/82138df79d256befb7602d8181366cf7ee454aeb))
+
 # [2.4.0](https://github.com/adobe/helix-importer/compare/v2.3.6...v2.4.0) (2023-01-05)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-importer",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Helix Importer tool: create md / docx from html",
   "main": "src/index.js",
   "type": "module",
@@ -27,7 +27,7 @@
   "devDependencies": {
     "@adobe/eslint-config-helix": "1.3.2",
     "@adobe/helix-docx2md": "1.3.7",
-    "@adobe/helix-mediahandler": "1.2.24",
+    "@adobe/helix-mediahandler": "1.2.25",
     "@semantic-release/changelog": "6.0.2",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -37,7 +37,7 @@
     "eslint-import-resolver-exports": "1.0.0-beta.3",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.26.0",
-    "husky": "8.0.2",
+    "husky": "8.0.3",
     "lint-staged": "13.1.0",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
@@ -47,7 +47,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@adobe/helix-markdown-support": "6.0.0",
-    "@adobe/helix-md2docx": "2.0.27",
+    "@adobe/helix-md2docx": "2.0.28",
     "@adobe/mdast-util-gridtables": "1.0.3",
     "@adobe/remark-gridtables": "1.0.0",
     "form-data": "4.0.0",

package/src/importer/HTML2x.js

@@ -116,9 +116,11 @@ async function html2x(
         results.forEach((result) => {
           const name = path.basename(result.path);
           const dirname = path.dirname(result.path);
-          const extra = {
-            html: result.element.outerHTML,
-          };
+          const extra = {};
+
+          if (result.element) {
+            extra.html = result.element.outerHTML;
+          }
 
           if (result.report) {
             extra.report = result.report;
@@ -182,9 +184,11 @@ async function html2x(
   const pirs = await importer.import(url);
 
   const getResponseObjectFromPIR = async (pir) => {
-    const res = {
-      html: pir.extra.html,
-    };
+    const res = {};
+
+    if (pir.extra && pir.extra.html) {
+      res.html = pir.extra.html;
+    }
 
     if (pir.extra.report) {
       res.report = pir.extra.report;
@@ -192,11 +196,11 @@ async function html2x(
 
     res.path = path.resolve(pir.directory, pir.name);
 
-    if (config.toMd) {
+    if (config.toMd && pir.md) {
       const md = await storageHandler.get(pir.md);
       res.md = md;
     }
-    if (config.toDocx) {
+    if (config.toDocx && pir.docx) {
       const docx = await storageHandler.get(pir.docx);
       res.docx = docx;
     }

package/src/importer/PageImporter.js

@@ -314,28 +314,30 @@ export default class PageImporter {
 
       if (entries) {
         await Utils.asyncForEach(entries, async (entry) => {
-          const res = await this.createMarkdown(entry, url);
-          // eslint-disable-next-line no-param-reassign
-          entry.source = url;
-          // eslint-disable-next-line no-param-reassign
-          entry.path = res.path;
-          // eslint-disable-next-line no-param-reassign
-          entry.markdown = res.content;
-
-          if (!this.params.skipMDFileCreation) {
-            const mdPath = `${res.path}.md`;
-            await this.params.storageHandler.put(mdPath, res.content);
-            this.logger.log(`MD file created: ${mdPath}`);
-
+          if (entry.document) {
+            const res = await this.createMarkdown(entry, url);
             // eslint-disable-next-line no-param-reassign
-            entry.md = mdPath;
-          }
-
-          if (!this.params.skipDocxConversion) {
-            const docxPath = `${res.path}.docx`;
-            await this.convertToDocx(docxPath, res.content);
+            entry.source = url;
             // eslint-disable-next-line no-param-reassign
-            entry.docx = docxPath;
+            entry.path = res.path;
+            // eslint-disable-next-line no-param-reassign
+            entry.markdown = res.content;
+
+            if (!this.params.skipMDFileCreation) {
+              const mdPath = `${res.path}.md`;
+              await this.params.storageHandler.put(mdPath, res.content);
+              this.logger.log(`MD file created: ${mdPath}`);
+
+              // eslint-disable-next-line no-param-reassign
+              entry.md = mdPath;
+            }
+
+            if (!this.params.skipDocxConversion) {
+              const docxPath = `${res.path}.docx`;
+              await this.convertToDocx(docxPath, res.content);
+              // eslint-disable-next-line no-param-reassign
+              entry.docx = docxPath;
+            }
           }
 
           results.push(entry);

package/test/importers/HTML2x.spec.js

@@ -230,6 +230,35 @@ describe('html2md tests', () => {
     strictEqual(out2.report.somethingElse, 'something else');
   });
 
+  it('html2md allows no element to be provided when using transform', async () => {
+    const out = await html2md('https://www.sample.com/page.html', '<html><body><h1>Hello World</h1></body></html>', {
+      transform: () => [{
+        path: '/my-custom-path-p1',
+        report: {
+          custom: 'A custom property',
+          customArray: ['a', 'b', 'c'],
+          customObject: {
+            a: 1,
+            b: true,
+            c: {
+              d: 'e',
+            },
+          },
+        },
+      }],
+    });
+
+    // if no element provided, no creation of html, md or docx
+    strictEqual(out.html, undefined);
+    strictEqual(out.md, undefined);
+    strictEqual(out.docx, undefined);
+    strictEqual(out.path, '/my-custom-path-p1');
+    ok(out.report);
+    strictEqual(out.report.custom, 'A custom property');
+    deepStrictEqual(out.report.customArray, ['a', 'b', 'c']);
+    deepStrictEqual(out.report.customObject, { a: 1, b: true, c: { d: 'e' } });
+  });
+
   it('html2md does not crash if transform returns null', async () => {
     const out = await html2md('https://www.sample.com/page.html', '<html><body><h1>Hello World</h1></body></html>', {
       transform: () => null,