@pubtech-ai/core 2.7.0 → 2.8.0

package/lib/cjs/TCString.d.ts

@@ -19,9 +19,10 @@ export declare class TCString {
      * @param {string} encodedTCString - base64url encoded Transparency and
      * Consent String to decode - can also be a single or group of segments of
      * the string
-     * @param {string} [tcModel] - model to enhance with the information.  If
+     * @param {TCModel} tcModel - model to enhance with the information.  If
      * none is passed a new instance of TCModel will be created.
+     * @param {boolean} useCached - if true it will return a reference to the same TCModel already created previously.
      * @return {TCModel} - Returns populated TCModel
      */
-    static decode(encodedTCString: string, tcModel?: TCModel): TCModel;
+    static decode(encodedTCString: string, tcModel?: TCModel, useCached?: boolean): TCModel;
 }

package/lib/cjs/TCString.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TCString=void 0;var index_js_1=require("./encoder/index.js"),index_js_2=require("./model/index.js"),IntEncoder_js_1=require("./encoder/field/IntEncoder.js"),TCModel_js_1=require("./TCModel.js"),decodeCachedResults={},TCString=function(){function e(){}return e.encode=function(e,n){var d,r="";return e=index_js_1.SemanticPreEncoder.process(e,n),(d=Array.isArray(null==n?void 0:n.segments)?n.segments:new index_js_1.SegmentSequence(e,n)[""+e.version]).forEach((function(n,s){var t="";s<d.length-1&&(t="."),r+=index_js_1.SegmentEncoder.encode(e,n)+t})),r},e.decode=function(e,n){if(decodeCachedResults[e])return decodeCachedResults[e].clone();decodeCachedResults={};var d=e.split("."),r=d.length;n||(n=new TCModel_js_1.TCModel);for(var s=0;s<r;s++){var t=d[s],o=index_js_1.Base64Url.decode(t.charAt(0)).substr(0,index_js_1.BitLength.segmentType),c=index_js_2.SegmentIDs.ID_TO_KEY[IntEncoder_js_1.IntEncoder.decode(o,index_js_1.BitLength.segmentType).toString()];index_js_1.SegmentEncoder.decode(t,n,c)}return decodeCachedResults[e]=n,n},e}();exports.TCString=TCString;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TCString=void 0;var index_js_1=require("./encoder/index.js"),index_js_2=require("./model/index.js"),IntEncoder_js_1=require("./encoder/field/IntEncoder.js"),TCModel_js_1=require("./TCModel.js"),decodeCachedResults={},TCString=function(){function e(){}return e.encode=function(e,n){var d,r="";return e=index_js_1.SemanticPreEncoder.process(e,n),(d=Array.isArray(null==n?void 0:n.segments)?n.segments:new index_js_1.SegmentSequence(e,n)[""+e.version]).forEach((function(n,s){var t="";s<d.length-1&&(t="."),r+=index_js_1.SegmentEncoder.encode(e,n)+t})),r},e.decode=function(e,n,d){if(void 0===d&&(d=!1),d&&decodeCachedResults[e])return decodeCachedResults[e];decodeCachedResults={};var r=e.split("."),s=r.length;n||(n=new TCModel_js_1.TCModel);for(var t=0;t<s;t++){var o=r[t],i=index_js_1.Base64Url.decode(o.charAt(0)).substr(0,index_js_1.BitLength.segmentType),c=index_js_2.SegmentIDs.ID_TO_KEY[IntEncoder_js_1.IntEncoder.decode(i,index_js_1.BitLength.segmentType).toString()];index_js_1.SegmentEncoder.decode(o,n,c)}return decodeCachedResults[e]=n,n},e}();exports.TCString=TCString;

