prebid.js 10.2.0 → 10.4.0

package/modules/validationFpdModule/index.ts

@@ -172,7 +172,7 @@ export function validateFpd(fpd, path = '', parent = '') {
       modified = (mapping.type === 'object' && !mapping.isArray)
         ? validateFpd(fpd[key], path + key + '.children.', parent + key + '.')
         : (mapping.isArray && mapping.childType)
-          ? filterArrayData(fpd[key], { type: mapping.childType, isArray: mapping.childisArray }, path + key, parent + key) : fpd[key];
+            ? filterArrayData(fpd[key], { type: mapping.childType, isArray: mapping.childisArray }, path + key, parent + key) : fpd[key];
 
       // Check if modified data has data and return
       (!isEmptyData(modified)) ? result[key] = modified
@@ -201,9 +201,9 @@ function runValidations(data) {
 }
 
 declare module '../../src/fpd/enrichment' {
-    interface FirstPartyDataConfig {
-        skipValidations?: boolean;
-    }
+  interface FirstPartyDataConfig {
+    skipValidations?: boolean;
+  }
 }
 
 /**

package/modules/videoModule/index.ts

@@ -4,13 +4,13 @@ import {logError, logWarn, mergeDeep} from '../../src/utils.js';
 import {getGlobal} from '../../src/prebidGlobal.js';
 import {EVENTS} from '../../src/constants.js';
 import {
-    AD_ERROR,
-    AD_IMPRESSION,
-    additionalEvents,
-    AUCTION_AD_LOAD_ABORT,
-    BID_ERROR,
-    BID_IMPRESSION,
-    videoEvents
+  AD_ERROR,
+  AD_IMPRESSION,
+  additionalEvents,
+  AUCTION_AD_LOAD_ABORT,
+  BID_ERROR,
+  BID_IMPRESSION,
+  videoEvents
 } from '../../libraries/video/constants/events.js'
 import {PLACEMENT} from '../../libraries/video/constants/ortb.js';
 import {videoKey} from '../../libraries/video/constants/constants.js'
@@ -35,42 +35,42 @@ const allVideoEvents = Object.keys(videoEvents).map(eventKey => videoEvents[even
 events.addEvents(allVideoEvents.concat(additionalEvents).map(getExternalVideoEventName) as any);
 
 declare module '../../src/events' {
-    interface EventNames {
-        video: VideoEvent
-    }
+  interface EventNames {
+    video: VideoEvent
+  }
 }
 
 interface AdServerConfig {
-    /**
-     * The identifier of the AdServer vendor (i.e. gam, etc).
-     */
-    vendorCode: AdServerVendor
-    /**
-     * Your AdServer Ad Tag. The targeting params of the winning bid will be appended.
-     */
-    baseAdTagUrl?: string;
-    /**
-     * Querystring parameters that will be used to construct the video ad tag URL.
-     */
-    params?: Record<string, string>;
+  /**
+   * The identifier of the AdServer vendor (i.e. gam, etc).
+   */
+  vendorCode: AdServerVendor
+  /**
+   * Your AdServer Ad Tag. The targeting params of the winning bid will be appended.
+   */
+  baseAdTagUrl?: string;
+  /**
+   * Querystring parameters that will be used to construct the video ad tag URL.
+   */
+  params?: Record<string, string>;
 }
 
 interface AdUnitVideoOptions {
-    /**
-     * Unique identifier of the player provider, used to specify which player should be used to render the ad.
-     * Equivalent to the HTML Div Id of the player.
-     */
-    divId: string;
-    /**
-     * Configuration for ad server integration. Supersedes video.adServer configurations defined in the Prebid Config.
-     */
-    adServer?: AdServerConfig
+  /**
+   * Unique identifier of the player provider, used to specify which player should be used to render the ad.
+   * Equivalent to the HTML Div Id of the player.
+   */
+  divId: string;
+  /**
+   * Configuration for ad server integration. Supersedes video.adServer configurations defined in the Prebid Config.
+   */
+  adServer?: AdServerConfig
 }
 
 declare module '../../src/adUnits' {
-    interface AdUnitDefinition {
-        video?: AdUnitVideoOptions
-    }
+  interface AdUnitDefinition {
+    video?: AdUnitVideoOptions
+  }
 }
 
 /**
@@ -328,9 +328,9 @@ export function PbVideo(videoCore_, getConfig_, pbGlobal_, requestBids_, pbEvent
 }
 
 declare module '../../src/prebidGlobal' {
-    interface PrebidJS {
-        videoModule: ReturnType<typeof PbVideo>
-    }
+  interface PrebidJS {
+    videoModule: ReturnType<typeof PbVideo>
+  }
 }
 
 function videoRenderHook(next, args) {

package/modules/weboramaRtdProvider.js

@@ -353,17 +353,21 @@ class WeboramaRtdProvider {
       extra = extra || {};
       const requiredFields = extra?.requiredFields || [];
 
-      requiredFields.forEach((field) => {
+      for (const field of requiredFields) {
         if (!(field in weboSectionConf)) {
-          throw `missing required field '${field}'`;
+          const msg = `missing required field '${field}'`;
+          logger.logError(msg);
+          return false;
         }
-      });
+      }
 
       if (
         isPlainObject(extra?.userConsent?.gdpr) &&
         !this.#checkTCFv2(extra.userConsent.gdpr)
       ) {
-        throw 'gdpr consent not ok';
+        const msg = 'gdpr consent not ok';
+        logger.logError(msg);
+        return false;
       }
     } catch (e) {
       logger.logError(
@@ -474,11 +478,15 @@ class WeboramaRtdProvider {
     this.#coerceSendToBidders(submoduleParams);
 
     if (!isFn(submoduleParams.onData)) {
-      throw 'onData parameter should be a callback';
+      const msg = 'onData parameter should be a callback';
+      logger.logError(msg);
+      return false;
     }
 
     if (!isValidProfile(submoduleParams.defaultProfile)) {
-      throw 'defaultProfile is not valid';
+      const msg = 'defaultProfile is not valid';
+      logger.logError(msg);
+      return false;
     }
   }
 
@@ -497,7 +505,9 @@ class WeboramaRtdProvider {
         submoduleParams.setPrebidTargeting
       );
     } catch (e) {
-      throw `invalid setPrebidTargeting: ${e}`;
+      const msg = `invalid setPrebidTargeting: ${e}`;
+      logger.logError(msg);
+      return false;
     }
   }
 
@@ -533,7 +543,9 @@ class WeboramaRtdProvider {
         try {
           return validatorCallback(adUnitCode);
         } catch (e) {
-          throw `invalid sendToBidders[${bidder}]: ${e}`;
+          const msg = `invalid sendToBidders[${bidder}]: ${e}`;
+          logger.logError(msg);
+          return false;
         }
       };
 
@@ -546,7 +558,9 @@ class WeboramaRtdProvider {
         (bid) => bid.bidder
       );
     } catch (e) {
-      throw `invalid sendToBidders: ${e}`;
+      const msg = `invalid sendToBidders: ${e}`;
+      logger.logError(msg);
+      return false;
     }
   }
 
@@ -680,7 +694,10 @@ class WeboramaRtdProvider {
         const data = JSON.parse(response);
         onSuccess(data);
       } else {
-        throw `unexpected http status response ${req.status} with response ${response}`;
+        const msg = `unexpected http status response ${req.status} with response ${response}`;
+        logger.logError(msg);
+        onDone();
+        return;
       }
 
       onDone();
@@ -997,7 +1014,9 @@ class WeboramaRtdProvider {
       };
     }
 
-    throw `unexpected format: ${typeof value} (expects function, boolean, string or array)`;
+    const msg = `unexpected format: ${typeof value} (expects function, boolean, string or array)`;
+    logger.logError(msg);
+    return () => false;
   }
 }
 

package/modules/welectBidAdapter.js

@@ -41,9 +41,9 @@ export const spec = {
     let catData = null
     if (bidderRequest?.ortb2?.site) {
       catData = {
-          pagecat: bidderRequest.ortb2.site.pagecat || [],
-          sectioncat: bidderRequest.ortb2.site.sectioncat || [],
-          sitecat: bidderRequest.ortb2.site.cat || [],
+        pagecat: bidderRequest.ortb2.site.pagecat || [],
+        sectioncat: bidderRequest.ortb2.site.sectioncat || [],
+        sitecat: bidderRequest.ortb2.site.cat || [],
       }
     }
 

package/modules/yandexBidAdapter.js

@@ -54,8 +54,27 @@ const DEFAULT_CURRENCY = 'EUR';
  * @type {MediaType[]}
  */
 const SUPPORTED_MEDIA_TYPES = [BANNER, NATIVE, VIDEO];
