@stream-io/node-sdk 0.1.3 → 0.1.5

package/dist/src/StreamClient.d.ts

@@ -2,12 +2,17 @@ import { StreamChatClient } from "./StreamChatClient";
 import { StreamVideoClient } from "./StreamVideoClient";
 import { BanRequest, CheckPushRequest, CreateDeviceRequest, CreateRoleRequest, DeactivateUserRequest, DeactivateUsersRequest, DeleteDeviceRequest, DeletePushProviderRequest, DeleteRoleRequest, DeleteUserRequest, DeleteUsersRequest, ExportUserRequest, ExportUsersRequest, FlagRequest, GetPermissionRequest, GetTaskRequest, GuestRequest, ListDevicesRequest, MuteUserRequest, PushProviderRequest, QueryBannedUsersRequest, QueryUsersRequest, ReactivateUserRequest, ReactivateUsersRequest, RestoreUsersRequest, UnbanRequest, UnmuteUserRequest, UpdateAppRequest, UpdateUserPartialRequest, UpdateUsersRequest, UserCustomEventRequest } from "./gen/chat";
 import { Configuration } from "./gen/video";
+export type StreamClientOptions = {
+    timeout?: number;
+    basePath?: string;
+};
 export declare class StreamClient {
     private apiKey;
     private secret;
-    readonly basePath?: string | undefined;
+    readonly config?: string | StreamClientOptions | undefined;
     readonly video: StreamVideoClient;
     readonly chat: StreamChatClient;
+    readonly options: StreamClientOptions;
     private readonly usersApi;
     private readonly devicesApi;
     private readonly pushApi;
@@ -18,16 +23,31 @@ export declare class StreamClient {
     private readonly eventsApi;
     private readonly tasksApi;
     private token;
-    constructor(apiKey: string, secret: string, basePath?: string | undefined);
+    private static readonly DEFAULT_TIMEOUT;
+    /**
+     *
+     * @param apiKey
+     * @param secret
+     * @param config can be a string, which will be interpreted as base path (deprecated), or a config object
+     */
+    constructor(apiKey: string, secret: string, config?: string | StreamClientOptions | undefined);
     /**
      *
      * @param userID
      * @param exp
-     * @param iat
+     * @param iat deprecated, the default date will be set internally
      * @param call_cids this parameter is deprecated use `createCallToken` for call tokens
      * @returns
      */
     createToken(userID: string, exp?: number, iat?: number, call_cids?: string[]): string;
+    /**
+     *
+     * @param userID
+     * @param call_cids
+     * @param exp
+     * @param iat this is deprecated, the current date will be set internally
+     * @returns
+     */
     createCallToken(userID: string, call_cids: string[], exp?: number, iat?: number): string;
     createDevice: (createDeviceRequest: CreateDeviceRequest) => Promise<void>;
     deleteDevice: (requestParameters: DeleteDeviceRequest) => Promise<import("./gen/chat").Response>;
@@ -40,6 +60,11 @@ export declare class StreamClient {
     banUser: (banRequest: BanRequest) => Promise<import("./gen/chat").Response>;
     deactivateUser: (deactivateUserRequest: DeactivateUserRequest) => Promise<import("./gen/chat").DeactivateUserResponse>;
     deactivateUsers: (deactivateUsersRequest: DeactivateUsersRequest) => Promise<import("./gen/chat").DeactivateUsersResponse>;
+    /**
+     * @deprecated use `deleteUsers` instead
+     * @param deleteUsersRequest
+     * @returns
+     */
     deleteUser: (request: DeleteUserRequest) => Promise<import("./gen/chat").DeleteUserResponse>;
     deleteUsers: (deleteUsersRequest: DeleteUsersRequest) => Promise<import("./gen/chat").DeleteUsersResponse>;
     exportUser: (request: ExportUserRequest) => Promise<import("./gen/chat").ExportUserResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/node-sdk",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/StreamCall.ts

@@ -28,7 +28,8 @@ export class StreamCall {
     this.baseRequest = { id: this.id, type: this.type };
     const configuration = this.streamClient.getConfiguration({
       basePath:
-        this.streamClient.basePath || "https://video.stream-io-api.com/video",
+        this.streamClient.options.basePath ||
+        "https://video.stream-io-api.com/video",
     });
     this.apiClient = new DefaultApi(configuration);
   }
@@ -66,7 +67,7 @@ export class StreamCall {
   goLive = (videoGoLiveRequest?: VideoGoLiveRequest) => {
     return this.apiClient.goLive({
       ...this.baseRequest,
-      videoGoLiveRequest: videoGoLiveRequest || null,
+      videoGoLiveRequest: videoGoLiveRequest || {},
     });
   };
 
@@ -77,7 +78,10 @@ export class StreamCall {
   };
 
   muteUsers = (videoMuteUsersRequest: VideoMuteUsersRequest) => {
-    return this.apiClient.muteUsers({ ...this.baseRequest, videoMuteUsersRequest });
+    return this.apiClient.muteUsers({
+      ...this.baseRequest,
+      videoMuteUsersRequest,
+    });
   };
 
   queryMembers = (request?: OmitTypeId<VideoQueryMembersRequest>) => {
@@ -135,7 +139,9 @@ export class StreamCall {
     });
   };
 
-  updateCallMembers = (videoUpdateCallMembersRequest: VideoUpdateCallMembersRequest) => {
+  updateCallMembers = (
+    videoUpdateCallMembersRequest: VideoUpdateCallMembersRequest
+  ) => {
     return this.apiClient.updateCallMembers({
       videoUpdateCallMembersRequest,
       ...this.baseRequest,
@@ -156,6 +162,9 @@ export class StreamCall {
   };
 
   unpinVideo = (videoUnpinRequest: VideoUnpinRequest) => {
-    return this.apiClient.videoUnpin({ videoUnpinRequest, ...this.baseRequest });
+    return this.apiClient.videoUnpin({
+      videoUnpinRequest,
+      ...this.baseRequest,
+    });
   };
 }

package/src/StreamClient.ts

@@ -48,6 +48,8 @@ import {
 } from "./gen/chat";
 import {
   Configuration,
+  ErrorContext,
+  FetchError,
   HTTPQuery,
   JSONApiResponse,
   RequestContext,
@@ -56,9 +58,15 @@ import {
 import { v4 as uuidv4 } from "uuid";
 import { JWTServerToken, JWTUserToken } from "./utils/create-token";
 
+export type StreamClientOptions = {
+  timeout?: number;
+  basePath?: string;
+};
+
 export class StreamClient {
   public readonly video: StreamVideoClient;
   public readonly chat: StreamChatClient;
+  public readonly options: StreamClientOptions = {};
   private readonly usersApi: UsersApi;
   private readonly devicesApi: DevicesApi;
   private readonly pushApi: PushApi;
@@ -69,16 +77,30 @@ export class StreamClient {
   private readonly eventsApi: EventsApi;
   private readonly tasksApi: TasksApi;
   private token: string;
+  private static readonly DEFAULT_TIMEOUT = 3000;
 
+  /**
+   *
+   * @param apiKey
+   * @param secret
+   * @param config can be a string, which will be interpreted as base path (deprecated), or a config object
+   */
   constructor(
     private apiKey: string,
     private secret: string,
-    public readonly basePath?: string
+    readonly config?: string | StreamClientOptions
   ) {
     this.token = JWTServerToken(this.secret);
     this.video = new StreamVideoClient(this);
     this.chat = new StreamChatClient(this);
 
+    if (typeof config === "string") {
+      this.options.basePath = config;
+      this.options.timeout = StreamClient.DEFAULT_TIMEOUT;
+    } else {
+      this.options.timeout = config?.timeout || StreamClient.DEFAULT_TIMEOUT;
+    }
+
     const chatConfiguration = this.getConfiguration();
     //@ts-expect-error typing problem
     this.usersApi = new UsersApi(chatConfiguration);
@@ -121,9 +143,6 @@ export class StreamClient {
     }
 
     if (iat) {
-      console.warn(
-        `This parameter is deprecated, and will be removed method with version 0.2.0, the client will set this to the current date by deault`
-      );
       extra.iat = iat;
     }
 
@@ -158,9 +177,6 @@ export class StreamClient {
     }
 
     if (iat) {
-      console.warn(
-        `This parameter is deprecated, and will be removed method with version 0.2.0, the client will set this to the current date by deault`
-      );
       extra.iat = iat;
     }
 
@@ -225,6 +241,11 @@ export class StreamClient {
     return this.usersApi.deactivateUsers({ deactivateUsersRequest });
   };
 
+  /**
+   * @deprecated use `deleteUsers` instead
+   * @param deleteUsersRequest
+   * @returns
+   */
   deleteUser = async (request: DeleteUserRequest) => {
     const response = await this.usersApi.deleteUser(request);
     response.user = this.mapCustomDataAfterReceive(response.user);
@@ -416,7 +437,7 @@ export class StreamClient {
 
         return mapping[name];
       },
-      basePath: options?.basePath || this.basePath,
+      basePath: options?.basePath || this.options.basePath,
       headers: {
         "X-Stream-Client": "stream-node-" + process.env.PKG_VERSION,
       },
@@ -447,6 +468,24 @@ export class StreamClient {
             }
           },
         },
+        {
+          pre: (context: RequestContext) => {
+            context.init.signal = AbortSignal.timeout(this.options.timeout!);
+
+            return Promise.resolve(context);
+          },
+          onError: (context: ErrorContext) => {
+            const error = context.error as DOMException;
+            if (error.name === "AbortError" || error.name === "TimeoutError") {
+              throw new FetchError(
+                error,
+                `The request was aborted due to to the ${this.options.timeout}ms timeout, you can set the timeout in the StreamClient constructor`
+              );
+            }
+
+            return Promise.resolve(context.response);
+          },
+        },
       ],
       // https://github.com/OpenAPITools/openapi-generator/issues/13222
       queryParamsStringify: (params: HTTPQuery) => {

package/src/StreamVideoClient.ts

@@ -17,7 +17,8 @@ export class StreamVideoClient {
   constructor(private streamClient: StreamClient) {
     const configuration = this.streamClient.getConfiguration({
       basePath:
-        this.streamClient.basePath || "https://video.stream-io-api.com/video",
+        this.streamClient.options.basePath ||
+        "https://video.stream-io-api.com/video",
     });
     this.apiClient = new DefaultApi(configuration);
     this.videoServerSideApiClient = new ServerSideApi(configuration);