@xmtp/browser-sdk 0.0.21 → 0.0.22

package/src/Client.ts

@@ -112,34 +112,91 @@ export class Client extends ClientWorkerClass {
     return this.#installationIdBytes;
   }
 
-  async #createInboxSignatureText() {
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `register` function instead.
+   */
+  async unsafe_createInboxSignatureText() {
     return this.sendMessage("createInboxSignatureText", undefined);
   }
 
-  async #addAccountSignatureText(newAccountAddress: string) {
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `unsafe_addAccount` function instead.
+   *
+   * The `allowInboxReassign` parameter must be true or this function will
+   * throw an error.
+   */
+  async unsafe_addAccountSignatureText(
+    newAccountAddress: string,
+    allowInboxReassign: boolean = false,
+  ) {
+    if (!allowInboxReassign) {
+      throw new Error(
+        "Unable to create add account signature text, `allowInboxReassign` must be true",
+      );
+    }
+
     return this.sendMessage("addAccountSignatureText", {
       newAccountAddress,
     });
   }
 
-  async #removeAccountSignatureText(accountAddress: string) {
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `removeAccount` function instead.
+   */
+  async unsafe_removeAccountSignatureText(accountAddress: string) {
     return this.sendMessage("removeAccountSignatureText", { accountAddress });
   }
 
-  async #revokeAllOtherInstallationsSignatureText() {
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `revokeAllOtherInstallations` function
+   * instead.
+   */
+  async unsafe_revokeAllOtherInstallationsSignatureText() {
     return this.sendMessage(
       "revokeAllOtherInstallationsSignatureText",
       undefined,
     );
   }
 
-  async #revokeInstallationsSignatureText(installationIds: Uint8Array[]) {
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `revokeInstallations` function instead.
+   */
+  async unsafe_revokeInstallationsSignatureText(installationIds: Uint8Array[]) {
     return this.sendMessage("revokeInstallationsSignatureText", {
       installationIds,
     });
   }
 
-  async #addSignature(
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `register`, `addAccount`,
+   * `removeAccount`, `revokeAllOtherInstallations`, or `revokeInstallations`
+   * functions instead.
+   */
+  async unsafe_addSignature(
     signatureType: SignatureRequestType,
     signatureText: string,
     signer: Signer,
@@ -161,19 +218,28 @@ export class Client extends ClientWorkerClass {
     }
   }
 
