@dolby-optiview/ads-sdk-core 1.1.0 → 1.2.0

package/dist/session/SessionState.js

@@ -1 +1 @@
-export class SessionState{constructor(){this.sessionActive=!1,this.sessionGeneration=0,this.sessionDeliveryMode=null,this.steeredSsaiActive=!1,this.steeredSsaiOptions=null,this.pauseAdTickInterval=null,this.heldPreRollArmInterval=null,this.manifestOrigin=null,this.stitcherOrigin=null,this.heldImmediatePreRollId=null,this.heldPreRollArmed=!1,this.heldPreRollWaitStartedAt=null,this.snapbackSeekInFlight=!1,this.sessionConfig=null,this.sessionManifest=null,this.channelSwitchInFlight=!1,this.pendingChannelSwitch=null}clearSessionIdentity(){this.sessionDeliveryMode=null,this.sessionManifest=null,this.channelSwitchInFlight=!1,this.pendingChannelSwitch=null}}
+export class SessionState{constructor(){this.sessionActive=!1,this.sessionGeneration=0,this.adStartDelayElapsed=!1,this.sessionDeliveryMode=null,this.steeredSsaiActive=!1,this.steeredSsaiOptions=null,this.pauseAdTickInterval=null,this.heldPreRollArmInterval=null,this.manifestOrigin=null,this.stitcherOrigin=null,this.heldImmediatePreRollId=null,this.heldPreRollArmed=!1,this.heldPreRollWaitStartedAt=null,this.snapbackSeekInFlight=!1,this.sessionConfig=null,this.sessionManifest=null,this.channelSwitchInFlight=!1,this.pendingChannelSwitch=null}clearSessionIdentity(){this.sessionDeliveryMode=null,this.sessionManifest=null,this.channelSwitchInFlight=!1,this.pendingChannelSwitch=null}}

package/dist/types/BreakManifest.d.ts

@@ -54,8 +54,13 @@ export interface GamVendorConfiguration extends VendorConfigurationBase {
     sgai?: GamSgaiConfiguration[];
     ssai?: GamSsaiConfiguration[];
 }
+export interface ExternalVendorConfigurationEntry extends VendorConfigurationBase {
+    type: 'external';
+    provider: string;
+    assetParameters: Record<string, string>;
+}
 /** Known vendor configuration entries, kept open to unrecognized vendors from newer manifests. @category Break Manifests & Ad Formats */
-export type VendorConfiguration = GamVendorConfiguration | VendorConfigurationBase;
+export type VendorConfiguration = GamVendorConfiguration | ExternalVendorConfigurationEntry | VendorConfigurationBase;
 /** Type guard: narrows a {@link VendorConfiguration} to a {@link GamVendorConfiguration}. */
 export declare function isGamVendorConfiguration(entry: VendorConfiguration): entry is GamVendorConfiguration;
 /** The root Break Manifest structure. @category Break Manifests & Ad Formats */
@@ -167,14 +172,47 @@ export declare enum BreakFormat {
 }
 /** Device type for targeting. @category Break Manifests & Ad Formats */
 export declare enum DeviceType {
+    CONSOLE = "console",
     DESKTOP = "desktop",
     MOBILE = "mobile",
     TABLET = "tablet",
     TV = "tv"
 }
