@twilio/conversations 3.0.0-rc.9 → 3.0.1-rc.0

package/dist/message.js

@@ -126,68 +126,70 @@ This software includes platform.js under the following license.
     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var tslib_es6 = require('./node_modules/tslib/tslib.es6.js');
-var index = require('./util/index.js');
-var logger = require('./logger.js');
-var mcsClient = require('@twilio/mcs-client');
-var media = require('./media.js');
-var aggregatedDeliveryReceipt = require('./aggregated-delivery-receipt.js');
-var declarativeTypeValidator = require('@twilio/declarative-type-validator');
-var attributes = require('./interfaces/attributes.js');
-var restPaginator = require('./rest-paginator.js');
-var detailedDeliveryReceipt = require('./detailed-delivery-receipt.js');
-var replayEventEmitter = require('@twilio/replay-event-emitter');
-var isEqual = require('lodash.isequal');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
-
-const log = logger.Logger.scope("Message");
+var global =
+  typeof global !== "undefined"
+    ? global
+    : typeof self !== "undefined"
+    ? self
+    : typeof window !== "undefined"
+    ? window
+    : {};
+
+import { __decorate, __metadata, __classPrivateFieldGet } from './node_modules/tslib/tslib.es6.js';
+import { parseAttributes, isEqual, UriBuilder } from './util/index.js';
+import { Logger } from './logger.js';
+import { CancellablePromise } from '@twilio/mcs-client';
+import { Media } from './media.js';
+import { AggregatedDeliveryReceipt } from './aggregated-delivery-receipt.js';
+import { validateTypes, nonEmptyString, validateTypesAsync, nonEmptyArray } from '@twilio/declarative-type-validator';
+import { json } from './interfaces/rules.js';
+import { RestPaginator } from './rest-paginator.js';
+import { DetailedDeliveryReceipt } from './detailed-delivery-receipt.js';
+import { ReplayEventEmitter } from '@twilio/replay-event-emitter';
+import { deprecated } from '@twilio/deprecation-decorator';
+import { parseVariant } from './content-template.js';
+
+var _Message_instances, _Message_wrapMedia, _Message_assignMedias;
+const log = Logger.scope("Message");
+const XHR = 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+global["XMLHttpRequest"] || {};
 /**
  * A message in a conversation.
  */
