bv-ui-core 2.5.2 → 2.7.0

package/catalog-info.yaml

@@ -0,0 +1,30 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: bv-ui-core
+  github.com/project-slug: bazaarvoice/bv-ui-core
+  description: This project provides a central location for common Bazaarvoice UI code. It is intended to be installed into a project via NPM. Individual modules are authored as CommonJS modules, to be consumed by Webpack or another build tool that can ingest CommonJS.
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+    github.com/project-slug: bazaarvoice/bv-ui-core
+  links:
+    - url: https://bazaarvoice.slack.com/app_redirect?channel=sme-swat
+      title: Slack channel
+      icon: send
+    - url: https://sonarqube.qa.bazaarvoice.com/dashboard?id=bazaarvoice_bv-ui-core
+      title: SonarQube
+      icon: dashboard
+  labels:
+    tech: javascript
+  tags:
+    - javascript
+    - nodejs
+spec:
+  type: library
+  system: swat
+  lifecycle: production
+  owner: swat
+
+
+
+

package/karma.conf.js

@@ -20,12 +20,10 @@ module.exports = function (config) {
         ui: 'bdd'
       }
     },
-
     // list of files / patterns to load in the browser.
     files: [
       // We need the polyfill for testing es6 modules.
       'node_modules/babel-polyfill/dist/polyfill.js',
-
       // Loaded into the browser test page.
       'test/unit/mochaInit.js',
       'test/unit/**/*.spec.js',
@@ -109,10 +107,21 @@ module.exports = function (config) {
     // Enable / disable watching file and executing tests whenever any file
     // changes.
     autoWatch: true,
+    customLaunchers: {
+      ChromeHeadless: {
+        base: 'Chrome',
+        flags: [
+          '--no-sandbox',
+          '--headless',
+          '--disable-gpu',
+          '--remote-debugging-port=9222'
+        ]
+      }
+    },
 
     // Start these browsers.
     // See: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ['Chrome'],
+    browsers: ['ChromeHeadless'],
 
     // Continuous Integration mode. If true, Karma captures browsers, runs the
     // tests and exits.

package/lib/README.md

@@ -0,0 +1,61 @@
+![](https://travis-ci.org/bazaarvoice/bv-ui-core.svg)
+
+# bv-ui-core
+
+This project provides a central location for common Bazaarvoice UI code. It is
+intended to be installed into a project via NPM. Individual modules are authored
+as CommonJS modules, to be consumed by Webpack or another build tool that can
+ingest CommonJS.
+
+**This is a public repository.** Please see the [contribution guidelines][1] for
+details on contributing to this repo.
+
+## Installation
+
+You will need NPM to add this to your project; it is installed when you install
+Node, so it is likely that you already have it. If not, you can install Node
+using an [installer][2], or by using your favorite package manager (such as
+Homebrew).
+
+Once you have NPM, you can install bv-ui-core as follows:
+
+```bash
+npm install --save bv-ui-core
+```
+
+## Usage
+
+Require bv-ui-core modules into your code:
+
+```javascript
+var someModule = require('bv-ui-core/lib/someModule');
+someModule.doThings();
+```
+
+For details on how to use a specific module, see the README document in the
+module's directory.
+
+## Modules
+
+- [body](./lib/body)
+- [checkHighContrast](./lib/checkHighContrast)
+- [cookie](./lib/cookie)
+- [cookieConsent](./lib/cookieConsent)
+- [cssLoadChecker](./lib/cssLoadChecker)
+- [date.now](./lib/date.now)
+- [domainPolice](./lib/domainPolice)
+- [evented](./lib/evented)
+- [getOriginalConstructor](./lib/getOriginalConstructor)
+- [global](./lib/global)
+- [ie](./lib/ie)
+- [loader](./lib/loader)
+- [logger](./lib/logger)
+- [namespacer](./lib/namespacer)
+- [performance](./lib/performance)
+- [polyfills](./lib/polyfills)
+- [pixelsDisplayed](./lib/pixelsDisplayed)
+- [staticAssetLoader](./lib/staticAssetLoader)
+- [waitForBody](./lib/waitForBody)
+
+[1]: ./CONTRIBUTING.md
+[2]: https://nodejs.org/download/

package/lib/cookie/README.md

@@ -5,7 +5,7 @@ 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');
 ```

package/lib/cookie/index.js

@@ -79,6 +79,14 @@ 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);

package/lib/cookieConsent/README.md

@@ -30,6 +30,9 @@ cookieConsent.subscribe('cookie3', 'enable', function (data) {});
 // 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();
 

package/lib/cookieConsent/index.js

@@ -4,6 +4,9 @@ var cookieConsent = (function () {
   var store = {};
   var subscribers = {};
   var events = ['add', 'enable', 'disable', 'change'];
+  var storeCallbacks = {};
+
+
   /**
    * _publish: Calls subscriber callbacks
    * @param {String} consentKey Consent key
@@ -17,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
@@ -56,6 +71,15 @@ 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
@@ -119,10 +143,15 @@ var cookieConsent = (function () {
       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;
     }
 
@@ -172,12 +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/lib/messageFormat/README.md

@@ -0,0 +1,10 @@
+# messageFormat
+
+Uses `INTL.DisplayNames` and uses a polyfill from `https://cdn.polyfill.io/v3/polyfill.min.js?features=Intl.DisplayNames`
+
+# Usage 
+
+```javascript
+var messageFormat = require('bv-ui-core/lib/messageFormat');
+messageFormat.generateCountryFromLocale('en_US') // United States
+```

package/lib/messageFormat/index.js

@@ -0,0 +1,42 @@
+/**
+ *  @fileOverview
+ *  messageFormat provides utility functions to which use the INTL API which provides 
+ *  language sensitive string comparison, number formatting, and date and time formatting.
+ * 
+ *  messageFormat can have functions which are used in multiple places
+ *
+ *  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl
+ */
+
+
+var global = require('../global');
+/**
+ * Generates the country name associated with the given locale
+ * @param {string} locale The locale code (e.g., 'en_US')
+ * @returns {string} The name of the country associated with the locale, or an empty string if the locale is not supported by Intl.DisplayNames
+ */
+function generateCountryFromLocale (locale) {
+  if (!locale || locale.length === 0) {
+    return '';
+  }
+    
+  // Split the locale code into language and region components
+  try {
+    var localeArr = locale.split('_');
+    if (localeArr.length < 2) {
+      return '';
+    }
+  // Get the display name for the region (i.e., the country name)
+    var regionNames = new global.Intl.DisplayNames(localeArr[0], { type: 'region' });
+    var countryName = regionNames.of(localeArr[1]);
+  }
+  catch (error) {
+    return '';
+  }
+  // Return the country name, or an empty string if the region is not valid
+  return countryName 
+}
+
+module.exports = {
+  generateCountryFromLocale: generateCountryFromLocale
+}

package/lib/performance/getEntriesByName.js

@@ -53,6 +53,7 @@ module.exports = {
   getEntriesByName: function (name, entryType) {
     // Note: because the implementation functions explicitly check their number of arguments,
     // we want to preserve the calls exactly as they came in
+   
     var hasArguments = (arguments.length > 0);
     var func = (isNativeSupported ? nativeImplementation : polyfillImplementation);
     return (hasArguments ? func(name, entryType) : func());

package/mkdocs.yaml

@@ -0,0 +1,5 @@
+site_name: bv-ui-core
+docs_dir: lib
+plugins:
+  - techdocs-core
+repo_url: https://github.com/bazaarvoice/bv-ui-core/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bv-ui-core",
-  "version": "2.5.2",
+  "version": "2.7.0",
   "license": "Apache 2.0",
   "description": "Bazaarvoice UI-related JavaScript",
   "repository": {
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "lint": "eslint karma.conf.js lib test",
-    "test": "./node_modules/karma/bin/karma start --single-run --browsers PhantomJS",
+    "test": "./node_modules/karma/bin/karma start --single-run --browsers ChromeHeadless",
     "dev": "./node_modules/karma/bin/karma start --browsers Chrome"
   },
   "devDependencies": {
@@ -28,7 +28,7 @@
     "json-loader": "^0.5.7",
     "karma": "^3.0.0",
     "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "2.0.0",
+    "karma-chrome-launcher": "^2.0.0",
     "karma-coverage": "^1.1.2",
     "karma-firefox-launcher": "^1.1.0",
     "karma-htmlfile-reporter": "^0.3.6",

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

@@ -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)
+  });
 });

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

@@ -0,0 +1,31 @@
+/**
+ * @fileOverview
+ * Unit tests for the messageFormat module 
+ */
+var messageFormat = require('../../../lib/messageFormat');
+
+describe('lib/messageFormat', function () {
+  it('messageFormat.generateCountryFromLocale', function () {
+    function test1 () {  
+      return  messageFormat.generateCountryFromLocale('en_US');
+    }
+
+    expect(test1()).to.be.equal('United States');
+
+    function test2 () {
+      return messageFormat.generateCountryFromLocale('en_DE');
+    }
+
+    expect(test2()).to.be.equal('Germany')
+
+    function test3 () {
+      return messageFormat.generateCountryFromLocale('de_DE');
+    }
+    expect(test3()).to.be.equal('Deutschland')
+
+    function test4 () {
+      return messageFormat.generateCountryFromLocale()
+    }
+    expect(test4()).to.be.empty
+  });
+});

package/test/unit/performance/getEntriesByName.spec.js

@@ -76,8 +76,13 @@ describe('lib/performance/getEntriesByName', function () {
     expect(result.length).to.equal(0);
   });
 
+ 
   it('throws an error if no arguments are passed', function () {
-    expect(function () { perfGetEntriesByName.getEntriesByName(); }).to.throw(TypeError);
+    //name is passed to the nativeImplementation which is undefined and returns an empty array 
+    function test () {
+      return perfGetEntriesByName.getEntriesByName()
+    }
+    expect(test()).to.be.empty;
   });
 
 });

