@dxos/plugin-space 0.8.3-main.672df60 → 0.8.3-staging.0fa589b

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

@@ -6,26 +6,19 @@ import { Rx } from '@effect-rx/rx-react';
 import { Array, Option, pipe } from 'effect';
 
 import { Capabilities, contributes, createIntent, type PluginContext } from '@dxos/app-framework';
-import {
-  Expando,
-  Filter,
-  getSpace,
-  isEchoObject,
-  SpaceState,
-  type Space,
-  isSpace,
-  type QueryResult,
-} from '@dxos/client/echo';
+import { getSpace, SpaceState, type Space, isSpace, type QueryResult } from '@dxos/client/echo';
+import { Filter, Obj, Query, Type } from '@dxos/echo';
 import { log } from '@dxos/log';
 import { ClientCapabilities } from '@dxos/plugin-client';
 import { PLANK_COMPANION_TYPE, ATTENDABLE_PATH_SEPARATOR } from '@dxos/plugin-deck/types';
 import { createExtension, rxFromObservable, ROOT_ID, rxFromSignal } from '@dxos/plugin-graph';
+import { DataType } from '@dxos/schema';
 import { isNonNullable } from '@dxos/util';
 
 import { SpaceCapabilities } from './capabilities';
 import { getActiveSpace } from '../hooks';
 import { SPACE_PLUGIN } from '../meta';
