@dxos/plugin-sheet 0.8.2-main.f11618f → 0.8.2-staging.42af850

package/src/model/sheet-model.ts

@@ -119,7 +119,7 @@ export class SheetModel extends Resource {
   /**
    * Initialize sheet and engine.
    */
-  protected override async _open() {
+  protected override async _open(): Promise<void> {
     log('initialize', { id: this.id });
     initialize(this._sheet);
 
@@ -145,7 +145,7 @@ export class SheetModel extends Resource {
    * NOTE: This resets the undo history.
    * @deprecated
    */
-  reset() {
+  reset(): void {
     invariant(this._node);
     this._node.graph.hf.clearSheet(this._node.sheetId);
     Object.entries(this._sheet.cells).forEach(([key, { value }]) => {
@@ -173,17 +173,17 @@ export class SheetModel extends Resource {
    * @deprecated
    */
   // TODO(burdon): Remove.
-  recalculate() {
+  recalculate(): void {
     this._node?.graph.hf.rebuildAndRecalculate();
   }
 
-  insertRows(i: number, n = 1) {
+  insertRows(i: number, n = 1): string[] {
     const idx = insertIndices(this._sheet.rows, i, n, MAX_ROWS);
     this.reset();
     return idx;
   }
 
-  insertColumns(i: number, n = 1) {
+  insertColumns(i: number, n = 1): string[] {
     const idx = insertIndices(this._sheet.columns, i, n, MAX_COLS);
     this.reset();
     return idx;
@@ -217,7 +217,7 @@ export class SheetModel extends Resource {
     return { axis: 'col', index, axisIndex: colIndex, axisMeta: this._sheet.rowMeta[colIndex], values };
   }
 
-  restoreRow({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis) {
+  restoreRow({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis): void {
     this._sheet.rows.splice(index, 0, axisIndex);
     values.forEach((value, col) => {
       if (value) {
@@ -230,7 +230,7 @@ export class SheetModel extends Resource {
     this.reset();
   }
 
-  restoreColumn({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis) {
+  restoreColumn({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis): void {
     this._sheet.columns.splice(index, 0, axisIndex);
     values.forEach((value, row) => {
       if (value) {
@@ -251,7 +251,7 @@ export class SheetModel extends Resource {
   /**
    * Clear range of values.
    */
-  clear(range: CellRange) {
+  clear(range: CellRange): void {
     invariant(this._node);
     const topLeft = getTopLeft(range);
     const values = this._iterRange(range, () => null);
@@ -262,7 +262,7 @@ export class SheetModel extends Resource {
     });
   }
 
-  cut(range: CellRange) {
+  cut(range: CellRange): void {
     invariant(this._node);
     this._node.graph.hf.cut(toModelRange(this._node.sheetId, range));
     this._iterRange(range, (cell) => {
@@ -271,12 +271,12 @@ export class SheetModel extends Resource {
     });
   }
 
-  copy(range: CellRange) {
+  copy(range: CellRange): void {
     invariant(this._node);
     this._node.graph.hf.copy(toModelRange(this._node.sheetId, range));
   }
 
-  paste(cell: CellAddress) {
+  paste(cell: CellAddress): void {
     invariant(this._node);
     if (!this._node.graph.hf.isClipboardEmpty()) {
       const changes = this._node.graph.hf.paste(toSimpleCellAddress(this._node.sheetId, cell));
@@ -291,7 +291,7 @@ export class SheetModel extends Resource {
   }
 
   // TODO(burdon): Display undo/redo state.
-  undo() {
+  undo(): void {
     invariant(this._node);
     if (this._node.graph.hf.isThereSomethingToUndo()) {
       this._node.graph.hf.undo();
@@ -299,7 +299,7 @@ export class SheetModel extends Resource {
     }
   }
 
-  redo() {
+  redo(): void {
     invariant(this._node);
     if (this._node.graph.hf.isThereSomethingToRedo()) {
       this._node.graph.hf.redo();
@@ -368,7 +368,7 @@ export class SheetModel extends Resource {
   /**
    * Sets the value, updating the sheet and engine.
    */
-  setValue(cell: CellAddress, value: CellScalarValue) {
+  setValue(cell: CellAddress, value: CellScalarValue): void {
     invariant(this._node);
     if (this._options.readonly) {
       throw new ReadonlyException();
@@ -411,7 +411,7 @@ export class SheetModel extends Resource {
   /**
    * Sets values from a simple map.
    */
-  setValues(values: Record<string, CellValue>) {
+  setValues(values: Record<string, CellValue>): void {
     Object.entries(values).forEach(([key, { value }]) => {
       this.setValue(addressFromA1Notation(key), value);
     });
@@ -441,12 +441,12 @@ export class SheetModel extends Resource {
   }
 
   // TODO(burdon): Delete index.
-  private _deleteIndices(indices: string[], i: number, n: number) {
+  private _deleteIndices(indices: string[], i: number, n: number): void {
     throw new Error('Not implemented');
   }
 
   // TODO(burdon): Move. Cannot use fractional without changing. Switch back to using unique IDs?
-  private _moveIndices(indices: string[], i: number, j: number, n: number) {
+  private _moveIndices(indices: string[], i: number, j: number, n: number): void {
     throw new Error('Not implemented');
   }
 

package/src/sanity.test.ts

@@ -12,7 +12,7 @@ import { describe, test, expect } from 'vitest';
 
 import { Client } from '@dxos/client';
 import { live } from '@dxos/client/echo';
-import { FunctionType } from '@dxos/functions/types';
+import { FunctionType } from '@dxos/functions';
 
 // TODO(burdon): Fix test infrastructure:
 //  - Need docs? esp. needed for config. need pristine example package?

package/src/serializer.ts

@@ -9,8 +9,7 @@ import { SheetType } from './types';
 
 export const serializer: TypedObjectSerializer<SheetType> = {
   serialize: async ({ object }): Promise<string> => {
-    const { threads: _threads, ...sheet } = object;
-    return JSON.stringify(sheet, null, 2);
+    return JSON.stringify(object, null, 2);
   },
 
   deserialize: async ({ content, newId }) => {

package/src/testing/playwright/sheet-manager.ts

@@ -25,21 +25,21 @@ export class SheetManager {
     return this.cellByText('Ready').waitFor({ state: 'visible' });
   }
 
-  async fill(text: string) {
+  async fill(text: string): Promise<void> {
     // TODO(thure): Do these timeouts help with test flakiness?
     await this.page.waitForTimeout(200);
     await this.cellEditor().fill(text);
     await this.page.waitForTimeout(200);
   }
 
-  async press(key: string) {
+  async press(key: string): Promise<void> {
     // TODO(thure): Does these timeouts help with test flakiness?
     await this.page.waitForTimeout(200);
     await this.page.keyboard.press(key);
     await this.page.waitForTimeout(200);
   }
 
-  async commit(key: string) {
+  async commit(key: string): Promise<void> {
     // TODO(thure): Why do we need to wait? Enter is ignored otherwise…
     await this.page.waitForTimeout(500);
     await this.press(key);
@@ -49,7 +49,7 @@ export class SheetManager {
     return this.grid.grid.getByText(text);
   }
 
-  async setFocusedCellValue(text: string, commitKey: string) {
+  async setFocusedCellValue(text: string, commitKey: string): Promise<void> {
     const mode = await this.grid.mode();
     if (mode === 'browse') {
       await this.commit('Enter');
@@ -58,7 +58,7 @@ export class SheetManager {
     await this.commit(commitKey);
   }
 
-  async selectRange(start: DxGridPosition, end: DxGridPosition) {
+  async selectRange(start: DxGridPosition, end: DxGridPosition): Promise<void> {
     const startCell = this.grid.cell(start.col, start.row, start.plane);
     const endCell = this.grid.cell(end.col, end.row, end.plane);
     const startBox = await startCell.boundingBox();
@@ -69,7 +69,7 @@ export class SheetManager {
     });
   }
 
-  async deleteAxis(axis: DxGridAxis, position: number) {
+  async deleteAxis(axis: DxGridAxis, position: number): Promise<void> {
     const col = axis === 'row' ? 0 : position;
     const row = axis === 'row' ? position : 0;
     const plane = axis === 'row' ? 'frozenColsStart' : 'frozenRowsStart';
@@ -77,15 +77,15 @@ export class SheetManager {
     await this.page.getByTestId(`grid.${axis}.drop`).click();
   }
 
-  toolbarAction(key: string, value: string) {
+  toolbarAction(key: string, value: string): Locator {
     return this.page.getByTestId(`grid.toolbar.${key}.${value}`);
   }
 
-  cellEditor() {
+  cellEditor(): Locator {
     return this.page.getByTestId('grid.cell-editor').getByRole('textbox');
   }
 
-  rangeInList(a1Coords: string) {
+  rangeInList(a1Coords: string): Locator {
     return this.page.getByTestId('grid.range-list').getByText(a1Coords);
   }
 }

package/src/types/schema.ts

@@ -2,55 +2,53 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Ref, S, TypedObject } from '@dxos/echo-schema';
-import { ThreadType } from '@dxos/plugin-space/types';
+import { Schema } from 'effect';
 
-export const CellValue = S.Struct({
+import { TypedObject } from '@dxos/echo-schema';
+
+export const CellValue = Schema.Struct({
   // TODO(burdon): How to store dates (datetime, date, time), percentages, etc.
   //  Consider import/export; natural access for other plugins. Special handling for currency (precision).
   // TODO(burdon): Automerge (long string) or short string or number.
-  value: S.Any,
+  value: Schema.Any,
 });
 
-export type CellValue = S.Schema.Type<typeof CellValue>;
+export type CellValue = Schema.Schema.Type<typeof CellValue>;
 
 // TODO(burdon): IMPORTANT: Reconcile with Field definition.
-export const Range = S.Struct({
-  range: S.String,
-  key: S.String,
-  value: S.String,
+export const Range = Schema.Struct({
+  range: Schema.String,
+  key: Schema.String,
+  value: Schema.String,
 });
 
-export type Range = S.Schema.Type<typeof Range>;
+export type Range = Schema.Schema.Type<typeof Range>;
 
 // TODO(burdon): Visibility, locked, frozen, etc.
-export const RowColumnMeta = S.Struct({
-  size: S.optional(S.Number),
+export const RowColumnMeta = Schema.Struct({
+  size: Schema.optional(Schema.Number),
 });
 
 // TODO(burdon): Reconcile col/column (across packages).
 // TODO(burdon): Index to all updates when rows/columns are inserted/deleted.
 export class SheetType extends TypedObject({ typename: 'dxos.org/type/Sheet', version: '0.1.0' })({
-  name: S.optional(S.String),
+  name: Schema.optional(Schema.String),
 
   // Sparse map of cells referenced by index.
-  cells: S.mutable(S.Record({ key: S.String, value: S.mutable(CellValue) })),
+  cells: Schema.mutable(Schema.Record({ key: Schema.String, value: Schema.mutable(CellValue) })),
 
   // Ordered row indices.
-  rows: S.mutable(S.Array(S.String)),
+  rows: Schema.mutable(Schema.Array(Schema.String)),
 
   // Ordered column indices.
-  columns: S.mutable(S.Array(S.String)),
+  columns: Schema.mutable(Schema.Array(Schema.String)),
 
   // Row metadata referenced by index.
-  rowMeta: S.mutable(S.Record({ key: S.String, value: S.mutable(RowColumnMeta) })),
+  rowMeta: Schema.mutable(Schema.Record({ key: Schema.String, value: Schema.mutable(RowColumnMeta) })),
 
   // Column metadata referenced by index.
-  columnMeta: S.mutable(S.Record({ key: S.String, value: S.mutable(RowColumnMeta) })),
+  columnMeta: Schema.mutable(Schema.Record({ key: Schema.String, value: Schema.mutable(RowColumnMeta) })),
 
   // Cell formatting referenced by indexed range.
-  ranges: S.mutable(S.Array(Range)),
-
-  // Threads associated with the sheet
-  threads: S.optional(S.mutable(S.Array(Ref(ThreadType)))),
+  ranges: Schema.mutable(Schema.Array(Range)),
 }) {}

package/src/types/types.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { S } from '@dxos/echo-schema';
+import { Schema } from 'effect';
 
 import { type CellValue, RowColumnMeta, SheetType } from './schema';
 import { SHEET_PLUGIN } from '../meta';
@@ -21,47 +21,47 @@ export type CreateSheetOptions = {
 export namespace SheetAction {
   const SHEET_ACTION = `${SHEET_PLUGIN}/action`;
 
-  export class Create extends S.TaggedClass<Create>()(`${SHEET_ACTION}/create`, {
-    input: S.Struct({
-      name: S.optional(S.String),
+  export class Create extends Schema.TaggedClass<Create>()(`${SHEET_ACTION}/create`, {
+    input: Schema.Struct({
+      name: Schema.optional(Schema.String),
     }),
-    output: S.Struct({
+    output: Schema.Struct({
       object: SheetType,
     }),
   }) {}
 
   // TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
-  const Axis = S.Union(S.Literal('row'), S.Literal('col'));
+  const Axis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
 
-  export class InsertAxis extends S.TaggedClass<InsertAxis>()(`${SHEET_ACTION}/axis-insert`, {
-    input: S.Struct({
-      // TODO(wittjosiah): S.instanceOf(SheetModel) throws when running tests.
-      model: S.Any.pipe(S.filter((model) => model instanceof SheetModel)) as S.Schema<SheetModel>,
+  export class InsertAxis extends Schema.TaggedClass<InsertAxis>()(`${SHEET_ACTION}/axis-insert`, {
+    input: Schema.Struct({
+      // TODO(wittjosiah): Schema.instanceOf(SheetModel) throws when running tests.
+      model: Schema.Any.pipe(Schema.filter((model) => model instanceof SheetModel)) as Schema.Schema<SheetModel>,
       axis: Axis,
-      index: S.Number,
-      count: S.optional(S.Number),
+      index: Schema.Number,
+      count: Schema.optional(Schema.Number),
     }),
-    output: S.Void,
+    output: Schema.Void,
   }) {}
 
-  export const RestoreAxis = S.Struct({
+  export const RestoreAxis = Schema.Struct({
     axis: Axis,
-    axisIndex: S.String,
-    index: S.Number,
+    axisIndex: Schema.String,
+    index: Schema.Number,
     axisMeta: RowColumnMeta,
-    values: S.Array(S.Any),
+    values: Schema.Array(Schema.Any),
   });
 
-  export type RestoreAxis = S.Schema.Type<typeof RestoreAxis>;
+  export type RestoreAxis = Schema.Schema.Type<typeof RestoreAxis>;
 
-  export class DropAxis extends S.TaggedClass<DropAxis>()(`${SHEET_ACTION}/axis-drop`, {
-    input: S.Struct({
-      // TODO(wittjosiah): S.instanceOf(SheetModel) throws when running tests.
-      model: S.Any.pipe(S.filter((model) => model instanceof SheetModel)) as S.Schema<SheetModel>,
+  export class DropAxis extends Schema.TaggedClass<DropAxis>()(`${SHEET_ACTION}/axis-drop`, {
+    input: Schema.Struct({
+      // TODO(wittjosiah): Schema.instanceOf(SheetModel) throws when running tests.
+      model: Schema.Any.pipe(Schema.filter((model) => model instanceof SheetModel)) as Schema.Schema<SheetModel>,
       axis: Axis,
-      axisIndex: S.String,
-      deletionData: S.optional(RestoreAxis),
+      axisIndex: Schema.String,
+      deletionData: Schema.optional(RestoreAxis),
     }),
-    output: S.Void,
+    output: Schema.Void,
   }) {}
 }

package/src/types/util.ts

@@ -76,7 +76,6 @@ export const createSheet = ({ name, cells, ...size }: CreateSheetOptions = {}):
     rowMeta: {},
     columnMeta: {},
     ranges: [],
-    threads: [],
   });
 
   initialize(sheet, size);