Merge pull request #703 from xmtp/rygine/browser-sdk-update

Add 1:1 messaging to Browser SDK

sdks/browser-sdk/package.json

@@ -65,7 +65,7 @@
     "@xmtp/content-type-primitives": "^1.0.1",
     "@xmtp/content-type-text": "^1.0.0",
     "@xmtp/proto": "^3.70.0",
-    "@xmtp/wasm-bindings": "^0.0.1",
+    "@xmtp/wasm-bindings": "^0.0.2",
     "uuid": "^10.0.0"
   },
   "devDependencies": {

sdks/browser-sdk/src/Client.ts

@@ -95,12 +95,16 @@ export class Client extends ClientWorkerClass {
     return this.sendMessage("getRevokeWalletSignatureText", { accountAddress });
   }
 
+  async getRevokeInstallationsSignatureText() {
+    return this.sendMessage("getRevokeInstallationsSignatureText", undefined);
+  }
+
   async addSignature(type: WasmSignatureRequestType, bytes: Uint8Array) {
     return this.sendMessage("addSignature", { type, bytes });
   }
 
-  async applySignaturesRequests() {
-    return this.sendMessage("applySignaturesRequests", undefined);
+  async applySignatures() {
+    return this.sendMessage("applySignatures", undefined);
   }
 
   async registerIdentity() {
@@ -119,8 +123,10 @@ export class Client extends ClientWorkerClass {
     return this.sendMessage("findInboxIdByAddress", { address });
   }
 
-  async inboxState(refreshFromNetwork: boolean) {
-    return this.sendMessage("inboxState", { refreshFromNetwork });
+  async inboxState(refreshFromNetwork?: boolean) {
+    return this.sendMessage("inboxState", {
+      refreshFromNetwork: refreshFromNetwork ?? false,
+    });
   }
 
   async getLatestInboxState(inboxId: string) {

sdks/browser-sdk/src/Conversation.ts

@@ -282,4 +282,10 @@ export class Conversation {
       state,
     });
   }
+
+  async dmPeerInboxId() {
+    return this.#client.sendMessage("getDmPeerInboxId", {
+      id: this.#id,
+    });
+  }
 }

sdks/browser-sdk/src/Conversations.ts

@@ -28,6 +28,12 @@ export class Conversations {
     });
   }
 
+  async getDmByInboxId(inboxId: string) {
+    return this.#client.sendMessage("getDmByInboxId", {
+      inboxId,
+    });
+  }
+
   async list(options?: SafeListConversationsOptions) {
     const conversations = await this.#client.sendMessage("getConversations", {
       options,
@@ -39,6 +45,22 @@ export class Conversations {
     );
   }
 
+  async listGroups(
+    options?: Omit<SafeListConversationsOptions, "conversation_type">,
+  ) {
+    return this.#client.sendMessage("getGroups", {
+      options,
+    });
+  }
+
+  async listDms(
+    options?: Omit<SafeListConversationsOptions, "conversation_type">,
+  ) {
+    return this.#client.sendMessage("getDms", {
+      options,
+    });
+  }
+
   async newGroup(accountAddresses: string[], options?: SafeCreateGroupOptions) {
     const conversation = await this.#client.sendMessage("newGroup", {
       accountAddresses,
@@ -47,4 +69,12 @@ export class Conversations {
 
     return new Conversation(this.#client, conversation.id, conversation);
   }
+
+  async newDm(accountAddress: string) {
+    const conversation = await this.#client.sendMessage("newDm", {
+      accountAddress,
+    });
+
+    return new Conversation(this.#client, conversation.id, conversation);
+  }
 }

sdks/browser-sdk/src/WorkerClient.ts

@@ -84,7 +84,7 @@ export class WorkerClient {
     return this.#client.addSignature(type, bytes);
   }
 
-  async applySignaturesRequests() {
+  async applySignatures() {
     return this.#client.applySignatureRequests();
   }
 

sdks/browser-sdk/src/WorkerConversation.ts

@@ -166,4 +166,8 @@ export class WorkerConversation {
   updateConsentState(state: WasmConsentState) {
     this.#group.update_consent_state(state);
   }
+
+  dmPeerInboxId() {
+    return this.#group.dm_peer_inbox_id();
+  }
 }

sdks/browser-sdk/src/WorkerConversations.ts

@@ -43,18 +43,50 @@ export class WorkerConversations {
     }
   }
 
