Update to the latest version of the IAB TCF library

.circleci/config.yml

@@ -1,8 +1,10 @@
+# This job run on circleci https://circleci.com/ on every PR.
+# The purpose is to execute all tests and see the result in the test-results.xml
 version: 2.1
 jobs:
   build:
     docker:
-      - image: 'circleci/node:10.15.3'
+      - image: "cimg/node:16.15.0"
     steps:
       - checkout
       - run: yarn

.eslintrc.js → .eslintrc.cjs

@@ -10,11 +10,15 @@ module.exports = {
     'plugin:json/recommended',
   ],
   settings: {
-    'import/parsers': {
-      '@typescript-eslint/parser': [ 
-        '.ts' 
-      ]
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts"]
     },
+    "import/resolver": {
+      // This with eslint-import-resolver-typescript allow use '.js' suffix in exports to allow ESM work also in browser
+      "typescript": {
+        "alwaysTryTypes": true,
+      },
+    }
   },
   parserOptions: {
     parser: '@typescript-eslint/parser',
@@ -23,6 +27,7 @@ module.exports = {
   },
   rules: {
     'import/no-cycle': ['error', { maxDepth: 1 }],
+    'import/namespace': 0,
     'max-len': 0,
     'no-multiple-empty-lines':['error', {'max':1, 'maxEOF':0, 'maxBOF':0}],
     'require-jsdoc': [0],

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+# This job run on GitHub actions on every PR opened.
+# The purpose is to perform the build and all module tests.
+name: CI
+
+on:
+  pull_request:
+    branches: [ '**' ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.15.0]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: yarn install
+      - run: yarn build
+      - run: yarn test

.mocharc.json

@@ -0,0 +1,12 @@
+{
+  "require": [
+    "ts-node/register",
+    "jsdom-global/register",
+    "source-map-support/register"
+  ],
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm"
+  ],
+  "spec": "./modules/**/test/Root.test.ts"
+}

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contribution
+
+In order to contribute to the improvement of the project, below you will find the project development flow.
+Before being able to open a PR with changes to be applied or bug fixes to be solved, it is necessary to open an issue 
+and explain the reason and a possible solution. You can open each PR by forking the project and creating the PR directly from 
+your project to the project of our library.
+
+Main rules:
+- Open issue
+- Create PR from forked project
+- Link your PR to the issue
+
+## Development environment
+
+To ease local development you have to install these tools:
+
+- [NodeJs v16.15.0](https://nodejs.org/it/)
+- [Yarn 1.22.17](https://yarnpkg.com/)
+
+### Install dependencies
+
+To install dependencies, execute these commands:
+```sh
+yarn install
+```
+
+### Test project
+
+To run tests, execute this command:
+```sh
+yarn test
+```
+
+### Lint project
+
+To lint the project files, execute this command:
+```sh
+yarn lint
+```
+
+### Compile and minify for production
+
+To create a production version, execute this command:
+```sh
+yarn build
+```
+
+## ESM - CJS
+
+This library is exported to support both ESM and CJS usage.
+To ensure a good output on ESM we need to add the extension on exports and imports with '.js'. 
+This is necessary and also recommended by Typescript maintainers to 
+generate code that works in environments where ESM can be used.

README.md

@@ -15,3 +15,7 @@ This is a mono repo containing 5 modules:
 [Testing](./modules/testing#iabtcftesting) - Tools for testing the core library including random TCModel and GVL generators.
 
 [Stub](./modules/stub#iabtcfstub) - Code for the on-page `__tcfapi()` CMP stub.
+
+## Contributing
+
+Here you can find the [contributing guide](CONTRIBUTING.md) to help maintain and update the library.

bin/publish-version

@@ -58,7 +58,7 @@ fi
 
 for pkg in ./modules/*; do
   if [[ -d $pkg ]]; then
-    yarn publish --access public --new-version $npm_package_version $pkg
+    yarn publish --access public --new-version $npm_package_version --tag next $pkg
   fi
 done
 

modules/.mocharc.json

@@ -0,0 +1,12 @@
+{
+  "require": [
+    "ts-node/register",
+    "jsdom-global/register",
+    "source-map-support/register"
+  ],
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm"
+  ],
+  "spec": "./test/Root.test.ts"
+}

modules/build

@@ -3,12 +3,26 @@
 rm -rf lib
 mkdir lib
 
-tsc
+tsc -p tsconfig.json
 
-FILES=$(find lib -name "*.js")
+tsc -p tsconfig-cjs.json
+
+FILES=$(find lib/cjs -name "*.js")
 
 for FILE in $FILES; do
 
   terser $FILE --ecma 5 -m -c -o $FILE
 
 done
+
+cat >lib/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+cat >lib/mjs/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF

modules/cli/README.md

@@ -28,8 +28,8 @@ cmpId: 2
 cmpVersion: 1
 consentScreen: 2
 consentLanguage: "EN"
-created: Mon Dec 09 2019 18:01:46 GMT-0800 (Pacific Standard Time)
-lastUpdated: Mon Dec 09 2019 18:01:46 GMT-0800 (Pacific Standard Time)
+created: Mon Dec 09 2019 00:00:00 GMT
+lastUpdated: Mon Dec 09 2019 00:00:00 GMT
 policyVersion: 2
 isServiceSpecific: false
 useNonStandardStacks: false

modules/cli/package.json

@@ -1,31 +1,42 @@
 {
   "name": "@iabtcf/cli",
-  "version": "1.2.1",
+  "version": "1.5.3",
   "description": "Decode a iab TCF (Transparency and Consent Framework) TC String via the command line",
   "author": "Chris Paterson <tcf@chrispaterson.io>",
   "homepage": "https://iabtcf.com/",
   "license": "Apache-2.0",
   "bin": {
-    "tcstring": "./lib/index.js"
+    "tcstring": "./lib/cjs/index.js"
   },
+  "type": "module",
+  "main": "lib/cjs/index.js",
+  "module": "lib/mjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./lib/mjs/index.js",
+      "require": "./lib/cjs/index.js"
+    }
+  },
+  "types": "lib/mjs/index.d.ts",
   "files": [
     "lib/**/*"
   ],
   "scripts": {
     "preversion": "echo 'woops I think you meant to go to the root' && exit 1",
-    "build": "rm -rf lib ; tsc ; chmod a+x lib/index.js",
+    "build": "../build ; chmod a+x lib/mjs/index.js ; chmod a+x lib/cjs/index.js",
     "lint": "eslint `find src -name '*.ts'`"
   },
   "dependencies": {
-    "@iabtcf/core": "1.2.1"
+    "@iabtcf/core": "1.5.3"
   },
   "devDependencies": {
+    "@types/node": "^17.0.18",
     "@typescript-eslint/eslint-plugin": "^2.10.0",
-    "@typescript-eslint/parser": "^2.10.0",
+    "@typescript-eslint/parser": "^5.12.0",
     "eslint": "6.8.0",
     "source-map-support": "^0.5.12",
-    "ts-node": "^8.5.4",
-    "typescript": "^3.7.0"
+    "ts-node": "^10.5.0",
+    "typescript": "^4.5.5"
   },
   "eslintIgnore": [
     "lib"

modules/cli/tsconfig-cjs.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib/cjs",
+    "module": "commonjs",
+    "target": "es2015"
+  },
+  "exclude": [
+    "node_modules"
+  ],
+  "include": [
+    "src"
+  ]
+}
+

modules/cmpapi/.mocharc.json

@@ -0,0 +1,12 @@
+{
+  "require": [
+    "ts-node/register",
+    "jsdom-global/register",
+    "source-map-support/register"
+  ],
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm"
+  ],
+  "spec": "./test/Root.test.ts"
+}

modules/cmpapi/README.md

@@ -157,7 +157,7 @@ const cmpApi = new CmpApi(1, 3, false, {
 
 });
 
-const songLyricCallback = (lyrics) => {
+const songLyricCallback = (lyrics, success) => {
 
   if(success) {
 
@@ -181,7 +181,7 @@ __tcfapi('connectBones', 2, songLyricCallback, 'knee', 'thigh');
 ### Built-In and Custom Commands
 Beginning in 1.1.0, if a custom command is defined that overlaps with a built-in command (`"ping"`, `"getTCData"`, `"getInAppTCData"`, `"getVendorList"`) then the custom command will act as a "middleware" being passed the built-in command's response and expected to pass along the response when finished.
 
-**Note:** `"addEventListener"` and `"removeEventListener"` can __not__ be overwritten.  `"addEventListener"` utilizes the `"getTCData"` command, so to modify `TCData` responses, write a Built-In custom command for that command and both `"getTCData"` and `"addEventListener"` will utilize it. 
+**Note:** `"addEventListener"` and `"removeEventListener"` can __not__ be overwritten.  `"addEventListener"` utilizes the `"getTCData"` command, so to modify `TCData` responses, write a Built-In custom command for that command and both `"getTCData"` and `"addEventListener"` will utilize it.  If the `"removeEventListener"` command is also used with a custom `"getTCData"` command, note that `"removeEventListener"` will not return `tcData` but rather a boolean that indicates if the listener was removed.  So it is important to add a check, otherwise the CmpApi will catch that error and the callbacks will return with `tcData: null`.
 
 **Example**
 ````javascript
@@ -190,13 +190,19 @@ import {CmpApi} from '@iabtcf/cmpapi';
 
 const cmpApi = new CmpApi(1, 3, false, {
 
-  'getTCData': (next, tcData) => {
+  'getTCData': (next, tcData, status) => {
 
-    // tcData will be constructed via the TC string and can be added to here
-    tcData.reallyImportantExtraProperty = true;
+    /*
+     * If using with 'removeEventListener' command, add a check to see if tcData is not a boolean. */
+    if (typeof tcData !== 'boolean') {
 
-    // pass data along
-    next(tcData);
+      // tcData will be constructed via the TC string and can be added to here
+      tcData.reallyImportantExtraProperty = true;
+
+    }
+
+    // pass data and status along
+    next(tcData, status);
 
 
   },