@flusys/nestjs-auth 1.0.0-beta → 1.1.0-beta

package/interfaces/user-enricher.interface.d.ts

@@ -0,0 +1,67 @@
+import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
+import { QueryRunner, SelectQueryBuilder } from 'typeorm';
+import { User } from '../entities/user.entity';
+import { IUser } from './user.interface';
+export interface IProfileSection {
+    id: string;
+    name: string;
+    order: number;
+    icon?: string;
+    required?: boolean;
+    hasFileUpload?: boolean;
+    editPermission?: string;
+}
+export interface IProfileSectionData {
+    sectionId: string;
+    data: Record<string, any>;
+    isComplete: boolean;
+    files?: IProfileFile[];
+}
+export interface IProfileFile {
+    field: string;
+    id: string;
+    name: string;
+    url?: string;
+    type?: string;
+}
+export interface IProfileExtras {
+    roles?: IProfileRole[];
+    actions?: IProfileAction[];
+    sections?: IProfileSectionData[];
+    completionPercentage?: number;
+    [key: string]: any;
+}
+export interface IProfileRole {
+    id: string;
+    name: string;
+    description?: string | null;
+}
+export interface IProfileAction {
+    id: string;
+    name: string;
+    code: string;
+    description?: string | null;
+}
+export interface IEnrichedUser extends IUser {
+    [key: string]: any;
+}
+export interface IUserEnricher {
+    enrichListQuery?(query: SelectQueryBuilder<User>, user: ILoggedUserInfo | null): Promise<{
+        extraFields: string[];
+    }>;
+    enrichListItems?(users: IUser[], user: ILoggedUserInfo | null): Promise<IEnrichedUser[]>;
+    getProfileExtras?(userId: string, user: ILoggedUserInfo): Promise<IProfileExtras>;
+    updateProfileExtras?(userId: string, extras: Record<string, any>, queryRunner: QueryRunner): Promise<void>;
+    validateProfileExtras?(userId: string, extras: Record<string, any>, user: ILoggedUserInfo): Promise<void>;
+    getProfileSections?(): IProfileSection[];
+    getProfileSectionData?(userId: string, sectionId: string, user: ILoggedUserInfo): Promise<IProfileSectionData>;
+    updateProfileSection?(userId: string, sectionId: string, data: Record<string, any>, queryRunner: QueryRunner): Promise<void>;
+    handleSectionFileUpload?(userId: string, sectionId: string, field: string, fileInfo: {
+        name: string;
+        url: string;
+        size: number;
+        type: string;
+    }, queryRunner: QueryRunner): Promise<IProfileFile>;
+    handleSectionFileDelete?(userId: string, sectionId: string, field: string, fileId: string, queryRunner: QueryRunner): Promise<void>;
+    calculateProfileCompletion?(userId: string, user: ILoggedUserInfo): Promise<number>;
+}

package/interfaces/user.interface.d.ts

@@ -3,6 +3,7 @@ export interface IUserMini {
     id: string;
     email: string;
     name?: string;
+    phone?: string | null;
     profilePictureId?: string | null;
 }
 export interface IUser extends Identity {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-auth",
-  "version": "1.0.0-beta",
+  "version": "1.1.0-beta",
   "description": "Authentication and authorization infrastructure for NestJS applications",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -91,7 +91,7 @@
     "typeorm": "^0.3.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "1.0.0-beta",
-    "@flusys/nestjs-shared": "1.0.0-beta"
+    "@flusys/nestjs-core": "1.1.0-beta",
+    "@flusys/nestjs-shared": "1.1.0-beta"
   }
 }

package/services/auth-config.service.d.ts

