@dxos/plugin-client 0.7.4-staging.f7e8224 → 0.7.5-main.499c70c

package/src/types.ts

@@ -0,0 +1,115 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import {
+  type GraphBuilderProvides,
+  type IntentResolverProvides,
+  type Plugin,
+  type SurfaceProvides,
+  type TranslationsProvides,
+} from '@dxos/app-framework';
+import { S } from '@dxos/echo-schema';
+import { Client, PublicKey, type ClientOptions } from '@dxos/react-client';
+
+import { CLIENT_PLUGIN } from './meta';
+
+// TODO(wittjosiah): Factor out. Generate?
+const IdentitySchema = S.Struct({
+  identityKey: S.instanceOf(PublicKey),
+  spaceKey: S.optional(S.instanceOf(PublicKey)),
+  profile: S.optional(
+    S.Struct({
+      displayName: S.optional(S.String),
+      avatarCid: S.optional(S.String),
+      data: S.optional(S.Record({ key: S.String, value: S.Any })),
+    }),
+  ),
+});
+
+const CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;
+export namespace ClientAction {
+  export class CreateIdentity extends S.TaggedClass<CreateIdentity>()(`${CLIENT_ACTION}/create-identity`, {
+    input: S.Struct({
+      displayName: S.optional(S.String),
+    }),
+    output: IdentitySchema,
+  }) {}
+
+  export class JoinIdentity extends S.TaggedClass<JoinIdentity>()(`${CLIENT_ACTION}/join-identity`, {
+    input: S.Struct({
+      invitationCode: S.String,
+    }),
+    output: S.Void,
+  }) {}
+
+  export class ShareIdentity extends S.TaggedClass<ShareIdentity>()(`${CLIENT_ACTION}/share-identity`, {
+    input: S.Void,
+    output: S.Void,
+  }) {}
+
+  export class RecoverIdentity extends S.TaggedClass<RecoverIdentity>()(`${CLIENT_ACTION}/recover-identity`, {
+    input: S.Void,
+    output: S.Void,
+  }) {}
+
+  export class ResetStorage extends S.TaggedClass<ResetStorage>()(`${CLIENT_ACTION}/reset-storage`, {
+    input: S.Struct({
+      target: S.optional(S.String),
+    }),
+    output: S.Void,
+  }) {}
+
+  export class CreateAgent extends S.TaggedClass<CreateAgent>()(`${CLIENT_ACTION}/create-agent`, {
+    input: S.Void,
+    output: S.Void,
+  }) {}
+
+  export class CreateRecoveryCode extends S.TaggedClass<CreateRecoveryCode>()(`${CLIENT_ACTION}/create-recovery-code`, {
+    input: S.Void,
+    output: S.Void,
+  }) {}
+}
+
+export type ClientPluginOptions = ClientOptions & {
+  /**
+   * Used to track app-specific state in spaces.
+   */
+  appKey: string;
+
+  /**
+   * Base URL for the invitation link.
+   */
+  invitationUrl?: string;
+
+  /**
+   * Query parameter for the invitation code.
+   */
+  invitationParam?: string;
+
+  /**
+   * Run after the client has been initialized.
+   */
+  onClientInitialized?: (client: Client) => Promise<void>;
+
+  /**
+   * Run after the identity has been successfully initialized.
+   * Run with client during plugin ready phase.
+   */
+  onReady?: (client: Client, plugins: Plugin[]) => Promise<void>;
+
+  /**
+   * Called when the client is reset.
+   */
+  onReset?: (params: { target?: string }) => Promise<void>;
+};
+
+export type ClientPluginProvides = IntentResolverProvides &
+  GraphBuilderProvides &
+  SurfaceProvides &
+  TranslationsProvides & {
+    client: Client;
+  };
+
+export const parseClientPlugin = (plugin?: Plugin) =>
+  (plugin?.provides as any).client instanceof Client ? (plugin as Plugin<ClientPluginProvides>) : undefined;

package/dist/lib/browser/chunk-FGUXUNOK.mjs

