remark-docx 0.0.2 → 0.0.3

package/README.md

@@ -27,16 +27,16 @@ npm install remark-docx
 ```javascript
 import { unified } from "unified";
 import markdown from "remark-parse";
-import docx, { Packer } from "remark-docx";
+import docx from "remark-docx";
 import { saveAs } from "file-saver";
 
-const processor = unified().use(markdown).use(docx);
+const processor = unified().use(markdown).use(docx, { output: "blob" });
 
 const text = "# hello world";
 
 (async () => {
   const doc = await processor.process(text);
-  const blob = await Packer.toBlob(doc.result);
+  const blob = await doc.result;
   saveAs(blob, "example.docx");
 })();
 ```
@@ -46,23 +46,24 @@ const text = "# hello world";
 ```javascript
 import { unified } from "unified";
 import markdown from "remark-parse";
-import docx, { Packer } from "remark-docx";
+import docx from "remark-docx";
 import * as fs from "fs";
 
-const processor = unified().use(markdown).use(docx);
+const processor = unified().use(markdown).use(docx, { output: "buffer" });
 
 const text = "# hello world";
 
 (async () => {
   const doc = await processor.process(text);
-  const buffer = await Packer.toBuffer(doc.result);
+  const buffer = await doc.result;
   fs.writeFileSync("example.docx", buffer);
 })();
 ```
 
 ## Options
 
-| Key           | Default   | Type          | Description                                                                                                                                                                                                                                      |
-| ------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| docProperties | undefined | object        | Override properties of document.                                                                                                                                                                                                                 |
-| imageResolver | undefined | ImageResolver | **You must set** if your markdown includes images. See example for [browser](https://github.com/inokawa/remark-docx/blob/main/stories/playground.stories.tsx) and [Node.js](https://github.com/inokawa/remark-docx/blob/main/src/index.spec.ts). |
+| Key           | Default   | Type                        | Description                                                                                                                                                                                                                                      |
+| ------------- | --------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| output        | "buffer"  | `"buffer"` `"blob"` `"raw"` | Set output type of `VFile.result`. `buffer` is `Promise<ArrayBuffer>`. `blob` is `Promise<Blob>`. `raw` is internal data for testing.                                                                                                            |
+| docProperties | undefined | object                      | Override properties of document.                                                                                                                                                                                                                 |
+| imageResolver | undefined | ImageResolver               | **You must set** if your markdown includes images. See example for [browser](https://github.com/inokawa/remark-docx/blob/main/stories/playground.stories.tsx) and [Node.js](https://github.com/inokawa/remark-docx/blob/main/src/index.spec.ts). |

package/lib/index.d.ts

@@ -1,3 +1,2 @@
 export { default } from "./plugin";
 export type { Options as DocxOptions } from "./plugin";
-export { Packer } from "docx";

package/lib/index.js

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var unistUtilVisit = require('unist-util-visit');
 var docx = require('docx');
 
@@ -158,7 +156,16 @@ var error = function (message) {
     throw new Error(message);
 };
 function mdastToDocx(node, opts, images) {
-    return buildDocxRoot(node, opts, images);
+    var _a;
+    var doc = buildDocxRoot(node, opts, images);
+    switch ((_a = opts.output) !== null && _a !== void 0 ? _a : "buffer") {
+        case "buffer":
+            return docx.Packer.toBuffer(doc);
+        case "blob":
+            return docx.Packer.toBlob(doc);
+        case "raw":
+            return doc;
+    }
 }
 function buildDocxRoot(root, opts, images) {
     var ctx = { deco: {}, images: images };
@@ -484,8 +491,4 @@ var plugin = function (opts) {
     }); };
 };
 
-Object.defineProperty(exports, 'Packer', {
-    enumerable: true,
-    get: function () { return docx.Packer; }
-});
-exports["default"] = plugin;
+module.exports = plugin;

package/lib/index.mjs

@@ -1,7 +1,6 @@
 import { visit } from 'unist-util-visit';
 import * as docx from 'docx';
-import { convertInchesToTwip } from 'docx';
-export { Packer } from 'docx';
+import { convertInchesToTwip, Packer } from 'docx';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -136,7 +135,16 @@ var error = function (message) {
     throw new Error(message);
 };
 function mdastToDocx(node, opts, images) {
-    return buildDocxRoot(node, opts, images);
+    var _a;
+    var doc = buildDocxRoot(node, opts, images);
+    switch ((_a = opts.output) !== null && _a !== void 0 ? _a : "buffer") {
+        case "buffer":
+            return Packer.toBuffer(doc);
+        case "blob":
+            return Packer.toBlob(doc);
+        case "raw":
+            return doc;
+    }
 }
 function buildDocxRoot(root, opts, images) {
     var ctx = { deco: {}, images: images };

package/lib/transformer.d.ts

@@ -11,7 +11,8 @@ export declare type ImageData = {
 };
 export declare type ImageResolver = (url: string) => Promise<ImageData> | ImageData;
 export declare type Opts = {
+    output?: "buffer" | "blob" | "raw";
     docProperties?: Omit<IPropertiesOptions, "sections" | "numbering">;
     imageResolver?: ImageResolver;
 };
-export declare function mdastToDocx(node: mdast.Root, opts: Opts, images: ImageDataMap): docx.File;
+export declare function mdastToDocx(node: mdast.Root, opts: Opts, images: ImageDataMap): Promise<any> | docx.File;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-docx",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "remark plugin to transform markdown to docx.",
   "main": "lib/index.js",
   "module": "lib/index.mjs",