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

package/builds/lib.d.ts

@@ -588,7 +588,7 @@ interface AggregatedDeliveryDescriptor {
  * Contains aggregated information about delivery statuses of a message across all participants
  * of a conversation.
  *
- * At any moment during the message delivery to a participant, the message can have zero or more of following
+ * At any moment during the message delivery to a participant, the message can have zero or more of the following
  * delivery statuses:
  * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.
  * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message
@@ -803,14 +803,15 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     get dateUpdated(): Date | null;
     /**
-     * Index of the message in the conversation's messages list.
-     * By design of the Conversations system, the message indices may have arbitrary gaps between them,
+     * Index of this message in the conversation's list of messages.
+     *
+     * 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.
      *
      * Trying to use indices for some calculations is going to be unreliable.
      *
-     * To calculate the number of unread messages it is better to use the read horizon API.
+     * To calculate the number of unread messages, it is better to use the Read Horizon API.
      * See {@link Conversation.getUnreadMessagesCount} for details.
      */
     get index(): number;
@@ -1707,7 +1708,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      */
     getMessagesCount(): Promise<number>;
     /**
-     * Get unread messages count for the user if they are a participant of this
+     * 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.
      *
      * Use this method to obtain the number of unread messages together with
@@ -1715,12 +1716,19 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * message indices which may have gaps. See {@link Message.index} for details.
      *
      * 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.
      *
      * 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.
+     *
+     * 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 `null` value is up to the customer application.
+     *
+     * @return Number of unread messages based on the current read horizon set for
+     * the user or `null` if the read horizon is not set.
      */
     getUnreadMessagesCount(): Promise<number | null>;
     /**
@@ -1761,7 +1769,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     setAllMessagesRead(): Promise<number>;
     /**
      * Set all messages in the conversation unread.
-     * @return Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
     setAllMessagesUnread(): Promise<number>;
     /**
@@ -1790,7 +1798,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Set the last read message index to the current read horizon.
      * @param index Message index to set as last read. If null is provided, then
      * the behavior is identical to {@link Conversation.setAllMessagesUnread}.
-     * @returns Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
     updateLastReadMessageIndex(index: number | null): Promise<number>;
     /**

package/builds/lib.js

@@ -2304,7 +2304,7 @@ var Media = /*#__PURE__*/function () {
  * Contains aggregated information about delivery statuses of a message across all participants
  * of a conversation.
  *
- * At any moment during the message delivery to a participant, the message can have zero or more of following
+ * At any moment during the message delivery to a participant, the message can have zero or more of the following
  * delivery statuses:
  * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.
  * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message
@@ -2661,14 +2661,15 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
       return this.state.dateUpdated;
     }
     /**
-     * Index of the message in the conversation's messages list.
-     * By design of the Conversations system, the message indices may have arbitrary gaps between them,
+     * Index of this message in the conversation's list of messages.
+     *
+     * 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.
      *
      * Trying to use indices for some calculations is going to be unreliable.
      *
-     * To calculate the number of unread messages it is better to use the read horizon API.
+     * To calculate the number of unread messages, it is better to use the Read Horizon API.
      * See {@link Conversation.getUnreadMessagesCount} for details.
      */
 
@@ -2983,32 +2984,27 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
               case 2:
                 paginator = _context2.sent;
-                detailedDeliveryReceipts = [];
+                detailedDeliveryReceipts = paginator.items;
 
               case 4:
-
-                detailedDeliveryReceipts = [].concat(_toConsumableArray__default["default"](detailedDeliveryReceipts), _toConsumableArray__default["default"](paginator.items));
-
-                if (paginator.hasNextPage) {
-                  _context2.next = 8;
+                if (!paginator.hasNextPage) {
+                  _context2.next = 11;
                   break;
                 }
 
-                return _context2.abrupt("break", 13);
-
-              case 8:
-                _context2.next = 10;
+                _context2.next = 7;
                 return paginator.nextPage();
 
-              case 10:
+              case 7:
                 paginator = _context2.sent;
+                detailedDeliveryReceipts = [].concat(_toConsumableArray__default["default"](detailedDeliveryReceipts), _toConsumableArray__default["default"](paginator.items));
                 _context2.next = 4;
                 break;
 
-              case 13:
+              case 11:
                 return _context2.abrupt("return", detailedDeliveryReceipts);
 
-              case 14:
+              case 12:
               case "end":
                 return _context2.stop();
             }
@@ -4929,7 +4925,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
       return getMessagesCount;
     }()
     /**
-     * Get unread messages count for the user if they are a participant of this
+     * 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.
      *
      * Use this method to obtain the number of unread messages together with
@@ -4937,12 +4933,19 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
      * message indices which may have gaps. See {@link Message.index} for details.
      *
      * 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.
      *
      * 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.
+     *
+     * 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 `null` value is up to the customer application.
+     *
+     * @return Number of unread messages based on the current read horizon set for
+     * the user or `null` if the read horizon is not set.
      */
 
   }, {
@@ -5215,7 +5218,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
     }()
     /**
      * Set all messages in the conversation unread.
-     * @return Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
 
   }, {
@@ -5373,7 +5376,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
      * Set the last read message index to the current read horizon.
      * @param index Message index to set as last read. If null is provided, then
      * the behavior is identical to {@link Conversation.setAllMessagesUnread}.
-     * @returns Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
 
   }, {
@@ -7326,7 +7329,7 @@ function PushNotification(data) {
   this.data = data.data || {};
 });
 
-var version = "2.2.0-rc.13";
+var version = "2.2.0-rc.14";
 
 function ownKeys$1(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }