@twilio/conversations 2.0.0-rc.3 → 2.0.1-rc.2

package/CHANGELOG.md

@@ -3,6 +3,48 @@
 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.2](https://github.com/twilio/rtd-sdk-monorepo-js/compare/@twilio/conversations@2.0.1-rc.1...@twilio/conversations@2.0.1-rc.2) (2021-10-25)
+
+**Note:** Version bump only for package @twilio/conversations
+
+
+
+
+
+### [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

package/README.md

@@ -7,33 +7,38 @@ Visit our official site for more detalis: [https://www.twilio.com/conversations]
 
 Instantiating and using
 ------------
-To use the library you need [to generate a token](https://www.twilio.com/docs/conversations/create-tokens) and pass it to the conversations Client `create` factory.
+To use the library you need [to generate a token](https://www.twilio.com/docs/conversations/create-tokens) and pass it to the Conversations Client constructor.
 
 ### NPM
 ```
 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
@@ -43,17 +48,9 @@ directly in your web app using a `<script>` tag.
 ```html
 <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 :
-```
-Twilio.Conversations.Client.create(token).then(client => {
-    // Use client
-});
-```
-
-or, if you prefer `async`/`await` syntax:
+Using this method, `twilio-conversations.js` will set a browser global `Twilio.Conversations` through which you can use the client:
 ```
-let client = await Twilio.Conversations.Client.create(token);
-// Use client
+const client = new Twilio.Conversations.Client(token);
 ```
 
 ### Security
@@ -67,7 +64,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/2.0.0/twilio-conversations.min.js"
+<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.1/twilio-conversations.min.js"
         integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
         crossorigin="anonymous"></script>
 ```

package/dist/browser.js

@@ -161,9 +161,9 @@ require('core-js/modules/web.dom-collections.iterator.js');
 require('core-js/modules/es.regexp.exec.js');
 require('core-js/modules/es.string.replace.js');
 require('core-js/modules/es.array.join.js');
-var JsonDiff = require('rfc6902');
 var declarativeTypeValidator = require('@twilio/declarative-type-validator');
 var replayEventEmitter = require('@twilio/replay-event-emitter');
+var isEqual = require('lodash.isequal');
 require('core-js/modules/es.array.slice.js');
 require('core-js/modules/es.function.name.js');
 require('core-js/modules/es.symbol.description.js');
@@ -244,7 +244,7 @@ var _classCallCheck__default = /*#__PURE__*/_interopDefaultLegacy(_classCallChec
 var _regeneratorRuntime__default = /*#__PURE__*/_interopDefaultLegacy(_regeneratorRuntime);
 var _typeof__default = /*#__PURE__*/_interopDefaultLegacy(_typeof);
 var loglevelLog__namespace = /*#__PURE__*/_interopNamespace(loglevelLog);
-var JsonDiff__namespace = /*#__PURE__*/_interopNamespace(JsonDiff);
+var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
 var _slicedToArray__default = /*#__PURE__*/_interopDefaultLegacy(_slicedToArray);
 var _toConsumableArray__default = /*#__PURE__*/_interopDefaultLegacy(_toConsumableArray);
 
@@ -459,21 +459,12 @@ var Configuration = function Configuration() {
   }
 };
 
-/**
- * Checks if objects are equal
- */
-
-function isDeepEqual(o1, o2) {
-  return JsonDiff__namespace.createPatch(o1, o2).length === 0;
-}
 /**
  * Deep-clone an object. Note that this does not work on object containing
  * functions.
  * @param {object} obj - the object to deep-clone
  * @returns {object}
  */
-
-
 function deepClone(obj) {
   return JSON.parse(JSON.stringify(obj));
 }
@@ -719,7 +710,7 @@ var User = /*#__PURE__*/function (_ReplayEventEmitter) {
               case 9:
                 updateAttributes = parseAttributes(value.value, "Retrieved malformed attributes from the server for user: ".concat(this.state.identity), log$8);
 
-                if (!isDeepEqual(this.state.attributes, updateAttributes)) {
+                if (!isEqual__default['default'](this.state.attributes, updateAttributes)) {
                   this.state.attributes = updateAttributes;
                   updateReasons.push('attributes');
                 }
@@ -1432,7 +1423,7 @@ var Participant = /*#__PURE__*/function (_ReplayEventEmitter) {
       var updateReasons = [];
       var updateAttributes = parseAttributes(data.attributes, 'Retrieved malformed attributes from the server for participant: ' + this.state.sid, log$7);
 
-      if (data.attributes && !isDeepEqual(this.state.attributes, updateAttributes)) {
+      if (data.attributes && !isEqual__default['default'](this.state.attributes, updateAttributes)) {
         this.state.attributes = updateAttributes;
         updateReasons.push('attributes');
       }
@@ -2647,7 +2638,7 @@ var Message = /*#__PURE__*/function (_ReplayEventEmitter) {
 
       var updatedAttributes = parseAttributes(data.attributes, "Got malformed attributes for the message ".concat(this.sid), log$5);
 
-      if (!isDeepEqual(this.state.attributes, updatedAttributes)) {
+      if (!isEqual__default['default'](this.state.attributes, updatedAttributes)) {
         this.state.attributes = updatedAttributes;
         updateReasons.push('attributes');
       }
@@ -4210,7 +4201,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
             break;
 
           case fieldMappings.attributes:
-            if (isDeepEqual(this.channelState.attributes, update.attributes)) {
+            if (isEqual__default['default'](this.channelState.attributes, update.attributes)) {
               break;
             }
 
@@ -4246,7 +4237,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
               updateReasons.add(localKey);
             }
 
-            if (isDeepEqual(this.channelState.lastMessage, {})) {
+            if (isEqual__default['default'](this.channelState.lastMessage, {})) {
               delete this.channelState.lastMessage;
             }
 
@@ -4259,7 +4250,7 @@ var Conversation = /*#__PURE__*/function (_ReplayEventEmitter) {
               state.dateUpdated = new Date(state.dateUpdated);
             }
 
-            if (isDeepEqual(this.channelState.state, state)) {
+            if (isEqual__default['default'](this.channelState.state, state)) {
               break;
             }
 
@@ -4393,7 +4384,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":
@@ -5925,7 +5916,7 @@ var Conversations = /*#__PURE__*/function (_ReplayEventEmitter) {
                   updateData.lastConsumedMessageIndex = data.lastConsumedMessageIndex;
                 }
 
-                if (!isDeepEqual(updateData, {})) {
+                if (!isEqual__default['default'](updateData, {})) {
                   conversation._update(updateData);
                 }
 
@@ -6608,7 +6599,7 @@ function PushNotification(data) {
   this.data = data.data || {};
 };
 
-var version = "2.0.0-rc.3";
+var version = "2.0.1-rc.2";
 
 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 +7683,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.
@@ -7858,6 +7856,7 @@ exports.DetailedDeliveryReceipt = DetailedDeliveryReceipt;
 exports.Media = Media;
 exports.Message = Message;
 exports.MessageBuilder = MessageBuilder;
+exports.NotificationTypes = NotificationTypes;
 exports.Participant = Participant;
 exports.PushNotification = PushNotification;
 exports.RestPaginator = RestPaginator;