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

package/classes/stat/StatSignalingCommands.d.ts

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

package/classes/stat/StatUnloadJournal.d.ts

@@ -0,0 +1,39 @@
+import { StatQueueEntry } from './StatQueue';
+/**
+ * Синхронный журнал умирающей вкладки.
+ *
+ * Транзакция IndexedDB, начатая в pagehide-обработчике, не успевает
+ * закоммититься при перезагрузке или навигации: браузер сносит документ,
+ * не дав движку базы завершить запись. Из синхронных хранилищ на этот момент
+ * доступен только localStorage, поэтому события финиша складываются сюда,
+ * а при следующем старте SDK переносятся в очередь drainToQueue().
+ *
+ * Ключ уникален на вкладку: две вкладки, умирающие одновременно, не затирают
+ * журналы друг друга.
+ */
+export default abstract class StatUnloadJournal {
+    private static _tabKey;
+    private static _entries;
+    /**
+     * Открывает новый журнал для этой вкладки.
+     *
+     * Вызывается на каждом входе в unload-режим. Вкладка может пережить
+     * pagehide (bfcache, отменённая навигация, сворачивание на мобильном) и
+     * умереть повторно; без сброса второй журнал содержал бы события первого,
+     * уже перенесённые в очередь, и они уехали бы в статистику дважды.
+     */
+    static beginTabSession(): void;
+    static writeSync(entry: StatQueueEntry): boolean;
+    /**
+     * Переносит журналы всех закрытых вкладок в очередь IndexedDB.
+     *
+     * Журнал стирается независимо от исхода переноса: это best-effort страховка,
+     * повторные попытки при неработающем IndexedDB дали бы дубли без шанса на
+     * успех. Статистика никогда не влияет на звонок.
+     *
+     * @returns число перенесённых событий.
+     */
+    static drainToQueue(): Promise<number>;
+    private static _storage;
+    private static _isValidEntry;
+}

package/classes/transport/DirectTransport.d.ts

@@ -3,7 +3,7 @@ import BaseSignaling from '../../abstract/BaseSignaling';
 import { type DebugLogger } from '../../static/Debug';
 import { ParticipantId } from '../../types/Participant';
 import ServerSettings from '../../types/ServerSettings';
-import StatsLogger from '../StatsLogger';
+import StatEventCollector from '../stat/StatEventCollector';
 import { MediaSource } from '../MediaSource';
 import { CodecStatsAggregator } from '../stat/CodecStatsAggregator';
 import { StatAggregator } from '../stat/StatAggregator';
