@dxos/plugin-space 0.7.5-main.2567c87 → 0.7.5-main.5ae2ba8

package/src/SpacePlugin.tsx

@@ -12,10 +12,12 @@ import {
   Events,
   oneOf,
 } from '@dxos/app-framework';
+import { S } from '@dxos/echo-schema';
 import { RefArray } from '@dxos/live-object';
 import { AttentionEvents } from '@dxos/plugin-attention';
-import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
-import { DeckCapabilities } from '@dxos/plugin-deck';
+import { ClientEvents } from '@dxos/plugin-client';
+import { DeckCapabilities, DeckEvents } from '@dxos/plugin-deck';
+import { isEchoObject, getSpace } from '@dxos/react-client/echo';
 import { osTranslations } from '@dxos/shell/react';
 
 import {
@@ -25,6 +27,8 @@ import {
   IntentResolver,
   ReactRoot,
   ReactSurface,
+  Schema,
+  SpaceCapabilities,
   SpaceSettings,
   SpacesReady,
   SpaceState,
@@ -32,7 +36,7 @@ import {
 import { SpaceEvents } from './events';
 import { meta, SPACE_PLUGIN } from './meta';
 import translations from './translations';
-import { CollectionAction, CollectionType } from './types';
+import { CollectionAction, CollectionType, defineObjectForm } from './types';
 
 export type SpacePluginOptions = {
   /**
@@ -44,11 +48,17 @@ export type SpacePluginOptions = {
    * Query parameter for the invitation code.
    */
   invitationParam?: string;
+
+  /**
+   * Whether to send observability events.
+   */
+  observability?: boolean;
 };
 
 export const SpacePlugin = ({
   invitationUrl = window.location.origin,
   invitationParam = 'spaceInvitationCode',
+  observability = true,
 }: SpacePluginOptions = {}) => {
   const createInvitationUrl = (invitationCode: string) => {
     const baseUrl = new URL(invitationUrl);
@@ -59,7 +69,10 @@ export const SpacePlugin = ({
   return definePlugin(meta, [
     defineModule({
       id: `${meta.id}/module/state`,
-      activatesOn: oneOf(Events.Startup, Events.SetupAppGraph),
+      // TODO(wittjosiah): Does not integrate with settings store.
+      //   Should this be a different event?
+      //   Should settings store be renamed to be more generic?
+      activatesOn: oneOf(Events.SetupSettings, Events.SetupAppGraph),
       activatesAfter: [SpaceEvents.StateReady],
       activate: SpaceState,
     }),
@@ -75,12 +88,11 @@ export const SpacePlugin = ({
     }),
     defineModule({
       id: `${meta.id}/module/metadata`,
-      activatesOn: oneOf(Events.Startup, Events.SetupAppGraph),
+      activatesOn: Events.SetupMetadata,
       activate: () =>
         contributes(Capabilities.Metadata, {
           id: CollectionType.typename,
           metadata: {
-            createObject: (props: { name?: string }) => createIntent(CollectionAction.Create, props),
             placeholder: ['unnamed collection label', { ns: SPACE_PLUGIN }],
             icon: 'ph--cards-three--regular',
             // TODO(wittjosiah): Move out of metadata.
@@ -89,20 +101,36 @@ export const SpacePlugin = ({
           },
         }),
     }),
+    defineModule({
+      id: `${meta.id}/module/object-form`,
+      activatesOn: ClientEvents.SetupSchema,
+      activate: () =>
+        contributes(
+          SpaceCapabilities.ObjectForm,
+          defineObjectForm({
+            objectSchema: CollectionType,
+            formSchema: S.Struct({ name: S.optional(S.String) }),
+            getIntent: (props) => createIntent(CollectionAction.Create, props),
+          }),
+        ),
+    }),
     defineModule({
       id: `${meta.id}/module/complementary-panel`,
-      activatesOn: Events.Startup,
+      activatesOn: DeckEvents.SetupComplementaryPanels,
       activate: () =>
         contributes(DeckCapabilities.ComplementaryPanel, {
           id: 'settings',
           label: ['settings panel label', { ns: SPACE_PLUGIN }],
-          icon: 'ph--gear--regular',
+          icon: 'ph--sliders--regular',
+          position: 'hoist',
+          filter: (node) => isEchoObject(node.data) && !!getSpace(node.data),
         }),
     }),
     defineModule({
       id: `${meta.id}/module/schema`,
-      activatesOn: ClientEvents.SetupClient,
-      activate: () => contributes(ClientCapabilities.Schema, [CollectionType]),
+      activatesOn: ClientEvents.ClientReady,
+      activatesBefore: [ClientEvents.SetupSchema],
+      activate: Schema,
     }),
     defineModule({
       id: `${meta.id}/module/react-root`,
@@ -111,13 +139,15 @@ export const SpacePlugin = ({
     }),
     defineModule({
       id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.Startup,
+      activatesOn: Events.SetupReactSurface,
+      // TODO(wittjosiah): Should occur before the settings dialog is loaded when surfaces activation is more granular.
+      activatesBefore: [SpaceEvents.SetupSettingsPanel],
       activate: () => ReactSurface({ createInvitationUrl }),
     }),
     defineModule({
       id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntents,
-      activate: (context) => IntentResolver({ createInvitationUrl, context }),
+      activatesOn: Events.SetupIntentResolver,
+      activate: (context) => IntentResolver({ createInvitationUrl, context, observability }),
     }),
     defineModule({
       id: `${meta.id}/module/app-graph-builder`,
@@ -127,7 +157,7 @@ export const SpacePlugin = ({
     // TODO(wittjosiah): This could probably be deferred.
     defineModule({
       id: `${meta.id}/module/app-graph-serializer`,
-      activatesOn: Events.Startup,
+      activatesOn: Events.AppGraphReady,
       activate: AppGraphSerializer,
     }),
     defineModule({
@@ -141,7 +171,6 @@ export const SpacePlugin = ({
       activatesOn: allOf(
         Events.DispatcherReady,
         Events.LayoutReady,
-        Events.LocationReady,
         Events.AppGraphReady,
         AttentionEvents.AttentionReady,
         SpaceEvents.StateReady,

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

@@ -11,17 +11,16 @@ import {
   isEchoObject,
   isSpace,
   OBJECT_ID_LENGTH,
-  parseId,
   type ReactiveEchoObject,
   SPACE_ID_LENGTH,
   SpaceState,
   type Space,
 } from '@dxos/client/echo';
-import { getTypename, isDeleted } from '@dxos/live-object';
+import { isDeleted } from '@dxos/live-object';
 import { log } from '@dxos/log';
 import { ClientCapabilities } from '@dxos/plugin-client';
-import { createExtension, toSignal, type Node } from '@dxos/plugin-graph';
-import { nonNullable } from '@dxos/util';
+import { createExtension, toSignal, type Node, type InvokeParams } from '@dxos/plugin-graph';
+import { isNonNullable } from '@dxos/util';
 
 import { SpaceCapabilities } from './capabilities';
 import { SPACE_PLUGIN } from '../meta';
@@ -46,8 +45,10 @@ export default (context: PluginsContext) => {
     cacheable: ['label', 'role'],
     properties: {
       label: ['spaces label', { ns: SPACE_PLUGIN }],
+      icon: 'ph--planet--regular',
       testId: 'spacePlugin.spaces',
       role: 'branch',
+      disposition: 'collection',
       disabled: true,
       childrenPersistenceClass: 'echo',
       onRearrangeChildren: async (nextOrder: Space[]) => {
@@ -79,33 +80,21 @@ export default (context: PluginsContext) => {
     // Primary actions.
     createExtension({
       id: `${SPACE_PLUGIN}/primary-actions`,
-      disposition: 'hoist',
+      position: 'hoist',
       filter: (node): node is Node<null> => node.id === 'root',
       actions: () => [
         {
-          id: SpaceAction.OpenCreateSpace._tag,
-          data: async () => {
+          id: SpaceAction.AddSpace._tag,
+          data: async (params: InvokeParams) => {
             const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);
-            await dispatch(createIntent(SpaceAction.OpenCreateSpace));
+            await dispatch(createIntent(SpaceAction.AddSpace));
           },
           properties: {
-            label: ['create space label', { ns: SPACE_PLUGIN }],
+            label: ['add space label', { ns: SPACE_PLUGIN }],
             icon: 'ph--plus--regular',
-            testId: 'spacePlugin.createSpace',
-            disposition: 'item',
-          },
-        },
-        {
-          id: SpaceAction.Join._tag,
-          data: async () => {
-            const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);
-            await dispatch(createIntent(SpaceAction.Join));
-          },
-          properties: {
-            label: ['join space label', { ns: SPACE_PLUGIN }],
-            icon: 'ph--sign-in--regular',
-            testId: 'spacePlugin.joinSpace',
+            testId: 'spacePlugin.addSpace',
             disposition: 'item',
+            position: 'fallback',
           },
         },
       ],
@@ -114,7 +103,7 @@ export default (context: PluginsContext) => {
     // Create spaces group node.
     createExtension({
       id: `${SPACE_PLUGIN}/root`,
-      disposition: 'hoist',
+      position: 'hoist',
       filter: (node): node is Node<null> => node.id === 'root',
       connector: () => [spacesNode],
       resolver: ({ id }) => (id === SPACES ? spacesNode : undefined),
@@ -195,6 +184,8 @@ export default (context: PluginsContext) => {
 
         if (space.state.get() === SpaceState.SPACE_INACTIVE) {
           return false;
+        } else if (space.state.get() !== SpaceState.SPACE_READY) {
+          return undefined;
         } else {
           const state = context.requestCapability(SpaceCapabilities.State);
           return constructSpaceNode({
@@ -250,9 +241,9 @@ export default (context: PluginsContext) => {
 
         return collection.objects
           .map((object) => object.target)
-          .filter(nonNullable)
+          .filter(isNonNullable)
           .map((object) => createObjectNode({ object, space, resolve, navigable: state.navigableCollections }))
-          .filter(nonNullable);
+          .filter(isNonNullable);
       },
     }),
 
@@ -271,9 +262,9 @@ export default (context: PluginsContext) => {
 
         return collection.objects
           .map((object) => object.target)
-          .filter(nonNullable)
+          .filter(isNonNullable)
           .map((object) => createObjectNode({ object, space, resolve, navigable: state.navigableCollections }))
-          .filter(nonNullable);
+          .filter(isNonNullable);
       },
       resolver: ({ id }) => {
         if (id.length !== FQ_ID_LENGTH) {
@@ -324,69 +315,5 @@ export default (context: PluginsContext) => {
         return constructObjectActions({ node, dispatch, navigable: state.navigableCollections });
       },
     }),
-
-    // Create nodes for object settings.
-    createExtension({
-      id: `${SPACE_PLUGIN}/settings-for-subject`,
-      resolver: ({ id }) => {
-        // TODO(Zan): Find util (or make one).
-        if (!id.endsWith('~settings')) {
-          return;
-        }
-
-        const type = 'orphan-settings-for-subject';
-        const icon = 'ph--gear--regular';
-
-        const [subjectId] = id.split('~');
-        const { spaceId, objectId } = parseId(subjectId);
-        const client = context.requestCapability(ClientCapabilities.Client);
-        const spaces = toSignal(
-          (onChange) => client.spaces.subscribe(() => onChange()).unsubscribe,
-          () => client.spaces.get(),
-        );
-        const space = spaces?.find((space) => space.id === spaceId && space.state.get() === SpaceState.SPACE_READY);
-        if (!objectId) {
-          const label = space
-            ? space.properties.name || ['unnamed space label', { ns: SPACE_PLUGIN }]
-            : ['unnamed object settings label', { ns: SPACE_PLUGIN }];
-
-          // TODO(wittjosiah): Support comments for arbitrary subjects.
-          //   This is to ensure that the comments panel is not stuck on an old object.
-          return {
-            id,
-            type,
-            data: null,
-            properties: {
-              icon,
-              label,
-              showResolvedThreads: false,
-              object: null,
-              space,
-            },
-          };
-        }
-
-        const [object] = memoizeQuery(space, { id: objectId });
-        if (!object || !subjectId) {
-          return;
-        }
-
-        const meta = resolve(getTypename(object) ?? '');
-        const label = meta.label?.(object) ||
-          object.name ||
-          meta.placeholder || ['unnamed object settings label', { ns: SPACE_PLUGIN }];
-
-        return {
-          id,
-          type,
-          data: null,
-          properties: {
-            icon,
-            label,
-            object,
-          },
-        };
-      },
-    }),
   ]);
 };

package/src/capabilities/capabilities.ts

@@ -2,15 +2,20 @@
 // Copyright 2025 DXOS.org
 //
 
-import { defineCapability } from '@dxos/app-framework';
+import { defineCapability, type Label } from '@dxos/app-framework';
 import { type DeepReadonly } from '@dxos/util';
 
 import { SPACE_PLUGIN } from '../meta';
-import { type PluginState } from '../types';
+import { type ObjectForm, type PluginState } from '../types';
 
 export namespace SpaceCapabilities {
   export const State = defineCapability<DeepReadonly<PluginState>>(`${SPACE_PLUGIN}/capability/state`);
   export const MutableState = defineCapability<PluginState>(`${SPACE_PLUGIN}/capability/state`);
+
+  export type SpaceSettingsPanel = { id: string; label: Label };
+  export const SettingsPanel = defineCapability<SpaceSettingsPanel>(`${SPACE_PLUGIN}/capability/settings-panel`);
+
+  export const ObjectForm = defineCapability<ObjectForm<any>>(`${SPACE_PLUGIN}/capability/object-form`);
 }
 
 // TODO(wittjosiah): Factor out.

package/src/capabilities/index.ts

@@ -10,6 +10,7 @@ export const IdentityCreated = lazy(() => import('./identity-created'));
 export const IntentResolver = lazy(() => import('./intent-resolver'));
 export const ReactRoot = lazy(() => import('./react-root'));
 export const ReactSurface = lazy(() => import('./react-surface'));
+export const Schema = lazy(() => import('./schema'));
 export const SpaceSettings = lazy(() => import('./settings'));
 export const SpaceState = lazy(() => import('./state'));
 export const SpacesReady = lazy(() => import('./spaces-ready'));