stream-chat 8.37.0 → 8.38.0

package/src/client.ts

@@ -206,6 +206,7 @@ import {
 } from './types';
 import { InsightMetrics, postInsights } from './insights';
 import { Thread } from './thread';
+import { Moderation } from './moderation';
 
 function isString(x: unknown): x is string {
   return typeof x === 'string' || x instanceof String;
@@ -239,6 +240,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * manually calling queryChannels endpoint.
    */
   recoverStateOnReconnect?: boolean;
+  moderation: Moderation<StreamChatGenerics>;
   mutedChannels: ChannelMute<StreamChatGenerics>[];
   mutedUsers: Mute<StreamChatGenerics>[];
   node: boolean;
@@ -290,6 +292,8 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     this.mutedChannels = [];
     this.mutedUsers = [];
 
+    this.moderation = new Moderation(this);
+
     // set the secret
     if (secretOrOptions && isString(secretOrOptions)) {
       this.secret = secretOrOptions;
@@ -320,11 +324,11 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
 
     this.setBaseURL(this.options.baseURL || 'https://chat.stream-io-api.com');
 
-    if (typeof process !== 'undefined' && process.env.STREAM_LOCAL_TEST_RUN) {
+    if (typeof process !== 'undefined' && 'env' in process && process.env.STREAM_LOCAL_TEST_RUN) {
       this.setBaseURL('http://localhost:3030');
     }
 
-    if (typeof process !== 'undefined' && process.env.STREAM_LOCAL_TEST_HOST) {
+    if (typeof process !== 'undefined' && 'env' in process && process.env.STREAM_LOCAL_TEST_HOST) {
       this.setBaseURL('http://' + process.env.STREAM_LOCAL_TEST_HOST);
     }
 
@@ -2258,7 +2262,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param {string} [options.user_id] currentUserID, only used with serverside auth
    * @returns {Promise<APIResponse>}
    */
-  async flagMessage(targetMessageID: string, options: { user_id?: string } = {}) {
+  async flagMessage(targetMessageID: string, options: { reason?: string; user_id?: string } = {}) {
     return await this.post<FlagMessageResponse<StreamChatGenerics>>(this.baseURL + '/moderation/flag', {
       target_message_id: targetMessageID,
       ...options,
@@ -2271,7 +2275,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param {string} [options.user_id] currentUserID, only used with serverside auth
    * @returns {Promise<APIResponse>}
    */
-  async flagUser(targetID: string, options: { user_id?: string } = {}) {
+  async flagUser(targetID: string, options: { reason?: string; user_id?: string } = {}) {
     return await this.post<FlagUserResponse<StreamChatGenerics>>(this.baseURL + '/moderation/flag', {
       target_user_id: targetID,
       ...options,
@@ -3488,44 +3492,58 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   /**
    * Creates a poll
    * @param params PollData The poll that will be created
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & CreatePollAPIResponse} The poll
    */
-  async createPoll(poll: PollData) {
-    return await this.post<APIResponse & CreatePollAPIResponse>(this.baseURL + `/polls`, poll);
+  async createPoll(poll: PollData, userId?: string) {
+    return await this.post<APIResponse & CreatePollAPIResponse>(this.baseURL + `/polls`, {
+      ...poll,
+      ...(userId ? { user_id: userId } : {}),
+    });
   }
 
   /**
    * Retrieves a poll
    * @param id string The poll id
+   *  @param userId string The user id (only serverside)
    * @returns {APIResponse & GetPollAPIResponse} The poll
    */
   async getPoll(id: string, userId?: string): Promise<APIResponse & GetPollAPIResponse> {
-    return await this.get<APIResponse & GetPollAPIResponse>(this.baseURL + `/polls/${id}`, {
-      ...(userId ? { user_id: userId } : {}),
-    });
+    return await this.get<APIResponse & GetPollAPIResponse>(this.baseURL + `/polls/${id}`, 
+      userId ? { user_id: userId } : {}
+    );
   }
 
   /**
    * Updates a poll
    * @param poll PollData The poll that will be updated
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & PollResponse} The poll
    */
-  async updatePoll(poll: PollData) {
-    return await this.put<APIResponse & UpdatePollAPIResponse>(this.baseURL + `/polls`, poll);
+  async updatePoll(poll: PollData, userId?: string) {
+    return await this.put<APIResponse & UpdatePollAPIResponse>(this.baseURL + `/polls`, {
+      ...poll,
+      ...(userId ? { user_id: userId } : {})
+    });
   }
 
   /**
    * Partially updates a poll
    * @param id string The poll id
    * @param {PartialPollUpdate<StreamChatGenerics>} partialPollObject which should contain id and any of "set" or "unset" params;
+   * @param userId string The user id (only serverside)
    * example: {id: "44f26af5-f2be-4fa7-9dac-71cf893781de", set:{field: value}, unset:["field2"]}
    * @returns {APIResponse & UpdatePollAPIResponse} The poll
    */
   async partialUpdatePoll(
     id: string,
     partialPollObject: PartialPollUpdate,
+    userId?: string
   ): Promise<APIResponse & UpdatePollAPIResponse> {
-    return await this.patch<APIResponse & UpdatePollAPIResponse>(this.baseURL + `/polls/${id}`, partialPollObject);
+    return await this.patch<APIResponse & UpdatePollAPIResponse>(this.baseURL + `/polls/${id}`, {
+      ...partialPollObject,
+      ...(userId ? { user_id: userId } : {})
+    });
   }
 
   /**
@@ -3543,13 +3561,15 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   /**
    * Close a poll
    * @param id string The poll id
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & UpdatePollAPIResponse} The poll
    */
-  async closePoll(id: string): Promise<APIResponse & UpdatePollAPIResponse> {
+  async closePoll(id: string, userId?: string): Promise<APIResponse & UpdatePollAPIResponse> {
     return this.partialUpdatePoll(id, {
       set: {
         is_closed: true,
       },
+      ...(userId ? { user_id: userId } : {})
     });
   }
 
@@ -3557,45 +3577,52 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * Creates a poll option
    * @param pollId string The poll id
    * @param option PollOptionData The poll option that will be created
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & PollOptionResponse} The poll option
    */
-  async createPollOption(pollId: string, option: PollOptionData) {
+  async createPollOption(pollId: string, option: PollOptionData, userId?: string) {
     return await this.post<APIResponse & CreatePollOptionAPIResponse>(
-      this.baseURL + `/polls/${pollId}/options`,
-      option,
-    );
+      this.baseURL + `/polls/${pollId}/options`, {
+        ...option,
+        ...(userId ? { user_id: userId } : {})
+    });
   }
 
   /**
    * Retrieves a poll option
    * @param pollId string The poll id
    * @param optionId string The poll option id
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & PollOptionResponse} The poll option
    */
-  async getPollOption(pollId: string, optionId: string) {
+  async getPollOption(pollId: string, optionId: string, userId?: string) {
     return await this.get<APIResponse & GetPollOptionAPIResponse>(
-      this.baseURL + `/polls/${pollId}/options/${optionId}`,
-    );
+      this.baseURL + `/polls/${pollId}/options/${optionId}`, userId ? { user_id: userId } : {});
   }
 
   /**
    * Updates a poll option
    * @param pollId string The poll id
    * @param option PollOptionData The poll option that will be updated
+   * @param userId string The user id (only serverside)
    * @returns
    */
-  async updatePollOption(pollId: string, option: PollOptionData) {
-    return await this.put<APIResponse & UpdatePollOptionAPIResponse>(this.baseURL + `/polls/${pollId}/options`, option);
+  async updatePollOption(pollId: string, option: PollOptionData, userId?: string) {
+    return await this.put<APIResponse & UpdatePollOptionAPIResponse>(this.baseURL + `/polls/${pollId}/options`, {
+      ...option,
+      ...(userId ? { user_id: userId } : {}),
+    });
   }
 
   /**
    * Delete a poll option
    * @param pollId string The poll id
    * @param optionId string The poll option id
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse} The poll option
    */
-  async deletePollOption(pollId: string, optionId: string) {
-    return await this.delete<APIResponse>(this.baseURL + `/polls/${pollId}/options/${optionId}`);
+  async deletePollOption(pollId: string, optionId: string, userId?: string) {
+    return await this.delete<APIResponse>(this.baseURL + `/polls/${pollId}/options/${optionId}`, userId ? { user_id: userId } : {});
   }
 
   /**
@@ -3603,12 +3630,15 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param messageId string The message id
    * @param pollId string The poll id
    * @param vote PollVoteData The vote that will be casted
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & CastVoteAPIResponse} The poll vote
    */
-  async castPollVote(messageId: string, pollId: string, vote: PollVoteData, options = {}) {
+  async castPollVote(messageId: string, pollId: string, vote: PollVoteData, userId?: string) {
     return await this.post<APIResponse & CastVoteAPIResponse>(
-      this.baseURL + `/messages/${messageId}/polls/${pollId}/vote`,
-      { vote, ...options },
+      this.baseURL + `/messages/${messageId}/polls/${pollId}/vote`, {
+        vote,
+        ...(userId ? { user_id: userId } : {}),
+      },
     );
   }
 
@@ -3617,17 +3647,19 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param messageId string The message id
    * @param pollId string The poll id
    * @param answerText string The answer text
+   * @param userId string The user id (only serverside)
    */
-  async addPollAnswer(messageId: string, pollId: string, answerText: string) {
+  async addPollAnswer(messageId: string, pollId: string, answerText: string, userId?: string) {
     return this.castPollVote(messageId, pollId, {
       answer_text: answerText,
-    });
+    }, userId);
   }
 
-  async removePollVote(messageId: string, pollId: string, voteId: string) {
+  async removePollVote(messageId: string, pollId: string, voteId: string, userId?: string) {
     return await this.delete<APIResponse & { vote: PollVote }>(
-      this.baseURL + `/messages/${messageId}/polls/${pollId}/vote/${voteId}`,
-    );
+      this.baseURL + `/messages/${messageId}/polls/${pollId}/vote/${voteId}`, {
+      ...(userId ? { user_id: userId } : {}),
+    });
   }
 
   /**
@@ -3635,14 +3667,17 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param filter
    * @param sort
    * @param options Option object, {limit: 10, offset:0}
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & QueryPollsResponse} The polls
    */
   async queryPolls(
     filter: QueryPollsFilters = {},
     sort: PollSort = [],
     options: QueryPollsOptions = {},
+    userId?: string
   ): Promise<APIResponse & QueryPollsResponse> {
-    return await this.post<APIResponse & QueryPollsResponse>(this.baseURL + '/polls/query', {
+    const q = userId ? `?user_id=${userId}` : ''; 
+    return await this.post<APIResponse & QueryPollsResponse>(this.baseURL + `/polls/query${q}`, {
       filter,
       sort: normalizeQuerySort(sort),
       ...options,
@@ -3655,7 +3690,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param filter
    * @param sort
    * @param options Option object, {limit: 10, offset:0}
-
+   * @param userId string The user id (only serverside)
    * @returns {APIResponse & PollVotesAPIResponse} The poll votes
    */
   async queryPollVotes(
@@ -3663,8 +3698,10 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     filter: QueryVotesFilters = {},
     sort: VoteSort = [],
     options: QueryVotesOptions = {},
+    userId?: string
   ): Promise<APIResponse & PollVotesAPIResponse> {
-    return await this.post<APIResponse & PollVotesAPIResponse>(this.baseURL + `/polls/${pollId}/votes`, {
+    const q = userId ? `?user_id=${userId}` : ''; 
+    return await this.post<APIResponse & PollVotesAPIResponse>(this.baseURL + `/polls/${pollId}/votes${q}`, {
       filter,
       sort: normalizeQuerySort(sort),
       ...options,
@@ -3672,7 +3709,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   }
 
   /**
-   * Queries message histories
+   * Query message history
    * @param filter
    * @param sort
    * @param options Option object, {limit: 10}

package/src/index.ts

@@ -6,6 +6,7 @@ export * from './channel_state';
 export * from './thread';
 export * from './connection';
 export * from './events';
+export * from './moderation';
 export * from './permissions';
 export * from './signing';
 export * from './token_manager';

package/src/moderation.ts

@@ -0,0 +1,194 @@
+import {
+  APIResponse,
+  ModerationConfig,
+  DefaultGenerics,
+  ExtendableGenerics,
+  GetConfigResponse,
+  GetUserModerationReportResponse,
+  MuteUserResponse,
+  ReviewQueueFilters,
+  ReviewQueuePaginationOptions,
+  ReviewQueueResponse,
+  ReviewQueueSort,
+  UpsertConfigResponse,
+  ModerationFlagOptions,
+  ModerationMuteOptions,
+  GetUserModerationReportOptions,
+  SubmitActionOptions,
+} from './types';
+import { StreamChat } from './client';
+import { normalizeQuerySort } from './utils';
+
+export const MODERATION_ENTITY_TYPES = {
+  user: 'stream:user',
+  message: 'stream:chat:v1:message',
+};
+
+// Moderation class provides all the endpoints related to moderation v2.
+export class Moderation<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> {
+  client: StreamChat<StreamChatGenerics>;
+
+  constructor(client: StreamChat<StreamChatGenerics>) {
+    this.client = client;
+  }
+
+  /**
+   * Flag a user
+   *
+   * @param {string} flaggedUserID User ID to be flagged
+   * @param {string} reason Reason for flagging the user
+   * @param {Object} options Additional options for flagging the user
+   * @param {string} options.user_id (For server side usage) User ID of the user who is flagging the target user
+   * @param {Object} options.custom Additional data to be stored with the flag
+   * @returns
+   */
+  async flagUser(flaggedUserID: string, reason: string, options: ModerationFlagOptions = {}) {
+    return this.flag(MODERATION_ENTITY_TYPES.user, flaggedUserID, '', reason, options);
+  }
+
+  /**
+   * Flag a message
+   *
+   * @param {string} messageID Message ID to be flagged
+   * @param {string} reason Reason for flagging the message
+   * @param {Object} options Additional options for flagging the message
+   * @param {string} options.user_id (For server side usage) User ID of the user who is flagging the target message
+   * @param {Object} options.custom Additional data to be stored with the flag
+   * @returns
+   */
+  async flagMessage(messageID: string, reason: string, options: ModerationFlagOptions = {}) {
+    return this.flag(MODERATION_ENTITY_TYPES.message, messageID, '', reason, options);
+  }
+
+  /**
+   * Flag a user
+   *
+   * @param {string} entityType Entity type to be flagged
+   * @param {string} entityId Entity ID to be flagged
+   * @param {string} entityCreatorID User ID of the entity creator
+   * @param {string} reason Reason for flagging the entity
+   * @param {Object} options Additional options for flagging the entity
+   * @param {string} options.user_id (For server side usage) User ID of the user who is flagging the target entity
+   * @param {Object} options.moderation_payload Content to be flagged e.g., { texts: ['text1', 'text2'], images: ['image1', 'image2']}
+   * @param {Object} options.custom Additional data to be stored with the flag
+   * @returns
+   */
+  async flag(
+    entityType: string,
+    entityId: string,
+    entityCreatorID: string,
+    reason: string,
+    options: ModerationFlagOptions = {},
+  ) {
+    return await this.client.post<{ item_id: string } & APIResponse>(this.client.baseURL + '/api/v2/moderation/flag', {
+      entity_type: entityType,
+      entity_id: entityId,
+      entity_creator_id: entityCreatorID,
+      reason,
+      ...options,
+    });
+  }
+
+  /**
+   * Mute a user
+   * @param {string} targetID  User ID to be muted
+   * @param {Object} options Additional options for muting the user
+   * @param {string} options.user_id (For server side usage) User ID of the user who is muting the target user
+   * @param {number} options.timeout Timeout for the mute in minutes
+   * @returns
+   */
+  async muteUser(targetID: string, options: ModerationMuteOptions = {}) {
+    return await this.client.post<MuteUserResponse<StreamChatGenerics> & APIResponse>(
+      this.client.baseURL + '/api/v2/moderation/mute',
+      {
+        target_ids: [targetID],
+        ...options,
+      },
+    );
+  }
+
+  /**
+   * Unmute a user
+   * @param {string} targetID  User ID to be unmuted
+   * @param {Object} options Additional options for unmuting the user
+   * @param {string} options.user_id (For server side usage) User ID of the user who is unmuting the target user
+   * @returns
+   */
+  async unmuteUser(
+    targetID: string,
+    options: {
+      user_id?: string;
+    },
+  ) {
+    return await this.client.post<{ item_id: string } & APIResponse>(
+      this.client.baseURL + '/api/v2/moderation/unmute',
+      {
+        target_ids: [targetID],
+        ...options,
+      },
+    );
+  }
+
+  /**
+   * Get moderation report for a user
+   * @param {string} userID User ID for which moderation report is to be fetched
+   * @param {Object} options Additional options for fetching the moderation report
+   * @param {boolean} options.create_user_if_not_exists Create user if not exists
+   * @param {boolean} options.include_user_blocks Include user blocks
+   * @param {boolean} options.include_user_mutes Include user mutes
+   */
+  async getUserModerationReport(userID: string, options: GetUserModerationReportOptions = {}) {
+    return await this.client.get<GetUserModerationReportResponse<StreamChatGenerics>>(
+      this.client.baseURL + `/api/v2/moderation/user_report`,
+      {
+        user_id: userID,
+        ...options,
+      },
+    );
+  }
+
+  /**
+   * Query review queue
+   * @param {Object} filterConditions Filter conditions for querying review queue
+   * @param {Object} sort Sort conditions for querying review queue
+   * @param {Object} options Pagination options for querying review queue
+   */
+  async queryReviewQueue(
+    filterConditions: ReviewQueueFilters = {},
+    sort: ReviewQueueSort = [],
+    options: ReviewQueuePaginationOptions = {},
+  ) {
+    return await this.client.post<ReviewQueueResponse>(this.client.baseURL + '/api/v2/moderation/review_queue', {
+      filter: filterConditions,
+      sort: normalizeQuerySort(sort),
+      ...options,
+    });
+  }
+
+  /**
+   * Upsert moderation config
+   * @param {Object} config Moderation config to be upserted
+   */
+  async upsertConfig(config: ModerationConfig = {}) {
+    return await this.client.post<UpsertConfigResponse>(this.client.baseURL + '/api/v2/moderation/config', config);
+  }
+
+  /**
+   * Get moderation config
+   * @param {string} key Key for which moderation config is to be fetched
+   */
+  async getConfig(key: string) {
+    return await this.client.get<GetConfigResponse>(this.client.baseURL + '/api/v2/moderation/config/' + key);
+  }
+
+  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',
+      {
+        action_type: actionType,
+        item_id: itemID,
+        ...options,
+      },
+    );
+  }
+}