@dxos/plugin-sheet 0.8.3 → 0.8.4-main.1068cf700f

package/src/types/types.ts

@@ -2,66 +2,101 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
-import { type CellValue, RowColumnMeta, SheetType } from './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';
 
-export type SheetSize = {
-  rows: number;
-  columns: number;
-};
+import { meta } from '../meta';
 
-export type CreateSheetOptions = {
-  name?: string;
-  cells?: Record<string, CellValue>;
-} & Partial<SheetSize>;
+import * as Sheet from './Sheet';
 
-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,
-  }) {}
+// 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 {
   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 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 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 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

@@ -3,18 +3,18 @@
 //
 
 import {
-  addressFromA1Notation,
-  addressToA1Notation,
-  isFormula,
   type CellAddress,
   type CellRange,
   type CompleteCellRange,
+  addressFromA1Notation,
+  addressToA1Notation,
+  isFormula,
 } from '@dxos/compute';
 import { randomBytes } from '@dxos/crypto';
-import { Obj } from '@dxos/echo';
+import { type 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 +56,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: Obj.Mutable<Sheet.Sheet>,
+  { rows = DEFAULT_ROWS, columns = DEFAULT_COLS }: Partial<Sheet.SheetSize> = {},
 ) => {
   if (!sheet.rows.length) {
     insertIndices(sheet.rows, 0, rows, MAX_ROWS);
@@ -67,44 +67,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 +88,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 +104,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 +121,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 +131,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));

package/dist/lib/browser/SheetContainer-BDZXBB5U.mjs

