@twilio/conversations 2.0.0-rc.3 → 2.0.0-rc.4

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 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

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

package/dist/browser.js

@@ -4393,7 +4393,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
           while (1) {
             switch (_context5.prev = _context5.next) {
               case 0:
-                return _context5.abrupt("return", this.participantsEntity.addNonChatParticipant(proxyAddress, address, attributes !== null && attributes !== void 0 ? attributes : {}));
+                return _context5.abrupt("return", this.participantsEntity.addNonChatParticipant(proxyAddress, address, attributes));
 
               case 1:
               case "end":
@@ -6608,7 +6608,7 @@ function PushNotification(data) {
   this.data = data.data || {};
 };
 
-var version = "2.0.0-rc.3";
+var version = "2.0.0-rc.4";
 
 function ownKeys$1(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
@@ -7692,6 +7692,13 @@ exports.Client = Client_1 = (_temp = _class = /*#__PURE__*/function (_ReplayEven
      * The factory method will automatically trigger connection.
      * Do not use it if you need finer-grained control.
      *
+     * Since this method returns an already-initialized client, some of the events
+     * will be lost because they happen *before* the initialization. It is
+     * recommended that `client.onWithReplay` is used as opposed to `client.on`
+     * for subscribing to client events. The `client.onWithReplay` will re-emit
+     * the most recent value for a given event if it emitted before the
+     * subscription.
+     *
      * @param token Access token.
      * @param options Options to customize the client.
      * @returns Returns a fully initialized client.