stream-chat 4.2.0 → 4.3.0

package/dist/index.es.js

@@ -1066,7 +1066,8 @@ var Channel = /*#__PURE__*/function () {
      * sendMessage - Send a message to this channel
      *
      * @param {Message<AttachmentType, MessageType, UserType>} message The Message object
-     * @param {{ skip_push?: boolean }} [options] Option object, {skip_push: true} to skip sending push notifications
+     * @param {boolean} [options.skip_enrich_url] Do not try to enrich the URLs within message
+     * @param {boolean} [options.skip_push] Skip sending push notifications
      *
      * @return {Promise<SendMessageAPIResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>>} The Server Response
      */
@@ -1261,8 +1262,8 @@ var Channel = /*#__PURE__*/function () {
      * queryMembers - Query Members
      *
      * @param {UserFilters<UserType>}  filterConditions object MongoDB style filters
-     * @param {UserSort<UserType>} [sort] Sort options, for instance [{created_at: -1}].
-     * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_active: -1}, {created_at: 1}]
+     * @param {MemberSort<UserType>} [sort] Sort options, for instance [{created_at: -1}].
+     * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{name: -1}, {created_at: 1}]
      * @param {{ limit?: number; offset?: number }} [options] Option object, {limit: 10, offset:10}
      *
      * @return {Promise<ChannelMemberAPIResponse<UserType>>} Query Members response
@@ -2514,6 +2515,7 @@ var Channel = /*#__PURE__*/function () {
       if (message.silent) return false;
       if (((_message$user = message.user) === null || _message$user === void 0 ? void 0 : _message$user.id) === this.getClient().userID) return false;
       if ((_message$user2 = message.user) !== null && _message$user2 !== void 0 && _message$user2.id && this.getClient().userMuteStatus(message.user.id)) return false;
+      if (message.type === 'system') return false;
       if (this.muteStatus().muted) return false;
       return true;
     }
