@ooxml-tools/xml 0.5.0 → 0.7.2

package/dist/npm/cjs/index.js

@@ -0,0 +1,185 @@
+'use strict';
+
+var xmlJs = require('xml-js');
+
+function asXmlElement(xml) {
+    if (typeof xml === "string") {
+        return xmlJs.xml2js(xml, {
+            compact: false,
+            captureSpacesBetweenElements: false,
+        });
+    }
+    else {
+        return xml;
+    }
+}
+
+/**
+ * @param templateStrings template strings
+ * @param templateValues tamplate values
+ * @returns xml string
+ */
+function safeXml(templateStrings, ...templateValues) {
+    let xml = "";
+    for (let i = 0; i < templateStrings.length; i++) {
+        if (templateValues[i] !== undefined && templateValues[i] !== null) {
+            const value = templateValues[i];
+            const xmlPart = Array.isArray(value) ? value.join("") : value;
+            xml += `${templateStrings[i]}${xmlPart}`;
+        }
+        else {
+            xml += `${templateStrings[i]}`;
+        }
+    }
+    if (process.env.NODE_ENV === "development") {
+        // This will "throw" if the XML is invalid
+        xmlJs.xml2js(xml, {
+            compact: false,
+            captureSpacesBetweenElements: false,
+        });
+    }
+    return xml;
+}
+
+function cdata(input) {
+    if (input === null || input === undefined) {
+        return "";
+    }
+    return `<![CDATA[${input}]]>`;
+}
+
+function compact(xml) {
+    const parsed = xmlJs.xml2js(xml, {
+        compact: false,
+        trim: true,
+    });
+    return xmlJs.js2xml(parsed);
+}
+
+function _collapseFragments(orig) {
+    var _a;
+    let node = orig;
+    const cloneIfRequired = () => {
+        if (node === orig) {
+            return Object.assign(Object.assign({}, node), { elements: node.elements ? [...node.elements] : undefined });
+        }
+        return node;
+    };
+    if (node.elements) {
+        for (let i = node.elements.length - 1; i >= 0; i--) {
+            if (node.elements) {
+                const child = node.elements[i];
+                const out = _collapseFragments(child);
+                if (Array.isArray(out)) {
+                    node = cloneIfRequired();
+                    node.elements.splice(i, 1, ...out);
+                }
+                else if (out !== child) {
+                    node = cloneIfRequired();
+                    if (node.elements) {
+                        node.elements[i] = out;
+                    }
+                }
+            }
+        }
+    }
+    if (node.name === "XML_FRAGMENT") {
+        return (_a = node.elements) !== null && _a !== void 0 ? _a : [];
+    }
+    return node;
+}
+function collapseFragments(root) {
+    const out = _collapseFragments(asXmlElement(root));
+    return out;
+}
+
+function format(input, { spaces = 2 } = {}) {
+    const elementJson = xmlJs.xml2js(input, {
+        compact: false,
+        captureSpacesBetweenElements: false,
+    });
+    return xmlJs.js2xml(elementJson, {
+        spaces: spaces,
+        compact: false,
+        indentText: true,
+        fullTagEmptyElement: true,
+        indentAttributes: true,
+    });
+}
+
+function createFragment(elements) {
+    return {
+        type: "element",
+        name: "XML_FRAGMENT",
+        elements: elements,
+    };
+}
+
+const TEST_ATTR_NAME = "_testid";
+
+function getAllByTestIdRecursive(root, id, collection) {
+    var _a;
+    const testAttrValue = (_a = root.attributes) === null || _a === void 0 ? void 0 : _a[TEST_ATTR_NAME];
+    if (testAttrValue === id) {
+        collection.push(root);
+    }
+    if (root.elements) {
+        for (const element of root.elements) {
+            getAllByTestIdRecursive(element, id, collection);
+        }
+    }
+    return collection;
+}
+function getAllByTestId(root, id) {
+    return getAllByTestIdRecursive(root, id, []);
+}
+
+function getByTestId(root, id) {
+    const elements = getAllByTestId(root, id);
+    if (elements.length > 1) {
+        throw new Error(`Only expected 1 element with ${TEST_ATTR_NAME}='${id}'`);
+    }
+    return elements[0];
+}
+
+function getSingleTextNode(element) {
+    if (element) {
+        const elements = element.elements;
+        if (elements && elements.length === 1 && elements[0].type === "text") {
+            return elements[0];
+        }
+    }
+    throw new Error("Not a single text node");
+}
+
+function removeTestIdsRecursive(root) {
+    var _a;
+    const attributes = root.attributes ? Object.assign({}, root.attributes) : undefined;
+    if (attributes) {
+        delete attributes[TEST_ATTR_NAME];
+    }
+    return Object.assign(Object.assign({}, root), { attributes, elements: (_a = root.elements) === null || _a === void 0 ? void 0 : _a.map((element) => {
+            return removeTestIdsRecursive(element);
+        }) });
+}
+function removeTestIds(root) {
+    return removeTestIdsRecursive(root);
+}
+
+// Remove all "special" content from the XML 
+function clean(element) {
+    return collapseFragments(removeTestIds(element));
+}
+
+exports.asXmlElement = asXmlElement;
+exports.cdata = cdata;
+exports.clean = clean;
+exports.collapseFragments = collapseFragments;
+exports.compact = compact;
+exports.createFragment = createFragment;
+exports.format = format;
+exports.getAllByTestId = getAllByTestId;
+exports.getByTestId = getByTestId;
+exports.getSingleTextNode = getSingleTextNode;
+exports.removeTestIds = removeTestIds;
+exports.safeXml = safeXml;

