prebid.js 5.14.0 → 5.18.0

package/modules/getintentBidAdapter.js

@@ -1,6 +1,5 @@
+import { getBidIdParameter, isFn, isInteger } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { isInteger } from '../src/utils.js';
-import * as utils from '../src/utils.js';
 
 const BIDDER_CODE = 'getintent';
 const IS_NET_REVENUE = true;
@@ -124,7 +123,7 @@ function buildGiBidRequest(bidRequest) {
     giBidRequest.size = produceSize(bidRequest.sizes);
   }
 
-  const currency = utils.getBidIdParameter(CURRENCY_PARAM, bidRequest.params);
+  const currency = getBidIdParameter(CURRENCY_PARAM, bidRequest.params);
   const floorInfo = getBidFloor(bidRequest, currency);
   if (floorInfo.floor) {
     giBidRequest[FLOOR_PARAM] = floorInfo.floor;
@@ -143,7 +142,7 @@ function buildGiBidRequest(bidRequest) {
 function getBidFloor(bidRequest, currency) {
   let floorInfo = {};
 
-  if (utils.isFn(bidRequest.getFloor)) {
+  if (isFn(bidRequest.getFloor)) {
     floorInfo = bidRequest.getFloor({
       currency: currency || DEFAULT_CURRENCY,
       mediaType: bidRequest.mediaType,

package/modules/glimpseBidAdapter.js

@@ -1,69 +1,181 @@
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
+import { BANNER } from '../src/mediaTypes.js'
+import { getStorageManager } from '../src/storageManager.js'
+import { isArray } from '../src/utils.js'
+import { registerBidder } from '../src/adapters/bidderFactory.js'
 
-const BIDDER_CODE = 'glimpse';
+const storageManager = getStorageManager()
 
-function transformEachBidResponse(glimpseBid) {
-  const bid = glimpseBid;
-  bid.meta = { advertiserDomains: [] };
-
-  if (glimpseBid.adomain) {
-    bid.meta.advertiserDomains = glimpseBid.adomain;
-  }
-
-  return bid;
+const BIDDER_CODE = 'glimpse'
+const ENDPOINT = 'https://api.glimpsevault.io/ads/serving/public/v1/prebid'
+const LOCAL_STORAGE_KEY = {
+  glimpse: {
+    jwt: 'gp_vault_jwt',
+  },
 }
 
 export const spec = {
   code: BIDDER_CODE,
-  url: 'https://api.glimpseprotocol.io/cloud/v1/vault/prebid',
   supportedMediaTypes: [BANNER],
 
+  /**
+   * Determines whether or not the given bid request is valid
+   * @param bid {BidRequest} The bid to validate
+   * @return {boolean}
+   */
   isBidRequestValid: (bid) => {
-    try {
-      const { placementId } = bid.params;
-      return typeof placementId === 'string' && placementId.length > 0;
-    } catch (error) {
-      return false;
-    }
+    return (
+      hasValue(bid) &&
+      hasValue(bid.params) &&
+      hasStringValue(bid.params.placementId)
+    )
   },
 
+  /**
+   * Builds http request for Glimpse bids
+   * @param validBidRequests {BidRequest[]}
+   * @param bidderRequest {BidderRequest}
+   * @returns {ServerRequest}
+   */
   buildRequests: (validBidRequests, bidderRequest) => {
-    const { url, code: bidderCode } = spec;
-
-    const bids = validBidRequests.map((request) => {
-      delete request.mediaTypes;
-      return request;
-    });
+    const networkId = window.networkId || -1
+    const bids = validBidRequests.map(processBidRequest)
+    const referer = getReferer(bidderRequest)
+    const gdprConsent = getGdprConsentChoice(bidderRequest)
+    const jwt = getVaultJwt()
 
-    const sdk = {
-      source: 'pbjs',
-      version: '$prebid.version$',
-    };
-
-    const payload = {
-      ...bidderRequest,
-      bidderCode,
-      bids,
-      sdk,
-    };
+    const data = {
+      auth: jwt,
+      data: {
+        bidderCode: spec.code,
+        networkId,
+        bids,
+        referer,
+        gdprConsent,
+      }
+    }
 
     return {
       method: 'POST',
-      url,
-      data: JSON.stringify(payload),
-    };
+      url: ENDPOINT,
+      data: JSON.stringify(data),
+      options: {},
+    }
   },
 
-  interpretResponse: (serverResponse, _) => {
-    let bids = [];
-    try {
-      const { body } = serverResponse;
-      bids = body.map(transformEachBidResponse);
-    } catch (error) {}
+  /**
+   * Parse response from Glimpse server
+   * @param bidResponse {ServerResponse}
+   * @param bidRequest {BidRequest}
+   * @returns {Bid[]}
+   */
+  interpretResponse: (bidResponse, bidRequest) => {
+    const isValidResponse = isValidBidResponse(bidResponse)
+
+    if (isValidResponse) {
+      const {auth, data} = bidResponse.body
+      setVaultJwt(auth)
+      return data.bids
+    }
 
-    return bids;
+    return []
   },
-};
+}
+
+function processBidRequest(bidRequest) {
+  const sizes = normalizeSizes(bidRequest.sizes)
+  const keywords = bidRequest.params.keywords || []
+
+  return {
+    bidId: bidRequest.bidId,
+    placementId: bidRequest.params.placementId,
+    unitCode: bidRequest.adUnitCode,
+    sizes,
+    keywords,
+  }
+}
+
+function normalizeSizes(sizes) {
+  const isSingleSize =
+    isArray(sizes) &&
+    sizes.length === 2 &&
+    !isArray(sizes[0]) &&
+    !isArray(sizes[1])
+
+  if (isSingleSize) {
+    return [sizes]
+  }
+
+  return sizes
+}
+
+function getReferer(bidderRequest) {
+  const hasReferer =
+    hasValue(bidderRequest) &&
+    hasValue(bidderRequest.refererInfo) &&
+    hasStringValue(bidderRequest.refererInfo.referer)
+
+  if (hasReferer) {
+    return bidderRequest.refererInfo.referer
+  }
+
+  return ''
+}
+
+function getGdprConsentChoice(bidderRequest) {
+  const hasGdprConsent =
+    hasValue(bidderRequest) &&
+    hasValue(bidderRequest.gdprConsent)
+
+  if (hasGdprConsent) {
+    return bidderRequest.gdprConsent
+  }
+
+  return {
+    consentString: '',
+    vendorData: {},
+    gdprApplies: false,
+  }
+}
+
+function setVaultJwt(auth) {
+  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.glimpse.jwt, auth)
+}
+
+function getVaultJwt() {
+  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.glimpse.jwt) || ''
+}
+
+function isValidBidResponse(bidResponse) {
+  return (
+    hasValue(bidResponse) &&
+    hasValue(bidResponse.body) &&
+    hasValue(bidResponse.body.data) &&
+    hasArrayValue(bidResponse.body.data.bids) &&
+    hasStringValue(bidResponse.body.auth)
+  )
+}
+
+function hasValue(value) {
+  return (
+    value !== undefined &&
+    value !== null
+  )
+}
+
+function hasStringValue(value) {
+  return (
+    hasValue(value) &&
+    typeof value === 'string' &&
+    value.length > 0
+  )
+}
+
+function hasArrayValue(value) {
+  return (
+    hasValue(value) &&
+    isArray(value) &&
+    value.length > 0
+  )
+}
 
-registerBidder(spec);
+registerBidder(spec)

package/modules/glimpseBidAdapter.md

@@ -3,7 +3,7 @@
 ```
 Module Name:  Glimpse Protocol Bid Adapter
 Module Type:  Bidder Adapter
-Maintainer:   hello@glimpseprotocol.io
+Maintainer:   publisher@glimpseprotocol.io
 ```
 
 # Description
@@ -11,12 +11,12 @@ Maintainer:   hello@glimpseprotocol.io
 This module connects publishers to Glimpse Protocol's demand sources via Prebid.js. Our innovative marketplace protects
 consumer privacy while allowing precise targeting. It is compliant with GDPR, DPA and CCPA.
 
-This adapter supports Banner.
+The Glimpse Adapter supports banner formats.
 
 # Test Parameters
 
 ```javascript
-var adUnits = [
+const adUnits = [
   {
     code: 'banner-div-a',
     mediaTypes: {
@@ -24,78 +24,15 @@ var adUnits = [
         sizes: [[300, 250]],
       },
     },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-300x250',
+    bids: [{
+      bidder: 'glimpse',
+      params: {
+        placementId: 'e53a7f564f8f44cc913b',
+        keywords: {
+          country: 'uk',
         },
       },
-    ],
+    }],
   },
-  {
-    code: 'banner-div-b',
-    mediaTypes: {
-      banner: {
-        sizes: [[320, 50]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-320x50',
-        },
-      },
-    ],
-  },
-  {
-    code: 'banner-div-c',
-    mediaTypes: {
-      banner: {
-        sizes: [[970, 250]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-970x250',
-        },
-      },
-    ],
-  },
-  {
-    code: 'banner-div-d',
-    mediaTypes: {
-      banner: {
-        sizes: [[728, 90]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-728x90',
-        },
-      },
-    ],
-  },
-  {
-    code: 'banner-div-e',
-    mediaTypes: {
-      banner: {
-        sizes: [[300, 600]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-300x600',
-        },
-      },
-    ],
-  },
-];
+]
 ```

package/modules/gmosspBidAdapter.js

@@ -1,5 +1,5 @@
+import { getDNT, getBidIdParameter, tryAppendQueryString, isEmpty, createTrackPixelHtml, logError, deepSetValue } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import * as utils from '../src/utils.js';
 import { config } from '../src/config.js';
 import { BANNER } from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -33,7 +33,7 @@ export const spec = {
 
     const urlInfo = getUrlInfo(bidderRequest.refererInfo);
     const cur = getCurrencyType();
-    const dnt = utils.getDNT() ? '1' : '0';
+    const dnt = getDNT() ? '1' : '0';
     const imuid = storage.getCookie('_im_uid.1000283') || '';
 
     for (let i = 0; i < validBidRequests.length; i++) {
@@ -43,17 +43,17 @@ export const spec = {
       const tid = request.transactionId;
       const bid = request.bidId;
       const ver = '$prebid.version$';
-      const sid = utils.getBidIdParameter('sid', request.params);
-
-      queryString = utils.tryAppendQueryString(queryString, 'tid', tid);
-      queryString = utils.tryAppendQueryString(queryString, 'bid', bid);
-      queryString = utils.tryAppendQueryString(queryString, 'ver', ver);
-      queryString = utils.tryAppendQueryString(queryString, 'sid', sid);
-      queryString = utils.tryAppendQueryString(queryString, 'im_uid', imuid);
-      queryString = utils.tryAppendQueryString(queryString, 'url', urlInfo.url);
-      queryString = utils.tryAppendQueryString(queryString, 'ref', urlInfo.ref);
-      queryString = utils.tryAppendQueryString(queryString, 'cur', cur);
-      queryString = utils.tryAppendQueryString(queryString, 'dnt', dnt);
+      const sid = getBidIdParameter('sid', request.params);
+
+      queryString = tryAppendQueryString(queryString, 'tid', tid);
+      queryString = tryAppendQueryString(queryString, 'bid', bid);
+      queryString = tryAppendQueryString(queryString, 'ver', ver);
+      queryString = tryAppendQueryString(queryString, 'sid', sid);
+      queryString = tryAppendQueryString(queryString, 'im_uid', imuid);
+      queryString = tryAppendQueryString(queryString, 'url', urlInfo.url);
+      queryString = tryAppendQueryString(queryString, 'ref', urlInfo.ref);
+      queryString = tryAppendQueryString(queryString, 'cur', cur);
+      queryString = tryAppendQueryString(queryString, 'dnt', dnt);
 
       bidRequests.push({
         method: 'GET',
@@ -73,17 +73,17 @@ export const spec = {
   interpretResponse: function (bidderResponse, requests) {
     const res = bidderResponse.body;
 
-    if (utils.isEmpty(res)) {
+    if (isEmpty(res)) {
       return [];
     }
 
     try {
       res.imps.forEach(impTracker => {
-        const tracker = utils.createTrackPixelHtml(impTracker);
+        const tracker = createTrackPixelHtml(impTracker);
         res.ad += tracker;
       });
     } catch (error) {
-      utils.logError('Error appending tracking pixel', error);
+      logError('Error appending tracking pixel', error);
     }
 
     const bid = {
@@ -99,7 +99,7 @@ export const spec = {
     };
 
     if (res.adomains) {
-      utils.deepSetValue(bid, 'meta.advertiserDomains', Array.isArray(res.adomains) ? res.adomains : [res.adomains]);
+      deepSetValue(bid, 'meta.advertiserDomains', Array.isArray(res.adomains) ? res.adomains : [res.adomains]);
     }
 
     return [bid];

package/modules/gnetBidAdapter.js

@@ -1,5 +1,5 @@
+import { _each, parseSizesInput, isEmpty } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import * as utils from '../src/utils.js';
 import { BANNER } from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'gnet';
@@ -29,7 +29,7 @@ export const spec = {
     const bidRequests = [];
     const referer = bidderRequest.refererInfo.referer;
 
-    utils._each(validBidRequests, (request) => {
+    _each(validBidRequests, (request) => {
       const data = {};
 
       data.referer = referer;
@@ -37,7 +37,7 @@ export const spec = {
       data.bidId = request.bidId;
       data.transactionId = request.transactionId;
 
-      data.sizes = utils.parseSizesInput(request.sizes);
+      data.sizes = parseSizesInput(request.sizes);
 
       data.params = request.params;
 
@@ -70,13 +70,13 @@ export const spec = {
 
     const res = serverResponse && serverResponse.body;
 
-    if (utils.isEmpty(res)) {
+    if (isEmpty(res)) {
       return [];
     }
 
     if (res.bids) {
       const bids = [];
-      utils._each(res.bids, (bidData) => {
+      _each(res.bids, (bidData) => {
         const bid = {
           requestId: bidData.bidId,
           cpm: bidData.cpm,

package/modules/googleAnalyticsAdapter.js

@@ -2,8 +2,8 @@
  * ga.js - analytics adapter for google analytics
  */
 
+import { _each, logMessage } from '../src/utils.js';
 var events = require('../src/events.js');
-var utils = require('../src/utils.js');
 var CONSTANTS = require('../src/constants.json');
 var adapterManager = require('../src/adapterManager.js').default;
 
@@ -54,7 +54,7 @@ adapter.enableAnalytics = function ({ provider, options }) {
 
     var existingEvents = events.getEvents();
 
-    utils._each(existingEvents, function (eventObj) {
+    _each(existingEvents, function (eventObj) {
       if (typeof eventObj !== 'object') {
         return;
       }
@@ -98,12 +98,12 @@ adapter.enableAnalytics = function ({ provider, options }) {
       sendBidWonToGa(bid);
     });
   } else {
-    utils.logMessage('Prebid.js google analytics disabled by sampling');
+    logMessage('Prebid.js google analytics disabled by sampling');
   }
 
   // finally set this function to return log message, prevents multiple adapter listeners
   this.enableAnalytics = function _enable() {
-    return utils.logMessage(`Analytics adapter already enabled, unnecessary call to \`enableAnalytics\`.`);
+    return logMessage(`Analytics adapter already enabled, unnecessary call to \`enableAnalytics\`.`);
   };
 };
 
@@ -129,7 +129,7 @@ function checkAnalytics() {
     _enableCheck = false;
   }
 
-  utils.logMessage('event count sent to GA: ' + _eventCount);
+  logMessage('event count sent to GA: ' + _eventCount);
 }
 
 function convertToCents(dollars) {
@@ -242,7 +242,7 @@ function sendBidResponseToGa(bid) {
 
 function sendBidTimeouts(timedOutBidders) {
   _analyticsQueue.push(function () {
-    utils._each(timedOutBidders, function (bidderCode) {
+    _each(timedOutBidders, function (bidderCode) {
       _eventCount++;
       var bidderName = bidderCode.bidder;
       window[_gaGlobal](_trackerSend, 'event', _category, 'Timeouts', bidderName, _disableInteraction);

package/modules/gothamadsBidAdapter.js

@@ -1,6 +1,6 @@
+import { logMessage, deepSetValue, deepAccess, _map, logWarn } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import * as utils from '../src/utils.js';
 import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'gothamads';
@@ -79,7 +79,7 @@ export const spec = {
       winTop = window.top;
     } catch (e) {
       location = winTop.location;
-      utils.logMessage(e);
+      logMessage(e);
     };
 
     let bids = [];
@@ -110,12 +110,12 @@ export const spec = {
       };
 
       if (bidRequest.gdprConsent && bidRequest.gdprConsent.gdprApplies) {
-        utils.deepSetValue(data, 'regs.ext.gdpr', bidRequest.gdprConsent.gdprApplies ? 1 : 0);
-        utils.deepSetValue(data, 'user.ext.consent', bidRequest.gdprConsent.consentString);
+        deepSetValue(data, 'regs.ext.gdpr', bidRequest.gdprConsent.gdprApplies ? 1 : 0);
+        deepSetValue(data, 'user.ext.consent', bidRequest.gdprConsent.consentString);
       }
 
       if (bidRequest.uspConsent !== undefined) {
-        utils.deepSetValue(data, 'regs.ext.us_privacy', bidRequest.uspConsent);
+        deepSetValue(data, 'regs.ext.us_privacy', bidRequest.uspConsent);
       }
 
       bids.push(data)
@@ -186,7 +186,7 @@ export const spec = {
  * @returns {boolean}
  */
 const checkRequestType = (bidRequest, type) => {
-  return (typeof utils.deepAccess(bidRequest, `mediaTypes.${type}`) !== 'undefined');
+  return (typeof deepAccess(bidRequest, `mediaTypes.${type}`) !== 'undefined');
 }
 
 const parseNative = admObject => {
@@ -246,7 +246,7 @@ const addNativeParameters = bidRequest => {
     ver: NATIVE_VERSION,
   };
 
-  const assets = utils._map(bidRequest.mediaTypes.native, (bidParams, key) => {
+  const assets = _map(bidRequest.mediaTypes.native, (bidParams, key) => {
     const props = NATIVE_PARAMS[key];
     const asset = {
       required: bidParams.required & 1,
@@ -300,7 +300,7 @@ const parseSizes = (bid, mediaType) => {
         mediaTypes.video.w,
         mediaTypes.video.h
       ];
-    } else if (Array.isArray(utils.deepAccess(bid, 'mediaTypes.video.playerSize')) && bid.mediaTypes.video.playerSize.length === 1) {
+    } else if (Array.isArray(deepAccess(bid, 'mediaTypes.video.playerSize')) && bid.mediaTypes.video.playerSize.length === 1) {
       size = bid.mediaTypes.video.playerSize[0];
     } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0 && Array.isArray(bid.sizes[0]) && bid.sizes[0].length > 1) {
       size = bid.sizes[0];
@@ -313,7 +313,7 @@ const parseSizes = (bid, mediaType) => {
   } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) {
     sizes = bid.sizes
   } else {
-    utils.logWarn('no sizes are setup or found');
+    logWarn('no sizes are setup or found');
   }
 
   return sizes

package/modules/gptPreAuction.js

@@ -1,5 +1,5 @@
+import { isGptPubadsDefined, isAdUnitCodeMatchingSlot, deepAccess, pick, logInfo } from '../src/utils.js';
 import { config } from '../src/config.js';
-import * as utils from '../src/utils.js';
 import { getHook } from '../src/hook.js';
 import find from 'core-js-pure/features/array/find.js';
 
@@ -10,7 +10,7 @@ let hooksAdded = false;
 export const appendGptSlots = adUnits => {
   const { customGptSlotMatching } = _currentConfig;
 
-  if (!utils.isGptPubadsDefined()) {
+  if (!isGptPubadsDefined()) {
     return;
   }
 
@@ -22,7 +22,7 @@ export const appendGptSlots = adUnits => {
   window.googletag.pubads().getSlots().forEach(slot => {
     const matchingAdUnitCode = find(Object.keys(adUnitMap), customGptSlotMatching
       ? customGptSlotMatching(slot)
-      : utils.isAdUnitCodeMatchingSlot(slot));
+      : isAdUnitCodeMatchingSlot(slot));
 
     if (matchingAdUnitCode) {
       const adUnit = adUnitMap[matchingAdUnitCode];
@@ -56,7 +56,7 @@ export const appendPbAdSlot = adUnit => {
   const { customPbAdSlot } = _currentConfig;
 
   if (customPbAdSlot) {
-    context.pbadslot = customPbAdSlot(adUnit.code, utils.deepAccess(context, 'adserver.adslot'));
+    context.pbadslot = customPbAdSlot(adUnit.code, deepAccess(context, 'adserver.adslot'));
     return;
   }
 
@@ -73,7 +73,7 @@ export const appendPbAdSlot = adUnit => {
     }
   } catch (e) {}
   // banner adUnit, use GPT adunit if defined
-  if (utils.deepAccess(context, 'adserver.adslot')) {
+  if (deepAccess(context, 'adserver.adslot')) {
     context.pbadslot = context.adserver.adslot;
     return;
   }
@@ -89,7 +89,7 @@ export const makeBidRequestsHook = (fn, adUnits, ...args) => {
 };
 
 const handleSetGptConfig = moduleConfig => {
-  _currentConfig = utils.pick(moduleConfig, [
+  _currentConfig = pick(moduleConfig, [
     'enabled', enabled => enabled !== false,
     'customGptSlotMatching', customGptSlotMatching =>
       typeof customGptSlotMatching === 'function' && customGptSlotMatching,
@@ -102,7 +102,7 @@ const handleSetGptConfig = moduleConfig => {
       hooksAdded = true;
     }
   } else {
-    utils.logInfo(`${MODULE_NAME}: Turning off module`);
+    logInfo(`${MODULE_NAME}: Turning off module`);
     _currentConfig = {};
     getHook('makeBidRequests').getHooks({hook: makeBidRequestsHook}).remove();
     hooksAdded = false;