bv-ui-core 0.1.1

package/.eslintrc

@@ -0,0 +1,40 @@
+{
+  "env": {
+    "node": true,
+    "browser": true,
+    "es6": true
+  },
+  "rules": {
+    "brace-style": [2, "stroustrup", { "allowSingleLine": true }],
+    "consistent-return": 0,
+    "curly": 2,
+    "eqeqeq": 2,
+    "indent": [2, 2, { "SwitchCase": 1 }],
+    "key-spacing": [2, {
+      "beforeColon": false,
+      "afterColon": true
+    }],
+    "keyword-spacing": [2, {"before": true, "after": true, "overrides": {}}],
+    "no-multiple-empty-lines": 2,
+    "no-throw-literal": 2,
+    "no-underscore-dangle": 0,
+    "no-unused-vars": [2, {
+      "vars": "all",
+      "args": "none"
+    }],
+    "no-use-before-define": [2, "nofunc"],
+    "object-curly-spacing": [2, "always"],
+    "quote-props": [2, "as-needed"],
+    "quotes": [2, "single"],
+    "radix": 2,
+    "space-before-blocks": [2, "always"],
+    "space-before-function-paren": [2, "always"],
+    "space-in-parens": [2, "never"],
+    "space-unary-ops": [2, {
+      "words": true,
+      "nonwords": false
+    }],
+    "strict": [2, "never"],
+    "wrap-iife": [2, "inside"]
+  }
+}

package/.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "10"
+install:
+  - npm install

