Merge pull request #1422 from damienbod/fabiangosebrink/Adding-abstract-services

Fabiangosebrink/adding abstract services

Author: FabianGosebrink

…-client/docs/documentation/public-api.md …ient/docs/documentation/01-public-api.mddocs/site/angular-auth-oidc-client/docs/documentation/public-api.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/01-public-api.md docs/site/angular-auth-oidc-client/docs/documentation/public-api.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/01-public-api.md

@@ -1,26 +1,26 @@
----
-sidebar_label: Deploying to different domains
-sidebar_position: 5
----
-
-# Deploying to different domains
-
-If the client and the Secure Token Service provider are hosted on 2 different domains, the `X-Frame-Options` HTTPS header needs to be set to allow all iframes. Once set, use the CSP HTTPS header to only allow the required domains.
-**The silent renew requires this.**
-
-Add this header to responses from the server that serves your SPA:
-
-```bash
-Content-Security-Policy: script-src 'self' 'unsafe-inline';style-src 'self' 'unsafe-inline';img-src 'self' data:;font-src 'self';frame-ancestors 'self' https://localhost:44318;block-all-mixed-content
-```
-
-where `https://localhost:44318` is the address of your secure token secure server, i.e. the authority which issues tokens.
-
-E.g. if you use nginx to serve your Angular application, you can configure the server as follows:
-
-```javascript
-http {
-  server {
-    ...
-    add_header Content-Security-Policy "script-src 'self' 'unsafe-inline';style-src 'self' 'unsafe-inline';img-src 'self' data:;font-src 'self';frame-ancestors 'self' https://localhost:44318;block-all-mixed-content";
-```
+---
+sidebar_label: Deploying to different domains
+sidebar_position: 4
+---
+
+# Deploying to different domains
+
+If the client and the Secure Token Service provider are hosted on 2 different domains, the `X-Frame-Options` HTTPS header needs to be set to allow all iframes. Once set, use the CSP HTTPS header to only allow the required domains.
+**The silent renew requires this.**
+
+Add this header to responses from the server that serves your SPA:
+
+```bash
+Content-Security-Policy: script-src 'self' 'unsafe-inline';style-src 'self' 'unsafe-inline';img-src 'self' data:;font-src 'self';frame-ancestors 'self' https://localhost:44318;block-all-mixed-content
+```
+
+where `https://localhost:44318` is the address of your secure token secure server, i.e. the authority which issues tokens.
+
+E.g. if you use nginx to serve your Angular application, you can configure the server as follows:
+
+```javascript
+http {
+  server {
+    ...
+    add_header Content-Security-Policy "script-src 'self' 'unsafe-inline';style-src 'self' 'unsafe-inline';img-src 'self' data:;font-src 'self';frame-ancestors 'self' https://localhost:44318;block-all-mixed-content";
+```

…ient/docs/documentation/configuration.md …t/docs/documentation/02-configuration.mddocs/site/angular-auth-oidc-client/docs/documentation/configuration.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/02-configuration.md docs/site/angular-auth-oidc-client/docs/documentation/configuration.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/02-configuration.md

@@ -1,6 +1,6 @@
 ---
 sidebar_label: Public Events
-sidebar_position: 6
+sidebar_position: 5
 ---
 
 # Public Events

…lient/docs/documentation/login-logout.md …nt/docs/documentation/03-login-logout.mddocs/site/angular-auth-oidc-client/docs/documentation/login-logout.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/03-login-logout.md docs/site/angular-auth-oidc-client/docs/documentation/login-logout.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/03-login-logout.md

@@ -0,0 +1,32 @@
+---
+sidebar_label: Custom Logger
+sidebar_position: 6
+---
+
+# Custom Logger
+
+```ts
+import { AbstractLoggerService } from 'angular-auth-oidc-client';
+
+@Injectable()
+export class MyLoggerService implements AbstractLoggerService {
+  // ...
+}
+```
+
+Then provide the class in the module:
+
+```ts
+@NgModule({
+  imports: [
+    AuthModule.forRoot({
+      config: {
+        // ...
+      },
+    }),
+  ],
+  providers: [{ provide: AbstractLoggerService, useClass: MyLoggerService }],
+  exports: [AuthModule],
+})
+export class AuthConfigModule {}
+```

…mentation/deploy-to-different-domains.md …tation/04-deploy-to-different-domains.mddocs/site/angular-auth-oidc-client/docs/documentation/deploy-to-different-domains.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/04-deploy-to-different-domains.md docs/site/angular-auth-oidc-client/docs/documentation/deploy-to-different-domains.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/04-deploy-to-different-domains.md

@@ -13,7 +13,7 @@ The following example shows a custom storage that uses `localStorage`:
 import { AbstractSecurityStorage } from 'angular-auth-oidc-client';
 
 @Injectable()
