@cj-tech-master/excelts 1.4.4 → 1.4.5-canary.20251212064440.3eb099f

package/dist/types/doc/workbook.d.ts

@@ -1,12 +1,16 @@
-import { Worksheet } from "./worksheet.js";
-import { DefinedNames } from "./defined-names.js";
+import { Worksheet, type WorksheetModel } from "./worksheet.js";
+import { DefinedNames, type DefinedNameModel } from "./defined-names.js";
 import { XLSX } from "../xlsx/xlsx.js";
 import { CSV } from "../csv/csv.js";
-interface WorksheetModel {
-    id: number;
-    name: string;
-    state?: string;
-    [key: string]: any;
+import type { PivotTable } from "./pivot-table.js";
+import type { AddWorksheetOptions, CalculationProperties, Image, WorkbookProperties, WorkbookView, Buffer as ExcelBuffer } from "../types.js";
+interface WorkbookMedia {
+    type: string;
+    extension: string;
+    filename?: string;
+    buffer?: ExcelBuffer;
+    base64?: string;
+    name?: string;
 }
 interface WorkbookModel {
     creator?: string;
@@ -14,11 +18,11 @@ interface WorkbookModel {
     lastPrinted?: Date;
     created: Date;
     modified: Date;
-    properties: any;
+    properties: Partial<WorkbookProperties>;
     worksheets: WorksheetModel[];
     sheets?: WorksheetModel[];
-    definedNames: any;
-    views: any[];
+    definedNames: DefinedNameModel[];
+    views: WorkbookView[];
     company: string;
     manager: string;
     title: string;
@@ -29,17 +33,10 @@ interface WorkbookModel {
     language?: string;
     revision?: number;
     contentStatus?: string;
-    themes?: any;
-    media: any[];
-    pivotTables: any[];
-    calcProperties: any;
-}
-interface AddWorksheetOptions {
-    properties?: any;
-    views?: any[];
-    pageSetup?: any;
-    headerFooter?: any;
-    [key: string]: any;
+    themes?: unknown;
+    media: WorkbookMedia[];
+    pivotTables: PivotTable[];
+    calcProperties: Partial<CalculationProperties>;
 }
 declare class Workbook {
     category: string;
@@ -49,24 +46,24 @@ declare class Workbook {
     keywords: string;
     manager: string;
     modified: Date;
-    properties: any;
-    calcProperties: any;
-    _worksheets: Worksheet[];
+    properties: Partial<WorkbookProperties>;
+    calcProperties: Partial<CalculationProperties>;
+    private _worksheets;
     subject: string;
     title: string;
-    views: any[];
-    media: any[];
-    pivotTables: any[];
-    _definedNames: DefinedNames;
+    views: WorkbookView[];
+    media: WorkbookMedia[];
+    pivotTables: PivotTable[];
+    private _definedNames;
     creator?: string;
     lastModifiedBy?: string;
     lastPrinted?: Date;
     language?: string;
     revision?: number;
     contentStatus?: string;
-    _themes?: any;
-    _xlsx?: XLSX;
-    _csv?: CSV;
+    private _themes?;
+    private _xlsx?;
+    private _csv?;
     constructor();
     get xlsx(): XLSX;
     get csv(): CSV;
@@ -79,8 +76,8 @@ declare class Workbook {
     eachSheet(iteratee: (sheet: Worksheet, id: number) => void): void;
     get definedNames(): DefinedNames;
     clearThemes(): void;
-    addImage(image: any): number;
-    getImage(id: number): any;
+    addImage(image: Image): number;
+    getImage(id: number | string): WorkbookMedia | undefined;
     get model(): WorkbookModel;
     set model(value: WorkbookModel);
 }

package/dist/types/doc/worksheet.d.ts

@@ -1,19 +1,49 @@
-import { Range } from "./range.js";
-import { Row } from "./row.js";
-import { Table } from "./table.js";
+import { Range, type RangeInput } from "./range.js";
+import { Row, type RowModel } from "./row.js";
+import { Column, type ColumnModel, type ColumnDefn } from "./column.js";
+import type { Cell, FormulaResult } from "./cell.js";
+import { Image, type ImageModel } from "./image.js";
+import { Table, type TableModel } from "./table.js";
 import { DataValidations } from "./data-validations.js";
-import type { RowBreak } from "../types.js";
+import { type PivotTable, type PivotTableModel } from "./pivot-table.js";
+import type { Workbook } from "./workbook.js";
+import type { AddImageRange, AutoFilter, CellValue, ConditionalFormattingOptions, DataValidation, RowBreak, RowValues, TableProperties, WorksheetProperties, WorksheetView } from "../types.js";
+type DataValidationModel = {
+    [address: string]: DataValidation | undefined;
+};
+interface SheetProtection {
+    sheet?: boolean;
+    objects?: boolean;
+    scenarios?: boolean;
+    selectLockedCells?: boolean;
+    selectUnlockedCells?: boolean;
+    formatCells?: boolean;
+    formatColumns?: boolean;
+    formatRows?: boolean;
+    insertColumns?: boolean;
+    insertRows?: boolean;
+    insertHyperlinks?: boolean;
+    deleteColumns?: boolean;
+    deleteRows?: boolean;
+    sort?: boolean;
+    autoFilter?: boolean;
+    pivotTables?: boolean;
+    algorithmName?: string;
+    hashValue?: string;
+    saltValue?: string;
+    spinCount?: number;
+}
 interface WorksheetOptions {
-    workbook?: any;
+    workbook?: Workbook;
     id?: number;
     orderNo?: number;
     name?: string;
     state?: string;
-    properties?: any;
-    pageSetup?: any;
-    headerFooter?: any;
-    views?: any[];
-    autoFilter?: any;
+    properties?: Partial<WorksheetProperties>;
+    pageSetup?: Partial<PageSetup>;
+    headerFooter?: Partial<HeaderFooter>;
+    views?: Partial<WorksheetView>[];
+    autoFilter?: AutoFilter | null;
 }
 interface EachRowOptions {
     includeEmpty?: boolean;
@@ -47,7 +77,6 @@ interface PageSetup {
     horizontalCentered: boolean;
     verticalCentered: boolean;
     rowBreaks: RowBreak[];
-    colBreaks: any;
     printTitlesRow?: string;
     printTitlesColumn?: string;
 }
@@ -64,77 +93,73 @@ interface HeaderFooter {
 interface WorksheetModel {
     id: number;
     name: string;
-    dataValidations: any;
-    properties: any;
+    dataValidations: DataValidationModel;
+    properties: Partial<WorksheetProperties>;
     state: string;
     pageSetup: PageSetup;
     headerFooter: HeaderFooter;
     rowBreaks: RowBreak[];
-    views: any[];
-    autoFilter: any;
-    media: any[];
-    sheetProtection: any;
-    tables: any[];
-    pivotTables: any[];
-    conditionalFormattings: any[];
-    cols?: any[];
-    rows?: any[];
+    views: Partial<WorksheetView>[];
+    autoFilter: AutoFilter | null;
+    media: ImageModel[];
+    sheetProtection: SheetProtection | null;
+    tables: TableModel[];
+    pivotTables: PivotTable[];
+    conditionalFormattings: ConditionalFormattingOptions[];
+    cols?: ColumnModel[];
+    rows?: RowModel[];
     dimensions?: Range;
     merges?: string[];
     mergeCells?: string[];
 }
 declare class Worksheet {
-    _workbook: any;
+    private _workbook;
     id: number;
     orderNo: number;
-    _name: string;
+    private _name;
     state: string;
-    _rows: any[];
-    _columns: any[];
-    _keys: {
-        [key: string]: any;
-    };
-    _merges: {
-        [key: string]: Range;
-    };
-    rowBreaks: any[];
-    properties: any;
+    private _rows;
+    private _columns;
+    private _keys;
+    private _merges;
+    rowBreaks: RowBreak[];
+    properties: Partial<WorksheetProperties>;
     pageSetup: PageSetup;
     headerFooter: HeaderFooter;
     dataValidations: DataValidations;
-    views: any[];
-    autoFilter: any;
-    _media: any[];
-    sheetProtection: any;
+    views: Partial<WorksheetView>[];
+    autoFilter: AutoFilter | null;
+    private _media;
+    sheetProtection: SheetProtection | null;
     tables: {
         [key: string]: Table;
     };
-    pivotTables: any[];
-    conditionalFormattings: any[];
-    _headerRowCount?: number;
+    pivotTables: PivotTable[];
+    conditionalFormattings: ConditionalFormattingOptions[];
+    private _headerRowCount?;
     constructor(options: WorksheetOptions);
     get name(): string;
     set name(name: string | undefined);
-    get workbook(): any;
+    get workbook(): Workbook;
     destroy(): void;
     get dimensions(): Range;
-    get columns(): any[];
-    set columns(value: any[]);
-    getColumnKey(key: string): any;
-    setColumnKey(key: string, value: any): void;
+    get columns(): Column[];
+    set columns(value: ColumnDefn[]);
+    getColumnKey(key: string): Column | undefined;
+    setColumnKey(key: string, value: Column): void;
     deleteColumnKey(key: string): void;
-    eachColumnKey(f: (column: any, key: string) => void): void;
-    getColumn(c: string | number): any;
-    spliceColumns(start: number, count: number, ...inserts: any[][]): void;
-    get lastColumn(): any;
+    eachColumnKey(f: (column: Column, key: string) => void): void;
+    getColumn(c: string | number): Column;
+    spliceColumns(start: number, count: number, ...inserts: CellValue[][]): void;
+    get lastColumn(): Column;
     get columnCount(): number;
     get actualColumnCount(): number;
     _commitRow(row: Row): void;
     get _lastRowNumber(): number;
     get _nextRow(): number;
-    get lastRow(): any;
-    findRow(r: number): any;
-    findRows(start: number, length: number): any[];
+    get lastRow(): Row | undefined;
+    findRow(r: number): Row | undefined;
+    findRows(start: number, length: number): (Row | undefined)[];
     get rowCount(): number;
     get actualRowCount(): number;
     getRow(r: number): any;
@@ -142,39 +167,39 @@ declare class Worksheet {
     addRow(value: any, style?: string): any;
     addRows(value: any[], style?: string): any[];
     insertRow(pos: number, value: any, style?: string): any;
-    insertRows(pos: number, values: any[], style?: string): any[] | undefined;
+    insertRows(pos: number, values: any[], style?: string): Row[] | undefined;
     _setStyleOption(pos: number, style?: string): void;
     _copyStyle(src: number, dest: number, styleEmpty?: boolean): void;
     duplicateRow(rowNum: number, count: number, insert?: boolean): void;
-    spliceRows(start: number, count: number, ...inserts: any[]): void;
+    spliceRows(start: number, count: number, ...inserts: RowValues[]): void;
     eachRow(iteratee: (row: any, rowNumber: number) => void): void;
     eachRow(options: EachRowOptions, iteratee: (row: any, rowNumber: number) => void): void;
-    getSheetValues(): any[];
-    findCell(r: number | string, c?: number): any;
-    getCell(r: number | string, c?: number): any;
-    mergeCells(...cells: any[]): void;
-    mergeCellsWithoutStyle(...cells: any[]): void;
+    getSheetValues(): CellValue[][];
+    findCell(r: number | string, c?: number): Cell | undefined;
+    getCell(r: number | string, c?: number): Cell;
+    mergeCells(...cells: RangeInput[]): void;
+    mergeCellsWithoutStyle(...cells: RangeInput[]): void;
     _mergeCellsInternal(dimensions: Range, ignoreStyle?: boolean): void;
-    _unMergeMaster(master: any): void;
+    _unMergeMaster(master: Cell): void;
     get hasMerges(): boolean;
-    unMergeCells(...cells: any[]): void;
-    fillFormula(range: string, formula: string, results?: any[][] | any[] | ((row: number, col: number) => any), shareType?: string): void;
-    addImage(imageId: number, range: any): void;
-    getImages(): any[];
-    addBackgroundImage(imageId: number): void;
-    getBackgroundImageId(): number | undefined;
-    protect(password?: string, options?: any): Promise<void>;
+    unMergeCells(...cells: RangeInput[]): void;
+    fillFormula(range: string, formula: string, results?: FormulaResult[][] | FormulaResult[] | ((row: number, col: number) => FormulaResult | undefined), shareType?: string): void;
+    addImage(imageId: string | number, range: AddImageRange): void;
+    getImages(): Image[];
+    addBackgroundImage(imageId: string | number): void;
+    getBackgroundImageId(): string | undefined;
+    protect(password?: string, options?: Partial<SheetProtection>): Promise<void>;
     unprotect(): void;
-    addTable(model: any): Table;
+    addTable(model: TableProperties): Table;
     getTable(name: string): Table;
     removeTable(name: string): void;
     getTables(): Table[];
-    addPivotTable(model: any): any;
-    addConditionalFormatting(cf: any): void;
-    removeConditionalFormatting(filter: number | ((value: any, index: number, array: any[]) => boolean)): void;
+    addPivotTable(model: PivotTableModel): PivotTable;
+    addConditionalFormatting(cf: ConditionalFormattingOptions): void;
+    removeConditionalFormatting(filter: number | ((value: ConditionalFormattingOptions, index: number, array: ConditionalFormattingOptions[]) => boolean)): void;
     get model(): WorksheetModel;
     _parseRows(model: WorksheetModel): void;
     _parseMergeCells(model: WorksheetModel): void;
     set model(value: WorksheetModel);
 }
-export { Worksheet };
+export { Worksheet, type WorksheetModel };

package/dist/types/stream/xlsx/worksheet-reader.d.ts

@@ -12,11 +12,9 @@ declare class WorksheetReader extends EventEmitter {
     options: any;
     name: string;
     state?: string;
-    _columns: any[] | null;
-    _keys: {
-        [key: string]: any;
-    };
-    _dimensions: any;
+    private _columns;
+    private _keys;
+    private _dimensions;
     hyperlinks?: {
         [key: string]: any;
     };

package/dist/types/types.d.ts

@@ -2,8 +2,7 @@
  * Type definitions for ExcelTS
  * This file exports all public types used by the library
  */
-import type { IAnchor } from "./doc/anchor.js";
-export type Buffer = ArrayBuffer;
+export type Buffer = Uint8Array;
 export declare enum PaperSize {
     Legal = 5,
     Executive = 7,
@@ -92,14 +91,26 @@ export interface FillGradientPath {
     stops: GradientStop[];
 }
 export type Fill = FillPattern | FillGradientAngle | FillGradientPath;
-export interface Style {
-    numFmt: string;
+export interface NumFmt {
+    id: number;
+    formatCode: string;
+}
+interface StyleBase {
     font: Partial<Font>;
     alignment: Partial<Alignment>;
     protection: Partial<Protection>;
     border: Partial<Borders>;
     fill: Fill;
 }
+export interface StyleInput extends StyleBase {
+    numFmt: string;
+}
+export interface StyleOutput extends StyleBase {
+    numFmt: NumFmt;
+}
+export interface Style extends StyleBase {
+    numFmt: string | NumFmt;
+}
 export interface Margins {
     top: number;
     left: number;
@@ -143,13 +154,13 @@ export interface HeaderFooter {
     firstFooter: string;
 }
 export interface WorksheetViewCommon {
-    rightToLeft: boolean;
-    activeCell: string;
-    showRuler: boolean;
-    showRowColHeaders: boolean;
-    showGridLines: boolean;
-    zoomScale: number;
-    zoomScaleNormal: number;
+    rightToLeft?: boolean;
+    activeCell?: string;
+    showRuler?: boolean;
+    showRowColHeaders?: boolean;
+    showGridLines?: boolean;
+    zoomScale?: number;
+    zoomScaleNormal?: number;
 }
 export interface WorksheetViewNormal {
     state: "normal";
@@ -248,13 +259,22 @@ export interface CellFormulaValue {
     result?: number | string | boolean | Date | CellErrorValue;
     date1904?: boolean;
 }
+/** Array formula that spans multiple cells */
+export interface CellArrayFormulaValue {
+    formula: string;
+    result?: number | string | boolean | Date | CellErrorValue;
+    /** Must be "array" for array formulas */
+    shareType: "array";
+    /** The range this array formula applies to, e.g. "A1:B2" */
+    ref: string;
+}
 export interface CellSharedFormulaValue {
     sharedFormula: string;
     readonly formula?: string;
     result?: number | string | boolean | Date | CellErrorValue;
     date1904?: boolean;
 }
-export type CellValue = null | number | string | boolean | Date | undefined | CellErrorValue | CellRichTextValue | CellHyperlinkValue | CellFormulaValue | CellSharedFormulaValue;
+export type CellValue = null | number | string | boolean | Date | undefined | CellErrorValue | CellRichTextValue | CellHyperlinkValue | CellFormulaValue | CellArrayFormulaValue | CellSharedFormulaValue;
 export interface CommentMargins {
     insetmode: "auto" | "custom";
     inset: number[];
@@ -271,11 +291,9 @@ export interface Comment {
     editAs?: CommentEditAs;
 }
 export type DataValidationOperator = "between" | "notBetween" | "equal" | "notEqual" | "greaterThan" | "lessThan" | "greaterThanOrEqual" | "lessThanOrEqual";
-export interface DataValidation {
-    type: "list" | "whole" | "decimal" | "date" | "textLength" | "custom";
-    formulae: any[];
+/** Base properties shared by all data validation types */
+interface DataValidationBase {
     allowBlank?: boolean;
-    operator?: DataValidationOperator;
     error?: string;
     errorTitle?: string;
     errorStyle?: string;
@@ -284,16 +302,23 @@ export interface DataValidation {
     showErrorMessage?: boolean;
     showInputMessage?: boolean;
 }
+/** Data validation that requires formulae and operator */
+export interface DataValidationWithFormulae extends DataValidationBase {
+    type: "list" | "whole" | "decimal" | "date" | "textLength" | "custom";
+    formulae: any[];
+    operator?: DataValidationOperator;
+}
+/** Data validation type 'any' - no formulae needed */
+export interface DataValidationAny extends DataValidationBase {
+    type: "any";
+}
+export type DataValidation = DataValidationWithFormulae | DataValidationAny;
 export interface Image {
     extension: "jpeg" | "png" | "gif";
     base64?: string;
     filename?: string;
     buffer?: Buffer;
 }
-export interface ImageRange {
-    tl: IAnchor;
-    br: IAnchor;
-}
 export interface ImagePosition {
     tl: {
         col: number;
@@ -304,6 +329,34 @@ export interface ImagePosition {
         height: number;
     };
 }
+/** Anchor position for image placement */
+export interface ImageAnchor {
+    col: number;
+    row: number;
+    nativeCol?: number;
+    nativeRow?: number;
+    nativeColOff?: number;
+    nativeRowOff?: number;
+}
+/** Range input for addImage - can be a string like "A1:B2" or an object */
+export type AddImageRange = string | {
+    /** Top-left anchor position */
+    tl: ImageAnchor | string;
+    /** Bottom-right anchor position (optional if ext is provided) */
+    br?: ImageAnchor | string;
+    /** Image dimensions (alternative to br) */
+    ext?: {
+        width: number;
+        height: number;
+    };
+    /** How the image behaves when cells are resized */
+    editAs?: "oneCell" | "twoCell" | "absolute";
+    /** Hyperlink for the image */
+    hyperlinks?: {
+        hyperlink?: string;
+        tooltip?: string;
+    };
+};
 export interface ImageHyperlinkValue {
     hyperlink: string;
     tooltip?: string;
@@ -319,7 +372,7 @@ export type Address = {
     address: string;
     col: number;
     row: number;
-    $col$row: string;
+    $col$row?: string;
 };
 export type RowValues = CellValue[] | {
     [key: string]: CellValue;
@@ -331,10 +384,10 @@ export type IconSetTypes = "5Arrows" | "5ArrowsGray" | "5Boxes" | "5Quarters" |
 export type CfvoTypes = "percentile" | "percent" | "num" | "min" | "max" | "formula" | "autoMin" | "autoMax";
 export interface Cvfo {
     type: CfvoTypes;
-    value?: number;
+    value?: number | string;
 }
 export interface ConditionalFormattingBaseRule {
-    priority: number;
+    priority?: number;
     style?: Partial<Style>;
 }
 export interface ExpressionRuleType extends ConditionalFormattingBaseRule {
@@ -350,11 +403,11 @@ export interface Top10RuleType extends ConditionalFormattingBaseRule {
     type: "top10";
     rank: number;
     percent: boolean;
-    bottom: boolean;
+    bottom?: boolean;
 }
 export interface AboveAverageRuleType extends ConditionalFormattingBaseRule {
     type: "aboveAverage";
-    aboveAverage: boolean;
+    aboveAverage?: boolean;
 }
 export interface ColorScaleRuleType extends ConditionalFormattingBaseRule {
     type: "colorScale";
@@ -390,12 +443,17 @@ export interface DataBarRuleType extends ConditionalFormattingBaseRule {
     axisPosition?: "auto" | "middle" | "none";
     direction?: "context" | "leftToRight" | "rightToLeft";
     cfvo?: Cvfo[];
+    color?: Partial<Color>;
 }
 export type ConditionalFormattingRule = ExpressionRuleType | CellIsRuleType | Top10RuleType | AboveAverageRuleType | ColorScaleRuleType | IconSetRuleType | ContainsTextRuleType | TimePeriodRuleType | DataBarRuleType;
 export interface ConditionalFormattingOptions {
     ref: string;
     rules: ConditionalFormattingRule[];
 }
+export interface ConditionalFormattingOptions {
+    ref: string;
+    rules: ConditionalFormattingRule[];
+}
 export interface TableStyleProperties {
     theme?: string;
     showFirstColumn?: boolean;
@@ -409,6 +467,7 @@ export interface TableColumnProperties {
     totalsRowLabel?: string;
     totalsRowFunction?: "none" | "average" | "countNums" | "count" | "max" | "min" | "stdDev" | "var" | "sum" | "custom";
     totalsRowFormula?: string;
+    totalsRowResult?: CellFormulaValue["result"];
     style?: Partial<Style>;
 }
 export interface TableProperties {
@@ -459,6 +518,7 @@ export type DefinedNamesModel = DefinedNamesRanges[];
 export interface RowBreak {
     id: number;
     max: number;
-    min: number;
+    min?: number;
     man: number;
 }
+export {};

package/dist/types/utils/col-cache.d.ts

@@ -1,7 +1,10 @@
 import type { Address, Location } from "../types.js";
-type Range = Location & {
-    tl: string | Address;
-    br: string | Address;
+type CachedAddress = Address & {
+    $col$row: string;
+};
+export type DecodedRange = Location & {
+    tl: string | CachedAddress;
+    br: string | CachedAddress;
     dimensions: string;
     sheetName?: string;
 };
@@ -9,21 +12,21 @@ interface ErrorReference {
     error: string;
     sheetName?: string;
 }
-type DecodeExResult = Address | Range | ErrorReference;
+type DecodeExResult = CachedAddress | DecodedRange | ErrorReference;
 interface ColCache {
     _dictionary: string[];
     _l2nFill: number;
     _l2n: Record<string, number>;
     _n2l: string[];
-    _hash: Record<string, Address>;
+    _hash: Record<string, CachedAddress>;
     _level(n: number): number;
     _fill(level: number): void;
     l2n(l: string): number;
     n2l(n: number): string;
     validateAddress(value: string): boolean;
-    decodeAddress(value: string): Address;
-    getAddress(r: number | string, c?: number): Address;
-    decode(value: string): Address | Range;
+    decodeAddress(value: string): CachedAddress;
+    getAddress(r: number | string, c?: number): CachedAddress;
+    decode(value: string): CachedAddress | DecodedRange;
     decodeEx(value: string): DecodeExResult;
     encodeAddress(row: number, col: number): string;
     encode(...args: number[]): string;