docx 7.0.0 → 7.2.0

package/src/file/paragraph/formatting/break.ts

@@ -1,43 +1,43 @@
-// http://officeopenxml.com/WPtextSpecialContent-break.php
-import { Attributes, XmlComponent } from "file/xml-components";
-import { Run } from "../run";
-
-enum BreakType {
-    COLUMN = "column",
-    PAGE = "page",
-    // textWrapping breaks are the default and already exposed via the "Run" class
-}
-
-class Break extends XmlComponent {
-    constructor(type: BreakType) {
-        super("w:br");
-        this.root.push(
-            new Attributes({
-                type,
-            }),
-        );
-    }
-}
-
-export class PageBreak extends Run {
-    constructor() {
-        super({});
-        this.root.push(new Break(BreakType.PAGE));
-    }
-}
-
-export class ColumnBreak extends Run {
-    constructor() {
-        super({});
-        this.root.push(new Break(BreakType.COLUMN));
-    }
-}
-
-/**
- * Add page break before the paragraph if there is no one added before.
- */
-export class PageBreakBefore extends XmlComponent {
-    constructor() {
-        super("w:pageBreakBefore");
-    }
-}
+// http://officeopenxml.com/WPtextSpecialContent-break.php
+import { Attributes, XmlComponent } from "file/xml-components";
+import { Run } from "../run";
+
+enum BreakType {
+    COLUMN = "column",
+    PAGE = "page",
+    // textWrapping breaks are the default and already exposed via the "Run" class
+}
+
+class Break extends XmlComponent {
+    constructor(type: BreakType) {
+        super("w:br");
+        this.root.push(
+            new Attributes({
+                type,
+            }),
+        );
+    }
+}
+
+export class PageBreak extends Run {
+    constructor() {
+        super({});
+        this.root.push(new Break(BreakType.PAGE));
+    }
+}
+
+export class ColumnBreak extends Run {
+    constructor() {
+        super({});
+        this.root.push(new Break(BreakType.COLUMN));
+    }
+}
+
+/**
+ * Add page break before the paragraph if there is no one added before.
+ */
+export class PageBreakBefore extends XmlComponent {
+    constructor() {
+        super("w:pageBreakBefore");
+    }
+}

package/src/file/paragraph/formatting/index.ts

@@ -1,8 +1,8 @@
-export * from "./alignment";
-export * from "./border";
-export * from "./indent";
-export * from "./break";
-export * from "./spacing";
-export * from "./style";
-export * from "./tab-stop";
-export * from "./unordered-list";
+export * from "./alignment";
+export * from "./border";
+export * from "./indent";
+export * from "./break";
+export * from "./spacing";
+export * from "./style";
+export * from "./tab-stop";
+export * from "./unordered-list";

package/src/file/paragraph/frame/frame-properties.ts

