@depup/mammoth 1.12.0-depup.54

package/test/docx/numbering-xml.tests.js

@@ -0,0 +1,183 @@
+var assert = require("assert");
+var duck = require("duck");
+
+var readNumberingXml = require("../../lib/docx/numbering-xml").readNumberingXml;
+var stylesReader = require("../../lib/docx/styles-reader");
+var XmlElement = require("../../lib/xml").Element;
+var test = require("../test")(module);
+
+
+test('w:num element inherits levels from w:abstractNum', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "42"}, [
+                new XmlElement("w:lvl", {"w:ilvl": "0"}, [
+                    new XmlElement("w:numFmt", {"w:val": "bullet"})
+                ]),
+                new XmlElement("w:lvl", {"w:ilvl": "1"}, [
+                    new XmlElement("w:numFmt", {"w:val": "decimal"})
+                ])
+            ]),
+            new XmlElement("w:num", {"w:numId": "47"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "42"})
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevel("47", "0"), duck.hasProperties({
+        isOrdered: false
+    }));
+    duck.assertThat(numbering.findLevel("47", "1"), duck.hasProperties({
+        isOrdered: true
+    }));
+});
+
+
+test('w:num element referencing non-existent w:abstractNumId is ignored', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:num", {"w:numId": "47"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "42"})
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevel("47", "0"), duck.equalTo(null));
+});
+
+test('given no other levels with index of 0 when level is missing w:ilvl then level index is 0', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "42"}, [
+                new XmlElement("w:lvl", {}, [
+                    new XmlElement("w:numFmt", {"w:val": "decimal"})
+                ])
+            ]),
+            new XmlElement("w:num", {"w:numId": "47"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "42"})
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevel("47", "0"), duck.hasProperties({
+        isOrdered: true
+    }));
+});
+
+test('given previous other level with index of 0 when level is missing w:ilvl then level is ignored', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "42"}, [
+                new XmlElement("w:lvl", {"w:ilvl": "0"}, [
+                    new XmlElement("w:numFmt", {"w:val": "bullet"})
+                ]),
+                new XmlElement("w:lvl", {}, [
+                    new XmlElement("w:numFmt", {"w:val": "decimal"})
+                ])
+            ]),
+            new XmlElement("w:num", {"w:numId": "47"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "42"})
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevel("47", "0"), duck.hasProperties({
+        isOrdered: false
+    }));
+});
+
+test('given subsequent other level with index of 0 when level is missing w:ilvl then level is ignored', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "42"}, [
+                new XmlElement("w:lvl", {}, [
+                    new XmlElement("w:numFmt", {"w:val": "decimal"})
+                ]),
+                new XmlElement("w:lvl", {"w:ilvl": "0"}, [
+                    new XmlElement("w:numFmt", {"w:val": "bullet"})
+                ])
+            ]),
+            new XmlElement("w:num", {"w:numId": "47"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "42"})
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevel("47", "0"), duck.hasProperties({
+        isOrdered: false
+    }));
+});
+
+test('when level is missing w:numFmt then level is ordered', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "42"}, [
+                new XmlElement("w:lvl", {"w:ilvl": "0"})
+            ]),
+            new XmlElement("w:num", {"w:numId": "47"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "42"})
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevel("47", "0"), duck.hasProperties({
+        isOrdered: true
+    }));
+});
+
+
+test('when w:abstractNum has w:numStyleLink then style is used to find w:num', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "100"}, [
+                new XmlElement("w:lvl", {"w:ilvl": "0"}, [
+                    new XmlElement("w:numFmt", {"w:val": "decimal"})
+                ])
+            ]),
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "101"}, [
+                new XmlElement("w:numStyleLink", {"w:val": "List1"})
+            ]),
+            new XmlElement("w:num", {"w:numId": "200"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "100"})
+            ]),
+            new XmlElement("w:num", {"w:numId": "201"}, [
+                new XmlElement("w:abstractNumId", {"w:val": "101"})
+            ])
+        ]),
+        {styles: new stylesReader.Styles({}, {}, {}, {"List1": {numId: "200"}})}
+    );
+    duck.assertThat(numbering.findLevel("201", "0"), duck.hasProperties({
+        isOrdered: true
+    }));
+});
+
+
+// See: 17.9.23 pStyle (Paragraph Style's Associated Numbering Level) in ECMA-376, 4th Edition
+test('numbering level can be found by paragraph style ID', function() {
+    var numbering = readNumberingXml(
+        new XmlElement("w:numbering", {}, [
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "42"}, [
+                new XmlElement("w:lvl", {"w:ilvl": "0"}, [
+                    new XmlElement("w:numFmt", {"w:val": "bullet"})
+                ])
+            ]),
+            new XmlElement("w:abstractNum", {"w:abstractNumId": "43"}, [
+                new XmlElement("w:lvl", {"w:ilvl": "0"}, [
+                    new XmlElement("w:pStyle", {"w:val": "List"}),
+                    new XmlElement("w:numFmt", {"w:val": "decimal"})
+                ])
+            ])
+        ]),
+        {styles: stylesReader.defaultStyles}
+    );
+    duck.assertThat(numbering.findLevelByParagraphStyleId("List"), duck.hasProperties({
+        isOrdered: true
+    }));
+    duck.assertThat(numbering.findLevelByParagraphStyleId("Paragraph"), duck.equalTo(null));
+});
+
+test('when styles is missing then error is thrown', function() {
+    assert.throws(function() {
+        readNumberingXml(new XmlElement("w:numbering", {}, []));
+    }, /styles is missing/);
+});

