feat: add shouldPush to contentTypes messages

example/src/tests.ts

@@ -58,6 +58,10 @@ class NumberCodec implements JSContentCodec<NumberRef> {
   fallback(content: NumberRef): string | undefined {
     return 'a billion'
   }
+
+  shouldPush(content: NumberRef): boolean {
+    return false
+  }
 }
 
 export type Test = {
@@ -808,6 +812,46 @@ test('register and use custom content types when preparing message', async () =>
   return true
 })
 
+test('shouldPush for content types', async () => {
+  const bob = await Client.createRandom({
+    env: 'local',
+    codecs: [new NumberCodec()],
+  })
+  const alice = await Client.createRandom({
+    env: 'local',
+    codecs: [new NumberCodec()],
+  })
+
+  bob.register(new NumberCodec())
+  alice.register(new NumberCodec())
+
+  const bobConvo = await bob.conversations.newConversation(alice.address)
+  const aliceConvo = await alice.conversations.newConversation(bob.address)
+
+  await bobConvo.send('hi')
+
+  const messages = await aliceConvo.messages()
+
+  const message = messages[0]
+  assert(message.shouldPush === true, 'shouldPush should be true')
+
+  const prepped = await bobConvo.prepareMessage(
+    { topNumber: { bottomNumber: 12 } },
+    {
+      contentType: ContentTypeNumber,
+    }
+  )
+
+  await bobConvo.sendPreparedMessage(prepped)
+
+  const messages2 = await aliceConvo.messages()
+  const message2 = messages2[0]
+
+  assert(message2.shouldPush === false, 'shouldPush should be false')
+
+  return true
+})
+
 test('calls preCreateIdentityCallback when supplied', async () => {
   let isCallbackCalled = false
   const preCreateIdentityCallback = () => {

ios/Wrappers/DecodedMessageWrapper.swift

@@ -13,6 +13,7 @@ struct DecodedMessageWrapper {
 			"senderAddress": model.senderAddress,
 			"sent": UInt64(model.sentAt.timeIntervalSince1970 * 1000),
 			"fallback": model.encodedContent.fallback,
+			"shouldPush": model.shouldPush
 		]
 	}
 

ios/XMTPModule.swift

@@ -226,14 +226,16 @@ public class XMTPModule: Module {
 			).toJson()
 		}
 
-		AsyncFunction("sendEncodedContent") { (clientAddress: String, topic: String, encodedContentData: [UInt8]) -> String in
+		AsyncFunction("sendEncodedContent") { (clientAddress: String, topic: String, encodedContentData: [UInt8], shouldPush: Bool) -> String in
 			guard let conversation = try await findConversation(clientAddress: clientAddress, topic: topic) else {
 				throw Error.conversationNotFound("no conversation found for \(topic)")
 			}
 
 			let encodedContent = try EncodedContent(serializedData: Data(encodedContentData))
+
+			let options = SendOptions(contentType: encodedContent.type, shouldPush: shouldPush)
 
-			return try await conversation.send(encodedContent: encodedContent)
+			return try await conversation.send(encodedContent: encodedContent, options: options)
 		}
 
 		AsyncFunction("listConversations") { (clientAddress: String) -> [String] in
@@ -390,15 +392,19 @@ public class XMTPModule: Module {
 		AsyncFunction("prepareEncodedMessage") { (
 			clientAddress: String,
 			conversationTopic: String,
-			encodedContentData: [UInt8]
+			encodedContentData: [UInt8],
+			shouldPush: Bool
 		) -> String in
 			guard let conversation = try await findConversation(clientAddress: clientAddress, topic: conversationTopic) else {
 				throw Error.conversationNotFound("no conversation found for \(conversationTopic)")
 			}
             let encodedContent = try EncodedContent(serializedData: Data(encodedContentData))
+
+			let contentType = encodedContent.type
 
 			let prepared = try await conversation.prepareMessage(
-				encodedContent: encodedContent
+				encodedContent: encodedContent,
+				options: SendOptions(contentType: contentType, shouldPush: shouldPush)
 			)
 			let preparedAtMillis = prepared.envelopes[0].timestampNs / 1_000_000
 			let preparedData = try prepared.serializedData()

src/index.ts

@@ -235,12 +235,14 @@ export async function sendWithContentType<T>(
   } else {
     const encodedContent = codec.encode(content)
     encodedContent.fallback = codec.fallback(content)
+    const shouldPush = codec.shouldPush(content)
     const encodedContentData = EncodedContent.encode(encodedContent).finish()
 
     return await XMTPModule.sendEncodedContent(
       clientAddress,
       conversationTopic,
-      Array.from(encodedContentData)
+      Array.from(encodedContentData),
+      shouldPush
     )
   }
 }
@@ -287,11 +289,13 @@ export async function prepareMessageWithContentType<T>(
   }
   const encodedContent = codec.encode(content)
   encodedContent.fallback = codec.fallback(content)
+  const shouldPush = codec.shouldPush(content)
   const encodedContentData = EncodedContent.encode(encodedContent).finish()
   const preparedJson = await XMTPModule.prepareEncodedMessage(
     clientAddress,
     conversationTopic,
-    Array.from(encodedContentData)
+    Array.from(encodedContentData),
+    shouldPush
   )
   return JSON.parse(preparedJson)
 }

src/lib/ContentCodec.ts

@@ -1,7 +1,7 @@
 import { content } from '@xmtp/proto'
 import { ReadReceiptCodec } from './NativeCodecs/ReadReceiptCodec'
 import { TextCodec } from './NativeCodecs/TextCodec'
 import { ReplyCodec } from './NativeCodecs/ReplyCodec'
 
 export type EncodedContent = content.EncodedContent
 export type ContentTypeId = content.ContentTypeId
@@ -101,6 +101,7 @@
   encode(content: T): EncodedContent
   decode(encodedContent: EncodedContent): T
   fallback(content: T): string | undefined
+  shouldPush(content: T): boolean
 }
 
 export interface NativeContentCodec<T> {
@@ -109,6 +110,7 @@
   encode(content: T): NativeMessageContent
   decode(nativeContent: NativeMessageContent): T
   fallback(content: T): string | undefined
+  shouldPush(content: T): boolean
 }
 
 export type ContentCodec<T> = JSContentCodec<T> | NativeContentCodec<T>

src/lib/DecodedMessage.ts

@@ -1,12 +1,12 @@
 import { Client } from './Client'
 import {
   ContentCodec,
   JSContentCodec,
   NativeContentCodec,
   NativeMessageContent,
 } from './ContentCodec'
 import { ReplyCodec } from './NativeCodecs/ReplyCodec'
 import { TextCodec } from './NativeCodecs/TextCodec'
 import { Buffer } from 'buffer'
 
 export class DecodedMessage<ContentTypes = any> {
@@ -18,6 +18,7 @@
   sent: number // timestamp in milliseconds
   nativeContent: NativeMessageContent
   fallback: string | undefined
+  shouldPush: boolean
 
   static from<ContentTypes>(
     json: string,
@@ -32,7 +33,8 @@
       decoded.senderAddress,
       decoded.sent,
       decoded.content,
-      decoded.fallback
+      decoded.fallback,
+      decoded.shouldPush
     )
   }
 
@@ -45,6 +47,7 @@
       sent: number // timestamp in milliseconds
       content: any
       fallback: string | undefined
+      shouldPush: boolean
     },
     client: Client<ContentTypes>
   ): DecodedMessage<ContentTypes> {
@@ -56,7 +59,8 @@
       object.senderAddress,
       object.sent,
       object.content,
-      object.fallback
+      object.fallback,
+      object.shouldPush
     )
   }
 
