bitmovin-analytics 2.29.2 → 2.29.3-beta.1

package/README.md

@@ -1,6 +1,7 @@
 # Bitmovin Analytics Collector
 
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/bitmovin-engineering/bitmovin-analytics-collector/tree/main.svg?style=shield&circle-token=e3ec1c4b9bcaf4bb4818dc6f234845f2807137cc)](https://dl.circleci.com/status-badge/redirect/gh/bitmovin-engineering/bitmovin-analytics-collector/tree/main)
+[![install size](https://packagephobia.com/badge?p=bitmovin-analytics)](https://packagephobia.com/result?p=bitmovin-analytics)
 
 Instruments adaptive streaming video players and collects information to be sent to the Bitmovin Analytics service.
 

package/bitmovin-analytics.d.ts

@@ -1,3 +1,4 @@
+declare const VERSION: string;
 export interface AnalyticsDebugConfig {
 	fields?: string[];
 }
@@ -92,9 +93,6 @@ export interface AdapterAPI {
 	setCustomDataOnce: (values: CustomDataValues) => void;
 	sourceChange: (config: AnalyticsConfig) => void;
 }
-export interface AnalyticsStateMachineOptions {
-	starttime: any;
-}
 export interface Timespan {
 	start: number;
 	end: number;
@@ -374,6 +372,18 @@ 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;
+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;
@@ -398,18 +408,6 @@ 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;
-export interface DeferredLicenseLoadingAdapterAPI {
-	readonly supportsDeferredLicenseLoading?: boolean;
-	readonly onLicenseKeyReceived: Subscribable<{
-		licenseKey: string;
-	}>;
-	readonly onLicenseCallFailed: Subscribable<{}>;
-}
 export interface InternalAdapterAPI extends DeferredLicenseLoadingAdapterAPI {
 	readonly downloadSpeedInfo: DownloadSpeedInfo;
 	readonly segments: SegmentInfo[];
@@ -512,9 +510,9 @@ declare class Analytics {
 	generateNewImpressionId(): void;
 	setUserId(): void;
 	setupStateMachineCallbacks(): void;
-	guardAgainstMissingVideoTitle: (oldConfig: AnalyticsConfig, newConfig: AnalyticsConfig) => void;
-	guardAgainstMissingIsLive: (oldConfig: AnalyticsConfig, newConfig: AnalyticsConfig) => void;
-	sourceChange: (config: AnalyticsConfig) => void;
+	guardAgainstMissingVideoTitle: (oldConfig: AnalyticsConfig, newConfig: AnalyticsConfig | undefined) => void;
+	guardAgainstMissingIsLive: (oldConfig: AnalyticsConfig, newConfig: AnalyticsConfig | undefined) => void;
+	sourceChange: (config: AnalyticsConfig | undefined) => void;
 	setCustomDataOnce: (values: CustomDataValues) => void;
 	setCustomData: (values: CustomDataValues) => void;
 	getCurrentImpressionId: () => string | undefined;
@@ -531,8 +529,8 @@ declare class Analytics {
 	sendAnalyticsRequestSynchronous(): void;
 	clearValues(): void;
 	getIsLiveFromConfigOrPlaybackInfo(config: AnalyticsConfig, isLiveFromPlayback?: boolean): boolean;
-	getMergedCollectorConfig(newConfig: AnalyticsConfig, oldConfig?: AnalyticsConfig): CollectorConfig | undefined;
-	getMergedAnalyticsConfig(newConfig: AnalyticsConfig, oldConfig?: AnalyticsConfig): AnalyticsConfig;
+	getMergedCollectorConfig(newConfig: AnalyticsConfig | undefined, oldConfig?: AnalyticsConfig): CollectorConfig | undefined;
+	getMergedAnalyticsConfig(newConfig: AnalyticsConfig | undefined, oldConfig?: AnalyticsConfig): AnalyticsConfig;
 	/**
 	 * This method sanitizes the input and updates the analytics config.
 	 * @param values Object containing the customData and other fields
@@ -561,6 +559,12 @@ declare abstract class Adapter {
 	protected markPlayerInstanceAsAugmented(player: any): void;
 	private guardAgainstNotInitializedAnalytics;
 }
+export declare class AmazonIVSAdapter extends Adapter implements AdapterAPI {
+	constructor(config: AnalyticsConfig, player: any);
+}
+export interface AnalyticsStateMachineOptions {
+	starttime: any;
+}
 export declare class Bitmovin8Adapter extends Adapter implements AdapterAPI {
 	constructor(player: any, opts?: AnalyticsStateMachineOptions);
 	private wrapPlayerLoad;
@@ -571,12 +575,12 @@ export declare class CAFv3Adapter extends Adapter implements AdapterAPI {
 export declare class DashjsAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 }
-export declare class HlsAdapter extends Adapter implements AdapterAPI {
-	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
-}
 export declare class HTMLVideoElementAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: HTMLVideoElement, opts?: AnalyticsStateMachineOptions);
 }
+export declare class HlsAdapter extends Adapter implements AdapterAPI {
+	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
+}
 export declare class ShakaAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 	private wrapPlayerLoad;
@@ -603,9 +607,9 @@ declare enum Player {
 	SHAKA = "shaka",
 	DASHJS = "dashjs",
 	HTML5 = "html5",
-	CHROMECAST_SHAKA = "chromecast-shaka"
+	CHROMECAST_SHAKA = "chromecast-shaka",
+	AMAZON_IVS = "amazonivs"
 }
-declare const VERSION: string;
 declare const AnalyticsPlayerModule: {
 	name: string;
 	module: {
@@ -623,6 +627,7 @@ export declare const adapters: {
 	DashjsAdapter: typeof DashjsAdapter;
 	CAFv3Adapter: typeof CAFv3Adapter;
 	HTMLVideoElementAdapter: typeof HTMLVideoElementAdapter;
+	AmazonIVSAdapter: typeof AmazonIVSAdapter;
 };
 declare const _default: {
 	PlayerModule: {
@@ -637,6 +642,10 @@ declare const _default: {
 };
 
 export {
+	AnalyticsPlayerModule as PlayerModule,
+	CdnProvider as CdnProviders,
+	Player as Players,
+	VERSION as version,
 	_default as default,
 };