package/lib/cjs/encoder/field/PurposeRestrictionVectorEncoder.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PurposeRestrictionVectorEncoder=void 0;var BitLength_js_1=require("../BitLength.js"),BooleanEncoder_js_1=require("./BooleanEncoder.js"),index_js_1=require("../../errors/index.js"),IntEncoder_js_1=require("./IntEncoder.js"),index_js_2=require("../../model/index.js"),PurposeRestrictionVectorEncoder=function(){function e(){}return e.encode=function(e){var n=IntEncoder_js_1.IntEncoder.encode(e.numRestrictions,BitLength_js_1.BitLength.numRestrictions);if(!e.isEmpty()){var t=Array.from(e.gvl.vendorIds),r=function(e,n){var r=t.indexOf(e);if(t.indexOf(n)-r>0){var o=t.indexOf(e+1);return t[o]}return e},o=new Map;e.getRestrictions().forEach((function(t){n+=IntEncoder_js_1.IntEncoder.encode(t.purposeId,BitLength_js_1.BitLength.purposeId),n+=IntEncoder_js_1.IntEncoder.encode(t.restrictionType,BitLength_js_1.BitLength.restrictionType);var i=e.getVendorsSet(t),s=0,d="";if(o.has(i)){var _=o.get(i);s=_.numEntries,d=_.rangeField}else{for(var c=Array.from(i).sort((function(e,n){return e-n})),g=c.length,B=0,h=0;h<g;h++){var L=c[h];if(0===B&&(s++,B=L),h===g-1||c[h+1]>r(L,c[g-1])){var j=!(L===B);d+=BooleanEncoder_js_1.BooleanEncoder.encode(j),d+=IntEncoder_js_1.IntEncoder.encode(B,BitLength_js_1.BitLength.vendorId),j&&(d+=IntEncoder_js_1.IntEncoder.encode(L,BitLength_js_1.BitLength.vendorId)),B=0}}o.set(i,{numEntries:s,rangeField:d})}n+=IntEncoder_js_1.IntEncoder.encode(s,BitLength_js_1.BitLength.numEntries),n+=d}))}return n},e.decode=function(e){var n=0,t=new index_js_2.PurposeRestrictionVector,r=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.numRestrictions),BitLength_js_1.BitLength.numRestrictions);n+=BitLength_js_1.BitLength.numRestrictions;for(var o=0;o<r;o++){var i=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.purposeId),BitLength_js_1.BitLength.purposeId);n+=BitLength_js_1.BitLength.purposeId;var s=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.restrictionType),BitLength_js_1.BitLength.restrictionType);n+=BitLength_js_1.BitLength.restrictionType;var d=new index_js_2.PurposeRestriction(i,s),_=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.numEntries),BitLength_js_1.BitLength.numEntries);n+=BitLength_js_1.BitLength.numEntries;for(var c=0;c<_;c++){var g=BooleanEncoder_js_1.BooleanEncoder.decode(e.substr(n,BitLength_js_1.BitLength.anyBoolean));n+=BitLength_js_1.BitLength.anyBoolean;var B=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.vendorId),BitLength_js_1.BitLength.vendorId);if(n+=BitLength_js_1.BitLength.vendorId,g){var h=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.vendorId),BitLength_js_1.BitLength.vendorId);if(n+=BitLength_js_1.BitLength.vendorId,h<B)throw new index_js_1.DecodingError("Invalid RangeEntry: endVendorId ".concat(h," is less than ").concat(B));for(var L=B;L<=h;L++)t.add(L,d)}else t.add(B,d)}}return t.bitLength=n,t},e}();exports.PurposeRestrictionVectorEncoder=PurposeRestrictionVectorEncoder;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PurposeRestrictionVectorEncoder=void 0;var BitLength_js_1=require("../BitLength.js"),BooleanEncoder_js_1=require("./BooleanEncoder.js"),index_js_1=require("../../errors/index.js"),IntEncoder_js_1=require("./IntEncoder.js"),index_js_2=require("../../model/index.js"),PurposeRestrictionVectorEncoder=function(){function e(){}return e.encode=function(e){var n=IntEncoder_js_1.IntEncoder.encode(e.numRestrictions,BitLength_js_1.BitLength.numRestrictions);if(!e.isEmpty()){var t=Array.from(e.gvl.vendorIds),r=function(e,n){var r=t.indexOf(e);if(t.indexOf(n)-r>0){var o=t.indexOf(e+1);return{nextVendorId:t[o],index:t[r+1]}}return{nextVendorId:e,index:e}},o=new Map;e.getRestrictions().forEach((function(t){n+=IntEncoder_js_1.IntEncoder.encode(t.purposeId,BitLength_js_1.BitLength.purposeId),n+=IntEncoder_js_1.IntEncoder.encode(t.restrictionType,BitLength_js_1.BitLength.restrictionType);var i=e.getVendorsSet(t),s=0,d="";if(o.has(i)){var _=o.get(i);s=_.numEntries,d=_.rangeField}else{for(var c=Array.from(i).sort((function(e,n){return e-n})),g=c.length,B=0,h=0;h<g;h++){var L=c[h];0===B&&(s++,B=L);var j=h===g-1;if(!j){var u=r(L,c[g-1]),a=u.nextVendorId,E=u.index;c[h+1]>a?j=!0:E>h&&E<g&&(h=E)}if(j){var I=!(L===B);d+=BooleanEncoder_js_1.BooleanEncoder.encode(I),d+=IntEncoder_js_1.IntEncoder.encode(B,BitLength_js_1.BitLength.vendorId),I&&(d+=IntEncoder_js_1.IntEncoder.encode(L,BitLength_js_1.BitLength.vendorId)),B=0}}o.set(i,{numEntries:s,rangeField:d})}n+=IntEncoder_js_1.IntEncoder.encode(s,BitLength_js_1.BitLength.numEntries),n+=d}))}return n},e.decode=function(e){var n=0,t=new index_js_2.PurposeRestrictionVector,r=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.numRestrictions),BitLength_js_1.BitLength.numRestrictions);n+=BitLength_js_1.BitLength.numRestrictions;for(var o=0;o<r;o++){var i=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.purposeId),BitLength_js_1.BitLength.purposeId);n+=BitLength_js_1.BitLength.purposeId;var s=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.restrictionType),BitLength_js_1.BitLength.restrictionType);n+=BitLength_js_1.BitLength.restrictionType;var d=new index_js_2.PurposeRestriction(i,s),_=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.numEntries),BitLength_js_1.BitLength.numEntries);n+=BitLength_js_1.BitLength.numEntries;for(var c=0;c<_;c++){var g=BooleanEncoder_js_1.BooleanEncoder.decode(e.substr(n,BitLength_js_1.BitLength.anyBoolean));n+=BitLength_js_1.BitLength.anyBoolean;var B=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.vendorId),BitLength_js_1.BitLength.vendorId);if(n+=BitLength_js_1.BitLength.vendorId,g){var h=IntEncoder_js_1.IntEncoder.decode(e.substr(n,BitLength_js_1.BitLength.vendorId),BitLength_js_1.BitLength.vendorId);if(n+=BitLength_js_1.BitLength.vendorId,h<B)throw new index_js_1.DecodingError("Invalid RangeEntry: endVendorId ".concat(h," is less than ").concat(B));for(var L=B;L<=h;L++)t.add(L,d)}else t.add(B,d)}}return t.bitLength=n,t},e}();exports.PurposeRestrictionVectorEncoder=PurposeRestrictionVectorEncoder;

