@openplayerjs/ads 3.0.0-beta.0

package/dist/types/ads.d.ts

@@ -0,0 +1,166 @@
+import type { PlayerPlugin, PluginContext } from '@openplayerjs/core';
+export type AdsEvent = 'ads:requested' | 'ads:break:start' | 'ads:break:end' | 'ads:ad:start' | 'ads:ad:end' | 'ads:loaded' | 'ads:impression' | 'ads:quartile' | 'ads:clickthrough' | 'ads:error' | 'ads:timeupdate' | 'ads:duration' | 'ads:allAdsCompleted' | 'ads:skip' | 'ads:pause' | 'ads:resume' | 'ads:mute' | 'ads:unmute' | 'ads:volumeChange';
+type BreakAt = 'preroll' | 'postroll' | number;
+export type AdsSourceType = 'VAST' | 'VMAP' | 'NONLINEAR';
+export type AdsSource = {
+    type: AdsSourceType;
+    src: string;
+};
+export type AdsBreakConfig = {
+    id?: string;
+    at: BreakAt;
+    source?: AdsSource;
+    sources?: AdsSource[];
+    once?: boolean;
+    timeOffset?: string;
+};
+export type AdsPluginConfig = {
+    sources?: AdsSource | AdsSource[];
+    breaks?: AdsBreakConfig[];
+    interceptPlayForPreroll?: boolean;
+    autoPlayOnReady?: boolean;
+    mountEl?: HTMLElement;
+    mountSelector?: string;
+    nonLinearContainer?: HTMLElement;
+    nonLinearSelector?: string;
+    companionContainer?: HTMLElement;
+    companionSelector?: string;
+    allowNativeControls?: boolean;
+    resumeContent?: boolean;
+    preferredMediaTypes?: string[];
+    debug?: boolean;
+    breakTolerance?: number;
+    adSourcesMode?: 'waterfall' | 'playlist';
+};
+export declare class AdsPlugin implements PlayerPlugin {
+    name: string;
+    version: string;
+    capabilities: string[];
+    private ctx;
+    private bus;
+    private _lastCreative;
+    private overlayId;
+    private prevActiveCaptionSig;
+    private adEndPromise;
+    private adTrackEls;
+    private cfg;
+    private overlay;
+    private adVideo?;
+    private skipWrap?;
+    private skipBtn?;
+    private skipOffsetRaw?;
+    private skipAtSeconds?;
+    private companionWrap?;
+    private nonLinearWrap?;
+    private resolvedNonLinearContainer?;
+    private resolvedCompanionContainer?;
+    private currentBreakMeta?;
+    private vastClient;
+    private tracker?;
+    private globalUnsubs;
+    private sessionUnsubs;
+    private active;
+    private resumeAfter;
+    private contentMedia?;
+    private contentHadControls;
+    private startingBreak;
+    private playedBreaks;
+    private userPlayIntent;
+    private forcedMuteUntilInteraction;
+    private resolvedBreaks;
+    private pendingPercentBreaks;
+    private syncingVolume;
+    private vmapLoadPromise;
+    private vmapPending;
+    private pendingVmapSrc?;
+    constructor(config?: AdsPluginConfig);
+    setup(ctx: PluginContext): void;
+    playAds(vastUrl: string): Promise<boolean>;
+    playAdsFromXml(vastXml: string): Promise<boolean>;
+    getDueMidrollBreaks(currentTime: number): AdsBreakConfig[];
+    /** Returns the earliest due midroll break, if any. (Convenience for tests/debugging.) */
+    getDueMidrollBreak(currentTime: number): AdsBreakConfig | undefined;
+    destroy(): void;
+    private inferSourceTypeForUrl;
+    private resolveContainer;
+    private getNonLinearContainer;
+    private getCompanionContainer;
+    private getSource;
+    private getPrimaryVastLikeSource;
+    private isXmlString;
+    private getVastXmlText;
+    private buildParsedForNonLinearFromXml;
+    private setSafeHTML;
+    private log;
+    private warn;
+    private rebuildSchedule;
+    private normalizeVmapAdSource;
+    private extractVastTagUri;
+    private loadVmapAndMerge;
+    private resolveMount;
+    private parseVmapTimeOffset;
+    private getVastInputFromBreak;
+    private getPostrollBreak;
+    private toXmlDocument;
+    private getBreakId;
+    private getPrerollBreak;
+    private shouldInterceptPreroll;
+    private bindPrerollInterceptors;
+    private bindBreakScheduler;
+    private startBreak;
+    private startBreakGroup;
+    private extractAdsFromParsed;
+    private collectPodAds;
+    private collectPodAdsFromXml;
+    private clearAdTracks;
+    private buildCaptionsFromVastMediaFileRaw;
+    private ensureRawCaptions;
+    private attachAdCaptionTracks;
+    private captionsSignature;
+    private listCaptionTracks;
+    private captureActiveCaptionTrack;
+    private restoreActiveTextTrack;
+    private extractClosedCaptions;
+    private removeAdCaptions;
+    private pickBestMediaFile;
+    private extractSkipOffsetFromCreative;
+    private parseTimecodeToSeconds;
+    private computeSkipAtSeconds;
+    private ensureSkipDom;
+    private hideSkipUi;
+    private setupSkipUIForPodItem;
+    private onSkip;
+    private requestSkip;
+    private clearAdOverlays;
+    private mountCompanions;
+    private renderCompanion;
+    private collectNonLinearCreatives;
+    private collectNonLinearFromXml;
+    private playNonLinearOnlyBreakFromXml;
+    private ensureNonLinearDom;
+    private renderNonLinear;
+    private mountNonLinear;
+    private nonLinearSuggestedDurationSeconds;
+    private playNonLinearOnlyBreak;
+    private mountAdVideo;
+    private bindAdSurfaceCommands;
+    private bindTrackerAndTelemetry;
+    private getClickThroughUrl;
+    private safeWindowOpen;
+    private ensureOverlayMounted;
+    /**
+     * Best-effort SIMID mounting helper.
+     * Some ad servers provide multiple SIMID iframe URLs; we mount all of them.
+     * This is intentionally permissive and does not block playback if the creative doesn't contain SIMID data.
+     */
+    tryMountSimidLayer(creative: any): void;
+    private playBreakFromVast;
+    private waitForAdEnd;
+    private startAdPlayback;
+    private clearSession;
+    private finish;
+}
+export declare function installAds(PlayerCtor: any): void;
+export declare function extendAds(player: any, plugin: AdsPlugin): void;
+export {};
+//# sourceMappingURL=ads.d.ts.map

