@twilio/conversations 2.4.0-rc.0 → 2.4.0-rc.1
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.
- package/README.md +17 -11
- package/builds/browser.js +19 -2
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +16 -3
- package/builds/lib.js +19 -2
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +19 -2
- package/builds/twilio-conversations.min.js +1 -1
- package/dist/channel-metadata-client.js +6 -0
- package/dist/channel-metadata-client.js.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/packages/conversations/package.json.js +1 -1
- package/dist/participant.js.map +1 -1
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/ChannelMetadata.html +3050 -0
- package/docs/classes/Message.html +3 -3
- package/docs/classes/Participant.html +2 -2
- package/docs/index.html +14 -7
- package/docs/modules.html +14 -7
- package/package.json +2 -2
|
@@ -3213,7 +3213,7 @@ img {
|
|
|
3213
3213
|
<a name="getChannelMetadata" class="tsd-anchor"></a>
|
|
3214
3214
|
<h3>get<wbr>Channel<wbr>Metadata</h3>
|
|
3215
3215
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
3216
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Channel<wbr>Metadata<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><
|
|
3216
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Channel<wbr>Metadata<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ChannelMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">ChannelMetadata</a><span class="tsd-signature-symbol">></span></li>
|
|
3217
3217
|
</ul>
|
|
3218
3218
|
<ul class="tsd-descriptions">
|
|
3219
3219
|
<li class="tsd-description">
|
|
@@ -3221,11 +3221,11 @@ img {
|
|
|
3221
3221
|
</aside>
|
|
3222
3222
|
<div class="tsd-comment tsd-typography">
|
|
3223
3223
|
<div class="lead">
|
|
3224
|
-
<p>Get the
|
|
3224
|
+
<p>Get the <a href="ChannelMetadata.html">ChannelMetadata</a> for this message. Resolves to <code>null</code> if
|
|
3225
3225
|
the message doesn't have any channel metadata.</p>
|
|
3226
3226
|
</div>
|
|
3227
3227
|
</div>
|
|
3228
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><
|
|
3228
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ChannelMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">ChannelMetadata</a><span class="tsd-signature-symbol">></span></h4>
|
|
3229
3229
|
</li>
|
|
3230
3230
|
</ul>
|
|
3231
3231
|
</section>
|
|
@@ -3082,7 +3082,7 @@ img {
|
|
|
3082
3082
|
<a name="type" class="tsd-anchor"></a>
|
|
3083
3083
|
<h3>type</h3>
|
|
3084
3084
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
|
3085
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><
|
|
3085
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
3086
3086
|
</ul>
|
|
3087
3087
|
<ul class="tsd-descriptions">
|
|
3088
3088
|
<li class="tsd-description">
|
|
@@ -3093,7 +3093,7 @@ img {
|
|
|
3093
3093
|
<p>Type of the participant.</p>
|
|
3094
3094
|
</div>
|
|
3095
3095
|
</div>
|
|
3096
|
-
<h4 class="tsd-returns-title">Returns <
|
|
3096
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
3097
3097
|
</li>
|
|
3098
3098
|
</ul>
|
|
3099
3099
|
</section>
|
package/docs/index.html
CHANGED
|
@@ -2706,6 +2706,9 @@ img {
|
|
|
2706
2706
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
2707
2707
|
<a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a>
|
|
2708
2708
|
</li>
|
|
2709
|
+
<li class=" tsd-kind-class">
|
|
2710
|
+
<a href="classes/ChannelMetadata.html" class="tsd-kind-icon">Channel<wbr>Metadata</a>
|
|
2711
|
+
</li>
|
|
2709
2712
|
<li class=" tsd-kind-class">
|
|
2710
2713
|
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
|
|
2711
2714
|
</li>
|
|
@@ -2944,7 +2947,7 @@ img {
|
|
|
2944
2947
|
</a>
|
|
2945
2948
|
<p>Releases of <code>twilio-conversations.js</code> are hosted on a CDN, and you can include these
|
|
2946
2949
|
directly in your web app using a <code><script></code> tag.</p>
|
|
2947
|
-
<pre><code class="language-html"><span style="color: #800000"><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.
|
|
2950
|
+
<pre><code class="language-html"><span style="color: #800000"><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.4/twilio-conversations.min.js"</span><span style="color: #800000">></script></span>
|
|
2948
2951
|
</code></pre>
|
|
2949
2952
|
<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>
|
|
2950
2953
|
<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>
|
|
@@ -2957,11 +2960,13 @@ img {
|
|
|
2957
2960
|
<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
|
|
2958
2961
|
number. While less flexible it is significantly more secure, which is required by some applications.</p>
|
|
2959
2962
|
<p>To consume securely use the following script snippet format:</p>
|
|
2960
|
-
<pre><code class="language-html"><span style="color: #800000"><script</span
|
|
2961
|
-
<span style="color: #000000FF">
|
|
2962
|
-
<span style="color: #000000FF">
|
|
2963
|
+
<pre><code class="language-html"><span style="color: #800000"><script</span>
|
|
2964
|
+
<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.4.0/twilio-conversations.min.js"</span>
|
|
2965
|
+
<span style="color: #000000FF"> </span><span style="color: #FF0000">integrity</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"sha256-<HASH FROM THE CHANGELOGS PAGE>"</span>
|
|
2966
|
+
<span style="color: #000000FF"> </span><span style="color: #FF0000">crossorigin</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"anonymous"</span>
|
|
2967
|
+
<span style="color: #800000">></script></span>
|
|
2963
2968
|
</code></pre>
|
|
2964
|
-
<p>Find the hash of each release published on the <a href="#
|
|
2969
|
+
<p>Find the hash of each release published on the <a href="#changelog">Changelog</a> page.</p>
|
|
2965
2970
|
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
|
|
2966
2971
|
<h2>Supported Browsers</h2><table><thead><tr><th>Browser</th><th>Supported Versions</th></tr></thead><tbody><tr><td>Chrome for Android</td><td>110</td></tr><tr><td>Firefox for Android</td><td>110</td></tr><tr><td>UC Browser for Android</td><td>13.4</td></tr><tr><td>Chrome</td><td>110, 109, 108</td></tr><tr><td>Edge</td><td>110, 109, 108</td></tr><tr><td>Firefox</td><td>110, 109, 108</td></tr><tr><td>Internet Explorer</td><td>11</td></tr><tr><td>Safari for iOS</td><td>16.3, 16.2</td></tr><tr><td>Safari</td><td>16.3, 16.2, 16.1</td></tr><tr><td>Samsung Internet</td><td>20, 19.0</td></tr></tbody></table><h3>Changelog</h3>
|
|
2967
2972
|
</a>
|
|
@@ -2977,6 +2982,7 @@ img {
|
|
|
2977
2982
|
<ul class="tsd-index-list">
|
|
2978
2983
|
<li class="tsd-kind-class"><a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a></li>
|
|
2979
2984
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a></li>
|
|
2985
|
+
<li class="tsd-kind-class"><a href="classes/ChannelMetadata.html" class="tsd-kind-icon">Channel<wbr>Metadata</a></li>
|
|
2980
2986
|
<li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li>
|
|
2981
2987
|
<li class="tsd-kind-class"><a href="classes/ContentTemplate.html" class="tsd-kind-icon">Content<wbr>Template</a></li>
|
|
2982
2988
|
<li class="tsd-kind-class"><a href="classes/ContentTemplateVariable.html" class="tsd-kind-icon">Content<wbr>Template<wbr>Variable</a></li>
|
|
@@ -3999,12 +4005,13 @@ img {
|
|
|
3999
4005
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
4000
4006
|
<a name="ParticipantType" class="tsd-anchor"></a>
|
|
4001
4007
|
<h3>Participant<wbr>Type</h3>
|
|
4002
|
-
<div class="tsd-signature tsd-kind-icon">Participant<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"chat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sms"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"whatsapp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span></div>
|
|
4008
|
+
<div class="tsd-signature tsd-kind-icon">Participant<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"chat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sms"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"whatsapp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
|
4003
4009
|
<aside class="tsd-sources">
|
|
4004
4010
|
</aside>
|
|
4005
4011
|
<div class="tsd-comment tsd-typography">
|
|
4006
4012
|
<div class="lead">
|
|
4007
|
-
<p>
|
|
4013
|
+
<p>Participant type. The string variant can be used to denote new types of
|
|
4014
|
+
participant that aren't supported by this version of the SDK.</p>
|
|
4008
4015
|
</div>
|
|
4009
4016
|
</div>
|
|
4010
4017
|
</section>
|
package/docs/modules.html
CHANGED
|
@@ -2708,6 +2708,9 @@ img {
|
|
|
2708
2708
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
2709
2709
|
<a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a>
|
|
2710
2710
|
</li>
|
|
2711
|
+
<li class=" tsd-kind-class">
|
|
2712
|
+
<a href="classes/ChannelMetadata.html" class="tsd-kind-icon">Channel<wbr>Metadata</a>
|
|
2713
|
+
</li>
|
|
2711
2714
|
<li class=" tsd-kind-class">
|
|
2712
2715
|
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
|
|
2713
2716
|
</li>
|
|
@@ -2946,7 +2949,7 @@ img {
|
|
|
2946
2949
|
</a>
|
|
2947
2950
|
<p>Releases of <code>twilio-conversations.js</code> are hosted on a CDN, and you can include these
|
|
2948
2951
|
directly in your web app using a <code><script></code> tag.</p>
|
|
2949
|
-
<pre><code class="language-html"><span style="color: #800000"><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.
|
|
2952
|
+
<pre><code class="language-html"><span style="color: #800000"><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.4/twilio-conversations.min.js"</span><span style="color: #800000">></script></span>
|
|
2950
2953
|
</code></pre>
|
|
2951
2954
|
<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>
|
|
2952
2955
|
<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>
|
|
@@ -2959,11 +2962,13 @@ img {
|
|
|
2959
2962
|
<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
|
|
2960
2963
|
number. While less flexible it is significantly more secure, which is required by some applications.</p>
|
|
2961
2964
|
<p>To consume securely use the following script snippet format:</p>
|
|
2962
|
-
<pre><code class="language-html"><span style="color: #800000"><script</span
|
|
2963
|
-
<span style="color: #000000FF">
|
|
2964
|
-
<span style="color: #000000FF">
|
|
2965
|
+
<pre><code class="language-html"><span style="color: #800000"><script</span>
|
|
2966
|
+
<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.4.0/twilio-conversations.min.js"</span>
|
|
2967
|
+
<span style="color: #000000FF"> </span><span style="color: #FF0000">integrity</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"sha256-<HASH FROM THE CHANGELOGS PAGE>"</span>
|
|
2968
|
+
<span style="color: #000000FF"> </span><span style="color: #FF0000">crossorigin</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"anonymous"</span>
|
|
2969
|
+
<span style="color: #800000">></script></span>
|
|
2965
2970
|
</code></pre>
|
|
2966
|
-
<p>Find the hash of each release published on the <a href="#
|
|
2971
|
+
<p>Find the hash of each release published on the <a href="#changelog">Changelog</a> page.</p>
|
|
2967
2972
|
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
|
|
2968
2973
|
<h3>Changelog</h3>
|
|
2969
2974
|
</a>
|
|
@@ -2978,6 +2983,7 @@ img {
|
|
|
2978
2983
|
<ul class="tsd-index-list">
|
|
2979
2984
|
<li class="tsd-kind-class"><a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a></li>
|
|
2980
2985
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a></li>
|
|
2986
|
+
<li class="tsd-kind-class"><a href="classes/ChannelMetadata.html" class="tsd-kind-icon">Channel<wbr>Metadata</a></li>
|
|
2981
2987
|
<li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li>
|
|
2982
2988
|
<li class="tsd-kind-class"><a href="classes/ContentTemplate.html" class="tsd-kind-icon">Content<wbr>Template</a></li>
|
|
2983
2989
|
<li class="tsd-kind-class"><a href="classes/ContentTemplateVariable.html" class="tsd-kind-icon">Content<wbr>Template<wbr>Variable</a></li>
|
|
@@ -4000,12 +4006,13 @@ img {
|
|
|
4000
4006
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
4001
4007
|
<a name="ParticipantType" class="tsd-anchor"></a>
|
|
4002
4008
|
<h3>Participant<wbr>Type</h3>
|
|
4003
|
-
<div class="tsd-signature tsd-kind-icon">Participant<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"chat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sms"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"whatsapp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span></div>
|
|
4009
|
+
<div class="tsd-signature tsd-kind-icon">Participant<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"chat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sms"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"whatsapp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
|
4004
4010
|
<aside class="tsd-sources">
|
|
4005
4011
|
</aside>
|
|
4006
4012
|
<div class="tsd-comment tsd-typography">
|
|
4007
4013
|
<div class="lead">
|
|
4008
|
-
<p>
|
|
4014
|
+
<p>Participant type. The string variant can be used to denote new types of
|
|
4015
|
+
participant that aren't supported by this version of the SDK.</p>
|
|
4009
4016
|
</div>
|
|
4010
4017
|
</div>
|
|
4011
4018
|
</section>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twilio/conversations",
|
|
3
|
-
"version": "2.4.0-rc.
|
|
3
|
+
"version": "2.4.0-rc.1",
|
|
4
4
|
"description": "Twilio Conversations client library",
|
|
5
5
|
"main": "./builds/lib.js",
|
|
6
6
|
"browser": "./builds/browser.js",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"scripts": {
|
|
22
22
|
"clean": "rm -rf ./coverage ./dist ./builds ./docs",
|
|
23
23
|
"lint:strict": "npx tsc-strict",
|
|
24
|
-
"lint": "yarn lint:strict && npx eslint src test --ext .ts",
|
|
24
|
+
"lint": "yarn lint:strict && npx eslint src test --ext .ts && node ../../tools/check-readme.js conversations",
|
|
25
25
|
"lint:fix": "yarn lint:strict && npx eslint src test --ext .ts --fix",
|
|
26
26
|
"test:unit": "env FORCE_COLOR=1 NODE_ENV=test npx nyc --report-dir coverage/unit ./node_modules/.bin/mocha test/unit/index.ts",
|
|
27
27
|
"test:integration": "env FORCE_COLOR=1 NODE_ENV=test npx nyc --report-dir coverage/integration ./node_modules/.bin/mocha test/integration/index.ts",
|