@badzz88/baileys 8.4.7 → 8.5.0

package/lib/Socket/text-router.js

@@ -0,0 +1,83 @@
+'use strict'
+Object.defineProperty(exports, '__esModule', { value: true })
+exports.attachTextRouter = void 0
+
+const extractText = message => {
+	if (!message) return ''
+	return (
+		message.conversation ||
+		message.extendedTextMessage?.text ||
+		message.imageMessage?.caption ||
+		message.videoMessage?.caption ||
+		message.documentMessage?.caption ||
+		''
+	)
+}
+
+const escapeRegExp = str => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+
+/**
+ * Attaches Telegraf text routing to a socket:
+ * `sock.onText(pattern, handler)`, `sock.hears(pattern, handler)` (alias), and
+ * `sock.command(name, handler)`, instead of manually parsing every
+ * `messages.upsert` event by hand.
+ *
+ * - `pattern` as a RegExp: handler gets called as `handler(msg, match)` where
+ *   `match` is the result of `pattern.exec(text)` (or null if only testing).
+ * - `pattern` as a string: matched literally (exact match) against the message
+ *   text; `handler(msg, [text])` is called on match.
+ * - `sock.command('start', handler)`: matches `/start`, `/start@BotName`, and
+ *   `/start extra args`, calling `handler(msg, match)` where `match[1]` is the
+ *   text after the command (or undefined).
+ *
+ * All three return an unsubscribe function. Only one `messages.upsert`
+ * listener is registered regardless of how many routes are added.
+ */
+const attachTextRouter = sock => {
+	const routes = []
+
+	const addRoute = (pattern, handler) => {
+		const route = { pattern, handler }
+		routes.push(route)
+		return () => {
+			const idx = routes.indexOf(route)
+			if (idx !== -1) routes.splice(idx, 1)
+		}
+	}
+
+	const dispatch = async ({ messages, type }) => {
+		if (type !== 'notify' && type !== 'append') return
+		for (const msg of messages) {
+			if (!msg.message || msg.key.fromMe) continue
+			const text = extractText(msg.message)
+			if (!text) continue
+			for (const route of routes.slice()) {
+				let match = null
+				if (route.pattern instanceof RegExp) {
+					route.pattern.lastIndex = 0
+					match = route.pattern.exec(text)
+				} else if (typeof route.pattern === 'string') {
+					match = text === route.pattern ? [text] : null
+				}
+				if (!match) continue
+				try {
+					await route.handler(msg, match)
+				} catch (error) {
+					sock.logger?.error?.({ error, text }, 'onText/hears handler threw')
+				}
+			}
+		}
+	}
+	sock.ev.on('messages.upsert', dispatch)
+
+	sock.onText = addRoute
+	sock.hears = addRoute
+	sock.command = (name, handler) => {
+		const names = (Array.isArray(name) ? name : [name]).map(escapeRegExp)
+		const pattern = new RegExp(`^/(?:${names.join('|')})(?:@\\S+)?(?:\\s+([\\s\\S]*))?$`, 'i')
+		return addRoute(pattern, handler)
+	}
+
+	return sock
+}
+exports.attachTextRouter = attachTextRouter

package/lib/Socket/username.js

