@xmtp/browser-sdk 5.1.0 → 5.3.0

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

@@ -1,4 +1,5 @@
 import {
+  GroupMembershipState,
   MessageDisappearingSettings,
   SortDirection,
   type ConsentState,
@@ -12,6 +13,7 @@ import {
   type MetadataField,
   type PermissionPolicy,
   type PermissionUpdateType,
+  type SendMessageOpts,
 } from "@xmtp/wasm-bindings";
 import {
   fromSafeListMessagesOptions,
@@ -64,6 +66,19 @@ export class WorkerConversation {
     return this.#group.updateGroupDescription(description);
   }
 
+  get appData() {
+    try {
+      return this.#group.appData();
+    } catch {
+      // DM groups don't support appData
+      return "";
+    }
+  }
+
+  async updateAppData(appData: string) {
+    return this.#group.updateAppData(appData);
+  }
+
   get isActive() {
     return this.#group.isActive();
   }
@@ -180,12 +195,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 +211,12 @@ export class WorkerConversation {
     );
   }
 
+  async countMessages(options?: SafeListMessagesOptions) {
+    return this.#group.countMessages(
+      options ? fromSafeListMessagesOptions(options) : undefined,
+    );
+  }
+
   get consentState() {
     return this.#group.consentState();
   }
@@ -252,4 +275,12 @@ export class WorkerConversation {
     const dms = await this.#group.findDuplicateDms();
     return dms.map((dm) => new WorkerConversation(this.#client, dm));
   }
+
+  async requestRemoval() {
+    return this.#group.leaveGroup();
+  }
+
+  get isPendingRemoval() {
+    return this.#group.membershipState() === GroupMembershipState.PendingRemove;
+  }
 }

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/group.ts

@@ -140,6 +140,15 @@ export type GroupAction =
         imageUrl: string;
       };
     }
