xlkit 1.1.0 → 1.2.0

package/dist/Sheetflow.js

@@ -1,304 +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;
-const exceljs_1 = __importDefault(require("exceljs"));
-const style_1 = require("./utils/style");
-class XLKit {
-    constructor() {
-        this.workbook = new exceljs_1.default.Workbook();
-    }
-    addSheet(config) {
-        // Validate Sheet Name
-        if (!config.name) {
-            throw new Error('Sheet name is required.');
-        }
-        if (config.name.length > 31) {
-            throw new Error(`Sheet name "${config.name}" exceeds the maximum length of 31 characters.`);
-        }
-        // Invalid characters: \ / ? * [ ] :
-        const invalidChars = /[\\/?*[\]:]/;
-        if (invalidChars.test(config.name)) {
-            throw new Error(`Sheet name "${config.name}" contains invalid characters (\\ / ? * [ ] :).`);
-        }
-        const sheet = this.workbook.addWorksheet(config.name);
-        const data = config.rows;
-        // Handle autoWidth
-        const autoWidthConfig = typeof config.autoWidth === 'boolean'
-            ? { enabled: config.autoWidth }
-            : config.autoWidth || {};
-        const autoWidthEnabled = autoWidthConfig.enabled !== false;
-        // 1. Setup Columns & Headers
-        const columns = config.headers.map((header, colIndex) => {
-            let width = header.width;
-            // Apply autoWidth if no width specified and autoWidth is enabled
-            if (!width && autoWidthEnabled) {
-                width = 'auto';
-            }
-            if (width === 'auto') {
-                // Get header label text
-                const headerText = typeof header.label === 'string'
-                    ? header.label
-                    : header.label.value;
-                let maxLen = headerText.length * (autoWidthConfig.headerIncluded !== false ? 1 : 0);
-                // Check data length
-                data.forEach(row => {
-                    const cellData = row[header.key];
-                    const val = this.isCellValueWithStyle(cellData) ? cellData.value : cellData;
-                    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 = autoWidthConfig.padding ?? 2;
-                const constant = autoWidthConfig.charWidthConstant ?? 1.2;
-                width = (maxLen + padding) * constant;
-            }
-            // Get header label text for ExcelJS
-            const headerText = typeof header.label === 'string'
-                ? header.label
-                : header.label.value;
-            return {
-                header: headerText,
-                key: String(header.key),
-                width: typeof width === 'number' ? width : 15
-            };
-        });
-        sheet.columns = columns;
-        // 2. Apply Title Rows (if any)
-        if (config.title) {
-            const titleLabels = Array.isArray(config.title.label)
-                ? config.title.label
-                : [config.title.label];
-            titleLabels.forEach(titleText => {
-                const titleRow = sheet.insertRow(1, [titleText]);
-                // Merge title across all columns
-                if (config.headers.length > 1) {
-                    sheet.mergeCells(1, 1, 1, config.headers.length);
-                }
-                // Apply title style
-                if (config.title.style) {
-                    const mappedTitleStyle = (0, style_1.mapStyle)(config.title.style);
-                    titleRow.eachCell((cell) => {
-                        cell.style = { ...cell.style, ...mappedTitleStyle };
-                    });
-                }
-            });
-        }
-        // Calculate header row index (after title rows)
-        const titleRowCount = config.title
-            ? (Array.isArray(config.title.label) ? config.title.label.length : 1)
-            : 0;
-        const headerRowIndex = titleRowCount + 1;
-        // 3. Apply Header Cell Styles (from headers[].label.style)
-        const headerRow = sheet.getRow(headerRowIndex);
-        config.headers.forEach((header, colIndex) => {
-            if (typeof header.label === 'object' && header.label.style) {
-                const cell = headerRow.getCell(colIndex + 1);
-                const mappedStyle = (0, style_1.mapStyle)(header.label.style);
-                cell.style = { ...cell.style, ...mappedStyle };
-            }
-        });
-        // 4. Apply Header Row Style (from styles.header)
-        if (config.styles?.header) {
-            const mappedHeaderStyle = (0, style_1.mapStyle)(config.styles.header);
-            headerRow.eachCell((cell) => {
-                cell.style = { ...cell.style, ...mappedHeaderStyle };
-            });
-        }
-        // 5. Apply styles.all to header row
-        if (config.styles?.all) {
-            const mappedAllStyle = (0, style_1.mapStyle)(config.styles.all);
-            headerRow.eachCell((cell) => {
-                cell.style = { ...mappedAllStyle, ...cell.style };
-            });
-        }
-        // 6. Add Data & Apply Styles
-        data.forEach((rowData, rowIndex) => {
-            const rowValues = {};
-            // Extract values from row data
-            config.headers.forEach(header => {
-                const cellData = rowData[header.key];
-                rowValues[header.key] = this.isCellValueWithStyle(cellData) ? cellData.value : cellData;
-            });
-            const addedRow = sheet.addRow(rowValues);
-            const excelRowIndex = headerRowIndex + rowIndex + 1;
-            // Apply styles to each cell
-            config.headers.forEach((header, colIndex) => {
-                const cell = addedRow.getCell(colIndex + 1);
-                const cellData = rowData[header.key];
-                const cellValue = this.isCellValueWithStyle(cellData) ? cellData.value : cellData;
-                // Apply styles in priority order
-                let finalStyle = {};
-                // 1. styles.all
-                if (config.styles?.all) {
-                    finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(config.styles.all) };
-                }
-                // 2. styles.body
-                if (config.styles?.body) {
-                    finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(config.styles.body) };
-                }
-                // 3. styles.column[key]
-                if (config.styles?.column?.[header.key]) {
-                    finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(config.styles.column[header.key]) };
-                }
-                // 4. styles.row(data, index)
-                if (config.styles?.row) {
-                    const rowStyle = config.styles.row(rowData, rowIndex);
-                    finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(rowStyle) };
-                }
-                // 5. headers[].style (object or function)
-                if (header.style) {
-                    if (typeof header.style === 'function') {
-                        const cellStyle = header.style(cellValue, rowData, rowIndex);
-                        finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(cellStyle) };
-                    }
-                    else {
-                        finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(header.style) };
-                    }
-                }
-                // 6. rows[].{key}.style (highest priority)
-                if (this.isCellValueWithStyle(cellData) && cellData.style) {
-                    finalStyle = { ...finalStyle, ...(0, style_1.mapStyle)(cellData.style) };
-                }
-                cell.style = finalStyle;
-                // Apply format
-                if (header.format) {
-                    if (typeof header.format === 'string') {
-                        cell.numFmt = header.format;
-                    }
-                    else {
-                        cell.value = header.format(cellValue);
-                    }
-                }
-            });
-        });
-        // 7. Apply Vertical Merges
-        config.headers.forEach((header, colIndex) => {
-            if (header.merge === 'vertical') {
-                let startRow = headerRowIndex + 1; // First data row
-                let previousValue = null;
-                // Iterate from first data row to last
-                for (let i = 0; i < data.length; i++) {
-                    const currentRowIndex = headerRowIndex + i + 1;
-                    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 = headerRowIndex + data.length;
-                if (lastRowIndex > startRow) {
-                    sheet.mergeCells(startRow, colIndex + 1, lastRowIndex, colIndex + 1);
-                }
-            }
-        });
-        // 8. Apply Borders
-        if (config.borders === 'all') {
-            sheet.eachRow((row) => {
-                row.eachCell((cell) => {
-                    cell.border = {
-                        top: { style: 'thin' },
-                        left: { style: 'thin' },
-                        bottom: { style: 'thin' },
-                        right: { style: 'thin' }
-                    };
-                });
-            });
-        }
-        else if (config.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 (config.borders === 'header-body') {
-            const lastCol = sheet.columnCount;
-            for (let c = 1; c <= lastCol; c++) {
-                const headerCell = sheet.getCell(headerRowIndex, c);
-                headerCell.border = { ...headerCell.border, bottom: { style: 'medium' } };
-            }
-        }
-        return this;
-    }
-    isCellValueWithStyle(val) {
-        return val !== null &&
-            typeof val === 'object' &&
-            'value' in val &&
-            !Array.isArray(val) &&
-            !(val instanceof Date);
-    }
-    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();
-}

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,57 +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 type CellValue = any | {
-    value: any;
-    style?: XLStyle;
-};
-export interface HeaderDef {
-    key: string;
-    label: string | {
-        value: string;
-        style?: XLStyle;
-    };
-    width?: number | 'auto';
-    merge?: 'vertical';
-    style?: XLStyle | ((val: any, row: any, index: number) => XLStyle);
-    format?: string | ((val: any) => string);
-}
-export interface TitleConfig {
-    label: string | string[];
-    style?: XLStyle;
-}
-export interface StylesConfig {
-    all?: XLStyle;
-    header?: XLStyle;
-    body?: XLStyle;
-    row?: (data: any, index: number) => XLStyle;
-    column?: {
-        [key: string]: XLStyle;
-    };
-}
-export interface SheetConfig {
-    name: string;
-    headers: HeaderDef[];
-    rows: any[];
-    title?: TitleConfig;
-    styles?: StylesConfig;
-    borders?: 'all' | 'outer' | 'header-body' | 'none';
-    autoWidth?: boolean | {
-        enabled?: boolean;
-        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;AAGD,MAAM,MAAM,SAAS,GAAG,GAAG,GAAG;IAC5B,KAAK,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IACnD,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC;IACnE,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrC;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC;IACnD,SAAS,CAAC,EAAE,OAAO,GAAG;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,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;
-}