@dxos/plugin-space 0.8.3 → 0.8.4-main.1068cf700f

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

@@ -1,540 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Rx } from '@effect-rx/rx-react';
-import { Array, Option, pipe } from 'effect';
-
-import { Capabilities, contributes, createIntent, type PluginContext } from '@dxos/app-framework';
-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 { SPACE_TYPE, SpaceAction, type SpaceSettingsProps } from '../types';
-import {
-  constructObjectActions,
-  constructSpaceActions,
-  constructSpaceNode,
-  createObjectNode,
-  rxFromQuery,
-  SHARED,
-  SPACES,
-} from '../util';
-
-export default (context: PluginContext) => {
-  // TODO(wittjosiah): Make reactive.
-  const resolve = (typename: string) =>
-    context.getCapabilities(Capabilities.Metadata).find(({ id }) => id === typename)?.metadata ?? {};
-
-  const spacesNode = {
-    id: SPACES,
-    type: SPACES,
-    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[]) => {
-        const { graph } = context.getCapability(Capabilities.AppGraph);
-        const client = context.getCapability(ClientCapabilities.Client);
-
-        // NOTE: This is needed to ensure order is updated by next animation frame.
-        // TODO(wittjosiah): Is there a better way to do this?
-        //   If not, graph should be passed as an argument to the extension.
-        graph.sortEdges(
-          SPACES,
-          'outbound',
-          nextOrder.map(({ id }) => id),
-        );
-
-        const {
-          objects: [spacesOrder],
-        } = await client.spaces.default.db.query(Filter.type(Type.Expando, { key: SHARED })).run();
-        if (spacesOrder) {
-          spacesOrder.order = nextOrder.map(({ id }) => id);
-        } else {
-          log.warn('spaces order object not found');
-        }
-      },
-    },
-  };
-
-  return contributes(Capabilities.AppGraphBuilder, [
-    // Primary actions.
-    createExtension({
-      id: `${SPACE_PLUGIN}/primary-actions`,
-      position: 'hoist',
-      actions: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => [
-              {
-                id: SpaceAction.OpenCreateSpace._tag,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  await dispatch(createIntent(SpaceAction.OpenCreateSpace));
-                },
-                properties: {
-                  label: ['create space label', { ns: SPACE_PLUGIN }],
-                  icon: 'ph--plus--regular',
-                  testId: 'spacePlugin.createSpace',
-                  disposition: 'menu',
-                },
-              },
-              {
-                id: SpaceAction.Join._tag,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  await dispatch(createIntent(SpaceAction.Join));
-                },
-                properties: {
-                  label: ['join space label', { ns: SPACE_PLUGIN }],
-                  icon: 'ph--sign-in--regular',
-                  testId: 'spacePlugin.joinSpace',
-                  disposition: 'menu',
-                },
-              },
-              {
-                id: SpaceAction.OpenMembers._tag,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  const client = context.getCapability(ClientCapabilities.Client);
-                  const space = getActiveSpace(context) ?? client.spaces.default;
-                  await dispatch(createIntent(SpaceAction.OpenMembers, { space }));
-                },
-                properties: {
-                  label: ['share space label', { ns: SPACE_PLUGIN }],
-                  icon: 'ph--users--regular',
-                  testId: 'spacePlugin.shareSpace',
-                  keyBinding: {
-                    macos: 'meta+.',
-                    windows: 'alt+.',
-                  },
-                },
-              },
-              {
-                id: SpaceAction.OpenSettings._tag,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  const client = context.getCapability(ClientCapabilities.Client);
-                  const space = getActiveSpace(context) ?? client.spaces.default;
-                  await dispatch(createIntent(SpaceAction.OpenSettings, { space }));
-                },
-                properties: {
-                  label: ['open current space settings label', { ns: SPACE_PLUGIN }],
-                  icon: 'ph--faders--regular',
-                  keyBinding: {
-                    macos: 'meta+shift+,',
-                    windows: 'ctrl+shift+,',
-                  },
-                },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-
-    // Create spaces group node.
-    createExtension({
-      id: `${SPACE_PLUGIN}/root`,
-      position: 'hoist',
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => [spacesNode]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-      // resolver: ({ id }) => (id === SPACES ? spacesNode : undefined),
-    }),
-
-    // Create space nodes.
-    createExtension({
-      id: SPACES,
-      connector: (node) => {
-        let query: QueryResult<Type.Expando> | undefined;
-        return Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === SPACES ? Option.some(node) : Option.none())),
-            Option.map(() => {
-              const state = context.getCapability(SpaceCapabilities.State);
-              const client = context.getCapability(ClientCapabilities.Client);
-              const spacesRx = rxFromObservable(client.spaces);
-              const isReadyRx = rxFromObservable(client.spaces.isReady);
-
-              const spaces = get(spacesRx);
-              const isReady = get(isReadyRx);
-
-              if (!spaces || !isReady) {
-                return [];
-              }
-
-              const settings = get(context.capabilities(Capabilities.SettingsStore))[0]?.getStore<SpaceSettingsProps>(
-                SPACE_PLUGIN,
-              )?.value;
-
-              // TODO(wittjosiah): During client reset, accessing default space throws.
-              try {
-                if (!query) {
-                  query = client.spaces.default.db.query(Filter.type(Type.Expando, { key: SHARED }));
-                }
-                const [spacesOrder] = get(rxFromQuery(query));
-                return get(
-                  rxFromSignal(() => {
-                    const order: string[] = spacesOrder?.order ?? [];
-                    const orderMap = new Map(order.map((id, index) => [id, index]));
-                    return [
-                      ...spaces
-                        .filter((space) => orderMap.has(space.id))
-                        .sort((a, b) => orderMap.get(a.id)! - orderMap.get(b.id)!),
-                      ...spaces.filter((space) => !orderMap.has(space.id)),
-                    ]
-                      .filter((space) =>
-                        settings?.showHidden ? true : space.state.get() !== SpaceState.SPACE_INACTIVE,
-                      )
-                      .map((space) =>
-                        constructSpaceNode({
-                          space,
-                          navigable: state.navigableCollections,
-                          personal: space === client.spaces.default,
-                          namesCache: state.spaceNames,
-                          resolve,
-                        }),
-                      );
-                  }),
-                );
-              } catch {
-                return [];
-              }
-            }),
-            Option.getOrElse(() => []),
-          ),
-        );
-      },
-      // resolver: ({ id }) => {
-      //   if (id.length !== SPACE_ID_LENGTH) {
-      //     return;
-      //   }
-
-      //   const client = context.requestCapability(ClientCapabilities.Client);
-      //   const spaces = toSignal(
-      //     (onChange) => client.spaces.subscribe(() => onChange()).unsubscribe,
-      //     () => client.spaces.get(),
-      //   );
-
-      //   const isReady = toSignal(
-      //     (onChange) => client.spaces.isReady.subscribe(() => onChange()).unsubscribe,
-      //     () => client.spaces.isReady.get(),
-      //   );
-
-      //   if (!spaces || !isReady) {
-      //     return;
-      //   }
-
-      //   const space = spaces.find((space) => space.id === id);
-      //   if (!space) {
-      //     return;
-      //   }
-
-      //   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({
-      //       space,
-      //       navigable: state.navigableCollections,
-      //       personal: space === client.spaces.default,
-      //       namesCache: state.spaceNames,
-      //       resolve,
-      //     });
-      //   }
-      // },
-    }),
-
-    // Create space actions.
-    createExtension({
-      id: `${SPACE_PLUGIN}/actions`,
-      actions: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) =>
-              node.type === SPACE_TYPE && isSpace(node.data) ? Option.some(node.data) : Option.none(),
-            ),
-            Option.flatMap((space) => {
-              const [dispatcher] = get(context.capabilities(Capabilities.IntentDispatcher));
-              const [client] = get(context.capabilities(ClientCapabilities.Client));
-              const [state] = get(context.capabilities(SpaceCapabilities.State));
-
-              if (!dispatcher || !client || !state) {
-                return Option.none();
-              } else {
-                return Option.some({
-                  space,
-                  dispatch: dispatcher.dispatchPromise,
-                  personal: space === client.spaces.default,
-                  migrating: state.sdkMigrationRunning[space.id],
-                });
-              }
-            }),
-            Option.map((params) => constructSpaceActions(params)),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-
-    // Create nodes for objects in the root collection of a space.
-    createExtension({
-      id: `${SPACE_PLUGIN}/root-collection`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) =>
-              node.type === SPACE_TYPE && isSpace(node.data) ? Option.some(node.data) : Option.none(),
-            ),
-            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[Type.getTypename(DataType.Collection)]?.target as DataType.Collection | undefined,
-                ),
-              );
-              if (!collection) {
-                return [];
-              }
-
-              return get(
-                rxFromSignal(() =>
-                  pipe(
-                    collection.objects,
-                    Array.map((object) => object.target),
-                    Array.filter(isNonNullable),
-                    Array.map((object) =>
-                      createObjectNode({
-                        space,
-                        object,
-                        resolve,
-                        navigable: state.navigableCollections,
-                      }),
-                    ),
-                    Array.filter(isNonNullable),
-                  ),
-                ),
-              );
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-
-    // Create nodes for objects in a collection or by its fully qualified id.
-    createExtension({
-      id: `${SPACE_PLUGIN}/objects`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            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);
-
-              return get(
-                rxFromSignal(() =>
-                  pipe(
-                    collection.objects,
-                    Array.map((object) => object.target),
-                    Array.filter(isNonNullable),
-                    Array.map(
-                      (object) =>
-                        space && createObjectNode({ object, space, resolve, navigable: state.navigableCollections }),
-                    ),
-                    Array.filter(isNonNullable),
-                  ),
-                ),
-              );
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-      // resolver: ({ id }) => {
-      //   if (id.length !== FQ_ID_LENGTH) {
-      //     return;
-      //   }
-
-      //   const [spaceId, objectId] = id.split(':');
-      //   if (spaceId.length !== SPACE_ID_LENGTH && objectId.length !== OBJECT_ID_LENGTH) {
-      //     return;
-      //   }
-
-      //   const client = context.requestCapability(ClientCapabilities.Client);
-      //   const space = client.spaces.get().find((space) => space.id === spaceId);
-      //   if (!space) {
-      //     return;
-      //   }
-
-      //   const spaceState = toSignal(
-      //     (onChange) => space.state.subscribe(() => onChange()).unsubscribe,
-      //     () => space.state.get(),
-      //     space.id,
-      //   );
-      //   if (spaceState !== SpaceState.SPACE_READY) {
-      //     return;
-      //   }
-
-      //   const [object] = memoizeQuery(space, Query.select(Filter.ids(objectId)));
-      //   if (!object) {
-      //     return;
-      //   }
-
-      //   if (isDeleted(object)) {
-      //     return false;
-      //   } else {
-      //     const state = context.requestCapability(SpaceCapabilities.State);
-      //     return createObjectNode({ object, space, resolve, navigable: state.navigableCollections });
-      //   }
-      // },
-    }),
-
-    // 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`,
-      actions: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            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();
-              } else {
-                return Option.some({
-                  object,
-                  graph: appGraph.graph,
-                  dispatch: dispatcher.dispatchPromise,
-                  objectForms,
-                  navigable: get(rxFromSignal(() => state.navigableCollections)),
-                });
-              }
-            }),
-            Option.map((params) => constructObjectActions(params)),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-
-    // Object settings plank companion.
-    createExtension({
-      id: `${SPACE_PLUGIN}/settings`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (Obj.isObject(node.data) ? Option.some(node) : Option.none())),
-            Option.map((node) => [
-              {
-                id: [node.id, 'settings'].join(ATTENDABLE_PATH_SEPARATOR),
-                type: PLANK_COMPANION_TYPE,
-                data: 'settings',
-                properties: {
-                  label: ['object settings label', { ns: SPACE_PLUGIN }],
-                  icon: 'ph--sliders--regular',
-                  disposition: 'hidden',
-                  position: 'fallback',
-                },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  ]);
-};

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

@@ -1,76 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes, createIntent, type PluginContext } from '@dxos/app-framework';
-import { isSpace } from '@dxos/client/echo';
-import { Obj, Type } from '@dxos/echo';
-import { DataType } from '@dxos/schema';
-
-import { SPACE_PLUGIN } from '../meta';
-import translations from '../translations';
-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';
-
-export default (context: PluginContext) =>
-  contributes(Capabilities.AppGraphSerializer, [
-    {
-      inputType: SPACES,
-      outputType: DIRECTORY_TYPE,
-      serialize: (node) => ({
-        name: translations[0]['en-US'][SPACE_PLUGIN]['spaces label'],
-        data: translations[0]['en-US'][SPACE_PLUGIN]['spaces label'],
-        type: DIRECTORY_TYPE,
-      }),
-      deserialize: () => {
-        // No-op.
-      },
-    },
-    {
-      inputType: SPACE_TYPE,
-      outputType: DIRECTORY_TYPE,
-      serialize: (node) => ({
-        name: node.data.properties.name ?? translations[0]['en-US'][SPACE_PLUGIN]['unnamed space label'],
-        data: node.data.properties.name ?? translations[0]['en-US'][SPACE_PLUGIN]['unnamed space label'],
-        type: DIRECTORY_TYPE,
-      }),
-      deserialize: async (data) => {
-        const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-        const result = await dispatch(createIntent(SpaceAction.Create, { name: data.name, edgeReplication: true }));
-        return result.data?.space;
-      },
-    },
-    {
-      inputType: COLLECTION_TYPE,
-      outputType: DIRECTORY_TYPE,
-      serialize: (node) => ({
-        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) => Obj.instanceOf(DataType.Collection, ancestor)) ??
-          space?.properties[COLLECTION_TYPE]?.target;
-        if (!space || !collection) {
-          return;
-        }
-
-        const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-        const result = await dispatch(
-          createIntent(SpaceAction.AddObject, {
-            target: collection,
-            object: Obj.make(DataType.Collection, { name: data.name, objects: [] }),
-          }),
-        );
-
-        return result.data?.object;
-      },
-    },
-  ]);

