Merge pull request #1552 from dolanmiu/feat/word-break-asian

#1529 Add word break feature
dolanmiu · Jun 15, 2022 · a79f839 · a79f839
2 parents bdbd15e + c7b68a4
commit a79f839
Show file tree

Hide file tree

Showing 14 changed files with 133 additions and 38 deletions.
diff --git a/demo/72-word-wrap.ts b/demo/72-word-wrap.ts
@@ -0,0 +1,37 @@
+// Example on how to preserve word wrap text. Works with all languages.
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun, SpaceType } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("我今天遛狗去公园"),
+                        new TextRun({
+                            text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
+                            space: SpaceType.PRESERVE,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun(
+                            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua",
+                        ),
+                        new TextRun({
+                            text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
+                            space: SpaceType.PRESERVE,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});
diff --git a/src/export/packer/next-compiler.spec.ts b/src/export/packer/next-compiler.spec.ts
@@ -43,19 +43,27 @@ describe("Compiler", () => {
                 sections: [
                     {
                         headers: {
-                            default: new Header(),
+                            default: new Header({
+                                children: [new Paragraph("test")],
+                            }),
                         },
                         footers: {
-                            default: new Footer(),
+                            default: new Footer({
+                                children: [new Paragraph("test")],
+                            }),
                         },
                         children: [],
                     },
                     {
                         headers: {
-                            default: new Header(),
+                            default: new Header({
+                                children: [new Paragraph("test")],
+                            }),
                         },
                         footers: {
-                            default: new Footer(),
+                            default: new Footer({
+                                children: [new Paragraph("test")],
+                            }),
                         },
                         children: [],
                     },
@@ -99,5 +107,39 @@ describe("Compiler", () => {
             compiler.compile(file);
             expect(spy.callCount).to.equal(12);
         });
+
+        it("should work with media datas", () => {
+            // This test is required because before, there was a case where Document was formatted twice, which was inefficient
+            // This also caused issues such as running prepForXml multiple times as format() was ran multiple times.
+            const paragraph = new Paragraph("");
+            const file = new File({
+                sections: [
+                    {
+                        properties: {},
+                        children: [paragraph],
+                    },
+                ],
+            });
+
+            // tslint:disable-next-line: no-string-literal
+            sinon.stub(compiler["imageReplacer"], "getMediaData").returns([
+                {
+                    stream: Buffer.from(""),
+                    fileName: "test",
+                    transformation: {
+                        pixels: {
+                            x: 100,
+                            y: 100,
+                        },
+                        emus: {
+                            x: 100,
+                            y: 100,
+                        },
+                    },
+                },
+            ]);
+
+            compiler.compile(file);
+        });
     });
 });
diff --git a/src/file/index.ts b/src/file/index.ts
@@ -19,3 +19,4 @@ export * from "./shared";
 export * from "./border";
 export * from "./values";
 export * from "./vertical-align";
+export * from "./space-type";
diff --git a/src/file/paragraph/links/pageref-field-instruction.ts b/src/file/paragraph/links/pageref-field-instruction.ts
@@ -1,10 +1,8 @@
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { IPageReferenceOptions } from "./pageref-properties";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "../run/text-attributes";
+import { IPageReferenceOptions } from "./pageref-properties";
 
 export class PageReferenceFieldInstruction extends XmlComponent {
     constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {

diff --git a/src/file/paragraph/run/page-number.ts b/src/file/paragraph/run/page-number.ts
@@ -1,9 +1,7 @@
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "./text-attributes";
 
 export class Page extends XmlComponent {
     constructor() {

diff --git a/src/file/paragraph/run/properties.ts b/src/file/paragraph/run/properties.ts
@@ -1,8 +1,9 @@
-import { ChangeAttributes, IChangedAttributesProperties } from "../../track-revision/track-revision";
-
 import { BorderElement, IBorderOptions } from "file/border";
 import { IShadingAttributesProperties, Shading } from "file/shading";
+import { SpaceType } from "file/space-type";
+import { ChangeAttributes, IChangedAttributesProperties } from "file/track-revision/track-revision";
 import { HpsMeasureElement, IgnoreIfEmptyXmlComponent, OnOffElement, StringValueElement, XmlComponent } from "file/xml-components";
+
 import { EmphasisMark, EmphasisMarkType } from "./emphasis-mark";
 import { CharacterSpacing, Color, Highlight, HighlightComplexScript } from "./formatting";
 import { IFontAttributesProperties, RunFonts } from "./run-fonts";
@@ -45,6 +46,7 @@ export interface IRunStylePropertiesOptions {
     readonly imprint?: boolean;
     readonly revision?: IRunPropertiesChangeOptions;
     readonly border?: IBorderOptions;
+    readonly space?: SpaceType;
 }
 
 export interface IRunPropertiesOptions extends IRunStylePropertiesOptions {

diff --git a/src/file/paragraph/run/run-components/text.ts b/src/file/paragraph/run/run-components/text.ts
@@ -1,9 +1,7 @@
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "../text-attributes";
 
 export class Text extends XmlComponent {
     constructor(text: string) {

diff --git a/src/file/paragraph/run/run.spec.ts b/src/file/paragraph/run/run.spec.ts
@@ -4,6 +4,7 @@ import { Formatter } from "export/formatter";
 import { BorderStyle } from "file/border";
 // import { FootnoteReferenceRun } from "file/footnotes/footnote/run/reference-run";
 import { ShadingType } from "file/shading";
+import { SpaceType } from "file/space-type";
 
 import { Run } from "./";
 import { EmphasisMarkType } from "./emphasis-mark";
@@ -521,4 +522,20 @@ describe("Run", () => {
             });
         });
     });
+
+    describe("#space", () => {
+        it("should correctly set the border", () => {
+            const run = new Run({
+                space: SpaceType.PRESERVE,
+            });
+            const tree = new Formatter().format(run);
+            expect(tree).to.deep.equal({
+                "w:r": {
+                    _attr: {
+                        "xml:space": "preserve",
+                    },
+                },
+            });
+        });
+    });
 });
diff --git a/src/file/paragraph/run/run.ts b/src/file/paragraph/run/run.ts
@@ -3,11 +3,13 @@ import { XmlComponent } from "file/xml-components";
 
 import { FootnoteReferenceRun } from "file/footnotes/footnote/run/reference-run";
 import { FieldInstruction } from "file/table-of-contents/field-instruction";
+
 import { Break } from "./break";
 import { Begin, End, Separate } from "./field";
 import { NumberOfPages, NumberOfPagesSection, Page } from "./page-number";
 import { IRunPropertiesOptions, RunProperties } from "./properties";
 import { Text } from "./run-components/text";
+import { TextAttributes } from "./text-attributes";
 
 export interface IRunOptions extends IRunPropertiesOptions {
     readonly children?: (Begin | FieldInstruction | Separate | End | PageNumber | FootnoteReferenceRun | string)[];
@@ -35,6 +37,10 @@ export class Run extends XmlComponent {
             }
         }
 
+        if (options.space) {
+            this.root.push(new TextAttributes({ space: options.space }));
+        }
+
         if (options.children) {
             for (const child of options.children) {
                 if (typeof child === "string") {

diff --git a/src/file/paragraph/run/sequential-identifier-instruction.ts b/src/file/paragraph/run/sequential-identifier-instruction.ts
@@ -1,10 +1,8 @@
 // http://officeopenxml.com/WPfieldInstructions.php
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "./text-attributes";
 
 export class SequentialIdentifierInstruction extends XmlComponent {
     constructor(identifier: string) {

diff --git a/src/file/paragraph/run/text-attributes.ts b/src/file/paragraph/run/text-attributes.ts
@@ -0,0 +1,6 @@
+import { SpaceType } from "file/space-type";
+import { XmlAttributeComponent } from "file/xml-components";
+
+export class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
+    protected readonly xmlKeys = { space: "xml:space" };
+}
diff --git a/src/file/table-of-contents/field-instruction.ts b/src/file/table-of-contents/field-instruction.ts
@@ -1,11 +1,9 @@
 // http://officeopenxml.com/WPfieldInstructions.php
+import { TextAttributes } from "file/paragraph/run/text-attributes";
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { ITableOfContentsOptions } from "./table-of-contents-properties";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { ITableOfContentsOptions } from "./table-of-contents-properties";
 
 export class FieldInstruction extends XmlComponent {
     private readonly properties: ITableOfContentsOptions;

diff --git a/src/file/track-revision/track-revision-components/deleted-page-number.ts b/src/file/track-revision/track-revision-components/deleted-page-number.ts
@@ -1,9 +1,6 @@
+import { TextAttributes } from "file/paragraph/run/text-attributes";
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { XmlComponent } from "file/xml-components";
 
 export class DeletedPage extends XmlComponent {
     constructor() {

diff --git a/src/file/track-revision/track-revision-components/deleted-text.ts b/src/file/track-revision/track-revision-components/deleted-text.ts
@@ -1,9 +1,6 @@
+import { TextAttributes } from "file/paragraph/run/text-attributes";
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { XmlComponent } from "file/xml-components";
 
 export class DeletedText extends XmlComponent {
     constructor(text: string) {