mk9-prebid/modules/britepoolIdSystem.js

Header Bidding Management Library

/**
 * This module adds BritePoolId to the User ID module
 * The {@link module:modules/userId} module is required
 * @module modules/britepoolIdSystem
 * @requires module:modules/userId
 */

import * as utils from '../src/utils.js'
import {ajax} from '../src/ajax.js';
import {submodule} from '../src/hook.js';
const PIXEL = 'https://px.britepool.com/new?partner_id=t';

/** @type {Submodule} */
export const britepoolIdSubmodule = {
  /**
   * Used to link submodule with config
   * @type {string}
   */
  name: 'britepoolId',
  /**
   * Decode the stored id value for passing to bid requests
   * @function
   * @param {string} value
   * @returns {{britepoolid:string}}
   */
  decode(value) {
    return (value && typeof value['primaryBPID'] === 'string') ? { 'britepoolid': value['primaryBPID'] } : null;
  },
  /**
   * Performs action to obtain id and return a value in the callback's response argument
   * @function
   * @param {SubmoduleConfig} [submoduleConfig]
   * @param {ConsentData|undefined} consentData
   * @returns {function(callback:function)}
   */
  getId(submoduleConfig, consentData) {
    const submoduleConfigParams = (submoduleConfig && submoduleConfig.params) || {};
    const { params, headers, url, getter, errors } = britepoolIdSubmodule.createParams(submoduleConfigParams, consentData);
    let getterResponse = null;
    if (typeof getter === 'function') {
      getterResponse = getter(params);
      // First let's rule out that the response is not a function
      if (typeof getterResponse !== 'function') {
        // Optimization to return value from getter
        return {
          id: britepoolIdSubmodule.normalizeValue(getterResponse)
        };
      }
    }
    if (utils.isEmpty(params)) {
      utils.triggerPixel(PIXEL);
    }
    // Return for async operation
    return {
      callback: function(callback) {
        if (errors.length > 0) {
          errors.forEach(error => utils.logError(error));
          callback();
          return;
        }
        if (getterResponse) {
          // Resolve the getter function response
          try {
            getterResponse(function(response) {
              callback(britepoolIdSubmodule.normalizeValue(response));
            });
          } catch (error) {
            if (error !== '') utils.logError(error);
            callback();
          }
        } else {
          ajax(url, {
            success: response => {
              const responseObj = britepoolIdSubmodule.normalizeValue(response);
              callback(responseObj ? { primaryBPID: responseObj.primaryBPID } : null);
            },
            error: error => {
              if (error !== '') utils.logError(error);
              callback();
            }
          }, JSON.stringify(params), { customHeaders: headers, contentType: 'application/json', method: 'POST', withCredentials: true });
        }
      }
    }
  },
  /**
   * Helper method to create params for our API call
   * @param {SubmoduleParams} [submoduleConfigParams]
   * @param {ConsentData|undefined} consentData
   * @returns {object} Object with parsed out params
   */
  createParams(submoduleConfigParams, consentData) {
    const hasGdprData = consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies;
    const gdprConsentString = hasGdprData ? consentData.consentString : undefined;
    let errors = [];
    const headers = {};
    const dynamicVars = typeof britepool_pubparams !== 'undefined' ? britepool_pubparams : {}; // eslint-disable-line camelcase, no-undef
    let params = Object.assign({}, submoduleConfigParams, dynamicVars);
    if (params.getter) {
      // Custom getter will not require other params
      if (typeof params.getter !== 'function') {
        errors.push(`userIdTargeting - britepoolId submodule requires getter to be a function`);
        return { errors };
      }
    } else {
      if (params.api_key) {
        // Add x-api-key into the header
        headers['x-api-key'] = params.api_key;
      }
    }
    const url = params.url || `https://api.britepool.com/v1/britepool/id${gdprConsentString ? '?gdprString=' + encodeURIComponent(gdprConsentString) : ''}`;
    const getter = params.getter;
    delete params.api_key;
    delete params.url;
    delete params.getter;
    return {
      params,
      headers,
      url,
      getter,
      errors
    };
  },
  /**
   * Helper method to normalize a JSON value
   */
  normalizeValue(value) {
    let valueObj = null;
    if (typeof value === 'object') {
      valueObj = value;
    } else if (typeof value === 'string') {
      try {
        valueObj = JSON.parse(value);
      } catch (error) {
        utils.logError(error);
      }
    }
    return valueObj;
  }
};

submodule('userId', britepoolIdSubmodule);