@vkontakte/calls-sdk 2.8.13-dev.8897f036.0 → 2.8.13-dev.a25e6d68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/CallsSDK.d.ts +5 -0
  2. package/abstract/BaseApi.d.ts +8 -8
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +2681 -2008
  5. package/classes/AudioFix.d.ts +2 -2
  6. package/classes/AudioOutput.d.ts +3 -3
  7. package/classes/MediaSource.d.ts +6 -2
  8. package/classes/SpecListener.d.ts +2 -2
  9. package/classes/VolumesDetector.d.ts +0 -1
  10. package/classes/codec/LibVPxDecoder.d.ts +2 -2
  11. package/classes/codec/LibVPxEncoder.d.ts +2 -2
  12. package/classes/codec/WebCodecsDecoder.d.ts +2 -2
  13. package/classes/codec/WebCodecsEncoder.d.ts +2 -2
  14. package/classes/codec/WorkerBase.d.ts +3 -3
  15. package/classes/conversation/Conversation.d.ts +1 -0
  16. package/classes/screenshare/ScreenCaptureReceiver.d.ts +2 -2
  17. package/classes/screenshare/ScreenCaptureSender.d.ts +2 -2
  18. package/classes/screenshare/StreamBuilder.d.ts +2 -2
  19. package/classes/stat/CallLifecycleStats.d.ts +2 -2
  20. package/classes/stat/CodecStatsAggregator.d.ts +2 -2
  21. package/classes/stat/ConversationStats.d.ts +11 -2
  22. package/classes/stat/StatAggregator.d.ts +2 -2
  23. package/classes/stat/StatClock.d.ts +28 -0
  24. package/classes/stat/StatDrainScheduler.d.ts +92 -0
  25. package/classes/stat/StatEventCollector.d.ts +50 -0
  26. package/classes/stat/StatPings.d.ts +2 -2
  27. package/classes/stat/StatQueue.d.ts +79 -0
  28. package/classes/stat/StatSignalingCommands.d.ts +2 -2
  29. package/classes/stat/StatUnloadJournal.d.ts +27 -0
  30. package/classes/transport/DirectTransport.d.ts +6 -8
  31. package/classes/transport/ServerTransport.d.ts +2 -2
  32. package/classes/transport/SimulcastSender.d.ts +2 -2
  33. package/classes/transport/Transport.d.ts +2 -2
  34. package/default/Api.d.ts +10 -1
  35. package/default/Signaling.d.ts +2 -2
  36. package/enums/SessionError.d.ts +10 -0
  37. package/package.json +1 -1
  38. package/static/ApiTransport.d.ts +4 -0
  39. package/static/Params.d.ts +41 -1
  40. package/static/SessionStore.d.ts +29 -0
  41. package/static/WebRTCUtils.d.ts +5 -5
@@ -3,17 +3,11 @@ import BaseSignaling from '../../abstract/BaseSignaling';
3
3
  import { type DebugLogger } from '../../static/Debug';
4
4
  import { ParticipantId } from '../../types/Participant';
5
5
  import ServerSettings from '../../types/ServerSettings';
6
- import StatsLogger from '../StatsLogger';
6
+ import StatEventCollector from '../stat/StatEventCollector';
7
7
  import { MediaSource } from '../MediaSource';
8
8
  import { CodecStatsAggregator } from '../stat/CodecStatsAggregator';
9
9
  import { StatAggregator } from '../stat/StatAggregator';
10
10
  import BaseTransport from './BaseTransport';
11
- /**
12
- * Соединение с собеседником было установлено, но после обрыва не восстановилось за отведённое время
13
- */
14
- export declare class IceRestartTimeoutError extends Error {
15
- constructor();
16
- }
17
11
  export default class DirectTransport extends BaseTransport {
18
12
  private readonly _participantId;
19
13
  private readonly _isMaster;
@@ -49,7 +43,7 @@ export default class DirectTransport extends BaseTransport {
49
43
  private readonly _logger;
50
44
  private readonly _statAggregator;
51
45
  private readonly _codecStatsAggregator;
52
- 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);
46
+ 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);
53
47
  get participantId(): ParticipantId;
54
48
  updateStatisticsInterval(): void;
55
49
  private _isDeadConnection;
