smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into feat/declaritive

Browse Source 
# Conflicts:
#	src/file/paragraph/formatting/border.spec.ts
#	src/file/paragraph/links/outline-level.spec.ts
#	src/file/paragraph/run/run.spec.ts
This commit is contained in:
Dolan
2019-07-02 01:33:41 +01:00
parent edbb4ce9f2 9e8d67c4a9
commit f33d6da65a
25 changed files with 879 additions and 277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
demo/demo44.ts
View File

@ -1,23 +1,33 @@
// Sections with multiple columns // Sections with multiple columns
// Import from 'docx' rather than '../build' if you install from npm // Import from 'docx' rather than '../build' if you install from npm
import * as fs from "fs"; import * as fs from "fs";
import { Document, Packer} from "../build"; import { Document, Packer } from "../build";
const doc = new Document(); const doc = new Document();
doc.addSection({ doc.addSection({
num: 2, column: {
width: 708,
count: 2,
},
}); });
doc.createParagraph("This text will be split into 2 columns on a page."); doc.createParagraph("This text will be split into 2 columns on a page.");
doc.createParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."); doc.createParagraph(
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
);
doc.addSection({ doc.addSection({
num: 3, column: {
width: 708,
count: 2,
},
}); });
doc.createParagraph("This text will be split into 3 columns on a page."); doc.createParagraph("This text will be split into 3 columns on a page.");
doc.createParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."); doc.createParagraph(
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
);
const packer = new Packer(); const packer = new Packer();

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "docx", "name": "docx",
"version": "5.0.0-rc3", "version": "5.0.0-rc4",
"description": "Generate .docx documents with JavaScript (formerly Office-Clippy)", "description": "Generate .docx documents with JavaScript (formerly Office-Clippy)",
"main": "build/index.js", "main": "build/index.js",
"scripts": { "scripts": {

37
src/export/formatter.spec.ts
View File

@ -1,10 +1,9 @@
import { assert } from "chai"; import { assert, expect } from "chai";
import { Formatter } from "../export/formatter"; import { Formatter } from "export/formatter";
import * as file from "../file"; import * as file from "file";
import { CoreProperties } from "../file/core-properties"; import { CoreProperties } from "file/core-properties";
import { Attributes } from "../file/xml-components"; import { Attributes } from "file/xml-components";
import { Utility } from "../tests/utility";
describe("Formatter", () => { describe("Formatter", () => {
let formatter: Formatter; let formatter: Formatter;
@ -43,26 +42,24 @@ describe("Formatter", () => {
const attributes = new Attributes({ const attributes = new Attributes({
rsidSect: "test2", rsidSect: "test2",
}); });
let newJson = formatter.format(attributes); const tree = formatter.format(attributes);
newJson = Utility.jsonify(newJson); expect(tree).to.deep.equal({
if (newJson._attr === undefined) { _attr: {
assert.fail(); "w:rsidSect": "test2",
return; },
} });
assert.isDefined(newJson._attr["w:rsidSect"]);
}); });
it("should format attributes (val)", () => { it("should format attributes (val)", () => {
const attributes = new Attributes({ const attributes = new Attributes({
val: "test", val: "test",
}); });
let newJson = formatter.format(attributes); const tree = formatter.format(attributes);
newJson = Utility.jsonify(newJson); expect(tree).to.deep.equal({
if (newJson._attr === undefined) { _attr: {
assert.fail(); "w:val": "test",
return; },
} });
assert.isDefined(newJson._attr["w:val"]);
}); });
it("should should change 'p' tag into 'w:p' tag", () => { it("should should change 'p' tag into 'w:p' tag", () => {

36
src/export/packer/next-compiler.ts
View File

@ -30,10 +30,12 @@ interface IXmlifyedFileMapping {
export class Compiler { export class Compiler {
private readonly formatter: Formatter; private readonly formatter: Formatter;
private readonly imageReplacer: ImageReplacer; private readonly imageReplacer: ImageReplacer;
private readonly prettifyXml?: boolean;
constructor() { constructor(prettifyXml?: boolean) {
this.formatter = new Formatter(); this.formatter = new Formatter();
this.imageReplacer = new ImageReplacer(); this.imageReplacer = new ImageReplacer();
this.prettifyXml = prettifyXml;
} }
public compile(file: File): JSZip { public compile(file: File): JSZip {
@ -71,7 +73,7 @@ export class Compiler {
return { return {
Relationships: { Relationships: {
data: (() => { data: (() => {
const xmlData = xml(this.formatter.format(file.Document)); const xmlData = xml(this.formatter.format(file.Document), this.prettifyXml);
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media); const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
mediaDatas.forEach((mediaData, i) => { mediaDatas.forEach((mediaData, i) => {
@ -82,13 +84,13 @@ export class Compiler {
); );
}); });
return xml(this.formatter.format(file.DocumentRelationships)); return xml(this.formatter.format(file.DocumentRelationships), this.prettifyXml);
})(), })(),
path: "word/_rels/document.xml.rels", path: "word/_rels/document.xml.rels",
}, },
Document: { Document: {
data: (() => { data: (() => {
const tempXmlData = xml(this.formatter.format(file.Document), true); const tempXmlData = xml(this.formatter.format(file.Document), this.prettifyXml);
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media); const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, documentRelationshipCount); const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, documentRelationshipCount);
@ -97,7 +99,7 @@ export class Compiler {
path: "word/document.xml", path: "word/document.xml",
}, },
Styles: { Styles: {
data: xml(this.formatter.format(file.Styles)), data: xml(this.formatter.format(file.Styles), this.prettifyXml),
path: "word/styles.xml", path: "word/styles.xml",
}, },
Properties: { Properties: {
@ -110,15 +112,15 @@ export class Compiler {
path: "docProps/core.xml", path: "docProps/core.xml",
}, },
Numbering: { Numbering: {
data: xml(this.formatter.format(file.Numbering)), data: xml(this.formatter.format(file.Numbering), this.prettifyXml),
path: "word/numbering.xml", path: "word/numbering.xml",
}, },
FileRelationships: { FileRelationships: {
data: xml(this.formatter.format(file.FileRelationships)), data: xml(this.formatter.format(file.FileRelationships), this.prettifyXml),
path: "_rels/.rels", path: "_rels/.rels",
}, },
HeaderRelationships: file.Headers.map((headerWrapper, index) => { HeaderRelationships: file.Headers.map((headerWrapper, index) => {
const xmlData = xml(this.formatter.format(headerWrapper.Header)); const xmlData = xml(this.formatter.format(headerWrapper.Header), this.prettifyXml);
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media); const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
mediaDatas.forEach((mediaData, i) => { mediaDatas.forEach((mediaData, i) => {
@ -130,12 +132,12 @@ export class Compiler {
}); });
return { return {
data: xml(this.formatter.format(headerWrapper.Relationships)), data: xml(this.formatter.format(headerWrapper.Relationships), this.prettifyXml),
path: `word/_rels/header${index + 1}.xml.rels`, path: `word/_rels/header${index + 1}.xml.rels`,
}; };
}), }),
FooterRelationships: file.Footers.map((footerWrapper, index) => { FooterRelationships: file.Footers.map((footerWrapper, index) => {
const xmlData = xml(this.formatter.format(footerWrapper.Footer)); const xmlData = xml(this.formatter.format(footerWrapper.Footer), this.prettifyXml);
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media); const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
mediaDatas.forEach((mediaData, i) => { mediaDatas.forEach((mediaData, i) => {
@ -147,12 +149,12 @@ export class Compiler {
}); });
return { return {
data: xml(this.formatter.format(footerWrapper.Relationships)), data: xml(this.formatter.format(footerWrapper.Relationships), this.prettifyXml),
path: `word/_rels/footer${index + 1}.xml.rels`, path: `word/_rels/footer${index + 1}.xml.rels`,
}; };
}), }),
Headers: file.Headers.map((headerWrapper, index) => { Headers: file.Headers.map((headerWrapper, index) => {
const tempXmlData = xml(this.formatter.format(headerWrapper.Header)); const tempXmlData = xml(this.formatter.format(headerWrapper.Header), this.prettifyXml);
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media); const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
// TODO: 0 needs to be changed when headers get relationships of their own // TODO: 0 needs to be changed when headers get relationships of their own
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0); const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
@ -163,7 +165,7 @@ export class Compiler {
}; };
}), }),
Footers: file.Footers.map((footerWrapper, index) => { Footers: file.Footers.map((footerWrapper, index) => {
const tempXmlData = xml(this.formatter.format(footerWrapper.Footer)); const tempXmlData = xml(this.formatter.format(footerWrapper.Footer), this.prettifyXml);
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media); const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
// TODO: 0 needs to be changed when headers get relationships of their own // TODO: 0 needs to be changed when headers get relationships of their own
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0); const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
@ -174,19 +176,19 @@ export class Compiler {
}; };
}), }),
ContentTypes: { ContentTypes: {
data: xml(this.formatter.format(file.ContentTypes)), data: xml(this.formatter.format(file.ContentTypes), this.prettifyXml),
path: "[Content_Types].xml", path: "[Content_Types].xml",
}, },
AppProperties: { AppProperties: {
data: xml(this.formatter.format(file.AppProperties)), data: xml(this.formatter.format(file.AppProperties), this.prettifyXml),
path: "docProps/app.xml", path: "docProps/app.xml",
}, },
FootNotes: { FootNotes: {
data: xml(this.formatter.format(file.FootNotes)), data: xml(this.formatter.format(file.FootNotes), this.prettifyXml),
path: "word/footnotes.xml", path: "word/footnotes.xml",
}, },
Settings: { Settings: {
data: xml(this.formatter.format(file.Settings)), data: xml(this.formatter.format(file.Settings), this.prettifyXml),
path: "word/settings.xml", path: "word/settings.xml",
}, },
}; };

4
src/export/packer/packer.ts
View File

@ -4,8 +4,8 @@ import { Compiler } from "./next-compiler";
export class Packer { export class Packer {
private readonly compiler: Compiler; private readonly compiler: Compiler;
constructor() { constructor(prettifyXml?: boolean) {
this.compiler = new Compiler(); this.compiler = new Compiler(prettifyXml);
} }
public async toBuffer(file: File): Promise<Buffer> { public async toBuffer(file: File): Promise<Buffer> {

6
src/file/document/body/section-properties/section-properties.spec.ts
View File

@ -25,8 +25,10 @@ describe("SectionProperties", () => {
footer: 708, footer: 708,
gutter: 0, gutter: 0,
mirror: false, mirror: false,
space: 708, column: {
num: 1, space: 708,
count: 1,
},
linePitch: 360, linePitch: 360,
headers: { headers: {
default: new HeaderWrapper(media, 100), default: new HeaderWrapper(media, 100),

17
src/file/document/body/section-properties/section-properties.ts
View File

@ -4,7 +4,6 @@ import { HeaderWrapper } from "file/header-wrapper";
import { XmlComponent } from "file/xml-components"; import { XmlComponent } from "file/xml-components";
import { Columns } from "./columns/columns"; import { Columns } from "./columns/columns";
import { IColumnsAttributes } from "./columns/columns-attributes";
import { DocumentGrid } from "./doc-grid/doc-grid"; import { DocumentGrid } from "./doc-grid/doc-grid";
import { IDocGridAttributesProperties } from "./doc-grid/doc-grid-attributes"; import { IDocGridAttributesProperties } from "./doc-grid/doc-grid-attributes";
import { FooterReferenceType } from "./footer-reference"; import { FooterReferenceType } from "./footer-reference";
@ -40,19 +39,24 @@ interface ITitlePageOptions {
export type SectionPropertiesOptions = IPageSizeAttributes & export type SectionPropertiesOptions = IPageSizeAttributes &
IPageMarginAttributes & IPageMarginAttributes &
IColumnsAttributes &
IDocGridAttributesProperties & IDocGridAttributesProperties &
IHeadersOptions & IHeadersOptions &
IFootersOptions & IFootersOptions &
IPageNumberTypeAttributes & IPageNumberTypeAttributes &
ILineNumberAttributes & ILineNumberAttributes &
IPageBordersOptions & IPageBordersOptions &
ITitlePageOptions; ITitlePageOptions & {
readonly column?: {
readonly space?: number;
readonly count?: number;
};
};
// Need to decouple this from the attributes
export class SectionProperties extends XmlComponent { export class SectionProperties extends XmlComponent {
private readonly options: SectionPropertiesOptions; private readonly options: SectionPropertiesOptions;
constructor(options: SectionPropertiesOptions = {}) { constructor(options: SectionPropertiesOptions = { column: {} }) {
super("w:sectPr"); super("w:sectPr");
const { const {
@ -66,8 +70,7 @@ export class SectionProperties extends XmlComponent {
footer = 708, footer = 708,
gutter = 0, gutter = 0,
mirror = false, mirror = false,
space = 708, column = {},
num = 1,
linePitch = 360, linePitch = 360,
orientation = PageOrientation.PORTRAIT, orientation = PageOrientation.PORTRAIT,
headers, headers,
@ -89,7 +92,7 @@ export class SectionProperties extends XmlComponent {
this.options = options; this.options = options;
this.root.push(new PageSize(width, height, orientation)); this.root.push(new PageSize(width, height, orientation));
this.root.push(new PageMargin(top, right, bottom, left, header, footer, gutter, mirror)); this.root.push(new PageMargin(top, right, bottom, left, header, footer, gutter, mirror));
this.root.push(new Columns(space, num)); this.root.push(new Columns(column.space ? column.space : 708, column.count ? column.count : 1));
this.root.push(new DocumentGrid(linePitch)); this.root.push(new DocumentGrid(linePitch));
this.addHeaders(headers); this.addHeaders(headers);

401
src/file/drawing/drawing.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { Drawing, IDrawingOptions } from "./drawing"; import { Drawing, IDrawingOptions } from "./drawing";
@ -32,16 +32,181 @@ describe("Drawing", () => {
let currentBreak: Drawing; let currentBreak: Drawing;
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Drawing with correct root key", () => {
currentBreak = createDrawing();
const newJson = Utility.jsonify(currentBreak);
assert.equal(newJson.rootKey, "w:drawing");
});
it("should create a drawing with inline element when there are no options passed", () => { it("should create a drawing with inline element when there are no options passed", () => {
currentBreak = createDrawing(); currentBreak = createDrawing();
const newJson = Utility.jsonify(currentBreak); const tree = new Formatter().format(currentBreak);
assert.equal(newJson.root[0].rootKey, "wp:inline"); expect(tree).to.deep.equal({
"w:drawing": [
{
"wp:inline": [
{
_attr: {
distB: 0,
distL: 0,
distR: 0,
distT: 0,
},
},
{
"wp:extent": {
_attr: {
cx: 952500,
cy: 952500,
},
},
},
{
"wp:effectExtent": {
_attr: {
b: 0,
l: 0,
r: 0,
t: 0,
},
},
},
{
"wp:docPr": {
_attr: {
descr: "",
id: 0,
name: "",
},
},
},
{
"wp:cNvGraphicFramePr": [
{
"a:graphicFrameLocks": {
_attr: {
// tslint:disable-next-line:object-literal-key-quotes
noChangeAspect: 1,
"xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
},
},
},
],
},
{
"a:graphic": [
{
_attr: {
"xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
},
},
{
"a:graphicData": [
{
_attr: {
uri: "http://schemas.openxmlformats.org/drawingml/2006/picture",
},
},
{
"pic:pic": [
{
_attr: {
"xmlns:pic": "http://schemas.openxmlformats.org/drawingml/2006/picture",
},
},
{
"pic:nvPicPr": [
{
"pic:cNvPr": {
_attr: {
desc: "",
id: 0,
name: "",
},
},
},
{
"pic:cNvPicPr": [
{
"a:picLocks": {
_attr: {
noChangeArrowheads: 1,
noChangeAspect: 1,
},
},
},
],
},
],
},
{
"pic:blipFill": [
{
"a:blip": {
_attr: {
// tslint:disable-next-line:object-literal-key-quotes
cstate: "none",
"r:embed": "rId{test.jpg}",
},
},
},
{
"a:srcRect": {},
},
{
"a:stretch": [
{
"a:fillRect": {},
},
],
},
],
},
{
"pic:spPr": [
{
_attr: {
bwMode: "auto",
},
},
{
"a:xfrm": [
{
"a:ext": {
_attr: {
cx: 952500,
cy: 952500,
},
},
},
{
"a:off": {
_attr: {
x: 0,
y: 0,
},
},
},
],
},
{
"a:prstGeom": [
{
_attr: {
prst: "rect",
},
},
{
"a:avLst": {},
},
],
},
],
},
],
},
],
},
],
},
],
},
],
});
}); });
it("should create a drawing with anchor element when there options are passed", () => { it("should create a drawing with anchor element when there options are passed", () => {
@ -55,8 +220,220 @@ describe("Drawing", () => {
}, },
}, },
}); });
const newJson = Utility.jsonify(currentBreak); const tree = new Formatter().format(currentBreak);
assert.equal(newJson.root[0].rootKey, "wp:anchor"); expect(tree).to.deep.equal({
"w:drawing": [
{
"wp:anchor": [
{
_attr: {
allowOverlap: "1",
behindDoc: "0",
distB: 0,
distL: 0,
distR: 0,
distT: 0,
layoutInCell: "1",
locked: "0",
relativeHeight: 952500,
simplePos: "0",
},
},
{
"wp:simplePos": {
_attr: {
x: 0,
y: 0,
},
},
},
{
"wp:positionH": [
{
_attr: {
relativeFrom: "page",
},
},
{
"wp:posOffset": ["0"],
},
],
},
{
"wp:positionV": [
{
_attr: {
relativeFrom: "page",
},
},
{
"wp:posOffset": ["0"],
},
],
},
{
"wp:extent": {
_attr: {
cx: 952500,
cy: 952500,
},
},
},
{
"wp:effectExtent": {
_attr: {
b: 0,
l: 0,
r: 0,
t: 0,
},
},
},
{
"wp:wrapNone": {},
},
{
"wp:docPr": {
_attr: {
descr: "",
id: 0,
name: "",
},
},
},
{
"wp:cNvGraphicFramePr": [
{
"a:graphicFrameLocks": {
_attr: {
// tslint:disable-next-line:object-literal-key-quotes
noChangeAspect: 1,
"xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
},
},
},
],
},
{
"a:graphic": [
{
_attr: {
"xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
},
},
{
"a:graphicData": [
{
_attr: {
uri: "http://schemas.openxmlformats.org/drawingml/2006/picture",
},
},
{
"pic:pic": [
{
_attr: {
"xmlns:pic": "http://schemas.openxmlformats.org/drawingml/2006/picture",
},
},
{
"pic:nvPicPr": [
{
"pic:cNvPr": {
_attr: {
desc: "",
id: 0,
name: "",
},
},
},
{
"pic:cNvPicPr": [
{
"a:picLocks": {
_attr: {
noChangeArrowheads: 1,
noChangeAspect: 1,
},
},
},
],
},
],
},
{
"pic:blipFill": [
{
"a:blip": {
_attr: {
// tslint:disable-next-line:object-literal-key-quotes
cstate: "none",
"r:embed": "rId{test.jpg}",
},
},
},
{
"a:srcRect": {},
},
{
"a:stretch": [
{
"a:fillRect": {},
},
],
},
],
},
{
"pic:spPr": [
{
_attr: {
bwMode: "auto",
},
},
{
"a:xfrm": [
{
"a:ext": {
_attr: {
cx: 952500,
cy: 952500,
},
},
},
{
"a:off": {
_attr: {
x: 0,
y: 0,
},
},
},
],
},
{
"a:prstGeom": [
{
_attr: {
prst: "rect",
},
},
{
"a:avLst": {},
},
],
},
],
},
],
},
],
},
],
},
],
},
],
});
}); });
}); });
}); });

11
src/file/drawing/floating/align.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { Align } from "./align"; import { Align } from "./align";
import { VerticalPositionAlign } from "./floating-position"; import { VerticalPositionAlign } from "./floating-position";
@ -8,9 +8,10 @@ import { VerticalPositionAlign } from "./floating-position";
describe("Align", () => { describe("Align", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a element with correct root key", () => { it("should create a element with correct root key", () => {
const newJson = Utility.jsonify(new Align(VerticalPositionAlign.CENTER)); const tree = new Formatter().format(new Align(VerticalPositionAlign.CENTER));
assert.equal(newJson.rootKey, "wp:align"); expect(tree).to.deep.equal({
assert.include(newJson.root[0], VerticalPositionAlign.CENTER); "wp:align": ["center"],
});
}); });
}); });
}); });

42
src/file/drawing/floating/horizontal-position.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { HorizontalPositionAlign, HorizontalPositionRelativeFrom } from "./floating-position"; import { HorizontalPositionAlign, HorizontalPositionRelativeFrom } from "./floating-position";
import { HorizontalPosition } from "./horizontal-position"; import { HorizontalPosition } from "./horizontal-position";
@ -8,35 +8,45 @@ import { HorizontalPosition } from "./horizontal-position";
describe("HorizontalPosition", () => { describe("HorizontalPosition", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a element with position align", () => { it("should create a element with position align", () => {
const newJson = Utility.jsonify( const tree = new Formatter().format(
new HorizontalPosition({ new HorizontalPosition({
relative: HorizontalPositionRelativeFrom.MARGIN, relative: HorizontalPositionRelativeFrom.MARGIN,
align: HorizontalPositionAlign.CENTER, align: HorizontalPositionAlign.CENTER,
}), }),
); );
assert.equal(newJson.rootKey, "wp:positionH"); expect(tree).to.deep.equal({
assert.include(newJson.root[0].root, { "wp:positionH": [
relativeFrom: "margin", {
_attr: {
relativeFrom: "margin",
},
},
{
"wp:align": ["center"],
},
],
}); });
assert.equal(newJson.root[1].rootKey, "wp:align");
assert.include(newJson.root[1].root, "center");
}); });
it("should create a element with offset", () => { it("should create a element with offset", () => {
const newJson = Utility.jsonify( const tree = new Formatter().format(
new HorizontalPosition({ new HorizontalPosition({
relative: HorizontalPositionRelativeFrom.MARGIN, relative: HorizontalPositionRelativeFrom.MARGIN,
offset: 40, offset: 40,
}), }),
); );
assert.equal(newJson.rootKey, "wp:positionH"); expect(tree).to.deep.equal({
assert.include(newJson.root[0].root, { "wp:positionH": [
relativeFrom: "margin", {
_attr: {
relativeFrom: "margin",
},
},
{
"wp:posOffset": ["40"],
},
],
}); });
assert.equal(newJson.root[1].rootKey, "wp:posOffset");
assert.include(newJson.root[1].root[0], 40);
}); });
}); });
}); });

