@js-ak/excel-toolbox 1.7.0 → 1.8.0

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
@@ -224,6 +225,20 @@ 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);
@@ -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.
      *
@@ -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;
@@ -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);
-};

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

@@ -76,6 +76,7 @@ class TemplateMemory {
     constructor(files) {
         this.files = files;
     }
+    /** Private methods */
     /**
      * Ensures that this Template instance has not been destroyed.
      * @private
@@ -335,28 +336,45 @@ class TemplateMemory {
      * @throws {Error} If the sheet does not exist.
      * @experimental This API is experimental and might change in future versions.
      */
-    #removeSheets(data) {
+    async #removeSheets(data) {
         const { sheetIndexes = [], sheetNames = [] } = data;
-        for (const sheetIndex of sheetIndexes) {
+        // 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.files[sheetPath]) {
                 continue;
             }
+            // remove sheet file
             delete this.files[sheetPath];
-            if (this.files["xl/workbook.xml"]) {
-                this.files["xl/workbook.xml"] = Buffer.from(Utils.Common.removeSheetFromWorkbook(this.files["xl/workbook.xml"].toString(), sheetIndex));
+            // remove sheet from workbook
+            const workbook = this.files[this.#excelKeys.workbook];
+            if (workbook) {
+                this.files[this.#excelKeys.workbook] = Buffer.from(Utils.Common.removeSheetFromWorkbook(workbook.toString(), sheetIndex));
             }
-            if (this.files["xl/_rels/workbook.xml.rels"]) {
-                this.files["xl/_rels/workbook.xml.rels"] = Buffer.from(Utils.Common.removeSheetFromRels(this.files["xl/_rels/workbook.xml.rels"].toString(), sheetIndex));
+            // remove sheet from workbook relations
+            const workbookRels = this.files[this.#excelKeys.workbookRels];
+            if (workbookRels) {
+                this.files[this.#excelKeys.workbookRels] = Buffer.from(Utils.Common.removeSheetFromRels(workbookRels.toString(), sheetIndex));
             }
-            if (this.files["[Content_Types].xml"]) {
-                this.files["[Content_Types].xml"] = Buffer.from(Utils.Common.removeSheetFromContentTypes(this.files["[Content_Types].xml"].toString(), sheetIndex));
+            // remove sheet from content types
+            const contentTypes = this.files[this.#excelKeys.contentTypes];
+            if (contentTypes) {
+                this.files[this.#excelKeys.contentTypes] = Buffer.from(Utils.Common.removeSheetFromContentTypes(contentTypes.toString(), sheetIndex));
             }
         }
-        for (const sheetName of sheetNames) {
-            Utils.Common.removeSheetByName(this.files, sheetName);
-        }
     }
+    /** Public methods */
     /**
      * Copies a sheet from the template to a new name.
      *
@@ -454,12 +472,12 @@ class TemplateMemory {
      * @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;
@@ -525,7 +543,7 @@ class TemplateMemory {
             else {
                 updatedXml = sheetXml.replace(/<worksheet[^>]*>/, (match) => `${match}<sheetData>${rowsXml}</sheetData>`);
             }
-            await this.#set(sheetPath, Buffer.from(updatedXml));
+            await this.#set(sheetPath, Buffer.from(Utils.updateDimension(updatedXml)));
         }
         finally {
             this.#isProcessing = false;
@@ -558,6 +576,26 @@ class TemplateMemory {
             const sheetXml = await this.#extractXmlFromSheet(sheetPath);
             const output = new memory_write_stream_js_1.MemoryWriteStream();
             let inserted = false;
+            const initialDimension = sheetXml.match(/<dimension\s+ref="[^"]*"/)?.[0] || "";
+            const dimension = {
+                maxColumn: "A",
+                maxRow: 1,
+                minColumn: "A",
+                minRow: 1,
+            };
+            if (initialDimension) {
+                const dimensionMatch = initialDimension.match(/<dimension\s+ref="([^"]*)"/);
+                if (dimensionMatch) {
+                    const dimensionRef = dimensionMatch[1];
+                    if (dimensionRef) {
+                        const [min, max] = dimensionRef.split(":");
+                        dimension.minColumn = min.slice(0, 1);
+                        dimension.minRow = parseInt(min.slice(1));
+                        dimension.maxColumn = max.slice(0, 1);
+                        dimension.maxRow = parseInt(max.slice(1));
+                    }
+                }
+            }
             // --- Case 1: <sheetData>...</sheetData> on one line ---
             const singleLineMatch = sheetXml.match(/(<sheetData[^>]*>)(.*)(<\/sheetData>)/);
             if (!inserted && singleLineMatch) {
@@ -578,7 +616,13 @@ class TemplateMemory {
                         output.write(innerRows);
                     }
                 }
-                const { rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                const { dimension: newDimension, rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    dimension.maxColumn = newDimension.maxColumn;
+                }
+                if (newDimension.maxRow > dimension.maxRow) {
+                    dimension.maxRow = newDimension.maxRow;
+                }
                 if (innerRows) {
                     const filtered = Utils.getRowsAbove(innerRowsMap, actualRowNumber);
                     if (filtered)
@@ -595,7 +639,13 @@ class TemplateMemory {
                 const matchIndex = match.index;
                 output.write(sheetXml.slice(0, matchIndex));
                 output.write("<sheetData>");
-                await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                const { dimension: newDimension } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    dimension.maxColumn = newDimension.maxColumn;
+                }
+                if (newDimension.maxRow > dimension.maxRow) {
+                    dimension.maxRow = newDimension.maxRow;
+                }
                 output.write("</sheetData>");
                 output.write(sheetXml.slice(matchIndex + match[0].length));
                 inserted = true;
@@ -626,7 +676,13 @@ class TemplateMemory {
                         output.write(innerRows);
                     }
                 }
-                const { rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, Utils.getMaxRowNumber(innerRows));
+                const { dimension: newDimension, rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, Utils.getMaxRowNumber(innerRows));
+                if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    dimension.maxColumn = newDimension.maxColumn;
+                }
+                if (newDimension.maxRow > dimension.maxRow) {
+                    dimension.maxRow = newDimension.maxRow;
+                }
                 if (innerRows) {
                     const filtered = Utils.getRowsAbove(innerRowsMap, actualRowNumber);
                     if (filtered)
@@ -638,8 +694,18 @@ class TemplateMemory {
             }
             if (!inserted)
                 throw new Error("Failed to locate <sheetData> for insertion");
+            let result = output.toBuffer();
+            // update dimension
+            {
+                const target = initialDimension;
+                const refRange = `${dimension.minColumn}${dimension.minRow}:${dimension.maxColumn}${dimension.maxRow}`;
+                const replacement = `<dimension ref="${refRange}"`;
+                if (target) {
+                    result = Buffer.from(result.toString().replace(target, replacement));
+                }
+            }
             // Save the buffer to the sheet
-            this.files[sheetPath] = output.toBuffer();
+            this.files[sheetPath] = result;
         }
         finally {
             this.#isProcessing = false;
@@ -702,12 +768,12 @@ class TemplateMemory {
      * @param {number} [data.gap=0] - The number of empty rows to insert between each added section.
      * @returns {void}
      */
-    mergeSheets(data) {
+    async mergeSheets(data) {
         this.#ensureNotProcessing();
         this.#ensureNotDestroyed();
         this.#isProcessing = true;
         try {
-            this.#mergeSheets(data);
+            await this.#mergeSheets(data);
         }
         finally {
             this.#isProcessing = false;
@@ -721,17 +787,18 @@ class TemplateMemory {
      * @param {string[]} [data.sheetNames] - The names of the sheets to remove.
      * @returns {void}
      */
-    removeSheets(data) {
+    async removeSheets(data) {
         this.#ensureNotProcessing();
         this.#ensureNotDestroyed();
         this.#isProcessing = true;
         try {
-            this.#removeSheets(data);
+            await this.#removeSheets(data);
         }
         finally {
             this.#isProcessing = false;
         }
     }
+    /** Static methods */
     /**
      * Creates a Template instance from an Excel file source.
      *

package/build/cjs/lib/template/utils/compare-columns.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareColumns = compareColumns;
+/**
+ * Compares two column strings and returns a number indicating their relative order.
+ *
+ * @param a - The first column string to compare.
+ * @param b - The second column string to compare.
+ * @returns 0 if the columns are equal, -1 if the first column is less than the second, or 1 if the first column is greater than the second.
+ */
+function compareColumns(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    return a.length === b.length ? (a < b ? -1 : 1) : (a.length < b.length ? -1 : 1);
+}

package/build/cjs/lib/template/utils/index.js

@@ -43,6 +43,7 @@ __exportStar(require("./check-row.js"), exports);
 __exportStar(require("./check-rows.js"), exports);
 __exportStar(require("./check-start-row.js"), exports);
 __exportStar(require("./column-index-to-letter.js"), exports);
+__exportStar(require("./compare-columns.js"), exports);
 __exportStar(require("./escape-xml.js"), exports);
 __exportStar(require("./extract-xml-declaration.js"), exports);
 __exportStar(require("./get-by-path.js"), exports);

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

@@ -53,6 +53,7 @@ export class TemplateFs {
         this.fileKeys = fileKeys;
         this.destination = destination;
     }
+    /** Private methods */
     /**
      * Removes the temporary directory created by this Template instance.
      * @private
@@ -185,6 +186,20 @@ export 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);
@@ -212,6 +227,54 @@ export 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.
      *
@@ -231,6 +294,7 @@ export class TemplateFs {
             }
         }
     }
+    /** Public methods */
     /**
      * Copies a sheet from the template to a new name.
      *
@@ -321,12 +385,12 @@ export 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;
@@ -488,7 +552,7 @@ export 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) {
@@ -535,7 +599,7 @@ export 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) {
@@ -568,7 +632,7 @@ export 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) {
@@ -635,6 +699,25 @@ export 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.
      *
@@ -723,6 +806,7 @@ export class TemplateFs {
             this.#isProcessing = false;
         }
     }
+    /** Static methods */
     /**
      * Creates a Template instance from an Excel file source.
      * Removes any existing files in the destination directory.
@@ -760,8 +844,3 @@ export class TemplateFs {
         return new TemplateFs(new Set(Object.keys(files)), destinationWithUuid);
     }
 }
-const compareColumns = (a, b) => {
-    if (a === b)
-        return 0;
-    return a.length === b.length ? (a < b ? -1 : 1) : (a.length < b.length ? -1 : 1);
-};

package/build/esm/lib/template/template-memory.js

@@ -40,6 +40,7 @@ export class TemplateMemory {
     constructor(files) {
         this.files = files;
     }
+    /** Private methods */
     /**
      * Ensures that this Template instance has not been destroyed.
      * @private
@@ -299,28 +300,45 @@ export class TemplateMemory {
      * @throws {Error} If the sheet does not exist.
      * @experimental This API is experimental and might change in future versions.
      */
-    #removeSheets(data) {
+    async #removeSheets(data) {
         const { sheetIndexes = [], sheetNames = [] } = data;
-        for (const sheetIndex of sheetIndexes) {
+        // 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.files[sheetPath]) {
                 continue;
             }
+            // remove sheet file
             delete this.files[sheetPath];
-            if (this.files["xl/workbook.xml"]) {
-                this.files["xl/workbook.xml"] = Buffer.from(Utils.Common.removeSheetFromWorkbook(this.files["xl/workbook.xml"].toString(), sheetIndex));
+            // remove sheet from workbook
+            const workbook = this.files[this.#excelKeys.workbook];
+            if (workbook) {
+                this.files[this.#excelKeys.workbook] = Buffer.from(Utils.Common.removeSheetFromWorkbook(workbook.toString(), sheetIndex));
             }
-            if (this.files["xl/_rels/workbook.xml.rels"]) {
-                this.files["xl/_rels/workbook.xml.rels"] = Buffer.from(Utils.Common.removeSheetFromRels(this.files["xl/_rels/workbook.xml.rels"].toString(), sheetIndex));
+            // remove sheet from workbook relations
+            const workbookRels = this.files[this.#excelKeys.workbookRels];
+            if (workbookRels) {
+                this.files[this.#excelKeys.workbookRels] = Buffer.from(Utils.Common.removeSheetFromRels(workbookRels.toString(), sheetIndex));
             }
-            if (this.files["[Content_Types].xml"]) {
-                this.files["[Content_Types].xml"] = Buffer.from(Utils.Common.removeSheetFromContentTypes(this.files["[Content_Types].xml"].toString(), sheetIndex));
+            // remove sheet from content types
+            const contentTypes = this.files[this.#excelKeys.contentTypes];
+            if (contentTypes) {
+                this.files[this.#excelKeys.contentTypes] = Buffer.from(Utils.Common.removeSheetFromContentTypes(contentTypes.toString(), sheetIndex));
             }
         }
-        for (const sheetName of sheetNames) {
-            Utils.Common.removeSheetByName(this.files, sheetName);
-        }
     }
+    /** Public methods */
     /**
      * Copies a sheet from the template to a new name.
      *
@@ -418,12 +436,12 @@ export class TemplateMemory {
      * @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;
@@ -489,7 +507,7 @@ export class TemplateMemory {
             else {
                 updatedXml = sheetXml.replace(/<worksheet[^>]*>/, (match) => `${match}<sheetData>${rowsXml}</sheetData>`);
             }
-            await this.#set(sheetPath, Buffer.from(updatedXml));
+            await this.#set(sheetPath, Buffer.from(Utils.updateDimension(updatedXml)));
         }
         finally {
             this.#isProcessing = false;
@@ -522,6 +540,26 @@ export class TemplateMemory {
             const sheetXml = await this.#extractXmlFromSheet(sheetPath);
             const output = new MemoryWriteStream();
             let inserted = false;
+            const initialDimension = sheetXml.match(/<dimension\s+ref="[^"]*"/)?.[0] || "";
+            const dimension = {
+                maxColumn: "A",
+                maxRow: 1,
+                minColumn: "A",
+                minRow: 1,
+            };
+            if (initialDimension) {
+                const dimensionMatch = initialDimension.match(/<dimension\s+ref="([^"]*)"/);
+                if (dimensionMatch) {
+                    const dimensionRef = dimensionMatch[1];
+                    if (dimensionRef) {
+                        const [min, max] = dimensionRef.split(":");
+                        dimension.minColumn = min.slice(0, 1);
+                        dimension.minRow = parseInt(min.slice(1));
+                        dimension.maxColumn = max.slice(0, 1);
+                        dimension.maxRow = parseInt(max.slice(1));
+                    }
+                }
+            }
             // --- Case 1: <sheetData>...</sheetData> on one line ---
             const singleLineMatch = sheetXml.match(/(<sheetData[^>]*>)(.*)(<\/sheetData>)/);
             if (!inserted && singleLineMatch) {
@@ -542,7 +580,13 @@ export class TemplateMemory {
                         output.write(innerRows);
                     }
                 }
-                const { rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                const { dimension: newDimension, rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    dimension.maxColumn = newDimension.maxColumn;
+                }
+                if (newDimension.maxRow > dimension.maxRow) {
+                    dimension.maxRow = newDimension.maxRow;
+                }
                 if (innerRows) {
                     const filtered = Utils.getRowsAbove(innerRowsMap, actualRowNumber);
                     if (filtered)
@@ -559,7 +603,13 @@ export class TemplateMemory {
                 const matchIndex = match.index;
                 output.write(sheetXml.slice(0, matchIndex));
                 output.write("<sheetData>");
-                await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                const { dimension: newDimension } = await Utils.writeRowsToStream(output, rows, maxRowNumber);
+                if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    dimension.maxColumn = newDimension.maxColumn;
+                }
+                if (newDimension.maxRow > dimension.maxRow) {
+                    dimension.maxRow = newDimension.maxRow;
+                }
                 output.write("</sheetData>");
                 output.write(sheetXml.slice(matchIndex + match[0].length));
                 inserted = true;
@@ -590,7 +640,13 @@ export class TemplateMemory {
                         output.write(innerRows);
                     }
                 }
-                const { rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, Utils.getMaxRowNumber(innerRows));
+                const { dimension: newDimension, rowNumber: actualRowNumber } = await Utils.writeRowsToStream(output, rows, Utils.getMaxRowNumber(innerRows));
+                if (Utils.compareColumns(newDimension.maxColumn, dimension.maxColumn) > 0) {
+                    dimension.maxColumn = newDimension.maxColumn;
+                }
+                if (newDimension.maxRow > dimension.maxRow) {
+                    dimension.maxRow = newDimension.maxRow;
+                }
                 if (innerRows) {
                     const filtered = Utils.getRowsAbove(innerRowsMap, actualRowNumber);
                     if (filtered)
@@ -602,8 +658,18 @@ export class TemplateMemory {
             }
             if (!inserted)
                 throw new Error("Failed to locate <sheetData> for insertion");
+            let result = output.toBuffer();
+            // update dimension
+            {
+                const target = initialDimension;
+                const refRange = `${dimension.minColumn}${dimension.minRow}:${dimension.maxColumn}${dimension.maxRow}`;
+                const replacement = `<dimension ref="${refRange}"`;
+                if (target) {
+                    result = Buffer.from(result.toString().replace(target, replacement));
+                }
+            }
             // Save the buffer to the sheet
-            this.files[sheetPath] = output.toBuffer();
+            this.files[sheetPath] = result;
         }
         finally {
             this.#isProcessing = false;
@@ -666,12 +732,12 @@ export class TemplateMemory {
      * @param {number} [data.gap=0] - The number of empty rows to insert between each added section.
      * @returns {void}
      */
-    mergeSheets(data) {
+    async mergeSheets(data) {
         this.#ensureNotProcessing();
         this.#ensureNotDestroyed();
         this.#isProcessing = true;
         try {
-            this.#mergeSheets(data);
+            await this.#mergeSheets(data);
         }
         finally {
             this.#isProcessing = false;
@@ -685,17 +751,18 @@ export class TemplateMemory {
      * @param {string[]} [data.sheetNames] - The names of the sheets to remove.
      * @returns {void}
      */
-    removeSheets(data) {
+    async removeSheets(data) {
         this.#ensureNotProcessing();
         this.#ensureNotDestroyed();
         this.#isProcessing = true;
         try {
-            this.#removeSheets(data);
+            await this.#removeSheets(data);
         }
         finally {
             this.#isProcessing = false;
         }
     }
+    /** Static methods */
     /**
      * Creates a Template instance from an Excel file source.
      *

package/build/esm/lib/template/utils/compare-columns.js

@@ -0,0 +1,13 @@
+/**
+ * Compares two column strings and returns a number indicating their relative order.
+ *
+ * @param a - The first column string to compare.
+ * @param b - The second column string to compare.
+ * @returns 0 if the columns are equal, -1 if the first column is less than the second, or 1 if the first column is greater than the second.
+ */
+export function compareColumns(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    return a.length === b.length ? (a < b ? -1 : 1) : (a.length < b.length ? -1 : 1);
+}

package/build/esm/lib/template/utils/index.js

@@ -4,6 +4,7 @@ export * from "./check-row.js";
 export * from "./check-rows.js";
 export * from "./check-start-row.js";
 export * from "./column-index-to-letter.js";
+export * from "./compare-columns.js";
 export * from "./escape-xml.js";
 export * from "./extract-xml-declaration.js";
 export * from "./get-by-path.js";

package/build/types/lib/template/template-fs.d.ts

@@ -29,6 +29,7 @@ export declare class TemplateFs {
      * @experimental This API is experimental and might change in future versions.
      */
     constructor(fileKeys: Set<string>, destination: string);
+    /** Public methods */
     /**
      * Copies a sheet from the template to a new name.
      *
@@ -91,6 +92,18 @@ export declare class TemplateFs {
         startRowNumber?: number;
         rows: AsyncIterable<unknown[]>;
     }): Promise<void>;
+    /**
+     * 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}
+     */
+    removeSheets(data: {
+        sheetNames?: string[];
+        sheetIndexes?: number[];
+    }): Promise<void>;
     /**
      * Saves the modified Excel template to a buffer.
      *
@@ -128,6 +141,7 @@ export declare class TemplateFs {
      * @experimental This API is experimental and might change in future versions.
      */
     validate(): Promise<void>;
+    /** Static methods */
     /**
      * Creates a Template instance from an Excel file source.
      * Removes any existing files in the destination directory.

package/build/types/lib/template/template-memory.d.ts

@@ -19,6 +19,7 @@ export declare class TemplateMemory {
      * @experimental This API is experimental and might change in future versions.
      */
     constructor(files: Record<string, Buffer>);
+    /** Public methods */
     /**
      * Copies a sheet from the template to a new name.
      *
@@ -118,7 +119,7 @@ export declare class TemplateMemory {
         baseSheetIndex?: number;
         baseSheetName?: string;
         gap?: number;
-    }): void;
+    }): Promise<void>;
     /**
      * Removes sheets from the workbook.
      *
@@ -130,7 +131,8 @@ export declare class TemplateMemory {
     removeSheets(data: {
         sheetNames?: string[];
         sheetIndexes?: number[];
-    }): void;
+    }): Promise<void>;
+    /** Static methods */
     /**
      * Creates a Template instance from an Excel file source.
      *

package/build/types/lib/template/utils/compare-columns.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Compares two column strings and returns a number indicating their relative order.
+ *
+ * @param a - The first column string to compare.
+ * @param b - The second column string to compare.
+ * @returns 0 if the columns are equal, -1 if the first column is less than the second, or 1 if the first column is greater than the second.
+ */
+export declare function compareColumns(a: string, b: string): number;

package/build/types/lib/template/utils/index.d.ts

@@ -4,6 +4,7 @@ export * from "./check-row.js";
 export * from "./check-rows.js";
 export * from "./check-start-row.js";
 export * from "./column-index-to-letter.js";
+export * from "./compare-columns.js";
 export * from "./escape-xml.js";
 export * from "./extract-xml-declaration.js";
 export * from "./get-by-path.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@js-ak/excel-toolbox",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "excel-toolbox",
   "publishConfig": {
     "access": "public",