@twilio/conversations 2.1.0 → 3.0.0-rc.1

package/dist/client.js

@@ -151,8 +151,9 @@ var commandExecutor = require('./command-executor.js');
 var replayEventEmitter = require('@twilio/replay-event-emitter');
 
 var Client_1;
-const log = logger.Logger.scope("Client");
-const SDK_VERSION = _package.version;
+/**
+ * Client services.
+ */
 class ClientServices {
 }
 /**
@@ -160,9 +161,11 @@ class ClientServices {
  */
 exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventEmitter {
     /**
-     * Returned Conversations 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', event tokenExpired, event connectionError).
+     * Returned Conversations 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',
+     * event tokenExpired, event connectionError).
      *
      * @param fpaToken Access token
      * @param options Options to customize the Client
@@ -171,6 +174,10 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
     constructor(fpaToken, options = {}) {
         var _a, _b, _c, _d, _e;
         super();
+        /**
+         * Current version of the Conversations client.
+         */
+        this.version = _package.version;
         /**
          * Client connection state.
          */
@@ -178,98 +185,97 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         /**
          * Current version of the Conversations client.
          */
-        this.version = SDK_VERSION;
         this.parsePushNotification = Client_1.parsePushNotification;
-        this.fpaToken = fpaToken !== null && fpaToken !== void 0 ? fpaToken : "";
-        this.options = options !== null && options !== void 0 ? options : {};
-        if (!this.options.disableDeepClone) {
-            let options = Object.assign(Object.assign({}, this.options), { transport: undefined, twilsockClient: undefined });
+        this._fpaToken = fpaToken !== null && fpaToken !== void 0 ? fpaToken : "";
+        this._options = options !== null && options !== void 0 ? options : {};
+        if (!this._options.disableDeepClone) {
+            let options = Object.assign(Object.assign({}, this._options), { transport: undefined, twilsockClient: undefined });
             options = index.deepClone(options);
-            options.transport = this.options.transport;
-            options.twilsockClient = this.options.twilsockClient;
-            this.options = options;
+            options.transport = this._options.transport;
+            options.twilsockClient = this._options.twilsockClient;
+            this._options = options;
         }
-        this.options.logLevel = (_a = this.options.logLevel) !== null && _a !== void 0 ? _a : "silent";
-        log.setLevel(this.options.logLevel);
-        const productId = (this.options.productId = "ip_messaging");
+        this._options.logLevel = (_a = this._options.logLevel) !== null && _a !== void 0 ? _a : "silent";
+        Client_1._logger.setLevel(this._options.logLevel);
+        const productId = (this._options.productId = "ip_messaging");
         // Filling ClientMetadata
-        this.options.clientMetadata = this.options.clientMetadata || {};
-        if (!this.options.clientMetadata.hasOwnProperty("type")) {
-            this.options.clientMetadata.type = "conversations";
+        this._options.clientMetadata = this._options.clientMetadata || {};
+        if (!this._options.clientMetadata.hasOwnProperty("type")) {
+            this._options.clientMetadata.type = "conversations";
         }
-        if (!this.options.clientMetadata.hasOwnProperty("sdk")) {
-            this.options.clientMetadata.sdk = "JS";
-            this.options.clientMetadata.sdkv = SDK_VERSION;
+        if (!this._options.clientMetadata.hasOwnProperty("sdk")) {
+            this._options.clientMetadata.sdk = "JS";
+            this._options.clientMetadata.sdkv = _package.version;
         }
         // Enable session local storage for Sync
-        this.options.Sync = this.options.Sync || {};
-        if (typeof this.options.Sync.enableSessionStorage === "undefined") {
-            this.options.Sync.enableSessionStorage = true;
+        this._options.Sync = this._options.Sync || {};
+        if (typeof this._options.Sync.enableSessionStorage === "undefined") {
+            this._options.Sync.enableSessionStorage = true;
         }
-        if (this.options.region) {
-            this.options.Sync.region = this.options.region;
+        if (this._options.region) {
+            this._options.Sync.region = this._options.region;
         }
         if (!fpaToken) {
             throw new Error("A valid Twilio token should be provided");
         }
-        this.services = new ClientServices();
-        this._myself = new user.User("", "", null, this.services);
-        const startTwilsock = !this.options.twilsockClient;
+        this._services = new ClientServices();
+        this._myself = new user.User("", "", null, this._services);
+        const startTwilsock = !this._options.twilsockClient;
         // Create default init registrations if none were provided.
         // Otherwise, the outside party have to list all the init registrations they
         // need.
         // Init registrations passed to the Conversations client will be passed down
         // to the Sync client as well.
-        if (!this.options.initRegistrations) {
+        if (!this._options.initRegistrations) {
             const initRegistration = new twilsock.InitRegistration(productId);
             Client_1.populateInitRegistrations(initRegistration);
-            this.options.initRegistrations = [initRegistration];
+            this._options.initRegistrations = [initRegistration];
         }
-        this.services.twilsockClient = this.options.twilsockClient =
-            (_b = this.options.twilsockClient) !== null && _b !== void 0 ? _b : new twilsock.TwilsockClient(fpaToken, productId, this.options);
-        this.services.twilsockClient.on("tokenAboutToExpire", (ttl) => this.emit("tokenAboutToExpire", ttl));
-        this.services.twilsockClient.on("tokenExpired", () => this.emit("tokenExpired"));
-        this.services.twilsockClient.on("connectionError", (error) => this.emit("connectionError", error));
-        this.services.twilsockClient.on("stateChanged", (state) => {
-            log.debug(`Handling stateChanged for ConversationsClient: new state ${state}`);
+        this._services.twilsockClient = this._options.twilsockClient =
+            (_b = this._options.twilsockClient) !== null && _b !== void 0 ? _b : new twilsock.TwilsockClient(fpaToken, productId, this._options);
+        this._services.twilsockClient.on("tokenAboutToExpire", (ttl) => this.emit("tokenAboutToExpire", ttl));
+        this._services.twilsockClient.on("tokenExpired", () => this.emit("tokenExpired"));
+        this._services.twilsockClient.on("connectionError", (error) => this.emit("connectionError", error));
+        this._services.twilsockClient.on("stateChanged", (state) => {
+            Client_1._logger.debug(`Handling stateChanged for ConversationsClient: new state ${state}`);
             if (state !== this.connectionState) {
                 this.connectionState = state;
                 this.emit("connectionStateChanged", this.connectionState);
             }
         });
-        this.services.transport = this.options.transport = ((_c = this.options
-            .transport) !== null && _c !== void 0 ? _c : this.options.twilsockClient);
-        this.services.notificationClient = this.options.notificationsClient =
-            (_d = this.options.notificationsClient) !== null && _d !== void 0 ? _d : new notifications.Notifications(fpaToken, this.options);
-        this.services.syncClient = this.options.syncClient =
-            (_e = this.options.syncClient) !== null && _e !== void 0 ? _e : new twilioSync.SyncClient(fpaToken, this.options);
+        this._services.transport = this._options.transport = ((_c = this._options
+            .transport) !== null && _c !== void 0 ? _c : this._options.twilsockClient);
+        this._services.notificationClient = this._options.notificationsClient =
+            (_d = this._options.notificationsClient) !== null && _d !== void 0 ? _d : new notifications.Notifications(fpaToken, this._options);
+        this._services.syncClient = this._options.syncClient =
+            (_e = this._options.syncClient) !== null && _e !== void 0 ? _e : new twilioSync.SyncClient(fpaToken, this._options);
         const configurationOptions = (options === null || options === void 0 ? void 0 : options.Chat) || (options === null || options === void 0 ? void 0 : options.IPMessaging) || options || {};
         const region = configurationOptions.region || (options === null || options === void 0 ? void 0 : options.region);
         const baseUrl = configurationOptions.apiUri ||
             configurationOptions.typingUri ||
             `https://aim.${region || "us1"}.twilio.com`;
-        this.services.commandExecutor = new commandExecutor.CommandExecutor(baseUrl, { transport: this.options.transport }, productId);
-        const emitFailed = (err) => {
-            this._rejectEnsureReady(err);
-            this.emit("stateChanged", "failed");
+        this._services.commandExecutor = new commandExecutor.CommandExecutor(baseUrl, { transport: this._options.transport }, productId);
+        const emitFailed = (error) => {
+            this._rejectEnsureReady(error);
+            this.emit("stateChanged", { state: "failed", error });
         };
-        this.services.twilsockClient.once("connectionError", emitFailed);
-        this.services.twilsockClient.once("disconnected", emitFailed);
-        // ConversationsClient will be able to initialize only after twilsock is connected
-        this.services.twilsockClient.once("connected", async () => {
-            log.debug(`ConversationsClient started INITIALIZING`);
-            this.services.twilsockClient.off("connectionError", emitFailed);
-            this.services.twilsockClient.off("disconnected", emitFailed);
+        this._services.twilsockClient.once("connectionError", emitFailed);
+        this._services.twilsockClient.once("disconnected", emitFailed);
+        // The client will be able to initialize only after Twilsock is connected
+        this._services.twilsockClient.once("connected", async () => {
+            Client_1._logger.debug(`ConversationsClient started INITIALIZING`);
+            this._services.twilsockClient.off("connectionError", emitFailed);
+            this._services.twilsockClient.off("disconnected", emitFailed);
             try {
                 const startupEvent = "conversations.client.startup";
-                this.services.twilsockClient.addPartialTelemetryEvent(new twilsock.TelemetryEventDescription(startupEvent, "Conversations client startup", new Date()), startupEvent, twilsock.TelemetryPoint.Start);
+                this._services.twilsockClient.addPartialTelemetryEvent(new twilsock.TelemetryEventDescription(startupEvent, "Conversations client startup", new Date()), startupEvent, twilsock.TelemetryPoint.Start);
                 await this._initialize();
-                this.services.twilsockClient.addPartialTelemetryEvent(new twilsock.TelemetryEventDescription("", "", new Date()), startupEvent, twilsock.TelemetryPoint.End);
+                this._services.twilsockClient.addPartialTelemetryEvent(new twilsock.TelemetryEventDescription("", "", new Date()), startupEvent, twilsock.TelemetryPoint.End);
             }
             catch (err) {
                 // Fail ChatClient if initialization is incomplete
                 this._rejectEnsureReady(err);
-                this.emit("stateChanged", "failed");
+                this.emit("stateChanged", { state: "failed", error: err });
             }
         });
         this._ensureReady = new Promise((resolve, reject) => {
@@ -277,12 +283,28 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
             this._rejectEnsureReady = reject;
         }).catch(() => void 0); // @todo How to process unhandled rejection here?
         if (startTwilsock) {
-            this.services.twilsockClient.connect();
+            this._services.twilsockClient.connect();
         }
     }
-    static populateInitRegistrations(reg) {
-        reg.populateInitRegistrations([notificationTypes.NotificationTypes.TYPING_INDICATOR]);
-        twilioSync.SyncClient.populateInitRegistrations(reg);
+    /**
+     * Information of the logged-in user. Before client initialization, returns an
+     * uninitialized user. Will trigger a {@link Client.userUpdated} event after
+     * initialization.
+     */
+    get user() {
+        return this._myself;
+    }
+    /**
+     * Client reachability state. Throws an error if accessed before the client
+     * initialization was completed.
+     */
+    get reachabilityEnabled() {
+        if (!this._configuration) {
+            throw new Error("Reachability information could not yet be accessed as the client " +
+                "has not yet been initialized. Subscribe to the 'stateChanged' event " +
+                "to properly react to the client initialization.");
+        }
+        return this._configuration.reachabilityEnabled;
     }
     /**
      * @deprecated Call constructor directly.
@@ -320,109 +342,104 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         return client;
     }
     /**
-     * Information of the logged-in user. Before client initialization, returns an
-     * uninitialized user. Will trigger a {@link Client.userUpdated} event after
-     * initialization.
+     * Static method for push notification payload parsing. Returns parsed push as
+     * a {@link PushNotification} object.
+     * @param notificationPayload Push notification payload.
      */
-    get user() {
-        return this._myself;
+    static parsePushNotification(notificationPayload) {
+        Client_1._logger.debug("parsePushNotification, notificationPayload=", notificationPayload);
+        // APNS specifics
+        if (typeof notificationPayload.aps !== "undefined") {
+            if (!notificationPayload.twi_message_type) {
+                throw new Error("Provided push notification payload does not contain Programmable Chat push notification type");
+            }
+            const data = Client_1._parsePushNotificationChatData(notificationPayload);
+            const apsPayload = notificationPayload.aps;
+            let body;
+            let title = null;
+            if (typeof apsPayload.alert === "string") {
+                body = apsPayload.alert || null;
+            }
+            else {
+                body = apsPayload.alert.body || null;
+                title = apsPayload.alert.title || null;
+            }
+            return new pushNotification.PushNotification({
+                title,
+                body,
+                sound: apsPayload.sound || null,
+                badge: apsPayload.badge || null,
+                action: apsPayload.category || null,
+                type: notificationPayload.twi_message_type,
+                data: data,
+            });
+        }
+        // FCM specifics
+        if (typeof notificationPayload.data !== "undefined") {
+            const dataPayload = notificationPayload.data;
+            if (!dataPayload.twi_message_type) {
+                throw new Error("Provided push notification payload does not contain Programmable Chat push notification type");
+            }
+            const data = Client_1._parsePushNotificationChatData(notificationPayload.data);
+            return new pushNotification.PushNotification({
+                title: dataPayload.twi_title || null,
+                body: dataPayload.twi_body || null,
+                sound: dataPayload.twi_sound || null,
+                badge: null,
+                action: dataPayload.twi_action || null,
+                type: dataPayload.twi_message_type,
+                data: data,
+            });
+        }
+        throw new Error("Provided push notification payload is not Programmable Chat notification");
     }
     /**
-     * Client reachability state. Throws if accessed before the client
-     * initialization was completed.
+     * Static method for parsing push notification chat data.
+     * @param data Data to parse
      */
-    get reachabilityEnabled() {
-        if (!this.configuration) {
-            throw new Error("Reachability information could not yet be accessed as the client " +
-                "has not yet been initialized. Subscribe to the 'stateChanged' event " +
-                "to properly react to the client initialization.");
+    static _parsePushNotificationChatData(data) {
+        const result = {};
+        for (const key in Client_1._supportedPushDataFields) {
+            const value = data[key];
+            if (typeof value === "undefined" || value === null) {
+                continue;
+            }
+            if (key === "message_index" || key === "media_count") {
+                const number = index.parseToNumber(value);
+                if (number !== null) {
+                    result[Client_1._supportedPushDataFields[key]] = number;
+                }
+                continue;
+            }
+            if (key === "media") {
+                if (typeof value === "string") {
+                    try {
+                        result[Client_1._supportedPushDataFields[key]] = JSON.parse(value);
+                    }
+                    catch (_a) {
+                        Client_1._logger.debug("Media message notification parsing error");
+                    }
+                }
+                continue;
+            }
+            result[Client_1._supportedPushDataFields[key]] = value;
         }
-        return this.configuration.reachabilityEnabled;
-    }
-    get token() {
-        return this.fpaToken;
-    }
-    _subscribeToPushNotifications(channelType) {
-        [
-            notificationTypes.NotificationTypes.NEW_MESSAGE,
-            notificationTypes.NotificationTypes.ADDED_TO_CONVERSATION,
-            notificationTypes.NotificationTypes.REMOVED_FROM_CONVERSATION,
-            notificationTypes.NotificationTypes.TYPING_INDICATOR,
-            notificationTypes.NotificationTypes.CONSUMPTION_UPDATE,
-        ].forEach((messageType) => {
-            this.services.notificationClient.subscribe(channelType, messageType);
-        });
-    }
-    _unsubscribeFromPushNotifications(channelType) {
-        [
-            notificationTypes.NotificationTypes.NEW_MESSAGE,
-            notificationTypes.NotificationTypes.ADDED_TO_CONVERSATION,
-            notificationTypes.NotificationTypes.REMOVED_FROM_CONVERSATION,
-            notificationTypes.NotificationTypes.TYPING_INDICATOR,
-            notificationTypes.NotificationTypes.CONSUMPTION_UPDATE,
-        ].forEach((messageType) => {
-            this.services.notificationClient.unsubscribe(channelType, messageType);
-        });
+        return result;
     }
-    async _initialize() {
-        const configurationResponse = await this.services.commandExecutor.fetchResource("Client/v2/Configuration");
-        this.configuration = new configuration.Configuration(this.options, configurationResponse, log);
-        this._myself._resolveInitialization(this.configuration, this.configuration.userIdentity, this.configuration.userInfo, true);
-        this.services.typingIndicator = new typingIndicator.TypingIndicator(this.getConversationBySid.bind(this), this.configuration, this.services);
-        this.services.network = new network.Network(this.configuration, this.services);
-        this.services.users = new users.Users(this._myself, this.configuration, this.services);
-        this.services.users.on("userSubscribed", (user) => {
-            this.emit("userSubscribed", user);
-        });
-        this.services.users.on("userUpdated", (args) => this.emit("userUpdated", args));
-        this.services.users.on("userUnsubscribed", (user) => {
-            this.emit("userUnsubscribed", user);
-        });
-        this.conversations = new conversations.Conversations(this.configuration, this.services);
-        this.conversations.on("conversationAdded", (conversation) => {
-            this.emit("conversationAdded", conversation);
-        });
-        this.conversations.on("conversationRemoved", (conversation) => {
-            this.emit("conversationRemoved", conversation);
-        });
-        this.conversations.on("conversationJoined", (conversation) => {
-            this.emit("conversationJoined", conversation);
-        });
-        this.conversations.on("conversationLeft", (conversation) => {
-            this.emit("conversationLeft", conversation);
-        });
-        this.conversations.on("conversationUpdated", (args) => this.emit("conversationUpdated", args));
-        this.conversations.on("participantJoined", (participant) => {
-            this.emit("participantJoined", participant);
-        });
-        this.conversations.on("participantLeft", (participant) => {
-            this.emit("participantLeft", participant);
-        });
-        this.conversations.on("participantUpdated", (args) => this.emit("participantUpdated", args));
-        this.conversations.on("messageAdded", (message) => this.emit("messageAdded", message));
-        this.conversations.on("messageUpdated", (args) => this.emit("messageUpdated", args));
-        this.conversations.on("messageRemoved", (message) => this.emit("messageRemoved", message));
-        this.conversations.on("typingStarted", (participant) => this.emit("typingStarted", participant));
-        this.conversations.on("typingEnded", (participant) => this.emit("typingEnded", participant));
-        this.conversationsPromise = this.conversations
-            .fetchConversations()
-            .then(() => this.conversations)
-            .catch((error) => {
-            throw error;
-        });
-        await this.services.users.myself._ensureFetched();
-        Client_1.supportedPushChannels.forEach((channelType) => this._subscribeToPushNotifications(channelType));
-        this.services.typingIndicator.initialize();
-        this.services.mcsClient = new mcsClient.McsClient(this.fpaToken, this.configuration.links.mediaService, this.configuration.links.mediaSetService, Object.assign(Object.assign({}, this.options), { transport: undefined }));
-        this._resolveEnsureReady();
-        this.emit("stateChanged", "initialized");
+    /**
+     * Populate the client with init registrations.
+     * @param reg The init registration to populate.
+     */
+    static populateInitRegistrations(reg) {
+        reg.populateInitRegistrations([notificationTypes.NotificationTypes.TYPING_INDICATOR]);
+        twilioSync.SyncClient.populateInitRegistrations(reg);
     }
     /**
      * Gracefully shut down the client.
      */
     async shutdown() {
         await this._ensureReady;
-        await this.services.twilsockClient.disconnect();
+        await this._services.twilsockClient.disconnect();
     }
     /**
      * Update the token used by the client and re-register with the Conversations services.
@@ -430,14 +447,14 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
      */
     async updateToken(token) {
         await this._ensureReady;
-        log.info("updateToken");
-        if (this.fpaToken === token) {
+        Client_1._logger.info("updateToken");
+        if (this._fpaToken === token) {
             return this;
         }
-        await this.services.twilsockClient.updateToken(token);
-        await this.services.notificationClient.updateToken(token);
-        await this.services.mcsClient.updateToken(token);
-        this.fpaToken = token;
+        await this._services.twilsockClient.updateToken(token);
+        await this._services.notificationClient.updateToken(token);
+        await this._services.mcsClient.updateToken(token);
+        this._fpaToken = token;
         return this;
     }
     /**
@@ -446,11 +463,21 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
      */
     async getConversationBySid(conversationSid) {
         await this._ensureReady;
-        await this.conversations.myConversationsRead.promise;
-        let conversation = await this.conversations.getConversation(conversationSid);
+        await this._conversations.myConversationsRead.promise;
+        const conversation = await this._conversations.getConversation(conversationSid);
         if (!conversation) {
-            conversation = await this.conversations.peekConversation(conversationSid);
+            throw new Error(`Conversation with SID ${conversationSid} is not found.`);
         }
+        return conversation;
+    }
+    /**
+     * Peek a conversation by its SID.
+     * @param conversationSid Conversation sid
+     * @internal
+     */
+    async peekConversationBySid(conversationSid) {
+        await this._ensureReady;
+        const conversation = await this._conversations.peekConversation(conversationSid);
         if (!conversation) {
             throw new Error(`Conversation with SID ${conversationSid} is not found.`);
         }
@@ -462,8 +489,8 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
      */
     async getConversationByUniqueName(uniqueName) {
         await this._ensureReady;
-        await this.conversations.myConversationsRead.promise;
-        const conversation = await this.conversations.getConversationByUniqueName(uniqueName);
+        await this._conversations.myConversationsRead.promise;
+        const conversation = await this._conversations.getConversationByUniqueName(uniqueName);
         if (!conversation) {
             throw new Error(`Conversation with unique name ${uniqueName} is not found.`);
         }
@@ -474,7 +501,7 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
      */
     async getSubscribedConversations() {
         await this._ensureReady;
-        return this.conversationsPromise.then((conversations) => conversations.getConversations());
+        return this._conversationsPromise.then((conversations) => conversations.getConversations());
     }
     /**
      * Create a conversation on the server and subscribe to its events.
@@ -484,18 +511,19 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
     async createConversation(options) {
         await this._ensureReady;
         options = options || {};
-        return this.conversationsPromise.then((conversationsEntity) => conversationsEntity.addConversation(options));
+        return this._conversationsPromise.then((conversationsEntity) => conversationsEntity.addConversation(options));
     }
     /**
      * Register for push notifications.
      * @param channelType Channel type.
-     * @param registrationId Push notification ID provided by the FCM/APNS service on the platform.
+     * @param registrationId Push notification ID provided by the FCM/APNS service
+     * on the platform.
      */
     async setPushRegistrationId(channelType, registrationId) {
         await this._ensureReady;
         this._subscribeToPushNotifications(channelType);
-        this.services.notificationClient.setPushRegistrationId(channelType, registrationId);
-        await this.services.notificationClient.commitChanges(); // Committing before this point is useless because we have no push id
+        this._services.notificationClient.setPushRegistrationId(channelType, registrationId);
+        await this._services.notificationClient.commitChanges(); // Committing before this point is useless because we have no push id
     }
     /**
      * Unregister from push notifications.
@@ -505,132 +533,180 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
     async unsetPushRegistrationId(channelType) {
         await this._ensureReady;
         this._unsubscribeFromPushNotifications(channelType);
-        await this.services.notificationClient.commitChanges();
+        await this._services.notificationClient.commitChanges();
     }
     /**
      * Clear existing registrations directly using provided device token.
      * This is useful to ensure stopped subscriptions without resubscribing.
      *
-     * This function goes completely beside the state machine and removes all registrations.
-     * Use with caution: if it races with current state machine operations, madness will ensue.
+     * This function goes completely beside the state machine and removes all
+     * registrations.
+     * Use with caution: if it races with current state machine operations,
+     * madness will ensue.
      *
      * @param channelType Channel type.
-     * @param registrationId Push notification ID provided by the FCM/APNS service on the platform.
+     * @param registrationId Push notification ID provided by the FCM/APNS service
+     * on the platform.
      */
     async removePushRegistrations(channelType, registrationId) {
         // do not await this._ensureReady() here - it could be called at any moment
-        await this.services.notificationClient.removeRegistrations(channelType, registrationId);
-    }
-    static parsePushNotificationChatData(data) {
-        const result = {};
-        for (const key in Client_1.supportedPushDataFields) {
-            if (typeof data[key] === "undefined" || data[key] === null) {
-                continue;
-            }
-            if (key !== "message_index") {
-                result[Client_1.supportedPushDataFields[key]] = data[key];
-                continue;
-            }
-            if (index.parseToNumber(data[key]) !== null) {
-                result[Client_1.supportedPushDataFields[key]] = Number(data[key]);
-            }
-        }
-        return result;
+        await this._services.notificationClient.removeRegistrations(channelType, registrationId);
     }
     /**
-     * Static method for push notification payload parsing. Returns parsed push as a {@link PushNotification} object.
-     * @param notificationPayload Push notification payload.
-     */
-    static parsePushNotification(notificationPayload) {
-        log.debug("parsePushNotification, notificationPayload=", notificationPayload);
-        // APNS specifics
-        if (typeof notificationPayload.aps !== "undefined") {
-            if (!notificationPayload.twi_message_type) {
-                throw new Error("Provided push notification payload does not contain Programmable Chat push notification type");
-            }
-            const data = Client_1.parsePushNotificationChatData(notificationPayload);
-            const apsPayload = notificationPayload.aps;
-            let body;
-            let title = null;
-            if (typeof apsPayload.alert === "string") {
-                body = apsPayload.alert || null;
-            }
-            else {
-                body = apsPayload.alert.body || null;
-                title = apsPayload.alert.title || null;
-            }
-            return new pushNotification.PushNotification({
-                title,
-                body,
-                sound: apsPayload.sound || null,
-                badge: apsPayload.badge || null,
-                action: apsPayload.category || null,
-                type: notificationPayload.twi_message_type,
-                data: data,
-            });
-        }
-        // FCM specifics
-        if (typeof notificationPayload.data !== "undefined") {
-            const dataPayload = notificationPayload.data;
-            if (!dataPayload.twi_message_type) {
-                throw new Error("Provided push notification payload does not contain Programmable Chat push notification type");
-            }
-            const data = Client_1.parsePushNotificationChatData(notificationPayload.data);
-            return new pushNotification.PushNotification({
-                title: dataPayload.twi_title || null,
-                body: dataPayload.twi_body || null,
-                sound: dataPayload.twi_sound || null,
-                badge: null,
-                action: dataPayload.twi_action || null,
-                type: dataPayload.twi_message_type,
-                data: data,
-            });
-        }
-        throw new Error("Provided push notification payload is not Programmable Chat notification");
-    }
-    /**
-     * Handle push notification payload parsing and emit the {@link Client.pushNotification} event on this {@link Client} instance.
+     * Handle push notification payload parsing and emit the
+     * {@link Client.pushNotification} event on this {@link Client} instance.
      * @param notificationPayload Push notification payload
      */
     async handlePushNotification(notificationPayload) {
         await this._ensureReady;
-        log.debug("handlePushNotification, notificationPayload=", notificationPayload);
+        Client_1._logger.debug("handlePushNotification, notificationPayload=", notificationPayload);
         this.emit("pushNotification", Client_1.parsePushNotification(notificationPayload));
     }
     /**
-     * Gets a user with the given identity. If it's in the subscribed list, then return the user object from it;
+     * Gets a user with the given identity. If it's in the subscribed list, then
+     * return the user object from it;
      * if not, then subscribe and add user to the subscribed list.
      * @param identity Identity of the user.
      * @returns A fully initialized user.
      */
     async getUser(identity) {
         await this._ensureReady;
-        return this.services.users.getUser(identity);
+        return this._services.users.getUser(identity);
     }
     /**
      * Get a list of subscribed user objects.
      */
     async getSubscribedUsers() {
         await this._ensureReady;
-        return this.services.users.getSubscribedUsers();
+        return this._services.users.getSubscribedUsers();
+    }
+    /**
+     * Get content URLs for all media attachments in the given set of media sids
+     * using a single operation.
+     * @param mediaSids Set of media sids to query for the content URL.
+     */
+    getTemporaryContentUrlsForMediaSids(mediaSids) {
+        return new mcsClient.CancellablePromise(async (resolve, reject, onCancel) => {
+            if (!this._services.mcsClient || !mediaSids) {
+                reject(new Error("Media Content Service is unavailable"));
+                return;
+            }
+            const request = this._services.mcsClient.mediaSetGetContentUrls(mediaSids);
+            onCancel(() => {
+                request.cancel();
+            });
+            try {
+                const urls = await request;
+                resolve(urls);
+            }
+            catch (e) {
+                reject(e);
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    getTemporaryContentUrlsForMedia(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.map((m) => m.sid);
+        return this.getTemporaryContentUrlsForMediaSids(sids);
+    }
+    /**
+     * Initialize the client.
+     */
+    async _initialize() {
+        const configurationResponse = await this._services.commandExecutor.fetchResource("Client/v2/Configuration");
+        this._configuration = new configuration.Configuration(this._options, configurationResponse, Client_1._logger);
+        this._myself._resolveInitialization(this._configuration, this._configuration.userIdentity, this._configuration.userInfo, true);
+        this._services.typingIndicator = new typingIndicator.TypingIndicator(this.getConversationBySid.bind(this), this._configuration, this._services);
+        this._services.network = new network.Network(this._configuration, this._services);
+        this._services.users = new users.Users(this._myself, this._configuration, this._services);
+        this._services.users.on("userSubscribed", (user) => {
+            this.emit("userSubscribed", user);
+        });
+        this._services.users.on("userUpdated", (args) => this.emit("userUpdated", args));
+        this._services.users.on("userUnsubscribed", (user) => {
+            this.emit("userUnsubscribed", user);
+        });
+        this._conversations = new conversations.Conversations(this._configuration, this._services);
+        this._conversations.on("conversationAdded", (conversation) => {
+            this.emit("conversationAdded", conversation);
+        });
+        this._conversations.on("conversationRemoved", (conversation) => {
+            this.emit("conversationRemoved", conversation);
+        });
+        this._conversations.on("conversationJoined", (conversation) => {
+            this.emit("conversationJoined", conversation);
+        });
+        this._conversations.on("conversationLeft", (conversation) => {
+            this.emit("conversationLeft", conversation);
+        });
+        this._conversations.on("conversationUpdated", (args) => this.emit("conversationUpdated", args));
+        this._conversations.on("participantJoined", (participant) => {
+            this.emit("participantJoined", participant);
+        });
+        this._conversations.on("participantLeft", (participant) => {
+            this.emit("participantLeft", participant);
+        });
+        this._conversations.on("participantUpdated", (args) => this.emit("participantUpdated", args));
+        this._conversations.on("messageAdded", (message) => this.emit("messageAdded", message));
+        this._conversations.on("messageUpdated", (args) => this.emit("messageUpdated", args));
+        this._conversations.on("messageRemoved", (message) => this.emit("messageRemoved", message));
+        this._conversations.on("typingStarted", (participant) => this.emit("typingStarted", participant));
+        this._conversations.on("typingEnded", (participant) => this.emit("typingEnded", participant));
+        this._conversationsPromise = this._conversations
+            .fetchConversations()
+            .then(() => this._conversations)
+            .catch((error) => {
+            throw error;
+        });
+        await this._services.users.myself._ensureFetched();
+        Client_1._supportedPushChannels.forEach((channelType) => this._subscribeToPushNotifications(channelType));
+        this._services.typingIndicator.initialize();
+        this._services.mcsClient = new mcsClient.McsClient(this._fpaToken, this._configuration.links.mediaService, this._configuration.links.mediaSetService, Object.assign(Object.assign({}, this._options), { transport: undefined }));
+        this._resolveEnsureReady();
+        this.emit("stateChanged", { state: "initialized" });
+    }
+    /**
+     * Subscribe to push notifications.
+     * @param channelType The channel type to subscribe to.
+     */
+    _subscribeToPushNotifications(channelType) {
+        [
+            notificationTypes.NotificationTypes.NEW_MESSAGE,
+            notificationTypes.NotificationTypes.ADDED_TO_CONVERSATION,
+            notificationTypes.NotificationTypes.REMOVED_FROM_CONVERSATION,
+            notificationTypes.NotificationTypes.TYPING_INDICATOR,
+            notificationTypes.NotificationTypes.CONSUMPTION_UPDATE,
+        ].forEach((messageType) => {
+            this._services.notificationClient.subscribe(channelType, messageType);
+        });
+    }
+    /**
+     * Unsubscribe from push notifications.
+     * @param channelType The channel type to unsubscribe from.
+     */
+    _unsubscribeFromPushNotifications(channelType) {
+        [
+            notificationTypes.NotificationTypes.NEW_MESSAGE,
+            notificationTypes.NotificationTypes.ADDED_TO_CONVERSATION,
+            notificationTypes.NotificationTypes.REMOVED_FROM_CONVERSATION,
+            notificationTypes.NotificationTypes.TYPING_INDICATOR,
+            notificationTypes.NotificationTypes.CONSUMPTION_UPDATE,
+        ].forEach((messageType) => {
+            this._services.notificationClient.unsubscribe(channelType, messageType);
+        });
     }
 };
 /**
- * Current version of the Conversations client.
- */
-exports.Client.version = SDK_VERSION;
-exports.Client.supportedPushChannels = [
-    "fcm",
-    "apn",
-];
-exports.Client.supportedPushDataFields = {
-    conversation_sid: "conversationSid",
-    message_sid: "messageSid",
-    message_index: "messageIndex",
-};
-/**
- * Fired when a conversation becomes visible to the client. The event is also triggered when the client creates a new conversation.
- * Fired for all conversations client has joined.
+ * Fired when a conversation becomes visible to the client. The event is also
+ * triggered when the client creates a new conversation.
+ * Fired for all conversations that the client has joined.
  *
  * Parameters:
  * 1. {@link Conversation} `conversation` - the conversation in question
@@ -662,14 +738,17 @@ exports.Client.conversationLeft = "conversationLeft";
  */
 exports.Client.conversationRemoved = "conversationRemoved";
 /**
- * Fired when the attributes or the metadata of a conversation have been updated.
- * During conversation's creation and initialization, this event might be fired multiple times
- * for same joined or created conversation as new data is arriving from different sources.
+ * Fired when the attributes or the metadata of a conversation have been
+ * updated. During conversation's creation and initialization, this event
+ * might be fired multiple times for same joined or created conversation as
+ * new data is arriving from different sources.
  *
  * Parameters:
- * 1. object `data` - info object provided with the event. It has the following properties:
+ * 1. object `data` - info object provided with the event. It has the
+ * following properties:
  *     * {@link Conversation} `conversation` - the conversation in question
- *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons for the update
+ *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons
+ *     for the update
  * @event
  */
 exports.Client.conversationUpdated = "conversationUpdated";
@@ -693,9 +772,11 @@ exports.Client.participantLeft = "participantLeft";
  * Fired when a participant's fields have been updated.
  *
  * Parameters:
- * 1. object `data` - info object provided with the event. It has the following properties:
+ * 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
+ *     * {@link ParticipantUpdateReason}[] `updateReasons` - array of reasons
+ *     for the update
  * @event
  */
 exports.Client.participantUpdated = "participantUpdated";
@@ -719,9 +800,11 @@ exports.Client.messageRemoved = "messageRemoved";
  * Fired when the fields of an existing message are updated with new values.
  *
  * Parameters:
- * 1. object `data` - info object provided with the event. It has the following properties:
+ * 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
+ *     * {@link MessageUpdateReason}[] `updateReasons` - array of reasons for
+ *     the update
  * @event
  */
 exports.Client.messageUpdated = "messageUpdated";
@@ -754,10 +837,12 @@ exports.Client.typingEnded = "typingEnded";
  */
 exports.Client.typingStarted = "typingStarted";
 /**
- * Fired when the client has received (and parsed) a push notification via one of the push channels (apn or fcm).
+ * Fired when the client has received (and parsed) a push notification via one
+ * of the push channels (apn or fcm).
  *
  * Parameters:
- * 1. {@link PushNotification} `pushNotification` - the push notification in question
+ * 1. {@link PushNotification} `pushNotification` - the push notification in
+ * question
  * @event
  */
 exports.Client.pushNotification = "pushNotification";
@@ -778,12 +863,15 @@ exports.Client.userSubscribed = "userSubscribed";
  */
 exports.Client.userUnsubscribed = "userUnsubscribed";
 /**
- * Fired when the properties or the reachability status of a user have been updated.
+ * Fired when the properties or the reachability status of a user have been
+ * updated.
  *
  * Parameters:
- * 1. object `data` - info object provided with the event. It has the following properties:
+ * 1. object `data` - info object provided with the event. It has the
+ * following properties:
  *     * {@link User} `user` - the user in question
- *     * {@link UserUpdateReason}[] `updateReasons` - array of reasons for the update
+ *     * {@link UserUpdateReason}[] `updateReasons` - array of reasons for the
+ *     update
  * @event
  */
 exports.Client.userUpdated = "userUpdated";
@@ -791,14 +879,17 @@ exports.Client.userUpdated = "userUpdated";
  * Fired when the state of the client has been changed.
  *
  * Parameters:
- * 1. {@link State} `state` - the new client state
+ * 1. object `data` - info object provided with the event. It has the
+ * following properties:
+ *     * {@link State} `state` - the new client state
+ *     * Error? `error` - the initialization error if present
  * @event
  */
 exports.Client.stateChanged = "stateChanged";
 /**
  * Fired when the connection state of the client has been changed.
  *
- * Paremeters:
+ * Parameters:
  * 1. {@link ConnectionState} `state` - the new connection state
  * @event
  */
@@ -807,7 +898,8 @@ exports.Client.connectionStateChanged = "connectionStateChanged";
  * Fired when the connection is interrupted for an unexpected reason.
  *
  * Parameters:
- * 1. object `data` - info object provided with the event. It has the following properties:
+ * 1. object `data` - info object provided with the event. It has the
+ * following properties:
  *     * boolean `terminal` - Twilsock will stop connection attempts if true
  *     * string `message` - the error message of the root cause
  *     * number? `httpStatusCode` - http status code if available
@@ -815,6 +907,32 @@ exports.Client.connectionStateChanged = "connectionStateChanged";
  * @event
  */
 exports.Client.connectionError = "connectionError";
+/**
+ * Current version of the Conversations client.
+ */
+exports.Client.version = _package.version;
+/**
+ * Logger instance.
+ */
+exports.Client._logger = logger.Logger.scope("Client");
+/**
+ * Supported push notification channels.
+ */
+exports.Client._supportedPushChannels = [
+    "fcm",
+    "apn",
+];
+/**
+ * Supported push data fields.
+ */
+exports.Client._supportedPushDataFields = {
+    conversation_sid: "conversationSid",
+    conversation_title: "conversationTitle",
+    message_sid: "messageSid",
+    message_index: "messageIndex",
+    media_count: "mediaCount",
+    media: "media", // object
+};
 tslib_es6.__decorate([
     declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString),
     tslib_es6.__metadata("design:type", Function),
@@ -827,6 +945,12 @@ tslib_es6.__decorate([
     tslib_es6.__metadata("design:paramtypes", [String]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], exports.Client.prototype, "getConversationBySid", null);
+tslib_es6.__decorate([
+    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString),
+    tslib_es6.__metadata("design:type", Function),
+    tslib_es6.__metadata("design:paramtypes", [String]),
+    tslib_es6.__metadata("design:returntype", Promise)
+], exports.Client.prototype, "peekConversationBySid", null);
 tslib_es6.__decorate([
     declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString),
     tslib_es6.__metadata("design:type", Function),