-import { CollectionType, SPACE_TYPE, SpaceAction, type SpaceSettingsProps } from '../types';
+import { SPACE_TYPE, SpaceAction, type SpaceSettingsProps } from '../types';
 import {
   constructObjectActions,
   constructSpaceActions,
@@ -37,6 +30,7 @@ import {
 } from '../util';
 
 export default (context: PluginContext) => {
+  // TODO(wittjosiah): Make reactive.
   const resolve = (typename: string) =>
     context.getCapabilities(Capabilities.Metadata).find(({ id }) => id === typename)?.metadata ?? {};
 
@@ -67,7 +61,7 @@ export default (context: PluginContext) => {
 
         const {
           objects: [spacesOrder],
-        } = await client.spaces.default.db.query(Filter.type(Expando, { key: SHARED })).run();
+        } = await client.spaces.default.db.query(Filter.type(Type.Expando, { key: SHARED })).run();
         if (spacesOrder) {
           spacesOrder.order = nextOrder.map(({ id }) => id);
         } else {
@@ -175,7 +169,7 @@ export default (context: PluginContext) => {
     createExtension({
       id: SPACES,
       connector: (node) => {
-        let query: QueryResult<Expando> | undefined;
+        let query: QueryResult<Type.Expando> | undefined;
         return Rx.make((get) =>
           pipe(
             get(node),
@@ -200,7 +194,7 @@ export default (context: PluginContext) => {
               // TODO(wittjosiah): During client reset, accessing default space throws.
               try {
                 if (!query) {
-                  query = client.spaces.default.db.query(Filter.type(Expando, { key: SHARED }));
+                  query = client.spaces.default.db.query(Filter.type(Type.Expando, { key: SHARED }));
                 }
                 const [spacesOrder] = get(rxFromQuery(query));
                 return get(
@@ -321,14 +315,16 @@ export default (context: PluginContext) => {
             ),
             Option.map((space) => {
               const state = context.getCapability(SpaceCapabilities.State);
-
               const spaceState = get(rxFromObservable(space.state));
               if (spaceState !== SpaceState.SPACE_READY) {
                 return [];
               }
 
               const collection = get(
-                rxFromSignal(() => space.properties[CollectionType.typename]?.target as CollectionType | undefined),
+                rxFromSignal(
+                  () =>
+                    space.properties[Type.getTypename(DataType.Collection)]?.target as DataType.Collection | undefined,
+                ),
               );
               if (!collection) {
                 return [];
@@ -342,8 +338,8 @@ export default (context: PluginContext) => {
                     Array.filter(isNonNullable),
                     Array.map((object) =>
                       createObjectNode({
-                        object,
                         space,
+                        object,
                         resolve,
                         navigable: state.navigableCollections,
                       }),
@@ -365,7 +361,9 @@ export default (context: PluginContext) => {
         Rx.make((get) =>
           pipe(
             get(node),
-            Option.flatMap((node) => (node.data instanceof CollectionType ? Option.some(node.data) : Option.none())),
+            Option.flatMap((node) =>
+              Obj.instanceOf(DataType.Collection, node.data) ? Option.some(node.data) : Option.none(),
+            ),
             Option.map((collection) => {
               const state = context.getCapability(SpaceCapabilities.State);
               const space = getSpace(collection);
@@ -427,6 +425,60 @@ export default (context: PluginContext) => {
       // },
     }),
 
+    // Create nodes for objects in a query collection.
+    createExtension({
+      id: `${SPACE_PLUGIN}/query-collection-objects`,
+      connector: (node) => {
+        let query: QueryResult<Type.Expando> | undefined;
+        return Rx.make((get) =>
+          pipe(
+            get(node),
+            Option.flatMap((node) =>
+              Obj.instanceOf(DataType.QueryCollection, node.data) ? Option.some(node.data) : Option.none(),
+            ),
+            Option.flatMap((collection) => {
+              const space = getSpace(collection);
+              return collection.query.typename && space
+                ? Option.some({ typename: collection.query.typename, space })
+                : Option.none();
+            }),
+            Option.map(({ typename, space }) => {
+              const state = context.getCapability(SpaceCapabilities.State);
+              if (!query) {
+                query = space.db.query(
+                  Query.without(
+                    Query.select(Filter.typename(typename)),
+                    // TODO(wittjosiah): This query is broader than it should be.
+                    //   It will return all objects in the collection, not just the ones of the given type.
+                    //   However this works fine for now because this query is only used for exclusions.
+                    Query.select(Filter.typename(typename))
+                      .referencedBy(DataType.Collection, 'objects')
+                      .reference('objects'),
+                  ),
+                );
+              }
+              return get(rxFromQuery(query))
+                .map((object) =>
+                  get(
+                    rxFromSignal(() =>
+                      createObjectNode({
+                        object,
+                        space,
+                        resolve,
+                        droppable: false, // Cannot rearrange query collections.
+                        navigable: state.navigableCollections,
+                      }),
+                    ),
+                  ),
+                )
+                .filter(isNonNullable);
+            }),
+            Option.getOrElse(() => []),
+          ),
+        );
+      },
+    }),
+
     // Create collection actions and action groups.
     createExtension({
       id: `${SPACE_PLUGIN}/object-actions`,
@@ -434,11 +486,12 @@ export default (context: PluginContext) => {
         Rx.make((get) =>
           pipe(
             get(node),
-            Option.flatMap((node) => (isEchoObject(node.data) ? Option.some(node.data) : Option.none())),
+            Option.flatMap((node) => (Obj.isObject(node.data) ? Option.some(node.data) : Option.none())),
             Option.flatMap((object) => {
               const [dispatcher] = get(context.capabilities(Capabilities.IntentDispatcher));
               const [appGraph] = get(context.capabilities(Capabilities.AppGraph));
               const [state] = get(context.capabilities(SpaceCapabilities.State));
+              const objectForms = get(context.capabilities(SpaceCapabilities.ObjectForm));
 
               if (!dispatcher || !appGraph || !state) {
                 return Option.none();
@@ -447,6 +500,7 @@ export default (context: PluginContext) => {
                   object,
                   graph: appGraph.graph,
                   dispatch: dispatcher.dispatchPromise,
+                  objectForms,
                   navigable: get(rxFromSignal(() => state.navigableCollections)),
                 });
               }
@@ -464,7 +518,7 @@ export default (context: PluginContext) => {
         Rx.make((get) =>
           pipe(
             get(node),
-            Option.flatMap((node) => (isEchoObject(node.data) ? Option.some(node) : Option.none())),
+            Option.flatMap((node) => (Obj.isObject(node.data) ? Option.some(node) : Option.none())),
             Option.map((node) => [
               {
                 id: [node.id, 'settings'].join(ATTENDABLE_PATH_SEPARATOR),

package/src/capabilities/app-graph-serializer.ts

@@ -4,13 +4,16 @@
 
 import { Capabilities, contributes, createIntent, type PluginContext } from '@dxos/app-framework';
 import { isSpace } from '@dxos/client/echo';
-import { live } from '@dxos/live-object';
+import { Obj, Type } from '@dxos/echo';
+import { DataType } from '@dxos/schema';
 
 import { SPACE_PLUGIN } from '../meta';
 import translations from '../translations';
-import { CollectionType, SpaceAction, SPACE_TYPE } from '../types';
+import { SPACE_TYPE, SpaceAction } from '../types';
 import { SPACES } from '../util';
 
+const COLLECTION_TYPE = Type.getTypename(DataType.Collection);
+
 // https://stackoverflow.com/a/19016910
 const DIRECTORY_TYPE = 'text/directory';
 
@@ -43,18 +46,18 @@ export default (context: PluginContext) =>
       },
     },
     {
-      inputType: CollectionType.typename,
+      inputType: COLLECTION_TYPE,
       outputType: DIRECTORY_TYPE,
       serialize: (node) => ({
-        name: node.data.name ?? translations[0]['en-US'][CollectionType.typename]['object name placeholder'],
-        data: node.data.name ?? translations[0]['en-US'][CollectionType.typename]['object name placeholder'],
+        name: node.data.name ?? translations[0]['en-US'][COLLECTION_TYPE]['object name placeholder'],
+        data: node.data.name ?? translations[0]['en-US'][COLLECTION_TYPE]['object name placeholder'],
         type: DIRECTORY_TYPE,
       }),
       deserialize: async (data, ancestors) => {
         const space = ancestors.find(isSpace);
         const collection =
-          ancestors.findLast((ancestor) => ancestor instanceof CollectionType) ??
-          space?.properties[CollectionType.typename]?.target;
+          ancestors.findLast((ancestor) => Obj.instanceOf(DataType.Collection, ancestor)) ??
+          space?.properties[COLLECTION_TYPE]?.target;
         if (!space || !collection) {
           return;
         }
@@ -63,7 +66,7 @@ export default (context: PluginContext) =>
         const result = await dispatch(
           createIntent(SpaceAction.AddObject, {
             target: collection,
-            object: live(CollectionType, { name: data.name, objects: [], views: {} }),
+            object: Obj.make(DataType.Collection, { name: data.name, objects: [] }),
           }),
         );
 

package/src/capabilities/capabilities.ts

@@ -3,7 +3,9 @@
 //
 
 import { defineCapability, type Label } from '@dxos/app-framework';
-import { type Position, type DeepReadonly } from '@dxos/util';
+import { type Space } from '@dxos/react-client/echo';
+import { type DataType } from '@dxos/schema';
+import { type Position, type DeepReadonly, type MaybePromise } from '@dxos/util';
 
 import { SPACE_PLUGIN } from '../meta';
 import { type ObjectForm, type PluginState } from '../types';
@@ -15,5 +17,8 @@ export namespace SpaceCapabilities {
   export type SettingsSection = { id: string; label: Label; position?: Position };
   export const SettingsSection = defineCapability<SettingsSection>(`${SPACE_PLUGIN}/capability/settings-section`);
 
+  export type OnSpaceCreated = (params: { space: Space; rootCollection: DataType.Collection }) => MaybePromise<void>;
+  export const OnSpaceCreated = defineCapability<OnSpaceCreated>(`${SPACE_PLUGIN}/capability/on-space-created`);
+
   export const ObjectForm = defineCapability<ObjectForm<any>>(`${SPACE_PLUGIN}/capability/object-form`);
 }

package/src/capabilities/identity-created.ts

@@ -3,11 +3,10 @@
 //
 
 import { contributes, type PluginContext, Capabilities } from '@dxos/app-framework';
-import { live, makeRef } from '@dxos/live-object';
+import { Obj, Ref, Type } from '@dxos/echo';
 import { Migrations } from '@dxos/migrations';
 import { ClientCapabilities } from '@dxos/plugin-client';
-
-import { CollectionType } from '../types';
+import { DataType } from '@dxos/schema';
 
 export default async (context: PluginContext) => {
   const client = context.getCapability(ClientCapabilities.Client);
@@ -17,7 +16,9 @@ export default async (context: PluginContext) => {
   await defaultSpace.waitUntilReady();
 
   // Create root collection structure.
-  defaultSpace.properties[CollectionType.typename] = makeRef(live(CollectionType, { objects: [], views: {} }));
+  defaultSpace.properties[Type.getTypename(DataType.Collection)] = Ref.make(
+    Obj.make(DataType.Collection, { objects: [] }),
+  );
   if (Migrations.versionProperty) {
     defaultSpace.properties[Migrations.versionProperty] = Migrations.targetVersion;
   }

package/src/capabilities/intent-resolver.ts

@@ -6,36 +6,36 @@ import { Effect } from 'effect';
 
 import {
   Capabilities,
+  LayoutAction,
+  type PluginContext,
   contributes,
   createIntent,
   createResolver,
-  LayoutAction,
-  type PluginContext,
 } from '@dxos/app-framework';
-import { Relation } from '@dxos/echo';
-import { type Expando, getTypename, type HasId } from '@dxos/echo-schema';
+import { Obj, Ref, Relation, Type } from '@dxos/echo';
 import { invariant } from '@dxos/invariant';
-import { live, makeRef, type Live } from '@dxos/live-object';
 import { Migrations } from '@dxos/migrations';
 import { ClientCapabilities } from '@dxos/plugin-client';
 import { ObservabilityAction } from '@dxos/plugin-observability/types';
 import { EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
-import { isSpace, getSpace, SpaceState, fullyQualifiedId, isEchoObject } from '@dxos/react-client/echo';
+import { isSpace, getSpace, SpaceState, fullyQualifiedId } from '@dxos/react-client/echo';
 import { Invitation, InvitationEncoder } from '@dxos/react-client/invitations';
 import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
+import { DataType } from '@dxos/schema';
 
 import { SpaceCapabilities } from './capabilities';
 import {
+  CREATE_OBJECT_DIALOG,
   CREATE_SPACE_DIALOG,
   JOIN_DIALOG,
-  type JoinDialogProps,
+  POPOVER_RENAME_OBJECT,
   POPOVER_RENAME_SPACE,
-  CREATE_OBJECT_DIALOG,
   type CreateObjectDialogProps,
-  POPOVER_RENAME_OBJECT,
+  type JoinDialogProps,
 } from '../components';
+import { SpaceEvents } from '../events';
 import { SPACE_PLUGIN } from '../meta';
-import { CollectionAction, CollectionType, SpaceAction } from '../types';
+import { CollectionAction, SpaceAction } from '../types';
 import { cloneObject, COMPOSER_SPACE_LOCK, getNestedObjects } from '../util';
 
 // TODO(wittjosiah): Remove.
@@ -75,13 +75,19 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
           await space.internal.setEdgeReplicationPreference(EdgeReplicationSetting.ENABLED);
         }
         await space.waitUntilReady();
-        const collection = live(CollectionType, { objects: [], views: {} });
-        space.properties[CollectionType.typename] = makeRef(collection);
+        const collection = Obj.make(DataType.Collection, { objects: [] });
+        space.properties[Type.getTypename(DataType.Collection)] = Ref.make(collection);
 
         if (Migrations.versionProperty) {
           space.properties[Migrations.versionProperty] = Migrations.targetVersion;
         }
 
+        await context.activatePromise(SpaceEvents.SpaceCreated);
+        const onSpaceCreatedCallbacks = context.getCapabilities(SpaceCapabilities.OnSpaceCreated);
+        await Promise.all(
+          onSpaceCreatedCallbacks.map((onSpaceCreated) => onSpaceCreated({ space, rootCollection: collection })),
+        );
+
         return {
           data: {
             id: space.id,
@@ -305,7 +311,7 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
     }),
     createResolver({
       intent: SpaceAction.OpenCreateObject,
-      resolve: ({ target, navigable = true }) => {
+      resolve: ({ target, typename, navigable = true }) => {
         const state = context.getCapability(SpaceCapabilities.State);
 
         return {
@@ -317,8 +323,13 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
                 blockAlign: 'start',
                 props: {
                   target,
+                  typename,
                   shouldNavigate: navigable
-                    ? (object: Live<any>) => !(object instanceof CollectionType) || state.navigableCollections
+                    ? (object: Obj.Any) => {
+                        const isCollection = Obj.instanceOf(DataType.Collection, object);
+                        const isQueryCollection = Obj.instanceOf(DataType.QueryCollection, object);
+                        return (!isCollection && !isQueryCollection) || state.navigableCollections;
+                      }
                     : () => false,
                 } satisfies Partial<CreateObjectDialogProps>,
               },
@@ -365,18 +376,18 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
           };
         }
 
-        if (target instanceof CollectionType) {
-          target.objects.push(makeRef(object as HasId));
+        if (Obj.instanceOf(DataType.Collection, target)) {
+          target.objects.push(Ref.make(object));
         } else if (isSpace(target) && hidden) {
           space.db.add(object);
         } else if (isSpace(target)) {
-          const collection = space.properties[CollectionType.typename]?.target;
-          if (collection instanceof CollectionType) {
-            collection.objects.push(makeRef(object as HasId));
+          const collection = space.properties[Type.getTypename(DataType.Collection)]?.target;
+          if (Obj.instanceOf(DataType.Collection, collection)) {
+            collection.objects.push(Ref.make(object));
           } else {
             // TODO(wittjosiah): Can't add non-echo objects by including in a collection because of types.
-            const collection = live(CollectionType, { objects: [makeRef(object as HasId)], views: {} });
-            space.properties[CollectionType.typename] = makeRef(collection);
+            const collection = Obj.make(DataType.Collection, { objects: [Ref.make(object)] });
+            space.properties[Type.getTypename(DataType.Collection)] = Ref.make(collection);
           }
         }
 
@@ -384,7 +395,7 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
           data: {
             id: fullyQualifiedId(object),
             subject: [fullyQualifiedId(object)],
-            object: object as HasId,
+            object,
           },
           intents: [
             ...(observability
@@ -394,7 +405,7 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
                     properties: {
                       spaceId: space.id,
                       objectId: object.id,
-                      typename: getTypename(object),
+                      typename: Obj.getTypename(object),
                     },
                   }),
                 ]
@@ -406,8 +417,14 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
     createResolver({
       intent: SpaceAction.AddRelation,
       resolve: ({ space, schema, source, target, fields }) => {
-        const relation = live(schema, { [Relation.Source]: source, [Relation.Target]: target, ...fields });
-        space.db.add(relation);
+        const relation = space.db.add(
+          Relation.make(schema, {
+            [Relation.Source]: source,
+            [Relation.Target]: target,
+            ...fields,
+          }),
+        );
+
         return {
           data: {
             relation,
@@ -422,18 +439,19 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
 
         // All objects must be a member of the same space.
         const space = getSpace(objects[0]);
-        invariant(space && objects.every((obj) => isEchoObject(obj) && getSpace(obj) === space));
+        invariant(space && objects.every((obj) => Obj.isObject(obj) && getSpace(obj) === space));
         const openObjectIds = new Set<string>(layout.active);
 
         if (!undo) {
-          const parentCollection: CollectionType = target ?? space.properties[CollectionType.typename]?.target;
+          const parentCollection: DataType.Collection =
+            target ?? space.properties[Type.getTypename(DataType.Collection)]?.target;
           const nestedObjectsList = await Promise.all(objects.map((obj) => getNestedObjects(obj, resolve)));
 
           const deletionData = {
             objects,
             parentCollection,
             indices: objects.map((obj) =>
-              parentCollection instanceof CollectionType
+              Obj.instanceOf(DataType.Collection, parentCollection)
                 ? parentCollection.objects.findIndex((object) => object.target === obj)
                 : -1,
             ),
@@ -444,7 +462,7 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
               .filter((id) => openObjectIds.has(id)),
           } satisfies SpaceAction.DeletionData;
 
-          if (deletionData.parentCollection instanceof CollectionType) {
+          if (Obj.instanceOf(DataType.Collection, deletionData.parentCollection)) {
             [...deletionData.indices]
               .sort((a, b) => b - a)
               .forEach((index: number) => {
@@ -459,7 +477,7 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
           });
           objects.forEach((obj) => space.db.remove(obj));
 
-          const undoMessageKey = objects.some((obj) => obj instanceof CollectionType)
+          const undoMessageKey = objects.some((obj) => Obj.instanceOf(DataType.Collection, obj))
             ? 'collection deleted label'
             : objects.length > 1
               ? 'objects deleted label'
@@ -485,20 +503,20 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
         } else {
           if (
             deletionData?.objects?.length &&
-            deletionData.objects.every(isEchoObject) &&
-            deletionData.parentCollection instanceof CollectionType
+            deletionData.objects.every(Obj.isObject) &&
+            Obj.instanceOf(DataType.Collection, deletionData.parentCollection)
           ) {
             // Restore the object to the space.
-            const restoredObjects = deletionData.objects.map((obj: Expando) => space.db.add(obj));
+            const restoredObjects = deletionData.objects.map((obj: Type.Expando) => space.db.add(obj));
 
             // Restore nested objects to the space.
-            deletionData.nestedObjectsList.flat().forEach((obj: Expando) => {
+            deletionData.nestedObjectsList.flat().forEach((obj: Type.Expando) => {
               space.db.add(obj);
             });
 
             deletionData.indices.forEach((index: number, i: number) => {
               if (index !== -1) {
-                deletionData.parentCollection.objects.splice(index, 0, makeRef(restoredObjects[i] as Expando));
+                deletionData.parentCollection.objects.splice(index, 0, Ref.make(restoredObjects[i] as Type.Expando));
               }
             });
 
@@ -554,7 +572,13 @@ export default ({ context, observability, createInvitationUrl }: IntentResolverO
     createResolver({
       intent: CollectionAction.Create,
       resolve: async ({ name }) => ({
-        data: { object: live(CollectionType, { name, objects: [], views: {} }) },
+        data: { object: Obj.make(DataType.Collection, { name, objects: [] }) },
+      }),
+    }),
+    createResolver({
+      intent: CollectionAction.CreateQueryCollection,
+      resolve: async ({ name, typename }) => ({
+        data: { object: Obj.make(DataType.QueryCollection, { name, query: { typename } }) },
       }),
     }),
   ]);