prebid.js 9.4.0 → 9.5.0

package/modules/symitriDapRtdProvider.md

@@ -0,0 +1,49 @@
+### Overview
+
+ Symitri DAP Real time data Provider automatically invokes the DAP APIs and submit audience segments and the SAID to the bid-stream.
+
+### Integration
+
+ 1) Build the symitriDapRTD module into the Prebid.js package with:
+
+ ```
+ gulp build --modules=symitriDapRtdProvider,...
+ ```
+
+ 2) Use `setConfig` to instruct Prebid.js to initilaize the symitriDapRtdProvider module, as specified below.
+
+### Configuration
+
+```
+ pbjs.setConfig({
+   realTimeData: {
+     auctionDelay: 2000,
+     dataProviders: [
+       {
+         name: "dap",
+         waitForIt: true,
+         params: {
+           apiHostname: '<see your Symitri account rep>',
+           apiVersion: "x1",
+           domain: 'your-domain.com',
+           identityType: 'email' | 'mobile' | ... | 'dap-signature:1.3.0',
+           segtax: 504,
+           dapEntropyUrl: 'https://sym-dist.symitri.net/dapentropy.js',
+           dapEntropyTimeout: 1500       // Maximum time for dapentropy to run
+         }
+       }
+     ]
+   }
+ });
+ ```
+
+Please reach out to your Symitri account representative(Prebid@symitri.com) to get provisioned on the DAP platform.
+
+
+### Testing
+To view an example of available segments returned by dap:
+```
+‘gulp serve --modules=rtdModule,symitriDapRtdProvider,appnexusBidAdapter,sovrnBidAdapter’
+```
+and then point your browser at:
+"http://localhost:9999/integrationExamples/gpt/symitridap_segments_example.html"

package/modules/targetVideoBidAdapter.js

@@ -1,24 +1,19 @@
-import {find} from '../src/polyfill.js';
-import {getBidRequest} from '../src/utils.js';
+import {_each, getDefinedParams, parseGPTSingleSizeArrayToRtbSize} from '../src/utils.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {formatRequest, getRtbBid, getSiteObj, videoBid, bannerBid, createVideoTag} from '../libraries/targetVideoUtils/bidderUtils.js';
+import {SOURCE, GVLID, BIDDER_CODE, VIDEO_PARAMS, BANNER_ENDPOINT_URL, VIDEO_ENDPOINT_URL, MARGIN, TIME_TO_LIVE} from '../libraries/targetVideoUtils/constants.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
  * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
  */
 
