@neelegirl/baileys 1.5.5 → 1.5.7

package/lib/Socket/mex.d.ts

@@ -0,0 +1,2 @@
+import type { BinaryNode } from '../WABinary/index.js';
+export declare const executeWMexQuery: <T>(variables: Record<string, unknown>, queryId: string, dataPath: string, query: (node: BinaryNode) => Promise<BinaryNode>, generateMessageTag: () => string) => Promise<T>;

package/lib/Socket/mex.js

@@ -0,0 +1,47 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const { Boom } = require("@hapi/boom")
+const { getBinaryNodeChild, S_WHATSAPP_NET }= require("../WABinary/index.js")
+const wMexQuery = (variables, queryId, query, generateMessageTag) => {
+    return query({
+        tag: 'iq',
+        attrs: {
+            id: generateMessageTag(),
+            type: 'get',
+            to: S_WHATSAPP_NET,
+            xmlns: 'w:mex'
+        },
+        content: [
+            {
+                tag: 'query',
+                attrs: { query_id: queryId },
+                content: Buffer.from(JSON.stringify({ variables }), 'utf-8')
+            }
+        ]
+    });
+};
+ const executeWMexQuery = async (variables, queryId, dataPath, query, generateMessageTag) => {
+    const result = await wMexQuery(variables, queryId, query, generateMessageTag);
+    const child = getBinaryNodeChild(result, 'result');
+    if (child?.content) {
+        const data = JSON.parse(child.content.toString());
+        if (data.errors && data.errors.length > 0) {
+            const errorMessages = data.errors.map((err) => err.message || 'Unknown error').join(', ');
+            const firstError = data.errors[0];
+            const errorCode = firstError.extensions?.error_code || 400;
+            throw new Boom(`GraphQL server error: ${errorMessages}`, { statusCode: errorCode, data: firstError });
+        }
+        const response = dataPath ? data?.data?.[dataPath] : data?.data;
+        if (typeof response !== 'undefined') {
+            return response;
+        }
+    }
+    const action = (dataPath || '').startsWith('xwa2_')
+        ? dataPath.substring(5).replace(/_/g, ' ')
+        : dataPath?.replace(/_/g, ' ');
+    throw new Boom(`Failed to ${action}, unexpected response structure.`, { statusCode: 400, data: result });
+};
+module.exports = {
+  executeWMexQuery
+}

package/lib/Socket/newsletter.d.ts

