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

package/src/capabilities/capabilities.ts

@@ -1,18 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineCapability } 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 = defineCapability<Client>(`${meta.id}/capability/client`);
-  export const Schema = defineCapability<Type.Obj.Any[]>(`${meta.id}/capability/schema`);
-  // TODO(wittjosiah): More descriptive name.
-  export const SchemaWhiteList = defineCapability<Type.Obj.Any[]>(`${meta.id}/capability/schema-whitelist`);
-  export const Migration = defineCapability<ObjectMigration[]>(`${meta.id}/capability/migration`);
-}

package/src/capabilities/intent-resolver.ts

@@ -1,251 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Function from 'effect/Function';
-
-import {
-  Capabilities,
-  LayoutAction,
-  type PluginContext,
-  chain,
-  contributes,
-  createIntent,
-  createResolver,
-} from '@dxos/app-framework';
-import { invariant } from '@dxos/invariant';
-import { ObservabilityAction } from '@dxos/plugin-observability/types';
-import { PublicKey } from '@dxos/react-client';
-import { type JoinPanelProps } from '@dxos/shell/react';
-
-import { JOIN_DIALOG, RECOVERY_CODE_DIALOG, RESET_DIALOG } from '../components';
-import { ClientEvents } from '../events';
-import { Account, ClientAction } from '../types';
-
-import { ClientCapabilities } from './capabilities';
-
-type IntentResolverOptions = {
-  context: PluginContext;
-  appName?: string;
-};
-
-const RECOVER_IDENTITY_RPC_TIMEOUT = 20_000;
-
-export default ({ context, appName = 'Composer' }: IntentResolverOptions) =>
-  contributes(Capabilities.IntentResolver, [
-    createResolver({
-      intent: ClientAction.CreateIdentity,
-      resolve: async (profile) => {
-        const manager = context.getCapability(Capabilities.PluginManager);
-        const client = context.getCapability(ClientCapabilities.Client);
-        const data = await client.halo.createIdentity(profile);
-        await manager.activate(ClientEvents.IdentityCreated);
-        return {
-          data,
-          intents: [
-            createIntent(ObservabilityAction.SendEvent, {
-              name: 'identity.create',
-            }),
-          ],
-        };
-      },
-    }),
-    createResolver({
-      intent: ClientAction.JoinIdentity,
-      resolve: async (data) => {
-        return {
-          intents: [
-            createIntent(LayoutAction.UpdateDialog, {
-              part: 'dialog',
-              subject: JOIN_DIALOG,
-              options: {
-                blockAlign: 'start',
-                props: {
-                  initialInvitationCode: data.invitationCode,
-                  initialDisposition: 'accept-halo-invitation',
-                },
-              },
-            }),
-          ],
-        };
-      },
-    }),
-    createResolver({
-      intent: ClientAction.ShareIdentity,
-      resolve: async () => {
-        return {
-          intents: [
-            Function.pipe(
-              createIntent(LayoutAction.SwitchWorkspace, {
-                part: 'workspace',
-                subject: Account.id,
-              }),
-              chain(LayoutAction.Open, {
-                part: 'main',
-                subject: [Account.Profile],
-              }),
-            ),
-            createIntent(ObservabilityAction.SendEvent, {
-              name: 'identity.share',
-            }),
-          ],
-        };
-      },
-    }),
-    createResolver({
-      intent: ClientAction.RecoverIdentity,
-      resolve: async () => {
-        return {
-          intents: [
-            createIntent(LayoutAction.UpdateDialog, {
-              part: 'dialog',
-              subject: JOIN_DIALOG,
-              options: {
-                blockAlign: 'start',
-                props: {
-                  initialDisposition: 'recover-identity',
-                } satisfies Partial<JoinPanelProps>,
-              },
-            }),
-          ],
-        };
-      },
-    }),
-    createResolver({
-      intent: ClientAction.ResetStorage,
-      resolve: async (data) => {
-        return {
-          intents: [
-            createIntent(LayoutAction.UpdateDialog, {
-              part: 'dialog',
-              subject: RESET_DIALOG,
-              options: {
-                blockAlign: 'start',
-                props: {
-                  mode: data.mode ?? 'reset storage',
-                },
-              },
-            }),
-          ],
-        };
-      },
-    }),
-    createResolver({
-      intent: ClientAction.CreateAgent,
-      resolve: async () => {
-        const client = context.getCapability(ClientCapabilities.Client);
-        invariant(client.services.services.EdgeAgentService, 'Missing EdgeAgentService');
-        await client.services.services.EdgeAgentService.createAgent(null as any, { timeout: 10_000 });
-      },
-    }),
-    createResolver({
-      intent: ClientAction.CreateRecoveryCode,
-      resolve: async () => {
-        const client = context.getCapability(ClientCapabilities.Client);
-        invariant(client.services.services.IdentityService, 'IdentityService not available');
-        // TODO(wittjosiah): This needs a proper api.
-        const { recoveryCode } = await client.services.services.IdentityService.createRecoveryCredential({});
-        return {
-          intents: [
-            createIntent(LayoutAction.UpdateDialog, {
-              part: 'dialog',
-              subject: RECOVERY_CODE_DIALOG,
-              options: {
-                blockAlign: 'start',
-                type: 'alert',
-                props: { code: recoveryCode },
-              },
-            }),
-          ],
-        };
-      },
-    }),
-    createResolver({
-      intent: ClientAction.CreatePasskey,
-      resolve: async () => {
-        const client = context.getCapability(ClientCapabilities.Client);
-        const identity = client.halo.identity.get();
-        invariant(identity, 'Identity not available');
-
-        // TODO(wittjosiah): Consider factoring out passkey creation to the halo api.
-        const lookupKey = PublicKey.random();
-        const credential = await navigator.credentials.create({
-          publicKey: {
-            challenge: new Uint8Array(),
-            rp: { id: location.hostname, name: appName },
-            user: {
-              id: lookupKey.asUint8Array() as Uint8Array<ArrayBuffer>,
-              name: identity.did,
-              displayName: identity.profile?.displayName ?? '',
-            },
-            pubKeyCredParams: [
-              { type: 'public-key', alg: -8 }, // Ed25519 (not yet supported across all browsers)
-              { type: 'public-key', alg: -7 }, // ES256
-            ],
-            // https://web.dev/articles/webauthn-discoverable-credentials#resident-key
-            authenticatorSelection: {
-              residentKey: 'required',
-              requireResidentKey: true,
-            },
-          },
-        });
-
-        invariant(credential, 'Credential not available');
-        const recoveryKey = PublicKey.from(new Uint8Array((credential as any).response.getPublicKey()));
-        const algorithm = (credential as any).response.getPublicKeyAlgorithm() === -7 ? 'ES256' : 'ED25519';
-
-        // TODO(wittjosiah): This needs a proper api.
-        invariant(client.services.services.IdentityService, 'IdentityService not available');
-        await client.services.services.IdentityService.createRecoveryCredential({
-          data: {
-            recoveryKey,
-            algorithm,
-            lookupKey,
-          },
-        });
-      },
-    }),
-    createResolver({
-      intent: ClientAction.RedeemPasskey,
-      resolve: async () => {
-        const client = context.getCapability(ClientCapabilities.Client);
-        // TODO(wittjosiah): This needs a proper api.
-        invariant(client.services.services.IdentityService, 'IdentityService not available');
-        const { deviceKey, controlFeedKey, challenge } =
-          await client.services.services.IdentityService.requestRecoveryChallenge();
-        const credential = await navigator.credentials.get({
-          publicKey: {
-            challenge: Buffer.from(challenge, 'base64'),
-            rpId: location.hostname,
-            userVerification: 'required',
-          },
-        });
-        const lookupKey = PublicKey.from(new Uint8Array((credential as any).response.userHandle));
-        await client.services.services.IdentityService.recoverIdentity(
-          {
-            external: {
-              lookupKey,
-              deviceKey,
-              controlFeedKey,
-              signature: Buffer.from((credential as any).response.signature),
-              clientDataJson: Buffer.from((credential as any).response.clientDataJSON),
-              authenticatorData: Buffer.from((credential as any).response.authenticatorData),
-            },
-          },
-          { timeout: RECOVER_IDENTITY_RPC_TIMEOUT },
-        );
-      },
-    }),
-    createResolver({
-      intent: ClientAction.RedeemToken,
-      resolve: async (data) => {
-        const client = context.getCapability(ClientCapabilities.Client);
-        // TODO(wittjosiah): This needs a proper api.
-        invariant(client.services.services.IdentityService, 'IdentityService not available');
-        await client.services.services.IdentityService.recoverIdentity(
-          { token: data.token },
-          { timeout: RECOVER_IDENTITY_RPC_TIMEOUT },
-        );
-      },
-    }),
-  ]);

