@dxos/plugin-explorer 0.8.4-main.937b3ca → 0.8.4-main.9be5663bfe

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

@@ -5,7 +5,8 @@
 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 { withLayout, withTheme } from '@dxos/react-ui/testing';
@@ -17,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(() => {
@@ -44,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: [withRegistry, withTheme, withLayout()],
+  decorators: [withRegistry, withTheme(), withLayout()],
   parameters: {
     layout: 'fullscreen',
   },

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;

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

@@ -4,7 +4,7 @@
 
 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';
 
@@ -14,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(TestSchema.Expando)),
+  ref: Schema.optional(Ref.Ref(TestSchema.Expando)),
 }).pipe(Schema.mutable);
 
 export interface TreeNodeType extends Schema.Schema.Type<typeof TreeNodeType> {}
@@ -24,7 +24,7 @@ export const TreeType = Schema.Struct({
   nodes: Schema.mutable(Schema.Record({ key: Key.ObjectId, value: TreeNodeType })),
 }).pipe(
   Type.object({
-    typename: 'dxos.org/type/Tree',
+    typename: 'org.dxos.type.tree',
     version: '0.1.0',
   }),
 );
@@ -185,8 +185,8 @@ export class Tree {
   clear(): void {
     const root = this._tree.nodes[this._tree.root];
     root.children.length = 0;
-    Obj.change(this._tree, (t) => {
-      t.nodes = {
+    Obj.change(this._tree, (obj) => {
+      obj.nodes = {
         [root.id]: root,
       };
     });
@@ -202,8 +202,8 @@ export class Tree {
     }
 
     const nodeToAdd = node;
-    Obj.change(this._tree, (t) => {
-      t.nodes[nodeToAdd.id] = nodeToAdd;
+    Obj.change(this._tree, (obj) => {
+      obj.nodes[nodeToAdd.id] = nodeToAdd;
       parent.children.splice(index ?? parent.children.length, 0, nodeToAdd.id);
     });
     return node;
@@ -218,8 +218,8 @@ export class Tree {
       return undefined;
     }
 
-    Obj.change(this._tree, (t) => {
-      delete t.nodes[node.id];
+    Obj.change(this._tree, (obj) => {
+      delete obj.nodes[node.id];
     });
     const idx = parent.children.findIndex((child) => child === id);
     if (idx !== -1) {

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

@@ -2,9 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { RegistryContext } from '@effect-atom/atom-react';
-import { useContext, useEffect, useState } from 'react';
+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';
 
@@ -15,24 +16,28 @@ export const useGraphModel = (
   options?: SpaceGraphModelOptions,
   queue?: Queue,
 ): SpaceGraphModel | undefined => {
-  const registry = useContext(RegistryContext);
+  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(registry).setFilter(filter).setOptions(options);
-      void model.open(space.db, queue);
-      setModel(model);
-    } else {
-      model.setFilter(filter).setOptions(options);
-    }
-  }, [space, filter, options, queue, registry]);
+    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

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

package/src/translations.ts

@@ -6,25 +6,26 @@ 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': {
       [Type.getTypename(Graph.Graph)]: {
-        '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',
-        'object deleted label': 'Explorer deleted',
+        '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

@@ -14,7 +14,6 @@ export const GraphProps = Schema.Struct({
     TypeInputOptionsAnnotation.set({
       location: ['database', 'runtime'],
       kind: ['user'],
-      registered: ['registered'],
     }),
     Schema.optional,
   ),

package/src/types/Graph.ts

@@ -4,26 +4,31 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Filter, Obj, Query, QueryAST, Ref, Type } from '@dxos/echo';
+import { Annotation, Filter, Obj, Query, QueryAST, Ref, Type } from '@dxos/echo';
+import { View } from '@dxos/echo';
 import { FormInputAnnotation, LabelAnnotation } from '@dxos/echo/internal';
-import { View, ViewAnnotation } from '@dxos/schema';
+import { ViewAnnotation } from '@dxos/schema';
 
 const GraphSchema = Schema.Struct({
   name: Schema.optional(Schema.String),
 
-  view: Type.Ref(View.View).pipe(FormInputAnnotation.set(false)),
+  view: Ref.Ref(View.View).pipe(FormInputAnnotation.set(false)),
 
   query: Schema.Struct({
     raw: Schema.optional(Schema.String),
     ast: QueryAST.Query,
-  }).pipe(Schema.mutable, FormInputAnnotation.set(false)),
+  }).pipe(FormInputAnnotation.set(false)),
 }).pipe(
   Type.object({
-    typename: 'dxos.org/type/Graph',
-    version: '0.2.0',
+    typename: 'org.dxos.type.graph',
+    version: '0.1.0',
   }),
   LabelAnnotation.set(['name']),
   ViewAnnotation.set(true),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--graph--regular',
+    hue: 'green',
+  }),
 );
 export interface Graph extends Schema.Schema.Type<typeof GraphSchema> {}
 export const Graph: Type.Obj<Graph> = GraphSchema as any;
@@ -42,21 +47,3 @@ export const make = ({
 }: MakeProps): Graph => {
   return Obj.make(Graph, { name, view: Ref.make(view), query });
 };
-
-//
-// V1
-//
-
-export const GraphV1 = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  query: Schema.Struct({
-    raw: Schema.optional(Schema.String),
-    ast: QueryAST.Query,
-  }).pipe(Schema.mutable),
-}).pipe(
-  Type.object({
-    typename: 'dxos.org/type/Graph',
-    version: '0.1.0',
-  }),
-  LabelAnnotation.set(['name']),
-);

package/src/typings.d.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+declare module '*.css' {
+  const content: undefined;
+  export default content;
+}

package/dist/lib/browser/ExplorerContainer-BFAWRIAJ.mjs

@@ -1,45 +0,0 @@
-import {
-  useGraphModel
-} from "./chunk-BZMTFAP3.mjs";
-import {
-  D3ForceGraph
-} from "./chunk-MGBT2ZFU.mjs";
-import "./chunk-J5LGTIGS.mjs";
-
-// src/components/ExplorerContainer.tsx
-import React, { useCallback, useMemo, useState } from "react";
-import { QueryBuilder } from "@dxos/echo-query";
-import { useGlobalSearch } from "@dxos/plugin-search";
-import { getSpace } from "@dxos/react-client/echo";
-import { Toolbar } from "@dxos/react-ui";
-import { QueryEditor } from "@dxos/react-ui-components";
-import { Layout } from "@dxos/react-ui-mosaic";
-var ExplorerContainer = ({ role, subject: view }) => {
-  const space = getSpace(view);
-  const [filter, setFilter] = useState();
-  const model = useGraphModel(space, filter);
-  const { match } = useGlobalSearch();
-  const builder = useMemo(() => new QueryBuilder(), []);
-  const handleChange = useCallback((value) => {
-    setFilter(builder.build(value).filter);
-  }, []);
-  const showToolbar = role === "article";
-  if (!space || !model) {
-    return null;
-  }
-  return /* @__PURE__ */ React.createElement(Layout.Main, {
-    role,
-    toolbar: showToolbar
-  }, showToolbar && /* @__PURE__ */ React.createElement(Toolbar.Root, null, /* @__PURE__ */ React.createElement(QueryEditor, {
-    db: space.db,
-    onChange: handleChange
-  })), /* @__PURE__ */ React.createElement(D3ForceGraph, {
-    model,
-    match
-  }));
-};
-var ExplorerContainer_default = ExplorerContainer;
-export {
-  ExplorerContainer_default as default
-};
-//# sourceMappingURL=ExplorerContainer-BFAWRIAJ.mjs.map

package/dist/lib/browser/ExplorerContainer-BFAWRIAJ.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/components/ExplorerContainer.tsx"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { useCallback, useMemo, useState } from 'react';\n\nimport { type SurfaceComponentProps } from '@dxos/app-framework/react';\nimport { type Filter } from '@dxos/echo';\nimport { QueryBuilder } from '@dxos/echo-query';\nimport { useGlobalSearch } from '@dxos/plugin-search';\nimport { getSpace } from '@dxos/react-client/echo';\nimport { Toolbar } from '@dxos/react-ui';\nimport { QueryEditor, type QueryEditorProps } from '@dxos/react-ui-components';\nimport { Layout } from '@dxos/react-ui-mosaic';\nimport { type View } from '@dxos/schema';\n\nimport { useGraphModel } from '../hooks';\n\nimport { D3ForceGraph } from './Graph';\n\nexport type ExplorerContainerProps = SurfaceComponentProps<View.View>;\n\nconst ExplorerContainer = ({ role, subject: view }: ExplorerContainerProps) => {\n  const space = getSpace(view);\n  const [filter, setFilter] = useState<Filter.Any>();\n  const model = useGraphModel(space, filter);\n  const { match } = useGlobalSearch();\n\n  const builder = useMemo(() => new QueryBuilder(), []);\n  const handleChange = useCallback<NonNullable<QueryEditorProps['onChange']>>((value) => {\n    setFilter(builder.build(value).filter);\n  }, []);\n\n  const showToolbar = role === 'article';\n\n  if (!space || !model) {\n    return null;\n  }\n\n  return (\n    <Layout.Main role={role} toolbar={showToolbar}>\n      {showToolbar && (\n        <Toolbar.Root>\n          <QueryEditor db={space.db} onChange={handleChange} />\n        </Toolbar.Root>\n      )}\n      <D3ForceGraph model={model} match={match} />\n    </Layout.Main>\n  );\n};\n\nexport default ExplorerContainer;\n"],
-  "mappings": ";;;;;;;;;AAIA,OAAOA,SAASC,aAAaC,SAASC,gBAAgB;AAItD,SAASC,oBAAoB;AAC7B,SAASC,uBAAuB;AAChC,SAASC,gBAAgB;AACzB,SAASC,eAAe;AACxB,SAASC,mBAA0C;AACnD,SAASC,cAAc;AASvB,IAAMC,oBAAoB,CAAC,EAAEC,MAAMC,SAASC,KAAI,MAA0B;AACxE,QAAMC,QAAQC,SAASF,IAAAA;AACvB,QAAM,CAACG,QAAQC,SAAAA,IAAaC,SAAAA;AAC5B,QAAMC,QAAQC,cAAcN,OAAOE,MAAAA;AACnC,QAAM,EAAEK,MAAK,IAAKC,gBAAAA;AAElB,QAAMC,UAAUC,QAAQ,MAAM,IAAIC,aAAAA,GAAgB,CAAA,CAAE;AACpD,QAAMC,eAAeC,YAAuD,CAACC,UAAAA;AAC3EX,cAAUM,QAAQM,MAAMD,KAAAA,EAAOZ,MAAM;EACvC,GAAG,CAAA,CAAE;AAEL,QAAMc,cAAcnB,SAAS;AAE7B,MAAI,CAACG,SAAS,CAACK,OAAO;AACpB,WAAO;EACT;AAEA,SACE,sBAAA,cAACY,OAAOC,MAAI;IAACrB;IAAYsB,SAASH;KAC/BA,eACC,sBAAA,cAACI,QAAQC,MAAI,MACX,sBAAA,cAACC,aAAAA;IAAYC,IAAIvB,MAAMuB;IAAIC,UAAUZ;OAGzC,sBAAA,cAACa,cAAAA;IAAapB;IAAcE;;AAGlC;AAEA,IAAA,4BAAeX;",
-  "names": ["React", "useCallback", "useMemo", "useState", "QueryBuilder", "useGlobalSearch", "getSpace", "Toolbar", "QueryEditor", "Layout", "ExplorerContainer", "role", "subject", "view", "space", "getSpace", "filter", "setFilter", "useState", "model", "useGraphModel", "match", "useGlobalSearch", "builder", "useMemo", "QueryBuilder", "handleChange", "useCallback", "value", "build", "showToolbar", "Layout", "Main", "toolbar", "Toolbar", "Root", "QueryEditor", "db", "onChange", "D3ForceGraph"]
-}