11
src/file/drawing/floating/position-offset.spec.ts
View File

@ -1,15 +1,16 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { PositionOffset } from "./position-offset"; import { PositionOffset } from "./position-offset";
describe("PositionOffset", () => { describe("PositionOffset", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a element with correct root key", () => { it("should create a element with correct root key", () => {
const newJson = Utility.jsonify(new PositionOffset(50)); const tree = new Formatter().format(new PositionOffset(50));
assert.equal(newJson.rootKey, "wp:posOffset"); expect(tree).to.deep.equal({
assert.equal(newJson.root[0], 50); "wp:posOffset": ["50"],
});
}); });
}); });
}); });

17
src/file/drawing/floating/simple-pos.spec.ts
View File

@ -1,17 +1,20 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { SimplePos } from "./simple-pos"; import { SimplePos } from "./simple-pos";
describe("SimplePos", () => { describe("SimplePos", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a element with correct root key", () => { it("should create a element with correct root key", () => {
const newJson = Utility.jsonify(new SimplePos()); const tree = new Formatter().format(new SimplePos());
assert.equal(newJson.rootKey, "wp:simplePos"); expect(tree).to.deep.equal({
assert.include(newJson.root[0].root, { "wp:simplePos": {
x: 0, _attr: {
y: 0, x: 0,
y: 0,
},
},
}); });
}); });
}); });

