@vkontakte/videoplayer-statistics 1.0.28 → 1.0.30

package/Api.d.ts

@@ -1,68 +0,0 @@
-import { ConnectionReused, ConnectionType, ContentType, Quality, ScreenDestination, StatType } from './types';
-import { IApiTransport } from './ApiTransport';
-import { ISubject, IError, ValueSubject, IValueObservable } from '@vkontakte/videoplayer-shared';
-export interface ILogItem {
-    operation: string;
-    timestamp: number;
-    custom: ILogCustomData;
-}
-export interface ILogCustomData {
-    /**
-     * Id видео
-     */
-    vid: number;
-    /**
-     * Сессия смотрения, уникальна для пользователя, контента, экземпляра плеера и одного просмотра
-     * См https://confluence.vk.team/display/VID/Video%20Session%20ID
-     */
-    vsid?: string;
-    quality?: Quality;
-    dst?: ScreenDestination;
-    ct?: ContentType;
-    aid?: string;
-    place?: string;
-    cdn_host?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: ConnectionReused;
-    stat_type?: StatType;
-    vk_playlist_id?: string;
-    vk_app_id?: string;
-    track_code?: string;
-    /**
-     * Параметр события (имеет разный смысл в каждом из событий)
-     */
-    param?: any;
-}
-export interface IApi {
-    authorize(authToken?: string): Promise<string | undefined>;
-    logRequest(items: ILogItem[]): Promise<void>;
-    logBeacon(items: ILogItem[]): void;
-    authorized$: IValueObservable<boolean>;
-    destroy(): void;
-}
-export interface IApiParams {
-    apiTransport: IApiTransport;
-    refreshAuthToken?: () => Promise<string>;
-    requestRetryCount: number;
-    error$: ISubject<IError>;
-}
-export default class Api implements IApi {
-    private params;
-    private uuid;
-    private authToken;
-    private sessionKey;
-    private authorizePromise?;
-    private refreshAuthTokenPromise?;
-    private consequentAuthErrors;
-    authorized$: ValueSubject<boolean>;
-    private backoffTimeoutId;
-    constructor(params: IApiParams);
-    authorize(authToken?: string): Promise<string | undefined>;
-    logBeacon(items: ILogItem[]): void;
-    logRequest(items: ILogItem[]): Promise<void>;
-    destroy(): void;
-    private refreshAuthToken;
-    private createLogParams;
-    private _authorizeWithBackoff;
-    private _authorize;
-}

package/ApiTransport.d.ts

@@ -1,27 +0,0 @@
-import { IError, ISubject } from '@vkontakte/videoplayer-shared';
-import { ApiEnv } from './types';
-import type { TimeSynchronisation } from './utils/timeSynchronisation';
-export interface IApiTransportParams {
-    apiKey: string;
-    apiBaseUrl: string;
-    apiEnv: ApiEnv;
-    error$: ISubject<IError>;
-    timeSynchronisation: TimeSynchronisation;
-}
-export interface IApiTransport {
-    sendBeacon(method: string, params: Record<string, unknown>, sessionKey?: string): boolean;
-    sendRequest<T = unknown>(method: string, params: Record<string, unknown>, sessionKey?: string): Promise<T>;
-}
-export default class ApiTransport implements IApiTransport {
-    private apiKey;
-    private apiBaseUrl;
-    private apiEnv;
-    private timeSynchronisation;
-    private isApiBaseUrlFetched;
-    private params;
-    constructor(params: IApiTransportParams);
-    private resolveApiBaseUrl;
-    sendBeacon(method: string, params: Record<string, unknown>, sessionKey?: string): boolean;
-    sendRequest<T = unknown>(method: string, params: Record<string, unknown>, sessionKey?: string): Promise<T>;
-    private _prepareQueryParams;
-}

package/Logger.d.ts