+
+const ORTB_MTYPES = {
+  BANNER: 1,
+  VIDEO: 2,
+  NATIVE: 4
+};
+
 const SSP_ID = 10500;
-const ADAPTER_VERSION = '2.3.0';
+const ADAPTER_VERSION = '2.6.0';
+
+const TRACKER_METHODS = {
+  img: 1,
+  js: 2,
+};
+
+const TRACKER_EVENTS = {
+  impression: 1,
+  'viewable-mrc50': 2,
+  'viewable-mrc100': 3,
+  'viewable-video50': 4,
+};
 
 const IMAGE_ASSET_TYPES = {
   ICON: 1,
@@ -312,20 +331,20 @@ function mapBanner(bidRequest) {
 function mapVideo(bidRequest) {
   const videoParams = deepAccess(bidRequest, 'mediaTypes.video');
   if (videoParams) {
-      const { sizes, playerSize } = videoParams;
+    const { sizes, playerSize } = videoParams;
 
-      const format = (playerSize || sizes)?.map((size) => ({ w: size[0], h: size[1] }));
+    const format = (playerSize || sizes)?.map((size) => ({ w: size[0], h: size[1] }));
 
-      const [firstSize] = format || [];
+    const [firstSize] = format || [];
 
-      delete videoParams.sizes;
+    delete videoParams.sizes;
 
-      return {
-          ...videoParams,
-          w: firstSize?.w,
-          h: firstSize?.h,
-          format,
-      };
+    return {
+      ...videoParams,
+      w: firstSize?.w,
+      h: firstSize?.h,
+      format,
+    };
   }
 }
 
@@ -347,10 +366,13 @@ function mapNative(bidRequest) {
     });
 
     return {
-      ver: 1.1,
+      ver: 1.2,
       request: JSON.stringify({
-        ver: 1.1,
-        assets
+        ver: 1.2,
+        assets,
+        eventtrackers: [
+          { event: TRACKER_EVENTS.impression, methods: [TRACKER_METHODS.img] },
+        ],
       }),
     };
   }
