feat(moderation): add custom check API (#1411)

Co-authored-by: Vishal Narkhede <[email protected]>

src/moderation.ts

@@ -18,6 +18,8 @@ import {
   QueryModerationConfigsFilters,
   QueryModerationConfigsSort,
   Pager,
+  CustomCheckFlag,
+  ReviewQueueItem,
 } from './types';
 import { StreamChat } from './client';
 import { normalizeQuerySort } from './utils';
@@ -255,4 +257,49 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
       options,
     });
   }
+
+  /**
+   *
+   * @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 {Array<CustomCheckFlag>} flags Array of CustomCheckFlag to be passed to flag the entity
+   * @returns
+   */
+  async addCustomFlags(
+    entityType: string,
+    entityID: string,
+    entityCreatorID: string,
+    moderationPayload: {
+      images?: string[];
+      texts?: string[];
+      videos?: string[];
+    },
+    flags: CustomCheckFlag[],
+  ) {
+    return await this.client.post<{ id: string; item: ReviewQueueItem; status: string } & APIResponse>(
+      this.client.baseURL + `/api/v2/moderation/custom_check`,
+      {
+        entity_type: entityType,
+        entity_id: entityID,
+        entity_creator_id: entityCreatorID,
+        moderation_payload: moderationPayload,
+        flags,
+      },
+    );
+  }
+
+  /**
+   * Add custom flags to a message
+   * @param {string} messageID Message ID to be flagged
+   * @param {Array<CustomCheckFlag>} flags Array of CustomCheckFlag to be passed to flag the message
+   * @returns
+   */
+  async addCustomMessageFlags(messageID: string, flags: CustomCheckFlag[]) {
+    return await this.addCustomFlags(MODERATION_ENTITY_TYPES.message, messageID, '', {}, flags);
+  }
 }

src/types.ts

@@ -3420,6 +3420,14 @@ export type ReviewQueueItem = {
   updated_at: string;
 };
 
+export type CustomCheckFlag = {
+  type: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  custom?: Record<string, any>[];
+  labels?: string[];
+  reason?: string;
+};
+
 export type SubmitActionOptions = {
   ban?: {
     channel_ban_only?: boolean;