@rowsncolumns/y-spreadsheet 16.0.0 → 16.1.0-beta.0

package/Readme.md

@@ -24,7 +24,7 @@ import { useYSpreadsheet } from "@rowsncolumns/spreadsheet-yjs";
 import * as Y from "yjs";
 import { WebsocketProvider } from "y-websocket";
 
-const version = "v4";
+const version = "v5";
 const yDoc = new Y.Doc();
 const yWebsocketProvider = new WebsocketProvider(
   "ws://localhost:1234",

package/dist/cjs/helpers-v5.d.ts

@@ -0,0 +1,64 @@
+import type { CellData, CellFormat } from "@rowsncolumns/spreadsheet";
+import type { SheetData } from "@rowsncolumns/spreadsheet-state";
+import type { Patch } from "immer";
+import type * as Y from "yjs";
+/** A parsed v5 cell key; line ids as decimal strings (an id can exceed 2^53). */
+export type ParsedCellKeyV5 = {
+    sheetId: number;
+    rowId: string;
+    colId: string;
+};
+/** The composed style plane: cell key → format (`StyleOverlay`). */
+export type StyleOverlayV5 = Map<string, CellFormat>;
+/**
+ * A sheet's line ids in grid order (position = index + 1), as decimal strings.
+ * Later duplicates and non-id values are skipped, as the engine's index does.
+ */
+export declare const readLineIds: (doc: Y.Doc, sheetId: number, axis: "row" | "column") => string[];
+/** The `rncCells` / `rncNotes` key of a cell by its line ids. */
+export declare const createCellKeyV5: (sheetId: number, rowId: string, colId: string) => string;
+/** Parse a v5 key `"{sheetId}:{rowId}:{colId}"`; null when malformed. */
+export declare const parseCellKeyV5: (key: string) => ParsedCellKeyV5 | null;
+/**
+ * The composed style plane of a v5 doc (`refold_style_overlay`): the legacy
+ * `rncCellStyles` seed (`"{sheetId}!{A1}"`, the client-0 ids of that position)
+ * with every `rncCellStylesLog` buffer folded on in array order. Walks the log.
+ */
+export declare const readStyleOverlayV5: (doc: Y.Doc) => StyleOverlayV5;
+/**
+ * A v5 doc as V2 `SheetData` (same shape as `sheetDataV3ToV2`), hot plane only:
+ * every key of `rncCells`, `rncNotes` and the composed style plane composed as
+ * `composeCell` does (tombstones and orphans skipped).
+ */
+export declare const sheetDataV5ToV2: <T extends CellData>(doc: Y.Doc, styles?: ReadonlyMap<string, CellFormat>) => SheetData<T>;
+/**
+ * A reader of the cell at a 1-based position (`composeCell`), line ids read once
+ * per sheet. Undefined when nothing is there or the line is unnamed.
+ */
+export declare const createCellReaderV5: <T extends CellData = CellData>(doc: Y.Doc, styles?: ReadonlyMap<string, CellFormat>) => (sheetId: number, rowIndex: number, columnIndex: number) => T | undefined;
+/** `createCellReaderV5` for one cell (reads both id arrays: O(lines)). */
+export declare const getCellV5: <T extends CellData = CellData>(doc: Y.Doc, sheetId: number, rowIndex: number, columnIndex: number, styles?: ReadonlyMap<string, CellFormat>) => T | undefined;
+/**
+ * Apply changed `rncCells` / `rncNotes` keys to `currentSheetData` (copy-on-write,
+ * like `processSheetDataEventsV3`), `uf` from `styles`. Only valid while no id
+ * array and no style changed (those need `sheetDataV5ToV2`). Null when nothing changed.
+ */
+export declare const processSheetDataChangesV5: <T extends CellData>(changedKeys: Iterable<string>, currentSheetData: SheetData<T>, doc: Y.Doc, styles?: ReadonlyMap<string, CellFormat>) => SheetData<T> | null;
+/**
+ * Apply immer `SheetData` patches to a v5 doc in one transaction (`origin`, the
+ * caller's; nested in an open transaction it joins that one). Positional, like
+ * the v3 path: a row insert/delete arrives as rewritten rows and is applied as
+ * cell writes/removals at each position's line ids; no line is inserted or
+ * deleted. Writes past an axis name lines (client-0 padding, `ensure_lines`).
+ * `uf` changes append ONE `STYLE_LOG_V2` buffer to `rncCellStylesLog` and stay
+ * inline on the cell. `styles`, when given, is the caller's composed style plane
+ * (`readStyleOverlayV5`), used instead of folding the log and updated in place.
+ */
+export declare const addSheetDataPatchesV5: (doc: Y.Doc, patches: Patch[] | undefined, origin?: unknown, styles?: StyleOverlayV5) => void;
+/** Set one cell of a v5 doc (see `addSheetDataPatchesV5`). */
+export declare const setCellV5: (doc: Y.Doc, sheetId: number, rowIndex: number, columnIndex: number, value: CellData) => void;
+/** Remove one cell of a v5 doc (see `addSheetDataPatchesV5`). */
+export declare const deleteCellV5: (doc: Y.Doc, sheetId: number, rowIndex: number, columnIndex: number) => void;
+/** Remove every cell of a sheet of a v5 doc; its line ids and dimensions stay. */
+export declare const deleteSheetV5: (doc: Y.Doc, sheetId: number) => void;
+//# sourceMappingURL=helpers-v5.d.ts.map

package/dist/cjs/helpers-v5.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers-v5.d.ts","sourceRoot":"","sources":["../../helpers-v5.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAOnC,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC;AAE9B,iFAAiF;AACjF,MAAM,MAAM,eAAe,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhF,oEAAoE;AACpE,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAsDrD;;;GAGG;AACH,eAAO,MAAM,WAAW,GACtB,KAAK,CAAC,CAAC,GAAG,EACV,SAAS,MAAM,EACf,MAAM,KAAK,GAAG,QAAQ,KACrB,MAAM,EAYR,CAAC;AAEF,iEAAiE;AACjE,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EACf,OAAO,MAAM,EACb,OAAO,MAAM,KACZ,MAAwC,CAAC;AAE5C,yEAAyE;AACzE,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,eAAe,GAAG,IAc9D,CAAC;AAyHF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,KAAK,CAAC,CAAC,GAAG,KAAG,cAoB/C,CAAC;AAqFF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,QAAQ,EAChD,KAAK,CAAC,CAAC,GAAG,EACV,SAAQ,WAAW,CAAC,MAAM,EAAE,UAAU,CAA2B,KAChE,SAAS,CAAC,CAAC,CAqBb,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC9D,KAAK,CAAC,CAAC,GAAG,EACV,SAAQ,WAAW,CAAC,MAAM,EAAE,UAAU,CAA2B,MAGzD,SAAS,MAAM,EAAE,UAAU,MAAM,EAAE,aAAa,MAAM,KAAG,CAAC,GAAG,SAWtE,CAAC;AAEF,0EAA0E;AAC1E,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,QAAQ,GAAG,QAAQ,EACrD,KAAK,CAAC,CAAC,GAAG,EACV,SAAS,MAAM,EACf,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,SAAS,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,KACvC,CAAC,GAAG,SAA+E,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,CAAC,SAAS,QAAQ,EAC1D,aAAa,QAAQ,CAAC,MAAM,CAAC,EAC7B,kBAAkB,SAAS,CAAC,CAAC,CAAC,EAC9B,KAAK,CAAC,CAAC,GAAG,EACV,SAAQ,WAAW,CAAC,MAAM,EAAE,UAAU,CAA2B,KAChE,SAAS,CAAC,CAAC,CAAC,GAAG,IAoCjB,CAAC;AAuSF;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,CAAC,CAAC,GAAG,EACV,SAAS,KAAK,EAAE,GAAG,SAAS,EAC5B,SAAQ,OAAc,EACtB,SAAS,cAAc,SA6CxB,CAAC;AAEF,8DAA8D;AAC9D,eAAO,MAAM,SAAS,GACpB,KAAK,CAAC,CAAC,GAAG,EACV,SAAS,MAAM,EACf,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,OAAO,QAAQ,KACd,IAGC,CAAC;AAEL,iEAAiE;AACjE,eAAO,MAAM,YAAY,GACvB,KAAK,CAAC,CAAC,GAAG,EACV,SAAS,MAAM,EACf,UAAU,MAAM,EAChB,aAAa,MAAM,KAClB,IAGC,CAAC;AAEL,kFAAkF;AAClF,eAAO,MAAM,aAAa,GAAI,KAAK,CAAC,CAAC,GAAG,EAAE,SAAS,MAAM,KAAG,IACK,CAAC"}