docxtemplater/js/docxtemplater.test-d.ts

docx and pptx generator working with templates and data (like Mustache, for Word and Powerpoint documents)

import Docxtemplater, {DXT} from "./docxtemplater";
const PizZip: any = require('pizzip');
import {expectType, expectError} from 'tsd';
const doc1 = new Docxtemplater({}, {delimiters: { start: '[[', end: ']]'}, 
   nullGetter: function(part) {
        expectError(part.foobar);
        if (part.module === "rawxml") {
            return "";
        }
        if (part.type === "placeholder" && part.value === "foobar") {
            return "{Foobar}"
        }
        return "Hello";
    },
});
doc1.setData({foo: "bar"});
doc1.attachModule({
    set: function() {

    },
    parse: function(placeHolderContent) {
        if (placeHolderContent.indexOf(":hello") === 0) {
            return {
                type: "placeholder",
                module: "mycustomModule",
                value: placeHolderContent.substr(7),
                isEmpty: "foobar",
            }
        }
        return null;
    },
    getFoobar: function() {

    }
});
doc1.render()

expectError(doc1.foobar())
expectError(new Docxtemplater(1,2))
expectError(new Docxtemplater({}, {delimiters: { start: 1, end: ']]'}}))
expectError(new Docxtemplater({}, {delimiters: { start: '[['}}))

const doc2 = new Docxtemplater();
doc2.loadZip(new PizZip("hello"));

// Error because parser should return a {get: fn} object
expectError(doc2.setOptions({
    parser: function(tag) {
        return 10;
    }
}));

doc2.setOptions({
    parser: function(tag) {
        expectType<string>(tag)
        return {
            get: function(scope, context) {
                const first = context.scopeList[0]
                expectType<DXT.integer>(context.num)
                expectError(context.foobar);
                if (context.meta.part.value === tag) {
                    return scope[context.meta.part.value];
                }
                expectError(context.meta.part.other);
                return scope[tag];
            }
        }
    }
});

const doc3 = new Docxtemplater();
doc3.loadZip(new PizZip("hello"));
doc3.compile();
doc3.resolveData({a: "b"}).then(function() {
    doc3.render();
});
const text = doc3.getFullText();
const text2 = doc3.getFullText("word/heading1.xml");

// Error because getFullText requires a string parameter
expectError(doc3.getFullText(false));
expectError(doc3.getFullText(10));