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

package/src/capabilities/spaces-ready.ts

@@ -1,231 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Option } from 'effect';
-
-import { contributes, createIntent, Capabilities, LayoutAction, type PluginContext } from '@dxos/app-framework';
-import { SubscriptionList } from '@dxos/async';
-import { Filter, Obj, Type } from '@dxos/echo';
-import { scheduledEffect } from '@dxos/echo-signals/core';
-import { log } from '@dxos/log';
-import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { DeckCapabilities } from '@dxos/plugin-deck';
-import { EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
-import { PublicKey } from '@dxos/react-client';
-import { FQ_ID_LENGTH, parseFullyQualifiedId, SpaceState } from '@dxos/react-client/echo';
-import { ComplexMap, reduceGroupBy } from '@dxos/util';
-
-import { SpaceCapabilities } from './capabilities';
-import { SpaceAction } from '../types';
-import { COMPOSER_SPACE_LOCK, SHARED } from '../util';
-
-const ACTIVE_NODE_BROADCAST_INTERVAL = 30_000;
-const WAIT_FOR_OBJECT_TIMEOUT = 5_000;
-
-export default async (context: PluginContext) => {
-  const subscriptions = new SubscriptionList();
-  const spaceSubscriptions = new SubscriptionList();
-
-  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-  const { graph } = context.getCapability(Capabilities.AppGraph);
-  const layout = context.getCapability(Capabilities.Layout);
-  const deck = context.getCapabilities(DeckCapabilities.DeckState)[0];
-  const attention = context.getCapability(AttentionCapabilities.Attention);
-  const state = context.getCapability(SpaceCapabilities.MutableState);
-  const client = context.getCapability(ClientCapabilities.Client);
-
-  const defaultSpace = client.spaces.default;
-  await defaultSpace.waitUntilReady();
-
-  if (deck?.activeDeck === 'default') {
-    await dispatch(createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: defaultSpace.id }));
-  }
-
-  // Initialize space sharing lock in default space.
-  if (typeof defaultSpace.properties[COMPOSER_SPACE_LOCK] !== 'boolean') {
-    defaultSpace.properties[COMPOSER_SPACE_LOCK] = true;
-  }
-
-  const {
-    objects: [spacesOrder],
-  } = await defaultSpace.db.query(Filter.type(Type.Expando, { key: SHARED })).run();
-  if (!spacesOrder) {
-    // TODO(wittjosiah): Cannot be a Folder because Spaces are not TypedObjects so can't be saved in the database.
-    //  Instead, we store order as an array of space ids.
-    defaultSpace.db.add(Obj.make(Type.Expando, { key: SHARED, order: [] }));
-  }
-
-  // Await missing objects.
-  subscriptions.add(
-    scheduledEffect(
-      () => ({ active: layout.active }),
-      ({ active }) => {
-        if (active.length !== 1) {
-          return;
-        }
-
-        const node = graph.getNode(active[0]).pipe(Option.getOrNull);
-        if (!node && active[0].length === FQ_ID_LENGTH) {
-          const timeout = setTimeout(async () => {
-            const node = graph.getNode(active[0]).pipe(Option.getOrNull);
-            if (!node) {
-              await dispatch(createIntent(SpaceAction.WaitForObject, { id: active[0] }));
-            }
-          }, WAIT_FOR_OBJECT_TIMEOUT);
-
-          return () => clearTimeout(timeout);
-        }
-      },
-    ),
-  );
-
-  // Cache space names.
-  subscriptions.add(
-    client.spaces.subscribe(async (spaces) => {
-      // TODO(wittjosiah): Remove. This is a hack to be able to migrate the default space properties.
-      if (defaultSpace.state.get() === SpaceState.SPACE_REQUIRES_MIGRATION) {
-        await defaultSpace.internal.migrate();
-      }
-
-      spaces
-        .filter((space) => space.state.get() === SpaceState.SPACE_READY)
-        .forEach((space) => {
-          subscriptions.add(
-            scheduledEffect(
-              () => ({ name: space.properties.name }),
-              ({ name }) => (state.spaceNames[space.id] = name),
-            ),
-          );
-        });
-    }).unsubscribe,
-  );
-
-  // Broadcast active node to other peers in the space.
-  subscriptions.add(
-    scheduledEffect(
-      () => ({ current: attention.current, active: layout.active, inactive: layout.inactive }),
-      ({ current, active, inactive }) => {
-        const send = () => {
-          const spaces = client.spaces.get();
-          const identity = client.halo.identity.get();
-          if (identity) {
-            // Group parts by space for efficient messaging.
-            const idsBySpace = reduceGroupBy(active, (id) => {
-              try {
-                const [spaceId] = parseFullyQualifiedId(id);
-                return spaceId;
-              } catch {
-                return null;
-              }
-            });
-
-            const removedBySpace = reduceGroupBy(inactive, (id) => {
-              try {
-                const [spaceId] = parseFullyQualifiedId(id);
-                return spaceId;
-              } catch {
-                return null;
-              }
-            });
-
-            // NOTE: Ensure all spaces are included so that we send the correct `removed` object arrays.
-            for (const space of spaces) {
-              if (!idsBySpace.has(space.id)) {
-                idsBySpace.set(space.id, []);
-              }
-            }
-
-            for (const [spaceId, added] of idsBySpace) {
-              const removed = removedBySpace.get(spaceId) ?? [];
-              const space = spaces.find((space) => space.id === spaceId);
-              if (!space) {
-                continue;
-              }
-
-              void space
-                .postMessage('viewing', {
-                  identityKey: identity.identityKey.toHex(),
-                  attended: current,
-                  added,
-                  removed,
-                })
-                // TODO(burdon): This seems defensive; why would this fail? Backoff interval.
-                .catch((err) => {
-                  log.warn('Failed to broadcast active node for presence.', { err: err.message });
-                });
-            }
-          }
-        };
-
-        send();
-        // Send at interval to allow peers to expire entries if they become disconnected.
-        const interval = setInterval(() => send(), ACTIVE_NODE_BROADCAST_INTERVAL);
-        return () => clearInterval(interval);
-      },
-    ),
-  );
-
-  // Listen for active nodes from other peers in the space.
-  subscriptions.add(
-    client.spaces.subscribe((spaces) => {
-      spaceSubscriptions.clear();
-      spaces.forEach((space) => {
-        spaceSubscriptions.add(
-          space.listen('viewing', (message) => {
-            const { added, removed, attended } = message.payload;
-
-            const identityKey = PublicKey.safeFrom(message.payload.identityKey);
-            const currentIdentity = client.halo.identity.get();
-            if (
-              identityKey &&
-              !currentIdentity?.identityKey.equals(identityKey) &&
-              Array.isArray(added) &&
-              Array.isArray(removed)
-            ) {
-              added.forEach((id) => {
-                if (typeof id === 'string') {
-                  if (!(id in state.viewersByObject)) {
-                    state.viewersByObject[id] = new ComplexMap(PublicKey.hash);
-                  }
-                  state.viewersByObject[id]!.set(identityKey, {
-                    lastSeen: Date.now(),
-                    currentlyAttended: new Set(attended).has(id),
-                  });
-                  if (!state.viewersByIdentity.has(identityKey)) {
-                    state.viewersByIdentity.set(identityKey, new Set());
-                  }
-                  state.viewersByIdentity.get(identityKey)!.add(id);
-                }
-              });
-
-              removed.forEach((id) => {
-                if (typeof id === 'string') {
-                  state.viewersByObject[id]?.delete(identityKey);
-                  state.viewersByIdentity.get(identityKey)?.delete(id);
-                  // It’s okay for these to be empty sets/maps, reduces churn.
-                }
-              });
-            }
-          }),
-        );
-      });
-    }).unsubscribe,
-  );
-
-  // Enable edge replication for all spaces.
-  try {
-    await Promise.all(
-      client.spaces.get().map((space) => space.internal.setEdgeReplicationPreference(EdgeReplicationSetting.ENABLED)),
-    );
-    state.enabledEdgeReplication = true;
-  } catch (err) {
-    log.catch(err);
-  }
-
-  return contributes(Capabilities.Null, null, () => {
-    spaceSubscriptions.clear();
-    subscriptions.clear();
-  });
-};