-  async #applySignatures() {
+  /**
+   * WARNING: This function should be used with caution. It is only provided
+   * for use in special cases where the provided workflows do not meet the
+   * requirements of an application.
+   *
+   * It is highly recommended to use the `register`, `addAccount`,
+   * `removeAccount`, `revokeAllOtherInstallations`, or `revokeInstallations`
+   * functions instead.
+   */
+  async unsafe_applySignatures() {
     return this.sendMessage("applySignatures", undefined);
   }
 
   async register() {
-    const signatureText = await this.#createInboxSignatureText();
+    const signatureText = await this.unsafe_createInboxSignatureText();
 
     // if the signature text is not available, the client is already registered
     if (!signatureText) {
       return;
     }
 
-    await this.#addSignature(
+    await this.unsafe_addSignature(
       SignatureRequestType.CreateInbox,
       signatureText,
       this.#signer,
@@ -182,44 +248,67 @@ export class Client extends ClientWorkerClass {
     return this.sendMessage("registerIdentity", undefined);
   }
 
-  async addAccount(newAccountSigner: Signer) {
-    const signatureText = await this.#addAccountSignatureText(
+  /**
+   * WARNING: This function should be used with caution. Adding a wallet already
+   * associated with an inboxId will cause the wallet to lose access to
+   * that inbox.
+   *
+   * The `allowInboxReassign` parameter must be true to reassign an inbox
+   * already associated with a different account.
+   */
+  async unsafe_addAccount(
+    newAccountSigner: Signer,
+    allowInboxReassign: boolean = false,
+  ) {
+    // check for existing inbox id
+    const existingInboxId = await this.findInboxIdByAddress(
+      await newAccountSigner.getAddress(),
+    );
+
+    if (existingInboxId && !allowInboxReassign) {
+      throw new Error(
+        `Signer address already associated with inbox ${existingInboxId}`,
+      );
+    }
+
+    const signatureText = await this.unsafe_addAccountSignatureText(
       await newAccountSigner.getAddress(),
+      true,
     );
 
     if (!signatureText) {
       throw new Error("Unable to generate add account signature text");
     }
 
-    await this.#addSignature(
+    await this.unsafe_addSignature(
       SignatureRequestType.AddWallet,
       signatureText,
       newAccountSigner,
     );
 
-    await this.#applySignatures();
+    await this.unsafe_applySignatures();
   }
 
   async removeAccount(accountAddress: string) {
     const signatureText =
-      await this.#removeAccountSignatureText(accountAddress);
+      await this.unsafe_removeAccountSignatureText(accountAddress);
 
     if (!signatureText) {
       throw new Error("Unable to generate remove account signature text");
     }
 
-    await this.#addSignature(
+    await this.unsafe_addSignature(
       SignatureRequestType.RevokeWallet,
       signatureText,
       this.#signer,
     );
 
-    await this.#applySignatures();
+    await this.unsafe_applySignatures();
   }
 
   async revokeAllOtherInstallations() {
     const signatureText =
-      await this.#revokeAllOtherInstallationsSignatureText();
+      await this.unsafe_revokeAllOtherInstallationsSignatureText();
 
     if (!signatureText) {
       throw new Error(
@@ -227,30 +316,30 @@ export class Client extends ClientWorkerClass {
       );
     }
 
-    await this.#addSignature(
+    await this.unsafe_addSignature(
       SignatureRequestType.RevokeInstallations,
       signatureText,
       this.#signer,
     );
 
-    await this.#applySignatures();
+    await this.unsafe_applySignatures();
   }
 
   async revokeInstallations(installationIds: Uint8Array[]) {
     const signatureText =
-      await this.#revokeInstallationsSignatureText(installationIds);
+      await this.unsafe_revokeInstallationsSignatureText(installationIds);
 
     if (!signatureText) {
       throw new Error("Unable to generate revoke installations signature text");
     }
 
-    await this.#addSignature(
+    await this.unsafe_addSignature(
       SignatureRequestType.RevokeInstallations,
       signatureText,
       this.#signer,
     );
 
-    await this.#applySignatures();
+    await this.unsafe_applySignatures();
   }
 
   async isRegistered() {

package/src/Conversation.ts

@@ -1,11 +1,6 @@
 import type { ContentTypeId } from "@xmtp/content-type-primitives";
 import { ContentTypeText } from "@xmtp/content-type-text";
-import type {
-  ConsentState,
-  MetadataField,
-  PermissionPolicy,
-  PermissionUpdateType,
-} from "@xmtp/wasm-bindings";
+import type { ConsentState } from "@xmtp/wasm-bindings";
 import { v4 } from "uuid";
 import { AsyncStream, type StreamCallback } from "@/AsyncStream";
 import type { Client } from "@/Client";
@@ -22,12 +17,6 @@ export class Conversation {
 
   #id: string;
 
-  #name?: SafeConversation["name"];
-
-  #imageUrl?: SafeConversation["imageUrl"];
-
-  #description?: SafeConversation["description"];
-
   #isActive?: SafeConversation["isActive"];
 
   #addedByInboxId?: SafeConversation["addedByInboxId"];
@@ -36,10 +25,6 @@ export class Conversation {
 
   #createdAtNs?: SafeConversation["createdAtNs"];
 
-  #admins: SafeConversation["admins"] = [];
-
-  #superAdmins: SafeConversation["superAdmins"] = [];
-
   constructor(client: Client, id: string, data?: SafeConversation) {
     this.#client = client;
     this.#id = id;
@@ -47,57 +32,16 @@ export class Conversation {
   }
 
   #syncData(data?: SafeConversation) {
-    this.#name = data?.name ?? "";
-    this.#imageUrl = data?.imageUrl ?? "";
-    this.#description = data?.description ?? "";
     this.#isActive = data?.isActive ?? undefined;
     this.#addedByInboxId = data?.addedByInboxId ?? "";
     this.#metadata = data?.metadata ?? undefined;
     this.#createdAtNs = data?.createdAtNs ?? undefined;
-    this.#admins = data?.admins ?? [];
-    this.#superAdmins = data?.superAdmins ?? [];
   }
 
   get id() {
     return this.#id;
   }
 
-  get name() {
-    return this.#name;
-  }
-
-  async updateName(name: string) {
-    await this.#client.sendMessage("updateGroupName", {
-      id: this.#id,
-      name,
-    });
-    this.#name = name;
-  }
-
-  get imageUrl() {
-    return this.#imageUrl;
-  }
-
-  async updateImageUrl(imageUrl: string) {
-    await this.#client.sendMessage("updateGroupImageUrlSquare", {
-      id: this.#id,
-      imageUrl,
-    });
-    this.#imageUrl = imageUrl;
-  }
-
-  get description() {
-    return this.#description;
-  }
-
-  async updateDescription(description: string) {
-    await this.#client.sendMessage("updateGroupDescription", {
-      id: this.#id,
-      description,
-    });
-    this.#description = description;
-  }
-
   get isActive() {
     return this.#isActive;
   }
@@ -124,118 +68,12 @@ export class Conversation {
     });
   }
 
