@lenne.tech/nest-server 8.6.27 → 9.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "8.6.27",
+  "version": "9.0.0",
   "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",
@@ -18,7 +18,7 @@
     "build:pack": "npm pack && echo 'use file:/ROOT_PATH_TO_TGZ_FILE to integrate the package'",
     "docs": "npm run docs:ci && open ./public/index.html",
     "docs:bootstrap": "node extras/update-spectaql-version.mjs && npx -y spectaql ./spectaql.yml",
-    "docs:ci": "ts-node ./scripts/init-server.ts && npm run docs:boostrap",
+    "docs:ci": "ts-node ./scripts/init-server.ts && npm run docs:bootstrap",
     "format": "prettier --write 'src/**/*.ts'",
     "format:staged": "pretty-quick --staged",
     "lint": "eslint \"{src,tests}/**/*.ts\" --fix",
@@ -59,17 +59,17 @@
   },
   "dependencies": {
     "@apollo/gateway": "2.0.5",
-    "@nestjs/apollo": "10.0.16",
-    "@nestjs/common": "8.4.7",
-    "@nestjs/core": "8.4.7",
-    "@nestjs/graphql": "10.0.16",
-    "@nestjs/jwt": "8.0.1",
-    "@nestjs/mongoose": "9.1.1",
-    "@nestjs/passport": "8.2.2",
-    "@nestjs/platform-express": "8.4.7",
-    "@nestjs/schedule": "2.0.1",
-    "apollo-server-core": "3.9.0",
-    "apollo-server-express": "3.9.0",
+    "@nestjs/apollo": "10.0.17",
+    "@nestjs/common": "9.0.3",
+    "@nestjs/core": "9.0.3",
+    "@nestjs/graphql": "10.0.18",
+    "@nestjs/jwt": "9.0.0",
+    "@nestjs/mongoose": "9.2.0",
+    "@nestjs/passport": "9.0.0",
+    "@nestjs/platform-express": "9.0.3",
+    "@nestjs/schedule": "2.1.0",
+    "apollo-server-core": "3.10.0",
+    "apollo-server-express": "3.10.0",
     "bcrypt": "5.0.1",
     "class-transformer": "0.5.1",
     "class-validator": "0.13.2",
@@ -79,36 +79,37 @@
     "graphql-upload": "15.0.2",
     "js-sha256": "0.9.0",
     "json-to-graphql-query": "2.2.4",
-    "light-my-request": "5.0.0",
+    "light-my-request": "5.1.0",
     "lodash": "4.17.21",
-    "mongodb": "4.7.0",
-    "mongoose": "6.4.2",
+    "mongodb": "4.8.0",
+    "mongoose": "6.4.4",
     "mongoose-gridfs": "1.3.0",
     "multer": "1.4.5-lts.1",
     "node-mailjet": "5.0.1",
-    "nodemailer": "6.7.6",
-    "nodemon": "2.0.18",
+    "nodemailer": "6.7.7",
+    "nodemon": "2.0.19",
     "passport": "0.6.0",
     "passport-jwt": "4.0.0",
     "reflect-metadata": "0.1.13",
+    "rfdc": "1.3.0",
     "rimraf": "3.0.2",
-    "rxjs": "7.5.5"
+    "rxjs": "7.5.6"
   },
   "devDependencies": {
-    "@nestjs/testing": "8.4.7",
+    "@nestjs/testing": "9.0.3",
     "@types/cron": "2.0.0",
     "@types/ejs": "3.1.1",
-    "@types/jest": "28.1.4",
+    "@types/jest": "28.1.6",
     "@types/lodash": "4.14.182",
     "@types/multer": "1.4.7",
-    "@types/node": "18.0.1",
+    "@types/node": "18.0.5",
     "@types/nodemailer": "6.4.4",
     "@types/passport": "1.0.9",
     "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "5.30.4",
-    "@typescript-eslint/parser": "5.30.4",
+    "@typescript-eslint/eslint-plugin": "5.30.6",
+    "@typescript-eslint/parser": "5.30.6",
     "coffeescript": "2.7.0",
-    "eslint": "8.19.0",
+    "eslint": "8.20.0",
     "eslint-config-prettier": "8.5.0",
     "find-file-up": "2.0.1",
     "grunt": "1.5.3",
@@ -117,14 +118,14 @@
     "grunt-contrib-watch": "1.1.0",
     "grunt-sync": "0.8.2",
     "husky": "8.0.1",
-    "jest": "28.1.2",
+    "jest": "28.1.3",
     "pm2": "5.2.0",
     "prettier": "2.7.1",
     "pretty-quick": "3.1.3",
     "supertest": "6.2.4",
-    "ts-jest": "28.0.5",
+    "ts-jest": "28.0.7",
     "ts-morph": "15.1.0",
-    "ts-node": "10.8.2",
+    "ts-node": "10.9.1",
     "tsconfig-paths": "4.0.0",
     "typescript": "4.7.4"
   },

