@stream-io/video-client 1.11.15 → 1.12.1

package/dist/src/StreamVideoClient.d.ts

@@ -1,7 +1,7 @@
 import { Call } from './Call';
 import { StreamClient } from './coordinator/connection/client';
 import { StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore } from './store';
-import type { ConnectedEvent, CreateDeviceRequest, CreateGuestRequest, CreateGuestResponse, GetEdgesResponse, ListDevicesResponse, QueryCallsRequest, QueryCallStatsRequest, QueryCallStatsResponse } from './gen/coordinator';
+import type { ConnectedEvent, CreateDeviceRequest, CreateGuestRequest, CreateGuestResponse, GetEdgesResponse, ListDevicesResponse, QueryAggregateCallStatsRequest, QueryAggregateCallStatsResponse, QueryCallsRequest, QueryCallStatsRequest, QueryCallStatsResponse } from './gen/coordinator';
 import { AllClientEvents, ClientEventListener, Logger, LogLevel, StreamClientOptions, TokenOrProvider, TokenProvider, User, UserWithId } from './coordinator/connection/types';
 /**
  * A `StreamVideoClient` instance lets you communicate with our API, and authenticate users.
@@ -111,6 +111,13 @@ export declare class StreamVideoClient {
      * @returns List with summary of available call reports matching the condition.
      */
     queryCallStats: (data?: QueryCallStatsRequest) => Promise<QueryCallStatsResponse>;
+    /**
+     * Retrieve the list of available reports aggregated from the call stats.
+     *
+     * @param data Specify filter conditions like from and to (within last 30 days) and the report types
+     * @returns Requested reports with (mostly) raw daily data for each report type requested
+     */
+    queryAggregateCallStats: (data?: QueryAggregateCallStatsRequest) => Promise<QueryAggregateCallStatsResponse>;
     /**
      * Returns a list of available data centers available for hosting calls.
      */

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

@@ -1,3 +1,4 @@
+import type { Bound, DailyAggregateCallStatsResponse } from '../shims';
 /**
  *
  * @export
@@ -481,6 +482,32 @@ export interface CallDeletedEvent {
      */
     type: string;
 }
+/**
+ *
+ * @export
+ * @interface CallDurationReportResponse
+ */
+export interface CallDurationReportResponse {
+    /**
+     *
+     * @type {Array<DailyAggregateCallStatsResponse<CallDurationReport>>}
+     * @memberof CallDurationReportResponse
+     */
+    daily: Array<DailyAggregateCallStatsResponse<CallDurationReport>>;
+}
+/**
+ *
+ * @export
+ * @interface CallDurationReport
+ */
+export interface CallDurationReport {
+    /**
+     *
+     * @type {Array<ReportByHistogramBucket>}
+     * @memberof CallDurationReport
+     */
+    histogram: Array<ReportByHistogramBucket>;
+}
 /**
  * This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen
  * @export
@@ -971,6 +998,32 @@ export interface CallParticipantResponse {
      */
     user_session_id: string;
 }
+/**
+ *
+ * @export
+ * @interface CallParticipantCountReportResponse
+ */
+export interface CallParticipantCountReportResponse {
+    /**
+     *
+     * @type {Array<DailyAggregateCallStatsResponse<CallParticipantCountReport>>}
+     * @memberof CallParticipantCountReportResponse
+     */
+    daily: Array<DailyAggregateCallStatsResponse<CallParticipantCountReport>>;
+}
+/**
+ *
+ * @export
+ * @interface CallParticipantCountReport
+ */
+export interface CallParticipantCountReport {
+    /**
+     *
+     * @type {Array<ReportByHistogramBucket>}
+     * @memberof CallParticipantCountReport
+     */
+    histogram: Array<ReportByHistogramBucket>;
+}
 /**
  * This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen
  * @export
@@ -1843,6 +1896,32 @@ export interface CallSettingsResponse {
      */
     video: VideoSettingsResponse;
 }
+/**
+ *
+ * @export
+ * @interface CallsPerDayReportResponse
+ */
+export interface CallsPerDayReportResponse {
+    /**
+     *
+     * @type {Array<DailyAggregateCallStatsResponse<CallsPerDayReport>>}
+     * @memberof CallsPerDayReportResponse
+     */
+    daily: Array<DailyAggregateCallStatsResponse<CallsPerDayReport>>;
+}
+/**
+ *
+ * @export
+ * @interface CallsPerDayReport
+ */
+export interface CallsPerDayReport {
+    /**
+     *
+     * @type {number}
+     * @memberof CallsPerDayReport
+     */
+    count: number;
+}
 /**
  *
  * @export
@@ -3432,6 +3511,12 @@ export interface GetCallResponse {
  * @interface GetCallStatsResponse
  */
 export interface GetCallStatsResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof GetCallStatsResponse
+     */
+    average_connection_time?: number;
     /**
      *
      * @type {number}
@@ -4229,6 +4314,37 @@ export interface MuteUsersResponse {
      */
     duration: string;
 }
+/**
+ *
+ * @export
+ * @interface NetworkMetricsReportResponse
+ */
+export interface NetworkMetricsReportResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof NetworkMetricsReportResponse
+     */
+    average_connection_time?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof NetworkMetricsReportResponse
+     */
+    average_jitter?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof NetworkMetricsReportResponse
+     */
+    average_latency?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof NetworkMetricsReportResponse
+     */
+    average_time_to_reconnect?: number;
+}
 /**
  *
  * @export
@@ -4678,6 +4794,27 @@ export interface PermissionRequestEvent {
      */
     user: UserResponse;
 }
+/**
+ *
+ * @export
+ * @interface PerSDKUsageReport
+ */
+export interface PerSDKUsageReport {
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof PerSDKUsageReport
+     */
+    by_version: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof PerSDKUsageReport
+     */
+    total: number;
+}
 /**
  *
  * @export
@@ -4830,6 +4967,112 @@ export interface PushNotificationSettingsResponse {
      */
     disabled_until?: string;
 }
+/**
+ *
+ * @export
+ * @interface QualityScoreReportResponse
+ */
+export interface QualityScoreReportResponse {
+    /**
+     *
+     * @type {Array<DailyAggregateCallStatsResponse<QualityScoreReport>>}
+     * @memberof QualityScoreReportResponse
+     */
+    daily: Array<DailyAggregateCallStatsResponse<QualityScoreReport>>;
+}
+/**
+ *
+ * @export
+ * @interface QualityScoreReport
+ */
+export interface QualityScoreReport {
+    /**
+     *
+     * @type {Array<ReportByHistogramBucket>}
+     * @memberof QualityScoreReport
+     */
+    histogram: Array<ReportByHistogramBucket>;
+}
+/**
+ *
+ * @export
+ * @interface QueryAggregateCallStatsRequest
+ */
+export interface QueryAggregateCallStatsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof QueryAggregateCallStatsRequest
+     */
+    from?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof QueryAggregateCallStatsRequest
+     */
+    report_types?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryAggregateCallStatsRequest
+     */
+    to?: string;
+}
+/**
+ * Basic response information
+ * @export
+ * @interface QueryAggregateCallStatsResponse
+ */
+export interface QueryAggregateCallStatsResponse {
+    /**
+     *
+     * @type {CallDurationReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    call_duration_report?: CallDurationReportResponse;
+    /**
+     *
+     * @type {CallParticipantCountReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    call_participant_count_report?: CallParticipantCountReportResponse;
+    /**
+     *
+     * @type {CallsPerDayReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    calls_per_day_report?: CallsPerDayReportResponse;
+    /**
+     * Duration of the request in milliseconds
+     * @type {string}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    duration: string;
+    /**
+     *
+     * @type {NetworkMetricsReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    network_metrics_report?: NetworkMetricsReportResponse;
+    /**
+     *
+     * @type {QualityScoreReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    quality_score_report?: QualityScoreReportResponse;
+    /**
+     *
+     * @type {SDKUsageReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    sdk_usage_report?: SDKUsageReportResponse;
+    /**
+     *
+     * @type {UserFeedbackReportResponse}
+     * @memberof QueryAggregateCallStatsResponse
+     */
+    user_feedback_report?: UserFeedbackReportResponse;
+}
 /**
  *
  * @export
@@ -5218,6 +5461,49 @@ export interface RejectCallResponse {
      */
     duration: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportByHistogramBucket
+ */
+export interface ReportByHistogramBucket {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportByHistogramBucket
+     */
+    category: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportByHistogramBucket
+     */
+    count: number;
+    /**
+     *
+     * @type {Bound}
+     * @memberof ReportByHistogramBucket
+     */
+    lower_bound?: Bound;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportByHistogramBucket
+     */
+    mean: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportByHistogramBucket
+     */
+    sum: number;
+    /**
+     *
+     * @type {Bound}
+     * @memberof ReportByHistogramBucket
+     */
+    upper_bound?: Bound;
+}
 /**
  *
  * @export
@@ -5413,6 +5699,34 @@ export interface ScreensharingSettingsResponse {
      */
     target_resolution?: TargetResolution;
 }
