docx-plus 0.0.1 → 0.0.2

package/README.md

@@ -21,11 +21,12 @@
 
 ## 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`) |
-| Test environment      | jsdom                                     | happy-dom                            |
+|                     | 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                            |
 
 ## Installation
 

package/dist/index.cjs

@@ -25,6 +25,7 @@ let xml_js = require("xml-js");
 let hash_js = require("hash.js");
 hash_js = __toESM(hash_js);
 let nanoid_non_secure = require("nanoid/non-secure");
+let stream = require("stream");
 let fflate = require("fflate");
 let undio = require("undio");
 let xml = require("xml");
@@ -19019,6 +19020,50 @@ var Packer = class Packer {
 	static toArrayBuffer(file, prettify, overrides = []) {
 		return Packer.pack(file, "arraybuffer", prettify, overrides);
 	}
+	/**
+	* Exports a document to a Node.js Readable stream.
+	*
+	* Uses fflate's streaming Zip API to emit compressed chunks incrementally,
+	* avoiding buffering the entire archive in memory before the first byte
+	* is available to the consumer.
+	*
+	* @param file - The document to export
+	* @param prettify - Whether to prettify the XML output
+	* @param overrides - Optional array of file overrides
+	* @returns A readable stream containing the compressed .docx data
+	*
+	* @example
+	* ```typescript
+	* import { createWriteStream } from "fs";
+	* Packer.toStream(doc).pipe(createWriteStream("output.docx"));
+	* ```
+	*/
+	static toStream(file, prettify, overrides = []) {
+		const stream$1 = new stream.Readable({ read() {} });
+		try {
+			const files = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+			const zip = new fflate.Zip((err, chunk, final) => {
+				if (err) {
+					stream$1.destroy(err);
+					return;
+				}
+				if (!stream$1.destroyed) stream$1.push(chunk);
+				if (final) stream$1.push(null);
+			});
+			for (const [name, data] of Object.entries(files)) {
+				var _level;
+				const raw = Array.isArray(data) ? data[0] : data;
+				const level = Array.isArray(data) ? (_level = data[1].level) !== null && _level !== void 0 ? _level : 6 : 6;
+				const entry = level === 0 ? new fflate.ZipPassThrough(name) : new fflate.ZipDeflate(name, { level });
+				zip.add(entry);
+				entry.push(raw, true);
+			}
+			zip.end();
+		} catch (err) {
+			stream$1.destroy(err instanceof Error ? err : new Error(String(err)));
+		}
+		return stream$1;
+	}
 };
 _defineProperty(Packer, "compiler", new Compiler());
 //#endregion

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { Element } from "xml-js";
+import { Readable } from "stream";
 //#region src/file/file-child.d.ts
 declare class FileChild extends XmlComponent {
   readonly fileChild: symbol;
@@ -3166,6 +3167,7 @@ declare class Packer {
   static toBase64String(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<string>;
   static toBlob(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<Blob>;
   static toArrayBuffer(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<ArrayBuffer>;
+  static toStream(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Readable;
   private static readonly compiler;
 }
 //#endregion

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { Element } from "xml-js";
+import { Readable } from "stream";
 //#region src/file/file-child.d.ts
 declare class FileChild extends XmlComponent {
   readonly fileChild: symbol;
@@ -3166,6 +3167,7 @@ declare class Packer {
   static toBase64String(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<string>;
   static toBlob(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<Blob>;
   static toArrayBuffer(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<ArrayBuffer>;
+  static toStream(file: File, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Readable;
   private static readonly compiler;
 }
 //#endregion

package/dist/index.iife.js

@@ -1,4 +1,4 @@
-var docxPlus = (function(exports, xml_js, hash_js, nanoid_non_secure, fflate, undio, xml) {
+var docxPlus = (function(exports, xml_js, hash_js, nanoid_non_secure, stream, fflate, undio, xml) {
 	Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 	//#region \0rolldown/runtime.js
 	var __create = Object.create;
@@ -19014,6 +19014,50 @@ var docxPlus = (function(exports, xml_js, hash_js, nanoid_non_secure, fflate, un
 		static toArrayBuffer(file, prettify, overrides = []) {
 			return Packer.pack(file, "arraybuffer", prettify, overrides);
 		}
+		/**
+		* Exports a document to a Node.js Readable stream.
+		*
+		* Uses fflate's streaming Zip API to emit compressed chunks incrementally,
+		* avoiding buffering the entire archive in memory before the first byte
+		* is available to the consumer.
+		*
+		* @param file - The document to export
+		* @param prettify - Whether to prettify the XML output
+		* @param overrides - Optional array of file overrides
+		* @returns A readable stream containing the compressed .docx data
+		*
+		* @example
+		* ```typescript
+		* import { createWriteStream } from "fs";
+		* Packer.toStream(doc).pipe(createWriteStream("output.docx"));
+		* ```
+		*/
+		static toStream(file, prettify, overrides = []) {
+			const stream$1 = new stream.Readable({ read() {} });
+			try {
+				const files = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+				const zip = new fflate.Zip((err, chunk, final) => {
+					if (err) {
+						stream$1.destroy(err);
+						return;
+					}
+					if (!stream$1.destroyed) stream$1.push(chunk);
+					if (final) stream$1.push(null);
+				});
+				for (const [name, data] of Object.entries(files)) {
+					var _level;
+					const raw = Array.isArray(data) ? data[0] : data;
+					const level = Array.isArray(data) ? (_level = data[1].level) !== null && _level !== void 0 ? _level : 6 : 6;
+					const entry = level === 0 ? new fflate.ZipPassThrough(name) : new fflate.ZipDeflate(name, { level });
+					zip.add(entry);
+					entry.push(raw, true);
+				}
+				zip.end();
+			} catch (err) {
+				stream$1.destroy(err instanceof Error ? err : new Error(String(err)));
+			}
+			return stream$1;
+		}
 	};
 	_defineProperty(Packer, "compiler", new Compiler());
 	//#endregion
@@ -20138,4 +20182,4 @@ var docxPlus = (function(exports, xml_js, hash_js, nanoid_non_secure, fflate, un
 	exports.universalMeasureValue = universalMeasureValue;
 	exports.unsignedDecimalNumber = unsignedDecimalNumber;
 	return exports;
-})({}, xml_js, hash_js, nanoid_non_secure, fflate, undio, xml);
+})({}, xml_js, hash_js, nanoid_non_secure, stream, fflate, undio, xml);

package/dist/index.mjs

@@ -1,7 +1,8 @@
 import { js2xml, xml2js } from "xml-js";
 import hash from "hash.js";
 import { customAlphabet, nanoid } from "nanoid/non-secure";
-import { strFromU8, unzipSync, zipSync } from "fflate";
+import { Readable } from "stream";
+import { Zip, ZipDeflate, ZipPassThrough, strFromU8, unzipSync, zipSync } from "fflate";
 import { textToUint8Array, toUint8Array } from "undio";
 import xml from "xml";
 //#region \0@oxc-project+runtime@0.123.0/helpers/typeof.js
@@ -18994,6 +18995,50 @@ var Packer = class Packer {
 	static toArrayBuffer(file, prettify, overrides = []) {
 		return Packer.pack(file, "arraybuffer", prettify, overrides);
 	}
+	/**
+	* Exports a document to a Node.js Readable stream.
+	*
+	* Uses fflate's streaming Zip API to emit compressed chunks incrementally,
+	* avoiding buffering the entire archive in memory before the first byte
+	* is available to the consumer.
+	*
+	* @param file - The document to export
+	* @param prettify - Whether to prettify the XML output
+	* @param overrides - Optional array of file overrides
+	* @returns A readable stream containing the compressed .docx data
+	*
+	* @example
+	* ```typescript
+	* import { createWriteStream } from "fs";
+	* Packer.toStream(doc).pipe(createWriteStream("output.docx"));
+	* ```
+	*/
+	static toStream(file, prettify, overrides = []) {
+		const stream = new Readable({ read() {} });
+		try {
+			const files = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+			const zip = new Zip((err, chunk, final) => {
+				if (err) {
+					stream.destroy(err);
+					return;
+				}
+				if (!stream.destroyed) stream.push(chunk);
+				if (final) stream.push(null);
+			});
+			for (const [name, data] of Object.entries(files)) {
+				var _level;
+				const raw = Array.isArray(data) ? data[0] : data;
+				const level = Array.isArray(data) ? (_level = data[1].level) !== null && _level !== void 0 ? _level : 6 : 6;
+				const entry = level === 0 ? new ZipPassThrough(name) : new ZipDeflate(name, { level });
+				zip.add(entry);
+				entry.push(raw, true);
+			}
+			zip.end();
+		} catch (err) {
+			stream.destroy(err instanceof Error ? err : new Error(String(err)));
+		}
+		return stream;
+	}
 };
 _defineProperty(Packer, "compiler", new Compiler());
 //#endregion

package/dist/index.umd.js

@@ -1,14 +1,15 @@
 (function(global, factory) {
-	typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("xml-js"), require("hash.js"), require("nanoid/non-secure"), require("fflate"), require("undio"), require("xml")) : typeof define === "function" && define.amd ? define([
+	typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("xml-js"), require("hash.js"), require("nanoid/non-secure"), require("stream"), require("fflate"), require("undio"), require("xml")) : typeof define === "function" && define.amd ? define([
 		"exports",
 		"xml-js",
 		"hash.js",
 		"nanoid/non-secure",
+		"stream",
 		"fflate",
 		"undio",
 		"xml"
-	], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global.docxPlus = {}, global.xml_js, global.hash_js, global.nanoid_non_secure, global.fflate, global.undio, global.xml));
-})(this, function(exports, xml_js, hash_js, nanoid_non_secure, fflate, undio, xml) {
+	], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global.docxPlus = {}, global.xml_js, global.hash_js, global.nanoid_non_secure, global.stream, global.fflate, global.undio, global.xml));
+})(this, function(exports, xml_js, hash_js, nanoid_non_secure, stream, fflate, undio, xml) {
 	Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 	//#region \0rolldown/runtime.js
 	var __create = Object.create;
@@ -19024,6 +19025,50 @@
 		static toArrayBuffer(file, prettify, overrides = []) {
 			return Packer.pack(file, "arraybuffer", prettify, overrides);
 		}
+		/**
+		* Exports a document to a Node.js Readable stream.
+		*
+		* Uses fflate's streaming Zip API to emit compressed chunks incrementally,
+		* avoiding buffering the entire archive in memory before the first byte
+		* is available to the consumer.
+		*
+		* @param file - The document to export
+		* @param prettify - Whether to prettify the XML output
+		* @param overrides - Optional array of file overrides
+		* @returns A readable stream containing the compressed .docx data
+		*
+		* @example
+		* ```typescript
+		* import { createWriteStream } from "fs";
+		* Packer.toStream(doc).pipe(createWriteStream("output.docx"));
+		* ```
+		*/
+		static toStream(file, prettify, overrides = []) {
+			const stream$1 = new stream.Readable({ read() {} });
+			try {
+				const files = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+				const zip = new fflate.Zip((err, chunk, final) => {
+					if (err) {
+						stream$1.destroy(err);
+						return;
+					}
+					if (!stream$1.destroyed) stream$1.push(chunk);
+					if (final) stream$1.push(null);
+				});
+				for (const [name, data] of Object.entries(files)) {
+					var _level;
+					const raw = Array.isArray(data) ? data[0] : data;
+					const level = Array.isArray(data) ? (_level = data[1].level) !== null && _level !== void 0 ? _level : 6 : 6;
+					const entry = level === 0 ? new fflate.ZipPassThrough(name) : new fflate.ZipDeflate(name, { level });
+					zip.add(entry);
+					entry.push(raw, true);
+				}
+				zip.end();
+			} catch (err) {
+				stream$1.destroy(err instanceof Error ? err : new Error(String(err)));
+			}
+			return stream$1;
+		}
 	};
 	_defineProperty(Packer, "compiler", new Compiler());
 	//#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx-plus",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
   "keywords": [
     "clippy",