docx-plus 0.0.5 → 0.0.6

package/README.md

@@ -11,21 +11,24 @@ Easily generate and modify .docx files with JS/TS. Works for Node and on the Bro
 
 ## What's Different from docx?
 
-|                     | docx                                      | docx-plus                            |
-| ------------------- | ----------------------------------------- | ------------------------------------ |
-| ZIP handling        | jszip                                     | **fflate** (faster, smaller)         |
-| Data conversion     | Manual env detection (`Buffer.from` etc.) | **undio** (universal `toUint8Array`) |
-| `Packer.toStream()` | Removed (pseudo-streaming)                | **Restored** with real streaming ZIP |
-| Test environment    | jsdom                                     | happy-dom                            |
-| OOXML compliance    | ECMA-376 (legacy)                         | **ISO/IEC 29500-4** (latest)         |
-| Theme support       | Partial (missing `ThemeColor`/`ThemeFont`) | **Full** (`ThemeColor`, `ThemeFont` enums, theme attributes on `Color`, `Underline`, `Border`, `Shading`) |
-| CT_Ind              | Twips-only indent                         | **Character-based** (`startChars`, `endChars`, `hangingChars`, `firstLineChars`) |
-| CT_Spacing          | Missing `beforeLines`/`afterLines`        | **Complete** (both twips & line-unit spacing) |
-| CT_Border           | Missing `shadow`/`frame`/theme attrs      | **Complete** (`shadow`, `frame`, `themeColor`, `themeTint`, `themeShade`) |
-| CT_Shd              | Missing theme fill/color attrs             | **Complete** (`themeColor`, `themeFill`, `themeTint`/`themeShade`) |
-| EG_RPrBase          | Missing `outline`/`shadow`/`webHidden`/`fitText`/`cs` | **Complete** (all spec-defined elements) |
-| ST_Em               | `dot` only                                | **Complete** (`none`, `comma`, `circle`, `dot`, `underDot`) |
-| ST_TabTlc           | Missing `heavy`                           | **Complete** (`none`, `dot`, `hyphen`, `middleDot`, `underscore`, `heavy`) |
+|                     | docx                                                                       | docx-plus                                                                                                                                         |
+| ------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ZIP handling        | jszip                                                                      | **fflate** (faster, smaller)                                                                                                                      |
+| Data conversion     | Manual env detection (`Buffer.from` etc.)                                  | **undio** (universal `toUint8Array`)                                                                                                              |
+| `Packer.toStream()` | Removed (pseudo-streaming)                                                 | **Restored** with real streaming ZIP                                                                                                              |
+| Test environment    | jsdom                                                                      | happy-dom                                                                                                                                         |
+| OOXML compliance    | ECMA-376 (legacy)                                                          | **ISO/IEC 29500-4** (latest)                                                                                                                      |
+| Theme support       | Partial (missing `ThemeColor`/`ThemeFont`)                                 | **Full** (`ThemeColor`, `ThemeFont` enums, theme attributes on `Color`, `Underline`, `Border`, `Shading`)                                         |
+| CT_Ind              | Twips-only indent                                                          | **Character-based** (`startChars`, `endChars`, `hangingChars`, `firstLineChars`)                                                                  |
+| CT_Spacing          | Missing `beforeLines`/`afterLines`                                         | **Complete** (both twips & line-unit spacing)                                                                                                     |
+| CT_Border           | Missing `shadow`/`frame`/theme attrs                                       | **Complete** (`shadow`, `frame`, `themeColor`, `themeTint`, `themeShade`)                                                                         |
+| CT_Shd              | Missing theme fill/color attrs                                             | **Complete** (`themeColor`, `themeFill`, `themeTint`/`themeShade`)                                                                                |
+| EG_RPrBase          | Missing `outline`/`shadow`/`webHidden`/`fitText`/`cs`                      | **Complete** (all spec-defined elements)                                                                                                          |
+| ST_Em               | `dot` only                                                                 | **Complete** (`none`, `comma`, `circle`, `dot`, `underDot`)                                                                                       |
+| ST_TabTlc           | Missing `heavy`                                                            | **Complete** (`none`, `dot`, `hyphen`, `middleDot`, `underscore`, `heavy`)                                                                        |
+| CT_PPrBase          | Missing 9 paragraph props                                                  | **Complete** (`suppressAutoHyphens`, `adjustRightInd`, `snapToGrid`, `mirrorIndents`, East Asian typography, `textAlignment`, `textboxTightWrap`) |
+| CT_SectPr           | Missing `noEndnote`/`bidi`/`rtlGutter`/`paperSrc`/`footnotePr`/`endnotePr` | **Complete** (all spec-defined elements)                                                                                                          |
+| EG_RPrBase          | Missing `eastAsianLayout`                                                  | **Complete** (`eastAsianLayout` with `combine`, `combineBrackets`, `vert`, `vertCompress`)                                                        |
 
 ## Installation
 

