prebid.js 5.14.0 → 5.18.0

package/modules/prebidmanagerAnalyticsAdapter.js

@@ -1,3 +1,4 @@
+import { generateUUID, getParameterByName, logError, parseUrl, logInfo } from '../src/utils.js';
 import {ajaxBuilder} from '../src/ajax.js';
 import adapter from '../src/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
@@ -11,13 +12,12 @@ const DEFAULT_EVENT_URL = 'https://endpoint.prebidmanager.com/endpoint'
 const analyticsType = 'endpoint';
 const analyticsName = 'Prebid Manager Analytics: ';
 
-var utils = require('../src/utils.js');
 var CONSTANTS = require('../src/constants.json');
 let ajax = ajaxBuilder(0);
 
 var _VERSION = 1;
 var initOptions = null;
-var _pageViewId = utils.generateUUID();
+var _pageViewId = generateUUID();
 var _startAuction = 0;
 var _bidRequestTimeout = 0;
 let flushInterval;
@@ -76,7 +76,7 @@ function collectUtmTagData() {
   let pmUtmTags = {};
   try {
     utmTags.forEach(function (utmKey) {
-      let utmValue = utils.getParameterByName(utmKey);
+      let utmValue = getParameterByName(utmKey);
       if (utmValue !== '') {
         newUtm = true;
       }
@@ -95,7 +95,7 @@ function collectUtmTagData() {
       });
     }
   } catch (e) {
-    utils.logError(`${analyticsName}Error`, e);
+    logError(`${analyticsName}Error`, e);
     pmUtmTags['error_utm'] = 1;
   }
   return pmUtmTags;
@@ -106,7 +106,7 @@ function collectPageInfo() {
     domain: window.location.hostname,
   }
   if (document.referrer) {
-    pageInfo.referrerDomain = utils.parseUrl(document.referrer).hostname;
+    pageInfo.referrerDomain = parseUrl(document.referrer).hostname;
   }
   return pageInfo;
 }
