bv-ui-core 2.5.0 → 2.6.0

package/README.md

@@ -40,6 +40,7 @@ module's directory.
 - [body](./lib/body)
 - [checkHighContrast](./lib/checkHighContrast)
 - [cookie](./lib/cookie)
+- [cookieConsent](./lib/cookieConsent)
 - [cssLoadChecker](./lib/cssLoadChecker)
 - [date.now](./lib/date.now)
 - [domainPolice](./lib/domainPolice)

package/lib/cookie/README.md

@@ -5,12 +5,12 @@ The cookie module provides methods for interacting with browser cookies.
 ```js
 var cookie = require('bv-ui-core/lib/cookie');
 
-cookie.write('RememberMe', '1', 365);
+cookie.create('RememberMe', '1', 365);
 console.log(cookie.read('RememberMe')); // '1'
 cookie.remove('RememberMe');
 ```
 
-The following methods are provided:
+## The following methods are provided:
 
 - `read(name)`: Read the cookie with the given name.
 - `create(name, value, [days, domain, secure])`: Write a cookie with the given
@@ -19,3 +19,11 @@ The following methods are provided:
   by passing `true` as the `secure` argument. Note that if one optional
   argument is provided, all previous arguments must be provided as well.
 - `remove(name)`: Delete the cookie with the given name.
+
+## Usage with `cookieConsent`:
+
+- Call `cookieConsent.initConsent` before calling `cookie.create`.
+- Cookies will get created only if the consent for that cookie is true.
+- Each cookie will automatically subscribe to `enable` and `disable` consent events for that cookie.
+- Cookie will get set when consent is `true`.
+- Cookie will get removed when consent is `false`.

package/lib/cookie/index.js

@@ -55,16 +55,21 @@ function readCookie (name) {
     }
   }
 
-  return store[name] || null;
+  return null;
 }
 /**
  * Remove a cookie.
  *
  * @param {String} name The cookie name.
  */