package/src/config.env.ts

@@ -1,5 +1,6 @@
 import { CronExpression } from '@nestjs/schedule';
 import { join } from 'path';
+import { merge } from './core/common/helpers/config.helper';
 import { IServerOptions } from './core/common/interfaces/server-options.interface';
 
 /**
@@ -22,8 +23,8 @@ const config: { [env: string]: IServerOptions } = {
     email: {
       smtp: {
         auth: {
-          user: 'rebeca68@ethereal.email',
-          pass: 'v5WUScAN98AzGbRjpc',
+          user: 'sandra98@ethereal.email',
+          pass: 'JCQQdz8xJEfBSewahK',
         },
         host: 'smtp.ethereal.email',
         port: 587,
@@ -34,8 +35,8 @@ const config: { [env: string]: IServerOptions } = {
         api_key_private: 'MAILJET_API_KEY_PRIVATE',
       },
       defaultSender: {
-        email: 'rebeca68@ethereal.email',
-        name: 'Rebeca Sixtyeight',
+        email: 'sandra98@ethereal.email',
+        name: 'Sandra Klein',
       },
       verificationLink: 'http://localhost:4200/user/verification',
       passwordResetLink: 'http://localhost:4200/user/password-reset',
@@ -51,6 +52,7 @@ const config: { [env: string]: IServerOptions } = {
     jwt: {
       secret: 'SECRET_OR_PRIVATE_KEY_DEV',
     },
+    loadLocalConfig: false,
     mongoose: {
       uri: 'mongodb://localhost/nest-server-dev',
     },
@@ -73,8 +75,8 @@ const config: { [env: string]: IServerOptions } = {
     email: {
       smtp: {
         auth: {
-          user: 'rebeca68@ethereal.email',
-          pass: 'v5WUScAN98AzGbRjpc',
+          user: 'sandra98@ethereal.email',
+          pass: 'JCQQdz8xJEfBSewahK',
         },
         host: 'smtp.ethereal.email',
         port: 587,
@@ -85,8 +87,8 @@ const config: { [env: string]: IServerOptions } = {
         api_key_private: 'MAILJET_API_KEY_PRIVATE',
       },
       defaultSender: {
-        email: 'rebeca68@ethereal.email',
-        name: 'Rebeca Sixtyeight',
+        email: 'sandra98@ethereal.email',
+        name: 'Sandra Klein',
       },
       verificationLink: 'http://localhost:4200/user/verification',
       passwordResetLink: 'http://localhost:4200/user/password-reset',
@@ -102,6 +104,7 @@ const config: { [env: string]: IServerOptions } = {
     jwt: {
       secret: 'SECRET_OR_PRIVATE_KEY_DEV',
     },
+    loadLocalConfig: false,
     mongoose: {
       uri: 'mongodb://localhost/nest-server-dev',
     },
@@ -124,8 +127,8 @@ const config: { [env: string]: IServerOptions } = {
     email: {
       smtp: {
         auth: {
-          user: 'rebeca68@ethereal.email',
-          pass: 'v5WUScAN98AzGbRjpc',
+          user: 'sandra98@ethereal.email',
+          pass: 'JCQQdz8xJEfBSewahK',
         },
         host: 'smtp.ethereal.email',
         port: 587,
@@ -136,8 +139,8 @@ const config: { [env: string]: IServerOptions } = {
         api_key_private: 'MAILJET_API_KEY_PRIVATE',
       },
       defaultSender: {
-        email: 'rebeca68@ethereal.email',
-        name: 'Rebeca Sixtyeight',
+        email: 'sandra98@ethereal.email',
+        name: 'Sandra Klein',
       },
       verificationLink: 'http://localhost:4200/user/verification',
       passwordResetLink: 'http://localhost:4200/user/password-reset',
@@ -153,6 +156,7 @@ const config: { [env: string]: IServerOptions } = {
     jwt: {
       secret: 'SECRET_OR_PRIVATE_KEY_PROD',
     },
+    loadLocalConfig: false,
     mongoose: {
       uri: 'mongodb://localhost/nest-server-prod',
     },
@@ -178,6 +182,29 @@ const env = process.env['NODE' + '_ENV'] || 'development';
 const envConfig = config[env] || config.development;
 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);
+  } else {
+    try {
+      // get config from src directory
+      localConfig = require(__dirname + '/config.json');
+      merge(envConfig, localConfig);
+    } catch {
+      try {
+        // if not found try to find in project directory
+        localConfig = require(__dirname + '/../config.json');
+        merge(envConfig, localConfig);
+      } catch (e) {
+        // No config.json found => nothing to do
+      }
+    }
+  }
+}
+
 /**
  * Export envConfig as default
  */

