prebid.js 7.53.0 → 8.0.0

package/modules/utiqSystem.js

@@ -0,0 +1,129 @@
+/**
+ * This module adds Utiq provided by Utiq SA/NV to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/utiqSystem
+ * @requires module:modules/userId
+ */
+import { logInfo } from '../src/utils.js';
+import { submodule } from '../src/hook.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { MODULE_TYPE_UID } from '../src/activities/modules.js';
+
+const MODULE_NAME = 'utiq';
+const LOG_PREFIX = 'Utiq module';
+
+export const storage = getStorageManager({
+  moduleType: MODULE_TYPE_UID,
+  moduleName: MODULE_NAME,
+});
+
+/**
+ * Get the "atid" from html5 local storage to make it available to the UserId module.
+ * @param config
+ * @returns {{utiq: (*|string)}}
+ */
+function getUtiqFromStorage() {
+  let utiqPass;
+  let utiqPassStorage = JSON.parse(
+    storage.getDataFromLocalStorage('utiqPass')
+  );
+  logInfo(
+    `${LOG_PREFIX}: Local storage utiqPass: ${JSON.stringify(
+      utiqPassStorage
+    )}`
+  );
+
+  if (
+    utiqPassStorage &&
+    utiqPassStorage.connectId &&
+    Array.isArray(utiqPassStorage.connectId.idGraph) &&
+    utiqPassStorage.connectId.idGraph.length > 0
+  ) {
+    utiqPass = utiqPassStorage.connectId.idGraph[0];
+  }
+  logInfo(
+    `${LOG_PREFIX}: Graph of utiqPass: ${JSON.stringify(
+      utiqPass
+    )}`
+  );
+
+  return {
+    utiq:
+      utiqPass && utiqPass.atid
+        ? utiqPass.atid
+        : null,
+  };
+}
+
+/** @type {Submodule} */
+export const utiqSubmodule = {
+  /**
+   * Used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * Decodes the stored id value for passing to bid requests.
+   * @function
+   * @returns {{utiq: string} | null}
+   */
+  decode(bidId) {
+    logInfo(`${LOG_PREFIX}: Decoded ID value ${JSON.stringify(bidId)}`);
+    return bidId.utiq ? bidId : null;
+  },
+  /**
+   * Get the id from helper function and initiate a new user sync.
+   * @param config
+   * @returns {{callback: result}|{id: {utiq: string}}}
+   */
+  getId: function (config) {
+    const data = getUtiqFromStorage();
+    if (data.utiq) {
+      logInfo(`${LOG_PREFIX}: Local storage ID value ${JSON.stringify(data)}`);
+      return { id: { utiq: data.utiq } };
+    } else {
+      if (!config) {
+        config = {};
+      }
+      if (!config.params) {
+        config.params = {};
+      }
+      if (
+        typeof config.params.maxDelayTime === 'undefined' ||
+        config.params.maxDelayTime === null
+      ) {
+        config.params.maxDelayTime = 1000;
+      }
+      // Current delay and delay step in milliseconds
+      let currentDelay = 0;
+      const delayStep = 50;
+      const result = (callback) => {
+        const data = getUtiqFromStorage();
+        if (!data.utiq) {
+          if (currentDelay > config.params.maxDelayTime) {
+            logInfo(
+              `${LOG_PREFIX}: No utiq value set after ${config.params.maxDelayTime} max allowed delay time`
+            );
+            callback(null);
+          } else {
+            currentDelay += delayStep;
+            setTimeout(() => {
+              result(callback);
+            }, delayStep);
+          }
+        } else {
+          const dataToReturn = { utiq: data.utiq };
+          logInfo(
+            `${LOG_PREFIX}: Returning ID value data of ${JSON.stringify(
+              dataToReturn
+            )}`
+          );
+          callback(dataToReturn);
+        }
+      };
+      return { callback: result };
+    }
+  },
+};
+
+submodule('userId', utiqSubmodule);

package/modules/{trustpidSystem.md → utiqSystem.md}

@@ -1,22 +1,22 @@
-## trustpid User Id Submodule
+## Utiq User ID Submodule
 
-trustpid User Id Module.
+Utiq ID Module.
 
