Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@feathersjs/authentication-client
Advanced tools
@feathersjs/authentication-client - npm Package Compare versions
Comparing version 1.0.1 to 1.0.2
| # Change Log | ||
| ## [v1.0.1](https://github.com/feathersjs/authentication-client/tree/v1.0.1) (2017-11-16) | ||
| [Full Changelog](https://github.com/feathersjs/authentication-client/compare/v1.0.0...v1.0.1) | ||
| **Merged pull requests:** | ||
| - Add default export for better ES module \(TypeScript\) compatibility [\#81](https://github.com/feathersjs/authentication-client/pull/81) ([daffl](https://github.com/daffl)) | ||
| - Update @feathersjs/authentication to the latest version 🚀 [\#79](https://github.com/feathersjs/authentication-client/pull/79) ([greenkeeper[bot]](https://github.com/apps/greenkeeper)) | ||
| ## [v1.0.0](https://github.com/feathersjs/authentication-client/tree/v1.0.0) (2017-11-01) | ||
@@ -4,0 +12,0 @@ [Full Changelog](https://github.com/feathersjs/authentication-client/compare/v1.0.0-pre.1...v1.0.0) |
| { | ||
| "name": "@feathersjs/authentication-client", | ||
| "description": "The authentication plugin for feathers-client", | ||
| "version": "1.0.1", | ||
| "version": "1.0.2", | ||
| "homepage": "https://github.com/feathersjs/authentication-client", | ||
@@ -38,4 +38,3 @@ "main": "lib/index.js", | ||
| "coverage": "istanbul cover _mocha -- --opts mocha.opts", | ||
| "test": "npm run lint && npm run coverage", | ||
| "start": "npm run compile && node example/app" | ||
| "test": "npm run lint && npm run coverage" | ||
| }, | ||
@@ -69,3 +68,3 @@ "semistandard": { | ||
| "chai": "^4.0.0", | ||
| "feathers-memory": "^1.1.0", | ||
| "feathers-memory": "^2.0.0", | ||
| "istanbul": "^1.1.0-alpha.1", | ||
@@ -76,3 +75,3 @@ "localstorage-memory": "^1.0.2", | ||
| "primus-emitter": "^3.1.1", | ||
| "semistandard": "^11.0.0", | ||
| "semistandard": "^12.0.0", | ||
| "socket.io-client": "^2.0.0", | ||
@@ -79,0 +78,0 @@ "superagent": "^3.5.2", |
114
README.md
@@ -18,116 +18,24 @@ # @feathersjs/authentication-client | ||
| **Note:** This is only compatibile with `feathers-authentication@1.x` and above. | ||
| ## Quick example | ||
| ## Documentation | ||
| <!-- Please refer to the [@feathersjs/authentication-client documentation](http://docs.feathersjs.com/) for more details. --> | ||
| ## API | ||
| This module contains: | ||
| 1. The main entry function | ||
| 2. Some helpful hooks | ||
| The main feathers client instance has a few public methods: | ||
| - `app.authenticate(options)` - Authenticate by passing credentials. | ||
| - `app.logout()` | ||
| It also has a `app.passport` instance that, like on the server, exposes utils functions for dealing with JWTs: | ||
| - `app.passport.getJWT()` - pull it from localstorage or the cookie | ||
| - `app.passport.verifyJWT(token)` - verify that a JWT is not expired and decode it to get the payload. | ||
| **Note:** All these methods return promises. | ||
| ### Handling the special re-authentication errors | ||
| In the event that your server goes down or the client loses connectivity, it will automatically handle attempting to re-authenticate the socket when the client regains connectivity with the server. In order to handle an authentication failure during automatic re-authentication you need to implement the following event listener: | ||
| ```js | ||
| const errorHandler = error => { | ||
| app.authenticate({ | ||
| strategy: 'local', | ||
| email: 'admin@feathersjs.com', | ||
| password: 'admin' | ||
| }).then(response => { | ||
| // You are now authenticated again | ||
| }); | ||
| }; | ||
| const feathers = require('@feathersjs/feathers'); | ||
| const auth = require('@feathersjs/authentication-client'); | ||
| // Handle when auth fails during a reconnect or a transport upgrade | ||
| app.on('reauthentication-error', errorHandler) | ||
| ``` | ||
| const app = feathers(); | ||
| ### Default Options | ||
| The following default options will be mixed in with the settings you pass in when configuring authentication. It will set the mixed options back to to the app so that they are available at any time by `app.get('auth')`. They can all be overridden. | ||
| ```js | ||
| { | ||
| header: 'Authorization', // the default authorization header | ||
| path: '/authentication', // the server side authentication service path | ||
| jwtStrategy: 'jwt', // the name of the JWT authentication strategy | ||
| entity: 'user', // the entity you are authenticating (ie. a users) | ||
| service: 'users', // the service to look up the entity | ||
| cookie: 'feathers-jwt', // the name of the cookie to parse the JWT from when cookies are enabled server side | ||
| storageKey: 'feathers-jwt', // the key to store the accessToken in localstorage or AsyncStorage on React Native | ||
| } | ||
| // Available options are listed in the "Options" section | ||
| app.configure(auth({ | ||
| storage: window.localStorage | ||
| })) | ||
| ``` | ||
| ### Hooks | ||
| ## Documentation | ||
| There are 3 hooks. They are really meant for internal use and you shouldn't need to worry about them very often. | ||
| Please refer to the [@feathersjs/authentication-client documentation](https://docs.feathersjs.com/api/authentication/client.html) for more details. | ||
| 1. `populateAccessToken` - Takes the token and puts in on `hooks.params.accessToken` in case you need it in one of your client side services or hooks | ||
| 2. `populateHeader` - Add the accessToken to the authorization header | ||
| 3. `populateEntity` - Experimental. Populate an entity based on the JWT payload. | ||
| ## Complete Example | ||
| Here's an example of a Feathers client that uses `@feathersjs/authentication-client`. | ||
| ```js | ||
| const feathers = require('feathers/client'); | ||
| const rest = require('feathers-rest/client'); | ||
| const superagent = require('superagent'); | ||
| const hooks = require('feathers-hooks'); | ||
| const localStorage = require('localstorage-memory'); | ||
| const auth = require('@feathersjs/authentication-client'); | ||
| const client = feathers(); | ||
| // NOTE: the order is important: auth must be configured _after_ rest/socket | ||
| client.configure(hooks()) | ||
| .configure(rest('http://localhost:3030').superagent(superagent)) | ||
| .configure(auth({ storage: localStorage })); | ||
| client.authenticate({ | ||
| strategy: 'local', | ||
| email: 'admin@feathersjs.com', | ||
| password: 'admin' | ||
| }) | ||
| .then(response => { | ||
| console.log('Authenticated!', response); | ||
| return client.passport.verifyJWT(response.accessToken); | ||
| }) | ||
| .then(payload => { | ||
| console.log('JWT Payload', payload); | ||
| return client.service('users').get(payload.userId); | ||
| }) | ||
| .then(user => { | ||
| client.set('user', user); | ||
| console.log('User', client.get('user')); | ||
| }) | ||
| .catch(function(error){ | ||
| console.error('Error authenticating!', error); | ||
| }); | ||
| ``` | ||
| ## License | ||
| Copyright (c) 2016 | ||
| Copyright (c) 2018 | ||
| Licensed under the [MIT license](LICENSE). |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-22.2%
31563
- Number of package files
- decreased by-25%
12
- Lines of code
- decreased by-31.39%
389
- Number of lines in readme file
- decreased by-69.17%
41
No dependency changes