-  get admins() {
-    return this.#admins;
-  }
-
-  get superAdmins() {
-    return this.#superAdmins;
-  }
-
-  async syncAdmins() {
-    const admins = await this.#client.sendMessage("getGroupAdmins", {
-      id: this.#id,
-    });
-    this.#admins = admins;
-  }
-
-  async syncSuperAdmins() {
-    const superAdmins = await this.#client.sendMessage("getGroupSuperAdmins", {
-      id: this.#id,
-    });
-    this.#superAdmins = superAdmins;
-  }
-
-  async permissions() {
-    return this.#client.sendMessage("getGroupPermissions", {
-      id: this.#id,
-    });
-  }
-
-  async updatePermission(
-    permissionType: PermissionUpdateType,
-    policy: PermissionPolicy,
-    metadataField?: MetadataField,
-  ) {
-    return this.#client.sendMessage("updateGroupPermissionPolicy", {
-      id: this.#id,
-      permissionType,
-      policy,
-      metadataField,
-    });
-  }
-
-  async isAdmin(inboxId: string) {
-    await this.syncAdmins();
-    return this.#admins.includes(inboxId);
-  }
-
-  async isSuperAdmin(inboxId: string) {
-    await this.syncSuperAdmins();
-    return this.#superAdmins.includes(inboxId);
-  }
-
   async sync() {
     const data = await this.#client.sendMessage("syncGroup", {
       id: this.#id,
     });
     this.#syncData(data);
-  }
-
-  async addMembers(accountAddresses: string[]) {
-    return this.#client.sendMessage("addGroupMembers", {
-      id: this.#id,
-      accountAddresses,
-    });
-  }
-
-  async addMembersByInboxId(inboxIds: string[]) {
-    return this.#client.sendMessage("addGroupMembersByInboxId", {
-      id: this.#id,
-      inboxIds,
-    });
-  }
-
-  async removeMembers(accountAddresses: string[]) {
-    return this.#client.sendMessage("removeGroupMembers", {
-      id: this.#id,
-      accountAddresses,
-    });
-  }
-
-  async removeMembersByInboxId(inboxIds: string[]) {
-    return this.#client.sendMessage("removeGroupMembersByInboxId", {
-      id: this.#id,
-      inboxIds,
-    });
-  }
-
-  async addAdmin(inboxId: string) {
-    return this.#client.sendMessage("addGroupAdmin", {
-      id: this.#id,
-      inboxId,
-    });
-  }
-
-  async removeAdmin(inboxId: string) {
-    return this.#client.sendMessage("removeGroupAdmin", {
-      id: this.#id,
-      inboxId,
-    });
-  }
-
-  async addSuperAdmin(inboxId: string) {
-    return this.#client.sendMessage("addGroupSuperAdmin", {
-      id: this.#id,
-      inboxId,
-    });
-  }
-
-  async removeSuperAdmin(inboxId: string) {
-    return this.#client.sendMessage("removeGroupSuperAdmin", {
-      id: this.#id,
-      inboxId,
-    });
+    return data;
   }
 
   async publishMessages() {
@@ -304,12 +142,6 @@ export class Conversation {
     });
   }
 
-  async dmPeerInboxId() {
-    return this.#client.sendMessage("getDmPeerInboxId", {
-      id: this.#id,
-    });
-  }
-
   async messageDisappearingSettings() {
     return this.#client.sendMessage("getGroupMessageDisappearingSettings", {
       id: this.#id,
@@ -342,11 +174,17 @@ export class Conversation {
     const endStream = this.#client.handleStreamMessage<SafeMessage>(
       streamId,
       (error, value) => {
+        if (error) {
+          void asyncStream.callback(error, undefined);
+          void callback?.(error, undefined);
+          return;
+        }
+
         const decodedMessage = value
           ? new DecodedMessage(this.#client, value)
           : undefined;
-        void asyncStream.callback(error, decodedMessage);
-        void callback?.(error, decodedMessage);
+        void asyncStream.callback(null, decodedMessage);
+        void callback?.(null, decodedMessage);
       },
     );
     await this.#client.sendMessage("streamGroupMessages", {