-First, make sure to add the trustpid submodule to your Prebid.js package with:
+First, make sure to add the utiq submodule to your Prebid.js package with:
 
 ```
-gulp build --modules=userId,adfBidAdapter,ixBidAdapter,prebidServerBidAdapter,trustpidSystem
+gulp build --modules=userId,adfBidAdapter,ixBidAdapter,prebidServerBidAdapter,utiqSystem
 ```
 
 ## Parameter Descriptions
 
 | Params under userSync.userIds[] | Type             | Description                                                                                                  | Example                          |
 | ------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------- |
-| name                            | String           | The name of the module                                                                                       | `"trustpid"`                     |
-| params                          | Object           | Object with configuration parameters for trustpid User Id submodule                                          | -                                |
+| name                            | String           | The name of the module                                                                                       | `"utiq"`                         |
+| params                          | Object           | Object with configuration parameters for utiq User Id submodule                                              | -                                |
 | params.maxDelayTime             | Integer          | Max amount of time (in seconds) before looking into storage for data                                         | 2500                             |
 | bidders                         | Array of Strings | An array of bidder codes to which this user ID may be sent. Currently required and supporting AdformOpenRTB  | [`"adf"`, `"adformPBS"`, `"ix"`] |
 | storage                         | Object           | Local storage configuration object                                                                           | -                                |
 | storage.type                    | String           | Type of the storage that would be used to store user ID. Must be `"html5"` to utilise HTML5 local storage.   | `"html5"`                        |
-| storage.name                    | String           | The name of the key in local storage where the user ID will be stored.                                       | `"trustpid"`                     |
+| storage.name                    | String           | The name of the key in local storage where the user ID will be stored.                                       | `"utiq"`                         |
 | storage.expires                 | Integer          | How long (in days) the user ID information will be stored. For safety reasons, this information is required. | `1`                              |

package/modules/vdoaiBidAdapter.js

@@ -38,6 +38,7 @@ export const spec = {
         bidId: bidRequest.bidId,
         // TODO: is 'page' the right value here?
         referer: bidderRequest.refererInfo.page,
+        // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
         id: bidRequest.auctionId,
         mediaType: bidRequest.mediaTypes.video ? 'video' : 'banner'
       };

package/modules/vibrantmediaBidAdapter.js