@@ -1,26 +0,0 @@
-// packages/plugins/plugin-client/src/meta.ts
-var CLIENT_PLUGIN = "dxos.org/plugin/client";
-var meta_default = {
-  id: CLIENT_PLUGIN,
-  name: "Client"
-};
-var CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;
-var ClientAction;
-(function(ClientAction2) {
-  ClientAction2[ClientAction2["CREATE_IDENTITY"] = `${CLIENT_ACTION}/CREATE_IDENTITY`] = "CREATE_IDENTITY";
-  ClientAction2[ClientAction2["JOIN_IDENTITY"] = `${CLIENT_ACTION}/JOIN_IDENTITY`] = "JOIN_IDENTITY";
-  ClientAction2[ClientAction2["SHARE_IDENTITY"] = `${CLIENT_ACTION}/SHARE_IDENTITY`] = "SHARE_IDENTITY";
-  ClientAction2[ClientAction2["RECOVER_IDENTITY"] = `${CLIENT_ACTION}/RECOVER_IDENTITY`] = "RECOVER_IDENTITY";
-  ClientAction2[ClientAction2["RESET_STORAGE"] = `${CLIENT_ACTION}/RESET_STORAGE`] = "RESET_STORAGE";
-  ClientAction2[ClientAction2["CREATE_AGENT"] = `${CLIENT_ACTION}/CREATE_AGENT`] = "CREATE_AGENT";
-  ClientAction2[ClientAction2["CREATE_RECOVERY_CODE"] = `${CLIENT_ACTION}/CREATE_RECOVERY_CODE`] = "CREATE_RECOVERY_CODE";
-})(ClientAction || (ClientAction = {}));
-var OBSERVABILITY_ACTION = "dxos.org/plugin/observability/send-event";
-
-export {
-  CLIENT_PLUGIN,
-  meta_default,
-  ClientAction,
-  OBSERVABILITY_ACTION
-};
-//# sourceMappingURL=chunk-FGUXUNOK.mjs.map

package/dist/lib/browser/chunk-FGUXUNOK.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const CLIENT_PLUGIN = 'dxos.org/plugin/client';\n\nexport default {\n  id: CLIENT_PLUGIN,\n  name: 'Client',\n} satisfies PluginMeta;\n\nconst CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;\nexport enum ClientAction {\n  CREATE_IDENTITY = `${CLIENT_ACTION}/CREATE_IDENTITY`,\n  JOIN_IDENTITY = `${CLIENT_ACTION}/JOIN_IDENTITY`,\n  SHARE_IDENTITY = `${CLIENT_ACTION}/SHARE_IDENTITY`,\n  RECOVER_IDENTITY = `${CLIENT_ACTION}/RECOVER_IDENTITY`,\n  RESET_STORAGE = `${CLIENT_ACTION}/RESET_STORAGE`,\n  CREATE_AGENT = `${CLIENT_ACTION}/CREATE_AGENT`,\n  CREATE_RECOVERY_CODE = `${CLIENT_ACTION}/CREATE_RECOVERY_CODE`,\n}\n\n// NOTE: This action is hardcoded to avoid circular dependency with observability plugin.\nexport const OBSERVABILITY_ACTION = 'dxos.org/plugin/observability/send-event';\n"],
-  "mappings": ";AAMO,IAAMA,gBAAgB;AAE7B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,gBAAgB,GAAGH,aAAAA;;UACbI,eAAAA;mDACQ,GAAGD,aAAAA,kBAA+B,IAAA;iDACpC,GAAGA,aAAAA,gBAA6B,IAAA;kDAC/B,GAAGA,aAAAA,iBAA8B,IAAA;oDAC/B,GAAGA,aAAAA,mBAAgC,IAAA;iDACtC,GAAGA,aAAAA,gBAA6B,IAAA;gDACjC,GAAGA,aAAAA,eAA4B,IAAA;wDACvB,GAAGA,aAAAA,uBAAoC,IAAA;GAPpDC,iBAAAA,eAAAA,CAAAA,EAAAA;AAWL,IAAMC,uBAAuB;",
-  "names": ["CLIENT_PLUGIN", "id", "name", "CLIENT_ACTION", "ClientAction", "OBSERVABILITY_ACTION"]
-}

package/dist/lib/node/chunk-XYLDQWFV.cjs

