@wppconnect/wa-js 2.4.1 → 2.5.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.5.0 (2022-06-04)
+
+
+### Features
+
+* Added option to filter chat and contacts with label (close [#436](https://github.com/wppconnect-team/wa-js/issues/436)) ([bff74df](https://github.com/wppconnect-team/wa-js/commit/bff74df6bc55ce657b97957752e06e0aa5c09d14))
+
+
+
 ## 2.4.1 (2022-05-31)
 
 

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

@@ -88,6 +88,35 @@ export interface ChatEventTypes {
         chat: Wid;
         seq: number;
     };
+    /**
+     * Triggered when a new reaction is received
+     *
+     * @example
+     * ```javascript
+     * WPP.on('chat.new_reaction', (msg) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'chat.new_reaction': {
+        /**
+         * Reaction ID
+         */
+        id: MsgKey;
+        /**
+         * Message ID that received the reaction
+         */
+        msgId: MsgKey;
+        /**
+         * The reaction emoji or empty if removed
+         */
+        reactionText: string;
+        read: boolean;
+        sender: Wid;
+        orphan: number;
+        orphanReason: any;
+        timestamp: number;
+    };
     /**
      * On presence change
      */

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

@@ -18,3 +18,4 @@ import './registerLiveLocationUpdateEvent';
 import './registerNewMessageEvent';
 import './registerPresenceChange';
 import './registerRevokeMessageEvent';
+import './registerReactionsEvent';

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

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2021 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/list.d.ts

@@ -18,6 +18,7 @@ export interface ChatListOptions {
     onlyGroups?: boolean;
     onlyUsers?: boolean;
     onlyWithUnreadMessage?: boolean;
+    withLabels?: string[];
 }
 /**
  * Return a list of chats
@@ -25,15 +26,24 @@ export interface ChatListOptions {
  * @example
  * ```javascript
  * // All chats
- * const chat = await WPP.chat.list();
+ * const chats = await WPP.chat.list();
  *
  * // Only users chats
- * const chat = await WPP.chat.list({onlyUsers: true});
+ * const chats = await WPP.chat.list({onlyUsers: true});
  *
  * // Only groups chats
- * const chat = await WPP.chat.list({onlyGroups: true});
+ * const chats = await WPP.chat.list({onlyGroups: true});
+ *
+ * // Only with label Text
+ * const chats = await WPP.chat.list({withLabels: ['Test']});
+ *
+ * // Only with label id
+ * const chats = await WPP.chat.list({withLabels: ['1']});
+ *
+ * // Only with label with one of text or id
+ * const chats = await WPP.chat.list({withLabels: ['Alfa','5']});
  * ```
  *
  * @category Chat
  */
-export declare function list(options: ChatListOptions): Promise<ChatModel[]>;
+export declare function list(options?: ChatListOptions): Promise<ChatModel[]>;

package/dist/conn/functions/getMyDeviceId.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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 { Wid } from '../../whatsapp';
+/**
+ * Return the current logged user ID with device id
+ *
+ * @example
+ * ```javascript
+ * const wid = WPP.conn.getMyDeviceId();
+ * console.log(wid.toString()); // Output: 123:4@c.us
+ * ```
+ */
+export declare function getMyDeviceId(): Wid | undefined;

package/dist/conn/functions/getMyUserId.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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 { Wid } from '../../whatsapp';
+/**
+ * Return the current logged user ID without device id
+ *
+ * @example
+ * ```javascript
+ * const wid = WPP.conn.getMyUserId();
+ * console.log(wid.toString()); // Output: 123@c.us
+ * ```
+ */
+export declare function getMyUserId(): Wid | undefined;

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

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 export { getAuthCode } from './getAuthCode';
+export { getMyDeviceId } from './getMyDeviceId';
+export { getMyUserId } from './getMyUserId';
 export { isAuthenticated } from './isAuthenticated';
 export { isIdle } from './isIdle';
 export { isMainLoaded } from './isMainLoaded';

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

@@ -15,4 +15,5 @@
  */
 export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
+export { ContactListOptions, list } from './list';
 export { queryExists } from './queryExists';

package/dist/contact/functions/list.d.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright 2021 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 { ContactModel } from '../../whatsapp';
+export interface ContactListOptions {
+    onlyMyContacts?: boolean;
+    withLabels?: string[];
+}
+/**
+ * Return a list of contacts
+ *
+ * @example
+ * ```javascript
+ * // All contacts
+ * const contats = await WPP.contact.list();
+ *
+ * // Only my contacts
+ * const contacts = await WPP.contact.list({onlyMyContacts: true});
+ *
+ * // Only with label Text
+ * const contacts = await WPP.contact.list({withLabels: ['Test']});
+ *
+ * // Only with label id
+ * const contacts = await WPP.contact.list({withLabels: ['1']});
+ *
+ * // Only with label with one of text or id
+ * const contacts = await WPP.contact.list({withLabels: ['Alfa','5']});
+ * ```
+ *
+ * @category Contact
+ */
+export declare function list(options?: ContactListOptions): Promise<ContactModel[]>;

package/dist/whatsapp/collections/Collection.d.ts

@@ -32,6 +32,7 @@ export declare class Collection<M, A = M | M[]> extends EventEmitter {
     constructor(e?: any, t?: {
         parent: any;
     });
+    get length(): number;
     add(value: A | WritableProperties<A>, options?: Option): A;
     set(value: A, options?: Option): A;
     remove(value: A, options?: {
@@ -47,9 +48,6 @@ export declare class Collection<M, A = M | M[]> extends EventEmitter {
     get(e: Stringable): M | undefined;
     assertGet(e: Stringable): M;
     at(position: number): M | undefined;
-    get length(): number;
-    get isCollection(): boolean;
-    get models(): M[];
     serialize(): any[];
     toJSON(): any[];
     isModel(model: any): model is M;

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

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2021 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 interface ReactionData {
+    msgKey: string;
+    orphan: number;
+    orphanReason: any;
+    parentMsgKey: string;
+    reactionText: string;
+    read: boolean;
+    senderUserJid: string;
+    timestamp: number;
+}
+/** @whatsapp 7394 */
+export declare function createOrUpdateReactions(data: ReactionData[]): Promise<any>;

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

@@ -16,6 +16,7 @@
 export * from './addAndSendMsgToChat';
 export * from './blockContact';
 export * from './createMsgProtobuf';
+export * from './createOrUpdateReactions';
 export * from './encryptAndSendGroupMsg';
 export * from './encryptAndSendMsg';
 export * from './fetchLinkPreview';

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

@@ -29,7 +29,7 @@ interface Props {
     privacyMode?: any;
     statusMute?: any;
     sectionHeader?: any;
-    labels?: any;
+    labels?: string[];
     disappearingModeDuration?: any;
     disappearingModeSettingTimestamp?: any;
 }

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

@@ -20,7 +20,7 @@ import { MsgModel } from './MsgModel';
 export interface PropsChatBase {
     id: Wid;
     pendingMsgs: boolean;
-    labels: any | undefined;
+    labels?: string[];
 }
 export interface SessionChatBase {
     msgChunks: MsgLoad[];

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

@@ -25,10 +25,14 @@ interface Session {
 }
 interface Derived {
 }
-/** @whatsapp 80666 */
+/** @whatsapp 80666
+ * @whatsapp 81130 >= 2.2220.8
+ */
 export declare interface ReactionsModel extends ModelProxy<Props, Session, Derived> {
 }
-/** @whatsapp 80666 */
+/** @whatsapp 80666
+ * @whatsapp 81130 >= 2.2220.8
+ */
 export declare class ReactionsModel extends Model {
     constructor(proterties?: ModelPropertiesContructor<ReactionsModel>, options?: ModelOptions);
     reactions: AggReactionsCollection;