@@ -72,7 +72,7 @@ const transformBidRequests = function(bidRequests) {
     const transformedBidRequest = {
       code: bidRequest.adUnitCode || bidRequest.code,
       id: bidRequest.placementId || params.placementId || params.invCode,
-      requestId: bidRequest.bidId || bidRequest.transactionId,
+      requestId: bidRequest.bidId,
       bidder: bidRequest.bidder,
       mediaTypes: bidRequest.mediaTypes,
       bids: bidRequest.bids,

package/modules/vidazooBidAdapter.js

@@ -57,7 +57,7 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest, bidderTimeout) {
     schain,
     mediaTypes,
     auctionId,
-    transactionId,
+    ortb2Imp,
     bidderRequestId,
     bidRequestsCount,
     bidderRequestsCount,
@@ -114,8 +114,9 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest, bidderTimeout) {
     gpid: gpid,
     cat: cat,
     pagecat: pagecat,
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     auctionId: auctionId,
-    transactionId: transactionId,
+    transactionId: ortb2Imp?.ext?.tid,
     bidderRequestId: bidderRequestId,
     bidRequestsCount: bidRequestsCount,
     bidderRequestsCount: bidderRequestsCount,

package/modules/videobyteBidAdapter.js

@@ -90,7 +90,6 @@ export const spec = {
       if (bid.adm && bid.price) {
         let bidResponse = {
           requestId: response.id,
-          bidderCode: spec.code,
           cpm: bid.price,
           width: bid.w,
           height: bid.h,

package/modules/videoheroesBidAdapter.js

@@ -57,6 +57,8 @@ export const spec = {
         impObject.video = createVideoRequest(br);
       } else if (br.mediaTypes.native) {
         impObject.native = {
+          // TODO: fix transactionId leak: https://github.com/prebid/Prebid.js/issues/9781
+          // Also, `id` is not in the ORTB native spec
           id: br.transactionId,
           ver: '1.2',
           request: createNativeRequest(br)

package/modules/videojsVideoProvider.js

@@ -628,6 +628,8 @@ export const utils = {
         return 'adserror';
       case CONTENT_LOADED:
         return 'loadstart';
+      case ERROR:
+        return ['error', 'aderror', 'contenterror'];
       case PLAY:
         return PLAY + 'ing';
       case PLAYBACK_REQUEST:

package/modules/videoreachBidAdapter.js

@@ -21,8 +21,9 @@ export const spec = {
           adUnitCode: getBidIdParameter('adUnitCode', bid),
           bidId: getBidIdParameter('bidId', bid),
           bidderRequestId: getBidIdParameter('bidderRequestId', bid),
+          // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
           auctionId: getBidIdParameter('auctionId', bid),
-          transactionId: getBidIdParameter('transactionId', bid)
+          transactionId: bid.ortb2Imp?.ext?.tid,
         }
       })
     };

package/modules/vlybyBidAdapter.js

@@ -23,6 +23,7 @@ export const spec = {
       url: `${ENDPOINT}`,
       data: {
         request: {
+          // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
           auctionId: bidderRequest.auctionId
         },
         gdprConsent: {

package/modules/voxBidAdapter.js

@@ -15,6 +15,7 @@ function buildBidRequests(validBidRequests) {
     const params = validBidRequest.params;
     const bidRequest = {
       bidId: validBidRequest.bidId,
+      // TODO: fix transactionId leak: https://github.com/prebid/Prebid.js/issues/9781
       transactionId: validBidRequest.transactionId,
       sizes: validBidRequest.sizes,
       placement: params.placement,
@@ -80,6 +81,7 @@ function buildBid(bidData) {
     bid.vastXml = bidData.content;
     bid.mediaType = VIDEO;
 
+    // TODO: why does this need to iterate through every ad unit?
     let adUnit = find(auctionManager.getAdUnits(), function (unit) {
       return unit.transactionId === bidData.transactionId;
     });

package/modules/vrtcalBidAdapter.js

@@ -8,7 +8,7 @@ export const spec = {
   code: 'vrtcal',
   supportedMediaTypes: [BANNER],
   isBidRequestValid: function (bid) {
-    if (bid.bidId == '' || bid.auctionId == '') { return false; } else { return true; }// No extras params required
+    return true;
   },
   buildRequests: function (bidRequests) {
     const requests = bidRequests.map(function (bid) {
@@ -93,6 +93,11 @@ export const spec = {
         params.imp[0].banner.h = bid.sizes[0][1];
       }
 
+      if (bid.ortb2?.regs?.gpp) {
+        params.regs.ext.gpp = bid.ortb2.regs.gpp;
+        params.regs.ext.gpp_sid = bid.ortb2.regs.gpp_sid;
+      }
+
       return {method: 'POST', url: 'https://rtb.vrtcal.com/bidder_prebid.vap?ssp=1804', data: JSON.stringify(params), options: {withCredentials: false, crossOrigin: true}};
     });
 

package/modules/winrBidAdapter.js

@@ -5,12 +5,10 @@ import {
   getBidRequest,
   getParameterByName,
   isArray,
-  isEmpty,
   isFn,
   isNumber,
   isPlainObject,
-  logError,
-  transformBidderParamKeywords
+  logError
 } from '../src/utils.js';
 import {config} from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
@@ -18,6 +16,7 @@ import {BANNER} from '../src/mediaTypes.js';
 import {find, includes} from '../src/polyfill.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {getANKeywordParam, transformBidderParamKeywords} from '../libraries/appnexusKeywords/anKeywords.js';
 
 const BIDDER_CODE = 'winr';
 const URL = 'https://ib.adnxs.com/ut/v3/prebid';
@@ -330,10 +329,6 @@ export const spec = {
         delete params.usePaymentRule;
       }
 
-      if (isPopulatedArray(params.keywords)) {
-        params.keywords.forEach(deleteValues);
-      }
-
       Object.keys(params).forEach((paramKey) => {
         let convertedKey = convertCamelToUnderscore(paramKey);
         if (convertedKey !== paramKey) {
@@ -347,16 +342,6 @@ export const spec = {
   },
 };
 
-function isPopulatedArray(arr) {
-  return !!(isArray(arr) && arr.length > 0);
-}
-
-function deleteValues(keyPairObj) {
-  if (isPopulatedArray(keyPairObj.value) && keyPairObj.value[0] === '') {
-    delete keyPairObj.value;
-  }
-}
-
 function formatRequest(payload, bidderRequest) {
   let request = [];
   let options = {
@@ -402,6 +387,7 @@ function newBid(serverBid, rtbBid, bidderRequest) {
   const bid = {
     adType: rtbBid.ad_type,
     requestId: serverBid.uuid,
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     auctionId: bidRequest.auctionId,
     cpm: rtbBid.cpm,
     creativeId: rtbBid.creative_id,
@@ -497,14 +483,7 @@ function bidToTag(bid) {
   if (bid.params.externalImpId) {
     tag.external_imp_id = bid.params.externalImpId;
   }
-  if (!isEmpty(bid.params.keywords)) {
-    let keywords = transformBidderParamKeywords(bid.params.keywords);
-
-    if (keywords.length > 0) {
-      keywords.forEach(deleteValues);
-    }
-    tag.keywords = keywords;
-  }
+  tag.keywords = getANKeywordParam(bid.ortb2, bid.params.keywords)
 
   let gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
   if (gpid) {

package/modules/xeBidAdapter.js

@@ -44,8 +44,9 @@ function buildRequests(validBidRequests, bidderRequest) {
     const request = {};
     request.bidId = req.bidId;
     request.banner = deepAccess(req, 'mediaTypes.banner');
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     request.auctionId = req.auctionId;
-    request.transactionId = req.transactionId;
+    request.transactionId = req.ortb2Imp?.ext?.tid;
     request.sizes = parseSizesInput(getAdUnitSizes(req));
     request.schain = req.schain;
     request.location = {

package/modules/yieldliftBidAdapter.js

@@ -1,4 +1,4 @@
-import {deepSetValue, logInfo, deepAccess} from '../src/utils.js';
+import {deepAccess, deepSetValue, logInfo} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
 
@@ -41,7 +41,7 @@ export const spec = {
     }));
 
     const openrtbRequest = {
-      id: bidderRequest.auctionId,
+      id: bidderRequest.bidderRequestId,
       imp: impressions,
       site: {
         domain: bidderRequest.refererInfo?.domain,

package/modules/yieldmoBidAdapter.js

@@ -258,6 +258,7 @@ function addPlacement(request) {
     placementInfo.tid = transactionId;
   }
   if (request.auctionId) {
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     placementInfo.auctionId = request.auctionId;
   }
   return JSON.stringify(placementInfo);

package/modules/yieldoneBidAdapter.js

@@ -50,7 +50,7 @@ export const spec = {
       // TODO: is 'page' the right value here?
       const referrer = bidderRequest.refererInfo.page;
       const bidId = bidRequest.bidId;
-      const transactionId = bidRequest.transactionId;
+      const transactionId = bidRequest.ortb2Imp?.ext?.tid;
       const unitCode = bidRequest.adUnitCode;
       const timeout = bidderRequest.timeout;
       const language = window.navigator.language;

package/modules/zetaBidAdapter.js

@@ -1,6 +1,7 @@
-import { logWarn, deepAccess } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
+import {deepAccess, logWarn} from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
+
 const BIDDER_CODE = 'zeta_global';
 const PREBID_DEFINER_ID = '44253'
 const ENDPOINT_URL = 'https://prebid.rfihub.com/prebid';
@@ -40,12 +41,6 @@ export const spec = {
       return false;
     }
 
-    if (!(bid.params.device.geo &&
-          bid.params.device.geo.country)) {
-      logWarn('Invalid bid request - missing required geo data');
-      return false;
-    }
-
     if (!bid.params.definerId) {
       logWarn('Invalid bid request - missing required definer data');
       return false;
@@ -71,7 +66,7 @@ export const spec = {
       banner: buildBanner(request)
     };
     let payload = {
-      id: bidderRequest.auctionId,
+      id: bidderRequest.bidderRequestId,
       imp: [impData],
       site: params.site ? params.site : {},
       app: params.app ? params.app : {},

package/modules/zeta_global_sspBidAdapter.js

@@ -113,7 +113,7 @@ export const spec = {
     });
 
     let payload = {
-      id: bidderRequest.auctionId,
+      id: bidderRequest.bidderRequestId,
       cur: [DEFAULT_CUR],
       imp: imps,
       site: params.site ? params.site : {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.53.0",
+  "version": "8.0.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/src/activities/activities.js

@@ -45,3 +45,8 @@ export const ACTIVITY_TRANSMIT_UFPD = 'transmitUfpd';
  * transmitPreciseGeo: some component wants access to (and send along) geolocation info
  */
 export const ACTIVITY_TRANSMIT_PRECISE_GEO = 'transmitPreciseGeo';
+
+/**
+ * transmit TID: some component wants access ot (and send along) transaction IDs
+ */
+export const ACTIVITY_TRANSMIT_TID = 'transmitTid';

package/src/activities/redactor.js

@@ -1,6 +1,12 @@
 import {deepAccess} from '../utils.js';
-import {isActivityAllowed} from './rules.js';
-import {ACTIVITY_TRANSMIT_EIDS, ACTIVITY_TRANSMIT_PRECISE_GEO, ACTIVITY_TRANSMIT_UFPD} from './activities.js';
+import {config} from '../config.js';
+import {isActivityAllowed, registerActivityControl} from './rules.js';
+import {
+  ACTIVITY_TRANSMIT_EIDS,
+  ACTIVITY_TRANSMIT_PRECISE_GEO,
+  ACTIVITY_TRANSMIT_TID,
+  ACTIVITY_TRANSMIT_UFPD
+} from './activities.js';
 
 export const ORTB_UFPD_PATHS = ['user.data', 'user.ext.data'];
 export const ORTB_EIDS_PATHS = ['user.eids', 'user.ext.eids'];
@@ -74,16 +80,12 @@ export function objectTransformer(rules) {
   })
   return function applyTransform(session, obj, ...args) {
     const result = [];
+    const applies = sessionedApplies(session, ...args);
     rules.forEach(rule => {
       if (session[rule.name] === false) return;
       for (const [head, tail] of rule.paths) {
         const parent = head == null ? obj : deepAccess(obj, head);
-        result.push(rule.run(obj, head, parent, tail, () => {
-          if (!session.hasOwnProperty(rule.name)) {
-            session[rule.name] = !!rule.applies(...args);
-          }
-          return session[rule.name]
-        }))
+        result.push(rule.run(obj, head, parent, tail, applies.bind(null, rule)));
         if (session[rule.name] === false) return;
       }
     })
@@ -91,6 +93,15 @@ export function objectTransformer(rules) {
   }
 }
 
+export function sessionedApplies(session, ...args) {
+  return function applies(rule) {
+    if (!session.hasOwnProperty(rule.name)) {
+      session[rule.name] = !!rule.applies(...args);
+    }
+    return session[rule.name];
+  }
+}
+
 export function isData(val) {
   return val != null && (typeof val !== 'object' || Object.keys(val).length > 0)
 }
@@ -107,6 +118,11 @@ function bidRequestTransmitRules(isAllowed = isActivityAllowed) {
       name: ACTIVITY_TRANSMIT_EIDS,
       paths: ['userId', 'userIdAsEids'],
       applies: appliesWhenActivityDenied(ACTIVITY_TRANSMIT_EIDS, isAllowed),
+    },
+    {
+      name: ACTIVITY_TRANSMIT_TID,
+      paths: ['ortb2Imp.ext.tid'],
+      applies: appliesWhenActivityDenied(ACTIVITY_TRANSMIT_TID, isAllowed)
     }
   ].map(redactRule)
 }
@@ -130,6 +146,11 @@ export function ortb2TransmitRules(isAllowed = isActivityAllowed) {
       get(val) {
         return Math.round((val + Number.EPSILON) * 100) / 100;
       }
+    },
+    {
+      name: ACTIVITY_TRANSMIT_TID,
+      paths: ['source.tid'],
+      applies: appliesWhenActivityDenied(ACTIVITY_TRANSMIT_TID, isAllowed),
     }
   ].map(redactRule);
 }
@@ -155,3 +176,10 @@ export function redactorFactory(isAllowed = isActivityAllowed) {
  *  that can redact disallowed data from ORTB2 and/or bid request objects.
  */
 export const redactor = redactorFactory();
+
+// by default, TIDs are off since version 8
+registerActivityControl(ACTIVITY_TRANSMIT_TID, 'enableTIDs config', () => {
+  if (!config.getConfig('enableTIDs')) {
+    return {allow: false, reason: 'TIDs are disabled'}
+  }
+});