@xmtp/browser-sdk 5.0.1 → 5.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmtp/browser-sdk",
-  "version": "5.0.1",
+  "version": "5.2.0",
   "description": "XMTP client SDK for browsers written in TypeScript",
   "keywords": [
     "xmtp",
@@ -63,30 +63,31 @@
     "@xmtp/content-type-group-updated": "^2.0.2",
     "@xmtp/content-type-primitives": "^2.0.2",
     "@xmtp/content-type-text": "^2.0.2",
-    "@xmtp/wasm-bindings": "1.5.4",
+    "@xmtp/wasm-bindings": "1.6.6",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.4",
+    "@rollup/plugin-typescript": "^12.3.0",
     "@testing-library/dom": "^10.4.1",
-    "@testing-library/jest-dom": "^6.8.0",
+    "@testing-library/jest-dom": "^6.9.1",
     "@types/uuid": "^10.0.0",
-    "@vitest/browser": "^3.2.4",
-    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/browser": "^4.0.3",
+    "@vitest/browser-playwright": "^4.0.3",
+    "@vitest/coverage-v8": "^4.0.3",
     "@web/rollup-plugin-copy": "^0.5.1",
-    "playwright": "^1.55.0",
-    "rollup": "^4.50.2",
+    "playwright": "^1.56.1",
+    "rollup": "^4.52.5",
     "rollup-plugin-dts": "^6.2.3",
     "rollup-plugin-tsconfig-paths": "^1.5.2",
-    "typescript": "^5.9.2",
-    "viem": "^2.37.6",
-    "vite": "^7.1.5",
+    "typescript": "^5.9.3",
+    "viem": "^2.38.4",
+    "vite": "^7.1.12",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.3"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "publishConfig": {
     "access": "public",

package/src/Client.ts

@@ -221,6 +221,20 @@ export class Client<
     return this.#preferences;
   }
 
+  /**
+   * Gets the version of libxmtp used in the bindings
+   */
+  async libxmtpVersion() {
+    return this.sendMessage("client.libxmtpVersion", undefined);
+  }
+
+  /**
+   * Gets the app version used by the client
+   */
+  async appVersion() {
+    return this.sendMessage("client.appVersion", undefined);
+  }
+
   /**
    * Creates signature text for creating a new inbox
    *
@@ -488,6 +502,12 @@ export class Client<
 
     const { signatureText, signatureRequestId } =
       await this.unsafe_revokeAllOtherInstallationsSignatureText();
+
+    // no other installations to revoke, nothing to do
+    if (!signatureText) {
+      return;
+    }
+
     const signature = await this.#signer.signMessage(signatureText);
     const signer = await toSafeSigner(this.#signer, signature);
 
@@ -535,11 +555,18 @@ export class Client<
     inboxId: string,
     installationIds: Uint8Array[],
     env?: XmtpEnv,
+    gatewayHost?: string,
     enableLogging?: boolean,
   ) {
     const utils = new Utils(enableLogging);
     await utils.init();
-    await utils.revokeInstallations(signer, inboxId, installationIds, env);
+    await utils.revokeInstallations(
+      signer,
+      inboxId,
+      installationIds,
+      env,
+      gatewayHost,
+    );
     utils.close();
   }
 
@@ -554,10 +581,15 @@ export class Client<
     inboxIds: string[],
     env?: XmtpEnv,
     enableLogging?: boolean,
+    gatewayHost?: string,
   ) {
     const utils = new Utils(enableLogging);
     await utils.init();
-    const result = await utils.inboxStateFromInboxIds(inboxIds, env);
+    const result = await utils.inboxStateFromInboxIds(
+      inboxIds,
+      env,
+      gatewayHost,
+    );
     utils.close();
     return result;
   }
@@ -662,6 +694,38 @@ export class Client<
     if (!codec) {
       throw new CodecNotFoundError(contentType);
     }
+
+    return this.#encodeWithCodec(content, codec);
+  }
+
+  /**
+   * Prepares content for sending by encoding it and generating send options from the codec
+   *
+   * @param content - The message content to prepare for sending
+   * @param contentType - The content type identifier for the appropriate codec
+   * @returns An object containing the encoded content and send options
+   * @throws {CodecNotFoundError} When no codec is registered for the specified content type
+   */
+  prepareForSend(content: ContentTypes, contentType: ContentTypeId) {
+    const codec = this.codecFor(contentType);
+    if (!codec) {
+      throw new CodecNotFoundError(contentType);
+    }
+
+    return {
+      encodedContent: this.#encodeWithCodec(content, codec),
+      sendOptions: this.#sendMessageOpts(content, codec),
+    };
+  }
+
+  /**
+   * Encodes content using a specific codec and adds fallback information if available
+   *
+   * @param content - The content to encode
+   * @param codec - The codec to use for encoding
+   * @returns The encoded content with optional fallback
+   */
+  #encodeWithCodec(content: ContentTypes, codec: ContentCodec) {
     const encoded = codec.encode(content, this);
     const fallback = codec.fallback(content);
     if (fallback) {
@@ -670,6 +734,20 @@ export class Client<
     return toSafeEncodedContent(encoded);
   }
 