package/dist/npm/{types.d.ts → cjs/types.d.ts}

@@ -7,9 +7,9 @@ declare function asXmlElement(xml: string | Element): Element;
  * @param templateValues tamplate values
  * @returns xml string
  */
-declare function safeXml(templateStrings: TemplateStringsArray, ...templateValues: (undefined | null | string | number | (string | number)[])[]): string;
+declare function safeXml(templateStrings: TemplateStringsArray, ...templateValues: (undefined | null | string | number | (undefined | null | string | number)[])[]): string;
 
-declare function cdata(input: string | number): string;
+declare function cdata(input: string | number | null | undefined): string;
 
 declare function compact(xml: string): string;
 

package/dist/npm/{index.js → es/index.js}

@@ -40,6 +40,9 @@ function safeXml(templateStrings, ...templateValues) {
 }
 
 function cdata(input) {
+    if (input === null || input === undefined) {
+        return "";
+    }
     return `<![CDATA[${input}]]>`;
 }
 

package/dist/npm/es/types.d.ts

@@ -0,0 +1,36 @@
+import { Element, ElementCompact } from 'xml-js';
+
+declare function asXmlElement(xml: string | Element): Element;
+
+/**
+ * @param templateStrings template strings
+ * @param templateValues tamplate values
+ * @returns xml string
+ */
+declare function safeXml(templateStrings: TemplateStringsArray, ...templateValues: (undefined | null | string | number | (undefined | null | string | number)[])[]): string;
+
+declare function cdata(input: string | number | null | undefined): string;
+
+declare function compact(xml: string): string;
+
+declare function collapseFragments(root: string | Element): Element | Element[];
+
+type FormatOptions = {
+    spaces?: number;
+};
+declare function format(input: string, { spaces }?: FormatOptions): string;
+
+declare function createFragment(elements: Element[]): Element;
+
+declare function getAllByTestId(root: Element | ElementCompact, id: string): (Element | ElementCompact)[];
+
+declare function getByTestId(root: Element | ElementCompact, id: string): Element | ElementCompact | undefined;
+
+declare function getSingleTextNode(element: Element | ElementCompact | undefined): Element;
+
+declare function removeTestIds(root: Element | ElementCompact): Element;
+
+declare function clean(element: Element | ElementCompact): Element | Element[];
+
+export { asXmlElement, cdata, clean, collapseFragments, compact, createFragment, format, getAllByTestId, getByTestId, getSingleTextNode, removeTestIds, safeXml };
+export type { FormatOptions };

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@ooxml-tools/xml",
   "description": "Some XML helpers to help with OOXML development",
-  "version": "0.5.0",
+  "version": "0.7.2",
   "license": "MIT",
-  "main": "./dist/npm/index.js",
-  "types": "./dist/npm/types.d.ts",
   "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ooxml-tools/xml"
+  },
   "scripts": {
     "lint": "npx prettier . --check",
     "test": "vitest run --coverage",
@@ -13,6 +15,18 @@
     "lint:format": "npx prettier . --write",
     "build": "rollup -c rollup.config.ts --configPlugin typescript"
   },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/npm/es/index.js",
+        "default": "./dist/npm/es/types.d.ts"
+      },
+      "require": {
+        "types": "./dist/npm/cjs/index.js",
+        "default": "./dist/npm/cjs/types.d.ts"
+      }
+    }
+  },
   "files": [
     "./dist/npm",
     "./package.json",