feat: Added option to filter chat and contacts with label (close #436)

src/chat/functions/list.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import { ChatModel, ChatStore } from '../../whatsapp';
+import { ChatModel, ChatStore, LabelStore } from '../../whatsapp';
 
 export interface ChatListOptions {
   onlyGroups?: boolean;
   onlyUsers?: boolean;
   onlyWithUnreadMessage?: boolean;
+  withLabels?: string[];
 }
 
 /**
@@ -28,13 +29,22 @@ 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
@@ -56,5 +66,19 @@ export async function list(
     models = models.filter((c) => c.hasUnread);
   }
 
+  if (options.withLabels) {
+    const ids = options.withLabels.map((value) => {
+      const label = LabelStore.findFirst((l) => l.name === value);
+
+      if (label) {
+        return label.id;
+      }
+
+      return value;
+    });
+
+    models = models.filter((c) => c.labels?.some((id) => ids.includes(id)));
+  }
+
   return models;
 }

src/contact/functions/list.ts

@@ -14,10 +14,11 @@
  * limitations under the License.
  */
 
-import { ContactModel, ContactStore } from '../../whatsapp';
+import { ContactModel, ContactStore, LabelStore } from '../../whatsapp';
 
 export interface ContactListOptions {
   onlyMyContacts?: boolean;
+  withLabels?: string[];
 }
 
 /**
@@ -29,7 +30,16 @@ export interface ContactListOptions {
  * const contats = await WPP.contact.list();
  *
  * // Only my contacts
- * const contatcs = await WPP.contact.list({onlyMyContacts: true});
+ * 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
@@ -43,5 +53,18 @@ export async function list(
     models = models.filter((c) => c.isMyContact);
   }
 
+  if (options.withLabels) {
+    const ids = options.withLabels.map((value) => {
+      const label = LabelStore.findFirst((l) => l.name === value);
+
+      if (label) {
+        return label.id;
+      }
+
+      return value;
+    });
+
+    models = models.filter((c) => c.labels?.some((id) => ids.includes(id)));
+  }
   return models;
 }

src/whatsapp/models/ContactModel.ts

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

src/whatsapp/models/ModelChatBase.ts

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