@lenne.tech/nest-server 10.0.2 → 10.0.4

package/src/core/modules/user/core-user.service.ts

@@ -1,6 +1,6 @@
+import crypto = require('crypto');
 import { BadRequestException, NotFoundException, UnprocessableEntityException } from '@nestjs/common';
 import bcrypt = require('bcrypt');
-import crypto = require('crypto');
 import { sha256 } from 'js-sha256';
 import { Document, Model } from 'mongoose';
 import { assignPlain, prepareServiceOptionsForCreate } from '../../common/helpers/input.helper';
@@ -19,13 +19,13 @@ import { CoreUserInput } from './inputs/core-user.input';
 export abstract class CoreUserService<
   TUser extends CoreUserModel,
   TUserInput extends CoreUserInput,
-  TUserCreateInput extends CoreUserCreateInput
+  TUserCreateInput extends CoreUserCreateInput,
 > extends CrudService<TUser, TUserCreateInput, TUserInput> {
   protected constructor(
     protected override readonly configService: ConfigService,
     protected readonly emailService: EmailService,
     protected override readonly mainDbModel: Model<TUser & Document>,
-    protected override readonly mainModelConstructor: CoreModelConstructor<TUser>
+    protected override readonly mainModelConstructor: CoreModelConstructor<TUser>,
   ) {
     super();
   }
@@ -64,7 +64,7 @@ export abstract class CoreUserService<
         // Return created user
         return createdUser;
       },
-      { input, serviceOptions }
+      { input, serviceOptions },
     );
   }
 
@@ -82,6 +82,7 @@ export abstract class CoreUserService<
   /**
    * Get verified state of user by token
    */
+  // eslint-disable-next-line unused-imports/no-unused-vars
   async getVerifiedState(token: string, serviceOptions?: ServiceOptions): Promise<boolean> {
     const user = await this.mainDbModel.findOne({ verificationToken: token }).exec();
 
@@ -115,7 +116,7 @@ export abstract class CoreUserService<
         // Update and return user
         return await assignPlain(dbObject, { verified: true, verifiedAt: new Date() }).save();
       },
-      { dbObject, serviceOptions }
+      { dbObject, serviceOptions },
     );
   }
 
@@ -143,7 +144,7 @@ export abstract class CoreUserService<
           passwordResetToken: null,
         }).save();
       },
-      { dbObject, serviceOptions }
+      { dbObject, serviceOptions },
     );
   }
 
@@ -168,7 +169,7 @@ export abstract class CoreUserService<
         // Return new user
         return dbObject;
       },
-      { dbObject, serviceOptions }
+      { dbObject, serviceOptions },
     );
   }
 
@@ -182,7 +183,7 @@ export abstract class CoreUserService<
     }
 
     // Check roles values
-    if (roles.some((role) => typeof role !== 'string')) {
+    if (roles.some(role => typeof role !== 'string')) {
       throw new BadRequestException('Roles contains invalid values');
     }
 
@@ -191,7 +192,7 @@ export abstract class CoreUserService<
       async () => {
         return await this.mainDbModel.findByIdAndUpdate(userId, { roles }).exec();
       },
-      { serviceOptions }
+      { serviceOptions },
     );
   }
 }

package/src/core/modules/user/inputs/core-user.input.ts

@@ -4,7 +4,6 @@ import { Restricted } from '../../../common/decorators/restricted.decorator';
 import { ProcessType } from '../../../common/enums/process-type.enum';
 import { RoleEnum } from '../../../common/enums/role.enum';
 import { CoreInput } from '../../../common/inputs/core-input.input';
-import { toLowerCase } from '../../../common/middlewares/to-lower-case.middleware';
 
 /**
  * User input to update a user
@@ -41,7 +40,7 @@ export abstract class CoreUserInput extends CoreInput {
    * Roles of the user
    */
   @Restricted({ roles: RoleEnum.ADMIN, processType: ProcessType.INPUT })
-  @Field((type) => [String], { description: 'Roles of the user', nullable: true })
+  @Field(type => [String], { description: 'Roles of the user', nullable: true })
   @IsOptional()
   roles?: string[] = undefined;
 

package/src/core.module.ts

@@ -13,6 +13,8 @@ import { ConfigService } from './core/common/services/config.service';
 import { EmailService } from './core/common/services/email.service';
 import { MailjetService } from './core/common/services/mailjet.service';
 import { TemplateService } from './core/common/services/template.service';
