@dxos/plugin-client 0.8.4-main.fffef41 → 0.9.0

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

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, test } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as Option from 'effect/Option';
+
+import {} 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 { EffectEx } from '@dxos/effect';
+import { ObservabilityPlugin } from '@dxos/plugin-observability/plugin';
+
+import { ClientPlugin } from '#plugin';
+
+import { handler } from './create';
+
+// TODO(wittjosiah): Align browser and node variant option types for ObservabilityPlugin.
+const layer = Layer.merge(TestLayer, fromPlugins([ClientPlugin({}), ObservabilityPlugin({} as any)]));
+
+// TODO(wittjosiah): Fix these tests.
+describe.skip('halo create', () => {
+  test('should create an identity without a display name', ({ expect }) =>
+    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({
+        identityDid: client.halo.identity.get()?.did,
+        displayName: client.halo.identity.get()?.profile?.displayName,
+      });
+    }).pipe(Effect.provide(layer), Effect.scoped, EffectEx.runAndForwardErrors));
+
+  test('should create an identity with a display name', ({ expect }) =>
+    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({
+        identityDid: client.halo.identity.get()?.did,
+        displayName: client.halo.identity.get()?.profile?.displayName,
+      });
+    }).pipe(Effect.provide(layer), Effect.scoped, EffectEx.runAndForwardErrors));
+});

package/src/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 { PERSONAL_SPACE_TAG } from '@dxos/app-toolkit';
+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 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));
+  yield* flushAndSync({ indexes: true }).pipe(Effect.provide(spaceLayer(Option.some(space.id))));
+
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          identityDid: identity.identityDid,
+          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/commands/halo/create/index.ts

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

package/src/commands/halo/credential/add/add.ts

@@ -0,0 +1,97 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Args from '@effect/cli/Args';
+import * as Command from '@effect/cli/Command';
+import * as Prompt from '@effect/cli/Prompt';
+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 { invariant } from '@dxos/invariant';
+import { schema } from '@dxos/protocols/proto';
+
+export const handler = Effect.fn(function* ({ credential }: { credential: Option.Option<string> }) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+
+  let credentialHex = Option.getOrUndefined(credential);
+  if (!credentialHex) {
+    credentialHex = yield* Prompt.text({ message: 'Enter credential (hex string)' }).pipe(Prompt.run);
+  }
+
+  invariant(credentialHex, 'Invalid credential.');
+
+  const identity = client.halo.identity;
+  if (!identity) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'Profile not initialized' }, null, 2));
+    } else {
+      yield* Console.log('Profile not initialized.');
+    }
+    return;
+  }
+
+  yield* Effect.gen(function* () {
+    const codec = schema.getCodecForType('dxos.halo.credentials.Credential');
+    const credentialBytes = yield* Effect.try({
+      try: () => Buffer.from(credentialHex, 'hex'),
+      catch: (error) => new Error(`Failed to parse hex string: ${error}`),
+    });
+
+    const verifyError = codec.protoType.verify(credentialBytes);
+    if (verifyError) {
+      yield* Effect.fail(new Error(verifyError));
+    }
+
+    const credentialObj = yield* Effect.try({
+      try: () => codec.decode(credentialBytes),
+      catch: (error) => new Error(`Failed to decode credential: ${error}`),
+    });
+
+    yield* Effect.tryPromise({
+      try: () => client.halo.writeCredentials([credentialObj]),
+      catch: (error) => new Error(`Failed to write credential: ${error}`),
+    });
+
+    if (json) {
+      yield* Console.log(JSON.stringify({ success: true }, null, 2));
+    } else {
+      yield* Console.log('Credential added successfully.');
+    }
+  }).pipe(
+    Effect.catchAll((error) =>
+      Effect.gen(function* () {
+        if (json) {
+          yield* Console.log(
+            JSON.stringify(
+              {
+                error: 'Invalid credential',
+                message: error instanceof Error ? error.message : String(error),
+              },
+              null,
+              2,
+            ),
+          );
+        } else {
+          yield* Console.log('Invalid credential.');
+        }
+        yield* Effect.fail(error);
+      }),
+    ),
+  );
+});
+
+export const add = Command.make(
+  'add',
+  {
+    credential: Args.text({ name: 'credential' }).pipe(
+      Args.withDescription('Credential as hex string.'),
+      Args.optional,
+    ),
+  },
+  handler,
+).pipe(Command.withDescription('Import credential into HALO.'));

