@dxos/plugin-sheet 0.6.13-main.ed424a1 → 0.6.13

package/src/graph/compute-graph.test.ts

@@ -1,87 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type CellValue } from 'hyperformula';
-import { afterEach, beforeEach, describe, expect, test } from 'vitest';
-
-import { Trigger } from '@dxos/async';
-import { create, fullyQualifiedId } from '@dxos/client/echo';
-import { FunctionType } from '@dxos/plugin-script/types';
-
-import { DetailedCellError } from '#hyperformula';
-import { TestBuilder } from './testing';
-
-describe('ComputeGraph', () => {
-  let testBuilder: TestBuilder;
-  beforeEach(async () => {
-    testBuilder = new TestBuilder({ types: [FunctionType] });
-    await testBuilder.open();
-  });
-  afterEach(async () => {
-    await testBuilder.close();
-  });
-
-  test('map functions', async () => {
-    const space = await testBuilder.client.spaces.create();
-    const graph = testBuilder.registry.createGraph(space);
-    await graph.open();
-
-    // Create script.
-    const trigger = new Trigger();
-    graph.update.once(() => trigger.wake());
-    const functionObject = space.db.add(create(FunctionType, { version: 1, binding: 'TEST' }));
-    await trigger.wait();
-    const functions = graph.getFunctions({ echo: true });
-    expect(functions).to.toHaveLength(1);
-
-    const id = graph.mapFunctionBindingToId('TEST()');
-    expect(id).to.eq(`${fullyQualifiedId(functionObject)}()`);
-  });
-
-  test('cross-node references', async () => {
-    const space = await testBuilder.client.spaces.create();
-    const graph = testBuilder.registry.createGraph(space);
-
-    // Create nodes.
-    const node1 = await graph.getOrCreateNode('node-1').open();
-    const node2 = await graph.getOrCreateNode('node-2').open();
-    expect(graph.hf.getSheetNames()).to.toHaveLength(2);
-
-    {
-      node1.graph.hf.setCellContents({ sheet: node1.sheetId, row: 0, col: 0 }, [[100, 200, 300, '=SUM(A1:C1)']]);
-      node2.graph.hf.setCellContents({ sheet: node2.sheetId, row: 0, col: 0 }, "='node-1'!D1");
-      const value1 = node1.graph.hf.getCellValue({ sheet: node1.sheetId, col: 3, row: 0 });
-      const value2 = node2.graph.hf.getCellValue({ sheet: node2.sheetId, col: 0, row: 0 });
-      expect(value1).to.eq(value2);
-    }
-
-    // Get updated event.
-    const trigger = new Trigger<CellValue>();
-    node2.update.on(({ change }) => {
-      const value = node2.graph.hf.getCellValue({ sheet: node2.sheetId, col: 0, row: 0 });
-      expect(value).to.eq(change?.newValue);
-      trigger.wake(value);
-    });
-
-    {
-      node1.graph.hf.setCellContents({ sheet: node1.sheetId, row: 0, col: 0 }, 400);
-      const value1 = node1.graph.hf.getCellValue({ sheet: node1.sheetId, col: 3, row: 0 });
-      const value2 = await trigger.wait();
-      expect(value1).to.eq(value2);
-    }
-  });
-
-  // TODO(burdon): Dynamically load node/model based on dependencies.
-  //  - Create dependency then close model.
-  test('dynamic loading', async () => {
-    const space = await testBuilder.client.spaces.create();
-    const graph = testBuilder.registry.createGraph(space);
-
-    const node1 = await graph.getOrCreateNode('node-1').open();
-    node1.graph.hf.setCellContents({ sheet: node1.sheetId, row: 0, col: 0 }, "='node-2'!A1");
-    const value1 = node1.graph.hf.getCellValue({ sheet: node1.sheetId, col: 0, row: 0 });
-    expect(value1).to.be.instanceof(DetailedCellError);
-    expect((value1 as DetailedCellError).type).to.eq('REF');
-  });
-});

package/src/graph/compute-graph.ts

