@stream-io/node-sdk 0.2.1 → 0.2.2

package/dist/src/StreamClient.d.ts

@@ -49,7 +49,10 @@ export declare class StreamClient {
      * @param iat this is deprecated, the current date will be set internally
      * @returns
      */
-    createCallToken(userID: string, call_cids: string[], exp?: number, iat?: number): string;
+    createCallToken(userIdOrObject: string | {
+        user_id: string;
+        role?: string;
+    }, call_cids: string[], exp?: number, iat?: number): string;
     createDevice: (createDeviceRequest: CreateDeviceRequest) => Promise<void>;
     deleteDevice: (requestParameters: DeleteDeviceRequest) => Promise<import("./gen/chat").Response>;
     listDevices: (requestParameters: ListDevicesRequest) => Promise<import("./gen/chat").ListDevicesResponse>;

package/dist/src/types.d.ts

@@ -1 +1,13 @@
 export type OmitTypeId<T> = Omit<T, 'type' | 'id' | 'connection_id'>;
+interface BaseTokenPayload {
+    user_id: string;
+    exp: number;
+    iat: number;
+    call_cids?: string[];
+}
+export type UserTokenPayload = BaseTokenPayload;
+export type CallTokenPayload = BaseTokenPayload & {
+    call_cids: string[];
+    role?: string;
+};
+export {};

package/dist/src/utils/create-token.d.ts

@@ -1,3 +1,8 @@
 import { Secret, SignOptions } from 'jsonwebtoken';
-export declare function JWTUserToken(apiSecret: Secret, userId: string, extraData?: {}, jwtOptions?: SignOptions): string;
+export declare function JWTUserToken(apiSecret: Secret, payload: {
+    user_id: string;
+    exp: number;
+    iat: number;
+    call_cids?: string[];
+}): string;
 export declare function JWTServerToken(apiSecret: Secret, jwtOptions?: SignOptions): string;

package/package.json

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

package/src/StreamClient.ts

@@ -58,6 +58,7 @@ import {
 import { v4 as uuidv4 } from 'uuid';
 import { JWTServerToken, JWTUserToken } from './utils/create-token';
 import crypto from 'crypto';
+import { CallTokenPayload, UserTokenPayload } from './types';
 
 export interface StreamClientOptions {
   timeout?: number;
@@ -141,24 +142,20 @@ export class StreamClient {
     iat = Math.round(Date.now() / 1000),
     call_cids?: string[],
   ) {
-    const extra: { exp?: number; iat?: number; call_cids?: string[] } = {};
-
-    if (exp) {
-      extra.exp = exp;
-    }
-
-    if (iat) {
-      extra.iat = iat;
-    }
+    const payload: UserTokenPayload = {
+      user_id: userID,
+      exp,
+      iat,
+    };
 
     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`,
       );
-      extra.call_cids = call_cids;
+      payload.call_cids = call_cids;
     }
 
-    return JWTUserToken(this.secret, userID, extra);
+    return JWTUserToken(this.secret, payload);
   }
 
   /**
@@ -170,24 +167,26 @@ export class StreamClient {
    * @returns
    */
   createCallToken(
-    userID: string,
+    userIdOrObject: string | { user_id: string; role?: string },
     call_cids: string[],
     exp = Math.round(new Date().getTime() / 1000) + 60 * 60,
     iat = Math.round(Date.now() / 1000),
   ) {
-    const extra: { exp?: number; iat?: number; call_cids?: string[] } = {};
-
-    if (exp) {
-      extra.exp = exp;
-    }
-
-    if (iat) {
-      extra.iat = iat;
+    const payload: CallTokenPayload = {
+      exp,
+      iat,
+      call_cids,
+      user_id:
+        typeof userIdOrObject === 'string'
+          ? userIdOrObject
+          : userIdOrObject.user_id,
+    };
+
+    if (typeof userIdOrObject === 'object' && userIdOrObject.role) {
+      payload.role = userIdOrObject.role;
     }
 
-    extra.call_cids = call_cids;
-
-    return JWTUserToken(this.secret, userID, extra);
+    return JWTUserToken(this.secret, payload);
   }
 
   createDevice = (createDeviceRequest: CreateDeviceRequest) => {

package/src/types.ts

@@ -1 +1,15 @@
 export type OmitTypeId<T> = Omit<T, 'type' | 'id' | 'connection_id'>;
+
+interface BaseTokenPayload {
+  user_id: string;
+  exp: number;
+  iat: number;
+  call_cids?: string[];
+}
+
+export type UserTokenPayload = BaseTokenPayload;
+
+export type CallTokenPayload = BaseTokenPayload & {
+  call_cids: string[];
+  role?: string;
+};

package/src/utils/create-token.ts

@@ -2,19 +2,8 @@ import jwt, { Secret, SignOptions } from 'jsonwebtoken';
 
 export function JWTUserToken(
   apiSecret: Secret,
-  userId: string,
-  extraData = {},
-  jwtOptions: SignOptions = {},
+  payload: { user_id: string; exp: number; iat: number; call_cids?: string[] },
 ) {
-  if (typeof userId !== 'string') {
-    throw new TypeError('userId should be a string');
-  }
-
-  const payload: { user_id: string } & any = {
-    user_id: userId,
-    ...extraData,
-  };
-
   // make sure we return a clear error when jwt is shimmed (ie. browser build)
   if (jwt == null || jwt.sign == null) {
     throw Error(
@@ -22,10 +11,10 @@ export function JWTUserToken(
     );
   }
 
-  const opts: SignOptions = Object.assign(
-    { algorithm: 'HS256', noTimestamp: true },
-    jwtOptions,
-  );
+  const opts: SignOptions = Object.assign({
+    algorithm: 'HS256',
+    noTimestamp: true,
+  });
 
   if (payload.iat) {
     opts.noTimestamp = false;