chore: reorganize data exported by media-signaling lib (#39870)

Author: pierre-lehnen-rc

packages/media-signaling/src/definition/call/IClientMediaCall.ts

@@ -1,21 +1,12 @@
 import type { Emitter } from '@rocket.chat/emitter';
 
 import type { CallEvents } from './CallEvents';
-import type { IMediaStreamWrapper } from '../media/IMediaStreamWrapper';
-
-export type CallActorType = 'user' | 'sip';
-
-export type CallContact = {
-	type?: CallActorType;
-	id?: string;
-	contractId?: string;
-
-	displayName?: string;
-	username?: string;
-	sipExtension?: string;
-};
-
-export type CallRole = 'caller' | 'callee';
+import type {
+	AnyClientMediaCallParticipant,
+	IClientMediaCallLocalParticipant,
+	IClientMediaCallRemoteParticipant,
+} from './IClientMediaCallParticipant';
+import type { CallActorType } from './common';
 
 export type CallService = 'webrtc';
 
@@ -77,26 +68,13 @@ export type CallFlag = 'internal' | 'create-data-channel';
 
 export interface IClientMediaCall {
 	callId: string;
-	role: CallRole;
-	service: CallService | null;
-	flags: readonly CallFlag[];
-	features: readonly CallFeature[];
 
 	state: CallState;
 	ignored: boolean;
 	signed: boolean;
 	hidden: boolean;
-	muted: boolean;
-	/* if the call was put on hold */
-	held: boolean;
 	/* busy = state >= 'accepted' && state < 'hangup' */
 	busy: boolean;
-	/* if the other side has put the call on hold */
-	remoteHeld: boolean;
-	remoteMute: boolean;
-
-	contact: CallContact;
-	transferredBy: CallContact | null;
 
 	/** The timestamp of the moment the call was marked as active for the first time */
 	activeTimestamp?: Date;
@@ -108,14 +86,9 @@ export interface IClientMediaCall {
 
 	emitter: Emitter<CallEvents>;
 
-	getLocalMediaStream(tag?: string): IMediaStreamWrapper | null;
-	getRemoteMediaStream(tag?: string): IMediaStreamWrapper | null;
-
 	accept(): void;
 	reject(): void;
 	hangup(): void;
-	setMuted(muted: boolean): void;
-	setHeld(onHold: boolean): void;
 	requestScreenShare(requested: boolean): void;
 	setScreenVideoTrack(videoTrack: MediaStreamTrack | null): Promise<void>;
 	hasScreenVideoTrack(): boolean;
@@ -126,4 +99,9 @@ export interface IClientMediaCall {
 
 	getStats(selector?: MediaStreamTrack | null): Promise<RTCStatsReport | null>;
 	isFeatureAvailable(feature: CallFeature): boolean;
+	hasFlag(flag: CallFlag): boolean;
+
+	readonly localParticipant: IClientMediaCallLocalParticipant;
+	readonly remoteParticipants: IClientMediaCallRemoteParticipant[];
+	readonly participants: AnyClientMediaCallParticipant[];
 }

packages/media-signaling/src/definition/call/IClientMediaCallParticipant.ts

@@ -0,0 +1,35 @@
+import type { IMediaStreamWrapper } from '../media';
+import type { CallActorType, CallContact, CallRole } from './common';
+
+export interface IClientMediaCallParticipant {
+	readonly local: boolean;
+
+	readonly participantId: string;
+
+	readonly actorType: CallActorType;
+
+	readonly actorId: string;
+
+	readonly role: CallRole;
+
+	readonly muted: boolean;
+
+	readonly held: boolean;
+
+	readonly contact: CallContact;
+
+	getMediaStream(tag?: string): IMediaStreamWrapper | null;
+}
+
+export interface IClientMediaCallLocalParticipant extends IClientMediaCallParticipant {
+	readonly local: true;
+
+	setMuted(muted: boolean): void;
+	setHeld(onHold: boolean): void;
+}
+
+export interface IClientMediaCallRemoteParticipant extends IClientMediaCallParticipant {
+	readonly local: false;
+}
+
+export type AnyClientMediaCallParticipant = IClientMediaCallLocalParticipant | IClientMediaCallRemoteParticipant;

packages/media-signaling/src/definition/call/callStates/AnyMediaCallData.ts

@@ -0,0 +1,4 @@
+import type { IDirectMediaCallData } from './IDirectMediaCallData';
+import type { ITempMediaCallData } from './ITempMediaCallData';
+
+export type AnyMediaCallData = ITempMediaCallData | IDirectMediaCallData;

packages/media-signaling/src/definition/call/callStates/IDirectMediaCallData.ts

@@ -0,0 +1,23 @@
+import type { CallFeature, CallFlag, CallService, CallState } from '../IClientMediaCall';
+import type { IClientMediaCallLocalParticipant, IClientMediaCallRemoteParticipant } from '../IClientMediaCallParticipant';
+import type { CallContact } from '../common';
+
+export interface IDirectMediaCallData {
+	readonly confirmed: true;
+
+	readonly callId: string;
+	readonly service: CallService | null;
+	readonly flags: readonly CallFlag[];
+	readonly features: readonly CallFeature[];
+	readonly state: CallState;
+	readonly hidden: boolean;
+
+	readonly transferredBy: CallContact | null;
+
+	readonly activeTimestamp?: Date;
+
+	readonly tempCallId: string;
+
+	readonly localParticipant: IClientMediaCallLocalParticipant;
+	readonly remoteParticipant: IClientMediaCallRemoteParticipant;
+}

packages/media-signaling/src/definition/call/callStates/ITempMediaCallData.ts

@@ -0,0 +1,13 @@
+import type { CallState } from '../IClientMediaCall';
+import type { IClientMediaCallLocalParticipant } from '../IClientMediaCallParticipant';
+
+export interface ITempMediaCallData {
+	readonly confirmed: false;
+	readonly tempCallId: string;
+
+	readonly state: CallState;
+
+	readonly title: string;
+
+	readonly localParticipant: IClientMediaCallLocalParticipant;
+}

packages/media-signaling/src/definition/call/callStates/index.ts

@@ -0,0 +1,3 @@
+export type * from './AnyMediaCallData';
+export type * from './IDirectMediaCallData';
+export type * from './ITempMediaCallData';

packages/media-signaling/src/definition/call/common.ts

@@ -0,0 +1,13 @@
+export type CallActorType = 'user' | 'sip';
+
+export type CallContact = {
+	type?: CallActorType;
+	id?: string;
+	contractId?: string;
+
+	displayName?: string;
+	username?: string;
+	sipExtension?: string;
+};
+
+export type CallRole = 'caller' | 'callee';

packages/media-signaling/src/definition/call/index.ts

@@ -1,2 +1,5 @@
 export type * from './CallEvents';
+export type * from './callStates';
+export type * from './common';
 export * from './IClientMediaCall';
+export type * from './IClientMediaCallParticipant';