@flusys/nestjs-auth 7.1.0 → 8.0.0

package/fesm/interfaces/auth-email-provider.interface.js

@@ -1,38 +0,0 @@
-/**
- * Auth Email  Provider Interface
- *
- * This interface defines the contract for email sending in the auth module.
- * It allows auth to work independently of the email module.
- *
- * To use email features in auth:
- * 1. Provide AUTH_EMAIL_PROVIDER in your app module
- * 2. Implement IAuthEmailProvider using EmailSendService from nestjs-email
- *
- * @example
- * ```typescript
- * // In app.module.ts or a provider file
- * {
- *   provide: AUTH_EMAIL_PROVIDER,
- *   useFactory: (emailSendService: EmailSendService) => ({
- *     sendPasswordResetEmail: async (email, token, resetUrl) => {
- *       await emailSendService.sendTemplateEmail({
- *         templateSlug: 'password-reset',
- *         to: email,
- *         variables: { resetUrl, token },
- *       });
- *     },
- *     sendVerificationEmail: async (email, token, verifyUrl) => {
- *       await emailSendService.sendTemplateEmail({
- *         templateSlug: 'email-verification',
- *         to: email,
- *         variables: { verifyUrl, token },
- *       });
- *     },
- *   }),
- *   inject: [EmailSendService],
- * }
- * ```
- */ /**
- * Injection token for auth email provider
- * Use this to provide the email implementation
- */ export const AUTH_EMAIL_PROVIDER = 'AUTH_EMAIL_PROVIDER';

package/fesm/interfaces/auth-module-options.interface.js

@@ -1,3 +0,0 @@
-/**
- * Async options for AuthModule registration
- */ export { };

package/fesm/interfaces/authentication.interface.js

@@ -1 +0,0 @@
-/** Company/branch selection or creation data supplied during registration */ export { };

package/fesm/interfaces/company-branch.interface.js

@@ -1 +0,0 @@
-export { };

package/fesm/interfaces/company.interface.js

@@ -1 +0,0 @@
-export { };

package/fesm/interfaces/social-auth.interface.js

@@ -1 +0,0 @@
-export { };

package/fesm/interfaces/user-enricher.interface.js

@@ -1,4 +0,0 @@
-/**
- * User Enricher Provider Interface - allows apps to extend user list/profile
- * without modifying nestjs-auth. Provide via: { provide: USER_ENRICHER, useClass: MyEnricher }
- */ export { };

package/fesm/interfaces/user.interface.js

@@ -1 +0,0 @@
-export { };

package/fesm/modules/auth.module.js

