mongodb-dynamic-api 2.2.1 → 2.3.0

package/src/routes/delete-many/delete-many-controller.mixin.js

@@ -16,10 +16,9 @@ exports.DeleteManyControllerMixin = void 0;
 const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function DeleteManyControllerMixin(entity, controllerOptions, routeConfig, version) {
-    const { routeType, description, isPublic, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         presenter: RoutePresenter,
     });

package/src/routes/delete-one/delete-one-controller.mixin.js

@@ -16,10 +16,9 @@ exports.DeleteOneControllerMixin = void 0;
 const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function DeleteOneControllerMixin(entity, controllerOptions, routeConfig, version) {
-    const { routeType, description, isPublic, EntityParam, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, EntityParam, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         param: EntityParam,
         presenter: RoutePresenter,

package/src/routes/duplicate-many/base-duplicate-many.service.js

@@ -33,7 +33,7 @@ class BaseDuplicateManyService extends services_1.BaseService {
                 .lean()
                 .exec();
             if (this.callback && documents.length) {
-                await Promise.all(documents.map((document) => this.callback(document, this.model)));
+                await Promise.all(documents.map((document) => this.callback(document, this.callbackMethods)));
             }
             return documents.map((d) => this.buildInstance(d));
         }

package/src/routes/duplicate-many/duplicate-many-controller.mixin.js

@@ -16,11 +16,10 @@ exports.DuplicateManyControllerMixin = void 0;
 const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function DuplicateManyControllerMixin(entity, controllerOptions, routeConfig, version) {
     var _a;
-    const { routeType, description, isPublic, RouteBody, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, RouteBody, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         body: RouteBody,
         presenter: RoutePresenter,

package/src/routes/duplicate-one/base-duplicate-one.service.js

@@ -31,7 +31,7 @@ class BaseDuplicateOneService extends services_1.BaseService {
             });
             const document = await this.model.findOne({ _id }).lean().exec();
             if (this.callback) {
-                await this.callback(document, this.model);
+                await this.callback(document, this.callbackMethods);
             }
             return this.buildInstance(document);
         }

package/src/routes/duplicate-one/duplicate-one-controller.mixin.js

@@ -17,11 +17,10 @@ const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const dtos_1 = require("../../dtos");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function DuplicateOneControllerMixin(entity, controllerOptions, routeConfig, version) {
     var _a;
-    const { routeType, description, isPublic, RouteBody, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, RouteBody, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder('DuplicateOne', entity, version, description, isPublic, {
         param: dtos_1.EntityParam,
         body: RouteBody,

package/src/routes/get-many/base-get-many.service.js

@@ -16,7 +16,7 @@ class BaseGetManyService extends services_1.BaseService {
             .lean()
             .exec();
         if (this.callback && documents.length) {
-            await Promise.all(documents.map((document) => this.callback(document, this.model)));
+            await Promise.all(documents.map((document) => this.callback(document, this.callbackMethods)));
         }
         return documents.map((d) => this.buildInstance(d));
     }

package/src/routes/get-many/get-many-controller.mixin.js

@@ -17,10 +17,9 @@ const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const dtos_1 = require("../../dtos");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function GetManyControllerMixin(entity, controllerOptions, routeConfig, version) {
-    const { routeType, description, isPublic, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     class RouteQuery extends (routeConfig.dTOs?.query ?? dtos_1.EntityQuery) {
     }
     Object.defineProperty(RouteQuery, 'name', {

package/src/routes/get-one/base-get-one.service.js

@@ -19,7 +19,7 @@ class BaseGetOneService extends services_1.BaseService {
             this.handleDocumentNotFound();
         }
         if (this.callback) {
-            await this.callback(document, this.model);
+            await this.callback(document, this.callbackMethods);
         }
         return this.buildInstance(document);
     }

package/src/routes/get-one/get-one-controller.mixin.js

@@ -17,10 +17,9 @@ const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const dtos_1 = require("../../dtos");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function GetOneControllerMixin(entity, controllerOptions, routeConfig, version) {
-    const { routeType, description, isPublic, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         param: dtos_1.EntityParam,
         presenter: RoutePresenter,

package/src/routes/replace-one/base-replace-one.service.js

@@ -23,7 +23,7 @@ class BaseReplaceOneService extends services_1.BaseService {
                 this.handleDocumentNotFound();
             }
             if (this.callback) {
-                await this.callback(document, this.model);
+                await this.callback(document, this.callbackMethods);
             }
             return this.buildInstance(document);
         }

package/src/routes/replace-one/replace-one-controller.mixin.js

@@ -16,11 +16,10 @@ exports.ReplaceOneControllerMixin = void 0;
 const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function ReplaceOneControllerMixin(entity, controllerOptions, routeConfig, version) {
     var _a;
-    const { routeType, description, isPublic, EntityParam, RouteBody, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, EntityParam, RouteBody, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         param: EntityParam,
         body: RouteBody,

package/src/routes/update-many/base-update-many.service.js

@@ -22,7 +22,7 @@ class BaseUpdateManyService extends services_1.BaseService {
                 .exec();
             const documents = await this.model.find({ _id: { $in: ids } }).lean().exec();
             if (this.callback && documents.length) {
-                await Promise.all(documents.map((document) => this.callback(document, this.model)));
+                await Promise.all(documents.map((document) => this.callback(document, this.callbackMethods)));
             }
             return documents.map((d) => this.buildInstance(d));
         }

package/src/routes/update-many/update-many-controller.mixin.js

@@ -16,11 +16,10 @@ exports.UpdateManyControllerMixin = void 0;
 const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function UpdateManyControllerMixin(entity, controllerOptions, routeConfig, version) {
     var _a;
-    const { routeType, description, isPublic, RouteBody, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, RouteBody, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         body: RouteBody,
         presenter: RoutePresenter,

package/src/routes/update-one/base-update-one.service.js

@@ -20,7 +20,7 @@ class BaseUpdateOneService extends services_1.BaseService {
                 this.handleDocumentNotFound();
             }
             if (this.callback) {
-                await this.callback(document, this.model);
+                await this.callback(document, this.callbackMethods);
             }
             return this.buildInstance(document);
         }

package/src/routes/update-one/update-one-controller.mixin.js

@@ -16,11 +16,10 @@ exports.UpdateOneControllerMixin = void 0;
 const common_1 = require("@nestjs/common");
 const builders_1 = require("../../builders");
 const helpers_1 = require("../../helpers");
-const controller_mixin_helper_1 = require("../../helpers/controller-mixin.helper");
 const mixins_1 = require("../../mixins");
 function UpdateOneControllerMixin(entity, controllerOptions, routeConfig, version) {
     var _a;
-    const { routeType, description, isPublic, EntityParam, RouteBody, RoutePresenter, abilityPredicate, } = (0, controller_mixin_helper_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
+    const { routeType, description, isPublic, EntityParam, RouteBody, RoutePresenter, abilityPredicate, } = (0, helpers_1.getControllerMixinData)(entity, controllerOptions, routeConfig, version);
     const routeDecoratorsBuilder = new builders_1.RouteDecoratorsBuilder(routeType, entity, version, description, isPublic, {
         param: EntityParam,
         body: RouteBody,

package/src/services/base/base.service.d.ts

@@ -24,17 +24,21 @@
 /// <reference types="mongoose/types/inferschematype" />
 import { Type } from '@nestjs/common';
 import { FilterQuery, Model, Schema } from 'mongoose';
-import { AbilityPredicate } from '../../interfaces';
+import { AbilityPredicate, DynamicApiCallbackMethods } from '../../interfaces';
 import { BaseEntity } from '../../models';
+import { DynamicApiResetPasswordOptions } from '../../modules';
 export declare abstract class BaseService<Entity extends BaseEntity> {
     protected readonly model: Model<Entity>;
     abilityPredicate: AbilityPredicate<Entity> | undefined;
     user: unknown;
     protected readonly entity: Type<Entity>;
+    protected readonly passwordField: keyof Entity | undefined;
+    protected readonly resetPasswordOptions: DynamicApiResetPasswordOptions<Entity> | undefined;
+    protected readonly callbackMethods: DynamicApiCallbackMethods<Entity>;
     protected constructor(model: Model<Entity>);
     get isSoftDeletable(): boolean;
     findManyDocuments(conditions?: FilterQuery<Entity>): Promise<Entity[]>;
-    findOneDocument(_id: string | Schema.Types.ObjectId, conditions?: FilterQuery<Entity>): Promise<Entity>;
+    findOneDocument(_id: string | Schema.Types.ObjectId | undefined, conditions?: FilterQuery<Entity>): Promise<Entity>;
     protected buildInstance(document: Entity): Entity;
     protected handleAbilityPredicate(document: Entity): void;
     protected handleDuplicateKeyError(error: any): void;

package/src/services/base/base.service.js

@@ -6,6 +6,25 @@ const builder_pattern_1 = require("builder-pattern");
 class BaseService {
     constructor(model) {
         this.model = model;
+        this.callbackMethods = {
+            findById: async (id) => {
+                const entity = await this.model.findOne({ _id: id }).lean().exec();
+                if (!entity) {
+                    return;
+                }
+                return this.buildInstance(entity);
+            },
+            findAndUpdateById: async (id, update) => {
+                if (this.passwordField && typeof update[this.passwordField] !== 'undefined') {
+                    throw new common_1.BadRequestException(`${this.passwordField} cannot be updated using this method because it is hashed. Use reset password process instead.`);
+                }
+                const updated = await this.model.findOneAndUpdate({ _id: id }, update, { new: true }).lean().exec();
+                if (!updated) {
+                    this.handleDocumentNotFound();
+                }
+                return this.buildInstance(updated);
+            },
+        };
     }
     get isSoftDeletable() {
         const paths = Object.getOwnPropertyNames(this.model.schema.paths);
@@ -24,7 +43,7 @@ class BaseService {
     async findOneDocument(_id, conditions = {}) {
         const document = await this.model
             .findOne({
-            _id,
+            ...(_id ? { _id } : {}),
             ...conditions,
         })
             .lean()

package/src/version.json

@@ -1,3 +1,3 @@
 {
-    "version": "2.2.1"
+    "version": "2.3.0"
 }