@twilio/conversations 1.3.0-rc8 → 2.0.0-rc.4

package/CHANGELOG.md

@@ -0,0 +1,210 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [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)
+
+
+### ⚠ BREAKING CHANGES
+
+* User.updateFriendlyName no longer accepts
+null as the value.
+* Passing null to Conversation.sendMessage
+will result with the message body being empty.
+
+### Features
+
+* Add getCachedTemporaryUrl() ([c453e70](https://github.com/twilio/rtd-sdk-monorepo-js/commit/c453e70d0e0bc8bb6f0cd80ef0e2a3309b5ba804))
+* Add limits support ([b471295](https://github.com/twilio/rtd-sdk-monorepo-js/commit/b4712954bf6f0cf82c47c77b96a98ed1ebe9c158))
+* Add Media category field ([0672c20](https://github.com/twilio/rtd-sdk-monorepo-js/commit/0672c202d000736dda37be66387692e2befe24bd))
+* Add mediaSet GET operation support ([424bd4a](https://github.com/twilio/rtd-sdk-monorepo-js/commit/424bd4abe42312ea01740bc142ed1c6ec3b1913d))
+* Add multiple media accessors ([99e78e6](https://github.com/twilio/rtd-sdk-monorepo-js/commit/99e78e6239b87d36b23e6bbbd0bc68f19b869f85))
+* Add sendMessageV2 and prepareMessage() builder ([fd5ae39](https://github.com/twilio/rtd-sdk-monorepo-js/commit/fd5ae39816e45cce83a37120bfff3f2d530f09d3))
+* Allow specifying filename when uploading media file ([abd6126](https://github.com/twilio/rtd-sdk-monorepo-js/commit/abd61266135b14c27c3d076c009a3fd331a0f810))
+* Dispose of session in favour of the sessionless protocol ([8b46fbd](https://github.com/twilio/rtd-sdk-monorepo-js/commit/8b46fbdac04d7e2cf55a74fb13b3016661f869b8))
+* Do not filter out body for media messages ([3eeeabc](https://github.com/twilio/rtd-sdk-monorepo-js/commit/3eeeabc7c32b2798bef40e50466610d155aa68e5))
+
+
+### Bug Fixes
+
+* Add token update for notificationClient ([5cda351](https://github.com/twilio/rtd-sdk-monorepo-js/commit/5cda3513c0df4aac8df01034d2764bb0e970a476))
+* Default addNonChatParticipant options to empty if not provided ([84e205b](https://github.com/twilio/rtd-sdk-monorepo-js/commit/84e205b7e4c4c2faebce6fe79521751765dde8c5))
+* Deprecate unsetPushRegistrationId and add removePushRegistrations ([82ef892](https://github.com/twilio/rtd-sdk-monorepo-js/commit/82ef892537942efd1e47302dad33086a2d8a5f22))
+* Fix setPushRegistrationId and unsetPushRegistrationId impls ([9120a65](https://github.com/twilio/rtd-sdk-monorepo-js/commit/9120a65834c9fb38c184c55bfa961d2e1cddb8ca))
+* Return correct type from function ([5353810](https://github.com/twilio/rtd-sdk-monorepo-js/commit/5353810e32de201415f1e93d25d1b679eac2d974))
+* Streamline Message state initialization ([a29331f](https://github.com/twilio/rtd-sdk-monorepo-js/commit/a29331f3d7e75ed85d4919efd67a5766482af06b))
+
+
+### Code Refactoring
+
+* Migrate to Sessionless EditUser command ([060b96b](https://github.com/twilio/rtd-sdk-monorepo-js/commit/060b96b5019311a47e7fdb71b12cbdd4996f3e44))
+* Migrate to Sessionless SendMessage command ([997e17f](https://github.com/twilio/rtd-sdk-monorepo-js/commit/997e17fd04426aebe04e1fa734752aee4ddecaf5))
+
+
+
+## [2.0.0-rc.0](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.12...@twilio/conversations@2.0.0-rc.0) (2021-09-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* Add init registrations
+* Use twilsock connection state
+
+### Features
+
+* Add init registrations ([d09c52d](https://github.com/twilio/rtd-sdk-monorepo-js/commit/d09c52d2b1894fb0db2e3a084937350ee1a73f01))
+* Export Telemetry from Twilsock ([eb261ec](https://github.com/twilio/rtd-sdk-monorepo-js/commit/eb261ecdb366b6381462c377431735c5c09f1094))
+* Use twilsock connection state ([2a6a4be](https://github.com/twilio/rtd-sdk-monorepo-js/commit/2a6a4be6384037ca80f1a02663cb126cbff3797a))
+
+
+### Bug Fixes
+
+* Fix getMessages()' usage of sync pagination ([4563227](https://github.com/twilio/rtd-sdk-monorepo-js/commit/45632271337affeb3af7dcf8bec78b555b5db6b1))
+* Start client connection state in 'unknown' ([a78acd1](https://github.com/twilio/rtd-sdk-monorepo-js/commit/a78acd1e5dde7532cfd64ed6ed09178d5009399e))
+* Use Transport from Twilsock ([7f0ce1e](https://github.com/twilio/rtd-sdk-monorepo-js/commit/7f0ce1e8e74b39d38cb4feff685e19807cba5ff0))
+
+
+
+### [1.2.4-rc.12](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.11...@twilio/conversations@1.2.4-rc.12) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.11](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.10...@twilio/conversations@1.2.4-rc.11) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.10](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.9...@twilio/conversations@1.2.4-rc.10) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.9](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.8...@twilio/conversations@1.2.4-rc.9) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.8](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.7...@twilio/conversations@1.2.4-rc.8) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.7](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.5...@twilio/conversations@1.2.4-rc.7) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.6](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.5...@twilio/conversations@1.2.4-rc.6) (2021-09-12)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.5](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.4...@twilio/conversations@1.2.4-rc.5) (2021-09-10)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.4](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.3...@twilio/conversations@1.2.4-rc.4) (2021-09-10)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.4-rc.3](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.4-rc.2...@twilio/conversations@1.2.4-rc.3) (2021-09-09)
+
+
+### Bug Fixes
+
+* Fix Rollup type export issue ([02f9d73](https://github.com/twilio/rtd-sdk-monorepo-js/commit/02f9d7307ce982afbd1a8e92f8e8bdd6646b74f0))
+
+
+
+### [1.2.4-rc.2](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.3-rc.1...@twilio/conversations@1.2.4-rc.2) (2021-09-07)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [1.2.3-rc.1](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@1.2.3-rc.0...@twilio/conversations@1.2.3-rc.1) (2021-08-23)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### 1.2.3-rc.0 (2021-08-23)
+
+**Note:** Version bump only for package @twilio/conversations

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>
 ```