@dxos/plugin-sheet 0.8.4-main.1da679c → 0.8.4-main.21d9917

package/src/types/Sheet.ts

@@ -0,0 +1,106 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { addressFromA1Notation, isFormula } from '@dxos/compute';
+import { Obj, Type } from '@dxos/echo';
+import { FormInputAnnotation } from '@dxos/echo/internal';
+
+import { addressToIndex, initialize, mapFormulaRefsToIndices } from './util';
+
+export type SheetSize = {
+  rows: number;
+  columns: number;
+};
+
+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: Schema.Any,
+});
+
+export type CellValue = Schema.Schema.Type<typeof CellValue>;
+
+// TODO(burdon): IMPORTANT: Reconcile with Field definition.
+export const Range = Schema.Struct({
+  range: Schema.String,
+  key: Schema.String,
+  value: Schema.String,
+});
+
+export type Range = Schema.Schema.Type<typeof Range>;
+
+// TODO(burdon): Visibility, locked, frozen, etc.
+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 const Sheet = Schema.Struct({
+  name: Schema.optional(Schema.String),
+
+  // Sparse map of cells referenced by index.
+  cells: Schema.Record({ key: Schema.String, value: Schema.mutable(CellValue) }).pipe(
+    Schema.mutable,
+    FormInputAnnotation.set(false),
+  ),
+
+  // Ordered row indices.
+  rows: Schema.Array(Schema.String).pipe(Schema.mutable, FormInputAnnotation.set(false)),
+
+  // Ordered column indices.
+  columns: Schema.Array(Schema.String).pipe(Schema.mutable, FormInputAnnotation.set(false)),
+
+  // Row metadata referenced by index.
+  rowMeta: Schema.Record({ key: Schema.String, value: Schema.mutable(RowColumnMeta) }).pipe(
+    Schema.mutable,
+    FormInputAnnotation.set(false),
+  ),
+
+  // Column metadata referenced by index.
+  columnMeta: Schema.Record({ key: Schema.String, value: Schema.mutable(RowColumnMeta) }).pipe(
+    Schema.mutable,
+    FormInputAnnotation.set(false),
+  ),
+
+  // Cell formatting referenced by indexed range.
+  ranges: Schema.Array(Range).pipe(Schema.mutable, FormInputAnnotation.set(false)),
+}).pipe(
+  Type.object({
+    typename: 'dxos.org/type/Sheet',
+    version: '0.1.0',
+  }),
+);
+
+export interface Sheet extends Schema.Schema.Type<typeof Sheet> {}
+
+export type SheetProps = {
+  name?: string;
+  cells?: Record<string, CellValue>;
+} & Partial<SheetSize>;
+
+export const make = ({ name, cells = {}, ...size }: SheetProps = {}) => {
+  const sheet = Obj.make(Sheet, { name, cells: {}, rows: [], columns: [], rowMeta: {}, columnMeta: {}, ranges: [] });
+
+  // Initialize and set cells within Obj.change to satisfy change context requirements.
+  Obj.change(sheet, () => {
+    initialize(sheet, size);
+
+    if (cells) {
+      Object.entries(cells).forEach(([key, { value }]) => {
+        const idx = addressToIndex(sheet, addressFromA1Notation(key));
+        if (isFormula(value)) {
+          value = mapFormulaRefsToIndices(sheet, value);
+        }
+
+        sheet.cells[idx] = { value };
+      });
+    }
+  });
+
+  return sheet;
+};

package/src/types/capabilities.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+import { type ComputeGraphRegistry } from '@dxos/compute';
+
+import { meta } from '../meta';
+
+export namespace SheetCapabilities {
+  export const ComputeGraphRegistry = Capability.make<ComputeGraphRegistry>(
+    `${meta.id}/capability/compute-graph-registry`,
+  );
+}

package/src/types/index.ts

@@ -2,7 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './schema';
+export * from './capabilities';
+export * as Sheet from './Sheet';
 export * from './sheet-range-types';
 export * from './types';
 export * from './util';

package/src/types/sheet-range-types.ts

@@ -4,7 +4,7 @@
 
 import { type ClassNameValue } from '@dxos/react-ui';
 
-import { type SheetType } from '../types';
+import { type Sheet } from '../types';
 
 export const alignKey = 'alignment';
 export type AlignKey = typeof alignKey;
@@ -19,7 +19,7 @@ export type StyleKey = typeof styleKey;
 export type StyleValue = 'highlight' | 'softwrap';
 
 // TODO(burdon): Reconcile with plugin-table.
