@dxos/plugin-space 0.7.4 → 0.7.5-labs.071a3e2

package/src/capabilities/intent-resolver.ts

@@ -0,0 +1,518 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import {
+  Capabilities,
+  contributes,
+  createIntent,
+  createResolver,
+  LayoutAction,
+  type PluginsContext,
+} from '@dxos/app-framework';
+import { type Expando, getTypename, type HasId } from '@dxos/echo-schema';
+import { invariant } from '@dxos/invariant';
+import { create, makeRef, type ReactiveObject } from '@dxos/live-object';
+import { Migrations } from '@dxos/migrations';
+import { AttentionCapabilities } from '@dxos/plugin-attention';
+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, type Space, fullyQualifiedId, isEchoObject } from '@dxos/react-client/echo';
+
+import { SpaceCapabilities } from './capabilities';
+import {
+  CREATE_SPACE_DIALOG,
+  JOIN_DIALOG,
+  SPACE_SETTINGS_DIALOG,
+  type SpaceSettingsDialogProps,
+  type JoinDialogProps,
+  POPOVER_RENAME_SPACE,
+  CREATE_OBJECT_DIALOG,
+  type CreateObjectDialogProps,
+  POPOVER_RENAME_OBJECT,
+} from '../components';
+import { SPACE_PLUGIN } from '../meta';
+import { CollectionAction, CollectionType, SpaceAction } from '../types';
+import { cloneObject, COMPOSER_SPACE_LOCK, getNestedObjects } from '../util';
+
+// TODO(wittjosiah): Remove.
+const SPACE_MAX_OBJECTS = 500;
+
+type IntentResolverOptions = {
+  createInvitationUrl: (invitationCode: string) => string;
+  context: PluginsContext;
+  observability?: boolean;
+};
+
+export default ({ createInvitationUrl, context, observability }: IntentResolverOptions) => {
+  const resolve = (typename: string) =>
+    context.requestCapabilities(Capabilities.Metadata).find(({ id }) => id === typename)?.metadata ?? {};
+
+  return contributes(Capabilities.IntentResolver, [
+    createResolver({
+      intent: SpaceAction.OpenCreateSpace,
+      resolve: () => ({
+        intents: [
+          createIntent(LayoutAction.UpdateDialog, {
+            part: 'dialog',
+            subject: CREATE_SPACE_DIALOG,
+            options: {
+              blockAlign: 'start',
+            },
+          }),
+        ],
+      }),
+    }),
+    createResolver({
+      intent: SpaceAction.Create,
+      resolve: async ({ name, edgeReplication }) => {
+        const client = context.requestCapability(ClientCapabilities.Client);
+        const space = await client.spaces.create({ name });
+        if (edgeReplication) {
+          await space.internal.setEdgeReplicationPreference(EdgeReplicationSetting.ENABLED);
+        }
+        await space.waitUntilReady();
+        const collection = create(CollectionType, { objects: [], views: {} });
+        space.properties[CollectionType.typename] = makeRef(collection);
+
+        if (Migrations.versionProperty) {
+          space.properties[Migrations.versionProperty] = Migrations.targetVersion;
+        }
+
+        return {
+          data: {
+            id: space.id,
+            subject: [space.id],
+            space,
+          },
+          intents: [
+            ...(observability
+              ? [
+                  createIntent(ObservabilityAction.SendEvent, {
+                    name: 'space.create',
+                    properties: {
+                      spaceId: space.id,
+                    },
+                  }),
+                ]
+              : []),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Join,
+      resolve: ({ invitationCode }) => ({
+        intents: [
+          createIntent(LayoutAction.UpdateDialog, {
+            part: 'dialog',
+            subject: JOIN_DIALOG,
+            options: {
+              blockAlign: 'start',
+              props: {
+                initialInvitationCode: invitationCode,
+              } satisfies Partial<JoinDialogProps>,
+            },
+          }),
+        ],
+      }),
+    }),
+    createResolver({
+      intent: SpaceAction.Share,
+      filter: (data): data is { space: Space } => !data.space.properties[COMPOSER_SPACE_LOCK],
+      resolve: ({ space }) => {
+        const attention = context.requestCapability(AttentionCapabilities.Attention);
+        const current = attention.current.at(-1);
+        const target = current?.startsWith(space.id) ? current : undefined;
+
+        return {
+          intents: [
+            createIntent(LayoutAction.UpdateDialog, {
+              part: 'dialog',
+              subject: SPACE_SETTINGS_DIALOG,
+              options: {
+                blockAlign: 'start',
+                props: {
+                  space,
+                  target,
+                  initialTab: 'members',
+                  createInvitationUrl,
+                } satisfies Partial<SpaceSettingsDialogProps>,
+              },
+            }),
+            ...(observability
+              ? [
+                  createIntent(ObservabilityAction.SendEvent, {
+                    name: 'space.share',
+                    properties: {
+                      space: space.id,
+                    },
+                  }),
+                ]
+              : []),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Lock,
+      resolve: ({ space }) => {
+        space.properties[COMPOSER_SPACE_LOCK] = true;
+        return {
+          intents: [
+            ...(observability
+              ? [
+                  createIntent(ObservabilityAction.SendEvent, {
+                    name: 'space.lock',
+                    properties: {
+                      spaceId: space.id,
+                    },
+                  }),
+                ]
+              : []),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Unlock,
+      resolve: ({ space }) => {
+        space.properties[COMPOSER_SPACE_LOCK] = false;
+        return {
+          intents: [
+            ...(observability
+              ? [
+                  createIntent(ObservabilityAction.SendEvent, {
+                    name: 'space.unlock',
+                    properties: {
+                      spaceId: space.id,
+                    },
+                  }),
+                ]
+              : []),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Rename,
+      resolve: ({ caller, space }) => {
+        return {
+          intents: [
+            createIntent(LayoutAction.UpdatePopover, {
+              part: 'popover',
+              subject: POPOVER_RENAME_SPACE,
+              options: {
+                anchorId: `dxos.org/ui/${caller}/${space.id}`,
+                props: space,
+              },
+            }),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.OpenSettings,
+      resolve: ({ space }) => {
+        return {
+          intents: [
+            createIntent(LayoutAction.UpdateDialog, {
+              part: 'dialog',
+              subject: SPACE_SETTINGS_DIALOG,
+              options: {
+                blockAlign: 'start',
+                props: {
+                  space,
+                  initialTab: 'settings',
+                  createInvitationUrl,
+                } satisfies Partial<SpaceSettingsDialogProps>,
+              },
+            }),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Open,
+      resolve: async ({ space }) => {
+        await space.open();
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Close,
+      resolve: async ({ space }) => {
+        await space.close();
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.Migrate,
+      resolve: async ({ space, version }) => {
+        const state = context.requestCapability(SpaceCapabilities.MutableState);
+
+        if (space.state.get() === SpaceState.SPACE_REQUIRES_MIGRATION) {
+          state.sdkMigrationRunning[space.id] = true;
+          await space.internal.migrate();
+          state.sdkMigrationRunning[space.id] = false;
+        }
+        const result = await Migrations.migrate(space, version);
+        return {
+          data: result,
+          intents: [
+            ...(observability
+              ? [
+                  createIntent(ObservabilityAction.SendEvent, {
+                    name: 'space.migrate',
+                    properties: {
+                      spaceId: space.id,
+                      version,
+                    },
+                  }),
+                ]
+              : []),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.OpenCreateObject,
+      resolve: ({ target, navigable = true }) => {
+        const state = context.requestCapability(SpaceCapabilities.State);
+
+        return {
+          intents: [
+            createIntent(LayoutAction.UpdateDialog, {
+              part: 'dialog',
+              subject: CREATE_OBJECT_DIALOG,
+              options: {
+                blockAlign: 'start',
+                props: {
+                  target,
+                  shouldNavigate: navigable
+                    ? (object: ReactiveObject<any>) => !(object instanceof CollectionType) || state.navigableCollections
+                    : () => false,
+                } satisfies Partial<CreateObjectDialogProps>,
+              },
+            }),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.AddObject,
+      resolve: async ({ target, object }) => {
+        const space = isSpace(target) ? target : getSpace(target);
+        invariant(space, 'Space not found.');
+
+        if (space.db.coreDatabase.getAllObjectIds().length >= SPACE_MAX_OBJECTS) {
+          return {
+            error: new Error('Space limit reached.'),
+            intents: [
+              createIntent(LayoutAction.AddToast, {
+                part: 'toast',
+                subject: {
+                  id: `${SPACE_PLUGIN}/space-limit`,
+                  title: ['space limit label', { ns: SPACE_PLUGIN }],
+                  description: ['space limit description', { ns: SPACE_PLUGIN }],
+                  duration: 5_000,
+                  icon: 'ph--warning--regular',
+                  actionLabel: ['remove deleted objects label', { ns: SPACE_PLUGIN }],
+                  actionAlt: ['remove deleted objects alt', { ns: SPACE_PLUGIN }],
+                  closeLabel: ['close label', { ns: 'os' }],
+                  onAction: () => space.db.coreDatabase.unlinkDeletedObjects(),
+                },
+              }),
+              ...(observability
+                ? [
+                    createIntent(ObservabilityAction.SendEvent, {
+                      name: 'space.limit',
+                      properties: {
+                        spaceId: space.id,
+                      },
+                    }),
+                  ]
+                : []),
+            ],
+          };
+        }
+
+        if (target instanceof CollectionType) {
+          target.objects.push(makeRef(object as HasId));
+        } else if (isSpace(target)) {
+          const collection = space.properties[CollectionType.typename]?.target;
+          if (collection instanceof CollectionType) {
+            collection.objects.push(makeRef(object as HasId));
+          } else {
+            // TODO(wittjosiah): Can't add non-echo objects by including in a collection because of types.
+            const collection = create(CollectionType, { objects: [makeRef(object as HasId)], views: {} });
+            space.properties[CollectionType.typename] = makeRef(collection);
+          }
+        }
+
+        return {
+          data: {
+            id: fullyQualifiedId(object),
+            subject: [fullyQualifiedId(object)],
+            object: object as HasId,
+          },
+          intents: [
+            ...(observability
+              ? [
+                  createIntent(ObservabilityAction.SendEvent, {
+                    name: 'space.object.add',
+                    properties: {
+                      spaceId: space.id,
+                      objectId: object.id,
+                      typename: getTypename(object),
+                    },
+                  }),
+                ]
+              : []),
+          ],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.RemoveObjects,
+      resolve: async ({ objects, target, deletionData }, undo) => {
+        const layout = context.requestCapability(Capabilities.Layout);
+
+        // 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));
+        const openObjectIds = new Set<string>(layout.active);
+
+        if (!undo) {
+          const parentCollection: CollectionType = target ?? space.properties[CollectionType.typename]?.target;
+          const nestedObjectsList = await Promise.all(objects.map((obj) => getNestedObjects(obj, resolve)));
+
+          const deletionData = {
+            objects,
+            parentCollection,
+            indices: objects.map((obj) =>
+              parentCollection instanceof CollectionType
+                ? parentCollection.objects.findIndex((object) => object.target === obj)
+                : -1,
+            ),
+            nestedObjectsList,
+            wasActive: objects
+              .flatMap((obj, i) => [obj, ...nestedObjectsList[i]])
+              .map((obj) => fullyQualifiedId(obj))
+              .filter((id) => openObjectIds.has(id)),
+          } satisfies SpaceAction.DeletionData;
+
+          if (deletionData.parentCollection instanceof CollectionType) {
+            [...deletionData.indices]
+              .sort((a, b) => b - a)
+              .forEach((index: number) => {
+                if (index !== -1) {
+                  deletionData.parentCollection.objects.splice(index, 1);
+                }
+              });
+          }
+
+          deletionData.nestedObjectsList.flat().forEach((obj) => {
+            space.db.remove(obj);
+          });
+          objects.forEach((obj) => space.db.remove(obj));
+
+          const undoMessageKey = objects.some((obj) => obj instanceof CollectionType)
+            ? 'collection deleted label'
+            : objects.length > 1
+              ? 'objects deleted label'
+              : 'object deleted label';
+
+          return {
+            undoable: {
+              // TODO(ZaymonFC): Pluralize if more than one object.
+              message: [undoMessageKey, { ns: SPACE_PLUGIN }],
+              data: { deletionData },
+            },
+            intents:
+              deletionData.wasActive.length > 0
+                ? [
+                    createIntent(LayoutAction.Close, {
+                      part: 'main',
+                      subject: deletionData.wasActive,
+                      options: { state: false },
+                    }),
+                  ]
+                : undefined,
+          };
+        } else {
+          if (
+            deletionData?.objects?.length &&
+            deletionData.objects.every(isEchoObject) &&
+            deletionData.parentCollection instanceof CollectionType
+          ) {
+            // Restore the object to the space.
+            const restoredObjects = deletionData.objects.map((obj: Expando) => space.db.add(obj));
+
+            // Restore nested objects to the space.
+            deletionData.nestedObjectsList.flat().forEach((obj: 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));
+              }
+            });
+
+            return {
+              intents:
+                deletionData.wasActive.length > 0
+                  ? [
+                      createIntent(LayoutAction.Open, {
+                        part: 'main',
+                        subject: deletionData.wasActive,
+                      }),
+                    ]
+                  : undefined,
+            };
+          }
+        }
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.RenameObject,
+      resolve: async ({ object, caller }) => ({
+        intents: [
+          createIntent(LayoutAction.UpdatePopover, {
+            part: 'popover',
+            subject: POPOVER_RENAME_OBJECT,
+            options: {
+              anchorId: `dxos.org/ui/${caller}/${fullyQualifiedId(object)}`,
+              props: object,
+            },
+          }),
+        ],
+      }),
+    }),
+    createResolver({
+      intent: SpaceAction.DuplicateObject,
+      resolve: async ({ object, target }) => {
+        const space = isSpace(target) ? target : getSpace(target);
+        invariant(space, 'Space not found.');
+
+        const newObject = await cloneObject(object, resolve, space);
+        return {
+          intents: [createIntent(SpaceAction.AddObject, { object: newObject, target })],
+        };
+      },
+    }),
+    createResolver({
+      intent: SpaceAction.WaitForObject,
+      resolve: async ({ id }) => {
+        const state = context.requestCapability(SpaceCapabilities.MutableState);
+        state.awaiting = id;
+      },
+    }),
+    createResolver({
+      intent: CollectionAction.Create,
+      resolve: async ({ name }) => ({
+        data: { object: create(CollectionType, { name, objects: [], views: {} }) },
+      }),
+    }),
+  ]);
+};

package/src/capabilities/react-root.tsx

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { Capabilities, contributes, useCapability } from '@dxos/app-framework';
+
+import { SpaceCapabilities } from './capabilities';
+import { AwaitingObject } from '../components';
+import { SPACE_PLUGIN } from '../meta';
+
+export default () =>
+  contributes(Capabilities.ReactRoot, {
+    id: SPACE_PLUGIN,
+    root: () => {
+      const state = useCapability(SpaceCapabilities.State);
+      return state.awaiting ? <AwaitingObject id={state.awaiting} /> : null;
+    },
+  });