stream-chat 9.27.2 → 9.29.0

package/dist/cjs/index.browser.js

@@ -66,6 +66,7 @@ __export(index_exports, {
   BuiltinRoles: () => BuiltinRoles,
   Campaign: () => Campaign,
   Channel: () => Channel,
+  ChannelBatchUpdater: () => ChannelBatchUpdater,
   ChannelManager: () => ChannelManager,
   ChannelSearchSource: () => ChannelSearchSource,
   ChannelState: () => ChannelState,
@@ -335,6 +336,190 @@ var Campaign = class {
   }
 };
 
+// src/channel_batch_updater.ts
+var ChannelBatchUpdater = class {
+  constructor(client) {
+    this.client = client;
+  }
+  // Member operations
+  /**
+   * addMembers - Add members to channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[] | NewMemberPayload[]} members Members to add
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async addMembers(filter, members) {
+    return await this.client.updateChannelsBatch({
+      operation: "addMembers",
+      filter,
+      members
+    });
+  }
+  /**
+   * removeMembers - Remove members from channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[]} members Member IDs to remove
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async removeMembers(filter, members) {
+    return await this.client.updateChannelsBatch({
+      operation: "removeMembers",
+      filter,
+      members
+    });
+  }
+  /**
+   * inviteMembers - Invite members to channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[] | NewMemberPayload[]} members Members to invite
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async inviteMembers(filter, members) {
+    return await this.client.updateChannelsBatch({
+      operation: "inviteMembers",
+      filter,
+      members
+    });
+  }
+  /**
+   * addModerators - Add moderators to channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[]} members Member IDs to promote to moderator
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async addModerators(filter, members) {
+    return await this.client.updateChannelsBatch({
+      operation: "addModerators",
+      filter,
+      members
+    });
+  }
+  /**
+   * demoteModerators - Remove moderator role from members in channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[]} members Member IDs to demote
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async demoteModerators(filter, members) {
+    return await this.client.updateChannelsBatch({
+      operation: "demoteModerators",
+      filter,
+      members
+    });
+  }
+  /**
+   * assignRoles - Assign roles to members in channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {NewMemberPayload[]} members Members with role assignments
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async assignRoles(filter, members) {
+    return await this.client.updateChannelsBatch({
+      operation: "assignRoles",
+      filter,
+      members
+    });
+  }
+  // Visibility operations
+  /**
+   * hide - Hide channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async hide(filter) {
+    return await this.client.updateChannelsBatch({
+      operation: "hide",
+      filter
+    });
+  }
+  /**
+   * show - Show channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async show(filter) {
+    return await this.client.updateChannelsBatch({
+      operation: "show",
+      filter
+    });
+  }
+  /**
+   * archive - Archive channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async archive(filter) {
+    return await this.client.updateChannelsBatch({
+      operation: "archive",
+      filter
+    });
+  }
+  /**
+   * unarchive - Unarchive channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async unarchive(filter) {
+    return await this.client.updateChannelsBatch({
+      operation: "unarchive",
+      filter
+    });
+  }
+  // Data operations
+  /**
+   * updateData - Update data on channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {BatchChannelDataUpdate} data Data to update
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async updateData(filter, data) {
+    return await this.client.updateChannelsBatch({
+      operation: "updateData",
+      filter,
+      data
+    });
+  }
+  /**
+   * addFilterTags - Add filter tags to channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[]} tags Tags to add
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async addFilterTags(filter, tags) {
+    return await this.client.updateChannelsBatch({
+      operation: "addFilterTags",
+      filter,
+      filter_tags_update: tags
+    });
+  }
+  /**
+   * removeFilterTags - Remove filter tags from channels matching the filter
+   *
+   * @param {UpdateChannelsBatchFilters} filter Filter to select channels
+   * @param {string[]} tags Tags to remove
+   * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async removeFilterTags(filter, tags) {
+    return await this.client.updateChannelsBatch({
+      operation: "removeFilterTags",
+      filter,
+      filter_tags_update: tags
+    });
+  }
+};
+
 // src/client.ts
 var import_axios3 = __toESM(require("axios"));
 var import_https = __toESM(require_https());
@@ -5375,10 +5560,11 @@ var getTriggerCharWithToken = ({
   isCommand = false,
   acceptTrailingSpaces = true
 }) => {
-  const triggerNorWhitespace = `[^\\s${trigger}]*`;
+  const escapedTrigger = escapeRegExp(trigger);
+  const triggerNorWhitespace = `[^\\s${escapedTrigger}]*`;
   const match = text.match(
     new RegExp(
-      isCommand ? `^[${trigger}]${triggerNorWhitespace}$` : acceptTrailingSpaces ? `(?!^|\\W)?[${trigger}]${triggerNorWhitespace}\\s?${triggerNorWhitespace}$` : `(?!^|\\W)?[${trigger}]${triggerNorWhitespace}$`,
+      isCommand ? `^[${escapedTrigger}]${triggerNorWhitespace}$` : acceptTrailingSpaces ? `(?!^|\\W)?[${escapedTrigger}]${triggerNorWhitespace}\\s?${triggerNorWhitespace}$` : `(?!^|\\W)?[${escapedTrigger}]${triggerNorWhitespace}$`,
       "g"
     )
   );
@@ -9003,11 +9189,13 @@ var Channel = class {
    * unbanUser - Removes the bans for a user on a channel
    *
    * @param {string} targetUserID
+   * @param {UnBanUserOptions} options
    * @returns {Promise<APIResponse>}
    */
-  async unbanUser(targetUserID) {
+  async unbanUser(targetUserID, options) {
     this._checkInitialized();
     return await this.getClient().unbanUser(targetUserID, {
+      ...options,
       type: this.type,
       id: this.id
     });
@@ -13593,6 +13781,20 @@ var StreamChat = class _StreamChat {
       }
     });
   }
+  /**
+   * queryFutureChannelBans - Query future channel bans created by a user
+   *
+   * @param {QueryFutureChannelBansOptions} options Option object with user_id, exclude_expired_bans, limit, offset
+   * @returns {Promise<FutureChannelBansResponse>} Future Channel Bans Response
+   */
+  async queryFutureChannelBans(options = {}) {
+    return await this.get(
+      this.baseURL + "/query_future_channel_bans",
+      {
+        payload: options
+      }
+    );
+  }
   /**
    * queryMessageFlags - Query message flags
    *
@@ -13612,10 +13814,10 @@ var StreamChat = class _StreamChat {
   /**
    * queryChannelsRequest - Queries channels and returns the raw response
    *
-   * @param {ChannelFilters} filterConditions object MongoDB style filters
+   * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options.
    * @param {ChannelSort} [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_updated: -1}, {created_at: 1}]
-   * @param {ChannelOptions} [options] Options object
+   * @param {ChannelOptions} [options] Options object. Can include predefined_filter, filter_values, and sort_values for using predefined filters.
    *
    * @return {Promise<Array<ChannelAPIResponse>>} search channels response
    */
@@ -13629,11 +13831,18 @@ var StreamChat = class _StreamChat {
     if (!this._hasConnectionID()) {
       defaultOptions.watch = false;
     }
-    const payload = {
+    const { predefined_filter, filter_values, sort_values, ...restOptions } = options;
+    const payload = predefined_filter ? {
+      predefined_filter,
+      filter_values,
+      sort_values,
+      ...defaultOptions,
+      ...restOptions
+    } : {
       filter_conditions: filterConditions,
       sort: normalizeQuerySort(sort),
       ...defaultOptions,
-      ...options
+      ...restOptions
     };
     const data = await this.post(
       this.baseURL + "/channels",
@@ -14740,7 +14949,7 @@ var StreamChat = class _StreamChat {
     if (this.userAgent) {
       return this.userAgent;
     }
-    const version = "9.27.2";
+    const version = "9.29.0";
     const clientBundle = "browser-cjs";
     let userAgentString = "";
     if (this.sdkIdentifier) {
@@ -15039,6 +15248,14 @@ var StreamChat = class _StreamChat {
     }
     return new Campaign(this, idOrData, data);
   }
+  /**
+   * channelBatchUpdater - Returns a ChannelBatchUpdater instance for batch channel operations
+   *
+   * @return {ChannelBatchUpdater} A ChannelBatchUpdater instance
+   */
+  channelBatchUpdater() {
+    return new ChannelBatchUpdater(this);
+  }
   segment(type, idOrData, data) {
     if (typeof idOrData === "string") {
       return new Segment(this, type, idOrData, data);
@@ -15048,7 +15265,7 @@ var StreamChat = class _StreamChat {
   validateServerSideAuth() {
     if (!this.secret) {
       throw new Error(
-        "Campaigns is a server-side only feature. Please initialize the client with a secret to use this feature."
+        "This feature can be used server-side only. Please initialize the client with a secret to use this feature."
       );
     }
   }
@@ -15901,6 +16118,91 @@ var StreamChat = class _StreamChat {
   syncDeliveredCandidates(collections) {
     this.messageDeliveryReporter.syncDeliveredCandidates(collections);
   }
+  /**
+   *  Update Channels Batch
+   *
+   *  @param {UpdateChannelsBatchOptions} payload for updating channels in batch
+   *  @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
+   */
+  async updateChannelsBatch(payload) {
+    return await this.put(
+      this.baseURL + `/channels/batch`,
+      payload
+    );
+  }
+  /**
+   * createPredefinedFilter - Creates a new predefined filter (server-side only)
+   *
+   * @param {CreatePredefinedFilterOptions} options Predefined filter options
+   *
+   * @return {Promise<PredefinedFilterResponse>} The created predefined filter
+   */
+  async createPredefinedFilter(options) {
+    this.validateServerSideAuth();
+    return await this.post(
+      `${this.baseURL}/predefined_filters`,
+      options
+    );
+  }
+  /**
+   * getPredefinedFilter - Gets a predefined filter by name (server-side only)
+   *
+   * @param {string} name Predefined filter name
+   *
+   * @return {Promise<PredefinedFilterResponse>} The predefined filter
+   */
+  async getPredefinedFilter(name) {
+    this.validateServerSideAuth();
+    return await this.get(
+      `${this.baseURL}/predefined_filters/${encodeURIComponent(name)}`
+    );
+  }
+  /**
+   * updatePredefinedFilter - Updates a predefined filter (server-side only)
+   *
+   * @param {string} name Predefined filter name
+   * @param {UpdatePredefinedFilterOptions} options Predefined filter options
+   *
+   * @return {Promise<PredefinedFilterResponse>} The updated predefined filter
+   */
+  async updatePredefinedFilter(name, options) {
+    this.validateServerSideAuth();
+    return await this.put(
+      `${this.baseURL}/predefined_filters/${encodeURIComponent(name)}`,
+      options
+    );
+  }
+  /**
+   * deletePredefinedFilter - Deletes a predefined filter (server-side only)
+   *
+   * @param {string} name Predefined filter name
+   *
+   * @return {Promise<APIResponse>} The server response
+   */
+  async deletePredefinedFilter(name) {
+    this.validateServerSideAuth();
+    return await this.delete(
+      `${this.baseURL}/predefined_filters/${encodeURIComponent(name)}`
+    );
+  }
+  /**
+   * listPredefinedFilters - Lists all predefined filters (server-side only)
+   *
+   * @param {ListPredefinedFiltersOptions} options Query options
+   *
+   * @return {Promise<ListPredefinedFiltersResponse>} The list of predefined filters
+   */
+  async listPredefinedFilters(options = {}) {
+    this.validateServerSideAuth();
+    const { sort, ...paginationOptions } = options;
+    return await this.get(
+      `${this.baseURL}/predefined_filters`,
+      {
+        ...paginationOptions,
+        ...sort ? { sort: JSON.stringify(sort) } : {}
+      }
+    );
+  }
 };
 
 // src/events.ts