package/dist/types/ads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ads.d.ts","sourceRoot":"","sources":["../../src/ads.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAY,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGhF,MAAM,MAAM,QAAQ,GAChB,eAAe,GACf,iBAAiB,GACjB,eAAe,GACf,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,qBAAqB,GACrB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,kBAAkB,CAAC;AAIvB,KAAK,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;AAgB/C,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;AAE1D,MAAM,MAAM,SAAS,GAAG;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAcF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC;IAClC,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,WAAW,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,WAAW,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CAC1C,CAAC;AA2BF,qBAAa,SAAU,YAAW,YAAY;IAC5C,IAAI,SAAS;IACb,OAAO,SAAW;IAClB,YAAY,WAAW;IAEvB,OAAO,CAAC,GAAG,CAAiB;IAC5B,OAAO,CAAC,GAAG,CAAuB;IAClC,OAAO,CAAC,aAAa,CAAM;IAC3B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,UAAU,CAA0B;IAI5C,OAAO,CAAC,GAAG,CAsBoB;IAE/B,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,OAAO,CAAC,CAAmB;IAEnC,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAClC,OAAO,CAAC,OAAO,CAAC,CAAoB;IACpC,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,aAAa,CAAC,CAAS;IAE/B,OAAO,CAAC,aAAa,CAAC,CAAiB;IACvC,OAAO,CAAC,aAAa,CAAC,CAAiB;IAEvC,OAAO,CAAC,0BAA0B,CAAC,CAAc;IACjD,OAAO,CAAC,0BAA0B,CAAC,CAAc;IAEjD,OAAO,CAAC,gBAAgB,CAAC,CAAoC;IAE7D,OAAO,CAAC,UAAU,CAAM;IACxB,OAAO,CAAC,OAAO,CAAC,CAAM;IAEtB,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,aAAa,CAAsB;IAE3C,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,YAAY,CAAC,CAAmB;IACxC,OAAO,CAAC,kBAAkB,CAAS;IAEnC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,0BAA0B,CAAS;IAC3C,OAAO,CAAC,cAAc,CAAwB;IAC9C,OAAO,CAAC,oBAAoB,CACvB;IACL,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,cAAc,CAAC,CAAS;gBAEpB,MAAM,GAAE,eAAoB;IAgDxC,KAAK,CAAC,GAAG,EAAE,aAAa;IA0DlB,OAAO,CAAC,OAAO,EAAE,MAAM;IAKvB,cAAc,CAAC,OAAO,EAAE,MAAM;IAIpC,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,EAAE;IAmC1D,yFAAyF;IACzF,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAInE,OAAO;IAOP,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,WAAW;YAIL,cAAc;IAc5B,OAAO,CAAC,8BAA8B;IAItC,OAAO,CAAC,WAAW;IA6DnB,OAAO,CAAC,GAAG;IAKX,OAAO,CAAC,IAAI;IAKZ,OAAO,CAAC,eAAe;IA+CvB,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,iBAAiB;YAYX,gBAAgB;IAyK9B,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,mBAAmB;IA0B3B,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,eAAe;IAwCvB,OAAO,CAAC,sBAAsB;IAkB9B,OAAO,CAAC,uBAAuB;IAiG/B,OAAO,CAAC,kBAAkB;YAuDZ,UAAU;YA2DV,eAAe;IA4B7B,OAAO,CAAC,oBAAoB;IAqB5B,OAAO,CAAC,aAAa;IAkDrB,OAAO,CAAC,oBAAoB;IA0D5B,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,iCAAiC;IAmBzC,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,qBAAqB;IAuB7B,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,iBAAiB;IAczB,OAAO,CAAC,yBAAyB;IAOjC,OAAO,CAAC,sBAAsB;IAiB9B,OAAO,CAAC,qBAAqB;IA4B7B,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,6BAA6B;IAwDrC,OAAO,CAAC,sBAAsB;IAU9B,OAAO,CAAC,oBAAoB;IAsB5B,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,qBAAqB;IAsC7B,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,WAAW;IAgCnB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,eAAe;IAiCvB,OAAO,CAAC,eAAe;IAwEvB,OAAO,CAAC,yBAAyB;IA0CjC,OAAO,CAAC,uBAAuB;YA2EjB,6BAA6B;IAsD3C,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,eAAe;IAgEvB,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,iCAAiC;YAa3B,sBAAsB;YA4EtB,YAAY;IA6I1B,OAAO,CAAC,qBAAqB;IAiE7B,OAAO,CAAC,uBAAuB;IA8J/B,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,oBAAoB;IAoB5B;;;;OAIG;IACH,kBAAkB,CAAC,QAAQ,EAAE,GAAG,GAAG,IAAI;YA2CzB,iBAAiB;IA+M/B,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,eAAe;IAsCvB,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,MAAM;CAgCf;AAED,wBAAgB,UAAU,CAAC,UAAU,EAAE,GAAG,QAyCzC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,QAOvD"}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @openplayerjs/ads
+ *
+ * VAST / VMAP / VPAID ad-serving plugin for OpenPlayerJS.
+ * Peer dependencies: @openplayerjs/core, @dailymotion/vast-client, @dailymotion/vmap
+ *
+ * ESM usage:
+ *   import { AdsPlugin } from '@openplayerjs/ads';
+ *   new Core(el, { plugins: [new AdsPlugin({ breaks: [...] })] });
+ *
+ * UMD / CDN usage: load openplayer-ads.umd.js after the main OpenPlayer bundle.
+ * It auto-registers itself under window.OpenPlayerPlugins.ads.
+ */
+export { AdsPlugin } from './ads';
+export { extendAds, installAds } from './ads';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC"}

package/dist/types/umd.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=umd.d.ts.map

package/dist/types/umd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"umd.d.ts","sourceRoot":"","sources":["../../src/umd.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@openplayerjs/ads",
+  "version": "3.0.0-beta.0",
+  "description": "VAST/VMAP/Non-linear/companions ad-serving plugin for OpenPlayerJS",
+  "author": {
+    "name": "Rafael Miranda",
+    "email": "rafa8626@gmail.com"
+  },
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openplayerjs/openplayerjs.git",
+    "directory": "packages/ads"
+  },
+  "bugs": {
+    "url": "https://github.com/openplayerjs/openplayerjs/issues"
+  },
+  "keywords": [
+    "vast",
+    "vmap",
+    "ads",
+    "ad",
+    "advertising",
+    "player",
+    "openplayer"
+  ],
+  "dependencies": {
+    "@dailymotion/vast-client": "^6.4.2",
+    "@dailymotion/vmap": ">=3.0.0"
+  },
+  "peerDependencies": {
+    "@openplayerjs/core": "^3.0.0-beta.0"
+  },
+  "devDependencies": {
+    "@types/dailymotion__vast-client": "^6.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest --passWithNoTests  --config ../../jest.config.cjs"
+  }
+}