Skip to content

Commit

Permalink
fix: resolve module resolution issues and update package configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
Med5KDB committed Jul 20, 2024
1 parent 1128e89 commit 2405757
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Keycloak User Manager

The `keycloak-user-manager` package provides an easy way to manage users with Keycloak in a NestJS application. It offers pre-built endpoints for common user management tasks while allowing customization for your own endpoints if needed.
The `nest-keycloak-user-manager` package provides an easy way to manage users with Keycloak in a NestJS application. It offers pre-built endpoints for common user management tasks while allowing customization for your own endpoints if needed.

## Features

Expand All @@ -18,9 +18,9 @@ Module/Boilerplate for simplified user-management w/ [Keycloak](https://www.keyc
To install the package, use npm or yarn:

```bash
npm install keycloak-user-manager
npm install nest-keycloak-user-manager
# or
yarn add keycloak-user-manager
yarn add nest-keycloak-user-manager
```

## Configuration
Expand All @@ -29,7 +29,7 @@ To configure the module, you need to provide the Keycloak connection details in

```typescript
import { Module } from '@nestjs/common';
import { KeycloakUserManagerModule } from 'keycloak-user-manager';
import { KeycloakUserManagerModule } from 'nest-keycloak-user-manager';

@Module({
imports: [
Expand Down Expand Up @@ -88,7 +88,7 @@ If you need to create your own endpoints, you can use the `KeycloakUserManagerSe

```typescript
import { Controller, Post, Body, Put, Param, Get, Delete } from '@nestjs/common';
import { KeycloakUserManagerService } from 'keycloak-user-manager';
import { KeycloakUserManagerService } from 'nest-keycloak-user-manager';
import { AddUserDto, UpdateUserDto } from 'src/dto/custom-users.dto'; // your custom dto

@Controller('custom-users')
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"name": "nest-keycloak-user-manager",
"version": "0.0.2",
"version": "0.0.3",
"description": "",
"main": "dist/main.js",
"types": "dist/main.d.ts",
"author": "Mohamed Lamine Badji <[email protected]>",
"private": false,
"license": "UNLICENSED",
Expand Down
1 change: 1 addition & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from './keycloak-user-manager/keycloak-user-manager.module';
export * from './keycloak-user-manager/keycloak-user-manager.service';
4 changes: 3 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,7 @@
"strictBindCallApply": false,
"forceConsistentCasingInFileNames": false,
"noFallthroughCasesInSwitch": false
}
},
"include": ["src/**/*"],
"exclude": ["node_modules","**/*spec.ts"]
}

0 comments on commit 2405757

Please sign in to comment.