@pubtech-ai/core 1.6.0

package/lib/cjs/GVL.d.ts

@@ -0,0 +1,295 @@
+import { Cloneable } from './Cloneable.js';
+import { GVLError } from './errors/index.js';
+import { ConsentLanguages, IntMap } from './model/index.js';
+import { Feature, Purpose, Stack, Vendor, VendorList, DataCategory } from './model/gvl/index.js';
+export declare type VersionOrVendorList = string | number | VendorList;
+/**
+ * class with utilities for managing the global vendor list.  Will use JSON to
+ * fetch the vendor list from specified url and will serialize it into this
+ * object and provide accessors.  Provides ways to group vendors on the list by
+ * purpose and feature.
+ */
+export declare class GVL extends Cloneable<GVL> implements VendorList {
+    private static LANGUAGE_CACHE;
+    private static CACHE;
+    private static LATEST_CACHE_KEY;
+    static readonly DEFAULT_LANGUAGE: string;
+    /**
+     * Set of available consent languages published by the IAB
+     */
+    static readonly consentLanguages: ConsentLanguages;
+    private static baseUrl_;
+    /**
+     * baseUrl - Entities using the vendor-list.json are required by the iab to
+     * host their own copy of it to reduce the load on the iab's infrastructure
+     * so a 'base' url must be set to be put together with the versioning scheme
+     * of the filenames.
+     *
+     * @static
+     * @param {string} url - the base url to load the vendor-list.json from.  This is
+     * broken out from the filename because it follows a different scheme for
+     * latest file vs versioned files.
+     *
+     * @throws {GVLError} - If the url is http[s]://vendorlist.consensu.org/...
+     * this will throw an error.  IAB Europe requires that that CMPs and Vendors
+     * cache their own copies of the GVL to minimize load on their
+     * infrastructure.  For more information regarding caching of the
+     * vendor-list.json, please see [the TCF documentation on 'Caching the Global
+     * Vendor List'
+     * ](https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md#caching-the-global-vendor-list)
+     */
+    static set baseUrl(url: string);
+    /**
+     * baseUrl - Entities using the vendor-list.json are required by the iab to
+     * host their own copy of it to reduce the load on the iab's infrastructure
+     * so a 'base' url must be set to be put together with the versioning scheme
+     * of the filenames.
+     *
+     * @static
+     * @return {string} - returns the previously set baseUrl, the default is
+     * `undefined`
+     */
+    static get baseUrl(): string;
+    /**
+     * @static
+     * @param {string} - the latest is assumed to be vendor-list.json because
+     * that is what the iab uses, but it could be different... if you want
+     */
+    static latestFilename: string;
+    /**
+     * @static
+     * @param {string} - the versioned name is assumed to be
+     * vendor-list-v[VERSION].json where [VERSION] will be replaced with the
+     * specified version.  But it could be different... if you want just make
+     * sure to include the [VERSION] macro if you have a numbering scheme, it's a
+     * simple string substitution.
+     *
+     * eg.
+     * ```javascript
+     * GVL.baseUrl = "http://www.mydomain.com/iabcmp/";
+     * GVL.versionedFilename = "vendorlist?getVersion=[VERSION]";
+     * ```
+     */
+    static versionedFilename: string;
+    /**
+     * @param {string} - Translations of the names and descriptions for Purposes,
+     * Special Purposes, Features, and Special Features to non-English languages
+     * are contained in a file where attributes containing English content
+     * (except vendor declaration information) are translated.  The iab publishes
+     * one following the scheme below where the LANG is the iso639-1 language
+     * code.  For a list of available translations
+     * [please go here](https://register.consensu.org/Translation).
+     *
+     * eg.
+     * ```javascript
+     * GVL.baseUrl = "http://www.mydomain.com/iabcmp/";
+     * GVL.languageFilename = "purposes?getPurposes=[LANG]";
+     * ```
+     */
+    static languageFilename: string;
+    /**
+     * @param {Promise} resolved when this GVL object is populated with the data
+     * or rejected if there is an error.
+     */
+    readyPromise: Promise<void | GVLError>;
+    /**
+     * @param {number} gvlSpecificationVersion - schema version for the GVL that is used
+     */
+    gvlSpecificationVersion: number;
+    /**
+     * @param {number} incremented with each published file change
+     */
+    vendorListVersion: number;
+    /**
+     * @param {number} tcfPolicyVersion - The TCF MO will increment this value
+     * whenever a GVL change (such as adding a new Purpose or Feature or a change
+     * in Purpose wording) legally invalidates existing TC Strings and requires
+     * CMPs to re-establish transparency and consent from users. If the policy
+     * version number in the latest GVL is different from the value in your TC
+     * String, then you need to re-establish transparency and consent for that
+     * user. A version 1 format TC String is considered to have a version value
+     * of 1.
+     */
+    tcfPolicyVersion: number;
+    /**
+     * @param {string | Date} lastUpdated - the date in which the vendor list
+     * json file  was last updated.
+     */
+    lastUpdated: string | Date;
+    /**
+     * @param {IntMap<Purpose>} a collection of [[Purpose]]s
+     */
+    purposes: IntMap<Purpose>;
+    /**
+     * @param {IntMap<Purpose>} a collection of [[Purpose]]s
+     */
+    specialPurposes: IntMap<Purpose>;
+    /**
+     * @param {IntMap<Feature>} a collection of [[Feature]]s
+     */
+    features: IntMap<Feature>;
+    /**
+     * @param {IntMap<Feature>} a collection of [[Feature]]s
+     */
+    specialFeatures: IntMap<Feature>;
+    /**
+     * @param {boolean} internal reference of when the GVL is ready to be used
+     */
+    private isReady_;
+    /**
+     * @param {IntMap<Vendor>} a collection of [[Vendor]]s
+     */
+    private vendors_;
+    vendorIds: Set<number>;
+    /**
+     * @param {IntMap<Vendor>} a collection of [[Vendor]]. Used as a backup if a whitelist is sets
+     */
+    private fullVendorList;
+    /**
+     * @param {ByPurposeVendorMap} vendors by purpose
+     */
+    private byPurposeVendorMap;
+    /**
+     * @param {IDSetMap} vendors by special purpose
+     */
+    private bySpecialPurposeVendorMap;
+    /**
+     * @param {IDSetMap} vendors by feature
+     */
+    private byFeatureVendorMap;
+    /**
+     * @param {IDSetMap} vendors by special feature
+     */
+    private bySpecialFeatureVendorMap;
+    /**
+     * @param {IntMap<Stack>} a collection of [[Stack]]s
+     */
+    stacks: IntMap<Stack>;
+    /**
+     * @param {IntMap<DataCategory>} a collection of [[DataCategory]]s
+     */
+    dataCategories?: IntMap<DataCategory>;
+    private lang_;
+    private isLatest;
+    /**
+     * @param {VersionOrVendorList} [versionOrVendorList] - can be either a
+     * [[VendorList]] object or a version number represented as a string or
+     * number to download.  If nothing is passed the latest version of the GVL
+     * will be loaded
+     */
+    constructor(versionOrVendorList?: VersionOrVendorList);
+    /**
+     * emptyLanguageCache
+     *
+     * @param {string} [lang] - Optional ISO 639-1 langauge code to remove from
+     * the cache.  Should be one of the languages in GVL.consentLanguages set.
+     * If not then the whole cache will be deleted.
+     * @return {boolean} - true if anything was deleted from the cache
+     */
+    static emptyLanguageCache(lang?: string): boolean;
+    /**
+     * emptyCache
+     *
+     * @param {number} [vendorListVersion] - version of the vendor list to delete
+     * from the cache.  If none is specified then the whole cache is deleted.
+     * @return {boolean} - true if anything was deleted from the cache
+     */
+    static emptyCache(vendorListVersion?: number): boolean;
+    private cacheLanguage;
+    private fetchJson;
+    /**
+     * getJson - Method for getting the JSON that was downloaded to created this
+     * `GVL` object
+     *
+     * @return {VendorList} - The basic JSON structure without the extra
+     * functionality and methods of this class.
+     */
+    getJson(): VendorList;
+    /**
+     * changeLanguage - retrieves the purpose language translation and sets the
+     * internal language variable
+     *
+     * @param {string} lang - ISO 639-1 langauge code to change language to
+     * @return {Promise<void | GVLError>} - returns the `readyPromise` and
+     * resolves when this GVL is populated with the data from the language file.
+     */
+    changeLanguage(lang: string): Promise<void | GVLError>;
+    get language(): string;
+    private isVendorList;
+    private populate;
+    private mapVendors;
+    private getFilteredVendors;
+    /**
+     * getVendorsWithConsentPurpose
+     *
+     * @param {number} purposeId
+     * @return {IntMap<Vendor>} - list of vendors that have declared the consent purpose id
+     */
+    getVendorsWithConsentPurpose(purposeId: number): IntMap<Vendor>;
+    /**
+     * getVendorsWithLegIntPurpose
+     *
+     * @param {number} purposeId
+     * @return {IntMap<Vendor>} - list of vendors that have declared the legInt (Legitimate Interest) purpose id
+     */
+    getVendorsWithLegIntPurpose(purposeId: number): IntMap<Vendor>;
+    /**
+     * getVendorsWithFlexiblePurpose
+     *
+     * @param {number} purposeId
+     * @return {IntMap<Vendor>} - list of vendors that have declared the flexible purpose id
+     */
+    getVendorsWithFlexiblePurpose(purposeId: number): IntMap<Vendor>;
+    /**
+     * getVendorsWithSpecialPurpose
+     *
+     * @param {number} specialPurposeId
+     * @return {IntMap<Vendor>} - list of vendors that have declared the special purpose id
+     */
+    getVendorsWithSpecialPurpose(specialPurposeId: number): IntMap<Vendor>;
+    /**
+     * getVendorsWithFeature
+     *
+     * @param {number} featureId
+     * @return {IntMap<Vendor>} - list of vendors that have declared the feature id
+     */
+    getVendorsWithFeature(featureId: number): IntMap<Vendor>;
+    /**
+     * getVendorsWithSpecialFeature
+     *
+     * @param {number} specialFeatureId
+     * @return {IntMap<Vendor>} - list of vendors that have declared the special feature id
+     */
+    getVendorsWithSpecialFeature(specialFeatureId: number): IntMap<Vendor>;
+    /**
+     * vendors
+     *
+     * @return {IntMap<Vendor>} - the list of vendors as it would on the JSON file
+     * except if `narrowVendorsTo` was called, it would be that narrowed list
+     */
+    get vendors(): IntMap<Vendor>;
+    /**
+     * narrowVendorsTo - narrows vendors represented in this GVL to the list of ids passed in
+     *
+     * @param {number[]} vendorIds - list of ids to narrow this GVL to
+     * @return {void}
+     */
+    narrowVendorsTo(vendorIds: number[]): void;
+    /**
+     * isReady - Whether or not this instance is ready to be used.  This will be
+     * immediately and synchronously true if a vendorlist object is passed into
+     * the constructor or once the JSON vendorllist is retrieved.
+     *
+     * @return {boolean} whether or not the instance is ready to be interacted
+     * with and all the data is populated
+     */
+    get isReady(): boolean;
+    /**
+     * clone - overrides base `clone()` method since GVL is a special class that
+     * represents a JSON structure with some additional functionality.
+     *
+     * @return {GVL}
+     */
+    clone(): GVL;
+    static isInstanceOf(questionableInstance: unknown): questionableInstance is GVL;
+}