-export class CustomStorage implements AbstractSecurityStorage {
+export class MyStorageService implements AbstractSecurityStorage {
   read(key: string) {
     return localStorage.getItem(key);
   }
@@ -37,9 +37,14 @@ Then provide the class in the module:
 ```ts
 @NgModule({
   imports: [
-      // ...
-      AuthModule.forRoot({ config: { storage: new CustomStorage() } })
+    AuthModule.forRoot({
+      config: {
+        // ...
+      },
+    }),
   ],
-  // ...
+  providers: [{ provide: AbstractSecurityStorage, useClass: MyStorageService }],
+  exports: [AuthModule],
 })
+export class AuthConfigModule {}
 ```

…ient/docs/documentation/public-events.md …t/docs/documentation/05-public-events.mddocs/site/angular-auth-oidc-client/docs/documentation/public-events.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/05-public-events.md docs/site/angular-auth-oidc-client/docs/documentation/public-events.md renamed to docs/site/angular-auth-oidc-client/docs/documentation/05-public-events.md

@@ -1,52 +1,52 @@
----
-sidebar_label: Using Route Guards
-sidebar_position: 7
----
-
-# Using Route Guards
-
-> Guards should only be applied to protected URLs. There should be no guard active on the default route where the authorization request is processed.
-
-Please refer to the auto-login guard in this repo as a reference. It is important that the callback logic can be run on a route without the guard running or run before the guard logic.
-
-```ts
-import { Injectable } from '@angular/core';
-import { ActivatedRouteSnapshot, CanActivate, Router, RouterStateSnapshot, UrlTree } from '@angular/router';
-import { OidcSecurityService } from 'angular-auth-oidc-client';
-import { Observable } from 'rxjs';
-import { map } from 'rxjs/operators';
-
-@Injectable({ providedIn: 'root' })
-export class AuthorizationGuard implements CanActivate {
-  constructor(private oidcSecurityService: OidcSecurityService, private router: Router) {}
-
-  canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> {
-    return this.oidcSecurityService.isAuthenticated$.pipe(
-      map(({ isAuthenticated }) => {
-        // allow navigation if authenticated
-        if (isAuthenticated) {
-          return true;
-        }
-
-        // redirect if not authenticated
-        return this.router.parseUrl('/unauthorized');
-      })
-    );
-  }
-}
-```
-
-To apply the guard for specific routes you have to add it to the route configuration e.g. with `canActivate`:
-
-```ts
-const appRoutes: Routes = [
-  {
-    path: 'protected',
-    component: <yourComponent>,
-    canActivate: [AuthorizationGuard]
-  },
-  // ...
-];
-```
-
-All other guard types like `canLoad` or `canActivateChild` work in a similar way. However, the guard class has to implement the respective interfaces and methods accordingly.
+---
+sidebar_label: Using Route Guards
+sidebar_position: 8
+---
+
+# Using Route Guards
+
+> Guards should only be applied to protected URLs. There should be no guard active on the default route where the authorization request is processed.
+
+Please refer to the auto-login guard in this repo as a reference. It is important that the callback logic can be run on a route without the guard running or run before the guard logic.
+
+```ts
+import { Injectable } from '@angular/core';
+import { ActivatedRouteSnapshot, CanActivate, Router, RouterStateSnapshot, UrlTree } from '@angular/router';
+import { OidcSecurityService } from 'angular-auth-oidc-client';
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+
+@Injectable({ providedIn: 'root' })
+export class AuthorizationGuard implements CanActivate {
+  constructor(private oidcSecurityService: OidcSecurityService, private router: Router) {}
+
+  canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> {
+    return this.oidcSecurityService.isAuthenticated$.pipe(
+      map(({ isAuthenticated }) => {
+        // allow navigation if authenticated
+        if (isAuthenticated) {
+          return true;
+        }
+
+        // redirect if not authenticated
+        return this.router.parseUrl('/unauthorized');
+      })
+    );
+  }
+}
+```
+
+To apply the guard for specific routes you have to add it to the route configuration e.g. with `canActivate`:
+
+```ts
+const appRoutes: Routes = [
+  {
+    path: 'protected',
+    component: <yourComponent>,
+    canActivate: [AuthorizationGuard]
+  },
+  // ...
+];
+```
+
+All other guard types like `canLoad` or `canActivateChild` work in a similar way. However, the guard class has to implement the respective interfaces and methods accordingly.

docs/site/angular-auth-oidc-client/docs/documentation/06-custom-logger.md

@@ -1,6 +1,6 @@
 ---
 sidebar_label: Auto Login
-sidebar_position: 8
+sidebar_position: 9
 ---
 
 # Auto Login