From 81dede8084e048fa82c7eac11e6171c4e5920541 Mon Sep 17 00:00:00 2001 From: Mauricio Vigolo Date: Mon, 23 Dec 2024 01:08:35 -0300 Subject: [PATCH] feat: fix links to repository docs --- README.md | 4 ++-- docs/release-notes/v19-0-0.md | 30 +++----------------------- docs/release-notes/v19-0-1.md | 23 ++++++++++++++++++++ package.json | 2 +- projects/keycloak-angular/package.json | 2 +- 5 files changed, 30 insertions(+), 31 deletions(-) create mode 100644 docs/release-notes/v19-0-1.md diff --git a/README.md b/README.md index 7c6b926..b102c0c 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ If you want to know more about these options and various other capabilities of t > If your application relies on NgModules, the library still has support for it. See more information on how to configure a [NgModule the application](https://github.com/mauriciovigolo/keycloak-angular/docs/ngmodule.md). **Additional Resources** -For more details, refer to the [provideKeycloak](https://github.com/mauriciovigolo/keycloak-angular/docs/provide.md) documentation. +For more details, refer to the [provideKeycloak](https://github.com/mauriciovigolo/keycloak-angular/blob/main/docs/provide.md) documentation. ## Example project @@ -278,7 +278,7 @@ export const appConfig: ApplicationConfig = { ``` **Additional Resources** -For more details on the available interceptors and their configurations, refer to the [Keycloak HttpClient Interceptors](https://github.com/mauriciovigolo/keycloak-angular/docs/interceptors.md) documentation. +For more details on the available interceptors and their configurations, refer to the [Keycloak HttpClient Interceptors](https://github.com/mauriciovigolo/keycloak-angular/blob/main/docs/interceptors.md) documentation. ## Directives diff --git a/docs/release-notes/v19-0-0.md b/docs/release-notes/v19-0-0.md index 5c0f524..240338a 100644 --- a/docs/release-notes/v19-0-0.md +++ b/docs/release-notes/v19-0-0.md @@ -1,29 +1,5 @@ -# Keycloak-Angular v19 🚀 +# v19.0.1 -We’re thrilled to release **Keycloak-Angular v19**, packed with modern features and improvements for Angular applications. 🎉 +## ✨ Features -## ✨ Key Highlights - -- **Functional Configuration**: Simplify setup with `provideKeycloak`—no more `KeycloakService` or `KeycloakAngularModule`. -- **Angular Signals**: Reactive handling of Keycloak events for a cleaner, modern approach. -- **Enhanced Interceptors**: Add tokens with explicit configuration using `includeBearerTokenInterceptor` and `customBearerTokenInterceptor`. -- **Role-Based Rendering**: New `*kaHasRoles` directive for conditional rendering based on roles. -- **Modular Features**: Introduced `withAutoRefreshToken` for seamless token refresh and session management. -- **Functional Route Guards**: Create custom guards with `createAuthGuard` for streamlined route protection. - -## ⚠️ Breaking Changes - -- Deprecated `KeycloakService`, `KeycloakAngularModule`, `KeycloakAuthGuard`, and `keycloakEvents$`. -- Bearer tokens are no longer added automatically to all HTTP requests—explicit configuration required. - -## 🛠️ Legacy Version Still Bundled - -The legacy implementation of Keycloak-Angular (`KeycloakService`, `KeycloakAngularModule`, etc.) is still bundled in this release for backward compatibility. However, **it is deprecated** and will be removed in a future major version. We strongly encourage migrating to the new APIs. - -## 🛠️ Migration Guide - -- Migrate to `provideKeycloak` for setup. -- Replace RxJS-based `keycloakEvents$` with Angular Signals. -- Use `*kaHasRoles` for role-based DOM rendering. - -For full details, see the [migration guide](https://github.com/mauriciovigolo/keycloak-angular/docs/migration-guides/v19.md). 🚀 +- **Fix links in documentation**: fix GitHub repository links with the wrong documentation URL. diff --git a/docs/release-notes/v19-0-1.md b/docs/release-notes/v19-0-1.md new file mode 100644 index 0000000..d5ba356 --- /dev/null +++ b/docs/release-notes/v19-0-1.md @@ -0,0 +1,23 @@ +# v19.0.0 + +## ✨ Key Highlights + +- **Functional Configuration**: Simplify setup with `provideKeycloak`—no more `KeycloakService` or `KeycloakAngularModule`. +- **Angular Signals**: Reactive handling of Keycloak events for a cleaner, modern approach. +- **Enhanced Interceptors**: Add tokens with explicit configuration using `includeBearerTokenInterceptor` and `customBearerTokenInterceptor`. +- **Role-Based Rendering**: New `*kaHasRoles` directive for conditional rendering based on roles. +- **Modular Features**: Introduced `withAutoRefreshToken` for seamless token refresh and session management. +- **Functional Route Guards**: Create custom guards with `createAuthGuard` for streamlined route protection. + +## ⚠️ Breaking Changes + +- Deprecated `KeycloakService`, `KeycloakAngularModule`, `KeycloakAuthGuard`, and `keycloakEvents$`. +- Bearer tokens are no longer added automatically to all HTTP requests—explicit configuration required. + +## 🛠️ Legacy Version Still Bundled + +The legacy implementation of Keycloak-Angular (`KeycloakService`, `KeycloakAngularModule`, etc.) is still bundled in this release for backward compatibility. However, **it is deprecated** and will be removed in a future major version. We strongly encourage migrating to the new APIs. + +## 🛠️ Migration Guide + +For full details, see the [migration guide](https://github.com/mauriciovigolo/keycloak-angular/blob/main/docs/migration-guides/v19.md). 🚀 diff --git a/package.json b/package.json index a616f75..c00b1ce 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "keycloak-angular", - "version": "19.0.0", + "version": "19.0.1", "description": "Easy Keycloak setup for Angular applications", "scripts": { "build": "ng build keycloak-angular --configuration production", diff --git a/projects/keycloak-angular/package.json b/projects/keycloak-angular/package.json index 7385b84..f1d3618 100644 --- a/projects/keycloak-angular/package.json +++ b/projects/keycloak-angular/package.json @@ -1,6 +1,6 @@ { "name": "keycloak-angular", - "version": "19.0.0", + "version": "19.0.1", "description": "Easy Keycloak setup for Angular applications", "repository": { "type": "git",