@dxos/plugin-client 0.8.4-main.72ec0f3 → 0.8.4-main.7996785055

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

@@ -0,0 +1,74 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/ui';
+import { type JoinPanelProps } from '@dxos/shell/react';
+
+import { JOIN_DIALOG, RECOVERY_CODE_DIALOG, RESET_DIALOG } from '../../constants';
+import {
+  DevicesContainer,
+  JoinDialog,
+  ProfileContainer,
+  RecoveryCodeDialog,
+  type RecoveryCodeDialogProps,
+  RecoveryCredentialsContainer,
+  ResetDialog,
+  type ResetDialogProps,
+} from '../../containers';
+import { Account, type ClientPluginOptions } from '../../types';
+
+type ReactSurfaceOptions = Pick<ClientPluginOptions, 'onReset'> & {
+  createInvitationUrl: (invitationCode: string) => string;
+};
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* ({ createInvitationUrl, onReset }: ReactSurfaceOptions) {
+    const capabilityManager = yield* Capability.Service;
+
+    return Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: Account.Profile,
+        role: 'article',
+        filter: (data): data is any => data.subject === Account.Profile,
+        component: () => <ProfileContainer />,
+      }),
+      Surface.create({
+        id: Account.Devices,
+        role: 'article',
+        filter: (data): data is any => data.subject === Account.Devices,
+        component: () => <DevicesContainer createInvitationUrl={createInvitationUrl} />,
+      }),
+      Surface.create({
+        id: Account.Security,
+        role: 'article',
+        filter: (data): data is any => data.subject === Account.Security,
+        component: () => <RecoveryCredentialsContainer />,
+      }),
+      Surface.create({
+        id: JOIN_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { props: JoinPanelProps } => data.component === JOIN_DIALOG,
+        component: ({ data }: { data: any }) => <JoinDialog {...data.props} />,
+      }),
+      Surface.create({
+        id: RECOVERY_CODE_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { props: RecoveryCodeDialogProps } => data.component === RECOVERY_CODE_DIALOG,
+        component: ({ data }: { data: any }) => <RecoveryCodeDialog {...data.props} />,
+      }),
+      Surface.create({
+        id: RESET_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { props: ResetDialogProps } => data.component === RESET_DIALOG,
+        component: ({ data }: { data: any }) => (
+          <ResetDialog {...data.props} onReset={onReset} capabilityManager={capabilityManager} />
+        ),
+      }),
+    ]);
+  }),
+);

package/src/capabilities/schema-defs/index.ts

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

package/src/capabilities/schema-defs/schema-defs.ts

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { type Type } from '@dxos/echo';
+
+import { ClientCapabilities } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const registry = yield* Capability.get(Capabilities.AtomRegistry);
+    const client = yield* Capability.get(ClientCapabilities.Client);
+    const schemasAtom = yield* Capability.atom(AppCapabilities.Schema);
+
+    // TODO(wittjosiah): Unregister schemas when they are disabled.
+    let previous: Type.AnyEntity[] = [];
+    const cancel = registry.subscribe(
+      schemasAtom,
+      async (_schemas: any[]) => {
+        // TODO(wittjosiah): This doesn't seem to de-dupe schemas as expected.
+        const schemas = Array.from(new Set(_schemas.flat())) as Type.AnyEntity[];
+        // TODO(wittjosiah): Filter out schemas which the client has already registered.
+        const newSchemas = schemas.filter((schema) => !previous.includes(schema));
+        previous = schemas;
+        await client.addTypes(newSchemas);
+      },
+      { immediate: true },
+    );
+
+    return Capability.contributes(Capabilities.Null, null, () => Effect.sync(() => cancel()));
+  }),
+);

package/src/cli/commands/config/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+
+import { view } from './view';
+
+export const config = Command.make('config').pipe(
+  Command.withDescription('Config commands.'),
+  Command.withSubcommands([view]),
+);

package/src/cli/commands/config/view.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Yaml from 'yaml';
+
+import { CommandConfig } from '@dxos/cli-util';
+import { ConfigService } from '@dxos/client';
+import { DX_CONFIG, getProfileConfigPath } from '@dxos/client-protocol';
+
+export const view = Command.make(
+  'view',
+  {},
+  Effect.fnUntraced(function* () {
+    const config = yield* ConfigService;
+    const { json, profile } = yield* CommandConfig;
+    const configPath = getProfileConfigPath(DX_CONFIG, profile);
+
+    if (json) {
+      yield* Console.log(JSON.stringify(config.values, null, 2));
+    } else {
+      yield* Console.log(`Path: ${configPath}`);
+      yield* Console.log(Yaml.stringify(config.values));
+    }
+  }),
+);

