@vkontakte/videoplayer-statistics 1.0.113-dev.9dd0ca0bc.0 → 1.0.113-dev.fc8d8316c.0

package/types/oneStat/utils/watchCoverage.d.ts

@@ -1,8 +1,8 @@
-import type { IOneStatPlayerAdapter } from "../playerAdapter";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
 import type { IObservable, IRange, Milliseconds, Seconds } from "@vkontakte/videoplayer-shared";
 export type IParams = {
 	forceInterval: Milliseconds;
 	watchCoverageTimeoutFix: boolean;
 	watchCoverageExactTime: boolean;
 };
-export declare const watchCoverage: (player: IOneStatPlayerAdapter, params: IParams) => IObservable<IRange<Seconds>>;
+export declare const watchCoverage: (player: IPlayer, params: IParams) => IObservable<IRange<Seconds>>;

package/types/oneStat/values.d.ts

@@ -1,5 +1,9 @@
 import type { 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" | "quality" | "play_toggle" | "pause" | "adv" | "playing";
+export type Operation = CommonOperation | AdvOperation;
+export declare const COMMON_OPERATIONS: readonly ["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", "quality", "play_toggle", "pause", "playing"];
+export type CommonOperation = (typeof COMMON_OPERATIONS)[number];
+export declare const ADV_OPERATIONS: readonly ["adv"];
+export type AdvOperation = (typeof ADV_OPERATIONS)[number];
 export declare enum ApiEnv {
 	PROD = "prod",
 	VK_ALIAS = "vk_alias",
@@ -54,7 +58,7 @@ export declare enum Network {
 	GOOD = "good",
 	POOR = "poor"
 }
-export declare enum Mode {
+export declare enum SurfaceMode {
 	PIP = "pip",
 	FULLSCREEN = "fullscreen",
 	EXTERNAL = "external",
@@ -64,6 +68,15 @@ export declare enum Mode {
 	INVISIBLE = "invisible",
 	MINIMAL = "minimal"
 }
+/**
+* Режим отправки статистики
+* `COMMON` - обычная отправка всех событий
+* `ADV` - играется реклама, отправляются только рекламные события
+*/
+export declare enum SessionMode {
+	ADV = "adv",
+	COMMON = "common"
+}
 export declare enum SeekAction {
 	SLIDER = "slider",
 	RICH = "rich",
@@ -85,4 +98,4 @@ 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>;
+export declare const SurfaceModeAliases: Record<SurfaceMode, string>;

package/types/shared/{useModeController.d.ts → useSurfaceModeController.d.ts}

@@ -1,16 +1,13 @@
 import type { IUIEvents as IUIEventsOneStat } from "../oneStat";
 import type { IUIEvents as IUIEventsThinOneStat } from "../thinOneStat";
-import type { IPlayerInfo } from "@vkontakte/videoplayer-core";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
 import { Surface } from "@vkontakte/videoplayer-core";
 import type { IListener, IObservable } from "@vkontakte/videoplayer-shared";
-export interface IModeControllerPlayerAdapter {
-	info: Pick<IPlayerInfo, "surface$">;
-}
-export interface ModeControllerDependencies {
+export interface SurfaceModeControllerDependencies {
 	uiEvents: IUIEventsOneStat | IUIEventsThinOneStat;
 	initExternalSubscribers: (surfaceObservable$: IObservable<Surface | undefined>) => void;
 	subscribe: <T>(observable: IObservable<T> | undefined, logger: IListener<T>) => void;
-	player?: IModeControllerPlayerAdapter;
+	player?: IPlayer;
 }
 /** конроллер для состояния mode плеера */
-export declare const useModeController: ({ uiEvents, initExternalSubscribers, subscribe, player }: ModeControllerDependencies) => void;
+export declare const useSurfaceModeController: ({ uiEvents, initExternalSubscribers, subscribe, player }: SurfaceModeControllerDependencies) => void;

package/types/thinOneStat/ThinOneStat.d.ts

@@ -1,9 +1,9 @@
 import type { IError, IObservable, ISubject, ISubscription, IValueObservable, IValueSubject, Milliseconds } from "@vkontakte/videoplayer-shared";
 import { ErrorCategory } from "@vkontakte/videoplayer-shared";
-import type { IThinOneStatPlayerAdapter } from "./playerAdapter";
+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 { SurfaceMode, Quality, Visibility, ConnectionType, ContentType } from "./values";
+import { ActionSeekType, AutoQuality, SessionMode } from "./values";
 import type { IAdsEvents, IUIEvents } from "./events";
 export interface IThinOneStat {
 	vsid$: IValueObservable<string | undefined>;
@@ -25,9 +25,21 @@ export interface IThinOneStat {
 	*/
 	updateContext(context: Partial<IStatContext>): void;
 	/**
+	* Устанавливает режим отправки статистики
+	*/
+	setSessionMode(mode: SessionMode): void;
+	/**
+	* Ставит отправку событий на паузу. Они будут накапливаться до вызова `resume()`
+	*/
+	pause(): void;
+	/**
+	* Снимает паузу отправки событий и отправляет все накопленные события
+	*/
+	resume(): void;
+	/**
 	* Привязываемся к событиям и разным изменениям состояний плеера
 	*/
-	attachTo(player: IThinOneStatPlayerAdapter, adsEvents: IAdsEvents): ISubscription;
+	attachTo(player: IPlayer, adsEvents: IAdsEvents): ISubscription;
 	attachToUi(uiEvents: IUIEvents): ISubscription;
 	attachToAds(adsEvents: IAdsEvents): ISubscription;
 	/**
@@ -123,7 +135,7 @@ export interface IPlaybackStartedPayload {
 	muted?: boolean;
 	sound_volume?: number;
 	buffer_time?: Milliseconds;
-	mode?: Mode;
+	mode?: SurfaceMode;
 	visibility?: Visibility;
 	subtitles_enabled?: boolean;
 	auto_subtitles?: boolean;
@@ -210,7 +222,7 @@ export interface IViewPortChangedPayload {
 	player_height?: number;
 }
 export interface IModeChangedPayload {
-	mode?: Mode;
+	mode?: SurfaceMode;
 }
 export interface IVisibilityChangedPayload {
 	visibility?: Visibility;
@@ -318,6 +330,7 @@ export declare class ThinOneStat implements IThinOneStat {
 	private readonly onceEvents;
 	private sentOnceEvents;
 	private eventNumber;
+	private sessionMode;
 	private isStarted?;
 	private isSeeking?;
 	private inBufferStarvation?;
@@ -349,9 +362,12 @@ export declare class ThinOneStat implements IThinOneStat {
 	authorize(authToken?: string): void;
 	reportError(payload: IReportErrorPayload): void;
 	updateContext(newContext: Partial<IStatContext>): void;
-	attachTo(player: IThinOneStatPlayerAdapter, adsEvents: IAdsEvents): ISubscription;
+	attachTo(player: IPlayer, adsEvents: IAdsEvents): ISubscription;
 	attachToUi(events: IUIEvents): ISubscription;
 	attachToAds(events: IAdsEvents): ISubscription;
+	setSessionMode(mode: SessionMode): void;
+	pause(): void;
+	resume(): void;
 	getDeviceId(): string;
 	resetViewSession(): void;
 	destroy(): Promise<void>;

package/types/thinOneStat/index.d.ts

@@ -1,7 +1,6 @@
 export { ThinOneStat } from "./ThinOneStat";
 export type { IThinOneStat, IStatContext } from "./ThinOneStat";
-export type { IThinOneStatPlayerAdapter } from "./playerAdapter";
-export { ActionSeekType } from "./values";
+export { ActionSeekType, SessionMode } from "./values";
 export type { ActionQualityType } from "./values";
 export type { IUIEvents } from "./events";
 export { VERSION } from "../env";

package/types/thinOneStat/utils/calculateTotalViewTime.d.ts

@@ -1,6 +1,5 @@
 import type { Milliseconds } from "@vkontakte/videoplayer-shared";
-import type { IObservable } from "@vkontakte/videoplayer-core";
-import type { IThinOneStatPlayerAdapter } from "../playerAdapter";
+import type { IPlayer, IObservable } from "@vkontakte/videoplayer-core";
 type GetTotalViewTime = () => Milliseconds;
-export declare const calculateTotalViewTime: (player: IThinOneStatPlayerAdapter) => IObservable<GetTotalViewTime>;
+export declare const calculateTotalViewTime: (player: IPlayer) => IObservable<GetTotalViewTime>;
 export {};

package/types/thinOneStat/utils/downloadBytes.d.ts

@@ -1,7 +1,7 @@
-import type { IThinOneStatPlayerAdapter } from "../playerAdapter";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
 import type { IObservable } from "@vkontakte/videoplayer-shared";
 import type { IDownloadBytesPayload } from "../ThinOneStat";
 export type IParams = {
 	maxTimeWindow: number;
 };
-export declare const downloadBytes: (player: IThinOneStatPlayerAdapter, { maxTimeWindow }: IParams) => IObservable<IDownloadBytesPayload>;
+export declare const downloadBytes: (player: IPlayer, { maxTimeWindow }: IParams) => IObservable<IDownloadBytesPayload>;

package/types/thinOneStat/utils/eventName.d.ts

@@ -0,0 +1,2 @@
+import type { EventName, AdvEventName } from "../values";
+export declare const isAdvEvent: (eventName: EventName) => eventName is AdvEventName;

package/types/thinOneStat/utils/mappers.d.ts

@@ -1,11 +1,11 @@
 import type { ISources } from "@vkontakte/videoplayer-core";
 import { HttpConnectionType as CoreConnectionType, Surface, VideoFormat, VideoQuality } from "@vkontakte/videoplayer-core";
-import { ConnectionType as StatisticsConnectionType, ContentType, Mode, Quality, StreamingProfile, Visibility } from "../values";
+import { ConnectionType as StatisticsConnectionType, ContentType, SurfaceMode, Quality, StreamingProfile, Visibility } from "../values";
 export declare const errorTrace: (data: unknown) => string | undefined;
 export declare const connectionType: (coreType?: CoreConnectionType) => StatisticsConnectionType | undefined;
 export declare const contentType: (format?: VideoFormat) => ContentType | undefined;
 export declare const quality: (coreQuality?: VideoQuality) => Quality | undefined;
 export declare const streamingProfile: (contentType?: ContentType) => StreamingProfile | undefined;
 export declare const formatUrl: (format?: VideoFormat, sources?: ISources, quality?: VideoQuality) => string | undefined;
-export declare const mode: (surface?: Surface, isPreviewPlayerView?: boolean) => Mode | undefined;
+export declare const mode: (surface?: Surface, isPreviewPlayerView?: boolean) => SurfaceMode | undefined;
 export declare const visibility: (surface?: Surface) => Visibility | undefined;

package/types/thinOneStat/utils/telemetry.d.ts

@@ -1,7 +1,7 @@
-import type { IThinOneStatPlayerAdapter } from "../playerAdapter";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
 import type { IObservable, Milliseconds } from "@vkontakte/videoplayer-shared";
 export type IParams = {
 	interval: number;
 	getTotalViewTime: () => Milliseconds;
 };
-export declare const telemetry: (player: IThinOneStatPlayerAdapter, params: IParams) => IObservable<void>;
+export declare const telemetry: (player: IPlayer, params: IParams) => IObservable<void>;

package/types/thinOneStat/utils/watchCoverage.d.ts

@@ -1,8 +1,8 @@
-import type { IThinOneStatPlayerAdapter } from "../playerAdapter";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
 import type { Seconds, IObservable, IRange } from "@vkontakte/videoplayer-shared";
 import type { IAdsEvents } from "../events";
 export type IParams = {
 	heartbeatInterval?: Seconds;
 	exactTime: boolean;
 };
-export declare const watchCoverage: (player: IThinOneStatPlayerAdapter, adsEvents: IAdsEvents, params: IParams) => IObservable<IRange<Seconds>>;
+export declare const watchCoverage: (player: IPlayer, adsEvents: IAdsEvents, params: IParams) => IObservable<IRange<Seconds>>;

package/types/thinOneStat/utils/watchedN.d.ts

@@ -1,8 +1,8 @@
-import type { IThinOneStatPlayerAdapter } from "../playerAdapter";
+import type { IPlayer } from "@vkontakte/videoplayer-core";
 import type { IObservable, Milliseconds } from "@vkontakte/videoplayer-shared";
 import type { IWatchedNPayload } from "../ThinOneStat";
 export type IParams = {
 	targetDuration: Milliseconds;
 	getTotalViewTime: () => Milliseconds;
 };
-export declare const watchedN: (player: IThinOneStatPlayerAdapter, params: IParams) => IObservable<IWatchedNPayload>;
+export declare const watchedN: (player: IPlayer, params: IParams) => IObservable<IWatchedNPayload>;

package/types/thinOneStat/values.d.ts

@@ -1,5 +1,9 @@
 import type { VideoQuality } from "@vkontakte/videoplayer-shared";
-export type EventName = "watch_coverage" | "watch_coverage_live" | "watched_n" | "start_session" | "preload_started" | "preload_ended" | "preload_error" | "playback_started" | "play" | "manifest_request" | "first_media_request" | "first_byte_manifest" | "first_byte_media" | "manifest_received" | "connection_established" | "first_video_frame_decoded" | "ready" | "playing" | "pause" | "resume" | "seeking" | "seeked" | "content_end_reached" | "stop" | "buffer_starvation" | "show_loader" | "quality_change_requested" | "quality_changed" | "cdn_host_changed" | "view_port_changed" | "mode_changed" | "visibility_changed" | "audio_track_switched" | "video_track_switched" | "subtitles_switched" | "sound_changed" | "failover" | "content_type_change" | "error" | "cannot_play" | "download_bytes" | "telemetry" | "adv_configuration" | "adv_request" | "adv_break_started" | "adv_break_ended" | "adv_error";
+export type EventName = CommonEventName | AdvEventName;
+export declare const COMMON_EVENT_NAMES: readonly ["watch_coverage", "watch_coverage_live", "watched_n", "start_session", "preload_started", "preload_ended", "preload_error", "playback_started", "play", "manifest_request", "first_media_request", "first_byte_manifest", "first_byte_media", "manifest_received", "connection_established", "first_video_frame_decoded", "ready", "playing", "pause", "resume", "seeking", "seeked", "content_end_reached", "stop", "buffer_starvation", "show_loader", "quality_change_requested", "quality_changed", "cdn_host_changed", "view_port_changed", "mode_changed", "visibility_changed", "audio_track_switched", "video_track_switched", "subtitles_switched", "sound_changed", "failover", "content_type_change", "error", "cannot_play", "download_bytes", "telemetry"];
+export type CommonEventName = (typeof COMMON_EVENT_NAMES)[number];
+export declare const ADV_EVENT_NAMES: readonly ["adv_configuration", "adv_request", "adv_break_started", "adv_break_ended", "adv_error"];
+export type AdvEventName = (typeof ADV_EVENT_NAMES)[number];
 export declare const onceEvents: EventName[];
 export declare enum ApiEnv {
 	PROD = "prod",
@@ -60,7 +64,7 @@ export declare enum StreamingProfile {
 	LIVE = "live",
 	VOD = "vod"
 }
-export declare enum Mode {
+export declare enum SurfaceMode {
 	INLINE = "inline",
 	FULLSCREEN = "fullscreen",
 	PIP_EXTERNAL = "pip_external",
@@ -74,6 +78,15 @@ export declare enum Visibility {
 	FOREGROUND = "foreground",
 	BACKGROUND = "background"
 }
+/**
+* Режим отправки статистики
+* `COMMON` - обычная отправка всех событий
+* `ADV` - играется реклама, отправляются только рекламные события
+*/
+export declare enum SessionMode {
+	ADV = "adv",
+	COMMON = "common"
+}
 export declare enum ActionSeekType {
 	SLIDER = "slider",
 	RICH = "rich",

package/types/oneStat/playerAdapter.d.ts

@@ -1,7 +0,0 @@
-import type { IPlayer, IPlayerInfo, IPlayerEvents } from "@vkontakte/videoplayer-core";
-export interface IOneStatPlayerAdapter {
-	info: Pick<IPlayerInfo, "atLiveEdge$" | "availableTextTracks$" | "currentAudioStream$" | "currentBuffer$" | "currentFormat$" | "currentPlaybackRate$" | "currentQuality$" | "currentTextTrack$" | "currentVideoStream$" | "hostname$" | "httpConnectionReused$" | "httpConnectionType$" | "isAutoQualityEnabled$" | "isBuffering$" | "isLive$" | "liveBufferTime$" | "liveLatency$" | "liveTime$" | "muted$" | "playbackState$" | "position$" | "stallStartTime$" | "surface$" | "throughputEstimation$" | "volume$">;
-	events: Pick<IPlayerEvents, "willStart$" | "willResume$" | "willSeek$" | "willStop$" | "willDestruct$" | "started$" | "playing$" | "paused$" | "seeked$" | "looped$" | "firstBytes$" | "firstFrame$" | "managedError$" | "fatalError$">;
-	getExactTime: IPlayer["getExactTime"];
-	getExactLiveTime: IPlayer["getExactLiveTime"];
-}

package/types/thinOneStat/playerAdapter.d.ts

@@ -1,8 +0,0 @@
-import type { IPlayer, IPlayerInfo, IPlayerEvents } from "@vkontakte/videoplayer-core";
-export interface IThinOneStatPlayerAdapter {
-	info: Pick<IPlayerInfo, "atLiveEdge$" | "availableSources$" | "availableTextTracks$" | "currentAudioStream$" | "currentBuffer$" | "currentFormat$" | "currentPlaybackRate$" | "currentQuality$" | "currentTextTrack$" | "currentVideoStream$" | "hostname$" | "httpConnectionMetrics$" | "httpConnectionReused$" | "httpConnectionType$" | "httpDownloadMetrics$" | "isAutoQualityEnabled$" | "isLive$" | "isStalled$" | "liveTime$" | "muted$" | "playbackState$" | "position$" | "rttEstimation$" | "stallStartTime$" | "surface$" | "videoBitrate$" | "volume$">;
-	events: Pick<IPlayerEvents, "willStart$" | "willReady$" | "willSeek$" | "willStop$" | "willDestruct$" | "started$" | "playing$" | "paused$" | "seeked$" | "ended$" | "looped$" | "firstBytes$" | "firstBytesManifest$" | "firstBytesRequested$" | "firstFrame$" | "manifestRequested$" | "manifestReceived$" | "managedError$" | "fatalError$" | "fetcherRecoverableError$">;
-	experimental: Pick<IPlayer["experimental"], "element$">;
-	getExactTime: IPlayer["getExactTime"];
-	getExactLiveTime: IPlayer["getExactLiveTime"];
-}