@dxos/plugin-explorer 0.8.4-main.422d1c7879 → 0.8.4-main.43cb759274

package/src/components/Tree/layout/TidyTree.tsx

@@ -0,0 +1,246 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Observable, Inc.
+//
+
+import { curveBumpX, link as d3Link, select, tree as d3Tree } from 'd3';
+import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+
+import { type ThemedClassName } from '@dxos/react-ui';
+import { mx } from '@dxos/ui-theme';
+
+import { type TreeNode } from '../types';
+import { buildHierarchy, isCollapsed, isLeaf } from './hierarchy';
+import { type TreeLayoutSlots, defaultTreeLayoutSlots } from './slots';
+import { useContainerSize } from './useContainerSize';
+
+const TRANSITION_MS = 350;
+
+export type TidyTreeProps = ThemedClassName<{
+  data: TreeNode;
+  label?: (d: TreeNode) => string;
+  slots?: TreeLayoutSlots;
+  /** Node radius. */
+  r?: number;
+  /** Margin in screen pixels reserved around the layout. */
+  margin?: number;
+  /** Initial set of collapsed node ids. */
+  initialCollapsed?: Iterable<string>;
+  /** Notified when the user clicks a node. */
+  onNodeClick?: (node: TreeNode) => void;
+}>;
+
+/**
+ * Tidy (horizontal) tree layout based on the D3 reference component.
+ * https://observablehq.com/@d3/tree-component
+ *
+ * Click a node with children to toggle collapse / expand.
+ */
+export const TidyTree = ({
+  classNames,
+  data,
+  label = (d) => d.label ?? d.id,
+  slots = defaultTreeLayoutSlots,
+  r = 4,
+  margin = 24,
+  initialCollapsed,
+  onNodeClick,
+}: TidyTreeProps) => {
+  const svgRef = useRef<SVGSVGElement | null>(null);
+  const { setRef, width, height } = useContainerSize();
+
+  const [collapsed, setCollapsed] = useState<Set<string>>(() => new Set(initialCollapsed ?? []));
+  const toggle = useCallback((id: string) => {
+    setCollapsed((prev) => {
+      const next = new Set(prev);
+      if (next.has(id)) {
+        next.delete(id);
+      } else {
+        next.add(id);
+      }
+      return next;
+    });
+  }, []);
+
+  // Stable click handler ref so the d3 render fn doesn't need to be re-bound.
+  const handleClickRef = useRef<(node: TreeNode) => void>(() => {});
+  handleClickRef.current = (node: TreeNode) => {
+    onNodeClick?.(node);
+    if (node.children?.length) {
+      toggle(node.id);
+    }
+  };
+
+  const root = useMemo(() => buildHierarchy(data, collapsed), [data, collapsed]);
+
+  useEffect(() => {
+    if (!svgRef.current || !width || !height) {
+      return;
+    }
+
+    renderTidyTree(svgRef.current, root, {
+      width,
+      height,
+      r,
+      margin,
+      label,
+      slots,
+      collapsed,
+      onNodeClick: (n) => handleClickRef.current(n),
+    });
+  }, [root, width, height, r, margin, label, slots, collapsed]);
+
+  return (
+    <div ref={setRef} className={mx('dx-expander relative', classNames)}>
+      {width > 0 && height > 0 && (
+        <svg
+          ref={svgRef}
+          xmlns='http://www.w3.org/2000/svg'
+          width={width}
+          height={height}
+          viewBox={`${-width / 2} ${-height / 2} ${width} ${height}`}
+        />
+      )}
+    </div>
+  );
+};
+
+type RenderOptions = {
+  width: number;
+  height: number;
+  r: number;
+  margin: number;
+  label: (d: TreeNode) => string;
+  slots: TreeLayoutSlots;
+  collapsed: Set<string>;
+  onNodeClick: (node: TreeNode) => void;
+};
+
+const renderTidyTree = (svgElement: SVGSVGElement, root: any, options: RenderOptions) => {
+  const { width, height, r, margin, label, slots, collapsed, onNodeClick } = options;
+  const svg = select(svgElement);
+
+  // Compute layout: nodeSize gives a stable, content-driven scale.
+  // dx = vertical spacing between siblings; dy = horizontal spacing between depths.
+  const dx = 18;
+  const dy = Math.max(60, (width - margin * 2) / Math.max(1, root.height + 1));
+  d3Tree<TreeNode>().nodeSize([dx, dy])(root);
+
+  // Center the tree vertically; lay it out horizontally from left.
+  let x0 = Infinity;
+  let x1 = -x0;
+  root.each((d: any) => {
+    if (d.x > x1) {
+      x1 = d.x;
+    }
+    if (d.x < x0) {
+      x0 = d.x;
+    }
+  });
+
+  const treeWidth = width - margin * 2;
+  const treeHeight = x1 - x0;
+  const scaleY = treeHeight > 0 ? Math.min(1, (height - margin * 2) / treeHeight) : 1;
+  const offsetX = -treeWidth / 2;
+  const offsetY = -(x0 + x1) / 2;
+
+  // Root group ensures consistent transforms on re-renders.
+  const g = svg.selectAll<SVGGElement, null>('g.dx-tidy-root').data([null]).join('g').classed('dx-tidy-root', true);
+
+  // Links layer.
+  const linksLayer = g
+    .selectAll<SVGGElement, null>('g.dx-tidy-links')
+    .data([null])
+    .join('g')
+    .classed('dx-tidy-links', true);
+
+  // Nodes layer (rendered above links).
+  const nodesLayer = g
+    .selectAll<SVGGElement, null>('g.dx-tidy-nodes')
+    .data([null])
+    .join('g')
+    .classed('dx-tidy-nodes', true);
+
+  // Links.
+  const linkPath = d3Link<any, any>(curveBumpX)
+    .x((d: any) => offsetX + d.y)
+    .y((d: any) => (d.x + offsetY) * scaleY);
+
+  linksLayer
+    .selectAll<SVGPathElement, any>('path')
+    .data(root.links(), (d: any) => `${d.source.data.id}->${d.target.data.id}`)
+    .join(
+      (enter) =>
+        enter
+          .append('path')
+          .attr('class', slots.path ?? '')
+          .attr('fill', 'none')
+          .attr('opacity', 0),
+      (update) => update,
+      (exit) => exit.transition().duration(TRANSITION_MS).attr('opacity', 0).remove(),
+    )
+    .transition()
+    .duration(TRANSITION_MS)
+    .attr('opacity', 1)
+    .attr('d', linkPath);
+
+  // Nodes.
+  const node = nodesLayer.selectAll<SVGGElement, any>('g.dx-tidy-node').data(root.descendants(), (d: any) => d.data.id);
+
+  const nodeEnter = node
+    .enter()
+    .append('g')
+    .classed('dx-tidy-node', true)
+    .attr('transform', (d: any) => `translate(${offsetX + d.y},${(d.x + offsetY) * scaleY})`)
+    .attr('opacity', 0)
+    .style('cursor', (d: any) => (d.data.children?.length ? 'pointer' : 'default'))
+    .on('click', (_, d: any) => onNodeClick(d.data));
+
+  nodeEnter.append('circle').attr('r', r);
+  nodeEnter
+    .append('text')
+    .attr('dy', '0.32em')
+    .attr('x', (d: any) => (d.children ? -(r + 4) : r + 4))
+    .attr('text-anchor', (d: any) => (d.children ? 'end' : 'start'))
+    .text((d: any) => label(d.data));
+
+  const nodeMerge = nodeEnter.merge(node as any);
+
+  nodeMerge
+    .transition()
+    .duration(TRANSITION_MS)
+    .attr('opacity', 1)
+    .attr('transform', (d: any) => `translate(${offsetX + d.y},${(d.x + offsetY) * scaleY})`);
+
+  // Circle: filled when collapsed (has hidden children), outlined when expanded or leaf.
+  nodeMerge
+    .select<SVGCircleElement>('circle')
+    .attr('class', (d: any) => {
+      const collapsedHere = isCollapsed(d.data, collapsed);
+      const leaf = isLeaf(d.data);
+      return [slots.node ?? '', collapsedHere ? 'dx-collapsed' : leaf ? 'dx-leaf' : 'dx-branch']
+        .filter(Boolean)
+        .join(' ');
+    })
+    .attr('r', r);
+
+  nodeMerge
+    .select<SVGTextElement>('text')
+    .attr('class', slots.text ?? '')
+    .attr('x', (d: any) => (d.children ? -(r + 4) : r + 4))
+    .attr('text-anchor', (d: any) => (d.children ? 'end' : 'start'))
+    .text((d: any) => label(d.data));
+
+  node
+    .exit()
+    .each(function () {
+      // Cancel any in-flight transitions so .remove() actually fires.
+      select(this).interrupt();
+    })
+    .transition()
+    .duration(TRANSITION_MS)
+    .attr('opacity', 0)
+    .remove();
+};
+
+export default TidyTree;

