@office-open/core 0.3.0 → 0.3.1

package/dist/archive.d.mts

@@ -17,6 +17,13 @@ declare function readXmlFromZip(zip: Map<string, Uint8Array>, path: string): Ele
  * Read a binary file from the zip.
  */
 declare function readBinaryFromZip(zip: Map<string, Uint8Array>, path: string): Uint8Array | undefined;
+/**
+ * Parse all XML files in the zip into Element trees.
+ * Skips media files, binary files, and the main document/presentation file.
+ */
+declare function readAllXmlParts(zip: Map<string, Uint8Array>, options?: {
+  skipPaths?: string[];
+}): Record<string, Element>;
 /**
  * List all files in the zip matching a prefix.
  */
@@ -38,5 +45,14 @@ interface Relationship {
 declare function parseRels(zip: Map<string, Uint8Array>, path: string): Relationship[];
 declare function findRel(rels: Relationship[], id: string): Relationship | undefined;
 declare function findRelsByType(rels: Relationship[], typeSubstring: string): Relationship[];
+/**
+ * Zip a map of path → Uint8Array/string into a ZIP buffer.
+ * XML strings are auto-encoded to UTF-8 bytes.
+ */
+declare function zipToBuffer(files: Map<string, Uint8Array | string>): Uint8Array;
+/**
+ * Serialize an Element tree to an XML string.
+ */
+declare function elementToXml(el: Element): string;
 //#endregion
-export { Relationship, findRel, findRelsByType, getImageType, listFiles, parseRels, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap };
+export { Relationship, elementToXml, findRel, findRelsByType, getImageType, listFiles, parseRels, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap, zipToBuffer };

package/dist/archive.mjs

@@ -1,5 +1,5 @@
-import { attr, xml2js } from "@office-open/xml";
-import { strFromU8, unzipSync } from "fflate";
+import { attr, js2xml, xml2js } from "@office-open/xml";
+import { strFromU8, strToU8, unzipSync, zipSync } from "fflate";
 //#region src/archive.ts
 const XML_PARSE_OPTIONS = {
 	nativeTypeAttributes: true,
@@ -37,6 +37,21 @@ function readBinaryFromZip(zip, path) {
 	return zip.get(path);
 }
 /**
+* Parse all XML files in the zip into Element trees.
+* Skips media files, binary files, and the main document/presentation file.
+*/
+function readAllXmlParts(zip, options) {
+	const parts = {};
+	const skip = new Set(options?.skipPaths ?? []);
+	for (const path of zip.keys()) {
+		if (skip.has(path)) continue;
+		if (path.startsWith("word/media/") || path.startsWith("ppt/media/") || path.startsWith("xl/media/") || path.endsWith(".png") || path.endsWith(".jpg") || path.endsWith(".jpeg") || path.endsWith(".gif") || path.endsWith(".bmp") || path.endsWith(".tif") || path.endsWith(".tiff") || path.endsWith(".emf") || path.endsWith(".wmf") || path.endsWith(".svg") || path.endsWith(".wav") || path.endsWith(".mp3") || path.endsWith(".mp4") || path.endsWith(".avi") || path.endsWith(".wmv") || path.endsWith(".thmx") || path.endsWith(".bin")) continue;
+		const el = readXmlFromZip(zip, path);
+		if (el) parts[path] = el;
+	}
+	return parts;
+}
+/**
 * List all files in the zip matching a prefix.
 */
 function listFiles(zip, prefix) {
@@ -48,8 +63,12 @@ function listFiles(zip, prefix) {
 * Convert Uint8Array to base64 string.
 */
 function uint8ToBase64(data) {
+	const chunkSize = 8192;
 	let binary = "";
-	for (let i = 0; i < data.length; i++) binary += String.fromCharCode(data[i]);
+	for (let i = 0; i < data.length; i += chunkSize) {
+		const chunk = data.subarray(i, Math.min(i + chunkSize, data.length));
+		binary += String.fromCharCode(...chunk);
+	}
 	return btoa(binary);
 }
 /**
@@ -97,5 +116,20 @@ function findRel(rels, id) {
 function findRelsByType(rels, typeSubstring) {
 	return rels.filter((r) => r.type.includes(typeSubstring));
 }
+/**
+* Zip a map of path → Uint8Array/string into a ZIP buffer.
+* XML strings are auto-encoded to UTF-8 bytes.
+*/
+function zipToBuffer(files) {
+	const entries = {};
+	for (const [path, data] of files) entries[path] = typeof data === "string" ? strToU8(data) : data;
+	return zipSync(entries);
+}
+/**
+* Serialize an Element tree to an XML string.
+*/
+function elementToXml(el) {
+	return js2xml(el);
+}
 //#endregion
-export { findRel, findRelsByType, getImageType, listFiles, parseRels, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap };
+export { elementToXml, findRel, findRelsByType, getImageType, listFiles, parseRels, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap, zipToBuffer };

package/dist/index.d.mts

@@ -1,7 +1,8 @@
-import { Relationship, findRel, findRelsByType, getImageType, listFiles, parseRels, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap } from "./archive.mjs";
+import { Relationship, elementToXml, findRel, findRelsByType, getImageType, listFiles, parseRels, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap, zipToBuffer } from "./archive.mjs";
 import { A as IContext, C as AttributePayload, D as IgnoreIfEmptyXmlComponent, E as EMPTY_OBJECT, M as IXmlableObject, O as XmlComponent, S as AttributeMap, T as XmlAttributeComponent, _ as stringContainerObj, a as BuilderElement, b as wrapEl, c as NumberValueElement, d as StringEnumValueElement, f as StringValueElement, g as onOffObj, h as numberValObj, i as convertToXmlComponent, j as IXmlAttribute, k as BaseXmlComponent, l as OnOffElement, m as hpsMeasureObj, n as ImportedRootElementAttributes, o as EmptyElement, p as chartAttr, r as ImportedXmlComponent, s as HpsMeasureElement, t as InitializableXmlComponent, u as StringContainer, v as stringEnumValObj, w as NextAttributeComponent, x as AttributeData, y as stringValObj } from "./_chunks/index-3uVYzs32.mjs";
 import { C as universalMeasureValue, S as uCharHexNumber, _ as positiveUniversalMeasureValue, a as ThemeColor, b as signedTwipsMeasureValue, c as dateTimeValue, d as hexColorValue, f as hpsMeasureValue, g as pointMeasureValue, h as percentageValue, i as RelativeMeasure, l as decimalNumber, m as measurementOrPercentValue, n as PositivePercentage, o as ThemeFont, p as longHexNumber, r as PositiveUniversalMeasure, s as UniversalMeasure, t as Percentage, u as eighthPointMeasureValue, v as shortHexNumber, w as unsignedDecimalNumber, x as twipsMeasureValue, y as signedHpsMeasureValue } from "./_chunks/values-BrGywpRh.mjs";
 import { COLOR_CATEGORIES, Connection, DataModel, ISmartArtData, ITreeNode, LAYOUT_CATEGORIES, Point, STYLE_CATEGORIES, SmartArtCollection, TransPoint, createDataModel } from "./smartart/index.mjs";
+import { Element } from "@office-open/xml";
 
 //#region src/converters.d.ts
 /**
@@ -123,4 +124,33 @@ interface CoreProperties {
 }
 declare function parseCoreProperties(zip: Map<string, Uint8Array>): CoreProperties;
 //#endregion
-export { AppProperties, AttributeData, AttributeMap, AttributePayload, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, CoreProperties, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IContext, ISmartArtData, ITreeNode, IXmlAttribute, IXmlableObject, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, NextAttributeComponent, NumberValueElement, OnOffElement, OutputByType, OutputType, Percentage, Point, PositivePercentage, PositiveUniversalMeasure, Relationship, type RelationshipType, Relationships, RelativeMeasure, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, UniqueNumericIdCreator, UniversalMeasure, XmlAttributeComponent, XmlComponent, chartAttr, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertPixelsToEmu, convertPointsToEmu, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, findRel, findRelsByType, getImageType, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readBinaryFromZip, readTextFromZip, readXmlFromZip, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl };
+//#region src/parser.d.ts
+/**
+ * Wrapper for unknown/unhandled XML elements in parsed output.
+ * Enables lossless round-trip: unknown elements are preserved as Element trees
+ * and can be serialized back via js2xml() during reconstruction.
+ */
+interface RawElement {
+  $raw: true;
+  element: Element;
+}
+/** Type guard for RawElement */
+declare function isRaw(el: unknown): el is RawElement;
+/**
+ * Mixed content array: typed children interleaved with unknown raw elements,
+ * preserving original document order for lossless round-trip.
+ */
+type MixedChildren<T> = Array<T | RawElement>;
+//#endregion
+//#region src/raw-passthrough.d.ts
+/**
+ * Thin wrapper that passes a raw Element tree through the XML serialization pipeline.
+ * Used to include parsed-but-unrecognized XML in generated documents.
+ */
+declare class RawPassthrough extends BaseXmlComponent {
+  private readonly element;
+  constructor(element: Element);
+  prepForXml(_context: IContext): IXmlableObject;
+}
+//#endregion
+export { AppProperties, AttributeData, AttributeMap, AttributePayload, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, CoreProperties, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IContext, ISmartArtData, ITreeNode, IXmlAttribute, IXmlableObject, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, MixedChildren, NextAttributeComponent, NumberValueElement, OnOffElement, OutputByType, OutputType, Percentage, Point, PositivePercentage, PositiveUniversalMeasure, RawElement, RawPassthrough, Relationship, type RelationshipType, Relationships, RelativeMeasure, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, UniqueNumericIdCreator, UniversalMeasure, XmlAttributeComponent, XmlComponent, chartAttr, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertPixelsToEmu, convertPointsToEmu, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, elementToXml, findRel, findRelsByType, getImageType, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, isRaw, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl, zipToBuffer };

package/dist/index.mjs

@@ -2,7 +2,7 @@ import { C as EMPTY_OBJECT, E as BaseXmlComponent, S as XmlAttributeComponent, T
 import { ThemeColor, ThemeFont, dateTimeValue, decimalNumber, eighthPointMeasureValue, hexColorValue, hpsMeasureValue, longHexNumber, measurementOrPercentValue, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, twipsMeasureValue, uCharHexNumber, universalMeasureValue, unsignedDecimalNumber } from "./values.mjs";
 import { a as convertEmuToInches, c as convertInchesToEmu, d as convertPixelsToEmu, f as convertPointsToEmu, i as uniqueUuid, l as convertInchesToTwip, n as uniqueId, o as convertEmuToPixels, r as uniqueNumericIdCreator, s as convertEmuToPoints, t as hashedId, u as convertMillimetersToTwip } from "./_chunks/id-generators-Ch07cHW1.mjs";
 import { COLOR_CATEGORIES, Connection, DataModel, LAYOUT_CATEGORIES, Point, STYLE_CATEGORIES, SmartArtCollection, TransPoint, createDataModel } from "./smartart/index.mjs";
-import { findRel, findRelsByType, getImageType, listFiles, parseRels, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap } from "./archive.mjs";
+import { elementToXml, findRel, findRelsByType, getImageType, listFiles, parseRels, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap, zipToBuffer } from "./archive.mjs";
 import { textOf } from "@office-open/xml";
 //#region src/opc/app-properties.ts
 var AppPropertiesAttributes = class extends XmlAttributeComponent {
@@ -115,4 +115,46 @@ function parseCoreProperties(zip) {
 	return props;
 }
 //#endregion
-export { AppProperties, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, NextAttributeComponent, NumberValueElement, OnOffElement, Point, Relationships, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, XmlAttributeComponent, XmlComponent, chartAttr, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertPixelsToEmu, convertPointsToEmu, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, findRel, findRelsByType, getImageType, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readBinaryFromZip, readTextFromZip, readXmlFromZip, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl };
+//#region src/parser.ts
+/** Type guard for RawElement */
+function isRaw(el) {
+	return typeof el === "object" && el !== null && el.$raw === true;
+}
+//#endregion
+//#region src/raw-passthrough.ts
+/**
+* Convert an Element tree to xml-js compact format (IXmlableObject).
+* Always wraps in a named key so the element name is preserved even for empty elements.
+*/
+function elementToCompact(el) {
+	const inner = {};
+	if (el.attributes && Object.keys(el.attributes).length > 0) inner._attributes = el.attributes;
+	if (el.cdata) inner._cdata = el.cdata;
+	else if (el.text != null) inner._text = el.text;
+	if (el.elements) for (const child of el.elements) {
+		const key = child.name ?? "_unknown";
+		const compactChild = elementToCompact(child);
+		if (inner[key]) {
+			if (!Array.isArray(inner[key])) inner[key] = [inner[key]];
+			inner[key].push(compactChild);
+		} else inner[key] = compactChild;
+	}
+	const name = el.name ?? "unknown";
+	if (Object.keys(inner).length === 0) return { [name]: {} };
+	return { [name]: inner };
+}
+/**
+* Thin wrapper that passes a raw Element tree through the XML serialization pipeline.
+* Used to include parsed-but-unrecognized XML in generated documents.
+*/
+var RawPassthrough = class extends BaseXmlComponent {
+	constructor(element) {
+		super(element.name ?? "unknown");
+		this.element = element;
+	}
+	prepForXml(_context) {
+		return elementToCompact(this.element);
+	}
+};
+//#endregion
+export { AppProperties, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, NextAttributeComponent, NumberValueElement, OnOffElement, Point, RawPassthrough, Relationships, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, XmlAttributeComponent, XmlComponent, chartAttr, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertPixelsToEmu, convertPointsToEmu, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, elementToXml, findRel, findRelsByType, getImageType, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, isRaw, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl, zipToBuffer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@office-open/core",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Shared OOXML infrastructure: XmlComponent, value validators, unit converters",
   "keywords": [
     "core",
@@ -59,7 +59,7 @@
     "fflate": "0.8.2",
     "hash.js": "1.1.7",
     "nanoid": "5.1.9",
-    "@office-open/xml": "0.3.0"
+    "@office-open/xml": "0.3.1"
   },
   "scripts": {
     "dev": "basis build --stub",