@cj-tech-master/excelts 3.1.0-canary.20260102041828.82ed571 → 3.1.0

package/dist/types/modules/csv/csv.d.ts

@@ -1,14 +0,0 @@
-/**
- * CSV class - Node.js Version
- *
- * Extends browser CSV class with file system support.
- */
-import { CSV as CSVBrowser, type CsvStreamReadOptions, type CsvStreamWriteOptions } from "@csv/csv.browser";
-import type { Worksheet } from "@excel/worksheet";
-declare class CSV extends CSVBrowser {
-    readFile(filename: string, options?: CsvStreamReadOptions): Promise<Worksheet>;
-    writeFile(filename: string, options?: CsvStreamWriteOptions): Promise<void>;
-}
-export { CSV };
-export type { CsvReadOptions, CsvWriteOptions, CsvStreamReadOptions, CsvStreamWriteOptions } from "@csv/csv.browser";
-export { CsvParserStream, CsvFormatterStream } from "@csv/csv-stream";

package/dist/types/modules/excel/anchor.d.ts

@@ -1,33 +0,0 @@
-import type { Worksheet } from "@excel/worksheet";
-interface AnchorModel {
-    nativeCol: number;
-    nativeRow: number;
-    nativeColOff: number;
-    nativeRowOff: number;
-}
-interface SimpleAddress {
-    col: number;
-    row: number;
-}
-type AddressInput = string | AnchorModel | SimpleAddress;
-declare class Anchor {
-    nativeCol: number;
-    nativeRow: number;
-    nativeColOff: number;
-    nativeRowOff: number;
-    worksheet?: Worksheet;
-    constructor(worksheet?: Worksheet, address?: AddressInput | null, offset?: number);
-    static asInstance(model: AddressInput | Anchor | null | undefined): Anchor | null;
-    get col(): number;
-    set col(v: number);
-    get row(): number;
-    set row(v: number);
-    get colWidth(): number;
-    get rowHeight(): number;
-    get model(): AnchorModel;
-    set model(value: AnchorModel);
-}
-export { Anchor };
-export type { AnchorModel };
-type IAnchor = Pick<InstanceType<typeof Anchor>, "col" | "row" | "nativeCol" | "nativeRow" | "nativeColOff" | "nativeRowOff">;
-export type { IAnchor };

package/dist/types/modules/excel/cell.d.ts

@@ -1,138 +0,0 @@
-import { Note } from "@excel/note";
-import type { Row } from "@excel/row";
-import type { Column } from "@excel/column";
-import type { Worksheet } from "@excel/worksheet";
-import type { Workbook } from "@excel/workbook";
-import type { Style, NumFmt, Font, Alignment, Protection, Borders, Fill, CellRichTextValue, CellErrorValue, DataValidation, CellValue, CellHyperlinkValue } from "@excel/types";
-export type FormulaResult = string | number | boolean | Date | CellErrorValue;
-export interface FormulaValueData {
-    shareType?: string;
-    ref?: string;
-    formula?: string;
-    sharedFormula?: string;
-    result?: FormulaResult;
-    date1904?: boolean;
-}
-interface FullAddress {
-    sheetName: string;
-    address: string;
-    row: number;
-    col: number;
-}
-export interface CellAddress {
-    address: string;
-    row: number;
-    col: number;
-    $col$row?: string;
-}
-export interface NoteText {
-    text: string;
-    font?: Record<string, unknown>;
-}
-export interface NoteConfig {
-    texts?: NoteText[];
-    margins?: {
-        insetmode?: string;
-        inset?: number[];
-    };
-    protection?: {
-        locked?: string;
-        lockText?: string;
-    };
-    editAs?: string;
-}
-export interface NoteModel {
-    type: string;
-    note: NoteConfig;
-}
-export interface CellModel {
-    address: string;
-    type: number;
-    value?: number | string | boolean | Date | CellRichTextValue | CellErrorValue | CellHyperlinkValue;
-    style?: Partial<Style>;
-    comment?: NoteModel;
-    text?: string;
-    hyperlink?: string;
-    tooltip?: string;
-    master?: string;
-    shareType?: string;
-    ref?: string;
-    formula?: string;
-    sharedFormula?: string;
-    result?: FormulaResult;
-    richText?: CellRichTextValue;
-    sharedString?: number;
-    error?: CellErrorValue;
-    rawValue?: unknown;
-}
-export type CellValueType = CellValue;
-declare class Cell {
-    static Types: typeof import("@excel/enums").ValueType;
-    private _row;
-    private _column;
-    private _address;
-    private _value;
-    style: Partial<Style>;
-    private _mergeCount;
-    private _comment?;
-    constructor(row: Row, column: Column, address: string);
-    get worksheet(): Worksheet;
-    get workbook(): Workbook;
-    destroy(): void;
-    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 border(): Partial<Borders> | undefined;
-    set border(value: Partial<Borders> | undefined);
-    get fill(): Fill | undefined;
-    set fill(value: Fill | undefined);
-    get protection(): Partial<Protection> | undefined;
-    set protection(value: Partial<Protection> | undefined);
-    private _mergeStyle;
-    get address(): string;
-    get row(): number;
-    get col(): number;
-    get $col$row(): string;
-    get type(): number;
-    get effectiveType(): number;
-    toCsvString(): string;
-    addMergeRef(): void;
-    releaseMergeRef(): void;
-    get isMerged(): boolean;
-    merge(master: Cell, ignoreStyle?: boolean): void;
-    unmerge(): void;
-    isMergedTo(master: Cell): boolean;
-    get master(): Cell;
-    get isHyperlink(): boolean;
-    get hyperlink(): string | undefined;
-    get value(): CellValueType;
-    set value(v: CellValueType);
-    get note(): string | NoteConfig | undefined;
-    set note(note: string | NoteConfig);
-    get comment(): Note | undefined;
-    set comment(comment: Note | NoteConfig | undefined);
-    get text(): string;
-    get html(): string;
-    toString(): string;
-    _upgradeToHyperlink(hyperlink: string): void;
-    get formula(): string | undefined;
-    get result(): FormulaResult | undefined;
-    get formulaType(): number;
-    get fullAddress(): FullAddress;
-    get name(): string;
-    set name(value: string);
-    get names(): string[];
-    set names(value: string[]);
-    addName(name: string): void;
-    removeName(name: string): void;
-    removeAllNames(): void;
-    private get _dataValidations();
-    get dataValidation(): DataValidation | undefined;
-    set dataValidation(value: DataValidation);
-    get model(): CellModel;
-    set model(value: CellModel);
-}
-export { Cell };