-function removeCookie (name) {
+function removeCookie (name, domain) {
   delete store[name];
-  createCookie(name, '', -1);
+  if (domain) {
+    createCookie(name, null, -1, domain);
+  }
+  else {
+    createCookie(name, '', -1);
+  }
 }
 
 module.exports = {
@@ -74,13 +79,21 @@ module.exports = {
     if (consentPresent) {
       createCookie(name, value, days, domain, secure);
     }
+    cookieConsent.subscribe(name,'add',function (consent) {
+      if (consent) {
+        createCookie(name,value,days,domain,secure);
+      } 
+      else { 
+        removeCookie(name,domain)
+      }     
+    })
 
     cookieConsent.subscribe(name, 'enable', function () {
       createCookie(name, value, days, domain, secure);
     });
 
     cookieConsent.subscribe(name, 'disable', function () {
-      removeCookie(name);
+      removeCookie(name, domain);
     });
   },
   read: readCookie,

package/lib/cookieConsent/README.md

@@ -5,10 +5,14 @@ The cookieConsent module provides methods for controlling cookie consents.
 ```js
 var cookieConsent = require('bv-ui-core/lib/cookieConsent');
 // Initialize
+/**
+ * 2nd parameter is to disable/enable consent mechanism.
+ * Passing true will disable the consent mechanism.
+*/
 cookieConsent.initConsent({
   cookie1: false,
   cookie2: true
-});
+}, false);
 
 // Set cookie consent
 cookieConsent.setConsent({ cookie1: true });
@@ -22,9 +26,16 @@ cookieConsent.subscribe('cookie3', 'add', function (data) {});
 // Subscribe to consent 'enable' event. Triggers when a cookie consent is set to true
 cookieConsent.subscribe('cookie3', 'enable', function (data) {});
 
+// Valid events that can be subscribed to are 'add', 'enable', 'disable', and 'change'
 // Subscribe to consent 'disable' event. Triggers when a cookie consent is set to false
 var event = cookieConsent.subscribe('cookie3', 'disable', function (data) {});
 
+// Subscribe to the store change event. The latest consent store object is passed as parameter to the callback function
+var event = subscribeToConsentStore(function (store){});
+
 // Unsubscribe events
 event.unsubscribe();
+
+// Get cookie consent disabled/enabled value.
+cookieConsent.getConsentDisabled();
 ```

package/lib/cookieConsent/index.js

@@ -1,8 +1,12 @@
 var cookieConsent = (function () {
   var init = false;
+  var consentDisabled = true;
   var store = {};
   var subscribers = {};
-  var events = ['add', 'enable', 'disable'];
+  var events = ['add', 'enable', 'disable', 'change'];
+  var storeCallbacks = {};
+
+
   /**
    * _publish: Calls subscriber callbacks
    * @param {String} consentKey Consent key
@@ -16,6 +20,18 @@ var cookieConsent = (function () {
       })
     }
   }
+
+  /**
+   * _publishStore: calls Callbacks with the store object passed
+   */
+
+  function _publishStore () {
+    if (Object.values(storeCallbacks).length > 0) {
+      Object.values(storeCallbacks).forEach(function (callback) {
+        callback(Object.assign({}, store));
+      })
+    }
+  }
   /**
    * _set: Set store data
    * @param {String} consentKey Consent key
@@ -36,9 +52,14 @@ var cookieConsent = (function () {
       }
       if (oldValue === true) {
         _publish(consentKey, 'disable', consentValue);
+        _publish(consentKey, 'change', consentValue);
       }
-      else {
+      else if (oldValue === false) {
         _publish(consentKey, 'enable', consentValue);
+        _publish(consentKey, 'change', consentValue);
+      }
+      else {
+        _publish(consentKey, 'change', consentValue);
       }
     }
   }
@@ -50,13 +71,37 @@ var cookieConsent = (function () {
       delete subscribers[this.consentKey][this.eventName][this.key];
     }
   }
+
+  /**
+   * _unsubscribeStore: Unsubscribes subscribers from the consent store 
+   */
+  function _unsubscribeStore () {
+    if (storeCallbacks[this.key]) {
+      delete storeCallbacks[this.key];
+    }
+  }
+  /**
+   * Get consent disabled
+   * @returns Boolean
+   */
+  function getConsentDisabled () {
+    return consentDisabled
+  }
   /**
    * initConsent: Initialize the consent store
    * @param {Object} consent Consent object
+   * @param {Boolean} disable Disable consent
    * @returns Boolean
    */
-  function initConsent (consent) {
+  function initConsent (consent, disable) {
     if (!init) {
+      consentDisabled = !!disable;
+
+      if (consentDisabled) {
+        init = true;
+        return true;
+      }
+
       if (!(consent && !Array.isArray(consent) && typeof consent === 'object')) {
         throw new TypeError('cookieConsent (init): consent should be an object.');
       }
@@ -82,6 +127,10 @@ var cookieConsent = (function () {
    * @returns Boolean or Undefined
    */
   function getConsent (consentKey) {
+    if (consentDisabled) {
+      return true;
+    }
+
     return store[consentKey];
   }
   /**
@@ -90,14 +139,19 @@ var cookieConsent = (function () {
    * @returns Boolean
    */
   function setConsent (consent) {
-    if (init) {
+    if (init && !consentDisabled) {
       if (!(consent && !Array.isArray(consent) && typeof consent === 'object')) {
         throw new TypeError('cookieConsent (setConsent): consent should be an object.')
       }
+      var store 
       var keys = Object.keys(consent);
       for (var i = 0; i < keys.length; i++) {
         _set(keys[i], consent[keys[i]]);
       }
+      var storeCopy=Object.assign({},store)
+      if (JSON.stringify(storeCopy)!==JSON.stringify(store)) {
+        _publishStore()
+      }
       return true;
     }
 
@@ -147,11 +201,26 @@ var cookieConsent = (function () {
     };
   }
 
+  function subscribeToConsentStore (callback) {
+    if (typeof callback !== 'function') {
+      throw new TypeError('cookieConsent (subscribeToConsentStore): callback should be a function.');
+    }
+
+    var key = Math.random().toString(36).substr(2, 5);
+    storeCallbacks[key] = callback;
+
+    return {
+      unsubscribe: _unsubscribeStore.bind({ key: key })
+    }
+  }
+
   return {
     initConsent: initConsent,
     getConsent: getConsent,
+    getConsentDisabled: getConsentDisabled,
     setConsent: setConsent,
-    subscribe: subscribe
+    subscribe: subscribe,
+    subscribeToConsentStore: subscribeToConsentStore
   };
 })();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bv-ui-core",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "license": "Apache 2.0",
   "description": "Bazaarvoice UI-related JavaScript",
   "repository": {

package/test/unit/cookieConsent/index.spec.js

@@ -72,7 +72,7 @@ describe('lib/cookieConsent', function () {
       cookieConsent.subscribe('key1', 'delete', null);
     }
 
-    var events = ['add', 'enable', 'disable'];
+    var events = ['add', 'enable', 'disable', 'change'];
     expect(test3).to.throw(TypeError, 'cookieConsent (subscribe): event name should be one of ' + events.join(', ') + '.');
 
     function test4 () {
@@ -84,7 +84,36 @@ describe('lib/cookieConsent', function () {
     function test5 () {
       return cookieConsent.subscribe('key1', 'enable', function () {});
     }
-
     expect(test5()).to.be.an('object');
   });
+  it('cookieConsent.subscribeToConsentStore', function () {
+    // Error checks - Correct errors are thrown
+    function test6 () {
+      cookieConsent.subscribeToConsentStore('Callback')
+    }
+    expect(test6).to.throw(TypeError,'cookieConsent (subscribeToConsentStore): callback should be a function.');
+    // Subscriber creation test - The subscription gets created correctly
+    function test7 () {
+      return cookieConsent.subscribeToConsentStore(function () {});
+    }
+    expect(test7()).to.be.an('object');
+
+    // Event listener test - The subscriber callback fires on store change
+    var fn = sinon.spy()
+    function test8 () {
+      cookieConsent.subscribeToConsentStore(fn)
+      cookieConsent.setConsent({ cookie4: true })
+    }
+    test8 ()
+    sinon.assert.calledOnce(fn)
+    // Unsubscribe test - Should be able to unsubscribe successfully (Should not fire the callback after unsubscription)
+    var fn2 = sinon.spy()
+    function test9 () {
+      var event = cookieConsent.subscribeToConsentStore(fn2)
+      event.unsubscribe()
+      cookieConsent.setConsent({ cookie5: true })
+    } 
+    test9()
+    sinon.assert.notCalled(fn2)
+  });
 });