-export const cellClassNameForRange = ({ key, value }: SheetType['ranges'][number]): ClassNameValue => {
+export const cellClassNameForRange = ({ key, value }: Sheet.Sheet['ranges'][number]): ClassNameValue => {
   switch (key) {
     case alignKey:
       switch (value) {

package/src/types/types.ts

@@ -2,67 +2,101 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
-import { SHEET_PLUGIN } from '../meta';
-import { SheetModel } from '../model';
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/operation';
+import { SpaceSchema } from '@dxos/react-client/echo';
+import { Collection } from '@dxos/schema';
 
-import { type CellValue, RowColumnMeta, SheetType } from './schema';
+import { meta } from '../meta';
 
-export type SheetSize = {
-  rows: number;
-  columns: number;
-};
+import * as Sheet from './Sheet';
 
-export type CreateSheetOptions = {
-  name?: string;
-  cells?: Record<string, CellValue>;
-} & Partial<SheetSize>;
+// TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
+const ActionAxis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
 
 export namespace SheetAction {
-  const SHEET_ACTION = `${SHEET_PLUGIN}/action`;
-
-  export class Create extends Schema.TaggedClass<Create>()(`${SHEET_ACTION}/create`, {
-    input: Schema.Struct({
-      name: Schema.optional(Schema.String),
-    }),
-    output: Schema.Struct({
-      object: SheetType,
-    }),
-  }) {}
-
-  // TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
-  const Axis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
-
-  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: Schema.Number,
-      count: Schema.optional(Schema.Number),
-    }),
-    output: Schema.Void,
-  }) {}
-
   export const RestoreAxis = Schema.Struct({
-    axis: Axis,
+    axis: ActionAxis,
     axisIndex: Schema.String,
     index: Schema.Number,
-    axisMeta: RowColumnMeta,
+    axisMeta: Sheet.RowColumnMeta,
     values: Schema.Array(Schema.Any),
   });
 
   export type RestoreAxis = Schema.Schema.Type<typeof RestoreAxis>;
+}
+
+const SHEET_OPERATION = `${meta.id}/operation`;
+
+// TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
+const Axis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
+
+export namespace SheetOperation {
+  export const OnCreateSpace = Operation.make({
+    meta: { key: `${SHEET_OPERATION}/on-create-space`, name: 'On Create Space' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        space: SpaceSchema,
+        rootCollection: Collection.Collection,
+        isDefault: Schema.optional(Schema.Boolean),
+      }),
+      output: Schema.Void,
+    },
+  });
 
-  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: Schema.String,
-      deletionData: Schema.optional(RestoreAxis),
-    }),
-    output: Schema.Void,
-  }) {}
+  export const InsertAxis = Operation.make({
+    meta: { key: `${SHEET_OPERATION}/axis-insert`, name: 'Insert Axis' },
+    schema: {
+      input: Schema.Struct({
+        model: Schema.Any,
+        axis: Axis,
+        index: Schema.Number,
+        count: Schema.optional(Schema.Number),
+      }),
+      output: Schema.Void,
+    },
+  });
+
+  export const DropAxisOutput = Schema.Struct({
+    axis: Axis.annotations({ description: 'The axis type (row or col).' }),
+    axisIndex: Schema.String.annotations({ description: 'The dropped axis index.' }),
+    index: Schema.Number.annotations({ description: 'The position the axis was at.' }),
+    axisMeta: Schema.Any.annotations({ description: 'The row/column metadata.' }),
+    values: Schema.Array(Schema.Any).annotations({ description: 'The cell values that were dropped.' }),
+  });
+
+  export type DropAxisOutput = Schema.Schema.Type<typeof DropAxisOutput>;
+
+  export const DropAxis = Operation.make({
+    meta: { key: `${SHEET_OPERATION}/axis-drop`, name: 'Drop Axis' },
+    schema: {
+      input: Schema.Struct({
+        model: Schema.Any,
+        axis: Axis,
+        axisIndex: Schema.String,
+      }),
+      output: DropAxisOutput,
+    },
+  });
+
+  /**
+   * Restore a dropped axis (inverse of DropAxis).
+   */
+  export const RestoreAxis = Operation.make({
+    meta: { key: `${SHEET_OPERATION}/restore-axis`, name: 'Restore Axis' },
+    schema: {
+      input: Schema.Struct({
+        model: Schema.Any.annotations({ description: 'The sheet model.' }),
+        axis: Axis.annotations({ description: 'The axis type (row or col).' }),
+        axisIndex: Schema.String.annotations({ description: 'The axis index to restore.' }),
+        index: Schema.Number.annotations({ description: 'The position to restore at.' }),
+        axisMeta: Schema.Any.annotations({ description: 'The row/column metadata.' }),
+        values: Schema.Array(Schema.Any).annotations({ description: 'The cell values to restore.' }),
+      }),
+      output: Schema.Void,
+    },
+  });
 }

package/src/types/util.ts

@@ -11,10 +11,9 @@ import {
   isFormula,
 } from '@dxos/compute';
 import { randomBytes } from '@dxos/crypto';
-import { Obj } from '@dxos/echo';
 import { invariant } from '@dxos/invariant';
 
-import { type CreateSheetOptions, type SheetSize, SheetType } from '../types';
+import { type Sheet } from '../types';
 
 export const MAX_ROWS = 500;
 export const MAX_COLS = 676; // 26^2;
