@vkontakte/calls-sdk 2.8.13-dev.8b43110d.0 → 2.8.13-dev.8d49bb21.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 (37) hide show
  1. package/CallsSDK.d.ts +7 -3
  2. package/abstract/BaseApi.d.ts +1 -1
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +2578 -1988
  5. package/classes/AudioOutput.d.ts +2 -0
  6. package/classes/CallRegistry.d.ts +17 -4
  7. package/classes/MediaSource.d.ts +10 -0
  8. package/classes/StatsLogger.d.ts +1 -1
  9. package/classes/conversation/Conversation.d.ts +23 -7
  10. package/classes/conversation/Conversation.testUtils.d.ts +1 -0
  11. package/classes/stat/BatteryStats.d.ts +25 -0
  12. package/classes/stat/CallLifecycleStats.d.ts +4 -1
  13. package/classes/stat/CallStatTail.d.ts +65 -0
  14. package/classes/stat/ClientResourceStats.d.ts +41 -0
  15. package/classes/stat/CodecStatsAggregator.d.ts +4 -1
  16. package/classes/stat/ConversationStats.d.ts +12 -8
  17. package/classes/stat/SdpStats.d.ts +2 -1
  18. package/classes/stat/Stat.testUtils.d.ts +7 -0
  19. package/classes/stat/StatAggregator.d.ts +3 -1
  20. package/classes/stat/StatDrainScheduler.d.ts +34 -13
  21. package/classes/stat/StatEventCollector.d.ts +7 -12
  22. package/classes/stat/StatPings.d.ts +3 -1
  23. package/classes/stat/StatQueue.d.ts +42 -3
  24. package/classes/stat/StatSignalingCommands.d.ts +3 -1
  25. package/classes/transport/PerfStatReporter.d.ts +5 -1
  26. package/classes/transport/ServerTransport.d.ts +2 -0
  27. package/default/Api.d.ts +3 -0
  28. package/enums/ActiveFeature.d.ts +19 -0
  29. package/package.json +3 -3
  30. package/static/AuthData.d.ts +11 -1
  31. package/static/External.d.ts +4 -0
  32. package/static/Params.d.ts +12 -2
  33. package/types/ClientStatsEvent.d.ts +2 -1
  34. package/types/FastHangup.d.ts +7 -5
  35. package/types/PerfStatReporter.d.ts +25 -1
  36. package/types/Statistics.d.ts +22 -7
  37. package/classes/stat/StatUnloadJournal.d.ts +0 -27
@@ -2,8 +2,8 @@
2
2
  export declare const RECORD_LIMIT = 5000;
3
3
  /** Срок жизни события в очереди. */
4
4
  export declare const MAX_AGE_MS: number;
5
- /** Произвольный набор скалярных полей события. */
6
- export type StatPayload = Record<string, string | number | boolean | null>;
5
+ /** Произвольный набор полей события: скаляры и списки строк. */
6
+ export type StatPayload = Record<string, string | string[] | number | boolean | null>;
7
7
  /** Запись очереди без сгенерированного ключа. */