+  /**
+   * Generates send options based on the content and codec
+   *
+   * @param content - The content being sent
+   * @param codec - The codec used for the content
+   * @returns Send options including whether to push notify recipients
+   */
+  #sendMessageOpts(
+    content: ContentTypes,
+    codec: ContentCodec,
+  ): { shouldPush: boolean } {
+    return { shouldPush: codec.shouldPush(content) };
+  }
+
   /**
    * Decodes a message for a given content type
    *

package/src/Conversation.ts

@@ -144,15 +144,16 @@ export class Conversation<ContentTypes = unknown> {
       throw new MissingContentTypeError();
     }
 
-    const safeEncodedContent =
+    const { encodedContent: safeEncodedContent, sendOptions } =
       typeof content === "string"
-        ? this.#client.encodeContent(content, contentType ?? ContentTypeText)
+        ? this.#client.prepareForSend(content, contentType ?? ContentTypeText)
         : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          this.#client.encodeContent(content, contentType!);
+          this.#client.prepareForSend(content, contentType!);
 
     return this.#client.sendMessage("conversation.sendOptimistic", {
       id: this.#id,
       content: safeEncodedContent,
+      sendOptions,
     });
   }
 
@@ -169,15 +170,16 @@ export class Conversation<ContentTypes = unknown> {
       throw new MissingContentTypeError();
     }
 
-    const safeEncodedContent =
+    const { encodedContent: safeEncodedContent, sendOptions } =
       typeof content === "string"
-        ? this.#client.encodeContent(content, contentType ?? ContentTypeText)
+        ? this.#client.prepareForSend(content, contentType ?? ContentTypeText)
         : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          this.#client.encodeContent(content, contentType!);
+          this.#client.prepareForSend(content, contentType!);
 
     return this.#client.sendMessage("conversation.send", {
       id: this.#id,
       content: safeEncodedContent,
+      sendOptions,
     });
   }
 
@@ -196,6 +198,22 @@ export class Conversation<ContentTypes = unknown> {
     return messages.map((message) => new DecodedMessage(this.#client, message));
   }
 
+  /**
+   * Counts messages in this conversation
+   *
+   * @param options - Optional filtering options
+   * @returns Promise that resolves with the count of messages
+   */
+  async countMessages(
+    options?: Omit<SafeListMessagesOptions, "limit" | "direction">,
+  ) {
+    const count = await this.#client.sendMessage("conversation.countMessages", {
+      id: this.#id,
+      options,
+    });
+    return count;
+  }
+
   /**
    * Gets the consent state for this conversation
    *
@@ -294,8 +312,10 @@ export class Conversation<ContentTypes = unknown> {
       onFail: () => void,
     ) => {
       const streamId = v4();
-      // sync the conversation
-      await this.sync();
+      if (!options?.disableSync) {
+        // sync the conversation
+        await this.sync();
+      }
       // start the stream
       await this.#client.sendMessage("conversation.stream", {
         groupId: this.#id,

package/src/Conversations.ts

@@ -114,6 +114,20 @@ export class Conversations<ContentTypes = unknown> {
     return data ? new Dm(this.#client, data.id, data) : undefined;
   }
 
+  /**
+   * Retrieves a DM by identifier
+   *
+   * @param identifier - The identifier to look up
+   * @returns Promise that resolves with the DM, if found
+   */
+  async getDmByIdentifier(identifier: Identifier) {
+    const inboxId = await this.#client.findInboxIdByIdentifier(identifier);
+    if (!inboxId) {
+      return undefined;
+    }
+    return this.getDmByInboxId(inboxId);
+  }
+
   /**
    * Lists all conversations with optional filtering
    *
@@ -307,8 +321,10 @@ export class Conversations<ContentTypes = unknown> {
       onFail: () => void,
     ) => {
       const streamId = v4();
-      // sync the conversation
-      await this.sync();
+      if (!options?.disableSync) {
+        // sync the conversation
+        await this.sync();
+      }
       // start the stream
       await this.#client.sendMessage("conversations.stream", {
         streamId,
@@ -380,8 +396,10 @@ export class Conversations<ContentTypes = unknown> {
       onFail: () => void,
     ) => {
       const streamId = v4();
-      // sync the conversation
-      await this.sync();
+      if (!options?.disableSync) {
+        // sync the conversation
+        await this.sync();
+      }
       // start the stream
       await this.#client.sendMessage("conversations.streamAllMessages", {
         streamId,
@@ -439,4 +457,38 @@ export class Conversations<ContentTypes = unknown> {
       conversationType: ConversationType.Dm,
     });
   }
+
+  /**
+   * Creates a stream for message deletions
+   *
+   * @param options - Optional stream options
+   * @returns Stream instance for message deletions
+   */
+  async streamMessageDeletions(
+    options?: Omit<
+      StreamOptions<string>,
+      | "disableSync"
+      | "onFail"
+      | "onRetry"
+      | "onRestart"
+      | "retryAttempts"
+      | "retryDelay"
+      | "retryOnFail"
+    >,
+  ) {
+    const stream = async (callback: StreamCallback<string>) => {
+      const streamId = v4();
+      // start the stream
+      await this.#client.sendMessage("conversations.streamMessageDeletions", {
+        streamId,
+      });
+      // handle stream messages
+      return this.#client.handleStreamMessage<string>(
+        streamId,
+        callback,
+        options,
+      );
+    };
+    return createStream(stream, undefined, options);
+  }
 }

