prebid.js 7.53.0 → 8.0.0

package/modules/trustpidSystem.js

@@ -1,143 +0,0 @@
-/**
- * This module adds TrustPid provided by Vodafone Sales and Services Limited to the User ID module
- * The {@link module:modules/userId} module is required
- * @module modules/trustpidSystem
- * @requires module:modules/userId
- */
-import { logInfo } from '../src/utils.js';
-import { submodule } from '../src/hook.js';
-import {getStorageManager} from '../src/storageManager.js';
-import {MODULE_TYPE_UID} from '../src/activities/modules.js';
-
-const MODULE_NAME = 'trustpid';
-const LOG_PREFIX = 'Trustpid module'
-let mnoDomain = '';
-
-export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
-
-/**
- * Handle an event for an iframe.
- * Takes the body.url parameter from event and returns the string domain.
- * i.e.: "fc.vodafone.de"
- * @param event
- */
-function messageHandler(event) {
-  try {
-    if (event && event.data && typeof event.data === 'string') {
-      const msg = JSON.parse(event.data);
-      if (msg.msgType === 'MNOSELECTOR' && msg.body && msg.body.url) {
-        let URL = msg.body.url.split('//');
-        let domainURL = URL[1].split('/');
-        mnoDomain = domainURL[0];
-        logInfo(`${LOG_PREFIX}: Message handler set domain to ${mnoDomain}`);
-      }
-    }
-  } catch (e) {
-    logInfo(`${LOG_PREFIX}: Unsupported message caught. Origin: ${event.origin}, data: ${event.data}.`);
-  }
-}
-
-// Set a listener to handle the iframe response message.
-window.addEventListener('message', messageHandler, false);
-
-/**
- * Get the "atid" from html5 local storage to make it available to the UserId module.
- * @param config
- * @returns {{trustpid: (*|string)}}
- */
-function getTrustpidFromStorage() {
-  // Get the domain either from localStorage or global
-  let domain = JSON.parse(storage.getDataFromLocalStorage('fcIdConnectDomain')) || mnoDomain;
-  logInfo(`${LOG_PREFIX}: Local storage domain: ${domain}`);
-
-  if (!domain) {
-    logInfo(`${LOG_PREFIX}: Local storage domain not found, returning null`);
-    return {
-      trustpid: null,
-    };
-  }
-
-  let fcIdConnectObject;
-  let fcIdConnectData = JSON.parse(storage.getDataFromLocalStorage('fcIdConnectData'));
-  logInfo(`${LOG_PREFIX}: Local storage fcIdConnectData: ${JSON.stringify(fcIdConnectData)}`);
-
-  if (fcIdConnectData &&
-    fcIdConnectData.connectId &&
-    Array.isArray(fcIdConnectData.connectId.idGraph) &&
-    fcIdConnectData.connectId.idGraph.length > 0) {
-    fcIdConnectObject = fcIdConnectData.connectId.idGraph.find(item => {
-      return item.domain === domain;
-    });
-  }
-  logInfo(`${LOG_PREFIX}: Local storage fcIdConnectObject for domain: ${JSON.stringify(fcIdConnectObject)}`);
-
-  return {
-    trustpid: (fcIdConnectObject && fcIdConnectObject.atid)
-      ? fcIdConnectObject.atid
-      : null,
-  };
-}
-
-/** @type {Submodule} */
-export const trustpidSubmodule = {
-  /**
-   * Used to link submodule with config
-   * @type {string}
-   */
-  name: MODULE_NAME,
-  /**
-   * Decodes the stored id value for passing to bid requests.
-   * @function
-   * @returns {{trustpid: string} | null}
-   */
-  decode(bidId) {
-    logInfo(`${LOG_PREFIX}: Decoded ID value ${JSON.stringify(bidId)}`);
-    return bidId.trustpid ? bidId : null;
-  },
-  /**
-   * Get the id from helper function and initiate a new user sync.
-   * @param config
-   * @returns {{callback: result}|{id: {trustpid: string}}}
-   */
-  getId: function(config) {
-    const data = getTrustpidFromStorage();
-    if (data.trustpid) {
-      logInfo(`${LOG_PREFIX}: Local storage ID value ${JSON.stringify(data)}`);
-      return {id: {trustpid: data.trustpid}};
-    } else {
-      if (!config) {
-        config = {};
-      }
-      if (!config.params) {
-        config.params = {};
-      }
-      if (typeof config.params.maxDelayTime === 'undefined' || config.params.maxDelayTime === null) {
-        config.params.maxDelayTime = 1000;
-      }
-      // Current delay and delay step in milliseconds
-      let currentDelay = 0;
-      const delayStep = 50;
-      const result = (callback) => {
-        const data = getTrustpidFromStorage();
-        if (!data.trustpid) {
-          if (currentDelay > config.params.maxDelayTime) {
-            logInfo(`${LOG_PREFIX}: No trustpid value set after ${config.params.maxDelayTime} max allowed delay time`);
-            callback(null);
-          } else {
-            currentDelay += delayStep;
-            setTimeout(() => {
-              result(callback);
-            }, delayStep);
-          }
-        } else {
-          const dataToReturn = { trustpid: data.trustpid };
-          logInfo(`${LOG_PREFIX}: Returning ID value data of ${JSON.stringify(dataToReturn)}`);
-          callback(dataToReturn);
-        }
-      };
-      return { callback: result };
-    }
-  },
-};
-
-submodule('userId', trustpidSubmodule);

