Add output option

inokawa · Jan 11, 2022 · bfd7b0b · bfd7b0b
1 parent a58fb3b
commit bfd7b0b
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 16 deletions.
diff --git a/README.md b/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). |
diff --git a/src/index.spec.ts b/src/index.spec.ts
@@ -20,6 +20,7 @@ describe("e2e", () => {
     .use(frontmatter, ["yaml", "toml"])
     .use(math)
     .use(docx, {
+      output: "raw",
       imageResolver: (url) => ({
         image: new Uint8Array(),
         width: 600,

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,2 @@
 export { default } from "./plugin";
 export type { Options as DocxOptions } from "./plugin";
-export { Packer } from "docx";
diff --git a/src/transformer.ts b/src/transformer.ts
@@ -1,5 +1,5 @@
 import * as docx from "docx";
-import { convertInchesToTwip } from "docx";
+import { convertInchesToTwip, Packer } from "docx";
 import { IPropertiesOptions } from "docx/build/file/core-properties";
 import * as mdast from "./models/mdast";
 
@@ -95,6 +95,7 @@ type Context = Readonly<{
 }>;
 
 export type Opts = {
+  output?: "buffer" | "blob" | "raw";
   docProperties?: Omit<IPropertiesOptions, "sections" | "numbering">;
   imageResolver?: ImageResolver;
 };
@@ -110,8 +111,16 @@ export function mdastToDocx(
   node: mdast.Root,
   opts: Opts,
   images: ImageDataMap
-): docx.File {
-  return buildDocxRoot(node, opts, images);
+): Promise<any> | docx.File {
+  const doc = buildDocxRoot(node, opts, images);
+  switch (opts.output ?? "buffer") {
+    case "buffer":
+      return Packer.toBuffer(doc);
+    case "blob":
+      return Packer.toBlob(doc);
+    case "raw":
+      return doc;
+  }
 }
 
 function buildDocxRoot(

diff --git a/stories/playground.stories.tsx b/stories/playground.stories.tsx
@@ -3,7 +3,7 @@ import { unified } from "unified";
 import markdown from "remark-parse";
 import gfm from "remark-gfm";
 import frontmatter from "remark-frontmatter";
-import docx, { Packer } from "../src";
+import docx from "../src";
 import TextEditor from "./components/text-editor";
 // @ts-expect-error no type definition
 import text from "../fixtures/article.md";
@@ -33,12 +33,13 @@ const toDocxProcessor = unified()
   .use(gfm)
   .use(frontmatter)
   .use(docx, {
+    output: "blob",
     imageResolver: fetchImage,
   });
 
 const toDocx = async (s: string) => {
   const doc = await toDocxProcessor.process(s);
-  return Packer.toBlob(doc.result as any);
+  return doc.result;
 };
 
 export default {