stream-chat 8.57.6 → 8.59.0

package/src/client.ts

@@ -214,6 +214,10 @@ import {
   UserResponse,
   UserSort,
   VoteSort,
+  QueryDraftsResponse,
+  DraftFilters,
+  DraftSort,
+  Pager,
 } from './types';
 import { InsightMetrics, postInsights } from './insights';
 import { Thread } from './thread';
@@ -330,6 +334,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
       warmUp: false,
       recoverStateOnReconnect: true,
       disableCache: false,
+      wsUrlParams: new URLSearchParams({}),
       ...inputOptions,
     };
 
@@ -4045,4 +4050,32 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
       ...options,
     });
   }
+
+  /**
+   * queryDrafts - Queries drafts for the current user
+   *
+   * @param {object} [options] Query options
+   * @param {object} [options.filter] Filters for the query
+   * @param {number} [options.sort] Sort parameters
+   * @param {number} [options.limit] Limit the number of results
+   * @param {string} [options.next] Pagination parameter
+   * @param {string} [options.prev] Pagination parameter
+   * @param {string} [options.user_id] Has to be provided when called server-side
+   *
+   * @return {Promise<APIResponse & { drafts: DraftResponse<StreamChatGenerics>[]; next?: string }>} Response containing the drafts
+   */
+  async queryDrafts(
+    options: Pager & {
+      filter?: DraftFilters<StreamChatGenerics>;
+      sort?: DraftSort;
+      user_id?: string;
+    } = {},
+  ) {
+    const payload = {
+      ...options,
+      sort: options.sort ? normalizeQuerySort(options.sort) : undefined,
+    };
+
+    return await this.post<QueryDraftsResponse<StreamChatGenerics>>(this.baseURL + '/drafts/query', payload);
+  }
 }

package/src/connection.ts

@@ -184,14 +184,20 @@ export class StableWSConnection<StreamChatGenerics extends ExtendableGenerics =
    * @returns url string
    */
   _buildUrl = () => {
-    const qs = encodeURIComponent(this.client._buildWSPayload(this.requestID));
+    const qs = this.client._buildWSPayload(this.requestID);
     const token = this.client.tokenManager.getToken();
-
-    return `${this.client.wsBaseURL}/connect?json=${qs}&api_key=${
-      this.client.key
-    }&authorization=${token}&stream-auth-type=${this.client.getAuthType()}&X-Stream-Client=${encodeURIComponent(
-      this.client.getUserAgent(),
-    )}`;
+    const wsUrlParams = this.client.options.wsUrlParams;
+
+    const params = new URLSearchParams(wsUrlParams);
+    params.set('json', qs);
+    params.set('api_key', this.client.key);
+    // it is expected that the autorization parameter exists even if
+    // the token is undefined, so we interpolate it to be safe
+    params.set('authorization', `${token}`);
+    params.set('stream-auth-type', this.client.getAuthType());
+    params.set('X-Stream-Client', this.client.getUserAgent());
+
+    return `${this.client.wsBaseURL}/connect?${params.toString()}`;
   };
 
   /**

package/src/moderation.ts

@@ -21,6 +21,7 @@ import {
   CustomCheckFlag,
   ReviewQueueItem,
   QueryConfigsResponse,
+  RequireAtLeastOne,
 } from './types';
 import { StreamChat } from './client';
 import { normalizeQuerySort } from './utils';
@@ -28,6 +29,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 +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

package/src/types.ts

@@ -32,6 +32,8 @@ export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
   }[Keys];
 
+export type PartializeKeys<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
+
 /* Unknown Record */
 export type UR = Record<string, unknown>;
 export type UnknownType = UR; //alias to avoid breaking change
@@ -919,9 +921,12 @@ export type UserResponse<StreamChatGenerics extends ExtendableGenerics = Default
   push_notifications?: PushNotificationSettings;
   revoke_tokens_issued_before?: string;
   shadow_banned?: boolean;
+  teams_role?: TeamsRole;
   updated_at?: string;
 };
 
