@xmtp/browser-sdk 2.0.13 → 2.1.1

package/src/Group.ts

@@ -13,9 +13,9 @@ import type { SafeConversation } from "@/utils/conversions";
  *
  * This class is not intended to be initialized directly.
  */
-export class Group extends Conversation {
+export class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
   #admins: SafeConversation["admins"] = [];
-  #client: Client;
+  #client: Client<ContentTypes>;
   #description?: SafeConversation["description"];
   #id: string;
   #imageUrl?: SafeConversation["imageUrl"];
@@ -37,7 +37,11 @@ export class Group extends Conversation {
    * @param id - Identifier for the group 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;
@@ -68,7 +72,7 @@ export class Group extends Conversation {
    * @param name The new name for the group
    */
   async updateName(name: string) {
-    await this.#client.sendMessage("updateGroupName", {
+    await this.#client.sendMessage("group.updateName", {
       id: this.#id,
       name,
     });
@@ -88,7 +92,7 @@ export class Group extends Conversation {
    * @param imageUrl The new image URL for the group
    */
   async updateImageUrl(imageUrl: string) {
-    await this.#client.sendMessage("updateGroupImageUrlSquare", {
+    await this.#client.sendMessage("group.updateImageUrl", {
       id: this.#id,
       imageUrl,
     });
@@ -108,7 +112,7 @@ export class Group extends Conversation {
    * @param description The new description for the group
    */
   async updateDescription(description: string) {
-    await this.#client.sendMessage("updateGroupDescription", {
+    await this.#client.sendMessage("group.updateDescription", {
       id: this.#id,
       description,
     });
@@ -135,7 +139,7 @@ export class Group extends Conversation {
    * @returns Array of admin inbox IDs
    */
   async listAdmins() {
-    const admins = await this.#client.sendMessage("getGroupAdmins", {
+    const admins = await this.#client.sendMessage("group.listAdmins", {
       id: this.#id,
     });
     this.#admins = admins;
@@ -148,9 +152,12 @@ export class Group extends Conversation {
    * @returns Array of super admin inbox IDs
    */
   async listSuperAdmins() {
-    const superAdmins = await this.#client.sendMessage("getGroupSuperAdmins", {
-      id: this.#id,
-    });
+    const superAdmins = await this.#client.sendMessage(
+      "group.listSuperAdmins",
+      {
+        id: this.#id,
+      },
+    );
     this.#superAdmins = superAdmins;
     return superAdmins;
   }
@@ -161,7 +168,7 @@ export class Group extends Conversation {
    * @returns The group's permissions
    */
   async permissions() {
-    return this.#client.sendMessage("getGroupPermissions", {
+    return this.#client.sendMessage("group.permissions", {
       id: this.#id,
     });
   }
