@js-ak/excel-toolbox 1.6.0 → 1.8.0

package/build/cjs/lib/merge-sheets-to-base-file-process-sync.js

@@ -0,0 +1,105 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeSheetsToBaseFileProcessSync = mergeSheetsToBaseFileProcessSync;
+const Utils = __importStar(require("./utils/index.js"));
+const Xml = __importStar(require("./xml/index.js"));
+/**
+ * Merges rows from other Excel files into a base Excel file.
+ *
+ * This function is a process-friendly version of mergeSheetsToBaseFile.
+ * It takes a single object with the following properties:
+ * - additions: An array of objects with two properties:
+ *   - files: A dictionary of file paths to their corresponding XML content
+ *   - sheetIndexes: The 1-based indexes of the sheet to extract rows from
+ * - baseFiles: A dictionary of file paths to their corresponding XML content
+ * - baseSheetIndex: The 1-based index of the sheet in the base file to add rows to
+ * - gap: The number of empty rows to insert between each added section
+ * - sheetNamesToRemove: The names of sheets to remove from the output file
+ * - sheetsToRemove: The 1-based indices of sheets to remove from the output file
+ *
+ * The function returns a dictionary of file paths to their corresponding XML content.
+ */
+function mergeSheetsToBaseFileProcessSync(data) {
+    const { additions, baseFiles, baseSheetIndex, gap, sheetNamesToRemove, sheetsToRemove, } = data;
+    const basePath = `xl/worksheets/sheet${baseSheetIndex}.xml`;
+    if (!baseFiles[basePath]) {
+        throw new Error(`Base file does not contain ${basePath}`);
+    }
+    const { lastRowNumber, mergeCells: baseMergeCells, rows: baseRows, xml, } = Xml.extractRowsFromSheetSync(baseFiles[basePath]);
+    const allRows = [...baseRows];
+    const allMergeCells = [...baseMergeCells];
+    let currentRowOffset = lastRowNumber + gap;
+    for (const { files, sheetIndexes } of additions) {
+        for (const sheetIndex of sheetIndexes) {
+            const sheetPath = `xl/worksheets/sheet${sheetIndex}.xml`;
+            if (!files[sheetPath]) {
+                throw new Error(`File does not contain ${sheetPath}`);
+            }
+            const { mergeCells, rows } = Xml.extractRowsFromSheetSync(files[sheetPath]);
+            const shiftedRows = Xml.shiftRowIndices(rows, currentRowOffset);
+            const shiftedMergeCells = mergeCells.map(cell => {
+                const [start, end] = cell.ref.split(":");
+                if (!start || !end) {
+                    return cell;
+                }
+                const shiftedStart = Utils.shiftCellRef(start, currentRowOffset);
+                const shiftedEnd = Utils.shiftCellRef(end, currentRowOffset);
+                return { ...cell, ref: `${shiftedStart}:${shiftedEnd}` };
+            });
+            allRows.push(...shiftedRows);
+            allMergeCells.push(...shiftedMergeCells);
+            currentRowOffset += Utils.getMaxRowNumber(rows) + gap;
+        }
+    }
+    const mergedXml = Xml.buildMergedSheet(xml, allRows, allMergeCells);
+    baseFiles[basePath] = mergedXml;
+    for (const sheetIndex of sheetsToRemove) {
+        const sheetPath = `xl/worksheets/sheet${sheetIndex}.xml`;
+        delete baseFiles[sheetPath];
+        if (baseFiles["xl/workbook.xml"]) {
+            baseFiles["xl/workbook.xml"] = Buffer.from(Utils.removeSheetFromWorkbook(baseFiles["xl/workbook.xml"].toString(), sheetIndex));
+        }
+        if (baseFiles["xl/_rels/workbook.xml.rels"]) {
+            baseFiles["xl/_rels/workbook.xml.rels"] = Buffer.from(Utils.removeSheetFromRels(baseFiles["xl/_rels/workbook.xml.rels"].toString(), sheetIndex));
+        }
+        if (baseFiles["[Content_Types].xml"]) {
+            baseFiles["[Content_Types].xml"] = Buffer.from(Utils.removeSheetFromContentTypes(baseFiles["[Content_Types].xml"].toString(), sheetIndex));
+        }
+    }
+    for (const sheetName of sheetNamesToRemove) {
+        Utils.removeSheetByName(baseFiles, sheetName);
+    }
+}

package/build/cjs/lib/merge-sheets-to-base-file-process.js

@@ -52,13 +52,13 @@ const Xml = __importStar(require("./xml/index.js"));
  *
  * The function returns a dictionary of file paths to their corresponding XML content.
  */
