@cj-tech-master/excelts 0.1.0-canary.20251025023400.dff1908

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

@@ -0,0 +1,103 @@
+import type { RowBreak } from "../../types.js";
+interface WorksheetWriterOptions {
+    id: number;
+    name?: string;
+    workbook: any;
+    useSharedStrings?: boolean;
+    properties?: any;
+    state?: string;
+    pageSetup?: any;
+    views?: any[];
+    autoFilter?: any;
+    headerFooter?: any;
+}
+declare class WorksheetWriter {
+    id: number;
+    name: string;
+    state: string;
+    _rows: any[] | null;
+    _columns: any[] | null;
+    _keys: {
+        [key: string]: any;
+    };
+    _merges: any[];
+    _sheetRelsWriter: any;
+    _sheetCommentsWriter: any;
+    _dimensions: any;
+    _rowZero: number;
+    committed: boolean;
+    dataValidations: any;
+    _formulae: {
+        [key: string]: any;
+    };
+    _siFormulae: number;
+    conditionalFormatting: any[];
+    rowBreaks: RowBreak[];
+    properties: any;
+    headerFooter: any;
+    pageSetup: any;
+    useSharedStrings: boolean;
+    _workbook: any;
+    hasComments: boolean;
+    _views: any[];
+    autoFilter: any;
+    _media: any[];
+    sheetProtection: any;
+    _stream?: any;
+    startedData: boolean;
+    _background?: any;
+    _headerRowCount?: number;
+    constructor(options: WorksheetWriterOptions);
+    get workbook(): any;
+    get stream(): any;
+    destroy(): void;
+    commit(): void;
+    get dimensions(): any;
+    get views(): any[];
+    get columns(): any[] | null;
+    set columns(value: any[]);
+    getColumnKey(key: string): any;
+    setColumnKey(key: string, value: any): void;
+    deleteColumnKey(key: string): void;
+    eachColumnKey(f: (column: any, key: string) => void): void;
+    getColumn(c: string | number): any;
+    get _nextRow(): number;
+    eachRow(options: any, iteratee?: (row: any, rowNumber: number) => void): void;
+    _commitRow(cRow: any): void;
+    get lastRow(): any;
+    findRow(rowNumber: number): any;
+    getRow(rowNumber: number): any;
+    addRow(value: any): any;
+    findCell(r: any, c?: number): any;
+    getCell(r: any, c?: number): any;
+    mergeCells(...cells: any[]): void;
+    addConditionalFormatting(cf: any): void;
+    removeConditionalFormatting(filter: any): void;
+    addBackgroundImage(imageId: number): void;
+    getBackgroundImageId(): number | undefined;
+    protect(password?: string, options?: any): Promise<void>;
+    unprotect(): void;
+    _write(text: string): void;
+    _writeSheetProperties(xmlBuf: any, properties: any, pageSetup: any): void;
+    _writeSheetFormatProperties(xmlBuf: any, properties: any): void;
+    _writeOpenWorksheet(): void;
+    _writeColumns(): void;
+    _writeOpenSheetData(): void;
+    _writeRow(row: any): void;
+    _writeCloseSheetData(): void;
+    _writeMergeCells(): void;
+    _writeHyperlinks(): void;
+    _writeConditionalFormatting(): void;
+    _writeRowBreaks(): void;
+    _writeDataValidations(): void;
+    _writeSheetProtection(): void;
+    _writePageMargins(): void;
+    _writePageSetup(): void;
+    _writeHeaderFooter(): void;
+    _writeAutoFilter(): void;
+    _writeBackground(): void;
+    _writeLegacyData(): void;
+    _writeDimensions(): void;
+    _writeCloseWorksheet(): void;
+}
+export { WorksheetWriter };

package/dist/types/types.d.ts

