keycloak-angular 7.0.1 → 7.3.1

package/README.md

@@ -45,6 +45,11 @@ This library helps you to use [keycloak-js](https://www.keycloak.org/docs/latest
 npm i --save keycloak-angular
 ```
 
+**Note about versions**:
+
+- For Angular v9, please use keycloak-angular v7.3 or higher.
+- For Angular v8 and bellow, keycloak-angular v7.2.
+
 ### keycloak-js
 
 > Since keycloak-angular v.7.0.0, the [keycloak-js](https://www.npmjs.com/package/keycloak-js) dependency became a peer dependency. This change allows greater flexibility for choosing the keycloak-js adapter version and follows the [project documentation recommendation](https://www.keycloak.org/docs/latest/securing_apps/index.html#_javascript_adapter).
@@ -83,9 +88,9 @@ import { initializer } from './utils/app-init';
       provide: APP_INITIALIZER,
       useFactory: initializer,
       multi: true,
-      deps: [KeycloakService]
-    }
-  ]
+      deps: [KeycloakService],
+    },
+  ],
 })
 export class AppModule {}
 ```
@@ -111,13 +116,12 @@ The KeycloakService can be initialized before the application loading. When the
 This has two major benefits.
 
 1. This is faster because the application isn't fully bootstrapped and
-1. it prevents a moment when you see the application without having the authorization.
+1. It prevents a moment when you see the application without having the authorization.
 
 #### AppModule
 
 ```js
-import { NgModule } from '@angular/core';
-
+import { NgModule, DoBootstrap, ApplicationRef } from '@angular/core';
 import { KeycloakAngularModule, KeycloakService } from 'keycloak-angular';
 
 const keycloakService = new KeycloakService();
@@ -127,25 +131,29 @@ const keycloakService = new KeycloakService();
   providers: [
     {
       provide: KeycloakService,
-      useValue: keycloakService
-    }
+      useValue: keycloakService,
+    },
   ],
-  entryComponents: [AppComponent]
+  entryComponents: [AppComponent],
 })
-export class AppModule {
-  ngDoBootstrap(app) {
+export class AppModule implements DoBootstrap {
+  ngDoBootstrap(appRef: ApplicationRef) {
     keycloakService
       .init()
       .then(() => {
         console.log('[ngDoBootstrap] bootstrap app');
 
-        app.bootstrap(AppComponent);
+        appRef.bootstrap(AppComponent);
       })
-      .catch(error => console.error('[ngDoBootstrap] init Keycloak failed', error));
+      .catch((error) =>
+        console.error('[ngDoBootstrap] init Keycloak failed', error)
+      );
   }
 }
 ```
 
+**Hint:** Do not forget to remove `bootstrap: [AppComponent]` from NgModule decorator options.
+
 ### Keycloak
 
 Besides configuring the keycloak lib in your application it is also necessary to setup the
@@ -172,8 +180,8 @@ Example:
 
 ```js
 import { Injectable } from '@angular/core';
-import {CanActivate, ActivatedRouteSnapshot, RouterStateSnapshot, Router} from '@angular/router';
-import {KeycloakAuthGuard, KeycloakService} from 'keycloak-angular';
+import { CanActivate, ActivatedRouteSnapshot, RouterStateSnapshot, Router } from '@angular/router';
+import { KeycloakAuthGuard, KeycloakService } from 'keycloak-angular';
 
 @Injectable({
   providedIn: 'root'
@@ -217,14 +225,14 @@ try {
     config: {
       url: 'http://localhost:8080/auth',
       realm: 'your-realm',
-      clientId: 'client-id'
+      clientId: 'client-id',
     },
     initOptions: {
       onLoad: 'login-required',
-      checkLoginIframe: false
+      checkLoginIframe: false,
     },
     enableBearerInterceptor: true,
-    bearerExcludedUrls: ['/assets', '/clients/public']
+    bearerExcludedUrls: ['/assets', '/clients/public'],
   });
   resolve();
 } catch (error) {}
@@ -235,12 +243,12 @@ try {
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 
 <!-- prettier-ignore -->
- |[<img src="https://avatars3.githubusercontent.com/u/676270?v=4" width="100px;"/><br /><sub><b>Mauricio Gemelli Vigolo</b></sub>](https://github.com/mauriciovigolo)<br />|[<img src="https://avatars0.githubusercontent.com/u/2146903?v=4" width="100px;"/><br /><sub><b>Frederik Prijck</b></sub>](https://github.com/frederikprijck)<br /> | [<img src="https://avatars2.githubusercontent.com/u/161351?s=460&v=4" width="100px;"/><br /><sub><b>Jonathan Share</b></sub>](https://github.com/sharebear)<br /> | [<img src="https://avatars1.githubusercontent.com/u/980278?v=4" width="100px;"/><br /><sub><b>jmparra</b></sub>](https://github.com/jmparra)<br /> | [<img src="https://avatars2.githubusercontent.com/u/6547340?v=4" width="100px;"/><br /><sub><b>Marcel Német</b></sub>](https://github.com/marcelnem)<br /> | [<img src="https://avatars3.githubusercontent.com/u/14264577?v=4" width="100px;"/><br /><sub><b>Raphael Alex Silva Abreu</b></sub>](https://github.com/aelkz)<br /> |
-| :---: | :---: | :---: | :---: | :---: | :---: |
+ |[<img src="https://avatars3.githubusercontent.com/u/676270?v=4" width="89px;"/><br /><sub><b>Mauricio Gemelli Vigolo</b></sub>](https://github.com/mauriciovigolo)<br />|[<img src="https://avatars1.githubusercontent.com/u/695720?s=400&v=4" width="89px;"/><br /><sub><b>Jon Koops</b></sub>](https://github.com/https://github.com/jonkoops)<br />|[<img src="https://avatars0.githubusercontent.com/u/2146903?v=4" width="89px;"/><br /><sub><b>Frederik Prijck</b></sub>](https://github.com/frederikprijck)<br /> | [<img src="https://avatars2.githubusercontent.com/u/161351?s=460&v=4" width="89px;"/><br /><sub><b>Jonathan Share</b></sub>](https://github.com/sharebear)<br /> | [<img src="https://avatars1.githubusercontent.com/u/980278?v=4" width="89px;"/><br /><sub><b>jmparra</b></sub>](https://github.com/jmparra)<br /> | [<img src="https://avatars2.githubusercontent.com/u/6547340?v=4" width="89px;"/><br /><sub><b>Marcel Német</b></sub>](https://github.com/marcelnem)<br /> | [<img src="https://avatars3.githubusercontent.com/u/14264577?v=4" width="89px;"/><br /><sub><b>Raphael Alex Silva Abreu</b></sub>](https://github.com/aelkz)<br /> |
+| :---: | :---: | :---: | :---: | :---: | :---: |:---: |
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-If you want to contribute to the project, please check out the [contributing](docs/CONTRIBUTING.md)
+If you want to contribute to the project, please check out the [contributing](docs/contributing.md)
 document.
 
 ## License