@dxos/plugin-client 0.8.4-main.3c1ae3b → 0.8.4-main.3eb6e50203

package/src/meta.ts

@@ -2,10 +2,10 @@
 // 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 meta: PluginMeta = {
+export const meta: Plugin.Meta = {
   id: 'dxos.org/plugin/client',
   name: 'Client',
   description: trim`

package/src/translations.ts

@@ -3,14 +3,15 @@
 //
 
 import { type Resource } from '@dxos/react-ui';
+import { translations as shellTranslations } from '@dxos/shell/react';
 
 import { meta } from './meta';
 
-export const translations = [
+const pluginTranslations = [
   {
     'en-US': {
       [meta.id]: {
-        'account label': 'User Account',
+        'account label': 'User profile',
         'profile label': 'Profile',
         'profile description': 'You can adjust how your user settings here.',
         'devices label': 'Devices',
@@ -35,7 +36,7 @@ export const translations = [
         '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.',
+        '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.',
@@ -68,3 +69,5 @@ export const translations = [
     },
   },
 ] 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.Entity.Any[]>(`${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';

package/src/types/schema.ts

@@ -2,11 +2,12 @@
 // Copyright 2024 DXOS.org
 //
 
+import type * as Effect from 'effect/Effect';
 import * as Schema from 'effect/Schema';
 
-import { type PluginContext } from '@dxos/app-framework';
-import { type Client, type ClientOptions, PublicKey } from '@dxos/react-client';
-import { type MaybePromise } from '@dxos/util';
+import { Capability } from '@dxos/app-framework';
+import { type Client, type ClientOptions, PublicKey } from '@dxos/client';
+import { Operation } from '@dxos/operation';
 
 import { meta } from '../meta';
 
@@ -90,6 +91,115 @@ export namespace ClientAction {
   }) {}
 }
 
