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

package/src/capabilities/react-root/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const ReactRoot = Capability.lazy('ReactRoot', () => import('./react-root'));

package/src/capabilities/react-root/react-root.tsx

@@ -0,0 +1,25 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { useAtomCapability } from '@dxos/app-framework/ui';
+
+import { AwaitingObject } from '../../components';
+import { meta } from '../../meta';
+import { SpaceCapabilities } from '../../types';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactRoot, {
+      id: meta.id,
+      root: () => {
+        const ephemeral = useAtomCapability(SpaceCapabilities.EphemeralState);
+        return ephemeral.awaiting ? <AwaitingObject id={ephemeral.awaiting} /> : null;
+      },
+    }),
+  ),
+);

package/src/capabilities/react-surface/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/react-surface/react-surface.tsx

@@ -0,0 +1,377 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+import type * as Schema from 'effect/Schema';
+import React, { useCallback } from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface, useAtomCapability, useSettingsState } from '@dxos/app-framework/ui';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { useLayout } from '@dxos/app-toolkit/ui';
+import { Database, Obj, type Ref } from '@dxos/echo';
+import { findAnnotation } from '@dxos/effect';
+import { type Space, SpaceState, getSpace, isSpace, parseId, useSpace } from '@dxos/react-client/echo';
+import { Input } from '@dxos/react-ui';
+import { type FormFieldComponentProps, SelectField } from '@dxos/react-ui-form';
+import { HuePicker, IconPicker } from '@dxos/react-ui-pickers';
+import { Collection, type View, ViewAnnotation } from '@dxos/schema';
+import { type JoinPanelProps } from '@dxos/shell/react';
+
+import {
+  CollectionArticle,
+  CollectionSection,
+  CreateObjectDialog,
+  type CreateObjectDialogProps,
+  CreateSpaceDialog,
+  InlineSyncStatus,
+  JoinDialog,
+  MembersContainer,
+  MenuFooter,
+  ObjectCardStack,
+  ObjectDetails,
+  ObjectRenamePopover,
+  RecordArticle,
+  SchemaContainer,
+  SmallPresenceLive,
+  SpacePluginSettings,
+  SpacePresence,
+  SpaceRenamePopover,
+  SpaceSettingsContainer,
+  SyncStatus,
+  ViewEditor,
+} from '../../components';
+import {
+  CREATE_OBJECT_DIALOG,
+  CREATE_SPACE_DIALOG,
+  JOIN_DIALOG,
+  OBJECT_RENAME_POPOVER,
+  SPACE_RENAME_POPOVER,
+} from '../../constants';
+import { useTypeOptions } from '../../hooks';
+import { meta } from '../../meta';
+import {
+  HueAnnotationId,
+  IconAnnotationId,
+  SpaceCapabilities,
+  type SpaceSettingsProps,
+  type TypeInputOptions,
+  TypeInputOptionsAnnotationId,
+} from '../../types';
+
+type ReactSurfaceOptions = {
+  createInvitationUrl: (invitationCode: string) => string;
+};
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* (props?: ReactSurfaceOptions) {
+    const { createInvitationUrl } = props!;
+
+    return Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: `${meta.id}/article`,
+        role: 'article',
+        filter: (data): data is { subject: Space } =>
+          // TODO(wittjosiah): Need to avoid shotgun parsing space state everywhere.
+          isSpace(data.subject) && data.subject.state.get() === SpaceState.SPACE_READY,
+        component: ({ data, role, ...rest }) => (
+          <Surface.Surface
+            data={{
+              id: data.subject.id,
+              subject: data.subject.properties[Collection.Collection.typename]?.target,
+            }}
+            role={role}
+            {...rest}
+          />
+        ),
+      }),
+      Surface.create({
+        id: `${meta.id}/collection-fallback`,
+        role: 'article',
+        position: 'fallback',
+        filter: (data): data is { subject: Collection.Collection | Collection.Managed } =>
+          Obj.instanceOf(Collection.Collection, data.subject) || Obj.instanceOf(Collection.Managed, data.subject),
+        component: ({ data }) => <CollectionArticle subject={data.subject} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/record-article`,
+        role: 'article',
+        position: 'fallback',
+        filter: (data): data is { subject: Obj.Unknown } => Obj.isObject(data.subject),
+        component: ({ data }) => <RecordArticle subject={data.subject} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/plugin-settings`,
+        role: 'article',
+        filter: (data): data is { subject: AppCapabilities.Settings } =>
+          AppCapabilities.isSettings(data.subject) && data.subject.prefix === meta.id,
+        component: ({ data: { subject } }) => {
+          const { settings, updateSettings } = useSettingsState<SpaceSettingsProps>(subject.atom);
+          return <SpacePluginSettings settings={settings} onSettingsChange={updateSettings} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/companion/object-settings`,
+        role: 'article',
+        filter: (data): data is { companionTo: Obj.Unknown } =>
+          Obj.isObject(data.companionTo) && data.subject === 'settings',
+        component: ({ ref, data, role }) => <ObjectDetails subject={data.companionTo} role={role} ref={ref} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/space-settings-properties`,
+        role: 'article',
+        filter: (data): data is { subject: string } => data.subject === `${meta.id}/properties`,
+        component: ({ ref }) => {
+          const layout = useLayout();
+          const { spaceId } = parseId(layout.workspace);
+          const space = useSpace(spaceId);
+          if (!space || !spaceId) {
+            return null;
+          }
+
+          return <SpaceSettingsContainer space={space} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/space-settings-members`,
+        role: 'article',
+        position: 'hoist',
+        filter: (data): data is { subject: string } => data.subject === `${meta.id}/members`,
+        component: () => {
+          const layout = useLayout();
+          const { spaceId } = parseId(layout.workspace);
+          const space = useSpace(spaceId);
+          if (!space || !spaceId) {
+            return null;
+          }
+
+          return <MembersContainer space={space} createInvitationUrl={createInvitationUrl} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/space-settings-schema`,
+        role: 'article',
+        filter: (data): data is { subject: string } => data.subject === `${meta.id}/schema`,
+        component: () => {
+          const layout = useLayout();
+          const { spaceId } = parseId(layout.workspace);
+          const space = useSpace(spaceId);
+          if (!space || !spaceId) {
+            return null;
+          }
+
+          return <SchemaContainer space={space} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/selected-objects`,
+        role: 'article',
+        filter: (data): data is { companionTo: Obj.Obj<{ view: Ref.Ref<View.View> }>; subject: 'selected-objects' } => {
+          if (data.subject !== 'selected-objects' || !Obj.isObject(data.companionTo)) {
+            return false;
+          }
+
+          // TODO(burdon): Check companionTo.view.target is valid.
+          const schema = Obj.getSchema(data.companionTo);
+          return Option.fromNullable(schema).pipe(
+            Option.flatMap((schema) => ViewAnnotation.get(schema)),
+            Option.getOrElse(() => false),
+          );
+        },
+        component: ({ data, ref }) => (
+          <ObjectCardStack
+            key={Obj.getDXN(data.companionTo).toString()}
+            objectId={Obj.getDXN(data.companionTo).toString()}
+            view={data.companionTo.view.target!}
+            ref={ref}
+          />
+        ),
+      }),
+      Surface.create({
+        id: JOIN_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { props: JoinPanelProps } => data.component === JOIN_DIALOG,
+        component: ({ data }) => <JoinDialog {...data.props} />,
+      }),
+      Surface.create({
+        id: CREATE_SPACE_DIALOG,
+        role: 'dialog',
+        filter: (data): data is any => data.component === CREATE_SPACE_DIALOG,
+        component: () => <CreateSpaceDialog />,
+      }),
+      Surface.create({
+        id: CREATE_OBJECT_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { props: CreateObjectDialogProps } => data.component === CREATE_OBJECT_DIALOG,
+        component: ({ data }) => <CreateObjectDialog {...data.props} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/create-initial-space-form-[hue]`,
+        role: 'form-input',
+        filter: (data): data is { prop: string; schema: Schema.Schema<any> } => {
+          const annotation = findAnnotation<boolean>((data.schema as Schema.Schema.All).ast, HueAnnotationId);
+          return !!annotation;
+        },
+        component: ({ data: _, ...inputProps }) => {
+          const { label, readonly, type, getValue, onValueChange } = inputProps as any as FormFieldComponentProps;
+          const handleChange = useCallback((nextHue: string) => onValueChange(type, nextHue), [onValueChange]);
+          const handleReset = useCallback(() => onValueChange(type, undefined), [onValueChange]);
+          return (
+            <Input.Root>
+              <Input.Label>{label}</Input.Label>
+              <HuePicker disabled={!!readonly} value={getValue() ?? ''} onChange={handleChange} onReset={handleReset} />
+            </Input.Root>
+          );
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/create-initial-space-form-[icon]`,
+        role: 'form-input',
+        filter: (data): data is { prop: string; schema: Schema.Schema<any> } => {
+          const annotation = findAnnotation<boolean>((data.schema as Schema.Schema.All).ast, IconAnnotationId);
+          return !!annotation;
+        },
+        component: ({ data: _, ...inputProps }) => {
+          const { label, readonly, type, getValue, onValueChange } = inputProps as any as FormFieldComponentProps;
+          const handleChange = useCallback((nextIcon: string) => onValueChange(type, nextIcon), [onValueChange]);
+          const handleReset = useCallback(() => onValueChange(type, undefined), [onValueChange]);
+          return (
+            <Input.Root>
+              <Input.Label>{label}</Input.Label>
+              <IconPicker
+                disabled={!!readonly}
+                value={getValue() ?? ''}
+                onChange={handleChange}
+                onReset={handleReset}
+              />
+            </Input.Root>
+          );
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/typename-form-input`,
+        role: 'form-input',
+        filter: (
+          data,
+        ): data is {
+          prop: string;
+          schema: Schema.Schema.Any;
+          target: Database.Database | Collection.Collection | undefined;
+        } => {
+          if (data.prop !== 'typename') {
+            return false;
+          }
+
+          const annotation = findAnnotation((data.schema as Schema.Schema.All).ast, TypeInputOptionsAnnotationId);
+          return !!annotation;
+        },
+        component: ({ data: { schema, target }, ...inputProps }) => {
+          const props = inputProps as any as FormFieldComponentProps;
+          const db = Database.isDatabase(target) ? target : target && Obj.getDatabase(target);
+          const space = useSpace(db?.spaceId);
+          const annotation = findAnnotation<TypeInputOptions>(schema.ast, TypeInputOptionsAnnotationId)!;
+          const options = useTypeOptions({ space, annotation });
+
+          return <SelectField {...props} options={options} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/object-settings`,
+        role: 'object-settings',
+        filter: (data): data is { subject: { view: Ref.Ref<View.View> } } => {
+          if (!Obj.isObject(data.subject)) {
+            return false;
+          }
+
+          const schema = Obj.getSchema(data.subject);
+          return Option.fromNullable(schema).pipe(
+            Option.flatMap((schema) => ViewAnnotation.get(schema)),
+            Option.getOrElse(() => false),
+          );
+        },
+        component: ({ data }) => {
+          const view = data.subject.view.target;
+          if (!view) {
+            return null;
+          }
+
+          return <ViewEditor view={view} />;
+        },
+      }),
+      Surface.create({
+        id: SPACE_RENAME_POPOVER,
+        role: 'popover',
+        filter: (data): data is { props: Space } => data.component === SPACE_RENAME_POPOVER && isSpace(data.props),
+        component: ({ data }) => <SpaceRenamePopover space={data.props} />,
+      }),
+      Surface.create({
+        id: OBJECT_RENAME_POPOVER,
+        role: 'popover',
+        filter: (data): data is { props: Obj.Unknown } =>
+          data.component === OBJECT_RENAME_POPOVER && Obj.isObject(data.props),
+        component: ({ data }) => <ObjectRenamePopover object={data.props} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/menu-footer`,
+        role: 'menu-footer',
+        filter: (data): data is { subject: Obj.Unknown } => Obj.isObject(data.subject),
+        component: ({ data }) => <MenuFooter object={data.subject} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/navtree-presence`,
+        role: 'navtree-item-end',
+        filter: (data): data is { id: string; subject: Obj.Unknown; open?: boolean } =>
+          typeof data.id === 'string' && Obj.isObject(data.subject),
+        component: ({ data }) => {
+          const ephemeral = useAtomCapability(SpaceCapabilities.EphemeralState);
+          return <SmallPresenceLive id={data.id} open={data.open} viewers={ephemeral.viewersByObject[data.id]} />;
+        },
+      }),
+      // TODO(wittjosiah): Attention glyph for non-echo items should be handled elsewhere.
+      Surface.create({
+        id: `${meta.id}/navtree-presence-fallback`,
+        role: 'navtree-item-end',
+        position: 'fallback',
+        filter: (data): data is { id: string; open?: boolean } => typeof data.id === 'string',
+        component: ({ data }) => <SmallPresenceLive id={data.id} open={data.open} />,
+      }),
+      // TODO(wittjosiah): Broken?
+      Surface.create({
+        id: `${meta.id}/navtree-sync-status`,
+        role: 'navtree-item-end',
+        filter: (data): data is { subject: Space; open?: boolean } => isSpace(data.subject),
+        component: ({ data }) => <InlineSyncStatus space={data.subject} open={data.open} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/navbar-presence`,
+        role: 'navbar-end',
+        position: 'hoist',
+        filter: (data): data is { subject: Space | Obj.Unknown } => isSpace(data.subject) || Obj.isObject(data.subject),
+        component: ({ data }) => {
+          const space = isSpace(data.subject) ? data.subject : getSpace(data.subject);
+          const object = isSpace(data.subject)
+            ? data.subject.state.get() === SpaceState.SPACE_READY
+              ? (space?.properties[Collection.Collection.typename]?.target as Collection.Collection)
+              : undefined
+            : data.subject;
+
+          return object ? <SpacePresence object={object} /> : null;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/collection-section`,
+        role: 'section',
+        filter: (data): data is { subject: Collection.Collection } =>
+          Obj.instanceOf(Collection.Collection, data.subject),
+        component: ({ data }) => <CollectionSection subject={data.subject} />,
+      }),
+      Surface.create({
+        id: `${meta.id}/status`,
+        role: 'status',
+        component: () => <SyncStatus />,
+      }),
+    ]);
+  }),
+);

package/src/capabilities/repair/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const Repair = Capability.lazy('Repair', () => import('./repair'));

package/src/capabilities/repair/repair.ts

@@ -0,0 +1,67 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { Obj, Ref, Type } from '@dxos/echo';
+import { type Space } from '@dxos/react-client/echo';
+import { Collection } from '@dxos/schema';
+
+import { SpaceCapabilities } from '../../types';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(SpaceCapabilities.Repair, async ({ space }: { space: Space }) => {
+      await removeQueryCollections(space);
+      await ensureSystemCollection(space);
+    }),
+  ),
+);
+
+/**
+ * Remove all existing query collections from the root collection.
+ */
+const removeQueryCollections = async (space: Space) => {
+  const rootCollection: Collection.Collection = await space.properties[Collection.Collection.typename]?.load();
+  if (!rootCollection) {
+    return;
+  }
+
+  const objects = await Promise.all(rootCollection.objects.map((ref) => ref.load()));
+  const queryCollections = objects.filter((object) => Obj.getTypename(object) === 'dxos.org/type/QueryCollection');
+  if (queryCollections.length === 0) {
+    return;
+  }
+
+  Obj.change(rootCollection, (c) => {
+    c.objects = objects
+      .filter((object) => Obj.getTypename(object) !== 'dxos.org/type/QueryCollection')
+      .map((object) => Ref.make(object));
+  });
+  queryCollections.forEach((object) => space.db.remove(object));
+};
+
+/**
+ * Ensure the root collection has a system collection for StoredSchema.
+ */
+const ensureSystemCollection = async (space: Space) => {
+  const rootCollection: Collection.Collection = await space.properties[Collection.Collection.typename]?.load();
+  if (!rootCollection) {
+    return;
+  }
+
+  const objects = await Promise.all(rootCollection.objects.map((ref) => ref.load()));
+  const records = objects.find(
+    (object) => Obj.instanceOf(Collection.Managed, object) && object.key === Type.getTypename(Type.PersistentType),
+  );
+  if (records) {
+    return;
+  }
+
+  const recordsCollectionRef = Ref.make(Collection.makeManaged({ key: Type.getTypename(Type.PersistentType) }));
+  Obj.change(rootCollection, (c) => {
+    c.objects.push(recordsCollectionRef);
+  });
+};

package/src/capabilities/settings/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const SpaceSettings = Capability.lazy('SpaceSettings', () => import('./settings'));

package/src/capabilities/settings/settings.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { createKvsStore } from '@dxos/effect';
+
+import { meta } from '../../meta';
+import { SpaceCapabilities, SpaceSettingsSchema } from '../../types';
+
+export default Capability.makeModule(() =>
+  Effect.sync(() => {
+    const settingsAtom = createKvsStore({
+      key: meta.id,
+      schema: SpaceSettingsSchema,
+      defaultValue: () => ({
+        showHidden: false,
+      }),
+    });
+
+    return [
+      Capability.contributes(SpaceCapabilities.Settings, settingsAtom),
+      Capability.contributes(AppCapabilities.Settings, {
+        prefix: meta.id,
+        schema: SpaceSettingsSchema,
+        atom: settingsAtom,
+      }),
+    ];
+  }),
+);

package/src/capabilities/spaces-ready/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const SpacesReady = Capability.lazy('SpacesReady', () => import('./spaces-ready'));