42
src/file/drawing/floating/vertical-position.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { VerticalPositionAlign, VerticalPositionRelativeFrom } from "./floating-position"; import { VerticalPositionAlign, VerticalPositionRelativeFrom } from "./floating-position";
import { VerticalPosition } from "./vertical-position"; import { VerticalPosition } from "./vertical-position";
@ -8,35 +8,45 @@ import { VerticalPosition } from "./vertical-position";
describe("VerticalPosition", () => { describe("VerticalPosition", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a element with position align", () => { it("should create a element with position align", () => {
const newJson = Utility.jsonify( const tree = new Formatter().format(
new VerticalPosition({ new VerticalPosition({
relative: VerticalPositionRelativeFrom.MARGIN, relative: VerticalPositionRelativeFrom.MARGIN,
align: VerticalPositionAlign.INSIDE, align: VerticalPositionAlign.INSIDE,
}), }),
); );
assert.equal(newJson.rootKey, "wp:positionV"); expect(tree).to.deep.equal({
assert.include(newJson.root[0].root, { "wp:positionV": [
relativeFrom: "margin", {
_attr: {
relativeFrom: "margin",
},
},
{
"wp:align": ["inside"],
},
],
}); });
assert.equal(newJson.root[1].rootKey, "wp:align");
assert.include(newJson.root[1].root, "inside");
}); });
it("should create a element with offset", () => { it("should create a element with offset", () => {
const newJson = Utility.jsonify( const tree = new Formatter().format(
new VerticalPosition({ new VerticalPosition({
relative: VerticalPositionRelativeFrom.MARGIN, relative: VerticalPositionRelativeFrom.MARGIN,
offset: 40, offset: 40,
}), }),
); );
assert.equal(newJson.rootKey, "wp:positionV"); expect(tree).to.deep.equal({
assert.include(newJson.root[0].root, { "wp:positionV": [
relativeFrom: "margin", {
_attr: {
relativeFrom: "margin",
},
},
{
"wp:posOffset": ["40"],
},
],
}); });
assert.equal(newJson.root[1].rootKey, "wp:posOffset");
assert.include(newJson.root[1].root[0], 40);
}); });
}); });
}); });

