@badzz88/baileys 8.5.4 → 8.5.5

package/lib/Socket/communities.js

@@ -15,10 +15,10 @@ const business_1 = require('./business')
 const mex_1 = require('./mex')
 
 const COMMUNITY_MEX_QUERY_IDS = {
-	QUERY_PARTICIPANT_COUNT: '31981537024824320', 
-	QUERY_SUBGROUPS: '25554052094203120', 
-	QUERY_SUBGROUP_PARTICIPANT_COUNT: '24784259781196780', 
-	UPDATE_OWNER: '24781435194845316' 
+	QUERY_PARTICIPANT_COUNT: '31981537024824320', // QueryCommunityParticipantCount
+	QUERY_SUBGROUPS: '25554052094203120', // QuerySubgroups (shared with groups)
+	QUERY_SUBGROUP_PARTICIPANT_COUNT: '24784259781196780', // QuerySubgroupParticipantCount
+	UPDATE_OWNER: '24781435194845316' // UpdateCommunityOwner
 }
 
 const makeCommunitiesSocket = config => {
@@ -205,16 +205,16 @@ const makeCommunitiesSocket = config => {
 		communityFetchLinkedGroups: async jid => {
 			let communityJid = jid
 			let isCommunity = false
-			
+			// Try to determine if it is a subgroup or a community
 			const metadata = await sock.groupMetadata(jid)
 			if (metadata.linkedParent) {
-				
+				// It is a subgroup, get the community jid
 				communityJid = metadata.linkedParent
 			} else {
-				
+				// It is a community
 				isCommunity = true
 			}
-			
+			// Fetch all subgroups of the community
 			const result = await communityQuery(communityJid, 'get', [{ tag: 'sub_groups', attrs: {} }])
 			const linkedGroupsData = []
 			const subGroupsNode = (0, WABinary_1.getBinaryNodeChild)(result, 'sub_groups')
@@ -317,14 +317,23 @@ const makeCommunitiesSocket = config => {
 			const result = (0, WABinary_1.getBinaryNodeChild)(results, 'community')
 			return result?.attrs.jid
 		},
-		
+		/**
+		 * revoke a v4 invite for someone
+		 * @param communityJid community jid
+		 * @param invitedJid jid of person you invited
+		 * @returns true if successful
+		 */
 		communityRevokeInviteV4: async (communityJid, invitedJid) => {
 			const result = await communityQuery(communityJid, 'set', [
 				{ tag: 'revoke', attrs: {}, content: [{ tag: 'participant', attrs: { jid: invitedJid } }] }
 			])
 			return !!result
 		},
-		
+		/**
+		 * accept a CommunityInviteMessage
+		 * @param key the key of the invite message, or optionally only provide the jid of the person who sent the invite
+		 * @param inviteMessage the message to accept
+		 */
 		communityAcceptInviteV4: ev.createBufferedFunction(async (key, inviteMessage) => {
 			key = typeof key === 'string' ? { remoteJid: key } : key
 			const results = await communityQuery(inviteMessage.groupJid, 'set', [
@@ -337,10 +346,10 @@ const makeCommunitiesSocket = config => {
 					}
 				}
 			])
-			
-			
+			// if we have the full message key
+			// update the invite message to be expired
 			if (key.id) {
-				
+				// create new invite message that is expired
 				inviteMessage = index_js_1.proto.Message.GroupInviteMessage.fromObject(inviteMessage)
 				inviteMessage.inviteExpiration = 0
 				inviteMessage.inviteCode = ''
@@ -355,14 +364,14 @@ const makeCommunitiesSocket = config => {
 					}
 				])
 			}
-			
+			// generate the community add message
 			await upsertMessage(
 				{
 					key: {
 						remoteJid: inviteMessage.groupJid,
 						id: (0, Utils_1.generateMessageIDV2)(sock.user?.id),
 						fromMe: false,
-						participant: key.remoteJid 
+						participant: key.remoteJid // TODO: investigate if this makes any sense at all
 					},
 					messageStubType: Types_1.WAMessageStubType.GROUP_PARTICIPANT_ADD,
 					messageStubParameters: [JSON.stringify(authState.creds.me)],
@@ -373,15 +382,30 @@ const makeCommunitiesSocket = config => {
 			)
 			return results.attrs.from
 		}),
+		communityGetInviteInfo: async code => {
+			const results = await communityQuery('@g.us', 'get', [{ tag: 'invite', attrs: { code } }])
+			return (0, exports.extractCommunityMetadata)(results)
+		},
+		communityToggleEphemeral: async (jid, ephemeralExpiration) => {
+			const content = ephemeralExpiration
+				? { tag: 'ephemeral', attrs: { expiration: ephemeralExpiration.toString() } }
+				: { tag: 'not_ephemeral', attrs: {} }
+			await communityQuery(jid, 'set', [content])
+		},
+		communitySettingUpdate: async (jid, setting) => {
+			await communityQuery(jid, 'set', [{ tag: setting, attrs: {} }])
+		},
 		communityMemberAddMode: async (jid, mode) => {
 			await communityQuery(jid, 'set', [{ tag: 'member_add_mode', attrs: {}, content: mode }])
 		},
 		communityJoinApprovalMode: async (jid, mode) => {
 			await communityQuery(jid, 'set', [
-				{ tag: 'membership_approval_mode', attrs: {}, content: [{ tag: 'group_join', attrs: { state: mode } }] }
+				{ tag: 'membership_approval_mode', attrs: {}, content: [{ tag: 'community_join', attrs: { state: mode } }] }
 			])
 		},
-		
+		/**
+		 * Update community profile picture
+		 */
 		communityUpdatePicture: async (jid, content) => {
 			const { img } = await (0, Utils_1.generateProfilePicture)(content)
 			await communityQuery(jid, 'set', [
@@ -392,24 +416,34 @@ const makeCommunitiesSocket = config => {
 				}
 			])
 		},
-		
+		/**
+		 * Remove community profile picture
+		 */
 		communityRemovePicture: async jid => {
 			await communityQuery(jid, 'set', [{ tag: 'picture', attrs: { type: 'delete' } }])
 		},
-		
+		/**
+		 * Update community settings (announce-only, etc.)
+		 */
 		communitySettingUpdate: async (jid, setting) => {
 			await communityQuery(jid, 'set', [{ tag: setting, attrs: {} }])
 		},
-		
+		/**
+		 * Deactivate/delete a community
+		 */
 		communityDeactivate: async jid => {
 			await communityQuery(jid, 'set', [{ tag: 'delete_parent', attrs: {} }])
 		},
-		
+		/**
+		 * Get info about a community from an invite link code
+		 */
 		communityGetInviteInfo: async code => {
 			const results = await communityQuery('@g.us', 'get', [{ tag: 'invite', attrs: { code } }])
 			return (0, exports.extractCommunityMetadata)(results)
 		},
-		
+		/**
+		 * Toggle ephemeral messages for the whole community
+		 */
 		communityToggleEphemeral: async (jid, ephemeralExpiration) => {
 			const content = ephemeralExpiration
 				? { tag: 'ephemeral', attrs: { expiration: ephemeralExpiration.toString() } }
@@ -418,50 +452,52 @@ const makeCommunitiesSocket = config => {
 		},
 		communityFetchAllParticipating,
 
-		
+		// ── MEX queries (JSON responses) ──────────────────────────────────────
 
-		
-		communityParticipantCount: async jid => {
-			const result = await mexQuery(
+		/**
+		 * Fetch total participant count of a community via MEX.
+		 * @param {string} jid - Community JID
+		 */
+		communityParticipantCount: jid =>
+			mexQuery(
 				{ group_input: { group_id: jid } },
 				COMMUNITY_MEX_QUERY_IDS.QUERY_PARTICIPANT_COUNT,
 				'xwa2_group_query_by_id'
-			)
-			return result?.participant_count ?? result?.participantCount ?? result?.count ?? result
-		},
+			),
 
-		
-		communitySubgroupsMex: async jid => {
-			const result = await mexQuery(
-				{ group_input: { group_id: jid } },
-				COMMUNITY_MEX_QUERY_IDS.QUERY_SUBGROUPS,
-				'xwa2_group_query_by_id'
-			)
-			return result?.subgroups ?? result?.linked_groups ?? result?.sub_groups ?? result
-		},
+		/**
+		 * Fetch subgroups of a community via MEX (includes hidden_group, join approval state, etc.)
+		 * @param {string} jid - Community JID
+		 */
+		communitySubgroupsMex: jid =>
+			mexQuery({ group_input: { group_id: jid } }, COMMUNITY_MEX_QUERY_IDS.QUERY_SUBGROUPS, 'xwa2_group_query_by_id'),
 
-		
-		communitySubgroupParticipantCount: async subgroupJid => {
-			const result = await mexQuery(
+		/**
+		 * Fetch participant count of a specific subgroup within a community.
+		 * @param {string} subgroupJid - Subgroup JID
+		 */
+		communitySubgroupParticipantCount: subgroupJid =>
+			mexQuery(
 				{ group_input: { group_id: subgroupJid } },
 				COMMUNITY_MEX_QUERY_IDS.QUERY_SUBGROUP_PARTICIPANT_COUNT,
 				'xwa2_group_query_by_id'
-			)
-			return result?.participant_count ?? result?.participantCount ?? result?.count ?? result
-		},
+			),
 
-		
-		communityTransferOwnershipMex: async (communityJid, newOwnerJid) => {
-			const result = await mexQuery(
+		/**
+		 * Transfer community ownership to a new owner via MEX.
+		 * Sends role_updates: [{ user_jid, new_role: "SUPERADMIN_MEMBER" }]
+		 * @param {string} communityJid - Community JID
+		 * @param {string} newOwnerJid - JID of the new owner
+		 */
+		communityTransferOwnershipMex: (communityJid, newOwnerJid) =>
+			mexQuery(
 				{
 					group_id: communityJid,
 					role_updates: [{ user_jid: newOwnerJid, new_role: 'SUPERADMIN_MEMBER' }]
 				},
 				COMMUNITY_MEX_QUERY_IDS.UPDATE_OWNER,
 				'xwa2_community_update_owner'
-			)
-			return result?.status === 'ok' || !!result?.success || !!result
-		},
+			),
 
 		COMMUNITY_MEX_QUERY_IDS
 	}
@@ -481,12 +517,6 @@ const extractCommunityMetadata = result => {
 		: (0, WABinary_1.jidEncode)(community.attrs.id || '', 'g.us')
 	const eph = (0, WABinary_1.getBinaryNodeChild)(community, 'ephemeral')?.attrs.expiration
 	const memberAddMode = (0, WABinary_1.getBinaryNodeChildString)(community, 'member_add_mode') === 'all_member_add'
-	const linkedGroupsNode = (0, WABinary_1.getBinaryNodeChild)(community, 'linked_groups')
-	const linkLimit = community.attrs.parent_group_link_limit
-		? +community.attrs.parent_group_link_limit
-		: linkedGroupsNode?.attrs?.parent_group_link_limit
-			? +linkedGroupsNode.attrs.parent_group_link_limit
-			: undefined
 	const metadata = {
 		id: communityId,
 		subject: community.attrs.subject || '',
@@ -506,39 +536,13 @@ const extractCommunityMetadata = result => {
 		memberAddMode,
 		participants: (0, WABinary_1.getBinaryNodeChildren)(community, 'participant').map(({ attrs }) => {
 			return {
+				// TODO: IMPLEMENT THE PN/LID FIELDS HERE!!
 				id: attrs.jid,
-				admin: attrs.type || null,
-				...(attrs.lid ? { lid: attrs.lid } : {}),
-				...(attrs.pn ? { pn: attrs.pn } : {})
+				admin: attrs.type || null
 			}
 		}),
 		ephemeralDuration: eph ? +eph : undefined,
-		addressingMode: (0, WABinary_1.getBinaryNodeChildString)(community, 'addressing_mode'),
-		linkLimit,
-		suspendAppealStatus: community.attrs.suspend_appeal_status || community.attrs.appeal_status || undefined,
-		allowMemberSuggestM3:
-			community.attrs.parent_group_allow_member_suggest_existing_m3 === 'true'
-				? true
-				: community.attrs.parent_group_allow_member_suggest_existing_m3 === 'false'
-					? false
-					: undefined,
-		allowMemberSuggestM3ForAdmin:
-			community.attrs.parent_group_allow_member_suggest_existing_m3_for_admin === 'true'
-				? true
-				: community.attrs.parent_group_allow_member_suggest_existing_m3_for_admin === 'false'
-					? false
-					: undefined,
-		subgroupPollInterval: community.attrs.improve_subgroup_activation_subgroup_poll_interval
-			? Number(community.attrs.improve_subgroup_activation_subgroup_poll_interval)
-			: undefined,
-		isGeneralSubgroup:
-			community.attrs.general_subgroup != null
-				? community.attrs.general_subgroup === 'true' || community.attrs.general_subgroup === true
-				: undefined,
-		isHiddenSubgroup:
-			community.attrs.hidden_subgroup != null
-				? community.attrs.hidden_subgroup === 'true' || community.attrs.hidden_subgroup === true
-				: undefined
+		addressingMode: (0, WABinary_1.getBinaryNodeChildString)(community, 'addressing_mode')
 	}
 	return metadata
 }