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

package/src/capabilities/app-graph-builder/extensions/collections.ts

@@ -0,0 +1,346 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import {
+  AppCapabilities,
+  AppNodeMatcher,
+  LayoutOperation,
+  RootCollectionAnnotation,
+  Segments,
+  getObjectPathFromObject,
+  toUrlPath,
+} from '@dxos/app-toolkit';
+import { SpaceState, isSpace } from '@dxos/client/echo';
+import { Operation } from '@dxos/compute';
+import { Annotation, Collection, Obj, Type } from '@dxos/echo';
+import { AtomObj } from '@dxos/echo-atom';
+import { invariant } from '@dxos/invariant';
+import { CreateAtom, Graph, GraphBuilder, Node } from '@dxos/plugin-graph';
+import { isNonNullable } from '@dxos/util';
+
+import { meta } from '#meta';
+import { SpaceOperation } from '#operations';
+import { SpaceCapabilities } from '#types';
+
+import {
+  COLLECTIONS_SECTION_TYPE,
+  COPY_LINK_LABEL,
+  CREATE_OBJECT_IN_COLLECTION_LABEL,
+  EXPOSE_OBJECT_LABEL,
+  REMOVE_FROM_COLLECTION_LABEL,
+  createObjectNode,
+  getCollectionGraphNodePartials,
+  getDynamicLabel,
+} from './shared';
+
+//
+// Extension Factory
+//
+
+/** Creates collection-related extensions: collections section, collections, objects, and object actions. */
+export const createCollectionExtensions = Effect.fnUntraced(function* ({
+  shareableLinkOrigin,
+}: {
+  shareableLinkOrigin: string;
+}) {
+  const capabilities = yield* Capability.Service;
+
+  return yield* Effect.all([
+    // Collections section virtual node under each space.
+    GraphBuilder.createExtension({
+      id: 'collectionsSection',
+      match: AppNodeMatcher.whenSpace,
+      connector: (space, get) => {
+        const spaceState = get(CreateAtom.fromObservable(space.state));
+        if (spaceState !== SpaceState.SPACE_READY) {
+          return Effect.succeed([]);
+        }
+
+        get(AtomObj.make(space.properties));
+        const collectionRef = Annotation.get(space.properties, RootCollectionAnnotation).pipe(Option.getOrUndefined);
+        if (collectionRef) {
+          get(AtomObj.make(collectionRef));
+        }
+        const rootCollection = collectionRef?.target;
+        const collectionPartials = rootCollection
+          ? getCollectionGraphNodePartials({ db: space.db, collection: rootCollection })
+          : undefined;
+
+        return Effect.succeed([
+          Node.make({
+            id: Segments.collections,
+            type: COLLECTIONS_SECTION_TYPE,
+            data: null,
+            properties: {
+              label: ['collections-section.label', { ns: meta.id }],
+              icon: 'ph--folder--regular',
+              iconHue: 'amber',
+              role: 'branch',
+              position: 'first',
+              testId: 'spacePlugin.collectionsSection',
+              draggable: false,
+              droppable: false,
+              space,
+              ...collectionPartials,
+            },
+          }),
+        ]);
+      },
+    }),
+
+    // Root collection objects under the Collections virtual node.
+    GraphBuilder.createExtension({
+      id: 'collections',
+      match: (node) => {
+        const space = isSpace(node.properties.space) ? node.properties.space : undefined;
+        return node.type === COLLECTIONS_SECTION_TYPE && space ? Option.some(space) : Option.none();
+      },
+      connector: (space, get) => {
+        const ephemeralAtom = capabilities.get(SpaceCapabilities.EphemeralState);
+        const ephemeralState = get(ephemeralAtom);
+
+        get(AtomObj.make(space.properties));
+        const collectionRef = Annotation.get(space.properties, RootCollectionAnnotation).pipe(Option.getOrUndefined);
+        const collection = collectionRef ? get(AtomObj.make(collectionRef)) : undefined;
+        if (!collection) {
+          return Effect.succeed([]);
+        }
+
+        const rawRefs = collection.objects ?? [];
+
+        const objects = rawRefs
+          .map((ref: any) => {
+            get(AtomObj.make(ref));
+            return ref.target;
+          })
+          .filter(isNonNullable);
+
+        return Effect.succeed(
+          objects
+            .map((object: Obj.Unknown) =>
+              createObjectNode({
+                db: space.db,
+                object,
+                navigable: ephemeralState.navigableCollections,
+                parentCollection: collectionRef?.target,
+              }),
+            )
+            .filter(isNonNullable),
+        );
+      },
+    }),
+
+    // Children of Collection.Collection nodes.
+    GraphBuilder.createExtension({
+      id: 'objects',
+      match: (node) => (Obj.instanceOf(Collection.Collection, node.data) ? Option.some(node.data) : Option.none()),
+      connector: (collection, get) => {
+        const ephemeralAtom = capabilities.get(SpaceCapabilities.EphemeralState);
+        const ephemeralState = get(ephemeralAtom);
+        const db = Obj.getDatabase(collection);
+
+        const collectionSnapshot = get(AtomObj.make(collection));
+        const refs = collectionSnapshot.objects ?? [];
+
+        const objects = refs
+          .map((ref: any) => {
+            get(AtomObj.make(ref));
+            return ref.target;
+          })
+          .filter(isNonNullable);
+
+        return Effect.succeed(
+          objects
+            .map(
+              (object: Obj.Unknown) =>
+                db &&
+                createObjectNode({
+                  object,
+                  db,
+                  navigable: ephemeralState.navigableCollections,
+                  parentCollection: collection,
+                }),
+            )
+            .filter(isNonNullable),
+        );
+      },
+      // TODO(graph-path-ids): Resolver temporarily disabled; redesign needed for path-based IDs.
+      // resolver: (id, get) => { ... },
+    }),
+
+    // Object actions.
+    GraphBuilder.createExtension({
+      id: 'objectActions',
+      match: (node) => {
+        return node.data != null &&
+          Obj.getDatabase(node.data) &&
+          Obj.isObject(node.data) &&
+          Obj.getTypename(node.data) === node.type
+          ? Option.some({ object: node.data, nodeId: node.id })
+          : Option.none();
+      },
+      actions: ({ object, nodeId }, get) => {
+        const deletable = !Type.isType(object);
+
+        const [appGraph] = get(capabilities.atom(AppCapabilities.AppGraph));
+        const ephemeralAtom = capabilities.get(SpaceCapabilities.EphemeralState);
+        const ephemeralState = get(ephemeralAtom);
+
+        if (!appGraph) {
+          return Effect.succeed([]);
+        }
+
+        const parentId = nodeId.substring(0, nodeId.lastIndexOf('/'));
+        const parentNode = Option.getOrUndefined(Graph.getNode(appGraph.graph, parentId));
+        const parentCollection =
+          parentNode && Obj.instanceOf(Collection.Collection, parentNode.data) ? parentNode.data : undefined;
+
+        return Effect.succeed(
+          constructObjectActions({
+            object,
+            nodeId,
+            deletable,
+            navigable: ephemeralState.navigableCollections,
+            shareableLinkOrigin,
+            parentCollection,
+          }),
+        );
+      },
+    }),
+  ]);
+});
+
+//
+// Helpers
+//
+
+/** Builds the action list for an ECHO object node. */
+const constructObjectActions = ({
+  object,
+  nodeId,
+  deletable = true,
+  navigable = false,
+  shareableLinkOrigin,
+  parentCollection,
+}: {
+  object: Obj.Unknown;
+  nodeId: string;
+  shareableLinkOrigin: string;
+  deletable?: boolean;
+  navigable?: boolean;
+  parentCollection?: Collection.Collection;
+}) => {
+  const db = Obj.getDatabase(object);
+  invariant(db, 'Database not found');
+  const typename = Obj.getTypename(object);
+  invariant(typename, 'Object has no typename');
+
+  const actions: Node.NodeArg<Node.ActionData<Operation.Service | Capability.Service>>[] = [
+    ...(Obj.instanceOf(Collection.Collection, object)
+      ? [
+          Node.makeAction({
+            id: SpaceOperation.OpenCreateObject.meta.key,
+            data: () => Operation.invoke(SpaceOperation.OpenCreateObject, { target: object, targetNodeId: nodeId }),
+            properties: {
+              label: CREATE_OBJECT_IN_COLLECTION_LABEL,
+              icon: 'ph--plus--regular',
+              disposition: 'list-item-primary',
+              testId: 'spacePlugin.createObject',
+            },
+          }),
+        ]
+      : []),
+    Node.makeAction({
+      id: SpaceOperation.RenameObject.meta.key,
+      data: (params?: Node.InvokeProps) =>
+        Operation.invoke(SpaceOperation.RenameObject, { object, caller: `${params?.caller}:${params?.parent?.id}` }),
+      properties: {
+        label: getDynamicLabel('rename-object.label', typename, { defaultValue: 'Rename' }),
+        icon: 'ph--pencil-simple-line--regular',
+        disposition: 'list-item',
+        testId: 'spacePlugin.renameObject',
+      },
+    }),
+    ...(parentCollection && !Obj.instanceOf(Collection.Collection, object)
+      ? [
+          Node.makeAction({
+            id: 'removeFromCollection',
+            data: () =>
+              Effect.gen(function* () {
+                const index = parentCollection.objects.findIndex((ref: any) => ref.target === object);
+                if (index !== -1) {
+                  const layout = yield* Capabilities.getAtomValue(AppCapabilities.Layout);
+                  const isActive = layout.active.includes(nodeId);
+
+                  Obj.update(parentCollection, (parentCollection) => {
+                    parentCollection.objects.splice(index, 1);
+                  });
+
+                  if (isActive) {
+                    yield* Operation.invoke(LayoutOperation.Open, {
+                      subject: [getObjectPathFromObject(object)],
+                    });
+                  }
+                }
+              }),
+            properties: {
+              label: REMOVE_FROM_COLLECTION_LABEL,
+              icon: 'ph--minus-circle--regular',
+              disposition: 'list-item',
+              testId: 'spacePlugin.removeFromCollection',
+            },
+          }),
+        ]
+      : []),
+    Node.makeAction({
+      id: SpaceOperation.RemoveObjects.meta.key,
+      data: () =>
+        Operation.invoke(SpaceOperation.RemoveObjects, {
+          objects: [object],
+          target: parentCollection,
+        }),
+      properties: {
+        label: getDynamicLabel('delete object label', typename, { defaultValue: 'Delete' }),
+        icon: 'ph--trash--regular',
+        disposition: 'list-item',
+        disabled: !deletable,
+        testId: 'spacePlugin.deleteObject',
+      },
+    }),
+    ...(navigable || !Obj.instanceOf(Collection.Collection, object)
+      ? [
+          Node.makeAction({
+            id: 'copyLink',
+            data: () =>
+              Effect.promise(async () => {
+                const url = new URL(toUrlPath(nodeId), shareableLinkOrigin);
+                await navigator.clipboard.writeText(url.toString());
+              }),
+            properties: {
+              label: COPY_LINK_LABEL,
+              icon: 'ph--link--regular',
+              disposition: 'list-item',
+              testId: 'spacePlugin.copyLink',
+            },
+          }),
+        ]
+      : []),
+    Node.makeAction({
+      id: LayoutOperation.Expose.meta.key,
+      data: () => Operation.invoke(LayoutOperation.Expose, { subject: getObjectPathFromObject(object) }),
+      properties: {
+        label: EXPOSE_OBJECT_LABEL,
+        icon: 'ph--eye--regular',
+        disposition: 'heading-list-item',
+        testId: 'spacePlugin.exposeObject',
+      },
+    }),
+  ];
+
+  return actions;
+};

