@dxos/plugin-client 0.8.4-main.406dc2a → 0.8.4-main.4a85c3132b

package/src/capabilities/app-graph-builder.ts

@@ -1,115 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Rx } from '@effect-rx/rx-react';
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
-
-import { createIntent } from '@dxos/app-framework';
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
-import { ROOT_ID, createExtension, rxFromObservable } from '@dxos/plugin-graph';
-import { ConnectionState } from '@dxos/react-client/mesh';
-
-import { meta } from '../meta';
-import { Account, ClientAction } from '../types';
-
-import { ClientCapabilities } from './capabilities';
-
-export default (context: PluginContext) =>
-  contributes(
-    Capabilities.AppGraphBuilder,
-    createExtension({
-      id: meta.id,
-      actions: (node) =>
-        Rx.make((get) =>
-          Function.pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => {
-              return [
-                {
-                  id: `${meta.id}/open-user-account`,
-                  data: async () => {
-                    const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                    await dispatch(createIntent(ClientAction.ShareIdentity));
-                  },
-                  properties: {
-                    label: ['open user account label', { ns: meta.id }],
-                    icon: 'ph--user--regular',
-                    disposition: 'menu',
-                    keyBinding: {
-                      macos: 'meta+shift+.',
-                      // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
-                      windows: 'alt+shift+.',
-                      linux: 'alt+shift+>',
-                    },
-                  },
-                },
-              ];
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-      connector: (node) =>
-        Rx.make((get) =>
-          Function.pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => {
-              const client = context.getCapability(ClientCapabilities.Client);
-              const identity = get(rxFromObservable(client.halo.identity));
-              const status = get(rxFromObservable(client.mesh.networkStatus));
-
-              return [
-                {
-                  id: Account.id,
-                  type: meta.id,
-                  properties: {
-                    label: ['account label', { ns: meta.id }],
-                    icon: 'ph--user--regular',
-                    disposition: 'user-account',
-                    // NOTE: This currently needs to be the identity key because the fallback is generated from hex.
-                    userId: identity?.identityKey.toHex(),
-                    hue: identity?.profile?.data?.hue,
-                    emoji: identity?.profile?.data?.emoji,
-                    status: status.swarm === ConnectionState.OFFLINE ? 'error' : 'active',
-                  },
-                  nodes: [
-                    {
-                      id: Account.Profile,
-                      data: Account.Profile,
-                      type: meta.id,
-                      properties: {
-                        label: ['profile label', { ns: meta.id }],
-                        icon: 'ph--user--regular',
-                      },
-                    },
-                    {
-                      id: Account.Devices,
-                      data: Account.Devices,
-                      type: meta.id,
-                      properties: {
-                        label: ['devices label', { ns: meta.id }],
-                        icon: 'ph--devices--regular',
-                        testId: 'clientPlugin.devices',
-                      },
-                    },
-                    {
-                      id: Account.Security,
-                      data: Account.Security,
-                      type: meta.id,
-                      properties: {
-                        label: ['security label', { ns: meta.id }],
-                        icon: 'ph--key--regular',
-                      },
-                    },
-                  ],
-                },
-              ];
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  );

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/client.ts

@@ -1,43 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type PluginContext, contributes } from '@dxos/app-framework';
-import { Client } from '@dxos/react-client';
-
-import { ClientEvents } from '../events';
-import { type ClientPluginOptions } from '../types';
-
-import { ClientCapabilities } from './capabilities';
-
-type ClientCapabilityOptions = Omit<ClientPluginOptions, 'appKey' | 'invitationUrl' | 'invitationParam' | 'onReset'> & {
-  context: PluginContext;
-};
-
-export default async ({ context, onClientInitialized, onSpacesReady, ...options }: ClientCapabilityOptions) => {
-  const client = new Client(options);
-  await client.initialize();
-  await onClientInitialized?.({ context, client });
-
-  // TODO(wittjosiah): Remove. This is a hack to get the app to boot with the new identity after a reset.
-  client.reloaded.on(() => {
-    client.halo.identity.subscribe(async (identity) => {
-      if (identity) {
-        window.location.href = window.location.origin;
-      }
-    });
-  });
-
-  // TODO(burdon): The callback isn't called?
-  const subscription = client.spaces.isReady.subscribe(async (ready) => {
-    if (ready) {
-      await context.activatePromise(ClientEvents.SpacesReady);
-      await onSpacesReady?.({ context, client });
-    }
-  });
-
-  return contributes(ClientCapabilities.Client, client, async () => {
-    subscription.unsubscribe();
-    await client.destroy();
-  });
-};

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/capabilities/migrations.ts

@@ -1,25 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
-
-import { ClientCapabilities } from './capabilities';
-
-export default (context: PluginContext) => {
-  const registry = context.getCapability(Capabilities.RxRegistry);
-  const client = context.getCapability(ClientCapabilities.Client);
-
-  // NOTE: Migrations are currently unidirectional and idempotent.
-  const cancel = registry.subscribe(
-    context.capabilities(ClientCapabilities.Migration),
-    (_migrations) => {
-      const migrations = Array.from(new Set(_migrations.flat()));
-      const spaces = client.spaces.get();
-      void Promise.all(spaces.map((space) => space.db.runMigrations(migrations)));
-    },
-    { immediate: true },
-  );
-
-  return contributes(Capabilities.Null, null, () => cancel());
-};

package/src/capabilities/react-context.tsx

@@ -1,21 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, useCapability } from '@dxos/app-framework';
-import { ClientProvider } from '@dxos/react-client';
-
-import { meta } from '../meta';
-
-import { ClientCapabilities } from './capabilities';
-
-export default () =>
-  contributes(Capabilities.ReactContext, {
-    id: meta.id,
-    context: ({ children }) => {
-      const client = useCapability(ClientCapabilities.Client);
-      return <ClientProvider client={client}>{children}</ClientProvider>;
-    },
-  });

package/src/capabilities/react-surface.tsx

@@ -1,67 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { type JoinPanelProps } from '@dxos/shell/react';
-
-import {
-  DevicesContainer,
-  JOIN_DIALOG,
-  JoinDialog,
-  ProfileContainer,
-  RECOVERY_CODE_DIALOG,
-  RESET_DIALOG,
-  RecoveryCodeDialog,
-  type RecoveryCodeDialogProps,
-  RecoveryCredentialsContainer,
-  ResetDialog,
-  type ResetDialogProps,
-} from '../components';
-import { Account, type ClientPluginOptions } from '../types';
-
-type ReactSurfaceOptions = Pick<ClientPluginOptions, 'onReset'> & {
-  createInvitationUrl: (invitationCode: string) => string;
-};
-
-export default ({ createInvitationUrl, onReset }: ReactSurfaceOptions) =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: Account.Profile,
-      role: 'article',
-      filter: (data): data is any => data.subject === Account.Profile,
-      component: () => <ProfileContainer />,
-    }),
-    createSurface({
-      id: Account.Devices,
-      role: 'article',
-      filter: (data): data is any => data.subject === Account.Devices,
-      component: ({ data }) => <DevicesContainer createInvitationUrl={createInvitationUrl} />,
-    }),
-    createSurface({
-      id: Account.Security,
-      role: 'article',
-      filter: (data): data is any => data.subject === Account.Security,
-      component: () => <RecoveryCredentialsContainer />,
-    }),
-    createSurface({
-      id: JOIN_DIALOG,
-      role: 'dialog',
-      filter: (data): data is { props: JoinPanelProps } => data.component === JOIN_DIALOG,
-      component: ({ data }) => <JoinDialog {...data.props} />,
-    }),
-    createSurface({
-      id: RECOVERY_CODE_DIALOG,
-      role: 'dialog',
-      filter: (data): data is { props: RecoveryCodeDialogProps } => data.component === RECOVERY_CODE_DIALOG,
-      component: ({ data }) => <RecoveryCodeDialog {...data.props} />,
-    }),
-    createSurface({
-      id: RESET_DIALOG,
-      role: 'dialog',
-      filter: (data): data is { props: ResetDialogProps } => data.component === RESET_DIALOG,
-      component: ({ data }) => <ResetDialog {...data.props} onReset={onReset} />,
-    }),
-  ]);

package/src/capabilities/schema-defs.ts

@@ -1,29 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
-import { type Type } from '@dxos/echo';
-
-import { ClientCapabilities } from './capabilities';
-
-export default (context: PluginContext) => {
-  const registry = context.getCapability(Capabilities.RxRegistry);
-  const client = context.getCapability(ClientCapabilities.Client);
-
-  // TODO(wittjosiah): Unregister schemas when they are disabled.
-  let previous: Type.Obj.Any[] = [];
-  const cancel = registry.subscribe(
-    context.capabilities(ClientCapabilities.Schema),
-    (_schemas) => {
-      const schemas = Array.from(new Set(_schemas.flat()));
-      // TODO(wittjosiah): Filter out schemas which the client has already registered.
-      const newSchemas = schemas.filter((schema) => !previous.includes(schema));
-      previous = schemas;
-      client.addTypes(newSchemas);
-    },
-    { immediate: true },
-  );
-
-  return contributes(Capabilities.Null, null, () => cancel());
-};

package/src/components/JoinDialog.tsx

@@ -1,53 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { LayoutAction, createIntent, useIntentDispatcher } from '@dxos/app-framework';
-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 = {};