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

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

@@ -6,29 +6,36 @@ import * as Effect from 'effect/Effect';
 import * as Option from 'effect/Option';
 
 import { Capabilities, Capability } from '@dxos/app-framework';
-import { AppCapabilities, LayoutOperation, Segments, getObjectPathFromObject } from '@dxos/app-toolkit';
-import { SpaceState, getSpace, isSpace } from '@dxos/client/echo';
-import { Collection, Obj, Type } from '@dxos/echo';
+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 { Operation } from '@dxos/operation';
 import { CreateAtom, Graph, GraphBuilder, Node } from '@dxos/plugin-graph';
 import { isNonNullable } from '@dxos/util';
 
-import { meta } from '../../../meta';
-import { SpaceCapabilities, SpaceOperation } from '../../../types';
+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,
-  type MetadataResolver,
   REMOVE_FROM_COLLECTION_LABEL,
   createObjectNode,
   getCollectionGraphNodePartials,
   getDynamicLabel,
-  whenSpace,
 } from './shared';
 
 //
@@ -43,55 +50,52 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
 }) {
   const capabilities = yield* Capability.Service;
 
-  const resolve = (get: any) => (typename: string) =>
-    capabilities.getAll(AppCapabilities.Metadata).find(({ id }) => id === typename)?.metadata ?? {};
-
   return yield* Effect.all([
     // Collections section virtual node under each space.
     GraphBuilder.createExtension({
-      id: `${meta.id}.collections-section`,
-      match: whenSpace,
+      id: 'collectionsSection',
+      match: AppNodeMatcher.whenSpace,
       connector: (space, get) => {
         const spaceState = get(CreateAtom.fromObservable(space.state));
         if (spaceState !== SpaceState.SPACE_READY) {
           return Effect.succeed([]);
         }
 
-        const propertiesSnapshot = get(AtomObj.make(space.properties));
-        const collectionRef = propertiesSnapshot[Collection.Collection.typename] as any;
+        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({ collection: rootCollection, db: space.db, resolve: resolve(get) })
+          ? 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 }],
+              label: ['collections-section.label', { ns: meta.id }],
               icon: 'ph--folder--regular',
-              iconHue: 'neutral',
+              iconHue: 'amber',
               role: 'branch',
-              position: 'hoist',
+              position: 'first',
               testId: 'spacePlugin.collectionsSection',
               draggable: false,
               droppable: false,
               space,
               ...collectionPartials,
             },
-          },
+          }),
         ]);
       },
     }),
 
     // Root collection objects under the Collections virtual node.
     GraphBuilder.createExtension({
-      id: `${meta.id}.collections`,
+      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();
@@ -100,8 +104,8 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
         const ephemeralAtom = capabilities.get(SpaceCapabilities.EphemeralState);
         const ephemeralState = get(ephemeralAtom);
 
-        const propertiesSnapshot = get(AtomObj.make(space.properties));
-        const collectionRef = propertiesSnapshot[Collection.Collection.typename] as any;
+        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([]);
@@ -122,7 +126,6 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
               createObjectNode({
                 db: space.db,
                 object,
-                resolve: resolve(get),
                 navigable: ephemeralState.navigableCollections,
                 parentCollection: collectionRef?.target,
               }),
@@ -134,12 +137,12 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
 
     // Children of Collection.Collection nodes.
     GraphBuilder.createExtension({
-      id: `${meta.id}.objects`,
+      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 space = getSpace(collection);
+        const db = Obj.getDatabase(collection);
 
         const collectionSnapshot = get(AtomObj.make(collection));
         const refs = collectionSnapshot.objects ?? [];
@@ -155,11 +158,10 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
           objects
             .map(
               (object: Obj.Unknown) =>
-                space &&
+                db &&
                 createObjectNode({
                   object,
-                  db: space.db,
-                  resolve: resolve(get),
+                  db,
                   navigable: ephemeralState.navigableCollections,
                   parentCollection: collection,
                 }),
@@ -173,15 +175,17 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
 
     // Object actions.
     GraphBuilder.createExtension({
-      id: `${meta.id}.object-actions`,
+      id: 'objectActions',
       match: (node) => {
-        const space = getSpace(node.data);
-        return space && Obj.isObject(node.data) && Obj.getTypename(node.data) === node.type
-          ? Option.some({ space, object: node.data, nodeId: node.id })
+        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: ({ space, object, nodeId }, get) => {
-        const deletable = !Obj.instanceOf(Type.PersistentType, object);
+      actions: ({ object, nodeId }, get) => {
+        const deletable = !Type.isType(object);
 
         const [appGraph] = get(capabilities.atom(AppCapabilities.AppGraph));
         const ephemeralAtom = capabilities.get(SpaceCapabilities.EphemeralState);
@@ -200,7 +204,6 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
           constructObjectActions({
             object,
             nodeId,
-            resolve: resolve(get),
             deletable,
             navigable: ephemeralState.navigableCollections,
             shareableLinkOrigin,
@@ -220,7 +223,6 @@ export const createCollectionExtensions = Effect.fnUntraced(function* ({
 const constructObjectActions = ({
   object,
   nodeId,
-  resolve,
   deletable = true,
   navigable = false,
   shareableLinkOrigin,
@@ -228,7 +230,6 @@ const constructObjectActions = ({
 }: {
   object: Obj.Unknown;
   nodeId: string;
-  resolve: MetadataResolver;
   shareableLinkOrigin: string;
   deletable?: boolean;
   navigable?: boolean;
@@ -242,9 +243,8 @@ const constructObjectActions = ({
   const actions: Node.NodeArg<Node.ActionData<Operation.Service | Capability.Service>>[] = [
     ...(Obj.instanceOf(Collection.Collection, object)
       ? [
-          {
+          Node.makeAction({
             id: SpaceOperation.OpenCreateObject.meta.key,
-            type: Node.ActionType,
             data: () => Operation.invoke(SpaceOperation.OpenCreateObject, { target: object, targetNodeId: nodeId }),
             properties: {
               label: CREATE_OBJECT_IN_COLLECTION_LABEL,
@@ -252,26 +252,24 @@ const constructObjectActions = ({
               disposition: 'list-item-primary',
               testId: 'spacePlugin.createObject',
             },
-          },
+          }),
         ]
       : []),
-    {
+    Node.makeAction({
       id: SpaceOperation.RenameObject.meta.key,
-      type: Node.ActionType,
       data: (params?: Node.InvokeProps) =>
         Operation.invoke(SpaceOperation.RenameObject, { object, caller: `${params?.caller}:${params?.parent?.id}` }),
       properties: {
-        label: getDynamicLabel('rename object label', typename, { defaultValue: 'Rename' }),
+        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)
       ? [
-          {
-            id: 'remove-from-collection',
-            type: Node.ActionType,
+          Node.makeAction({
+            id: 'removeFromCollection',
             data: () =>
               Effect.gen(function* () {
                 const index = parentCollection.objects.findIndex((ref: any) => ref.target === object);
@@ -279,8 +277,8 @@ const constructObjectActions = ({
                   const layout = yield* Capabilities.getAtomValue(AppCapabilities.Layout);
                   const isActive = layout.active.includes(nodeId);
 
-                  Obj.change(parentCollection, (mutable) => {
-                    mutable.objects.splice(index, 1);
+                  Obj.update(parentCollection, (parentCollection) => {
+                    parentCollection.objects.splice(index, 1);
                   });
 
                   if (isActive) {
@@ -296,12 +294,11 @@ const constructObjectActions = ({
               disposition: 'list-item',
               testId: 'spacePlugin.removeFromCollection',
             },
-          },
+          }),
         ]
       : []),
-    {
+    Node.makeAction({
       id: SpaceOperation.RemoveObjects.meta.key,
-      type: Node.ActionType,
       data: () =>
         Operation.invoke(SpaceOperation.RemoveObjects, {
           objects: [object],
@@ -314,16 +311,15 @@ const constructObjectActions = ({
         disabled: !deletable,
         testId: 'spacePlugin.deleteObject',
       },
-    },
+    }),
     ...(navigable || !Obj.instanceOf(Collection.Collection, object)
       ? [
-          {
-            id: 'copy-link',
-            type: Node.ActionType,
+          Node.makeAction({
+            id: 'copyLink',
             data: () =>
               Effect.promise(async () => {
-                const url = `${shareableLinkOrigin}/${db.spaceId}/${Obj.getDXN(object).toString()}`;
-                await navigator.clipboard.writeText(url);
+                const url = new URL(toUrlPath(nodeId), shareableLinkOrigin);
+                await navigator.clipboard.writeText(url.toString());
               }),
             properties: {
               label: COPY_LINK_LABEL,
@@ -331,12 +327,11 @@ const constructObjectActions = ({
               disposition: 'list-item',
               testId: 'spacePlugin.copyLink',
             },
-          },
+          }),
         ]
       : []),
-    {
+    Node.makeAction({
       id: LayoutOperation.Expose.meta.key,
-      type: Node.ActionType,
       data: () => Operation.invoke(LayoutOperation.Expose, { subject: getObjectPathFromObject(object) }),
       properties: {
         label: EXPOSE_OBJECT_LABEL,
@@ -344,7 +339,7 @@ const constructObjectActions = ({
         disposition: 'heading-list-item',
         testId: 'spacePlugin.exposeObject',
       },
-    },
+    }),
   ];
 
   return actions;

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

@@ -5,16 +5,17 @@
 import * as Effect from 'effect/Effect';
 import * as Option from 'effect/Option';
 
-import { COMPANION_PREFIX } from '@dxos/app-toolkit';
-import { Obj } from '@dxos/echo';
-import { PLANK_COMPANION_TYPE } from '@dxos/plugin-deck/types';
+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';
+import { meta } from '#meta';
 
 //
 // Extension Factory
@@ -25,38 +26,51 @@ export const createCompanionExtensions = Effect.fnUntraced(function* () {
   return yield* Effect.all([
     // Object settings plank companion.
     GraphBuilder.createExtension({
-      id: `${meta.id}.settings`,
+      id: 'settings',
       match: NodeMatcher.whenEchoObjectMatches,
       connector: (node) =>
         Effect.succeed([
-          {
-            id: `${COMPANION_PREFIX}settings`,
-            type: PLANK_COMPANION_TYPE,
-            data: 'settings',
-            properties: {
-              label: ['object settings label', { ns: meta.id }],
-              icon: 'ph--sliders--regular',
-              disposition: 'hidden',
-              position: 'fallback',
-            },
-          },
+          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: `${meta.id}.selected-objects`,
+      id: 'selectedObjects',
       match: (node) => {
         if (!Obj.isObject(node.data)) {
           return Option.none();
         }
 
-        const schema = Obj.getSchema(node.data);
-        const isView = Option.fromNullable(schema).pipe(
-          Option.flatMap((candidate) => ViewAnnotation.get(candidate)),
-          Option.getOrElse(() => false),
-        );
-        if (!isView) {
+        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();
         }
 
@@ -64,16 +78,12 @@ export const createCompanionExtensions = Effect.fnUntraced(function* () {
       },
       connector: (node) =>
         Effect.succeed([
-          {
-            id: `${COMPANION_PREFIX}selected-objects`,
-            type: PLANK_COMPANION_TYPE,
+          AppNode.makeCompanion({
+            id: linkedSegment('selected-objects'),
+            label: ['companion-selected-objects.label', { ns: meta.id }],
+            icon: 'ph--tree-view--regular',
             data: 'selected-objects',
-            properties: {
-              label: ['companion selected objects label', { ns: meta.id }],
-              icon: 'ph--tree-view--regular',
-              disposition: 'hidden',
-            },
-          },
+          }),
         ]),
     }),
   ]);