xml-disassembler 1.10.12 → 1.10.13

package/dist/index.mjs

@@ -1,14 +1,14 @@
 import { getLogger, configure } from 'log4js';
-import { readFile, readdir, stat, writeFile, rm, mkdir, unlink } from 'node:fs/promises';
-import { join, dirname, basename } from 'node:path/posix';
+import { readFile, writeFile, rm, readdir, stat, mkdir, unlink } from 'node:fs/promises';
+import { dirname, basename, join } from 'node:path/posix';
 import { existsSync } from 'node:fs';
-import { resolve, relative, dirname as dirname$1, join as join$1, basename as basename$1, extname } from 'node:path';
+import { relative, resolve, dirname as dirname$1, join as join$1, basename as basename$1, extname } from 'node:path';
 import ignore from 'ignore';
 import { XMLParser, XMLBuilder } from 'fast-xml-parser';
-import { parse as parse$1, stringify as stringify$1 } from 'json5';
-import { parse as parse$2, stringify as stringify$2 } from 'smol-toml';
-import { parse as parse$3, stringify as stringify$3 } from 'ini';
-import { parse, stringify } from 'yaml';
+import { parse as parse$2, stringify as stringify$1 } from 'json5';
+import { parse as parse$1, stringify as stringify$2 } from 'smol-toml';
+import { parse, stringify as stringify$3 } from 'ini';
+import { parse as parse$3, stringify } from 'yaml';
 import { createHash } from 'node:crypto';
 import { readFile as readFile$1 } from 'fs/promises';
 