@@ -0,0 +1,464 @@
+/**
+ * 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 declare enum PaperSize {
+    Legal = 5,
+    Executive = 7,
+    A4 = 9,
+    A5 = 11,
+    B5 = 13,
+    Envelope_10 = 20,
+    Envelope_DL = 27,
+    Envelope_C5 = 28,
+    Envelope_B5 = 34,
+    Envelope_Monarch = 37,
+    Double_Japan_Postcard_Rotated = 82,
+    K16_197x273_mm = 119
+}
+export interface Color {
+    argb: string;
+    theme: number;
+}
+export interface Font {
+    name: string;
+    size: number;
+    family: number;
+    scheme: "minor" | "major" | "none";
+    charset: number;
+    color: Partial<Color>;
+    bold: boolean;
+    italic: boolean;
+    underline: boolean | "none" | "single" | "double" | "singleAccounting" | "doubleAccounting";
+    vertAlign: "superscript" | "subscript";
+    strike: boolean;
+    outline: boolean;
+}
+export interface Alignment {
+    horizontal: "left" | "center" | "right" | "fill" | "justify" | "centerContinuous" | "distributed";
+    vertical: "top" | "middle" | "bottom" | "distributed" | "justify";
+    wrapText: boolean;
+    shrinkToFit: boolean;
+    indent: number;
+    readingOrder: "rtl" | "ltr";
+    textRotation: number | "vertical";
+}
+export interface Protection {
+    locked: boolean;
+    hidden: boolean;
+}
+export type BorderStyle = "thin" | "dotted" | "hair" | "medium" | "double" | "thick" | "dashed" | "dashDot" | "dashDotDot" | "slantDashDot" | "mediumDashed" | "mediumDashDotDot" | "mediumDashDot";
+export interface Border {
+    style: BorderStyle;
+    color: Partial<Color>;
+}
+export interface BorderDiagonal extends Border {
+    up: boolean;
+    down: boolean;
+}
+export interface Borders {
+    top: Partial<Border>;
+    left: Partial<Border>;
+    bottom: Partial<Border>;
+    right: Partial<Border>;
+    diagonal: Partial<BorderDiagonal>;
+}
+export type FillPatterns = "none" | "solid" | "darkVertical" | "darkHorizontal" | "darkGrid" | "darkTrellis" | "darkDown" | "darkUp" | "lightVertical" | "lightHorizontal" | "lightGrid" | "lightTrellis" | "lightDown" | "lightUp" | "darkGray" | "mediumGray" | "lightGray" | "gray125" | "gray0625";
+export interface FillPattern {
+    type: "pattern";
+    pattern: FillPatterns;
+    fgColor?: Partial<Color>;
+    bgColor?: Partial<Color>;
+}
+export interface GradientStop {
+    position: number;
+    color: Partial<Color>;
+}
+export interface FillGradientAngle {
+    type: "gradient";
+    gradient: "angle";
+    degree: number;
+    stops: GradientStop[];
+}
+export interface FillGradientPath {
+    type: "gradient";
+    gradient: "path";
+    center: {
+        left: number;
+        top: number;
+    };
+    stops: GradientStop[];
+}
+export type Fill = FillPattern | FillGradientAngle | FillGradientPath;
+export interface Style {
+    numFmt: string;
+    font: Partial<Font>;
+    alignment: Partial<Alignment>;
+    protection: Partial<Protection>;
+    border: Partial<Borders>;
+    fill: Fill;
+}
+export interface Margins {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+    header: number;
+    footer: number;
+}
+export interface PageSetup {
+    margins: Margins;
+    orientation: "portrait" | "landscape";
+    horizontalDpi: number;
+    verticalDpi: number;
+    fitToPage: boolean;
+    fitToWidth: number;
+    fitToHeight: number;
+    scale: number;
+    pageOrder: "downThenOver" | "overThenDown";
+    blackAndWhite: boolean;
+    draft: boolean;
+    cellComments: "atEnd" | "asDisplayed" | "None";
+    errors: "dash" | "blank" | "NA" | "displayed";
+    paperSize: PaperSize;
+    showRowColHeaders: boolean;
+    showGridLines: boolean;
+    firstPageNumber: number;
+    horizontalCentered: boolean;
+    verticalCentered: boolean;
+    printArea: string;
+    printTitlesRow: string;
+    printTitlesColumn: string;
+}
+export interface HeaderFooter {
+    differentFirst: boolean;
+    differentOddEven: boolean;
+    oddHeader: string;
+    oddFooter: string;
+    evenHeader: string;
+    evenFooter: string;
+    firstHeader: string;
+    firstFooter: string;
+}
+export interface WorksheetViewCommon {
+    rightToLeft: boolean;
+    activeCell: string;
+    showRuler: boolean;
+    showRowColHeaders: boolean;
+    showGridLines: boolean;
+    zoomScale: number;
+    zoomScaleNormal: number;
+}
+export interface WorksheetViewNormal {
+    state: "normal";
+    style: "pageBreakPreview" | "pageLayout";
+}
+export interface WorksheetViewFrozen {
+    state: "frozen";
+    style?: "pageBreakPreview";
+    xSplit?: number;
+    ySplit?: number;
+    topLeftCell?: string;
+}
+export interface WorksheetViewSplit {
+    state: "split";
+    style?: "pageBreakPreview" | "pageLayout";
+    xSplit?: number;
+    ySplit?: number;
+    topLeftCell?: string;
+    activePane?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
+}
+export type WorksheetView = WorksheetViewCommon & (WorksheetViewNormal | WorksheetViewFrozen | WorksheetViewSplit);
+export interface WorksheetProperties {
+    tabColor: Partial<Color>;
+    outlineLevelCol: number;
+    outlineLevelRow: number;
+    outlineProperties: {
+        summaryBelow: boolean;
+        summaryRight: boolean;
+    };
+    defaultRowHeight: number;
+    defaultColWidth?: number;
+    dyDescent: number;
+    showGridLines: boolean;
+}
+export type WorksheetState = "visible" | "hidden" | "veryHidden";
+export type AutoFilter = string | {
+    from: string | {
+        row: number;
+        column: number;
+    };
+    to: string | {
+        row: number;
+        column: number;
+    };
+};
+export interface WorksheetProtection {
+    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;
+    spinCount: number;
+}
+export interface WorkbookView {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    firstSheet: number;
+    activeTab: number;
+    visibility: string;
+}
+export interface WorkbookProperties {
+    date1904: boolean;
+}
+export interface CalculationProperties {
+    fullCalcOnLoad: boolean;
+}
+export interface CellErrorValue {
+    error: "#N/A" | "#REF!" | "#NAME?" | "#DIV/0!" | "#NULL!" | "#VALUE!" | "#NUM!";
+}
+export interface RichText {
+    text: string;
+    font?: Partial<Font>;
+}
+export interface CellRichTextValue {
+    richText: RichText[];
+}
+export interface CellHyperlinkValue {
+    text: string;
+    hyperlink: string;
+    tooltip?: string;
+}
+export interface CellFormulaValue {
+    formula: string;
+    result?: number | string | boolean | Date | CellErrorValue;
+    date1904?: boolean;
+}
+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 interface CommentMargins {
+    insetmode: "auto" | "custom";
+    inset: number[];
+}
+export interface CommentProtection {
+    locked: "True" | "False";
+    lockText: "True" | "False";
+}
+export type CommentEditAs = "twoCells" | "oneCells" | "absolute";
+export interface Comment {
+    texts?: RichText[];
+    margins?: Partial<CommentMargins>;
+    protection?: Partial<CommentProtection>;
+    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[];
+    allowBlank?: boolean;
+    operator?: DataValidationOperator;
+    error?: string;
+    errorTitle?: string;
+    errorStyle?: string;
+    prompt?: string;
+    promptTitle?: string;
+    showErrorMessage?: boolean;
+    showInputMessage?: boolean;
+}
+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;
+        row: number;
+    };
+    ext: {
+        width: number;
+        height: number;
+    };
+}
+export interface ImageHyperlinkValue {
+    hyperlink: string;
+    tooltip?: string;
+}
+export type Location = {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+};
+export type Address = {
+    sheetName?: string;
+    address: string;
+    col: number;
+    row: number;
+    $col$row: string;
+};
+export type RowValues = CellValue[] | {
+    [key: string]: CellValue;
+} | undefined | null;
+export type CellIsOperators = "equal" | "greaterThan" | "lessThan" | "between";
+export type ContainsTextOperators = "containsText" | "containsBlanks" | "notContainsBlanks" | "containsErrors" | "notContainsErrors";
+export type TimePeriodTypes = "lastWeek" | "thisWeek" | "nextWeek" | "yesterday" | "today" | "tomorrow" | "last7Days" | "lastMonth" | "thisMonth" | "nextMonth";
+export type IconSetTypes = "5Arrows" | "5ArrowsGray" | "5Boxes" | "5Quarters" | "5Rating" | "4Arrows" | "4ArrowsGray" | "4Rating" | "4RedToBlack" | "4TrafficLights" | "NoIcons" | "3Arrows" | "3ArrowsGray" | "3Flags" | "3Signs" | "3Stars" | "3Symbols" | "3Symbols2" | "3TrafficLights1" | "3TrafficLights2" | "3Triangles";
+export type CfvoTypes = "percentile" | "percent" | "num" | "min" | "max" | "formula" | "autoMin" | "autoMax";
+export interface Cvfo {
+    type: CfvoTypes;
+    value?: number;
+}
+export interface ConditionalFormattingBaseRule {
+    priority: number;
+    style?: Partial<Style>;
+}
+export interface ExpressionRuleType extends ConditionalFormattingBaseRule {
+    type: "expression";
+    formulae?: any[];
+}
+export interface CellIsRuleType extends ConditionalFormattingBaseRule {
+    type: "cellIs";
+    formulae?: any[];
+    operator?: CellIsOperators;
+}
+export interface Top10RuleType extends ConditionalFormattingBaseRule {
+    type: "top10";
+    rank: number;
+    percent: boolean;
+    bottom: boolean;
+}
+export interface AboveAverageRuleType extends ConditionalFormattingBaseRule {
+    type: "aboveAverage";
+    aboveAverage: boolean;
+}
+export interface ColorScaleRuleType extends ConditionalFormattingBaseRule {
+    type: "colorScale";
+    cfvo?: Cvfo[];
+    color?: Partial<Color>[];
+}
+export interface IconSetRuleType extends ConditionalFormattingBaseRule {
+    type: "iconSet";
+    showValue?: boolean;
+    reverse?: boolean;
+    custom?: boolean;
+    iconSet?: IconSetTypes;
+    cfvo?: Cvfo[];
+}
+export interface ContainsTextRuleType extends ConditionalFormattingBaseRule {
+    type: "containsText";
+    operator?: ContainsTextOperators;
+    text?: string;
+}
+export interface TimePeriodRuleType extends ConditionalFormattingBaseRule {
+    type: "timePeriod";
+    timePeriod?: TimePeriodTypes;
+}
+export interface DataBarRuleType extends ConditionalFormattingBaseRule {
+    type: "dataBar";
+    gradient?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    showValue?: boolean;
+    border?: boolean;
+    negativeBarColorSameAsPositive?: boolean;
+    negativeBarBorderColorSameAsPositive?: boolean;
+    axisPosition?: "auto" | "middle" | "none";
+    direction?: "context" | "leftToRight" | "rightToLeft";
+    cfvo?: Cvfo[];
+}
+export type ConditionalFormattingRule = ExpressionRuleType | CellIsRuleType | Top10RuleType | AboveAverageRuleType | ColorScaleRuleType | IconSetRuleType | ContainsTextRuleType | TimePeriodRuleType | DataBarRuleType;
+export interface ConditionalFormattingOptions {
+    ref: string;
+    rules: ConditionalFormattingRule[];
+}
+export interface TableStyleProperties {
+    theme?: string;
+    showFirstColumn?: boolean;
+    showLastColumn?: boolean;
+    showRowStripes?: boolean;
+    showColumnStripes?: boolean;
+}
+export interface TableColumnProperties {
+    name: string;
+    filterButton?: boolean;
+    totalsRowLabel?: string;
+    totalsRowFunction?: "none" | "average" | "countNums" | "count" | "max" | "min" | "stdDev" | "var" | "sum" | "custom";
+    totalsRowFormula?: string;
+    style?: Partial<Style>;
+}
+export interface TableProperties {
+    name: string;
+    displayName?: string;
+    ref: string;
+    headerRow?: boolean;
+    totalsRow?: boolean;
+    style?: TableStyleProperties;
+    columns: TableColumnProperties[];
+    rows: any[][];
+}
+export type TableColumn = Required<TableColumnProperties>;
+export interface JSZipGeneratorOptions {
+    compression: "STORE" | "DEFLATE";
+    compressionOptions: null | {
+        level: number;
+    };
+}
+export interface XlsxReadOptions {
+    ignoreNodes?: string[];
+    maxRows?: number;
+    maxCols?: number;
+}
+export interface XlsxWriteOptions {
+    zip?: Partial<JSZipGeneratorOptions>;
+    useSharedStrings?: boolean;
+    useStyles?: boolean;
+}
+export interface Media {
+    type: string;
+    name: string;
+    extension: string;
+    buffer: Buffer;
+}
+export interface AddWorksheetOptions {
+    properties?: Partial<WorksheetProperties>;
+    pageSetup?: Partial<PageSetup>;
+    headerFooter?: Partial<HeaderFooter>;
+    views?: Array<Partial<WorksheetView>>;
+    state?: WorksheetState;
+}
+export interface DefinedNamesRanges {
+    name: string;
+    ranges: string[];
+}
+export type DefinedNamesModel = DefinedNamesRanges[];
+export interface RowBreak {
+    id: number;
+    max: number;
+    min: number;
+    man: number;
+}

package/dist/types/utils/browser-buffer-decode.d.ts

@@ -0,0 +1,2 @@
+declare function bufferToString(chunk: Buffer<ArrayBuffer>): string;
+export { bufferToString };

package/dist/types/utils/browser-buffer-encode.d.ts

@@ -0,0 +1,2 @@
+declare function stringToBuffer(str: string | Buffer<ArrayBuffer>): Buffer<ArrayBuffer>;
+export { stringToBuffer };

package/dist/types/utils/browser.d.ts

@@ -0,0 +1 @@
+export declare const isBrowser: boolean;

package/dist/types/utils/cell-matrix.d.ts

@@ -0,0 +1,37 @@
+interface CellAddress {
+    sheetName?: string;
+    address: string;
+    row: number;
+    col: number;
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+}
+type Cell = CellAddress & any;
+type Row = Cell[];
+type Sheet = Row[];
+type Sheets = Record<string, Sheet>;
+declare class CellMatrix {
+    template: any;
+    sheets: Sheets;
+    constructor(template?: any);
+    addCell(addressStr: string): void;
+    getCell(addressStr: string): Cell;
+    findCell(addressStr: string): Cell | undefined;
+    findCellAt(sheetName: string, rowNumber: number, colNumber: number): Cell | undefined;
+    addCellEx(address: CellAddress): void;
+    getCellEx(address: CellAddress): Cell;
+    findCellEx(address: CellAddress, create: boolean): Cell | undefined;
+    getCellAt(sheetName: string, rowNumber: number, colNumber: number): Cell;
+    removeCellEx(address: CellAddress): void;
+    forEachInSheet(sheetName: string, callback: (cell: Cell, rowNumber: number, colNumber: number) => void): void;
+    forEach(callback: (cell: Cell) => void): void;
+    map<T>(callback: (cell: Cell) => T): T[];
+    findSheet(address: CellAddress, create: boolean): Sheet | undefined;
+    findSheetRow(sheet: Sheet | undefined, address: CellAddress, create: boolean): Row | undefined;
+    findRowCell(row: Row | undefined, address: CellAddress, create: boolean): Cell | undefined;
+    spliceRows(sheetName: string, start: number, numDelete: number, numInsert: number): void;
+    spliceColumns(sheetName: string, start: number, numDelete: number, numInsert: number): void;
+}
+export { CellMatrix };

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

@@ -0,0 +1,33 @@
+import type { Address, Location } from "../types.js";
+type Range = Location & {
+    tl: string | Address;
+    br: string | Address;
+    dimensions: string;
+    sheetName?: string;
+};
+interface ErrorReference {
+    error: string;
+    sheetName?: string;
+}
+type DecodeExResult = Address | Range | ErrorReference;
+interface ColCache {
+    _dictionary: string[];
+    _l2nFill: number;
+    _l2n: Record<string, number>;
+    _n2l: string[];
+    _hash: Record<string, Address>;
+    _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;
+    decodeEx(value: string): DecodeExResult;
+    encodeAddress(row: number, col: number): string;
+    encode(...args: number[]): string;
+    inRange(range: number[], address: number[]): boolean;
+}
+declare const colCache: ColCache;
+export { colCache };

package/dist/types/utils/copy-style.d.ts

@@ -0,0 +1,5 @@
+interface StyleObject {
+    [key: string]: any;
+}
+declare const copyStyle: (style: StyleObject | null | undefined) => StyleObject | null | undefined;
+export { copyStyle };

package/dist/types/utils/encryptor.d.ts

@@ -0,0 +1,23 @@
+declare const Encryptor: {
+    /**
+     * Calculate a hash of the concatenated buffers with the given algorithm.
+     * @param algorithm - The hash algorithm.
+     * @returns The hash
+     */
+    hash(algorithm: string, ...buffers: Buffer[]): Buffer;
+    /**
+     * Convert a password into an encryption key
+     * @param password - The password
+     * @param hashAlgorithm - The hash algoritm
+     * @param saltValue - The salt value
+     * @param spinCount - The spin count
+     * @returns The encryption key
+     */
+    convertPasswordToHash(password: string, hashAlgorithm: string, saltValue: string, spinCount: number): string;
+    /**
+     * Generates cryptographically strong pseudo-random data.
+     * @param size The size argument is a number indicating the number of bytes to generate.
+     */
+    randomBytes(size: number): Buffer;
+};
+export { Encryptor };

package/dist/types/utils/iterate-stream.d.ts

@@ -0,0 +1,10 @@
+import type { EventEmitter } from "events";
+interface Readable extends EventEmitter {
+    resume(): void;
+    pause(): void;
+    on(event: "data", listener: (chunk: any) => void): this;
+    on(event: "end", listener: () => void): this;
+    on(event: "error", listener: (err: Error) => void): this;
+}
+declare function iterateStream(stream: Readable): AsyncGenerator<any>;
+export { iterateStream };

package/dist/types/utils/parse-sax.d.ts

@@ -0,0 +1,6 @@
+interface SaxEvent {
+    eventType: "opentag" | "text" | "closetag";
+    value: any;
+}
+declare function parseSax(iterable: any): AsyncGenerator<SaxEvent[]>;
+export { parseSax };