package/src/commands/halo/credential/add/index.ts

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

package/src/commands/halo/credential/index.ts

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

package/src/commands/halo/credential/list/index.ts

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

package/src/commands/halo/credential/list/list.test.ts

@@ -0,0 +1,27 @@
+//
+// 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 { EffectEx } from '@dxos/effect';
+
+import { handler } from './list';
+
+describe('halo credential list', () => {
+  it('should list HALO credentials', () =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity());
+      yield* handler({ type: Option.none(), spaceId: Option.none(), timeout: 500, delay: 250 });
+      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, EffectEx.runAndForwardErrors));
+});

package/src/commands/halo/credential/list/list.ts

@@ -0,0 +1,115 @@
+//
+// 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 Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig, Common, FormBuilder, getSpace, printList } from '@dxos/cli-util';
+import { ClientService } from '@dxos/client';
+import type { Credential } from '@dxos/client/halo';
+import { type Key } from '@dxos/echo';
+
+const mapCredentials = (credentials: Credential[]) => {
+  return credentials.map((credential) => ({
+    id: credential.id?.toHex() ?? '<unknown>',
+    issuer: credential.issuer?.toHex() ?? '<unknown>',
+    subject: credential.subject?.id?.toHex() ?? '<unknown>',
+    type: credential.subject.assertion['@type'],
+    assertion: credential.subject.assertion,
+  }));
+};
+
+const printCredential = (credential: Credential) => {
+  const type = credential.subject.assertion['@type'] ?? '<unknown>';
+  return FormBuilder.make({ title: type }).pipe(
+    FormBuilder.option('id', Option.fromNullable(credential.id?.truncate())),
+    FormBuilder.option('issuer', Option.fromNullable(credential.issuer?.truncate())),
+    FormBuilder.option('subject', Option.fromNullable(credential.subject?.id?.truncate())),
+    FormBuilder.build,
+  );
+};
+
+export const handler = Effect.fn(function* ({
+  type,
+  spaceId,
+  timeout,
+  delay,
+}: {
+  type: Option.Option<string>;
+  spaceId: Option.Option<Key.SpaceId>;
+  timeout: number;
+  delay: number;
+}) {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  let credentials: Credential[];
+
+  if (Option.isSome(spaceId)) {
+    // If space ID was provided, get credentials from that space.
+    const space = yield* getSpace(spaceId.value);
+    credentials = yield* Effect.tryPromise(() => space.internal.getCredentials());
+  } else {
+    // Get credentials from HALO
+    const identity = client.halo.identity;
+    if (!identity) {
+      if (json) {
+        yield* Console.log(JSON.stringify({ error: 'Profile not initialized' }, null, 2));
+      } else {
+        yield* Console.log('Profile not initialized.');
+      }
+      return;
+    }
+
+    // Wait for at least one credential
+    const latch = yield* Effect.makeLatch();
+    const subscription = client.halo.credentials.subscribe((creds) => {
+      if (creds.length > 0) {
+        Effect.runSync(latch.open);
+      }
+    });
+
+    yield* latch.await.pipe(
+      Effect.timeout(Duration.millis(timeout)),
+      Effect.catchAll(() => Effect.void),
+      Effect.ensuring(
+        Effect.sync(() => {
+          subscription.unsubscribe();
+        }),
+      ),
+    );
+
+    // Wait a bit more to ensure all credentials are loaded
+    yield* Effect.sleep(Duration.millis(delay));
+
+    credentials = client.halo.queryCredentials({ type: Option.getOrUndefined(type) });
+  }
+
+  if (json) {
+    yield* Console.log(JSON.stringify(mapCredentials(credentials), null, 2));
+  } else {
+    const formatted = credentials.map(printCredential);
+    yield* Console.log(printList(formatted));
+  }
+});
+
+export const list = Command.make(
+  'list',
+  {
+    type: Options.text('type').pipe(Options.withDescription('Filter by credential type.'), Options.optional),
+    spaceId: Common.spaceId.pipe(Options.withDescription('Space ID to show credentials from.'), Options.optional),
+    timeout: Options.integer('timeout').pipe(
+      Options.withDescription('Time in milliseconds to wait for at least one credential before listing.'),
+      Options.withDefault(500),
+    ),
+    delay: Options.integer('delay').pipe(
+      Options.withDescription('Delay in milliseconds before listing.'),
+      Options.withDefault(250),
+    ),
+  },
+  handler,
+).pipe(Command.withDescription('List HALO credentials.'));