@@ -1,198 +0,0 @@
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-import { CacheModule, UtilsModule, createModuleEventsProvider } from '@flusys/nestjs-shared/modules';
-import { Module } from '@nestjs/common';
-import { JwtModule } from '@nestjs/jwt';
-import { PassportModule } from '@nestjs/passport';
-import { JwtAuthGuard } from '@flusys/nestjs-shared/guards';
-import { AUTH_MODULE_OPTIONS } from '../config/auth.constants';
-import { AuthenticationController, BranchController, CompanyController, CompanySelectionController, EmailVerificationController, SocialAuthConfigController, SocialAuthController, UserController, UserPermissionController } from '../controllers';
-import { getAuthEntitiesByConfig } from '../entities';
-import { ClearToken } from '../interceptors/clear-token.interceptor';
-import { SetToken } from '../interceptors/set-token.interceptor';
-import { AuthEmailService, AuthenticationService, BranchService, CompanySelectionSessionService, CompanyService, SocialAuthConfigService, SocialAuthService, UserPermissionService, UserService } from '../services';
-import { AuthConfigService } from '../services/auth-config.service';
-import { AuthDataSourceProvider } from '../services/auth-datasource.provider';
-import { JwtStrategy } from '../strategies/jwt.strategy';
-export class AuthModule {
-    static forRoot(options) {
-        const optionsProvider = {
-            provide: AUTH_MODULE_OPTIONS,
-            useValue: options
-        };
-        return this.buildModule(options, [
-            optionsProvider,
-            ...options.providers ?? []
-        ]);
-    }
-    static forRootAsync(options) {
-        const asyncProviders = this.createAsyncProviders(options);
-        return this.buildModule(options, [
-            ...asyncProviders,
-            ...options.providers ?? []
-        ], options.imports);
-    }
-    static buildModule(options, providers, externalImports = []) {
-        const { global = false, includeController = true, bootstrapAppConfig } = options;
-        const featureFlags = this.getFeatureFlags(bootstrapAppConfig);
-        return {
-            module: AuthModule,
-            global,
-            imports: [
-                ...externalImports,
-                ...this.buildImports()
-            ],
-            controllers: this.buildControllers(includeController, featureFlags),
-            providers: [
-                ...providers,
-                ...this.buildProviders(featureFlags)
-            ],
-            exports: this.buildExports(featureFlags)
-        };
-    }
-    static getFeatureFlags(bootstrapAppConfig) {
-        return {
-            enableCompanyFeature: bootstrapAppConfig?.enableCompanyFeature ?? false,
-            enableEmailVerification: bootstrapAppConfig?.enableEmailVerification ?? true
-        };
-    }
-    static buildImports() {
-        return [
-            PassportModule.register({
-                defaultStrategy: 'jwt'
-            }),
-            JwtModule.register({}),
-            CacheModule,
-            UtilsModule
-        ];
-    }
-    static buildControllers(includeController, flags) {
-        if (!includeController) return [];
-        const controllers = [
-            AuthenticationController,
-            SocialAuthController,
-            SocialAuthConfigController,
-            UserController
-        ];
-        if (flags.enableEmailVerification) {
-            controllers.push(EmailVerificationController);
-        }
-        if (flags.enableCompanyFeature) {
-            controllers.push(CompanySelectionController, CompanyController, BranchController, UserPermissionController);
-        }
-        return controllers;
-    }
-    static buildProviders(flags) {
-        const providers = [
-            AuthConfigService,
-            AuthDataSourceProvider,
-            JwtStrategy,
-            JwtAuthGuard,
-            AuthenticationService,
-            SocialAuthService,
-            SocialAuthConfigService,
-            SetToken,
-            ClearToken,
-            UserService,
-            createModuleEventsProvider('auth', AUTH_MODULE_OPTIONS)
-        ];
-        if (flags.enableEmailVerification) {
-            providers.push(AuthEmailService);
-        }
-        if (flags.enableCompanyFeature) {
-            providers.push(CompanySelectionSessionService, CompanyService, BranchService, UserPermissionService);
-        }
-        return providers;
-    }
-    static buildExports(flags) {
-        const exports = [
-            PassportModule,
-            AUTH_MODULE_OPTIONS,
-            AuthConfigService,
-            AuthDataSourceProvider,
-            JwtStrategy,
-            JwtAuthGuard,
-            AuthenticationService,
-            SocialAuthService,
-            SocialAuthConfigService,
-            UserService
-        ];
-        if (flags.enableEmailVerification) {
-            exports.push(AuthEmailService);
-        }
-        if (flags.enableCompanyFeature) {
-            exports.push(CompanySelectionSessionService, CompanyService, BranchService, UserPermissionService);
-        }
-        return exports;
-    }
-    static createAsyncProviders(options) {
-        const staticOptions = {
-            global: options.global,
-            includeController: options.includeController,
-            bootstrapAppConfig: options.bootstrapAppConfig
-        };
-        if (options.useFactory) {
-            return [
-                {
-                    provide: AUTH_MODULE_OPTIONS,
-                    useFactory: async (...args)=>({
-                            ...staticOptions,
-                            config: await options.useFactory(...args)
-                        }),
-                    inject: options.inject || []
-                }
-            ];
-        }
-        if (options.useClass) {
-            return [
-                {
-                    provide: options.useClass,
-                    useClass: options.useClass
-                },
-                {
-                    provide: AUTH_MODULE_OPTIONS,
-                    useFactory: async (factory)=>({
-                            ...staticOptions,
-                            config: await factory.createAuthOptions()
-                        }),
-                    inject: [
-                        options.useClass
-                    ]
-                }
-            ];
-        }
-        if (options.useExisting) {
-            return [
-                {
-                    provide: AUTH_MODULE_OPTIONS,
-                    useFactory: async (factory)=>({
-                            ...staticOptions,
-                            config: await factory.createAuthOptions()
-                        }),
-                    inject: [
-                        options.useExisting
-                    ]
-                }
-            ];
-        }
-        return [
-            {
-                provide: AUTH_MODULE_OPTIONS,
-                useValue: staticOptions
-            }
-        ];
-    }
-    static getEntities(config) {
-        return getAuthEntitiesByConfig({
-            enableCompanyFeature: config.enableCompanyFeature ?? false,
-            enableEmailVerification: config.enableEmailVerification ?? true
-        });
-    }
-}
-AuthModule = _ts_decorate([
-    Module({})
-], AuthModule);

package/fesm/modules/auth.module.spec.js