27
src/file/paragraph/formatting/border.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { assert, expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { ThematicBreak } from "./border"; import { ThematicBreak } from "./border";
@ -28,14 +28,21 @@ describe("ThematicBreak", () => {
}); });
it("should create a Thematic Break with correct border properties", () => { it("should create a Thematic Break with correct border properties", () => {
const newJson = Utility.jsonify(thematicBreak); const tree = new Formatter().format(thematicBreak);
const attributes = { expect(tree).to.deep.equal({
color: "auto", "w:pBdr": [
space: 1, {
val: "single", "w:bottom": {
sz: 6, _attr: {
}; "w:color": "auto",
assert.equal(JSON.stringify(newJson.root[0].root[0].root), JSON.stringify(attributes)); "w:space": 1,
"w:sz": 6,
"w:val": "single",
},
},
},
],
});
}); });
}); });
}); });

37
src/file/paragraph/formatting/page-break.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { PageBreak, PageBreakBefore } from "./page-break"; import { PageBreak, PageBreakBefore } from "./page-break";
@ -13,21 +13,18 @@ describe("PageBreak", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Page Break with correct attributes", () => { it("should create a Page Break with correct attributes", () => {
const newJson = Utility.jsonify(pageBreak); const tree = new Formatter().format(pageBreak);
const attributes = { expect(tree).to.deep.equal({
type: "page", "w:r": [
}; {
assert.equal(JSON.stringify(newJson.root[1].root[0].root), JSON.stringify(attributes)); "w:br": {
}); _attr: {
"w:type": "page",
it("should create a Page Break with w:r", () => { },
const newJson = Utility.jsonify(pageBreak); },
assert.equal(newJson.rootKey, "w:r"); },
}); ],
});
it("should create a Page Break with a Break inside", () => {
const newJson = Utility.jsonify(pageBreak);
assert.equal(newJson.root[1].rootKey, "w:br");
}); });
}); });
}); });
@ -35,7 +32,9 @@ describe("PageBreak", () => {
describe("PageBreakBefore", () => { describe("PageBreakBefore", () => {
it("should create page break before", () => { it("should create page break before", () => {
const pageBreakBefore = new PageBreakBefore(); const pageBreakBefore = new PageBreakBefore();
const newJson = Utility.jsonify(pageBreakBefore); const tree = new Formatter().format(pageBreakBefore);
assert.equal(newJson.rootKey, "w:pageBreakBefore"); expect(tree).to.deep.equal({
"w:pageBreakBefore": {},
});
}); });
}); });

24
src/file/paragraph/formatting/style.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { Style } from "./style"; import { Style } from "./style";
@ -10,14 +10,26 @@ describe("ParagraphStyle", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a style with given value", () => { it("should create a style with given value", () => {
style = new Style("test"); style = new Style("test");
const newJson = Utility.jsonify(style); const tree = new Formatter().format(style);
assert.equal(newJson.root[0].root.val, "test"); expect(tree).to.deep.equal({
"w:pStyle": {
_attr: {
"w:val": "test",
},
},
});
}); });
it("should create a style with blank val", () => { it("should create a style with blank val", () => {
style = new Style(""); style = new Style("");
const newJson = Utility.jsonify(style); const tree = new Formatter().format(style);
assert.equal(newJson.root[0].root.val, ""); expect(tree).to.deep.equal({
"w:pStyle": {
_attr: {
"w:val": "",
},
},
});
}); });
}); });
}); });