@@ -0,0 +1,147 @@
+import { SocketConfig, WAMediaUpload, NewsletterMetadata, NewsletterReactionMode, NewsletterViewRole, NewsletterFetchedUpdate, ContactAction } from '../Types'
+import { BinaryNode } from '../WABinary'
+
+export declare const makeNewsletterSocket: (config: SocketConfig) => {
+    subscribeNewsletterUpdates: (jid: string) => Promise<{
+        duration: string
+    }>
+    newsletterReactionMode: (jid: string, mode: NewsletterReactionMode) => Promise<void>
+    newsletterUpdateDescription: (jid: string, description?: string) => Promise<void>
+    newsletterUpdateName: (jid: string, name: string) => Promise<void>
+    newsletterUpdatePicture: (jid: string, content: WAMediaUpload) => Promise<void>
+    newsletterRemovePicture: (jid: string) => Promise<void>
+    newsletterUnfollow: (jid: string) => Promise<void>
+    newsletterFollow: (jid: string) => Promise<void>
+    newsletterUnmute: (jid: string) => Promise<void>
+    newsletterMute: (jid: string) => Promise<void>
+    newsletterCreate: (name: string, description?: string, picture?: WAMediaUpload) => Promise<NewsletterMetadata>
+    newsletterQuery: (jid: string, type: string, content: BinaryNode) => Promise<BinaryNode>
+    newsletterWMexQuery: (jid?: string | undefined, query_id: number, content: BinaryNode) => Promise<BinaryNode>
+    newsletterMetadata: (type: 'invite' | 'jid', key: string, role?: NewsletterViewRole) => Promise<NewsletterMetadata>
+    newsletterFetchAllParticipating: () => Promise<{
+    	[_: string]: NewsletterMetadata
+    }>
+    newsletterAdminCount: (jid: string) => Promise<number>
+    newsletterChangeOwner: (jid: string, userLid: string) => Promise<void>
+    newsletterDemote: (jid: string, userLid: string) => Promise<void>
+    newsletterDelete: (jid: string) => Promise<void>
+    /**if code wasn't passed, the reaction will be removed (if is reacted) */
+    newsletterReactMessage: (jid: string, server_id: string, code?: string) => Promise<void>
+    newsletterFetchMessages: (type: 'invite' | 'jid', key: string, count: number, after?: number) => Promise<NewsletterFetchedUpdate[]>
+    newsletterFetchUpdates: (jid: string, count: number, after?: number, since?: number) => Promise<NewsletterFetchedUpdate[]>
+    groupQuery: (jid: string, type: string, content: BinaryNode) => Promise<BinaryNode>
+    groupMetadata: (jid: string) => Promise<import("../Types").GroupMetadata>
+    groupCreate: (subject: string, participants: string[]) => Promise<import("../Types").GroupMetadata>
+    groupLeave: (id: string) => Promise<void>
+    groupUpdateSubject: (jid: string, subject: string) => Promise<void>
+    groupRequestParticipantsList: (jid: string) => Promise<{
+        [key: string]: string
+    }[]>
+    groupRequestParticipantsUpdate: (jid: string, participants: string[], action: "reject" | "approve") => Promise<{
+        status: string
+        jid: string
+    }[]>
+    groupParticipantsUpdate: (jid: string, participants: string[], action: import("../Types").ParticipantAction) => Promise<{
+        status: string
+        jid: string
+        content: BinaryNode
+    }[]>
+    groupUpdateDescription: (jid: string, description?: string | undefined) => Promise<void>
+    groupInviteCode: (jid: string) => Promise<string | undefined>
+    groupRevokeInvite: (jid: string) => Promise<string | undefined>
+    groupAcceptInvite: (code: string) => Promise<string | undefined>
+    groupRevokeInviteV4: (groupJid: string, invitedJid: string) => Promise<boolean>
+    groupAcceptInviteV4: (key: string | import("../Types").WAMessageKey, inviteMessage: import("../Types").WAProto.Message.IGroupInviteMessage) => Promise<string>
+    groupGetInviteInfo: (code: string) => Promise<import("../Types").GroupMetadata>
+    groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>
+    groupSettingUpdate: (jid: string, setting: "announcement" | "locked" | "not_announcement" | "unlocked") => Promise<void>
+    groupMemberAddMode: (jid: string, mode: "all_member_add" | "admin_add") => Promise<void>
+    groupJoinApprovalMode: (jid: string, mode: "on" | "off") => Promise<void>
+    groupFetchAllParticipating: () => Promise<{
+        [_: string]: import("../Types").GroupMetadata
+    }>
+    processingMutex: {
+        mutex<T>(code: () => T | Promise<T>): Promise<T>
+    }
+    fetchPrivacySettings: (force?: boolean) => Promise<{
+        [_: string]: string
+    }>    
+    upsertMessage: (msg: import("../Types").WAProto.IWebMessageInfo, type: import("../Types").MessageUpsertType) => Promise<void>
+    appPatch: (patchCreate: import("../Types").WAPatchCreate) => Promise<void>
+    createCallLink: (type: 'audio' | 'video', event?: number, timeoutMs?: number) => Promise<void>
+    sendPresenceUpdate: (type: import("../Types").WAPresence, toJid?: string | undefined) => Promise<void>
+    presenceSubscribe: (toJid: string, tcToken?: Buffer | undefined) => Promise<void>   
+    getBotListV2: () => Promise<BotListInfo[]>
+    getLidUser: (jid: string) => Promise<{
+    	lid: string
+        id: string
+    }[] | undefined>
+    onWhatsApp: (...jids: string[]) => Promise<{
+        jid: string
+        exists: unknown
+    }[] | undefined>
+    fetchBlocklist: () => Promise<string[]>
+    fetchDisappearingDuration: (...jids: string[]) => Promise<import("../index").USyncQueryResultList[] | undefined>
+    fetchStatus: (...jids: string[]) => Promise<import("../index").USyncQueryResultList[] | undefined>
+    updateProfilePicture: (jid: string, content: WAMediaUpload) => Promise<void>
+    removeProfilePicture: (jid: string) => Promise<void>
+    updateProfileStatus: (status: string) => Promise<void>
+    updateProfileName: (name: string) => Promise<void>
+    updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>
+    updateCallPrivacy: (value: import("../Types").WAPrivacyCallValue) => Promise<void>
+    updateLastSeenPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>
+    updateOnlinePrivacy: (value: import("../Types").WAPrivacyOnlineValue) => Promise<void>
+    updateProfilePicturePrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>
+    updateStatusPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>
+    updateReadReceiptsPrivacy: (value: import("../Types").WAReadReceiptsValue) => Promise<void>
+    updateGroupsAddPrivacy: (value: import("../Types").WAPrivacyGroupAddValue) => Promise<void>
+    updateDefaultDisappearingMode: (duration: number) => Promise<void>
+    updateDisableLinkPreviewsPrivacy: (isPreviewsDisabled: boolean) => Promise<void>
+    getBusinessProfile: (jid: string) => Promise<void | import("../Types").WABusinessProfile>
+    resyncAppState: (collections: readonly ("critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular")[], isInitialSync: boolean) => Promise<void>
+    chatModify: (mod: import("../Types").ChatModification, jid: string) => Promise<void>
+    cleanDirtyBits: (type: "account_sync" | "groups", fromTimestamp?: string | number | undefined) => Promise<void>
+    addChatLabel: (jid: string, labelId: string) => Promise<void>
+    removeChatLabel: (jid: string, labelId: string) => Promise<void>
+    addMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>
+    removeMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>
+    clearMessage: (jid: string, key: import("../Types").WAProto.IMessageKey, timeStamp: number | import("long").Long) => Promise<void>
+    star: (jid: string, messages: {
+        id: string
+        fromMe?: boolean | undefined
+    }[], star: boolean) => Promise<void>
+    addOrEditContact: (jid: string, contact: ContactAction) => Promise<void>
+    removeContact: (jid: string) => Promise<void>
+    executeUSyncQuery: (usyncQuery: import("../index").USyncQuery) => Promise<import("../index").USyncQueryResult | undefined>
+    type: "md"
+    ws: any
+    ev: import("../Types").BaileysEventEmitter & {
+        process(handler: (events: Partial<import("../Types").BaileysEventMap>) => void | Promise<void>): () => void
+        buffer(): void
+        createBufferedFunction<A extends any[], T_1>(work: (...args: A) => Promise<T_1>): (...args: A) => Promise<T_1>
+        flush(force?: boolean | undefined): boolean
+        isBuffering(): boolean
+    }
+    authState: {
+        creds: import("../Types").AuthenticationCreds
+        keys: import("../Types").SignalKeyStoreWithTransaction
+    }
+    signalRepository: import("../Types").SignalRepository
+    user: import("../Types").Contact | undefined
+    generateMessageTag: () => string
+    query: (node: BinaryNode, timeoutMs?: number | undefined) => Promise<BinaryNode>
+    waitForMessage: <T_2>(msgId: string, timeoutMs?: number | undefined) => Promise<T_2>
+    waitForSocketOpen: () => Promise<void>
+    sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>
+    sendNode: (frame: BinaryNode) => Promise<void>
+    logout: (msg?: string | undefined) => Promise<void>
+    end: (error: Error | undefined) => void
+    onUnexpectedError: (err: Error | import("@hapi/boom").Boom<any>, msg: string) => void
+    uploadPreKeys: (count?: number) => Promise<void>
+    uploadPreKeysToServerIfRequired: () => Promise<void>
+    requestPairingCode: (phoneNumber: string, code?: string) => Promise<string>
+    waitForConnectionUpdate: (check: (u: Partial<import("../Types").ConnectionState>) => boolean | undefined, timeoutMs?: number | undefined) => Promise<void>
+    sendWAMBuffer: (wamBuffer: Buffer) => Promise<BinaryNode>
+}
+
+export declare const extractNewsletterMetadata: (node: BinaryNode, isCreate?: boolean) => NewsletterMetadata

