plogme 2.1.1 → 2.1.2

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

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/rich-message-utils.js
+ * About: Rich message utils module for the Plogme WhatsApp protocol client.
+ * Important exports: tokenizeCode, normalizeNewReel, normalizeNewRichImage, prepareNewRichMediaCompatibility, toUnified, buildImaginePrimitive, prepareRichGenerationMessage, buildAdditionalBotMetadataContext; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 /**
  * Lia@Changes 09-04-26 [WIP]
  * Adds support for tables and code blocks with richResponseMessage (wrapped inside botForwardedMessage).
@@ -11,6 +23,7 @@ import { LANGUAGE_KEYWORDS } from '../WABinary/constants.js';
 import { CodeHighlightType, RichSubMessageType } from '../Types/RichType.js';
 import { proto } from '../../WAProto/index.js';
 import { unixTimestampSeconds } from './generics.js';
+import { generateTableContent } from './message-composer.js';
 const NOOP = new Set([]);
 export const tokenizeCode = (code, language = 'javascript') => {
     const keywords = LANGUAGE_KEYWORDS[language] || NOOP;
@@ -88,6 +101,54 @@ const buildRichImagePrimitive = (image = {}, expiration = String(Date.now() + 30
     primitive.dark_mode_full_image = media(darkFullUrl, darkWidth, darkHeight);
     return primitive;
 };
+
+/** Normalize the field names used by New compatibility's Meta/reels helpers. */
+export const normalizeNewReel = (reel = {}) => ({
+    reels_url: reel.videoUrl || reel.video_url || reel.reels_url || reel.reelsUrl || reel.url || '',
+    thumbnail_url: reel.thumbnailUrl || reel.thumbnail_url || reel.thumbnail || '',
+    creator: reel.creator || reel.username || reel.title || '',
+    avatar_url: reel.profileIconUrl || reel.avatar_url || reel.avatar || reel.icon || '',
+    reels_title: reel.title || reel.reels_title || reel.reelsTitle || '',
+    likes_count: reel.likesCount ?? reel.likes_count ?? reel.likes ?? 0,
+    comments_count: reel.commentsCount ?? reel.comments_count ?? reel.comments ?? 0,
+    shares_count: reel.sharesCount ?? reel.shares_count ?? reel.shares ?? 0,
+    view_count: reel.viewCount ?? reel.view_count ?? reel.views ?? 0,
+    reel_source: reel.reelSource || reel.reel_source || reel.source || 'IG',
+    is_verified: !!(reel.isVerified ?? reel.is_verified ?? reel.verified),
+    orientation: reel.orientation || reel.ratio || 'LANDSCAPE',
+    post_type: reel.postType || reel.post_type || 'VIDEO',
+    is_carousel: reel.isCarousel ?? reel.is_carousel ?? false
+});
+
+/** Build the New-compatible image/post shape without replacing native image data. */
+export const normalizeNewRichImage = (image = {}) => ({
+    thumbnail_url: image.thumbnailUrl || image.thumbnail_url || image.thumbnail || image.previewUrl || image.preview_url || '',
+    image_url: image.imageUrl || image.image_url || image.fullUrl || image.full_url || image.url || '',
+    source_url: image.sourceUrl || image.source_url || image.url || '',
+    title: image.title || image.caption || '',
+    creator: image.creator || image.username || '',
+    avatar_url: image.profileIconUrl || image.avatar_url || image.avatar || '',
+    is_verified: !!(image.isVerified ?? image.is_verified ?? image.verified),
+    post_caption: image.postCaption || image.post_caption || image.caption || '',
+    likes_count: image.likesCount ?? image.likes_count ?? image.likes ?? 0,
+    comments_count: image.commentsCount ?? image.comments_count ?? image.comments ?? 0,
+    shares_count: image.sharesCount ?? image.shares_count ?? image.shares ?? 0,
+    orientation: image.orientation || image.ratio || 'LANDSCAPE',
+    post_type: image.postType || image.post_type || 'IMAGE',
+    is_carousel: image.isCarousel ?? image.is_carousel ?? false
+});
+
+/** Create the second New-shaped representation beside native AIRich sections. */
+export const prepareNewRichMediaCompatibility = (content = {}) => {
+    const reels = (Array.isArray(content.reels) ? content.reels : []).map(normalizeNewReel);
+    const images = (Array.isArray(content.images) ? content.images : content.image ? [content.image] : []).map(normalizeNewRichImage);
+    const posts = (Array.isArray(content.posts) ? content.posts : content.post ? [content.post] : []).map(normalizeNewRichImage);
+    const sections = [];
+    if (reels.length) sections.push({ view_model: { primitives: reels.map(item => ({ ...item, __typename: 'GenAIReelPrimitive' })), __typename: 'GenAIHScrollLayoutViewModel' } });
+    if (images.length) sections.push({ view_model: { primitives: images.map(item => ({ ...item, __typename: 'GenAIImagePrimitive' })), __typename: 'GenAIHScrollLayoutViewModel' } });
+    if (posts.length) sections.push({ view_model: { primitives: posts.map(item => ({ ...item, __typename: 'GenAIPostPrimitive' })), __typename: 'GenAIHScrollLayoutViewModel' } });
+    return { compatibility: 'new-rich-media', reels, images, posts, sections };
+};
 // Lia@Changes 09-04-26 --- Inject buffer into unifiedResponse.data to support proper rendering of rich messages (ex: tables and code blocks)
 export const toUnified = (submessages, uuid) => ({
     response_id: uuid || randomUUID(),
@@ -1388,8 +1449,8 @@ const buildRichHtmlScreen = (options = {}) => {
     };
 };
 
-export const prepareRichResponseMessage = (content) => {
-    const { alignment, code, contentText, disclaimerText, footerText, headerText, html, richHtml, trustedSources, imageText, inlineImage, inlineVideo, items, language, latex, links, noDonation, noHeading, posts, products, reels, sources: sourceInputs, suggested, richResponse, table, tapLinkUrl, title, verificationMetadata, sections: rawSections, richSections, copyButton, copyToClipboard, copyText, copyLabel, richText, quote, richImage, richLinks, richMap, map, dynamicMedia, richDynamicMedia, socialEntity, socialProfile, richMenu, airichCommandMenu, unifiedResponse, gridImages, verticalAlbum, videoGrid, richGeneration, richLabel, suggestedPrompt, botSources, botPttTranscript } = content;
+const prepareRichResponseMessageFixedOrder = (content) => {
+    const { alignment, code, compatibility, contentText, disclaimerText, footerText, headerText, html, richHtml, trustedSources, imageText, image, images, inlineImage, inlineVideo, items, language, latex, links, noDonation, noHeading, posts, products, reels, sources: sourceInputs, suggested, richResponse, table, tapLinkUrl, title, verificationMetadata, sections: rawSections, richSections, copyButton, copyToClipboard, copyText, copyLabel, richText, quote, richImage, richLinks, richMap, map, dynamicMedia, richDynamicMedia, socialEntity, socialProfile, richMenu, airichCommandMenu, unifiedResponse, gridImages, verticalAlbum, videoGrid, richGeneration, richLabel, suggestedPrompt, botSources, botPttTranscript } = content;
     let submessages = [];
     const extraSections = [];
     if (Array.isArray(richResponse)) {
@@ -1547,11 +1608,11 @@ export const prepareRichResponseMessage = (content) => {
                 view_model: {
                     primitive: buildImaginePrimitive({
                         mediaType: 'video',
-                        url: video?.url || video?.videoUrl || '',
-                        mimeType: video?.mimeType || video?.mime_type || 'video/mp4',
-                        fileLength: video?.fileLength || video?.file_length || 0,
-                        duration: video?.duration || 0,
-                        thumbnail: video?.thumbnail,
+                        url: video?.url || video?.videoUrl || video?.video_url || '',
+                        mimeType: video?.mimeType || video?.mime_type || video?.mimetype || 'video/mp4',
+                        fileLength: video?.fileLength ?? video?.file_length ?? video?.filesize ?? 0,
+                        duration: video?.duration ?? 0,
+                        thumbnail: video?.thumbnail || video?.thumbnailUrl || video?.thumbnail_url,
                         status: video?.status || 'READY'
                     }),
                     __typename: 'GenAISingleLayoutViewModel'
@@ -1687,14 +1748,14 @@ export const prepareRichResponseMessage = (content) => {
                 messageText: 'SUGGESTED_PROMPT'
             });
         }
-        if (table) {
+        if (Array.isArray(table)) {
             submessages.push({
                 messageType: RichSubMessageType.TABLE,
                 tableMetadata: {
                     title,
                     rows: table.map((items, index) => ({
                         isHeading: !noHeading && index == 0,
-                        items
+                        items: Array.isArray(items) ? items.map(String) : [String(items)]
                     }))
                 }
             });
@@ -1734,6 +1795,16 @@ export const prepareRichResponseMessage = (content) => {
     const uuid = randomUUID();
     const unified = toUnified(submessages, uuid);
     unified.sections = [...unified.sections.filter(Boolean), ...extraSections];
+    if (compatibility === 'new-rich-media' || compatibility === 'both') {
+        const compatible = prepareNewRichMediaCompatibility({ reels, images: images || (inlineImage ? [inlineImage] : image ? [image] : []), posts });
+        unified.sections.push(...compatible.sections);
+        unified.new_rich_media = {
+            compatibility: compatible.compatibility,
+            reels: compatible.reels,
+            images: compatible.images,
+            posts: compatible.posts
+        };
+    }
     if (richHtmlScreen) unified.embedded_screens = [richHtmlScreen.embeddedScreen];
 
     // Compose the remaining AIRich convenience formats as sections. These
@@ -1888,6 +1959,216 @@ const decodePreparedUnified = (prepared) => {
     }
 };
 
+/**
+ * Compose each rich fragment in the order its key appears in the caller's
+ * object. The fixed-order renderer remains the single source of wire formats;
+ * this wrapper only orders independently rendered sections before combining
+ * them into one AIRich response.
+ */
+export const prepareRichResponseMessage = (content = {}) => {
+    if (!content || typeof content !== 'object' || Array.isArray(content)) {
+        throw new Boom('rich response content must be an object', { statusCode: 400 });
+    }
+    const submessages = [];
+    const sections = [];
+    const embeddedScreens = [];
+    const mergedBotMetadata = {};
+    const compatibility = content.compatibility === 'new-rich-media' || content.compatibility === 'both';
+    let compatibilityAdded = false;
+    let newRichMedia;
+
+    const appendPrepared = (prepared) => {
+        const unified = decodePreparedUnified(prepared);
+        if (Array.isArray(unified?.sections)) sections.push(...unified.sections.filter(Boolean));
+        if (Array.isArray(unified?.embedded_screens)) embeddedScreens.push(...unified.embedded_screens);
+        const richResponse = prepared?.botForwardedMessage?.message?.richResponseMessage;
+        if (Array.isArray(richResponse?.submessages)) submessages.push(...richResponse.submessages);
+        const botMetadata = prepared?.messageContextInfo?.botMetadata;
+        if (botMetadata) Object.assign(mergedBotMetadata, botMetadata);
+    };
+
+    const appendField = (key, value) => {
+        const fragment = { noDonation: true, verificationMetadata: content.verificationMetadata };
+        switch (key) {
+            case 'text':
+                fragment.contentText = value;
+                break;
+            case 'table':
+                appendTableValue(value);
+                return;
+            case 'code':
+                fragment.code = value;
+                fragment.language = content.language;
+                break;
+            case 'inlineImage':
+                fragment.inlineImage = value;
+                fragment.imageText = content.imageText;
+                fragment.alignment = content.alignment;
+                fragment.tapLinkUrl = content.tapLinkUrl;
+                break;
+            case 'html':
+                fragment.html = value;
+                fragment.trustedSources = content.trustedSources;
+                break;
+            case 'richHtml':
+                fragment.richHtml = value;
+                fragment.trustedSources = content.trustedSources;
+                break;
+            case 'richTable':
+                appendTableValue(value);
+                return;
+            case 'tables':
+                if (Array.isArray(value)) value.forEach(appendTableValue);
+                return;
+            case 'richResponse': {
+                if (!Array.isArray(value)) break;
+                for (const item of value) {
+                    if (item?.inlineVideo) appendField('inlineVideo', item.inlineVideo);
+                    else if (Object.hasOwn(item || {}, 'table')) appendField('table', item.table);
+                    else if (item?.posts) appendField('posts', item.posts);
+                    else if (item?.products) appendField('products', item.products);
+                    else if (item?.suggested) appendField('suggested', item.suggested);
+                    else appendPrepared(prepareRichResponseMessageFixedOrder({
+                        richResponse: [item],
+                        noDonation: true,
+                        verificationMetadata: content.verificationMetadata
+                    }));
+                }
+                return;
+            }
+            case 'contentItemsGroup':
+                Object.assign(fragment, value);
+                break;
+            default:
+                fragment[key] = value;
+        }
+        appendPrepared(prepareRichResponseMessageFixedOrder(fragment));
+    };
+
+    const appendSimpleTable = (tableRows) => {
+        const normalizedRows = tableRows.map(row => Array.isArray(row) ? row : [row]);
+        appendPrepared(prepareRichResponseMessageFixedOrder({
+            table: normalizedRows,
+            title: content.title,
+            noHeading: content.noHeading,
+            noDonation: true,
+            verificationMetadata: content.verificationMetadata
+        }));
+    };
+
+    const appendRichTable = (table) => {
+        if (!table || typeof table !== 'object' || Array.isArray(table)) return;
+        const richTable = generateTableContent(
+            String(table.title ?? ''),
+            Array.isArray(table.headers) ? table.headers : [],
+            Array.isArray(table.rows) ? table.rows : [],
+            undefined,
+            { headerText: table.headerText, footer: table.footer }
+        );
+        const richResponse = richTable?.message?.botForwardedMessage?.message?.richResponseMessage;
+        if (Array.isArray(richResponse?.submessages)) submessages.push(...richResponse.submessages);
+    };
+
+    const appendTableValue = (table) => {
+        if (Array.isArray(table)) {
+            appendSimpleTable(table);
+            return;
+        }
+        if (!table || typeof table !== 'object') return;
+        if (Array.isArray(table.headers) && Array.isArray(table.rows)) {
+            appendRichTable(table);
+        }
+        else if (Array.isArray(table.rows)) {
+            appendSimpleTable([...(Array.isArray(table.headers) ? [table.headers] : []), ...table.rows]);
+        }
+    };
+
+    const appendCompatibility = () => {
+        if (compatibilityAdded || !compatibility) return;
+        compatibilityAdded = true;
+        const compatible = prepareNewRichMediaCompatibility({
+            reels: content.reels,
+            images: content.images || (content.image ? [content.image] : []),
+            posts: content.posts
+        });
+        if (!compatible.sections.length) return;
+        sections.push(...compatible.sections);
+        newRichMedia = {
+            compatibility: compatible.compatibility,
+            reels: compatible.reels,
+            images: compatible.images,
+            posts: compatible.posts
+        };
+    };
+
+    const nonRenderableKeys = new Set([
+        'alignment', 'compatibility', 'copyLabel', 'disclaimerText',
+        'image', 'images', 'language', 'noDonation', 'noHeading', 'title',
+        'tapLinkUrl', 'trustedSources', 'verificationMetadata'
+    ]);
+    const renderableKeys = new Set([
+        'headerText', 'contentText', 'text', 'footerText', 'code', 'table', 'richTable', 'tables', 'items', 'reels',
+        'inlineImage', 'inlineVideo', 'latex', 'links', 'sources', 'posts', 'products', 'suggested',
+        'html', 'richHtml', 'richResponse', 'copyButton', 'copyToClipboard', 'copyText',
+        'richText', 'quote', 'richImage', 'richLinks', 'richMap', 'map', 'dynamicMedia',
+        'richDynamicMedia', 'socialEntity', 'socialProfile', 'richMenu', 'airichCommandMenu',
+        'unifiedResponse', 'gridImages', 'verticalAlbum', 'videoGrid', 'richGeneration',
+        'richLabel', 'suggestedPrompt', 'botSources', 'botPttTranscript', 'sections', 'richSections'
+    ]);
+    const inputEntries = Object.entries(content);
+    const entries = [
+        ...inputEntries.filter(([key]) => key === 'headerText'),
+        ...inputEntries.filter(([key]) => key !== 'headerText' && key !== 'footerText'),
+        ...inputEntries.filter(([key]) => key === 'footerText')
+    ];
+    for (let index = 0; index < entries.length; index++) {
+        const [key, value] = entries[index];
+        if (['reels', 'images', 'image', 'posts'].includes(key)) appendCompatibility();
+        if (key === 'items' || key === 'reels') {
+            const grouped = {};
+            let nextIndex = index;
+            while (nextIndex < entries.length && ['items', 'reels'].includes(entries[nextIndex][0])) {
+                const [groupKey, groupValue] = entries[nextIndex];
+                grouped[groupKey] = groupValue;
+                nextIndex++;
+            }
+            if (Object.hasOwn(grouped, 'reels')) appendCompatibility();
+            appendField('contentItemsGroup', grouped);
+            index = nextIndex - 1;
+            continue;
+        }
+        if (!renderableKeys.has(key) || nonRenderableKeys.has(key)) continue;
+        appendField(key, value);
+    }
+
+    if (content.noDonation !== true) {
+        appendPrepared(prepareRichResponseMessageFixedOrder({ links: [], noDonation: false }));
+    }
+
+    const responseId = randomUUID();
+    const unified = {
+        response_id: responseId,
+        sections,
+        ...(embeddedScreens.length ? { embedded_screens: embeddedScreens } : {}),
+        ...(newRichMedia ? { new_rich_media: newRichMedia } : {})
+    };
+    const richResponseMessage = proto.AIRichResponseMessage.create({
+        submessages,
+        messageType: proto.AIRichResponseMessageType.AI_RICH_RESPONSE_TYPE_STANDARD,
+        unifiedResponse: { data: Buffer.from(JSON.stringify(unified)) },
+        contextInfo: { isForwarded: true, forwardingScore: 1, forwardedAiBotMessageInfo: { botJid: '867051314767696@bot' }, forwardOrigin: 4 }
+    });
+    const message = wrapToBotForwardedMessage(richResponseMessage, content.verificationMetadata);
+    const botMetadata = message.messageContextInfo.botMetadata;
+    Object.assign(botMetadata, mergedBotMetadata);
+    if (content.disclaimerText) botMetadata.messageDisclaimerText = content.disclaimerText;
+    botMetadata.botResponseId = responseId;
+    const { sources, mediaDetailsMetadataList } = buildAdditionalBotMetadataContext(submessages);
+    if (sources.length > 0) botMetadata.richResponseSourcesMetadata = { sources };
+    if (mediaDetailsMetadataList.length > 0) botMetadata.unifiedResponseMutation = { mediaDetailsMetadataList };
+    return message;
+};
+
 /** Merge any prepared AIRich helper into a single PLOGME response. */
 const appendPreparedRichContent = (target, prepared) => {
     const unified = decodePreparedUnified(prepared);

package/lib/Utils/signal.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/signal.js
+ * About: Signal module for the Plogme WhatsApp protocol client.
+ * Important exports: createSignalIdentity, getPreKeys, generateOrGetPreKeys, xmppSignedPreKey, xmppPreKey, extractE2ESessionFromRetryReceipt, parseAndInjectE2ESessions, extractDeviceJids; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { KEY_BUNDLE_TYPE } from '../Defaults/index.js';
 import { assertNodeErrorFree, getBinaryNodeChild, getBinaryNodeChildBuffer, getBinaryNodeChildren, getBinaryNodeChildUInt, getServerFromDomainType, jidDecode, S_WHATSAPP_NET, WAJIDDomains } from '../WABinary/index.js';
 import { Curve, generateSignalPubKey } from './crypto.js';

package/lib/Utils/source-grep.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/source-grep.js
+ * About: Source grep module for the Plogme WhatsApp protocol client.
+ * Important exports: grepSource
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import fs from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';

package/lib/Utils/stanza-ack.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/stanza-ack.js
+ * About: Stanza ack module for the Plogme WhatsApp protocol client.
+ * Important exports: buildAckStanza
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 /**
  * Builds an ACK stanza for a received node.
  * Pure function -- no I/O, no side effects.

package/lib/Utils/sync-action-utils.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/sync-action-utils.js
+ * About: Sync action utils module for the Plogme WhatsApp protocol client.
+ * Important exports: processContactAction, emitSyncActionResults
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { proto } from '../../WAProto/index.js';
 import { isLidUser, isPnUser } from '../WABinary/index.js';
 /**

package/lib/Utils/tc-token-utils.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/tc-token-utils.js
+ * About: Tc token utils module for the Plogme WhatsApp protocol client.
+ * Important exports: TC_TOKEN_INDEX_KEY, readTcTokenIndex, buildMergedTcTokenIndexWrite, isTcTokenExpired, shouldSendNewTcToken, resolveTcTokenJid, resolveIssuanceJid, buildTcTokenFromJid; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { getBinaryNodeChild, getBinaryNodeChildren, isHostedLidUser, isHostedPnUser, isJidMetaAI, isLidUser, isPnUser, jidNormalizedUser } from '../WABinary/index.js';
 // Same phone-number pattern as WABinary's isJidBot, applied against the user
 // part so the check is invariant to @c.us ↔ @s.whatsapp.net normalization.

package/lib/Utils/use-multi-file-auth-state.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/use-multi-file-auth-state.js
+ * About: Use multi file auth state module for the Plogme WhatsApp protocol client.
+ * Important exports: useMultiFileAuthState
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { Mutex } from 'async-mutex';
 import { mkdir, readFile, stat, unlink, writeFile } from 'fs/promises';
 import { join } from 'path';

package/lib/Utils/use-single-file-auth-state.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/use-single-file-auth-state.js
+ * About: Use single file auth state module for the Plogme WhatsApp protocol client.
+ * Important exports: useSingleFileAuthState
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { readFile, rename, stat, writeFile } from 'fs/promises';
 import { DEFAULT_CACHE_TTLS } from '../Defaults/index.js';
 import { proto } from '../../WAProto/index.js';

package/lib/Utils/use-sqlite-auth-state.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/use-sqlite-auth-state.js
+ * About: Use sqlite auth state module for the Plogme WhatsApp protocol client.
+ * Important exports: useSqliteAuthState
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { mkdir, readFile, stat, unlink, writeFile } from 'fs/promises';
 import { join } from 'path';
 import { proto } from '../../WAProto/index.js';

package/lib/Utils/validate-connection.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/validate-connection.js
+ * About: Validate connection module for the Plogme WhatsApp protocol client.
+ * Important exports: generateLoginNode, generateRegistrationNode, configureSuccessfulPairing, encodeSignedDeviceIdentity
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { Boom } from '@hapi/boom';
 import { createHash } from 'crypto';
 import { proto } from '../../WAProto/index.js';

package/lib/Utils/view-once-utils.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/view-once-utils.js
+ * About: View once utils module for the Plogme WhatsApp protocol client.
+ * Important exports: isViewOnceMessage, extractViewOnceContent, getViewOnceMediaType, getViewOnceMediaContent, downloadViewOnceMedia, createRegularMessageFromViewOnce, shouldAutoDecryptViewOnce, shouldDeleteViewOnce; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 /**
  * View-Once Message Utilities
  * 

package/lib/Utils/voip-rekey.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/voip-rekey.js
+ * About: Voip rekey module for the Plogme WhatsApp protocol client.
+ * Important exports: decodeE2eRekeyPayload
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { proto } from '../../WAProto/index.js';
 
 const REKEY_TYPE_NAMES = {

package/lib/Utils/welcome-flow.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/Utils/welcome-flow.js
+ * About: Welcome flow module for the Plogme WhatsApp protocol client.
+ * Important exports: createWelcomeFlow
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 /**
  * Lia@Changes [WIP]
  * Welcome Flow — Meta Business-style startup template.

package/lib/WABinary/constants.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/WABinary/constants.js
+ * About: Constants module for the Plogme WhatsApp protocol client.
+ * Important exports: TAGS, DOUBLE_BYTE_TOKENS, SINGLE_BYTE_TOKENS, TOKEN_MAP, CPP_KEYWORDS, CSS_KEYWORDS, GO_KEYWORDS, HTML_KEYWORDS; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 export const TAGS = {
     LIST_EMPTY: 0,
     DICTIONARY_0: 236,

package/lib/WABinary/decode.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/WABinary/decode.js
+ * About: Decode module for the Plogme WhatsApp protocol client.
+ * Important exports: decompressingIfRequired, decodeDecompressedBinaryNode, decodeBinaryNode
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { promisify } from 'util';
 import { inflate } from 'zlib';
 import * as constants from './constants.js';

package/lib/WABinary/encode.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/WABinary/encode.js
+ * About: Encode module for the Plogme WhatsApp protocol client.
+ * Important exports: encodeBinaryNode
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import * as constants from './constants.js';
 import { jidDecode } from './jid-utils.js';
 export const encodeBinaryNode = (node, opts = constants, buffer = [0]) => {

package/lib/WABinary/generic-utils.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/WABinary/generic-utils.js
+ * About: Generic utils module for the Plogme WhatsApp protocol client.
+ * Important exports: getBinaryNodeChildren, getBinaryNodeChild, getAllBinaryNodeChildren, getBinaryNodeChildBuffer, getBinaryNodeChildString, getBinaryNodeChildUInt, assertNodeErrorFree, reduceBinaryNodeToDictionary; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 import { Boom } from '@hapi/boom';
 import { randomBytes } from 'crypto';
 import { proto } from '../../WAProto/index.js';

package/lib/WABinary/index.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/WABinary/index.js
+ * About: WABinary module for the Plogme WhatsApp protocol client.
+ * Important exports: No public exports detected; module side effects or declarations are local.
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 export * from './encode.js';
 export * from './decode.js';
 export * from './generic-utils.js';

package/lib/WABinary/jid-utils.js

@@ -1,3 +1,15 @@
+/**
+ * @crysnpvax
+ *
+ * File: lib/WABinary/jid-utils.js
+ * About: Jid utils module for the Plogme WhatsApp protocol client.
+ * Important exports: S_WHATSAPP_NET, OFFICIAL_BIZ_JID, SERVER_JID, PSA_WID, STORIES_JID, META_AI_JID, WAJIDDomains, getServerFromDomainType; …
+ * Directions: Import the listed exports and preserve protocol, validation, and compatibility invariants when modifying.
+ *
+ * Copyright and attribution notice.
+ * Do not copy, reproduce, redistribute, modify, or create derivative works
+ * from this source without explicit written permission.
+ */
 export const S_WHATSAPP_NET = '@s.whatsapp.net';
 export const OFFICIAL_BIZ_JID = '16505361212@c.us';
 export const SERVER_JID = 'server@c.us';