@cj-tech-master/excelts 1.4.5 → 1.5.0

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

@@ -1,72 +1,108 @@
-import type { Cell } from "./cell.js";
+import type { Cell, CellValueType } from "./cell.js";
 import type { Worksheet } from "./worksheet.js";
-interface ColumnDefn {
-    header?: any;
+import type { Style, NumFmt, Font, Alignment, Protection, Borders, Fill } from "../types.js";
+export interface ColumnDefn {
+    header?: string | string[];
     key?: string;
     width?: number;
     outlineLevel?: number;
     hidden?: boolean;
-    style?: any;
+    style?: Partial<Style>;
 }
-interface ColumnModel {
+export interface ColumnModel {
     min: number;
     max: number;
     width?: number;
-    style?: any;
+    style?: Partial<Style>;
     isCustomWidth?: boolean;
     hidden?: boolean;
     outlineLevel?: number;
     collapsed?: boolean;
 }
+/**
+ * Column defines the column properties for 1 column.
+ * This includes header rows, widths, key, (style), etc.
+ * Worksheet will condense the columns as appropriate during serialization
+ */
 declare class Column {
-    _worksheet: Worksheet;
-    _number: number;
-    _header: string | string[] | undefined;
-    _key: string | undefined;
+    private _worksheet;
+    private _number;
+    private _header;
+    private _key;
+    /** The width of the column */
     width?: number;
-    _hidden: boolean | undefined;
-    _outlineLevel: number | undefined;
-    style: Record<string, unknown>;
-    constructor(worksheet: any, number: number, defn?: any);
+    private _hidden;
+    private _outlineLevel;
+    /** Styles applied to the column */
+    style: Partial<Style>;
+    constructor(worksheet: Worksheet, number: number, defn?: ColumnDefn | false);
     get number(): number;
-    get worksheet(): any;
+    get worksheet(): Worksheet;
+    /**
+     * Column letter key
+     */
     get letter(): string;
     get isCustomWidth(): boolean;
     get defn(): ColumnDefn;
     set defn(value: ColumnDefn | undefined);
-    get headers(): any[];
-    get header(): any;
-    set header(value: any);
+    get headers(): string[];
+    /**
+     * Can be a string to set one row high header or an array to set multi-row high header
+     */
+    get header(): string | string[] | undefined;
+    set header(value: string | string[] | undefined);
+    /**
+     * The name of the properties associated with this column in each row
+     */
     get key(): string | undefined;
     set key(value: string | undefined);
+    /**
+     * Hides the column
+     */
     get hidden(): boolean;
     set hidden(value: boolean);
+    /**
+     * Set an outline level for columns
+     */
     get outlineLevel(): number;
     set outlineLevel(value: number | undefined);
+    /**
+     * Indicate the collapsed state based on outlineLevel
+     */
     get collapsed(): boolean;
     toString(): string;
     equivalentTo(other: Column): boolean;
+    equivalentToModel(model: ColumnModel): boolean;
     get isDefault(): boolean;
     get headerCount(): number;
-    eachCell(options: {
+    /**
+     * Iterate over all current cells in this column
+     */
+    eachCell(callback: (cell: Cell, rowNumber: number) => void): void;
+    /**
+     * Iterate over all current cells in this column including empty cells
+     */
+    eachCell(opt: {
         includeEmpty?: boolean;
-    } | ((cell: Cell, rowNumber: number) => void), iteratee?: (cell: Cell, rowNumber: number) => void): void;
-    get values(): any[];
-    set values(v: any[]);
-    _applyStyle(name: string, value: any): any;
-    get numFmt(): any;
-    set numFmt(value: any);
-    get font(): any;
-    set font(value: any);
-    get alignment(): any;
-    set alignment(value: any);
-    get protection(): any;
-    set protection(value: any);
-    get border(): any;
-    set border(value: any);
-    get fill(): any;
-    set fill(value: any);
+    }, callback: (cell: Cell, rowNumber: number) => void): void;
+    /**
+     * The cell values in the column
+     */
+    get values(): CellValueType[];
+    set values(v: CellValueType[]);
+    get numFmt(): string | NumFmt | undefined;
+    set numFmt(value: string | undefined);
+    get font(): Partial<Font> | undefined;
+    set font(value: Partial<Font> | undefined);
+    get alignment(): Partial<Alignment> | undefined;
+    set alignment(value: Partial<Alignment> | undefined);
+    get protection(): Partial<Protection> | undefined;
+    set protection(value: Partial<Protection> | undefined);
+    get border(): Partial<Borders> | undefined;
+    set border(value: Partial<Borders> | undefined);
+    get fill(): Fill | undefined;
+    set fill(value: Fill | undefined);
     static toModel(columns: Column[]): ColumnModel[] | undefined;
-    static fromModel(worksheet: any, cols: ColumnModel[]): Column[] | null;
+    static fromModel(worksheet: Worksheet, cols: ColumnModel[]): Column[] | null;
 }
 export { Column };

package/dist/types/doc/defined-names.d.ts

@@ -1,12 +1,15 @@
+import { type DecodedRange } from "../utils/col-cache.js";
 import { CellMatrix } from "../utils/cell-matrix.js";
 import { Range } from "./range.js";
-interface Cell {
+import type { Address } from "../types.js";
+interface DefinedNameCell {
     sheetName?: string;
     address: string;
     row: number;
     col: number;
     mark?: boolean;
 }
+type CellLocation = Address | DecodedRange;
 interface DefinedNameModel {
     name: string;
     ranges: string[];
@@ -16,14 +19,14 @@ declare class DefinedNames {
     constructor();
     getMatrix(name: string): CellMatrix;
     add(locStr: string, name: string): void;
-    addEx(location: any, name: string): void;
+    addEx(location: CellLocation, name: string): void;
     remove(locStr: string, name: string): void;
-    removeEx(location: any, name: string): void;
-    removeAllNames(location: any): void;
-    forEach(callback: (name: string, cell: Cell) => void): void;
+    removeEx(location: CellLocation, name: string): void;
+    removeAllNames(location: CellLocation): void;
+    forEach(callback: (name: string, cell: DefinedNameCell) => void): void;
     getNames(addressStr: string): string[];
-    getNamesEx(address: any): string[];
-    _explore(matrix: CellMatrix, cell: Cell): Range;
+    getNamesEx(address: Address): string[];
+    _explore(matrix: CellMatrix, cell: DefinedNameCell): Range;
     getRanges(name: string, matrix?: CellMatrix): DefinedNameModel;
     normaliseMatrix(matrix: CellMatrix, sheetName: string): void;
     spliceRows(sheetName: string, start: number, numDelete: number, numInsert: number): void;
@@ -31,4 +34,4 @@ declare class DefinedNames {
     get model(): DefinedNameModel[];
     set model(value: DefinedNameModel[]);
 }
-export { DefinedNames };
+export { DefinedNames, type DefinedNameModel };

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

@@ -1,6 +1,8 @@
-import { Anchor } from "./anchor.js";
+import { Anchor, type AnchorModel } from "./anchor.js";
+import type { Worksheet } from "./worksheet.js";
 interface ImageHyperlinks {
-    [key: string]: any;
+    hyperlink?: string;
+    tooltip?: string;
 }
 interface ImageExt {
     width?: number;
@@ -17,31 +19,46 @@ interface BackgroundModel {
     type: "background";
     imageId: string;
 }
+interface ImageRangeModel {
+    tl: AnchorModel;
+    br?: AnchorModel;
+    ext?: ImageExt;
+    editAs?: string;
+}
 interface ImageModel {
     type: "image";
     imageId: string;
     hyperlinks?: ImageHyperlinks;
-    range: {
-        tl: any;
-        br?: any;
-        ext?: ImageExt;
-        editAs?: string;
-    };
+    range: ImageRangeModel;
 }
 type Model = BackgroundModel | ImageModel;
+type ImageModelInput = ModelInput;
+interface RangeInput {
+    tl?: AnchorModel | {
+        col: number;
+        row: number;
+    } | string;
+    br?: AnchorModel | {
+        col: number;
+        row: number;
+    } | string;
+    ext?: ImageExt;
+    editAs?: string;
+    hyperlinks?: ImageHyperlinks;
+}
 interface ModelInput {
     type: string;
     imageId: string;
-    range?: string | any;
+    range?: string | RangeInput | ImageRangeModel;
     hyperlinks?: ImageHyperlinks;
 }
 declare class Image {
-    worksheet: any;
+    worksheet: Worksheet;
     type?: string;
     imageId?: string;
     range?: ImageRange;
-    constructor(worksheet: any, model?: ModelInput);
+    constructor(worksheet: Worksheet, model?: ModelInput);
     get model(): Model;
     set model({ type, imageId, range, hyperlinks }: ModelInput);
 }
-export { Image };
+export { Image, type Model as ImageModel, type ImageModelInput };

package/dist/types/doc/pivot-table.d.ts

@@ -19,4 +19,4 @@ interface PivotTable {
     cacheId: string;
 }
 declare function makePivotTable(worksheet: any, model: PivotTableModel): PivotTable;
-export { makePivotTable };
+export { makePivotTable, type PivotTable, type PivotTableModel };

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

@@ -1,3 +1,4 @@
+import type { Address } from "../types.js";
 interface RangeModel {
     top: number;
     left: number;
@@ -13,11 +14,21 @@ interface RowWithDimensions {
     number: number;
     dimensions?: RowDimensions;
 }
+export type RangeInput = Range | RangeModel | string | number | RangeInput[];
 declare class Range {
     model: RangeModel;
-    constructor(...args: any[]);
-    setTLBR(t: number | string, l?: number | string, b?: number | string, r?: number | string, s?: string): void;
-    decode(argv: any[]): void;
+    constructor();
+    constructor(range: Range);
+    constructor(model: RangeModel);
+    constructor(rangeString: string);
+    constructor(args: RangeInput[]);
+    constructor(tl: string, br: string);
+    constructor(tl: string, br: string, sheetName: string);
+    constructor(top: number, left: number, bottom: number, right: number);
+    constructor(top: number, left: number, bottom: number, right: number, sheetName: string);
+    setTLBR(tl: string, br: string, sheetName?: string): void;
+    setTLBR(top: number, left: number, bottom: number, right: number, sheetName?: string): void;
+    private decode;
     get top(): number;
     set top(value: number);
     get left(): number;
@@ -44,7 +55,7 @@ declare class Range {
     toString(): string;
     intersects(other: Range): boolean;
     contains(addressStr: string): boolean;
-    containsEx(address: any): boolean;
+    containsEx(address: Address): boolean;
     forEachAddress(cb: (address: string, row: number, col: number) => void): void;
 }
 export { Range };

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

@@ -1,70 +1,108 @@
-import { Cell } from "./cell.js";
+import { Cell, type CellModel, type CellAddress } from "./cell.js";
 import type { Worksheet } from "./worksheet.js";
-interface CellAddress {
-    address: string;
-    row: number;
-    col: number;
-    $col$row?: string;
-}
+import type { Style, NumFmt, Font, Alignment, Protection, Borders, Fill, CellValue, RowValues } from "../types.js";
 interface RowDimensions {
     min: number;
     max: number;
 }
-interface RowModel {
-    cells: any[];
+export interface RowModel {
+    cells: CellModel[];
     number: number;
     min: number;
     max: number;
     height?: number;
-    style: any;
+    style: Partial<Style>;
     hidden: boolean;
     outlineLevel: number;
     collapsed: boolean;
 }
-interface EachCellOptions {
-    includeEmpty?: boolean;
-}
 declare class Row {
-    _worksheet: Worksheet;
-    _number: number;
-    _cells: (Cell | undefined)[];
-    style: Record<string, unknown>;
-    _hidden?: boolean;
-    _outlineLevel?: number;
+    private _worksheet;
+    private _number;
+    private _cells;
+    style: Partial<Style>;
+    private _hidden?;
+    private _outlineLevel?;
     height?: number;
-    constructor(worksheet: any, number: number);
+    constructor(worksheet: Worksheet, number: number);
+    /**
+     * The row number
+     */
     get number(): number;
+    /**
+     * The worksheet that contains this row
+     */
     get worksheet(): Worksheet;
+    /**
+     * Commit a completed row to stream.
+     * Inform Streaming Writer that this row (and all rows before it) are complete
+     * and ready to write. Has no effect on Worksheet document.
+     */
     commit(): void;
+    /**
+     * Helps GC by breaking cyclic references
+     */
     destroy(): void;
     findCell(colNumber: number): Cell | undefined;
     getCellEx(address: CellAddress): Cell;
+    /**
+     * Get cell by number, column letter or column key
+     */
     getCell(col: string | number): Cell;
-    splice(start: number, count: number, ...inserts: any[]): void;
-    eachCell(iteratee: (cell: Cell, colNumber: number) => void): void;
-    eachCell(options: EachCellOptions, iteratee: (cell: Cell, colNumber: number) => void): void;
+    /**
+     * Cut one or more cells (cells to the right are shifted left)
+     *
+     * Note: this operation will not affect other rows
+     */
+    splice(start: number, count: number, ...inserts: CellValue[]): void;
+    /**
+     * Iterate over all non-null cells in a row
+     */
+    eachCell(callback: (cell: Cell, colNumber: number) => void): void;
+    /**
+     * Iterate over all cells in a row (including empty cells)
+     */
+    eachCell(opt: {
+        includeEmpty?: boolean;
+    }, callback: (cell: Cell, colNumber: number) => void): void;
     addPageBreak(lft?: number, rght?: number): void;
-    get values(): any[];
-    set values(value: any[] | {
-        [key: string]: any;
-    });
+    /**
+     * Get a row as a sparse array
+     */
+    get values(): CellValue[];
+    /**
+     * Set the values by contiguous or sparse array, or by key'd object literal
+     */
+    set values(value: RowValues);
+    /**
+     * Returns true if the row includes at least one cell with a value
+     */
     get hasValues(): boolean;
+    /**
+     * Number of cells including empty ones
+     */
     get cellCount(): number;
+    /**
+     * Number of non-empty cells
+     */
     get actualCellCount(): number;
+    /**
+     * Get the min and max column number for the non-null cells in this row or null
+     */
     get dimensions(): RowDimensions | null;
-    _applyStyle(name: string, value: any): any;
-    get numFmt(): any;
-    set numFmt(value: any);
-    get font(): any;
-    set font(value: any);
-    get alignment(): any;
-    set alignment(value: any);
-    get protection(): any;
-    set protection(value: any);
-    get border(): any;
-    set border(value: any);
-    get fill(): any;
-    set fill(value: any);
+    private _applyStyle;
+    get numFmt(): string | NumFmt | undefined;
+    set numFmt(value: string | undefined);
+    get font(): Partial<Font> | undefined;
+    set font(value: Partial<Font> | undefined);
+    get alignment(): Partial<Alignment> | undefined;
+    set alignment(value: Partial<Alignment> | undefined);
+    get protection(): Partial<Protection> | undefined;
+    set protection(value: Partial<Protection> | undefined);
+    get border(): Partial<Borders> | undefined;
+    set border(value: Partial<Borders> | undefined);
+    get fill(): Fill | undefined;
+    set fill(value: Fill | undefined);
     get hidden(): boolean;
     set hidden(value: boolean);
     get outlineLevel(): number;

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

@@ -1,75 +1,60 @@
-interface ColumnModel {
-    name: string;
-    filterButton?: boolean;
-    style?: any;
-    totalsRowLabel?: string;
-    totalsRowFunction?: string;
-    totalsRowResult?: any;
-    totalsRowFormula?: string;
-}
-interface TableStyle {
-    theme?: string;
-    name?: string;
-    showFirstColumn?: boolean;
-    showLastColumn?: boolean;
-    showRowStripes?: boolean;
-    showColumnStripes?: boolean;
-}
+import type { Address, CellFormulaValue, CellValue, Style, TableColumnProperties, TableStyleProperties } from "../types.js";
+import type { Worksheet } from "./worksheet.js";
 interface TableModel {
     ref: string;
     name: string;
     displayName?: string;
-    columns: ColumnModel[];
-    rows: any[][];
+    columns: TableColumnProperties[];
+    rows: CellValue[][];
     headerRow?: boolean;
     totalsRow?: boolean;
-    style: TableStyle;
-    tl?: any;
+    style?: TableStyleProperties;
+    tl?: Address;
     autoFilterRef?: string;
     tableRef?: string;
 }
 declare class Column {
     table: Table;
-    column: ColumnModel;
+    column: TableColumnProperties;
     index: number;
-    constructor(table: Table, column: ColumnModel, index: number);
+    constructor(table: Table, column: TableColumnProperties, index: number);
     private _set;
     get name(): string;
     set name(value: string);
     get filterButton(): boolean | undefined;
     set filterButton(value: boolean | undefined);
-    get style(): any;
-    set style(value: any);
+    get style(): Partial<Style> | undefined;
+    set style(value: Partial<Style> | undefined);
     get totalsRowLabel(): string | undefined;
     set totalsRowLabel(value: string | undefined);
-    get totalsRowFunction(): string | undefined;
-    set totalsRowFunction(value: string | undefined);
-    get totalsRowResult(): any;
-    set totalsRowResult(value: any);
+    get totalsRowFunction(): TableColumnProperties["totalsRowFunction"];
+    set totalsRowFunction(value: TableColumnProperties["totalsRowFunction"]);
+    get totalsRowResult(): CellValue;
+    set totalsRowResult(value: CellFormulaValue["result"]);
     get totalsRowFormula(): string | undefined;
     set totalsRowFormula(value: string | undefined);
 }
 declare class Table {
-    worksheet: any;
+    worksheet: Worksheet;
     table: TableModel;
     private _cache?;
-    constructor(worksheet: any, table?: TableModel);
-    getFormula(column: ColumnModel): string | null;
+    constructor(worksheet: Worksheet, table?: TableModel);
+    getFormula(column: TableColumnProperties): string | null;
     get width(): number;
     get height(): number;
     get filterHeight(): number;
     get tableHeight(): number;
     validate(): void;
     store(): void;
-    load(worksheet: any): void;
+    load(worksheet: Worksheet): void;
     get model(): TableModel;
     set model(value: TableModel);
     cacheState(): void;
     commit(): void;
-    addRow(values: any[], rowNumber?: number): void;
+    addRow(values: CellValue[], rowNumber?: number): void;
     removeRows(rowIndex: number, count?: number): void;
     getColumn(colIndex: number): Column;
-    addColumn(column: ColumnModel, values: any[], colIndex?: number): void;
+    addColumn(column: TableColumnProperties, values: CellValue[], colIndex?: number): void;
     removeColumns(colIndex: number, count?: number): void;
     private _assign;
     get ref(): string;
@@ -93,4 +78,4 @@ declare class Table {
     get showColumnStripes(): boolean | undefined;
     set showColumnStripes(value: boolean | undefined);
 }
-export { Table };
+export { Table, type TableModel };