@xmtp/browser-sdk 5.2.0 → 6.0.0

package/src/DecodedMessage.ts

@@ -1,89 +1,186 @@
-import type { ContentTypeId } from "@xmtp/content-type-primitives";
-import { DeliveryStatus, GroupMessageKind } from "@xmtp/wasm-bindings";
-import type { Client } from "@/Client";
-import { fromSafeContentTypeId, type SafeMessage } from "@/utils/conversions";
+import {
+  contentTypeToString,
+  type EncodedContent,
+} from "@xmtp/content-type-primitives";
+import type {
+  ContentTypeId,
+  DecodedMessageContent,
+  DeliveryStatus,
+  GroupMessageKind,
+  Reaction,
+  DecodedMessage as XmtpDecodedMessage,
+} from "@xmtp/wasm-bindings";
+import type { CodecRegistry } from "@/CodecRegistry";
+import { nsToDate } from "@/utils/date";
 
-export type MessageKind = "application" | "membership_change";
-export type MessageDeliveryStatus = "unpublished" | "published" | "failed";
+const getContentFromDecodedMessageContent = <T = unknown>(
+  content: DecodedMessageContent,
+): T => {
+  switch (content.type) {
+    case "text": {
+      return content.content as T;
+    }
+    case "markdown": {
+      return content.content as T;
+    }
+    case "reply": {
+      return content.content as T;
+    }
+    case "reaction": {
+      return content.content as T;
+    }
+    case "attachment": {
+      return content.content as T;
+    }
+    case "remoteAttachment": {
+      return content.content as T;
+    }
+    case "multiRemoteAttachment": {
+      return content.content as T;
+    }
+    case "transactionReference": {
+      return content.content as T;
+    }
+    case "groupUpdated": {
+      return content.content as T;
+    }
+    case "readReceipt": {
+      return content.content as T;
+    }
+    case "leaveRequest": {
+      return content.content as T;
+    }
+    case "walletSendCalls": {
+      return content.content as T;
+    }
+    case "intent": {
+      return content.content as T;
+    }
+    case "actions": {
+      return content.content as T;
+    }
+    case "custom": {
+      return content.content as T;
+    }
+    default:
+      content satisfies never;
+      return null as T;
+  }
+};
 
 /**
  * Represents a decoded XMTP message
  *
- * This class transforms network messages into a structured format with
- * content decoding.
- *
  * @class
- * @property {any} content - The decoded content of the message
+ * @property {unknown} content - The decoded content of the message
  * @property {ContentTypeId} contentType - The content type of the message content
  * @property {string} conversationId - Unique identifier for the conversation
- * @property {MessageDeliveryStatus} deliveryStatus - Current delivery status of the message ("unpublished" | "published" | "failed")
- * @property {string} [fallback] - Optional fallback text for the message
- * @property {number} [compression] - Optional compression level applied to the message
+ * @property {DeliveryStatus} deliveryStatus - Current delivery status of the message ("unpublished" | "published" | "failed")
+ * @property {bigint} expiresAtNs - Timestamp when the message will expire (in nanoseconds)
+ * @property {Date} expiresAt - Timestamp when the message will expire
+ * @property {string} fallback - Optional fallback text for the message
  * @property {string} id - Unique identifier for the message
- * @property {MessageKind} kind - Type of message ("application" | "membership_change")
- * @property {Map<string, string>} parameters - Additional parameters associated with the message
- * @property {SafeMessage["content"]} encodedContent - Raw encoded content of the message
+ * @property {GroupMessageKind} kind - Type of message ("application" | "membership_change")
+ * @property {bigint} numReplies - Number of replies to the message
+ * @property {DecodedMessage<Reaction>[]} reactions - Reactions to the message
  * @property {string} senderInboxId - Identifier for the sender's inbox
+ * @property {Date} sentAt - Timestamp when the message was sent
  * @property {bigint} sentAtNs - Timestamp when the message was sent (in nanoseconds)
  */
 export class DecodedMessage<ContentTypes = unknown> {
-  #client: Client<ContentTypes>;
   content: ContentTypes | undefined;
   contentType: ContentTypeId;
   conversationId: string;
-  deliveryStatus: MessageDeliveryStatus;
+  deliveryStatus: DeliveryStatus;
+  expiresAtNs?: bigint;
+  expiresAt?: Date;
   fallback?: string;
-  compression?: number;
   id: string;
-  kind: MessageKind;
-  parameters: Map<string, string>;
-  encodedContent: SafeMessage["content"];
+  kind: GroupMessageKind;
+  numReplies: bigint;
+  reactions: DecodedMessage<Reaction>[];
   senderInboxId: string;
+  sentAt: Date;
   sentAtNs: bigint;
 
-  constructor(client: Client<ContentTypes>, message: SafeMessage) {
-    this.#client = client;
+  constructor(codecRegistry: CodecRegistry, message: XmtpDecodedMessage) {
     this.id = message.id;
+    this.expiresAtNs = message.expiresAtNs;
+    this.expiresAt = message.expiresAtNs
+      ? nsToDate(message.expiresAtNs)
+      : undefined;
     this.sentAtNs = message.sentAtNs;
-    this.conversationId = message.convoId;
+    this.sentAt = nsToDate(message.sentAtNs);
+    this.conversationId = message.conversationId;
     this.senderInboxId = message.senderInboxId;
-    this.encodedContent = message.content;
+    this.contentType = message.contentType;
+    this.fallback = message.fallback ?? undefined;
 
-    switch (message.kind) {
-      case GroupMessageKind.Application:
-        this.kind = "application";
-        break;
-      case GroupMessageKind.MembershipChange:
-        this.kind = "membership_change";
-        break;
-      // no default
-    }
+    this.kind = message.kind;
+    this.deliveryStatus = message.deliveryStatus;
 
-    switch (message.deliveryStatus) {
-      case DeliveryStatus.Unpublished:
-        this.deliveryStatus = "unpublished";
-        break;
-      case DeliveryStatus.Published:
-        this.deliveryStatus = "published";
-        break;
-      case DeliveryStatus.Failed:
-        this.deliveryStatus = "failed";
-        break;
-      // no default
-    }
+    this.numReplies = message.numReplies;
+    this.reactions = message.reactions.map(
+      (reaction) => new DecodedMessage<Reaction>(codecRegistry, reaction),
+    );
 
-    this.contentType = fromSafeContentTypeId(message.content.type);
-    this.parameters = new Map(Object.entries(message.content.parameters));
-    this.fallback = message.content.fallback;
-    this.compression = message.content.compression;
+    this.content =
+      getContentFromDecodedMessageContent<ContentTypes>(message.content) ??
+      undefined;
 
-    try {
-      this.content = this.#client.decodeContent<ContentTypes>(
-        message,
-        this.contentType,
-      );
-    } catch {
-      this.content = undefined;
+    switch (message.content.type) {
+      case "reply": {
+        const reply = message.content.content;
+        let replyContent = getContentFromDecodedMessageContent<ContentTypes>(
+          reply.content,
+        );
+        if (reply.content.type === "custom") {
+          const codec = codecRegistry.getCodec<ContentTypes>(
+            reply.content.content.type as ContentTypeId,
+          );
+          if (codec) {
+            try {
+              replyContent = codec.decode(replyContent as EncodedContent);
+            } catch (error) {
+              if (error instanceof Error) {
+                console.warn(`Error decoding custom content: ${error.message}`);
+              } else {
+                console.warn(`Error decoding custom content`);
+              }
+            }
+          }
+        }
+        this.content = {
+          referenceId: reply.referenceId,
+          content: replyContent,
+          inReplyTo: reply.inReplyTo
+            ? new DecodedMessage<ContentTypes>(codecRegistry, reply.inReplyTo)
+            : null,
+        } as ContentTypes;
+        break;
+      }
+      case "custom": {
+        const encodedContent = message.content.content;
+        const codec = codecRegistry.getCodec<ContentTypes>(this.contentType);
+        if (codec) {
+          try {
+            this.content = codec.decode(encodedContent);
+          } catch (error) {
+            if (error instanceof Error) {
+              console.warn(`Error decoding custom content: ${error.message}`);
+            } else {
+              console.warn(`Error decoding custom content`);
+            }
+            this.content = undefined;
+          }
+        } else {
+          console.warn(
+            `No codec found for content type "${contentTypeToString(this.contentType)}"`,
+          );
+          this.content = undefined;
+        }
+        break;
+      }
     }
   }
 }

package/src/Dm.ts

@@ -1,6 +1,8 @@
-import type { Client } from "@/Client";
+import type { CodecRegistry } from "@/CodecRegistry";
 import { Conversation } from "@/Conversation";
+import type { ClientWorkerAction } from "@/types/actions";
 import type { SafeConversation } from "@/utils/conversions";
+import type { WorkerBridge } from "@/utils/WorkerBridge";
 
 /**
  * Represents a direct message conversation between two inboxes
@@ -8,23 +10,27 @@ import type { SafeConversation } from "@/utils/conversions";
  * This class is not intended to be initialized directly.
  */
 export class Dm<ContentTypes = unknown> extends Conversation<ContentTypes> {
-  #client: Client<ContentTypes>;
+  #codecRegistry: CodecRegistry;
+  #worker: WorkerBridge<ClientWorkerAction>;
   #id: string;
 
   /**
    * Creates a new direct message conversation instance
    *
-   * @param client - The client instance managing this direct message conversation
+   * @param worker - The worker bridge instance for client communication
+   * @param codecRegistry - The codec registry instance
    * @param id - Identifier for the direct message conversation
    * @param data - Optional conversation data to initialize with
    */
   constructor(
-    client: Client<ContentTypes>,
+    worker: WorkerBridge<ClientWorkerAction>,
+    codecRegistry: CodecRegistry,
     id: string,
     data?: SafeConversation,
   ) {
-    super(client, id, data);
-    this.#client = client;
+    super(worker, codecRegistry, id, data);
+    this.#worker = worker;
+    this.#codecRegistry = codecRegistry;
     this.#id = id;
   }
 
@@ -34,14 +40,24 @@ export class Dm<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @returns Promise that resolves with the peer's inbox ID
    */
   async peerInboxId() {
-    return this.#client.sendMessage("dm.peerInboxId", {
+    return this.#worker.action("dm.peerInboxId", {
       id: this.#id,
     });
   }
 