@@ -3704,14 +3706,22 @@ var StableWSConnection = /*#__PURE__*/function () {
     });
 
     _defineProperty(this, "_listenForConnectionChanges", function () {
-      if (typeof window !== 'undefined' && window != null && window.addEventListener != null) {
+      var _window;
+
+      // (typeof window !== 'undefined') check is for environments where window is not defined, such as nextjs environment,
+      // and thus (window === undefined) will result in ReferenceError.
+      if (typeof window !== 'undefined' && (_window = window) !== null && _window !== void 0 && _window.addEventListener) {
         window.addEventListener('offline', _this.onlineStatusChanged);
         window.addEventListener('online', _this.onlineStatusChanged);
       }
     });
 
     _defineProperty(this, "_removeConnectionListeners", function () {
-      if (typeof window !== 'undefined' && window != null && window.addEventListener != null) {
+      var _window2;
+
+      // (typeof window !== 'undefined') check is for environments where window is not defined, such as nextjs environment,
+      // and thus (window === undefined) will result in ReferenceError.
+      if (typeof window !== 'undefined' && (_window2 = window) !== null && _window2 !== void 0 && _window2.removeEventListener) {
         window.removeEventListener('offline', _this.onlineStatusChanged);
         window.removeEventListener('online', _this.onlineStatusChanged);
       }
@@ -5375,6 +5385,8 @@ var StreamChat = /*#__PURE__*/function () {
 
     _defineProperty(this, "updateUser", this.upsertUser);
 
+    _defineProperty(this, "markAllRead", this.markChannelsRead);
+
     _defineProperty(this, "_isUsingServerAuth", function () {
       return !!_this.secret;
     });
@@ -5780,6 +5792,7 @@ var StreamChat = /*#__PURE__*/function () {
     		  apnTemplate: '{}', //if app doesn't have apn configured it will error
     		  firebaseTemplate: '{}', //if app doesn't have firebase configured it will error
     		  firebaseDataTemplate: '{}', //if app doesn't have firebase configured it will error
+    		  huaweiDataTemplate: '{}' //if app doesn't have huawei configured it will error
     		  skipDevices: true, // skip config/device checks and sending to real devices
     	}
     */
@@ -5796,7 +5809,7 @@ var StreamChat = /*#__PURE__*/function () {
               case 0:
                 data = _args11.length > 1 && _args11[1] !== undefined ? _args11[1] : {};
                 _context11.next = 3;
-                return this.post(this.baseURL + '/check_push', _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+                return this.post(this.baseURL + '/check_push', _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
                   user_id: userID
                 }, data.messageID ? {
                   message_id: data.messageID
@@ -5806,6 +5819,8 @@ var StreamChat = /*#__PURE__*/function () {
                   firebase_template: data.firebaseTemplate
                 } : {}), data.firebaseDataTemplate ? {
                   firebase_data_template: data.firebaseDataTemplate
+                } : {}), data.huaweiDataTemplate ? {
+                  huawei_data_template: data.huaweiDataTemplate
                 } : {}), data.skipDevices ? {
                   skip_devices: true
                 } : {}));
@@ -5830,13 +5845,11 @@ var StreamChat = /*#__PURE__*/function () {
     /**
      * testSQSSettings - Tests that the given or configured SQS configuration is valid
      *
-     * @param {string} userID User ID. If user has no devices, it will error
-     * @param {TestPushDataInput} [data] Overrides for push templates/message used
+     * @param {TestSQSDataInput} [data] Overrides SQS settings for testing if needed
      * 		IE: {
-    		  messageID: 'id-of-message',//will error if message does not exist
-    		  apnTemplate: '{}', //if app doesn't have apn configured it will error
-    		  firebaseTemplate: '{}', //if app doesn't have firebase configured it will error
-    		  firebaseDataTemplate: '{}', //if app doesn't have firebase configured it will error
+    		  sqs_key: 'auth_key',
+    		  sqs_secret: 'auth_secret',
+    		  sqs_url: 'url_to_queue',
     	}
      */
 
@@ -6709,7 +6722,7 @@ var StreamChat = /*#__PURE__*/function () {
      *
      * @param {BaseDeviceFields} device the device object
      * @param {string} device.id device id
-     * @param {string} device.push_provider the push provider (apn or firebase)
+     * @param {string} device.push_provider the push provider
      *
      */
 
@@ -6726,7 +6739,7 @@ var StreamChat = /*#__PURE__*/function () {
      * addDevice - Adds a push device for a user.
      *
      * @param {string} id the device id
-     * @param {'apn' | 'firebase'} push_provider the push provider (apn or firebase)
+     * @param {PushProvider} push_provider the push provider
      * @param {string} [userID] the user id (defaults to current user)
      *
      */
@@ -7717,6 +7730,8 @@ var StreamChat = /*#__PURE__*/function () {
       return unflagUser;
     }()
     /**
+     * @deprecated use markChannelsRead instead
+     *
      * markAllRead - marks all channels for this user as read
      * @param {MarkAllReadOptions<UserType>} [data]
      *
@@ -7724,9 +7739,18 @@ var StreamChat = /*#__PURE__*/function () {
      */
 
   }, {
-    key: "markAllRead",
-    value: function () {
-      var _markAllRead = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee41() {
+    key: "markChannelsRead",
+    value:
+    /**
+     * markChannelsRead - marks channels read -
+     * it accepts a map of cid:messageid pairs, if messageid is empty, the whole channel will be marked as read
+     *
+     * @param {MarkChannelsReadOptions <UserType>} [data]
+     *
+     * @return {Promise<APIResponse>}
+     */
+    function () {
+      var _markChannelsRead = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee41() {
         var data,
             _args41 = arguments;
         return _regeneratorRuntime.wrap(function _callee41$(_context41) {
@@ -7745,11 +7769,11 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee41, this);
       }));
 
-      function markAllRead() {
-        return _markAllRead.apply(this, arguments);
+      function markChannelsRead() {
+        return _markChannelsRead.apply(this, arguments);
       }
 
-      return markAllRead;
+      return markChannelsRead;
     }()
   }, {
     key: "createCommand",
@@ -7930,6 +7954,7 @@ var StreamChat = /*#__PURE__*/function () {
      *
      * @param {Omit<MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>, 'mentioned_users'> & { mentioned_users?: string[] }} message object, id needs to be specified
      * @param {string | { id: string }} [userId]
+     * @param {boolean} [options.skip_enrich_url] Do not try to enrich the URLs within message
      *
      * @return {APIResponse & { message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> }} Response that includes the message
      */
@@ -7937,7 +7962,7 @@ var StreamChat = /*#__PURE__*/function () {
   }, {
     key: "updateMessage",
     value: function () {
-      var _updateMessage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee43(message, userId) {
+      var _updateMessage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee43(message, userId, options) {
         var clonedMessage, reservedMessageFields;
         return _regeneratorRuntime.wrap(function _callee43$(_context43) {
           while (1) {
@@ -7982,9 +8007,9 @@ var StreamChat = /*#__PURE__*/function () {
                 }
 
                 _context43.next = 10;
-                return this.post(this.baseURL + "/messages/".concat(message.id), {
+                return this.post(this.baseURL + "/messages/".concat(message.id), _objectSpread({
                   message: clonedMessage
-                });
+                }, options));
 
               case 10:
                 return _context43.abrupt("return", _context43.sent);
@@ -7997,7 +8022,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee43, this);
       }));
 
-      function updateMessage(_x55, _x56) {
+      function updateMessage(_x55, _x56, _x57) {
         return _updateMessage.apply(this, arguments);
       }
 
@@ -8012,13 +8037,15 @@ var StreamChat = /*#__PURE__*/function () {
      *         example: {id: "user1", set:{text: "hi"}, unset:["color"]}
      * @param {string | { id: string }} [userId]
      *
+     * @param {boolean} [options.skip_enrich_url] Do not try to enrich the URLs within message
+     *
      * @return {APIResponse & { message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> }} Response that includes the updated message
      */
 
   }, {
     key: "partialUpdateMessage",
     value: function () {
-      var _partialUpdateMessage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee44(id, partialMessageObject, userId) {
+      var _partialUpdateMessage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee44(id, partialMessageObject, userId, options) {
         var user;
         return _regeneratorRuntime.wrap(function _callee44$(_context44) {
           while (1) {
@@ -8041,7 +8068,7 @@ var StreamChat = /*#__PURE__*/function () {
                 }
 
                 _context44.next = 6;
-                return this.put(this.baseURL + "/messages/".concat(id), _objectSpread(_objectSpread({}, partialMessageObject), {}, {
+                return this.put(this.baseURL + "/messages/".concat(id), _objectSpread(_objectSpread(_objectSpread({}, partialMessageObject), options), {}, {
                   user: user
                 }));
 
@@ -8056,7 +8083,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee44, this);
       }));
 
-      function partialUpdateMessage(_x57, _x58, _x59) {
+      function partialUpdateMessage(_x58, _x59, _x60, _x61) {
         return _partialUpdateMessage.apply(this, arguments);
       }
 
@@ -8093,7 +8120,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee45, this);
       }));
 
-      function deleteMessage(_x60, _x61) {
+      function deleteMessage(_x62, _x63) {
         return _deleteMessage.apply(this, arguments);
       }
 
@@ -8121,7 +8148,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee46, this);
       }));
 
-      function getMessage(_x62) {
+      function getMessage(_x64) {
         return _getMessage.apply(this, arguments);
       }
 
@@ -8130,7 +8157,7 @@ var StreamChat = /*#__PURE__*/function () {
   }, {
     key: "getUserAgent",
     value: function getUserAgent() {
-      return this.userAgent || "stream-chat-javascript-client-".concat(this.node ? 'node' : 'browser', "-", "4.2.0");
+      return this.userAgent || "stream-chat-javascript-client-".concat(this.node ? 'node' : 'browser', "-", "4.3.0");
     }
   }, {
     key: "setUserAgent",
@@ -8332,7 +8359,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee47, this);
       }));
 
-      function sendUserCustomEvent(_x63, _x64) {
+      function sendUserCustomEvent(_x65, _x66) {
         return _sendUserCustomEvent.apply(this, arguments);
       }
 
@@ -8420,7 +8447,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee48, this);
       }));
 
-      function createSegment(_x65) {
+      function createSegment(_x67) {
         return _createSegment.apply(this, arguments);
       }
 
@@ -8460,7 +8487,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee49, this);
       }));
 
-      function getSegment(_x66) {
+      function getSegment(_x68) {
         return _getSegment.apply(this, arguments);
       }
 
@@ -8499,7 +8526,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee50, this);
       }));
 
-      function listSegments(_x67) {
+      function listSegments(_x69) {
         return _listSegments.apply(this, arguments);
       }
 
@@ -8542,7 +8569,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee51, this);
       }));
 
