@dxos/plugin-explorer 0.8.4-main.72ec0f3 → 0.8.4-main.74a063c4e0

package/src/components/Graph/ForceGraph.stories.tsx

@@ -5,55 +5,60 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
-import { faker } from '@dxos/random';
+import { Type } from '@dxos/echo';
+import { View } from '@dxos/echo';
+import { random } from '@dxos/random';
 import { useClient } from '@dxos/react-client';
 import { type Space } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { useAsyncEffect } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { View } from '@dxos/schema';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
+import { ViewModel } from '@dxos/schema';
 import { type ValueGenerator } from '@dxos/schema/testing';
-import { render } from '@dxos/storybook-utils';
-import { HasRelationship, Organization, Person, Project } from '@dxos/types';
+import { withRegistry } from '@dxos/storybook-utils';
+import { HasRelationship, Organization, Person, Pipeline } from '@dxos/types';
 
-import { useGraphModel } from '../../hooks';
-import { Graph } from '../../types';
+import { useGraphModel } from '#hooks';
+import { Graph } from '#types';
 
 import { ForceGraph } from './ForceGraph';
 import { generate } from './testing';
 
-const generator = faker as any as ValueGenerator;
+const generator = random as any as ValueGenerator;
 
-faker.seed(1);
+random.seed(1);
 
 const DefaultStory = () => {
   const client = useClient();
   const [space, setSpace] = useState<Space>();
-  const [view, setView] = useState<View.View>();
+  const [graph, setGraph] = useState<Graph.Graph>();
 
   useAsyncEffect(async () => {
-    const space = client.spaces.default;
+    const space = client.spaces.get()[0];
     void generate(space, generator);
-    const { view } = await Graph.makeView({ client, space, name: 'Test', typename: Graph.Graph.typename });
-    space.db.add(view);
+    const { view } = await ViewModel.makeFromDatabase({ db: space.db, typename: Type.getTypename(Graph.Graph) });
+    const graph = Graph.make({ name: 'Test', view });
+    space.db.add(graph);
     setSpace(space);
-    setView(view);
-  }, []);
+    setGraph(graph);
+  }, [client]);
 
   const model = useGraphModel(space);
