stream-chat 8.42.0 → 8.43.0

package/src/moderation.ts

@@ -15,6 +15,9 @@ import {
   ModerationMuteOptions,
   GetUserModerationReportOptions,
   SubmitActionOptions,
+  QueryModerationConfigsFilters,
+  QueryModerationConfigsSort,
+  Pager,
 } from './types';
 import { StreamChat } from './client';
 import { normalizeQuerySort } from './utils';
@@ -181,6 +184,28 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
     return await this.client.get<GetConfigResponse>(this.client.baseURL + '/api/v2/moderation/config/' + key);
   }
 
+  async deleteConfig(key: string) {
+    return await this.client.delete(this.client.baseURL + '/api/v2/moderation/config/' + key);
+  }
+
+  /**
+   * Query moderation configs
+   * @param {Object} filterConditions Filter conditions for querying moderation configs
+   * @param {Object} sort Sort conditions for querying moderation configs
+   * @param {Object} options Additional options for querying moderation configs
+   */
+  async queryConfigs(
+    filterConditions: QueryModerationConfigsFilters,
+    sort: QueryModerationConfigsSort,
+    options: Pager = {},
+  ) {
+    return await this.client.post(this.client.baseURL + '/api/v2/moderation/configs', {
+      filter: filterConditions,
+      sort,
+      ...options,
+    });
+  }
+
   async submitAction(actionType: string, itemID: string, options: SubmitActionOptions = {}) {
     return await this.client.post<{ item_id: string } & APIResponse>(
       this.client.baseURL + '/api/v2/moderation/submit_action',
@@ -191,4 +216,43 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
       },
     );
   }
+
+  /**
+   *
+   * @param {string} entityType string Type of entity to be checked E.g., stream:user, stream:chat:v1:message, or any custom string
+   * @param {string} entityID string ID of the entity to be checked. This is mainly for tracking purposes
+   * @param {string} entityCreatorID string ID of the entity creator
+   * @param {object} moderationPayload object Content to be checked for moderation. E.g., { texts: ['text1', 'text2'], images: ['image1', 'image2']}
+   * @param {Array} moderationPayload.texts array Array of texts to be checked for moderation
+   * @param {Array} moderationPayload.images array Array of images to be checked for moderation
+   * @param {Array} moderationPayload.videos array Array of videos to be checked for moderation
+   * @param configKey
+   * @param options
+   * @returns
+   */
+  async check(
+    entityType: string,
+    entityID: string,
+    entityCreatorID: string,
+    moderationPayload: {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      custom?: Record<string, any>;
+      images?: string[];
+      texts?: string[];
+      videos?: string[];
+    },
+    configKey: string,
+    options?: {
+      force_sync?: boolean;
+    },
+  ) {
+    return await this.client.post(this.client.baseURL + `/api/v2/moderation/check`, {
+      entity_type: entityType,
+      entity_id: entityID,
+      entity_creator_id: entityCreatorID,
+      moderation_payload: moderationPayload,
+      config_key: configKey,
+      options,
+    });
+  }
 }

package/src/types.ts

@@ -331,7 +331,14 @@ export type ChannelMemberAPIResponse<StreamChatGenerics extends ExtendableGeneri
   members: ChannelMemberResponse<StreamChatGenerics>[];
 };
 
+export type ChannelMemberUpdates = {
+  archived?: boolean;
+  channel_role?: Role;
+  pinned?: boolean;
+};
+
 export type ChannelMemberResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  archived_at?: string;
   ban_expires?: string;
   banned?: boolean;
   channel_role?: Role;
@@ -341,6 +348,7 @@ export type ChannelMemberResponse<StreamChatGenerics extends ExtendableGenerics
   invited?: boolean;
   is_moderator?: boolean;
   notifications_muted?: boolean;
+  pinned_at?: string;
   role?: string;
   shadow_banned?: boolean;
   status?: string;
@@ -349,6 +357,12 @@ export type ChannelMemberResponse<StreamChatGenerics extends ExtendableGenerics
   user_id?: string;
 };
 
+export type PartialUpdateMemberAPIResponse<
+  StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
+> = APIResponse & {
+  channel_member: ChannelMemberResponse<StreamChatGenerics>;
+};
+
 export type CheckPushResponse = APIResponse & {
   device_errors?: {
     [deviceID: string]: {
@@ -1487,6 +1501,9 @@ export type ChannelFilters<StreamChatGenerics extends ExtendableGenerics = Defau
               userType: StreamChatGenerics['userType'];
             }>[Key]
           >;
+    } & {
+      archived?: boolean;
+      pinned?: boolean;
     }
 >;
 
@@ -1800,7 +1817,8 @@ export type ReactionSortBase<StreamChatGenerics extends ExtendableGenerics = Def
 
 export type ChannelSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> =
   | ChannelSortBase<StreamChatGenerics>
-  | Array<ChannelSortBase<StreamChatGenerics>>;
+  | Array<ChannelSortBase<StreamChatGenerics>>
+  | { pinned_at: AscDesc };
 
 export type ChannelSortBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<
   StreamChatGenerics['channelType']
@@ -2491,9 +2509,9 @@ export type PartialUpdateChannel<StreamChatGenerics extends ExtendableGenerics =
   unset?: Array<keyof ChannelResponse<StreamChatGenerics>>;
 };
 
-export type PartialUpdateMember<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
-  set?: Partial<ChannelMemberResponse<StreamChatGenerics>>;
-  unset?: Array<keyof ChannelMemberResponse<StreamChatGenerics>>;
+export type PartialUpdateMember = {
+  set?: ChannelMemberUpdates;
+  unset?: Array<keyof ChannelMemberUpdates>;
 };
 
 export type PartialUserUpdate<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
@@ -3303,6 +3321,16 @@ export type GetUserModerationReportResponse<StreamChatGenerics extends Extendabl
   user_mutes?: Mute<StreamChatGenerics>[];
 };
 
+export type QueryModerationConfigsFilters = QueryFilters<
+  {
+    key?: string;
+  } & {
+    created_at?: PrimitiveFilter<string>;
+  } & {
+    updated_at?: PrimitiveFilter<string>;
+  }
+>;
+
 export type ReviewQueueFilters = QueryFilters<
   {
     assigned_to?:
@@ -3359,6 +3387,8 @@ export type ReviewQueueSort =
   | Sort<Pick<ReviewQueueItem, 'id' | 'created_at' | 'updated_at'>>
   | Array<Sort<Pick<ReviewQueueItem, 'id' | 'created_at' | 'updated_at'>>>;
 
+export type QueryModerationConfigsSort = Array<Sort<'key' | 'created_at' | 'updated_at'>>;
+
 export type ReviewQueuePaginationOptions = Pager;
 
 export type ReviewQueueResponse = {