@codexverified/baileys 2.7.5

package/lib/WAM/encode.js

@@ -0,0 +1,149 @@
+import { BinaryInfo } from './BinaryInfo.js';
+import { FLAG_BYTE, FLAG_EVENT, FLAG_EXTENDED, FLAG_FIELD, FLAG_GLOBAL, WEB_EVENTS, WEB_GLOBALS } from './constants.js';
+const getHeaderBitLength = (key) => (key < 256 ? 2 : 3);
+export const encodeWAM = (binaryInfo) => {
+    binaryInfo.buffer = [];
+    encodeWAMHeader(binaryInfo);
+    encodeEvents(binaryInfo);
+    const totalSize = binaryInfo.buffer.map(a => a.length).reduce((a, b) => a + b);
+    const buffer = Buffer.alloc(totalSize);
+    let offset = 0;
+    for (const buffer_ of binaryInfo.buffer) {
+        buffer_.copy(buffer, offset);
+        offset += buffer_.length;
+    }
+    return buffer;
+};
+function encodeWAMHeader(binaryInfo) {
+    const headerBuffer = Buffer.alloc(8); // starting buffer
+    headerBuffer.write('WAM', 0, 'utf8');
+    headerBuffer.writeUInt8(binaryInfo.protocolVersion, 3);
+    headerBuffer.writeUInt8(1, 4); //random flag
+    headerBuffer.writeUInt16BE(binaryInfo.sequence, 5);
+    headerBuffer.writeUInt8(0, 7); // regular channel
+    binaryInfo.buffer.push(headerBuffer);
+}
+function encodeGlobalAttributes(binaryInfo, globals) {
+    for (const [key, _value] of Object.entries(globals)) {
+        const id = WEB_GLOBALS.find(a => a?.name === key).id;
+        let value = _value;
+        if (typeof value === 'boolean') {
+            value = value ? 1 : 0;
+        }
+        binaryInfo.buffer.push(serializeData(id, value, FLAG_GLOBAL));
+    }
+}
+function encodeEvents(binaryInfo) {
+    for (const [name, { props, globals }] of binaryInfo.events.map(a => Object.entries(a)[0])) {
+        encodeGlobalAttributes(binaryInfo, globals);
+        const event = WEB_EVENTS.find(a => a.name === name);
+        const props_ = Object.entries(props);
+        let extended = false;
+        for (const [, value] of props_) {
+            extended || (extended = value !== null);
+        }
+        const eventFlag = extended ? FLAG_EVENT : FLAG_EVENT | FLAG_EXTENDED;
+        binaryInfo.buffer.push(serializeData(event.id, -event.weight, eventFlag));
+        for (let i = 0; i < props_.length; i++) {
+            const [key, _value] = props_[i];
+            const id = event.props[key]?.[0];
+            extended = i < props_.length - 1;
+            let value = _value;
+            if (typeof value === 'boolean') {
+                value = value ? 1 : 0;
+            }
+            const fieldFlag = extended ? FLAG_EVENT : FLAG_FIELD | FLAG_EXTENDED;
+            binaryInfo.buffer.push(serializeData(id, value, fieldFlag));
+        }
+    }
+}
+function serializeData(key, value, flag) {
+    const bufferLength = getHeaderBitLength(key);
+    let buffer;
+    let offset = 0;
+    if (value === null) {
+        if (flag === FLAG_GLOBAL) {
+            buffer = Buffer.alloc(bufferLength);
+            offset = serializeHeader(buffer, offset, key, flag);
+            return buffer;
+        }
+    }
+    else if (typeof value === 'number' && Number.isInteger(value)) {
+        // is number
+        if (value === 0 || value === 1) {
+            buffer = Buffer.alloc(bufferLength);
+            offset = serializeHeader(buffer, offset, key, flag | ((value + 1) << 4));
+            return buffer;
+        }
+        else if (-128 <= value && value < 128) {
+            buffer = Buffer.alloc(bufferLength + 1);
+            offset = serializeHeader(buffer, offset, key, flag | (3 << 4));
+            buffer.writeInt8(value, offset);
+            return buffer;
+        }
+        else if (-32768 <= value && value < 32768) {
+            buffer = Buffer.alloc(bufferLength + 2);
+            offset = serializeHeader(buffer, offset, key, flag | (4 << 4));
+            buffer.writeInt16LE(value, offset);
+            return buffer;
+        }
+        else if (-2147483648 <= value && value < 2147483648) {
+            buffer = Buffer.alloc(bufferLength + 4);
+            offset = serializeHeader(buffer, offset, key, flag | (5 << 4));
+            buffer.writeInt32LE(value, offset);
+            return buffer;
+        }
+        else {
+            buffer = Buffer.alloc(bufferLength + 8);
+            offset = serializeHeader(buffer, offset, key, flag | (7 << 4));
+            buffer.writeDoubleLE(value, offset);
+            return buffer;
+        }
+    }
+    else if (typeof value === 'number') {
+        // is float
+        buffer = Buffer.alloc(bufferLength + 8);
+        offset = serializeHeader(buffer, offset, key, flag | (7 << 4));
+        buffer.writeDoubleLE(value, offset);
+        return buffer;
+    }
+    else if (typeof value === 'string') {
+        // is string
+        const utf8Bytes = Buffer.byteLength(value, 'utf8');
+        if (utf8Bytes < 256) {
+            buffer = Buffer.alloc(bufferLength + 1 + utf8Bytes);
+            offset = serializeHeader(buffer, offset, key, flag | (8 << 4));
+            buffer.writeUint8(utf8Bytes, offset++);
+        }
+        else if (utf8Bytes < 65536) {
+            buffer = Buffer.alloc(bufferLength + 2 + utf8Bytes);
+            offset = serializeHeader(buffer, offset, key, flag | (9 << 4));
+            buffer.writeUInt16LE(utf8Bytes, offset);
+            offset += 2;
+        }
+        else {
+            buffer = Buffer.alloc(bufferLength + 4 + utf8Bytes);
+            offset = serializeHeader(buffer, offset, key, flag | (10 << 4));
+            buffer.writeUInt32LE(utf8Bytes, offset);
+            offset += 4;
+        }
+        buffer.write(value, offset, 'utf8');
+        return buffer;
+    }
+    throw 'missing';
+}
+function serializeHeader(buffer, offset, key, flag) {
+    if (key < 256) {
+        buffer.writeUInt8(flag, offset);
+        offset += 1;
+        buffer.writeUInt8(key, offset);
+        offset += 1;
+    }
+    else {
+        buffer.writeUInt8(flag | FLAG_BYTE, offset);
+        offset += 1;
+        buffer.writeUInt16LE(key, offset);
+        offset += 2;
+    }
+    return offset;
+}

