feat: add create srt credentials method to StreamCall

Author: vagruchi

src/ApiClient.ts

@@ -1,5 +1,11 @@
 import { v4 as uuidv4 } from 'uuid';
-import { ApiConfig, RequestMetadata, StreamError } from './types';
+import {
+  ApiConfig,
+  RequestMetadata,
+  StreamError,
+  UserTokenPayload,
+} from './types';
+import { JWTUserToken } from './utils/create-token';
 import { APIError } from './gen/models';
 import { getRateLimitFromResponseHeader } from './utils/rate-limit';
 
@@ -147,4 +153,50 @@ export class ApiClient {
 
     return newParams.join('&');
   };
+
+  /**
+   *
+   * @param payload
+   * - user_id - the id of the user the token is for
+   * - validity_in_seconds - how many seconds is the token valid for (starting from issued at), by default it's 1 hour, dicarded if exp is provided
+   * - exp - when the token expires, unix timestamp in seconds
+   * - iat - issued at date of the token, unix timestamp in seconds, by default it's now
+   */
+  generateUserToken = (
+    payload: {
+      user_id: string;
+      validity_in_seconds?: number;
+      exp?: number;
+      iat?: number;
+    } & Record<string, unknown>,
+  ) => {
+    if (!this.apiConfig.secret) {
+      throw new Error('API secret is not set');
+    }
+
+    const defaultIat = Math.floor((Date.now() - 1000) / 1000);
+    payload.iat = payload.iat ?? defaultIat;
+    const validityInSeconds = payload.validity_in_seconds ?? 60 * 60;
+    payload.exp = payload.exp ?? payload.iat + validityInSeconds;
+
+    return JWTUserToken(this.apiConfig.secret, payload as UserTokenPayload);
+  };
+
+  createToken = (
+    userID: string,
+    exp = Math.round(Date.now() / 1000) + 60 * 60,
+    iat = Math.floor((Date.now() - 1000) / 1000),
+  ) => {
+    if (!this.apiConfig.secret) {
+      throw new Error('API secret is not set');
+    }
+
+    const payload: UserTokenPayload = {
+      user_id: userID,
+      exp,
+      iat,
+    };
+
+    return JWTUserToken(this.apiConfig.secret, payload);
+  };
 }

src/StreamCall.ts

@@ -1,8 +1,14 @@
-import { GetOrCreateCallRequest, QueryCallMembersRequest } from './gen/models';
+import {
+  CallResponse,
+  GetOrCreateCallRequest,
+  QueryCallMembersRequest,
+} from './gen/models';
 import { CallApi } from './gen/video/CallApi';
 import { OmitTypeId } from './types';
 
 export class StreamCall extends CallApi {
+  data?: CallResponse;
+
   get cid() {
     return `${this.type}:${this.id}`;
   }
@@ -16,4 +22,40 @@ export class StreamCall extends CallApi {
       ...(request ?? {}),
     });
   };
+
+  getOrCreate = async (request?: GetOrCreateCallRequest) => {
+    const response = await super.getOrCreate(request);
+    this.data = response.call;
+    return response;
+  };
+
+  get = async () => {
+    const response = await super.get();
+    this.data = response.call;
+    return response;
+  };
+
+  createSRTCredetials = (
+    userID: string,
+  ): {
+    address: string;
+  } => {
+    if (!this.data) {
+      throw new Error(
+        'Object is not initialized, call get() or getOrCreate() first',
+      );
+    }
+
+    const token = this.videoApi.apiClient.createToken(userID, undefined);
+    const segments = token.split('.');
+    if (segments.length !== 3) {
+      throw new Error('Invalid token format');
+    }
+
+    return {
+      address: this.data.ingress.srt.address
+        .replace('{passphrase}', segments[2])
+        .replace('{token}', token),
+    };
+  };
 }

src/StreamClient.ts

@@ -54,6 +54,7 @@ export class StreamClient extends CommonApi {
       baseUrl: chatBaseUrl,
       timeout,
       agent: config?.agent as RequestInit['dispatcher'],
+      secret,
     });
 
     const videoApiClient = new ApiClient({
@@ -62,6 +63,7 @@ export class StreamClient extends CommonApi {
       baseUrl: videoBaseUrl,
       timeout,
       agent: config?.agent as RequestInit['dispatcher'],
+      secret,
     });
 
     const feedsApiClient = new ApiClient({
@@ -70,6 +72,7 @@ export class StreamClient extends CommonApi {
       baseUrl: feedsBaseUrl,
       timeout,
       agent: config?.agent as RequestInit['dispatcher'],
+      secret,
     });
 
     super(chatApiClient);
@@ -136,14 +139,7 @@ export class StreamClient extends CommonApi {
       exp?: number;
       iat?: number;
     } & Record<string, unknown>,
-  ) => {
-    const defaultIat = Math.floor((Date.now() - 1000) / 1000);
-    payload.iat = payload.iat ?? defaultIat;
-    const validityInSeconds = payload.validity_in_seconds ?? 60 * 60;
-    payload.exp = payload.exp ?? payload.iat + validityInSeconds;
-
-    return JWTUserToken(this.secret, payload as UserTokenPayload);
-  };
+  ) => this.apiClient.generateUserToken(payload);
 
   /**
    *
@@ -179,15 +175,7 @@ export class StreamClient extends CommonApi {
     userID: string,
     exp = Math.round(Date.now() / 1000) + 60 * 60,
     iat = Math.floor((Date.now() - 1000) / 1000),
-  ) => {
-    const payload: UserTokenPayload = {
-      user_id: userID,
-      exp,
-      iat,
-    };
-
-    return JWTUserToken(this.secret, payload);
-  };
+  ) => this.apiClient.createToken(userID, exp, iat);
 
   /**
    *

src/types.ts

@@ -7,6 +7,7 @@ export interface ApiConfig {
   /** The timeout for requests in milliseconds. The default is 3000. */
   timeout: number;
   agent?: RequestInit['dispatcher'];
+  secret?: string;
 }
 
 export interface RequestMetadata {