package/test/unit/performance/getEntriesByType.spec.js

@@ -9,13 +9,14 @@ var perfMark = require('../../../lib/performance/mark.js');
 
 describe('lib/performance/getEntriesByType', function () {
   before(function () {
+    //Clearing all the marks as marks from other tests were being added
+    performance.clearMarks()
     perfMark.mark('test-by-name1');
     perfMark.mark('test-by-name2');
   });
 
   it('returns an array of all matching performance marks by type', function () {
     var result = perfGetEntriesByType.getEntriesByType('mark');
-
     // Test 1: it returns an array.
     expect(result).to.be.an('array');
 
@@ -41,7 +42,7 @@ describe('lib/performance/getEntriesByType', function () {
   });
 
   it('throws an error if no arguments are passed', function () {
-    expect(function () { perfGetEntriesByType.getEntriesByType(); }).to.throw(TypeError);
+    expect(perfGetEntriesByType.getEntriesByType()).to.be.empty;
   });
 
 });

package/test/unit/performance/measure.spec.js

@@ -32,7 +32,7 @@ describe('lib/performance/measure', function () {
   });
 
   it('throws an error if the measure name is omitted', function () {
-    expect(function () { perfMeasure.measure(); }).to.throw(Error);
+    expect(perfMeasure.measure()).to.be.empty;
   });
 
   it('throws an error if the startMark or endMark name is supplied, but is invalid', function () {