-function mergeSheetsToBaseFileProcess(data) {
+async function mergeSheetsToBaseFileProcess(data) {
     const { additions, baseFiles, baseSheetIndex, gap, sheetNamesToRemove, sheetsToRemove, } = data;
     const basePath = `xl/worksheets/sheet${baseSheetIndex}.xml`;
     if (!baseFiles[basePath]) {
         throw new Error(`Base file does not contain ${basePath}`);
     }
-    const { lastRowNumber, mergeCells: baseMergeCells, rows: baseRows, xml, } = Xml.extractRowsFromSheet(baseFiles[basePath]);
+    const { lastRowNumber, mergeCells: baseMergeCells, rows: baseRows, xml, } = await Xml.extractRowsFromSheet(baseFiles[basePath]);
     const allRows = [...baseRows];
     const allMergeCells = [...baseMergeCells];
     let currentRowOffset = lastRowNumber + gap;
@@ -68,7 +68,7 @@ function mergeSheetsToBaseFileProcess(data) {
             if (!files[sheetPath]) {
                 throw new Error(`File does not contain ${sheetPath}`);
             }
-            const { mergeCells, rows } = Xml.extractRowsFromSheet(files[sheetPath]);
+            const { mergeCells, rows } = await Xml.extractRowsFromSheet(files[sheetPath]);
             const shiftedRows = Xml.shiftRowIndices(rows, currentRowOffset);
             const shiftedMergeCells = mergeCells.map(cell => {
                 const [start, end] = cell.ref.split(":");

package/build/cjs/lib/merge-sheets-to-base-file-sync.js

@@ -36,7 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeSheetsToBaseFileSync = mergeSheetsToBaseFileSync;
 const Utils = __importStar(require("./utils/index.js"));
 const Zip = __importStar(require("./zip/index.js"));
-const merge_sheets_to_base_file_process_js_1 = require("./merge-sheets-to-base-file-process.js");
+const merge_sheets_to_base_file_process_sync_js_1 = require("./merge-sheets-to-base-file-process-sync.js");
 /**
  * Merge rows from other Excel files into a base Excel file.
  * The output is a new Excel file with the merged content.
@@ -65,7 +65,7 @@ function mergeSheetsToBaseFileSync(data) {
             sheetIndexes,
         });
     }
-    (0, merge_sheets_to_base_file_process_js_1.mergeSheetsToBaseFileProcess)({
+    (0, merge_sheets_to_base_file_process_sync_js_1.mergeSheetsToBaseFileProcessSync)({
         additions: additionsUpdated,
         baseFiles,
         baseSheetIndex,

package/build/cjs/lib/merge-sheets-to-base-file.js

@@ -65,7 +65,7 @@ async function mergeSheetsToBaseFile(data) {
             sheetIndexes,
         });
     }
-    (0, merge_sheets_to_base_file_process_js_1.mergeSheetsToBaseFileProcess)({
+    await (0, merge_sheets_to_base_file_process_js_1.mergeSheetsToBaseFileProcess)({
         additions: additionsUpdated,
         baseFiles,
         baseSheetIndex,

package/build/cjs/lib/template/template-fs.js

@@ -92,6 +92,7 @@ class TemplateFs {
         this.fileKeys = fileKeys;
         this.destination = destination;
     }
+    /** Private methods */
     /**
      * Removes the temporary directory created by this Template instance.
      * @private
@@ -165,13 +166,13 @@ class TemplateFs {
      */
     async #getSheetPathByName(sheetName) {
         // Read XML workbook to find sheet name and path
-        const workbookXml = Xml.extractXmlFromSheet(await this.#readFile(this.#excelKeys.workbook));
+        const workbookXml = await Xml.extractXmlFromSheet(await this.#readFile(this.#excelKeys.workbook));
         const sheetMatch = workbookXml.match(Utils.sheetMatch(sheetName));
         if (!sheetMatch || !sheetMatch[1]) {
             throw new Error(`Sheet "${sheetName}" not found`);
         }
         const rId = sheetMatch[1];
-        const relsXml = Xml.extractXmlFromSheet(await this.#readFile(this.#excelKeys.workbookRels));
+        const relsXml = await Xml.extractXmlFromSheet(await this.#readFile(this.#excelKeys.workbookRels));
         const relMatch = relsXml.match(Utils.relationshipMatch(rId));
         if (!relMatch || !relMatch[1]) {
             throw new Error(`Relationship "${rId}" not found`);
@@ -224,16 +225,30 @@ class TemplateFs {
         const fullPath = path.join(this.destination, ...key.split("/"));
         await fs.writeFile(fullPath, Buffer.isBuffer(content) ? content : Buffer.from(content));
     }
+    /**
+     * Replaces placeholders in the given sheet with values from the replacements map.
+     *
+     * The function searches for placeholders in the format `${key}` within the sheet
+     * content, where `key` corresponds to a path in the replacements object.
+     * If a value is found for the key, it replaces the placeholder with the value.
+     * If no value is found, the original placeholder remains unchanged.
+     *
+     * @param sheetName - The name of the sheet to be replaced.
+     * @param replacements - An object where keys represent placeholder paths and values are the replacements.
+     * @returns A promise that resolves when the substitution is complete.
+     * @throws {Error} If the template instance has been destroyed.
+     * @experimental This API is experimental and might change in future versions.
+     */
     async #substitute(sheetName, replacements) {
         const sharedStringsPath = this.#excelKeys.sharedStrings;
         const sheetPath = await this.#getSheetPathByName(sheetName);
         let sharedStringsContent = "";
         let sheetContent = "";
         if (this.fileKeys.has(sharedStringsPath)) {
-            sharedStringsContent = Xml.extractXmlFromSheet(await this.#readFile(sharedStringsPath));
+            sharedStringsContent = await Xml.extractXmlFromSheet(await this.#readFile(sharedStringsPath));
         }
         if (this.fileKeys.has(sheetPath)) {
-            sheetContent = Xml.extractXmlFromSheet(await this.#readFile(sheetPath));
+            sheetContent = await Xml.extractXmlFromSheet(await this.#readFile(sheetPath));
             const TABLE_REGEX = /\$\{table:([a-zA-Z0-9_]+)\.([a-zA-Z0-9_]+)\}/g;
             const hasTablePlaceholders = TABLE_REGEX.test(sharedStringsContent) || TABLE_REGEX.test(sheetContent);
             if (hasTablePlaceholders) {
@@ -251,6 +266,54 @@ class TemplateFs {
             await this.#set(sheetPath, sheetContent);
         }
     }
+    /**
+     * Removes sheets from the workbook.
+     *
+     * @param {Object} data - The data for sheet removal.
+     * @param {number[]} [data.sheetIndexes] - The 1-based indexes of the sheets to remove.
+     * @param {string[]} [data.sheetNames] - The names of the sheets to remove.
+     * @returns {void}
+     *
+     * @throws {Error} If the template instance has been destroyed.
+     * @throws {Error} If the sheet does not exist.
+     * @experimental This API is experimental and might change in future versions.
+     */
+    async #removeSheets(data) {
+        const { sheetIndexes = [], sheetNames = [] } = data;
+        // first get index of sheets to remove
+        const sheetIndexesToRemove = new Set(sheetIndexes);
+        for (const sheetName of sheetNames) {
+            const sheetPath = await this.#getSheetPathByName(sheetName);
+            const sheetIndexMatch = sheetPath.match(/sheet(\d+)\.xml$/);
+            if (!sheetIndexMatch || !sheetIndexMatch[1]) {
+                throw new Error(`Sheet "${sheetName}" not found`);
+            }
+            const sheetIndex = parseInt(sheetIndexMatch[1], 10);
+            sheetIndexesToRemove.add(sheetIndex);
+        }
+        // Remove sheets by index
+        for (const sheetIndex of sheetIndexesToRemove.values()) {
+            const sheetPath = `xl/worksheets/sheet${sheetIndex}.xml`;
+            if (!this.fileKeys.has(sheetPath)) {
+                continue;
+            }
+            // remove sheet file
+            await fs.unlink(path.join(this.destination, ...sheetPath.split("/")));
+            this.fileKeys.delete(sheetPath);
+            // remove sheet from workbook
+            if (this.fileKeys.has(this.#excelKeys.workbook)) {
+                this.#set(this.#excelKeys.workbook, Buffer.from(Utils.Common.removeSheetFromWorkbook(this.#readFile(this.#excelKeys.workbook).toString(), sheetIndex)));
+            }
+            // remove sheet from workbook relations
+            if (this.fileKeys.has(this.#excelKeys.workbookRels)) {
+                this.#set(this.#excelKeys.workbookRels, Buffer.from(Utils.Common.removeSheetFromRels(this.#readFile(this.#excelKeys.workbookRels).toString(), sheetIndex)));
+            }
+            // remove sheet from content types
+            if (this.fileKeys.has(this.#excelKeys.contentTypes)) {
+                this.#set(this.#excelKeys.contentTypes, Buffer.from(Utils.Common.removeSheetFromContentTypes(this.#readFile(this.#excelKeys.contentTypes).toString(), sheetIndex)));
+            }
+        }
+    }
     /**
      * Validates the template by checking all required files exist.
      *
@@ -270,6 +333,7 @@ class TemplateFs {
             }
         }
     }
+    /** Public methods */
     /**
      * Copies a sheet from the template to a new name.
      *
@@ -290,7 +354,7 @@ class TemplateFs {
             }
             // Read workbook.xml and find the source sheet
             const workbookXmlPath = this.#excelKeys.workbook;
-            const workbookXml = Xml.extractXmlFromSheet(await this.#readFile(workbookXmlPath));
+            const workbookXml = await Xml.extractXmlFromSheet(await this.#readFile(workbookXmlPath));
             // Find the source sheet
             const sheetMatch = workbookXml.match(Utils.sheetMatch(sourceName));
             if (!sheetMatch || !sheetMatch[1]) {
@@ -304,7 +368,7 @@ class TemplateFs {
             // Find the source sheet path by rId
             const rId = sheetMatch[1];
             const relsXmlPath = this.#excelKeys.workbookRels;
-            const relsXml = Xml.extractXmlFromSheet(await this.#readFile(relsXmlPath));
+            const relsXml = await Xml.extractXmlFromSheet(await this.#readFile(relsXmlPath));
             const relMatch = relsXml.match(Utils.relationshipMatch(rId));
             if (!relMatch || !relMatch[1]) {
                 throw new Error(`Relationship "${rId}" not found`);
@@ -339,7 +403,7 @@ class TemplateFs {
             // Read [Content_Types].xml
             // Update [Content_Types].xml
             const contentTypesPath = this.#excelKeys.contentTypes;
-            const contentTypesXml = Xml.extractXmlFromSheet(await this.#readFile(contentTypesPath));
+            const contentTypesXml = await Xml.extractXmlFromSheet(await this.#readFile(contentTypesPath));
             const overrideTag = `<Override PartName="/xl/worksheets/${newSheetFilename}" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>`;
             const updatedContentTypesXml = contentTypesXml.replace("</Types>", overrideTag + "</Types>");
             await this.#set(contentTypesPath, updatedContentTypesXml);
@@ -360,12 +424,12 @@ class TemplateFs {
      * @param replacements - An object where keys represent placeholder paths and values are the replacements.
      * @returns A promise that resolves when the substitution is complete.
      */
-    substitute(sheetName, replacements) {
+    async substitute(sheetName, replacements) {
         this.#ensureNotProcessing();
         this.#ensureNotDestroyed();
         this.#isProcessing = true;
         try {
-            return this.#substitute(sheetName, replacements);
+            await this.#substitute(sheetName, replacements);
         }
         finally {
             this.#isProcessing = false;
@@ -398,7 +462,7 @@ class TemplateFs {
             // Find the sheet
             const sheetPath = await this.#getSheetPathByName(sheetName);
             const sheetXmlRaw = await this.#readFile(sheetPath);
-            const sheetXml = Xml.extractXmlFromSheet(sheetXmlRaw);
+            const sheetXml = await Xml.extractXmlFromSheet(sheetXmlRaw);
             let nextRow = 0;
             if (!startRowNumber) {
                 // Find the last row
@@ -527,7 +591,7 @@ class TemplateFs {
                             }
                         }
                         const { dimension: newDimension, rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
-                        if (compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                        if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
                             dimension.maxColumn = newDimension.maxColumn;
                         }
                         if (newDimension.maxRow > dimension.maxRow) {
@@ -574,7 +638,7 @@ class TemplateFs {
                     }
                     // new <row>
                     const { dimension: newDimension, rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
-                    if (compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
                         dimension.maxColumn = newDimension.maxColumn;
                     }
                     if (newDimension.maxRow > dimension.maxRow) {
@@ -607,7 +671,7 @@ class TemplateFs {
                     output.write("<sheetData>");
                     // Prepare the rows
                     const { dimension: newDimension } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
-                    if (compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
                         dimension.maxColumn = newDimension.maxColumn;
                     }
                     if (newDimension.maxRow > dimension.maxRow) {
@@ -674,6 +738,25 @@ class TemplateFs {
             this.#isProcessing = false;
         }
     }
+    /**
+     * Removes sheets from the workbook.
+     *
+     * @param {Object} data
+     * @param {number[]} [data.sheetIndexes] - The 1-based indexes of the sheets to remove.
+     * @param {string[]} [data.sheetNames] - The names of the sheets to remove.
+     * @returns {void}
+     */
+    async removeSheets(data) {
+        this.#ensureNotProcessing();
+        this.#ensureNotDestroyed();
+        this.#isProcessing = true;
+        try {
+            await this.#removeSheets(data);
+        }
+        finally {
+            this.#isProcessing = false;
+        }
+    }
     /**
      * Saves the modified Excel template to a buffer.
      *
@@ -762,6 +845,7 @@ class TemplateFs {
             this.#isProcessing = false;
         }
     }
+    /** Static methods */
     /**
      * Creates a Template instance from an Excel file source.
      * Removes any existing files in the destination directory.
@@ -800,8 +884,3 @@ class TemplateFs {
     }
 }
 exports.TemplateFs = TemplateFs;
-const compareColumns = (a, b) => {
-    if (a === b)
-        return 0;
-    return a.length === b.length ? (a < b ? -1 : 1) : (a.length < b.length ? -1 : 1);
-};