-class Message extends replayEventEmitter.ReplayEventEmitter {
+class Message extends ReplayEventEmitter {
     /**
      * @internal
      */
-    constructor(index$1, data, conversation, links, configuration, services) {
-        var _a, _b, _c, _d;
+    constructor(index, data, conversation, links, configuration, services) {
+        var _a, _b, _c, _d, _e, _f, _g;
         super();
+        _Message_instances.add(this);
         this.conversation = conversation;
         this.links = links;
         this.configuration = configuration;
         this.services = services;
         this.state = {
             sid: data.sid,
-            index: index$1,
+            index: index,
             author: data.author,
             subject: data.subject,
+            contentSid: data.contentSid,
             body: (_a = data.text) !== null && _a !== void 0 ? _a : null,
             timestamp: data.timestamp ? new Date(data.timestamp) : null,
             dateUpdated: data.dateUpdated ? new Date(data.dateUpdated) : null,
             lastUpdatedBy: (_b = data.lastUpdatedBy) !== null && _b !== void 0 ? _b : null,
-            attributes: index.parseAttributes(data.attributes, `Got malformed attributes for the message ${data.sid}`, log),
+            attributes: parseAttributes(data.attributes, `Got malformed attributes for the message ${data.sid}`, log),
             type: (_c = data.type) !== null && _c !== void 0 ? _c : "text",
-            media: data.type === "media" && data.media
-                ? new media.Media(data.media, this.services)
-                : null,
-            medias: data.type === "media" && data.medias
-                ? data.medias.map((m) => new media.Media(m, this.services))
-                : data.type === "media" && data.media && !data.medias
-                    ? [
-                        new media.Media(Object.assign(Object.assign({}, data.media), { category: "media" }), this.services),
-                    ]
-                    : null,
+            media: null,
+            medias: null,
             participantSid: (_d = data.memberSid) !== null && _d !== void 0 ? _d : null,
             aggregatedDeliveryReceipt: data.delivery
-                ? new aggregatedDeliveryReceipt.AggregatedDeliveryReceipt(data.delivery)
+                ? new AggregatedDeliveryReceipt(data.delivery)
                 : null,
+            hasChannelMetadata: (_e = data.channelMetadata) !== null && _e !== void 0 ? _e : false,
         };
+        __classPrivateFieldGet(this, _Message_instances, "m", _Message_assignMedias).call(this, (_f = data.medias) !== null && _f !== void 0 ? _f : null, (_g = data.media) !== null && _g !== void 0 ? _g : null);
     }
     /**
      * The server-assigned unique identifier for the message.
@@ -207,6 +209,12 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
     get subject() {
         return this.state.subject;
     }
+    /**
+     * Unique identifier of {@link ContentTemplate} for this message.
+     */
+    get contentSid() {
+        return this.state.contentSid;
+    }
     /**
      * Body of the message.
      */
@@ -220,14 +228,15 @@ class Message extends replayEventEmitter.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.
      */
     get index() {
@@ -282,6 +291,16 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
     get aggregatedDeliveryReceipt() {
         return this.state.aggregatedDeliveryReceipt;
     }
+    /**
+     * @deprecated
+     * Return a (possibly empty) array of media matching a specific set of categories.
+     * Allowed category is so far only 'media'.
+     * @param categories Array of categories to match.
+     * @returns Array of media descriptors matching given categories.
+     */
+    getMediaByCategory(categories) {
+        return this.getMediaByCategories(categories);
+    }
     /**
      * Return a (possibly empty) array of media matching a specific set of categories.
      * Allowed category is so far only 'media'.
@@ -311,6 +330,7 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
         return ((_b = (_a = this.getMediaByCategories(["history"])) === null || _a === void 0 ? void 0 : _a.filter((m) => m.contentType == type).shift()) !== null && _b !== void 0 ? _b : null);
     }
     _update(data) {
+        var _a, _b, _c, _d, _e, _f;
         const updateReasons = [];
         if ((data.text || typeof data.text === "string") &&
             data.text !== this.state.body) {
@@ -341,8 +361,8 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
             this.state.timestamp = new Date(data.timestamp);
             updateReasons.push("dateCreated");
         }
-        const updatedAttributes = index.parseAttributes(data.attributes, `Got malformed attributes for the message ${this.sid}`, log);
-        if (!isEqual__default["default"](this.state.attributes, updatedAttributes)) {
+        const updatedAttributes = parseAttributes(data.attributes, `Got malformed attributes for the message ${this.sid}`, log);
+        if (!isEqual(this.state.attributes, updatedAttributes)) {
             this.state.attributes = updatedAttributes;
             updateReasons.push("attributes");
         }
@@ -357,7 +377,7 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
             !!updatedAggregatedDelivery.undelivered;
         if (isUpdatedAggregateDeliveryValid) {
             if (!currentAggregatedDelivery) {
-                this.state.aggregatedDeliveryReceipt = new aggregatedDeliveryReceipt.AggregatedDeliveryReceipt(updatedAggregatedDelivery);
+                this.state.aggregatedDeliveryReceipt = new AggregatedDeliveryReceipt(updatedAggregatedDelivery);
                 updateReasons.push("deliveryReceipt");
             }
             else if (!currentAggregatedDelivery._isEquals(updatedAggregatedDelivery)) {
@@ -365,6 +385,19 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
                 updateReasons.push("deliveryReceipt");
             }
         }
+        // @fixme: This is a fairly heavy check.
+        // Map data back and forth to perform a necessary field massage.
+        const input = ((_a = data.medias) !== null && _a !== void 0 ? _a : [])
+            .map((value) => { var _a; return (_a = __classPrivateFieldGet(this, _Message_instances, "m", _Message_wrapMedia).call(this, value)) === null || _a === void 0 ? void 0 : _a._state(); })
+            .filter((el) => !(el === null));
+        const current = ((_b = this.state.medias) !== null && _b !== void 0 ? _b : [])
+            .map((value) => value._state())
+            .filter((el) => !(el === null));
+        if (!isEqual(input, current) ||
+            !isEqual((_c = __classPrivateFieldGet(this, _Message_instances, "m", _Message_wrapMedia).call(this, data.media)) === null || _c === void 0 ? void 0 : _c._state(), (_d = this.state.media) === null || _d === void 0 ? void 0 : _d._state())) {
+            __classPrivateFieldGet(this, _Message_instances, "m", _Message_assignMedias).call(this, (_e = data.medias) !== null && _e !== void 0 ? _e : null, (_f = data.media) !== null && _f !== void 0 ? _f : null);
+            updateReasons.push("media");
+        }
         if (updateReasons.length > 0) {
             this.emit("updated", { message: this, updateReasons: updateReasons });
         }
@@ -393,37 +426,34 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
         if (participant) {
             return participant;
         }
-        let errorMesage = "Participant with ";
+        let 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);
     }
     /**
      * Get the delivery receipts of the message.
      */
     async getDetailedDeliveryReceipts() {
         let paginator = await this._getDetailedDeliveryReceiptsPaginator();
-        let detailedDeliveryReceipts = [];
-        while (true) {
+        let detailedDeliveryReceipts = paginator.items;
+        while (paginator.hasNextPage) {
+            paginator = await paginator.nextPage();
             detailedDeliveryReceipts = [
                 ...detailedDeliveryReceipts,
                 ...paginator.items,
             ];
-            if (!paginator.hasNextPage) {
-                break;
-            }
-            paginator = await paginator.nextPage();
         }
         return detailedDeliveryReceipts;
     }
@@ -456,6 +486,24 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
         });
         return this;
     }
+    /**
+     * @deprecated
+     * Get content URLs for all media attachments in the given set using a single operation.
+     * @param contentSet Set of media attachments to query content URLs.
+     */
+    async attachTemporaryUrlsFor(contentSet) {
+        // We ignore existing mcsMedia members of each of the media entries.
+        // Instead we just collect their sids and pull new descriptors from a mediaSet GET endpoint.
+        const sids = contentSet === null || contentSet === void 0 ? void 0 : contentSet.map((m) => m.sid);
+        if (this.services.mcsClient && sids) {
+            return (await this.services.mcsClient.mediaSetGet(sids)).map((item) => {
+                return new Media(item, this.services);
+            });
+        }
+        else {
+            throw new Error("Media Content Service is unavailable");
+        }
+    }
     /**
      * Get content URLs for all media attachments in the given set using a single operation.
      * @param contentSet Set of media attachments to query content URLs.
@@ -471,7 +519,7 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
      * @param mediaSids Set of media sids to query for the content URL.
      */
     getTemporaryContentUrlsForMediaSids(mediaSids) {
-        return new mcsClient.CancellablePromise(async (resolve, reject, onCancel) => {
+        return new CancellablePromise(async (resolve, reject, onCancel) => {
             const mediaGetRequest = this.services.mcsClient.mediaSetGetContentUrls(mediaSids !== null && mediaSids !== void 0 ? mediaSids : []);
             if (!this.services.mcsClient || !mediaSids) {
                 reject(new Error("Media Content Service is unavailable"));
@@ -502,14 +550,120 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
         const messagesReceiptsUrl = this.configuration.links.messagesReceipts
             .replace("%s", this.conversation.sid)
             .replace("%s", this.sid);
-        const url = new index.UriBuilder(messagesReceiptsUrl)
+        const url = new UriBuilder(messagesReceiptsUrl)
             .arg("PageToken", options === null || options === void 0 ? void 0 : options.pageToken)
             .arg("PageSize", options === null || options === void 0 ? void 0 : options.pageSize)
             .build();
         const response = await this.services.network.get(url);
-        return new restPaginator.RestPaginator(response.body.delivery_receipts.map((x) => new detailedDeliveryReceipt.DetailedDeliveryReceipt(x)), (pageToken, pageSize) => this._getDetailedDeliveryReceiptsPaginator({ pageToken, pageSize }), response.body.meta.previous_token, response.body.meta.next_token);
+        return new RestPaginator(response.body.delivery_receipts.map((x) => new DetailedDeliveryReceipt(x)), (pageToken, pageSize) => this._getDetailedDeliveryReceiptsPaginator({ pageToken, pageSize }), response.body.meta.previous_token, response.body.meta.next_token);
+    }
+    /**
+     * Get the {@link ContentData} for this message. Resolves to `null` when
+     * {@link Message.contentSid} is null.
+     */
+    getContentData() {
+        return new CancellablePromise(async (resolve, reject, onCancel) => {
+            if (this.state.contentSid === null) {
+                resolve(null);
+                return;
+            }
+            const bodies = this.getMediaByCategories(["body"]);
+            if (bodies === null) {
+                resolve(null);
+                return;
+            }
+            const twilioPrefix = "application/x-vnd.com.twilio.rich.";
+            const filteredMedias = bodies.filter((media) => media.contentType.startsWith(twilioPrefix));
+            if (filteredMedias.length === 0) {
+                resolve(null);
+                return;
+            }
+            const contentMedia = filteredMedias[0];
+            const urlPromise = contentMedia.getContentTemporaryUrl();
+            onCancel(() => {
+                urlPromise.cancel();
+            });
+            let url;
+            try {
+                url = await urlPromise;
+            }
+            catch (e) {
+                reject(e);
+                return;
+            }
+            if (url === null) {
+                resolve(null);
+                return;
+            }
+            const jsonStringPromise = new Promise((resolve, reject) => {
+                let isCancelled = false;
+                const xhr = new XHR();
+                xhr.open("GET", url !== null && url !== void 0 ? url : "", true);
+                xhr.responseType = "text";
+                xhr.onreadystatechange = () => {
+                    if (xhr.readyState !== 4 || isCancelled) {
+                        return;
+                    }
+                    resolve(xhr.responseText);
+                };
+                xhr.onerror = () => {
+                    reject(xhr.statusText);
+                };
+                onCancel(() => {
+                    isCancelled = true;
+                    xhr.abort();
+                    reject(new Error("XHR has been aborted"));
+                });
+                xhr.send();
+            });
+            let json;
+            try {
+                const jsonString = await jsonStringPromise;
+                json = JSON.parse(jsonString);
+            }
+            catch (e) {
+                reject(e);
+                return;
+            }
+            const dataType = contentMedia.contentType
+                .replace(twilioPrefix, "")
+                .replace(".", "/");
+            resolve(parseVariant(dataType, json.data));
+        });
+    }
+    /**
+     * Get the {@link ChannelMetadata} for this message. Resolves to `null` if
+     * the message doesn't have any channel metadata.
+     */
+    async getChannelMetadata() {
+        if (!this.state.hasChannelMetadata) {
+            return null;
+        }
+        return await this.services.channelMetadataClient.getChannelMetadata(this.conversation.sid, this.sid);
+    }
+    /**
+     * Get recipients of the message.
+     */
+    async getMessageRecipients() {
+        return await this.services.messageRecipientsClient.getRecipientsFromMessage(this.conversation.sid, this.sid);
     }
 }
+_Message_instances = new WeakSet(), _Message_wrapMedia = function _Message_wrapMedia(media, category = null) {
+    return media
+        ? category
+            ? new Media(Object.assign(Object.assign({}, media), { category }), this.services)
+            : new Media(media, this.services)
+        : null;
+}, _Message_assignMedias = function _Message_assignMedias(medias, media) {
+    this.state.media = __classPrivateFieldGet(this, _Message_instances, "m", _Message_wrapMedia).call(this, media);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    this.state.medias = medias
+        ? medias.map((m) => __classPrivateFieldGet(this, _Message_instances, "m", _Message_wrapMedia).call(this, m)).filter((el) => el !== null)
+        : media && !medias
+            ? [__classPrivateFieldGet(this, _Message_instances, "m", _Message_wrapMedia).call(this, media, "media")].filter((el) => el !== null)
+            : null;
+};
 /**
  * Fired when the properties or the body of the message has been updated.
  *
@@ -519,42 +673,54 @@ class Message extends replayEventEmitter.ReplayEventEmitter {
  *     * {@link MessageUpdateReason}[] updateReasons - array of reasons for the update
  */
 Message.updated = "updated";
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypes([declarativeTypeValidator.nonEmptyString, "undefined"]),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [Object]),
-    tslib_es6.__metadata("design:returntype", media.Media)
+__decorate([
+    deprecated("getMediaByCategory", "getMediaByCategories"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array]),
+    __metadata("design:returntype", Array)
+], Message.prototype, "getMediaByCategory", null);
+__decorate([
+    validateTypes([nonEmptyString, "undefined"]),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Media)
 ], Message.prototype, "getEmailBody", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypes([declarativeTypeValidator.nonEmptyString, "undefined"]),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [Object]),
-    tslib_es6.__metadata("design:returntype", media.Media)
+__decorate([
+    validateTypes([nonEmptyString, "undefined"]),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Media)
 ], Message.prototype, "getEmailHistory", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync("string"),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [String]),
-    tslib_es6.__metadata("design:returntype", Promise)
+__decorate([
+    validateTypesAsync("string"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
 ], Message.prototype, "updateBody", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(attributes.attributesValidator),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [Object]),
-    tslib_es6.__metadata("design:returntype", Promise)
+__decorate([
+    validateTypesAsync(json),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
 ], Message.prototype, "updateAttributes", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyArray("media", media.Media)),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [Array]),
-    tslib_es6.__metadata("design:returntype", mcsClient.CancellablePromise)
+__decorate([
+    deprecated("attachTemporaryUrlsFor", "getTemporaryContentUrlsForMedia"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array]),
+    __metadata("design:returntype", Promise)
+], Message.prototype, "attachTemporaryUrlsFor", null);
+__decorate([
+    validateTypesAsync(nonEmptyArray("media", Media)),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array]),
+    __metadata("design:returntype", CancellablePromise)
 ], Message.prototype, "getTemporaryContentUrlsForMedia", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyArray("strings", "string")),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [Array]),
-    tslib_es6.__metadata("design:returntype", mcsClient.CancellablePromise)
+__decorate([
+    validateTypesAsync(nonEmptyArray("strings", "string")),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array]),
+    __metadata("design:returntype", CancellablePromise)
 ], Message.prototype, "getTemporaryContentUrlsForMediaSids", null);
 
-exports.Message = Message;
+export { Message };
 //# sourceMappingURL=message.js.map