@datalayer/cells 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2026 Datalayer, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,56 @@
-# Temporary Holding Version
+[![Datalayer](https://images.datalayer.io/legacy/datalayer-25.svg)](https://datalayer.ai)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![Become a Sponsor](https://img.shields.io/static/v1?label=Become%20a%20Sponsor&message=%E2%9D%A4&logo=GitHub&style=flat&color=1ABC9C)](https://github.com/sponsors/datalayer)
+
+# ☰ 🦠 Datalayer Cells
+
+A spreadsheet drawn on canvas and exposed as a React component, over a
+headless model that also runs in Node and in workers. Cells is built on
+[Reactor](https://github.com/datalayer/reactor): every extension point (formula
+functions, cell types, commands, importers and exporters, data sources, the
+collaboration provider) is a Reactor contribution point, and the built-in
+features are Reactor plugins contributing through the same points.
+
+> Work in progress: nothing is published yet.
+
+## Packages
+
+| Import                    | What                                                    |
+| ------------------------- | ------------------------------------------------------- |
+| `@datalayer/cells`        | the React component and hooks; re-exports `./core`      |
+| `@datalayer/cells/core`   | the headless model: no React, no DOM                    |
+| `@datalayer/cells/csv`    | CSV and TSV in and out                                  |
+| `@datalayer/cells/xlsx`   | XLSX in and out, loaded lazily                          |
+| `@datalayer/cells/collab` | real-time collaboration over Loro                       |
+| `@datalayer/cells/chrome` | toolbar, formula bar and sheet tabs                     |
+| `@datalayer/cells/plugin` | views for a Reactor shell                               |
+
+## Development
+
+The reactor is resolved from a checkout beside this repository (`../reactor`).
+
+```bash
+npm install
+npm run lint        # Prettier and the licence header on every file
+npm run typecheck   # everything, tests included, against ../reactor/src
+npm test            # unit tests (vitest, two workers)
+npm run build       # lib/
+npm run bench       # Node benches into bench/results/
+npm run size        # bundle sizes against their budgets
+```
+
+Browser benches and end-to-end tests run on the system Chrome, headless:
+
+```bash
+env -u WAYLAND_DISPLAY -u DISPLAY node scripts/bench.mjs --browser
+```
+
+## Credits
+
+Cells was designed after reading [x-spreadsheet](https://github.com/myliang/x-spreadsheet)
+(MIT) and [o-spreadsheet](https://github.com/odoo/o-spreadsheet) (LGPLv3) for
+ideas; no code of either is included. See [THIRD_PARTY.md](THIRD_PARTY.md).
+
+## License
+
+MIT, see [LICENSE](LICENSE).

package/lib/chrome/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * `@datalayer/cells/chrome`: the optional toolbar, formula bar and sheet tabs.
+ *
+ * @module chrome
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/chrome/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/chrome/index.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AAEH,OAAO,EAAE,CAAC"}

package/lib/chrome/index.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2022-2026 Datalayer, Inc.
+ *
+ * MIT License
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/lib/chrome/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/chrome/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/lib/collab/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * `@datalayer/cells/collab`: real-time collaboration over Loro.
+ *
+ * @module collab
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/collab/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collab/index.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AAEH,OAAO,EAAE,CAAC"}

package/lib/collab/index.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2022-2026 Datalayer, Inc.
+ *
+ * MIT License
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/lib/collab/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/collab/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/lib/core/axis.d.ts

@@ -0,0 +1,103 @@
+/**
+ * An axis of a sheet: its rows, or its columns.
+ *
+ * - **Ids.** Every index has a stable id that follows the row through inserts,
+ *   deletes and moves. Ids are materialised only up to the last index ever
+ *   named; beyond, an index has an *implicit* id derived from where the row
+ *   was when the axis was created (`IMPLICIT_BASE + creation index`), so two
+ *   replicas that materialise the same index independently agree on its id.
+ *   Inserted indexes get fresh ids, from `FRESH_BASE` up.
+ * - **Sizes.** Default until the first resize; then a raw `Float64Array` of
+ *   sizes and a Fenwick tree over the effective sizes (0 when hidden), so
+ *   `offsetOf` and `indexAt` are O(log n) and a resize is O(log n). An insert
+ *   or delete rebuilds the tree from the edit point only.
+ * - **Hidden** is a bitset beside the sizes: a hidden index keeps its size for
+ *   unhide and contributes 0 to offsets.
+ *
+ * @module core/axis
+ */
+/** Implicit ids are `IMPLICIT_BASE + creation index`. */
+export declare const IMPLICIT_BASE = 0;
+/** Fresh ids (inserted indexes) start here, above any creation index. */
+export declare const FRESH_BASE: number;
+/** The state of a run of indexes, as patches carry it. */
+export interface AxisSegment {
+    readonly ids: Int32Array;
+    /** `null`: every size is the default. */
+    readonly sizes: Float64Array | null;
+    /** `null`: none is hidden; else 1 per hidden index. */
+    readonly hidden: Uint8Array | null;
+}
+export interface AxisOptions {
+    /** The logical number of indexes (1,048,576 rows, 16,384 columns in Excel). */
+    readonly count: number;
+    /** The size of an index nobody resized, in CSS px. */
+    readonly defaultSize: number;
+}
+export declare class Axis {
+    #private;
+    readonly count: number;
+    readonly defaultSize: number;
+    constructor(options: AxisOptions);
+    /** The id of an index, materialised or implicit. */
+    idAt(index: number): number;
+    /**
+     * Materialise ids up to `index` inclusive and return its id. Anything that
+     * names an index (content, a size, a merge corner, a reference) calls this
+     * first, so no implicit id is ever referenced.
+     */
+    materialize(index: number): number;
+    /** How many ids are materialised. */
+    get materialized(): number;
+    /** `n` fresh ids, for the indexes an insert creates. Never reused. */
+    freshIds(n: number): Int32Array;
+    /** The index of an id, or -1. O(n) over the materialised ids; for the binding, not the hot path. */
+    indexOfId(id: number): number;
+    /** A copy of the materialised ids, for snapshots and the file format. */
+    ids(): Int32Array;
+    /** The state of `n` indexes from `at`: ids, sizes and hidden flags, for patches. */
+    segment(at: number, n: number): AxisSegment;
+    /**
+     * Insert `n` indexes before `at`. The count stays: the last `n` indexes fall
+     * off the end (the command checks they are empty), and come back as
+     * `dropped`. With `segment`, the inserted indexes take its ids, sizes and
+     * hidden flags (undo, redo, remote inserts); without, fresh ids and the
+     * default size.
+     */
+    insert(at: number, n: number, segment?: AxisSegment): {
+        inserted: AxisSegment;
+        dropped: AxisSegment;
+    };
+    /**
+     * Delete `n` indexes from `at`; returns them. New indexes appear at the end:
+     * implicit ones, or `tail`'s when given (undoing an insert brings back the
+     * indexes it pushed off).
+     */
+    delete(at: number, n: number, tail?: AxisSegment): AxisSegment;
+    /**
+     * Move `n` indexes from `at` to before `to` (an index in the coordinates
+     * before the move, outside `[at, at + n]`). Ids, sizes and hidden flags travel.
+     */
+    move(at: number, n: number, to: number): void;
+    /** Set sizes and hidden flags of `n` indexes from `at` at once (patches). */
+    setSegmentSizes(at: number, sizes: Float64Array | null, hidden: Uint8Array | null, n: number): void;
+    /** The size of an index as set, hidden or not. */
+    sizeOf(index: number): number;
+    /** The size an index takes on screen: 0 when hidden. */
+    effectiveSizeOf(index: number): number;
+    /** Set the size of an index. O(log n). */
+    resize(index: number, size: number): void;
+    /** Whether any size was ever set (else every size is the default and nothing is hidden). */
+    get customized(): boolean;
+    /** Whether any index is hidden. */
+    get hasHidden(): boolean;
+    isHidden(index: number): boolean;
+    setHidden(index: number, hidden: boolean): void;
+    /** The offset of an index's start: the sum of the effective sizes before it. O(log n). */
+    offsetOf(index: number): number;
+    /** The total extent of the axis. */
+    get extent(): number;
+    /** The index under an offset: the last index whose start is at or before it. O(log n). */
+    indexAt(offset: number): number;
+}
+//# sourceMappingURL=axis.d.ts.map

package/lib/core/axis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"axis.d.ts","sourceRoot":"","sources":["../../src/core/axis.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;GAiBG;AAEH,yDAAyD;AACzD,eAAO,MAAM,aAAa,IAAI,CAAC;AAC/B,yEAAyE;AACzE,eAAO,MAAM,UAAU,QAAU,CAAC;AAElC,0DAA0D;AAC1D,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;IACzB,yCAAyC;IACzC,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;IACpC,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,qBAAa,IAAI;;IACf,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;gBAcjB,OAAO,EAAE,WAAW;IAehC,oDAAoD;IACpD,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAM3B;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAalC,qCAAqC;IACrC,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,sEAAsE;IACtE,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU;IAoB/B,oGAAoG;IACpG,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAS7B,yEAAyE;IACzE,GAAG,IAAI,UAAU;IAMjB,oFAAoF;IACpF,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,WAAW;IAY3C;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,CAAC,EAAE,MAAM,EACT,OAAO,CAAC,EAAE,WAAW,GACpB;QAAE,QAAQ,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE;IAsClD;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW;IAmC9D;;;OAGG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI;IAgC7C,6EAA6E;IAC7E,eAAe,CACb,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,YAAY,GAAG,IAAI,EAC1B,MAAM,EAAE,UAAU,GAAG,IAAI,EACzB,CAAC,EAAE,MAAM,GACR,IAAI;IAeP,kDAAkD;IAClD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAK7B,wDAAwD;IACxD,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAItC,0CAA0C;IAC1C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAWzC,4FAA4F;IAC5F,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,mCAAmC;IACnC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAMhC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAU/C,0FAA0F;IAC1F,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAU/B,oCAAoC;IACpC,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,0FAA0F;IAC1F,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CA+FhC"}