@flusys/nestjs-auth 1.0.0-beta → 1.0.0

package/fesm/controllers/authentication.controller.js

@@ -26,35 +26,56 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 import { CurrentUser } from '@flusys/nestjs-shared/decorators';
+import { MessageResponseDto } from '@flusys/nestjs-shared/dtos';
 import { JwtAuthGuard } from '@flusys/nestjs-shared/guards';
 import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
-import { Body, Controller, Get, HttpCode, HttpStatus, Inject, Optional, Post, Req, UnauthorizedException, UseGuards, UseInterceptors } from '@nestjs/common';
-import { ApiBearerAuth, ApiBody, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { Body, Controller, HttpCode, HttpStatus, Inject, Optional, Post, Req, UnauthorizedException, UseGuards, UseInterceptors } from '@nestjs/common';
+import { ApiBearerAuth, ApiBody, ApiExtraModels, ApiHeader, ApiOperation, ApiResponse, ApiTags, getSchemaPath } from '@nestjs/swagger';
+import { SkipThrottle, Throttle } from '@nestjs/throttler';
 import { Request } from 'express';
-import { ChangePasswordDto, CompanySelectionResponseDto, LoginDto, LoginResponseDto, MeResponseDto, RefreshTokenDto, RegistrationDto, RegistrationResponseDto } from '../dtos/authentication.dto';
+import { DEFAULT_COOKIE_NAME } from '../config';
+import { ChangePasswordDto, CompanySelectionResponseDto, ForgotPasswordDto, LoginDto, LoginResponseDto, LoginResponseRequiresEmailVerificationDto, MeResponseDto, RefreshTokenDto, RegistrationDto, RegistrationResponseDto, ResendVerificationDto, ResetPasswordDto, VerifyEmailDto } from '../dtos/authentication.dto';
 import { ClearToken } from '../interceptors/clear-token.interceptor';
 import { SetToken } from '../interceptors/set-token.interceptor';
 import { AuthConfigService } from '../services/auth-config.service';
+import { AuthEmailService } from '../services/auth-email.service';
 import { AuthenticationService } from '../services/authentication.service';
 export class AuthenticationController {
-    // Core Endpoints
-    /** Login - Returns tokens or company/branch selection requirement */ async login(loginDto) {
+    buildAuthUrl(req, path) {
+        const frontendUrl = this.authConfig?.getFrontendUrl();
+        return frontendUrl ? `${frontendUrl}${path}` : `${req.protocol}://${req.get('host')}${path}`;
+    }
+    get emailService() {
+        if (!this.authEmailService) {
+            throw new Error('Email service is not configured');
+        }
+        return this.authEmailService;
+    }
+    get isEmailEnabled() {
+        return !!this.authEmailService;
+    }
+    async login(loginDto) {
         const result = await this.authService.login(loginDto.email, loginDto.password);
+        if ('requiresEmailVerification' in result) {
+            return result;
+        }
         if ('requiresSelection' in result) {
             return result;
         }
         return result;
     }
-    /** Register new user. If company feature enabled, can join/create company. */ async register(registrationDto) {
-        const result = await this.authService.register(registrationDto);
-        return {
-            ...result,
-            companyFeatureEnabled: this.authConfig?.isCompanyFeatureEnabled() ?? false
-        };
+    /** Register new user. If company feature enabled, can join/create company. */ async register(req, registrationDto) {
+        const verifyUrlBase = this.buildAuthUrl(req, '/auth/verify-email');
+        const result = await this.authService.register(registrationDto, verifyUrlBase);
+        return result;
     }
-    /** Refresh access token. Browser uses HTTP-only cookie, API/Mobile uses request body. */ async refreshToken(req, refreshTokenDto) {
-        // Get refresh token from cookie (browser) or body (API/mobile)
-        const cookieName = this.authConfig?.getRefreshTokenCookieName() ?? 'fsn_refresh_token';
+    /**
+   * Refresh access token.
+   * - **Browser**: Prefers HTTP-only cookie, falls back to body if cookie missing.
+   * - **API/Mobile**: Must send `refreshToken` in request body. Set header `x-client-type: mobile` or `x-client-type: api`.
+   */ async refreshToken(req, refreshTokenDto) {
+        const cookieName = this.authConfig?.getRefreshTokenCookieName() ?? DEFAULT_COOKIE_NAME;
+        // Always check cookie first, then body - handles Browser, SSR, and Mobile/API
         const refreshToken = req.cookies?.[cookieName] || refreshTokenDto.refreshToken;
         if (!refreshToken) {
             throw new UnauthorizedException('Refresh token is required');
@@ -67,26 +88,78 @@ export class AuthenticationController {
     /** Logout - Clears refresh token cookie for browsers */ async logout(userId) {
         await this.authService.logout(userId);
         return {
+            success: true,
             message: 'Logged out successfully'
         };
     }
-    /** Change password */ async changePassword(userId, dto) {
+    async changePassword(userId, dto) {
         await this.authService.changePassword(userId, dto.currentPassword, dto.newPassword);
         return {
+            success: true,
             message: 'Password changed successfully'
         };
     }
-    // NOTE: @Inject() required for bundled code - type metadata may be lost during esbuild
-    constructor(authService, authConfig){
+    async forgotPassword(req, dto) {
+        if (!this.isEmailEnabled) {
+            return {
+                success: false,
+                message: 'Email service is not configured'
+            };
+        }
+        return this.emailService.forgotPassword(dto.email, this.buildAuthUrl(req, '/auth/reset-password'));
+    }
+    async resetPassword(dto) {
+        if (!this.isEmailEnabled) {
+            return {
+                success: false,
+                message: 'Email service is not configured'
+            };
+        }
+        return this.emailService.resetPassword(dto.token, dto.newPassword);
+    }
+    async resendVerification(req, dto) {
+        if (!this.isEmailEnabled) {
+            return {
+                success: false,
+                message: 'Email service is not configured'
+            };
+        }
+        return this.emailService.resendVerificationEmail(dto.email, this.buildAuthUrl(req, '/auth/verify-email'));
+    }
+    /** Verify email - Verify email using token. Handles both pending registration and existing user verification. */ async verifyEmail(dto) {
+        if (!this.isEmailEnabled) {
+            return {
+                success: false,
+                message: 'Email service is not configured'
+            };
+        }
+        const result = await this.emailService.verifyEmail(dto.token);
+        if (result.type === 'pending') {
+            return this.authService.createUserFromPendingRegistration(result.pending);
+        }
+        return {
+            success: true,
+            message: result.message
+        };
+    }
+    constructor(authService, authConfig, authEmailService){
         _define_property(this, "authService", void 0);
         _define_property(this, "authConfig", void 0);
+        _define_property(this, "authEmailService", void 0);
         this.authService = authService;
         this.authConfig = authConfig;
+        this.authEmailService = authEmailService;
     }
 }
 _ts_decorate([
     Post('login'),
     HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 5,
+            ttl: 60000
+        }
+    }),
     UseInterceptors(SetToken),
     ApiOperation({
         summary: 'User login'
@@ -94,13 +167,102 @@ _ts_decorate([
     ApiBody({
         type: LoginDto
     }),
+    ApiExtraModels(LoginResponseDto, CompanySelectionResponseDto, LoginResponseRequiresEmailVerificationDto),
     ApiResponse({
         status: 200,
-        type: LoginResponseDto
-    }),
-    ApiResponse({
-        status: 200,
-        type: CompanySelectionResponseDto
+        description: 'Login successful, requires company selection, or requires email verification',
+        content: {
+            'application/json': {
+                schema: {
+                    oneOf: [
+                        {
+                            $ref: getSchemaPath(LoginResponseDto)
+                        },
+                        {
+                            $ref: getSchemaPath(CompanySelectionResponseDto)
+                        },
+                        {
+                            $ref: getSchemaPath(LoginResponseRequiresEmailVerificationDto)
+                        }
+                    ]
+                },
+                examples: {
+                    loginSuccess: {
+                        summary: 'Login Success',
+                        description: 'Successful login with tokens (company/branch included when company feature enabled)',
+                        value: {
+                            accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+                            refreshToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+                            user: {
+                                id: '550e8400-e29b-41d4-a716-446655440000',
+                                email: 'john@example.com',
+                                name: 'John Doe'
+                            }
+                        }
+                    },
+                    loginSuccessWithCompany: {
+                        summary: 'Login Success (Company Feature)',
+                        description: 'Login with company/branch - only when company feature is enabled',
+                        value: {
+                            accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+                            refreshToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+                            user: {
+                                id: '550e8400-e29b-41d4-a716-446655440000',
+                                email: 'john@example.com',
+                                name: 'John Doe'
+                            },
+                            company: {
+                                id: '550e8400-e29b-41d4-a716-446655440001',
+                                name: 'Acme Corporation',
+                                slug: 'acme-corp'
+                            },
+                            branch: {
+                                id: '550e8400-e29b-41d4-a716-446655440002',
+                                name: 'Main Branch',
+                                slug: 'main-branch'
+                            }
+                        }
+                    },
+                    companySelection: {
+                        summary: 'Company Selection Required (Company Feature)',
+                        description: 'User has multiple companies/branches - only when company feature is enabled',
+                        value: {
+                            requiresSelection: true,
+                            sessionId: 'sess_abc123def456',
+                            expiresAt: '2024-12-18T15:30:00.000Z',
+                            user: {
+                                id: '550e8400-e29b-41d4-a716-446655440000',
+                                email: 'john@example.com',
+                                name: 'John Doe'
+                            },
+                            companies: [
+                                {
+                                    id: '550e8400-e29b-41d4-a716-446655440001',
+                                    name: 'Company A',
+                                    slug: 'company-a',
+                                    branches: [
+                                        {
+                                            id: '550e8400-e29b-41d4-a716-446655440010',
+                                            name: 'Branch 1',
+                                            slug: 'branch-1'
+                                        }
+                                    ]
+                                }
+                            ]
+                        }
+                    },
+                    emailVerification: {
+                        summary: 'Email Verification Required',
+                        description: 'User must verify email before logging in',
+                        value: {
+                            requiresEmailVerification: true,
+                            email: 'john@example.com',
+                            message: 'Please verify your email address before logging in.'
+                        }
+                    }
+                }
+            }
+        }
     }),
     _ts_param(0, Body()),
     _ts_metadata("design:type", Function),
@@ -112,6 +274,12 @@ _ts_decorate([
 _ts_decorate([
     Post('register'),
     HttpCode(HttpStatus.CREATED),
+    Throttle({
+        default: {
+            limit: 3,
+            ttl: 60000
+        }
+    }),
     UseInterceptors(SetToken),
     ApiOperation({
         summary: 'Register new user'
@@ -123,9 +291,11 @@ _ts_decorate([
         status: 201,
         type: RegistrationResponseDto
     }),
-    _ts_param(0, Body()),
+    _ts_param(0, Req()),
+    _ts_param(1, Body()),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [
+        typeof Request === "undefined" ? Object : Request,
         typeof RegistrationDto === "undefined" ? Object : RegistrationDto
     ]),
     _ts_metadata("design:returntype", Promise)
@@ -133,11 +303,50 @@ _ts_decorate([
 _ts_decorate([
     Post('refresh'),
     HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 30,
+            ttl: 60000
+        }
+    }),
     ApiOperation({
-        summary: 'Refresh access token'
+        summary: 'Refresh access token',
+        description: `
+**Browser clients**: Refresh token is read from HTTP-only cookie (automatically set on login/register).
+Falls back to request body if cookie is not available.
+
+**API/Mobile clients**: Must send \`refreshToken\` in request body.
+Set header \`x-client-type: mobile\` or \`x-client-type: api\` to identify as non-browser client.
+
+**Client detection**: Uses \`x-client-type\` header first, then falls back to User-Agent detection.
+    `
+    }),
+    ApiHeader({
+        name: 'x-client-type',
+        required: false,
+        description: 'Client type: "browser"/"web" for cookie-based auth, "mobile"/"api" for body-based auth',
+        example: 'mobile'
     }),
     ApiBody({
-        type: RefreshTokenDto
+        type: RefreshTokenDto,
+        description: 'Required for API/Mobile clients. Browser clients prefer HTTP-only cookie with body fallback.'
+    }),
+    ApiResponse({
+        status: 200,
+        description: 'New access token',
+        schema: {
+            type: 'object',
+            properties: {
+                accessToken: {
+                    type: 'string',
+                    example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+                }
+            }
+        }
+    }),
+    ApiResponse({
+        status: 401,
+        description: 'Invalid or missing refresh token'
     }),
     _ts_param(0, Req()),
     _ts_param(1, Body()),
@@ -150,7 +359,8 @@ _ts_decorate([
 ], AuthenticationController.prototype, "refreshToken", null);
 _ts_decorate([
     UseGuards(JwtAuthGuard),
-    Get('me'),
+    Post('me'),
+    SkipThrottle(),
     ApiBearerAuth(),
     ApiOperation({
         summary: 'Get current user info'
@@ -170,11 +380,16 @@ _ts_decorate([
     UseGuards(JwtAuthGuard),
     Post('logout'),
     HttpCode(HttpStatus.OK),
+    SkipThrottle(),
     UseInterceptors(ClearToken),
     ApiBearerAuth(),
     ApiOperation({
         summary: 'Logout user'
     }),
+    ApiResponse({
+        status: 200,
+        type: MessageResponseDto
+    }),
     _ts_param(0, CurrentUser('id')),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [
@@ -186,6 +401,12 @@ _ts_decorate([
     UseGuards(JwtAuthGuard),
     Post('change-password'),
     HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 5,
+            ttl: 60000
+        }
+    }),
     ApiBearerAuth(),
     ApiOperation({
         summary: 'Change password'
@@ -193,6 +414,10 @@ _ts_decorate([
     ApiBody({
         type: ChangePasswordDto
     }),
+    ApiResponse({
+        status: 200,
+        type: MessageResponseDto
+    }),
     _ts_param(0, CurrentUser('id')),
     _ts_param(1, Body()),
     _ts_metadata("design:type", Function),
@@ -202,15 +427,131 @@ _ts_decorate([
     ]),
     _ts_metadata("design:returntype", Promise)
 ], AuthenticationController.prototype, "changePassword", null);
+_ts_decorate([
+    Post('forgot-password'),
+    HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 3,
+            ttl: 300000
+        }
+    }),
+    ApiOperation({
+        summary: 'Request password reset email'
+    }),
+    ApiBody({
+        type: ForgotPasswordDto
+    }),
+    ApiResponse({
+        status: 200,
+        type: MessageResponseDto
+    }),
+    _ts_param(0, Req()),
+    _ts_param(1, Body()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof Request === "undefined" ? Object : Request,
+        typeof ForgotPasswordDto === "undefined" ? Object : ForgotPasswordDto
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], AuthenticationController.prototype, "forgotPassword", null);
+_ts_decorate([
+    Post('reset-password'),
+    HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 5,
+            ttl: 900000
+        }
+    }),
+    ApiOperation({
+        summary: 'Reset password using token'
+    }),
+    ApiBody({
+        type: ResetPasswordDto
+    }),
+    ApiResponse({
+        status: 200,
+        type: MessageResponseDto
+    }),
+    _ts_param(0, Body()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof ResetPasswordDto === "undefined" ? Object : ResetPasswordDto
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], AuthenticationController.prototype, "resetPassword", null);
+_ts_decorate([
+    Post('resend-verification'),
+    HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 3,
+            ttl: 300000
+        }
+    }),
+    ApiOperation({
+        summary: 'Resend email verification link'
+    }),
+    ApiBody({
+        type: ResendVerificationDto
+    }),
+    ApiResponse({
+        status: 200,
+        type: MessageResponseDto
+    }),
+    _ts_param(0, Req()),
+    _ts_param(1, Body()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof Request === "undefined" ? Object : Request,
+        typeof ResendVerificationDto === "undefined" ? Object : ResendVerificationDto
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], AuthenticationController.prototype, "resendVerification", null);
+_ts_decorate([
+    Post('verify-email'),
+    HttpCode(HttpStatus.OK),
+    Throttle({
+        default: {
+            limit: 10,
+            ttl: 60000
+        }
+    }),
+    UseInterceptors(SetToken),
+    ApiOperation({
+        summary: 'Verify email using token'
+    }),
+    ApiBody({
+        type: VerifyEmailDto
+    }),
+    ApiResponse({
+        status: 200,
+        type: MessageResponseDto
+    }),
+    ApiResponse({
+        status: 200,
+        type: RegistrationResponseDto
+    }),
+    _ts_param(0, Body()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof VerifyEmailDto === "undefined" ? Object : VerifyEmailDto
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], AuthenticationController.prototype, "verifyEmail", null);
 AuthenticationController = _ts_decorate([
     ApiTags('Authentication'),
     Controller('auth'),
     _ts_param(0, Inject(AuthenticationService)),
     _ts_param(1, Optional()),
     _ts_param(1, Inject(AuthConfigService)),
+    _ts_param(2, Optional()),
+    _ts_param(2, Inject(AuthEmailService)),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [
         typeof AuthenticationService === "undefined" ? Object : AuthenticationService,
-        typeof AuthConfigService === "undefined" ? Object : AuthConfigService
+        typeof AuthConfigService === "undefined" ? Object : AuthConfigService,
+        typeof AuthEmailService === "undefined" ? Object : AuthEmailService
     ])
 ], AuthenticationController);

package/fesm/controllers/branch.controller.js

@@ -25,13 +25,56 @@ function _ts_param(paramIndex, decorator) {
         decorator(target, key, paramIndex);
     };
 }
-import { createApiController } from '@flusys/nestjs-shared/classes';
+import { createApiController, BRANCH_PERMISSIONS } from '@flusys/nestjs-shared/classes';
 import { Controller, Inject } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import { CompanyBranchResponseDto, CreateCompanyBranchDto, UpdateCompanyBranchDto } from '../dtos/company-branch.dto';
 import { BranchService } from '../services/branch.service';
 export class BranchController extends createApiController(CreateCompanyBranchDto, UpdateCompanyBranchDto, CompanyBranchResponseDto, {
-    security: 'jwt'
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                BRANCH_PERMISSIONS.DELETE
+            ]
+        }
+    }
 }) {
     constructor(branchService){
         super(branchService), _define_property(this, "branchService", void 0), this.branchService = branchService;

package/fesm/controllers/company-selection.controller.js

@@ -26,42 +26,35 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 import { CurrentUser } from '@flusys/nestjs-shared/decorators';
-import { Body, Controller, Get, HttpCode, HttpStatus, Inject, Param, Post, UseGuards, UseInterceptors } from '@nestjs/common';
+import { Body, Controller, HttpCode, HttpStatus, Inject, Post, UseGuards, UseInterceptors } from '@nestjs/common';
 import { ApiBearerAuth, ApiBody, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { LoginResponseDto, SelectDto, SwitchCompanyDto } from '../dtos/authentication.dto';
 import { JwtAuthGuard } from '@flusys/nestjs-shared/guards';
 import { SetToken } from '../interceptors/set-token.interceptor';
 import { AuthenticationService } from '../services/authentication.service';
 export class CompanySelectionController {
-    /**
-   * Select Company & Branch
-   * Used after login when user needs to select company and branch
-   */ async select(dto) {
+    async select(dto) {
         return this.authService.select(dto.sessionId, dto.companyId, dto.branchId);
     }
-    /**
-   * Switch Company/Branch
-   * Used to switch company/branch after already logged in
-   */ async switchCompany(userId, dto) {
+    async switchCompany(userId, dto) {
         return this.authService.switchCompany(userId, dto.companyId, dto.branchId);
     }
-    /**
-   * Get user's companies
-   */ async getUserCompanies(userId) {
+    async getUserCompanies(userId) {
         const companies = await this.authService.getUserCompanies(userId);
         return {
-            companies
+            success: true,
+            message: 'User companies retrieved successfully',
+            data: companies
         };
     }
-    /**
-   * Get branches for a specific company
-   */ async getUserBranches(userId, companyId) {
+    async getUserBranches(userId, companyId) {
         const branches = await this.authService.getUserBranches(userId, companyId);
         return {
-            branches
+            success: true,
+            message: 'Company branches retrieved successfully',
+            data: branches
         };
     }
-    // NOTE: @Inject() required for bundled code - type metadata may be lost during esbuild
     constructor(authService){
         _define_property(this, "authService", void 0);
         this.authService = authService;
@@ -117,7 +110,8 @@ _ts_decorate([
 ], CompanySelectionController.prototype, "switchCompany", null);
 _ts_decorate([
     UseGuards(JwtAuthGuard),
-    Get('companies'),
+    Post('get-companies'),
+    HttpCode(HttpStatus.OK),
     ApiBearerAuth(),
     ApiOperation({
         summary: "Get user's available companies",
@@ -132,14 +126,27 @@ _ts_decorate([
 ], CompanySelectionController.prototype, "getUserCompanies", null);
 _ts_decorate([
     UseGuards(JwtAuthGuard),
-    Get('companies/:companyId/branches'),
+    Post('get-company-branches'),
+    HttpCode(HttpStatus.OK),
     ApiBearerAuth(),
     ApiOperation({
         summary: 'Get branches for a company',
         description: 'Get list of branches for a specific company that the user has access to'
     }),
+    ApiBody({
+        schema: {
+            properties: {
+                companyId: {
+                    type: 'string'
+                }
+            },
+            required: [
+                'companyId'
+            ]
+        }
+    }),
     _ts_param(0, CurrentUser('id')),
-    _ts_param(1, Param('companyId')),
+    _ts_param(1, Body('companyId')),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [
         String,