@xmtp/browser-sdk 2.0.12 → 2.1.0

package/src/Conversation.ts

@@ -18,9 +18,9 @@ import { MissingContentTypeError } from "@/utils/errors";
  *
  * This class is not intended to be initialized directly.
  */
-export class Conversation {
+export class Conversation<ContentTypes = unknown> {
   #addedByInboxId?: SafeConversation["addedByInboxId"];
-  #client: Client;
+  #client: Client<ContentTypes>;
   #createdAtNs?: SafeConversation["createdAtNs"];
   #id: string;
   #isActive?: SafeConversation["isActive"];
@@ -33,7 +33,11 @@ export class Conversation {
    * @param id - The unique identifier for this conversation
    * @param data - Optional conversation data to initialize with
    */
-  constructor(client: Client, id: string, data?: SafeConversation) {
+  constructor(
+    client: Client<ContentTypes>,
+    id: string,
+    data?: SafeConversation,
+  ) {
     this.#client = client;
     this.#id = id;
     this.#syncData(data);
@@ -76,7 +80,7 @@ export class Conversation {
    * @returns Promise that resolves with the conversation members
    */
   async members() {
-    return this.#client.sendMessage("getGroupMembers", {
+    return this.#client.sendMessage("conversation.members", {
       id: this.#id,
     });
   }
@@ -87,7 +91,7 @@ export class Conversation {
    * @returns Promise that resolves with the updated conversation data
    */
   async sync() {
-    const data = await this.#client.sendMessage("syncGroup", {
+    const data = await this.#client.sendMessage("conversation.sync", {
       id: this.#id,
     });
     this.#syncData(data);
@@ -100,7 +104,7 @@ export class Conversation {
    * @returns Promise that resolves when publishing is complete
    */
   async publishMessages() {
-    return this.#client.sendMessage("publishGroupMessages", {
+    return this.#client.sendMessage("conversation.publishMessages", {
       id: this.#id,
     });
   }
@@ -113,7 +117,7 @@ export class Conversation {
    * @returns Promise that resolves with the message ID
    * @throws {MissingContentTypeError} if content type is required but not provided
    */
-  async sendOptimistic(content: unknown, contentType?: ContentTypeId) {
+  async sendOptimistic(content: ContentTypes, contentType?: ContentTypeId) {
     if (typeof content !== "string" && !contentType) {
       throw new MissingContentTypeError();
     }
@@ -124,7 +128,7 @@ export class Conversation {
         : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           this.#client.encodeContent(content, contentType!);
 
-    return this.#client.sendMessage("sendOptimisticGroupMessage", {
+    return this.#client.sendMessage("conversation.sendOptimistic", {
       id: this.#id,
       content: safeEncodedContent,
     });
@@ -138,7 +142,7 @@ export class Conversation {
    * @returns Promise that resolves with the message ID after it has been sent
    * @throws {MissingContentTypeError} if content type is required but not provided
    */
-  async send(content: unknown, contentType?: ContentTypeId) {
+  async send(content: ContentTypes, contentType?: ContentTypeId) {
     if (typeof content !== "string" && !contentType) {
       throw new MissingContentTypeError();
     }
@@ -149,7 +153,7 @@ export class Conversation {
         : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           this.#client.encodeContent(content, contentType!);
 
-    return this.#client.sendMessage("sendGroupMessage", {
+    return this.#client.sendMessage("conversation.send", {
       id: this.#id,
       content: safeEncodedContent,
     });
@@ -162,7 +166,7 @@ export class Conversation {
    * @returns Promise that resolves with an array of decoded messages
    */
   async messages(options?: SafeListMessagesOptions) {
-    const messages = await this.#client.sendMessage("getGroupMessages", {
+    const messages = await this.#client.sendMessage("conversation.messages", {
       id: this.#id,
       options,
     });
@@ -176,7 +180,7 @@ export class Conversation {
    * @returns Promise that resolves with the current consent state
    */
   async consentState() {
-    return this.#client.sendMessage("getGroupConsentState", {
+    return this.#client.sendMessage("conversation.consentState", {
       id: this.#id,
     });
   }
@@ -188,7 +192,7 @@ export class Conversation {
    * @returns Promise that resolves when the update is complete
    */
   async updateConsentState(state: ConsentState) {
-    return this.#client.sendMessage("updateGroupConsentState", {
+    return this.#client.sendMessage("conversation.updateConsentState", {
       id: this.#id,
       state,
     });
@@ -200,9 +204,12 @@ export class Conversation {
    * @returns Promise that resolves with the current message disappearing settings
    */
   async messageDisappearingSettings() {
-    return this.#client.sendMessage("getGroupMessageDisappearingSettings", {
-      id: this.#id,
-    });
+    return this.#client.sendMessage(
+      "conversation.messageDisappearingSettings",
+      {
+        id: this.#id,
+      },
+    );
   }
 
   /**
@@ -213,11 +220,14 @@ export class Conversation {
    * @returns Promise that resolves when the update is complete
    */
   async updateMessageDisappearingSettings(fromNs: bigint, inNs: bigint) {
-    return this.#client.sendMessage("updateGroupMessageDisappearingSettings", {
-      id: this.#id,
-      fromNs,
-      inNs,
-    });
+    return this.#client.sendMessage(
+      "conversation.updateMessageDisappearingSettings",
+      {
+        id: this.#id,
+        fromNs,
+        inNs,
+      },
+    );
   }
 
   /**
@@ -226,9 +236,12 @@ export class Conversation {
    * @returns Promise that resolves when the settings are removed
    */
   async removeMessageDisappearingSettings() {
-    return this.#client.sendMessage("removeGroupMessageDisappearingSettings", {
-      id: this.#id,
-    });
+    return this.#client.sendMessage(
+      "conversation.removeMessageDisappearingSettings",
+      {
+        id: this.#id,
+      },
+    );
   }
 
   /**
@@ -237,9 +250,12 @@ export class Conversation {
    * @returns Promise that resolves with whether message disappearing is enabled
    */
   async isMessageDisappearingEnabled() {
-    return this.#client.sendMessage("isGroupMessageDisappearingEnabled", {
-      id: this.#id,
-    });
+    return this.#client.sendMessage(
+      "conversation.isMessageDisappearingEnabled",
+      {
+        id: this.#id,
+      },
+    );
   }
 
   /**
@@ -248,14 +264,14 @@ export class Conversation {
    * @param callback - Optional callback function for handling new stream values
    * @returns Stream instance for new messages
    */
