@observertc/observer-js 1.0.1-ec27289.0 → 1.1.0

package/src/common/logger.ts

@@ -1,82 +0,0 @@
-export interface Logger {
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	trace(...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	debug(...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	info(...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	warn(...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	error(...args: any[]): void;
-}
-
-export interface ObserverLogger {
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	trace(module: string, ...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	debug(module: string, ...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	info(module: string, ...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	warn(module: string, ...args: any[]): void;
-	/* eslint-disable @typescript-eslint/no-explicit-any */
-	error(module: string, ...args: any[]): void;
-}
-
-let mainLogger: ObserverLogger = new class implements ObserverLogger {
-	trace = () => void 0;
-	// trace(module: string, ...args: any[]) {
-	// 	// eslint-disable-next-line no-console
-	// 	console.log(`[TRACE] ${module}`, ...args);
-	// }
-
-	debug(module: string, ...args: any[]) {
-		// eslint-disable-next-line no-console
-		console.log(`[DEBUG] ${module}`, ...args);
-	}
-
-	info(module: string, ...args: any[]) {
-		// eslint-disable-next-line no-console
-		console.info(`[INFO] ${module}`, ...args);
-	}
-
-	warn(module: string, ...args: any[]) {
-		// eslint-disable-next-line no-console
-		console.warn(`[WARN] ${module}`, ...args);
-	}
-
-	error(module: string, ...args: any[]) {
-		// eslint-disable-next-line no-console
-		console.error(`[ERROR] ${module}`, ...args);
-	}
-}();
-
-export function createLogger(moduleName: string): Logger {
-	return new class implements Logger {
-		trace(...args: any[]) {
-			mainLogger.trace(moduleName, ...args);
-		}
-
-		debug(...args: any[]) {
-			mainLogger.debug(moduleName, ...args);
-		}
-
-		info(...args: any[]) {
-			mainLogger.info(moduleName, ...args);
-		}
-
-		warn(...args: any[]) {
-			mainLogger.warn(moduleName, ...args);
-		}
-
-		error(...args: any[]) {
-			mainLogger.error(moduleName, ...args);
-		}
-
-	}();
-}
-
-export function setObserverLogger(logger: ObserverLogger) {
-	mainLogger = logger;
-}

package/src/common/types.ts

@@ -1,4 +0,0 @@
-export type MediaKind = 'audio' | 'video';
-export type SupportedVideoCodecType = 'vp8' | 'vp9' | 'h264' | 'h265';
-
-// export type EvaluatorMiddleware = Middleware<EvaluatorContext>;

package/src/common/utils.ts

@@ -1,69 +0,0 @@
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-
-export type Writable<T> = T extends object ? { -readonly [K in keyof T]: Writable<T[K]> } : T;
-
-export function iteratorConverter<T>(generator: Generator<T, void, undefined>): IterableIterator<T> {
-	return {
-		[Symbol.iterator](): IterableIterator<T> {
-			return this;
-		},
-		next(): IteratorResult<T> {
-			return generator.next();
-		},
-	};
-}
-
-export function asyncIteratorConverter<T>(generator: AsyncGenerator<T, void, undefined>): AsyncIterableIterator<T> {
-	return {
-		[Symbol.asyncIterator](): AsyncIterableIterator<T> {
-			return this;
-		},
-		next(): Promise<IteratorResult<T>> {
-			return generator.next();
-		},
-	};
-}
-
-export function isValidUuid(str: string): boolean {
-	const regexp = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
-
-	return regexp.test(str);
-}
-
-export function getAverage(arr: number[], defaultAvgIfArrLengthIs0 = 0): number {
-	if (arr.length === 0) return defaultAvgIfArrLengthIs0;
-	
-	return arr.reduce((a, b) => a + b, 0) / arr.length;
-}
-
-export function getMedian(arr: number[], copyArrayForSorting = true): number {
-	// Sort the array in ascending order
-	const sortedArr = copyArrayForSorting 
-		? arr.slice().sort((a, b) => a - b)
-		: arr.sort((a, b) => a-b)
-
-	;
-
-	// Calculate the middle index
-	const mid = Math.floor(sortedArr.length / 2);
-
-	// If the array length is odd, return the middle element
-	if (sortedArr.length % 2 !== 0) {
-		return sortedArr[mid];
-	}
-
-	// If the array length is even, return the average of the two middle elements
-	return (sortedArr[mid - 1] + sortedArr[mid]) / 2;
-}
-
-export function parseJsonAs<T>(json?: string): T | undefined {
-	if (!json) {
-		return undefined;
-	}
-	
-	try {
-		return JSON.parse(json) as T;
-	} catch (error) {
-		return undefined;
-	}
-}

package/src/detectors/Detector.ts

@@ -1,6 +0,0 @@
-// import { AlertState } from "../ClientMonitor";
-
-export interface Detector {
-	readonly name: string;
-	update(): void;
-}

package/src/detectors/Detectors.ts

@@ -1,38 +0,0 @@
-import { createLogger } from '../common/logger';
-import { Detector } from './Detector';
-
-const logger = createLogger('Detectors');
-
-export class Detectors {
-	private _detectors: Detector[];
-
-	public constructor(...detectors: Detector[]) {
-		this._detectors = detectors;
-	}
-
-	public add(detector: Detector) {
-		this._detectors.push(detector);
-	}
-
-	public remove(detector: Detector) {
-		this._detectors = this._detectors.filter((d) => d !== detector);
-	}
-
-	get listOfNames() {
-		return this._detectors.map((d) => d.name);
-	}
-
-	public update() {
-		for (const detector of this._detectors) {
-			try {
-				detector.update();
-			} catch (err) {
-				logger.warn(`Error updating detector ${detector?.constructor?.name}`, err);
-			}
-		}
-	}
-
-	public clear() {
-		this._detectors = [];
-	}
-}

package/src/index.ts

@@ -1,28 +0,0 @@
-export type { ObserverEvents } from './Observer';
-
-export { Observer } from './Observer';
-export { ObservedCall } from './ObservedCall';
-export { ObservedInboundTrack } from './ObservedInboundTrack';
-export { ObservedOutboundTrack } from './ObservedOutboundTrack';
-export { ObservedClient } from './ObservedClient';
-export { ObservedPeerConnection } from './ObservedPeerConnection';
-export { ObservedMediaSource } from './ObservedMediaSource';
-export { ObservedMediaPlayout } from './ObservedMediaPlayout';
-export { ObservedCodec } from './ObservedCodec';
-export { ObservedCertificate } from './ObservedCertificate';
-export { ObservedDataChannel } from './ObservedDataChannel';
-export { ObservedInboundRtp } from './ObservedInboundRtp';
-export { ObservedOutboundRtp } from './ObservedOutboundRtp';
-export { ObservedRemoteInboundRtp } from './ObservedRemoteInboundRtp';
-export { ObservedRemoteOutboundRtp } from './ObservedRemoteOutboundRtp';
-export { ObservedIceCandidatePair } from './ObservedIceCandidatePair';
-export { ObservedIceCandidate } from './ObservedIceCandidate';
-export { ObservedIceTransport } from './ObservedIceTransport';
-export { ObservedPeerConnectionTransport } from './ObservedPeerConnectionTransport';
-export { ClientEventTypes } from './schema/ClientEventTypes';
-export { ClientMetaTypes } from './schema/ClientMetaTypes';
-export { ClientSample } from './schema/ClientSample';
-export { ScoreCalculator } from './scores/ScoreCalculator';
-export { ObservedClientEventMonitor } from './ObservedClientEventMonitor';
-
-export { Middleware } from './common/Middleware';

package/src/monitors/TurnUsageMonitor.ts

@@ -1,187 +0,0 @@
-// import { EventEmitter } from 'events';
-// import { ObservedPeerConnection } from '../ObservedPeerConnection';
-// import { ObservedICEEvents } from '../ObservedICE';
-// import { ObservedClient } from '../ObservedClient';
-
-// export type TurnUsageMonitorEvents = {
-// 	close: [],
-// 	'newturnip': [string],
-// 	update: [TurnUsage],
-// 	addpeerconnection: [ObservedPeerConnection],
-// 	removepeerconnection: [ObservedPeerConnection],
-// }
-
-// export type TurnUsage = {
-// 	turnIp: string;
-// 	totalBytesSent: number;
-// 	totalBytesReceived: number;
-// 	totalPacketsSent: number;
-// 	totalPacketsReceived: number;
-// }
-
-// export type TurnStats = {
-// 	turnIp: string;
-// 	totalBytesSent: number;
-// 	totalBytesReceived: number;
-// 	totalPacketsSent: number;
-// 	totalPacketsReceived: number;
-// 	deltaBytesSent: number;
-// 	deltaBytesReceived: number;
-// 	timestamp: number;
-// 	outboundBitrate: number;
-// 	inboundBitrate: number;
-// }
-
-// type ObservedConnection = {
-// 	peerConnection: ObservedPeerConnection,
-// 	onUpdate: (...e: ObservedICEEvents['update']) => void;
-
-// }
-
-// export declare interface TurnUsageMonitor {
-// 	on<U extends keyof TurnUsageMonitorEvents>(event: U, listener: (...args: TurnUsageMonitorEvents[U]) => void): this;
-// 	off<U extends keyof TurnUsageMonitorEvents>(event: U, listener: (...args: TurnUsageMonitorEvents[U]) => void): this;
-// 	once<U extends keyof TurnUsageMonitorEvents>(event: U, listener: (...args: TurnUsageMonitorEvents[U]) => void): this;
-// 	emit<U extends keyof TurnUsageMonitorEvents>(event: U, ...args: TurnUsageMonitorEvents[U]): boolean;
-// }
-
-// export class TurnUsageMonitor extends EventEmitter {
-// 	private readonly _connections = new Map<string, ObservedConnection>();
-// 	private readonly _turnUsage = new Map<string, TurnUsage>();
-// 	private readonly _stats = new Map<string, TurnStats>();
-
-// 	private _closed = false;
-// 	public constructor() {
-// 		super();
-// 		this.setMaxListeners(Infinity);
-// 	}
-
-// 	public get stats(): TurnStats[] {
-// 		const result: TurnStats[] = [];
-
-// 		for (const [ turnIp, usage ] of this._turnUsage) {
-// 			const stats = this._stats.get(turnIp) ?? {
-// 				turnIp,
-// 				totalBytesSent: 0,
-// 				totalBytesReceived: 0,
-// 				totalPacketsSent: 0,
-// 				totalPacketsReceived: 0,
-// 				deltaBytesSent: 0,
-// 				deltaBytesReceived: 0,
-// 				timestamp: Date.now(),
-// 				outboundBitrate: 0,
-// 				inboundBitrate: 0,
-// 			};
-
-// 			stats.deltaBytesSent = usage.totalBytesSent - stats.totalBytesSent;
-// 			stats.deltaBytesReceived = usage.totalBytesReceived - stats.totalBytesReceived;
-// 			stats.timestamp = Date.now();
-// 			stats.outboundBitrate = (stats.deltaBytesSent * 8) / ((stats.timestamp - stats.timestamp) / 1000.0);
-// 			stats.inboundBitrate = (stats.deltaBytesReceived * 8) / ((stats.timestamp - stats.timestamp) / 1000.0);
-// 			stats.totalBytesSent = usage.totalBytesSent;
-// 			stats.totalBytesReceived = usage.totalBytesReceived;
-// 			stats.totalPacketsSent = usage.totalPacketsSent;
-// 			stats.totalPacketsReceived = usage.totalPacketsReceived;
-
-// 			this._stats.set(turnIp, stats);
-
-// 			result.push(stats);
-// 		}
-
-// 		return result;
-// 	}
-
-// 	public addPeerConnection(peerConnection: ObservedPeerConnection) {
-// 		if (this.closed) return;
-// 		if (this._connections.has(peerConnection.peerConnectionId)) return;
-
-// 		const ice = peerConnection.ICE;
-
-// 		const onUpdate = () => {
-// 			const turnIp = ice?.selectedRemoteCandidate?.address;
-			
-// 			if (!peerConnection.usingTURN || !turnIp) return;
-			
-// 			let usage = this._turnUsage.get(turnIp);
-
-// 			if (!usage) {
-// 				usage = {
-// 					turnIp,
-// 					totalBytesSent: 0,
-// 					totalBytesReceived: 0,
-// 					totalPacketsSent: 0,
-// 					totalPacketsReceived: 0,
-// 				};
-// 				this._turnUsage.set(turnIp, usage);
-
-// 				this.emit('newturnip', turnIp);
-// 			}
-			
-// 			usage.totalBytesSent += ice.deltaBytesSent;
-// 			usage.totalBytesReceived += ice.deltaBytesReceived;
-// 			usage.totalPacketsSent += ice.deltaPacketsSent;
-// 			usage.totalPacketsReceived += ice.deltaPacketsReceived;
-
-// 			this.emit('update', usage);
-// 		};
-
-// 		peerConnection.ICE.on('update', onUpdate);
-
-// 		this._connections.set(peerConnection.peerConnectionId, {
-// 			peerConnection,
-// 			onUpdate
-// 		});
-
-// 		this.emit('addpeerconnection', peerConnection);
-// 	}
-
-// 	public removePeerConnection(peerConnection: ObservedPeerConnection) {
-// 		if (this.closed) return;
-// 		if (!this._connections.has(peerConnection.peerConnectionId)) return;
-
-// 		const { onUpdate } = this._connections.get(peerConnection.peerConnectionId) ?? {};
-		
-// 		if (!onUpdate) return;
-
-// 		peerConnection.ICE.off('update', onUpdate);
-
-// 		this._connections.delete(peerConnection.peerConnectionId);
-
-// 		this.emit('removepeerconnection', peerConnection);
-// 	}
-
-// 	public get turnIps() {
-// 		return Array.from(this._turnUsage.keys());
-// 	}
-
-// 	public get peerConnections() {
-// 		return Array.from(this._connections.values()).map(({ peerConnection }) => peerConnection);
-// 	}
-
-// 	public getUsage(turnIp: string) {
-// 		return this._turnUsage.get(turnIp);
-// 	}
-
-// 	public get clients(): ReadonlyMap<string, ObservedClient> {
-// 		const result = new Map<string, ObservedClient>();
-
-// 		for (const pc of this.peerConnections) {
-// 			if (result.has(pc.clientId)) continue;
-			
-// 			result.set(pc.clientId, pc.client);
-// 		}
-
-// 		return result;
-// 	}
-
-// 	public get closed() {
-// 		return this._closed;
-// 	}
-
-// 	public close() {
-// 		if (this._closed) return;
-// 		this._closed = true;
-
-// 		this.emit('close');
-// 	}
-// }

package/src/schema/ClientEventTypes.ts

@@ -1,112 +0,0 @@
-/* eslint-disable no-shadow */
-
-export enum ClientEventTypes {
-	CLIENT_JOINED = 'CLIENT_JOINED',
-	CLIENT_LEFT = 'CLIENT_LEFT',
-	PEER_CONNECTION_OPENED = 'PEER_CONNECTION_OPENED',
-	PEER_CONNECTION_CLOSED = 'PEER_CONNECTION_CLOSED',
-	MEDIA_TRACK_ADDED = 'MEDIA_TRACK_ADDED',
-	MEDIA_TRACK_REMOVED = 'MEDIA_TRACK_REMOVED',
-	MEDIA_TRACK_RESUMED = 'MEDIA_TRACK_RESUMED',
-	MEDIA_TRACK_MUTED = 'MEDIA_TRACK_MUTED',
-	MEDIA_TRACK_UNMUTED = 'MEDIA_TRACK_UNMUTED',
-	ICE_GATHERING_STATE_CHANGED = 'ICE_GATHERING_STATE_CHANGED',
-	PEER_CONNECTION_STATE_CHANGED = 'PEER_CONNECTION_STATE_CHANGED',
-	ICE_CONNECTION_STATE_CHANGED = 'ICE_CONNECTION_STATE_CHANGED',
-	DATA_CHANNEL_OPEN = 'DATA_CHANNEL_OPEN',
-	DATA_CHANNEL_CLOSED = 'DATA_CHANNEL_CLOSED',
-	DATA_CHANNEL_ERROR = 'DATA_CHANNEL_ERROR',
-	NEGOTIATION_NEEDED = 'NEGOTIATION_NEEDED',
-	SIGNALING_STATE_CHANGE = 'SIGNALING_STATE_CHANGE',
-	ICE_GATHERING_STATE_CHANGE = 'ICE_GATHERING_STATE_CHANGE',
-	ICE_CONNECTION_STATE_CHANGE = 'ICE_CONNECTION_STATE_CHANGE',
-	ICE_CANDIDATE = 'ICE_CANDIDATE',
-	
-	// mediasoup events
-	PRODUCER_ADDED = 'PRODUCER_ADDED',
-	PRODUCER_REMOVED = 'PRODUCER_REMOVED',
-	PRODUCER_PAUSED = 'PRODUCER_PAUSED',
-	PRODUCER_RESUMED = 'PRODUCER_RESUMED',
-	CONSUMER_ADDED = 'CONSUMER_ADDED',
-	CONSUMER_REMOVED = 'CONSUMER_REMOVED',
-	DATA_PRODUCER_CREATED = 'DATA_PRODUCER_CREATED',
-	DATA_PRODUCER_CLOSED = 'DATA_PRODUCER_CLOSED',
-	DATA_CONSUMER_CREATED = 'DATA_CONSUMER_CREATED',
-	DATA_CONSUMER_CLOSED = 'DATA_CONSUMER_CLOSED',
-}
-
-export interface PeerConnectionOpenedEventPayload extends Record<string, unknown> {
-	peerConnectionId: string;
-	iceConnectionState: string;
-	iceGatheringState: string;
-	signalingState: string;
-}
-
-export interface PeerConnectionClosedEventPayload extends Record<string, unknown> {
-	peerConnectionId: string;
-	iceConnectionState: string;
-	iceGatheringState: string;
-	signalingState: string;
-}
-
-export interface MediaTrackMutedEventPayload extends Record<string, unknown> {
-	trackId: string;
-	kind: 'audio' | 'video';
-	label?: string;
-	muted: boolean;
-	enabled: boolean;
-	readyState: string;
-	contentHint?: string;
-}
-
-export interface MediaTrackUnmutedEventPayload extends Record<string, unknown> {
-	trackId: string;
-	kind: 'audio' | 'video';
-	label?: string;
-	muted: boolean;
-	enabled: boolean;
-	readyState: string;
-	contentHint?: string;
-}
-
-export interface MediaTrackAddedEventPayload extends Record<string, unknown> {
-	trackId: string;
-	kind: 'audio' | 'video';
-	label?: string;
-	muted: boolean;
-	enabled: boolean;
-	readyState: string;
-	contentHint?: string;
-	constraints: MediaTrackConstraints,
-	capabilities: MediaTrackCapabilities,
-	settings: MediaTrackSettings,
-}
-
-export interface MediaTrackRemovedEventPayload extends Record<string, unknown> {
-	trackId: string;
-	kind: 'audio' | 'video';
-	label?: string;
-	muted: boolean;
-	enabled: boolean;
-	readyState: string;
-	contentHint?: string;
-}
-
-export interface DataChannelErrorEventPayload extends Record<string, unknown> {
-	label: string;
-	readyState: string;
-	dataChannelId: string,
-	error: string,
-}
-
-export interface DataChannelOpenEventPayload extends Record<string, unknown> {
-	label: string;
-	readyState: string;
-	dataChannelId: string,
-}
-
-export interface DataChannelClosedEventPayload extends Record<string, unknown> {
-	label: string;
-	readyState: string;
-	dataChannelId: string,
-}

package/src/schema/ClientMetaTypes.ts

@@ -1,41 +0,0 @@
-/* eslint-disable no-shadow */
-
-export enum ClientMetaTypes {
-	MEDIA_CONSTRAINT = 'MEDIA_CONSTRAINT',
-	MEDIA_DEVICE = 'MEDIA_DEVICE',
-	MEDIA_DEVICES_SUPPORTED_CONSTRAINTS = 'MEDIA_DEVICES_SUPPORTED_CONSTRAINTS',
-	USER_MEDIA_ERROR = 'USER_MEDIA_ERROR',
-	LOCAL_SDP = 'LOCAL_SDP',
-
-	OPERATION_SYSTEM = 'OPERATION_SYSTEM',
-	ENGINE = 'ENGINE',
-	PLATFORM = 'PLATFORM',
-	BROWSER = 'BROWSER',
-}
-
-export type MediaDeviceInfo = {
-	deviceId: string;
-	label: string;
-	kind: string;
-	groupId: string;
-}
-
-export type Browser = {
-	name: string;
-	version: string;
-}
-
-export type Platform = {
-	name: string;
-	version: string;
-}
-
-export type Engine = {
-	name: string;
-	version: string;
-}
-
-export type OperationSystem = {
-	name: string;
-	version: string;
-}