Merge pull request #21 from canove/develop

merge development branch

Author: canove

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "whaileys",
-  "version": "6.2.4",
+  "version": "6.2.5",
   "description": "WhatsApp API",
   "homepage": "https://github.com/canove/whaileys",
   "main": "lib/index.js",

package.json

@@ -15,7 +15,13 @@ import {
   WAMessage,
   WAPatchCreate,
   WAPatchName,
-  WAPresence
+  WAPresence,
+  WAPrivacyCallValue,
+  WAPrivacyGroupAddValue,
+  WAPrivacyMessagesValue,
+  WAPrivacyOnlineValue,
+  WAPrivacyValue,
+  WAReadReceiptsValue
 } from "../Types";
 import {
   chatModificationToAppPatch,
@@ -94,6 +100,62 @@ export const makeChatsSocket = (config: SocketConfig) => {
     return privacySettings;
   };
 
+  /** helper function to run a privacy IQ query */
+  const privacyQuery = async (name: string, value: string) => {
+    await query({
+      tag: "iq",
+      attrs: {
+        xmlns: "privacy",
+        to: S_WHATSAPP_NET,
+        type: "set"
+      },
+      content: [
+        {
+          tag: "privacy",
+          attrs: {},
+          content: [
+            {
+              tag: "category",
+              attrs: { name, value }
+            }
+          ]
+        }
+      ]
+    });
+  };
+
+  const updateMessagesPrivacy = async (value: WAPrivacyMessagesValue) => {
+    await privacyQuery("messages", value);
+  };
+
+  const updateCallPrivacy = async (value: WAPrivacyCallValue) => {
+    await privacyQuery("calladd", value);
+  };
+
+  const updateLastSeenPrivacy = async (value: WAPrivacyValue) => {
+    await privacyQuery("last", value);
+  };
+
+  const updateOnlinePrivacy = async (value: WAPrivacyOnlineValue) => {
+    await privacyQuery("online", value);
+  };
+
+  const updateProfilePicturePrivacy = async (value: WAPrivacyValue) => {
+    await privacyQuery("profile", value);
+  };
+
+  const updateStatusPrivacy = async (value: WAPrivacyValue) => {
+    await privacyQuery("status", value);
+  };
+
+  const updateReadReceiptsPrivacy = async (value: WAReadReceiptsValue) => {
+    await privacyQuery("readreceipts", value);
+  };
+
+  const updateGroupsAddPrivacy = async (value: WAPrivacyGroupAddValue) => {
+    await privacyQuery("groupadd", value);
+  };
+
   /** helper function to run a generic IQ query */
   const interactiveQuery = async (
     userNodes: BinaryNode[],
@@ -884,6 +946,14 @@ export const makeChatsSocket = (config: SocketConfig) => {
     onWhatsApp,
     fetchBlocklist,
     fetchStatus,
+    updateCallPrivacy,
+    updateMessagesPrivacy,
+    updateLastSeenPrivacy,
+    updateOnlinePrivacy,
+    updateProfilePicturePrivacy,
+    updateStatusPrivacy,
+    updateReadReceiptsPrivacy,
+    updateGroupsAddPrivacy,
     updateProfilePicture,
     updateProfileStatus,
     updateProfileName,

src/Socket/chats.ts

@@ -300,8 +300,13 @@ export const extractGroupMetadata = (result: BinaryNode) => {
       : undefined,
     desc,
     descId,
+    linkedParent:
+      getBinaryNodeChild(group, "linked_parent")?.attrs.jid || undefined,
     restrict: !!getBinaryNodeChild(group, "locked"),
     announce: !!getBinaryNodeChild(group, "announcement"),
+    isCommunity: !!getBinaryNodeChild(group, "parent"),
+    isCommunityAnnounce: !!getBinaryNodeChild(group, "default_sub_group"),
+    joinApprovalMode: !!getBinaryNodeChild(group, "membership_approval_mode"),
     participants: getBinaryNodeChildren(group, "participant").map(
       ({ attrs }) => {
         return {

src/Socket/groups.ts

@@ -818,17 +818,6 @@ export const makeMessagesRecvSocket = (config: SocketConfig) => {
 
           cleanMessage(msg, authState.creds.me!.id);
 
-          if (
-            msg.message?.protocolMessage?.type ===
-              proto.Message.ProtocolMessage.Type.SHARE_PHONE_NUMBER &&
-            node.attrs.sender_pn
-          ) {
-            ev.emit("chats.phoneNumberShare", {
-              lid: node.attrs.from,
-              jid: node.attrs.sender_pn
-            });
-          }
-
           await upsertMessage(msg, node.attrs.offline ? "append" : "notify");
         })
       ]);

src/Socket/messages-recv.ts

@@ -3,6 +3,19 @@ import type { AccountSettings } from "./Auth";
 import type { BufferedEventData } from "./Events";
 import type { MinimalMessage } from "./Message";
 
+/** privacy settings in WhatsApp Web */
+export type WAPrivacyValue = "all" | "contacts" | "contact_blacklist" | "none";
+
+export type WAPrivacyOnlineValue = "all" | "match_last_seen";
+
+export type WAPrivacyGroupAddValue = "all" | "contacts" | "contact_blacklist";
+
+export type WAReadReceiptsValue = "all" | "none";
+
+export type WAPrivacyCallValue = "all" | "known";
+
+export type WAPrivacyMessagesValue = "all" | "contacts";
+
 /** set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send */
 export type WAPresence =
   | "unavailable"
@@ -67,6 +80,11 @@ export type LastMessageList =
   | MinimalMessage[]
   | proto.SyncActionValue.ISyncActionMessageRange;
 
+export type VoteAggregation = {
+  name: string;
+  voters: string[];
+};
+
 export type ChatModification =
   | {
       archive: boolean;

src/Types/Chat.ts

@@ -32,6 +32,7 @@ export type BaileysEventMap = {
   "chats.upsert": Chat[];
   /** update the given chats */
   "chats.update": ChatUpdate[];
+  /** @deprecated Use contacts.phone-number-share instead */
   "chats.phoneNumberShare": { lid: string; jid: string };
   /** delete chats with given ID */
   "chats.delete": string[];
@@ -43,6 +44,8 @@ export type BaileysEventMap = {
 
   "contacts.upsert": Contact[];
   "contacts.update": Partial<Contact>[];
+  /** contact decided to share his phone number that was hidden */
+  "contacts.phone-number-share": { lid: string; jid: string };
 
   "messages.delete": { keys: WAMessageKey[] } | { jid: string; all: true };
   "messages.update": WAMessageUpdate[];

src/Types/Events.ts

@@ -22,6 +22,14 @@ export interface GroupMetadata {
   desc?: string;
   descOwner?: string;
   descId?: string;
+  /** Request approval to join the group */
+  joinApprovalMode?: boolean;
+  /** if this group is part of a community, it returns the jid of the community to which it belongs */
+  linkedParent?: string;
+  /** is this a community */
+  isCommunity?: boolean;
+  /** is this the announce of a community */
+  isCommunityAnnounce?: boolean;
   /** is set when the group only allows admins to change group settings */
   restrict?: boolean;
   /** is set when the group only allows admins to write messages */

src/Types/GroupMetadata.ts

@@ -108,7 +108,7 @@ export const decodeMessageStanza = (
 
   const sender = msgType === "chat" ? author : chatId;
 
-  const fromMe = (isLidUser(from) ? isMeLid : isMe)(
+  const fromMe = (isLidUser(from) || isLidUser(participant) ? isMeLid : isMe)(
     stanza.attrs.participant || stanza.attrs.from
   );
   const pushname = stanza.attrs.notify;

src/Utils/decode-wa-message.ts

@@ -20,6 +20,7 @@ import {
   MessageGenerationOptionsFromContent,
   MessageType,
   MessageUserReceipt,
+  VoteAggregation,
   WAMediaUpload,
   WAMessage,
   WAMessageContent,
@@ -37,6 +38,7 @@ import {
   getAudioDuration,
   MediaDownloadOptions
 } from "./messages-media";
+import { sha256 } from "./crypto";
 
 type MediaUploadData = {
   media: WAMediaUpload;
@@ -707,6 +709,74 @@ export const updateMessageWithReaction = (
   msg.reactions = reactions;
 };
 
+/** Update the message with a new poll update */
+export const updateMessageWithPollUpdate = (
+  msg: Pick<WAMessage, "pollUpdates">,
+  update: proto.IPollUpdate
+) => {
+  const authorID = getKeyAuthor(update.pollUpdateMessageKey);
+
+  const reactions = (msg.pollUpdates || []).filter(
+    r => getKeyAuthor(r.pollUpdateMessageKey) !== authorID
+  );
+  if (update.vote?.selectedOptions?.length) {
+    reactions.push(update);
+  }
+
+  msg.pollUpdates = reactions;
+};
+
+/**
+ * Aggregates all poll updates in a poll.
+ * @param msg the poll creation message
+ * @param meId your jid
+ * @returns A list of options & their voters
+ */
+export function getAggregateVotesInPollMessage({
+  message,
+  pollUpdates
+}: Pick<WAMessage, "pollUpdates" | "message">) {
+  const opts =
+    message?.pollCreationMessage?.options ||
+    message?.pollCreationMessageV2?.options ||
+    message?.pollCreationMessageV3?.options ||
+    [];
+  const voteHashMap = opts.reduce(
+    (acc, opt) => {
+      const hash = sha256(Buffer.from(opt.optionName || "")).toString();
+      acc[hash] = {
+        name: opt.optionName || "",
+        voters: []
+      };
+      return acc;
+    },
+    {} as { [_: string]: VoteAggregation }
+  );
+
+  for (const update of pollUpdates || []) {
+    const { vote } = update;
+    if (!vote) {
+      continue;
+    }
+
+    for (const option of vote.selectedOptions || []) {
+      const hash = option.toString();
+      let data = voteHashMap[hash];
+      if (!data) {
+        voteHashMap[hash] = {
+          name: "Unknown",
+          voters: []
+        };
+        data = voteHashMap[hash];
+      }
+
+      voteHashMap[hash]!.voters.push(getKeyAuthor(update.pollUpdateMessageKey));
+    }
+  }
+
+  return Object.values(voteHashMap);
+}
+
 /** Given a list of message keys, aggregates them by chat & sender. Useful for sending read receipts in bulk */
 export const aggregateMessageKeysNotFromMe = (keys: proto.IMessageKey[]) => {
   const keyMap: {