package/src/capabilities/state.ts

@@ -1,45 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { effect } from '@preact/signals-core';
-
-import { Capabilities, contributes, type PluginContext } from '@dxos/app-framework';
-import { PublicKey } from '@dxos/keys';
-import { LocalStorageStore } from '@dxos/local-storage';
-import { ComplexMap } from '@dxos/util';
-
-import { SpaceCapabilities } from './capabilities';
-import { SPACE_PLUGIN } from '../meta';
-import { type PluginState } from '../types';
-
-export default (context: PluginContext) => {
-  const state = new LocalStorageStore<PluginState>(SPACE_PLUGIN, {
-    awaiting: undefined,
-    spaceNames: {},
-    viewersByObject: {},
-    // TODO(wittjosiah): Stop using (Complex)Map inside reactive object.
-    viewersByIdentity: new ComplexMap(PublicKey.hash),
-    sdkMigrationRunning: {},
-    navigableCollections: false,
-    enabledEdgeReplication: false,
-  });
-
-  state
-    .prop({ key: 'spaceNames', type: LocalStorageStore.json<Record<string, string>>() })
-    .prop({ key: 'enabledEdgeReplication', type: LocalStorageStore.bool() });
-
-  const manager = context.getCapability(Capabilities.PluginManager);
-  const unsubscribe = effect(() => {
-    // TODO(wittjosiah): Find a way to make this capability-based.
-    const enabled = manager.enabled.includes('dxos.org/plugin/stack');
-    if (enabled !== state.values.navigableCollections) {
-      state.values.navigableCollections = enabled;
-    }
-  });
-
-  return contributes(SpaceCapabilities.State, state.values, () => {
-    unsubscribe();
-    state.close();
-  });
-};

