@vkontakte/videoplayer-statistics 1.0.100-dev.04f0bb5f.0 → 1.0.100-dev.319d6ebf.0

package/types/thinOneStat/ThinOneStat.d.ts

@@ -1,351 +1,351 @@
-import type { ISubscription, IValueObservable, Milliseconds } from '@vkontakte/videoplayer-shared';
-import { ValueSubject } from '@vkontakte/videoplayer-shared';
-import type { IPlayer } from '@vkontakte/videoplayer-core';
-import type { IOptionalConfig } from './config';
-import { Mode, Quality, ActionSeekType, AutoQuality, Visibility, ConnectionType, ContentType } from './values';
-import type { IAdsEvents, IUIEvents } from './events';
+import type { ISubscription, IValueObservable, Milliseconds } from "@vkontakte/videoplayer-shared";
+import { ValueSubject } from "@vkontakte/videoplayer-shared";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
+import type { IOptionalConfig } from "./config";
+import type { Mode, Quality, Visibility, ConnectionType, ContentType } from "./values";
+import { ActionSeekType, AutoQuality } from "./values";
+import type { IAdsEvents, IUIEvents } from "./events";
 export interface IThinOneStat {
-    vsid$: IValueObservable<string | undefined>;
-    isid$: IValueObservable<string | undefined>;
-    /**
-     * Лучше авторизоваться сразу, чтобы избежать ситуации:
-     * 1. Накапливаем запросы в очереди через debounce send
-     * 2. Пользователь закрывает приложение
-     * 3. Запрос пытается уйти через sendBeacon и падает без авторизации
-     */
-    authorize(authToken?: string): Promise<unknown>;
-    /**
-     * Обновляет общие параметры событий
-     */
-    updateContext(context: Partial<IStatContext>): void;
-    /**
-     * Привязываемся к событиям и разным изменениям состояний плеера
-     */
-    attachTo(player: IPlayer, adsEvents: IAdsEvents): ISubscription;
-    attachToUi(uiEvents: IUIEvents): ISubscription;
-    attachToAds(adsEvents: IAdsEvents): ISubscription;
-    /**
-     * Идентификатор текущего устройства
-     */
-    getDeviceId(): string;
-    getTotalViewTime(): Milliseconds;
-    /**
-     * Деструктор класса
-     */
-    destroy(): void;
+	vsid$: IValueObservable<string | undefined>;
+	isid$: IValueObservable<string | undefined>;
+	/**
+	* Лучше авторизоваться сразу, чтобы избежать ситуации:
+	* 1. Накапливаем запросы в очереди через debounce send
+	* 2. Пользователь закрывает приложение
+	* 3. Запрос пытается уйти через sendBeacon и падает без авторизации
+	*/
+	authorize(authToken?: string): Promise<unknown>;
+	/**
+	* Обновляет общие параметры событий
+	*/
+	updateContext(context: Partial<IStatContext>): void;
+	/**
+	* Привязываемся к событиям и разным изменениям состояний плеера
+	*/
+	attachTo(player: IPlayer, adsEvents: IAdsEvents): ISubscription;
+	attachToUi(uiEvents: IUIEvents): ISubscription;
+	attachToAds(adsEvents: IAdsEvents): ISubscription;
+	/**
+	* Идентификатор текущего устройства
+	*/
+	getDeviceId(): string;
+	getTotalViewTime(): Milliseconds;
+	/**
+	* Деструктор класса
+	*/
+	destroy(): void;
 }
 export interface IStatContext {
-    movieId?: number;
-    deviceId?: string;
-    preload?: boolean;
-    targetDuration?: Milliseconds;
-    inHistory?: boolean;
-    recomInfo?: Record<string, unknown>;
-    product?: string;
-    navigation?: Record<string, unknown>;
-    application?: string;
-    platform?: string;
-    os?: string;
-    osVersion?: string;
-    browser?: string;
-    browserVersion?: string;
-    deviceType?: string;
-    deviceManufacturer?: string;
-    deviceModel?: string;
-    isMobile?: boolean;
-    networkType?: string;
-    dpi?: number;
-    playerSize?: {
-        width: number;
-        height: number;
-    };
-    /**
-     * Плеер в режиме превью.
-     */
-    isPreviewPlayerView?: boolean;
+	movieId?: number;
+	deviceId?: string;
+	preload?: boolean;
+	targetDuration?: Milliseconds;
+	inHistory?: boolean;
+	recomInfo?: Record<string, unknown>;
+	product?: string;
+	navigation?: Record<string, unknown>;
+	application?: string;
+	platform?: string;
+	os?: string;
+	osVersion?: string;
+	browser?: string;
+	browserVersion?: string;
+	deviceType?: string;
+	deviceManufacturer?: string;
+	deviceModel?: string;
+	isMobile?: boolean;
+	networkType?: string;
+	dpi?: number;
+	playerSize?: {
+		width: number;
+		height: number;
+	};
+	/**
+	* Плеер в режиме превью.
+	*/
+	isPreviewPlayerView?: boolean;
 }
 export interface IConstructorParams {
-    config: IOptionalConfig;
-    userSalt?: string;
-    refreshAuthToken?: () => Promise<string | undefined>;
-    isid?: string;
-    useIsid?: boolean;
+	config: IOptionalConfig;
+	userSalt?: string;
+	refreshAuthToken?: () => Promise<string | undefined>;
+	isid?: string;
+	useIsid?: boolean;
 }
 export interface IWatchCoveragePayload {
-    watch_interval: string;
-    in_history: boolean;
-    content_type?: ContentType;
-    playback_quality?: string;
-    recom_info?: Record<string, unknown>;
+	watch_interval: string;
+	in_history: boolean;
+	content_type?: ContentType;
+	playback_quality?: string;
+	recom_info?: Record<string, unknown>;
 }
 export interface IWatchCoverageLivePayload extends IWatchCoveragePayload {
-    live: boolean;
+	live: boolean;
 }
 export interface IWatchedNPayload {
-    target_duration: Milliseconds;
-    current_tvt: Milliseconds;
+	target_duration: Milliseconds;
+	current_tvt: Milliseconds;
 }
 export interface IStartSessionPayload {
-    isid?: string;
-    stream_profile?: 'live' | 'vod';
-    dpi: number;
-    web_layout: 'desktop' | 'mobile';
-    iframe_host?: string | 'unknown' | null;
-    from_downloads?: boolean;
-    preloaded?: boolean;
-    navigation?: Record<string, unknown>;
-    recom_info?: Record<string, unknown>;
+	isid?: string;
+	stream_profile?: "live" | "vod";
+	dpi: number;
+	web_layout: "desktop" | "mobile";
+	iframe_host?: string | "unknown" | null;
+	from_downloads?: boolean;
+	preloaded?: boolean;
+	navigation?: Record<string, unknown>;
+	recom_info?: Record<string, unknown>;
 }
 export interface IPreloadStartedPayload {
-    target_buffer_time?: Milliseconds;
-    playback_url?: string;
-    playback_quality?: Quality;
+	target_buffer_time?: Milliseconds;
+	playback_url?: string;
+	playback_quality?: Quality;
 }
 export interface IPreloadEndedPayload {
-    buffer_time?: Milliseconds;
+	buffer_time?: Milliseconds;
 }
 export interface IPlaybackStartedPayload {
-    playback_quality?: Quality;
-    user_quality?: Quality | AutoQuality;
-    player_width?: number;
-    player_height?: number;
-    muted?: boolean;
-    sound_volume?: number;
-    buffer_time?: Milliseconds;
-    mode?: Mode;
-    visibility?: Visibility;
-    subtitles_enabled?: boolean;
-    auto_subtitles?: boolean;
-    audio_track_lang?: string;
-    playback_rate?: number;
-    recom_info?: Record<string, unknown>;
+	playback_quality?: Quality;
+	user_quality?: Quality | AutoQuality;
+	player_width?: number;
+	player_height?: number;
+	muted?: boolean;
+	sound_volume?: number;
+	buffer_time?: Milliseconds;
+	mode?: Mode;
+	visibility?: Visibility;
+	subtitles_enabled?: boolean;
+	auto_subtitles?: boolean;
+	audio_track_lang?: string;
+	playback_rate?: number;
+	recom_info?: Record<string, unknown>;
 }
 export interface IManifestRequestPayload {
-    playback_url?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
+	playback_url?: string;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
 }
 export interface IFirstByteManifestPayload {
-    playback_url?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
+	playback_url?: string;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
 }
 export interface IFirstMediaRequestPayload {
-    playback_url?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
+	playback_url?: string;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
 }
 export interface IFirstByteMediaPayload {
-    playback_url?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
+	playback_url?: string;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
 }
 export interface IManifestReceivedPayload {
-    playback_url?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
+	playback_url?: string;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
 }
 export interface IConnectionEstablishedPayload {
-    playback_url?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
-    rtt?: Milliseconds;
-    network_type?: string;
-    dns_resolve_time?: number;
-    tcp_handshake_time?: number;
-    tls_handshake_time?: number;
+	playback_url?: string;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
+	rtt?: Milliseconds;
+	network_type?: string;
+	dns_resolve_time?: number;
+	tcp_handshake_time?: number;
+	tls_handshake_time?: number;
 }
 export interface IReadyPayload {
-    buffer_time?: Milliseconds;
+	buffer_time?: Milliseconds;
 }
 export interface IPlayingPayload {
-    buffer_time?: Milliseconds;
+	buffer_time?: Milliseconds;
 }
 export interface ISeekingPayload {
-    seek_type?: ActionSeekType;
+	seek_type?: ActionSeekType;
 }
 export interface ISeekedPayload {
-    seek_type?: ActionSeekType;
+	seek_type?: ActionSeekType;
 }
 export interface IBufferStarvationPayload {
-    buffer_time?: Milliseconds;
+	buffer_time?: Milliseconds;
 }
 export interface IQualityChangeRequestedPayload {
-    user_quality?: Quality | AutoQuality;
-    playback_quality?: Quality;
-    download_quality?: Quality;
-    codec_info?: string;
+	user_quality?: Quality | AutoQuality;
+	playback_quality?: Quality;
+	download_quality?: Quality;
+	codec_info?: string;
 }
 export interface IQualityChangedPayload {
-    user_quality?: Quality | AutoQuality;
-    playback_quality?: Quality;
-    download_quality?: Quality;
-    codec_info?: string;
+	user_quality?: Quality | AutoQuality;
+	playback_quality?: Quality;
+	download_quality?: Quality;
+	codec_info?: string;
 }
 export interface ICdnHostChangedPayload {
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
-    content_type?: ContentType;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
+	content_type?: ContentType;
 }
 export interface IViewPortChangedPayload {
-    player_width?: number;
-    player_height?: number;
+	player_width?: number;
+	player_height?: number;
 }
 export interface IModeChangedPayload {
-    mode?: Mode;
+	mode?: Mode;
 }
 export interface IVisibilityChangedPayload {
-    visibility?: Visibility;
+	visibility?: Visibility;
 }
 export interface IAudioTrackSwitchedPayload {
-    audio_track_lang?: string;
-    codec_info?: string;
+	audio_track_lang?: string;
+	codec_info?: string;
 }
 export interface IVideoTrackSwitchedPayload {
-    hdr?: boolean;
-    codec_info?: string;
+	hdr?: boolean;
+	codec_info?: string;
 }
 export interface ISubtitlesSwitchedPayload {
-    subtitles_enabled?: boolean;
-    subtitles_track_lang?: string;
-    auto_subtitles?: boolean;
+	subtitles_enabled?: boolean;
+	subtitles_track_lang?: string;
+	auto_subtitles?: boolean;
 }
 export interface ISoundChangedPayload {
-    muted?: boolean;
-    sound_volume?: number;
+	muted?: boolean;
+	sound_volume?: number;
 }
 export interface IFailoverPayload {
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
-    content_type?: ContentType;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
+	content_type?: ContentType;
 }
 export interface IContentTypeChangePayload {
-    content_type?: ContentType;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: boolean;
+	content_type?: ContentType;
+	cdn_host?: string;
+	connection_type?: ConnectionType;
+	connection_reused?: boolean;
 }
 export interface IErrorPayload {
-    error_severity?: 'informative' | 'critical';
-    error_category?: 'network' | 'video_pipeline' | 'external_api' | 'parser' | 'dom' | 'wtf' | // контентные
-    'sdk_init' | 'playback' | 'timeout' | 'other';
-    player_error_code?: string;
-    player_error_trace?: string;
-    http_error_code?: number;
-    uv_backend_error_code_subcode?: string;
-    error_message?: string;
+	error_severity?: "informative" | "critical";
+	error_category?: "network" | "video_pipeline" | "external_api" | "parser" | "dom" | "wtf" | "sdk_init" | "playback" | "timeout" | "other";
+	player_error_code?: string;
+	player_error_trace?: string;
+	http_error_code?: number;
+	uv_backend_error_code_subcode?: string;
+	error_message?: string;
 }
 export interface IDownloadBytes {
-    download_bytes?: number;
-    download_speed?: number;
+	download_bytes?: number;
+	download_speed?: number;
 }
 export interface IAdvConfigurationPayload {
-    slot?: number;
+	slot?: number;
 }
 export interface IAdvBreakStartedPayload {
-    adv_section?: string;
+	adv_section?: string;
 }
 export interface IAdvBreakEndedPayload {
-    adv_section?: string;
+	adv_section?: string;
 }
 export interface IAdvErrorPayload {
-    error_message?: string;
+	error_message?: string;
 }
 export declare class ThinOneStat implements IThinOneStat {
-    private api;
-    private logger;
-    private config;
-    private subscription;
-    private beforeunloadSubscription?;
-    private timeSynchronisation?;
-    private statContext;
-    private deviceId;
-    private targetDuration;
-    private debugLogger;
-    private thinOneStatDebugLog;
-    private eventNumber;
-    private isStarted?;
-    private wasPaused?;
-    private isLive?;
-    private position;
-    private cdnHostname?;
-    private isEmbed;
-    private embedHostname?;
-    private connectionType?;
-    private connectionReused?;
-    private player;
-    private playerSize;
-    private currentSubtitle?;
-    private uiEvents?;
-    private seekAction$;
-    get vsid$(): ValueSubject<string | undefined>;
-    isid$: ValueSubject<string | undefined>;
-    getTotalViewTime: () => Milliseconds;
-    constructor(statContext: IStatContext, params: IConstructorParams);
-    authorize(authToken?: string): Promise<unknown>;
-    updateContext(newContext: Partial<IStatContext>): void;
-    attachTo(player: IPlayer, adsEvents: IAdsEvents): ISubscription;
-    attachToUi(events: IUIEvents): ISubscription;
-    attachToAds(events: IAdsEvents): ISubscription;
-    getDeviceId(): string;
-    resetViewSession(): void;
-    destroy(): void;
-    private calcBufferTime;
-    private createRequiredParams;
-    private createRequiredFatParams;
-    private log;
-    private logWatchCoverage;
-    private logWatchCoverageLive;
-    private logWatchedN;
-    private logStartSession;
-    private logPreloadStarted;
-    private logPreloadEnded;
-    private logPreloadError;
-    private logPlaybackStarted;
-    private logPlay;
-    private logManifestRequest;
-    private logFirstByteManifest;
-    private logFirstMediaRequest;
-    private logFirstByteMedia;
-    private logManifestReceived;
-    private logConnectionEstablished;
-    private logFirstVideoFrameDecoded;
-    private logReady;
-    private logPlaying;
-    private logPause;
-    private logResume;
-    private logSeeking;
-    private logSeeked;
-    private logStop;
-    private logBufferStarvation;
-    private logShowLoader;
-    private logQualityChangeRequested;
-    private logQualityChanged;
-    private logCdnHostChanged;
-    private logViewPortChanged;
-    private logModeChanged;
-    private logVisibilityChanged;
-    private logAudioTrackSwitched;
-    private logVideoTrackSwitched;
-    private logSubtitlesSwitched;
-    private logSoundChanged;
-    private logFailover;
-    private logContentTypeChange;
-    private logError;
-    private logCannotPlay;
-    private logDownloadBytes;
-    private logAdvConfiguration;
-    private logAdvRequest;
-    private logAdvBreakStarted;
-    private logAdvBreakEnded;
-    private logAdvError;
-    private resubscribeBeforeunload;
+	private api;
+	private logger;
+	private config;
+	private subscription;
+	private beforeunloadSubscription?;
+	private timeSynchronisation?;
+	private statContext;
+	private deviceId;
+	private targetDuration;
+	private debugLogger;
+	private thinOneStatDebugLog;
+	private eventNumber;
+	private isStarted?;
+	private wasPaused?;
+	private isLive?;
+	private position;
+	private cdnHostname?;
+	private isEmbed;
+	private embedHostname?;
+	private connectionType?;
+	private connectionReused?;
+	private player;
+	private playerSize;
+	private currentSubtitle?;
+	private uiEvents?;
+	private seekAction$;
+	get vsid$(): ValueSubject<string | undefined>;
+	isid$: ValueSubject<string | undefined>;
+	getTotalViewTime: () => Milliseconds;
+	constructor(statContext: IStatContext, params: IConstructorParams);
+	authorize(authToken?: string): Promise<unknown>;
+	updateContext(newContext: Partial<IStatContext>): void;
+	attachTo(player: IPlayer, adsEvents: IAdsEvents): ISubscription;
+	attachToUi(events: IUIEvents): ISubscription;
+	attachToAds(events: IAdsEvents): ISubscription;
+	getDeviceId(): string;
+	resetViewSession(): void;
+	destroy(): void;
+	private calcBufferTime;
+	private createRequiredParams;
+	private createRequiredFatParams;
+	private log;
+	private logWatchCoverage;
+	private logWatchCoverageLive;
+	private logWatchedN;
+	private logStartSession;
+	private logPreloadStarted;
+	private logPreloadEnded;
+	private logPreloadError;
+	private logPlaybackStarted;
+	private logPlay;
+	private logManifestRequest;
+	private logFirstByteManifest;
+	private logFirstMediaRequest;
+	private logFirstByteMedia;
+	private logManifestReceived;
+	private logConnectionEstablished;
+	private logFirstVideoFrameDecoded;
+	private logReady;
+	private logPlaying;
+	private logPause;
+	private logResume;
+	private logSeeking;
+	private logSeeked;
+	private logStop;
+	private logBufferStarvation;
+	private logShowLoader;
+	private logQualityChangeRequested;
+	private logQualityChanged;
+	private logCdnHostChanged;
+	private logViewPortChanged;
+	private logModeChanged;
+	private logVisibilityChanged;
+	private logAudioTrackSwitched;
+	private logVideoTrackSwitched;
+	private logSubtitlesSwitched;
+	private logSoundChanged;
+	private logFailover;
+	private logContentTypeChange;
+	private logError;
+	private logCannotPlay;
+	private logDownloadBytes;
+	private logAdvConfiguration;
+	private logAdvRequest;
+	private logAdvBreakStarted;
+	private logAdvBreakEnded;
+	private logAdvError;
+	private resubscribeBeforeunload;
 }