mongodb-dynamic-api 1.6.0 → 2.1.0

package/CHANGELOG.md

@@ -1,43 +1,96 @@
 Changelog
 
-## [1.6.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/release...1.6.0) (2024-03-03)
+## [2.1.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v2.0.0...v2.1.0) (2024-03-20)
 
-## [1.5.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/release...1.5.0) (2024-03-03)
 
-## [1.4.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/release...1.4.0) (2024-03-02)
+### schema
 
-## [1.3.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/1.3.0-beta.0...1.3.0) (2024-03-02)
+* **schema:** add the possibility to customize initialization ([7fd541b](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/7fd541b055bb0baa60409651a54d42244d8f3042))
 
-## [1.3.0-beta.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/release...1.3.0-beta.0) (2024-03-02)
+## [2.0.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.4.3...v2.0.0) (2024-03-18)
 
-## [1.2.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/1.2.0-beta.8...1.2.0) (2024-03-02)
 
-## [1.2.0-beta.8](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/release...1.2.0-beta.8) (2024-03-02)
+### ⚠ BREAKING CHANGES
 
-## [1.2.0-beta.7](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.7) (2024-03-02)
+* **schema-options:** bind event type to route type to improve understanding
+* **authentication:** rework options
 
-## [1.2.0-beta.6](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.6) (2024-03-01)
+### schema-options
 
-## [1.2.0-beta.5](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.5) (2024-03-01)
+* **schema-options:** bind event type to route type to improve understanding ([8a6a391](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/8a6a391c19a68697998ed6508d88ed63c1fbde7d))
 
-## [1.2.0-beta.4](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.4) (2024-02-29)
 
-## [1.2.0-beta.3](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.3) (2024-02-29)
+### authentication
 
-## [1.2.0-beta.2](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.2) (2024-02-29)
+* **authentication:** rework options ([e833898](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/e833898903279e1e1e220b065724e013b1729029))
 
-## [1.2.0-beta.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.1) (2024-02-29)
+## [1.4.3](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.4.2...v1.4.3) (2024-03-15)
 
-## [1.2.0-beta.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/prerelease...1.2.0-beta.0) (2024-02-29)
+## [1.4.2](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.4.1...v1.4.2) (2024-03-15)
 
-## [1.1.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/mongodb-dynamic-api-v1.1.0...mongodb-dynamic-api-v1.2.0) (2024-02-28)
+## [1.4.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.4.0...v1.4.1) (2024-03-12)
 
+## [1.4.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.3.3...v1.4.0) (2024-03-11)
 
-### Features
 
-* **routes:** add create-many module ([f6b6a25](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/f6b6a25edfc924ce5e305951db97c353465156e3))
+### authentication
+
+* **authentication:** add register ability predicate ([811b085](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/811b0853ed836ce33a7a56312c3e045b5f73f5ee))
+
+
+### api
+
+* **api:** add authentication ([a692b7b](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/a692b7b0fcd774dc5152b9f82ed22107c543110a))
+* **api:** add casl ability to control route access ([6202a24](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/6202a247d301a7a72ce47f596a288d66724999f1))
+
+## [1.3.3](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.3.2...v1.3.3) (2024-03-06)
+
+
+### api
+
+* **api:** display the package version in swagger by default ([36520c3](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/36520c37abdd4fcbbfeed333a68ea0a108533b39))
+
+## [1.3.2](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.3.1...v1.3.2) (2024-03-05)
+
+## [1.3.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.3.0...v1.3.1) (2024-03-05)
+
+## [1.3.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.2.1...v1.3.0) (2024-03-04)
+
+
+### api
+
+* **api:** add delete many route ([43a89cb](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/43a89cb4c087c468743559950fa232ff6e10c140))
+* **api:** add duplicate many route ([be33d1b](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/be33d1b221d81c5ff6649cd2eccc331cb58459b9))
+* **api:** add update many route ([7543eb9](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/7543eb92d7ba538f6d46b69ec194a6c44daff5b2))
+
+## [1.2.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.2.0...v1.2.1) (2024-03-04)
+
+
+## [1.2.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v1.1.0...v1.2.0) (2024-03-03)
+
+
+### api
+
+* **api:** add default route description if not specified ([733b42a](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/733b42a6dab49c39370fdd4094b7f08288e54c5b))
+
+## 1.1.0 (2024-03-03)
+
+
+### api
+
+* **api:** add the possibility to enable the api uri versioning ([0f52917](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/0f529174ea583078bb136d2db484ef64b6aa6e49))
+* **api:** correct CreateMany response type and body ([804b7d5](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/804b7d55fe2b8b515436b41fa338be75c5e030e2))
+* **api:** make routes optional, add all routes automatically if not configured ([f17e2eb](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/f17e2ebdbbde8f05a5c80c404ffc1febf460bc20))
+* **api:** set duplicate one body optional ([f24b2b9](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/f24b2b964e251fbb92acfc14222386fec3239dcb))
+* **api:** add create-many module ([9ae72d5](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/9ae72d5dd7bda27423f96dd642d41eff31e75370))
+
+
+### swagger
+
+* **swagger:** add enable method ([5f3f865](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/5f3f8656dc186e833d5c4792efacf9f0a2005afd))
+
 
