docx-plus 0.0.4 → 0.0.5

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Dolan
+Copyright (c) 2016 Dolan, Demo Macro
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,21 +1,11 @@
-<p align="center">
-    <img src="./logo/logo-animate.svg" width="100%" height="300" alt="docx-plus">
-</p>
-
-<p align="center">
-    Easily generate and modify .docx files with JS/TS. Works for Node and on the Browser.
-</p>
-
----
+# docx-plus
 
 [![NPM version][npm-image]][npm-url]
 [![Downloads per month][downloads-image]][downloads-url]
 [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
-[![Known Vulnerabilities][snky-image]][snky-url]
 [![PRs Welcome][pr-image]][pr-url]
-[codecov][codecov-image][codecov-url]
 
-# docx-plus
+Easily generate and modify .docx files with JS/TS. Works for Node and on the Browser.
 
 **docx-plus** is an enhanced fork of [docx](https://github.com/dolanmiu/docx) — a TypeScript/JavaScript library for generating and modifying Word documents (.docx) programmatically with a declarative API.
 
@@ -27,6 +17,15 @@
 | 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`) |
 
 ## Installation
 
@@ -88,9 +87,5 @@ Contributions are welcome! Please feel free to submit pull requests.
 [downloads-url]: https://npmjs.org/package/docx-plus
 [github-actions-workflow-image]: https://github.com/DemoMacro/docx-plus/workflows/Default/badge.svg?branch=main
 [github-actions-workflow-url]: https://github.com/DemoMacro/docx-plus/actions
-[snky-image]: https://snyk.io/test/github/DemoMacro/docx-plus/badge.svg
-[snky-url]: https://snyk.io/test/github/DemoMacro/docx-plus
 [pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
 [pr-url]: http://makeapullrequest.com
-[codecov-image]: https://codecov.io/gh/DemoMacro/docx-plus/branch/main/graph/badge.svg
-[codecov-url]: https://codecov.io/gh/DemoMacro/docx-plus

package/dist/index.cjs

@@ -389,6 +389,9 @@ var Attributes = class extends XmlAttributeComponent {
 			rsidSect: "w:rsidSect",
 			space: "w:space",
 			sz: "w:sz",
+			themeColor: "w:themeColor",
+			themeShade: "w:themeShade",
+			themeTint: "w:themeTint",
 			top: "w:top",
 			type: "w:type",
 			val: "w:val",
@@ -915,6 +918,49 @@ const pointMeasureValue = unsignedDecimalNumber;
 * ```
 */
 const dateTimeValue = (val) => val.toISOString();
+/**
+* Theme color values used throughout OOXML for referencing document theme colors.
+*
+* Reference: ST_ThemeColor in OOXML specification
+*
+* @publicApi
+*/
+const ThemeColor = {
+	DARK1: "dark1",
+	LIGHT1: "light1",
+	DARK2: "dark2",
+	LIGHT2: "light2",
+	ACCENT1: "accent1",
+	ACCENT2: "accent2",
+	ACCENT3: "accent3",
+	ACCENT4: "accent4",
+	ACCENT5: "accent5",
+	ACCENT6: "accent6",
+	HYPERLINK: "hyperlink",
+	FOLLOWED_HYPERLINK: "followedHyperlink",
+	NONE: "none",
+	BACKGROUND1: "background1",
+	TEXT1: "text1",
+	BACKGROUND2: "background2",
+	TEXT2: "text2"
+};
+/**
+* Theme font values used for referencing document theme fonts.
+*
+* Reference: ST_Theme in OOXML specification
+*
+* @publicApi
+*/
+const ThemeFont = {
+	MAJOR_EAST_ASIA: "majorEastAsia",
+	MAJOR_BIDI: "majorBidi",
+	MAJOR_ASCII: "majorAscii",
+	MAJOR_H_ANSI: "majorHAnsi",
+	MINOR_EAST_ASIA: "minorEastAsia",
+	MINOR_BIDI: "minorBidi",
+	MINOR_ASCII: "minorAscii",
+	MINOR_H_ANSI: "minorHAnsi"
+};
 //#endregion
 //#region src/file/xml-components/simple-elements.ts
 /**
@@ -1327,12 +1373,20 @@ const createAlignment = (type) => new BuilderElement({
 * });
 * ```
 */
-const createBorderElement = (elementName, { color, size, space, style }) => new BuilderElement({
+const createBorderElement = (elementName, { color, size, space, style, themeColor, themeTint, themeShade, shadow, frame }) => new BuilderElement({
 	attributes: {
 		color: {
 			key: "w:color",
 			value: color === void 0 ? void 0 : hexColorValue(color)
 		},
+		frame: {
+			key: "w:frame",
+			value: frame
+		},
+		shadow: {
+			key: "w:shadow",
+			value: shadow
+		},
 		size: {
 			key: "w:sz",
 			value: size === void 0 ? void 0 : eighthPointMeasureValue(size)
@@ -1344,6 +1398,18 @@ const createBorderElement = (elementName, { color, size, space, style }) => new
 		style: {
 			key: "w:val",
 			value: style
+		},
+		themeColor: {
+			key: "w:themeColor",
+			value: themeColor
+		},
+		themeShade: {
+			key: "w:themeShade",
+			value: themeShade === void 0 ? void 0 : uCharHexNumber(themeShade)
+		},
+		themeTint: {
+			key: "w:themeTint",
+			value: themeTint === void 0 ? void 0 : uCharHexNumber(themeTint)
 		}
 	},
 	name: elementName
@@ -1547,20 +1613,32 @@ var ThematicBreak = class extends XmlComponent {
 * </xsd:complexType>
 * ```
 */
-const createIndent = ({ start, end, left, right, hanging, firstLine }) => new BuilderElement({
+const createIndent = ({ start, startChars, end, endChars, left, right, hanging, hangingChars, firstLine, firstLineChars }) => new BuilderElement({
 	attributes: {
 		end: {
 			key: "w:end",
 			value: end === void 0 ? void 0 : signedTwipsMeasureValue(end)
 		},
+		endChars: {
+			key: "w:endChars",
+			value: endChars === void 0 ? void 0 : decimalNumber(endChars)
+		},
 		firstLine: {
 			key: "w:firstLine",
 			value: firstLine === void 0 ? void 0 : twipsMeasureValue(firstLine)
 		},
+		firstLineChars: {
+			key: "w:firstLineChars",
+			value: firstLineChars === void 0 ? void 0 : decimalNumber(firstLineChars)
+		},
 		hanging: {
 			key: "w:hanging",
 			value: hanging === void 0 ? void 0 : twipsMeasureValue(hanging)
 		},
+		hangingChars: {
+			key: "w:hangingChars",
+			value: hangingChars === void 0 ? void 0 : decimalNumber(hangingChars)
+		},
 		left: {
 			key: "w:left",
 			value: left === void 0 ? void 0 : signedTwipsMeasureValue(left)
@@ -1572,6 +1650,10 @@ const createIndent = ({ start, end, left, right, hanging, firstLine }) => new Bu
 		start: {
 			key: "w:start",
 			value: start === void 0 ? void 0 : signedTwipsMeasureValue(start)
+		},
+		startChars: {
+			key: "w:startChars",
+			value: startChars === void 0 ? void 0 : decimalNumber(startChars)
 		}
 	},
 	name: "w:ind"
@@ -2022,7 +2104,7 @@ var CurrentSection = class extends XmlComponent {
 *
 * Reference: http://officeopenxml.com/WPshading.php
 */
-const createShading = ({ fill, color, type }) => new BuilderElement({
+const createShading = ({ fill, color, type, themeColor, themeTint, themeShade, themeFill, themeFillTint, themeFillShade }) => new BuilderElement({
 	attributes: {
 		color: {
 			key: "w:color",
@@ -2032,6 +2114,30 @@ const createShading = ({ fill, color, type }) => new BuilderElement({
 			key: "w:fill",
 			value: fill === void 0 ? void 0 : hexColorValue(fill)
 		},
+		themeColor: {
+			key: "w:themeColor",
+			value: themeColor
+		},
+		themeFill: {
+			key: "w:themeFill",
+			value: themeFill
+		},
+		themeFillShade: {
+			key: "w:themeFillShade",
+			value: themeFillShade === void 0 ? void 0 : uCharHexNumber(themeFillShade)
+		},
+		themeFillTint: {
+			key: "w:themeFillTint",
+			value: themeFillTint === void 0 ? void 0 : uCharHexNumber(themeFillTint)
+		},
+		themeShade: {
+			key: "w:themeShade",
+			value: themeShade === void 0 ? void 0 : uCharHexNumber(themeShade)
+		},
+		themeTint: {
+			key: "w:themeTint",
+			value: themeTint === void 0 ? void 0 : uCharHexNumber(themeTint)
+		},
 		type: {
 			key: "w:val",
 			value: type
@@ -2210,7 +2316,13 @@ var InsertionTrackChange = class extends XmlComponent {
 *
 * @publicApi
 */
-const EmphasisMarkType = { DOT: "dot" };
+const EmphasisMarkType = {
+	NONE: "none",
+	COMMA: "comma",
+	CIRCLE: "circle",
+	DOT: "dot",
+	UNDER_DOT: "underDot"
+};
 /**
 * Creates an emphasis mark element for a WordprocessingML document.
 *
@@ -2301,16 +2413,27 @@ var CharacterSpacing = class extends XmlComponent {
 *
 * @example
 * ```typescript
-* new Color("FF0000"); // Red text
+* new Color("FF0000"); // Red text (backward compatible)
 * new Color("auto"); // Automatic color
+* new Color({ themeColor: ThemeColor.ACCENT1, themeTint: "99" }); // Theme color with tint
 * ```
 *
 * @internal
 */
 var Color = class extends XmlComponent {
-	constructor(color) {
+	constructor(colorOrOptions) {
 		super("w:color");
-		this.root.push(new Attributes({ val: hexColorValue(color) }));
+		if (typeof colorOrOptions === "string") {
+			this.root.push(new Attributes({ val: hexColorValue(colorOrOptions) }));
+			return;
+		}
+		const opts = colorOrOptions;
+		this.root.push(new Attributes({
+			val: opts.val === void 0 ? void 0 : hexColorValue(opts.val),
+			themeColor: opts.themeColor,
+			themeTint: opts.themeTint === void 0 ? void 0 : uCharHexNumber(opts.themeTint),
+			themeShade: opts.themeShade === void 0 ? void 0 : uCharHexNumber(opts.themeShade)
+		}));
 	}
 };
 /**
@@ -2509,18 +2632,34 @@ const createRunFonts = (nameOrAttrs, hint) => {
 				key: "w:ascii",
 				value: attrs.ascii
 			},
+			asciiTheme: {
+				key: "w:asciiTheme",
+				value: attrs.asciiTheme
+			},
 			cs: {
 				key: "w:cs",
 				value: attrs.cs
 			},
+			cstheme: {
+				key: "w:cstheme",
+				value: attrs.cstheme
+			},
 			eastAsia: {
 				key: "w:eastAsia",
 				value: attrs.eastAsia
 			},
+			eastAsiaTheme: {
+				key: "w:eastAsiaTheme",
+				value: attrs.eastAsiaTheme
+			},
 			hAnsi: {
 				key: "w:hAnsi",
 				value: attrs.hAnsi
 			},
+			hAnsiTheme: {
+				key: "w:hAnsiTheme",
+				value: attrs.hAnsiTheme
+			},
 			hint: {
 				key: "w:hint",
 				value: attrs.hint
@@ -2677,12 +2816,24 @@ const UnderlineType = {
 * createUnderline(UnderlineType.WAVE, "FF0000");
 * ```
 */
-const createUnderline = (underlineType = UnderlineType.SINGLE, color) => new BuilderElement({
+const createUnderline = (underlineType = UnderlineType.SINGLE, color, themeColor, themeTint, themeShade) => new BuilderElement({
 	attributes: {
 		color: {
 			key: "w:color",
 			value: color === void 0 ? void 0 : hexColorValue(color)
 		},
+		themeColor: {
+			key: "w:themeColor",
+			value: themeColor
+		},
+		themeShade: {
+			key: "w:themeShade",
+			value: themeShade === void 0 ? void 0 : uCharHexNumber(themeShade)
+		},
+		themeTint: {
+			key: "w:themeTint",
+			value: themeTint === void 0 ? void 0 : uCharHexNumber(themeTint)
+		},
 		val: {
 			key: "w:val",
 			value: underlineType
@@ -2834,6 +2985,9 @@ var RunProperties = class extends IgnoreIfEmptyXmlComponent {
 		if (options.doubleStrike !== void 0) this.push(new OnOffElement("w:dstrike", options.doubleStrike));
 		if (options.emboss !== void 0) this.push(new OnOffElement("w:emboss", options.emboss));
 		if (options.imprint !== void 0) this.push(new OnOffElement("w:imprint", options.imprint));
+		if (options.outline !== void 0) this.push(new OnOffElement("w:outline", options.outline));
+		if (options.shadow !== void 0) this.push(new OnOffElement("w:shadow", options.shadow));
+		if (options.webHidden !== void 0) this.push(new OnOffElement("w:webHidden", options.webHidden));
 		if (options.noProof !== void 0) this.push(new OnOffElement("w:noProof", options.noProof));
 		if (options.snapToGrid !== void 0) this.push(new OnOffElement("w:snapToGrid", options.snapToGrid));
 		if (options.vanish) this.push(new OnOffElement("w:vanish", options.vanish));
@@ -2859,6 +3013,8 @@ var RunProperties = class extends IgnoreIfEmptyXmlComponent {
 		if (options.language) this.push(createLanguageComponent(options.language));
 		if (options.specVanish) this.push(new OnOffElement("w:specVanish", options.vanish));
 		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.revision) this.push(new RunPropertiesChange(options.revision));
 	}
 	push(item) {
@@ -3294,18 +3450,6 @@ const generateUuidPart = (count) => (0, nanoid_non_secure.customAlphabet)("12345
 * ```
 */
 const uniqueUuid = () => `${generateUuidPart(8)}-${generateUuidPart(4)}-${generateUuidPart(4)}-${generateUuidPart(4)}-${generateUuidPart(12)}`;
-/**
-* Encode a string to UTF-8 bytes.
-*
-* This is used to pre-encode XML content before passing to fflate's zipSync,
-* which expects Uint8Array input for text content.
-*
-* The copy via `new Uint8Array()` ensures the returned array uses the
-* current module's Uint8Array constructor, avoiding cross-realm issues
-* in test environments (happy-dom) where TextEncoder returns a different
-* realm's Uint8Array.
-*/
-const encodeUtf8 = (str) => new Uint8Array(new TextEncoder().encode(str));
 //#endregion
 //#region src/file/drawing/floating/floating-position.ts
 /**
@@ -6968,7 +7112,7 @@ const LineRuleType = {
 * });
 * ```
 */
-const createSpacing = ({ after, before, line, lineRule, beforeAutoSpacing, afterAutoSpacing }) => new BuilderElement({
+const createSpacing = ({ after, before, line, lineRule, beforeAutoSpacing, afterAutoSpacing, beforeLines, afterLines }) => new BuilderElement({
 	attributes: {
 		after: {
 			key: "w:after",
@@ -6978,6 +7122,10 @@ const createSpacing = ({ after, before, line, lineRule, beforeAutoSpacing, after
 			key: "w:afterAutospacing",
 			value: afterAutoSpacing
 		},
+		afterLines: {
+			key: "w:afterLines",
+			value: afterLines === void 0 ? void 0 : decimalNumber(afterLines)
+		},
 		before: {
 			key: "w:before",
 			value: before
@@ -6986,6 +7134,10 @@ const createSpacing = ({ after, before, line, lineRule, beforeAutoSpacing, after
 			key: "w:beforeAutospacing",
 			value: beforeAutoSpacing
 		},
+		beforeLines: {
+			key: "w:beforeLines",
+			value: beforeLines === void 0 ? void 0 : decimalNumber(beforeLines)
+		},
 		line: {
 			key: "w:line",
 			value: line
@@ -7096,6 +7248,7 @@ const TabStopType = {
 */
 const LeaderType = {
 	DOT: "dot",
+	HEAVY: "heavy",
 	HYPHEN: "hyphen",
 	MIDDLE_DOT: "middleDot",
 	NONE: "none",
@@ -21706,13 +21859,12 @@ var Compiler = class {
 		const footerFormattedViews = /* @__PURE__ */ new Map();
 		const xmlifiedFileMapping = this.xmlifyFile(file, headerFormattedViews, footerFormattedViews, prettifyXml);
 		const map = new Map(Object.entries(xmlifiedFileMapping));
-		for (const [, obj] of map) if (Array.isArray(obj)) for (const subFile of obj) files[subFile.path] = encodeUtf8(subFile.data);
-		else files[obj.path] = encodeUtf8(obj.data);
-		for (const subFile of overrides) files[subFile.path] = encodeUtf8(subFile.data);
-		for (const mediaData of file.Media.Array) if (mediaData.type !== "svg") files[`word/media/${mediaData.fileName}`] = [(0, undio.toUint8Array)(mediaData.data), { level: 0 }];
-		else {
+		for (const [, obj] of map) if (Array.isArray(obj)) for (const subFile of obj) files[subFile.path] = (0, undio.textToUint8Array)(subFile.data);
+		else files[obj.path] = (0, undio.textToUint8Array)(obj.data);
+		for (const subFile of overrides) files[subFile.path] = (0, undio.textToUint8Array)(subFile.data);
+		for (const mediaData of file.Media.Array) {
 			files[`word/media/${mediaData.fileName}`] = [(0, undio.toUint8Array)(mediaData.data), { level: 0 }];
-			files[`word/media/${mediaData.fallback.fileName}`] = [(0, undio.toUint8Array)(mediaData.fallback.data), { level: 0 }];
+			if (mediaData.type === "svg") files[`word/media/${mediaData.fallback.fileName}`] = [(0, undio.toUint8Array)(mediaData.fallback.data), { level: 0 }];
 		}
 		for (const { data: buffer, name, fontKey } of file.FontTable.fontOptionsWithKey) {
 			const [nameWithoutExtension] = name.split(".");
@@ -23255,6 +23407,8 @@ exports.TextWrappingSide = TextWrappingSide;
 exports.TextWrappingType = TextWrappingType;
 exports.Textbox = Textbox;
 exports.ThematicBreak = ThematicBreak;
+exports.ThemeColor = ThemeColor;
+exports.ThemeFont = ThemeFont;
 exports.UnderlineType = UnderlineType;
 exports.VerticalAlign = VerticalAlign;
 exports.VerticalAlignSection = VerticalAlignSection;
@@ -23333,7 +23487,6 @@ exports.dateTimeValue = dateTimeValue;
 exports.decimalNumber = decimalNumber;
 exports.docPropertiesUniqueNumericIdGen = docPropertiesUniqueNumericIdGen;
 exports.eighthPointMeasureValue = eighthPointMeasureValue;
-exports.encodeUtf8 = encodeUtf8;
 exports.hashedId = hashedId;
 exports.hexColorValue = hexColorValue;
 exports.hpsMeasureValue = hpsMeasureValue;