@@ -53,34 +53,49 @@ function mergeXmlElements(elements) {
     const rootKey = Object.keys(first).find((k) => k !== "?xml");
     const mergedContent = {};
     for (const element of elements) {
-        const current = element[rootKey];
-        for (const [childKey, value] of Object.entries(current)) {
-            if (Array.isArray(value)) {
-                mergedContent[childKey] = [...value];
-            }
-            else if (typeof value === "object") {
-                if (Array.isArray(mergedContent[childKey])) {
-                    mergedContent[childKey].push(value);
-                }
-                else if (mergedContent[childKey]) {
-                    mergedContent[childKey] = [mergedContent[childKey], value];
-                }
-                else {
-                    mergedContent[childKey] = value;
-                }
-            }
-            else {
-                if (!mergedContent.hasOwnProperty(childKey)) {
-                    mergedContent[childKey] = value;
-                }
-            }
+        mergeElementContent(mergedContent, element[rootKey]);
+    }
+    return buildFinalXmlElement(first["?xml"], rootKey, mergedContent);
+}
+function mergeElementContent(target, source) {
+    for (const [key, value] of Object.entries(source)) {
+        if (Array.isArray(value)) {
+            mergeArrayValue(target, key, value);
+        }
+        else if (isMergeableObject(value)) {
+            mergeObjectValue(target, key, value);
+        }
+        else {
+            mergePrimitiveValue(target, key, value);
         }
     }
-    const declaration = first["?xml"];
-    const finalMerged = declaration
-        ? { "?xml": declaration, [rootKey]: mergedContent }
-        : { [rootKey]: mergedContent };
-    return finalMerged;
+}
+function mergeArrayValue(target, key, value) {
+    target[key] = [...value];
+}
+function mergeObjectValue(target, key, value) {
+    if (Array.isArray(target[key])) {
+        target[key].push(value);
+    }
+    else if (target[key]) {
+        target[key] = [target[key], value];
+    }
+    else {
+        target[key] = value;
+    }
+}
+function mergePrimitiveValue(target, key, value) {
+    if (!Object.prototype.hasOwnProperty.call(target, key)) {
+        target[key] = value;
+    }
+}
+function isMergeableObject(value) {
+    return typeof value === "object" && value !== null;
+}
+function buildFinalXmlElement(declaration, rootKey, content) {
+    return declaration
+        ? { "?xml": declaration, [rootKey]: content }
+        : { [rootKey]: content };
 }
 
 const INDENT = "    ";
@@ -97,25 +112,33 @@ const XML_PARSER_OPTION = {
 };
 const JSON_PARSER_OPTION = Object.assign(Object.assign({}, XML_PARSER_OPTION), { format: true, indentBy: INDENT, suppressBooleanAttributes: false, suppressEmptyNode: false });
 
+function isEmptyTextNode(key, value) {
+    return key === "#text" && typeof value === "string" && value.trim() === "";
+}
+function cleanArray(arr) {
+    return arr
+        .map(stripWhitespaceTextNodes)
+        .filter((entry) => !(typeof entry === "object" && Object.keys(entry).length === 0));
+}
+function cleanObject(obj) {
+    const result = {};
+    for (const key in obj) {
+        const value = obj[key];
+        if (isEmptyTextNode(key, value))
+            continue;
+        const cleaned = stripWhitespaceTextNodes(value);
+        if (cleaned !== undefined) {
+            result[key] = cleaned;
+        }
+    }
+    return result;
+}
 function stripWhitespaceTextNodes(node) {
     if (Array.isArray(node)) {
-        return node.map(stripWhitespaceTextNodes).filter((entry) => {
-            return !(typeof entry === "object" && Object.keys(entry).length === 0);
-        });
+        return cleanArray(node);
     }
     else if (typeof node === "object" && node !== null) {
-        const result = {};
-        for (const key in node) {
-            const value = node[key];
-            if (key === "#text" && typeof value === "string" && value.trim() === "") {
-                continue;
-            }
-            const cleaned = stripWhitespaceTextNodes(value);
-            if (cleaned !== undefined) {
-                result[key] = cleaned;
-            }
-        }
-        return result;
+        return cleanObject(node);
     }
     else {
         return node;
@@ -139,90 +162,91 @@ function parseXML(filePath) {
     });
 }
 
+const parsers = {
+    ".yaml": parse$3,
+    ".yml": parse$3,
+    ".json": JSON.parse,
+    ".json5": parse$2,
+    ".toml": parse$1,
+    ".ini": parse,
+};
 function parseToXmlObject(filePath) {
     return __awaiter(this, void 0, void 0, function* () {
         if (filePath.endsWith(".xml")) {
             return yield parseXML(filePath);
         }
+        const ext = Object.keys(parsers).find((ext) => filePath.endsWith(ext));
         const fileContent = yield readFile$1(filePath, "utf-8");
-        let parsed;
-        if (filePath.endsWith(".yaml") || filePath.endsWith(".yml")) {
-            parsed = parse(fileContent);
-        }
-        else if (filePath.endsWith(".json5")) {
-            parsed = parse$1(fileContent);
-        }
-        else if (filePath.endsWith(".json")) {
-            parsed = JSON.parse(fileContent);
-        }
-        else if (filePath.endsWith(".toml")) {
-            parsed = parse$2(fileContent);
-        }
-        else if (filePath.endsWith(".ini")) {
-            parsed = parse$3(fileContent);
-        }
-        return parsed;
+        return parsers[ext](fileContent);
     });
 }
 
 class ReassembleXMLFileHandler {
+    reassemble(xmlAttributes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { filePath, fileExtension, postPurge = false } = xmlAttributes;
+            if (!(yield this._validateDirectory(filePath)))
+                return;
+            logger.debug(`Parsing directory to reassemble: ${filePath}`);
+            const parsedXmlObjects = yield this.processFilesInDirectory(filePath);
+            if (!parsedXmlObjects.length) {
+                this._logEmptyParseError(filePath);
+                return;
+            }
+            const mergedXml = mergeXmlElements(parsedXmlObjects);
+            const finalXml = buildXMLString(mergedXml);
+            const outputPath = this._getOutputPath(filePath, fileExtension);
+            yield writeFile(outputPath, finalXml, "utf-8");
+            if (postPurge)
+                yield rm(filePath, { recursive: true });
+        });
+    }
     processFilesInDirectory(dirPath) {
         return __awaiter(this, void 0, void 0, function* () {
             const parsedXmlObjects = [];
             const files = yield readdir(dirPath);
-            files.sort((fileA, fileB) => {
-                const fullNameA = fileA.split(".")[0].toLowerCase();
-                const fullNameB = fileB.split(".")[0].toLowerCase();
-                return fullNameA.localeCompare(fullNameB);
-            });
-            for (const file of files) {
+            const sortedFiles = this._sortFilesByBaseName(files);
+            for (const file of sortedFiles) {
                 const filePath = join(dirPath, file);
                 const fileStat = yield stat(filePath);
-                if (fileStat.isFile()) {
-                    if (/\.(xml|json|json5|ya?ml|toml|ini)$/.test(file)) {
-                        const parsedObject = yield parseToXmlObject(filePath);
-                        if (parsedObject === undefined)
-                            continue;
-                        parsedXmlObjects.push(parsedObject);
-                    }
+                if (fileStat.isFile() && this._isParsableFile(file)) {
+                    const parsed = yield parseToXmlObject(filePath);
+                    if (parsed)
+                        parsedXmlObjects.push(parsed);
                 }
                 else if (fileStat.isDirectory()) {
-                    const subParsedObjects = yield this.processFilesInDirectory(filePath);
-                    parsedXmlObjects.push(...subParsedObjects);
+                    const subParsed = yield this.processFilesInDirectory(filePath);
+                    parsedXmlObjects.push(...subParsed);
                 }
             }
             return parsedXmlObjects;
         });
     }
-    reassemble(xmlAttributes) {
+    _sortFilesByBaseName(files) {
+        return files.sort((a, b) => a.split(".")[0].localeCompare(b.split(".")[0]));
+    }
+    _isParsableFile(fileName) {
+        return /\.(xml|json|json5|ya?ml|toml|ini)$/i.test(fileName);
+    }
+    _validateDirectory(path) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { filePath, fileExtension, postPurge = false } = xmlAttributes;
-            const fileStat = yield stat(filePath);
-            if (!fileStat.isDirectory()) {
-                logger.error(`The provided path to reassemble is not a directory: ${filePath}`);
-                return;
-            }
-            logger.debug(`Parsing directory to reassemble: ${filePath}`);
-            const parsedXmlObjects = yield this.processFilesInDirectory(filePath);
-            if (!parsedXmlObjects.length) {
-                logger.error(`No files under ${filePath} were parsed successfully. A reassembled XML file was not created.`);
-                return;
-            }
-            const mergedXml = mergeXmlElements(parsedXmlObjects);
-            const xmlContent = buildXMLString(mergedXml);
-            const finalXml = xmlContent;
-            const parentDirectory = dirname(filePath);
-            const subdirectoryBasename = basename(filePath);
-            const fileName = fileExtension
-                ? `${subdirectoryBasename}.${fileExtension}`
-                : `${subdirectoryBasename}.xml`;
-            const outputPath = join(parentDirectory, fileName);
-            yield writeFile(outputPath, finalXml, "utf-8");
-            if (postPurge) {
-                yield rm(filePath, { recursive: true });
+            const stats = yield stat(path);
+            if (!stats.isDirectory()) {
+                logger.error(`The provided path to reassemble is not a directory: ${path}`);
+                return false;
             }
+            return true;
         });
     }
+    _logEmptyParseError(path) {
+        logger.error(`No files under ${path} were parsed successfully. A reassembled XML file was not created.`);
+    }
+    _getOutputPath(dirPath, extension) {
+        const parentDir = dirname(dirPath);
+        const baseName = basename(dirPath);
+        const fileName = `${baseName}.${extension !== null && extension !== void 0 ? extension : "xml"}`;
+        return join(parentDir, fileName);
+    }
 }
 
 function buildXMLString(element) {
@@ -297,13 +321,16 @@ function findDirectFieldMatch(element, fieldNames) {
 function findNestedFieldMatch(element, uniqueIdElements) {
     for (const key in element) {
         const child = element[key];
-        if (typeof child === "object" && child !== null) {
-            const result = parseUniqueIdElement(child, uniqueIdElements);
-            if (result)
-                return result;
-        }
+        if (!isObject(child))
+            continue;
+        const result = parseUniqueIdElement(child, uniqueIdElements);
+        if (result)
+            return result;
     }
 }
+function isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
 function createShortHash(element) {
     const hash = createHash("sha256")
         .update(JSON.stringify(element))
@@ -415,10 +442,8 @@ function buildDisassembledFilesUnified(_a) {
             strategy,
             format,
         });
-        if (!hasNestedElements && leafCount > 0) {
-            logger.error(`The XML file ${filePath} only has leaf elements. This file will not be disassembled.`);
+        if (shouldAbortForLeafOnly(leafCount, hasNestedElements, filePath))
             return;
-        }
         yield writeNestedGroups(nestedGroups, strategy, {
             disassembledPath,
             rootElementName,
@@ -426,25 +451,42 @@ function buildDisassembledFilesUnified(_a) {
             xmlDeclaration,
             format,
         });
-        if (leafCount > 0) {
-            const finalLeafContent = strategy === "grouped-by-tag"
-                ? orderXmlElementKeys(leafContent, keyOrder)
-                : leafContent;
-            yield buildDisassembledFile({
-                content: finalLeafContent,
+        yield writeLeafContentIfAny({
+            leafCount,
+            leafContent,
+            strategy,
+            keyOrder,
+            options: {
                 disassembledPath,
                 outputFileName: `${baseName}.${format}`,
                 rootElementName,
                 rootAttributes,
                 xmlDeclaration,
                 format,
-            });
-        }
+            },
+        });
         if (postPurge) {
             yield unlink(filePath);
         }
     });
 }
