mongodb-dynamic-api 4.24.1 → 5.0.0

package/codemods/migrate-v5/removed-symbols.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REMOVED_SYMBOLS = void 0;
+const REMOVED_SYMBOLS = [
+    {
+        name: 'AnyBeforeSaveCallback',
+        guidance: "no longer needed now that DynamicApiRouteConfig is a discriminated union — each per-route config type already carries a precisely-typed beforeSaveCallback, use it directly instead of this wide union.",
+    },
+    {
+        name: 'InMemoryPresenceAdapter',
+        guidance: "use DynamicApiPresenceModule.register({ adapter: 'memory' }) and inject the DYNAMIC_API_PRESENCE_ADAPTER token instead of importing the concrete class.",
+    },
+    {
+        name: 'RedisPresenceAdapter',
+        guidance: "use DynamicApiPresenceModule.register({ adapter: 'redis', redisUrl, redisTtlSeconds }) and inject the DYNAMIC_API_PRESENCE_ADAPTER token instead of importing the concrete class.",
+    },
+    {
+        name: 'BaseService',
+        guidance: 'internal base class for the auto-generated route services — no replacement, was never meant to be extended directly.',
+    },
+    {
+        name: 'RoutePoliciesGuardMixin',
+        guidance: 'internal wiring for ability-predicate guards — no replacement, configure abilityPredicate on the route instead.',
+    },
+    {
+        name: 'SocketPoliciesGuardMixin',
+        guidance: 'internal wiring for WebSocket ability-predicate guards — no replacement, configure abilityPredicate on the route instead.',
+    },
+    {
+        name: 'EntityBodyMixin',
+        guidance: 'internal DTO-building for the auto-generated routes — no replacement, was never meant to be called directly.',
+    },
+    {
+        name: 'EntityPresenterMixin',
+        guidance: 'internal DTO-building for the auto-generated routes — no replacement, was never meant to be called directly.',
+    },
+    {
+        name: 'AuthDecoratorsBuilder',
+        guidance: 'internal Swagger/route-decorator wiring for the auth module — no replacement.',
+    },
+    {
+        name: 'RouteDecoratorsBuilder',
+        guidance: 'internal Swagger/route-decorator wiring for the auto-generated routes — no replacement.',
+    },
+    {
+        name: 'BasePoliciesGuard',
+        guidance: 'internal base class for ability-predicate guards — no replacement, configure abilityPredicate on the route instead.',
+    },
+    {
+        name: 'BaseSocketPoliciesGuard',
+        guidance: 'internal base class for WebSocket ability-predicate guards — no replacement, configure abilityPredicate on the route instead.',
+    },
+    {
+        name: 'DynamicApiJwtAuthGuard',
+        guidance: "internal global guard installed by useAuth — no replacement, use @Public() to exempt a route instead of referencing this guard directly.",
+    },
+    {
+        name: 'JwtSocketGuard',
+        guidance: 'internal WebSocket JWT guard installed by enableDynamicAPIWebSockets — no replacement.',
+    },
+    { name: 'JwtAuthGuard', guidance: 'internal auth guard — no replacement, use @Public()/useAuth configuration instead.' },
+    { name: 'JwtRefreshGuard', guidance: 'internal auth guard for /auth/refresh-token — no replacement.' },
+    { name: 'JwtSocketAuthGuard', guidance: 'internal WebSocket auth guard — no replacement.' },
+    { name: 'JwtSocketRefreshGuard', guidance: 'internal WebSocket auth guard — no replacement.' },
+    { name: 'LocalAuthGuard', guidance: 'internal auth guard for /auth/login — no replacement.' },
+    { name: 'PasswordlessGuard', guidance: 'internal auth guard — no replacement.' },
+    { name: 'ResetPasswordGuard', guidance: 'internal auth guard — no replacement.' },
+    {
+        name: 'BaseGateway',
+        guidance: 'internal base class for the auto-generated WebSocket gateways — no replacement, use DynamicApiBroadcastService.broadcastFromHttp() from a custom route instead.',
+    },
+    {
+        name: 'createDynamicApiBroadcastGateway',
+        guidance: 'internal gateway factory — no replacement, wired automatically by enableDynamicAPIWebSockets.',
+    },
+    {
+        name: 'DynamicApiCacheInterceptor',
+        guidance: 'internal interceptor wired automatically for cached routes — no replacement, use DynamicApiCacheService to invalidate manually if needed.',
+    },
+    {
+        name: 'MergeIdParamInterceptor',
+        guidance: 'internal interceptor for UpdateOne\'s :id param — no replacement, was never meant to be applied directly.',
+    },
+    {
+        name: 'DynamicAPIWsExceptionFilter',
+        guidance: 'internal WebSocket exception filter wired automatically — no replacement.',
+    },
+    {
+        name: 'MongoDBDynamicApiLogger',
+        guidance: 'internal logger wrapper — no replacement, use the MONGODB_DYNAMIC_API_LOGGER environment variable to control its output instead of instantiating it yourself.',
+    },
+    { name: 'ManyEntityQuery', guidance: 'internal query DTO for *Many routes — no replacement, was never meant to be imported directly.' },
+    { name: 'DeletePresenter', guidance: 'internal response DTO for delete routes — no replacement, was never meant to be imported directly.' },
+    { name: 'EntityParam', guidance: 'internal :id path-param DTO — no replacement, was never meant to be imported directly.' },
+    { name: 'EntityQuery', guidance: 'internal empty query DTO — no replacement, was never meant to be imported directly.' },
+    { name: 'ApiEndpointVisibility', guidance: 'internal Swagger visibility decorator — no replacement.' },
+    { name: 'RateLimit', guidance: 'internal rate-limit decorator applied automatically to sensitive auth routes — no replacement, configure rateLimit in useAuth options instead.' },
+    { name: 'ValidatorPipe', guidance: 'internal validation pipe wired automatically — no replacement, configure enableDynamicAPIValidation instead.' },
+    { name: 'IS_PUBLIC_KEY', guidance: 'internal metadata key behind @Public() — no replacement, use the @Public() decorator itself.' },
+    { name: 'DynamicApiDecoratorBuilder', guidance: 'internal builder contract — no replacement.' },
+    { name: 'PoliciesGuard', guidance: 'internal guard contract — no replacement, configure abilityPredicate on the route instead.' },
+    { name: 'PoliciesGuardConstructor', guidance: 'internal guard contract — no replacement.' },
+    { name: 'AuthPoliciesGuardConstructor', guidance: 'internal guard contract — no replacement.' },
+    { name: 'RouteModule', guidance: 'internal route-module union type — no replacement.' },
+    { name: 'DYNAMIC_API_GLOBAL_STATE', guidance: 'internal DI token — no replacement, use DynamicApiEntityService.getModel() instead.' },
+    { name: 'Credentials', guidance: 'internal global-state shape — no replacement.' },
+    { name: 'EntitySchemas', guidance: 'internal global-state shape — no replacement.' },
+    { name: 'DynamicApiGlobalState', guidance: 'internal global-state shape — no replacement.' },
+    { name: 'AfterSaveCallbackConfig', guidance: 'internal callback wiring shape — no replacement, use the AfterSaveCallback type instead.' },
+    { name: 'GatewayResponse', guidance: 'internal WebSocket response wrapper type — no replacement.' },
+    { name: 'AuthModule', guidance: "internal module wired automatically by useAuth — no replacement, configure useAuth on DynamicApiModule.forRoot() instead." },
+    { name: 'DynamicApiConfigModule', guidance: 'internal config module — no replacement.' },
+    { name: 'BaseAuthService', guidance: 'internal base class for the auth module — no replacement.' },
+    { name: 'JwtStrategy', guidance: 'internal Passport strategy wired automatically by useAuth — no replacement.' },
+    { name: 'JwtRefreshStrategy', guidance: 'internal Passport strategy wired automatically by useAuth — no replacement.' },
+    { name: 'HealthController', guidance: 'internal controller wired automatically by DynamicApiHealthModule — no replacement.' },
+    { name: 'createHealthController', guidance: 'internal controller factory — no replacement, use DynamicApiHealthModule instead.' },
+    { name: 'PresenceController', guidance: "internal controller wired by DynamicApiPresenceModule.register({ enableController: true }) — no replacement, was never meant to be imported directly." },
+    { name: 'createPresenceGateway', guidance: 'internal gateway factory — no replacement, wired automatically by DynamicApiPresenceModule.' },
+];
+exports.REMOVED_SYMBOLS = REMOVED_SYMBOLS;
+//# sourceMappingURL=removed-symbols.js.map