-      function updateSegment(_x68, _x69) {
+      function updateSegment(_x70, _x71) {
         return _updateSegment.apply(this, arguments);
       }
 
@@ -8574,7 +8601,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee52, this);
       }));
 
-      function deleteSegment(_x70) {
+      function deleteSegment(_x72) {
         return _deleteSegment.apply(this, arguments);
       }
 
@@ -8616,7 +8643,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee53, this);
       }));
 
-      function createCampaign(_x71) {
+      function createCampaign(_x73) {
         return _createCampaign.apply(this, arguments);
       }
 
@@ -8656,7 +8683,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee54, this);
       }));
 
-      function getCampaign(_x72) {
+      function getCampaign(_x74) {
         return _getCampaign.apply(this, arguments);
       }
 
@@ -8695,7 +8722,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee55, this);
       }));
 
-      function listCampaigns(_x73) {
+      function listCampaigns(_x75) {
         return _listCampaigns.apply(this, arguments);
       }
 
@@ -8738,7 +8765,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee56, this);
       }));
 
-      function updateCampaign(_x74, _x75) {
+      function updateCampaign(_x76, _x77) {
         return _updateCampaign.apply(this, arguments);
       }
 
@@ -8770,7 +8797,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee57, this);
       }));
 
-      function deleteCampaign(_x76) {
+      function deleteCampaign(_x78) {
         return _deleteCampaign.apply(this, arguments);
       }
 
@@ -8814,7 +8841,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee58, this);
       }));
 
