Release 3.11.0

open-wa · Apr 17, 2021 · e7716ca · e7716ca
1 parent f8ceb8e
commit e7716ca
Show file tree

Hide file tree

Showing 98 changed files with 513 additions and 314 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-## [v3.10.15](https://github.com/open-wa/wa-automate-nodejs/compare/3.10.14...v3.10.15)
+## [v3.11.0](https://github.com/open-wa/wa-automate-nodejs/compare/3.10.15...v3.11.0)
+
+### Merged
+
+- build(deps-dev): bump @types/node from 14.14.37 to 14.14.39 [`#1587`](https://github.com/open-wa/wa-automate-nodejs/pull/1587)
+- build(deps): bump ts-json-schema-generator from 0.89.3 to 0.90.0 [`#1586`](https://github.com/open-wa/wa-automate-nodejs/pull/1586)
+
+### Fixed
+
+- 🐛  fixes #1589 [`#1589`](https://github.com/open-wa/wa-automate-nodejs/issues/1589)
+
+### Commits
+
+- ✨ feat: installed optional PQueue on `onMessage` and `onAnyMessage` #1592 [`08c28c5`](https://github.com/open-wa/wa-automate-nodejs/commit/08c28c55a459a246c1bd092f0e6c1fb7354655eb)
+- ✨ feat[insiders]: `client.createLabel` #1591 [`ebd1251`](https://github.com/open-wa/wa-automate-nodejs/commit/ebd1251dbe5be6f975e039b243e5ff47dcea5c77)
+- 🎨 update MessageCollector to work with new event signatures #1590 [`d3b1654`](https://github.com/open-wa/wa-automate-nodejs/commit/d3b1654df77ba0e24ae54197cc85b9a5be99e5f0)
+- 🐛  #1590 - client events emit on specific session instance. This is just a band aid. Please ensure each instance in the same process has a seperate session Id [`25d28f5`](https://github.com/open-wa/wa-automate-nodejs/commit/25d28f5a2100c7595ce45575296d7a69b8c47af3)
+- ✨ feat: Implemented `client.getListenerQueues()` #1592 [`f8ceb8e`](https://github.com/open-wa/wa-automate-nodejs/commit/f8ceb8e2cbd9d55dfbd0d09211a0d14df180dc78)
+
+## [3.10.15](https://github.com/open-wa/wa-automate-nodejs/compare/3.10.14...3.10.15) - 2021-04-14
 
 ### Merged
 
@@ -19,6 +38,10 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - 🐛  fix #1585 [`#1585`](https://github.com/open-wa/wa-automate-nodejs/issues/1585)
 
+### Commits
+
+- Release 3.10.15 [`269c850`](https://github.com/open-wa/wa-automate-nodejs/commit/269c8504afb1f81ea629ee3ce2a9a03a8182fbae)
+
 ## [3.10.14](https://github.com/open-wa/wa-automate-nodejs/compare/3.10.13...3.10.14) - 2021-04-13
 
 ### Merged

diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/classes/api_client.client.html b/docs/classes/api_client.client.html
diff --git a/docs/classes/api_model_errors.addparticipanterror.html b/docs/classes/api_model_errors.addparticipanterror.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>AddParticipantError | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>AddParticipantError | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/classes/api_model_errors.customerror.html b/docs/classes/api_model_errors.customerror.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>CustomError | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>CustomError | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/classes/api_model_errors.pageevaluationtimeout.html b/docs/classes/api_model_errors.pageevaluationtimeout.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>PageEvaluationTimeout | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>PageEvaluationTimeout | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/classes/api_model_errors.sessionexpirederror.html b/docs/classes/api_model_errors.sessionexpirederror.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>SessionExpiredError | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>SessionExpiredError | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/classes/structures_collector.collection.html b/docs/classes/structures_collector.collection.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Collection | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>Collection | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/classes/structures_collector.collector.html b/docs/classes/structures_collector.collector.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Collector | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>Collector | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/classes/structures_messagecollector.messagecollector.html b/docs/classes/structures_messagecollector.messagecollector.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>MessageCollector | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>MessageCollector | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -118,6 +118,7 @@ <h3>Properties</h3>
 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="structures_messagecollector.messagecollector.html#collected" class="tsd-kind-icon">collected</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="structures_messagecollector.messagecollector.html#ended" class="tsd-kind-icon">ended</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="structures_messagecollector.messagecollector.html#filter" class="tsd-kind-icon">filter</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="structures_messagecollector.messagecollector.html#instanceid" class="tsd-kind-icon">instance<wbr>Id</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="structures_messagecollector.messagecollector.html#options" class="tsd-kind-icon">options</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="structures_messagecollector.messagecollector.html#received" class="tsd-kind-icon">received</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="structures_messagecollector.messagecollector.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a></li>
@@ -181,7 +182,7 @@ <h2>Constructors</h2>
 					<a name="constructor" class="tsd-anchor"></a>
 					<h3>constructor</h3>
 					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
-						<li class="tsd-signature tsd-kind-icon">new <wbr>Message<wbr>Collector<span class="tsd-signature-symbol">(</span>sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chat<span class="tsd-signature-symbol">: </span><a href="../modules/api_model_aliases.html#chatid" class="tsd-signature-type" data-tsd-kind="Type alias">ChatId</a>, filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/structures_collector.collectoroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollectorOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="structures_messagecollector.messagecollector.html" class="tsd-signature-type" data-tsd-kind="Class">MessageCollector</a></li>
+						<li class="tsd-signature tsd-kind-icon">new <wbr>Message<wbr>Collector<span class="tsd-signature-symbol">(</span>sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, instanceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chat<span class="tsd-signature-symbol">: </span><a href="../modules/api_model_aliases.html#chatid" class="tsd-signature-type" data-tsd-kind="Type alias">ChatId</a>, filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/structures_collector.collectoroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollectorOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="structures_messagecollector.messagecollector.html" class="tsd-signature-type" data-tsd-kind="Class">MessageCollector</a></li>
 					</ul>
 					<ul class="tsd-descriptions">
 						<li class="tsd-description">
@@ -203,6 +204,12 @@ <h5>sessionId: <span class="tsd-signature-type">string</span></h5>
 										<p>The id of the session</p>
 									</div>
 								</li>
+								<li>
+									<h5>instanceId: <span class="tsd-signature-type">string</span></h5>
+									<div class="tsd-comment tsd-typography">
+										<p>The id of the current instance of the session (see: client.getInstanceId)</p>
+									</div>
+								</li>
 								<li>
 									<h5>chat: <a href="../modules/api_model_aliases.html#chatid" class="tsd-signature-type" data-tsd-kind="Type alias">ChatId</a></h5>
 								</li>
@@ -312,6 +319,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
 						</ul>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="instanceid" class="tsd-anchor"></a>
+					<h3>instance<wbr>Id</h3>
+					<div class="tsd-signature tsd-kind-icon">instance<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+					<aside class="tsd-sources">
+					</aside>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
 					<a name="options" class="tsd-anchor"></a>
 					<h3>options</h3>
@@ -1638,6 +1652,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
 								<a href="structures_messagecollector.messagecollector.html#filter" class="tsd-kind-icon">filter</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="structures_messagecollector.messagecollector.html#instanceid" class="tsd-kind-icon">instance<wbr>Id</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
 								<a href="structures_messagecollector.messagecollector.html#options" class="tsd-kind-icon">options</a>
 							</li>

diff --git a/docs/enums/api_client.namespace.html b/docs/enums/api_client.namespace.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>namespace | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>namespace | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/enums/api_functions_exposed_enum.exposedfn.html b/docs/enums/api_functions_exposed_enum.exposedfn.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>ExposedFn | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>ExposedFn | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/enums/api_model.events.html b/docs/enums/api_model.events.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Events | @open-wa/wa-automate - v3.10.15</title>
-	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.10.15">
+	<title>Events | @open-wa/wa-automate - v3.11.0</title>
+	<meta name="description" content="Documentation for @open-wa/wa-automate - v3.11.0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<link rel="stylesheet" href="../assets/css/pages.css">
@@ -31,7 +31,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@open-wa/wa-automate - v3.10.15</a>
+					<a href="../index.html" class="title">@open-wa/wa-automate - v3.11.0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">