@office-open/xml 0.3.1 → 0.3.3

package/dist/index.d.mts

@@ -32,9 +32,19 @@ declare function escapeXml(str: string): string;
  * Handles already-escaped entities to prevent double-escaping.
  */
 declare function escapeAttributeValue(str: string): string;
+/**
+ * Build an XML attribute string fragment from a record.
+ * `undefined` values are automatically skipped.
+ * String values are escaped via `escapeXml`.
+ *
+ * @example
+ * attrs({ id: 1, name: "foo", hidden: undefined })
+ * // => ' id="1" name="foo"'
+ */
+declare function attrs(record: Record<string, string | number | boolean | undefined>): string;
 //#endregion
 //#region src/json.d.ts
 /** Convert XML string to JSON string — xml-js compatible export */
 declare function xml2json(xml: string, options?: Xml2JsOptions): string;
 //#endregion
-export { Attributes, DeclarationAttributes, Element, ElementCompact, ElementObject, IgnoreOptions, Js2XmlOptions, Xml2JsOptions, XmlAtom, XmlAttrs, XmlDesc, XmlDescArray, XmlObject, XmlOption, allChildren, attr, attrBool, attrNum, childCount, childText, children, collectText, colorAttr, escapeAttributeValue, escapeXml, findChild, findDeep, hasChild, js2xml, json2xml, textOf, toElement, xml, xml2js, xml2json };
+export { Attributes, DeclarationAttributes, Element, ElementCompact, ElementObject, IgnoreOptions, Js2XmlOptions, Xml2JsOptions, XmlAtom, XmlAttrs, XmlDesc, XmlDescArray, XmlObject, XmlOption, allChildren, attr, attrBool, attrNum, attrs, childCount, childText, children, collectText, colorAttr, escapeAttributeValue, escapeXml, findChild, findDeep, hasChild, js2xml, json2xml, textOf, toElement, xml, xml2js, xml2json };

package/dist/index.mjs

@@ -19,6 +19,20 @@ function escapeXml(str) {
 function escapeAttributeValue(str) {
 	return String(str).replace(/&(?!amp;|lt;|gt;|quot;|apos;)/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
 }
+/**
+* Build an XML attribute string fragment from a record.
+* `undefined` values are automatically skipped.
+* String values are escaped via `escapeXml`.
+*
+* @example
+* attrs({ id: 1, name: "foo", hidden: undefined })
+* // => ' id="1" name="foo"'
+*/
+function attrs(record) {
+	let s = "";
+	for (const [k, v] of Object.entries(record)) if (v !== void 0) s += ` ${k}="${typeof v === "string" ? escapeXml(v) : v}"`;
+	return s;
+}
 //#endregion
 //#region src/serialize.ts
 const DEFAULT_INDENT = "    ";
@@ -37,7 +51,8 @@ function xml(input, options) {
 	}
 	const items = Array.isArray(input) ? input : [input];
 	for (let i = 0; i < items.length; i++) {
-		parts.push(formatElement(resolve(items[i], opts.indent, 0)));
+		const keys = Object.keys(items[i]);
+		parts.push(formatElement(keys[0], items[i][keys[0]], opts.indent, 0));
 		if (opts.indent && i < items.length - 1) parts.push("\n");
 	}
 	return parts.join("");
@@ -51,71 +66,50 @@ function normalizeOptions$1(options) {
 		declaration: opts.declaration
 	};
 }
-function resolve(data, indent, depth) {
-	const name = Object.keys(data)[0];
-	const values = data[name];
-	const attributes = [];
-	const content = [];
-	if (values == null) return {
-		name,
-		attributes,
-		content,
-		indent,
-		depth,
-		emptyArray: false
-	};
-	switch (typeof values) {
-		case "object":
-			if (values._attr) for (const key of Object.keys(values._attr)) attributes.push(`${key}="${escapeXml(String(values._attr[key]))}"`);
-			if (values._attributes) for (const key of Object.keys(values._attributes)) attributes.push(`${key}="${escapeXml(String(values._attributes[key]))}"`);
-			if (values._cdata) {
-				const escaped = String(values._cdata).replace(/\]\]>/g, "]]]]><![CDATA[>");
-				content.push(`<![CDATA[${escaped}]]>`);
-			}
-			if (Array.isArray(values)) {
-				if (values.length === 0) return {
-					name,
-					attributes,
-					content,
-					indent,
-					depth,
-					emptyArray: true
-				};
-				for (const value of values) if (value && typeof value === "object" && "_attr" in value) for (const key of Object.keys(value._attr)) attributes.push(`${key}="${escapeXml(String(value._attr[key]))}"`);
-				else if (value && typeof value === "object" && "_attributes" in value) for (const key of Object.keys(value._attributes)) attributes.push(`${key}="${escapeXml(String(value._attributes[key]))}"`);
-				else if (value && typeof value === "object") content.push(resolve(value, indent, depth + 1));
-				else if (value != null) content.push(escapeXml(String(value)));
-			}
-			break;
-		default: content.push(escapeXml(String(values)));
+/**
+* Single-pass XML formatter: directly converts IXmlableObject to string,
+* eliminating the intermediate ResolvedElement tree.
+*/
+function formatElement(name, values, indent, depth) {
+	const attrParts = [];
+	const textParts = [];
+	const elemParts = [];
+	let emptyArray = false;
+	if (values == null) {
+		const attrStr = attrParts.length ? " " + attrParts.join(" ") : "";
+		return `${indent ? indent.repeat(depth) : ""}<${name}${attrStr}/>`;
 	}
-	return {
-		name,
-		attributes,
-		content,
-		indent,
-		depth,
-		emptyArray: false
-	};
-}
-function formatElement(elem) {
-	const { name, attributes, content, indent, depth } = elem;
-	const hasChildren = content.length > 0;
+	if (typeof values === "object") {
+		if (values._attr) for (const key of Object.keys(values._attr)) attrParts.push(`${key}="${escapeXml(String(values._attr[key]))}"`);
+		if (values._attributes) for (const key of Object.keys(values._attributes)) attrParts.push(`${key}="${escapeXml(String(values._attributes[key]))}"`);
+		if (values._cdata) {
+			const escaped = String(values._cdata).replace(/\]\]>/g, "]]]]><![CDATA[>");
+			textParts.push(`<![CDATA[${escaped}]]>`);
+		}
+		if (Array.isArray(values)) {
+			if (values.length === 0) emptyArray = true;
+			else for (const value of values) if (value && typeof value === "object" && "_attr" in value) for (const key of Object.keys(value._attr)) attrParts.push(`${key}="${escapeXml(String(value._attr[key]))}"`);
+			else if (value && typeof value === "object" && "_attributes" in value) for (const key of Object.keys(value._attributes)) attrParts.push(`${key}="${escapeXml(String(value._attributes[key]))}"`);
+			else if (value && typeof value === "object") {
+				const childKeys = Object.keys(value);
+				elemParts.push(formatElement(childKeys[0], value[childKeys[0]], indent, depth + 1));
+			} else if (value != null) textParts.push(escapeXml(String(value)));
+		}
+	} else textParts.push(escapeXml(String(values)));
 	const ind = indent ? indent.repeat(depth) : "";
