Merge pull request #246 from Secreto31126/show-yourself

Added reply method to OnMessage callback

Author: Secreto31126

ENVIRONMENTS.md

@@ -203,8 +203,8 @@ const Whatsapp = new WhatsAppAPI({
     }
 });
 
-Whatsapp.on.message = ({ phoneID, from, name }) => {
-    Whatsapp.sendMessage(phoneID, from, new Text(`Hello ${name}!`));
+Whatsapp.on.message = ({ name, reply }) => {
+    reply(new Text(`Hello ${name}!`));
 };
 
 async function doPost(e) {

README.md

@@ -55,7 +55,7 @@ async function post(e) {
     );
 }
 
-Whatsapp.on.message = async ({ phoneID, from, message, name }) => {
+Whatsapp.on.message = async ({ phoneID, from, message, name, reply }) => {
     console.log(
         `User ${name} (${from}) sent to bot ${phoneID} ${JSON.stringify(
             message
@@ -65,34 +65,26 @@ Whatsapp.on.message = async ({ phoneID, from, message, name }) => {
     let promise;
 
     if (message.type === "text") {
-        promise = Whatsapp.sendMessage(
-            phoneID,
-            from,
+        promise = reply(
             new Text(`*${name}* said:\n\n${message.text.body}`),
-            message.id
+            true
         );
     }
 
     if (message.type === "image") {
-        promise = Whatsapp.sendMessage(
-            phoneID,
-            from,
+        promise = reply(
             new Image(message.image.id, true, `Nice photo, ${name}`)
         );
     }
 
     if (message.type === "document") {
-        promise = Whatsapp.sendMessage(
-            phoneID,
-            from,
+        promise = reply(
             new Document(message.document.id, true, undefined, "Our document")
         );
     }
 
     if (message.type === "contacts") {
-        promise = Whatsapp.sendMessage(
-            phoneID,
-            from,
+        promise = reply(
             new Contacts.Contacts(
                 [
                     new Contacts.Name(name, "First name", "Last name"),

package.json

@@ -1,6 +1,6 @@
 {
     "name": "whatsapp-api-js",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "author": "Secreto31126",
     "description": "A TypeScript server agnostic Whatsapp's Official API framework",
     "license": "MIT",

src/emitters.ts

@@ -1,3 +1,4 @@
+import { Response } from "undici";
 import type {
     ClientMessage,
     ClientMessageRequest,
@@ -83,6 +84,17 @@ export type OnMessageArgs = {
      * The raw data from the API
      */
     raw: PostData;
+    /**
+     * A method to easily reply to the user who sent the message
+     *
+     * @param response - The message to send as a reply
+     * @param context - Wether to mention the current message
+     * @returns WhatsAppAPI.sendMessage return value
+     */
+    reply: (
+        response: ClientMessage,
+        context: boolean
+    ) => Promise<ServerMessageResponse | Response>;
 };
 
 /**

src/index.ts

@@ -778,7 +778,14 @@ export default class WhatsAppAPI {
                 from,
                 message,
                 name,
-                raw: data
+                raw: data,
+                reply: (response, context = false) =>
+                    this.sendMessage(
+                        phoneID,
+                        from,
+                        response,
+                        context ? message.id : undefined
+                    )
             };
 
             this.offload(this.on?.message, args);

test/index.test.cjs

@@ -1635,6 +1635,21 @@ describe("WhatsAppAPI", function () {
             });
 
             describe("Messages", function () {
+                const expectedResponse = {
+                    messaging_product: "whatsapp",
+                    contacts: [
+                        {
+                            input: user,
+                            wa_id: user
+                        }
+                    ],
+                    messages: [
+                        {
+                            id
+                        }
+                    ]
+                };
+
                 let spy_on_message;
                 this.beforeEach(function () {
                     spy_on_message = sinon_spy();
@@ -1662,6 +1677,33 @@ describe("WhatsAppAPI", function () {
                     });
                 });
 
+                it("should reply to a message with the method reply", async function () {
+                    const spy_on_sent = sinon_spy();
+                    Whatsapp.on.sent = spy_on_sent;
+
+                    clientFacebook
+                        .intercept({
+                            path: `/${Whatsapp.v}/${phoneID}/messages`,
+                            method: "POST",
+                            headers: {
+                                Authorization: `Bearer ${token}`
+                            }
+                        })
+                        .reply(200, expectedResponse)
+                        .times(1);
+
+                    Whatsapp.on.message = async ({ reply }) => {
+                        reply(new Text("Hello World"));
+                    };
+
+                    Whatsapp.post(valid_message_mock);
+
+                    // Callbacks are executed in the next tick
+                    await new Promise((resolve) => setTimeout(resolve, 0));
+
+                    sinon_assert.calledOnce(spy_on_sent);
+                });
+
                 it("should not block the main thread with the user's callback", async function () {
                     // Emulates a blocking function
                     function block(delay) {