@vkontakte/calls-sdk 2.8.13-dev.f163e503.0 → 2.8.13-dev.f6e48354.0

package/CallsSDK.d.ts

@@ -28,6 +28,7 @@ import RoomsEventType from './enums/RoomsEventType';
 import SignalingCommandType from './enums/SignalingCommandType';
 import SignalingConnectionType from './enums/SignalingConnectionType';
 import SignalingNotification from './enums/SignalingNotification';
+import Stat from './enums/Stat';
 import UserRole from './enums/UserRole';
 import UserType from './enums/UserType';
 import { DebugMessageType } from './static/Debug';
@@ -59,6 +60,7 @@ import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from './type
 import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
 import SignalingMessage, { GetRoomsSignalingResponse, GetParticipantsSignalingResponse } from './types/SignalingMessage';
 import { StatResult } from './types/Statistics';
+import { ClientStatsEvent } from './types/ClientStatsEvent';
 import { IStartStreamData, IStopStreamData, IPublishStreamData } from './types/Streams';
 import { WaitingHallResponse } from './types/WaitingHall';
 import { ArrayDequeue } from './utils/ArrayDequeue';
@@ -266,6 +268,11 @@ export declare function callInternal(ids: OkUserId[], type: CallType | undefined
 export declare function processPush(conversationId: string, conversationParams?: string): Promise<void>;
 export declare function processPushInternal(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number): Promise<void>;
 export declare function getInbounds(): Promise<PushData[]>;
+/**
+ * Запускает отправку клиентской статистики. Нужен только при
+ * `autoStartStats: false`; повторные вызовы ничего не делают.
+ */
+export declare function startStats(): void;
 /**
  * Авторизоваться для совершения звонков
  *
@@ -804,5 +811,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, 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, };
+export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, ClientHangupReason, ClientStatsEvent, 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, Stat, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, VolumeDetector, };

package/abstract/BaseApi.d.ts

@@ -7,18 +7,12 @@ import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
 import { OkUserId, ParticipantId } from '../types/Participant';
 import PushData from '../types/PushData';
+import { ApiCallStats } from '../classes/stat/ApiCallStats';
 export type ClientStats = {
     call_topology: 'D' | 'S';
     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;
@@ -33,6 +27,9 @@ export type LogItem = {
 };
 export default abstract class BaseApi {
     protected _abortSignal?: AbortSignal;
+    protected _apiCallStats: ApiCallStats | null;
+    /** Куда писать время выполнения запросов, появляется вместе со звонком */
+    setApiCallStats(apiCallStats: ApiCallStats | null): void;
     /**
      * Устанавливает сигнал прерывания для запуска звонка, если не успели отменить до установки соединения с другим участником, то он больше ни как не будет использоваться
      * @param signal - Сигнал прерывания или undefined для очистки
@@ -69,8 +66,15 @@ export default abstract class BaseApi {
     log(items: LogItem[]): void;
     /**
      * method: vchat.clientStats
+     *
+     * Резолвится только после подтверждённой сервером отправки.
+     */
+    logClientStats(items: ClientStats[]): Promise<void>;
+    /**
+     * method: vchat.clientStats под сохранённым session_key другого
+     * пользователя. Одна попытка, без перелогина; AuthData не трогает.
      */
-    logClientStats(items: ClientStats[]): void;
+    logClientStatsWith(sessionKey: string, items: ClientStats[]): Promise<void>;
     abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
     getCachedParticipantIdByExternalId(externalId: ExternalId): ParticipantId | null;
     getCachedExternalIdByParticipantId(participantId: ParticipantId): ExternalParticipantId | null;