package/lib/Socket/newsletter.js

@@ -0,0 +1,286 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const Types_1 = require("../Types")
+const Utils_1 = require("../Utils")
+const WABinary_1 = require("../WABinary")
+const groups_1 = require("./groups")
+
+const makeNewsletterSocket = (config) => {
+    const Neele = groups_1.makeGroupsSocket(config)
+    const { authState, signalRepository, query, generateMessageTag } = Neele
+    const encoder = new TextEncoder()
+    
+    const newsletterQuery = async (jid, type, content) => (query({
+        tag: 'iq',
+        attrs: {
+            id: generateMessageTag(),
+            type,
+            xmlns: 'newsletter',
+            to: jid,
+        },
+        content
+    }))
+    
+    const newsletterWMexQuery = async (jid, queryId, content) => (query({
+        tag: 'iq',
+        attrs: {
+            id: generateMessageTag(),
+            type: 'get',
+            xmlns: 'w:mex',
+            to: WABinary_1.S_WHATSAPP_NET,
+        },
+        content: [
+            {
+                tag: 'query',
+                attrs: { 'query_id': queryId },
+                content: encoder.encode(JSON.stringify({
+                    variables: {
+                        'newsletter_id': jid,
+                        ...content
+                    }
+                }))
+            }
+        ]
+    }))
+    
+    const parseFetchedUpdates = async (node, type) => {
+        let child
+        if (type === 'messages') {
+            child = WABinary_1.getBinaryNodeChild(node, 'messages')
+        }
+        
+        else {
+            const parent = WABinary_1.getBinaryNodeChild(node, 'message_updates')
+            child = WABinary_1.getBinaryNodeChild(parent, 'messages')
+        }
+        
+        return await Promise.all(WABinary_1.getAllBinaryNodeChildren(child).map(async (messageNode) => {
+            messageNode.attrs.from = child?.attrs.jid
+            
+            const views = parseInt(WABinary_1.getBinaryNodeChild(messageNode, 'views_count')?.attrs?.count || '0')
+            const reactionNode = WABinary_1.getBinaryNodeChild(messageNode, 'reactions')
+            const reactions = WABinary_1.getBinaryNodeChildren(reactionNode, 'reaction')
+                .map(({ attrs }) => ({ count: +attrs.count, code: attrs.code }))
+                
+            const data = {
+                'server_id': messageNode.attrs.server_id,
+                views,
+                reactions
+            }
+            
+            if (type === 'messages') {
+                const { fullMessage: message, decrypt } = await Utils_1.decryptMessageNode(messageNode, authState.creds.me.id, authState.creds.me.lid || '', signalRepository, config.logger)
+                await decrypt()
+                data.message = message
+            }
+            
+            return data
+        }))
+    }
+    
+    const newsletterMetadata = async (type, key, role) => {
+        const result = await newsletterWMexQuery(undefined, Types_1.QueryIds.METADATA, {
+            input: {
+                key,
+                type: type.toUpperCase(),
+                view_role: role || 'GUEST'
+            },
+            fetch_viewer_metadata: true,
+            fetch_full_image: true,
+            fetch_creation_time: true
+        })
+            
+        return extractNewsletterMetadata(result)
+    }
+    
+    return {
+        ...Neele,
+        newsletterQuery, 
+        newsletterWMexQuery, 
+        subscribeNewsletterUpdates: async (jid) => {
+            const result = await newsletterQuery(jid, 'set', [{ tag: 'live_updates', attrs: {}, content: [] }])
+            
+            return WABinary_1.getBinaryNodeChild(result, 'live_updates')?.attrs
+        },
+        newsletterReactionMode: async (jid, mode) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { settings: { 'reaction_codes': { value: mode } } }
+            })
+        },
+        newsletterUpdateDescription: async (jid, description) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { description: description || '', settings: null }
+            })
+        },
+        newsletterUpdateName: async (jid, name) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { name, settings: null }
+            })
+        },
+        newsletterUpdatePicture: async (jid, content) => {
+            const { img } = await Utils_1.generateProfilePicture(content)
+            
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { picture: img.toString('base64'), settings: null }
+            })
+        },
+        newsletterRemovePicture: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { picture: '', settings: null }
+            })
+        },
+        newsletterUnfollow: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.UNFOLLOW)
+        },
+        newsletterFollow: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.FOLLOW)
+        },
+        newsletterUnmute: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.UNMUTE)
+        },
+        newsletterMute: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.MUTE)
+        },
+        newsletterAction: async (jid, type) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds[type.toUpperCase()])
+        },
+        newsletterCreate: async (name, description, picture) => {
+            //TODO: Implement TOS system wide for Meta AI, communities, and here etc.
+            /**tos query */
+            await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    xmlns: 'tos',
+                    id: generateMessageTag(),
+                    type: 'set'
+                },
+                content: [
+                    {
+                        tag: 'notice',
+                        attrs: {
+                            id: '20601218',
+                            stage: '5'
+                        },
+                        content: []
+                    }
+                ]
+            })
+            
+            const result = await newsletterWMexQuery(undefined, Types_1.QueryIds.CREATE, {
+                input: { 
+                	name, 
+                    description: description || null, 
+                    picture: picture ? (await Utils_1.generateProfilePicture(picture)).img.toString('base64') : null, 
+                    settings: {
+                    	reaction_codes: {
+                    	    value: 'ALL'
+                        }
+                    }
+                }
+            })
+            
+            return extractNewsletterMetadata(result, true)
+        },
+        newsletterMetadata, 
+        newsletterFetchAllParticipating: async () => {
+        	const data = {}
+        
+        	const result = await newsletterWMexQuery(undefined, Types_1.QueryIds.SUBSCRIBED) 
+        	const child = JSON.parse(WABinary_1.getBinaryNodeChild(result, 'result')?.content?.toString())
+        	const newsletters = child.data[Types_1.XWAPaths.SUBSCRIBED]
+        
+        	for (const i of newsletters) {
+        		if (!WABinary_1.isJidNewsletter(i.id)) {
+        			continue
+        		}
+        	
+        		const metadata = await newsletterMetadata('JID', i.id) 
+        		data[metadata.id] = metadata
+        	}
+        	
+        	return data
+        }, 
+        newsletterAdminCount: async (jid) => {
+            const result = await newsletterWMexQuery(jid, Types_1.QueryIds.ADMIN_COUNT)
+            const buff = WABinary_1.getBinaryNodeChild(result, 'result')?.content?.toString()
+            
+            return JSON.parse(buff).data[Types_1.XWAPaths.ADMIN_COUNT].admin_count
+        },
+        newsletterChangeOwner: async (jid, userLid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.CHANGE_OWNER, {
+                user_id: userLid
+            })
+        },
+        newsletterDemote: async (jid, userLid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.DEMOTE, {
+                user_id: userLid
+            })
+        },
+        newsletterDelete: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.DELETE)
+        },
+        /**if code wasn't passed, the reaction will be removed (if is reacted) */
+        newsletterReactMessage: async (jid, serverId, code) => {
+            await query({
+                tag: 'message',
+                attrs: { to: jid, ...(!code ? { edit: '7' } : {}), type: 'reaction', server_id: serverId, id: Utils_1.generateMessageID() },
+                content: [{
+                        tag: 'reaction',
+                        attrs: code ? { code } : {}
+                    }]
+            })
+        },
+        newsletterFetchMessages: async (type, key, count, after) => {
+            const result = await newsletterQuery(WABinary_1.S_WHATSAPP_NET, 'get', [
+                {
+                    tag: 'messages',
+                    attrs: { type, ...(type === 'invite' ? { key } : { jid: key }), count: count.toString(), after: after?.toString() || '100' }
+                }
+            ])
+            
+            return await parseFetchedUpdates(result, 'messages')
+        },
+        newsletterFetchUpdates: async (jid, count, after, since) => {
+            const result = await newsletterQuery(jid, 'get', [
+                {
+                    tag: 'message_updates',
+                    attrs: { count: count.toString(), after: after?.toString() || '100', since: since?.toString() || '0' }
+                }
+            ])
+            
+            return await parseFetchedUpdates(result, 'updates')
+        }
+    }
+}
+
+const extractNewsletterMetadata = (node, isCreate) => {
+    const result = WABinary_1.getBinaryNodeChild(node, 'result')?.content?.toString()
+    const metadataPath = JSON.parse(result).data[isCreate ? Types_1.XWAPaths.CREATE : Types_1.XWAPaths.NEWSLETTER]
+    
+    const metadata = {
+        id: metadataPath.id,
+        state: metadataPath.state.type,
+        creation_time: +metadataPath.thread_metadata.creation_time,
+        name: metadataPath.thread_metadata.name.text,
+        nameTime: +metadataPath.thread_metadata.name.update_time,
+        description: metadataPath.thread_metadata.description.text,
+        descriptionTime: +metadataPath.thread_metadata.description.update_time,
+        invite: metadataPath.thread_metadata.invite,
+        handle: metadataPath.thread_metadata.handle,
+        picture: Utils_1.getUrlFromDirectPath(metadataPath.thread_metadata.picture?.direct_path || ''), 
+        preview: Utils_1.getUrlFromDirectPath(metadataPath.thread_metadata.preview?.direct_path || ''), 
+        reaction_codes: metadataPath.thread_metadata?.settings?.reaction_codes?.value,
+        subscribers: +metadataPath.thread_metadata.subscribers_count,
+        verification: metadataPath.thread_metadata.verification,
+        viewer_metadata: metadataPath.viewer_metadata
+    }
+    return metadata
+}
+
+module.exports = {
+  makeNewsletterSocket, 
+  extractNewsletterMetadata
+}