package/src/components/Tree/layout/hierarchy.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type HierarchyNode, hierarchy as d3Hierarchy } from 'd3';
+
+import { type TreeNode } from '../types';
+
+/**
+ * Build a d3 hierarchy from a TreeNode, pruning children of nodes whose ids are in `collapsed`.
+ * Nodes that have children but are collapsed retain their identity in the hierarchy and can be
+ * distinguished by `node._children` (the original list).
+ */
+export const buildHierarchy = (data: TreeNode, collapsed: Set<string> = new Set()): HierarchyNode<TreeNode> => {
+  return d3Hierarchy<TreeNode>(data, (d) => {
+    if (!d.children?.length) {
+      return undefined;
+    }
+    return collapsed.has(d.id) ? undefined : d.children;
+  });
+};
+
+/**
+ * True when the node has children that have been hidden via collapse.
+ */
+export const isCollapsed = (data: TreeNode, collapsed: Set<string>): boolean =>
+  Boolean(data.children?.length) && collapsed.has(data.id);
+
+/**
+ * True when the node has no children at all (a real leaf, not a collapsed branch).
+ */
+export const isLeaf = (data: TreeNode): boolean => !data.children?.length;

package/src/components/Tree/layout/index.ts

@@ -2,8 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
-import HierarchicalEdgeBundling from './HierarchicalEdgeBundling';
-import RadialTree from './RadialTree';
-import TidyTree from './TidyTree';
-
-export { HierarchicalEdgeBundling, RadialTree, TidyTree };
+export * from './HierarchicalEdgeBundling';
+export * from './RadialTree';
+export * from './TidyTree';
+export * from './hierarchy';
+export * from './slots';