package/lib/WAM/index.js

@@ -0,0 +1,3 @@
+export * from './constants.js';
+export * from './encode.js';
+export * from './BinaryInfo.js';

package/lib/WAUSync/Protocols/USyncBusinessProtocol.js

@@ -0,0 +1,96 @@
+import { assertNodeErrorFree, getBinaryNodeChild, getBinaryNodeChildren } from '../../WABinary/index.js';
+export class USyncBusinessProtocol {
+    constructor(profileVersion = '2') {
+        this.name = 'business';
+        this.profileVersion = profileVersion;
+    }
+    getQueryElement() {
+        return {
+            tag: 'business',
+            attrs: {},
+            content: [
+                { tag: 'verified_name', attrs: {} },
+                { tag: 'profile', attrs: { v: this.profileVersion } }
+            ]
+        };
+    }
+    getUserElement(user) {
+        const children = [];
+        if (user.verifiedNameSerial) {
+            children.push({ tag: 'verified_name', attrs: { serial: user.verifiedNameSerial } });
+        }
+        if (user.businessProfileTag) {
+            children.push({ tag: 'profile', attrs: { tag: user.businessProfileTag } });
+        }
+        return children.length > 0 ? { tag: 'business', attrs: {}, content: children } : null;
+    }
+    parser(node) {
+        if (node.tag !== 'business') return null;
+        assertNodeErrorFree(node);
+        const verifiedNameNode = getBinaryNodeChild(node, 'verified_name');
+        const profileNode = getBinaryNodeChild(node, 'profile');
+
+        // Business hours: profile may contain a business_hours child with business_hours_config children
+        let businessHours = undefined;
+        if (profileNode) {
+            const businessHoursNode = getBinaryNodeChild(profileNode, 'business_hours');
+            if (businessHoursNode) {
+                const configs = getBinaryNodeChildren(businessHoursNode, 'business_hours_config');
+                businessHours = {
+                    timezone: businessHoursNode.attrs?.timezone ?? null,
+                    config: configs.map(({ attrs }) => ({
+                        dayOfWeek: attrs?.day_of_week ?? null,
+                        openTime: attrs?.open_time ?? null,
+                        closeTime: attrs?.close_time ?? null,
+                        mode: attrs?.mode ?? null
+                    }))
+                };
+            }
+        }
+
+        // Business address from profile child node
+        const addressNode = profileNode ? getBinaryNodeChild(profileNode, 'address') : null;
+        const businessAddress = addressNode?.content
+            ? Buffer.isBuffer(addressNode.content)
+                ? addressNode.content.toString()
+                : String(addressNode.content)
+            : (profileNode?.attrs?.address ?? null);
+
+        // Catalog status from profile attrs
+        const catalogStatus = profileNode
+            ? {
+                exists: profileNode.attrs?.catalog_exists === 'true' || profileNode.attrs?.catalog_exists === true,
+                sendAll: profileNode.attrs?.catalog_send_all === 'true' || profileNode.attrs?.catalog_send_all === true
+            }
+            : null;
+
+        // Cart flags from profile attrs
+        const cartEnabled =
+            profileNode?.attrs?.cart_enabled !== undefined
+                ? profileNode.attrs.cart_enabled === 'true' || profileNode.attrs.cart_enabled === true
+                : null;
+        const webCartEnabled =
+            profileNode?.attrs?.web_cart_enabled !== undefined
+                ? profileNode.attrs.web_cart_enabled === 'true' || profileNode.attrs.web_cart_enabled === true
+                : null;
+        const webCartOnOff = profileNode?.attrs?.web_cart_on_off ?? null;
+
+        // Commerce experience from profile attrs
+        const commerceExperience = profileNode?.attrs?.commerce_experience ?? null;
+
+        return {
+            verifiedName: verifiedNameNode?.content ?? null,
+            verifiedLevel: verifiedNameNode?.attrs?.verified_level ?? null,
+            verifiedNameLevel: verifiedNameNode?.attrs?.verified_level ?? null,
+            profileTag: profileNode?.attrs?.tag ?? null,
+            pnJid: node.attrs?.pn_jid ?? null,
+            businessHours: businessHours ?? null,
+            businessAddress,
+            catalogStatus,
+            cartEnabled,
+            webCartEnabled,
+            webCartOnOff,
+            commerceExperience
+        };
+    }
+}

