Tnc id module: initial release

modules/.submodules.json

@@ -43,7 +43,8 @@
     "unifiedIdSystem",
     "verizonMediaIdSystem",
     "zeotapIdPlusIdSystem",
-    "adqueryIdSystem", 
+    "tncIdSystem",
+    "adqueryIdSystem",
     "gravitoIdSystem"
   ],
   "adpod": [

modules/tncIdSystem.js

@@ -0,0 +1,85 @@
+import { submodule } from '../src/hook.js';
+import { logInfo } from '../src/utils.js';
+
+const MODULE_NAME = 'tncId';
+const FALLBACK_TNC_PROVIDERID = 'c8549079-f149-4529-a34b-3fa91ef257d1';
+const FALLBACK_TNC_INSTANCE = '__tncPbjs';
+
+const loadRemoteTNCScript = (providerId) => {
+  try {
+    let tncOptions = {
+      autostart: true,
+      tcf: true,
+      getFiles: {
+        cacheid: true, // true
+        options: false, // true
+        callback: false, // true
+        prepare: false, // false
+        scripts: false // true
+      }
+    };
+    let t = window;
+    let n = t.document;
+    let c = FALLBACK_TNC_INSTANCE;
+    let i = providerId;
+    let d = tncOptions;
+
+    t[c] = t[c] || {}; t[c].providerId = i; t[c].options = t[c].options || d;
+    var f = 'ready'; t[c][f] = t[c][f] || function (z) {
+      t[c][f].q = t[c][f].q || []; t[c][f].q.push(z);
+      return t[c];
+    }; var s = n.createElement('script'); s.setAttribute('global', c); s.async = !0;
+    s.defer = !0; s.id = 'tnc_route'; s.src = 'https://js.tncid.app/route.js';
+    n.querySelector('head,body').appendChild(s);
+  } catch (error) { }
+}
+
+const waitTNCScript = (tncNS) => {
+  return new Promise((resolve, reject) => {
+    var tnc = window[tncNS];
+    if (!tnc) reject(new Error('No TNC Object'));
+    if (tnc.tncid) resolve(tnc.tncid);
+    tnc.ready(() => {
+      tnc = window[tncNS];
+      if (tnc.tncid) resolve(tnc.tncid);
+      else tnc.on('data-sent', () => resolve(tnc.tncid));
+    });
+  });
+}
+
+const tncCallback = function (providerId, cb) {
+  let tncNS = '__tnc';
+  if (!window[tncNS]) {
+    tncNS = FALLBACK_TNC_INSTANCE;
+    loadRemoteTNCScript(providerId);
+  }
+
+  return waitTNCScript(tncNS).then(cb).catch(() => cb());
+}
+
+export const tncidSubModule = {
+  name: MODULE_NAME,
+  decode(id) {
+    return {
+      tncid: id
+    };
+  },
+  gvlid: 750,
+  getId(config, consentData) {
+    const gdpr = (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) ? 1 : 0;
+    const consentString = gdpr ? consentData.consentString : '';
+    let providerId = FALLBACK_TNC_PROVIDERID;
+    if (config && config.params && config.params.providerId)providerId = config.params.providerId;
+
+    if (gdpr && !consentString) {
+      logInfo('Consent string is required for TNCID module');
+      return;
+    }
+
+    return {
+      callback: function (cb) { return tncCallback(providerId, cb); }
+    }
+  }
+}
+
+submodule('userId', tncidSubModule)

modules/tncIdSystem.md

@@ -0,0 +1,34 @@
+# TNCID UserID Module
+
+### Prebid Configuration
+
+First, make sure to add the TNCID submodule to your Prebid.js package with:
+
+```
+gulp build --modules=tncIdSystem,userId
+```
+
+### TNCIDIdSystem module Configuration
+
+You can configure this submodule in your `userSync.userIds[]` configuration:
+
+```javascript
+pbjs.setConfig({
+  userSync: {
+    userIds: [
+      {
+        name: 'tncId',
+        params: {
+					providerId: "c8549079-f149-4529-a34b-3fa91ef257d1" // Optional
+				}
+      }
+    ]
+  }
+});
+```
+#### Configuration Params
+
+| Param Name | Required | Type | Description |
+| --- | --- | --- | --- |
+| name | Required | String | ID value for the TNCID module: `"tncId"` |
+| params.providerId | Optional | String | Provide TNC providerId if possible |

modules/userId/eids.js

@@ -315,11 +315,18 @@ export const USER_IDS_CONFIG = {
     }
   },
 
