@rowsncolumns/rnc-engine 0.10.132

package/dist/esm/wasm/rnc_wasm.d.ts

@@ -0,0 +1,394 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A collaborative spreadsheet engine backed by a Yjs CRDT document.
+ *
+ * Same command / read surface as `SpreadsheetEngine`, plus sync methods for exchanging Yrs
+ * updates between peers.
+ */
+export class CollabSpreadsheetEngine {
+    free(): void;
+    [Symbol.dispose](): void;
+    addSheet(sheet_id: number, name: string): void;
+    applyCommand(command_json: string): string;
+    /**
+     * Apply a remote Yjs V1 update into this peer's document. After calling this, call
+     * `syncRemote()` to rebuild the engine and get a `CommitResult` for the UI.
+     */
+    applyUpdate(update: Uint8Array): void;
+    canRedo(): boolean;
+    canUndo(): boolean;
+    clearHistory(): void;
+    dependents(sheet_id: number, row: number, col: number): string;
+    documentFacets(): string;
+    /**
+     * Encode a diff: everything this peer has that the remote (identified by its state vector)
+     * doesn't. Send the result to the remote via `applyUpdate`.
+     */
+    encodeDiffV1(remote_sv: Uint8Array): Uint8Array;
+    /**
+     * Encode the full document state as a Yjs V1 update (for persistence or initial sync).
+     */
+    encodeStateAsUpdate(): Uint8Array;
+    /**
+     * Encode the current state vector (compact summary of what this peer has seen).
+     */
+    encodeStateVector(): Uint8Array;
+    /**
+     * Export a sheet's display values as RFC-4180 CSV.
+     */
+    exportCsv(sheet_id: number): string;
+    /**
+     * Export the whole workbook to in-memory XLSX bytes (a JS `Uint8Array`) via `rnc-export`.
+     */
+    exportXlsx(): Uint8Array;
+    /**
+     * Pre-allocate rows and columns for a sheet. YrsStore addresses cells by positional index
+     * within CRDT arrays, so the grid dimensions must be established before cells can be written.
+     * Call this once per sheet after `addSheet`.
+     */
+    initGrid(sheet_id: number, rows: number, cols: number): void;
+    loadDocument(document_json: string): string;
+    /**
+     * Create a new collaborative engine with a random client ID.
+     */
+    constructor();
+    /**
+     * Create a new collaborative engine with a specific client ID (important when running two
+     * instances on the same page — they must have distinct IDs for CRDT correctness).
+     */
+    static newWithClientId(client_id: number): CollabSpreadsheetEngine;
+    precedents(sheet_id: number, row: number, col: number): string;
+    /**
+     * Selection statistics over a 1-indexed inclusive range, computed in Rust; returns `RangeStats`
+     * JSON (`{ sum, count, average, min, max, numericalCount }`). See `SpreadsheetEngine::rangeStats`.
+     */
+    rangeStats(sheet_id: number, start_row: number, start_col: number, end_row: number, end_col: number): string;
+    readWindow(sheet_id: number, start_row: number, start_col: number, end_row: number, end_col: number): string;
+    redo(): string;
+    redoDepth(): number;
+    registerCustomFunction(name: string): void;
+    /**
+     * See [`SpreadsheetEngine::set_windowed`](super::SpreadsheetEngine). When on, commits serialized
+     * by this engine omit the per-cell channels the windowed host re-reads from the window. Idempotent.
+     */
+    setWindowed(on: boolean): void;
+    /**
+     * Per-sheet used extent as JSON `[[sheetId, rowCount, colCount], …]` (nav + windowing bounds).
+     */
+    sheetExtents(): string;
+    sheetIds(): Int32Array;
+    /**
+     * The workbook's sheets in tab order as JSON `[{sheetId, title, index, hidden?, tabColor?}]` —
+     * the engine's authoritative sheet identity/order. A thin UI reconciles its tab list from this.
+     */
+    sheets(): string;
+    /**
+     * Begin a streaming NDJSON hydration (huge workbooks). Feed chunks with `streamWrite`, then
+     * `streamEnd`. Read the viewport with `readWindow` afterward.
+     */
+    streamBegin(): void;
+    /**
+     * Finish the streaming hydration (ingest the trailing line + recompute once).
+     */
+    streamEnd(): void;
+    /**
+     * Ingest one NDJSON byte chunk of the hydration stream (partial lines are buffered).
+     */
+    streamWrite(chunk: Uint8Array): void;
+    /**
+     * Rebuild the calc engine from the (now-mutated) CRDT store and return a full `CommitResult`
+     * JSON so the UI can repaint after a remote update.
+     */
+    syncRemote(): string;
+    undo(): string;
+    undoDepth(): number;
+}
+
+/**
+ * The spreadsheet engine instance the UI holds (standalone, in-memory document).
+ */
+export class SpreadsheetEngine {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Register a sheet (id → display name).
+     */
+    addSheet(sheet_id: number, name: string): void;
+    /**
+     * Apply a `commands.ts` JSON command; returns `CommitResult` JSON.
+     */
+    applyCommand(command_json: string): string;
+    canRedo(): boolean;
+    /**
+     * Whether an undo / redo is currently available (for enabling toolbar buttons).
+     */
+    canUndo(): boolean;
+    /**
+     * Drop the entire undo/redo history (the document is unchanged). Backs `onClearHistory`.
+     */
+    clearHistory(): void;
+    /**
+     * The DEPENDENTS of a cell — every formula cell that references it (directly or within a range) —
+     * as `[{sheetId,rowIndex,columnIndex}]`. Powers `getDependents`.
+     */
+    dependents(sheet_id: number, row: number, col: number): string;
+    /**
+     * Document-level facets the renderer draws (CF rules, tables, named/protected ranges, embeds,
+     * slicers, banded ranges, basic filters, DV rules) as canonical JSON — the thin hook re-reads
+     * this once per commit (they're small and change rarely, so they ride a getter, not a diff).
+     */
+    documentFacets(): string;
+    /**
+     * Scratch-evaluate a formula at a cell — `ExtendedValue` JSON or `"null"`. Read-only; powers
+     * the cell editor's live result preview (`onRequestCalculate`).
+     */
+    evalFormula(sheet_id: number, row: number, col: number, formula: string): string;
+    /**
+     * Export a sheet's display values as RFC-4180 CSV.
+     */
+    exportCsv(sheet_id: number): string;
+    /**
+     * Export the whole workbook to in-memory XLSX bytes (a JS `Uint8Array`). Reads the full document
+     * from the store (all sheets, values, formats, merges, frozen panes, dims, tables, named ranges)
+     * and runs the `rnc-export` writer; formulas are inserted, not recalculated.
+     */
+    exportXlsx(): Uint8Array;
+    /**
+     * [`SpreadsheetEngine::export_xlsx`] with client export options — `options_json` is
+     * `{"includeNotes":bool,"citationsAsNotes":bool}` (camelCase, fields optional).
+     * `includeNotes:false` omits every cell-note comment part; `citationsAsNotes:true`
+     * additionally writes each citation's string as a note on its anchor (top-left) cell.
+     */
+    exportXlsxWithOptions(options_json: string): Uint8Array;
+    /**
+     * Find every cell on `sheet_id` matching `find`, returned as a JSON array of `SheetCoordinate`
+     * (row-major). Read-only — the windowed UI calls this for off-window matches the JS search can't
+     * see (it only holds the loaded viewport). `ranges_json` is a JSON array of `SheetRange`
+     * (empty/`""` = whole sheet). Matching mirrors the UI: `match_case` / `whole_word` / `use_regex`.
+     * Distinct fill/font colors + CF icons in one column's body rows — JSON
+     * `{cellColors, fontColors, icons}`. Powers the "Filter by color" picker on windowed hosts.
+     */
+    filterColors(sheet_id: number, col: number, start_row: number, end_row: number): string;
+    findAll(sheet_id: number, ranges_json: string, find: string, match_case: boolean, whole_word: boolean, use_regex: boolean): string;
+    /**
+     * Import an `.xlsx` workbook with the native `rnc-import` reader (the symmetric inverse of
+     * [`SpreadsheetEngine::export_xlsx`]) and hydrate the engine from it. Returns the full
+     * `CommitResult` (every cell + style) so the UI repaints in one shot — the same path and shape as
+     * [`SpreadsheetEngine::load_document`]. The imported sheets are loaded into the current store
+     * (by sheet id); start from a fresh engine for a clean replace.
+     */
+    importXlsx(bytes: Uint8Array): string;
+    /**
+     * Like [`SpreadsheetEngine::import_xlsx`] but for password-protected workbooks (ECMA-376 agile,
+     * standard AES, or RC4 CryptoAPI): decrypts with `password` first. A non-encrypted file imports
+     * directly (password ignored), so a host can route every import here. A wrong password returns an
+     * error the UI can re-prompt on.
+     */
+    importXlsxWithPassword(bytes: Uint8Array, password: string): string;
+    /**
+     * Whether the bytes are an encrypted (CFB) workbook needing a password (vs a plain `.xlsx`).
+     */
+    isEncryptedXlsx(bytes: Uint8Array): boolean;
+    /**
+     * Hydrate the engine from an initial document (`{ sheets, sheetData, styles }` JSON, the
+     * `rnc-model` shape an API returns). Loads cells + styles, recomputes formulas, and returns the
+     * full `CommitResult` (every cell + style) so the UI can populate in one shot.
+     */
+    loadDocument(document_json: string): string;
+    constructor();
+    /**
+     * The PRECEDENTS of a cell — the cells + ranges its formula references — as
+     * `{cells:[{sheetId,rowIndex,columnIndex}], ranges:[{sheetId,startRowIndex,…}]}`. The engine
+     * parses the formula with the grammar it evaluates, so this is exact. Powers `getPrecedents`.
+     */
+    precedents(sheet_id: number, row: number, col: number): string;
+    /**
+     * Selection statistics over a 1-indexed inclusive range, computed in Rust; returns `RangeStats`
+     * JSON (`{ sum, count, average, min, max, numericalCount }`, numeric fields `null` when the
+     * range holds no numbers). Cheap even at a million cells — the status bar can show stats for
+     * any selection without iterating it on the JS main thread.
+     */
+    rangeStats(sheet_id: number, start_row: number, start_col: number, end_row: number, end_col: number): string;
+    /**
+     * Read a 1-indexed inclusive window; returns `WindowSnapshot` JSON.
+     */
+    readWindow(sheet_id: number, start_row: number, start_col: number, end_row: number, end_col: number): string;
+    /**
+     * Redo the last undone mutation; returns the `CommitResult` JSON.
+     */
+    redo(): string;
+    redoDepth(): number;
+    /**
+     * Register a host (JS) custom-function NAME so `=NAME(…)` resolves (and its arg cell refs are
+     * tracked as dependencies) instead of `#NAME?`. The body runs in JS: on recalc the engine streams
+     * a `customEvals` request (cell + resolved args) the host answers via `set-effective-value`.
+     */
+    registerCustomFunction(name: string): void;
+    /**
+     * Declare whether the host renders WINDOWED. When on, every commit serialized by this engine
+     * (`applyCommand` / `undo` / `redo` / `loadDocument`) omits the per-cell channels the windowed
+     * host re-reads via `readWindow` anyway — see [`SpreadsheetEngine::serialize_commit`]. Idempotent.
+     */
+    setWindowed(on: boolean): void;
+    /**
+     * Per-sheet used extent as JSON `[[sheetId, rowCount, colCount], …]` (1-based data extents).
+     * A windowed renderer reads this to size the grid's scroll extent to the engine's data — so it
+     * can hold only the visible viewport in JS yet scroll the full sheet.
+     */
+    sheetExtents(): string;
+    /**
+     * Sheet ids in order.
+     */
+    sheetIds(): Int32Array;
+    /**
+     * The workbook's sheets in tab order as JSON `[{sheetId, title, index, hidden?, tabColor?}]` —
+     * the engine's authoritative sheet identity/order (it owns `create`/`rename`/`move`/`delete`).
+     * A thin UI reconciles its tab list from this after each commit.
+     */
+    sheets(): string;
+    /**
+     * Begin a streaming hydration (for huge workbooks). Then feed NDJSON bytes via
+     * `streamWrite(chunk)` as they arrive (e.g. from `fetch(url).body`) and finish with
+     * `streamEnd()`. Nothing is streamed back — read the viewport with `readWindow` afterward.
+     */
+    streamBegin(): void;
+    /**
+     * Finish the streaming hydration: ingest the trailing line and recompute once.
+     */
+    streamEnd(): void;
+    /**
+     * Ingest one byte chunk of the NDJSON hydration stream (a `Uint8Array`). Chunk boundaries may
+     * fall anywhere — partial lines are buffered until complete.
+     */
+    streamWrite(chunk: Uint8Array): void;
+    /**
+     * Every function name the calc engine resolves by registration (formualizer builtins + rnc
+     * overrides), as a JSON string array — uppercase, sorted. Alias spellings are not listed;
+     * probe `evalFormula` for `#NAME?` to cover them. Feeds the cross-engine function-catalog
+     * parity harness (`libs/functions/__tests__/engine-function-parity.spec.ts`).
+     */
+    supportedFunctionNames(): string;
+    /**
+     * Undo the last document mutation; returns the `CommitResult` JSON to stream back.
+     */
+    undo(): string;
+    /**
+     * Undo / redo stack depth — a UI keeping parallel per-edit state (cursor/selection) watches these
+     * to push/pop its own snapshots in lockstep with the engine.
+     */
+    undoDepth(): number;
+    /**
+     * The engine's WASM linear-memory size in bytes — the VM's committed heap (`memory.size` × 64 KiB
+     * page). It never shrinks, so read it after a workload for the high-water mark. Returns 0 on a
+     * non-wasm (native test) target.
+     */
+    wasmMemoryBytes(): number;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_spreadsheetengine_free: (a: number, b: number) => void;
+    readonly spreadsheetengine_addSheet: (a: number, b: number, c: number, d: number) => void;
+    readonly spreadsheetengine_applyCommand: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly spreadsheetengine_canRedo: (a: number) => number;
+    readonly spreadsheetengine_canUndo: (a: number) => number;
+    readonly spreadsheetengine_clearHistory: (a: number) => void;
+    readonly spreadsheetengine_dependents: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly spreadsheetengine_documentFacets: (a: number) => [number, number];
+    readonly spreadsheetengine_evalFormula: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
+    readonly spreadsheetengine_exportCsv: (a: number, b: number) => [number, number];
+    readonly spreadsheetengine_exportXlsx: (a: number) => [number, number, number, number];
+    readonly spreadsheetengine_exportXlsxWithOptions: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly spreadsheetengine_filterColors: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly spreadsheetengine_findAll: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number, number];
+    readonly spreadsheetengine_importXlsx: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly spreadsheetengine_importXlsxWithPassword: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly spreadsheetengine_isEncryptedXlsx: (a: number, b: number, c: number) => number;
+    readonly spreadsheetengine_loadDocument: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly spreadsheetengine_new: () => number;
+    readonly spreadsheetengine_precedents: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly spreadsheetengine_rangeStats: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly spreadsheetengine_readWindow: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly spreadsheetengine_redo: (a: number) => [number, number, number, number];
+    readonly spreadsheetengine_redoDepth: (a: number) => number;
+    readonly spreadsheetengine_registerCustomFunction: (a: number, b: number, c: number) => void;
+    readonly spreadsheetengine_setWindowed: (a: number, b: number) => void;
+    readonly spreadsheetengine_sheetExtents: (a: number) => [number, number, number, number];
+    readonly spreadsheetengine_sheetIds: (a: number) => [number, number];
+    readonly spreadsheetengine_sheets: (a: number) => [number, number];
+    readonly spreadsheetengine_streamBegin: (a: number) => void;
+    readonly spreadsheetengine_streamEnd: (a: number) => void;
+    readonly spreadsheetengine_streamWrite: (a: number, b: number, c: number) => void;
+    readonly spreadsheetengine_supportedFunctionNames: (a: number) => [number, number];
+    readonly spreadsheetengine_undo: (a: number) => [number, number, number, number];
+    readonly spreadsheetengine_undoDepth: (a: number) => number;
+    readonly spreadsheetengine_wasmMemoryBytes: (a: number) => number;
+    readonly __wbg_collabspreadsheetengine_free: (a: number, b: number) => void;
+    readonly collabspreadsheetengine_addSheet: (a: number, b: number, c: number, d: number) => void;
+    readonly collabspreadsheetengine_applyCommand: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_applyUpdate: (a: number, b: number, c: number) => [number, number];
+    readonly collabspreadsheetengine_canRedo: (a: number) => number;
+    readonly collabspreadsheetengine_canUndo: (a: number) => number;
+    readonly collabspreadsheetengine_clearHistory: (a: number) => void;
+    readonly collabspreadsheetengine_dependents: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_documentFacets: (a: number) => [number, number];
+    readonly collabspreadsheetengine_encodeDiffV1: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_encodeStateAsUpdate: (a: number) => [number, number];
+    readonly collabspreadsheetengine_encodeStateVector: (a: number) => [number, number];
+    readonly collabspreadsheetengine_exportCsv: (a: number, b: number) => [number, number];
+    readonly collabspreadsheetengine_exportXlsx: (a: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_initGrid: (a: number, b: number, c: number, d: number) => void;
+    readonly collabspreadsheetengine_loadDocument: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_new: () => number;
+    readonly collabspreadsheetengine_newWithClientId: (a: number) => number;
+    readonly collabspreadsheetengine_precedents: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_rangeStats: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_readWindow: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_redo: (a: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_redoDepth: (a: number) => number;
+    readonly collabspreadsheetengine_registerCustomFunction: (a: number, b: number, c: number) => void;
+    readonly collabspreadsheetengine_setWindowed: (a: number, b: number) => void;
+    readonly collabspreadsheetengine_sheetExtents: (a: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_sheetIds: (a: number) => [number, number];
+    readonly collabspreadsheetengine_sheets: (a: number) => [number, number];
+    readonly collabspreadsheetengine_streamBegin: (a: number) => void;
+    readonly collabspreadsheetengine_streamEnd: (a: number) => void;
+    readonly collabspreadsheetengine_streamWrite: (a: number, b: number, c: number) => void;
+    readonly collabspreadsheetengine_syncRemote: (a: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_undo: (a: number) => [number, number, number, number];
+    readonly collabspreadsheetengine_undoDepth: (a: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;