airmap

airmap-auth

<dt><a href="#module_airmap-auth">airmap-auth</a></dt>

<dt><a href="#AirMapAuth">AirMapAuth</a></dt>

<dd><p>Class for handling the AirMap Auth Module</p>

<dt><a href="#authorizationErrorsConsts">authorizationErrorsConsts</a></dt>

<dd><p>AuthorizationError language/type mappings</p>

Class for handling the AirMap Auth Module

    * [new AirMapAuth(config, options)](#new_AirMapAuth_new)

    * [.showAuth()](#AirMapAuth+showAuth) ⇒ <code>void</code>

    * [.isAuthenticated()](#AirMapAuth+isAuthenticated) ⇒ <code>boolean</code>

    * [.getUserId()](#AirMapAuth+getUserId) ⇒ <code>string</code>

    * [.getUserToken()](#AirMapAuth+getUserToken) ⇒ <code>string</code>

    * [.logout(logoutUrl)](#AirMapAuth+logout) ⇒ <code>void</code>

| config | <code>Object</code> | AirMap Auth configuration settings can be copied and pasted from the AirMap Developer Portal |

| config.auth0.client_id | <code>string</code> | Client ID provided by AirMap |

| config.auth0.callback_url | <code>string</code> | Callback URL provided by AirMap |

| options | <code>Object</code> | Optional settings for the AirMap Auth Module |

| options.autoLaunch | <code>boolean</code> | Optional boolean. Will check on pageload if user is authenticated. If not authenticated, the auth window will launch. Defaults to `false` |

| options.closeable | <code>boolean</code> | Optional boolean will determine if the auth window can be closed when launched. Defaults to `true` |

| options.domain | <code>string</code> | Optional string. Defaults to `sso.airmap.io`. |

| options.language | <code>string</code> | Optional string. Language code for UI text. Defaults to `en`. |

| options.onAuthenticated | <code>function</code> | Optional function. Function called when Auth Module successfully authenticates the user. Parameter passed to function is the resulting Authorization object |

| options.onAuthorizationError | <code>function</code> | Optional function. Function called when there is an error in authentication. Parameter passed to function is the resulting error object |

| options.state | <code>string</code> | Optional string. String will be passed back with the Authorization object as 'state' on a successful authentication |

### airMapAuth.showAuth() ⇒ <code>void</code>

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

**Kind**: instance method of <code>[AirMapAuth](#AirMapAuth)</code>  

### airMapAuth.isAuthenticated() ⇒ <code>boolean</code>

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

**Returns**: <code>boolean</code> - - If `true`, user has a valid, authenticated token. If `false`, user does not have a valid token.  

### airMapAuth.getUserId() ⇒ <code>string</code>

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.

**Returns**: <code>string</code> - returns the user's id (if authenticated), null if profile could not be retrieved.  

### airMapAuth.getUserToken() ⇒ <code>string</code>

**Returns**: <code>string</code> - returns the user's token (if authenticated), null if user is not authenticated (active session).  

### airMapAuth.logout(logoutUrl) ⇒ <code>void</code>

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

| logoutUrl | <code>string</code> | <code>null</code> | If a logout url is provided as a parameter, upon logging out, page will be redirected to the provided url, otherwise no redirect. |

AuthorizationError language/type mappings

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.2](https://github.com/airmap/js-auth/compare/v1.5.1...v1.5.2) (2017-12-05)

## [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)

  "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",

		@@ -17,2 +17,10 @@ ## Modules

		## Constants

		<dl>
		<dt><a href="#authorizationErrorsConsts">authorizationErrorsConsts</a></dt>
		<dd><p>AuthorizationError language/type mappings</p>
		</dd>
		</dl>

		<a name="module_airmap-auth"></a>
		@@ -102,1 +110,7 @@

		<a name="authorizationErrorsConsts"></a>

		## authorizationErrorsConsts
		AuthorizationError language/type mappings

		Kind: global constant

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

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



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

		{
		"name": "airmap-auth",
		"version": "1.5.1",
		"version": "1.5.2",
		"description": "Authenticate users with AirMap",
		@@ -38,3 +38,3 @@ "author": "AirMap, Inc. <developers@airmap.com> (https://airmap.com)",
		"dependencies": {
		"auth0-lock": "10.22.0",
		"auth0-lock": "^10.22.0",
		"jsonwebtoken": "^7.1.9"
		@@ -41,0 +41,0 @@ },

Improved metrics

Worsened metrics

Dependency changes