package/src/components/Tree/layout/slots.ts

@@ -0,0 +1,19 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+export type TreeLayoutSlots = {
+  node?: string;
+  path?: string;
+  text?: string;
+};
+
+export const defaultTreeLayoutSlots: TreeLayoutSlots = {
+  // Cursor + transition so the hover swap reads clearly; SVG circles support the `:hover` pseudo-class
+  // via Tailwind variants exactly like HTML elements.
+  node: 'fill-blue-600 hover:fill-orange-500 cursor-pointer transition-colors',
+  // 0.5px is fine on a white background, but on a dark Storybook background the lines disappear.
+  // Use stroke-1 with opacity 50% so they read in both themes; dx-bundle-dim/out/in further tune on hover.
+  path: 'fill-none stroke-blue-500/50 stroke-[1px] dark:stroke-blue-400/60',
+  text: 'fill-neutral-700 dark:fill-neutral-300 text-xs hover:fill-orange-500 cursor-pointer transition-colors',
+};

package/src/components/Tree/layout/useContainerSize.ts

@@ -0,0 +1,43 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { useEffect, useState } from 'react';
+
+/**
+ * Track an element's content-box size via ResizeObserver.
+ * Returns the most recently observed `{ width, height }` plus a callback ref to attach to the element.
+ *
+ * Why not `react-resize-detector` directly: its `targetRef` API doesn't pick up a ref whose
+ * `.current` is set later than the hook runs, and the returned-`ref` API forces the consumer to
+ * forward a callback ref through their own component — which is awkward for class refs.
+ * This hook returns a setter so the consumer assigns it directly to `<div ref={setRef}>`.
+ */
+export const useContainerSize = (): {
+  setRef: (el: HTMLDivElement | null) => void;
+  width: number;
+  height: number;
+} => {
+  const [el, setEl] = useState<HTMLDivElement | null>(null);
+  const [size, setSize] = useState<{ width: number; height: number }>({ width: 0, height: 0 });
+
+  useEffect(() => {
+    if (!el) {
+      return;
+    }
+    const rect = el.getBoundingClientRect();
+    setSize({ width: rect.width, height: rect.height });
+    const observer = new ResizeObserver((entries) => {
+      const entry = entries[0];
+      if (!entry) {
+        return;
+      }
+      const { width, height } = entry.contentRect;
+      setSize((prev) => (prev.width === width && prev.height === height ? prev : { width, height }));
+    });
+    observer.observe(el);
+    return () => observer.disconnect();
+  }, [el]);
+
+  return { setRef: setEl, width: size.width, height: size.height };
+};

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