package/src/components/JoinDialog.tsx

@@ -1,54 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { LayoutAction, createIntent } from '@dxos/app-framework';
-import { useIntentDispatcher } from '@dxos/app-framework/react';
-import { ObservabilityAction } from '@dxos/plugin-observability/types';
-import { type InvitationResult } from '@dxos/react-client/invitations';
-import { Dialog, useTranslation } from '@dxos/react-ui';
-import { JoinPanel, type JoinPanelProps } from '@dxos/shell/react';
-
-import { meta } from '../meta';
-import { ClientAction } from '../types';
-
-export const JOIN_DIALOG = `${meta.id}/JoinDialog`;
-
-export const JoinDialog = (props: JoinPanelProps) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const { t } = useTranslation(meta.id);
-
-  const handleCancelResetStorage = useCallback(() => dispatch(createIntent(ClientAction.ShareIdentity)), [dispatch]);
-
-  const handleDone = useCallback(
-    async (result: InvitationResult | null) => {
-      if (result?.identityKey) {
-        await Promise.all([
-          dispatch(createIntent(LayoutAction.UpdateDialog, { part: 'dialog', options: { state: false } })),
-          dispatch(
-            createIntent(ObservabilityAction.SendEvent, {
-              name: props.initialDisposition === 'recover-identity' ? 'identity.recover' : 'identity.join',
-            }),
-          ),
-        ]);
-      }
-    },
-    [dispatch],
-  );
-
-  return (
-    <Dialog.Content>
-      <Dialog.Title classNames='sr-only'>{t('join space label', { ns: 'os' })}</Dialog.Title>
-      <JoinPanel
-        mode='halo-only'
-        {...props}
-        exitActionParent={<Dialog.Close asChild />}
-        doneActionParent={<Dialog.Close asChild />}
-        onCancelResetStorage={handleCancelResetStorage}
-        onDone={handleDone}
-      />
-    </Dialog.Content>
-  );
-};