package/lib/WAUSync/Protocols/USyncContactProtocol.js

@@ -0,0 +1,56 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncContactProtocol {
+    constructor() {
+        this.name = 'contact';
+    }
+    getQueryElement() {
+        return {
+            tag: 'contact',
+            attrs: {}
+        };
+    }
+    getUserElement(user) {
+        if (user.phone) {
+            return {
+                tag: 'contact',
+                attrs: {},
+                content: user.phone
+            };
+        }
+        if (user.username) {
+            return {
+                tag: 'contact',
+                attrs: {
+                    username: user.username,
+                    ...(user.usernameKey ? { pin: user.usernameKey } : {}),
+                    ...(user.lid ? { lid: user.lid } : {})
+                }
+            };
+        }
+        if (user.type) {
+            return {
+                tag: 'contact',
+                attrs: {
+                    type: user.type
+                }
+            };
+        }
+        return {
+            tag: 'contact',
+            attrs: {}
+        };
+    }
+    parser(node) {
+        if (node.tag === 'contact') {
+            assertNodeErrorFree(node);
+            const inWA = node?.attrs?.type === 'in';
+            const restrictionType = node?.attrs?.stella_addressbook_restriction_type;
+            if (restrictionType !== undefined) {
+                // Return object with extra metadata when restriction type is present
+                return { inWA, stellaAddressbookRestrictionType: restrictionType };
+            }
+            return inWA;
+        }
+        return false;
+    }
+}

