feat(messages): typingIndicator option on markRead

buf.gen.yaml

@@ -1,8 +1,8 @@
 version: v2
 inputs:
-  # Pinned BSR commit (main @ spectrum-whatsapp-business 17e7e9c).
+  # Pinned BSR commit (main @ spectrum-whatsapp-business 2cab0fb).
   # To pick up schema changes: update the ref, run `bun run generate`, commit both.
-  - module: buf.build/photon-hq/whatsapp:b218d3336d65421c8b215137797db344
+  - module: buf.build/photon-hq/whatsapp:ff29794be4d4464b9ae22fd1c90d8229
 plugins:
   - local: protoc-gen-ts_proto
     out: src/generated

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@photon-ai/whatsapp-business",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript SDK for WhatsApp Business API via Spectrum",
   "type": "module",
   "exports": {

src/index.ts

@@ -89,6 +89,7 @@ export type {
   ContactCardInput,
   InteractiveInput,
   LocationInput,
+  MarkReadOptions,
   MediaInput,
   MessageContent,
   ReactionInput,

src/resources/messages.ts

@@ -3,6 +3,7 @@ import type { MessageServiceClient } from "../transport/grpc-client.ts";
 import { mapSendParams } from "../transport/mapper.ts";
 import type { RequestOptions } from "../types/client.ts";
 import type {
+  MarkReadOptions,
   SendMessageParams,
   SendMessageResult,
 } from "../types/messages.ts";
@@ -32,9 +33,15 @@ export class MessagesResource {
     }
   }
 
-  async markRead(messageId: string, options?: RequestOptions): Promise<void> {
+  async markRead(
+    messageId: string,
+    options?: RequestOptions & MarkReadOptions
+  ): Promise<void> {
     try {
-      await this._client.markRead({ messageId }, { signal: options?.signal });
+      await this._client.markRead(
+        { messageId, typingIndicator: options?.typingIndicator ?? false },
+        { signal: options?.signal }
+      );
     } catch (err) {
       throw fromGrpcError(err);
     }

src/types/messages.ts

@@ -151,3 +151,17 @@ export interface SendMessageResult {
   readonly messageId: string;
   readonly messageStatus: string;
 }
+
+// ---------------------------------------------------------------------------
+// Mark read options
+// ---------------------------------------------------------------------------
+
+export interface MarkReadOptions {
+  /**
+   * Also display a typing indicator in the chat. Meta dismisses it after
+   * 25 seconds or when the business sends a message, whichever comes first —
+   * there is no explicit "stop typing" call. The message being marked read
+   * must be an inbound message.
+   */
+  readonly typingIndicator?: boolean;
+}

tests/unit/messages.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it } from "bun:test";
+import type { MarkReadRequest } from "../../src/generated/photon/whatsapp/v1/message_service.ts";
+import { MessagesResource } from "../../src/resources/messages.ts";
+import type { MessageServiceClient } from "../../src/transport/grpc-client.ts";
+
+function makeResource() {
+  const calls: MarkReadRequest[] = [];
+  const client = {
+    markRead: (request: MarkReadRequest) => {
+      calls.push(request);
+      return Promise.resolve({});
+    },
+  } as unknown as MessageServiceClient;
+  return { messages: new MessagesResource(client), calls };
+}
+
+describe("MessagesResource.markRead", () => {
+  it("sends a plain read receipt by default", async () => {
+    const { messages, calls } = makeResource();
+    await messages.markRead("wamid.abc");
+    expect(calls).toEqual([{ messageId: "wamid.abc", typingIndicator: false }]);
+  });
+
+  it("passes typingIndicator through when requested", async () => {
+    const { messages, calls } = makeResource();
+    await messages.markRead("wamid.abc", { typingIndicator: true });
+    expect(calls).toEqual([{ messageId: "wamid.abc", typingIndicator: true }]);
+  });
+});