Utiq user sub-module: Remove unused domain assingment

modules/.submodules.json

@@ -38,7 +38,7 @@
       "tapadIdSystem",
       "teadsIdSystem",
       "tncIdSystem",
-      "trustpidSystem",
+      "utiqSystem",
       "uid2IdSystem",
       "unifiedIdSystem",
       "verizonMediaIdSystem",

modules/ixBidAdapter.js

@@ -75,7 +75,7 @@ const SOURCE_RTI_MAPPING = {
   'epsilon.com': '', // Publisher Link, publinkId
   'audigent.com': '', // Hadron ID from Audigent, hadronId
   'pubcid.org': '', // SharedID, pubcid
-  'trustpid.com': '', // Trustpid
+  'utiq.com': '', // Utiq
   'intimatemerger.com': ''
 };
 const PROVIDERS = [

modules/userId/eids.js

@@ -24,9 +24,9 @@ export const USER_IDS_CONFIG = {
     }
   },
 
-  // trustpid
-  'trustpid': {
-    source: 'trustpid.com',
+  // utiq
+  'utiq': {
+    source: 'utiq.com',
     atype: 1,
     getValue: function (data) {
       return data;

modules/userId/eids.md

@@ -10,7 +10,7 @@ userIdAsEids = [
         }]
     },
     {
-        source: 'trustpid.com',
+        source: 'utiq.com',
         uids: [{
             id: 'some-random-id-value',
             atype: 1

modules/userId/userId.md

@@ -356,20 +356,22 @@ pbjs.setConfig({
     }
 });
 ```
+
 ```
 
 Example showing how to configure a `params` object to pass directly to bid adapters
 
 ```
+
 pbjs.setConfig({
-    userSync: {
-        userIds: [{
-            name: 'tncId',
-            params: {
-              providerId: "c8549079-f149-4529-a34b-3fa91ef257d1"
-            }
-        }],
-        syncDelay: 5000
-    }
+userSync: {
+userIds: [{
+name: 'tncId',
+params: {
+providerId: "c8549079-f149-4529-a34b-3fa91ef257d1"
+}
+}],
+syncDelay: 5000
+}
 });
-```
+```

modules/utiqSystem.js

@@ -0,0 +1,129 @@
+/**
+ * This module adds Utiq provided by Utiq SA/NV to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/utiqSystem
+ * @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 = 'utiq';
+const LOG_PREFIX = 'Utiq module';
+
+export const storage = getStorageManager({
+  moduleType: MODULE_TYPE_UID,
+  moduleName: MODULE_NAME,
+});
+
+/**
+ * Get the "atid" from html5 local storage to make it available to the UserId module.
+ * @param config
+ * @returns {{utiq: (*|string)}}
+ */
+function getUtiqFromStorage() {
+  let utiqPass;
+  let utiqPassStorage = JSON.parse(
+    storage.getDataFromLocalStorage('utiqPass')
+  );
+  logInfo(
+    `${LOG_PREFIX}: Local storage utiqPass: ${JSON.stringify(
+      utiqPassStorage
+    )}`
+  );
+
+  if (
+    utiqPassStorage &&
+    utiqPassStorage.connectId &&
+    Array.isArray(utiqPassStorage.connectId.idGraph) &&
+    utiqPassStorage.connectId.idGraph.length > 0
+  ) {
+    utiqPass = utiqPassStorage.connectId.idGraph[0];
+  }
+  logInfo(
+    `${LOG_PREFIX}: Graph of utiqPass: ${JSON.stringify(
+      utiqPass
+    )}`
+  );
+
+  return {
+    utiq:
+      utiqPass && utiqPass.atid
+        ? utiqPass.atid
+        : null,
+  };
+}
+
+/** @type {Submodule} */
+export const utiqSubmodule = {
+  /**
+   * Used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * Decodes the stored id value for passing to bid requests.
+   * @function
+   * @returns {{utiq: string} | null}
+   */
+  decode(bidId) {
+    logInfo(`${LOG_PREFIX}: Decoded ID value ${JSON.stringify(bidId)}`);
+    return bidId.utiq ? bidId : null;
+  },
+  /**
+   * Get the id from helper function and initiate a new user sync.
+   * @param config
+   * @returns {{callback: result}|{id: {utiq: string}}}
+   */
+  getId: function (config) {
+    const data = getUtiqFromStorage();
+    if (data.utiq) {
+      logInfo(`${LOG_PREFIX}: Local storage ID value ${JSON.stringify(data)}`);
+      return { id: { utiq: data.utiq } };
+    } 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 = getUtiqFromStorage();
+        if (!data.utiq) {
+          if (currentDelay > config.params.maxDelayTime) {
+            logInfo(
+              `${LOG_PREFIX}: No utiq value set after ${config.params.maxDelayTime} max allowed delay time`
+            );
+            callback(null);
+          } else {
+            currentDelay += delayStep;
+            setTimeout(() => {
+              result(callback);
+            }, delayStep);
+          }
+        } else {
+          const dataToReturn = { utiq: data.utiq };
+          logInfo(
+            `${LOG_PREFIX}: Returning ID value data of ${JSON.stringify(
+              dataToReturn
+            )}`
+          );
+          callback(dataToReturn);
+        }
+      };
+      return { callback: result };
+    }
+  },
+};
+
+submodule('userId', utiqSubmodule);

modules/trustpidSystem.md → modules/utiqSystem.md

@@ -1,22 +1,22 @@
-## trustpid User Id Submodule
+## Utiq User ID Submodule
 
-trustpid User Id Module.
+Utiq ID Module.
 
-First, make sure to add the trustpid submodule to your Prebid.js package with:
+First, make sure to add the utiq submodule to your Prebid.js package with:
 
 ```
-gulp build --modules=userId,adfBidAdapter,ixBidAdapter,prebidServerBidAdapter,trustpidSystem
+gulp build --modules=userId,adfBidAdapter,ixBidAdapter,prebidServerBidAdapter,utiqSystem
 ```
 
 ## Parameter Descriptions
 
 | Params under userSync.userIds[] | Type             | Description                                                                                                  | Example                          |
 | ------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------- |
-| name                            | String           | The name of the module                                                                                       | `"trustpid"`                     |
-| params                          | Object           | Object with configuration parameters for trustpid User Id submodule                                          | -                                |
+| name                            | String           | The name of the module                                                                                       | `"utiq"`                         |
+| params                          | Object           | Object with configuration parameters for utiq User Id submodule                                              | -                                |
 | params.maxDelayTime             | Integer          | Max amount of time (in seconds) before looking into storage for data                                         | 2500                             |
 | bidders                         | Array of Strings | An array of bidder codes to which this user ID may be sent. Currently required and supporting AdformOpenRTB  | [`"adf"`, `"adformPBS"`, `"ix"`] |
 | storage                         | Object           | Local storage configuration object                                                                           | -                                |
 | storage.type                    | String           | Type of the storage that would be used to store user ID. Must be `"html5"` to utilise HTML5 local storage.   | `"html5"`                        |
-| storage.name                    | String           | The name of the key in local storage where the user ID will be stored.                                       | `"trustpid"`                     |
+| storage.name                    | String           | The name of the key in local storage where the user ID will be stored.                                       | `"utiq"`                         |
 | storage.expires                 | Integer          | How long (in days) the user ID information will be stored. For safety reasons, this information is required. | `1`                              |