package/codemods/migrate-v5/removed-symbols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"removed-symbols.js","sourceRoot":"","sources":["../../../libs/dynamic-api/codemods/migrate-v5/removed-symbols.ts"],"names":[],"mappings":";;;AAaA,MAAM,eAAe,GAAoB;IACvC;QACE,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,yMAAyM;KACpN;IAED;QACE,IAAI,EAAE,yBAAyB;QAC/B,QAAQ,EAAE,yJAAyJ;KACpK;IACD;QACE,IAAI,EAAE,sBAAsB;QAC5B,QAAQ,EAAE,mLAAmL;KAC9L;IAID;QACE,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,sHAAsH;KACjI;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,QAAQ,EAAE,iHAAiH;KAC5H;IACD;QACE,IAAI,EAAE,0BAA0B;QAChC,QAAQ,EAAE,2HAA2H;KACtI;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE,8GAA8G;KACzH;IACD;QACE,IAAI,EAAE,sBAAsB;QAC5B,QAAQ,EAAE,8GAA8G;KACzH;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,+EAA+E;KAC1F;IACD;QACE,IAAI,EAAE,wBAAwB;QAC9B,QAAQ,EAAE,yFAAyF;KACpG;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,QAAQ,EAAE,qHAAqH;KAChI;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,QAAQ,EAAE,+HAA+H;KAC1I;IACD;QACE,IAAI,EAAE,wBAAwB;QAC9B,QAAQ,EAAE,0IAA0I;KACrJ;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,QAAQ,EAAE,wFAAwF;KACnG;IACD,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,oFAAoF,EAAE;IACxH,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,+DAA+D,EAAE;IACtG,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,iDAAiD,EAAE;IAC3F,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,iDAAiD,EAAE;IAC9F,EAAE,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,uDAAuD,EAAE;IAC7F,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,EAAE,uCAAuC,EAAE;IAChF,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,uCAAuC,EAAE;IACjF;QACE,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,iKAAiK;KAC5K;IACD;QACE,IAAI,EAAE,kCAAkC;QACxC,QAAQ,EAAE,+FAA+F;KAC1G;IACD;QACE,IAAI,EAAE,4BAA4B;QAClC,QAAQ,EAAE,2IAA2I;KACtJ;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,QAAQ,EAAE,2GAA2G;KACtH;IACD;QACE,IAAI,EAAE,6BAA6B;QACnC,QAAQ,EAAE,2EAA2E;KACtF;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,QAAQ,EAAE,+JAA+J;KAC1K;IAED,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,gGAAgG,EAAE;IACvI,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,oGAAoG,EAAE;IAC3I,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,wFAAwF,EAAE;IAC3H,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,qFAAqF,EAAE;IACxH,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,yDAAyD,EAAE;IACtG,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,gJAAgJ,EAAE;IACjL,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,8GAA8G,EAAE;IACnJ,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,8FAA8F,EAAE;IAEnI,EAAE,IAAI,EAAE,4BAA4B,EAAE,QAAQ,EAAE,6CAA6C,EAAE;IAC/F,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,4FAA4F,EAAE;IACjI,EAAE,IAAI,EAAE,0BAA0B,EAAE,QAAQ,EAAE,2CAA2C,EAAE;IAC3F,EAAE,IAAI,EAAE,8BAA8B,EAAE,QAAQ,EAAE,2CAA2C,EAAE;IAC/F,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,oDAAoD,EAAE;IACvF,EAAE,IAAI,EAAE,0BAA0B,EAAE,QAAQ,EAAE,qFAAqF,EAAE;IACrI,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,+CAA+C,EAAE;IAClF,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,+CAA+C,EAAE;IACpF,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,+CAA+C,EAAE;IAC5F,EAAE,IAAI,EAAE,yBAAyB,EAAE,QAAQ,EAAE,0FAA0F,EAAE;IACzI,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,4DAA4D,EAAE;IAEnG,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,2HAA2H,EAAE;IAC7J,EAAE,IAAI,EAAE,wBAAwB,EAAE,QAAQ,EAAE,0CAA0C,EAAE;IACxF,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,2DAA2D,EAAE;IAClG,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,6EAA6E,EAAE;IAChH,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,6EAA6E,EAAE;IACvH,EAAE,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,qFAAqF,EAAE;IAC7H,EAAE,IAAI,EAAE,wBAAwB,EAAE,QAAQ,EAAE,mFAAmF,EAAE;IACjI,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,uJAAuJ,EAAE;IACjM,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,6FAA6F,EAAE;CAC3I,CAAC;AAEO,0CAAe"}