@@ -1,254 +0,0 @@
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-import { AuthModule } from './auth.module';
-import { AUTH_MODULE_OPTIONS } from '../config/auth.constants';
-import { AuthenticationController, BranchController, CompanyController, CompanySelectionController, EmailVerificationController, SocialAuthConfigController, SocialAuthController, UserController, UserPermissionController } from '../controllers';
-import { AuthEmailService, BranchService, CompanySelectionSessionService, CompanyService, SocialAuthConfigService, SocialAuthService, UserPermissionService } from '../services';
-function providerTokens(providers) {
-    return providers.map((p)=>typeof p === 'function' ? p : p.provide);
-}
-describe('AuthModule', ()=>{
-    describe('forRoot', ()=>{
-        it('should build a non-global module by default with the minimal feature set', ()=>{
-            const dynamicModule = AuthModule.forRoot({
-                bootstrapAppConfig: {
-                    enableEmailVerification: false
-                }
-            });
-            expect(dynamicModule.module).toBe(AuthModule);
-            expect(dynamicModule.global).toBe(false);
-            expect(dynamicModule.controllers).toEqual([
-                AuthenticationController,
-                SocialAuthController,
-                SocialAuthConfigController,
-                UserController
-            ]);
-            expect(providerTokens(dynamicModule.providers)).not.toContain(AuthEmailService);
-            expect(providerTokens(dynamicModule.providers)).not.toContain(CompanyService);
-        });
-        it('should always register social sign-in, whatever the feature flags say', ()=>{
-            const dynamicModule = AuthModule.forRoot({
-                bootstrapAppConfig: {
-                    enableCompanyFeature: false
-                }
-            });
-            expect(dynamicModule.controllers).toContain(SocialAuthController);
-            expect(dynamicModule.controllers).toContain(SocialAuthConfigController);
-            expect(providerTokens(dynamicModule.providers)).toContain(SocialAuthService);
-            expect(providerTokens(dynamicModule.providers)).toContain(SocialAuthConfigService);
-            expect(dynamicModule.exports).toContain(SocialAuthService);
-            expect(dynamicModule.exports).toContain(SocialAuthConfigService);
-        });
-        it('should respect global: true', ()=>{
-            const dynamicModule = AuthModule.forRoot({
-                global: true
-            });
-            expect(dynamicModule.global).toBe(true);
-        });
-        it('should register no controllers when includeController is false', ()=>{
-            const dynamicModule = AuthModule.forRoot({
-                includeController: false
-            });
-            expect(dynamicModule.controllers).toEqual([]);
-        });
-        it('should enable email verification by default (bootstrapAppConfig omitted)', ()=>{
-            const dynamicModule = AuthModule.forRoot({});
-            expect(dynamicModule.controllers).toContain(EmailVerificationController);
-            expect(providerTokens(dynamicModule.providers)).toContain(AuthEmailService);
-            expect(dynamicModule.exports).toContain(AuthEmailService);
-        });
-        it('should omit email verification controller/provider/export when explicitly disabled', ()=>{
-            const dynamicModule = AuthModule.forRoot({
-                bootstrapAppConfig: {
-                    enableEmailVerification: false
-                }
-            });
-            expect(dynamicModule.controllers).not.toContain(EmailVerificationController);
-            expect(providerTokens(dynamicModule.providers)).not.toContain(AuthEmailService);
-            expect(dynamicModule.exports).not.toContain(AuthEmailService);
-        });
-        it('should add company controllers/providers/exports when enableCompanyFeature is true', ()=>{
-            const dynamicModule = AuthModule.forRoot({
-                bootstrapAppConfig: {
-                    enableCompanyFeature: true
-                }
-            });
-            expect(dynamicModule.controllers).toEqual(expect.arrayContaining([
-                CompanySelectionController,
-                CompanyController,
-                BranchController,
-                UserPermissionController
-            ]));
-            expect(providerTokens(dynamicModule.providers)).toEqual(expect.arrayContaining([
-                CompanySelectionSessionService,
-                CompanyService,
-                BranchService,
-                UserPermissionService
-            ]));
-            expect(dynamicModule.exports).toEqual(expect.arrayContaining([
-                CompanyService,
-                BranchService,
-                UserPermissionService
-            ]));
-        });
-        it('should register an AUTH_MODULE_OPTIONS provider carrying the given options', ()=>{
-            const options = {
-                bootstrapAppConfig: {
-                    enableCompanyFeature: true
-                }
-            };
-            const dynamicModule = AuthModule.forRoot(options);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === AUTH_MODULE_OPTIONS);
-            expect(optionsProvider.useValue).toBe(options);
-        });
-        it('should append any caller-supplied extra providers', ()=>{
-            const extraProvider = {
-                provide: 'EXTRA',
-                useValue: 'x'
-            };
-            const dynamicModule = AuthModule.forRoot({
-                providers: [
-                    extraProvider
-                ]
-            });
-            expect(dynamicModule.providers).toEqual(expect.arrayContaining([
-                extraProvider
-            ]));
-        });
-    });
-    describe('forRootAsync', ()=>{
-        it('should default AUTH_MODULE_OPTIONS to the static options when no useFactory/useClass/useExisting is given', async ()=>{
-            const dynamicModule = AuthModule.forRootAsync({
-                bootstrapAppConfig: {},
-                global: true
-            });
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === AUTH_MODULE_OPTIONS);
-            expect(optionsProvider.useValue).toEqual({
-                global: true,
-                includeController: undefined,
-                bootstrapAppConfig: {}
-            });
-        });
-        it('should resolve config via useFactory and merge it with the static options', async ()=>{
-            const useFactory = jest.fn().mockResolvedValue({
-                jwtSecret: 'from-factory'
-            });
-            const dynamicModule = AuthModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useFactory,
-                inject: [
-                    'SOME_TOKEN'
-                ]
-            });
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === AUTH_MODULE_OPTIONS);
-            expect(optionsProvider.inject).toEqual([
-                'SOME_TOKEN'
-            ]);
-            const resolved = await optionsProvider.useFactory('injected-value');
-            expect(useFactory).toHaveBeenCalledWith('injected-value');
-            expect(resolved).toEqual({
-                global: undefined,
-                includeController: undefined,
-                bootstrapAppConfig: {},
-                config: {
-                    jwtSecret: 'from-factory'
-                }
-            });
-        });
-        it('should resolve config via a useClass factory', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createAuthOptions", jest.fn().mockResolvedValue({
-                        jwtSecret: 'from-class'
-                    }));
-                }
-            };
-            const dynamicModule = AuthModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useClass: MyOptionsFactory
-            });
-            const classProvider = dynamicModule.providers.find((p)=>p.provide === MyOptionsFactory);
-            expect(classProvider.useClass).toBe(MyOptionsFactory);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === AUTH_MODULE_OPTIONS);
-            expect(optionsProvider.inject).toEqual([
-                MyOptionsFactory
-            ]);
-            const factoryInstance = new MyOptionsFactory();
-            const resolved = await optionsProvider.useFactory(factoryInstance);
-            expect(factoryInstance.createAuthOptions).toHaveBeenCalled();
-            expect(resolved.config).toEqual({
-                jwtSecret: 'from-class'
-            });
-        });
-        it('should resolve config via a useExisting factory', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createAuthOptions", jest.fn().mockResolvedValue({
-                        jwtSecret: 'from-existing'
-                    }));
-                }
-            };
-            const dynamicModule = AuthModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useExisting: MyOptionsFactory
-            });
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === AUTH_MODULE_OPTIONS);
-            expect(optionsProvider.inject).toEqual([
-                MyOptionsFactory
-            ]);
-            const factoryInstance = new MyOptionsFactory();
-            const resolved = await optionsProvider.useFactory(factoryInstance);
-            expect(resolved.config).toEqual({
-                jwtSecret: 'from-existing'
-            });
-        });
-        it('should forward the async `imports` array into the built module', ()=>{
-            let FakeImportedModule = class FakeImportedModule {
-            };
-            const dynamicModule = AuthModule.forRootAsync({
-                bootstrapAppConfig: {},
-                imports: [
-                    FakeImportedModule
-                ]
-            });
-            expect(dynamicModule.imports).toEqual(expect.arrayContaining([
-                FakeImportedModule
-            ]));
-        });
-        it('should append any caller-supplied extra providers alongside the async options provider', ()=>{
-            const extraProvider = {
-                provide: 'EXTRA',
-                useValue: 'x'
-            };
-            const dynamicModule = AuthModule.forRootAsync({
-                bootstrapAppConfig: {},
-                providers: [
-                    extraProvider
-                ]
-            });
-            expect(dynamicModule.providers).toEqual(expect.arrayContaining([
-                extraProvider
-            ]));
-        });
-    });
-    describe('getEntities', ()=>{
-        it('should delegate to getAuthEntitiesByConfig with the bootstrap flags', ()=>{
-            const entitiesWithDefaults = AuthModule.getEntities({});
-            const entitiesWithCompany = AuthModule.getEntities({
-                enableCompanyFeature: true
-            });
-            expect(entitiesWithDefaults.length).toBeLessThan(entitiesWithCompany.length);
-        });
-    });
-});

