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

package/dist/aggregated-delivery-receipt.js

@@ -128,13 +128,22 @@ This software includes platform.js under the following license.
 */
 'use strict';
 
+var global =
+  typeof global !== "undefined"
+    ? global
+    : typeof self !== "undefined"
+    ? self
+    : typeof window !== "undefined"
+    ? window
+    : {};
+
 Object.defineProperty(exports, '__esModule', { value: true });
 
 /**
  * Contains aggregated information about delivery statuses of a message across all participants
  * of a conversation.
  *
- * At any moment during the message delivery to a participant, the message can have zero or more of following
+ * At any moment during the message delivery to a participant, the message can have zero or more of the following
  * delivery statuses:
  * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.
  * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message

package/dist/aggregated-delivery-receipt.js.map

@@ -1 +1 @@
-{"version":3,"file":"aggregated-delivery-receipt.js","sources":["../src/aggregated-delivery-receipt.ts"],"sourcesContent":["/**\n * Signifies the amount of participants which have the status for the message.\n */\ntype DeliveryAmount = \"none\" | \"some\" | \"all\";\n\ninterface AggregatedDeliveryDescriptor {\n  total: number;\n  delivered: DeliveryAmount;\n  failed: DeliveryAmount;\n  read: DeliveryAmount;\n  sent: DeliveryAmount;\n  undelivered: DeliveryAmount;\n}\n\n/**\n * Contains aggregated information about delivery statuses of a message across all participants\n * of a conversation.\n *\n * At any moment during the message delivery to a participant, the message can have zero or more of following\n * delivery statuses:\n * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.\n * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message\n * delivery from the upstream carrier, and, where available, the destination handset.\n * * Message considered as **undelivered** to a participant if Twilio has received a delivery receipt\n * indicating that the message was not delivered. This can happen for many reasons including carrier content\n * filtering and the availability of the destination handset.\n * * Message considered as **read** by a participant if the message has been delivered and opened by the\n * recipient in a conversation. The recipient must have enabled the read receipts.\n * * Message considered as **failed** to be delivered to a participant if the message could not be sent.\n * This can happen for various reasons including queue overflows, account suspensions and media\n * errors (in the case of MMS for instance).\n *\n * {@link AggregatedDeliveryReceipt} class contains an aggregated value {@link DeliveryAmount} for each delivery status.\n */\nclass AggregatedDeliveryReceipt {\n  private state: AggregatedDeliveryDescriptor;\n\n  /**\n   * @internal\n   */\n  constructor(data: AggregatedDeliveryDescriptor) {\n    this.state = data;\n  }\n\n  /**\n   * Maximum number of delivery events expected for the message.\n   */\n  public get total(): number {\n    return this.state.total;\n  }\n\n  /**\n   * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.\n   *\n   * @return Amount of participants that have the **sent** delivery status for the message.\n   */\n  public get sent(): DeliveryAmount {\n    return this.state.sent;\n  }\n\n  /**\n   * Message is considered as **delivered** to a participant if Twilio has received confirmation of message\n   * delivery from the upstream carrier, and, where available, the destination handset.\n   *\n   * @return Amount of participants that have the **delivered** delivery status for the message.\n   */\n  public get delivered(): DeliveryAmount {\n    return this.state.delivered;\n  }\n\n  /**\n   * Message is considered as **read** by a participant, if the message has been delivered and opened by the\n   * recipient in a conversation. The recipient must have enabled the read receipts.\n   *\n   * @return Amount of participants that have the **read** delivery status for the message.\n   */\n  public get read(): DeliveryAmount {\n    return this.state.read;\n  }\n\n  /**\n   * Message is considered as **undelivered** to a participant if Twilio has received a delivery receipt\n   * indicating that the message was not delivered. This can happen for many reasons including carrier content\n   * filtering and the availability of the destination handset.\n   *\n   * @return Ammount of participants that have the **undelivered** delivery status for the message.\n   */\n  public get undelivered(): DeliveryAmount {\n    return this.state.undelivered;\n  }\n\n  /**\n   * Message is considered as **failed** to be delivered to a participant if the message could not be sent.\n   * This can happen for various reasons including queue overflows, account suspensions and media\n   * errors (in the case of MMS for instance). Twilio does not charge you for failed messages.\n   *\n   * @return Amount of participants that have the **failed** delivery status for the message.\n   */\n  public get failed(): DeliveryAmount {\n    return this.state.failed;\n  }\n\n  _update(data: AggregatedDeliveryDescriptor): void {\n    this.state = data;\n  }\n\n  _isEquals(data: AggregatedDeliveryDescriptor): boolean {\n    const isTotalSame = this.total === data.total;\n    const isSentSame = this.sent === data.sent;\n    const isDeliveredSame = this.delivered === data.delivered;\n    const isReadSame = this.read === data.read;\n    const isUndeliveredSame = this.undelivered === data.undelivered;\n    const isFailedSame = this.failed === data.failed;\n\n    return (\n      isTotalSame &&\n      isSentSame &&\n      isDeliveredSame &&\n      isReadSame &&\n      isUndeliveredSame &&\n      isFailedSame\n    );\n  }\n}\n\nexport {\n  AggregatedDeliveryReceipt,\n  AggregatedDeliveryDescriptor,\n  DeliveryAmount,\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA;;;;;;;;;;;;;;;;;;;AAmBG;AACH,MAAM,yBAAyB,CAAA;AAG7B;;AAEG;AACH,IAAA,WAAA,CAAY,IAAkC,EAAA;AAC5C,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;AAED;;AAEG;AACH,IAAA,IAAW,KAAK,GAAA;AACd,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;KACzB;AAED;;;;AAIG;AACH,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACxB;AAED;;;;;AAKG;AACH,IAAA,IAAW,SAAS,GAAA;AAClB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;KAC7B;AAED;;;;;AAKG;AACH,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACxB;AAED;;;;;;AAMG;AACH,IAAA,IAAW,WAAW,GAAA;AACpB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;KAC/B;AAED;;;;;;AAMG;AACH,IAAA,IAAW,MAAM,GAAA;AACf,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;KAC1B;AAED,IAAA,OAAO,CAAC,IAAkC,EAAA;AACxC,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;AAED,IAAA,SAAS,CAAC,IAAkC,EAAA;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC;QAC3C,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC;QAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC;QAC3C,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW,CAAC;QAChE,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC;AAEjD,QAAA,QACE,WAAW;YACX,UAAU;YACV,eAAe;YACf,UAAU;YACV,iBAAiB;AACjB,YAAA,YAAY,EACZ;KACH;AACF;;;;"}
+{"version":3,"file":"aggregated-delivery-receipt.js","sources":["../src/aggregated-delivery-receipt.ts"],"sourcesContent":["/**\n * Signifies the amount of participants which have the status for the message.\n */\ntype DeliveryAmount = \"none\" | \"some\" | \"all\";\n\ninterface AggregatedDeliveryDescriptor {\n  total: number;\n  delivered: DeliveryAmount;\n  failed: DeliveryAmount;\n  read: DeliveryAmount;\n  sent: DeliveryAmount;\n  undelivered: DeliveryAmount;\n}\n\n/**\n * Contains aggregated information about delivery statuses of a message across all participants\n * of a conversation.\n *\n * At any moment during the message delivery to a participant, the message can have zero or more of the following\n * delivery statuses:\n * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.\n * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message\n * delivery from the upstream carrier, and, where available, the destination handset.\n * * Message considered as **undelivered** to a participant if Twilio has received a delivery receipt\n * indicating that the message was not delivered. This can happen for many reasons including carrier content\n * filtering and the availability of the destination handset.\n * * Message considered as **read** by a participant if the message has been delivered and opened by the\n * recipient in a conversation. The recipient must have enabled the read receipts.\n * * Message considered as **failed** to be delivered to a participant if the message could not be sent.\n * This can happen for various reasons including queue overflows, account suspensions and media\n * errors (in the case of MMS for instance).\n *\n * {@link AggregatedDeliveryReceipt} class contains an aggregated value {@link DeliveryAmount} for each delivery status.\n */\nclass AggregatedDeliveryReceipt {\n  private state: AggregatedDeliveryDescriptor;\n\n  /**\n   * @internal\n   */\n  constructor(data: AggregatedDeliveryDescriptor) {\n    this.state = data;\n  }\n\n  /**\n   * Maximum number of delivery events expected for the message.\n   */\n  public get total(): number {\n    return this.state.total;\n  }\n\n  /**\n   * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.\n   *\n   * @return Amount of participants that have the **sent** delivery status for the message.\n   */\n  public get sent(): DeliveryAmount {\n    return this.state.sent;\n  }\n\n  /**\n   * Message is considered as **delivered** to a participant if Twilio has received confirmation of message\n   * delivery from the upstream carrier, and, where available, the destination handset.\n   *\n   * @return Amount of participants that have the **delivered** delivery status for the message.\n   */\n  public get delivered(): DeliveryAmount {\n    return this.state.delivered;\n  }\n\n  /**\n   * Message is considered as **read** by a participant, if the message has been delivered and opened by the\n   * recipient in a conversation. The recipient must have enabled the read receipts.\n   *\n   * @return Amount of participants that have the **read** delivery status for the message.\n   */\n  public get read(): DeliveryAmount {\n    return this.state.read;\n  }\n\n  /**\n   * Message is considered as **undelivered** to a participant if Twilio has received a delivery receipt\n   * indicating that the message was not delivered. This can happen for many reasons including carrier content\n   * filtering and the availability of the destination handset.\n   *\n   * @return Ammount of participants that have the **undelivered** delivery status for the message.\n   */\n  public get undelivered(): DeliveryAmount {\n    return this.state.undelivered;\n  }\n\n  /**\n   * Message is considered as **failed** to be delivered to a participant if the message could not be sent.\n   * This can happen for various reasons including queue overflows, account suspensions and media\n   * errors (in the case of MMS for instance). Twilio does not charge you for failed messages.\n   *\n   * @return Amount of participants that have the **failed** delivery status for the message.\n   */\n  public get failed(): DeliveryAmount {\n    return this.state.failed;\n  }\n\n  _update(data: AggregatedDeliveryDescriptor): void {\n    this.state = data;\n  }\n\n  _isEquals(data: AggregatedDeliveryDescriptor): boolean {\n    const isTotalSame = this.total === data.total;\n    const isSentSame = this.sent === data.sent;\n    const isDeliveredSame = this.delivered === data.delivered;\n    const isReadSame = this.read === data.read;\n    const isUndeliveredSame = this.undelivered === data.undelivered;\n    const isFailedSame = this.failed === data.failed;\n\n    return (\n      isTotalSame &&\n      isSentSame &&\n      isDeliveredSame &&\n      isReadSame &&\n      isUndeliveredSame &&\n      isFailedSame\n    );\n  }\n}\n\nexport {\n  AggregatedDeliveryReceipt,\n  AggregatedDeliveryDescriptor,\n  DeliveryAmount,\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA;;;;;;;;;;;;;;;;;;;AAmBG;AACH,MAAM,yBAAyB,CAAA;AAG7B;;AAEG;AACH,IAAA,WAAA,CAAY,IAAkC,EAAA;AAC5C,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;AAED;;AAEG;AACH,IAAA,IAAW,KAAK,GAAA;AACd,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;KACzB;AAED;;;;AAIG;AACH,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACxB;AAED;;;;;AAKG;AACH,IAAA,IAAW,SAAS,GAAA;AAClB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;KAC7B;AAED;;;;;AAKG;AACH,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACxB;AAED;;;;;;AAMG;AACH,IAAA,IAAW,WAAW,GAAA;AACpB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;KAC/B;AAED;;;;;;AAMG;AACH,IAAA,IAAW,MAAM,GAAA;AACf,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;KAC1B;AAED,IAAA,OAAO,CAAC,IAAkC,EAAA;AACxC,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;AAED,IAAA,SAAS,CAAC,IAAkC,EAAA;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC;QAC3C,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC;QAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC;QAC3C,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW,CAAC;QAChE,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC;AAEjD,QAAA,QACE,WAAW;YACX,UAAU;YACV,eAAe;YACf,UAAU;YACV,iBAAiB;AACjB,YAAA,YAAY,EACZ;KACH;AACF;;;;"}

package/dist/channel-metadata-client.js

@@ -0,0 +1,192 @@
+/*
+@license
+The following license applies to all parts of this software except as
+documented below.
+
+    Copyright (c) 2019, Twilio, inc.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are
+    met:
+
+      1. Redistributions of source code must retain the above copyright
+         notice, this list of conditions and the following disclaimer.
+
+      2. Redistributions in binary form must reproduce the above copyright
+         notice, this list of conditions and the following disclaimer in
+         the documentation and/or other materials provided with the
+         distribution.
+
+      3. Neither the name of Twilio nor the names of its contributors may
+         be used to endorse or promote products derived from this software
+         without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+This software includes javascript-state-machine under the following license.
+
+    Copyright (c) 2012, 2013, 2014, 2015, Jake Gordon and contributors
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+
+This software includes loglevel under the following license.
+
+    Copyright (c) 2013 Tim Perry
+
+    Permission is hereby granted, free of charge, to any person
+    obtaining a copy of this software and associated documentation
+    files (the "Software"), to deal in the Software without
+    restriction, including without limitation the rights to use,
+    copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following
+    conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+    OTHER DEALINGS IN THE SOFTWARE.
+
+This software includes q under the following license.
+
+    Copyright 2009–2014 Kristopher Michael Kowal. All rights reserved.
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to
+    deal in the Software without restriction, including without limitation the
+    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+    sell copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+    IN THE SOFTWARE.
+
+This software includes platform.js under the following license.
+
+    Copyright 2014 Benjamin Tan <https://d10.github.io/>
+    Copyright 2011-2015 John-David Dalton <http://allyoucanleet.com/>
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+'use strict';
+
+var global =
+  typeof global !== "undefined"
+    ? global
+    : typeof self !== "undefined"
+    ? self
+    : typeof window !== "undefined"
+    ? window
+    : {};
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var commandExecutor = require('./command-executor.js');
+var index = require('./node_modules/quick-lru/index.js');
+
+/**
+ * Represents channel metadata.
+ */
+class ChannelMetadata {
+    /**
+     * @internal
+     */
+    constructor(type, data) {
+        this.type = type;
+        this.data = data;
+        Object.freeze(data);
+    }
+}
+class ChannelMetadataClient {
+    constructor(services, configuration) {
+        this._services = services;
+        this._configuration = configuration;
+        this._cache = new index["default"]({
+            maxSize: configuration.channelMetadataCacheCapacity,
+        });
+    }
+    async getChannelMetadata(conversationSid, messageSid) {
+        const key = `${conversationSid},${messageSid}`;
+        const cachedItem = this._cache.get(key);
+        if (cachedItem) {
+            return cachedItem.item;
+        }
+        const url = `${this._configuration.links.conversations}/${conversationSid}/Messages/${messageSid}/ChannelMetadata`;
+        let metadataResponse;
+        try {
+            metadataResponse = await this._services.commandExecutor.fetchResource(url);
+        }
+        catch (e) {
+            if (e instanceof commandExecutor.ChannelMetadataNotFoundError) {
+                this._cache.set(key, { item: null });
+                return null;
+            }
+            throw e;
+        }
+        const metadata = new ChannelMetadata(metadataResponse.type, metadataResponse.data);
+        this._cache.set(key, { item: metadata });
+        return metadata;
+    }
+}
+
+exports.ChannelMetadata = ChannelMetadata;
+exports.ChannelMetadataClient = ChannelMetadataClient;
+//# sourceMappingURL=channel-metadata-client.js.map

package/dist/channel-metadata-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-metadata-client.js","sources":["../src/channel-metadata-client.ts"],"sourcesContent":["import {\n  ChannelMetadataNotFoundError,\n  CommandExecutor,\n} from \"./command-executor\";\nimport { ChannelMetadataResponse } from \"./interfaces/commands/channel-metadata-response\";\nimport QuickLRU from \"quick-lru\";\nimport { Configuration } from \"./configuration\";\n\ntype ChannelMetadataClientServices = {\n  commandExecutor: CommandExecutor;\n};\n\ntype CacheEntry = {\n  item: ChannelMetadata | null;\n};\n\n/**\n * Represents channel metadata.\n */\nclass ChannelMetadata {\n  /**\n   * Communication channel type.\n   */\n  public readonly type: string;\n\n  /**\n   * The actual metadata.\n   */\n  public readonly data: unknown;\n\n  /**\n   * @internal\n   */\n  public constructor(type: string, data: unknown) {\n    this.type = type;\n    this.data = data;\n\n    Object.freeze(data);\n  }\n}\n\nclass ChannelMetadataClient {\n  private readonly _services: ChannelMetadataClientServices;\n  private readonly _configuration: Configuration;\n  private readonly _cache: QuickLRU<string, CacheEntry>;\n\n  public constructor(\n    services: ChannelMetadataClientServices,\n    configuration: Configuration\n  ) {\n    this._services = services;\n    this._configuration = configuration;\n    this._cache = new QuickLRU({\n      maxSize: configuration.channelMetadataCacheCapacity,\n    });\n  }\n\n  public async getChannelMetadata(\n    conversationSid: string,\n    messageSid: string\n  ): Promise<ChannelMetadata | null> {\n    const key = `${conversationSid},${messageSid}`;\n    const cachedItem = this._cache.get(key);\n\n    if (cachedItem) {\n      return cachedItem.item;\n    }\n\n    const url = `${this._configuration.links.conversations}/${conversationSid}/Messages/${messageSid}/ChannelMetadata`;\n    let metadataResponse: ChannelMetadataResponse;\n\n    try {\n      metadataResponse = await this._services.commandExecutor.fetchResource<\n        void,\n        ChannelMetadataResponse\n      >(url);\n    } catch (e) {\n      if (e instanceof ChannelMetadataNotFoundError) {\n        this._cache.set(key, { item: null });\n        return null;\n      }\n\n      throw e;\n    }\n\n    const metadata = new ChannelMetadata(\n      metadataResponse.type,\n      metadataResponse.data\n    );\n    this._cache.set(key, { item: metadata });\n    return metadata;\n  }\n}\n\nexport { ChannelMetadataClient, ChannelMetadata };\n"],"names":["QuickLRU","ChannelMetadataNotFoundError"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgBA;;AAEG;AACH,MAAM,eAAe,CAAA;AAWnB;;AAEG;IACH,WAAmB,CAAA,IAAY,EAAE,IAAa,EAAA;AAC5C,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACjB,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AAEjB,QAAA,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;KACrB;AACF,CAAA;AAED,MAAM,qBAAqB,CAAA;IAKzB,WACE,CAAA,QAAuC,EACvC,aAA4B,EAAA;AAE5B,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;AAC1B,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;AACpC,QAAA,IAAI,CAAC,MAAM,GAAG,IAAIA,gBAAQ,CAAC;YACzB,OAAO,EAAE,aAAa,CAAC,4BAA4B;AACpD,SAAA,CAAC,CAAC;KACJ;AAEM,IAAA,MAAM,kBAAkB,CAC7B,eAAuB,EACvB,UAAkB,EAAA;AAElB,QAAA,MAAM,GAAG,GAAG,CAAA,EAAG,eAAe,CAAI,CAAA,EAAA,UAAU,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAExC,QAAA,IAAI,UAAU,EAAE;YACd,OAAO,UAAU,CAAC,IAAI,CAAC;AACxB,SAAA;AAED,QAAA,MAAM,GAAG,GAAG,CAAG,EAAA,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,aAAa,CAAI,CAAA,EAAA,eAAe,CAAa,UAAA,EAAA,UAAU,kBAAkB,CAAC;AACnH,QAAA,IAAI,gBAAyC,CAAC;QAE9C,IAAI;AACF,YAAA,gBAAgB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,aAAa,CAGnE,GAAG,CAAC,CAAC;AACR,SAAA;AAAC,QAAA,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,YAAYC,4CAA4B,EAAE;AAC7C,gBAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AACrC,gBAAA,OAAO,IAAI,CAAC;AACb,aAAA;AAED,YAAA,MAAM,CAAC,CAAC;AACT,SAAA;AAED,QAAA,MAAM,QAAQ,GAAG,IAAI,eAAe,CAClC,gBAAgB,CAAC,IAAI,EACrB,gBAAgB,CAAC,IAAI,CACtB,CAAC;AACF,QAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACzC,QAAA,OAAO,QAAQ,CAAC;KACjB;AACF;;;;;"}

package/dist/client.js

@@ -128,6 +128,15 @@ This software includes platform.js under the following license.
 */
 'use strict';
 
+var global =
+  typeof global !== "undefined"
+    ? global
+    : typeof self !== "undefined"
+    ? self
+    : typeof window !== "undefined"
+    ? window
+    : {};
+
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var tslib_es6 = require('./node_modules/tslib/tslib.es6.js');
@@ -150,6 +159,8 @@ var _package = require('./packages/conversations/package.json.js');
 var commandExecutor = require('./command-executor.js');
 var replayEventEmitter = require('@twilio/replay-event-emitter');
 var media = require('./media.js');
+var contentClient = require('./content-client.js');
+var channelMetadataClient = require('./channel-metadata-client.js');
 
 var Client_1;
 /**
@@ -222,25 +233,31 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         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) {
-            const initRegistration = new twilsock.InitRegistration(productId);
-            Client_1.populateInitRegistrations(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);
+            (_b = this._options.twilsockClient) !== null && _b !== void 0 ? _b : 
+            // todo: remove any after the release of new Twilsock
+            new twilsock.TwilsockClient(fpaToken, productId, this._options);
+        this._services.twilsockClient.populateInitRegistrations(new Set([notificationTypes.NotificationTypes.TYPING_INDICATOR]));
         this._services.twilsockClient.on("tokenAboutToExpire", () => this.emit("tokenAboutToExpire"));
         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._services.twilsockClient.on("disconnected", () => {
+            Client_1._logger.debug(`Handling stateChanged for ConversationsClient: new state disconnected`);
+            if ("disconnected" !== this.connectionState) {
+                this.connectionState = "disconnected";
+                this.emit("connectionStateChanged", this.connectionState);
+            }
+        });
+        this._services.twilsockClient.on("connecting", () => {
+            Client_1._logger.debug(`Handling stateChanged for ConversationsClient: new state connecting`);
+            if ("connecting" !== this.connectionState) {
+                this.connectionState = "connecting";
+                this.emit("connectionStateChanged", this.connectionState);
+            }
+        });
+        this._services.twilsockClient.on("connected", () => {
+            Client_1._logger.debug(`Handling stateChanged for ConversationsClient: new state connected`);
+            if ("connected" !== this.connectionState) {
+                this.connectionState = "connected";
                 this.emit("connectionStateChanged", this.connectionState);
             }
         });
@@ -256,27 +273,20 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
             configurationOptions.typingUri ||
             `https://aim.${region || "us1"}.twilio.com`;
         this._services.commandExecutor = new commandExecutor.CommandExecutor(baseUrl, { transport: this._options.transport }, productId);
-        const emitFailed = (error) => {
-            this._rejectEnsureReady(error);
-            this.emit("stateChanged", { state: "failed", error });
-        };
-        const emitDisconnected = () => {
-            emitFailed({
+        this._services.contentClient = new contentClient.ContentClient(this._services);
+        const unsubscribeFatalError = this._services.twilsockClient.onceWithReplay("fatalError", (errorInfo) => {
+            const error = {
                 terminal: true,
-                message: "Twilsock has disconnected.",
-            });
-        };
-        this._services.twilsockClient.onceWithReplay("connectionError", emitFailed);
-        this._services.twilsockClient.onceWithReplay("disconnected", emitDisconnected);
+                message: errorInfo.description,
+            };
+            this._rejectEnsureReady(error);
+            this.emit("initFailed", { error });
+        });
         this._services.twilsockClient.onceWithReplay("connected", async () => {
             Client_1._logger.debug(`ConversationsClient started INITIALIZING`);
-            this._services.twilsockClient.off("connectionError", emitFailed);
-            this._services.twilsockClient.off("disconnected", emitDisconnected);
+            unsubscribeFatalError();
             try {
-                const startupEvent = "conversations.client.startup";
-                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);
             }
             catch (err) {
                 // Fail ChatClient if initialization is incomplete
@@ -285,13 +295,17 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
                     message: err.message,
                 };
                 this._rejectEnsureReady(connectionError);
-                this.emit("stateChanged", { state: "failed", error: connectionError });
+                this.emit("initFailed", {
+                    error: connectionError,
+                });
             }
         });
         this._ensureReady = new Promise((resolve, reject) => {
             this._resolveEnsureReady = resolve;
             this._rejectEnsureReady = reject;
-        }).catch(() => void 0); // @todo How to process unhandled rejection here?
+        }).catch((e) => {
+            Client_1._logger.error(e);
+        });
         if (startTwilsock) {
             this._services.twilsockClient.connect();
         }
@@ -311,46 +325,11 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
     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.");
+                "has not yet been initialized. Subscribe to 'initialized' and " +
+                "'initFailed' events to properly react to the client initialization.");
         }
         return this._configuration.reachabilityEnabled;
     }
-    /**
-     * @deprecated Call constructor directly.
-     *
-     * Factory method to create a Conversations client instance.
-     *
-     * The factory method will automatically trigger connection.
-     * Do not use it if you need finer-grained control.
-     *
-     * Since this method returns an already-initialized client, some of the events
-     * will be lost because they happen *before* the initialization. It is
-     * recommended that `client.onWithReplay` is used as opposed to `client.on`
-     * for subscribing to client events. The `client.onWithReplay` will re-emit
-     * the most recent value for a given event if it emitted before the
-     * subscription.
-     *
-     * @param token Access token.
-     * @param options Options to customize the client.
-     * @returns Returns a fully initialized client.
-     */
-    static async create(token, options) {
-        // The logic is as follows:
-        // - If twilsock is not passed in, then the ConversationsClient constructor will call twilsock.connect() by itself
-        //   and we do not need to do it here.
-        // - If twilsock was passed in from the outside, but customer called ConversationsClient.create() then they are
-        //   using an obsolete workflow and the startup sequence will never complete.
-        if (options === null || options === void 0 ? void 0 : options.twilsockClient) {
-            throw new Error("Obsolete usage of ConversationsClient.create() " +
-                "factory method: if you pass twilsock from the outside then you must " +
-                "use ConversationsClient constructor and be prepared to work with " +
-                "uninitialized client.");
-        }
-        const client = new Client_1(token, options);
-        await client._ensureReady;
-        return client;
-    }
     /**
      * Static method for push notification payload parsing. Returns parsed push as
      * a {@link PushNotification} object.
@@ -437,20 +416,13 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         }
         return result;
     }
-    /**
-     * 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() {
+        var _a;
         await this._ensureReady;
-        await this._services.twilsockClient.disconnect();
+        await ((_a = this._services.network) === null || _a === void 0 ? void 0 : _a.disconnect());
     }
     /**
      * Update the token used by the client and re-register with the Conversations services.
@@ -512,7 +484,8 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
      */
     async getSubscribedConversations() {
         await this._ensureReady;
-        return this._conversationsPromise.then((conversations) => conversations.getConversations());
+        const conversations = await this._conversationsPromise;
+        return await conversations.getConversations();
     }
     /**
      * Create a conversation on the server and subscribe to its events.
@@ -536,16 +509,6 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         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.
-     * @param channelType Channel type.
-     * @deprecated Use removePushRegistrations() instead.
-     */
-    async unsetPushRegistrationId(channelType) {
-        await this._ensureReady;
-        this._unsubscribeFromPushNotifications(channelType);
-        await this._services.notificationClient.commitChanges();
-    }
     /**
      * Clear existing registrations directly using provided device token.
      * This is useful to ensure stopped subscriptions without resubscribing.
@@ -627,12 +590,21 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         const sids = contentSet.map((m) => m.sid);
         return this.getTemporaryContentUrlsForMediaSids(sids);
     }
+    /**
+     * Returns rich content templates belonging to the account. Rich content
+     * templates can be created via the Twilio console or the REST API.
+     */
+    async getContentTemplates() {
+        await this._ensureReady;
+        return await this._services.contentClient.getContentTemplates();
+    }
     /**
      * 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._services.channelMetadataClient = new channelMetadataClient.ChannelMetadataClient(this._services, this._configuration);
         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);
@@ -674,6 +646,9 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
             .fetchConversations()
             .then(() => this._conversationsEntity)
             .catch((error) => {
+            if (error.message === "Client has been shut down.") {
+                return this._conversationsEntity;
+            }
             throw error;
         });
         await this._services.users.myself._ensureFetched();
@@ -681,7 +656,7 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
         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" });
+        this.emit("initialized");
     }
     /**
      * Subscribe to push notifications.
@@ -698,21 +673,6 @@ exports.Client = Client_1 = class Client extends replayEventEmitter.ReplayEventE
             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);
-        });
-    }
 };
 /**
  * Fired when a conversation becomes visible to the client. The event is also
@@ -885,16 +845,20 @@ exports.Client.userUnsubscribed = "userUnsubscribed";
  */
 exports.Client.userUpdated = "userUpdated";
 /**
- * Fired when the state of the client has been changed.
+ * Fired when the client has completed initialization successfully.
+ * @event
+ */
+exports.Client.initialized = "initialized";
+/**
+ * Fired when the client initialization failed.
  *
  * Parameters:
  * 1. object `data` - info object provided with the event. It has the
- * following properties:
- *     * {@link State} `state` - the new client state
+ * following property:
  *     * Error? `error` - the initialization error if present
  * @event
  */
-exports.Client.stateChanged = "stateChanged";
+exports.Client.initFailed = "initFailed";
 /**
  * Fired when the connection state of the client has been changed.
  *
@@ -985,12 +949,6 @@ tslib_es6.__decorate([
     tslib_es6.__metadata("design:paramtypes", [String, String]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], exports.Client.prototype, "setPushRegistrationId", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.literal("fcm", "apn")),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [String]),
-    tslib_es6.__metadata("design:returntype", Promise)
-], exports.Client.prototype, "unsetPushRegistrationId", null);
 tslib_es6.__decorate([
     declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.literal("fcm", "apn"), declarativeTypeValidator.nonEmptyString),
     tslib_es6.__metadata("design:type", Function),
@@ -1021,12 +979,6 @@ tslib_es6.__decorate([
     tslib_es6.__metadata("design:paramtypes", [Array]),
     tslib_es6.__metadata("design:returntype", mcsClient.CancellablePromise)
 ], exports.Client.prototype, "getTemporaryContentUrlsForMedia", null);
-tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync("string", ["undefined", declarativeTypeValidator.pureObject]),
-    tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [String, Object]),
-    tslib_es6.__metadata("design:returntype", Promise)
-], exports.Client, "create", null);
 tslib_es6.__decorate([
     declarativeTypeValidator.validateTypes(declarativeTypeValidator.pureObject),
     tslib_es6.__metadata("design:type", Function),