bitmovin-analytics 2.21.0 → 2.23.0

package/js/enums/VideoStartFailedReason.d.ts

@@ -1,6 +1,10 @@
-export declare enum VideoStartFailedReason {
-    PageClosed = "PAGE_CLOSED",
-    PlayerError = "PLAYER_ERROR",
-    Timeout = "TIMEOUT",
-    Unknown = "UNKNOWN"
+import { ErrorCode } from './ErrorCode';
+export declare class VideoStartFailedReason {
+    readonly reason: string;
+    readonly errorCode: ErrorCode | null;
+    static PAGE_CLOSED: VideoStartFailedReason;
+    static PLAYER_ERROR: VideoStartFailedReason;
+    static TIMEOUT: VideoStartFailedReason;
+    static UNKNOWN: VideoStartFailedReason;
+    private constructor();
 }

package/js/features/Feature.d.ts

@@ -0,0 +1,14 @@
+import { FeatureConfig } from './FeatureConfig';
+export declare abstract class Feature<TConfigContainer, TConfig extends FeatureConfig> {
+    private _config?;
+    private _isEnabled;
+    get config(): TConfig | undefined;
+    get isEnabled(): boolean;
+    abstract reset(): void;
+    abstract enabled(): void;
+    abstract disabled(): void;
+    abstract configured(authenticated: boolean, config?: TConfig): void;
+    disable(): void;
+    configure(authenticated: boolean, configContainer?: TConfigContainer): TConfig | undefined;
+    abstract extractConfig(configContainer: TConfigContainer): TConfig | undefined;
+}

package/js/features/FeatureConfig.d.ts

@@ -0,0 +1,3 @@
+export interface FeatureConfig {
+    enabled: boolean | undefined;
+}

package/js/features/FeatureManager.d.ts

@@ -0,0 +1,9 @@
+import { Feature } from './Feature';
+import { FeatureConfig } from './FeatureConfig';
+export declare class FeatureManager<TConfigContainer> {
+    private features;
+    registerFeatures(features: Array<Feature<TConfigContainer, FeatureConfig>>): void;
+    unregisterFeatures(): void;
+    resetFeatures(): void;
+    configureFeatures(authenticated: boolean, featureConfigs?: TConfigContainer): void;
+}

package/js/features/errordetails/ErrorData.d.ts

@@ -0,0 +1,5 @@
+export interface ErrorData {
+    exceptionMessage?: string | undefined;
+    exceptionStacktrace?: string[] | undefined;
+    additionalData?: string | undefined;
+}

package/js/features/errordetails/ErrorDetail.d.ts

@@ -0,0 +1,18 @@
+import { HttpRequest } from '../httprequesttracking/HttpRequest';
+import { ErrorData } from './ErrorData';
+export interface ErrorDetail {
+    platform: string;
+    licenseKey: string;
+    domain: string;
+    impressionId: string;
+    errorId: number;
+    /**
+     * Epoch timestamp in milliseconds
+     */
+    timestamp: number;
+    code: number | undefined;
+    message: string | undefined;
+    data: ErrorData;
+    httpRequests: HttpRequest[] | undefined;
+    analyticsVersion: string;
+}

package/js/features/errordetails/ErrorDetailBackend.d.ts

@@ -0,0 +1,24 @@
+import { CollectorConfig } from '../../types/AnalyticsConfig';
+import { HttpRequest } from '../httprequesttracking/HttpRequest';
+import { ErrorData } from './ErrorData';
+import { ErrorDetail } from './ErrorDetail';
+export declare class ErrorDetailBackend {
+    get queue(): ReadonlyArray<ErrorDetail>;
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    static copyErrorDetailTruncateStringsAndUrls(errorDetail: ErrorDetail, maxStringLength: number, maxUrlLength: number): ErrorDetail;
+    static copyHttpRequestTruncateUrls(httpRequest: HttpRequest, maxLength: number): HttpRequest;
+    static copyErrorDataTruncateStrings(errorData: ErrorData, maxStringLength: number): ErrorData;
+    static copyErrorDetailTruncateHttpRequests(errorDetail: ErrorDetail, maxRequests: number): ErrorDetail;
+    private static MAX_URL_LENGTH;
+    private static MAX_STRING_LENGTH;
+    private readonly backendUrl;
+    private readonly _queue;
+    private _enabled;
+    constructor(collectorConfig: CollectorConfig | undefined);
+    limitHttpRequestsOfQueuedErrorDetails(max: number): void;
+    send(errorDetail: ErrorDetail): void;
+    flush(): void;
+    clear(): void;
+    private removeFromQueue;
+}

package/js/features/errordetails/ErrorDetailTracking.d.ts

@@ -0,0 +1,28 @@
+import { Subscribable } from '../../core/EventDispatcher';
+import { CollectorConfig } from '../../types/AnalyticsConfig';
+import { FeatureConfigContainer } from '../../types/FeatureConfigContainer';
+import { Feature } from '../Feature';
+import { HttpRequestTracking } from '../httprequesttracking/HttpRequestTracking';
+import { ErrorDetailBackend } from './ErrorDetailBackend';
+import { ErrorDetailTrackingConfig } from './ErrorDetailTrackingConfig';
+import { OnErrorDetailEventObject } from './OnErrorDetailEventObject';
+export interface ErrorDetailTrackingSettingsProvider {
+    readonly licenseKey: string;
+    readonly domain: string;
+    readonly impressionId: string;
+    readonly collectorConfig?: CollectorConfig;
+}
+export declare class ErrorDetailTracking extends Feature<FeatureConfigContainer, ErrorDetailTrackingConfig> {
+    private settingsProvider;
+    private backend;
+    private subscribables;
+    private httpRequestTracking;
+    private errorIndex;
+    constructor(settingsProvider: ErrorDetailTrackingSettingsProvider, backend: ErrorDetailBackend, subscribables: Array<Subscribable<OnErrorDetailEventObject>>, httpRequestTracking: HttpRequestTracking | undefined);
+    reset(): void;
+    enabled(): void;
+    disabled(): void;
+    configured(authenticated: boolean, config?: ErrorDetailTrackingConfig): void;
+    extractConfig(configContainer: FeatureConfigContainer): ErrorDetailTrackingConfig | undefined;
+    private onErrorHandler;
+}

package/js/features/errordetails/ErrorDetailTrackingConfig.d.ts

@@ -0,0 +1,4 @@
+import { FeatureConfig } from '../FeatureConfig';
+export interface ErrorDetailTrackingConfig extends FeatureConfig {
+    numberOfHttpRequests: number | undefined;
+}

package/js/features/errordetails/OnErrorDetailEventObject.d.ts

@@ -0,0 +1,6 @@
+import { ErrorData } from './ErrorData';
+export interface OnErrorDetailEventObject {
+    code: number | undefined;
+    message: string | undefined;
+    errorData?: ErrorData | undefined;
+}

package/js/features/httprequesttracking/HttpRequest.d.ts

@@ -0,0 +1,24 @@
+import { HttpRequestType } from './HttpRequestType';
+export interface HttpRequest {
+    /**
+     * Epoch timestamp in milliseconds
+     */
+    timestamp: number;
+    type: HttpRequestType;
+    url?: string | undefined;
+    lastRedirectLocation?: string | undefined;
+    httpStatus: number;
+    /**
+     * Total time elapsed in milliseconds since the request was opened (including TTFB).
+     */
+    downloadTime: number;
+    /**
+     * The time-to-first-byte for this request in milliseconds.
+     */
+    timeToFirstByte?: number | undefined;
+    /**
+     * The size of the downloaded data, in bytes.
+     */
+    size?: number | undefined;
+    success: boolean;
+}

package/js/features/httprequesttracking/HttpRequestTracking.d.ts

@@ -0,0 +1,17 @@
+import { Subscribable } from '../../core/EventDispatcher';
+import { HttpRequest } from './HttpRequest';
+import { OnDownloadFinishedEventObject } from './OnDownloadFinishedEventObject';
+export declare class HttpRequestTracking {
+    private subscribables;
+    private static DEFAULT_MAX_REQUESTS;
+    private _maxRequests;
+    private _httpRequestQueue;
+    get maxRequests(): number;
+    get httpRequests(): ReadonlyArray<HttpRequest>;
+    constructor(subscribables: Array<Subscribable<OnDownloadFinishedEventObject>>);
+    configure(maxRequests: number): void;
+    disable(): void;
+    reset(): void;
+    private onDownloadFinishedHandler;
+    private addRequest;
+}

package/js/features/httprequesttracking/HttpRequestType.d.ts

@@ -0,0 +1,24 @@
+export declare enum HttpRequestType {
+    DRM_LICENSE_WIDEVINE = "DRM_LICENSE_WIDEVINE",
+    DRM_OTHER = "DRM_OTHER",
+    MEDIA_THUMBNAILS = "MEDIA_THUMBNAILS",
+    MEDIA_VIDEO = "MEDIA_VIDEO",
+    MEDIA_AUDIO = "MEDIA_AUDIO",
+    MEDIA_PROGRESSIVE = "MEDIA_PROGRESSIVE",
+    MEDIA_SUBTITLES = "MEDIA_SUBTITLES",
+    MANIFEST_DASH = "MANIFEST_DASH",
+    MANIFEST_HLS = "MANIFEST_HLS",
+    MANIFEST_HLS_MASTER = "MANIFEST_HLS_MASTER",
+    MANIFEST_HLS_VARIANT = "DRM_LICENSMANIFEST_HLS_VARIANTE_WIDEVINE",
+    MANIFEST_SMOOTH = "MANIFEST_SMOOTH",
+    MANIFEST = "MANIFEST",
+    KEY_HLS_AES = "KEY_HLS_AES",
+    UNKNOWN = "UNKNOWN",
+    TIME_SYNC = "TIME_SYNC",
+    DRM_CERTIFICATE_FAIRPLAY = "DRM_CERTIFICATE_FAIRPLAY",
+    DRM_LICENSE_CLEARKEY = "DRM_LICENSE_CLEARKEY",
+    DRM_LICENSE_PRIMETIME = "DRM_LICENSE_PRIMETIME",
+    DRM_LICENSE_FAIRPLAY = "DRM_LICENSE_FAIRPLAY",
+    DRM_LICENSE_PLAYREADY = "DRM_LICENSE_PLAYREADY",
+    MANIFEST_ADS = "MANIFEST_ADS"
+}

package/js/features/httprequesttracking/OnDownloadFinishedEventObject.d.ts

@@ -0,0 +1,4 @@
+import { HttpRequest } from './HttpRequest';
+export interface OnDownloadFinishedEventObject {
+    httpRequest: HttpRequest;
+}

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/AuthenticationCallback.d.ts

@@ -0,0 +1,4 @@
+import { FeatureConfigContainer } from './FeatureConfigContainer';
+export interface AuthenticationCallback {
+    authenticationCompleted(success: boolean, featureConfigs: FeatureConfigContainer | undefined): void;
+}

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/EventData.d.ts

@@ -1,13 +1,28 @@
 import { VideoStartFailedReason } from '../enums/VideoStartFailedReason';
-import ErrorEventObject from './ErrorEventObject';
-export interface ErrorEvent {
-    code: number;
-    message: string;
-    data: unknown;
+import { ErrorData } from '../features/errordetails/ErrorData';
+import { AnalyticsConfig } from './AnalyticsConfig';
+export interface AnalyticsEventBase {
     currentTime?: number;
 }
-export interface VideoStartFailedEvent {
-    timestamp: number;
+export interface SourceChangeEvent extends AnalyticsEventBase {
+    config: AnalyticsConfig;
+}
+export interface ErrorEvent extends AnalyticsEventBase {
+    code: number | undefined;
+    message: string | undefined;
+    legacyData?: any;
+    data: ErrorData;
+}
+export interface AudioChangeEvent extends AnalyticsEventBase {
+    bitrate?: number;
+    codec?: string;
+}
+export interface VideoChangeEvent extends AnalyticsEventBase {
+    bitrate?: number;
+    height?: number;
+    width?: number;
+    codec?: string;
+}
+export interface VideoStartFailedEvent extends AnalyticsEventBase {
     reason: VideoStartFailedReason;
-    errorData?: ErrorEventObject;
 }

package/js/types/FeatureConfigContainer.d.ts

@@ -0,0 +1,4 @@
+import { ErrorDetailTrackingConfig } from '../features/errordetails/ErrorDetailTrackingConfig';
+export interface FeatureConfigContainer {
+    errorDetails?: ErrorDetailTrackingConfig;
+}

package/js/types/LicensingRequest.d.ts

@@ -1,3 +1,4 @@
+import { FeatureConfigContainer } from './FeatureConfigContainer';
 export interface LicensingRequest {
     key?: string;
     domain: string;
@@ -11,5 +12,6 @@ export declare enum LicensingResult {
 export interface LicensingResponse {
     status: LicensingResult;
     message: string;
+    features?: FeatureConfigContainer;
 }
 export declare type LicenseCallFunc = (key: string, domain: string, version: string, baseUrl: string) => Promise<LicensingResponse>;

package/js/types/NoExtraProperties.d.ts

@@ -0,0 +1,5 @@
+declare type Impossible<K extends keyof any> = {
+    [P in K]: never;
+};
+export declare type NoExtraProperties<T, U extends T = T> = U & Impossible<Exclude<keyof U, keyof T>>;
+export {};

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/CodecHelper.d.ts

@@ -1,4 +1,4 @@
 export declare class CodecHelper {
-    static readonly supportedVideoFormats: string[];
+    static get supportedVideoFormats(): string[] | undefined;
     static isCodecSupported(codec: string): boolean;
 }

package/js/utils/Queue.d.ts

@@ -0,0 +1,9 @@
+export declare class Queue<T> {
+    private readonly _items;
+    get items(): ReadonlyArray<T>;
+    get length(): number;
+    offer(item: T): void;
+    poll(): T | undefined;
+    clear(): void;
+    limit(maxElements: number): void;
+}

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.21.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"}]}

package/js/types/ErrorEventObject.d.ts

@@ -1,7 +0,0 @@
-declare class ErrorEventObject {
-    readonly code: number;
-    readonly message?: string;
-    constructor(code: number);
-    private getMessageFromCode;
-}
-export default ErrorEventObject;