@rainbow-o23/n7 0.1.16

package/.babelrc

@@ -0,0 +1,11 @@
+{
+	"presets": [
+		"@babel/preset-typescript",
+		[
+			"@babel/preset-env",
+			{
+				"modules": false
+			}
+		]
+	]
+}

package/.eslintrc

@@ -0,0 +1,23 @@
+{
+	"root": true,
+	"parser": "@typescript-eslint/parser",
+	"plugins": [
+		"@typescript-eslint"
+	],
+	"extends": [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/eslint-recommended",
+		"plugin:@typescript-eslint/recommended"
+	],
+	"rules": {
+		"no-plusplus": 0,
+		"no-mixed-spaces-and-tabs": [
+			"error",
+			"smart-tabs"
+		],
+		"@typescript-eslint/no-empty-interface": "off",
+		"@typescript/no-non-null-assertion": "off",
+		"@typescript-eslint/adjacent-overload-signatures": "off",
+		"@typescript-eslint/ban-ts-comment": "error"
+	}
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 InsureMO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,235 @@
+![Static Badge](https://img.shields.io/badge/InsureMO-777AF2.svg)
+
+![Docx-templates](https://img.shields.io/badge/Docx--templates-white.svg?logo=microsoftword&logoColor=2B579A&style=social)
+
+![Module Formats](https://img.shields.io/badge/module%20formats-cjs-green.svg)
+
+# o23/n7
+
+`o23/n7` provides
+
+- A pipeline step that converts word templates to word, implemented based on [Docx-templates](https://github.com/guigrpa/docx-templates).
+
+## Word Generate Step
+
+### Environment Parameters
+
+| Name                       | Type                     | Default Value | Comments                                                                                                                                                                                                                                                                                                                                                                                        |
+|----------------------------|--------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| cmd                        | string, [string, string] | `+++`         | Defines a custom command delimiter. This can be a String e.g. '+++' or an Array of Strings with length 2: ['{', '}'] in which the first element serves as the start delimiter and the second as the end delimiter.                                                                                                                                                                              |
+| literalXmlDelimiter        | string                   | `\|\|`        | The delimiter that's used to indicate literal XML that should be inserted into the docx XML tree as-is.                                                                                                                                                                                                                                                                                         |
+| processLineBreaks          | boolean                  | true          | Handle linebreaks in result of commands as actual linebreaks.                                                                                                                                                                                                                                                                                                                                   |
+| failFast                   | boolean                  | true          | Whether to fail on the first error encountered in the template.                                                                                                                                                                                                                                                                                                                                 |
+| rejectNullish              | boolean                  | false         | When set to true, this setting ensures createReport throws a NullishCommandResultError when the result of an INS, HTML, IMAGE, or LINK command is null or undefined. This is useful as nullish return values usually indicate a mistake in the template or the invoking code.                                                                                                                   |
+| fixSmartQuotes             | boolean                  | false         | MS Word usually autocorrects JS string literal quotes with unicode 'smart' quotes ('curly' quotes). E.g. 'aubergine' -> ‘aubergine’. This causes an error when evaluating commands containing these smart quotes, as they are not valid JavaScript. If you set fixSmartQuotes to 'true', these smart quotes will automatically get replaced with straight quotes (') before command evaluation. |
+| processLineBreaksAsNewText | boolean                  | false         | Use the new way of injecting line breaks from command results (only applies when processLineBreaks is true) which has better results in LibreOffice and Google Drive.                                                                                                                                                                                                                           |
+
+### Request and Response
+
+```typescript
+export interface PrintWordPipelineStepInFragment {
+	template: Buffer;
+	data: any;
+	jsContext?: Object;
+}
+
+export interface PrintWordPipelineStepOutFragment {
+	file: Buffer;
+}
+```
+
+### Syntax
+
+Find template and unit test in `/test` folder, syntax for using a Word template is as follows.
+
+#### Command Delimiters
+
+The default command delimiters are `+++` and `+++`. This means that commands are written as `+++command+++`. You can change the delimiters
+by setting the `cmd` option to a string or an array of strings with length 2: `['{', '}']`, `['{#', '#}']` for example.
+
+#### Property Value
+
+The following syntaxes are equivalent. You can choose based on your needs:
+
+- `+++INS project.name+++`,
+- `+++= project.name+++`,
+- `+++project.name+++`.
+
+It is important to note that the content supports JavaScript syntax. Therefore, the following notation is also equally effective:
+
+- `+++INS ``${project.name ?? ''}``+++`.
+
+> Always define the Word document style you need across the entire command. If it is only defined within the command content, the style will
+> not take effect.
+
+#### Image or SVG
+
+Use the `IMAGE` syntax to replace images or SVG. This syntax calls a context function to retrieve image details, as follows:
+
+- `+++IMAGE logo()+++`.
+
+When using the syntax above, please ensure that the corresponding function is already provided in the `jsContext` context object passed as a
+parameter,
+
+```typescript
+jsContext: {
+	logo: () => {
+		const data = Buffer.from(`<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="63" height="20" role="img" aria-label="InsureMO"><title>InsureMO</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="63" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#777af2"/><rect x="0" width="63" height="20" fill="#777af2"/><rect width="63" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">InsureMO</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="530">InsureMO</text></g></svg>`, 'utf-8');
+		return {width: 1.66687479, height: 0.5291666, data, extension: '.svg'};
+	}
+}
+```
+
+> Please note that the units for `width` and `height` are in centimeters (cm), not in pixel values. Generally, it can be assumed that at a
+> resolution of 96 DPI, approximately one pixel is equal to `1.66687479cm`.
+
+#### Link
+
+Use the `LINK` syntax to replace links. This syntax also can call a context function to retrieve link details, as follows:
+
+- `+++LINK ({ url: project.url, label: project.name })+++`,
+- `+++LINK link()+++`.
+
+When using the syntax above, please ensure that the corresponding function is already provided in the `jsContext` context object passed as a
+
+```typescript
+jsContext: {
+	link: () => {
+		// data is the data passed to the print step
+		return {url: data.project.url, label: data.project.name};
+	};
+}
+```
+
+#### For Loop
+
+Use the `FOR ... IN`, `END-FOR` syntax to loop through the array, as follows:
+
+```
++++FOR group IN groups+++
+Group (+++`${$idx + 1}`+++)
+Cash In Tax: +++= $group.subTotal.cashInTxn+++
+Cash In Amount: +++= $group.subTotal.cashInAmt+++
+Departments:
++++FOR dept IN $group.depts+++
+Department (+++`${$idx + 1}`+++)
+	Name: +++$dept.name+++
+	Cashier: +++$dept.cashierName+++
+	Cash In Tax: +++$dept.cashInTxn+++
+	Cash In Amount: +++$dept.cashInAmt+++
++++END-FOR dept+++
++++END-FOR group+++
+```
+
+> From the sample above, it can be observed that nested loops are also supported.
+
+> It is possible to get the current element index of the inner-most loop with the variable `$idx`, starting from `0`.
+
+To obtain the array data (`arrayPropertyName`) used in the loop body and define a variable name (`variableName`) that represents each array
+element in the loop, you can use the `FOR variableName IN arrayPropertyName` syntax. In the example above, they are respectively:
+
+- `+++FOR group IN groups+++`,
+- `+++FOR dept IN $group.depts+++`.
+
+Similarly, the loop ending must be defined in the correct order, following the rule of ending the ones that start later. The order is as
+follows:
+
+- `+++END-FOR dept+++`,
+- `+++END-FOR group+++`.
+
+> Please note that when ending the loop, you need to use the variable name defined in the loop start.
+
+The following syntax can be used to output a table using loops:
+
+| Group                            | Department         | Cashier                   | Cash In Tax                         | Cash In Amount                      |
+|----------------------------------|--------------------|---------------------------|-------------------------------------|-------------------------------------|
+| `+++For group In groups+++`      |                    |                           |                                     |                                     |
+| `Group (+++``${$idx + 1}``+++)`  |                    |                           | `+++= $group.subTotal.cashInTxn+++` | `+++= $group.subTotal.cashInAmt+++` |
+| `+++FOR dept IN $group.depts+++` |                    |                           |                                     |                                     |
+|                                  | `+++$dept.name+++` | `+++$dept.cashierName+++` | `+++$dept.cashInTxn+++`             | `+++$dept.cashInAmt+++`             |
+| `+++END-FOR dept+++`             |                    |                           |                                     |                                     |
+| `+++END-FOR group+++`            |                    |                           |                                     |                                     |
+
+#### If Statement
+
+Use the `IF ... END-IF` syntax to implement the if statement, as follows:
+
+```
++++FOR group IN groups+++
+Group (+++`${$idx + 1}`+++)
+Cash In Tax: +++= $group.subTotal.cashInTxn+++
+Cash In Amount: +++= $group.subTotal.cashInAmt+++
+Departments:
++++FOR dept IN $group.depts+++
++++IF $dept.name === 'Development'+++
+Department (+++`${$idx + 1}`+++)
+	Name: +++$dept.name+++
+	Cashier: +++$dept.cashierName+++
+	Cash In Tax: +++$dept.cashInTxn+++
+	Cash In Amount: +++$dept.cashInAmt+++
++++END-IF+++
++++END-FOR dept+++
++++END-FOR group+++
+```
+
+> From the sample above, it can be observed that `IF ... END-IF` can be applied inside loop.
+
+The `IF statement` actually executes the given JavaScript syntax and determines whether to output the internal content based on the boolean
+value of the result:
+
+- `+++IF $dept.name === 'Development'+++`,
+- `+++END-IF+++`.
+
+Similarly, `IF ... END-IF` can also be used in table output:
+
+| Group                                   | Department         | Cashier                   | Cash In Tax                         | Cash In Amount                      |
+|-----------------------------------------|--------------------|---------------------------|-------------------------------------|-------------------------------------|
+| `+++For group In groups+++`             |                    |                           |                                     |                                     |
+| `Group (+++``${$idx + 1}``+++)`         |                    |                           | `+++= $group.subTotal.cashInTxn+++` | `+++= $group.subTotal.cashInAmt+++` |
+| `+++FOR dept IN $group.depts+++`        |                    |                           |                                     |                                     |
+| `+++IF $dept.name === 'Development'+++` |                    |                           |                                     |                                     |
+|                                         | `+++$dept.name+++` | `+++$dept.cashierName+++` | `+++$dept.cashInTxn+++`             | `+++$dept.cashInAmt+++`             |
+| `+++END-IF+++`                          |                    |                           |                                     |                                     |
+| `+++END-FOR dept+++`                    |                    |                           |                                     |                                     |
+| `+++END-FOR group+++`                   |                    |                           |                                     |                                     |
+
+#### HTML
+
+Replace HTML-based text with `HTML` syntax, as follows:
+
+```
++++HTML `
+<meta charset="UTF-8">
+<body>
+  <h1>${$film.title}</h1>
+  <h3>${$film.releaseDate.slice(0, 4)}</h3>
+  <p>
+    <strong style="color: red;">This paragraph should be red and strong</strong>
+  </p>
+</body>
+`+++
+```
+
+`HTML` executes a JavaScript script, which can also be achieved through `jsContext`, for example:
+
+- ```+++HTML html()+++```.
+
+```typescript
+jsContext: {
+	html: () => {
+		return `<meta charset="UTF-8"><body><strong style="color: red;">This paragraph should be red and strong</strong></body>`;
+	}
+}
+```
+
+> It should be noted that the content of HTML needs to be wrapped within the `<body>` tag, and it is recommended to
+> use `<meta charset="UTF-8">` to define the character set.
+
+### Known Issues
+
+- If the `LINK` syntax is used in the header or footer, it may result in the issue of "Word found unreachable content" when opening the
+  document in Word. Although this does not affect the final content display (the link will not work), it can easily confuse users. However,
+  if it is a static link, it is not affected,
+- If the `HTML` syntax is used in the header or footer, it may result in the issue of "Word found unreachable content" when opening the
+  document in Word. Additionally, HTML cannot display correctly and may also affect other content in the header and footer,
+- Odd and even row background colors are currently not supported.

package/index.cjs

@@ -0,0 +1,78 @@
+'use strict';
+
+var n1 = require('@rainbow-o23/n1');
+var n3 = require('@rainbow-o23/n3');
+var docxTemplates = require('docx-templates');
+var n4 = require('@rainbow-o23/n4');
+
+const ERR_TEMPLATE_NOT_DEFINED = 'O07-00001';
+
+class PrintWordPipelineStep extends n3.AbstractFragmentaryPipelineStep {
+    _cmdDelimiter;
+    _literalXmlDelimiter;
+    _processLineBreaks;
+    _noSandbox;
+    _failFast;
+    _rejectNullish;
+    _fixSmartQuotes;
+    _processLineBreaksAsNewText;
+    constructor(options) {
+        super(options);
+        this._cmdDelimiter = options.cmdDelimiter ?? '+++';
+        this._literalXmlDelimiter = options.literalXmlDelimiter ?? '||';
+        this._processLineBreaks = options.processLineBreaks ?? true;
+        this._noSandbox = options.noSandbox ?? true;
+        this._failFast = options.failFast ?? true;
+        this._rejectNullish = options.rejectNullish ?? false;
+        this._fixSmartQuotes = options.fixSmartQuotes ?? false;
+        this._processLineBreaksAsNewText = options.processLineBreaksAsNewText ?? false;
+    }
+    getCreateReportOptions() {
+        return {
+            cmdDelimiter: this._cmdDelimiter,
+            literalXmlDelimiter: this._literalXmlDelimiter,
+            processLineBreaks: this._processLineBreaks,
+            noSandbox: this._noSandbox,
+            failFast: this._failFast,
+            rejectNullish: this._rejectNullish,
+            fixSmartQuotes: this._fixSmartQuotes,
+            processLineBreaksAsNewText: this._processLineBreaksAsNewText
+        };
+    }
+    async printWord(templateWord, data, jsContext) {
+        const buffer = await docxTemplates.createReport({
+            ...this.getCreateReportOptions(),
+            template: templateWord, data, additionalJsContext: jsContext
+        });
+        return Buffer.from(buffer.buffer);
+    }
+    async doPerform(data, _request) {
+        if (data.template == null) {
+            throw new n1.UncatchableError(ERR_TEMPLATE_NOT_DEFINED, 'Print template cannot be null.');
+        }
+        const file = await this.printWord(data.template, data.data, data.jsContext);
+        return { file };
+    }
+}
+
+class PrintWordPipelineStepBuilder extends n4.AbstractFragmentaryPipelineStepBuilder {
+    getStepType() {
+        return PrintWordPipelineStep;
+    }
+    readMoreOptions(given, transformed) {
+        transformed = super.readMoreOptions(given, transformed);
+        transformed.cmdDelimiter = given.cmd;
+        transformed.literalXmlDelimiter = given.literalXmlDelimiter;
+        transformed.processLineBreaks = given.processLineBreaks;
+        transformed.noSandbox = given.noSandbox;
+        transformed.failFast = given.failFast;
+        transformed.rejectNullish = given.rejectNullish;
+        transformed.fixSmartQuotes = given.fixSmartQuotes;
+        transformed.processLineBreaksAsNewText = given.processLineBreaksAsNewText;
+        return transformed;
+    }
+}
+
+exports.ERR_TEMPLATE_NOT_DEFINED = ERR_TEMPLATE_NOT_DEFINED;
+exports.PrintWordPipelineStep = PrintWordPipelineStep;
+exports.PrintWordPipelineStepBuilder = PrintWordPipelineStepBuilder;

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/error-codes';
+export * from './lib/print-word-step';
+export * from './lib/print-word-step-builder';

package/index.js

@@ -0,0 +1,74 @@
+import { UncatchableError } from '@rainbow-o23/n1';
+import { AbstractFragmentaryPipelineStep } from '@rainbow-o23/n3';
+import { createReport } from 'docx-templates';
+import { AbstractFragmentaryPipelineStepBuilder } from '@rainbow-o23/n4';
+
+const ERR_TEMPLATE_NOT_DEFINED = 'O07-00001';
+
+class PrintWordPipelineStep extends AbstractFragmentaryPipelineStep {
+    _cmdDelimiter;
+    _literalXmlDelimiter;
+    _processLineBreaks;
+    _noSandbox;
+    _failFast;
+    _rejectNullish;
+    _fixSmartQuotes;
+    _processLineBreaksAsNewText;
+    constructor(options) {
+        super(options);
+        this._cmdDelimiter = options.cmdDelimiter ?? '+++';
+        this._literalXmlDelimiter = options.literalXmlDelimiter ?? '||';
+        this._processLineBreaks = options.processLineBreaks ?? true;
+        this._noSandbox = options.noSandbox ?? true;
+        this._failFast = options.failFast ?? true;
+        this._rejectNullish = options.rejectNullish ?? false;
+        this._fixSmartQuotes = options.fixSmartQuotes ?? false;
+        this._processLineBreaksAsNewText = options.processLineBreaksAsNewText ?? false;
+    }
+    getCreateReportOptions() {
+        return {
+            cmdDelimiter: this._cmdDelimiter,
+            literalXmlDelimiter: this._literalXmlDelimiter,
+            processLineBreaks: this._processLineBreaks,
+            noSandbox: this._noSandbox,
+            failFast: this._failFast,
+            rejectNullish: this._rejectNullish,
+            fixSmartQuotes: this._fixSmartQuotes,
+            processLineBreaksAsNewText: this._processLineBreaksAsNewText
+        };
+    }
+    async printWord(templateWord, data, jsContext) {
+        const buffer = await createReport({
+            ...this.getCreateReportOptions(),
+            template: templateWord, data, additionalJsContext: jsContext
+        });
+        return Buffer.from(buffer.buffer);
+    }
+    async doPerform(data, _request) {
+        if (data.template == null) {
+            throw new UncatchableError(ERR_TEMPLATE_NOT_DEFINED, 'Print template cannot be null.');
+        }
+        const file = await this.printWord(data.template, data.data, data.jsContext);
+        return { file };
+    }
+}
+
+class PrintWordPipelineStepBuilder extends AbstractFragmentaryPipelineStepBuilder {
+    getStepType() {
+        return PrintWordPipelineStep;
+    }
+    readMoreOptions(given, transformed) {
+        transformed = super.readMoreOptions(given, transformed);
+        transformed.cmdDelimiter = given.cmd;
+        transformed.literalXmlDelimiter = given.literalXmlDelimiter;
+        transformed.processLineBreaks = given.processLineBreaks;
+        transformed.noSandbox = given.noSandbox;
+        transformed.failFast = given.failFast;
+        transformed.rejectNullish = given.rejectNullish;
+        transformed.fixSmartQuotes = given.fixSmartQuotes;
+        transformed.processLineBreaksAsNewText = given.processLineBreaksAsNewText;
+        return transformed;
+    }
+}
+
+export { ERR_TEMPLATE_NOT_DEFINED, PrintWordPipelineStep, PrintWordPipelineStepBuilder };

package/lib/error-codes.d.ts

@@ -0,0 +1,2 @@
+import { O23ReservedErrorCode } from '@rainbow-o23/n1';
+export declare const ERR_TEMPLATE_NOT_DEFINED: O23ReservedErrorCode;

package/lib/print-word-step-builder.d.ts

@@ -0,0 +1,17 @@
+import { PipelineStepType } from '@rainbow-o23/n1';
+import { AbstractFragmentaryPipelineStepBuilder, FragmentaryPipelineStepBuilderOptions } from '@rainbow-o23/n4';
+import { PrintWordPipelineStep, PrintWordPipelineStepOptions } from './print-word-step';
+export type PrintWordPipelineStepBuilderOptions = FragmentaryPipelineStepBuilderOptions & {
+    cmd?: PrintWordPipelineStepOptions['cmdDelimiter'];
+    literalXmlDelimiter?: PrintWordPipelineStepOptions['literalXmlDelimiter'];
+    processLineBreaks?: PrintWordPipelineStepOptions['processLineBreaks'];
+    noSandbox?: PrintWordPipelineStepOptions['noSandbox'];
+    failFast?: PrintWordPipelineStepOptions['failFast'];
+    rejectNullish?: PrintWordPipelineStepOptions['rejectNullish'];
+    fixSmartQuotes?: PrintWordPipelineStepOptions['fixSmartQuotes'];
+    processLineBreaksAsNewText?: PrintWordPipelineStepOptions['processLineBreaksAsNewText'];
+};
+export declare class PrintWordPipelineStepBuilder extends AbstractFragmentaryPipelineStepBuilder<PrintWordPipelineStepBuilderOptions, PrintWordPipelineStepOptions, PrintWordPipelineStep> {
+    protected getStepType(): PipelineStepType<PrintWordPipelineStep>;
+    protected readMoreOptions(given: PrintWordPipelineStepBuilderOptions, transformed: PrintWordPipelineStepOptions): PrintWordPipelineStepOptions;
+}

package/lib/print-word-step.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { PipelineStepData, PipelineStepPayload } from '@rainbow-o23/n1';
+import { AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions } from '@rainbow-o23/n3';
+import { UserOptions } from 'docx-templates/lib/types';
+export interface PrintWordPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
+    cmdDelimiter?: string | [string, string];
+    literalXmlDelimiter?: string;
+    processLineBreaks?: boolean;
+    noSandbox?: boolean;
+    failFast?: boolean;
+    rejectNullish?: boolean;
+    fixSmartQuotes?: boolean;
+    processLineBreaksAsNewText?: boolean;
+}
+export interface PrintWordPipelineStepInFragment {
+    template: Buffer;
+    data: any;
+    jsContext?: Object;
+}
+export interface PrintWordPipelineStepOutFragment {
+    file: Buffer;
+}
+export declare class PrintWordPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload> extends AbstractFragmentaryPipelineStep<In, Out, PrintWordPipelineStepInFragment, PrintWordPipelineStepOutFragment> {
+    private readonly _cmdDelimiter?;
+    private readonly _literalXmlDelimiter?;
+    private readonly _processLineBreaks?;
+    private readonly _noSandbox?;
+    private readonly _failFast?;
+    private readonly _rejectNullish?;
+    private readonly _fixSmartQuotes?;
+    private readonly _processLineBreaksAsNewText?;
+    constructor(options: PrintWordPipelineStepOptions<In, Out, PrintWordPipelineStepInFragment, PrintWordPipelineStepOutFragment>);
+    protected getCreateReportOptions(): Omit<UserOptions, 'template' | 'data'>;
+    protected printWord(templateWord: Buffer, data: any, jsContext?: Object): Promise<Buffer>;
+    protected doPerform(data: PrintWordPipelineStepInFragment, _request: PipelineStepData<In>): Promise<PrintWordPipelineStepOutFragment>;
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+	"name": "@rainbow-o23/n7",
+	"version": "0.1.16",
+	"description": "o23 excel+csv print",
+	"main": "index.cjs",
+	"module": "index.js",
+	"types": "index.d.ts",
+	"type": "module",
+	"scripts": {
+		"build": "rollup -c",
+		"build:ci": "rollup -c rollup.config.ci.js",
+		"test": "jest"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/InsureMO/rainbow-o23.git"
+	},
+	"author": "Rainbow Team",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/InsureMO/rainbow-o23/issues"
+	},
+	"dependencies": {
+		"@rainbow-o23/n3": "0.1.16",
+		"@rainbow-o23/n4": "0.1.16",
+		"docx-templates": "^4.11.4"
+	},
+	"devDependencies": {
+		"@babel/core": "^7.20.5",
+		"@babel/preset-env": "^7.20.2",
+		"@babel/preset-typescript": "^7.18.6",
+		"@rollup/plugin-babel": "^6.0.4",
+		"@rollup/plugin-eslint": "^9.0.3",
+		"@types/events": "^3.0.1",
+		"@types/node": "18.16.12",
+		"@typescript-eslint/eslint-plugin": "^5.46.0",
+		"@typescript-eslint/parser": "^5.46.0",
+		"eslint": "^8.29.0",
+		"rollup": "^3.7.0",
+		"rollup-plugin-tslint": "^0.2.2",
+		"rollup-plugin-typescript2": "^0.34.1",
+		"tslib": "^2.4.1",
+		"typescript": "5.1.6"
+	},
+	"jest": {
+		"moduleFileExtensions": [
+			"js",
+			"json",
+			"ts",
+			"yaml",
+			"yml"
+		],
+		"testRegex": "(/test/.*\\.(test|spec))\\.[tj]sx?$",
+		"testPathIgnorePatterns": [
+			"/node_modules/"
+		],
+		"transform": {
+			"^.+\\.(t|j)s$": "ts-jest"
+		},
+		"collectCoverageFrom": [
+			"src/**/*.(t|j)s"
+		],
+		"coverageDirectory": "./coverage",
+		"coverageReporters": [
+			"html"
+		],
+		"testEnvironment": "node"
+	},
+	"volta": {
+		"node": "18.19.0",
+		"yarn": "1.22.21"
+	}
+}

package/rollup.config.base.js

@@ -0,0 +1,38 @@
+import {babel} from '@rollup/plugin-babel';
+import eslint from '@rollup/plugin-eslint';
+import typescript from 'rollup-plugin-typescript2';
+
+export const buildConfig = (lint) => {
+	// ['./index.d.ts', './index.js', './index.cjs', './lib'].forEach(f => {
+	// 	const cwd = path.resolve(process.cwd(), f);
+	// 	if (fs.existsSync(cwd)) {
+	// 		fs.rmSync(cwd, {recursive: true, force: true});
+	// 	}
+	// });
+
+	return {
+		input: './src/index.ts',
+		output: [
+			{format: 'es', dir: '.'},
+			{format: 'cjs', file: './index.cjs'}
+		],
+		plugins: [
+			lint ? eslint({exclude: ['../node_modules/**', 'node_modules/**']}) : null,
+			// lint ? tslint({exclude: ['../node_modules/**', 'node_modules/**']}) : null,
+			typescript({clean: true}),
+			babel({babelHelpers: 'bundled'})
+		].filter(x => x != null),
+		external(id) {
+			return ["@rainbow-o23/"].some(scope => id.startsWith(scope))
+				|| [
+					"fs", "path", "docx-templates"
+				].includes(id);
+		},
+		onLog(level, log, handler) {
+			if (log.code === 'CIRCULAR_DEPENDENCY') {
+				return; // Ignore circular dependency warnings
+			}
+			handler(level, log); // otherwise, just print the log
+		}
+	};
+};

package/rollup.config.ci.js

@@ -0,0 +1,3 @@
+import {buildConfig} from './rollup.config.base.js';
+
+export default [buildConfig(false)];

package/rollup.config.js

@@ -0,0 +1,3 @@
+import {buildConfig} from './rollup.config.base.js';
+
+export default [buildConfig(true)];

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './lib/error-codes';
+
+export * from './lib/print-word-step';
+export * from './lib/print-word-step-builder';

package/src/lib/error-codes.ts

@@ -0,0 +1,3 @@
+import {O23ReservedErrorCode} from '@rainbow-o23/n1';
+
+export const ERR_TEMPLATE_NOT_DEFINED: O23ReservedErrorCode = 'O07-00001';

package/src/lib/print-word-step-builder.ts

@@ -0,0 +1,34 @@
+import {PipelineStepType} from '@rainbow-o23/n1';
+import {AbstractFragmentaryPipelineStepBuilder, FragmentaryPipelineStepBuilderOptions} from '@rainbow-o23/n4';
+import {PrintWordPipelineStep, PrintWordPipelineStepOptions} from './print-word-step';
+
+export type PrintWordPipelineStepBuilderOptions = FragmentaryPipelineStepBuilderOptions & {
+	cmd?: PrintWordPipelineStepOptions['cmdDelimiter'];
+	literalXmlDelimiter?: PrintWordPipelineStepOptions['literalXmlDelimiter'];
+	processLineBreaks?: PrintWordPipelineStepOptions['processLineBreaks'];
+	noSandbox?: PrintWordPipelineStepOptions['noSandbox'];
+	failFast?: PrintWordPipelineStepOptions['failFast'];
+	rejectNullish?: PrintWordPipelineStepOptions['rejectNullish'];
+	fixSmartQuotes?: PrintWordPipelineStepOptions['fixSmartQuotes'];
+	processLineBreaksAsNewText?: PrintWordPipelineStepOptions['processLineBreaksAsNewText'];
+};
+
+export class PrintWordPipelineStepBuilder
+	extends AbstractFragmentaryPipelineStepBuilder<PrintWordPipelineStepBuilderOptions, PrintWordPipelineStepOptions, PrintWordPipelineStep> {
+	protected getStepType(): PipelineStepType<PrintWordPipelineStep> {
+		return PrintWordPipelineStep;
+	}
+
+	protected readMoreOptions(given: PrintWordPipelineStepBuilderOptions, transformed: PrintWordPipelineStepOptions): PrintWordPipelineStepOptions {
+		transformed = super.readMoreOptions(given, transformed);
+		transformed.cmdDelimiter = given.cmd;
+		transformed.literalXmlDelimiter = given.literalXmlDelimiter;
+		transformed.processLineBreaks = given.processLineBreaks;
+		transformed.noSandbox = given.noSandbox;
+		transformed.failFast = given.failFast;
+		transformed.rejectNullish = given.rejectNullish;
+		transformed.fixSmartQuotes = given.fixSmartQuotes;
+		transformed.processLineBreaksAsNewText = given.processLineBreaksAsNewText;
+		return transformed;
+	}
+}

package/src/lib/print-word-step.ts

@@ -0,0 +1,84 @@
+import {PipelineStepData, PipelineStepPayload, UncatchableError} from '@rainbow-o23/n1';
+import {AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions} from '@rainbow-o23/n3';
+import {createReport} from 'docx-templates';
+import {UserOptions} from 'docx-templates/lib/types';
+import {ERR_TEMPLATE_NOT_DEFINED} from './error-codes';
+
+export interface PrintWordPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
+	extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
+	cmdDelimiter?: string | [string, string];
+	literalXmlDelimiter?: string;
+	processLineBreaks?: boolean;
+	noSandbox?: boolean;
+	failFast?: boolean;
+	rejectNullish?: boolean;
+	fixSmartQuotes?: boolean;
+	processLineBreaksAsNewText?: boolean;
+}
+
+export interface PrintWordPipelineStepInFragment {
+	template: Buffer;
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	data: any;
+	// eslint-disable-next-line @typescript-eslint/ban-types
+	jsContext?: Object;
+}
+
+export interface PrintWordPipelineStepOutFragment {
+	file: Buffer;
+}
+
+export class PrintWordPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, >
+	extends AbstractFragmentaryPipelineStep<In, Out, PrintWordPipelineStepInFragment, PrintWordPipelineStepOutFragment> {
+	private readonly _cmdDelimiter?: string | [string, string];
+	private readonly _literalXmlDelimiter?: string;
+	private readonly _processLineBreaks?: boolean;
+	private readonly _noSandbox?: boolean;
+	private readonly _failFast?: boolean;
+	private readonly _rejectNullish?: boolean;
+	private readonly _fixSmartQuotes?: boolean;
+	private readonly _processLineBreaksAsNewText?: boolean;
+
+	public constructor(options: PrintWordPipelineStepOptions<In, Out, PrintWordPipelineStepInFragment, PrintWordPipelineStepOutFragment>) {
+		super(options);
+		this._cmdDelimiter = options.cmdDelimiter ?? '+++';
+		this._literalXmlDelimiter = options.literalXmlDelimiter ?? '||';
+		this._processLineBreaks = options.processLineBreaks ?? true;
+		this._noSandbox = options.noSandbox ?? true;
+		this._failFast = options.failFast ?? true;
+		this._rejectNullish = options.rejectNullish ?? false;
+		this._fixSmartQuotes = options.fixSmartQuotes ?? false;
+		this._processLineBreaksAsNewText = options.processLineBreaksAsNewText ?? false;
+	}
+
+	protected getCreateReportOptions(): Omit<UserOptions, 'template' | 'data'> {
+		return {
+			cmdDelimiter: this._cmdDelimiter,
+			literalXmlDelimiter: this._literalXmlDelimiter,
+			processLineBreaks: this._processLineBreaks,
+			noSandbox: this._noSandbox,
+			failFast: this._failFast,
+			rejectNullish: this._rejectNullish,
+			fixSmartQuotes: this._fixSmartQuotes,
+			processLineBreaksAsNewText: this._processLineBreaksAsNewText
+		};
+	}
+
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
+	protected async printWord(templateWord: Buffer, data: any, jsContext?: Object): Promise<Buffer> {
+		const buffer = await createReport({
+			...this.getCreateReportOptions(),
+			template: templateWord, data, additionalJsContext: jsContext
+		});
+		return Buffer.from(buffer.buffer);
+	}
+
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	protected async doPerform(data: PrintWordPipelineStepInFragment, _request: PipelineStepData<In>): Promise<PrintWordPipelineStepOutFragment> {
+		if (data.template == null) {
+			throw new UncatchableError(ERR_TEMPLATE_NOT_DEFINED, 'Print template cannot be null.');
+		}
+		const file = await this.printWord(data.template, data.data, data.jsContext);
+		return {file};
+	}
+}

package/test/print-word.test.ts

@@ -0,0 +1,58 @@
+import {createConfig, createLogger} from '@rainbow-o23/n1';
+import * as fs from 'fs';
+import * as path from 'path';
+import {PrintWordPipelineStep} from '../src';
+
+const logger = createLogger();
+const config = createConfig(logger);
+
+test('Test Print Word', async () => {
+	const template = fs.readFileSync(path.resolve(__dirname, 'template.docx'));
+	const data = {
+		createDate: '2023-12-1',
+		project: {
+			name: 'Rainbow O23',
+			url: 'https://github.com/InsureMO/rainbow-o23'
+		},
+		groups: [
+			{
+				depts: [
+					{name: 'Development', cashierName: 'John', cashInTxn: 134.4, cashInAmt: 1344},
+					{name: 'Research', cashierName: 'Joe', cashInTxn: 159.67, cashInAmt: 1277.36}
+				],
+				subTotal: {
+					cashInTxn: 294.07, cashInAmt: 2621.36
+				}
+			},
+			{
+				depts: [
+					{name: 'Development', cashierName: 'John', cashInTxn: 104.4, cashInAmt: 1044},
+					{name: 'Research', cashierName: 'Joe', cashInTxn: 129.67, cashInAmt: 977.36}
+				],
+				subTotal: {
+					cashInTxn: 234.07, cashInAmt: 2021.36
+				}
+			}
+		]
+	};
+
+	const step = new PrintWordPipelineStep({config, logger});
+	const {content: {file}} = await step.perform({
+		content: {
+			template, data, jsContext: {
+				link: () => {
+					return {url: data.project.url, label: data.project.name};
+				},
+				logo: () => {
+					const data = Buffer.from(`<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="63" height="20" role="img" aria-label="InsureMO"><title>InsureMO</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="63" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#777af2"/><rect x="0" width="63" height="20" fill="#777af2"/><rect width="63" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">InsureMO</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="530">InsureMO</text></g></svg>`, 'utf-8');
+					return {width: 1.66687479, height: 0.5291666, data, extension: '.svg'};
+				},
+				html: () => {
+					return `<meta charset="UTF-8"><body><strong style="color: red;">This paragraph should be red and strong</strong></body>`;
+				}
+			}
+		}
+	});
+	expect(file).not.toBeNull();
+	fs.writeFileSync(path.resolve(__dirname, 'output.docx'), file);
+});

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+	"compilerOptions": {
+		"baseUrl": ".",
+		"outDir": "./dist",
+		"declarationDir": "./lib",
+		"module": "ES2015",
+		"target": "ESNext",
+		"moduleResolution": "node",
+		"sourceMap": true,
+		// create d.ts file
+		"declaration": true,
+		"removeComments": true,
+		"noImplicitAny": false,
+		"allowSyntheticDefaultImports": true,
+		"allowUnreachableCode": true,
+		"allowUnusedLabels": false,
+		"alwaysStrict": true,
+		"allowJs": true,
+		"experimentalDecorators": true,
+		"lib": [
+			"es5",
+			"es2015",
+			"es2016",
+			"es2017",
+			"es2018",
+			"dom"
+		]
+	},
+	"include": [
+		"src/**/*"
+	],
+	"exclude": [
+		"node_modules",
+		"dist"
+	]
+}