@@ -1,242 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Listeners } from 'hyperformula/typings/Emitter';
-
-import { Event } from '@dxos/async';
-import { type Space, Filter, fullyQualifiedId } from '@dxos/client/echo';
-import { Resource } from '@dxos/context';
-import { getTypename } from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
-import { log } from '@dxos/log';
-import { FunctionType } from '@dxos/plugin-script/types';
-import { nonNullable } from '@dxos/util';
-
-import { ExportedCellChange, type HyperFormula } from '#hyperformula';
-import { ComputeNode } from './compute-node';
-import {
-  defaultFunctions,
-  FunctionContext,
-  type FunctionContextOptions,
-  type FunctionDefinition,
-  EDGE_FUNCTION_NAME,
-} from './functions';
-
-// TODO(wittjosiah): Factor out.
-const OBJECT_ID_LENGTH = 60; // 33 (space id) + 1 (separator) + 26 (object id).
-
-// TODO(burdon): Factory.
-// export type ComputeNodeGenerator = <T>(obj: T) => ComputeNode;
-
-type ObjectRef = { type: string; id: string };
-
-/**
- * Marker for sheets that are managed by an ECHO object.
- * Sheet ID: `dxos.org/type/SheetType@1234`
- */
-export const createSheetName = ({ type, id }: ObjectRef) => `${type}@${id}`;
-export const parseSheetName = (name: string): Partial<ObjectRef> => {
-  const [type, id] = name.split('@');
-  return id ? { type, id } : { id: type };
-};
-
-export type ComputeGraphEvent = 'functionsUpdated';
-
-/**
- * Per-space compute and dependency graph.
- * Consists of multiple ComputeNode (corresponding to a HyperFormula sheet).
- * Manages the set of custom functions.
- * HyperFormula manages the dependency graph.
- */
-export class ComputeGraph extends Resource {
-  public readonly id = `graph-${PublicKey.random().truncate()}`;
-
-  // Map of nodes indexed by sheet number.
-  private readonly _nodes = new Map<number, ComputeNode>();
-
-  // Cached function objects.
-  private _remoteFunctions: FunctionType[] = [];
-
-  public readonly update = new Event<{ type: ComputeGraphEvent }>();
-
-  // The context is passed to all functions.
-  public readonly context = new FunctionContext(this._hf, this._space, this._options);
-
-  constructor(
-    private readonly _hf: HyperFormula,
-    private readonly _space?: Space,
-    private readonly _options?: Partial<FunctionContextOptions>,
-  ) {
-    super();
-    this._hf.updateConfig({ context: this.context });
-    // TODO(burdon): If debounce then aggregate changes.
-    const onValuesUpdate: Listeners['valuesUpdated'] = (changes) => {
-      for (const change of changes) {
-        if (change instanceof ExportedCellChange) {
-          const { sheet } = change;
-          const node = this._nodes.get(sheet);
-          if (node) {
-            node.update.emit({ type: 'valuesUpdated', change });
-          }
-        }
-      }
-    };
-
-    this._hf.on('valuesUpdated', onValuesUpdate);
-    this._ctx.onDispose(() => this._hf.off('valuesUpdated', onValuesUpdate));
-  }
-
-  get hf() {
-    return this._hf;
-  }
-
-  getFunctions(
-    { standard, echo }: { standard?: boolean; echo?: boolean } = { standard: true, echo: true },
-  ): FunctionDefinition[] {
-    return [
-      ...(standard
-        ? this._hf
-            .getRegisteredFunctionNames()
-            .map((name) => defaultFunctions.find((fn) => fn.name === name) ?? { name })
-        : []),
-      ...(echo ? this._remoteFunctions.map((fn) => ({ name: fn.binding! })) : []),
-    ];
-  }
-
-  /**
-   * Get or create cell representing a sheet.
-   */
-  // TODO(burdon): Async (open node).
-  //  The graph should be an extensible factory that plugins extend with model constructors.
-  //  This would enable on-the-fly instantiation of new models when then are referenced.
-  //  E.g., Cross-object reference would be stored as "ObjectId!A1"
-  //  The graph would then load the object and create a ComputeNode (model) of the appropriate type.
-  getOrCreateNode(name: string): ComputeNode {
-    invariant(name.length);
-    if (!this._hf.doesSheetExist(name)) {
-      log.info('created node', { space: this._space?.id, sheet: name });
-      this._hf.addSheet(name);
-    }
-
-    const sheetId = this._hf.getSheetId(name);
-    invariant(sheetId !== undefined);
-
-    const node = new ComputeNode(this, sheetId);
-    this._nodes.set(sheetId, node);
-    return node;
-  }
-
-  /**
-   * Map bound value to custom function invocation.
-   * E.g., "HELLO(...args)" => "EDGE("HELLO", ...args)".
-   */
-  mapFormulaToNative(formula: string): string {
-    return (
-      formula
-        //
-        // Map cross-sheet references by name onto sheet stored by ECHO object/model.
-        // Example: "Test Sheet"!A0 => "dxos.org/type/SheetType@1234"!A0
-        // https://hyperformula.handsontable.com/guide/cell-references.html#cell-references
-        //
-        .replace(/['"]?([ \w]+)['"]?!/, (_match, name) => {
-          if (name) {
-            // TODO(burdon): Cache map.
-            const objects = this._hf
-              .getSheetNames()
-              .map((name) => {
-                const { type, id } = parseSheetName(name);
-                return type && id ? this._space?.db.getObjectById(id) : undefined;
-              })
-              .filter(nonNullable);
-
-            for (const obj of objects) {
-              if (obj.name === name) {
-                const type = getTypename(obj)!;
-                // NOTE: Names must be single quoted.
-                return `'${createSheetName({ type, id: obj.id })}'!`;
-              }
-            }
-          }
-
-          return `${name}!`;
-        })
-
-        //
-        // Map remote function references (i.e., to remote DX function invocation).
-        //
-        .replace(/(\w+)\((.*)\)/g, (match, binding, args) => {
-          const fn = this._remoteFunctions.find((fn) => fn.binding === binding);
-          if (!fn) {
-            return match;
-          }
-
-          if (args.trim() === '') {
-            return `${EDGE_FUNCTION_NAME}("${binding}")`;
-          } else {
-            return `${EDGE_FUNCTION_NAME}("${binding}", ${args})`;
-          }
-        })
-    );
-  }
-
-  /**
-   * Map from binding to fully qualified ECHO ID (to store).
-   * E.g., HELLO() => spaceId:objectId()
-   */
-  mapFunctionBindingToId(formula: string) {
-    return formula.replace(/(\w+)\((.*)\)/g, (match, binding, args) => {
-      if (binding === EDGE_FUNCTION_NAME || defaultFunctions.find((fn) => fn.name === binding)) {
-        return match;
-      }
-
-      const fn = this._remoteFunctions.find((fn) => fn.binding === binding);
-      if (fn) {
-        const id = fullyQualifiedId(fn);
-        return `${id}(${args})`;
-      } else {
-        return match;
-      }
-    });
-  }
-
-  /**
-   * Map from fully qualified ECHO ID to binding (from store).
-   * E.g., spaceId:objectId() => HELLO()
-   */
-  mapFunctionBindingFromId(formula: string) {
-    return formula.replace(/(\w+):([a-zA-Z0-9]+)\((.*)\)/g, (match, spaceId, objectId, args) => {
-      const id = `${spaceId}:${objectId}`;
-      if (id.length !== OBJECT_ID_LENGTH) {
-        return match;
-      }
-
-      const fn = this._remoteFunctions.find((fn) => fullyQualifiedId(fn) === id);
-      if (fn?.binding) {
-        return `${fn.binding}(${args})`;
-      } else {
-        return match;
-      }
-    });
-  }
-
-  protected override async _open() {
-    if (this._space) {
-      // Subscribe to remote function definitions.
-      const query = this._space.db.query(Filter.schema(FunctionType));
-      const unsubscribe = query.subscribe(({ objects }) => {
-        this._remoteFunctions = objects.filter(({ binding }) => binding);
-        this.update.emit({ type: 'functionsUpdated' });
-      });
-
-      this._ctx.onDispose(unsubscribe);
-    }
-  }
-
-  protected override async _close() {
-    for (const node of this._nodes.values()) {
-      await node.close();
-    }
-  }
-}

