@stream-io/video-client 0.6.10 → 0.7.1

package/dist/src/stats/utils.d.ts

@@ -1,6 +1,17 @@
+import { LocalClientDetailsType } from '../client-details';
 /**
  * Flatten the stats report into an array of stats objects.
  *
  * @param report the report to flatten.
  */
 export declare const flatten: (report: RTCStatsReport) => RTCStats[];
+export declare const getSdkSignature: (clientDetails: LocalClientDetailsType) => {
+    os?: import("../gen/video/sfu/models/models").OS | undefined;
+    browser?: import("../gen/video/sfu/models/models").Browser | undefined;
+    device?: import("../gen/video/sfu/models/models").Device | undefined;
+    webRTCInfo?: {
+        version: string;
+    } | undefined;
+    sdkName: string;
+    sdkVersion: string;
+};

package/dist/src/store/CallState.d.ts

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import type { Patch } from './rxUtils';
 import { StreamVideoParticipant, StreamVideoParticipantPatch, StreamVideoParticipantPatches } from '../types';
 import { CallStatsReport } from '../stats';
-import { CallIngressResponse, CallResponse, CallSessionResponse, CallSettingsResponse, EgressResponse, MemberResponse, OwnCapability, ThumbnailResponse, UserResponse, VideoEvent } from '../gen/coordinator';
+import { CallIngressResponse, CallResponse, CallSessionResponse, CallSettingsResponse, EgressResponse, MemberResponse, OwnCapability, ThumbnailResponse, UserResponse, WSEvent } from '../gen/coordinator';
 import { Pin } from '../gen/video/sfu/models/models';
 import { Comparator } from '../sorting';
 import { Logger } from '../coordinator/connection/types';
