Merge pull request #1 from InteractiveAdvertisingBureau/388

Update to support TCF v2.2 (issue InteractiveAdvertisingBureau#388). Also fixed an error in the t…
BaCybot · Aug 30, 2023 · 7c79c2c · 7c79c2c
2 parents 564a453 + f0b27e0
commit 7c79c2c
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 8 deletions.
diff --git a/modules/cmpapi/src/CmpApi.ts b/modules/cmpapi/src/CmpApi.ts
@@ -23,7 +23,7 @@ export class CmpApi {
 
     CmpApiModel.cmpId = cmpId;
     CmpApiModel.cmpVersion = cmpVersion;
-    CmpApiModel.tcfPolicyVersion = 2;
+    CmpApiModel.tcfPolicyVersion = 4;
 
     this.isServiceSpecific = !!isServiceSpecific;
     this.callResponder = new CallResponder(customCommands);

diff --git a/modules/cmpapi/test/response/Ping.test.ts b/modules/cmpapi/test/response/Ping.test.ts
@@ -8,6 +8,12 @@ import {expect} from 'chai';
 
 describe('response->Ping', (): void => {
 
+  beforeEach(function() {
+
+    CmpApiModel.reset();
+
+  });
+
   const isAGoodPing = (ping: Ping): void => {
 
     expect(ping.cmpLoaded, 'ping.cmpLoaded').to.be.true;

diff --git a/modules/core/src/TCModel.ts b/modules/core/src/TCModel.ts
@@ -21,7 +21,7 @@ export class TCModel extends Cloneable<TCModel> {
   private publisherCountryCode_ = 'AA';
   private version_ = 2;
   private consentScreen_: StringOrNumber = 0;
-  private policyVersion_: StringOrNumber = 2;
+  private policyVersion_: StringOrNumber = 4;
   private consentLanguage_ = 'EN';
   private cmpId_: StringOrNumber = 0;
   private cmpVersion_: StringOrNumber = 0;

diff --git a/modules/core/src/encoder/SemanticPreEncoder.ts b/modules/core/src/encoder/SemanticPreEncoder.ts
@@ -21,8 +21,9 @@ export class SemanticPreEncoder {
 
       /**
        * Purpose 1 is never allowed to be true for legitimate interest
+       * As of TCF v2.2 purposes 3,4,5 & 6 are not allowed to be true for LI
        */
-      tcModel.purposeLegitimateInterests.unset(1);
+      tcModel.purposeLegitimateInterests.unset([1, 3, 4, 5, 6]);
 
       /**
        * If a Vendor does not declare a purpose for consent or legitimate

diff --git a/modules/core/test/TCModel.test.ts b/modules/core/test/TCModel.test.ts
@@ -143,7 +143,7 @@ describe('TCModel', (): void => {
 
     // since we didn't construct with a gvl we should
     // have empty fields here
-    expect(tcModel.vendorListVersion).to.equal(0); expect(tcModel.policyVersion).to.equal(2);
+    expect(tcModel.vendorListVersion).to.equal(0); expect(tcModel.policyVersion).to.equal(4);
     expect(tcModel.gvl).to.be.undefined;
 
   });

diff --git a/modules/core/test/TCString.test.ts b/modules/core/test/TCString.test.ts
@@ -35,17 +35,25 @@ describe('TCString', (): void => {
 
   });
 
-  it('should unset purposeLegitimateInterests 1 if it is set', (): void => {
+  it('should unset purposeLegitimateInterests 1, 3, 4, 5 & 6 if it is set', (): void => {
 
     const tcModel = getTCModel();
-    tcModel.purposeLegitimateInterests.set(1);
+    tcModel.purposeLegitimateInterests.set([1, 3, 4, 5, 6]);
 
     expect(tcModel.purposeLegitimateInterests.has(1), 'purposeLegitimateInterests.has(1)').to.be.true;
+    expect(tcModel.purposeLegitimateInterests.has(3), 'purposeLegitimateInterests.has(3)').to.be.true;
+    expect(tcModel.purposeLegitimateInterests.has(4), 'purposeLegitimateInterests.has(4)').to.be.true;
+    expect(tcModel.purposeLegitimateInterests.has(5), 'purposeLegitimateInterests.has(5)').to.be.true;
+    expect(tcModel.purposeLegitimateInterests.has(6), 'purposeLegitimateInterests.has(6)').to.be.true;
 
     const encodedString = TCString.encode(tcModel);
     const newModel = TCString.decode(encodedString);
 
     expect(newModel.purposeLegitimateInterests.has(1), 'newModel.purposeLegitimateInterests.has(1)').to.be.false;
+    expect(newModel.purposeLegitimateInterests.has(3), 'newModel.purposeLegitimateInterests.has(3)').to.be.false;
+    expect(newModel.purposeLegitimateInterests.has(4), 'newModel.purposeLegitimateInterests.has(4)').to.be.false;
+    expect(newModel.purposeLegitimateInterests.has(5), 'newModel.purposeLegitimateInterests.has(5)').to.be.false;
+    expect(newModel.purposeLegitimateInterests.has(6), 'newModel.purposeLegitimateInterests.has(6)').to.be.false;
 
   });
 
@@ -174,9 +182,9 @@ describe('TCString', (): void => {
 
     tcModel.purposeLegitimateInterests.forEach((value: boolean, id: number): void => {
 
-      if ( id === 1 && value ) {
+      if ( (id === 1 || id >= 3 && id <= 6) && value ) {
 
-        // id 1 gets unset on encoding for legitimate interests
+        // id 1, 3, 4, 5 & 6 gets unset on encoding for legitimate interests
 
         expect(newModel.purposeLegitimateInterests.has(id), `purposeLegitimateInterests.has(${id})`).to.be.false;