package/src/components/CollectionMain.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useTranslation } from '@dxos/react-ui';
-import { baseSurface, descriptionMessage, mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
-
-import { SPACE_PLUGIN } from '../meta';
-
-export const CollectionMain = ({ collection }: { collection: DataType.Collection }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-
-  return (
-    <div
-      role='none'
-      className={mx(baseSurface, 'min-bs-screen is-full flex items-center justify-center p-8')}
-      data-testid='composer.firstRunMessage'
-    >
-      <p
-        role='alert'
-        className={mx(descriptionMessage, 'rounded-md p-8 font-normal text-lg max-is-[24rem] break-words')}
-      >
-        {collection.name ?? t('unnamed collection label')}
-      </p>
-    </div>
-  );
-};

package/src/components/MembersContainer.stories.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type StoryObj, type Meta } from '@storybook/react';
-
-import { withClientProvider } from '@dxos/react-client/testing';
-import { osTranslations } from '@dxos/shell/react';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
-
-import { MembersContainer } from './MembersContainer';
-import translations from '../translations';
-
-const meta: Meta = {
-  title: 'plugins/plugin-space/MembersContainer',
-  component: MembersContainer,
-  decorators: [withClientProvider({ createIdentity: true, createSpace: true }), withTheme, withLayout()],
-  parameters: {
-    layout: 'fullscreen',
-    translations: [...translations, osTranslations],
-  },
-};
-
-export default meta;
-
-type Story = StoryObj<typeof MembersContainer>;
-
-export const Default: Story = {};

package/src/components/ObjectSettings/AdvancedObjectSettings.tsx

@@ -1,80 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useState } from 'react';
-
-import { Obj } from '@dxos/echo';
-import { ForeignKey } from '@dxos/echo-schema';
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-
-import { ForeignKeys } from './ForeignKeys';
-import { SPACE_PLUGIN } from '../../meta';
-
-const initialValues = {
-  source: '',
-  id: '',
-};
-
-export type AdvancedObjectSettingsProps = {
-  object: Obj.Any;
-};
-
-export const AdvancedObjectSettings = ({ object }: AdvancedObjectSettingsProps) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const [adding, setAdding] = useState(false);
-  const { keys } = Obj.getMeta(object);
-
-  const handleNew = useCallback(() => setAdding(true), []);
-  const handleCancel = useCallback(() => setAdding(false), []);
-  const handleSave = useCallback(
-    (key: ForeignKey) => {
-      const index = keys.findIndex(({ source, id }) => source === key.source && id === key.id);
-      if (index === -1) {
-        keys.push(key);
-      }
-      setAdding(false);
-    },
-    [keys],
-  );
-  const handleDelete = useCallback(
-    (key: ForeignKey) => {
-      const index = keys.findIndex(({ source, id }) => source === key.source && id === key.id);
-      if (index !== -1) {
-        keys.splice(index, 1);
-      }
-    },
-    [keys],
-  );
-
-  // TODO(wittjosiah): This should be wrapped in an "Advanced" accordion.
-  return (
-    <>
-      <div className='p-2 flex flex-col gap-4'>
-        <h2>{t('advanced settings label')}</h2>
-        <div className='flex items-center'>
-          <h3 className='text-sm font-semibold'>{t('foreign keys')}</h3>
-          <div className='grow' />
-          <IconButton
-            classNames={adding && 'invisible'}
-            icon='ph--plus--regular'
-            label={t('add key')}
-            onClick={handleNew}
-          />
-        </div>
-        {!adding && <ForeignKeys keys={keys} onDelete={handleDelete} />}
-      </div>
-
-      {adding && (
-        <Form
-          outerSpacing={false}
-          schema={ForeignKey}
-          values={initialValues}
-          onSave={handleSave}
-          onCancel={handleCancel}
-        />
-      )}
-    </>
-  );
-};

