@observertc/observer-js 0.42.9 → 1.0.1-28c6425.0

package/.prettierrc

@@ -1,7 +1,7 @@
 {
-    "tabWidth": 2,
-    "useTabs": true,
-    "trailingComma": "es5",
-    "singleQuote": true,
-    "printWidth": 120
-}
+	"tabWidth": 2,
+	"useTabs": true,
+	"trailingComma": "es5",
+	"singleQuote": true,
+	"printWidth": 120
+}

package/README.md

@@ -1,106 +1,2 @@
 Server side component for monitoring WebRTC applications and services
 ---
-
-Table of Contents:
-
- * [Quick Start](#quick-start)
- * [Configurations](#configurations)
- * [NPM package](#npm-package)
- * [Schemas](#schemas)
- * [License](#license)
-
-## Qucik Start
-
-Install it from [npm](https://www.npmjs.com/package/@observertc/observer-js) package repository.
-
-```
-npm i @observertc/observer-js
-```
-
-Use it in your server side NodeJS app. 
-
-```javascript
-import { createObserver, ClientSample } from "@observertc/observer-js";
-
-const observer = createObserver({
-    defaultServiceId: 'my-service-name',
-    defaultMediaUnitId: 'my-reporting-component',
-});
-
-const observedCall = observer.createObservedCall({
-    roomId: 'roomId',
-    callId: 'room-session-id',
-});
-
-const observedClient = observedCall.createObservedClient({
-    clientId: 'client-id',
-    mediaUnitId: 'media-unit-id',
-});
-
-const clientSample: ClientSample; // Receive your samples, for example, from a WebSocket
-
-observedClient.accept(clientSample);
-```
-
-The above example do as follows:
- 1. create an observer to evaluate samples from clients and sfus
- 2. create a client source object to accept client samples
- 3. add an evaluator process to evaluate ended calls
-
- ### Get a Summary of a call when it ends
-
- ```javascript
-
- const monitor = observer.createCallSummaryMonitor('summary', (summary) => {
-     console.log('Call Summary', summary);
- });
- ```
-
- ### How Many Clients are using TURN?
-
-```javascript
-const monitor = observer.createTurnUsageMonitor('turn', (turn) => {
-    console.log('TURN', turn);
-});
-
-// at any point of time you can get the current state of the turn usage
-
-console.log('Currently ', monitor.clients.size, 'clients are using TURN');
-
-// you can get the incoming and outgoing bytes of the TURN server
-console.log(`${YOUR_TURN_SERVER_ADDRESS} usage:`, monitor.getUsage(YOUR_TURN_SERVER_ADDRESS));
-
-```
-
-### Monitor Calls and Clients as they updated
-
-```javascript
-observer.on('newcall', (call) => {
-    call.on('update', () => {
-        console.log('Call Updated', call.callId);
-    });
-
-    call.on('newclient', (client) => {
-
-        client.on('update', () => {
-            console.log('Client Updated', client.clientId);
-
-            console.log(`The avaialble incoming bitrate for the client ${client.clientId} is: ${client.availableIncomingBitrate}`)
-        });
-    })
-});
-```
-
-## NPM package
-
-https://www.npmjs.com/package/@observertc/observer-js
-
-
-## Schemas
-
-https://github.com/observertc/schemas
-
-
-## License
-
-Apache-2.0

package/lib/ObservedCall.d.ts

@@ -1,24 +1,28 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-import { ObservedClient, ObservedClientModel } from './ObservedClient';
+import { ObservedClient, ObservedClientSettings } from './ObservedClient';
 import { Observer } from './Observer';
-import { PartialBy } from './common/utils';
-import { CallEventReport } from '@observertc/report-schemas-js';
-import { ClientSample } from '@observertc/sample-schemas-js';
-import { ObservedOutboundAudioTrack } from './ObservedOutboundAudioTrack';
-import { ObservedOutboundVideoTrack } from './ObservedOutboundVideoTrack';
-import { CalculatedScore } from './common/CalculatedScore';
-export type ObservedCallModel = {
-    serviceId: string;
-    roomId: string;
+import { ScoreCalculator } from './scores/ScoreCalculator';
+import { CalculatedScore } from './scores/CalculatedScore';
+import { Detectors } from './detectors/Detectors';
+import { RemoteTrackResolver } from './utils/RemoteTrackResolver';
+import { Updater } from './updaters/Updater';
+import { ObservedCallSummary } from './ObservedCallSummary';
+export type ObservedCallSettings<AppData extends Record<string, unknown> = Record<string, unknown>> = {
     callId: string;
+    appData?: AppData;
+    remoteTrackResolvePolicy?: 'p2p' | 'mediasoup-sfu';
+    updatePolicy?: 'update-on-any-client-updated' | 'update-when-all-client-updated' | 'update-on-interval';
+    updateIntervalInMs?: number;
 };
 export type ObservedCallEvents = {
     update: [];
     newclient: [ObservedClient];
-    callevent: [Omit<CallEventReport, 'callId' | 'serviceId' | 'roomId'>];
     empty: [];
+    'not-empty': [];
     close: [];
+    started: [];
+    ended: [];
 };
 export declare interface ObservedCall {
     on<U extends keyof ObservedCallEvents>(event: U, listener: (...args: ObservedCallEvents[U]) => void): this;
@@ -27,39 +31,59 @@ export declare interface ObservedCall {
     emit<U extends keyof ObservedCallEvents>(event: U, ...args: ObservedCallEvents[U]): boolean;
 }
 export declare class ObservedCall<AppData extends Record<string, unknown> = Record<string, unknown>> extends EventEmitter {
-    private readonly _model;
     readonly observer: Observer;
-    readonly appData: AppData;
-    readonly created: number;
-    readonly processor: import("./common/Middleware").Processor<ClientSample>;
-    private readonly _clients;
-    _scoreData?: {
-        score: CalculatedScore;
-        calculated: number;
-    };
-    readonly sfuStreamIdToOutboundAudioTrack: Map<string | number, ObservedOutboundAudioTrack>;
-    readonly sfuStreamIdToOutboundVideoTrack: Map<string | number, ObservedOutboundVideoTrack>;
-    private _closed;
-    started?: number;
+    readonly detectors: Detectors;
+    updater?: Updater;
+    scoreCalculator: ScoreCalculator;
+    readonly callId: string;
+    readonly observedClients: Map<string, ObservedClient<Record<string, unknown>>>;
+    readonly clientsUsedTurn: Set<string>;
+    readonly calculatedScore: CalculatedScore;
+    remoteTrackResolver?: RemoteTrackResolver;
+    totalAddedClients: number;
+    totalRemovedClients: number;
+    totalClientsReceivedAudioBytes: number;
+    totalClientsReceivedVideoBytes: number;
+    totalClientsReceivedDataChannelBytes: number;
+    totalClientsReceivedBytes: number;
+    totalClientsSentAudioBytes: number;
+    totalClientsSentDataChannelBytes: number;
+    totalClientsSentVideoBytes: number;
+    totalClientsSentBytes: number;
+    totalRttLt50Measurements: number;
+    totalRttLt150Measurements: number;
+    totalRttLt300Measurements: number;
+    totalRttGtOrEq300Measurements: number;
+    numberOfIssues: number;
+    numberOfPeerConnections: number;
+    numberOfInboundRtpStreams: number;
+    numberOfOutboundRtpStreams: number;
+    numberOfDataChannels: number;
+    maxNumberOfClients: number;
+    deltaNumberOfIssues: number;
+    deltaRttLt50Measurements: number;
+    deltaRttLt150Measurements: number;
+    deltaRttLt300Measurements: number;
+    deltaRttGtOrEq300Measurements: number;
+    appData: AppData;
+    closed: boolean;
+    startedAt?: number;
     ended?: number;
-    observationUpdated: number;
-    observationEnded?: number;
-    readonly observationStarted: number;
-    constructor(_model: ObservedCallModel, observer: Observer, appData: AppData);
-    get serviceId(): string;
-    get reports(): import("./ReportsCollector").ReportsCollector;
-    get roomId(): string;
-    get callId(): string;
-    get clients(): ReadonlyMap<string, ObservedClient>;
-    get score(): CalculatedScore | undefined;
-    get closed(): boolean;
+    private _callStartedEvent;
+    private _callEndedEvent;
+    constructor(settings: ObservedCallSettings<AppData>, observer: Observer);
+    get numberOfClients(): number;
+    get score(): number | undefined;
     close(): void;
-    addEventReport(params: PartialBy<Omit<CallEventReport, 'serviceId' | 'roomId' | 'callId'>, 'timestamp'>): void;
-    createClient<ClientAppData extends Record<string, unknown> = Record<string, unknown>>(config: ObservedClientModel & {
-        appData: ClientAppData;
-        joinedTimestamp?: number;
-        createClientJoinedReport?: boolean;
-        createClientLeftReport?: boolean;
-    }): ObservedClient<ClientAppData>;
+    getObservedClient<ClientAppData extends Record<string, unknown> = Record<string, unknown>>(clientId: string): ObservedClient<ClientAppData> | undefined;
+    createObservedClient<ClientAppData extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedClientSettings<ClientAppData>): ObservedClient<ClientAppData>;
+    update(): void;
+    private _onClientUpdate;
+    private _clientJoined;
+    private _clientLeft;
+    emitCallStartedEvent(): void;
+    emitCallEndedEvent(): void;
+    resetSummaryMetrics(): void;
+    createSummary(): ObservedCallSummary;
 }
 //# sourceMappingURL=ObservedCall.d.ts.map

package/lib/ObservedCall.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ObservedCall.d.ts","sourceRoot":"","sources":["../src/ObservedCall.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAa,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,MAAM,MAAM,iBAAiB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,EAAE,CAAC;IACX,SAAS,EAAE,CAAC,cAAc,CAAC,CAAC;IAC5B,SAAS,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC;IACtE,KAAK,EAAE,EAAE,CAAC;IACV,KAAK,EAAE,EAAE,CAAC;CACV,CAAA;AAED,MAAM,CAAC,OAAO,WAAW,YAAY;IACpC,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3G,GAAG,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5G,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC7G,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;CAC5F;AAED,qBAAa,YAAY,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAE,SAAQ,YAAY;IAyB/G,OAAO,CAAC,QAAQ,CAAC,MAAM;aACP,QAAQ,EAAE,QAAQ;aAClB,OAAO,EAAE,OAAO;IA1BjC,SAAgB,OAAO,SAAc;IAErC,SAAgB,SAAS,wDAAmC;IAE5D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqC;IAEvD,UAAU,CAAC,EAAE;QACnB,KAAK,EAAE,eAAe,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF,SAAgB,+BAA+B,mDAA0D;IACzG,SAAgB,+BAA+B,mDAA0D;IACzG,OAAO,CAAC,OAAO,CAAS;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB,SAAc;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACjC,SAAgB,kBAAkB,SAAc;gBAG9B,MAAM,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,OAAO;IAMjC,IAAW,SAAS,IAAI,MAAM,CAG7B;IAED,IAAW,OAAO,kDAEjB;IAED,IAAW,MAAM,WAGhB;IAED,IAAW,MAAM,WAGhB;IAED,IAAW,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAExD;IAED,IAAW,KAAK,IAAI,eAAe,GAAG,SAAS,CA2B9C;IAED,IAAW,MAAM,YAEhB;IAEM,KAAK;IAWL,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAE,EAAE,WAAW,CAAC;IAUxG,YAAY,CAAC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,mBAAmB,GAAG;QAC1H,OAAO,EAAE,aAAa,CAAC;QAIvB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,wBAAwB,CAAC,EAAE,OAAO,CAAC;QACnC,sBAAsB,CAAC,EAAE,OAAO,CAAC;KACjC;CA0ED"}
+{"version":3,"file":"ObservedCall.d.ts","sourceRoot":"","sources":["../src/ObservedCall.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACrG,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wBAAwB,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC;IACnD,YAAY,CAAC,EAAE,8BAA8B,GAAG,gCAAgC,GAAG,oBAAoB,CAAC;IACxG,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,EAAE,CAAC;IACX,SAAS,EAAE,CAAC,cAAc,CAAC,CAAC;IAC5B,KAAK,EAAE,EAAE,CAAC;IACV,WAAW,EAAE,EAAE,CAAC;IAChB,KAAK,EAAE,EAAE,CAAC;IACV,OAAO,EAAE,EAAE,CAAC;IACZ,KAAK,EAAE,EAAE,CAAC;CACV,CAAA;AAED,MAAM,CAAC,OAAO,WAAW,YAAY;IACpC,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3G,GAAG,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5G,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC7G,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;CAC5F;AAED,qBAAa,YAAY,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAE,SAAQ,YAAY;aA4D/F,QAAQ,EAAE,QAAQ;IA3DnC,SAAgB,SAAS,EAAE,SAAS,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,eAAe,CAAC;IACxC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,eAAe,uDAAqC;IACpE,SAAgB,eAAe,cAAqB;IACpD,SAAgB,eAAe,EAAE,eAAe,CAG9C;IACK,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,iBAAiB,SAAK;IACtB,mBAAmB,SAAK;IAExB,8BAA8B,SAAK;IACnC,8BAA8B,SAAK;IACnC,oCAAoC,SAAK;IACzC,yBAAyB,SAAK;IAE9B,0BAA0B,SAAK;IAC/B,gCAAgC,SAAK;IACrC,0BAA0B,SAAK;IAC/B,qBAAqB,SAAK;IAE1B,wBAAwB,SAAK;IAC7B,yBAAyB,SAAK;IAC9B,yBAAyB,SAAK;IAC9B,6BAA6B,SAAK;IAElC,cAAc,SAAK;IACnB,uBAAuB,SAAK;IAC5B,yBAAyB,SAAK;IAC9B,0BAA0B,SAAK;IAC/B,oBAAoB,SAAK;IAEzB,kBAAkB,SAAK;IACvB,mBAAmB,SAAK;IAExB,wBAAwB,SAAK;IAC7B,yBAAyB,SAAK;IAC9B,yBAAyB,SAAK;IAC9B,6BAA6B,SAAK;IAElC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,UAAS;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,iBAAiB,CAGvB;IACF,OAAO,CAAC,eAAe,CAErB;gBAGD,QAAQ,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACvB,QAAQ,EAAE,QAAQ;IA8CnC,IAAW,eAAe,WAEzB;IAED,IAAW,KAAK,uBAEf;IAEM,KAAK;IAcL,iBAAiB,CAAC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAC,aAAa,CAAC,GAAG,SAAS;IAMvJ,oBAAoB,CAAC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,sBAAsB,CAAC,aAAa,CAAC,GAAG,cAAc,CAAC,aAAa,CAAC;IAsC7K,MAAM;IA+Bb,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,aAAa;IAkBrB,OAAO,CAAC,WAAW;IAMZ,oBAAoB;IASpB,kBAAkB;IAOlB,mBAAmB;IAuBnB,aAAa,IAAI,mBAAmB;CAuB3C"}

package/lib/ObservedCall.js

@@ -1,139 +1,263 @@
 "use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObservedCall = void 0;
 const events_1 = require("events");
 const ObservedClient_1 = require("./ObservedClient");
-const callEventReports_1 = require("./common/callEventReports");
-const utils_1 = require("./common/utils");
-const Middleware_1 = require("./common/Middleware");
+const DefaultCallScoreCalculator_1 = require("./scores/DefaultCallScoreCalculator");
+const Detectors_1 = require("./detectors/Detectors");
+const OnAllClientCallUpdater_1 = require("./updaters/OnAllClientCallUpdater");
+const OnIntervalUpdater_1 = require("./updaters/OnIntervalUpdater");
+const OnAnyClientCallUpdater_1 = require("./updaters/OnAnyClientCallUpdater");
 class ObservedCall extends events_1.EventEmitter {
-    constructor(_model, observer, appData) {
+    observer;
+    detectors;
+    updater;
+    scoreCalculator;
+    callId;
+    observedClients = new Map();
+    clientsUsedTurn = new Set();
+    calculatedScore = {
+        weight: 1,
+        value: undefined,
+    };
+    remoteTrackResolver;
+    totalAddedClients = 0;
+    totalRemovedClients = 0;
+    totalClientsReceivedAudioBytes = 0;
+    totalClientsReceivedVideoBytes = 0;
+    totalClientsReceivedDataChannelBytes = 0;
+    totalClientsReceivedBytes = 0;
+    totalClientsSentAudioBytes = 0;
+    totalClientsSentDataChannelBytes = 0;
+    totalClientsSentVideoBytes = 0;
+    totalClientsSentBytes = 0;
+    totalRttLt50Measurements = 0;
+    totalRttLt150Measurements = 0;
+    totalRttLt300Measurements = 0;
+    totalRttGtOrEq300Measurements = 0;
+    numberOfIssues = 0;
+    numberOfPeerConnections = 0;
+    numberOfInboundRtpStreams = 0;
+    numberOfOutboundRtpStreams = 0;
+    numberOfDataChannels = 0;
+    maxNumberOfClients = 0;
+    deltaNumberOfIssues = 0;
+    deltaRttLt50Measurements = 0;
+    deltaRttLt150Measurements = 0;
+    deltaRttLt300Measurements = 0;
+    deltaRttGtOrEq300Measurements = 0;
+    appData;
+    closed = false;
+    startedAt;
+    ended;
+    _callStartedEvent;
+    _callEndedEvent;
+    constructor(settings, observer) {
         super();
-        this._model = _model;
         this.observer = observer;
-        this.appData = appData;
-        this.created = Date.now();
-        this.processor = (0, Middleware_1.createProcessor)();
-        this._clients = new Map();
-        this.sfuStreamIdToOutboundAudioTrack = new Map();
-        this.sfuStreamIdToOutboundVideoTrack = new Map();
-        this._closed = false;
-        this.observationUpdated = Date.now();
-        this.observationStarted = Date.now();
         this.setMaxListeners(Infinity);
-    }
-    get serviceId() {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return this._model.serviceId;
-    }
-    get reports() {
-        return this.observer.reports;
-    }
-    get roomId() {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return this._model.roomId;
-    }
-    get callId() {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return this._model.callId;
-    }
-    get clients() {
-        return this._clients;
-    }
-    get score() {
-        var _a, _b, _c;
-        const now = Date.now();
-        if (now - 15000 < ((_b = (_a = this._scoreData) === null || _a === void 0 ? void 0 : _a.calculated) !== null && _b !== void 0 ? _b : 0)) {
-            return (_c = this._scoreData) === null || _c === void 0 ? void 0 : _c.score;
+        this.callId = settings.callId;
+        this.appData = settings.appData ?? {};
+        this.scoreCalculator = new DefaultCallScoreCalculator_1.DefaultCallScoreCalculator(this);
+        this.detectors = new Detectors_1.Detectors();
+        if (settings.updateIntervalInMs) {
+            if (settings.updatePolicy !== 'update-on-interval') {
+                throw new Error('updatePolicy must be update-on-interval if updateIntervalInMs is set in config');
+            }
         }
-        else if (this.clients.size < 1) {
-            return {
-                remarks: [{
-                        severity: 'none',
-                        text: 'No clients',
-                    }],
-                score: 5.0,
-                timestamp: now,
-            };
+        switch (settings.updatePolicy) {
+            case 'update-on-any-client-updated':
+                this.updater = new OnAllClientCallUpdater_1.OnAllClientCallUpdater(this);
+                break;
+            case 'update-when-all-client-updated':
+                this.updater = new OnAnyClientCallUpdater_1.OnAnyClientCallUpdater(this);
+                break;
+            case 'update-on-interval':
+                if (!settings.updateIntervalInMs) {
+                    throw new Error('updateIntervalInMs setting in config must be set if updatePolicy is update-on-interval');
+                }
+                this.updater = new OnIntervalUpdater_1.OnIntervalUpdater(settings.updateIntervalInMs, this.update.bind(this));
+                break;
+        }
+        switch (settings.remoteTrackResolvePolicy) {
+            case 'mediasoup-sfu':
+                break;
         }
-        const scores = [...this.clients.values()].map((client) => { var _a, _b; return (_b = (_a = client.score) === null || _a === void 0 ? void 0 : _a.score) !== null && _b !== void 0 ? _b : 5.0; });
-        this._scoreData = {
-            score: {
-                remarks: [],
-                score: (0, utils_1.getMedian)(scores),
-                timestamp: now,
-            },
-            calculated: now,
+        this._callStartedEvent = {
+            emitted: false,
+        };
+        this._callEndedEvent = {
+            emitted: false,
         };
-        return this._scoreData.score;
     }
-    get closed() {
-        return this._closed;
+    get numberOfClients() {
+        return this.observedClients.size;
+    }
+    get score() {
+        return this.calculatedScore.value;
     }
     close() {
-        if (this._closed)
+        if (this.closed)
             return;
-        this._closed = true;
-        Array.from(this._clients.values()).forEach((client) => client.close());
-        this.observationEnded = Date.now();
+        this.closed = true;
+        this.updater?.close();
+        [...this.observedClients.values()].forEach((client) => client.close());
+        // make sure to emit the events
+        this.emitCallStartedEvent();
+        this.emitCallEndedEvent();
         this.emit('close');
     }
-    addEventReport(params) {
-        var _a;
-        this.reports.addCallEventReport(Object.assign(Object.assign({}, params), { serviceId: this.serviceId, roomId: this.roomId, callId: this.callId, timestamp: (_a = params.timestamp) !== null && _a !== void 0 ? _a : Date.now() }));
+    getObservedClient(clientId) {
+        if (this.closed || !this.observedClients.has(clientId))
+            return;
+        return this.observedClients.get(clientId);
     }
-    createClient(config) {
-        var _a;
-        if (this._closed)
+    createObservedClient(settings) {
+        if (this.closed)
             throw new Error(`Call ${this.callId} is closed`);
-        const { appData, createClientJoinedReport, createClientLeftReport, joinedTimestamp = Date.now() } = config, model = __rest(config, ["appData", "createClientJoinedReport", "createClientLeftReport", "joinedTimestamp"]);
-        const result = new ObservedClient_1.ObservedClient(model, this, appData);
-        const onUpdate = ({ sample }) => {
-            this.observationUpdated = Date.now();
-            if (result.joined) {
-                if (this.started === undefined || result.joined < this.started) {
-                    this.started = result.joined;
-                }
-            }
-            if (result.left) {
-                if (this.ended === undefined || result.left > this.ended) {
-                    this.ended = result.left;
-                }
-            }
-            this.emit('update');
-            this.processor.process(sample);
-        };
+        if (this.observedClients.has(settings.clientId))
+            throw new Error(`Client with id ${settings.clientId} already exists`);
+        const result = new ObservedClient_1.ObservedClient(settings, this);
+        const wasEmpty = this.observedClients.size === 0;
+        const onUpdate = () => this._onClientUpdate(result);
+        const joined = () => this._clientJoined(result);
+        const left = () => this._clientLeft(result);
         result.once('close', () => {
             result.off('update', onUpdate);
-            this._clients.delete(result.clientId);
-            if (this._clients.size === 0) {
+            result.off('joined', joined);
+            result.off('left', left);
+            this.observedClients.delete(settings.clientId);
+            if (this.observedClients.size === 0) {
                 this.emit('empty');
             }
+            --this.totalRemovedClients;
         });
         result.on('update', onUpdate);
-        this._clients.set(result.clientId, result);
-        if (createClientJoinedReport) {
-            this.reports.addCallEventReport((0, callEventReports_1.createClientJoinedEventReport)(this.serviceId, result.mediaUnitId, this.roomId, this.callId, result.clientId, (_a = result.joined) !== null && _a !== void 0 ? _a : joinedTimestamp, result.userId, result.marker));
-        }
-        result.once('close', () => {
-            var _a;
-            if (createClientLeftReport) {
-                this.reports.addCallEventReport((0, callEventReports_1.createClientLeftEventReport)(this.serviceId, result.mediaUnitId, this.roomId, this.callId, result.clientId, (_a = result.left) !== null && _a !== void 0 ? _a : Date.now(), result.userId, result.marker));
-            }
-        });
+        result.on('joined', joined);
+        result.on('left', left);
+        ++this.totalAddedClients;
+        this.observedClients.set(settings.clientId, result);
+        this.maxNumberOfClients = Math.max(this.maxNumberOfClients, this.observedClients.size);
         this.emit('newclient', result);
+        if (wasEmpty) {
+            this.emit('not-empty');
+        }
         return result;
     }
+    update() {
+        if (this.closed)
+            return;
+        this.numberOfInboundRtpStreams = 0;
+        this.numberOfOutboundRtpStreams = 0;
+        this.numberOfPeerConnections = 0;
+        this.numberOfDataChannels = 0;
+        for (const client of this.observedClients.values()) {
+            this.numberOfInboundRtpStreams += client.numberOfInboundRtpStreams;
+            this.numberOfOutboundRtpStreams += client.numberOfOutboundRtpStreams;
+            this.numberOfPeerConnections += client.numberOfPeerConnections;
+            this.numberOfDataChannels += client.numberOfDataChannels;
+            if (client.usingTURN) {
+                this.clientsUsedTurn.add(client.clientId);
+            }
+        }
+        this.detectors.update();
+        this.scoreCalculator.update();
+        this.emit('update');
+        this.deltaNumberOfIssues = 0;
+        this.deltaRttLt50Measurements = 0;
+        this.deltaRttLt150Measurements = 0;
+        this.deltaRttLt300Measurements = 0;
+        this.deltaRttGtOrEq300Measurements = 0;
+    }
+    _onClientUpdate(client) {
+        this.totalClientsReceivedAudioBytes += client.deltaReceivedAudioBytes;
+        this.totalClientsSentAudioBytes += client.deltaSentAudioBytes;
+        this.totalClientsReceivedVideoBytes += client.deltaReceivedVideoBytes;
+        this.totalClientsReceivedVideoBytes += client.deltaSentVideoBytes;
+        this.totalClientsReceivedDataChannelBytes += client.deltaDataChannelBytesReceived;
+        this.totalClientsSentDataChannelBytes += client.deltaDataChannelBytesSent;
+        this.totalClientsReceivedBytes += client.deltaTransportReceivedBytes;
+        this.totalClientsSentBytes += client.deltaTransportSentBytes;
+        this.deltaRttLt50Measurements += client.deltaRttLt50Measurements;
+        this.deltaRttLt150Measurements += client.deltaRttLt150Measurements;
+        this.deltaRttLt300Measurements += client.deltaRttLt300Measurements;
+        this.deltaRttGtOrEq300Measurements += client.deltaRttGtOrEq300Measurements;
+        this.totalRttLt50Measurements += client.deltaRttLt50Measurements;
+        this.totalRttLt150Measurements += client.deltaRttLt150Measurements;
+        this.totalRttLt300Measurements += client.deltaRttLt300Measurements;
+        this.totalRttGtOrEq300Measurements += client.deltaRttGtOrEq300Measurements;
+        this.deltaNumberOfIssues += client.deltaNumberOfIssues;
+        this.numberOfIssues += client.deltaNumberOfIssues;
+    }
+    _clientJoined(client) {
+        if (!client.joinedAt)
+            return;
+        this.startedAt = Math.min(this.startedAt ?? client.joinedAt, client.joinedAt);
+        if (this._callStartedEvent.emitted)
+            return;
+        if (this._callStartedEvent.timer) {
+            if (1 < this.observedClients.size) {
+                this.emitCallStartedEvent();
+            }
+            return;
+        }
+        this._callStartedEvent.timer = setTimeout(() => {
+            this.emitCallStartedEvent();
+        }, 5000);
+    }
+    _clientLeft(client) {
+        if (!client.leftAt)
+            return;
+        this.ended = Math.max(this.ended ?? client.leftAt, client.leftAt);
+    }
+    emitCallStartedEvent() {
+        if (this._callStartedEvent.emitted)
+            return;
+        this._callStartedEvent.emitted = true;
+        clearTimeout(this._callStartedEvent.timer);
+        this._callStartedEvent.timer = undefined;
+        this.emit('started');
+    }
+    emitCallEndedEvent() {
+        if (this._callEndedEvent.emitted)
+            return;
+        this._callEndedEvent.emitted = true;
+        this.emit('ended');
+    }
+    resetSummaryMetrics() {
+        this.totalAddedClients = 0;
+        this.totalRemovedClients = 0;
+        this.totalClientsReceivedAudioBytes = 0;
+        this.totalClientsReceivedVideoBytes = 0;
+        this.totalClientsReceivedBytes = 0;
+        this.totalClientsSentAudioBytes = 0;
+        this.totalClientsSentVideoBytes = 0;
+        this.totalClientsSentBytes = 0;
+        this.totalRttLt50Measurements = 0;
+        this.totalRttLt150Measurements = 0;
+        this.totalRttLt300Measurements = 0;
+        this.totalRttGtOrEq300Measurements = 0;
+        this.numberOfIssues = 0;
+        this.clientsUsedTurn.clear();
+    }
+    createSummary() {
+        return {
+            currentActiveClients: this.observedClients.size,
+            totalAddedClients: this.totalAddedClients,
+            totalRemovedClients: this.totalRemovedClients,
+            totalClientsReceivedAudioBytes: this.totalClientsReceivedBytes,
+            totalClientsReceivedVideoBytes: this.totalClientsReceivedVideoBytes,
+            totalClientsReceivedBytes: this.totalClientsReceivedBytes,
+            totalClientsSentAudioBytes: this.totalClientsSentAudioBytes,
+            totalClientsSentVideoBytes: this.totalClientsSentVideoBytes,
+            totalClientsSentBytes: this.totalClientsSentBytes,
+            totalRttLt50Measurements: this.totalRttLt50Measurements,
+            totalRttLt150Measurements: this.totalRttLt150Measurements,
+            totalRttLt300Measurements: this.totalRttLt300Measurements,
+            totalRttGtOrEq300Measurements: this.totalRttGtOrEq300Measurements,
+            numberOfIssues: this.numberOfIssues,
+            numberOfClientsUsedTurn: this.clientsUsedTurn.size,
+        };
+    }
 }
 exports.ObservedCall = ObservedCall;

package/lib/ObservedCallSummary.d.ts

@@ -0,0 +1,18 @@
+export type ObservedCallSummary = {
+    currentActiveClients: number;
+    totalAddedClients: number;
+    totalRemovedClients: number;
+    totalClientsSentBytes: number;
+    totalClientsReceivedBytes: number;
+    totalClientsReceivedAudioBytes: number;
+    totalClientsReceivedVideoBytes: number;
+    totalClientsSentAudioBytes: number;
+    totalClientsSentVideoBytes: number;
+    totalRttLt50Measurements: number;
+    totalRttLt150Measurements: number;
+    totalRttLt300Measurements: number;
+    totalRttGtOrEq300Measurements: number;
+    numberOfIssues: number;
+    numberOfClientsUsedTurn: number;
+};
+//# sourceMappingURL=ObservedCallSummary.d.ts.map