@bitmovin/player-web-x 10.2.0-beta.8 → 10.2.0

package/types/packages/advertising/api/Types.d.ts

@@ -1,5 +1,10 @@
 import type { EventBus } from '../../event-bus/Types';
-import type { AdType, BaseAdBreakState, BaseAdState } from '../base/Types';
+import type { AdExtension } from '../base/AdExtension';
+import type { AdIconHorizontalPosition, AdIconVerticalPosition } from '../base/AdIconPosition';
+import type { AdResource } from '../base/AdResource';
+import type { AdType } from '../base/AdType';
+import type { BaseAdPodState } from '../base/BaseAdPodState';
+import type { BaseAdState } from '../base/BaseAdState';
 import type { AdvertisingEventMap } from './AdvertisingEvents';
 export type AdTagConfig = {
     type: AdType;
@@ -9,41 +14,135 @@ export type PreloadConfig = {
     adManifestPreloadOffset?: number;
     adSourcePreloadOffset?: number;
 };
-export type AdBreakConfig = {
+export type AdConfig = {
     id?: string;
     tag: AdTagConfig;
     position?: number | string;
     preloadConfig?: PreloadConfig;
 };
-export type Ad = {
+export type ClickThrough = {
+    readonly url: string;
+    reportClicked(): void;
+};
+export type CompanionAd = {
+    readonly id: string;
+    readonly width: number;
+    readonly height: number;
+    readonly resource: AdResource;
+    readonly altText?: string;
+    readonly clickThrough?: ClickThrough;
+    reportShown(): void;
+};
+export type AdIcon = {
+    readonly program: string;
+    readonly width: number;
+    readonly height: number;
+    readonly xPosition: number | AdIconHorizontalPosition;
+    readonly yPosition: number | AdIconVerticalPosition;
+    readonly offset?: number;
+    readonly duration?: number;
+    readonly resource: AdResource;
+    readonly clickThrough?: ClickThrough;
+};
+type AdBase = {
     readonly id: string;
-    readonly skippable: boolean;
+    readonly externalAdId: string;
     readonly skipDelay: number;
     readonly state: BaseAdState;
     readonly position: number;
+    readonly isLinear: boolean;
+    readonly error?: Error;
+    readonly clickThrough?: ClickThrough;
+    readonly companions: readonly CompanionAd[];
+    readonly icons: readonly AdIcon[];
+    readonly extensions: readonly AdExtension[];
+    readonly canPause: boolean;
+    readonly canSkip: boolean;
+    readonly canSetVolume: boolean;
+    readonly canExpand: boolean;
+    readonly hasTimeline: boolean;
 };
-export type AdBreak = {
+type CanPause = {
+    readonly canPause: true;
+    readonly paused: boolean;
+    play(): void;
+    pause(): void;
+};
+type CannotPause = {
+    readonly canPause: false;
+};
+type CanSkip = {
+    readonly canSkip: true;
+    skip(): void;
+};
+type CannotSkip = {
+    readonly canSkip: false;
+};
+type CanSetVolume = {
+    readonly canSetVolume: true;
+    volume: number;
+};
+type CannotSetVolume = {
+    readonly canSetVolume: false;
+};
+type CanExpand = {
+    readonly canExpand: true;
+    expanded: boolean;
+};
+type CannotExpand = {
+    readonly canExpand: false;
+};
+type HasTimeline = {
+    readonly hasTimeline: true;
+    readonly duration: number;
+    readonly currentTime: number;
+};
+type NoTimeline = {
+    readonly hasTimeline: false;
+};
+export type Ad = AdBase & (CanPause | CannotPause) & (CanSkip | CannotSkip) & (CanSetVolume | CannotSetVolume) & (CanExpand | CannotExpand) & (HasTimeline | NoTimeline);
+export type PausableAd = Ad & CanPause;
+export type SkippableAd = Ad & CanSkip;
+export type VolumeControllableAd = Ad & CanSetVolume;
+export type ExpandableAd = Ad & CanExpand;
+export type TimedAd = Ad & HasTimeline;
+export type AdPod = {
     readonly id: string;
     readonly position: number;
     readonly ads: Ad[];
-    readonly state: BaseAdBreakState;
+    readonly state: BaseAdPodState;
+};
+export declare enum AdBreakState {
+    Scheduled = "scheduled",
+    Playing = "playing",
+    Error = "error",
+    Completed = "completed"
+}
+export type AdBreak = {
+    readonly id: string;
+    readonly position: number;
+    readonly state: AdBreakState;
+    readonly adPods: AdPod[];
 };
 export type ContentSourceAdvertisingApi = {
     readonly isAd: false;
     readonly isLinearAdActive: boolean;
-    schedule(adBreak: AdBreakConfig): AdBreak;
-    discardAdBreak(adBreak: AdBreak): void;
+    schedule(config: AdConfig): AdPod;
+    discard(adPodOrAdBreak: AdPod | AdBreak): void;
     list(): AdBreak[];
     getActiveAdBreak(): AdBreak | undefined;
+    getActiveAdPod(): AdPod | undefined;
     getActiveAd(): Ad | undefined;
 };
-export type AdSourceAdvertisingApi = {
+type AdSourceAdvertisingApiBase = {
     readonly isAd: true;
-    readonly isSkippable: boolean;
     readonly skipDelay: number;
-    skip(): void;
+    readonly id: string;
+    readonly externalAdId: string;
 };
+export type AdSourceAdvertisingApi = AdSourceAdvertisingApiBase & (CanSkip | CannotSkip);
 export type AdvertisingApi = {
     ads: ContentSourceAdvertisingApi | AdSourceAdvertisingApi;
     events: EventBus<AdvertisingEventMap>;
 };
+export {};

package/types/packages/advertising/api/api-conversion/AdApiCache.d.ts

@@ -0,0 +1,14 @@
+import type { ContextWithState } from '../../../Types';
+import type { AdIconAtom } from '../../base/AdIconAtom';
+import type { BaseAdAtom } from '../../base/BaseAdAtom';
+import type { BaseAdPodAtom } from '../../base/BaseAdPodAtom';
+import type { ClickThroughAtom } from '../../base/ClickThroughAtom';
+import type { CompanionAdAtom } from '../../base/CompanionAdAtom';
+import type { AdBreakAtom } from '../content-source/AdBreakAtom';
+import type { Ad, AdBreak, AdIcon, AdPod, ClickThrough, CompanionAd } from '../Types';
+type ValueFor<K> = K extends BaseAdAtom ? Ad : K extends BaseAdPodAtom ? AdPod : K extends AdBreakAtom ? AdBreak : K extends ClickThroughAtom ? ClickThrough : K extends CompanionAdAtom ? CompanionAd : K extends AdIconAtom ? AdIcon : never;
+export type AdApiCache = {
+    getOrCreate<K extends object>(key: K, factory: (context: ContextWithState) => ValueFor<K>): ValueFor<K>;
+};
+export declare function createAdApiCache(context: ContextWithState): AdApiCache;
+export {};

package/types/packages/advertising/api/content-source/AdBreakAtom.d.ts

@@ -0,0 +1,19 @@
+import type { EmptyObject } from '../../../../../framework-types/BaseTypes';
+import type { ArrayAtom } from '../../../core/state/ArrayStateAtom';
+import type { PrimitiveAtom } from '../../../core/state/PrimitiveAtom';
+import type { StateAtom } from '../../../core/state/Types';
+import type { BaseAdPodAtom } from '../../base/BaseAdPodAtom';
+import { AdBreakState } from '../Types';
+import type { ContentSourceAdApiContext } from './Types';
+type AdBreak = {
+    id: string;
+    position: number;
+    state: PrimitiveAtom<AdBreakState>;
+    adPods: ArrayAtom<BaseAdPodAtom>;
+    error: PrimitiveAtom<Error | undefined>;
+};
+export type AdBreakAtom = StateAtom<AdBreak, EmptyObject>;
+export declare function createAdBreakAtom(context: ContentSourceAdApiContext, position: number, ...initialAdPods: BaseAdPodAtom[]): AdBreakAtom;
+export declare function findAdBreakAtPosition(adBreaks: ArrayAtom<AdBreakAtom>, position: number): AdBreakAtom | undefined;
+export declare function findAdBreakContainingPod(adBreaks: ArrayAtom<AdBreakAtom>, adPod: BaseAdPodAtom): AdBreakAtom | undefined;
+export {};

package/types/packages/advertising/api/content-source/Types.d.ts

@@ -0,0 +1,36 @@
+import type { ApiManager } from '../../../../../framework-types/api-manager/ApiManager';
+import type { EmptyObject } from '../../../../../framework-types/BaseTypes';
+import type { ContextHaving, ContextUsing } from '../../../../../framework-types/execution-context/Types';
+import type { StoreEffectFactory } from '../../../core/state/StoreEffectFactory';
+import type { CoreEffects, CoreExportNames, CoreStateAtoms } from '../../../core/Types';
+import type { CoreUtils } from '../../../core/utils/Types';
+import type { extendEventBusTypes } from '../../../event-bus/EventBus';
+import type { EventBus, EventBusExportNames } from '../../../event-bus/Types';
+import type { SourceStateAtom } from '../../../source/atoms/SourceStateAtom';
+import type { SourceExportNames } from '../../../source/Types';
+import type { SourcesApiExportNames } from '../../../sources-api/Types';
+import type { ContextWithState } from '../../../Types';
+import type { isAdPositionKnown } from '../../base/AdPosition';
+import type { createBaseAdPodAtom } from '../../base/BaseAdPodAtom';
+import type { BaseAdPodState } from '../../base/BaseAdPodState';
+import type { BaseAdState } from '../../base/BaseAdState';
+import type { AdvertisingBaseExportNames, ContentSourceAdExports } from '../../base/Types';
+import type { AdvertisingEventMap } from '../AdvertisingEvents';
+import type { AdApiCache } from '../api-conversion/AdApiCache';
+import type { ContentSourceAdvertisingApi } from '../Types';
+export type ContentSourceAdvertisingApiDependencies = {
+    [CoreExportNames.CoreEffects]: CoreEffects;
+    [CoreExportNames.CoreStateAtoms]: CoreStateAtoms;
+    [CoreExportNames.Utils]: CoreUtils;
+    [EventBusExportNames.ExtendEventBusTypes]: typeof extendEventBusTypes;
+    [SourcesApiExportNames.SourceApiManager]: ApiManager<{
+        ads: ContentSourceAdvertisingApi;
+    }>;
+    [SourcesApiExportNames.SourceEventBus]: EventBus<AdvertisingEventMap>;
+    [AdvertisingBaseExportNames.CreateBaseAdPod]: typeof createBaseAdPodAtom;
+    [AdvertisingBaseExportNames.BaseAdPodState]: typeof BaseAdPodState;
+    [AdvertisingBaseExportNames.BaseAdState]: typeof BaseAdState;
+    [AdvertisingBaseExportNames.IsAdPositionKnown]: typeof isAdPositionKnown;
+    [SourceExportNames.SourceState]: SourceStateAtom;
+} & ContentSourceAdExports;
+export type ContentSourceAdApiContext = ContextHaving<ContentSourceAdvertisingApiDependencies, EmptyObject, ContextUsing<[StoreEffectFactory<'adApiCache', AdApiCache>], ContextWithState>>;

package/types/packages/advertising/base/AdExtension.d.ts

@@ -0,0 +1,11 @@
+export declare enum AdExtensionSource {
+    Ad = "ad",
+    Creative = "creative"
+}
+export type AdExtension = {
+    readonly source: AdExtensionSource;
+    readonly name: string;
+    readonly value: string | undefined;
+    readonly attributes: Readonly<Record<string, string>>;
+    readonly children: readonly AdExtension[];
+};

package/types/packages/advertising/base/AdIconAtom.d.ts

@@ -0,0 +1,20 @@
+import type { EmptyObject } from '../../../../framework-types/BaseTypes';
+import type { StateAtom } from '../../core/state/Types';
+import type { AdIconHorizontalPosition, AdIconVerticalPosition } from './AdIconPosition';
+import type { AdResource } from './AdResource';
+import type { ClickThroughAtom } from './ClickThroughAtom';
+import type { AdvertisingBaseContext } from './Types';
+type AdIconState = {
+    program: string;
+    width: number;
+    height: number;
+    xPosition: number | AdIconHorizontalPosition;
+    yPosition: number | AdIconVerticalPosition;
+    offset: number | undefined;
+    duration: number | undefined;
+    resource: AdResource;
+    clickThrough: ClickThroughAtom | undefined;
+};
+export type AdIconAtom = StateAtom<AdIconState, EmptyObject>;
+export declare function createAdIconAtom(context: AdvertisingBaseContext, data: AdIconState): AdIconAtom;
+export {};

package/types/packages/advertising/base/AdIconPosition.d.ts

@@ -0,0 +1,8 @@
+export declare enum AdIconHorizontalPosition {
+    Left = "left",
+    Right = "right"
+}
+export declare enum AdIconVerticalPosition {
+    Top = "top",
+    Bottom = "bottom"
+}

package/types/packages/advertising/base/AdPosition.d.ts

@@ -1,4 +1,5 @@
 export declare const AdPositionNotYetKnown: unique symbol;
 export type AdPosition = (contentDuration: number) => typeof AdPositionNotYetKnown | number;
+export declare function isAdPositionKnown(position: typeof AdPositionNotYetKnown | number): position is number;
 export declare function resolveAdPosition(position: unknown, contentDuration: number): number | typeof AdPositionNotYetKnown;
 export declare function createAdPosition(configuredPosition?: string | number): AdPosition;

package/types/packages/advertising/base/AdQuartile.d.ts

@@ -0,0 +1,5 @@
+export declare enum AdQuartile {
+    FirstQuartile = "first-quartile",
+    Midpoint = "midpoint",
+    ThirdQuartile = "third-quartile"
+}

package/types/packages/advertising/base/AdResource.d.ts

@@ -0,0 +1,16 @@
+export declare enum AdResourceType {
+    Static = "static",
+    Iframe = "iframe",
+    Html = "html"
+}
+export type AdResource = {
+    type: AdResourceType.Static;
+    url: string;
+    creativeType: string;
+} | {
+    type: AdResourceType.Iframe;
+    url: string;
+} | {
+    type: AdResourceType.Html;
+    markup: string;
+};

package/types/packages/advertising/base/AdSchedule.d.ts

@@ -1,3 +1,3 @@
 import type { ArrayAtom } from '../../core/state/ArrayStateAtom';
-import type { BaseAdBreakAtom } from './BaseAdBreakAtom';
-export type AdSchedule = ArrayAtom<BaseAdBreakAtom>;
+import type { BaseAdPodAtom } from './BaseAdPodAtom';
+export type AdSchedule = ArrayAtom<BaseAdPodAtom>;

package/types/packages/advertising/base/AdTagAtom.d.ts

@@ -1,7 +1,7 @@
 import type { EmptyObject } from '../../../../framework-types/BaseTypes';
 import type { StateAtom } from '../../core/state/Types';
 import type { ContextWithState } from '../../Types';
-import type { AdType } from './Types';
+import type { AdType } from './AdType';
 type AdTag = {
     type: AdType;
     url: string;

package/types/packages/advertising/base/AdType.d.ts

@@ -0,0 +1,4 @@
+export declare enum AdType {
+    VAST = "vast",
+    VMAP = "vmap"
+}

package/types/packages/advertising/base/AdvertisingBase.package.d.ts

@@ -10,3 +10,5 @@ import type { EmptyObject } from '../../../../framework-types/BaseTypes';
 import type { AdvertisingBasePackageExports } from './Types';
 export declare const AdvertisingBasePackage: import("../../../../framework-types/package-api/Package").Package<EmptyObject, AdvertisingBasePackageExports, EmptyObject>;
 export default AdvertisingBasePackage;
+
+export declare const version: string;

package/types/packages/advertising/base/BaseAdAtom.d.ts

@@ -1,22 +1,44 @@
 import type { EmptyObject } from '../../../../framework-types/BaseTypes';
+import type { ArrayAtom } from '../../core/state/ArrayStateAtom';
 import type { PrimitiveAtom } from '../../core/state/PrimitiveAtom';
 import type { StateAtom } from '../../core/state/Types';
 import type { Transient } from '../../core/utils/StateUtils';
+import type { AdExtension } from './AdExtension';
+import type { AdIconAtom } from './AdIconAtom';
 import type { AdPosition } from './AdPosition';
-import type { AdQuartile, AdvertisingBaseContext } from './Types';
-import { BaseAdState } from './Types';
+import type { AdQuartile } from './AdQuartile';
+import { BaseAdState } from './BaseAdState';
+import type { ClickThroughAtom } from './ClickThroughAtom';
+import type { CompanionAdAtom } from './CompanionAdAtom';
+import type { AdvertisingBaseContext } from './Types';
 type AdState = {
     id: string;
+    externalAdId: string;
     position: AdPosition;
-    isSkippable: PrimitiveAtom<boolean>;
     skipDelay: PrimitiveAtom<number>;
     quartile: PrimitiveAtom<AdQuartile | undefined>;
     state: PrimitiveAtom<BaseAdState>;
     error: PrimitiveAtom<Error | undefined>;
     sourcePreloadOffset: PrimitiveAtom<number>;
+    isLinear: PrimitiveAtom<boolean>;
+    canPause: PrimitiveAtom<boolean>;
+    paused: PrimitiveAtom<boolean>;
+    play: Transient<void>;
+    pause: Transient<void>;
+    canSkip: PrimitiveAtom<boolean>;
     skip: Transient<void>;
-    clicked: Transient<string | undefined>;
+    canSetVolume: PrimitiveAtom<boolean>;
+    volume: PrimitiveAtom<number>;
+    canExpand: PrimitiveAtom<boolean>;
+    expanded: PrimitiveAtom<boolean>;
+    hasTimeline: PrimitiveAtom<boolean>;
+    duration: PrimitiveAtom<number>;
+    currentTime: PrimitiveAtom<number>;
+    clickThrough: ClickThroughAtom | undefined;
+    companions: ArrayAtom<CompanionAdAtom>;
+    icons: ArrayAtom<AdIconAtom>;
+    extensions: ArrayAtom<AdExtension>;
 };
 export type BaseAdAtom = StateAtom<AdState, EmptyObject>;
-export declare function createBaseAdAtom(context: AdvertisingBaseContext, id: string, position: AdPosition, adSkipDelay: number, preloadOffset: number): BaseAdAtom;
+export declare function createBaseAdAtom(context: AdvertisingBaseContext, id: string, externalAdId: string, position: AdPosition, adSkipDelay: number, preloadOffset: number, clickThrough: ClickThroughAtom | undefined, initialCompanions: CompanionAdAtom[], initialIcons: AdIconAtom[], initialExtensions: AdExtension[]): BaseAdAtom;
 export {};

package/types/packages/advertising/base/{BaseAdBreakAtom.d.ts → BaseAdPodAtom.d.ts}

@@ -8,22 +8,24 @@ import { CoreExportNames } from '../../core/Types';
 import type { ContextWithState } from '../../Types';
 import type { AdPosition } from './AdPosition';
 import type { AdTagAtom } from './AdTagAtom';
+import type { AdType } from './AdType';
 import type { BaseAdAtom } from './BaseAdAtom';
+import type { BaseAdPodState } from './BaseAdPodState';
 import type { PreloadConfigAtom } from './PreloadConfigAtom';
-import type { AdType } from './Types';
-import { BaseAdBreakState } from './Types';
-type BaseAdBreak = {
+import { AdvertisingBaseExportNames } from './Types';
+type BaseAdPod = {
     id: string;
     position: AdPosition;
     tag: AdTagAtom;
-    state: PrimitiveAtom<BaseAdBreakState>;
+    state: PrimitiveAtom<BaseAdPodState>;
     ads: ArrayAtom<BaseAdAtom>;
     preloadConfig: PreloadConfigAtom;
     error: PrimitiveAtom<Error | undefined>;
 };
-export type BaseAdBreakAtom = StateAtom<BaseAdBreak, EmptyObject>;
+export type BaseAdPodAtom = StateAtom<BaseAdPod, EmptyObject>;
 type Context = ContextHaving<{
     [CoreExportNames.CoreStateAtoms]: CoreStateAtoms;
+    [AdvertisingBaseExportNames.BaseAdPodState]: typeof BaseAdPodState;
 }, EmptyObject, ContextWithState>;
-export declare function createBaseAdBreakAtom(context: Context, id: string, scheduledPosition: string | number | undefined, tagType: AdType, url: string, adManifestPreloadOffset?: number, adSourcePreloadOffset?: number): BaseAdBreakAtom;
+export declare function createBaseAdPodAtom(context: Context, id: string, scheduledPosition: string | number | undefined, tagType: AdType, url: string, adManifestPreloadOffset?: number, adSourcePreloadOffset?: number): BaseAdPodAtom;
 export {};

package/types/packages/advertising/base/BaseAdPodState.d.ts

@@ -0,0 +1,7 @@
+export declare enum BaseAdPodState {
+    Scheduled = "scheduled",
+    Loaded = "loaded",
+    Playing = "playing",
+    Error = "error",
+    Completed = "completed"
+}

package/types/packages/advertising/base/BaseAdState.d.ts

@@ -0,0 +1,7 @@
+export declare enum BaseAdState {
+    Scheduled = "scheduled",
+    Playing = "playing",
+    Completed = "completed",
+    Skipped = "skipped",
+    Error = "error"
+}

package/types/packages/advertising/base/ClickThroughAtom.d.ts

@@ -0,0 +1,11 @@
+import type { EmptyObject } from '../../../../framework-types/BaseTypes';
+import type { StateAtom } from '../../core/state/Types';
+import type { Transient } from '../../core/utils/StateUtils';
+import type { AdvertisingBaseContext } from './Types';
+type ClickThroughState = {
+    url: string;
+    clicked: Transient<void>;
+};
+export type ClickThroughAtom = StateAtom<ClickThroughState, EmptyObject>;
+export declare function createClickThroughAtom(context: AdvertisingBaseContext, url: string): ClickThroughAtom;
+export {};

package/types/packages/advertising/base/CompanionAdAtom.d.ts

@@ -0,0 +1,18 @@
+import type { EmptyObject } from '../../../../framework-types/BaseTypes';
+import type { StateAtom } from '../../core/state/Types';
+import type { Transient } from '../../core/utils/StateUtils';
+import type { AdResource } from './AdResource';
+import type { ClickThroughAtom } from './ClickThroughAtom';
+import type { AdvertisingBaseContext } from './Types';
+type CompanionAdState = {
+    id: string;
+    width: number;
+    height: number;
+    resource: AdResource;
+    altText: string | undefined;
+    clickThrough: ClickThroughAtom | undefined;
+    shown: Transient<void>;
+};
+export type CompanionAdAtom = StateAtom<CompanionAdState, EmptyObject>;
+export declare function createCompanionAdAtom(context: AdvertisingBaseContext, id: string, width: number, height: number, resource: AdResource, altText: string | undefined, clickThrough: ClickThroughAtom | undefined): CompanionAdAtom;
+export {};

package/types/packages/advertising/base/Types.d.ts

@@ -4,32 +4,16 @@ import type { CoreUtils } from '../../core/utils/Types';
 import type { SourceStateAtom } from '../../source/atoms/SourceStateAtom';
 import type { SourceExportNames } from '../../source/Types';
 import type { ContextWithState } from '../../Types';
+import type { AdExtensionSource } from './AdExtension';
+import type { isAdPositionKnown } from './AdPosition';
+import type { AdQuartile } from './AdQuartile';
 import type { AdSchedule } from './AdSchedule';
+import type { AdType } from './AdType';
 import type { BaseAdAtom, createBaseAdAtom } from './BaseAdAtom';
-import type { createBaseAdBreakAtom } from './BaseAdBreakAtom';
-export declare enum AdType {
-    VAST = "vast",
-    VMAP = "vmap"
-}
-export declare enum AdQuartile {
-    FirstQuartile = "first-quartile",
-    Midpoint = "midpoint",
-    ThirdQuartile = "third-quartile"
-}
-export declare enum BaseAdBreakState {
-    Scheduled = "scheduled",
-    Loaded = "loaded",
-    Playing = "playing",
-    Error = "error",
-    Completed = "completed"
-}
-export declare enum BaseAdState {
-    Scheduled = "scheduled",
-    Playing = "playing",
-    Completed = "completed",
-    Skipped = "skipped",
-    Error = "error"
-}
+import type { createBaseAdPodAtom } from './BaseAdPodAtom';
+import type { BaseAdPodState } from './BaseAdPodState';
+import type { BaseAdState } from './BaseAdState';
+import type { createClickThroughAtom } from './ClickThroughAtom';
 export type AdvertisingBasePackageDependencies = {
     [CoreExportNames.CoreEffects]: CoreEffects;
     [CoreExportNames.CoreStateAtoms]: CoreStateAtoms;
@@ -39,18 +23,24 @@ export type AdvertisingBasePackageDependencies = {
 export declare enum AdvertisingBaseExportNames {
     AdType = "ad-type",
     AdQuartile = "ad-quartile",
-    BaseAdBreakState = "base-ad-break-state",
+    AdExtensionSource = "ad-extension-source",
+    BaseAdPodState = "base-ad-pod-state",
     BaseAdState = "base-ad-state",
-    CreateBaseAdBreak = "create-base-ad-break",
-    CreateBaseAd = "create-base-ad"
+    CreateBaseAdPod = "create-base-ad-pod",
+    CreateBaseAd = "create-base-ad",
+    CreateClickThrough = "create-click-through",
+    IsAdPositionKnown = "is-position-known"
 }
 export type AdvertisingBasePackageExports = {
     [AdvertisingBaseExportNames.AdType]: typeof AdType;
     [AdvertisingBaseExportNames.AdQuartile]: typeof AdQuartile;
-    [AdvertisingBaseExportNames.BaseAdBreakState]: typeof BaseAdBreakState;
+    [AdvertisingBaseExportNames.AdExtensionSource]: typeof AdExtensionSource;
+    [AdvertisingBaseExportNames.BaseAdPodState]: typeof BaseAdPodState;
     [AdvertisingBaseExportNames.BaseAdState]: typeof BaseAdState;
-    [AdvertisingBaseExportNames.CreateBaseAdBreak]: typeof createBaseAdBreakAtom;
+    [AdvertisingBaseExportNames.CreateBaseAdPod]: typeof createBaseAdPodAtom;
     [AdvertisingBaseExportNames.CreateBaseAd]: typeof createBaseAdAtom;
+    [AdvertisingBaseExportNames.CreateClickThrough]: typeof createClickThroughAtom;
+    [AdvertisingBaseExportNames.IsAdPositionKnown]: typeof isAdPositionKnown;
 };
 export type AdvertisingBaseContext = ContextHaving<AdvertisingBasePackageDependencies, AdvertisingBasePackageExports, ContextWithState>;
 export declare enum ContentSourceExportNames {

package/types/packages/advertising/bitmovin/AdvertisingBitmovin.package.d.ts

@@ -12,3 +12,5 @@ import type { EmptyObject } from '../../../../framework-types/BaseTypes';
 import type { AdvertisingBitmovinPackageDependencies, AdvertisingBitmovinPackageExports } from './Types';
 export declare const AdvertisingBitmovinPackage: import("../../../../framework-types/package-api/Package").Package<AdvertisingBitmovinPackageDependencies, AdvertisingBitmovinPackageExports, EmptyObject>;
 export default AdvertisingBitmovinPackage;
+
+export declare const version: string;

package/types/packages/advertising/bitmovin/Types.d.ts

@@ -5,21 +5,25 @@ import type { MetricsAtom } from '../../core/metrics/MetricsAtom';
 import type { CoreEffects, CoreExportNames, CoreStateAtoms } from '../../core/Types';
 import type { CoreUtils } from '../../core/utils/Types';
 import type { NetworkTask } from '../../network/NetworkTask';
-import type { NetworkExportNames } from '../../network/Types';
+import type { HttpRequestMethod, HttpResponseType, NetworkExportNames } from '../../network/Types';
 import type { TargetPlaybackState, TargetPlaybackStateAtom } from '../../playback/play-pause/TargetPlaybackStateAtom';
 import type { PlayPauseExportNames } from '../../playback/play-pause/Types';
-import type { SeekRestrictionAtom } from '../../playback/video-element-state/SeekRestrictionAtom';
-import type { VideoElementStateExportNames } from '../../playback/video-element-state/Types';
-import type { VideoElementStateAtom } from '../../playback/video-element-state/VideoElementStateAtom';
 import type { SourceStateAtom } from '../../source/atoms/SourceStateAtom';
 import type { createSourceReference } from '../../source/SourceReference';
 import type { SourceExportNames, SourceReferences } from '../../source/Types';
 import type { SourceRemovedError } from '../../sources-api/SourceRemovedError';
 import type { SourcesApiExportNames } from '../../sources-api/Types';
 import type { ContextWithState } from '../../Types';
+import type { AdExtensionSource } from '../base/AdExtension';
+import type { isAdPositionKnown } from '../base/AdPosition';
+import type { AdQuartile } from '../base/AdQuartile';
+import type { AdType } from '../base/AdType';
 import type { createBaseAdAtom } from '../base/BaseAdAtom';
-import type { createBaseAdBreakAtom } from '../base/BaseAdBreakAtom';
-import type { AdQuartile, AdSourceAdExports, AdType, AdvertisingBaseExportNames, BaseAdBreakState, BaseAdState, ContentSourceAdExports } from '../base/Types';
+import type { createBaseAdPodAtom } from '../base/BaseAdPodAtom';
+import type { BaseAdPodState } from '../base/BaseAdPodState';
+import type { BaseAdState } from '../base/BaseAdState';
+import type { createClickThroughAtom } from '../base/ClickThroughAtom';
+import type { AdSourceAdExports, AdvertisingBaseExportNames, ContentSourceAdExports } from '../base/Types';
 export type AdvertisingBitmovinPackageDependencies = {
     [CoreExportNames.CoreEffects]: CoreEffects;
     [CoreExportNames.CoreStateAtoms]: CoreStateAtoms;
@@ -29,18 +33,21 @@ export type AdvertisingBitmovinPackageDependencies = {
     [SourceExportNames.CreateSourceReference]: typeof createSourceReference;
     [SourceExportNames.SourceReferences]: SourceReferences;
     [SourcesApiExportNames.SourceRemovedError]: typeof SourceRemovedError;
-    [VideoElementStateExportNames.VideoElementState]: VideoElementStateAtom;
-    [VideoElementStateExportNames.SeekRestriction]: SeekRestrictionAtom;
     [NetworkExportNames.NetworkTask]: typeof NetworkTask;
+    [NetworkExportNames.HttpRequestMethod]: typeof HttpRequestMethod;
+    [NetworkExportNames.HttpResponseType]: typeof HttpResponseType;
     [AdaptationExportNames.Metrics]: MetricsAtom;
     [PlayPauseExportNames.TargetPlaybackState]: typeof TargetPlaybackState;
     [PlayPauseExportNames.TargetPlaybackStateAtom]: TargetPlaybackStateAtom;
     [AdvertisingBaseExportNames.AdType]: typeof AdType;
     [AdvertisingBaseExportNames.AdQuartile]: typeof AdQuartile;
-    [AdvertisingBaseExportNames.BaseAdBreakState]: typeof BaseAdBreakState;
+    [AdvertisingBaseExportNames.AdExtensionSource]: typeof AdExtensionSource;
+    [AdvertisingBaseExportNames.BaseAdPodState]: typeof BaseAdPodState;
     [AdvertisingBaseExportNames.BaseAdState]: typeof BaseAdState;
-    [AdvertisingBaseExportNames.CreateBaseAdBreak]: typeof createBaseAdBreakAtom;
+    [AdvertisingBaseExportNames.CreateBaseAdPod]: typeof createBaseAdPodAtom;
     [AdvertisingBaseExportNames.CreateBaseAd]: typeof createBaseAdAtom;
+    [AdvertisingBaseExportNames.CreateClickThrough]: typeof createClickThroughAtom;
+    [AdvertisingBaseExportNames.IsAdPositionKnown]: typeof isAdPositionKnown;
 };
 export type AdvertisingBitmovinPackageExports = ContentSourceAdExports & AdSourceAdExports;
 export type AdvertisingBitmovinContext = ContextHaving<AdvertisingBitmovinPackageDependencies, AdvertisingBitmovinPackageExports, ContextWithState>;

package/types/packages/analytics/Analytics.package.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @packageDocumentation Analytics.package
+ *
+ * Analytics package enables Bitmovin Analytics Collector.
+ *
+ * Collector features are limited based on what API's are available on the PWX.
+ *
+ * ### `Analytics` Package Dependency Graph
+ * <svg aria-roledescription="flowchart-v2" role="graphics-document document" viewBox="-8 -8 16 16" style="max-width: 16px; background-color: transparent;" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" width="100%" id="my-svg"><style>#my-svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#ccc;}#my-svg .error-icon{fill:#a44141;}#my-svg .error-text{fill:#ddd;stroke:#ddd;}#my-svg .edge-thickness-normal{stroke-width:2px;}#my-svg .edge-thickness-thick{stroke-width:3.5px;}#my-svg .edge-pattern-solid{stroke-dasharray:0;}#my-svg .edge-pattern-dashed{stroke-dasharray:3;}#my-svg .edge-pattern-dotted{stroke-dasharray:2;}#my-svg .marker{fill:lightgrey;stroke:lightgrey;}#my-svg .marker.cross{stroke:lightgrey;}#my-svg svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;}#my-svg .label{font-family:"trebuchet ms",verdana,arial,sans-serif;color:#ccc;}#my-svg .cluster-label text{fill:#F9FFFE;}#my-svg .cluster-label span,#my-svg p{color:#F9FFFE;}#my-svg .label text,#my-svg span,#my-svg p{fill:#ccc;color:#ccc;}#my-svg .node rect,#my-svg .node circle,#my-svg .node ellipse,#my-svg .node polygon,#my-svg .node path{fill:#1f2020;stroke:#81B1DB;stroke-width:1px;}#my-svg .flowchart-label text{text-anchor:middle;}#my-svg .node .katex path{fill:#000;stroke:#000;stroke-width:1px;}#my-svg .node .label{text-align:center;}#my-svg .node.clickable{cursor:pointer;}#my-svg .arrowheadPath{fill:lightgrey;}#my-svg .edgePath .path{stroke:lightgrey;stroke-width:2.0px;}#my-svg .flowchart-link{stroke:lightgrey;fill:none;}#my-svg .edgeLabel{background-color:hsl(0, 0%, 34.4117647059%);text-align:center;}#my-svg .edgeLabel rect{opacity:0.5;background-color:hsl(0, 0%, 34.4117647059%);fill:hsl(0, 0%, 34.4117647059%);}#my-svg .labelBkg{background-color:rgba(87.75, 87.75, 87.75, 0.5);}#my-svg .cluster rect{fill:hsl(180, 1.5873015873%, 28.3529411765%);stroke:rgba(255, 255, 255, 0.25);stroke-width:1px;}#my-svg .cluster text{fill:#F9FFFE;}#my-svg .cluster span,#my-svg p{color:#F9FFFE;}#my-svg div.mermaidTooltip{position:absolute;text-align:center;max-width:200px;padding:2px;font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:12px;background:hsl(20, 1.5873015873%, 12.3529411765%);border:1px solid rgba(255, 255, 255, 0.25);border-radius:2px;pointer-events:none;z-index:100;}#my-svg .flowchartTitleText{text-anchor:middle;font-size:18px;fill:#ccc;}#my-svg :root{--mermaid-font-family:"trebuchet ms",verdana,arial,sans-serif;}</style><g><marker orient="auto" markerHeight="12" markerWidth="12" markerUnits="userSpaceOnUse" refY="5" refX="6" viewBox="0 0 10 10" class="marker flowchart" id="my-svg_flowchart-pointEnd"><path style="stroke-width: 1; stroke-dasharray: 1, 0;" class="arrowMarkerPath" d="M 0 0 L 10 5 L 0 10 z"/></marker><marker orient="auto" markerHeight="12" markerWidth="12" markerUnits="userSpaceOnUse" refY="5" refX="4.5" viewBox="0 0 10 10" class="marker flowchart" id="my-svg_flowchart-pointStart"><path style="stroke-width: 1; stroke-dasharray: 1, 0;" class="arrowMarkerPath" d="M 0 5 L 10 10 L 10 0 z"/></marker><marker orient="auto" markerHeight="11" markerWidth="11" markerUnits="userSpaceOnUse" refY="5" refX="11" viewBox="0 0 10 10" class="marker flowchart" id="my-svg_flowchart-circleEnd"><circle style="stroke-width: 1; stroke-dasharray: 1, 0;" class="arrowMarkerPath" r="5" cy="5" cx="5"/></marker><marker orient="auto" markerHeight="11" markerWidth="11" markerUnits="userSpaceOnUse" refY="5" refX="-1" viewBox="0 0 10 10" class="marker flowchart" id="my-svg_flowchart-circleStart"><circle style="stroke-width: 1; stroke-dasharray: 1, 0;" class="arrowMarkerPath" r="5" cy="5" cx="5"/></marker><marker orient="auto" markerHeight="11" markerWidth="11" markerUnits="userSpaceOnUse" refY="5.2" refX="12" viewBox="0 0 11 11" class="marker cross flowchart" id="my-svg_flowchart-crossEnd"><path style="stroke-width: 2; stroke-dasharray: 1, 0;" class="arrowMarkerPath" d="M 1,1 l 9,9 M 10,1 l -9,9"/></marker><marker orient="auto" markerHeight="11" markerWidth="11" markerUnits="userSpaceOnUse" refY="5.2" refX="-1" viewBox="0 0 11 11" class="marker cross flowchart" id="my-svg_flowchart-crossStart"><path style="stroke-width: 2; stroke-dasharray: 1, 0;" class="arrowMarkerPath" d="M 1,1 l 9,9 M 10,1 l -9,9"/></marker><g class="root"><g class="clusters"/><g class="edgePaths"/><g class="edgeLabels"/><g class="nodes"/></g></g></svg>
+ */
+import type { EmptyObject } from '../../../framework-types/BaseTypes';
+import type { Package } from '../../../framework-types/package-api/Package';
+import type { AnalyticsPackageDependencies } from './Types';
+export declare const AnalyticsPackage: Package<AnalyticsPackageDependencies, EmptyObject, EmptyObject>;
+export default AnalyticsPackage;
+
+export declare const version: string;