@lenne.tech/nest-server 10.0.2 → 10.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "10.0.2",
+  "version": "10.0.4",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",
@@ -17,9 +17,9 @@
     "build": "rimraf dist && nest build",
     "build:pack": "npm pack && echo 'use file:/ROOT_PATH_TO_TGZ_FILE to integrate the package'",
     "build:dev": "npm run build && yalc push --private",
-    "docs": "npm run docs:ci && open ./public/index.html",
+    "docs": "npm run docs:ci && open http://127.0.0.1:8080/ && open ./public/index.html && compodoc -p tsconfig.json -s ",
     "docs:bootstrap": "node extras/update-spectaql-version.mjs && npx -y spectaql ./spectaql.yml",
-    "docs:ci": "ts-node ./scripts/init-server.ts && npm run docs:bootstrap",
+    "docs:ci": "ts-node ./scripts/init-server.ts && npm run docs:bootstrap && compodoc -p tsconfig.json",
     "format": "prettier --write 'src/**/*.ts'",
     "format:staged": "pretty-quick --staged",
     "lint": "eslint \"{src,tests}/**/*.ts\" --fix",
@@ -47,7 +47,7 @@
     "test:watch": "NODE_ENV=local jest --watch",
     "prepack": "npm run prestart:prod",
     "prepare": "husky install",
-    "prepublishOnly": "npm run format && npm run lint && npm run test:ci",
+    "prepublishOnly": "npm run lint && npm run test:ci",
     "preversion": "npm run lint",
     "watch": "npm-watch"
   },
@@ -62,16 +62,17 @@
     "node": ">= 16.13.0"
   },
   "dependencies": {
-    "@apollo/gateway": "2.4.9",
+    "@apollo/gateway": "2.5.1",
     "@nestjs/apollo": "12.0.7",
-    "@nestjs/common": "10.0.5",
-    "@nestjs/core": "10.0.5",
+    "@nestjs/common": "10.1.3",
+    "@nestjs/core": "10.1.3",
     "@nestjs/graphql": "12.0.8",
     "@nestjs/jwt": "10.1.0",
-    "@nestjs/mongoose": "10.0.0",
+    "@nestjs/mongoose": "10.0.1",
     "@nestjs/passport": "10.0.0",
-    "@nestjs/platform-express": "10.0.5",
+    "@nestjs/platform-express": "10.1.3",
     "@nestjs/schedule": "3.0.1",
+    "@nestjs/terminus": "10.0.1",
     "apollo-server-core": "3.11.1",
     "apollo-server-express": "3.11.1",
     "bcrypt": "5.1.0",
@@ -89,44 +90,49 @@
     "light-my-request": "5.10.0",
     "lodash": "4.17.21",
     "mongodb": "4.16.0",
-    "mongoose": "6.11.3",
+    "mongoose": "6.11.5",
     "mongoose-gridfs": "1.3.0",
     "multer": "1.4.5-lts.1",
     "multer-gridfs-storage": "5.0.2",
-    "node-mailjet": "6.0.3",
-    "nodemailer": "6.9.3",
+    "node-mailjet": "6.0.4",
+    "nodemailer": "6.9.4",
     "nodemon": "3.0.1",
     "passport": "0.6.0",
     "passport-jwt": "4.0.1",
     "reflect-metadata": "0.1.13",
     "rfdc": "1.3.0",
     "rimraf": "5.0.1",
-    "rxjs": "7.8.1"
+    "rxjs": "7.8.1",
+    "yuml-diagram": "1.2.0"
   },
   "devDependencies": {
-    "@nestjs/cli": "10.1.8",
+    "@babel/plugin-proposal-private-methods": "7.18.6",
+    "@compodoc/compodoc": "1.1.21",
+    "@lenne.tech/eslint-config-ts": "0.0.8",
+    "@nestjs/cli": "10.1.11",
     "@nestjs/schematics": "10.0.1",
-    "@nestjs/testing": "10.0.5",
+    "@nestjs/testing": "10.1.3",
     "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.69",
-    "@swc/jest": "0.2.26",
+    "@swc/core": "1.3.73",
+    "@swc/jest": "0.2.27",
     "@types/compression": "1.7.2",
     "@types/cookie-parser": "1.4.3",
     "@types/cron": "2.0.1",
     "@types/ejs": "3.1.2",
     "@types/express": "4.17.17",
     "@types/jest": "29.5.3",
-    "@types/lodash": "4.14.195",
+    "@types/lodash": "4.14.196",
     "@types/multer": "1.4.7",
-    "@types/node": "20.4.2",
-    "@types/nodemailer": "6.4.8",
+    "@types/node": "20.4.5",
+    "@types/nodemailer": "6.4.9",
     "@types/passport": "1.0.12",
     "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "6.0.0",
-    "@typescript-eslint/parser": "6.0.0",
+    "@typescript-eslint/eslint-plugin": "6.2.1",
+    "@typescript-eslint/parser": "6.2.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.45.0",
-    "eslint-config-prettier": "8.8.0",
+    "eslint": "8.46.0",
+    "eslint-config-prettier": "8.9.0",
+    "eslint-plugin-unused-imports": "3.0.0",
     "find-file-up": "2.0.1",
     "grunt": "1.6.1",
     "grunt-bg-shell": "2.3.3",
@@ -134,10 +140,10 @@
     "grunt-contrib-watch": "1.1.0",
     "grunt-sync": "0.8.2",
     "husky": "8.0.3",
-    "jest": "29.6.1",
+    "jest": "29.6.2",
     "npm-watch": "0.11.0",
     "pm2": "5.3.0",
-    "prettier": "2.8.8",
+    "prettier": "3.0.0",
     "pretty-quick": "3.1.3",
     "supertest": "6.3.3",
     "ts-jest": "29.1.1",

package/src/config.env.ts

@@ -1,5 +1,5 @@
-import { CronExpression } from '@nestjs/schedule';
 import { join } from 'path';
+import { CronExpression } from '@nestjs/schedule';
 import { merge } from './core/common/helpers/config.helper';
 import { IServerOptions } from './core/common/interfaces/server-options.interface';
 
@@ -55,6 +55,14 @@ const config: { [env: string]: IServerOptions } = {
       },
       maxComplexity: 20,
     },
