@ackplus/nest-auth v0.1.32

Nest Auth

A comprehensive authentication module for NestJS applications.

Table of Contents

• Installation
• Quick Start
• Configuration
• Database Setup
• Testing
• Authentication Providers
• API Documentation
• Contributing
• License

Installation

yarn add @ackplus/nest-auth

Quick Start

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

@Module({
  imports: [
    NestAuthModule.forRoot({
      jwt: {
        secret: 'your-secret-key',
      },
      emailAuth: {
        enabled: true,
      },
      // ... other options
    }),
  ],
})
export class AppModule {}

Configuration

Database Configuration

The module supports both PostgreSQL and SQLite databases. Configure your database connection using the DATABASE_URL environment variable:

# For PostgreSQL
DATABASE_URL=postgresql://user:password@localhost:5432/dbname

# For SQLite
DATABASE_URL=:memory:  # For in-memory database
DATABASE_URL=./database.sqlite  # For file-based database

Environment Variables

Module Options

interface AuthModuleOptions {
  jwt: {
    secret: string;
    expiresIn?: string;
  };
  emailAuth?: {
    enabled: boolean;
    // ... other email auth options
  };
  phoneAuth?: {
    enabled: boolean;
    // ... other phone auth options
  };
  // ... other options
}

Database Setup

PostgreSQL

1. Create a new database:

CREATE DATABASE your_database;

2. Run migrations:

yarn typeorm migration:run -d src/typeorm.config.ts

SQLite

No setup required. The database will be created automatically.

Testing

Local Development

1. For PostgreSQL:

DATABASE_URL=postgresql://user:password@localhost:5432/testdb yarn test

2. For SQLite:

DATABASE_URL=:memory: yarn test

CI/CD (GitHub Actions)

The tests run automatically in GitHub Actions using SQLite for faster execution. No additional setup required.

Authentication Providers

Email Authentication

@Post('login')
async login(@Body() loginDto: LoginRequestDto) {
  return this.authService.login({
    providerId: 'email',
    credentials: {
      email: loginDto.email,
      password: loginDto.password,
    },
  });
}

Phone Authentication

@Post('login')
async login(@Body() loginDto: LoginRequestDto) {
  return this.authService.login({
    providerId: 'phone',
    credentials: {
      phone: loginDto.phone,
      password: loginDto.password,
    },
  });
}

API Documentation

Authentication Endpoints

Request/Response Examples

Login Request

{
  "providerId": "email",
  "credentials": {
    "email": "user@example.com",
    "password": "password123"
  }
}

Login Response

{
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
  "isRequiresMfa": false
}

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Setup

1. Clone the repository
2. Install dependencies:

yarn install

3. Set up the database:

# For PostgreSQL
DATABASE_URL=postgresql://user:password@localhost:5432/testdb

# For SQLite
DATABASE_URL=:memory:

4. Run tests:

yarn test

Testing Guidelines

• Write tests for all new features
• Ensure tests pass in both PostgreSQL and SQLite
• Follow the existing test patterns
• Use appropriate test fixtures

License

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