@openplayerjs/ads 3.1.1 → 3.2.0

package/dist/types/types.d.ts

@@ -0,0 +1,91 @@
+import type { EventBus } 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';
+export type VastInput = {
+    kind: 'url';
+    value: string;
+} | {
+    kind: 'xml';
+    value: string | XMLDocument | Element;
+};
+export type BreakAt = 'preroll' | 'postroll' | number;
+export type VastClosedCaption = {
+    type?: string;
+    language?: string;
+    fileURL?: string;
+};
+export type CaptionResource = {
+    src: string;
+    kind: 'captions' | 'subtitles';
+    srclang?: string;
+    label?: string;
+    type?: string;
+};
+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 OmidConfig = {
+    accessMode?: 'domain' | 'limited';
+};
+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';
+    omid?: OmidConfig;
+};
+export type NormalizedMediaFile = {
+    type: string;
+    fileURL: string;
+    bitrate: number;
+    width: number;
+    height: number;
+    raw: any;
+};
+export type PodAd = {
+    creativeIndex?: number;
+    ad: any;
+    creative: any;
+    mediaFile: NormalizedMediaFile;
+    sequence?: number;
+    skipOffset?: string;
+    companions?: any[];
+    nonLinears?: any[];
+};
+export type XmlNonLinearItem = {
+    nonLinear: any;
+    companions?: any[];
+};
+export type AdVerification = {
+    vendor: string;
+    scriptUrl: string;
+    params: string;
+};
+export declare class PluginBus<E extends string> {
+    private bus;
+    constructor(bus: EventBus);
+    on(event: E, cb: (...args: any[]) => void): () => boolean;
+    emit(event: E, ...data: any[]): void;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAInD,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,MAAM,MAAM,SAAS,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAA;CAAE,CAAC;AAIhH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;AAItD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,GAAG,WAAW,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAIF,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;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,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;IACzC,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAIF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,EAAE,EAAE,GAAG,CAAC;IACR,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;IACnB,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,GAAG,CAAC;IACf,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAIF,qBAAa,SAAS,CAAC,CAAC,SAAS,MAAM;IACzB,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,QAAQ;IAEjC,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAIzC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;CAG9B"}

package/dist/types/vast-parser.d.ts

@@ -0,0 +1,33 @@
+import type { AdVerification, NormalizedMediaFile, PodAd, VastInput, XmlNonLinearItem, CaptionResource, VastClosedCaption } from './types';
+export declare function isXmlString(src: string): boolean;
+export declare function toXmlDocument(xml: string): XMLDocument;
+export declare function buildParsedForNonLinearFromXml(xmlText: string): XMLDocument;
+export declare function getVastXmlText(input: VastInput): Promise<string>;
+export declare function parseTimecodeToSeconds(s: string): number | null;
+export declare function computeSkipAtSeconds(skipOffset: string | undefined, duration: number): number | undefined;
+export declare function pickBestMediaFile(mediaFiles: any[], preferredMediaTypes: string[]): NormalizedMediaFile | null;
+export declare function extractSkipOffsetFromCreative(creative: any): string | undefined;
+/**
+ * Looks for a SIMID MediaFile in a VAST creative or raw XMLDocument.
+ * SIMID MediaFiles have `apiFramework="SIMID"` and `type="text/html"`.
+ * Returns the URL of the first SIMID creative found, or undefined.
+ */
+export declare function extractSimidUrl(creative: any, rawDoc?: XMLDocument | null): string | undefined;
+/**
+ * Extracts AdVerification entries from a parsed VAST response or raw XMLDocument.
+ * Returns an array of verification resources usable by OmidSession.
+ */
+export declare function extractAdVerifications(parsed: any, rawDoc?: XMLDocument | null): AdVerification[];
+export declare function extractAdsFromParsed(parsed: any): any[];
+export declare function collectPodAds(parsed: any, preferredMediaTypes: string[]): PodAd[];
+export declare function collectPodAdsFromXml(doc: XMLDocument, preferredMediaTypes: string[]): PodAd[];
+export declare function collectNonLinearCreatives(parsed: any): {
+    ad: any;
+    creative: any;
+    nonLinear: any;
+    sequence?: number;
+}[];
+export declare function collectNonLinearFromXml(doc: XMLDocument): XmlNonLinearItem[];
+export declare function extractClosedCaptions(mediaFileRaw: any): VastClosedCaption[];
+export declare function buildCaptionsFromVastMediaFileRaw(mediaFileRaw: any): CaptionResource[];
+//# sourceMappingURL=vast-parser.d.ts.map

package/dist/types/vast-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vast-parser.d.ts","sourceRoot":"","sources":["../../src/vast-parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAI3I,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAEtD;AAED,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAE3E;AAED,wBAAsB,cAAc,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAStE;AAED,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQ/D;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAmBzG;AAID,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,mBAAmB,GAAG,IAAI,CAsB9G;AAED,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CA8C/E;AAID;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAgC9F;AAID;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,GAAG,cAAc,EAAE,CA4CjG;AAID,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,CAmBvD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CA6CjF;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAoD7F;AAID,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,GAAG,GAAG;IAAE,EAAE,EAAE,GAAG,CAAC;IAAC,QAAQ,EAAE,GAAG,CAAC;IAAC,SAAS,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CAoCtH;AAED,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,WAAW,GAAG,gBAAgB,EAAE,CA8D5E;AAID,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,GAAG,GAAG,iBAAiB,EAAE,CA2B5E;AAED,wBAAgB,iCAAiC,CAAC,YAAY,EAAE,GAAG,GAAG,eAAe,EAAE,CAetF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openplayerjs/ads",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "VAST/VMAP/Non-linear/companions ad-serving plugin for OpenPlayerJS",
   "author": {
     "name": "Rafael Miranda",
@@ -40,10 +40,10 @@
   ],
   "dependencies": {
     "@dailymotion/vast-client": "^6.4.2",
-    "@dailymotion/vmap": ">=3.0.0"
+    "@dailymotion/vmap": ">=3.3.3"
   },
   "peerDependencies": {
-    "@openplayerjs/core": "^3.1.1"
+    "@openplayerjs/core": "^3.2.0"
   },
   "devDependencies": {
     "@types/dailymotion__vast-client": "^6.3.0"