+function shouldAbortForLeafOnly(leafCount, hasNestedElements, filePath) {
+    if (!hasNestedElements && leafCount > 0) {
+        logger.error(`The XML file ${filePath} only has leaf elements. This file will not be disassembled.`);
+        return true;
+    }
+    return false;
+}
+function writeLeafContentIfAny(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ leafCount, leafContent, strategy, keyOrder, options, }) {
+        if (leafCount === 0)
+            return;
+        const finalLeafContent = strategy === "grouped-by-tag"
+            ? orderXmlElementKeys(leafContent, keyOrder)
+            : leafContent;
+        yield buildDisassembledFile(Object.assign({ content: finalLeafContent }, options));
+    });
+}
 function getRootInfo(parsedXml) {
     const rawDeclaration = parsedXml["?xml"];
     const xmlDeclaration = typeof rawDeclaration === "object" && rawDeclaration !== null
@@ -540,68 +582,83 @@ class DisassembleXMLFileHandler {
                 logger.warn(`Unsupported strategy "${strategy}", defaulting to "unique-id".`);
                 strategy = "unique-id";
             }
-            const resolvedIgnorePath = resolve(ignorePath);
-            if (existsSync(resolvedIgnorePath)) {
-                const content = yield readFile(resolvedIgnorePath);
-                this.ign.add(content.toString());
-            }
+            yield this._loadIgnoreRules(ignorePath);
             const fileStat = yield stat(filePath);
             const relativePath = this.posixPath(relative(process.cwd(), filePath));
             if (fileStat.isFile()) {
-                const resolvedPath = resolve(filePath);
-                if (!resolvedPath.endsWith(".xml")) {
-                    logger.error(`The file path provided is not an XML file: ${resolvedPath}`);
-                    return;
-                }
-                if (this.ign.ignores(relativePath)) {
-                    logger.warn(`File ignored by ${ignorePath}: ${resolvedPath}`);
-                    return;
-                }
-                const dirPath = dirname$1(resolvedPath);
-                yield this.processFile({
-                    dirPath,
-                    strategy,
-                    filePath: resolvedPath,
+                yield this._handleFile(filePath, relativePath, {
                     uniqueIdElements,
+                    strategy,
                     prePurge,
                     postPurge,
                     format,
                 });
             }
             else if (fileStat.isDirectory()) {
-                const subFiles = yield readdir(filePath);
-                for (const subFile of subFiles) {
-                    const subFilePath = join$1(filePath, subFile);
-                    const relativeSubFilePath = this.posixPath(relative(process.cwd(), subFilePath));
-                    if (subFilePath.endsWith(".xml") &&
-                        !this.ign.ignores(relativeSubFilePath)) {
-                        yield this.processFile({
-                            dirPath: filePath,
-                            strategy,
-                            filePath: subFilePath,
-                            uniqueIdElements,
-                            prePurge,
-                            postPurge,
-                            format,
-                        });
-                    }
-                    else if (this.ign.ignores(relativeSubFilePath)) {
-                        logger.warn(`File ignored by ${ignorePath}: ${subFilePath}`);
-                    }
+                yield this._handleDirectory(filePath, {
+                    uniqueIdElements,
+                    strategy,
+                    prePurge,
+                    postPurge,
+                    format,
+                    ignorePath,
+                });
+            }
+        });
+    }
+    _loadIgnoreRules(ignorePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resolvedIgnorePath = resolve(ignorePath);
+            if (existsSync(resolvedIgnorePath)) {
+                const content = yield readFile(resolvedIgnorePath);
+                this.ign.add(content.toString());
+            }
+        });
+    }
+    _handleFile(filePath, relativePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resolvedPath = resolve(filePath);
+            if (!this._isXmlFile(resolvedPath)) {
+                logger.error(`The file path provided is not an XML file: ${resolvedPath}`);
+                return;
+            }
+            if (this.ign.ignores(relativePath)) {
+                logger.warn(`File ignored by ignore rules: ${resolvedPath}`);
+                return;
+            }
+            const dirPath = dirname$1(resolvedPath);
+            yield this.processFile(Object.assign(Object.assign({}, options), { dirPath, filePath: resolvedPath }));
+        });
+    }
+    _handleDirectory(dirPath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const subFiles = yield readdir(dirPath);
+            for (const subFile of subFiles) {
+                const subFilePath = join$1(dirPath, subFile);
+                const relativeSubFilePath = this.posixPath(relative(process.cwd(), subFilePath));
+                if (this._isXmlFile(subFilePath) &&
+                    !this.ign.ignores(relativeSubFilePath)) {
+                    yield this.processFile(Object.assign(Object.assign({}, options), { dirPath, filePath: subFilePath }));
+                }
+                else if (this.ign.ignores(relativeSubFilePath)) {
+                    logger.warn(`File ignored by ignore rules: ${subFilePath}`);
                 }
             }
         });
     }
+    _isXmlFile(filePath) {
+        return filePath.endsWith(".xml");
+    }
     processFile(xmlAttributes) {
         return __awaiter(this, void 0, void 0, function* () {
             const { dirPath, strategy, filePath, uniqueIdElements, prePurge, postPurge, format, } = xmlAttributes;
             logger.debug(`Parsing file to disassemble: ${filePath}`);
             const fullName = basename$1(filePath, extname(filePath));
             const baseName = fullName.split(".")[0];
-            let outputPath;
-            outputPath = join$1(dirPath, baseName);
-            if (prePurge && existsSync(outputPath))
+            const outputPath = join$1(dirPath, baseName);
+            if (prePurge && existsSync(outputPath)) {
                 yield rm(outputPath, { recursive: true });
+            }
             yield buildDisassembledFilesUnified({
                 filePath,
                 disassembledPath: outputPath,