@flusys/nestjs-auth 7.0.2 → 8.0.0-beta.1

package/fesm/controllers/user.controller.spec.js

@@ -1,200 +0,0 @@
-import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
-import { UserController } from './user.controller';
-function buildUser(overrides = {}) {
-    return {
-        id: 'user-1',
-        name: 'Test User',
-        email: 'test@example.com',
-        phone: null,
-        isActive: true,
-        readOnly: false,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-        ...overrides
-    };
-}
-describe('UserController', ()=>{
-    let controller;
-    let mockUserService;
-    beforeEach(()=>{
-        mockUserService = {
-            insert: jest.fn(),
-            insertMany: jest.fn(),
-            findById: jest.fn(),
-            findByIds: jest.fn(),
-            update: jest.fn(),
-            updateMany: jest.fn(),
-            bulkUpsert: jest.fn(),
-            getAll: jest.fn(),
-            delete: jest.fn(),
-            getProfileWithExtras: jest.fn(),
-            verifyEmail: jest.fn(),
-            verifyPhone: jest.fn(),
-            updateStatus: jest.fn(),
-            profile: jest.fn(),
-            getProfileSections: jest.fn(),
-            getProfileSectionData: jest.fn(),
-            updateProfileSection: jest.fn(),
-            getProfileCompletion: jest.fn()
-        };
-        controller = new UserController(mockUserService);
-    });
-    describe('insert', ()=>{
-        it('creates a user and returns the mapped response', async ()=>{
-            const user = buildMockUser();
-            mockUserService.insert.mockResolvedValue(buildUser());
-            const result = await controller.insert({
-                name: 'Test User',
-                email: 'test@example.com',
-                password: 'Password1!'
-            }, user);
-            expect(mockUserService.insert).toHaveBeenCalledWith({
-                name: 'Test User',
-                email: 'test@example.com',
-                password: 'Password1!'
-            }, user);
-            expect(result.success).toBe(true);
-            expect(result.data).toEqual(expect.objectContaining({
-                id: 'user-1'
-            }));
-        });
-    });
-    describe('getAll', ()=>{
-        it('paginates users and maps the response list', async ()=>{
-            mockUserService.getAll.mockResolvedValue({
-                data: [
-                    buildUser()
-                ],
-                total: 1
-            });
-            const result = await controller.getAll({}, buildMockUser(), '');
-            expect(mockUserService.getAll).toHaveBeenCalledWith('', {}, buildMockUser());
-            expect(result.data).toHaveLength(1);
-        });
-    });
-    describe('getProfileWithExtras', ()=>{
-        it('returns the enriched profile payload', async ()=>{
-            const user = buildMockUser();
-            mockUserService.getProfileWithExtras.mockResolvedValue({
-                ...buildUser(),
-                completionPercentage: 80
-            });
-            const result = await controller.getProfileWithExtras('user-1', user);
-            expect(mockUserService.getProfileWithExtras).toHaveBeenCalledWith('user-1', user);
-            expect(result).toEqual({
-                success: true,
-                message: 'Profile extras retrieved successfully',
-                messageKey: expect.any(String),
-                data: expect.objectContaining({
-                    completionPercentage: 80
-                })
-            });
-        });
-    });
-    describe('verifyEmail', ()=>{
-        it('verifies the email and returns a success message', async ()=>{
-            mockUserService.verifyEmail.mockResolvedValue(undefined);
-            const result = await controller.verifyEmail('user-1');
-            expect(mockUserService.verifyEmail).toHaveBeenCalledWith('user-1');
-            expect(result.success).toBe(true);
-        });
-    });
-    describe('verifyPhone', ()=>{
-        it('verifies the phone and returns a success message', async ()=>{
-            mockUserService.verifyPhone.mockResolvedValue(undefined);
-            const result = await controller.verifyPhone('user-1');
-            expect(mockUserService.verifyPhone).toHaveBeenCalledWith('user-1');
-            expect(result.success).toBe(true);
-        });
-    });
-    describe('updateStatus', ()=>{
-        it('updates the active status for the given user', async ()=>{
-            const user = buildMockUser();
-            mockUserService.updateStatus.mockResolvedValue(undefined);
-            const result = await controller.updateStatus('user-1', false, user);
-            expect(mockUserService.updateStatus).toHaveBeenCalledWith('user-1', false, user);
-            expect(result.success).toBe(true);
-        });
-    });
-    describe('profile', ()=>{
-        it('updates the current user profile and returns the data', async ()=>{
-            const user = buildMockUser();
-            mockUserService.profile.mockResolvedValue('user-1');
-            const result = await controller.profile({
-                id: 'user-1',
-                name: 'New Name'
-            }, user);
-            expect(mockUserService.profile).toHaveBeenCalledWith({
-                id: 'user-1',
-                name: 'New Name'
-            }, user);
-            expect(result).toEqual({
-                success: true,
-                message: 'Profile updated successfully',
-                messageKey: expect.any(String),
-                data: 'user-1'
-            });
-        });
-    });
-    describe('getProfileSections', ()=>{
-        it('returns the profile section definitions', async ()=>{
-            mockUserService.getProfileSections.mockResolvedValue([
-                {
-                    id: 's1',
-                    name: 'Basic',
-                    order: 1
-                }
-            ]);
-            const result = await controller.getProfileSections();
-            expect(result.data).toEqual([
-                {
-                    id: 's1',
-                    name: 'Basic',
-                    order: 1
-                }
-            ]);
-        });
-    });
-    describe('getProfileSectionData', ()=>{
-        it('returns data for the requested section', async ()=>{
-            const user = buildMockUser();
-            mockUserService.getProfileSectionData.mockResolvedValue({
-                sectionId: 's1',
-                data: {
-                    foo: 'bar'
-                },
-                isComplete: true
-            });
-            const result = await controller.getProfileSectionData('user-1', 's1', user);
-            expect(mockUserService.getProfileSectionData).toHaveBeenCalledWith('user-1', 's1', user);
-            expect(result.data).toEqual(expect.objectContaining({
-                sectionId: 's1',
-                isComplete: true
-            }));
-        });
-    });
-    describe('updateProfileSection', ()=>{
-        it('updates the requested section', async ()=>{
-            const user = buildMockUser();
-            mockUserService.updateProfileSection.mockResolvedValue(undefined);
-            const result = await controller.updateProfileSection('user-1', 's1', {
-                foo: 'bar'
-            }, user);
-            expect(mockUserService.updateProfileSection).toHaveBeenCalledWith('user-1', 's1', {
-                foo: 'bar'
-            }, user);
-            expect(result.success).toBe(true);
-        });
-    });
-    describe('getProfileCompletion', ()=>{
-        it('returns the completion percentage', async ()=>{
-            const user = buildMockUser();
-            mockUserService.getProfileCompletion.mockResolvedValue(42);
-            const result = await controller.getProfileCompletion('user-1', user);
-            expect(mockUserService.getProfileCompletion).toHaveBeenCalledWith('user-1', user);
-            expect(result.data).toEqual({
-                completionPercentage: 42
-            });
-        });
-    });
-});

