Merge pull request #43 from jacwright/default-run-styles

Making it easier to work with default styles

demo/demo3.js

@@ -0,0 +1,35 @@
+const docx = require('../build');
+
+var doc = new docx.Document();
+
+const numbering = new docx.Numbering();
+
+const abstractNum = numbering.createAbstractNumbering();
+abstractNum.createLevel(0, "upperRoman", "%1", "start")
+    .addParagraphProperty(new docx.Indent(720, 260));
+abstractNum.createLevel(1, "decimal", "%2.", "start")
+    .addParagraphProperty(new docx.Indent(1440, 980));
+abstractNum.createLevel(2, "lowerLetter", "%3)", "start")
+    .addParagraphProperty(new docx.Indent(2160, 1700));
+
+const concrete = numbering.createConcreteNumbering(abstractNum);
+
+var topLevelP = new docx.Paragraph("Hey you");
+var subP = new docx.Paragraph("What's up fam");
+var secondSubP = new docx.Paragraph("Hello World 2");
+var subSubP = new docx.Paragraph("Yeah boi");
+
+topLevelP.setNumbering(concrete, 0);
+subP.setNumbering(concrete, 1);
+secondSubP.setNumbering(concrete, 1);
+subSubP.setNumbering(concrete, 2);
+
+doc.addParagraph(topLevelP);
+doc.addParagraph(subP);
+doc.addParagraph(secondSubP);
+doc.addParagraph(subSubP);
+
+var exporter = new docx.LocalPacker(doc);
+exporter.pack('My Document');
+
+console.log('Document created succesfully at project root!');

demo/demo4.js

@@ -0,0 +1,12 @@
+const docx = require('../build');
+
+var doc = new docx.Document();
+
+const table = doc.createTable(4, 4);
+table.getCell(2, 2).addContent(new docx.Paragraph('Hello'));
+
+
+var exporter = new docx.LocalPacker(doc);
+exporter.pack('My Document');
+
+console.log('Document created succesfully at project root!');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx",
-  "version": "2.1.0",
+  "version": "2.1.3",
   "description": "Generate .docx documents with JavaScript (formerly Office-Clippy)",
   "main": "build/index.js",
   "scripts": {
@@ -34,7 +34,7 @@
   ],
   "types": "./build/index.d.ts",
   "dependencies": {
-    "@types/archiver": "^1.3.2",
+    "@types/archiver": "^1.3.4",
     "@types/express": "^4.0.35",
     "archiver": "^1.3.0",
     "xml": "^1.0.1"
@@ -55,6 +55,6 @@
     "shelljs": "^0.7.7",
     "tslint": "^5.1.0",
     "typedoc": "^0.5.10",
-    "typescript": "^2.2.1"
+    "typescript": "2.4.1"
   }
 }

ts/docx/index.ts

@@ -1,5 +1,5 @@
 export { Document } from "./document";
-export { Paragraph } from "./paragraph";
+export * from "./paragraph";
 export { Run } from "./run";
 export { TextRun } from "./run/text-run";
 export { PictureRun } from "./run/picture-run";

ts/docx/paragraph/index.ts

@@ -16,6 +16,8 @@ import { Style } from "./style";
 import { LeftTabStop, MaxRightTabStop } from "./tab-stop";
 import { NumberProperties } from "./unordered-list";
 
