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

package/types/oneStat/OneStat.d.ts

@@ -1,335 +1,337 @@
-import type { IOptionalConfig } from './config';
-import { type IPlayer } from '@vkontakte/videoplayer-core';
-import { IError, IObservable, ISubscription, IValueObservable, Kbps, Milliseconds, Seconds, ValueSubject } from '@vkontakte/videoplayer-shared';
-import { ILogCustomData } from './types';
-import { IAdsEvents, IInteractiveEvents, IUIEvents } from './uiEvents';
-import { ApiEnv, ConnectionType, ContentType, Mode, Network, Quality, SeekAction } from './values';
+import type { IOptionalConfig } from "./config";
+import { type IPlayer } from "@vkontakte/videoplayer-core";
+import type { IError, IObservable, ISubscription, IValueObservable, Kbps, Milliseconds, Seconds } from "@vkontakte/videoplayer-shared";
+import { ValueSubject } from "@vkontakte/videoplayer-shared";
+import type { ILogCustomData } from "./types";
+import type { IAdsEvents, IInteractiveEvents, IUIEvents } from "./uiEvents";
+import type { ApiEnv, ConnectionType, ContentType, Mode, Network, Quality } from "./values";
+import { SeekAction } from "./values";
 export interface IOneStat {
-    /**
-     * Лучше авторизоваться сразу, чтобы избежать ситуации:
-     * 1. Накапливаем запросы в очереди через debounce send
-     * 2. Пользователь закрывает приложение
-     * 3. Запрос пытается уйти через sendBeacon и падает без авторизации
-     */
-    authorize(authToken?: string): Promise<unknown>;
-    /**
-     * Обновляет общие параметры событий
-     */
-    updateContext(context: Partial<IStatContext>): void;
-    attachTo(player: IPlayer): ISubscription;
-    attachToUi(uiEvents: IUIEvents): ISubscription;
-    attachToAds(adsEvents: IAdsEvents): ISubscription;
-    attachToInteractive(interactiveEvents: IInteractiveEvents): ISubscription;
-    /**
-     * Ставит отправку событий на паузу. Они будут накапливаться до вызова `resume()`
-     */
-    pause(): void;
-    /**
-     * Снимает паузу отправки событий
-     */
-    resume(): void;
-    /**
-     * Деструктор класса
-     */
-    destroy(): void;
-    /**
-     * Сбрасывает сессию смотрения
-     */
-    resetViewSession(): void;
-    /**
-     * Идентификатор текущего устройства
-     */
-    getDeviceId(): string;
-    /**
-     * @deprecated
-     * Отключает отправку полей событий
-     */
-    setFieldBlacklist(fields: (keyof ILogCustomData)[]): void;
-    /**
-     * @deprecated
-     */
-    logInited(): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Плеер готов начать воспроизведение
-     */
-    logReady(payload: IReadyPayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Первый старт видео. Отправляется 1 раз, когда фактически началось воспроизведение ролика, а также после зацикливания, но не после паузы.
-     *
-     * В документации API может называться `play`
-     */
-    logStarted(payload: IActionPlayPayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     *  Возобновление после паузы
-     *
-     *  В документации API может называться `play_toggle`
-     */
-    logPlay(): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     *  Постановка видео на паузу
-     */
-    logPause(payload: IPausePayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * перемотка видео
-     */
-    logSeek(payload: ISeekPayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Промежутки видео, которые были просмотрены пользователем.
-     * Время указывается в секундах от начала ролика (т.е. является позицией).
-     */
-    logWatchCoverageRecord(payload: IWatchCoveragePayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Промежутки видео, которые были просмотрены пользователем.
-     * Время указывается в виде UTC timestamp'ов.
-     */
-    logWatchCoverageLive(payload: IWatchCoveragePayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Буфер пуст и пользователь видит залипший кадр.
-     */
-    logEmptyBuffer(payload: IEmptyBufferPayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Получен первый кусок данных контента от сервера раздачи видео
-     */
-    logFirstBytes(payload: IFirstBytesPayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * Пользователь увидел первый кадр
-     */
-    logFirstFrame(payload: IFirstFramePayload): void;
-    /**
-     * @deprecated публично нужно использовать attachTo
-     * @param payload
-     */
-    logDownloadSpeed(payload: IDownloadSpeedPayload): void;
-    /**
-     * произошла ошибка
-     */
-    logError(payload: IErrorPayload): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     */
-    logAdSlotRequest(): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     * @param sectionType
-     */
-    logAdStarted(sectionType: string): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     */
-    logAdPaused(): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     */
-    logAdResumed(): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     */
-    logAdEnded(): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     */
-    logAdSkipped(): void;
-    /**
-     * @deprecated публично нужно использовать attachToAds
-     */
-    logAdClicked(): void;
-    experimental: {
-        error$: IObservable<IError>;
-    };
-    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): ISubscription;
+	attachToUi(uiEvents: IUIEvents): ISubscription;
+	attachToAds(adsEvents: IAdsEvents): ISubscription;
+	attachToInteractive(interactiveEvents: IInteractiveEvents): ISubscription;
+	/**
+	* Ставит отправку событий на паузу. Они будут накапливаться до вызова `resume()`
+	*/
+	pause(): void;
+	/**
+	* Снимает паузу отправки событий
+	*/
+	resume(): void;
+	/**
+	* Деструктор класса
+	*/
+	destroy(): void;
+	/**
+	* Сбрасывает сессию смотрения
+	*/
+	resetViewSession(): void;
+	/**
+	* Идентификатор текущего устройства
+	*/
+	getDeviceId(): string;
+	/**
+	* @deprecated
+	* Отключает отправку полей событий
+	*/
+	setFieldBlacklist(fields: (keyof ILogCustomData)[]): void;
+	/**
+	* @deprecated
+	*/
+	logInited(): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Плеер готов начать воспроизведение
+	*/
+	logReady(payload: IReadyPayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Первый старт видео. Отправляется 1 раз, когда фактически началось воспроизведение ролика, а также после зацикливания, но не после паузы.
+	*
+	* В документации API может называться `play`
+	*/
+	logStarted(payload: IActionPlayPayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	*  Возобновление после паузы
+	*
+	*  В документации API может называться `play_toggle`
+	*/
+	logPlay(): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	*  Постановка видео на паузу
+	*/
+	logPause(payload: IPausePayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* перемотка видео
+	*/
+	logSeek(payload: ISeekPayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Промежутки видео, которые были просмотрены пользователем.
+	* Время указывается в секундах от начала ролика (т.е. является позицией).
+	*/
+	logWatchCoverageRecord(payload: IWatchCoveragePayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Промежутки видео, которые были просмотрены пользователем.
+	* Время указывается в виде UTC timestamp'ов.
+	*/
+	logWatchCoverageLive(payload: IWatchCoveragePayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Буфер пуст и пользователь видит залипший кадр.
+	*/
+	logEmptyBuffer(payload: IEmptyBufferPayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Получен первый кусок данных контента от сервера раздачи видео
+	*/
+	logFirstBytes(payload: IFirstBytesPayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* Пользователь увидел первый кадр
+	*/
+	logFirstFrame(payload: IFirstFramePayload): void;
+	/**
+	* @deprecated публично нужно использовать attachTo
+	* @param payload
+	*/
+	logDownloadSpeed(payload: IDownloadSpeedPayload): void;
+	/**
+	* произошла ошибка
+	*/
+	logError(payload: IErrorPayload): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	*/
+	logAdSlotRequest(): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	* @param sectionType
+	*/
+	logAdStarted(sectionType: string): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	*/
+	logAdPaused(): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	*/
+	logAdResumed(): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	*/
+	logAdEnded(): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	*/
+	logAdSkipped(): void;
+	/**
+	* @deprecated публично нужно использовать attachToAds
+	*/
+	logAdClicked(): void;
+	experimental: {
+		error$: IObservable<IError>;
+	};
+	vsid$: IValueObservable<string | undefined>;
+	isid$: IValueObservable<string | undefined>;
 }
 export interface IActionPlayPayload {
-    /**
-     * время в секундах от начала ролика
-     */
-    position: Seconds;
+	/**
+	* время в секундах от начала ролика
+	*/
+	position: Seconds;
 }
 export interface IPausePayload {
-    /**
-     * время в секундах: сколько просмотрено от начала ролика
-     */
-    position: Seconds;
+	/**
+	* время в секундах: сколько просмотрено от начала ролика
+	*/
+	position: Seconds;
 }
 export interface ISeekPayload {
-    /**
-     * Действие пользователя приведшее к перемотке
-     */
-    action: SeekAction;
-    time: Seconds;
+	/**
+	* Действие пользователя приведшее к перемотке
+	*/
+	action: SeekAction;
+	time: Seconds;
 }
 export interface IReadyPayload {
-    /**
-     * время в миллисекундах с события inited
-     */
-    time: Milliseconds;
+	/**
+	* время в миллисекундах с события inited
+	*/
+	time: Milliseconds;
 }
 export interface IFirstBytesPayload {
-    /**
-     * время в миллисекундах с события inited
-     */
-    time: Milliseconds;
+	/**
+	* время в миллисекундах с события inited
+	*/
+	time: Milliseconds;
 }
 export interface IFirstFramePayload {
-    /**
-     * время в миллисекундах с события inited
-     */
-    time: Milliseconds;
+	/**
+	* время в миллисекундах с события inited
+	*/
+	time: Milliseconds;
 }
 export interface IEmptyBufferPayload {
-    /**
-     * время в миллисекундах которое пользователь видел застывшую картинку
-     */
-    duration: Milliseconds;
+	/**
+	* время в миллисекундах которое пользователь видел застывшую картинку
+	*/
+	duration: Milliseconds;
 }
 export interface IDownloadSpeedPayload {
-    /**
-     * Скорость в килобайтах (!) в секунду
-     */
-    speed: number;
+	/**
+	* Скорость в килобайтах (!) в секунду
+	*/
+	speed: number;
 }
 export interface IErrorPayload {
-    /**
-     * строка из символов(без пробелов): тип ошибки
-     */
-    errorType: string;
-    fatal: boolean;
+	/**
+	* строка из символов(без пробелов): тип ошибки
+	*/
+	errorType: string;
+	fatal: boolean;
 }
 export interface IStatContext {
-    mobile: boolean;
-    movieId: number;
-    projectId?: number;
-    vkAppId?: string;
-    clip?: boolean;
-    liveEdge?: boolean;
-    autoplay: boolean;
-    audible?: boolean;
-    quality?: Quality;
-    autoQuality?: boolean;
-    contentType?: ContentType;
-    albumId?: string;
-    vkPlaylistId?: string;
-    trackCode?: string;
-    place?: string;
-    cdnHostname?: string;
-    downloadSpeed?: Kbps;
-    connectionType?: ConnectionType;
-    connectionReused?: boolean;
-    firstConnectionType?: ConnectionType;
-    firstConnectionReused?: boolean;
-    network?: Network;
-    cached?: boolean;
-    mode?: Mode;
-    subtitles?: string;
-    failover?: boolean;
-    rate?: number;
-    is3d?: boolean;
-    refDomain?: string;
-    inHistory?: boolean;
-    deviceId?: string;
-    /**
-     * Плеер в режиме превью.
-     */
-    isPreviewPlayerView?: boolean;
+	mobile: boolean;
+	movieId: number;
+	projectId?: number;
+	vkAppId?: string;
+	clip?: boolean;
+	liveEdge?: boolean;
+	autoplay: boolean;
+	audible?: boolean;
+	quality?: Quality;
+	autoQuality?: boolean;
+	contentType?: ContentType;
+	albumId?: string;
+	vkPlaylistId?: string;
+	trackCode?: string;
+	place?: string;
+	cdnHostname?: string;
+	downloadSpeed?: Kbps;
+	connectionType?: ConnectionType;
+	connectionReused?: boolean;
+	firstConnectionType?: ConnectionType;
+	firstConnectionReused?: boolean;
+	network?: Network;
+	cached?: boolean;
+	mode?: Mode;
+	subtitles?: string;
+	failover?: boolean;
+	rate?: number;
+	is3d?: boolean;
+	refDomain?: string;
+	inHistory?: boolean;
+	deviceId?: string;
+	/**
+	* Плеер в режиме превью.
+	*/
+	isPreviewPlayerView?: boolean;
 }
 export interface IConstructorParams {
-    /** @deprecated Используете config.apiEnv */
-    apiEnv?: ApiEnv;
-    config?: IOptionalConfig;
-    userSalt?: string;
-    isid?: string;
-    zenUid?: string;
-    useIsid?: boolean;
-    refreshAuthToken?: () => Promise<string | undefined>;
-    /** переданная версия приложения smart_tv */
-    vktvVersion?: string;
+	/** @deprecated Используете config.apiEnv */
+	apiEnv?: ApiEnv;
+	config?: IOptionalConfig;
+	userSalt?: string;
+	isid?: string;
+	zenUid?: string;
+	useIsid?: boolean;
+	refreshAuthToken?: () => Promise<string | undefined>;
+	/** переданная версия приложения smart_tv */
+	vktvVersion?: string;
 }
 export interface IWatchCoveragePayload {
-    start: number;
-    end: number;
-    latency?: number;
-    bufferLatency?: number;
+	start: number;
+	end: number;
+	latency?: number;
+	bufferLatency?: number;
 }
 export declare class OneStat implements IOneStat {
-    private api;
-    private logger;
-    private config;
-    private subscription;
-    private beforeunloadSubscription;
-    private timeSynchronisation?;
-    private debugLogger;
-    private oneStatDebugLog;
-    private loopCounter;
-    private disabled;
-    experimental: {
-        error$: IObservable<IError>;
-    };
-    get vsid$(): ValueSubject<string | undefined>;
-    isid$: ValueSubject<string | undefined>;
-    zenUid$: ValueSubject<string | undefined>;
-    private statContext;
-    private isEmbed;
-    private embedParent;
-    private uiEvents;
-    private player;
-    private seekAction$;
-    private deviceId;
-    constructor(statContext: IStatContext, params: IConstructorParams);
-    updateContext(newContext: Partial<IStatContext>): void;
-    attachTo(player: IPlayer): ISubscription;
-    attachToUi(events: IUIEvents): ISubscription;
-    attachToAds(adsEvents: IAdsEvents): ISubscription;
-    attachToInteractive(interactiveEvents: IInteractiveEvents): ISubscription;
-    authorize(authToken?: string): Promise<unknown>;
-    pause(): void;
-    resume(): void;
-    destroy(): void;
-    resetViewSession(): void;
-    getDeviceId(): string;
-    setFieldBlacklist(): void;
-    logInited(): void;
-    logReady(payload: IReadyPayload): void;
-    logStarted(...args: Parameters<typeof this.logActionPlay>): void;
-    logPlay(): void;
-    logPlaying(): void;
-    logPause(payload: IPausePayload): void;
-    logSeek(payload: ISeekPayload): void;
-    logFirstBytes(payload: IFirstBytesPayload): void;
-    logFirstFrame(payload: IFirstFramePayload): void;
-    logError(payload: IErrorPayload): void;
-    logWatchCoverageRecord(payload: IWatchCoveragePayload): void;
-    logWatchCoverageLive(payload: IWatchCoveragePayload): void;
-    logEmptyBuffer(payload: IEmptyBufferPayload): void;
-    logDownloadSpeed(): void;
-    logAdSlotRequest(): void;
-    logAdStarted(sectionType: string): void;
-    logAdPaused(): void;
-    logAdResumed(): void;
-    logAdEnded(): void;
-    logAdSkipped(): void;
-    logAdClicked(): void;
-    private logInterfaceClick;
-    private logNextMovie;
-    private subscribe;
-    private resubscribeBeforeunload;
-    private logPlayerReady;
-    private logActionPlay;
-    private logActionPlayInteractive;
-    private logFailover;
-    private logCloseAtEmptyBuffer;
-    private logActionStop;
-    private logTrackSwitch;
-    private logQuality;
-    private log;
-    private createLogItem;
+	private api;
+	private logger;
+	private config;
+	private subscription;
+	private beforeunloadSubscription;
+	private timeSynchronisation?;
+	private debugLogger;
+	private oneStatDebugLog;
+	private loopCounter;
+	private disabled;
+	experimental: {
+		error$: IObservable<IError>;
+	};
+	get vsid$(): ValueSubject<string | undefined>;
+	isid$: ValueSubject<string | undefined>;
+	zenUid$: ValueSubject<string | undefined>;
+	private statContext;
+	private isEmbed;
+	private embedParent;
+	private uiEvents;
+	private player;
+	private seekAction$;
+	private deviceId;
+	constructor(statContext: IStatContext, params: IConstructorParams);
+	updateContext(newContext: Partial<IStatContext>): void;
+	attachTo(player: IPlayer): ISubscription;
+	attachToUi(events: IUIEvents): ISubscription;
+	attachToAds(adsEvents: IAdsEvents): ISubscription;
+	attachToInteractive(interactiveEvents: IInteractiveEvents): ISubscription;
+	authorize(authToken?: string): Promise<unknown>;
+	pause(): void;
+	resume(): void;
+	destroy(): void;
+	resetViewSession(): void;
+	getDeviceId(): string;
+	setFieldBlacklist(): void;
+	logInited(): void;
+	logReady(payload: IReadyPayload): void;
+	logStarted(...args: Parameters<typeof this.logActionPlay>): void;
+	logPlay(): void;
+	logPlaying(): void;
+	logPause(payload: IPausePayload): void;
+	logSeek(payload: ISeekPayload): void;
+	logFirstBytes(payload: IFirstBytesPayload): void;
+	logFirstFrame(payload: IFirstFramePayload): void;
+	logError(payload: IErrorPayload): void;
+	logWatchCoverageRecord(payload: IWatchCoveragePayload): void;
+	logWatchCoverageLive(payload: IWatchCoveragePayload): void;
+	logEmptyBuffer(payload: IEmptyBufferPayload): void;
+	logDownloadSpeed(): void;
+	logAdSlotRequest(): void;
+	logAdStarted(sectionType: string): void;
+	logAdPaused(): void;
+	logAdResumed(): void;
+	logAdEnded(): void;
+	logAdSkipped(): void;
+	logAdClicked(): void;
+	private logInterfaceClick;
+	private logNextMovie;
+	private subscribe;
+	private resubscribeBeforeunload;
+	private logPlayerReady;
+	private logActionPlay;
+	private logActionPlayInteractive;
+	private logFailover;
+	private logCloseAtEmptyBuffer;
+	private logActionStop;
+	private logTrackSwitch;
+	private logQuality;
+	private log;
+	private createLogItem;
 }