+/**
+ *
+ * @export
+ * @interface SDKUsageReportResponse
+ */
+export interface SDKUsageReportResponse {
+    /**
+     *
+     * @type {Array<DailyAggregateCallStatsResponse<SDKUsageReport>>}
+     * @memberof SDKUsageReportResponse
+     */
+    daily: Array<DailyAggregateCallStatsResponse<SDKUsageReport>>;
+}
+/**
+ *
+ * @export
+ * @interface SDKUsageReport
+ */
+export interface SDKUsageReport {
+    /**
+     *
+     * @type {{ [key: string]: PerSDKUsageReport; }}
+     * @memberof SDKUsageReport
+     */
+    per_sdk_usage: {
+        [key: string]: PerSDKUsageReport;
+    };
+}
 /**
  *
  * @export
@@ -6282,6 +6596,40 @@ export interface UserDeletedEvent {
      */
     user?: UserObject;
 }
+/**
+ *
+ * @export
+ * @interface UserFeedbackReportResponse
+ */
+export interface UserFeedbackReportResponse {
+    /**
+     *
+     * @type {Array<DailyAggregateCallStatsResponse<UserFeedbackReport>>}
+     * @memberof UserFeedbackReportResponse
+     */
+    daily: Array<DailyAggregateCallStatsResponse<UserFeedbackReport>>;
+}
+/**
+ *
+ * @export
+ * @interface UserFeedbackReport
+ */
+export interface UserFeedbackReport {
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof UserFeedbackReport
+     */
+    count_by_rating: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof UserFeedbackReport
+     */
+    unreported_count: number;
+}
 /**
  *
  * @export
@@ -6755,6 +7103,12 @@ export interface UserResponse {
  * @interface UserSessionStats
  */
 export interface UserSessionStats {
+    /**
+     *
+     * @type {number}
+     * @memberof UserSessionStats
+     */
+    average_connection_time?: number;
     /**
      *
      * @type {string}

package/dist/src/gen/shims.d.ts

@@ -1,3 +1,41 @@
 import type { TargetResolution } from './coordinator';
 export type TargetResolutionRequest = TargetResolution;
 export type TargetResolutionResponse = Required<TargetResolution>;
+/**
+ *
+ * @export
+ * @interface Bound
+ */
+export interface Bound {
+    /**
+     *
+     * @type {boolean}
+     * @memberof Bound
+     */
+    inclusive: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Bound
+     */
+    value: number;
+}
+/**
+ *
+ * @export
+ * @interface DailyAggregateCallStatsResponse
+ */
+export interface DailyAggregateCallStatsResponse<T = any> {
+    /**
+     *
+     * @type {string}
+     * @memberof DailyAggregateCallStatsResponse<T>
+     */
+    date: string;
+    /**
+     *
+     * @type {T}
+     * @memberof DailyAggregateCallStatsResponse<T>
+     */
+    report: T;
+}

package/package.json

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

package/src/Call.ts

@@ -615,8 +615,12 @@ export class Call {
     }
     // update the call state with the latest event data
     this.state.updateFromCallResponse(event.call);
-    this.ringingSubject.next(true);
     this.watching = true;
+    this.ringingSubject.next(true);
+    // we remove the instance from the calls list to enable the following filter in useCalls hook
+    // const calls = useCalls().filter((c) => c.ringing);
+    const calls = this.clientStore.calls.filter((c) => c.cid !== this.cid);
+    this.clientStore.setCalls([this, ...calls]);
     await this.applyDeviceConfig(false);
   };
 

package/src/StreamVideoClient.ts

@@ -11,6 +11,8 @@ import type {
   CreateGuestResponse,
   GetEdgesResponse,
   ListDevicesResponse,
+  QueryAggregateCallStatsRequest,
+  QueryAggregateCallStatsResponse,
   QueryCallsRequest,
   QueryCallsResponse,
   QueryCallStatsRequest,
@@ -439,6 +441,21 @@ export class StreamVideoClient {
     >(`/call/stats`, data);
   };
 
+  /**
+   * Retrieve the list of available reports aggregated from the call stats.
+   *
+   * @param data Specify filter conditions like from and to (within last 30 days) and the report types
+   * @returns Requested reports with (mostly) raw daily data for each report type requested
+   */
+  queryAggregateCallStats = async (
+    data: QueryAggregateCallStatsRequest = {},
+  ) => {
+    return this.streamClient.post<
+      QueryAggregateCallStatsResponse,
+      QueryAggregateCallStatsRequest
+    >(`/stats`, data);
+  };
+
   /**
    * Returns a list of available data centers available for hosting calls.
    */