@lenne.tech/nest-server 10.0.0 → 10.0.3

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,35 @@ export interface IServerOptions {
     options?: GqlModuleAsyncOptions;
   };
 
+  /**
+   * Whether to activate health check endpoints
+   */
+  healthCheck?: {
+    enabled?: boolean;
+    configs?: {
+      database?: {
+        disabled?: boolean;
+        key?: string;
+        options?: MongoosePingCheckSettings;
+      };
+      memoryHeap?: {
+        disabled?: boolean;
+        key?: string;
+        heapUsedThreshold?: number;
+      };
+      memoryRss?: {
+        disabled?: boolean;
+        key?: string;
+        rssThreshold?: number;
+      };
+      storage?: {
+        disabled?: boolean;
+        key?: string;
+        options?: DiskHealthIndicatorOptions;
+      };
+    };
+  };
+
   /**
    * Ignore selections in fieldSelection
    * [ConfigService must be integrated in ModuleService]

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: {

package/src/core/common/scalars/date-timestamp.scalar.ts

@@ -1,11 +1,10 @@
 import { CustomScalar, Scalar } from '@nestjs/graphql';
-import { Kind } from 'graphql';
 import { checkAndGetDate, getDateFromGraphQL } from '../helpers/input.helper';
 
 /**
  * Date-Timestamp-Scalar to convert timestamp to date and vice versa
  */
