@dxos/plugin-sheet 0.8.4-main.c85a9c8dae → 0.8.4-main.d9fc60f731

package/src/types/Sheet.ts

@@ -2,10 +2,12 @@
 // Copyright 2023 DXOS.org
 //
 
+// @import-as-namespace
+
 import * as Schema from 'effect/Schema';
 
-import { addressFromA1Notation, isFormula } from '@dxos/compute';
-import { Obj, Type } from '@dxos/echo';
+import { addressFromA1Notation, isFormula } from '@dxos/compute-hyperformula';
+import { DXN, Annotation, Obj, Type } from '@dxos/echo';
 import { FormInputAnnotation } from '@dxos/echo/internal';
 
 import { addressToIndex, initialize, mapFormulaRefsToIndices } from './util';
@@ -61,13 +63,11 @@ export const Sheet = Schema.Struct({
   // Cell formatting referenced by indexed range.
   ranges: Schema.Array(Range).pipe(FormInputAnnotation.set(false)),
 }).pipe(
-  Type.object({
-    typename: 'dxos.org/type/Sheet',
-    version: '0.1.0',
-  }),
+  Annotation.IconAnnotation.set({ icon: 'ph--grid-nine--regular', hue: 'indigo' }),
+  Type.makeObject(DXN.make('org.dxos.type.sheet', '0.1.0')),
 );
 