@@ -78,6 +72,10 @@ export default class DirectTransport extends BaseTransport {
78
72
  private _markConnected;
79
73
  private _onConnectionStateChange;
80
74
  private _startReconnection;
75
+ /**
76
+ * Запрашивает у сигналинга переход на серверную топологию.
77
+ * Обычно это делает только мастер, `fromAnySide` снимает это ограничение.
78
+ */
81
79
  private _requestTopologySwitch;
82
80
  private _stopReconnection;
83
81
  private _startIceRestart;
@@ -3,7 +3,7 @@ import BaseSignaling from '../../abstract/BaseSignaling';
3
3
  import { type DebugLogger } from '../../static/Debug';
4
4
  import { ParticipantId } from '../../types/Participant';
5
5
  import ServerSettings from '../../types/ServerSettings';
6
- import StatsLogger from '../StatsLogger';
6
+ import StatEventCollector from '../stat/StatEventCollector';
7
7
  import { MediaSource } from '../MediaSource';
8
8
  import { CodecStatsAggregator } from '../stat/CodecStatsAggregator';
9
9
  import { StatAggregator } from '../stat/StatAggregator';
@@ -47,7 +47,7 @@ export default class ServerTransport extends BaseTransport {
47
47
  private readonly _statAggregator;
48
48
  private readonly _codecStatsAggregator;
49
49
  private readonly _simulcast;
50
- constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
50
+ constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
51
51
  updateStatisticsInterval(): void;
52
52
  open(observer?: boolean): void;
53
53
  close(error?: Error): void;
@@ -2,7 +2,7 @@ import BaseSignaling from '../../abstract/BaseSignaling';
2
2
  import { type DebugLogger } from '../../static/Debug';
3
3
  import type VideoSettings from '../../types/VideoSettings';
4
4
  import { MediaSource } from '../MediaSource';
5
- import StatsLogger from '../StatsLogger';
5
+ import StatEventCollector from '../stat/StatEventCollector';
6
6
  export default class SimulcastSender {
7
7
  private _pc;
8
8
  private _transceiver;
@@ -12,7 +12,7 @@ export default class SimulcastSender {
12
12
  private readonly _getCameraSettings;
13
13
  private readonly _debug;
14
14
  private readonly _logger;
15
- constructor(signaling: BaseSignaling, mediaSource: MediaSource, getCameraSettings: () => VideoSettings | null, debug?: DebugLogger, logger?: StatsLogger | null);
15
+ constructor(signaling: BaseSignaling, mediaSource: MediaSource, getCameraSettings: () => VideoSettings | null, debug?: DebugLogger, logger?: StatEventCollector | null);
16
16
  configureFromRemoteOffer(pc: RTCPeerConnection): Promise<void>;
17
17
  finalizeAnswer(sdp: string): string;
18
18
  sync({ force }?: {
@@ -6,7 +6,7 @@ import { type DebugLogger } from '../../static/Debug';
6
6
  import { ParticipantId } from '../../types/Participant';
7
7
  import ServerSettings from '../../types/ServerSettings';
8
8
  import EventEmitter from '../EventEmitter';
9
- import StatsLogger from '../StatsLogger';
9
+ import StatEventCollector from '../stat/StatEventCollector';
10
10
  import { MediaSource } from '../MediaSource';
11
11
  import { CodecStatsAggregator } from '../stat/CodecStatsAggregator';
12
12
  import { StatAggregator } from '../stat/StatAggregator';
@@ -51,7 +51,7 @@ export declare class Transport extends EventEmitter {
51
51
  private readonly _onFirstMediaSent;
52
52
  private _firstMediaSentProbeStopped;
53
53
  private _vadController;
54
- constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
54
+ constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
55
55
  updateSettings(settings: ServerSettings): void;
56
56
  updateStatisticsInterval(): void;
57
57
  allocate(participantId: ParticipantId, isMaster?: boolean): void;
package/default/Api.d.ts CHANGED
@@ -14,14 +14,23 @@ export default class Api extends BaseApi {
14
14
  protected _call(method: string, data?: any, noSession?: boolean, allowReauthorize?: boolean): Promise<any>;
15
15
  userId(participantId: ParticipantId): ExternalParticipantId | null;
16
16
  authorize(): Promise<void>;
17
+ /** Запрос auth.anonymLogin без побочных эффектов. Пустой токен — версия 2. */
18
+ private _anonymLogin;
17
19
  private _getAnonymLoginCacheKey;
18
20
  private _getCachedAnonymLogin;
19
21
  private _setCachedAnonymLogin;
20
22
  private _removeCachedAnonymLogin;
21
23
  private _reauthorize;
22
24
  private _applyAnonymLogin;
25
+ private _buildClientStatsData;
26
+ /** Ошибки по отдельным событиям логируются, но батч трактуется целиком. */
27
+ private _reportClientStatsItemErrors;
28
+ /** noSession = true, иначе _prepareQuery перебил бы явный session_key. */
29
+ private _sendClientStatsWith;
30
+ /** Бекенд отвечает 200 всегда: ошибки статистики лежат в теле. */
23
31
  private _sendClientStats;
24
- logClientStats(items: ClientStats[]): void;
32
+ logClientStats(items: ClientStats[]): Promise<void>;
33
+ logClientStatsWith(sessionKey: string, items: ClientStats[]): Promise<void>;
25
34
  uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
26
35
  joinConversation(conversationId: string, isVideo?: boolean, chatId?: string): Promise<ConversationResponse>;
27
36
  createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie, audienceMode, audioOnly, waitForAdmin, closedConversation, }?: {
@@ -4,7 +4,7 @@ import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
4
4
  import { StatAggregator } from '../classes/stat/StatAggregator';
5
5
  import { StatPings } from '../classes/stat/StatPings';
6
6
  import { StatSignalingCommands } from '../classes/stat/StatSignalingCommands';
7
- import StatsLogger from '../classes/StatsLogger';
7
+ import StatEventCollector from '../classes/stat/StatEventCollector';
8
8
  import ConversationFeature from '../enums/ConversationFeature';
9
9
  import ConversationOption from '../enums/ConversationOption';
10
10
  import MediaOption from '../enums/MediaOption';
@@ -56,7 +56,7 @@ export default class Signaling extends BaseSignaling {
56
56
  private static get WAIT_CONNECTION_DELAY();
57
57
  private static get WAIT_RESPONSE_DELAY();
58
58
  get ready(): boolean;
59
- constructor(debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, statPings?: StatPings | null, statSignalingCommands?: StatSignalingCommands | null);
59
+ constructor(debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, statPings?: StatPings | null, statSignalingCommands?: StatSignalingCommands | null);
60
60
  setAbortSignal(signal: AbortSignal | undefined): void;
61
61
  setEndpoint(endpoint: string): void;
62
62
  setWebTransportEndpoint(endpoint: string | null): void;
@@ -0,0 +1,10 @@
1
+ /** Коды ошибок сессии API. */
2
+ declare enum SessionError {
3
+ PARAM_SESSION_EXPIRED = 102,
4
+ PARAM_SESSION_KEY = 103,
5
+ PARAM_SIGNATURE = 104,
6
+ AUTH_LOGIN = 401
7
+ }
8
+ /** Ошибки, после которых имеет смысл переавторизоваться. 401 — токен хоста. */
9
+ export declare function isSessionErrorCode(code: unknown): boolean;
10
+ export default SessionError;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vkontakte/calls-sdk",
3
- "version": "2.8.13-dev.8897f036.0",
3
+ "version": "2.8.13-dev.a25e6d68.0",
4
4
  "author": "vk.com",
5
5
  "description": "Library for video calls based on the vk.com platform",
6
6
  "homepage": "https://vk.com",
@@ -1,5 +1,9 @@
1
1
  import { IAPIBaseUrl, IApiEnv } from '../types/Params';
2
2
  export declare function resetApiEndpoint(): void;
3
+ /**
4
+ * Убираем слэш на конце
5
+ */
6
+ export declare function sanitizeApiBaseUrl(url: IAPIBaseUrl): IAPIBaseUrl;
3
7
  export declare function _resolveApiEndpoint(apiBaseUrl?: IAPIBaseUrl, apiEnv?: IApiEnv): Promise<string>;
4
8
  export declare function sendBeakon(method: string, params?: {
5
9
  [key: string]: any;
@@ -37,6 +37,27 @@ export type ParamsObject = {
37
37
  platform: string;
38
38
  /** @hidden */
39
39
  clientStatsPlatform: string;
40
+ /**
41
+ * Версия приложения-хоста, уходит в статистику и сигналинг, например `'26.31.0:6822'`.
42
+ * По умолчанию `'0.0.0'`
43
+ */
44
+ appVersion: string;
45
+ /**
46
+ * Автоматически запускать отправку клиентской статистики при `init()`.
47
+ *
48
+ * При `false` события копятся в очереди, но не уходят в сеть, пока хост не
49
+ * вызовет `startStats()`.
50
+ *
51
+ * _По умолчанию: `true`_
52
+ */
53
+ autoStartStats: boolean;
54
+ /**
55
+ * Персистентная очередь клиентской статистики: события копятся в IndexedDB
56
+ * и уезжают пачками с подтверждением, переживая перезагрузку вкладки.
57
+ *
58
+ * _По умолчанию: `false`_
59
+ */
60
+ statQueueEnabled: boolean;
40
61
  /** @hidden */
41
62
  clientType: string;
42
63
  /** @hidden */
@@ -230,6 +251,13 @@ export type ParamsObject = {
230
251
  iceRestartWaitTime: number;
231
252
  /** @hidden */
232
253
  transportConnectionWaitTime: number;
254
+ /**
255
+ * Разрешить запрашивать переход на серверную топологию не только звонящему,
256
+ * но и принимающей стороне, если не удалось восстановить оборвавшееся p2p-соединение
257
+ *
258
+ * _По умолчанию: `false`_
259
+ */
260
+ switchTopologyOnReconnectFromAnySide: boolean;
233
261
  /**
234
262
  * Частота получения статистики в миллисекундах
235
263
  *
@@ -927,7 +955,13 @@ export default abstract class Params {
927
955
  static getScreenFrameRate(fastScreenShare: boolean): number;
928
956
  static get<N extends keyof ParamsObject>(name: N): ParamsObject[N];
929
957
  static get appName(): string;
930
- static get appVersion(): number;
958
+ static get appVersion(): string;
959
+ /**
960
+ * Версия клиента для `client_version` в `auth.anonymLogin`. Бэкенд валидирует формат,
961
+ * поэтому это фиксированное значение, а не версия приложения-хоста (см. {@link Params.appVersion}).
962
+ * @hidden
963
+ */
964
+ static get apiClientVersion(): number;
931
965
  static get sdkVersion(): string;
932
966
  static get debug(): boolean;
933
967
  static get protocolVersion(): 5 | 6;
@@ -935,6 +969,8 @@ export default abstract class Params {
935
969
  static set platform(value: string);
936
970
  static get clientStatsPlatform(): string;
937
971
  static set clientStatsPlatform(value: string);
972
+ static get autoStartStats(): boolean;
973
+ static get statQueueEnabled(): boolean;
938
974
  static get clientType(): string;
939
975
  static set clientType(value: string);
940
976
  static get externalUserType(): string;
@@ -1007,6 +1043,7 @@ export default abstract class Params {
1007
1043
  };
1008
1044
  static get iceRestartWaitTime(): number;
1009
1045
  static get transportConnectionWaitTime(): number;
1046
+ static get switchTopologyOnReconnectFromAnySide(): boolean;
1010
1047
  static get statisticsInterval(): number;
1011
1048
  static set statisticsInterval(value: number);
1012
1049
  static get networkStatisticsInterval(): number;
@@ -1087,6 +1124,9 @@ export default abstract class Params {
1087
1124
  movieShare: boolean;
1088
1125
  clientType: string;
1089
1126
  clientStatsPlatform: string;
1127
+ appVersion: string;
1128
+ autoStartStats: boolean;
1129
+ statQueueEnabled: boolean;
1090
1130
  consumerScreenDataChannelPacketSize: number;
1091
1131
  switchVideoAtBadNetwork: boolean;
1092
1132
  simulcast: boolean;
@@ -0,0 +1,29 @@
1
+ export type StoredSession = {
2
+ sessionKey: string;
3
+ /** Ключ окружения на момент сохранения, см. currentEndpoint(). */
4
+ endpoint: string;
5
+ savedAt: number;
6
+ };
7
+ /**
8
+ * Снимки сессий по uid на диске. Снимок может быть протухшим и переавторизации
9
+ * не подлежит, поэтому годится только для отложенных best-effort задач вроде
10
+ * досылки статистики.
11
+ */
12
+ export default abstract class SessionStore {
13
+ static remember(uid: number, session: {
14
+ sessionKey: string;
15
+ endpoint: string;
16
+ }): void;
17
+ static get(uid: number): StoredSession | null;
18
+ static forget(uid: number): void;
19
+ /** Снимок живёт столько же, сколько события, которые он мог бы дослать. */
20
+ static prune(now?: number): void;
21
+ /**
22
+ * Ключ окружения: сессия прода не должна улететь на тестовый кластер.
23
+ * Адрес нормализуется так же, как в транспорте.
24
+ */
25
+ static currentEndpoint(): string;
26
+ private static _read;
27
+ private static _write;
28
+ private static _isValid;
29
+ }
@@ -2,7 +2,7 @@
2
2
  * Вспомогательный плагин для работы с WebRTC
3
3
  */
4
4
  import { IVideoDimentions } from '../types/MediaSettings';
5
- import type StatsLogger from '../classes/StatsLogger';
5
+ import type StatEventCollector from '../classes/stat/StatEventCollector';
6
6
  import { type DebugLogger } from './Debug';
7
7
  /**
8
8
  * Тип камеры мобильного устройства
@@ -85,24 +85,24 @@ declare namespace WebRTCUtils {
85
85
  * @param needAudio Нужно ли аудио
86
86
  * @param needEmptyTracks Добавлять ли в стрим пустые треки для отключенного видео/аудио
87
87
  */
88
- function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
88
+ function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
89
89
  /**
90
90
  * Запрашивает трансляцию экрана пользователя с опциональным захватом звука
91
91
  */
92
- function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
92
+ function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
93
93
  /**
94
94
  * Запрашивает камеру пользователя
95
95
  *
96
96
  * @param deviceId ID устройства
97
97
  * @param resolution Размеры видео
98
98
  */
99
- function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
99
+ function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
100
100
  /**
101
101
  * Запрашивает микрофон пользователя
102
102
  *
103
103
  * @param deviceId ID устройства
104
104
  */
105
- function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
105
+ function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
106
106
  /**
107
107
  * Устанавливает размер видео в стриме
108
108
  *