37
src/file/paragraph/formatting/unordered-list.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { NumberProperties } from "./unordered-list"; import { NumberProperties } from "./unordered-list";
@ -13,20 +13,25 @@ describe("NumberProperties", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Number Properties with correct root key", () => { it("should create a Number Properties with correct root key", () => {
const newJson = Utility.jsonify(numberProperties); const tree = new Formatter().format(numberProperties);
assert.equal(newJson.rootKey, "w:numPr"); expect(tree).to.deep.equal({
}); "w:numPr": [
{
it("should create a Page Break with a Indent Level inside", () => { "w:ilvl": {
const newJson = Utility.jsonify(numberProperties); _attr: {
assert.equal(newJson.root[0].rootKey, "w:ilvl"); "w:val": 10,
assert.equal(newJson.root[0].root[0].root.val, 10); },
}); },
},
it("should create a Page Break with a Number Id inside", () => { {
const newJson = Utility.jsonify(numberProperties); "w:numId": {
assert.equal(newJson.root[1].rootKey, "w:numId"); _attr: {
assert.equal(newJson.root[1].root[0].root.val, 5); "w:val": 5,
},
},
},
],
});
}); });
}); });
}); });

61
src/file/paragraph/links/hyperlink.spec.ts
View File

@ -1,7 +1,6 @@
import { assert, expect } from "chai"; import { expect } from "chai";
import { Formatter } from "export/formatter"; import { Formatter } from "export/formatter";
import { Utility } from "tests/utility";
import { Hyperlink } from "./"; import { Hyperlink } from "./";
@ -14,28 +13,23 @@ describe("Hyperlink", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a hyperlink with correct root key", () => { it("should create a hyperlink with correct root key", () => {
const newJson = Utility.jsonify(hyperlink);
assert.equal(newJson.rootKey, "w:hyperlink");
});
it("should create a hyperlink with right attributes", () => {
const newJson = Utility.jsonify(hyperlink);
const attributes = {
history: 1,
id: "rId1",
};
assert.equal(JSON.stringify(newJson.root[0].root), JSON.stringify(attributes));
});
it("should create a hyperlink with a run component", () => {
const tree = new Formatter().format(hyperlink); const tree = new Formatter().format(hyperlink);
const runJson = { expect(tree).to.deep.equal({
"w:r": [ "w:hyperlink": [
{ "w:rPr": [{ "w:rStyle": { _attr: { "w:val": "Hyperlink" } } }] }, {
{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "https://example.com"] }, _attr: {
"w:history": 1,
"r:id": "rId1",
},
},
{
"w:r": [
{ "w:rPr": [{ "w:rStyle": { _attr: { "w:val": "Hyperlink" } } }] },
{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "https://example.com"] },
],
},
], ],
}; });
expect(tree["w:hyperlink"][1]).to.deep.equal(runJson);
}); });
describe("with optional anchor parameter", () => { describe("with optional anchor parameter", () => {
@ -44,12 +38,23 @@ describe("Hyperlink", () => {
}); });
it("should create an internal link with anchor tag", () => { it("should create an internal link with anchor tag", () => {
const newJson = Utility.jsonify(hyperlink); const tree = new Formatter().format(hyperlink);
const attributes = { expect(tree).to.deep.equal({
history: 1, "w:hyperlink": [
anchor: "anchor", {
}; _attr: {
assert.equal(JSON.stringify(newJson.root[0].root), JSON.stringify(attributes)); "w:history": 1,
"w:anchor": "anchor",
},
},
{
"w:r": [
{ "w:rPr": [{ "w:rStyle": { _attr: { "w:val": "Hyperlink" } } }] },
{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "Anchor Text"] },
],
},
],
});
}); });
}); });
}); });

