feat: Added WPP.contact.list function (close #434)

src/chat/functions/list.ts

@@ -39,8 +39,10 @@ export interface ChatListOptions {
  *
  * @category Chat
  */
-export async function list(options: ChatListOptions): Promise<ChatModel[]> {
-  let models = ChatStore.getModelsArray();
+export async function list(
+  options: ChatListOptions = {}
+): Promise<ChatModel[]> {
+  let models = ChatStore.getModelsArray().slice();
 
   if (options.onlyUsers) {
     models = models.filter((c) => c.isUser);

src/contact/functions/index.ts

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

src/contact/functions/list.ts

@@ -0,0 +1,47 @@
+/*!
+ * 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, ContactStore } from '../../whatsapp';
+
+export interface ContactListOptions {
+  onlyMyContacts?: boolean;
+}
+
+/**
+ * Return a list of contacts
+ *
+ * @example
+ * ```javascript
+ * // All contacts
+ * const contats = await WPP.contact.list();
+ *
+ * // Only my contacts
+ * const contatcs = await WPP.contact.list({onlyMyContacts: true});
+ * ```
+ *
+ * @category Contact
+ */
+export async function list(
+  options: ContactListOptions = {}
+): Promise<ContactModel[]> {
+  let models = ContactStore.getModelsArray().slice();
+
+  if (options.onlyMyContacts) {
+    models = models.filter((c) => c.isMyContact);
+  }
+
+  return models;
+}