@ackplus/nest-auth

A powerful, modular authentication and user management system for NestJS.

Features

• � Complete Auth System - Login, generic registration, password recovery, verification.
• � Multi-Factor Authentication - Built-in TOTP (Authenticator App) support.
• � Social Authentication - Google, Facebook, Apple, GitHub integration.
• 🏢 Multi-Tenancy - Built-in tenant isolation and management.
• � RBAC - Role-Based Access Control with dynamic permissions.
• 🍪 Flexible Session Management - Support for JWTs via Cookies or Headers.
• � Device Management - Trusted device tracking.

Installation

npm install @ackplus/nest-auth
# or
pnpm add @ackplus/nest-auth

Peer Dependencies

npm install @nestjs/common @nestjs/core @nestjs/typeorm typeorm class-validator class-transformer reflect-metadata @nestjs/event-emitter @nestjs/swagger

Optional Dependencies (Social Auth)

If you plan to use social authentication providers:

# Google
npm install google-auth-library

# Facebook
npm install fb

# Apple
npm install apple-auth

Quick Start

1. Import Module

import { Module } from '@nestjs/common';
import { NestAuthModule } from '@ackplus/nest-auth';

@Module({
  imports: [
    NestAuthModule.forRoot({
      isGlobal: true,
      session: {
        accessTokenExpiry: '15m',
        refreshTokenExpiry: '7d',
      },
      // ... other config
    }),
  ],
})
export class AppModule {}

2. Guard Routes

import { Controller, Get, UseGuards } from '@nestjs/common';
import { NestAuthAuthGuard } from '@ackplus/nest-auth';

@Controller('profile')
export class ProfileController {
  
  @Get()
  @UseGuards(NestAuthAuthGuard)
  getProfile(@Req() req) {
    return req.user;
  }
}

Configuration

Social Providers

NestAuthModule.forRoot({
  google: {
    clientId: '...',
    clientSecret: '...',
  },
  facebook: {
    appId: '...',
    appSecret: '...',
  },
  // ...
})

Email / SMPT

To enable email verification and password resets:

NestAuthModule.forRoot({
  mail: {
    driver: 'smtp',
    host: 'smtp.example.com',
    // ...
  }
})

Documentation

For full documentation covering RBAC, Tenants, and advanced configuration, please refer to the official docs (link to be added).

License

MIT