@cj-tech-master/excelts 3.1.0 → 4.0.0-canary.20260103013222.0e5d37f

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

@@ -1,139 +0,0 @@
-import { EventEmitter } from "events";
-import { Readable } from "stream";
-import { StylesXform } from "../../xlsx/xform/style/styles-xform";
-import { WorksheetReader } from "./worksheet-reader";
-import { HyperlinkReader } from "./hyperlink-reader";
-import type { WorksheetState, Font, WorkbookProperties } from "../../types";
-/** Internal options type that includes undocumented 'prep' value */
-export interface InternalWorksheetOptions {
-    worksheets?: "emit" | "ignore" | "prep";
-    sharedStrings?: "cache" | "emit" | "ignore";
-    hyperlinks?: "cache" | "emit" | "ignore";
-    styles?: "cache" | "ignore";
-    entries?: "emit" | "ignore";
-}
-/** Rich text item from shared strings */
-export interface SharedStringRichText {
-    richText: Array<{
-        font: Partial<Font> | null;
-        text: string | null;
-    }>;
-}
-/** Shared string value - either plain text or rich text */
-export type SharedStringValue = string | SharedStringRichText;
-/** Relationship entry from workbook.xml.rels */
-export interface WorkbookRelationship {
-    Id: string;
-    Target: string;
-    Type?: string;
-}
-/** Sheet metadata from workbook.xml */
-export interface SheetMetadata {
-    id: number;
-    name: string;
-    state?: WorksheetState;
-    rId: string;
-}
-/** Workbook model parsed from workbook.xml */
-export interface WorkbookModel {
-    sheets?: SheetMetadata[];
-    properties?: Partial<WorkbookProperties>;
-    views?: unknown[];
-    definedNames?: unknown[];
-}
-/** Properties parsed from workbook.xml (workbookPr element) */
-export interface WorkbookPropertiesXform {
-    model?: Partial<WorkbookProperties>;
-}
-/** Entry event payload */
-interface EntryPayload {
-    type: "shared-strings" | "styles" | "workbook" | "worksheet" | "hyperlinks";
-    id?: string;
-}
-/** Parse event types */
-export type ParseEventType = EntryPayload["type"];
-export interface SharedStringEvent {
-    eventType: "shared-strings";
-    value: {
-        index: number;
-        text: SharedStringValue;
-    };
-}
-export interface WorksheetReadyEvent {
-    eventType: "worksheet";
-    value: WorksheetReader;
-}
-export interface HyperlinksEvent {
-    eventType: "hyperlinks";
-    value: HyperlinkReader;
-}
-export type ParseEvent = SharedStringEvent | WorksheetReadyEvent | HyperlinksEvent;
-/**
- * Options for WorkbookReader
- */
-export interface WorkbookReaderOptions {
-    /**
-     * Specifies whether to emit worksheets ('emit') or not ('ignore').
-     * @default 'emit'
-     */
-    worksheets?: "emit" | "ignore";
-    /**
-     * Specifies whether to cache shared strings ('cache'), emit them ('emit'), or ignore them ('ignore').
-     * @default 'cache'
-     */
-    sharedStrings?: "cache" | "emit" | "ignore";
-    /**
-     * Specifies whether to cache hyperlinks ('cache'), emit them ('emit'), or ignore them ('ignore').
-     * @default 'ignore'
-     */
-    hyperlinks?: "cache" | "emit" | "ignore";
-    /**
-     * Specifies whether to cache styles ('cache') or ignore them ('ignore').
-     * @default 'ignore'
-     */
-    styles?: "cache" | "ignore";
-    /**
-     * Specifies whether to emit entries ('emit') or not ('ignore').
-     * @default 'ignore'
-     */
-    entries?: "emit" | "ignore";
-}
-declare class WorkbookReader extends EventEmitter {
-    input: string | Readable;
-    options: {
-        worksheets: "emit" | "ignore";
-        sharedStrings: "cache" | "emit" | "ignore";
-        hyperlinks: "cache" | "emit" | "ignore";
-        styles: "cache" | "ignore";
-        entries: "emit" | "ignore";
-    };
-    styles: StylesXform;
-    stream?: Readable;
-    sharedStrings?: SharedStringValue[];
-    workbookRels?: WorkbookRelationship[];
-    properties?: WorkbookPropertiesXform;
-    model?: WorkbookModel;
-    constructor(input: string | Readable, options?: WorkbookReaderOptions);
-    _getStream(input: string | Readable): Readable;
-    read(input?: string | Readable, options?: WorkbookReaderOptions): Promise<void>;
-    [Symbol.asyncIterator](): AsyncIterableIterator<WorksheetReader>;
-    parse(input?: string | Readable, options?: WorkbookReaderOptions): AsyncIterableIterator<ParseEvent>;
-    _emitEntry(payload: EntryPayload): void;
-    _parseRels(entry: NodeJS.ReadableStream): Promise<void>;
-    _parseWorkbook(entry: NodeJS.ReadableStream): Promise<void>;
-    _parseSharedStrings(entry: NodeJS.ReadableStream): AsyncIterableIterator<{
-        index: number;
-        text: SharedStringValue;
-    }>;
-    _parseStyles(entry: NodeJS.ReadableStream): Promise<void>;
-    _parseWorksheet(iterator: AsyncIterable<unknown>, sheetNo: string): IterableIterator<WorksheetReadyEvent>;
-    _parseHyperlinks(iterator: AsyncIterable<unknown>, sheetNo: string): IterableIterator<HyperlinksEvent>;
-}
-declare const WorkbookReaderOptions: {
-    readonly worksheets: readonly ["emit", "ignore"];
-    readonly sharedStrings: readonly ["cache", "emit", "ignore"];
-    readonly hyperlinks: readonly ["cache", "emit", "ignore"];
-    readonly styles: readonly ["cache", "ignore"];
-    readonly entries: readonly ["emit", "ignore"];
-};
-export { WorkbookReader, WorkbookReaderOptions };

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