package/src/core/common/helpers/input.helper.ts

@@ -3,6 +3,7 @@ import { plainToInstance } from 'class-transformer';
 import { validate } from 'class-validator';
 import { ValidatorOptions } from 'class-validator/types/validation/ValidatorOptions';
 import * as _ from 'lodash';
+import * as rfdc from 'rfdc';
 import { checkRestricted } from '../decorators/restricted.decorator';
 import { ProcessType } from '../enums/process-type.enum';
 import { RoleEnum } from '../enums/role.enum';
@@ -196,7 +197,7 @@ export function assignPlain(target: Record<any, any>, ...args: Record<any, any>[
           ? // Return item if not an object
             item
           : // Return cloned record with undefined properties removed
-            filterProperties(JSON.parse(JSON.stringify(item)), (prop) => prop !== undefined)
+            filterProperties(clone(item, { circles: false }), (prop) => prop !== undefined)
     )
   );
 }
@@ -297,6 +298,44 @@ export async function check(
   return value;
 }
 
+/**
+ * Clone object
+ * @param object Any object
+ * @param options Finetuning of rfdc cloning
+ * @param options.proto Copy prototype properties as well as own properties into the new object.
+ *                      It's marginally faster to allow enumerable properties on the prototype to be copied into the
+ *                      cloned object (not onto it's prototype, directly onto the object).
+ * @param options.circles Keeping track of circular references will slow down performance with an additional 25% overhead.
+ *                        Even if an object doesn't have any circular references, the tracking overhead is the cost.
+ *                        By default if an object with a circular reference is passed to rfdc, it will throw
+ *                        (similar to how JSON.stringify would throw). Use the circles option to detect and preserve
+ *                        circular references in the object. If performance is important, try removing the circular
+ *                        reference from the object (set to undefined) and then add it back manually after cloning
+ *                        instead of using this option.
+ */
+export function clone(object: any, options?: { proto?: boolean; circles?: boolean }) {
+  const config = {
+    proto: false,
+    circles: true,
+    ...options,
+  };
+  try {
+    return rfdc(config)(object);
+  } catch (e) {
+    console.debug(e);
+    if (!config.circles) {
+      try {
+        return rfdc({ ...config, ...{ circles: true } })(object);
+      } catch (e) {
+        console.debug(e);
+        return _.clone(object);
+      }
+    } else {
+      return _.clone(object);
+    }
+  }
+}
+
 /**
  * Combines objects to a new single plain object and ignores undefined
  */
