Core Library for NestJS API

This library provides core functionalities for a NestJS API, including authentication, exception handling, guards, interceptors, and storage management. It is designed to be used as a foundational layer for building robust and scalable NestJS applications.

Features

• Authentication: Implement JWT-based authentication with customizable strategies.
• Exception Handling: Centralized exception handling with custom error responses.
• Guards: Custom guards for route protection.
• Interceptors: Request/response interceptors for logging, transformation, and more.
• Storage Management: Utilities for managing file uploads and storage.

Installation

To install the core library, use npm or yarn:

npm install @your-org/nestjs-core

or

yarn add @your-org/nestjs-core

Usage

Authentication

Configure JWT authentication in your app.module.ts:

import { Module } from "@nestjs/common";
import { AuthModule } from "@your-org/nestjs-core";

@Module({
	imports: [
		AuthModule.forRoot({
			secret: "your-jwt-secret",
			signOptions: { expiresIn: "60m" },
		}),
	],
})
export class AppModule {}

Exception Handling

Use the global exception filter provided by the core library:

import { NestFactory } from "@nestjs/core";
import { AppModule } from "./app.module";
import { HttpExceptionFilter } from "@your-org/nestjs-core";

async function bootstrap() {
	const app = await NestFactory.create(AppModule);
	app.useGlobalFilters(new HttpExceptionFilter());
	await app.listen(3000);
}
bootstrap();

Guards

Apply custom guards to your routes:

import { Controller, Get, UseGuards } from "@nestjs/common";
import { JwtAuthGuard } from "@your-org/nestjs-core";

@Controller("protected")
export class ProtectedController {
	@Get()
	@UseGuards(JwtAuthGuard)
	getProtectedResource() {
		return { message: "This is a protected resource" };
	}
}

Interceptors

Use interceptors for logging or transforming responses:

import { Controller, Get, UseInterceptors } from "@nestjs/common";
import { LoggingInterceptor } from "@your-org/nestjs-core";

@Controller("logging")
export class LoggingController {
	@Get()
	@UseInterceptors(LoggingInterceptor)
	getLogging() {
		return { message: "This route is being logged" };
	}
}

Storage Management

Configure and use storage utilities for file uploads:

import { Module } from "@nestjs/common";
import { StorageModule, StorageService } from "@your-org/nestjs-core";

@Module({
	imports: [
		StorageModule.forRoot({
			dest: "./uploads",
		}),
	],
	providers: [StorageService],
})
export class AppModule {}

Configuration

AuthModule

AuthModule.forRoot({
	secret: "your-jwt-secret",
	signOptions: { expiresIn: "60m" },
});

StorageModule

StorageModule.forRoot({
	dest: "./uploads",
});

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or issues, please open an issue on GitHub or contact us at [email protected].