-## [1.0.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/mongodb-dynamic-api-v1.0.0...mongodb-dynamic-api-v1.1.0) (2024-02-27)
+## 1.0.0 (2024-02-27)
 
 
 ### Features

package/README.md

@@ -47,28 +47,36 @@
 
 ---
 
+## mongodb-dynamic-api <img src="https://pbs.twimg.com/media/EDoWJbUXYAArclg.png" width="24" height="24" />
+```text
+npm install --save mongodb-dynamic-api
+```
+
+---
+
 <div style="text-align: center; width: 100%;">
 
-# mongodb-dynamic-api
+# Dynamic API Module
 
 </div>
 
 
 <p style="text-align: justify; width: 100%;font-size: 15px;">
 
-**mongodb-dynamic-api** is an auto generated CRUD API for MongoDB using NestJS 10.
+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),
+[Versioning](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/versioning.md),
+[Validation](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/validation.md),
+[Caching](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/caching.md),
+[Authentication](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/authentication.md) and
+[Authorization](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/authorization.md).
 
 </p>
 
----
-
-## npm package <img src="https://pbs.twimg.com/media/EDoWJbUXYAArclg.png" width="24" height="24" />
-```text
-npm install --save mongodb-dynamic-api
-```
-
+___
 
----
 ### HOW TO ENJOY IT
 
 - Start a new [nest](https://docs.nestjs.com/) project with **typescript** (use the `--strict` option)
@@ -76,18 +84,22 @@ npm install --save mongodb-dynamic-api
 nest new --strict your-project-name
 ```
 
-- Go to your project root and install the [mongodb-dynamic-api](https://www.npmjs.com/package/mongodb-dynamic-api) package
+- Go to your new project root and install the [mongodb-dynamic-api](https://www.npmjs.com/package/mongodb-dynamic-api) package
 ```text
 npm i -S mongodb-dynamic-api
 ```
+**Basic Configuration**
+
+- Add `DynamicApiModule.forRoot` to your `app.module.ts` and pass your **MongoDB connection string** to the method.
 
-- Add DynamicApiModule to your app.module.ts and pass the MongoDB connection string to the `forRoot` method
 ```typescript
+// src/app.module.ts
+import { DynamicApiModule } from 'mongodb-dynamic-api';
+
 @Module({
   imports: [
-    // ...
     DynamicApiModule.forRoot(
-      // <- pass the MongoDB connection string here
+      'mongodb-uri', // <- replace by your own MongoDB connection string
     ),
     // ...
   ],
@@ -96,24 +108,46 @@ npm i -S mongodb-dynamic-api
 })
 export class AppModule {}
 ```
+**Basic Usage**
+
+- 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 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)**.
+
+Just create a new file `user.ts` and add the following code.
 
-- Ok, now let's add our first content. This content will be a simple `User` with a `name` and an `email` field.
 ```typescript
-// user.ts
+// src/users/user.ts
+import { Prop, Schema } from '@nestjs/mongoose';
+import { BaseEntity } from 'mongodb-dynamic-api';
+
 @Schema({ collection: 'users' })
-export class User extends BaseEntity { // <- you must extend BaseEntity
-  @Prop({ type: String })
+export class User extends BaseEntity { // <- extends BaseEntity
+  @Prop({ type: String, required: true })
   name: string;
 
-  @Prop({ type: String })
+  @Prop({ type: String, required: true })
   email: string;
 }
 ```
+
+- Then we will use the `DynamicApiModule.forFeature` method to add the `User` API to our application.
+- We pass the `User` class to the `entity` property and specify the path `users` to the `controllerOptions` property.
+- Create a new file `users.module.ts` and add the following code.
+
 ```typescript
-// users.module.ts
+// src/users/users.module.ts
+import { DynamicApiModule } from 'mongodb-dynamic-api';
+import { User } from './user';
+
 @Module({
   imports: [
-    DynamicApiModule.forFeature({ // <- use the forFeature method to add the User content
+    DynamicApiModule.forFeature({
       entity: User,
       controllerOptions: {
         path: 'users',
@@ -123,13 +157,20 @@ export class User extends BaseEntity { // <- you must extend BaseEntity
 })
 export class UsersModule {}
 ```
+
+- Last step, add the `UsersModule` to the **imports** in the `app.module.ts` after the `DynamicApiModule.forRoot` method.
+
 ```typescript
-// app.module.ts
+// src/app.module.ts
+import { DynamicApiModule } from 'mongodb-dynamic-api';
+import { UsersModule } from './users/users.module';
+
 @Module({
   imports: [
-    // ...
-    DynamicApiModule.forRoot('...'),
-    UsersModule, // <- add the module to the imports after the DynamicApiModule
+    DynamicApiModule.forRoot(
+      'mongodb-uri', // <- replace by your own MongoDB connection string
+    ),
+    UsersModule,
   ],
   controllers: [AppController],
   providers: [AppService],
@@ -137,54 +178,37 @@ export class UsersModule {}
 export class AppModule {}
 ```
 
-**That's all !** *You now have a fully functional CRUD API for the `User` content at the `/users` path.*
+**And that's all !** *You now have a fully functional CRUD API for the `User` content at the `/users` path.*
 
-___
-### Swagger (optional but recommended)
-```typescript
-async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-  // ...
-  enableDynamicAPISwagger(app); // <- add this line in your main.ts file
 
-  await app.listen(3000);
-}
-```
-The `enableDynamicAPISwagger` function will automatically build the swagger documentation.
-This method can be called with optional parameters to specify more documentation options.
+| Endpoint                                          |                      Body                      |    Param     |      Query      |
+|:--------------------------------------------------|:----------------------------------------------:|:------------:|:---------------:|
+| GET **/users**               <br>*Get many*       |                       x                        |      x       |        x        |
+| GET **/users/:id**           <br>*Get one*        |                       x                        | `id: string` |        x        |
+| POST **/users/many**         <br>*Create many*    | `{ list: [{ name: string; email: string; }] }` |      x       |        x        |
+| POST **/users**              <br>*Create one*     |       `{ name: string; email: string; }`       |      x       |        x        |
+| PUT **/users/:id**           <br>*Replace one*    |       `{ name: string; email: string; }`       | `id: string` |        x        |
+| PATCH **/users**             <br>*Update many*    |      `{ name?: string; email?: string; }`      |      x       | `ids: string[]` |
+| PATCH **/users/:id**         <br>*Update one*     |      `{ name?: string; email?: string; }`      | `id: string` |        x        |
+| DELETE **/users**            <br>*Delete many*    |                       x                        |      x       | `ids: string[]` |
+| DELETE **/users/:id**        <br>*Delete one*     |                       x                        | `id: string` |        x        |
+| POST **/users/duplicate**    <br>*Duplicate many* |      `{ name?: string; email?: string; }`      |      x       | `ids: string[]` |
+| POST **/users/duplicate/:id**<br>*Duplicate one*  |      `{ name?: string; email?: string; }`      | `id: string` |        x        |
 
-Do not forget to add the `@ApiProperty` decorator to your entity properties to have a better swagger documentation.
-```typescript
-// user.entity.ts
-@Schema({ collection: 'users' })
-export class UserEntity extends BaseEntity {
-  @ApiProperty() // <- add this line
-  @Prop({ type: String })
-  name: string;
-  
-  @ApiProperty() // <- add this line
-  @Prop({ type: String })
-  email: string;
-}
-```
+___
 
-go to the swagger API path (default to `/openapi`) and you will see the auto generated API
+Go further with optional features like:
+- **[Swagger UI](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/swagger-ui.md)**
+- **[Versioning](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/versioning.md)**
+- **[Validation](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/validation.md)** with **Class Validator**
+- **[Caching](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/caching.md)** with **cache-manager**
+- **[Authentication](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/authentication.md)** with **JWT**
+- **[Authorization](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/authorization.md)** with **Casl**
 
 
-![User API](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/images/dynamic-api-user-full.Jpeg?raw=true "User API")
 
-[more screenshots](https://github.com/MikeDev75015/mongodb-dynamic-api/blob/develop/README/swagger.md)
 
-___
-### Versioning (optional)
-```typescript
-async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-  // ...
-  enableDynamicAPIVersioning(app); // <- add this line in your main.ts file
+<br>
+<br>
+<br>
 
-  await app.listen(3000);
-}
-```
-The `enableDynamicAPIVersioning` function will automatically add versioning to the API. By default it will use the URI versioning type.
-This method can be called with a second optional parameter to specify more options.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-dynamic-api",
-  "version": "1.6.0",
+  "version": "2.1.0",
   "description": "Auto generated CRUD API for MongoDB using NestJS",
   "readmeFilename": "README.md",
   "main": "index.js",
@@ -38,17 +38,26 @@
   },
   "homepage": "https://mikedev75015.github.io",
   "dependencies": {
+    "@casl/ability": "^6.7.0",
+    "@nestjs/cache-manager": "^2.2.1",
     "@nestjs/common": "^10.3.2",
     "@nestjs/core": "^10.3.2",
+    "@nestjs/jwt": "^10.2.0",
     "@nestjs/mongoose": "^10.0.4",
+    "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.3.2",
     "@nestjs/swagger": "^7.3.0",
     "@types/lodash": "^4.14.202",
+    "bcrypt": "^5.1.1",
     "builder-pattern": "^2.2.0",
+    "cache-manager": "^5.4.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "lodash": "^4.17.21",
     "mongoose": "^8.1.1",
+    "passport": "^0.7.0",
+    "passport-jwt": "^4.0.1",
+    "passport-local": "^1.0.0",
     "reflect-metadata": "^0.2.1",
     "rxjs": "^7.8.1"
   },
@@ -61,9 +70,12 @@
     "@release-it/conventional-changelog": "^8.0.1",
     "@swc/cli": "^0.3.9",
     "@swc/core": "^1.4.0",
+    "@types/bcrypt": "^5.0.2",
     "@types/express": "^4.17.21",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.16",
+    "@types/passport-jwt": "^4.0.1",
+    "@types/passport-local": "^1.0.38",
     "@types/supertest": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",

package/src/builders/casl/casl-ability.builder.d.ts

@@ -0,0 +1,5 @@
+import { Type } from '@nestjs/common';
+import { AppAbility, DynamicApiRouteCaslAbilityPredicate, RouteType } from '../../interfaces';
+import { BaseEntity } from '../../models';
+declare function CaslAbilityBuilder<Entity extends BaseEntity>(entity: Type<Entity>, routeType: RouteType, abilityPredicate: DynamicApiRouteCaslAbilityPredicate<Entity>, user: unknown): AppAbility<Entity>;
+export { CaslAbilityBuilder };

package/src/builders/casl/casl-ability.builder.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaslAbilityBuilder = void 0;
+const ability_1 = require("@casl/ability");
+function CaslAbilityBuilder(entity, routeType, abilityPredicate, user) {
+    const { can, build } = new ability_1.AbilityBuilder(ability_1.createMongoAbility);
+    if (abilityPredicate(new entity(), user)) {
+        can(routeType, entity);
+    }
+    return build({
+        detectSubjectType: (object) => object.constructor
+    });
+}
+exports.CaslAbilityBuilder = CaslAbilityBuilder;

package/src/builders/index.d.ts

@@ -1 +1,3 @@
-export * from './route-decorators.builder';
+export * from './casl/casl-ability.builder';
+export * from './route-decorators/auth-decorators.builder';
+export * from './route-decorators/route-decorators.builder';

package/src/builders/index.js

@@ -14,4 +14,6 @@ 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("./route-decorators.builder"), exports);
+__exportStar(require("./casl/casl-ability.builder"), exports);
+__exportStar(require("./route-decorators/auth-decorators.builder"), exports);
+__exportStar(require("./route-decorators/route-decorators.builder"), exports);

package/src/builders/route-decorators/auth-decorators.builder.d.ts

@@ -0,0 +1,7 @@
+import { DynamicApiDecoratorBuilder } from '../../interfaces';
+declare class AuthDecoratorsBuilder implements DynamicApiDecoratorBuilder<any> {
+    private readonly protectRegister;
+    constructor(protectRegister: boolean | undefined);
+    build(): (ClassDecorator & MethodDecorator)[];
+}
+export { AuthDecoratorsBuilder };

package/src/builders/route-decorators/auth-decorators.builder.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthDecoratorsBuilder = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const decorators_1 = require("../../decorators");
+class AuthDecoratorsBuilder {
+    constructor(protectRegister) {
+        this.protectRegister = protectRegister;
+    }
+    build() {
+        return !this.protectRegister ? [(0, decorators_1.Public)()] : [(0, swagger_1.ApiBearerAuth)()];
+    }
+}
+exports.AuthDecoratorsBuilder = AuthDecoratorsBuilder;

package/src/builders/route-decorators/route-decorators.builder.d.ts

@@ -0,0 +1,23 @@
+import { Type } from '@nestjs/common';
+import { DynamicApiDecoratorBuilder, RouteType } from '../../interfaces';
+import { BaseEntity } from '../../models';
+declare class RouteDecoratorsBuilder<Entity extends BaseEntity> implements DynamicApiDecoratorBuilder<Entity> {
+    private readonly routeType;
+    private readonly entity;
+    private readonly version;
+    private readonly description;
+    private readonly isPublic;
+    private readonly dTOs;
+    private readonly responseRouteTypeIsArray;
+    private readonly bodyRouteTypeIsOptional;
+    constructor(routeType: RouteType, entity: Type<Entity>, version: string | undefined, description: string | undefined, isPublic: boolean | undefined, dTOs?: {
+        param?: Type;
+        query?: Type;
+        body?: Type;
+        presenter?: Type;
+    });
+    build(): any[];
+    private getRouteDecorators;
+    private getApiDecorators;
+}
+export { RouteDecoratorsBuilder };

package/src/builders/route-decorators/route-decorators.builder.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteDecoratorsBuilder = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const lodash_1 = require("lodash");
+const decorators_1 = require("../../decorators");
+const dynamic_api_module_1 = require("../../dynamic-api.module");
+class RouteDecoratorsBuilder {
+    constructor(routeType, entity, version, description, isPublic, dTOs = {}) {
+        this.routeType = routeType;
+        this.entity = entity;
+        this.version = version;
+        this.description = description;
+        this.isPublic = isPublic;
+        this.dTOs = dTOs;
+        this.responseRouteTypeIsArray = [
+            'GetMany',
+            'CreateMany',
+            'DuplicateMany',
+        ];
+        this.bodyRouteTypeIsOptional = [
+            'DuplicateOne',
+            'DuplicateMany',
+        ];
+    }
+    build() {
+        const [paramKey] = this.dTOs.param ? (0, lodash_1.keys)(new this.dTOs.param()) : [];
+        return [
+            ...this.getRouteDecorators(paramKey),
+            ...this.getApiDecorators(paramKey),
+        ];
+    }
+    getRouteDecorators(paramKey) {
+        let routeDecorators = [];
+        const isAuthEnabled = dynamic_api_module_1.DynamicApiModule.state.get('isAuthEnabled');
+        if (this.isPublic) {
+            routeDecorators.push((0, decorators_1.Public)());
+        }
+        else if (isAuthEnabled) {
+            routeDecorators.push((0, swagger_1.ApiBearerAuth)());
+        }
+        switch (this.routeType) {
+            case 'GetMany':
+                routeDecorators.push((0, common_1.Get)());
+                break;
+            case 'GetOne':
+                routeDecorators.push((0, common_1.Get)(`:${paramKey}`));
+                break;
+            case 'CreateMany':
+                routeDecorators.push((0, common_1.Post)('many'));
+                break;
+            case 'CreateOne':
+                routeDecorators.push((0, common_1.Post)());
+                break;
+            case 'UpdateMany':
+                routeDecorators.push((0, common_1.Patch)());
+                break;
+            case 'UpdateOne':
+                routeDecorators.push((0, common_1.Patch)(`:${paramKey}`));
+                break;
+            case 'ReplaceOne':
+                routeDecorators.push((0, common_1.Put)(`:${paramKey}`));
+                break;
+            case 'DuplicateMany':
+                routeDecorators.push((0, common_1.Post)(`duplicate`));
+                break;
+            case 'DuplicateOne':
+                routeDecorators.push((0, common_1.Post)(`duplicate/:${paramKey}`));
+                break;
+            case 'DeleteMany':
+                routeDecorators.push((0, common_1.Delete)());
+                break;
+            case 'DeleteOne':
+                routeDecorators.push((0, common_1.Delete)(`:${paramKey}`));
+                break;
+            default:
+                throw new Error(`Unexpected route type! Cannot build route decorators. Received: ${this.routeType}`);
+        }
+        return routeDecorators;
+    }
+    getApiDecorators(paramKey) {
+        return [
+            (0, swagger_1.ApiOperation)({
+                operationId: `${(0, lodash_1.lowerFirst)(this.routeType)}${this.entity.name}${this.version ? 'V' + this.version : ''}`,
+                summary: this.description ??
+                    `${(0, lodash_1.upperFirst)((0, lodash_1.lowerCase)(this.routeType))} ${(0, lodash_1.lowerCase)(this.entity.name)}`,
+            }),
+            (0, swagger_1.ApiResponse)({
+                type: this.dTOs.presenter ?? this.entity,
+                isArray: this.responseRouteTypeIsArray.includes(this.routeType),
+            }),
+            ...(this.dTOs.body ? [
+                (0, swagger_1.ApiBody)({
+                    type: this.dTOs.body,
+                    required: !this.bodyRouteTypeIsOptional.includes(this.routeType),
+                }),
+            ] : []),
+            ...(this.dTOs.param && paramKey
+                ? [
+                    (0, swagger_1.ApiParam)({
+                        type: typeof new this.dTOs.param()[paramKey],
+                        name: paramKey,
+                    }),
+                ]
+                : []),
+        ];
+    }
+}
+exports.RouteDecoratorsBuilder = RouteDecoratorsBuilder;

package/src/decorators/check-policies.decorator.d.ts

@@ -0,0 +1,5 @@
+import { PolicyHandler } from '../interfaces';
+import { BaseEntity } from '../models';
+declare const CHECK_POLICIES_KEY = "check_policy";
+declare const CheckPolicies: <Entity extends BaseEntity>(...handlers: PolicyHandler<Entity>[]) => import("@nestjs/common").CustomDecorator<string>;
+export { CheckPolicies, CHECK_POLICIES_KEY };

package/src/decorators/check-policies.decorator.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHECK_POLICIES_KEY = exports.CheckPolicies = void 0;
+const common_1 = require("@nestjs/common");
+const CHECK_POLICIES_KEY = 'check_policy';
+exports.CHECK_POLICIES_KEY = CHECK_POLICIES_KEY;
+const CheckPolicies = (...handlers) => (0, common_1.SetMetadata)(CHECK_POLICIES_KEY, handlers);
+exports.CheckPolicies = CheckPolicies;

package/src/decorators/index.d.ts

@@ -1 +1,3 @@
+export * from './check-policies.decorator';
+export * from './public.decorator';
 export * from './schema-options.decorator';

package/src/decorators/index.js

@@ -14,4 +14,6 @@ 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("./check-policies.decorator"), exports);
+__exportStar(require("./public.decorator"), exports);
 __exportStar(require("./schema-options.decorator"), exports);

package/src/decorators/public.decorator.d.ts

@@ -0,0 +1,3 @@
+declare const IS_PUBLIC_KEY = "isPublic";
+declare const Public: () => import("@nestjs/common").CustomDecorator<string>;
+export { IS_PUBLIC_KEY, Public };

package/src/decorators/public.decorator.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Public = exports.IS_PUBLIC_KEY = void 0;
+const common_1 = require("@nestjs/common");
+const IS_PUBLIC_KEY = 'isPublic';
+exports.IS_PUBLIC_KEY = IS_PUBLIC_KEY;
+const Public = () => (0, common_1.SetMetadata)(IS_PUBLIC_KEY, true);
+exports.Public = Public;

package/src/dtos/delete-many-entity.query.d.ts

@@ -0,0 +1,3 @@
+export declare class DeleteManyEntityQuery {
+    ids: string[];
+}