package/src/Utils.ts

@@ -37,12 +37,18 @@ export class Utils extends UtilsWorkerClass {
    *
    * @param identifier - The identifier to get the inbox ID for
    * @param env - Optional XMTP environment configuration (default: "dev")
+   * @param gatewayHost - Optional gateway host override
    * @returns Promise that resolves with the inbox ID for the identifier
    */
-  async getInboxIdForIdentifier(identifier: Identifier, env?: XmtpEnv) {
+  async getInboxIdForIdentifier(
+    identifier: Identifier,
+    env?: XmtpEnv,
+    gatewayHost?: string,
+  ) {
     return this.sendMessage("utils.getInboxIdForIdentifier", {
       identifier,
       env,
+      gatewayHost,
     });
   }
 
@@ -59,6 +65,7 @@ export class Utils extends UtilsWorkerClass {
    * @param identifier - The identifier to revoke installations for
    * @param inboxId - The inbox ID to revoke installations for
    * @param installationIds - The installation IDs to revoke
+   * @param gatewayHost - Optional gateway host override
    * @returns The signature text and signature request ID
    */
   async revokeInstallationsSignatureText(
@@ -66,6 +73,7 @@ export class Utils extends UtilsWorkerClass {
     inboxId: string,
     installationIds: Uint8Array[],
     env?: XmtpEnv,
+    gatewayHost?: string,
   ) {
     return this.sendMessage("utils.revokeInstallationsSignatureText", {
       env,
@@ -73,6 +81,7 @@ export class Utils extends UtilsWorkerClass {
       inboxId,
       installationIds,
       signatureRequestId: v4(),
+      gatewayHost,
     });
   }
 
@@ -83,6 +92,7 @@ export class Utils extends UtilsWorkerClass {
    * @param signer - The signer to use
    * @param inboxId - The inbox ID to revoke installations for
    * @param installationIds - The installation IDs to revoke
+   * @param gatewayHost - Optional gateway host override
    * @returns Promise that resolves with the result of the revoke installations operation
    */
   async revokeInstallations(
@@ -90,6 +100,7 @@ export class Utils extends UtilsWorkerClass {
     inboxId: string,
     installationIds: Uint8Array[],
     env?: XmtpEnv,
+    gatewayHost?: string,
   ) {
     const identifier = await signer.getIdentifier();
     const { signatureText, signatureRequestId } =
@@ -98,6 +109,7 @@ export class Utils extends UtilsWorkerClass {
         inboxId,
         installationIds,
         env,
+        gatewayHost,
       );
     const signature = await signer.signMessage(signatureText);
     const safeSigner = await toSafeSigner(signer, signature);
@@ -106,6 +118,7 @@ export class Utils extends UtilsWorkerClass {
       signer: safeSigner,
       signatureRequestId,
       env,
+      gatewayHost,
     });
   }
 
@@ -116,10 +129,15 @@ export class Utils extends UtilsWorkerClass {
    * @param env - The environment to use
    * @returns The inbox state for the specified inbox IDs
    */
-  async inboxStateFromInboxIds(inboxIds: string[], env?: XmtpEnv) {
+  async inboxStateFromInboxIds(
+    inboxIds: string[],
+    env?: XmtpEnv,
+    gatewayHost?: string,
+  ) {
     return this.sendMessage("utils.inboxStateFromInboxIds", {
       inboxIds,
       env,
+      gatewayHost,
     });
   }
 }

package/src/WorkerClient.ts

@@ -34,6 +34,14 @@ export class WorkerClient {
     return new WorkerClient(client, options);
   }
 
+  get libxmtpVersion() {
+    return this.#client.libxmtpVersion;
+  }
+
+  get appVersion() {
+    return this.#client.appVersion;
+  }
+
   get accountIdentifier() {
     return this.#client.accountIdentifier;
   }

package/src/WorkerConversation.ts

@@ -12,6 +12,7 @@ import {
   type MetadataField,
   type PermissionPolicy,
   type PermissionUpdateType,
+  type SendMessageOpts,
 } from "@xmtp/wasm-bindings";
 import {
   fromSafeListMessagesOptions,
@@ -180,12 +181,14 @@ export class WorkerConversation {
     return this.#group.publishMessages();
   }
 
-  sendOptimistic(encodedContent: EncodedContent) {
-    return this.#group.sendOptimistic(encodedContent);
+  sendOptimistic(encodedContent: EncodedContent, opts: SendMessageOpts) {
+    // Pass through to underlying implementation - it will handle undefined opts
+    return this.#group.sendOptimistic(encodedContent, opts);
   }
 
-  async send(encodedContent: EncodedContent) {
-    return this.#group.send(encodedContent);
+  async send(encodedContent: EncodedContent, opts: SendMessageOpts) {
+    // Pass through to underlying implementation - it will handle undefined opts
+    return this.#group.send(encodedContent, opts);
   }
 
   async messages(options?: SafeListMessagesOptions) {
@@ -194,6 +197,12 @@ export class WorkerConversation {
     );
   }
 
+  async countMessages(options?: SafeListMessagesOptions) {
+    return this.#group.countMessages(
+      options ? fromSafeListMessagesOptions(options) : undefined,
+    );
+  }
+
   get consentState() {
     return this.#group.consentState();
   }

package/src/WorkerConversations.ts

@@ -214,4 +214,17 @@ export class WorkerConversations {
       consentStates,
     );
   }
+
+  streamMessageDeletions(callback: StreamCallback<string>) {
+    const on_message_deleted = (messageId: string) => {
+      callback(null, messageId);
+    };
+    const on_error = (error: Error | null) => {
+      callback(error, undefined);
+    };
+    return this.#conversations.streamMessageDeletions({
+      on_message_deleted,
+      on_error,
+    });
+  }
 }

package/src/constants.ts

@@ -7,9 +7,9 @@
  * @property {string} production - The production URL for the XMTP network
  */
 export const ApiUrls = {
-  local: "http://localhost:5555",
-  dev: "https://dev.xmtp.network",
-  production: "https://production.xmtp.network",
+  local: "http://localhost:5557",
+  dev: "https://api.dev.xmtp.network:5558",
+  production: "https://api.production.xmtp.network:5558",
 } as const;
 
 /**

package/src/index.ts

@@ -12,6 +12,7 @@ export type * from "./types/options";
 export * from "./utils/conversions";
 export type { AsyncStreamProxy } from "./AsyncStream";
 export type {
+  GroupSyncSummary,
   Identifier,
   IdentifierKind,
   UserPreference,

package/src/types/actions/client.ts

@@ -65,7 +65,7 @@ export type ClientAction =
       action: "client.revokeAllOtherInstallationsSignatureText";
       id: string;
       result: {
-        signatureText: string;
+        signatureText: string | undefined;
         signatureRequestId: string;
       };
       data: {
@@ -210,4 +210,16 @@ export type ClientAction =
       data: {
         installationIds: string[];
       };
+    }
+  | {
+      action: "client.libxmtpVersion";
+      id: string;
+      result: string;
+      data: undefined;
+    }
+  | {
+      action: "client.appVersion";
+      id: string;
+      result: string;
+      data: undefined;
     };

package/src/types/actions/conversation.ts

@@ -8,6 +8,7 @@ import type {
   SafeListMessagesOptions,
   SafeMessage,
   SafeMessageDisappearingSettings,
+  SafeSendMessageOpts,
 } from "@/utils/conversions";
 
 export type ConversationAction =
@@ -26,6 +27,7 @@ export type ConversationAction =
       data: {
         id: string;
         content: SafeEncodedContent;
+        sendOptions: SafeSendMessageOpts;
       };
     }
   | {
@@ -35,6 +37,7 @@ export type ConversationAction =
       data: {
         id: string;
         content: SafeEncodedContent;
+        sendOptions: SafeSendMessageOpts;
       };
     }
   | {
@@ -54,6 +57,15 @@ export type ConversationAction =
         options?: SafeListMessagesOptions;
       };
     }
+  | {
+      action: "conversation.countMessages";
+      id: string;
+      result: bigint;
+      data: {
+        id: string;
+        options?: Omit<SafeListMessagesOptions, "limit" | "direction">;
+      };
+    }
   | {
       action: "conversation.members";
       id: string;

package/src/types/actions/conversations.ts

@@ -143,4 +143,12 @@ export type ConversationsAction =
         conversationType?: ConversationType;
         consentStates?: ConsentState[];
       };
+    }
+  | {
+      action: "conversations.streamMessageDeletions";
+      id: string;
+      result: undefined;
+      data: {
+        streamId: string;
+      };
     };

package/src/types/actions/preferences.ts

@@ -1,4 +1,8 @@
-import type { ConsentEntityType, ConsentState } from "@xmtp/wasm-bindings";
+import type {
+  ConsentEntityType,
+  ConsentState,
+  GroupSyncSummary,
+} from "@xmtp/wasm-bindings";
 import type { SafeConsent, SafeInboxState } from "@/utils/conversions";
 
 export type PreferencesAction =
@@ -47,7 +51,7 @@ export type PreferencesAction =
   | {
       action: "preferences.sync";
       id: string;
-      result: number;
+      result: GroupSyncSummary;
       data: undefined;
     }
   | {

package/src/types/actions/streams.ts

@@ -26,6 +26,11 @@ export type StreamAction =
       streamId: string;
       result: UserPreference[] | undefined;
     }
+  | {
+      action: "stream.messageDeleted";
+      streamId: string;
+      result: string | undefined;
+    }
   | {
       action: "stream.fail";
       streamId: string;

package/src/types/actions/utils.ts

@@ -27,6 +27,7 @@ export type UtilsWorkerAction =
       data: {
         identifier: Identifier;
         env?: XmtpEnv;
+        gatewayHost?: string;
       };
     }
   | {
@@ -40,6 +41,7 @@ export type UtilsWorkerAction =
         env?: XmtpEnv;
         identifier: Identifier;
         inboxId: string;
+        gatewayHost?: string;
         installationIds: Uint8Array[];
         signatureRequestId: string;
       };
@@ -52,6 +54,7 @@ export type UtilsWorkerAction =
         env?: XmtpEnv;
         signer: SafeSigner;
         signatureRequestId: string;
+        gatewayHost?: string;
       };
     }
   | {
@@ -61,5 +64,6 @@ export type UtilsWorkerAction =
       data: {
         inboxIds: string[];
         env?: XmtpEnv;
+        gatewayHost?: string;
       };
     };

package/src/types/options.ts

@@ -21,6 +21,10 @@ export type NetworkOptions = {
    * specific endpoint for syncing history
    */
   historySyncUrl?: string | null;
+  /**
+   * gatewayHost can be used to override the gateway endpoint
+   */
+  gatewayHost?: string | null;
 };
 
 export type ContentOptions = {