14
src/file/paragraph/links/outline-level.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { OutlineLevel } from "./outline-level"; import { OutlineLevel } from "./outline-level";
@ -10,8 +10,14 @@ describe("ParagraphOutlineLevel", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create an outlineLevel with given value", () => { it("should create an outlineLevel with given value", () => {
outlineLevel = new OutlineLevel(0); outlineLevel = new OutlineLevel(0);
const newJson = Utility.jsonify(outlineLevel); const tree = new Formatter().format(outlineLevel);
assert.equal(newJson.root[0].root.val, "0"); expect(tree).to.deep.equal({
"w:outlineLvl": {
_attr: {
"w:val": 0,
},
},
});
}); });
}); });
}); });

10
src/file/paragraph/run/break.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { Break } from "./break"; import { Break } from "./break";
@ -13,8 +13,10 @@ describe("Break", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Break with correct root key", () => { it("should create a Break with correct root key", () => {
const newJson = Utility.jsonify(currentBreak); const tree = new Formatter().format(currentBreak);
assert.equal(newJson.rootKey, "w:br"); expect(tree).to.deep.equal({
"w:br": {},
});
}); });
}); });
}); });

79
src/file/paragraph/run/run.spec.ts
View File

@ -1,7 +1,6 @@
import { assert, expect } from "chai"; import { expect } from "chai";
import { Formatter } from "export/formatter"; import { Formatter } from "export/formatter";
import { Utility } from "tests/utility";
import { Run } from "./"; import { Run } from "./";
import { UnderlineType } from "./underline"; import { UnderlineType } from "./underline";
@ -12,9 +11,23 @@ describe("Run", () => {
const run = new Run({ const run = new Run({
bold: true, bold: true,
}); });
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[0].root[0].rootKey, "w:b"); expect(tree).to.deep.equal({
assert.equal(newJson.root[0].root[1].rootKey, "w:bCs"); "w:r": [
{
"w:rPr": [
{ "w:b": { _attr: { "w:val": true } } },
{
"w:bCs": {
_attr: {
"w:val": true,
},
},
},
],
},
],
});
}); });
}); });
@ -23,9 +36,23 @@ describe("Run", () => {
const run = new Run({ const run = new Run({
italics: true, italics: true,
}); });
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[0].root[0].rootKey, "w:i"); expect(tree).to.deep.equal({
assert.equal(newJson.root[0].root[1].rootKey, "w:iCs"); "w:r": [
{
"w:rPr": [
{ "w:i": { _attr: { "w:val": true } } },
{
"w:iCs": {
_attr: {
"w:val": true,
},
},
},
],
},
],
});
}); });
}); });
@ -59,8 +86,10 @@ describe("Run", () => {
const run = new Run({ const run = new Run({
smallCaps: true, smallCaps: true,
}); });
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[0].root[0].rootKey, "w:smallCaps"); expect(tree).to.deep.equal({
"w:r": [{ "w:rPr": [{ "w:smallCaps": {} }] }],
});
}); });
}); });
@ -69,8 +98,10 @@ describe("Run", () => {
const run = new Run({ const run = new Run({
allCaps: true, allCaps: true,
}); });
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[0].root[0].rootKey, "w:caps"); expect(tree).to.deep.equal({
"w:r": [{ "w:rPr": [{ "w:caps": {} }] }],
});
}); });
}); });
@ -79,8 +110,10 @@ describe("Run", () => {
const run = new Run({ const run = new Run({
strike: true, strike: true,
}); });
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[0].root[0].rootKey, "w:strike"); expect(tree).to.deep.equal({
"w:r": [{ "w:rPr": [{ "w:strike": { _attr: { "w:val": true } } }] }],
});
}); });
}); });
@ -89,8 +122,10 @@ describe("Run", () => {
const run = new Run({ const run = new Run({
doubleStrike: true, doubleStrike: true,
}); });
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[0].root[0].rootKey, "w:dstrike"); expect(tree).to.deep.equal({
"w:r": [{ "w:rPr": [{ "w:dstrike": { _attr: { "w:val": true } } }] }],
});
}); });
}); });
@ -98,8 +133,10 @@ describe("Run", () => {
it("it should add break to the run", () => { it("it should add break to the run", () => {
const run = new Run({}); const run = new Run({});
run.break(); run.break();
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[1].rootKey, "w:br"); expect(tree).to.deep.equal({
"w:r": [{ "w:br": {} }],
});
}); });
}); });
@ -107,8 +144,10 @@ describe("Run", () => {
it("it should add break to the run", () => { it("it should add break to the run", () => {
const run = new Run({}); const run = new Run({});
run.tab(); run.tab();
const newJson = Utility.jsonify(run); const tree = new Formatter().format(run);
assert.equal(newJson.root[1].rootKey, "w:tab"); expect(tree).to.deep.equal({
"w:r": [{ "w:tab": {} }],
});
}); });
}); });

