hedhog/user

The Hedhog User module in HedHog provides functionality to manage user data within an application. This module leverages the HedHog framework components, including pagination and Prisma integration, to offer a robust user management system.

Installation

This library is an integral part of the HedHog framework and should be installed as a dependency in your HedHog project. Ensure that the necessary dependencies are configured in your HedHog project.

npm i @hedhog/user

Integrations

• Pagination: Utilizes @hedhog/pagination for managing paginated results of user queries.
• Database Interaction: Uses @hedhog/prisma to interface with the database for user data management.
• Authentication: Secured with @hedhog/auth to ensure that only authorized users can access or modify user data.

Controller Endpoints

GET /users

• Description: Retrieve a paginated list of users.
• Authentication: Required (uses AuthGuard).
• Pagination: Supports pagination through query parameters.

GET /users/:userId

• Description: Retrieve a specific user by its ID.
• Authentication: Required (uses AuthGuard).
• Parameters:
  • userId (number): The ID of the user to retrieve.

POST /users

• Description: Create a new user.
• Authentication: Required (uses AuthGuard).
• Body:
  • email (string): Email address of the user.
  • name (string): Name of the user.
  • password (string): Password of the user.

PATCH /users/:userId

• Description: Update an existing user.
• Authentication: Required (uses AuthGuard).
• Parameters:
  • userId (number): The ID of the user to update.
• Body:
  • email (string, optional): Updated email address of the user.
  • name (string, optional): Updated name of the user.
  • password (string, optional): Updated password of the user.

DELETE /users

• Description: Delete one or more users.
• Authentication: Required (uses AuthGuard).
• Body:
  • ids (number[]): Array of user IDs to delete.

Service Methods

getUsers(paginationParams: PaginationDTO)

• Description: Retrieves a paginated list of users with optional search functionality.
• Parameters:
  • paginationParams: Includes pagination and search criteria.

get(userId: number)

• Description: Retrieves a specific user by its ID.
• Parameters:
  • userId: ID of the user to retrieve.

hashPassword(password: string): Promise

• Description: Hashes a password using bcrypt.
• Parameters:
  • password: The password to be hashed.

create(data: CreateDTO)

• Description: Creates a new user.
• Parameters:
  • data: Includes email, name, and password.

update(id: number, data: UpdateDTO)

• Description: Updates an existing user.
• Parameters:
  • id: ID of the user to update.
  • data: Includes updated email, name, and password.

delete(data: DeleteDTO)

• Description: Deletes one or more users.
• Parameters:
  • data: Includes array of user IDs to delete.

Folder Structure

user/
├── dist/                        # Compiled JavaScript files from build
├── node_modules/                # Discardable folder with all module dependencies
├── src/
│   ├── constants/
│   │   └── user.constants.ts    # Constants related to user module
│   ├── dto/
│   │   ├── create.dto.ts        # Data Transfer Object for creating a user
│   │   ├── delete.dto.ts        # Data Transfer Object for deleting a user
│   │   └── update.dto.ts        # Data Transfer Object for updating a user
│   ├── migrations/              # Migration files for database schema changes
|   ├── user.module.ts           # Module for UserService
│   ├── user.service.spec.ts     # Unit tests for UserService
│   ├── user.controller.ts       # Controller for user-related endpoints
│   └── user.service.ts          # Service handling business logic for users
├── .gitignore                   # Specifies which files Git should ignore
├── package.json                 # Manages dependencies and scripts for the module
├── package-lock.json            # Lock file for dependencies
├── README.md                    # Documentation for the library
├── tsconfig.lib.json            # TypeScript configuration for library builds
├── tsconfig.production.json     # TypeScript configuration for production builds