@dxos/plugin-client 0.8.4-main.84f28bd → 0.8.4-main.937b3ca

package/package.json

@@ -1,30 +1,41 @@
 {
   "name": "@dxos/plugin-client",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.937b3ca",
   "description": "DXOS Surface plugin for DXOS Client",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
     },
+    "./cli": {
+      "source": "./src/cli/index.ts",
+      "types": "./dist/types/src/cli/index.d.ts",
+      "node": "./dist/lib/node-esm/cli/index.mjs"
+    },
     "./types": {
-      "types": "./dist/types/src/types.d.ts",
-      "browser": "./dist/lib/browser/types.mjs",
-      "node": "./dist/lib/node-esm/types.mjs"
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "browser": "./dist/lib/browser/types/index.mjs",
+      "node": "./dist/lib/node-esm/types/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
     "*": {
       "types": [
-        "dist/types/src/types.d.ts"
+        "dist/types/src/types/index.d.ts"
       ]
     }
   },
@@ -33,51 +44,54 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
+    "@effect/cli": "0.72.1",
+    "@effect/platform": "0.93.6",
+    "effect": "3.19.11",
     "react-qr-rounded": "^1.0.0",
-    "@dxos/app-framework": "0.8.4-main.84f28bd",
-    "@dxos/async": "0.8.4-main.84f28bd",
-    "@dxos/config": "0.8.4-main.84f28bd",
-    "@dxos/echo-schema": "0.8.4-main.84f28bd",
-    "@dxos/echo": "0.8.4-main.84f28bd",
-    "@dxos/echo-signals": "0.8.4-main.84f28bd",
-    "@dxos/invariant": "0.8.4-main.84f28bd",
-    "@dxos/local-storage": "0.8.4-main.84f28bd",
-    "@dxos/plugin-graph": "0.8.4-main.84f28bd",
-    "@dxos/log": "0.8.4-main.84f28bd",
-    "@dxos/plugin-observability": "0.8.4-main.84f28bd",
-    "@dxos/react-client": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-form": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-pickers": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-stack": "0.8.4-main.84f28bd",
-    "@dxos/shell": "0.8.4-main.84f28bd",
-    "@dxos/util": "0.8.4-main.84f28bd"
+    "yaml": "^2.7.0",
+    "@dxos/app-framework": "0.8.4-main.937b3ca",
+    "@dxos/async": "0.8.4-main.937b3ca",
+    "@dxos/cli-util": "0.8.4-main.937b3ca",
+    "@dxos/client-protocol": "0.8.4-main.937b3ca",
+    "@dxos/client-services": "0.8.4-main.937b3ca",
+    "@dxos/client": "0.8.4-main.937b3ca",
+    "@dxos/config": "0.8.4-main.937b3ca",
+    "@dxos/echo": "0.8.4-main.937b3ca",
+    "@dxos/effect": "0.8.4-main.937b3ca",
+    "@dxos/invariant": "0.8.4-main.937b3ca",
+    "@dxos/log": "0.8.4-main.937b3ca",
+    "@dxos/operation": "0.8.4-main.937b3ca",
+    "@dxos/plugin-graph": "0.8.4-main.937b3ca",
+    "@dxos/protocols": "0.8.4-main.937b3ca",
+    "@dxos/plugin-observability": "0.8.4-main.937b3ca",
+    "@dxos/react-client": "0.8.4-main.937b3ca",
+    "@dxos/react-ui-form": "0.8.4-main.937b3ca",
+    "@dxos/react-ui-pickers": "0.8.4-main.937b3ca",
+    "@dxos/react-ui-stack": "0.8.4-main.937b3ca",
+    "@dxos/util": "0.8.4-main.937b3ca",
+    "@dxos/shell": "0.8.4-main.937b3ca"
   },
   "devDependencies": {
-    "@effect-rx/rx-react": "0.38.0",
-    "@effect/platform": "0.88.0",
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "effect": "3.16.13",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/live-object": "0.8.4-main.84f28bd",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd",
-    "@dxos/storybook-utils": "0.8.4-main.84f28bd"
+    "@effect-atom/atom-react": "^0.4.6",
+    "@effect/printer": "0.47.0",
+    "@effect/printer-ansi": "0.47.0",
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "7.1.9",
+    "@dxos/storybook-utils": "0.8.4-main.937b3ca",
+    "@dxos/react-ui": "0.8.4-main.937b3ca",
+    "@dxos/ui-theme": "0.8.4-main.937b3ca"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@effect/platform": "^0.80.12",
-    "@phosphor-icons/react": "^2.1.5",
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd"
+    "@effect-atom/atom-react": "^0.4.6",
+    "@effect/platform": "0.93.6",
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/ui-theme": "0.8.4-main.937b3ca",
+    "@dxos/react-ui": "0.8.4-main.937b3ca"
   },
   "publishConfig": {
     "access": "public"

package/src/ClientPlugin.ts

@@ -2,77 +2,57 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, contributes, defineModule, definePlugin, Events, oneOf } from '@dxos/app-framework';
+import { ActivationEvent, Capability, Common, Plugin } from '@dxos/app-framework';
 
 import {
-  Client,
   AppGraphBuilder,
-  IntentResolver,
+  Client,
   Migrations,
+  OperationResolver,
   ReactContext,
   ReactSurface,
   SchemaDefs,
 } from './capabilities';
