stream-chat 8.57.6 → 8.59.0

package/dist/index.es.js

@@ -113,7 +113,7 @@ var Campaign = /*#__PURE__*/function () {
     key: "create",
     value: function () {
       var _create = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-        var _this$data, _this$data2, _this$data3, _this$data4, _this$data5, _this$data6, _this$data7, _this$data8, _this$data9;
+        var _this$data, _this$data2, _this$data3, _this$data4, _this$data5, _this$data6, _this$data7, _this$data8, _this$data9, _this$data10, _this$data11, _this$data12;
 
         var body, result;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
@@ -128,9 +128,12 @@ var Campaign = /*#__PURE__*/function () {
                   sender_mode: (_this$data4 = this.data) === null || _this$data4 === void 0 ? void 0 : _this$data4.sender_mode,
                   channel_template: (_this$data5 = this.data) === null || _this$data5 === void 0 ? void 0 : _this$data5.channel_template,
                   create_channels: (_this$data6 = this.data) === null || _this$data6 === void 0 ? void 0 : _this$data6.create_channels,
-                  description: (_this$data7 = this.data) === null || _this$data7 === void 0 ? void 0 : _this$data7.description,
-                  name: (_this$data8 = this.data) === null || _this$data8 === void 0 ? void 0 : _this$data8.name,
-                  user_ids: (_this$data9 = this.data) === null || _this$data9 === void 0 ? void 0 : _this$data9.user_ids
+                  show_channels: (_this$data7 = this.data) === null || _this$data7 === void 0 ? void 0 : _this$data7.show_channels,
+                  description: (_this$data8 = this.data) === null || _this$data8 === void 0 ? void 0 : _this$data8.description,
+                  name: (_this$data9 = this.data) === null || _this$data9 === void 0 ? void 0 : _this$data9.name,
+                  skip_push: (_this$data10 = this.data) === null || _this$data10 === void 0 ? void 0 : _this$data10.skip_push,
+                  skip_webhook: (_this$data11 = this.data) === null || _this$data11 === void 0 ? void 0 : _this$data11.skip_webhook,
+                  user_ids: (_this$data12 = this.data) === null || _this$data12 === void 0 ? void 0 : _this$data12.user_ids
                 };
                 _context.next = 3;
                 return this.client.createCampaign(body);
@@ -5008,6 +5011,134 @@ var Channel = /*#__PURE__*/function () {
 
       return removeVote;
     }()
+    /**
+     * createDraft - Creates or updates a draft message in a channel
+     *
+     * @param {string} channelType The channel type
+     * @param {string} channelID The channel ID
+     * @param {DraftMessagePayload<StreamChatGenerics>} message The draft message to create or update
+     *
+     * @return {Promise<CreateDraftResponse<StreamChatGenerics>>} Response containing the created draft
+     */
+
+  }, {
+    key: "createDraft",
+    value: function () {
+      var _createDraft = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee50(message) {
+        return _regeneratorRuntime.wrap(function _callee50$(_context50) {
+          while (1) {
+            switch (_context50.prev = _context50.next) {
+              case 0:
+                _context50.next = 2;
+                return this.getClient().post(this._channelURL() + '/draft', {
+                  message: message
+                });
+
+              case 2:
+                return _context50.abrupt("return", _context50.sent);
+
+              case 3:
+              case "end":
+                return _context50.stop();
+            }
+          }
+        }, _callee50, this);
+      }));
+
+      function createDraft(_x53) {
+        return _createDraft.apply(this, arguments);
+      }
+
+      return createDraft;
+    }()
+    /**
+     * deleteDraft - Deletes a draft message from a channel
+     *
+     * @param {Object} options
+     * @param {string} options.parent_id Optional parent message ID for drafts in threads
+     *
+     * @return {Promise<APIResponse>} API response
+     */
+
+  }, {
+    key: "deleteDraft",
+    value: function () {
+      var _deleteDraft = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee51() {
+        var _ref2,
+            parent_id,
+            _args51 = arguments;
+
+        return _regeneratorRuntime.wrap(function _callee51$(_context51) {
+          while (1) {
+            switch (_context51.prev = _context51.next) {
+              case 0:
+                _ref2 = _args51.length > 0 && _args51[0] !== undefined ? _args51[0] : {}, parent_id = _ref2.parent_id;
+                _context51.next = 3;
+                return this.getClient().delete(this._channelURL() + '/draft', {
+                  parent_id: parent_id
+                });
+
+              case 3:
+                return _context51.abrupt("return", _context51.sent);
+
+              case 4:
+              case "end":
+                return _context51.stop();
+            }
+          }
+        }, _callee51, this);
+      }));
+
+      function deleteDraft() {
+        return _deleteDraft.apply(this, arguments);
+      }
+
+      return deleteDraft;
+    }()
+    /**
+     * getDraft - Retrieves a draft message from a channel
+     *
+     * @param {Object} options
+     * @param {string} options.parent_id Optional parent message ID for drafts in threads
+     *
+     * @return {Promise<GetDraftResponse<StreamChatGenerics>>} Response containing the draft
+     */
+
+  }, {
+    key: "getDraft",
+    value: function () {
+      var _getDraft = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee52() {
+        var _ref3,
+            parent_id,
+            _args52 = arguments;
+
+        return _regeneratorRuntime.wrap(function _callee52$(_context52) {
+          while (1) {
+            switch (_context52.prev = _context52.next) {
+              case 0:
+                _ref3 = _args52.length > 0 && _args52[0] !== undefined ? _args52[0] : {}, parent_id = _ref3.parent_id;
+                _context52.next = 3;
+                return this.getClient().get(this._channelURL() + '/draft', {
+                  parent_id: parent_id
+                });
+
+              case 3:
+                return _context52.abrupt("return", _context52.sent);
+
+              case 4:
+              case "end":
+                return _context52.stop();
+            }
+          }
+        }, _callee52, this);
+      }));
+
+      function getDraft() {
+        return _getDraft.apply(this, arguments);
+      }
+
+      return getDraft;
+    }()
     /**
      * on - Listen to events on this channel.
      *
@@ -5218,18 +5349,18 @@ var Channel = /*#__PURE__*/function () {
           if ((_event$channel = event.channel) !== null && _event$channel !== void 0 && _event$channel.truncated_at) {
             var truncatedAt = +new Date(event.channel.truncated_at);
             channelState.messageSets.forEach(function (messageSet, messageSetIndex) {
-              messageSet.messages.forEach(function (_ref2) {
-                var createdAt = _ref2.created_at,
-                    id = _ref2.id;
+              messageSet.messages.forEach(function (_ref4) {
+                var createdAt = _ref4.created_at,
+                    id = _ref4.id;
                 if (truncatedAt > +createdAt) channelState.removeMessage({
                   id: id,
                   messageSetIndex: messageSetIndex
                 });
               });
             });
-            channelState.pinnedMessages.forEach(function (_ref3) {
-              var id = _ref3.id,
-                  createdAt = _ref3.created_at;
+            channelState.pinnedMessages.forEach(function (_ref5) {
+              var id = _ref5.id,
+                  createdAt = _ref5.created_at;
               if (truncatedAt > +createdAt) channelState.removePinnedMessage({
                 id: id
               });
@@ -5529,10 +5660,10 @@ var Channel = /*#__PURE__*/function () {
     }
   }, {
     key: "_hydrateMembers",
-    value: function _hydrateMembers(_ref4) {
-      var members = _ref4.members,
-          _ref4$overrideCurrent = _ref4.overrideCurrentState,
-          overrideCurrentState = _ref4$overrideCurrent === void 0 ? true : _ref4$overrideCurrent;
+    value: function _hydrateMembers(_ref6) {
+      var members = _ref6.members,
+          _ref6$overrideCurrent = _ref6.overrideCurrentState,
+          overrideCurrentState = _ref6$overrideCurrent === void 0 ? true : _ref6$overrideCurrent;
       var newMembersById = members.reduce(function (membersById, member) {
         if (member.user) {
           membersById[member.user.id] = member;
@@ -5837,11 +5968,20 @@ var StableWSConnection = /*#__PURE__*/function () {
     _defineProperty(this, "wsID", void 0);
 
     _defineProperty(this, "_buildUrl", function () {
-      var qs = encodeURIComponent(_this.client._buildWSPayload(_this.requestID));
+      var qs = _this.client._buildWSPayload(_this.requestID);
 
       var token = _this.client.tokenManager.getToken();
 
-      return "".concat(_this.client.wsBaseURL, "/connect?json=").concat(qs, "&api_key=").concat(_this.client.key, "&authorization=").concat(token, "&stream-auth-type=").concat(_this.client.getAuthType(), "&X-Stream-Client=").concat(encodeURIComponent(_this.client.getUserAgent()));
+      var wsUrlParams = _this.client.options.wsUrlParams;
+      var params = new URLSearchParams(wsUrlParams);
+      params.set('json', qs);
+      params.set('api_key', _this.client.key); // it is expected that the autorization parameter exists even if
+      // the token is undefined, so we interpolate it to be safe
+
+      params.set('authorization', "".concat(token));
+      params.set('stream-auth-type', _this.client.getAuthType());
+      params.set('X-Stream-Client', _this.client.getUserAgent());
+      return "".concat(_this.client.wsBaseURL, "/connect?").concat(params.toString());
     });
 
     _defineProperty(this, "onlineStatusChanged", function (event) {
@@ -8680,7 +8820,8 @@ function ownKeys$5(object, enumerableOnly) { var keys = Object.keys(object); if
 function _objectSpread$5(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys$5(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys$5(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 var MODERATION_ENTITY_TYPES = {
   user: 'stream:user',
-  message: 'stream:chat:v1:message'
+  message: 'stream:chat:v1:message',
+  userprofile: 'stream:v1:user_profile'
 }; // Moderation class provides all the endpoints related to moderation v2.
 
 var Moderation = /*#__PURE__*/function () {
@@ -9203,6 +9344,82 @@ var Moderation = /*#__PURE__*/function () {
 
       return check;
     }()
+    /**
+     * Experimental: Check user profile
+     *
+     * Warning: This is an experimental feature and the API is subject to change.
+     *
+     * This function is used to check a user profile for moderation.
+     * This will not create any review queue items for the user profile.
+     * You can just use this to check whether to allow a certain user profile to be created or not.
+     *
+     * Example:
+     *
+     * ```ts
+     * const res = await client.moderation.checkUserProfile(userId, { username: "fuck_boy_001", image: "https://example.com/profile.jpg" });
+     * if (res.recommended_action === "remove") {
+     *   // Block the user profile from being created
+     * } else {
+     *   // Allow the user profile to be created
+     * }
+     * ```
+     *
+     * @param userId
+     * @param profile.username
+     * @param profile.image
+     * @returns
+     */
+
+  }, {
+    key: "checkUserProfile",
+    value: function () {
+      var _checkUserProfile = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee14(userId, profile) {
+        var moderationPayload;
+        return _regeneratorRuntime.wrap(function _callee14$(_context14) {
+          while (1) {
+            switch (_context14.prev = _context14.next) {
+              case 0:
+                if (!(!profile.username && !profile.image)) {
+                  _context14.next = 2;
+                  break;
+                }
+
+                throw new Error('Either username or image must be provided');
+
+              case 2:
+                moderationPayload = {};
+
+                if (profile.username) {
+                  moderationPayload.texts = [profile.username];
+                }
+
+                if (profile.image) {
+                  moderationPayload.images = [profile.image];
+                }
+
+                _context14.next = 7;
+                return this.check(MODERATION_ENTITY_TYPES.userprofile, userId, userId, moderationPayload, 'user_profile:default', {
+                  force_sync: true,
+                  test_mode: true
+                });
+
+              case 7:
+                return _context14.abrupt("return", _context14.sent);
+
+              case 8:
+              case "end":
+                return _context14.stop();
+            }
+          }
+        }, _callee14, this);
+      }));
+
+      function checkUserProfile(_x28, _x29) {
+        return _checkUserProfile.apply(this, arguments);
+      }
+
+      return checkUserProfile;
+    }()
     /**
      *
      * @param {string} entityType string Type of entity to be checked E.g., stream:user, stream:chat:v1:message, or any custom string
@@ -9219,12 +9436,12 @@ var Moderation = /*#__PURE__*/function () {
   }, {
     key: "addCustomFlags",
     value: function () {
-      var _addCustomFlags = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee14(entityType, entityID, entityCreatorID, moderationPayload, flags) {
-        return _regeneratorRuntime.wrap(function _callee14$(_context14) {
+      var _addCustomFlags = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee15(entityType, entityID, entityCreatorID, moderationPayload, flags) {
+        return _regeneratorRuntime.wrap(function _callee15$(_context15) {
           while (1) {
-            switch (_context14.prev = _context14.next) {
+            switch (_context15.prev = _context15.next) {
               case 0:
-                _context14.next = 2;
+                _context15.next = 2;
                 return this.client.post(this.client.baseURL + "/api/v2/moderation/custom_check", {
                   entity_type: entityType,
                   entity_id: entityID,
@@ -9234,17 +9451,17 @@ var Moderation = /*#__PURE__*/function () {
                 });
 
               case 2:
-                return _context14.abrupt("return", _context14.sent);
+                return _context15.abrupt("return", _context15.sent);
 
               case 3:
               case "end":
-                return _context14.stop();
+                return _context15.stop();
             }
           }
-        }, _callee14, this);
+        }, _callee15, this);
       }));
 
-      function addCustomFlags(_x28, _x29, _x30, _x31, _x32) {
+      function addCustomFlags(_x30, _x31, _x32, _x33, _x34) {
         return _addCustomFlags.apply(this, arguments);
       }
 
@@ -9260,26 +9477,26 @@ var Moderation = /*#__PURE__*/function () {
   }, {
     key: "addCustomMessageFlags",
     value: function () {
-      var _addCustomMessageFlags = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee15(messageID, flags) {
-        return _regeneratorRuntime.wrap(function _callee15$(_context15) {
+      var _addCustomMessageFlags = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee16(messageID, flags) {
+        return _regeneratorRuntime.wrap(function _callee16$(_context16) {
           while (1) {
-            switch (_context15.prev = _context15.next) {
+            switch (_context16.prev = _context16.next) {
               case 0:
-                _context15.next = 2;
+                _context16.next = 2;
                 return this.addCustomFlags(MODERATION_ENTITY_TYPES.message, messageID, '', {}, flags);
 
               case 2:
-                return _context15.abrupt("return", _context15.sent);
+                return _context16.abrupt("return", _context16.sent);
 
               case 3:
               case "end":
-                return _context15.stop();
+                return _context16.stop();
             }
           }
-        }, _callee15, this);
+        }, _callee16, this);
       }));
 
-      function addCustomMessageFlags(_x33, _x34) {
+      function addCustomMessageFlags(_x35, _x36) {
         return _addCustomMessageFlags.apply(this, arguments);
       }
 
@@ -12336,7 +12553,8 @@ var StreamChat = /*#__PURE__*/function () {
       // making sure cookies are not sent
       warmUp: false,
       recoverStateOnReconnect: true,
-      disableCache: false
+      disableCache: false,
+      wsUrlParams: new URLSearchParams({})
     }, inputOptions);
 
     if (this.node && !this.options.httpsAgent) {
@@ -16096,7 +16314,7 @@ var StreamChat = /*#__PURE__*/function () {
         return this.userAgent;
       }
 
-      var version = "8.57.6";
+      var version = "8.59.0";
       var clientBundle = "";
       var userAgentString = '';
 
@@ -18342,6 +18560,55 @@ var StreamChat = /*#__PURE__*/function () {
 
       return updateFlags;
     }()
+    /**
+     * queryDrafts - Queries drafts for the current user
+     *
+     * @param {object} [options] Query options
+     * @param {object} [options.filter] Filters for the query
+     * @param {number} [options.sort] Sort parameters
+     * @param {number} [options.limit] Limit the number of results
+     * @param {string} [options.next] Pagination parameter
+     * @param {string} [options.prev] Pagination parameter
+     * @param {string} [options.user_id] Has to be provided when called server-side
+     *
+     * @return {Promise<APIResponse & { drafts: DraftResponse<StreamChatGenerics>[]; next?: string }>} Response containing the drafts
+     */
+
+  }, {
+    key: "queryDrafts",
+    value: function () {
+      var _queryDrafts = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee118() {
+        var options,
+            payload,
+            _args118 = arguments;
+        return _regeneratorRuntime.wrap(function _callee118$(_context118) {
+          while (1) {
+            switch (_context118.prev = _context118.next) {
+              case 0:
+                options = _args118.length > 0 && _args118[0] !== undefined ? _args118[0] : {};
+                payload = _objectSpread$1(_objectSpread$1({}, options), {}, {
+                  sort: options.sort ? normalizeQuerySort(options.sort) : undefined
+                });
+                _context118.next = 4;
+                return this.post(this.baseURL + '/drafts/query', payload);
+
+              case 4:
+                return _context118.abrupt("return", _context118.sent);
+
+              case 5:
+              case "end":
+                return _context118.stop();
+            }
+          }
+        }, _callee118, this);
+      }));
+
+      function queryDrafts() {
+        return _queryDrafts.apply(this, arguments);
+      }
+
+      return queryDrafts;
+    }()
   }], [{
     key: "getInstance",
     value: function getInstance(key, secretOrOptions, options) {