GVL 2.2 [InteractiveAdvertisingBureau#396 - from forked] (#6)

* add optional fields * schema version for GVL: v2 and v2.2 * add tests * fix GVL path * update v2.2 GVL to the latest version in testing * v1.5.7 * Assigned new package name iabtechlabtcf * corrected package version * v1.5.7 * v1.5.7 * v1.5.7 * Update to support TCF v2.2 (issue InteractiveAdvertisingBureau#388). Also fixed an error in the test script" --------- Co-authored-by: Sergei Sevriugin <sevriugin@gmail.com> Co-authored-by: Nitish Shelage <nitish.shelage@aitglobalinc.com> Co-authored-by: Heinz Baumann <heinz_baumann1@hotmail.com>
pubtech-ai · Jul 25, 2023 · 4fcbea6 · 4fcbea6
1 parent 55b2ca8
commit 4fcbea6
Show file tree

Hide file tree

Showing 137 changed files with 21,191 additions and 158 deletions.
diff --git a/bin/version b/bin/version
@@ -2,6 +2,8 @@
 
 ROOT=$(git rev-parse --show-toplevel)
 
+npm_package_version=1.6.0
+
 cd $ROOT
 
 for pkg in ./modules/*; do
@@ -16,7 +18,7 @@ for pkg in ./modules/*; do
 done
 
 # Updated references to other iab libs but only hard versions
-sed -i '' 's/\(\@iabtcf\/.*\)":.*"[0-9]*\..*"/\1": "'$npm_package_version'"/g' ./modules/**/package.json
+sed -i '' 's/\(\@pubtech-ai\/.*\)":.*"[0-9]*\..*"/\1": "'$npm_package_version'"/g' ./modules/**/package.json
 
 # add this to the previous commit
 git add -A && git commit --amend --no-edit

diff --git a/modules/cli/README.md b/modules/cli/README.md
@@ -1,21 +1,21 @@
-[![NPM version](https://img.shields.io/npm/v/@iabtechlabtcf/cli.svg?style=flat-square)](https://www.npmjs.com/package/@iabtechlabtcf/cli)
-[![npm module downloads per month](http://img.shields.io/npm/dm/@iabtechlabtcf/cli.svg?style=flat)](https://www.npmjs.org/package/@iabtechlabtcf/cli)
-[![InteractiveAdvertisingBureau](https://circleci.com/gh/InteractiveAdvertisingBureau/iabtechlabtcf-es.svg?style=shield)](https://circleci.com/gh/InteractiveAdvertisingBureau/iabtechlabtcf-es)
+[![NPM version](https://img.shields.io/npm/v/@pubtech-ai/cli.svg?style=flat-square)](https://www.npmjs.com/package/@pubtech-ai/cli)
+[![npm module downloads per month](http://img.shields.io/npm/dm/@pubtech-ai/cli.svg?style=flat)](https://www.npmjs.org/package/@pubtech-ai/cli)
+[![InteractiveAdvertisingBureau](https://circleci.com/gh/InteractiveAdvertisingBureau/pubtech-ai-es.svg?style=shield)](https://circleci.com/gh/InteractiveAdvertisingBureau/pubtech-ai-es)
 
-# @iabtechlabtcf/cli
+# @pubtech-ai/cli
 
 command line decoding of iab TC String
 
 #### Installation
 
 npm
 ```
-npm install -g @iabtechlabtcf/cli
+npm install -g @pubtech-ai/cli
 ```
 
 yarn
 ```
-yarn add -g @iabtechlabtcf/cli
+yarn add -g @pubtech-ai/cli
 ```
 
 #### Using

diff --git a/modules/cli/package.json b/modules/cli/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@iabtechlabtcf/cli",
+  "name": "@pubtech-ai/cli",
   "version": "1.5.7",
   "description": "Decode a iab TCF (Transparency and Consent Framework) TC String via the command line",
   "author": "Mayank Mishra <mayank@iabtechlab.com>",
@@ -27,7 +27,7 @@
     "lint": "eslint `find src -name '*.ts'`"
   },
   "dependencies": {
-    "@iabtechlabtcf/core": "1.5.7"
+    "@pubtech-ai/core": "1.6.0"
   },
   "devDependencies": {
     "@types/node": "^17.0.18",

diff --git a/modules/cli/src/index.ts b/modules/cli/src/index.ts
@@ -2,7 +2,7 @@
 
 /* eslint no-console: 0 */
 
-import {TCString, Vector} from '@iabtechlabtcf/core';
+import {TCString, Vector} from '@pubtech-ai/core';
 
 const args = process.argv;
 let encoded = '';

diff --git a/modules/cmpapi/README.md b/modules/cmpapi/README.md
@@ -1,9 +1,9 @@
-[![NPM version](https://img.shields.io/npm/v/@iabtechlabtcf/cmpapi.svg?style=flat-square)](https://www.npmjs.com/package/@iabtechlabtcf/cmpapi)
-[![npm module downloads per month](http://img.shields.io/npm/dm/@iabtechlabtcf/cmpapi.svg?style=flat)](https://www.npmjs.org/package/@iabtechlabtcf/cmpapi)
-[![InteractiveAdvertisingBureau](https://circleci.com/gh/InteractiveAdvertisingBureau/iabtechlabtcf-es.svg?style=shield)](https://circleci.com/gh/InteractiveAdvertisingBureau/iabtechlabtcf-es)
+[![NPM version](https://img.shields.io/npm/v/@pubtech-ai/cmpapi.svg?style=flat-square)](https://www.npmjs.com/package/@pubtech-ai/cmpapi)
+[![npm module downloads per month](http://img.shields.io/npm/dm/@pubtech-ai/cmpapi.svg?style=flat)](https://www.npmjs.org/package/@pubtech-ai/cmpapi)
+[![InteractiveAdvertisingBureau](https://circleci.com/gh/InteractiveAdvertisingBureau/pubtech-ai-es.svg?style=shield)](https://circleci.com/gh/InteractiveAdvertisingBureau/pubtech-ai-es)
 
 
-# @iabtechlabtcf/cmpapi
+# @pubtech-ai/cmpapi
 
 Ensures other in-page digital marketing technologies have access to CMP transparency and consent information for the [IAB's Transparency and Consent Framework (TCF)](https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework).
 
@@ -16,12 +16,12 @@ The process involves setting the state of a few properties and/or a validly ecno
 
 npm
 ```
-npm install @iabtechlabtcf/cmpapi --save
+npm install @pubtech-ai/cmpapi --save
 ```
 
 yarn
 ```
-yarn add @iabtechlabtcf/cmpapi
+yarn add @pubtech-ai/cmpapi
 ```
 
 
@@ -33,7 +33,7 @@ To create an instance of the CmpApi. Pass in your Cmp ID (assigned by IAB) and t
 A [custom commands object map](#custom-commands) may optionally be passed to extend the page-call functionality as well.
 
 ````javascript
-import {CmpApi} from '@iabtechlabtcf/cmpapi';
+import {CmpApi} from '@pubtech-ai/cmpapi';
 
 const cmpApi = new CmpApi(1, 3, true);
 ````
@@ -139,7 +139,7 @@ the calling script.
 **Example**
 ````javascript
 
-import {CmpApi} from '@iabtechlabtcf/cmpapi';
+import {CmpApi} from '@pubtech-ai/cmpapi';
 
 const cmpApi = new CmpApi(1, 3, false, {
 
@@ -186,7 +186,7 @@ Beginning in 1.1.0, if a custom command is defined that overlaps with a built-in
 **Example**
 ````javascript
 
-import {CmpApi} from '@iabtechlabtcf/cmpapi';
+import {CmpApi} from '@pubtech-ai/cmpapi';
 
 const cmpApi = new CmpApi(1, 3, false, {
 

diff --git a/modules/cmpapi/package.json b/modules/cmpapi/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@iabtechlabtcf/cmpapi",
+  "name": "@pubtech-ai/cmpapi",
   "version": "1.5.7",
   "description": "Ensures other in-page digital marketing technologies have access to CMP transparency and consent information for the iab. Transparency and Consent Framework (TCF).",
   "author": "Mayank Mishra <mayank@iabtechlab.com>",
@@ -28,11 +28,11 @@
     "test-cov": "rm -rf coverage; nyc --reporter=html mocha"
   },
   "peerDependencies": {
-    "@iabtechlabtcf/core": ">=1.0.0"
+    "@pubtech-ai/core": ">=1.0.0"
   },
   "devDependencies": {
-    "@iabtechlabtcf/stub": "1.5.7",
-    "@iabtechlabtcf/testing": "1.5.7",
+    "@pubtech-ai/stub": "1.6.0",
+    "@pubtech-ai/testing": "1.6.0",
     "@istanbuljs/nyc-config-typescript": "^0.1.3",
     "@types/mocha": "^9.1.0",
     "@types/sinon": "10.0.11",

diff --git a/modules/cmpapi/src/CmpApi.ts b/modules/cmpapi/src/CmpApi.ts
@@ -2,7 +2,7 @@ import {CmpApiModel} from './CmpApiModel.js';
 import {CustomCommands} from './CustomCommands.js';
 import {CmpStatus, DisplayStatus, EventStatus} from './status/index.js';
 import {CallResponder} from './CallResponder.js';
-import {TCString, TCModel} from '@iabtechlabtcf/core';
+import {TCString, TCModel} from '@pubtech-ai/core';
 
 export class CmpApi {
 

diff --git a/modules/cmpapi/src/CmpApiModel.ts b/modules/cmpapi/src/CmpApiModel.ts
@@ -1,6 +1,6 @@
 import {CmpStatus, DisplayStatus, EventStatus} from './status/index.js';
 import {EventListenerQueue} from './EventListenerQueue.js';
-import {TCModel} from '@iabtechlabtcf/core';
+import {TCModel} from '@pubtech-ai/core';
 
 /**
  * Class holds shareable data across cmp api and provides change event listener for TcModel.

diff --git a/modules/cmpapi/src/command/GetVendorListCommand.ts b/modules/cmpapi/src/command/GetVendorListCommand.ts
@@ -1,6 +1,6 @@
 import {CmpApiModel} from '../CmpApiModel.js';
 import {Command} from './Command.js';
-import {GVL} from '@iabtechlabtcf/core';
+import {GVL} from '@pubtech-ai/core';
 
 /**
  * Gets a version of the Global Vendors List

diff --git a/modules/cmpapi/src/response/InAppTCData.ts b/modules/cmpapi/src/response/InAppTCData.ts
@@ -1,4 +1,4 @@
-import {IdBoolTuple, PurposeRestriction, PurposeRestrictionVector, RestrictionType, Vector} from '@iabtechlabtcf/core';
+import {IdBoolTuple, PurposeRestriction, PurposeRestrictionVector, RestrictionType, Vector} from '@pubtech-ai/core';
 import {Restrictions} from './Restrictions.js';
 import {TCData} from './TCData.js';
 

diff --git a/modules/cmpapi/src/response/Restrictions.ts b/modules/cmpapi/src/response/Restrictions.ts
@@ -1,4 +1,4 @@
-import {RestrictionType} from '@iabtechlabtcf/core';
+import {RestrictionType} from '@pubtech-ai/core';
 
 export interface Restrictions {
 

diff --git a/modules/cmpapi/src/response/TCData.ts b/modules/cmpapi/src/response/TCData.ts
@@ -1,4 +1,4 @@
-import {TCModel, PurposeRestriction, PurposeRestrictionVector, Vector, IdBoolTuple} from '@iabtechlabtcf/core';
+import {TCModel, PurposeRestriction, PurposeRestrictionVector, Vector, IdBoolTuple} from '@pubtech-ai/core';
 
 import {CmpApiModel} from '../CmpApiModel.js';
 import {BooleanVector} from './BooleanVector.js';

diff --git a/modules/cmpapi/test/CallResponder.test.ts b/modules/cmpapi/test/CallResponder.test.ts
@@ -3,7 +3,7 @@ import {CmpApiModel} from '../src/CmpApiModel';
 import {CommandCallback} from '../src/command/CommandCallback';
 import {TCData} from '../src/response/TCData';
 import {TCFCommand} from '../src/command';
-import {TCModelFactory} from '@iabtechlabtcf/testing';
+import {TCModelFactory} from '@pubtech-ai/testing';
 import {expect} from 'chai';
 import * as sinon from 'sinon';
 

diff --git a/modules/cmpapi/test/CmpApi.test.ts b/modules/cmpapi/test/CmpApi.test.ts
@@ -7,11 +7,11 @@ import {Ping} from '../src/response/Ping';
 import {TCData} from '../src/response/TCData';
 import {TCFCommand} from '../src/command/TCFCommand';
 import {TestUtils} from './TestUtils';
-import {VendorList} from '@iabtechlabtcf/core';
+import {VendorList} from '@pubtech-ai/core';
 import {expect} from 'chai';
-import {makeRandomInt, makeRandomString, TCStringFactory} from '@iabtechlabtcf/testing';
+import {makeRandomInt, makeRandomString, TCStringFactory} from '@pubtech-ai/testing';
 
-import * as stub from '@iabtechlabtcf/stub';
+import * as stub from '@pubtech-ai/stub';
 
 const API_VERSION = 2;
 

diff --git a/modules/cmpapi/test/EventListenerQueue.test.ts b/modules/cmpapi/test/EventListenerQueue.test.ts
@@ -1,7 +1,7 @@
 import {EventListenerQueue} from '../src/EventListenerQueue';
 import {expect} from 'chai';
-import {TCStringFactory} from '@iabtechlabtcf/testing';
-import {TCString} from '@iabtechlabtcf/core';
+import {TCStringFactory} from '@pubtech-ai/testing';
+import {TCString} from '@pubtech-ai/core';
 import {TCData} from '../src/response/TCData';
 import {CmpApiModel} from '../src/CmpApiModel';
 

diff --git a/modules/cmpapi/test/ReportedIssues.test.ts b/modules/cmpapi/test/ReportedIssues.test.ts
@@ -1,4 +1,4 @@
-import * as stub from '@iabtechlabtcf/stub';
+import * as stub from '@pubtech-ai/stub';
 import * as sinon from 'sinon';
 import {API_KEY, CmpApi} from '../src/';
 import {CmpApiModel} from '../src/CmpApiModel';
@@ -7,7 +7,7 @@ import {EventStatus} from '../src/status/EventStatus';
 import {TCFCommand} from '../src/command/TCFCommand';
 import {TestUtils} from './TestUtils';
 import {expect} from 'chai';
-import {makeRandomInt, TCStringFactory} from '@iabtechlabtcf/testing';
+import {makeRandomInt, TCStringFactory} from '@pubtech-ai/testing';
 
 describe('Reported issues', (): void => {
 

diff --git a/modules/cmpapi/test/Root.test.ts b/modules/cmpapi/test/Root.test.ts
@@ -1,7 +1,7 @@
 import {CmpApiModel} from '../src/CmpApiModel';
-import {GVL} from '@iabtechlabtcf/core';
+import {GVL} from '@pubtech-ai/core';
 import * as path from 'path';
-import {XMLHttpTestTools, TestCollector} from '@iabtechlabtcf/testing';
+import {XMLHttpTestTools, TestCollector} from '@pubtech-ai/testing';
 import {fileURLToPath} from 'url';
 // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
 // @ts-ignore
@@ -24,7 +24,7 @@ declare global {
 
 GVL.baseUrl = 'http://sweetcmp.mgr.consensu.org';
 
-describe('@iabtechlabtcf/cmpapi', (): void => {
+describe('@pubtech-ai/cmpapi', (): void => {
 
   beforeEach((): void => {
 

diff --git a/modules/cmpapi/test/TestUtils.ts b/modules/cmpapi/test/TestUtils.ts
@@ -3,10 +3,10 @@ import {CmpApiModel} from '../src/CmpApiModel';
 import {CmpApi} from '../src/CmpApi';
 import {CustomCommands} from '../src/CustomCommands';
 import {InAppTCData} from '../src/response/InAppTCData';
-import {PurposeRestriction, TCString, Vector} from '@iabtechlabtcf/core';
+import {PurposeRestriction, TCString, Vector} from '@pubtech-ai/core';
 import {TCData} from '../src/response/TCData';
 import {expect} from 'chai';
-import {makeRandomInt} from '@iabtechlabtcf/testing';
+import {makeRandomInt} from '@pubtech-ai/testing';
 
 export class TestUtils {
 

diff --git a/modules/cmpapi/test/command/AddEventListenerCommand.test.ts b/modules/cmpapi/test/command/AddEventListenerCommand.test.ts
@@ -1,6 +1,6 @@
 import {AddEventListenerCommand} from '../../src/command/AddEventListenerCommand';
 import {CmpApiModel} from '../../src/CmpApiModel';
-import {TCModelFactory} from '@iabtechlabtcf/testing';
+import {TCModelFactory} from '@pubtech-ai/testing';
 import {TCData} from '../../src/response/TCData';
 import {expect} from 'chai';
 

diff --git a/modules/cmpapi/test/command/GetInAppTCDataCommand.test.ts b/modules/cmpapi/test/command/GetInAppTCDataCommand.test.ts
@@ -1,6 +1,6 @@
 import {GetInAppTCDataCommand} from '../../src/command/GetInAppTCDataCommand';
 import {CmpApiModel} from '../../src/CmpApiModel';
-import {TCModelFactory} from '@iabtechlabtcf/testing';
+import {TCModelFactory} from '@pubtech-ai/testing';
 import {InAppTCData} from '../../src/response/InAppTCData';
 import {expect} from 'chai';
 

diff --git a/modules/cmpapi/test/command/GetTCDataCommand.test.ts b/modules/cmpapi/test/command/GetTCDataCommand.test.ts
@@ -1,8 +1,8 @@
 import {CmpApiModel} from '../../src/CmpApiModel';
-import {TCModelFactory, TCStringFactory, XMLHttpTestTools} from '@iabtechlabtcf/testing';
+import {TCModelFactory, TCStringFactory, XMLHttpTestTools} from '@pubtech-ai/testing';
 import {GetTCDataCommand} from '../../src/command/GetTCDataCommand';
 import {TCData} from '../../src/response/TCData';
-import {TCString} from '@iabtechlabtcf/core';
+import {TCString} from '@pubtech-ai/core';
 import {expect} from 'chai';
 
 describe('command->GetTCDataCommand', (): void => {

diff --git a/modules/cmpapi/test/command/GetVendorListCommand.test.ts b/modules/cmpapi/test/command/GetVendorListCommand.test.ts
@@ -1,8 +1,8 @@
 import * as sinon from 'sinon';
 import {CmpApiModel} from '../../src/CmpApiModel';
 import {GetVendorListCommand} from '../../src/command/GetVendorListCommand';
-import {TCModelFactory, XMLHttpTestTools, GVLFactory, makeRandomInt} from '@iabtechlabtcf/testing';
-import {VendorList, TCModel} from '@iabtechlabtcf/core';
+import {TCModelFactory, XMLHttpTestTools, GVLFactory, makeRandomInt} from '@pubtech-ai/testing';
+import {VendorList, TCModel} from '@pubtech-ai/core';
 import {expect} from 'chai';
 import * as fs from 'fs';
 import * as path from 'path';
@@ -66,7 +66,7 @@ describe('command->GetVendorListCommand', (): void => {
     const version = makeRandomInt(1, 22);
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const json = JSON.parse(fs.readFileSync(__dirname + `/../../../testing/lib/mjs/vendorlist/vendor-list-v${version}.json`).toString());
+    const json = JSON.parse(fs.readFileSync(__dirname + `/../../../testing/lib/mjs/vendorlist/v2/vendor-list-v${version}.json`).toString());
     const stringified = JSON.stringify(json);
 
     new GetVendorListCommand((gvl: VendorList, success: boolean): void => {

diff --git a/modules/cmpapi/test/command/RemoveEventListenerCommand.test.ts b/modules/cmpapi/test/command/RemoveEventListenerCommand.test.ts
@@ -2,8 +2,8 @@ import {AddEventListenerCommand} from '../../src/command/AddEventListenerCommand
 import {CmpApiModel} from '../../src/CmpApiModel';
 import {RemoveEventListenerCommand} from '../../src/command/RemoveEventListenerCommand';
 import {TCData} from '../../src/response';
-import {TCStringFactory} from '@iabtechlabtcf/testing';
-import {TCString} from '@iabtechlabtcf/core';
+import {TCStringFactory} from '@pubtech-ai/testing';
+import {TCString} from '@pubtech-ai/core';
 import {expect} from 'chai';
 
 describe('command->RemoveEventListenerCommand', (): void => {

diff --git a/modules/cmpapi/test/response/Disabled.test.ts b/modules/cmpapi/test/response/Disabled.test.ts
@@ -2,7 +2,7 @@ import {CmpApiModel} from '../../src/CmpApiModel';
 import {CmpStatus} from '../../src/status/CmpStatus';
 import {Disabled} from '../../src/response/Disabled';
 import {expect} from 'chai';
-import {makeRandomInt} from '@iabtechlabtcf/testing';
+import {makeRandomInt} from '@pubtech-ai/testing';
 
 describe('response->Disabled', (): void => {
 

diff --git a/modules/cmpapi/test/response/InAppTCData.test.ts b/modules/cmpapi/test/response/InAppTCData.test.ts
@@ -1,7 +1,7 @@
 import {CmpApiModel} from '../../src/CmpApiModel';
 import {TestUtils} from '../TestUtils';
-import {TCModelFactory, makeRandomIntArray} from '@iabtechlabtcf/testing';
-import {TCString} from '@iabtechlabtcf/core';
+import {TCModelFactory, makeRandomIntArray} from '@pubtech-ai/testing';
+import {TCString} from '@pubtech-ai/core';
 
 describe('response->InAppTCData', (): void => {
 

diff --git a/modules/cmpapi/test/response/Ping.test.ts b/modules/cmpapi/test/response/Ping.test.ts
@@ -1,6 +1,6 @@
 import {Ping} from '../../src/response/Ping';
-import {TCModel} from '@iabtechlabtcf/core';
-import {makeRandomInt} from '@iabtechlabtcf/testing';
+import {TCModel} from '@pubtech-ai/core';
+import {makeRandomInt} from '@pubtech-ai/testing';
 import {CmpApiModel} from '../../src/CmpApiModel';
 import {CmpStatus} from '../../src/status/CmpStatus';
 import {DisplayStatus} from '../../src/status/DisplayStatus';

diff --git a/modules/cmpapi/test/response/Response.test.ts b/modules/cmpapi/test/response/Response.test.ts
@@ -1,7 +1,7 @@
 import {CmpApiModel} from '../../src/CmpApiModel';
 import {Response} from '../../src/response/Response';
 import {expect} from 'chai';
-import {makeRandomInt} from '@iabtechlabtcf/testing';
+import {makeRandomInt} from '@pubtech-ai/testing';
 
 describe('response->Response', (): void => {
 

diff --git a/modules/cmpapi/test/response/TCData.test.ts b/modules/cmpapi/test/response/TCData.test.ts
@@ -1,8 +1,8 @@
 import {CmpApiModel} from '../../src/CmpApiModel';
-import {PurposeRestriction, TCString} from '@iabtechlabtcf/core';
+import {PurposeRestriction, TCString} from '@pubtech-ai/core';
 import {TestUtils} from '../TestUtils';
 import {TCData} from '../../src/response/TCData';
-import {TCModelFactory, makeRandomInt, makeRandomIntArray} from '@iabtechlabtcf/testing';
+import {TCModelFactory, makeRandomInt, makeRandomIntArray} from '@pubtech-ai/testing';
 import {expect} from 'chai';
 
 describe('response->TCData', (): void => {