@@ -443,15 +465,23 @@ function interpretResponse(serverResponse, { bidRequest }) {
       }
     };
 
-    if (bidReceived.adm.indexOf('{') === 0) {
-      prBid.mediaType = NATIVE;
-      prBid.native = interpretNativeAd(bidReceived, price, currency);
-    } else if (bidReceived.adm.indexOf('<VAST') > -1) {
-      prBid.mediaType = VIDEO;
-      prBid.vastXml = bidReceived.adm;
-    } else {
-      prBid.mediaType = BANNER;
-      prBid.ad = bidReceived.adm;
+    if (bidReceived.lurl) {
+      prBid.lurl = bidReceived.lurl;
+    }
+
+    switch (bidReceived.mtype) {
+      case ORTB_MTYPES.VIDEO:
+        prBid.mediaType = VIDEO;
+        prBid.vastXml = bidReceived.adm;
+        break;
+      case ORTB_MTYPES.NATIVE:
+        prBid.mediaType = NATIVE;
+        prBid.native = interpretNativeAd(bidReceived, price, currency);
+        break;
+      case ORTB_MTYPES.BANNER:
+        prBid.mediaType = BANNER;
+        prBid.ad = bidReceived.adm;
+        break;
     }
 
     return prBid;
@@ -485,10 +515,23 @@ function interpretNativeAd(bidReceived, price, currency) {
       }
     });
 