package/fesm/providers/facebook.social-provider.js

@@ -1,63 +0,0 @@
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-import { SocialProviderTypeEnum } from '../enums/social-provider-type.enum';
-import { buildQuery, getJson, postForm, readAccessToken, readString, resolveScopes } from './oauth-http.util';
-const GRAPH_VERSION = 'v21.0';
-const AUTHORIZE_URL = `https://www.facebook.com/${GRAPH_VERSION}/dialog/oauth`;
-const TOKEN_URL = `https://graph.facebook.com/${GRAPH_VERSION}/oauth/access_token`;
-const PROFILE_URL = `https://graph.facebook.com/${GRAPH_VERSION}/me?fields=id,name,email,picture.type(large)`;
-function readAvatarUrl(profile) {
-    const picture = profile['picture'];
-    if (typeof picture !== 'object' || picture === null) return null;
-    const data = picture['data'];
-    if (typeof data !== 'object' || data === null) return null;
-    return readString(data, 'url');
-}
-let FacebookSocialProvider = class FacebookSocialProvider {
-    buildAuthorizationUrl(credentials, state) {
-        const query = buildQuery({
-            client_id: credentials.clientId,
-            redirect_uri: credentials.redirectUri,
-            response_type: 'code',
-            scope: resolveScopes(credentials, this.defaultScopes, ','),
-            state
-        });
-        return `${AUTHORIZE_URL}?${query}`;
-    }
-    async fetchProfile(credentials, code) {
-        const token = await postForm(this.provider, TOKEN_URL, {
-            code,
-            client_id: credentials.clientId,
-            client_secret: credentials.clientSecret,
-            redirect_uri: credentials.redirectUri
-        });
-        const profile = await getJson(this.provider, PROFILE_URL, readAccessToken(this.provider, token));
-        const email = readString(profile, 'email');
-        return {
-            providerUserId: readString(profile, 'id') ?? '',
-            email,
-            emailVerified: !!email,
-            name: readString(profile, 'name'),
-            avatarUrl: readAvatarUrl(profile)
-        };
-    }
-    constructor(){
-        _define_property(this, "provider", SocialProviderTypeEnum.FACEBOOK);
-        _define_property(this, "defaultScopes", [
-            'email',
-            'public_profile'
-        ]);
-    }
-};
-export const facebookSocialProvider = new FacebookSocialProvider();

