From 1d8f3bb1fde3036f511b029fed72cb705998309f Mon Sep 17 00:00:00 2001
From: Vishal Narkhede <vishalnarkhede.iitd@gmail.com>
Date: Thu, 27 Mar 2025 07:52:24 +0100
Subject: [PATCH 1/6] feat: username moderation endpoint

---
 src/moderation.ts | 48 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/src/moderation.ts b/src/moderation.ts
index d9be41da4..af9f3cbbc 100644
--- a/src/moderation.ts
+++ b/src/moderation.ts
@@ -28,6 +28,7 @@ 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 +248,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 +261,52 @@ 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 weather to allow certain user profile to be created or not.
+   *
+   * Example:
+   *
+   * ```ts
+   * const res = await client.moderation.checkUserProfile(userId, { username: "fuck_boy_001", profileImage: "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 username
+   * @param profileImage
+   * @returns
+   */
+  async checkUserProfile(userId: string, profile: { profileImage?: string, username?: string; } = {}) {
+    if (!profile.username && !profile.profileImage) {
+      throw new Error('Either username or profileImage must be provided');
+    }
+
+    return await this.check(
+      MODERATION_ENTITY_TYPES.userprofile,
+      userId,
+      userId,
+      {
+        texts: [profile.username as string],
+        images: [profile.profileImage as string],
+      },
+      '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

From 79d888a2b69644b69b033d0b6f54f0423ab76a7c Mon Sep 17 00:00:00 2001
From: Vishal Narkhede <vishalnarkhede.iitd@gmail.com>
Date: Thu, 27 Mar 2025 12:00:03 +0100
Subject: [PATCH 2/6] refactor: lint fix

---
 src/moderation.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/moderation.ts b/src/moderation.ts
index af9f3cbbc..60fd65020 100644
--- a/src/moderation.ts
+++ b/src/moderation.ts
@@ -286,7 +286,7 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param profileImage
    * @returns
    */
-  async checkUserProfile(userId: string, profile: { profileImage?: string, username?: string; } = {}) {
+  async checkUserProfile(userId: string, profile: { profileImage?: string; username?: string } = {}) {
     if (!profile.username && !profile.profileImage) {
       throw new Error('Either username or profileImage must be provided');
     }

From 7379c02370040cf94303c0a42b4615496da2390e Mon Sep 17 00:00:00 2001
From: Vishal Narkhede <vishalnarkhede.iitd@gmail.com>
Date: Thu, 27 Mar 2025 12:16:46 +0100
Subject: [PATCH 3/6] refactor: fix comment

Co-authored-by: Santhosh Vaiyapuri <3846977+santhoshvai@users.noreply.github.com>
---
 src/moderation.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/moderation.ts b/src/moderation.ts
index 60fd65020..1d0d89250 100644
--- a/src/moderation.ts
+++ b/src/moderation.ts
@@ -268,7 +268,7 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
    *
    * 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 weather to allow certain user profile to be created or not.
+   * You can just use this to check whether to allow a certain user profile to be created or not.
    *
    * Example:
    *

From c06c0e90cad95922c3df7323ac4b8a2aa2306188 Mon Sep 17 00:00:00 2001
From: Vishal Narkhede <vishalnarkhede.iitd@gmail.com>
Date: Thu, 27 Mar 2025 12:24:54 +0100
Subject: [PATCH 4/6] refactor: some changes

---
 src/moderation.ts | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/src/moderation.ts b/src/moderation.ts
index 60fd65020..321969a1e 100644
--- a/src/moderation.ts
+++ b/src/moderation.ts
@@ -21,6 +21,7 @@ import {
   CustomCheckFlag,
   ReviewQueueItem,
   QueryConfigsResponse,
+  RequireAtLeastOne,
 } from './types';
 import { StreamChat } from './client';
 import { normalizeQuerySort } from './utils';
@@ -273,7 +274,7 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * Example:
    *
    * ```ts
-   * const res = await client.moderation.checkUserProfile(userId, { username: "fuck_boy_001", profileImage: "https://example.com/profile.jpg" });
+   * 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 {
@@ -282,13 +283,13 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * ```
    *
    * @param userId
-   * @param username
-   * @param profileImage
+   * @param profile.username
+   * @param profile.image
    * @returns
    */
-  async checkUserProfile(userId: string, profile: { profileImage?: string; username?: string } = {}) {
-    if (!profile.username && !profile.profileImage) {
-      throw new Error('Either username or profileImage must be provided');
+  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');
     }
 
     return await this.check(
@@ -297,7 +298,7 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
       userId,
       {
         texts: [profile.username as string],
-        images: [profile.profileImage as string],
+        images: [profile.image as string],
       },
       'user_profile:default',
       {

From 3e3c1134df4dcf7f5c485be98b70ce7f5bc334c6 Mon Sep 17 00:00:00 2001
From: Vishal Narkhede <vishalnarkhede.iitd@gmail.com>
Date: Thu, 27 Mar 2025 12:26:58 +0100
Subject: [PATCH 5/6] refactor: avoid undefined

---
 src/moderation.ts | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/src/moderation.ts b/src/moderation.ts
index d9b24c151..bc2eeff80 100644
--- a/src/moderation.ts
+++ b/src/moderation.ts
@@ -292,14 +292,19 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
       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,
-      {
-        texts: [profile.username as string],
-        images: [profile.image as string],
-      },
+      moderationPayload,
       'user_profile:default',
       {
         force_sync: true,

From d6ccd560923ea524dd4a17ad32bb32096dc909ae Mon Sep 17 00:00:00 2001
From: Vishal Narkhede <vishalnarkhede.iitd@gmail.com>
Date: Thu, 27 Mar 2025 12:30:08 +0100
Subject: [PATCH 6/6] refactor: lint fix

---
 src/moderation.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/moderation.ts b/src/moderation.ts
index bc2eeff80..6cf225f47 100644
--- a/src/moderation.ts
+++ b/src/moderation.ts
@@ -292,7 +292,7 @@ export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultG
       throw new Error('Either username or image must be provided');
     }
 
-    const moderationPayload: { images?: string[], texts?: string[]; } = {};
+    const moderationPayload: { images?: string[]; texts?: string[] } = {};
     if (profile.username) {
       moderationPayload.texts = [profile.username];
     }