+export * from "./formatting";
+
 export class Paragraph extends XmlComponent {
     private properties: ParagraphProperties;
 
@@ -101,7 +103,7 @@ export class Paragraph extends XmlComponent {
     }
 
     public pageBreak(): Paragraph {
-        this.properties.push(new PageBreak());
+        this.root.push(new PageBreak());
         return this;
     }
 

ts/docx/table/index.ts

@@ -1,6 +1,6 @@
 import { Paragraph } from "../paragraph";
 import { XmlComponent } from "../xml-components";
-
+import { IXmlableObject } from "../xml-components/xmlable-object";
 import { TableGrid } from "./grid";
 import { TableProperties, WidthTypes } from "./properties";
 
@@ -99,7 +99,7 @@ export class TableCell extends XmlComponent {
         return this;
     }
 
-    public prepForXml(): XmlableObject {
+    public prepForXml(): IXmlableObject {
         // Cells must end with a paragraph
         const retval = super.prepForXml();
         const content = retval["w:tc"];

ts/docx/xml-components/base.ts

@@ -1,3 +1,5 @@
+import { IXmlableObject } from "./xmlable-object";
+
 export abstract class BaseXmlComponent {
     protected rootKey: string;
 
@@ -5,5 +7,5 @@ export abstract class BaseXmlComponent {
         this.rootKey = rootKey;
     }
 
-    public abstract prepForXml(): XmlableObject;
+    public abstract prepForXml(): IXmlableObject;
 }

ts/docx/xml-components/default-attributes.ts

@@ -1,4 +1,5 @@
 import { BaseXmlComponent } from "./base";
+import { IXmlableObject } from "./xmlable-object";
 
 export type AttributeMap<T> = {[P in keyof T]: string};
 
@@ -11,7 +12,7 @@ export abstract class XmlAttributeComponent<T> extends BaseXmlComponent {
         this.root = properties;
     }
 
-    public prepForXml(): XmlableObject {
+    public prepForXml(): IXmlableObject {
         const attrs = {};
         Object.keys(this.root).forEach((key) => {
             const value = this.root[key];

ts/docx/xml-components/index.ts

@@ -1,4 +1,5 @@
 import { BaseXmlComponent } from "./base";
+import { IXmlableObject } from "./xmlable-object";
 export { BaseXmlComponent };
 
 export abstract class XmlComponent extends BaseXmlComponent {
@@ -9,7 +10,7 @@ export abstract class XmlComponent extends BaseXmlComponent {
         this.root = new Array<BaseXmlComponent>();
     }
 
-    public prepForXml(): XmlableObject {
+    public prepForXml(): IXmlableObject {
         const children = this.root.map((comp) => {
             if (comp instanceof BaseXmlComponent) {
                 return comp.prepForXml();

ts/docx/xml-components/xmlable-object.d.ts

@@ -1,3 +0,0 @@
-declare interface XmlableObject extends Object {
-    _attr?: { [key: string]: (string | number | boolean) }
-}

ts/docx/xml-components/xmlable-object.ts

@@ -0,0 +1,3 @@
+export interface IXmlableObject extends Object {
+    _attr?: { [key: string]: (string | number | boolean) };
+}

ts/export/formatter.ts

@@ -1,7 +1,8 @@
 import { BaseXmlComponent } from "../docx/xml-components";
+import { IXmlableObject } from "../docx/xml-components/xmlable-object";
 
 export class Formatter {
-    public format(input: BaseXmlComponent): XmlableObject {
+    public format(input: BaseXmlComponent): IXmlableObject {
         return input.prepForXml();
     }
 }

ts/styles/defaults/run-properties.ts

@@ -1,10 +1,24 @@
 import { RunProperties } from "../../docx/run/properties";
 import { XmlComponent } from "../../docx/xml-components";
+import { RunFonts } from "../../docx/run/run-fonts";
+import { Size } from "../../docx/run/formatting";
 
 export class RunPropertiesDefaults extends XmlComponent {
+    private properties: RunProperties;
 
     constructor() {
         super("w:rPrDefault");
-        this.root.push(new RunProperties());
+        this.properties = new RunProperties();
+        this.root.push(this.properties);
+    }
+
+    public size(size: number): RunPropertiesDefaults {
+        this.properties.push(new Size(size));
+        return this;
+    }
+
+    public font(fontName: string): RunPropertiesDefaults {
+        this.properties.push(new RunFonts(fontName));
+        return this;
     }
 }

ts/styles/factory.ts

@@ -11,7 +11,7 @@ export class DefaultStylesFactory {
 
     public newInstance(): Styles {
         const styles = new Styles();
-        styles.push(new DocumentDefaults());
+        styles.createDocumentDefaults();
 
         const titleStyle = new TitleStyle();
         titleStyle.addRunProperty(new Size(56));

ts/styles/index.ts

@@ -1,6 +1,7 @@
 import { DocumentAttributes } from "../docx/document/document-attributes";
 import { XmlComponent } from "../docx/xml-components";
 import { ParagraphStyle } from "./style";
+import { DocumentDefaults } from "./defaults";
 
 export class Styles extends XmlComponent {
 
@@ -14,11 +15,7 @@ export class Styles extends XmlComponent {
             w15: "http://schemas.microsoft.com/office/word/2012/wordml",
             Ignorable: "w14 w15",
         }));
-        // let latentStyles = new LatentStyles();
+
-        // latentStyles.push(new LatentStyleException(new LatentStyleExceptionAttributes({
-        //    name: "Normal"
-        // })));
-        // this.root.push(latentStyles);
     }
 
     public push(style: XmlComponent): Styles {
@@ -26,6 +23,12 @@ export class Styles extends XmlComponent {
         return this;
     }
 
+    public createDocumentDefaults(): DocumentDefaults {
+        const defaults = new DocumentDefaults();
+        this.push(defaults);
+        return defaults;
+    }
+
     public createParagraphStyle(styleId: string, name?: string): ParagraphStyle {
         const para = new ParagraphStyle(styleId, name);
         this.push(para);

ts/tests/docx/paragraph/paragraphTests.ts

@@ -144,13 +144,13 @@ describe("Paragraph", () => {
             const tree = new Formatter().format(paragraph);
             expect(tree).to.deep.equal({
                 "w:p": [{
-                    "w:pPr": [{
+                    "w:pPr": [],
+                },{
                     "w:r": [
                         {"w:rPr": []},
                         {"w:br": [{_attr: {"w:type": "page"}}]},
                     ],
                 }],
-                }],
             });
         });
     });