package/modules/viewability.js

@@ -1,9 +0,0 @@
-import {logWarn} from '../src/utils.js';
-
-export const MODULE_NAME = 'viewability';
-
-export function init() {
-  logWarn('Viewability module should not be used. See https://github.com/prebid/Prebid.js/issues/8928');
-}
-
-init();

package/modules/zeusPrimeRtdProvider.js

@@ -1,37 +0,0 @@
-import { logWarn } from '../src/utils.js'
-import { submodule } from '../src/hook.js'
-
-function initModule() {
-  logWarn('Zeus Prime has been deprecated. This module will be removed in Prebid 8.')
-}
-
-/**
- * @preserve
- * @type {RtdSubmodule}
- */
-const zeusPrimeSubmodule = {
-  /**
-   * @preserve
-   * The name of the plugin.
-   * @type {string}
-   */
-  name: 'zeusPrime',
-
-  /**
-   * @preserve
-   * ZeusPrime use
-   */
-  init: initModule,
-}
-
-/**
- * @preserve
- * Register the Sub Module.
- */
-function registerSubModule() {
-  submodule('realTimeData', zeusPrimeSubmodule)
-}
-
-registerSubModule()
-
-export { zeusPrimeSubmodule }

package/modules/zeusPrimeRtdProvider.md

@@ -1,63 +0,0 @@
-# Overview
-
-# NOTE: ZEUS PRIME HAS BEEN DEPRECATED!
-# THIS MODULE WILL BE REMOVED IN PREBID 8.
-
-Module Name: Zeus Prime RTD Provider
-Module Type: Rtd Provider
-Maintainer: support@zeustechnology.com
-
-## Description
-
-The Zeus Prime RTD Provider provides integration of Zeus Prime onto sites with Prebid. This module will request information from Zeus Prime servers to add the page level targeting required for Prime into the customer's ad setup.
-
-Zeus Prime runs as soon as the code is initialized, so it can retrieve the information required from the Zeus Prime server to create the targeting key-values. Zeus Prime will provide two page level key-values: `zeus_<yourGamId>` and `zeus_insights`. Zeus Prime provides contextual information about a pages content, and does not provide user information that could present privacy implications.
-
-For more information and help with setting up Zeus Prime, see the [onboarding documentation site](https://onboarding.zeustechnology.com).
-
-## Usage
-
-To use Zeus Prime, add `zeusPrimeRtdProvider` into your Prebid build: 
-
-```
-gulp build --modules=rtdModule,zeusPrimeRtdProvider
-```
-
-> Note that the global RTD module, `rtdModule`, is required for the Zeus Prime RTD module.
-
-Once the code is included, configure Zeus Prime in your Prebid configuration: 
-
-```javascript
-pbjs.setConfig({
-  ...,
-  realTimeData: {
-    dataProviders: [{
-      name: 'zeusPrime',
-      waitForIt: false,
-      params: {
-        gamId: '<yourGamId>'
-      }
-    }]
-  },
-  ...
-})
-```
-
-## Parameters
-
-The parameters below describe the configuration object used to configure Zeus Prime. 
-
-| Name                   | Type     | Description                                                                                   | Default |
-|------------------------|----------|-----------------------------------------------------------------------------------------------|---------|
-| name                   | String   | This will always be `zeusPrime`                                                               | -       |
-| waitForIt              | Boolean  | Should be false since Zeus Prime runs on initial load and not during the bidding cycle.       | `false` |
-| params                 | Object   |                                                                                               | -       |
-| params.gamId           | String   | The gamId or Google Ad Manager Network Code to access your Google Ad Manager instance.        | -       |
-
-### `gamId` Parameter
-
-Zeus Prime requires the gamId parameter, or the Google Ad Manager Network Code, to reference your account. See the [Google documentation](https://support.google.com/admanager/answer/7674889?hl=en) to find out where you can retrieve the Network Code.
-
-## Troubleshooting 
-
-For troubleshooting steps and guides to assist with verifying your Zeus Prime installation, see our [installation documentation](https://onboarding.zeustechnology.com/docs/installation).