package/src/cli/commands/device/index.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+
+import { info } from './info';
+import { list } from './list';
+import { update } from './update';
+
+export const device = Command.make('device').pipe(
+  Command.withDescription('Manage HALO devices.'),
+  Command.withSubcommands([info, list, update]),
+);

package/src/cli/commands/device/info/index.ts

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

package/src/cli/commands/device/info/info.test.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+
+import { handler } from './info';
+
+describe('device info', () => {
+  it('should show device info', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      yield* handler();
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsed = TestConsole.parseJson<{ deviceKey: string; profile: unknown }>(logs[0]);
+      expect(parsed).toHaveProperty('deviceKey');
+      expect(parsed).toHaveProperty('profile');
+      expect(parsed.deviceKey).toBe(client.halo.device?.deviceKey.toHex());
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+});

package/src/cli/commands/device/info/info.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+
+import { CommandConfig } from '@dxos/cli-util';
+import { print } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { DeviceType } from '@dxos/protocols/proto/dxos/halo/credentials';
+
+import { printDevice } from '../util';
+
+export const handler = Effect.fn(function* () {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  const device = client.halo.device;
+  if (!device) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'No device found' }, null, 2));
+    } else {
+      yield* Console.log('No device found.');
+    }
+    return;
+  }
+
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          deviceKey: device.deviceKey.toHex(),
+          profile: {
+            ...device.profile,
+            type: device.profile?.type ? DeviceType[device.profile?.type] : 'UNKNOWN',
+          },
+        },
+        null,
+        2,
+      ),
+    );
+  } else {
+    yield* Console.log(print(printDevice(device)));
+  }
+});
+
+export const info = Command.make('info', {}, handler).pipe(Command.withDescription('Show device info.'));

package/src/cli/commands/device/list/index.ts

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

package/src/cli/commands/device/list/list.test.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+
+import { handler } from './list';
+
+describe('device list', () => {
+  it('should list devices', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      yield* handler();
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsed = TestConsole.parseJson<Array<{ key: string; type: string; kind: string }>>(logs[0]);
+      expect(Array.isArray(parsed)).toBe(true);
+      expect(parsed.length).toBeGreaterThan(0);
+      expect(parsed[0]).toHaveProperty('key');
+      expect(parsed[0]).toHaveProperty('type');
+      expect(parsed[0]).toHaveProperty('kind');
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, runAndForwardErrors));
+});

package/src/cli/commands/device/list/list.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+
+import { CommandConfig } from '@dxos/cli-util';
+import { printList } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+
+import { mapDevices, printDevices } from '../util';
+
+export const handler = Effect.fn(function* () {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  const devices = client.halo.devices.get();
+
+  if (json) {
+    yield* Console.log(JSON.stringify(mapDevices(devices), null, 2));
+  } else {
+    const formatted = printDevices(devices);
+    yield* Console.log(printList(formatted));
+  }
+});
+
+export const list = Command.make('list', {}, handler).pipe(Command.withDescription('List devices.'));

package/src/cli/commands/device/update/index.ts

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

package/src/cli/commands/device/update/update.ts

@@ -0,0 +1,68 @@
+//
+// 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 } from '@dxos/cli-util';
+import { print } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+
+import { printDevice } from '../util';
+
+export const handler = Effect.fn(function* ({ label }: { label: string }) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  const device = client.halo.device;
+  if (!device) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'No device found' }, null, 2));
+    } else {
+      yield* Console.log('No device found.');
+    }
+    return;
+  }
+
+  const updatedProfile = {
+    ...device.profile,
+    label,
+  };
+
+  const devicesService = client.services.services.DevicesService;
+  if (!devicesService) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'DevicesService not found' }, null, 2));
+    } else {
+      yield* Console.log('DevicesService not found.');
+    }
+    return;
+  }
+
+  const updatedDevice = yield* Effect.tryPromise(() => devicesService.updateDevice(updatedProfile));
+
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          deviceKey: updatedDevice.deviceKey.toHex(),
+          profile: updatedDevice.profile,
+        },
+        null,
+        2,
+      ),
+    );
+  } else {
+    yield* Console.log(print(printDevice(updatedDevice)));
+  }
+});
+
+export const update = Command.make(
+  'update',
+  {
+    label: Options.text('label').pipe(Options.withDescription('The device label.')),
+  },
+  handler,
+).pipe(Command.withDescription('Update device label.'));