package/lib/WAUSync/Protocols/USyncDeviceProtocol.js

@@ -0,0 +1,53 @@
+import { assertNodeErrorFree, getBinaryNodeChild } from '../../WABinary/index.js';
+export class USyncDeviceProtocol {
+    constructor() {
+        this.name = 'devices';
+    }
+    getQueryElement() {
+        return {
+            tag: 'devices',
+            attrs: {
+                version: '2'
+            }
+        };
+    }
+    getUserElement( /* user: USyncUser */) {
+        //TODO: Implement device phashing, ts and expectedTs
+        //TODO: if all are not present, return null <- current behavior
+        //TODO: otherwise return a node w tag 'devices' w those as attrs
+        return null;
+    }
+    parser(node) {
+        const deviceList = [];
+        let keyIndex = undefined;
+        if (node.tag === 'devices') {
+            assertNodeErrorFree(node);
+            const deviceListNode = getBinaryNodeChild(node, 'device-list');
+            const keyIndexNode = getBinaryNodeChild(node, 'key-index-list');
+            if (Array.isArray(deviceListNode?.content)) {
+                for (const { tag, attrs } of deviceListNode.content) {
+                    const id = +attrs.id;
+                    const keyIndex = +attrs['key-index'];
+                    if (tag === 'device') {
+                        deviceList.push({
+                            id,
+                            keyIndex,
+                            isHosted: !!(attrs['is_hosted'] && attrs['is_hosted'] === 'true')
+                        });
+                    }
+                }
+            }
+            if (keyIndexNode?.tag === 'key-index-list') {
+                keyIndex = {
+                    timestamp: +keyIndexNode.attrs['ts'],
+                    signedKeyIndex: keyIndexNode?.content,
+                    expectedTimestamp: keyIndexNode.attrs['expected_ts'] ? +keyIndexNode.attrs['expected_ts'] : undefined
+                };
+            }
+        }
+        return {
+            deviceList,
+            keyIndex
+        };
+    }
+}

package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.js

@@ -0,0 +1,26 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncDisappearingModeProtocol {
+    constructor() {
+        this.name = 'disappearing_mode';
+    }
+    getQueryElement() {
+        return {
+            tag: 'disappearing_mode',
+            attrs: {}
+        };
+    }
+    getUserElement() {
+        return null;
+    }
+    parser(node) {
+        if (node.tag === 'disappearing_mode') {
+            assertNodeErrorFree(node);
+            const duration = +node?.attrs.duration;
+            const setAt = new Date(+(node?.attrs.t || 0) * 1000);
+            return {
+                duration,
+                setAt
+            };
+        }
+    }
+}

package/lib/WAUSync/Protocols/USyncFeatureProtocol.js

@@ -0,0 +1,70 @@
+import { getBinaryNodeChild } from '../../WABinary/index.js';
+// Device feature flags that can be queried, ported from WhatsApp Web's
+// WAWebUsyncFeature module.
+export const USYNC_FEATURES = [
+    'document',
+    'encrypt',
+    'encrypt_blist',
+    'encrypt_contact',
+    'encrypt_group_gen2',
+    'encrypt_image',
+    'encrypt_location',
+    'encrypt_url',
+    'encrypt_v2',
+    'voip',
+    'voip_legacy',
+    'multi_agent',
+    'bot_eligible'
+];
+export class USyncFeatureProtocol {
+    /**
+     * @param {string[]} [features] feature names to query (defaults to all known)
+     */
+    constructor(features) {
+        this.name = 'feature';
+        this.features = features && features.length ? features : USYNC_FEATURES;
+    }
+    getQueryElement() {
+        return {
+            tag: 'feature',
+            attrs: {},
+            content: this.features.map(feature => ({ tag: feature, attrs: {} }))
+        };
+    }
+    getUserElement() {
+        return null;
+    }
+    parser(node) {
+        if (node.tag !== 'feature') {
+            return null;
+        }
+        const errorNode = getBinaryNodeChild(node, 'error');
+        if (errorNode) {
+            return {
+                errorCode: errorNode.attrs?.code ? +errorNode.attrs.code : undefined,
+                errorText: errorNode.attrs?.text
+            };
+        }
+        const CAMEL_MAP = {
+            encrypt_v2: 'encryptV2',
+            voip_legacy: 'voipLegacy',
+            multi_agent: 'multiAgent',
+            bot_eligible: 'botEligible',
+            encrypt_blist: 'encryptBlist',
+            encrypt_contact: 'encryptContact',
+            encrypt_group_gen2: 'encryptGroupGen2',
+            encrypt_image: 'encryptImage',
+            encrypt_location: 'encryptLocation',
+            encrypt_url: 'encryptUrl'
+        };
+        const features = {};
+        const children = Array.isArray(node.content) ? node.content : [];
+        for (const child of children) {
+            if (child?.attrs && child.attrs.value !== undefined) {
+                const key = CAMEL_MAP[child.tag] || child.tag;
+                features[key] = child.attrs.value;
+            }
+        }
+        return features;
+    }
+}

