@vkontakte/calls-sdk 2.8.12-dev.773596bc.0 → 2.8.12-dev.7afbc576.0

package/CallsSDK.d.ts

@@ -2,7 +2,7 @@
  * CallsSDK
  */
 import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
-import type { EffectVoiceChange } from '@vkontakte/calls-audio-effects';
+import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
 import BaseLogger from './abstract/BaseLogger';
 import { AddParticipantParams } from './abstract/BaseSignaling';
@@ -14,6 +14,7 @@ import Api from './default/Api';
 import Signaling from './default/Signaling';
 import CallDirection from './enums/CallDirection';
 import CallType from './enums/CallType';
+import type ClientHangupReason from './enums/ClientHangupReason';
 import ChatRoomEventType from './enums/ChatRoomEventType';
 import ConversationFeature from './enums/ConversationFeature';
 import ConversationOption from './enums/ConversationOption';
@@ -67,6 +68,7 @@ import { VmojiError } from './types/Vmoji';
 import { VolumeDetector } from './classes/VolumeDetector';
 import { FastStartHandler, FastStartParams } from './types/FastStart';
 import { FastJoinHandler, FastJoinParams, FastJoinResponse } from './types/FastJoin';
+import { FastHangupHandler, FastHangupParams, FastHangupResponse, HangupParams } from './types/FastHangup';
 import PushData from './types/PushData';
 export type { CurrentLogItem, DebugLogGetParams, DebugLogSessionInfo, DebugLogStorageStats } from './utils/DebugStorage';
 /**
@@ -212,6 +214,13 @@ export declare function setVideoEffects(effects: VideoEffects): void;
  * @param effects Экземпляр класса `EffectVoiceChange` из `@vkontakte/calls-audio-effects`
  */
 export declare function setAudioEffects(effects: EffectVoiceChange): void;
+/**
+ * Устанавливает поддержку VAD
+ *
+ * @param vad принимает VadController из `@vkontakte/calls-audio-effects`
+ * @param options принимает VadControllerOptions из `@vkontakte/calls-audio-effects`
+ */
+export declare function setVad(vad: VadLib, options?: VadControllerOptions): void;
 /**
  * Устанавливает библиотеку вимоджи
  *
@@ -263,6 +272,15 @@ export declare function getInbounds(): Promise<PushData[]>;
  * @param authToken Токен авторизации
  * @param apiBaseUrl Базовый адрес для API. Если не передан, то не меняет установленный
  */
+/**
+ * Запускает отправку клиентской статистики.
+ *
+ * Нужен только если `init()` был вызван с `autoStartStats: false`: до этого
+ * момента события копятся в IndexedDB и в сеть не уходят. Первый дрейн после
+ * старта забирает всё накопленное. Повторные вызовы и вызов после автостарта
+ * ничего не делают.
+ */
+export declare function startStats(): void;
 export declare function authorize(authToken?: string, apiBaseUrl?: IAPIBaseUrl): Promise<void>;
 /**
  * Принять входящий звонок
@@ -272,8 +290,14 @@ export declare function authorize(authToken?: string, apiBaseUrl?: IAPIBaseUrl):
 export declare function acceptCall(mediaOptions?: MediaOption[], conversationId?: string): Promise<ConversationData>;
 /**
  * Отклонить входящий звонок
+ *
+ * @param params Параметры завершения. `params.conversationId` — ID звонка
+ * (по умолчанию текущий активный), `params.reason` — причина завершения
+ * для проброса в сигналинг (по умолчанию `REJECTED`). См. {@link ClientHangupReason}.
+ * `params.onFastHangup` — опционально: вместо Calls API hangup при отклонении.
+ * На закрытии вкладки не используется. См. {@link HangupParams}.
  */
-export declare function declineCall(conversationId?: string): Promise<void>;
+export declare function declineCall(params?: HangupParams): Promise<void>;
 /**
  * Присоединиться к активному звонку
  *
@@ -295,8 +319,16 @@ export declare function joinCallInternal(conversationId: string, mediaOptions: M
 export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOption[], anonymToken?: string, observedIds?: ExternalUserId[], payload?: string, onFastJoin?: FastJoinHandler): Promise<ConversationData>;
 /**
  * Завершить текущий разговор
+ *
+ * @param params Параметры завершения. `params.conversationId` — ID звонка
+ * (по умолчанию текущий активный), `params.reason` — причина завершения
+ * для проброса в сигналинг: по умолчанию `HUNGUP` (если звонок активен) или `CANCELED`.
+ * См. {@link ClientHangupReason}.
+ * `params.onFastHangup` — опционально: вместо Calls API hangup, если обработчик передан.
+ * Без него API hangup не вызывается (signaling hangup остаётся). На `pagehide` всегда beacon.
+ * См. {@link HangupParams}.
  */
