@dxos/plugin-space 0.8.4-main.8360d9e660 → 0.8.4-main.8baae0fced

package/src/commands/database/stats.ts

@@ -0,0 +1,43 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Array from 'effect/Array';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Function from 'effect/Function';
+import * as Record from 'effect/Record';
+
+import { CommandConfig, Common, printList, spaceLayer } from '@dxos/cli-util';
+import { Database, Filter, Obj, Query } from '@dxos/echo';
+
+import { printStats } from './util';
+
+export const stats = Command.make(
+  'stats',
+  {
+    spaceId: Common.spaceId.pipe(Options.optional),
+  },
+  () =>
+    Effect.gen(function* () {
+      const { json } = yield* CommandConfig;
+      const objects = yield* Database.runQuery(Query.select(Filter.everything()));
+      const stats = Function.pipe(
+        objects,
+        Array.groupBy((obj) => Obj.getTypename(obj) ?? '<empty>'),
+        Record.map((objs) => objs.length),
+      );
+
+      if (json) {
+        yield* Console.log(JSON.stringify(stats, null, 2));
+      } else {
+        const formatted = Record.toEntries(stats).map(([typename, count]) => printStats(typename, count));
+        yield* Console.log(printList(formatted));
+      }
+    }),
+).pipe(
+  Command.withDescription('Query objects.'),
+  Command.provide(({ spaceId }) => spaceLayer(spaceId, true)),
+);

package/src/commands/queue/query.ts

@@ -0,0 +1,54 @@
+//
+// 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 Schema from 'effect/Schema';
+
+import { CommandConfig, printList } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { DXN, type SpaceId } from '@dxos/keys';
+
+import { printQueueObject } from './util';
+
+// TODO(dmaretskyi): Extract
+const DXNSchema = Schema.String.pipe(
+  Schema.transform(Schema.instanceOf(DXN), {
+    decode: (value: string) => DXN.parse(value),
+    encode: (value: DXN) => value.toString(),
+  }),
+);
+
+export const query = Command.make(
+  'query',
+  {
+    dxn: Options.text('dxn').pipe(Options.withDescription('DXN of the queue.'), Options.withSchema(DXNSchema)),
+  },
+  Effect.fnUntraced(function* ({ dxn }) {
+    const { json } = yield* CommandConfig;
+    const client = yield* ClientService;
+    const parts = dxn.asQueueDXN();
+    if (!parts) {
+      yield* Console.error(`Not a queue DXN: ${dxn.toString()}`);
+      return;
+    }
+    const space = client.spaces.get(parts.spaceId as SpaceId);
+    if (!space) {
+      yield* Console.error(`Space not found: ${parts.spaceId}`);
+      return;
+    }
+    // CLI works at the raw queue layer to inspect any queue by DXN.
+    const objects = (yield* Effect.promise(() => space.queues.get(dxn).queryObjects())) ?? [];
+
+    if (json) {
+      yield* Console.log(JSON.stringify(objects, null, 2));
+    } else {
+      // TODO(wittjosiah): Interactive table of results.
+      const formatted = objects.map((obj) => printQueueObject(obj as any));
+      yield* Console.log(printList(formatted));
+    }
+  }),
+).pipe(Command.withDescription('Query objects in a queue.'));

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/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/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

@@ -7,14 +7,14 @@ 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 { Filter, Obj } from '@dxos/echo';
 import { useClient } from '@dxos/react-client';
-import { Filter, useQuery } from '@dxos/react-client/echo';
+import { 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 '../../types';
+import { meta } from '#meta';
+import { SpaceOperation } from '#operations';
 
 const WAIT_FOR_OBJECT_TIMEOUT = 3 * 60 * 1_000;
 const TOAST_TIMEOUT = 4 * 60 * 1_000;
@@ -64,47 +64,47 @@ export const AwaitingObject = ({ id }: { id: string }) => {
         <Toast.Title classNames='flex items-center gap-2'>
           {found ? (
             <>
-              <Icon icon='ph--check-circle--regular' size={5} />
-              <span>{t('found object label')}</span>
+              <Icon icon='ph--check-circle--regular' />
+              <span>{t('found-object.label')}</span>
             </>
           ) : waiting ? (
             <>
-              <Icon icon='ph--circle-notch--regular' size={5} classNames='animate-spin' />
-              <span>{t('waiting for object label')}</span>
+              <Icon icon='ph--circle-notch--regular' classNames='animate-spin' />
+              <span>{t('waiting-for-object.label')}</span>
             </>
           ) : (
             <>
-              <Icon icon='ph--circle-dashed--regular' size={5} />
-              <span>{t('object not found label')}</span>
+              <Icon icon='ph--circle-dashed--regular' />
+              <span>{t('object-not-found.label')}</span>
             </>
           )}
         </Toast.Title>
         <Toast.Description>
           {t(
             found
-              ? 'found object description'
+              ? 'found-object.description'
               : waiting
-                ? 'waiting for object description'
-                : 'object not found description',
+                ? 'waiting-for-object.description'
+                : 'object-not-found.description',
           )}
         </Toast.Description>
       </Toast.Body>
       <Toast.Actions>
         {found ? (
           <>
-            <Toast.Action altText={t('go to object alt')} asChild>
+            <Toast.Action altText={t('go-to-object.alt')} asChild>
               <Button variant='primary' onClick={handleNavigate}>
-                {t('go to object label')}
+                {t('go-to-object.label')}
               </Button>
             </Toast.Action>
             <Toast.Close asChild>
-              <Button onClick={handleClose}>{t('close label', { ns: osTranslations })}</Button>
+              <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 })}
+              {t(waiting ? 'close.label' : 'confirm.label', { ns: osTranslations })}
             </Button>
           </Toast.Close>
         )}