+const CLIENT_OPERATION = `${meta.id}/operation`;
+
+/**
+ * Operations for the Client plugin.
+ */
+export namespace ClientOperation {
+  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],
+    schema: {
+      input: ProfileSchema,
+      output: IdentitySchema,
+    },
+  });
+
+  export const JoinIdentity = Operation.make({
+    meta: { key: `${CLIENT_OPERATION}/join-identity`, name: 'Join Identity' },
+    services: [Capability.Service],
+    schema: {
+      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],
+    schema: {
+      input: Schema.Void,
+      output: Schema.Void,
+    },
+  });
+
+  export const RecoverIdentity = Operation.make({
+    meta: { key: `${CLIENT_OPERATION}/recover-identity`, name: 'Recover Identity' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Void,
+      output: Schema.Void,
+    },
+  });
+
+  export const ResetStorage = Operation.make({
+    meta: { key: `${CLIENT_OPERATION}/reset-storage`, name: 'Reset Storage' },
+    services: [Capability.Service],
+    schema: {
+      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],
+    schema: {
+      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],
+    schema: {
+      input: Schema.Void,
+      output: Schema.Void,
+    },
+  });
+
+  export const CreatePasskey = Operation.make({
+    meta: { key: `${CLIENT_OPERATION}/create-passkey`, name: 'Create Passkey' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Void,
+      output: Schema.Void,
+    },
+  });
+
+  export const RedeemPasskey = Operation.make({
+    meta: { key: `${CLIENT_OPERATION}/redeem-passkey`, name: 'Redeem Passkey' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Void,
+      output: Schema.Void,
+    },
+  });
+
+  export const RedeemToken = Operation.make({
+    meta: { key: `${CLIENT_OPERATION}/redeem-token`, name: 'Redeem Token' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        token: Schema.String,
+      }),
+      output: Schema.Void,
+    },
+  });
+}
+
 export type ClientPluginOptions = ClientOptions & {
   /**
    * Base URL for the invitation link.
@@ -99,22 +209,25 @@ export type ClientPluginOptions = ClientOptions & {
   /**
    * Query parameter for the invitation code.
    */
-  invitationParam?: string;
+  invitationProp?: string;
 
   /**
    * Run after the client has been initialized.
+   * Plugin context is provided so capabilities are accessible.
    */
-  onClientInitialized?: (params: { context: PluginContext; client: Client }) => MaybePromise<void>;
+  onClientInitialized?: (params: { client: Client }) => Effect.Effect<void, Error | never, Capability.Service | never>;
 
   /**
    * Called when spaces are ready.
+   * Plugin context is provided so capabilities are accessible.
    */
-  onSpacesReady?: (params: { context: PluginContext; client: Client }) => MaybePromise<void>;
+  onSpacesReady?: (params: { client: Client }) => Effect.Effect<void, Error | never, Capability.Service | never>;
 
   /**
    * Called when the client is reset.
+   * Plugin context is provided so capabilities are accessible.
    */
-  onReset?: (params: { target?: string }) => MaybePromise<void>;
+  onReset?: (params: { target?: string }) => Effect.Effect<void, Error | never, Capability.Service | never>;
 };
 
 export namespace Account {

package/dist/lib/browser/app-graph-builder-7LBCMPIW.mjs

@@ -1,124 +0,0 @@
-import {
-  ClientCapabilities
-} from "./chunk-UZTC5O5A.mjs";
-import {
-  Account,
-  ClientAction
-} from "./chunk-RDIG75CA.mjs";
-import {
-  meta
-} from "./chunk-ZRVMXLDR.mjs";
-
-// src/capabilities/app-graph-builder.ts
-import { Atom } from "@effect-atom/atom-react";
-import * as Function from "effect/Function";
-import * as Option from "effect/Option";
-import { createIntent } from "@dxos/app-framework";
-import { Capabilities, contributes } from "@dxos/app-framework";
-import { ROOT_ID, atomFromObservable, createExtension } from "@dxos/plugin-graph";
-import { ConnectionState } from "@dxos/react-client/mesh";
-var app_graph_builder_default = ((context) => contributes(Capabilities.AppGraphBuilder, createExtension({
-  id: meta.id,
-  actions: (node) => Atom.make((get) => Function.pipe(get(node), Option.flatMap((node2) => node2.id === ROOT_ID ? Option.some(node2) : 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) => Atom.make((get) => Function.pipe(get(node), Option.flatMap((node2) => node2.id === ROOT_ID ? Option.some(node2) : Option.none()), Option.map(() => {
-    const client = context.getCapability(ClientCapabilities.Client);
-    const identity = get(atomFromObservable(client.halo.identity));
-    const status = get(atomFromObservable(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(() => [])))
-})));
-export {
-  app_graph_builder_default as default
-};
-//# sourceMappingURL=app-graph-builder-7LBCMPIW.mjs.map

package/dist/lib/browser/app-graph-builder-7LBCMPIW.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/app-graph-builder.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Atom } from '@effect-atom/atom-react';\nimport * as Function from 'effect/Function';\nimport * as Option from 'effect/Option';\n\nimport { createIntent } from '@dxos/app-framework';\nimport { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';\nimport { ROOT_ID, atomFromObservable, createExtension } from '@dxos/plugin-graph';\nimport { ConnectionState } from '@dxos/react-client/mesh';\n\nimport { meta } from '../meta';\nimport { Account, ClientAction } from '../types';\n\nimport { ClientCapabilities } from './capabilities';\n\nexport default (context: PluginContext) =>\n  contributes(\n    Capabilities.AppGraphBuilder,\n    createExtension({\n      id: meta.id,\n      actions: (node) =>\n        Atom.make((get) =>\n          Function.pipe(\n            get(node),\n            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n            Option.map(() => {\n              return [\n                {\n                  id: `${meta.id}/open-user-account`,\n                  data: async () => {\n                    const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n                    await dispatch(createIntent(ClientAction.ShareIdentity));\n                  },\n                  properties: {\n                    label: ['open user account label', { ns: meta.id }],\n                    icon: 'ph--user--regular',\n                    disposition: 'menu',\n                    keyBinding: {\n                      macos: 'meta+shift+.',\n                      // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n                      windows: 'alt+shift+.',\n                      linux: 'alt+shift+>',\n                    },\n                  },\n                },\n              ];\n            }),\n            Option.getOrElse(() => []),\n          ),\n        ),\n      connector: (node) =>\n        Atom.make((get) =>\n          Function.pipe(\n            get(node),\n            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n            Option.map(() => {\n              const client = context.getCapability(ClientCapabilities.Client);\n              const identity = get(atomFromObservable(client.halo.identity));\n              const status = get(atomFromObservable(client.mesh.networkStatus));\n\n              return [\n                {\n                  id: Account.id,\n                  type: meta.id,\n                  properties: {\n                    label: ['account label', { ns: meta.id }],\n                    icon: 'ph--user--regular',\n                    disposition: 'user-account',\n                    // NOTE: This currently needs to be the identity key because the fallback is generated from hex.\n                    userId: identity?.identityKey.toHex(),\n                    hue: identity?.profile?.data?.hue,\n                    emoji: identity?.profile?.data?.emoji,\n                    status: status.swarm === ConnectionState.OFFLINE ? 'error' : 'active',\n                  },\n                  nodes: [\n                    {\n                      id: Account.Profile,\n                      data: Account.Profile,\n                      type: meta.id,\n                      properties: {\n                        label: ['profile label', { ns: meta.id }],\n                        icon: 'ph--user--regular',\n                      },\n                    },\n                    {\n                      id: Account.Devices,\n                      data: Account.Devices,\n                      type: meta.id,\n                      properties: {\n                        label: ['devices label', { ns: meta.id }],\n                        icon: 'ph--devices--regular',\n                        testId: 'clientPlugin.devices',\n                      },\n                    },\n                    {\n                      id: Account.Security,\n                      data: Account.Security,\n                      type: meta.id,\n                      properties: {\n                        label: ['security label', { ns: meta.id }],\n                        icon: 'ph--key--regular',\n                      },\n                    },\n                  ],\n                },\n              ];\n            }),\n            Option.getOrElse(() => []),\n          ),\n        ),\n    }),\n  );\n"],
-  "mappings": ";;;;;;;;;;;;AAIA,SAASA,YAAY;AACrB,YAAYC,cAAc;AAC1B,YAAYC,YAAY;AAExB,SAASC,oBAAoB;AAC7B,SAASC,cAAkCC,mBAAmB;AAC9D,SAASC,SAASC,oBAAoBC,uBAAuB;AAC7D,SAASC,uBAAuB;AAOhC,IAAA,6BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC,KAAKD;EACTE,SAAS,CAACC,SACRC,KAAKC,KAAK,CAACC,QACAC,cACPD,IAAIH,IAAAA,GACGK,eAAQ,CAACL,UAAUA,MAAKH,OAAOS,UAAiBC,YAAKP,KAAAA,IAAeQ,YAAI,CAAA,GACxEC,WAAI,MAAA;AACT,WAAO;MACL;QACEZ,IAAI,GAAGC,KAAKD,EAAE;QACda,MAAM,YAAA;AACJ,gBAAM,EAAEC,iBAAiBC,SAAQ,IAAKpB,QAAQqB,cAAcnB,aAAaoB,gBAAgB;AACzF,gBAAMF,SAASG,aAAaC,aAAaC,aAAa,CAAA;QACxD;QACAC,YAAY;UACVC,OAAO;YAAC;YAA2B;cAAEC,IAAItB,KAAKD;YAAG;;UACjDwB,MAAM;UACNC,aAAa;UACbC,YAAY;YACVC,OAAO;;YAEPC,SAAS;YACTC,OAAO;UACT;QACF;MACF;;EAEJ,CAAA,GACOC,iBAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAG/BC,WAAW,CAAC5B,SACVC,KAAKC,KAAK,CAACC,QACAC,cACPD,IAAIH,IAAAA,GACGK,eAAQ,CAACL,UAAUA,MAAKH,OAAOS,UAAiBC,YAAKP,KAAAA,IAAeQ,YAAI,CAAA,GACxEC,WAAI,MAAA;AACT,UAAMoB,SAASrC,QAAQqB,cAAciB,mBAAmBC,MAAM;AAC9D,UAAMC,WAAW7B,IAAI8B,mBAAmBJ,OAAOK,KAAKF,QAAQ,CAAA;AAC5D,UAAMG,SAAShC,IAAI8B,mBAAmBJ,OAAOO,KAAKC,aAAa,CAAA;AAE/D,WAAO;MACL;QACExC,IAAIyC,QAAQzC;QACZ0C,MAAMzC,KAAKD;QACXqB,YAAY;UACVC,OAAO;YAAC;YAAiB;cAAEC,IAAItB,KAAKD;YAAG;;UACvCwB,MAAM;UACNC,aAAa;;UAEbkB,QAAQR,UAAUS,YAAYC,MAAAA;UAC9BC,KAAKX,UAAUY,SAASlC,MAAMiC;UAC9BE,OAAOb,UAAUY,SAASlC,MAAMmC;UAChCV,QAAQA,OAAOW,UAAUC,gBAAgBC,UAAU,UAAU;QAC/D;QACAC,OAAO;UACL;YACEpD,IAAIyC,QAAQY;YACZxC,MAAM4B,QAAQY;YACdX,MAAMzC,KAAKD;YACXqB,YAAY;cACVC,OAAO;gBAAC;gBAAiB;kBAAEC,IAAItB,KAAKD;gBAAG;;cACvCwB,MAAM;YACR;UACF;UACA;YACExB,IAAIyC,QAAQa;YACZzC,MAAM4B,QAAQa;YACdZ,MAAMzC,KAAKD;YACXqB,YAAY;cACVC,OAAO;gBAAC;gBAAiB;kBAAEC,IAAItB,KAAKD;gBAAG;;cACvCwB,MAAM;cACN+B,QAAQ;YACV;UACF;UACA;YACEvD,IAAIyC,QAAQe;YACZ3C,MAAM4B,QAAQe;YACdd,MAAMzC,KAAKD;YACXqB,YAAY;cACVC,OAAO;gBAAC;gBAAkB;kBAAEC,IAAItB,KAAKD;gBAAG;;cACxCwB,MAAM;YACR;UACF;;MAEJ;;EAEJ,CAAA,GACOM,iBAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
-  "names": ["Atom", "Function", "Option", "createIntent", "Capabilities", "contributes", "ROOT_ID", "atomFromObservable", "createExtension", "ConnectionState", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "meta", "actions", "node", "Atom", "make", "get", "pipe", "flatMap", "ROOT_ID", "some", "none", "map", "data", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "createIntent", "ClientAction", "ShareIdentity", "properties", "label", "ns", "icon", "disposition", "keyBinding", "macos", "windows", "linux", "getOrElse", "connector", "client", "ClientCapabilities", "Client", "identity", "atomFromObservable", "halo", "status", "mesh", "networkStatus", "Account", "type", "userId", "identityKey", "toHex", "hue", "profile", "emoji", "swarm", "ConnectionState", "OFFLINE", "nodes", "Profile", "Devices", "testId", "Security"]
-}

package/dist/lib/browser/chunk-4LRO3Y2O.mjs

@@ -1,19 +0,0 @@
-import {
-  meta
-} from "./chunk-ZRVMXLDR.mjs";
-
-// src/events.ts
-import { defineEvent } from "@dxos/app-framework";
-(function(ClientEvents2) {
-  ClientEvents2.ClientReady = defineEvent(`${meta.id}/event/client-ready`);
-  ClientEvents2.SetupSchema = defineEvent(`${meta.id}/event/setup-schema`);
-  ClientEvents2.SetupMigration = defineEvent(`${meta.id}/event/setup-migration`);
-  ClientEvents2.IdentityCreated = defineEvent(`${meta.id}/event/identity-created`);
-  ClientEvents2.SpacesReady = defineEvent(`${meta.id}/event/spaces-ready`);
-})(ClientEvents || (ClientEvents = {}));
-var ClientEvents;
-
-export {
-  ClientEvents
-};
-//# sourceMappingURL=chunk-4LRO3Y2O.mjs.map

package/dist/lib/browser/chunk-4LRO3Y2O.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/events.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineEvent } from '@dxos/app-framework';\n\nimport { meta } from './meta';\n\nexport namespace ClientEvents {\n  export const ClientReady = defineEvent(`${meta.id}/event/client-ready`);\n  export const SetupSchema = defineEvent(`${meta.id}/event/setup-schema`);\n  export const SetupMigration = defineEvent(`${meta.id}/event/setup-migration`);\n  export const IdentityCreated = defineEvent(`${meta.id}/event/identity-created`);\n  export const SpacesReady = defineEvent(`${meta.id}/event/spaces-ready`);\n}\n"],
-  "mappings": ";;;;;AAIA,SAASA,mBAAmB;UAIXC,eAAAA;gBACFC,cAAcC,YAAY,GAAGC,KAAKC,EAAE,qBAAqB;gBACzDC,cAAcH,YAAY,GAAGC,KAAKC,EAAE,qBAAqB;gBACzDE,iBAAiBJ,YAAY,GAAGC,KAAKC,EAAE,wBAAwB;gBAC/DG,kBAAkBL,YAAY,GAAGC,KAAKC,EAAE,yBAAyB;gBACjEI,cAAcN,YAAY,GAAGC,KAAKC,EAAE,qBAAqB;AACxE,GANiBJ,iBAAAA,eAAAA,CAAAA,EAAAA;;",
-  "names": ["defineEvent", "ClientEvents", "ClientReady", "defineEvent", "meta", "id", "SetupSchema", "SetupMigration", "IdentityCreated", "SpacesReady"]
-}