package/dist/index.cjs

@@ -2284,6 +2284,57 @@ var InsertionTrackChange = class extends XmlComponent {
 	}
 };
 //#endregion
+//#region src/file/paragraph/run/east-asian-layout.ts
+/**
+* East Asian layout module for WordprocessingML run properties.
+*
+* Specifies East Asian typography settings for a run, including
+* character combination, vertical text, and compression.
+*
+* Reference: ISO/IEC 29500-4, CT_EastAsianLayout
+*
+* @module
+*/
+/**
+* Creates an East Asian layout element (w:eastAsianLayout) for a run.
+*
+* ## XSD Schema
+* ```xml
+* <xsd:complexType name="CT_EastAsianLayout">
+*   <xsd:attribute name="id" type="ST_DecimalNumber" use="optional"/>
+*   <xsd:attribute name="combine" type="s:ST_OnOff" use="optional"/>
+*   <xsd:attribute name="combineBrackets" type="ST_CombineBrackets" use="optional"/>
+*   <xsd:attribute name="vert" type="s:ST_OnOff" use="optional"/>
+*   <xsd:attribute name="vertCompress" type="s:ST_OnOff" use="optional"/>
+* </xsd:complexType>
+* ```
+*/
+const createEastAsianLayout = ({ id, combine, combineBrackets, vert, vertCompress }) => new BuilderElement({
+	attributes: {
+		combine: {
+			key: "w:combine",
+			value: combine
+		},
+		combineBrackets: {
+			key: "w:combineBrackets",
+			value: combineBrackets
+		},
+		id: {
+			key: "w:id",
+			value: id === void 0 ? void 0 : decimalNumber(id)
+		},
+		vert: {
+			key: "w:vert",
+			value: vert
+		},
+		vertCompress: {
+			key: "w:vertCompress",
+			value: vertCompress
+		}
+	},
+	name: "w:eastAsianLayout"
+});
+//#endregion
 //#region src/file/paragraph/run/emphasis-mark.ts
 /**
 * Emphasis mark module for WordprocessingML run properties.
@@ -3015,6 +3066,7 @@ var RunProperties = class extends IgnoreIfEmptyXmlComponent {
 		if (options.math) this.push(new OnOffElement("w:oMath", options.math));
 		if (options.fitText !== void 0) this.push(new NumberValueElement("w:fitText", options.fitText));
 		if (options.complexScript !== void 0) this.push(new OnOffElement("w:cs", options.complexScript));
+		if (options.eastAsianLayout) this.push(createEastAsianLayout(options.eastAsianLayout));
 		if (options.revision) this.push(new RunPropertiesChange(options.revision));
 	}
 	push(item) {
@@ -8521,6 +8573,34 @@ const createFrameProperties = (options) => {
 * @module
 */
 /**
+* Vertical text alignment types for paragraphs.
+*
+* Specifies the vertical alignment of text within the paragraph.
+*
+* @publicApi
+*/
+const TextAlignmentType = {
+	TOP: "top",
+	CENTER: "center",
+	BASELINE: "baseline",
+	BOTTOM: "bottom",
+	AUTO: "auto"
+};
+/**
+* Textbox tight wrap types for paragraphs.
+*
+* Specifies how tightly text wraps around a textbox.
+*
+* @publicApi
+*/
+const TextboxTightWrapType = {
+	NONE: "none",
+	ALL_LINES: "allLines",
+	FIRST_AND_LAST_LINE: "firstAndLastLine",
+	FIRST_LINE_ONLY: "firstLineOnly",
+	LAST_LINE_ONLY: "lastLineOnly"
+};
+/**
 * Represents paragraph properties (pPr) in a WordprocessingML document.
 *
 * The paragraph properties element specifies all formatting applied to a paragraph,
@@ -8683,6 +8763,27 @@ var ParagraphProperties = class extends IgnoreIfEmptyXmlComponent {
 		if (options.outlineLevel !== void 0) this.push(createOutlineLevel(options.outlineLevel));
 		if (options.suppressLineNumbers !== void 0) this.push(new OnOffElement("w:suppressLineNumbers", options.suppressLineNumbers));
 		if (options.autoSpaceEastAsianText !== void 0) this.push(new OnOffElement("w:autoSpaceDN", options.autoSpaceEastAsianText));
+		if (options.suppressAutoHyphens !== void 0) this.push(new OnOffElement("w:suppressAutoHyphens", options.suppressAutoHyphens));
+		if (options.adjustRightInd !== void 0) this.push(new OnOffElement("w:adjustRightInd", options.adjustRightInd));
+		if (options.snapToGrid !== void 0) this.push(new OnOffElement("w:snapToGrid", options.snapToGrid));
+		if (options.mirrorIndents !== void 0) this.push(new OnOffElement("w:mirrorIndents", options.mirrorIndents));
+		if (options.kinsoku !== void 0) this.push(new OnOffElement("w:kinsoku", options.kinsoku));
+		if (options.topLinePunct !== void 0) this.push(new OnOffElement("w:topLinePunct", options.topLinePunct));
+		if (options.autoSpaceDE !== void 0) this.push(new OnOffElement("w:autoSpaceDE", options.autoSpaceDE));
+		if (options.textAlignment !== void 0) this.push(new BuilderElement({
+			attributes: { val: {
+				key: "w:val",
+				value: options.textAlignment
+			} },
+			name: "w:textAlignment"
+		}));
+		if (options.textboxTightWrap !== void 0) this.push(new BuilderElement({
+			attributes: { val: {
+				key: "w:val",
+				value: options.textboxTightWrap
+			} },
+			name: "w:textboxTightWrap"
+		}));
 		if (options.run) this.push(new ParagraphRunProperties(options.run));
 		if (options.revision) this.push(new ParagraphPropertiesChange(options.revision));
 	}
@@ -13052,6 +13153,137 @@ const createDocumentGrid = ({ type, linePitch, charSpace }) => new BuilderElemen
 	name: "w:docGrid"
 });
 //#endregion
+//#region src/file/document/body/section-properties/properties/footnote-endnote-properties.ts
+/**
+* Footnote and endnote properties module for WordprocessingML section properties.
+*
+* Specifies footnote/endnote placement and numbering format within a section.
+*
+* Reference: ISO/IEC 29500-4, CT_FtnProps / CT_EdnProps
+*
+* @module
+*/
+/**
+* Creates footnote properties element (w:footnotePr) for a section.
+*
+* ## XSD Schema
+* ```xml
+* <xsd:complexType name="CT_FtnProps">
+*   <xsd:sequence>
+*     <xsd:element name="pos" type="CT_FtnPos" minOccurs="0"/>
+*     <xsd:element name="numFmt" type="CT_NumFmt" minOccurs="0"/>
+*     <xsd:group ref="EG_FtnEdnNumProps" minOccurs="0"/>
+*   </xsd:sequence>
+* </xsd:complexType>
+* ```
+*/
+const createFootnoteProperties = ({ pos, formatType, format, numStart, numRestart }) => {
+	const container = new FootnoteProperties();
+	if (pos !== void 0) container.addChildElement(new BuilderElement({
+		attributes: { val: {
+			key: "w:val",
+			value: pos
+		} },
+		name: "w:pos"
+	}));
+	if (formatType !== void 0 || format !== void 0) container.addChildElement(new BuilderElement({
+		attributes: {
+			format: {
+				key: "w:format",
+				value: format
+			},
+			val: {
+				key: "w:fmt",
+				value: formatType
+			}
+		},
+		name: "w:numFmt"
+	}));
+	if (numStart !== void 0) container.addChildElement(new BuilderElement({
+		attributes: { val: {
+			key: "w:val",
+			value: decimalNumber(numStart)
+		} },
+		name: "w:numStart"
+	}));
+	if (numRestart !== void 0) container.addChildElement(new BuilderElement({
+		attributes: { val: {
+			key: "w:val",
+			value: numRestart
+		} },
+		name: "w:numRestart"
+	}));
+	return container;
+};
+/**
+* Footnote properties container element.
+*/
+var FootnoteProperties = class extends IgnoreIfEmptyXmlComponent {
+	constructor() {
+		super("w:footnotePr", true);
+	}
+};
+/**
+* Creates endnote properties element (w:endnotePr) for a section.
+*
+* ## XSD Schema
+* ```xml
+* <xsd:complexType name="CT_EdnProps">
+*   <xsd:sequence>
+*     <xsd:element name="pos" type="CT_EdnPos" minOccurs="0"/>
+*     <xsd:element name="numFmt" type="CT_NumFmt" minOccurs="0"/>
+*     <xsd:group ref="EG_FtnEdnNumProps" minOccurs="0"/>
+*   </xsd:sequence>
+* </xsd:complexType>
+* ```
+*/
+const createEndnoteProperties = ({ pos, formatType, format, numStart, numRestart }) => {
+	const container = new EndnoteProperties();
+	if (pos !== void 0) container.addChildElement(new BuilderElement({
+		attributes: { val: {
+			key: "w:val",
+			value: pos
+		} },
+		name: "w:pos"
+	}));
+	if (formatType !== void 0 || format !== void 0) container.addChildElement(new BuilderElement({
+		attributes: {
+			format: {
+				key: "w:format",
+				value: format
+			},
+			val: {
+				key: "w:fmt",
+				value: formatType
+			}
+		},
+		name: "w:numFmt"
+	}));
+	if (numStart !== void 0) container.addChildElement(new BuilderElement({
+		attributes: { val: {
+			key: "w:val",
+			value: decimalNumber(numStart)
+		} },
+		name: "w:numStart"
+	}));
+	if (numRestart !== void 0) container.addChildElement(new BuilderElement({
+		attributes: { val: {
+			key: "w:val",
+			value: numRestart
+		} },
+		name: "w:numRestart"
+	}));
+	return container;
+};
+/**
+* Endnote properties container element.
+*/
+var EndnoteProperties = class extends IgnoreIfEmptyXmlComponent {
+	constructor() {
+		super("w:endnotePr", true);
+	}
+};
+//#endregion
 //#region src/file/document/body/section-properties/properties/header-footer-reference.ts
 /**
 * This simple type specifies the possible types of headers and footers which may be specified for a given header or footer reference in a document. This value determines the page(s) on which the current header or footer shall be displayed.
@@ -13414,8 +13646,12 @@ const PageNumberSeparator = {
 * });
 * ```
 */