-  async getDuplicateDms() {
-    return this.#client.sendMessage("dm.getDuplicateDms", {
+  async duplicateDms() {
+    const conversations = await this.#worker.action("dm.duplicateDms", {
       id: this.#id,
     });
+
+    return conversations.map(
+      (conversation) =>
+        new Dm<ContentTypes>(
+          this.#worker,
+          this.#codecRegistry,
+          conversation.id,
+          conversation,
+        ),
+    );
   }
 }

package/src/Group.ts

@@ -4,9 +4,11 @@ import type {
   PermissionPolicy,
   PermissionUpdateType,
 } from "@xmtp/wasm-bindings";
-import type { Client } from "@/Client";
+import type { CodecRegistry } from "@/CodecRegistry";
 import { Conversation } from "@/Conversation";
+import type { ClientWorkerAction } from "@/types/actions";
 import type { SafeConversation } from "@/utils/conversions";
+import type { WorkerBridge } from "@/utils/WorkerBridge";
 
 /**
  * Represents a group conversation between multiple inboxes
@@ -15,7 +17,8 @@ import type { SafeConversation } from "@/utils/conversions";
  */
 export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
   #admins: SafeConversation["admins"] = [];
-  #client: Client<ContentTypes>;
+  #appData?: SafeConversation["appData"];
+  #worker: WorkerBridge<ClientWorkerAction>;
   #description?: SafeConversation["description"];
   #id: string;
   #imageUrl?: SafeConversation["imageUrl"];
