@lenne.tech/nest-server 9.2.7 → 9.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "9.2.7",
+  "version": "9.2.8",
   "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",

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

@@ -0,0 +1,7 @@
+import { createParamDecorator } from '@nestjs/common';
+import { currentUserDec } from '../helpers/decorator.helper';
+
+/**
+ * Decorator to get current user for Controller (http context) and Resolver (graphql context)
+ */
+export const CurrentUser = createParamDecorator(currentUserDec);

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

@@ -0,0 +1,15 @@
+import { createParamDecorator } from '@nestjs/common';
+import { graphqlPopulateDec } from '../helpers/decorator.helper';
+
+/**
+ * Get Mongoose populate configuration for result type of GraphQL request
+ *
+ * gqlPath (string, default: name of the resolver method):
+ * Dot separated path to select specific fields in GraphQL request
+ * (usually name of the query or mutation (resolver) method, e.g 'getUser')
+ *
+ * ignoreSelections (boolean, default: true):
+ * Whether to ignore selections in population options
+ * to avoid problems with missing properties (if not requested) in the checkSecurity method of models
+ */
+export const GraphQLPopulate = createParamDecorator(graphqlPopulateDec);

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

@@ -0,0 +1,29 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { currentUserDec, graphqlPopulateDec } from '../helpers/decorator.helper';
+import { ServiceOptions } from '../interfaces/service-options.interface';
+
+/**
+ * Get standard ServiceOptions for GraphQL-Requests
+ *
+ * Includes following properties of ServiceOptions:
+ *  - currentUser
+ *  - populate
+ *
+ * Configuration via Decorator data:
+ *
+ * gqlPath (string, default: name of the resolver method):
+ * Dot separated path to select specific fields in GraphQL request
+ * (usually name of the query or mutation (resolver) method, e.g 'getUser')
+ *
+ * ignoreSelections (boolean, default: true):
+ * Whether to ignore selections in population options
+ * to avoid problems with missing properties (if not requested) in the checkSecurity method of models
+ */
+export const GraphQLServiceOptions = createParamDecorator(
+  (data: { gqlPath?: string; ignoreSelections?: boolean }, ctx: ExecutionContext): ServiceOptions => {
+    return {
+      currentUser: currentUserDec(null, ctx),
+      populate: graphqlPopulateDec(data, ctx),
+    };
+  }
+);

package/src/core/common/enums/role.enum.ts

