@cj-tech-master/excelts 1.6.1 → 1.6.2-canary.20251223042142.4d33ec6

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

@@ -1,85 +1,119 @@
-import type { RowBreak } from "../../types.js";
+import { Dimensions } from "../../doc/range.js";
+import { StringBuf } from "../../utils/string-buf.js";
+import { Row } from "../../doc/row.js";
+import { Column } from "../../doc/column.js";
+import { SheetRelsWriter } from "./sheet-rels-writer.js";
+import { SheetCommentsWriter } from "./sheet-comments-writer.js";
+import { DataValidations } from "../../doc/data-validations.js";
+import type { StreamBuf } from "../../utils/stream-buf.js";
+import type { RowBreak, PageSetup, HeaderFooter, WorksheetProperties, WorksheetView, WorksheetState, AutoFilter, WorksheetProtection, ConditionalFormattingOptions } 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;
+    properties?: Partial<WorksheetProperties>;
+    state?: WorksheetState;
+    pageSetup?: Partial<PageSetup>;
+    views?: Partial<WorksheetView>[];
+    autoFilter?: AutoFilter;
+    headerFooter?: Partial<HeaderFooter>;
 }
 declare class WorksheetWriter {
     id: number;
     name: string;
-    state: string;
-    _rows: any[] | null;
-    _columns: any[] | null;
+    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]: any;
+        [key: string]: Column;
     };
-    _merges: any[];
-    _sheetRelsWriter: any;
-    _sheetCommentsWriter: any;
-    _dimensions: any;
+    /** Merged cell ranges */
+    _merges: Dimensions[];
+    _sheetRelsWriter: SheetRelsWriter;
+    _sheetCommentsWriter: SheetCommentsWriter;
+    _dimensions: Dimensions;
     _rowZero: number;
     committed: boolean;
-    dataValidations: any;
+    dataValidations: DataValidations;
+    /** Shared formulae by address */
     _formulae: {
-        [key: string]: any;
+        [key: string]: unknown;
     };
     _siFormulae: number;
-    conditionalFormatting: any[];
+    conditionalFormatting: ConditionalFormattingOptions[];
     rowBreaks: RowBreak[];
-    properties: any;
-    headerFooter: any;
-    pageSetup: any;
+    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: any[];
-    autoFilter: any;
-    _media: any[];
-    sheetProtection: any;
-    _stream?: any;
+    _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?: any;
+    _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(): any;
-    get views(): any[];
-    get columns(): any[] | null;
-    set columns(value: any[]);
-    getColumnKey(key: string): any;
-    setColumnKey(key: string, value: any): 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: any, key: string) => void): void;
-    getColumn(c: string | number): any;
+    eachColumnKey(f: (column: Column, key: string) => void): void;
+    getColumn(c: string | number): Column;
     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;
+    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?: any): Promise<void>;
+    protect(password?: string, options?: Partial<WorksheetProtection>): Promise<void>;
     unprotect(): void;
     _write(text: string): void;
-    _writeSheetProperties(xmlBuf: any, properties: any, pageSetup: any): void;
-    _writeSheetFormatProperties(xmlBuf: any, properties: any): 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;

package/dist/types/types.d.ts

@@ -481,22 +481,6 @@ export interface TableProperties {
     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;
@@ -509,6 +493,10 @@ export interface AddWorksheetOptions {
     headerFooter?: Partial<HeaderFooter>;
     views?: Array<Partial<WorksheetView>>;
     state?: WorksheetState;
+    /** Specifies whether to use shared strings. Overrides workbook setting. */
+    useSharedStrings?: boolean;
+    /** Apply an auto filter to the worksheet */
+    autoFilter?: AutoFilter;
 }
 export interface DefinedNamesRanges {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cj-tech-master/excelts",
-  "version": "1.6.1",
+  "version": "1.6.2-canary.20251223042142.4d33ec6",
   "description": "TypeScript Excel Workbook Manager - Read and Write xlsx and csv Files.",
   "private": false,
   "publishConfig": {
@@ -110,7 +110,7 @@
     "@types/node": "^25.0.3",
     "@typescript-eslint/eslint-plugin": "^8.50.0",
     "@typescript-eslint/parser": "^8.50.0",
-    "@typescript/native-preview": "^7.0.0-dev.20251217.1",
+    "@typescript/native-preview": "^7.0.0-dev.20251219.1",
     "@vitest/browser": "^4.0.16",
     "@vitest/browser-playwright": "^4.0.16",
     "@vitest/ui": "^4.0.16",
@@ -120,14 +120,14 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import-x": "^4.16.1",
-    "eslint-plugin-oxlint": "^1.33.0",
+    "eslint-plugin-oxlint": "^1.34.0",
     "eslint-plugin-unused-imports": "^4.3.0",
     "express": "^5.2.1",
     "fast-xml-parser": "^5.3.3",
     "husky": "^9.1.7",
     "node-stdlib-browser": "^1.3.1",
     "nodemon": "^3.1.11",
-    "oxlint": "^1.33.0",
+    "oxlint": "^1.34.0",
     "playwright": "^1.57.0",
     "prettier": "^3.7.4",
     "rimraf": "^6.1.2",
@@ -136,7 +136,7 @@
     "tslib": "^2.8.1",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0",
-    "vite-tsconfig-paths": "^6.0.2",
+    "vite-tsconfig-paths": "^6.0.3",
     "vitest": "^4.0.16"
   },
   "scripts": {