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

package/CHANGELOG.md

@@ -3,6 +3,73 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [2.0.1-rc.1](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.1-rc.0...@twilio/conversations@2.0.1-rc.1) (2021-10-22)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [2.0.1-rc.0](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.0...@twilio/conversations@2.0.1-rc.0) (2021-10-22)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+## [2.0.0](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.0-rc.4...@twilio/conversations@2.0.0) (2021-10-19)
+
+
+### Bug Fixes
+
+* Add an export to NotificationTypes ([0986564](https://github.com/twilio/rtd-sdk-monorepo-js/commit/09865645750f8ae2f930471284de9d9f7445f1e8))
+
+
+
+## [2.0.0-rc.4](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.0-rc.3...@twilio/conversations@2.0.0-rc.4) (2021-10-14)
+
+
+### Bug Fixes
+
+* Fix passing JSON attributes into conversation.addNonChatParticipant ([c3da243](https://github.com/twilio/rtd-sdk-monorepo-js/commit/c3da243469f5c33663c756d9f714a38240c4dd48))
+
+
+
+## [2.0.0-rc.3](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.0-rc.2...@twilio/conversations@2.0.0-rc.3) (2021-10-13)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+## [2.0.0-rc.2](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.0-rc.1...@twilio/conversations@2.0.0-rc.2) (2021-10-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* Disallow null Conversation.updateFriendlyName
+* Disallow null for client options
+* Remove default exports from Conversations
+* Client.reachabilityEnabled can now throw an error.
+
+### Bug Fixes
+
+* Add missing exports ([74d08ce](https://github.com/twilio/rtd-sdk-monorepo-js/commit/74d08ce00a8a4cf0b961dde3570f5c7bd7a1e1f9))
+* Allow all JSON values as properties in addNonChatParticipant ([ddbea1c](https://github.com/twilio/rtd-sdk-monorepo-js/commit/ddbea1c0d0d26b488661ef123883316f7926b456))
+* Disallow null Conversation.updateFriendlyName ([7e4b556](https://github.com/twilio/rtd-sdk-monorepo-js/commit/7e4b5563e2a016f1904d9b37cfc063592712f0a6))
+* Disallow null for client options ([c5435f9](https://github.com/twilio/rtd-sdk-monorepo-js/commit/c5435f9fb9dadf11483e2c7884c334a040c06330))
+* Fix client user initialization problem ([043546d](https://github.com/twilio/rtd-sdk-monorepo-js/commit/043546d872300fda4db70d9c04461f944dfa5936))
+* Remove default exports from Conversations ([38e2e24](https://github.com/twilio/rtd-sdk-monorepo-js/commit/38e2e24512425da4ba0f1670dcf37d8ccf1ac67e))
+* Reset currentState on push unregister ([590991c](https://github.com/twilio/rtd-sdk-monorepo-js/commit/590991c841a78b3c7e88a05629090a2de5a8f9da))
+* Resubscribe to push notification on re-register ([709847f](https://github.com/twilio/rtd-sdk-monorepo-js/commit/709847f8462890214197cf1af769f41b56bfbccc))
+* Throw an error if reachabilityEnabled was accessed before client init ([3fd3293](https://github.com/twilio/rtd-sdk-monorepo-js/commit/3fd32937d7e42d6df815efab35ded3b93a671556))
+* UnsentMessage.send now returns a proper value ([c71a0a9](https://github.com/twilio/rtd-sdk-monorepo-js/commit/c71a0a9a9618c09f5d02dbee6bc2d122d9008383))
+
+
+
 ## [2.0.0-rc.1](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.0-rc.0...@twilio/conversations@2.0.0-rc.1) (2021-10-04)
 
 

package/README.md

@@ -14,26 +14,31 @@ To use the library you need [to generate a token](https://www.twilio.com/docs/co
 npm install --save @twilio/conversations
 ```
 
-Using this method, you can `require` `twilio-conversations` and then use the client:
+Using this method, you can `require` `twilio-conversations` and then use the 
+client:
 ```
-const Conversations = require('@twilio/conversations');
-Conversations.Client.create(token).then(client => {
-    // Use client
-});
-```
-
-Or, if you prefer `async`/`await` syntax:
-```
-const Conversations = require('@twilio/conversations');
-const client = await Conversations.Client.create(token);
-// Use client
+const { Client } = require('@twilio/conversations');
+const client = new Client(token);
+// Before you use the client, subscribe to the `'stateChanged'` event and wait 
+// for the `'initialized'` state to be reported.
+client.on('stateChanged', (state) => {
+  if (state === 'initialized') {
+    // Use the client
+  }
+}
 ```
 
 The SDK could also be imported using the ES module syntax:
 ```
-import Conversations from '@twilio/conversations';
-const client = await Conversations.Client.create(token);
-// Use client
+import { Client } from '@twilio/conversations';
+const client = new Client(token);
+// Before you use the client, subscribe to the `'stateChanged'` event and wait 
+// for the `'initialized'` state to be reported.
+client.on('stateChanged', (state) => {
+  if (state === 'initialized') {
+    // Use the client
+  }
+}
 ```
 
 ### CDN
@@ -41,7 +46,7 @@ const client = await Conversations.Client.create(token);
 Releases of `twilio-conversations.js` are hosted on a CDN, and you can include these
 directly in your web app using a `<script>` tag.
 ```html
-<script src="https://media.twiliocdn.com/sdk/js/conversations/v1.2/twilio-conversations.min.js"></script>
+<script src="https://media.twiliocdn.com/sdk/js/conversations/v2.0/twilio-conversations.min.js"></script>
 ```
 Using this method, `twilio-conversations.js` will set a browser global `Twilio.Conversations` through which you can use the client :
 ```
@@ -67,7 +72,7 @@ number. While less flexible it is significantly more secure, which is required b
 To consume securely use the following script snippet format:
 
 ```html
-<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/1.2.0/twilio-conversations.min.js"
+<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.0/twilio-conversations.min.js"
         integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
         crossorigin="anonymous"></script>
 ```