-export declare function hangup(conversationId?: string): Promise<void>;
+export declare function hangup(params?: HangupParams): Promise<void>;
 /**
  * Добавить собеседника в звонок
  *
@@ -781,5 +813,5 @@ export declare function getSyncedTime(): number;
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, DisplayLayoutRequest, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, ParticipantListMarker, RequestKeyFrame, Rooms, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IMovieMetaData, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IRoomId, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, IPublishStreamData, VmojiError, FastStartHandler, FastStartParams, FastJoinHandler, FastJoinParams, FastJoinResponse, };
+export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, ClientHangupReason, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, DisplayLayoutRequest, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, ParticipantListMarker, RequestKeyFrame, Rooms, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IMovieMetaData, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IRoomId, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, IPublishStreamData, VmojiError, FastStartHandler, FastStartParams, FastJoinHandler, FastJoinParams, FastJoinResponse, FastHangupHandler, FastHangupParams, FastHangupResponse, HangupParams, };
 export { Api, AuthData, BaseLogger, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStateDataValue, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, VolumeDetector, };

package/abstract/BaseApi.d.ts

@@ -1,5 +1,6 @@
 import CallType from '../enums/CallType';
 import HangupType from '../enums/HangupType';
+import { IHangupParams } from '../types/Api';
 import { ConversationData } from '../types/Conversation';
 import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
@@ -11,13 +12,6 @@ export type ClientStats = {
     vcid: ConversationData['id'] | null;
     [k: string]: string | number | boolean | null;
 };
-export type ClientEvent = {
-    timestamp: number;
-    call_topology: 'D' | 'S';
-    event_type: string;
-    vcid: ConversationData['id'] | null;
-    [k: string]: string | number | boolean | null;
-};
 export type LogItem = {
     count?: number;
     custom: ClientStats;
@@ -38,7 +32,7 @@ export default abstract class BaseApi {
      */
     setAbortSignal(signal: AbortSignal | undefined): void;
     abstract authorize(): Promise<void>;
-    abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
+    abstract userId(participantId: ParticipantId): ExternalParticipantId;
     abstract deviceId(): string;
     abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
@@ -68,8 +62,11 @@ export default abstract class BaseApi {
     log(items: LogItem[]): void;
     /**
      * method: vchat.clientStats
+     *
+     * Резолвится только после подтверждённой сервером отправки: вызывающий
+     * код удаляет события из очереди по факту резолва.
      */
-    logClientStats(items: ClientStats[]): void;
+    logClientStats(items: ClientStats[]): Promise<void>;
     abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
     getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
     getCachedRawOkIdByExternalId(externalId: ExternalId): OkUserId | null;
@@ -79,7 +76,7 @@ export default abstract class BaseApi {
     unmapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId): void;
     getDecorativeIdByInitialId(okId: OkUserId | CompositeUserId | ParticipantId): OkUserId | undefined;
     replaceByInitialIdIdIfExists(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
-    hangupConversation(conversationId: string, reason?: HangupType): void;
+    hangupConversation(conversationId: string, reason?: HangupType, hangupParams?: Partial<IHangupParams>): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;
     getServerTime(): Promise<number>;
     cleanup(): void;

package/abstract/BaseSignaling.d.ts

@@ -42,6 +42,12 @@ export interface AddParticipantParams {
      */
     payload?: string;
 }
+export declare class SignalingDisposedError extends Error {
+    constructor(command?: string);
+}
+export declare class ProducerConnectionClosedError extends Error {
+    constructor(command?: string);
+}
 /**
  * Should trigger SignalingEvent.NOTIFICATION on notification message and SignalingEvent.FAILED on error
  * https://wiki.odkl.ru/display/projects/Signaling+API#SignalingAPI-Notifications
@@ -55,11 +61,11 @@ export default abstract class BaseSignaling extends EventEmitter {
      */
     setAbortSignal(signal: AbortSignal | undefined): void;
     abstract connect(connectionType: SignalingConnectionType, conversation?: ConversationResponse): Promise<SignalingMessage.Connection>;
-    abstract close(): void;
+    abstract dispose(cause?: Error): void;
     abstract hangup(reason: string): Promise<SignalingMessage | void>;
     abstract acceptCall(mediaSettings: MediaSettings): Promise<SignalingMessage>;
     abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
-    abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
+    abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidateInit): Promise<SignalingMessage>;
     abstract changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
     abstract changeParticipantState(state: ParticipantStateData, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
     abstract hold(hold: boolean, capabilities?: TCapabilities): Promise<SignalingMessage>;
@@ -119,6 +125,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
     abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
     abstract useCommandDataChannel(status: boolean): void;
+    abstract resetProducerConnection(cause?: Error): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<GetParticipantsSignalingResponse>;
     abstract getPeerId(): number | null;
@@ -130,9 +137,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     requestRealloc(): void;
     setEndpoint(endpoint: string): void;
     setWebTransportEndpoint(endpoint: string | null): void;
-    setConversationId(conversationId: string): void;
     readyToSend(isReady?: boolean): void;
-    cleanup(): void;
-    requestTestMode(consumerCommand: string, producerCommand: string | null): void;
+    requestTestMode(consumerCommand: string, producerCommand: string | null): Promise<SignalingMessage | void>;
     getNextCommandSequenceNumber(): number;
 }