feat: added channel batch updater

Author: javierdfm

src/channel_batch_updater.ts

@@ -0,0 +1,218 @@
+import type { StreamChat } from './client';
+import type {
+  APIResponse,
+  BatchChannelDataUpdate,
+  NewMemberPayload,
+  UpdateChannelsBatchFilters,
+  UpdateChannelsBatchResponse,
+} from './types';
+
+/**
+ * ChannelBatchUpdater - A class that provides convenience methods for batch channel operations
+ */
+export class ChannelBatchUpdater {
+  client: StreamChat;
+
+  constructor(client: StreamChat) {
+    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: UpdateChannelsBatchFilters,
+    members: string[] | NewMemberPayload[],
+  ) {
+    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: UpdateChannelsBatchFilters, members: string[]) {
+    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: UpdateChannelsBatchFilters,
+    members: string[] | NewMemberPayload[],
+  ) {
+    return await this.client.updateChannelsBatch({
+      operation: 'invites',
+      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: UpdateChannelsBatchFilters, members: string[]) {
+    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: UpdateChannelsBatchFilters, members: string[]) {
+    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: UpdateChannelsBatchFilters, members: NewMemberPayload[]) {
+    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: UpdateChannelsBatchFilters) {
+    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: UpdateChannelsBatchFilters) {
+    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: UpdateChannelsBatchFilters) {
+    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: UpdateChannelsBatchFilters) {
+    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: UpdateChannelsBatchFilters, data: BatchChannelDataUpdate) {
+    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: UpdateChannelsBatchFilters, tags: string[]) {
+    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: UpdateChannelsBatchFilters, tags: string[]) {
+    return await this.client.updateChannelsBatch({
+      operation: 'removeFilterTags',
+      filter,
+      filter_tags_update: tags,
+    });
+  }
+}

src/client.ts

@@ -13,6 +13,7 @@ import { CheckSignature, DevToken, JWTUserToken } from './signing';
 import { TokenManager } from './token_manager';
 import { WSConnectionFallback } from './connection_fallback';
 import { Campaign } from './campaign';
+import { ChannelBatchUpdater } from './channel_batch_updater';
 import { Segment } from './segment';
 import { isErrorResponse, isWSFailure } from './errors';
 import {
@@ -3718,6 +3719,15 @@ export 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: SegmentType, idOrData: string | SegmentData, data?: SegmentData) {
     if (typeof idOrData === 'string') {
       return new Segment(this, type, idOrData, data);

src/index.ts

@@ -1,5 +1,6 @@
 export * from './base64';
 export * from './campaign';
+export * from './channel_batch_updater';
 export * from './client';
 export * from './client_state';
 export * from './channel';

src/types.ts

@@ -4490,6 +4490,7 @@ export type UpdateChannelsBatchOptions = {
   filter: UpdateChannelsBatchFilters;
   members?: string[] | Array<NewMemberPayload>;
   data?: BatchChannelDataUpdate;
+  filter_tags_update?: string[];
 };
 
 export type UpdateChannelsBatchFilters = QueryFilters<{