@@ -476,7 +476,7 @@ export declare class CallState {
      *
      * @param event the video event that our backend sent us.
      */
-    updateFromEvent: (event: VideoEvent) => void;
+    updateFromEvent: (event: WSEvent) => void;
     /**
      * Updates the participant pinned state with server side pinning data.
      *

package/index.ts

@@ -13,7 +13,6 @@ export * from './src/stats/types';
 export * from './src/Call';
 export * from './src/CallType';
 export * from './src/StreamVideoClient';
-export * from './src/StreamVideoServerClient';
 export * from './src/StreamSfuClient';
 export * from './src/devices';
 export * from './src/store';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.6.10",
+  "version": "0.7.1",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -35,7 +35,6 @@
     "axios": "^1.6.0",
     "base64-js": "^1.5.1",
     "isomorphic-ws": "^5.0.0",
-    "jsonwebtoken": "^9.0.2",
     "rxjs": "~7.8.1",
     "sdp-transform": "^2.14.1",
     "ua-parser-js": "^1.0.36",
@@ -46,7 +45,7 @@
     "@openapitools/openapi-generator-cli": "^2.7.0",
     "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@types/jsonwebtoken": "^9.0.3",
+    "@stream-io/node-sdk": "^0.1.12",
     "@types/sdp-transform": "^2.4.7",
     "@types/ua-parser-js": "^0.7.37",
     "@vitest/coverage-v8": "^0.34.4",

package/src/Call.ts

@@ -22,6 +22,8 @@ import {
   AcceptCallResponse,
   BlockUserRequest,
   BlockUserResponse,
+  CollectUserFeedbackRequest,
+  CollectUserFeedbackResponse,
   EndCallResponse,
   GetCallResponse,
   GetCallStatsResponse,
@@ -123,6 +125,7 @@ import {
   ScreenShareManager,
   SpeakerManager,
 } from './devices';
+import { getSdkSignature } from './stats/utils';
 
 /**
  * An object representation of a `Call`.
@@ -1909,6 +1912,56 @@ export class Call {
     return this.streamClient.get<GetCallStatsResponse>(endpoint);
   };
 
+  /**
+   * Submit user feedback for the call
+   *
+   * @param rating Rating between 1 and 5 denoting the experience of the user in the call
+   * @param reason The reason/description for the rating
+   * @param custom Custom data
+   * @returns
+   */
+  submitFeedback = async (
+    rating: number,
+    {
+      reason,
+      custom,
+    }: {
+      reason?: string;
+      custom?: Record<string, any>;
+    } = {},
+  ) => {
+    if (rating < 1 || rating > 5) {
+      throw new Error('Rating must be between 1 and 5');
+    }
+    const userSessionId = this.sfuClient?.sessionId;
+    const callSessionId = this.state.session?.id;
+    if (!callSessionId || !userSessionId) {
+      throw new Error(
+        'Feedback can be submitted only in the context of a call session',
+      );
+    }
+
+    const { sdkName, sdkVersion, ...platform } = getSdkSignature(
+      getClientDetails(),
+    );
+
+    const endpoint = `${this.streamClientBasePath}/feedback/${callSessionId}`;
+    return this.streamClient.post<
+      CollectUserFeedbackResponse,
+      CollectUserFeedbackRequest
+    >(endpoint, {
+      rating,
+      reason,
+      user_session_id: userSessionId,
+      sdk: sdkName,
+      sdk_version: sdkVersion,
+      custom: {
+        ...custom,
+        'x-stream-platform-data': platform,
+      },
+    });
+  };
+
   /**
    * Sends a custom event to all call participants.
    *

package/src/__tests__/StreamVideoClient.test.ts

@@ -2,18 +2,23 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { StreamVideoClient } from '../StreamVideoClient';
 import 'dotenv/config';
 import { generateUUIDv4 } from '../coordinator/connection/utils';
-import { StreamVideoServerClient } from '../StreamVideoServerClient';
 import { User } from '../coordinator/connection/types';
+import { StreamClient } from '@stream-io/node-sdk';
 
 const apiKey = process.env.STREAM_API_KEY!;
 const secret = process.env.STREAM_SECRET!;
 
+const serverClient = new StreamClient(apiKey, secret);
+
 const tokenProvider = (userId: string) => {
-  const serverClient = new StreamVideoServerClient(apiKey, { secret });
   return async () => {
     return new Promise<string>((resolve) => {
       setTimeout(() => {
-        const token = serverClient.createToken(userId);
+        const token = serverClient.createToken(
+          userId,
+          undefined,
+          Math.round(Date.now() / 1000 - 10),
+        );
         resolve(token);
       }, 100);
     });

package/src/coordinator/connection/client.ts

@@ -7,7 +7,7 @@ import axios, {
 } from 'axios';
 import https from 'https';
 import { StableWSConnection } from './connection';
-import { DevToken, JWTUserToken } from './signing';
+import { DevToken } from './signing';
 import { TokenManager } from './token_manager';
 import { WSConnectionFallback } from './connection_fallback';
 import { isErrorResponse, isWSFailure } from './errors';
@@ -416,7 +416,6 @@ export class StreamClient {
       {
         user: {
           ...user,
-          role: 'guest',
         },
       },
       { publicEndpoint: true },
@@ -862,42 +861,4 @@ export class StreamClient {
   createAbortControllerForNextRequest = () => {
     return (this.nextRequestAbortController = new AbortController());
   };
-
-  /**
-   * createToken - Creates a token to authenticate this user. This function is used server side.
-   * The resulting token should be passed to the client side when the users registers or logs in.
-   *
-   * @param {string} userID The UserWithId ID
-   * @param {number} [exp] The expiration time for the token expressed in the number of seconds since the epoch
-   * @param call_cids for anonymous tokens you have to provide the call cids the use can join
-   *
-   * @return {string} Returns a token
-   */
-  createToken = (
-    userID: string,
-    exp?: number,
-    iat?: number,
-    call_cids?: string[],
-  ) => {
-    if (this.secret == null) {
-      throw Error(
-        `tokens can only be created server-side using the API Secret`,
-      );
-    }
-    const extra: { exp?: number; iat?: number; call_cids?: string[] } = {};
-
-    if (exp) {
-      extra.exp = exp;
-    }
-
-    if (iat) {
-      extra.iat = iat;
-    }
-
-    if (call_cids) {
-      extra.call_cids = call_cids;
-    }
-
-    return JWTUserToken(this.secret, userID, extra, {});
-  };
 }

package/src/coordinator/connection/signing.ts