-const createPageNumberType = ({ start, formatType, separator }) => new BuilderElement({
+const createPageNumberType = ({ start, formatType, separator, chapStyle }) => new BuilderElement({
 	attributes: {
+		chapStyle: {
+			key: "w:chapStyle",
+			value: chapStyle === void 0 ? void 0 : decimalNumber(chapStyle)
+		},
 		formatType: {
 			key: "w:fmt",
 			value: formatType
@@ -13704,7 +13940,7 @@ const sectionPageSizeDefaults = {
 * ```
 */
 var SectionProperties = class extends XmlComponent {
-	constructor({ page: { size: { width = sectionPageSizeDefaults.WIDTH, height = sectionPageSizeDefaults.HEIGHT, orientation = sectionPageSizeDefaults.ORIENTATION } = {}, margin: { top = sectionMarginDefaults.TOP, right = sectionMarginDefaults.RIGHT, bottom = sectionMarginDefaults.BOTTOM, left = sectionMarginDefaults.LEFT, header = sectionMarginDefaults.HEADER, footer = sectionMarginDefaults.FOOTER, gutter = sectionMarginDefaults.GUTTER } = {}, pageNumbers = {}, borders, textDirection } = {}, grid: { linePitch = 360, charSpace, type: gridType } = {}, headerWrapperGroup = {}, footerWrapperGroup = {}, lineNumbers, titlePage, verticalAlign, column, type, revision } = {}) {
+	constructor({ page: { size: { width = sectionPageSizeDefaults.WIDTH, height = sectionPageSizeDefaults.HEIGHT, orientation = sectionPageSizeDefaults.ORIENTATION } = {}, margin: { top = sectionMarginDefaults.TOP, right = sectionMarginDefaults.RIGHT, bottom = sectionMarginDefaults.BOTTOM, left = sectionMarginDefaults.LEFT, header = sectionMarginDefaults.HEADER, footer = sectionMarginDefaults.FOOTER, gutter = sectionMarginDefaults.GUTTER } = {}, pageNumbers = {}, borders, textDirection } = {}, grid: { linePitch = 360, charSpace, type: gridType } = {}, headerWrapperGroup = {}, footerWrapperGroup = {}, lineNumbers, titlePage, verticalAlign, column, type, revision, noEndnote, bidi, rtlGutter, paperSrc, footnotePr, endnotePr } = {}) {
 		super("w:sectPr");
 		this.addHeaderFooterGroup(HeaderFooterType.HEADER, headerWrapperGroup);
 		this.addHeaderFooterGroup(HeaderFooterType.FOOTER, footerWrapperGroup);
@@ -13723,6 +13959,24 @@ var SectionProperties = class extends XmlComponent {
 		if (titlePage !== void 0) this.root.push(new OnOffElement("w:titlePg", titlePage));
 		if (textDirection) this.root.push(new PageTextDirection(textDirection));
 		if (revision) this.root.push(new SectionPropertiesChange(revision));
+		if (noEndnote !== void 0) this.root.push(new OnOffElement("w:noEndnote", noEndnote));
+		if (bidi !== void 0) this.root.push(new OnOffElement("w:bidi", bidi));
+		if (rtlGutter !== void 0) this.root.push(new OnOffElement("w:rtlGutter", rtlGutter));
+		if (paperSrc) this.root.push(new BuilderElement({
+			attributes: {
+				first: {
+					key: "w:first",
+					value: paperSrc.first === void 0 ? void 0 : decimalNumber(paperSrc.first)
+				},
+				other: {
+					key: "w:other",
+					value: paperSrc.other === void 0 ? void 0 : decimalNumber(paperSrc.other)
+				}
+			},
+			name: "w:paperSrc"
+		}));
+		if (footnotePr) this.root.push(createFootnoteProperties(footnotePr));
+		if (endnotePr) this.root.push(createEndnoteProperties(endnotePr));
 		this.root.push(createDocumentGrid({
 			charSpace,
 			linePitch,
@@ -23400,12 +23654,14 @@ exports.TableProperties = TableProperties;
 exports.TableRow = TableRow;
 exports.TableRowProperties = TableRowProperties;
 exports.TableRowPropertiesChange = TableRowPropertiesChange;
+exports.TextAlignmentType = TextAlignmentType;
 exports.TextDirection = TextDirection;
 exports.TextEffect = TextEffect;
 exports.TextRun = TextRun;
 exports.TextWrappingSide = TextWrappingSide;
 exports.TextWrappingType = TextWrappingType;
 exports.Textbox = Textbox;
+exports.TextboxTightWrapType = TextboxTightWrapType;
 exports.ThematicBreak = ThematicBreak;
 exports.ThemeColor = ThemeColor;
 exports.ThemeFont = ThemeFont;