airmap

airmap-auth

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [1.5.1](https://github.com/airmap/js-auth/compare/v1.5.0...v1.5.1) (2017-12-04)

# [1.5.0](https://github.com/airmap/js-auth/compare/v1.3.2...v1.5.0) (2017-10-22)

* Bump Auth0 lock to latest version. ([2ff01e5](https://github.com/airmap/js-auth/commit/2ff01e5))

* Change version of auth0-lock to 10.22.0 which uses older version of react-transition-group. ([e10cf0a](https://github.com/airmap/js-auth/commit/e10cf0a))

* Update email verification error message. ([c23ff75](https://github.com/airmap/js-auth/commit/c23ff75))

* Add option to configure sso domain. ([17be534](https://github.com/airmap/js-auth/commit/17be534))

* Add option to select a language. ([0002654](https://github.com/airmap/js-auth/commit/0002654))

# [1.4.0](https://github.com/airmap/js-auth/compare/v1.3.2...v1.4.0) (2017-06-29)

## [1.3.2](https://github.com/airmap/js-auth/compare/v1.3.1...v1.3.2) (2017-03-07)

* Ensure allowedConnections are correctly passed through to Auth0. ([3d8c20f](https://github.com/airmap/js-auth/commit/3d8c20f))

* Upgrade Auth0 to fix logo width regression. ([40574af](https://github.com/airmap/js-auth/commit/40574af))

## [1.3.1](https://github.com/airmap/js-auth/compare/v1.3.0...v1.3.1) (2016-12-15)

* Updated build script for npm to fix how the files were being built for npm. Previously, the package was being bundled with dependencies. Now, the package is transpiled to ES5 before it gets deployed to npm and lists all necessary dependencies that will be installed and bundled by the consuming application. ([fb5bb2a](https://github.com/airmap/js-auth/commit/fb5bb2a))

# [1.3.0](https://github.com/airmap/js-auth/compare/v1.2.7...v1.3.0) (2016-12-13)

* Resolve typo in README. closes [#5](https://github.com/airmap/js-auth/issues/5) ([11f2822](https://github.com/airmap/js-auth/commit/11f2822))

* add state auth parameter to Options object - string stored in state will be passed in the successful authentication result. ([af9e906](https://github.com/airmap/js-auth/commit/af9e906))

## [1.2.8](https://github.com/airmap/js-auth/compare/v1.2.7...v1.2.8) (2016-12-09)

## [1.2.7](https://github.com/airmap/js-auth/compare/v1.2.6...v1.2.7) (2016-11-17)

## [1.2.6](https://github.com/airmap/js-auth/compare/v1.2.4...v1.2.6) (2016-08-23)

## [1.2.4](https://github.com/airmap/js-auth/compare/v1.2.3...v1.2.4) (2016-08-23)

## [1.2.3](https://github.com/airmap/js-auth/compare/v1.2.1...v1.2.3) (2016-08-22)

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

var Auth0Lock = require('auth0-lock').default;

    AuthorizationError = _require.AuthorizationError,

    BadConfigError = _require.BadConfigError;

var _require2 = require('./utilities.js'),

    supportsLocalStorage = _require2.supportsLocalStorage;

/** Class for handling the AirMap Auth Module */

     * @param {Object} config AirMap Auth configuration settings can be copied and pasted from the AirMap Developer Portal

     * @param {string} config.auth0.client_id - Client ID provided by AirMap

     * @param {string} config.auth0.callback_url Callback URL provided by AirMap

     * @param {Object} options Optional settings for the AirMap Auth Module

     * @param {boolean} options.autoLaunch Optional boolean. Will check on pageload if user is authenticated. If not authenticated, the auth window will launch. Defaults to `false`

     * @param {boolean} options.closeable Optional boolean will determine if the auth window can be closed when launched. Defaults to `true`

     * @param {string} options.domain Optional string. Defaults to `sso.airmap.io`.

     * @param {string} options.language Optional string. Language code for UI text. Defaults to `en`.

     * @param {function} options.onAuthenticated Optional function. Function called when Auth Module successfully authenticates the user. Parameter passed to function is the resulting Authorization object

     * @param {function} options.onAuthorizationError Optional function. Function called when there is an error in authentication. Parameter passed to function is the resulting error object

     * @param {string} options.state Optional string. String will be passed back with the Authorization object as 'state' on a successful authentication

        var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};

        _classCallCheck(this, AirMapAuth);

        // Checks for Auth0 Config Variables

        if (!config || typeof config.auth0 === 'undefined') {

            throw new BadConfigError('auth0');

        if (config.auth0.client_id === 'undefined' || !config.auth0.client_id) {

            throw new BadConfigError('auth0.client_id');

        if (config.auth0.callback_url === 'undefined' || !config.auth0.callback_url) {

            throw new BadConfigError('auth0.callback_url');

        // Auth Settings - Classwide Config Variables

        this.opts = _extends({}, this.defaults, opts);

        this._clientId = config.auth0.client_id;

        this._callbackUrl = config.auth0.callback_url;

        this._tokenName = 'AirMapUserToken';

            allowedConnections: ['Username-Password-Authentication', 'google-oauth2'],

                redirectUrl: this._callbackUrl,

                    state: this.opts.state

            closable: this.opts.closeable,

            language: this.opts.language,

                emailInputPlaceholder: 'email@domain.com',

        // Creates an instance of Auth0Lock and then initiates Event Emitters

        this._lock = new Auth0Lock(this._clientId, this._domain, this._authOptions);

            // Checks localStorage browser support

            if (!supportsLocalStorage()) {

                window.alert('Your web browser does not support storing settings locally. In Safari, the most common cause of this is using "Private Browsing Mode". Please try exiting Private Browsing Mode and logging in again, or using another browser.');

                var authErr = new AuthorizationError(err.error_description.type);

                _this._showAuthError(authErr.getText());

                _this._showAuthError(authErr.getText(_this.opts.language));

                _this.opts.onAuthorizationError(error);

            // Attaching event listener for DOM load when autoLaunch is desired so that an authenticated check is made.

                document.addEventListener('DOMContentLoaded', function () {

         *  Launches the Auth Modal with an error message displayed.

         *  @param {string} text - Error message text to display.

        value: function _showAuthError(text) {

         *  Launches the Auth Modal after checking if a valid auth token is available.

            // Will only show Auth Modal when user does not have a valid auth token available.

            // Also, handling race conditions by checking hash for id_token as a redirect (causing DOM loading) fires before 'authenticated' event.

            var authenticated = this.isAuthenticated();

            if (authenticated || window.location.hash.indexOf('id_token') > -1) {

         *  Checks whether a user is authenticated, which means that they have a token stored in localStorage and that the token is not expired.

         *  @return {boolean} - If `true`, user has a valid, authenticated token. If `false`, user does not have a valid token.

        value: function isAuthenticated() {

            // Will only show Auth Modal when user does not have an auth token available.

            if (!localStorage.getItem(this._tokenName)) return false;

            //Checks expiration date of token.

            var decoded = jwt.decode(localStorage.getItem(this._tokenName));

            var timeStampNow = Math.floor(Date.now() / 1000);

            return timeStampNow < decoded.exp ? true : false;

         *  Retreives a user's id when authenticated. If no auth token exists or if it's invalid, the return value will be null.

         *  This method can be used to retrieve the user's AirMap Id for calls to other AirMap APIs like the Pilot API, which returns a Pilot's profile.

         *  @return {string} returns the user's id (if authenticated), null if profile could not be retrieved.

            // Looks for a valid token in localStorage.

                return jwt.decode(localStorage.getItem(this._tokenName)).sub;

         *  @return {string} returns the user's token (if authenticated), null if user is not authenticated (active session).

            // Looks for a token in localStorage and makes sure the token is valid.

            return localStorage.getItem(this._tokenName) || null;

         *  Logs out a user by removing the authenticated user token from localStorage and redirects the user (optional).

function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }

 * Error caused when config is malformatted.

        _classCallCheck(this, BadConfigError);

        return _possibleConstructorReturn(this, (BadConfigError.__proto__ || Object.getPrototypeOf(BadConfigError)).call(this, 'AirMap Auth - unable to initialize due to missing configuration item: ' + item));

 * Handles authorization errors returned from Auth0.

        _classCallCheck(this, AuthorizationError);

        this.type = _constants.authorizationErrorsConsts['en'][type] ? type : '__default__';

                    return 'Sorry, we are unable to create an account for this email address. Please register with an address from another domain.';

                case 'email_verification':

                    return 'Your email address has not been verified. Please click the link that was sent to you.';

                    return 'There was an error authenticating.';

            var lang = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'en';

            return _constants.authorizationErrorsConsts[lang][this.type];

    AuthorizationError: AuthorizationError,

  "description": "Authenticate users with AirMap",

  "author": "AirMap, Inc. <developers@airmap.com> (https://airmap.com)",

  "license": "SEE LICENSE IN LICENSE.md",

    "url": "https://github.com/airmap/js-auth.git"

    "build-prod-cdn": "mkdir -p dist && browserify -t [babelify] src/index.js -s AirMapAuth | uglifyjs -c -m > dist/airmap-auth.min.js",

    "build-prod-npm": "mkdir -p dist && babel src/ --out-dir dist",

    "build-prod": "npm run build-prod-cdn && npm run build-prod-npm",

    "build-dev": "mkdir -p dist && browserify -t [babelify] src/index.js -s AirMapAuth > dist/index.js",

    "docs": "node_modules/.bin/jsdoc2md src/** > API.md",

    "standard-version": "standard-version",

    "release": "sh ./scripts/release.sh",

    "start": "budo ./examples/index.js --serve=examples/bundle.js --port=8080 --live -ssl --cors --dir=examples -- -t babelify",

    "test": "export NODE_PATH=./ && mocha --compilers js:babel-register --recursive test/setup.js test/unit/*",

    "test:circle": "export NODE_PATH=./ && mocha --compilers js:babel-register --recursive --reporter mocha-junit-reporter test/setup.js test/unit/* --reporter-options mochaFile=$CIRCLE_TEST_REPORTS/mocha/unit.xml"

    "babel-plugin-transform-object-assign": "^6.8.0",

    "babel-plugin-transform-object-rest-spread": "^6.8.0",

		@@ -5,2 +5,7 @@ # Change Log

		<a name="1.5.1"></a>
		## [1.5.1](https://github.com/airmap/js-auth/compare/v1.5.0...v1.5.1) (2017-12-04)



		<a name="1.5.0"></a>
		@@ -7,0 +12,0 @@ # [1.5.0](https://github.com/airmap/js-auth/compare/v1.3.2...v1.5.0) (2017-10-22)

		@@ -5,2 +5,4 @@ 'use strict';

		var _constants = require('./constants');

		function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
		@@ -38,3 +40,3 @@

		this.type = type;
		this.type = _constants.authorizationErrorsConsts['en'][type] ? type : '__default__';
		}
		@@ -45,13 +47,5 @@
		value: function getText() {
		switch (this.type) {
		case 'domain_blacklist':
		return 'Sorry, we are unable to create an account for this email address. Please register with an address from another domain.';
		break;
		case 'email_verification':
		return 'Your email address has not been verified. Please click the link that was sent to you.';
		break;
		default:
		return 'There was an error authenticating.';
		break;
		}
		var lang = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'en';

		return _constants.authorizationErrorsConsts[lang][this.type];
		}
		@@ -58,0 +52,0 @@ }]);

		{
		"name": "airmap-auth",
		"version": "1.5.0",
		"version": "1.5.1",
		"description": "Authenticate users with AirMap",
		@@ -5,0 +5,0 @@ "author": "AirMap, Inc. <developers@airmap.com> (https://airmap.com)",

Improved metrics

Worsened metrics

		@@ -123,3 +123,3 @@ 'use strict';
		var authErr = new AuthorizationError(err.error_description.type);
		_this._showAuthError(authErr.getText());
		_this._showAuthError(authErr.getText(_this.opts.language));
		_this.opts.onAuthorizationError(error);
		@@ -126,0 +126,0 @@ });