@twilio/conversations 2.5.0-rc.8 → 2.6.0-rc.0

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');
@@ -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",
@@ -1444,8 +1487,9 @@ var Participant = /*#__PURE__*/function (_ReplayEventEmitter) {
       }
 
       this.state.isTyping = true;
-      this.emit("typingStarted", this);
-      this.conversation.emit("typingStarted", this);
+      this.emit(Participant.typingStarted, this);
+      this.conversation.emit(Conversation.typingStarted, this); // @fixme layering violation
+
       this.state.typingTimeout = Number(setTimeout(function () {
         return _this2._endTyping();
       }, timeout));
@@ -1464,8 +1508,8 @@ var Participant = /*#__PURE__*/function (_ReplayEventEmitter) {
       }
 
       this.state.isTyping = false;
-      this.emit("typingEnded", this);
-      this.conversation.emit("typingEnded", this);
+      this.emit(Participant.typingEnded, this);
+      this.conversation.emit(Conversation.typingEnded, this);
       clearInterval(this.state.typingTimeout);
       this.state.typingTimeout = null;
     }
@@ -1524,7 +1568,7 @@ var Participant = /*#__PURE__*/function (_ReplayEventEmitter) {
       }
 
       if (updateReasons.length > 0) {
-        this.emit("updated", {
+        this.emit(Participant.updated, {
           participant: this,
           updateReasons: updateReasons
         });
@@ -1660,7 +1704,8 @@ var Participants = /*#__PURE__*/function (_ReplayEventEmitter) {
 
   var _super = _createSuper$7(Participants);
 
-  function Participants(conversation, participants, links, configuration, services) {
+  // passed in from Conversation
+  function Participants(conversation, participants, links, services) {
     var _this;
 
     _classCallCheck__default["default"](this, Participants);
@@ -1672,7 +1717,6 @@ var Participants = /*#__PURE__*/function (_ReplayEventEmitter) {
     _this.conversation = conversation;
     _this.participants = participants;
     _this.links = links;
-    _this.configuration = configuration;
     _this.services = services;
     return _this;
   }
@@ -1723,14 +1767,14 @@ var Participants = /*#__PURE__*/function (_ReplayEventEmitter) {
         mode: "open_existing"
       }) : Promise.resolve(arg);
       return this.rosterEntityPromise = this.rosterEntityPromise || participantsMapPromise.then(function (rosterMap) {
-        rosterMap.on("itemAdded", function (args) {
+        rosterMap.on(twilioSync.SyncMap.itemAdded, function (args) {
           log$4.debug(_this2.conversation.sid + " itemAdded: " + args.item.key);
 
           _this2.upsertParticipant(args.item.key, args.item.data).then(function (participant) {
-            _this2.emit("participantJoined", participant);
+            _this2.emit(Conversation.participantJoined, participant);
           });
         });
-        rosterMap.on("itemRemoved", function (args) {
+        rosterMap.on(twilioSync.SyncMap.itemRemoved, function (args) {
           log$4.debug(_this2.conversation.sid + " itemRemoved: " + args.key);
           var participantSid = args.key;
 
@@ -1746,12 +1790,14 @@ var Participants = /*#__PURE__*/function (_ReplayEventEmitter) {
             return;
           }
 
-          _this2.emit("participantLeft", leftParticipant);
+          _this2.emit(Conversation.participantLeft, leftParticipant);
         });
-        rosterMap.on("itemUpdated", function (args) {
+        rosterMap.on(twilioSync.SyncMap.itemUpdated, function (args) {
           log$4.debug(_this2.conversation.sid + " itemUpdated: " + args.item.key);
 
-          _this2.upsertParticipant(args.item.key, args.item.data);
+          _this2.upsertParticipant(args.item.key, args.item.data).catch(function (e) {
+            return log$4.error(e);
+          });
         });
         var participantsPromises = [];
 
@@ -1845,8 +1891,8 @@ var Participants = /*#__PURE__*/function (_ReplayEventEmitter) {
                 };
                 participant = new Participant(data, participantSid, this.conversation, links, this.services);
                 this.participants.set(participantSid, participant);
-                participant.on("updated", function (args) {
-                  return _this3.emit("participantUpdated", args);
+                participant.on(Participant.updated, function (args) {
+                  return _this3.emit(Conversation.participantUpdated, args);
                 });
                 return _context3.abrupt("return", participant);
 
@@ -2457,15 +2503,14 @@ var RestPaginator = /*#__PURE__*/function () {
   /**
    * @internal
    */
-  function RestPaginator(items, source, prevToken, nextToken, pageSize) {
+  function RestPaginator(items, source, prevToken, nextToken) {
     _classCallCheck__default["default"](this, RestPaginator);
 
     this.state = {
       prevToken: prevToken,
       nextToken: nextToken,
       source: source,
-      items: items,
-      pageSize: pageSize
+      items: items
     };
   }
   /**
@@ -2503,7 +2548,7 @@ var RestPaginator = /*#__PURE__*/function () {
   }, {
     key: "nextPage",
     value: function nextPage() {
-      return this.hasNextPage ? this.state.source(this.state.nextToken, this.state.pageSize) : Promise.reject(new Error("No next page"));
+      return this.hasNextPage ? this.state.source(this.state.nextToken) : Promise.reject(new Error("No next page"));
     }
     /**
      * Request the previous page. Does not modify the existing object.
@@ -2512,7 +2557,7 @@ var RestPaginator = /*#__PURE__*/function () {
   }, {
     key: "prevPage",
     value: function prevPage() {
-      return this.hasPrevPage ? this.state.source(this.state.prevToken, this.state.pageSize) : Promise.reject(new Error("No previous page"));
+      return this.hasPrevPage ? this.state.source(this.state.prevToken) : Promise.reject(new Error("No previous page"));
     }
   }]);
 
@@ -2893,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",
@@ -3203,7 +3257,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
       var _getParticipant = _asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee() {
         var _this3 = this;
 
-        var participant, errorMesage;
+        var participant, errorMessage;
         return _regeneratorRuntime__default["default"].wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
@@ -3248,26 +3302,26 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
                 return _context.abrupt("return", participant);
 
               case 11:
-                errorMesage = "Participant with ";
+                errorMessage = "Participant with ";
 
                 if (this.state.participantSid) {
-                  errorMesage += "SID '" + this.state.participantSid + "' ";
+                  errorMessage += "SID '" + this.state.participantSid + "' ";
                 }
 
                 if (this.state.author) {
                   if (this.state.participantSid) {
-                    errorMesage += "or ";
+                    errorMessage += "or ";
                   }
 
-                  errorMesage += "identity '" + this.state.author + "' ";
+                  errorMessage += "identity '" + this.state.author + "' ";
                 }
 
-                if (errorMesage === "Participant with ") {
-                  errorMesage = "Participant ";
+                if (errorMessage === "Participant with ") {
+                  errorMessage = "Participant ";
                 }
 
-                errorMesage += "was not found";
-                throw new Error(errorMesage);
+                errorMessage += "was not found";
+                throw new Error(errorMessage);
 
               case 17:
               case "end":
@@ -3604,7 +3658,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
                     pageToken: pageToken,
                     pageSize: pageSize
                   });
-                }, response.body.meta.previous_token, response.body.meta.next_token, options === null || options === void 0 ? void 0 : options.pageSize));
+                }, response.body.meta.previous_token, response.body.meta.next_token));
 
               case 6:
               case "end":
@@ -4889,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.
@@ -4930,32 +5042,39 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
       participants: _this._links.participants
     };
     _this._participants = new Map();
-    _this._participantsEntity = new Participants(_assertThisInitialized__default["default"](_this), _this._participants, participantsLinks, _this._configuration, _this._services);
+    _this._participantsEntity = new Participants(_assertThisInitialized__default["default"](_this), _this._participants, // state leak
+    participantsLinks, _this._services);
 
-    _this._participantsEntity.on("participantJoined", function (participant) {
-      return _this.emit("participantJoined", participant);
+    _this._participantsEntity.on(Conversation.participantJoined, function (participant) {
+      return (// @todo update participants map here??
+        _this.emit(Conversation.participantJoined, participant)
+      );
     });
 
-    _this._participantsEntity.on("participantLeft", function (participant) {
-      return _this.emit("participantLeft", participant);
+    _this._participantsEntity.on(Conversation.participantLeft, function (participant) {
+      return (// @todo update participants map here??
+        _this.emit(Conversation.participantLeft, participant)
+      );
     });
 
-    _this._participantsEntity.on("participantUpdated", function (args) {
-      return _this.emit("participantUpdated", args);
+    _this._participantsEntity.on(Conversation.participantUpdated, function (args) {
+      return (// @todo update participants map here??
+        _this.emit(Conversation.participantUpdated, args)
+      );
     });
 
     _this._messagesEntity = new Messages(_assertThisInitialized__default["default"](_this), configuration, services);
 
-    _this._messagesEntity.on("messageAdded", function (message) {
+    _this._messagesEntity.on(Conversation.messageAdded, function (message) {
       return _this._onMessageAdded(message);
     });
 
-    _this._messagesEntity.on("messageUpdated", function (args) {
-      return _this.emit("messageUpdated", args);
+    _this._messagesEntity.on(Conversation.messageUpdated, function (args) {
+      return _this.emit(Conversation.messageUpdated, args);
     });
 
-    _this._messagesEntity.on("messageRemoved", function (message) {
-      return _this.emit("messageRemoved", message);
+    _this._messagesEntity.on(Conversation.messageRemoved, function (message) {
+      return _this.emit(Conversation.messageRemoved, message);
     });
 
     return _this;
@@ -5058,7 +5177,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
       return (_this$_internalState$3 = this._internalState.notificationLevel) !== null && _this$_internalState$3 !== void 0 ? _this$_internalState$3 : "default";
     }
     /**
-     * Conversation bindings. Undocumented feature (for now).
+     * Conversation bindings. An undocumented feature (for now).
      * @internal
      */
 
@@ -6107,12 +6226,12 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
               case 6:
                 this._entity = _context25.sent;
 
-                this._entity.on("updated", function (args) {
+                this._entity.on(twilioSync.SyncDocument.updated, function (args) {
                   return _this2._update(args.data);
                 });
 
-                this._entity.on("removed", function () {
-                  return _this2.emit("removed", _this2);
+                this._entity.on(twilioSync.SyncDocument.removed, function () {
+                  return _this2.emit(Conversation.removed, _this2);
                 });
 
                 this._update(this._entity.data);
@@ -6280,22 +6399,16 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
           while (1) {
             switch (_context28.prev = _context28.next) {
               case 0:
-                if (!this._entity) {
-                  _context28.next = 5;
-                  break;
-                }
-
-                _context28.next = 3;
-                return this._entity.close();
+                if (this._entity) {
+                  this._entity.close();
 
-              case 3:
-                this._entity = null;
-                this._entityPromise = null;
+                  this._entity = null;
+                  this._entityPromise = null;
+                }
 
-              case 5:
                 return _context28.abrupt("return", Promise.all([this._participantsEntity.unsubscribe(), this._messagesEntity.unsubscribe()]));
 
-              case 6:
+              case 2:
               case "end":
                 return _context28.stop();
             }
@@ -6464,7 +6577,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
       }
 
       if (updateReasons.size > 0) {
-        this.emit("updated", {
+        this.emit(Conversation.updated, {
           conversation: this,
           updateReasons: _toConsumableArray__default["default"](updateReasons)
         });
@@ -6496,7 +6609,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
         _iterator.f();
       }
 
-      this.emit("messageAdded", message);
+      this.emit(Conversation.messageAdded, message);
     }
     /**
      * Set last read message index.
@@ -6806,7 +6919,7 @@ var Conversations = /*#__PURE__*/function (_ReplayEventEmitter) {
       return addConversation;
     }()
     /**
-     * Fetch conversations list and instantiate all necessary objects
+     * Fetch conversations' list and instantiate all necessary objects
      */
 
   }, {
@@ -6827,12 +6940,12 @@ var Conversations = /*#__PURE__*/function (_ReplayEventEmitter) {
 
               case 3:
                 map = _context2.sent;
-                map.on("itemAdded", function (args) {
+                map.on(twilioSync.SyncMap.itemAdded, function (args) {
                   log$1.debug("itemAdded: ".concat(args.item.key));
 
                   _this2._upsertConversation("sync", args.item.key, args.item.data);
                 });
-                map.on("itemRemoved", function (args) {
+                map.on(twilioSync.SyncMap.itemRemoved, function (args) {
                   log$1.debug("itemRemoved: ".concat(args.key));
                   var sid = args.key;
 
@@ -6858,7 +6971,7 @@ var Conversations = /*#__PURE__*/function (_ReplayEventEmitter) {
 
                   conversation.emit("removed", conversation);
                 });
-                map.on("itemUpdated", function (args) {
+                map.on(twilioSync.SyncMap.itemUpdated, function (args) {
                   log$1.debug("itemUpdated: ".concat(args.item.key));
 
                   _this2._upsertConversation("sync", args.item.key, args.item.data);
@@ -7951,7 +8064,7 @@ function PushNotification(data) {
   this.data = data.data || {};
 });
 
-var version = "2.5.0-rc.8";
+var version = "2.6.0-rc.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; }
 
@@ -8824,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
  */
@@ -8978,7 +9107,7 @@ var MessageRecipientsClient = /*#__PURE__*/function () {
                     pageToken: pageToken,
                     pageSize: pageSize
                   });
-                }, recipientsResponse.meta.previous_token, recipientsResponse.meta.next_token, paginatorOptions === null || paginatorOptions === void 0 ? void 0 : paginatorOptions.pageSize));
+                }, recipientsResponse.meta.previous_token, recipientsResponse.meta.next_token));
 
               case 8:
               case "end":
@@ -9278,7 +9407,47 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
    */
 
   /**
-   * Returned Conversations instance is not yet fully initialized. Calling any
+   * 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
    * client becomes fully available (connectionStateChanged with state
    * 'connected') or not available (connectionStateChange with state 'denied',
@@ -9368,16 +9537,16 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
 
     _this._services.twilsockClient = _this._options.twilsockClient = (_this$_options$twilso = _this._options.twilsockClient) !== null && _this$_options$twilso !== void 0 ? _this$_options$twilso : new twilsock.TwilsockClient(fpaToken, productId, _this._options);
 
-    _this._services.twilsockClient.on("tokenAboutToExpire", function () {
-      return _this.emit("tokenAboutToExpire");
+    _this._services.twilsockClient.on(Client_1.tokenAboutToExpire, function () {
+      return _this.emit(Client_1.tokenAboutToExpire);
     });
 
-    _this._services.twilsockClient.on("tokenExpired", function () {
-      return _this.emit("tokenExpired");
+    _this._services.twilsockClient.on(Client_1.tokenExpired, function () {
+      return _this.emit(Client_1.tokenExpired);
     });
 
-    _this._services.twilsockClient.on("connectionError", function (error) {
-      return _this.emit("connectionError", error);
+    _this._services.twilsockClient.on(Client_1.connectionError, function (error) {
+      return _this.emit(Client_1.connectionError, error);
     });
 
     _this._services.twilsockClient.on("stateChanged", function (state) {
@@ -9386,7 +9555,7 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
       if (state !== _this.connectionState) {
         _this.connectionState = state;
 
-        _this.emit("connectionStateChanged", _this.connectionState);
+        _this.emit(Client_1.connectionStateChanged, _this.connectionState);
       }
     });
 
@@ -9404,9 +9573,9 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
     var emitFailed = function emitFailed(error) {
       _this._rejectEnsureReady(error);
 
-      _this.emit("stateChanged", "failed");
+      _this.emit(Client_1.stateChanged, "failed");
 
-      _this.emit("initFailed", {
+      _this.emit(Client_1.initFailed, {
         error: error
       });
     };
@@ -9459,9 +9628,9 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
 
               _this._rejectEnsureReady(connectionError);
 
-              _this.emit("stateChanged", "failed");
+              _this.emit(Client_1.stateChanged, "failed");
 
-              _this.emit("initFailed", {
+              _this.emit(Client_1.initFailed, {
                 error: connectionError
               });
 
@@ -9989,7 +10158,7 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
       return removePushRegistrations;
     }()
     /**
-     * Current version of the Conversations client.
+     * Parse a push notification payload.
      */
 
   }, {
@@ -10326,8 +10495,8 @@ exports.Client = Client_1 = (_class = /*#__PURE__*/function (_ReplayEventEmitter
 
                 this._resolveEnsureReady();
 
-                this.emit("stateChanged", "initialized");
-                this.emit("initialized");
+                this.emit(Client_1.stateChanged, "initialized");
+                this.emit(Client_1.initialized);
 
               case 36:
               case "end":