package/package.json

@@ -1,21 +1,24 @@
 {
   "name": "mongodb-dynamic-api",
-  "version": "4.24.1",
+  "version": "5.0.0",
   "description": "Auto generated CRUD API for MongoDB using NestJS",
   "readmeFilename": "README.md",
   "main": "index.js",
   "types": "index.d.ts",
   "schematics": "./schematics/collection.json",
+  "bin": {
+    "mongodb-dynamic-api": "./codemods/migrate-v5/cli.js"
+  },
   "scripts": {
     "build": "tsc && tsc -p tsconfig.schematics.json && node scripts/copy-schematics-assets.cjs",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json -c tslint.json",
-    "test": "jest --runInBand",
-    "test-cov": "jest --runInBand --coverage",
-    "test-e2e": "jest --runInBand --config ./libs/dynamic-api/test/jest-e2e.json",
-    "test-e2e:ci": "jest --ci --runInBand --config ./libs/dynamic-api/test/jest-e2e.json",
-    "test:ci:junit": "jest --ci --runInBand --coverage --testResultsProcessor=jest-junit",
-    "test:ci:sonar": "jest --ci --runInBand --coverage --testResultsProcessor=jest-sonar-reporter",
+    "test": "vitest run",
+    "test-cov": "vitest run --coverage",
+    "test-e2e": "vitest run --config vitest.e2e.config.ts",
+    "test-e2e:ci": "vitest run --config vitest.e2e.config.ts --reporter=default --reporter=junit --outputFile=reports/junit/results.xml",
+    "test:ci:junit": "vitest run --coverage --reporter=default --reporter=junit --outputFile=reports/junit/results.xml",
+    "test:ci:sonar": "vitest run --coverage --reporter=default --reporter=vitest-sonar-reporter --outputFile=reports/sonar/test-report.xml",
     "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",
@@ -41,16 +44,16 @@
   "homepage": "https://mikedev75015.github.io",
   "dependencies": {
     "@angular-devkit/schematics": "^19.2.27",
-    "@nestjs/cache-manager": "^3.0.1",
-    "@nestjs/common": "^11.1.13",
-    "@nestjs/core": "11.1.18",
-    "@nestjs/jwt": "^11.0.2",
-    "@nestjs/mongoose": "^11.0.4",
-    "@nestjs/passport": "^11.0.5",
-    "@nestjs/platform-express": "^11.1.13",
-    "@nestjs/platform-socket.io": "^11.1.13",
-    "@nestjs/swagger": "^11.2.6",
-    "@nestjs/websockets": "^11.1.13",
+    "@nestjs/cache-manager": "^12.0.0",
+    "@nestjs/common": "^12.0.1",
+    "@nestjs/core": "^12.0.1",
+    "@nestjs/jwt": "^12.0.1",
+    "@nestjs/mongoose": "^12.0.0",
+    "@nestjs/passport": "^12.0.0",
+    "@nestjs/platform-express": "^12.0.1",
+    "@nestjs/platform-socket.io": "^12.0.1",
+    "@nestjs/swagger": "^12.0.1",
+    "@nestjs/websockets": "^12.0.1",
     "@types/lodash": "^4.14.202",
     "bcrypt": "^5.1.1",
     "cache-manager": "^6.1.6",
@@ -59,6 +62,7 @@
     "cookie-parser": "^1.4.7",
     "dotenv": "^16.4.5",
     "ioredis": "^5.10.1",
+    "jsonwebtoken": "^9.0.3",
     "mongodb-pipeline-builder": "^4.0.2",
     "mongoose": "^8.9.5",
     "passport": "^0.7.0",
@@ -66,13 +70,13 @@
     "passport-local": "^1.0.0",
     "reflect-metadata": "^0.2.1",
     "rxjs": "^7.8.1",
-    "socket.io-client": "^4.7.5"
+    "socket.io-client": "^4.7.5",
+    "ts-morph": "^28.0.0"
   },
   "devDependencies": {
-    "@golevelup/ts-jest": "^0.4.0",
-    "@nestjs/cli": "^11.0.16",
-    "@nestjs/schematics": "^11.0.9",
-    "@nestjs/testing": "^11.1.16",
+    "@nestjs/cli": "^12.0.0",
+    "@nestjs/schematics": "^12.0.0",
+    "@nestjs/testing": "^12.0.1",
     "@nestjs/throttler": "^6.5.0",
     "@release-it/bumper": "^7.0.5",
     "@release-it/conventional-changelog": "^11.0.0",
@@ -81,59 +85,44 @@
     "@types/bcrypt": "^5.0.2",
     "@types/cookie-parser": "^1.4.10",
     "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.12",
+    "@types/jsonwebtoken": "^9.0.10",
     "@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": "^8.57.0",
     "@typescript-eslint/parser": "^8.57.0",
+    "@vitest/coverage-istanbul": "^4.1.11",
     "eslint": "^10.0.3",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.5",
-    "jest": "^29.7.0",
-    "jest-junit": "^16.0.0",
-    "jest-mock-extended": "^3.0.5",
-    "jest-sonar-reporter": "^2.0.0",
     "lcov-result-merger": "^5.0.1",
     "mongodb-memory-server": "^11.2.0",
     "prettier": "^3.2.5",
     "release-it": "^20.0.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"
+    "typescript": "^5.3.3",
+    "unplugin-swc": "^1.5.11",
+    "vitest": "^4.1.11",
+    "vitest-sonar-reporter": "^3.0.0"
   },
-  "jest": {
-    "clearMocks": true,
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "libs",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.ts$": "ts-jest"
+  "overrides": {
+    "@nestjs/throttler": {
+      "@nestjs/common": "$@nestjs/common",
+      "@nestjs/core": "$@nestjs/core"
     },
-    "collectCoverage": true,
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node",
-    "roots": [
-      "<rootDir>/"
-    ],
-    "coveragePathIgnorePatterns": [
-      ".*\\.mock\\.ts"
-    ],
-    "reporters": [
-      "default"
-    ]
-  },
-  "jestSonar": {
-    "reportPath": "reports/sonar"
+    "@nestjs/schematics": {
+      "typescript": "$typescript"
+    },
+    "@nestjs/cli": {
+      "@swc/cli": "$@swc/cli",
+      "@swc/core": "$@swc/core",
+      "ts-loader": "$ts-loader"
+    }
   },
   "publishConfig": {
     "access": "public"

package/schematics/resource/files/__name@dasherize__.entity.ts.template

@@ -1,7 +1,7 @@
-import { Prop, Schema } from '@nestjs/mongoose';
-import { <%= softDelete ? 'SoftDeletableEntity' : 'BaseEntity' %> } from 'mongodb-dynamic-api';
+import { Prop } from '@nestjs/mongoose';
+import { <%= softDelete ? 'SoftDeletableEntity' : 'BaseEntity' %>, DynamicApiSchema } from 'mongodb-dynamic-api';
 
-@Schema({ collection: '<%= dasherize(name) %>' })
+@DynamicApiSchema({ collection: '<%= dasherize(name) %>' })
 export class <%= classify(name) %> extends <%= softDelete ? 'SoftDeletableEntity' : 'BaseEntity' %> {
   // TODO: declare your entity's fields here, e.g.:
   // @Prop({ type: String, required: true })