openrtb/lib/openrtb2_3/bid.js

A Javascript library which builds and validates OpenRTB objects

const RtbObject = require('../rtbObject');
const replaceMacros = require('../utils').replaceMacros;
const removeEmptyValues = require('../utils').removeEmptyValues;

const Bid = function(status, nurl, adm, adid, adomain, id, dealid, price, cid, clearPrice, crid, iurl, impid, cat, ext){
  this.status = status;
  this.nurl = nurl;
  this.adm = adm;
  this.adid = adid;
  this.adomain = adomain;
  this.id = id;
  this.dealid = dealid;
  this.price = price;
  this.cid = cid;
  this.clearPrice = clearPrice;
  this.crid = crid;
  this.iurl = iurl;
  this.impid = impid;
  this.cat = cat;
  this.ext = ext;
};

Bid.prototype = Object.create(RtbObject.prototype);

Bid.prototype.replaceMacros = function(string, valuesMap){
  valuesMap = valuesMap || {};

  if (!string || string.length === 0 || typeof string !== 'string'){
    throw new Error('Invalid string argument');
  }

  if (!this.clearPrice){
    throw new Error('Cannot replace macros without a clear price');
  }

  // Set default values if values are not passed
  valuesMap['${AUCTION_PRICE}'] = valuesMap['${AUCTION_PRICE}'] || encodeURIComponent(this.clearPrice);
  valuesMap['${AUCTION_ID}'] = valuesMap['${AUCTION_ID}'] || '${AUCTION_ID}'; // if not passed do not replace it
  valuesMap['${AUCTION_BID_ID}'] = valuesMap['${AUCTION_BID_ID}'] || encodeURIComponent(this.id);
  valuesMap['${AUCTION_IMP_ID}'] = valuesMap['${AUCTION_IMP_ID}'] || encodeURIComponent(this.impid);

  return replaceMacros(string, valuesMap);
};

Bid.prototype.isBelowFloor = function(bidfloor) {
  return this.price < bidfloor;
};

Bid.prototype.hasAdm = function() {
  // Double ! is intentional
  return !!this.adm && typeof this.adm === 'string';
};

Bid.prototype.isBlockedAdomain = function(badv) {
  if (!Array.isArray(badv)) {
    throw new Error('badv should be an array');
  }
  return badv.some(a => ~(this.adomain || []).indexOf(a));
};

Bid.prototype.isBlockedCat = function(bcat) {
  if (!Array.isArray(bcat)) {
    throw new Error('bcat should be an array');
  }
  return bcat.some(c => ~(this.cat || []).indexOf(c));
};

const BidBuilder = function(){};

BidBuilder.prototype.status = function(status){
  this._status = status;
  return this;
};

BidBuilder.prototype.nurl = function(nurl){
  this._nurl = nurl;
  return this;
};

BidBuilder.prototype.adm = function(adm){
  this._adm = adm;
  return this;
};

BidBuilder.prototype.adid = function(adid){
  this._adid = adid;
  return this;
};

BidBuilder.prototype.adomain = function(adomain){
  this._adomain = adomain;
  return this;
};

BidBuilder.prototype.id = function(id){
  this._id = id;
  return this;
};

BidBuilder.prototype.dealid = function(dealid){
  this._dealid = dealid;
  return this;
};

BidBuilder.prototype.price = function(price){
  this._price = price;
  return this;
};

BidBuilder.prototype.cid = function(cid){
  this._cid = cid;
  return this;
};

BidBuilder.prototype.clearPrice = function(clearPrice){
  this._clearPrice = clearPrice;
  return this;
};

BidBuilder.prototype.crid = function(crid){
  this._crid = crid;
  return this;
};

BidBuilder.prototype.iurl = function(iurl){
  this._iurl = iurl;
  return this;
};

BidBuilder.prototype.impid = function(impid){
  this._impid = impid;
  return this;
};

BidBuilder.prototype.cat = function(cat){
  this._cat = cat;
  return this;
};

BidBuilder.prototype.ext = function(ext){
  this._ext = ext;
  return this;
};

BidBuilder.prototype.build = function() {
  const bid = new Bid(
    this._status,
    this._nurl,
    this._adm,
    this._adid,
    this._adomain,
    this._id,
    this._dealid,
    this._price,
    this._cid,
    this._clearPrice,
    this._crid,
    this._iurl,
    this._impid,
    this._cat,
    this._ext
  );

  return removeEmptyValues(bid);
};

module.exports = {
  object: Bid,
  builder: BidBuilder  
};