xlkit 1.0.5 → 1.2.0

package/dist/Sheetflow.js

@@ -1,335 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XLKit = void 0;
-exports.createWorkbook = createWorkbook;
-exports.defineSheet = defineSheet;
-const exceljs_1 = __importDefault(require("exceljs"));
-const style_1 = require("./utils/style");
-class XLKit {
-    constructor() {
-        this.workbook = new exceljs_1.default.Workbook();
-    }
-    addSheet(def, data) {
-        // Validate Sheet Name
-        if (!def.name) {
-            throw new Error('Sheet name is required.');
-        }
-        if (def.name.length > 31) {
-            throw new Error(`Sheet name "${def.name}" exceeds the maximum length of 31 characters.`);
-        }
-        // Invalid characters: \ / ? * [ ] :
-        const invalidChars = /[\\/?*[\]:]/;
-        if (invalidChars.test(def.name)) {
-            throw new Error(`Sheet name "${def.name}" contains invalid characters (\\ / ? * [ ] :).`);
-        }
-        const sheet = this.workbook.addWorksheet(def.name);
-        // 1. Setup Columns
-        const columns = def.columns.map((col, colIndex) => {
-            let width = col.width;
-            // Validate Column Key
-            if (col.key === 'style') {
-                throw new Error("Column key 'style' is reserved for row styling and cannot be used as a column key.");
-            }
-            if (width === 'auto') {
-                let maxLen = col.header.length * (def.autoWidth?.headerIncluded !== false ? 1 : 0);
-                // Check data length (sample first 100 rows for performance if needed, currently all)
-                data.forEach(row => {
-                    const val = row[col.key];
-                    const str = val != null ? String(val) : '';
-                    // Simple full-width check: count as 2 if char code > 255
-                    let len = 0;
-                    for (let i = 0; i < str.length; i++) {
-                        len += str.charCodeAt(i) > 255 ? 2 : 1;
-                    }
-                    if (len > maxLen)
-                        maxLen = len;
-                });
-                const padding = def.autoWidth?.padding ?? 2;
-                const constant = def.autoWidth?.charWidthConstant ?? 1.2;
-                width = (maxLen + padding) * constant;
-            }
-            return {
-                header: col.header,
-                key: String(col.key),
-                width: typeof width === 'number' ? width : 15,
-                style: col.style && typeof col.style === 'object' ? (0, style_1.mapStyle)(col.style) : undefined
-            };
-        });
-        sheet.columns = columns;
-        // 2. Setup Headers (Multi-line support)
-        let headerRowCount = 1;
-        if (def.header?.rows) {
-            headerRowCount = def.header.rows.length;
-            // Clear default header row if we are using custom rows
-            sheet.spliceRows(1, 1);
-            def.header.rows.forEach((row, rowIndex) => {
-                const currentSheetRowIndex = rowIndex + 1;
-                const sheetRow = sheet.getRow(currentSheetRowIndex);
-                let colIndex = 1;
-                row.forEach((cellConfig) => {
-                    // Find next available cell (skip merged cells)
-                    while (sheet.getCell(currentSheetRowIndex, colIndex).isMerged) {
-                        colIndex++;
-                    }
-                    const cell = sheet.getCell(currentSheetRowIndex, colIndex);
-                    if (typeof cellConfig === 'string') {
-                        cell.value = cellConfig;
-                        colIndex++;
-                    }
-                    else {
-                        cell.value = cellConfig.value;
-                        if (cellConfig.style) {
-                            cell.style = { ...cell.style, ...(0, style_1.mapStyle)(cellConfig.style) };
-                        }
-                        const rowSpan = cellConfig.rowSpan || 1;
-                        const colSpan = cellConfig.colSpan || 1;
-                        if (rowSpan > 1 || colSpan > 1) {
-                            sheet.mergeCells(currentSheetRowIndex, colIndex, currentSheetRowIndex + rowSpan - 1, colIndex + colSpan - 1);
-                        }
-                        colIndex += colSpan;
-                    }
-                });
-            });
-        }
-        // 3. Add Data & Apply Row Styles
-        const dataStartRow = headerRowCount + 1;
-        data.forEach((row, index) => {
-            const rowIndex = dataStartRow + index;
-            // We can't use addRow easily because it appends to the end, but we might have gaps if we messed with rows?
-            // Actually addRow is fine as long as we are consistent.
-            // But since we might have complex headers, let's be explicit with getRow to be safe or just use addRow if we know we are at the end.
-            // For safety with existing header logic, let's use explicit row rendering for data to ensure alignment.
-            const sheetRow = sheet.getRow(rowIndex);
-            def.columns.forEach((col, colIndex) => {
-                const cell = sheetRow.getCell(colIndex + 1);
-                cell.value = row[col.key];
-            });
-            // Apply row-level style from definition
-            if (def.rows?.style) {
-                const rowStyle = def.rows.style(row, index);
-                const mappedStyle = (0, style_1.mapStyle)(rowStyle);
-                sheetRow.eachCell((cell) => {
-                    cell.style = { ...cell.style, ...mappedStyle };
-                });
-            }
-            // Apply row-level style from data (if 'style' property exists)
-            if (row.style) {
-                const dataRowStyle = row.style;
-                const mappedStyle = (0, style_1.mapStyle)(dataRowStyle);
-                sheetRow.eachCell((cell) => {
-                    cell.style = { ...cell.style, ...mappedStyle };
-                });
-            }
-            // Apply column-level conditional styles
-            def.columns.forEach((col, colIndex) => {
-                if (typeof col.style === 'function') {
-                    const cell = sheetRow.getCell(colIndex + 1);
-                    const cellStyle = col.style(row[col.key], row, index);
-                    cell.style = { ...cell.style, ...(0, style_1.mapStyle)(cellStyle) };
-                }
-                if (col.format) {
-                    const cell = sheetRow.getCell(colIndex + 1);
-                    if (typeof col.format === 'string') {
-                        cell.numFmt = col.format;
-                    }
-                    else {
-                        cell.value = col.format(row[col.key]);
-                    }
-                }
-            });
-            sheetRow.commit();
-        });
-        // 4. Apply Header Styles (Global)
-        if (def.header?.style) {
-            const mappedHeaderStyle = (0, style_1.mapStyle)(def.header.style);
-            // Apply to all header rows
-            for (let i = 1; i <= headerRowCount; i++) {
-                const row = sheet.getRow(i);
-                row.eachCell((cell) => {
-                    // Merge with existing style (cell specific style takes precedence if we did it right, but here we are applying global header style)
-                    // Usually global header style is base, cell specific is override. 
-                    // But here we apply global AFTER. Let's apply it only if no style? 
-                    // Or just merge.
-                    cell.style = { ...mappedHeaderStyle, ...cell.style };
-                });
-            }
-        }
-        // 5. Apply Vertical Merges
-        def.columns.forEach((col, colIndex) => {
-            if (col.merge === 'vertical') {
-                let startRow = dataStartRow;
-                let previousValue = null;
-                // Iterate from first data row to last
-                for (let i = 0; i < data.length; i++) {
-                    const currentRowIndex = dataStartRow + i;
-                    const cell = sheet.getCell(currentRowIndex, colIndex + 1);
-                    const currentValue = cell.value;
-                    if (i === 0) {
-                        previousValue = currentValue;
-                        continue;
-                    }
-                    // If value changed or it's the last row, process the merge
-                    if (currentValue !== previousValue) {
-                        if (currentRowIndex - 1 > startRow) {
-                            sheet.mergeCells(startRow, colIndex + 1, currentRowIndex - 1, colIndex + 1);
-                        }
-                        startRow = currentRowIndex;
-                        previousValue = currentValue;
-                    }
-                }
-                // Handle the last group
-                const lastRowIndex = dataStartRow + data.length; // This is actually the row AFTER the last data row index if we use <
-                // Wait, loop goes 0 to length-1.
-                // If i=length-1 (last item), we check logic.
-                // We need to handle the merge AFTER the loop for the final group.
-                if (data.length > 0) {
-                    const finalRowIndex = dataStartRow + data.length - 1;
-                    if (finalRowIndex > startRow) {
-                        sheet.mergeCells(startRow, colIndex + 1, finalRowIndex, colIndex + 1);
-                    }
-                }
-            }
-        });
-        // 6. Apply Horizontal Merges
-        // We iterate row by row
-        for (let i = 0; i < data.length; i++) {
-            const currentRowIndex = dataStartRow + i;
-            const row = sheet.getRow(currentRowIndex);
-            let startCol = 1;
-            let previousValue = null;
-            let merging = false;
-            // We need to check which columns are candidates for horizontal merge.
-            // A simple approach: iterate columns. If current col has merge='horizontal', try to merge with next.
-            // But we need to group them.
-            for (let c = 0; c < def.columns.length; c++) {
-                const colDef = def.columns[c];
-                const currentCell = row.getCell(c + 1);
-                const currentValue = currentCell.value;
-                if (colDef.merge === 'horizontal') {
-                    if (!merging) {
-                        merging = true;
-                        startCol = c + 1;
-                        previousValue = currentValue;
-                    }
-                    else {
-                        if (currentValue !== previousValue) {
-                            // End of a merge group
-                            if ((c + 1) - 1 > startCol) {
-                                sheet.mergeCells(currentRowIndex, startCol, currentRowIndex, c);
-                            }
-                            // Start new group
-                            startCol = c + 1;
-                            previousValue = currentValue;
-                        }
-                    }
-                }
-                else {
-                    if (merging) {
-                        // End of merge group because this column is not mergeable
-                        if ((c + 1) - 1 > startCol) {
-                            sheet.mergeCells(currentRowIndex, startCol, currentRowIndex, c);
-                        }
-                        merging = false;
-                    }
-                }
-            }
-            // Check at end of row
-            if (merging) {
-                const lastCol = def.columns.length;
-                if (lastCol > startCol) {
-                    sheet.mergeCells(currentRowIndex, startCol, currentRowIndex, lastCol);
-                }
-            }
-        }
-        // 7. Apply Borders
-        if (def.borders === 'all') {
-            sheet.eachRow((row) => {
-                row.eachCell((cell) => {
-                    cell.border = {
-                        top: { style: 'thin' },
-                        left: { style: 'thin' },
-                        bottom: { style: 'thin' },
-                        right: { style: 'thin' }
-                    };
-                });
-            });
-        }
-        else if (def.borders === 'outer') {
-            const lastRow = sheet.rowCount;
-            const lastCol = sheet.columnCount;
-            // Top & Bottom
-            for (let c = 1; c <= lastCol; c++) {
-                const topCell = sheet.getCell(1, c);
-                topCell.border = { ...topCell.border, top: { style: 'thin' } };
-                const bottomCell = sheet.getCell(lastRow, c);
-                bottomCell.border = { ...bottomCell.border, bottom: { style: 'thin' } };
-            }
-            // Left & Right
-            for (let r = 1; r <= lastRow; r++) {
-                const leftCell = sheet.getCell(r, 1);
-                leftCell.border = { ...leftCell.border, left: { style: 'thin' } };
-                const rightCell = sheet.getCell(r, lastCol);
-                rightCell.border = { ...rightCell.border, right: { style: 'thin' } };
-            }
-        }
-        else if (def.borders === 'header-body') {
-            const lastCol = sheet.columnCount;
-            // Apply to the last row of the header
-            for (let c = 1; c <= lastCol; c++) {
-                const headerCell = sheet.getCell(headerRowCount, c);
-                headerCell.border = { ...headerCell.border, bottom: { style: 'medium' } };
-            }
-        }
-        return this;
-    }
-    async save(path, options) {
-        if (!path || path.trim() === '') {
-            throw new Error('File path cannot be empty.');
-        }
-        if (typeof process !== 'undefined' && process.versions && process.versions.node) {
-            const timeout = options?.timeout ?? 10000; // Default 10s
-            const writePromise = this.workbook.xlsx.writeFile(path);
-            const timeoutPromise = new Promise((_, reject) => {
-                setTimeout(() => reject(new Error(`Operation timed out after ${timeout}ms`)), timeout);
-            });
-            await Promise.race([writePromise, timeoutPromise]);
-        }
-        else {
-            throw new Error('File system access is only available in Node.js environment. Use saveToBuffer() instead.');
-        }
-    }
-    async saveToBuffer(options) {
-        const timeout = options?.timeout ?? 10000; // Default 10s
-        const writePromise = this.workbook.xlsx.writeBuffer();
-        const timeoutPromise = new Promise((_, reject) => {
-            setTimeout(() => reject(new Error(`Operation timed out after ${timeout}ms`)), timeout);
-        });
-        const buffer = await Promise.race([writePromise, timeoutPromise]);
-        return new Uint8Array(buffer);
-    }
-    async download(filename, options) {
-        if (typeof window === 'undefined' || typeof document === 'undefined') {
-            throw new Error('download() is only available in browser environment. Use save() for Node.js or saveToBuffer() for custom handling.');
-        }
-        const buffer = await this.saveToBuffer(options);
-        const blob = new Blob([buffer.buffer], {
-            type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-        });
-        const url = URL.createObjectURL(blob);
-        const a = document.createElement('a');
-        a.href = url;
-        a.download = filename;
-        a.click();
-        URL.revokeObjectURL(url);
-    }
-}
-exports.XLKit = XLKit;
-function createWorkbook() {
-    return new XLKit();
-}
-function defineSheet(def) {
-    return def;
-}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}

