@vkontakte/calls-sdk 2.8.12-beta.7 → 2.8.12-beta.9

package/classes/CallRegistry.d.ts

@@ -1,4 +1,4 @@
-import Conversation from './Conversation';
+import type Conversation from './conversation';
 import MediaSettings from '../types/MediaSettings';
 export interface HoldableConversation extends Conversation {
     id: string;

package/classes/ExternalIdCache.d.ts

@@ -1,6 +1,7 @@
 import { ExternalId, ExternalParticipantId } from '../types/ExternalId';
 import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
 export declare class ExternalIdCache {
+    private static _normalizeType;
     private _okIdToExternalId;
     private _externalIdToOkId;
     private _decorativeIdToInitialId;

package/classes/{Conversation.d.ts → conversation/Conversation.d.ts}

@@ -1,33 +1,33 @@
 import type { IEffect } from '@vkontakte/calls-video-effects';
 import type { RGBTuple } from '@vkontakte/calls-vmoji';
-import BaseApi from '../abstract/BaseApi';
-import BaseLogger from '../abstract/BaseLogger';
-import { AddParticipantParams } from '../abstract/BaseSignaling';
-import ConversationFeature from '../enums/ConversationFeature';
-import ConversationOption from '../enums/ConversationOption';
-import MediaOption from '../enums/MediaOption';
-import UpdateDisplayLayoutErrorReason from '../enums/UpdateDisplayLayoutErrorReason';
-import UserRole from '../enums/UserRole';
-import UserType from '../enums/UserType';
-import { DebugMessageType } from '../static/Debug';
-import { JSONObject } from '../static/Json';
-import { IAsrStartParams, IAsrStopParams } from '../types/Asr';
-import { AudienceModeHandsResponse } from '../types/AudienceMode';
-import { ConversationData, ConversationOnJoinParams, ConversationOnStartParams } from '../types/Conversation';
-import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk } from '../types/ExternalId';
-import MediaModifiers from '../types/MediaModifiers';
-import MediaSettings, { IVideoDimentions } from '../types/MediaSettings';
-import { IAddMovieParams, IUpdateMovieData } from '../types/MovieShare';
-import MuteStates from '../types/MuteStates';
-import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantStateData } from '../types/Participant';
-import { DisplayLayoutRequest, ParticipantLayout } from '../types/ParticipantLayout';
-import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
-import ParticipantPriority from '../types/ParticipantPriority';
-import { ParticipantStreamDescription } from '../types/ParticipantStreamDescription';
-import { ScreenCaptureSettings } from '../types/ScreenCaptureSettings';
-import SignalingMessage from '../types/SignalingMessage';
-import { WaitingHallResponse } from '../types/WaitingHall';
-import EventEmitter from './EventEmitter';
+import BaseApi from '../../abstract/BaseApi';
+import BaseLogger from '../../abstract/BaseLogger';
+import { AddParticipantParams } from '../../abstract/BaseSignaling';
+import ConversationFeature from '../../enums/ConversationFeature';
+import ConversationOption from '../../enums/ConversationOption';
+import MediaOption from '../../enums/MediaOption';
+import UpdateDisplayLayoutErrorReason from '../../enums/UpdateDisplayLayoutErrorReason';
+import UserRole from '../../enums/UserRole';
+import UserType from '../../enums/UserType';
+import { DebugMessageType } from '../../static/Debug';
+import { JSONObject } from '../../static/Json';
+import { IAsrStartParams, IAsrStopParams } from '../../types/Asr';
+import { AudienceModeHandsResponse } from '../../types/AudienceMode';
+import { ConversationData, ConversationOnJoinParams, ConversationOnStartParams } from '../../types/Conversation';
+import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk } from '../../types/ExternalId';
+import MediaModifiers from '../../types/MediaModifiers';
+import MediaSettings, { IVideoDimentions } from '../../types/MediaSettings';
+import { IAddMovieParams, IUpdateMovieData } from '../../types/MovieShare';
+import MuteStates from '../../types/MuteStates';
+import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantStateData } from '../../types/Participant';
+import { DisplayLayoutRequest, ParticipantLayout } from '../../types/ParticipantLayout';
+import { ParticipantListChunkParameters } from '../../types/ParticipantListChunk';
+import ParticipantPriority from '../../types/ParticipantPriority';
+import { ParticipantStreamDescription } from '../../types/ParticipantStreamDescription';
+import { ScreenCaptureSettings } from '../../types/ScreenCaptureSettings';
+import SignalingMessage from '../../types/SignalingMessage';
+import { WaitingHallResponse } from '../../types/WaitingHall';
+import EventEmitter from '../EventEmitter';
 export default class Conversation extends EventEmitter {
     private readonly _api;
     private readonly _signaling;
@@ -42,7 +42,6 @@ export default class Conversation extends EventEmitter {
     private _waitingHallHoldPending;
     private _participantState;
     private _participants;
-    private _pendingParticipants;
     private _directTransportIsMaster?;
     private _transport;
     private _debugInfo;
@@ -57,6 +56,8 @@ export default class Conversation extends EventEmitter {
     private _serverSettings;
     private _serverTimeOffset;
     private _delayedHangup;
+    private _hangupEmitted;
+    private _hangupPromise;
     private _abortController;
     private _registeredPeerReceived;
     private _calleeUnavailableTimer;
@@ -113,8 +114,10 @@ export default class Conversation extends EventEmitter {
     private _openTransport;
     private _allocateParticipantTransport;
     private _cleanupRegistry;
+    private _emitHangupOnce;
     private _close;
-    destroy(): Promise<void>;
+    destroy(): void;
+    private _destroy;
     private _getConversationParams;
     private _setConversationParams;
     private _buildSignalingEndpoint;
@@ -156,6 +159,7 @@ export default class Conversation extends EventEmitter {
     private _getExistedParticipantByIdOrCreate;
     private _getExternalIdByParticipantId;
     private _getExternalIdsByOkIdsFromCache;
+    private _getOrCacheExternalIdByCompositeId;
     private _registerParticipantAndSetMarkersIfChunkEnabled;
     private _warnParticipantNotInConversation;
     private _denormalizeMarkers;
@@ -198,7 +202,7 @@ export default class Conversation extends EventEmitter {
     private _cleanupTransportForHold;
     private _cleanupSpeakerDetector;
     private _cleanupSpecListener;
-    private _cleanupSignaling;
+    private _disposeSignaling;
     private _onAddParticipant;
     private _onRemoveParticipant;
     changeDevice(kind: MediaDeviceKind): Promise<void>;
@@ -231,7 +235,7 @@ export default class Conversation extends EventEmitter {
     private _getWaitingForPromotionStatus;
     putHandsDown(): Promise<void>;
     requestKeyFrame(participantStreamDescription: ParticipantStreamDescription): Promise<void | SignalingMessage>;
-    requestTestMode(consumerCommand: string, producerCommand: string): Promise<void>;
+    requestTestMode(consumerCommand: string, producerCommand: string): Promise<void | SignalingMessage>;
     updateDisplayLayout(layouts: ParticipantLayout[]): Promise<void>;
     requestDisplayLayout(requests: DisplayLayoutRequest[]): Promise<void>;
     feedback(key: string): Promise<SignalingMessage>;
@@ -360,7 +364,7 @@ export default class Conversation extends EventEmitter {
     private _onRecordInfo;
     private _onStopRecordInfo;
     private _changePinnedParticipantForRoom;
-    _changeRecordInfoForRoom(): Promise<void>;
+    _changeRecordInfoForRoom(): void;
     private _changeAsrInfoForRoom;
     private _changeUrlSharingInfoForRoom;
     private _onParticipantAnimojiChanged;
@@ -435,7 +439,6 @@ export default class Conversation extends EventEmitter {
     private _setMuteStatesForRoomId;
     private _forceOpenTransportForAloneInCall;
     private _registerParticipant;
-    private _getParticipants;
     private _getParticipant;
 }
 declare function _resetPendingInstance(): void;

package/classes/conversation/Conversation.testUtils.d.ts

@@ -0,0 +1,148 @@
+import { FetchMock } from 'vitest-fetch-mock';
+import { Mock } from 'vitest';
+import { Client, Server } from 'mock-socket';
+import { ISharedMovieInfo, OkUserId } from '../../CallsSDK';
+import Api from '../../default/Api';
+import CallDirection from '../../enums/CallDirection';
+import ConversationOption from '../../enums/ConversationOption';
+import TransportState from '../../enums/TransportState';
+import TransportTopology from '../../enums/TransportTopology';
+import { ParticipantStatus } from '../../static/External';
+import { ExternalParticipantId } from '../../types/ExternalId';
+import { ParticipantListMarkers } from '../../types/Participant';
+import SignalingMessage from '../../types/SignalingMessage';
+import Conversation from './Conversation';
+declare function createParams(): {
+    apiKey: string;
+    apiEnv: string;
+    onLocalStream: Mock<import("@vitest/spy").Procedure>;
+    onLocalStatus: Mock<import("@vitest/spy").Procedure>;
+    onConversation: Mock<import("@vitest/spy").Procedure>;
+    onLocalSharedMovieInfo: Mock<import("@vitest/spy").Procedure>;
+    onRemoteSharedMovieInfo: Mock<import("@vitest/spy").Procedure>;
+    onRemoteSharedUrl: Mock<import("@vitest/spy").Procedure>;
+    onCallState: Mock<import("@vitest/spy").Procedure>;
+    onOptionsChanged: Mock<import("@vitest/spy").Procedure>;
+    onPinnedParticipant: Mock<import("@vitest/spy").Procedure>;
+    onRemoteMediaSettings: Mock<import("@vitest/spy").Procedure>;
+    onRemoteParticipantState: Mock<import("@vitest/spy").Procedure>;
+    onLocalPin: Mock<import("@vitest/spy").Procedure>;
+    onDebugMessage: Mock<import("@vitest/spy").Procedure>;
+    onHangup: Mock<import("@vitest/spy").Procedure>;
+    onRemoteRemoved: Mock<import("@vitest/spy").Procedure>;
+    onConversationParticipantListChunk: Mock<import("@vitest/spy").Procedure>;
+    onRoomParticipantsUpdated: Mock<import("@vitest/spy").Procedure>;
+    onChatRoomUpdated: Mock<import("@vitest/spy").Procedure>;
+    onRemoteStatus: Mock<import("@vitest/spy").Procedure>;
+    onSpeakerChanged: Mock<import("@vitest/spy").Procedure>;
+};
+export type ConversationTestParams = ReturnType<typeof createParams>;
+export type ConversationTestTools = {
+    readonly endpointURL: string;
+    readonly fetchMocker: FetchMock;
+    readonly params: ConversationTestParams;
+    readonly server: Server;
+    readonly wsBaseURL: string;
+    createConnectionMessage(data?: Partial<SignalingMessage.Connection>): SignalingMessage.Connection;
+    createConversation(options?: {
+        api?: Api;
+    }): Conversation;
+    createExternalIdMock(id: string, data?: Partial<ExternalParticipantId>): ExternalParticipantId;
+    createMarkers(data?: Partial<ParticipantListMarkers>): ParticipantListMarkers;
+    createMovieShareInfo(initiatorId: string, data?: Partial<ISharedMovieInfo> | null): ISharedMovieInfo;
+    createParticipant(id: number, data?: Partial<SignalingMessage.Participant>): SignalingMessage.Participant & Required<Pick<SignalingMessage.Participant, 'markers'>>;
+    createParticipantWithMarkers(id: number, data?: Partial<SignalingMessage.Participant>): SignalingMessage.Participant & Required<Pick<SignalingMessage.Participant, 'markers'>>;
+    createPromoteParticipantMessage(): SignalingMessage.PromoteParticipant;
+    createSignallingConversation(okUserId: OkUserId, peerId: SignalingMessage.PeerId, data?: Partial<SignalingMessage.Conversation>): SignalingMessage.Conversation;
+    createWaitingHallConversationData(): ReturnType<typeof createWaitingHallConversationData>;
+    emitMessageOnConnection(wsServer: Server, message?: SignalingMessage.Connection): void;
+    enableParticipantListChunk(): void;
+    expectRemoteStatus(status: ParticipantStatus, participantId?: string): Promise<void>;
+    expectRemoteStatusCall(status: ParticipantStatus, participantId?: string): void;
+    forgetConversation(conversation: Conversation): void;
+    getActiveSocket(wsServer: Server): Client;
+    hasRemoteStatusCall(status: ParticipantStatus, participantId?: string): boolean;
+    isCapabilityEnabled(predicateIndex: number, wsServer: Server): boolean;
+    parseUrlSearch(search: string): Record<string, string>;
+    resetRemoteStatusCallbacks(): void;
+    respondOnGetParticipantListChunkWith(data: Partial<SignalingMessage.ParticipantListChunk>): void;
+    sendAcceptedCall(participant: SignalingMessage.Participant): void;
+    sendHungup(participant: SignalingMessage.Participant): void;
+    sendSessionState(participant: SignalingMessage.Participant | number, connected: boolean, data?: Partial<SignalingMessage.SessionState>): void;
+    setApiAuth(data?: {
+        sessionKey?: string;
+        sessionSecretKey?: string;
+    }): void;
+    setTransportState(conversation: Conversation, state: TransportState): void;
+    socketRespondWith(socket: Client, command: string, response: SignalingMessage): void;
+    socketSendNotification(socket: Client, notification: string, response?: SignalingMessage): void;
+    startConversation(message?: SignalingMessage.Connection): Promise<Conversation>;
+    startConversationWithParticipants(participants: SignalingMessage.Participant[], peerId?: SignalingMessage.PeerId): Promise<Conversation>;
+    startConversationWithRemoteParticipant(remoteParticipantData?: Partial<SignalingMessage.Participant>): Promise<{
+        conversation: Conversation;
+        meParticipant: SignalingMessage.Participant;
+        remoteParticipant: SignalingMessage.Participant;
+    }>;
+    stubApiRequest(endpoint: string, method: string, data: object): void;
+    waitFor(fn: () => Promise<boolean> | boolean, message?: string, timeout?: number): Promise<true>;
+    flushSdkCallbacks(): Promise<null>;
+};
+export declare function defineConversationTests(name: string, defineTests: (tools: ConversationTestTools) => void): void;
+export declare function createExternalIdMock(id: string, data?: Partial<ExternalParticipantId>): ExternalParticipantId;
+export declare function enableParticipantListChunk(): void;
+export declare function setApiAuth(data?: {
+    sessionKey?: string;
+    sessionSecretKey?: string;
+}): void;
+export declare function setTransportState(conversation: Conversation, state: TransportState): void;
+export declare function socketRespondWith(socket: Client, command: string, response: SignalingMessage): void;
+export declare function socketSendNotification(socket: Client, notification: string, response?: SignalingMessage): void;
+export declare function createWaitingHallConversationData(): {
+    acceptTime: null;
+    asrInfo: null;
+    asrInfoByRoom: Map<any, any>;
+    audienceMode: boolean;
+    chatId: null;
+    compositeUserId: string;
+    concurrent: boolean;
+    direction: CallDirection;
+    externalId: ExternalParticipantId;
+    features: never[];
+    featuresPerRole: null;
+    id: string;
+    mediaModifiers: {
+        denoise: boolean;
+        denoiseAnn: boolean;
+    };
+    muteStates: Map<any, any>;
+    muteStatesPersonal: {};
+    needRate: boolean;
+    networkRating: number;
+    observer: boolean;
+    options: ConversationOption[];
+    participantsLimit: number;
+    pinnedParticipantIdByRoom: Map<any, any>;
+    recordsInfoByRoom: Map<any, any>;
+    restricted: boolean;
+    roles: never[];
+    roomId: number | null;
+    topology: TransportTopology;
+    urlSharingInfoByRoom: Map<any, any>;
+    userId: number;
+    waitForAdmin: boolean;
+    waitingHall: boolean;
+};
+export declare function createPromoteParticipantMessage(): SignalingMessage.PromoteParticipant;
+export declare function emitMessageOnConnection(wsServer: Server, message?: SignalingMessage.Connection): void;
+export declare function getActiveSocket(wsServer: Server): Client;
+export declare function isCapabilityEnabled(predicateIndex: number, wsServer: Server): boolean;
+export declare function parseUrlSearch(search: string): Record<string, string>;
+export declare function flushSdkCallbacks(): Promise<null>;
+export declare function waitFor(fn: () => Promise<boolean> | boolean, message?: string, timeout?: number): Promise<true>;
+export declare function createSignallingConversation(okUserId: OkUserId, peerId: SignalingMessage.PeerId, data?: Partial<SignalingMessage.Conversation>): SignalingMessage.Conversation;
+export declare function createConnectionMessage(data?: Partial<SignalingMessage.Connection>): SignalingMessage.Connection;
+export declare function createParticipant(id: number, data?: Partial<SignalingMessage.Participant>): SignalingMessage.Participant & Required<Pick<SignalingMessage.Participant, 'markers'>>;
+export declare function createParticipantWithMarkers(id: number, data?: Partial<SignalingMessage.Participant>): SignalingMessage.Participant & Required<Pick<SignalingMessage.Participant, 'markers'>>;
+export declare function createMarkers(data?: Partial<ParticipantListMarkers>): ParticipantListMarkers;
+export declare function createMovieShareInfo(initiatorId: string, data?: Partial<ISharedMovieInfo> | null): ISharedMovieInfo;
+export {};

package/classes/{ConversationResponseValidator.d.ts → conversation/ConversationResponseValidator.d.ts}

@@ -1,3 +1,3 @@
-import ConversationResponse from '../types/ConversationResponse';
+import ConversationResponse from '../../types/ConversationResponse';
 export type ConversationResponseSource = 'startConversation' | 'joinConversation' | 'joinConversationByLink' | 'fastStart' | 'fastJoin';
 export declare function assertValidConversationResponse(response: ConversationResponse | null | undefined, source: ConversationResponseSource): void;

package/classes/{DisplayLayoutRequester.d.ts → conversation/DisplayLayoutRequester.d.ts}

@@ -1,11 +1,11 @@
-import BaseApi from '../abstract/BaseApi';
-import type { DebugLogger } from '../static/Debug';
-import { DisplayLayoutRequest, ParticipantLayout } from '../types/ParticipantLayout';
-import { Participant, ParticipantId } from '../types/Participant';
+import BaseApi from '../../abstract/BaseApi';
+import type { DebugLogger } from '../../static/Debug';
+import { DisplayLayoutRequest, ParticipantLayout } from '../../types/ParticipantLayout';
+import { Participant, ParticipantId } from '../../types/Participant';
 type DisplayLayoutRequesterParams = {
     api: BaseApi;
     debug: DebugLogger;
-    getParticipants: () => Promise<Record<ParticipantId, Participant>>;
+    getParticipants: () => Record<ParticipantId, Participant>;
     isMe: (participantId: ParticipantId) => boolean;
     updateDisplayLayout: (layouts: ParticipantLayout[]) => Promise<void>;
 };

package/classes/conversation/index.d.ts

@@ -0,0 +1 @@
+export { default } from './Conversation';

package/default/Api.d.ts

@@ -11,7 +11,7 @@ export default class Api extends BaseApi {
     private _idCache;
     private _callUnsafe;
     protected _call(method: string, data?: any, noSession?: boolean, allowReauthorize?: boolean): Promise<any>;
-    userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
+    userId(participantId: ParticipantId): ExternalParticipantId;
     authorize(): Promise<void>;
     private _getAnonymLoginCacheKey;
     private _getCachedAnonymLogin;

package/default/Signaling.d.ts

@@ -35,13 +35,13 @@ export default class Signaling extends BaseSignaling {
     private datachannelCommandsQueue;
     private incomingCache;
     private responseHandlers;
+    private disposed;
     private connectionType;
     private conversationResolve;
     private conversationReject;
     private connected;
     private listenersReady;
     private peerId;
-    private conversationId;
     private connectionMessageWaitTimer;
     private participantIdRegistry;
     private producerNotificationDataChannel;
@@ -60,21 +60,16 @@ export default class Signaling extends BaseSignaling {
     setAbortSignal(signal: AbortSignal | undefined): void;
     setEndpoint(endpoint: string): void;
     setWebTransportEndpoint(endpoint: string | null): void;
-    setConversationId(conversationId: string): void;
     setParticipantIdRegistry(participantIdRegistry: ParticipantIdRegistry): void;
     setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
     setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
     useCommandDataChannel(status: boolean): void;
-    /**
-     * Free used resources
-     */
-    cleanup(): void;
     /**
      * Open a connection with a signaling server
      */
     connect(connectionType: SignalingConnectionType): Promise<SignalingMessage.Connection>;
     getNextCommandSequenceNumber(): number;
-    hangup(reason: string): Promise<SignalingMessage | void>;
+    hangup(reason: string): Promise<SignalingMessage>;
     sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
     requestTestMode(consumerCommand: string, producerCommand: string | null): Promise<SignalingMessage>;
     sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
@@ -138,10 +133,7 @@ export default class Signaling extends BaseSignaling {
     acceptPromotion(reject?: boolean): Promise<SignalingMessage>;
     feedback(key: string): Promise<SignalingMessage>;
     getHandQueue(): Promise<SignalingMessage>;
-    /**
-     * Close a connection with a signaling server
-     */
-    close(): void;
+    dispose(cause?: Error): void;
     /**
      * Этот метод нужен т.к. после получения сообщения "connected" устанавливается транспорт
      * и подписывается на сигналинг. Данные приходят очень быстро и транспорт пропускает
@@ -173,17 +165,20 @@ export default class Signaling extends BaseSignaling {
     private _onError;
     private _serializeErrorEvent;
     private _onClose;
-    private _closeSocket;
+    private _terminate;
+    private _fail;
     private _isRecordCommand;
     private _resolvePendingRecordCommands;
     private _handleCommandResponse;
     private _handleCommandsQueue;
     private _startResponseTimer;
+    private _resolveCommandWithoutResponse;
     private _serializeBinary;
     private _serializeJson;
     private _convertDisplayLayout;
     private _waitConnectionMessage;
     private _stopWaitConnectionMessage;
+    private _onTransportConnecting;
     private _onTransportFailed;
     private _onTransportReconnectScheduled;
     private _onTransportConnectionDead;

package/default/SignalingTransport.d.ts

@@ -16,7 +16,12 @@ export type SignalingTransportReconnectEvent = {
     count: number;
     delay: number;
 };
+export type SignalingTransportConnectingEvent = {
+    connectionType: SignalingConnectionType;
+    source: SignalingTransportType;
+};
 export type SignalingTransportHandlers = {
+    onConnecting: (event: SignalingTransportConnectingEvent) => void;
     onOpen: () => void;
     onMessage: (event: MessageEvent) => void;
     onError: (event: Event) => void;
@@ -52,7 +57,7 @@ export default class SignalingTransport {
     resetReconnectCount(): void;
     connect(connectionType: SignalingConnectionType): void;
     close(code?: number): void;
-    send(data: string | ArrayBuffer): void;
+    send(data: string | ArrayBuffer): Promise<void>;
     private _connect;
     private _connectWebTransport;
     private _connectWebSocket;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.12-beta.7",
+  "version": "2.8.12-beta.9",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",