@twilio/conversations 2.0.0-rc.1 → 2.0.1-canary.1

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

@@ -0,0 +1,227 @@
+/*
+@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';
+
+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
+ * 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
+ * delivery from the upstream carrier, and, where available, the destination handset.
+ * * Message considered as **undelivered** to a participant if Twilio has received a delivery receipt
+ * indicating that the message was not delivered. This can happen for many reasons including carrier content
+ * filtering and the availability of the destination handset.
+ * * Message considered as **read** by a participant if the message has been delivered and opened by the
+ * recipient in a conversation. The recipient must have enabled the read receipts.
+ * * Message considered as **failed** to be delivered to a participant if the message could not be sent.
+ * This can happen for various reasons including queue overflows, account suspensions and media
+ * errors (in the case of MMS for instance).
+ *
+ * {@link AggregatedDeliveryReceipt} class contains an aggregated value {@link DeliveryAmount} for each delivery status.
+ */
+class AggregatedDeliveryReceipt {
+    /**
+     * @internal
+     */
+    constructor(data) {
+        this.state = data;
+    }
+    /**
+     * Maximum number of delivery events expected for the message.
+     */
+    get total() {
+        return this.state.total;
+    }
+    /**
+     * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.
+     *
+     * @return Amount of participants that have the **sent** delivery status for the message.
+     */
+    get sent() {
+        return this.state.sent;
+    }
+    /**
+     * Message is considered as **delivered** to a participant if Twilio has received confirmation of message
+     * delivery from the upstream carrier, and, where available, the destination handset.
+     *
+     * @return Amount of participants that have the **delivered** delivery status for the message.
+     */
+    get delivered() {
+        return this.state.delivered;
+    }
+    /**
+     * Message is considered as **read** by a participant, if the message has been delivered and opened by the
+     * recipient in a conversation. The recipient must have enabled the read receipts.
+     *
+     * @return Amount of participants that have the **read** delivery status for the message.
+     */
+    get read() {
+        return this.state.read;
+    }
+    /**
+     * Message is considered as **undelivered** to a participant if Twilio has received a delivery receipt
+     * indicating that the message was not delivered. This can happen for many reasons including carrier content
+     * filtering and the availability of the destination handset.
+     *
+     * @return Ammount of participants that have the **undelivered** delivery status for the message.
+     */
+    get undelivered() {
+        return this.state.undelivered;
+    }
+    /**
+     * Message is considered as **failed** to be delivered to a participant if the message could not be sent.
+     * This can happen for various reasons including queue overflows, account suspensions and media
+     * errors (in the case of MMS for instance). Twilio does not charge you for failed messages.
+     *
+     * @return Amount of participants that have the **failed** delivery status for the message.
+     */
+    get failed() {
+        return this.state.failed;
+    }
+    _update(data) {
+        this.state = data;
+    }
+    _isEquals(data) {
+        const isTotalSame = this.total === data.total;
+        const isSentSame = this.sent === data.sent;
+        const isDeliveredSame = this.delivered === data.delivered;
+        const isReadSame = this.read === data.read;
+        const isUndeliveredSame = this.undelivered === data.undelivered;
+        const isFailedSame = this.failed === data.failed;
+        return isTotalSame && isSentSame && isDeliveredSame && isReadSame && isUndeliveredSame && isFailedSame;
+    }
+}
+
+exports.AggregatedDeliveryReceipt = AggregatedDeliveryReceipt;
+//# sourceMappingURL=aggregated-delivery-receipt.js.map

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

@@ -0,0 +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\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 isTotalSame && isSentSame && isDeliveredSame && isReadSame && isUndeliveredSame && isFailedSame;\n  }\n}\n\nexport {\n  AggregatedDeliveryReceipt,\n  AggregatedDeliveryDescriptor,\n  DeliveryAmount,\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA;;;;;;;;;;;;;;;;;;;;AAoBA,MAAM,yBAAyB;;;;IAO7B,YAAY,IAAkC;QAC5C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;;;;IAKD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;KACzB;;;;;;IAOD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACxB;;;;;;;IAQD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;KAC7B;;;;;;;IAQD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACxB;;;;;;;;IASD,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;KAC/B;;;;;;;;IASD,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;KAC1B;IAED,OAAO,CAAC,IAAkC;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;IAED,SAAS,CAAC,IAAkC;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;QAEjD,OAAO,WAAW,IAAI,UAAU,IAAI,eAAe,IAAI,UAAU,IAAI,iBAAiB,IAAI,YAAY,CAAC;KACxG;;;;;"}