package/src/cli/commands/device/util.ts

@@ -0,0 +1,55 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { FormBuilder } from '@dxos/cli-util';
+import { Device, DeviceKind, DeviceType } from '@dxos/client/halo';
+
+const maybeTruncateKey = (key: { toHex(): string; truncate(): string }, truncate = false) =>
+  truncate ? key.truncate() : key.toHex();
+
+const getDeviceTitle = (device: Device): string => {
+  if (device.profile?.label) {
+    return device.profile.label;
+  }
+  const platform = device.profile?.platform ?? 'Unknown';
+  const os = device.profile?.os ?? 'Unknown';
+  return `${platform} on ${os}`;
+};
+
+export const mapDevices = (devices: Device[], truncateKeys = false) => {
+  return devices.map((device) => ({
+    label: device.profile?.label,
+    type: device.profile?.type ? DeviceType[device.profile?.type] : 'UNKNOWN',
+    key: maybeTruncateKey(device.deviceKey, truncateKeys),
+    kind: DeviceKind[device.kind],
+    platform: device.profile?.platform,
+    platformVersion: device.profile?.platformVersion,
+    architecture: device.profile?.architecture,
+    os: device.profile?.os,
+    osVersion: device.profile?.osVersion,
+    presence: device?.kind === DeviceKind.CURRENT ? 'THIS DEVICE' : Device.PresenceState[device.presence],
+  }));
+};
+
+export const printDevice = (device: Device) =>
+  FormBuilder.make({ title: getDeviceTitle(device) }).pipe(
+    FormBuilder.set('deviceKey', device.deviceKey.truncate()),
+    FormBuilder.set('label', device.profile?.label ?? '<none>'),
+    FormBuilder.set('type', device.profile?.type ? DeviceType[device.profile?.type] : 'UNKNOWN'),
+    FormBuilder.set('kind', DeviceKind[device.kind]),
+    FormBuilder.set(
+      'presence',
+      device?.kind === DeviceKind.CURRENT ? 'THIS DEVICE' : Device.PresenceState[device.presence],
+    ),
+    FormBuilder.set('platform', device.profile?.platform ?? '<none>'),
+    FormBuilder.set('platformVersion', device.profile?.platformVersion ?? '<none>'),
+    FormBuilder.set('architecture', device.profile?.architecture ?? '<none>'),
+    FormBuilder.set('os', device.profile?.os ?? '<none>'),
+    FormBuilder.set('osVersion', device.profile?.osVersion ?? '<none>'),
+    FormBuilder.build,
+  );
+
+export const printDevices = (devices: Device[]) => {
+  return devices.map(printDevice);
+};

package/src/cli/commands/edge/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+
+import { status } from './status';
+
+export const edge = Command.make('edge').pipe(
+  Command.withDescription('EDGE commands.'),
+  Command.withSubcommands([status]),
+);

package/src/cli/commands/edge/status.ts

@@ -0,0 +1,46 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+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 { ClientService } from '@dxos/client';
+import { createEdgeIdentity } from '@dxos/client/edge';
+import { Context } from '@dxos/context';
+
+export const getStatus = () =>
+  Effect.gen(function* () {
+    const client = yield* ClientService;
+    const identity = createEdgeIdentity(client);
+    client.edge.http.setIdentity(identity);
+    const status = yield* Effect.tryPromise(() => client.edge.http.getStatus(Context.default()));
+
+    if (yield* CommandConfig.isJson) {
+      yield* Console.log(JSON.stringify(status, null, 2));
+    } else if (status.problems.length > 0) {
+      for (const problem of status.problems) {
+        yield* Console.error(problem);
+      }
+    } else {
+      yield* Console.log('No problems found.');
+    }
+  }).pipe(
+    // TODO(wittjosiah): Tagged error.
+    Effect.catchSome((error) => {
+      if (error instanceof Error && error.message === 'Identity not available') {
+        // TODO(wittjosiah): Error coloring for logs.
+        return Option.some(Console.error(error.message));
+      } else {
+        return Option.none();
+      }
+    }),
+  );
+
+// TODO(wittjosiah): Admin functionality to provide to specify an identity.
+export const status = Command.make('status', {}, getStatus).pipe(
+  Command.withDescription('Get the EDGE status for the current identity.'),
+);