@@ -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, onFirstMediaSent?: (() => void) | null);
+    constructor(participantId: ParticipantId, isMaster: boolean, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
     get participantId(): ParticipantId;
     updateStatisticsInterval(): void;
     private _isDeadConnection;

package/classes/transport/ServerTransport.d.ts

@@ -3,7 +3,7 @@ import BaseSignaling from '../../abstract/BaseSignaling';
 import { type DebugLogger } from '../../static/Debug';
 import { ParticipantId } from '../../types/Participant';
 import ServerSettings from '../../types/ServerSettings';
-import StatsLogger from '../StatsLogger';
+import StatEventCollector from '../stat/StatEventCollector';
 import { MediaSource } from '../MediaSource';
 import { CodecStatsAggregator } from '../stat/CodecStatsAggregator';
 import { StatAggregator } from '../stat/StatAggregator';
@@ -47,7 +47,7 @@ export default class ServerTransport extends BaseTransport {
     private readonly _statAggregator;
     private readonly _codecStatsAggregator;
     private readonly _simulcast;
-    constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
+    constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
     updateStatisticsInterval(): void;
     open(observer?: boolean): void;
     close(error?: Error): void;

package/classes/transport/SimulcastSender.d.ts

@@ -2,7 +2,7 @@ import BaseSignaling from '../../abstract/BaseSignaling';
 import { type DebugLogger } from '../../static/Debug';
 import type VideoSettings from '../../types/VideoSettings';
 import { MediaSource } from '../MediaSource';
-import StatsLogger from '../StatsLogger';
+import StatEventCollector from '../stat/StatEventCollector';
 export default class SimulcastSender {
     private _pc;
     private _transceiver;
@@ -12,7 +12,7 @@ export default class SimulcastSender {
     private readonly _getCameraSettings;
     private readonly _debug;
     private readonly _logger;
-    constructor(signaling: BaseSignaling, mediaSource: MediaSource, getCameraSettings: () => VideoSettings | null, debug?: DebugLogger, logger?: StatsLogger | null);
+    constructor(signaling: BaseSignaling, mediaSource: MediaSource, getCameraSettings: () => VideoSettings | null, debug?: DebugLogger, logger?: StatEventCollector | null);
     configureFromRemoteOffer(pc: RTCPeerConnection): Promise<void>;
     finalizeAnswer(sdp: string): string;
     sync({ force }?: {

package/classes/transport/Transport.d.ts

@@ -6,7 +6,7 @@ import { type DebugLogger } from '../../static/Debug';
 import { ParticipantId } from '../../types/Participant';
 import ServerSettings from '../../types/ServerSettings';
 import EventEmitter from '../EventEmitter';
-import StatsLogger from '../StatsLogger';
+import StatEventCollector from '../stat/StatEventCollector';
 import { MediaSource } from '../MediaSource';
 import { CodecStatsAggregator } from '../stat/CodecStatsAggregator';
 import { StatAggregator } from '../stat/StatAggregator';
@@ -51,7 +51,7 @@ export declare class Transport extends EventEmitter {
     private readonly _onFirstMediaSent;
     private _firstMediaSentProbeStopped;
     private _vadController;
-    constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
+    constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
     updateSettings(settings: ServerSettings): void;
     updateStatisticsInterval(): void;
     allocate(participantId: ParticipantId, isMaster?: boolean): void;

package/default/Api.d.ts

@@ -14,14 +14,36 @@ 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.
+     */
+    private _anonymLogin;
     private _getAnonymLoginCacheKey;
     private _getCachedAnonymLogin;
     private _setCachedAnonymLogin;
     private _removeCachedAnonymLogin;
     private _reauthorize;
     private _applyAnonymLogin;
+    private _buildClientStatsData;
+    /**
+     * Ошибки по отдельным событиям логируются, но не влияют на результат:
+     * батч трактуется целиком, иначе одно всегда отвергаемое событие
+     * залипило бы очередь навсегда.
+     */
+    private _reportClientStatsItemErrors;
+    /**
+     * noSession = true: _prepareQuery не подставит session_key из AuthData,
+     * наш явный ключ останется; application_key добавится как обычно.
+     */
+    private _sendClientStatsWith;
+    /**
+     * Бекенд присылает 200 в любой ситуации, нужно читать тело.
+     * В теле есть ошибки если есть проблемы со статой.
+     */
     private _sendClientStats;
-    logClientStats(items: ClientStats[]): void;
+    logClientStats(items: ClientStats[]): Promise<void>;
+    logClientStatsWith(sessionKey: string, items: ClientStats[]): Promise<void>;
     uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
     joinConversation(conversationId: string, isVideo?: boolean, chatId?: string): Promise<ConversationResponse>;
     createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie, audienceMode, audioOnly, waitForAdmin, closedConversation, }?: {

package/default/Signaling.d.ts

@@ -4,7 +4,7 @@ import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 import { StatAggregator } from '../classes/stat/StatAggregator';
 import { StatPings } from '../classes/stat/StatPings';
 import { StatSignalingCommands } from '../classes/stat/StatSignalingCommands';
-import StatsLogger from '../classes/StatsLogger';
+import StatEventCollector from '../classes/stat/StatEventCollector';
 import ConversationFeature from '../enums/ConversationFeature';
 import ConversationOption from '../enums/ConversationOption';
 import MediaOption from '../enums/MediaOption';
@@ -56,7 +56,7 @@ export default class Signaling extends BaseSignaling {
     private static get WAIT_CONNECTION_DELAY();
     private static get WAIT_RESPONSE_DELAY();
     get ready(): boolean;
-    constructor(debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, statPings?: StatPings | null, statSignalingCommands?: StatSignalingCommands | null);
+    constructor(debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, statPings?: StatPings | null, statSignalingCommands?: StatSignalingCommands | null);
     setAbortSignal(signal: AbortSignal | undefined): void;
     setEndpoint(endpoint: string): void;
     setWebTransportEndpoint(endpoint: string | null): void;

package/enums/SessionError.d.ts

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

package/package.json

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

package/static/ApiTransport.d.ts

@@ -1,5 +1,9 @@
 import { IAPIBaseUrl, IApiEnv } from '../types/Params';
 export declare function resetApiEndpoint(): void;
+/**
+ * Убираем слэш на конце
+ */
+export declare function sanitizeApiBaseUrl(url: IAPIBaseUrl): IAPIBaseUrl;
 export declare function _resolveApiEndpoint(apiBaseUrl?: IAPIBaseUrl, apiEnv?: IApiEnv): Promise<string>;
 export declare function sendBeakon(method: string, params?: {
     [key: string]: any;

package/static/Params.d.ts

@@ -37,6 +37,29 @@ export type ParamsObject = {
     platform: string;
     /** @hidden */
     clientStatsPlatform: string;
+    /**
+     * Автоматически запускать отправку клиентской статистики при `init()`.
+     *
+     * Если `false`, события звонков продолжают копиться в IndexedDB, но в сеть
+     * не уходят, пока хост не вызовет `startStats()`. Так хост может прогреть
+     * приложение, не нагружая сеть. До старта неактивен и fallback прямой
+     * отправки при недоступном хранилище. Если `startStats()` не вызвать
+     * никогда, очередь дорастёт до лимита и начнёт вытеснять старые звонки.
+     *
+     * _По умолчанию: `true`_
+     */
+    autoStartStats: boolean;
+    /**
+     * Персистентная очередь клиентской статистики.
+     *
+     * Включённая — события копятся в IndexedDB и уезжают пачками с
+     * подтверждением, переживая перезагрузку вкладки. Выключенная возвращает
+     * старую схему: накопление в памяти, отправка раз в три секунды без
+     * подтверждения, всё несохранённое теряется вместе с вкладкой.
+     *
+     * _По умолчанию: `false`_
+     */
+    statQueueEnabled: boolean;
     /** @hidden */
     clientType: string;
     /** @hidden */
@@ -935,6 +958,8 @@ export default abstract class Params {
     static set platform(value: string);
     static get clientStatsPlatform(): string;
     static set clientStatsPlatform(value: string);
+    static get autoStartStats(): boolean;
+    static get statQueueEnabled(): boolean;
     static get clientType(): string;
     static set clientType(value: string);
     static get externalUserType(): string;
@@ -1087,6 +1112,8 @@ export default abstract class Params {
         movieShare: boolean;
         clientType: string;
         clientStatsPlatform: string;
+        autoStartStats: boolean;
+        statQueueEnabled: boolean;
         consumerScreenDataChannelPacketSize: number;
         switchVideoAtBadNetwork: boolean;
         simulcast: boolean;

package/static/SessionStore.d.ts

@@ -0,0 +1,38 @@
+export type StoredSession = {
+    sessionKey: string;
+    /** Ключ окружения на момент сохранения, см. currentEndpoint(). */
+    endpoint: string;
+    savedAt: number;
+};
+/**
+ * Снимки сессий по uid на диске. В памяти сессия текущего пользователя —
+ * AuthData; здесь — то, что SDK видел раньше.
+ *
+ * Это снимок: он может быть протухшим, переавторизовать его извне нельзя.
+ * Годится только для отложенных best-effort задач (например, досылка
+ * статистики). Живые запросы звонка им подписывать нельзя.
+ *
+ * Хранится только session_key: секрет сессии транспорту не нужен, а токен
+ * хоста незачем — протухший снимок не переавторизуется, а выбрасывается.
+ */
+export default abstract class SessionStore {
+    static remember(uid: number, session: {
+        sessionKey: string;
+        endpoint: string;
+    }): 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;
+    private static _write;
+    private static _isValid;
+}

package/static/WebRTCUtils.d.ts

@@ -2,7 +2,7 @@
  * Вспомогательный плагин для работы с WebRTC
  */
 import { IVideoDimentions } from '../types/MediaSettings';
-import type StatsLogger from '../classes/StatsLogger';
+import type StatEventCollector from '../classes/stat/StatEventCollector';
 import { type DebugLogger } from './Debug';
 /**
  * Тип камеры мобильного устройства
@@ -85,24 +85,24 @@ declare namespace WebRTCUtils {
      * @param needAudio Нужно ли аудио
      * @param needEmptyTracks Добавлять ли в стрим пустые треки для отключенного видео/аудио
      */
-    function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Запрашивает трансляцию экрана пользователя с опциональным захватом звука
      */
-    function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Запрашивает камеру пользователя
      *
      * @param deviceId ID устройства
      * @param resolution Размеры видео
      */
-    function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Запрашивает микрофон пользователя
      *
      * @param deviceId ID устройства
      */
-    function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Устанавливает размер видео в стриме
      *