package/lib/cjs/GVL.js

@@ -0,0 +1 @@
+"use strict";var __extends=this&&this.__extends||function(){var e=function(t,r){return(e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])})(t,r)};return function(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),__awaiter=this&&this.__awaiter||function(e,t,r,n){return new(r||(r=Promise))((function(s,o){function i(e){try{u(n.next(e))}catch(e){o(e)}}function a(e){try{u(n.throw(e))}catch(e){o(e)}}function u(e){var t;e.done?s(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(i,a)}u((n=n.apply(e,t||[])).next())}))},__generator=this&&this.__generator||function(e,t){var r,n,s,o,i={label:0,sent:function(){if(1&s[0])throw s[1];return s[1]},trys:[],ops:[]};return o={next:a(0),throw:a(1),return:a(2)},"function"==typeof Symbol&&(o[Symbol.iterator]=function(){return this}),o;function a(o){return function(a){return function(o){if(r)throw new TypeError("Generator is already executing.");for(;i;)try{if(r=1,n&&(s=2&o[0]?n.return:o[0]?n.throw||((s=n.return)&&s.call(n),0):n.next)&&!(s=s.call(n,o[1])).done)return s;switch(n=0,s&&(o=[2&o[0],s.value]),o[0]){case 0:case 1:s=o;break;case 4:return i.label++,{value:o[1],done:!1};case 5:i.label++,n=o[1],o=[0];continue;case 7:o=i.ops.pop(),i.trys.pop();continue;default:if(!(s=i.trys,(s=s.length>0&&s[s.length-1])||6!==o[0]&&2!==o[0])){i=0;continue}if(3===o[0]&&(!s||o[1]>s[0]&&o[1]<s[3])){i.label=o[1];break}if(6===o[0]&&i.label<s[1]){i.label=s[1],s=o;break}if(s&&i.label<s[2]){i.label=s[2],i.ops.push(o);break}s[2]&&i.ops.pop(),i.trys.pop();continue}o=t.call(e,i)}catch(e){o=[6,e],n=0}finally{r=s=0}if(5&o[0])throw o[1];return{value:o[0]?o[1]:void 0,done:!0}}([o,a])}}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GVL=void 0;var Cloneable_js_1=require("./Cloneable.js"),index_js_1=require("./errors/index.js"),Json_js_1=require("./Json.js"),index_js_2=require("./model/index.js"),GVL=function(e){function t(r){var n=e.call(this)||this;n.isReady_=!1,n.isLatest=!1;var s=t.baseUrl;if(n.lang_=t.DEFAULT_LANGUAGE,n.isVendorList(r))n.populate(r),n.readyPromise=Promise.resolve();else{if(!s)throw new index_js_1.GVLError("must specify GVL.baseUrl before loading GVL json");if(r>0){var o=r;t.CACHE.has(o)?(n.populate(t.CACHE.get(o)),n.readyPromise=Promise.resolve()):(s+=t.versionedFilename.replace("[VERSION]",String(o)),n.readyPromise=n.fetchJson(s))}else t.CACHE.has(t.LATEST_CACHE_KEY)?(n.populate(t.CACHE.get(t.LATEST_CACHE_KEY)),n.readyPromise=Promise.resolve()):(n.isLatest=!0,n.readyPromise=n.fetchJson(s+t.latestFilename))}return n}return __extends(t,e),Object.defineProperty(t,"baseUrl",{get:function(){return this.baseUrl_},set:function(e){if(/^https?:\/\/vendorlist\.consensu\.org\//.test(e))throw new index_js_1.GVLError("Invalid baseUrl!  You may not pull directly from vendorlist.consensu.org and must provide your own cache");e.length>0&&"/"!==e[e.length-1]&&(e+="/"),this.baseUrl_=e},enumerable:!1,configurable:!0}),t.emptyLanguageCache=function(e){var r=!1;return void 0===e&&t.LANGUAGE_CACHE.size>0?(t.LANGUAGE_CACHE=new Map,r=!0):"string"==typeof e&&this.consentLanguages.has(e.toUpperCase())&&(t.LANGUAGE_CACHE.delete(e.toUpperCase()),r=!0),r},t.emptyCache=function(e){var r=!1;return Number.isInteger(e)&&e>=0?(t.CACHE.delete(e),r=!0):void 0===e&&(t.CACHE=new Map,r=!0),r},t.prototype.cacheLanguage=function(){t.LANGUAGE_CACHE.has(this.lang_)||t.LANGUAGE_CACHE.set(this.lang_,{purposes:this.purposes,specialPurposes:this.specialPurposes,features:this.features,specialFeatures:this.specialFeatures,stacks:this.stacks,dataCategories:this.dataCategories})},t.prototype.fetchJson=function(e){return __awaiter(this,void 0,void 0,(function(){var t,r;return __generator(this,(function(n){switch(n.label){case 0:return n.trys.push([0,2,,3]),t=this.populate,[4,Json_js_1.Json.fetch(e)];case 1:return t.apply(this,[n.sent()]),[3,3];case 2:throw r=n.sent(),new index_js_1.GVLError(r.message);case 3:return[2]}}))}))},t.prototype.getJson=function(){return JSON.parse(JSON.stringify({gvlSpecificationVersion:this.gvlSpecificationVersion,vendorListVersion:this.vendorListVersion,tcfPolicyVersion:this.tcfPolicyVersion,lastUpdated:this.lastUpdated,purposes:this.purposes,specialPurposes:this.specialPurposes,features:this.features,specialFeatures:this.specialFeatures,stacks:this.stacks,dataCategories:this.dataCategories,vendors:this.fullVendorList}))},t.prototype.changeLanguage=function(e){return __awaiter(this,void 0,void 0,(function(){var r,n,s,o,i;return __generator(this,(function(a){switch(a.label){case 0:if(r=e.toUpperCase(),!t.consentLanguages.has(r))return[3,6];if(r===this.lang_)return[3,5];if(this.lang_=r,!t.LANGUAGE_CACHE.has(r))return[3,1];for(s in n=t.LANGUAGE_CACHE.get(r))n.hasOwnProperty(s)&&(this[s]=n[s]);return[3,5];case 1:o=t.baseUrl+t.languageFilename.replace("[LANG]",e),a.label=2;case 2:return a.trys.push([2,4,,5]),[4,this.fetchJson(o)];case 3:return a.sent(),this.cacheLanguage(),[3,5];case 4:throw i=a.sent(),new index_js_1.GVLError("unable to load language: "+i.message);case 5:return[3,7];case 6:throw new index_js_1.GVLError("unsupported language ".concat(e));case 7:return[2]}}))}))},Object.defineProperty(t.prototype,"language",{get:function(){return this.lang_},enumerable:!1,configurable:!0}),t.prototype.isVendorList=function(e){return void 0!==e&&void 0!==e.vendors},t.prototype.populate=function(e){this.purposes=e.purposes,this.specialPurposes=e.specialPurposes,this.features=e.features,this.specialFeatures=e.specialFeatures,this.stacks=e.stacks,this.dataCategories=e.dataCategories,this.isVendorList(e)&&(this.gvlSpecificationVersion=e.gvlSpecificationVersion,this.tcfPolicyVersion=e.tcfPolicyVersion,this.vendorListVersion=e.vendorListVersion,this.lastUpdated=e.lastUpdated,"string"==typeof this.lastUpdated&&(this.lastUpdated=new Date(this.lastUpdated)),this.vendors_=e.vendors,this.fullVendorList=e.vendors,this.mapVendors(),this.isReady_=!0,this.isLatest&&t.CACHE.set(t.LATEST_CACHE_KEY,this.getJson()),t.CACHE.has(this.vendorListVersion)||t.CACHE.set(this.vendorListVersion,this.getJson())),this.cacheLanguage()},t.prototype.mapVendors=function(e){var t=this;this.byPurposeVendorMap={},this.bySpecialPurposeVendorMap={},this.byFeatureVendorMap={},this.bySpecialFeatureVendorMap={},Object.keys(this.purposes).forEach((function(e){t.byPurposeVendorMap[e]={legInt:new Set,consent:new Set,flexible:new Set}})),Object.keys(this.specialPurposes).forEach((function(e){t.bySpecialPurposeVendorMap[e]=new Set})),Object.keys(this.features).forEach((function(e){t.byFeatureVendorMap[e]=new Set})),Object.keys(this.specialFeatures).forEach((function(e){t.bySpecialFeatureVendorMap[e]=new Set})),Array.isArray(e)||(e=Object.keys(this.fullVendorList).map((function(e){return+e}))),this.vendorIds=new Set(e),this.vendors_=e.reduce((function(e,r){var n=t.vendors_[String(r)];return n&&void 0===n.deletedDate&&(n.purposes.forEach((function(e){t.byPurposeVendorMap[String(e)].consent.add(r)})),n.specialPurposes.forEach((function(e){t.bySpecialPurposeVendorMap[String(e)].add(r)})),n.legIntPurposes.forEach((function(e){t.byPurposeVendorMap[String(e)].legInt.add(r)})),n.flexiblePurposes&&n.flexiblePurposes.forEach((function(e){t.byPurposeVendorMap[String(e)].flexible.add(r)})),n.features.forEach((function(e){t.byFeatureVendorMap[String(e)].add(r)})),n.specialFeatures.forEach((function(e){t.bySpecialFeatureVendorMap[String(e)].add(r)})),e[r]=n),e}),{})},t.prototype.getFilteredVendors=function(e,t,r,n){var s=this,o=e.charAt(0).toUpperCase()+e.slice(1),i={};return("purpose"===e&&r?this["by"+o+"VendorMap"][String(t)][r]:this["by"+(n?"Special":"")+o+"VendorMap"][String(t)]).forEach((function(e){i[String(e)]=s.vendors[String(e)]})),i},t.prototype.getVendorsWithConsentPurpose=function(e){return this.getFilteredVendors("purpose",e,"consent")},t.prototype.getVendorsWithLegIntPurpose=function(e){return this.getFilteredVendors("purpose",e,"legInt")},t.prototype.getVendorsWithFlexiblePurpose=function(e){return this.getFilteredVendors("purpose",e,"flexible")},t.prototype.getVendorsWithSpecialPurpose=function(e){return this.getFilteredVendors("purpose",e,void 0,!0)},t.prototype.getVendorsWithFeature=function(e){return this.getFilteredVendors("feature",e)},t.prototype.getVendorsWithSpecialFeature=function(e){return this.getFilteredVendors("feature",e,void 0,!0)},Object.defineProperty(t.prototype,"vendors",{get:function(){return this.vendors_},enumerable:!1,configurable:!0}),t.prototype.narrowVendorsTo=function(e){this.mapVendors(e)},Object.defineProperty(t.prototype,"isReady",{get:function(){return this.isReady_},enumerable:!1,configurable:!0}),t.prototype.clone=function(){var e=new t(this.getJson());return this.lang_!==t.DEFAULT_LANGUAGE&&e.changeLanguage(this.lang_),e},t.isInstanceOf=function(e){return"object"==typeof e&&"function"==typeof e.narrowVendorsTo},t.LANGUAGE_CACHE=new Map,t.CACHE=new Map,t.LATEST_CACHE_KEY=0,t.DEFAULT_LANGUAGE="EN",t.consentLanguages=new index_js_2.ConsentLanguages,t.latestFilename="vendor-list.json",t.versionedFilename="archives/vendor-list-v[VERSION].json",t.languageFilename="purposes-[LANG].json",t}(Cloneable_js_1.Cloneable);exports.GVL=GVL;

package/lib/cjs/Json.d.ts

@@ -0,0 +1,20 @@
+export declare class Json {
+    private static absCall;
+    /**
+     * @static
+     * @param {string} url - full path to POST to
+     * @param {object} body - JSON object to post
+     * @param {boolean} sendCookies - Whether or not to send the XMLHttpRequest with credentials or not
+     * @param {number} [timeout] - optional timeout in milliseconds
+     * @return {Promise<object>} - if the server responds the response will be returned here
+     */
+    static post(url: string, body: object, sendCookies?: boolean, timeout?: number): Promise<object>;
+    /**
+     * @static
+     * @param {string} url - full path to the json
+     * @param {boolean} sendCookies - Whether or not to send the XMLHttpRequest with credentials or not
+     * @param {number} [timeout] - optional timeout in milliseconds
+     * @return {Promise<object>} - resolves with parsed JSON
+     */
+    static fetch(url: string, sendCookies?: boolean, timeout?: number): Promise<object>;
+}

package/lib/cjs/Json.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Json=void 0;var Json=function(){function e(){}return e.absCall=function(e,t,n,r){return new Promise((function(o,s){var i=new XMLHttpRequest;i.withCredentials=n,i.addEventListener("load",(function(){if(i.readyState==XMLHttpRequest.DONE)if(i.status>=200&&i.status<300){var e=i.response;if("string"==typeof e)try{e=JSON.parse(e)}catch(e){}o(e)}else s(new Error("HTTP Status: ".concat(i.status," response type: ").concat(i.responseType)))})),i.addEventListener("error",(function(){s(new Error("error"))})),i.addEventListener("abort",(function(){s(new Error("aborted"))})),null===t?i.open("GET",e,!0):i.open("POST",e,!0),i.responseType="json",i.timeout=r,i.ontimeout=function(){s(new Error("Timeout "+r+"ms "+e))},i.send(t)}))},e.post=function(e,t,n,r){return void 0===n&&(n=!1),void 0===r&&(r=0),this.absCall(e,JSON.stringify(t),n,r)},e.fetch=function(e,t,n){return void 0===t&&(t=!1),void 0===n&&(n=0),this.absCall(e,null,t,n)},e}();exports.Json=Json;

package/lib/cjs/TCModel.d.ts

@@ -0,0 +1,337 @@
+import { Cloneable } from './Cloneable.js';
+import { GVL } from './GVL.js';
+import { ConsentLanguages, IntMap, PurposeRestrictionVector, Vector } from './model/index.js';
+import { Purpose } from './model/gvl/index.js';
+declare type StringOrNumber = number | string;
+export declare type TCModelPropType = number | Date | string | boolean | Vector | PurposeRestrictionVector;
+export declare class TCModel extends Cloneable<TCModel> {
+    /**
+     * Set of available consent languages published by the IAB
+     */
+    static readonly consentLanguages: ConsentLanguages;
+    private isServiceSpecific_;
+    private supportOOB_;
+    private useNonStandardStacks_;
+    private purposeOneTreatment_;
+    private publisherCountryCode_;
+    private version_;
+    private consentScreen_;
+    private policyVersion_;
+    private consentLanguage_;
+    private cmpId_;
+    private cmpVersion_;
+    private vendorListVersion_;
+    private numCustomPurposes_;
+    private gvl_;
+    created: Date;
+    lastUpdated: Date;
+    /**
+     * The TCF designates certain Features as special, that is, a CMP must afford
+     * the user a means to opt in to their use. These Special Features are
+     * published and numbered in the GVL separately from normal Features.
+     * Provides for up to 12 special features.
+     */
+    readonly specialFeatureOptins: Vector;
+    /**
+     * Renamed from `PurposesAllowed` in TCF v1.1
+     * The user’s consent value for each Purpose established on the legal basis
+     * of consent. Purposes are published in the Global Vendor List (see. [[GVL]]).
+     */
+    readonly purposeConsents: Vector;
+    /**
+     * The user’s permission for each Purpose established on the legal basis of
+     * legitimate interest. If the user has exercised right-to-object for a
+     * purpose.
+     */
+    readonly purposeLegitimateInterests: Vector;
+    /**
+     * The user’s consent value for each Purpose established on the legal basis
+     * of consent, for the publisher.  Purposes are published in the Global
+     * Vendor List.
+     */
+    readonly publisherConsents: Vector;
+    /**
+     * The user’s permission for each Purpose established on the legal basis of
+     * legitimate interest.  If the user has exercised right-to-object for a
+     * purpose.
+     */
+    readonly publisherLegitimateInterests: Vector;
+    /**
+     * The user’s consent value for each Purpose established on the legal basis
+     * of consent, for the publisher.  Purposes are published in the Global
+     * Vendor List.
+     */
+    readonly publisherCustomConsents: Vector;
+    /**
+     * The user’s permission for each Purpose established on the legal basis of
+     * legitimate interest.  If the user has exercised right-to-object for a
+     * purpose that is established in the publisher's custom purposes.
+     */
+    readonly publisherCustomLegitimateInterests: Vector;
+    /**
+     * set by a publisher if they wish to collect consent and LI Transparency for
+     * purposes outside of the TCF
+     */
+    customPurposes: IntMap<Purpose>;
+    /**
+     * Each [[Vendor]] is keyed by id. Their consent value is true if it is in
+     * the Vector
+     */
+    readonly vendorConsents: Vector;
+    /**
+     * Each [[Vendor]] is keyed by id. Whether their Legitimate Interests
+     * Disclosures have been established is stored as boolean.
+     * see: [[Vector]]
+     */
+    readonly vendorLegitimateInterests: Vector;
+    /**
+     * The value included for disclosed vendors signals which vendors have been
+     * disclosed to the user in the interface surfaced by the CMP. This section
+     * content is required when writing a TC string to the global (consensu)
+     * scope. When a CMP has read from and is updating a TC string from the
+     * global consensu.org storage, the CMP MUST retain the existing disclosure
+     * information and only add information for vendors that it has disclosed
+     * that had not been disclosed by other CMPs in prior interactions with this
+     * device/user agent.
+     */
+    readonly vendorsDisclosed: Vector;
+    /**
+     * Signals which vendors the publisher permits to use OOB legal bases.
+     */
+    readonly vendorsAllowed: Vector;
+    readonly publisherRestrictions: PurposeRestrictionVector;
+    /**
+     * Constructs the TCModel. Passing a [[GVL]] is optional when constructing
+     * as this TCModel may be constructed from decoding an existing encoded
+     * TCString.
+     *
+     * @param {GVL} [gvl]
+     */
+    constructor(gvl?: GVL);
+    /**
+     * sets the [[GVL]] with side effects of also setting the `vendorListVersion`, `policyVersion`, and `consentLanguage`
+     * @param {GVL} gvl
+     */
+    set gvl(gvl: GVL);
+    /**
+     * @return {GVL} the gvl instance set on this TCModel instance
+     */
+    get gvl(): GVL;
+    /**
+     * @param {number} integer - A unique ID will be assigned to each Consent
+     * Manager Provider (CMP) from the iab.
+     *
+     * @throws {TCModelError} if the value is not an integer greater than 1 as those are not valid.
+     */
+    set cmpId(integer: StringOrNumber);
+    get cmpId(): StringOrNumber;
+    /**
+     * Each change to an operating CMP should receive a
+     * new version number, for logging proof of consent. CmpVersion defined by
+     * each CMP.
+     *
+     * @param {number} integer
+     *
+     * @throws {TCModelError} if the value is not an integer greater than 1 as those are not valid.
+     */
+    set cmpVersion(integer: StringOrNumber);
+    get cmpVersion(): StringOrNumber;
+    /**
+     * The screen number is CMP and CmpVersion
+     * specific, and is for logging proof of consent.(For example, a CMP could
+     * keep records so that a publisher can request information about the context
+     * in which consent was gathered.)
+     *
+     * @param {number} integer
+     *
+     * @throws {TCModelError} if the value is not an integer greater than 0 as those are not valid.
+     */
+    set consentScreen(integer: StringOrNumber);
+    get consentScreen(): StringOrNumber;
+    /**
+     * @param {string} lang - [two-letter ISO 639-1 language
+     * code](http://www.loc.gov/standards/iso639-2/php/code_list.php) in which
+     * the CMP UI was presented
+     *
+     * @throws {TCModelError} if the value is not a length-2 string of alpha characters
+     */
+    set consentLanguage(lang: string);
+    get consentLanguage(): string;
+    /**
+     * @param {string} countryCode - [two-letter ISO 3166-1 alpha-2 country
+     * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the publisher,
+     * determined by the CMP-settings of the publisher.
+     *
+     * @throws {TCModelError} if the value is not a length-2 string of alpha characters
+     */
+    set publisherCountryCode(countryCode: string);
+    get publisherCountryCode(): string;
+    /**
+     * Version of the GVL used to create this TCModel. Global
+     * Vendor List versions will be released periodically.
+     *
+     * @param {number} integer
+     *
+     * @throws {TCModelError} if the value is not an integer greater than 0 as those are not valid.
+     */
+    set vendorListVersion(integer: StringOrNumber);
+    get vendorListVersion(): StringOrNumber;
+    /**
+     * From the corresponding field in the GVL that was
+     * used for obtaining consent. A new policy version invalidates existing
+     * strings and requires CMPs to re-establish transparency and consent from
+     * users.
+     *
+     * If a TCF policy version number is different from the one from the latest
+     * GVL, the CMP must re-establish transparency and consent.
+     *
+     * @param {number} num - You do not need to set this.  This comes
+     * directly from the [[GVL]].
+     *
+     */
+    set policyVersion(num: StringOrNumber);
+    get policyVersion(): StringOrNumber;
+    set version(num: StringOrNumber);
+    get version(): StringOrNumber;
+    /**
+     * Whether the signals encoded in this TC String were from site-specific
+     * storage `true` versus ‘global’ consensu.org shared storage `false`. A
+     * string intended to be stored in global/shared scope but the CMP is unable
+     * to store due to a user agent not accepting third-party cookies would be
+     * considered site-specific `true`.
+     *
+     * @param {boolean} bool - value to set. Some changes to other fields in this
+     * model will automatically change this value like adding publisher
+     * restrictions.
+     */
+    set isServiceSpecific(bool: boolean);
+    get isServiceSpecific(): boolean;
+    /**
+     * Non-standard stacks means that a CMP is using publisher-customized stack
+     * descriptions. Stacks (in terms of purposes in a stack) are pre-set by the
+     * IAB. As are titles. Descriptions are pre-set, but publishers can customize
+     * them. If they do, they need to set this bit to indicate that they've
+     * customized descriptions.
+     *
+     * @param {boolean} bool - value to set
+     */
+    set useNonStandardStacks(bool: boolean);
+    get useNonStandardStacks(): boolean;
+    /**
+     * Whether or not this publisher supports OOB signaling.  On Global TC String
+     * OOB Vendors Disclosed will be included if the publish wishes to no allow
+     * these vendors they should set this to false.
+     * @param {boolean} bool - value to set
+     */
+    set supportOOB(bool: boolean);
+    get supportOOB(): boolean;
+    /**
+     * `false` There is no special Purpose 1 status.
+     * Purpose 1 was disclosed normally (consent) as expected by Policy.  `true`
+     * Purpose 1 not disclosed at all. CMPs use PublisherCC to indicate the
+     * publisher’s country of establishment to help Vendors determine whether the
+     * vendor requires Purpose 1 consent. In global scope TC strings, this field
+     * must always have a value of `false`. When a CMP encounters a global scope
+     * string with `purposeOneTreatment=true` then that string should be
+     * considered invalid and the CMP must re-establish transparency and consent.
+     *
+     * @param {boolean} bool
+     */
+    set purposeOneTreatment(bool: boolean);
+    get purposeOneTreatment(): boolean;
+    /**
+     * setAllVendorConsents - sets all vendors on the GVL Consent (true)
+     *
+     * @return {void}
+     */
+    setAllVendorConsents(): void;
+    /**
+     * unsetAllVendorConsents - unsets all vendors on the GVL Consent (false)
+     *
+     * @return {void}
+     */
+    unsetAllVendorConsents(): void;
+    /**
+     * setAllVendorsDisclosed - sets all vendors on the GVL Vendors Disclosed (true)
+     *
+     * @return {void}
+     */
+    setAllVendorsDisclosed(): void;
+    /**
+     * unsetAllVendorsDisclosed - unsets all vendors on the GVL Consent (false)
+     *
+     * @return {void}
+     */
+    unsetAllVendorsDisclosed(): void;
+    /**
+     * setAllVendorsAllowed - sets all vendors on the GVL Consent (true)
+     *
+     * @return {void}
+     */
+    setAllVendorsAllowed(): void;
+    /**
+     * unsetAllVendorsAllowed - unsets all vendors on the GVL Consent (false)
+     *
+     * @return {void}
+     */
+    unsetAllVendorsAllowed(): void;
+    /**
+     * setAllVendorLegitimateInterests - sets all vendors on the GVL LegitimateInterests (true)
+     *
+     * @return {void}
+     */
+    setAllVendorLegitimateInterests(): void;
+    /**
+     * unsetAllVendorLegitimateInterests - unsets all vendors on the GVL LegitimateInterests (false)
+     *
+     * @return {void}
+     */
+    unsetAllVendorLegitimateInterests(): void;
+    /**
+     * setAllPurposeConsents - sets all purposes on the GVL Consent (true)
+     *
+     * @return {void}
+     */
+    setAllPurposeConsents(): void;
+    /**
+     * unsetAllPurposeConsents - unsets all purposes on the GVL Consent (false)
+     *
+     * @return {void}
+     */
+    unsetAllPurposeConsents(): void;
+    /**
+     * setAllPurposeLegitimateInterests - sets all purposes on the GVL LI Transparency (true)
+     *
+     * @return {void}
+     */
+    setAllPurposeLegitimateInterests(): void;
+    /**
+     * unsetAllPurposeLegitimateInterests - unsets all purposes on the GVL LI Transparency (false)
+     *
+     * @return {void}
+     */
+    unsetAllPurposeLegitimateInterests(): void;
+    /**
+     * setAllSpecialFeatureOptins - sets all special featuresOptins on the GVL (true)
+     *
+     * @return {void}
+     */
+    setAllSpecialFeatureOptins(): void;
+    /**
+     * unsetAllSpecialFeatureOptins - unsets all special featuresOptins on the GVL (true)
+     *
+     * @return {void}
+     */
+    unsetAllSpecialFeatureOptins(): void;
+    setAll(): void;
+    unsetAll(): void;
+    get numCustomPurposes(): StringOrNumber;
+    set numCustomPurposes(num: StringOrNumber);
+    /**
+     * updated - updates the created and lastUpdated dates with a 'now' day-level UTC timestamp
+     *
+     * @return {void}
+     */
+    updated(): void;
+}
+export {};