@first-line/firstline-angular
v1.0.3
Published
Firstline SDK for Angular Single Page Applications (SPA)
Downloads
5
Readme
Firstline Angular
This library enables you to add authentication to your Angular app.
Helpful resources
- Quick setup - our guide for quickly adding login, logout and user information to an Angular app using Firstline.
- Angular sample app - a full-fledged Angular application integrated with Firstline.
- Firstline docs - explore our docs site and learn more about Firstline.
Getting started
Setup Firstline Application & API
- Follow the Quick setup to configure a Firstline Application.
- Add a Firstline API as shown in Secure API.
Important: Don't forget to configure the Application URIs.
Installation
Using npm:
npm install @first-line/firstline-angular
Using yarn:
yarn add @first-line/firstline-angular
Hint: You can also try out our Angular sample app.
Configuration
Add the following code to your Angular project. Replace DOMAIN, API_IDENTIFIER and CLIENT_ID with the settings you configured in the setup step. You can also find them in the Application's and API's "Configure" tab in your dashboard.
Furthermore, replace API_URL with the base URL of your secured API endpoints. For example, by specifying http://localhost:8080/*
all calls to endpoints that start with http://localhost:8080
have an Authorization header.
// app.module.ts
import { NgModule } from '@angular/core';
import { AuthModule } from '@first-line/firstline-angular';
@NgModule({
// ...
imports: [
AuthModule.forRoot({
domain: 'DOMAIN',
audience: 'API_IDENTIFIER', // = audience
client_id: 'CLIENT_ID',
redirect_uri: window.location.origin,
logout_uri: `${window.location.origin}/logout`, // or window.location.origin to redirect back to home after logout
httpInterceptor: {
allowedList: [
'API_URL/*'
]
}
}),
]
})
export class AppModule {}
Add login, logout, isAuthenticated & user
Implement the following component in your frontend and you have a fully functional login/logout.
// home.component.ts
import { Component } from '@angular/core';
import { AuthService } from '@first-line/firstline-angular';
@Component({
selector: 'app-home',
templateUrl: './home.component.html',
styleUrls: ['./home.component.css']
})
export class NavBarComponent {
constructor(public auth: AuthService) { }
loginWithRedirect() {
this.auth.loginWithRedirect();
}
logout() {
this.auth.logout();
}
}
<!-- home.component.html -->
<div class="container" *ngIf="auth.isLoading$ | async; else loaded">
<app-loading></app-loading>
</div>
<ng-template #loaded>
<div class="container" *ngIf="auth.user$ | async as user; else homesignin">
<h1 class="text-2xl">Welcome {{user.email}}.</h1>
<button (click)="logout()">Logout</button>
</div>
<ng-template #homesignin>
<h1>Please sign-in </h1>
<button (click)="loginWithRedirect()">Login</button>
</ng-template>
</ng-template>
You can use the auth variable to
- log in
- log out
- check if the user is signed in
- retrieve the logged in user
Make a secured backend call
You now only need to implement the API call. Firstline will automatically inject an Authorization header into all API calls that have a URL starting with API_URL
(that you configured above).
// api.service.ts
import { Injectable } from '@angular/core';
import { HttpClient } from '@angular/common/http';
@Injectable({
providedIn: 'root',
})
export class ApiService {
constructor(private http: HttpClient) {}
loadPosts$() {
return this.http.get('API_URL/posts');
}
}
In this example, we assume that the API endpoint http://localhost:8080/posts exists.
Protect a page
Create a component SecureComponent
with secure UI content. Add the following code to app-routing.module.ts
.
If you have implemented everything correctly, unauthenticated users can no longer access /secured
.
// app-routing.module.ts
import { NgModule } from '@angular/core';
import { Routes, RouterModule } from '@angular/router';
import { HomeComponent } from './pages/home/home.component';
import { SecuredComponent } from './pages/secured/secured.component';
import { LogoutComponent } from './pages/logout/logout.component';
import { AuthGuard } from '@first-line/firstline-angular';
const routes: Routes = [
{ path: '', component: HomeComponent, pathMatch: 'full' },
{ path: 'logout', component: LogoutComponent },
{ // secured page:
path: 'secured',
component: SecuredComponent,
canActivate: [AuthGuard],
}
];
@NgModule({
imports: [RouterModule.forRoot(routes, {})],
exports: [RouterModule],
})
export class AppRoutingModule {}