@@ -26,6 +29,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
     this.#name = data?.name ?? "";
     this.#imageUrl = data?.imageUrl ?? "";
     this.#description = data?.description ?? "";
+    this.#appData = data?.appData ?? "";
     this.#admins = data?.admins ?? [];
     this.#superAdmins = data?.superAdmins ?? [];
   }
@@ -33,17 +37,19 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
   /**
    * Creates a new group conversation instance
    *
-   * @param client - The client instance managing this group conversation
+   * @param worker - The worker bridge instance for client communication
+   * @param codecRegistry - The codec registry instance
    * @param id - Identifier for the group conversation
    * @param data - Optional conversation data to initialize with
    */
   constructor(
-    client: Client<ContentTypes>,
+    worker: WorkerBridge<ClientWorkerAction>,
+    codecRegistry: CodecRegistry,
     id: string,
     data?: SafeConversation,
   ) {
-    super(client, id, data);
-    this.#client = client;
+    super(worker, codecRegistry, id, data);
+    this.#worker = worker;
     this.#id = id;
     this.#syncData(data);
   }
@@ -72,7 +78,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param name The new name for the group
    */
   async updateName(name: string) {
-    await this.#client.sendMessage("group.updateName", {
+    await this.#worker.action("group.updateName", {
       id: this.#id,
       name,
     });
