prebid.js 5.14.0 → 5.18.0

package/modules/openxAnalyticsAdapter.js

@@ -1,10 +1,10 @@
+import { logInfo, logError, getWindowLocation, parseQS, logMessage, _each, deepAccess, logWarn, _map, flatten, uniques, isEmpty, parseSizesInput } from '../src/utils.js';
 import adapter from '../src/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { ajax } from '../src/ajax.js';
 import find from 'core-js-pure/features/array/find.js';
 import includes from 'core-js-pure/features/array/includes.js';
-const utils = require('../src/utils.js');
 
 export const AUCTION_STATES = {
   INIT: 'initialized', // auction has initialized
@@ -92,7 +92,7 @@ openxAdapter.enableAnalytics = function(adapterConfig = {options: {}}) {
     // campaign properties defined by config will override utm query parameters
     analyticsConfig.campaign = {...buildCampaignFromUtmCodes(), ...analyticsConfig.campaign};
 
-    utils.logInfo('OpenX Analytics enabled with config', analyticsConfig);
+    logInfo('OpenX Analytics enabled with config', analyticsConfig);
 
     // override track method with v2 handlers
     openxAdapter.track = prebidAnalyticsEventHandler;
@@ -103,7 +103,7 @@ openxAdapter.enableAnalytics = function(adapterConfig = {options: {}}) {
       if (pubads.addEventListener) {
         pubads.addEventListener(SLOT_LOADED, args => {
           openxAdapter.track({eventType: SLOT_LOADED, args});
-          utils.logInfo('OX: SlotOnLoad event triggered');
+          logInfo('OX: SlotOnLoad event triggered');
         });
       }
     });
@@ -160,9 +160,9 @@ function isValidConfig({options: analyticsOptions}) {
     let [property, type, required] = failedValidation;
 
     if (required) {
-      utils.logError(`OpenXAnalyticsAdapter: Expected '${property}' to exist and of type '${type}'`);
+      logError(`OpenXAnalyticsAdapter: Expected '${property}' to exist and of type '${type}'`);
     } else {
-      utils.logError(`OpenXAnalyticsAdapter: Expected '${property}' to be type '${type}'`);
+      logError(`OpenXAnalyticsAdapter: Expected '${property}' to be type '${type}'`);
     }
   }
 
@@ -170,8 +170,8 @@ function isValidConfig({options: analyticsOptions}) {
 }
 
 function buildCampaignFromUtmCodes() {
-  const location = utils.getWindowLocation();
-  const queryParams = utils.parseQS(location && location.search);
+  const location = getWindowLocation();
+  const queryParams = parseQS(location && location.search);
   let campaign = {};
 
   UTM_TAGS.forEach(function(utmKey) {
@@ -231,7 +231,7 @@ function detectBrowser() {
 }
 
 function prebidAnalyticsEventHandler({eventType, args}) {
-  utils.logMessage(eventType, Object.assign({}, args));
+  logMessage(eventType, Object.assign({}, args));
   switch (eventType) {
     case AUCTION_INIT:
       onAuctionInit(args);
@@ -401,8 +401,8 @@ function onBidResponse(bidResponse) {
 }
 
 function onBidTimeout(args) {
-  utils._each(args, ({auctionId, adUnitCode, bidId: requestId}) => {
-    let timedOutRequest = utils.deepAccess(auctionMap,
+  _each(args, ({auctionId, adUnitCode, bidId: requestId}) => {
+    let timedOutRequest = deepAccess(auctionMap,
       `${auctionId}.adUnitCodeToAdUnitMap.${adUnitCode}.bidRequestsMap.${requestId}`);
 
     if (timedOutRequest) {
@@ -433,7 +433,7 @@ function onAuctionEnd(endedAuction) {
  */
 function onBidWon(bidResponse) {
   const { auctionId, adUnitCode, requestId, adId } = bidResponse;
-  let winningBid = utils.deepAccess(auctionMap,
+  let winningBid = deepAccess(auctionMap,
     `${auctionId}.adUnitCodeToAdUnitMap.${adUnitCode}.bidRequestsMap.${requestId}.bids.${adId}`);
 
   if (winningBid) {
@@ -444,10 +444,10 @@ function onBidWon(bidResponse) {
       const bidder = auction.adUnitCodeToAdUnitMap[adUnitCode].bidRequestsMap[requestId].bidder;
       ajax(`${endpoint}?t=win&b=${adId}&a=${analyticsConfig.orgId}&bidder=${bidder}&ts=${auction.startTime}`,
         () => {
-          utils.logInfo(`Openx Analytics - Sending complete impression event for ${adId} at ${Date.now()}`)
+          logInfo(`Openx Analytics - Sending complete impression event for ${adId} at ${Date.now()}`)
         });
     } else {
-      utils.logInfo(`Openx Analytics - impression event for ${adId} will be sent with auction data`)
+      logInfo(`Openx Analytics - impression event for ${adId} will be sent with auction data`)
     }
   }
 }
@@ -522,7 +522,7 @@ function isAtf(elementId, scrollLeft = 0, scrollTop = 0) {
       }
     }
   } else {
-    utils.logWarn('OX: DOM element not for id ' + elementId);
+    logWarn('OX: DOM element not for id ' + elementId);
   }
   return isAtf;
 }
@@ -552,7 +552,7 @@ function delayedSend(auction) {
     let payload = JSON.stringify([buildAuctionPayload(auction)]);
 
     ajax(analyticsConfig.endpoint || ENDPOINT, () => {
-      utils.logInfo(`OpenX Analytics - Sending complete auction at ${Date.now()}`);
+      logInfo(`OpenX Analytics - Sending complete auction at ${Date.now()}`);
     }, payload, { contentType: 'application/json' });
   }, delayTime);
 }
@@ -579,15 +579,15 @@ function getPathToBidResponseByBidId(bidId) {
     return [];
   }
 
-  utils._each(auctionMap, currentAuction => {
+  _each(auctionMap, currentAuction => {
     // skip completed auctions
     if (currentAuction.state === AUCTION_STATES.COMPLETED) {
       return;
     }
 
-    utils._each(currentAuction.adUnitCodeToAdUnitMap, (currentAdunit) => {
-      utils._each(currentAdunit.bidRequestsMap, currentBiddRequest => {
-        utils._each(currentBiddRequest.bids, (currentBidResponse, bidResponseId) => {
+    _each(currentAuction.adUnitCodeToAdUnitMap, (currentAdunit) => {
+      _each(currentAdunit.bidRequestsMap, currentBiddRequest => {
+        _each(currentBiddRequest.bids, (currentBidResponse, bidResponseId) => {
           if (bidId === bidResponseId) {
             auction = currentAuction;
             adUnit = currentAdunit;
@@ -604,12 +604,12 @@ function getAuctionByGoogleTagSLot(slot) {
   let slotAdunitCodes = [slot.getSlotElementId(), slot.getAdUnitPath()];
   let slotAuction;
 
-  utils._each(auctionMap, auction => {
+  _each(auctionMap, auction => {
     if (auction.state === AUCTION_STATES.COMPLETED) {
       return;
     }
 
-    utils._each(auction.adUnitCodeToAdUnitMap, (bidderRequestIdMap, adUnitCode) => {
+    _each(auction.adUnitCodeToAdUnitMap, (bidderRequestIdMap, adUnitCode) => {
       if (includes(slotAdunitCodes, adUnitCode)) {
         slotAuction = auction;
       }
@@ -649,7 +649,7 @@ function buildAuctionPayload(auction) {
   };
 
   function buildAdUnitsPayload(adUnitCodeToAdUnitMap) {
-    return utils._map(adUnitCodeToAdUnitMap, (adUnit) => {
+    return _map(adUnitCodeToAdUnitMap, (adUnit) => {
       let {code, adPosition} = adUnit;
 
       return {
@@ -659,7 +659,7 @@ function buildAuctionPayload(auction) {
       };
 
       function buildBidRequestPayload(bidRequestsMap) {
-        return utils._map(bidRequestsMap, (bidRequest) => {
+        return _map(bidRequestsMap, (bidRequest) => {
           let {bidder, source, bids, mediaTypes, timeLimit, timedOut} = bidRequest;
           return {
             bidder,
@@ -669,7 +669,7 @@ function buildAuctionPayload(auction) {
             availableMediaTypes: getMediaTypes(mediaTypes),
             timeLimit,
             timedOut,
-            bidResponses: utils._map(bidRequest.bids, (bidderBidResponse) => {
+            bidResponses: _map(bidRequest.bids, (bidderBidResponse) => {
               let {
                 adId,
                 cpm,
@@ -716,11 +716,11 @@ function buildAuctionPayload(auction) {
   }
 
   function buildUserIdProviders(userIds) {
-    return utils._map(userIds, (userId) => {
-      return utils._map(userId, (id, module) => {
+    return _map(userIds, (userId) => {
+      return _map(userId, (id, module) => {
         return hasUserData(module, id) ? module : false
       }).filter(module => module);
-    }).reduce(utils.flatten, []).filter(utils.uniques).sort();
+    }).reduce(flatten, []).filter(uniques).sort();
   }
 
   function hasUserData(module, idOrIdObject) {
@@ -728,7 +728,7 @@ function buildAuctionPayload(auction) {
 
     switch (module) {
       case 'digitrustid':
-        normalizedId = utils.deepAccess(idOrIdObject, 'data.id');
+        normalizedId = deepAccess(idOrIdObject, 'data.id');
         break;
       case 'lipb':
         normalizedId = idOrIdObject.lipbid;
@@ -737,17 +737,17 @@ function buildAuctionPayload(auction) {
         normalizedId = idOrIdObject;
     }
 
-    return !utils.isEmpty(normalizedId);
+    return !isEmpty(normalizedId);
   }
 
   function getMediaTypeSizes(mediaTypes) {
-    return utils._map(mediaTypes, (mediaTypeConfig, mediaType) => {
-      return utils.parseSizesInput(mediaTypeConfig.sizes)
+    return _map(mediaTypes, (mediaTypeConfig, mediaType) => {
+      return parseSizesInput(mediaTypeConfig.sizes)
         .map(size => `${mediaType}_${size}`);
-    }).reduce(utils.flatten, []);
+    }).reduce(flatten, []);
   }
 
   function getMediaTypes(mediaTypes) {
-    return utils._map(mediaTypes, (mediaTypeConfig, mediaType) => mediaType);
+    return _map(mediaTypes, (mediaTypeConfig, mediaType) => mediaType);
   }
 }

package/modules/openxBidAdapter.js

@@ -1,6 +1,6 @@
+import { deepAccess, convertTypes, isArray, inIframe, _map, deepSetValue, _each, parseSizesInput, parseUrl } from '../src/utils.js';
 import {config} from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import * as utils from '../src/utils.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import includes from 'core-js-pure/features/array/includes.js'
 
@@ -51,8 +51,8 @@ export const spec = {
   supportedMediaTypes: SUPPORTED_AD_TYPES,
   isBidRequestValid: function (bidRequest) {
     const hasDelDomainOrPlatform = bidRequest.params.delDomain || bidRequest.params.platform;
-    if (utils.deepAccess(bidRequest, 'mediaTypes.banner') && hasDelDomainOrPlatform) {
-      return !!bidRequest.params.unit || utils.deepAccess(bidRequest, 'mediaTypes.banner.sizes.length') > 0;
+    if (deepAccess(bidRequest, 'mediaTypes.banner') && hasDelDomainOrPlatform) {
+      return !!bidRequest.params.unit || deepAccess(bidRequest, 'mediaTypes.banner.sizes.length') > 0;
     }
 
     return !!(bidRequest.params.unit && hasDelDomainOrPlatform);
@@ -87,8 +87,8 @@ export const spec = {
   getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
     if (syncOptions.iframeEnabled || syncOptions.pixelEnabled) {
       let pixelType = syncOptions.iframeEnabled ? 'iframe' : 'image';
-      let url = utils.deepAccess(responses, '0.body.ads.pixels') ||
-        utils.deepAccess(responses, '0.body.pixels') ||
+      let url = deepAccess(responses, '0.body.ads.pixels') ||
+        deepAccess(responses, '0.body.pixels') ||
         generateDefaultSyncUrl(gdprConsent, uspConsent);
 
       return [{
@@ -98,7 +98,7 @@ export const spec = {
     }
   },
   transformBidParams: function(params, isOpenRtb) {
-    return utils.convertTypes({
+    return convertTypes({
       'unit': 'string',
       'customFloor': 'number'
     }, params);
@@ -123,7 +123,7 @@ function generateDefaultSyncUrl(gdprConsent, uspConsent) {
 }
 
 function isVideoRequest(bidRequest) {
-  return (utils.deepAccess(bidRequest, 'mediaTypes.video') && !utils.deepAccess(bidRequest, 'mediaTypes.banner')) || bidRequest.mediaType === VIDEO;
+  return (deepAccess(bidRequest, 'mediaTypes.video') && !deepAccess(bidRequest, 'mediaTypes.banner')) || bidRequest.mediaType === VIDEO;
 }
 
 function createBannerBidResponses(oxResponseObj, {bids, startTime}) {
@@ -215,7 +215,7 @@ function getViewportDimensions(isIfr) {
 
 function formatCustomParms(customKey, customParams) {
   let value = customParams[customKey];
-  if (utils.isArray(value)) {
+  if (isArray(value)) {
     // if value is an array, join them with commas first
     value = value.join(',');
   }
@@ -240,7 +240,7 @@ function getMediaTypeFromRequest(serverRequest) {
 }
 
 function buildCommonQueryParamsFromBids(bids, bidderRequest) {
-  const isInIframe = utils.inIframe();
+  const isInIframe = inIframe();
   let defaultParams;
 
   defaultParams = {
@@ -252,7 +252,7 @@ function buildCommonQueryParamsFromBids(bids, bidderRequest) {
     tws: getViewportDimensions(isInIframe),
     be: 1,
     bc: bids[0].params.bc || `${BIDDER_CONFIG}_${BIDDER_VERSION}`,
-    dddid: utils._map(bids, bid => bid.transactionId).join(','),
+    dddid: _map(bids, bid => bid.transactionId).join(','),
     nocache: new Date().getTime()
   };
 
@@ -304,8 +304,8 @@ function buildCommonQueryParamsFromBids(bids, bidderRequest) {
   }
 
   // normalize publisher common id
-  if (utils.deepAccess(bids[0], 'crumbs.pubcid')) {
-    utils.deepSetValue(bids[0], 'userId.pubcid', utils.deepAccess(bids[0], 'crumbs.pubcid'));
+  if (deepAccess(bids[0], 'crumbs.pubcid')) {
+    deepSetValue(bids[0], 'userId.pubcid', deepAccess(bids[0], 'crumbs.pubcid'));
   }
   defaultParams = appendUserIdsToQueryParams(defaultParams, bids[0].userId);
 
@@ -318,7 +318,7 @@ function buildCommonQueryParamsFromBids(bids, bidderRequest) {
 }
 
 function appendUserIdsToQueryParams(queryParams, userIds) {
-  utils._each(userIds, (userIdObjectOrValue, userIdProviderKey) => {
+  _each(userIds, (userIdObjectOrValue, userIdProviderKey) => {
     const key = USER_ID_CODE_TO_QUERY_ARG[userIdProviderKey];
 
     if (USER_ID_CODE_TO_QUERY_ARG.hasOwnProperty(userIdProviderKey)) {
@@ -371,13 +371,13 @@ function buildOXBannerRequest(bids, bidderRequest) {
   let customParamsForAllBids = [];
   let hasCustomParam = false;
   let queryParams = buildCommonQueryParamsFromBids(bids, bidderRequest);
-  let auids = utils._map(bids, bid => bid.params.unit);
+  let auids = _map(bids, bid => bid.params.unit);
 
-  queryParams.aus = utils._map(bids, bid => utils.parseSizesInput(bid.mediaTypes.banner.sizes).join(',')).join('|');
-  queryParams.divids = utils._map(bids, bid => encodeURIComponent(bid.adUnitCode)).join(',');
+  queryParams.aus = _map(bids, bid => parseSizesInput(bid.mediaTypes.banner.sizes).join(',')).join('|');
+  queryParams.divids = _map(bids, bid => encodeURIComponent(bid.adUnitCode)).join(',');
   // gpid
-  queryParams.aucs = utils._map(bids, function (bid) {
-    let gpid = utils.deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
+  queryParams.aucs = _map(bids, function (bid) {
+    let gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
     return encodeURIComponent(gpid || '')
   }).join(',');
 
@@ -395,7 +395,7 @@ function buildOXBannerRequest(bids, bidderRequest) {
 
   bids.forEach(function (bid) {
     if (bid.params.customParams) {
-      let customParamsForBid = utils._map(Object.keys(bid.params.customParams), customKey => formatCustomParms(customKey, bid.params.customParams));
+      let customParamsForBid = _map(Object.keys(bid.params.customParams), customKey => formatCustomParms(customKey, bid.params.customParams));
       let formattedCustomParams = window.btoa(customParamsForBid.join('&'));
       hasCustomParam = true;
       customParamsForAllBids.push(formattedCustomParams);
@@ -435,22 +435,22 @@ function buildOXVideoRequest(bid, bidderRequest) {
 }
 
 function generateVideoParameters(bid, bidderRequest) {
-  const videoMediaType = utils.deepAccess(bid, `mediaTypes.video`);
+  const videoMediaType = deepAccess(bid, `mediaTypes.video`);
   let queryParams = buildCommonQueryParamsFromBids([bid], bidderRequest);
-  let oxVideoConfig = utils.deepAccess(bid, 'params.video') || {};
-  let context = utils.deepAccess(bid, 'mediaTypes.video.context');
-  let playerSize = utils.deepAccess(bid, 'mediaTypes.video.playerSize');
+  let oxVideoConfig = deepAccess(bid, 'params.video') || {};
+  let context = deepAccess(bid, 'mediaTypes.video.context');
+  let playerSize = deepAccess(bid, 'mediaTypes.video.playerSize');
   let width;
   let height;
 
   // normalize config for video size
-  if (utils.isArray(bid.sizes) && bid.sizes.length === 2 && !utils.isArray(bid.sizes[0])) {
+  if (isArray(bid.sizes) && bid.sizes.length === 2 && !isArray(bid.sizes[0])) {
     width = parseInt(bid.sizes[0], 10);
     height = parseInt(bid.sizes[1], 10);
-  } else if (utils.isArray(bid.sizes) && utils.isArray(bid.sizes[0]) && bid.sizes[0].length === 2) {
+  } else if (isArray(bid.sizes) && isArray(bid.sizes[0]) && bid.sizes[0].length === 2) {
     width = parseInt(bid.sizes[0][0], 10);
     height = parseInt(bid.sizes[0][1], 10);
-  } else if (utils.isArray(playerSize) && playerSize.length === 2) {
+  } else if (isArray(playerSize) && playerSize.length === 2) {
     width = parseInt(playerSize[0], 10);
     height = parseInt(playerSize[1], 10);
   }
@@ -463,7 +463,7 @@ function generateVideoParameters(bid, bidderRequest) {
     legacyParams = legacyParams.openrtb;
   }
   // support for video object or full openrtb object
-  if (utils.isArray(legacyParams.imp)) {
+  if (isArray(legacyParams.imp)) {
     legacyParams = legacyParams.imp[0].video;
   }
   Object.keys(legacyParams)
@@ -502,7 +502,7 @@ function generateVideoParameters(bid, bidderRequest) {
     queryParams.vtest = 1;
   }
 
-  let gpid = utils.deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
+  let gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
   if (gpid) {
     queryParams.aucs = encodeURIComponent(gpid)
   }
@@ -517,7 +517,7 @@ function createVideoBidResponses(response, {bid, startTime}) {
   let bidResponses = [];
 
   if (response !== undefined && response.vastUrl !== '' && response.pub_rev > 0) {
-    let vastQueryParams = utils.parseUrl(response.vastUrl).search || {};
+    let vastQueryParams = parseUrl(response.vastUrl).search || {};
     let bidResponse = {};
     bidResponse.requestId = bid.bidId;
     if (response.deal_id) {