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

package/src/commands/space/close/close.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+
+import { CommandConfig, Common, getSpace, waitForSync } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { type Key } from '@dxos/echo';
+
+export const handler = ({ spaceId }: { spaceId: Key.SpaceId }) =>
+  Effect.gen(function* () {
+    const { json } = yield* CommandConfig;
+    const client = yield* ClientService;
+
+    const space = yield* getSpace(spaceId);
+
+    // Flush and sync before closing
+    yield* Effect.tryPromise(() => space.db.flush());
+    yield* waitForSync(space);
+
+    yield* Effect.tryPromise(() => space.close());
+
+    if (json) {
+      yield* Console.log(JSON.stringify({ success: true, spaceId }, null, 2));
+    } else {
+      yield* Console.log(`Space ${spaceId} closed successfully.`);
+    }
+  });
+
+export const close = Command.make(
+  'close',
+  {
+    spaceId: Common.spaceId.pipe(Options.withDescription('Space ID to close.')),
+  },
+  handler,
+).pipe(Command.withDescription('Close a space.'));

package/src/commands/space/create/create.ts

@@ -0,0 +1,61 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig } from '@dxos/cli-util';
+import { print, waitForSync } from '@dxos/cli-util';
+import { FormBuilder } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { Obj } from '@dxos/echo';
+
+export const handler = Effect.fn(function* ({ name }: { name: Option.Option<string> }) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+
+  const space = yield* Effect.tryPromise(() => client.spaces.create());
+  yield* Effect.tryPromise(() => space.waitUntilReady());
+
+  if (Option.isSome(name)) {
+    Obj.update(space.properties, (obj) => {
+      obj.name = Option.getOrUndefined(name);
+    });
+  }
+
+  // Output first, then flush and sync
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          key: space.key.toHex(),
+          ...(space.properties.name ? { name: space.properties.name } : {}),
+        },
+        null,
+        2,
+      ),
+    );
+  } else {
+    const builder = FormBuilder.make({ title: 'Created Space' }).pipe(
+      FormBuilder.set('key', space.key.truncate()),
+      FormBuilder.set('name', space.properties.name ?? '<none>'),
+    );
+    yield* Console.log(print(FormBuilder.build(builder)));
+  }
+
+  // Flush and sync before completion
+  yield* Effect.tryPromise(() => space.db.flush());
+  yield* waitForSync(space);
+});
+
+export const create = Command.make(
+  'create',
+  {
+    name: Options.text('name').pipe(Options.withDescription('The name of the space.'), Options.optional),
+  },
+  handler,
+).pipe(Command.withDescription('Create a new space.'));

package/src/commands/space/info/info.test.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+
+import { handler } from './info';
+
+describe('space info', () => {
+  it('should show space info', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      const space = yield* Effect.tryPromise(() => client.spaces.create());
+      yield* Effect.tryPromise(() => space.waitUntilReady());
+      yield* handler({ spaceId: Option.some(space.id), wait: Option.none() });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsed = TestConsole.parseJson<{ id: string; state: string; key: string }>(logs[0]);
+      expect(parsed).toHaveProperty('id');
+      expect(parsed).toHaveProperty('state');
+      expect(parsed).toHaveProperty('key');
+      expect(parsed.id).toBe(space.id);
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+});

package/src/commands/space/info/info.ts

@@ -0,0 +1,50 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig, Common, formatSpace, getSpace, print, printSpace, spaceIdWithDefault } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { type Key } from '@dxos/echo';
+
+export const handler = Effect.fn(function* ({
+  spaceId,
+  wait,
+}: {
+  spaceId: Option.Option<string>;
+  wait: Option.Option<number>;
+}) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+
+  const resolvedSpaceId = yield* spaceIdWithDefault(spaceId as Option.Option<Key.SpaceId>);
+  const space = yield* getSpace(resolvedSpaceId);
+
+  const waitSeconds = Option.getOrElse(wait, () => 0);
+  const formatted = yield* formatSpace(space, { waitSeconds });
+
+  if (json) {
+    yield* Console.log(JSON.stringify(formatted, null, 2));
+  } else {
+    yield* Console.log(print(printSpace(formatted)));
+  }
+});
+
+export const info = Command.make(
+  'info',
+  {
+    spaceId: Common.spaceId.pipe(Options.optional),
+    wait: Options.integer('wait').pipe(
+      Options.withDescription(
+        'Wait up to this many seconds for the space to reach SPACE_READY. Default 0 — read whatever state is available immediately.',
+      ),
+      Options.optional,
+    ),
+  },
+  handler,
+).pipe(Command.withDescription('Show space info.'));