+export type TeamsRole = { [team: string]: string };
+
 export type PrivacySettings = {
   read_receipts?: {
     enabled?: boolean;
@@ -1241,6 +1246,11 @@ export type StreamChatOptions = AxiosRequestConfig & {
    * not be used in production apps.
    */
   wsConnection?: StableWSConnection;
+  /**
+   * Sets a suffix to the wsUrl when it is being built in `wsConnection`. Is meant to be
+   * used purely in testing suites and should not be used in production apps.
+   */
+  wsUrlParams?: URLSearchParams;
 };
 
 export type SyncOptions = {
@@ -1308,6 +1318,7 @@ export type Event<StreamChatGenerics extends ExtendableGenerics = DefaultGeneric
   connection_id?: string;
   // event creation timestamp, format Date ISO string
   created_at?: string;
+  draft?: DraftResponse<StreamChatGenerics>;
   // id of the message that was marked as unread - all the following messages are considered unread. (notification.mark_unread)
   first_unread_message_id?: string;
   hard_delete?: boolean;
@@ -1592,6 +1603,18 @@ export type ChannelFilters<StreamChatGenerics extends ExtendableGenerics = Defau
     }
 >;
 
+export type DraftFilters<SCG extends ExtendableGenerics = DefaultGenerics> = {
+  channel_cid?:
+    | RequireOnlyOne<Pick<QueryFilter<DraftResponse<SCG>['channel_cid']>, '$in' | '$eq'>>
+    | PrimitiveFilter<DraftResponse<SCG>['channel_cid']>;
+  created_at?:
+    | RequireOnlyOne<Pick<QueryFilter<DraftResponse<SCG>['created_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>>
+    | PrimitiveFilter<DraftResponse<SCG>['created_at']>;
+  parent_id?:
+    | RequireOnlyOne<Pick<QueryFilter<DraftResponse<SCG>['created_at']>, '$in' | '$eq' | '$exists'>>
+    | PrimitiveFilter<DraftResponse<SCG>['parent_id']>;
+};
+
 export type QueryPollsParams = {
   filter?: QueryPollsFilters;
   options?: QueryPollsOptions;
@@ -2041,6 +2064,12 @@ export type SearchMessageSort<StreamChatGenerics extends ExtendableGenerics = De
   | SearchMessageSortBase<StreamChatGenerics>
   | Array<SearchMessageSortBase<StreamChatGenerics>>;
 
+export type DraftSortBase = {
+  created_at?: AscDesc;
+};
+
+export type DraftSort = DraftSortBase | Array<DraftSortBase>;
+
 export type QuerySort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> =
   | BannedUsersSort
   | ChannelSort<StreamChatGenerics>
@@ -3045,6 +3074,7 @@ export type CampaignData = {
   segment_ids?: string[];
   sender_id?: string;
   sender_mode?: 'exclude' | 'include' | null;
+  show_channels?: boolean;
   skip_push?: boolean;
   skip_webhook?: boolean;
   user_ids?: string[];
@@ -3828,3 +3858,45 @@ export type SdkIdentifier = { name: 'react' | 'react-native' | 'expo' | 'angular
  * available. Is used by the react-native SDKs to enrich the user agent further.
  */
 export type DeviceIdentifier = { os: string; model?: string };
+
+export type DraftResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  channel_cid: string;
+  created_at: string;
+  message: DraftMessage<StreamChatGenerics>;
+  channel?: ChannelResponse<StreamChatGenerics>;
+  parent_id?: string;
+  parent_message?: MessageResponseBase<StreamChatGenerics>;
+  quoted_message?: MessageResponseBase<StreamChatGenerics>;
+};
+export type CreateDraftResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  draft: DraftResponse<StreamChatGenerics>;
+};
+
+export type GetDraftResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  draft: DraftResponse<StreamChatGenerics>;
+};
+
+export type QueryDraftsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  drafts: DraftResponse<StreamChatGenerics>[];
+} & Omit<Pager, 'limit'>;
+
+export type DraftMessagePayload<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = PartializeKeys<
+  DraftMessage<StreamChatGenerics>,
+  'id'
+> & { user_id?: string };
+
+export type DraftMessage<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  id: string;
+  text: string;
+  attachments?: Attachment<StreamChatGenerics>[];
+  custom?: {};
+  html?: string;
+  mentioned_users?: string[];
+  mml?: string;
+  parent_id?: string;
+  poll_id?: string;
+  quoted_message_id?: string;
+  show_in_channel?: boolean;
+  silent?: boolean;
+  type?: MessageLabel;
+};