mongodb-dynamic-api 2.2.1 → 2.3.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 Changelog
 
+## [2.3.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.3.0...v2.3.1) (2024-05-05)
+
+## [2.3.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.2.1...v2.3.0) (2024-05-02)
+
+
+### api
+
+* **api:** add reset password process with callbacks ([9e8bf56](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/9e8bf562ee9717ea1c0fe387bb621e9f724955ac))
+
 ## [2.2.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.2.0...v2.2.1) (2024-04-30)
 
 ## [2.2.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.1.10...v2.2.0) (2024-04-30)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-dynamic-api",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "Auto generated CRUD API for MongoDB using NestJS",
   "readmeFilename": "README.md",
   "main": "index.js",
@@ -96,6 +96,8 @@
     "typescript": "^5.3.3"
   },
   "jest": {
+    "clearMocks": true,
+    "resetMocks": true,
     "moduleFileExtensions": [
       "js",
       "json",

package/src/decorators/api-endpoint-visibility.decorator.d.ts

@@ -0,0 +1,3 @@
+import { CustomDecorator } from '@nestjs/common';
+declare function ApiEndpointVisibility(condition: boolean, decorator?: MethodDecorator | CustomDecorator): MethodDecorator | CustomDecorator;
+export { ApiEndpointVisibility };

package/src/decorators/api-endpoint-visibility.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiEndpointVisibility = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+function ApiEndpointVisibility(condition, decorator) {
+    const decoratorIfValid = decorator ?? ((_) => undefined);
+    return (0, common_1.applyDecorators)(!condition ? (0, swagger_1.ApiExcludeEndpoint)() : decoratorIfValid);
+}
+exports.ApiEndpointVisibility = ApiEndpointVisibility;

package/src/decorators/index.d.ts

@@ -1,3 +1,4 @@
+export * from './api-endpoint-visibility.decorator';
 export * from './public.decorator';
 export * from './schema-options.decorator';
 export * from './validator-pipe.decorator';

package/src/decorators/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-endpoint-visibility.decorator"), exports);
 __exportStar(require("./public.decorator"), exports);
 __exportStar(require("./schema-options.decorator"), exports);
 __exportStar(require("./validator-pipe.decorator"), exports);

package/src/dynamic-api.module.js

@@ -28,7 +28,7 @@ let DynamicApiModule = DynamicApiModule_1 = class DynamicApiModule {
         }
         this.state.set([
             'partial',
-            this.buildStateFromOptions(useGlobalCache, cacheOptions, useAuth, routesConfig),
+            this.buildStateFromOptions(uri, useGlobalCache, cacheOptions, useAuth, routesConfig),
         ]);
         return {
             module: DynamicApiModule_1,
@@ -36,7 +36,7 @@ let DynamicApiModule = DynamicApiModule_1 = class DynamicApiModule {
                 modules_1.DynamicApiConfigModule.register(this.state.get()),
                 cache_manager_1.CacheModule.register({ isGlobal: true, ...cacheOptions }),
                 mongoose_1.MongooseModule.forRoot(uri, { connectionName: this.state.get('connectionName') }),
-                ...(useAuth?.user ? [
+                ...(useAuth?.userEntity ? [
                     modules_1.AuthModule.forRoot(this.initializeAuthOptions(useAuth)),
                 ] : []),
             ],
@@ -46,7 +46,7 @@ let DynamicApiModule = DynamicApiModule_1 = class DynamicApiModule {
     static forFeature({ entity, controllerOptions, routes = [], }) {
         const schema = (0, helpers_1.buildSchemaFromEntity)(entity);
         const databaseModule = mongoose_1.MongooseModule.forFeature([{ name: entity.name, schema }], this.state.get('connectionName'));
-        services_1.DynamicApiGlobalStateService.addEntitySchema(entity.name, schema);
+        services_1.DynamicApiGlobalStateService.addEntitySchema(entity, schema);
         return new Promise((resolve, reject) => {
             const waitInitializedStateInterval = setInterval(async () => {
                 const stateInitialized = await (0, rxjs_1.firstValueFrom)(services_1.DynamicApiGlobalStateService.onInitialized());
@@ -80,10 +80,6 @@ let DynamicApiModule = DynamicApiModule_1 = class DynamicApiModule {
                         ...routes.map((routeConfig) => {
                             const { type, description: routeDescription, version: routeVersion, validationPipeOptions: routeValidationPipeOptions, } = routeConfig;
                             const module = moduleByRouteType.get(type);
-                            if (!module) {
-                                reject(new Error(`Route module for ${type} not found`));
-                                return;
-                            }
                             const description = routeDescription ?? (0, helpers_1.getDefaultRouteDescription)(type, entity.name);
                             const version = routeVersion ?? controllerVersion;
                             if (version && !(0, helpers_1.isValidVersion)(version)) {
@@ -120,17 +116,18 @@ let DynamicApiModule = DynamicApiModule_1 = class DynamicApiModule {
             }, 5000);
         });
     }
-    static buildStateFromOptions(useGlobalCache, cacheOptions, useAuth, routesConfig) {
+    static buildStateFromOptions(uri, useGlobalCache, cacheOptions, useAuth, routesConfig) {
         const routesConfigState = this.state.get('routesConfig');
         return {
+            uri,
             initialized: true,
             isGlobalCacheEnabled: useGlobalCache,
             ...(cacheOptions?.excludePaths ? { cacheExcludedPaths: cacheOptions?.excludePaths } : {}),
-            ...(useAuth?.user ? {
+            ...(useAuth?.userEntity ? {
                 isAuthEnabled: true,
                 credentials: {
-                    loginField: !useAuth.user.loginField ? 'email' : String(useAuth.user.loginField),
-                    passwordField: !useAuth.user.passwordField ? 'password' : String(useAuth.user.passwordField),
+                    loginField: !useAuth.login?.loginField ? 'email' : String(useAuth.login.loginField),
+                    passwordField: !useAuth.login?.passwordField ? 'password' : String(useAuth.login.passwordField),
                 },
                 jwtSecret: useAuth.jwt?.secret ?? 'dynamic-api-jwt-secret',
             } : {}),
@@ -144,24 +141,28 @@ let DynamicApiModule = DynamicApiModule_1 = class DynamicApiModule {
     }
     static initializeAuthOptions(useAuth) {
         return {
-            user: {
-                entity: useAuth.user.entity,
-                loginField: useAuth.user.loginField ?? 'email',
-                passwordField: useAuth.user.passwordField ?? 'password',
-                requestAdditionalFields: useAuth.user.requestAdditionalFields ?? [],
+            userEntity: useAuth.userEntity,
+            login: {
+                ...useAuth.login,
+                loginField: useAuth.login?.loginField ?? 'email',
+                passwordField: useAuth.login?.passwordField ?? 'password',
+                additionalFields: useAuth.login?.additionalFields ?? [],
+            },
+            register: {
+                ...useAuth.register,
+                additionalFields: useAuth.register?.additionalFields ?? [],
+                protected: useAuth.register?.protected ?? !!useAuth.register.abilityPredicate,
+            },
+            resetPassword: {
+                ...useAuth.resetPassword,
+                emailField: !useAuth.resetPassword?.emailField ? 'email' : String(useAuth.resetPassword.emailField),
+                expirationInMinutes: useAuth.resetPassword?.expirationInMinutes ?? 10,
             },
             jwt: {
                 secret: useAuth.jwt?.secret ?? 'dynamic-api-jwt-secret',
                 expiresIn: useAuth.jwt?.expiresIn ?? '1d',
             },
-            register: useAuth.register ? {
-                ...useAuth.register,
-                protected: useAuth.register.protected ?? !!useAuth.register.abilityPredicate,
-            } : {
-                protected: false,
-                additionalFields: [],
-            },
-            login: useAuth.login ?? {},
+            validationPipeOptions: useAuth.validationPipeOptions,
         };
     }
     static setDefaultRoutes(stateRoutesConfig, controllerRoutesConfig = {}, routes = []) {

package/src/guards/base-policies.guard.d.ts

@@ -1,12 +1,37 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
 import { CanActivate, ExecutionContext, Type } from '@nestjs/common';
+import { Model } from 'mongoose';
 import { AbilityPredicate, RouteType } from '../interfaces';
 import { BaseEntity } from '../models';
 import { BaseService } from '../services';
-export declare abstract class BasePoliciesGuard<Entity extends BaseEntity, Service extends BaseService<Entity>> implements CanActivate {
-    protected readonly service: Service;
+export declare abstract class BasePoliciesGuard<Entity extends BaseEntity> extends BaseService<Entity> implements CanActivate {
+    protected readonly model: Model<Entity>;
     protected routeType: RouteType;
     protected entity: Type<Entity>;
     protected abilityPredicate: AbilityPredicate<Entity> | undefined;
-    protected constructor(service: Service);
+    protected constructor(model: Model<Entity>);
     canActivate(context: ExecutionContext): Promise<boolean>;
 }

package/src/guards/base-policies.guard.js

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasePoliciesGuard = void 0;
 const common_1 = require("@nestjs/common");
-class BasePoliciesGuard {
-    constructor(service) {
-        this.service = service;
+const services_1 = require("../services");
+class BasePoliciesGuard extends services_1.BaseService {
+    constructor(model) {
+        super(model);
+        this.model = model;
     }
     async canActivate(context) {
         let { user, query, params } = context.switchToHttp().getRequest();
@@ -12,13 +14,12 @@ class BasePoliciesGuard {
             if (!user) {
                 throw new common_1.ForbiddenException('Access Denied');
             }
-            this.service.abilityPredicate = this.abilityPredicate;
-            this.service.user = user;
+            this.user = user;
             if (params?.id) {
-                await this.service.findOneDocument(params.id, query);
+                await this.findOneDocumentWithAbilityPredicate(params.id, query);
             }
             else {
-                await this.service.findManyDocuments(query);
+                await this.findManyDocumentsWithAbilityPredicate(query);
             }
         }
         return true;

package/src/helpers/index.d.ts

@@ -1,3 +1,5 @@
+export * from './controller-ability-predicates.helper';
+export * from './controller-mixin.helper';
 export * from './format.helper';
 export * from './route-decorators.helper';
 export * from './route-description.helper';

package/src/helpers/index.js

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./controller-ability-predicates.helper"), exports);
+__exportStar(require("./controller-mixin.helper"), exports);
 __exportStar(require("./format.helper"), exports);
 __exportStar(require("./route-decorators.helper"), exports);
 __exportStar(require("./route-description.helper"), exports);

package/src/interfaces/dynamic-api-ability.interface.d.ts

@@ -1,9 +1,9 @@
 import { BaseEntity } from '../models';
 import { RouteType } from './dynamic-api-route-type.type';
 type AbilityPredicate<Entity extends BaseEntity, User = any> = (entity: Entity, user: User) => boolean;
-type RegisterAbilityPredicate<User = any> = (user: User) => boolean;
+type AuthAbilityPredicate<User = any> = (user: User) => boolean;
 type ControllerAbilityPredicate<Entity extends BaseEntity> = {
     targets: RouteType[];
     predicate: AbilityPredicate<Entity>;
 };
-export { ControllerAbilityPredicate, RegisterAbilityPredicate, AbilityPredicate, };
+export { ControllerAbilityPredicate, AuthAbilityPredicate, AbilityPredicate, };

package/src/interfaces/dynamic-api-global-state.interface.d.ts

@@ -37,6 +37,7 @@ type RoutesConfig = {
 };
 interface DynamicApiGlobalState {
     initialized: boolean;
+    uri: string;
     connectionName: string;
     isGlobalCacheEnabled: boolean;
     cacheExcludedPaths: string[];

package/src/interfaces/dynamic-api-policy-handler.interface.d.ts

@@ -1,8 +1,32 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
 import { ExecutionContext } from '@nestjs/common';
+import { Model } from 'mongoose';
 import { BaseEntity } from '../models';
-import { BaseService } from '../services';
-interface PoliciesGuard<Entity extends BaseEntity> {
+interface PoliciesGuard {
     canActivate(context: ExecutionContext): boolean | Promise<boolean>;
 }
-type PoliciesGuardConstructor<Entity extends BaseEntity> = new (service: BaseService<Entity>) => PoliciesGuard<Entity>;
+type PoliciesGuardConstructor<Entity extends BaseEntity> = new (model: Model<Entity>) => PoliciesGuard;
 export { PoliciesGuardConstructor, PoliciesGuard };

package/src/interfaces/dynamic-api-route-response.type.d.ts

@@ -0,0 +1,7 @@
+type DeleteResult = {
+    deletedCount: number;
+};
+type UpdateResult = {
+    modifiedCount: number;
+};
+export { DeleteResult, UpdateResult };

package/src/interfaces/dynamic-api-route-response.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/interfaces/dynamic-api-service-callback.interface.d.ts

@@ -22,7 +22,27 @@
 /// <reference types="mongoose/types/validation" />
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
-import { Model } from 'mongoose';
+import { Type } from '@nestjs/common';
+import { FilterQuery } from 'mongoose';
 import { BaseEntity } from '../models';
-type DynamicApiServiceCallback<Entity extends BaseEntity> = (entity: Partial<Entity>, model: Model<Entity>) => Promise<void>;
-export type { DynamicApiServiceCallback };
+import { DeleteResult, UpdateResult } from './dynamic-api-route-response.type';
+type DynamicApiCallbackMethods = {
+    findManyDocuments<T>(entity: Type<T>, query: FilterQuery<T>): Promise<T[]>;
+    findOneDocument<T>(entity: Type<T>, query: FilterQuery<T>): Promise<T | undefined>;
+    createManyDocuments<T>(entity: Type<T>, data: Partial<T>[]): Promise<T[]>;
+    createOneDocument<T>(entity: Type<T>, data: Partial<T>): Promise<T>;
+    updateManyDocuments<T>(entity: Type<T>, query: FilterQuery<T>, data: Partial<T>): Promise<UpdateResult>;
+    updateOneDocument<T>(entity: Type<T>, query: FilterQuery<T>, data: Partial<T>): Promise<UpdateResult>;
+    deleteManyDocuments<T>(entity: Type<T>, ids: string[]): Promise<DeleteResult>;
+    deleteOneDocument<T>(entity: Type<T>, id: string): Promise<DeleteResult>;
+};
+type DynamicApiServiceCallback<Entity extends BaseEntity> = (entity: Entity, methods: DynamicApiCallbackMethods) => Promise<void>;
+type DynamicApiResetPasswordCallbackMethods<Entity extends BaseEntity, UpdateBy = 'userId'> = {
+    findUserByEmail: (email: string) => Promise<Entity | undefined>;
+    updateUserByEmail: (email: string, update: Partial<Entity>) => Promise<Entity | undefined>;
+};
+type DynamicApiResetPasswordCallback<Entity extends BaseEntity> = (_: {
+    resetPasswordToken: string;
+    email: string;
+}, methods: DynamicApiResetPasswordCallbackMethods<Entity>) => Promise<void>;
+export type { DynamicApiServiceCallback, DynamicApiResetPasswordCallback, DynamicApiCallbackMethods, DynamicApiResetPasswordCallbackMethods, };

package/src/interfaces/index.d.ts

@@ -9,6 +9,7 @@ export * from './dynamic-api-policy-handler.interface';
 export * from './dynamic-api-route-config.interface';
 export * from './dynamic-api-route-dtos-bundle.type';
 export * from './dynamic-api-route-module.type';
+export * from './dynamic-api-route-response.type';
 export * from './dynamic-api-route-type.type';
 export * from './dynamic-api-schema-options.interface';
 export * from './dynamic-api-service-callback.interface';

package/src/interfaces/index.js

@@ -25,6 +25,7 @@ __exportStar(require("./dynamic-api-policy-handler.interface"), exports);
 __exportStar(require("./dynamic-api-route-config.interface"), exports);
 __exportStar(require("./dynamic-api-route-dtos-bundle.type"), exports);
 __exportStar(require("./dynamic-api-route-module.type"), exports);
+__exportStar(require("./dynamic-api-route-response.type"), exports);
 __exportStar(require("./dynamic-api-route-type.type"), exports);
 __exportStar(require("./dynamic-api-schema-options.interface"), exports);
 __exportStar(require("./dynamic-api-service-callback.interface"), exports);

package/src/mixins/create-policies-guard.mixin.d.ts

@@ -1,6 +1,5 @@
 import { Type } from '@nestjs/common';
 import { AbilityPredicate, PoliciesGuardConstructor, RouteType } from '../interfaces';
 import { BaseEntity } from '../models';
-import { BaseService } from '../services';
-declare function CreatePoliciesGuardMixin<Entity extends BaseEntity, Service extends BaseService<Entity>>(entity: Type<Entity>, routeType: RouteType, version: string | undefined, abilityPredicate: AbilityPredicate<Entity> | undefined): PoliciesGuardConstructor<Entity>;
+declare function CreatePoliciesGuardMixin<Entity extends BaseEntity>(entity: Type<Entity>, routeType: RouteType, version: string | undefined, abilityPredicate: AbilityPredicate<Entity> | undefined): PoliciesGuardConstructor<Entity>;
 export { CreatePoliciesGuardMixin };

package/src/mixins/create-policies-guard.mixin.js

@@ -14,13 +14,16 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreatePoliciesGuardMixin = void 0;
 const common_1 = require("@nestjs/common");
+const mongoose_1 = require("@nestjs/mongoose");
+const mongoose_2 = require("mongoose");
+const dynamic_api_module_1 = require("../dynamic-api.module");
 const guards_1 = require("../guards");
 const helpers_1 = require("../helpers");
 function CreatePoliciesGuardMixin(entity, routeType, version, abilityPredicate) {
     let RoutePoliciesGuard = class RoutePoliciesGuard extends guards_1.BasePoliciesGuard {
-        constructor(service) {
-            super(service);
-            this.service = service;
+        constructor(model) {
+            super(model);
+            this.model = model;
             this.routeType = routeType;
             this.entity = entity;
             this.abilityPredicate = abilityPredicate;
@@ -28,8 +31,8 @@ function CreatePoliciesGuardMixin(entity, routeType, version, abilityPredicate)
     };
     RoutePoliciesGuard = __decorate([
         (0, common_1.Injectable)(),
-        __param(0, (0, common_1.Inject)(`${(0, helpers_1.provideName)(routeType, entity.name, version, 'Service')}`)),
-        __metadata("design:paramtypes", [Object])
+        __param(0, (0, mongoose_1.InjectModel)(entity.name, dynamic_api_module_1.DynamicApiModule.state.get('connectionName'))),
+        __metadata("design:paramtypes", [mongoose_2.Model])
     ], RoutePoliciesGuard);
     Object.defineProperty(RoutePoliciesGuard, 'name', {
         value: `${(0, helpers_1.provideName)(routeType, entity.name, version, 'PoliciesGuard')}`,

package/src/modules/auth/auth.helper.d.ts

@@ -1,10 +1,10 @@
 import { Type, ValidationPipeOptions } from '@nestjs/common';
 import { DynamicApiServiceCallback, DynamicAPIServiceProvider } from '../../interfaces';
 import { BaseEntity } from '../../models';
-import { AuthControllerConstructor, DynamicApiRegisterOptions } from './interfaces';
+import { AuthControllerConstructor, DynamicApiLoginOptions, DynamicApiRegisterOptions, DynamicApiResetPasswordOptions } from './interfaces';
 declare const authServiceProviderName = "DynamicApiAuthService";
 declare const localStrategyProviderName = "DynamicApiLocalStrategy";
 declare function createLocalStrategyProvider<Entity extends BaseEntity>(loginField: keyof Entity, passwordField: keyof Entity): DynamicAPIServiceProvider;
-declare function createAuthServiceProvider<Entity extends BaseEntity>(userEntity: Type<Entity>, loginField: keyof Entity, passwordField: keyof Entity, additionalFields: (keyof Entity)[] | undefined, registerCallback: DynamicApiServiceCallback<Entity> | undefined, loginCallback: DynamicApiServiceCallback<Entity> | undefined): DynamicAPIServiceProvider;
-declare function createAuthController<Entity extends BaseEntity>(userEntity: Type<Entity>, loginField: keyof Entity, passwordField: keyof Entity, additionalRequestFields: (keyof Entity)[] | undefined, registerOptions: DynamicApiRegisterOptions<Entity> | undefined, validationPipeOptions: ValidationPipeOptions | undefined): AuthControllerConstructor<Entity>;
+declare function createAuthServiceProvider<Entity extends BaseEntity>(userEntity: Type<Entity>, { loginField, passwordField, additionalFields, callback: loginCallback }: DynamicApiLoginOptions<Entity>, registerCallback: DynamicApiServiceCallback<Entity> | undefined, resetPasswordOptions: DynamicApiResetPasswordOptions<Entity> | undefined): DynamicAPIServiceProvider;
+declare function createAuthController<Entity extends BaseEntity>(userEntity: Type<Entity>, { loginField, passwordField, additionalFields }: DynamicApiLoginOptions<Entity>, registerOptions: DynamicApiRegisterOptions<Entity> | undefined, validationPipeOptions: ValidationPipeOptions | undefined, resetPasswordOptions: DynamicApiResetPasswordOptions<Entity> | undefined): AuthControllerConstructor<Entity>;
 export { authServiceProviderName, createAuthController, createAuthServiceProvider, createLocalStrategyProvider, localStrategyProviderName, };

package/src/modules/auth/auth.helper.js

@@ -56,7 +56,7 @@ function createLocalStrategyProvider(loginField, passwordField) {
     };
 }
 exports.createLocalStrategyProvider = createLocalStrategyProvider;
-function createAuthServiceProvider(userEntity, loginField, passwordField, additionalFields, registerCallback, loginCallback) {
+function createAuthServiceProvider(userEntity, { loginField, passwordField, additionalFields, callback: loginCallback }, registerCallback, resetPasswordOptions) {
     let AuthService = class AuthService extends services_2.BaseAuthService {
         constructor(model, jwtService, bcryptService) {
             super(model, jwtService, bcryptService);
@@ -68,6 +68,7 @@ function createAuthServiceProvider(userEntity, loginField, passwordField, additi
             this.passwordField = passwordField;
             this.registerCallback = registerCallback;
             this.loginCallback = loginCallback;
+            this.resetPasswordOptions = resetPasswordOptions;
         }
     };
     AuthService = __decorate([
@@ -82,8 +83,8 @@ function createAuthServiceProvider(userEntity, loginField, passwordField, additi
     };
 }
 exports.createAuthServiceProvider = createAuthServiceProvider;
-function createAuthController(userEntity, loginField, passwordField, additionalRequestFields, registerOptions, validationPipeOptions) {
-    let AuthController = class AuthController extends (0, mixins_1.AuthControllerMixin)(userEntity, loginField, passwordField, additionalRequestFields, registerOptions ?? {}) {
+function createAuthController(userEntity, { loginField, passwordField, additionalFields }, registerOptions, validationPipeOptions, resetPasswordOptions) {
+    let AuthController = class AuthController extends (0, mixins_1.AuthControllerMixin)(userEntity, loginField, passwordField, additionalFields, registerOptions ?? {}, resetPasswordOptions) {
         constructor(service) {
             super(service);
             this.service = service;

package/src/modules/auth/auth.module.d.ts

@@ -3,7 +3,7 @@ import { BcryptService } from '../../services';
 import { DynamicApiAuthOptions } from './interfaces';
 import { JwtStrategy } from './strategies';
 export declare class AuthModule {
-    static forRoot<Entity extends BaseEntity>({ user: { entity: userEntity, loginField, passwordField, requestAdditionalFields, }, jwt: { secret, expiresIn }, register, login, validationPipeOptions, }: DynamicApiAuthOptions<Entity>, extraImports?: any[]): {
+    static forRoot<Entity extends BaseEntity>({ userEntity, login: { loginField, passwordField, ...login }, register, resetPassword, jwt: { secret, expiresIn }, validationPipeOptions, }: DynamicApiAuthOptions<Entity>, extraImports?: any[]): {
         module: typeof AuthModule;
         imports: any[];
         providers: (typeof BcryptService | import("../../interfaces/dynamic-api-service-provider.interface").DynamicAPIServiceProvider | typeof JwtStrategy)[];

package/src/modules/auth/auth.module.js

@@ -18,9 +18,13 @@ const services_1 = require("../../services");
 const auth_helper_1 = require("./auth.helper");
 const strategies_1 = require("./strategies");
 let AuthModule = AuthModule_1 = class AuthModule {
-    static forRoot({ user: { entity: userEntity, loginField, passwordField, requestAdditionalFields, }, jwt: { secret, expiresIn }, register, login, validationPipeOptions, }, extraImports = []) {
-        const AuthController = (0, auth_helper_1.createAuthController)(userEntity, loginField, passwordField, requestAdditionalFields, register, validationPipeOptions);
-        const AuthServiceProvider = (0, auth_helper_1.createAuthServiceProvider)(userEntity, loginField, passwordField, requestAdditionalFields, register.callback, login.callback);
+    static forRoot({ userEntity, login: { loginField, passwordField, ...login }, register, resetPassword, jwt: { secret, expiresIn }, validationPipeOptions, }, extraImports = []) {
+        const { resetPasswordCallback, changePasswordCallback, emailField, expirationInMinutes } = resetPassword;
+        const resetPasswordOptions = resetPasswordCallback
+            ? { resetPasswordCallback, changePasswordCallback, emailField, expirationInMinutes }
+            : undefined;
+        const AuthController = (0, auth_helper_1.createAuthController)(userEntity, { loginField, passwordField, ...login }, register, validationPipeOptions, resetPasswordOptions);
+        const AuthServiceProvider = (0, auth_helper_1.createAuthServiceProvider)(userEntity, { loginField, passwordField, ...login }, register.callback, resetPasswordOptions);
         const LocalStrategyProvider = (0, auth_helper_1.createLocalStrategyProvider)(loginField, passwordField);
         return {
             module: AuthModule_1,

package/src/modules/auth/dtos/change-password.dto.d.ts

@@ -0,0 +1,4 @@
+export declare class ChangePasswordDto {
+    resetPasswordToken: string;
+    newPassword: string;
+}

package/src/modules/auth/dtos/change-password.dto.js

@@ -0,0 +1,29 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangePasswordDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+class ChangePasswordDto {
+}
+exports.ChangePasswordDto = ChangePasswordDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", String)
+], ChangePasswordDto.prototype, "resetPasswordToken", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", String)
+], ChangePasswordDto.prototype, "newPassword", void 0);

package/src/modules/auth/dtos/reset-password.dto.d.ts

@@ -0,0 +1,3 @@
+export declare class ResetPasswordDto {
+    email: string;
+}

package/src/modules/auth/dtos/reset-password.dto.js

@@ -0,0 +1,24 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResetPasswordDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+class ResetPasswordDto {
+}
+exports.ResetPasswordDto = ResetPasswordDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsEmail)(),
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", String)
+], ResetPasswordDto.prototype, "email", void 0);

package/src/modules/auth/interfaces/auth-options.interface.d.ts

@@ -1,33 +1,39 @@
 import { Type, ValidationPipeOptions } from '@nestjs/common';
-import { DynamicApiServiceCallback, RegisterAbilityPredicate } from '../../../interfaces';
+import { DynamicApiResetPasswordCallback, DynamicApiServiceCallback, AuthAbilityPredicate } from '../../../interfaces';
 import { BaseEntity } from '../../../models';
 type DynamicApiJWTOptions = {
     secret: string;
     expiresIn?: string | number;
 };
 type DynamicApiLoginOptions<Entity extends BaseEntity = any> = {
+    loginField?: keyof Entity;
+    passwordField?: keyof Entity;
     callback?: DynamicApiServiceCallback<Entity>;
+    abilityPredicate?: AuthAbilityPredicate;
+    additionalFields?: (keyof Entity)[];
 };
 type DynamicApiRegisterOptions<Entity extends BaseEntity = any> = {
     callback?: DynamicApiServiceCallback<Entity>;
     protected?: boolean;
-    abilityPredicate?: RegisterAbilityPredicate;
+    abilityPredicate?: AuthAbilityPredicate;
     additionalFields?: (keyof Entity | {
         name: keyof Entity;
         required?: boolean;
     })[];
 };
-type DynamicApiUserOptions<Entity extends BaseEntity = any> = {
-    entity: Type<Entity>;
-    loginField?: keyof Entity;
-    passwordField?: keyof Entity;
-    requestAdditionalFields?: (keyof Entity)[];
+type DynamicApiResetPasswordOptions<Entity extends BaseEntity = any> = {
+    emailField: keyof Entity | string;
+    expirationInMinutes: number;
+    resetPasswordCallback: DynamicApiResetPasswordCallback<Entity>;
+    changePasswordCallback: DynamicApiServiceCallback<Entity>;
+    abilityPredicate?: AuthAbilityPredicate;
 };
 type DynamicApiAuthOptions<Entity extends BaseEntity = any> = {
-    user: DynamicApiUserOptions<Entity>;
+    userEntity: Type<Entity>;
     login?: DynamicApiLoginOptions<Entity>;
     register?: DynamicApiRegisterOptions<Entity>;
     jwt?: DynamicApiJWTOptions;
+    resetPassword?: Partial<DynamicApiResetPasswordOptions<Entity>>;
     validationPipeOptions?: ValidationPipeOptions;
 };
-export type { DynamicApiAuthOptions, DynamicApiRegisterOptions, DynamicApiUserOptions, DynamicApiJWTOptions, DynamicApiLoginOptions, };
+export type { DynamicApiAuthOptions, DynamicApiRegisterOptions, DynamicApiJWTOptions, DynamicApiLoginOptions, DynamicApiResetPasswordOptions, };