package/src/commands/halo/identity/identity.test.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, test } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { TestConsole, TestLayer } from '@dxos/cli-util/testing';
+import { ClientService } from '@dxos/client';
+import { EffectEx } from '@dxos/effect';
+
+import { handler } from './identity';
+
+describe('halo identity', () => {
+  test('should log if identity is not initialized', ({ expect }) =>
+    Effect.gen(function* () {
+      yield* handler();
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      expect(TestConsole.extractJsonString(logs[0])).toEqual(
+        JSON.stringify({ error: 'Identity not initialized' }, null, 2),
+      );
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, EffectEx.runAndForwardErrors));
+
+  test('should print identity if initialized', ({ expect }) =>
+    Effect.gen(function* () {
+      const client = yield* ClientService;
+      yield* Effect.tryPromise(() => client.halo.createIdentity({ displayName: 'Test' }));
+      yield* handler();
+      const logger = yield* TestConsole.TestConsole;
+      const logs = logger.logs;
+      expect(logs).toHaveLength(1);
+      const parsedIdentity = TestConsole.parseJson(logs[0]);
+      expect(parsedIdentity).toEqual({
+        identityDid: client.halo.identity.get()?.did,
+        displayName: client.halo.identity.get()?.profile?.displayName,
+      });
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, EffectEx.runAndForwardErrors));
+});

package/src/commands/halo/identity/identity.ts

@@ -0,0 +1,45 @@
+//
+// 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 { printIdentity } from '../util';
+
+export const handler = Effect.fn(function* () {
+  const { json } = yield* CommandConfig;
+  const client = yield* ClientService;
+  const identity = client.halo.identity.get();
+  if (!identity) {
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'Identity not initialized' }, null, 2));
+    } else {
+      yield* Console.log('Identity not initialized.');
+    }
+  } else {
+    if (json) {
+      yield* Console.log(
+        JSON.stringify(
+          {
+            identityDid: identity.did,
+            displayName: identity.profile?.displayName,
+          },
+          null,
+          2,
+        ),
+      );
+    } else {
+      yield* Console.log(print(printIdentity({ identityDid: identity.did, profile: identity.profile })));
+    }
+  }
+});
+
+export const identity = Command.make('identity', {}, handler).pipe(
+  Command.withDescription('Get the current identity.'),
+);

package/src/commands/halo/identity/index.ts

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

package/src/commands/halo/index.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+
+import { create } from './create';
+import { credential } from './credential';
+import { identity } from './identity';
+// TODO(wittjosiah): Omitted currently due to p2p networking not working in bun.
+// import { join } from './join';
+import { keys } from './keys';
+import { recover } from './recover';
+import { seed } from './seed';
+// import { share } from './share';
+import { update } from './update';
+
+export const halo: Command.Command<any, any, any, any> = Command.make('halo').pipe(
+  Command.withDescription('Manage HALO identity.'),
+  Command.withSubcommands([create, credential, identity, keys, recover, seed, update]),
+);

package/src/commands/halo/join/index.ts

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

