Merge branch 'master' of https://github.com/h4buli/docx into feat/h4buli-update

# Conflicts:
#	package.json
#	src/file/numbering/numbering.ts

src/file/xml-components/base.ts

@@ -2,10 +2,15 @@ import { IXmlableObject } from "./xmlable-object";
 
 export abstract class BaseXmlComponent {
     protected rootKey: string;
+    protected deleted: boolean = false;
 
     constructor(rootKey: string) {
         this.rootKey = rootKey;
     }
 
     public abstract prepForXml(): IXmlableObject;
+
+    get isDeleted() {
+        return this.deleted;
+    }
 }

src/file/xml-components/imported-xml-component.spec.ts

@@ -0,0 +1,34 @@
+import { expect } from "chai";
+import { ImportedXmlComponent } from "./";
+
+describe("ImportedXmlComponent", () => {
+    let importedXmlComponent: ImportedXmlComponent;
+
+    beforeEach(() => {
+        const attributes = {
+            someAttr: "1",
+            otherAttr: "2",
+        };
+        importedXmlComponent = new ImportedXmlComponent("w:test", attributes);
+        importedXmlComponent.push(new ImportedXmlComponent("w:child"));
+    });
+
+    describe("#prepForXml()", () => {
+        it("should transform for xml", () => {
+            const converted = importedXmlComponent.prepForXml();
+            expect(converted).to.eql({
+                "w:test": [
+                    {
+                        _attr: {
+                            someAttr: "1",
+                            otherAttr: "2",
+                        },
+                    },
+                    {
+                        "w:child": [],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/xml-components/imported-xml-component.ts

@@ -0,0 +1,71 @@
+import { XmlComponent, IXmlableObject } from ".";
+
+/**
+ * Represents imported xml component from xml file.
+ */
+export class ImportedXmlComponent extends XmlComponent {
+    private _attr: any;
+
+    constructor(rootKey: string, _attr?: any) {
+        super(rootKey);
+        if (_attr) {
+            this._attr = _attr;
+        }
+    }
+
+    /**
+     * Transforms the object so it can be converted to xml. Example:
+     * <w:someKey someAttr="1" otherAttr="11">
+     *    <w:child childAttr="2">
+     *    </w:child>
+     * </w:someKey>
+     * {
+     *   'w:someKey': [
+     *      {
+     *          _attr: {
+     *              someAttr: "1",
+     *              otherAttr: "11"
+     *          }
+     *      },
+     *      {
+     *          'w:child': [
+     *              {
+     *                  _attr: {
+     *                      childAttr: "2"
+     *                  }
+     *              }
+     *           ]
+     *      }
+     *    ]
+     * }
+     */
+    prepForXml(): IXmlableObject {
+        const result = super.prepForXml();
+        if (!!this._attr) {
+            if (!Array.isArray(result[this.rootKey])) {
+                result[this.rootKey] = [result[this.rootKey]];
+            }
+            result[this.rootKey].unshift({ _attr: this._attr });
+        }
+        return result;
+    }
+
+    push(xmlComponent: XmlComponent) {
+        this.root.push(xmlComponent);
+    }
+}
+
+/**
+ * Used for the attributes of root element that is being imported.
+ */
+export class ImportedRootElementAttributes extends XmlComponent {
+    constructor(private _attr: any) {
+        super("");
+    }
+
+    public prepForXml(): IXmlableObject {
+        return {
+            _attr: this._attr,
+        };
+    }
+}

src/file/xml-components/index.ts

@@ -1,4 +1,5 @@
 export * from "./xml-component";
 export * from "./attributes";
 export * from "./default-attributes";
+export * from './imported-xml-component';
 export * from "./xmlable-object";

src/file/xml-components/xml-component.spec.ts

@@ -18,4 +18,15 @@ describe("XmlComponent", () => {
             assert.equal(newJson.rootKey, "w:test");
         });
     });
+
+    describe("#prepForXml()", () => {
+        it("should skip deleted elements", () => {
+            const child = new TestComponent("w:test1");
+            child.delete();
+            xmlComponent.addChildElement(child);
+           
+            const xml = xmlComponent.prepForXml();
+            assert.equal(xml['w:test'].length, 0); 
+        });
+    });
 });

src/file/xml-components/xml-component.ts

@@ -12,6 +12,12 @@ export abstract class XmlComponent extends BaseXmlComponent {
 
     public prepForXml(): IXmlableObject {
         const children = this.root
+            .filter(c => {
+                if (c instanceof BaseXmlComponent) {
+                    return !c.isDeleted;
+                }
+                return true;
+            })
             .map((comp) => {
                 if (comp instanceof BaseXmlComponent) {
                     return comp.prepForXml();
@@ -23,4 +29,12 @@ export abstract class XmlComponent extends BaseXmlComponent {
             [this.rootKey]: children,
         };
     }
+
+    public addChildElement(child: XmlComponent | string) {
+        this.root.push(child);
+    }
+
+    public delete() {
+        this.deleted = true;
+    }
 }