mongodb-dynamic-api 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+Changelog
+
+## 1.1.0 (2024-03-03)
+
+
+* activate schema timestamps ([ee2e8e4](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/ee2e8e4442bd692b2fe1566687b98f421bc9f9f6))
+* rename mixin dtos ([7a0fc65](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/7a0fc6540a4d93000c735744786469204a734ce4))
+* rework validation options ([3cb0b56](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/3cb0b56a81e7016f1dc03c0f46ec1714ad57eff2))
+
+
+### 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 (2024-02-27)
+
+
+### Features
+
+* add mongodb dynamic api files ([33dfc14](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/33dfc143d34e31c802a5d1adb5e8d99ad5aadc6f))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mickaël Nodanche
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,190 @@
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+[![NPM version](https://img.shields.io/npm/v/mongodb-dynamic-api.svg)](https://www.npmjs.com/package/mongodb-dynamic-api)
+![NPM](https://img.shields.io/npm/l/mongodb-dynamic-api?registry_uri=https%3A%2F%2Fregistry.npmjs.com)
+![npm](https://img.shields.io/npm/dw/mongodb-dynamic-api)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+![GitHub branch checks state](https://img.shields.io/github/checks-status/MikeDev75015/mongodb-dynamic-api/main)
+[![CircleCI](https://circleci.com/gh/MikeDev75015/mongodb-dynamic-api.svg?style=shield)](https://app.circleci.com/pipelines/github/MikeDev75015/mongodb-dynamic-api)
+![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/MikeDev75015_mongodb-dynamic-api?server=https%3A%2F%2Fsonarcloud.io)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+![Sonar Tests](https://img.shields.io/sonar/tests/MikeDev75015_mongodb-dynamic-api?server=https%3A%2F%2Fsonarcloud.io)
+![Sonar Coverage](https://img.shields.io/sonar/coverage/MikeDev75015_mongodb-dynamic-api?server=https%3A%2F%2Fsonarcloud.io)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-dynamic-api&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-dynamic-api)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-dynamic-api&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-dynamic-api)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-dynamic-api&metric=security_rating)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-dynamic-api)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-dynamic-api&metric=ncloc)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-dynamic-api)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-dynamic-api&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-dynamic-api)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+![GitHub top language](https://img.shields.io/github/languages/top/MikeDev75015/mongodb-dynamic-api)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/MikeDev75015/mongodb-dynamic-api)
+![GitHub commit activity](https://img.shields.io/github/commit-activity/w/MikeDev75015/mongodb-dynamic-api)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/MikeDev75015/mongodb-dynamic-api/main)
+</div>
+</div>
+
+---
+
+<div style="text-align: center; width: 100%;">
+
+# mongodb-dynamic-api
+
+</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.
+
+</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)
+```text
+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
+```text
+npm i -S mongodb-dynamic-api
+```
+
+- Add DynamicApiModule to your app.module.ts and pass the MongoDB connection string to the `forRoot` method
+```typescript
+@Module({
+  imports: [
+    // ...
+    DynamicApiModule.forRoot(
+      // <- pass the MongoDB connection string here
+    ),
+    // ...
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
+```
+
+- 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
+@Schema({ collection: 'users' })
+export class User extends BaseEntity { // <- you must extend BaseEntity
+  @Prop({ type: String })
+  name: string;
+
+  @Prop({ type: String })
+  email: string;
+}
+```
+```typescript
+// users.module.ts
+@Module({
+  imports: [
+    DynamicApiModule.forFeature({ // <- use the forFeature method to add the User content
+      entity: User,
+      controllerOptions: {
+        path: 'users',
+      },
+    }),
+  ],
+})
+export class UsersModule {}
+```
+```typescript
+// app.module.ts
+@Module({
+  imports: [
+    // ...
+    DynamicApiModule.forRoot('...'),
+    UsersModule, // <- add the module to the imports after the DynamicApiModule
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
+```
+
+**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.
+
+Do not forget to add the `@ApiProperty` decorator to your entity properties to have a better swagger documentation.
+```typescript
+// user.ts
+@Schema({ collection: 'users' })
+export class User 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
+
+
+![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
+
+  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/index.d.ts

@@ -0,0 +1 @@
+export * from './src';

package/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./src"), exports);

package/package.json

@@ -0,0 +1,119 @@
+{
+  "name": "mongodb-dynamic-api",
+  "version": "1.1.0",
+  "description": "Auto generated CRUD API for MongoDB using NestJS",
+  "readmeFilename": "README.md",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "test": "jest --runInBand",
+    "test-cov": "jest --runInBand --coverage",
+    "test:ci:junit": "jest --ci --runInBand --coverage --testResultsProcessor=jest-junit",
+    "test:ci:sonar": "jest --ci --runInBand --coverage --testResultsProcessor=jest-sonar-reporter",
+    "pre-release-tag": "git tag -f prerelease && git push -f origin prerelease",
+    "release-tag": "git tag -f release && git push -f origin release",
+    "auto-prerelease": "release-it --ci --preRelease=beta --no-git.requireUpstream --no-git.tag",
+    "auto-release": "release-it --ci --no-git.requireUpstream --no-git.tag",
+    "publish-prerelease": "npm publish ./dist --tag prerelease",
+    "publish-release": "npm publish ./dist --tag latest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MikeDev75015/mongodb-dynamic-api.git"
+  },
+  "keywords": [
+    "nestjs",
+    "mongodb",
+    "dynamic-api",
+    "crud"
+  ],
+  "author": "Mickaël NODANCHE <mikeonline75@gmail.com> (https://cv-mikeonline.web.app)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MikeDev75015/mongodb-dynamic-api/issues"
+  },
+  "homepage": "https://mikedev75015.github.io",
+  "dependencies": {
+    "@nestjs/common": "^10.3.2",
+    "@nestjs/core": "^10.3.2",
+    "@nestjs/mongoose": "^10.0.4",
+    "@nestjs/platform-express": "^10.3.2",
+    "@nestjs/swagger": "^7.3.0",
+    "@types/lodash": "^4.14.202",
+    "builder-pattern": "^2.2.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "lodash": "^4.17.21",
+    "mongoose": "^8.1.1",
+    "reflect-metadata": "^0.2.1",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@golevelup/ts-jest": "^0.4.0",
+    "@nestjs/cli": "^10.3.1",
+    "@nestjs/schematics": "^10.1.0",
+    "@nestjs/testing": "^10.3.2",
+    "@release-it/bumper": "^6.0.1",
+    "@release-it/conventional-changelog": "^8.0.1",
+    "@swc/cli": "^0.3.9",
+    "@swc/core": "^1.4.0",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.16",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "jest-sonar-reporter": "^2.0.0",
+    "prettier": "^3.2.5",
+    "release-it": "^17.1.1",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.4",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.3.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "libs",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "./**/*.ts"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/"
+    ],
+    "coveragePathIgnorePatterns": [
+      "index.ts",
+      ".*\\.mock\\.ts"
+    ],
+    "reporters": [
+      "default"
+    ]
+  },
+  "jestSonar": {
+    "reportPath": "reports/sonar"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/builders/index.d.ts

@@ -0,0 +1 @@
+export * from './route-decorators.builder';

package/src/builders/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);

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

@@ -0,0 +1,18 @@
+import { Type } from '@nestjs/common';
+import { RouteType } from '../interfaces';
+import { BaseEntity } from '../models';
+declare class RouteDecoratorsBuilder<Entity extends BaseEntity> {
+    private readonly routeType;
+    private readonly entity;
+    private readonly description?;
+    private readonly param?;
+    private readonly query?;
+    private readonly body?;
+    private readonly presenter?;
+    private readonly responseRouteTypeIsArray;
+    constructor(routeType: RouteType, entity: Type<Entity>, description?: string, param?: Type, query?: Type, body?: Type, presenter?: Type);
+    build(): MethodDecorator[];
+    private getRouteDecorators;
+    private getApiDecorators;
+}
+export { RouteDecoratorsBuilder };

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

@@ -0,0 +1,76 @@
+"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");
+class RouteDecoratorsBuilder {
+    constructor(routeType, entity, description, param, query, body, presenter) {
+        this.routeType = routeType;
+        this.entity = entity;
+        this.description = description;
+        this.param = param;
+        this.query = query;
+        this.body = body;
+        this.presenter = presenter;
+        this.responseRouteTypeIsArray = [
+            'GetMany',
+            'CreateMany',
+        ];
+    }
+    build() {
+        const [paramKey] = this.param ? (0, lodash_1.keys)(new this.param()) : [];
+        return [
+            ...this.getRouteDecorators(paramKey),
+            ...this.getApiDecorators(paramKey),
+        ];
+    }
+    getRouteDecorators(paramKey) {
+        switch (this.routeType) {
+            case 'GetMany':
+                return [(0, common_1.Get)()];
+            case 'GetOne':
+                return [(0, common_1.Get)(`:${paramKey}`)];
+            case 'CreateMany':
+                return [(0, common_1.Post)('many')];
+            case 'CreateOne':
+                return [(0, common_1.Post)()];
+            case 'UpdateOne':
+                return [(0, common_1.Patch)(`:${paramKey}`)];
+            case 'ReplaceOne':
+                return [(0, common_1.Put)(`:${paramKey}`)];
+            case 'DuplicateOne':
+                return [(0, common_1.Post)(`:${paramKey}`)];
+            case 'DeleteOne':
+                return [(0, common_1.Delete)(`:${paramKey}`)];
+            default:
+                throw new Error(`Unexpected route type! Cannot build route decorators. Received: ${this.routeType}`);
+        }
+    }
+    getApiDecorators(paramKey) {
+        return [
+            (0, swagger_1.ApiOperation)({
+                operationId: `${(0, lodash_1.lowerFirst)(this.routeType)}${this.entity.name}`,
+                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.presenter ?? this.entity,
+                isArray: this.responseRouteTypeIsArray.includes(this.routeType),
+            }),
+            ...(this.body ? [(0, swagger_1.ApiBody)({
+                    type: this.body,
+                    ...(this.routeType === 'DuplicateOne' ? { required: false } : {})
+                })] : []),
+            ...(this.param && paramKey
+                ? [
+                    (0, swagger_1.ApiParam)({
+                        type: typeof new this.param()[paramKey],
+                        name: paramKey,
+                    }),
+                ]
+                : []),
+        ];
+    }
+}
+exports.RouteDecoratorsBuilder = RouteDecoratorsBuilder;

package/src/decorators/index.d.ts

@@ -0,0 +1 @@
+export * from './schema-options.decorator';

package/src/decorators/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./schema-options.decorator"), exports);

package/src/decorators/schema-options.decorator.d.ts

@@ -0,0 +1,4 @@
+import { DynamicAPISchemaOptionsInterface } from '../interfaces';
+declare const DYNAMIC_API_SCHEMA_OPTIONS_METADATA = "dynamic-api-module:schema-options";
+declare function DynamicAPISchemaOptions(options: DynamicAPISchemaOptionsInterface): ClassDecorator;
+export { DYNAMIC_API_SCHEMA_OPTIONS_METADATA, DynamicAPISchemaOptions };

package/src/decorators/schema-options.decorator.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicAPISchemaOptions = exports.DYNAMIC_API_SCHEMA_OPTIONS_METADATA = void 0;
+const DYNAMIC_API_SCHEMA_OPTIONS_METADATA = 'dynamic-api-module:schema-options';
+exports.DYNAMIC_API_SCHEMA_OPTIONS_METADATA = DYNAMIC_API_SCHEMA_OPTIONS_METADATA;
+function DynamicAPISchemaOptions(options) {
+    return (target) => {
+        Reflect.defineMetadata(DYNAMIC_API_SCHEMA_OPTIONS_METADATA, options, target);
+    };
+}
+exports.DynamicAPISchemaOptions = DynamicAPISchemaOptions;

package/src/dtos/entity.param.d.ts

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../models';
+export declare class EntityParam implements Pick<BaseEntity, 'id'> {
+    id: string;
+}

package/src/dtos/entity.param.js

@@ -0,0 +1,26 @@
+"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.EntityParam = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+class EntityParam {
+    constructor() {
+        this.id = '';
+    }
+}
+exports.EntityParam = EntityParam;
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", Object)
+], EntityParam.prototype, "id", void 0);

package/src/dtos/entity.query.d.ts

@@ -0,0 +1,2 @@
+export declare class EntityQuery {
+}

package/src/dtos/entity.query.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityQuery = void 0;
+class EntityQuery {
+}
+exports.EntityQuery = EntityQuery;

package/src/dtos/index.d.ts

@@ -0,0 +1,2 @@
+export * from './entity.param';
+export * from './entity.query';

package/src/dtos/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./entity.param"), exports);
+__exportStar(require("./entity.query"), exports);

package/src/dynamic-api.module.d.ts

@@ -0,0 +1,8 @@
+import { DynamicModule } from '@nestjs/common';
+import { DynamicApiOptions } from './interfaces';
+import { BaseEntity } from './models';
+export declare class DynamicApiModule {
+    static readonly connectionName = "dynamic-api-connection";
+    static forRoot(uri: string): DynamicModule;
+    static forFeature<Entity extends BaseEntity>({ entity, controllerOptions: { path, apiTag, version: controllerVersion, validationPipeOptions: controllerValidationPipeOptions, }, routes, }: DynamicApiOptions<Entity>): DynamicModule;
+}