24
src/file/paragraph/run/strike.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { DoubleStrike, Strike } from "./formatting"; import { DoubleStrike, Strike } from "./formatting";
@ -13,8 +13,14 @@ describe("Strike", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Strike with correct root key", () => { it("should create a Strike with correct root key", () => {
const newJson = Utility.jsonify(strike); const tree = new Formatter().format(strike);
assert.equal(newJson.rootKey, "w:strike"); expect(tree).to.deep.equal({
"w:strike": {
_attr: {
"w:val": true,
},
},
});
}); });
}); });
}); });
@ -28,8 +34,14 @@ describe("DoubleStrike", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Double Strike with correct root key", () => { it("should create a Double Strike with correct root key", () => {
const newJson = Utility.jsonify(strike); const tree = new Formatter().format(strike);
assert.equal(newJson.rootKey, "w:dstrike"); expect(tree).to.deep.equal({
"w:dstrike": {
_attr: {
"w:val": true,
},
},
});
}); });
}); });
}); });

10
src/file/paragraph/run/tab.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { Tab } from "./tab"; import { Tab } from "./tab";
@ -13,8 +13,10 @@ describe("Tab", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a Tab with correct root key", () => { it("should create a Tab with correct root key", () => {
const newJson = Utility.jsonify(tab); const tree = new Formatter().format(tab);
assert.equal(newJson.rootKey, "w:tab"); expect(tree).to.deep.equal({
"w:tab": {},
});
}); });
}); });
}); });

