expose full user id config (including storage) to user id modules

modules/britepoolIdSystem.js

@@ -29,11 +29,12 @@ export const britepoolIdSubmodule = {
  /**
  * Performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [submoduleConfigParams]
+ * @param {SubmoduleParams} [submoduleConfig]
  * @param {ConsentData|undefined} consentData
  * @returns {function(callback:function)}
  */
- getId(submoduleConfigParams, consentData) {
+ 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') {

modules/criteoIdSystem.js

@@ -126,11 +126,11 @@ export const criteoIdSubmodule = {
  /**
  * get the Criteo Id from local storages and initiate a new user sync
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {ConsentData} [consentData]
  * @returns {{id: {criteoId: string} | undefined}}}
  */
- getId(configParams, consentData) {
+ getId(config, consentData) {
  const hasGdprData = consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies;
  const gdprConsentString = hasGdprData ? consentData.consentString : undefined;
 

modules/haloIdSystem.js

@@ -30,10 +30,10 @@ export const haloIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {IdResponse|undefined}
  */
- getId(configParams) {
+ getId(config) {
  const url = `https://id.halo.ad.gt/api/v1/pbhid`;
 
  const resp = function (callback) {

modules/id5IdSystem.js

@@ -65,12 +65,13 @@ export const id5IdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function getId
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {ConsentData} [consentData]
  * @param {(Object|undefined)} cacheIdObj
  * @returns {IdResponse|undefined}
  */
- getId(configParams, consentData, cacheIdObj) {
+ getId(config, consentData, cacheIdObj) {
+ const configParams = (config && config.params) || {};
  if (!hasRequiredParams(configParams)) {
  return undefined;
  }
@@ -123,11 +124,12 @@ export const id5IdSubmodule = {
  * If IdResponse#callback is defined, then it'll called at the end of auction.
  * It's permissible to return neither, one, or both fields.
  * @function extendId
- * @param {SubmoduleParams} configParams
+ * @param {SubmoduleParams} config
  * @param {Object} cacheIdObj - existing id, if any
  * @return {(IdResponse|function(callback:function))} A response object that contains id and/or callback.
  */
- extendId(configParams, cacheIdObj) {
+ extendId(config, cacheIdObj) {
+ const configParams = (config && config.params) || {};
  incrementNb(configParams);
  return cacheIdObj;
  }

modules/identityLinkIdSystem.js

@@ -34,10 +34,11 @@ export const identityLinkSubmodule = {
  * performs action to obtain id and return a value in the callback's response argument
  * @function
  * @param {ConsentData} [consentData]
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {IdResponse|undefined}
  */
- getId(configParams, consentData) {
+ getId(config, consentData) {
+ const configParams = (config && config.params) || {};
  if (!configParams || typeof configParams.pid !== 'string') {
  utils.logError('identityLink submodule requires partner id to be defined');
  return;

modules/intentIqIdSystem.js

@@ -30,10 +30,11 @@ export const intentIqIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {IdResponse|undefined}
  */
- getId(configParams) {
+ getId(config) {
+ const configParams = (config && config.params) || {};
  if (!configParams || typeof configParams.partner !== 'number') {
  utils.logError('User ID - intentIqId submodule requires a valid partner to be defined');
  return;

modules/liveIntentIdSystem.js

@@ -100,10 +100,11 @@ export const liveIntentIdSubmodule = {
  * `publisherId` params.
  * @function
  * @param {{unifiedId:string}} value
- * @param {SubmoduleParams|undefined} [configParams]
+ * @param {SubmoduleParams|undefined} [config]
  * @returns {{lipb:Object}}
  */
- decode(value, configParams) {
+ decode(value, config) {
+ const configParams = (config && config.params) || {};
  function composeIdObject(value) {
  const base = { 'lipbid': value['unifiedId'] };
  delete value.unifiedId;
@@ -121,10 +122,11 @@ export const liveIntentIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {IdResponse|undefined}
  */
- getId(configParams) {
+ getId(config) {
+ const configParams = (config && config.params) || {};
  const liveConnect = initializeLiveConnect(configParams);
  if (!liveConnect) {
  return;

modules/lotamePanoramaIdSystem.js

@@ -154,19 +154,19 @@ export const lotamePanoramaIdSubmodule = {
  * @param {(Object|string)} value
  * @returns {(Object|undefined)}
  */
- decode(value, configParams) {
+ decode(value, config) {
  return utils.isStr(value) ? { 'lotamePanoramaId': value } : undefined;
  },
 
  /**
  * Retrieve the Lotame Panorama Id
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {ConsentData} [consentData]
  * @param {(Object|undefined)} cacheIdObj
  * @returns {IdResponse|undefined}
  */
- getId(configParams, consentData, cacheIdObj) {
+ getId(config, consentData, cacheIdObj) {
  let localCache = getLotameLocalCache();
 
  let refreshNeeded = Date.now() > localCache.expiryTimestampMs;

modules/merkleIdSystem.js

@@ -31,11 +31,12 @@ export const merkleIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {ConsentData} [consentData]
  * @returns {IdResponse|undefined}
  */
- getId(configParams, consentData) {
+ getId(config, consentData) {
+ const configParams = (config && config.params) || {};
  if (!configParams || typeof configParams.pubid !== 'string') {
  utils.logError('User ID - merkleId submodule requires a valid pubid to be defined');
  return;

modules/netIdSystem.js

@@ -26,12 +26,12 @@ export const netIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {ConsentData} [consentData]
  * @param {(Object|undefined)} cacheIdObj
  * @returns {IdResponse|undefined}
  */
- getId(configParams) {
+ getId(config) {
  /* currently not possible */
  return {};
  }

modules/parrableIdSystem.js

@@ -261,11 +261,12 @@ export const parrableIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {ConsentData} [consentData]
  * @returns {function(callback:function), id:ParrableId}
  */
- getId(configParams, gdprConsentData, currentStoredId) {
+ getId(config, gdprConsentData, currentStoredId) {
+ const configParams = (config && config.params) || {};
  return fetchId(configParams);
  }
 };

modules/pubCommonIdSystem.js

@@ -54,10 +54,10 @@ export const pubCommonIdSubmodule = {
  /**
  * performs action to obtain id
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {IdResponse}
  */
- getId: function ({create = true, pixelUrl} = {}) {
+ getId: function ({params: {create = true, pixelUrl} = {}} = {}) {
  try {
  if (typeof window[PUB_COMMON_ID] === 'object') {
  // If the page includes its own pubcid module, then save a copy of id.
@@ -75,11 +75,11 @@ export const pubCommonIdSubmodule = {
  /**
  * performs action to extend an id
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @param {Object} storedId existing id
  * @returns {IdResponse|undefined}
  */
- extendId: function({extend = false, pixelUrl} = {}, storedId) {
+ extendId: function({params: {extend = false, pixelUrl} = {}} = {}, storedId) {
  try {
  if (typeof window[PUB_COMMON_ID] === 'object') {
  // If the page includes its onw pubcid module, then there is nothing to do.

modules/pubProvidedSystem.js

@@ -34,10 +34,11 @@ export const pubProvidedIdSubmodule = {
  /**
  * performs action to obtain id and return a value.
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {{id: array}}
  */
- getId(configParams) {
+ getId(config) {
+ const configParams = (config && config.params) || {};
  let res = [];
  if (utils.isArray(configParams.eids)) {
  res = res.concat(configParams.eids);

modules/sharedIdSystem.js

@@ -296,10 +296,10 @@ export const sharedIdSubmodule = {
  /**
  * performs action to obtain id and return a value.
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {sharedId}
  */
- getId(configParams) {
+ getId(config) {
  const resp = function (callback) {
  utils.logInfo('SharedId: Sharedid doesnt exists, new cookie creation');
  ajax(ID_SVC, idGenerationCallback(callback), undefined, {method: 'GET', withCredentials: true});
@@ -309,11 +309,12 @@ export const sharedIdSubmodule = {
 
  /**
  * performs actions even if the id exists and returns a value
- * @param configParams
+ * @param config
  * @param storedId
  * @returns {{callback: *}}
  */
- extendId(configParams, storedId) {
+ extendId(config, storedId) {
+ const configParams = (config && config.params) || {};
  utils.logInfo('SharedId: Existing shared id ' + storedId.id);
  const resp = function (callback) {
  const needSync = isIdSynced(configParams, storedId);

modules/unifiedIdSystem.js

@@ -30,10 +30,11 @@ export const unifiedIdSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleParams} [config]
  * @returns {IdResponse|undefined}
  */
- getId(configParams) {
+ getId(config) {
+ const configParams = (config && config.params) || {};
  if (!configParams || (typeof configParams.partner !== 'string' && typeof configParams.url !== 'string')) {
  utils.logError('User ID - unifiedId submodule requires either partner or url to be defined');
  return;

modules/userId/index.js

@@ -14,7 +14,7 @@
  * If IdResponse#callback is defined, then it'll called at the end of auction.
  * It's permissible to return neither, one, or both fields.
  * @name Submodule#getId
- * @param {SubmoduleParams} configParams
+ * @param {SubmoduleParams} config
  * @param {ConsentData|undefined} consentData
  * @param {(Object|undefined)} cacheIdObj
  * @return {(IdResponse|undefined)} A response object that contains id and/or callback.
@@ -27,7 +27,7 @@
  * If IdResponse#callback is defined, then it'll called at the end of auction.
  * It's permissible to return neither, one, or both fields.
  * @name Submodule#extendId
- * @param {SubmoduleParams} configParams
+ * @param {SubmoduleParams} config
  * @param {Object} storedId - existing id, if any
  * @return {(IdResponse|function(callback:function))} A response object that contains id and/or callback.
  */
@@ -37,7 +37,7 @@
  * @summary decode a stored value for passing to bid requests
  * @name Submodule#decode
  * @param {Object|string} value
- * @param {SubmoduleParams|undefined} configParams
+ * @param {SubmoduleParams|undefined} config
  * @return {(Object|undefined)}
  */
 
@@ -322,7 +322,7 @@ function processSubmoduleCallbacks(submodules, cb) {
  setStoredValue(submodule, idObj);
  }
  // cache decoded value (this is copied to every adUnit bid)
- submodule.idObj = submodule.submodule.decode(idObj);
+ submodule.idObj = submodule.submodule.decode(idObj, submodule.config);
  } else {
  utils.logInfo(`${MODULE_NAME}: ${submodule.submodule.name} - request id responded with an empty value`);
  }
@@ -505,10 +505,10 @@ function initSubmodules(submodules, consentData) {
 
  if (!storedId || refreshNeeded || !storedConsentDataMatchesConsentData(storedConsentData, consentData)) {
  // No id previously saved, or a refresh is needed, or consent has changed. Request a new id from the submodule.
- response = submodule.submodule.getId(submodule.config.params, consentData, storedId);
+ response = submodule.submodule.getId(submodule.config, consentData, storedId);
  } else if (typeof submodule.submodule.extendId === 'function') {
  // If the id exists already, give submodule a chance to decide additional actions that need to be taken
- response = submodule.submodule.extendId(submodule.config.params, storedId);
+ response = submodule.submodule.extendId(submodule.config, storedId);
  }
 
  if (utils.isPlainObject(response)) {
@@ -526,16 +526,16 @@ function initSubmodules(submodules, consentData) {
 
  if (storedId) {
  // cache decoded value (this is copied to every adUnit bid)
- submodule.idObj = submodule.submodule.decode(storedId, submodule.config.params);
+ submodule.idObj = submodule.submodule.decode(storedId, submodule.config);
  }
  } else if (submodule.config.value) {
  // cache decoded value (this is copied to every adUnit bid)
  submodule.idObj = submodule.config.value;
  } else {
- const response = submodule.submodule.getId(submodule.config.params, consentData, undefined);
+ const response = submodule.submodule.getId(submodule.config, consentData, undefined);
  if (utils.isPlainObject(response)) {
  if (typeof response.callback === 'function') { submodule.callback = response.callback; }
- if (response.id) { submodule.idObj = submodule.submodule.decode(response.id, submodule.config.params); }
+ if (response.id) { submodule.idObj = submodule.submodule.decode(response.id, submodule.config); }
  }
  }
  carry.push(submodule);

modules/zeotapIdPlusIdSystem.js

@@ -41,7 +41,7 @@ export const zeotapIdPlusSubmodule = {
  /**
  * performs action to obtain id and return a value in the callback's response argument
  * @function
- * @param {SubmoduleParams} configParams
+ * @param {SubmoduleParams} config
  * @return {{id: string | undefined} | undefined}
  */
  getId() {

test/spec/modules/britepoolIdSystem_spec.js

@@ -28,17 +28,17 @@ describe('BritePool Submodule', () => {
  });
 
  it('trigger id resolution pixel when no identifiers set', () => {
- britepoolIdSubmodule.getId({});
+ britepoolIdSubmodule.getId({ params: {} });
  expect(triggerPixelStub.called).to.be.true;
  });
 
  it('trigger id resolution pixel when no identifiers set with api_key param', () => {
- britepoolIdSubmodule.getId({ api_key });
+ britepoolIdSubmodule.getId({ params: { api_key } });
  expect(triggerPixelStub.called).to.be.true;
  });
 
  it('does not trigger id resolution pixel when identifiers set', () => {
- britepoolIdSubmodule.getId({ api_key, aaid });
+ britepoolIdSubmodule.getId({ params: { api_key, aaid } });
  expect(triggerPixelStub.called).to.be.false;
  });
 
@@ -110,7 +110,7 @@ describe('BritePool Submodule', () => {
  expect(getter).to.equal(getter_override);
  // Making sure it did not become part of params
  expect(params.getter).to.be.undefined;
- const response = britepoolIdSubmodule.getId({ api_key, aaid, url: url_override, getter: getter_override });
+ const response = britepoolIdSubmodule.getId({ params: { api_key, aaid, url: url_override, getter: getter_override } });
  assert.deepEqual(response, { id: { 'primaryBPID': bpid } });
  });
 
@@ -119,7 +119,7 @@ describe('BritePool Submodule', () => {
  expect(getter).to.equal(getter_callback_override);
  // Making sure it did not become part of params
  expect(params.getter).to.be.undefined;
- const response = britepoolIdSubmodule.getId({ api_key, aaid, url: url_override, getter: getter_callback_override });
+ const response = britepoolIdSubmodule.getId({ params: { api_key, aaid, url: url_override, getter: getter_callback_override } });
  expect(response.callback).to.not.be.undefined;
  response.callback(result => {
  assert.deepEqual(result, { 'primaryBPID': bpid });