package/src/capabilities/capabilities.ts

@@ -1,24 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineCapability, type Label } from '@dxos/app-framework';
-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';
-
-export namespace SpaceCapabilities {
-  export const State = defineCapability<DeepReadonly<PluginState>>(`${SPACE_PLUGIN}/capability/state`);
-  export const MutableState = defineCapability<PluginState>(`${SPACE_PLUGIN}/capability/state`);
-
-  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

@@ -1,27 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { contributes, type PluginContext, Capabilities } from '@dxos/app-framework';
-import { Obj, Ref, Type } from '@dxos/echo';
-import { Migrations } from '@dxos/migrations';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { DataType } from '@dxos/schema';
-
-export default async (context: PluginContext) => {
-  const client = context.getCapability(ClientCapabilities.Client);
-  await client.spaces.waitUntilReady();
-
-  const defaultSpace = client.spaces.default;
-  await defaultSpace.waitUntilReady();
-
-  // Create root collection structure.
-  defaultSpace.properties[Type.getTypename(DataType.Collection)] = Ref.make(
-    Obj.make(DataType.Collection, { objects: [] }),
-  );
-  if (Migrations.versionProperty) {
-    defaultSpace.properties[Migrations.versionProperty] = Migrations.targetVersion;
-  }
-
-  return contributes(Capabilities.Null, null);
-};