Merge branch 'main' into get-pinned-msg

pedroslopez · Oct 3, 2024 · ac21953 · ac21953
2 parents fdf1f3d + 1e03ca6
commit ac21953
Show file tree

Hide file tree

Showing 98 changed files with 5,204 additions and 1,698 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,72 +1,71 @@
-name: '🐛 Bug report'
+name: '🐛 Bug Report'
 description: Create a report to help us improve
 labels: bug
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for reporting an issue :pray:.
+        ### Thank you for reporting an issue.
 
-        This issue tracker is for reporting bugs found in [`whatsapp-web.js`](https://github.com/pedroslopez/whatsapp-web.js).
+        ### Here are some important points to consider before submitting a new bug or issue:
         
-        If you have a question about how to achieve something and are struggling, please post a question in our [Discord server](https://discord.gg/wyKybbF) instead.
+        - Please report only issues related to the `whatsapp-web.js` library.
+        - Duplicate issues will be closed.
+        - Any issue opened as a question will be closed.
         
-        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
-         - `whatsapp-web.js` [Issues tab](https://github.com/pedroslopez/whatsapp-web.js/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
-         - `whatsapp-web.js` [closed Issues tab](https://github.com/pedroslopez/whatsapp-web.js/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
+        ### If you have any question about how to achieve something and are struggling, please post a question in our [Discord Server](https://discord.gg/wyKybbF) instead.
+        
+        ### Please check the links below to see if you can find a solution there:
+        
+         - [Open Issues](https://github.com/pedroslopez/whatsapp-web.js/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
+         - [Closed Issues](https://github.com/pedroslopez/whatsapp-web.js/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
+         - [Library Documentation](https://docs.wwebjs.dev/)
+         - [Guide](https://wwebjs.dev/guide)
+         - [JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide)
+         - [Node.js Documentation](https://nodejs.org/en/docs/)
 
-        The more information you fill in, the better the community can help you.
+        ### The more information you fill in, the better the community can help you.
   - type: checkboxes
     attributes:
       label: Is there an existing issue for this?
       description: Please search to see if an issue already exists for the bug you encountered.
       options:
-        - label: I have searched the existing issues
+        - label: I have searched the existing issues.
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Is this a problem caused by your code, or is it specifically because of the library?
+      description: Please check your code once again to make sure it is correct.
+      options:
+        - label: I have double-checked my code carefully.
           required: true
   - type: textarea
     id: description
     attributes:
-      label: Describe the bug
+      label: Describe the bug.
       description: Provide a clear and concise description of the challenge you are running into.
     validations:
       required: true
   - type: textarea
     id: expected
     attributes:
-      label: Expected behavior
+      label: Expected Behavior
       description: Provide a clear and concise description of what you expected to happen.
       placeholder: |
-        As a user, I expected ___ behavior but I am seeing ___
+        As a user, I expected ___ behavior, but I am seeing ___
     validations:
       required: true
   - type: textarea
     id: steps
     attributes:
       label: Steps to Reproduce the Bug or Issue
-      description: Describe the steps we have to take to reproduce the behavior.
+      description: Describe the steps we have to take to reproduce the behavior. Additionally, **please include the code snippet you used.** Use [syntax highlighting](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) for more readability.
       placeholder: |
-        1. Do X
-        2. Do Y
-        3. Do Z
-        4. See error
-    validations:
-      required: true
-  - type: textarea
-    id: relevant_code
-    attributes:
-      label: Relevant Code
-      description: If applicable, add code snippets to help explain your problem.
-    validations:
-      required: false
-  - type: dropdown
-    id: browser_type
-    attributes:
-      label: Browser Type
-      description: What web browser are you using?
-      options:
-        - Chromium
-        - Google Chrome
-        - Other (please write in Additional Context)
+        Your steps to reproduce the bug here...
+
+        ```js
+        // your code here
+        ```
     validations:
       required: true
   - type: dropdown
@@ -78,28 +77,64 @@ body:
         - WhatsApp Business
     validations:
       required: true
-  - type: dropdown
-    id: multidevice
+  - type: input
+    id: browser_type
     attributes:
-      label: Does your WhatsApp account have multidevice enabled?
-      options:
-        - Yes, I am using Multi Device
-        - No, I am not using Multi Device
+      label: Browser Type
+      description: What web browser are you using? **Also provide the browser version.**
+      placeholder: Chromium | Google Chrome | other (provide the type)
     validations:
       required: true
-  - type: textarea
+  - type: input
+    id: os
+    attributes:
+      label: Operation System Type
+      description: What OS are you using? **Also provide its version.**
+      placeholder: Mac | Windows | Linux | Docker + Ubuntu | other (provide the type)
+    validations:
+      required: true
+  - type: input
+    id: phone_os
+    attributes:
+      label: Phone OS Type
+      description: What OS are you using on your phone? **Also provide its version.**
+      placeholder: Android | iOS | other (provide the type)
+    validations:
+        required: true
+  - type: input
+    id: lib_version
     attributes:
-      label: Environment
-      description: |
-        - OS: [e.g. Mac, Windows, Linux, Docker + Ubuntu 18, etc]
-        - Phone OS: [e.g. Android, iOS]
-        - whatsapp-web.js version [e.g. 1.2.3]
-        - WhatsApp Web version [run `await client.getWWebVersion()`]:
-        - Node.js Version [e.g. 1.2.3]
+      label: WhatsApp-Web.js Version
+      description: What library version are you using? Check it in `package.json` file.
+    validations:
+        required: true
+  - type: input
+    id: wweb_version
+    attributes:
+      label: WhatsApp Web Version
+      description: What WhatsApp Web version are you using? Run `await client.getWWebVersion()`.
+    validations:
+        required: true
+  - type: input
+    id: node_version
+    attributes:
+      label: Node.js Version
+      description: What Node.js version are you using? Run `node -v` in your terminal.
+    validations:
+        required: true
+  - type: dropdown
+    id: auth_type
+    attributes:
+      label: Authentication Strategy
+      description: What authenctication strategy are you using?
+      options:
+        - LocalAuth
+        - RemoteAuth
+        - NoAuth
     validations:
       required: true
   - type: textarea
     id: additional
     attributes:
-      label: Additional context
-      description: Add any other context about the problem here.
+      label: Additional Context
+      description: Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,21 +1,50 @@
-name: 🚀 Feature request
+name: 🚀 Feature Request
 description: Suggest an idea for this project
 labels: enhancement
-
 body:
+  - type: markdown
+    attributes:
+      value: |
+        ### Thank you for suggesting a new idea for this project.
+        
+        ### Here are some important points to consider before continuing:
+        
+        - Please submit only feature requests that related to the `whatsapp-web.js` library.
+        - Duplicate feature requests will be closed.
+        - Any feature request opened as a question will be closed.
+        
+        ### If you have any question about how to achieve something and are struggling, please post a question in our [Discord Server](https://discord.gg/wyKybbF) instead.
+        
+        ### Please check the links below to see if you can find a solution there:
+        
+         - [Open Pull Requests](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Aopen+-author%3Aapp%2Fdependabot)
+         - [Merged Pull Requests](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Amerged+-author%3Aapp%2Fdependabot)
+         - [Library Documentation](https://docs.wwebjs.dev/)
+         - [Guide](https://wwebjs.dev/guide)
+         - [JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide)
+         - [Node.js Documentation](https://nodejs.org/en/docs/)
+
   - type: checkboxes
     attributes:
-      label: Is there an existing issue for this?
-      description: Please search to see if an issue related to this feature request already exists.
+      label: Is the feature you are looking for already implemented in the library?
+      description: Please check to see if an issue related to this feature request has [already been implemented](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Amerged+-author%3Aapp%2Fdependabot).
       options:
-        - label: I have searched the existing issues
+        - label: I have reviewed the implemented features.
+          required: true
+
+  - type: checkboxes
+    attributes:
+      label: Is your "solution" already implemented in an opened pull request?
+      description: Please check the [open pull requests](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Aopen+-author%3Aapp%2Fdependabot) to see if there is already an issue related to this feature request.
+      options:
+        - label: I have reviewed the existing pull requests.
           required: true
 
   - type: textarea
     attributes:
       label: Is your feature request related to a problem? Please describe.
-      description: A concise description of the problem you are facing or the motivetion behind this feature request.
-      placeholder: I faced a problem due to ...
+      description: A concise description of the problem you are facing or the motivation behind this feature request.
+      placeholder: I faced a problem due to...
     validations:
       required: false
 
@@ -28,15 +57,15 @@ body:
 
   - type: textarea
     attributes:
-      label: Describe an alternate solution.
+      label: Describe an alternate solution if you have one.
       description: Is there any other approach to solve the problem?
     validations:
       required: false
 
   - type: textarea
     attributes:
-      label: Additional context
+      label: Additional Context
       description: |
         Links? Screenshots? References? Anything that will give us more context about what you would like to see!
     validations:
-      required: false
+      required: false
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,29 +1,43 @@
 # PR Details
 
-<!--- Provide a general summary of your changes in the Title above -->
+<!-- Provide here a general summary of your changes. -->
 
 ## Description
 
-<!--- Describe your changes in detail -->
+<!-- Describe here your changes in detail. -->
 
-## Related Issue
+## Related Issue(s)
 
-<!--- Optional --->
-<!--- If there is an issue link it here: -->
+<!-- Optional --->
+<!-- If there is an issue related to the PR, link it here using a 'closes' keyword, for example: -->
+<!-- closes #XXXX (where the XXXX is an issue number) -->
+<!-- If there are multiple issues, link them as follows: -->
+<!-- closes #XXXX closes #YYYY closes #ZZZZ -->
+<!-- See more here: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword -->
 
 ## Motivation and Context
 
-<!--- Optional --->
-<!--- Why is this change required? What problem does it solve? -->
+<!-- Optional --->
+<!-- Why is this change required? What problem does it solve? -->
 
 ## How Has This Been Tested
 
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
+<!-- Please describe in detail how you tested your changes. -->
+
+### Environment
+
+<!-- Include details of your testing environment: -->
+- Machine OS: <!-- The operation system of a machine you tested the PR on. (Mac | Windows | Linux | Docker + Ubuntu | other (provide the type)) -->
+- Phone OS: <!-- The operation system of a phone you used to check the the PR functionality on. -->
+- Library Version: <!-- The whatsapp-web.js version you used to test the PR. -->
+- WhatsApp Web Version: <!-- Run `await client.getWWebVersion()` to see the WWeb version you used to test the PR. -->
+- Puppeteer Version:
+- Browser Type and Version: <!-- Chromium XX | Google Chrome XX | other (provide the type and version) -->
+- Node Version: <!-- Run `npm -v` in your terminal to see the version of Node.js being used. -->
 
 ## Types of changes
 
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+<!-- What types of changes does your code introduce? Put an `X` in all the boxes that apply: -->
 
 - [ ] Dependency change
 - [ ] Bug fix (non-breaking change which fixes an issue)
@@ -32,10 +46,8 @@
 
 ## Checklist
 
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!-- Go over all the following points, and put an `X` in all the boxes that apply: -->
 
 - [ ] My code follows the code style of this project.
 - [ ] I have updated the documentation accordingly (index.d.ts).
-
-
-
+- [ ] I have updated the usage example accordingly (example.js)
diff --git a/.gitignore b/.gitignore
@@ -74,3 +74,7 @@ typings/
 
 # local version cache
 .wwebjs_cache/
+
+# IDE's
+.idea
+.vscode
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
     <p>
 		<a href="https://www.npmjs.com/package/whatsapp-web.js"><img src="https://img.shields.io/npm/v/whatsapp-web.js.svg" alt="npm" /></a>
         <a href="https://depfu.com/github/pedroslopez/whatsapp-web.js?project_id=9765"><img src="https://badges.depfu.com/badges/4a65a0de96ece65fdf39e294e0c8dcba/overview.svg" alt="Depfu" /></a>
-        <img src="https://img.shields.io/badge/WhatsApp_Web-2.2346.52-brightgreen.svg" alt="WhatsApp_Web 2.2346.52" />
+        <img src="https://img.shields.io/badge/WhatsApp_Web-2.3000.1016590837-brightgreen.svg" alt="WhatsApp_Web 2.2346.52" />
         <a href="https://discord.gg/H7DqQs4"><img src="https://img.shields.io/discord/698610475432411196.svg?logo=discord" alt="Discord server" /></a>
 	</p>
     <br />

diff --git a/docs/Base.html b/docs/Base.html
@@ -4,7 +4,7 @@
 <head>
   <meta name="generator" content="JSDoc 3.6.11">
   <meta charset="utf-8">
-  <title>whatsapp-web.js 1.23.0 &raquo; Class: Base</title>
+  <title>whatsapp-web.js 1.26.0 &raquo; Class: Base</title>
   <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
   <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
   <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@@ -15,7 +15,7 @@
   <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
     <div id="jsdoc-navbar-container">
       <div id="jsdoc-navbar-content">
-        <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>23.<wbr>0</a>
+        <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>25.<wbr>0</a>
       </div>
     </div>
   </nav>
@@ -50,7 +50,7 @@ <h2 id="Base">new&nbsp;<span class="symbol-name">Base</span><span class="signatu
   <footer id="jsdoc-footer" class="jsdoc-footer">
     <div id="jsdoc-footer-container">
       <p>
-        Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on October 21, 2023.
+        Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on September 18, 2024.
       </p>
     </div>
   </footer>
-Original file line number
+Diff line change
@@ Expand Up / @@ -74,3 +74,7 @@ typings/ @@
     # local version cache
     .wwebjs_cache/
+    # IDE's
+    .idea
+    .vscode