package/test/docx/office-xml-reader.tests.js

@@ -0,0 +1,41 @@
+var assert = require("assert");
+
+var xml = require("../../lib/xml");
+var officeXmlReader = require("../../lib/docx/office-xml-reader");
+var test = require("../test")(module);
+
+
+test("mc:AlternateContent", {
+    "when mc:Fallback is present then mc:Fallback is read": function() {
+        var xmlString =
+            '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+            '<numbering xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006">' +
+            '<mc:AlternateContent>' +
+            '<mc:Choice Requires="w14">' +
+            '<choice/>' +
+            '</mc:Choice>' +
+            '<mc:Fallback>' +
+            '<fallback/>' +
+            '</mc:Fallback>' +
+            '</mc:AlternateContent>' +
+            '</numbering>';
+        return officeXmlReader.read(xmlString).then(function(element) {
+            assert.deepEqual(element.children, [xml.element("fallback")]);
+        });
+    },
+
+    "when mc:Fallback is not present then element is ignored": function() {
+        var xmlString =
+            '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+            '<numbering xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006">' +
+            '<mc:AlternateContent>' +
+            '<mc:Choice Requires="w14">' +
+            '<choice/>' +
+            '</mc:Choice>' +
+            '</mc:AlternateContent>' +
+            '</numbering>';
+        return officeXmlReader.read(xmlString).then(function(element) {
+            assert.deepEqual(element.children, []);
+        });
+    }
+});

package/test/docx/relationships-reader.tests.js

@@ -0,0 +1,65 @@
+var assert = require("assert");
+
+var readRelationships = require("../../lib/docx/relationships-reader").readRelationships;
+var xml = require("../../lib/xml");
+var test = require("../test")(module);
+
+
+test("relationships can be found by ID", function() {
+    var relationships = readRelationships(relationshipsElement([
+        relationshipElement({
+            "Id": "rId1",
+            "Target": "http://example.com/",
+            "Type": "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
+        }),
+        relationshipElement({
+            "Id": "rId2",
+            "Target": "http://example.net/",
+            "Type": "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
+        })
+    ]));
+    assert.equal(relationships.findTargetByRelationshipId("rId1"), "http://example.com/");
+});
+
+
+test("relationships can be found by type", function() {
+    var relationships = readRelationships(relationshipsElement([
+        relationshipElement({
+            "Id": "rId2",
+            "Target": "docProps/core.xml",
+            "Type": "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties"
+        }),
+        relationshipElement({
+            "Id": "rId1",
+            "Target": "word/document.xml",
+            "Type": "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
+        }),
+        relationshipElement({
+            "Id": "rId3",
+            "Target": "word/document2.xml",
+            "Type": "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
+        })
+    ]));
+    assert.deepEqual(
+        relationships.findTargetsByType("http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"),
+        ["word/document.xml", "word/document2.xml"]
+    );
+});
+
+
+test("when there are no relationships of requested type then empty array is returned", function() {
+    var relationships = readRelationships(relationshipsElement([]));
+    assert.deepEqual(
+        relationships.findTargetsByType("http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"),
+        []
+    );
+});
+
+
+function relationshipsElement(children) {
+    return xml.element("relationships:Relationships", {}, children);
+}
+
+function relationshipElement(attributes) {
+    return xml.element("relationships:Relationship", attributes, []);
+}

package/test/docx/style-map.tests.js