package/src/graph/compute-node.ts

@@ -1,63 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Listeners } from 'hyperformula/typings/Emitter';
-import { type ExportedCellChange } from 'hyperformula/typings/Exporter';
-
-import { Event } from '@dxos/async';
-import { Resource } from '@dxos/context';
-
-import { DetailedCellError } from '#hyperformula';
-import { type ComputeGraph } from './compute-graph';
-import { type CellAddress } from '../defs';
-import { type CellScalarValue } from '../types';
-
-export type ComputeNodeEvent = {
-  type: keyof Listeners;
-  change?: ExportedCellChange;
-};
-
-/**
- * Individual "sheet" (typically corresponds to an ECHO object).
- */
-// TODO(burdon): Factor out common HF wrapper from from SheetModel.
-export class ComputeNode extends Resource {
-  public readonly update = new Event<ComputeNodeEvent>();
-
-  constructor(
-    private readonly _graph: ComputeGraph,
-    public readonly sheetId: number,
-  ) {
-    super();
-  }
-
-  get graph() {
-    return this._graph;
-  }
-
-  clear() {
-    this._graph.hf.clearSheet(this.sheetId);
-  }
-
-  getValue(cell: CellAddress): CellScalarValue {
-    const value = this._graph.hf.getCellValue({ sheet: this.sheetId, row: cell.row, col: cell.col });
-    if (value instanceof DetailedCellError) {
-      return null;
-    }
-
-    return value;
-  }
-
-  setValue(cell: CellAddress, value: CellScalarValue) {
-    const mappedValue =
-      typeof value === 'string' && value.charAt(0) === '=' ? this._graph.mapFormulaToNative(value) : value;
-    this._graph.hf.setCellContents({ sheet: this.sheetId, row: cell.row, col: cell.col }, [[mappedValue]]);
-  }
-
-  // TODO(burdon): Load data into sheet.
-  protected override async _open() {
-    // const unsubscribe = this._graph.update.on(this.update.emit);
-    // this._ctx.onDispose(unsubscribe);
-  }
-}

