@dxos/plugin-space 0.8.4-main.84f28bd → 0.8.4-main.ae835ea

package/src/util.tsx

@@ -3,40 +3,40 @@
 //
 
 import { Rx } from '@effect-rx/rx-react';
-import { pipe } from 'effect';
+import * as Function from 'effect/Function';
 
-import { chain, createIntent, LayoutAction, type PromiseIntentDispatcher } from '@dxos/app-framework';
+import { LayoutAction, type PromiseIntentDispatcher, chain, createIntent } from '@dxos/app-framework';
 import { Obj, Ref, Type } from '@dxos/echo';
-import { EXPANDO_TYPENAME } from '@dxos/echo-schema';
+import { type AnyEchoObject, EXPANDO_TYPENAME } from '@dxos/echo/internal';
 import { invariant } from '@dxos/invariant';
 import { Migrations } from '@dxos/migrations';
 import {
   ACTION_GROUP_TYPE,
   ACTION_TYPE,
-  type ReadableGraph,
   type ActionData,
   type InvokeParams,
   type Node,
   type NodeArg,
+  type ReadableGraph,
   isGraphNode,
 } from '@dxos/plugin-graph';
-import { fullyQualifiedId, getSpace, type QueryResult, SpaceState, type Space, isSpace } from '@dxos/react-client/echo';
+import { type QueryResult, type Space, SpaceState, fullyQualifiedId, getSpace, isSpace } from '@dxos/react-client/echo';
 import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
 import { type TreeData } from '@dxos/react-ui-list';
-import { DataType } from '@dxos/schema';
+import { DataType, getTypenameFromQuery } from '@dxos/schema';
 
-import { SPACE_PLUGIN } from './meta';
-import { SpaceAction, SPACE_TYPE, type ObjectForm } from './types';
+import { meta } from './meta';
+import { type ObjectForm, SPACE_TYPE, SpaceAction } from './types';
 
-export const SPACES = `${SPACE_PLUGIN}-spaces`;
-export const COMPOSER_SPACE_LOCK = 'dxos.org/plugin/space/lock';
+export const SPACES = `${meta.id}-spaces`;
+export const COMPOSER_SPACE_LOCK = `${meta.id}/lock`;
 // TODO(wittjosiah): Remove.
 export const SHARED = 'shared-spaces';
 
 /**
  * Convert a query result to an Rx value of the objects.
  */
