Merge branch 'master' into dependabot/npm_and_yarn/vitest/ui-2.1.2

Author: dolanmiu

.github/workflows/default.yml

@@ -13,10 +13,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - uses: "./.github/actions/install-and-build"
             - name: Archive Production Artifact
-              uses: actions/upload-artifact@master
+              uses: actions/upload-artifact@v4
               with:
                   name: build
                   path: build
@@ -25,7 +25,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
               run: npm ci --force
             - name: Test
@@ -42,7 +42,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
               run: npm ci --force
             - name: Lint
@@ -52,7 +52,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
               run: npm ci --force
             - name: Prettier
@@ -62,7 +62,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
               run: npm ci --force
             - name: Prettier

.github/workflows/demos.yml

@@ -12,7 +12,7 @@ jobs:
         name: Demos
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@master
+            - uses: actions/checkout@v4
             - uses: "./.github/actions/install-and-build"
             - name: Run Demos
               run: npm run run-ts -- ./demo/1-basic.ts

.github/workflows/github-pages.yml

@@ -10,7 +10,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
               run: npm ci --force
             - name: Build 🔧
@@ -19,7 +19,7 @@ jobs:
                   echo "docx.js.org" > docs/.nojekyll
                   echo "docx.js.org" > docs/CNAME
             - name: Archive Production Artifact
-              uses: actions/upload-artifact@master
+              uses: actions/upload-artifact@v4
               with:
                   name: docs
                   path: docs
@@ -28,11 +28,11 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo 🛎️
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
               run: npm ci --force
             - name: Download Artifact
-              uses: actions/download-artifact@master
+              uses: actions/download-artifact@v4
               with:
                   name: docs
                   path: docs

.github/workflows/npm-publish.yml

@@ -0,0 +1,46 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "20.x"
+            - run: npm ci
+            - run: npm run cspell
+            - run: npm run prettier
+            - run: npm run lint
+            - run: npm run test:ci
+
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "20.x"
+            - run: npm ci
+            - run: npm run build
+
+    publish-npm:
+        needs: [test, build]
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "20.x"
+                  registry-url: https://registry.npmjs.org/
+            - run: npm ci
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.npm_token}}

demo/93-template-document.ts

@@ -0,0 +1,72 @@
+// Patch a document with patches
+
+import * as fs from "fs";
+import { patchDocument, PatchType, TextRun } from "docx";
+
+patchDocument({
+    outputType: "nodebuffer",
+    data: fs.readFileSync("demo/assets/field-trip.docx"),
+    patches: {
+        todays_date: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: new Date().toLocaleDateString() })],
+        },
+
+        school_name: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        address: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "blah blah" })],
+        },
+
+        city: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        state: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        zip: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        phone: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        first_name: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        last_name: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        email_address: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        ft_dates: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+
+        grade: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: "test" })],
+        },
+    },
+}).then((doc) => {
+    fs.writeFileSync("My Document.docx", doc);
+});