feat: set max connections to 100, allow integrators to configure Fetch API (#98)

Author: szuperaz

package.json

@@ -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": {

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;

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,28 +39,39 @@ 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,
       apiKey,
       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,
     });
   }
 

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>> => {

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>> => {