@@ -1,77 +1,4 @@
-import jwt, { Secret, SignOptions } from 'jsonwebtoken';
-import crypto from 'crypto';
-import { encodeBase64, decodeBase64 } from './base64';
-import { UR } from './types';
-
-/**
- * Creates the JWT token that can be used for a UserSession
- * @method JWTUserToken
- * @memberof signing
- * @private
- * @param {Secret} apiSecret - API Secret key
- * @param {string} userId - The user_id key in the JWT payload
- * @param {UR} [extraData] - Extra that should be part of the JWT token
- * @param {SignOptions} [jwtOptions] - Options that can be past to jwt.sign
- * @return {string} JWT Token
- */
-export function JWTUserToken(
-  apiSecret: Secret,
-  userId: string,
-  extraData: UR = {},
-  jwtOptions: SignOptions = {},
-) {
-  if (typeof userId !== 'string') {
-    throw new TypeError('userId should be a string');
-  }
-
-  const payload: { user_id: string } & UR = {
-    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(
-      `Unable to find jwt crypto, if you are getting this error is probably because you are trying to generate tokens on browser or React Native (or other environment where crypto functions are not available). Please Note: token should only be generated server-side.`,
-    );
-  }
-
-  const opts: SignOptions = Object.assign(
-    { algorithm: 'HS256', noTimestamp: true },
-    jwtOptions,
-  );
-
-  if (payload.iat) {
-    opts.noTimestamp = false;
-  }
-  return jwt.sign(payload, apiSecret, opts);
-}
-
-export function JWTServerToken(
-  apiSecret: Secret,
-  jwtOptions: SignOptions = {},
-) {
-  const payload = {
-    server: true,
-  };
-
-  const opts: SignOptions = Object.assign(
-    { algorithm: 'HS256', noTimestamp: true },
-    jwtOptions,
-  );
-  return jwt.sign(payload, apiSecret, opts);
-}
-
-export function UserFromToken(token: string) {
-  const fragments = token.split('.');
-  if (fragments.length !== 3) {
-    return '';
-  }
-  const b64Payload = fragments[1];
-  const payload = decodeBase64(b64Payload);
-  const data = JSON.parse(payload);
-  return data.user_id as string;
-}
+import { decodeBase64, encodeBase64 } from './base64';
 
 /**
  *
@@ -86,19 +13,13 @@ export function DevToken(userId: string) {
   ].join('.');
 }
 
-/**
- *
- * @param {string} body the signed message
- * @param {string} secret the shared secret used to generate the signature (Stream API secret)
- * @param {string} signature the signature to validate
- * @return {boolean}
- */
-export function CheckSignature(
-  body: string,
-  secret: string,
-  signature: string,
-) {
-  const key = Buffer.from(secret, 'ascii');
-  const hash = crypto.createHmac('sha256', key).update(body).digest('hex');
-  return hash === signature;
+export function UserFromToken(token: string) {
+  const fragments = token.split('.');
+  if (fragments.length !== 3) {
+    return '';
+  }
+  const b64Payload = fragments[1];
+  const payload = decodeBase64(b64Payload);
+  const data = JSON.parse(payload);
+  return data.user_id as string;
 }

package/src/coordinator/connection/token_manager.ts

@@ -1,5 +1,4 @@
-import { Secret } from 'jsonwebtoken';
-import { JWTServerToken, JWTUserToken, UserFromToken } from './signing';
+import { UserFromToken } from './signing';
 import { isFunction } from './utils';
 import type { TokenOrProvider, UserWithId } from './types';
 
@@ -11,7 +10,7 @@ import type { TokenOrProvider, UserWithId } from './types';
 export class TokenManager {
   loadTokenPromise: Promise<string> | null;
   type: 'static' | 'provider';
-  secret?: Secret;
+  secret?: string;
   token?: string;
   tokenProvider?: TokenOrProvider;
   user?: UserWithId;
@@ -20,17 +19,13 @@ export class TokenManager {
    *
    * @param {Secret} secret
    */
-  constructor(secret?: Secret) {
+  constructor(secret?: string) {
     this.loadTokenPromise = null;
     if (secret) {
       this.secret = secret;
     }
 
     this.type = 'static';
-
-    if (this.secret) {
-      this.token = JWTServerToken(this.secret);
-    }
   }
 
   /**
@@ -59,11 +54,6 @@ export class TokenManager {
       this.type = 'static';
     }
 
-    if (!tokenOrProvider && this.user && this.secret) {
-      this.token = JWTUserToken(this.secret, user.id, {}, {});
-      this.type = 'static';
-    }
-
     await this.loadToken();
   };
 
@@ -155,10 +145,6 @@ export class TokenManager {
       return this.token;
     }
 
-    if (this.secret) {
-      return JWTServerToken(this.secret);
-    }
-
     throw new Error(
       `Both secret and user tokens are not set. Either client.connectUser wasn't called or client.disconnect was called`,
     );

package/src/coordinator/connection/types.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { StableWSConnection } from './connection';
-import { ConnectedEvent, UserRequest, VideoEvent } from '../../gen/coordinator';
+import { ConnectedEvent, UserRequest, WSEvent } from '../../gen/coordinator';
 import { AllSfuEvents } from '../../rtc';
 
 export type UR = Record<string, unknown>;
@@ -62,7 +62,7 @@ export type ConnectionRecoveredEvent = {
 };
 
 export type StreamVideoEvent = (
-  | VideoEvent
+  | WSEvent
   | ConnectionChangedEvent
   | TransportChangedEvent
   | ConnectionRecoveredEvent
@@ -70,7 +70,7 @@ export type StreamVideoEvent = (
 
 // TODO: we should use WSCallEvent here but that needs fixing
 export type StreamCallEvent = Extract<StreamVideoEvent, { call_cid: string }>;
-export type EventTypes = 'all' | VideoEvent['type'];
+export type EventTypes = 'all' | WSEvent['type'];
 
 export type AllClientEventTypes = 'all' | StreamVideoEvent['type'];
 export type AllClientEvents = {
@@ -81,7 +81,7 @@ export type ClientEventListener<E extends keyof AllClientEvents> = (
 ) => void;
 
 export type AllClientCallEvents = {
-  [K in EventTypes]: Extract<VideoEvent, { type: K }>;
+  [K in EventTypes]: Extract<WSEvent, { type: K }>;
 };
 
 export type AllCallEvents = AllClientCallEvents & AllSfuEvents;