@@ -68,7 +72,8 @@
     senderAddress: string,
     sent: number,
     content: any,
-    fallback: string | undefined
+    fallback: string | undefined,
+    shouldPush: boolean
   ) {
     this.client = client
     this.id = id
@@ -78,6 +83,7 @@
     this.sent = sent
     this.nativeContent = content
     this.fallback = fallback
+    this.shouldPush = shouldPush
   }
 
   content(): ContentTypes {

src/lib/NativeCodecs/ReactionCodec.ts

@@ -35,4 +35,15 @@ export class ReactionCodec implements NativeContentCodec<ReactionContent> {
         return undefined
     }
   }
+
+  shouldPush(content: ReactionContent): boolean {
+    switch (content.action) {
+      case 'added':
+        return true
+      case 'removed':
+        return false
+      default:
+        return false
+    }
+  }
 }

src/lib/NativeCodecs/ReadReceiptCodec.ts

@@ -30,4 +30,8 @@ export class ReadReceiptCodec
   fallback(content: object): string | undefined {
     return undefined
   }
+
+  shouldPush(content: object): boolean {
+    return false
+  }
 }

src/lib/NativeCodecs/RemoteAttachmentCodec.ts

@@ -30,4 +30,8 @@ export class RemoteAttachmentCodec
   fallback(content: RemoteAttachmentContent): string | undefined {
     return `Can’t display "${content.filename}". This app doesn’t support attachments.`
   }
+
+  shouldPush(content: RemoteAttachmentContent): boolean {
+    return true
+  }
 }

src/lib/NativeCodecs/ReplyCodec.ts

@@ -36,4 +36,8 @@ export class ReplyCodec implements NativeContentCodec<ReplyContent> {
     }
     return 'Replied to an earlier message'
   }
+
+  shouldPush(content: ReplyContent): boolean {
+    return true
+  }
 }

src/lib/NativeCodecs/StaticAttachmentCodec.ts

@@ -30,4 +30,8 @@ export class StaticAttachmentCodec
   fallback(content: StaticAttachmentContent): string | undefined {
     return `Can’t display "${content.filename}". This app doesn’t support attachments.`
   }
+
+  shouldPush(content: StaticAttachmentContent): boolean {
+    return true
+  }
 }

src/lib/NativeCodecs/TextCodec.ts

@@ -27,4 +27,8 @@ export class TextCodec implements NativeContentCodec<string> {
   fallback(content: string): string | undefined {
     return content
   }
+
+  shouldPush(content: string): boolean {
+    return true
+  }
 }