@@ -128,7 +128,7 @@ function flush() {
 
     ajax(
       initOptions.url,
-      () => utils.logInfo(`${analyticsName} sent events batch`),
+      () => logInfo(`${analyticsName} sent events batch`),
       _VERSION + ':' + JSON.stringify(data),
       {
         contentType: 'text/plain',
@@ -215,7 +215,7 @@ function handleEvent(eventType, eventArgs) {
 
 function sendEvent(event) {
   _eventQueue.push(event);
-  utils.logInfo(`${analyticsName}Event ${event.eventType}:`, event);
+  logInfo(`${analyticsName}Event ${event.eventType}:`, event);
 
   if (event.eventType === CONSTANTS.EVENTS.AUCTION_END) {
     flush();

package/modules/priceFloors.js

@@ -1,6 +1,6 @@
+import { parseUrl, deepAccess, parseGPTSingleSizeArray, getGptSlotInfoForAdUnitCode, deepSetValue, logWarn, deepClone, getParameterByName, generateUUID, logError, logInfo, isNumber, pick, debugTurnedOn } from '../src/utils.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 import { config } from '../src/config.js';
-import * as utils from '../src/utils.js';
 import { ajaxBuilder } from '../src/ajax.js';
 import events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
@@ -60,13 +60,13 @@ function roundUp(number, precision) {
 
 let referrerHostname;
 function getHostNameFromReferer(referer) {
-  referrerHostname = utils.parseUrl(referer, {noDecodeWholeURL: true}).hostname;
+  referrerHostname = parseUrl(referer, {noDecodeWholeURL: true}).hostname;
   return referrerHostname;
 }
 
 // First look into bidRequest!
 function getGptSlotFromBidRequest(bidRequest) {
-  const isGam = utils.deepAccess(bidRequest, 'ortb2Imp.ext.data.adserver.name') === 'gam';
+  const isGam = deepAccess(bidRequest, 'ortb2Imp.ext.data.adserver.name') === 'gam';
   return isGam && bidRequest.ortb2Imp.ext.data.adserver.adslot;
 }
 
@@ -74,9 +74,9 @@ function getGptSlotFromBidRequest(bidRequest) {
  * @summary floor field types with their matching functions to resolve the actual matched value
  */
 export let fieldMatchingFunctions = {
-  'size': (bidRequest, bidResponse) => utils.parseGPTSingleSizeArray(bidResponse.size) || '*',
+  'size': (bidRequest, bidResponse) => parseGPTSingleSizeArray(bidResponse.size) || '*',
   'mediaType': (bidRequest, bidResponse) => bidResponse.mediaType || 'banner',
-  'gptSlot': (bidRequest, bidResponse) => getGptSlotFromBidRequest(bidRequest) || utils.getGptSlotInfoForAdUnitCode(bidRequest.adUnitCode).gptSlot,
+  'gptSlot': (bidRequest, bidResponse) => getGptSlotFromBidRequest(bidRequest) || getGptSlotInfoForAdUnitCode(bidRequest.adUnitCode).gptSlot,
   'domain': (bidRequest, bidResponse) => referrerHostname || getHostNameFromReferer(getRefererInfo().referer),
   'adUnitCode': (bidRequest, bidResponse) => bidRequest.adUnitCode
 }
@@ -101,17 +101,17 @@ function enumeratePossibleFieldValues(floorFields, bidObject, responseObject) {
  * Generates all possible rule matches and picks the first matching one.
  */
 export function getFirstMatchingFloor(floorData, bidObject, responseObject = {}) {
-  let fieldValues = enumeratePossibleFieldValues(utils.deepAccess(floorData, 'schema.fields') || [], bidObject, responseObject);
+  let fieldValues = enumeratePossibleFieldValues(deepAccess(floorData, 'schema.fields') || [], bidObject, responseObject);
   if (!fieldValues.length) return { matchingFloor: floorData.default };
 
   // look to see if a request for this context was made already
   let matchingInput = fieldValues.map(field => field[0]).join('-');
   // if we already have gotten the matching rule from this matching input then use it! No need to look again
-  let previousMatch = utils.deepAccess(floorData, `matchingInputs.${matchingInput}`);
+  let previousMatch = deepAccess(floorData, `matchingInputs.${matchingInput}`);
   if (previousMatch) {
     return {...previousMatch};
   }
-  let allPossibleMatches = generatePossibleEnumerations(fieldValues, utils.deepAccess(floorData, 'schema.delimiter') || '|');
+  let allPossibleMatches = generatePossibleEnumerations(fieldValues, deepAccess(floorData, 'schema.delimiter') || '|');
   let matchingRule = find(allPossibleMatches, hashValue => floorData.values.hasOwnProperty(hashValue));
 
   let matchingData = {
@@ -122,7 +122,7 @@ export function getFirstMatchingFloor(floorData, bidObject, responseObject = {})
   };
   matchingData.matchingFloor = Math.max(matchingData.floorMin, matchingData.floorRuleValue);
   // save for later lookup if needed
-  utils.deepSetValue(floorData, `matchingInputs.${matchingInput}`, {...matchingData});
+  deepSetValue(floorData, `matchingInputs.${matchingInput}`, {...matchingData});
   return matchingData;
 }
 
@@ -147,7 +147,7 @@ function generatePossibleEnumerations(arrayOfFields, delimiter) {
  * @summary If a the input bidder has a registered cpmadjustment it returns the input CPM after being adjusted
  */
 export function getBiddersCpmAdjustment(bidderName, inputCpm, bid = {}) {
-  const adjustmentFunction = utils.deepAccess(getGlobal(), `bidderSettings.${bidderName}.bidCpmAdjustment`) || utils.deepAccess(getGlobal(), 'bidderSettings.standard.bidCpmAdjustment');
+  const adjustmentFunction = deepAccess(getGlobal(), `bidderSettings.${bidderName}.bidCpmAdjustment`) || deepAccess(getGlobal(), 'bidderSettings.standard.bidCpmAdjustment');
   if (adjustmentFunction) {
     return parseFloat(adjustmentFunction(inputCpm, {...bid, cpm: inputCpm}));
   }
@@ -167,9 +167,9 @@ export function calculateAdjustedFloor(oldFloor, newFloor) {
  * @summary gets the prebid set sizes depending on the input mediaType
  */
 const getMediaTypesSizes = {
-  banner: (bid) => utils.deepAccess(bid, 'mediaTypes.banner.sizes') || [],
-  video: (bid) => utils.deepAccess(bid, 'mediaTypes.video.playerSize') || [],
-  native: (bid) => utils.deepAccess(bid, 'mediaTypes.native.image.sizes') ? [utils.deepAccess(bid, 'mediaTypes.native.image.sizes')] : []
+  banner: (bid) => deepAccess(bid, 'mediaTypes.banner.sizes') || [],
+  video: (bid) => deepAccess(bid, 'mediaTypes.video.playerSize') || [],
+  native: (bid) => deepAccess(bid, 'mediaTypes.native.image.sizes') ? [deepAccess(bid, 'mediaTypes.native.image.sizes')] : []
 }
 
 /**
@@ -208,7 +208,7 @@ export function getFloor(requestParams = {currency: 'USD', mediaType: '*', size:
     try {
       floorInfo.matchingFloor = getGlobal().convertCurrency(floorInfo.matchingFloor, floorData.data.currency, currency);
     } catch (err) {
-      utils.logWarn(`${MODULE_NAME}: Unable to get currency conversion for getFloor for bidder ${bidRequest.bidder}. You must have currency module enabled with defaultRates in your currency config`);
+      logWarn(`${MODULE_NAME}: Unable to get currency conversion for getFloor for bidder ${bidRequest.bidder}. You must have currency module enabled with defaultRates in your currency config`);
       // since we were unable to convert to the bidders requested currency, we send back just the actual floors currency to them
       currency = floorData.data.currency;
     }
@@ -233,7 +233,7 @@ export function getFloor(requestParams = {currency: 'USD', mediaType: '*', size:
  * @summary Takes a floorsData object and converts it into a hash map with appropriate keys
  */
 export function getFloorsDataForAuction(floorData, adUnitCode) {
-  let auctionFloorData = utils.deepClone(floorData);
+  let auctionFloorData = deepClone(floorData);
   auctionFloorData.schema.delimiter = floorData.schema.delimiter || '|';
   auctionFloorData.values = normalizeRulesForAuction(auctionFloorData, adUnitCode);
   // default the currency to USD if not passed in
@@ -296,10 +296,10 @@ export function updateAdUnitsForAuction(adUnits, floorData, auctionId) {
         skipped: floorData.skipped,
         skipRate: floorData.skipRate,
         floorMin: floorData.floorMin,
-        modelVersion: utils.deepAccess(floorData, 'data.modelVersion'),
-        modelWeight: utils.deepAccess(floorData, 'data.modelWeight'),
-        modelTimestamp: utils.deepAccess(floorData, 'data.modelTimestamp'),
-        location: utils.deepAccess(floorData, 'data.location', 'noData'),
+        modelVersion: deepAccess(floorData, 'data.modelVersion'),
+        modelWeight: deepAccess(floorData, 'data.modelWeight'),
+        modelTimestamp: deepAccess(floorData, 'data.modelTimestamp'),
+        location: deepAccess(floorData, 'data.location', 'noData'),
         floorProvider: floorData.floorProvider,
         fetchStatus: _floorsConfig.fetchStatus
       };
@@ -323,27 +323,27 @@ export function pickRandomModel(modelGroups, weightSum) {
  * @summary Updates the adUnits accordingly and returns the necessary floorsData for the current auction
  */
 export function createFloorsDataForAuction(adUnits, auctionId) {
-  let resolvedFloorsData = utils.deepClone(_floorsConfig);
+  let resolvedFloorsData = deepClone(_floorsConfig);
   // if using schema 2 pick a model here:
-  if (utils.deepAccess(resolvedFloorsData, 'data.floorsSchemaVersion') === 2) {
+  if (deepAccess(resolvedFloorsData, 'data.floorsSchemaVersion') === 2) {
     // merge the models specific stuff into the top level data settings (now it looks like floorsSchemaVersion 1!)
     let { modelGroups, ...rest } = resolvedFloorsData.data;
     resolvedFloorsData.data = Object.assign(rest, pickRandomModel(modelGroups, rest.modelWeightSum));
   }
 
   // if we do not have a floors data set, we will try to use data set on adUnits
-  let useAdUnitData = Object.keys(utils.deepAccess(resolvedFloorsData, 'data.values') || {}).length === 0;
+  let useAdUnitData = Object.keys(deepAccess(resolvedFloorsData, 'data.values') || {}).length === 0;
   if (useAdUnitData) {
     resolvedFloorsData.data = getFloorDataFromAdUnits(adUnits);
   } else {
     resolvedFloorsData.data = getFloorsDataForAuction(resolvedFloorsData.data);
   }
   // if we still do not have a valid floor data then floors is not on for this auction, so skip
-  if (Object.keys(utils.deepAccess(resolvedFloorsData, 'data.values') || {}).length === 0) {
+  if (Object.keys(deepAccess(resolvedFloorsData, 'data.values') || {}).length === 0) {
     resolvedFloorsData.skipped = true;
   } else {
     // determine the skip rate now
-    const auctionSkipRate = utils.getParameterByName('pbjs_skipRate') || resolvedFloorsData.skipRate;
+    const auctionSkipRate = getParameterByName('pbjs_skipRate') || resolvedFloorsData.skipRate;
     const isSkipped = Math.random() * 100 < parseFloat(auctionSkipRate);
     resolvedFloorsData.skipped = isSkipped;
   }
@@ -364,7 +364,7 @@ export function continueAuction(hookConfig) {
     _delayedAuctions = _delayedAuctions.filter(auctionConfig => auctionConfig.timer !== hookConfig.timer);
 
     // We need to know the auctionId at this time. So we will use the passed in one or generate and set it ourselves
-    hookConfig.reqBidsConfigObj.auctionId = hookConfig.reqBidsConfigObj.auctionId || utils.generateUUID();
+    hookConfig.reqBidsConfigObj.auctionId = hookConfig.reqBidsConfigObj.auctionId || generateUUID();
 
     // now we do what we need to with adUnits and save the data object to be used for getFloor and enforcement calls
     _floorDataForAuction[hookConfig.reqBidsConfigObj.auctionId] = createFloorsDataForAuction(hookConfig.reqBidsConfigObj.adUnits || getGlobal().adUnits, hookConfig.reqBidsConfigObj.auctionId);
@@ -378,7 +378,7 @@ function validateSchemaFields(fields) {
   if (Array.isArray(fields) && fields.length > 0 && fields.every(field => allowedFields.indexOf(field) !== -1)) {
     return true;
   }
-  utils.logError(`${MODULE_NAME}: Fields recieved do not match allowed fields`);
+  logError(`${MODULE_NAME}: Fields recieved do not match allowed fields`);
   return false;
 }
 
@@ -406,7 +406,7 @@ function validateRules(floorsData, numFields, delimiter) {
 
 function modelIsValid(model) {
   // schema.fields has only allowed attributes
-  if (!validateSchemaFields(utils.deepAccess(model, 'schema.fields'))) {
+  if (!validateSchemaFields(deepAccess(model, 'schema.fields'))) {
     return false;
   }
   return validateRules(model, model.schema.fields.length, model.schema.delimiter || '|')
@@ -446,7 +446,7 @@ export function isFloorsDataValid(floorsData) {
   }
   floorsData.floorsSchemaVersion = floorsData.floorsSchemaVersion || 1;
   if (typeof floorsSchemaValidation[floorsData.floorsSchemaVersion] !== 'function') {
-    utils.logError(`${MODULE_NAME}: Unknown floorsSchemaVersion: `, floorsData.floorsSchemaVersion);
+    logError(`${MODULE_NAME}: Unknown floorsSchemaVersion: `, floorsData.floorsSchemaVersion);
     return false;
   }
   return floorsSchemaValidation[floorsData.floorsSchemaVersion](floorsData);
@@ -457,13 +457,13 @@ export function isFloorsDataValid(floorsData) {
  */
 export function parseFloorData(floorsData, location) {
   if (floorsData && typeof floorsData === 'object' && isFloorsDataValid(floorsData)) {
-    utils.logInfo(`${MODULE_NAME}: A ${location} set the auction floor data set to `, floorsData);
+    logInfo(`${MODULE_NAME}: A ${location} set the auction floor data set to `, floorsData);
     return {
       ...floorsData,
       location
     };
   }
-  utils.logError(`${MODULE_NAME}: The floors data did not contain correct values`, floorsData);
+  logError(`${MODULE_NAME}: The floors data did not contain correct values`, floorsData);
 }
 
 /**
@@ -484,7 +484,7 @@ export function requestBidsHook(fn, reqBidsConfigObj) {
   // If auction delay > 0 AND we are fetching -> Then wait until it finishes
   if (_floorsConfig.auctionDelay > 0 && fetching) {
     hookConfig.timer = setTimeout(() => {
-      utils.logWarn(`${MODULE_NAME}: Fetch attempt did not return in time for auction`);
+      logWarn(`${MODULE_NAME}: Fetch attempt did not return in time for auction`);
       _floorsConfig.fetchStatus = 'timeout';
       continueAuction(hookConfig);
     }, _floorsConfig.auctionDelay);
@@ -526,7 +526,7 @@ export function handleFetchResponse(fetchResponse) {
     // set .data to it
     _floorsConfig.data = fetchData;
     // set skipRate override if necessary
-    _floorsConfig.skipRate = utils.isNumber(fetchData.skipRate) ? fetchData.skipRate : _floorsConfig.skipRate;
+    _floorsConfig.skipRate = isNumber(fetchData.skipRate) ? fetchData.skipRate : _floorsConfig.skipRate;
     _floorsConfig.floorProvider = fetchData.floorProvider || _floorsConfig.floorProvider;
   }
 
@@ -537,7 +537,7 @@ export function handleFetchResponse(fetchResponse) {
 function handleFetchError(status) {
   fetching = false;
   _floorsConfig.fetchStatus = 'error';
-  utils.logError(`${MODULE_NAME}: Fetch errored with: `, status);
+  logError(`${MODULE_NAME}: Fetch errored with: `, status);
 
   // if any auctions are waiting for fetch to finish, we need to continue them!
   resumeDelayedAuctions();
@@ -553,13 +553,13 @@ export function generateAndHandleFetch(floorEndpoint) {
     // default to GET and we only support GET for now
     let requestMethod = floorEndpoint.method || 'GET';
     if (requestMethod !== 'GET') {
-      utils.logError(`${MODULE_NAME}: 'GET' is the only request method supported at this time!`);
+      logError(`${MODULE_NAME}: 'GET' is the only request method supported at this time!`);
     } else {
       ajax(floorEndpoint.url, { success: handleFetchResponse, error: handleFetchError }, null, { method: 'GET' });
       fetching = true;
     }
   } else if (fetching) {
-    utils.logWarn(`${MODULE_NAME}: A fetch is already occuring. Skipping.`);
+    logWarn(`${MODULE_NAME}: A fetch is already occuring. Skipping.`);
   }
 }
 
@@ -580,14 +580,14 @@ function addFieldOverrides(overrides) {
  * @summary This is the function which controls what happens during a pbjs.setConfig({...floors: {}}) is called
  */
 export function handleSetFloorsConfig(config) {
-  _floorsConfig = utils.pick(config, [
+  _floorsConfig = pick(config, [
     'floorMin',
     'enabled', enabled => enabled !== false, // defaults to true
     'auctionDelay', auctionDelay => auctionDelay || 0,
-    'floorProvider', floorProvider => utils.deepAccess(config, 'data.floorProvider', floorProvider),
+    'floorProvider', floorProvider => deepAccess(config, 'data.floorProvider', floorProvider),
     'endpoint', endpoint => endpoint || {},
-    'skipRate', () => !isNaN(utils.deepAccess(config, 'data.skipRate')) ? config.data.skipRate : config.skipRate || 0,
-    'enforcement', enforcement => utils.pick(enforcement || {}, [
+    'skipRate', () => !isNaN(deepAccess(config, 'data.skipRate')) ? config.data.skipRate : config.skipRate || 0,
+    'enforcement', enforcement => pick(enforcement || {}, [
       'enforceJS', enforceJS => enforceJS !== false, // defaults to true
       'enforcePBS', enforcePBS => enforcePBS === true, // defaults to false
       'floorDeals', floorDeals => floorDeals === true, // defaults to false
@@ -613,11 +613,11 @@ export function handleSetFloorsConfig(config) {
       getGlobal().requestBids.before(requestBidsHook, 50);
       // if user has debug on then we want to allow the debugging module to run before this, assuming they are testing priceFloors
       // debugging is currently set at 5 priority
-      getHook('addBidResponse').before(addBidResponseHook, utils.debugTurnedOn() ? 4 : 50);
+      getHook('addBidResponse').before(addBidResponseHook, debugTurnedOn() ? 4 : 50);
       addedFloorsHook = true;
     }
   } else {
-    utils.logInfo(`${MODULE_NAME}: Turning off module`);
+    logInfo(`${MODULE_NAME}: Turning off module`);
 
     _floorsConfig = {};
     _floorDataForAuction = {};
@@ -653,8 +653,8 @@ function addFloorDataToBid(floorData, floorInfo, bid, adjustedCpm) {
  * @summary takes the enforcement flags and the bid itself and determines if it should be floored
  */
 function shouldFloorBid(floorData, floorInfo, bid) {
-  let enforceJS = utils.deepAccess(floorData, 'enforcement.enforceJS') !== false;
-  let shouldFloorDeal = utils.deepAccess(floorData, 'enforcement.floorDeals') === true || !bid.dealId;
+  let enforceJS = deepAccess(floorData, 'enforcement.enforceJS') !== false;
+  let shouldFloorDeal = deepAccess(floorData, 'enforcement.floorDeals') === true || !bid.dealId;
   let bidBelowFloor = bid.floorData.cpmAfterAdjustments < floorInfo.matchingFloor;
   return enforceJS && (bidBelowFloor && shouldFloorDeal);
 }
@@ -675,7 +675,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
   let floorInfo = getFirstMatchingFloor(floorData.data, {...matchingBidRequest}, {...bid, size: [bid.width, bid.height]});
 
   if (!floorInfo.matchingFloor) {
-    utils.logWarn(`${MODULE_NAME}: unable to determine a matching price floor for bidResponse`, bid);
+    logWarn(`${MODULE_NAME}: unable to determine a matching price floor for bidResponse`, bid);
     return fn.call(this, adUnitCode, bid);
   }
 
@@ -691,7 +691,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
     try {
       adjustedCpm = getGlobal().convertCurrency(bid.cpm, bidResponseCurrency.toUpperCase(), floorCurrency);
     } catch (err) {
-      utils.logError(`${MODULE_NAME}: Unable do get currency conversion for bidResponse to Floor Currency. Do you have Currency module enabled? ${bid}`);
+      logError(`${MODULE_NAME}: Unable do get currency conversion for bidResponse to Floor Currency. Do you have Currency module enabled? ${bid}`);
       return fn.call(this, adUnitCode, bid);
     }
   }
@@ -707,7 +707,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
     // bid fails floor -> throw it out
     // create basic bid no-bid with necessary data fro analytics adapters
     let flooredBid = createBid(CONSTANTS.STATUS.NO_BID, matchingBidRequest);
-    Object.assign(flooredBid, utils.pick(bid, [
+    Object.assign(flooredBid, pick(bid, [
       'floorData',
       'width',
       'height',
@@ -720,7 +720,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
     flooredBid.status = CONSTANTS.BID_STATUS.BID_REJECTED;
     // if floor not met update bid with 0 cpm so it is not included downstream and marked as no-bid
     flooredBid.cpm = 0;
-    utils.logWarn(`${MODULE_NAME}: ${flooredBid.bidderCode}'s Bid Response for ${adUnitCode} was rejected due to floor not met`, bid);
+    logWarn(`${MODULE_NAME}: ${flooredBid.bidderCode}'s Bid Response for ${adUnitCode} was rejected due to floor not met`, bid);
     return fn.call(this, adUnitCode, flooredBid);
   }
   return fn.call(this, adUnitCode, bid);

package/modules/proxistoreBidAdapter.js

@@ -1,10 +1,11 @@
+import { isFn, isPlainObject } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import * as utils from '../src/utils.js';
 
 const BIDDER_CODE = 'proxistore';
 const PROXISTORE_VENDOR_ID = 418;
 const COOKIE_BASE_URL = 'https://abs.proxistore.com/v3/rtb/prebid/multi';
-const COOKIE_LESS_URL = 'https://abs.cookieless-proxistore.com/v3/rtb/prebid/multi';
+const COOKIE_LESS_URL =
+  'https://abs.cookieless-proxistore.com/v3/rtb/prebid/multi';
 
 function _createServerRequest(bidRequests, bidderRequest) {
   var sizeIds = [];
@@ -170,7 +171,7 @@ function interpretResponse(serverResponse, bidRequest) {
 }
 
 function _assignFloor(bid) {
-  if (!utils.isFn(bid.getFloor)) {
+  if (!isFn(bid.getFloor)) {
     // eslint-disable-next-line no-console
     console.log(bid.params.bidFloor);
     return bid.params.bidFloor ? bid.params.bidFloor : null;
@@ -181,11 +182,7 @@ function _assignFloor(bid) {
     size: '*',
   });
 
-  if (
-    utils.isPlainObject(floor) &&
-    !isNaN(floor.floor) &&
-    floor.currency === 'EUR'
-  ) {
+  if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'EUR') {
     return floor.floor;
   }
   return null;
@@ -196,6 +193,7 @@ export const spec = {
   isBidRequestValid: isBidRequestValid,
   buildRequests: buildRequests,
   interpretResponse: interpretResponse,
+  gvlid: PROXISTORE_VENDOR_ID,
 };
 
 registerBidder(spec);

package/modules/pubCommonId.js

@@ -3,7 +3,7 @@
  * stored in the page's domain.  When the module is included, an id is generated if needed,
  * persisted as a cookie, and automatically appended to all the bidRequest as bid.crumbs.pubcid.
  */
-import * as utils from '../src/utils.js';
+import { logMessage, parseUrl, buildUrl, triggerPixel, generateUUID, isArray } from '../src/utils.js';
 import { config } from '../src/config.js';
 import events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
@@ -44,7 +44,7 @@ export function setStorageItem(key, val, expires) {
 
     storage.setDataInLocalStorage(key, val);
   } catch (e) {
-    utils.logMessage(e);
+    logMessage(e);
   }
 }
 
@@ -74,7 +74,7 @@ export function getStorageItem(key) {
       }
     }
   } catch (e) {
-    utils.logMessage(e);
+    logMessage(e);
   }
 
   return val;
@@ -89,7 +89,7 @@ export function removeStorageItem(key) {
     storage.removeDataFromLocalStorage(key + EXP_SUFFIX);
     storage.removeDataFromLocalStorage(key);
   } catch (e) {
-    utils.logMessage(e);
+    logMessage(e);
   }
 }
 
@@ -141,13 +141,13 @@ function queuePixelCallback(pixelUrl, id) {
   id = id || '';
 
   // Use pubcid as a cache buster
-  const urlInfo = utils.parseUrl(pixelUrl);
+  const urlInfo = parseUrl(pixelUrl);
   urlInfo.search.id = encodeURIComponent('pubcid:' + id);
-  const targetUrl = utils.buildUrl(urlInfo);
+  const targetUrl = buildUrl(urlInfo);
 
   events.on(CONSTANTS.EVENTS.AUCTION_END, function auctionEndHandler() {
     events.off(CONSTANTS.EVENTS.AUCTION_END, auctionEndHandler);
-    utils.triggerPixel(targetUrl);
+    triggerPixel(targetUrl);
   });
 
   return true;
@@ -177,7 +177,7 @@ export function requestBidHook(next, config) {
   if (typeof window[PUB_COMMON] === 'object') {
     // If the page includes its own pubcid object, then use that instead.
     pubcid = window[PUB_COMMON].getId();
-    utils.logMessage(PUB_COMMON + ': pubcid = ' + pubcid);
+    logMessage(PUB_COMMON + ': pubcid = ' + pubcid);
   } else {
     // Otherwise get the existing cookie
     pubcid = readValue(ID_NAME);
@@ -190,7 +190,7 @@ export function requestBidHook(next, config) {
         }
         // Generate a new id
         if (!pubcid) {
-          pubcid = utils.generateUUID();
+          pubcid = generateUUID();
         }
         // Update the cookie/storage with the latest expiration date
         writeValue(ID_NAME, pubcid, pubcidConfig.interval);
@@ -205,14 +205,14 @@ export function requestBidHook(next, config) {
       }
     }
 
-    utils.logMessage('pbjs: pubcid = ' + pubcid);
+    logMessage('pbjs: pubcid = ' + pubcid);
   }
 
   // Append pubcid to each bid object, which will be incorporated
   // into bid requests later.
   if (adUnits && pubcid) {
     adUnits.forEach((unit) => {
-      if (unit.bids && utils.isArray(unit.bids)) {
+      if (unit.bids && isArray(unit.bids)) {
         unit.bids.forEach((bid) => {
           Object.assign(bid, {crumbs: {pubcid}});
         });

package/modules/pubProvidedIdSystem.js

@@ -6,7 +6,7 @@
  */
 
 import {submodule} from '../src/hook.js';
-import * as utils from '../src/utils.js';
+import { logInfo, isArray } from '../src/utils.js';
 
 const MODULE_NAME = 'pubProvidedId';
 
@@ -27,7 +27,7 @@ export const pubProvidedIdSubmodule = {
    */
   decode(value) {
     const res = value ? {pubProvidedId: value} : undefined;
-    utils.logInfo('PubProvidedId: Decoded value ' + JSON.stringify(res));
+    logInfo('PubProvidedId: Decoded value ' + JSON.stringify(res));
     return res;
   },
 
@@ -40,7 +40,7 @@ export const pubProvidedIdSubmodule = {
   getId(config) {
     const configParams = (config && config.params) || {};
     let res = [];
-    if (utils.isArray(configParams.eids)) {
+    if (isArray(configParams.eids)) {
       res = res.concat(configParams.eids);
     }
     if (typeof configParams.eidsFunction === 'function') {

package/modules/publinkIdSystem.js

@@ -8,7 +8,7 @@
 import {submodule} from '../src/hook.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {ajax} from '../src/ajax.js';
-import * as utils from '../src/utils.js';
+import { parseUrl, buildUrl, logError } from '../src/utils.js';
 import {uspDataHandler} from '../src/adapterManager.js';
 
 const MODULE_NAME = 'publinkId';
@@ -18,24 +18,33 @@ const PUBLINK_S2S_COOKIE = '_publink_srv';
 
 export const storage = getStorageManager(GVLID);
 
+function isHex(s) {
+  return /^[A-F0-9]+$/i.test(s);
+}
+
 function publinkIdUrl(params, consentData) {
-  let url = utils.parseUrl('https://proc.ad.cpe.dotomi.com/cvx/client/sync/publink');
+  let url = parseUrl('https://proc.ad.cpe.dotomi.com/cvx/client/sync/publink');
   url.search = {
     deh: params.e,
     mpn: 'Prebid.js',
     mpv: '$prebid.version$',
   };
+
   if (consentData) {
     url.search.gdpr = (consentData.gdprApplies) ? 1 : 0;
     url.search.gdpr_consent = consentData.consentString;
   }
 
+  if (params.site_id) { url.search.sid = params.site_id; }
+
+  if (params.api_key) { url.search.apikey = params.api_key; }
+
   const usPrivacyString = uspDataHandler.getConsentData();
   if (usPrivacyString && typeof usPrivacyString === 'string') {
     url.search.us_privacy = usPrivacyString;
   }
 
-  return utils.buildUrl(url);
+  return buildUrl(url);
 }
 
 function makeCallback(config = {}, consentData) {
@@ -49,8 +58,13 @@ function makeCallback(config = {}, consentData) {
         }
       }
     };
+
     if (config.params && config.params.e) {
-      ajax(publinkIdUrl(config.params, consentData), handleResponse, undefined, options);
+      if (isHex(config.params.e)) {
+        ajax(publinkIdUrl(config.params, consentData), handleResponse, undefined, options);
+      } else {
+        logError('params.e must be a hex string');
+      }
     }
   };
 }
@@ -73,7 +87,7 @@ function getlocalValue() {
           return obj.publink;
         }
       } catch (e) {
-        utils.logError(e);
+        logError(e);
       }
     }
   }
@@ -96,11 +110,11 @@ export const publinkIdSubmodule = {
   /**
    * decode the stored id value for passing to bid requests
    * @function
-   * @param {string} id encrypted userid
+   * @param {string} publinkId encrypted userid
    * @returns {{publinkId: string} | undefined}
    */
   decode(publinkId) {
-    return {publink: publinkId};
+    return {publinkId: publinkId};
   },
 
   /**
@@ -108,6 +122,8 @@ export const publinkIdSubmodule = {
    * Use a publink cookie first if it is present, otherwise use prebids copy, if neither are available callout to get a new id
    * @function
    * @param {SubmoduleConfig} [config] Config object with params and storage properties
+   * @param {ConsentData|undefined} consentData GDPR consent
+   * @param {(Object|undefined)} storedId Previously cached id
    * @returns {IdResponse}
    */
   getId: function(config, consentData, storedId) {

package/modules/publinkIdSystem.md

@@ -7,7 +7,10 @@ Publink user id module
 | Param Name | Required | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Yes | String | module identifier | `"publinkId"` |
-| params.e | Yes | String | hashed email address | `"e80b5017098950fc58aad83c8c14978e"` |
+| params.e | Yes | String | hashed email address | `"7D320454942620664D96EF78ED4E3A2A"` |
+| params.api_key | Yes | String | api key for access | `"7ab62359-bdc0-4095-b573-ef474fb55d24"` |
+| params.site_id | Yes | String | site identifier | `"123456"` |
+
 
 ### Example configuration for Publink
 ```
@@ -20,7 +23,9 @@ pbjs.setConfig({
                    type: "html5"
                },
                params: {
-                   e: "e80b5017098950fc58aad83c8c14978e", // example hashed email (md5)
+                   e: "7D320454942620664D96EF78ED4E3A2A",           // example hashed email (md5)
+                   site_id: "123456",                               // provided by Epsilon
+                   api_key: "7ab62359-bdc0-4095-b573-ef474fb55d2"   // provided by Epsilon
                }
            }],
        }