package/src/commands/space/join/join.ts

@@ -0,0 +1,122 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Args from '@effect/cli/Args';
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Prompt from '@effect/cli/Prompt';
+import * as Console from 'effect/Console';
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig } from '@dxos/cli-util';
+import { print, waitForSync } from '@dxos/cli-util';
+import { FormBuilder } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+
+import { acceptInvitation } from './util';
+
+export const handler = Effect.fn(function* ({
+  invitationCode,
+  authCode,
+}: {
+  invitationCode: string;
+  authCode: Option.Option<string>;
+}) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+
+  let encoded = invitationCode;
+  if (encoded.startsWith('http') || encoded.startsWith('socket')) {
+    const searchProps = new URL(encoded).searchParams;
+    encoded = searchProps.get('spaceInvitationCode') ?? encoded;
+  }
+
+  const invitation = yield* acceptInvitation({
+    observable: client.spaces.join(encoded),
+    callbacks: {
+      onReadyForAuth: (invitation) => {
+        if (Option.isSome(authCode)) {
+          return Effect.succeed(Option.getOrUndefined(authCode) ?? undefined) as Effect.Effect<
+            string | void,
+            never,
+            never
+          >;
+        }
+        return Prompt.text({ message: 'Enter the authentication code' })
+          .pipe(Prompt.run)
+          .pipe(Effect.mapError(() => undefined as never))
+          .pipe(Effect.catchAll(() => Effect.succeed(undefined))) as Effect.Effect<string | void, never, never>;
+      },
+    },
+  });
+
+  // Wait for space to be available with retry logic
+  const spaceKey = invitation.spaceKey;
+  if (!spaceKey) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'No space key in invitation' }, null, 2));
+    } else {
+      yield* Console.log('No space key in invitation.');
+    }
+    return;
+  }
+
+  let space = client.spaces.get(spaceKey);
+  if (!space) {
+    // Retry up to 5 times with increasing delays
+    const maxRetries = 5;
+    const retryDelays = [0.5, 1, 1.5, 2, 2.5].map((s) => Duration.seconds(s));
+    for (let i = 0; i < maxRetries; i++) {
+      yield* Effect.sleep(retryDelays[i]);
+      space = client.spaces.get(spaceKey);
+      if (space) {
+        break;
+      }
+    }
+  }
+
+  if (!space) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'Space not found after joining' }, null, 2));
+    } else {
+      yield* Console.log('Space not found after joining.');
+    }
+    return;
+  }
+
+  // Flush and sync after joining
+  yield* Effect.tryPromise(() => space.db.flush());
+  yield* waitForSync(space);
+
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          spaceId: space.id,
+          state: space.state.get(),
+        },
+        null,
+        2,
+      ),
+    );
+  } else {
+    const builder = FormBuilder.make({ title: 'Joined Space' }).pipe(
+      FormBuilder.set('spaceId', space.id),
+      FormBuilder.set('key', space.key.truncate()),
+      FormBuilder.set('name', space.properties.name ?? '<none>'),
+    );
+    yield* Console.log(print(FormBuilder.build(builder)));
+  }
+});
+
+export const join = Command.make(
+  'join',
+  {
+    invitationCode: Args.text({ name: 'invitationCode' }).pipe(Args.withDescription('The invitation code.')),
+    authCode: Options.text('authCode').pipe(Options.withDescription('The authentication code.'), Options.optional),
+  },
+  handler,
+).pipe(Command.withDescription('Join a space via invitation.'));