+  getDmByInboxId(inboxId: string) {
+    try {
+      const group = this.#conversations.find_dm_by_target_inbox_id(inboxId);
+      return new WorkerConversation(this.#client, group);
+    } catch {
+      return undefined;
+    }
+  }
+
   async list(options?: SafeListConversationsOptions) {
     const groups = (await this.#conversations.list(
       options ? fromSafeListConversationsOptions(options) : undefined,
     )) as WasmGroup[];
     return groups.map((group) => new WorkerConversation(this.#client, group));
   }
 
+  async listGroups(
+    options?: Omit<SafeListConversationsOptions, "conversation_type">,
+  ) {
+    const groups = (await this.#conversations.list_groups(
+      options ? fromSafeListConversationsOptions(options) : undefined,
+    )) as WasmGroup[];
+    return groups.map((group) => new WorkerConversation(this.#client, group));
+  }
+
+  async listDms(
+    options?: Omit<SafeListConversationsOptions, "conversation_type">,
+  ) {
+    const groups = (await this.#conversations.list_dms(
+      options ? fromSafeListConversationsOptions(options) : undefined,
+    )) as WasmGroup[];
+    return groups.map((group) => new WorkerConversation(this.#client, group));
+  }
+
   async newGroup(accountAddresses: string[], options?: SafeCreateGroupOptions) {
     const group = await this.#conversations.create_group(
       accountAddresses,
       options ? fromSafeCreateGroupOptions(options) : undefined,
     );
     return new WorkerConversation(this.#client, group);
   }
+
+  async newDm(accountAddress: string) {
+    const group = await this.#conversations.create_dm(accountAddress);
+    return new WorkerConversation(this.#client, group);
+  }
 }

sdks/browser-sdk/src/types/clientEvents.ts

@@ -79,7 +79,7 @@ export type ClientEvents =
       };
     }
   | {
-      action: "applySignaturesRequests";
+      action: "applySignatures";
       id: string;
       result: undefined;
       data: undefined;
@@ -164,6 +164,14 @@ export type ClientEvents =
         id: string;
       };
     }
+  | {
+      action: "getDmByInboxId";
+      id: string;
+      result: SafeConversation | undefined;
+      data: {
+        inboxId: string;
+      };
+    }
   | {
       action: "getConversations";
       id: string;
@@ -172,6 +180,22 @@ export type ClientEvents =
         options?: SafeListConversationsOptions;
       };
     }
+  | {
+      action: "getGroups";
+      id: string;
+      result: SafeConversation[];
+      data: {
+        options?: Omit<SafeListConversationsOptions, "conversation_type">;
+      };
+    }
+  | {
+      action: "getDms";
+      id: string;
+      result: SafeConversation[];
+      data: {
+        options?: Omit<SafeListConversationsOptions, "conversation_type">;
+      };
+    }
   | {
       action: "newGroup";
       id: string;
@@ -181,6 +205,14 @@ export type ClientEvents =
         options?: SafeCreateGroupOptions;
       };
     }
+  | {
+      action: "newDm";
+      id: string;
+      result: SafeConversation;
+      data: {
+        accountAddress: string;
+      };
+    }
   | {
       action: "syncConversations";
       id: string;
@@ -399,6 +431,14 @@ export type ClientEvents =
         id: string;
         state: WasmConsentState;
       };
+    }
+  | {
+      action: "getDmPeerInboxId";
+      id: string;
+      result: string;
+      data: {
+        id: string;
+      };
     };
 
 export type ClientEventsActions = ClientEvents["action"];

sdks/browser-sdk/src/utils/conversions.ts

@@ -12,7 +12,10 @@ import {
   WasmListMessagesOptions,
   type WasmConsentEntityType,
   type WasmConsentState,
+  type WasmConversationType,
   type WasmDeliveryStatus,
+  type WasmDirection,
+  type WasmGroupMembershipState,
   type WasmGroupMessageKind,
   type WasmGroupPermissionsOptions,
   type WasmInboxState,
@@ -141,6 +144,7 @@ export const toSafeMessage = (message: WasmMessage): SafeMessage => ({
 
 export type SafeListMessagesOptions = {
   delivery_status?: WasmDeliveryStatus;
+  direction?: WasmDirection;
   limit?: bigint;
   sent_after_ns?: bigint;
   sent_before_ns?: bigint;
@@ -150,6 +154,7 @@ export const toSafeListMessagesOptions = (
   options: WasmListMessagesOptions,
 ): SafeListMessagesOptions => ({
   delivery_status: options.delivery_status,
+  direction: options.direction,
   limit: options.limit,
   sent_after_ns: options.sent_after_ns,
   sent_before_ns: options.sent_before_ns,
@@ -163,9 +168,12 @@ export const fromSafeListMessagesOptions = (
     options.sent_after_ns,
     options.limit,
     options.delivery_status,
+    options.direction,
   );
 
 export type SafeListConversationsOptions = {
+  allowed_states?: WasmGroupMembershipState[];
+  conversation_type?: WasmConversationType;
   created_after_ns?: bigint;
   created_before_ns?: bigint;
   limit?: bigint;
@@ -174,6 +182,8 @@ export type SafeListConversationsOptions = {
 export const toSafeListConversationsOptions = (
   options: WasmListConversationsOptions,
 ): SafeListConversationsOptions => ({
+  allowed_states: options.allowed_states,
+  conversation_type: options.conversation_type,
   created_after_ns: options.created_after_ns,
   created_before_ns: options.created_before_ns,
   limit: options.limit,
@@ -183,6 +193,8 @@ export const fromSafeListConversationsOptions = (
   options: SafeListConversationsOptions,
 ): WasmListConversationsOptions =>
   new WasmListConversationsOptions(
+    options.allowed_states,
+    options.conversation_type,
     options.created_after_ns,
     options.created_before_ns,
     options.limit,

sdks/browser-sdk/src/utils/createClient.ts

@@ -14,7 +14,12 @@ export const createClient = async (
   await init();
 
   const host = options?.apiUrl ?? ApiUrls[options?.env ?? "dev"];
-  const dbPath = `xmtp-${options?.env ?? "dev"}-${accountAddress}.db3`;
+  // TODO: add db path validation
+  //       - must end with .db3
+  //       - must not contain invalid characters
+  //       - must not start with a dot
+  const dbPath =
+    options?.dbPath ?? `xmtp-${options?.env ?? "dev"}-${accountAddress}.db3`;
 
   const inboxId =
     (await getInboxIdForAddress(host, accountAddress)) ||