@@ -12,6 +12,7 @@ export declare class AuthConfigService {
     getRefreshTokenSecret(): string;
     getRefreshTokenExpiration(): string;
     getRefreshTokenCookieName(): string;
+    getFrontendUrl(): string | undefined;
     getDefaultDatabaseConfig(): IDatabaseConfig | undefined;
     getTenantDefaultDatabaseConfig(): IDatabaseConfig | undefined;
     getTenants(): ITenantDatabaseConfig[];

package/services/auth-email.service.d.ts

@@ -0,0 +1,50 @@
+import { AuthDataSourceProvider } from './auth-datasource.provider';
+import { PendingRegistration } from '../entities/pending-registration.entity';
+import { IAuthEmailProvider } from '../interfaces';
+export declare class AuthEmailService {
+    private readonly dataSourceProvider?;
+    private readonly emailProvider?;
+    private readonly logger;
+    private readonly PASSWORD_RESET_EXPIRY;
+    private readonly EMAIL_VERIFICATION_EXPIRY;
+    constructor(dataSourceProvider?: AuthDataSourceProvider, emailProvider?: IAuthEmailProvider);
+    private getUserRepository;
+    private getUserTokenRepository;
+    private getPendingRegistrationRepository;
+    isEmailEnabled(): boolean;
+    private generateToken;
+    createPendingRegistration(data: {
+        email: string;
+        name?: string;
+        phone?: string;
+        password: string;
+        companyData?: PendingRegistration['companyData'];
+        verifyUrlBase: string;
+    }): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    forgotPassword(email: string, resetUrlBase: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    resetPassword(token: string, newPassword: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    verifyEmail(token: string): Promise<{
+        type: 'pending';
+        pending: PendingRegistration;
+    } | {
+        type: 'verified';
+        message: string;
+    }>;
+    resendVerificationEmail(email: string, verifyUrlBase: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    cleanupExpired(): Promise<{
+        deletedTokens: number;
+        deletedPending: number;
+    }>;
+}

package/services/authentication.service.d.ts

@@ -4,9 +4,11 @@ import { AuthConfigService } from './auth-config.service';
 import { AuthDataSourceProvider } from './auth-datasource.provider';
 import { RegistrationDto } from '../dtos/authentication.dto';
 import { HybridCache } from '@flusys/nestjs-shared/classes';
-import { LoginResponse, LoginResponseRequiresSelection, MeResponse } from '../interfaces/authentication.interface';
+import { LoginResponse, LoginResponseRequiresEmailVerification, LoginResponseRequiresSelection, MeResponse, RegistrationResponse } from '../interfaces/authentication.interface';
+import { AuthEmailService } from './auth-email.service';
 import { CompanyBranch } from '../entities/company-branch.entity';
 import { Company } from '../entities/company.entity';
+import { PendingRegistration } from '../entities/pending-registration.entity';
 import { UserCompanyPermission } from '../entities/user-company-permission.entity';
 import { User } from '../entities/user.entity';
 import { CompanySelectionSessionService } from './company-selection-session.service';
@@ -16,20 +18,28 @@ export declare class AuthenticationService {
     private readonly cacheManager?;
     private readonly dataSourceProvider?;
     private readonly sessionService?;
+    private readonly authEmailService?;
     private readonly injectedUserRepository?;
     private readonly injectedPermissionRepository?;
     private readonly injectedCompanyRepository?;
     private readonly injectedBranchRepository?;
     private readonly logger;
-    constructor(jwtService: JwtService, authConfig: AuthConfigService, cacheManager?: HybridCache, dataSourceProvider?: AuthDataSourceProvider, sessionService?: CompanySelectionSessionService, injectedUserRepository?: Repository<User>, injectedPermissionRepository?: Repository<UserCompanyPermission>, injectedCompanyRepository?: Repository<Company>, injectedBranchRepository?: Repository<CompanyBranch>);
+    constructor(jwtService: JwtService, authConfig: AuthConfigService, cacheManager?: HybridCache, dataSourceProvider?: AuthDataSourceProvider, sessionService?: CompanySelectionSessionService, authEmailService?: AuthEmailService, injectedUserRepository?: Repository<User>, injectedPermissionRepository?: Repository<UserCompanyPermission>, injectedCompanyRepository?: Repository<Company>, injectedBranchRepository?: Repository<CompanyBranch>);
     private getUserRepository;
     private getPermissionRepository;
     private getCompanyRepository;
     private getBranchRepository;
-    login(email: string, password: string): Promise<LoginResponse | LoginResponseRequiresSelection>;
+    login(email: string, password: string): Promise<LoginResponse | LoginResponseRequiresSelection | LoginResponseRequiresEmailVerification>;
     private handleCompanyBasedLogin;
-    register(dto: RegistrationDto): Promise<LoginResponse>;
+    register(dto: RegistrationDto, verifyUrlBase?: string): Promise<RegistrationResponse | {
+        requiresEmailVerification: true;
+        message: string;
+    }>;
+    private createUserDirectly;
+    createUserFromPendingRegistration(pending: PendingRegistration): Promise<RegistrationResponse>;
+    private handleCompanyRegistrationFromPending;
     private handleCompanyRegistration;
+    private processCompanyRegistration;
     private generateSlug;
     select(sessionId: string, companyId: string, branchId: string): Promise<LoginResponse>;
     switchCompany(userId: string, companyId: string, branchId: string): Promise<LoginResponse>;
@@ -51,4 +61,6 @@ export declare class AuthenticationService {
     private generateLoginResponse;
     private generateLoginResponseWithCompany;
     private generateCompanySelectionResponse;
+    private generateRegistrationResponse;
+    private generateRegistrationResponseWithCompany;
 }

package/services/index.d.ts

@@ -1,4 +1,5 @@
 export * from './authentication.service';
+export * from './auth-email.service';
 export * from './company-selection-session.service';
 export * from './user.service';
 export * from './company.service';

package/services/user.service.d.ts

@@ -6,22 +6,24 @@ import { AuthConfigService } from './auth-config.service';
 import { AuthDataSourceProvider } from './auth-datasource.provider';
 import { CreateUserDto, UpdateUserDto } from '../dtos/user.dto';
 import { IUser } from '../interfaces/user.interface';
+import { IEnrichedUser, IProfileExtras, IProfileSection, IProfileSectionData, IUserEnricher } from '../interfaces/user-enricher.interface';
 import { User } from '../entities/user.entity';
 export declare class UserService extends RequestScopedApiService<CreateUserDto, UpdateUserDto, IUser, User, Repository<User>> {
     protected cacheManager: HybridCache;
     protected utilsService: UtilsService;
     private readonly dataSourceProvider;
     private readonly authConfig;
+    private readonly userEnricher?;
     private permissionRepository?;
     private dataSource?;
-    constructor(cacheManager: HybridCache, utilsService: UtilsService, dataSourceProvider: AuthDataSourceProvider, authConfig: AuthConfigService);
+    constructor(cacheManager: HybridCache, utilsService: UtilsService, dataSourceProvider: AuthDataSourceProvider, authConfig: AuthConfigService, userEnricher?: IUserEnricher);
     protected resolveEntity(): EntityTarget<User>;
     protected getDataSourceProvider(): AuthDataSourceProvider;
     protected ensureRepositoryInitialized(): Promise<void>;
     verifyEmail(id: string): Promise<void>;
     verifyPhone(id: string): Promise<void>;
     updateStatus(id: string, isActive: boolean, user?: ILoggedUserInfo | null): Promise<void>;
-    protected convertSingleDtoToEntity(dto: CreateUserDto | UpdateUserDto, user: any): Promise<User>;
+    protected convertSingleDtoToEntity(dto: CreateUserDto | UpdateUserDto, user: ILoggedUserInfo | null): Promise<User>;
     protected convertEntityToResponseDto(entity: User, isRaw: boolean): IUser;
     protected convertEntityListToResponseListDto(entities: User[], isRaw: boolean): IUser[];
     protected getGlobalSearchQuery(query: any, search: string, _user: any): Promise<{
@@ -33,5 +35,16 @@ export declare class UserService extends RequestScopedApiService<CreateUserDto,
         isRaw: boolean;
     }>;
     insert(dto: CreateUserDto, user: ILoggedUserInfo | null): Promise<IUser>;
-    profile(dto: UpdateUserDto, user: ILoggedUserInfo): Promise<string>;
+    getProfileWithExtras(userId: string, user: ILoggedUserInfo): Promise<{
+        user: IUser;
+        extras?: IProfileExtras;
+    }>;
+    getEnrichedList(users: IUser[], user: ILoggedUserInfo | null): Promise<IEnrichedUser[]>;
+    getProfileSections(): Promise<IProfileSection[]>;
+    getProfileSectionData(userId: string, sectionId: string, user: ILoggedUserInfo): Promise<IProfileSectionData | null>;
+    updateProfileSection(userId: string, sectionId: string, data: Record<string, any>, user: ILoggedUserInfo): Promise<void>;
+    getProfileCompletion(userId: string, user: ILoggedUserInfo): Promise<number>;
+    profile(dto: UpdateUserDto & {
+        extras?: Record<string, any>;
+    }, user: ILoggedUserInfo): Promise<string>;
 }