@xlvane/compat 1.2.3 → 1.3.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { StreamSheetSpec, Workbook as Workbook$1, WorkbookProperties as WorkbookProperties$1 } from "xlvane";
+import { FontStyle, StreamSheetSpec, Workbook as Workbook$1, WorkbookProperties as WorkbookProperties$1 } from "xlvane";
 /**
  * A cell location of a defined name, as exceljs keeps it.
  *
@@ -150,6 +150,8 @@ interface WorkbookMeta {
   readonly views?: readonly Record<string, unknown>[];
   /** `workbook.calcProperties`. */
   readonly calcProperties?: Record<string, unknown>;
+  /** The default font (font 0) of a loaded workbook (F4). */
+  readonly defaultFont?: FontStyle;
 }
 /**
  * Options of `xlsx.load`, `read` and `readFile`, as exceljs `XlsxReadOptions` (index.d.ts L1460;
@@ -287,6 +289,8 @@ export declare class Workbook {
   get definedNames(): DefinedNames;
   /** @internal The document properties and defined names to write, as exceljs `workbook.model`. */
   _meta(): WorkbookMeta;
+  /** @internal The default font (font 0) of the file this workbook was loaded from, written again (F4); `null` for a workbook made in code. */
+  _defaultFont: FontStyle | null;
   /** @internal */
   get _date1904(): boolean;
   private _byName;
@@ -405,12 +409,16 @@ interface CsvWriteOptions {
   map?(value: unknown, index: number): unknown;
   /** Blank lines for missing rows (default `true`). */
   includeEmptyRows?: boolean;
-  /** fast-csv formatter options: `delimiter`, `rowDelimiter`, `quote`, `escape`, `quoteColumns`, `headers`, `writeHeaders`, `includeEndRowDelimiter`, `writeBOM`. */
+  /** fast-csv formatter options: `delimiter`, `rowDelimiter`, `quote`, `escape`, `quoteColumns`, `quoteHeaders`, `headers`, `writeHeaders`, `alwaysWriteHeaders`, `includeEndRowDelimiter`, `writeBOM`, `transform`. */
   formatterOptions?: Record<string, unknown>;
   /**
-   * `"escape"` (default): text that starts with `=`, `+`, `-`, `@`, tab, CR or LF (or their
-   * full-width forms) is written with a leading `'`, so spreadsheet applications show it as text
-   * (OWASP CSV Injection). `"off"`: written unchanged, as exceljs does. An xlvane option.
+   * `"escape"` (default): text that starts with `=`, `+`, `-`, `@`, tab, CR, LF or another
+   * control character (or the full-width forms of the signs), or with a byte order mark, is
+   * written with a leading `'`, so spreadsheet applications show it as text (OWASP CSV
+   * Injection); so is a `latin1` or `utf16le` field whose first bytes are a byte order mark, and
+   * a `utf16le` field whose bytes without NULs start with `=`. `utf16le` output starts with the
+   * UTF-16LE byte order mark. A field holding a comma, `;`, tab or `|` is quoted whatever the
+   * delimiter. `"off"`: written unchanged, as exceljs does. An xlvane option.
    */
   formulaInjection?: "escape" | "off";
 }
@@ -2452,8 +2460,12 @@ export declare class Cell {
   _master: Cell | null;
   /** @internal Number of merged ranges this cell is the master of. */
   _mergeCount: number;
+  /** The moved formula of a `{ sharedFormula }` value, and what it was moved from (see `formula`). */
+  private _moved;
   /** @internal Use `worksheet.getCell()`. */
   constructor(_row: Row, _col: number);
+  /** The style a new cell takes: row style wins over column style, part by part (lib/doc/cell.js L99-119 `_mergeStyle`). */
+  private _rowColumnStyle;
   get worksheet(): Worksheet;
   get row(): number;
   get col(): number;
@@ -2476,7 +2488,12 @@ export declare class Cell {
    * this cell, as exceljs translates it (lib/doc/cell.js `_getTranslatedFormula`; X4-29).
    */
   get formula(): string | undefined;
-  /** `FormulaType.Shared` for a `{ sharedFormula }` value, `Master` for other formulas, otherwise `None` (lib/doc/cell.js L807). */
+  /**
+   * `FormulaType.Shared` for a `{ sharedFormula }` value, `Master` for other formulas, and
+   * `undefined` for a cell without a formula and for a merged cell other than the top-left one,
+   * as in exceljs, where only the formula value has a `formulaType` (lib/doc/cell.js L264-266,
+   * L807-815; exceljs's declaration says `FormulaType` all the same).
+   */
   get formulaType(): FormulaType;
   get result(): unknown;
   get numFmt(): string | undefined;
@@ -2553,6 +2570,11 @@ export declare class Cell {
   _merge(master: Cell): void;
   /** @internal */
   _unmerge(): void;
+  /**
+   * @internal As exceljs `cell.unmerge()` (lib/doc/cell.js L177-183): a cell merged into another
+   * one gets the row and column style again, instead of the master's.
+   */
+  _unmergeResetStyle(): void;
 }
 /**
  * A row, as exceljs `Row` (lib/doc/row.js).
@@ -2702,7 +2724,7 @@ export declare class Column {
   equivalentTo(other: Column): boolean;
   get defn(): ColumnDefn;
   set defn(value: ColumnDefn | undefined);
-  /** Cell values of this column by row number (index 0 unused). */
+  /** Cell values of this column by row number (index 0 unused); empty cells are left out (lib/doc/column.js L179-187). */
   get values(): CellValue[];
   set values(values: CellValue[]);
   eachCell(options: {
@@ -2808,6 +2830,11 @@ export declare class Worksheet {
   _columns: Column[];
   /** @internal */
   _merges: MergeMap;
+  /**
+   * @internal Formulas of shared-formula masters by address, for the dependents of a worksheet
+   * whose rows are not kept (stream.xlsx.WorkbookReader), so `cell.formula` can move them (K2).
+   */
+  _sharedMasters: Map<string, string> | undefined;
   /** The cells covered by `_merges` (row × 16 385 + column), valid while `_mergedVersion` equals `_merges.version`. */
   private _mergedCells;
   private _mergedVersion;
@@ -2902,8 +2929,9 @@ export declare class Worksheet {
   }[], change: SpliceChange): void;
   /**
    * @internal Merges a range without the overlap check of `mergeCells`. Cells keep their own
-   * style, except those for which `takeMasterStyle` returns true (cells inserted inside the range),
-   * which get a copy of the master's style; style objects are never shared.
+   * style object (the master's, when `mergeCells` shared it with them), except those for which
+   * `takeMasterStyle` returns true (cells inserted inside the range), which get a copy of the
+   * master's style.
    */
   _mergeRange(range: {
     top: number;