-import { ClientEvents } from './events';
 import { meta } from './meta';
 import { translations } from './translations';
+import { ClientEvents } from './types';
 import { type ClientPluginOptions } from './types';
 
-export const ClientPlugin = ({
-  invitationUrl = window.location.origin,
-  invitationParam = 'deviceInvitationCode',
-  onReset,
-  ...options
-}: ClientPluginOptions) => {
-  const createInvitationUrl = (invitationCode: string) => {
-    const baseUrl = new URL(invitationUrl);
-    baseUrl.searchParams.set(invitationParam, invitationCode);
-    return baseUrl.toString();
-  };
-
-  return definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/client`,
-      activatesOn: oneOf(Events.Startup, Events.SetupAppGraph),
+export const ClientPlugin = Plugin.define<ClientPluginOptions>(meta).pipe(
+  Plugin.addModule((options) => {
+    return {
+      id: Capability.getModuleTag(Client),
+      activatesOn: ActivationEvent.oneOf(Common.ActivationEvent.Startup, Common.ActivationEvent.SetupAppGraph),
       activatesAfter: [ClientEvents.ClientReady],
-      activate: (context) => Client({ ...options, context }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/schema`,
-      activatesOn: ClientEvents.ClientReady,
-      activatesBefore: [ClientEvents.SetupSchema],
-      activate: SchemaDefs,
-    }),
-    defineModule({
-      id: `${meta.id}/module/migration`,
-      activatesOn: ClientEvents.ClientReady,
-      activatesBefore: [ClientEvents.SetupMigration],
-      activate: Migrations,
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-context`,
-      activatesOn: Events.Startup,
-      activate: ReactContext,
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
+      activate: () => Client(options),
+    };
+  }),
+  Plugin.addModule({
+    activatesOn: ClientEvents.ClientReady,
+    activatesBefore: [Common.ActivationEvent.SetupSchema],
+    activate: SchemaDefs,
+  }),
+  Plugin.addModule({
+    activatesOn: ClientEvents.ClientReady,
+    activatesBefore: [ClientEvents.SetupMigration],
+    activate: Migrations,
+  }),
+  Common.Plugin.addReactContextModule({ activate: ReactContext }),
+  Plugin.addModule(({ invitationUrl = window.location.origin, invitationProp = 'deviceInvitationCode', onReset }) => {
+    const createInvitationUrl = (invitationCode: string) => {
+      const baseUrl = new URL(invitationUrl);
+      baseUrl.searchParams.set(invitationProp, invitationCode);
+      return baseUrl.toString();
+    };
+
+    return {
+      id: Capability.getModuleTag(ReactSurface),
+      activatesOn: Common.ActivationEvent.SetupReactSurface,
       activate: () => ReactSurface({ createInvitationUrl, onReset }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/app-graph-builder`,
-      activatesOn: Events.SetupAppGraph,
-      activate: AppGraphBuilder,
-    }),
-    defineModule({
-      id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: (context) => IntentResolver({ context }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-  ]);
-};
+    };
+  }),
+  Common.Plugin.addAppGraphModule({ activate: AppGraphBuilder }),
+  Common.Plugin.addOperationResolverModule({ activate: OperationResolver }),
+  Common.Plugin.addTranslationsModule({ translations }),
+  Plugin.make,
+);

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

@@ -0,0 +1,95 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { Operation } from '@dxos/operation';
+import { CreateAtom, GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';
+import { ConnectionState } from '@dxos/react-client/mesh';
+
+import { meta } from '../../meta';
+import { Account, ClientCapabilities, ClientOperation } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* GraphBuilder.createExtension({
+      id: meta.id,
+      match: NodeMatcher.whenRoot,
+      actions: () =>
+        Effect.succeed([
+          {
+            id: `${meta.id}/open-user-account`,
+            data: () => Operation.invoke(ClientOperation.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+>',
+              },
+            },
+          },
+        ]),
+      connector: Effect.fnUntraced(function* (node, get) {
+        const client = yield* Capability.get(ClientCapabilities.Client);
+        const identity = get(CreateAtom.fromObservable(client.halo.identity));
+        const status = get(CreateAtom.fromObservable(client.mesh.networkStatus));
+
+        return [
+          {
+            id: Account.id,
+            type: meta.id,
+            properties: {
+              label: ['account label', { ns: meta.id }],
+              icon: 'ph--user--regular',
+              disposition: 'user-account',
+              testId: 'clientPlugin.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',
+                },
+              },
+            ],
+          },
+        ];
+      }),
+    });
+
+    return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);
+  }),
+);

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

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));

