@twilio/conversations 3.0.0-rc.1 → 3.0.0-rc.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/CHANGELOG.md +57 -0
  2. package/README.md +7 -3
  3. package/builds/browser.js +1643 -1410
  4. package/builds/browser.js.map +1 -1
  5. package/builds/lib.d.ts +270 -182
  6. package/builds/lib.js +1643 -1410
  7. package/builds/lib.js.map +1 -1
  8. package/builds/twilio-conversations.js +3719 -4034
  9. package/builds/twilio-conversations.min.js +1 -16
  10. package/dist/aggregated-delivery-receipt.js.map +1 -1
  11. package/dist/client.js +53 -35
  12. package/dist/client.js.map +1 -1
  13. package/dist/command-executor.js.map +1 -1
  14. package/dist/configuration.js.map +1 -1
  15. package/dist/conversation.js +405 -376
  16. package/dist/conversation.js.map +1 -1
  17. package/dist/data/conversations.js +10 -11
  18. package/dist/data/conversations.js.map +1 -1
  19. package/dist/data/messages.js +9 -9
  20. package/dist/data/messages.js.map +1 -1
  21. package/dist/data/participants.js +19 -10
  22. package/dist/data/participants.js.map +1 -1
  23. package/dist/data/users.js +2 -2
  24. package/dist/data/users.js.map +1 -1
  25. package/dist/detailed-delivery-receipt.js.map +1 -1
  26. package/dist/index.js +6 -4
  27. package/dist/index.js.map +1 -1
  28. package/dist/interfaces/attributes.js.map +1 -1
  29. package/dist/interfaces/notification-types.js.map +1 -1
  30. package/dist/logger.js +2 -4
  31. package/dist/logger.js.map +1 -1
  32. package/dist/media.js.map +1 -1
  33. package/dist/message-builder.js.map +1 -1
  34. package/dist/message.js +16 -12
  35. package/dist/message.js.map +1 -1
  36. package/dist/node_modules/tslib/tslib.es6.js +1 -1
  37. package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
  38. package/dist/packages/conversations/package.json.js +1 -1
  39. package/dist/participant.js +2 -2
  40. package/dist/participant.js.map +1 -1
  41. package/dist/push-notification.js.map +1 -1
  42. package/dist/rest-paginator.js.map +1 -1
  43. package/dist/services/network.js.map +1 -1
  44. package/dist/services/typing-indicator.js +1 -1
  45. package/dist/services/typing-indicator.js.map +1 -1
  46. package/dist/unsent-message.js.map +1 -1
  47. package/dist/user.js +1 -1
  48. package/dist/user.js.map +1 -1
  49. package/dist/util/deferred.js.map +1 -1
  50. package/dist/util/index.js.map +1 -1
  51. package/docs/assets/js/search.js +1 -1
  52. package/docs/classes/CancellablePromise.html +3213 -0
  53. package/docs/classes/Client.html +4 -10
  54. package/docs/classes/Conversation.html +80 -51
  55. package/docs/classes/Media.html +2 -2
  56. package/docs/classes/Message.html +6 -6
  57. package/docs/classes/MessageBuilder.html +2 -2
  58. package/docs/classes/PushNotification.html +1 -1
  59. package/docs/classes/UnsentMessage.html +2 -2
  60. package/docs/index.html +20 -25
  61. package/docs/interfaces/ConversationState.html +2 -2
  62. package/docs/interfaces/ConversationUpdatedEventArgs.html +3001 -0
  63. package/docs/interfaces/PushNotificationData.html +48 -0
  64. package/docs/modules.html +19 -24
  65. package/package.json +21 -19