@@ -92,7 +98,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param imageUrl The new image URL for the group
    */
   async updateImageUrl(imageUrl: string) {
-    await this.#client.sendMessage("group.updateImageUrl", {
+    await this.#worker.action("group.updateImageUrl", {
       id: this.#id,
       imageUrl,
     });
@@ -112,13 +118,33 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param description The new description for the group
    */
   async updateDescription(description: string) {
-    await this.#client.sendMessage("group.updateDescription", {
+    await this.#worker.action("group.updateDescription", {
       id: this.#id,
       description,
     });
     this.#description = description;
   }
 
+  /**
+   * The app data of the group
+   */
+  get appData() {
+    return this.#appData;
+  }
+
+  /**
+   * Updates the group's app data (max 8192 bytes)
+   *
+   * @param appData The new app data for the group
+   */
+  async updateAppData(appData: string) {
+    await this.#worker.action("group.updateAppData", {
+      id: this.#id,
+      appData,
+    });
+    this.#appData = appData;
+  }
+
   /**
    * The list of admins of the group by inbox ID
    */
@@ -139,7 +165,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @returns Array of admin inbox IDs
    */
   async listAdmins() {
-    const admins = await this.#client.sendMessage("group.listAdmins", {
+    const admins = await this.#worker.action("group.listAdmins", {
       id: this.#id,
     });
     this.#admins = admins;
@@ -152,12 +178,9 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @returns Array of super admin inbox IDs
    */
   async listSuperAdmins() {
-    const superAdmins = await this.#client.sendMessage(
-      "group.listSuperAdmins",
-      {
-        id: this.#id,
-      },
-    );
+    const superAdmins = await this.#worker.action("group.listSuperAdmins", {
+      id: this.#id,
+    });
     this.#superAdmins = superAdmins;
     return superAdmins;
   }
@@ -168,7 +191,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @returns The group's permissions
    */
   async permissions() {
-    return this.#client.sendMessage("group.permissions", {
+    return this.#worker.action("group.permissions", {
       id: this.#id,
     });
   }
@@ -185,7 +208,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
     policy: PermissionPolicy,
     metadataField?: MetadataField,
   ) {
-    return this.#client.sendMessage("group.updatePermission", {
+    return this.#worker.action("group.updatePermission", {
       id: this.#id,
       permissionType,
       policy,
@@ -221,7 +244,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param identifiers Array of member identifiers to add
    */
   async addMembersByIdentifiers(identifiers: Identifier[]) {
-    return this.#client.sendMessage("group.addMembersByIdentifiers", {
+    return this.#worker.action("group.addMembersByIdentifiers", {
       id: this.#id,
       identifiers,
     });
@@ -233,7 +256,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param inboxIds Array of inbox IDs to add
    */
   async addMembers(inboxIds: string[]) {
-    return this.#client.sendMessage("group.addMembers", {
+    return this.#worker.action("group.addMembers", {
       id: this.#id,
       inboxIds,
     });