package/dist/types.d.ts

@@ -1,49 +0,0 @@
-import { Alignment, Border, Fill, Font } from 'exceljs';
-export type HexColor = string;
-export interface XLStyle {
-    font?: Partial<Font> & {
-        color?: HexColor | {
-            argb: string;
-        };
-    };
-    fill?: Partial<Fill> & {
-        color?: HexColor;
-    };
-    alignment?: Partial<Alignment>;
-    border?: Partial<Border> | 'all' | 'outer' | 'header-body' | 'none';
-}
-export interface ColumnDef<T> {
-    key: keyof T;
-    header: string;
-    width?: number | 'auto';
-    merge?: 'vertical' | 'horizontal';
-    style?: XLStyle | ((val: any, row: T, index: number) => XLStyle);
-    format?: string | ((val: any) => string);
-}
-export interface HeaderCell {
-    value: string;
-    colSpan?: number;
-    rowSpan?: number;
-    style?: XLStyle;
-}
-export interface HeaderConfig {
-    rows?: (string | HeaderCell)[][];
-    style?: XLStyle;
-    borders?: 'header-body' | 'all' | 'none';
-}
-export interface SheetDef<T> {
-    name: string;
-    columns: ColumnDef<T>[];
-    header?: HeaderConfig;
-    rows?: {
-        style?: (data: T, index: number) => XLStyle;
-    };
-    defaultStyle?: XLStyle;
-    borders?: 'all' | 'outer' | 'header-body' | 'none';
-    autoWidth?: {
-        padding?: number;
-        headerIncluded?: boolean;
-        charWidthConstant?: number;
-    };
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/D,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,WAAW,OAAO;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,QAAQ,GAAG;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAC/D,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,QAAQ,CAAA;KAAE,CAAC;IAC5C,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC;CACrE;AAED,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IAClC,KAAK,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC;IACjE,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,UAAU,CAAC,EAAE,EAAE,CAAC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,aAAa,GAAG,KAAK,GAAG,MAAM,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE;QACL,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;KAC7C,CAAC;IACF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC;IACnD,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH"}

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/color.d.ts

@@ -1,2 +0,0 @@
-export declare function toArgb(hex: string): string;
-//# sourceMappingURL=color.d.ts.map

package/dist/utils/color.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../src/utils/color.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAY1C"}

package/dist/utils/color.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toArgb = toArgb;
-function toArgb(hex) {
-    if (!hex)
-        return 'FF000000';
-    if (hex.startsWith('#')) {
-        hex = hex.slice(1);
-    }
-    if (hex.length === 3) {
-        hex = hex.split('').map(c => c + c).join('');
-    }
-    if (hex.length === 6) {
-        return 'FF' + hex.toUpperCase();
-    }
-    return hex.toUpperCase(); // Assume already ARGB or invalid
-}

package/dist/utils/style.d.ts

@@ -1,4 +0,0 @@
-import { Style } from 'exceljs';
-import { XLStyle } from '../types';
-export declare function mapStyle(style: XLStyle): Partial<Style>;
-//# sourceMappingURL=style.d.ts.map

package/dist/utils/style.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"style.d.ts","sourceRoot":"","sources":["../../src/utils/style.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAW,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnC,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAqCvD"}

package/dist/utils/style.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapStyle = mapStyle;
-const color_1 = require("./color");
-function mapStyle(style) {
-    const excelStyle = {};
-    if (style.font) {
-        excelStyle.font = { ...style.font };
-        if (typeof style.font.color === 'string') {
-            excelStyle.font.color = { argb: (0, color_1.toArgb)(style.font.color) };
-        }
-    }
-    if (style.fill) {
-        if (style.fill.color) {
-            excelStyle.fill = {
-                type: 'pattern',
-                pattern: 'solid',
-                fgColor: { argb: (0, color_1.toArgb)(style.fill.color) },
-            };
-        }
-        else {
-            // If no color is specified but fill is provided, use it as-is
-            excelStyle.fill = style.fill;
-        }
-    }
-    if (style.alignment) {
-        excelStyle.alignment = style.alignment;
-    }
-    if (style.border) {
-        if (typeof style.border === 'string') {
-            // Presets handled in main logic or expanded here
-            // For now, we'll handle explicit border objects here
-        }
-        else {
-            excelStyle.border = style.border;
-        }
-    }
-    return excelStyle;
-}