-export const rxFromQuery = <T extends Obj.Any>(query: QueryResult<T>): Rx.Rx<T[]> => {
+export const rxFromQuery = <T extends AnyEchoObject>(query: QueryResult<T>): Rx.Rx<T[]> => {
   return Rx.make((get) => {
     const unsubscribe = query.subscribe((result) => {
       get.setSelf(result.objects);
@@ -57,8 +57,8 @@ export const getSpaceDisplayName = (
     : namesCache[space.id]
       ? namesCache[space.id]
       : personal
-        ? ['personal space label', { ns: SPACE_PLUGIN }]
-        : ['unnamed space label', { ns: SPACE_PLUGIN }];
+        ? ['personal space label', { ns: meta.id }]
+        : ['unnamed space label', { ns: meta.id }];
 };
 
 const getCollectionGraphNodePartials = ({
@@ -145,16 +145,17 @@ const getQueryCollectionNodePartials = ({
   space: Space;
   resolve: (typename: string) => Record<string, any>;
 }) => {
+  const typename = getTypenameFromQuery(collection.query);
+  const metadata = typename ? resolve(typename) : {};
   return {
-    icon: collection.query.typename && resolve(collection.query.typename)?.icon,
+    icon: metadata.icon,
+    iconHue: metadata.iconHue,
     acceptPersistenceClass: new Set(['echo']),
     acceptPersistenceKey: new Set([space.id]),
     role: 'branch',
     canDrop: (source: TreeData) => {
       return (
-        isGraphNode(source.item) &&
-        Obj.isObject(source.item.data) &&
-        Obj.getTypename(source.item.data) === collection.query.typename
+        isGraphNode(source.item) && Obj.isObject(source.item.data) && Obj.getTypename(source.item.data) === typename
       );
     },
     onTransferStart: (child: Node<Obj.Any>, index?: number) => {
@@ -166,6 +167,32 @@ const getQueryCollectionNodePartials = ({
   };
 };
 
+const getSchemaGraphNodePartials = () => {
+  return {
+    role: 'branch',
+    canDrop: () => false,
+  };
+};
+
+const getViewGraphNodePartials = ({
+  view,
+  resolve,
+}: {
+  view: DataType.View;
+  resolve: (typename: string) => Record<string, any>;
+}) => {
+  const presentation = view.presentation.target;
+  const typename = presentation ? Obj.getTypename(presentation) : undefined;
+  const metadata = typename ? resolve(typename) : {};
+
+  return {
+    label: view.name || ['object name placeholder', { ns: typename, default: 'New view' }],
+    icon: metadata.icon,
+    iconHue: metadata.iconHue,
+    canDrop: () => false,
+  };
+};
+
 const checkPendingMigration = (space: Space) => {
   return (
     space.state.get() === SpaceState.SPACE_REQUIRES_MIGRATION ||
@@ -210,6 +237,7 @@ export const constructSpaceNode = ({
         space.state.get() === SpaceState.SPACE_READY && space.properties.icon
           ? `ph--${space.properties.icon}--regular`
           : undefined,
+      iconHue: space.state.get() === SpaceState.SPACE_READY && space.properties.iconHue,
       disabled: !navigable || space.state.get() !== SpaceState.SPACE_READY || hasPendingMigration,
       testId: 'spacePlugin.space',
       canDrop: (source: TreeData) => {
@@ -220,40 +248,40 @@ export const constructSpaceNode = ({
     nodes: [
       {
         id: `settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
-        type: `${SPACE_PLUGIN}/settings`,
+        type: `${meta.id}/settings`,
         data: null,
         properties: {
-          label: ['settings panel label', { ns: SPACE_PLUGIN }],
+          label: ['settings panel label', { ns: meta.id }],
           icon: 'ph--faders--regular',
           disposition: 'alternate-tree',
         },
         nodes: [
           {
             id: `properties-settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
-            type: `${SPACE_PLUGIN}/properties`,
-            data: `${SPACE_PLUGIN}/properties`,
+            type: `${meta.id}/properties`,
+            data: `${meta.id}/properties`,
             properties: {
-              label: ['space settings properties label', { ns: SPACE_PLUGIN }],
+              label: ['space settings properties label', { ns: meta.id }],
               icon: 'ph--sliders--regular',
               position: 'hoist',
             },
           },
           {
             id: `members-settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
-            type: `${SPACE_PLUGIN}/members`,
-            data: `${SPACE_PLUGIN}/members`,
+            type: `${meta.id}/members`,
+            data: `${meta.id}/members`,
             properties: {
-              label: ['members panel label', { ns: SPACE_PLUGIN }],
+              label: ['members panel label', { ns: meta.id }],
               icon: 'ph--users--regular',
               position: 'hoist',
             },
           },
           {
             id: `schema-settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
-            type: `${SPACE_PLUGIN}/schema`,
-            data: `${SPACE_PLUGIN}/schema`,
+            type: `${meta.id}/schema`,
+            data: `${meta.id}/schema`,
             properties: {
-              label: ['space settings schema label', { ns: SPACE_PLUGIN }],
+              label: ['space settings schema label', { ns: meta.id }],
               icon: 'ph--shapes--regular',
             },
           },
@@ -287,7 +315,7 @@ export const constructSpaceActions = ({
         await dispatch(createIntent(SpaceAction.Migrate, { space }));
       },
       properties: {
-        label: ['migrate space label', { ns: SPACE_PLUGIN }],
+        label: ['migrate space label', { ns: meta.id }],
         icon: 'ph--database--regular',
         disposition: 'list-item-primary',
         disabled: migrating || Migrations.running(space),
@@ -304,7 +332,7 @@ export const constructSpaceActions = ({
           await dispatch(createIntent(SpaceAction.OpenCreateObject, { target: space }));
         },
         properties: {
-          label: ['create object in space label', { ns: SPACE_PLUGIN }],
+          label: ['create object in space label', { ns: meta.id }],
           icon: 'ph--plus--regular',
           disposition: 'item',
           testId: 'spacePlugin.createObject',
@@ -317,7 +345,7 @@ export const constructSpaceActions = ({
           await dispatch(createIntent(SpaceAction.Rename, { space, caller: params?.caller }));
         },
         properties: {
-          label: ['rename space label', { ns: SPACE_PLUGIN }],
+          label: ['rename space label', { ns: meta.id }],
           icon: 'ph--pencil-simple-line--regular',
           keyBinding: {
             macos: 'shift+F6',
@@ -331,34 +359,137 @@ export const constructSpaceActions = ({
   return actions;
 };
 
+export const createStaticSchemaNode = ({ schema, space }: { schema: Type.Obj.Any; space: Space }) => {
+  return {
+    id: `${space.id}/${Type.getTypename(schema)}`,
+    type: `${meta.id}/static-schema`,
+    data: schema,
+    properties: {
+      label: ['typename label', { ns: Type.getTypename(schema), default: Type.getTypename(schema) }],
+      icon: 'ph--database--regular',
+      iconHue: 'green',
+      role: 'branch',
+      selectable: false,
+      canDrop: () => false,
+      space,
+    },
+  };
+};
+
+export const createStaticSchemaActions = ({
+  schema,
+  space,
+  dispatch,
+  deletable,
+}: {
+  schema: Type.Obj.Any;
+  space: Space;
+  dispatch: PromiseIntentDispatcher;
+  deletable: boolean;
+}) => {
+  const getId = (id: string) => `${space.id}/${Type.getTypename(schema)}/${id}`;
+
+  const actions: NodeArg<ActionData>[] = [
+    {
+      id: getId(SpaceAction.AddObject._tag),
+      type: ACTION_TYPE,
+      data: async () => {
+        await dispatch(
+          createIntent(SpaceAction.OpenCreateObject, {
+            target: space,
+            views: true,
+            initialFormValues: { typename: Type.getTypename(schema) },
+          }),
+        );
+      },
+      properties: {
+        label: ['add view to schema label', { ns: Type.getTypename(DataType.StoredSchema) }],
+        icon: 'ph--plus--regular',
+        disposition: 'list-item-primary',
+        testId: 'spacePlugin.addViewToSchema',
+      },
+    },
+    {
+      id: getId(SpaceAction.RenameObject._tag),
+      type: ACTION_TYPE,
+      data: async (params?: InvokeParams) => {
+        throw new Error('Not implemented');
+      },
+      properties: {
+        label: ['rename object label', { ns: Type.getTypename(DataType.StoredSchema) }],
+        icon: 'ph--pencil-simple-line--regular',
+        disabled: true,
+        disposition: 'list-item',
+        testId: 'spacePlugin.renameObject',
+      },
+    },
+    {
+      id: getId(SpaceAction.RemoveObjects._tag),
+      type: ACTION_TYPE,
+      data: async () => {
+        const index = space.properties.staticRecords.findIndex(
+          (typename: string) => typename === Type.getTypename(schema),
+        );
+        if (index > -1) {
+          space.properties.staticRecords.splice(index, 1);
+        }
+      },
+      properties: {
+        label: ['delete object label', { ns: Type.getTypename(DataType.StoredSchema) }],
+        icon: 'ph--trash--regular',
+        disposition: 'list-item',
+        disabled: !deletable,
+        testId: 'spacePlugin.deleteObject',
+      },
+    },
+  ];
+
+  return actions;
+};
+
 export const createObjectNode = ({
   space,
   object,
+  disposition,
   droppable = true,
   navigable = false,
   resolve,
 }: {
   space: Space;
   object: Obj.Any;
+  disposition?: string;
   droppable?: boolean;
   navigable?: boolean;
   resolve: (typename: string) => Record<string, any>;
 }) => {
   const type = Obj.getTypename(object);
   if (!type) {
-    return undefined;
+    return null;
   }
 
   const metadata = resolve(type);
-  if (Object.keys(metadata).length === 0) {
-    return undefined;
-  }
-
   const partials = Obj.instanceOf(DataType.Collection, object)
     ? getCollectionGraphNodePartials({ collection: object, space, resolve })
     : Obj.instanceOf(DataType.QueryCollection, object)
       ? getQueryCollectionNodePartials({ collection: object, space, resolve })
-      : metadata.graphProps;
+      : Obj.instanceOf(DataType.StoredSchema, object)
+        ? getSchemaGraphNodePartials()
+        : Obj.instanceOf(DataType.View, object)
+          ? getViewGraphNodePartials({ view: object, resolve })
+          : metadata.graphProps;
+
+  // TODO(wittjosiah): Obj.getLabel isn't triggering reactivity in some cases.
+  //   e.g., create new collection with no name and rename it.
+  const label = (object as any).name ||
+    Obj.getLabel(object) ||
+    // TODO(wittjosiah): Remove metadata labels.
+    metadata.label?.(object) || ['object name placeholder', { ns: type, default: 'New item' }];
+
+  const selectable =
+    (!Obj.instanceOf(DataType.StoredSchema, object) &&
+      !Obj.instanceOf(DataType.QueryCollection, object) &&
+      !Obj.instanceOf(DataType.Collection, object)) ||
+    (navigable && Obj.instanceOf(DataType.Collection, object));
 
   return {
     id: fullyQualifiedId(object),
@@ -366,13 +497,14 @@ export const createObjectNode = ({
     cacheable: ['label', 'icon', 'role'],
     data: object,
     properties: {
-      // TODO(burdon): Use annotation to get the name field.
-      label: metadata.label?.(object) ||
-        (object as any).name || ['object name placeholder', { ns: type, default: 'New object' }],
+      label,
       icon: metadata.icon ?? 'ph--placeholder--regular',
+      iconHue: metadata.iconHue,
+      disposition,
       testId: 'spacePlugin.object',
       persistenceClass: 'echo',
       persistenceKey: space?.id,
+      selectable,
       canDrop: (source: TreeData) => {
         return droppable && isGraphNode(source.item) && Obj.isObject(source.item.data);
       },
@@ -386,21 +518,26 @@ export const constructObjectActions = ({
   graph,
   dispatch,
   objectForms,
+  deletable = true,
   navigable = false,
 }: {
   object: Obj.Any;
   graph: ReadableGraph;
   dispatch: PromiseIntentDispatcher;
   objectForms: ObjectForm<any>[];
+  deletable?: boolean;
   navigable?: boolean;
 }) => {
   const space = getSpace(object);
   invariant(space, 'Space not found');
+  const typename = Obj.getTypename(object);
+  invariant(typename, 'Object has no typename');
+
   const getId = (id: string) => `${id}/${fullyQualifiedId(object)}`;
 
   const queryCollection = Obj.instanceOf(DataType.QueryCollection, object) ? object : undefined;
   const matchingObjectForm = queryCollection
-    ? objectForms.find((form) => Type.getTypename(form.objectSchema) === queryCollection.query.typename)
+    ? objectForms.find((form) => Type.getTypename(form.objectSchema) === getTypenameFromQuery(queryCollection.query))
     : undefined;
 
   const actions: NodeArg<ActionData>[] = [
@@ -413,7 +550,7 @@ export const constructObjectActions = ({
               await dispatch(createIntent(SpaceAction.OpenCreateObject, { target: object }));
             },
             properties: {
-              label: ['create object in collection label', { ns: SPACE_PLUGIN }],
+              label: ['create object in collection label', { ns: meta.id }],
               icon: 'ph--plus--regular',
               disposition: 'list-item-primary',
               testId: 'spacePlugin.createObject',
@@ -421,6 +558,29 @@ export const constructObjectActions = ({
           },
         ]
       : []),
+    ...(Obj.instanceOf(DataType.StoredSchema, object)
+      ? [
+          {
+            id: getId(SpaceAction.AddObject._tag),
+            type: ACTION_TYPE,
+            data: async () => {
+              await dispatch(
+                createIntent(SpaceAction.OpenCreateObject, {
+                  target: space,
+                  views: true,
+                  initialFormValues: { typename: object.typename },
+                }),
+              );
+            },
+            properties: {
+              label: ['add view to schema label', { ns: Type.getTypename(DataType.StoredSchema) }],
+              icon: 'ph--plus--regular',
+              disposition: 'list-item-primary',
+              testId: 'spacePlugin.addViewToSchema',
+            },
+          },
+        ]
+      : []),
     ...(matchingObjectForm
       ? [
           {
@@ -431,12 +591,12 @@ export const constructObjectActions = ({
                 await dispatch(
                   createIntent(SpaceAction.OpenCreateObject, {
                     target: space,
-                    typename: queryCollection?.query.typename,
+                    typename: queryCollection ? getTypenameFromQuery(queryCollection.query) : undefined,
                   }),
                 );
               } else {
                 await dispatch(
-                  pipe(
+                  Function.pipe(
                     matchingObjectForm.getIntent({}, { space }),
                     chain(SpaceAction.AddObject, { target: space, hidden: true }),
                     chain(LayoutAction.Open, { part: 'main' }),
@@ -445,7 +605,7 @@ export const constructObjectActions = ({
               }
             },
             properties: {
-              label: ['create object in smart collection label', { ns: SPACE_PLUGIN }],
+              label: ['create object in smart collection label', { ns: meta.id }],
               icon: 'ph--plus--regular',
               disposition: 'list-item-primary',
               testId: 'spacePlugin.createObject',
@@ -460,10 +620,7 @@ export const constructObjectActions = ({
         await dispatch(createIntent(SpaceAction.RenameObject, { object, caller: params?.caller }));
       },
       properties: {
-        label: [
-          Obj.instanceOf(DataType.Collection, object) ? 'rename collection label' : 'rename object label',
-          { ns: SPACE_PLUGIN },
-        ],
+        label: ['rename object label', { ns: typename }],
         icon: 'ph--pencil-simple-line--regular',
         disposition: 'list-item',
         // TODO(wittjosiah): Not working.
@@ -483,18 +640,19 @@ export const constructObjectActions = ({
         await dispatch(createIntent(SpaceAction.RemoveObjects, { objects: [object], target: collection }));
       },
       properties: {
-        label: [
-          Obj.instanceOf(DataType.Collection, object) ? 'delete collection label' : 'delete object label',
-          { ns: SPACE_PLUGIN },
-        ],
+        label: ['delete object label', { ns: typename }],
         icon: 'ph--trash--regular',
         disposition: 'list-item',
+        disabled: !deletable,
         // TODO(wittjosiah): This is a browser shortcut.
         // keyBinding: object instanceof CollectionType ? undefined : 'shift+meta+Backspace',
         testId: 'spacePlugin.deleteObject',
       },
     },
-    ...(navigable || (!Obj.instanceOf(DataType.Collection, object) && !Obj.instanceOf(DataType.QueryCollection, object))
+    ...(navigable ||
+    (!Obj.instanceOf(DataType.Collection, object) &&
+      !Obj.instanceOf(DataType.QueryCollection, object) &&
+      !Obj.instanceOf(DataType.StoredSchema, object))
       ? [
           {
             id: getId('copy-link'),
@@ -504,7 +662,7 @@ export const constructObjectActions = ({
               await navigator.clipboard.writeText(url);
             },
             properties: {
-              label: ['copy link label', { ns: SPACE_PLUGIN }],
+              label: ['copy link label', { ns: meta.id }],
               icon: 'ph--link--regular',
               disposition: 'list-item',
               testId: 'spacePlugin.copyLink',
@@ -520,7 +678,7 @@ export const constructObjectActions = ({
         await dispatch(createIntent(LayoutAction.Expose, { part: 'navigation', subject: fullyQualifiedId(object) }));
       },
       properties: {
-        label: ['expose object label', { ns: SPACE_PLUGIN }],
+        label: ['expose object label', { ns: meta.id }],
         icon: 'ph--eye--regular',
         disposition: 'heading-list-item',
         testId: 'spacePlugin.exposeObject',
@@ -564,7 +722,7 @@ export const cloneObject = async (
   newSpace: Space,
 ): Promise<Type.Expando> => {
   const schema = Obj.getSchema(object);
-  const typename = schema ? Type.getTypename(schema) ?? EXPANDO_TYPENAME : EXPANDO_TYPENAME;
+  const typename = schema ? (Type.getTypename(schema) ?? EXPANDO_TYPENAME) : EXPANDO_TYPENAME;
   const metadata = resolve(typename);
   const serializer = metadata.serializer;
   invariant(serializer, `No serializer for type: ${typename}`);