@adobe/helix-importer 2.6.0 → 2.8.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.8.0](https://github.com/adobe/helix-importer/compare/v2.7.0...v2.8.0) (2023-02-08)
+
+
+### Features
+
+* add waitForElement DOMUtils ([#94](https://github.com/adobe/helix-importer/issues/94)) ([ca041f3](https://github.com/adobe/helix-importer/commit/ca041f30f39b0d511fbbe30a1410b2c013826a0d))
+
+# [2.7.0](https://github.com/adobe/helix-importer/compare/v2.6.0...v2.7.0) (2023-02-06)
+
+
+### Features
+
+* allow from property ([#92](https://github.com/adobe/helix-importer/issues/92)) ([91f9681](https://github.com/adobe/helix-importer/commit/91f96812ce8062d860f57fa38d1795b8df242c55))
+
 # [2.6.0](https://github.com/adobe/helix-importer/compare/v2.5.16...v2.6.0) (2023-01-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-importer",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "description": "Helix Importer tool: create md / docx from html",
   "main": "src/index.js",
   "type": "module",
@@ -26,25 +26,25 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.1",
-    "@adobe/helix-docx2md": "1.3.13",
-    "@adobe/helix-mediahandler": "2.0.4",
+    "@adobe/helix-docx2md": "1.3.14",
+    "@adobe/helix-mediahandler": "2.0.6",
     "@semantic-release/changelog": "6.0.2",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "c8": "7.12.0",
     "dirname-filename-esm": "1.1.1",
-    "eslint": "8.32.0",
+    "eslint": "8.33.0",
     "husky": "8.0.3",
     "lint-staged": "13.1.0",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "mock-fs": "5.2.0",
-    "semantic-release": "19.0.5"
+    "semantic-release": "20.1.0"
   },
   "license": "Apache-2.0",
   "dependencies": {
     "@adobe/helix-markdown-support": "6.1.1",
-    "@adobe/helix-md2docx": "2.0.37",
+    "@adobe/helix-md2docx": "2.0.39",
     "@adobe/mdast-util-gridtables": "1.0.6",
     "@adobe/remark-gridtables": "1.0.2",
     "form-data": "4.0.0",

package/src/importer/HTML2x.js

@@ -120,6 +120,8 @@ async function html2x(
 
           if (result.element) {
             extra.html = result.element.outerHTML;
+          } else if (result.from) {
+            extra.from = result.from;
           }
 
           if (result.report) {
@@ -190,6 +192,10 @@ async function html2x(
       res.html = pir.extra.html;
     }
 
+    if (pir.extra.from) {
+      res.from = pir.extra.from;
+    }
+
     if (pir.extra.report) {
       res.report = pir.extra.report;
     }

package/src/index.js

@@ -23,6 +23,7 @@ import Blocks from './utils/Blocks.js';
 import CSV from './utils/CSV.js';
 import DOMUtils from './utils/DOMUtils.js';
 import FileUtils from './utils/FileUtils.js';
+import Loader from './utils/Loader.js';
 import Utils from './utils/Utils.js';
 
 import WPUtils from './wp/WPUtils.js';
@@ -44,6 +45,7 @@ export {
   CSV,
   DOMUtils,
   FileUtils,
+  Loader,
   Utils,
   WPUtils,
   WPAdminAjaxPager,

package/src/utils/DOMUtils.js

@@ -263,4 +263,19 @@ export default class DOMUtils {
     }
     return null;
   }
+
+  static async waitForElement(selector, document, timeout = 5000, interval = 250) {
+    return new Promise((resolve, reject) => {
+      const timeWas = new Date();
+      const wait = setInterval(() => {
+        if (document.querySelector(selector)) {
+          clearInterval(wait);
+          resolve();
+        } else if (new Date() - timeWas > timeout) { // Timeout
+          clearInterval(wait);
+          reject();
+        }
+      }, interval);
+    });
+  }
 }

package/src/utils/Loader.js

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+
+export default class Loader {
+  static async waitForElement(selector, document, timeout = 5000, interval = 250) {
+    return new Promise((resolve, reject) => {
+      const timeWas = new Date();
+      const wait = setInterval(() => {
+        if (document.querySelector(selector)) {
+          clearInterval(wait);
+          resolve();
+        } else if (new Date() - timeWas > timeout) { // Timeout
+          clearInterval(wait);
+          reject();
+        }
+      }, interval);
+    });
+  }
+}

package/test/importers/HTML2x.spec.js

@@ -234,6 +234,7 @@ describe('html2md tests', () => {
     const out = await html2md('https://www.sample.com/page.html', '<html><body><h1>Hello World</h1></body></html>', {
       transform: () => [{
         path: '/my-custom-path-p1',
+        from: 'https://www.sample.com/page.html',
         report: {
           custom: 'A custom property',
           customArray: ['a', 'b', 'c'],
@@ -253,6 +254,7 @@ describe('html2md tests', () => {
     strictEqual(out.md, undefined);
     strictEqual(out.docx, undefined);
     strictEqual(out.path, '/my-custom-path-p1');
+    strictEqual(out.from, 'https://www.sample.com/page.html');
     ok(out.report);
     strictEqual(out.report.custom, 'A custom property');
     deepStrictEqual(out.report.customArray, ['a', 'b', 'c']);

package/test/utils/Loader.spec.js

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2020 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.
+ */
+
+/* eslint-disable no-shadow */
+
+import { rejects, doesNotReject } from 'assert';
+import { describe, it } from 'mocha';
+
+import { JSDOM } from 'jsdom';
+
+import Loader from '../../src/utils/Loader.js';
+
+describe('Loader#waitForElement', () => {
+  it('should fail for non existing element', async () => {
+    const { document } = (new JSDOM()).window;
+    const div = document.createElement('div');
+    document.body.appendChild(div);
+    await rejects(async () => {
+      await Loader.waitForElement('.dummy', document, 25, 20);
+    });
+  });
+
+  it('should find existing element', async () => {
+    const { document } = (new JSDOM()).window;
+    const div = document.createElement('div');
+    div.classList.add('dummy');
+    document.body.appendChild(div);
+    await doesNotReject(async () => {
+      await Loader.waitForElement('.dummy', document, 100, 20);
+    });
+  });
+
+  it('should wait for element to appear in the DOM', async () => {
+    const { document } = (new JSDOM()).window;
+    setTimeout(() => {
+      const div = document.createElement('div');
+      div.classList.add('dummy');
+      document.body.appendChild(div);
+    }, 50);
+    await doesNotReject(async () => {
+      await Loader.waitForElement('.dummy', document, 100, 20);
+    });
+  });
+});