-  async stream(callback?: StreamCallback<DecodedMessage>) {
+  async stream(callback?: StreamCallback<DecodedMessage<ContentTypes>>) {
     const streamId = v4();
-    const asyncStream = new AsyncStream<DecodedMessage>();
+    const asyncStream = new AsyncStream<DecodedMessage<ContentTypes>>();
     const endStream = this.#client.handleStreamMessage<SafeMessage>(
       streamId,
       (error, value) => {
         let err: Error | null = error;
-        let message: DecodedMessage | undefined;
+        let message: DecodedMessage<ContentTypes> | undefined;
 
         if (value) {
           try {
@@ -269,7 +285,7 @@ export class Conversation {
         void callback?.(err, message);
       },
     );
-    await this.#client.sendMessage("streamGroupMessages", {
+    await this.#client.sendMessage("conversation.stream", {
       groupId: this.#id,
       streamId,
     });
@@ -283,7 +299,7 @@ export class Conversation {
   }
 
   async pausedForVersion() {
-    return this.#client.sendMessage("getGroupPausedForVersion", {
+    return this.#client.sendMessage("conversation.pausedForVersion", {
       id: this.#id,
     });
   }
@@ -294,7 +310,18 @@ export class Conversation {
    * @returns Promise that resolves with the HMAC keys
    */
   async getHmacKeys() {
-    return this.#client.sendMessage("getGroupHmacKeys", {
+    return this.#client.sendMessage("conversation.getHmacKeys", {
+      id: this.#id,
+    });
+  }
+
+  /**
+   * Retrieves information for this conversation to help with debugging
+   *
+   * @returns The debug information for this conversation
+   */
+  async debugInfo() {
+    return this.#client.sendMessage("conversation.debugInfo", {
       id: this.#id,
     });
   }

package/src/Conversations.ts

