gravitoIdSystem.js

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

import { submodule } from '../src/hook.js';
import {getStorageManager} from '../src/storageManager.js';
import {MODULE_TYPE_UID} from '../src/activities/modules.js';

const MODULE_NAME = 'gravitompId';
export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});

export const cookieKey = 'gravitompId';

export const gravitoIdSystemSubmodule = {
  /**
   * used to link submodule with config
   * @type {string}
   */
  name: MODULE_NAME,

  /**
   * performs action to obtain id
   * @function
   * @returns { {id: {gravitompId: string}} | undefined }
   */
  getId: function() {
    const newId = storage.getCookie(cookieKey);
    if (!newId) {
      return undefined;
    }
    const result = {
      gravitompId: newId
    }
    return {id: result};
  },

  /**
   * decode the stored id value for passing to bid requests
   * @function
   * @param { {gravitompId: string} } value
   * @returns { {gravitompId: {string} } | undefined }
   */
  decode: function(value) {
    if (value && typeof value === 'object') {
      var result = {};
      if (value.gravitompId) {
        result = value.gravitompId
      }
      return {gravitompId: result};
    }
    return undefined;
  },
  eids: {
    'gravitompId': {
      source: 'gravito.net',
      atype: 1
    },
  }
}

submodule('userId', gravitoIdSystemSubmodule);