package/src/graph/functions/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './async-function';
-export * from './edge-function';
-export * from './function-defs';

package/src/graph/hyperformula.test.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { describe, test, expect } from 'vitest';
-
-import { HyperFormula } from '#hyperformula';
-
-describe('hyperformula', () => {
-  test('sanity test', async () => {
-    const hf = HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' });
-    expect(hf).to.exist;
-  });
-});

package/src/graph/index.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './compute-graph';
-export * from './compute-graph-registry';
-export * from './compute-node';
-export * from './functions';

package/src/graph/testing/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './test-builder';
-export * from './test-plugin';

package/src/graph/testing/test-builder.ts

@@ -1,54 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Client, type ClientOptions } from '@dxos/client';
-import { type Context, Resource } from '@dxos/context';
-import { invariant } from '@dxos/invariant';
-
-import { type ComputeGraphOptions, ComputeGraphRegistry } from '../compute-graph-registry';
-
-export type TestBuilderOptions = ClientOptions & ComputeGraphOptions;
-
-// TODO(burdon): Reconcile with @dxos/client/testing.
-export class TestBuilder extends Resource {
-  private _client?: Client;
-  private _registry?: ComputeGraphRegistry;
-
-  constructor(private readonly _options: TestBuilderOptions = {}) {
-    super();
-  }
-
-  get ctx(): Context {
-    return this._ctx;
-  }
-
-  get client(): Client {
-    invariant(this._client);
-    return this._client;
-  }
-
-  get registry(): ComputeGraphRegistry {
-    invariant(this._registry);
-    return this._registry;
-  }
-
-  override async _open() {
-    const client = new Client(this._options);
-    await client.initialize();
-    await client.halo.createIdentity();
-    this._client = client;
-    this._ctx.onDispose(async () => {
-      await client.destroy();
-      this._client = undefined;
-    });
-
-    const registry = new ComputeGraphRegistry(this._options);
-    await registry.open();
-    this._registry = registry;
-    this._ctx.onDispose(async () => {
-      await registry.close();
-      this._registry = undefined;
-    });
-  }
-}

package/src/graph/util.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-// TODO(burdon): Factor out.
-export const parseNumberString = (str: string): number => {
-  return parseFloat(str.replace(/[^\d.]/g, ''));
-};

package/src/hooks/hooks.stories.tsx

@@ -1,50 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import '@dxos-theme';
-
-import React, { useEffect, useState } from 'react';
-
-import { useSpace } from '@dxos/react-client/echo';
-import { withClientProvider } from '@dxos/react-client/testing';
-import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
-import { withTheme } from '@dxos/storybook-utils';
-
-import { ComputeGraphContextProvider } from '../components';
-import { createSheet } from '../defs';
-import { useComputeGraph, useSheetModel } from '../hooks';
-import { withComputeGraphDecorator } from '../testing';
-import { SheetType } from '../types';
-
-const Story = () => {
-  const space = useSpace();
-  const graph = useComputeGraph(space);
-  const [sheet, setSheet] = useState<SheetType>();
-  const model = useSheetModel(graph, sheet);
-  useEffect(() => {
-    if (space) {
-      const sheet = space.db.add(createSheet());
-      setSheet(sheet);
-    }
-  }, [space]);
-
-  return (
-    <SyntaxHighlighter language='json'>
-      {JSON.stringify({ space: space?.id, graph: graph?.id, sheet: sheet?.id, model: model?.id }, null, 2)}
-    </SyntaxHighlighter>
-  );
-};
-
-export default {
-  title: 'plugin-sheet/hooks',
-  component: ComputeGraphContextProvider,
-  decorators: [
-    withClientProvider({ types: [SheetType], createIdentity: true, createSpace: true }),
-    withComputeGraphDecorator(),
-    withTheme,
-  ],
-  render: (args: any) => <Story {...args} />,
-};
-
-export const Default = {};

package/src/hooks/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './useComputeGraph';
-export * from './useSheetModel';
-export * from './threads';