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

clean up settings; BREAKING: TableOfContents requires Document features.updateFields = true setting

Browse Source
This commit is contained in:
Tom Hunkapiller
2021-05-26 08:36:05 +03:00
parent da61a30eb8
commit 60b7ce4785
20 changed files with 389 additions and 350 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
demo/28-table-of-contents.ts
View File

@ -9,6 +9,9 @@ import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } fr
// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
// making the entries be hyperlinks for the paragraph
const doc = new File({
features: {
updateFields: true,
},
styles: {
paragraphStyles: [
{

6
demo/60-track-revisions.ts
View File

@ -20,10 +20,12 @@ import {
- https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.insertedrun
- https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.deletedrun
The method `addTrackRevisions()` adds an element `<w:trackRevisions />` to the `settings.xml` file. This specifies that the application shall track *new* revisions made to the existing document.
The setting `features: { trackRevisions: true }` adds an element `<w:trackRevisions />` to the `settings.xml` file.
This specifies that the application shall track *new* revisions made to the existing document.
See also https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.trackrevisions
Note that this setting enables to track *new changes* after teh file is generated, so this example will still show inserted and deleted text runs when you remove it.
Note that this setting enables to track *new changes* after teh file is generated, so this example will still
show inserted and deleted text runs when you remove it.
*/
const paragraph = new Paragraph({

23
docs/usage/table-of-contents.md
View File

@ -12,14 +12,29 @@ The complete documentation can be found [here](https://www.ecma-international.or
All you need to do is create a `TableOfContents` object and assign it to the document.
**Note**: updateFields feature must be enabled for TableOfContents to update correctly.
```ts
const toc = new TableOfContents("Summary", {
const doc = new Document({
features: {
updateFields: true,
},
sections: [
{
children: [
new TableOfContents("Summary", {
hyperlink: true,
headingStyleRange: "1-5",
stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
}),
new Paragraph({
text: "Header #1",
heading: HeadingLevel.HEADING_1,
pageBreakBefore: true,
}),
]
}
]
});
doc.addTableOfContents(toc);
```
## Table of Contents Options

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

@ -70,7 +70,6 @@ export class Compiler {
}
private xmlifyFile(file: File, prettify?: boolean): IXmlifyedFileMapping {
file.verifyUpdateFields();
const documentRelationshipCount = file.Document.Relationships.RelationshipCount + 1;
const documentXmlData = xml(
@ -78,7 +77,13 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
},
},
);
const documentMediaDatas = this.imageReplacer.getMediaData(documentXmlData, file.Media);
@ -98,7 +103,12 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
);
})(),
path: "word/_rels/document.xml.rels",
@ -118,7 +128,13 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
},
},
),
path: "word/styles.xml",
},
@ -129,6 +145,7 @@ export class Compiler {
file,
}),
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
@ -143,7 +160,13 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
},
},
),
path: "word/numbering.xml",
},
@ -153,7 +176,12 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
),
path: "_rels/.rels",
},
@ -163,7 +191,12 @@ export class Compiler {
viewWrapper: headerWrapper,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
);
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
@ -181,7 +214,12 @@ export class Compiler {
viewWrapper: headerWrapper,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
),
path: `word/_rels/header${index + 1}.xml.rels`,
};
@ -192,7 +230,12 @@ export class Compiler {
viewWrapper: footerWrapper,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
);
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
@ -210,7 +253,12 @@ export class Compiler {
viewWrapper: footerWrapper,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
),
path: `word/_rels/footer${index + 1}.xml.rels`,
};
@ -221,7 +269,12 @@ export class Compiler {
viewWrapper: headerWrapper,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
);
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
// TODO: 0 needs to be changed when headers get relationships of their own
@ -238,7 +291,12 @@ export class Compiler {
viewWrapper: footerWrapper,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
);
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
// TODO: 0 needs to be changed when headers get relationships of their own
@ -255,7 +313,12 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
),
path: "[Content_Types].xml",
},
@ -265,7 +328,13 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
},
},
),
path: "docProps/custom.xml",
},
@ -275,7 +344,13 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
},
},
),
path: "docProps/app.xml",
},
@ -285,7 +360,12 @@ export class Compiler {
viewWrapper: file.FootNotes,
file: file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
),
path: "word/footnotes.xml",
},
@ -295,7 +375,12 @@ export class Compiler {
viewWrapper: file.FootNotes,
file: file,
}),
prettify,
{
indent: prettify,
declaration: {
encoding: "UTF-8",
},
},
),
path: "word/_rels/footnotes.xml.rels",
},
@ -305,7 +390,13 @@ export class Compiler {
viewWrapper: file.Document,
file,
}),
prettify,
{
indent: prettify,
declaration: {
standalone: "yes",
encoding: "UTF-8",
},
},
),
path: "word/settings.xml",
},