+  // tncId
+  'tncid': {
+    source: 'thenewco.it',
+    atype: 3
+  },
+
   // Gravito MP ID
   'gravitompId': {
     source: 'gravito.net',
     atype: 1
   },
+
 };
 
 // this function will create an eid object for the given UserId sub-module

test/spec/modules/tncIdSystem_spec.js

@@ -0,0 +1,108 @@
+import { tncidSubModule } from 'modules/tncIdSystem';
+
+const consentData = {
+  gdprApplies: true,
+  consentString: 'GDPR_CONSENT_STRING'
+};
+
+describe('TNCID tests', function () {
+  describe('name', () => {
+    it('should expose the name of the submodule', () => {
+      expect(tncidSubModule.name).to.equal('tncId');
+    });
+  });
+
+  describe('gvlid', () => {
+    it('should expose the vendor id', () => {
+      expect(tncidSubModule.gvlid).to.equal(750);
+    });
+  });
+
+  describe('decode', () => {
+    it('should wrap the given value inside an object literal', () => {
+      expect(tncidSubModule.decode('TNCID_TEST_ID')).to.deep.equal({
+        tncid: 'TNCID_TEST_ID'
+      });
+    });
+  });
+
+  describe('getId', () => {
+    afterEach(function () {
+      Object.defineProperty(window, '__tnc', {value: undefined, configurable: true});
+      Object.defineProperty(window, '__tncPbjs', {value: undefined, configurable: true});
+    });
+
+    it('Should NOT give TNCID if GDPR applies but consent string is missing', function () {
+      const res = tncidSubModule.getId(null, { gdprApplies: true });
+      expect(res).to.be.undefined;
+    });
+
+    it('GDPR is OK and page has no TNC script on page, script goes in error, no TNCID is returned', function () {
+      const completeCallback = sinon.spy();
+      const {callback} = tncidSubModule.getId(null, consentData);
+
+      return callback(completeCallback).then(() => {
+        expect(completeCallback.calledOnce).to.be.true;
+      })
+    });
+
+    it('GDPR is OK and page has TNC script with ns: __tnc, present TNCID is returned', function () {
+      Object.defineProperty(window, '__tnc', {
+        value: {
+          ready: (readyFunc) => { readyFunc() },
+          on: (name, cb) => { cb() },
+          tncid: 'TNCID_TEST_ID_1',
+          providerId: 'TEST_PROVIDER_ID_1',
+        },
+        configurable: true
+      });
+
+      const completeCallback = sinon.spy();
+      const {callback} = tncidSubModule.getId(null, { gdprApplies: false });
+
+      return callback(completeCallback).then(() => {
+        expect(completeCallback.calledOnceWithExactly('TNCID_TEST_ID_1')).to.be.true;
+      })
+    });
+
+    it('GDPR is OK and page has TNC script with ns: __tnc but not loaded, TNCID is assigned and returned', function () {
+      Object.defineProperty(window, '__tnc', {
+        value: {
+          ready: (readyFunc) => { readyFunc() },
+          on: (name, cb) => { cb() },
+          providerId: 'TEST_PROVIDER_ID_1',
+        },
+        configurable: true
+      });
+
+      const completeCallback = sinon.spy();
+      const {callback} = tncidSubModule.getId(null, { gdprApplies: false });
+
+      return callback(completeCallback).then(() => {
+        expect(completeCallback.calledOnce).to.be.true;
+      })
+    });
+
+    it('GDPR is OK and page has TNC script with ns: __tncPbjs, TNCID is returned', function () {
+      Object.defineProperty(window, '__tncPbjs', {
+        value: {
+          ready: (readyFunc) => { readyFunc() },
+          on: (name, cb) => { cb() },
+          providerId: 'TEST_PROVIDER_ID_1',
+          options: {},
+          tncid: 'TNCID_TEST_ID_2'
+        },
+        configurable: true,
+        writable: true
+      });
+
+      const completeCallback = sinon.spy();
+      const {callback} = tncidSubModule.getId({params: {providerId: 'TEST_PROVIDER_ID_2'}}, consentData);
+
+      return callback(completeCallback).then(() => {
+        expect(completeCallback.calledOnceWithExactly('TNCID_TEST_ID_2')).to.be.true;
+        expect(window.__tncPbjs.providerId).to.be.eq('TEST_PROVIDER_ID_2');
+      })
+    });
+  });
+});