@@ -8,7 +8,7 @@ import { Obj, Ref } from '@dxos/echo';
 import { random } from '@dxos/random';
 import { Task } from '@dxos/types';
 
-import { createTree } from '../testing';
+import { createTree } from '../../../testing';
 import { type Tree } from './tree';
 
 random.seed(0);
@@ -128,7 +128,7 @@ describe('tree', () => {
 
     const tree = createTree();
     const node = tree.addNode(tree.root);
-    Obj.change(tree.tree, () => {
+    Obj.update(tree.tree, () => {
       node.ref = Ref.make(task);
     });
   });

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

@@ -4,39 +4,34 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Key, Obj, Ref, Type } from '@dxos/echo';
+import { DXN, 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).
 
 export const TreeNodeType = Schema.Struct({
-  id: Key.ObjectId,
-  children: Schema.mutable(Schema.Array(Key.ObjectId)),
+  id: Key.EntityId,
+  children: Schema.mutable(Schema.Array(Key.EntityId)),
   data: Schema.mutable(Schema.Record({ key: Schema.String, value: Schema.Any })),
   ref: Schema.optional(Ref.Ref(TestSchema.Expando)),
 }).pipe(Schema.mutable);
 
-export interface TreeNodeType extends Schema.Schema.Type<typeof TreeNodeType> {}
+export type TreeNodeType = Schema.Schema.Type<typeof TreeNodeType>;
 
 export const TreeType = Schema.Struct({
-  root: Key.ObjectId,
-  nodes: Schema.mutable(Schema.Record({ key: Key.ObjectId, value: TreeNodeType })),
-}).pipe(
-  Type.object({
-    typename: 'org.dxos.type.tree',
-    version: '0.1.0',
-  }),
-);
+  root: Key.EntityId,
+  nodes: Schema.mutable(Schema.Record({ key: Key.EntityId, value: TreeNodeType })),
+}).pipe(Type.makeObject(DXN.make('org.dxos.type.tree', '0.1.0')));
 