+  | {
+      action: "group.updateAppData";
+      id: string;
+      result: undefined;
+      data: {
+        id: string;
+        appData: string;
+      };
+    }
   | {
       action: "group.updatePermission";
       id: string;
@@ -158,4 +167,20 @@ export type GroupAction =
       data: {
         id: string;
       };
+    }
+  | {
+      action: "group.requestRemoval";
+      id: string;
+      result: undefined;
+      data: {
+        id: string;
+      };
+    }
+  | {
+      action: "group.isPendingRemoval";
+      id: string;
+      result: boolean;
+      data: {
+        id: 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 = {

package/src/utils/conversions.ts

@@ -12,6 +12,7 @@ import {
   ListMessagesOptions,
   MessageDisappearingSettings,
   PermissionPolicySet,
+  SendMessageOpts,
   ContentTypeId as WasmContentTypeId,
   EncodedContent as WasmEncodedContent,
   type ApiStats,
@@ -28,7 +29,9 @@ import {
   type InboxState,
   type Installation,
   type KeyPackageStatus,
+  type ListConversationsOrderBy,
   type Message,
+  type MessageSortBy,
   type PermissionLevel,
   type PermissionPolicy,
   type SortDirection,
@@ -155,9 +158,15 @@ export type SafeListMessagesOptions = {
   contentTypes?: ContentType[];
   deliveryStatus?: DeliveryStatus;
   direction?: SortDirection;
+  excludeContentTypes?: ContentType[];
+  excludeSenderInboxIds?: string[];
+  insertedAfterNs?: bigint;
+  insertedBeforeNs?: bigint;
+  kind?: GroupMessageKind;
   limit?: bigint;
   sentAfterNs?: bigint;
   sentBeforeNs?: bigint;
+  sortBy?: MessageSortBy;
 };
 
 export const toSafeListMessagesOptions = (
@@ -166,9 +175,15 @@ export const toSafeListMessagesOptions = (
   contentTypes: options.contentTypes,
   deliveryStatus: options.deliveryStatus,
   direction: options.direction,
+  excludeContentTypes: options.excludeContentTypes,
+  excludeSenderInboxIds: options.excludeSenderInboxIds,
+  insertedAfterNs: options.insertedAfterNs,
+  insertedBeforeNs: options.insertedBeforeNs,
+  kind: options.kind,
   limit: options.limit,
   sentAfterNs: options.sentAfterNs,
   sentBeforeNs: options.sentBeforeNs,
+  sortBy: options.sortBy,
 });
 
 export const fromSafeListMessagesOptions = (
@@ -181,8 +196,30 @@ export const fromSafeListMessagesOptions = (
     options.deliveryStatus,
     options.direction,
     options.contentTypes,
+    options.excludeContentTypes,
+    options.kind,
+    options.excludeSenderInboxIds,
+    options.sortBy,
+    options.insertedAfterNs,
+    options.insertedBeforeNs,
   );
 
+export type SafeSendMessageOpts = {
+  shouldPush: boolean;
+};
+
+export const toSafeSendMessageOpts = (
+  opts: SendMessageOpts,
+): SafeSendMessageOpts => ({
+  shouldPush: opts.shouldPush,
+});
+
+export const fromSafeSendMessageOpts = (
+  opts: SafeSendMessageOpts,
+): SendMessageOpts => {
+  return new SendMessageOpts(opts.shouldPush);
+};
+
 export type SafeListConversationsOptions = {
   consentStates?: ConsentState[];
   conversationType?: ConversationType;
@@ -190,6 +227,7 @@ export type SafeListConversationsOptions = {
   createdBeforeNs?: bigint;
   includeDuplicateDms?: boolean;
   limit?: bigint;
+  orderBy?: ListConversationsOrderBy;
 };
 
 export const toSafeListConversationsOptions = (
@@ -201,6 +239,7 @@ export const toSafeListConversationsOptions = (
   createdBeforeNs: options.createdBeforeNs,
   includeDuplicateDms: options.includeDuplicateDms,
   limit: options.limit,
+  orderBy: options.orderBy,
 });
 
 export const fromSafeListConversationsOptions = (
@@ -213,6 +252,7 @@ export const fromSafeListConversationsOptions = (
     options.createdBeforeNs,
     options.includeDuplicateDms ?? false,
     options.limit,
+    options.orderBy,
   );
 
 export type SafePermissionPolicySet = {
@@ -319,6 +359,7 @@ export type SafeConversation = {
   name: string;
   imageUrl: string;
   description: string;
+  appData: string;
   permissions: {
     policyType: GroupPermissionsOptions;
     policySet: {
@@ -350,6 +391,7 @@ export const toSafeConversation = async (
   const name = conversation.name;
   const imageUrl = conversation.imageUrl;
   const description = conversation.description;
+  const appData = conversation.appData;
   const permissions = conversation.permissions;
   const addedByInboxId = conversation.addedByInboxId;
   const metadata = await conversation.metadata();
@@ -364,6 +406,7 @@ export const toSafeConversation = async (
     name,
     imageUrl,
     description,
+    appData,
     permissions: {
       policyType,
       policySet: {
@@ -506,6 +549,11 @@ export const toSafeKeyPackageStatus = (
   validationError: status.validationError,
 });
 
+export type SafeXMTPCursor = {
+  originatorID: number;
+  sequenceID: bigint;
+};
+
 export type SafeConversationDebugInfo = {
   epoch: bigint;
   maybeForked: boolean;
@@ -513,7 +561,7 @@ export type SafeConversationDebugInfo = {
   isCommitLogForked?: boolean;
   localCommitLog: string;
   remoteCommitLog: string;
-  cursor: bigint;
+  cursor: SafeXMTPCursor[];
 };
 
 export const toSafeConversationDebugInfo = (
@@ -525,7 +573,10 @@ export const toSafeConversationDebugInfo = (
   isCommitLogForked: debugInfo.isCommitLogForked,
   localCommitLog: debugInfo.localCommitLog,
   remoteCommitLog: debugInfo.remoteCommitLog,
-  cursor: debugInfo.cursor,
+  cursor: debugInfo.cursor.map((cursor) => ({
+    originatorID: cursor.originator_id,
+    sequenceID: cursor.sequence_id,
+  })),
 });
 
 export type SafeApiStats = {

package/src/utils/createClient.ts

@@ -14,8 +14,9 @@ export const createClient = async (
 ) => {
   const env = options?.env || "dev";
   const host = options?.apiUrl || ApiUrls[env];
+  const gatewayHost = options?.gatewayHost ?? null;
   const inboxId =
-    (await getInboxIdForIdentifier(host, identifier)) ||
+    (await getInboxIdForIdentifier(host, gatewayHost, identifier)) ||
     generateInboxId(identifier);
   const dbPath =
     options?.dbPath === undefined
@@ -54,5 +55,6 @@ export const createClient = async (
     undefined,
     options?.debugEventsEnabled,
     options?.appVersion,
+    options?.gatewayHost,
   );
 };

package/src/utils/streams.ts

@@ -55,6 +55,11 @@ export type StreamOptions<T = unknown, V = T> = {
    * (default: true)
    */
   retryOnFail?: boolean;
+  /**
+   * Whether to disable network sync before starting the stream
+   * (default: false)
+   */
+  disableSync?: boolean;
 };
 
 export type StreamCallback<T = unknown> = (