Summary

This module doesn't expose tags, but it makes it possible to do some operations on the docx itself.

After installing the module, you can use a working demo by running node sample.js.

The META module currently can :

• Make a document readonly
• Add a text watermark
• Update the margins
• Change the hyperlink base for the whole document
• Restrict edition of document using a password
• Search and replace some text in a paragraph
• Search for some text and place a comment
• Add a comment together with some tag
• Change language of document globally

Usage

To use this module, do your operations before the call to the render method.

Readonly

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
metaModule.readonly();
doc.render(data);

Watermark

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
metaModule.addTextWatermark("DRAFT", {
    diagonal: true,
});
doc.render(data);

Restrict Edition using a password

Word has a "restrict edition" mode that one can setup so that the document will be readonly unless you have a specific password.

The meta module can protect a document in this way.

Note that the content of the document will not be encrypted, the Microsoft Office software will simply respect the restriction and a malicious user could quite easily remove that protection.

Usage is like this :

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
metaModule.restrictEdition({
    password: "my-complex-password", // This should be autogenerated
    // protect, default "readOnly",
    // algorithm, default: "sha512", // You most likely should not change this, this is the most secure algorithm that word does support
    // spinCount, default: 100000, // You most likely should not change this, a high spinCount will make the password much more difficult to guess
    // salt, base64 string (completely optional, it will be randomly generated when not provided)
});

doc.render(data);

The password length must be of at least 6 characters.

Note that spinCount and algorithm options already have default values which are secure enough for most use cases.

The protect option can take one of the following values :

• "readOnly" => The document cannot be edited at all
• "trackedChanges" => The document can be edited, all changes are tracked
• "forms" => Only forms can be edited
• "comments" => Only comments can be added/changed

There also is a salt parameter which is a base64string of 24 characters, but this value is generated by the library so you don't have to, in most cases.

Margins

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
// Margins are in inches, and apply to all pages
metaModule.setMargins({
    top: 0.5,
    left: 0.8,
    right: 1.2,
    bottom: 1,
});
doc.render(data);

Hyperlink Base

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
const baseLink = "https://github.com/facebook/react";
metaModule.setHyperlinkBase(baseLink);
doc.render(data);

Search and replace some text

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
const results = metaModule.search("Lorem"); // search also works with regex
if (results.length > 0) {
    metaModule.replace(results[0], "Tatum");
}
doc.render(data);

This will replace the first found "Lorem" by "Tatum".

Add a comment from a search

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
const results = metaModule.search("Lorem");
if (results.length > 0) {
    metaModule.addComment(results[0], "This is a latin word", {
        author: "John Doe",
        initials: "JD",
        date: new Date(),
    });
}
doc.render(data);

This will search for the first "Lorem" and add a comment around it containing "This is a latin word".

Add a comment from a tag

Since version 3.4.0 of the meta module, it is possible to add a comment from a tag using the following code :

In your template :

const CommentModule = require("docxtemplater-meta-module/comment-module.js");
const doc = new Docxtemplater(zip, {
    modules: [
        new CommentModule({
            author: "John the pirate",
            date: new Date().toISOString(),
        }),
    ],
});
doc.render({
    user: {
        text: "John",
        comment: "Updated 2022\nSome comment",
        // author: "Jane the pirate",
    },
});

Change document language

It is possible to change the language that is used for spell checking globally in your document.

const DocxtemplaterMetaModule = require("docxtemplater-meta-module");
const metaModule = new DocxtemplaterMetaModule();
const doc = new Docxtemplater(zip, {
    modules: [metaModule],
});
metaModule.setLang("en-US");
doc.render(data);

The language parameter given to the setLang function must be a BCP 47 code.

See following links describing BCP 47 code : Tech on the net, Microsoft Documentation

Following languages can be used (list non-exhaustive)

• fr-FR : French (France)
• en-US : English (US)
• ru-RU : Russian (Russia)
• zh-CN : Chinese (Mainland China)
• ja-JP : Japanese (Japan)
• ar-SA : Arabic (Saudi Arabia)
• hi-IN : Hindi (India)
• de-DE : German (Germany)
• he-IL : Hebrew (Israel)
• nl-NL : Dutch (Netherlands)
• es-ES : Spanish (Spain)
• ca-ES : Catalan (Spain)