feat: add support for editing sent messages via new PATCH endpoint - Closes #169

Implemented the ability to edit previously sent messages by introducing a PATCH endpoint at /chat/editMessage/codechat. Messages can now be updated using an id and new text payload. \n\nThis adds support for message editing similar to Baileys, improving message control for users.

Author: jrCleber

package.json

@@ -1,6 +1,6 @@
 {
   "name": "whatsapp-api",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "Rest api for communication with WhatsApp",
   "main": "./dist/src/main.js",
   "scripts": {

src/validate/validate.schema.ts

@@ -614,6 +614,16 @@ export const mediaUrlSchema: JSONSchema7 = {
   ...isNotEmpty('id'),
 };
 
+export const editMessageSchema: JSONSchema7 = {
+  $id: ulid(),
+  type: 'object',
+  properties: {
+    text: { type: 'string' },
+  },
+  required: ['text'],
+  ...isNotEmpty('text'),
+};
+
 // Group Schema
 export const createGroupSchema: JSONSchema7 = {
   $id: ulid(),

src/whatsapp/controllers/chat.controller.ts

@@ -43,6 +43,7 @@ import {
   WhatsAppNumberDto,
   ReadMessageIdDto,
   RejectCallDto,
+  EditMessage,
 } from '../dto/chat.dto';
 import { InstanceDto } from '../dto/instance.dto';
 import { WAMonitoringService } from '../services/monitor.service';
@@ -115,4 +116,8 @@ export class ChatController {
       .get(instanceName)
       .assertSessions(data.numbers);
   }
+
+  public async editMessage({ instanceName }: InstanceDto, data: EditMessage) {
+    return await this.waMonitor.waInstances.get(instanceName).editMessage(data);
+  }
 }

src/whatsapp/dto/chat.dto.ts

@@ -82,12 +82,19 @@ export class ArchiveChatDto {
   archive: boolean;
 }
 
-export class DeleteMessage {
+export class MessageId {
   id: string;
+}
+
+export class DeleteMessage extends MessageId {
   everyOne?: 'true' | 'false';
 }
 
 export class RejectCallDto {
   callId: string;
   callFrom: string;
 }
+
+export class EditMessage extends MessageId {
+  text: string;
+}

src/whatsapp/routers/chat.router.ts

@@ -39,6 +39,7 @@ import {
   archiveChatSchema,
   contactValidateSchema,
   deleteMessageSchema,
+  editMessageSchema,
   messageValidateSchema,
   profilePictureSchema,
   readMessageForIdSchema,
@@ -50,6 +51,7 @@ import {
 import {
   ArchiveChatDto,
   DeleteMessage,
+  EditMessage,
   NumberDto,
   ReadMessageDto,
   ReadMessageIdDto,
@@ -280,6 +282,15 @@ export function ChatRouter(chatController: ChatController, ...guards: RequestHan
       });
 
       res.status(HttpStatus.OK).json(response);
+    })
+    .post(routerPath('editMessage'), ...guards, async (req, res) => {
+      const response = await dataValidate<EditMessage>({
+        request: req,
+        schema: editMessageSchema,
+        execute: (instance, data) => chatController.editMessage(instance, data),
+      });
+
+      return response;
     });
 
   return router;

src/whatsapp/services/whatsapp.service.ts

@@ -104,10 +104,18 @@ import {
   SendReactionDto,
   SendTextDto,
 } from '../dto/sendMessage.dto';
-import { isArray, isBase64, isNotEmpty, isURL } from 'class-validator';
+import {
+  isArray,
+  isBase64,
+  isInt,
+  isNotEmpty,
+  isNumberString,
+  isURL,
+} from 'class-validator';
 import {
   ArchiveChatDto,
   DeleteMessage,
+  EditMessage,
   OnWhatsAppDto,
   ReadMessageDto,
   ReadMessageIdDto,
@@ -1281,7 +1289,7 @@ export class WAStartupService {
 
         const messageId = options?.messageId || ulid(Date.now());
 
-        if (message?.['react']) {
+        if (message?.['react'] || message?.['edit']) {
           m = await this.client.sendMessage(recipient, message as AnyMessageContent, {
             quoted: q,
             messageId,
@@ -1913,6 +1921,36 @@ export class WAStartupService {
     });
   }
 
+  public async editMessage(data: EditMessage) {
+    try {
+      const where: any = {
+        instanceId: this.instance.id,
+      };
+      if (isInt(data.id)) {
+        const id = Number.parseInt(data.id);
+        where.id = id;
+      } else {
+        where.keyId = data.id;
+      }
+
+      const message = await this.repository.message.findFirst({ where });
+      const messageKey: proto.IMessageKey = {
+        id: message.keyId,
+        fromMe: message.keyFromMe,
+        remoteJid: message.keyRemoteJid,
+        participant: message?.keyParticipant,
+      };
+
+      return await this.sendMessageWithTyping<AnyMessageContent>(message.keyRemoteJid, {
+        edit: messageKey,
+        text: data.text,
+      });
+    } catch (error) {
+      this.logger.error(error);
+      throw new BadRequestException(error.toString());
+    }
+  }
+
   // Chat Controller
   public async whatsappNumber(data: WhatsAppNumberDto) {
     const onWhatsapp: OnWhatsAppDto[] = [];