-const SOURCE = 'pbjs';
-const BIDDER_CODE = 'targetVideo';
-const ENDPOINT_URL = 'https://ib.adnxs.com/ut/v3/prebid';
-const MARGIN = 1.35;
-const GVLID = 786;
-
 export const spec = {
 
   code: BIDDER_CODE,
   gvlid: GVLID,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
 
   /**
    * Determines whether or not the given bid request is valid.
@@ -37,35 +32,114 @@ export const spec = {
    * @return ServerRequest Info describing the request to the server.
    */
   buildRequests: function(bidRequests, bidderRequest) {
-    const tags = bidRequests.map(createVideoTag);
-    const schain = bidRequests[0].schain;
-    const payload = {
-      tags: tags,
-      sdk: {
-        source: SOURCE,
-        version: '$prebid.version$'
-      },
-      schain: schain
+    const requests = [];
+    const sdk = {
+      source: SOURCE,
+      version: '$prebid.version$'
     };
 
-    if (bidderRequest && bidderRequest.gdprConsent) {
-      payload.gdpr_consent = {
-        consent_string: bidderRequest.gdprConsent.consentString,
-        consent_required: bidderRequest.gdprConsent.gdprApplies
-      };
-
-      if (bidderRequest.gdprConsent.addtlConsent && bidderRequest.gdprConsent.addtlConsent.indexOf('~') !== -1) {
-        let ac = bidderRequest.gdprConsent.addtlConsent;
-        let acStr = ac.substring(ac.indexOf('~') + 1);
-        payload.gdpr_consent.addtl_consent = acStr.split('.').map(id => parseInt(id, 10));
+    for (let {params, bidId, sizes, mediaTypes} of bidRequests) {
+      for (const mediaType in mediaTypes) {
+        switch (mediaType) {
+          case VIDEO: {
+            const video = mediaTypes[VIDEO];
+            const placementId = params.placementId;
+            const site = getSiteObj();
+
+            if (sizes && !Array.isArray(sizes[0])) sizes = [sizes];
+
+            const payload = {
+              sdk,
+              id: bidderRequest.bidderRequestId,
+              site,
+              imp: []
+            }
+
+            const imp = {
+              ext: {
+                prebid: {
+                  storedrequest: { id: placementId }
+                }
+              },
+              video: getDefinedParams(video, VIDEO_PARAMS)
+            }
+
+            if (video.playerSize) {
+              imp.video = Object.assign(
+                imp.video, parseGPTSingleSizeArrayToRtbSize(video.playerSize[0]) || {}
+              );
+            } else if (video.w && video.h) {
+              imp.video.w = video.w;
+              imp.video.h = video.h;
+            }
+
+            payload.imp.push(imp);
+
+            const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
+            const uspConsent = bidderRequest && bidderRequest.uspConsent;
+
+            if (gdprConsent || uspConsent) {
+              payload.regs = { ext: {} };
+
+              if (uspConsent) {
+                payload.regs.ext.us_privacy = uspConsent;
+              };
+
+              if (gdprConsent) {
+                if (typeof gdprConsent.gdprApplies !== 'undefined') {
+                  payload.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
+                };
+
+                if (typeof gdprConsent.consentString !== 'undefined') {
+                  payload.user = {
+                    ext: { consent: gdprConsent.consentString }
+                  };
+                };
+              };
+            };
+
+            if (bidRequests[0].schain) {
+              payload.schain = bidRequests[0].schain;
+            }
+
+            requests.push(formatRequest({ payload, url: VIDEO_ENDPOINT_URL, bidId }));
+            break;
+          }
+
+          case BANNER: {
+            const tags = bidRequests.map(createVideoTag);
+            const schain = bidRequests[0].schain;
+
+            const payload = {
+              tags,
+              sdk,
+              schain,
+            };
+
+            if (bidderRequest && bidderRequest.gdprConsent) {
+              payload.gdpr_consent = {
+                consent_string: bidderRequest.gdprConsent.consentString,
+                consent_required: bidderRequest.gdprConsent.gdprApplies
+              };
+
+              if (bidderRequest.gdprConsent.addtlConsent && bidderRequest.gdprConsent.addtlConsent.indexOf('~') !== -1) {
+                let ac = bidderRequest.gdprConsent.addtlConsent;
+                let acStr = ac.substring(ac.indexOf('~') + 1);
+                payload.gdpr_consent.addtl_consent = acStr.split('.').map(id => parseInt(id, 10));
+              }
+            }
+
+            if (bidderRequest && bidderRequest.uspConsent) {
+              payload.us_privacy = bidderRequest.uspConsent
+            }
+
+            return formatRequest({ payload, url: BANNER_ENDPOINT_URL, bidderRequest });
+          }
+        }
       }
     }
 
-    if (bidderRequest && bidderRequest.uspConsent) {
-      payload.us_privacy = bidderRequest.uspConsent
-    }
-
-    return formatRequest(payload, bidderRequest);
+    return requests;
   },
 
   /**
@@ -74,139 +148,33 @@ export const spec = {
    * @param {*} serverResponse A successful response from the server.
    * @return {Bid[]} An array of bids which were nested inside the server.
    */
-  interpretResponse: function(serverResponse, { bidderRequest }) {
+  interpretResponse: function(serverResponse, { bidderRequest, ...bidRequest }) {
     serverResponse = serverResponse.body;
+    const currency = serverResponse.cur;
     const bids = [];
 
     if (serverResponse.tags) {
       serverResponse.tags.forEach(serverBid => {
         const rtbBid = getRtbBid(serverBid);
         if (rtbBid && rtbBid.cpm !== 0 && rtbBid.ad_type == VIDEO) {
-          bids.push(newBid(serverBid, rtbBid, bidderRequest));
+          bids.push(bannerBid(serverBid, rtbBid, bidderRequest, MARGIN));
         }
       });
     }
 
-    return bids;
-  }
-
-}
-
-function getSizes(request) {
-  let sizes = request.sizes;
-  if (!sizes && request.mediaTypes && request.mediaTypes.banner && request.mediaTypes.banner.sizes) {
-    sizes = request.mediaTypes.banner.sizes;
-  }
-  if (Array.isArray(sizes) && !Array.isArray(sizes[0])) {
-    sizes = [sizes[0], sizes[1]];
-  }
-  if (!Array.isArray(sizes) || !Array.isArray(sizes[0])) {
-    sizes = [[0, 0]];
-  }
-
-  return sizes;
-}
+    if (serverResponse.seatbid) {
+      _each(serverResponse.seatbid, (resp) => {
+        _each(resp.bid, (bid) => {
+          const requestId = bidRequest.bidId;
+          const params = bidRequest.params;
 
-function formatRequest(payload, bidderRequest) {
-  const options = {
-    withCredentials: true
-  };
-  const request = {
-    method: 'POST',
-    url: ENDPOINT_URL,
-    data: JSON.stringify(payload),
-    bidderRequest,
-    options
-  };
-
-  return request;
-}
-
-/**
- * Create video auction.
- *
- * @param {*} serverResponse A successful response from the server.
- * @return {Bid[]} An array of bids which were nested inside the server.
- */
-function createVideoTag(bid) {
-  const tag = {};
-  tag.id = parseInt(bid.params.placementId, 10);
-  tag.gpid = 'targetVideo';
-  tag.sizes = getSizes(bid);
-  tag.primary_size = tag.sizes[0];
-  tag.ad_types = [VIDEO];
-  tag.uuid = bid.bidId;
-  tag.allow_smaller_sizes = false;
-  tag.use_pmt_rule = false;
-  tag.prebid = true;
-  tag.disable_psa = true;
-  tag.hb_source = 1;
-  tag.require_asset_url = true;
-  tag.video = {
-    playback_method: 2,
-    skippable: true
-  };
-
-  return tag;
-}
-
-/**
- * Unpack the Server's Bid into a Prebid-compatible one.
- * @param serverBid
- * @param rtbBid
- * @param bidderRequest
- * @return Bid
- */
-function newBid(serverBid, rtbBid, bidderRequest) {
-  const bidRequest = getBidRequest(serverBid.uuid, [bidderRequest]);
-  const sizes = getSizes(bidRequest);
-  const bid = {
-    requestId: serverBid.uuid,
-    cpm: rtbBid.cpm / MARGIN,
-    creativeId: rtbBid.creative_id,
-    dealId: rtbBid.deal_id,
-    currency: 'USD',
-    netRevenue: true,
-    width: sizes[0][0],
-    height: sizes[0][1],
-    ttl: 300,
-    adUnitCode: bidRequest.adUnitCode,
-    appnexus: {
-      buyerMemberId: rtbBid.buyer_member_id,
-      dealPriority: rtbBid.deal_priority,
-      dealCode: rtbBid.deal_code
+          bids.push(videoBid(bid, requestId, currency, params, TIME_TO_LIVE));
+        });
+      });
     }
-  };
-
-  if (rtbBid.rtb.video) {
-    Object.assign(bid, {
-      vastImpUrl: rtbBid.notify_url,
-      ad: getBannerHtml(rtbBid.notify_url + '&redir=' + encodeURIComponent(rtbBid.rtb.video.asset_url)),
-      ttl: 3600
-    });
-  }
-
-  return bid;
-}
 
-function getRtbBid(tag) {
-  return tag && tag.ads && tag.ads.length && find(tag.ads, ad => ad.rtb);
-}
-
-function getBannerHtml(vastUrl) {
-  return `<!DOCTYPE html>
-    <html lang="en">
-    <head>
-      <meta charset="UTF-8">
-      <title></title>
-      <style>html, body {width: 100%; height: 100%; margin: 0;}</style>
-    </head>
-    <body>
-      <div id="targetVideoPlayer"></div>
-      <script src="https://player.target-video.com/custom/targetvideo-banner.js"></script>
-      <script>initPlayer("${vastUrl}");</script>
-    </body>
-  </html>`;
+    return bids;
+  }
 }
 
 registerBidder(spec);

package/modules/targetVideoBidAdapter.md

@@ -3,17 +3,17 @@
 ```
 Module Name:  Target Video Bid Adapter
 Module Type:  Bidder Adapter
-Maintainer:   grajzer@gmail.com
+Maintainers:   grajzer@gmail.com, danijel.ristic@target-video.com
 ```
 
 # Description
 
 Connects to Appnexus exchange for bids.
 
-TargetVideo bid adapter supports Banner.
+TargetVideo bid adapter supports Banner and Video.
 
 # Test Parameters
-```
+```js
 var adUnits = [
   // Banner adUnit
   {
@@ -29,6 +29,23 @@ var adUnits = [
               placementId: 13232361
           }
       }]
+  },
+  // Video adUnit
+  {
+    mediaTypes: {
+        video: {
+            playerSize: [[640, 360]],
+            context: 'instream',
+            playbackmethod: [1, 2, 3, 4]
+        }
+    },
+    bids: [{
+        bidder: 'targetVideo',
+        params: {
+            placementId: 12345,
+            reserve: 0,
+        }
+    }]
   }
 ];
 ```

package/modules/userId/eids.js

@@ -1,4 +1,7 @@
 import {deepAccess, deepClone, isFn, isPlainObject, isStr} from '../../src/utils.js';
+/*
+ * @typedef {import('../modules/userId/index.js').SubmoduleContainer} SubmoduleContainer
+ */
 
 export const EID_CONFIG = new Map();
 

package/modules/utiqIdSystem.js

@@ -27,11 +27,6 @@ function getUtiqFromStorage() {
   let utiqPassStorage = JSON.parse(
     storage.getDataFromLocalStorage('utiqPass')
   );
-  logInfo(
-    `${LOG_PREFIX}: Local storage utiqPass: ${JSON.stringify(
-      utiqPassStorage
-    )}`
-  );
 
   if (
     utiqPassStorage &&
@@ -40,12 +35,19 @@ function getUtiqFromStorage() {
     utiqPassStorage.connectId.idGraph.length > 0
   ) {
     utiqPass = utiqPassStorage.connectId.idGraph[0];
+
+    logInfo(
+      `${LOG_PREFIX}: Local storage utiqPass: ${JSON.stringify(
+        utiqPassStorage
+      )}`
+    );
+
+    logInfo(
+      `${LOG_PREFIX}: Graph of utiqPass: ${JSON.stringify(
+        utiqPass
+      )}`
+    );
   }
-  logInfo(
-    `${LOG_PREFIX}: Graph of utiqPass: ${JSON.stringify(
-      utiqPass
-    )}`
-  );
 
   return {
     utiq:

package/modules/validationFpdModule/index.js

@@ -13,8 +13,8 @@ let optout;
 
 /**
  * Check if data passed is empty
- * @param {*} value to test against
- * @returns {Boolean} is value empty
+ * @param {*} data to test against
+ * @returns {Boolean} is data empty
  */
 function isEmptyData(data) {
   let check = true;
@@ -30,10 +30,10 @@ function isEmptyData(data) {
 
 /**
  * Check if required keys exist in data object
- * @param {Object} data object
- * @param {Array} array of required keys
- * @param {String} object path (for printing warning)
- * @param {Number} index of object value in the data array (for printing warning)
+ * @param {Object} obj data object
+ * @param {Array} required array of required keys
+ * @param {String} parent object path (for printing warning)
+ * @param {Number} i index of object value in the data array (for printing warning)
  * @returns {Boolean} is requirements fulfilled
  */
 function getRequiredData(obj, required, parent, i) {
@@ -51,8 +51,8 @@ function getRequiredData(obj, required, parent, i) {
 
 /**
  * Check if data type is valid
- * @param {*} value to test against
- * @param {Object} object containing type definition and if should be array bool
+ * @param {*} data value to test against
+ * @param {Object} mapping object containing type definition and if should be array bool
  * @returns {Boolean} is type fulfilled
  */
 function typeValidation(data, mapping) {
@@ -77,10 +77,10 @@ function typeValidation(data, mapping) {
 
 /**
  * Validates ortb2 data arrays and filters out invalid data
- * @param {Array} ortb2 data array
- * @param {Object} object defining child type and if array
- * @param {String} config path of data array
- * @param {String} parent path for logging warnings
+ * @param {Array} arr ortb2 data array
+ * @param {Object} child object defining child type and if array
+ * @param {String} path config path of data array
+ * @param {String} parent parent path for logging warnings
  * @returns {Array} validated/filtered data
  */
 export function filterArrayData(arr, child, path, parent) {
@@ -136,9 +136,9 @@ export function filterArrayData(arr, child, path, parent) {
 
 /**
  * Validates ortb2 object and filters out invalid data
- * @param {Object} ortb2 object
- * @param {String} config path of data array
- * @param {String} parent path for logging warnings
+ * @param {Object} fpd ortb2 object
+ * @param {String} path config path of data array
+ * @param {String} parent parent path for logging warnings
  * @returns {Object} validated/filtered data
  */
 export function validateFpd(fpd, path = '', parent = '') {
@@ -190,6 +190,8 @@ export function validateFpd(fpd, path = '', parent = '') {
 
 /**
  * Run validation on global and bidder config data for ortb2
+ * @param {Object} data global and bidder config data
+ * @returns {Object} validated data
  */
 function runValidations(data) {
   return {
@@ -200,6 +202,9 @@ function runValidations(data) {
 
 /**
  * Sets default values to ortb2 if exists and adds currency and ortb2 setConfig callbacks on init
+ * @param {Object} fpdConf configuration object
+ * @param {Object} data ortb2 data
+ * @returns {Object} processed data
  */
 export function processFpd(fpdConf, data) {
   // Checks for existsnece of pubcid optout cookie/storage
@@ -210,11 +215,11 @@ export function processFpd(fpdConf, data) {
   return (!fpdConf.skipValidations) ? runValidations(data) : data;
 }
 
-/** @type {firstPartyDataSubmodule} */
+/** @type {{name: string, queue: number, processFpd: function}} */
 export const validationSubmodule = {
   name: 'validation',
   queue: 1,
   processFpd
 }
 
-submodule('firstPartyData', validationSubmodule)
+submodule('firstPartyData', validationSubmodule);

package/modules/videojsVideoProvider.js

@@ -13,6 +13,9 @@ import { submodule } from '../src/hook.js';
 import stateFactory from '../libraries/video/shared/state.js';
 import { PLAYBACK_MODE } from '../libraries/video/constants/constants.js';
 import { getEventHandler } from '../libraries/video/shared/eventHandler.js';
+/**
+ * @typedef {import('../libraries/video/shared/state.js').State} State
+ */
 
 /*
 Plugins of interest:

package/modules/visxBidAdapter.js

@@ -33,7 +33,7 @@ const LOG_ERROR_MESS = {
   onlyVideoInstream: `Only video ${VIDEO_INSTREAM} supported`,
   videoMissing: 'Bid request videoType property is missing - '
 };
-const currencyWhiteList = ['EUR', 'USD', 'GBP', 'PLN'];
+const currencyWhiteList = ['EUR', 'USD', 'GBP', 'PLN', 'CHF', 'SEK'];
 export const storage = getStorageManager({bidderCode: BIDDER_CODE});
 const _bidResponseTimeLogged = [];
 export const spec = {

package/modules/winrBidAdapter.js

@@ -13,9 +13,10 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 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 {hasPurpose1Consent} from '../src/utils/gdpr.js';
 import {getANKeywordParam} from '../libraries/appnexusUtils/anKeywords.js';
 import {convertCamelToUnderscore} from '../libraries/appnexusUtils/anUtils.js';
+import { transformSizes } from '../libraries/sizeUtils/tranformSize.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
@@ -470,32 +471,6 @@ function bidToTag(bid) {
   return tag;
 }
 
-/* Turn bid request sizes into ut-compatible format */
-function transformSizes(requestSizes) {
-  let sizes = [];
-  let sizeObj = {};
-
-  if (
-    isArray(requestSizes) &&
-    requestSizes.length === 2 &&
-    !isArray(requestSizes[0])
-  ) {
-    sizeObj.width = parseInt(requestSizes[0], 10);
-    sizeObj.height = parseInt(requestSizes[1], 10);
-    sizes.push(sizeObj);
-  } else if (typeof requestSizes === 'object') {
-    for (let i = 0; i < requestSizes.length; i++) {
-      let size = requestSizes[i];
-      sizeObj = {};
-      sizeObj.width = parseInt(size[0], 10);
-      sizeObj.height = parseInt(size[1], 10);
-      sizes.push(sizeObj);
-    }
-  }
-
-  return sizes;
-}
-
 function hasUserInfo(bid) {
   return !!bid.params.user;
 }

package/modules/yahooAdsBidAdapter.js

@@ -3,7 +3,7 @@ import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { deepAccess, isFn, isStr, isNumber, isArray, isEmpty, isPlainObject, generateUUID, logInfo, logWarn } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { Renderer } from '../src/Renderer.js';
-import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../src/utils/gdpr.js';
 
 const INTEGRATION_METHOD = 'prebid.js';
 const BIDDER_CODE = 'yahooAds';

package/modules/yandexIdSystem.js

@@ -128,7 +128,7 @@ class YandexUidGenerator {
   }
 
   _getRandomGenerator() {
-    if (crypto) {
+    if (window.crypto) {
       return () => {
         const buffer = new Uint32Array(1);
         crypto.getRandomValues(buffer);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "9.4.0",
+  "version": "9.5.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.public.js",
   "exports": {
@@ -66,7 +66,7 @@
     "eslint": "^7.27.0",
     "eslint-config-standard": "^10.2.1",
     "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jsdoc": "^38.1.6",
+    "eslint-plugin-jsdoc": "^48.5.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prebid": "file:./plugins/eslint",
     "eslint-plugin-promise": "^5.1.0",
@@ -74,7 +74,7 @@
     "execa": "^1.0.0",
     "faker": "^5.5.3",
     "fs.extra": "^1.3.2",
-    "gulp": "^4.0.0",
+    "gulp": "^4.0.2",
     "gulp-clean": "^0.4.0",
     "gulp-concat": "^2.6.0",
     "gulp-connect": "^5.7.0",
@@ -115,7 +115,7 @@
     "opn": "^5.4.0",
     "querystring": "^0.2.1",
     "resolve-from": "^5.0.0",
-    "sinon": "^4.1.3",
+    "sinon": "^4.5.0",
     "through2": "^4.0.2",
     "url": "^0.11.0",
     "url-parse": "^1.0.5",