fixo-baileys 1.0.8 → 1.0.9

package/README.md

@@ -962,6 +962,33 @@ Errors: a non-channel JID throws `400`; posting from an account that is not owne
 
 > 🎨 A **text** status always carries a background colour — if you don't pass `backgroundColor`, `#FFC107` is used.
 
+### ⚠️ `mode: 'status'` (default) vs `mode: 'post'`
+
+| `options.mode` | What is sent | Where it shows up |
+|:---|:---|:---|
+| `'status'` *(default, **experimental**)* | the message wrapped in `proto.Message.newsletterAdminProfileStatusMessage` (field 126) and published to the channel JID | meant to be a real **Channel Status** (Updates tab, 24 h) |
+| `'post'` | plain channel message (the old behaviour) | channel chat only — a normal post |
+
+> The `'status'` wrapper is based on WhatsApp's own protobuf definition, but the exact stanza WhatsApp uses has **not been verified against a real capture yet**.
+> If it still lands as a normal post, capture the real stanza (below) and open an issue / send the log.
+> Add `rawLog: true` to the 3rd argument to log the final payload: `sock.sendChannelStatus(jid, 'Hi', { rawLog: true })`.
+
+```js
+await sock.sendChannelStatus(channelJid, { image: { url: './pic.jpg' }, caption: 'Hi' })                 // status (experimental)
+await sock.sendChannelStatus(channelJid, { image: { url: './pic.jpg' }, caption: 'Hi' }, { mode: 'post' }) // old plain post
+```
+
+### 🔍 Capturing the real Channel Status stanza
+
+```js
+import makeWASocket from 'fixo-baileys'
+import { attachCapture } from 'fixo-baileys/tools/capture-channel-status.js'
+
+const sock = makeWASocket({ /* ... */ })
+attachCapture(sock)            // writes every received stanza to ./capture.log
+```
+Then post a real Channel Status (one text, one photo) **from your phone** and send `capture.log`.
+
 **How it works (for contributors)**
 - `lib/Socket/messages-send.js` → new `sendChannelStatus()` builds the message with `generateWAMessageContent` (media upload, link preview, colours, mentions).
 - `lib/Socket/newsletter-channel.js` → all channel node builders / parsers / error mapping (see the [Channel API](#-channel-api-newsletter-methods) below).

package/WAProto/WAProto.proto

@@ -2150,6 +2150,7 @@ message Message {
     optional FutureProofMessage questionMessage = 101;
     optional MessageHistoryNotice messageHistoryNotice = 102;
     optional FutureProofMessage groupStatusMessageV2 = 103;
+    optional FutureProofMessage newsletterAdminProfileStatusMessage = 126;
     optional FutureProofMessage botForwardedMessage = 104;
     optional StatusQuestionAnswerMessage statusQuestionAnswerMessage = 105;
     optional FutureProofMessage questionReplyMessage = 106;

package/WAProto/index.d.ts

@@ -5269,6 +5269,7 @@ export namespace proto {
         questionMessage?: (proto.Message.IFutureProofMessage|null);
         messageHistoryNotice?: (proto.Message.IMessageHistoryNotice|null);
         groupStatusMessageV2?: (proto.Message.IFutureProofMessage|null);
+        newsletterAdminProfileStatusMessage?: (proto.Message.IFutureProofMessage|null);
         botForwardedMessage?: (proto.Message.IFutureProofMessage|null);
         statusQuestionAnswerMessage?: (proto.Message.IStatusQuestionAnswerMessage|null);
         questionReplyMessage?: (proto.Message.IFutureProofMessage|null);
@@ -5368,6 +5369,7 @@ export namespace proto {
         public questionMessage?: (proto.Message.IFutureProofMessage|null);
         public messageHistoryNotice?: (proto.Message.IMessageHistoryNotice|null);
         public groupStatusMessageV2?: (proto.Message.IFutureProofMessage|null);
+        public newsletterAdminProfileStatusMessage?: (proto.Message.IFutureProofMessage|null);
         public botForwardedMessage?: (proto.Message.IFutureProofMessage|null);
         public statusQuestionAnswerMessage?: (proto.Message.IStatusQuestionAnswerMessage|null);
         public questionReplyMessage?: (proto.Message.IFutureProofMessage|null);

package/WAProto/index.js

@@ -35552,6 +35552,7 @@ export const proto = $root.proto = (() => {
         Message.prototype.questionMessage = null;
         Message.prototype.messageHistoryNotice = null;
         Message.prototype.groupStatusMessageV2 = null;
+        Message.prototype.newsletterAdminProfileStatusMessage = null;
         Message.prototype.botForwardedMessage = null;
         Message.prototype.statusQuestionAnswerMessage = null;
         Message.prototype.questionReplyMessage = null;
@@ -36080,6 +36081,12 @@ export const proto = $root.proto = (() => {
             set: $util.oneOfSetter($oneOfFields)
         });
 
+        // Virtual OneOf for proto3 optional field
+        Object.defineProperty(Message.prototype, "_newsletterAdminProfileStatusMessage", {
+            get: $util.oneOfGetter($oneOfFields = ["newsletterAdminProfileStatusMessage"]),
+            set: $util.oneOfSetter($oneOfFields)
+        });
+
         // Virtual OneOf for proto3 optional field
         Object.defineProperty(Message.prototype, "_botForwardedMessage", {
             get: $util.oneOfGetter($oneOfFields = ["botForwardedMessage"]),
@@ -36313,6 +36320,8 @@ export const proto = $root.proto = (() => {
                 $root.proto.Message.MessageHistoryNotice.encode(m.messageHistoryNotice, w.uint32(818).fork()).ldelim();
             if (m.groupStatusMessageV2 != null && Object.hasOwnProperty.call(m, "groupStatusMessageV2"))
                 $root.proto.Message.FutureProofMessage.encode(m.groupStatusMessageV2, w.uint32(826).fork()).ldelim();
+            if (m.newsletterAdminProfileStatusMessage != null && Object.hasOwnProperty.call(m, "newsletterAdminProfileStatusMessage"))
+                $root.proto.Message.FutureProofMessage.encode(m.newsletterAdminProfileStatusMessage, w.uint32(1010).fork()).ldelim();
             if (m.botForwardedMessage != null && Object.hasOwnProperty.call(m, "botForwardedMessage"))
                 $root.proto.Message.FutureProofMessage.encode(m.botForwardedMessage, w.uint32(834).fork()).ldelim();
             if (m.statusQuestionAnswerMessage != null && Object.hasOwnProperty.call(m, "statusQuestionAnswerMessage"))
@@ -36687,6 +36696,10 @@ export const proto = $root.proto = (() => {
                         m.groupStatusMessageV2 = $root.proto.Message.FutureProofMessage.decode(r, r.uint32());
                         break;
                     }
+                case 126: {
+                        m.newsletterAdminProfileStatusMessage = $root.proto.Message.FutureProofMessage.decode(r, r.uint32());
+                        break;
+                    }
                 case 104: {
                         m.botForwardedMessage = $root.proto.Message.FutureProofMessage.decode(r, r.uint32());
                         break;
@@ -37163,6 +37176,11 @@ export const proto = $root.proto = (() => {
                     throw TypeError(".proto.Message.groupStatusMessageV2: object expected");
                 m.groupStatusMessageV2 = $root.proto.Message.FutureProofMessage.fromObject(d.groupStatusMessageV2);
             }
+            if (d.newsletterAdminProfileStatusMessage != null) {
+                if (typeof d.newsletterAdminProfileStatusMessage !== "object")
+                    throw TypeError(".proto.Message.newsletterAdminProfileStatusMessage: object expected");
+                m.newsletterAdminProfileStatusMessage = $root.proto.Message.FutureProofMessage.fromObject(d.newsletterAdminProfileStatusMessage);
+            }
             if (d.botForwardedMessage != null) {
                 if (typeof d.botForwardedMessage !== "object")
                     throw TypeError(".proto.Message.botForwardedMessage: object expected");
@@ -37645,6 +37663,11 @@ export const proto = $root.proto = (() => {
                 if (o.oneofs)
                     d._groupStatusMessageV2 = "groupStatusMessageV2";
             }
+            if (m.newsletterAdminProfileStatusMessage != null && m.hasOwnProperty("newsletterAdminProfileStatusMessage")) {
+                d.newsletterAdminProfileStatusMessage = $root.proto.Message.FutureProofMessage.toObject(m.newsletterAdminProfileStatusMessage, o);
+                if (o.oneofs)
+                    d._newsletterAdminProfileStatusMessage = "newsletterAdminProfileStatusMessage";
+            }
             if (m.botForwardedMessage != null && m.hasOwnProperty("botForwardedMessage")) {
                 d.botForwardedMessage = $root.proto.Message.FutureProofMessage.toObject(m.botForwardedMessage, o);
                 if (o.oneofs)

package/lib/Socket/messages-send.js

@@ -1268,6 +1268,14 @@ export const makeMessagesSocket = (config) => {
         // ── Channel Status (post to a WhatsApp Channel like a user posts a status) ──
         // sock.sendChannelStatus(channelJid, 'text' | { text, backgroundColor, font, textColor }
         //                                   | { image|video|audio|document|sticker, caption, ... }, options)
+        //
+        // options.mode:
+        //   'status' (default, EXPERIMENTAL) -> the message is wrapped in
+        //            proto.Message.newsletterAdminProfileStatusMessage (field 126), which is the
+        //            wrapper WhatsApp uses for a channel admin's *status* (Updates tab, 24h).
+        //            The exact wire format is not verified against a real capture yet.
+        //   'post'   -> old behaviour: plain channel post (shows up inside the channel chat only).
+        // options.rawLog = true -> logs the final proto + stanza attrs (logger.info) for debugging.
         sendChannelStatus: async (jid, content, options = {}) => {
             if (!isJidNewsletter(jid)) {
                 throw new Boom('sendChannelStatus needs a channel JID (xxxx@newsletter)', { statusCode: 400 });
@@ -1334,8 +1342,20 @@ export const makeMessagesSocket = (config) => {
             else if (inner.documentMessage) [type, mediatype] = ['media', 'document'];
             else if (inner.stickerMessage) [type, mediatype] = ['media', 'sticker'];
 
+            const mode = options.mode === 'post' ? 'post' : 'status';
+            const toSend =
+                mode === 'status'
+                    ? proto.Message.create({
+                          newsletterAdminProfileStatusMessage: proto.Message.FutureProofMessage.create({ message })
+                      })
+                    : message;
+
+            if (options.rawLog) {
+                logger.info({ jid, mode, type, mediatype, proto: toSend.toJSON?.() }, 'sendChannelStatus payload');
+            }
+
             try {
-                return await sock.newsletterPublish(jid, message, {
+                return await sock.newsletterPublish(jid, toSend, {
                     messageId: options.messageId,
                     additionalAttributes: options.additionalAttributes,
                     type,

package/lib/Utils/messages.js

@@ -816,7 +816,8 @@ export const normalizeMessageContent = (content) => {
             message?.editedMessage ||
             message?.associatedChildMessage ||
             message?.groupStatusMessage ||
-            message?.groupStatusMessageV2);
+            message?.groupStatusMessageV2 ||
+            message?.newsletterAdminProfileStatusMessage);
     }
 };
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fixo-baileys",
   "type": "module",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "A WebSockets library for interacting with WhatsApp Web",
   "keywords": [
     "whatsapp",
@@ -17,7 +17,8 @@
     "lib/**/*",
     "WAProto/**/*",
     "engine-requirements.js",
-    "assets/**/*"
+    "assets/**/*",
+    "tools/**/*"
   ],
   "scripts": {
     "build": "tsc && tsc-esm-fix",

package/tools/capture-channel-status.js

@@ -0,0 +1,29 @@
+// capture-channel-status.js
+// Logs every raw stanza the bot receives/sends into capture.log so the real
+// "Channel Status" wire format can be inspected.
+//
+// Usage: in your bot, right after you create the socket:
+//
+//   import { attachCapture } from 'fixo-baileys/tools/capture-channel-status.js'
+//   const sock = makeWASocket({ ... })
+//   attachCapture(sock)
+//
+// Then post a real Channel Status from the phone (one text, one photo)
+// and send capture.log back (remove phone numbers if you like).
+import fs from 'fs'
+import { binaryNodeToString } from '../lib/WABinary/index.js'
+
+export const attachCapture = (sock, file = 'capture.log') => {
+    const out = fs.createWriteStream(file, { flags: 'a' })
+    sock.ws.on('frame', (frame) => {
+        if (frame instanceof Uint8Array) return
+        // skip noisy keep-alive / presence traffic
+        if (['presence', 'chatstate', 'receipt', 'ack'].includes(frame.tag)) return
+        try {
+            out.write(`\n[${new Date().toISOString()}] RECV\n${binaryNodeToString(frame)}\n`)
+        } catch (e) {
+            out.write(`\n[${new Date().toISOString()}] RECV (unprintable) ${e.message}\n`)
+        }
+    })
+    console.log(`capture started -> ${file}`)
+}