package/src/components/ObjectSettings/BaseObjectSettings.tsx

@@ -1,47 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { type PropsWithChildren, useRef } from 'react';
-
-import { type Obj } from '@dxos/echo';
-import { Input, type ThemedClassName, useTranslation } from '@dxos/react-ui';
-
-import { meta } from '../../meta';
-
-export type BaseObjectSettingsProps = ThemedClassName<
-  PropsWithChildren<{
-    object: Obj.Any;
-  }>
->;
-
-export const BaseObjectSettings = ({ classNames, children, object }: BaseObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  const inputRef = useRef<HTMLInputElement>(null);
-
-  // TODO(wittjosiah): This should be a form based on the schema of the object.
-  //  The form should only include fields with a specific settings annotation.
-  //  Perhaps also including the field of the title annotation as well.
-  return (
-    <>
-      <Input.Root>
-        <Input.Label>{t('name label')}</Input.Label>
-        <Input.TextInput
-          ref={inputRef}
-          placeholder={t('name placeholder')}
-          // TODO(burdon): Use annotation to get the name field.
-          value={(object as any).name ?? ''}
-          onChange={(event) => {
-            (object as any).name = event.target.value;
-          }}
-          onKeyDown={(event) => {
-            if (event.key === 'Enter') {
-              inputRef.current?.blur();
-            }
-          }}
-        />
-      </Input.Root>
-      {children}
-    </>
-  );
-};

package/src/components/ObjectSettings/ObjectSettingsContainer.tsx

@@ -1,36 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { Surface } from '@dxos/app-framework';
-import { type Obj } from '@dxos/echo';
-import { Clipboard } from '@dxos/react-ui';
-import { StackItem } from '@dxos/react-ui-stack';
-
-import { BaseObjectSettings } from './BaseObjectSettings';
-
-export type ObjectSettingsContainerProps = {
-  object: Obj.Any;
-  role: string;
-};
-
-export const ObjectSettingsContainer = ({ object, role }: ObjectSettingsContainerProps) => {
-  const data = useMemo(() => ({ subject: object }), [object]);
-
-  return (
-    <Clipboard.Provider>
-      <StackItem.Content toolbar={false}>
-        <div role='none' className='overflow-y-auto pli-cardSpacingInline plb-cardSpacingBlock'>
-          <BaseObjectSettings object={object}>
-            <Surface role='base-object-settings' data={data} />
-          </BaseObjectSettings>
-          <Surface role='object-settings' data={data} />
-          {/* TODO(wittjosiah): Remove? */}
-          {/* <AdvancedObjectSettings object={object} /> */}
-        </div>
-      </StackItem.Content>
-    </Clipboard.Provider>
-  );
-};

package/src/components/ObjectSettings/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './ObjectSettingsContainer';

package/src/components/PersistenceStatus.tsx