-    result.impressionTrackers = _map(native.imptrackers, (tracker) =>
+    const impressionTrackers = _map(native.imptrackers || [], (tracker) =>
       replaceAuctionPrice(tracker, price, currency)
     );
 
+    _each(native.eventtrackers || [], (eventtracker) => {
+      if (
+        eventtracker.event === TRACKER_EVENTS.impression &&
+        eventtracker.method === TRACKER_METHODS.img
+      ) {
+        impressionTrackers.push(
+          replaceAuctionPrice(eventtracker.url, price, currency)
+        );
+      }
+    });
+
+    result.impressionTrackers = impressionTrackers;
+
     return result;
   } catch (e) {}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "10.2.0",
+  "version": "10.4.0",
   "description": "Header Bidding Management Library",
   "main": "dist/src/prebid.public.ts",
   "exports": {
@@ -65,9 +65,8 @@
     "babel-plugin-istanbul": "^6.1.1",
     "body-parser": "^1.19.0",
     "chai": "^4.2.0",
-    "coveralls-next": "^4.2.1",
     "deep-equal": "^2.0.3",
-    "eslint": "^9.22.0",
+    "eslint": "^9.31.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsdoc": "^50.6.6",
     "execa": "^1.0.0",

package/src/activities/params.js

@@ -29,6 +29,12 @@ export const ACTIVITY_PARAM_STORAGE_TYPE = 'storageType';
  */
 export const ACTIVITY_PARAM_STORAGE_KEY = 'storageKey'
 
+/**
+ * True if attempting to write to device storage; false otherwise (e.g. when reading from or checking availability of storage).
+ * Relevant for: accessDevice
+ */
+export const ACTIVITY_PARAM_STORAGE_WRITE = 'write';
+
 /**
  * s2sConfig[].configName, used to identify a particular s2s instance
  * relevant for: fetchBids, but only when component is 'prebid.pbsBidAdapter'

package/src/activities/redactor.ts

@@ -207,14 +207,14 @@ export function redactorFactory(isAllowed = isActivityAllowed) {
 export const redactor = redactorFactory();
 
 declare module '../config' {
-    interface Config {
-        /**
-         * Prebid generates unique IDs for both auctions and ad units within auctions; these can be used by DSPs
-         * to correlate requests from different sources, which is useful for many applications but also a potential
-         * privacy concern. Since version 8 they are disabled by default, and can be re-enabled with this flag.
-         */
-        enableTIDs?: boolean;
-    }
+  interface Config {
+    /**
+     * Prebid generates unique IDs for both auctions and ad units within auctions; these can be used by DSPs
+     * to correlate requests from different sources, which is useful for many applications but also a potential
+     * privacy concern. Since version 8 they are disabled by default, and can be re-enabled with this flag.
+     */
+    enableTIDs?: boolean;
+  }
 }
 // by default, TIDs are off since version 8
 registerActivityControl(ACTIVITY_TRANSMIT_TID, 'enableTIDs config', () => {

package/src/adRendering.ts

@@ -1,12 +1,12 @@
 import {
-    createIframe,
-    createInvisibleIframe,
-    inIframe,
-    insertElement,
-    logError,
-    logWarn,
-    replaceMacros,
-    triggerPixel
+  createIframe,
+  createInvisibleIframe,
+  inIframe,
+  insertElement,
+  logError,
+  logWarn,
+  replaceMacros,
+  triggerPixel
 } from './utils.js';
 import * as events from './events.js';
 import {AD_RENDER_FAILED_REASON, BID_STATUS, EVENTS, MESSAGES, PB_LOCATOR} from './constants.js';
@@ -28,29 +28,29 @@ const { AD_RENDER_FAILED, AD_RENDER_SUCCEEDED, STALE_RENDER, BID_WON, EXPIRED_RE
 const { EXCEPTION } = AD_RENDER_FAILED_REASON;
 
 declare module './events' {
-    interface Events {
-        /**
-         * Fired when a bid is rendered (successfully or not).
-         */
-        [EVENTS.BID_WON]: [Bid];
-        /**
-         * Fired when a bid failed to render.
-         */
-        [EVENTS.AD_RENDER_FAILED]: [AdRenderFailedData];
-        /**
-         * Fired when a bid was rendered successfully.
-         */
-        [EVENTS.AD_RENDER_SUCCEEDED]: [AdRenderSucceededData];
-        /**
-         * Fired when a bid that was previously rendered is rendered again.
-         */
-        [EVENTS.STALE_RENDER]: [Bid];
-        /**
-         * Fired when an expired bid is rendered. A bid expires after `.ttl` seconds from
-         * the time it was received.
-         */
-        [EVENTS.EXPIRED_RENDER]: [Bid];
-    }
+  interface Events {
+    /**
+     * Fired when a bid is rendered (successfully or not).
+     */
+    [EVENTS.BID_WON]: [Bid];
+    /**
+     * Fired when a bid failed to render.
+     */
+    [EVENTS.AD_RENDER_FAILED]: [AdRenderFailedData];
+    /**
+     * Fired when a bid was rendered successfully.
+     */
+    [EVENTS.AD_RENDER_SUCCEEDED]: [AdRenderSucceededData];
+    /**
+     * Fired when a bid that was previously rendered is rendered again.
+     */
+    [EVENTS.STALE_RENDER]: [Bid];
+    /**
+     * Fired when an expired bid is rendered. A bid expires after `.ttl` seconds from
+     * the time it was received.
+     */
+    [EVENTS.EXPIRED_RENDER]: [Bid];
+  }
 }
 
 export const getBidToRender = hook('sync', function (adId, forRender = true, override = PbPromise.resolve()) {
@@ -67,22 +67,22 @@ export const markWinningBid = hook('sync', function (bid) {
 })
 
 type AdRenderFailedData = {
-    /**
-     * Failure reason.
-     */
-    reason: (typeof AD_RENDER_FAILED_REASON)[keyof typeof AD_RENDER_FAILED_REASON];
-    /**
-     * failure description
-     */
-    message: string;
-    /**
-     * The bid that failed to render.
-     */
-    bid?: Bid;
-    /**
-     * Ad ID of the bid that failed to render.
-     */
-    adId?: string;
+  /**
+   * Failure reason.
+   */
+  reason: (typeof AD_RENDER_FAILED_REASON)[keyof typeof AD_RENDER_FAILED_REASON];
+  /**
+   * failure description
+   */
+  message: string;
+  /**
+   * The bid that failed to render.
+   */
+  bid?: Bid;
+  /**
+   * Ad ID of the bid that failed to render.
+   */
+  adId?: string;
 }
 
 /**
@@ -101,19 +101,19 @@ export function emitAdRenderFail({ reason, message, bid, id }: Omit<AdRenderFail
 }
 
 type AdRenderSucceededData = {
-    /**
-     * document object that was used to `.write` the ad. Should be `null` if unavailable (e.g. for documents in
-     * a cross-origin frame).
-     */
-    doc: Document | null;
-    /**
-     * The bid that was rendered.
-     */
-    bid: Bid;
-    /**
-     * Ad ID of the bid that was rendered.
-     */
-    adId: string;
+  /**
+   * document object that was used to `.write` the ad. Should be `null` if unavailable (e.g. for documents in
+   * a cross-origin frame).
+   */
+  doc: Document | null;
+  /**
+   * The bid that was rendered.
+   */
+  bid: Bid;
+  /**
+   * Ad ID of the bid that was rendered.
+   */
+  adId: string;
 }
 /**
  * Emit the AD_RENDER_SUCCEEDED event.
@@ -176,7 +176,7 @@ function creativeMessageHandler(deps) {
 }
 
 type RenderOptions = {
-    clickUrl?: string;
+  clickUrl?: string;
 }
 
 export const getRenderingData = hook('sync', function (bidResponse: Bid, options?: RenderOptions): Record<string, any> {