package/CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contributing to bv-ui-core
+
+## Owners
+
+- Reason (@reason-bv)
+- Dan Heberden (@danheberden)
+
+## Getting Started
+
+Start by creating a fork of this repo, cloning it locally, and installing the required Node modules:
+
+```sh
+git clone git@github.com:<yourusername>/bv-ui-core.git
+cd bv-ui-core
+npm install
+```
+
+Verify the installation by running `npm run dev`. This should open Chrome to the test page; you will need to open the browser's console to see the test results.
+
+If you would like to submit a change to the repo, open a pull request *from a branch on your fork*. Do not create new branches on the main repo.
+
+## Adding New Modules
+
+If you want to submit a new module, be certain to open an issue explaining the rationale for adding the module, as well as the proposed API for the module. **Please do not start the discussion with a pull request.**
+
+Given that the modules in this repo are intended for use in user interfaces, please be extremely mindful of adding dependencies. Wherever possible, a module should allow dependencies to be passed to it as arguments:
+
+```js
+module.exports = function myModule ($) {
+    return {
+        awesome: function (arg) {
+            return $(arg);
+        }
+    };
+};
+```
+
+## File Structure
+
+For a module `foo`, *at least* the following files should exist:
+
+- `lib/foo/index.js`
+- `lib/foo/README.md`
+- `test/unit/foo/index.js`
+
+## Commit Hooks
+
+This project uses [ghooks](https://github.com/gtramontina/ghooks) to manage Git hooks. The hooks run linting before each commit, and run the tests before each push.
+
+## Style
+
+The coding style for this project is checked with [ESLint](http://eslint.org/), and defined by the .eslintrc file. To run ESLint:
+
+```
+npm run lint
+```
+
+If you see no output, no problems were found.
+
+## Tests
+
+This project uses [tape](https://github.com/substack/tape). To run the tests:
+
+```bash
+npm test
+```
+
+To run the tests in a browser while you are doing development:
+
+```bash
+npm run dev
+```
+
+Note that the results appear in the console, not in the browser itself.
+
+## Local Development with Another Project
+
+If you are working on this project alongside a project that uses it, you will likely want to use [`npm link`][npm-link]. It allows you to install an NPM package in your project from the local file system, rather than pulling the package down from NPM.
+
+Assuming that you've checked out `bv-ui-core` to `~/code/bv-ui-core` and your project is at `~/code/my-project`, you can run the following commands in the shell to get your project to use the local bv-ui-core:
+
+```bash
+cd ~/code/bv-ui-core
+npm link
+cd ~/code/my-project
+npm link bv-ui-core
+```
+
+Alternatively, you can combine the two steps into one:
+
+```bash
+cd ~/code/my-project
+npm link ../bv-ui-core
+```
+
+See the [`npm link` documentation][npm-link] for more details.
+
+[npm-link]: https://docs.npmjs.com/cli/link

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2015 Bazaarvoice, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/OWNERS

@@ -0,0 +1,2 @@
+# Owning team.
+firebird-devs@bazaarvoice.com

package/README.md

@@ -0,0 +1,63 @@
+![](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)
+- [bvFetch](./lib/bvFetch/)
+- [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)
+- [queryShadowDom](./lib/queryShadowDom)
+
+[1]: ./CONTRIBUTING.md
+[2]: https://nodejs.org/download/

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

@@ -0,0 +1,130 @@
+/**
+ * @fileOverview
+ * Karma configuration.
+ */
+
+module.exports = function (config) {
+  config.set({
+
+    // Base path that will be used to resolve all patterns (eg. files, exclude).
+    basePath: '',
+
+    // Frameworks to use.
+    // See: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['mocha', 'chai', 'sinon-chai'],
+
+    client: {
+      mocha: {
+        // Change Karma's debug.html to the mocha web reporter.
+        reporter: 'html',
+        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',
+
+      // Made available but not loaded. Note that the path for loading these
+      // files is prefixed with 'base/'.
+      {
+        pattern: 'test/fixtures/**',
+        included: false,
+        served: true,
+        watched: true,
+        nocache: true
+      },
+    ],
+
+    // List of files to exclude.
+    exclude: [],
+
+    // Preprocess matching files before serving them to the browser.
+    // See: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      'test/**/*.js': ['webpack']
+    },
+
+    coverageReporter: {
+      type: 'text',
+      dir: 'coverage/'
+    },
+
+    webpack: {
+      node: {
+        fs: 'empty'
+      },
+      // https://github.com/deepsweet/istanbul-instrumenter-loader allows
+      // code coverage of just the things we want.
+      module: {
+        loaders: [{
+          test: /\.js$/,
+          exclude: /(node_modules|bower_components)/,
+          loader: 'babel-loader',
+          query: {
+            plugins: ['lodash'],
+            presets: ['es2015']
+          }
+        }],
+        postLoaders: [{
+          test: /\.js$/,
+          exclude: /(test|node_modules)\//,
+          loader: 'istanbul-instrumenter'
+        }]
+      }
+    },
+
+    webpackMiddleware: {
+      noInfo: true
+    },
+
+    // Test results reporter to use. Possible values: 'dots', 'progress'.
+    // See: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: [
+      'dots',
+      'coverage'
+    ],
+
+    // Web server port.
+    port: 9876,
+
+    // Enable / disable colors in the output (reporters and logs).
+    colors: true,
+
+    // Level of logging.
+    //
+    // possible values:
+    //   config.LOG_DISABLE
+    //   config.LOG_ERROR
+    //   config.LOG_WARN
+    //   config.LOG_INFO
+    //   config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    // 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: ['ChromeHeadless'],
+
+    // Continuous Integration mode. If true, Karma captures browsers, runs the
+    // tests and exits.
+    singleRun: false
+  });
+};

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/api/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015"]
+}

package/lib/api/.eslintrc

@@ -0,0 +1,9 @@
+{
+  "env": {
+    "es6": true,
+    "browser": true
+  },
+  "parserOptions": {
+    "sourceType": "module"
+  }
+}

package/lib/api/README.md

@@ -0,0 +1,134 @@
+## API
+
+This module acts as a javascript wrapper around api.bazaarvoice.com. For more
+information about the API, please see the [API documentation][0].
+
+### Requirements
+
+This module is written using ES6. In order to use the source you may need to
+provide your own transpiler, depending on your supported browsers.
+
+We also take advantage of some built-ins that you may need to polyfill:
+
+- `fetch`: http://caniuse.com/#feat=fetch
+- `Promise`: http://caniuse.com/#feat=promises
+
+#### How to Use
+
+Before using, you'll need to load up the API module:
+
+```javascript
+const api = require('bv-ui-core/lib/api')
+```
+
+Or if you know the specific type of request you are going to make, you can do the following:
+
+```javascript
+const getStatistics = require('bv-ui-core/lib/api/statistics')
+```
+
+## METHODS
+
+Supported methods:
+* [statistics/getStatistics](#getstatistics)
+
+---
+
+### getStatistics
+
+Returns the statistics for a given list of products.
+
+#### Syntax
+
+```javascript
+api.get('statistics', options)
+
+// or
+const getStatistics = require('bv-ui-core/lib/api/statistics')
+getStatistics(options)
+```
+
+#### Parameters
+
+##### options
+
+An object with key/value pairs of inputs. Most values are required.
+
+##### options.productIds
+
+An array of product ids to query for. A warning will be emitted if over 100 products are requested.
+
+##### options.environment
+
+A string representing the data environment. Accepts `qa`, `staging` or
+`production`.
+
+##### options.key
+
+Your api key.
+
+##### options.type
+
+A string representing the type of statistics you want to query for. Currently
+accepts `Reviews` or `NativeReviews`.
+
+Using `Reviews` returns statistics for all content, including syndicated
+content (if enabled on your API key). If you only want statistics for reviews 
+you own that were written for the products specified, use `NativeReviews` 
+instead.
+
+##### options.filters (optional)
+
+An object representing filters keyed by the name of the filter. `ContentLocale `
+can be provided to specify a locale subset for the statistics. If no
+`ContentLocale` is provided, will return the global statistics for each product
+in the query.
+
+Example:
+
+```javascript
+getStatistics({
+  ...
+  filters: {
+    ContentLocale: 'en_US'
+  }
+})
+
+// Results in a call to
+// api.bazaarvoice.com?...&filter=ContentLocale:en_US
+```
+
+
+#### Description
+
+The getStatistics call will return an array of Results or the error message
+(if any) from the API.
+
+#### Examples
+
+```javascript
+//Get all syndicated review statistics for product1, product2
+//and product3 from the en_US locale.
+getStatistics({
+  productIds: ['product1', 'product2', 'product3'],
+  environment: 'qa',
+  key: 'clients_api_key',
+  type: 'Reviews',
+  filters: {
+    ContentLocale: 'en_US'
+  }
+}).then(results => {
+  // Do something with results array.
+}, error => {
+  // Do something with the error.
+  // Format will be:
+  // {
+  //  Message: 'foo',
+  //  Code: 'BAR'
+  // }
+})
+```
+
+---
+
+[0]: https://developer.bazaarvoice.com/docs/read/conversations

package/lib/api/index.js

@@ -0,0 +1,15 @@
+import { default as getStatistics } from './statistics'
+
+const typeMap = {
+  statistics: getStatistics
+}
+
+function get (type, options = {}) {
+  const call = typeMap[type]
+  if (!call) {
+    throw new TypeError(`Unsupported method: ${type}`)
+  }
+  return call(options)
+}
+
+export { get, getStatistics }