@niicojs/excel 0.3.0 → 0.3.2

package/dist/index.cjs

@@ -106,6 +106,334 @@ var fflate = require('fflate');
     };
 };
 
+const DEFAULT_LOCALE = 'fr-FR';
+const formatPartsCache = new Map();
+const getLocaleNumberInfo = (locale)=>{
+    const cacheKey = `num-info:${locale}`;
+    const cached = formatPartsCache.get(cacheKey);
+    if (cached) {
+        const decimal = cached.find((p)=>p.type === 'decimal')?.value ?? ',';
+        const group = cached.find((p)=>p.type === 'group')?.value ?? ' ';
+        return {
+            decimal,
+            group
+        };
+    }
+    const parts = new Intl.NumberFormat(locale).formatToParts(12345.6);
+    formatPartsCache.set(cacheKey, parts);
+    const decimal = parts.find((p)=>p.type === 'decimal')?.value ?? ',';
+    const group = parts.find((p)=>p.type === 'group')?.value ?? ' ';
+    return {
+        decimal,
+        group
+    };
+};
+const normalizeSpaces = (value)=>{
+    return value.replace(/[\u00a0\u202f]/g, ' ');
+};
+const splitFormatSections = (format)=>{
+    const sections = [];
+    let current = '';
+    let inQuote = false;
+    for(let i = 0; i < format.length; i++){
+        const ch = format[i];
+        if (ch === '"') {
+            inQuote = !inQuote;
+            current += ch;
+            continue;
+        }
+        if (ch === ';' && !inQuote) {
+            sections.push(current);
+            current = '';
+            continue;
+        }
+        current += ch;
+    }
+    sections.push(current);
+    return sections;
+};
+const extractFormatLiterals = (format)=>{
+    let prefix = '';
+    let suffix = '';
+    let cleaned = '';
+    let inQuote = false;
+    let sawPlaceholder = false;
+    for(let i = 0; i < format.length; i++){
+        const ch = format[i];
+        if (ch === '"') {
+            inQuote = !inQuote;
+            continue;
+        }
+        if (inQuote) {
+            if (!sawPlaceholder) {
+                prefix += ch;
+            } else {
+                suffix += ch;
+            }
+            continue;
+        }
+        if (ch === '\\' && i + 1 < format.length) {
+            const escaped = format[i + 1];
+            if (!sawPlaceholder) {
+                prefix += escaped;
+            } else {
+                suffix += escaped;
+            }
+            i++;
+            continue;
+        }
+        if (ch === '_' || ch === '*') {
+            if (i + 1 < format.length) {
+                i++;
+            }
+            continue;
+        }
+        if (ch === '[') {
+            const end = format.indexOf(']', i + 1);
+            if (end !== -1) {
+                const content = format.slice(i + 1, end);
+                const currencyMatch = content.match(/[$€]/);
+                if (currencyMatch) {
+                    if (!sawPlaceholder) {
+                        prefix += currencyMatch[0];
+                    } else {
+                        suffix += currencyMatch[0];
+                    }
+                }
+                i = end;
+                continue;
+            }
+        }
+        if (ch === '%') {
+            if (!sawPlaceholder) {
+                prefix += ch;
+            } else {
+                suffix += ch;
+            }
+            continue;
+        }
+        if (ch === '0' || ch === '#' || ch === '?' || ch === '.' || ch === ',') {
+            sawPlaceholder = true;
+            cleaned += ch;
+            continue;
+        }
+        if (!sawPlaceholder) {
+            prefix += ch;
+        } else {
+            suffix += ch;
+        }
+    }
+    return {
+        cleaned,
+        prefix,
+        suffix
+    };
+};
+const parseNumberFormat = (format)=>{
+    const trimmed = format.trim();
+    if (!trimmed) return null;
+    const { cleaned, prefix, suffix } = extractFormatLiterals(trimmed);
+    const lower = cleaned.toLowerCase();
+    if (!/[0#?]/.test(lower)) return null;
+    const percent = /%/.test(trimmed);
+    const section = lower;
+    const lastDot = section.lastIndexOf('.');
+    const lastComma = section.lastIndexOf(',');
+    let decimalSeparator = null;
+    if (lastDot >= 0 && lastComma >= 0) {
+        decimalSeparator = lastDot > lastComma ? '.' : ',';
+    } else if (lastDot >= 0 || lastComma >= 0) {
+        const candidate = lastDot >= 0 ? '.' : ',';
+        const index = lastDot >= 0 ? lastDot : lastComma;
+        const fractionSection = section.slice(index + 1);
+        const fractionDigitsCandidate = fractionSection.replace(/[^0#?]/g, '').length;
+        if (fractionDigitsCandidate > 0) {
+            if (fractionDigitsCandidate === 3) {
+                decimalSeparator = null;
+            } else {
+                decimalSeparator = candidate;
+            }
+        }
+    }
+    let decimalIndex = decimalSeparator === '.' ? lastDot : decimalSeparator === ',' ? lastComma : -1;
+    if (decimalIndex >= 0) {
+        const fractionSection = section.slice(decimalIndex + 1);
+        if (!/[0#?]/.test(fractionSection)) {
+            decimalIndex = -1;
+        }
+    }
+    const decimalSection = decimalIndex >= 0 ? section.slice(decimalIndex + 1) : '';
+    const fractionDigits = decimalSection.replace(/[^0#?]/g, '').length;
+    const integerSection = decimalIndex >= 0 ? section.slice(0, decimalIndex) : section;
+    const useGrouping = /[,.\s\u00a0\u202f]/.test(integerSection) && integerSection.length > 0;
+    return {
+        fractionDigits,
+        percent,
+        useGrouping,
+        literalPrefix: prefix || undefined,
+        literalSuffix: suffix || undefined
+    };
+};
+const formatNumber = (value, info, locale)=>{
+    const adjusted = info.percent ? value * 100 : value;
+    const { decimal, group } = getLocaleNumberInfo(locale);
+    const absValue = Math.abs(adjusted);
+    const fixed = absValue.toFixed(info.fractionDigits);
+    const [integerPart, fractionPart] = fixed.split('.');
+    const grouped = info.useGrouping ? integerPart.replace(/\B(?=(\d{3})+(?!\d))/g, group) : integerPart;
+    const fraction = info.fractionDigits > 0 ? `${decimal}${fractionPart}` : '';
+    const signed = adjusted < 0 ? '-' : '';
+    let result = `${signed}${grouped}${fraction}`;
+    if (info.literalPrefix) {
+        result = `${info.literalPrefix}${result}`;
+    }
+    if (info.literalSuffix) {
+        result = `${result}${info.literalSuffix}`;
+    }
+    return normalizeSpaces(result);
+};
+const padNumber = (value, length)=>{
+    const str = String(value);
+    return str.length >= length ? str : `${'0'.repeat(length - str.length)}${str}`;
+};
+const formatDatePart = (value, token, locale)=>{
+    switch(token){
+        case 'yyyy':
+            return String(value.getFullYear());
+        case 'yy':
+            return padNumber(value.getFullYear() % 100, 2);
+        case 'mmmm':
+            return value.toLocaleString(locale, {
+                month: 'long'
+            });
+        case 'mmm':
+            return value.toLocaleString(locale, {
+                month: 'short'
+            });
+        case 'mm':
+            return padNumber(value.getMonth() + 1, 2);
+        case 'm':
+            return String(value.getMonth() + 1);
+        case 'dd':
+            return padNumber(value.getDate(), 2);
+        case 'd':
+            return String(value.getDate());
+        case 'hh':
+            {
+                const hours = value.getHours();
+                return padNumber(hours, 2);
+            }
+        case 'h':
+            return String(value.getHours());
+        case 'min2':
+            return padNumber(value.getMinutes(), 2);
+        case 'min1':
+            return String(value.getMinutes());
+        case 'ss':
+            return padNumber(value.getSeconds(), 2);
+        case 's':
+            return String(value.getSeconds());
+        default:
+            return token;
+    }
+};
+const tokenizeDateFormat = (format)=>{
+    const tokens = [];
+    let i = 0;
+    while(i < format.length){
+        const ch = format[i];
+        if (ch === '"') {
+            let literal = '';
+            i++;
+            while(i < format.length && format[i] !== '"'){
+                literal += format[i];
+                i++;
+            }
+            i++;
+            if (literal) tokens.push(literal);
+            continue;
+        }
+        if (ch === '\\' && i + 1 < format.length) {
+            tokens.push(format[i + 1]);
+            i += 2;
+            continue;
+        }
+        if (ch === '[') {
+            const end = format.indexOf(']', i + 1);
+            if (end !== -1) {
+                i = end + 1;
+                continue;
+            }
+        }
+        const lower = format.slice(i).toLowerCase();
+        const match = [
+            'yyyy',
+            'yy',
+            'mmmm',
+            'mmm',
+            'mm',
+            'm',
+            'dd',
+            'd',
+            'hh',
+            'h',
+            'ss',
+            's'
+        ].find((t)=>lower.startsWith(t));
+        if (match) {
+            if (match === 'm' || match === 'mm') {
+                let j = i - 1;
+                let previousChar = '';
+                while(j >= 0 && previousChar === ''){
+                    const candidate = format[j];
+                    if (candidate && candidate !== ' ') {
+                        previousChar = candidate;
+                    }
+                    j--;
+                }
+                const isMinute = previousChar === 'h' || previousChar === 'H' || previousChar === ':';
+                if (isMinute) {
+                    tokens.push(match === 'mm' ? 'min2' : 'min1');
+                    i += match.length;
+                    continue;
+                }
+            }
+            tokens.push(match);
+            i += match.length;
+            continue;
+        }
+        tokens.push(ch);
+        i++;
+    }
+    return tokens;
+};
+const isDateFormat = (format)=>{
+    const lowered = format.toLowerCase();
+    return /[ymdhss]/.test(lowered);
+};
+const formatDate = (value, format, locale)=>{
+    const tokens = tokenizeDateFormat(format);
+    return tokens.map((token)=>formatDatePart(value, token, locale)).join('');
+};
+const formatCellValue = (value, style, locale)=>{
+    const numberFormat = style?.numberFormat;
+    if (!numberFormat) return null;
+    const normalizedLocale = locale || DEFAULT_LOCALE;
+    const sections = splitFormatSections(numberFormat);
+    const hasNegativeSection = sections.length > 1;
+    const section = value instanceof Date ? sections[0] : value < 0 ? sections[1] ?? sections[0] : sections[0];
+    if (value instanceof Date && isDateFormat(section)) {
+        return formatDate(value, section, normalizedLocale);
+    }
+    if (typeof value === 'number') {
+        const info = parseNumberFormat(section);
+        if (!info) return null;
+        const numericValue = value < 0 && hasNegativeSection ? Math.abs(value) : value;
+        return formatNumber(numericValue, info, normalizedLocale);
+    }
+    return null;
+};
+
 // Excel epoch: December 30, 1899 (accounting for the 1900 leap year bug)
 const EXCEL_EPOCH = new Date(Date.UTC(1899, 11, 30));
 const MS_PER_DAY = 24 * 60 * 60 * 1000;
@@ -306,12 +634,21 @@ const ERROR_TYPES = new Set([
     /**
    * Get the formatted text (as displayed in Excel)
    */ get text() {
+        return this.textWithLocale();
+    }
+    /**
+   * Get the formatted text using a specific locale
+   */ textWithLocale(locale) {
         if (this._data.w) {
             return this._data.w;
         }
         const val = this.value;
         if (val === null) return '';
         if (typeof val === 'object' && 'error' in val) return val.error;
+        if (val instanceof Date || typeof val === 'number') {
+            const formatted = formatCellValue(val, this.style, locale ?? this._worksheet.workbook.locale);
+            if (formatted !== null) return formatted;
+        }
         if (val instanceof Date) return val.toISOString().split('T')[0];
         return String(val);
     }
@@ -933,8 +1270,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
     }
 }
 
-/**
- * Represents a worksheet in a workbook
+/**
+ * Represents a worksheet in a workbook
  */ class Worksheet {
     constructor(workbook, name){
         this._cells = new Map();
@@ -956,24 +1293,24 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._workbook = workbook;
         this._name = name;
     }
-    /**
-   * Get the workbook this sheet belongs to
+    /**
+   * Get the workbook this sheet belongs to
    */ get workbook() {
         return this._workbook;
     }
-    /**
-   * Get the sheet name
+    /**
+   * Get the sheet name
    */ get name() {
         return this._name;
     }
-    /**
-   * Set the sheet name
+    /**
+   * Set the sheet name
    */ set name(value) {
         this._name = value;
         this._dirty = true;
     }
-    /**
-   * Parse worksheet XML content
+    /**
+   * Parse worksheet XML content
    */ parse(xml) {
         this._xmlNodes = parseXml(xml);
         this._preserveXml = true;
@@ -1037,8 +1374,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
             }
         }
     }
-    /**
-   * Parse the sheetData element to extract cells
+    /**
+   * Parse the sheetData element to extract cells
    */ _parseSheetData(rows) {
         for (const rowNode of rows){
             if (!('row' in rowNode)) continue;
@@ -1060,8 +1397,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         this._boundsDirty = true;
     }
-    /**
-   * Parse a cell XML node to CellData
+    /**
+   * Parse a cell XML node to CellData
    */ _parseCellNode(node) {
         const data = {};
         // Type attribute
@@ -1136,8 +1473,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         return data;
     }
-    /**
-   * Get a cell by address or row/col
+    /**
+   * Get a cell by address or row/col
    */ cell(rowOrAddress, col) {
         const { row, col: c } = parseCellRef(rowOrAddress, col);
         const address = toAddress(row, c);
@@ -1149,8 +1486,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         return cell;
     }
-    /**
-   * Get an existing cell without creating it.
+    /**
+   * Get an existing cell without creating it.
    */ getCellIfExists(rowOrAddress, col) {
         const { row, col: c } = parseCellRef(rowOrAddress, col);
         const address = toAddress(row, c);
@@ -1177,8 +1514,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         return new Range(this, rangeAddr);
     }
-    /**
-   * Merge cells in the given range
+    /**
+   * Merge cells in the given range
    */ mergeCells(rangeOrStart, end) {
         let rangeStr;
         if (end) {
@@ -1189,19 +1526,19 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._mergedCells.add(rangeStr);
         this._dirty = true;
     }
-    /**
-   * Unmerge cells in the given range
+    /**
+   * Unmerge cells in the given range
    */ unmergeCells(rangeStr) {
         this._mergedCells.delete(rangeStr);
         this._dirty = true;
     }
-    /**
-   * Get all merged cell ranges
+    /**
+   * Get all merged cell ranges
    */ get mergedCells() {
         return Array.from(this._mergedCells);
     }
-    /**
-   * Check if the worksheet has been modified
+    /**
+   * Check if the worksheet has been modified
    */ get dirty() {
         if (this._dirty) return true;
         for (const cell of this._cells.values()){
@@ -1209,13 +1546,13 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         return false;
     }
-    /**
-   * Get all cells in the worksheet
+    /**
+   * Get all cells in the worksheet
    */ get cells() {
         return this._cells;
     }
-    /**
-   * Set a column width (0-based index or column letter)
+    /**
+   * Set a column width (0-based index or column letter)
    */ setColumnWidth(col, width) {
         if (!Number.isFinite(width) || width <= 0) {
             throw new Error('Column width must be a positive number');
@@ -1228,14 +1565,14 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._colsDirty = true;
         this._dirty = true;
     }
-    /**
-   * Get a column width if set
+    /**
+   * Get a column width if set
    */ getColumnWidth(col) {
         const colIndex = typeof col === 'number' ? col : letterToCol(col);
         return this._columnWidths.get(colIndex);
     }
-    /**
-   * Set a row height (0-based index)
+    /**
+   * Set a row height (0-based index)
    */ setRowHeight(row, height) {
         if (!Number.isFinite(height) || height <= 0) {
             throw new Error('Row height must be a positive number');
@@ -1247,13 +1584,13 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._colsDirty = true;
         this._dirty = true;
     }
-    /**
-   * Get a row height if set
+    /**
+   * Get a row height if set
    */ getRowHeight(row) {
         return this._rowHeights.get(row);
     }
-    /**
-   * Freeze panes at a given row/column split (counts from top-left)
+    /**
+   * Freeze panes at a given row/column split (counts from top-left)
    */ freezePane(rowSplit, colSplit) {
         if (rowSplit < 0 || colSplit < 0) {
             throw new Error('Freeze pane splits must be >= 0');
@@ -1269,68 +1606,68 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._sheetViewsDirty = true;
         this._dirty = true;
     }
-    /**
-   * Get current frozen pane configuration
+    /**
+   * Get current frozen pane configuration
    */ getFrozenPane() {
         return this._frozenPane ? {
             ...this._frozenPane
         } : null;
     }
-    /**
-   * Get all tables in the worksheet
+    /**
+   * Get all tables in the worksheet
    */ get tables() {
         return [
             ...this._tables
         ];
     }
-    /**
-   * Get column width entries
-   * @internal
+    /**
+   * Get column width entries
+   * @internal
    */ getColumnWidths() {
         return new Map(this._columnWidths);
     }
-    /**
-   * Get row height entries
-   * @internal
+    /**
+   * Get row height entries
+   * @internal
    */ getRowHeights() {
         return new Map(this._rowHeights);
     }
-    /**
-   * Set table relationship IDs for tableParts generation.
-   * @internal
+    /**
+   * Set table relationship IDs for tableParts generation.
+   * @internal
    */ setTableRelIds(ids) {
         this._tableRelIds = ids ? [
             ...ids
         ] : null;
         this._tablePartsDirty = true;
     }
-    /**
-   * Create an Excel Table (ListObject) from a data range.
-   *
-   * Tables provide structured data features like auto-filter, banded styling,
-   * and total row with aggregation functions.
-   *
-   * @param config - Table configuration
-   * @returns Table instance for method chaining
-   *
-   * @example
-   * ```typescript
-   * // Create a table with default styling
-   * const table = sheet.createTable({
-   *   name: 'SalesData',
-   *   range: 'A1:D10',
-   * });
-   *
-   * // Create a table with total row
-   * const table = sheet.createTable({
-   *   name: 'SalesData',
-   *   range: 'A1:D10',
-   *   totalRow: true,
-   *   style: { name: 'TableStyleMedium2' }
-   * });
-   *
-   * table.setTotalFunction('Sales', 'sum');
-   * ```
+    /**
+   * Create an Excel Table (ListObject) from a data range.
+   *
+   * Tables provide structured data features like auto-filter, banded styling,
+   * and total row with aggregation functions.
+   *
+   * @param config - Table configuration
+   * @returns Table instance for method chaining
+   *
+   * @example
+   * ```typescript
+   * // Create a table with default styling
+   * const table = sheet.createTable({
+   *   name: 'SalesData',
+   *   range: 'A1:D10',
+   * });
+   *
+   * // Create a table with total row
+   * const table = sheet.createTable({
+   *   name: 'SalesData',
+   *   range: 'A1:D10',
+   *   totalRow: true,
+   *   style: { name: 'TableStyleMedium2' }
+   * });
+   *
+   * table.setTotalFunction('Sales', 'sum');
+   * ```
    */ createTable(config) {
         // Validate table name is unique within the workbook
         for (const sheet of this._workbook.sheetNames){
@@ -1353,25 +1690,25 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._dirty = true;
         return table;
     }
-    /**
+    /**
    * Convert sheet data to an array of JSON objects.
-   *
+   *
    * @param config - Configuration options
    * @returns Array of objects where keys are field names and values are cell values
    *
    * @example
-   * ```typescript
-   * // Using first row as headers
-   * const data = sheet.toJson();
-   *
-   * // Using custom field names
-   * const data = sheet.toJson({ fields: ['name', 'age', 'city'] });
-   *
-   * // Starting from a specific row/column
-   * const data = sheet.toJson({ startRow: 2, startCol: 1 });
-   * ```
+   * ```typescript
+   * // Using first row as headers
+   * const data = sheet.toJson();
+   *
+   * // Using custom field names
+   * const data = sheet.toJson({ fields: ['name', 'age', 'city'] });
+   *
+   * // Starting from a specific row/column
+   * const data = sheet.toJson({ startRow: 2, startCol: 1 });
+   * ```
    */ toJson(config = {}) {
-        const { fields, startRow = 0, startCol = 0, endRow, endCol, stopOnEmptyRow = true, dateHandling = this._workbook.dateHandling } = config;
+        const { fields, startRow = 0, startCol = 0, endRow, endCol, stopOnEmptyRow = true, dateHandling = this._workbook.dateHandling, asText = false, locale } = config;
         // Get the bounds of data in the sheet
         const bounds = this._getDataBounds();
         if (!bounds) {
@@ -1404,12 +1741,21 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
             for(let colOffset = 0; colOffset < fieldNames.length; colOffset++){
                 const col = startCol + colOffset;
                 const cell = this._cells.get(toAddress(row, col));
-                let value = cell?.value ?? null;
-                if (value instanceof Date) {
-                    value = this._serializeDate(value, dateHandling, cell);
-                }
-                if (value !== null) {
-                    hasData = true;
+                let value;
+                if (asText) {
+                    // Return formatted text instead of raw value
+                    value = cell?.textWithLocale(locale) ?? '';
+                    if (value !== '') {
+                        hasData = true;
+                    }
+                } else {
+                    value = cell?.value ?? null;
+                    if (value instanceof Date) {
+                        value = this._serializeDate(value, dateHandling, cell);
+                    }
+                    if (value !== null) {
+                        hasData = true;
+                    }
                 }
                 const fieldName = fieldNames[colOffset];
                 if (fieldName) {
@@ -1433,8 +1779,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         return value;
     }
-    /**
-   * Get the bounds of data in the sheet (min/max row and column with data)
+    /**
+   * Get the bounds of data in the sheet (min/max row and column with data)
    */ _getDataBounds() {
         if (!this._boundsDirty && this._dataBoundsCache) {
             return this._dataBoundsCache;
@@ -1470,8 +1816,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._boundsDirty = false;
         return this._dataBoundsCache;
     }
-    /**
-   * Generate XML for this worksheet
+    /**
+   * Generate XML for this worksheet
    */ toXml() {
         const preserved = this._preserveXml && this._xmlNodes ? this._buildPreservedWorksheet() : null;
         // Build sheetData from cells
@@ -1706,8 +2052,8 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         }
         return worksheet;
     }
-    /**
-   * Build a cell XML node from a Cell object
+    /**
+   * Build a cell XML node from a Cell object
    */ _buildCellNode(cell) {
         const data = cell.data;
         const attrs = {
@@ -3586,6 +3932,7 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._nextTableId = 1;
         // Date serialization handling
         this._dateHandling = 'jsDate';
+        this._locale = 'fr-FR';
         this._sharedStrings = new SharedStrings();
         this._styles = Styles.createDefault();
     }
@@ -3660,6 +4007,16 @@ const builder = new fastXmlParser.XMLBuilder(builderOptions);
         this._dateHandling = value;
     }
     /**
+   * Get the workbook locale for formatting.
+   */ get locale() {
+        return this._locale;
+    }
+    /**
+   * Set the workbook locale for formatting.
+   */ set locale(value) {
+        this._locale = value;
+    }
+    /**
    * Get the next unique table ID for this workbook.
    * Table IDs must be unique across all worksheets.
    * @internal