-@Scalar('Date', (type) => Date)
+@Scalar('Date', type => Date)
 export class DateTimestampScalar implements CustomScalar<number, Date> {
   description = 'Date (by Timestamp) custom scalar type';
 

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

@@ -1,11 +1,10 @@
 import { CustomScalar, Scalar } from '@nestjs/graphql';
-import { Kind } from 'graphql';
 import { checkAndGetDate, getDateFromGraphQL } from '../helpers/input.helper';
 
 /**
  * Date scalar to convert string into date
  */
-@Scalar('Date', (type) => Date)
+@Scalar('Date', type => Date)
 export class DateScalar implements CustomScalar<string, Date> {
   description = 'Date custom scalar type';
 

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

@@ -4,13 +4,13 @@ import { Kind, ValueNode } from 'graphql';
 /**
  * JSON scalar (is equivalent to the Any scalar)
  */
-@Scalar('JSON', (type) => JSON)
+@Scalar('JSON', type => JSON)
 export class JSON implements CustomScalar<string, any> {
   /**
    * Description of the scalar
    */
-  description =
-    'JSON scalar type. Information on the exact schema of the JSON object is contained in the description of the field.';
+  description
+    = 'JSON scalar type. Information on the exact schema of the JSON object is contained in the description of the field.';
 
   /**
    * Parse value from the client input variables
@@ -46,7 +46,7 @@ export class JSON 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: {

package/src/core/common/services/config.service.ts

@@ -37,14 +37,14 @@ export class ConfigService {
   /**
    * BehaviorSubject for config
    */
-  protected static _configSubject$: BehaviorSubject<{ [key: string]: any } & Partial<IServerOptions>> =
-    new BehaviorSubject(undefined);
+  protected static _configSubject$: BehaviorSubject<{ [key: string]: any } & Partial<IServerOptions>>
+    = new BehaviorSubject(undefined);
 
   /**
    * BehaviorSubject for frozen config
    */
-  protected static _frozenConfigSubject$: BehaviorSubject<{ [key: string]: any } & Partial<IServerOptions>> =
-    new BehaviorSubject(undefined);
+  protected static _frozenConfigSubject$: BehaviorSubject<{ [key: string]: any } & Partial<IServerOptions>>
+    = new BehaviorSubject(undefined);
 
   /**
    * Singleton instance of ConfigService
@@ -60,7 +60,7 @@ export class ConfigService {
    */
   constructor(
     configObject?: { [key: string]: any } & Partial<IServerOptions>,
-    options?: { reInit?: boolean; warn?: boolean }
+    options?: { reInit?: boolean; warn?: boolean },
   ) {
     const config = {
       reInit: false,
@@ -180,8 +180,8 @@ export class ConfigService {
    */
   static get observable() {
     return ConfigService._configSubject$.asObservable().pipe(
-      filter((config) => !config),
-      map((config) => clone(config, { circles: false }))
+      filter(config => !config),
+      map(config => clone(config, { circles: false })),
     );
   }
 
@@ -196,7 +196,7 @@ export class ConfigService {
    * Get observable for faster but read-only deep-frozen configuration
    */
   static get observableFastButReadOnly() {
-    return ConfigService._frozenConfigSubject$.asObservable().pipe(filter((config) => !config));
+    return ConfigService._frozenConfigSubject$.asObservable().pipe(filter(config => !config));
   }
 
   /**
@@ -243,7 +243,7 @@ export class ConfigService {
    */
   static mergeConfig(
     configData: { [key: string]: any } & Partial<IServerOptions>,
-    options?: { init?: boolean; warn?: boolean }
+    options?: { init?: boolean; warn?: boolean },
   ) {
     const config = {
       init: true,
@@ -266,7 +266,7 @@ export class ConfigService {
 
     // Warn if requested
     if (config.warn) {
-      console.warn('ConfigService ' + activity, JSON.stringify(merged, null, 2));
+      console.warn(`ConfigService ${activity}`, JSON.stringify(merged, null, 2));
     }
 
     // Return configuration
@@ -305,7 +305,7 @@ export class ConfigService {
 
     // Warn if requested
     if (config.warn) {
-      console.warn('ConfigService ' + key + ':', JSON.stringify(current[key], null, 2));
+      console.warn(`ConfigService ${key}:`, JSON.stringify(current[key], null, 2));
     }
 
     // Return configuration
@@ -317,7 +317,7 @@ export class ConfigService {
    */
   setConfig(
     configData: { [key: string]: any } & Partial<IServerOptions>,
-    options?: { reInit?: boolean; warn?: boolean }
+    options?: { reInit?: boolean; warn?: boolean },
   ) {
     return ConfigService.setConfig(configData, options);
   }
@@ -327,7 +327,7 @@ export class ConfigService {
    */
   static setConfig(
     configObject: { [key: string]: any } & Partial<IServerOptions>,
-    options?: { init?: boolean; reInit?: boolean; warn?: boolean }
+    options?: { init?: boolean; reInit?: boolean; warn?: boolean },
   ) {
     const config = {
       init: true,
@@ -342,8 +342,8 @@ export class ConfigService {
     // Check for unintentional overwriting
     if (!firstInitialization && !config.reInit) {
       throw new Error(
-        'Unintentional overwriting of the configuration. ' +
-          'If overwriting is desired, please set `reInit` in setConfig of ConfigService to `true`.'
+        'Unintentional overwriting of the configuration. '
+          + 'If overwriting is desired, please set `reInit` in setConfig of ConfigService to `true`.',
       );
     }
 
@@ -392,7 +392,7 @@ export class ConfigService {
     current[key] = value;
     ConfigService._configSubject$.next(current);
     if (config.warn) {
-      console.warn('ConfigService ' + key + ':', JSON.stringify(value, null, 2));
+      console.warn(`ConfigService ${key}:`, JSON.stringify(value, null, 2));
     }
 
     // Return config

package/src/core/common/services/core-cron-jobs.service.ts

@@ -31,7 +31,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
   protected constructor(
     protected schedulerRegistry: SchedulerRegistry,
     protected cronJobs: Record<string, CronExpression | string | Date | Falsy | CronJobConfig>,
-    options?: { log?: boolean }
+    options?: { log?: boolean },
   ) {
     this.config = {
       log: true,
@@ -91,7 +91,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
       // check if cron job exists
       if (!this[name]) {
         if (this.config.log) {
-          console.info('Missing cron job function ' + name);
+          console.info(`Missing cron job function ${name}`);
         }
         continue;
       }
@@ -105,8 +105,8 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
 
           // Check if parallel execution is allowed and if so how many can run in parallel
           if (
-            dates?.length &&
-            (!config.runParallel || (typeof config.runParallel === 'number' && dates.length >= config.runParallel))
+            dates?.length
+            && (!config.runParallel || (typeof config.runParallel === 'number' && dates.length >= config.runParallel))
           ) {
             return;
           }
@@ -123,7 +123,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
             await this[name]();
           } catch (e) {
             // Remove job from running list
-            this.runningJobs[name] = this.runningJobs[name].filter((item) => item !== date);
+            this.runningJobs[name] = this.runningJobs[name].filter(item => item !== date);
             if (config.throwException) {
               throw e;
             } else {
@@ -132,7 +132,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
           }
 
           // Remove job from running list
-          this.runningJobs[name] = this.runningJobs[name].filter((item) => item !== date);
+          this.runningJobs[name] = this.runningJobs[name].filter(item => item !== date);
         },
         null,
         true,
@@ -140,7 +140,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
         config.context,
         config.runOnInit,
         config.utcOffset,
-        config.unrefTimeout
+        config.unrefTimeout,
       );
       this.schedulerRegistry.addCronJob(name, job);
       if (this.config.log && this.schedulerRegistry.getCronJob(name)) {