@vkontakte/calls-sdk 2.8.12-dev.c0dd153e.0 → 2.8.12-dev.c8b26761.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 (39) hide show
  1. package/CallsSDK.d.ts +23 -6
  2. package/abstract/BaseApi.d.ts +2 -1
  3. package/abstract/BaseSignaling.d.ts +5 -4
  4. package/calls-sdk.cjs.js +9 -9
  5. package/calls-sdk.esm.js +3643 -2858
  6. package/classes/CallRegistry.d.ts +5 -1
  7. package/classes/ExternalIdCache.d.ts +1 -0
  8. package/classes/StatsLogger.d.ts +17 -2
  9. package/classes/{Conversation.d.ts → conversation/Conversation.d.ts} +54 -48
  10. package/classes/conversation/Conversation.testUtils.d.ts +148 -0
  11. package/classes/{ConversationResponseValidator.d.ts → conversation/ConversationResponseValidator.d.ts} +1 -1
  12. package/classes/{DisplayLayoutRequester.d.ts → conversation/DisplayLayoutRequester.d.ts} +5 -5
  13. package/classes/conversation/index.d.ts +1 -0
  14. package/classes/stat/CallFinishClassifier.d.ts +11 -0
  15. package/classes/stat/CallLifecycleStats.d.ts +42 -0
  16. package/classes/stat/ConversationStats.d.ts +5 -4
  17. package/classes/stat/FirstMediaSentProbe.d.ts +13 -0
  18. package/classes/stat/StatPings.d.ts +1 -2
  19. package/classes/stat/StatSignalingCommands.d.ts +1 -2
  20. package/classes/transport/BaseTransport.d.ts +7 -1
  21. package/classes/transport/DirectTransport.d.ts +2 -1
  22. package/classes/transport/ServerTransport.d.ts +2 -1
  23. package/classes/transport/Transport.d.ts +6 -1
  24. package/default/Api.d.ts +2 -3
  25. package/default/Signaling.d.ts +9 -12
  26. package/default/SignalingTransport.d.ts +7 -1
  27. package/enums/ClientHangupReason.d.ts +7 -0
  28. package/enums/HangupType.d.ts +0 -1
  29. package/enums/Stat.d.ts +5 -1
  30. package/package.json +1 -1
  31. package/static/AuthData.d.ts +10 -0
  32. package/static/Debug.d.ts +1 -0
  33. package/static/External.d.ts +1 -1
  34. package/static/Params.d.ts +1 -1
  35. package/static/WebRTCUtils.d.ts +4 -0
  36. package/types/Conversation.d.ts +12 -2
  37. package/types/FastHangup.d.ts +68 -0
  38. package/types/SignalingMessage.d.ts +4 -1
  39. package/utils/IceServers.d.ts +2 -0
@@ -48,13 +48,16 @@ export declare class Transport extends EventEmitter {
48
48
  private readonly _logger;
49
49
  private readonly _statAggregator;
50
50
  private readonly _codecStatsAggregator;
51
- constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null);
51
+ private readonly _onFirstMediaSent;
52
+ private _firstMediaSentProbeStopped;
53
+ constructor(topology: TransportTopology, signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatsLogger | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);
52
54
  updateSettings(settings: ServerSettings): void;
53
55
  updateStatisticsInterval(): void;
54
56
  allocate(participantId: ParticipantId, isMaster?: boolean): void;
55
57
  open(participantIds: ParticipantId[], peerId?: string | null, observer?: boolean, force?: boolean): void;
56
58
  close(participantId: ParticipantId): void;
57
59
  destroy(): void;
60
+ stopFirstMediaSentProbe(): void;
58
61
  holdClose(): void;
59
62
  setRemoteHold(hold: boolean): void;
60
63
  getTopology(): TransportTopology;