@@ -1,139 +0,0 @@
-import fs from "fs";
-import { Zip } from "../../utils/zip/streaming-zip";
-import { StreamBuf } from "../../utils/stream-buf";
-import { StylesXform } from "../../xlsx/xform/style/styles-xform";
-import { SharedStrings } from "../../utils/shared-strings";
-import { DefinedNames } from "../../doc/defined-names";
-import { WorksheetWriter } from "./worksheet-writer";
-import type Stream from "stream";
-import type { Image, WorkbookView, AddWorksheetOptions } from "../../types";
-/** Internal medium type for storing images in workbook */
-interface Medium extends Image {
-    type: "image";
-    name: string;
-}
-/** Internal comment reference type for tracking comment files */
-interface CommentRef {
-    commentName: string;
-    vmlDrawing: string;
-}
-export interface ZlibOptions {
-    /** @default constants.Z_NO_FLUSH */
-    flush?: number;
-    /** @default constants.Z_FINISH */
-    finishFlush?: number;
-    /** @default 16*1024 */
-    chunkSize?: number;
-    windowBits?: number;
-    /** compression level (0-9) */
-    level?: number;
-    memLevel?: number;
-    strategy?: number;
-    dictionary?: Buffer | NodeJS.TypedArray | DataView | ArrayBuffer;
-}
-export interface ZipOptions {
-    comment?: string;
-    forceLocalTime?: boolean;
-    forceZip64?: boolean;
-    store?: boolean;
-    zlib?: Partial<ZlibOptions>;
-    /** Alternative way to set compression level */
-    compressionOptions?: {
-        level?: number;
-    };
-}
-export interface WorkbookWriterOptions {
-    /** The date the workbook was created */
-    created?: Date;
-    /** The date the workbook was last modified */
-    modified?: Date;
-    /** The author of the workbook */
-    creator?: string;
-    /** Who last modified the workbook */
-    lastModifiedBy?: string;
-    /** The date the workbook was last printed */
-    lastPrinted?: Date;
-    /** Specifies whether to use shared strings in the workbook. Default is false */
-    useSharedStrings?: boolean;
-    /** Specifies whether to add style information to the workbook. Default is false */
-    useStyles?: boolean;
-    /** Zip compression options */
-    zip?: Partial<ZipOptions>;
-    /** Specifies a writable stream to write the XLSX workbook to */
-    stream?: Stream;
-    /** If stream not specified, this field specifies the path to a file to write the XLSX workbook to */
-    filename?: string;
-}
-declare class WorkbookWriter {
-    /** The date the workbook was created */
-    created: Date;
-    /** The date the workbook was last modified */
-    modified: Date;
-    /** The author of the workbook */
-    creator: string;
-    /** Who last modified the workbook */
-    lastModifiedBy: string;
-    /** The date the workbook was last printed */
-    lastPrinted?: Date;
-    /** Whether to use shared strings */
-    useSharedStrings: boolean;
-    /** Shared strings collection - internal use */
-    sharedStrings: SharedStrings;
-    /** Style manager - internal use */
-    styles: StylesXform;
-    /** Defined names - internal use */
-    _definedNames: DefinedNames;
-    /** Worksheets collection */
-    _worksheets: WorksheetWriter[];
-    /** Workbook views controls how many separate windows Excel will open */
-    views: WorkbookView[];
-    /** Zip options - internal use */
-    zipOptions?: Partial<ZipOptions>;
-    /** Compression level (0-9) */
-    compressionLevel: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
-    /** Media collection (images) - internal use */
-    media: Medium[];
-    /** Comment references - internal use */
-    commentRefs: CommentRef[];
-    /** Zip instance - internal use */
-    zip: Zip;
-    /** Output stream - internal use */
-    stream: Stream | fs.WriteStream | InstanceType<typeof StreamBuf>;
-    /** Internal promise for async operations */
-    promise: Promise<void[]>;
-    constructor(options?: WorkbookWriterOptions);
-    get definedNames(): DefinedNames;
-    _openStream(path: string): InstanceType<typeof StreamBuf>;
-    _addFile(data: string | Uint8Array, name: string, base64?: boolean): void;
-    _commitWorksheets(): Promise<void>;
-    commit(): Promise<void>;
-    get nextId(): number;
-    /**
-     * Add Image to Workbook and return the id
-     */
-    addImage(image: Image): number;
-    /**
-     * Get image by id
-     */
-    getImage(id: number): Image | undefined;
-    /**
-     * Add a new worksheet and return a reference to it
-     */
-    addWorksheet(name?: string, options?: Partial<AddWorksheetOptions>): WorksheetWriter;
-    /**
-     * Fetch sheet by name or id
-     */
-    getWorksheet(id?: string | number): WorksheetWriter | undefined;
-    addStyles(): Promise<void>;
-    addThemes(): Promise<void>;
-    addOfficeRels(): Promise<void>;
-    addContentTypes(): Promise<void>;
-    addMedia(): Promise<void[]>;
-    addApp(): Promise<void>;
-    addCore(): Promise<void>;
-    addSharedStrings(): Promise<void>;
-    addWorkbookRels(): Promise<void>;
-    addWorkbook(): Promise<void>;
-    _finalize(): Promise<any>;
-}
-export { WorkbookWriter };

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

