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

package/src/types/schema.ts

@@ -0,0 +1,243 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import type * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { type Client, type ClientOptions, PublicKey } from '@dxos/client';
+import { Operation } from '@dxos/operation';
+
+import { meta } from '../meta';
+
+// TODO(wittjosiah): Factor out. Generate?
+const IdentitySchema = Schema.Struct({
+  identityKey: Schema.instanceOf(PublicKey),
+  spaceKey: Schema.optional(Schema.instanceOf(PublicKey)),
+  profile: Schema.optional(
+    Schema.Struct({
+      displayName: Schema.optional(Schema.String),
+      avatarCid: Schema.optional(Schema.String),
+      data: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+    }),
+  ),
+});
+
+export namespace ClientAction {
+  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 class CreateIdentity extends Schema.TaggedClass<CreateIdentity>()(`${meta.id}/action/create-identity`, {
+    input: ProfileSchema,
+    output: IdentitySchema,
+  }) {}
+
+  export class JoinIdentity extends Schema.TaggedClass<JoinIdentity>()(`${meta.id}/action/join-identity`, {
+    input: Schema.Struct({
+      invitationCode: Schema.optional(Schema.String),
+    }),
+    output: Schema.Void,
+  }) {}
+
+  export class ShareIdentity extends Schema.TaggedClass<ShareIdentity>()(`${meta.id}/action/share-identity`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+
+  export class RecoverIdentity extends Schema.TaggedClass<RecoverIdentity>()(`${meta.id}/action/recover-identity`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+
+  export class ResetStorage extends Schema.TaggedClass<ResetStorage>()(`${meta.id}/action/reset-storage`, {
+    input: Schema.Struct({
+      mode: Schema.optional(Schema.String),
+    }),
+    output: Schema.Void,
+  }) {}
+
+  export class CreateAgent extends Schema.TaggedClass<CreateAgent>()(`${meta.id}/action/create-agent`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+
+  export class CreateRecoveryCode extends Schema.TaggedClass<CreateRecoveryCode>()(
+    `${meta.id}/action/create-recovery-code`,
+    {
+      input: Schema.Void,
+      output: Schema.Void,
+    },
+  ) {}
+
+  export class CreatePasskey extends Schema.TaggedClass<CreatePasskey>()(`${meta.id}/action/create-passkey`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+
+  export class RedeemPasskey extends Schema.TaggedClass<RedeemPasskey>()(`${meta.id}/action/redeem-passkey`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+
+  export class RedeemToken extends Schema.TaggedClass<RedeemToken>()(`${meta.id}/action/redeem-token`, {
+    input: Schema.Struct({
+      token: Schema.String,
+    }),
+    output: Schema.Void,
+  }) {}
+}
+
+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.
+   */
+  invitationUrl?: string;
+
+  /**
+   * Query parameter for the invitation code.
+   */
+  invitationProp?: string;
+
+  /**
+   * Run after the client has been initialized.
+   * Plugin context is provided so capabilities are accessible.
+   */
+  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: { 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 }) => Effect.Effect<void, Error | never, Capability.Service | never>;
+};
+
+export namespace Account {
+  // TODO(wittjosiah): Cannot use slashes in ids until we have a router which decouples ids from url paths.
+  const _id = 'dxos.org.plugin.client.account';
+  // TODO(wittjosiah): This is a hack to prevent the previous deck from being set for pinned items.
+  //  Ideally this should be worked into the data model in a generic way.
+  export const id = `!${_id}`;
+
+  export const Profile = `${_id}.profile`;
+  export const Devices = `${_id}.devices`;
+  export const Security = `${_id}.security`;
+}

package/dist/lib/browser/app-graph-builder-3EILEBWW.mjs

@@ -1,123 +0,0 @@
-import {
-  ClientCapabilities
-} from "./chunk-AWXKL4UR.mjs";
-import {
-  Account,
-  ClientAction
-} from "./chunk-Q7TFRFHI.mjs";
-import {
-  CLIENT_PLUGIN
-} from "./chunk-GS3LDHYD.mjs";
-
-// src/capabilities/app-graph-builder.ts
-import { Rx } from "@effect-rx/rx-react";
-import { Option, pipe } from "effect";
-import { createIntent } from "@dxos/app-framework";
-import { Capabilities, contributes } from "@dxos/app-framework";
-import { createExtension, rxFromObservable, ROOT_ID } from "@dxos/plugin-graph";
-import { ConnectionState } from "@dxos/react-client/mesh";
-var app_graph_builder_default = (context) => contributes(Capabilities.AppGraphBuilder, createExtension({
-  id: CLIENT_PLUGIN,
-  actions: (node) => Rx.make((get) => pipe(get(node), Option.flatMap((node2) => node2.id === ROOT_ID ? Option.some(node2) : Option.none()), Option.map(() => {
-    return [
-      {
-        id: `${CLIENT_PLUGIN}/open-user-account`,
-        data: async () => {
-          const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-          await dispatch(createIntent(ClientAction.ShareIdentity));
-        },
-        properties: {
-          label: [
-            "open user account label",
-            {
-              ns: CLIENT_PLUGIN
-            }
-          ],
-          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) => 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(rxFromObservable(client.halo.identity));
-    const status = get(rxFromObservable(client.mesh.networkStatus));
-    return [
-      {
-        id: Account.id,
-        type: CLIENT_PLUGIN,
-        properties: {
-          label: [
-            "account label",
-            {
-              ns: CLIENT_PLUGIN
-            }
-          ],
-          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: CLIENT_PLUGIN,
-            properties: {
-              label: [
-                "profile label",
-                {
-                  ns: CLIENT_PLUGIN
-                }
-              ],
-              icon: "ph--user--regular"
-            }
-          },
-          {
-            id: Account.Devices,
-            data: Account.Devices,
-            type: CLIENT_PLUGIN,
-            properties: {
-              label: [
-                "devices label",
-                {
-                  ns: CLIENT_PLUGIN
-                }
-              ],
-              icon: "ph--devices--regular",
-              testId: "clientPlugin.devices"
-            }
-          },
-          {
-            id: Account.Security,
-            data: Account.Security,
-            type: CLIENT_PLUGIN,
-            properties: {
-              label: [
-                "security label",
-                {
-                  ns: CLIENT_PLUGIN
-                }
-              ],
-              icon: "ph--key--regular"
-            }
-          }
-        ]
-      }
-    ];
-  }), Option.getOrElse(() => [])))
-}));
-export {
-  app_graph_builder_default as default
-};
-//# sourceMappingURL=app-graph-builder-3EILEBWW.mjs.map

package/dist/lib/browser/app-graph-builder-3EILEBWW.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/app-graph-builder.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport { Option, pipe } from 'effect';\n\nimport { createIntent } from '@dxos/app-framework';\nimport { Capabilities, contributes, type PluginContext } from '@dxos/app-framework';\nimport { createExtension, rxFromObservable, ROOT_ID } from '@dxos/plugin-graph';\nimport { ConnectionState } from '@dxos/react-client/mesh';\n\nimport { ClientCapabilities } from './capabilities';\nimport { CLIENT_PLUGIN } from '../meta';\nimport { Account, ClientAction } from '../types';\n\nexport default (context: PluginContext) =>\n  contributes(\n    Capabilities.AppGraphBuilder,\n    createExtension({\n      id: CLIENT_PLUGIN,\n      actions: (node) =>\n        Rx.make((get) =>\n          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: `${CLIENT_PLUGIN}/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: CLIENT_PLUGIN }],\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        Rx.make((get) =>\n          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(rxFromObservable(client.halo.identity));\n              const status = get(rxFromObservable(client.mesh.networkStatus));\n\n              return [\n                {\n                  id: Account.id,\n                  type: CLIENT_PLUGIN,\n                  properties: {\n                    label: ['account label', { ns: CLIENT_PLUGIN }],\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: CLIENT_PLUGIN,\n                      properties: {\n                        label: ['profile label', { ns: CLIENT_PLUGIN }],\n                        icon: 'ph--user--regular',\n                      },\n                    },\n                    {\n                      id: Account.Devices,\n                      data: Account.Devices,\n                      type: CLIENT_PLUGIN,\n                      properties: {\n                        label: ['devices label', { ns: CLIENT_PLUGIN }],\n                        icon: 'ph--devices--regular',\n                        testId: 'clientPlugin.devices',\n                      },\n                    },\n                    {\n                      id: Account.Security,\n                      data: Account.Security,\n                      type: CLIENT_PLUGIN,\n                      properties: {\n                        label: ['security label', { ns: CLIENT_PLUGIN }],\n                        icon: 'ph--key--regular',\n                      },\n                    },\n                  ],\n                },\n              ];\n            }),\n            Option.getOrElse(() => []),\n          ),\n        ),\n    }),\n  );\n"],
-  "mappings": ";;;;;;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,oBAAoB;AAC7B,SAASC,cAAcC,mBAAuC;AAC9D,SAASC,iBAAiBC,kBAAkBC,eAAe;AAC3D,SAASC,uBAAuB;AAMhC,IAAA,4BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC;EACJC,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAOU,UAAUF,OAAOG,KAAKR,KAAAA,IAAQK,OAAOI,KAAI,CAAA,GAC/EJ,OAAOK,IAAI,MAAA;AACT,WAAO;MACL;QACEb,IAAI,GAAGC,aAAAA;QACPa,MAAM,YAAA;AACJ,gBAAM,EAAEC,iBAAiBC,SAAQ,IAAKrB,QAAQsB,cAAcpB,aAAaqB,gBAAgB;AACzF,gBAAMF,SAASG,aAAaC,aAAaC,aAAa,CAAA;QACxD;QACAC,YAAY;UACVC,OAAO;YAAC;YAA2B;cAAEC,IAAIvB;YAAc;;UACvDwB,MAAM;UACNC,aAAa;UACbC,YAAY;YACVC,OAAO;;YAEPC,SAAS;YACTC,OAAO;UACT;QACF;MACF;;EAEJ,CAAA,GACAtB,OAAOuB,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAG/BC,WAAW,CAAC7B,SACVC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAOU,UAAUF,OAAOG,KAAKR,KAAAA,IAAQK,OAAOI,KAAI,CAAA,GAC/EJ,OAAOK,IAAI,MAAA;AACT,UAAMoB,SAAStC,QAAQsB,cAAciB,mBAAmBC,MAAM;AAC9D,UAAMC,WAAW9B,IAAI+B,iBAAiBJ,OAAOK,KAAKF,QAAQ,CAAA;AAC1D,UAAMG,SAASjC,IAAI+B,iBAAiBJ,OAAOO,KAAKC,aAAa,CAAA;AAE7D,WAAO;MACL;QACEzC,IAAI0C,QAAQ1C;QACZ2C,MAAM1C;QACNqB,YAAY;UACVC,OAAO;YAAC;YAAiB;cAAEC,IAAIvB;YAAc;;UAC7CwB,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;YACErD,IAAI0C,QAAQY;YACZxC,MAAM4B,QAAQY;YACdX,MAAM1C;YACNqB,YAAY;cACVC,OAAO;gBAAC;gBAAiB;kBAAEC,IAAIvB;gBAAc;;cAC7CwB,MAAM;YACR;UACF;UACA;YACEzB,IAAI0C,QAAQa;YACZzC,MAAM4B,QAAQa;YACdZ,MAAM1C;YACNqB,YAAY;cACVC,OAAO;gBAAC;gBAAiB;kBAAEC,IAAIvB;gBAAc;;cAC7CwB,MAAM;cACN+B,QAAQ;YACV;UACF;UACA;YACExD,IAAI0C,QAAQe;YACZ3C,MAAM4B,QAAQe;YACdd,MAAM1C;YACNqB,YAAY;cACVC,OAAO;gBAAC;gBAAkB;kBAAEC,IAAIvB;gBAAc;;cAC9CwB,MAAM;YACR;UACF;;MAEJ;;EAEJ,CAAA,GACAjB,OAAOuB,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
-  "names": ["Rx", "Option", "pipe", "createIntent", "Capabilities", "contributes", "createExtension", "rxFromObservable", "ROOT_ID", "ConnectionState", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "CLIENT_PLUGIN", "actions", "node", "Rx", "make", "get", "pipe", "Option", "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", "rxFromObservable", "halo", "status", "mesh", "networkStatus", "Account", "type", "userId", "identityKey", "toHex", "hue", "profile", "emoji", "swarm", "ConnectionState", "OFFLINE", "nodes", "Profile", "Devices", "testId", "Security"]
-}