Migrating from KeycloakAngularModule and APP_INITIALIZER to provideKeycloak() in a ngModules app

[Yawarzy]

Hi! We are currently using the Angular 19, and have updated to the keycloak-angular v19. While going through the migration guide, we noticed that the KeycloakAngularModule and the old way of APP_INITIALIZER has been deprecated, and the recommend way is to use the provideKeycloak(). But our apps still rely on the NgModules, and we are not sure if we will be migrating to the standalone. The documentation for the provideKeycloak assumes we are using the latest standalone API with appConfig, bootstrapApplication etc. So any way of configuring via the provideKeycloak() has failed for us.

Could you please let us know if it's recommended and possible to use the new provideKeycloak() with the NgModules. If not, can we keep using the old legacy way of configuration (as long as we are on the NgModules) ? I have read in the release notes, that these may be removed in future.

[Rezorl]

@Yawarzy Did you try something like:

import {importProvidersFrom} from '@angular/core';

@NgModule({
providers: [
importProvidersFrom(provideKeycloak({
      config: {
        url: 'keycloak-server-url',
        realm: 'realm-id',
        clientId: 'client-id'
      },
      initOptions: {
        onLoad: 'check-sso',
        silentCheckSsoRedirectUri: window.location.origin + '/silent-check-sso.html'
      }
    }))
]
})
export class AppModule {}

[Yawarzy]

Thanks for the response, I have tried this but actually our approach is a bit different. We have multiple realms, and what one to use is decided when a user enters it into an input field. Earlier we could provide the config options to the keycloakService.init method. But since we are now injecting the keycloak directly from the keycloak-js, the init method doesn't take this configuration.

So I'm kind of lost regarding what direction I should go in.

[Tomek6789]

The previous solution, based on KeycloakAngularModule (which is marked as deprecated), supported providing dynamic configuration.

I checked the official Angular roadmap and could not find any information about dropping support for NgModules. NgModules are also not marked as deprecated in the @angular/core source code.

Please remove the deprecation notice for KeycloakAngularModule and KeycloakService (at least until there is an official Angular announcement), and provide support for Signals in modular applications.

[Panossa]

Doing what has been suggested was much less possible than converting our entire project (decent size, development over many years) from NgModule to standalone JUST because of keycloak.

The background: our keycloak config depends on some external files that have to be loaded at runtime, thus I couldn't just call "provideKeycloak()" without having read those files before. This was supported in the earlier (deprecated) versions, but not any more.

So if anyone else comes across this and keycloak has still no solution for you, please think about trying it for a few hours. (There are migration scripts provided by Angular themselves for this.)

But yeah, quite annoying that it had to be done.