@xmtp/browser-sdk 5.1.0 → 5.2.0

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 = {
@@ -506,6 +546,11 @@ export const toSafeKeyPackageStatus = (
   validationError: status.validationError,
 });
 
+export type SafeXMTPCursor = {
+  originatorID: number;
+  sequenceID: bigint;
+};
+
 export type SafeConversationDebugInfo = {
   epoch: bigint;
   maybeForked: boolean;
@@ -513,7 +558,7 @@ export type SafeConversationDebugInfo = {
   isCommitLogForked?: boolean;
   localCommitLog: string;
   remoteCommitLog: string;
-  cursor: bigint;
+  cursor: SafeXMTPCursor[];
 };
 
 export const toSafeConversationDebugInfo = (
@@ -525,7 +570,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> = (

package/src/workers/client.ts

@@ -21,6 +21,7 @@ import type {
 import {
   fromEncodedContent,
   fromSafeEncodedContent,
+  fromSafeSendMessageOpts,
   toSafeApiStats,
   toSafeConsent,
   toSafeConversation,
@@ -203,10 +204,12 @@ self.onmessage = async (
         const signatureRequest =
           await client.revokeAllOtherInstallationsSignatureRequest();
         const result = {
-          signatureText: await signatureRequest.signatureText(),
+          signatureText: await signatureRequest?.signatureText(),
           signatureRequestId: data.signatureRequestId,
         };
-        signatureRequests.set(data.signatureRequestId, signatureRequest);
+        if (signatureRequest) {
+          signatureRequests.set(data.signatureRequestId, signatureRequest);
+        }
         postMessage({ id, action, result });
         break;
       }
@@ -350,6 +353,16 @@ self.onmessage = async (
         });
         break;
       }
+      case "client.libxmtpVersion": {
+        const result = client.libxmtpVersion;
+        postMessage({ id, action, result });
+        break;
+      }
+      case "client.appVersion": {
+        const result = client.appVersion;
+        postMessage({ id, action, result });
+        break;
+      }
       /**
        * Debug information actions
        */
@@ -597,6 +610,32 @@ self.onmessage = async (
         postMessage({ id, action, result: undefined });
         break;
       }
+      case "conversations.streamMessageDeletions": {
+        const streamCallback = (
+          error: Error | null,
+          value: string | undefined,
+        ) => {
+          if (error) {
+            streamClosers.delete(data.streamId);
+            postStreamMessageError({
+              action: "stream.messageDeleted",
+              streamId: data.streamId,
+              error,
+            });
+          } else {
+            postStreamMessage({
+              action: "stream.messageDeleted",
+              streamId: data.streamId,
+              result: value,
+            });
+          }
+        };
+        const streamCloser =
+          client.conversations.streamMessageDeletions(streamCallback);
+        streamClosers.set(data.streamId, streamCloser);
+        postMessage({ id, action, result: undefined });
+        break;
+      }
       case "conversations.list": {
         const conversations = client.conversations.list(data.options);
         const result = await Promise.all(
@@ -768,6 +807,7 @@ self.onmessage = async (
         const group = getGroup(data.id);
         const result = await group.send(
           fromEncodedContent(fromSafeEncodedContent(data.content)),
+          fromSafeSendMessageOpts(data.sendOptions),
         );
         postMessage({ id, action, result });
         break;
@@ -776,6 +816,7 @@ self.onmessage = async (
         const group = getGroup(data.id);
         const result = group.sendOptimistic(
           fromEncodedContent(fromSafeEncodedContent(data.content)),
+          fromSafeSendMessageOpts(data.sendOptions),
         );
         postMessage({ id, action, result });
         break;
@@ -793,6 +834,12 @@ self.onmessage = async (
         postMessage({ id, action, result });
         break;
       }
+      case "conversation.countMessages": {
+        const group = getGroup(data.id);
+        const result = await group.countMessages(data.options);
+        postMessage({ id, action, result });
+        break;
+      }
       case "conversation.members": {
         const group = getGroup(data.id);
         const result = await group.members();

package/src/workers/utils.ts

@@ -39,9 +39,10 @@ const postMessageError = (data: ActionErrorData<UtilsWorkerAction>) => {
 const getInboxIdForIdentifier = async (
   identifier: Identifier,
   env?: XmtpEnv,
+  gatewayHost?: string,
 ) => {
   const host = env ? ApiUrls[env] : ApiUrls.dev;
-  return get_inbox_id_for_identifier(host, identifier);
+  return get_inbox_id_for_identifier(host, gatewayHost ?? null, identifier);
 };
 
 let enableLogging = false;
@@ -75,14 +76,19 @@ self.onmessage = async (
         break;
       }
       case "utils.getInboxIdForIdentifier": {
-        const result = await getInboxIdForIdentifier(data.identifier, data.env);
+        const result = await getInboxIdForIdentifier(
+          data.identifier,
+          data.env,
+          data.gatewayHost,
+        );
         postMessage({ id, action, result });
         break;
       }
       case "utils.revokeInstallationsSignatureText": {
         const host = ApiUrls[data.env ?? "dev"];
-        const signatureRequest = await revokeInstallationsSignatureRequest(
+        const signatureRequest = revokeInstallationsSignatureRequest(
           host,
+          data.gatewayHost,
           data.identifier,
           data.inboxId,
           data.installationIds,
@@ -115,15 +121,24 @@ self.onmessage = async (
             );
             break;
         }
-        await applySignatureRequest(host, signatureRequest);
+        await applySignatureRequest(
+          host,
+          data.gatewayHost ?? null,
+          signatureRequest,
+        );
         signatureRequests.delete(data.signatureRequestId);
-        postMessage({ id, action, result: undefined });
+        postMessage({ id, action, result: [] });
         break;
       }
+
       case "utils.inboxStateFromInboxIds": {
         const host = ApiUrls[data.env ?? "dev"];
         try {
-          const inboxStates = await inboxStateFromInboxIds(host, data.inboxIds);
+          const inboxStates = await inboxStateFromInboxIds(
+            host,
+            data.gatewayHost ?? null,
+            data.inboxIds,
+          );
           const result = inboxStates.map((inboxState) =>
             toSafeInboxState(inboxState),
           );