@@ -1,112 +1,112 @@
-// http://officeopenxml.com/WPparagraph-textFrames.php
-import { HorizontalPositionAlign, VerticalPositionAlign } from "file/shared/alignment";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { HeightRule } from "/file";
-
-export enum DropCapType {
-    NONE = "none",
-    DROP = "drop",
-    MARGIN = "margin",
-}
-
-export enum FrameAnchorType {
-    MARGIN = "margin",
-    PAGE = "page",
-    TEXT = "text",
-}
-
-export enum FrameWrap {
-    AROUND = "around",
-    AUTO = "auto",
-    NONE = "none",
-    NOT_BESIDE = "notBeside",
-    THROUGH = "through",
-    TIGHT = "tight",
-}
-
-export interface IFrameOptions {
-    readonly anchorLock?: boolean;
-    readonly dropCap?: DropCapType;
-    readonly width: number;
-    readonly height: number;
-    readonly position: {
-        readonly x: number;
-        readonly y: number;
-    };
-    readonly wrap?: FrameWrap;
-    readonly lines?: number;
-    readonly anchor: {
-        readonly horizontal: FrameAnchorType;
-        readonly vertical: FrameAnchorType;
-    };
-    readonly space?: {
-        readonly horizontal: number;
-        readonly vertical: number;
-    };
-    readonly rule?: HeightRule;
-    readonly alignment: {
-        readonly x: HorizontalPositionAlign;
-        readonly y: VerticalPositionAlign;
-    };
-}
-
-export class FramePropertiesAttributes extends XmlAttributeComponent<{
-    readonly anchorLock?: boolean;
-    readonly dropCap?: DropCapType;
-    readonly width: number;
-    readonly height: number;
-    readonly x: number;
-    readonly y: number;
-    readonly wrap?: FrameWrap;
-    readonly lines?: number;
-    readonly anchorHorizontal?: FrameAnchorType;
-    readonly anchorVertical?: FrameAnchorType;
-    readonly spaceHorizontal?: number;
-    readonly spaceVertical?: number;
-    readonly rule?: HeightRule;
-    readonly alignmentX?: HorizontalPositionAlign;
-    readonly alignmentY?: VerticalPositionAlign;
-}> {
-    protected readonly xmlKeys = {
-        anchorLock: "w:anchorLock",
-        dropCap: "w:dropCap",
-        width: "w:w",
-        height: "w:h",
-        x: "w:x",
-        y: "w:y",
-        anchorHorizontal: "w:hAnchor",
-        anchorVertical: "w:vAnchor",
-        spaceHorizontal: "w:hSpace",
-        spaceVertical: "w:vSpace",
-        rule: "w:hRule",
-        alignmentX: "w:xAlign",
-        alignmentY: "w:yAlign",
-        lines: "w:lines",
-        wrap: "w:wrap",
-    };
-}
-
-export class FrameProperties extends XmlComponent {
-    constructor(options: IFrameOptions) {
-        super("w:framePr");
-        this.root.push(
-            new FramePropertiesAttributes({
-                anchorLock: options.anchorLock,
-                dropCap: options.dropCap,
-                width: options.width,
-                height: options.height,
-                x: options.position.x,
-                y: options.position.y,
-                anchorHorizontal: options.anchor.horizontal,
-                anchorVertical: options.anchor.vertical,
-                spaceHorizontal: options.space?.horizontal,
-                spaceVertical: options.space?.vertical,
-                rule: options.rule,
-                alignmentX: options.alignment.x,
-                alignmentY: options.alignment.y,
-                lines: options.lines,
-                wrap: options.wrap,
-            }),
-        );
-    }
-}
+// http://officeopenxml.com/WPparagraph-textFrames.php
+import { HeightRule } from "file";
+import { HorizontalPositionAlign, VerticalPositionAlign } from "file/shared/alignment";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+export enum DropCapType {
+    NONE = "none",
+    DROP = "drop",
+    MARGIN = "margin",
+}
+
+export enum FrameAnchorType {
+    MARGIN = "margin",
+    PAGE = "page",
+    TEXT = "text",
+}
+
+export enum FrameWrap {
+    AROUND = "around",
+    AUTO = "auto",
+    NONE = "none",
+    NOT_BESIDE = "notBeside",
+    THROUGH = "through",
+    TIGHT = "tight",
+}
+
+export interface IFrameOptions {
+    readonly anchorLock?: boolean;
+    readonly dropCap?: DropCapType;
+    readonly width: number;
+    readonly height: number;
+    readonly position: {
+        readonly x: number;
+        readonly y: number;
+    };
+    readonly wrap?: FrameWrap;
+    readonly lines?: number;
+    readonly anchor: {
+        readonly horizontal: FrameAnchorType;
+        readonly vertical: FrameAnchorType;
+    };
+    readonly space?: {
+        readonly horizontal: number;
+        readonly vertical: number;
+    };
+    readonly rule?: HeightRule;
+    readonly alignment: {
+        readonly x: HorizontalPositionAlign;
+        readonly y: VerticalPositionAlign;
+    };
+}
+
+export class FramePropertiesAttributes extends XmlAttributeComponent<{
+    readonly anchorLock?: boolean;
+    readonly dropCap?: DropCapType;
+    readonly width: number;
+    readonly height: number;
+    readonly x: number;
+    readonly y: number;
+    readonly wrap?: FrameWrap;
+    readonly lines?: number;
+    readonly anchorHorizontal?: FrameAnchorType;
+    readonly anchorVertical?: FrameAnchorType;
+    readonly spaceHorizontal?: number;
+    readonly spaceVertical?: number;
+    readonly rule?: HeightRule;
+    readonly alignmentX?: HorizontalPositionAlign;
+    readonly alignmentY?: VerticalPositionAlign;
+}> {
+    protected readonly xmlKeys = {
+        anchorLock: "w:anchorLock",
+        dropCap: "w:dropCap",
+        width: "w:w",
+        height: "w:h",
+        x: "w:x",
+        y: "w:y",
+        anchorHorizontal: "w:hAnchor",
+        anchorVertical: "w:vAnchor",
+        spaceHorizontal: "w:hSpace",
+        spaceVertical: "w:vSpace",
+        rule: "w:hRule",
+        alignmentX: "w:xAlign",
+        alignmentY: "w:yAlign",
+        lines: "w:lines",
+        wrap: "w:wrap",
+    };
+}
+
+export class FrameProperties extends XmlComponent {
+    constructor(options: IFrameOptions) {
+        super("w:framePr");
+        this.root.push(
+            new FramePropertiesAttributes({
+                anchorLock: options.anchorLock,
+                dropCap: options.dropCap,
+                width: options.width,
+                height: options.height,
+                x: options.position.x,
+                y: options.position.y,
+                anchorHorizontal: options.anchor.horizontal,
+                anchorVertical: options.anchor.vertical,
+                spaceHorizontal: options.space?.horizontal,
+                spaceVertical: options.space?.vertical,
+                rule: options.rule,
+                alignmentX: options.alignment.x,
+                alignmentY: options.alignment.y,
+                lines: options.lines,
+                wrap: options.wrap,
+            }),
+        );
+    }
+}

package/src/file/paragraph/links/bookmark-attributes.ts

