bitmovin-analytics 2.22.0 → 2.23.0

package/js/adapters/Adapter.d.ts

@@ -9,5 +9,7 @@ export declare abstract class Adapter {
     setCustomData(values: CustomDataValues): void;
     setCustomDataOnce(values: CustomDataValues): void;
     sourceChange(config: AnalyticsConfig): void;
+    protected hasPlayerAlreadyBeenAugmented(player: any): boolean;
+    protected markPlayerInstanceAsAugmented(player: any): void;
     private guardAgainstNotInitializedAnalytics;
 }

package/js/adapters/Bitmovin7Adapter.d.ts

@@ -5,6 +5,4 @@ export declare class Bitmovin7Adapter extends Adapter implements AdapterAPI {
     constructor(player: any, opts?: AnalyticsStateMachineOptions);
     private augment;
     private wrapPlayerLoad;
-    private hasPlayerAlreadyBeenAugmented;
-    private markPlayerInstanceAsAugmented;
 }

package/js/adapters/internal/InternalAdapter.d.ts

@@ -28,6 +28,7 @@ export declare abstract class InternalAdapter {
     get downloadSpeedInfo(): DownloadSpeedInfo;
     get segments(): SegmentInfo[];
     constructor(opts?: AnalyticsStateMachineOptions);
+    release(): void;
     eventCallback: <StatemachineEvent extends Event, EventData extends EventMap[StatemachineEvent]>(eventType: StatemachineEvent, eventObject: NoExtraProperties<EventMap[StatemachineEvent], EventData>) => void;
     getCommonPlaybackInfo(): {
         screenHeight: number;

package/js/analyticsStateMachines/AnalyticsStateMachine.d.ts

@@ -21,6 +21,7 @@ export declare abstract class AnalyticsStateMachine {
     abstract callEvent<StatemachineEvent extends keyof EventMap, EventData extends EventMap[StatemachineEvent]>(eventType: StatemachineEvent, eventObject: NoExtraProperties<EventMap[StatemachineEvent], EventData>, timestamp: number): void;
     abstract sourceChange(config: any, timestamp: number, currentTime?: number): void;
     get currentState(): string;
+    resetIntervals(): void;
     protected startRebufferingHeartbeatInterval(reset?: boolean): void;
     protected resetRebufferingHelpers(reset?: boolean): void;
     protected clearRebufferingHeartbeatHandle(): void;

package/js/core/Analytics.d.ts

@@ -66,6 +66,10 @@ export declare class Analytics {
     getIsLiveFromConfigOrPlaybackInfo(config: AnalyticsConfig, isLiveFromPlayback?: boolean): boolean;
     getMergedCollectorConfig(newConfig: AnalyticsConfig, oldConfig?: AnalyticsConfig): import("../types/AnalyticsConfig").CollectorConfig | undefined;
     getMergedAnalyticsConfig(newConfig: AnalyticsConfig, oldConfig?: AnalyticsConfig): AnalyticsConfig;
+    /**
+     * This method sanitizes the input and updates the analytics config.
+     * @param values Object containing the customData and other fields
+     */
     private changeCustomData;
     private buildDefaultAnalyticsConfigValues;
     private checkForErrorsInConfig;
@@ -74,5 +78,5 @@ export declare class Analytics {
     private getDomain;
     private setCompletionValues;
     private sendQualityChange;
-    private clearResetQualityChangeIntverval;
+    private clearResetQualityChangeInterval;
 }

package/js/types/AdAnalyticsSample.d.ts

@@ -1,5 +1,6 @@
+import { CustomDataValues } from './CustomDataValues';
 import { Sample } from './Sample';
-export declare class AdAnalyticsSample {
+export declare class AdAnalyticsSample implements CustomDataValues {
     adModule?: string;
     adModuleVersion?: string;
     videoImpressionId?: string;
@@ -13,9 +14,27 @@ export declare class AdAnalyticsSample {
     customData5?: string;
     customData6?: string;
     customData7?: string;
+    customData8?: string;
+    customData9?: string;
+    customData10?: string;
+    customData11?: string;
+    customData12?: string;
+    customData13?: string;
+    customData14?: string;
+    customData15?: string;
+    customData16?: string;
+    customData17?: string;
+    customData18?: string;
+    customData19?: string;
+    customData20?: string;
+    customData21?: string;
+    customData22?: string;
+    customData23?: string;
+    customData24?: string;
+    customData25?: string;
     customUserId?: string;
-    domain?: string;
     experimentName?: string;
+    domain?: string;
     key?: string;
     path?: string;
     player?: string;

package/js/types/CustomDataValues.d.ts

@@ -6,5 +6,27 @@ export interface CustomDataValues {
     customData5?: string;
     customData6?: string;
     customData7?: string;
+    customData8?: string;
+    customData9?: string;
+    customData10?: string;
+    customData11?: string;
+    customData12?: string;
+    customData13?: string;
+    customData14?: string;
+    customData15?: string;
+    customData16?: string;
+    customData17?: string;
+    customData18?: string;
+    customData19?: string;
+    customData20?: string;
+    customData21?: string;
+    customData22?: string;
+    customData23?: string;
+    customData24?: string;
+    customData25?: string;
     experimentName?: string;
 }
+/**
+ * Lists all keys of the {@see CustomDataValues} interface.
+ */
+export declare const customDataValuesKeys: Array<keyof CustomDataValues>;

package/js/types/Sample.d.ts

@@ -1,5 +1,6 @@
+import { CustomDataValues } from './CustomDataValues';
 import { DownloadSpeedInfo } from './DownloadSpeedInfo';
-export interface Sample {
+export interface Sample extends CustomDataValues {
     platform: string;
     sequenceNumber?: number;
     domain?: any;
@@ -52,14 +53,6 @@ export interface Sample {
     videoStartFailedReason?: string;
     autoplay?: any;
     pageLoadTime: number;
-    experimentName?: any;
-    customData1?: any;
-    customData2?: any;
-    customData3?: any;
-    customData4?: any;
-    customData5?: any;
-    customData6?: any;
-    customData7?: any;
     key?: string;
     playerKey?: any;
     cdnProvider?: any;

package/js/types/StateMachineCallbacks.d.ts

@@ -42,5 +42,6 @@ export interface StateMachineCallbacks {
     customdatachange: (duration?: number, state?: string, event?: {
         values: CustomDataValues;
     }) => void;
+    release: () => void;
 }
 export declare const defaultStateMachineCallbacks: StateMachineCallbacks;

package/js/utils/Utils.d.ts

@@ -1,4 +1,5 @@
 import { PAGE_LOAD_TYPE } from '../enums/PageLoadType';
+import { CustomDataValues } from '../types/CustomDataValues';
 export declare const validString: (text: any) => boolean;
 export declare const isNullOrEmptyString: (text: any) => boolean;
 export declare const validBoolean: (bool: any) => boolean;
@@ -12,6 +13,7 @@ export declare const generateUUID: () => string;
 export declare const getCookie: (cname: string) => string;
 export declare const noOp: () => void;
 export declare const getCustomDataString: (customData: any) => string | undefined;
+export declare const transferCustomDataFields: (fromConfig: CustomDataValues, toConfig: CustomDataValues) => void;
 export declare const getDocumentPropWithPrefix: (prop: string) => string | undefined;
 export declare const isVideoInFullscreen: () => boolean;
 export declare const getHiddenProp: () => string | undefined;

package/package.json

@@ -1 +1 @@
-{"name":"bitmovin-analytics","version":"v2.22.0","description":"Bitmovin Analytics Collector collects monitoring devents from video players for the Bitmovin Analytics Service","license":"MIT","repository":{"type":"git","url":"git+https://github.com/bitmovin/bitmovin-analytics-collector.git"},"main":"bitmovinanalytics.min.js","types":"bitmovin-analytics.d.ts","author":"Bitmovin Inc","homepage":"https://bitmovin.com/video-analytics/","maintainers":[{"name":"bitadmin","email":"admin@bitmovin.com"}]}
+{"name":"bitmovin-analytics","version":"v2.23.0","description":"Bitmovin Analytics Collector collects monitoring devents from video players for the Bitmovin Analytics Service","license":"MIT","repository":{"type":"git","url":"git+https://github.com/bitmovin/bitmovin-analytics-collector.git"},"main":"bitmovinanalytics.min.js","types":"bitmovin-analytics.d.ts","author":"Bitmovin Inc","homepage":"https://bitmovin.com/video-analytics/","maintainers":[{"name":"bitadmin","email":"admin@bitmovin.com"}]}