@twilio/conversations 2.2.0-rc.9 → 2.2.0

package/CHANGELOG.md

@@ -3,6 +3,91 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.0](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.15...@twilio/conversations@2.2.0) (2022-09-22)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+## [2.2.0-rc.15](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.14...@twilio/conversations@2.2.0-rc.15) (2022-09-21)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+## [2.2.0](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.14...@twilio/conversations@2.2.0) (2022-09-21)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+## [2.2.0-rc.14](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@3.0.0-rc.9...@twilio/conversations@2.2.0-rc.14) (2022-09-21)
+
+
+### Features
+
+* Deprecate methods for the multiple media release ([ef89aa6](https://github.com/twilio/rtd-sdk-monorepo-js/commit/ef89aa69c17a8a94446b870858cd3e74b6e4cf05))
+* Deprecate stateChanged event ([a69aa6c](https://github.com/twilio/rtd-sdk-monorepo-js/commit/a69aa6ce5faba8a53d00377b23563984c7bfcb15))
+* Revert add/addNonChatParticipant return value ([32ec453](https://github.com/twilio/rtd-sdk-monorepo-js/commit/32ec453a99eea284b4fd8b8828920a2433c13f0e))
+* Revert and deprecate peek conversation breaking changes ([3094767](https://github.com/twilio/rtd-sdk-monorepo-js/commit/309476703f8442b03e6c0c5d5210ab21459d2bcd))
+
+
+### Bug Fixes
+
+* Add deprecation notice for Conversation.create, fix packages versions ([94af4c8](https://github.com/twilio/rtd-sdk-monorepo-js/commit/94af4c8e8354154872bdd09af97a2ba07853e4a5))
+* Fix 2.2.0 release blockers ([099622b](https://github.com/twilio/rtd-sdk-monorepo-js/commit/099622bf459a75d141652f14ce9fdbff11c2e822))
+* Fix faulty event emits on token update. RTDSDK-3699 ([fb67269](https://github.com/twilio/rtd-sdk-monorepo-js/commit/fb67269bfeb31db09ba28132bcd19e98578f6453))
+* Fix IE11 behavior on participant add ([56e71e4](https://github.com/twilio/rtd-sdk-monorepo-js/commit/56e71e403dac7dd7a32e1fa9201c7a72c1b61083))
+* Ignore broken conversations on client init. RTDSDK-2085 ([4a812d1](https://github.com/twilio/rtd-sdk-monorepo-js/commit/4a812d14af9c91428d778f4cd26ea682f6390e69))
+* Remove unused parameter from initialized event ([2a57068](https://github.com/twilio/rtd-sdk-monorepo-js/commit/2a57068fbe2534e0b21a65551a1a6914ea5b14c5))
+* Rollback twilsock type, update loglevel version ([d318c5c](https://github.com/twilio/rtd-sdk-monorepo-js/commit/d318c5c0750096651ce1e01fef360aded070bb5c))
+* SyncError getting minified. RTDSDK-3717 ([fd42bce](https://github.com/twilio/rtd-sdk-monorepo-js/commit/fd42bcef1a4fbc9f4b2fd332f48e8fcfd9e4cba5))
+* Update stateChanged event name ([3e866bb](https://github.com/twilio/rtd-sdk-monorepo-js/commit/3e866bbf9a74c640ef5da348f3e6f2c722bbd150))
+
+
+
+## [2.2.0-rc.13](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.12...@twilio/conversations@2.2.0-rc.13) (2022-09-13)
+
+
+### Bug Fixes
+
+* Remove unused parameter from initialized event ([de54b9e](https://github.com/twilio/rtd-sdk-monorepo-js/commit/de54b9ec29ad358bcb6d946fb96e4fc4be3f45ce))
+* SyncError getting minified. RTDSDK-3717 ([0b99992](https://github.com/twilio/rtd-sdk-monorepo-js/commit/0b99992ed6c684d74c7b19c45956d293aa5662fd))
+
+
+
+## [2.2.0-rc.12](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.11...@twilio/conversations@2.2.0-rc.12) (2022-08-23)
+
+
+### Bug Fixes
+
+* Fix 2.2.0 release blockers ([f54f564](https://github.com/twilio/rtd-sdk-monorepo-js/commit/f54f56421d7e8f14476abfbf6a315a84d203c88c))
+* Fix faulty event emits on token update. RTDSDK-3699 ([4c40f39](https://github.com/twilio/rtd-sdk-monorepo-js/commit/4c40f39334ab6a62379c4b5c25c6a4f8cc168959))
+
+
+
+## [2.2.0-rc.11](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.10...@twilio/conversations@2.2.0-rc.11) (2022-07-26)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+## [2.2.0-rc.10](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.9...@twilio/conversations@2.2.0-rc.10) (2022-07-26)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
 ## [2.2.0-rc.9](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.2.0-rc.8...@twilio/conversations@2.2.0-rc.9) (2022-07-25)
 
 **Note:** Version bump only for package @twilio/conversations

package/README.md

@@ -18,31 +18,35 @@ Using this method, you can `require` `twilio-conversations` and then use the
 client:
 ```
 const { Client } = require('@twilio/conversations');
+
 const client = new Client(token);
-// Before you use the client, subscribe to the `'stateChanged'` event and wait 
-// for the `'initialized'` state to be reported.
-client.on('stateChanged', ({ state, error }) => {
-  if (state === 'initialized') {
-    // Use the client
-  }
-  
-  if (error) {
-    // Handle error
-  }
+
+// Before you use the client, subscribe to the `'initialized'` event.
+client.on('initialized', () => {
+  // Use the client.
 }
+
+// To catch client initialization errors, subscribe to the `'initFailed'` event.
+client.on('initFailed', ({ error }) => {
+  // Handle the error.
+});
 ```
 
 The SDK could also be imported using the ES module syntax:
 ```
 import { Client } from '@twilio/conversations';
+
 const client = new Client(token);
-// Before you use the client, subscribe to the `'stateChanged'` event and wait 
-// for the `'initialized'` state to be reported.
-client.on('stateChanged', ({ state, error }) => {
-  if (state === 'initialized') {
-    // Use the client
-  }
+
+// Before you use the client, subscribe to the `'initialized'` event.
+client.on('initialized', () => {
+  // Use the client.
 }
+
+// To catch client initialization errors, subscribe to the `'initFailed'` event.
+client.on('initFailed', ({ error }) => {
+  // Handle the error.
+});
 ```
 
 ### CDN
@@ -50,7 +54,7 @@ client.on('stateChanged', ({ state, error }) => {
 Releases of `twilio-conversations.js` are hosted on a CDN, and you can include these
 directly in your web app using a `<script>` tag.
 ```html
-<script src="https://media.twiliocdn.com/sdk/js/conversations/v3.0/twilio-conversations.min.js"></script>
+<script src="https://media.twiliocdn.com/sdk/js/conversations/v2.2/twilio-conversations.min.js"></script>
 ```
 Using this method, `twilio-conversations.js` will set a browser global `Twilio.Conversations` through which you can use the client:
 ```
@@ -68,7 +72,7 @@ number. While less flexible it is significantly more secure, which is required b
 To consume securely use the following script snippet format:
 
 ```html
-<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/3.0.0/twilio-conversations.min.js"
+<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/2.2.0/twilio-conversations.min.js"
         integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
         crossorigin="anonymous"></script>
 ```

package/builds/browser.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.9";
+var version = "2.2.0";
 
 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; }
 
@@ -7738,9 +7741,6 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
 
   /**
    * Fired when the client has completed initialization successfully.
-   *
-   * Parameters:
-   * 1. object `data` - Optional info object provided with the event
    * @event
    */
 
@@ -7939,11 +7939,11 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
       });
     };
 
-    _this._services.twilsockClient.on("connectionError", emitFailed);
+    _this._services.twilsockClient.once("connectionError", emitFailed);
 
-    _this._services.twilsockClient.on("disconnected", emitDisconnected);
+    _this._services.twilsockClient.once("disconnected", emitDisconnected);
 
-    _this._services.twilsockClient.on("connected", /*#__PURE__*/_asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee() {
+    _this._services.twilsockClient.once("connected", /*#__PURE__*/_asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee() {
       var startupEvent, connectionError;
       return _regeneratorRuntime__default["default"].wrap(function _callee$(_context) {
         while (1) {
@@ -8806,7 +8806,7 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
                 this._resolveEnsureReady();
 
                 this.emit("stateChanged", "initialized");
-                this.emit("initialized", {});
+                this.emit("initialized");
 
               case 34:
               case "end":