179
src/file/paragraph/run/underline.spec.ts
View File

@ -1,7 +1,6 @@
import { assert, expect } from "chai"; import { expect } from "chai";
import { Formatter } from "export/formatter"; import { Formatter } from "export/formatter";
import { Utility } from "tests/utility";
import * as u from "./underline"; import * as u from "./underline";
@ -9,8 +8,14 @@ describe("Underline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create a new Underline object with u:u as the rootKey", () => { it("should create a new Underline object with u:u as the rootKey", () => {
const underline = new u.Underline(); const underline = new u.Underline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.rootKey, "w:u"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "single",
},
},
});
}); });
it("should default to 'single' and no color", () => { it("should default to 'single' and no color", () => {
@ -33,16 +38,16 @@ describe("Underline", () => {
describe("DashDotDotHeavyUnderline", () => { describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should have u:u as the rootKey", () => {
const underline = new u.DashDotDotHeavyUnderline();
const newJson = Utility.jsonify(underline);
assert.equal(newJson.rootKey, "w:u");
});
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DashDotDotHeavyUnderline(); const underline = new u.DashDotDotHeavyUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dashDotDotHeavy"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dashDotDotHeavy",
},
},
});
}); });
}); });
}); });
@ -51,8 +56,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DashDotHeavyUnderline(); const underline = new u.DashDotHeavyUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dashDotHeavy"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dashDotHeavy",
},
},
});
}); });
}); });
}); });
@ -61,8 +72,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DashLongHeavyUnderline(); const underline = new u.DashLongHeavyUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dashLongHeavy"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dashLongHeavy",
},
},
});
}); });
}); });
}); });
@ -71,8 +88,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DashLongUnderline(); const underline = new u.DashLongUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dashLong"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dashLong",
},
},
});
}); });
}); });
}); });
@ -81,8 +104,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DashUnderline(); const underline = new u.DashUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dash"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dash",
},
},
});
}); });
}); });
}); });
@ -91,8 +120,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DotDashUnderline(); const underline = new u.DotDashUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dotDash"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dotDash",
},
},
});
}); });
}); });
}); });
@ -101,8 +136,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DotDotDashUnderline(); const underline = new u.DotDotDashUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dotDotDash"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dotDotDash",
},
},
});
}); });
}); });
}); });
@ -111,8 +152,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DottedHeavyUnderline(); const underline = new u.DottedHeavyUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dottedHeavy"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dottedHeavy",
},
},
});
}); });
}); });
}); });
@ -121,8 +168,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DottedUnderline(); const underline = new u.DottedUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "dotted"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "dotted",
},
},
});
}); });
}); });
}); });
@ -131,8 +184,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.DoubleUnderline(); const underline = new u.DoubleUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "double"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "double",
},
},
});
}); });
}); });
}); });
@ -141,8 +200,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.SingleUnderline(); const underline = new u.SingleUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "single"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "single",
},
},
});
}); });
}); });
}); });
@ -151,8 +216,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.ThickUnderline(); const underline = new u.ThickUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "thick"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "thick",
},
},
});
}); });
}); });
}); });
@ -161,8 +232,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.WaveUnderline(); const underline = new u.WaveUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "wave"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "wave",
},
},
});
}); });
}); });
}); });
@ -171,8 +248,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.WavyDoubleUnderline(); const underline = new u.WavyDoubleUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "wavyDouble"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "wavyDouble",
},
},
});
}); });
}); });
}); });
@ -181,8 +264,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.WavyHeavyUnderline(); const underline = new u.WavyHeavyUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "wavyHeavy"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "wavyHeavy",
},
},
});
}); });
}); });
}); });
@ -191,8 +280,14 @@ describe("DashDotDotHeavyUnderline", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should put value in attribute", () => { it("should put value in attribute", () => {
const underline = new u.WordsUnderline(); const underline = new u.WordsUnderline();
const newJson = Utility.jsonify(underline); const tree = new Formatter().format(underline);
assert.equal(newJson.root[0].root.val, "words"); expect(tree).to.deep.equal({
"w:u": {
_attr: {
"w:val": "words",
},
},
});
}); });
}); });
}); });

8
src/file/xml-components/xml-component.spec.ts
View File

@ -1,6 +1,6 @@
import { expect } from "chai"; import { expect } from "chai";
import { Utility } from "tests/utility"; import { Formatter } from "export/formatter";
import { EMPTY_OBJECT, XmlComponent } from "./"; import { EMPTY_OBJECT, XmlComponent } from "./";
class TestComponent extends XmlComponent {} class TestComponent extends XmlComponent {}
@ -14,8 +14,10 @@ describe("XmlComponent", () => {
describe("#constructor()", () => { describe("#constructor()", () => {
it("should create an Xml Component which has the correct rootKey", () => { it("should create an Xml Component which has the correct rootKey", () => {
const newJson = Utility.jsonify(xmlComponent); const tree = new Formatter().format(xmlComponent);
expect(newJson.rootKey).to.equal("w:test"); expect(tree).to.deep.equal({
"w:test": {},
});
}); });
}); });