@adobe/helix-md2docx 1.2.3 → 1.3.3

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.3.3](https://github.com/adobe/helix-md2docx/compare/v1.3.2...v1.3.3) (2022-02-04)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-fetch to v3.0.3 ([#21](https://github.com/adobe/helix-md2docx/issues/21)) ([9e6848a](https://github.com/adobe/helix-md2docx/commit/9e6848a99b88236e6e09ebc92ea126cca9d15820))
+
+## [1.3.2](https://github.com/adobe/helix-md2docx/compare/v1.3.1...v1.3.2) (2022-02-04)
+
+
+### Bug Fixes
+
+* **deps:** update adobe fixes ([2f017a9](https://github.com/adobe/helix-md2docx/commit/2f017a9a2b607df988b04a2452b93c4caae631e2))
+
+## [1.3.1](https://github.com/adobe/helix-md2docx/compare/v1.3.0...v1.3.1) (2022-02-03)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-process-queue to v1.1.1 ([#19](https://github.com/adobe/helix-md2docx/issues/19)) ([97db05e](https://github.com/adobe/helix-md2docx/commit/97db05e76cade37c2f5e37e210039d284d4ac094))
+
+# [1.3.0](https://github.com/adobe/helix-md2docx/compare/v1.2.3...v1.3.0) (2022-02-02)
+
+
+### Features
+
+* allow to provide styles.xml ([e01c784](https://github.com/adobe/helix-md2docx/commit/e01c78458ab7270fd9924f32767df1f204689e5b))
+
 ## [1.2.3](https://github.com/adobe/helix-md2docx/compare/v1.2.2...v1.2.3) (2022-01-25)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2docx",
-  "version": "1.2.3",
+  "version": "1.3.3",
   "description": "Helix Service that converts markdown to word documents",
   "main": "src/index.js",
   "type": "module",
@@ -27,15 +27,15 @@
   },
   "homepage": "https://github.com/adobe/helix-md2docx#readme",
   "dependencies": {
-    "@adobe/helix-fetch": "3.0.0",
+    "@adobe/helix-fetch": "3.0.3",
     "@adobe/helix-markdown-support": "3.1.2",
-    "@adobe/helix-shared-process-queue": "1.1.0",
-    "@adobe/helix-docx2md": "1.0.6",
+    "@adobe/helix-shared-process-queue": "1.1.1",
+    "@adobe/helix-docx2md": "1.0.7",
     "docx": "7.3.0",
     "hast-util-is-element": "2.1.2",
     "hast-util-to-mdast": "8.3.0",
     "image-size": "1.0.1",
-    "rehype-parse": "8.0.3",
+    "rehype-parse": "8.0.4",
     "remark-gfm": "3.0.1",
     "remark-parse": "10.0.1",
     "unified": "10.1.1",
@@ -43,25 +43,26 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "1.3.2",
-    "@adobe/helix-mediahandler": "1.0.2",
+    "@adobe/helix-mediahandler": "1.0.4",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "c8": "7.11.0",
-    "chai": "4.3.4",
+    "chai": "4.3.6",
     "codecov": "3.8.3",
-    "dotenv": "14.2.0",
-    "eslint": "8.7.0",
+    "dotenv": "14.3.2",
+    "eslint": "8.8.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.25.4",
     "fs-extra": "10.0.0",
     "husky": "7.0.4",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "12.2.2",
-    "mocha": "9.1.4",
+    "lint-staged": "12.3.2",
+    "mocha": "9.2.0",
     "mocha-multi-reporters": "1.5.1",
     "semantic-release": "19.0.2",
-    "unist-util-inspect": "7.0.0"
+    "unist-util-inspect": "7.0.0",
+    "yauzl": "2.10.0"
   },
   "lint-staged": {
     "*.js": "eslint"

package/src/md2docx/index.d.ts

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+declare interface Logger {}
+
+/**
+ * Converts the md to a word document (docx).
+ *
+ * @param {Node} md The md
+ * @param {Logger} [log] a console like logger
+ * @param {string} [stylesXML] The content of the styles.xml file of a Word template (to override provided default)
+ * @returns {Promise<Buffer>} the docx
+ */
+export default function md2docx(mdast: object, log: Logger, stylesXML: string): Promise<Buffer>;

package/src/md2docx/index.js

@@ -15,12 +15,12 @@ import gfm from 'remark-gfm';
 import { remarkMatter } from '@adobe/helix-markdown-support';
 import mdast2docx from '../mdast2docx/index.js';
 
-export default async function md2docx(md, log = console) {
+export default async function md2docx(md, log = console, stylesXML = null) {
   const mdast = unified()
     .use(remark, { position: false })
     .use(gfm)
     .use(remarkMatter)
     .parse(md);
 
-  return mdast2docx(mdast, log);
+  return mdast2docx(mdast, log, stylesXML);
 }

package/src/mdast2docx/index.d.ts

@@ -16,6 +16,7 @@ declare interface Logger {}
  *
  * @param {Node} mdast The mdast
  * @param {Logger} [log] a console like logger
+ * @param {string} [stylesXML] The content of the styles.xml file of a Word template (to override provided default)
  * @returns {Promise<Buffer>} the docx
  */
-export default function mdast2docx(mdast: object, log: Logger): Promise<Buffer>;
+export default function mdast2docx(mdast: object, log: Logger, stylesXML: string): Promise<Buffer>;

package/src/mdast2docx/index.js

@@ -24,10 +24,7 @@ import downloadImages from './mdast-download-images.js';
 
 const { Document, Packer } = docx;
 
-// eslint-disable-next-line no-underscore-dangle
-const __dirname = url.fileURLToPath ? path.dirname(url.fileURLToPath(import.meta.url)) : './';
-
-export default async function mdast2docx(mdast, log = console) {
+export default async function mdast2docx(mdast, log = console, stylesXML = null) {
   const ctx = {
     handlers,
     style: {},
@@ -50,15 +47,22 @@ export default async function mdast2docx(mdast, log = console) {
 
   const children = await all(ctx, mdast);
 
-  // read styles from template.docx. this seems to be the most reliable
-  // const templateDoc = await readFile(path.resolve(__dirname, 'template.docx'));
-  // const zip = await openArrayBuffer(templateDoc);
-  // const styleXML = await zip.read('word/styles.xml', 'utf-8');
-  const styleXML = await readFile(path.resolve(__dirname, 'template', 'word', 'styles.xml'), 'utf-8');
+  if (!stylesXML) {
+    // read styles from template.docx. this seems to be the most reliable
+    // const templateDoc = await readFile(path.resolve(__dirname, 'template.docx'));
+    // const zip = await openArrayBuffer(templateDoc);
+    // const stylesXML = await zip.read('word/styles.xml', 'utf-8');
+
+    // eslint-disable-next-line no-underscore-dangle
+    const __dirname = url.fileURLToPath ? path.dirname(url.fileURLToPath(import.meta.url)) : './';
+
+    // eslint-disable-next-line no-param-reassign
+    stylesXML = await readFile(path.resolve(__dirname, 'template', 'word', 'styles.xml'), 'utf-8');
+  }
 
   const doc = new Document({
     numbering,
-    externalStyles: styleXML,
+    externalStyles: stylesXML,
     sections: [{
       children,
     }],