Angular2-Token
About
Token based authentication service for Angular2 with multiple user support. Angular2-Token works best with the devise token auth gem for Rails.
Angular2-Token is currently in Alpha. Any contribution is much appreciated.
Live Demo
You can try out Angular2-Token here.
The repository can be found here.
Content
- Installation
- Configuration
- Service Methods
- HTTP Service Wrapper
- Multiple User Types
- Route Guards
- Testing
- Development
- Credits
- License
Installation
-
Install Angular2-Token via NPM with
npm install angular2-token -
Import and add
Ionic2TokenService
to your main module.Ionic2TokenService
depends onHttpModule
andRouterModule
, so make sure you imported them too.;;;@ -
Inject
Ionic2TokenService
into your main component and call.init()
.{this_tokenService;} -
If you are using CORS in your Rails API make sure that
Access-Control-Expose-Headers
includesaccess-token
,expiry
,token-type
,uid
, andclient
. For the rack-cors gem this can be done by adding the following to its config. More information can be found here:expose => ['access-token', 'expiry', 'token-type', 'uid', 'client']
Configuration
Configuration options can be passed as Angular2TokenOptions
via .init()
.
Default Configuration
{ this_tokenService;}
Options | Description |
---|---|
apiPath?: string |
Sets base path all operations are based on |
signInPath?: string |
Sets path for sign in |
signInRedirect?: string |
Sets redirect path for failed CanActivate |
signOutPath?: string |
Sets path for sign out |
validateTokenPath?: string |
Sets path for token validation |
registerAccountPath?: string |
Sets path for account registration |
deleteAccountPath?: string |
Sets path for account deletion |
registerAccountCallback?: string |
Sets the path user are redirected to after email confirmation for registration |
updatePasswordPath?: string |
Sets path for password update |
resetPasswordPath?: string |
Sets path for password reset |
resetPasswordCallback?: string |
Sets the path user are redirected to after email confirmation for password reset |
userTypes?: UserTypes[] |
Allows the configuration of multiple user types (see Multiple User Types) |
Further information on paths/routes can be found at devise token auth
Service Methods
Once initialized Ionic2TokenService
offers methods for session management.
.signIn()
The signIn method is used to sign in the user with email address and password.
The optional parameter type
specifies the name of UserType used for this session.
signIn(email: string, password: string, userType?: string): Observable<Response>
Example:
this_tokenService;
.signOut()
The signOut method destroys session and session storage.
signOut(): Observable<Response>
Example:
this_tokenService;
.registerAccount()
Sends a new user registration request to the Server.
registerAccount(email: string, password: string, passwordConfirmation: string, userType?: string): Observable<Response>
Example:
this_tokenService;
.deleteAccount()
Deletes the account for the signed in user.
deleteAccount(): Observable<Response>
Example:
this_tokenService;
.validateToken()
Validates the current token with the server.
validateToken(): Observable<Response>
Example:
this_tokenService;
.updatePassword()
Updates the password for the logged in user.
updatePassword(password: string, passwordConfirmation: string, currentPassword?: string, userType?: string): Observable<Response>
Example:
this_tokenService;
.resetPassword()
Request a password reset from the server.
resetPassword(email: string, userType?: string): Observable<Response>
Example:
this_tokenService;
HTTP Service Wrapper
Ionic2TokenService
wraps all standard Angular2 Http Service calls for authentication and token processing.
If apiPath
is configured it gets added in front of path.
get(path: string): Observable<Response>
post(path: string, data: any): Observable<Response>
put(path: string, data: any): Observable<Response>
delete(path: string): Observable<Response>
patch(path: string, data: any): Observable<Response>
head(path: string): Observable<Response>
options(path: string): Observable<Response>
Example:
this_tokenService;
.sendHttpRequest()
More customized requests can be send with the .sendHttpRequest()
-function. It accepts the RequestOptions-Class.
More information can be found in the Angular2 API Reference here.
sendHttpRequest(options: RequestOptions): Observable<Response>
Example:
this;
Multiple User Types
An array of UserType
can be passed in Angular2TokenOptions
during init()
.
The user type is selected during sign in and persists until sign out.
.currentUser
returns the currently logged in user.
Example:
this_tokenService; this_tokenService this_tokenServicecurrentUser; // ADMIN
Route Guards
Angular2-Token implements the CanActivate
interface, so it can directly be used as a route guard.
If the signInRedirect
option is set the user will be redirected on a failed (=false) CanActivate using Router.navigate()
.
It currently does not distinguish between user types.
Example:
const routerConfig: Routes = path: '' component: PublicComponent path: 'restricted' component: RestrictedComponent canActivate: Ionic2TokenService ;
Testing
npm test
Development
If the package is installed from Github specified in the package.json, you need to build the package locally.
cd ./node_modules/angular2-tokennpm installnpm run build
Credits
Test config files based on Angular2 Webpack Starter by AngularClass
License
The MIT License (see the LICENSE file for the full text)