@nanazx/baileys 0.0.0-stage → 1.0.0

package/lib/Socket/interop.js

@@ -0,0 +1,562 @@
+import { getBinaryNodeChild, getBinaryNodeChildren, S_WHATSAPP_NET } from '../WABinary/index.js'
+import { executeWMexQuery } from './mex.js'
+
+/**
+ * w:mex query IDs for interop group and privacy operations.
+ *
+ * Source: whatsapp-android-mex_client_persist_ids.json (WA 2.26.26.4 APK assets)
+ */
+const INTEROP_MEX_QUERY_IDS = {
+	CREATE_GROUP: '25726817620301611', // GroupsCreateInteropGroup
+	LEAVE_GROUP: '25346167795013271', // LeaveInteropGroup
+	ADD_PARTICIPANTS: '25732168276369451', // AddParticipantsToInteropGroup
+	QUERY_GROUP_INFO: '32734144032867938', // QueryInteropGroupInfo
+	PRIVACY_SETTINGS_QUERY: '24849123668112654', // InteropPrivacySettingsQuery
+	PRIVACY_SETTINGS_UPDATE: '25421856497452763', // InteropPrivacySettingsUpdate
+	PRIVACY_SETTINGS_WITH_CONTACT_LIST: '24913399124998598' // InteropPrivacySettingWithContactListUpdate
+}
+
+/**
+ * Known integrator IDs (assigned by WhatsApp).
+ * BirdyChat → identifier_type="email"
+ * Haiket    → identifier_type="pn"
+ */
+const INTEGRATOR_BIRDYCHAT = 12
+const INTEGRATOR_HAIKET = 13
+
+/**
+ * TOS trackable results sent by WA on first interop opt-in.
+ * 105 = TOS shown, 160 = TOS accepted.
+ */
+const TOS_TRACKABLE_ID = '20240306'
+const TOS_RESULT_SHOWN = '105'
+const TOS_RESULT_ACCEPTED = '160'
+
+/** Maximum users per batch lookup (enforced server-side too). */
+const INTEROP_BATCH_MAX = 256
+
+const makeInteropSocket = sock => {
+	const { query, generateMessageTag, logger, signalRepository, masqueradeAsPrimary } = sock
+
+	const mexQuery = (variables, queryId, dataPath) =>
+		executeWMexQuery(variables, queryId, dataPath, query, generateMessageTag)
+
+	/**
+	 * Fetch all available interop integrators from the server.
+	 * Each integrator carries: id, name, status, icon, identifierType,
+	 * optedIn, features.groupMessaging.
+	 * status can be "active" | "onboarding" | "removed".
+	 */
+	const fetchIntegrators = async () => {
+		const result = await query({
+			tag: 'iq',
+			attrs: {
+				type: 'get',
+				xmlns: 'w:interop',
+				to: S_WHATSAPP_NET
+			},
+			content: [{ tag: 'integrator', attrs: { fetch: 'all' } }]
+		})
+		const listNode = getBinaryNodeChild(result, 'integrator_list')
+		if (!listNode) return []
+		const globalOptedIn = listNode.attrs?.opted_in === 'true'
+		return getBinaryNodeChildren(listNode, 'integrator').map(node => {
+			const featuresNode = getBinaryNodeChild(node, 'features')
+			return {
+				id: parseInt(node.attrs.id, 10),
+				name: node.attrs.name,
+				// "active" | "onboarding" | "removed"
+				status: node.attrs.status,
+				icon: node.attrs.icon,
+				// "email" | "pn" | "username"
+				identifierType: node.attrs.identifier_type,
+				// Whether we are already opted-in to this integrator
+				optedIn: node.attrs.opted_in === 'true' || globalOptedIn,
+				features: {
+					groupMessaging: featuresNode?.attrs?.group_messaging === 'true'
+				}
+			}
+		})
+	}
+
+	/** Send a single TOS trackable item (shown or accepted). */
+	const sendTOSTrackable = async (id, result) => {
+		await query({
+			tag: 'iq',
+			attrs: { to: S_WHATSAPP_NET, type: 'set', xmlns: 'tos' },
+			content: [{ tag: 'trackable', attrs: { id, result } }]
+		})
+	}
+
+	/**
+	 * Accept TOS for interop.
+	 * Sends two trackable items: shown (105) then accepted (160).
+	 * Must be called before opting in.
+	 */
+	const acceptInteropTOS = async () => {
+		await sendTOSTrackable(TOS_TRACKABLE_ID, TOS_RESULT_SHOWN)
+		await sendTOSTrackable(TOS_TRACKABLE_ID, TOS_RESULT_ACCEPTED)
+	}
+
+	/**
+	 * Opt in to a list of integrators (by numeric ID).
+	 * Defaults to both known integrators (BirdyChat + Haiket).
+	 */
+	const optInIntegrators = async (integratorIds = [INTEGRATOR_BIRDYCHAT, INTEGRATOR_HAIKET]) => {
+		await query({
+			tag: 'iq',
+			attrs: { type: 'set', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [
+				{
+					tag: 'opt_in_integrators',
+					attrs: {},
+					content: [
+						{
+							tag: 'integrator_list',
+							attrs: {},
+							content: integratorIds.map(id => ({
+								tag: 'integrator',
+								attrs: { id: id.toString() }
+							}))
+						}
+					]
+				}
+			]
+		})
+	}
+
+	/**
+	 * Opt out of a list of integrators (by numeric ID).
+	 * Mirror of optInIntegrators — uses <opt_out_integrators>.
+	 */
+	const optOutIntegrators = async (integratorIds = [INTEGRATOR_BIRDYCHAT, INTEGRATOR_HAIKET]) => {
+		await query({
+			tag: 'iq',
+			attrs: { type: 'set', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [
+				{
+					tag: 'opt_out_integrators',
+					attrs: {},
+					content: [
+						{
+							tag: 'integrator_list',
+							attrs: {},
+							content: integratorIds.map(id => ({
+								tag: 'integrator',
+								attrs: { id: id.toString() }
+							}))
+						}
+					]
+				}
+			]
+		})
+	}
+
+	/**
+	 * Resolve one or more interop users by external ID in a single IQ.
+	 * Each entry: { externalId, integratorId }
+	 *   - BirdyChat (12): externalId = email address
+	 *   - Haiket    (13): externalId = phone number string (e.g. "19146088152")
+	 *
+	 * Max 256 entries per call (server limit).
+	 *
+	 * Returns an array of results:
+	 *   { jid, externalId, normalizedExternalId, integratorId }  on success
+	 *   { externalId, integratorId, error: { code, text } }       on failure
+	 */
+	const resolveInteropUsers = async users => {
+		if (!users || users.length === 0) return []
+		if (users.length > INTEROP_BATCH_MAX) {
+			throw new Error(`resolveInteropUsers: max ${INTEROP_BATCH_MAX} users per request`)
+		}
+		const result = await query({
+			tag: 'iq',
+			attrs: { type: 'get', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [
+				{
+					tag: 'users',
+					attrs: {},
+					content: users.map(({ externalId, integratorId }) => ({
+						tag: 'user',
+						attrs: {
+							external_id: externalId,
+							integrator_id: integratorId.toString()
+						}
+					}))
+				}
+			]
+		})
+		const usersNode = getBinaryNodeChild(result, 'users')
+		if (!usersNode) return []
+		return getBinaryNodeChildren(usersNode, 'user').map(userNode => {
+			const errorNode = getBinaryNodeChild(userNode, 'error')
+			if (errorNode) {
+				return {
+					externalId: userNode.attrs.external_id,
+					integratorId: parseInt(userNode.attrs.integrator_id, 10),
+					error: {
+						code: parseInt(errorNode.attrs.code, 10),
+						text: errorNode.attrs.text
+					}
+				}
+			}
+			return {
+				jid: userNode.attrs.jid,
+				externalId: userNode.attrs.external_id,
+				normalizedExternalId: userNode.attrs.normalized_external_id,
+				integratorId: parseInt(userNode.attrs.integrator_id, 10)
+			}
+		})
+	}
+
+	/**
+	 * Convenience wrapper: resolve a single interop user.
+	 * Returns the result object or null.
+	 */
+	const resolveInteropUser = async (externalId, integratorId) => {
+		const results = await resolveInteropUsers([{ externalId, integratorId }])
+		return results[0] ?? null
+	}
+
+	/**
+	 * Get reachability settings for interop contacts.
+	 * Returns the raw <reachability_settings> node content.
+	 * WA uses this as the interop presence/subscription mechanism.
+	 */
+	const getReachabilitySettings = async () => {
+		const result = await query({
+			tag: 'iq',
+			attrs: { type: 'get', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [{ tag: 'reachability_settings', attrs: {} }]
+		})
+		const settingsNode = getBinaryNodeChild(result, 'reachability_settings')
+		if (!settingsNode) return null
+		return {
+			enabled: settingsNode.attrs?.enabled,
+			users: getBinaryNodeChildren(settingsNode, 'user').map(n => ({
+				externalId: n.attrs.external_id,
+				integratorId: parseInt(n.attrs.integrator_id, 10),
+				jid: n.attrs.jid
+			}))
+		}
+	}
+
+	/**
+	 * Set reachability settings (subscribe to presence) for interop contacts.
+	 * users: array of { externalId, integratorId }
+	 * enabled: "true" | "false"
+	 */
+	const setReachabilitySettings = async (users, enabled = 'true') => {
+		await query({
+			tag: 'iq',
+			attrs: { type: 'set', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [
+				{
+					tag: 'reachability_settings',
+					attrs: { enabled },
+					content: users.map(({ externalId, integratorId }) => ({
+						tag: 'user',
+						attrs: {
+							external_id: externalId,
+							integrator_id: integratorId.toString()
+						}
+					}))
+				}
+			]
+		})
+	}
+
+	/**
+	 * Block or unblock an interop user via the w:interop blocklist.
+	 * Different from regular WA block (xmlns=blocklist).
+	 */
+	const updateInteropBlockStatus = async (jid, action) => {
+		await query({
+			tag: 'iq',
+			attrs: { type: 'set', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [
+				{
+					tag: 'blocklist',
+					attrs: {},
+					content: [{ tag: 'item', attrs: { action, jid } }]
+				}
+			]
+		})
+	}
+
+	const blockInteropUser = jid => updateInteropBlockStatus(jid, 'block')
+	const unblockInteropUser = jid => updateInteropBlockStatus(jid, 'unblock')
+
+	/**
+	 * Report an interop contact as spam.
+	 * spam_flow="account_info_block" = block + report (WA Web default).
+	 */
+	const reportInteropSpam = async (jid, spamFlow = 'account_info_block') => {
+		await query({
+			tag: 'iq',
+			attrs: { type: 'set', xmlns: 'spam', to: S_WHATSAPP_NET },
+			content: [{ tag: 'spam_list', attrs: { jid, spam_flow: spamFlow } }]
+		})
+	}
+
+	/**
+	 * Mark an interop JID as trusted_contact in privacy tokens.
+	 * WA calls this automatically after the first outgoing message.
+	 */
+	const trustInteropContact = async jid => {
+		const t = Math.floor(Date.now() / 1000).toString()
+		await query({
+			tag: 'iq',
+			attrs: { to: S_WHATSAPP_NET, xmlns: 'privacy', type: 'set' },
+			content: [
+				{
+					tag: 'tokens',
+					attrs: {},
+					content: [{ tag: 'token', attrs: { jid, type: 'trusted_contact', t } }]
+				}
+			]
+		})
+	}
+
+	/**
+	 * Full interop initialization sequence matching WA Web:
+	 * 1. Fetch available integrators
+	 * 2. Accept TOS (shown 105 + accepted 160)
+	 * 3. Opt-in to all active/onboarding integrators
+	 *
+	 * Silently tolerates TOS/opt-in errors.
+	 * Returns the full integrator list.
+	 */
+	const initInterop = async () => {
+		let integrators
+		try {
+			integrators = await fetchIntegrators()
+		} catch (err) {
+			logger.warn({ err }, 'interop: failed to fetch integrators')
+			return []
+		}
+		const toOptIn = integrators.filter(i => i.status === 'active' || i.status === 'onboarding')
+		if (toOptIn.length === 0) return integrators
+		try {
+			await acceptInteropTOS()
+		} catch (err) {
+			logger.warn({ err }, 'interop: failed to accept TOS')
+		}
+		try {
+			await optInIntegrators(toOptIn.map(i => i.id))
+		} catch (err) {
+			logger.warn({ err }, 'interop: failed to opt-in integrators')
+		}
+		logger.info({ integrators: toOptIn.map(i => i.name) }, 'interop: opted in')
+		logger.warn(
+			{ integrators: toOptIn.map(i => i.name) },
+			'interop: receiving messages from interop contacts (BirdyChat/Haiket) is NOT YET SUPPORTED. ' +
+			'The interop bridge only delivers to device 0 (primary phone) via a single Signal session — ' +
+			'no fan-out to companion devices. Opt-in and sending may work, but inbound messages will not arrive.'
+		)
+		return integrators
+	}
+
+	/**
+	 * Reset the Signal session with an interop contact and force a fresh pkmsg handshake.
+	 * Call this when incoming messages from an interop contact are not arriving or
+	 * failing to decrypt — it clears the stale session so the next sendMessage
+	 * generates a new pre-key message and re-establishes both directions.
+	 */
+	const resetInteropSession = async jid => {
+		await signalRepository.deleteSession([jid])
+		logger.info({ jid }, '[interop] session reset — next send will use pkmsg')
+	}
+
+	/**
+	 * Create an interop group via MEX.
+	 * Confirmed from C80913Xf.java opcode 15:
+	 *   input: { participants: [{ jid }] }
+	 *   dataPath: xwa2_interop_group_create
+	 *
+	 * @param {string[]} participants - Interop JIDs to add
+	 * @returns {{ gid, creationTime, creator, participants }}
+	 */
+	const createInteropGroup = async participants => {
+		const result = await mexQuery(
+			{ input: { participants: participants.map(jid => ({ jid })) } },
+			INTEROP_MEX_QUERY_IDS.CREATE_GROUP,
+			'xwa2_interop_group_create'
+		)
+		logger.info({ participants }, '[interop] group created via MEX')
+		return result
+	}
+
+	/**
+	 * Leave one or more interop groups via MEX.
+	 * Confirmed from C80913Xf.java opcode 28:
+	 *   input: { groups_to_leave: [{ gid }] }
+	 *   dataPath: xwa2_interop_group_leave
+	 *
+	 * gid is the raw interop group ID (without @g.us suffix).
+	 * @param {string|string[]} jids - Interop group JID(s)
+	 */
+	const leaveInteropGroup = async jids => {
+		const ids = Array.isArray(jids) ? jids : [jids]
+		const result = await mexQuery(
+			{ input: { groups_to_leave: ids.map(jid => ({ gid: jid.split('@')[0] })) } },
+			INTEROP_MEX_QUERY_IDS.LEAVE_GROUP,
+			'xwa2_interop_group_leave'
+		)
+		logger.info({ jids: ids }, '[interop] left group(s) via MEX')
+		return result
+	}
+
+	/**
+	 * Add participants to an existing interop group via MEX.
+	 * Confirmed from C3Wt.java opcode 9:
+	 *   input: { gid, participants: [{ jid }] }
+	 *   dataPath: xwa2_interop_add_participants_to_group
+	 *
+	 * @param {string} groupJid - Interop group JID
+	 * @param {string[]} participants - Interop JIDs to add
+	 */
+	const addParticipantsToInteropGroup = async (groupJid, participants) => {
+		const gid = groupJid.split('@')[0]
+		return mexQuery(
+			{ input: { gid, participants: participants.map(jid => ({ jid })) } },
+			INTEROP_MEX_QUERY_IDS.ADD_PARTICIPANTS,
+			'xwa2_interop_add_participants_to_group'
+		)
+	}
+
+	/**
+	 * Query info about an interop group via MEX.
+	 * Confirmed from C3Wt.java opcode 10:
+	 *   group_input: { gid }
+	 *   dataPath: xwa2_interop_group_query_by_id
+	 *
+	 * @param {string} groupJid - Interop group JID
+	 */
+	const queryInteropGroupInfo = async groupJid => {
+		const gid = groupJid.split('@')[0]
+		return mexQuery({ group_input: { gid } }, INTEROP_MEX_QUERY_IDS.QUERY_GROUP_INFO, 'xwa2_interop_group_query_by_id')
+	}
+
+	/**
+	 * Update an interop privacy setting via MEX.
+	 * Confirmed from C24385Ak0.java (InteropPrivacySettingsUpdate):
+	 *   feature, setting
+	 *   dataPath: xwa2_interop_privacy_setting_update
+	 *
+	 * Known features: "GROUPADD"
+	 * Known settings: "ALL" | "CONTACTS" | "NONE"
+	 *
+	 * @param {string} feature - Privacy feature name
+	 * @param {string} setting - New value
+	 */
+	const updateInteropPrivacySetting = async (feature, setting) => {
+		return mexQuery(
+			{ feature, setting },
+			INTEROP_MEX_QUERY_IDS.PRIVACY_SETTINGS_UPDATE,
+			'xwa2_interop_privacy_setting_update'
+		)
+	}
+
+	/**
+	 * Update an interop privacy setting with an explicit contact list via MEX.
+	 * Confirmed from C24388Ak8.java (InteropPrivacySettingWithContactListUpdate):
+	 *   feature, setting, contacts[], contact_list_type, dhash
+	 *   dataPath: xwa2_interop_privacy_setting_with_contact_list_update
+	 *
+	 * Used when setting is "CONTACTS" and you want to specify exact allowed contacts.
+	 *
+	 * @param {string} feature - Privacy feature (e.g. "GROUPADD")
+	 * @param {string} setting - "CONTACTS"
+	 * @param {string[]} contacts - List of JIDs to allow
+	 * @param {string} contactListType - Contact list type string
+	 * @param {string} [dhash] - Hash of the current contact list (or null/"none")
+	 */
+	const updateInteropPrivacySettingWithContactList = async (
+		feature,
+		setting,
+		contacts,
+		contactListType,
+		dhash = 'none'
+	) => {
+		return mexQuery(
+			{ feature, setting, contacts, contact_list_type: contactListType, dhash },
+			INTEROP_MEX_QUERY_IDS.PRIVACY_SETTINGS_WITH_CONTACT_LIST,
+			'xwa2_interop_privacy_setting_with_contact_list_update'
+		)
+	}
+
+	/**
+	 * Query all interop privacy settings via MEX.
+	 * Uses InteropPrivacySettingsQuery (doc_id: 24849123668112654).
+	 * Returns the current value for each privacy feature (e.g. GROUPADD).
+	 * dataPath: xwa2_interop_privacy_settings
+	 */
+	const queryInteropPrivacySettings = () =>
+		mexQuery({}, INTEROP_MEX_QUERY_IDS.PRIVACY_SETTINGS_QUERY, 'xwa2_interop_privacy_settings')
+
+	/**
+	 * Check whether an interop user allows being added to groups (GROUPADD privacy).
+	 * Returns true if the user can be added, false if blocked by their privacy settings.
+	 *
+	 * Mirrors InteropPrivacySettingsManager.A01() in the APK which queries
+	 * the "GROUPADD" feature for the given account.
+	 */
+	const getInteropGroupAddPrivacy = async (jid, integratorId) => {
+		const result = await query({
+			tag: 'iq',
+			attrs: { type: 'get', xmlns: 'w:interop', to: S_WHATSAPP_NET },
+			content: [
+				{
+					tag: 'privacy',
+					attrs: { feature: 'GROUPADD' },
+					content: [
+						{
+							tag: 'user',
+							attrs: {
+								jid,
+								integrator_id: integratorId.toString()
+							}
+						}
+					]
+				}
+			]
+		})
+		const privacyNode = getBinaryNodeChild(result, 'privacy')
+		const userNode = getBinaryNodeChild(privacyNode, 'user')
+		// "allowed" means the server confirmed the user can be added; any other value or
+		// absence of the attribute means the privacy setting blocks the add.
+		return userNode?.attrs?.result === 'allowed'
+	}
+
+	return {
+		...sock,
+		fetchIntegrators,
+		acceptInteropTOS,
+		optInIntegrators,
+		optOutIntegrators,
+		resolveInteropUser,
+		resolveInteropUsers,
+		getReachabilitySettings,
+		setReachabilitySettings,
+		blockInteropUser,
+		unblockInteropUser,
+		reportInteropSpam,
+		trustInteropContact,
+		initInterop,
+		resetInteropSession,
+		createInteropGroup,
+		leaveInteropGroup,
+		addParticipantsToInteropGroup,
+		queryInteropGroupInfo,
+		queryInteropPrivacySettings,
+		updateInteropPrivacySetting,
+		updateInteropPrivacySettingWithContactList,
+		getInteropGroupAddPrivacy,
+		INTEGRATOR_BIRDYCHAT,
+		INTEGRATOR_HAIKET,
+		INTEROP_MEX_QUERY_IDS
+	}
+}
+
+export { makeInteropSocket, INTEGRATOR_BIRDYCHAT, INTEGRATOR_HAIKET };