@@ -245,7 +268,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param identifiers Array of member identifiers to remove
    */
   async removeMembersByIdentifiers(identifiers: Identifier[]) {
-    return this.#client.sendMessage("group.removeMembersByIdentifiers", {
+    return this.#worker.action("group.removeMembersByIdentifiers", {
       id: this.#id,
       identifiers,
     });
@@ -257,7 +280,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param inboxIds Array of inbox IDs to remove
    */
   async removeMembers(inboxIds: string[]) {
-    return this.#client.sendMessage("group.removeMembers", {
+    return this.#worker.action("group.removeMembers", {
       id: this.#id,
       inboxIds,
     });
@@ -269,7 +292,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param inboxId The inbox ID of the member to promote
    */
   async addAdmin(inboxId: string) {
-    return this.#client.sendMessage("group.addAdmin", {
+    return this.#worker.action("group.addAdmin", {
       id: this.#id,
       inboxId,
     });
@@ -281,7 +304,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param inboxId The inbox ID of the admin to demote
    */
   async removeAdmin(inboxId: string) {
-    return this.#client.sendMessage("group.removeAdmin", {
+    return this.#worker.action("group.removeAdmin", {
       id: this.#id,
       inboxId,
     });
@@ -293,7 +316,7 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param inboxId The inbox ID of the member to promote
    */
   async addSuperAdmin(inboxId: string) {
-    return this.#client.sendMessage("group.addSuperAdmin", {
+    return this.#worker.action("group.addSuperAdmin", {
       id: this.#id,
       inboxId,
     });
@@ -305,9 +328,29 @@ export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
    * @param inboxId The inbox ID of the super admin to demote
    */
   async removeSuperAdmin(inboxId: string) {
-    return this.#client.sendMessage("group.removeSuperAdmin", {
+    return this.#worker.action("group.removeSuperAdmin", {
       id: this.#id,
       inboxId,
     });
   }
+
+  /**
+   * Request to leave the group
+   */
+  async requestRemoval() {
+    return this.#worker.action("group.requestRemoval", {
+      id: this.#id,
+    });
+  }
+
+  /**
+   * Checks if the current user has requested to leave the group
+   *
+   * @returns Boolean
+   */
+  async isPendingRemoval() {
+    return this.#worker.action("group.isPendingRemoval", {
+      id: this.#id,
+    });
+  }
 }

package/src/Opfs.ts

@@ -0,0 +1,63 @@
+import type { OpfsAction } from "@/types/actions/opfs";
+import { WorkerBridge } from "@/utils/WorkerBridge";
+
+export class Opfs {
+  #worker: WorkerBridge<OpfsAction>;
+  #enableLogging: boolean;
+
+  constructor(enableLogging?: boolean) {
+    const worker = new Worker(new URL("./workers/opfs", import.meta.url), {
+      type: "module",
+    });
+    this.#worker = new WorkerBridge<OpfsAction>(worker, enableLogging);
+    this.#enableLogging = enableLogging ?? false;
+  }
+
+  async init() {
+    await this.#worker.action("opfs.init", {
+      enableLogging: this.#enableLogging,
+    });
+  }
+
+  close() {
+    this.#worker.close();
+  }
+
+  static async create(enableLogging?: boolean) {
+    const opfs = new Opfs(enableLogging);
+    await opfs.init();
+    return opfs;
+  }
+
+  async listFiles() {
+    return this.#worker.action("opfs.listFiles");
+  }
+
+  async fileCount() {
+    return this.#worker.action("opfs.fileCount");
+  }
+
+  async poolCapacity() {
+    return this.#worker.action("opfs.poolCapacity");
+  }
+
+  async fileExists(path: string) {
+    return this.#worker.action("opfs.fileExists", { path });
+  }
+
+  async deleteFile(path: string) {
+    return this.#worker.action("opfs.deleteFile", { path });
+  }
+
+  async exportDb(path: string) {
+    return this.#worker.action("opfs.exportDb", { path });
+  }
+
+  async importDb(path: string, data: Uint8Array) {
+    return this.#worker.action("opfs.importDb", { path, data });
+  }
+
+  async clearAll() {
+    return this.#worker.action("opfs.clearAll");
+  }
+}