Skip to content

Commit

Permalink
feat: fix links to repository docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mauriciovigolo committed Dec 23, 2024
1 parent c830d28 commit 81dede8
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 31 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
30 changes: 3 additions & 27 deletions docs/release-notes/v19-0-0.md
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 23 additions & 0 deletions docs/release-notes/v19-0-1.md
Original file line number Diff line number Diff line change
@@ -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). 🚀
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion projects/keycloak-angular/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 81dede8

Please sign in to comment.