package/docs/index.html CHANGED
@@ -2703,6 +2703,9 @@ img {
2703
2703
  <li class=" tsd-kind-class">
2704
2704
  <a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2705
2705
  </li>
2706
+ <li class=" tsd-kind-class tsd-has-type-parameter">
2707
+ <a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a>
2708
+ </li>
2706
2709
  <li class=" tsd-kind-class">
2707
2710
  <a href="classes/Client.html" class="tsd-kind-icon">Client</a>
2708
2711
  </li>
@@ -2751,6 +2754,9 @@ img {
2751
2754
  <li class=" tsd-kind-interface">
2752
2755
  <a href="interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2753
2756
  </li>
2757
+ <li class=" tsd-kind-interface">
2758
+ <a href="interfaces/ConversationUpdatedEventArgs.html" class="tsd-kind-icon">Conversation<wbr>Updated<wbr>Event<wbr>Args</a>
2759
+ </li>
2754
2760
  <li class=" tsd-kind-interface">
2755
2761
  <a href="interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a>
2756
2762
  </li>
@@ -2823,9 +2829,6 @@ img {
2823
2829
  <li class=" tsd-kind-type-alias">
2824
2830
  <a href="modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a>
2825
2831
  </li>
2826
- <li class=" tsd-kind-type-alias">
2827
- <a href="modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2828
- </li>
2829
2832
  <li class=" tsd-kind-type-alias">
2830
2833
  <a href="modules.html#State" class="tsd-kind-icon">State</a>
2831
2834
  </li>
@@ -2857,10 +2860,14 @@ img {
2857
2860
  <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2858
2861
  <span style="color: #008000">// Before you use the client, subscribe to the `'stateChanged'` event and wait </span>
2859
2862
  <span style="color: #008000">// for the `'initialized'` state to be reported.</span>
2860
- <span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, (</span><span style="color: #001080">state</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
2863
+ <span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
2861
2864
  <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">'initialized'</span><span style="color: #000000">) {</span>
2862
2865
  <span style="color: #000000"> </span><span style="color: #008000">// Use the client</span>
2863
2866
  <span style="color: #000000"> }</span>
2867
+ <span style="color: #000000"> </span>
2868
+ <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">error</span><span style="color: #000000">) {</span>
2869
+ <span style="color: #000000"> </span><span style="color: #008000">// Handle error</span>
2870
+ <span style="color: #000000"> }</span>
2864
2871
  <span style="color: #000000">}</span>
2865
2872
  </code></pre>
2866
2873
  <p>The SDK could also be imported using the ES module syntax:</p>
@@ -2879,7 +2886,7 @@ img {
2879
2886
  </a>
2880
2887
  <p>Releases of <code>twilio-conversations.js</code> are hosted on a CDN, and you can include these
2881
2888
  directly in your web app using a <code>&lt;script&gt;</code> tag.</p>
2882
- <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/v2.0/twilio-conversations.min.js"</span><span style="color: #800000">&gt;&lt;/script&gt;</span>
2889
+ <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/v3.0.0/twilio-conversations.min.js"</span><span style="color: #800000">&gt;&lt;/script&gt;</span>
2883
2890
  </code></pre>
2884
2891
  <p>Using this method, <code>twilio-conversations.js</code> will set a browser global <code>Twilio.Conversations</code> through which you can use the client:</p>
2885
2892
  <pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #001080">Twilio</span><span style="color: #000000">.</span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
@@ -2892,13 +2899,13 @@ img {
2892
2899
  <p>If you require more security you will have to consume SDK by using <a href="https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity">SRI</a> and using an exact version
2893
2900
  number. While less flexible it is significantly more secure, which is required by some applications.</p>
2894
2901
  <p>To consume securely use the following script snippet format:</p>
2895
- <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.1/twilio-conversations.min.js"</span>
2902
+ <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/releases/3.0.0/twilio-conversations.min.js"</span>
2896
2903
  <span style="color: #000000FF"> </span><span style="color: #FF0000">integrity</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"sha256-&lt;HASH FROM THE CHANGELOGS PAGE&gt;"</span>
2897
2904
  <span style="color: #000000FF"> </span><span style="color: #FF0000">crossorigin</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"anonymous"</span><span style="color: #800000">&gt;&lt;/script&gt;</span>
2898
2905
  </code></pre>
2899
2906
  <p>Find the hash of each release published on the <a href="#Changelog">Changelog</a> page.</p>
2900
2907
  <a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
2901
- <h2>Supported Browsers</h2><table><thead><tr><th>Browser</th><th>Supported Versions</th></tr></thead><tbody><tr><td>Chrome for Android</td><td>94</td></tr><tr><td>Firefox for Android</td><td>92</td></tr><tr><td>UC Browser for Android</td><td>12.12</td></tr><tr><td>Chrome</td><td>94, 93, 92</td></tr><tr><td>Edge</td><td>94, 93, 92</td></tr><tr><td>Firefox</td><td>93, 92, 91</td></tr><tr><td>Internet Explorer</td><td>11</td></tr><tr><td>Safari for iOS</td><td>15, 14.5-14.8</td></tr><tr><td>Safari</td><td>15, 14.1, 14</td></tr><tr><td>Samsung Internet</td><td>15.0, 14.0</td></tr></tbody></table><h3>Changelog</h3>
2908
+ <h2>Supported Browsers</h2><table><thead><tr><th>Browser</th><th>Supported Versions</th></tr></thead><tbody><tr><td>Chrome for Android</td><td>99</td></tr><tr><td>Firefox for Android</td><td>96</td></tr><tr><td>UC Browser for Android</td><td>12.12</td></tr><tr><td>Chrome</td><td>99, 98, 97</td></tr><tr><td>Edge</td><td>99, 98, 97</td></tr><tr><td>Firefox</td><td>98, 97, 96</td></tr><tr><td>Internet Explorer</td><td>11</td></tr><tr><td>Safari for iOS</td><td>15.4, 15.2-15.3</td></tr><tr><td>Safari</td><td>15.4, 15.2-15.3, 15.1</td></tr><tr><td>Samsung Internet</td><td>16.0, 15.0</td></tr></tbody></table><h3>Changelog</h3>
2902
2909
  </a>
2903
2910
  <p>See this <a href="https://www.twilio.com/docs/conversations/javascript/changelog">link</a>.</p>
2904
2911
  </div>
@@ -2911,6 +2918,7 @@ img {
2911
2918
  <h3>Classes</h3>
2912
2919
  <ul class="tsd-index-list">
2913
2920
  <li class="tsd-kind-class"><a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a></li>
2921
+ <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a></li>
2914
2922
  <li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li>
2915
2923
  <li class="tsd-kind-class"><a href="classes/Conversation.html" class="tsd-kind-icon">Conversation</a></li>
2916
2924
  <li class="tsd-kind-class"><a href="classes/DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a></li>
@@ -2932,6 +2940,7 @@ img {
2932
2940
  <li class="tsd-kind-interface"><a href="interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a></li>
2933
2941
  <li class="tsd-kind-interface"><a href="interfaces/ConversationLimits.html" class="tsd-kind-icon">Conversation<wbr>Limits</a></li>
2934
2942
  <li class="tsd-kind-interface"><a href="interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a></li>
2943
+ <li class="tsd-kind-interface"><a href="interfaces/ConversationUpdatedEventArgs.html" class="tsd-kind-icon">Conversation<wbr>Updated<wbr>Event<wbr>Args</a></li>
2935
2944
  <li class="tsd-kind-interface"><a href="interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a></li>
2936
2945
  <li class="tsd-kind-interface"><a href="interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a></li>
2937
2946
  <li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a></li>
@@ -2961,7 +2970,6 @@ img {
2961
2970
  <li class="tsd-kind-type-alias"><a href="modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a></li>
2962
2971
  <li class="tsd-kind-type-alias"><a href="modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a></li>
2963
2972
  <li class="tsd-kind-type-alias"><a href="modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a></li>
2964
- <li class="tsd-kind-type-alias"><a href="modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a></li>
2965
2973
  <li class="tsd-kind-type-alias"><a href="modules.html#State" class="tsd-kind-icon">State</a></li>
2966
2974
  <li class="tsd-kind-type-alias"><a href="modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a></li>
2967
2975
  </ul>
@@ -3000,9 +3008,8 @@ img {
3000
3008
  </aside>
3001
3009
  <div class="tsd-comment tsd-typography">
3002
3010
  <div class="lead">
3003
- <p>The status of the conversation, relative to the client: whether
3004
- the conversation has been <code>joined</code> or the client is
3005
- <code>notParticipating</code> in the conversation.</p>
3011
+ <p>Status of the conversation, relative to the client: whether the conversation
3012
+ has been <code>joined</code> or the client is <code>notParticipating</code> in the conversation.</p>
3006
3013
  </div>
3007
3014
  </div>
3008
3015
  </section>
@@ -3014,7 +3021,7 @@ img {
3014
3021
  </aside>
3015
3022
  <div class="tsd-comment tsd-typography">
3016
3023
  <div class="lead">
3017
- <p>The reason for the <code>updated</code> event being emitted by a conversation.</p>
3024
+ <p>Reason for the <code>updated</code> event emission by a conversation.</p>
3018
3025
  </div>
3019
3026
  </div>
3020
3027
  </section>
@@ -3135,7 +3142,7 @@ img {
3135
3142
  </aside>
3136
3143
  <div class="tsd-comment tsd-typography">
3137
3144
  <div class="lead">
3138
- <p>The user's notification level for the conversation. Determines
3145
+ <p>User's notification level for the conversation. Determines
3139
3146
  whether the currently logged-in user will receive pushes for events
3140
3147
  in this conversation. Can be either <code>muted</code> or <code>default</code>, where
3141
3148
  <code>default</code> defers to the global service push configuration.</p>
@@ -3196,18 +3203,6 @@ img {
3196
3203
  </div>
3197
3204
  </div>
3198
3205
  </section>
3199
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
3200
- <a name="PushNotificationType" class="tsd-anchor"></a>
3201
- <h3>Push<wbr>Notification<wbr>Type</h3>
3202
- <div class="tsd-signature tsd-kind-icon">Push<wbr>Notification<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"twilio.conversations.new_message"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"twilio.conversations.added_to_conversation"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"twilio.conversations.removed_from_conversation"</span></div>
3203
- <aside class="tsd-sources">
3204
- </aside>
3205
- <div class="tsd-comment tsd-typography">
3206
- <div class="lead">
3207
- <p>Push notification type.</p>
3208
- </div>
3209
- </div>
3210
- </section>
3211
3206
  <section class="tsd-panel tsd-member tsd-kind-type-alias">
3212
3207
  <a name="State" class="tsd-anchor"></a>
3213
3208
  <h3>State</h3>
package/docs/interfaces/ConversationState.html CHANGED
@@ -2720,7 +2720,7 @@ img {
2720
2720
  <section class="tsd-panel tsd-comment">
2721
2721
  <div class="tsd-comment tsd-typography">
2722
2722
  <div class="lead">
2723
- <p>The state of the conversation.</p>
2723
+ <p>State of the conversation.</p>
2724
2724
  </div>
2725
2725
  </div>
2726
2726
  </section>
@@ -2756,7 +2756,7 @@ img {
2756
2756
  </aside>
2757
2757
  <div class="tsd-comment tsd-typography">
2758
2758
  <div class="lead">
2759
- <p>The current state.</p>
2759
+ <p>Current state.</p>
2760
2760
  </div>
2761
2761
  </div>
2762
2762
  </section>