+/** Platforms supported by manifest targeting (manifest spec v1.7.0). */
+export declare enum Platform {
+    WEB = "web",
+    ANDROID = "android",
+    IOS = "ios",
+    TVOS = "tvos",
+    ROKU = "roku"
+}
+/** Operating systems supported by manifest targeting (manifest spec v1.8.0). */
+export declare enum Os {
+    ANDROID = "android",
+    CHROMEOS = "chromeos",
+    IOS = "ios",
+    IPADOS = "ipados",
+    LINUX = "linux",
+    MACOS = "macos",
+    ROKUOS = "rokuos",
+    TIZEN = "tizen",
+    TVOS = "tvos",
+    VIZIO = "vizio",
+    WEBOS = "webos",
+    WINDOWS = "windows",
+    XBOX = "xbox"
+}
+/** Inclusive operating-system version bounds; each bound is dot-separated decimal integers. */
+export interface OsVersionRange {
+    min?: string;
+    max?: string;
+}
 /** Targeting criteria for break variants. @category Break Manifests & Ad Formats */
 export interface Targeting {
     deviceType?: DeviceType;
+    platform?: Platform;
+    os?: Os;
+    osVersion?: OsVersionRange;
 }
 /** Base fields for all break variants. @category Break Manifests & Ad Formats */
 export interface BaseBreakVariant {

package/dist/types/BreakManifest.js

@@ -1 +1 @@
-export var Timebase;!function(e){e.WALLCLOCK="wallclock",e.PTS="pts",e.MEDIATIME="mediatime"}(Timebase||(Timebase={}));export function isGamVendorConfiguration(e){return"gam"===e.type}export var DeliveryMode;!function(e){e.SGAI="sgai",e.SSAI="ssai"}(DeliveryMode||(DeliveryMode={}));export var BreakEvent;!function(e){e.START="start",e.PAUSE="pause",e.END="end"}(BreakEvent||(BreakEvent={}));export var BreakFormat;!function(e){e.SINGLE="single",e.DOUBLE="double",e.LSHAPE_AD="lshape_ad",e.LSHAPE_CONTENT="lshape_content",e.OVERLAY="overlay"}(BreakFormat||(BreakFormat={}));export var DeviceType;!function(e){e.DESKTOP="desktop",e.MOBILE="mobile",e.TABLET="tablet",e.TV="tv"}(DeviceType||(DeviceType={}));export var AssetType;!function(e){e.STATIC="static",e.VAST="vast",e.VENDOR="vendor"}(AssetType||(AssetType={}));export var MediaType;!function(e){e.VIDEO="video",e.IMAGE="image"}(MediaType||(MediaType={}));export var Vendor;!function(e){e.GAM="gam"}(Vendor||(Vendor={}));export function isEventTrigger(e){return"object"==typeof e&&null!==e&&"event"===e.type}export function getBreakEvent(e){return"pre"===e.position?BreakEvent.START:isEventTrigger(e.start)?e.start.event:null}export function isPauseBreak(e){return getBreakEvent(e)===BreakEvent.PAUSE}export function getPreRollDelay(e){return getBreakEvent(e)!==BreakEvent.START?null:"pre"===e.position?e.delay??0:isEventTrigger(e.start)?e.start.delay??0:0}export function isPostRollBreak(e){return getBreakEvent(e)===BreakEvent.END}export function getPostRollDelay(e){return isEventTrigger(e.start)&&e.start.event===BreakEvent.END?e.start.delay??0:null}export function isStaticAsset(e){return e.type===AssetType.STATIC}export function isVastAsset(e){return e.type===AssetType.VAST}export function isVendorAsset(e){return e.type===AssetType.VENDOR}
+export var Timebase;!function(e){e.WALLCLOCK="wallclock",e.PTS="pts",e.MEDIATIME="mediatime"}(Timebase||(Timebase={}));export function isGamVendorConfiguration(e){return"gam"===e.type}export var DeliveryMode;!function(e){e.SGAI="sgai",e.SSAI="ssai"}(DeliveryMode||(DeliveryMode={}));export var BreakEvent;!function(e){e.START="start",e.PAUSE="pause",e.END="end"}(BreakEvent||(BreakEvent={}));export var BreakFormat;!function(e){e.SINGLE="single",e.DOUBLE="double",e.LSHAPE_AD="lshape_ad",e.LSHAPE_CONTENT="lshape_content",e.OVERLAY="overlay"}(BreakFormat||(BreakFormat={}));export var DeviceType;!function(e){e.CONSOLE="console",e.DESKTOP="desktop",e.MOBILE="mobile",e.TABLET="tablet",e.TV="tv"}(DeviceType||(DeviceType={}));export var Platform;!function(e){e.WEB="web",e.ANDROID="android",e.IOS="ios",e.TVOS="tvos",e.ROKU="roku"}(Platform||(Platform={}));export var Os;!function(e){e.ANDROID="android",e.CHROMEOS="chromeos",e.IOS="ios",e.IPADOS="ipados",e.LINUX="linux",e.MACOS="macos",e.ROKUOS="rokuos",e.TIZEN="tizen",e.TVOS="tvos",e.VIZIO="vizio",e.WEBOS="webos",e.WINDOWS="windows",e.XBOX="xbox"}(Os||(Os={}));export var AssetType;!function(e){e.STATIC="static",e.VAST="vast",e.VENDOR="vendor"}(AssetType||(AssetType={}));export var MediaType;!function(e){e.VIDEO="video",e.IMAGE="image"}(MediaType||(MediaType={}));export var Vendor;!function(e){e.GAM="gam"}(Vendor||(Vendor={}));export function isEventTrigger(e){return"object"==typeof e&&null!==e&&"event"===e.type}export function getBreakEvent(e){return"pre"===e.position?BreakEvent.START:isEventTrigger(e.start)?e.start.event:null}export function isPauseBreak(e){return getBreakEvent(e)===BreakEvent.PAUSE}export function getPreRollDelay(e){return getBreakEvent(e)!==BreakEvent.START?null:"pre"===e.position?e.delay??0:isEventTrigger(e.start)?e.start.delay??0:0}export function isPostRollBreak(e){return getBreakEvent(e)===BreakEvent.END}export function getPostRollDelay(e){return isEventTrigger(e.start)&&e.start.event===BreakEvent.END?e.start.delay??0:null}export function isStaticAsset(e){return e.type===AssetType.STATIC}export function isVastAsset(e){return e.type===AssetType.VAST}export function isVendorAsset(e){return e.type===AssetType.VENDOR}

package/dist/types/Events.d.ts

@@ -7,6 +7,14 @@ import type { OptiViewAdsMode } from './OptiViewAdsConfig';
  * - `active`: a break is currently playing.
  * @category Events */
 export type AdBreakPhase = 'idle' | 'upcoming' | 'active' | 'complete';
+/** Why a scheduled ad break was refused before it began (`adbreakskipped` event). @category Events */
+export type AdBreakSkipReason = 'late' | 'not-ready' | 'preparation-failed' | 'unsupported' | 'overlap' | 'start-delay' | 'removed' | 'insufficient-remaining' | 'resource-limit';
+export interface AdBreakSkippedEvent extends OptiViewAdsEvent {
+    type: 'adbreakskipped';
+    break: Break;
+    reason: AdBreakSkipReason;
+    format?: BreakFormat | undefined;
+}
 /** Playback-gated snapshot of an ad break for UI countdowns (`adbreakstatus` event, `sdk.getAdBreakStatus()`). @category Events */
 export interface AdBreakStatus {
     /** Current lifecycle phase of the ad break. */
@@ -31,7 +39,7 @@ export interface AdBreakStatus {
     warningSec?: number | undefined;
 }
 /** Event types emitted by the OptiViewAds SDK. @category Events */
-export type OptiViewAdsEventType = 'adbreakbegin' | 'adbreakend' | 'adbegin' | 'adend' | 'aderror' | 'adfirstquartile' | 'admidpoint' | 'adthirdquartile' | 'adtimeupdate' | 'adbreakstatus' | 'adclick' | 'waiting' | 'playing' | 'volumechange' | 'adchannelchange';
+export type OptiViewAdsEventType = 'adbreakbegin' | 'adbreakend' | 'adbreakskipped' | 'adbegin' | 'adend' | 'aderror' | 'adfirstquartile' | 'admidpoint' | 'adthirdquartile' | 'adtimeupdate' | 'adbreakstatus' | 'adclick' | 'waiting' | 'playing' | 'volumechange' | 'adchannelchange' | 'externalvendorconfigurationchange';
 /** Which player a playback event originated from. @category Events */
 export type PlaybackSource = 'ad' | 'content';
 /** Base event interface. @category Events */
@@ -223,10 +231,16 @@ export interface AdChannelChangeEvent extends OptiViewAdsEvent {
     /** Delivery mode in effect after the switch. */
     deliveryMode: OptiViewAdsMode;
 }
+/** An external provider's manifest parameter template was added, changed, or removed. @category Events */
+export interface ExternalVendorConfigurationChangeEvent extends OptiViewAdsEvent {
+    type: 'externalvendorconfigurationchange';
+    provider: string;
+}
 /** Union type of all SDK events. @category Events */
 export type OptiViewAdsEventMap = {
     adbreakbegin: AdBreakBeginEvent;
     adbreakend: AdBreakEndEvent;
+    adbreakskipped: AdBreakSkippedEvent;
     adbegin: AdBeginEvent;
     adend: AdEndEvent;
     aderror: AdErrorEvent;
@@ -240,6 +254,7 @@ export type OptiViewAdsEventMap = {
     playing: PlayingEvent;
     volumechange: VolumeChangeEvent;
     adchannelchange: AdChannelChangeEvent;
+    externalvendorconfigurationchange: ExternalVendorConfigurationChangeEvent;
 };
 /** Event handler type. @category Events */
 export type OptiViewAdsEventHandler<T extends OptiViewAdsEventType> = (event: OptiViewAdsEventMap[T]) => void;

package/dist/types/ExternalVendorConfiguration.d.ts

@@ -0,0 +1,5 @@
+/** Resolved parameters for an external provider declared in the break manifest. */
+export interface ExternalVendorConfiguration {
+    provider: string;
+    assetParameters: Record<string, string>;
+}

package/dist/types/ExternalVendorConfiguration.js

@@ -0,0 +1 @@
+export{};

package/dist/types/OptiViewAdsConfig.d.ts

@@ -427,7 +427,8 @@ export interface SessionConfig {
      * is unchanged.
      * Callbacks are evaluated per ad request and cleared when the session ends.
      * Session-scoped parameters are sent to IMA DAI with
-     * built-in and customer macros resolved; break-duration macros are omitted.
+     * built-in and customer macros resolved; break-duration macros stay literal and are
+     * reported as `DA-ASSET-MACRO-UNKNOWN`.
      *
      * @see OPTIVIEW_ASSET_PARAMETER_MACROS
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dolby-optiview/ads-sdk-core",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "OptiView Ads SDK Core - Player-agnostic ad insertion",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",