package/src/commands/halo/join/join.test.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, it } from '@effect/vitest';
+
+describe('halo join', () => {
+  // TODO(wittjosiah): Need to be able to test prompts.
+  it.todo('should accept an invitation code');
+});

package/src/commands/halo/join/join.ts

@@ -0,0 +1,87 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Args from '@effect/cli/Args';
+import * as Command from '@effect/cli/Command';
+import * as Prompt from '@effect/cli/Prompt';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Match from 'effect/Match';
+
+import { CommandConfig, print } from '@dxos/cli-util';
+import { type Client, ClientService } from '@dxos/client';
+import { type AuthenticatingInvitationObservable, Invitation, InvitationEncoder } from '@dxos/client/invitations';
+import { invariant } from '@dxos/invariant';
+
+import { printIdentity } from '../util';
+
+export const join = Command.make(
+  'join',
+  {
+    invitationCode: Args.text({ name: 'invitationCode' }).pipe(Args.withDescription('The invitation code.')),
+  },
+  Effect.fn(function* ({ invitationCode }) {
+    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 identity = yield* sendInvitation({ client, invitationCode });
+    if (!identity) {
+      if (json) {
+        yield* Console.log(JSON.stringify({ error: 'Failed to join identity' }, null, 2));
+      } else {
+        yield* Console.log('Failed to join identity');
+      }
+      return;
+    }
+
+    if (json) {
+      yield* Console.log(
+        JSON.stringify(
+          {
+            identityDid: identity.did,
+            displayName: identity.profile?.displayName,
+          },
+          null,
+          2,
+        ),
+      );
+    } else {
+      yield* Console.log(print(printIdentity({ identityDid: identity.did, profile: identity.profile })));
+    }
+  }),
+).pipe(Command.withDescription('Join an existing identity using an invitation code.'));
+
+const sendInvitation = Effect.fn(function* ({
+  client,
+  invitationCode: encoded,
+}: {
+  client: Client;
+  invitationCode: string;
+}) {
+  if (encoded.startsWith('http') || encoded.startsWith('socket')) {
+    const searchProps = new URL(encoded).searchParams;
+    encoded = searchProps.get('deviceInvitationCode') ?? encoded;
+  }
+
+  const invitationCode = InvitationEncoder.decode(encoded);
+  const invitation = client.halo.join(invitationCode);
+  yield* waitForState(invitation, Invitation.State.READY_FOR_AUTHENTICATION);
+
+  const authCode = yield* Prompt.text({ message: 'Enter the authentication code' }).pipe(Prompt.run);
+  yield* Effect.tryPromise(() => invitation.authenticate(authCode));
+  yield* waitForState(invitation, Invitation.State.SUCCESS);
+  return client.halo.identity.get();
+});
+
+const waitForState = (invitation: AuthenticatingInvitationObservable, state: Invitation.State) =>
+  Effect.gen(function* () {
+    const latch = yield* Effect.makeLatch();
+    const subscription = invitation.subscribe((invitation) => {
+      Match.value(invitation.state).pipe(Match.when(state, () => Effect.runSync(latch.open)));
+    });
+    yield* latch.await;
+    subscription.unsubscribe();
+  });

package/src/commands/halo/keys/index.ts

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

package/src/commands/halo/keys/keys.test.ts

@@ -0,0 +1,29 @@
+//
+// 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 { EffectEx } from '@dxos/effect';
+
+import { handler } from './keys';
+
+describe('halo keys', () => {
+  it('should show HALO keys', () =>
+    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<{ identityKey?: string; deviceKey?: string }>(logs[0]);
+      expect(parsed).toHaveProperty('identityKey');
+      expect(parsed).toHaveProperty('deviceKey');
+      expect(parsed.identityKey).toBe(client.halo.identity.get()?.identityKey.toHex());
+      expect(parsed.deviceKey).toBe(client.halo.device?.deviceKey.toHex());
+    }).pipe(Effect.provide(TestLayer), Effect.scoped, EffectEx.runAndForwardErrors));
+});