@@ -22,15 +22,15 @@ import type {
  *
  * This class is not intended to be initialized directly.
  */
-export class Conversations {
-  #client: Client;
+export class Conversations<ContentTypes = unknown> {
+  #client: Client<ContentTypes>;
 
   /**
    * Creates a new conversations instance
    *
    * @param client - The client instance managing the conversations
    */
-  constructor(client: Client) {
+  constructor(client: Client<ContentTypes>) {
     this.#client = client;
   }
 
@@ -40,7 +40,7 @@ export class Conversations {
    * @returns Promise that resolves when sync is complete
    */
   async sync() {
-    return this.#client.sendMessage("syncConversations", undefined);
+    return this.#client.sendMessage("conversations.sync", undefined);
   }
 
   /**
@@ -52,7 +52,7 @@ export class Conversations {
    * @returns Promise that resolves when sync is complete
    */
   async syncAll(consentStates?: ConsentState[]) {
-    return this.#client.sendMessage("syncAllConversations", {
+    return this.#client.sendMessage("conversations.syncAll", {
       consentStates,
     });
   }
@@ -64,9 +64,12 @@ export class Conversations {
    * @returns Promise that resolves with the conversation, if found
    */
   async getConversationById(id: string) {
-    const data = await this.#client.sendMessage("getConversationById", {
-      id,
-    });
+    const data = await this.#client.sendMessage(
+      "conversations.getConversationById",
+      {
+        id,
+      },
+    );
     if (data) {
       return data.metadata.conversationType === "group"
         ? new Group(this.#client, data.id, data)
@@ -81,11 +84,14 @@ export class Conversations {
    * @param id - The message ID to look up
    * @returns Promise that resolves with the decoded message, if found
    */
-  async getMessageById<T = unknown>(id: string) {
-    const data = await this.#client.sendMessage("getMessageById", {
-      id,
-    });
-    return data ? new DecodedMessage<T>(this.#client, data) : undefined;
+  async getMessageById(id: string) {
+    const data = await this.#client.sendMessage(
+      "conversations.getMessageById",
+      {
+        id,
+      },
+    );
+    return data ? new DecodedMessage(this.#client, data) : undefined;
   }
 
   /**
@@ -95,9 +101,12 @@ export class Conversations {
    * @returns Promise that resolves with the DM, if found
    */
   async getDmByInboxId(inboxId: string) {
-    const data = await this.#client.sendMessage("getDmByInboxId", {
-      inboxId,
-    });
+    const data = await this.#client.sendMessage(
+      "conversations.getDmByInboxId",
+      {
+        inboxId,
+      },
+    );
     return data ? new Dm(this.#client, data.id, data) : undefined;
   }
 
@@ -108,7 +117,7 @@ export class Conversations {
    * @returns Promise that resolves with an array of conversations
    */
   async list(options?: SafeListConversationsOptions) {
-    const conversations = await this.#client.sendMessage("getConversations", {
+    const conversations = await this.#client.sendMessage("conversations.list", {
       options,
     });
 
@@ -135,9 +144,12 @@ export class Conversations {
   async listGroups(
     options?: Omit<SafeListConversationsOptions, "conversation_type">,
   ) {
-    const conversations = await this.#client.sendMessage("getGroups", {
-      options,
-    });
+    const conversations = await this.#client.sendMessage(
+      "conversations.listGroups",
+      {
+        options,
+      },
+    );
 
     return conversations.map(
       (conversation) => new Group(this.#client, conversation.id, conversation),
@@ -153,15 +165,35 @@ export class Conversations {
   async listDms(
     options?: Omit<SafeListConversationsOptions, "conversation_type">,
   ) {
-    const conversations = await this.#client.sendMessage("getDms", {
-      options,
-    });
+    const conversations = await this.#client.sendMessage(
+      "conversations.listDms",
+      {
+        options,
+      },
+    );
 
     return conversations.map(
       (conversation) => new Dm(this.#client, conversation.id, conversation),
     );
   }
 
+  /**
+   * Creates a new group without syncing to the network
+   *
+   * @param options - Optional group creation options
+   * @returns Promise that resolves with the new group
+   */
+  async newGroupOptimistic(options?: SafeCreateGroupOptions) {
+    const conversation = await this.#client.sendMessage(
+      "conversations.newGroupOptimistic",
+      {
+        options,
+      },
+    );
+
+    return new Group(this.#client, conversation.id, conversation);
+  }
+
   /**
    * Creates a new group conversation with the specified identifiers
    *
@@ -174,7 +206,7 @@ export class Conversations {
     options?: SafeCreateGroupOptions,
   ) {
     const conversation = await this.#client.sendMessage(
-      "newGroupWithIdentifiers",
+      "conversations.newGroupWithIdentifiers",
       {
         identifiers,
         options,
@@ -193,7 +225,7 @@ export class Conversations {
    */
   async newGroup(inboxIds: string[], options?: SafeCreateGroupOptions) {
     const conversation = await this.#client.sendMessage(
-      "newGroupWithInboxIds",
+      "conversations.newGroup",
       {
         inboxIds,
         options,
@@ -214,10 +246,13 @@ export class Conversations {
     identifier: Identifier,
     options?: SafeCreateDmOptions,
   ) {
-    const conversation = await this.#client.sendMessage("newDmWithIdentifier", {
-      identifier,
-      options,
-    });
+    const conversation = await this.#client.sendMessage(
+      "conversations.newDmWithIdentifier",
+      {
+        identifier,
+        options,
+      },
+    );
 
     return new Dm(this.#client, conversation.id, conversation);
   }
@@ -230,7 +265,7 @@ export class Conversations {
    * @returns Promise that resolves with the new DM
    */
   async newDm(inboxId: string, options?: SafeCreateDmOptions) {
-    const conversation = await this.#client.sendMessage("newDmWithInboxId", {
+    const conversation = await this.#client.sendMessage("conversations.newDm", {
       inboxId,
       options,
     });
@@ -244,7 +279,7 @@ export class Conversations {
    * @returns Promise that resolves with the HMAC keys for all conversations
    */
   async getHmacKeys() {
-    return this.#client.sendMessage("getHmacKeys", undefined);
+    return this.#client.sendMessage("conversations.getHmacKeys", undefined);
   }
 
   /**
@@ -254,10 +289,11 @@ export class Conversations {
    * @param conversationType - Optional type to filter conversations
    * @returns Stream instance for new conversations
    */
-  async stream<T extends Group | Dm = Group | Dm>(
-    callback?: StreamCallback<T>,
-    conversationType?: ConversationType,
-  ) {
+  async stream<
+    T extends Group<ContentTypes> | Dm<ContentTypes> =
+      | Group<ContentTypes>
+      | Dm<ContentTypes>,
+  >(callback?: StreamCallback<T>, conversationType?: ConversationType) {
     const streamId = v4();
     const asyncStream = new AsyncStream<T>();
     const endStream = this.#client.handleStreamMessage<SafeConversation>(
@@ -281,7 +317,7 @@ export class Conversations {
         void callback?.(err, streamValue);
       },
     );
-    await this.#client.sendMessage("streamAllGroups", {
+    await this.#client.sendMessage("conversations.stream", {
       streamId,
       conversationType,
     });
@@ -300,8 +336,8 @@ export class Conversations {
    * @param callback - Optional callback function for handling new stream value
    * @returns Stream instance for new group conversations
    */
-  async streamGroups(callback?: StreamCallback<Group>) {
-    return this.stream<Group>(callback, ConversationType.Group);
+  async streamGroups(callback?: StreamCallback<Group<ContentTypes>>) {
+    return this.stream(callback, ConversationType.Group);
   }
 
   /**
@@ -310,8 +346,8 @@ export class Conversations {
    * @param callback - Optional callback function for handling new stream value
    * @returns Stream instance for new DM conversations
    */
-  async streamDms(callback?: StreamCallback<Dm>) {
-    return this.stream<Dm>(callback, ConversationType.Dm);
+  async streamDms(callback?: StreamCallback<Dm<ContentTypes>>) {
+    return this.stream(callback, ConversationType.Dm);
   }
 
   /**
@@ -322,16 +358,17 @@ export class Conversations {
    * @returns Stream instance for new messages
    */
   async streamAllMessages(
-    callback?: StreamCallback<DecodedMessage>,
+    callback?: StreamCallback<DecodedMessage<ContentTypes>>,
     conversationType?: ConversationType,
+    consentStates?: ConsentState[],
   ) {
     const streamId = v4();
-    const asyncStream = new AsyncStream<DecodedMessage>();
+    const asyncStream = new AsyncStream<DecodedMessage<ContentTypes>>();
     const endStream = this.#client.handleStreamMessage<SafeMessage>(
       streamId,
       (error, value) => {
         let err: Error | null = error;
-        let message: DecodedMessage | undefined;
+        let message: DecodedMessage<ContentTypes> | undefined;
 
         if (value) {
           try {
@@ -345,9 +382,10 @@ export class Conversations {
         void callback?.(err, message);
       },
     );
-    await this.#client.sendMessage("streamAllMessages", {
+    await this.#client.sendMessage("conversations.streamAllMessages", {
       streamId,
       conversationType,
+      consentStates,
     });
     asyncStream.onReturn = () => {
       void this.#client.sendMessage("endStream", {
@@ -364,8 +402,15 @@ export class Conversations {
    * @param callback - Optional callback function for handling new stream value
    * @returns Stream instance for new group messages
    */
-  async streamAllGroupMessages(callback?: StreamCallback<DecodedMessage>) {
-    return this.streamAllMessages(callback, ConversationType.Group);
+  async streamAllGroupMessages(
+    callback?: StreamCallback<DecodedMessage<ContentTypes>>,
+    consentStates?: ConsentState[],
+  ) {
+    return this.streamAllMessages(
+      callback,
+      ConversationType.Group,
+      consentStates,
+    );
   }
 
   /**
@@ -374,7 +419,10 @@ export class Conversations {
    * @param callback - Optional callback function for handling new stream value
    * @returns Stream instance for new DM messages
    */
-  async streamAllDmMessages(callback?: StreamCallback<DecodedMessage>) {
-    return this.streamAllMessages(callback, ConversationType.Dm);
+  async streamAllDmMessages(
+    callback?: StreamCallback<DecodedMessage<ContentTypes>>,
+    consentStates?: ConsentState[],
+  ) {
+    return this.streamAllMessages(callback, ConversationType.Dm, consentStates);
   }
 }

package/src/DecodedMessage.ts

@@ -26,9 +26,9 @@ export type MessageDeliveryStatus = "unpublished" | "published" | "failed";
  * @property {string} senderInboxId - Identifier for the sender's inbox
  * @property {bigint} sentAtNs - Timestamp when the message was sent (in nanoseconds)
  */
-export class DecodedMessage<T = unknown> {
-  #client: Client;
-  content: T | undefined;
+export class DecodedMessage<ContentTypes = unknown> {
+  #client: Client<ContentTypes>;
+  content: ContentTypes | undefined;
   contentType: ContentTypeId;
   conversationId: string;
   deliveryStatus: MessageDeliveryStatus;
@@ -41,7 +41,7 @@ export class DecodedMessage<T = unknown> {
   senderInboxId: string;
   sentAtNs: bigint;
 
-  constructor(client: Client, message: SafeMessage) {
+  constructor(client: Client<ContentTypes>, message: SafeMessage) {
     this.#client = client;
     this.id = message.id;
     this.sentAtNs = message.sentAtNs;
@@ -78,7 +78,10 @@ export class DecodedMessage<T = unknown> {
     this.compression = message.content.compression;
 
     try {
-      this.content = this.#client.decodeContent<T>(message, this.contentType);
+      this.content = this.#client.decodeContent<ContentTypes>(
+        message,
+        this.contentType,
+      );
     } catch {
       this.content = undefined;
     }

package/src/Dm.ts

@@ -7,8 +7,8 @@ import type { SafeConversation } from "@/utils/conversions";
  *
  * This class is not intended to be initialized directly.
  */
-export class Dm extends Conversation {
-  #client: Client;
+export class Dm<ContentTypes = unknown> extends Conversation<ContentTypes> {
+  #client: Client<ContentTypes>;
   #id: string;
 
   /**
@@ -18,7 +18,11 @@ export class Dm extends Conversation {
    * @param id - Identifier for the direct message conversation
    * @param data - Optional conversation data to initialize with
    */
-  constructor(client: Client, id: string, data?: SafeConversation) {
+  constructor(
+    client: Client<ContentTypes>,
+    id: string,
+    data?: SafeConversation,
+  ) {
     super(client, id, data);
     this.#client = client;
     this.#id = id;
@@ -30,7 +34,13 @@ export class Dm extends Conversation {
    * @returns Promise that resolves with the peer's inbox ID
    */
   async peerInboxId() {
-    return this.#client.sendMessage("getDmPeerInboxId", {
+    return this.#client.sendMessage("dm.peerInboxId", {
+      id: this.#id,
+    });
+  }
+
+  async getDuplicateDms() {
+    return this.#client.sendMessage("dm.getDuplicateDms", {
       id: this.#id,
     });
   }