-export interface Sheet extends Schema.Schema.Type<typeof Sheet> {}
+export type Sheet = Type.InstanceType<typeof Sheet>;
 
 export type SheetProps = {
   name?: string;
@@ -77,18 +77,18 @@ export type SheetProps = {
 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, (s) => {
-    initialize(s, size);
+  // Initialize and set cells within Obj.update to satisfy change context requirements.
+  Obj.update(sheet, (sheet) => {
+    initialize(sheet, size);
 
     if (cells) {
       Object.entries(cells).forEach(([key, { value }]) => {
-        const idx = addressToIndex(s, addressFromA1Notation(key));
+        const idx = addressToIndex(sheet, addressFromA1Notation(key));
         if (isFormula(value)) {
-          value = mapFormulaRefsToIndices(s, value);
+          value = mapFormulaRefsToIndices(sheet, value);
         }
 
-        s.cells[idx] = { value };
+        sheet.cells[idx] = { value };
       });
     }
   });

package/src/types/SheetCapabilities.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { Capability } from '@dxos/app-framework';
+import { type ComputeGraphRegistry as ComputeGraphRegistryType } from '@dxos/compute-hyperformula';
+import { type DxGridElement, type GridContentProps } from '@dxos/react-ui-grid';
+
+import { meta } from '#meta';
+
+export type GridEntry = { grid: DxGridElement; setActiveRefs: (refs: GridContentProps['activeRefs']) => void };
+
+export type GridRegistry = {
+  register: (attendableId: string, grid: DxGridElement, setActiveRefs: GridEntry['setActiveRefs']) => void;
+  unregister: (attendableId: string) => void;
+  get: (attendableId: string) => GridEntry | undefined;
+};
+
+export const ComputeGraphRegistry = Capability.make<ComputeGraphRegistryType>(
+  `${meta.id}.capability.compute-graph-registry`,
+);
+
+/** Registry of active grid instances keyed by attendable ID. */
+export const GridInstances = Capability.make<GridRegistry>(`${meta.id}.capability.grid-instances`);

package/src/types/SheetOperation.ts

@@ -0,0 +1,84 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+import { DXN } from '@dxos/keys';
+
+import { meta } from '#meta';
+
+const makeKey = (name: string) => DXN.make(`${meta.id}.operation.${name}`);
+
+// TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
+const Axis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
+
+export const InsertAxis = Operation.make({
+  meta: { key: makeKey('axisInsert'), name: 'Insert Axis', icon: 'ph--plus--regular' },
+  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: makeKey('axisDrop'), name: 'Drop Axis', icon: 'ph--trash--regular' },
+  input: Schema.Struct({
+    model: Schema.Any,
+    axis: Axis,
+    axisIndex: Schema.String,
+  }),
+  output: DropAxisOutput,
+});
+
+export const ScrollToAnchor = Operation.make({
+  meta: {
+    key: makeKey('scrollToAnchor'),
+    name: 'Scroll To Anchor',
+    icon: 'ph--anchor-simple--regular',
+  },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    subject: Schema.String.annotations({ description: 'Attendable ID of the sheet.' }),
+    cursor: Schema.String.annotations({ description: 'Cell range coordinates.' }),
+    ref: Schema.optional(Schema.Any.annotations({ description: 'Active refs for highlighting.' })),
+  }),
+  output: Schema.Void,
+});
+
+/**
+ * Restore a dropped axis (inverse of DropAxis).
+ */
+export const RestoreAxis = Operation.make({
+  meta: {
+    key: makeKey('restoreAxis'),
+    name: 'Restore Axis',
+    icon: 'ph--clock-counter-clockwise--regular',
+  },
+  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/index.ts

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

package/src/types/types.ts

@@ -4,13 +4,6 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Capability } from '@dxos/app-framework';
-import { Collection } from '@dxos/echo';
-import { Operation } from '@dxos/operation';
-import { SpaceSchema } from '@dxos/react-client/echo';
-
-import { meta } from '../meta';
-
 import * as Sheet from './Sheet';
 
 // TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
@@ -27,76 +20,3 @@ export namespace SheetAction {
 
   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 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

@@ -9,10 +9,10 @@ import {
   addressFromA1Notation,
   addressToA1Notation,
   isFormula,
-} from '@dxos/compute';
+} from '@dxos/compute-hyperformula';
 import { randomBytes } from '@dxos/crypto';
 import { type Obj } from '@dxos/echo';
-import { invariant } from '@dxos/invariant';
+import { assertArgument } from '@dxos/invariant';
 
 import { type Sheet } from '../types';
 
@@ -122,7 +122,7 @@ export const compareIndexPositions = (sheet: Sheet.Sheet, indexA: string, indexB
  * Map from A1 notation to indices.
  */
 export const mapFormulaRefsToIndices = (sheet: Sheet.Sheet, formula: string): string => {
-  invariant(isFormula(formula));
+  assertArgument(isFormula(formula), 'formula');
   return formula.replace(/([a-zA-Z]+)([0-9]+)/g, (match) => {
     return addressToIndex(sheet, addressFromA1Notation(match));
   });
@@ -132,7 +132,7 @@ export const mapFormulaRefsToIndices = (sheet: Sheet.Sheet, formula: string): st
  * Map from indices to A1 notation.
  */
 export const mapFormulaIndicesToRefs = (sheet: Sheet.Sheet, formula: string): string => {
-  invariant(isFormula(formula));
+  assertArgument(isFormula(formula), 'formula');
   return formula.replace(/([a-zA-Z0-9]+)@([a-zA-Z0-9]+)/g, (idx) => {
     return addressToA1Notation(addressFromIndex(sheet, idx));
   });

package/src/vite-env.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="vite/client" />
+
+//
+// Copyright 2026 DXOS.org
+//
+
+declare module '*.mdl?raw' {
+  const content: string;
+  export default content;
+}

package/dist/lib/browser/RangeList-S3SHV7T6.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/containers/RangeList/RangeList.tsx", "../../../src/containers/RangeList/index.ts"],
-  "sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\nimport React, { useCallback } from 'react';\n\nimport { rangeToA1Notation } from '@dxos/compute';\nimport { Obj } from '@dxos/echo';\nimport { Input, Message, useTranslation } from '@dxos/react-ui';\nimport { List } from '@dxos/react-ui-list';\nimport { ghostHover } from '@dxos/ui-theme';\n\nimport { meta } from '../../meta';\nimport { rangeFromIndex } from '../../types';\nimport { Sheet } from '../../types';\n\nexport type RangeListProps = {\n  sheet: Sheet.Sheet;\n};\n\nexport const RangeList = ({ sheet }: RangeListProps) => {\n  const { t } = useTranslation(meta.id);\n  // TODO(thure): Implement similar to comments, #8121\n  const handleSelectRange = (range: Sheet.Range) => {};\n  const handleDeleteRange = useCallback(\n    (range: Sheet.Range) => {\n      const index = sheet.ranges.findIndex((sheetRange) => sheetRange === range);\n      Obj.change(sheet, (obj) => {\n        obj.ranges.splice(index, 1);\n      });\n    },\n    [sheet],\n  );\n  return (\n    <>\n      <Input.Root>\n        <Input.Label>{t('range list heading')}</Input.Label>\n      </Input.Root>\n      {sheet.ranges.length < 1 ? (\n        <Message.Root>\n          <Message.Title>{t('no ranges message')}</Message.Title>\n        </Message.Root>\n      ) : (\n        <List.Root<Sheet.Range> items={sheet.ranges} isItem={Schema.is(Sheet.Range)}>\n          {({ items: ranges }) =>\n            ranges.map((range, i) => (\n              <List.Item key={i} item={range} classNames={['p-2', ghostHover]}>\n                <List.ItemDragHandle />\n                <List.ItemTitle onClick={() => handleSelectRange(range)}>\n                  {t('range title', {\n                    position: rangeToA1Notation(rangeFromIndex(sheet, range.range)),\n                    key: t(`range key ${range.key} label`),\n                    value: t(`range value ${range.value} label`),\n                  })}\n                </List.ItemTitle>\n                <List.ItemDeleteButton onClick={() => handleDeleteRange(range)} />\n              </List.Item>\n            ))\n          }\n        </List.Root>\n      )}\n    </>\n  );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport { RangeList } from './RangeList';\n\nexport default RangeList;\n"],
-  "mappings": ";;;;;;;AAIA,YAAYA,YAAY;AACxB,OAAOC,SAASC,mBAAmB;AAEnC,SAASC,yBAAyB;AAClC,SAASC,WAAW;AACpB,SAASC,OAAOC,SAASC,sBAAsB;AAC/C,SAASC,YAAY;AACrB,SAASC,kBAAkB;AAUpB,IAAMC,YAAY,CAAC,EAAEC,MAAK,MAAkB;AACjD,QAAM,EAAEC,EAAC,IAAKC,eAAeC,KAAKC,EAAE;AAEpC,QAAMC,oBAAoB,CAACC,UAAAA;EAAwB;AACnD,QAAMC,oBAAoBC,YACxB,CAACF,UAAAA;AACC,UAAMG,QAAQT,MAAMU,OAAOC,UAAU,CAACC,eAAeA,eAAeN,KAAAA;AACpEO,QAAIC,OAAOd,OAAO,CAACe,QAAAA;AACjBA,UAAIL,OAAOM,OAAOP,OAAO,CAAA;IAC3B,CAAA;EACF,GACA;IAACT;GAAM;AAET,SACE,sBAAA,cAAA,MAAA,UAAA,MACE,sBAAA,cAACiB,MAAMC,MAAI,MACT,sBAAA,cAACD,MAAME,OAAK,MAAElB,EAAE,oBAAA,CAAA,CAAA,GAEjBD,MAAMU,OAAOU,SAAS,IACrB,sBAAA,cAACC,QAAQH,MAAI,MACX,sBAAA,cAACG,QAAQC,OAAK,MAAErB,EAAE,mBAAA,CAAA,CAAA,IAGpB,sBAAA,cAACsB,KAAKL,MAAI;IAAcM,OAAOxB,MAAMU;IAAQe,QAAeC,UAAGC,cAAMC,KAAK;KACvE,CAAC,EAAEJ,OAAOd,OAAM,MACfA,OAAOmB,IAAI,CAACvB,OAAOwB,MACjB,sBAAA,cAACP,KAAKQ,MAAI;IAACC,KAAKF;IAAGG,MAAM3B;IAAO4B,YAAY;MAAC;MAAOC;;KAClD,sBAAA,cAACZ,KAAKa,gBAAc,IAAA,GACpB,sBAAA,cAACb,KAAKc,WAAS;IAACC,SAAS,MAAMjC,kBAAkBC,KAAAA;KAC9CL,EAAE,eAAe;IAChBsC,UAAUC,kBAAkBC,eAAezC,OAAOM,MAAMA,KAAK,CAAA;IAC7D0B,KAAK/B,EAAE,aAAaK,MAAM0B,GAAG,QAAQ;IACrCU,OAAOzC,EAAE,eAAeK,MAAMoC,KAAK,QAAQ;EAC7C,CAAA,CAAA,GAEF,sBAAA,cAACnB,KAAKoB,kBAAgB;IAACL,SAAS,MAAM/B,kBAAkBD,KAAAA;;AAQxE;;;AC1DA,IAAA,oBAAesC;",
-  "names": ["Schema", "React", "useCallback", "rangeToA1Notation", "Obj", "Input", "Message", "useTranslation", "List", "ghostHover", "RangeList", "sheet", "t", "useTranslation", "meta", "id", "handleSelectRange", "range", "handleDeleteRange", "useCallback", "index", "ranges", "findIndex", "sheetRange", "Obj", "change", "obj", "splice", "Input", "Root", "Label", "length", "Message", "Title", "List", "items", "isItem", "is", "Sheet", "Range", "map", "i", "Item", "key", "item", "classNames", "ghostHover", "ItemDragHandle", "ItemTitle", "onClick", "position", "rangeToA1Notation", "rangeFromIndex", "value", "ItemDeleteButton", "RangeList"]
-}