package/src/components/RecoveryCredentialsContainer.stories.tsx

@@ -1,42 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-
-import { IntentPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { ClientPlugin } from '../ClientPlugin';
-import { translations } from '../translations';
-
-import { RecoveryCredentialsContainer } from './RecoveryCredentialsContainer';
-
-const meta = {
-  title: 'plugins/plugin-client/RecoveryCredentialsContainer',
-  component: RecoveryCredentialsContainer,
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [
-        ClientPlugin({
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-          },
-        }),
-        IntentPlugin(),
-      ],
-    }),
-  ],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof RecoveryCredentialsContainer>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {};

package/src/components/RecoveryCredentialsContainer.tsx

@@ -1,69 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React from 'react';
-
-import { createIntent } from '@dxos/app-framework';
-import { useIntentDispatcher } from '@dxos/app-framework/react';
-import { useCredentials } from '@dxos/react-client/halo';
-import { Icon, IconButton, List, ListItem, Message, useTranslation } from '@dxos/react-ui';
-import { ControlGroup, ControlItem, ControlPage, ControlSection } from '@dxos/react-ui-form';
-
-import { meta } from '../meta';
-import { ClientAction } from '../types';
-
-export const MANAGE_CREDENTIALS_DIALOG = `${meta.id}/ManageCredentialsDialog`;
-
-export const RecoveryCredentialsContainer = () => {
-  const { t } = useTranslation(meta.id);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const credentials = useCredentials();
-  const recoveryCredentials = credentials.filter(
-    (credential) => credential.subject.assertion['@type'] === 'dxos.halo.credentials.IdentityRecovery',
-  );
-
-  return (
-    <ControlPage>
-      <ControlSection title={t('recovery setup dialog title')} description={t('recovery setup dialog description')}>
-        <ControlGroup>
-          <ControlItem title={t('create passkey label')} description={t('create passkey description')}>
-            <IconButton
-              label={t('create passkey label')}
-              icon='ph--key--duotone'
-              variant='primary'
-              onClick={() => dispatch(createIntent(ClientAction.CreatePasskey))}
-            />
-          </ControlItem>
-          <ControlItem 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={() => dispatch(createIntent(ClientAction.CreateRecoveryCode))}
-            />
-          </ControlItem>
-        </ControlGroup>
-      </ControlSection>
-      <ControlSection title={t('credentials list label')}>
-        {recoveryCredentials.length < 1 ? (
-          <Message.Root valence='error' classNames='container-max-width'>
-            <Message.Title icon='ph--shield-warning--duotone'>{t('no credentials title')}</Message.Title>
-            <Message.Content>{t('no credentials message')}</Message.Content>
-          </Message.Root>
-        ) : (
-          <List classNames='container-max-width pli-2'>
-            {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>
-        )}
-      </ControlSection>
-    </ControlPage>
-  );
-};

package/src/components/ResetDialog.stories.tsx

@@ -1,52 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { IntentPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Dialog } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { ClientPlugin } from '../ClientPlugin';
-import { translations } from '../translations';
-
-import { ResetDialog, type ResetDialogProps } from './ResetDialog';
-
-const Render = (props: ResetDialogProps) => {
-  return (
-    <Dialog.Root open>
-      <Dialog.Overlay>
-        <ResetDialog onReset={() => console.log('reset')} {...props} />
-      </Dialog.Overlay>
-    </Dialog.Root>
-  );
-};
-
-const meta = {
-  title: 'plugins/plugin-client/ResetDialog',
-  component: ResetDialog,
-  render: Render,
-  decorators: [
-    withTheme, // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
-    withPluginManager({
-      plugins: [IntentPlugin(), 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' } };
-
-export const JoinNewIdentity: Story = { args: { mode: 'join new identity' } };
-
-export const Recover: Story = { args: { mode: 'recover' } };

package/src/components/ResetDialog.tsx

@@ -1,50 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { LayoutAction, createIntent } from '@dxos/app-framework';
-import { useIntentDispatcher } from '@dxos/app-framework/react';
-import { useClient } from '@dxos/react-client';
-import { Dialog, useTranslation } from '@dxos/react-ui';
-import { ConfirmReset, type ConfirmResetProps } from '@dxos/shell/react';
-
-import { meta } from '../meta';
-import { type ClientPluginOptions } from '../types';
-
-export const RESET_DIALOG = `${meta.id}/ResetDialog`;
-
-export type ResetDialogProps = Pick<ConfirmResetProps, 'mode'> & Pick<ClientPluginOptions, 'onReset'>;
-
-export const ResetDialog = ({ mode, onReset }: ResetDialogProps) => {
-  const { t } = useTranslation(meta.id);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const client = useClient();
-
-  const handleReset = useCallback(async () => {
-    await client.reset();
-    const target =
-      mode === 'join new identity' ? 'deviceInvitation' : mode === 'recover' ? 'recoverIdentity' : undefined;
-    await onReset?.({ target });
-  }, [dispatch, client, mode, onReset]);
-
-  const handleCancel = useCallback(() => {
-    void dispatch(
-      createIntent(LayoutAction.UpdateDialog, {
-        part: 'dialog',
-        options: { state: false },
-      }),
-    );
-  }, [dispatch]);
-
-  // TODO(wittjosiah): Add the sr-only translations.
-  // TODO(wittjosiah): Add missing descriptions to other dialogs.
-  return (
-    <Dialog.Content classNames='bs-content min-bs-[15rem] max-bs-full md:max-is-[40rem] overflow-hidden'>
-      <Dialog.Title classNames='sr-only'>{t('reset dialog title')}</Dialog.Title>
-      <Dialog.Description classNames='sr-only'>{t('reset dialog description')}</Dialog.Description>
-      <ConfirmReset active mode={mode} onConfirm={handleReset} onCancel={handleCancel} />
-    </Dialog.Content>
-  );
-};

package/src/events.ts

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