@xlvane/compat 1.2.2 → 1.3.0

package/dist/index.d.ts

@@ -289,14 +289,36 @@ export declare class Workbook {
   _meta(): WorkbookMeta;
   /** @internal */
   get _date1904(): boolean;
-  /** @internal Names of the other sheets, for the duplicate check of Worksheet.name. */
-  readonly _names: (exclude: Worksheet) => string[];
-  /** The id the next worksheet gets (lib/doc/workbook.js `nextId`). */
+  private _byName;
+  private _firstFree;
+  private _maxOrderNo;
+  private _maxOrderNoStale;
+  /** @internal Whether a sheet other than `exclude` has this name, ignoring case (the duplicate check of Worksheet.name). */
+  _nameTaken(name: string, exclude?: Worksheet): boolean;
+  /** @internal Keeps the name index in step with a renamed sheet. */
+  _renamed(sheet: Worksheet, oldName: string): void;
+  /** @internal Keeps the largest orderNo in step with a changed one. */
+  _orderNoChanged(sheet: Worksheet, oldOrderNo: number | undefined): void;
+  /** @internal Puts a worksheet into `_sheets` at its id and indexes it. */
+  _putSheet(sheet: Worksheet): void;
+  /** Takes a worksheet out of `_sheets` and its indexes. */
+  private _dropSheet;
+  /** Empties `_sheets` and its indexes. */
+  private _clearSheets;
+  /** The largest orderNo of the sheets, as exceljs computes it (lib/doc/workbook.js L81-85). */
+  private _lastOrderNo;
+  /** The id the next worksheet gets (lib/doc/workbook.js `nextId`): the lowest free id. */
   get nextId(): number;
   /** Adds a worksheet. Names follow exceljs rules (31 characters at most; longer names are cut). */
   addWorksheet(name?: string, options?: WorksheetOptions): Worksheet;
   /** @internal Adds a worksheet with a given id (a loaded file's sheetId, a model's id; D-F03). */
   _addWorksheetWithId(id: number, name?: string, options?: WorksheetOptions): Worksheet;
+  /**
+   * @internal Adds a worksheet read from a file (`xlsx.load`, `stream.xlsx.WorkbookReader`). A
+   * name exceljs refuses gives an XlvError with exceljs's message, the sheet and a hint, instead
+   * of the plain Error of `addWorksheet`; an empty name is refused too.
+   */
+  _addReadWorksheet(id: number, name: string, options?: WorksheetOptions): Worksheet;
   removeWorksheet(id: number | string): void;
   /** Removes a worksheet by id or name, as `removeWorksheet` (lib/doc/workbook.js L77). */
   removeWorksheetEx(worksheet: Worksheet): void;
@@ -386,9 +408,13 @@ interface CsvWriteOptions {
   /** fast-csv formatter options: `delimiter`, `rowDelimiter`, `quote`, `escape`, `quoteColumns`, `headers`, `writeHeaders`, `includeEndRowDelimiter`, `writeBOM`. */
   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";
 }
@@ -2430,6 +2456,8 @@ 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);
   get worksheet(): Worksheet;
@@ -2707,6 +2735,18 @@ type MergeRange = {
   bottom: number;
   right: number;
 };
+/**
+ * @internal What a worksheet needs from its workbook: the duplicate check of its name and, for a
+ * workbook that indexes its sheets, notices of a new name or orderNo.
+ */
+interface WorksheetHost {
+  /** Whether a sheet other than `exclude` has this name, ignoring case. */
+  _nameTaken(name: string, exclude: Worksheet): boolean;
+  _renamed?(sheet: Worksheet, oldName: string): void;
+  _orderNoChanged?(sheet: Worksheet, oldOrderNo: number | undefined): void;
+  readonly definedNames?: DefinedNames;
+  readonly worksheets?: readonly Worksheet[];
+}
 /** The merged ranges of a worksheet by master address, with a counter of changes (D-H01). */
 declare class MergeMap extends Map<string, MergeRange> {
   version: number;
@@ -2729,18 +2769,16 @@ declare class MergeMap extends Map<string, MergeRange> {
  * ```
  */
 export declare class Worksheet {
-  readonly workbook: {
-    readonly _names: (exclude: Worksheet) => string[];
-    readonly definedNames?: DefinedNames;
-    readonly worksheets?: readonly Worksheet[];
-  };
+  readonly workbook: WorksheetHost;
   readonly id: number;
   /**
    * The position of the sheet in `workbook.worksheets`, as exceljs `orderNo`: one more than the
    * largest of the other sheets for a new sheet (lib/doc/workbook.js L81-85), the 0-based position
    * in the file for a loaded one (L203). Worksheets are listed in this order.
    */
-  orderNo: number | undefined;
+  get orderNo(): number | undefined;
+  set orderNo(value: number | undefined);
+  private _orderNo;
   state: "visible" | "hidden" | "veryHidden";
   views: WorksheetView[];
   autoFilter: string | {
@@ -2776,17 +2814,18 @@ 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;
   private readonly _keys;
   private _name;
   /** @internal Use `workbook.addWorksheet()`. */
-  constructor(workbook: {
-    readonly _names: (exclude: Worksheet) => string[];
-    readonly definedNames?: DefinedNames;
-    readonly worksheets?: readonly Worksheet[];
-  }, id: number, name: string | undefined, options: WorksheetOptions | undefined);
+  constructor(workbook: WorksheetHost, id: number, name: string | undefined, options: WorksheetOptions | undefined);
   get name(): string;
   /** Sheet name rules of exceljs (lib/doc/worksheet.js L134–173), including truncation to 31 characters. */
   set name(value: string);