@@ -69,6 +72,8 @@ export declare class Transport extends EventEmitter {
69
72
  private _setStates;
70
73
  private _setLocalState;
71
74
  private _onSignalingNotification;
75
+ private _handleFirstMediaSent;
76
+ private _getFirstMediaSentCallback;
72
77
  private _onTopologyChanged;
73
78
  private _createDirectTransport;
74
79
  private _createServerTransport;
package/default/Api.d.ts CHANGED
@@ -7,12 +7,11 @@ import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/Exte
7
7
  import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
8
8
  import PushData from '../types/PushData';
9
9
  export default class Api extends BaseApi {
10
- private _userId;
11
10
  private _uuid;
12
11
  private _idCache;
13
12
  private _callUnsafe;
14
- protected _call(method: string, data?: any, noSession?: boolean): Promise<any>;
15
- userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
13
+ protected _call(method: string, data?: any, noSession?: boolean, allowReauthorize?: boolean): Promise<any>;
14
+ userId(participantId: ParticipantId): ExternalParticipantId;
16
15
  authorize(): Promise<void>;
17
16
  private _getAnonymLoginCacheKey;
18
17
  private _getCachedAnonymLogin;
@@ -35,13 +35,13 @@ export default class Signaling extends BaseSignaling {
35
35
  private datachannelCommandsQueue;
36
36
  private incomingCache;
37
37
  private responseHandlers;
38
+ private disposed;
38
39
  private connectionType;
39
40
  private conversationResolve;
40
41
  private conversationReject;
41
42
  private connected;
42
43
  private listenersReady;
43
44
  private peerId;
44
- private conversationId;
45
45
  private connectionMessageWaitTimer;
46
46
  private participantIdRegistry;
47
47
  private producerNotificationDataChannel;
@@ -60,21 +60,16 @@ export default class Signaling extends BaseSignaling {
60
60
  setAbortSignal(signal: AbortSignal | undefined): void;
61
61
  setEndpoint(endpoint: string): void;
62
62
  setWebTransportEndpoint(endpoint: string | null): void;
63
- setConversationId(conversationId: string): void;
64
63
  setParticipantIdRegistry(participantIdRegistry: ParticipantIdRegistry): void;
65
64
  setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
66
65
  setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
67
66
  useCommandDataChannel(status: boolean): void;
68
- /**
69
- * Free used resources
70
- */
71
- cleanup(): void;
72
67
  /**
73
68
  * Open a connection with a signaling server
74
69
  */
75
70
  connect(connectionType: SignalingConnectionType): Promise<SignalingMessage.Connection>;
76
71
  getNextCommandSequenceNumber(): number;
77
- hangup(reason: string): Promise<SignalingMessage | void>;
72
+ hangup(reason: string): Promise<SignalingMessage>;
78
73
  sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
79
74
  requestTestMode(consumerCommand: string, producerCommand: string | null): Promise<SignalingMessage>;
80
75
  sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
@@ -138,10 +133,7 @@ export default class Signaling extends BaseSignaling {
138
133
  acceptPromotion(reject?: boolean): Promise<SignalingMessage>;
139
134
  feedback(key: string): Promise<SignalingMessage>;
140
135
  getHandQueue(): Promise<SignalingMessage>;
141
- /**
142
- * Close a connection with a signaling server
143
- */
144
- close(): void;
136
+ dispose(cause?: Error): void;
145
137
  /**
146
138
  * Этот метод нужен т.к. после получения сообщения "connected" устанавливается транспорт
147
139
  * и подписывается на сигналинг. Данные приходят очень быстро и транспорт пропускает
@@ -173,20 +165,25 @@ export default class Signaling extends BaseSignaling {
173
165
  private _onError;
174
166
  private _serializeErrorEvent;
175
167
  private _onClose;
176
- private _closeSocket;
168
+ private _terminate;
169
+ private _fail;
177
170
  private _isRecordCommand;
178
171
  private _resolvePendingRecordCommands;
179
172
  private _handleCommandResponse;
180
173
  private _handleCommandsQueue;
181
174
  private _startResponseTimer;
175
+ private _resolveCommandWithoutResponse;
182
176
  private _serializeBinary;
183
177
  private _serializeJson;
184
178
  private _convertDisplayLayout;
185
179
  private _waitConnectionMessage;
186
180
  private _stopWaitConnectionMessage;
181
+ private _onTransportConnecting;
187
182
  private _onTransportFailed;
188
183
  private _onTransportReconnectScheduled;
189
184
  private _onTransportConnectionDead;
185
+ private _attachNotificationCallError;
186
+ private _createSignalingCallError;
190
187
  private _getSocketType;
191
188
  private _markTransportStat;
192
189
  private _logTransportStat;
@@ -9,13 +9,19 @@ export declare enum SignalingTransportFailure {
9
9
  export type SignalingTransportFailedEvent = {
10
10
  failure: SignalingTransportFailure;
11
11
  message: string;
12
+ source: SignalingTransportType;
12
13
  remote?: boolean;
13
14
  };
14
15
  export type SignalingTransportReconnectEvent = {
15
16
  count: number;
16
17
  delay: number;
17
18
  };
19
+ export type SignalingTransportConnectingEvent = {
20
+ connectionType: SignalingConnectionType;
21
+ source: SignalingTransportType;
22
+ };
18
23
  export type SignalingTransportHandlers = {
24
+ onConnecting: (event: SignalingTransportConnectingEvent) => void;
19
25
  onOpen: () => void;
20
26
  onMessage: (event: MessageEvent) => void;
21
27
  onError: (event: Event) => void;
@@ -51,7 +57,7 @@ export default class SignalingTransport {
51
57
  resetReconnectCount(): void;
52
58
  connect(connectionType: SignalingConnectionType): void;
53
59
  close(code?: number): void;
54
- send(data: string | ArrayBuffer): void;
60
+ send(data: string | ArrayBuffer): Promise<void>;
55
61
  private _connect;
56
62
  private _connectWebTransport;
57
63
  private _connectWebSocket;
@@ -0,0 +1,7 @@
1
+ import HangupType from './HangupType';
2
+ /**
3
+ * Причины завершения звонка, которые клиент может передать в {@link hangup}/{@link declineCall}
4
+ * и пробросить в сигналинг без маппинга.
5
+ */
6
+ export type ClientHangupReason = HangupType.HUNGUP | HangupType.CANCELED | HangupType.REJECTED | HangupType.BUSY | HangupType.MISSED | HangupType.CALL_TIMEOUT;
7
+ export default ClientHangupReason;
@@ -20,7 +20,6 @@ declare enum HangupType {
20
20
  CALLER_IS_REJECTED = "CALLER_IS_REJECTED",
21
21
  UNKNOWN_ERROR = "UNKNOWN_ERROR",
22
22
  UNSUPPORTED = "UNSUPPORTED",
23
- OLD_VERSION = "OLD_VERSION",
24
23
  SERVICE_DISABLED = "SERVICE_DISABLED",
25
24
  SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
26
25
  EXTERNAL_API_ERROR = "EXTERNAL_API_ERROR",
package/enums/Stat.d.ts CHANGED
@@ -1,4 +1,9 @@
1
1
  declare const enum Stat {
2
+ CALL_INIT = "call_init",
3
+ CALL_START = "call_start",
4
+ CALL_ACCEPTED_OUTGOING = "call_accepted_outgoing",
5
+ CALL_ACCEPTED_INCOMING = "call_accepted_incoming",
6
+ FIRST_MEDIA_SENT = "first_media_sent",
2
7
  CALL_FINISH = "call_finish",// событие отправляемое в конце звонка
3
8
  CODEC_USAGE = "codec_usage",// событие когда меняется кодек
4
9
  SIGNALING_CONNECTED = "signaling_connected",// measure
@@ -7,7 +12,6 @@ declare const enum Stat {
7
12
  FIRST_MEDIA_RECEIVED = "first_media_received",
8
13
  CALL_DECLINED_OR_HANGED_LOCALLY = "CallDeclinedOrHangedLocally",
9
14
  USER_FEEDBACK_RECEIVED = "UserFeedbackReceived",
10
- CALL_START = "call_start",
11
15
  SIGNALING_PING_SUMMARY = "signaling_ping_summary",
12
16
  SIGNALING_COMMAND_SUMMARY = "signaling_command_summary",
13
17
  WEBSOCKET_CONNECTED = "websocket_connected",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vkontakte/calls-sdk",
3
- "version": "2.8.12-dev.c0dd153e.0",
3
+ "version": "2.8.12-dev.c8b26761.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,12 +1,22 @@
1
+ import type { OkUserId } from '../types/Participant';
1
2
  export default abstract class AuthData {
2
3
  private static _sessionKey;
3
4
  private static _sessionSecretKey;
4
5
  private static _accessToken;
6
+ private static _userId;
7
+ private static _reauthorizePromise;
5
8
  static get sessionKey(): string | undefined;
6
9
  static set sessionKey(value: string | undefined);
7
10
  static get sessionSecretKey(): string | undefined;
8
11
  static set sessionSecretKey(value: string | undefined);
9
12
  static get accessToken(): string | undefined;
10
13
  static set accessToken(value: string | undefined);
14
+ static get userId(): OkUserId | null;
15
+ static set userId(value: OkUserId | null);
11
16
  static isEmpty(): boolean;
17
+ /**
18
+ * Дедуплицирует одновременные попытки реавторизации из разных инстансов Api.
19
+ * Первый вызов выполняет authorizeFn, остальные ждут того же промиса.
20
+ */
21
+ static reauthorize(authorizeFn: () => Promise<void>): Promise<void>;
12
22
  }
package/static/Debug.d.ts CHANGED
@@ -21,6 +21,7 @@ export type DebugSessionLogger = DebugLogger & {
21
21
  readonly sessionId: string | null;
22
22
  readonly conversationId: string | null;
23
23
  setConversationId(conversationId: string | null): void;
24
+ send(type: DebugMessageType, ...args: any[]): void;
24
25
  };
25
26
  declare namespace Debug {
26
27
  type ContextProvider = () => DebugMessageContext;
@@ -637,6 +637,6 @@ declare namespace External {
637
637
  /**
638
638
  * Собеседник подключился к сигналлингу
639
639
  */
640
- function onPeerRegistered(conversationId?: string): void;
640
+ function onPeerRegistered(conversationId?: string, externalIds?: ExternalId[]): void;
641
641
  }
642
642
  export default External;
@@ -892,7 +892,7 @@ export type ParamsObject = {
892
892
  /**
893
893
  * Собеседник подключился к сигналлингу
894
894
  */
895
- onPeerRegistered?: (conversationId?: string) => void;
895
+ onPeerRegistered?: (conversationId?: string, externalIds?: ExternalId[]) => void;
896
896
  };
897
897
  export default abstract class Params {
898
898
  private static _params;
@@ -122,6 +122,10 @@ declare namespace WebRTCUtils {
122
122
  * Проверяет поддержку WebRTC браузером
123
123
  */
124
124
  function isBrowserSupported(): boolean;
125
+ /**
126
+ * Возвращает первую отсутствующую capability в стабильном порядке.
127
+ */
128
+ function getBrowserSupportFailure(): BrowserSupportFailure | null;
125
129
  /**
126
130
  * Проверяет поддержку шаринга экрана браузером
127
131
  */
@@ -7,7 +7,8 @@ import MediaOption from '../enums/MediaOption';
7
7
  import UserRole from '../enums/UserRole';
8
8
  import { AsrInfo } from './Asr';
9
9
  import { IFeaturesPerRole } from './ConversationFeature';
10
- import { ExternalId, ExternalParticipantId } from './ExternalId';
10
+ import { ExternalId, ExternalParticipantId, ExternalUserId } from './ExternalId';
11
+ import { FastJoinHandler } from './FastJoin';
11
12
  import { FastStartHandler } from './FastStart';
12
13
  import MediaModifiers from './MediaModifiers';
13
14
  import MuteStates from './MuteStates';
@@ -84,6 +85,16 @@ export type ConversationOnStartParams = {
84
85
  onFastStart?: FastStartHandler;
85
86
  conversationId?: string;
86
87
  };
88
+ export type ConversationOnJoinParams = {
89
+ conversationId?: string;
90
+ mediaOptions: MediaOption[];
91
+ chatId?: string;
92
+ joinLink?: string;
93
+ observedIds?: ExternalUserId[];
94
+ payload?: string;
95
+ onFastJoin?: FastJoinHandler;
96
+ anonymous?: boolean;
97
+ };
87
98
  export type StartConversationParams = {
88
99
  opponentIds?: OkUserId[];
89
100
  opponentType: CallType;
@@ -94,7 +105,6 @@ export type StartConversationParams = {
94
105
  requireAuthToJoin?: boolean;
95
106
  onlyAdminCanShareMovie?: boolean;
96
107
  externalIds?: ExternalId[];
97
- startedTime: number;
98
108
  onFastStart?: FastStartHandler;
99
109
  conversationId?: string;
100
110
  };
@@ -0,0 +1,68 @@
1
+ import type ClientHangupReason from '../enums/ClientHangupReason';
2
+ import type HangupType from '../enums/HangupType';
3
+ /**
4
+ * Параметры запроса завершения звонка через внешнего партнёра (fast hangup).
5
+ *
6
+ * SDK генерирует объект и передаёт его в {@link FastHangupHandler}.
7
+ * Хост и backend партнёра пробрасывают `internalParams` как есть, без парсинга.
8
+ */
9
+ export interface FastHangupParams {
10
+ /**
11
+ * ID звонка
12
+ */
13
+ conversationId: string;
14
+ /**
15
+ * Причина завершения звонка
16
+ */
17
+ reason: HangupType;
18
+ /**
19
+ * Внутренние параметры звонка (JSON-строка). Генерируется SDK.
20
+ */
21
+ internalParams?: string | null;
22
+ }
23
+ /**
24
+ * Ответ внешнего партнёра на завершение звонка.
25
+ */
26
+ export interface FastHangupResponse {
27
+ /**
28
+ * true — участие в звонке завершено
29
+ */
30
+ success: boolean;
31
+ }
32
+ /**
33
+ * Параметры публичных методов {@link hangup} / {@link declineCall}.
34
+ *
35
+ * `reason` и `conversationId` идут в signaling hangup.
36
+ * `onFastHangup` заменяет Calls API `vchat.hangupConversation`, если обработчик передан
37
+ * (явный hangup/decline или delayed hangup во время init).
38
+ * Если обработчик не передан, API hangup не вызывается — кроме закрытия вкладки (`pagehide`),
39
+ * где SDK всегда шлёт beacon, и delayed hangup без handler.
40
+ */
41
+ export interface HangupParams {
42
+ /**
43
+ * ID звонка. Если опущен — завершается текущий активный звонок.
44
+ */
45
+ conversationId?: string;
46
+ /**
47
+ * Причина завершения для проброса в сигналинг. См. {@link ClientHangupReason}.
48
+ */
49
+ reason?: ClientHangupReason;
50
+ /**
51
+ * Обработчик fast hangup — завершение звонка через внешнего партнёра.
52
+ */
53
+ onFastHangup?: FastHangupHandler;
54
+ }
55
+ /**
56
+ * Функция-обработчик fast hangup.
57
+ *
58
+ * Если передана в {@link HangupParams.onFastHangup} при `hangup` / `declineCall`,
59
+ * SDK вызывает её вместо API `vchat.hangupConversation`.
60
+ *
61
+ * Fire-and-forget: `success` и ошибки логируются SDK и не влияют на teardown и `onHangup`.
62
+ *
63
+ * На `pagehide` не используется — SDK всегда отправляет `sendBeacon`.
64
+ *
65
+ * @param params Параметры запроса
66
+ * @param signal AbortSignal текущего звонка, если он ещё жив на момент вызова
67
+ */
68
+ export type FastHangupHandler = (params: FastHangupParams, signal?: AbortSignal) => Promise<FastHangupResponse>;
@@ -34,8 +34,11 @@ export type RecordInfo = {
34
34
  recordExternalOwnerId?: string;
35
35
  };
36
36
  export interface SignalingResponse extends SignalingMessage {
37
- response?: SignalingCommandType;
38
37
  error?: string;
38
+ errorCode?: string;
39
+ errorMessage?: string;
40
+ message?: string;
41
+ response?: SignalingCommandType;
39
42
  reason?: HangupType | FatalError;
40
43
  sequence?: number;
41
44
  type: 'response' | 'error' | 'timeout';
@@ -0,0 +1,2 @@
1
+ import IceServer from '../types/IceServer';
2
+ export declare function createIceServers(stunServer?: IceServer, turnServer?: IceServer): IceServer[];