@@ -304,6 +343,19 @@ export function combinePlain(...args: Record<any, any>[]): any {
   return assignPlain({}, ...args);
 }
 
+/**
+ * Get deep frozen object
+ */
+export function deepFreeze(object: any) {
+  if (typeof object !== 'object') {
+    return object;
+  }
+  for (const [key, value] of Object.entries(object)) {
+    object[key] = deepFreeze(value);
+  }
+  return Object.freeze(object);
+}
+
 /**
  * Standard error function
  */
@@ -327,7 +379,6 @@ export function filterProperties<T = Record<string, any>>(
 
 /**
  * Get plain copy of object
- * @param element
  */
 export function getPlain(object: any) {
   return JSON.parse(JSON.stringify(object));
@@ -512,11 +563,24 @@ export function match(expression: any, cases: Record<any, any>): any {
 /**
  * Map values into specific type
  */
-export function mapClass<T>(values: Partial<T>, ctor: new () => T, cloneDeep = true): T {
+export function mapClass<T>(
+  values: Partial<T>,
+  ctor: new () => T,
+  options?: {
+    cloneDeep?: boolean;
+    circle?: boolean;
+    proto?: boolean;
+  }
+): T {
+  const config = {
+    cloneDeep: true,
+    circles: false,
+    proto: false,
+  };
   const instance = new ctor();
 
   return Object.keys(instance).reduce((obj, key) => {
-    obj[key] = cloneDeep ? _.cloneDeep(values[key]) : values[key];
+    obj[key] = config.cloneDeep ? clone(values[key], { circles: config.circles, proto: config.proto }) : values[key];
     return obj;
   }, instance);
 }

package/src/core/common/helpers/model.helper.ts

@@ -1,6 +1,6 @@
 import { plainToInstance } from 'class-transformer';
-import * as _ from 'lodash';
 import { Types } from 'mongoose';
+import { clone } from './input.helper';
 
 /**
  * Helper class for models
@@ -63,15 +63,19 @@ export function prepareMap<T = Record<string, any>>(
   target: T,
   options: {
     cloneDeep?: boolean;
+    circles?: boolean;
     funcAllowed?: boolean;
     mapId?: boolean;
+    proto?: boolean;
   } = {}
 ): Partial<T> | Record<string, any> {
   // Set config
   const config = {
     cloneDeep: true,
+    circles: true,
     funcAllowed: false,
     mapId: false,
+    proto: false,
     ...options,
   };
 
@@ -85,7 +89,10 @@ export function prepareMap<T = Record<string, any>>(
       source[key] !== undefined &&
       (config.funcAllowed || typeof (source[key] !== 'function'))
     ) {
-      result[key] = source[key] !== 'function' && config.cloneDeep ? _.cloneDeep(source[key]) : source[key];
+      result[key] =
+        source[key] !== 'function' && config.cloneDeep
+          ? clone(source[key], { circles: config.circles, proto: config.proto })
+          : source[key];
     } else if (key === 'id' && !config.mapId) {
       result['id'] = source[key];
     }
@@ -102,21 +109,25 @@ export function map<T = Record<string, any>>(
   target: T,
   options: {
     cloneDeep?: boolean;
+    circles?: boolean;
     funcAllowed?: boolean;
     mapId?: boolean;
+    proto?: boolean;
   } = {}
 ): T {
   // Set config
   const config = {
     cloneDeep: true,
+    circles: false,
     funcAllowed: false,
     mapId: false,
+    proto: false,
     ...options,
   };
 
   // Check source
   if (!source || typeof source !== 'object' || Array.isArray(source)) {
-    return config.cloneDeep ? _.cloneDeep(target) : target;
+    return config.cloneDeep ? clone(target, { circles: config.circles, proto: config.proto }) : target;
   }
 
   // Prepare source
@@ -191,18 +202,18 @@ export function mapClasses<T = Record<string, any>>(
       if (Array.isArray(value)) {
         const arr = [];
         for (const item of value) {
-          if (value instanceof targetClass) {
-            arr.push(value);
-          } else if (value instanceof Types.ObjectId) {
-            config.objectIdsToString ? arr.push(value.toHexString()) : arr.push(value);
-          } else if (typeof value === 'object') {
+          if (item instanceof targetClass) {
+            arr.push(item);
+          } else if (item instanceof Types.ObjectId) {
+            config.objectIdsToString ? arr.push(item.toHexString()) : arr.push(item);
+          } else if (typeof item === 'object') {
             if (targetClass.map) {
               arr.push(targetClass.map(item));
             } else {
               arr.push(plainToInstance(targetClass, item));
             }
           } else {
-            arr.push(value);
+            arr.push(item);
           }
         }
         target[prop] = arr as any;
@@ -274,18 +285,18 @@ export async function mapClassesAsync<T = Record<string, any>>(
       if (Array.isArray(value)) {
         const arr = [];
         for (const item of value) {
-          if (value instanceof targetClass) {
-            arr.push(value);
-          } else if (value instanceof Types.ObjectId) {
-            config.objectIdsToString ? arr.push(value.toHexString()) : arr.push(value);
-          } else if (typeof value === 'object') {
+          if (item instanceof targetClass) {
+            arr.push(item);
+          } else if (item instanceof Types.ObjectId) {
+            config.objectIdsToString ? arr.push(item.toHexString()) : arr.push(item);
+          } else if (typeof item === 'object') {
             if (targetClass.map) {
               arr.push(await targetClass.map(item));
             } else {
               arr.push(plainToInstance(targetClass, item));
             }
           } else {
-            arr.push(value);
+            arr.push(item);
           }
         }
         target[prop] = arr as any;

package/src/core/common/helpers/service.helper.ts

@@ -4,12 +4,13 @@ import { plainToInstance } from 'class-transformer';
 import { sha256 } from 'js-sha256';
 import * as _ from 'lodash';
 import { Types } from 'mongoose';
-import envConfig from '../../../config.env';
 import { RoleEnum } from '../enums/role.enum';
 import { PrepareInputOptions } from '../interfaces/prepare-input-options.interface';
 import { PrepareOutputOptions } from '../interfaces/prepare-output-options.interface';
 import { ResolveSelector } from '../interfaces/resolve-selector.interface';
 import { ServiceOptions } from '../interfaces/service-options.interface';
+import { ConfigService } from '../services/config.service';
+import { clone } from './input.helper';
 
 /**
  * Helper class for services
@@ -24,10 +25,13 @@ export default class ServiceHelper {
     currentUser: { [key: string]: any; id: string },
     options: {
       [key: string]: any;
+      checkRoles?: boolean;
       create?: boolean;
       clone?: boolean;
       getNewArray?: boolean;
       removeUndefined?: boolean;
+      sha256?: boolean;
+      targetModel?: new (...args: any[]) => T;
     } = {}
   ): Promise<T> {
     return prepareInput(input, currentUser, options);
@@ -42,6 +46,8 @@ export default class ServiceHelper {
       [key: string]: any;
       clone?: boolean;
       getNewArray?: boolean;
+      objectIdsToStrings?: boolean;
+      removeSecrets?: boolean;
       removeUndefined?: boolean;
       targetModel?: new (...args: any[]) => T;
     } = {}
@@ -59,10 +65,13 @@ export async function prepareInput<T = any>(
   options: {
     [key: string]: any;
     checkRoles?: boolean;
+    circles?: boolean;
     create?: boolean;
     clone?: boolean;
     getNewArray?: boolean;
+    proto?: boolean;
     removeUndefined?: boolean;
+    sha256?: boolean;
     targetModel?: new (...args: any[]) => T;
   } = {}
 ): Promise<T> {
@@ -70,9 +79,12 @@ export async function prepareInput<T = any>(
   const config = {
     checkRoles: false,
     clone: false,
+    circles: false,
     create: false,
     getNewArray: false,
+    proto: false,
     removeUndefined: true,
+    sha256: ConfigService.configFastButReadOnly.sha256,
     ...options,
   };
 
@@ -98,7 +110,7 @@ export async function prepareInput<T = any>(
     if ((input as Record<string, any>).mapDeep && typeof (input as any).mapDeep === 'function') {
       input = await Object.getPrototypeOf(input).mapDeep(input);
     } else {
-      input = _.cloneDeep(input);
+      input = clone(input, { circles: config.circles, proto: config.proto });
     }
   }
 
@@ -134,7 +146,7 @@ export async function prepareInput<T = any>(
   if ((input as any).password) {
     // Check if the password was transmitted encrypted
     // If not, the password is encrypted to enable future encrypted and unencrypted transmissions
-    if (envConfig.sha256 && !/^[a-f0-9]{64}$/i.test((input as any).password)) {
+    if (config.sha256 && !/^[a-f0-9]{64}$/i.test((input as any).password)) {
       (input as any).password = sha256((input as any).password);
     }
 
@@ -164,8 +176,10 @@ export async function prepareOutput<T = { [key: string]: any; map: (...args: any
   options: {
     [key: string]: any;
     clone?: boolean;
+    circles?: boolean;
     getNewArray?: boolean;
     objectIdsToStrings?: boolean;
+    proto?: boolean;
     removeSecrets?: boolean;
     removeUndefined?: boolean;
     targetModel?: new (...args: any[]) => T;
@@ -174,8 +188,10 @@ export async function prepareOutput<T = { [key: string]: any; map: (...args: any
   // Configuration
   const config = {
     clone: false,
+    circles: false,
     getNewArray: false,
     objectIdsToStrings: true,
+    proto: false,
     removeSecrets: true,
     removeUndefined: false,
     targetModel: undefined,
@@ -204,7 +220,7 @@ export async function prepareOutput<T = { [key: string]: any; map: (...args: any
     if (output.mapDeep && typeof output.mapDeep === 'function') {
       output = await Object.getPrototypeOf(output).mapDeep(output);
     } else {
-      output = _.cloneDeep(output);
+      output = clone(output, { circles: config.circles, proto: config.proto });
     }
   }
 
@@ -259,9 +275,11 @@ export function prepareServiceOptions(
   serviceOptions: ServiceOptions,
   options?: {
     clone?: boolean;
+    circles?: boolean;
     inputType?: any;
     outputType?: any;
     subFieldSelection?: string;
+    proto?: boolean;
     prepareInput?: PrepareInputOptions;
     prepareOutput?: PrepareOutputOptions;
   }
@@ -269,12 +287,14 @@ export function prepareServiceOptions(
   // Set default values
   const config = {
     clone: true,
+    circles: true,
+    proto: false,
     ...options,
   };
 
   // Clone
   if (serviceOptions && config.clone) {
-    serviceOptions = _.cloneDeep(serviceOptions);
+    serviceOptions = clone(serviceOptions, { circles: config.circles, proto: config.proto });
   }
 
   // Init if not exists

package/src/core/common/interfaces/server-options.interface.ts

@@ -128,6 +128,14 @@ export interface IServerOptions {
     secretOrPrivateKey?: string;
   } & JwtModuleOptions;
 
+  /**
+   * Load local configuration
+   * false: no local configuration is loaded,
+   * true: it tries to load ./config.json or ../config.json,
+   * string: path to configuration
+   */
+  loadLocalConfig?: boolean | string;
+
   /**
    * Configuration for Mongoose
    */