@@ -1,51 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var chunk_XYLDQWFV_exports = {};
-__export(chunk_XYLDQWFV_exports, {
-  CLIENT_PLUGIN: () => CLIENT_PLUGIN,
-  ClientAction: () => ClientAction,
-  OBSERVABILITY_ACTION: () => OBSERVABILITY_ACTION,
-  meta_default: () => meta_default
-});
-module.exports = __toCommonJS(chunk_XYLDQWFV_exports);
-var CLIENT_PLUGIN = "dxos.org/plugin/client";
-var meta_default = {
-  id: CLIENT_PLUGIN,
-  name: "Client"
-};
-var CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;
-var ClientAction;
-(function(ClientAction2) {
-  ClientAction2[ClientAction2["CREATE_IDENTITY"] = `${CLIENT_ACTION}/CREATE_IDENTITY`] = "CREATE_IDENTITY";
-  ClientAction2[ClientAction2["JOIN_IDENTITY"] = `${CLIENT_ACTION}/JOIN_IDENTITY`] = "JOIN_IDENTITY";
-  ClientAction2[ClientAction2["SHARE_IDENTITY"] = `${CLIENT_ACTION}/SHARE_IDENTITY`] = "SHARE_IDENTITY";
-  ClientAction2[ClientAction2["RECOVER_IDENTITY"] = `${CLIENT_ACTION}/RECOVER_IDENTITY`] = "RECOVER_IDENTITY";
-  ClientAction2[ClientAction2["RESET_STORAGE"] = `${CLIENT_ACTION}/RESET_STORAGE`] = "RESET_STORAGE";
-  ClientAction2[ClientAction2["CREATE_AGENT"] = `${CLIENT_ACTION}/CREATE_AGENT`] = "CREATE_AGENT";
-  ClientAction2[ClientAction2["CREATE_RECOVERY_CODE"] = `${CLIENT_ACTION}/CREATE_RECOVERY_CODE`] = "CREATE_RECOVERY_CODE";
-})(ClientAction || (ClientAction = {}));
-var OBSERVABILITY_ACTION = "dxos.org/plugin/observability/send-event";
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  CLIENT_PLUGIN,
-  ClientAction,
-  OBSERVABILITY_ACTION,
-  meta_default
-});
-//# sourceMappingURL=chunk-XYLDQWFV.cjs.map

package/dist/lib/node/chunk-XYLDQWFV.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const CLIENT_PLUGIN = 'dxos.org/plugin/client';\n\nexport default {\n  id: CLIENT_PLUGIN,\n  name: 'Client',\n} satisfies PluginMeta;\n\nconst CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;\nexport enum ClientAction {\n  CREATE_IDENTITY = `${CLIENT_ACTION}/CREATE_IDENTITY`,\n  JOIN_IDENTITY = `${CLIENT_ACTION}/JOIN_IDENTITY`,\n  SHARE_IDENTITY = `${CLIENT_ACTION}/SHARE_IDENTITY`,\n  RECOVER_IDENTITY = `${CLIENT_ACTION}/RECOVER_IDENTITY`,\n  RESET_STORAGE = `${CLIENT_ACTION}/RESET_STORAGE`,\n  CREATE_AGENT = `${CLIENT_ACTION}/CREATE_AGENT`,\n  CREATE_RECOVERY_CODE = `${CLIENT_ACTION}/CREATE_RECOVERY_CODE`,\n}\n\n// NOTE: This action is hardcoded to avoid circular dependency with observability plugin.\nexport const OBSERVABILITY_ACTION = 'dxos.org/plugin/observability/send-event';\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;AAMO,IAAMA,gBAAgB;AAE7B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,gBAAgB,GAAGH,aAAAA;;UACbI,eAAAA;mDACQ,GAAGD,aAAAA,kBAA+B,IAAA;iDACpC,GAAGA,aAAAA,gBAA6B,IAAA;kDAC/B,GAAGA,aAAAA,iBAA8B,IAAA;oDAC/B,GAAGA,aAAAA,mBAAgC,IAAA;iDACtC,GAAGA,aAAAA,gBAA6B,IAAA;gDACjC,GAAGA,aAAAA,eAA4B,IAAA;wDACvB,GAAGA,aAAAA,uBAAoC,IAAA;GAPpDC,iBAAAA,eAAAA,CAAAA,EAAAA;AAWL,IAAMC,uBAAuB;",
-  "names": ["CLIENT_PLUGIN", "id", "name", "CLIENT_ACTION", "ClientAction", "OBSERVABILITY_ACTION"]
-}

package/dist/lib/node-esm/chunk-C6X363FK.mjs