8
8
  export type StatQueueEntry = {
9
9
  /** userId владельца события. Не может быть неизвестным. */
@@ -21,6 +21,19 @@ export type StatQueueRecord = StatQueueEntry & {
21
21
  /** Автоинкремент. Единственный источник истины для порядка событий. */
22
22
  id: number;
23
23
  };
24
+ /**
25
+ * Хвост идущего звонка: события, которые уйдут, если вкладка умрёт, не
26
+ * закончив звонок, — call_finish с причиной terminated и итоги звонка.
27
+ */
28
+ export type StatTail = {
29
+ /** `<id вкладки>.<conversationId>` */
30
+ key: string;
31
+ uid: number;
32
+ vcid: string;
33
+ /** Время финиша в хвосте, device-time. */
34
+ ts: number;
35
+ entries: StatQueueEntry[];
36
+ };
24
37
  /**
25
38
  * Персистентная очередь событий статистики поверх IndexedDB.
26
39
  *
@@ -39,6 +52,25 @@ export default abstract class StatQueue {
39
52
  static isSupported(): boolean;
40
53
  /** @returns ключ записи или null, если хранилище не приняло её. */
41
54
  static append(entry: StatQueueEntry): Promise<number | null>;
55
+ /** Создаёт или перезаписывает хвост звонка. @returns false — хранилище недоступно. */
56
+ static putTail(tail: StatTail): Promise<boolean>;
57
+ /**
58
+ * Обновляет хвост, только если он ещё лежит: пропавший хвост забрала
59
+ * другая вкладка, воскрешать его нельзя.
60
+ */
61
+ static updateTail(tail: StatTail): Promise<'updated' | 'missing' | 'failed'>;
62
+ /** Удаляет хвост. 'missing' — его уже забрала другая вкладка. */
63
+ static removeTail(key: string): Promise<'removed' | 'missing' | 'failed'>;
64
+ static listTailKeys(): Promise<string[]>;
65
+ /**
66
+ * Переносит хвост в очередь одной транзакцией. Если у звонка этого
67
+ * пользователя call_finish уже есть, хвост просто удаляется.
68
+ *
69
+ * @returns 'added' — события хвоста в очереди, 'exists' — финиш уже был,
70
+ * 'expired' — хвост старше MAX_AGE_MS и удалён, 'missing' — хвоста нет,
71
+ * 'failed' — хранилище недоступно.
72
+ */
73
+ static adoptTail(key: string): Promise<'added' | 'exists' | 'expired' | 'missing' | 'failed'>;
42
74
  /**
43
75
  * Проставляет delta перечисленным записям, у которых её ещё нет.
44
76
  *
@@ -66,10 +98,17 @@ export default abstract class StatQueue {
66
98
  static evictOlderThan(maxAgeMs: number, now?: number): Promise<void>;
67
99
  private static _checkSupport;
68
100
  private static _open;
101
+ /** Раз в EVICT_CHECK_EVERY записей подрезает хранилище до лимита. */
102
+ private static _countAppend;
69
103
  private static _close;
104
+ /** Создаёт недостающие таблицы: и новую базу, и базу версии 1 с событиями. */
70
105
  private static _createSchema;
71
- /** Обёртка над транзакцией: резолвится после успешного коммита. */
106
+ /**
107
+ * Обёртка над транзакцией: резолвится после успешного коммита. body
108
+ * получает первую из таблиц и саму транзакцию — для остальных.
109
+ */
72
110
  private static _runTransaction;
111
+ private static _request;
73
112
  /** Читает запись с минимальным id, то есть самую старую в хранилище. */
74
113
  private static _readOldestRecord;
75
114
  /**
@@ -1,5 +1,5 @@
1
1
  import { SignalingTransportType } from '../../enums/SignalingTransportStat';
2
- import StatEventCollector from './StatEventCollector';
2
+ import StatEventCollector, { ClientStatsPayload } from './StatEventCollector';
3
3
  export declare class StatSignalingCommands {
4
4
  private readonly _logger;
5
5
  private trackerByCommand;
@@ -7,5 +7,7 @@ export declare class StatSignalingCommands {
7
7
  mark(command: string, time: number, transport: SignalingTransportType): void;
8
8
  /** Отправляем данные в стату */
9
9
  logMetrics(): void;
10
+ /** Сводки на текущий момент, без отправки и без сброса. */
11
+ summaries(): ClientStatsPayload[];
10
12
  destroy(): void;
11
13
  }
