@rxap/authentication
Version:
Provides authentication services, guards, and interceptors for Angular applications. It supports token-based authentication and provides features such as sign-out functionality and routing based on authentication status. This package also includes utiliti
761 lines (627 loc) • 28.4 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-authentication</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-authentication</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content injectable">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Injectables</li>
<li class="breadcrumb-item" >RxapAuthenticationGuard</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/lib/authentication.guard.ts</code>
</p>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier"></span>
<span class="modifier">Public</span>
<a href="#authentication" >authentication</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#lastUrl" >lastUrl</a>
</li>
<li>
<span class="modifier"></span>
<span class="modifier">Public</span>
<a href="#router" >router</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<a href="#canActivate" >canActivate</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#canActivateChild" >canActivateChild</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(authentication: <a href="../injectables/RxapAuthenticationService.html" target="_self">RxapAuthenticationService</a>, router: Router, deactivated: boolean | null)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="18" class="link-to-prism">src/lib/authentication.guard.ts:18</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>authentication</td>
<td>
<code><a href="../injectables/RxapAuthenticationService.html" target="_self" >RxapAuthenticationService</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>router</td>
<td>
<code>Router</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>deactivated</td>
<td>
<code>boolean | null</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="canActivate"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>canActivate</b></span>
<a href="#canActivate"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="31"
class="link-to-prism">src/lib/authentication.guard.ts:31</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>route</td>
<td>
<code>ActivatedRouteSnapshot</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>state</td>
<td>
<code>RouterStateSnapshot</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Promise<UrlTree | boolean></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="canActivateChild"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>canActivateChild</b></span>
<a href="#canActivateChild"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="39"
class="link-to-prism">src/lib/authentication.guard.ts:39</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>childRoute</td>
<td>
<code>ActivatedRouteSnapshot</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>state</td>
<td>
<code>RouterStateSnapshot</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Promise<UrlTree | boolean></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="authentication"></a>
<span class="name">
<span class="modifier"></span>
<span class="modifier">Public</span>
<span ><b>authentication</b></span>
<a href="#authentication"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../injectables/RxapAuthenticationService.html" target="_self" >RxapAuthenticationService</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@Inject(RxapAuthenticationService)<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="22" class="link-to-prism">src/lib/authentication.guard.ts:22</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="lastUrl"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>lastUrl</b></span>
<a href="#lastUrl"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | null</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>null</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="18" class="link-to-prism">src/lib/authentication.guard.ts:18</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="router"></a>
<span class="name">
<span class="modifier"></span>
<span class="modifier">Public</span>
<span ><b>router</b></span>
<a href="#router"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Router</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@Inject(Router)<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="24" class="link-to-prism">src/lib/authentication.guard.ts:24</a></div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
Inject,
Injectable,
Optional,
} from '@angular/core';
import {
ActivatedRouteSnapshot,
Router,
RouterStateSnapshot,
UrlTree,
} from '@angular/router';
import { RxapAuthenticationService } from './authentication.service';
import { RXAP_AUTHENTICATION_DEACTIVATED } from './tokens';
@Injectable({ providedIn: 'root' })
export class RxapAuthenticationGuard {
public lastUrl: string | null = null;
constructor(
@Inject(RxapAuthenticationService)
public authentication: RxapAuthenticationService,
@Inject(Router)
public router: Router,
@Optional()
@Inject(RXAP_AUTHENTICATION_DEACTIVATED)
private readonly deactivated: boolean | null = null,
) {
}
public canActivate(
route: ActivatedRouteSnapshot,
state: RouterStateSnapshot,
): Promise<UrlTree | boolean> {
console.debug('[RxapAuthenticationGuard] can activate', state.url);
return this.checkAuthStatus(route, state);
}
public canActivateChild(
childRoute: ActivatedRouteSnapshot,
state: RouterStateSnapshot,
): Promise<UrlTree | boolean> {
console.debug('[RxapAuthenticationGuard] can activate child', state.url);
return this.checkAuthStatus(childRoute, state);
}
private async checkAuthStatus(
route: ActivatedRouteSnapshot,
state: RouterStateSnapshot,
): Promise<UrlTree | boolean> {
if (this.deactivated) {
return true;
}
const authenticated = await this.authentication.isAuthenticated();
if (authenticated === null) {
if (!this.lastUrl || (state.url !== '/' && !state.url.match(/authentication\/login/))) {
this.lastUrl = state.url;
}
return this.router.createUrlTree([ '/', 'authentication', 'loading' ]);
}
if (authenticated) {
if (this.lastUrl && (state.url/*?*/ === '/' || state.url.match(/authentication\/login/))) {
const lastUrl = this.lastUrl;
this.lastUrl = null;
return this.createUrlTreeToLastUrl(lastUrl);
} else {
if (state.url.match(/authentication/)) {
if (state.url.match(/authentication\/reset-password/)) {
return true;
}
return this.router.createUrlTree([ '/' ]);
} else {
this.lastUrl = null;
return true;
}
}
} else {
if (!state.url.match(/^\/?authentication/)) {
this.lastUrl = state.url;
}
if (state.url.match(/^\/?authentication/)) {
if (this.lastUrl && this.lastUrl.match(/^\/?authentication/)) {
const lastUrl = this.lastUrl;
this.lastUrl = null;
return this.createUrlTreeToLastUrl(lastUrl);
}
return true;
} else {
return this.router.createUrlTree([ '/', 'authentication', 'login' ]);
}
}
}
private createUrlTreeToLastUrl(lastUrl: string): UrlTree {
const urlMatch = lastUrl.match(/^([^?#]+)(\?([^#]+))?(#(.+))?$/);
if (urlMatch) {
let queryParams: Record<string, string> = {};
if (urlMatch[3]) {
const queryParamsString = urlMatch[3];
queryParams = queryParamsString.split('&').map(param => {
const split = param.split('=');
return { [split[0]]: split[1] };
}).reduce((params, param) => ({ ...params, ...param }), {});
}
let fragment: string | undefined = undefined;
if (urlMatch[5]) {
fragment = urlMatch[5];
}
return this.router.createUrlTree([ urlMatch[1] ], {
queryParams,
fragment,
});
}
return this.router.createUrlTree([ lastUrl ]);
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
var COMPODOC_CURRENT_PAGE_URL = 'RxapAuthenticationGuard.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>