+import { CoreHealthCheckModule } from './core/modules/health-check/core-health-check.module';
+import { ModelDocService } from './core/common/services/model-doc.service';
 
 /**
  * Core module (dynamic)
@@ -36,6 +38,7 @@ export class CoreModule implements NestModule {
   configure(consumer: MiddlewareConsumer) {
     consumer.apply(graphqlUploadExpress()).forRoutes('graphql');
   }
+
   /**
    * Dynamic module
    * see https://docs.nestjs.com/modules#dynamic-modules
@@ -75,7 +78,7 @@ export class CoreModule implements NestModule {
                             const payload = authService.decodeJwt(authToken);
                             const user = await authService.validateUser(payload);
                             // the user/jwtPayload object found will be available as context.currentUser/jwtPayload in your GraphQL resolvers
-                            return { user: user, headers: connectionParams };
+                            return { user, headers: connectionParams };
                           }
 
                           throw new UnauthorizedException('Missing authentication token');
@@ -105,7 +108,7 @@ export class CoreModule implements NestModule {
                     },
                   },
                 },
-                options?.graphQl?.driver
+                options?.graphQl?.driver,
               ),
           },
           enableSubscriptionAuth: true,
@@ -115,25 +118,24 @@ export class CoreModule implements NestModule {
           uri: 'mongodb://localhost/nest-server-default',
           options: {
             connectionFactory: (connection) => {
-              // eslint-disable-next-line @typescript-eslint/no-var-requires
               connection.plugin(require('./core/common/plugins/mongoose-id.plugin'));
               return connection;
             },
           },
         },
       } as IServerOptions,
-      options
+      options,
     );
 
     // Set providers
-    const providers = [
+    const providers: any[] = [
       // The ConfigService provides access to the current configuration of the module
       {
         provide: ConfigService,
         useValue: new ConfigService(config),
       },
 
-      // [Global] Map plain objects to metatype and validate
+      // [Global] Map plain objects to meta-type and validate
       {
         provide: APP_PIPE,
         useClass: MapAndValidatePipe,
@@ -148,15 +150,24 @@ export class CoreModule implements NestModule {
       ComplexityPlugin,
     ];
 
+    if (config.mongoose?.modelDocumentation) {
+      providers.push(ModelDocService);
+    }
+
+    const imports: any[] = [
+      MongooseModule.forRoot(config.mongoose.uri, config.mongoose.options),
+      GraphQLModule.forRootAsync<ApolloDriverConfig>(
+        Object.assign({ driver: ApolloDriver }, config.graphQl.driver, config.graphQl.options),
+      ),
+    ];
+    if (config.healthCheck) {
+      imports.push(CoreHealthCheckModule);
+    }
+
     // Return dynamic module
     return {
       module: CoreModule,
-      imports: [
-        MongooseModule.forRoot(config.mongoose.uri, config.mongoose.options),
-        GraphQLModule.forRootAsync<ApolloDriverConfig>(
-          Object.assign({ driver: ApolloDriver }, config.graphQl.driver, config.graphQl.options)
-        ),
-      ],
+      imports,
       providers,
       exports: [ConfigService, EmailService, TemplateService, MailjetService, ComplexityPlugin],
     };

package/src/index.ts

@@ -64,6 +64,7 @@ export * from './core/common/services/core-cron-jobs.service';
 export * from './core/common/services/crud.service';
 export * from './core/common/services/email.service';
 export * from './core/common/services/mailjet.service';
+export * from './core/common/services/model-doc.service';
 export * from './core/common/services/module.service';
 export * from './core/common/services/template.service';
 export * from './core/common/types/core-model-constructor.type';
@@ -125,6 +126,16 @@ export * from './core/modules/user/inputs/core-user-create.input';
 export * from './core/modules/user/core-user.model';
 export * from './core/modules/user/core-user.service';
 
+// =====================================================================================================================
+// Core - Modules - HealthCheck
+// =====================================================================================================================
+
+export * from './core/modules/health-check/core-health-check.controller';
+export * from './core/modules/health-check/core-health-check.module';
+export * from './core/modules/health-check/core-health-check.resolver';
+export * from './core/modules/health-check/core-health-check.service';
+export * from './core/modules/health-check/core-health-check-result.model';
+
 // =====================================================================================================================
 // Tests
 // =====================================================================================================================

package/src/main.ts

@@ -1,6 +1,6 @@
+import { exec } from 'child_process';
 import { NestFactory } from '@nestjs/core';
 import { NestExpressApplication } from '@nestjs/platform-express';
-import { exec } from 'child_process';
 import compression = require('compression');
 import cookieParser = require('cookie-parser');
 import envConfig from './config.env';
@@ -14,7 +14,7 @@ async function bootstrap() {
   // Create a new server based on express
   const server = await NestFactory.create<NestExpressApplication>(
     // Include server module, with all necessary modules for the project
-    ServerModule
+    ServerModule,
   );
 
   // Log exceptions

package/src/server/modules/auth/auth.controller.ts

@@ -10,7 +10,7 @@ export class AuthController extends CoreAuthController {
    */
   constructor(
     protected override readonly authService: AuthService,
-    protected override readonly configService: ConfigService
+    protected override readonly configService: ConfigService,
   ) {
     super(authService, configService);
   }

