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

package/src/operations/definitions.ts

@@ -0,0 +1,107 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { PublicKey } from '@dxos/client';
+import { Operation } from '@dxos/operation';
+
+import { meta } from '#meta';
+
+const CLIENT_OPERATION = `${meta.id}.operation`;
+
+const IdentitySchema = Schema.Struct({
+  identityKey: Schema.instanceOf(PublicKey),
+  spaceKey: Schema.optional(Schema.instanceOf(PublicKey)),
+  profile: Schema.optional(
+    Schema.Struct({
+      displayName: Schema.optional(Schema.String),
+      avatarCid: Schema.optional(Schema.String),
+      data: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+    }),
+  ),
+});
+
+const ProfileSchema = Schema.Struct({
+  displayName: Schema.optional(Schema.String),
+  avatarCid: Schema.optional(Schema.String),
+  data: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+});
+
+export const CreateIdentity = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.create-identity`, name: 'Create Identity' },
+  services: [Capability.Service],
+  input: ProfileSchema,
+  output: IdentitySchema,
+});
+
+export const JoinIdentity = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.join-identity`, name: 'Join Identity' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    invitationCode: Schema.optional(Schema.String),
+  }),
+  output: Schema.Void,
+});
+
+export const ShareIdentity = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.share-identity`, name: 'Share Identity' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});
+
+export const RecoverIdentity = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.recover-identity`, name: 'Recover Identity' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});
+
+export const ResetStorage = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.reset-storage`, name: 'Reset Storage' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    mode: Schema.optional(Schema.String),
+  }),
+  output: Schema.Void,
+});
+
+export const CreateAgent = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.create-agent`, name: 'Create Agent' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});
+
+export const CreateRecoveryCode = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.create-recovery-code`, name: 'Create Recovery Code' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});
+
+export const CreatePasskey = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.create-passkey`, name: 'Create Passkey' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});
+
+export const RedeemPasskey = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.redeem-passkey`, name: 'Redeem Passkey' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});
+
+export const RedeemToken = Operation.make({
+  meta: { key: `${CLIENT_OPERATION}.redeem-token`, name: 'Redeem Token' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    token: Schema.String,
+  }),
+  output: Schema.Void,
+});

package/src/operations/index.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+export * as ClientOperation from './definitions';
+
+export const ClientOperationHandlerSet = OperationHandlerSet.lazy(
+  () => import('./create-agent'),
+  () => import('./create-identity'),
+  () => import('./create-passkey'),
+  () => import('./create-recovery-code'),
+  () => import('./join-identity'),
+  () => import('./recover-identity'),
+  () => import('./redeem-passkey'),
+  () => import('./redeem-token'),
+  () => import('./reset-storage'),
+  () => import('./share-identity'),
+);

package/src/operations/join-identity.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/operation';
+
+import { JOIN_DIALOG } from '../constants';
+import { JoinIdentity } from './definitions';
+
+const handler: Operation.WithHandler<typeof JoinIdentity> = JoinIdentity.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (data) {
+      yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+        subject: JOIN_DIALOG,
+        blockAlign: 'start',
+        props: {
+          initialInvitationCode: data.invitationCode,
+          initialDisposition: 'accept-halo-invitation',
+        },
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/recover-identity.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/operation';
+import { type JoinPanelProps } from '@dxos/shell/react';
+
+import { JOIN_DIALOG } from '../constants';
+import { RecoverIdentity } from './definitions';
+
+const handler: Operation.WithHandler<typeof RecoverIdentity> = RecoverIdentity.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+        subject: JOIN_DIALOG,
+        blockAlign: 'start',
+        props: {
+          initialDisposition: 'recover-identity',
+        } satisfies Partial<JoinPanelProps>,
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/redeem-passkey.ts

@@ -0,0 +1,85 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Match from 'effect/Match';
+
+import { Capability } from '@dxos/app-framework';
+import { decodeUrlSafeBase64, supportsNativePasskeys, loginNativePasskey } from '@dxos/app-toolkit';
+import { PublicKey } from '@dxos/client';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+
+import { ClientCapabilities } from '../types';
+import { RedeemPasskey } from './definitions';
+
+const handler: Operation.WithHandler<typeof RedeemPasskey> = RedeemPasskey.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      const client = yield* Capability.get(ClientCapabilities.Client);
+      invariant(client.services.services.IdentityService, 'IdentityService not available');
+      const { deviceKey, controlFeedKey, challenge } = yield* Effect.promise(() =>
+        client.services.services.IdentityService!.requestRecoveryChallenge(),
+      );
+
+      const { lookupKey, signature, clientDataJson, authenticatorData } = yield* Match.value(
+        supportsNativePasskeys(),
+      ).pipe(
+        Match.when(true, () =>
+          Effect.gen(function* () {
+            const result = yield* Effect.promise(() =>
+              loginNativePasskey({ challenge: Uint8Array.from(Buffer.from(challenge, 'base64')) }),
+            );
+            invariant(result, 'Native passkey login returned no result');
+            return {
+              lookupKey: PublicKey.from(decodeUrlSafeBase64(result.user_handle)),
+              signature: Buffer.from(decodeUrlSafeBase64(result.signature)),
+              clientDataJson: Buffer.from(decodeUrlSafeBase64(result.client_data_json)),
+              authenticatorData: Buffer.from(decodeUrlSafeBase64(result.authenticator_data)),
+            };
+          }),
+        ),
+        Match.orElse(() =>
+          Effect.gen(function* () {
+            const credential = yield* Effect.promise(() =>
+              navigator.credentials.get({
+                publicKey: {
+                  challenge: Buffer.from(challenge, 'base64'),
+                  rpId: location.hostname,
+                  userVerification: 'required',
+                },
+              }),
+            );
+            return {
+              lookupKey: PublicKey.from(new Uint8Array((credential as any).response.userHandle)),
+              signature: Buffer.from((credential as any).response.signature),
+              clientDataJson: Buffer.from((credential as any).response.clientDataJSON),
+              authenticatorData: Buffer.from((credential as any).response.authenticatorData),
+            };
+          }),
+        ),
+      );
+
+      yield* Effect.promise(() =>
+        client.services.services.IdentityService!.recoverIdentity(
+          {
+            external: {
+              lookupKey,
+              deviceKey,
+              controlFeedKey,
+              signature,
+              clientDataJson,
+              authenticatorData,
+            },
+          },
+          { timeout: RECOVER_IDENTITY_RPC_TIMEOUT },
+        ),
+      );
+    }),
+  ),
+);
+
+export default handler;
+
+const RECOVER_IDENTITY_RPC_TIMEOUT = 20_000;

package/src/operations/redeem-token.ts

@@ -0,0 +1,31 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+
+import { ClientCapabilities } from '../types';
+import { RedeemToken } from './definitions';
+
+const handler: Operation.WithHandler<typeof RedeemToken> = RedeemToken.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (data) {
+      const client = yield* Capability.get(ClientCapabilities.Client);
+      invariant(client.services.services.IdentityService, 'IdentityService not available');
+      yield* Effect.promise(() =>
+        client.services.services.IdentityService!.recoverIdentity(
+          { token: data.token },
+          { timeout: RECOVER_IDENTITY_RPC_TIMEOUT },
+        ),
+      );
+    }),
+  ),
+);
+
+export default handler;
+
+const RECOVER_IDENTITY_RPC_TIMEOUT = 20_000;

package/src/operations/reset-storage.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/operation';
+
+import { RESET_DIALOG } from '../constants';
+import { ResetStorage } from './definitions';
+
+const handler: Operation.WithHandler<typeof ResetStorage> = ResetStorage.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (data) {
+      yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+        subject: RESET_DIALOG,
+        blockAlign: 'start',
+        props: {
+          mode: data.mode ?? 'reset storage',
+        },
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/share-identity.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { LayoutOperation, getSpacePath } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/operation';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+
+import { Account } from '../types';
+import { ShareIdentity } from './definitions';
+
+const handler: Operation.WithHandler<typeof ShareIdentity> = ShareIdentity.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      yield* Operation.invoke(LayoutOperation.SwitchWorkspace, { subject: getSpacePath(Account.id) });
+      yield* Operation.invoke(LayoutOperation.Open, {
+        subject: [`${getSpacePath(Account.id)}/${Account.Profile}`],
+      });
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, { name: 'identity.share' });
+    }),
+  ),
+);
+
+export default handler;

package/src/testing/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { initializeIdentity } from './initializeIdentity';

package/src/testing/initializeIdentity.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { PERSONAL_SPACE_TAG } from '@dxos/app-toolkit';
+import { type Client } from '@dxos/client';
+import { type Space } from '@dxos/client-protocol';
+import { type Identity } from '@dxos/protocols/proto/dxos/client/services';
+
+/**
+ * Create an identity and a personal space.
+ * Returns the identity and space for further setup.
+ */
+export const initializeIdentity = (
+  client: Client,
+): Effect.Effect<{ identity: Identity; personalSpace: Space }, never, never> =>
+  Effect.gen(function* () {
+    const identity = yield* Effect.promise(() => client.halo.createIdentity());
+    const personalSpace = yield* Effect.promise(() => client.spaces.create({}, { tags: [PERSONAL_SPACE_TAG] }));
+    yield* Effect.promise(() => personalSpace.waitUntilReady());
+    return { identity, personalSpace };
+  });

package/src/translations.ts

@@ -3,68 +3,82 @@
 //
 
 import { type Resource } from '@dxos/react-ui';
+import { translations as shellTranslations } from '@dxos/shell/react';
 
-import { meta } from './meta';
+import { meta } from '#meta';
 
-export const translations = [
+// TODO(burdon): Disambiguate with sdk/shell
+const pluginTranslations = [
   {
     'en-US': {
       [meta.id]: {
-        'account label': 'User Account',
-        'profile label': 'Profile',
-        'profile description': 'You can adjust how your user settings here.',
-        'devices label': 'Devices',
-        'devices verbose label': 'Manage devices',
-        'add device description':
+        'account.label': 'User profile',
+        'profile.label': 'Profile',
+        'profile.description': 'You can adjust how your user settings here.',
+        'devices.label': 'Devices',
+        'add-device.label': 'Add device',
+        'devices-verbose.label': 'Manage devices',
+        'add-device.description':
           'Authenticating another device is a two-step process. To get started, create a code using the button below.',
-        'devices description':
+        'devices.description':
           'You can add and remove devices, configure your agent in the cloud, reset this device, or log in as a different identity here.',
-        'create device invitation label': 'Create code',
-        'qr code description':
+        'create-device-invitation.label': 'Create code',
+        'qr-code.description':
           'Scan this QR code using the device you want to log in to, or copy the URL and share it with the new device.',
-        'security label': 'Security',
-        'reset device description': 'Log out from this device, erasing all the data on this device.',
-        'join new identity description':
+        'security.label': 'Security',
+        'reset-device.description': 'Log out from this device, erasing all the data on this device.',
+        'join-new-identity.description':
           'Log out from this device, erasing all the data currently on this device, and use a QR code or URL to log in.',
-        'recover identity description':
+        'recover-identity.description':
           'Log out from this device, erasing all the data currently on this device, and use a passkey or recovery code to log in.',
-        'danger zone title': 'Log out',
-        'danger zone description':
+        'danger-zone.title': 'Log out',
+        'danger-zone.description':
           'Because Composer is decentralized, logging out entails erasing all the data on this device. If you have any data on this device that you’d like to keep, you can log in on a separate device using a passkey or complete a peer-to-peer device invitation above.',
-        'display name label': 'Display name',
-        'display name description': 'Your name as it appears in the app.',
-        'display name input placeholder': 'Enter a name',
-        'icon label': 'Avatar',
-        'icon description': 'The emoji used to represent you in the app.',
-        'hue label': 'Color',
-        'hue description':
+        'display-name.label': 'Display name',
+        'display-name.description': 'Your name as it appears in the app.',
+        'display-name-input.placeholder': 'Enter a name',
+        'icon.label': 'Avatar',
+        'icon.description': 'The emoji used to represent the user.',
+        'hue.label': 'Color',
+        'hue.description':
           'The color used to represent you in the app, including as your avatar’s background, your cursor as it appears to others, and the messages you send in group threads.',
-        'did label': 'DID',
-        'did description': 'Your unique ID.',
-        'open user account label': 'Open user account',
-        'manage credentials dialog title': 'Manage Account Recovery',
-        'credentials list label': 'Recovery credentials',
-        'no credentials title': 'WARNING: There is currently no way to recover your account.',
-        'no credentials message': 'Create a recovery credential above to secure your account.',
-        'recovery setup dialog title': 'Account Security',
-        'recovery setup dialog description':
+        'did.label': 'DID',
+        'did.description': 'Your unique ID.',
+        'open-user-account.label': 'Open user account',
+        'manage-credentials-dialog.title': 'Manage Account Recovery',
+        'credentials-list.label': 'Recovery credentials',
+        'no-credentials.title': 'WARNING: There is currently no way to recover your account.',
+        'no-credentials.message': 'Create a recovery credential above to secure your account.',
+        'recovery-setup-dialog.title': 'Account Security',
+        'recovery-setup-dialog.description':
           'In order to maintain access to your account you need to register a recovery credential. Passkeys are the recommended way to do this, they can be stored in your browser or in a password manager.',
-        'create passkey label': 'Create Passkey',
+        'create-passkey.label': 'Create Passkey',
         // TODO(wittjosiah): At link to user-focused passkey information.
         //   Something like https://www.tomsguide.com/news/what-are-passkeys.
-        'create passkey description':
+        'create-passkey.description':
           'A passkey is a secure and easy to use credential that can be used to recover your account.',
-        'create recovery code label': 'Create Recovery Code',
-        'create recovery code description': 'A recovery code is 12 word phrase representing a private key.',
-        'recovery code dialog title': 'Recovery Code',
-        'recovery code dialog description':
+        'create-recovery-code.label': 'Create Recovery Code',
+        'create-recovery-code.description': 'A recovery code is 12 word phrase representing a private key.',
+        'recovery-code-dialog.title': 'Recovery Code',
+        'recovery-code-dialog.description':
           'This is your identity recovery code, store it in a safe place. You can use it to recover your identity if you ever lose access to your devices.',
-        'recovery code dialog warning 1': 'NOTE: This code will not be displayed again.',
-        'recovery code dialog warning 2':
+        'recovery-code-dialog-warning-1.message': 'NOTE: This code will not be displayed again.',
+        'recovery-code-dialog-warning-2.message':
           'It is your private key for recovering DXOS data. Anyone with this key will be able to gain access to your account.',
-        'recovery code confirmation label': 'Please confirm you have saved the code.',
-        'continue label': 'Continue',
+        'recovery-code-confirmation.label': 'Please confirm you have saved the code.',
+        'continue.label': 'Continue',
+        'auth-code.message': 'Authorization code',
+        'auth-other-device-emoji.message': 'Authorization icon',
+        'cancel.label': 'Cancel',
+        'join-new-identity.label': 'Join an existing identity',
+        'qr.label': 'QR Code',
+        'recover-identity.label': 'Use a recovery code',
+        'reset-device.label': 'Reset storage',
+        'reset-dialog.description': 'Reset storage',
+        'reset-dialog.title': 'Reset storage',
       },
     },
   },
 ] as const satisfies Resource[];
+
+export const translations: Resource[] = [...pluginTranslations, ...shellTranslations];

package/src/types/capabilities.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+import { type Client } from '@dxos/client';
+import { type ObjectMigration } from '@dxos/client/echo';
+import { type Type } from '@dxos/echo';
+
+import { meta } from '#meta';
+
+export namespace ClientCapabilities {
+  export const Client = Capability.make<Client>(`${meta.id}.capability.client`);
+  export const Schema = Capability.make<Type.AnyEntity[]>(`${meta.id}.capability.schema`);
+  export const Migration = Capability.make<ObjectMigration[]>(`${meta.id}.capability.migration`);
+}

package/src/types/events.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvent } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+export namespace ClientEvents {
+  export const ClientReady = ActivationEvent.make(`${meta.id}.event.client-ready`);
+  export const SetupSchema = ActivationEvent.make(`${meta.id}.event.setup-schema`);
+  export const SetupMigration = ActivationEvent.make(`${meta.id}.event.setup-migration`);
+  export const IdentityCreated = ActivationEvent.make(`${meta.id}.event.identity-created`);
+  export const SpacesReady = ActivationEvent.make(`${meta.id}.event.spaces-ready`);
+}

package/src/types/index.ts

@@ -2,4 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
+export * from './capabilities';
+export * from './events';
 export * from './schema';