@@ -1,84 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { ArrowsCounterClockwise, CheckCircle, Warning } from '@phosphor-icons/react';
-import React, { useEffect, useState } from 'react';
-
-import { debounce } from '@dxos/async';
-import { type EchoDatabase } from '@dxos/react-client/echo';
-import { Tooltip, useTranslation } from '@dxos/react-ui';
-import { getSize, mx, staticPlaceholderText, warningText } from '@dxos/react-ui-theme';
-
-import { SPACE_PLUGIN } from '../meta';
-
-enum Status {
-  PERSISTED_LOCALLY = 0,
-  PENDING = 1,
-  ERROR = 2,
-}
-
-// TODO(zan): This now has no usages. Remove it?
-export const PersistenceStatus = ({ db }: { db: EchoDatabase }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const [displayMessage, setDisplayMessage] = useState(false);
-  const [status, naturalSetStatus] = useState<Status>(Status.PERSISTED_LOCALLY);
-  const [prevStatus, setPrevStatus] = useState<Status>(Status.PERSISTED_LOCALLY);
-  const _setStatus = debounce(naturalSetStatus, 500);
-
-  // TODO(dmaretskyi): Fix this when we have save status for automerge.
-  // useEffect(() => {
-  //   return db.pendingBatch.on(({ duration, error }) => {
-  //     if (error) {
-  //       setStatus(Status.ERROR);
-  //     } else if (duration === undefined) {
-  //       setStatus(Status.PENDING);
-  //     } else {
-  //       setStatus(Status.PERSISTED_LOCALLY);
-  //     }
-  //   });
-  // }, [db]);
-
-  useEffect(() => {
-    // If this is changed outside the effect it's batched with setStatus and the following condition will never be true.
-    setPrevStatus(status);
-
-    if (prevStatus !== status && status === Status.PERSISTED_LOCALLY) {
-      setDisplayMessage(true);
-      const timeout = setTimeout(() => setDisplayMessage(false), 5000);
-      return () => clearTimeout(timeout);
-    }
-  }, [status]); // `prevStatus` omitted from dependency array to prevent timeout from being reset.
-
-  switch (status) {
-    case Status.ERROR:
-      return (
-        <div className='flex items-center'>
-          <Warning className={mx(getSize(4), 'me-1')} />
-          <span className={mx('text-sm', warningText)}>{t('persistence error label')}</span>
-        </div>
-      );
-    case Status.PENDING:
-      return (
-        <div className='flex items-center'>
-          <ArrowsCounterClockwise className={mx(getSize(4), 'me-1')} />
-          <span className={mx('text-sm', staticPlaceholderText)}>{t('persistence pending label')}</span>
-        </div>
-      );
-    case Status.PERSISTED_LOCALLY:
-    default:
-      return (
-        <Tooltip.Trigger
-          delayDuration={400}
-          role='status'
-          content={t('persisted locally message')}
-          className='flex items-center'
-        >
-          <CheckCircle className={mx(getSize(4), 'me-1')} />
-          {displayMessage && (
-            <span className={mx('text-sm', staticPlaceholderText)}>{t('persisted locally label')}</span>
-          )}
-        </Tooltip.Trigger>
-      );
-  }
-};

package/src/components/PopoverRenameObject.tsx

@@ -1,62 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useCallback, useRef, useState } from 'react';
-
-import { createIntent, LayoutAction, useIntentDispatcher } from '@dxos/app-framework';
-import { type Live } from '@dxos/live-object';
-import { log } from '@dxos/log';
-import { Button, Input, useTranslation } from '@dxos/react-ui';
-
-import { SPACE_PLUGIN } from '../meta';
-
-export const POPOVER_RENAME_OBJECT = `${SPACE_PLUGIN}/PopoverRenameObject`;
-
-export const PopoverRenameObject = ({ object: obj }: { object: Live<any> }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const doneButton = useRef<HTMLButtonElement>(null);
-  // TODO(wittjosiah): Use schema here.
-  const object = obj as any;
-  // TODO(burdon): Field should not be hardcoded field.
-  const [name, setName] = useState(object.name || object.title || '');
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  const handleDone = useCallback(() => {
-    try {
-      object.name = name;
-    } catch {
-      try {
-        object.title = name;
-      } catch (err) {
-        log.error('Failed to rename object', { err });
-      }
-    }
-    void dispatch(
-      createIntent(LayoutAction.UpdatePopover, {
-        part: 'popover',
-        options: { variant: 'react', anchorId: '', state: false },
-      }),
-    );
-  }, [object, name]);
-
-  return (
-    <div role='none' className='p-2 flex gap-2'>
-      <div role='none' className='flex-1'>
-        <Input.Root>
-          <Input.Label srOnly>{t('object name label')}</Input.Label>
-          <Input.TextInput
-            placeholder={t('object placeholder')}
-            value={name}
-            data-testid='spacePlugin.renameObject.input'
-            onChange={({ target: { value } }) => setName(value)}
-            onKeyDown={({ key }) => key === 'Enter' && doneButton.current?.click()}
-          />
-        </Input.Root>
-      </div>
-      <Button ref={doneButton} classNames='self-stretch' onClick={handleDone}>
-        {t('done label', { ns: 'os' })}
-      </Button>
-    </div>
-  );
-};

package/src/events.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineEvent, Events } from '@dxos/app-framework';
-
-import { SPACE_PLUGIN } from './meta';
-
-export namespace SpaceEvents {
-  export const StateReady = Events.createStateEvent(`${SPACE_PLUGIN}/event/state-ready`);
-  export const SetupSettingsPanel = defineEvent(`${SPACE_PLUGIN}/event/setup-settings-panel`);
-  export const DefaultSpaceReady = defineEvent(`${SPACE_PLUGIN}/event/default-space-ready`);
-  export const SpaceCreated = defineEvent(`${SPACE_PLUGIN}/event/space-created`);
-}