@vkontakte/calls-sdk 2.8.12-dev.73c9f7fe.0 → 2.8.12-dev.7afbc576.0

package/CallsSDK.d.ts

@@ -68,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';
 /**
@@ -271,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>;
 /**
  * Принять входящий звонок
@@ -281,13 +291,13 @@ export declare function acceptCall(mediaOptions?: MediaOption[], conversationId?
 /**
  * Отклонить входящий звонок
  *
- * @param conversationId ID звонка
- * @param params.reason Причина завершения для проброса в сигналинг
- * (по умолчанию `REJECTED`). См. {@link ClientHangupReason}.
+ * @param params Параметры завершения. `params.conversationId` — ID звонка
+ * (по умолчанию текущий активный), `params.reason` — причина завершения
+ * для проброса в сигналинг (по умолчанию `REJECTED`). См. {@link ClientHangupReason}.
+ * `params.onFastHangup` — опционально: вместо Calls API hangup при отклонении.
+ * На закрытии вкладки не используется. См. {@link HangupParams}.
  */
-export declare function declineCall(conversationId?: string, params?: {
-    reason?: ClientHangupReason;
-}): Promise<void>;
+export declare function declineCall(params?: HangupParams): Promise<void>;
 /**
  * Присоединиться к активному звонку
  *
@@ -310,13 +320,15 @@ export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOpt
 /**
  * Завершить текущий разговор
  *
- * @param conversationId ID звонка
- * @param params.reason Причина завершения для проброса в сигналинг.
- * По умолчанию `HUNGUP` (если звонок активен) или `CANCELED`. См. {@link ClientHangupReason}.
+ * @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, params?: {
-    reason?: ClientHangupReason;
-}): Promise<void>;
+export declare function hangup(params?: HangupParams): Promise<void>;
 /**
  * Добавить собеседника в звонок
  *
@@ -801,5 +813,5 @@ export declare function getSyncedTime(): number;
  * Версия SDK
  */
 export declare function version(): string;
-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 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

@@ -12,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;
@@ -69,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;