1
src/file/core-properties/properties.ts
View File

@ -29,6 +29,7 @@ export interface IPropertiesOptions {
readonly background?: IDocumentBackgroundOptions;
readonly features?: {
readonly trackRevisions?: boolean;
readonly updateFields?: boolean;
};
readonly compatabilityModeVersion?: number;
readonly customProperties?: ICustomPropertyOptions[];

14
src/file/file.spec.ts
View File

@ -165,20 +165,6 @@ describe("File", () => {
});
});
describe("#addTrackRevisionsFeature", () => {
it("should call the underlying document's add", () => {
const file = new File({
features: {
trackRevisions: true,
},
sections: [],
});
// tslint:disable-next-line: no-unused-expression no-string-literal
expect(file.Settings["trackRevisions"]).to.exist;
});
});
describe("#createFootnote", () => {
it("should create footnote", () => {
const wrapper = new File({

14
src/file/file.ts
View File

@ -78,6 +78,8 @@ export class File {
this.settings = new Settings({
compatabilityModeVersion: options.compatabilityModeVersion,
evenAndOddHeaders: options.evenAndOddHeaderAndFooters ? true : false,
trackRevisions: options.features?.trackRevisions,
updateFields: options.features?.updateFields,
});
this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media();
@ -132,18 +134,6 @@ export class File {
this.footnotesWrapper.View.createFootNote(parseFloat(key), options.footnotes[key].children);
}
}
if (options.features) {
if (options.features.trackRevisions) {
this.settings.addTrackRevisions();
}
}
}
public verifyUpdateFields(): void {
if (this.documentWrapper.View.getTablesOfContents().length) {
this.settings.addUpdateFields();
}
}
private addSection({ headers = {}, footers = {}, children, properties }: ISectionOptions): void {

12
src/file/settings/compatibility-setting/compatibility-setting.ts
View File

@ -1,5 +1,15 @@
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
// Currently, this is hard-coded for Microsoft word compatSettings.
// Theoretically, we could add compatSettings for other programs, but
// currently there isn't a need.
// <xsd:complexType name="CT_CompatSetting">
// <xsd:attribute name="name" type="s:ST_String"/>
// <xsd:attribute name="uri" type="s:ST_String"/>
// <xsd:attribute name="val" type="s:ST_String"/>
// </xsd:complexType>
export class CompatibilitySettingAttributes extends XmlAttributeComponent<{
readonly version: number;
readonly name: string;
@ -12,6 +22,8 @@ export class CompatibilitySettingAttributes extends XmlAttributeComponent<{
};
}
// https://docs.microsoft.com/en-us/openspecs/office_standards/ms-docx/90138c4d-eb18-4edc-aa6c-dfb799cb1d0d
export class CompatibilitySetting extends XmlComponent {
constructor(version: number) {
super("w:compatSetting");

83
src/file/settings/compatibility.ts
View File

@ -1,11 +1,77 @@
import { XmlComponent } from "file/xml-components";
import { OnOffElement, XmlComponent } from "file/xml-components";
import { CompatibilitySetting } from "./compatibility-setting/compatibility-setting";
class DoNotExpandShiftReturn extends XmlComponent {
constructor() {
super("w:doNotExpandShiftReturn");
}
}
// <xsd:complexType name="CT_Compat">
// <xsd:sequence>
// <xsd:element name="useSingleBorderforContiguousCells" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="wpJustification" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noTabHangInd" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noLeading" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="spaceForUL" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noColumnBalance" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="balanceSingleByteDoubleByteWidth" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noExtraLineSpacing" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotLeaveBackslashAlone" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="ulTrailSpace" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotExpandShiftReturn" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="spacingInWholePoints" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="lineWrapLikeWord6" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="printBodyTextBeforeHeader" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="printColBlack" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="wpSpaceWidth" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="showBreaksInFrames" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="subFontBySize" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="suppressBottomSpacing" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="suppressTopSpacing" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="suppressSpacingAtTopOfPage" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="suppressTopSpacingWP" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="suppressSpBfAfterPgBrk" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="swapBordersFacingPages" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="convMailMergeEsc" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="truncateFontHeightsLikeWP6" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="mwSmallCaps" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="usePrinterMetrics" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotSuppressParagraphBorders" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="wrapTrailSpaces" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="footnoteLayoutLikeWW8" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="shapeLayoutLikeWW8" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="alignTablesRowByRow" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="forgetLastTabAlignment" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="adjustLineHeightInTable" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="autoSpaceLikeWord95" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noSpaceRaiseLower" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotUseHTMLParagraphAutoSpacing" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="layoutRawTableWidth" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="layoutTableRowsApart" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useWord97LineBreakRules" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotBreakWrappedTables" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotSnapToGridInCell" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="selectFldWithFirstOrLastChar" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="applyBreakingRules" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotWrapTextWithPunct" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotUseEastAsianBreakRules" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useWord2002TableStyleRules" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="growAutofit" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useFELayout" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useNormalStyleForList" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotUseIndentAsNumberingTabStop" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useAltKinsokuLineBreakRules" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="allowSpaceOfSameStyleInTable" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotSuppressIndentation" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotAutofitConstrainedTables" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="autofitToFirstFixedWidthCell" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="underlineTabInNumList" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="displayHangulFixedWidth" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="splitPgBreakAndParaMark" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotVertAlignCellWithSp" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotBreakConstrainedForcedTable" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotVertAlignInTxbx" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useAnsiKerningPairs" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="cachedColBalance" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="compatSetting" type="CT_CompatSetting" minOccurs="0" maxOccurs="unbounded"
// />
// </xsd:sequence>
// </xsd:complexType>
export interface ICompatibilityOptions {
readonly doNotExpandShiftReturn?: boolean;
@ -16,8 +82,9 @@ export class Compatibility extends XmlComponent {
constructor(options: ICompatibilityOptions) {
super("w:compat");
if (options.doNotExpandShiftReturn) {
this.root.push(new DoNotExpandShiftReturn());
// Don't justify lines ending in soft line break setting
if (options.doNotExpandShiftReturn !== undefined) {
this.root.push(new OnOffElement("w:doNotExpandShiftReturn", options.doNotExpandShiftReturn));
}
if (options.version) {

17
src/file/settings/display-background-shape.spec.ts
View File

@ -1,17 +0,0 @@
import { expect } from "chai";
import { Formatter } from "export/formatter";
import { DisplayBackgroundShape } from "./display-background-shape";
describe("DisplayBackgroundShape", () => {
describe("#constructor()", () => {
it("should create", () => {
const displayBackgroundShape = new DisplayBackgroundShape();
const tree = new Formatter().format(displayBackgroundShape);
expect(tree).to.deep.equal({
"w:displayBackgroundShape": {},
});
});
});
});

9
src/file/settings/display-background-shape.ts
View File

@ -1,9 +0,0 @@
// http://officeopenxml.com/WPdocument.php
// http://www.datypic.com/sc/ooxml/e-w_background-1.html
import { XmlComponent } from "file/xml-components";
export class DisplayBackgroundShape extends XmlComponent {
constructor() {
super("w:displayBackgroundShape");
}
}

9
src/file/settings/even-odd-headers.ts
View File

@ -1,9 +0,0 @@
// http://officeopenxml.com/WPSectionFooterReference.php
// https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_evenAndOddHeaders_topic_ID0ET1WU.html
import { XmlComponent } from "file/xml-components";
export class EvenAndOddHeadersAndFooters extends XmlComponent {
constructor() {
super("w:evenAndOddHeaders");
}
}

1
src/file/settings/index.ts
View File

@ -1,2 +1 @@
export * from "./settings";
export * from "./update-fields";

172
src/file/settings/settings.spec.ts
View File

@ -7,83 +7,37 @@ import { Settings } from "./settings";
describe("Settings", () => {
describe("#constructor", () => {
it("should create a empty Settings with correct rootKey", () => {
const settings = new Settings({
evenAndOddHeaders: false,
});
const settings = new Settings({});
const tree = new Formatter().format(settings);
let keys = Object.keys(tree);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:settings");
keys = Object.keys(tree["w:settings"]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(3);
expect(Object.keys(tree)).has.length(1);
expect(tree["w:settings"]).to.be.an("array");
});
});
describe("#addUpdateFields", () => {
const assertSettingsWithUpdateFields = (settings: Settings) => {
const tree = new Formatter().format(settings);
let keys = Object.keys(tree);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:settings");
const rootArray = tree["w:settings"];
expect(rootArray).is.an.instanceof(Array);
expect(rootArray).has.length(4);
keys = Object.keys(rootArray[0]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("_attr");
keys = Object.keys(rootArray[3]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:updateFields");
const updateFields = rootArray[3]["w:updateFields"];
keys = Object.keys(updateFields);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("_attr");
const updateFieldsAttr = updateFields._attr;
expect(updateFieldsAttr["w:val"]).to.be.equal(true);
};
it("should add a UpdateFields with value true", () => {
it("should add updateFields setting", () => {
const settings = new Settings({
evenAndOddHeaders: false,
});
settings.addUpdateFields();
assertSettingsWithUpdateFields(settings);
});
it("should add a UpdateFields with value true only once", () => {
const settings = new Settings({
evenAndOddHeaders: false,
});
settings.addUpdateFields();
assertSettingsWithUpdateFields(settings);
settings.addUpdateFields();
assertSettingsWithUpdateFields(settings);
});
});
describe("#addCompatibility", () => {
it("should add an empty Compatibility by default", () => {
const settings = new Settings({
evenAndOddHeaders: false,
updateFields: true,
});
const tree = new Formatter().format(settings);
let keys: string[] = Object.keys(tree);
expect(keys[0]).to.be.equal("w:settings");
const rootArray = tree["w:settings"];
expect(rootArray).is.an.instanceof(Array);
expect(rootArray).has.length(3);
keys = Object.keys(rootArray[0]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("_attr");
keys = Object.keys(rootArray[1]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:compat");
expect(rootArray[1]["w:compat"][0]).to.deep.equal({
expect(Object.keys(tree)).has.length(1);
expect(tree["w:settings"]).to.be.an("array");
expect(tree["w:settings"]).to.deep.include({
"w:updateFields": {},
});
});
it("should indicate modern word compatibility by default", () => {
const settings = new Settings({});
const tree = new Formatter().format(settings);
expect(Object.keys(tree)).has.length(1);
expect(tree["w:settings"]).to.be.an("array");
const compat = tree["w:settings"][2];
expect(compat).to.be.an("object").with.keys("w:compat");
expect(compat["w:compat"]).to.deep.include({
"w:compatSetting": {
_attr: {
"w:val": 15,
@ -93,81 +47,19 @@ describe("Settings", () => {
},
});
});
});
describe("#addTrackRevisions", () => {
it("should add an empty Track Revisions", () => {
it("should add trackRevisions setting", () => {
const settings = new Settings({
evenAndOddHeaders: false,
trackRevisions: true,
});
settings.addTrackRevisions();
const tree = new Formatter().format(settings);
let keys: string[] = Object.keys(tree);
expect(keys[0]).to.be.equal("w:settings");
const rootArray = tree["w:settings"];
expect(rootArray).is.an.instanceof(Array);
expect(rootArray).has.length(4);
keys = Object.keys(rootArray[0]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("_attr");
keys = Object.keys(rootArray[3]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:trackRevisions");
});
});
describe("#addTrackRevisionsTwice", () => {
it("should add an empty Track Revisions if called twice", () => {
const settings = new Settings({
evenAndOddHeaders: false,
});
settings.addTrackRevisions();
settings.addTrackRevisions();
expect(Object.keys(tree)).has.length(1);
expect(tree["w:settings"]).to.be.an("array");
const tree = new Formatter().format(settings);
let keys: string[] = Object.keys(tree);
expect(keys[0]).to.be.equal("w:settings");
const rootArray = tree["w:settings"];
expect(rootArray).is.an.instanceof(Array);
expect(rootArray).has.length(4);
keys = Object.keys(rootArray[0]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("_attr");
keys = Object.keys(rootArray[3]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:trackRevisions");
expect(tree["w:settings"]).to.deep.include({
"w:trackRevisions": {},
});
});
describe("#addTrackRevisionsTwice", () => {
it("should add an empty Track Revisions if called twice", () => {
const settings = new Settings({
evenAndOddHeaders: true,
});
settings.addTrackRevisions();
settings.addTrackRevisions();
const tree = new Formatter().format(settings);
let keys: string[] = Object.keys(tree);
expect(keys[0]).to.be.equal("w:settings");
const rootArray = tree["w:settings"];
expect(rootArray).is.an.instanceof(Array);
expect(rootArray).has.length(5);
keys = Object.keys(rootArray[0]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("_attr");
keys = Object.keys(rootArray[4]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:trackRevisions");
keys = Object.keys(rootArray[2]);
expect(keys).is.an.instanceof(Array);
expect(keys).has.length(1);
expect(keys[0]).to.be.equal("w:evenAndOddHeaders");
});
});
});

157
src/file/settings/settings.ts
View File

@ -1,10 +1,6 @@
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
import { OnOffElement, XmlAttributeComponent, XmlComponent } from "file/xml-components";
import { Compatibility } from "./compatibility";
import { DisplayBackgroundShape } from "./display-background-shape";
import { EvenAndOddHeadersAndFooters } from "./even-odd-headers";
import { TrackRevisions } from "./track-revisions";
import { UpdateFields } from "./update-fields";
export class SettingsAttributes extends XmlAttributeComponent<{
readonly wpc?: string;
@ -46,14 +42,118 @@ export class SettingsAttributes extends XmlAttributeComponent<{
};
}
// <xsd:complexType name="CT_Settings">
// <xsd:sequence>
// <xsd:element name="writeProtection" type="CT_WriteProtection" minOccurs="0"/>
// <xsd:element name="view" type="CT_View" minOccurs="0"/>
// <xsd:element name="zoom" type="CT_Zoom" minOccurs="0"/>
// <xsd:element name="removePersonalInformation" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="removeDateAndTime" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotDisplayPageBoundaries" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="displayBackgroundShape" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="printPostScriptOverText" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="printFractionalCharacterWidth" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="printFormsData" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="embedTrueTypeFonts" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="embedSystemFonts" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="saveSubsetFonts" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="saveFormsData" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="mirrorMargins" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="alignBordersAndEdges" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="bordersDoNotSurroundHeader" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="bordersDoNotSurroundFooter" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="gutterAtTop" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="hideSpellingErrors" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="hideGrammaticalErrors" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="activeWritingStyle" type="CT_WritingStyle" minOccurs="0"
// maxOccurs="unbounded"/>
// <xsd:element name="proofState" type="CT_Proof" minOccurs="0"/>
// <xsd:element name="formsDesign" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="attachedTemplate" type="CT_Rel" minOccurs="0"/>
// <xsd:element name="linkStyles" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="stylePaneFormatFilter" type="CT_StylePaneFilter" minOccurs="0"/>
// <xsd:element name="stylePaneSortMethod" type="CT_StyleSort" minOccurs="0"/>
// <xsd:element name="documentType" type="CT_DocType" minOccurs="0"/>
// <xsd:element name="mailMerge" type="CT_MailMerge" minOccurs="0"/>
// <xsd:element name="revisionView" type="CT_TrackChangesView" minOccurs="0"/>
// <xsd:element name="trackRevisions" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotTrackMoves" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotTrackFormatting" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="documentProtection" type="CT_DocProtect" minOccurs="0"/>
// <xsd:element name="autoFormatOverride" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="styleLockTheme" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="styleLockQFSet" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="defaultTabStop" type="CT_TwipsMeasure" minOccurs="0"/>
// <xsd:element name="autoHyphenation" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="consecutiveHyphenLimit" type="CT_DecimalNumber" minOccurs="0"/>
// <xsd:element name="hyphenationZone" type="CT_TwipsMeasure" minOccurs="0"/>
// <xsd:element name="doNotHyphenateCaps" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="showEnvelope" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="summaryLength" type="CT_DecimalNumberOrPrecent" minOccurs="0"/>
// <xsd:element name="clickAndTypeStyle" type="CT_String" minOccurs="0"/>
// <xsd:element name="defaultTableStyle" type="CT_String" minOccurs="0"/>
// <xsd:element name="evenAndOddHeaders" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="bookFoldRevPrinting" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="bookFoldPrinting" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="bookFoldPrintingSheets" type="CT_DecimalNumber" minOccurs="0"/>
// <xsd:element name="drawingGridHorizontalSpacing" type="CT_TwipsMeasure" minOccurs="0"/>
// <xsd:element name="drawingGridVerticalSpacing" type="CT_TwipsMeasure" minOccurs="0"/>
// <xsd:element name="displayHorizontalDrawingGridEvery" type="CT_DecimalNumber" minOccurs="0"/>
// <xsd:element name="displayVerticalDrawingGridEvery" type="CT_DecimalNumber" minOccurs="0"/>
// <xsd:element name="doNotUseMarginsForDrawingGridOrigin" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="drawingGridHorizontalOrigin" type="CT_TwipsMeasure" minOccurs="0"/>
// <xsd:element name="drawingGridVerticalOrigin" type="CT_TwipsMeasure" minOccurs="0"/>
// <xsd:element name="doNotShadeFormData" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noPunctuationKerning" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="characterSpacingControl" type="CT_CharacterSpacing" minOccurs="0"/>
// <xsd:element name="printTwoOnOne" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="strictFirstAndLastChars" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="noLineBreaksAfter" type="CT_Kinsoku" minOccurs="0"/>
// <xsd:element name="noLineBreaksBefore" type="CT_Kinsoku" minOccurs="0"/>
// <xsd:element name="savePreviewPicture" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotValidateAgainstSchema" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="saveInvalidXml" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="ignoreMixedContent" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="alwaysShowPlaceholderText" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotDemarcateInvalidXml" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="saveXmlDataOnly" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="useXSLTWhenSaving" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="saveThroughXslt" type="CT_SaveThroughXslt" minOccurs="0"/>
// <xsd:element name="showXMLTags" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="alwaysMergeEmptyNamespace" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="updateFields" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="hdrShapeDefaults" type="CT_ShapeDefaults" minOccurs="0"/>
// <xsd:element name="footnotePr" type="CT_FtnDocProps" minOccurs="0"/>
// <xsd:element name="endnotePr" type="CT_EdnDocProps" minOccurs="0"/>
// <xsd:element name="compat" type="CT_Compat" minOccurs="0"/>
// <xsd:element name="docVars" type="CT_DocVars" minOccurs="0"/>
// <xsd:element name="rsids" type="CT_DocRsids" minOccurs="0"/>
// <xsd:element ref="m:mathPr" minOccurs="0" maxOccurs="1"/>
// <xsd:element name="attachedSchema" type="CT_String" minOccurs="0" maxOccurs="unbounded"/>
// <xsd:element name="themeFontLang" type="CT_Language" minOccurs="0" maxOccurs="1"/>
// <xsd:element name="clrSchemeMapping" type="CT_ColorSchemeMapping" minOccurs="0"/>
// <xsd:element name="doNotIncludeSubdocsInStats" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="doNotAutoCompressPictures" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="forceUpgrade" type="CT_Empty" minOccurs="0" maxOccurs="1"/>
// <xsd:element name="captions" type="CT_Captions" minOccurs="0" maxOccurs="1"/>
// <xsd:element name="readModeInkLockDown" type="CT_ReadingModeInkLockDown" minOccurs="0"/>
// <xsd:element name="smartTagType" type="CT_SmartTagType" minOccurs="0" maxOccurs="unbounded"/>
// <xsd:element ref="sl:schemaLibrary" minOccurs="0" maxOccurs="1"/>
// <xsd:element name="shapeDefaults" type="CT_ShapeDefaults" minOccurs="0"/>
// <xsd:element name="doNotEmbedSmartTags" type="CT_OnOff" minOccurs="0"/>
// <xsd:element name="decimalSymbol" type="CT_String" minOccurs="0" maxOccurs="1"/>
// <xsd:element name="listSeparator" type="CT_String" minOccurs="0" maxOccurs="1"/>
// </xsd:sequence>
// </xsd:complexType>
export interface ISettingsOptions {
readonly compatabilityModeVersion?: number;
readonly evenAndOddHeaders: boolean;
readonly evenAndOddHeaders?: boolean;
readonly trackRevisions?: boolean;
readonly updateFields?: boolean;
}
export class Settings extends XmlComponent {
private readonly trackRevisions: TrackRevisions;
constructor(options: ISettingsOptions) {
super("w:settings");
this.root.push(
@ -78,32 +178,29 @@ export class Settings extends XmlComponent {
}),
);
// http://officeopenxml.com/WPdocument.php
// https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_displayBackgroundSha_topic_ID0ET4SX.html
this.root.push(new OnOffElement("w:displayBackgroundShape", true));
// https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_trackRevisions_topic_ID0EKXKY.html
if (options.trackRevisions !== undefined) {
this.root.push(new OnOffElement("w:trackRevisions", options.trackRevisions));
}
// http://officeopenxml.com/WPSectionFooterReference.php
// https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_evenAndOddHeaders_topic_ID0ET1WU.html
if (options.evenAndOddHeaders !== undefined) {
this.root.push(new OnOffElement("w:evenAndOddHeaders", options.evenAndOddHeaders));
}
if (options.updateFields !== undefined) {
this.root.push(new OnOffElement("w:updateFields", options.updateFields));
}
this.root.push(
new Compatibility({
version: options.compatabilityModeVersion || 15,
}),
);
if (options.evenAndOddHeaders) {
this.root.push(new EvenAndOddHeadersAndFooters());
}
this.trackRevisions = new TrackRevisions();
this.root.push(new DisplayBackgroundShape());
}
public addUpdateFields(): void {
if (!this.root.find((child) => child instanceof UpdateFields)) {
this.addChildElement(new UpdateFields());
}
}
public addTrackRevisions(): TrackRevisions {
if (!this.root.find((child) => child instanceof TrackRevisions)) {
this.addChildElement(this.trackRevisions);
}
return this.trackRevisions;
}
}

16
src/file/settings/track-revisions.spec.ts
View File

@ -1,16 +0,0 @@
import { expect } from "chai";
import { Formatter } from "export/formatter";
import { TrackRevisions } from "file/settings/track-revisions";
import { EMPTY_OBJECT } from "file/xml-components";
describe("TrackRevisions", () => {
describe("#constructor", () => {
it("creates an initially empty property object", () => {
const trackRevisions = new TrackRevisions();
const tree = new Formatter().format(trackRevisions);
expect(tree).to.deep.equal({ "w:trackRevisions": EMPTY_OBJECT });
});
});
});

7
src/file/settings/track-revisions.ts
View File

@ -1,7 +0,0 @@
import { XmlComponent } from "file/xml-components";
export class TrackRevisions extends XmlComponent {
constructor() {
super("w:trackRevisions");
}
}

39
src/file/settings/update-fields.spec.ts
View File

@ -1,39 +0,0 @@
import { expect } from "chai";
import { Formatter } from "export/formatter";
import { UpdateFields } from "./update-fields";
const UF_TRUE = {
"w:updateFields": {
_attr: {
"w:val": true,
},
},
};
const UF_FALSE = {
"w:updateFields": {
_attr: {
"w:val": false,
},
},
};
describe("Update Fields", () => {
describe("#constructor", () => {
it("should construct a Update Fields with TRUE value by default", () => {
const uf = new UpdateFields();
const tree = new Formatter().format(uf);
expect(tree).to.be.deep.equal(UF_TRUE);
});
it("should construct a Update Fields with TRUE value", () => {
const uf = new UpdateFields(true);
const tree = new Formatter().format(uf);
expect(tree).to.be.deep.equal(UF_TRUE);
});
it("should construct a Update Fields with FALSE value", () => {
const uf = new UpdateFields(false);
const tree = new Formatter().format(uf);
expect(tree).to.be.deep.equal(UF_FALSE);
});
});
});

19
src/file/settings/update-fields.ts
View File

@ -1,19 +0,0 @@
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
export class UpdateFieldsAttributes extends XmlAttributeComponent<{
readonly enabled: boolean;
}> {
protected readonly xmlKeys = {
enabled: "w:val",
};
}
export class UpdateFields extends XmlComponent {
constructor(enabled: boolean = true) {
super("w:updateFields");
this.root.push(
new UpdateFieldsAttributes({
enabled,
}),
);
}
}

2
src/file/values.ts
View File

@ -186,7 +186,7 @@ export function measurementOrPercentValue(val: number | string): number | string
if (typeof val === "number") {
return decimalNumber(val);
}
if (val.slice(-1) === '%') {
if (val.slice(-1) === "%") {
return percentageValue(val);
}
return universalMeasureValue(val);