package/lib/WAUSync/Protocols/USyncPictureProtocol.js

@@ -0,0 +1,28 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncPictureProtocol {
+    constructor(type = 'image') {
+        this.name = 'picture';
+        // "image" for full resolution, "preview" for thumbnail
+        this.type = type;
+    }
+    getQueryElement() {
+        return {
+            tag: 'picture',
+            attrs: { type: this.type }
+        };
+    }
+    getUserElement(user) {
+        const attrs = {};
+        if (user.pictureId != null) attrs.id = String(user.pictureId);
+        return Object.keys(attrs).length > 0 ? { tag: 'picture', attrs } : null;
+    }
+    parser(node) {
+        if (node.tag !== 'picture') return null;
+        assertNodeErrorFree(node);
+        const id = node.attrs?.id ?? null;
+        const directPath = node.attrs?.direct_path ?? null;
+        const hash = node.attrs?.hash ?? null;
+        if (!id && !directPath) return null;
+        return { id, directPath, hash };
+    }
+}

package/lib/WAUSync/Protocols/USyncSidelistProtocol.js

@@ -0,0 +1,25 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncSidelistProtocol {
+    constructor(useLidAddressing = true) {
+        this.name = 'sidelist';
+        // When true, sends addressing_mode="lid"  required for interop/LID-mode contacts
+        this.useLidAddressing = useLidAddressing;
+    }
+    getQueryElement() {
+        const attrs = {};
+        if (this.useLidAddressing) attrs.addressing_mode = 'lid';
+        return { tag: 'sidelist', attrs };
+    }
+    getUserElement(user) {
+        if (user.sidelistDelete) {
+            return { tag: 'sidelist', attrs: { type: 'delete' } };
+        }
+        return null;
+    }
+    parser(node) {
+        if (node.tag !== 'sidelist' && node.tag !== 'side_list') return null;
+        assertNodeErrorFree(node);
+        // Returns minimal parsed data; the full side_list is parsed in USyncQuery
+        return { type: node.attrs?.type ?? null };
+    }
+}

package/lib/WAUSync/Protocols/USyncStatusProtocol.js

@@ -0,0 +1,37 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncStatusProtocol {
+    constructor() {
+        this.name = 'status';
+    }
+    getQueryElement() {
+        return {
+            tag: 'status',
+            attrs: {}
+        };
+    }
+    getUserElement() {
+        return null;
+    }
+    parser(node) {
+        if (node.tag === 'status') {
+            assertNodeErrorFree(node);
+            let status = node?.content?.toString() ?? null;
+            const setAt = new Date(+(node?.attrs.t || 0) * 1000);
+            if (!status) {
+                if (node.attrs?.code && +node.attrs.code === 401) {
+                    status = '';
+                }
+                else {
+                    status = null;
+                }
+            }
+            else if (typeof status === 'string' && status.length === 0) {
+                status = null;
+            }
+            return {
+                status,
+                setAt
+            };
+        }
+    }
+}

package/lib/WAUSync/Protocols/USyncTextStatusProtocol.js