package/src/cli/commands/halo/create/create.test.ts

@@ -0,0 +1,52 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as Option from 'effect/Option';
+
+import { OperationPlugin } from '@dxos/app-framework';
+import { fromPlugins } from '@dxos/app-framework/testing';
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+import { ObservabilityPlugin } from '@dxos/plugin-observability/cli';
+
+import { ClientPlugin } from '../../../plugin';
+
+import { handler } from './create';
+
+const layer = Layer.merge(TestLayer, fromPlugins([ClientPlugin({}), OperationPlugin(), ObservabilityPlugin()]));
+
+// TODO(wittjosiah): Fix these tests.
+describe.skip('halo create', () => {
+  it('should create an identity without a display name', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* handler({ agent: false, displayName: Option.none() });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsedIdentity = TestConsole.parseJson(logs[0]);
+      expect(parsedIdentity).toEqual({
+        identityKey: client.halo.identity.get()?.identityKey.toHex(),
+        displayName: client.halo.identity.get()?.profile?.displayName,
+      });
+    }).pipe(Effect.provide(layer), Effect.scoped, runAndForwardErrors));
+
+  it('should create an identity with a display name', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* handler({ agent: false, displayName: Option.some('Example') });
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsedIdentity = TestConsole.parseJson(logs[0]);
+      expect(parsedIdentity).toEqual({
+        identityKey: client.halo.identity.get()?.identityKey.toHex(),
+        displayName: client.halo.identity.get()?.profile?.displayName,
+      });
+    }).pipe(Effect.provide(layer), Effect.scoped, runAndForwardErrors));
+});

package/src/cli/commands/halo/create/create.ts

@@ -0,0 +1,82 @@
+//
+// 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 { Capabilities, Plugin } from '@dxos/app-framework';
+import { CommandConfig, flushAndSync, spaceLayer } from '@dxos/cli-util';
+import { print } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import { invariant } from '@dxos/invariant';
+import { EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
+import { MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
+
+import { ClientOperation } from '../../../../operations';
+import { printIdentity } from '../util';
+
+export const handler = Effect.fn(function* ({
+  agent,
+  displayName,
+}: {
+  agent: boolean;
+  displayName: Option.Option<string>;
+}) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  // TODO(wittjosiah): How to surface this error to the user cleanly?
+  invariant(!client.halo.identity.get(), 'Identity already exists');
+
+  const manager = yield* Plugin.Service;
+  const { invoke } = manager.capabilities.get(Capabilities.OperationInvoker);
+  const identity = yield* invoke(ClientOperation.CreateIdentity, {
+    displayName: Option.getOrUndefined(displayName),
+  });
+
+  if (agent) {
+    yield* invoke(ClientOperation.CreateAgent);
+  }
+
+  // Create personal space for the CLI identity.
+  const { PERSONAL_SPACE_TAG, setPersonalSpace } = yield* Effect.tryPromise(() => import('@dxos/app-toolkit'));
+  const space = yield* Effect.promise(() =>
+    client.spaces.create({}, { tags: [PERSONAL_SPACE_TAG], membershipPolicy: MembershipPolicy.LOCKED }),
+  );
+  yield* Effect.promise(() => space.waitUntilReady());
+  yield* Effect.promise(() => space.internal.setEdgeReplicationPreference(EdgeReplicationSetting.ENABLED));
+  setPersonalSpace(space);
+  yield* flushAndSync({ indexes: true }).pipe(Effect.provide(spaceLayer(Option.some(space.id))));
+
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          identityKey: identity.identityKey.toHex(),
+          displayName: identity.profile?.displayName,
+        },
+        null,
+        2,
+      ),
+    );
+  } else {
+    yield* Console.log(print(printIdentity(identity)));
+  }
+});
+
+export const create = Command.make(
+  'create',
+  {
+    agent: Options.boolean('noAgent', { ifPresent: false }).pipe(
+      Options.withDescription('Do not create an EDGE agent for the identity.'),
+    ),
+    displayName: Options.text('displayName').pipe(
+      Options.withDescription('The display name of the identity.'),
+      Options.optional,
+    ),
+  },
+  handler,
+).pipe(Command.withDescription('Create a new identity.'));

package/src/cli/commands/halo/create/index.ts

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