bitmovin-analytics 2.37.1 → 2.38.0

package/bitmovin-analytics.d.ts

@@ -1,4 +1,3 @@
-declare const VERSION: string;
 export interface AnalyticsDebugConfig {
 	fields?: string[];
 }
@@ -11,17 +10,19 @@ export interface CollectorConfig {
 	origin?: string;
 }
 export interface AnalyticsConfig {
-	debug?: boolean | AnalyticsDebugConfig;
-	deviceType?: string;
-	deviceClass?: "Console" | "Desktop" | "Phone" | "STB" | "TV" | "Tablet" | "Wearable" | "Other";
+	config?: CollectorConfig;
+	debug?: AnalyticsDebugConfig | boolean;
 	key?: string;
 	playerKey?: string;
+	deviceType?: string;
+	deviceClass?: "Console" | "Desktop" | "Other" | "Phone" | "STB" | "Tablet" | "TV" | "Wearable";
 	player?: string;
+	userId?: string;
+	customUserId?: string;
 	cdnProvider?: string;
 	videoId?: string;
 	title?: string;
-	userId?: string;
-	customUserId?: string;
+	isLive?: boolean;
 	customData1?: any;
 	customData2?: any;
 	customData3?: any;
@@ -53,8 +54,6 @@ export interface AnalyticsConfig {
 	customData29?: any;
 	customData30?: any;
 	experimentName?: string;
-	isLive?: boolean;
-	config?: CollectorConfig;
 }
 export interface CustomDataValues {
 	customData1?: string;
@@ -93,6 +92,7 @@ export interface CustomDataValues {
  * Minimal set of shared methods among all collectors
  */
 export interface AdapterAPI {
+	get version(): string;
 	getCurrentImpressionId: () => string | undefined;
 	getUserId: () => string | undefined;
 	setCustomData: (values: CustomDataValues) => void;
@@ -107,7 +107,7 @@ export interface SsaiAdMetadata {
 export interface SsaiAdBreakMetadata {
 	adPosition?: AdPosition;
 }
-export type AdPosition = "preroll" | "midroll" | "postroll";
+export type AdPosition = "midroll" | "postroll" | "preroll";
 export interface SsaiApi {
 	adBreakStart(adBreakMetadata?: SsaiAdBreakMetadata): any;
 	adStart(adMetadata?: SsaiAdMetadata): any;
@@ -203,8 +203,8 @@ export interface Sample extends CustomDataValues {
 	completedTotal?: number;
 	customUserId?: string;
 	deviceInformation?: {
-		model?: string;
 		deviceClass?: string;
+		model?: string;
 	};
 	domain?: any;
 	downloadSpeedInfo?: DownloadSpeedInfo;
@@ -270,7 +270,7 @@ declare class SsaiService {
 	 * eventHandler is outside dependency.
 	 * Due to the structure it is not possible to pass it to constructor of this class
 	 */
-	eventHandler: undefined | SsaiEventHandler;
+	eventHandler: SsaiEventHandler | undefined;
 	private state;
 	/**
 	 * represents the current playing ad metdata
@@ -372,8 +372,8 @@ export interface FeatureConfigContainer {
 	errorDetails?: ErrorDetailTrackingConfig;
 }
 declare enum PlayerSize {
-	Window = "WINDOW",
-	Fullscreen = "FULLSCREEN"
+	Fullscreen = "FULLSCREEN",
+	Window = "WINDOW"
 }
 export interface PlaybackInfo {
 	isLive?: boolean;
@@ -408,7 +408,7 @@ export interface SegmentInfo {
 	timestamp: number;
 	url: string;
 }
-export type HeartbeatPayload = Pick<Sample, "played"> | Pick<Sample, "buffered"> | Pick<Sample, "paused">;
+export type HeartbeatPayload = Pick<Sample, "buffered"> | Pick<Sample, "paused"> | Pick<Sample, "played">;
 export interface StateMachineCallbacks {
 	setup: (duration: number, state: string) => void;
 	startup: (duration: number, state: string) => void;
@@ -450,25 +450,6 @@ export interface StateMachineCallbacks {
 	release: () => void;
 	playlistTransition: (event: Readonly<AnalyticsEventBase>) => void;
 }
-export interface Subscribable<TArgs> {
-	subscribe(callback: EventHandler<TArgs>): () => void;
-	unsubscribe(callback: EventHandler<TArgs>): any;
-}
-export type EventHandler<TArgs> = (args: TArgs) => void;
-declare class EventDispatcher<TArgs> implements Subscribable<TArgs> {
-	private callbacks;
-	subscribe(callback: EventHandler<TArgs>): () => void;
-	dispatch(args: TArgs): void;
-	unsubscribe(callback: EventHandler<TArgs>): void;
-	get subscriberCount(): number;
-}
-export interface DeferredLicenseLoadingAdapterAPI {
-	readonly supportsDeferredLicenseLoading?: boolean;
-	readonly onLicenseKeyReceived: Subscribable<{
-		licenseKey: string;
-	}>;
-	readonly onLicenseCallFailed: Subscribable<any>;
-}
 declare class AdCallbacks {
 	onAdStarted: (event: any) => void;
 	onAdFinished: (event: any) => void;
@@ -493,6 +474,25 @@ export interface AdModuleAPI {
 	};
 	currentTime: () => number;
 }
+export interface Subscribable<TArgs> {
+	subscribe(callback: EventHandler<TArgs>): () => void;
+	unsubscribe(callback: EventHandler<TArgs>): any;
+}
+export type EventHandler<TArgs> = (args: TArgs) => void;
+declare class EventDispatcher<TArgs> implements Subscribable<TArgs> {
+	private callbacks;
+	subscribe(callback: EventHandler<TArgs>): () => void;
+	dispatch(args: TArgs): void;
+	unsubscribe(callback: EventHandler<TArgs>): void;
+	get subscriberCount(): number;
+}
+export interface DeferredLicenseLoadingAdapterAPI {
+	readonly supportsDeferredLicenseLoading?: boolean;
+	readonly onLicenseKeyReceived: Subscribable<{
+		licenseKey: string;
+	}>;
+	readonly onLicenseCallFailed: Subscribable<any>;
+}
 export interface InternalAdapterAPI extends DeferredLicenseLoadingAdapterAPI {
 	readonly downloadSpeedInfo: DownloadSpeedInfo;
 	readonly segments: SegmentInfo[];
@@ -513,13 +513,6 @@ export interface InternalAdapterAPI extends DeferredLicenseLoadingAdapterAPI {
 	onError?(): void;
 	setCustomData(values: CustomDataValues): void;
 }
-declare class FeatureManager<TConfigContainer> {
-	private features;
-	registerFeatures(features: Array<Feature<TConfigContainer, FeatureConfig>>): void;
-	unregisterFeatures(): void;
-	resetFeatures(): void;
-	configureFeatures(authenticated: boolean, featureConfigs?: TConfigContainer): void;
-}
 export interface OnErrorDetailEventObject {
 	code: number | undefined;
 	message: string | undefined;
@@ -531,6 +524,13 @@ export interface ErrorDetailTrackingSettingsProvider {
 	readonly impressionId: string;
 	readonly collectorConfig?: CollectorConfig;
 }
+declare class FeatureManager<TConfigContainer> {
+	private features;
+	registerFeatures(features: Array<Feature<TConfigContainer, FeatureConfig>>): void;
+	unregisterFeatures(): void;
+	resetFeatures(): void;
+	configureFeatures(authenticated: boolean, featureConfigs?: TConfigContainer): void;
+}
 export interface Backend {
 	sendRequest(sample: Sample): any;
 	sendUnloadRequest(sample: Sample): any;
@@ -628,6 +628,8 @@ declare class Analytics {
 declare abstract class Adapter {
 	protected analytics: Analytics;
 	protected internalAdapter: InternalAdapterAPI;
+	static version: string;
+	get version(): string;
 	getCurrentImpressionId(): string | undefined;
 	getUserId(): string | undefined;
 	setCustomData(values: CustomDataValues): void;
@@ -661,10 +663,10 @@ export declare class HlsAdapter extends Adapter implements AdapterAPI {
 }
 export declare class HTMLVideoElementAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: HTMLVideoElement, opts?: AnalyticsStateMachineOptions, sourceMetadata?: {
-		streamFormat?: string;
 		audioCodec?: string;
-		videoCodec?: string;
 		audioLanguage?: string;
+		streamFormat?: string;
+		videoCodec?: string;
 	});
 	get sessionMetadata(): {
 		readonly setAudioLanguage: (audioLanguage: string) => void;
@@ -672,10 +674,10 @@ export declare class HTMLVideoElementAdapter extends Adapter implements AdapterA
 		readonly setSubtitleLanguage: (subtitleLanguage: string) => void;
 	};
 	sourceChange(config: AnalyticsConfig, sourceMetadata?: {
-		streamFormat?: string;
 		audioCodec?: string;
-		videoCodec?: string;
 		audioLanguage?: string;
+		streamFormat?: string;
+		videoCodec?: string;
 	}): void;
 }
 export declare class ShakaAdapter extends Adapter implements AdapterAPI {
@@ -686,26 +688,26 @@ export declare class VideojsAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 }
 declare enum CdnProvider {
-	CLOUDFLARE = "cloudflare",
 	AKAMAI = "akamai",
-	FASTLY = "fastly",
-	MAXCDN = "maxcdn",
-	CLOUDFRONT = "cloudfront",
+	BITGRAVITY = "bitgravity",
 	CHINACACHE = "chinacache",
-	BITGRAVITY = "bitgravity"
+	CLOUDFLARE = "cloudflare",
+	CLOUDFRONT = "cloudfront",
+	FASTLY = "fastly",
+	MAXCDN = "maxcdn"
 }
 declare enum Player {
+	AMAZON_IVS = "amazonivs",
 	BITMOVIN = "bitmovin",
 	BITMOVIN_PWX = "bitmovin-pwx",
+	CHROMECAST_SHAKA = "chromecast-shaka",
+	DASHJS = "dashjs",
+	HLSJS = "hlsjs",
+	HTML5 = "html5",
 	JW = "jw",
 	RADIANT = "radiant",
-	VIDEOJS = "videojs",
-	HLSJS = "hlsjs",
 	SHAKA = "shaka",
-	DASHJS = "dashjs",
-	HTML5 = "html5",
-	CHROMECAST_SHAKA = "chromecast-shaka",
-	AMAZON_IVS = "amazonivs"
+	VIDEOJS = "videojs"
 }
 /**
  * @see https://github.com/bitmovin-engineering/bitdash/blob/ccd3227dac82d1416a471711b40ee0f65d7f9ddb/src/ModuleDefinition.ts#L17
@@ -719,6 +721,7 @@ export declare const PlayerModule: {
 		readonly setup: (module: any, player: any) => Promise<any>;
 	};
 };
+declare const VERSION: string;
 export declare const adapters: {
 	AmazonIVSAdapter: typeof AmazonIVSAdapter;
 	Bitmovin8Adapter: typeof Bitmovin8Adapter;