@twilio/conversations 2.5.0 → 2.6.0-rc.1

package/builds/lib.js

@@ -128,6 +128,15 @@ This software includes platform.js under the following license.
 */
 'use strict';
 
+var global =
+  typeof global !== "undefined"
+    ? global
+    : typeof self !== "undefined"
+    ? self
+    : typeof window !== "undefined"
+    ? window
+    : {};
+
 Object.defineProperty(exports, '__esModule', { value: true });
 
 require('core-js/modules/es.reflect.to-string-tag.js');
@@ -145,10 +154,10 @@ var _getPrototypeOf = require('@babel/runtime/helpers/getPrototypeOf');
 var _defineProperty = require('@babel/runtime/helpers/defineProperty');
 var _createClass = require('@babel/runtime/helpers/createClass');
 var _classCallCheck = require('@babel/runtime/helpers/classCallCheck');
-require('core-js/modules/es.object.to-string.js');
-require('core-js/modules/es.promise.js');
 require('core-js/modules/es.array.map.js');
+require('core-js/modules/es.object.to-string.js');
 require('core-js/modules/web.dom-collections.for-each.js');
+require('core-js/modules/es.promise.js');
 var _regeneratorRuntime = require('@babel/runtime/regenerator');
 var _typeof = require('@babel/runtime/helpers/typeof');
 require('core-js/modules/es.array.concat.js');
@@ -646,6 +655,22 @@ var User = /*#__PURE__*/function (_ReplayEventEmitter) {
    * @event
    */
 
+  /**
+   * Fired when the client has subscribed to the user.
+   *
+   * Parameters:
+   * 1. {@link User} `user` - the user in question
+   * @event
+   */
+
+  /**
+   * Fired when the client has unsubscribed from the user.
+   *
+   * Parameters:
+   * 1. {@link User} `user` - the user in question
+   * @event
+   */
+
 
   _createClass__default["default"](User, [{
     key: "identity",
@@ -1318,6 +1343,24 @@ var Participant = /*#__PURE__*/function (_ReplayEventEmitter) {
    * @event
    */
 
+  /**
+   * Fired when the participant has stopped typing.
+   *
+   * Parameters:
+   * 1. {@link Participant} `participant` - the participant in question
+   * @event
+   */
+
+  /**
+   * Fired when the fields of the participant have been updated.
+   *
+   * Parameters:
+   * 1. object `data` - info object provided with the event. It has the following properties:
+   *     * {@link Participant} participant - the participant in question
+   *     * {@link ParticipantUpdateReason}[] updateReasons - array of reasons for the update
+   * @event
+   */
+
 
   _createClass__default["default"](Participant, [{
     key: "sid",
@@ -2895,6 +2938,15 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
     return _this;
   }
+  /**
+   * Fired when the properties or the body of the message has been updated.
+   *
+   * Parameters:
+   * 1. object `data` - info object provided with the event. It has the following properties:
+   *     * {@link Message} message - the message in question
+   *     * {@link MessageUpdateReason}[] updateReasons - array of reasons for the update
+   */
+
 
   _createClass__default["default"](Message, [{
     key: "sid",
@@ -4891,6 +4943,64 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
    * Logger instance.
    */
 
+  /**
+   * Unique system identifier of the conversation.
+   */
+
+  /**
+   * Conversation links for REST requests.
+   * @internal
+   */
+
+  /**
+   * Configuration of the client that the conversation belongs to.
+   */
+
+  /**
+   * Conversation service objects.
+   */
+
+  /**
+   * Internal state of the conversation.
+   */
+
+  /**
+   * Name of the conversation entity document.
+   */
+
+  /**
+   * Messages entity.
+   */
+
+  /**
+   * Sync list containing messages.
+   */
+
+  /**
+   * Map of participants.
+   * @internal
+   */
+
+  /**
+   * Participants entity.
+   */
+
+  /**
+   * Sync map containing participants.
+   */
+
+  /**
+   * Source of the most recent update.
+   */
+
+  /**
+   * Promise for the conversation entity document.
+   */
+
+  /**
+   * Conversation entity document.
+   */
+
   /**
    * @param descriptor Conversation descriptor.
    * @param sid Conversation SID.
@@ -7954,7 +8064,7 @@ function PushNotification(data) {
   this.data = data.data || {};
 });
 
-var version = "2.5.0";
+var version = "2.6.0-rc.1";
 
 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; }
 
@@ -8827,6 +8937,22 @@ var EmailRecipientDescriptor = /*#__PURE__*/_createClass__default["default"](
  * Type of recipient.
  */
 
+/**
+ * Sid of the message that this recipient belongs to.
+ */
+
+/**
+ * Email recipient level.
+ */
+
+/**
+ * Name of the recipient.
+ */
+
+/**
+ * Address of the recipient.
+ */
+
 /**
  * @internal
  */
@@ -9280,6 +9406,46 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
    * Client connection state.
    */
 
+  /**
+   * Promise that resolves on successful initialization.
+   */
+
+  /**
+   * Options passed to the client.
+   */
+
+  /**
+   * Client service objects.
+   */
+
+  /**
+   * The user of the client.
+   */
+
+  /**
+   * Resolves the {@link Client._ensureReady} promise.
+   */
+
+  /**
+   * Rejects the {@link Client._ensureReady} promise.
+   */
+
+  /**
+   * The current token of the client.
+   */
+
+  /**
+   * The constructed configuration object.
+   */
+
+  /**
+   * The Conversations entity.
+   */
+
+  /**
+   * Promise that resolves when initial conversations are fetched.
+   */
+
   /**
    * Returned Conversations Client instance is not yet fully initialized. Calling any
    * operations will block until it is. Use connection events to monitor when
@@ -9419,6 +9585,8 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
         terminal: true,
         message: "Twilsock has disconnected."
       });
+
+      _this._initializeEnsureReady((options === null || options === void 0 ? void 0 : options.throwErrorsAlways) || false);
     };
 
     _this._services.twilsockClient.once("connectionError", emitFailed);
@@ -9476,12 +9644,7 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
       }, _callee, null, [[3, 11]]);
     })));
 
-    _this._ensureReady = new Promise(function (resolve, reject) {
-      _this._resolveEnsureReady = resolve;
-      _this._rejectEnsureReady = reject;
-    }).catch(function () {
-      return void 0;
-    }); // @todo How to process unhandled rejection here?
+    _this._initializeEnsureReady((options === null || options === void 0 ? void 0 : options.throwErrorsAlways) || false);
 
     if (startTwilsock) {
       _this._services.twilsockClient.connect();
@@ -10374,6 +10537,26 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
         _this5._services.notificationClient.unsubscribe(channelType, messageType);
       });
     }
+    /**
+     * Initialize the ensureReady promise.
+     */
+
+  }, {
+    key: "_initializeEnsureReady",
+    value: function _initializeEnsureReady(throwErrorsAlways) {
+      var _this6 = this;
+
+      this._ensureReady = new Promise(function (resolve, reject) {
+        _this6._resolveEnsureReady = resolve;
+        _this6._rejectEnsureReady = reject;
+      }).catch(function (error) {
+        if (throwErrorsAlways) {
+          throw error;
+        } else {
+          return void 0;
+        }
+      });
+    }
   }], [{
     key: "create",
     value: function () {