@js-ak/excel-toolbox 1.5.0 → 1.6.0

package/build/esm/lib/template/utils/validate-worksheet-xml.js

@@ -30,9 +30,7 @@ export function validateWorksheetXml(xml) {
     const requiredElements = [
         { name: "sheetViews", tag: "<sheetViews>" },
         { name: "sheetFormatPr", tag: "<sheetFormatPr" },
-        { name: "cols", tag: "<cols>" },
         { name: "sheetData", tag: "<sheetData>" },
-        { name: "mergeCells", tag: "<mergeCells" },
     ];
     for (const { name, tag } of requiredElements) {
         if (!xml.includes(tag)) {
@@ -97,59 +95,82 @@ export function validateWorksheetXml(xml) {
         }
     }
     // 4. Check mergeCells
-    const mergeCellsStart = xml.indexOf("<mergeCells");
-    const mergeCellsEnd = xml.indexOf("</mergeCells>");
-    if (mergeCellsStart === -1 || mergeCellsEnd === -1) {
-        return createError("Invalid mergeCells structure");
-    }
-    const mergeCellsContent = xml.substring(mergeCellsStart, mergeCellsEnd);
-    const countMatch = mergeCellsContent.match(/count="(\d+)"/);
-    if (!countMatch) {
-        return createError("Count attribute not specified for mergeCells");
-    }
-    const mergeCellTags = mergeCellsContent.match(/<mergeCell\s+ref="([A-Z]+\d+:[A-Z]+\d+)"\s*\/>/g);
-    if (!mergeCellTags) {
-        return createError("No merged cells found");
-    }
-    // Check if the number of mergeCells matches the count attribute
-    if (mergeCellTags.length !== parseInt(countMatch[1])) {
-        return createError("Mismatch in the number of merged cells", `Expected: ${countMatch[1]}, found: ${mergeCellTags.length}`);
-    }
-    // Check for duplicates of mergeCell
-    const mergeRefs = new Set();
-    const duplicates = new Set();
-    for (const mergeTag of mergeCellTags) {
-        const refMatch = mergeTag.match(/ref="([A-Z]+\d+:[A-Z]+\d+)"/);
-        if (!refMatch) {
-            return createError("Invalid merge cell format", `Tag: ${mergeTag}`);
-        }
-        const ref = refMatch[1];
-        if (mergeRefs.has(ref)) {
-            duplicates.add(ref);
+    if (xml.includes("<mergeCells")) {
+        const mergeCellsStart = xml.indexOf("<mergeCells");
+        const mergeCellsEnd = xml.indexOf("</mergeCells>");
+        if (mergeCellsStart === -1 || mergeCellsEnd === -1) {
+            return createError("Invalid mergeCells structure");
+        }
+        const mergeCellsContent = xml.substring(mergeCellsStart, mergeCellsEnd);
+        const countMatch = mergeCellsContent.match(/count="(\d+)"/);
+        if (!countMatch) {
+            return createError("Count attribute not specified for mergeCells");
+        }
+        const mergeCellTags = mergeCellsContent.match(/<mergeCell\s+ref="([A-Z]+\d+:[A-Z]+\d+)"\s*\/>/g);
+        if (!mergeCellTags) {
+            return createError("No merged cells found");
+        }
+        // Check if the number of mergeCells matches the count attribute
+        if (mergeCellTags.length !== parseInt(countMatch[1])) {
+            return createError("Mismatch in the number of merged cells", `Expected: ${countMatch[1]}, found: ${mergeCellTags.length}`);
+        }
+        // Check for duplicates of mergeCell
+        const mergeRefs = new Set();
+        const duplicates = new Set();
+        for (const mergeTag of mergeCellTags) {
+            const refMatch = mergeTag.match(/ref="([A-Z]+\d+:[A-Z]+\d+)"/);
+            if (!refMatch) {
+                return createError("Invalid merge cell format", `Tag: ${mergeTag}`);
+            }
+            const ref = refMatch[1];
+            if (mergeRefs.has(ref)) {
+                duplicates.add(ref);
+            }
+            else {
+                mergeRefs.add(ref);
+            }
         }
-        else {
-            mergeRefs.add(ref);
+        if (duplicates.size > 0) {
+            return createError("Duplicates of merged cells found", `Duplicates: ${Array.from(duplicates).join(", ")}`);
+        }
+        // Check for overlapping merge ranges
+        const mergedRanges = Array.from(mergeRefs).map(ref => {
+            const [start, end] = ref.split(":");
+            return {
+                endCol: end.match(/[A-Z]+/)?.[0] || "",
+                endRow: parseInt(end.match(/\d+/)?.[0] || "0"),
+                startCol: start.match(/[A-Z]+/)?.[0] || "",
+                startRow: parseInt(start.match(/\d+/)?.[0] || "0"),
+            };
+        });
+        for (let i = 0; i < mergedRanges.length; i++) {
+            for (let j = i + 1; j < mergedRanges.length; j++) {
+                const a = mergedRanges[i];
+                const b = mergedRanges[j];
+                if (rangesIntersect(a, b)) {
+                    return createError("Found intersecting merged cells", `Intersecting: ${getRangeString(a)} and ${getRangeString(b)}`);
+                }
+            }
         }
-    }
-    if (duplicates.size > 0) {
-        return createError("Duplicates of merged cells found", `Duplicates: ${Array.from(duplicates).join(", ")}`);
-    }
-    // Check for overlapping merge ranges
-    const mergedRanges = Array.from(mergeRefs).map(ref => {
-        const [start, end] = ref.split(":");
-        return {
-            endCol: end.match(/[A-Z]+/)?.[0] || "",
-            endRow: parseInt(end.match(/\d+/)?.[0] || "0"),
-            startCol: start.match(/[A-Z]+/)?.[0] || "",
-            startRow: parseInt(start.match(/\d+/)?.[0] || "0"),
-        };
-    });
-    for (let i = 0; i < mergedRanges.length; i++) {
-        for (let j = i + 1; j < mergedRanges.length; j++) {
-            const a = mergedRanges[i];
-            const b = mergedRanges[j];
-            if (rangesIntersect(a, b)) {
-                return createError("Found intersecting merged cells", `Intersecting: ${getRangeString(a)} and ${getRangeString(b)}`);
+        // 6. Additional check: all mergeCell tags refer to existing cells
+        for (const mergeTag of mergeCellTags) {
+            const refMatch = mergeTag.match(/ref="([A-Z]+\d+:[A-Z]+\d+)"/);
+            if (!refMatch) {
+                return createError("Invalid merge cell format", `Tag: ${mergeTag}`);
+            }
+            const [cell1, cell2] = refMatch[1].split(":");
+            const cell1Col = cell1.match(/[A-Z]+/)?.[0];
+            const cell1Row = parseInt(cell1.match(/\d+/)?.[0] || "0");
+            const cell2Col = cell2.match(/[A-Z]+/)?.[0];
+            const cell2Row = parseInt(cell2.match(/\d+/)?.[0] || "0");
+            if (!cell1Col || !cell2Col || isNaN(cell1Row) || isNaN(cell2Row)) {
+                return createError("Invalid merged cell coordinates", `Merged cells: ${refMatch[1]}`);
+            }
+            // Check if the merged cells exist
+            const cell1Exists = allCells.some(c => c.row === cell1Row && c.col === cell1Col);
+            const cell2Exists = allCells.some(c => c.row === cell2Row && c.col === cell2Col);
+            if (!cell1Exists || !cell2Exists) {
+                return createError("Merged cell reference points to non-existent cells", `Merged cells: ${refMatch[1]}, missing: ${!cell1Exists ? `${cell1Col}${cell1Row}` : `${cell2Col}${cell2Row}`}`);
             }
         }
     }
@@ -178,27 +199,6 @@ export function validateWorksheetXml(xml) {
             return createError("Cell is outside the specified area (by column)", `Cell: ${cell.col}${cell.row}, dimension: ${dimensionMatch[1]}`);
         }
     }
-    // 6. Additional check: all mergeCell tags refer to existing cells
-    for (const mergeTag of mergeCellTags) {
-        const refMatch = mergeTag.match(/ref="([A-Z]+\d+:[A-Z]+\d+)"/);
-        if (!refMatch) {
-            return createError("Invalid merge cell format", `Tag: ${mergeTag}`);
-        }
-        const [cell1, cell2] = refMatch[1].split(":");
-        const cell1Col = cell1.match(/[A-Z]+/)?.[0];
-        const cell1Row = parseInt(cell1.match(/\d+/)?.[0] || "0");
-        const cell2Col = cell2.match(/[A-Z]+/)?.[0];
-        const cell2Row = parseInt(cell2.match(/\d+/)?.[0] || "0");
-        if (!cell1Col || !cell2Col || isNaN(cell1Row) || isNaN(cell2Row)) {
-            return createError("Invalid merged cell coordinates", `Merged cells: ${refMatch[1]}`);
-        }
-        // Check if the merged cells exist
-        const cell1Exists = allCells.some(c => c.row === cell1Row && c.col === cell1Col);
-        const cell2Exists = allCells.some(c => c.row === cell2Row && c.col === cell2Col);
-        if (!cell1Exists || !cell2Exists) {
-            return createError("Merged cell reference points to non-existent cells", `Merged cells: ${refMatch[1]}, missing: ${!cell1Exists ? `${cell1Col}${cell1Row}` : `${cell2Col}${cell2Row}`}`);
-        }
-    }
     return { isValid: true };
 }
 // A function to check if two ranges intersect

package/build/esm/lib/template/utils/write-rows-to-stream.js

@@ -10,34 +10,74 @@ import { prepareRowToCells } from "./prepare-row-to-cells.js";
  * for the first row written to the file. Subsequent rows are written
  * with incrementing row numbers.
  *
- * @param output - A file write stream to write the Excel XML to.
- * @param rows - An async iterable of rows, where each row is an array
- *               of values.
- * @param startRowNumber - The starting row number to use for the first
- *                         row written to the file.
- *
- * @returns An object with a single property `rowNumber`, which is the
- *          last row number written to the file (i.e., the `startRowNumber`
- *          plus the number of rows written).
+ * @param {WritableLike} output - A file write stream to write the Excel XML to.
+ * @param {AsyncIterable<unknown[] | unknown[][]>} rows - An async iterable of rows, where each row is an array
+ *                                                        of values or an array of arrays of values.
+ * @param {number} startRowNumber - The starting row number to use for the first
+ *                                 row written to the file.
+ * @returns {Promise<{
+ *   dimension: {
+ *     maxColumn: string;
+ *     maxRow: number;
+ *     minColumn: string;
+ *     minRow: number;
+ *   };
+ *   rowNumber: number;
+ * }>} An object containing:
+ *   - dimension: The boundaries of the written data (min/max columns and rows)
+ *   - rowNumber: The last row number written to the file
  */
 export async function writeRowsToStream(output, rows, startRowNumber) {
     let rowNumber = startRowNumber;
+    const dimension = {
+        maxColumn: "A",
+        maxRow: startRowNumber,
+        minColumn: "A",
+        minRow: startRowNumber,
+    };
+    // Функция для сравнения колонок (A < B, AA > Z и т.д.)
+    const compareColumns = (a, b) => {
+        if (a === b)
+            return 0;
+        return a.length === b.length ? (a < b ? -1 : 1) : (a.length < b.length ? -1 : 1);
+    };
+    const processRow = (row, currentRowNumber) => {
+        const cells = prepareRowToCells(row, currentRowNumber);
+        if (cells.length === 0)
+            return;
+        output.write(`<row r="${currentRowNumber}">${cells.map(cell => cell.cellXml).join("")}</row>`);
+        // Обновление границ
+        const firstCellRef = cells[0]?.cellRef;
+        const lastCellRef = cells[cells.length - 1]?.cellRef;
+        if (firstCellRef) {
+            const colLetters = firstCellRef.match(/[A-Z]+/)?.[0] || "";
+            if (compareColumns(colLetters, dimension.minColumn) < 0) {
+                dimension.minColumn = colLetters;
+            }
+        }
+        if (lastCellRef) {
+            const colLetters = lastCellRef.match(/[A-Z]+/)?.[0] || "";
+            if (compareColumns(colLetters, dimension.maxColumn) > 0) {
+                dimension.maxColumn = colLetters;
+            }
+        }
+        dimension.maxRow = currentRowNumber;
+    };
     for await (const row of rows) {
-        // Transform the row into XML
+        if (!row.length)
+            continue;
         if (Array.isArray(row[0])) {
             for (const subRow of row) {
-                const cells = prepareRowToCells(subRow, rowNumber);
-                // Write the row to the file
-                output.write(`<row r="${rowNumber}">${cells.join("")}</row>`);
+                if (!subRow.length)
+                    continue;
+                processRow(subRow, rowNumber);
                 rowNumber++;
             }
         }
         else {
-            const cells = prepareRowToCells(row, rowNumber);
-            // Write the row to the file
-            output.write(`<row r="${rowNumber}">${cells.join("")}</row>`);
+            processRow(row, rowNumber);
             rowNumber++;
         }
     }
-    return { rowNumber };
+    return { dimension, rowNumber };
 }

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

@@ -135,6 +135,7 @@ export declare class TemplateFs {
      * @param {Object} data - The data to create the template from.
      * @param {string} data.source - The path or buffer of the Excel file.
      * @param {string} data.destination - The path to save the template to.
+     * @param {boolean} data.isUniqueDestination - Whether to add a random UUID to the destination path.
      * @returns {Promise<Template>} A new Template instance.
      * @throws {Error} If reading or writing files fails.
      * @experimental This API is experimental and might change in future versions.
@@ -142,5 +143,6 @@ export declare class TemplateFs {
     static from(data: {
         destination: string;
         source: string | Buffer;
+        isUniqueDestination?: boolean;
     }): Promise<TemplateFs>;
 }

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

@@ -11,6 +11,13 @@ export declare class TemplateMemory {
      * @type {boolean}
      */
     destroyed: boolean;
+    /**
+     * Creates a Template instance from a map of file paths to buffers.
+     *
+     * @param {Object<string, Buffer>} files - The files to create the template from.
+     * @throws {Error} If reading or writing files fails.
+     * @experimental This API is experimental and might change in future versions.
+     */
     constructor(files: Record<string, Buffer>);
     /**
      * Copies a sheet from the template to a new name.
@@ -55,6 +62,20 @@ export declare class TemplateMemory {
         startRowNumber?: number;
         rows: unknown[][];
     }): Promise<void>;
+    /**
+     * Inserts rows into a specific sheet in the template using an async stream.
+     *
+     * @param {Object} data - The data for row insertion.
+     * @param {string} data.sheetName - The name of the sheet to insert rows into.
+     * @param {number} [data.startRowNumber] - The row number to start inserting from.
+     * @param {AsyncIterable<unknown[]>} data.rows - Async iterable of rows to insert.
+     * @returns {Promise<void>}
+     * @throws {Error} If the template instance has been destroyed.
+     * @throws {Error} If the sheet does not exist.
+     * @throws {Error} If the row number is out of range.
+     * @throws {Error} If a column is out of range.
+     * @experimental This API is experimental and might change in future versions.
+     */
     insertRowsStream(data: {
         sheetName: string;
         startRowNumber?: number;
@@ -79,6 +100,46 @@ export declare class TemplateMemory {
      * @experimental This API is experimental and might change in future versions.
      */
     set(key: string, content: Buffer): Promise<void>;
+    /**
+     * Merges sheets into a base sheet.
+     *
+     * @param {Object} data
+     * @param {{ sheetIndexes?: number[]; sheetNames?: string[] }} data.additions - The sheets to merge.
+     * @param {number} [data.baseSheetIndex=1] - The 1-based index of the sheet to merge into.
+     * @param {string} [data.baseSheetName] - The name of the sheet to merge into.
+     * @param {number} [data.gap=0] - The number of empty rows to insert between each added section.
+     * @returns {void}
+     */
+    mergeSheets(data: {
+        additions: {
+            sheetIndexes?: number[];
+            sheetNames?: string[];
+        };
+        baseSheetIndex?: number;
+        baseSheetName?: string;
+        gap?: number;
+    }): 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[];
+    }): void;
+    /**
+     * Creates a Template instance from an Excel file source.
+     *
+     * @param {Object} data - The data to create the template from.
+     * @param {string | Buffer} data.source - The path or buffer of the Excel file.
+     * @returns {Promise<TemplateMemory>} A new Template instance.
+     * @throws {Error} If reading the file fails.
+     * @experimental This API is experimental and might change in future versions.
+     */
     static from(data: {
         source: string | Buffer;
     }): Promise<TemplateMemory>;

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

@@ -1,3 +1,4 @@
+export * as Common from "../../utils/index.js";
 export * from "./apply-replacements.js";
 export * from "./check-row.js";
 export * from "./check-rows.js";
@@ -14,6 +15,7 @@ export * from "./process-merge-cells.js";
 export * from "./process-merge-finalize.js";
 export * from "./process-rows.js";
 export * from "./process-shared-strings.js";
+export * from "./regexp.js";
 export * from "./to-excel-column-object.js";
 export * from "./update-dimension.js";
 export * from "./validate-worksheet-xml.js";

package/build/types/lib/template/utils/prepare-row-to-cells.d.ts

@@ -1 +1,5 @@
-export declare function prepareRowToCells(row: unknown[], rowNumber: number): string[];
+export declare function prepareRowToCells(row: unknown[], rowNumber: number): {
+    cellRef: string;
+    cellValue: string;
+    cellXml: string;
+}[];

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

@@ -0,0 +1,24 @@
+/**
+ * Creates a regular expression to match a relationship element with a specific ID.
+ *
+ * @param {string} id - The relationship ID to match (e.g. "rId1")
+ * @returns {RegExp} A regular expression that matches a Relationship XML element with the given ID and captures the Target attribute value
+ * @example
+ * const regex = relationshipMatch("rId1");
+ * const xml = '<Relationship Id="rId1" Target="worksheets/sheet1.xml"/>';
+ * const match = xml.match(regex);
+ * // match[1] === "worksheets/sheet1.xml"
+ */
+export declare function relationshipMatch(id: string): RegExp;
+/**
+ * Creates a regular expression to match a sheet element with a specific name.
+ *
+ * @param {string} sheetName - The name of the sheet to match
+ * @returns {RegExp} A regular expression that matches a sheet XML element with the given name and captures the r:id attribute value
+ * @example
+ * const regex = sheetMatch("Sheet1");
+ * const xml = '<sheet name="Sheet1" sheetId="1" r:id="rId1"/>';
+ * const match = xml.match(regex);
+ * // match[1] === "rId1"
+ */
+export declare function sheetMatch(sheetName: string): RegExp;

package/build/types/lib/template/utils/update-dimension.d.ts

@@ -1 +1,16 @@
+/**
+ * Updates the dimension element in an Excel worksheet XML string based on the actual cell references.
+ *
+ * This function scans the XML for all cell references and calculates the minimum and maximum
+ * column/row values to determine the actual used range in the worksheet. It then updates
+ * the dimension element to reflect this range.
+ *
+ * @param {string} xml - The worksheet XML string to process
+ * @returns {string} The XML string with updated dimension element
+ * @example
+ * // XML with cells from A1 to C3
+ * const xml = '....<dimension ref="A1:B2"/>.....<c r="C3">...</c>...';
+ * const updated = updateDimension(xml);
+ * // Returns XML with dimension updated to ref="A1:C3"
+ */
 export declare function updateDimension(xml: string): string;

package/build/types/lib/template/utils/write-rows-to-stream.d.ts

@@ -13,17 +13,30 @@ interface WritableLike {
  * for the first row written to the file. Subsequent rows are written
  * with incrementing row numbers.
  *
- * @param output - A file write stream to write the Excel XML to.
- * @param rows - An async iterable of rows, where each row is an array
- *               of values.
- * @param startRowNumber - The starting row number to use for the first
- *                         row written to the file.
- *
- * @returns An object with a single property `rowNumber`, which is the
- *          last row number written to the file (i.e., the `startRowNumber`
- *          plus the number of rows written).
+ * @param {WritableLike} output - A file write stream to write the Excel XML to.
+ * @param {AsyncIterable<unknown[] | unknown[][]>} rows - An async iterable of rows, where each row is an array
+ *                                                        of values or an array of arrays of values.
+ * @param {number} startRowNumber - The starting row number to use for the first
+ *                                 row written to the file.
+ * @returns {Promise<{
+ *   dimension: {
+ *     maxColumn: string;
+ *     maxRow: number;
+ *     minColumn: string;
+ *     minRow: number;
+ *   };
+ *   rowNumber: number;
+ * }>} An object containing:
+ *   - dimension: The boundaries of the written data (min/max columns and rows)
+ *   - rowNumber: The last row number written to the file
  */
 export declare function writeRowsToStream(output: WritableLike, rows: AsyncIterable<unknown[] | unknown[][]>, startRowNumber: number): Promise<{
+    dimension: {
+        maxColumn: string;
+        maxRow: number;
+        minColumn: string;
+        minRow: number;
+    };
     rowNumber: number;
 }>;
 export {};

package/package.json

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