@vkontakte/videoplayer-statistics 1.0.49 → 1.0.50

package/{index.d.ts → types/OneStat.d.ts}

@@ -1,169 +1,10 @@
-import { Kbps, RecursivePartial, Milliseconds, IObservable, ISubscription, IError, IValueObservable, Seconds, ValueSubject } from '@vkontakte/videoplayer-shared';
-import { IPlayer } from '@vkontakte/videoplayer-core';
-
-type Operation = 'action_play' | 'action_play_interactive' | 'first_bytes' | 'player_ready' | 'first_frame' | 'seek' | 'watch_coverage_record' | 'watch_coverage_live' | 'empty_buffer' | 'action_stop' | 'close_at_empty_buffer' | 'content_error' | 'player_interface_click' | 'next_movie' | 'track_switch' | // Пока не поддержана
-'failover' | 'play_toggle' | 'pause' | 'adv';
-declare enum ApiEnv {
-    PROD = "prod",
-    VK_ALIAS = "vk_alias",
-    VIDEOTEST = "videotest",
-    TEST = "test",
-    AUTO = "auto"
-}
-declare enum Quality {
-    Q144P = "mobile",
-    Q240P = "lowest",
-    Q360P = "low",
-    Q480P = "medium",
-    Q720P = "high",
-    Q1080P = "fullhd",
-    Q1440P = "quadhd",
-    Q2160P = "ultrahd",
-    UNKNOWN = "unknown"
-}
-declare enum ContentType {
-    MP4 = "mp4",
-    DASH = "dash",
-    DASH_SEP = "dash_sep",
-    ONDEMAND_DASH = "ondemand_dash",
-    HLS = "hls",
-    ONDEMAND_HLS = "ondemand_hls",
-    WEBM = "webm",
-    AV1 = "av1",
-    ONDEMAND_DASH_LIVE = "ondemand_dash_live",
-    ONDEMAND_HLS_LIVE = "ondemand_hls_live",
-    WEBRTC = "webrtc",
-    UNKNOWN = "unknown",
-    /** @deprecated сдк не поддерживает RTMP, не нужно его использовать */
-    RTMP = "rtmp"
-}
-declare enum StatType {
-    AUTO = "auto",
-    MANUAL = ""
-}
-declare enum ConnectionType {
-    HTTP1 = "http1",
-    HTTP2 = "http2",
-    HTTP3 = "http3"
-}
-declare enum Flag {
-    YES = 1,
-    NO = 0
-}
-declare enum Network {
-    EXCELLENT = "excellent",
-    GOOD = "good",
-    POOR = "poor"
-}
-declare enum Mode {
-    PIP = "pip",
-    FULLSCREEN = "fullscreen",
-    EXTERNAL = "external",
-    PREFETCH = "prefetch",
-    AIRPLAY = "airplay",
-    CHROMECAST = "chromecast",
-    INVISIBLE = "invisible"
-}
-declare enum SeekAction {
-    SLIDER = "slider",
-    DOUBLE_TAP = "double_tap",
-    TIME_CODE = "time_code",
-    EPISODE = "episode",
-    REWIND = "rewind",
-    LIVE = "live",
-    UNKNOWN = "unknown"
-}
-declare enum InteractiveInterfaceClick {
-    GRAPH_SHOW = "iGraphShow",
-    GRAPH_HIDE = "iGraphHide",
-    NEXT_AREA = "iNextChapterArea",
-    NEXT_BUTTON = "iNextChapterBtn",
-    WATCH_AGAIN = "iWatchAgainBtn"
-}
-type InterfaceClick = InteractiveInterfaceClick;
-
-interface ILogCustomData {
-    /**
-     * Сессия смотрения, уникальна для пользователя, контента, экземпляра плеера и одного просмотра
-     * См https://confluence.vk.team/display/VID/Video%20Session%20ID
-     */
-    vsid: string;
-    isid?: string;
-    vid: number;
-    ct?: ContentType;
-    place?: string;
-    quality?: Quality;
-    cdn_host?: string;
-    stat_type?: StatType;
-    param?: any;
-    vk_app_id?: string;
-    track_code?: string;
-    connection_type?: ConnectionType;
-    connection_reused?: Flag;
-    cached_data?: Flag;
-    live?: Flag;
-    muted?: Flag;
-    mode?: Mode;
-    subtitles?: string;
-    failover?: Flag;
-    download_speed?: Kbps;
-    manual_quality?: Flag;
-    ref_domain?: string;
-    direct_url?: string;
-    rate?: string;
-    view_360?: 1;
-    vk_playlist_id?: string;
-    aid?: string;
-}
-
-interface IConfig {
-    apiEnv: ApiEnv;
-    requestRetryCount: number;
-    firstFlushTime: Milliseconds;
-    flushDebounceTime: Milliseconds;
-    flushMaxWait: Milliseconds;
-    storageExpiration: Milliseconds;
-    watchCoverageInterval: Milliseconds;
-    disabledOperations: Operation[];
-    disabledCustomFields: (keyof ILogCustomData)[];
-    shorten: boolean;
-    maxLoops: number;
-    embedUrlParams: string[];
-    useBeacon: boolean;
-    synchronizeTime: boolean;
-    debugLog: boolean;
-    backoff: {
-        start: Milliseconds;
-        factor: number;
-        max: Milliseconds;
-        random: number;
-    };
-}
-type IOptionalConfig = RecursivePartial<IConfig>;
-
-interface IUIEvents {
-    actionRewind$?: IObservable<void>;
-    actionSeek$?: IObservable<SeekAction>;
-    inPiP$?: IObservable<boolean>;
-    inFullscreen$?: IObservable<boolean>;
-    actionSetSubtitle$?: IObservable<string>;
-    nextMovie$?: IObservable<number>;
-}
-interface IAdsEvents {
-    slotRequested$?: IObservable<void>;
-    started$?: IObservable<string>;
-    paused$?: IObservable<void>;
-    resumed$?: IObservable<void>;
-    ended$?: IObservable<void>;
-    skipped$?: IObservable<void>;
-    clicked$?: IObservable<void>;
-}
-interface IInteractiveEvents {
-    click$?: IObservable<InteractiveInterfaceClick>;
-    nextMovie$?: IObservable<number>;
-}
-
-interface IOneStat {
+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';
+export interface IOneStat {
     /**
      * Лучше авторизоваться сразу, чтобы избежать ситуации:
      * 1. Накапливаем запросы в очереди через debounce send
@@ -308,63 +149,63 @@ interface IOneStat {
     vsid$: IValueObservable<string | undefined>;
     isid$: IValueObservable<string | undefined>;
 }
-interface IActionPlayPayload {
+export interface IActionPlayPayload {
     /**
      * время в секундах от начала ролика
      */
     position: Seconds;
 }
-interface IPausePayload {
+export interface IPausePayload {
     /**
      * время в секундах: сколько просмотрено от начала ролика
      */
     position: Seconds;
 }
-interface ISeekPayload {
+export interface ISeekPayload {
     /**
      * Действие пользователя приведшее к перемотке
      */
     action: SeekAction;
     time: Seconds;
 }
-interface IReadyPayload {
+export interface IReadyPayload {
     /**
      * время в миллисекундах с события inited
      */
     time: Milliseconds;
 }
-interface IFirstBytesPayload {
+export interface IFirstBytesPayload {
     /**
      * время в миллисекундах с события inited
      */
     time: Milliseconds;
 }
-interface IFirstFramePayload {
+export interface IFirstFramePayload {
     /**
      * время в миллисекундах с события inited
      */
     time: Milliseconds;
 }
-interface IEmptyBufferPayload {
+export interface IEmptyBufferPayload {
     /**
      * время в миллисекундах которое пользователь видел застывшую картинку
      */
     duration: Milliseconds;
 }
-interface IDownloadSpeedPayload {
+export interface IDownloadSpeedPayload {
     /**
      * Скорость в килобайтах (!) в секунду
      */
     speed: number;
 }
-interface IErrorPayload {
+export interface IErrorPayload {
     /**
      * строка из символов(без пробелов): тип ошибки
      */
     errorType: string;
     fatal: boolean;
 }
-interface IStatContext {
+export interface IStatContext {
     mobile: boolean;
     movieId: number;
     projectId?: number;
@@ -395,7 +236,7 @@ interface IStatContext {
     is3d?: boolean;
     refDomain?: string;
 }
-interface IConstructorParams {
+export interface IConstructorParams {
     /** @deprecated Используете config.apiEnv */
     apiEnv?: ApiEnv;
     config?: IOptionalConfig;
@@ -404,11 +245,11 @@ interface IConstructorParams {
     useIsid?: boolean;
     refreshAuthToken?: () => Promise<string | undefined>;
 }
-interface IWatchCoveragePayload {
+export interface IWatchCoveragePayload {
     start: number;
     end: number;
 }
-declare class OneStat implements IOneStat {
+export declare class OneStat implements IOneStat {
     private api;
     private logger;
     private config;
@@ -446,7 +287,7 @@ declare class OneStat implements IOneStat {
     setFieldBlacklist(): void;
     logInited(): void;
     logReady(payload: IReadyPayload): void;
-    logStarted(...args: Parameters<typeof this$1.logActionPlay>): void;
+    logStarted(...args: Parameters<typeof this.logActionPlay>): void;
     logPlay(): void;
     logPause(payload: IPausePayload): void;
     logSeek(payload: ISeekPayload): void;
@@ -477,7 +318,3 @@ declare class OneStat implements IOneStat {
     private log;
     private createLogItem;
 }
-
-declare const VERSION: string;
-
-export { ApiEnv, ConnectionType, ContentType, IAdsEvents, IConstructorParams, IInteractiveEvents, IOneStat, IOptionalConfig, IStatContext, IUIEvents, InteractiveInterfaceClick, InterfaceClick, OneStat, Quality, SeekAction, VERSION };

package/types/config.d.ts

@@ -0,0 +1,29 @@
+import { ILogCustomData } from './types';
+import { ApiEnv, Operation } from './values';
+import { Milliseconds } from '@vkontakte/videoplayer-shared';
+import type { RecursivePartial } from '@vkontakte/videoplayer-shared';
+export interface IConfig {
+    apiEnv: ApiEnv;
+    requestRetryCount: number;
+    firstFlushTime: Milliseconds;
+    flushDebounceTime: Milliseconds;
+    flushMaxWait: Milliseconds;
+    storageExpiration: Milliseconds;
+    watchCoverageInterval: Milliseconds;
+    disabledOperations: Operation[];
+    disabledCustomFields: (keyof ILogCustomData)[];
+    shorten: boolean;
+    maxLoops: number;
+    embedUrlParams: string[];
+    useBeacon: boolean;
+    synchronizeTime: boolean;
+    debugLog: boolean;
+    backoff: {
+        start: Milliseconds;
+        factor: number;
+        max: Milliseconds;
+        random: number;
+    };
+}
+export type IOptionalConfig = RecursivePartial<IConfig>;
+export declare const fillDefault: (partial: IOptionalConfig) => IConfig;

package/types/env.d.ts

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

package/types/index.d.ts

@@ -0,0 +1,6 @@
+import { IOneStat, OneStat, IStatContext, IConstructorParams } from './OneStat';
+import { ApiEnv, ContentType, Quality, ConnectionType, SeekAction, InterfaceClick, InteractiveInterfaceClick } from './values';
+import { IUIEvents, IAdsEvents, IInteractiveEvents } from './uiEvents';
+export { OneStat, IOneStat, IStatContext, IConstructorParams, ApiEnv, ContentType, Quality, ConnectionType, SeekAction, IUIEvents, IAdsEvents, IInteractiveEvents, InterfaceClick, InteractiveInterfaceClick, };
+export { VERSION } from './env';
+export { IOptionalConfig } from './config';

package/types/types.d.ts

@@ -0,0 +1,43 @@
+import { Kbps, Milliseconds, Seconds } from '@vkontakte/videoplayer-shared';
+import { ConnectionType, ContentType, Flag, Mode, Network, Operation, Quality, StatType } from './values';
+export interface ILogItem {
+    operation: Operation;
+    type: 1;
+    time?: Seconds | Milliseconds;
+    timestamp: Milliseconds;
+    network?: Network;
+    custom: ILogCustomData;
+}
+export interface ILogCustomData {
+    /**
+     * Сессия смотрения, уникальна для пользователя, контента, экземпляра плеера и одного просмотра
+     * См https://confluence.vk.team/display/VID/Video%20Session%20ID
+     */
+    vsid: string;
+    isid?: string;
+    vid: number;
+    ct?: ContentType;
+    place?: string;
+    quality?: Quality;
+    cdn_host?: string;
+    stat_type?: StatType;
+    param?: any;
+    vk_app_id?: string;
+    track_code?: string;
+    connection_type?: ConnectionType;
+    connection_reused?: Flag;
+    cached_data?: Flag;
+    live?: Flag;
+    muted?: Flag;
+    mode?: Mode;
+    subtitles?: string;
+    failover?: Flag;
+    download_speed?: Kbps;
+    manual_quality?: Flag;
+    ref_domain?: string;
+    direct_url?: string;
+    rate?: string;
+    view_360?: 1;
+    vk_playlist_id?: string;
+    aid?: string;
+}

package/types/uiEvents.d.ts

@@ -0,0 +1,24 @@
+import { IObservable } from '@vkontakte/videoplayer-shared';
+import { InteractiveInterfaceClick } from './values';
+import type { SeekAction } from './values';
+export interface IUIEvents {
+    actionRewind$?: IObservable<void>;
+    actionSeek$?: IObservable<SeekAction>;
+    inPiP$?: IObservable<boolean>;
+    inFullscreen$?: IObservable<boolean>;
+    actionSetSubtitle$?: IObservable<string>;
+    nextMovie$?: IObservable<number>;
+}
+export interface IAdsEvents {
+    slotRequested$?: IObservable<void>;
+    started$?: IObservable<string>;
+    paused$?: IObservable<void>;
+    resumed$?: IObservable<void>;
+    ended$?: IObservable<void>;
+    skipped$?: IObservable<void>;
+    clicked$?: IObservable<void>;
+}
+export interface IInteractiveEvents {
+    click$?: IObservable<InteractiveInterfaceClick>;
+    nextMovie$?: IObservable<number>;
+}

package/types/utils/mappers.d.ts

@@ -0,0 +1,7 @@
+import { HttpConnectionType as CoreConnectionType, Surface, VideoFormat, VideoQuality } from '@vkontakte/videoplayer-core';
+import { ConnectionType as StatisticsConnectionType, ContentType, Mode, Network, Quality } from '../values';
+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;
+export declare const surface: (surface: Surface | undefined) => Mode | undefined;
+export declare const network: (effectiveType: 'slow-2g' | '2g' | '3g' | '4g' | string) => Network | undefined;

package/types/utils/shorten.d.ts

@@ -0,0 +1,2 @@
+import { ILogItem } from '../types';
+export declare const shorten: (item: ILogItem) => object;

package/types/utils/timeSynchronisation.d.ts

@@ -0,0 +1,10 @@
+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/types/utils/uuid.d.ts

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

package/types/utils/vsid.d.ts

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

package/types/utils/watchCoverage.d.ts

@@ -0,0 +1,6 @@
+import { IPlayer } from '@vkontakte/videoplayer-core';
+import { IObservable, IRange, Milliseconds, Seconds } from '@vkontakte/videoplayer-shared';
+export type IParams = {
+    forceInterval: Milliseconds;
+};
+export declare const watchCoverage: (player: IPlayer, params: IParams) => IObservable<IRange<Seconds>>;

package/types/values.d.ts

@@ -0,0 +1,85 @@
+import { ILogCustomData } from './types';
+export type Operation = 'action_play' | 'action_play_interactive' | 'first_bytes' | 'player_ready' | 'first_frame' | 'seek' | 'watch_coverage_record' | 'watch_coverage_live' | 'empty_buffer' | 'action_stop' | 'close_at_empty_buffer' | 'content_error' | 'player_interface_click' | 'next_movie' | 'track_switch' | // Пока не поддержана
+'failover' | 'play_toggle' | 'pause' | 'adv';
+export declare enum ApiEnv {
+    PROD = "prod",
+    VK_ALIAS = "vk_alias",
+    VIDEOTEST = "videotest",
+    TEST = "test",
+    AUTO = "auto"
+}
+export declare enum Quality {
+    Q144P = "mobile",
+    Q240P = "lowest",
+    Q360P = "low",
+    Q480P = "medium",
+    Q720P = "high",
+    Q1080P = "fullhd",
+    Q1440P = "quadhd",
+    Q2160P = "ultrahd",
+    UNKNOWN = "unknown"
+}
+export declare enum ContentType {
+    MP4 = "mp4",
+    DASH = "dash",
+    DASH_SEP = "dash_sep",
+    ONDEMAND_DASH = "ondemand_dash",
+    HLS = "hls",
+    ONDEMAND_HLS = "ondemand_hls",
+    WEBM = "webm",
+    AV1 = "av1",
+    ONDEMAND_DASH_LIVE = "ondemand_dash_live",
+    ONDEMAND_HLS_LIVE = "ondemand_hls_live",
+    WEBRTC = "webrtc",
+    UNKNOWN = "unknown",
+    /** @deprecated сдк не поддерживает RTMP, не нужно его использовать */
+    RTMP = "rtmp"
+}
+export declare enum StatType {
+    AUTO = "auto",
+    MANUAL = ""
+}
+export declare enum ConnectionType {
+    HTTP1 = "http1",
+    HTTP2 = "http2",
+    HTTP3 = "http3"
+}
+export declare enum Flag {
+    YES = 1,
+    NO = 0
+}
+export declare enum Network {
+    EXCELLENT = "excellent",
+    GOOD = "good",
+    POOR = "poor"
+}
+export declare enum Mode {
+    PIP = "pip",
+    FULLSCREEN = "fullscreen",
+    EXTERNAL = "external",
+    PREFETCH = "prefetch",
+    AIRPLAY = "airplay",
+    CHROMECAST = "chromecast",
+    INVISIBLE = "invisible"
+}
+export declare enum SeekAction {
+    SLIDER = "slider",
+    DOUBLE_TAP = "double_tap",
+    TIME_CODE = "time_code",
+    EPISODE = "episode",
+    REWIND = "rewind",
+    LIVE = "live",
+    UNKNOWN = "unknown"
+}
+export declare enum InteractiveInterfaceClick {
+    GRAPH_SHOW = "iGraphShow",
+    GRAPH_HIDE = "iGraphHide",
+    NEXT_AREA = "iNextChapterArea",
+    NEXT_BUTTON = "iNextChapterBtn",
+    WATCH_AGAIN = "iWatchAgainBtn"
+}
+export type InterfaceClick = InteractiveInterfaceClick;
+export declare const OperationAliases: Partial<Record<Operation, string>>;
+export declare const CustomParamAliases: Partial<Record<keyof ILogCustomData, string>>;
+export declare const QualityAliases: Record<Quality, string>;
+export declare const ModeAliases: Record<Mode, string>;