package/src/capabilities/client/client.ts

@@ -0,0 +1,75 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common, Plugin } from '@dxos/app-framework';
+import { Client, ClientService } from '@dxos/client';
+import { runAndForwardErrors } from '@dxos/effect';
+import { log } from '@dxos/log';
+
+import { ClientEvents } from '../../types';
+import { ClientCapabilities, type ClientPluginOptions } from '../../types';
+
+type ClientCapabilityOptions = Omit<ClientPluginOptions, 'appKey' | 'invitationUrl' | 'invitationParam' | 'onReset'>;
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* (props?: ClientCapabilityOptions) {
+    const { onClientInitialized, onSpacesReady, ...options } = props!;
+    const capabilityManager = yield* Capability.Service;
+    const pluginManager = yield* Plugin.Service;
+
+    log('creating client');
+    const client = new Client(options);
+    log('initializing client');
+    yield* Effect.tryPromise(() => client.initialize());
+    log('initialized client');
+    if (onClientInitialized) {
+      yield* onClientInitialized({ client }).pipe(
+        Effect.provideService(Capability.Service, capabilityManager),
+        Effect.provideService(Plugin.Service, pluginManager),
+      );
+    }
+    log('called client initialized callback');
+
+    // 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 Effect.gen(function* () {
+          yield* Plugin.activate(ClientEvents.SpacesReady);
+          if (onSpacesReady) {
+            yield* onSpacesReady({ client });
+          }
+        }).pipe(
+          Effect.provideService(Capability.Service, capabilityManager),
+          Effect.provideService(Plugin.Service, pluginManager),
+          runAndForwardErrors,
+        );
+      }
+    });
+
+    log('client capability ready');
+
+    return [
+      // TODO(wittjosiah): Try to remove and prefer layer?
+      //  Perhaps move to using layer has source of truth and add a getter capability for the client.
+      Capability.contributes(ClientCapabilities.Client, client, () =>
+        Effect.gen(function* () {
+          subscription.unsubscribe();
+          yield* Effect.tryPromise(() => client.destroy());
+        }),
+      ),
+      Capability.contributes(Common.Capability.Layer, ClientService.fromClient(client)),
+    ];
+  }),
+);

package/src/capabilities/client/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const Client = Capability.lazy('Client', () => import('./client'));

package/src/capabilities/index.ts

@@ -2,14 +2,10 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
-
-export const AppGraphBuilder = lazy(async () => import('./app-graph-builder'));
-export const Client = lazy(async () => import('./client'));
-export const IntentResolver = lazy(async () => import('./intent-resolver'));
-export const Migrations = lazy(async () => import('./migrations'));
-export const ReactContext = lazy(async () => import('./react-context'));
-export const ReactSurface = lazy(async () => import('./react-surface'));
-export const SchemaDefs = lazy(async () => import('./schema-defs'));
-
-export * from './capabilities';
+export * from './app-graph-builder';
+export * from './client';
+export * from './migrations';
+export * from './operation-resolver';
+export * from './react-context';
+export * from './react-surface';
+export * from './schema-defs';

package/src/capabilities/migrations/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const Migrations = Capability.lazy('Migrations', () => import('./migrations'));

package/src/capabilities/migrations/migrations.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common } from '@dxos/app-framework';
+
+import { ClientCapabilities } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const registry = yield* Capability.get(Common.Capability.AtomRegistry);
+    const client = yield* Capability.get(ClientCapabilities.Client);
+    const migrationsAtom = yield* Capability.atom(ClientCapabilities.Migration);
+
+    // NOTE: Migrations are currently unidirectional and idempotent.
+    const cancel = registry.subscribe(
+      migrationsAtom,
+      (_migrations: any[]) => {
+        const migrations = Array.from(new Set(_migrations.flat()));
+        const spaces = client.spaces.get();
+        void Promise.all(spaces.map((space: any) => space.internal.db.runMigrations(migrations)));
+      },
+      { immediate: true },
+    );
+
+    return Capability.contributes(Common.Capability.Null, null, () => Effect.sync(() => cancel()));
+  }),
+);

package/src/capabilities/operation-resolver/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const OperationResolver = Capability.lazy('OperationResolver', () => import('./operation-resolver'));