@lenne.tech/nest-server 10.0.2 → 10.0.4

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

@@ -17,7 +17,7 @@ export class ModelHelper {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): Partial<T> | Record<string, any> {
     return prepareMap(source, target, options);
   }
@@ -32,7 +32,7 @@ export class ModelHelper {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): T {
     return map(source, target, options);
   }
@@ -43,7 +43,7 @@ export class ModelHelper {
   public static maps<T = Record<string, any>>(
     data: Partial<T> | Partial<T>[] | Record<string, any> | Record<string, any>[],
     targetClass: new (...args: any[]) => T,
-    cloneDeep = true
+    cloneDeep = true,
   ): T[] {
     return maps(data, targetClass, cloneDeep);
   }
@@ -61,7 +61,7 @@ export function prepareMap<T = Record<string, any>>(
     funcAllowed?: boolean;
     mapId?: boolean;
     proto?: boolean;
-  } = {}
+  } = {},
 ): Partial<T> | Record<string, any> {
   // Set config
   const config = {
@@ -79,12 +79,12 @@ export function prepareMap<T = Record<string, any>>(
   // Update properties
   for (const key of Object.keys(target)) {
     if (
-      (!['id', '_id'].includes(key) || config.mapId) &&
-      source[key] !== undefined &&
-      (config.funcAllowed || typeof (source[key] !== 'function'))
+      (!['id', '_id'].includes(key) || config.mapId)
+      && source[key] !== undefined
+      && (config.funcAllowed || typeof (source[key] !== 'function'))
     ) {
-      result[key] =
-        source[key] !== 'function' && config.cloneDeep
+      result[key]
+        = source[key] !== 'function' && config.cloneDeep
           ? clone(source[key], { circles: config.circles, proto: config.proto })
           : source[key];
     } else if (key === 'id' && !config.mapId) {
@@ -107,7 +107,7 @@ export function map<T = Record<string, any>>(
     funcAllowed?: boolean;
     mapId?: boolean;
     proto?: boolean;
-  } = {}
+  } = {},
 ): T {
   // Set config
   const config = {
@@ -140,7 +140,7 @@ export function map<T = Record<string, any>>(
 export function maps<T = Record<string, any>>(
   data: Partial<T> | Partial<T>[] | Record<string, any> | Record<string, any>[],
   targetClass: new (...args: any[]) => T,
-  cloneDeep = true
+  cloneDeep = true,
 ): T[] {
   // Check data
   if (!data || typeof data !== 'object') {
@@ -171,7 +171,7 @@ export function mapClasses<T = Record<string, any>>(
   input: Record<string, any>,
   mapping: Record<string, new (...args: any[]) => any>,
   target?: T,
-  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean }
+  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean },
 ): T {
   // Check params
   if (!target) {
@@ -198,10 +198,9 @@ export function mapClasses<T = Record<string, any>>(
       if (value === null) {
         target[prop] = null;
         continue;
-      }
 
-      // Process array
-      else if (Array.isArray(value)) {
+        // Process array
+      } else if (Array.isArray(value)) {
         const arr = [];
         for (const item of value) {
           if (item instanceof targetClass) {
@@ -219,15 +218,13 @@ export function mapClasses<T = Record<string, any>>(
           }
         }
         target[prop] = arr as any;
-      }
 
-      // Process ObjectId
-      else if (value instanceof Types.ObjectId) {
+        // Process ObjectId
+      } else if (value instanceof Types.ObjectId) {
         target[prop] = config.objectIdsToString ? value.toHexString() : value;
-      }
 
-      // Process object
-      else if (typeof value === 'object') {
+        // Process object
+      } else if (typeof value === 'object') {
         if (value instanceof targetClass) {
           target[prop] = value as any;
         } else {
@@ -237,10 +234,9 @@ export function mapClasses<T = Record<string, any>>(
             target[prop] = plainToInstance(targetClass, value) as any;
           }
         }
-      }
 
-      // Others
-      else if (!config.removeUndefinedProperties || value !== undefined) {
+        // Others
+      } else if (!config.removeUndefinedProperties || value !== undefined) {
         target[prop] = value;
       }
     }
@@ -262,7 +258,7 @@ export async function mapClassesAsync<T = Record<string, any>>(
   input: Record<string, any>,
   mapping: Record<string, new (...args: any[]) => any>,
   target?: T,
-  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean }
+  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean },
 ): Promise<T> {
   // Check params
   if (!target) {
@@ -289,10 +285,9 @@ export async function mapClassesAsync<T = Record<string, any>>(
       if (value === null) {
         target[prop] = null;
         continue;
-      }
 
-      // Process array
-      else if (Array.isArray(value)) {
+        // Process array
+      } else if (Array.isArray(value)) {
         const arr = [];
         for (const item of value) {
           if (item instanceof targetClass) {
@@ -310,15 +305,13 @@ export async function mapClassesAsync<T = Record<string, any>>(
           }
         }
         target[prop] = arr as any;
-      }
 
-      // Process ObjectId
-      else if (value instanceof Types.ObjectId) {
+        // Process ObjectId
+      } else if (value instanceof Types.ObjectId) {
         target[prop] = config.objectIdsToString ? value.toHexString() : value;
-      }
 
-      // Process object
-      else if (typeof value === 'object') {
+        // Process object
+      } else if (typeof value === 'object') {
         if (value instanceof targetClass) {
           target[prop] = value as any;
         } else {
@@ -328,10 +321,9 @@ export async function mapClassesAsync<T = Record<string, any>>(
             target[prop] = plainToInstance(targetClass, value) as any;
           }
         }
-      }
 
-      // Others
-      else if (!config.removeUndefinedProperties || value !== undefined) {
+        // Others
+      } else if (!config.removeUndefinedProperties || value !== undefined) {
         target[prop] = value;
       }
     }
@@ -347,14 +339,14 @@ export function mapInputClasses<T = Record<string, any>>(
   input: Record<string, any>,
   mapping: Record<string, new (...args: any[]) => any>,
   target?: T,
-  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean }
+  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean },
 ) {
   // Get config
   const config = {
     removeUndefinedProperties: true,
     ...options,
   };
-  return mapClasses(input, mapping, target, options);
+  return mapClasses(input, mapping, target, config);
 }
 
 /**
@@ -364,12 +356,12 @@ export function mapInputClassesAsync<T = Record<string, any>>(
   input: Record<string, any>,
   mapping: Record<string, new (...args: any[]) => any>,
   target?: T,
-  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean }
+  options?: { objectIdsToString?: boolean; removeUndefinedProperties?: boolean },
 ) {
   // Get config
   const config = {
     removeUndefinedProperties: true,
     ...options,
   };
-  return mapClassesAsync(input, mapping, target, options);
+  return mapClassesAsync(input, mapping, target, config);
 }

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

@@ -33,7 +33,7 @@ export default class ServiceHelper {
       removeUndefined?: boolean;
       sha256?: boolean;
       targetModel?: new (...args: any[]) => T;
-    } = {}
+    } = {},
   ): Promise<T> {
     return prepareInput(input, currentUser, options);
   }
@@ -51,7 +51,7 @@ export default class ServiceHelper {
       removeSecrets?: boolean;
       removeUndefined?: boolean;
       targetModel?: new (...args: any[]) => T;
-    } = {}
+    } = {},
   ): Promise<T | T[] | any> {
     return prepareOutput(output, options);
   }
@@ -75,7 +75,7 @@ export async function prepareInput<T = any>(
     removeUndefined?: boolean;
     sha256?: boolean;
     targetModel?: new (...args: any[]) => T;
-  } = {}
+  } = {},
 ): Promise<T> {
   // Configuration
   const config = {
@@ -127,7 +127,7 @@ export async function prepareInput<T = any>(
         }
         return property;
       },
-      { specialClasses: ['ObjectId'] }
+      { specialClasses: ['ObjectId'] },
     );
   }
 
@@ -153,7 +153,7 @@ export async function prepareInput<T = any>(
       const allowedRoles = _.intersection((input as Record<string, any>).roles, (currentUser as any).roles);
       if (allowedRoles.length !== (input as Record<string, any>).roles.length) {
         const missingRoles = _.difference((input as Record<string, any>).roles, (currentUser as any).roles);
-        throw new UnauthorizedException('Current user not allowed setting roles: ' + missingRoles);
+        throw new UnauthorizedException(`Current user not allowed setting roles: ${missingRoles}`);
       }
       (input as Record<string, any>).roles = allowedRoles;
     }
@@ -190,7 +190,7 @@ export async function prepareOutput<T = { [key: string]: any; map: (...args: any
     removeSecrets?: boolean;
     removeUndefined?: boolean;
     targetModel?: new (...args: any[]) => T;
-  } = {}
+  } = {},
 ): Promise<T | T[] | any> {
   // Configuration
   const config = {
@@ -289,7 +289,7 @@ export function prepareServiceOptions(
     proto?: boolean;
     prepareInput?: PrepareInputOptions;
     prepareOutput?: PrepareOutputOptions;
-  }
+  },
 ): ServiceOptions {
   // Set default values
   const config = {
@@ -322,7 +322,7 @@ export function prepareServiceOptions(
   // Set subfield selection
   if (config.subFieldSelection) {
     if ((serviceOptions.fieldSelection as ResolveSelector)?.select) {
-      (serviceOptions.fieldSelection as ResolveSelector).select += '.' + config.subFieldSelection;
+      (serviceOptions.fieldSelection as ResolveSelector).select += `.${config.subFieldSelection}`;
     }
   }
 

package/src/core/common/inputs/combined-filter.input.ts

@@ -11,7 +11,7 @@ export class CombinedFilterInput extends CoreInput {
   /**
    * Logical Operator to combine filters
    */
-  @Field((type) => LogicalOperatorEnum, {
+  @Field(type => LogicalOperatorEnum, {
     description: 'Logical Operator to combine filters',
   })
   logicalOperator: LogicalOperatorEnum = undefined;
@@ -19,7 +19,7 @@ export class CombinedFilterInput extends CoreInput {
   /**
    * Filters to combine via logical operator
    */
-  @Field((type) => [FilterInput], {
+  @Field(type => [FilterInput], {
     description: 'Filters to combine via logical operator',
   })
   filters: FilterInput[] = undefined;
@@ -37,11 +37,11 @@ export class CombinedFilterInput extends CoreInput {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     super.map(data, options);
     this.filters = maps(data.filters, FilterInput, 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/inputs/core-input.input.ts

@@ -21,7 +21,7 @@ export abstract class CoreInput extends CoreModel {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     const config = {
       cloneDeep: false,
@@ -30,7 +30,7 @@ export abstract class CoreInput extends CoreModel {
       ...options,
     };
     const coreInput = map(data, this, config);
-    Object.keys(coreInput).forEach((key) => coreInput[key] === undefined && delete coreInput[key]);
+    Object.keys(coreInput).forEach(key => coreInput[key] === undefined && delete coreInput[key]);
     return coreInput;
   }
 }

package/src/core/common/inputs/filter.input.ts

@@ -13,7 +13,7 @@ export class FilterInput extends CoreInput {
   /**
    * Combination of multiple filters via logical operator
    */
-  @Field((type) => CombinedFilterInput, {
+  @Field(type => CombinedFilterInput, {
     description: 'Combination of multiple filters via logical operator',
     nullable: true,
   })
@@ -22,7 +22,7 @@ export class FilterInput extends CoreInput {
   /**
    * Filter for a single property
    */
-  @Field((type) => SingleFilterInput, {
+  @Field(type => SingleFilterInput, {
     description: 'Filter for a single property',
     nullable: true,
   })
@@ -41,12 +41,12 @@ export class FilterInput extends CoreInput {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     super.map(data, options);
     this.combinedFilter = data.combinedFilter ? CombinedFilterInput.map(data.combinedFilter, options) : undefined;
     this.singleFilter = data.singleFilter ? SingleFilterInput.map(data.singleFilter, 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/inputs/single-filter.input.ts

@@ -44,7 +44,7 @@ export class SingleFilterInput extends CoreInput {
   /**
    * [Comparison operator](https://docs.mongodb.com/manual/reference/operator/query-comparison/)
    */
-  @Field((type) => ComparisonOperatorEnum, {
+  @Field(type => ComparisonOperatorEnum, {
     description: '[Comparison operator](https://docs.mongodb.com/manual/reference/operator/query-comparison/)',
   })
   operator: ComparisonOperatorEnum = undefined;
@@ -55,12 +55,12 @@ export class SingleFilterInput extends CoreInput {
    */
   @Field({
     description:
-      '[Options](https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_options) for ' +
-      '[REGEX](https://docs.mongodb.com/manual/reference/operator/query/regex/) operator',
+      '[Options](https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_options) for '
+      + '[REGEX](https://docs.mongodb.com/manual/reference/operator/query/regex/) operator',
     nullable: true,
   })
   options?: string = undefined;
 
-  @Field((type) => JSON, { description: 'Value of the property' })
+  @Field(type => JSON, { description: 'Value of the property' })
   value: any = undefined;
 }

package/src/core/common/inputs/sort.input.ts

@@ -16,6 +16,6 @@ export class SortInput extends CoreInput {
   /**
    * SortInput order of the field
    */
-  @Field((type) => SortOrderEnum, { description: 'SortInput order of the field' })
+  @Field(type => SortOrderEnum, { description: 'SortInput order of the field' })
   order: SortOrderEnum = undefined;
 }

package/src/core/common/interceptors/check-response.interceptor.ts

@@ -21,7 +21,7 @@ export class CheckResponseInterceptor implements NestInterceptor {
       map((data) => {
         // Prepare response data for current user
         return checkRestricted(data, currentUser, { throwError: false });
-      })
+      }),
     );
   }
 }

package/src/core/common/interceptors/check-security.interceptor.ts

@@ -1,4 +1,4 @@
-import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
 import { getContextData } from '../helpers/context.helper';
@@ -33,7 +33,7 @@ export class CheckSecurityInterceptor implements NestInterceptor {
 
         // Check if data is writeable (e.g. objects from direct access to json files via http are not writable)
         if (data && typeof data === 'object') {
-          const writeable = !Object.keys(data).find((key) => !Object.getOwnPropertyDescriptor(data, key).writable);
+          const writeable = !Object.keys(data).find(key => !Object.getOwnPropertyDescriptor(data, key).writable);
           if (!writeable) {
             return data;
           }
@@ -45,15 +45,15 @@ export class CheckSecurityInterceptor implements NestInterceptor {
           (item) => {
             if (!item || typeof item !== 'object' || typeof item.securityCheck !== 'function') {
               if (Array.isArray(item)) {
-                return item.filter((i) => i !== undefined);
+                return item.filter(i => i !== undefined);
               }
               return item;
             }
             return item.securityCheck(user, force);
           },
-          { specialFunctions: ['securityCheck'] }
+          { specialFunctions: ['securityCheck'] },
         );
-      })
+      }),
     );
   }
 }

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

@@ -8,6 +8,8 @@ import { CronExpression } from '@nestjs/schedule';
 import compression from 'compression';
 import { CollationOptions } from 'mongodb';
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport';
+import { MongoosePingCheckSettings } from '@nestjs/terminus/dist/health-indicator/database/mongoose.health';
+import { DiskHealthIndicatorOptions } from '@nestjs/terminus/dist/health-indicator/disk/disk-health-options.type';
 import { Falsy } from '../types/falsy.type';
 import { CronJobConfig } from './cron-job-config.interface';
 import { MailjetOptions } from './mailjet-options.interface';
@@ -170,6 +172,107 @@ export interface IServerOptions {
     options?: GqlModuleAsyncOptions;
   };
 
+  /**
+   * Whether to activate health check endpoints
+   */
+  healthCheck?: {
+
+    /**
+     * Whether health check is enabled
+     */
+    enabled?: boolean;
+
+    /**
+     * Configuration of single health checks
+     */
+    configs?: {
+
+      /**
+       * Configuration for database health check
+       */
+      database?: {
+
+        /**
+         * Whether to enable the database health check
+         */
+        enabled?: boolean;
+
+        /**
+         * Key in result JSON
+         */
+        key?: string;
+
+        /**
+         * Database health check options
+         */
+        options?: MongoosePingCheckSettings;
+      };
+
+      /**
+       * Configuration for memory heap health check
+       */
+      memoryHeap?: {
+
+        /**
+         * Whether to enable the memory heap health check
+         */
+        enabled?: boolean;
+
+        /**
+         * Key in result JSON
+         */
+        key?: string;
+
+        /**
+         * Memory limit in bytes
+         */
+        heapUsedThreshold?: number;
+      };
+
+      /**
+       * Configuration for memory resident set size health check
+       */
+      memoryRss?: {
+
+        /**
+         * Whether to enable the memory resident set size health check
+         */
+        enabled?: boolean;
+
+        /**
+         * Key in result JSON
+         */
+        key?: string;
+
+        /**
+         * Memory limit in bytes
+         */
+        rssThreshold?: number;
+      };
+
+      /**
+       * Configuration for disk space health check
+       */
+      storage?: {
+
+        /**
+         * Whether to enable the disk space health check
+         */
+        enabled?: boolean;
+
+        /**
+         * Key in result JSON
+         */
+        key?: string;
+
+        /**
+         * Disk health indicator options
+         */
+        options?: DiskHealthIndicatorOptions;
+      };
+    };
+  };
+
   /**
    * Ignore selections in fieldSelection
    * [ConfigService must be integrated in ModuleService]
@@ -218,6 +321,12 @@ export interface IServerOptions {
   mongoose?: {
     collation?: CollationOptions;
 
+    /**
+     * Whether to create SVG-Diagrams of mongoose models
+     * @beta
+     */
+    modelDocumentation?: boolean;
+
     /**
      * Mongoose connection string
      */

package/src/core/common/models/core-model.model.ts

@@ -32,7 +32,7 @@ export abstract class CoreModel {
       init?: any;
       item?: T;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): T {
     const item = options.item || new this();
     delete options.item;
@@ -57,7 +57,7 @@ export abstract class CoreModel {
       init?: any;
       item?: T;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): T {
     const item = options.item || new this();
     delete options.item;
@@ -68,6 +68,7 @@ export abstract class CoreModel {
    * Initialize instance with default values instead of undefined
    * Should be overwritten in child class to organize the defaults
    */
+  // eslint-disable-next-line unused-imports/no-unused-vars
   public init(...args: any[]): this {
     return this;
   }
@@ -83,7 +84,7 @@ export abstract class CoreModel {
       funcAllowed?: boolean;
       init?: any;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     const config = {
       cloneDeep: false,
@@ -114,7 +115,7 @@ export abstract class CoreModel {
       funcAllowed?: boolean;
       init?: any;
       mapId?: boolean;
-    } = {}
+    } = {},
   ): this {
     const config = {
       cloneDeep: true,
@@ -129,6 +130,7 @@ export abstract class CoreModel {
   /**
    * Verification of the user's rights to access the properties of this object
    */
+  // eslint-disable-next-line unused-imports/no-unused-vars
   public securityCheck(user: any, force?: boolean): this {
     return this;
   }

package/src/core/common/models/core-persistence.model.ts

@@ -36,7 +36,7 @@ export abstract class CorePersistenceModel extends CoreModel {
   /**
    * ID of the persistence object as string
    */
-  @Field((type) => ID, {
+  @Field(type => ID, {
     description: 'ID of the persistence object',
     nullable: true,
   })
@@ -52,7 +52,7 @@ export abstract class CorePersistenceModel extends CoreModel {
   /**
    * Labels of the object
    */
-  @Field((type) => [String], {
+  @Field(type => [String], {
     description: 'Labels of the object',
     nullable: true,
   })
@@ -62,7 +62,7 @@ export abstract class CorePersistenceModel extends CoreModel {
   /**
    * Tags for the object
    */
-  @Field((type) => [String], {
+  @Field(type => [String], {
     description: 'Tags for the object',
     nullable: true,
   })

package/src/core/common/pipes/map-and-validate.pipe.ts

@@ -1,4 +1,4 @@
-import { PipeTransform, Injectable, ArgumentMetadata, BadRequestException } from '@nestjs/common';
+import { ArgumentMetadata, BadRequestException, Injectable, PipeTransform } from '@nestjs/common';
 import { plainToInstance } from 'class-transformer';
 import { validate } from 'class-validator';
 import { isBasicType } from '../helpers/input.helper';
@@ -24,7 +24,7 @@ export class MapAndValidatePipe implements PipeTransform {
     // Validate
     const errors = await validate(value, { forbidUnknownValues: false });
     if (errors.length > 0) {
-      throw new BadRequestException('Input validation failed:' + errors.join('; '));
+      throw new BadRequestException(`Input validation failed:${errors.join('; ')}`);
     }
 
     return value;

package/src/core/common/scalars/any.scalar.ts

@@ -4,7 +4,7 @@ import { Kind, ValueNode } from 'graphql';
 /**
  * Any scalar (is equivalent to the JSON scalar)
  */
-@Scalar('Any', (type) => Any)
+@Scalar('Any', type => Any)
 export class Any implements CustomScalar<string, any> {
   /**
    * Description of the scalar
@@ -45,7 +45,7 @@ export class Any implements CustomScalar<string, any> {
         return value;
       }
       case Kind.LIST:
-        return ast.values.map((n) => this.parseLiteral(n, variables));
+        return ast.values.map(n => this.parseLiteral(n, variables));
       case Kind.NULL:
         return null;
       case Kind.VARIABLE: {