@@ -0,0 +1,113 @@
+var assert = require("assert");
+
+var JSZip = require("jszip");
+
+var zipfile = require("../../lib/zipfile");
+var styleMap = require("../../lib/docx/style-map");
+var test = require("../test")(module);
+
+test('reading embedded style map on document without embedded style map returns null', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.readStyleMap(zip).then(function(contents) {
+            assert.equal(contents, null);
+        });
+    });
+});
+
+test('embedded style map can be read after being written', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.writeStyleMap(zip, "p => h1").then(function() {
+            return styleMap.readStyleMap(zip).then(function(contents) {
+                assert.equal(contents, "p => h1");
+            });
+        });
+    });
+});
+
+test('embedded style map is written to separate file', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.writeStyleMap(zip, "p => h1").then(function() {
+            return zip.read("mammoth/style-map", "utf8").then(function(contents) {
+                assert.equal(contents, "p => h1");
+            });
+        });
+    });
+});
+
+test('embedded style map is referenced in relationships', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.writeStyleMap(zip, "p => h1").then(function() {
+            return zip.read("word/_rels/document.xml.rels", "utf8").then(function(contents) {
+                assert.equal(contents, expectedRelationshipsXml);
+            });
+        });
+    });
+});
+
+test('re-embedding style map replaces original', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.writeStyleMap(zip, "p => h1").then(function() {
+            return styleMap.writeStyleMap(zip, "p => h2");
+        }).then(function() {
+            return zip.read("word/_rels/document.xml.rels", "utf8").then(function(contents) {
+                assert.equal(contents, expectedRelationshipsXml);
+            });
+        }).then(function() {
+            return styleMap.readStyleMap(zip).then(function(contents) {
+                assert.equal(contents, "p => h2");
+            });
+        });
+    });
+});
+
+test('embedded style map has override content type in [Content_Types].xml', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.writeStyleMap(zip, "p => h1").then(function() {
+            return zip.read("[Content_Types].xml", "utf8").then(function(contents) {
+                assert.equal(contents, expectedContentTypesXml);
+            });
+        });
+    });
+});
+
+test('replacing style map keeps content type', function() {
+    return normalDocx().then(function(zip) {
+        return styleMap.writeStyleMap(zip, "p => h1").then(function() {
+            return styleMap.writeStyleMap(zip, "p => h2");
+        }).then(function() {
+            return zip.read("[Content_Types].xml", "utf8").then(function(contents) {
+                assert.equal(contents, expectedContentTypesXml);
+            });
+        });
+    });
+});
+
+var expectedRelationshipsXml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+    '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">' +
+    '<Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" Target="settings.xml"/>' +
+    '<Relationship Id="rMammothStyleMap" Type="http://schemas.zwobble.org/mammoth/style-map" Target="/mammoth/style-map"/>' +
+    '</Relationships>';
+
+var expectedContentTypesXml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+    '<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">' +
+    '<Default Extension="png" ContentType="image/png"/>' +
+    '<Override PartName="/mammoth/style-map" ContentType="text/prs.mammoth.style-map"/>' +
+    '</Types>';
+
+function normalDocx() {
+    var zip = new JSZip();
+    var originalRelationshipsXml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+        '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">' +
+        '<Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" Target="settings.xml"/>' +
+        '</Relationships>';
+    var originalContentTypesXml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+        '<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">' +
+        '<Default Extension="png" ContentType="image/png"/>' +
+        '</Types>';
+    zip.file("word/_rels/document.xml.rels", originalRelationshipsXml);
+    zip.file("[Content_Types].xml", originalContentTypesXml);
+    return zip.generateAsync({type: "arraybuffer"}).then(function(buffer) {
+        return zipfile.openArrayBuffer(buffer);
+    });
+}
+

package/test/docx/styles-reader.tests.js

