@s3pweb/keycloak-admin-client-cjs/README.md

Keycloak Admin Client compiled in CommonJS.

# Keycloak Admin Client in CommonJS

This lib exports the [@keycloak/keycloak-admin-client](https://www.npmjs.com/package/@keycloak/keycloak-admin-client) 
(an ECMA Script module) as a CommonJS module, so it can be used in NestJS.

This repo is based on an idea by [Manuelbaun](https://github.com/Manuelbaun) on this issue https://github.com/keycloak/keycloak-nodejs-admin-client/issues/523

The version number of this repo will follow the version number of @keycloak/keycloak-admin-client.

## Install

```shell
npm i @s3pweb/keycloak-admin-client-cjs
```

## Usage

```ts
import { KeycloakAdminClient } from '@s3pweb/keycloak-admin-client-cjs';

@Injectable()
export class KeycloakService {
    private readonly kcAdminClient: KeycloakAdminClient;

    constructor(logger: LoggingService) {
        this.log = logger.getLogger(KeycloackService.name);
        this.kcAdminClient = new KeycloakAdminClient();
    }

}
```

## How to release

First, compile and build the project:

```shell
npm i
npm run prepublish
```

To release a new version, you can use the `release` script with the keycloak-admin-client version as an argument:

```shell
npm run release -- --release-as <NEW_VERSION>
```

Then push the changes and the new tag to the main branch:

```shell
git push origin main --follow-tags
```