@@ -178,7 +185,7 @@ export class Group extends Conversation {
     policy: PermissionPolicy,
     metadataField?: MetadataField,
   ) {
-    return this.#client.sendMessage("updateGroupPermissionPolicy", {
+    return this.#client.sendMessage("group.updatePermission", {
       id: this.#id,
       permissionType,
       policy,
@@ -214,7 +221,7 @@ export class Group extends Conversation {
    * @param identifiers Array of member identifiers to add
    */
   async addMembersByIdentifiers(identifiers: Identifier[]) {
-    return this.#client.sendMessage("addGroupMembers", {
+    return this.#client.sendMessage("group.addMembersByIdentifiers", {
       id: this.#id,
       identifiers,
     });
@@ -226,7 +233,7 @@ export class Group extends Conversation {
    * @param inboxIds Array of inbox IDs to add
    */
   async addMembers(inboxIds: string[]) {
-    return this.#client.sendMessage("addGroupMembersByInboxId", {
+    return this.#client.sendMessage("group.addMembers", {
       id: this.#id,
       inboxIds,
     });
@@ -238,7 +245,7 @@ export class Group extends Conversation {
    * @param identifiers Array of member identifiers to remove
    */
   async removeMembersByIdentifiers(identifiers: Identifier[]) {
-    return this.#client.sendMessage("removeGroupMembers", {
+    return this.#client.sendMessage("group.removeMembersByIdentifiers", {
       id: this.#id,
       identifiers,
     });
@@ -250,7 +257,7 @@ export class Group extends Conversation {
    * @param inboxIds Array of inbox IDs to remove
    */
   async removeMembers(inboxIds: string[]) {
-    return this.#client.sendMessage("removeGroupMembersByInboxId", {
+    return this.#client.sendMessage("group.removeMembers", {
       id: this.#id,
       inboxIds,
     });
@@ -262,7 +269,7 @@ export class Group extends Conversation {
    * @param inboxId The inbox ID of the member to promote
    */
   async addAdmin(inboxId: string) {
-    return this.#client.sendMessage("addGroupAdmin", {
+    return this.#client.sendMessage("group.addAdmin", {
       id: this.#id,
       inboxId,
     });
@@ -274,7 +281,7 @@ export class Group extends Conversation {
    * @param inboxId The inbox ID of the admin to demote
    */
   async removeAdmin(inboxId: string) {
-    return this.#client.sendMessage("removeGroupAdmin", {
+    return this.#client.sendMessage("group.removeAdmin", {
       id: this.#id,
       inboxId,
     });
@@ -286,7 +293,7 @@ export class Group extends Conversation {
    * @param inboxId The inbox ID of the member to promote
    */
   async addSuperAdmin(inboxId: string) {
-    return this.#client.sendMessage("addGroupSuperAdmin", {
+    return this.#client.sendMessage("group.addSuperAdmin", {
       id: this.#id,
       inboxId,
     });
@@ -298,7 +305,7 @@ export class Group extends Conversation {
    * @param inboxId The inbox ID of the super admin to demote
    */
   async removeSuperAdmin(inboxId: string) {
-    return this.#client.sendMessage("removeGroupSuperAdmin", {
+    return this.#client.sendMessage("group.removeSuperAdmin", {
       id: this.#id,
       inboxId,
     });

package/src/Preferences.ts

@@ -9,18 +9,22 @@ import type { Client } from "./Client";
  *
  * This class is not intended to be initialized directly.
  */
-export class Preferences {
-  #client: Client;
+export class Preferences<ContentTypes = unknown> {
+  #client: Client<ContentTypes>;
 
   /**
    * Creates a new preferences instance
    *
    * @param client - The client instance managing preferences
    */
-  constructor(client: Client) {
+  constructor(client: Client<ContentTypes>) {
     this.#client = client;
   }
 
+  sync() {
+    return this.#client.sendMessage("preferences.sync", undefined);
+  }
+
   /**
    * Retrieves the current inbox state
    *
@@ -28,7 +32,7 @@ export class Preferences {
    * @returns Promise that resolves with the inbox state
    */
   async inboxState(refreshFromNetwork?: boolean) {
-    return this.#client.sendMessage("inboxState", {
+    return this.#client.sendMessage("preferences.inboxState", {
       refreshFromNetwork: refreshFromNetwork ?? false,
     });
   }
@@ -44,7 +48,7 @@ export class Preferences {
     inboxIds: string[],
     refreshFromNetwork?: boolean,
   ) {
-    return this.#client.sendMessage("inboxStateFromInboxIds", {
+    return this.#client.sendMessage("preferences.inboxStateFromInboxIds", {
       inboxIds,
       refreshFromNetwork: refreshFromNetwork ?? false,
     });
@@ -57,7 +61,9 @@ export class Preferences {
    * @returns Promise that resolves with the latest inbox state
    */
   async getLatestInboxState(inboxId: string) {
-    return this.#client.sendMessage("getLatestInboxState", { inboxId });
+    return this.#client.sendMessage("preferences.getLatestInboxState", {
+      inboxId,
+    });
   }
 
   /**
@@ -67,7 +73,9 @@ export class Preferences {
    * @returns Promise that resolves when consent states are updated
    */
   async setConsentStates(records: SafeConsent[]) {
-    return this.#client.sendMessage("setConsentStates", { records });
+    return this.#client.sendMessage("preferences.setConsentStates", {
+      records,
+    });
   }
 
   /**
@@ -78,7 +86,10 @@ export class Preferences {
    * @returns Promise that resolves with the consent state
    */
   async getConsentState(entityType: ConsentEntityType, entity: string) {
-    return this.#client.sendMessage("getConsentState", { entityType, entity });
+    return this.#client.sendMessage("preferences.getConsentState", {
+      entityType,
+      entity,
+    });
   }
 
   /**
@@ -97,7 +108,7 @@ export class Preferences {
         void callback?.(error, value ?? undefined);
       },
     );
-    await this.#client.sendMessage("streamConsent", {
+    await this.#client.sendMessage("preferences.streamConsent", {
       streamId,
     });
     asyncStream.onReturn = () => {
@@ -125,7 +136,7 @@ export class Preferences {
         void callback?.(error, value ?? undefined);
       },
     );
-    await this.#client.sendMessage("streamPreferences", {
+    await this.#client.sendMessage("preferences.streamPreferences", {
       streamId,
     });
     asyncStream.onReturn = () => {

package/src/Utils.ts

@@ -25,7 +25,7 @@ export class Utils extends UtilsWorkerClass {
    * @returns Promise that resolves with the generated inbox ID
    */
   async generateInboxId(identifier: Identifier) {
-    return this.sendMessage("generateInboxId", {
+    return this.sendMessage("utils.generateInboxId", {
       identifier,
     });
   }
@@ -38,7 +38,7 @@ export class Utils extends UtilsWorkerClass {
    * @returns Promise that resolves with the inbox ID for the identifier
    */
   async getInboxIdForIdentifier(identifier: Identifier, env?: XmtpEnv) {
-    return this.sendMessage("getInboxIdForIdentifier", {
+    return this.sendMessage("utils.getInboxIdForIdentifier", {
       identifier,
       env,
     });

package/src/UtilsWorkerClass.ts

@@ -1,17 +1,27 @@
 import { v4 } from "uuid";
 import type {
-  UtilsEventsActions,
-  UtilsEventsErrorData,
-  UtilsEventsResult,
-  UtilsEventsWorkerMessageData,
-  UtilsSendMessageData,
-} from "@/types";
+  ActionErrorData,
+  ActionName,
+  ActionWithoutData,
+  ExtractActionData,
+  ExtractActionResult,
+} from "@/types/actions";
+import type { UtilsWorkerAction } from "@/types/actions/utils";
 
 const handleError = (event: ErrorEvent) => {
-  console.error(`Worker error on line ${event.lineno} in "${event.filename}"`);
   console.error(event.message);
 };
 
+/**
+ * Class that sets up a worker and provides communications for utility functions
+ *
+ * This class is not meant to be used directly, it is extended by the Utils class
+ * to provide an interface to the worker.
+ *
+ * @param worker - The worker to use for the utils class
+ * @param enableLogging - Whether to enable logging in the worker
+ * @returns A new UtilsWorkerClass instance
+ */
 export class UtilsWorkerClass {
   #worker: Worker;
 
@@ -25,20 +35,35 @@ export class UtilsWorkerClass {
   constructor(worker: Worker, enableLogging: boolean) {
     this.#worker = worker;
     this.#worker.addEventListener("message", this.handleMessage);
-    this.#worker.addEventListener("error", handleError);
+    if (enableLogging) {
+      this.#worker.addEventListener("error", handleError);
+    }
     this.#enableLogging = enableLogging;
     void this.init(enableLogging);
   }
 
+  /**
+   * Initializes the utils worker
+   *
+   * @param enableLogging - Whether to enable logging in the worker
+   * @returns A promise that resolves when the worker is initialized
+   */
   async init(enableLogging: boolean) {
-    return this.sendMessage("init", {
+    return this.sendMessage("utils.init", {
       enableLogging,
     });
   }
 
-  sendMessage<A extends UtilsEventsActions>(
+  /**
+   * Sends an action message to the utils worker
+   *
+   * @param action - The action to send to the worker
+   * @param data - The data to send to the worker
+   * @returns A promise that resolves when the action is completed
+   */
+  sendMessage<A extends ActionName<UtilsWorkerAction>>(
     action: A,
-    data: UtilsSendMessageData<A>,
+    data: ExtractActionData<UtilsWorkerAction, A>,
   ) {
     const promiseId = v4();
     this.#worker.postMessage({
@@ -46,17 +71,28 @@ export class UtilsWorkerClass {
       id: promiseId,
       data,
     });
-    const promise = new Promise<UtilsEventsResult<A>>((resolve, reject) => {
+    const promise = new Promise((resolve, reject) => {
       this.#promises.set(promiseId, {
         resolve: resolve as (value: unknown) => void,
         reject,
       });
     });
-    return promise;
+    return promise as [ExtractActionResult<UtilsWorkerAction, A>] extends [
+      undefined,
+    ]
+      ? Promise<void>
+      : Promise<ExtractActionResult<UtilsWorkerAction, A>>;
   }
 
+  /**
+   * Handles a message from the utils worker
+   *
+   * @param event - The event to handle
+   */
   handleMessage = (
-    event: MessageEvent<UtilsEventsWorkerMessageData | UtilsEventsErrorData>,
+    event: MessageEvent<
+      ActionWithoutData<UtilsWorkerAction> | ActionErrorData<UtilsWorkerAction>
+    >,
   ) => {
     const eventData = event.data;
     if (this.#enableLogging) {
@@ -73,9 +109,14 @@ export class UtilsWorkerClass {
     }
   };
 
+  /**
+   * Removes all event listeners and terminates the worker
+   */
   close() {
     this.#worker.removeEventListener("message", this.handleMessage);
-    this.#worker.removeEventListener("error", handleError);
+    if (this.#enableLogging) {
+      this.#worker.removeEventListener("error", handleError);
+    }
     this.#worker.terminate();
   }
 }

package/src/WorkerClient.ts

@@ -5,7 +5,8 @@ import {
   type KeyPackageStatus,
   type SignatureRequestType,
 } from "@xmtp/wasm-bindings";
-import type { ClientOptions } from "@/types";
+import { HistorySyncUrls } from "@/constants";
+import type { ClientOptions } from "@/types/options";
 import { createClient } from "@/utils/createClient";
 import { WorkerConversations } from "@/WorkerConversations";
 import { WorkerPreferences } from "@/WorkerPreferences";
@@ -13,13 +14,15 @@ import { WorkerPreferences } from "@/WorkerPreferences";
 export class WorkerClient {
   #client: Client;
   #conversations: WorkerConversations;
+  #options?: ClientOptions;
   #preferences: WorkerPreferences;
 
-  constructor(client: Client) {
+  constructor(client: Client, options?: ClientOptions) {
     this.#client = client;
     const conversations = client.conversations();
     this.#conversations = new WorkerConversations(this, conversations);
     this.#preferences = new WorkerPreferences(client, conversations);
+    this.#options = options;
   }
 
   static async create(
@@ -27,7 +30,7 @@ export class WorkerClient {
     options?: Omit<ClientOptions, "codecs">,
   ) {
     const client = await createClient(identifier, options);
-    return new WorkerClient(client);
+    return new WorkerClient(client, options);
   }
 
   get accountIdentifier() {
@@ -178,4 +181,23 @@ export class WorkerClient {
       installationIds,
     ) as Promise<Map<string, KeyPackageStatus>>;
   }
+
+  apiStatistics() {
+    return this.#client.apiStatistics();
+  }
+
+  apiIdentityStatistics() {
+    return this.#client.apiIdentityStatistics();
+  }
+
+  apiAggregateStatistics() {
+    return this.#client.apiAggregateStatistics();
+  }
+
+  async uploadDebugArchive(serverUrl?: string) {
+    const env = this.#options?.env || "dev";
+    const historySyncUrl =
+      this.#options?.historySyncUrl || HistorySyncUrls[env];
+    return this.#client.uploadDebugArchive(serverUrl || historySyncUrl);
+  }
 }

package/src/WorkerConversation.ts

@@ -2,6 +2,7 @@ import {
   MessageDisappearingSettings,
   type ConsentState,
   type Conversation,
+  type ConversationDebugInfo,
   type EncodedContent,
   type GroupMember,
   type HmacKey,
@@ -20,7 +21,6 @@ import {
 import type { WorkerClient } from "@/WorkerClient";
 
 export class WorkerConversation {
-  // eslint-disable-next-line no-unused-private-class-members
   #client: WorkerClient;
 
   #group: Conversation;
@@ -217,6 +217,15 @@ export class WorkerConversation {
   }
 
   getHmacKeys() {
-    return this.#group.getHmacKeys() as HmacKey[];
+    return this.#group.getHmacKeys() as Map<string, HmacKey[]>;
+  }
+
+  async debugInfo() {
+    return (await this.#group.getDebugInfo()) as ConversationDebugInfo;
+  }
+
+  async getDuplicateDms() {
+    const dms = await this.#group.findDuplicateDms();
+    return dms.map((dm) => new WorkerConversation(this.#client, dm));
   }
 }

package/src/WorkerConversations.ts

@@ -78,8 +78,11 @@ export class WorkerConversations {
   listGroups(
     options?: Omit<SafeListConversationsOptions, "conversation_type">,
   ) {
-    const groups = this.#conversations.listGroups(
-      options ? fromSafeListConversationsOptions(options) : undefined,
+    const groups = this.#conversations.list(
+      fromSafeListConversationsOptions({
+        ...(options ?? {}),
+        conversationType: ConversationType.Group,
+      }),
     ) as ConversationListItem[];
     return groups.map(
       (item) => new WorkerConversation(this.#client, item.conversation),
@@ -87,14 +90,24 @@ export class WorkerConversations {
   }
 
   listDms(options?: Omit<SafeListConversationsOptions, "conversation_type">) {
-    const groups = this.#conversations.listDms(
-      options ? fromSafeListConversationsOptions(options) : undefined,
+    const groups = this.#conversations.list(
+      fromSafeListConversationsOptions({
+        ...(options ?? {}),
+        conversationType: ConversationType.Dm,
+      }),
     ) as ConversationListItem[];
     return groups.map(
       (item) => new WorkerConversation(this.#client, item.conversation),
     );
   }
 
+  newGroupOptimistic(options?: SafeCreateGroupOptions) {
+    const group = this.#conversations.createGroupOptimistic(
+      options ? fromSafeCreateGroupOptions(options) : undefined,
+    );
+    return new WorkerConversation(this.#client, group);
+  }
+
   async newGroupWithIdentifiers(
     identifiers: Identifier[],
     options?: SafeCreateGroupOptions,
@@ -164,6 +177,7 @@ export class WorkerConversations {
   streamAllMessages(
     callback?: StreamCallback<Message>,
     conversationType?: ConversationType,
+    consentStates?: ConsentState[],
   ) {
     const on_message = (message: Message) => {
       void callback?.(null, message);
@@ -174,6 +188,7 @@ export class WorkerConversations {
     return this.#conversations.streamAllMessages(
       { on_message, on_error },
       conversationType,
+      consentStates,
     );
   }
 }

package/src/WorkerPreferences.ts

@@ -17,6 +17,10 @@ export class WorkerPreferences {
     this.#conversations = conversations;
   }
 
+  sync() {
+    return this.#client.syncPreferences();
+  }
+
   async inboxState(refreshFromNetwork: boolean) {
     return this.#client.inboxState(refreshFromNetwork);
   }

package/src/index.ts

@@ -1,4 +1,5 @@
 export { Client } from "./Client";
+export type { ExtractCodecContentTypes } from "./Client";
 export { Conversations } from "./Conversations";
 export { Conversation } from "./Conversation";
 export { Dm } from "./Dm";
@@ -7,7 +8,7 @@ export type { MessageDeliveryStatus, MessageKind } from "./DecodedMessage";
 export { DecodedMessage } from "./DecodedMessage";
 export { Utils } from "./Utils";
 export { ApiUrls, HistorySyncUrls } from "./constants";
-export type * from "./types";
+export type * from "./types/options";
 export * from "./utils/conversions";
 export type { AsyncStream, StreamCallback } from "./AsyncStream";
 export type {
@@ -50,3 +51,4 @@ export {
   SortDirection,
 } from "@xmtp/wasm-bindings";
 export type { Signer } from "./utils/signer";
+export * from "./utils/errors";