package/fesm/providers/google.social-provider.js

@@ -1,58 +0,0 @@
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-import { SocialProviderTypeEnum } from '../enums/social-provider-type.enum';
-import { buildQuery, getJson, postForm, readAccessToken, readString, resolveScopes } from './oauth-http.util';
-const AUTHORIZE_URL = 'https://accounts.google.com/o/oauth2/v2/auth';
-const TOKEN_URL = 'https://oauth2.googleapis.com/token';
-const USERINFO_URL = 'https://openidconnect.googleapis.com/v1/userinfo';
-let GoogleSocialProvider = class GoogleSocialProvider {
-    buildAuthorizationUrl(credentials, state) {
-        const query = buildQuery({
-            client_id: credentials.clientId,
-            redirect_uri: credentials.redirectUri,
-            response_type: 'code',
-            scope: resolveScopes(credentials, this.defaultScopes),
-            state,
-            access_type: 'online',
-            prompt: 'select_account'
-        });
-        return `${AUTHORIZE_URL}?${query}`;
-    }
-    async fetchProfile(credentials, code) {
-        const token = await postForm(this.provider, TOKEN_URL, {
-            code,
-            client_id: credentials.clientId,
-            client_secret: credentials.clientSecret,
-            redirect_uri: credentials.redirectUri,
-            grant_type: 'authorization_code'
-        });
-        const profile = await getJson(this.provider, USERINFO_URL, readAccessToken(this.provider, token));
-        return {
-            providerUserId: readString(profile, 'sub') ?? '',
-            email: readString(profile, 'email'),
-            emailVerified: profile['email_verified'] === true,
-            name: readString(profile, 'name'),
-            avatarUrl: readString(profile, 'picture')
-        };
-    }
-    constructor(){
-        _define_property(this, "provider", SocialProviderTypeEnum.GOOGLE);
-        _define_property(this, "defaultScopes", [
-            'openid',
-            'email',
-            'profile'
-        ]);
-    }
-};
-export const googleSocialProvider = new GoogleSocialProvider();

package/fesm/providers/index.js

@@ -1 +0,0 @@
-export * from './social-provider.registry';