@@ -1,28 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-
-// packages/plugins/plugin-client/src/meta.ts
-var CLIENT_PLUGIN = "dxos.org/plugin/client";
-var meta_default = {
-  id: CLIENT_PLUGIN,
-  name: "Client"
-};
-var CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;
-var ClientAction;
-(function(ClientAction2) {
-  ClientAction2[ClientAction2["CREATE_IDENTITY"] = `${CLIENT_ACTION}/CREATE_IDENTITY`] = "CREATE_IDENTITY";
-  ClientAction2[ClientAction2["JOIN_IDENTITY"] = `${CLIENT_ACTION}/JOIN_IDENTITY`] = "JOIN_IDENTITY";
-  ClientAction2[ClientAction2["SHARE_IDENTITY"] = `${CLIENT_ACTION}/SHARE_IDENTITY`] = "SHARE_IDENTITY";
-  ClientAction2[ClientAction2["RECOVER_IDENTITY"] = `${CLIENT_ACTION}/RECOVER_IDENTITY`] = "RECOVER_IDENTITY";
-  ClientAction2[ClientAction2["RESET_STORAGE"] = `${CLIENT_ACTION}/RESET_STORAGE`] = "RESET_STORAGE";
-  ClientAction2[ClientAction2["CREATE_AGENT"] = `${CLIENT_ACTION}/CREATE_AGENT`] = "CREATE_AGENT";
-  ClientAction2[ClientAction2["CREATE_RECOVERY_CODE"] = `${CLIENT_ACTION}/CREATE_RECOVERY_CODE`] = "CREATE_RECOVERY_CODE";
-})(ClientAction || (ClientAction = {}));
-var OBSERVABILITY_ACTION = "dxos.org/plugin/observability/send-event";
-
-export {
-  CLIENT_PLUGIN,
-  meta_default,
-  ClientAction,
-  OBSERVABILITY_ACTION
-};
-//# sourceMappingURL=chunk-C6X363FK.mjs.map

package/dist/lib/node-esm/chunk-C6X363FK.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const CLIENT_PLUGIN = 'dxos.org/plugin/client';\n\nexport default {\n  id: CLIENT_PLUGIN,\n  name: 'Client',\n} satisfies PluginMeta;\n\nconst CLIENT_ACTION = `${CLIENT_PLUGIN}/action`;\nexport enum ClientAction {\n  CREATE_IDENTITY = `${CLIENT_ACTION}/CREATE_IDENTITY`,\n  JOIN_IDENTITY = `${CLIENT_ACTION}/JOIN_IDENTITY`,\n  SHARE_IDENTITY = `${CLIENT_ACTION}/SHARE_IDENTITY`,\n  RECOVER_IDENTITY = `${CLIENT_ACTION}/RECOVER_IDENTITY`,\n  RESET_STORAGE = `${CLIENT_ACTION}/RESET_STORAGE`,\n  CREATE_AGENT = `${CLIENT_ACTION}/CREATE_AGENT`,\n  CREATE_RECOVERY_CODE = `${CLIENT_ACTION}/CREATE_RECOVERY_CODE`,\n}\n\n// NOTE: This action is hardcoded to avoid circular dependency with observability plugin.\nexport const OBSERVABILITY_ACTION = 'dxos.org/plugin/observability/send-event';\n"],
-  "mappings": ";;;AAMO,IAAMA,gBAAgB;AAE7B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,gBAAgB,GAAGH,aAAAA;;UACbI,eAAAA;mDACQ,GAAGD,aAAAA,kBAA+B,IAAA;iDACpC,GAAGA,aAAAA,gBAA6B,IAAA;kDAC/B,GAAGA,aAAAA,iBAA8B,IAAA;oDAC/B,GAAGA,aAAAA,mBAAgC,IAAA;iDACtC,GAAGA,aAAAA,gBAA6B,IAAA;gDACjC,GAAGA,aAAAA,eAA4B,IAAA;wDACvB,GAAGA,aAAAA,uBAAoC,IAAA;GAPpDC,iBAAAA,eAAAA,CAAAA,EAAAA;AAWL,IAAMC,uBAAuB;",
-  "names": ["CLIENT_PLUGIN", "id", "name", "CLIENT_ACTION", "ClientAction", "OBSERVABILITY_ACTION"]
-}