@dxos/plugin-client 0.8.4-main.f5c0578 → 0.8.4-main.fcfe5033a5

package/src/{components → containers/RecoveryCodeDialog}/RecoveryCodeDialog.stories.tsx

@@ -2,19 +2,16 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
 import { useClient } from '@dxos/react-client';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { AlertDialog, useAsyncEffect } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-import { translations } from '../translations';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
-import { RecoveryCodeDialog, type RecoveryCodeDialogProps } from './RecoveryCodeDialog';
+import { translations } from '../../translations';
+import { RecoveryCodeDialog } from './RecoveryCodeDialog';
 
 const DefaultStory = () => {
   const client = useClient();
@@ -33,19 +30,19 @@ const DefaultStory = () => {
   );
 };
 
-const meta: Meta<RecoveryCodeDialogProps> = {
-  title: 'plugins/plugin-client/RecoveryCodeDialog',
-  component: RecoveryCodeDialog,
+const meta = {
+  title: 'plugins/plugin-client/containers/RecoveryCodeDialog',
+  component: RecoveryCodeDialog as any,
   render: DefaultStory,
-  decorators: [withClientProvider({ createIdentity: true }), withTheme, withLayout()],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' }), withClientProvider({ createIdentity: true })],
   parameters: {
     layout: 'fullscreen',
     translations,
   },
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-type Story = StoryObj<RecoveryCodeDialogProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {};

package/src/{components → containers/RecoveryCodeDialog}/RecoveryCodeDialog.tsx

@@ -6,48 +6,49 @@ import React, { useCallback, useState } from 'react';
 
 import { AlertDialog, Button, Clipboard, Input, useTranslation } from '@dxos/react-ui';
 
-import { CLIENT_PLUGIN } from '../meta';
-
-export const RECOVERY_CODE_DIALOG = `${CLIENT_PLUGIN}/RecoveryCodeDialog`;
+import { meta } from '#meta';
 
 export type RecoveryCodeDialogProps = {
   code: string;
 };
 
+// TODO(burdon): Should have cancel button.
 export const RecoveryCodeDialog = ({ code }: RecoveryCodeDialogProps) => {
-  const { t } = useTranslation(CLIENT_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const [confirmation, setConfirmation] = useState(false);
 
   const handleConfirmation = useCallback((checked: boolean) => setConfirmation(checked), []);
 
   return (
-    <AlertDialog.Content classNames='bs-content min-bs-[15rem] max-bs-full md:max-is-[40rem] overflow-hidden'>
-      <AlertDialog.Title>{t('recovery code dialog title')}</AlertDialog.Title>
-      <p className='py-4'>{t('recovery code dialog description')}</p>
-      <Clipboard.Provider>
-        <Code code={code} />
-      </Clipboard.Provider>
-      <div className='flex flex-col py-4 gap-2'>
-        <p>{t('recovery code dialog warning 1')}</p>
-        <p>{t('recovery code dialog warning 2')}</p>
-      </div>
-      <div className='flex items-center gap-2 pbe-4'>
-        <Input.Root>
-          <Input.Checkbox
-            data-testid='recoveryCode.confirm'
-            checked={confirmation}
-            onCheckedChange={handleConfirmation}
-          />
-          <Input.Label>{t('recovery code confirmation label')}</Input.Label>
-        </Input.Root>
-      </div>
-      <div className='flex justify-end'>
+    <AlertDialog.Content size='md' classNames='min-h-[15rem]'>
+      <AlertDialog.Body>
+        <AlertDialog.Title>{t('recovery-code-dialog.title')}</AlertDialog.Title>
+        <p className='py-4'>{t('recovery-code-dialog.description')}</p>
+        <Clipboard.Provider>
+          <Code code={code} />
+        </Clipboard.Provider>
+        <div className='flex flex-col py-4 gap-2'>
+          <p>{t('recovery-code-dialog-warning-1.message')}</p>
+          <p>{t('recovery-code-dialog-warning-2.message')}</p>
+        </div>
+        <div className='flex items-center gap-2 pb-4'>
+          <Input.Root>
+            <Input.Checkbox
+              data-testid='recoveryCode.confirm'
+              checked={confirmation}
+              onCheckedChange={handleConfirmation}
+            />
+            <Input.Label>{t('recovery-code-confirmation.label')}</Input.Label>
+          </Input.Root>
+        </div>
+      </AlertDialog.Body>
+      <AlertDialog.ActionBar>
         <AlertDialog.Action asChild>
           <Button data-testid='recoveryCode.continue' variant='primary' disabled={!confirmation}>
-            {t('continue label')}
+            {t('continue.label')}
           </Button>
         </AlertDialog.Action>
-      </div>
+      </AlertDialog.ActionBar>
     </AlertDialog.Content>
   );
 };
@@ -55,7 +56,7 @@ export const RecoveryCodeDialog = ({ code }: RecoveryCodeDialogProps) => {
 const Code = ({ code }: { code: string }) => {
   const words = code.split(' ');
   return (
-    <div className='relative p-2 border border-separator rounded group'>
+    <div className='relative p-2 border border-separator rounded-sm group'>
       <Clipboard.IconButton value={code} classNames='absolute top-2 right-2 invisible group-hover:visible' />
       <div className='grid grid-cols-4'>
         {words.map((word, i) => (

package/src/containers/RecoveryCodeDialog/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RecoveryCodeDialog } from './RecoveryCodeDialog';
+
+export * from './RecoveryCodeDialog';
+export default RecoveryCodeDialog;

package/src/containers/RecoveryCredentialsContainer/RecoveryCredentialsContainer.stories.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { initializeIdentity } from '#testing';
+
+import { ClientPlugin } from '../../ClientPlugin';
+import { translations } from '../../translations';
+import { RecoveryCredentialsContainer } from './RecoveryCredentialsContainer';
+
+const meta = {
+  title: 'plugins/plugin-client/containers/RecoveryCredentialsContainer',
+  component: RecoveryCredentialsContainer,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'fullscreen' }),
+    withPluginManager({
+      plugins: [
+        ClientPlugin({
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+            }),
+        }),
+        OperationPlugin(),
+        RuntimePlugin(),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof RecoveryCredentialsContainer>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/RecoveryCredentialsContainer/RecoveryCredentialsContainer.tsx

@@ -0,0 +1,66 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { useCredentials } from '@dxos/react-client/halo';
+import { Icon, IconButton, List, ListItem, Message, useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+
+import { meta } from '#meta';
+import { ClientOperation } from '#operations';
+
+export const MANAGE_CREDENTIALS_DIALOG = `${meta.id}.ManageCredentialsDialog`;
+
+export const RecoveryCredentialsContainer = () => {
+  const { t } = useTranslation(meta.id);
+  const { invokePromise } = useOperationInvoker();
+  const credentials = useCredentials();
+  const recoveryCredentials = credentials.filter(
+    (credential) => credential.subject.assertion['@type'] === 'dxos.halo.credentials.IdentityRecovery',
+  );
+
+  return (
+    <Settings.Viewport>
+      <Settings.Section title={t('recovery-setup-dialog.title')} description={t('recovery-setup-dialog.description')}>
+        <Settings.Item title={t('create-passkey.label')} description={t('create-passkey.description')}>
+          <IconButton
+            label={t('create-passkey.label')}
+            icon='ph--key--duotone'
+            variant='primary'
+            onClick={() => invokePromise(ClientOperation.CreatePasskey)}
+          />
+        </Settings.Item>
+        <Settings.Item title={t('create-recovery-code.label')} description={t('create-recovery-code.description')}>
+          <IconButton
+            label={t('create-recovery-code.label')}
+            icon='ph--receipt--duotone'
+            variant='default'
+            onClick={() => invokePromise(ClientOperation.CreateRecoveryCode)}
+          />
+        </Settings.Item>
+      </Settings.Section>
+      <Settings.Section title={t('credentials-list.label')}>
+        {recoveryCredentials.length < 1 ? (
+          <Message.Root valence='error'>
+            <Message.Title icon='ph--shield-warning--duotone'>{t('no-credentials.title')}</Message.Title>
+            <Message.Content>{t('no-credentials.message')}</Message.Content>
+          </Message.Root>
+        ) : (
+          <List>
+            {recoveryCredentials.map((credential) => (
+              <ListItem.Root key={credential.id?.toHex()}>
+                <ListItem.Endcap>
+                  <Icon icon='ph--key--regular' />
+                </ListItem.Endcap>
+                <ListItem.Heading>{credential.issuanceDate.toLocaleString()}</ListItem.Heading>
+              </ListItem.Root>
+            ))}
+          </List>
+        )}
+      </Settings.Section>
+    </Settings.Viewport>
+  );
+};

package/src/containers/RecoveryCredentialsContainer/index.ts

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

package/src/containers/ResetDialog/ResetDialog.stories.tsx

@@ -0,0 +1,72 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { usePluginManager } from '@dxos/app-framework/ui';
+import { Dialog } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { ClientPlugin } from '../../ClientPlugin';
+import { translations } from '../../translations';
+import { ResetDialog, type ResetDialogProps } from './ResetDialog';
+
+const DefaultStory = (props: Omit<ResetDialogProps, 'capabilityManager'>) => {
+  const manager = usePluginManager();
+
+  return (
+    <Dialog.Root open>
+      <Dialog.Overlay>
+        <ResetDialog
+          capabilityManager={manager.capabilities}
+          onReset={() => Effect.sync(() => console.log('reset'))}
+          {...props}
+        />
+      </Dialog.Overlay>
+    </Dialog.Root>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-client/containers/ResetDialog',
+  component: ResetDialog,
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'fullscreen' }),
+    withPluginManager({
+      plugins: [RuntimePlugin(), OperationPlugin(), ClientPlugin({})],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof ResetDialog>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    mode: 'reset-storage' as const,
+  } as any,
+};
+
+export const JoinNewIdentity: Story = {
+  args: {
+    mode: 'join-new-identity' as const,
+  } as any,
+};
+
+export const Recover: Story = {
+  args: {
+    mode: 'recover' as const,
+  } as any,
+};

package/src/containers/ResetDialog/ResetDialog.tsx

@@ -0,0 +1,52 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React, { useCallback } from 'react';
+
+import { Capability, type CapabilityManager } from '@dxos/app-framework';
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { runAndForwardErrors } from '@dxos/effect';
+import { useClient } from '@dxos/react-client';
+import { Dialog, useTranslation } from '@dxos/react-ui';
+import { ConfirmReset, type ConfirmResetProps, translationKey } from '@dxos/shell/react';
+
+import { type ClientPluginOptions } from '#types';
+
+export type ResetDialogProps = Pick<ConfirmResetProps, 'mode'> &
+  Pick<ClientPluginOptions, 'onReset'> & {
+    capabilityManager: CapabilityManager.CapabilityManager;
+  };
+
+export const ResetDialog = ({ mode, onReset, capabilityManager }: ResetDialogProps) => {
+  const { t } = useTranslation(translationKey);
+  const { invokePromise } = useOperationInvoker();
+  const client = useClient();
+
+  const handleReset = useCallback(async () => {
+    await client.reset();
+    const target =
+      mode === 'join-new-identity' ? 'deviceInvitation' : mode === 'recover' ? 'recoverIdentity' : undefined;
+    if (onReset) {
+      await runAndForwardErrors(onReset({ target }).pipe(Effect.provideService(Capability.Service, capabilityManager)));
+    }
+  }, [client, mode, onReset, capabilityManager]);
+
+  const handleCancel = useCallback(() => {
+    void invokePromise(LayoutOperation.UpdateDialog, { state: false });
+  }, [invokePromise]);
+
+  return (
+    <Dialog.Content>
+      <Dialog.Header>
+        <Dialog.Title>{t('reset-dialog.title')}</Dialog.Title>
+      </Dialog.Header>
+      <Dialog.Body>
+        <Dialog.Description classNames='sr-only'>{t('reset-dialog.description')}</Dialog.Description>
+        <ConfirmReset active mode={mode} onConfirm={handleReset} onCancel={handleCancel} />
+      </Dialog.Body>
+    </Dialog.Content>
+  );
+};

package/src/containers/ResetDialog/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ResetDialog } from './ResetDialog';
+
+export * from './ResetDialog';
+export default ResetDialog;

package/src/containers/index.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export { type RecoveryCodeDialogProps } from './RecoveryCodeDialog';
+export { type ResetDialogProps } from './ResetDialog';
+
+export const DevicesContainer: ComponentType<any> = lazy(() => import('./DevicesContainer'));
+export const JoinDialog: ComponentType<any> = lazy(() => import('./JoinDialog'));
+export const ProfileContainer: ComponentType<any> = lazy(() => import('./ProfileContainer'));
+export const RecoveryCodeDialog: ComponentType<any> = lazy(() => import('./RecoveryCodeDialog'));
+export const RecoveryCredentialsContainer: ComponentType<any> = lazy(() => import('./RecoveryCredentialsContainer'));
+export const ResetDialog: ComponentType<any> = lazy(() => import('./ResetDialog'));

package/src/index.ts

@@ -2,8 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './ClientPlugin';
-export * from './meta';
-
-export { ClientCapabilities } from './capabilities';
-export { ClientEvents } from './events';
+export { ClientPlugin } from './ClientPlugin';
+export { meta } from './meta';

package/src/meta.ts

@@ -2,11 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-export const CLIENT_PLUGIN = 'dxos.org/plugin/client';
-
-export const meta: PluginMeta = {
-  id: CLIENT_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.client',
   name: 'Client',
+  description: trim`
+    Core client connectivity and peer-to-peer networking infrastructure.
+    Manages identity, authentication, and real-time synchronization across devices.
+  `,
 };

package/src/operations/create-agent.ts

@@ -0,0 +1,26 @@
+//
+// 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 { CreateAgent } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreateAgent> = CreateAgent.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      const client = yield* Capability.get(ClientCapabilities.Client);
+      invariant(client.services.services.EdgeAgentService, 'Missing EdgeAgentService');
+      yield* Effect.promise(() =>
+        client.services.services.EdgeAgentService!.createAgent(undefined, { timeout: 10_000 }),
+      );
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/create-identity.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { runAndForwardErrors } from '@dxos/effect';
+import { Operation } from '@dxos/operation';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+
+import { ClientEvents } from '../types';
+import { ClientCapabilities } from '../types';
+import { CreateIdentity } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreateIdentity> = CreateIdentity.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (profile) {
+      const manager = yield* Capability.get(Capabilities.PluginManager);
+      const client = yield* Capability.get(ClientCapabilities.Client);
+      const data = yield* Effect.promise(() => client.halo.createIdentity(profile));
+      yield* Effect.promise(() => runAndForwardErrors(manager.activate(ClientEvents.IdentityCreated)));
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, { name: 'identity.create' });
+      return data;
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/create-passkey.ts

@@ -0,0 +1,88 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Match from 'effect/Match';
+
+import { Capability } from '@dxos/app-framework';
+import { supportsNativePasskeys, createNativePasskey, extractPublicKeyFromAttestation } from '@dxos/app-toolkit';
+import { PublicKey } from '@dxos/client';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+
+import { ClientCapabilities } from '../types';
+import { CreatePasskey } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreatePasskey> = CreatePasskey.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      const client = yield* Capability.get(ClientCapabilities.Client);
+      const identity = client.halo.identity.get();
+      invariant(identity, 'Identity not available');
+
+      const lookupKey = PublicKey.random();
+
+      const { recoveryKey, algorithm } = yield* Match.value(supportsNativePasskeys()).pipe(
+        Match.when(true, () =>
+          Effect.gen(function* () {
+            const result = yield* Effect.promise(() =>
+              createNativePasskey({
+                username: identity.did,
+                userId: lookupKey.asUint8Array(),
+              }),
+            );
+            const { publicKey, algorithm: alg } = extractPublicKeyFromAttestation(result.attestation_object);
+            return {
+              recoveryKey: PublicKey.from(publicKey),
+              algorithm: alg === -7 ? 'ES256' : 'ED25519',
+            };
+          }),
+        ),
+        Match.orElse(() =>
+          Effect.gen(function* () {
+            const credential = yield* Effect.promise(() =>
+              navigator.credentials.create({
+                publicKey: {
+                  challenge: new Uint8Array(),
+                  rp: { id: location.hostname, name: 'Composer' },
+                  user: {
+                    id: lookupKey.asUint8Array() as Uint8Array<ArrayBuffer>,
+                    name: identity.did,
+                    displayName: identity.profile?.displayName ?? '',
+                  },
+                  pubKeyCredParams: [
+                    { type: 'public-key', alg: -8 },
+                    { type: 'public-key', alg: -7 },
+                  ],
+                  authenticatorSelection: {
+                    residentKey: 'required',
+                    requireResidentKey: true,
+                  },
+                },
+              }),
+            );
+            invariant(credential, 'Credential not available');
+            return {
+              recoveryKey: PublicKey.from(new Uint8Array((credential as any).response.getPublicKey())),
+              algorithm: (credential as any).response.getPublicKeyAlgorithm() === -7 ? 'ES256' : 'ED25519',
+            };
+          }),
+        ),
+      );
+
+      invariant(client.services.services.IdentityService, 'IdentityService not available');
+      yield* Effect.promise(() =>
+        client.services.services.IdentityService!.createRecoveryCredential({
+          data: {
+            recoveryKey,
+            algorithm,
+            lookupKey,
+          },
+        }),
+      );
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/create-recovery-code.ts

@@ -0,0 +1,34 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+
+import { RECOVERY_CODE_DIALOG } from '../constants';
+import { ClientCapabilities } from '../types';
+import { CreateRecoveryCode } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreateRecoveryCode> = CreateRecoveryCode.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      const client = yield* Capability.get(ClientCapabilities.Client);
+      invariant(client.services.services.IdentityService, 'IdentityService not available');
+      const { recoveryCode } = yield* Effect.promise(() =>
+        client.services.services.IdentityService!.createRecoveryCredential({}),
+      );
+      yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+        subject: RECOVERY_CODE_DIALOG,
+        blockAlign: 'start',
+        type: 'alert',
+        props: { code: recoveryCode },
+      });
+    }),
+  ),
+);
+
+export default handler;