package/src/capabilities/app-graph-builder/extensions/companions.ts

@@ -0,0 +1,90 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { AppNode } from '@dxos/app-toolkit';
+import { Obj, Type } from '@dxos/echo';
+import { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';
+// TODO(wittjosiah): This is currently necessary for type portability.
+// eslint-disable-next-line unused-imports/no-unused-imports
+import type { Node } from '@dxos/plugin-graph';
+import { linkedSegment } from '@dxos/react-ui-attention';
+import type { EchoViewRefPath } from '@dxos/schema';
+import { ViewAnnotation } from '@dxos/schema';
+
+import { meta } from '#meta';
+
+//
+// Extension Factory
+//
+
+/** Creates companion panel extensions: object settings and selected-objects. */
+export const createCompanionExtensions = Effect.fnUntraced(function* () {
+  return yield* Effect.all([
+    // Object settings plank companion.
+    GraphBuilder.createExtension({
+      id: 'settings',
+      match: NodeMatcher.whenEchoObjectMatches,
+      connector: (node) =>
+        Effect.succeed([
+          AppNode.makeCompanion({
+            id: linkedSegment('settings'),
+            label: ['object-properties.label', { ns: meta.id }],
+            icon: 'ph--sliders--regular',
+            data: 'settings', // TODO(burdon): Change to 'object-properties'.
+            position: 'last',
+          }),
+        ]),
+    }),
+
+    // Related objects plank companion.
+    GraphBuilder.createExtension({
+      id: 'related',
+      match: NodeMatcher.whenEchoObjectMatches,
+      connector: (node) =>
+        Effect.succeed([
+          AppNode.makeCompanion({
+            id: linkedSegment('related'),
+            label: ['companion-related.label', { ns: meta.id }],
+            icon: 'ph--graph--regular',
+            data: 'related',
+            position: 'last',
+          }),
+        ]),
+    }),
+
+    // View selected objects companion.
+    GraphBuilder.createExtension({
+      id: 'selectedObjects',
+      match: (node) => {
+        if (!Obj.isObject(node.data)) {
+          return Option.none();
+        }
+
+        const type = Obj.getType(node.data);
+        const path = type
+          ? ViewAnnotation.get(Type.getSchema(type)).pipe(Option.getOrElse(() => [] as EchoViewRefPath))
+          : [];
+        const isEchoViewBacked = type && path.length > 0 ? ViewAnnotation.hasRefAlongPath(node.data, path) : false;
+
+        if (!isEchoViewBacked) {
+          return Option.none();
+        }
+
+        return Option.some(node);
+      },
+      connector: (node) =>
+        Effect.succeed([
+          AppNode.makeCompanion({
+            id: linkedSegment('selected-objects'),
+            label: ['companion-selected-objects.label', { ns: meta.id }],
+            icon: 'ph--tree-view--regular',
+            data: 'selected-objects',
+          }),
+        ]),
+    }),
+  ]);
+});