@shbernal/ts-xlsx 2.1.0 → 3.1.0

package/dist/io/xlsx/read-worksheet.js

@@ -1,13 +1,21 @@
-import { MAX_COLUMN, MAX_ROW, tryDecodeRange } from '../../core/address.js';
+import { tryDecodeRange } from '../../core/address.js';
 import { isCustomFilterOperator, } from '../../core/autofilter.js';
 import { INTERNAL } from '../../core/internal.js';
-import { isPageOrder, isPageOrientation, } from '../../core/page-setup.js';
-import { SHEET_PROTECTION_FLAGS, } from '../../core/protection.js';
+import { HEADER_FOOTER_ELEMENTS } from '../../core/page-setup.js';
 import { assignStyleFacets } from '../../core/style.js';
-import { boolPresent, boolStrict, boolTristate, decodeSpreadsheetText, enumToken, localName, numFinite, numInteger, parseXml, } from '../../xml/xml-read.js';
+import { decodeSpreadsheetText, numFinite, numInteger } from '../../xml/xml-attrs.js';
+import {} from '../../xml/xml-read.js';
+import { boolPresent, boolStrict, localName } from '../../xml/xml-scan.js';
 import { CellAccumulator } from './cell-accumulator.js';
-import { parseColor } from './color-xml.js';
-const MARGIN_SIDES = ['left', 'right', 'top', 'bottom', 'header', 'footer'];
+import { CellStyleResolver } from './cell-style-resolution.js';
+import { ColumnRecordBudget, takeColumnSpan } from './column-budget.js';
+import { admitting } from './read-repair.js';
+import { RowPositionTracker } from './row-position.js';
+import { applySheetProperties, PageBreakAccumulator, parseSheetProtection, } from './sheet-properties.js';
+const HEADER_FOOTER_CHILDREN = new Set(HEADER_FOOTER_ELEMENTS);
+function isHeaderFooterElement(local) {
+    return HEADER_FOOTER_CHILDREN.has(local);
+}
 const WORKSHEET_EMPTY_CLOSES = new Set(['c', 'autoFilter']);
 function pendingFilterCriteria(values, blank, predicates, and) {
     if (values !== null && (values.length > 0 || blank)) {
@@ -18,31 +26,6 @@ function pendingFilterCriteria(values, blank, predicates, and) {
     }
     return null;
 }
-function parseSheetProtection(attrs) {
-    if (attrs.sheet === '0' || attrs.sheet === 'false')
-        return undefined;
-    const flags = {};
-    for (const { key } of SHEET_PROTECTION_FLAGS) {
-        const raw = attrs[key];
-        if (raw !== undefined)
-            flags[key] = !boolStrict(raw);
-    }
-    const { algorithmName, hashValue, saltValue, spinCount } = attrs;
-    const spin = numInteger(spinCount, 0);
-    if (algorithmName !== undefined &&
-        hashValue !== undefined &&
-        saltValue !== undefined &&
-        spin !== undefined) {
-        const credential = {
-            algorithmName,
-            hashValue,
-            saltValue,
-            spinCount: spin,
-        };
-        return { flags, credential };
-    }
-    return { flags };
-}
 class AutoFilterAccumulator {
     #ref = null;
     #columns = [];
@@ -102,76 +85,48 @@ class AutoFilterAccumulator {
         this.#columns = [];
     }
 }
-class PageBreakAccumulator {
-    #target = null;
-    begin(target) {
-        this.#target = target;
-    }
-    end() {
-        this.#target = null;
-    }
-    add(attrs) {
-        if (this.#target === null)
-            return;
-        const id = numInteger(attrs.id, 1);
-        if (id === undefined)
-            return;
-        const brk = { id };
-        const max = numInteger(attrs.max, 0);
-        if (max !== undefined)
-            brk.max = max;
-        if (boolStrict(attrs.man))
-            brk.man = true;
-        this.#target.push(brk);
-    }
-}
-export function parseWorksheet(xml, sheet, sharedStrings, xfStyles) {
-    const cell = new CellAccumulator({ richRuns: true });
-    let rowStyle = -1;
-    let rowCustomFormat = false;
+export function worksheetPass(sheet, sharedStrings, xfStyles, dateEpoch) {
+    const cell = new CellAccumulator({ richRuns: true, dateEpoch });
     const autoFilter = new AutoFilterAccumulator();
     const pageBreaks = new PageBreakAccumulator();
-    const columnStyle = new Map();
+    const styleResolution = new CellStyleResolver();
+    const columnBudget = new ColumnRecordBudget();
+    const rowPosition = new RowPositionTracker();
     const finalizeCellFromState = () => {
-        const styleIndex = cell.styleIndex >= 0
-            ? cell.styleIndex
-            : rowCustomFormat && rowStyle >= 0
-                ? rowStyle
-                : (columnStyle.get(cell.col) ?? -1);
+        const styleIndex = styleResolution.indexFor(cell.col, cell.styleIndex);
         const style = styleIndex >= 0 ? xfStyles[styleIndex] : xfStyles[0];
         cell.finalize(sheet, sharedStrings, style);
     };
-    parseXml(xml, {
+    const handlers = {
         onOpen(name, attrs, selfClosing) {
             const local = localName(name);
             if (cell.openElement(local, attrs, selfClosing))
                 return;
+            if (HEADER_FOOTER_CHILDREN.has(local)) {
+                cell.capture();
+                return;
+            }
             switch (local) {
                 case 'col':
-                    applyColumn(sheet, attrs, xfStyles, columnStyle);
-                    break;
-                case 'row':
-                    applyRow(sheet, attrs);
-                    rowStyle = numInteger(attrs.s, 0) ?? -1;
-                    rowCustomFormat = boolStrict(attrs.customFormat);
+                    applyColumn(sheet, attrs, xfStyles, styleResolution, columnBudget);
                     break;
-                case 'oddHeader':
-                case 'oddFooter':
-                case 'evenHeader':
-                case 'evenFooter':
-                case 'firstHeader':
-                case 'firstFooter':
-                    cell.capture();
+                case 'row': {
+                    const { number, inGrid } = rowPosition.open(attrs);
+                    if (inGrid)
+                        applyRow(sheet, number, attrs);
+                    cell.openRow(inGrid ? number : -1);
+                    styleResolution.openRow(attrs);
                     break;
+                }
                 case 'mergeCell':
                     if (attrs.ref !== undefined && attrs.ref !== '') {
-                        try {
-                            sheet.mergeCells(attrs.ref);
-                        }
-                        catch {
-                        }
+                        const ref = attrs.ref;
+                        admitting(() => {
+                            sheet.mergeCells(ref);
+                        });
                     }
                     break;
+                case 'sheetPr':
                 case 'tabColor':
                 case 'outlinePr':
                 case 'sheetView':
@@ -229,18 +184,13 @@ export function parseWorksheet(xml, sheet, sharedStrings, xfStyles) {
             }
             if (claimed === 'claimed')
                 return;
+            if (isHeaderFooterElement(local)) {
+                sheet.headerFooter[local] = decodeSpreadsheetText(cell.capturedText);
+                return;
+            }
             switch (local) {
-                case 'oddHeader':
-                case 'oddFooter':
-                case 'evenHeader':
-                case 'evenFooter':
-                case 'firstHeader':
-                case 'firstFooter':
-                    sheet.headerFooter[local] = decodeSpreadsheetText(cell.capturedText);
-                    break;
                 case 'row':
-                    rowStyle = -1;
-                    rowCustomFormat = false;
+                    styleResolution.closeRow();
                     break;
                 case 'filterColumn':
                     autoFilter.endColumn();
@@ -256,58 +206,14 @@ export function parseWorksheet(xml, sheet, sharedStrings, xfStyles) {
                     break;
             }
         },
-    }, { closeEmptyElements: WORKSHEET_EMPTY_CLOSES });
-}
-function applySheetProperties(local, attrs, sheet) {
-    switch (local) {
-        case 'tabColor':
-            sheet.tabColor = parseColor(attrs);
-            break;
-        case 'outlinePr':
-            if (attrs.summaryBelow !== undefined)
-                sheet.outline.summaryBelow = boolPresent(attrs.summaryBelow);
-            if (attrs.summaryRight !== undefined)
-                sheet.outline.summaryRight = boolPresent(attrs.summaryRight);
-            break;
-        case 'sheetView':
-            if (attrs.showGridLines !== undefined && !boolPresent(attrs.showGridLines)) {
-                sheet.view.showGridLines = false;
-            }
-            break;
-        case 'pane':
-            if (attrs.state === 'frozen' || attrs.state === 'frozenSplit') {
-                sheet.view.state = 'frozen';
-                const xSplit = numInteger(attrs.xSplit, 0);
-                const ySplit = numInteger(attrs.ySplit, 0);
-                if (xSplit !== undefined)
-                    sheet.view.xSplit = xSplit;
-                if (ySplit !== undefined)
-                    sheet.view.ySplit = ySplit;
-                if (attrs.topLeftCell !== undefined)
-                    sheet.view.topLeftCell = attrs.topLeftCell;
-            }
-            break;
-        case 'pageSetUpPr':
-            if (attrs.fitToPage !== undefined)
-                sheet.pageSetup.fitToPage = boolPresent(attrs.fitToPage);
-            break;
-        case 'printOptions':
-            applyPrintOptions(sheet.printOptions, attrs);
-            break;
-        case 'pageMargins':
-            applyMargins(sheet.pageMargins, attrs);
-            break;
-        case 'pageSetup':
-            applyPageSetup(sheet.pageSetup, attrs);
-            break;
-    }
+    };
+    return { handlers, closeEmptyElements: WORKSHEET_EMPTY_CLOSES };
 }
-function applyColumn(sheet, attrs, xfStyles, columnStyle) {
-    const min = numInteger(attrs.min, 1);
-    const max = numInteger(attrs.max, 1);
-    if (min === undefined || max === undefined || min > MAX_COLUMN)
+function applyColumn(sheet, attrs, xfStyles, styleResolution, budget) {
+    const span = takeColumnSpan(attrs, budget);
+    if (span === undefined)
         return;
-    const last = Math.min(max, MAX_COLUMN);
+    const { first: min, last } = span;
     const width = numFinite(attrs.width);
     const hidden = boolStrict(attrs.hidden);
     const styleIndex = numInteger(attrs.style, 0) ?? -1;
@@ -325,14 +231,10 @@ function applyColumn(sheet, attrs, xfStyles, columnStyle) {
             column.collapsed = true;
         if (style !== undefined)
             assignStyleFacets(column, style);
-        if (styleIndex >= 0)
-            columnStyle.set(index, styleIndex);
     }
+    styleResolution.noteColumnSpan(min, last, attrs);
 }
-function applyRow(sheet, attrs) {
-    const number = numInteger(attrs.r, 1);
-    if (number === undefined || number > MAX_ROW)
-        return;
+function applyRow(sheet, number, attrs) {
     const row = sheet.getRow(number);
     const height = numFinite(attrs.ht);
     if (height !== undefined && boolPresent(attrs.customHeight))
@@ -345,47 +247,3 @@ function applyRow(sheet, attrs) {
     if (boolStrict(attrs.collapsed))
         row.collapsed = true;
 }
-function applyPrintOptions(printOptions, attrs) {
-    const horizontalCentered = boolTristate(attrs.horizontalCentered);
-    if (horizontalCentered !== undefined)
-        printOptions.horizontalCentered = horizontalCentered;
-    const verticalCentered = boolTristate(attrs.verticalCentered);
-    if (verticalCentered !== undefined)
-        printOptions.verticalCentered = verticalCentered;
-    const headings = boolTristate(attrs.headings);
-    if (headings !== undefined)
-        printOptions.headings = headings;
-    const gridLines = boolTristate(attrs.gridLines);
-    if (gridLines !== undefined)
-        printOptions.gridLines = gridLines;
-    const gridLinesSet = boolTristate(attrs.gridLinesSet);
-    if (gridLinesSet !== undefined)
-        printOptions.gridLinesSet = gridLinesSet;
-}
-function applyMargins(margins, attrs) {
-    for (const side of MARGIN_SIDES) {
-        const value = numFinite(attrs[side]);
-        if (value !== undefined)
-            margins[side] = value;
-    }
-}
-function applyPageSetup(pageSetup, attrs) {
-    const paperSize = numInteger(attrs.paperSize, 0);
-    if (paperSize !== undefined)
-        pageSetup.paperSize = paperSize;
-    const scale = numInteger(attrs.scale, 0);
-    if (scale !== undefined)
-        pageSetup.scale = scale;
-    const fitToWidth = numInteger(attrs.fitToWidth, 0);
-    if (fitToWidth !== undefined)
-        pageSetup.fitToWidth = fitToWidth;
-    const fitToHeight = numInteger(attrs.fitToHeight, 0);
-    if (fitToHeight !== undefined)
-        pageSetup.fitToHeight = fitToHeight;
-    const pageOrder = enumToken(attrs.pageOrder, isPageOrder);
-    if (pageOrder !== undefined)
-        pageSetup.pageOrder = pageOrder;
-    const orientation = enumToken(attrs.orientation, isPageOrientation);
-    if (orientation !== undefined)
-        pageSetup.orientation = orientation;
-}

package/dist/io/xlsx/read.d.ts

@@ -1,10 +1,9 @@
-import { Workbook, type WorkbookView } from '../../core/workbook.ts';
-import { type WorksheetState } from '../../core/worksheet.ts';
-import { type ReadXlsxOptions } from '../opc/read-options.ts';
-export { parseRelationships, resolveWorkbookPart } from '../opc/read-opc.ts';
-export { DEFAULT_MAX_UNCOMPRESSED, type ReadXlsxOptions } from '../opc/read-options.ts';
+import { Workbook } from '../../core/workbook.ts';
+import type { ReadPackageOptions } from '../opc/read-options.ts';
+export type { ReadPackageOptions } from '../opc/read-options.ts';
 export type { StyleTable, XfStyle } from '../style/xf-style.ts';
 export { parseStyleTable } from './read-styles.ts';
+export { type SheetEntry, workbookPropertiesPass, workbookSheetsPass, workbookViewPass, } from './read-workbook-xml.ts';
 /**
  * Read a spreadsheet package into a {@link Workbook}.
  *
@@ -20,11 +19,4 @@ export { parseStyleTable } from './read-styles.ts';
  * @throws {PackageReadError} if the input is a ZIP that cannot be unpacked: a corrupt or
  *   truncated archive, or one exceeding the inflate bound (a probable zip bomb).
  */
-export declare function readXlsx(data: Uint8Array, options?: ReadXlsxOptions): Workbook;
-export interface SheetEntry {
-    readonly name: string;
-    readonly relId: string;
-    readonly state?: WorksheetState['state'];
-}
-export declare function parseWorkbookSheets(xml: string): SheetEntry[];
-export declare function applyWorkbookView(view: WorkbookView, xml: string): void;
+export declare function readXlsx(data: Uint8Array, options?: ReadPackageOptions): Workbook;