Repository files navigation

• About
• Features
• Technical features
• Configuration
• Usage
• CMP version
• License

Boros CMP is a stand alone Consent Management Provider solution compliant with the "Transparency & Consent Framework" standard established by theIAB Europe.

Boros CMP is registered with ID 129

• Open Source project
• Supports theIAB specification
• Supports consent management for a single site or multiple sites from a single brand
• Stand alone project (without User Interface). We also developed aUser Interface and abundle project including UI + CMP
• Have a look at ourCMP Showcase and try Boros

• Importable as a library from NPM.
• Developed in Javascript (ECMAScript 6) using Promises and Events
• We ❤️ Domain Driven Design
• Supports local storage using single site cookie
• Supports global storage using multi site cookie via iFrames

Boros CMP is available asnpm package named@adv-ui/boros-cmp.

To install the last stable version:

npm install --save @adv-ui/boros-cmp

To initialize Boros CMP usingdefault configuration values:

importboroscmpfrom'@adv-ui/boros-cmp'boroscmp.init().then(()=>{// do your stuff ...})

To initialize Boros CMP using customized configuration values:

importboroscmpfrom'@adv-ui/boros-cmp'constcustomConfig={gdpr:{gdprApplies:true,storeConsentGlobally:false},consent:{consentScreen:1,consentLanguage:'es'}}boroscmp.init({config:customConfig}).then(()=>{// do your stuff ...})

Notice thatinit method is returning aPromise but you can subscribe tocmpReady event instead:

importboroscmpfrom'@adv-ui/boros-cmp'window.document.addEventListener("cmpReady",(event)=>{// do your stuff ...// like calling window.__cmp( ...})boroscmp.init()

You could also import directly the library instead the bundled version. By using this, it will assume you're providing the @babel/runtime dependency, helpers and polyfills needed to get it working but it will give you a better size by reusing your packages.

importboroscmpfrom'@adv-ui/boros-cmp/lib'boroscmp.init().then(()=>{// do your stuff ...})

Boros should be initialized with at least this custom configuration

importboroscmpfrom'@adv-ui/boros-cmp'constcustomConfig={gdpr:{storeConsentGlobally:true,globalConsentLocation:'http://local.schibsted.io:8000/index.html'}}boroscmp.init({config:customConfig}).then(()=>{// do your stuff ...})

In the globalConsentLocation provided, a server should be running and it should have the boros script builded for global version on it (global.dev.js or global.pro.js).

There are some default configuration values that can be overwritten before CMP is loaded. Following you will find all the configuration properties and their default values.

Defines if GDPR applies or not.

Defines if Consent Storage is Global (true) or Local (false).

The source URL of global storage html.

Defines the Screen number in the CMP where consent was given. The screen number is CMP and CmpVersion specific, and is for logging proof of consent

This language will be used by the User interface using CMP. Language values areISO 639-1 (2 letter codes).By default,es will be used.

Check the available translations here:https://register.consensu.org/Translation

To find Vendor lists, CMP tries to retrieve a JSON namedvendorlist.json and uses the IAB version structure, as follows:

• Latest Vendor list:https://vendorlist.consensu.org/vendorlist.json
• Specific Vendor list version:https://vendorlist.consensu.org/v-${vendorListVersion}/vendorlist.json
  • where${vendorListVersion} is the specific version to retrieve. For example:https://vendorlist.consensu.org/v-2/vendorlist.json

Available log level values:

CMP version is set according to the version defined inside thepackage.json file. IAB standard uses only one number to define this version, so only the major version (first digit) will be used.

CMP isMIT licensed.