@vkontakte/calls-sdk 2.8.11 → 2.8.12-beta.1

package/classes/Conversation.d.ts

@@ -9,12 +9,12 @@ import MediaOption from '../enums/MediaOption';
 import UpdateDisplayLayoutErrorReason from '../enums/UpdateDisplayLayoutErrorReason';
 import UserRole from '../enums/UserRole';
 import UserType from '../enums/UserType';
+import { DebugMessageType } from '../static/Debug';
 import { JSONObject } from '../static/Json';
 import { IAsrStartParams, IAsrStopParams } from '../types/Asr';
 import { AudienceModeHandsResponse } from '../types/AudienceMode';
-import { ConversationData, ConversationOnStartParams } from '../types/Conversation';
-import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalUserId } from '../types/ExternalId';
-import type { FastJoinHandler } from '../types/FastJoin';
+import { ConversationData, ConversationOnJoinParams, ConversationOnStartParams } from '../types/Conversation';
+import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk } from '../types/ExternalId';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings, { IVideoDimentions } from '../types/MediaSettings';
 import { IAddMovieParams, IUpdateMovieData } from '../types/MovieShare';
@@ -58,6 +58,8 @@ export default class Conversation extends EventEmitter {
     private _serverTimeOffset;
     private _delayedHangup;
     private _abortController;
+    private _registeredPeerReceived;
+    private _calleeUnavailableTimer;
     private readonly _onUnload;
     private readonly _audioOutput;
     private readonly _stats;
@@ -80,18 +82,12 @@ export default class Conversation extends EventEmitter {
     get mediaSettings(): MediaSettings | undefined;
     get isCallHeld(): boolean;
     static debugSessionId(): string | null;
+    static debugMessage(type: DebugMessageType, ...args: any[]): boolean;
+    static debugMessageWithContext(type: DebugMessageType, conversationId: string, ...args: any[]): boolean;
     static getSyncedTime(): number;
     get debugSessionId(): string | null;
     onStart({ opponentIds, opponentType, mediaOptions, payload, joiningAllowed, requireAuthToJoin, onlyAdminCanShareMovie, externalIds, onFastStart, conversationId, }: ConversationOnStartParams): Promise<ConversationData>;
-    onJoin(joinArgs: {
-        conversationId?: string;
-        mediaOptions: MediaOption[];
-        chatId?: string;
-        joinLink?: string;
-        observedIds?: ExternalUserId[];
-        payload?: string;
-        onFastJoin?: FastJoinHandler;
-    }): Promise<ConversationData>;
+    onJoin(joinArgs: ConversationOnJoinParams): Promise<ConversationData>;
     private _onJoinPart2;
     private _extractExternalRooms;
     private _extractExternalRoomsData;
@@ -104,7 +100,6 @@ export default class Conversation extends EventEmitter {
     private _acceptConcurrent;
     private _getMainRoomParticipants;
     private _decodeExternalConversationParams;
-    private _logCallStartEvent;
     accept(mediaOptions: MediaOption[]): Promise<ConversationData>;
     decline(): Promise<void>;
     hangup(): Promise<void>;
@@ -120,6 +115,7 @@ export default class Conversation extends EventEmitter {
     private _getConversationParams;
     private _setConversationParams;
     private _buildSignalingEndpoint;
+    private _clearCalleeUnavailableWatchdog;
     /**
      * @throws ErrorEvent
      */
@@ -193,6 +189,9 @@ export default class Conversation extends EventEmitter {
     private _cleanupParticipants;
     private _cleanupParticipantAgnosticStreams;
     private _cleanupTransport;
+    private _finishLifecycle;
+    private _getFirstMediaSentCallback;
+    private _stopFirstMediaSentProbe;
     private _cleanupTransportForHold;
     private _cleanupSpeakerDetector;
     private _cleanupSpecListener;

package/classes/StatsLogger.d.ts

@@ -1,6 +1,14 @@
 import BaseApi from '../abstract/BaseApi';
 import BaseLogger from '../abstract/BaseLogger';
 import StatLog from '../enums/StatLog';
+import TransportTopology from '../enums/TransportTopology';
+type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
+export type LogClientStatsOptions = {
+    immediately?: boolean;
+    occurredAt?: number;
+    conversationId?: string | null;
+    deferUntilServerTime?: boolean;
+};
 /**
  * Класс отвечает за отправку различной информации в сервис статистики (события, статистика и подобное)
  */
@@ -8,19 +16,26 @@ export default class StatsLogger extends BaseLogger {
     private readonly _externalLogger;
     private readonly _api;
     private readonly _conversationIdProvider;
+    private readonly _topologyProvider;
     private readonly _batchInterval;
     private _batchedClientStats;
     private _batchTimeout;
     private _serverTimeDelta;
-    constructor(api: BaseApi, externalLogger: BaseLogger | null, conversationIdProvider: () => string | null);
+    private _waitingForServerTime;
+    private _deferredClientStats;
+    constructor(api: BaseApi, externalLogger: BaseLogger | null, conversationIdProvider: () => string | null, topologyProvider?: () => TransportTopology | undefined);
     log(name: StatLog, value?: string, immediately?: boolean): void;
-    logClientStats(data: Record<string, string | number | boolean | undefined | null>, immediately?: boolean): void;
+    logClientStats(data: ClientStatsPayload, immediatelyOrOptions?: boolean | LogClientStatsOptions): void;
     destroy(): void;
+    private _logClientStats;
     private _getConversationId;
+    private _getCallTopology;
     private _sendBatch;
     private _startTimeout;
     private _stopTimeout;
     private _sendClientStats;
     private _calculateServerTimeDelta;
+    private _flushDeferredClientStats;
     private _now;
 }
+export {};

package/classes/stat/CallLifecycleStats.d.ts

@@ -0,0 +1,47 @@
+import HangupReason from '../HangupReason';
+import StatsLogger from '../StatsLogger';
+export type CallLifecycleSource = 'outgoing' | 'incoming' | 'join' | 'anonym_join';
+export interface CallLifecycleInitializationParams {
+    source: CallLifecycleSource;
+    conversationId?: string;
+}
+export interface CallLifecycleClock {
+    wallNow(): number;
+    monotonicNow(): number;
+}
+export declare class CallLifecycleStats {
+    private readonly _logger;
+    private readonly _clock;
+    private _conversationId;
+    private _callStartLabel;
+    private _lifecycleStartedAtMonotonic;
+    private _warmupStartedAtMonotonic;
+    private _pendingEvents;
+    private _warmupCompleted;
+    private _callStarted;
+    private _accepted;
+    private _firstMediaSent;
+    private _finished;
+    private _destroyed;
+    constructor(logger: StatsLogger, clock?: CallLifecycleClock);
+    get firstMediaSentReported(): boolean;
+    get terminated(): boolean;
+    markInitializationStarted({ source, conversationId }: CallLifecycleInitializationParams): void;
+    bindConversationId(conversationId: string): void;
+    markWarmupStarted(): void;
+    markWarmupCompleted(): void;
+    markCallStarted(): void;
+    markOutgoingAccepted(): void;
+    markIncomingAccepted(concurrent: boolean): void;
+    markFirstMediaSent(): void;
+    markFinished(reason: HangupReason): void;
+    markTerminated(): void;
+    destroy(): void;
+    private _canRecord;
+    private _durationSince;
+    private _finish;
+    private _ensureConversationId;
+    private _record;
+    private _flushPendingEvents;
+    private _logEvent;
+}

package/classes/stat/ConversationStats.d.ts

@@ -1,21 +1,22 @@
 import BaseApi from '../../abstract/BaseApi';
 import BaseLogger from '../../abstract/BaseLogger';
+import TransportTopology from '../../enums/TransportTopology';
 import HangupReason from '../HangupReason';
 import StatsLogger from '../StatsLogger';
-import TransportTopology from '../../enums/TransportTopology';
+import { CallLifecycleStats } from './CallLifecycleStats';
 import { CodecStatsAggregator } from './CodecStatsAggregator';
 import { StatAggregator } from './StatAggregator';
 import { StatPings } from './StatPings';
 import { StatSignalingCommands } from './StatSignalingCommands';
 export declare class ConversationStats {
     readonly logger: StatsLogger;
+    readonly lifecycle: CallLifecycleStats;
     readonly statAggregator: StatAggregator;
     readonly codecStatsAggregator: CodecStatsAggregator;
     readonly pings: StatPings;
     readonly signalingCommands: StatSignalingCommands;
     constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined);
-    logHangup(reason: HangupReason, topology?: TransportTopology): void;
-    flushCallMetrics(topology?: TransportTopology): void;
+    logHangup(reason: HangupReason): void;
+    flushCallMetrics(): void;
     destroy(): void;
-    private static correctHangupReason;
 }

package/classes/stat/FirstMediaSentProbe.d.ts

@@ -0,0 +1,13 @@
+export declare class FirstMediaSentProbe {
+    private readonly _peerConnection;
+    private readonly _onFirstMediaSent;
+    private readonly _pollIntervalMs;
+    private _timer;
+    private _state;
+    constructor(peerConnection: RTCPeerConnection, onFirstMediaSent: () => void, pollIntervalMs?: number);
+    start(): void;
+    destroy(): void;
+    private _getStatsReports;
+    private _poll;
+    private _scheduleNextPoll;
+}

package/classes/stat/StatPings.d.ts

@@ -1,6 +1,5 @@
 import { SignalingTransportType } from '../../enums/SignalingTransportStat';
 import StatsLogger from '../StatsLogger';
-import TransportTopology from '../../enums/TransportTopology';
 export declare class StatPings {
     private readonly _logger;
     private trackerByTransport;
@@ -12,6 +11,6 @@ export declare class StatPings {
      */
     mark(transport: SignalingTransportType): void;
     /** Отправляем данные в стату */
-    logMetrics(topology?: TransportTopology): void;
+    logMetrics(): void;
     destroy(): void;
 }

package/classes/stat/StatSignalingCommands.d.ts

@@ -1,12 +1,11 @@
 import { SignalingTransportType } from '../../enums/SignalingTransportStat';
 import StatsLogger from '../StatsLogger';
-import TransportTopology from '../../enums/TransportTopology';
 export declare class StatSignalingCommands {
     private readonly _logger;
     private trackerByCommand;
     constructor(logger: StatsLogger);
     mark(command: string, time: number, transport: SignalingTransportType): void;
     /** Отправляем данные в стату */
-    logMetrics(topology?: TransportTopology): void;
+    logMetrics(): void;
     destroy(): void;
 }

package/classes/transport/BaseTransport.d.ts

@@ -7,7 +7,13 @@ export default abstract class BaseTransport extends EventEmitter {
     protected readonly _mediaSource: MediaSource;
     protected _state: TransportState;
     protected _pc: RTCPeerConnection | null;
-    protected constructor(signaling: BaseSignaling, mediaSource: MediaSource);
+    private readonly _onFirstMediaSent;
+    private _firstMediaSentProbe;
+    private _firstMediaSentProbeStopped;
+    protected constructor(signaling: BaseSignaling, mediaSource: MediaSource, onFirstMediaSent?: (() => void) | null);
     getState(): TransportState;
+    stopFirstMediaSentProbe(): void;
     abstract close(error?: Error): void;
+    protected _startFirstMediaSentProbe(): void;
+    protected _disposeFirstMediaSentProbe(): void;
 }

package/classes/transport/DirectTransport.d.ts

@@ -43,7 +43,7 @@ export default class DirectTransport extends BaseTransport {
     private readonly _logger;
     private readonly _statAggregator;
     private readonly _codecStatsAggregator;
-    constructor(participantId: ParticipantId, isMaster: boolean, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null);
+    constructor(participantId: ParticipantId, isMaster: boolean, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
     get participantId(): ParticipantId;
     updateStatisticsInterval(): void;
     private _isDeadConnection;

package/classes/transport/ServerTransport.d.ts

@@ -47,7 +47,7 @@ export default class ServerTransport extends BaseTransport {
     private readonly _logger;
     private readonly _statAggregator;
     private readonly _codecStatsAggregator;
-    constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null);
+    constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
     updateStatisticsInterval(): void;
     open(observer?: boolean): void;
     close(error?: Error): void;

package/classes/transport/Transport.d.ts

@@ -48,13 +48,16 @@ export declare class Transport extends EventEmitter {
     private readonly _logger;
     private readonly _statAggregator;
     private readonly _codecStatsAggregator;
-    constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null);
+    private readonly _onFirstMediaSent;
+    private _firstMediaSentProbeStopped;
+    constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
     updateSettings(settings: ServerSettings): void;
     updateStatisticsInterval(): void;
     allocate(participantId: ParticipantId, isMaster?: boolean): void;
     open(participantIds: ParticipantId[], peerId?: string | null, observer?: boolean, force?: boolean): void;
     close(participantId: ParticipantId): void;
     destroy(): void;
+    stopFirstMediaSentProbe(): void;
     holdClose(): void;
     setRemoteHold(hold: boolean): void;
     getTopology(): TransportTopology;
@@ -69,6 +72,8 @@ export declare class Transport extends EventEmitter {
     private _setStates;
     private _setLocalState;
     private _onSignalingNotification;
+    private _handleFirstMediaSent;
+    private _getFirstMediaSentCallback;
     private _onTopologyChanged;
     private _createDirectTransport;
     private _createServerTransport;

package/default/SignalingTransport.d.ts

@@ -1,5 +1,6 @@
 import SignalingConnectionType from '../enums/SignalingConnectionType';
 import { SignalingTransportType } from '../enums/SignalingTransportStat';
+import { DebugLogger } from '../static/Debug';
 export declare enum SignalingTransportFailure {
     EMPTY_ENDPOINT = "EMPTY_ENDPOINT",
     NETWORK_ERROR = "NETWORK_ERROR",
@@ -38,7 +39,8 @@ export default class SignalingTransport {
     private abortSignal;
     private manualClose;
     private currentType;
-    constructor(handlers: SignalingTransportHandlers);
+    private readonly _debug;
+    constructor(debug: DebugLogger | undefined, handlers: SignalingTransportHandlers);
     get readyState(): number | null;
     get type(): SignalingTransportType;
     setEndpoint(endpoint: string): void;

package/enums/HangupType.d.ts

@@ -16,6 +16,7 @@ declare enum HangupType {
     CALLER_IS_BLOCKED = "CALLER_IS_BLOCKED",
     NOT_FRIENDS = "NOT_FRIENDS",
     CALLEE_IS_OFFLINE = "CALLEE_IS_OFFLINE",
+    CALLEE_UNAVAILABLE = "CALLEE_UNAVAILABLE",
     CALLER_IS_REJECTED = "CALLER_IS_REJECTED",
     UNKNOWN_ERROR = "UNKNOWN_ERROR",
     UNSUPPORTED = "UNSUPPORTED",

package/enums/Stat.d.ts

@@ -1,4 +1,10 @@
 declare const enum Stat {
+    CALL_INIT = "call_init",
+    CALL_WARMUP = "call_warmup",
+    CALL_START = "call_start",
+    CALL_ACCEPTED_OUTGOING = "call_accepted_outgoing",
+    CALL_ACCEPTED_INCOMING = "call_accepted_incoming",
+    FIRST_MEDIA_SENT = "first_media_sent",
     CALL_FINISH = "call_finish",// событие отправляемое в конце звонка
     CODEC_USAGE = "codec_usage",// событие когда меняется кодек
     SIGNALING_CONNECTED = "signaling_connected",// measure
@@ -7,7 +13,6 @@ declare const enum Stat {
     FIRST_MEDIA_RECEIVED = "first_media_received",
     CALL_DECLINED_OR_HANGED_LOCALLY = "CallDeclinedOrHangedLocally",
     USER_FEEDBACK_RECEIVED = "UserFeedbackReceived",
-    CALL_START = "call_start",
     SIGNALING_PING_SUMMARY = "signaling_ping_summary",
     SIGNALING_COMMAND_SUMMARY = "signaling_command_summary",
     WEBSOCKET_CONNECTED = "websocket_connected",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.11",
+  "version": "2.8.12-beta.1",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/Debug.d.ts

@@ -21,6 +21,7 @@ export type DebugSessionLogger = DebugLogger & {
     readonly sessionId: string | null;
     readonly conversationId: string | null;
     setConversationId(conversationId: string | null): void;
+    send(type: DebugMessageType, ...args: any[]): void;
 };
 declare namespace Debug {
     type ContextProvider = () => DebugMessageContext;

package/static/Params.d.ts

@@ -100,6 +100,11 @@ export type ParamsObject = {
     waitMessageDelay: number;
     /** @hidden */
     waitAnotherTabDelay: number;
+    /**
+     * Время ожидания регистрации вызываемого абонента после запуска исходящего звонка, ms.
+     * Если параметр не задан или равен 0, ожидание не ограничивается.
+     */
+    calleeUnavailableWaitingTime?: number;
     /** @hidden */
     debugLog: boolean;
     /** @hidden */
@@ -480,13 +485,6 @@ export type ParamsObject = {
      * _По умолчанию: `false`_
      */
     webtransport: boolean;
-    /**
-     * Включить поддержку webtransport для сигналинга в FireFox
-     * Отдельная ручка, так как есть проблемы сейчас с FF
-     *
-     * _По умолчанию: `false`_
-     */
-    webtransportFF: boolean;
     /**
      * Ждать подтверждения от бэкенда для команд startStream/stopStream.
      * При включении: reject без соединения, resolve/reject по ответу бэкенда,
@@ -945,6 +943,7 @@ export default abstract class Params {
     static get waitResponseDelay(): number;
     static get waitMessageDelay(): number;
     static get waitAnotherTabDelay(): number;
+    static get calleeUnavailableWaitingTime(): number | undefined;
     static get debugLog(): boolean;
     static get forceRelayPolicy(): boolean;
     static set forceRelayPolicy(value: boolean);
@@ -1025,7 +1024,6 @@ export default abstract class Params {
     static get enableVideoEffectsFpsDegradation(): boolean;
     static get simulcast(): boolean;
     static get webtransport(): boolean;
-    static get webtransportFF(): boolean;
     static get waitForRecordResponse(): boolean;
     static get transparentAudio(): boolean;
     static get enableSessionStateUpdates(): boolean;
@@ -1062,7 +1060,6 @@ export default abstract class Params {
         switchVideoAtBadNetwork: boolean;
         simulcast: boolean;
         webtransport: boolean;
-        webtransportFF: boolean;
         waitForRecordResponse: boolean;
         transparentAudio: boolean;
         enableSessionStateUpdates: boolean;

package/types/Conversation.d.ts

@@ -7,7 +7,8 @@ import MediaOption from '../enums/MediaOption';
 import UserRole from '../enums/UserRole';
 import { AsrInfo } from './Asr';
 import { IFeaturesPerRole } from './ConversationFeature';
-import { ExternalId, ExternalParticipantId } from './ExternalId';
+import { ExternalId, ExternalParticipantId, ExternalUserId } from './ExternalId';
+import { FastJoinHandler } from './FastJoin';
 import { FastStartHandler } from './FastStart';
 import MediaModifiers from './MediaModifiers';
 import MuteStates from './MuteStates';
@@ -84,6 +85,16 @@ export type ConversationOnStartParams = {
     onFastStart?: FastStartHandler;
     conversationId?: string;
 };
+export type ConversationOnJoinParams = {
+    conversationId?: string;
+    mediaOptions: MediaOption[];
+    chatId?: string;
+    joinLink?: string;
+    observedIds?: ExternalUserId[];
+    payload?: string;
+    onFastJoin?: FastJoinHandler;
+    anonymous?: boolean;
+};
 export type StartConversationParams = {
     opponentIds?: OkUserId[];
     opponentType: CallType;
@@ -94,7 +105,6 @@ export type StartConversationParams = {
     requireAuthToJoin?: boolean;
     onlyAdminCanShareMovie?: boolean;
     externalIds?: ExternalId[];
-    startedTime: number;
     onFastStart?: FastStartHandler;
     conversationId?: string;
 };

package/types/WebTransport.d.ts

@@ -1,4 +1,5 @@
 import { WebTransportOptions } from '@fails-components/webtransport';
+import { DebugLogger } from '../static/Debug';
 declare class WebTransportEventual {
     private webTransport;
     private stream;
@@ -11,12 +12,13 @@ declare class WebTransportEventual {
     private closeEventEmitted;
     private encoder;
     private decoder;
+    private readonly _debug;
     onopen: ((this: WebTransportEventual, ev: Event) => any) | null;
     onmessage: ((this: WebTransportEventual, ev: MessageEvent) => any) | null;
     onerror: ((this: WebTransportEventual, ev: Event) => any) | null;
     onclose: ((this: WebTransportEventual, ev: CloseEvent) => any) | null;
     readyState: number;
-    constructor(url: string, options?: WebTransportOptions);
+    constructor(url: string, options?: WebTransportOptions, debug?: DebugLogger);
     private getCompressionTypeFromUrl;
     private connect;
     private readChunks;