-export interface TreeType extends Schema.Schema.Type<typeof TreeType> {}
+export type TreeType = Type.InstanceType<typeof TreeType>;
 
 /**
  * Wrapper object for tree.
  */
 export class Tree {
   static create = (): TreeType => {
-    const id = Key.ObjectId.random();
+    const id = Key.EntityId.random();
     return Obj.make(TreeType, {
       root: id,
       nodes: {
@@ -77,7 +72,7 @@ export class Tree {
    */
   tranverse<T>(
     callback: (node: TreeNodeType, depth: number) => T | void,
-    root: Key.ObjectId = this._tree.root,
+    root: Key.EntityId = this._tree.root,
     depth = 0,
   ): T | void {
     const node = this._tree.nodes[root];
@@ -94,7 +89,7 @@ export class Tree {
     }
   }
 
-  getNode(id: Key.ObjectId): TreeNodeType {
+  getNode(id: Key.EntityId): TreeNodeType {
     const node = this._tree.nodes[id];
     invariant(node);
     return node;
@@ -185,7 +180,7 @@ export class Tree {
   clear(): void {
     const root = this._tree.nodes[this._tree.root];
     root.children.length = 0;
-    Obj.change(this._tree, (obj) => {
+    Obj.update(this._tree, (obj) => {
       obj.nodes = {
         [root.id]: root,
       };
@@ -197,12 +192,12 @@ export class Tree {
    */
   addNode(parent: TreeNodeType, node?: TreeNodeType, index?: number): TreeNodeType {
     if (!node) {
-      const id = Key.ObjectId.random();
+      const id = Key.EntityId.random();
       node = { id, children: [], data: { text: '' } }; // TODO(burdon): Generic.
     }
 
     const nodeToAdd = node;
-    Obj.change(this._tree, (obj) => {
+    Obj.update(this._tree, (obj) => {
       obj.nodes[nodeToAdd.id] = nodeToAdd;
       parent.children.splice(index ?? parent.children.length, 0, nodeToAdd.id);
     });
@@ -212,18 +207,18 @@ export class Tree {
   /**
    * Delete node.
    */
-  deleteNode(parent: TreeNodeType, id: Key.ObjectId): TreeNodeType | undefined {
+  deleteNode(parent: TreeNodeType, id: Key.EntityId): TreeNodeType | undefined {
     const node = this._tree.nodes[id];
     if (!node) {
       return undefined;
     }
 
-    Obj.change(this._tree, (obj) => {
+    Obj.update(this._tree, (obj) => {
       delete obj.nodes[node.id];
     });
     const idx = parent.children.findIndex((child) => child === id);
     if (idx !== -1) {
-      Obj.change(this._tree, () => {
+      Obj.update(this._tree, () => {
         parent.children.splice(idx, 1);
       });
     }
@@ -242,7 +237,7 @@ export class Tree {
     }
 
     const child = node.children[from];
-    Obj.change(this._tree, () => {
+    Obj.update(this._tree, () => {
       node.children.splice(from, 1);
       node.children.splice(to, 0, child);
     });
@@ -264,7 +259,7 @@ export class Tree {
     }
 
     const previous = this.getNode(parent.children[idx - 1]);
-    Obj.change(this._tree, () => {
+    Obj.update(this._tree, () => {
       parent.children.splice(idx, 1);
       previous.children.push(node.id);
     });
@@ -286,20 +281,20 @@ export class Tree {
 
     // Remove node from parent and get following siblings.
     const nodeIdx = parent.children.findIndex((id) => id === node.id);
-    let rest: Key.ObjectId[] = [];
-    Obj.change(this._tree, () => {
+    let rest: Key.EntityId[] = [];
+    Obj.update(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);
-    Obj.change(this._tree, () => {
+    Obj.update(this._tree, () => {
       ancestor.children.splice(parentIdx + 1, 0, node.id);
     });
 
     // Transplant following siblings to current node.
-    Obj.change(this._tree, () => {
+    Obj.update(this._tree, () => {
       node.children.push(...rest);
     });
   }

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

@@ -2,40 +2,49 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type GraphModel } from '@dxos/graph';
+import { type Key } from '@dxos/echo';
 
-export type TreeNode = {
+import { type TreeType } from './tree';
+
+/**
+ * In-memory tree shape used by the d3 layouts.
+ * `data` carries through to layout callbacks (e.g. hover/inspect) — typically an ECHO object on leaves.
+ */
+export type TreeNode<TData = unknown> = {
   id: string;
   label?: string;
-  children?: TreeNode[];
+  data?: TData;
+  children?: TreeNode<TData>[];
 };
 
-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 = {
-  //     id: model.idAccessor(node),
-  //     label: model.idAccessor(node).slice(0, 8),
-  //   };
-
-  //   const links = model.graph.links.filter((link) => link.source === treeNode.id);
-  //   if (depth < maxDepth) {
-  //     treeNode.children = links.map((link) =>
-  //       mapNode(model.graph.nodes.find((node) => model.idAccessor(node) === link.target)!, depth + 1),
-  //     );
-  //   }
+/**
+ * Convert an ECHO `TreeType` (id-keyed node map) into a nested `TreeNode` hierarchy.
+ * Returns `undefined` if the root id is missing — the tree is then incomplete and shouldn't render.
+ */
+export const treeTypeToTreeNode = (
+  tree: TreeType,
+  rootId: Key.EntityId = tree.root,
+  visited: Set<string> = new Set(),
+): TreeNode | undefined => {
+  const node = tree.nodes[rootId];
+  if (!node) {
+    return undefined;
+  }
+  if (visited.has(rootId)) {
+    return { id: rootId, label: labelOf(node), data: node.data };
+  }
+  visited.add(rootId);
 
-  //   return treeNode;
-  // };
-
-  let data: TreeNode | undefined;
-  // TODO(burdon): Selection model.
-  // if (model.selected) {
-  //   const node = model.graph.nodes.find((node) => model.idAccessor(node) === model.selected);
-  //   if (node) {
-  //     data = mapNode(node);
-  //   }
-  // }
+  return {
+    id: rootId,
+    label: labelOf(node),
+    data: node.data,
+    children: node.children
+      .map((childId) => treeTypeToTreeNode(tree, childId, visited))
+      .filter((c): c is TreeNode => Boolean(c)),
+  };
+};
 
-  return data;
+const labelOf = (node: { data: Record<string, any> }): string | undefined => {
+  return typeof node.data?.text === 'string' ? node.data.text : undefined;
 };

package/src/components/index.ts

@@ -5,4 +5,5 @@
 export * from './Chart';
 export * from './Globe';
 export * from './Graph';
+export * from './Lattice';
 export * from './Tree';