@vkontakte/calls-sdk 2.8.13-dev.3b07b09d.0 → 2.8.13-dev.45510c4e.0

package/default/Api.d.ts

@@ -14,10 +14,7 @@ export default class Api extends BaseApi {
     protected _call(method: string, data?: any, noSession?: boolean, allowReauthorize?: boolean): Promise<any>;
     userId(participantId: ParticipantId): ExternalParticipantId | null;
     authorize(): Promise<void>;
-    /**
-     * Запрос auth.anonymLogin без побочных эффектов: ничего не пишет в
-     * AuthData и кэш. Пустой токен — анонимный логин версии 2.
-     */
+    /** Запрос auth.anonymLogin без побочных эффектов. Пустой токен — версия 2. */
     private _anonymLogin;
     private _getAnonymLoginCacheKey;
     private _getCachedAnonymLogin;
@@ -26,21 +23,11 @@ export default class Api extends BaseApi {
     private _reauthorize;
     private _applyAnonymLogin;
     private _buildClientStatsData;
-    /**
-     * Ошибки по отдельным событиям логируются, но не влияют на результат:
-     * батч трактуется целиком, иначе одно всегда отвергаемое событие
-     * залипило бы очередь навсегда.
-     */
+    /** Ошибки по отдельным событиям логируются, но батч трактуется целиком. */
     private _reportClientStatsItemErrors;
-    /**
-     * noSession = true: _prepareQuery не подставит session_key из AuthData,
-     * наш явный ключ останется; application_key добавится как обычно.
-     */
+    /** noSession = true, иначе _prepareQuery перебил бы явный session_key. */
     private _sendClientStatsWith;
-    /**
-     * Бекенд присылает 200 в любой ситуации, нужно читать тело.
-     * В теле есть ошибки если есть проблемы со статой.
-     */
+    /** Бекенд отвечает 200 всегда: ошибки статистики лежат в теле. */
     private _sendClientStats;
     logClientStats(items: ClientStats[]): Promise<void>;
     logClientStatsWith(sessionKey: string, items: ClientStats[]): Promise<void>;

package/default/Signaling.d.ts

@@ -42,6 +42,8 @@ export default class Signaling extends BaseSignaling {
     private connected;
     private listenersReady;
     private peerId;
+    /** Когда началась череда падений соединения, от неё считаем *_timeout */
+    private reconnectStartedAt;
     private connectionMessageWaitTimer;
     private participantIdRegistry;
     private producerNotificationDataChannel;
@@ -164,7 +166,8 @@ export default class Signaling extends BaseSignaling {
     private _handleCachedMessages;
     private _throwError;
     private _onError;
-    private _serializeErrorEvent;
+    /** Причина ошибки для статы: короткий читаемый текст */
+    private _describeErrorEvent;
     private _onClose;
     private _terminate;
     private _fail;
@@ -182,10 +185,15 @@ export default class Signaling extends BaseSignaling {
     private _onTransportConnecting;
     private _onTransportFailed;
     private _onTransportReconnectScheduled;
+    /** Попыток восстановить соединение больше не будет: отправляем, сколько длилась череда падений */
+    private _logReconnectTimeout;
     private _onTransportConnectionDead;
     private _attachNotificationCallError;
     private _createSignalingCallError;
     private _getSocketType;
     private _markTransportStat;
+    /** Событие уходит с переданными полями, без value — уходит без value */
     private _logTransportStat;
+    /** value — время от метки, поставленной в _markTransportStat; метки нет — событие не отправляем */
+    private _logTransportStatSinceMark;
 }

package/enums/SessionError.d.ts

@@ -1,15 +1,10 @@
-/**
- * Коды ошибок сессии API
- */
+/** Коды ошибок сессии API. */
 declare enum SessionError {
     PARAM_SESSION_EXPIRED = 102,
     PARAM_SESSION_KEY = 103,
     PARAM_SIGNATURE = 104,
     AUTH_LOGIN = 401
 }
-/**
- * Ошибки, после которых имеет смысл переавторизоваться: сессия протухла или
- * подпись не сошлась. 401 сюда не входит — там протух токен хоста.
- */
+/** Ошибки, после которых имеет смысл переавторизоваться. 401 — токен хоста. */
 export declare function isSessionErrorCode(code: unknown): boolean;
 export default SessionError;

package/enums/Stat.d.ts

@@ -1,4 +1,7 @@
-declare const enum Stat {
+/**
+ * Имена событий статистики — поле `name` в данных `onClientStats`
+ */
+declare enum Stat {
     CALL_INIT = "call_init",
     CALL_START = "call_start",
     CALL_ACCEPTED_OUTGOING = "call_accepted_outgoing",
@@ -14,6 +17,26 @@ declare const enum Stat {
     USER_FEEDBACK_RECEIVED = "UserFeedbackReceived",
     SIGNALING_PING_SUMMARY = "signaling_ping_summary",
     SIGNALING_COMMAND_SUMMARY = "signaling_command_summary",
+    API_CALL = "api_call",
+    CONNECTION_STATE_CHANGED = "connection_state_changed",
+    SIGNALING_STATE_CHANGED = "signaling_state_changed",
+    GATHERING_STATE_CHANGED = "gathering_state_changed",
+    ICE_RESTART = "ice_restart",
+    ICE_CANDIDATES_CHANGED = "ice_candidates_changed",
+    ICE_CANDIDATE_GATHERING_FAILED = "ice_candidate_gathering_failed",
+    ICE_CANDIDATE_ADD_FAILED = "ice_candidate_add_failed",
+    SDP_CREATE_OFFER = "sdp_create_offer",
+    SDP_CREATE_ANSWER = "sdp_create_answer",
+    SDP_SET_LOCAL_OFFER = "sdp_set_local_offer",
+    SDP_SET_LOCAL_PRANSWER = "sdp_set_local_pranswer",
+    SDP_SET_LOCAL_ANSWER = "sdp_set_local_answer",
+    SDP_SET_LOCAL_ROLLBACK = "sdp_set_local_rollback",
+    SDP_SET_REMOTE_OFFER = "sdp_set_remote_offer",
+    SDP_SET_REMOTE_PRANSWER = "sdp_set_remote_pranswer",
+    SDP_SET_REMOTE_ANSWER = "sdp_set_remote_answer",
+    SDP_SET_REMOTE_ROLLBACK = "sdp_set_remote_rollback",
+    SDP_GENERATED = "sdp_generated",
+    SDP_RECEIVED = "sdp_received",
     WEBSOCKET_CONNECTED = "websocket_connected",
     WEBSOCKET_RECONNECTED = "websocket_reconnected",
     WEBSOCKET_FAILED_PINGS = "websocket_failed_pings",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.13-dev.3b07b09d.0",
+  "version": "2.8.13-dev.45510c4e.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/External.d.ts

@@ -1,4 +1,5 @@
 import { IAsrData } from '../types/Asr';
+import { ClientStatsEvent } from '../types/ClientStatsEvent';
 import { ConversationData } from '../types/Conversation';
 import HangupReason from '../classes/HangupReason';
 import { MediaTrackKind } from '../classes/MediaSource';
@@ -513,6 +514,12 @@ declare namespace External {
      * @param memory Статистика памяти
      */
     function onStatistics(connection: StatResult, memory: Record<string, number>): void;
+    /**
+     * Событие статистики SDK
+     *
+     * @param data Данные события с `vcid` и `ts`
+     */
+    function onClientStats(data: ClientStatsEvent): void;
     /**
      * Ошибка воспроизведения звука
      */

package/static/Params.d.ts

@@ -2,6 +2,7 @@ import type { VideoEffects } from '@vkontakte/calls-video-effects';
 import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
 import { IAsrData } from '../types/Asr';
+import { ClientStatsEvent } from '../types/ClientStatsEvent';
 import { ConversationData } from '../types/Conversation';
 import HangupReason from '../classes/HangupReason';
 import { MediaTrackKind } from '../classes/MediaSource';
@@ -37,25 +38,23 @@ export type ParamsObject = {
     platform: string;
     /** @hidden */
     clientStatsPlatform: string;
+    /**
+     * Версия приложения-хоста, уходит в статистику и сигналинг, например `'26.31.0:6822'`.
+     * По умолчанию `'0.0.0'`
+     */
+    appVersion: string;
     /**
      * Автоматически запускать отправку клиентской статистики при `init()`.
      *
-     * Если `false`, события звонков продолжают копиться в IndexedDB, но в сеть
-     * не уходят, пока хост не вызовет `startStats()`. Так хост может прогреть
-     * приложение, не нагружая сеть. До старта неактивен и fallback прямой
-     * отправки при недоступном хранилище. Если `startStats()` не вызвать
-     * никогда, очередь дорастёт до лимита и начнёт вытеснять старые звонки.
+     * При `false` события копятся в очереди, но не уходят в сеть, пока хост не
+     * вызовет `startStats()`.
      *
      * _По умолчанию: `true`_
      */
     autoStartStats: boolean;
     /**
-     * Персистентная очередь клиентской статистики.
-     *
-     * Включённая — события копятся в IndexedDB и уезжают пачками с
-     * подтверждением, переживая перезагрузку вкладки. Выключенная возвращает
-     * старую схему: накопление в памяти, отправка раз в три секунды без
-     * подтверждения, всё несохранённое теряется вместе с вкладкой.
+     * Персистентная очередь клиентской статистики: события копятся в IndexedDB
+     * и уезжают пачками с подтверждением, переживая перезагрузку вкладки.
      *
      * _По умолчанию: `false`_
      */
@@ -253,6 +252,13 @@ export type ParamsObject = {
     iceRestartWaitTime: number;
     /** @hidden */
     transportConnectionWaitTime: number;
+    /**
+     * Разрешить запрашивать переход на серверную топологию не только звонящему,
+     * но и принимающей стороне, если не удалось восстановить оборвавшееся p2p-соединение
+     *
+     * _По умолчанию: `false`_
+     */
+    switchTopologyOnReconnectFromAnySide: boolean;
     /**
      * Частота получения статистики в миллисекундах
      *
@@ -292,6 +298,13 @@ export type ParamsObject = {
     perfStatReportEnabled: boolean;
     /** @hidden */
     callStatReportEnabled: boolean;
+    /**
+     * Отправлять событие статистики ice_candidate_gathering_failed
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    iceCandidateErrorStatEnabled: boolean;
     /**
      * Отдавать приоритет кодеку H264 для исходящего видео
      *
@@ -799,6 +812,12 @@ export type ParamsObject = {
      * Статистика звонка
      */
     onStatistics?: (stats: {}) => void;
+    /**
+     * Событие статистики SDK: те же данные, что уходят в статистику звонков, плюс `vcid` и `ts`
+     *
+     * @param data Данные события
+     */
+    onClientStats?: (data: ClientStatsEvent) => void;
     /**
      * Ошибка воспроизведения звука
      */
@@ -950,7 +969,13 @@ export default abstract class Params {
     static getScreenFrameRate(fastScreenShare: boolean): number;
     static get<N extends keyof ParamsObject>(name: N): ParamsObject[N];
     static get appName(): string;
-    static get appVersion(): number;
+    static get appVersion(): string;
+    /**
+     * Версия клиента для `client_version` в `auth.anonymLogin`. Бэкенд валидирует формат,
+     * поэтому это фиксированное значение, а не версия приложения-хоста (см. {@link Params.appVersion}).
+     * @hidden
+     */
+    static get apiClientVersion(): number;
     static get sdkVersion(): string;
     static get debug(): boolean;
     static get protocolVersion(): 5 | 6;
@@ -1032,11 +1057,13 @@ export default abstract class Params {
     };
     static get iceRestartWaitTime(): number;
     static get transportConnectionWaitTime(): number;
+    static get switchTopologyOnReconnectFromAnySide(): boolean;
     static get statisticsInterval(): number;
     static set statisticsInterval(value: number);
     static get networkStatisticsInterval(): number;
     static get perfStatReportEnabled(): boolean;
     static get callStatReportEnabled(): boolean;
+    static get iceCandidateErrorStatEnabled(): boolean;
     static get enableLogPerfStatReport(): boolean;
     static get asrDataChannel(): boolean;
     static get consumerScreenDataChannelPacketSize(): number;
@@ -1108,10 +1135,12 @@ export default abstract class Params {
         videoSuspend: boolean;
         debugLog: boolean;
         callStatReportEnabled: boolean;
+        iceCandidateErrorStatEnabled: boolean;
         joinFromMultipleDevices: boolean;
         movieShare: boolean;
         clientType: string;
         clientStatsPlatform: string;
+        appVersion: string;
         autoStartStats: boolean;
         statQueueEnabled: boolean;
         consumerScreenDataChannelPacketSize: number;

package/static/SessionStore.d.ts

@@ -5,15 +5,9 @@ export type StoredSession = {
     savedAt: number;
 };
 /**
- * Снимки сессий по uid на диске. В памяти сессия текущего пользователя —
- * AuthData; здесь — то, что SDK видел раньше.
- *
- * Это снимок: он может быть протухшим, переавторизовать его извне нельзя.
- * Годится только для отложенных best-effort задач (например, досылка
- * статистики). Живые запросы звонка им подписывать нельзя.
- *
- * Хранится только session_key: секрет сессии транспорту не нужен, а токен
- * хоста незачем — протухший снимок не переавторизуется, а выбрасывается.
+ * Снимки сессий по uid на диске. Снимок может быть протухшим и переавторизации
+ * не подлежит, поэтому годится только для отложенных best-effort задач вроде
+ * досылки статистики.
  */
 export default abstract class SessionStore {
     static remember(uid: number, session: {
@@ -22,14 +16,11 @@ export default abstract class SessionStore {
     }): void;
     static get(uid: number): StoredSession | null;
     static forget(uid: number): void;
-    /** Удаляет записи старше MAX_AGE_MS. */
+    /** Снимок живёт столько же, сколько события, которые он мог бы дослать. */
     static prune(now?: number): void;
     /**
      * Ключ окружения: сессия прода не должна улететь на тестовый кластер.
-     * Синхронный, в отличие от резолва endpoint в транспорте.
-     *
-     * Адрес нормализуется так же, как в транспорте: иначе снимок, сделанный
-     * при apiBaseUrl со слэшем на конце, не совпал бы сам с собой.
+     * Адрес нормализуется так же, как в транспорте.
      */
     static currentEndpoint(): string;
     private static _read;

package/static/SimulcastInfo.d.ts

@@ -4,6 +4,7 @@ export declare const SIMULCAST_DEFAULT: {
     HEIGHT: number;
     WIDTH: number;
     BITRATE: number;
+    FPS: number;
 };
 export declare const SIMULCAST_SCALABILITY_MODE = "L1T2";
 export declare function isEqualSimulcastInfo(si1: ISimulcastInfo | null, si2: ISimulcastInfo | null): boolean;

package/types/ClientStatsEvent.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Событие статистики SDK, которое получает `onClientStats`
+ */
+export type ClientStatsEvent = Record<string, string | number | boolean | null> & {
+    /** Имя события из `Stat`. У периодической статистики звонка его нет */
+    name?: string;
+    /** ID звонка, `null` — пока он неизвестен */
+    vcid: string | null;
+    /** Время события, мс */
+    ts: number;
+};

package/types/IEventualStatLog.d.ts

@@ -1,6 +1,6 @@
 import Stat from '../enums/Stat';
 export interface IEventualStatLog {
     name: Stat;
-    value?: number | null;
+    value?: number;
     [k: string]: number | string | undefined | null;
 }

package/types/Params.d.ts

@@ -1,2 +1,2 @@
-export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | string;
+export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | 'CALLS_CHELSEA' | 'CALLS_KERZH' | string;
 export type IAPIBaseUrl = string | null;