@@ -1,39 +0,0 @@
-import { IError, ISubject } from '@vkontakte/videoplayer-shared';
-import { IApi, ILogItem } from './Api';
-export interface ILogger {
-    /**
-     * Ставит элемент в очередь на отправку
-     */
-    log(item: ILogItem): void;
-    /**
-     * Отправляет и очищает текущую очередь принудительно
-     */
-    flush(useBeacon?: boolean): void;
-    /**
-     * Ставит отправку событий на паузу. Они будут накапливаться до вызова `resume()`
-     */
-    pause(): void;
-    /**
-     * Снимает паузу отправки событий
-     */
-    resume(): void;
-    destroy(): void;
-}
-export interface ILoggerParams {
-    api: IApi;
-    error$: ISubject<IError>;
-}
-export declare class Logger implements ILogger {
-    private api;
-    private error$;
-    private requestQueue;
-    private subscription;
-    private isPaused;
-    private debouncedFlush;
-    constructor(params: ILoggerParams);
-    log(item: ILogItem): void;
-    flush(useBeacon?: boolean): void;
-    pause(): void;
-    resume(): void;
-    destroy(): void;
-}

package/OneStat.d.ts

@@ -1,228 +0,0 @@
-import { IError, IObservable, ISubscription, Milliseconds, Seconds } from '@vkontakte/videoplayer-shared';
-import type { IPlayer } from '@vkontakte/videoplayer-core';
-import { ILogCustomData } from './Api';
-import { ApiEnv, ConnectionType, ContentType, Quality, ScreenDestination } from './types';
-export interface IOneStat {
-    /**
-     * Лучше авторизоваться сразу, чтобы избежать ситуации:
-     * 1. Накапливаем запросы в очереди через debounce send
-     * 2. Пользователь закрывает приложение
-     * 3. Запрос пытается уйти через sendBeacon и падает без авторизации
-     */
-    authorize(): Promise<unknown>;
-    /**
-     * Обновляет общие параметры событий
-     */
-    updateContext(context: Partial<IStatContext>): void;
-    attachTo(player: IPlayer): ISubscription;
-    /**
-     * Ставит отправку событий на паузу. Они будут накапливаться до вызова `resume()`
-     */
-    pause(): void;
-    /**
-     * Снимает паузу отправки событий
-     */
-    resume(): void;
-    /**
-     * Деструктор класса
-     */
-    destroy(): void;
-    /**
-     * Сбрасывает сессию смотрения
-     */
-    resetViewSession(): void;
-    /**
-     * Отключает отправку полей событий
-     */
-    setFieldBlacklist(fields: (keyof ILogCustomData)[]): void;
-    /**
-     * Плеер создался и получил ссылку
-     */
-    logInited(): void;
-    /**
-     * Плеер готов начать воспроизведение
-     */
-    logReady(payload: IReadyPayload): void;
-    /**
-     * Первый старт видео. Отправляется 1 раз, когда фактически началось воспроизведение ролика, а также после зацикливания, но не после паузы.
-     *
-     * В документации API может называться `play`
-     */
-    logStarted(payload: IActionPlayPayload): void;
-    /**
-     *  Возобновление после паузы
-     *
-     *  В документации API может называться `play_toggle`
-     */
-    logPlay(): void;
-    /**
-     *  Постановка видео на паузу
-     */
-    logPause(payload: IPausePayload): void;
-    /**
-     * перемотка видео
-     */
-    logSeek(): void;
-    /**
-     * Промежутки видео, которые были просмотрены пользователем.
-     * Время указывается в секундах от начала ролика (т.е. является позицией).
-     */
-    logWatchCoverageRecord(payload: IWatchCoveragePayload): void;
-    /**
-     * Промежутки видео, которые были просмотрены пользователем.
-     * Время указывается в виде UTC timestamp'ов.
-     */
-    logWatchCoverageLive(payload: IWatchCoveragePayload): void;
-    /**
-     * Буфер пуст и пользователь видит залипший кадр.
-     */
-    logEmptyBuffer(payload: IEmptyBufferPayload): void;
-    /**
-     * Получен первый кусок данных контента от сервера раздачи видео
-     */
-    logFirstBytes(payload: IFirstBytesPayload): void;
-    /**
-     * Пользователь увидел первый кадр
-     */
-    logFirstFrame(payload: IFirstFramePayload): void;
-    logDownloadSpeed(payload: IDownloadSpeedPayload): void;
-    /**
-     * произошла ошибка
-     */
-    logError(payload: IErrorPayload): void;
-    logAdSlotRequest(): void;
-    logAdStarted(sectionType: string): void;
-    logAdPaused(): void;
-    logAdResumed(): void;
-    logAdEnded(): void;
-    logAdSkipped(): void;
-    logAdClicked(): void;
-    experimental: {
-        error$: IObservable<IError>;
-    };
-}
-export interface IActionPlayPayload {
-    /**
-     * время в секундах от начала ролика
-     */
-    position: Seconds;
-}
-export interface IPausePayload {
-    /**
-     * время в секундах: сколько просмотрено от начала ролика
-     */
-    position: Seconds;
-}
-export interface IReadyPayload {
-    /**
-     * время в миллисекундах с события inited
-     */
-    time: Milliseconds;
-}
-export interface IFirstBytesPayload {
-    /**
-     * время в миллисекундах с события inited
-     */
-    time: Milliseconds;
-}
-export interface IFirstFramePayload {
-    /**
-     * время в миллисекундах с события inited
-     */
-    time: Milliseconds;
-}
-export interface IEmptyBufferPayload {
-    /**
-     * время в миллисекундах которое пользователь видел застывшую картинку
-     */
-    duration: Milliseconds;
-}
-export interface IDownloadSpeedPayload {
-    /**
-     * Скорость в килобайтах (!) в секунду
-     */
-    speed: number;
-}
-export interface IErrorPayload {
-    /**
-     * строка из символов(без пробелов): тип ошибки
-     */
-    errorType: string;
-}
-export interface IStatContext {
-    /**
-     * Ид видео
-     */
-    movieId: number;
-    quality?: Quality;
-    destination?: ScreenDestination;
-    contentType?: ContentType;
-    albumId?: string;
-    vkPlaylistId?: string;
-    vkAppId?: string;
-    /**
-     * Раздел сайта на котором играет видео: Лента, плеер, личные сообщения, ...
-     */
-    place?: string;
-    cdnHostname?: string;
-    connectionType?: ConnectionType;
-    connectionReused?: boolean;
-    autoplay?: boolean;
-    trackCode?: string;
-}
-export interface IConfig {
-    requestRetryCount: number;
-}
-export interface IConstructorParams {
-    apiEnv: ApiEnv;
-    config?: Partial<IConfig>;
-    refreshAuthToken?: () => Promise<string>;
-}
-export interface IWatchCoveragePayload {
-    start: number;
-    end: number;
-}
-export declare class OneStat implements IOneStat {
-    private api;
-    private logger;
-    private config;
-    private subscription;
-    private timeSynchronisation;
-    experimental: {
-        error$: IObservable<IError>;
-    };
-    private statContext;
-    private vsid;
-    private fieldBlacklist;
-    constructor(statContext: IStatContext, params: IConstructorParams);
-    updateContext(newContext: Partial<IStatContext>): void;
-    attachTo(player: IPlayer): ISubscription;
-    authorize(authToken?: string): Promise<unknown>;
-    pause(): void;
-    resume(): void;
-    destroy(): void;
-    resetViewSession(): void;
-    setFieldBlacklist(fields?: (keyof ILogCustomData)[]): void;
-    logInited(): void;
-    logReady(payload: IReadyPayload): void;
-    logStarted(payload: IActionPlayPayload): void;
-    logPlay(): void;
-    logPause(payload: IPausePayload): void;
-    logSeek(): 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(payload: IDownloadSpeedPayload): void;
-    logAdSlotRequest(): void;
-    logAdStarted(sectionType: string): void;
-    logAdPaused(): void;
-    logAdResumed(): void;
-    logAdEnded(): void;
-    logAdSkipped(): void;
-    logAdClicked(): void;
-    private log;
-    private createLogItem;
-}