@@ -0,0 +1,143 @@
+var assert = require("assert");
+
+var readStylesXml = require("../../lib/docx/styles-reader").readStylesXml;
+var XmlElement = require("../../lib/xml").Element;
+var test = require("../test")(module);
+
+
+test('paragraph style is null if no style with that ID exists', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [])
+    );
+    assert.equal(styles.findParagraphStyleById("Heading1"), null);
+});
+
+test('paragraph style can be found by ID', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            paragraphStyleElement("Heading1", "Heading 1")
+        ])
+    );
+    assert.equal(styles.findParagraphStyleById("Heading1").styleId, "Heading1");
+});
+
+test('table style can be found by ID', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            tableStyleElement("TableNormal", "Normal Table")
+        ])
+    );
+    assert.equal(styles.findTableStyleById("TableNormal").styleId, "TableNormal");
+});
+
+test('character style can be found by ID', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            characterStyleElement("Heading1Char", "Heading 1 Char")
+        ])
+    );
+    assert.equal(styles.findCharacterStyleById("Heading1Char").styleId, "Heading1Char");
+});
+
+test('paragraph and character styles are distinct', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            paragraphStyleElement("Heading1", "Heading 1"),
+            characterStyleElement("Heading1Char", "Heading 1 Char")
+        ])
+    );
+    assert.equal(styles.findCharacterStyleById("Heading1"), null);
+    assert.equal(styles.findParagraphStyleById("Heading1Char"), null);
+});
+
+test('character and table styles are distinct', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            tableStyleElement("Heading1", "Heading 1")
+        ])
+    );
+    assert.equal(styles.findCharacterStyleById("Heading1"), null);
+});
+
+test('styles include names', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            paragraphStyleElement("Heading1", "Heading 1")
+        ])
+    );
+    assert.equal(styles.findParagraphStyleById("Heading1").name, "Heading 1");
+});
+
+test('style name is null if w:name element does not exist', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            styleWithoutWNameElement("paragraph", "Heading1"),
+            styleWithoutWNameElement("character", "Heading1Char")
+        ])
+    );
+    assert.equal(styles.findParagraphStyleById("Heading1").name, null);
+    assert.equal(styles.findCharacterStyleById("Heading1Char").name, null);
+});
+
+test('numbering style is null if no style with that ID exists', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [])
+    );
+    assert.equal(styles.findNumberingStyleById("List1"), null);
+});
+
+test('numbering style has null numId if style has no paragraph properties', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            new XmlElement("w:style", {"w:type": "numbering", "w:styleId": "List1"})
+        ])
+    );
+    assert.equal(styles.findNumberingStyleById("List1").numId, null);
+});
+
+test('numbering style has numId read from paragraph properties', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            new XmlElement("w:style", {"w:type": "numbering", "w:styleId": "List1"}, [
+                new XmlElement("w:pPr", {}, [
+                    new XmlElement("w:numPr", {}, [
+                        new XmlElement("w:numId", {"w:val": "42"})
+                    ])
+                ])
+            ])
+        ])
+    );
+    assert.equal(styles.findNumberingStyleById("List1").numId, "42");
+});
+
+test('when multiple style elements have same style ID then only first element is used', function() {
+    var styles = readStylesXml(
+        new XmlElement("w:styles", {}, [
+            tableStyleElement("TableNormal", "Normal Table"),
+            tableStyleElement("TableNormal", "Table Normal")
+        ])
+    );
+    assert.equal(styles.findTableStyleById("TableNormal").name, "Normal Table");
+});
+
+function paragraphStyleElement(id, name) {
+    return styleElement("paragraph", id, name);
+}
+
+function characterStyleElement(id, name) {
+    return styleElement("character", id, name);
+}
+
+function tableStyleElement(id, name) {
+    return styleElement("table", id, name);
+}
+
+function styleElement(type, id, name) {
+    return new XmlElement("w:style", {"w:type": type, "w:styleId": id}, [
+        new XmlElement("w:name", {"w:val": name}, [])
+    ]);
+}
+
+function styleWithoutWNameElement(type, id) {
+    return new XmlElement("w:style", {"w:type": type, "w:styleId": id}, []);
+}

package/test/docx/testing.js

@@ -0,0 +1,12 @@
+var createBodyReader = require("../../lib/docx/body-reader").createBodyReader;
+var defaultNumbering = require("../../lib/docx/numbering-xml").defaultNumbering;
+var Styles = require("../../lib/docx/styles-reader").Styles;
+
+function createBodyReaderForTests(options) {
+    options = Object.create(options || {});
+    options.styles = options.styles || new Styles({}, {});
+    options.numbering = options.numbering || defaultNumbering;
+    return createBodyReader(options);
+}
+
+exports.createBodyReaderForTests = createBodyReaderForTests;

package/test/docx/uris.tests.js

@@ -0,0 +1,22 @@
+var assert = require("assert");
+
+var zipfile = require("../../lib/docx/uris");
+var test = require("../test")(module);
+
+
+test("uriToZipEntryName", {
+    "when path does not have leading slash then path is resolved relative to base": function() {
+        assert.equal(
+            zipfile.uriToZipEntryName("one/two", "three/four"),
+            "one/two/three/four"
+        );
+    },
+
+    "when path has leading slash then base is ignored": function() {
+        assert.equal(
+            zipfile.uriToZipEntryName("one/two", "/three/four"),
+            "three/four"
+        );
+    }
+});
+