@stream-io/node-sdk 0.4.19 → 0.4.20

package/dist/src/gen/moderation/ModerationApi.d.ts

@@ -1,8 +1,7 @@
 import { BaseApi } from '../../BaseApi';
 import { StreamResponse } from '../../types';
-import { BanRequest, BanResponse, CheckRequest, CheckResponse, CustomCheckRequest, CustomCheckResponse, DeleteModerationConfigResponse, DeleteModerationTemplateResponse, FlagRequest, FlagResponse, GetConfigResponse, GetModerationAnalyticsRequest, GetModerationAnalyticsResponse, GetReviewQueueItemResponse, GetUserModerationReportResponse, ModeratorStatsResponse, MuteRequest, MuteResponse, QueryFeedModerationTemplatesResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, QueryUsageStatsRequest, QueryUsageStatsResponse, QueueStatsResponse, SubmitActionRequest, SubmitActionResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse } from '../models';
+import { BanRequest, BanResponse, CheckRequest, CheckResponse, CustomCheckRequest, CustomCheckResponse, DeleteModerationConfigResponse, DeleteModerationTemplateResponse, FlagRequest, FlagResponse, GetConfigResponse, GetReviewQueueItemResponse, MuteRequest, MuteResponse, QueryFeedModerationTemplatesResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, SubmitActionRequest, SubmitActionResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse } from '../models';
 export declare class ModerationApi extends BaseApi {
-    getModerationAnalytics: (request?: GetModerationAnalyticsRequest) => Promise<StreamResponse<GetModerationAnalyticsResponse>>;
     ban: (request: BanRequest) => Promise<StreamResponse<BanResponse>>;
     check: (request: CheckRequest) => Promise<StreamResponse<CheckResponse>>;
     upsertConfig: (request: UpsertConfigRequest) => Promise<StreamResponse<UpsertConfigResponse>>;
@@ -21,9 +20,7 @@ export declare class ModerationApi extends BaseApi {
     v2UpsertTemplate: (request: UpsertModerationTemplateRequest) => Promise<StreamResponse<UpsertModerationTemplateResponse>>;
     flag: (request: FlagRequest) => Promise<StreamResponse<FlagResponse>>;
     queryModerationLogs: (request?: QueryModerationLogsRequest) => Promise<StreamResponse<QueryModerationLogsResponse>>;
-    getModeratorStats: () => Promise<StreamResponse<ModeratorStatsResponse>>;
     mute: (request: MuteRequest) => Promise<StreamResponse<MuteResponse>>;
-    getQueueStats: () => Promise<StreamResponse<QueueStatsResponse>>;
     queryReviewQueue: (request?: QueryReviewQueueRequest) => Promise<StreamResponse<QueryReviewQueueResponse>>;
     getReviewQueueItem: (request: {
         id: string;
@@ -35,11 +32,4 @@ export declare class ModerationApi extends BaseApi {
         created_by?: string;
     }) => Promise<StreamResponse<UnbanResponse>>;
     unmute: (request: UnmuteRequest) => Promise<StreamResponse<UnmuteResponse>>;
-    queryUsageStats: (request?: QueryUsageStatsRequest) => Promise<StreamResponse<QueryUsageStatsResponse>>;
-    getUserReport: (request: {
-        user_id: string;
-        create_user_if_not_exists?: boolean;
-        include_user_mutes?: boolean;
-        include_user_blocks?: boolean;
-    }) => Promise<StreamResponse<GetUserModerationReportResponse>>;
 }

package/dist/src/types.d.ts

@@ -1,9 +1,12 @@
+import { Agent } from 'undici';
 export type OmitTypeId<T> = Omit<T, 'type' | 'id' | 'connection_id'>;
 export interface ApiConfig {
     apiKey: string;
     token: string;
     baseUrl: string;
+    /** The timeout for requests in milliseconds. The default is 3000. */
     timeout: number;
+    agent: Agent;
 }
 export interface RequestMetadata {
     responseHeaders: Headers;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/node-sdk",
-  "version": "0.4.19",
+  "version": "0.4.20",
   "description": "",
   "exports": {
     ".": {
@@ -73,6 +73,7 @@
     "@types/jsonwebtoken": "^9.0.3",
     "@types/node": "^20.11.24",
     "jsonwebtoken": "^9.0.2",
+    "undici": "^5.29.0",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

package/src/BaseApi.ts

@@ -2,9 +2,14 @@ import { v4 as uuidv4 } from 'uuid';
 import { ApiConfig, RequestMetadata, StreamError } from './types';
 import { APIError } from './gen/models';
 import { getRateLimitFromResponseHeader } from './utils/rate-limit';
+import { Agent } from 'undici';
 
 export class BaseApi {
-  constructor(protected readonly apiConfig: ApiConfig) {}
+  private readonly dispatcher: Agent;
+
+  constructor(protected readonly apiConfig: ApiConfig) {
+    this.dispatcher = this.apiConfig.agent;
+  }
 
   protected sendRequest = async <T>(
     method: string,
@@ -21,6 +26,7 @@ export class BaseApi {
         url = url.replace(`{${paramName}}`, pathParams[paramName]);
       });
     }
+
     url += `?${encodedParams}`;
     const clientRequestId = uuidv4();
     const headers = {
@@ -40,6 +46,8 @@ export class BaseApi {
         method,
         body: JSON.stringify(body),
         headers,
+        /** @ts-expect-error we get types from DOM here, but we should use node types */
+        dispatcher: this.dispatcher,
       });
 
       const responseHeaders = response.headers;

package/src/StreamClient.ts

@@ -6,10 +6,15 @@ import { StreamChatClient } from './StreamChatClient';
 import { CallTokenPayload, UserTokenPayload } from './types';
 import { QueryBannedUsersPayload, UserRequest } from './gen/models';
 import { StreamModerationClient } from './StreamModerationClient';
+import { Agent } from 'undici';
 
 export interface StreamClientOptions {
   timeout?: number;
   basePath?: string;
+  /** The max number of clients to create. `null` if no limit. Default is 100. Has no effect if `agent` is provided. */
+  maxConnections?: number | null;
+  /** The [HTTP Agent](https://undici.nodejs.org/#/docs/api/Agent.md) to use. */
+  agent?: Agent;
 }
 
 export class StreamClient extends CommonApi {
@@ -19,6 +24,7 @@ export class StreamClient extends CommonApi {
   public readonly options: StreamClientOptions = {};
 
   private static readonly DEFAULT_TIMEOUT = 3000;
+  private static readonly MAX_CONNECTIONS = 100;
 
   /**
    *
@@ -33,9 +39,17 @@ export class StreamClient extends CommonApi {
   ) {
     const token = JWTServerToken(secret);
     const timeout = config?.timeout ?? StreamClient.DEFAULT_TIMEOUT;
+    const agent =
+      config?.agent ??
+      new Agent({
+        connections:
+          config?.maxConnections === undefined
+            ? StreamClient.MAX_CONNECTIONS
+            : config.maxConnections,
+      });
     const chatBaseUrl = config?.basePath ?? 'https://chat.stream-io-api.com';
     const videoBaseUrl = config?.basePath ?? 'https://video.stream-io-api.com';
-    super({ apiKey, token, timeout, baseUrl: chatBaseUrl });
+    super({ apiKey, token, timeout, baseUrl: chatBaseUrl, agent });
 
     this.video = new StreamVideoClient({
       streamClient: this,
@@ -43,18 +57,21 @@ export class StreamClient extends CommonApi {
       token,
       timeout,
       baseUrl: videoBaseUrl,
+      agent,
     });
     this.chat = new StreamChatClient({
       apiKey,
       token,
       timeout,
       baseUrl: chatBaseUrl,
+      agent,
     });
     this.moderation = new StreamModerationClient({
       apiKey,
       token,
       timeout,
       baseUrl: chatBaseUrl,
+      agent,
     });
   }
 

package/src/gen/chat/ChannelApi.ts

@@ -7,6 +7,7 @@ import {
   EventResponse,
   FileUploadRequest,
   FileUploadResponse,
+  GetDraftResponse,
   GetManyMessagesResponse,
   HideChannelRequest,
   HideChannelResponse,
@@ -83,6 +84,34 @@ export class ChannelApi {
     });
   };
 
+  deleteDraft = (request?: {
+    parent_id?: string;
+    user_id?: string;
+  }): Promise<StreamResponse<Response>> => {
+    if (!this.id) {
+      throw new Error(
+        `Channel isn't yet created, call getOrCreateDistinctChannel() before this operation`,
+      );
+    }
+    return this.chatApi.deleteDraft({
+      id: this.id,
+      type: this.type,
+      ...request,
+    });
+  };
+
+  getDraft = (request?: {
+    parent_id?: string;
+    user_id?: string;
+  }): Promise<StreamResponse<GetDraftResponse>> => {
+    if (!this.id) {
+      throw new Error(
+        `Channel isn't yet created, call getOrCreateDistinctChannel() before this operation`,
+      );
+    }
+    return this.chatApi.getDraft({ id: this.id, type: this.type, ...request });
+  };
+
   sendEvent = (
     request: SendEventRequest,
   ): Promise<StreamResponse<EventResponse>> => {

package/src/gen/chat/ChatApi.ts

@@ -27,6 +27,7 @@ import {
   GetCampaignResponse,
   GetChannelTypeResponse,
   GetCommandResponse,
+  GetDraftResponse,
   GetManyMessagesResponse,
   GetMessageResponse,
   GetReactionsResponse,
@@ -58,6 +59,8 @@ import {
   QueryCampaignsResponse,
   QueryChannelsRequest,
   QueryChannelsResponse,
+  QueryDraftsRequest,
+  QueryDraftsResponse,
   QueryMembersPayload,
   QueryMessageFlagsPayload,
   QueryMessageFlagsResponse,
@@ -129,6 +132,7 @@ export class ChatApi extends BaseApi {
       limit: request?.limit,
       next: request?.next,
       prev: request?.prev,
+      user_limit: request?.user_limit,
       sort: request?.sort,
       filter: request?.filter,
     };
@@ -144,14 +148,22 @@ export class ChatApi extends BaseApi {
 
   getCampaign = async (request: {
     id: string;
+    prev?: string;
+    next?: string;
+    limit?: number;
   }): Promise<StreamResponse<GetCampaignResponse>> => {
+    const queryParams = {
+      prev: request?.prev,
+      next: request?.next,
+      limit: request?.limit,
+    };
     const pathParams = {
       id: request?.id,
     };
 
     const response = await this.sendRequest<
       StreamResponse<GetCampaignResponse>
-    >('GET', '/api/v2/chat/campaigns/{id}', pathParams, undefined);
+    >('GET', '/api/v2/chat/campaigns/{id}', pathParams, queryParams);
 
     decoders.GetCampaignResponse?.(response.body);
 
@@ -378,6 +390,60 @@ export class ChatApi extends BaseApi {
     return { ...response.body, metadata: response.metadata };
   };
 
+  deleteDraft = async (request: {
+    type: string;
+    id: string;
+    parent_id?: string;
+    user_id?: string;
+  }): Promise<StreamResponse<Response>> => {
+    const queryParams = {
+      parent_id: request?.parent_id,
+      user_id: request?.user_id,
+    };
+    const pathParams = {
+      type: request?.type,
+      id: request?.id,
+    };
+
+    const response = await this.sendRequest<StreamResponse<Response>>(
+      'DELETE',
+      '/api/v2/chat/channels/{type}/{id}/draft',
+      pathParams,
+      queryParams,
+    );
+
+    decoders.Response?.(response.body);
+
+    return { ...response.body, metadata: response.metadata };
+  };
+
+  getDraft = async (request: {
+    type: string;
+    id: string;
+    parent_id?: string;
+    user_id?: string;
+  }): Promise<StreamResponse<GetDraftResponse>> => {
+    const queryParams = {
+      parent_id: request?.parent_id,
+      user_id: request?.user_id,
+    };
+    const pathParams = {
+      type: request?.type,
+      id: request?.id,
+    };
+
+    const response = await this.sendRequest<StreamResponse<GetDraftResponse>>(
+      'GET',
+      '/api/v2/chat/channels/{type}/{id}/draft',
+      pathParams,
+      queryParams,
+    );
+
+    decoders.GetDraftResponse?.(response.body);
+
+    return { ...response.body, metadata: response.metadata };
+  };
+
   sendEvent = async (
     request: SendEventRequest & { type: string; id: string },
   ): Promise<StreamResponse<EventResponse>> => {
@@ -991,6 +1057,28 @@ export class ChatApi extends BaseApi {
     return { ...response.body, metadata: response.metadata };
   };
 
+  queryDrafts = async (
+    request?: QueryDraftsRequest,
+  ): Promise<StreamResponse<QueryDraftsResponse>> => {
+    const body = {
+      limit: request?.limit,
+      next: request?.next,
+      prev: request?.prev,
+      user_id: request?.user_id,
+      sort: request?.sort,
+      filter: request?.filter,
+      user: request?.user,
+    };
+
+    const response = await this.sendRequest<
+      StreamResponse<QueryDraftsResponse>
+    >('POST', '/api/v2/chat/drafts/query', undefined, undefined, body);
+
+    decoders.QueryDraftsResponse?.(response.body);
+
+    return { ...response.body, metadata: response.metadata };
+  };
+
   exportChannels = async (
     request: ExportChannelsRequest,
   ): Promise<StreamResponse<ExportChannelsResponse>> => {

package/src/gen/model-decoders/index.ts

@@ -435,6 +435,8 @@ decoders.ChannelStateResponse = (input?: Record<string, any>) => {
 
     channel: { type: 'ChannelResponse', isSingle: true },
 
+    draft: { type: 'DraftResponse', isSingle: true },
+
     membership: { type: 'ChannelMember', isSingle: true },
 
     push_preferences: { type: 'ChannelPushPreferences', isSingle: true },
@@ -462,6 +464,8 @@ decoders.ChannelStateResponseFields = (input?: Record<string, any>) => {
 
     channel: { type: 'ChannelResponse', isSingle: true },
 
+    draft: { type: 'DraftResponse', isSingle: true },
+
     membership: { type: 'ChannelMember', isSingle: true },
 
     push_preferences: { type: 'ChannelPushPreferences', isSingle: true },
@@ -616,6 +620,28 @@ decoders.DeviceResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
+decoders.DraftPayloadResponse = (input?: Record<string, any>) => {
+  const typeMappings: TypeMapping = {
+    mentioned_users: { type: 'UserResponse', isSingle: false },
+  };
+  return decode(typeMappings, input);
+};
+
+decoders.DraftResponse = (input?: Record<string, any>) => {
+  const typeMappings: TypeMapping = {
+    created_at: { type: 'DatetimeType', isSingle: true },
+
+    message: { type: 'DraftPayloadResponse', isSingle: true },
+
+    channel: { type: 'ChannelResponse', isSingle: true },
+
+    parent_message: { type: 'MessageResponse', isSingle: true },
+
+    quoted_message: { type: 'MessageResponse', isSingle: true },
+  };
+  return decode(typeMappings, input);
+};
+
 decoders.EgressRTMPResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     started_at: { type: 'DatetimeType', isSingle: true },
@@ -688,7 +714,7 @@ decoders.ExportUserResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.Flag2 = (input?: Record<string, any>) => {
+decoders.Flag = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     created_at: { type: 'DatetimeType', isSingle: true },
 
@@ -699,17 +725,6 @@ decoders.Flag2 = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.Flag2Response = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    created_at: { type: 'DatetimeType', isSingle: true },
-
-    updated_at: { type: 'DatetimeType', isSingle: true },
-
-    user: { type: 'UserResponse', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.FlagDetails = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     automod: { type: 'AutomodDetails', isSingle: true },
@@ -788,13 +803,6 @@ decoders.GetCallTypeResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.GetCampaignResponse = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    campaign: { type: 'CampaignResponse', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.GetChannelTypeResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     created_at: { type: 'DatetimeType', isSingle: true },
@@ -822,6 +830,13 @@ decoders.GetConfigResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
+decoders.GetDraftResponse = (input?: Record<string, any>) => {
+  const typeMappings: TypeMapping = {
+    draft: { type: 'DraftResponse', isSingle: true },
+  };
+  return decode(typeMappings, input);
+};
+
 decoders.GetImportResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     import_task: { type: 'ImportTask', isSingle: true },
@@ -898,17 +913,6 @@ decoders.GetThreadResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.GetUserModerationReportResponse = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    user_blocks: { type: 'UserBlock', isSingle: false },
-
-    user_mutes: { type: 'UserMute', isSingle: false },
-
-    user: { type: 'UserResponse', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.GoLiveResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     call: { type: 'CallResponse', isSingle: true },
@@ -1146,6 +1150,8 @@ decoders.MessageResponse = (input?: Record<string, any>) => {
 
     thread_participants: { type: 'UserResponse', isSingle: false },
 
+    draft: { type: 'DraftResponse', isSingle: true },
+
     pinned_by: { type: 'UserResponse', isSingle: true },
 
     poll: { type: 'PollResponseData', isSingle: true },
@@ -1183,6 +1189,8 @@ decoders.MessageWithChannelResponse = (input?: Record<string, any>) => {
 
     thread_participants: { type: 'UserResponse', isSingle: false },
 
+    draft: { type: 'DraftResponse', isSingle: true },
+
     pinned_by: { type: 'UserResponse', isSingle: true },
 
     poll: { type: 'PollResponseData', isSingle: true },
@@ -1194,15 +1202,6 @@ decoders.MessageWithChannelResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.ModerationUsageStats = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    reference_date: { type: 'DatetimeType', isSingle: true },
-
-    updated_at: { type: 'DatetimeType', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.MuteChannelResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     channel_mutes: { type: 'ChannelMute', isSingle: false },
@@ -1442,6 +1441,13 @@ decoders.QueryChannelsResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
+decoders.QueryDraftsResponse = (input?: Record<string, any>) => {
+  const typeMappings: TypeMapping = {
+    drafts: { type: 'DraftResponse', isSingle: false },
+  };
+  return decode(typeMappings, input);
+};
+
 decoders.QueryFeedModerationTemplate = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     created_at: { type: 'DatetimeType', isSingle: true },
@@ -1530,13 +1536,6 @@ decoders.QueryThreadsResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.QueryUsageStatsResponse = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    items: { type: 'ModerationUsageStats', isSingle: false },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.QueryUsersResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     users: { type: 'FullUserResponse', isSingle: false },
@@ -1601,7 +1600,7 @@ decoders.ReviewQueueItem = (input?: Record<string, any>) => {
 
     bans: { type: 'Ban', isSingle: false },
 
-    flags: { type: 'Flag2', isSingle: false },
+    flags: { type: 'Flag', isSingle: false },
 
     assigned_to: { type: 'User', isSingle: true },
 
@@ -1626,8 +1625,6 @@ decoders.ReviewQueueItemResponse = (input?: Record<string, any>) => {
 
     bans: { type: 'Ban', isSingle: false },
 
-    flags: { type: 'Flag2Response', isSingle: false },
-
     completed_at: { type: 'DatetimeType', isSingle: true },
 
     reviewed_at: { type: 'DatetimeType', isSingle: true },
@@ -1687,6 +1684,8 @@ decoders.SearchResultMessage = (input?: Record<string, any>) => {
 
     channel: { type: 'ChannelResponse', isSingle: true },
 
+    draft: { type: 'DraftResponse', isSingle: true },
+
     pinned_by: { type: 'UserResponse', isSingle: true },
 
     poll: { type: 'PollResponseData', isSingle: true },
@@ -1743,13 +1742,6 @@ decoders.SendReactionResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.StartCampaignResponse = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    campaign: { type: 'CampaignResponse', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.StopLiveResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     call: { type: 'CallResponse', isSingle: true },
@@ -1820,6 +1812,8 @@ decoders.ThreadStateResponse = (input?: Record<string, any>) => {
 
     created_by: { type: 'UserResponse', isSingle: true },
 
+    draft: { type: 'DraftResponse', isSingle: true },
+
     parent_message: { type: 'MessageResponse', isSingle: true },
   };
   return decode(typeMappings, input);
@@ -2018,13 +2012,6 @@ decoders.User = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.UserBlock = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    created_at: { type: 'DatetimeType', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.UserMute = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     created_at: { type: 'DatetimeType', isSingle: true },