@@ -1,146 +1,243 @@
-import { executeWMexQuery } from './mex.js'
-import { USyncQuery, USyncUser } from '../WAUSync/index.js'
-import { makeNewsletterSocket } from '../WAUSync/Protocols/USyncNewsletterProtocol.js'
-export const USERNAME_QUERY_IDS = {
-	CHECK: '26124072630599520',
-	CHECK_MULTI: '27134626522840290',
-	SET: '27108705368767936',
-	GET: '32618050064506056',
-	GET_RECOMMENDATIONS: '26077456248616956',
-	PIN_SET: '25529696019976770'
+'use strict'
+Object.defineProperty(exports, '__esModule', { value: true })
+exports.makeUsernameSocket = void 0
+
+const { executeWMexQuery } = require('./mex.js')
+const { USyncQuery, USyncUser } = require('../WAUSync/index.js')
+const { makeNewsletterSocket } = require('./newsletter.js')
+const crypto = require('crypto')
+/**
+ * w:mex query IDs for username operations.
+ *
+ * Source: whatsapp-android-mex_client_persist_ids.json (WA 2.26.26.4 APK assets)
+ * Cross-checked: live Frida capture on real device (wa-logger-2.26.26.4.js, 2026-06-30)
+ */
+const USERNAME_QUERY_IDS = {
+  CHECK: '26124072630599518', // UsernameCheck
+  CHECK_MULTI: '27134626522840286', // UsernameCheckMulti
+  SET: '27108705368767936', // UsernameSet
+  GET: '32618050064506055', // UsernameGet
+  GET_RECOMMENDATIONS: '26077456248616957', // UsernameGetRecommendationsQuery
+  PIN_SET: '25529696019976770' // UsernamePinSet
+}
+
+/**
+ * Source enum values from EnumC141106Vn (UsernameCheck result)
+ * and EnumC141056Vi (rejection reasons) confirmed via C164057Wg.java
+ */
+const USERNAME_CHECK_RESULT = {
+  SUCCESS: 'SUCCESS',
+  INVALID: 'INVALID'
 }
 
-export const USERNAME_CHECK_RESULT = {
-	SUCCESS: 'SUCCESS',
-	INVALID: 'INVALID'
+const USERNAME_SOURCE = {
+  FB: 'FB',
+  IG: 'IG',
+  USER_INPUT: 'USER_INPUT',
+  SUGGESTION: 'SUGGESTION'
 }
 
-export const USERNAME_SOURCE = {
-	FB: 'FB',
-	IG: 'IG',
-	USER_INPUT: 'USER_INPUT',
-	SUGGESTION: 'SUGGESTION'
+const makeUsernameSocket = config => {
+  const sock = makeNewsletterSocket(config)
+  const { query, generateMessageTag, executeUSyncQuery } = sock
+
+  const mexQuery = (variables, queryId, dataPath) =>
+    executeWMexQuery(variables, queryId, dataPath, query, generateMessageTag)
+
+  /**
+   * Check whether a username is available.
+   *
+   * @param {string} username - The @username to check (without @)
+   * @param {boolean} includeSuggestions - Request alternative suggestions when taken
+   * @returns {object}
+   * On success: { available: true, username }
+   * On taken: { available: false, username, suggestions: string[], rejectionReasons: string[], suggestionsEligible: boolean }
+   * On rate-limit: throws Boom with statusCode 429
+   *
+   * Confirmed fields from C164057Wg.java:
+   * data.xwa2_username_check.result → 'SUCCESS' | 'INVALID'
+   * data.xwa2_username_check.suggestions
+   * data.xwa2_username_check.rejection_reasons
+   * data.xwa2_username_check.suggestions_eligible
+   */
+  const checkUsername = async (username, includeSuggestions = true, sessionId) => {
+    // session_id ties this check to the subsequent set step — caller can pass one in
+    // so both use the same UUID (confirmed from live WA 2.26.26.4 capture).
+    const session_id = sessionId || crypto.randomUUID()
+    const data = await mexQuery(
+      {
+        username,
+        include_suggestions: includeSuggestions,
+        session_id,
+        source: USERNAME_SOURCE.USER_INPUT
+      },
+      USERNAME_QUERY_IDS.CHECK,
+      'xwa2_username_check'
+    )
+    if (data?.includes(USERNAME_CHECK_RESULT.SUCCESS) || data?.result === USERNAME_CHECK_RESULT.SUCCESS) {
+      return { available: true, username, session_id }
+    }
+    return {
+      available: false,
+      username,
+      session_id,
+      suggestions: data?.suggestions?? [],
+      rejectionReasons: data?.rejection_reasons?? [],
+      suggestionsEligible: data?.suggestions_eligible?? true
+    }
+  }
+
+  /**
+   * Set your own username.
+   *
+   * @param {string} username - The username to set (without @)
+   * @param {object} options
+   * @param {string} [options.source] - 'USER_INPUT' | 'FB' | 'IG' | 'SUGGESTION'
+   * @param {string} [options.sessionId] - Optional session tracking ID
+   * @param {string} [options.pin] - Optional PIN for protected usernames
+   *
+   * Confirmed variables from C1568872p.java A00():
+   * username, reserved (bool), session_id, source, pin
+   */
+  const setUsername = async (username, options = {}) => {
+    const { source = USERNAME_SOURCE.USER_INPUT, sessionId, pin } = options
+    // session_id links the check and set steps — generate one if caller doesn't supply it.
+    // reserved:true confirmed from live WA 2.26.26.4 capture (was wrongly false before).
+    const session_id = sessionId || crypto.randomUUID()
+    const variables = {
+      username,
+      reserved: true,
+      source,
+      session_id,
+     ...(pin? { pin } : {})
+    }
+    return mexQuery(variables, USERNAME_QUERY_IDS.SET, 'xwa2_username_set')
+  }
+
+  const checkAndSetUsername = async (username) => {
+    const r = await checkUsername(username)
+    if (r.available) {
+      return await setUsername(username)
+    }
+    return r
+  }
+
+  /**
+   * Delete (unset) your own username.
+   *
+   * Confirmed from C1568872p.java:
+   * str4 = str == null? "delete" : "set"
+   * → sending username=null triggers the delete path on the server.
+   */
+  const deleteUsername = async () => {
+    return mexQuery({ username: null }, USERNAME_QUERY_IDS.SET, 'xwa2_username_delete')
+  }
+
+  /**
+   * Get your own current username.
+   *
+   * Confirmed from C1568872p.java A02():
+   * AbstractC41851rT.A0L(AbstractC130045pa.A0T(), C1363664w.class, "UsernameGet", false)
+   */
+  const getMyUsername = async () => {
+    const data = await mexQuery({}, USERNAME_QUERY_IDS.GET, 'xwa2_username_get')
+    return data?.username?? null
+  }
+
+  /**
+   * Set or delete the PIN that protects your username.
+   *
+   * @param {string|null} pin - New PIN, or null to delete the PIN
+   *
+   * Confirmed from MexUsernamePinProtocolApi.java:
+   * operation "UsernamePinSet", variable "pin"
+   * pin=null triggers the "delete" path on the server.
+   */
+  const setUsernamePin = async pin => {
+    // pin=null → delete PIN (server interprets empty/null variables as delete)
+    const variables = pin!= null? { pin } : {}
+    return mexQuery(variables, USERNAME_QUERY_IDS.PIN_SET, 'xwa2_username_pin_set')
+  }
+
+  /**
+   * Look up a contact by their @username via USync.
+   *
+   * Confirmed via USyncContactProtocol.getUserElement():
+   * { tag: 'contact', attrs: { username, pin? } }
+   *
+   * @param {string} username - The username to look up (without @)
+   * @param {string} [pin] - Optional PIN if the username is PIN-protected
+   * @returns {{ jid, lid?, contact: boolean }|null}
+   */
+  const findUserByUsername = async (username, pin) => {
+    const usyncQuery = new USyncQuery().withContactProtocol()
+    const user = new USyncUser().withUsername(username)
+    if (pin) user.withUsernameKey(pin)
+    usyncQuery.withUser(user)
+    const result = await executeUSyncQuery(usyncQuery)
+    if (!result?.list?.length) return null
+    const entry = result.list[0]
+    return {
+      jid: entry.id,
+      contact: entry.contact?? false
+    }
+  }
+
+  /**
+   * Fetch the username of one or more contacts by their JID.
+   * Uses USync with the username protocol.
+   *
+   * @param {...string} jids - One or more JIDs
+   * @returns {Array<{ id, username: string|null }>}
+   */
+  const fetchContactUsernames = async (...jids) => {
+    const usyncQuery = new USyncQuery().withUsernameProtocol()
+    for (const jid of jids) {
+      usyncQuery.withUser(new USyncUser().withId(jid))
+    }
+    const result = await executeUSyncQuery(usyncQuery)
+    return result?.list?? []
+  }
+
+  /**
+   * Check multiple usernames for availability at once.
+   * @param {string[]} usernames - Array of usernames (without @)
+   */
+  const checkUsernameMulti = async usernames => {
+    const data = await mexQuery(
+      { usernames },
+      USERNAME_QUERY_IDS.CHECK_MULTI,
+      'xwa2_username_check_multi'
+    )
+    return data
+  }
+
+  /**
+   * Fetch username recommendations for the current user.
+   * @param {string} [source] - Source hint: 'FB' | 'IG' | 'USER_INPUT'
+   */
+  const getUsernameRecommendations = async (source = null) => {
+    const variables = {}
+    if (source) variables.source = source
+    return mexQuery(variables, USERNAME_QUERY_IDS.GET_RECOMMENDATIONS, 'xwa2_username_get_recommendations')
+  }
+
+  return {
+   ...sock,
+    checkUsername,
+    checkUsernameMulti,
+    setUsername,
+    deleteUsername,
+    getMyUsername,
+    getUsernameRecommendations,
+    setUsernamePin,
+    findUserByUsername,
+    fetchContactUsernames,
+    checkAndSetUsername,
+    USERNAME_QUERY_IDS,
+    USERNAME_CHECK_RESULT,
+    USERNAME_SOURCE
+  }
 }
 
-export const makeUsernameSocket = config => {
-	const sock = makeNewsletterSocket(config)
-	const { query, generateMessageTag, executeUSyncQuery } = sock
-
-	const mexQuery = (variables, queryId, dataPath) =>
-		executeWMexQuery(variables, queryId, dataPath, query, generateMessageTag)
-
-	const checkUsername = async (username, includeSuggestions = true) => {
-		if (!USERNAME_QUERY_IDS.CHECK) {
-			throw new Error('Username CHECK query_id not configured — capture a live WA session to obtain it')
-	}
-		const data = await mexQuery(
-			{ username, include_suggestions: includeSuggestions },
-			USERNAME_QUERY_IDS.CHECK,
-			'xwa2_username_check'
-	)
-		if (data?.result === USERNAME_CHECK_RESULT.SUCCESS) {
-			return { available: true, username }
-	}
-		return {
-			available: false,
-			username,
-			suggestions: data?.suggestions?? [],
-			rejectionReasons: data?.rejection_reasons?? [],
-			suggestionsEligible: data?.suggestions_eligible?? true
-    	}
-	}
-
-	const setUsername = async (username, options = {}) => {
-		if (!USERNAME_QUERY_IDS.SET) {
-			throw new Error('Username SET query_id not configured — capture a live WA session to obtain it')
-	}
-		const { source = USERNAME_SOURCE.USER_INPUT, sessionId, pin } = options
-		const variables = {
-			username,
-			reserved: false,
-			source,
-			...(sessionId? { session_id: sessionId } : {}),
-			...(pin? { pin } : {})
-	}
-		return mexQuery(variables, USERNAME_QUERY_IDS.SET, 'xwa2_username_set')
-	}
-	
-	const deleteUsername = async () => {
-		if (!USERNAME_QUERY_IDS.SET) {
-			throw new Error('Username SET query_id not configured — capture a live WA session to obtain it')
-	}
-		return mexQuery({ username: null }, USERNAME_QUERY_IDS.SET, 'xwa2_username_delete')
-	}
-
-	const getMyUsername = async () => {
-		if (!USERNAME_QUERY_IDS.GET) {
-			throw new Error('Username GET query_id not configured — capture a live WA session to obtain it')
-	}
-		const data = await mexQuery({}, USERNAME_QUERY_IDS.GET, 'xwa2_username_get')
-		return data?.username?? null
-	}
-
-	const setUsernamePin = async pin => {
-		if (!USERNAME_QUERY_IDS.PIN_SET) {
-			throw new Error('Username PIN_SET query_id not configured — capture a live WA session to obtain it')
-	}
-		return mexQuery({ pin }, USERNAME_QUERY_IDS.PIN_SET, 'xwa2_username_pin_set')
-	}
-
-
-	const findUserByUsername = async (username, pin) => {
-		const usyncQuery = new USyncQuery().withContactProtocol()
-		const user = new USyncUser().withUsername(username)
-		if (pin) user.withUsernameKey(pin)
-	usyncQuery.withUser(user)
-		const result = await executeUSyncQuery(usyncQuery)
-		if (!result?.list?.length) return null
-		const entry = result.list[0]
-		return {
-			jid: entry.id,
-			contact: entry.contact?? false
-	}
-	}
-	
-	const fetchContactUsernames = async (...jids) => {
-		const usyncQuery = new USyncQuery().withUsernameProtocol()
-		for (const jid of jids) {
-			usyncQuery.withUser(new USyncUser().withId(jid))
-	}
-		const result = await executeUSyncQuery(usyncQuery)
-		return result?.list?? []
-	}
-
-
-	const checkUsernameMulti = async usernames => {
-		const data = await mexQuery(
-			{ usernames },
-			USERNAME_QUERY_IDS.CHECK_MULTI,
-			'xwa2_username_check_multi'
-	)
-		return data
-	}
-
-
-	const getUsernameRecommendations = async (source = null) => {
-		const variables = {}
-		if (source) variables.source = source
-		return mexQuery(variables, USERNAME_QUERY_IDS.GET_RECOMMENDATIONS, 'xwa2_username_get_recommendations')
-	}
-
-	return {
-	    ...sock,
-		checkUsername,
-		checkUsernameMulti,
-		setUsername,
-		deleteUsername,
-		getMyUsername,
-		getUsernameRecommendations,
-		setUsernamePin,
-		findUserByUsername,
-		fetchContactUsernames,
-		USERNAME_QUERY_IDS,
-		USERNAME_CHECK_RESULT,
-		USERNAME_SOURCE
-	}
-}
+exports.makeUsernameSocket = makeUsernameSocket

package/lib/Store/index.js

@@ -1,10 +1,36 @@
-export * from './make-cache-manager-store.js';
-export * from './make-in-memory-store.js';
-export * from './make-ordered-dictionary.js';
-export * from './object-repository.js';
-export * from './keyed-db.js';
-export { default as makeCacheManagerStore } from './make-cache-manager-store.js';
-export { default as makeInMemoryStore } from './make-in-memory-store.js';
-export { default as makeOrderedDictionary } from './make-ordered-dictionary.js';
-export { default as objectRepository } from './object-repository.js';
-export { default as keyedDB } from './keyed-db.js';
+'use strict'
+
+var __createBinding =
+	(this && this.__createBinding) ||
+	(Object.create
+		? function (o, m, k, k2) {
+				if (k2 === undefined) k2 = k
+				var desc = Object.getOwnPropertyDescriptor(m, k)
+				if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+					desc = {
+						enumerable: true,
+						get: function () {
+							return m[k]
+						}
+					}
+				}
+				Object.defineProperty(o, k2, desc)
+			}
+		: function (o, m, k, k2) {
+				if (k2 === undefined) k2 = k
+				o[k2] = m[k]
+			})
+
+var __exportStar =
+	(this && this.__exportStar) ||
+	function (m, exports) {
+		for (var p in m)
+			if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p)
+	}
+
+Object.defineProperty(exports, '__esModule', { value: true })
+
+__exportStar(require('./make-cache-manager-store'), exports)
+__exportStar(require('./make-in-memory-store'), exports)
+__exportStar(require('./make-ordered-dictionary'), exports)
+__exportStar(require('./object-repository'), exports)

package/lib/Store/make-cache-manager-store.js

@@ -1,85 +1,90 @@
-import { createRequire } from "module";
-const require = createRequire(import.meta.url);
-const cacheManager = require("cache-manager");
+'use strict'
 
-import * as WAProto_1 from "../../WAProto/index.js";
-import * as Utils_1 from "../Utils/index.js";
-import logger from "../Utils/logger.js";
+var __importDefault =
+	(this && this.__importDefault) ||
+	function (mod) {
+		return mod && mod.__esModule ? mod : { default: mod }
+	}
 
-export default async function makeCacheManagerAuthState(store, sessionKey) {
-    const defaultKey = (file) => `${sessionKey}:${file}`;
-    const databaseConn = await cacheManager.caching(store);
+Object.defineProperty(exports, '__esModule', { value: true })
 
-    const writeData = async (file, data) => {
-        let ttl = undefined;
-        if (file === "creds") ttl = 63115200; // 2 years
-        await databaseConn.set(
-            defaultKey(file),
-            JSON.stringify(data, Utils_1.BufferJSON.replacer),
-            ttl
-        );
-    };
+const cache_manager_1 = require('cache-manager')
+const WAProto_1 = require('../../WAProto')
+const Utils_1 = require('../Utils')
+const logger_1 = __importDefault(require('../Utils/logger'))
 
-    const readData = async (file) => {
-        try {
-            const data = await databaseConn.get(defaultKey(file));
-            if (data) return JSON.parse(data, Utils_1.BufferJSON.reviver);
-            return null;
-        } catch (error) {
-            logger.error(error);
-            return null;
-        }
-    };
+const makeCacheManagerAuthState = async (store, sessionKey) => {
+	const defaultKey = file => `${sessionKey}:${file}`
+	const databaseConn = await cache_manager_1.caching(store)
+	const writeData = async (file, data) => {
+		let ttl = undefined
+		if (file === 'creds') {
+			ttl = 63115200 // 2 years
+		}
+		await databaseConn.set(defaultKey(file), JSON.stringify(data, Utils_1.BufferJSON.replacer), ttl)
+	}
+	const readData = async file => {
+		try {
+			const data = await databaseConn.get(defaultKey(file))
+			if (data) {
+				return JSON.parse(data, Utils_1.BufferJSON.reviver)
+			}
+			return null
+		} catch (error) {
+			logger_1.default.error(error)
+			return null
+		}
+	}
+	const removeData = async file => {
+		try {
+			return await databaseConn.del(defaultKey(file))
+		} catch (err) {
+			logger_1.default.error({ err }, `Error removing ${file} from session ${sessionKey}`)
+		}
+	}
+	const clearState = async () => {
+		try {
+			const result = await databaseConn.store.keys(`${sessionKey}*`)
+			await Promise.all(result.map(async key => await databaseConn.del(key)))
+		} catch (err) {
+			logger_1.default.warn({ err }, 'clearState failed')
+		}
+	}
+	const creds = (await readData('creds')) || (0, Utils_1.initAuthCreds)()
+	return {
+		clearState,
+		saveCreds: () => writeData('creds', creds),
+		state: {
+			creds,
+			keys: {
+				get: async (type, ids) => {
+					const data = {}
+					await Promise.all(
+						ids.map(async id => {
+							let value = await readData(`${type}-${id}`)
+							if (type === 'app-state-sync-key' && value) {
+								value = WAProto_1.proto.Message.AppStateSyncKeyData.fromObject(value)
+							}
+							data[id] = value
+						})
+					)
+					return data
+				},
+				set: async data => {
+					// eslint-disable-next-line @typescript-eslint/no-explicit-any
+					const tasks = []
+					for (const category in data) {
+						for (const id in data[category]) {
+							const value = data[category][id]
+							const key = `${category}-${id}`
+							tasks.push(value ? writeData(key, value) : removeData(key))
+						}
+					}
+					await Promise.all(tasks)
+				}
+			}
+		}
+	}
+}
 
-    const removeData = async (file) => {
-        try {
-            return await databaseConn.del(defaultKey(file));
-        } catch {
-            logger.error(`Error removing ${file} from session ${sessionKey}`);
-        }
-    };
-
-    const clearState = async () => {
-        try {
-            const result = await databaseConn.store.keys(`${sessionKey}*`);
-            await Promise.all(result.map(async (key) => databaseConn.del(key)));
-        } catch {}
-    };
-
-    const creds = (await readData("creds")) || Utils_1.initAuthCreds();
-
-    return {
-        clearState,
-        saveCreds: () => writeData("creds", creds),
-        state: {
-            creds,
-            keys: {
-                get: async (type, ids) => {
-                    const data = {};
-                    await Promise.all(
-                        ids.map(async (id) => {
-                            let value = await readData(`${type}-${id}`);
-                            if (type === "app-state-sync-key" && value) {
-                                value =
-                                    WAProto_1.proto.Message.AppStateSyncKeyData.fromObject(value);
-                            }
-                            data[id] = value;
-                        })
-                    );
-                    return data;
-                },
-                set: async (data) => {
-                    const tasks = [];
-                    for (const category in data) {
-                        for (const id in data[category]) {
-                            const value = data[category][id];
-                            const key = `${category}-${id}`;
-                            tasks.push(value ? writeData(key, value) : removeData(key));
-                        }
-                    }
-                    await Promise.all(tasks);
-                }
-            }
-        }
-    };
-}
+exports.makeCacheManagerAuthState = makeCacheManagerAuthState