@vkontakte/calls-sdk 2.8.12-dev.a3089173.0 → 2.8.12-dev.a4b1a09a.0

package/CallsSDK.d.ts

@@ -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';
@@ -272,8 +273,14 @@ export declare function authorize(authToken?: string, apiBaseUrl?: IAPIBaseUrl):
 export declare function acceptCall(mediaOptions?: MediaOption[], conversationId?: string): Promise<ConversationData>;
 /**
  * Отклонить входящий звонок
+ *
+ * @param conversationId ID звонка
+ * @param params.reason Причина завершения для проброса в сигналинг
+ * (по умолчанию `REJECTED`). См. {@link ClientHangupReason}.
  */
-export declare function declineCall(conversationId?: string): Promise<void>;
+export declare function declineCall(conversationId?: string, params?: {
+    reason?: ClientHangupReason;
+}): Promise<void>;
 /**
  * Присоединиться к активному звонку
  *
@@ -295,8 +302,14 @@ 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 conversationId ID звонка
+ * @param params.reason Причина завершения для проброса в сигналинг.
+ * По умолчанию `HUNGUP` (если звонок активен) или `CANCELED`. См. {@link ClientHangupReason}.
  */
-export declare function hangup(conversationId?: string): Promise<void>;
+export declare function hangup(conversationId?: string, params?: {
+    reason?: ClientHangupReason;
+}): Promise<void>;
 /**
  * Добавить собеседника в звонок
  *
@@ -769,9 +782,6 @@ export declare function stopAsr(params?: IAsrStopParams): Promise<void>;
 export declare function requestAsr(request: boolean): Promise<void>;
 export declare function startUrlSharing(sharedUrl: string): Promise<void>;
 export declare function stopUrlSharing(): Promise<void>;
-export declare function sendTestCommand(name: string, params?: any): void;
-export declare function startAnalyzingAudio(expectAudio: boolean, expectedActiveTracks?: number | null, expectedTrackFrequencies?: number[] | null): void;
-export declare function stopAnalyzingAudio(): void;
 export declare function switchCall(conversationId: string): Promise<void>;
 export declare function getActiveCallId(): string | null;
 /**
@@ -784,5 +794,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, };
 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

@@ -4,7 +4,7 @@ import { ConversationData } from '../types/Conversation';
 import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
-import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
+import { OkUserId, ParticipantId } from '../types/Participant';
 import PushData from '../types/PushData';
 export type ClientStats = {
     call_topology: 'D' | 'S';
@@ -38,7 +38,7 @@ export default abstract class BaseApi {
      */
     setAbortSignal(signal: AbortSignal | undefined): void;
     abstract authorize(): Promise<void>;
-    abstract userId(participantId: ParticipantId): ExternalParticipantId;
+    abstract userId(participantId: ParticipantId): ExternalParticipantId | null;
     abstract deviceId(): string;
     abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
@@ -72,13 +72,11 @@ export default abstract class BaseApi {
     logClientStats(items: ClientStats[]): void;
     abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
     getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
-    getCachedRawOkIdByExternalId(externalId: ExternalId): OkUserId | null;
-    getCachedExternalIdByOkId(okId: OkUserId): ExternalParticipantId | null;
-    cacheExternalId(compositeId: OkUserId | CompositeUserId | ParticipantId, externalId: ExternalParticipantId): void;
-    mapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId, okId: OkUserId | CompositeUserId): void;
-    unmapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId): void;
-    getDecorativeIdByInitialId(okId: OkUserId | CompositeUserId | ParticipantId): OkUserId | undefined;
-    replaceByInitialIdIdIfExists(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
+    getCachedExternalIdByParticipantId(participantId: ParticipantId): ExternalParticipantId | null;
+    cacheExternalId(participantId: ParticipantId, externalId: ExternalParticipantId): void;
+    mapDecorativeId(decorativeId: ParticipantId, initialId: ParticipantId): void;
+    unmapDecorativeId(initialId: ParticipantId): void;
+    getDecorativeIdByInitialId(initialId: ParticipantId): ParticipantId | undefined;
     hangupConversation(conversationId: string, reason?: HangupType): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;
     getServerTime(): Promise<number>;

package/abstract/BaseSignaling.d.ts

@@ -42,6 +42,9 @@ export interface AddParticipantParams {
      */
     payload?: string;
 }
+export declare class SignalingDisposedError 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 +58,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>;
@@ -130,9 +133,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;
 }