-  if (!model || !space || !view) {
-    return null;
+  if (!model || !space || !graph) {
+    return <Loading data={{ model: !!model, space: !!space, graph: !!graph }} />;
   }
 
   return <ForceGraph model={model} />;
 };
 
 const meta = {
-  title: 'plugins/plugin-explorer/ForceGraph',
+  title: 'plugins/plugin-explorer/components/ForceGraph',
   component: ForceGraph,
-  render: render(DefaultStory),
+  render: DefaultStory,
   decorators: [
-    withTheme,
+    withRegistry,
+    withTheme(),
+    withLayout(),
     withClientProvider({
       createSpace: true,
       types: [
@@ -61,7 +66,7 @@ const meta = {
         View.View,
         HasRelationship.HasRelationship,
         Organization.Organization,
-        Project.Project,
+        Pipeline.Pipeline,
         Person.Person,
       ],
     }),

package/src/components/Graph/adapter.ts

@@ -25,19 +25,25 @@ export class GraphAdapter implements GraphData {
   private readonly _nodes: GraphNode[] = [];
   private readonly _links: GraphLink[] = [];
 
-  constructor(private readonly graph: Graph) {
-    this._nodes = graph.nodes.map((node) => ({
+  constructor(private readonly graph: Graph.Any) {
+    this._nodes = graph.nodes.map((node: Graph.Node.Any) => ({
       id: node.id,
       type: node.type,
       data: node.data,
     }));
 
-    this._links = graph.edges.map((edge) => ({
-      type: edge.type,
-      source: edge.source,
-      target: edge.target,
-      data: edge.data,
-    }));
+    // Build a set of node IDs for efficient lookup.
+    const nodeIds = new Set(this._nodes.map((node) => node.id));
+
+    // Filter out edges where source or target node doesn't exist.
+    this._links = graph.edges
+      .filter((edge: Graph.Edge.Any) => nodeIds.has(edge.source) && nodeIds.has(edge.target))
+      .map((edge: Graph.Edge.Any) => ({
+        type: edge.type,
+        source: edge.source,
+        target: edge.target,
+        data: edge.data,
+      }));
   }
 
   get nodes() {

package/src/components/Graph/testing.ts

@@ -5,14 +5,14 @@
 import { type Space } from '@dxos/client/echo';
 import { type Obj, Query, Relation } from '@dxos/echo';
 import { type TypeSpec, type ValueGenerator, createObjectFactory } from '@dxos/schema/testing';
-import { HasRelationship, Organization, Person, Project } from '@dxos/types';
+import { HasRelationship, Organization, Person, Pipeline } from '@dxos/types';
 import { range } from '@dxos/util';
 
-const getObject = (objects: Obj.Any[]) => objects[Math.floor(Math.random() * objects.length)];
+const getObject = (objects: Obj.Unknown[]) => objects[Math.floor(Math.random() * objects.length)];
 
 const defaultTypes: TypeSpec[] = [
   { type: Organization.Organization, count: 5 },
-  { type: Project.Project, count: 5 },
+  { type: Pipeline.Pipeline, count: 5 },
   { type: Person.Person, count: 10 },
 ];
 
@@ -24,7 +24,10 @@ export type GenerateOptions = {
   };
 };
 
-const defaultRelations: GenerateOptions['relations'] = { kind: 'friend', count: 10 };
+const defaultRelations: GenerateOptions['relations'] = {
+  kind: 'friend',
+  count: 10,
+};
 
 /**
  * @deprecated Use @dxos/schema.
@@ -38,7 +41,7 @@ export const generate = async (
   await createObjects(spec);
 
   // Add relations between objects.
-  const { objects: contacts } = await space.db.query(Query.type(Person.Person)).run();
+  const contacts = await space.db.query(Query.type(Person.Person)).run();
   for (const _ of range(relations.count)) {
     const source = getObject(contacts);
     const target = getObject(contacts);

package/src/components/Tree/Tree.stories.tsx

@@ -5,10 +5,12 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useEffect, useState } from 'react';
 
-import { faker } from '@dxos/random';
+import { invariant } from '@dxos/invariant';
+import { random } from '@dxos/random';
 import { useClient } from '@dxos/react-client';
 import { type ClientRepeatedComponentProps, ClientRepeater } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/react-ui/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { withRegistry } from '@dxos/storybook-utils';
 
 import { Tree, type TreeComponentProps } from './Tree';
 import { Tree as TreeModel, TreeType } from './types';
@@ -16,13 +18,14 @@ import { Tree as TreeModel, TreeType } from './types';
 // TODO(burdon): Storybook for Graph/Tree/Plot (generics); incl. GraphModel.
 // TODO(burdon): Type for all Explorer components (Space, Object, Query, etc.) incl.
 
-faker.seed(1);
+random.seed(1);
 
 type ComponentProps = ClientRepeatedComponentProps & { type?: TreeComponentProps<any>['variant'] };
 
 const Component = ({ type }: ComponentProps) => {
   const client = useClient();
-  const space = client.spaces.default;
+  const space = client.spaces.get()[0];
+  invariant(space, 'Tree story requires at least one space');
   const [object, setObject] = useState<TreeType>();
   useEffect(() => {
     setTimeout(() => {
@@ -43,10 +46,10 @@ const DefaultStory = () => {
 };
 
 const meta = {
-  title: 'plugins/plugin-explorer/Tree',
+  title: 'plugins/plugin-explorer/components/Tree',
   component: Tree as any,
   render: DefaultStory,
-  decorators: [withTheme],
+  decorators: [withRegistry, withTheme(), withLayout()],
   parameters: {
     layout: 'fullscreen',
   },

package/src/components/Tree/Tree.tsx

@@ -2,7 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { useEffect, useRef, useState } from 'react';
+import { RegistryContext } from '@effect-atom/atom-react';
+import React, { useContext, useEffect, useRef, useState } from 'react';
 
 import { type Space } from '@dxos/client/echo';
 import { useAsyncState } from '@dxos/react-ui';
@@ -62,7 +63,11 @@ export type TreeComponentProps<N = unknown> = {
 
 // TODO(burdon): Label accessor.
 export const Tree = <N,>({ space, selected, variant = 'tidy', onNodeClick }: TreeComponentProps<N>) => {
-  const [model] = useAsyncState(async () => (space ? new SpaceGraphModel().open(space) : undefined), [space, selected]);
+  const registry = useContext(RegistryContext);
+  const [model] = useAsyncState(
+    async () => (space ? new SpaceGraphModel(registry).open(space.db) : undefined),
+    [space, selected, registry],
+  );
 
   const [tree, setTree] = useState<TreeNode>();
   useEffect(() => {
@@ -100,7 +105,7 @@ export const Tree = <N,>({ space, selected, variant = 'tidy', onNodeClick }: Tre
   }, [context.current, tree]);
 
   return (
-    <div onClick={() => onNodeClick?.()}>
+    <div className='grow' onClick={() => onNodeClick?.()}>
       <SVG.Root ref={context} />
     </div>
   );

package/src/components/Tree/testing/generator.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Key } from '@dxos/echo';
+import { Key, Obj } from '@dxos/echo';
 import { range } from '@dxos/util';
 
 import { Tree, type TreeNodeType } from '../types';
@@ -16,7 +16,9 @@ const random = (min: number, max: number) => Math.floor(Math.random() * (max - m
  */
 export const createTree = (spec: NumberOrNumberArray[] = [], createText?: () => string): Tree => {
   const tree = new Tree();
-  tree.root.data = { text: 'root' };
+  Obj.change(tree.tree, () => {
+    tree.root.data = { text: 'root' };
+  });
 
   const createNodes = (parent: TreeNodeType, spec: NumberOrNumberArray = 0): TreeNodeType[] => {
     const count = Array.isArray(spec) ? random(spec[0], spec[1]) : spec;

package/src/components/Tree/types/tree.test.ts

@@ -5,14 +5,13 @@
 import { describe, test } from 'vitest';
 
 import { Obj, Ref } from '@dxos/echo';
-import { faker } from '@dxos/random';
+import { random } from '@dxos/random';
 import { Task } from '@dxos/types';
 
 import { createTree } from '../testing';
-
 import { type Tree } from './tree';
 
-faker.seed(0);
+random.seed(0);
 
 const print = (tree: Tree) => {
   let count = 0;
@@ -129,6 +128,8 @@ describe('tree', () => {
 
     const tree = createTree();
     const node = tree.addNode(tree.root);
-    node.ref = Ref.make(task);
+    Obj.change(tree.tree, () => {
+      node.ref = Ref.make(task);
+    });
   });
 });

package/src/components/Tree/types/tree.ts

@@ -4,7 +4,8 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Key, Obj, Type } from '@dxos/echo';
+import { Key, Obj, Ref, Type } from '@dxos/echo';
+import { TestSchema } from '@dxos/echo/testing';
 import { invariant } from '@dxos/invariant';
 
 // TODO(burdon): Reconcile with @dxos/graph (i.e., common types).
@@ -13,7 +14,7 @@ export const TreeNodeType = Schema.Struct({
   id: Key.ObjectId,
   children: Schema.mutable(Schema.Array(Key.ObjectId)),
   data: Schema.mutable(Schema.Record({ key: Schema.String, value: Schema.Any })),
-  ref: Schema.optional(Type.Ref(Type.Expando)),
+  ref: Schema.optional(Ref.Ref(TestSchema.Expando)),
 }).pipe(Schema.mutable);
 
 export interface TreeNodeType extends Schema.Schema.Type<typeof TreeNodeType> {}
@@ -22,8 +23,8 @@ export const TreeType = Schema.Struct({
   root: Key.ObjectId,
   nodes: Schema.mutable(Schema.Record({ key: Key.ObjectId, value: TreeNodeType })),
 }).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Tree',
+  Type.object({
+    typename: 'org.dxos.type.tree',
     version: '0.1.0',
   }),
 );
@@ -184,9 +185,11 @@ export class Tree {
   clear(): void {
     const root = this._tree.nodes[this._tree.root];
     root.children.length = 0;
-    this._tree.nodes = {
-      [root.id]: root,
-    };
+    Obj.change(this._tree, (obj) => {
+      obj.nodes = {
+        [root.id]: root,
+      };
+    });
   }
 
   /**
@@ -198,8 +201,11 @@ export class Tree {
       node = { id, children: [], data: { text: '' } }; // TODO(burdon): Generic.
     }
 
-    this._tree.nodes[node.id] = node;
-    parent.children.splice(index ?? parent.children.length, 0, node.id);
+    const nodeToAdd = node;
+    Obj.change(this._tree, (obj) => {
+      obj.nodes[nodeToAdd.id] = nodeToAdd;
+      parent.children.splice(index ?? parent.children.length, 0, nodeToAdd.id);
+    });
     return node;
   }
 
@@ -212,10 +218,14 @@ export class Tree {
       return undefined;
     }
 
-    delete this._tree.nodes[node.id];
+    Obj.change(this._tree, (obj) => {
+      delete obj.nodes[node.id];
+    });
     const idx = parent.children.findIndex((child) => child === id);
     if (idx !== -1) {
-      parent.children.splice(idx, 1);
+      Obj.change(this._tree, () => {
+        parent.children.splice(idx, 1);
+      });
     }
 
     return node;
@@ -232,8 +242,10 @@ export class Tree {
     }
 
     const child = node.children[from];
-    node.children.splice(from, 1);
-    node.children.splice(to, 0, child);
+    Obj.change(this._tree, () => {
+      node.children.splice(from, 1);
+      node.children.splice(to, 0, child);
+    });
     return this.getNode(child);
   }
 
@@ -252,8 +264,10 @@ export class Tree {
     }
 
     const previous = this.getNode(parent.children[idx - 1]);
-    parent.children.splice(idx, 1);
-    previous.children.push(node.id);
+    Obj.change(this._tree, () => {
+      parent.children.splice(idx, 1);
+      previous.children.push(node.id);
+    });
   }
 
   /**
@@ -270,16 +284,23 @@ export class Tree {
       return;
     }
 
-    // Remove node from parent.
+    // Remove node from parent and get following siblings.
     const nodeIdx = parent.children.findIndex((id) => id === node.id);
-    const [_, ...rest] = parent.children.splice(nodeIdx, parent.children.length - nodeIdx);
-    parent.children.splice(nodeIdx, parent.children.length - nodeIdx);
+    let rest: Key.ObjectId[] = [];
+    Obj.change(this._tree, () => {
+      const removed = parent.children.splice(nodeIdx, parent.children.length - nodeIdx);
+      rest = removed.slice(1); // Skip the node itself.
+    });
 
     // Add to ancestor.
     const parentIdx = this.getChildNodes(ancestor).findIndex((n) => n.id === parent.id);
-    ancestor.children.splice(parentIdx + 1, 0, node.id);
+    Obj.change(this._tree, () => {
+      ancestor.children.splice(parentIdx + 1, 0, node.id);
+    });
 
     // Transplant following siblings to current node.
-    node.children.push(...rest);
+    Obj.change(this._tree, () => {
+      node.children.push(...rest);
+    });
   }
 }

package/src/components/Tree/types/types.ts

@@ -10,7 +10,7 @@ export type TreeNode = {
   children?: TreeNode[];
 };
 
-export const mapGraphToTreeData = (model: GraphModel, maxDepth = 8): TreeNode | undefined => {
+export const mapGraphToTreeData = (model: GraphModel.GraphModel, maxDepth = 8): TreeNode | undefined => {
   // TODO(burdon): Convert to common/graph.
   // const mapNode = (node: N, depth = 0): TreeNode => {
   //   const treeNode: TreeNode = {

package/src/components/index.ts

@@ -2,11 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type ComponentType, lazy } from 'react';
-
 export * from './Chart';
 export * from './Globe';
 export * from './Graph';
 export * from './Tree';
-
-export const ExplorerContainer: ComponentType<any> = lazy(() => import('./ExplorerContainer'));

package/src/containers/ExplorerContainer/ExplorerContainer.tsx

@@ -0,0 +1,53 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useCallback, useMemo, useState } from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { type Filter } from '@dxos/echo';
+import { type View } from '@dxos/echo';
+import { QueryBuilder } from '@dxos/echo-query';
+import { useGlobalSearch } from '@dxos/plugin-search';
+import { getSpace, useObject } from '@dxos/react-client/echo';
+import { Panel, Toolbar } from '@dxos/react-ui';
+import { QueryEditor, type QueryEditorProps } from '@dxos/react-ui-components';
+
+import { D3ForceGraph } from '#components';
+import { useGraphModel } from '#hooks';
+
+export type ExplorerContainerProps = AppSurface.ObjectArticleProps<View.View>;
+
+export const ExplorerContainer = ({ role, subject: view, attendableId: _attendableId }: ExplorerContainerProps) => {
+  useObject(view);
+  const space = view && getSpace(view);
+  const [filter, setFilter] = useState<Filter.Any>();
+  const model = useGraphModel(space, filter);
+  const { match } = useGlobalSearch();
+
+  const builder = useMemo(() => new QueryBuilder(), []);
+  const handleChange = useCallback<NonNullable<QueryEditorProps['onChange']>>((value) => {
+    setFilter(builder.build(value).filter);
+  }, []);
+
+  const showToolbar = role === 'article';
+
+  if (!space || !model) {
+    return null;
+  }
+
+  return (
+    <Panel.Root role={role}>
+      {showToolbar && (
+        <Panel.Toolbar asChild>
+          <Toolbar.Root>
+            <QueryEditor db={space.db} onChange={handleChange} />
+          </Toolbar.Root>
+        </Panel.Toolbar>
+      )}
+      <Panel.Content asChild>
+        <D3ForceGraph model={model} match={match} />
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/ExplorerContainer/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { ExplorerContainer as default } from './ExplorerContainer';

package/src/containers/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const ExplorerContainer: ComponentType<any> = lazy(() => import('./ExplorerContainer'));

package/src/hooks/useGraphModel.ts

@@ -4,6 +4,8 @@
 
 import { useEffect, useState } from 'react';
 
+import { Capabilities } from '@dxos/app-framework';
+import { useCapability } from '@dxos/app-framework/ui';
 import { type Filter, type Queue, type Space } from '@dxos/client/echo';
 import { SpaceGraphModel, type SpaceGraphModelOptions } from '@dxos/schema';
 
@@ -14,23 +16,28 @@ export const useGraphModel = (
   options?: SpaceGraphModelOptions,
   queue?: Queue,
 ): SpaceGraphModel | undefined => {
+  const registry = useCapability(Capabilities.AtomRegistry);
   const [model, setModel] = useState<SpaceGraphModel | undefined>(undefined);
+
   useEffect(() => {
     if (!space) {
-      void model?.close();
       setModel(undefined);
       return;
     }
 
-    // TODO(burdon): Does this need to be a dependency?
-    if (!model || model.queue !== queue) {
-      const model = new SpaceGraphModel().setFilter(filter).setOptions(options);
-      void model.open(space, queue);
-      setModel(model);
-    } else {
-      model.setFilter(filter).setOptions(options);
-    }
-  }, [space, filter, options, queue]);
+    const newModel = new SpaceGraphModel(registry);
+    void newModel.open(space.db, queue);
+    setModel(newModel);
+
+    return () => {
+      setModel(undefined);
+      void newModel.close();
+    };
+  }, [space, registry, queue]);
+
+  useEffect(() => {
+    model?.setFilter(filter).setOptions(options);
+  }, [model, filter, options]);
 
   return model;
 };

package/src/meta.ts

@@ -2,11 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
-  id: 'dxos.org/plugin/explorer',
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.explorer',
   name: 'Explorer',
   description: trim`
     Interactive hypergraph visualization that reveals relationships between objects in your workspace.

package/src/translations.ts

@@ -2,27 +2,30 @@
 // Copyright 2023 DXOS.org
 //
 
+import { Type } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
 import { translations as componentsTranslations } from '@dxos/react-ui-components';
 
-import { meta } from './meta';
-import { Graph } from './types';
+import { meta } from '#meta';
+import { Graph } from '#types';
 
 export const translations = [
   {
     'en-US': {
-      [Graph.Graph.typename]: {
-        'typename label': 'Explorer',
-        'typename label_zero': 'Explorers',
-        'typename label_one': 'Explorer',
-        'typename label_other': 'Explorers',
-        'object name placeholder': 'New explorer',
-        'rename object label': 'Rename explorer',
-        'delete object label': 'Delete explorer',
+      [Type.getTypename(Graph.Graph)]: {
+        'typename.label': 'Explorer',
+        'typename.label_zero': 'Explorers',
+        'typename.label_one': 'Explorer',
+        'typename.label_other': 'Explorers',
+        'object-name.placeholder': 'New explorer',
+        'add-object.label': 'Add explorer',
+        'rename-object.label': 'Rename explorer',
+        'delete-object.label': 'Delete explorer',
+        'object-deleted.label': 'Explorer deleted',
       },
       [meta.id]: {
-        'plugin name': 'Explorer',
-        'object title label': 'Title',
+        'plugin.name': 'Explorer',
+        'object-title.label': 'Title',
       },
     },
   },

package/src/types/ExplorerAction.ts

@@ -4,27 +4,17 @@
 
 import * as Schema from 'effect/Schema';
 
-import { SpaceSchema } from '@dxos/react-client/echo';
-import { TypenameAnnotationId, View } from '@dxos/schema';
-
-import { meta } from '../meta';
-
-const EXPLORER_ACTION = `${meta.id}/action`;
+import { TypeInputOptionsAnnotation } from '@dxos/plugin-space/types';
 
 export const GraphProps = Schema.Struct({
   name: Schema.optional(Schema.String),
   // TODO(wittjosiah): This should be a query input instead.
-  typename: Schema.String.annotations({
-    [TypenameAnnotationId]: ['used-static', 'dynamic'],
-    title: 'Select graph record type',
-  }),
+  typename: Schema.String.pipe(
+    Schema.annotations({ title: 'Select type' }),
+    TypeInputOptionsAnnotation.set({
+      location: ['database', 'runtime'],
+      kind: ['user'],
+    }),
+    Schema.optional,
+  ),
 });
-
-export class CreateGraph extends Schema.TaggedClass<CreateGraph>()(`${EXPLORER_ACTION}/create-graph`, {
-  input: Schema.Struct({
-    space: SpaceSchema,
-  }).pipe(Schema.extend(GraphProps)),
-  output: Schema.Struct({
-    object: View.View,
-  }),
-}) {}