@stream-io/node-sdk 0.1.6 → 0.1.8

package/src/StreamClient.ts

@@ -1,5 +1,5 @@
-import { StreamChatClient } from "./StreamChatClient";
-import { StreamVideoClient } from "./StreamVideoClient";
+import { StreamChatClient } from './StreamChatClient';
+import { StreamVideoClient } from './StreamVideoClient';
 import {
   APIError,
   BanRequest,
@@ -45,7 +45,7 @@ import {
   UserObjectRequest,
   UserResponse,
   UsersApi,
-} from "./gen/chat";
+} from './gen/chat';
 import {
   Configuration,
   ErrorContext,
@@ -54,14 +54,14 @@ import {
   JSONApiResponse,
   RequestContext,
   ResponseContext,
-} from "./gen/video";
-import { v4 as uuidv4 } from "uuid";
-import { JWTServerToken, JWTUserToken } from "./utils/create-token";
+} from './gen/video';
+import { v4 as uuidv4 } from 'uuid';
+import { JWTServerToken, JWTUserToken } from './utils/create-token';
 
-export type StreamClientOptions = {
+export interface StreamClientOptions {
   timeout?: number;
   basePath?: string;
-};
+}
 
 export class StreamClient {
   public readonly video: StreamVideoClient;
@@ -76,7 +76,7 @@ export class StreamClient {
   private readonly settingsApi: SettingsApi;
   private readonly eventsApi: EventsApi;
   private readonly tasksApi: TasksApi;
-  private token: string;
+  private readonly token: string;
   private static readonly DEFAULT_TIMEOUT = 3000;
 
   /**
@@ -86,39 +86,39 @@ export class StreamClient {
    * @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,
-    readonly config?: string | StreamClientOptions
+    private readonly apiKey: string,
+    private readonly secret: string,
+    readonly config?: string | StreamClientOptions,
   ) {
     this.token = JWTServerToken(this.secret);
     this.video = new StreamVideoClient(this);
     this.chat = new StreamChatClient(this);
 
-    if (typeof config === "string") {
+    if (typeof config === 'string') {
       this.options.basePath = config;
       this.options.timeout = StreamClient.DEFAULT_TIMEOUT;
     } else {
-      this.options.timeout = config?.timeout || StreamClient.DEFAULT_TIMEOUT;
+      this.options.timeout = config?.timeout ?? StreamClient.DEFAULT_TIMEOUT;
     }
 
     const chatConfiguration = this.getConfiguration();
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.usersApi = new UsersApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.devicesApi = new DevicesApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.pushApi = new PushApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.serversideApi = new ServerSideApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.testingApi = new TestingApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.permissionsApi = new PermissionsV2Api(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.settingsApi = new SettingsApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.eventsApi = new EventsApi(chatConfiguration);
-    //@ts-expect-error typing problem
+    // @ts-expect-error typing problem
     this.tasksApi = new TasksApi(chatConfiguration);
   }
 
@@ -134,7 +134,7 @@ export class StreamClient {
     userID: string,
     exp = Math.round(new Date().getTime() / 1000) + 60 * 60,
     iat = Math.round(Date.now() / 1000),
-    call_cids?: string[]
+    call_cids?: string[],
   ) {
     const extra: { exp?: number; iat?: number; call_cids?: string[] } = {};
 
@@ -148,7 +148,7 @@ export class StreamClient {
 
     if (call_cids) {
       console.warn(
-        `Use createCallToken method for creating call tokens, the "call_cids" param will be removed from the createToken method with version 0.2.0`
+        `Use createCallToken method for creating call tokens, the "call_cids" param will be removed from the createToken method with version 0.2.0`,
       );
       extra.call_cids = call_cids;
     }
@@ -168,7 +168,7 @@ export class StreamClient {
     userID: string,
     call_cids: string[],
     exp = Math.round(new Date().getTime() / 1000) + 60 * 60,
-    iat = Math.round(Date.now() / 1000)
+    iat = Math.round(Date.now() / 1000),
   ) {
     const extra: { exp?: number; iat?: number; call_cids?: string[] } = {};
 
@@ -188,9 +188,11 @@ export class StreamClient {
   createDevice = (createDeviceRequest: CreateDeviceRequest) => {
     return this.devicesApi.createDevice({ createDeviceRequest });
   };
+
   deleteDevice = (requestParameters: DeleteDeviceRequest) => {
     return this.devicesApi.deleteDevice(requestParameters);
   };
+
   listDevices = (requestParameters: ListDevicesRequest) => {
     return this.devicesApi.listDevices(requestParameters);
   };
@@ -289,9 +291,9 @@ export class StreamClient {
   queryUsers = async (payload: QueryUsersRequest) => {
     payload.user = this.mapCustomDataBeforeSend(payload.user);
     const response = await this.usersApi.queryUsers({ payload });
-    // @ts-expect-error
-    response.users = response.users.map(
-      (u) => this.mapCustomDataAfterReceive(u)!
+    // @ts-expect-error typing problem
+    response.users = response.users.map((u) =>
+      this.mapCustomDataAfterReceive(u),
     );
 
     return response;
@@ -329,13 +331,13 @@ export class StreamClient {
   upsertUsers = async (updateUsersRequest: UpdateUsersRequest) => {
     Object.keys(updateUsersRequest.users).forEach((key) => {
       updateUsersRequest.users[key] = this.mapCustomDataBeforeSend(
-        updateUsersRequest.users[key]
+        updateUsersRequest.users[key],
       );
     });
     const response = await this.usersApi.updateUsers({ updateUsersRequest });
     Object.keys(response.users).forEach((key) => {
       response.users[key] = this.mapCustomDataAfterReceive(
-        response.users[key]
+        response.users[key],
       )!;
     });
 
@@ -351,7 +353,7 @@ export class StreamClient {
     });
     Object.keys(response.users).forEach((key) => {
       response.users[key] = this.mapCustomDataAfterReceive(
-        response.users[key]
+        response.users[key],
       )!;
     });
 
@@ -378,7 +380,7 @@ export class StreamClient {
 
   unmuteUser = (unmuteUserRequest: UnmuteUserRequest) => {
     unmuteUserRequest.user = this.mapCustomDataBeforeSend(
-      unmuteUserRequest.user
+      unmuteUserRequest.user,
     );
     return this.usersApi.unmuteUser({ unmuteUserRequest });
   };
@@ -429,24 +431,25 @@ export class StreamClient {
   getConfiguration = (options?: { basePath?: string }) => {
     return new Configuration({
       apiKey: (name: string) => {
-        const mapping: { [key: string]: string } = {
-          "Stream-Auth-Type": "jwt",
+        const mapping: Record<string, string> = {
+          'Stream-Auth-Type': 'jwt',
           api_key: this.apiKey,
           Authorization: this.token,
         };
 
         return mapping[name];
       },
-      basePath: options?.basePath || this.options.basePath,
+      basePath: options?.basePath ?? this.options.basePath,
       headers: {
-        "X-Stream-Client": "stream-node-" + process.env.PKG_VERSION,
+        'X-Stream-Client': 'stream-node-' + process.env.PKG_VERSION,
       },
       middleware: [
         {
           pre: (context: RequestContext) => {
             context.init.headers = {
               ...context.init.headers,
-              "x-client-request-id": uuidv4(),
+              'x-client-request-id': uuidv4(),
+              'Accept-Encoding': 'gzip',
             };
 
             return Promise.resolve(context);
@@ -463,7 +466,7 @@ export class StreamClient {
               const response = new JSONApiResponse(context.response);
               const value = (await response.value()) as APIError;
               throw new Error(
-                `Stream error code ${value.code}: ${value.message}`
+                `Stream error code ${value.code}: ${value.message}`,
               );
             }
           },
@@ -476,10 +479,10 @@ export class StreamClient {
           },
           onError: (context: ErrorContext) => {
             const error = context.error as DOMException;
-            if (error.name === "AbortError" || error.name === "TimeoutError") {
+            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`
+                `The request was aborted due to to the ${this.options.timeout}ms timeout, you can set the timeout in the StreamClient constructor`,
               );
             }
 
@@ -491,49 +494,50 @@ export class StreamClient {
       queryParamsStringify: (params: HTTPQuery) => {
         const newParams = [];
         for (const k in params) {
-          if (Array.isArray(params[k]) || typeof params[k] === "object") {
+          if (Array.isArray(params[k]) || typeof params[k] === 'object') {
             newParams.push(
-              `${k}=${encodeURIComponent(JSON.stringify(params[k]))}`
+              `${k}=${encodeURIComponent(JSON.stringify(params[k]))}`,
             );
           } else {
             const value = params[k];
             if (
-              typeof value === "string" ||
-              typeof value === "number" ||
-              typeof value === "boolean"
+              typeof value === 'string' ||
+              typeof value === 'number' ||
+              typeof value === 'boolean'
             ) {
               newParams.push(`${k}=${encodeURIComponent(value)}`);
             }
           }
         }
 
-        return newParams.join("&");
+        return newParams.join('&');
       },
     });
   };
 
-  private reservedKeywords = [
-    "ban_expires",
-    "banned",
-    "id",
-    "invisible",
-    "language",
-    "push_notifications",
-    "revoke_tokens_issued_before",
-    "role",
-    "teams",
-    "created_at",
-    "deactivated_at",
-    "deleted_at",
-    "last_active",
-    "online",
-    "updated_at",
-    "shadow_banned",
-    "name",
-    "image",
+  private readonly reservedKeywords = [
+    'ban_expires',
+    'banned',
+    'id',
+    'invisible',
+    'language',
+    'push_notifications',
+    'revoke_tokens_issued_before',
+    'role',
+    'teams',
+    'created_at',
+    'deactivated_at',
+    'deleted_at',
+    'last_active',
+    'online',
+    'updated_at',
+    'shadow_banned',
+    'name',
+    'image',
   ];
-  private mapCustomDataBeforeSend = (
-    user: UserObject | UserObjectRequest | UserResponse | undefined
+
+  private readonly mapCustomDataBeforeSend = (
+    user: UserObject | UserObjectRequest | UserResponse | undefined,
   ) => {
     if (!user) {
       return undefined;
@@ -543,14 +547,14 @@ export class StreamClient {
     return { ...copy, ...user.custom };
   };
 
-  private mapCustomDataAfterReceive = (
-    user: UserObject | UserResponse | undefined
-  ) => {
+  private mapCustomDataAfterReceive<T = UserObject | UserResponse | undefined>(
+    user: T,
+  ) {
     if (!user) {
       return undefined;
     }
-    // @ts-expect-error
-    let result: UserObject | UserResponse = {};
+    // @ts-expect-error typing problem
+    const result: UserObject | UserResponse = {};
     Object.keys(user).forEach((key) => {
       if (!this.reservedKeywords.includes(key)) {
         if (!result.custom) {
@@ -563,5 +567,5 @@ export class StreamClient {
     });
 
     return result;
-  };
+  }
 }

package/src/StreamVideoClient.ts

@@ -1,5 +1,5 @@
-import { StreamCall } from "./StreamCall";
-import { StreamClient } from "./StreamClient";
+import { StreamCall } from './StreamCall';
+import { StreamClient } from './StreamClient';
 import {
   DefaultApi,
   DeleteCallTypeRequest,
@@ -8,17 +8,17 @@ import {
   VideoCreateCallTypeRequest,
   VideoQueryCallsRequest,
   VideoUpdateCallTypeRequest,
-} from "./gen/video";
+} from './gen/video';
 
 export class StreamVideoClient {
   private readonly apiClient: DefaultApi;
   private readonly videoServerSideApiClient: ServerSideApi;
 
-  constructor(private streamClient: StreamClient) {
+  constructor(private readonly streamClient: StreamClient) {
     const configuration = this.streamClient.getConfiguration({
       basePath:
-        this.streamClient.options.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);
@@ -30,7 +30,7 @@ export class StreamVideoClient {
 
   queryCalls = (request?: VideoQueryCallsRequest) => {
     return this.apiClient.queryCalls({
-      videoQueryCallsRequest: request || {},
+      videoQueryCallsRequest: request ?? {},
     });
   };
 
@@ -54,7 +54,7 @@ export class StreamVideoClient {
 
   updateCallType = (
     name: string,
-    videoUpdateCallTypeRequest: VideoUpdateCallTypeRequest
+    videoUpdateCallTypeRequest: VideoUpdateCallTypeRequest,
   ) => {
     return this.videoServerSideApiClient.updateCallType({
       name,

package/src/gen/chat/apis/ChannelTypesApi.ts

@@ -4,7 +4,7 @@
  * Stream Chat API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: v89.9.2
+ * The version of the OpenAPI document: v92.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).