package/dist/types/modules/excel/column.d.ts

@@ -1,122 +0,0 @@
-import type { Cell, CellValueType } from "@excel/cell";
-import type { Worksheet } from "@excel/worksheet";
-import type { Style, NumFmt, Font, Alignment, Protection, Borders, Fill, CellValue } from "@excel/types";
-/** Header value type - can be a single value or array for multi-row headers */
-export type ColumnHeaderValue = CellValue | CellValue[];
-export interface ColumnDefn {
-    /** Column header value(s). Can be string, Date, number, or any CellValue type */
-    header?: ColumnHeaderValue;
-    key?: string;
-    width?: number;
-    outlineLevel?: number;
-    hidden?: boolean;
-    style?: Partial<Style>;
-}
-export interface ColumnModel {
-    min: number;
-    max: number;
-    width?: number;
-    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 {
-    private _worksheet;
-    private _number;
-    private _header;
-    private _key;
-    /** The width of the column */
-    width?: number;
-    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(): Worksheet;
-    /**
-     * Column letter key
-     */
-    get letter(): string;
-    get isCustomWidth(): boolean;
-    get defn(): ColumnDefn;
-    set defn(value: ColumnDefn | undefined);
-    /**
-     * Get header values as an array (for multi-row header support)
-     */
-    get headers(): CellValue[];
-    /**
-     * Can be a single value or an array for multi-row headers.
-     * Supports any CellValue type including Date, number, string, etc.
-     */
-    get header(): ColumnHeaderValue | undefined;
-    set header(value: ColumnHeaderValue | 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;
-    /**
-     * 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;
-    }, callback: (cell: Cell, rowNumber: number) => void): void;
-    /**
-     * The cell values in the column
-     */
-    get values(): CellValueType[];
-    set values(v: CellValueType[]);
-    /**
-     * Add a page break after this column.
-     * @param top - Optional top row limit for the page break (1-indexed)
-     * @param bottom - Optional bottom row limit for the page break (1-indexed)
-     */
-    addPageBreak(top?: number, bottom?: number): void;
-    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(cols: ColumnModel[]): Column[] | null;
-    static fromModel(worksheet: Worksheet, cols: ColumnModel[]): Column[] | null;
-}
-export { Column };

package/dist/types/modules/excel/defined-names.d.ts

@@ -1,37 +0,0 @@
-import { type DecodedRange } from "@excel/utils/col-cache";
-import { CellMatrix } from "@excel/utils/cell-matrix";
-import { Range } from "@excel/range";
-import type { Address } from "@excel/types";
-interface DefinedNameCell {
-    sheetName?: string;
-    address: string;
-    row: number;
-    col: number;
-    mark?: boolean;
-}
-type CellLocation = Address | DecodedRange;
-interface DefinedNameModel {
-    name: string;
-    ranges: string[];
-}
-declare class DefinedNames {
-    matrixMap: Record<string, CellMatrix>;
-    constructor();
-    getMatrix(name: string): CellMatrix;
-    add(locStr: string, name: string): void;
-    addEx(location: CellLocation, name: string): void;
-    remove(locStr: string, name: string): 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: 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;
-    spliceColumns(sheetName: string, start: number, numDelete: number, numInsert: number): void;
-    get model(): DefinedNameModel[];
-    set model(value: DefinedNameModel[]);
-}
-export { DefinedNames, type DefinedNameModel };

package/dist/types/modules/excel/image.d.ts

@@ -1,64 +0,0 @@
-import { Anchor, type AnchorModel } from "@excel/anchor";
-import type { Worksheet } from "@excel/worksheet";
-interface ImageHyperlinks {
-    hyperlink?: string;
-    tooltip?: string;
-}
-interface ImageExt {
-    width?: number;
-    height?: number;
-}
-interface ImageRange {
-    tl: Anchor;
-    br?: Anchor;
-    ext?: ImageExt;
-    editAs?: string;
-    hyperlinks?: ImageHyperlinks;
-}
-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: 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 | RangeInput | ImageRangeModel;
-    hyperlinks?: ImageHyperlinks;
-}
-declare class Image {
-    worksheet: Worksheet;
-    type?: string;
-    imageId?: string;
-    range?: ImageRange;
-    constructor(worksheet: Worksheet, model?: ModelInput);
-    get model(): Model;
-    set model({ type, imageId, range, hyperlinks }: ModelInput);
-}
-export { Image, type Model as ImageModel, type ImageModelInput };

package/dist/types/modules/excel/pivot-table.d.ts

@@ -1,152 +0,0 @@
-import type { Table } from "@excel/table";
-/**
- * Interface representing the source data abstraction for pivot tables.
- * This allows both Worksheet and Table to be used as pivot table data sources.
- */
-export interface PivotTableSource {
-    /** Name of the worksheet containing the source data (used in pivotCacheDefinition) */
-    name: string;
-    /** Get row values by 1-indexed row number */
-    getRow(rowNumber: number): {
-        values: any[];
-    };
-    /** Get column values by 1-indexed column number */
-    getColumn(columnNumber: number): {
-        values: any[];
-    };
-    /** Get all sheet values as a sparse 2D array */
-    getSheetValues(): any[][];
-    /** Dimensions with short range reference (e.g., "A1:E10") */
-    dimensions: {
-        shortRange: string;
-    };
-}
-/**
- * Model for creating a new pivot table.
- * Pass this to worksheet.addPivotTable() to create a pivot table.
- */
-export interface PivotTableModel {
-    /**
-     * Source worksheet for the pivot table data.
-     * Either sourceSheet or sourceTable must be provided (mutually exclusive).
-     */
-    sourceSheet?: PivotTableSource;
-    /**
-     * Source table for the pivot table data.
-     * Either sourceSheet or sourceTable must be provided (mutually exclusive).
-     * The table must have headerRow=true and contain at least one data row.
-     */
-    sourceTable?: Table;
-    /** Column names to use as row fields in the pivot table */
-    rows: string[];
-    /**
-     * Column names to use as column fields in the pivot table.
-     * If omitted or empty, Excel will use "Values" as the column field.
-     * @default []
-     */
-    columns?: string[];
-    /** Column names to aggregate as values in the pivot table */
-    values: string[];
-    /**
-     * Aggregation metric for the pivot table values.
-     * - 'sum': Sum of values (default)
-     * - 'count': Count of values
-     * @default 'sum'
-     */
-    metric?: "sum" | "count";
-    /**
-     * Controls whether pivot table style overrides worksheet column widths.
-     * - '0': Preserve worksheet column widths (useful for custom sizing)
-     * - '1': Apply pivot table style width/height (default Excel behavior)
-     * @default '1'
-     */
-    applyWidthHeightFormats?: "0" | "1";
-}
-/**
- * Represents a cache field in a pivot table.
- * Cache fields store unique values from source columns for row/column grouping.
- */
-export interface CacheField {
-    /** Name of the field (column header from source) */
-    name: string;
-    /** Unique values for row/column fields, null for value fields */
-    sharedItems: any[] | null;
-    /** Minimum value for numeric fields */
-    minValue?: number;
-    /** Maximum value for numeric fields */
-    maxValue?: number;
-}
-/** Aggregation function types for pivot table data fields */
-export type PivotTableSubtotal = "sum" | "count" | "average" | "max" | "min" | "product" | "countNums" | "stdDev" | "stdDevP" | "var" | "varP";
-/**
- * Data field configuration for pivot table aggregation.
- * Defines how values are aggregated in the pivot table.
- */
-export interface DataField {
-    /** Display name for the data field (e.g., "Sum of Sales") */
-    name: string;
-    /** Index of the source field in cacheFields */
-    fld: number;
-    /** Base field index for calculated fields */
-    baseField?: number;
-    /** Base item index for calculated fields */
-    baseItem?: number;
-    /** Aggregation function (default: 'sum') */
-    subtotal?: PivotTableSubtotal;
-}
-/**
- * Internal pivot table representation used by the library.
- * This is the processed model after calling makePivotTable().
- */
-export interface PivotTable {
-    /** Source data adapter (always present for new pivot tables) */
-    source?: PivotTableSource;
-    /** Field indices for row fields */
-    rows: number[];
-    /** Field indices for column fields */
-    columns: number[];
-    /** Field indices for value fields */
-    values: number[];
-    /** Aggregation metric */
-    metric: "sum" | "count";
-    /** Cache fields with shared items */
-    cacheFields: CacheField[];
-    /** Cache ID for linking to pivot cache */
-    cacheId: string;
-    /** Width/height format setting */
-    applyWidthHeightFormats: "0" | "1";
-    /** 1-indexed table number for file naming (pivotTable1.xml, pivotTable2.xml, etc.) */
-    tableNumber: number;
-    /** Flag indicating this pivot table was loaded from file (not newly created) */
-    isLoaded?: boolean;
-    /** Data fields for loaded pivot tables */
-    dataFields?: DataField[];
-    /** Cache definition for loaded pivot tables */
-    cacheDefinition?: ParsedCacheDefinition;
-    /** Cache records for loaded pivot tables */
-    cacheRecords?: ParsedCacheRecords;
-}
-/**
- * Parsed cache definition from loaded pivot table files.
- */
-export interface ParsedCacheDefinition {
-    sourceRef?: string;
-    sourceSheet?: string;
-    cacheFields: CacheField[];
-    recordCount?: number;
-    rId?: string;
-    isLoaded?: boolean;
-}
-/**
- * Parsed cache records from loaded pivot table files.
- */
-export interface ParsedCacheRecords {
-    records: Array<Array<{
-        type: string;
-        value?: any;
-    }>>;
-    count: number;
-    isLoaded?: boolean;
-}
-declare function makePivotTable(worksheet: any, model: PivotTableModel): PivotTable;
-export { makePivotTable };

package/dist/types/modules/excel/range.d.ts

@@ -1,62 +0,0 @@
-import type { Address } from "@excel/types";
-interface RangeModel {
-    top: number;
-    left: number;
-    bottom: number;
-    right: number;
-    sheetName?: string;
-}
-interface RowDimensions {
-    min: number;
-    max: number;
-}
-interface RowWithDimensions {
-    number: number;
-    dimensions?: RowDimensions;
-}
-export type RangeInput = Range | RangeModel | string | number | RangeInput[];
-declare class Range {
-    model: RangeModel;
-    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;
-    set left(value: number);
-    get bottom(): number;
-    set bottom(value: number);
-    get right(): number;
-    set right(value: number);
-    get sheetName(): string | undefined;
-    set sheetName(value: string | undefined);
-    get _serialisedSheetName(): string;
-    expand(top: number, left: number, bottom: number, right: number): void;
-    expandRow(row: RowWithDimensions | null | undefined): void;
-    expandToAddress(addressStr: string): void;
-    get tl(): string;
-    get $t$l(): string;
-    get br(): string;
-    get $b$r(): string;
-    get range(): string;
-    get $range(): string;
-    get shortRange(): string;
-    get $shortRange(): string;
-    get count(): number;
-    toString(): string;
-    intersects(other: Range): boolean;
-    contains(addressStr: string): boolean;
-    containsEx(address: Address): boolean;
-    forEachAddress(cb: (address: string, row: number, col: number) => void): void;
-}
-export { Range };
-export { Range as Dimensions };