package/build/polyfills/runtime/abortableFetch.d.ts

@@ -1,4 +0,0 @@
-export declare const fetch: any;
-export declare const Request: any;
-export declare const AbortController: any;
-export declare const AbortSignal: any;

package/env.d.ts

@@ -1,8 +0,0 @@
-import { ApiEnv } from './types';
-export declare const APP_VERSION: string;
-export declare const APP_NAME: string;
-/**
- * Application ID: 512000749287.
- */
-export declare const API_KEY: string;
-export declare const API_BASE_URLS: Record<ApiEnv, string>;

package/es2015.cjs.d.ts

@@ -1,3 +0,0 @@
-import { IOneStat, OneStat, IStatContext } from './OneStat';
-import { ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType } from './types';
-export { OneStat, IOneStat, IStatContext, ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType };

package/es2015.esm.d.ts

@@ -1,3 +0,0 @@
-import { IOneStat, OneStat, IStatContext } from './OneStat';
-import { ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType } from './types';
-export { OneStat, IOneStat, IStatContext, ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType };

package/es2018.cjs.d.ts

@@ -1,3 +0,0 @@
-import { IOneStat, OneStat, IStatContext } from './OneStat';
-import { ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType } from './types';
-export { OneStat, IOneStat, IStatContext, ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType };

package/es2018.esm.d.ts

@@ -1,3 +0,0 @@
-import { IOneStat, OneStat, IStatContext } from './OneStat';
-import { ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType } from './types';
-export { OneStat, IOneStat, IStatContext, ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType };

package/esnext.esm.d.ts

@@ -1,3 +0,0 @@
-import { IOneStat, OneStat, IStatContext } from './OneStat';
-import { ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType } from './types';
-export { OneStat, IOneStat, IStatContext, ApiEnv, ContentType, ScreenDestination, Quality, ConnectionType };

package/types.d.ts

@@ -1,50 +0,0 @@
-export declare enum ApiEnv {
-    PROD = "prod",
-    VK_ALIAS = "vk_alias",
-    VIDEOTEST = "videotest",
-    TEST = "test",
-    AUTO = "auto"
-}
-export declare enum Quality {
-    Q144P = "144",
-    Q240P = "240",
-    Q360P = "360",
-    Q480P = "480",
-    Q720P = "720",
-    Q1080P = "1080",
-    Q1440P = "1440",
-    Q2160P = "2160",
-    Q4320P = "4320",
-    UNKNOWN = "unknown"
-}
-export declare enum ScreenDestination {
-    CHROMECAST = "chromecast",
-    APPLE_TV = "appletv",
-    PIP = "pip",
-    HEADPHONES = "externalHeadphones",
-    SCREEN = ""
-}
-export declare enum ContentType {
-    MP4 = "mp4",
-    DASH = "dash",
-    DASH_SEP = "dash_sep",
-    ONDEMAND_DASH = "ondemand_dash",
-    HLS = "hls",
-    ONDEMAND_HLS = "ondemand_hls",
-    WEBM = "webm",
-    RTMP = "rtmp",
-    UNKNOWN = "unknown"
-}
-export declare enum StatType {
-    AUTO = "auto",
-    MANUAL = ""
-}
-export declare enum ConnectionType {
-    HTTP1 = "http1",
-    HTTP2 = "http2",
-    HTTP3 = "http3"
-}
-export declare enum ConnectionReused {
-    YES = 1,
-    NO = 0
-}

package/utils/coreMappers.d.ts

@@ -1,5 +0,0 @@
-import { VideoFormat, VideoQuality, HttpConnectionType as CoreConnectionType } from '@vkontakte/videoplayer-core';
-import { ContentType, Quality, ConnectionType as StatisticsConnectionType } from '../types';
-export declare const quality: (coreQuality: VideoQuality | undefined) => Quality | undefined;
-export declare const connectionType: (coreType: CoreConnectionType | undefined) => StatisticsConnectionType | undefined;
-export declare const contentType: (format: VideoFormat | undefined) => ContentType | undefined;

package/utils/storage.d.ts

@@ -1,11 +0,0 @@
-/**
- * LocalStorage
- * Перенесено из "звонков" as is
- */
-declare type IItem = string | number | boolean | Record<string, unknown>;
-declare const _default: {
-    get(name: string): IItem | null;
-    set(name: string, value: IItem): void;
-    remove(name: string): void;
-};
-export default _default;

package/utils/timeSynchronisation.d.ts

@@ -1,10 +0,0 @@
-import { Milliseconds } from '@vkontakte/videoplayer-shared';
-export declare class TimeSynchronisation {
-    private offset;
-    constructor(initialOffset?: Milliseconds);
-    getOffset(): Milliseconds;
-    setOffset(offset: Milliseconds): void;
-    now(): number;
-    date(date?: Date): Date;
-    addServerTime(serverTime: Milliseconds, rtt: Milliseconds): void;
-}

package/utils/uuid.d.ts

@@ -1 +0,0 @@
-export default function uuid(): string;

package/utils/vsid.d.ts

@@ -1 +0,0 @@
-export declare const generateVSID: () => string;