-	const attrStr = attributes.length ? " " + attributes.join(" ") : "";
-	if (!hasChildren) {
-		if (elem.emptyArray) return `${ind}<${name}${attrStr}></${name}>`;
-		return `${ind}<${name}${attrStr}/>`;
-	}
-	const textContent = content.length === 1 && typeof content[0] === "string" ? content[0] : null;
-	if (textContent !== null && !indent) return `<${name}${attrStr}>${textContent}</${name}>`;
-	if (textContent !== null) return `${ind}<${name}${attrStr}>${textContent}</${name}>`;
+	const attrStr = attrParts.length ? " " + attrParts.join(" ") : "";
+	if (textParts.length + elemParts.length === 0) return emptyArray ? `${ind}<${name}${attrStr}></${name}>` : `${ind}<${name}${attrStr}/>`;
+	if (elemParts.length === 0 && textParts.length === 1) return indent ? `${ind}<${name}${attrStr}>${textParts[0]}</${name}>` : `<${name}${attrStr}>${textParts[0]}</${name}>`;
 	const parts = [];
 	parts.push(`${ind}<${name}${attrStr}>`);
 	if (indent) parts.push("\n");
-	for (const child of content) {
-		if (typeof child === "string") parts.push(`${indent.repeat(depth + 1)}${child}`);
-		else parts.push(formatElement(child));
+	const childIndent = indent ? indent.repeat(depth + 1) : "";
+	for (const t of textParts) {
+		parts.push(`${childIndent}${t}`);
+		if (indent) parts.push("\n");
+	}
+	for (const e of elemParts) {
+		parts.push(e);
 		if (indent) parts.push("\n");
 	}
 	parts.push(`${ind}</${name}>`);
@@ -502,4 +496,4 @@ function xml2json(xml, options) {
 	return JSON.stringify(xml2js(xml, options));
 }
 //#endregion
-export { allChildren, attr, attrBool, attrNum, childCount, childText, children, collectText, colorAttr, escapeAttributeValue, escapeXml, findChild, findDeep, hasChild, js2xml, json2xml, textOf, toElement, xml, xml2js, xml2json };
+export { allChildren, attr, attrBool, attrNum, attrs, childCount, childText, children, collectText, colorAttr, escapeAttributeValue, escapeXml, findChild, findDeep, hasChild, js2xml, json2xml, textOf, toElement, xml, xml2js, xml2json };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@office-open/xml",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "XML parsing and serialization for Office Open XML. Zero dependencies, drop-in replacement for xml + xml-js.",
   "keywords": [
     "office-open",