Merge pull request #25 from templi-ai/main

Update deps, expose more options to consumers, add tip tap defaults
curvenote · Jul 4, 2024 · 8705eaf · 8705eaf
2 parents ad28809 + b78d5b9
commit 8705eaf
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 34 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -11,11 +11,11 @@ jobs:
     if: github.actor != 'dependabot[bot]'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14.x
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+          node-version: 20.x
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
         with:
           path: 'node_modules'
           key: ${{ runner.os }}-modules-${{ hashFiles('yarn.lock') }}

diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "buffer-image-size": "^0.6.4",
-    "docx": "^7.3.0",
+    "docx": "^8.5.0",
     "prosemirror-model": "^1.18.1"
   },
   "devDependencies": {

diff --git a/src/schema.ts b/src/schema.ts
@@ -74,6 +74,12 @@ export const defaultMarks: MarkSerializer = {
   strong() {
     return { bold: true };
   },
+  italic() {
+    return { italics: true };
+  },
+  bold() {
+    return { bold: true };
+  },
   link() {
     // Note, this is handled specifically in the serializer
     // Word treats links more like a Node rather than a mark

diff --git a/src/serializer.ts b/src/serializer.ts
@@ -21,6 +21,9 @@ import {
   InternalHyperlink,
   SimpleField,
   FootnoteReferenceRun,
+  IImageOptions,
+  ITableOptions,
+  ITableRowOptions,
 } from 'docx';
 import sizeOf from 'buffer-image-size';
 import { createNumbering, NumberingStyles } from './numbering';
@@ -244,21 +247,28 @@ export class DocxSerializerState {
   // not sure what this actually is, seems to be close for 8.5x11
   maxImageWidth = MAX_IMAGE_WIDTH;
 
-  image(src: string, widthPercent = 70, align: AlignOptions = 'center') {
+  image(
+    src: string,
+    widthPercent = 70,
+    align: AlignOptions = 'center',
+    imageRunOpts?: IImageOptions,
+  ) {
     const buffer = this.options.getImageBuffer(src);
     const dimensions = sizeOf(buffer);
     const aspect = dimensions.height / dimensions.width;
     const width = this.maxImageWidth * (widthPercent / 100);
     this.current.push(
       new ImageRun({
+        ...imageRunOpts,
         data: buffer,
         transformation: {
+          ...(imageRunOpts?.transformation || {}),
           width,
           height: width * aspect,
         },
       }),
     );
-    let alignment: AlignmentType;
+    let alignment: string;
     switch (align) {
       case 'right':
         alignment = AlignmentType.RIGHT;
@@ -270,38 +280,52 @@ export class DocxSerializerState {
         alignment = AlignmentType.CENTER;
     }
     this.addParagraphOptions({
-      alignment,
+      // TODO: fix
+      alignment: alignment as any,
     });
   }
 
-  table(node: Node) {
+  table(
+    node: Node,
+    opts: {
+      getCellOptions?: (cell: Node) => ITableCellOptions;
+      getRowOptions?: (row: Node) => Omit<ITableRowOptions, 'children'>;
+      tableOptions?: Omit<ITableOptions, 'rows'>;
+    } = {},
+  ) {
+    const { getCellOptions, getRowOptions, tableOptions } = opts;
     const actualChildren = this.children;
     const rows: TableRow[] = [];
-    node.content.forEach(({ content: rowContent }) => {
+    node.content.forEach((row) => {
       const cells: TableCell[] = [];
       // Check if all cells are headers in this row
       let tableHeader = true;
-      rowContent.forEach((cell) => {
+      row.content.forEach((cell) => {
         if (cell.type.name !== 'table_header') {
           tableHeader = false;
         }
       });
       // This scales images inside of tables
-      this.maxImageWidth = MAX_IMAGE_WIDTH / rowContent.childCount;
-      rowContent.forEach((cell) => {
+      this.maxImageWidth = MAX_IMAGE_WIDTH / row.content.childCount;
+      row.content.forEach((cell) => {
         this.children = [];
         this.renderContent(cell);
         const tableCellOpts: Mutable<ITableCellOptions> = { children: this.children };
         const colspan = cell.attrs.colspan ?? 1;
         const rowspan = cell.attrs.rowspan ?? 1;
         if (colspan > 1) tableCellOpts.columnSpan = colspan;
         if (rowspan > 1) tableCellOpts.rowSpan = rowspan;
-        cells.push(new TableCell(tableCellOpts));
+        cells.push(
+          new TableCell({
+            ...tableCellOpts,
+            ...(getCellOptions?.(cell) || {}),
+          }),
+        );
       });
-      rows.push(new TableRow({ children: cells, tableHeader }));
+      rows.push(new TableRow({ ...(getRowOptions?.(row) || {}), children: cells, tableHeader }));
     });
     this.maxImageWidth = MAX_IMAGE_WIDTH;
-    const table = new Table({ rows });
+    const table = new Table({ ...tableOptions, rows });
     actualChildren.push(table);
     // If there are multiple tables, this seperates them
     actualChildren.push(new Paragraph(''));

diff --git a/yarn.lock b/yarn.lock
@@ -1580,11 +1580,18 @@
   resolved "https://registry.yarnpkg.com/@types/mdurl/-/mdurl-1.0.2.tgz#e2ce9d83a613bacf284c7be7d491945e39e1f8e9"
   integrity sha512-eC4U9MlIcu2q0KQmXszyn5Akca/0jrQmwDRgpAMJai7qBWq4amIQhZyNau4VYGtCeALvW1/NtjzJJ567aZxfKA==
 
-"@types/node@*", "@types/node@^17.0.0":
+"@types/node@*":
   version "17.0.2"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.2.tgz#a4c07d47ff737e8ee7e586fe636ff0e1ddff070a"
   integrity sha512-JepeIUPFDARgIs0zD/SKPgFsJEAF0X5/qO80llx59gOxFTboS9Amv3S+QfB7lqBId5sFXJ99BN0J6zFRvL9dDA==
 
+"@types/node@^20.3.1":
+  version "20.14.9"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-20.14.9.tgz#12e8e765ab27f8c421a1820c99f5f313a933b420"
+  integrity sha512-06OCtnTXtWOZBJlRApleWndH4JsRVs1pDCc8dLSQp+7PpUpX3ePdHyeNSFTeSe7FtKyQkrlPvHwJOW3SLd8Oyg==
+  dependencies:
+    undici-types "~5.26.4"
+
 "@types/parse-json@^4.0.0":
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0"
@@ -2358,14 +2365,14 @@ doctrine@^3.0.0:
   dependencies:
     esutils "^2.0.2"
 
-docx@^7.3.0:
-  version "7.3.0"
-  resolved "https://registry.yarnpkg.com/docx/-/docx-7.3.0.tgz#5a23fde9cf245f98d31e46ff2292d5f61dbcbf29"
-  integrity sha512-OkSGlDNWMRFY07OEhUTx1ouuzYi8s1b67JDI6m5/5ek4xoshtP+/Rx8eRdY8LbhvpFkngvUantvTsxY4XW8Heg==
+docx@^8.5.0:
+  version "8.5.0"
+  resolved "https://registry.yarnpkg.com/docx/-/docx-8.5.0.tgz#656d7ee945cd44146b05878b5af8947c2a229595"
+  integrity sha512-4SbcbedPXTciySXiSnNNLuJXpvxFe5nqivbiEHXyL8P/w0wx2uW7YXNjnYgjW0e2e6vy+L/tMISU/oAiXCl57Q==
   dependencies:
-    "@types/node" "^17.0.0"
-    jszip "^3.1.5"
-    nanoid "^3.1.20"
+    "@types/node" "^20.3.1"
+    jszip "^3.10.1"
+    nanoid "^5.0.4"
     xml "^1.0.1"
     xml-js "^1.6.8"
 
@@ -4028,15 +4035,15 @@ jsx-ast-utils@^3.3.1:
     array-includes "^3.1.5"
     object.assign "^4.1.2"
 
-jszip@^3.1.5:
-  version "3.7.1"
-  resolved "https://registry.yarnpkg.com/jszip/-/jszip-3.7.1.tgz#bd63401221c15625a1228c556ca8a68da6fda3d9"
-  integrity sha512-ghL0tz1XG9ZEmRMcEN2vt7xabrDdqHHeykgARpmZ0BiIctWxM47Vt63ZO2dnp4QYt/xJVLLy5Zv1l/xRdh2byg==
+jszip@^3.10.1:
+  version "3.10.1"
+  resolved "https://registry.yarnpkg.com/jszip/-/jszip-3.10.1.tgz#34aee70eb18ea1faec2f589208a157d1feb091c2"
+  integrity sha512-xXDvecyTpGLrqFrvkrUSoxxfJI5AH7U8zxxtVclpsUtMCq4JQ290LY8AW5c7Ggnr/Y/oK+bQMbqK2qmtk3pN4g==
   dependencies:
     lie "~3.3.0"
     pako "~1.0.2"
     readable-stream "~2.3.6"
-    set-immediate-shim "~1.0.1"
+    setimmediate "^1.0.5"
 
 kleur@^3.0.3:
   version "3.0.3"
@@ -4435,11 +4442,16 @@ mystjs@^0.0.10:
     unist-util-select "^4.0.1"
     unist-util-visit "^4.1.0"
 
-nanoid@^3.1.20, nanoid@^3.1.30:
+nanoid@^3.1.30:
   version "3.1.30"
   resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.1.30.tgz#63f93cc548d2a113dc5dfbc63bfa09e2b9b64362"
   integrity sha512-zJpuPDwOv8D2zq2WRoMe1HsfZthVewpel9CAvTfc/2mBD1uUT/agc5f7GHGWXlYkFvi1mVxe4IjvP2HNrop7nQ==
 
+nanoid@^5.0.4:
+  version "5.0.7"
+  resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-5.0.7.tgz#6452e8c5a816861fd9d2b898399f7e5fd6944cc6"
+  integrity sha512-oLxFY2gd2IqnjcYyOXD8XGCftpGtZP2AbHbOkthDkvRywH5ayNtPVy9YlOPcHckXzbLTCHpkb7FB+yuxKV13pQ==
+
 natural-compare@^1.4.0:
   version "1.4.0"
   resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7"
@@ -5212,10 +5224,10 @@ semver@^7.3.7:
   dependencies:
     lru-cache "^6.0.0"
 
-set-immediate-shim@~1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/set-immediate-shim/-/set-immediate-shim-1.0.1.tgz#4b2b1b27eb808a9f8dcc481a58e5e56f599f3f61"
-  integrity sha1-SysbJ+uAip+NzEgaWOXlb1mfP2E=
+setimmediate@^1.0.5:
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/setimmediate/-/setimmediate-1.0.5.tgz#290cbb232e306942d7d7ea9b83732ab7856f8285"
+  integrity sha512-MATJdZp8sLqDl/68LfQmbP8zKPLQNV6BIZoIgrscFDQ+RsvK/BxeDQOgyxKKoh0y/8h3BqVFnCqQ/gd+reiIXA==
 
 shebang-command@^1.2.0:
   version "1.2.0"
@@ -5654,6 +5666,11 @@ unbox-primitive@^1.0.2:
     has-symbols "^1.0.3"
     which-boxed-primitive "^1.0.2"
 
+undici-types@~5.26.4:
+  version "5.26.5"
+  resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617"
+  integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==
+
 unicode-canonical-property-names-ecmascript@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz#301acdc525631670d39f6146e0e77ff6bbdebddc"