package/src/commands/space/list/list.test.ts

@@ -0,0 +1,37 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+
+import { handler } from './list';
+
+describe('spaces list', () => {
+  it('should list empty space list', () =>
+    Effect.gen(function* () {
+      yield* handler({ wait: Option.none() });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      expect(TestConsole.extractJsonString(logs[0])).toEqual('[]');
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+
+  it('should list spaces', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      yield* Effect.tryPromise(() => client.spaces.create());
+      yield* handler({ wait: Option.none() });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const formattedSpaces = TestConsole.parseJson(logs[0]);
+      expect(formattedSpaces).toHaveLength(1);
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+});

package/src/commands/space/list/list.ts

@@ -0,0 +1,42 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig, formatSpace, printSpace } from '@dxos/cli-util';
+import { printList } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+
+// TODO(burdon): Move handler inline and test separate functions.
+export const handler = Effect.fn(function* ({ wait }: { wait: Option.Option<number> }) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  const spaces = client.spaces.get();
+  const waitSeconds = Option.getOrElse(wait, () => 0);
+  const formattedSpaces = yield* Effect.all(spaces.map((space) => formatSpace(space, { waitSeconds })));
+
+  if (json) {
+    yield* Console.log(JSON.stringify(formattedSpaces, null, 2));
+  } else {
+    const formatted = formattedSpaces.map(printSpace);
+    yield* Console.log(printList(formatted));
+  }
+});
+
+export const list = Command.make(
+  'list',
+  {
+    wait: Options.integer('wait').pipe(
+      Options.withDescription(
+        'Wait up to this many seconds for each space to reach SPACE_READY before reading. Default 0 — print whatever state is available immediately so a stuck space cannot hang the command.',
+      ),
+      Options.optional,
+    ),
+  },
+  handler,
+).pipe(Command.withDescription('List all spaces available on this device.'));

package/src/commands/space/members/members.test.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+
+import { handler } from './members';
+
+describe('space members', () => {
+  it('should list space members', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      const space = yield* Effect.tryPromise(() => client.spaces.create());
+      yield* Effect.tryPromise(() => space.waitUntilReady());
+      yield* handler({ spaceId: Option.some(space.id) });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsed = TestConsole.parseJson<Array<{ key: string; presence: string }>>(logs[0]);
+      expect(Array.isArray(parsed)).toBe(true);
+      expect(parsed.length).toBeGreaterThan(0);
+      expect(parsed[0]).toHaveProperty('key');
+      expect(parsed[0]).toHaveProperty('presence');
+      // name might be undefined if identity has no displayName
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+});

package/src/commands/space/open/open.ts

@@ -0,0 +1,39 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+
+import { CommandConfig, Common, getSpace, waitForSync } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { type Key } from '@dxos/echo';
+
+export const handler = ({ spaceId }: { spaceId: Key.SpaceId }) =>
+  Effect.gen(function* () {
+    const { json } = yield* CommandConfig;
+    const client = yield* ClientService;
+
+    const space = yield* getSpace(spaceId);
+    yield* Effect.tryPromise(() => space.open());
+
+    // Flush and sync after opening
+    yield* Effect.tryPromise(() => space.db.flush());
+    yield* waitForSync(space);
+
+    if (json) {
+      yield* Console.log(JSON.stringify({ success: true, spaceId }, null, 2));
+    } else {
+      yield* Console.log(`Space ${spaceId} opened successfully.`);
+    }
+  });
+
+export const open = Command.make(
+  'open',
+  {
+    spaceId: Common.spaceId.pipe(Options.withDescription('Space ID to open.')),
+  },
+  handler,
+).pipe(Command.withDescription('Open a space.'));

package/src/commands/space/schema/list/list.test.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+
+import { handler } from './list';
+
+describe('space schema list', () => {
+  it('should list space schemas', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      const space = yield* Effect.tryPromise(() => client.spaces.create());
+      yield* Effect.tryPromise(() => space.waitUntilReady());
+      yield* handler({ spaceId: Option.some(space.id), typename: Option.none() });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsed = TestConsole.parseJson(logs[0]);
+      expect(Array.isArray(parsed)).toBe(true);
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+});

package/src/components/AwaitingObject/AwaitingObject.tsx

@@ -0,0 +1,114 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useCallback, useEffect, useState } from 'react';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { useLayout } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { useClient } from '@dxos/react-client';
+import { Filter, useQuery } from '@dxos/react-client/echo';
+import { Button, Icon, Toast, useTranslation } from '@dxos/react-ui';
+import { osTranslations } from '@dxos/ui-theme';
+
+import { meta } from '#meta';
+import { SpaceOperation } from '#operations';
+
+const WAIT_FOR_OBJECT_TIMEOUT = 3 * 60 * 1_000;
+const TOAST_TIMEOUT = 4 * 60 * 1_000;
+
+export const AwaitingObject = ({ id }: { id: string }) => {
+  const { t } = useTranslation(meta.id);
+  const { invokePromise } = useOperationInvoker();
+  const [open, setOpen] = useState(true);
+  const [waiting, setWaiting] = useState(true);
+  const [found, setFound] = useState(false);
+  const layout = useLayout();
+
+  const client = useClient();
+  const objects = useQuery(client.spaces, Filter.everything());
+
+  useEffect(() => {
+    if (!id) {
+      return;
+    }
+
+    const timeout = setTimeout(() => setWaiting(false), WAIT_FOR_OBJECT_TIMEOUT);
+    return () => clearTimeout(timeout);
+  }, [id]);
+
+  useEffect(() => {
+    if (objects.findIndex((object) => Obj.getDXN(object).toString() === id) > -1) {
+      setFound(true);
+      if (layout.active.includes(id)) {
+        setOpen(false);
+      }
+    }
+  }, [id, objects, layout]);
+
+  const handleClose = useCallback(
+    async () => invokePromise(SpaceOperation.WaitForObject, { id: undefined }),
+    [invokePromise],
+  );
+
+  const handleNavigate = useCallback(() => {
+    void invokePromise(LayoutOperation.Open, { subject: [id] });
+    void handleClose();
+  }, [id, handleClose, invokePromise]);
+
+  return (
+    <Toast.Root open={open} duration={TOAST_TIMEOUT} onOpenChange={setOpen}>
+      <Toast.Body>
+        <Toast.Title classNames='flex items-center gap-2'>
+          {found ? (
+            <>
+              <Icon icon='ph--check-circle--regular' />
+              <span>{t('found-object.label')}</span>
+            </>
+          ) : waiting ? (
+            <>
+              <Icon icon='ph--circle-notch--regular' classNames='animate-spin' />
+              <span>{t('waiting-for-object.label')}</span>
+            </>
+          ) : (
+            <>
+              <Icon icon='ph--circle-dashed--regular' />
+              <span>{t('object-not-found.label')}</span>
+            </>
+          )}
+        </Toast.Title>
+        <Toast.Description>
+          {t(
+            found
+              ? 'found-object.description'
+              : waiting
+                ? 'waiting-for-object.description'
+                : 'object-not-found.description',
+          )}
+        </Toast.Description>
+      </Toast.Body>
+      <Toast.Actions>
+        {found ? (
+          <>
+            <Toast.Action altText={t('go-to-object.alt')} asChild>
+              <Button variant='primary' onClick={handleNavigate}>
+                {t('go-to-object.label')}
+              </Button>
+            </Toast.Action>
+            <Toast.Close asChild>
+              <Button onClick={handleClose}>{t('close.label', { ns: osTranslations })}</Button>
+            </Toast.Close>
+          </>
+        ) : (
+          <Toast.Close asChild>
+            <Button onClick={handleClose}>
+              {t(waiting ? 'close.label' : 'confirm.label', { ns: osTranslations })}
+            </Button>
+          </Toast.Close>
+        )}
+      </Toast.Actions>
+    </Toast.Root>
+  );
+};

package/src/components/AwaitingObject/index.ts

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