feat: forward messages with caption text

example.js

@@ -211,6 +211,20 @@ client.on('message', async msg => {
  }
  }
  }
+ else if (msg.author) {
+ /** Note: forwarding with caption is available for media messages (photo/video) only. */
+
+ /**
+ * Let's say the message was sent in a group
+ * and I want to forward it to its author.
+ */
+
+ // 1. By default it will be forwarded without a caption text (even if provided):
+ await msg.forward(msg.author);
+
+ // 2. To forward with a caption text of original message (if provided) do:
+ await msg.forward(msg.author, { withCaption: true });
+ }
 });
 
 client.on('message_create', (msg) => {

index.d.ts

@@ -842,7 +842,7 @@ declare namespace WAWebJS {
  /** 
  * Forwards this message to another chat (that you chatted before, otherwise it will fail)
  */
- forward: (chat: Chat | string) => Promise<void>,
+ forward: (chat: Chat | string, options?: MessageForwardOptions) => Promise<void>,
  /** Star this message */
  star: () => Promise<void>,
  /** Unstar this message */
@@ -928,6 +928,13 @@ declare namespace WAWebJS {
  stickerCategories?: string[]
  }
 
+ /** Options for forwarding a message */
+ export interface MessageForwardOptions {
+ multicast?: boolean
+ /** Adds caption text to forwarded message (if provided), if withCaption is true */
+ withCaption?: boolean
+ }
+
  /** Options for editing a message */
  export interface MessageEditOptions {
  /** Show links preview. Has no effect on multi-device accounts. */

src/structures/Message.js

@@ -374,22 +374,35 @@ class Message extends Base {
  async acceptGroupV4Invite() {
  return await this.client.acceptGroupV4Invite(this.inviteV4);
  }
+
+ /**
+ * Forward options:
+ * 
+ * @typedef {Object} MessageForwardOptions
+ * @property {boolean} [multicast=false]
+ * @property {boolean} [withCaption=false] Forwards this message with the caption text of the original message if provided.
+ */
 
  /**
  * Forwards this message to another chat (that you chatted before, otherwise it will fail)
  *
  * @param {string|Chat} chat Chat model or chat ID to which the message will be forwarded
+ * @param {MessageForwardOptions} [options] Options used when forwarding the message
  * @returns {Promise}
  */
- async forward(chat) {
+ async forward(chat, options = {}) {
  const chatId = typeof chat === 'string' ? chat : chat.id._serialized;
+ let internalOptions = {
+ multicast: options.multicast || false,
+ withCaption: options.withCaption || false
+ };
 
- await this.client.pupPage.evaluate(async (msgId, chatId) => {
+ await this.client.pupPage.evaluate(async (msgId, chatId, options) => {
  let msg = window.Store.Msg.get(msgId);
  let chat = window.Store.Chat.get(chatId);
 
- return await chat.forwardMessages([msg]);
- }, this.id._serialized, chatId);
+ return await chat.forwardMessages([msg], ...Object.values(options));
+ }, this.id._serialized, chatId, internalOptions);
  }
 
  /**