@adobe/helix-importer 1.3.0 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [1.5.0](https://github.com/adobe/helix-importer/compare/v1.4.1...v1.5.0) (2022-02-24)
+
+
+### Features
+
+* helper method to get an image from background image style ([#17](https://github.com/adobe/helix-importer/issues/17)) ([63a384d](https://github.com/adobe/helix-importer/commit/63a384dceb75e6815115ffd1c37c321fc7476ab6))
+
+## [1.4.1](https://github.com/adobe/helix-importer/compare/v1.4.0...v1.4.1) (2022-02-24)
+
+
+### Bug Fixes
+
+* some images come with wrong src in md ([#16](https://github.com/adobe/helix-importer/issues/16)) ([7f27432](https://github.com/adobe/helix-importer/commit/7f274326683313cd11c2a92bb1c01c1960de5fcd))
+
+# [1.4.0](https://github.com/adobe/helix-importer/compare/v1.3.0...v1.4.0) (2022-02-02)
+
+
+### Features
+
+* add docxStylesXML param support ([1a10784](https://github.com/adobe/helix-importer/commit/1a1078453f1f5d761cf7f64addc013f8b73dc225))
+
 # [1.3.0](https://github.com/adobe/helix-importer/compare/v1.2.2...v1.3.0) (2022-01-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-importer",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Helix Importer tool: create md / docx from html",
   "main": "src/index.js",
   "type": "module",
@@ -47,7 +47,7 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "@adobe/helix-md2docx": "1.2.3",
+    "@adobe/helix-md2docx": "1.3.0",
     "form-data": "4.0.0",
     "fs-extra": "10.0.0",
     "hast-util-to-html": "8.0.3",

package/src/importer/PageImporter.js

@@ -25,6 +25,7 @@ import { md2docx } from '@adobe/helix-md2docx';
 import Utils from '../utils/Utils.js';
 import DOMUtils from '../utils/DOMUtils.js';
 import FileUtils from '../utils/FileUtils.js';
+import MDUtils from '../utils/MDUtils.js';
 
 export default class PageImporter {
   params;
@@ -41,7 +42,7 @@ export default class PageImporter {
   }
 
   async convertToDocx(docxPath, content) {
-    const buffer = await md2docx(content, this.logger);
+    const buffer = await md2docx(content, this.logger, this.params.docxStylesXML);
     return this.params.storageHandler.put(docxPath, buffer);
   }
 
@@ -112,7 +113,7 @@ export default class PageImporter {
             });
           }
         } catch (error) {
-          this.logger.warn(`Invalid link in the page: ${href}`);
+          this.logger.warn(`Invalid link in the page: ${href}`, error);
         }
       }
     });
@@ -138,19 +139,15 @@ export default class PageImporter {
             });
           }
         } catch (error) {
-          this.logger.warn(`Invalid video in the page: ${src}`);
+          this.logger.warn(`Invalid video in the page: ${src}`, error);
         }
       }
     });
 
-    const patchSrcInContent = (c, oldSrc, newSrc) => contents
-      .replace(new RegExp(`${oldSrc.replace('.', '\\.').replace('?', '\\?')}`, 'gm'), newSrc)
-      .replace(new RegExp(`${decodeURI(oldSrc).replace('.', '\\.')}`, 'gm'), newSrc);
-
     // adjust assets url (from relative to absolute)
     assets.forEach((asset) => {
       const u = new URL(decodeURI(asset.url), url);
-      contents = patchSrcInContent(contents, asset.url, u.toString());
+      contents = MDUtils.replaceSrcInMarkdown(contents, asset.url, u.toString());
     });
 
     if (resource.prepend) {

package/src/importer/PageImporterParams.js

@@ -20,4 +20,6 @@ export default class PageImporterParams {
   skipMDFileCreation;
 
   logger;
+
+  docxStylesXML;
 }

package/src/utils/DOMUtils.js

@@ -231,14 +231,22 @@ export default class DOMUtils {
   }
 
   static replaceBackgroundByImg(element, document) {
+    const img = DOMUtils.getImgFromBackground(element, document);
+    if (img) {
+      element.replaceWith(img);
+      return img;
+    }
+    return element;
+  }
+
+  static getImgFromBackground(element, document) {
     const url = element?.style?.['background-image'];
     if (url) {
       const src = url.replace(/url\(/gm, '').replace(/'/gm, '').replace(/\)/gm, '');
       const img = document.createElement('img');
       img.src = src;
-      element.replaceWith(img);
       return img;
     }
-    return element;
+    return null;
   }
 }

package/src/utils/MDUtils.js

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+export default class MDUtils {
+  static replaceSrcInMarkdown = (md, oldSrc, newSrc) => {
+    if (decodeURI(oldSrc) !== oldSrc) {
+      return md.replace(new RegExp(`${decodeURI(oldSrc).replace('.', '\\.')}`, 'gm'), newSrc);
+    } else {
+      return md.replace(new RegExp(`${oldSrc.replace('.', '\\.').replace('?', '\\?')}`, 'gm'), newSrc);
+    }
+  };
+}

package/test/importers/PageImporter.spec.js

@@ -89,6 +89,32 @@ describe('PageImporter tests - various options', () => {
     });
     strictEqual(md, test, 'valid backward conversion');
   });
+
+  it('import - can provide a custom styles.xml', async () => {
+    const docxStylesXML = await fs.readFile(path.resolve(__dirname, 'fixtures', 'custom-styles.xml'), 'utf-8');
+    const storageHandler = new MemoryHandler(logger);
+    const config = {
+      storageHandler,
+      logger,
+      docxStylesXML,
+    };
+    const se = new Test(config);
+    const results = await se.import('/someurl');
+
+    strictEqual(results.length, 1, 'expect no result');
+
+    ok(await storageHandler.exists('/someurl/somecomputedpath/resource1.md'), 'md has been stored');
+    ok(await storageHandler.exists('/someurl/somecomputedpath/resource1.docx'), 'docx has been stored');
+
+    const md = await storageHandler.get('/someurl/somecomputedpath/resource1.md');
+    strictEqual(md, '# heading1\n\nparagraph\n', 'valid markdown created');
+
+    const docx = await storageHandler.get('/someurl/somecomputedpath/resource1.docx');
+    const test = await docx2md(docx, {
+      mediaHandler: new MockMediaHandler(),
+    });
+    strictEqual(md, test, 'valid backward conversion');
+  });
 });
 
 describe('PageImporter tests - fixtures', () => {