package/src/server/modules/auth/auth.resolver.ts

@@ -19,7 +19,7 @@ export class AuthResolver extends CoreAuthResolver {
    */
   constructor(
     protected override readonly authService: AuthService,
-    protected override readonly configService: ConfigService
+    protected override readonly configService: ConfigService,
   ) {
     super(authService, configService);
   }
@@ -31,7 +31,7 @@ export class AuthResolver extends CoreAuthResolver {
   override async signIn(
     @GraphQLServiceOptions({ gqlPath: 'signIn.user' }) serviceOptions: ServiceOptions,
     @Context() ctx: { res: ResponseType },
-    @Args('input') input: AuthSignInInput
+    @Args('input') input: AuthSignInInput,
   ): Promise<Auth> {
     const result = await this.authService.signIn(input, {
       ...serviceOptions,
@@ -49,7 +49,7 @@ export class AuthResolver extends CoreAuthResolver {
   override async signUp(
     @GraphQLServiceOptions({ gqlPath: 'signUp.user' }) serviceOptions: ServiceOptions,
     @Context() ctx: { res: ResponseType },
-    @Args('input') input: AuthSignUpInput
+    @Args('input') input: AuthSignUpInput,
   ): Promise<Auth> {
     const result = await this.authService.signUp(input, serviceOptions);
     return this.processCookies(ctx, result);

package/src/server/modules/auth/auth.service.ts

@@ -15,7 +15,7 @@ export class AuthService extends CoreAuthService {
     protected override readonly jwtService: JwtService,
     protected readonly emailService: EmailService,
     protected override readonly userService: UserService,
-    protected override readonly configService: ConfigService
+    protected override readonly configService: ConfigService,
   ) {
     super(userService, jwtService, configService);
   }
@@ -43,7 +43,7 @@ export class AuthService extends CoreAuthService {
       htmlTemplate: 'welcome',
       templateData: {
         name: user.username,
-        link: this.configService.configFastButReadOnly.email.verificationLink + '/' + user.verificationToken,
+        link: `${this.configService.configFastButReadOnly.email.verificationLink}/${user.verificationToken}`,
       },
     });
 

package/src/server/modules/file/file.controller.ts

@@ -7,7 +7,6 @@ import {
   Param,
   Post,
   Res,
-  UnprocessableEntityException,
   UploadedFile,
   UseInterceptors,
 } from '@nestjs/common';
@@ -57,7 +56,7 @@ export class FileController {
     }
     const filestream = await this.fileService.getFileStream(id);
     res.header('Content-Type', file.contentType);
-    res.header('Content-Disposition', 'attachment; filename=' + file.filename);
+    res.header('Content-Disposition', `attachment; filename=${file.filename}`);
     res.header('Cache-Control', 'max-age=31536000');
     return filestream.pipe(res);
   }

package/src/server/modules/file/file.module.ts

@@ -1,4 +1,4 @@
-import { forwardRef, Module } from '@nestjs/common';
+import { Module, forwardRef } from '@nestjs/common';
 import { MulterModule } from '@nestjs/platform-express';
 import { UserModule } from '../user/user.module';
 import { FileController } from './file.controller';

package/src/server/modules/file/file.resolver.ts

@@ -1,6 +1,6 @@
-import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
 import fs = require('fs');
 import { createWriteStream } from 'fs';
+import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
 import GraphQLUpload = require('graphql-upload/GraphQLUpload.js');
 import { Roles } from '../../../core/common/decorators/roles.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
@@ -63,6 +63,7 @@ export class FileResolver {
     // Save files in filesystem
     const promises: Promise<any>[] = [];
     for (const file of files) {
+      // eslint-disable-next-line unused-imports/no-unused-vars
       const { filename, mimetype, encoding, createReadStream } = await file;
       await fs.promises.mkdir('./uploads', { recursive: true });
       promises.push(
@@ -70,8 +71,8 @@ export class FileResolver {
           createReadStream()
             .pipe(createWriteStream(`./uploads/${filename}`))
             .on('finish', () => resolve(true))
-            .on('error', (error) => reject(error))
-        )
+            .on('error', error => reject(error)),
+        ),
       );
     }
     await Promise.allSettled(promises);

package/src/server/modules/file/file.service.ts

@@ -16,7 +16,7 @@ export class FileService extends CoreFileService {
    * Duplicate file by name
    */
   async duplicate(fileName: string, newName: string): Promise<any> {
-    return new Promise(async (resolve, reject) => {
+    return new Promise(async (resolve) => {
       resolve(this.files.openDownloadStreamByName(fileName).pipe(this.files.openUploadStream(newName)));
     });
   }

package/src/server/modules/file/multer-config.service.ts

@@ -14,7 +14,7 @@ export class GridFsMulterConfigService implements MulterOptionsFactory {
         return new Promise((resolve) => {
           const filename = file.originalname.trim();
           const fileInfo = {
-            filename: filename,
+            filename,
           };
           resolve(fileInfo);
         });

package/src/server/modules/user/avatar.controller.ts

@@ -28,9 +28,9 @@ export class AvatarController {
     FileInterceptor(
       'file',
       multerOptionsForImageUpload({
-        destination: envConfig.staticAssets.path + '/avatars',
-      })
-    )
+        destination: `${envConfig.staticAssets.path}/avatars`,
+      }),
+    ),
   )
   uploadFile(@UploadedFile() file: Express.Multer.File, @CurrentUser() user: User): Promise<string> {
     return this.usersService.setAvatar(file, user);

package/src/server/modules/user/user.model.ts

@@ -1,5 +1,5 @@
 import { Field, ObjectType } from '@nestjs/graphql';
-import { Prop, Schema as MongooseSchema, SchemaFactory } from '@nestjs/mongoose';
+import { Schema as MongooseSchema, Prop, SchemaFactory } from '@nestjs/mongoose';
 import { Document, Schema } from 'mongoose';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
 import { CoreUserModel } from '../../../core/modules/user/core-user.model';

package/src/server/modules/user/user.resolver.ts

@@ -46,7 +46,7 @@ export class UserResolver {
   @Query(() => FindAndCountUsersResult, { description: 'Find users (via filter)' })
   async findAndCountUsers(
     @GraphQLServiceOptions({ gqlPath: 'findAndCountUsers.items' }) serviceOptions: ServiceOptions,
-    @Args() args?: FilterArgs
+    @Args() args?: FilterArgs,
   ) {
     return await this.userService.findAndCount(args, {
       ...serviceOptions,
@@ -95,7 +95,7 @@ export class UserResolver {
   @Mutation(() => User, { description: 'Create a new user' })
   async createUser(
     @GraphQLServiceOptions() serviceOptions: ServiceOptions,
-    @Args('input') input: UserCreateInput
+    @Args('input') input: UserCreateInput,
   ): Promise<User> {
     return await this.userService.create(input, {
       ...serviceOptions,
@@ -132,7 +132,7 @@ export class UserResolver {
   async updateUser(
     @GraphQLServiceOptions() serviceOptions: ServiceOptions,
     @Args('input') input: UserInput,
-    @Args('id') id: string
+    @Args('id') id: string,
   ): Promise<User> {
     // Update user
     return await this.userService.update(id, input, {
@@ -162,7 +162,7 @@ export class UserResolver {
     filter(this: UserResolver, payload, variables, context) {
       return context?.user?.hasRole?.(RoleEnum.ADMIN);
     },
-    resolve: (user) => user,
+    resolve: user => user,
   })
   async userCreated() {
     return this.pubSub.asyncIterator('userCreated');

package/src/server/modules/user/user.service.ts

@@ -1,6 +1,6 @@
+import fs = require('fs');
 import { Inject, Injectable, UnauthorizedException, UnprocessableEntityException } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
-import fs = require('fs');
 import { PubSub } from 'graphql-subscriptions';
 import { Model } from 'mongoose';
 import { ServiceOptions } from '../../../core/common/interfaces/service-options.interface';
@@ -29,7 +29,7 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
     protected override readonly emailService: EmailService,
     @Inject('USER_CLASS') protected override readonly mainModelConstructor: CoreModelConstructor<User>,
     @InjectModel('User') protected override readonly mainDbModel: Model<UserDocument>,
-    @Inject('PUB_SUB') protected readonly pubSub: PubSub
+    @Inject('PUB_SUB') protected readonly pubSub: PubSub,
   ) {
     super(configService, emailService, mainDbModel, mainModelConstructor);
   }
@@ -73,7 +73,7 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
       htmlTemplate: 'password-reset',
       templateData: {
         name: user.username,
-        link: this.configService.configFastButReadOnly.email.passwordResetLink + '/' + user.passwordResetToken,
+        link: `${this.configService.configFastButReadOnly.email.passwordResetLink}/${user.passwordResetToken}`,
       },
     });
 
@@ -98,7 +98,7 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
 
     // Remove old avatar image
     if (user.avatar) {
-      fs.unlink(this.configService.configFastButReadOnly.staticAssets.path + '/avatars/' + user.avatar, (err) => {
+      fs.unlink(`${this.configService.configFastButReadOnly.staticAssets.path}/avatars/${user.avatar}`, (err) => {
         if (err) {
           console.error(err);
         }

package/src/test/test.helper.ts

@@ -1,10 +1,10 @@
-import { INestApplication } from '@nestjs/common';
 import { Blob } from 'buffer';
+import util = require('util');
+import { INestApplication } from '@nestjs/common';
 import { createClient } from 'graphql-ws';
 import { jsonToGraphQLQuery } from 'json-to-graphql-query';
 import { Types } from 'mongoose';
 import supertest = require('supertest');
-import util = require('util');
 import ws = require('ws');
 import { getStringIds } from '../core/common/helpers/db.helper';
 
@@ -158,7 +158,7 @@ export class TestHelper {
     return new Promise((resolve, reject) => {
       const request = supertest((this.app as INestApplication).getHttpServer()).get(url);
       if (token) {
-        request.set('Authorization', 'bearer ' + token);
+        request.set('Authorization', `bearer ${token}`);
       }
       let data = '';
       request
@@ -220,7 +220,7 @@ export class TestHelper {
           name: null,
           type: TestGraphQLType.QUERY,
         },
-        graphql
+        graphql,
       ) as TestGraphQLConfig;
 
       // Init request
@@ -256,7 +256,7 @@ export class TestHelper {
     if (config.convertEnums) {
       if (Array.isArray(config.convertEnums)) {
         for (const key of Object.values(config.convertEnums)) {
-          const regExpStr = '(' + key + ': )\\"([_A-Z][_0-9A-Z]*)\\"';
+          const regExpStr = `(${key}: )\\"([_A-Z][_0-9A-Z]*)\\"`;
           const regExp = new RegExp(regExpStr, 'g');
           query = query.replace(regExp, '$1$2');
         }
@@ -362,7 +362,7 @@ export class TestHelper {
     }
     if (Array.isArray(args)) {
       objects.set(args, args);
-      return args.map((item) => this.prepareArguments(item, objects));
+      return args.map(item => this.prepareArguments(item, objects));
     }
     if (typeof args === 'object') {
       objects.set(args, args);
@@ -429,7 +429,7 @@ export class TestHelper {
     log: boolean,
     logError: boolean,
     variables?: Record<string, TestGraphQLVariable>,
-    attachments?: Record<string, string>
+    attachments?: Record<string, string>,
   ): Promise<any> {
     // Token
     if (token) {
@@ -460,7 +460,7 @@ export class TestHelper {
     const method: string = requestConfig.method.toLowerCase();
     let request = supertest((this.app as INestApplication).getHttpServer())[method](requestConfig.url as string);
     if (token) {
-      request.set('Authorization', 'bearer ' + token);
+      request.set('Authorization', `bearer ${token}`);
     }
 
     // Process variables (incl. attachments for GraphQL)
@@ -508,7 +508,7 @@ export class TestHelper {
     }
     const map = {};
     mapArray.forEach((item, index) => {
-      map[index] = ['variables.' + item.key + ('index' in item ? '.' + item.index : '')];
+      map[index] = [`variables.${item.key}${'index' in item ? `.${item.index}` : ''}`];
     });
 
     // Add operations
@@ -565,7 +565,7 @@ export class TestHelper {
   async getSubscription(graphql: TestGraphQLConfig, query: string, options?: TestGraphQLOptions) {
     // Check url
     if (!this.subscriptionUrl) {
-      throw new Error("Missing subscriptionUrl in TestHelper: new TestHelper(app, 'ws://localhost:3030/graphql')");
+      throw new Error('Missing subscriptionUrl in TestHelper: new TestHelper(app, \'ws://localhost:3030/graphql\')');
     }
 
     // Prepare subscription
@@ -599,7 +599,7 @@ export class TestHelper {
           next: onNext,
           error: reject,
           complete: resolve as any,
-        }
+        },
       );
     });