plogme 2.0.0 → 2.0.2

package/lib/Utils/rich-message-utils.js

@@ -5,7 +5,7 @@
  * If you use or copy this code, please credit my name or project. AND DO NOT CHANGE THIS NOTE
  */
 import { getRandomValues, randomUUID, randomBytes } from 'crypto';
-import { DONATE_URL, LEXER_REGEX } from '../Defaults/index.js';
+import { BOT_RENDERING_CONFIG_METADATA, DONATE_URL, LEXER_REGEX } from '../Defaults/index.js';
 import { LANGUAGE_KEYWORDS } from '../WABinary/constants.js';
 import { CodeHighlightType, RichSubMessageType } from '../Types/RichType.js';
 import { proto } from '../../WAProto/index.js';
@@ -196,7 +196,8 @@ export const prepareRichGenerationMessage = ({
     estimatedMs,
     itemId = `imagine_${randomUUID()}`,
     responseId = randomUUID(),
-    forwarded = true
+    forwarded = true,
+    verificationMetadata
 } = {}) => {
     const sections = [];
     if (text) {
@@ -210,7 +211,7 @@ export const prepareRichGenerationMessage = ({
         unifiedResponse: { data: Buffer.from(JSON.stringify({ response_id: responseId, sections })) },
         contextInfo: forwarded ? { isForwarded: true, forwardingScore: 1, forwardedAiBotMessageInfo: { botJid: '867051314767696@bot' }, forwardOrigin: 4 } : {}
     });
-    const message = wrapToBotForwardedMessage(richResponseMessage);
+    const message = wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
     message.messageContextInfo = message.messageContextInfo || {};
     message.messageContextInfo.botMetadata = {
         ...(message.messageContextInfo.botMetadata || {}),
@@ -220,56 +221,72 @@ export const prepareRichGenerationMessage = ({
 };
 
 // Lia@Note 17-04-26 --- WIP
+/**
+ * A preview-media descriptor is only meaningful when the client can locate and
+ * decrypt the media. A descriptor without a key, hash and direct path describes
+ * media that cannot be fetched, so it is dropped rather than shipped
+ * present-but-empty (which is what previously produced `''` crypto fields and a
+ * hard-coded `image/jpeg` mimetype on every reel).
+ *
+ * Callers that upload real media supply it as `previewMedia` on the reel item or
+ * LaTeX expression: `{ fileSha256, mediaKey, fileEncSha256, directPath, mimetype?, mediaKeyTimestamp?, mediaId? }`.
+ */
+const normalizePreviewMedia = (media) => {
+    if (!media || typeof media !== 'object') return null;
+    const { fileSha256, mediaKey, fileEncSha256, directPath, mimetype, mediaKeyTimestamp } = media;
+    if (!fileSha256 || !mediaKey || !fileEncSha256 || !directPath) return null;
+    return {
+        fileSha256,
+        mediaKey,
+        fileEncSha256,
+        directPath,
+        mediaKeyTimestamp: mediaKeyTimestamp ?? unixTimestampSeconds(),
+        mimetype: mimetype || 'image/jpeg'
+    };
+};
+
 export const buildAdditionalBotMetadataContext = (submessages) => {
     const sources = [];
     const mediaDetailsMetadataList = [];
-    for (let i = 0; i < submessages.length; i++) {
-        const submessage = submessages[i];
+    for (const submessage of submessages) {
         switch (submessage.messageType) {
             case RichSubMessageType.CONTENT_ITEMS: {
                 const itemsMetadata = submessage.contentItemsMetadata?.itemsMetadata || [];
-                for (let n = 0; n < itemsMetadata.length; n++) {
-                    const reelItem = itemsMetadata[n]?.reelItem || itemsMetadata[n] || {};
+                for (const item of itemsMetadata) {
+                    const reelItem = item?.reelItem || item || {};
                     sources.push({
                         provider: 0,
                         thumbnailCdnUrl: reelItem.thumbnailUrl || reelItem.thumbnail_url || '',
                         sourceProviderUrl: reelItem.videoUrl || reelItem.reels_url || reelItem.url || '',
                         sourceQuery: '',
                         faviconCdnUrl: reelItem.profileIconUrl || reelItem.avatar_url || '',
-                        citationNumber: i + 1,
+                        // 1-based source ordinal, not the submessage index.
+                        citationNumber: sources.length + 1,
                         sourceTitle: reelItem.title || reelItem.reels_title || reelItem.creator || ''
                     });
-                    mediaDetailsMetadataList.push({
-                        id: randomBytes(32).toString('hex'),
-                        previewMedia: {
-                            fileSha256: '',
-                            mediaKey: '',
-                            fileEncSha256: '',
-                            directPath: '',
-                            mediaKeyTimestamp: unixTimestampSeconds(),
-                            mimetype: 'image/jpeg'
-                        }
-                    });
+                    const previewMedia = normalizePreviewMedia(reelItem.previewMedia);
+                    if (previewMedia) {
+                        mediaDetailsMetadataList.push({
+                            id: reelItem.mediaId || reelItem.previewMedia?.mediaId || randomBytes(32).toString('hex'),
+                            previewMedia
+                        });
+                    }
                 }
                 break;
             }
-            case RichSubMessageType.LATEX:
-                const expressions = submessage.latexMetadata.expressions;
-                for (let n = 0; n < expressions.length; n++) {
-                    const expression = expressions[n];
-                    mediaDetailsMetadataList.push({
-                        id: randomBytes(32).toString('hex'),
-                        previewMedia: {
-                            fileSha256: '',
-                            mediaKey: '',
-                            fileEncSha256: '',
-                            directPath: '',
-                            mediaKeyTimestamp: unixTimestampSeconds(),
-                            mimetype: 'image/jpeg'
-                        }
-                    });
+            case RichSubMessageType.LATEX: {
+                const expressions = submessage.latexMetadata?.expressions || [];
+                for (const expression of expressions) {
+                    const previewMedia = normalizePreviewMedia(expression?.previewMedia);
+                    if (previewMedia) {
+                        mediaDetailsMetadataList.push({
+                            id: expression.mediaId || expression.previewMedia?.mediaId || randomBytes(32).toString('hex'),
+                            previewMedia
+                        });
+                    }
                 }
                 break;
+            }
         }
     }
     return { sources, mediaDetailsMetadataList };
@@ -336,7 +353,7 @@ const richMenuButton = (button, toast = '') => {
  * buttonsMessage/nativeFlowMessage payload.
  */
 export const prepareRichMenuMessage = (content = {}) => {
-    const { header = {}, body = {}, footer = {} } = content || {};
+    const { header = {}, body = {}, footer = {}, verificationMetadata } = content || {};
     const sections = [];
     const title = header?.title || '';
     if (title) {
@@ -418,7 +435,7 @@ export const prepareRichMenuMessage = (content = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 /**
@@ -432,7 +449,7 @@ export const prepareRichMenuMessage = (content = {}) => {
  * @returns {Object} Wrapped botForwardedMessage ready for relayMessage
  */
 export const prepareCopyToClipboardMessage = (options = {}) => {
-    const { text = '', label, alignment = 'END' } = options;
+    const { text = '', label, alignment = 'END', verificationMetadata } = options;
     const displayText = label || text;
     const sections = [
         {
@@ -458,7 +475,7 @@ export const prepareCopyToClipboardMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 /**
@@ -470,7 +487,7 @@ export const prepareCopyToClipboardMessage = (options = {}) => {
  * @returns {Object} Wrapped botForwardedMessage ready for relayMessage
  */
 export const prepareRichTextMessage = (options = {}) => {
-    const { text = '' } = options;
+    const { text = '', verificationMetadata } = options;
     const sections = [
         {
             __typename: 'GenAIUnifiedResponseSection',
@@ -491,12 +508,12 @@ export const prepareRichTextMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 /** Builds Markdown text with an optional GenAI COPY_TO_CLIPBOARD action section. */
 export const prepareRichQuoteMessage = (options = {}) => {
-    const { text = '', copyText, copyLabel = copyText, alignment = 'END' } = options;
+    const { text = '', copyText, copyLabel = copyText, alignment = 'END', verificationMetadata } = options;
     const sections = [{
         __typename: 'GenAIUnifiedResponseSection',
         view_model: {
@@ -522,7 +539,7 @@ export const prepareRichQuoteMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 /**
@@ -535,7 +552,7 @@ export const prepareRichQuoteMessage = (options = {}) => {
  * @returns {Object} Wrapped botForwardedMessage ready for relayMessage
  */
 export const prepareRichImageMessage = (options = {}) => {
-    const { url = '', mimeType = 'image/png' } = options;
+    const { url = '', mimeType = 'image/png', verificationMetadata } = options;
     const media = {
         __typename: 'GenAIMediaItem',
         mime_type: mimeType,
@@ -562,7 +579,7 @@ export const prepareRichImageMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 
@@ -575,7 +592,7 @@ export const prepareRichImageMessage = (options = {}) => {
  * @returns {Object} Wrapped botForwardedMessage ready for relayMessage
  */
 export const prepareRichLinkMessage = (options = {}) => {
-    const { links = [], text: fallbackText } = options;
+    const { links = [], text: fallbackText, verificationMetadata } = options;
     const sections = [];
     const allInlineEntities = [];
     let combinedText = '';
@@ -629,11 +646,11 @@ export const prepareRichLinkMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 export const prepareRichResponseMessage = (content) => {
-    const { alignment, code, contentText, disclaimerText, footerText, headerText, imageText, inlineImage, inlineVideo, items, language, latex, links, noDonation, noHeading, posts, products, reels, sources: sourceInputs, suggested, richResponse, table, tapLinkUrl, title } = content;
+    const { alignment, code, contentText, disclaimerText, footerText, headerText, imageText, inlineImage, inlineVideo, items, language, latex, links, noDonation, noHeading, posts, products, reels, sources: sourceInputs, suggested, richResponse, table, tapLinkUrl, title, verificationMetadata } = content;
     let submessages = [];
     if (Array.isArray(richResponse)) {
         submessages = richResponse.map((submessage) => {
@@ -879,7 +896,7 @@ export const prepareRichResponseMessage = (content) => {
             forwardOrigin: 4
         }
     });
-    const message = wrapToBotForwardedMessage(richResponseMessage);
+    const message = wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
     const botMetadata = message.messageContextInfo.botMetadata;
     // Lia@Note 13-05-26 --- Add disclaimer text on richResponseMessage
     if (disclaimerText) {
@@ -898,6 +915,11 @@ export const prepareRichResponseMessage = (content) => {
     return message;
 };
 // Lia@Note 17-04-26 --- signature and certificateChain for proofs[] field
+/**
+ * @deprecated Generates random bytes that verify against nothing. Kept only for
+ * experimental tooling; the library no longer attaches generated proofs to
+ * messages. Pass real proofs through the `verificationMetadata` option instead.
+ */
 export const botMetadataSignature = () => {
     const signature = new Uint8Array(64);
     getRandomValues(signature);
@@ -923,7 +945,7 @@ export const botMetadataCertificate = (length = 685) => {
  * @returns {Object} Wrapped botForwardedMessage ready for relayMessage
  */
 export const prepareHtmlMessage = (options = {}) => {
-    const { html = '', trustedSources = [] } = options;
+    const { html = '', trustedSources = [], verificationMetadata } = options;
     const sections = [
         {
             __typename: 'GenAIUnifiedResponseSection',
@@ -944,7 +966,7 @@ export const prepareHtmlMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 },
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
 /**
@@ -959,7 +981,8 @@ export const prepareRichHtmlMessage = (options = {}) => {
         url = '',
         title = 'Preview',
         tabHeader = 'HTML',
-        tabs
+        tabs,
+        verificationMetadata
     } = options;
     const tabItems = Array.isArray(tabs) && tabs.length
         ? tabs
@@ -1003,26 +1026,55 @@ export const prepareRichHtmlMessage = (options = {}) => {
         unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
         contextInfo: { isForwarded: true, forwardingScore: 1, forwardOrigin: 4 }
     });
-    return wrapToBotForwardedMessage(richResponseMessage);
+    return wrapToBotForwardedMessage(richResponseMessage, verificationMetadata);
 };
 
-export const wrapToBotForwardedMessage = (richResponseMessage) => ({
+/**
+ * Proofs are forwarded only when the caller supplies real, verifiable proofs.
+ * The library never fabricates a certificate chain or signature: an unverifiable
+ * proof is worse than none, because it asserts provenance the caller cannot back.
+ */
+export const hasVerifiableProofs = (verificationMetadata) =>
+    Array.isArray(verificationMetadata?.proofs) && verificationMetadata.proofs.length > 0;
+
+/**
+ * Attach trusted verification proofs to an already-built rich envelope.
+ *
+ * Pure, null-safe, and idempotent: returns the envelope untouched when no
+ * verifiable proofs are supplied or when the envelope carries no botMetadata.
+ * Used by the send pipeline (`relayMessage`) to auto-inject proofs configured
+ * once on the socket as `config.metaAiRendering.verificationMetadata`, so every
+ * rich message (menu, reels, rich text/image/link, HTML) is covered without each
+ * send method needing to thread the config through.
+ */
+export const attachBotVerificationProofs = (envelope, verificationMetadata) => {
+    if (!envelope || !hasVerifiableProofs(verificationMetadata))
+        return envelope;
+    const botMetadata = envelope?.messageContextInfo?.botMetadata;
+    if (!botMetadata || botMetadata.verificationMetadata)
+        return envelope;
+    botMetadata.verificationMetadata = verificationMetadata;
+    return envelope;
+};
+
+/**
+ * Wrap a rich response in the bot-forwarded envelope.
+ *
+ * @param {Object} richResponseMessage - proto.AIRichResponseMessage
+ * @param {Object} [verificationMetadata] - Trusted proofs supplied by the caller
+ *   (typically `config.metaAiRendering.verificationMetadata`). Omitted when absent
+ *   or empty, so no fabricated provenance is ever sent.
+ */
+export const wrapToBotForwardedMessage = (richResponseMessage, verificationMetadata) => ({
     messageContextInfo: {
         botMetadata: {
-            // Lia@Note 09-04-26 --- TODO: Fill verificationMetadata field
-            verificationMetadata: {
-                proofs: [
-                    {
-                        certificateChain: [
-                            botMetadataCertificate(),
-                            botMetadataCertificate(892)
-                        ],
-                        version: 1,
-                        useCase: 1,
-                        signature: botMetadataSignature()
-                    }
-                ]
-            }
+            pluginMetadata: {},
+            ...(hasVerifiableProofs(verificationMetadata) ? { verificationMetadata } : {}),
+            // Lia@Fix --- The Bloks rendering config is required for the client to resolve
+            // and verify rich media. Without it, rich messages attach media the client
+            // treats as unverified: "WhatsApp can't verify the security of this media",
+            // tapping Download crashes the app, and reel previews stop rendering.
+            botRenderingConfigMetadata: BOT_RENDERING_CONFIG_METADATA
         }
     },
     botForwardedMessage: {

package/lib/index.d.ts

@@ -266,8 +266,14 @@ export interface WASocket {
     sendBotDiagnostics(jid: string, content?: { text?: string; botBackend?: number; toolsUsed?: string[]; isThinking?: boolean; botJid?: string }, options?: Record<string, unknown>): Promise<unknown>;
     /** Send a rich response with experimental bot command metadata. */
     sendBotCommand(jid: string, content?: { text?: string; commandName?: string; commandDescription?: string; commandPrompt?: string; botJid?: string }, options?: Record<string, unknown>): Promise<unknown>;
+    /** Send an agentic execution plan, advertising AGENTIC_PLANNING and QUERY_PLAN. */
+    sendBotPlanning(jid: string, content?: { text?: string; steps?: Array<string | { title?: string; name?: string; body?: string }>; queryPlan?: boolean; botJid?: string }, options?: Record<string, unknown>): Promise<unknown>;
     /** Send a rich response with experimental resolved tool-call metadata. */
     sendBotToolResult(jid: string, content?: { text?: string; toolCallId?: string; resolutionData?: unknown; resolutionDataSerialized?: string; botJid?: string }, options?: Record<string, unknown>): Promise<unknown>;
+    /** Resolve a WhatsApp Channel invite code or invite URL to channel metadata. */
+    newsletterGetInviteInfo(inviteCodeOrUrl: string): Promise<Record<string, unknown> | null>;
+    /** React to a Channel post; pass an empty string, null, or undefined to remove the reaction. */
+    newsletterReactMessage(jid: string, serverId: string | number, reaction?: string | null): Promise<void>;
     /** Send Markdown text containing blockquotes in a forwarded GenAI rich response. */
     sendMarkdownQuote(jid: string, content?: { text?: string; copyText?: string; copyLabel?: string; alignment?: 'END' | 'START' | 'CENTER' }, options?: Record<string, unknown>): Promise<unknown>;
     /** Send Markdown blockquotes followed by a GenAI COPY_TO_CLIPBOARD action. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "plogme",
-  "version": "2.0.0",
-  "description": "Production-ready Baileys fork \u2689 with AI groups, Meta AI prompting, safe compositing fallbacks, rich responses, interactive messages, albums, newsletters, and communities \u2014 without antiban wrappers.",
+  "version": "2.0.2",
+  "description": "Production-ready Baileys fork ⚉ with AI groups, Meta AI prompting, safe compositing fallbacks, rich responses, interactive messages, albums, newsletters, and communities — without antiban wrappers.",
   "main": "lib/index.js",
   "type": "module",
   "scripts": {