@twilio/conversations 2.4.0 → 2.4.1-rc.1

package/builds/lib.d.ts

@@ -6,8 +6,7 @@ import { ConnectionState as TwilsockConnectionState } from "twilsock";
 import { ReplayEventEmitter } from "@twilio/replay-event-emitter";
 import { ChannelType, Notifications } from "@twilio/notifications";
 import { Notifications as NotificationClient } from "@twilio/notifications";
-import { CancellablePromise, McsClient, MediaCategory, McsMedia } from "@twilio/mcs-client";
-import { MediaCategory as McsMediaCategory } from "@twilio/mcs-client";
+import { CancellablePromise, McsClient, MediaCategory, McsMedia, McsMediaCategory, McsMediaState } from "@twilio/mcs-client";
 interface ConfigurationResponse {
     options: {
         consumption_report_interval: string;
@@ -523,13 +522,6 @@ interface ParticipantBindingOptions {
  * * `'history'`
  */
 type MediaCategory$0 = McsMediaCategory;
-interface MediaState {
-    sid: string;
-    category: MediaCategory$0;
-    filename: string | null;
-    contentType: string;
-    size: number;
-}
 interface MediaServices {
     mcsClient: McsClient;
 }
@@ -543,7 +535,7 @@ declare class Media {
     /**
      * @internal
      */
-    constructor(data: MediaState | McsMedia, services: MediaServices);
+    constructor(data: McsMediaState | McsMedia, services: MediaServices);
     /**
      * Server-assigned unique identifier for the media.
      */
@@ -573,6 +565,10 @@ declare class Media {
      */
     getContentTemporaryUrl(): CancellablePromise<string | null>;
     private _fetchMcsMedia;
+    /**
+     * @internal
+     */
+    _state(): McsMediaState;
 }
 /**
  * Signifies the amount of participants which have the status for the message.
@@ -1229,9 +1225,9 @@ interface MessageLinks {
 /**
  * The reason for the `updated` event being emitted by a message.
  */
-type MessageUpdateReason = "body" | "lastUpdatedBy" | "dateCreated" | "dateUpdated" | "attributes" | "author" | "deliveryReceipt" | "subject";
+type MessageUpdateReason = "body" | "lastUpdatedBy" | "dateCreated" | "dateUpdated" | "attributes" | "author" | "deliveryReceipt" | "subject" | "media";
 /**
- * Type of a message.
+ * Type of message.
  */
 type MessageType = "text" | "media";
 interface MessageUpdatedEventArgs {
@@ -1259,6 +1255,7 @@ interface MessageData {
  * A message in a conversation.
  */
 declare class Message extends ReplayEventEmitter<MessageEvents> {
+    #private;
     /**
      * Conversation that the message is in.
      */

package/builds/lib.js

@@ -212,6 +212,7 @@ require('isomorphic-form-data');
 require('core-js/modules/es.array.sort.js');
 require('core-js/modules/es.string.includes.js');
 require('core-js/modules/es.string.starts-with.js');
+require('core-js/modules/es.weak-set.js');
 var deprecationDecorator = require('@twilio/deprecation-decorator');
 require('core-js/modules/es.object.entries.js');
 require('core-js/modules/es.array.find.js');
@@ -2102,6 +2103,8 @@ var Media = /*#__PURE__*/function () {
    * @internal
    */
   function Media(data, services) {
+    var _data$filename;
+
     _classCallCheck__default["default"](this, Media);
 
     _defineProperty__default["default"](this, "mcsMedia", null);
@@ -2115,7 +2118,7 @@ var Media = /*#__PURE__*/function () {
     this.state = {
       sid: data.sid,
       category: data.category,
-      filename: data.filename,
+      filename: (_data$filename = data.filename) !== null && _data$filename !== void 0 ? _data$filename : null,
       contentType: data.contentType,
       size: data.size
     };
@@ -2188,10 +2191,12 @@ var Media = /*#__PURE__*/function () {
             while (1) {
               switch (_context.prev = _context.next) {
                 case 0:
-                  fetchMediaRequest = _this._fetchMcsMedia();
+                  fetchMediaRequest = _this.mcsMedia ? undefined : _this._fetchMcsMedia();
                   contentUrlRequest = (_this$mcsMedia = _this.mcsMedia) === null || _this$mcsMedia === void 0 ? void 0 : _this$mcsMedia.getContentUrl();
                   onCancel(function () {
-                    fetchMediaRequest.cancel();
+                    if (fetchMediaRequest) {
+                      fetchMediaRequest.cancel();
+                    }
 
                     if (contentUrlRequest) {
                       contentUrlRequest.cancel();
@@ -2199,7 +2204,7 @@ var Media = /*#__PURE__*/function () {
                   });
                   _context.prev = 3;
 
-                  if (_this.mcsMedia) {
+                  if (contentUrlRequest) {
                     _context.next = 9;
                     break;
                   }
@@ -2209,7 +2214,7 @@ var Media = /*#__PURE__*/function () {
 
                 case 7:
                   mcsMedia = _context.sent;
-                  contentUrlRequest = mcsMedia.getContentUrl();
+                  contentUrlRequest = mcsMedia === null || mcsMedia === void 0 ? void 0 : mcsMedia.getContentUrl();
 
                 case 9:
                   _context.t0 = resolve;
@@ -2266,13 +2271,11 @@ var Media = /*#__PURE__*/function () {
             while (1) {
               switch (_context2.prev = _context2.next) {
                 case 0:
-                  request = _this2.services.mcsClient.get(_this2.state.sid);
-
-                  if (!_this2.services.mcsClient) {
-                    _context2.next = 14;
-                    break;
+                  if (_this2.services.mcsClient === null) {
+                    reject(new Error("Media Content Service is unavailable"));
                   }
 
+                  request = _this2.services.mcsClient.get(_this2.state.sid);
                   onCancel(function () {
                     return request.cancel();
                   });
@@ -2282,27 +2285,22 @@ var Media = /*#__PURE__*/function () {
 
                 case 6:
                   _this2.mcsMedia = _context2.sent;
+                  _this2.state = _this2.mcsMedia._state();
                   resolve(_this2.mcsMedia);
-                  _context2.next = 13;
+                  _context2.next = 14;
                   break;
 
-                case 10:
-                  _context2.prev = 10;
+                case 11:
+                  _context2.prev = 11;
                   _context2.t0 = _context2["catch"](3);
                   reject(_context2.t0);
 
-                case 13:
-                  return _context2.abrupt("return");
-
                 case 14:
-                  reject(new Error("Media Content Service is unavailable"));
-
-                case 15:
                 case "end":
                   return _context2.stop();
               }
             }
-          }, _callee2, null, [[3, 10]]);
+          }, _callee2, null, [[3, 11]]);
         }));
 
         return function (_x4, _x5, _x6) {
@@ -2310,6 +2308,15 @@ var Media = /*#__PURE__*/function () {
         };
       }());
     }
+    /**
+     * @internal
+     */
+
+  }, {
+    key: "_state",
+    value: function _state() {
+      return this.state;
+    }
   }]);
 
   return Media;
@@ -2807,6 +2814,12 @@ function _objectSpread$4(target) { for (var i = 1; i < arguments.length; i++) {
 function _createSuper$6(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct$6(); return function _createSuperInternal() { var Super = _getPrototypeOf__default["default"](Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf__default["default"](this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn__default["default"](this, result); }; }
 
 function _isNativeReflectConstruct$6() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
 var log$3 = Logger.scope("Message");
 
 var XHR = // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -2816,6 +2829,10 @@ global["XMLHttpRequest"] || require("xmlhttprequest").XMLHttpRequest;
  */
 
 
+var _wrapMedia = /*#__PURE__*/new WeakSet();
+
+var _assignMedias = /*#__PURE__*/new WeakSet();
+
 var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
   _inherits__default["default"](Message, _ReplayEventEmitter);
 
@@ -2829,13 +2846,18 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
    * @internal
    */
   function Message(index, data, conversation, links, configuration, services) {
-    var _data$text, _data$lastUpdatedBy, _data$type, _data$memberSid, _data$channelMetadata;
+    var _data$text, _data$lastUpdatedBy, _data$type, _data$memberSid, _data$channelMetadata, _data$medias, _data$media;
 
     var _this;
 
     _classCallCheck__default["default"](this, Message);
 
     _this = _super.call(this);
+
+    _classPrivateMethodInitSpec(_assertThisInitialized__default["default"](_this), _assignMedias);
+
+    _classPrivateMethodInitSpec(_assertThisInitialized__default["default"](_this), _wrapMedia);
+
     _this.conversation = conversation;
     _this.links = links;
     _this.configuration = configuration;
@@ -2852,27 +2874,17 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
       lastUpdatedBy: (_data$lastUpdatedBy = data.lastUpdatedBy) !== null && _data$lastUpdatedBy !== void 0 ? _data$lastUpdatedBy : null,
       attributes: parseAttributes(data.attributes, "Got malformed attributes for the message ".concat(data.sid), log$3),
       type: (_data$type = data.type) !== null && _data$type !== void 0 ? _data$type : "text",
-      media: data.type === "media" && data.media ? new Media(data.media, _this.services) : null,
-      medias: data.type === "media" && data.medias ? data.medias.map(function (m) {
-        return new Media(m, _this.services);
-      }) : data.type === "media" && data.media && !data.medias ? [new Media(_objectSpread$4(_objectSpread$4({}, data.media), {}, {
-        category: "media"
-      }), _this.services)] : null,
+      media: null,
+      medias: null,
       participantSid: (_data$memberSid = data.memberSid) !== null && _data$memberSid !== void 0 ? _data$memberSid : null,
       aggregatedDeliveryReceipt: data.delivery ? new AggregatedDeliveryReceipt(data.delivery) : null,
       hasChannelMetadata: (_data$channelMetadata = data.channelMetadata) !== null && _data$channelMetadata !== void 0 ? _data$channelMetadata : false
     };
+
+    _classPrivateMethodGet(_assertThisInitialized__default["default"](_this), _assignMedias, _assignMedias2).call(_assertThisInitialized__default["default"](_this), (_data$medias = data.medias) !== null && _data$medias !== void 0 ? _data$medias : null, (_data$media = data.media) !== null && _data$media !== void 0 ? _data$media : null);
+
     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",
@@ -3083,6 +3095,12 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
   }, {
     key: "_update",
     value: function _update(data) {
+      var _data$medias2,
+          _this2 = this,
+          _this$state$medias2,
+          _classPrivateMethodGe2,
+          _this$state$media;
+
       var updateReasons = [];
 
       if ((data.text || typeof data.text === "string") && data.text !== this.state.body) {
@@ -3135,6 +3153,29 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
           updateReasons.push("deliveryReceipt");
         }
+      } // @fixme: This is a fairly heavy check.
+      // Map data back and forth to perform a necessary field massage.
+
+
+      var input = ((_data$medias2 = data.medias) !== null && _data$medias2 !== void 0 ? _data$medias2 : []).map(function (value) {
+        var _classPrivateMethodGe;
+
+        return (_classPrivateMethodGe = _classPrivateMethodGet(_this2, _wrapMedia, _wrapMedia2).call(_this2, value)) === null || _classPrivateMethodGe === void 0 ? void 0 : _classPrivateMethodGe._state();
+      }).filter(function (el) {
+        return !(el === null);
+      });
+      var current = ((_this$state$medias2 = this.state.medias) !== null && _this$state$medias2 !== void 0 ? _this$state$medias2 : []).map(function (value) {
+        return value._state();
+      }).filter(function (el) {
+        return !(el === null);
+      });
+
+      if (!isEqual__default["default"](input, current) || !isEqual__default["default"]((_classPrivateMethodGe2 = _classPrivateMethodGet(this, _wrapMedia, _wrapMedia2).call(this, data.media)) === null || _classPrivateMethodGe2 === void 0 ? void 0 : _classPrivateMethodGe2._state(), (_this$state$media = this.state.media) === null || _this$state$media === void 0 ? void 0 : _this$state$media._state())) {
+        var _data$medias3, _data$media2;
+
+        _classPrivateMethodGet(this, _assignMedias, _assignMedias2).call(this, (_data$medias3 = data.medias) !== null && _data$medias3 !== void 0 ? _data$medias3 : null, (_data$media2 = data.media) !== null && _data$media2 !== void 0 ? _data$media2 : null);
+
+        updateReasons.push("media");
       }
 
       if (updateReasons.length > 0) {
@@ -3152,7 +3193,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
     key: "getParticipant",
     value: function () {
       var _getParticipant = _asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee() {
-        var _this2 = this;
+        var _this3 = this;
 
         var participant, errorMesage;
         return _regeneratorRuntime__default["default"].wrap(function _callee$(_context) {
@@ -3168,7 +3209,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
                 _context.next = 4;
                 return this.conversation.getParticipantBySid(this.state.participantSid).catch(function () {
-                  log$3.debug("Participant with sid \"".concat(_this2.participantSid, "\" not found for message ").concat(_this2.sid));
+                  log$3.debug("Participant with sid \"".concat(_this3.participantSid, "\" not found for message ").concat(_this3.sid));
                   return null;
                 });
 
@@ -3183,7 +3224,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
                 _context.next = 8;
                 return this.conversation.getParticipantByIdentity(this.state.author).catch(function () {
-                  log$3.debug("Participant with identity \"".concat(_this2.author, "\" not found for message ").concat(_this2.sid));
+                  log$3.debug("Participant with identity \"".concat(_this3.author, "\" not found for message ").concat(_this3.sid));
                   return null;
                 });
 
@@ -3398,7 +3439,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
     key: "attachTemporaryUrlsFor",
     value: function () {
       var _attachTemporaryUrlsFor = _asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee6(contentSet) {
-        var _this3 = this;
+        var _this4 = this;
 
         var sids;
         return _regeneratorRuntime__default["default"].wrap(function _callee6$(_context6) {
@@ -3421,7 +3462,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
               case 4:
                 return _context6.abrupt("return", _context6.sent.map(function (item) {
-                  return new Media(item, _this3.services);
+                  return new Media(item, _this4.services);
                 }));
 
               case 7:
@@ -3464,7 +3505,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
   }, {
     key: "getTemporaryContentUrlsForMediaSids",
     value: function getTemporaryContentUrlsForMediaSids(mediaSids) {
-      var _this4 = this;
+      var _this5 = this;
 
       return new mcsClient.CancellablePromise( /*#__PURE__*/function () {
         var _ref = _asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee7(resolve, reject, onCancel) {
@@ -3473,9 +3514,9 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
             while (1) {
               switch (_context7.prev = _context7.next) {
                 case 0:
-                  mediaGetRequest = _this4.services.mcsClient.mediaSetGetContentUrls(mediaSids !== null && mediaSids !== void 0 ? mediaSids : []);
+                  mediaGetRequest = _this5.services.mcsClient.mediaSetGetContentUrls(mediaSids !== null && mediaSids !== void 0 ? mediaSids : []);
 
-                  if (!(!_this4.services.mcsClient || !mediaSids)) {
+                  if (!(!_this5.services.mcsClient || !mediaSids)) {
                     _context7.next = 4;
                     break;
                   }
@@ -3534,7 +3575,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
     key: "_getDetailedDeliveryReceiptsPaginator",
     value: function () {
       var _getDetailedDeliveryReceiptsPaginator2 = _asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee8(options) {
-        var _this5 = this;
+        var _this6 = this;
 
         var messagesReceiptsUrl, url, response;
         return _regeneratorRuntime__default["default"].wrap(function _callee8$(_context8) {
@@ -3551,7 +3592,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
                 return _context8.abrupt("return", new RestPaginator(response.body.delivery_receipts.map(function (x) {
                   return new DetailedDeliveryReceipt(x);
                 }), function (pageToken, pageSize) {
-                  return _this5._getDetailedDeliveryReceiptsPaginator({
+                  return _this6._getDetailedDeliveryReceiptsPaginator({
                     pageToken: pageToken,
                     pageSize: pageSize
                   });
@@ -3579,7 +3620,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
   }, {
     key: "getContentData",
     value: function getContentData() {
-      var _this6 = this;
+      var _this7 = this;
 
       return new mcsClient.CancellablePromise( /*#__PURE__*/function () {
         var _ref2 = _asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee9(resolve, reject, onCancel) {
@@ -3588,7 +3629,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
             while (1) {
               switch (_context9.prev = _context9.next) {
                 case 0:
-                  if (!(_this6.state.contentSid === null)) {
+                  if (!(_this7.state.contentSid === null)) {
                     _context9.next = 3;
                     break;
                   }
@@ -3597,7 +3638,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
                   return _context9.abrupt("return");
 
                 case 3:
-                  bodies = _this6.getMediaByCategories(["body"]);
+                  bodies = _this7.getMediaByCategories(["body"]);
 
                   if (!(bodies === null)) {
                     _context9.next = 7;
@@ -3758,6 +3799,28 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
   return Message;
 }(replayEventEmitter.ReplayEventEmitter);
 
+function _wrapMedia2(media) {
+  var category = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
+  return media ? category ? new Media(_objectSpread$4(_objectSpread$4({}, media), {}, {
+    category: category
+  }), this.services) : new Media(media, this.services) : null;
+}
+
+function _assignMedias2(medias, media) {
+  var _this8 = this;
+
+  this.state.media = _classPrivateMethodGet(this, _wrapMedia, _wrapMedia2).call(this, media); // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+
+  this.state.medias = medias ? medias.map(function (m) {
+    return _classPrivateMethodGet(_this8, _wrapMedia, _wrapMedia2).call(_this8, m);
+  }).filter(function (el) {
+    return el !== null;
+  }) : media && !medias ? [_classPrivateMethodGet(this, _wrapMedia, _wrapMedia2).call(this, media, "media")].filter(function (el) {
+    return el !== null;
+  }) : null;
+}
+
 _defineProperty__default["default"](Message, "updated", "updated");
 
 __decorate([deprecationDecorator.deprecated("getMediaByCategory", "getMediaByCategories"), __metadata("design:type", Function), __metadata("design:paramtypes", [Array]), __metadata("design:returntype", Array)], Message.prototype, "getMediaByCategory", null);
@@ -7815,7 +7878,7 @@ function PushNotification(data) {
   this.data = data.data || {};
 });
 
-var version = "2.4.0";
+var version = "2.4.1-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; }