@twilio/conversations 2.2.0-rc.12 → 2.2.0-rc.14

package/docs/classes/Conversation.html

@@ -3722,20 +3722,25 @@ img {
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<p>Get unread messages count for the user if they are a participant of this
+								<p>Get count of unread messages for the user if they are a participant of this
 								conversation. Rejects if the user is not a participant of the conversation.</p>
 							</div>
 							<p>Use this method to obtain the number of unread messages together with
 								<a href="Conversation.html#updateLastReadMessageIndex">Conversation.updateLastReadMessageIndex</a> instead of relying on the
 							message indices which may have gaps. See <a href="Message.html#index">Message.index</a> for details.</p>
 							<p>This method is semi-realtime. This means that this data will be eventually
-								correct, but will also be possibly incorrect for a few seconds. The
+								correct, but it will also be possibly incorrect for a few seconds. The
 								Conversations system does not provide real time events for counter values
 							changes.</p>
 							<p>This is useful for any UI badges, but it is not recommended to build any
 							core application logic based on these counters being accurate in real time.</p>
+							<p>If the read horizon is not set, this function will return null. This could mean
+								that all messages in the conversation are unread, or that the read horizon system
+							is not being used. How to interpret this <code>null</code> value is up to the customer application.</p>
 						</div>
 						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
+						<p>Number of unread messages based on the current read horizon set for
+						the user or <code>null</code> if the read horizon is not set.</p>
 					</li>
 				</ul>
 			</section>
@@ -3907,7 +3912,7 @@ img {
 							</div>
 						</div>
 						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
-						<p>Resulting unread messages count in the conversation.</p>
+						<p>New count of unread messages after this update.</p>
 					</li>
 				</ul>
 			</section>
@@ -4043,7 +4048,7 @@ img {
 							</li>
 						</ul>
 						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
-						<p>Resulting unread messages count in the conversation.</p>
+						<p>New count of unread messages after this update.</p>
 					</li>
 				</ul>
 			</section>

package/docs/classes/Message.html

@@ -3043,13 +3043,13 @@ img {
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<p>Index of the message in the conversation&#39;s messages list.
-									By design of the Conversations system, the message indices may have arbitrary gaps between them,
-									that does not necessarily mean they were deleted or otherwise modified - just that
-								messages may have some non-contiguous indices even if they are being sent immediately one after another.</p>
+								<p>Index of this message in the conversation&#39;s list of messages.</p>
 							</div>
+							<p>By design, the message indices may have arbitrary gaps between them,
+								that does not necessarily mean they were deleted or otherwise modified - just that
+							messages may have some non-contiguous indices even if they are being sent immediately one after another.</p>
 							<p>Trying to use indices for some calculations is going to be unreliable.</p>
-							<p>To calculate the number of unread messages it is better to use the read horizon API.
+							<p>To calculate the number of unread messages, it is better to use the Read Horizon API.
 							See <a href="Conversation.html#getUnreadMessagesCount">Conversation.getUnreadMessagesCount</a> for details.</p>
 						</div>
 						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>

package/docs/index.html

@@ -2857,29 +2857,33 @@ img {
 			<p>Using this method, you can <code>require</code> <code>twilio-conversations</code> and then use the
 			client:</p>
 			<pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">Client</span><span style="color: #000000"> } = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">'@twilio/conversations'</span><span style="color: #000000">);</span>
+
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
-<span style="color: #008000">// Before you use the client, subscribe to the `'stateChanged'` event and wait </span>
-<span style="color: #008000">// for the `'initialized'` state to be reported.</span>
-<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">'initialized'</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #008000">// Use the client</span>
-<span style="color: #000000">  }</span>
-<span style="color: #000000">  </span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">error</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #008000">// Handle error</span>
-<span style="color: #000000">  }</span>
+
+<span style="color: #008000">// Before you use the client, subscribe to the `'initialized'` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'initialized'</span><span style="color: #000000">, () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Use the client.</span>
 <span style="color: #000000">}</span>
+
+<span style="color: #008000">// To catch client initialization errors, subscribe to the `'initFailed'` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'initFailed'</span><span style="color: #000000">, ({ </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Handle the error.</span>
+<span style="color: #000000">});</span>
 </code></pre>
 			<p>The SDK could also be imported using the ES module syntax:</p>
 			<pre><code><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Client</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@twilio/conversations'</span><span style="color: #000000">;</span>
