feat: user profile check endpoint (#1503)

- [ ] I have signed the [Stream
CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform)
(required).
- [ ] Code changes are tested

- Added a new endpoint for moderation `checkUserProfile`
- Have added clear warning in description that this is subject to
introducing breaking changes.
- Backend PR: GetStream/chat#8424

---------

Co-authored-by: Santhosh Vaiyapuri <[email protected]>

Author: 2 people

src/moderation.ts

@@ -21,13 +21,15 @@ import {
   CustomCheckFlag,
   ReviewQueueItem,
   QueryConfigsResponse,
+  RequireAtLeastOne,
 } from './types';
 import { StreamChat } from './client';
 import { normalizeQuerySort } from './utils';
 
 export const MODERATION_ENTITY_TYPES = {
   user: 'stream:user',
   message: 'stream:chat:v1:message',
+  userprofile: 'stream:v1:user_profile',
 };
 
 // Moderation class provides all the endpoints related to moderation v2.
@@ -247,6 +249,7 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
     configKey: string,
     options?: {
       force_sync?: boolean;
+      test_mode?: boolean;
     },
   ) {
     return await this.client.post(this.client.baseURL + `/api/v2/moderation/check`, {
@@ -259,6 +262,57 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
     });
   }
 
+  /**
+   * Experimental: Check user profile
+   *
+   * Warning: This is an experimental feature and the API is subject to change.
+   *
+   * This function is used to check a user profile for moderation.
+   * This will not create any review queue items for the user profile.
+   * You can just use this to check whether to allow a certain user profile to be created or not.
+   *
+   * Example:
+   *
+   * ```ts
+   * const res = await client.moderation.checkUserProfile(userId, { username: "fuck_boy_001", image: "https://example.com/profile.jpg" });
+   * if (res.recommended_action === "remove") {
+   *   // Block the user profile from being created
+   * } else {
+   *   // Allow the user profile to be created
+   * }
+   * ```
+   *
+   * @param userId
+   * @param profile.username
+   * @param profile.image
+   * @returns
+   */
+  async checkUserProfile(userId: string, profile: RequireAtLeastOne<{ image?: string; username?: string }>) {
+    if (!profile.username && !profile.image) {
+      throw new Error('Either username or image must be provided');
+    }
+
+    const moderationPayload: { images?: string[]; texts?: string[] } = {};
+    if (profile.username) {
+      moderationPayload.texts = [profile.username];
+    }
+    if (profile.image) {
+      moderationPayload.images = [profile.image];
+    }
+
+    return await this.check(
+      MODERATION_ENTITY_TYPES.userprofile,
+      userId,
+      userId,
+      moderationPayload,
+      'user_profile:default',
+      {
+        force_sync: true,
+        test_mode: true,
+      },
+    );
+  }
+
   /**
    *
    * @param {string} entityType string Type of entity to be checked E.g., stream:user, stream:chat:v1:message, or any custom string