@wppconnect/wa-js 2.17.0 → 2.18.0

package/CHANGELOG.md

@@ -1 +1 @@
-# 2.17.0 (2022-12-06)
+# 2.18.0 (2022-12-15)

package/dist/chat/events/eventTypes.d.ts

@@ -135,4 +135,14 @@ export interface ChatEventTypes {
             shortName: string;
         }[];
     };
+    /**
+     * On Poll response
+     */
+    'chat.poll_response': {
+        msgId: MsgKey;
+        chatId: Wid;
+        selectedOptions: number[];
+        timestamp: number;
+        sender: Wid;
+    };
 }

package/dist/chat/events/index.d.ts

@@ -16,6 +16,7 @@
 import './registerAckMessageEvent';
 import './registerLiveLocationUpdateEvent';
 import './registerNewMessageEvent';
+import './registerPollEvent';
 import './registerPresenceChange';
 import './registerRevokeMessageEvent';
 import './registerReactionsEvent';

package/dist/chat/events/registerPollEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/chat/functions/getReactions.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey } from '../../whatsapp';
+/**
+ * Get all reactions in a message
+ * @example
+ * ```javascript
+ * WPP.chat.getReactions('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function getReactions(msgId: string): Promise<{
+    reactionByMe: {
+        id: MsgKey;
+        orphan: number;
+        msgId: MsgKey;
+        reactionText: string;
+        read: boolean;
+        senderUserJid: string;
+        timestamp: number;
+    };
+    reactions: {
+        aggregateEmoji: string;
+        hasReactionByMe: boolean;
+        senders: {
+            id: MsgKey;
+            orphan: number;
+            msgId: MsgKey;
+            reactionText: string;
+            read: boolean;
+            senderUserJid: string;
+            timestamp: number;
+        }[];
+    }[];
+}>;

package/dist/chat/functions/getVotes.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey, Wid } from '../../whatsapp';
+/**
+ * Get votes of a poll
+ * @example
+ * ```javascript
+ * WPP.chat.getVotes('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function getVotes(id: string | MsgKey): Promise<{
+    msgId: MsgKey;
+    chatId: Wid;
+    votes: {
+        selectedOptions: number[];
+        timestamp: number;
+        sender: Wid;
+    }[];
+}>;

package/dist/chat/functions/index.d.ts

@@ -31,6 +31,8 @@ export { getMessageACK } from './getMessageACK';
 export { getMessageById } from './getMessageById';
 export { getMessages, GetMessagesOptions } from './getMessages';
 export { getPlatformFromMessage } from './getPlatformFromMessage';
+export { getReactions } from './getReactions';
+export { getVotes } from './getVotes';
 export { ChatListOptions, list } from './list';
 export { markIsComposing } from './markIsComposing';
 export { markIsPaused } from './markIsPaused';

package/dist/group/functions/addParticipants.d.ts

@@ -21,13 +21,29 @@ import { Wid } from '../../whatsapp';
  *
  * @example
  * ```javascript
- * await WPP.group.addParticipants('[group@g.us]', [number@c.us]);
+ * const result = await WPP.group.addParticipants('[group@g.us]', [number@c.us]);
+ *
+ * // Get participant result:
+ * console.log(result['123@c.us'].code);
+ * console.log(result['123@c.us'].invite_code);
+ * console.log(result['123@c.us'].invite_code_exp);
+ * console.log(result['123@c.us'].message);
+ * console.log(result['123@c.us'].wid);
+ *
+ * const memberResult = result['123@c.us']; // To a variable
+ * // or
+ * const memberResult = Object.values(result)[0]; // Always the first member result
+ *
+ * // How to send a custom invite link
+ * const link = 'https://chat.whatsapp.com/' + result['123@c.us'].invite_code;
+ * console.log(link);
  * ```
  *
  * @category Group
  */
 export declare function addParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<{
     [key: `${number}@c.us`]: {
+        wid: string;
         code: number;
         message: string;
         invite_code: string | null;

package/dist/group/functions/canAdd.d.ts

@@ -14,4 +14,15 @@
  * limitations under the License.
  */
 import { Wid } from '../../whatsapp';
+/**
+ * Check if your account is allowed to add new participants
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.canAdd('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
 export declare function canAdd(groupId: string | Wid): Promise<boolean>;

package/dist/group/functions/canDemote.d.ts

@@ -14,4 +14,15 @@
  * limitations under the License.
  */
 import { Wid } from '../../whatsapp';
+/**
+ * Check if your account is allowed to demote participants
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.canDemote('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
 export declare function canDemote(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<boolean>;

package/dist/group/functions/canPromote.d.ts

@@ -14,4 +14,15 @@
  * limitations under the License.
  */
 import { Wid } from '../../whatsapp';
+/**
+ * Check if your account is allowed to promote participants
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.canPromote('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
 export declare function canPromote(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<boolean>;

package/dist/group/functions/canRemove.d.ts

@@ -14,4 +14,15 @@
  * limitations under the License.
  */
 import { Wid } from '../../whatsapp';
+/**
+ * Check if your account is allowed to remove participants
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.canRemove('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
 export declare function canRemove(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<boolean>;

package/dist/group/functions/create.d.ts

@@ -14,12 +14,43 @@
  * limitations under the License.
  */
 import { Wid } from '../../whatsapp';
+/**
+ * Create a new group
+ *
+ * The method return a object with the result of each participant as the key
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.create('Test Group', ['number@c.us']);
+ *
+ * console.log(result.gid.toString()); // Get the group ID
+ *
+ * // Get participant result:
+ * console.log(result['number@c.us'].code);
+ * console.log(result['number@c.us'].invite_code);
+ * console.log(result['number@c.us'].invite_code_exp);
+ * console.log(result['number@c.us'].message);
+ * console.log(result['number@c.us'].wid);
+ *
+ * const memberResult = result['number@c.us']; // To a variable
+ * // or
+ * const memberResult = Object.values(result)[0]; // Always the first member result
+ *
+ * // How to send a custom invite link
+ * const link = 'https://chat.whatsapp.com/' + result['number@c.us'].invite_code;
+ * console.log(link);
+ * ```
+ *
+ * @category Group
+ */
 export declare function create(groupName: string, participantsIds: (string | Wid) | (string | Wid)[]): Promise<{
     gid: Wid;
     participants: {
-        [key: string]: {
-            code: string;
+        [key: `${number}@c.us`]: {
+            wid: string;
+            code: number;
+            invite_code: string | null;
+            invite_code_exp: number | null;
         };
-    }[];
-    status: number;
+    };
 }>;

package/dist/whatsapp/functions/getReactions.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey } from '../misc';
+/**
+ * @whatsapp 297673
+ * @whatsapp 297673 >= 2.2232.6
+ */
+export interface ReactionReturn {
+    reactionByMe: any;
+    reactions: {
+        aggregateEmoji: string;
+        hasReactionByMe: boolean;
+        senders: {
+            msgKey: MsgKey;
+            orphan: number;
+            parentMsgKey: MsgKey;
+            reactionText: string;
+            read: boolean;
+            senderUserJid: string;
+            timestamp: number;
+        }[];
+    }[];
+}
+export declare function getReactions(msgId: string): Promise<ReactionReturn>;

package/dist/whatsapp/functions/getVotes.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey } from '../misc';
+import { VoteData } from './upsertVotes';
+/**
+ * @whatsapp 816349
+ * @whatsapp 816349 >= 2.2232.6
+ */
+export declare function getVotes(id: MsgKey): Promise<VoteData[]>;

