angular-stormpath

Stormpath is Joining Okta

We are incredibly excited to announce that Stormpath is joining forces with Okta. Please visit the Migration FAQs for a detailed look at what this means for Stormpath users.

We're available to answer all questions at [e-mail].

Stormpath Angular SDK

Angular Components for integrating with Stormpath's API

Table of contents

• About
• Installation
  • Configuration
• Documentation
• Development
• License

About

Angular SDK for Stormpath's API. If you're looking for AngularJS support, please see stormpath-sdk-angularjs.

Installation

Install through npm:

npm install --save angular-stormpath

Then use it in your app like so:

import { Component } from '@angular/core';
import { AuthPortComponent } from 'angular-stormpath';

@Component({
  selector: 'app-root',
  template: `<div *ngIf="(user$ | async)" class="row text-center">
 <h2>
   Welcome, {{ ( user$ | async ).fullName }}.
 </h2>

 <ul class="nav nav-pills nav-stacked text-centered">
   <li role="presentation" (click)="logout()"><a href="#">Logout</a></li>
 </ul>
</div>

<sp-authport></sp-authport>`
})
export class AppComponent extends AuthPortComponent {
}

If you're using a version of Angular < 2.3, extending AuthPortComponent won't work for you. As an alternative, you can inject the Stormpath service into your component, subscribe to stormpath.user$ and implement logout() yourself.

import { Account, Stormpath } from 'angular-stormpath';
...
export class AppComponent {
  user$: Observable<Account | boolean>;

  constructor(private stormpath: Stormpath) {
    this.user$ = this.stormpath.user$;
  }

  logout(): void {
    this.stormpath.logout();
  }
}

You may also find it useful to view the demo source.

Configuration

To override the endpoint prefix or URIs for the various endpoints, you can modify the defaults in StormpathConfiguration.

For example, to override the endpoint prefix and /me URI in demo.module.ts, change it to the following:

export function stormpathConfig(): StormpathConfiguration {
 let spConfig: StormpathConfiguration = new StormpathConfiguration();
 spConfig.endpointPrefix = 'http://api.mycompany.com';
 spConfig.meUri = '/account';
 return spConfig;
}

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, StormpathModule],
  bootstrap: [AppComponent],
  providers: [{
    provide: StormpathConfiguration, useFactory: stormpathConfig
  }]
})
export class DemoModule {
}

OAuth

If your Angular app is on a different domain than your endpoints, OAuth will be used for login/logout. The access token will be stored in localStorage under the name stormpath:token and it will be automatically added as an Authorization header when you send HTTP requests to your /me endpoint.

If you'd like to add this header to additional URLs, you'll need to add them as follows:

let config: StormpathConfiguration = new StormpathConfiguration();
config.autoAuthorizedUris.push(new RegExp('http://localhost:3000/myapi/*)');

Templates

To override templates, you can use the customTemplate attribute on a component. Below is an example of app.component.ts with a custom <sp-authport> and <login-form>:

import { Component, OnInit } from '@angular/core';
import { Observable } from 'rxjs/Observable';
import { Stormpath, StormpathErrorResponse, Account, LoginFormModel } from 'angular-stormpath';

@Component({
  selector: 'demo-app',
  template: `<div class="container">
<div *ngIf="(user$ | async)" class="row text-center">
  <h2>
    Welcome, {{ ( user$ | async ).fullName }}.
  </h2>
  <hr/>

  <ul class="nav nav-pills nav-stacked text-centered">
    <li role="presentation" (click)="logout(); false"><a href="">Logout</a></li>
  </ul>
</div>

<ng-template #loginform>
  <div *ngIf="error" class="alert alert-danger">{{error}}</div>
  <form>
      <label for="email">Email</label>
      <input id="email" name="login" type="text" [(ngModel)]="loginFormModel.login">
      <label for="passwordField">Password</label>
      <input id="passwordField" name="password" type="password" [(ngModel)]="loginFormModel.password">
      <button (click)="login()">Login</button>
  </form>
</ng-template>

<ng-template #authport>
  <div *ngIf="(user$ | async) === false">
      <h2>Sign In</h2>
      <login-form [customTemplate]="loginform"></login-form>
  </div>
</ng-template>

<sp-authport [customTemplate]="authport"></sp-authport>

</div>`
})
export class AppComponent implements OnInit {

  protected loginFormModel: LoginFormModel;
  protected error: string;

  private user$: Observable<Account | boolean>;
  private loggedIn$: Observable<boolean>;
  private _login: boolean;
  private _register: boolean;

  constructor(public stormpath: Stormpath) {
    this.loginFormModel = {
      login: '',
      password: ''
    };
  }

  ngOnInit(): void {
    this._login = true;
    this._register = false;
    this.user$ = this.stormpath.user$;
    this.loggedIn$ = this.user$.map(user => !!user);
  }

  showLogin(): void {
    this._login = !(this._register = false);
  }

  showRegister(): void {
    this._register = !(this._login = false);
  }

  login(): void {
    this.error = null;
    this.stormpath.login(this.loginFormModel)
      .subscribe(null, (error: StormpathErrorResponse) => {
        this.error = error.message;
      });
  }

  logout(): void {
    this.stormpath.logout();
  }
}

NOTE: One problem with this approach is you'll need to copy all the referenced variables in the template into your component. Another option is to extend the existing Stormpath component and override its template variable in @Component. This is the recommended solution if you're using Angular 2.3+.

Access Token Storage

To change the storage mechanism for authentication tokens from localStorage (the default), to cookies, change the class for the 'tokenStore' provider.

{
  provide: 'tokenStore', useClass: CookieTokenStoreManager
}

Below is a list of direct links to each component. You can use the HTML defined in their template variable as a starting point for your customizations.

• authport.component.ts
• email-verification.component.ts
• forgot-password.component.ts
• login.component.ts
• register.component.ts
• resend-email-verification.component.ts
• reset-password-component.component.ts

Usage without a module bundler

<script src="node_modules/dist/umd/stormpath-sdk-angular/stormpath-sdk-angular.js"></script>
<script>
    // everything is exported Stormpath namespace
</script>

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed at https://docs.stormpath.com/angular/api.

Development

Prepare your environment

• Install Node.js and npm
• Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Using npm link

If you want to use npm link to use this module in another Angular project, follow the steps below:

1. Build this project using npm run build:dist.
2. Run npm link in this project's directory.
3. Run npm link angular-stormpath in the <test-project>.
4. Run rm -rf node_modules/angular-stormpath/node_modules in <test-project>.
5. Manually install dependencies required by angular-stormpath:

npm install ng2-webstorage angular2-cookie --save

You'll know if this doesn't work because you'll see an error message like the following:

Type 'Observable<boolean | Account>' is not assignable to type 'Observable<boolean | Account>'. '
Property 'source' is protected but type 'Observable<T>' is not a class derived from 'Observable<T>'.

When this happens, you can use the ol' fashioned copy and paste method. If you have stormpath-sdk-angular in an adjacent directory, the commands below should work on your project that has angular-stormpath already installed. You will need to run npm run build:dist every time you change code in this project.

rm -rf node_modules/angular-stormpath/dist
cp -r ../stormpath-sdk-angular/dist node_modules/angular-stormpath/.
cp ../stormpath-sdk-angular/package.json node_modules/angular-stormpath/.

Release

Bump the version in package.json (once the module hits 1.0 this will become automatic).

npm run release

For more information, see generator-angular-library. It was used to create this project.

License

Apache-2.0 © Stormpath

Changelog

0.2.0 (2017-11-21)

<a name="2.0.0"></a>