stream-chat 9.27.2 → 9.29.0

package/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 {
@@ -75,6 +76,7 @@ import type {
   CreatePollAPIResponse,
   CreatePollData,
   CreatePollOptionAPIResponse,
+  CreatePredefinedFilterOptions,
   CreateReminderOptions,
   CustomPermissionOptions,
   DeactivateUsersOptions,
@@ -104,6 +106,7 @@ import type {
   FlagsPaginationOptions,
   FlagsResponse,
   FlagUserResponse,
+  FutureChannelBansResponse,
   GetBlockedUsersAPIResponse,
   GetCampaignOptions,
   GetChannelTypeResponse,
@@ -123,6 +126,8 @@ import type {
   ListCommandsResponse,
   ListImportsPaginationOptions,
   ListImportsResponse,
+  ListPredefinedFiltersOptions,
+  ListPredefinedFiltersResponse,
   LocalMessage,
   Logger,
   MarkChannelsReadOptions,
@@ -152,6 +157,7 @@ import type {
   PollVote,
   PollVoteData,
   PollVotesAPIResponse,
+  PredefinedFilterResponse,
   Product,
   PushPreference,
   PushProvider,
@@ -161,6 +167,7 @@ import type {
   PushProviderUpsertResponse,
   QueryChannelsAPIResponse,
   QueryDraftsResponse,
+  QueryFutureChannelBansOptions,
   QueryMessageHistoryFilters,
   QueryMessageHistoryOptions,
   QueryMessageHistoryResponse,
@@ -209,6 +216,8 @@ import type {
   TokenOrProvider,
   TranslateResponse,
   UnBanUserOptions,
+  UpdateChannelsBatchOptions,
+  UpdateChannelsBatchResponse,
   UpdateChannelTypeRequest,
   UpdateChannelTypeResponse,
   UpdateCommandOptions,
@@ -218,6 +227,7 @@ import type {
   UpdateMessageOptions,
   UpdatePollAPIResponse,
   UpdatePollOptionAPIResponse,
+  UpdatePredefinedFilterOptions,
   UpdateReminderOptions,
   UpdateSegmentData,
   UpdateUsersAPIResponse,
@@ -1814,6 +1824,21 @@ export 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: QueryFutureChannelBansOptions = {}) {
+    return await this.get<FutureChannelBansResponse>(
+      this.baseURL + '/query_future_channel_bans',
+      {
+        payload: options,
+      },
+    );
+  }
+
   /**
    * queryMessageFlags - Query message flags
    *
@@ -1838,10 +1863,10 @@ export 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
    */
@@ -1862,13 +1887,23 @@ export class StreamChat {
       defaultOptions.watch = false;
     }
 
-    // Return a list of channels
-    const payload = {
-      filter_conditions: filterConditions,
-      sort: normalizeQuerySort(sort),
-      ...defaultOptions,
-      ...options,
-    };
+    const { predefined_filter, filter_values, sort_values, ...restOptions } = options;
+
+    // Build payload based on whether we're using a predefined filter or traditional filters
+    const payload = predefined_filter
+      ? {
+          predefined_filter,
+          filter_values,
+          sort_values,
+          ...defaultOptions,
+          ...restOptions,
+        }
+      : {
+          filter_conditions: filterConditions,
+          sort: normalizeQuerySort(sort),
+          ...defaultOptions,
+          ...restOptions,
+        };
 
     const data = await this.post<QueryChannelsAPIResponse>(
       this.baseURL + '/channels',
@@ -3746,6 +3781,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);
@@ -3757,7 +3801,7 @@ export 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.',
       );
     }
   }
@@ -4792,4 +4836,95 @@ export class StreamChat {
   syncDeliveredCandidates(collections: Channel[]) {
     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: UpdateChannelsBatchOptions) {
+    return await this.put<APIResponse & UpdateChannelsBatchResponse>(
+      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: CreatePredefinedFilterOptions) {
+    this.validateServerSideAuth();
+    return await this.post<PredefinedFilterResponse>(
+      `${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: string) {
+    this.validateServerSideAuth();
+    return await this.get<PredefinedFilterResponse>(
+      `${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: string, options: UpdatePredefinedFilterOptions) {
+    this.validateServerSideAuth();
+    return await this.put<PredefinedFilterResponse>(
+      `${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: string) {
+    this.validateServerSideAuth();
+    return await this.delete<APIResponse>(
+      `${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: ListPredefinedFiltersOptions = {}) {
+    this.validateServerSideAuth();
+    const { sort, ...paginationOptions } = options;
+    return await this.get<ListPredefinedFiltersResponse>(
+      `${this.baseURL}/predefined_filters`,
+      {
+        ...paginationOptions,
+        ...(sort ? { sort: JSON.stringify(sort) } : {}),
+      },
+    );
+  }
 }

package/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';

package/src/messageComposer/middleware/textComposer/textMiddlewareUtils.ts

@@ -16,15 +16,16 @@ export const getTriggerCharWithToken = ({
   isCommand?: boolean;
   acceptTrailingSpaces?: boolean;
 }) => {
-  const triggerNorWhitespace = `[^\\s${trigger}]*`;
+  const escapedTrigger = escapeRegExp(trigger);
+  const triggerNorWhitespace = `[^\\s${escapedTrigger}]*`;
 
   const match = text.match(
     new RegExp(
       isCommand
-        ? `^[${trigger}]${triggerNorWhitespace}$`
+        ? `^[${escapedTrigger}]${triggerNorWhitespace}$`
         : acceptTrailingSpaces
-          ? `(?!^|\\W)?[${trigger}]${triggerNorWhitespace}\\s?${triggerNorWhitespace}$`
-          : `(?!^|\\W)?[${trigger}]${triggerNorWhitespace}$`,
+          ? `(?!^|\\W)?[${escapedTrigger}]${triggerNorWhitespace}\\s?${triggerNorWhitespace}$`
+          : `(?!^|\\W)?[${escapedTrigger}]${triggerNorWhitespace}$`,
       'g',
     ),
   );

package/src/types.ts

@@ -284,6 +284,26 @@ export type BannedUsersResponse = APIResponse & {
   }>;
 };
 
+export type FutureChannelBan = {
+  user: UserResponse;
+  expires?: string;
+  reason?: string;
+  shadow?: boolean;
+  created_at: string;
+};
+
+export type FutureChannelBansResponse = APIResponse & {
+  bans: FutureChannelBan[];
+};
+
+export type QueryFutureChannelBansOptions = {
+  user_id?: string;
+  target_user_id?: string;
+  exclude_expired_bans?: boolean;
+  limit?: number;
+  offset?: number;
+};
+
 export type BlockListResponse = BlockList & {
   created_at?: string;
   type?: string;
@@ -994,6 +1014,7 @@ export type BannedUsersPaginationOptions = Omit<
 };
 
 export type BanUserOptions = UnBanUserOptions & {
+  ban_from_future_channels?: boolean;
   banned_by?: UserResponse;
   banned_by_id?: string;
   ip_ban?: boolean;
@@ -1011,6 +1032,21 @@ export type ChannelOptions = {
   state?: boolean;
   user_id?: string;
   watch?: boolean;
+  /**
+   * Name of a predefined filter to use instead of filter_conditions.
+   * When provided, filter_conditions and sort parameters are ignored.
+   */
+  predefined_filter?: string;
+  /**
+   * Values to interpolate into the predefined filter template placeholders.
+   * Only used when predefined_filter is provided.
+   */
+  filter_values?: Record<string, unknown>;
+  /**
+   * Values to interpolate into the predefined filter sort template placeholders.
+   * Only used when predefined_filter is provided.
+   */
+  sort_values?: Record<string, unknown>;
 };
 
 export type ChannelQueryOptions = {
@@ -1478,6 +1514,7 @@ export type UnBanUserOptions = {
   client_id?: string;
   connection_id?: string;
   id?: string;
+  remove_future_channels_ban?: boolean;
   shadow?: boolean;
   target_user_id?: string;
   type?: string;
@@ -4495,3 +4532,101 @@ export type EventHook = {
   created_at?: string;
   updated_at?: string;
 };
+
+export type BatchUpdateOperation =
+  | 'addMembers'
+  | 'removeMembers'
+  | 'inviteMembers'
+  | 'assignRoles'
+  | 'addModerators'
+  | 'demoteModerators'
+  | 'hide'
+  | 'show'
+  | 'archive'
+  | 'unarchive'
+  | 'updateData'
+  | 'addFilterTags'
+  | 'removeFilterTags';
+
+export type BatchChannelDataUpdate = {
+  frozen?: boolean;
+  disabled?: boolean;
+  custom?: Record<string, unknown>;
+  team?: string;
+  config_overrides?: Record<string, unknown>;
+  auto_translation_enabled?: boolean;
+  auto_translation_language?: string;
+};
+
+export type UpdateChannelsBatchOptions = {
+  operation: BatchUpdateOperation;
+  filter: UpdateChannelsBatchFilters;
+  members?: string[] | Array<NewMemberPayload>;
+  data?: BatchChannelDataUpdate;
+  filter_tags_update?: string[];
+};
+
+export type UpdateChannelsBatchFilters = QueryFilters<{
+  cids?:
+    | RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$eq'>>
+    | PrimitiveFilter<string[]>;
+  types?:
+    | RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$eq'>>
+    | PrimitiveFilter<string[]>;
+  filter_tags?:
+    | RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$eq'>>
+    | PrimitiveFilter<Record<string, string>>;
+}>;
+
+export type UpdateChannelsBatchResponse = {
+  result: Record<string, string>;
+} & Partial<TaskResponse>;
+
+/**
+ * Predefined Filter Types
+ */
+
+export type PredefinedFilterOperation = 'QueryChannels';
+
+export type PredefinedFilterSortParam = {
+  field: string;
+  direction?: AscDesc;
+  type?: string;
+};
+
+export type PredefinedFilter = {
+  name: string;
+  operation: PredefinedFilterOperation;
+  filter: Record<string, unknown>;
+  created_at: string;
+  updated_at: string;
+  description?: string;
+  sort?: PredefinedFilterSortParam[];
+  query_id?: number;
+};
+
+export type CreatePredefinedFilterOptions = {
+  name: string;
+  operation: PredefinedFilterOperation;
+  filter: Record<string, unknown>;
+  description?: string;
+  sort?: PredefinedFilterSortParam[];
+};
+
+export type UpdatePredefinedFilterOptions = Omit<CreatePredefinedFilterOptions, 'name'>;
+
+export type PredefinedFilterResponse = APIResponse & {
+  predefined_filter: PredefinedFilter;
+};
+
+export type ListPredefinedFiltersResponse = APIResponse & {
+  predefined_filters: PredefinedFilter[];
+  next?: string;
+  prev?: string;
+};
+
+export type PredefinedFilterSort = SortParam[];
+
+export type ListPredefinedFiltersOptions = Pager & {
+  sort?: PredefinedFilterSort;
+};