@@ -1,351 +0,0 @@
-import {
-  GridSheet,
-  SheetProvider,
-  useComputeGraph,
-  useSheetContext
-} from "./chunk-5TA43LO4.mjs";
-import {
-  alignKey,
-  mapFormulaIndicesToRefs,
-  rangeFromIndex,
-  rangeToIndex
-} from "./chunk-I7FZ4TWJ.mjs";
-import "./chunk-FJRLDX7Z.mjs";
-import {
-  SHEET_PLUGIN
-} from "./chunk-D3G4UGEK.mjs";
-
-// packages/plugins/plugin-sheet/src/components/SheetContainer/SheetContainer.tsx
-import { useSignals as _useSignals4 } from "@preact-signals/safe-react/tracking";
-import React3 from "react";
-import { fullyQualifiedId } from "@dxos/react-client/echo";
-import { StackItem } from "@dxos/react-ui-stack";
-
-// packages/plugins/plugin-sheet/src/components/FunctionEditor/FunctionEditor.tsx
-import { useSignals as _useSignals } from "@preact-signals/safe-react/tracking";
-import React from "react";
-import { addressToA1Notation, isFormula, rangeToA1Notation } from "@dxos/compute";
-import { Icon } from "@dxos/react-ui";
-var FunctionEditor = () => {
-  var _effect = _useSignals();
-  try {
-    const { model, cursor, range } = useSheetContext();
-    let value;
-    let formula = false;
-    if (cursor) {
-      value = model.getCellValue(cursor);
-      if (isFormula(value)) {
-        value = model.graph.mapFunctionBindingFromId(mapFormulaIndicesToRefs(model.sheet, value));
-        formula = true;
-      } else if (value != null) {
-        value = String(value);
-      }
-    }
-    return /* @__PURE__ */ React.createElement("div", {
-      className: "flex shrink-0 justify-between items-center px-4 py-1 text-sm bg-toolbarSurface border-bs !border-subduedSeparator"
-    }, /* @__PURE__ */ React.createElement("div", {
-      className: "flex gap-4 items-center"
-    }, /* @__PURE__ */ React.createElement("div", {
-      className: "flex w-16 items-center font-mono"
-    }, range && rangeToA1Notation(range) || cursor && addressToA1Notation(cursor)), /* @__PURE__ */ React.createElement("div", {
-      className: "flex gap-2 items-center"
-    }, /* @__PURE__ */ React.createElement(Icon, {
-      icon: "ph--function--regular",
-      classNames: [
-        "text-greenText",
-        formula ? "visible" : "invisible"
-      ]
-    }), /* @__PURE__ */ React.createElement("span", {
-      className: "font-mono"
-    }, value))));
-  } finally {
-    _effect.f();
-  }
-};
-
-// packages/plugins/plugin-sheet/src/components/SheetToolbar/SheetToolbar.tsx
-import { useSignals as _useSignals3 } from "@preact-signals/safe-react/tracking";
-import { Rx } from "@effect-rx/rx-react";
-import React2, { useMemo as useMemo2 } from "react";
-import { useAppGraph } from "@dxos/app-framework";
-import { createGapSeparator, MenuProvider, rxFromSignal, ToolbarMenu, useMenuActions } from "@dxos/react-ui-menu";
-
-// packages/plugins/plugin-sheet/src/components/SheetToolbar/align.ts
-import { useSignals as _useSignals2 } from "@preact-signals/safe-react/tracking";
-import { useEffect } from "react";
-import { inRange } from "@dxos/compute";
-import { createMenuAction, createMenuItemGroup } from "@dxos/react-ui-menu";
-var aligns = {
-  start: "ph--text-align-left--regular",
-  center: "ph--text-align-center--regular",
-  end: "ph--text-align-right--regular"
-};
-var useAlignState = (state) => {
-  var _effect = _useSignals2();
-  try {
-    const { cursor, model } = useSheetContext();
-    useEffect(() => {
-      state[alignKey] = cursor ? model.sheet.ranges?.findLast(({ range, key }) => key === alignKey && inRange(rangeFromIndex(model.sheet, range), cursor))?.value : void 0;
-    }, [
-      cursor,
-      model.sheet
-    ]);
-  } finally {
-    _effect.f();
-  }
-};
-var createAlignGroupAction = (value) => createMenuItemGroup("align", {
-  label: [
-    "align label",
-    {
-      ns: SHEET_PLUGIN
-    }
-  ],
-  variant: "toggleGroup",
-  selectCardinality: "single",
-  value: `${alignKey}--${value}`
-});
-var createAlignActions = (model, state, cursorFallbackRange) => Object.entries(aligns).map(([alignValue, icon]) => {
-  return createMenuAction(`${alignKey}--${alignValue}`, () => {
-    if (!cursorFallbackRange) {
-      return;
-    }
-    const index = model.sheet.ranges?.findIndex((range) => range.key === alignKey && inRange(rangeFromIndex(model.sheet, range.range), cursorFallbackRange.from)) ?? -1;
-    const nextRangeEntity = {
-      range: rangeToIndex(model.sheet, cursorFallbackRange),
-      key: alignKey,
-      value: alignValue
-    };
-    if (index < 0) {
-      model.sheet.ranges?.push(nextRangeEntity);
-      state[alignKey] = nextRangeEntity.value;
-    } else if (model.sheet.ranges[index].value === nextRangeEntity.value) {
-      model.sheet.ranges?.splice(index, 1);
-      state[alignKey] = void 0;
-    } else {
-      model.sheet.ranges?.splice(index, 1, nextRangeEntity);
-      state[alignKey] = nextRangeEntity.value;
-    }
-  }, {
-    key: alignKey,
-    value: alignValue,
-    checked: state[alignKey] === alignValue,
-    label: [
-      `range value ${alignValue} label`,
-      {
-        ns: SHEET_PLUGIN
-      }
-    ],
-    icon,
-    testId: `grid.toolbar.${alignKey}.${alignValue}`
-  });
-});
-var createAlign = (model, state, cursorFallbackRange) => {
-  const alignGroup = createAlignGroupAction(state[alignKey]);
-  const alignActions = createAlignActions(model, state, cursorFallbackRange);
-  return {
-    nodes: [
-      alignGroup,
-      ...alignActions
-    ],
-    edges: [
-      {
-        source: "root",
-        target: "align"
-      },
-      ...alignActions.map(({ id }) => ({
-        source: alignGroup.id,
-        target: id
-      }))
-    ]
-  };
-};
-
-// packages/plugins/plugin-sheet/src/components/SheetToolbar/style.ts
-import { useEffect as useEffect2 } from "react";
-import { inRange as inRange2 } from "@dxos/compute";
-import { createMenuAction as createMenuAction2, createMenuItemGroup as createMenuItemGroup2 } from "@dxos/react-ui-menu";
-var styles = {
-  highlight: "ph--highlighter--regular",
-  softwrap: "ph--paragraph--regular"
-};
-var useStyleState = (state) => {
-  const { cursorFallbackRange, model } = useSheetContext();
-  useEffect2(() => {
-    state.highlight = false;
-    state.softwrap = false;
-    if (cursorFallbackRange && model.sheet.ranges) {
-      model.sheet.ranges.filter(({ range, key }) => key === "style" && inRange2(rangeFromIndex(model.sheet, range), cursorFallbackRange.from)).forEach(({ value }) => {
-        state[value] = true;
-      });
-    }
-  }, [
-    cursorFallbackRange,
-    model.sheet
-  ]);
-};
-var createStyleGroup = (state) => {
-  return createMenuItemGroup2("style", {
-    variant: "toggleGroup",
-    selectCardinality: "multiple",
-    value: Object.keys(styles).filter((key) => !!state[key]).map((styleValue) => `style--${styleValue}`)
-  });
-};
-var createStyleActions = (model, state, cursorFallbackRange) => Object.entries(styles).map(([styleValue, icon]) => {
-  return createMenuAction2(`style--${styleValue}`, () => {
-    if (!cursorFallbackRange) {
-      return;
-    }
-    const index = model.sheet.ranges?.findIndex((range) => range.key === "style" && inRange2(rangeFromIndex(model.sheet, range.range), cursorFallbackRange.from)) ?? -1;
-    const nextRangeEntity = {
-      range: rangeToIndex(model.sheet, cursorFallbackRange),
-      key: "style",
-      value: styleValue
-    };
-    if (model.sheet.ranges.filter(({ range, key: rangeKey }) => rangeKey === "style" && inRange2(rangeFromIndex(model.sheet, range), cursorFallbackRange.from)).some(({ value: rangeValue }) => rangeValue === styleValue)) {
-      if (index >= 0) {
-        model.sheet.ranges?.splice(index, 1);
-      }
-      state[nextRangeEntity.value] = false;
-    } else {
-      model.sheet.ranges?.push(nextRangeEntity);
-      state[nextRangeEntity.value] = true;
-    }
-  }, {
-    key: "style",
-    value: styleValue,
-    icon,
-    label: [
-      `range value ${styleValue} label`,
-      {
-        ns: SHEET_PLUGIN
-      }
-    ],
-    checked: !!state[styleValue]
-  });
-});
-var createStyle = (model, state, cursorFallbackRange) => {
-  const styleGroupAction = createStyleGroup(state);
-  const styleActions = createStyleActions(model, state, cursorFallbackRange);
-  return {
-    nodes: [
-      styleGroupAction,
-      ...styleActions
-    ],
-    edges: [
-      {
-        source: "root",
-        target: "style"
-      },
-      ...styleActions.map(({ id }) => ({
-        source: styleGroupAction.id,
-        target: id
-      }))
-    ]
-  };
-};
-
-// packages/plugins/plugin-sheet/src/components/SheetToolbar/useToolbarState.ts
-import { useMemo } from "react";
-import { live } from "@dxos/live-object";
-var useToolbarState = (initialState = {}) => {
-  return useMemo(() => live(initialState), []);
-};
-
-// packages/plugins/plugin-sheet/src/components/SheetToolbar/SheetToolbar.tsx
-var createToolbarActions = (model, state, cursorFallbackRange, customActions) => {
-  return Rx.make((get) => {
-    const align = get(rxFromSignal(() => createAlign(model, state, cursorFallbackRange)));
-    const style = get(rxFromSignal(() => createStyle(model, state, cursorFallbackRange)));
-    const gap = createGapSeparator();
-    const nodes = [
-      ...align.nodes,
-      ...style.nodes,
-      ...gap.nodes
-    ];
-    const edges = [
-      ...align.edges,
-      ...style.edges,
-      ...gap.edges
-    ];
-    if (customActions) {
-      const custom = get(customActions);
-      nodes.push(...custom.nodes);
-      edges.push(...custom.edges);
-    }
-    return {
-      nodes,
-      edges
-    };
-  });
-};
-var SheetToolbar = ({ id, classNames }) => {
-  var _effect = _useSignals3();
-  try {
-    const { model, cursorFallbackRange } = useSheetContext();
-    const state = useToolbarState({});
-    useAlignState(state);
-    useStyleState(state);
-    const { graph } = useAppGraph();
-    const customActions = useMemo2(() => {
-      return Rx.make((get) => {
-        const actions = get(graph.actions(id));
-        const nodes = actions.filter((action) => action.properties.disposition === "toolbar");
-        return {
-          nodes,
-          edges: nodes.map((node) => ({
-            source: "root",
-            target: node.id
-          }))
-        };
-      });
-    }, [
-      graph
-    ]);
-    const actionsCreator = useMemo2(() => createToolbarActions(model, state, cursorFallbackRange, customActions), [
-      model,
-      state,
-      cursorFallbackRange,
-      customActions
-    ]);
-    const menu = useMenuActions(actionsCreator);
-    return /* @__PURE__ */ React2.createElement(MenuProvider, {
-      ...menu,
-      attendableId: id
-    }, /* @__PURE__ */ React2.createElement(ToolbarMenu, {
-      classNames
-    }));
-  } finally {
-    _effect.f();
-  }
-};
-
-// packages/plugins/plugin-sheet/src/components/SheetContainer/SheetContainer.tsx
-var SheetContainer = ({ space, sheet, role, ignoreAttention }) => {
-  var _effect = _useSignals4();
-  try {
-    const graph = useComputeGraph(space);
-    return graph ? /* @__PURE__ */ React3.createElement(SheetProvider, {
-      sheet,
-      graph,
-      ignoreAttention
-    }, /* @__PURE__ */ React3.createElement(StackItem.Content, {
-      toolbar: true,
-      statusbar: true,
-      ...role === "section" && {
-        classNames: "aspect-video"
-      }
-    }, /* @__PURE__ */ React3.createElement(SheetToolbar, {
-      id: fullyQualifiedId(sheet)
-    }), /* @__PURE__ */ React3.createElement(GridSheet, null), /* @__PURE__ */ React3.createElement(FunctionEditor, null))) : null;
-  } finally {
-    _effect.f();
-  }
-};
-
-// packages/plugins/plugin-sheet/src/components/SheetContainer/index.ts
-var SheetContainer_default = SheetContainer;
-export {
-  SheetContainer_default as default
-};
-//# sourceMappingURL=SheetContainer-BDZXBB5U.mjs.map