@@ -36,13 +36,13 @@ export enum RoleEnum {
   // into user.roles!
   // ===================================================================================================================
 
-  // Everyone, including users who are not logged in, can access (see context user, e.g. @GraphQLUser)
+  // Everyone, including users who are not logged in, can access (see context user, e.g. @CurrentUser)
   S_EVERYONE = 's_everyone',
 
   // No one has access, not even administrators
   S_NO_ONE = 's_no_one',
 
-  // User must be logged in (see context user, e.g. @GraphQLUser)
+  // User must be logged in (see context user, e.g. @CurrentUser)
   S_USER = 's_user',
 
   // ===================================================================================================================

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

@@ -1,4 +1,5 @@
-import { ArgumentsHost, Catch, ContextType, ExceptionFilter, HttpException } from '@nestjs/common';
+import { ArgumentsHost, Catch, ExceptionFilter, HttpException } from '@nestjs/common';
+import { GqlContextType } from '@nestjs/graphql';
 import { Response } from 'express';
 
 @Catch(HttpException)
@@ -11,7 +12,7 @@ export class HttpExceptionLogFilter implements ExceptionFilter {
     console.debug(exception.stack);
 
     // GraphQL
-    const type = host.getType() as ContextType | 'graphql';
+    const type = host.getType<GqlContextType>();
     if (type === 'graphql') {
       return exception;
     }

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

@@ -0,0 +1,54 @@
+import { ExecutionContext } from '@nestjs/common';
+import { GqlContextType, GqlExecutionContext } from '@nestjs/graphql';
+import { PopulateOptions } from 'mongoose';
+import { getPopulateOptions } from './db.helper';
+import { removePropertiesDeep } from './input.helper';
+
+/**
+ * Decorator function to get current user for Controller (http context) and Resolver (graphql context)
+ */
+export function currentUserDec(data, ctx: ExecutionContext) {
+  if (ctx.getType<GqlContextType>() === 'graphql') {
+    const gqlContext = GqlExecutionContext.create(ctx);
+    return gqlContext.getContext().req.user;
+  }
+  return ctx.switchToHttp().getRequest().user;
+}
+
+/**
+ * Decorator function to get Mongoose populate configuration for result type of GraphQL request
+ *
+ * gqlPath (string, default: name of the resolver method):
+ * Dot separated path to select specific fields in GraphQL request
+ * (usually name of the query or mutation (resolver) method, e.g 'getUser')
+ *
+ * ignoreSelections (boolean, default: true):
+ * Whether to ignore selections in population options
+ * to avoid problems with missing properties (if not requested) in the checkSecurity method of models
+ */
+export function graphqlPopulateDec(
+  data: { gqlPath?: string; ignoreSelections?: boolean },
+  ctx: ExecutionContext
+): PopulateOptions[] {
+  // Check context type
+  if (ctx.getType<GqlContextType>() !== 'graphql') {
+    return undefined;
+  }
+
+  // Init data
+  const gqlContext = GqlExecutionContext.create(ctx);
+  const { gqlPath, ignoreSelections } = {
+    gqlPath: gqlContext.getHandler().name,
+    ignoreSelections: true,
+    ...data,
+  };
+
+  // Get and prepare populate options
+  const populateOptions = getPopulateOptions(gqlContext.getInfo(), gqlPath);
+  if (ignoreSelections) {
+    removePropertiesDeep(populateOptions, ['select']);
+  }
+
+  // Return prepared populate options
+  return populateOptions;
+}

package/src/core/common/types/populate-config.type.ts

@@ -0,0 +1,6 @@
+import { PopulateOptions } from 'mongoose';
+
+/**
+ * Configuration (path or options) for Mongoose populate methode
+ */
+export type PopulateConfig = string | string[] | PopulateOptions | (PopulateOptions | string)[];

package/src/core/modules/auth/core-auth.controller.ts

@@ -1,9 +1,7 @@
 import { Body, Controller, Get, Param, ParseBoolPipe, Post, Res, UseGuards } from '@nestjs/common';
-import { Args, Info } from '@nestjs/graphql';
+import { Args } from '@nestjs/graphql';
 import { Response as ResponseType } from 'express';
-import { GraphQLResolveInfo } from 'graphql/index';
-import { GraphQLUser } from '../../common/decorators/graphql-user.decorator';
-import { RESTUser } from '../../common/decorators/rest-user.decorator';
+import { CurrentUser } from '../../common/decorators/current-user.decorator';
 import { ConfigService } from '../../common/services/config.service';
 import { AuthGuardStrategy } from './auth-guard-strategy.enum';
 import { CoreAuthModel } from './core-auth.model';
@@ -27,7 +25,7 @@ export class CoreAuthController {
   @UseGuards(AuthGuard(AuthGuardStrategy.JWT))
   @Get()
   async logout(
-    @RESTUser() currentUser: ICoreAuthUser,
+    @CurrentUser() currentUser: ICoreAuthUser,
     @Tokens('token') token: string,
     @Res() res: ResponseType,
     @Param('allDevices', ParseBoolPipe) allDevices?: boolean
@@ -42,7 +40,7 @@ export class CoreAuthController {
   @UseGuards(AuthGuard(AuthGuardStrategy.JWT_REFRESH))
   @Get()
   async refreshToken(
-    @GraphQLUser() user: ICoreAuthUser,
+    @CurrentUser() user: ICoreAuthUser,
     @Tokens('refreshToken') refreshToken: string,
     @Res() res: ResponseType
   ): Promise<CoreAuthModel> {
@@ -54,11 +52,7 @@ export class CoreAuthController {
    * Sign in user via email and password (on specific device)
    */
   @Post()
-  async signIn(
-    @Info() info: GraphQLResolveInfo,
-    @Res() res: ResponseType,
-    @Body('input') input: CoreAuthSignInInput
-  ): Promise<CoreAuthModel> {
+  async signIn(@Res() res: ResponseType, @Body('input') input: CoreAuthSignInInput): Promise<CoreAuthModel> {
     const result = await this.authService.signIn(input);
     return this.processCookies(res, result);
   }
@@ -67,11 +61,7 @@ export class CoreAuthController {
    * Register a new user account (on specific device)
    */
   @Post()
-  async signUp(
-    @Info() info: GraphQLResolveInfo,
-    @Res() res: ResponseType,
-    @Args('input') input: CoreAuthSignUpInput
-  ): Promise<CoreAuthModel> {
+  async signUp(@Res() res: ResponseType, @Args('input') input: CoreAuthSignUpInput): Promise<CoreAuthModel> {
     const result = await this.authService.signUp(input);
     return this.processCookies(res, result);
   }

package/src/core/modules/auth/core-auth.resolver.ts

@@ -1,8 +1,9 @@
 import { UseGuards } from '@nestjs/common';
-import { Args, Context, Info, Mutation, Resolver } from '@nestjs/graphql';
+import { Args, Context, Mutation, Resolver } from '@nestjs/graphql';
 import { Response as ResponseType } from 'express';
-import { GraphQLResolveInfo } from 'graphql';
-import { GraphQLUser } from '../../common/decorators/graphql-user.decorator';
+import { CurrentUser } from '../../common/decorators/current-user.decorator';
+import { GraphQLServiceOptions } from '../../common/decorators/graphql-service-options.decorator';
+import { ServiceOptions } from '../../common/interfaces/service-options.interface';
 import { ConfigService } from '../../common/services/config.service';
 import { AuthGuardStrategy } from './auth-guard-strategy.enum';
 import { CoreAuthModel } from './core-auth.model';
@@ -33,7 +34,7 @@ export class CoreAuthResolver {
   @UseGuards(AuthGuard(AuthGuardStrategy.JWT))
   @Mutation((returns) => Boolean, { description: 'Logout user (from specific device)' })
   async logout(
-    @GraphQLUser() currentUser: ICoreAuthUser,
+    @CurrentUser() currentUser: ICoreAuthUser,
     @Context() ctx: { res: ResponseType },
     @Tokens('token') token: string,
     @Args('allDevices', { nullable: true }) allDevices?: boolean
@@ -48,7 +49,7 @@ export class CoreAuthResolver {
   @UseGuards(AuthGuard(AuthGuardStrategy.JWT_REFRESH))
   @Mutation((returns) => CoreAuthModel, { description: 'Refresh tokens (for specific device)' })
   async refreshToken(
-    @GraphQLUser() user: ICoreAuthUser,
+    @CurrentUser() user: ICoreAuthUser,
     @Tokens('refreshToken') refreshToken: string,
     @Context() ctx: { res: ResponseType }
   ): Promise<CoreAuthModel> {
@@ -63,11 +64,11 @@ export class CoreAuthResolver {
     description: 'Sign in user via email and password and get JWT tokens (for specific device)',
   })
   async signIn(
-    @Info() info: GraphQLResolveInfo,
+    @GraphQLServiceOptions({ gqlPath: 'signIn.user' }) serviceOptions: ServiceOptions,
     @Context() ctx: { res: ResponseType },
     @Args('input') input: CoreAuthSignInInput
   ): Promise<CoreAuthModel> {
-    const result = await this.authService.signIn(input, { fieldSelection: { info, select: 'signIn' } });
+    const result = await this.authService.signIn(input, serviceOptions);
     return this.processCookies(ctx, result);
   }
 
@@ -76,11 +77,11 @@ export class CoreAuthResolver {
    */
   @Mutation((returns) => CoreAuthModel, { description: 'Register a new user account (on specific device)' })
   async signUp(
-    @Info() info: GraphQLResolveInfo,
+    @GraphQLServiceOptions({ gqlPath: 'signUp.user' }) serviceOptions: ServiceOptions,
     @Context() ctx: { res: ResponseType },
     @Args('input') input: CoreAuthSignUpInput
   ): Promise<CoreAuthModel> {
-    const result = await this.authService.signUp(input, { fieldSelection: { info, select: 'signUp' } });
+    const result = await this.authService.signUp(input, serviceOptions);
     return this.processCookies(ctx, result);
   }
 

package/src/core/modules/file/core-file.controller.ts

@@ -1,5 +1,5 @@
 import { BadRequestException, Controller, Get, NotFoundException, Param, Res } from '@nestjs/common';
-import { RESTUser } from '../../common/decorators/rest-user.decorator';
+import { CurrentUser } from '../../common/decorators/current-user.decorator';
 import { CoreUserModel } from '../user/core-user.model';
 import { CoreFileService } from './core-file.service';
 
@@ -17,7 +17,7 @@ export abstract class CoreFileController {
    * Download file
    */
   @Get(':filename')
-  async getFile(@Param('filename') filename: string, @Res() res, @RESTUser() user: CoreUserModel) {
+  async getFile(@Param('filename') filename: string, @Res() res, @CurrentUser() user: CoreUserModel) {
     if (!filename) {
       throw new BadRequestException('Missing filename for download');
     }

package/src/index.ts

@@ -9,6 +9,9 @@ export * from './core.module';
 // =====================================================================================================================
 export * from './core/common/args/filter.args';
 export * from './core/common/args/pagination.args';
+export * from './core/common/decorators/current-user.decorator';
+export * from './core/common/decorators/graphql-populate.decorator';
+export * from './core/common/decorators/graphql-service-options.decorator';
 export * from './core/common/decorators/graphql-user.decorator';
 export * from './core/common/decorators/rest-user.decorator';
 export * from './core/common/decorators/restricted.decorator';
@@ -23,6 +26,7 @@ export * from './core/common/helpers/common.helper';
 export * from './core/common/helpers/config.helper';
 export * from './core/common/helpers/context.helper';
 export * from './core/common/helpers/db.helper';
+export * from './core/common/helpers/decorator.helper';
 export * from './core/common/helpers/file.helper';
 export * from './core/common/helpers/filter.helper';
 export * from './core/common/helpers/graphql.helper';
@@ -68,6 +72,7 @@ export * from './core/common/types/is-one-of.type';
 export * from './core/common/types/maybe-promise.type';
 export * from './core/common/types/plain-input.type';
 export * from './core/common/types/plain-object.type';
+export * from './core/common/types/populate-config.type';
 export * from './core/common/types/remove-methods.type';
 export * from './core/common/types/require-only-one.type';
 export * from './core/common/types/required-at-least-one.type';

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

@@ -1,6 +1,7 @@
-import { Args, Context, Info, Mutation, Resolver } from '@nestjs/graphql';
+import { Args, Context, Mutation, Resolver } from '@nestjs/graphql';
 import { Response as ResponseType } from 'express';
-import { GraphQLResolveInfo } from 'graphql';
+import { GraphQLServiceOptions } from '../../../core/common/decorators/graphql-service-options.decorator';
+import { ServiceOptions } from '../../../core/common/interfaces/service-options.interface';
 import { ConfigService } from '../../../core/common/services/config.service';
 import { CoreAuthResolver } from '../../../core/modules/auth/core-auth.resolver';
 import { Auth } from './auth.model';
@@ -28,12 +29,12 @@ export class AuthResolver extends CoreAuthResolver {
    */
   @Mutation(() => Auth, { description: 'Sign in and get JWT token' })
   override async signIn(
-    @Info() info: GraphQLResolveInfo,
+    @GraphQLServiceOptions({ gqlPath: 'signIn.user' }) serviceOptions: ServiceOptions,
     @Context() ctx: { res: ResponseType },
     @Args('input') input: AuthSignInInput
   ): Promise<Auth> {
     const result = await this.authService.signIn(input, {
-      fieldSelection: { info, select: 'signIn' },
+      ...serviceOptions,
       inputType: AuthSignInInput,
     });
     return this.processCookies(ctx, result);
@@ -46,13 +47,11 @@ export class AuthResolver extends CoreAuthResolver {
     description: 'Sign up user and get JWT token',
   })
   override async signUp(
-    @Info() info: GraphQLResolveInfo,
+    @GraphQLServiceOptions({ gqlPath: 'signUp.user' }) serviceOptions: ServiceOptions,
     @Context() ctx: { res: ResponseType },
     @Args('input') input: AuthSignUpInput
   ): Promise<Auth> {
-    const result = await this.authService.signUp(input, {
-      fieldSelection: { info, select: 'signUp' },
-    });
+    const result = await this.authService.signUp(input, serviceOptions);
     return this.processCookies(ctx, result);
   }
 }

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

@@ -2,7 +2,7 @@ import { Post, UploadedFile, UseInterceptors } from '@nestjs/common';
 import { Controller } from '@nestjs/common/decorators/core/controller.decorator';
 import { FileInterceptor } from '@nestjs/platform-express';
 import envConfig from '../../../config.env';
-import { RESTUser } from '../../../core/common/decorators/rest-user.decorator';
+import { CurrentUser } from '../../../core/common/decorators/current-user.decorator';
 import { Roles } from '../../../core/common/decorators/roles.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
 import { multerOptionsForImageUpload } from '../../../core/common/helpers/file.helper';
@@ -32,7 +32,7 @@ export class AvatarController {
       })
     )
   )
-  uploadFile(@UploadedFile() file: Express.Multer.File, @RESTUser() user: User): Promise<string> {
+  uploadFile(@UploadedFile() file: Express.Multer.File, @CurrentUser() user: User): Promise<string> {
     return this.usersService.setAvatar(file, user);
   }
 }

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

@@ -1,11 +1,11 @@
 import { Inject } from '@nestjs/common';
-import { Args, Info, Mutation, Query, Resolver, Subscription } from '@nestjs/graphql';
-import { GraphQLResolveInfo } from 'graphql';
+import { Args, Mutation, Query, Resolver, Subscription } from '@nestjs/graphql';
 import { PubSub } from 'graphql-subscriptions';
 import { FilterArgs } from '../../../core/common/args/filter.args';
-import { GraphQLUser } from '../../../core/common/decorators/graphql-user.decorator';
+import { GraphQLServiceOptions } from '../../../core/common/decorators/graphql-service-options.decorator';
 import { Roles } from '../../../core/common/decorators/roles.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
+import { ServiceOptions } from '../../../core/common/interfaces/service-options.interface';
 import { UserCreateInput } from './inputs/user-create.input';
 import { UserInput } from './inputs/user.input';
 import { FindAndCountUsersResult } from './outputs/find-and-count-users-result.output';
@@ -32,9 +32,9 @@ export class UserResolver {
    */
   @Roles(RoleEnum.ADMIN)
   @Query(() => [User], { description: 'Find users (via filter)' })
-  async findUsers(@Info() info: GraphQLResolveInfo, @Args() args?: FilterArgs) {
+  async findUsers(@GraphQLServiceOptions() serviceOptions: ServiceOptions, @Args() args?: FilterArgs) {
     return await this.userService.find(args, {
-      fieldSelection: { info, select: 'findUsers' },
+      ...serviceOptions,
       inputType: FilterArgs,
     });
   }
@@ -44,9 +44,12 @@ export class UserResolver {
    */
   @Roles(RoleEnum.ADMIN)
   @Query(() => FindAndCountUsersResult, { description: 'Find users (via filter)' })
-  async findAndCountUsers(@Info() info: GraphQLResolveInfo, @Args() args?: FilterArgs) {
+  async findAndCountUsers(
+    @GraphQLServiceOptions({ gqlPath: 'findAndCountUsers.items' }) serviceOptions: ServiceOptions,
+    @Args() args?: FilterArgs
+  ) {
     return await this.userService.findAndCount(args, {
-      fieldSelection: { info, select: 'findAndCountUsers' },
+      ...serviceOptions,
       inputType: FilterArgs,
     });
   }
@@ -56,10 +59,9 @@ export class UserResolver {
    */
   @Roles(RoleEnum.S_USER)
   @Query(() => User, { description: 'Get user with specified ID' })
-  async getUser(@Args('id') id: string, @Info() info: GraphQLResolveInfo, @GraphQLUser() user: User): Promise<User> {
+  async getUser(@GraphQLServiceOptions() serviceOptions: ServiceOptions, @Args('id') id: string): Promise<User> {
     return await this.userService.get(id, {
-      currentUser: user,
-      fieldSelection: { info, select: 'getUser' },
+      ...serviceOptions,
       roles: [RoleEnum.ADMIN, RoleEnum.S_CREATOR],
     });
   }
@@ -92,13 +94,11 @@ export class UserResolver {
   @Roles(RoleEnum.ADMIN)
   @Mutation(() => User, { description: 'Create a new user' })
   async createUser(
-    @Args('input') input: UserCreateInput,
-    @GraphQLUser() user: User,
-    @Info() info: GraphQLResolveInfo
+    @GraphQLServiceOptions() serviceOptions: ServiceOptions,
+    @Args('input') input: UserCreateInput
   ): Promise<User> {
     return await this.userService.create(input, {
-      currentUser: user,
-      fieldSelection: { info, select: 'createUser' },
+      ...serviceOptions,
       inputType: UserCreateInput,
     });
   }
@@ -108,10 +108,9 @@ export class UserResolver {
    */
   @Roles(RoleEnum.S_USER)
   @Mutation(() => User, { description: 'Delete existing user' })
-  async deleteUser(@Args('id') id: string, @Info() info: GraphQLResolveInfo, @GraphQLUser() user: User): Promise<User> {
+  async deleteUser(@GraphQLServiceOptions() serviceOptions: ServiceOptions, @Args('id') id: string): Promise<User> {
     return await this.userService.delete(id, {
-      currentUser: user,
-      fieldSelection: { info, select: 'deleteUser' },
+      ...serviceOptions,
       roles: [RoleEnum.ADMIN, RoleEnum.S_CREATOR],
     });
   }
@@ -131,15 +130,13 @@ export class UserResolver {
   @Roles(RoleEnum.S_USER)
   @Mutation(() => User, { description: 'Update existing user' })
   async updateUser(
+    @GraphQLServiceOptions() serviceOptions: ServiceOptions,
     @Args('input') input: UserInput,
-    @Args('id') id: string,
-    @GraphQLUser() user: User,
-    @Info() info: GraphQLResolveInfo
+    @Args('id') id: string
   ): Promise<User> {
     // Update user
     return await this.userService.update(id, input, {
-      currentUser: user,
-      fieldSelection: { info, select: 'updateUser' },
+      ...serviceOptions,
       inputType: UserInput,
       roles: [RoleEnum.ADMIN, RoleEnum.S_CREATOR],
     });