+    healthCheck: {
+      enabled: true,
+      configs: {
+        database: {
+          enabled: true,
+        },
+      },
+    },
     ignoreSelectionsForPopulate: true,
     jwt: {
       secret: 'SECRET_OR_PRIVATE_KEY_LOCAL',
@@ -69,12 +77,13 @@ const config: { [env: string]: IServerOptions } = {
         },
       },
     },
-    loadLocalConfig: false,
+    loadLocalConfig: true,
     logExceptions: true,
     mongoose: {
       collation: {
         locale: 'de',
       },
+      modelDocumentation: true,
       uri: 'mongodb://127.0.0.1/nest-server-local',
     },
     port: 3000,
@@ -128,6 +137,14 @@ const config: { [env: string]: IServerOptions } = {
       },
       maxComplexity: 20,
     },
+    healthCheck: {
+      enabled: true,
+      configs: {
+        database: {
+          enabled: true,
+        },
+      },
+    },
     ignoreSelectionsForPopulate: true,
     jwt: {
       secret: 'SECRET_OR_PRIVATE_KEY_DEV',
@@ -148,6 +165,7 @@ const config: { [env: string]: IServerOptions } = {
       collation: {
         locale: 'de',
       },
+      modelDocumentation: false,
       uri: 'mongodb://127.0.0.1/nest-server-dev',
     },
     port: 3000,
@@ -201,6 +219,14 @@ const config: { [env: string]: IServerOptions } = {
       },
       maxComplexity: 20,
     },