@@ -56,8 +55,8 @@ export const insertIndices = (indices: string[], i: number, n: number, max: numb
 };
 
 export const initialize = (
-  sheet: SheetType,
-  { rows = DEFAULT_ROWS, columns = DEFAULT_COLS }: Partial<SheetSize> = {},
+  sheet: Sheet.Sheet,
+  { rows = DEFAULT_ROWS, columns = DEFAULT_COLS }: Partial<Sheet.SheetSize> = {},
 ) => {
   if (!sheet.rows.length) {
     insertIndices(sheet.rows, 0, rows, MAX_ROWS);
@@ -67,44 +66,17 @@ export const initialize = (
   }
 };
 
-export const createSheet = ({ name, cells, ...size }: CreateSheetOptions = {}): SheetType => {
-  const sheet = Obj.make(SheetType, {
-    name,
-    cells: {},
-    rows: [],
-    columns: [],
-    rowMeta: {},
-    columnMeta: {},
-    ranges: [],
-  });
-
-  initialize(sheet, size);
-
-  if (cells) {
-    Object.entries(cells).forEach(([key, { value }]) => {
-      const idx = addressToIndex(sheet, addressFromA1Notation(key));
-      if (isFormula(value)) {
-        value = mapFormulaRefsToIndices(sheet, value);
-      }
-
-      sheet.cells[idx] = { value };
-    });
-  }
-
-  return sheet;
-};
-
 /**
  * E.g., "A1" => "CA2@CB3".
  */
-export const addressToIndex = (sheet: SheetType, cell: CellAddress): string => {
+export const addressToIndex = (sheet: Sheet.Sheet, cell: CellAddress): string => {
   return `${sheet.columns[cell.col]}@${sheet.rows[cell.row]}`;
 };
 
 /**
  * E.g., "CA2@CB3" => "A1".
  */
-export const addressFromIndex = (sheet: SheetType, idx: string): CellAddress => {
+export const addressFromIndex = (sheet: Sheet.Sheet, idx: string): CellAddress => {
   const [column, row] = idx.split('@');
   return {
     col: sheet.columns.indexOf(column),
@@ -115,14 +87,14 @@ export const addressFromIndex = (sheet: SheetType, idx: string): CellAddress =>
 /**
  * E.g., "A1:B2" => "CA2@CB3:CC4@CD5".
  */
-export const rangeToIndex = (sheet: SheetType, range: CellRange): string => {
+export const rangeToIndex = (sheet: Sheet.Sheet, range: CellRange): string => {
   return [range.from, range.to ?? range.from].map((cell) => addressToIndex(sheet, cell)).join(':');
 };
 
 /**
  * E.g., "CA2@CB3:CC4@CD5" => "A1:B2".
  */
-export const rangeFromIndex = (sheet: SheetType, idx: string): CompleteCellRange => {
+export const rangeFromIndex = (sheet: Sheet.Sheet, idx: string): CompleteCellRange => {
   const [from, to] = idx.split(':').map((index) => addressFromIndex(sheet, index));
   return { from, to };
 };
@@ -131,7 +103,7 @@ export const rangeFromIndex = (sheet: SheetType, idx: string): CompleteCellRange
  * Compares the positions of two cell indexes in a sheet.
  * Sorts primarily by row, then by column if rows are equal.
  */
-export const compareIndexPositions = (sheet: SheetType, indexA: string, indexB: string): number => {
+export const compareIndexPositions = (sheet: Sheet.Sheet, indexA: string, indexB: string): number => {
   const { row: rowA, col: columnA } = addressFromIndex(sheet, indexA);
   const { row: rowB, col: columnB } = addressFromIndex(sheet, indexB);
 
@@ -148,7 +120,7 @@ export const compareIndexPositions = (sheet: SheetType, indexA: string, indexB:
 /**
  * Map from A1 notation to indices.
  */
-export const mapFormulaRefsToIndices = (sheet: SheetType, formula: string): string => {
+export const mapFormulaRefsToIndices = (sheet: Sheet.Sheet, formula: string): string => {
   invariant(isFormula(formula));
   return formula.replace(/([a-zA-Z]+)([0-9]+)/g, (match) => {
     return addressToIndex(sheet, addressFromA1Notation(match));
@@ -158,7 +130,7 @@ export const mapFormulaRefsToIndices = (sheet: SheetType, formula: string): stri
 /**
  * Map from indices to A1 notation.
  */
-export const mapFormulaIndicesToRefs = (sheet: SheetType, formula: string): string => {
+export const mapFormulaIndicesToRefs = (sheet: Sheet.Sheet, formula: string): string => {
   invariant(isFormula(formula));
   return formula.replace(/([a-zA-Z0-9]+)@([a-zA-Z0-9]+)/g, (idx) => {
     return addressToA1Notation(addressFromIndex(sheet, idx));