@@ -1,7 +1,7 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export class BookmarkStartAttributes extends XmlAttributeComponent<{
-    readonly id: string;
+    readonly id: number;
     readonly name: string;
 }> {
     protected readonly xmlKeys = {
@@ -11,7 +11,7 @@ export class BookmarkStartAttributes extends XmlAttributeComponent<{
 }
 
 export class BookmarkEndAttributes extends XmlAttributeComponent<{
-    readonly id: string;
+    readonly id: number;
 }> {
     protected readonly xmlKeys = {
         id: "w:id",

package/src/file/paragraph/links/bookmark.spec.ts

@@ -36,6 +36,6 @@ describe("Bookmark", () => {
 
     it("should create a bookmark with the correct attributes on the bookmark end element", () => {
         const newJson = Utility.jsonify(bookmark);
-        expect(newJson.end.root[0].root.id).to.be.a("string");
+        expect(newJson.end.root[0].root.id).to.be.a("number");
     });
 });

package/src/file/paragraph/links/bookmark.ts

@@ -1,43 +1,75 @@
-// http://officeopenxml.com/WPbookmark.php
-import { uniqueId } from "convenience-functions";
-import { XmlComponent } from "file/xml-components";
-
-import { ParagraphChild } from "../paragraph";
-import { BookmarkEndAttributes, BookmarkStartAttributes } from "./bookmark-attributes";
-
-export class Bookmark {
-    public readonly start: BookmarkStart;
-    public readonly children: ParagraphChild[];
-    public readonly end: BookmarkEnd;
-
-    constructor(options: { readonly id: string; readonly children: ParagraphChild[] }) {
-        const linkId = uniqueId();
-
-        this.start = new BookmarkStart(options.id, linkId);
-        this.children = options.children;
-        this.end = new BookmarkEnd(linkId);
-    }
-}
-
-export class BookmarkStart extends XmlComponent {
-    constructor(id: string, linkId: string) {
-        super("w:bookmarkStart");
-
-        const attributes = new BookmarkStartAttributes({
-            name: id,
-            id: linkId,
-        });
-        this.root.push(attributes);
-    }
-}
-
-export class BookmarkEnd extends XmlComponent {
-    constructor(linkId: string) {
-        super("w:bookmarkEnd");
-
-        const attributes = new BookmarkEndAttributes({
-            id: linkId,
-        });
-        this.root.push(attributes);
-    }
-}
+// http://officeopenxml.com/WPbookmark.php
+import { uniqueNumericId } from "convenience-functions";
+import { XmlComponent } from "file/xml-components";
+
+import { ParagraphChild } from "../paragraph";
+import { BookmarkEndAttributes, BookmarkStartAttributes } from "./bookmark-attributes";
+
+export class Bookmark {
+    public readonly start: BookmarkStart;
+    public readonly children: ParagraphChild[];
+    public readonly end: BookmarkEnd;
+
+    constructor(options: { readonly id: string; readonly children: ParagraphChild[] }) {
+        const linkId = uniqueNumericId();
+
+        this.start = new BookmarkStart(options.id, linkId);
+        this.children = options.children;
+        this.end = new BookmarkEnd(linkId);
+    }
+}
+
+// <xsd:element name="bookmarkStart" type="CT_Bookmark"/>
+// <xsd:element name="bookmarkEnd" type="CT_MarkupRange"/>
+
+// <xsd:complexType name="CT_Bookmark">
+//   <xsd:complexContent>
+//     <xsd:extension base="CT_BookmarkRange">
+//     <xsd:attribute name="name" type="s:ST_String" use="required"/>
+//     </xsd:extension>
+//   </xsd:complexContent>
+// </xsd:complexType>
+
+// <xsd:complexType name="CT_BookmarkRange">
+//   <xsd:complexContent>
+//     <xsd:extension base="CT_MarkupRange">
+//       <xsd:attribute name="colFirst" type="ST_DecimalNumber" use="optional"/>
+//       <xsd:attribute name="colLast" type="ST_DecimalNumber" use="optional"/>
+//     </xsd:extension>
+//   </xsd:complexContent>
+// </xsd:complexType>
+
+// <xsd:complexType name="CT_MarkupRange">
+//   <xsd:complexContent>
+//     <xsd:extension base="CT_Markup">
+//       <xsd:attribute name="displacedByCustomXml" type="ST_DisplacedByCustomXml" use="optional"/>
+//     </xsd:extension>
+//   </xsd:complexContent>
+// </xsd:complexType>
+
+// <xsd:complexType name="CT_Markup">
+//   <xsd:attribute name="id" type="ST_DecimalNumber" use="required"/>
+// </xsd:complexType>
+
+export class BookmarkStart extends XmlComponent {
+    constructor(id: string, linkId: number) {
+        super("w:bookmarkStart");
+
+        const attributes = new BookmarkStartAttributes({
+            name: id,
+            id: linkId,
+        });
+        this.root.push(attributes);
+    }
+}
+
+export class BookmarkEnd extends XmlComponent {
+    constructor(linkId: number) {
+        super("w:bookmarkEnd");
+
+        const attributes = new BookmarkEndAttributes({
+            id: linkId,
+        });
+        this.root.push(attributes);
+    }
+}