+    healthCheck: {
+      enabled: true,
+      configs: {
+        database: {
+          enabled: true,
+        },
+      },
+    },
     ignoreSelectionsForPopulate: true,
     jwt: {
       secret: 'SECRET_OR_PRIVATE_KEY_PROD',
@@ -221,6 +247,7 @@ const config: { [env: string]: IServerOptions } = {
       collation: {
         locale: 'de',
       },
+      modelDocumentation: false,
       uri: 'mongodb://127.0.0.1/nest-server-prod',
     },
     port: 3000,
@@ -239,32 +266,35 @@ const config: { [env: string]: IServerOptions } = {
 /**
  * Environment specific config
  *
- * default: development
+ * default: local
  */
-const env = process.env['NODE' + '_ENV'] || 'development';
-const envConfig = config[env] || config.development;
-console.info('Configured for: ' + envConfig.env + (env !== envConfig.env ? ' (requested: ' + env + ')' : ''));
-
+const env = process.env['NODE' + '_ENV'] || 'local';
+const envConfig = config[env] || config.local;
+console.info(`Configured for: ${envConfig.env}${env !== envConfig.env ? ` (requested: ${env})` : ''}`);
 // Merge with localConfig (e.g. config.json)
 if (envConfig.loadLocalConfig) {
   let localConfig;
   if (typeof envConfig.loadLocalConfig === 'string') {
-    localConfig = require(envConfig.loadLocalConfig);
-    merge(envConfig, localConfig);
+    import(envConfig.loadLocalConfig).then((loadedConfig) => {
+      localConfig = loadedConfig.default || loadedConfig;
+      merge(envConfig, localConfig);
+    }).catch(() => {
+      console.info(`Configuration ${envConfig.loadLocalConfig} not found!`);
+    });
   } else {
-    try {
-      // get config from src directory
-      localConfig = require(__dirname + '/config.json');
+    // get config from src directory
+    import(join(__dirname, 'config.json')).then((loadedConfig) => {
+      localConfig = loadedConfig.default || loadedConfig;
       merge(envConfig, localConfig);
-    } catch {
-      try {
-        // if not found try to find in project directory
-        localConfig = require(__dirname + '/../config.json');
+    }).catch(() => {
+      // if not found try to find in project directory
+      import(join(__dirname, '..', 'config.json')).then((loadedConfig) => {
+        localConfig = loadedConfig.default || loadedConfig;
         merge(envConfig, localConfig);
-      } catch (e) {
-        // No config.json found => nothing to do
-      }
-    }
+      }).catch(() => {
+        console.info('No local config.json found!');
+      });
+    });
   }
 }
 

package/src/core/common/args/filter.args.ts

@@ -8,7 +8,7 @@ export class FilterArgs extends PaginationArgs {
   /**
    * Filtering
    */
-  @Field((type) => FilterInput, {
+  @Field(type => FilterInput, {
     description: 'Input for filtering',
     nullable: true,
   })
@@ -18,7 +18,7 @@ export class FilterArgs extends PaginationArgs {
   /**
    * Get a specific number of random samples from filter results
    */
-  @Field((type) => Number, {
+  @Field(type => Number, {
     description:
       'Request only a specified number of samples from the filter results; if not specified, all results are returned.',
     nullable: true,
@@ -38,11 +38,11 @@ export class FilterArgs extends PaginationArgs {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     super.map(data, options);
     this.filter = data.filter ? FilterInput.map(data.filter, options) : undefined;
-    Object.keys(this).forEach((key) => this[key] === undefined && delete this[key]);
+    Object.keys(this).forEach(key => this[key] === undefined && delete this[key]);
     return this;
   }
 }

package/src/core/common/args/pagination.args.ts

@@ -9,7 +9,7 @@ export class PaginationArgs extends CoreInput {
   /**
    * Limit for pagination
    */
-  @Field((type) => Int, {
+  @Field(type => Int, {
     description: 'Limit specifies the maximum number of elements found that are to be returned',
     nullable: true,
   })
@@ -19,7 +19,7 @@ export class PaginationArgs extends CoreInput {
   /**
    * Alias for skip
    */
-  @Field((type) => Int, {
+  @Field(type => Int, {
     description: 'Alias for skip',
     nullable: true,
   })
@@ -29,7 +29,7 @@ export class PaginationArgs extends CoreInput {
   /**
    * Skip for pagination
    */
-  @Field((type) => Int, {
+  @Field(type => Int, {
     description: 'Skip specifies how many found elements should be skipped on return',
     nullable: true,
   })
@@ -39,7 +39,7 @@ export class PaginationArgs extends CoreInput {
   /**
    * Sorting for pagination
    */
-  @Field((type) => [SortInput], {
+  @Field(type => [SortInput], {
     description: 'Sorting the returned elements',
     nullable: true,
   })
@@ -49,7 +49,7 @@ export class PaginationArgs extends CoreInput {
   /**
    * Alias for limit
    */
-  @Field((type) => Int, {
+  @Field(type => Int, {
     description: 'Alias for limit',
     nullable: true,
   })
@@ -69,11 +69,11 @@ export class PaginationArgs extends CoreInput {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     super.map(data, options);
     this.sort = maps(data.sort, SortInput, options.cloneDeep);
-    Object.keys(this).forEach((key) => this[key] === undefined && delete this[key]);
+    Object.keys(this).forEach(key => this[key] === undefined && delete this[key]);
     return this;
   }
 }

package/src/core/common/decorators/graphql-service-options.decorator.ts

@@ -1,4 +1,4 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { ExecutionContext, createParamDecorator } from '@nestjs/common';
 import { currentUserDec, graphqlPopulateDec } from '../helpers/decorator.helper';
 import { ServiceOptions } from '../interfaces/service-options.interface';
 
@@ -25,5 +25,5 @@ export const GraphQLServiceOptions = createParamDecorator(
       currentUser: currentUserDec(null, ctx),
       populate: graphqlPopulateDec(data, ctx),
     };
-  }
+  },
 );

package/src/core/common/decorators/graphql-user.decorator.ts

@@ -1,4 +1,4 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { ExecutionContext, createParamDecorator } from '@nestjs/common';
 import { GqlExecutionContext } from '@nestjs/graphql';
 
 /**

package/src/core/common/decorators/rest-user.decorator.ts

@@ -1,4 +1,4 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { ExecutionContext, createParamDecorator } from '@nestjs/common';
 
 /**
  * User decorator for REST request

package/src/core/common/decorators/restricted.decorator.ts

@@ -1,10 +1,10 @@
 import 'reflect-metadata';
 import { UnauthorizedException } from '@nestjs/common';
+import _ = require('lodash');
 import { ProcessType } from '../enums/process-type.enum';
 import { RoleEnum } from '../enums/role.enum';
 import { getIncludedIds } from '../helpers/db.helper';
 import { RequireAtLeastOne } from '../types/required-at-least-one.type';
-import _ = require('lodash');
 
 /**
  * Restricted meta key
@@ -68,7 +68,7 @@ export const checkRestricted = (
     removeUndefinedFromResultArray?: boolean;
     throwError?: boolean;
   } = {},
-  processedObjects: any[] = []
+  processedObjects: any[] = [],
 ) => {
   const config = {
     checkObjectItself: false,
@@ -92,9 +92,9 @@ export const checkRestricted = (
   // Array
   if (Array.isArray(data)) {
     // Check array items
-    let result = data.map((item) => checkRestricted(item, user, config, processedObjects));
+    let result = data.map(item => checkRestricted(item, user, config, processedObjects));
     if (!config.throwError && config.removeUndefinedFromResultArray) {
-      result = result.filter((item) => item !== undefined);
+      result = result.filter(item => item !== undefined);
     }
     return result;
   }
@@ -114,8 +114,8 @@ export const checkRestricted = (
       if (typeof item === 'string') {
         roles.push(item);
       } else if (
-        item?.roles?.length &&
-        (config.processType && item.processType ? config.processType === item.processType : true)
+        item?.roles?.length
+        && (config.processType && item.processType ? config.processType === item.processType : true)
       ) {
         if (Array.isArray(item.roles)) {
           roles.push(...item.roles);
@@ -134,11 +134,11 @@ export const checkRestricted = (
 
       // Check access rights
       if (
-        roles.includes(RoleEnum.S_EVERYONE) ||
-        user?.hasRole?.(roles) ||
-        (user?.id && roles.includes(RoleEnum.S_USER)) ||
-        (roles.includes(RoleEnum.S_SELF) && getIncludedIds(config.dbObject, user)) ||
-        (roles.includes(RoleEnum.S_CREATOR) && getIncludedIds(config.dbObject?.createdBy, user))
+        roles.includes(RoleEnum.S_EVERYONE)
+        || user?.hasRole?.(roles)
+        || (user?.id && roles.includes(RoleEnum.S_USER))
+        || (roles.includes(RoleEnum.S_SELF) && getIncludedIds(config.dbObject, user))
+        || (roles.includes(RoleEnum.S_CREATOR) && getIncludedIds(config.dbObject?.createdBy, user))
       ) {
         valid = true;
       }
@@ -148,11 +148,11 @@ export const checkRestricted = (
       // Get groups
       const groups = restricted.filter((item) => {
         return (
-          typeof item === 'object' &&
+          typeof item === 'object'
           // Check if object is valid
-          item.memberOf?.length &&
+          && item.memberOf?.length
           // Check if processType is specified and is valid for current process
-          (config.processType && item.processType ? config.processType === item.processType : true)
+          && (config.processType && item.processType ? config.processType === item.processType : true)
         );
       }) as { memberOf: string | string[] }[];
 
@@ -199,7 +199,7 @@ export const checkRestricted = (
     if (!objectIsValid) {
       // Throw error
       if (config.throwError) {
-        throw new UnauthorizedException('The current user has no access rights for ' + data.constructor?.name);
+        throw new UnauthorizedException(`The current user has no access rights for ${data.constructor?.name}`);
       }
       return null;
     }
@@ -225,9 +225,9 @@ export const checkRestricted = (
       // Throw error
       if (config.throwError) {
         throw new UnauthorizedException(
-          'The current user has no access rights for ' +
-            propertyKey +
-            (data.constructor?.name ? ' of ' + data.constructor.name : '')
+          `The current user has no access rights for ${
+            propertyKey
+            }${data.constructor?.name ? ` of ${data.constructor.name}` : ''}`,
         );
       }
 

package/src/core/common/filters/http-exception-log.filter.ts

@@ -1,4 +1,4 @@
-import { ArgumentsHost, Catch, ExceptionFilter, HttpException } from '@nestjs/common';
+import { ArgumentsHost, Catch, ExceptionFilter, HttpException, ServiceUnavailableException } from '@nestjs/common';
 import { GqlContextType } from '@nestjs/graphql';
 import { Response } from 'express';
 
@@ -21,8 +21,8 @@ export class HttpExceptionLogFilter implements ExceptionFilter {
     const ctx = host.switchToHttp();
     const res = ctx.getResponse<Response>();
     const status = exception.getStatus();
-    res.status(status).json({
-      ...exception,
-    });
+    res.status(status).json(
+      exception instanceof ServiceUnavailableException ? ({ ...exception } as any).response : { ...exception },
+    );
   }
 }