-      function scheduleCampaign(_x77, _x78) {
+      function scheduleCampaign(_x79, _x80) {
         return _scheduleCampaign.apply(this, arguments);
       }
 
@@ -8854,7 +8881,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee59, this);
       }));
 
-      function stopCampaign(_x79) {
+      function stopCampaign(_x81) {
         return _stopCampaign.apply(this, arguments);
       }
 
@@ -8894,7 +8921,7 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee60, this);
       }));
 
-      function resumeCampaign(_x80) {
+      function resumeCampaign(_x82) {
         return _resumeCampaign.apply(this, arguments);
       }
 
@@ -8937,12 +8964,182 @@ var StreamChat = /*#__PURE__*/function () {
         }, _callee61, this);
       }));
 
-      function testCampaign(_x81, _x82) {
+      function testCampaign(_x83, _x84) {
         return _testCampaign.apply(this, arguments);
       }
 
       return testCampaign;
     }()
+    /**
+     * enrichURL - Get OpenGraph data of the given link
+     *
+     * @param {string} url link
+     * @return {OGAttachment} OG Attachment
+     */
+
+  }, {
+    key: "enrichURL",
+    value: function () {
+      var _enrichURL = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee62(url) {
+        return _regeneratorRuntime.wrap(function _callee62$(_context62) {
+          while (1) {
+            switch (_context62.prev = _context62.next) {
+              case 0:
+                return _context62.abrupt("return", this.get(this.baseURL + "/og", {
+                  url: url
+                }));
+
+              case 1:
+              case "end":
+                return _context62.stop();
+            }
+          }
+        }, _callee62, this);
+      }));
+
+      function enrichURL(_x85) {
+        return _enrichURL.apply(this, arguments);
+      }
+
+      return enrichURL;
+    }()
+    /**
+     * getTask - Gets status of a long running task
+     *
+     * @param {string} id Task ID
+     *
+     * @return {TaskStatus} The task status
+     */
+
+  }, {
+    key: "getTask",
+    value: function () {
+      var _getTask = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee63(id) {
+        return _regeneratorRuntime.wrap(function _callee63$(_context63) {
+          while (1) {
+            switch (_context63.prev = _context63.next) {
+              case 0:
+                return _context63.abrupt("return", this.get("".concat(this.baseURL, "/tasks/").concat(id)));
+
+              case 1:
+              case "end":
+                return _context63.stop();
+            }
+          }
+        }, _callee63, this);
+      }));
+
+      function getTask(_x86) {
+        return _getTask.apply(this, arguments);
+      }
+
+      return getTask;
+    }()
+    /**
+     * deleteChannels - Deletes a list of channel
+     *
+     * @param {string[]} cids Channel CIDs
+     * @param {boolean} [options.hard_delete] Defines if the channel is hard deleted or not
+     *
+     * @return {DeleteChannelsResponse} Result of the soft deletion, if server-side, it holds the task ID as well
+     */
+
+  }, {
+    key: "deleteChannels",
+    value: function () {
+      var _deleteChannels = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee64(cids) {
+        var options,
+            _args64 = arguments;
+        return _regeneratorRuntime.wrap(function _callee64$(_context64) {
+          while (1) {
+            switch (_context64.prev = _context64.next) {
+              case 0:
+                options = _args64.length > 1 && _args64[1] !== undefined ? _args64[1] : {};
+                _context64.next = 3;
+                return this.post(this.baseURL + "/channels/delete", _objectSpread({
+                  cids: cids
+                }, options));
+
+              case 3:
+                return _context64.abrupt("return", _context64.sent);
+
+              case 4:
+              case "end":
+                return _context64.stop();
+            }
+          }
+        }, _callee64, this);
+      }));
+
+      function deleteChannels(_x87) {
+        return _deleteChannels.apply(this, arguments);
+      }
+
+      return deleteChannels;
+    }()
+    /**
+     * deleteUsers - Batch Delete Users
+     *
+     * @param {string[]} user_ids which users to delete
+     * @param {DeleteUserOptions} options Configuration how to delete users
+     *
+     * @return {APIResponse} A task ID
+     */
+
+  }, {
+    key: "deleteUsers",
+    value: function () {
+      var _deleteUsers = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee65(user_ids, options) {
+        return _regeneratorRuntime.wrap(function _callee65$(_context65) {
+          while (1) {
+            switch (_context65.prev = _context65.next) {
+              case 0:
+                if (!((options === null || options === void 0 ? void 0 : options.user) !== 'soft' && (options === null || options === void 0 ? void 0 : options.user) !== 'hard')) {
+                  _context65.next = 2;
+                  break;
+                }
+
+                throw new Error('Invalid delete user options. user must be one of [soft hard]');
+
+              case 2:
+                if (!(options.messages !== undefined && options.messages !== 'soft' && options.messages !== 'hard')) {
+                  _context65.next = 4;
+                  break;
+                }
+
+                throw new Error('Invalid delete user options. messages must be one of [soft hard]');
+
+              case 4:
+                if (!(options.conversations !== undefined && options.conversations !== 'soft' && options.conversations !== 'hard')) {
+                  _context65.next = 6;
+                  break;
+                }
+
+                throw new Error('Invalid delete user options. conversations must be one of [soft hard]');
+
+              case 6:
+                _context65.next = 8;
+                return this.post(this.baseURL + "/users/delete", _objectSpread({
+                  user_ids: user_ids
+                }, options));
+
+              case 8:
+                return _context65.abrupt("return", _context65.sent);
+
+              case 9:
+              case "end":
+                return _context65.stop();
+            }
+          }
+        }, _callee65, this);
+      }));
+
+      function deleteUsers(_x88, _x89) {
+        return _deleteUsers.apply(this, arguments);
+      }
+
+      return deleteUsers;
+    }()
   }], [{
     key: "getInstance",
     value: function getInstance(key, secretOrOptions, options) {