@@ -1,55 +0,0 @@
-import { EventEmitter } from "events";
-import { Dimensions } from "../../doc/range";
-import { Row } from "../../doc/row";
-import { Column } from "../../doc/column";
-import type { WorkbookReader, InternalWorksheetOptions } from "./workbook-reader";
-import type { WorksheetState } from "../../types";
-/** Hyperlink reference from worksheet XML */
-export interface WorksheetHyperlink {
-    ref: string;
-    rId: string;
-}
-/** Events emitted during worksheet parsing */
-export type WorksheetEventType = RowEvent["eventType"] | HyperlinkEvent["eventType"];
-/** Row event emitted during parsing */
-export interface RowEvent {
-    eventType: "row";
-    value: Row;
-}
-/** Hyperlink event emitted during parsing */
-export interface HyperlinkEvent {
-    eventType: "hyperlink";
-    value: WorksheetHyperlink;
-}
-export type WorksheetEvent = RowEvent | HyperlinkEvent;
-export interface WorksheetReaderOptions {
-    workbook: WorkbookReader;
-    id: number;
-    iterator: AsyncIterable<unknown>;
-    options?: InternalWorksheetOptions;
-}
-declare class WorksheetReader extends EventEmitter {
-    workbook: WorkbookReader;
-    id: number | string;
-    iterator: AsyncIterable<unknown>;
-    options: InternalWorksheetOptions;
-    name: string;
-    state?: WorksheetState;
-    private _columns;
-    private _keys;
-    private _dimensions;
-    hyperlinks?: Record<string, WorksheetHyperlink>;
-    constructor({ workbook, id, iterator, options }: WorksheetReaderOptions);
-    destroy(): void;
-    get dimensions(): Dimensions;
-    get columns(): Column[] | null;
-    getColumn(c: string | number): Column;
-    getColumnKey(key: string): Column | undefined;
-    setColumnKey(key: string, value: Column): void;
-    deleteColumnKey(key: string): void;
-    eachColumnKey(f: (column: Column, key: string) => void): void;
-    read(): Promise<void>;
-    [Symbol.asyncIterator](): AsyncIterableIterator<Row>;
-    parse(): AsyncIterableIterator<WorksheetEvent[]>;
-}
-export { WorksheetReader };

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