@@ -0,0 +1,34 @@
+import { assertNodeErrorFree, getBinaryNodeChild } from '../../WABinary/index.js';
+export class USyncTextStatusProtocol {
+    constructor() {
+        this.name = 'text_status';
+    }
+    getQueryElement() {
+        return {
+            tag: 'text_status',
+            attrs: {}
+        };
+    }
+    getUserElement() {
+        return null;
+    }
+    parser(node) {
+        if (node.tag !== 'text_status') return null;
+        assertNodeErrorFree(node);
+        const lastUpdateTimeSec = node.attrs?.last_update_time ? +node.attrs.last_update_time : 0;
+        const ephemeralDurationSec = node.attrs?.ephemeral_duration_sec ? +node.attrs.ephemeral_duration_sec : 0;
+        const text = node.attrs?.text ?? null;
+        const emojiNode = getBinaryNodeChild(node, 'emoji');
+        const emoji = emojiNode?.attrs?.content ?? null;
+        // expiry is lastUpdateTime + ephemeralDuration (both in ms); 0 means no expiry
+        const expiresAt = ephemeralDurationSec > 0
+            ? new Date((lastUpdateTimeSec + ephemeralDurationSec) * 1000)
+            : null;
+        return {
+            text,
+            emoji,
+            setAt: new Date(lastUpdateTimeSec * 1000),
+            expiresAt
+        };
+    }
+}

package/lib/WAUSync/Protocols/USyncUsernameProtocol.js

@@ -0,0 +1,24 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncUsernameProtocol {
+    constructor() {
+        this.name = 'username';
+    }
+    getQueryElement() {
+        return {
+            tag: 'username',
+            attrs: {}
+        };
+    }
+    getUserElement(user) {
+        void user;
+        return null;
+    }
+    parser(node) {
+        if (node.tag === 'username') {
+            assertNodeErrorFree(node);
+            const username = node.content != null ? node.content.toString() : null;
+            return username && username.length > 0 ? username : null;
+        }
+        return null;
+    }
+}

package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.js

@@ -0,0 +1,50 @@
+import { getBinaryNodeChild, getBinaryNodeChildren, getBinaryNodeChildString } from '../../WABinary/index.js';
+import { USyncUser } from '../USyncUser.js';
+export class USyncBotProfileProtocol {
+    constructor() {
+        this.name = 'bot';
+    }
+    getQueryElement() {
+        return {
+            tag: 'bot',
+            attrs: {},
+            content: [{ tag: 'profile', attrs: { v: '1' } }]
+        };
+    }
+    getUserElement(user) {
+        return {
+            tag: 'bot',
+            attrs: {},
+            content: [{ tag: 'profile', attrs: { persona_id: user.personaId } }]
+        };
+    }
+    parser(node) {
+        const botNode = getBinaryNodeChild(node, 'bot');
+        const profile = getBinaryNodeChild(botNode, 'profile');
+        const commandsNode = getBinaryNodeChild(profile, 'commands');
+        const promptsNode = getBinaryNodeChild(profile, 'prompts');
+        const commands = [];
+        const prompts = [];
+        for (const command of getBinaryNodeChildren(commandsNode, 'command')) {
+            commands.push({
+                name: getBinaryNodeChildString(command, 'name'),
+                description: getBinaryNodeChildString(command, 'description')
+            });
+        }
+        for (const prompt of getBinaryNodeChildren(promptsNode, 'prompt')) {
+            prompts.push(`${getBinaryNodeChildString(prompt, 'emoji')} ${getBinaryNodeChildString(prompt, 'text')}`);
+        }
+        return {
+            isDefault: !!getBinaryNodeChild(profile, 'default'),
+            jid: node.attrs.jid,
+            name: getBinaryNodeChildString(profile, 'name'),
+            attributes: getBinaryNodeChildString(profile, 'attributes'),
+            description: getBinaryNodeChildString(profile, 'description'),
+            category: getBinaryNodeChildString(profile, 'category'),
+            personaId: profile.attrs['persona_id'],
+            commandsDescription: getBinaryNodeChildString(commandsNode, 'description'),
+            commands,
+            prompts
+        };
+    }
+}