package/dist/whatsapp/functions/index.d.ts

@@ -34,7 +34,9 @@ export * from './getFanOutList';
 export * from './getGroupSenderKeyList';
 export * from './getHistorySyncProgress';
 export * from './getQuotedMsgObj';
+export * from './getReactions';
 export * from './getSearchContext';
+export * from './getVotes';
 export * from './groupParticipants';
 export * from './handleAck';
 export * from './isAnimatedWebp';
@@ -73,3 +75,4 @@ export * from './updateDBForGroupAction';
 export * from './updateParticipants';
 export * from './uploadProductImage';
 export * from './uploadThumbnail';
+export * from './upsertVotes';

package/dist/whatsapp/functions/sendCreateGroup.d.ts

@@ -17,10 +17,16 @@ import { Wid } from '..';
 /** @whatsapp 79583 */
 export declare function sendCreateGroup(groupName: string, participants: Wid[], ephemeral?: number, dogfooding?: boolean): Promise<{
     gid: Wid;
-    participants: {
-        [key: string]: {
+    participants: ({
+        [key: `${number}@c.us`]: {
             code: string;
+            invite_code: string | null;
+            invite_code_exp: string | null;
         };
-    }[];
-    status: number;
+    } | {
+        userWid: Wid;
+        code: string;
+        invite_code: string | null;
+        invite_code_exp: string | null;
+    })[];
 }>;

package/dist/whatsapp/functions/sendGroupParticipants.d.ts

@@ -18,13 +18,18 @@ import { Wid } from '..';
  * @whatsapp 437722 >= 2.2222.8
  */
 export declare function sendAddParticipants(group: Wid, participants: Wid[]): Promise<{
-    participants?: {
+    participants?: ({
         [key: `${number}@c.us`]: {
             code: string;
             invite_code: string | null;
             invite_code_exp: string | null;
         };
-    }[];
+    } | {
+        userWid: Wid;
+        code: string;
+        invite_code: string | null;
+        invite_code_exp: string | null;
+    })[];
     status: number;
     [key: `${number}@c.us`]: number;
 }>;

package/dist/whatsapp/functions/upsertVotes.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey, Wid } from '../misc';
+export interface VoteData {
+    ack: number;
+    msgKey: MsgKey;
+    parentMsgKey: MsgKey;
+    selectedOptionLocalIds: number[];
+    sender: Wid;
+    senderTimestampMs: number;
+}
+/**
+ * @whatsapp 479261
+ * @whatsapp 479261 >= 2.2230
+ */
+export declare function upsertVotes(args: VoteData[]): Promise<any>;

package/dist/whatsapp/models/MsgModel.d.ts

@@ -267,6 +267,8 @@ interface Derived {
     asImage?: any;
     asVideo?: any;
     asMms?: any;
+    asPollCreation?: any;
+    asPollUpdate?: any;
     asUrl?: any;
     asRevoked?: any;
     asViewOnce?: any;
@@ -301,6 +303,11 @@ interface Derived {
     hasBodyOrFooter: boolean;
     initialPageSize?: any;
     productListHeaderImage?: any;
+    pollInvalidated?: boolean;
+    pollName?: string;
+    pollOptions?: any;
+    pollSelectableOptionsCount?: number;
+    pollUpdateParentKey?: any;
 }
 /** @whatsapp 17304 */
 export declare interface MsgModel extends ModelProxy<Props, Session, Derived> {