@flusys/nestjs-auth 7.1.0 → 8.0.0

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

@@ -1,454 +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',
-        '- Social sign-in (Google, Facebook, LinkedIn, Microsoft)',
-        '- 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 socialSection = `
-### Social Sign-In Endpoints
-- \`POST /auth/social/providers\` - List the providers an administrator enabled
-- \`POST /auth/social/authorize\` - Start a sign-in and get the provider's consent URL
-- \`POST /auth/social/callback\` - Exchange the provider's code for a session
-- \`POST /auth/social-config/*\` - Manage provider credentials
-`;
-    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}${socialSection}${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
-    };
-}

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

@@ -1,126 +0,0 @@
-import { authSwaggerConfig } from './auth-swagger.config';
-describe('authSwaggerConfig', ()=>{
-    it('should default to both features enabled and single-database mode when no config is given', ()=>{
-        const config = authSwaggerConfig();
-        expect(config.title).toBe('Auth API');
-        expect(config.path).toBe('api/docs/auth');
-        expect(config.bearerAuth).toBe(true);
-        expect(config.excludeTags).toEqual([]);
-        expect(config.excludeSchemaProperties).toBeUndefined();
-        expect(config.excludeExamples).toBeUndefined();
-        expect(config.excludePaths).toBeUndefined();
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should exclude company-related tags, schema properties, and examples when the company feature is off', ()=>{
-        const config = authSwaggerConfig({
-            enableCompanyFeature: false,
-            databaseMode: 'single'
-        });
-        expect(config.excludeTags).toEqual(expect.arrayContaining([
-            'Companies',
-            'Branches',
-            'User Permissions',
-            'Company Selection'
-        ]));
-        expect(config.excludeSchemaProperties).toEqual(expect.arrayContaining([
-            expect.objectContaining({
-                schemaName: 'RegistrationDto'
-            })
-        ]));
-        expect(config.excludeExamples).toEqual(expect.arrayContaining([
-            expect.objectContaining({
-                pathPattern: '/auth/login',
-                examples: [
-                    'loginSuccessWithCompany',
-                    'companySelection'
-                ]
-            })
-        ]));
-        // Email verification is still enabled by default, so its paths must not be excluded
-        expect(config.excludePaths).toBeUndefined();
-    });
-    it('should exclude email-verification paths, schema properties, and examples when disabled', ()=>{
-        const config = authSwaggerConfig({
-            enableEmailVerification: false
-        });
-        expect(config.excludePaths).toEqual([
-            '/auth/forgot-password',
-            '/auth/reset-password',
-            '/auth/resend-verification',
-            '/auth/verify-email'
-        ]);
-        expect(config.excludeSchemaProperties).toEqual(expect.arrayContaining([
-            expect.objectContaining({
-                schemaName: 'LoginResponseRequiresEmailVerificationDto'
-            })
-        ]));
-        expect(config.excludeExamples).toEqual(expect.arrayContaining([
-            expect.objectContaining({
-                pathPattern: '/auth/login',
-                examples: [
-                    'emailVerification'
-                ]
-            })
-        ]));
-        // Company feature is still enabled by default, so its tags must not be excluded
-        expect(config.excludeTags).toEqual([]);
-    });
-    it('should merge exclusions from both features when both are disabled', ()=>{
-        const config = authSwaggerConfig({
-            enableCompanyFeature: false,
-            enableEmailVerification: false
-        });
-        expect(config.excludeTags?.length).toBeGreaterThan(0);
-        expect(config.excludePaths?.length).toBeGreaterThan(0);
-        // Both feature's schema exclusions should be present together
-        const schemaNames = config.excludeSchemaProperties?.map((e)=>e.schemaName) ?? [];
-        expect(schemaNames).toContain('RegistrationDto');
-        expect(schemaNames).toContain('LoginResponseRequiresEmailVerificationDto');
-        // Both feature's example exclusions merge onto the same /auth/login path
-        const loginExclusions = config.excludeExamples?.filter((e)=>e.pathPattern === '/auth/login');
-        expect(loginExclusions).toHaveLength(2);
-    });
-    it('should mention multi-tenant mode in the description only for multi-tenant database mode', ()=>{
-        const multiTenant = authSwaggerConfig({
-            databaseMode: 'multi-tenant'
-        });
-        const single = authSwaggerConfig({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should describe the multi-company login flow only when the company feature is enabled', ()=>{
-        const withCompany = authSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = authSwaggerConfig({
-            enableCompanyFeature: false
-        });
-        expect(withCompany.description).toContain('Multi-Company Login');
-        expect(withCompany.description).toContain('/auth/switch-company');
-        expect(withoutCompany.description).not.toContain('Multi-Company Login');
-        expect(withoutCompany.description).not.toContain('/auth/switch-company');
-    });
-    it('should describe email verification endpoints only when enabled', ()=>{
-        const withVerification = authSwaggerConfig({
-            enableEmailVerification: true
-        });
-        const withoutVerification = authSwaggerConfig({
-            enableEmailVerification: false
-        });
-        expect(withVerification.description).toContain('/auth/forgot-password');
-        expect(withoutVerification.description).not.toContain('### Email Verification Endpoints');
-    });
-    it('should list company administration endpoints only when the company feature is enabled', ()=>{
-        const withCompany = authSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = authSwaggerConfig({
-            enableCompanyFeature: false
-        });
-        expect(withCompany.description).toContain('/administration/company/*');
-        expect(withoutCompany.description).not.toContain('/administration/company/*');
-        expect(withoutCompany.description).toContain('/administration/users/*');
-    });
-});