package/lib/mjs/TCString.d.ts

@@ -19,9 +19,10 @@ export declare class TCString {
      * @param {string} encodedTCString - base64url encoded Transparency and
      * Consent String to decode - can also be a single or group of segments of
      * the string
-     * @param {string} [tcModel] - model to enhance with the information.  If
+     * @param {TCModel} tcModel - model to enhance with the information.  If
      * none is passed a new instance of TCModel will be created.
+     * @param {boolean} useCached - if true it will return a reference to the same TCModel already created previously.
      * @return {TCModel} - Returns populated TCModel
      */
-    static decode(encodedTCString: string, tcModel?: TCModel): TCModel;
+    static decode(encodedTCString: string, tcModel?: TCModel, useCached?: boolean): TCModel;
 }

package/lib/mjs/TCString.js

@@ -43,13 +43,14 @@ export class TCString {
      * @param {string} encodedTCString - base64url encoded Transparency and
      * Consent String to decode - can also be a single or group of segments of
      * the string
-     * @param {string} [tcModel] - model to enhance with the information.  If
+     * @param {TCModel} tcModel - model to enhance with the information.  If
      * none is passed a new instance of TCModel will be created.
+     * @param {boolean} useCached - if true it will return a reference to the same TCModel already created previously.
      * @return {TCModel} - Returns populated TCModel
      */
-    static decode(encodedTCString, tcModel) {
-        if (decodeCachedResults[encodedTCString]) {
-            return decodeCachedResults[encodedTCString].clone();
+    static decode(encodedTCString, tcModel, useCached = false) {
+        if (useCached && decodeCachedResults[encodedTCString]) {
+            return decodeCachedResults[encodedTCString];
         }
         decodeCachedResults = {};
         const segments = encodedTCString.split('.');

package/lib/mjs/encoder/field/PurposeRestrictionVectorEncoder.js

@@ -15,9 +15,15 @@ export class PurposeRestrictionVectorEncoder {
                 const lastIndex = gvlVendorIds.indexOf(lastVendorId);
                 if (lastIndex - firstIndex > 0) {
                     const nextIndex = gvlVendorIds.indexOf(vendorId + 1);
-                    return gvlVendorIds[nextIndex];
+                    return {
+                        nextVendorId: gvlVendorIds[nextIndex],
+                        index: gvlVendorIds[firstIndex + 1],
+                    };
                 }
-                return vendorId;
+                return {
+                    nextVendorId: vendorId,
+                    index: vendorId,
+                };
             };
             const cachedResults = new Map();
             // create each restriction group
@@ -48,10 +54,20 @@ export class PurposeRestrictionVectorEncoder {
                             numEntries++;
                             startId = vendorId;
                         }
+                        let isRangeEncodeRequired = i === len - 1;
+                        if (!isRangeEncodeRequired) {
+                            const { nextVendorId, index } = nextGvlVendor(vendorId, vendors[len - 1]);
+                            if (vendors[i + 1] > nextVendorId) {
+                                isRangeEncodeRequired = true;
+                            }
+                            else if (index > i && index < len) {
+                                i = index;
+                            }
+                        }
                         /**
                          * either end of the loop or there are GVL vendor IDs before the next one
                          */
-                        if (i === len - 1 || vendors[i + 1] > nextGvlVendor(vendorId, vendors[len - 1])) {
+                        if (isRangeEncodeRequired) {
                             /**
                              * it's a range entry if we've got something other than the start
                              * ID
@@ -73,7 +89,7 @@ export class PurposeRestrictionVectorEncoder {
                     });
                 }
                 /**
-                 * now that  the range encoding is built, encode the number of ranges
+                 * now that the range encoding is built, encode the number of ranges
                  * and then append the range field to the bitString.
                  */
                 bitString += IntEncoder.encode(numEntries, BitLength.numEntries);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pubtech-ai/core",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Ensures consistent encoding and decoding of TC Signals for the iab. Transparency and Consent Framework (TCF).",
   "author": "Mayank Mishra <mayank@iabtechlab.com>",
   "homepage": "https://iabtcf.com/",
@@ -28,7 +28,7 @@
     "test-cov": "rm -rf coverage; nyc --reporter=html mocha"
   },
   "devDependencies": {
-    "@pubtech-ai/testing": "2.7.0",
+    "@pubtech-ai/testing": "2.8.0",
     "@istanbuljs/nyc-config-typescript": "^0.1.3",
     "@types/sinon": "^10.0.11",
     "@types/sinon-chai": "3.2.8",