package/fesm/docs/auth-swagger.config.js

@@ -1,446 +0,0 @@
-// ============================================================================
-// Company feature exclusions
-// ============================================================================
-const COMPANY_RELATED_TAGS = [
-    'Companies',
-    'Branches',
-    'User Permissions',
-    'Company Selection'
-];
-const COMPANY_SCHEMA_EXCLUSIONS = [
-    // Request DTOs
-    {
-        schemaName: 'RegistrationDto',
-        properties: [
-            'companySlug',
-            'branchSlug',
-            'newCompanyName',
-            'newCompanyPhone',
-            'newCompanyAddress'
-        ]
-    },
-    {
-        schemaName: 'SelectDto',
-        properties: [
-            'sessionId',
-            'companyId',
-            'branchId'
-        ]
-    },
-    {
-        schemaName: 'SwitchCompanyDto',
-        properties: [
-            'companyId',
-            'branchId'
-        ]
-    },
-    // Response DTOs
-    {
-        schemaName: 'RegistrationResponseDto',
-        properties: [
-            'company',
-            'branch'
-        ]
-    },
-    {
-        schemaName: 'LoginResponseDto',
-        properties: [
-            'company',
-            'branch'
-        ]
-    },
-    {
-        schemaName: 'MeResponseDto',
-        properties: [
-            'company',
-            'branch'
-        ]
-    },
-    // Nested helper DTOs
-    {
-        schemaName: 'CompanyInfoDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'logoId'
-        ]
-    },
-    {
-        schemaName: 'BranchInfoDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'logoId'
-        ]
-    },
-    {
-        schemaName: 'BranchSelectionInfoDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'logoId'
-        ]
-    },
-    {
-        schemaName: 'CompanyWithBranchesDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'logoId',
-            'branches'
-        ]
-    },
-    {
-        schemaName: 'CompanySelectionResponseDto',
-        properties: [
-            'requiresSelection',
-            'sessionId',
-            'expiresAt',
-            'user',
-            'companies'
-        ]
-    },
-    // Company management DTOs
-    {
-        schemaName: 'CreateCompanyDto',
-        properties: [
-            'name',
-            'slug',
-            'logoId',
-            'address',
-            'phone',
-            'email',
-            'website',
-            'serial',
-            'isActive',
-            'settings',
-            'additionalFields'
-        ]
-    },
-    {
-        schemaName: 'UpdateCompanyDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'logoId',
-            'address',
-            'phone',
-            'email',
-            'website',
-            'serial',
-            'isActive',
-            'settings',
-            'additionalFields'
-        ]
-    },
-    {
-        schemaName: 'CompanyResponseDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'logoId',
-            'address',
-            'phone',
-            'email',
-            'website',
-            'serial',
-            'isActive',
-            'settings',
-            'additionalFields',
-            'readOnly',
-            'createdAt',
-            'updatedAt'
-        ]
-    },
-    // Branch management DTOs
-    {
-        schemaName: 'CreateCompanyBranchDto',
-        properties: [
-            'name',
-            'slug',
-            'companyId',
-            'parentId',
-            'logoId',
-            'address',
-            'phone',
-            'email',
-            'serial',
-            'isActive',
-            'additionalFields'
-        ]
-    },
-    {
-        schemaName: 'UpdateCompanyBranchDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'companyId',
-            'parentId',
-            'logoId',
-            'address',
-            'phone',
-            'email',
-            'serial',
-            'isActive',
-            'additionalFields'
-        ]
-    },
-    {
-        schemaName: 'CompanyBranchResponseDto',
-        properties: [
-            'id',
-            'name',
-            'slug',
-            'companyId',
-            'parentId',
-            'logoId',
-            'address',
-            'phone',
-            'email',
-            'serial',
-            'isActive',
-            'additionalFields',
-            'readOnly',
-            'createdAt',
-            'updatedAt'
-        ]
-    },
-    // User permission DTOs
-    {
-        schemaName: 'UserCompanyPermissionDto',
-        properties: [
-            'id',
-            'userId',
-            'companyId',
-            'companyName',
-            'companySlug'
-        ]
-    },
-    {
-        schemaName: 'UserBranchPermissionDto',
-        properties: [
-            'id',
-            'userId',
-            'branchId',
-            'branchName',
-            'branchSlug',
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'AssignUserCompanyDto',
-        properties: [
-            'userId',
-            'items'
-        ]
-    },
-    {
-        schemaName: 'AssignUserBranchDto',
-        properties: [
-            'userId',
-            'items'
-        ]
-    },
-    {
-        schemaName: 'PermissionItemDto',
-        properties: [
-            'targetId',
-            'isAdd'
-        ]
-    },
-    {
-        schemaName: 'UserCompaniesResponseDto',
-        properties: [
-            'data'
-        ]
-    },
-    {
-        schemaName: 'UserBranchesResponseDto',
-        properties: [
-            'data'
-        ]
-    }
-];
-const COMPANY_EXAMPLE_EXCLUSIONS = [
-    {
-        pathPattern: '/auth/login',
-        method: 'post',
-        examples: [
-            'loginSuccessWithCompany',
-            'companySelection'
-        ]
-    }
-];
-// ============================================================================
-// Email verification exclusions
-// ============================================================================
-const EMAIL_VERIFICATION_PATHS = [
-    '/auth/forgot-password',
-    '/auth/reset-password',
-    '/auth/resend-verification',
-    '/auth/verify-email'
-];
-const EMAIL_VERIFICATION_SCHEMA_EXCLUSIONS = [
-    {
-        schemaName: 'RegistrationResponseDto',
-        properties: [
-            'requiresEmailVerification'
-        ]
-    },
-    {
-        schemaName: 'LoginResponseRequiresEmailVerificationDto',
-        properties: [
-            'requiresEmailVerification',
-            'email'
-        ]
-    }
-];
-const EMAIL_VERIFICATION_EXAMPLE_EXCLUSIONS = [
-    {
-        pathPattern: '/auth/login',
-        method: 'post',
-        examples: [
-            'emailVerification'
-        ]
-    }
-];
-// ============================================================================
-// Description builder
-// ============================================================================
-function buildDescription(enableCompanyFeature, enableEmailVerification, isMultiTenant) {
-    const multiTenantNote = isMultiTenant ? `\n> **Multi-Tenant Mode**: Include \`x-tenant-id\` header to target a specific tenant database.\n` : '';
-    const features = [
-        '- User registration',
-        '- Login with email/password',
-        '- JWT token-based authentication',
-        ...enableEmailVerification ? [
-            '- Email verification',
-            '- Forgot/reset password'
-        ] : [],
-        ...enableCompanyFeature ? [
-            '- Company/Branch selection flow (multi-company enabled)'
-        ] : [],
-        '- Token refresh',
-        '- Password change'
-    ].join('\n');
-    const loginFlowSection = enableCompanyFeature ? `
-### Authentication Flow
-
-#### Simple Login (single company/branch)
-\`\`\`
-POST /auth/login → { accessToken, refreshToken, user, company, branch }
-\`\`\`
-
-#### Multi-Company Login (multiple companies or branches)
-\`\`\`
-POST /auth/login → { requiresSelection: true, sessionId, companies }
-POST /auth/select → { accessToken, refreshToken, user, company, branch }
-\`\`\`
-${enableEmailVerification ? `
-#### Email Verification Required
-\`\`\`
-POST /auth/login → { requiresEmailVerification: true, email }
-POST /auth/verify-email → { accessToken, refreshToken, user }
-\`\`\`
-` : ''}
-### Company/Branch Selection Endpoints
-- \`POST /auth/select\` - Complete login by selecting company and branch
-- \`POST /auth/switch-company\` - Switch to different company/branch while logged in
-` : `
-### Authentication Flow
-\`\`\`
-POST /auth/login → { accessToken, refreshToken, user }
-\`\`\`
-${enableEmailVerification ? `
-#### Email Verification Required
-\`\`\`
-POST /auth/login → { requiresEmailVerification: true, email }
-POST /auth/verify-email → { accessToken, refreshToken, user }
-\`\`\`
-` : ''}`;
-    const emailVerificationSection = enableEmailVerification ? `
-### Email Verification Endpoints
-- \`POST /auth/forgot-password\` - Request password reset email
-- \`POST /auth/reset-password\` - Reset password using token
-- \`POST /auth/resend-verification\` - Resend verification email
-- \`POST /auth/verify-email\` - Verify email using token
-` : '';
-    const administrationSection = enableCompanyFeature ? `
-### Administration Endpoints
-- \`POST /administration/users/*\` - User management
-- \`POST /administration/company/*\` - Company management
-- \`POST /administration/branch/*\` - Branch management
-- \`POST /administration/user-permissions/*\` - User permission management
-` : `
-### Administration Endpoints
-- \`POST /administration/users/*\` - User management
-`;
-    const registrationSection = enableCompanyFeature ? `
-### Registration Flow
-
-**Simple registration:**
-\`\`\`json
-{ "name": "John Doe", "email": "john@example.com", "password": "password123" }
-\`\`\`
-
-**Join existing company:**
-\`\`\`json
-{ "name": "John Doe", "email": "john@example.com", "password": "password123", "companySlug": "acme-corp", "branchSlug": "main-branch" }
-\`\`\`
-
-**Create new company:**
-\`\`\`json
-{ "name": "John Doe", "email": "john@example.com", "password": "password123", "newCompanyName": "My New Company" }
-\`\`\`
-` : `
-### Registration Flow
-\`\`\`json
-{ "name": "John Doe", "email": "john@example.com", "password": "password123" }
-\`\`\`
-`;
-    return `
-## Authentication API
-${multiTenantNote}
-Handles user authentication${enableCompanyFeature ? ', company/branch management' : ''}, and registration.
-
-### Features
-${features}
-${loginFlowSection}${emailVerificationSection}${administrationSection}${registrationSection}`;
-}
-// ============================================================================
-// Config factory
-// ============================================================================
-export function authSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    const enableEmailVerification = bootstrapConfig?.enableEmailVerification ?? true;
-    const isMultiTenant = bootstrapConfig?.databaseMode === 'multi-tenant';
-    const excludeTags = enableCompanyFeature ? [] : COMPANY_RELATED_TAGS;
-    const excludeSchemaProperties = [
-        ...enableCompanyFeature ? [] : COMPANY_SCHEMA_EXCLUSIONS,
-        ...enableEmailVerification ? [] : EMAIL_VERIFICATION_SCHEMA_EXCLUSIONS
-    ];
-    // Merge example exclusions — both may target /auth/login with different example names
-    const excludeExamples = [
-        ...enableCompanyFeature ? [] : COMPANY_EXAMPLE_EXCLUSIONS,
-        ...enableEmailVerification ? [] : EMAIL_VERIFICATION_EXAMPLE_EXCLUSIONS
-    ];
-    const excludePaths = enableEmailVerification ? undefined : EMAIL_VERIFICATION_PATHS;
-    return {
-        title: 'Auth API',
-        description: buildDescription(enableCompanyFeature, enableEmailVerification, isMultiTenant),
-        version: '1.0',
-        path: 'api/docs/auth',
-        bearerAuth: true,
-        excludeTags,
-        excludeSchemaProperties: excludeSchemaProperties.length ? excludeSchemaProperties : undefined,
-        excludeExamples: excludeExamples.length ? excludeExamples : undefined,
-        excludePaths
-    };
-}