@@ -1,139 +0,0 @@
-import { Dimensions } from "../../doc/range";
-import { StringBuf } from "../../utils/string-buf";
-import { Row } from "../../doc/row";
-import { Column } from "../../doc/column";
-import { SheetRelsWriter } from "./sheet-rels-writer";
-import { SheetCommentsWriter } from "./sheet-comments-writer";
-import { DataValidations } from "../../doc/data-validations";
-import type { StreamBuf } from "../../utils/stream-buf";
-import type { RowBreak, ColBreak, PageSetup, HeaderFooter, WorksheetProperties, WorksheetView, WorksheetState, AutoFilter, WorksheetProtection, ConditionalFormattingOptions } from "../../types";
-interface WorksheetWriterOptions {
-    id: number;
-    name?: string;
-    workbook: any;
-    useSharedStrings?: boolean;
-    properties?: Partial<WorksheetProperties>;
-    state?: WorksheetState;
-    pageSetup?: Partial<PageSetup>;
-    views?: Partial<WorksheetView>[];
-    autoFilter?: AutoFilter;
-    headerFooter?: Partial<HeaderFooter>;
-}
-declare class WorksheetWriter {
-    id: number;
-    name: string;
-    state: WorksheetState;
-    /** Rows stored while being worked on. Set to null after commit. */
-    _rows: Row[] | null;
-    /** Column definitions */
-    _columns: Column[] | null;
-    /** Column keys mapping: key => Column */
-    _keys: {
-        [key: string]: Column;
-    };
-    /** Merged cell ranges */
-    _merges: Dimensions[];
-    _sheetRelsWriter: SheetRelsWriter;
-    _sheetCommentsWriter: SheetCommentsWriter;
-    _dimensions: Dimensions;
-    _rowZero: number;
-    committed: boolean;
-    dataValidations: DataValidations;
-    /** Shared formulae by address */
-    _formulae: {
-        [key: string]: unknown;
-    };
-    _siFormulae: number;
-    conditionalFormatting: ConditionalFormattingOptions[];
-    rowBreaks: RowBreak[];
-    colBreaks: ColBreak[];
-    properties: Partial<WorksheetProperties> & {
-        defaultRowHeight: number;
-        dyDescent?: number;
-        outlineLevelCol: number;
-        outlineLevelRow: number;
-    };
-    headerFooter: Partial<HeaderFooter>;
-    pageSetup: Partial<PageSetup> & {
-        margins: PageSetup["margins"];
-    };
-    useSharedStrings: boolean;
-    _workbook: any;
-    hasComments: boolean;
-    _views: Partial<WorksheetView>[];
-    autoFilter: AutoFilter | null;
-    _media: unknown[];
-    sheetProtection: {
-        sheet?: boolean;
-        algorithmName?: string;
-        saltValue?: string;
-        spinCount?: number;
-        hashValue?: string;
-        [key: string]: unknown;
-    } | null;
-    _stream?: InstanceType<typeof StreamBuf>;
-    startedData: boolean;
-    _background?: {
-        imageId?: number;
-        rId?: string;
-    };
-    _headerRowCount?: number;
-    /** Relationship Id - assigned by WorkbookWriter */
-    rId?: string;
-    constructor(options: WorksheetWriterOptions);
-    get workbook(): any;
-    get stream(): any;
-    destroy(): void;
-    commit(): void;
-    get dimensions(): Dimensions;
-    get views(): Partial<WorksheetView>[];
-    get columns(): Column[] | null;
-    set columns(value: Partial<Column>[]);
-    getColumnKey(key: string): Column | undefined;
-    setColumnKey(key: string, value: Column): void;
-    deleteColumnKey(key: string): void;
-    eachColumnKey(f: (column: Column, key: string) => void): void;
-    getColumn(c: string | number): Column;
-    get _nextRow(): number;
-    eachRow(options: {
-        includeEmpty?: boolean;
-    } | ((row: Row, rowNumber: number) => void), iteratee?: (row: Row, rowNumber: number) => void): void;
-    _commitRow(cRow: Row): void;
-    get lastRow(): Row | undefined;
-    findRow(rowNumber: number): Row | undefined;
-    getRow(rowNumber: number): Row;
-    addRow(value: any[] | Record<string, any>): Row;
-    findCell(r: string | number, c?: number): any;
-    getCell(r: string | number, c?: number): any;
-    mergeCells(...cells: (string | number)[]): void;
-    addConditionalFormatting(cf: ConditionalFormattingOptions): void;
-    removeConditionalFormatting(filter?: number | ((cf: ConditionalFormattingOptions) => boolean)): void;
-    addBackgroundImage(imageId: number): void;
-    getBackgroundImageId(): number | undefined;
-    protect(password?: string, options?: Partial<WorksheetProtection>): Promise<void>;
-    unprotect(): void;
-    _write(text: string): void;
-    _writeSheetProperties(xmlBuf: StringBuf, properties: Partial<WorksheetProperties> | undefined, pageSetup: Partial<PageSetup> | undefined): void;
-    _writeSheetFormatProperties(xmlBuf: StringBuf, properties: Partial<WorksheetProperties> | undefined): void;
-    _writeOpenWorksheet(): void;
-    _writeColumns(): void;
-    _writeOpenSheetData(): void;
-    _writeRow(row: any): void;
-    _writeCloseSheetData(): void;
-    _writeMergeCells(): void;
-    _writeHyperlinks(): void;
-    _writeConditionalFormatting(): void;
-    _writeRowBreaks(): void;
-    _writeColBreaks(): 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/utils/browser-buffer.d.ts

@@ -1,28 +0,0 @@
-/**
- * Browser-compatible Buffer utilities
- * Provides base64 encoding/decoding and a Buffer-like wrapper for Uint8Array
- */
-/**
- * Convert Uint8Array to base64 string
- */
-export declare function uint8ArrayToBase64(bytes: Uint8Array): string;
-/**
- * Convert base64 string to Uint8Array
- */
-export declare function base64ToUint8Array(base64: string): Uint8Array;
-/**
- * Buffer-like wrapper for Uint8Array with toString("base64") support
- * This provides Node.js Buffer-like API for browser environments
- */
-export declare class BrowserBuffer extends Uint8Array {
-    toString(encoding?: string): string;
-    static from(data: Uint8Array): BrowserBuffer;
-}
-/**
- * Convert string to UTF-16LE Uint8Array (used for Excel password hashing)
- */
-export declare function stringToUtf16Le(str: string): Uint8Array;
-/**
- * Concatenate multiple Uint8Arrays into one
- */
-export declare function concatUint8Arrays(...arrays: Uint8Array[]): Uint8Array;

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

@@ -1,28 +0,0 @@
-/**
- * Browser-compatible Encryptor with pure JS SHA implementations
- * This provides synchronous hash functions for browser compatibility
- */
-import { BrowserBuffer } from "./browser-buffer";
-declare const Encryptor: {
-    /**
-     * Calculate a hash of the concatenated buffers with the given algorithm.
-     * @param algorithm - The hash algorithm.
-     * @returns The hash as Uint8Array
-     */
-    hash(algorithm: string, ...buffers: Uint8Array[]): Uint8Array;
-    /**
-     * Convert a password into an encryption key
-     * @param password - The password
-     * @param hashAlgorithm - The hash algorithm
-     * @param saltValue - The salt value (base64 encoded)
-     * @param spinCount - The spin count
-     * @returns The encryption key (base64 encoded)
-     */
-    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): BrowserBuffer;
-};
-export { Encryptor };

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

@@ -1,23 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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 };