@stream-io/video-client 0.7.0 → 0.7.2

package/dist/src/Call.d.ts

@@ -1,7 +1,7 @@
 import { Publisher, Subscriber } from './rtc';
 import { TrackType } from './gen/video/sfu/models/models';
 import { CallState } from './store';
-import { AcceptCallResponse, BlockUserResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryMembersRequest, QueryMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendEventResponse, SendReactionRequest, SendReactionResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopHLSBroadcastingResponse, StopLiveResponse, StopRecordingResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from './gen/coordinator';
+import { AcceptCallResponse, BlockUserResponse, CollectUserFeedbackResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryMembersRequest, QueryMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendEventResponse, SendReactionRequest, SendReactionResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopHLSBroadcastingResponse, StopLiveResponse, StopRecordingResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from './gen/coordinator';
 import { AudioTrackType, CallConstructor, CallLeaveOptions, DebounceType, JoinCallData, PublishOptions, SubscriptionChanges, TrackMuteType, VideoTrackType } from './types';
 import { VideoLayerSetting } from './gen/video/sfu/event/events';
 import { DynascaleManager } from './helpers/DynascaleManager';
@@ -470,6 +470,18 @@ export declare class Call {
      * @returns The call stats.
      */
     getCallStats: (callSessionID: string) => Promise<GetCallStatsResponse>;
+    /**
+     * 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: (rating: number, { reason, custom, }?: {
+        reason?: string | undefined;
+        custom?: Record<string, any> | undefined;
+    }) => Promise<CollectUserFeedbackResponse>;
     /**
      * Sends a custom event to all call participants.
      *

package/dist/src/gen/coordinator/index.d.ts

@@ -467,6 +467,7 @@ export interface CallEndedEvent {
     user?: UserResponse;
 }
 /**
+ *
  * @export
  * @interface CallEvent
  */
@@ -477,6 +478,12 @@ export interface CallEvent {
      * @memberof CallEvent
      */
     description: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CallEvent
+     */
+    end_timestamp: number;
     /**
      *
      * @type {number}
@@ -1660,41 +1667,47 @@ export interface CallStateResponseFields {
     own_capabilities: Array<OwnCapability>;
 }
 /**
- * CallTranscription represents a transcription of a call.
+ *
  * @export
  * @interface CallStatsReportSummaryResponse
  */
 export interface CallStatsReportSummaryResponse {
     /**
      *
-     * @type {number}
+     * @type {string}
      * @memberof CallStatsReportSummaryResponse
      */
-    app_pk: number;
+    call_cid: string;
     /**
      *
      * @type {string}
      * @memberof CallStatsReportSummaryResponse
      */
-    call_cid: string;
+    call_session_id: string;
     /**
      *
      * @type {string}
      * @memberof CallStatsReportSummaryResponse
      */
-    call_session_id: string;
+    call_status: string;
     /**
      *
      * @type {string}
      * @memberof CallStatsReportSummaryResponse
      */
-    call_status: string;
+    created_at?: string;
     /**
      *
      * @type {string}
      * @memberof CallStatsReportSummaryResponse
      */
     first_stats_time: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CallStatsReportSummaryResponse
+     */
+    quality_score?: number;
 }
 /**
  *
@@ -2092,6 +2105,64 @@ export interface ClosedCaptionEvent {
      */
     type: string;
 }
+/**
+ *
+ * @export
+ * @interface CollectUserFeedbackRequest
+ */
+export interface CollectUserFeedbackRequest {
+    /**
+     *
+     * @type {object}
+     * @memberof CollectUserFeedbackRequest
+     */
+    custom?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof CollectUserFeedbackRequest
+     */
+    rating?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectUserFeedbackRequest
+     */
+    reason?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectUserFeedbackRequest
+     */
+    sdk: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectUserFeedbackRequest
+     */
+    sdk_version: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectUserFeedbackRequest
+     */
+    user_session_id: string;
+}
+/**
+ *
+ * @export
+ * @interface CollectUserFeedbackResponse
+ */
+export interface CollectUserFeedbackResponse {
+    /**
+     * Duration of the request in human-readable format
+     * @type {string}
+     * @memberof CollectUserFeedbackResponse
+     */
+    duration: string;
+}
 /**
  *
  * @export
@@ -2568,6 +2639,49 @@ export interface GeofenceSettingsRequest {
      */
     names?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface GeolocationResult
+ */
+export interface GeolocationResult {
+    /**
+     *
+     * @type {number}
+     * @memberof GeolocationResult
+     */
+    accuracy_radius: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GeolocationResult
+     */
+    continent_code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GeolocationResult
+     */
+    country_iso_code: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GeolocationResult
+     */
+    latitude: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GeolocationResult
+     */
+    longitude: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GeolocationResult
+     */
+    subdivision_iso_code: string;
+}
 /**
  *
  * @export
@@ -2641,6 +2755,18 @@ export interface GetCallStatsResponse {
      * @memberof GetCallStatsResponse
      */
     duration: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCallStatsResponse
+     */
+    max_jitter: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCallStatsResponse
+     */
+    max_latency: number;
     /**
      *
      * @type {number}
@@ -4219,6 +4345,31 @@ export interface StopTranscriptionResponse {
      */
     duration: string;
 }
+/**
+ *
+ * @export
+ * @interface Subsession
+ */
+export interface Subsession {
+    /**
+     *
+     * @type {number}
+     * @memberof Subsession
+     */
+    ended_at: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Subsession
+     */
+    joined_at: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Subsession
+     */
+    sfu_id: string;
+}
 /**
  *
  * @export
@@ -4785,16 +4936,59 @@ export interface UserResponse {
     updated_at: string;
 }
 /**
+ *
  * @export
  * @interface UserSessionStats
  */
 export interface UserSessionStats {
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    browser?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    browser_version?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    current_ip?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    current_sfu?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    device_model?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    device_version?: string;
     /**
      *
      * @type {number}
      * @memberof UserSessionStats
      */
     freeze_duration_seconds: number;
+    /**
+     *
+     * @type {GeolocationResult}
+     * @memberof UserSessionStats
+     */
+    geolocation?: GeolocationResult;
     /**
      *
      * @type {Stats}
@@ -4807,18 +5001,72 @@ export interface UserSessionStats {
      * @memberof UserSessionStats
      */
     latency?: Stats;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    max_fir_per_minute?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    max_freezes_per_minute?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    max_nack_per_minute?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    max_pli_per_minute?: number;
+    /**
+     *
+     * @type {VideoQuality}
+     * @memberof UserSessionStats
+     */
+    max_publishing_video_quality?: VideoQuality;
+    /**
+     *
+     * @type {VideoQuality}
+     * @memberof UserSessionStats
+     */
+    max_receiving_video_quality?: VideoQuality;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    os?: string;
     /**
      *
      * @type {string}
      * @memberof UserSessionStats
      */
-    os: string;
+    os_version?: string;
     /**
      *
      * @type {number}
      * @memberof UserSessionStats
      */
     packet_loss_fraction: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    publishing_audio_codec?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    publishing_duration_seconds: number;
     /**
      *
      * @type {number}
@@ -4830,25 +5078,55 @@ export interface UserSessionStats {
      * @type {string}
      * @memberof UserSessionStats
      */
-    sdk: string;
+    receiving_audio_codec?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    receiving_duration_seconds: number;
     /**
      *
      * @type {string}
      * @memberof UserSessionStats
      */
-    sdk_version: string;
+    sdk?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSessionStats
+     */
+    sdk_version?: string;
+    /**
+     *
+     * @type {Array<Subsession>}
+     * @memberof UserSessionStats
+     */
+    subsessions?: Array<Subsession>;
     /**
      *
      * @type {CallTimeline}
      * @memberof UserSessionStats
      */
     timeline?: CallTimeline;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    total_pixels_in: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    total_pixels_out: number;
     /**
      *
      * @type {string}
      * @memberof UserSessionStats
      */
-    webrtc_version: string;
+    webrtc_version?: string;
 }
 /**
  *
@@ -4963,6 +5241,38 @@ export declare const VideoSettingsRequestCameraFacingEnum: {
     readonly EXTERNAL: "external";
 };
 export type VideoSettingsRequestCameraFacingEnum = (typeof VideoSettingsRequestCameraFacingEnum)[keyof typeof VideoSettingsRequestCameraFacingEnum];
+/**
+ *
+ * @export
+ * @interface VideoQuality
+ */
+export interface VideoQuality {
+    /**
+     *
+     * @type {VideoResolution}
+     * @memberof VideoQuality
+     */
+    resolution: VideoResolution;
+}
+/**
+ *
+ * @export
+ * @interface VideoResolution
+ */
+export interface VideoResolution {
+    /**
+     *
+     * @type {number}
+     * @memberof VideoResolution
+     */
+    height: number;
+    /**
+     *
+     * @type {number}
+     * @memberof VideoResolution
+     */
+    width: number;
+}
 /**
  *
  * @export

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

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.
    *