+
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
-<span style="color: #008000">// Before you use the client, subscribe to the `'stateChanged'` event and wait </span>
-<span style="color: #008000">// for the `'initialized'` state to be reported.</span>
-<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">'initialized'</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #008000">// Use the client</span>
-<span style="color: #000000">  }</span>
+
+<span style="color: #008000">// Before you use the client, subscribe to the `'initialized'` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'initialized'</span><span style="color: #000000">, () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Use the client.</span>
 <span style="color: #000000">}</span>
+
+<span style="color: #008000">// To catch client initialization errors, subscribe to the `'initFailed'` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'initFailed'</span><span style="color: #000000">, ({ </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Handle the error.</span>
+<span style="color: #000000">});</span>
 </code></pre>
 			<a href="#cdn" id="cdn" style="color: inherit; text-decoration: none;">
 				<h3>CDN</h3>

package/docs/modules.html

@@ -2859,29 +2859,33 @@ img {
 			<p>Using this method, you can <code>require</code> <code>twilio-conversations</code> and then use the
 			client:</p>
 			<pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">Client</span><span style="color: #000000"> } = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">);</span>
+
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
-<span style="color: #008000">// Before you use the client, subscribe to the `&#039;stateChanged&#039;` event and wait </span>
-<span style="color: #008000">// for the `&#039;initialized&#039;` state to be reported.</span>
-<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;stateChanged&#039;</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">&#039;initialized&#039;</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #008000">// Use the client</span>
-<span style="color: #000000">  }</span>
-<span style="color: #000000">  </span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">error</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #008000">// Handle error</span>
-<span style="color: #000000">  }</span>
+
+<span style="color: #008000">// Before you use the client, subscribe to the `&#039;initialized&#039;` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;initialized&#039;</span><span style="color: #000000">, () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Use the client.</span>
 <span style="color: #000000">}</span>
+
+<span style="color: #008000">// To catch client initialization errors, subscribe to the `&#039;initFailed&#039;` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;initFailed&#039;</span><span style="color: #000000">, ({ </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Handle the error.</span>
+<span style="color: #000000">});</span>
 </code></pre>
 			<p>The SDK could also be imported using the ES module syntax:</p>
 			<pre><code><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Client</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">;</span>
+
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
-<span style="color: #008000">// Before you use the client, subscribe to the `&#039;stateChanged&#039;` event and wait </span>
-<span style="color: #008000">// for the `&#039;initialized&#039;` state to be reported.</span>
-<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;stateChanged&#039;</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">&#039;initialized&#039;</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #008000">// Use the client</span>
-<span style="color: #000000">  }</span>
+
+<span style="color: #008000">// Before you use the client, subscribe to the `&#039;initialized&#039;` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;initialized&#039;</span><span style="color: #000000">, () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Use the client.</span>
 <span style="color: #000000">}</span>
+
+<span style="color: #008000">// To catch client initialization errors, subscribe to the `&#039;initFailed&#039;` event.</span>
+<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;initFailed&#039;</span><span style="color: #000000">, ({ </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #008000">// Handle the error.</span>
+<span style="color: #000000">});</span>
 </code></pre>
 			<a href="#cdn" id="cdn" style="color: inherit; text-decoration: none;">
 				<h3>CDN</h3>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twilio/conversations",
-  "version": "2.2.0-rc.12",
+  "version": "2.2.0-rc.14",
   "description": "Twilio Conversations client library",
   "main": "./builds/lib.js",
   "browser": "./builds/browser.js",
@@ -36,12 +36,12 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.17.0",
-    "@twilio/declarative-type-validator": "^0.2.0-rc.4",
-    "@twilio/deprecation-decorator": "^0.1.0-rc.13",
-    "@twilio/mcs-client": "^0.6.0-rc.9",
-    "@twilio/notifications": "^2.0.0-rc.4",
-    "@twilio/operation-retrier": "^4.0.8-rc.5",
-    "@twilio/replay-event-emitter": "^0.3.0-rc.5",
+    "@twilio/declarative-type-validator": "^0.2.1-rc.1",
+    "@twilio/deprecation-decorator": "^0.2.0-rc.0",
+    "@twilio/mcs-client": "^0.6.1-rc.1",
+    "@twilio/notifications": "^2.0.1-rc.1",
+    "@twilio/operation-retrier": "^4.0.9-rc.1",
+    "@twilio/replay-event-emitter": "^0.3.1-rc.1",
     "core-js": "^3.17.3",
     "iso8601-duration": "=1.2.0",
     "isomorphic-form-data": "^2.0.0",