@@ -8,8 +8,10 @@ export default class PerfStatReporter extends EventEmitter {
8
8
  private _previousPerfStatReportTimestamp;
9
9
  private _previousNetworkStatReportTimestamp;
10
10
  private _previousCallStatReportTimestamp;
11
- private _previousCallStatReport;
11
+ private _previousCounters;
12
12
  private _previousRemoteInboundRtps;
13
+ private _previousInboundRtps;
14
+ private _previousOutboundRtps;
13
15
  private _previousCandidatePair;
14
16
  private _screenShareStats;
15
17
  private _signaling;
@@ -24,7 +26,9 @@ export default class PerfStatReporter extends EventEmitter {
24
26
  private reportNetworkStats;
25
27
  private _reportCallStats;
26
28
  private _reportCandidatePair;
29
+ private _calculateRemotePacketLoss;
27
30
  private _calculatePacketLoss;
31
+ private _calculateOutboundDeltas;
28
32
  private _handleScreenSharingStat;
29
33
  private _handleTransportStateChanged;
30
34
  }
@@ -83,6 +83,8 @@ export default class ServerTransport extends BaseTransport {
83
83
  private _startSettingsInterval;
84
84
  private _stopSettingsInterval;
85
85
  private _collectStat;
86
+ /** mid потока быстрой шары, чтобы отделить его от камеры в статистике */
87
+ private _getScreenShareMid;
86
88
  private _reportStats;
87
89
  private _detectStaleTracks;
88
90
  private _allocateConsumer;
package/default/Api.d.ts CHANGED
@@ -10,6 +10,7 @@ import PushData from '../types/PushData';
10
10
  export default class Api extends BaseApi {
11
11
  private _uuid;
12
12
  private _idCache;
13
+ constructor();
13
14
  private _callUnsafe;
14
15
  protected _call(method: string, data?: any, noSession?: boolean, allowReauthorize?: boolean): Promise<any>;
15
16
  userId(participantId: ParticipantId): ExternalParticipantId | null;
@@ -22,6 +23,8 @@ export default class Api extends BaseApi {
22
23
  private _removeCachedAnonymLogin;
23
24
  private _reauthorize;
24
25
  private _applyAnonymLogin;
26
+ /** Кладёт в кеш id соответствие своего участника из auth.anonymLogin */
27
+ private _cacheSelfExternalId;
25
28
  private _buildClientStatsData;
26
29
  /** Ошибки по отдельным событиям логируются, но батч трактуется целиком. */
27
30
  private _reportClientStatsItemErrors;
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Фичи, активные во время звонка. Уходят в метрику active_features,
3
+ * чтобы по ним разрезать остальную статистику: сколько фризов при включённой камере,
4
+ * какой битрейт при шаре и так далее.
5
+ *
6
+ * Здесь только то, что реально включено прямо сейчас, а не то, что разрешено настройками:
7
+ * иначе фича попадала бы в метрику у всех, кому ее просто не запретили.
8
+ *
9
+ * Сервер принимает только имена из своего списка, незнакомые отбрасывает с ошибкой.
10
+ * Новое имя добавляем сюда после того, как его добавят на сервере.
11
+ */
12
+ declare enum ActiveFeature {
13
+ MICROPHONE = "MICROPHONE",
14
+ CAMERA = "CAMERA",
15
+ /** Любая шара экрана, в том числе быстрая */
16
+ SCREEN = "SCREEN",
17
+ ANIMOJI = "ANIMOJI"
18
+ }
19
+ export default ActiveFeature;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vkontakte/calls-sdk",
3
- "version": "2.8.13-dev.8b43110d.0",
3
+ "version": "2.8.13-dev.8d49bb21.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",
@@ -14,9 +14,9 @@
14
14
  "**/*.d.ts"
15
15
  ],
16
16
  "dependencies": {
17
- "@vkontakte/calls-audio-effects": "1.4.2-dev.7473a524.0",
17
+ "@vkontakte/calls-audio-effects": "1.5.0",
18
18
  "@vkontakte/calls-video-effects": "2.2.3-beta.7",
19
- "@vkontakte/calls-vmoji": "1.0.10-dev.d1b380b7.0",
19
+ "@vkontakte/calls-vmoji": "1.0.10",
20
20
  "@vkontakte/libvpx": "2.0.9",
21
21
  "bit-buffer": "0.2.5",
22
22
  "fflate": "^0.8.2",
@@ -1,9 +1,16 @@
1
- import type { OkUserId } from '../types/Participant';
1
+ import type { ExternalParticipantId } from '../types/ExternalId';
2
+ import type { OkUserId, ParticipantId } from '../types/Participant';
3
+ /** Свой участник и его внешний id */
4
+ export type SelfExternalId = {
5
+ participantId: ParticipantId;
6
+ externalId: ExternalParticipantId;
7
+ };
2
8
  export default abstract class AuthData {
3
9
  private static _sessionKey;
4
10
  private static _sessionSecretKey;
5
11
  private static _accessToken;
6
12
  private static _userId;
13
+ private static _selfExternalId;
7
14
  private static _reauthorizePromise;
8
15
  static get sessionKey(): string | undefined;
9
16
  static set sessionKey(value: string | undefined);
@@ -13,6 +20,9 @@ export default abstract class AuthData {
13
20
  static set accessToken(value: string | undefined);
14
21
  static get userId(): OkUserId | null;
15
22
  static set userId(value: OkUserId | null);
23
+ /** Свой участник и его внешний id из ответа auth.anonymLogin */
24
+ static get selfExternalId(): SelfExternalId | null;
25
+ static set selfExternalId(value: SelfExternalId | null);
16
26
  static isEmpty(): boolean;
17
27
  /**
18
28
  * Дедуплицирует одновременные попытки реавторизации из разных инстансов Api.
@@ -635,6 +635,10 @@ declare namespace External {
635
635
  */
636
636
  function onParticipantIdChanged(prevId: ExternalParticipantId, newId: ExternalParticipantId, conversationId?: string): void;
637
637
  function onVideoSuspendSuggest(bandwidth: number, conversationId?: string): void;
638
+ /**
639
+ * Успешно применено первое подключение к сигналингу или переподключение.
640
+ */
641
+ function onSignalingConnected(conversationId: string): void;
638
642
  /**
639
643
  * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
640
644
  *
@@ -562,7 +562,9 @@ export type ParamsObject = {
562
562
  */
563
563
  forwardEmptyIceCandidate: boolean;
564
564
  /**
565
- * Получен локальный стрим с камеры/микрофона
565
+ * Получен локальный стрим с камеры/микрофона, в том числе до подключения сигналинга.
566
+ * Повторяется после изменения видео (включение, выключение, смена камеры).
567
+ * Повторное событие может содержать тот же MediaStream с обновлёнными треками.
566
568
  */
567
569
  onLocalStream?: (stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string) => void;
568
570
  /**
@@ -744,7 +746,8 @@ export type ParamsObject = {
744
746
  onLocalVolume?: (volume: number, isMicEnabled: boolean) => void;
745
747
  onJoinStatus?: (available: boolean, chatId: string, conversationId?: string) => void;
746
748
  /**
747
- * Звонок был завершен
749
+ * Звонок завершён локально. При hangup callback планируется сразу, ровно один раз, без ожидания сети.
750
+ * Доставляется асинхронно; Promise hangup отдельно ждёт известную SDK работу по завершению.
748
751
  */
749
752
  onHangup?: (type: HangupReason | Error, conversationId: string | null) => void;
750
753
  /**
@@ -933,6 +936,13 @@ export type ParamsObject = {
933
936
  * @param bandwidth текущая полоса пропускания, kbps
934
937
  */
935
938
  onVideoSuspendSuggest?: (bandwidth: number, conversationId?: string) => void;
939
+ /**
940
+ * Первое подключение к сигналингу или переподключение успешно применено к состоянию звонка.
941
+ * Звонок зарегистрирован под conversationId, локальное управление доступно, в том числе в зале ожидания.
942
+ * Событие не означает принятие звонка собеседником или готовность WebRTC.
943
+ * Callback вызывается асинхронно; к моменту вызова звонок может уже завершиться.
944
+ */
945
+ onSignalingConnected?: (conversationId: string) => void;
936
946
  /**
937
947
  * Одобрено повышение пользователя в зале ожидания/зале в режиме Audience
938
948
  *
@@ -1,7 +1,8 @@
1
+ import { StatPayload } from '../classes/stat/StatQueue';
1
2
  /**
2
3
  * Событие статистики SDK, которое получает `onClientStats`
3
4
  */
4
- export type ClientStatsEvent = Record<string, string | number | boolean | null> & {
5
+ export type ClientStatsEvent = StatPayload & {
5
6
  /** Имя события из `Stat`. У периодической статистики звонка его нет */
6
7
  name?: string;
7
8
  /** ID звонка, `null` — пока он неизвестен */
@@ -34,13 +34,15 @@ export interface FastHangupResponse {
34
34
  *
35
35
  * `reason` и `conversationId` идут в signaling hangup.
36
36
  * `onFastHangup` заменяет Calls API `vchat.hangupConversation`, если обработчик передан
37
- * (явный hangup/decline или delayed hangup во время init).
38
- * Если обработчик не передан, API hangup не вызывается — кроме закрытия вкладки (`pagehide`),
39
- * где SDK всегда шлёт beacon, и delayed hangup без handler.
37
+ * (явный hangup/decline, включая отмену инициализации).
38
+ * При `hangup` без обработчика SDK отправляет Calls API beacon, если серверный ID уже известен.
39
+ * При `declineCall` без обработчика остаётся только signaling hangup.
40
+ * На закрытии вкладки (`pagehide`) SDK всегда использует beacon вместо обработчика.
40
41
  */
41
42
  export interface HangupParams {
42
43
  /**
43
- * ID звонка. Если опущен — завершается текущий активный звонок.
44
+ * Текущий или исходный ID для локального hangup; declineCall требует текущий ID готового звонка.
45
+ * Без ID: активный готовый, затем первый готовый, а для hangup — также единственный готовящийся звонок.
44
46
  */
45
47
  conversationId?: string;
46
48
  /**
@@ -61,6 +63,6 @@ export interface HangupParams {
61
63
  * На `pagehide` не используется — SDK всегда отправляет `sendBeacon`.
62
64
  *
63
65
  * @param params Параметры запроса
64
- * @param signal AbortSignal текущего звонка, если он ещё жив на момент вызова
66
+ * @param signal При `hangup` — отдельный AbortSignal завершения, при `declineCall` — сигнал текущего звонка, если он есть
65
67
  */
66
68
  export type FastHangupHandler = (params: FastHangupParams, signal?: AbortSignal) => Promise<FastHangupResponse>;
@@ -40,9 +40,33 @@ export interface ICallStatLog extends Pick<CallStatReport, 'call_topology' | 'na
40
40
  is_simulcast?: boolean;
41
41
  concealed_silent_audio_samples?: number;
42
42
  concealment_audio_avg_size?: number;
43
+ /** Потери исходящего видео: 100 * ΣΔpacketsLost / (ΣΔpacketsLost + ΣΔpacketsSent), по парам SSRC со свежим RR */
43
44
  video_loss?: number;
45
+ /** Потери исходящего аудио: 100 * ΣΔpacketsLost / (ΣΔpacketsLost + ΣΔpacketsSent), по парам SSRC со свежим RR */
44
46
  audio_loss?: number;
47
+ /** Потери входящего видео за период, в процентах */
48
+ in_video_loss?: number;
49
+ /** Потери входящего аудио за период, в процентах */
50
+ in_audio_loss?: number;
51
+ /** Байты, отправленные по исходящим аудио потокам за период, включая шару звука */
52
+ audio_bytes_sent?: number;
53
+ /** Уровень исходящего звука в шкале 16-битного PCM, от 0 до 32767 */
54
+ audio_level?: number;
55
+ /** Битрейт исходящего видео без ретрансмитов, кибибит/с */
56
+ br_encode?: number;
57
+ /** Битрейт отправки видео камеры, кибибит/с */
58
+ br_transmit?: number;
59
+ /** Битрейт ретрансмитов видео камеры, кибибит/с */
60
+ br_retransmit?: number;
61
+ /** Кадры камеры, закодированные энкодером за период */
62
+ frames_encoded?: number;
45
63
  cpu_hardware_concurrency?: number;
46
64
  audio_tracks?: number;
47
- [k: string]: string | number | boolean | undefined;
65
+ /** Максимум участников за интервал между отправками */
66
+ participants_max?: number;
67
+ /** Фичи, включенные в любой момент интервала */
68
+ active_features?: string[];
69
+ /** Максимальная площадь окна приложения за интервал, в мегапикселях */
70
+ app_total_area_mpx_max?: number;
71
+ [k: string]: string | string[] | number | boolean | undefined;
48
72
  }
@@ -36,8 +36,14 @@ interface StatRtpOutboundVideo {
36
36
  framesSent?: number;
37
37
  framesPerSecond?: number;
38
38
  targetBitrate?: number;
39
+ /**
40
+ * Общее количество кадров, закодированных энкодером
41
+ */
42
+ framesEncoded?: number;
39
43
  }
40
44
  export interface StatRtp extends StatRtpOutboundVideo {
45
+ /** Время измерения, для remote-inbound-rtp — время получения RTCP Receiver Report */
46
+ timestamp: number;
41
47
  /**
42
48
  * Уникальный идентификатор источника синхронизации RTP
43
49
  */
@@ -65,6 +71,10 @@ export interface StatRtp extends StatRtpOutboundVideo {
65
71
  * Общее количество байтов, отправленных по этому потоку
66
72
  */
67
73
  bytesSent: number;
74
+ /**
75
+ * Общее количество байтов, отправленных повторно (ретрансмиты) по этому потоку
76
+ */
77
+ retransmittedBytesSent?: number;
68
78
  /**
69
79
  * Общее количество байтов заголовков, полученных по этому потоку
70
80
  */
@@ -73,6 +83,11 @@ export interface StatRtp extends StatRtpOutboundVideo {
73
83
  * Общее количество байтов заголовков, отправленных по этому потоку
74
84
  */
75
85
  headerBytesSent: number;
86
+ /**
87
+ * Уровень звука исходящего аудио потока в момент снятия статистики, от 0 до 1.
88
+ * Берется из media-source, у входящих потоков его нет.
89
+ */
90
+ audioLevel?: number;
76
91
  /**
77
92
  * Среднее значение джиттера в секундах
78
93
  * Джиттер — это вариация задержки в получении пакетов данных.
@@ -81,19 +96,15 @@ export interface StatRtp extends StatRtpOutboundVideo {
81
96
  /**
82
97
  * Общее количество потерянных пакетов
83
98
  */
84
- packetsLost: number;
99
+ packetsLost?: number;
85
100
  /**
86
101
  * Общее количество полученных пакетов
87
102
  */
88
- packetsReceived: number;
103
+ packetsReceived?: number;
89
104
  /**
90
105
  * Общее количество отправленных пакетов
91
106
  */
92
- packetsSent: number;
93
- /**
94
- * Доля потерянных пакетов
95
- */
96
- fractionLost: number;
107
+ packetsSent?: number;
97
108
  /**
98
109
  * Количество Picture Loss Indication (PLI) сообщений
99
110
  * PLI — это сообщения, указывающие на потерю кадров изображения.
@@ -113,6 +124,10 @@ export interface StatRtp extends StatRtpOutboundVideo {
113
124
  * Идентификатор пользователя, связанный с этим потоком
114
125
  */
115
126
  userId?: string;
127
+ /**
128
+ * Поток демонстрации экрана (быстрая шара), а не камеры
129
+ */
130
+ isScreenShare?: boolean;
116
131
  /**
117
132
  * Пропускная способность в битах в секунду
118
133
  */
@@ -1,27 +0,0 @@
1
- import { StatQueueEntry } from './StatQueue';
2
- /**
3
- * Синхронный журнал умирающей вкладки поверх localStorage: транзакция
4
- * IndexedDB из pagehide не успевает закоммититься. Следующий старт SDK
5
- * переносит журнал в очередь. Ключ уникален на вкладку.
6
- */
7
- export default abstract class StatUnloadJournal {
8
- private static _tabKey;
9
- private static _entries;
10
- /**
11
- * Открывает новый журнал для этой вкладки. Без сброса пережившая pagehide
12
- * вкладка записала бы во второй журнал уже перенесённые события.
13
- */
14
- static beginTabSession(): void;
15
- static writeSync(entry: StatQueueEntry): boolean;
16
- /**
17
- * Переносит журналы всех закрытых вкладок в очередь. Журнал стирается
18
- * независимо от исхода: повторные попытки дали бы дубли.
19
- *
20
- * @returns число перенесённых событий.
21
- */
22
- static drainToQueue(): Promise<number>;
23
- /** Читает журнал и сразу удаляет его. null — ключа уже нет или хранилище недоступно. */
24
- private static _take;
25
- private static _storage;
26
- private static _isValidEntry;
27
- }