mongodb-dynamic-api 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 Changelog
 
+## [2.1.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.1.0...v2.1.1) (2024-03-21)
+
+## [2.1.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.0.0...v2.1.0) (2024-03-20)
+
+
+### schema
+
+* **schema:** add the possibility to customize initialization ([7fd541b](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/7fd541b055bb0baa60409651a54d42244d8f3042))
+
 ## [2.0.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.4.3...v2.0.0) (2024-03-18)
 
 

package/README.md

@@ -63,7 +63,7 @@ npm install --save mongodb-dynamic-api
 
 <p style="text-align: justify; width: 100%;font-size: 15px;">
 
-In summary, DynamicApiModule is a flexible and configurable module using NestJS 10 that provides dynamic API functionality.
+In summary, DynamicApiModule is a flexible and configurable module using NestJS 10 that provides dynamic API functionality for your contents.
 <br>It must be set up at the root level with global settings and then configured for individual features.
 <br>It has several optional features such as
 [Swagger UI](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/swagger-ui.md),
@@ -113,11 +113,11 @@ export class AppModule {}
 - Ok, now let's add our first content with just 2 files. It will be a simple `User` with a `name` and an `email` field.
 - We use the `@Schema` and `@Prop` decorators from the <a href="https://docs.nestjs.com/techniques/mongodb#model-injection" target="_blank">@nestjs/mongoose</a> package to define our MongoDB model.
 
-- You must extend the `BaseEntity` | `SoftDeletableEntity` class from the `mongodb-dynamic-api` package **for all your collection models**.
-  **See more details [here](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/entities.md)**.
+- You must extend the `BaseEntity` | `SoftDeletableEntity` class from the `mongodb-dynamic-api` package for all your **collection models**.
+  See more details **[here](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/entities.md)**.
 
 - You can also add the `@DynamicAPISchemaOptions` decorator to pass schema options.
-**See more details [here](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/schema-options.md)**.
+See more details **[here](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/schema-options.md)**.
 
 Just create a new file `user.ts` and add the following code.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-dynamic-api",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Auto generated CRUD API for MongoDB using NestJS",
   "readmeFilename": "README.md",
   "main": "index.js",

package/src/helpers/schema.helper.js

@@ -5,7 +5,7 @@ const mongoose_1 = require("@nestjs/mongoose");
 const decorators_1 = require("../decorators");
 const interfaces_1 = require("../interfaces");
 function buildSchemaFromEntity(entity) {
-    const { indexes, hooks } = Reflect.getOwnMetadata(decorators_1.DYNAMIC_API_SCHEMA_OPTIONS_METADATA, entity) ?? {};
+    const { indexes, hooks, customInit } = Reflect.getOwnMetadata(decorators_1.DYNAMIC_API_SCHEMA_OPTIONS_METADATA, entity) ?? {};
     const schema = mongoose_1.SchemaFactory.createForClass(entity);
     if (Object.getOwnPropertyNames(schema.paths).includes('createdAt')) {
         schema.set('timestamps', true);
@@ -22,6 +22,9 @@ function buildSchemaFromEntity(entity) {
             schema[method](isSoftDeletable && softDeletableQuery ? softDeletableQuery : query, { document: true, query: true, ...options }, callback);
         });
     }
+    if (customInit) {
+        customInit(schema);
+    }
     return schema;
 }
 exports.buildSchemaFromEntity = buildSchemaFromEntity;

package/src/interfaces/dynamic-api-schema-options.interface.d.ts

@@ -22,7 +22,7 @@
 /// <reference types="mongoose/types/validation" />
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
-import { IndexDefinition, IndexOptions } from 'mongoose';
+import { IndexDefinition, IndexOptions, Schema } from 'mongoose';
 import { RouteType } from './dynamic-api-route-type.type';
 type HookEvent = RouteType;
 type MongoDBQuery = 'deleteMany' | 'deleteOne' | 'find' | 'findOne' | 'findOneAndReplace' | 'findOneAndUpdate' | 'save' | 'updateMany' | 'updateOne';
@@ -45,5 +45,6 @@ interface DynamicAPISchemaOptionsInterface {
         options?: IndexOptions;
     }[];
     hooks?: SchemaHook[];
+    customInit?: (schema: Schema) => void;
 }
 export type { SchemaHook, DynamicAPISchemaOptionsInterface };

package/src/modules/auth/services/base-auth.service.js

@@ -14,7 +14,7 @@ class BaseAuthService extends services_1.BaseService {
     }
     async validateUser(login, pass) {
         const user = (await this.model.findOne({ [this.loginField]: login }).lean().exec());
-        if (!user || !await this.bcryptService.compare(pass, user[this.passwordField])) {
+        if (!user || !await this.bcryptService.comparePassword(pass, user[this.passwordField])) {
             return null;
         }
         const fieldsToBuild = [
@@ -37,7 +37,7 @@ class BaseAuthService extends services_1.BaseService {
         };
     }
     async register(userToCreate) {
-        const hashedPassword = await this.bcryptService.hash(userToCreate[this.passwordField]);
+        const hashedPassword = await this.bcryptService.hashPassword(userToCreate[this.passwordField]);
         const { _id } = await this.model.create({ ...userToCreate, [this.passwordField]: hashedPassword });
         const user = await this.getUserById(_id.toString());
         return this.login(user);
@@ -52,7 +52,7 @@ class BaseAuthService extends services_1.BaseService {
         return this.buildInstance(fieldsToBuild.reduce((acc, field) => (user[field] !== undefined ? { ...acc, [field]: user[field] } : acc), {}));
     }
     async changePassword(userId, newPassword) {
-        const hashedPassword = await this.bcryptService.hash(newPassword);
+        const hashedPassword = await this.bcryptService.hashPassword(newPassword);
         const { _id } = await this.model.findOneAndUpdate({ _id: userId }, { [this.passwordField]: hashedPassword }, { new: true });
         const user = await this.getUserById(_id.toString());
         return this.login(user);

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

@@ -1,5 +1,5 @@
 export declare class BcryptService {
     private readonly saltOrRounds;
-    hash(password: string): Promise<string>;
-    compare(password: string, hash: string): Promise<boolean>;
+    hashPassword(password: string): Promise<string>;
+    comparePassword(password: string, hash: string): Promise<boolean>;
 }

package/src/services/bcrypt/bcrypt.service.js

@@ -13,10 +13,10 @@ let BcryptService = class BcryptService {
     constructor() {
         this.saltOrRounds = 10;
     }
-    async hash(password) {
+    async hashPassword(password) {
         return bcrypt.hash(password, this.saltOrRounds);
     }
-    async compare(password, hash) {
+    async comparePassword(password, hash) {
         return bcrypt.compare(password, hash);
     }
 };

package/src/version.json

@@ -1,3 +1,3 @@
 {
-    "version": "2.0.0"
+    "version": "2.1.1"
 }