@lenne.tech/nest-server 8.5.0 → 8.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",
@@ -112,7 +112,7 @@
     "prettier": "2.6.2",
     "pretty-quick": "3.1.3",
     "supertest": "6.2.3",
-    "ts-jest": "28.0.1",
+    "ts-jest": "28.0.2",
     "ts-morph": "14.0.0",
     "ts-node": "10.7.0",
     "tsconfig-paths": "4.0.0",

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

@@ -275,19 +275,41 @@ export function getElementsViaIds<T = any>(
 /**
  * Get populate options from GraphQL resolve info
  */
-export function getPopulateOptions(info: GraphQLResolveInfo, select?: string): PopulateOptions[] {
+export function getPopulateOptions(info: GraphQLResolveInfo, dotSeparatedSelect?: string): PopulateOptions[] {
   const result = [];
 
   if (!info?.fieldNodes?.length) {
     return result;
   }
 
-  for (const fieldNode of info.fieldNodes) {
-    if ((select || fieldNode?.name?.value === select) && fieldNode?.selectionSet?.selections?.length) {
-      return getPopulatOptionsFromSelections(fieldNode.selectionSet.selections);
+  if (dotSeparatedSelect?.length) {
+    for (const fieldNode of info.fieldNodes) {
+      const selects = dotSeparatedSelect.split('.');
+      const fieldNodeName = selects.shift();
+      if (fieldNode?.name?.value === fieldNodeName && fieldNode?.selectionSet?.selections?.length) {
+        if (!selects.length) {
+          return getPopulatOptionsFromSelections(fieldNode.selectionSet.selections);
+        } else {
+          let selections = fieldNode.selectionSet.selections;
+          do {
+            if (!selections?.length) {
+              break;
+            }
+            const select = selects.shift();
+            for (const selection of selections) {
+              if ((selection as FieldNode)?.name?.value === select) {
+                selections = (selection as FieldNode)?.selectionSet?.selections;
+                if (!selects.length) {
+                  return getPopulatOptionsFromSelections(selections);
+                }
+                break;
+              }
+            }
+          } while (selects.length);
+        }
+      }
     }
   }
-
   return result;
 }
 

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

@@ -3,6 +3,10 @@ import * as bcrypt from 'bcrypt';
 import { plainToInstance } from 'class-transformer';
 import * as _ from 'lodash';
 import { RoleEnum } from '../enums/role.enum';
+import { PrepareInputOptions } from '../interfaces/prepare-input-options.interface';
+import { PrepareOutputOptions } from '../interfaces/prepare-output-options.interface';
+import { ResolveSelector } from '../interfaces/resolve-selector.interface';
+import { ServiceOptions } from '../interfaces/service-options.interface';
 
 /**
  * Helper class for services
@@ -213,3 +217,54 @@ export async function prepareOutput<T = { [key: string]: any; map: (...args: any
   // Return prepared output
   return output;
 }
+
+/**
+ * Prepare service options
+ */
+export function prepareServiceOptions(
+  serviceOptions: ServiceOptions,
+  options?: {
+    clone?: boolean;
+    inputType?: any;
+    outputType?: any;
+    subFieldSelection?: string;
+    prepareInput?: PrepareInputOptions;
+    prepareOutput?: PrepareOutputOptions;
+  }
+): ServiceOptions {
+  // Set default values
+  const config = {
+    clone: true,
+    ...options,
+  };
+
+  // Clone
+  if (serviceOptions && config.clone) {
+    serviceOptions = _.cloneDeep(serviceOptions);
+  }
+
+  // Init if not exists
+  serviceOptions = serviceOptions || {};
+
+  // Set properties
+  serviceOptions.inputType = serviceOptions.inputType || options?.inputType;
+  serviceOptions.outputType = serviceOptions.outputType || options?.outputType;
+
+  // Set properties which can deactivate handling when falsy
+  if (!serviceOptions.prepareInput && 'prepareInput' in config) {
+    serviceOptions.prepareInput = config.prepareInput;
+  }
+  if (!serviceOptions.prepareOutput && 'prepareOutput' in config) {
+    serviceOptions.prepareOutput = config.prepareOutput;
+  }
+
+  // Set subfield selection
+  if (config.subFieldSelection) {
+    if ((serviceOptions.fieldSelection as ResolveSelector)?.select) {
+      (serviceOptions.fieldSelection as ResolveSelector).select += '.' + config.subFieldSelection;
+    }
+  }
+
+  // Return (cloned and) prepared service options
+  return serviceOptions;
+}

package/src/core/common/interfaces/prepare-input-options.interface.ts

@@ -0,0 +1,11 @@
+/**
+ * Interface for prepare input options
+ */
+export interface PrepareInputOptions {
+  [key: string]: any;
+  create?: boolean;
+  clone?: boolean;
+  getNewArray?: boolean;
+  removeUndefined?: boolean;
+  targetModel?: new (...args: any[]) => any;
+}

package/src/core/common/interfaces/prepare-output-options.interface.ts

@@ -0,0 +1,10 @@
+/**
+ * Interface for prepare output options
+ */
+export interface PrepareOutputOptions {
+  [key: string]: any;
+  clone?: boolean;
+  getNewArray?: boolean;
+  removeUndefined?: boolean;
+  targetModel?: new (...args: any[]) => any;
+}

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

@@ -1,5 +1,7 @@
 import { Model } from 'mongoose';
 import { FieldSelection } from '../types/field-selection.type';
+import { PrepareInputOptions } from './prepare-input-options.interface';
+import { PrepareOutputOptions } from './prepare-output-options.interface';
 
 /**
  * General service options
@@ -40,24 +42,12 @@ export interface ServiceOptions {
   // Prepare input configuration:
   // If {} or not set, then the prepareInput function will run with defaults
   // If falsy, then the prepareInput function is not executed
-  prepareInput?: {
-    [key: string]: any;
-    create?: boolean;
-    clone?: boolean;
-    getNewArray?: boolean;
-    removeUndefined?: boolean;
-  };
+  prepareInput?: PrepareInputOptions;
 
   // Prepare output configuration:
   // If {} or not set, then the prepareInput function will run with defaults
   // If falsy, then the prepareInput function is not executed
-  prepareOutput?: {
-    [key: string]: any;
-    clone?: boolean;
-    getNewArray?: boolean;
-    removeUndefined?: boolean;
-    targetModel?: new (...args: any[]) => any;
-  };
+  prepareOutput?: PrepareOutputOptions;
 
   // Whether to publish action via GraphQL subscription
   pubSub?: boolean;

package/src/core/modules/auth/inputs/core-auth-sign-in.input.ts

@@ -0,0 +1,18 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { CoreInput } from '../../../common/inputs/core-input.input';
+
+/**
+ * SignIn input
+ */
+@InputType({ description: 'Sign-in input' })
+export class CoreAuthSignInInput extends CoreInput {
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  @Field({ description: 'Email', nullable: false })
+  email: string = undefined;
+
+  @Field({ description: 'Password', nullable: false })
+  password: string = undefined;
+}

package/src/core/modules/auth/inputs/core-auth-sign-up.input.ts

@@ -0,0 +1,18 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { CoreInput } from '../../../common/inputs/core-input.input';
+
+/**
+ * SignUp input
+ */
+@InputType({ description: 'Sign-up input' })
+export class CoreAuthSignUpInput extends CoreInput {
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  @Field({ description: 'Email', nullable: false })
+  email: string = undefined;
+
+  @Field({ description: 'Password', nullable: false })
+  password: string = undefined;
+}

package/src/index.ts

@@ -35,6 +35,8 @@ export * from './core/common/inputs/sort.input';
 export * from './core/common/interceptors/check-response.interceptor';
 export * from './core/common/interfaces/core-persistence-model.interface';
 export * from './core/common/interfaces/mailjet-options.interface';
+export * from './core/common/interfaces/prepare-input-options.interface';
+export * from './core/common/interfaces/prepare-output-options.interface';
 export * from './core/common/interfaces/resolve-selector.interface';
 export * from './core/common/interfaces/server-options.interface';
 export * from './core/common/interfaces/service-options.interface';

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

@@ -3,22 +3,22 @@ import { CoreAuthModel } from '../../../core/modules/auth/core-auth.model';
 import { User } from '../user/user.model';
 
 /**
- * CoreAuthModel model for the response after the sign in
+ * Authentication data
  */
-@ObjectType({ description: 'Auth' })
+@ObjectType({ description: 'Authentication data' })
 export class Auth extends CoreAuthModel {
   // ===================================================================================================================
   // Properties
   // ===================================================================================================================
 
   /**
-   * Signed in user
+   * Signed-in user
    */
-  @Field((type) => User, { description: 'User who signed in' })
+  @Field(() => User, { description: 'User who signed in' })
   user: User = undefined;
 
   // ===================================================================================================================
-  // Properties
+  // Methods
   // ===================================================================================================================
 
   /**

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

@@ -1,9 +1,11 @@
 import { DynamicModule, Module } from '@nestjs/common';
 import { JwtModuleOptions } from '@nestjs/jwt';
+import { EmailService } from '../../../core/common/services/email.service';
 import { CoreAuthModule } from '../../../core/modules/auth/core-auth.module';
 import { UserModule } from '../user/user.module';
 import { UserService } from '../user/user.service';
 import { AuthResolver } from './auth.resolver';
+import { AuthService } from './auth.service';
 
 /**
  * CoreAuthModule to handle user authentication
@@ -17,8 +19,17 @@ export class AuthModule {
   static forRoot(options: JwtModuleOptions): DynamicModule {
     return {
       module: AuthModule,
-      imports: [CoreAuthModule.forRoot(UserModule, UserService, options)],
-      providers: [AuthResolver],
+      imports: [
+        CoreAuthModule.forRoot(UserModule, UserService, {
+          ...options,
+          ...{
+            // imports: [], // Integrate additional Services here to resolve dependencies
+            // providers: [] // Integrate additional Providers here to resolve dependencies
+          },
+        }),
+        EmailService,
+      ],
+      providers: [AuthResolver, AuthService],
       exports: [AuthResolver, CoreAuthModule],
     };
   }

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

@@ -1,22 +1,40 @@
-import { Args, Info, Query, Resolver } from '@nestjs/graphql';
+import { Args, Info, Mutation, Query, Resolver } from '@nestjs/graphql';
 import { GraphQLResolveInfo } from 'graphql';
-import { CoreAuthResolver } from '../../../core/modules/auth/core-auth.resolver';
 import { Auth } from './auth.model';
+import { AuthService } from './auth.service';
+import { AuthSignInInput } from './inputs/auth-sign-in.input';
+import { AuthSignUpInput } from './inputs/auth-sign-up.input';
 
 /**
  * Authentication resolver for the sign in
  */
-@Resolver((of) => Auth)
-export class AuthResolver extends CoreAuthResolver {
+@Resolver(() => Auth)
+export class AuthResolver {
   /**
-   * Get user via ID
+   * Integrate services
    */
-  @Query((returns) => Auth, { description: 'Get JWT token' })
-  async signIn(
-    @Args('email') email: string,
-    @Args('password') password: string,
-    @Info() info: GraphQLResolveInfo
-  ): Promise<Auth> {
-    return (await this.authService.signIn(email, password, { fieldSelection: { info, select: 'signIn' } })) as Auth;
+  constructor(private readonly authService: AuthService) {}
+
+  /**
+   * SignIn for User
+   */
+  @Query(() => Auth, { description: 'Sign in and get JWT token' })
+  async signIn(@Info() info: GraphQLResolveInfo, @Args('input') input: AuthSignInInput): Promise<Auth> {
+    return this.authService.signIn(input, {
+      fieldSelection: { info, select: 'signIn' },
+      inputType: AuthSignInInput,
+    });
+  }
+
+  /**
+   * Sign up for user
+   */
+  @Mutation(() => Auth, {
+    description: 'Sign up user and get JWT token',
+  })
+  async signUp(@Info() info: GraphQLResolveInfo, @Args('input') input: AuthSignUpInput): Promise<Auth> {
+    return this.authService.signUp(input, {
+      fieldSelection: { info, select: 'signUp' },
+    });
   }
 }

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

@@ -0,0 +1,84 @@
+import { Injectable, UnauthorizedException } from '@nestjs/common';
+import { JwtService } from '@nestjs/jwt';
+import * as bcrypt from 'bcrypt';
+import envConfig from '../../../config.env';
+import { prepareServiceOptions } from '../../../core/common/helpers/service.helper';
+import { ResolveSelector } from '../../../core/common/interfaces/resolve-selector.interface';
+import { ServiceOptions } from '../../../core/common/interfaces/service-options.interface';
+import { EmailService } from '../../../core/common/services/email.service';
+import { JwtPayload } from '../../../core/modules/auth/interfaces/jwt-payload.interface';
+import { UserService } from '../user/user.service';
+import { Auth } from './auth.model';
+import { AuthSignInInput } from './inputs/auth-sign-in.input';
+import { AuthSignUpInput } from './inputs/auth-sign-up.input';
+
+@Injectable()
+export class AuthService {
+  constructor(
+    protected readonly jwtService: JwtService,
+    protected readonly emailService: EmailService,
+    protected readonly userService: UserService
+  ) {}
+
+  /**
+   * Sign in for user
+   */
+  async signIn(input: AuthSignInInput, serviceOptions?: ServiceOptions): Promise<Auth> {
+    // Prepare service options
+    const serviceOptionsForUserService = prepareServiceOptions(serviceOptions, {
+      // We need password, so we can't use prepare output handling and have to deactivate it
+      prepareOutput: null,
+
+      // Select user field for automatic populate handling via user service
+      subFieldSelection: 'user',
+    });
+
+    // Get and check user
+    const user = await this.userService.getViaEmail(input.email, serviceOptionsForUserService);
+    if (!user) {
+      throw new UnauthorizedException();
+    }
+
+    // Check password
+    if (!(await bcrypt.compare(input.password, user.password))) {
+      throw new UnauthorizedException();
+    }
+
+    // Create JWT and return sign-in data
+    const payload: JwtPayload = { email: user.email };
+    return Auth.map({
+      token: this.jwtService.sign(payload),
+      user,
+    });
+  }
+
+  /**
+   * Register a new user Account
+   */
+  async signUp(input: AuthSignUpInput, serviceOptions?: ServiceOptions): Promise<Auth> {
+    // Prepare service options
+    const serviceOptionsForUserService = prepareServiceOptions(serviceOptions, {
+      // Select user field for automatic populate handling via user service
+      subFieldSelection: 'user',
+    });
+
+    // Get and check user
+    const user = await this.userService.create(input, serviceOptionsForUserService);
+    if (!user) {
+      throw Error('Email Address already in use');
+    }
+
+    // Send email
+    await this.emailService.sendMail(user.email, 'Welcome', {
+      htmlTemplate: 'welcome',
+      templateData: { name: user.username, link: envConfig.email.verificationLink + '/' + user.verificationToken },
+    });
+
+    // Create JWT and return sign-in data
+    const payload: JwtPayload = { email: user.email };
+    return Auth.map({
+      token: this.jwtService.sign(payload),
+      user: user,
+    });
+  }
+}

package/src/server/modules/auth/inputs/auth-sign-in.input.ts

@@ -0,0 +1,10 @@
+import { InputType } from '@nestjs/graphql';
+import { CoreAuthSignInInput } from '../../../../core/modules/auth/inputs/core-auth-sign-in.input';
+
+/**
+ * SignIn input
+ */
+@InputType({ description: 'Description for AuthSignInInput' })
+export class AuthSignInInput extends CoreAuthSignInInput {
+  // Extend UserInput here
+}

package/src/server/modules/auth/inputs/auth-sign-up.input.ts

@@ -0,0 +1,18 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { CoreAuthSignUpInput } from '../../../../core/modules/auth/inputs/core-auth-sign-up.input';
+
+/**
+ * SignUp input
+ */
+@InputType({ description: 'Description for AuthSignUpInput' })
+export class AuthSignUpInput extends CoreAuthSignUpInput {
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  @Field({ description: 'firstName', nullable: true })
+  firstName: string = undefined;
+
+  @Field({ description: 'lastName', nullable: true })
+  lastName: string = undefined;
+}

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

@@ -14,7 +14,7 @@ import { UserService } from './user.service';
 /**
  * Resolver to process with user data
  */
-@Resolver((of) => User)
+@Resolver(() => User)
 export class UserResolver {
   /**
    * Import services
@@ -29,7 +29,7 @@ export class UserResolver {
    * Get users (via filter)
    */
   @Roles(RoleEnum.ADMIN)
-  @Query((returns) => [User], { description: 'Find users (via filter)' })
+  @Query(() => [User], { description: 'Find users (via filter)' })
   async findUsers(@Info() info: GraphQLResolveInfo, @Args() args?: FilterArgs) {
     return await this.userService.find(args, {
       fieldSelection: { info, select: 'findUsers' },
@@ -41,7 +41,7 @@ export class UserResolver {
    * Get user via ID
    */
   @Roles(RoleEnum.S_USER)
-  @Query((returns) => User, { description: 'Get user with specified ID' })
+  @Query(() => User, { description: 'Get user with specified ID' })
   async getUser(@Args('id') id: string, @Info() info: GraphQLResolveInfo, @GraphQLUser() user: User): Promise<User> {
     return await this.userService.get(id, {
       currentUser: user,
@@ -53,7 +53,7 @@ export class UserResolver {
   /**
    * Get verified state of user with token
    */
-  @Query((returns) => Boolean, { description: 'Get verified state of user with token' })
+  @Query(() => Boolean, { description: 'Get verified state of user with token' })
   async getVerifiedState(@Args('token') token: string) {
     return await this.userService.getVerifiedState(token);
   }
@@ -61,7 +61,7 @@ export class UserResolver {
   /**
    * Request new password for user with email
    */
-  @Query((returns) => Boolean, { description: 'Request new password for user with email' })
+  @Query(() => Boolean, { description: 'Request new password for user with email' })
   async requestPasswordResetMail(@Args('email') email: string): Promise<boolean> {
     return !!(await this.userService.sendPasswordResetMail(email));
   }
@@ -73,7 +73,8 @@ export class UserResolver {
   /**
    * Create new user
    */
-  @Mutation((returns) => User, { description: 'Create a new user' })
+  @Roles(RoleEnum.ADMIN)
+  @Mutation(() => User, { description: 'Create a new user' })
   async createUser(
     @Args('input') input: UserCreateInput,
     @GraphQLUser() user: User,
@@ -90,7 +91,7 @@ export class UserResolver {
    * Delete existing user
    */
   @Roles(RoleEnum.S_USER)
-  @Mutation((returns) => User, { description: 'Delete existing user' })
+  @Mutation(() => User, { description: 'Delete existing user' })
   async deleteUser(@Args('id') id: string, @Info() info: GraphQLResolveInfo, @GraphQLUser() user: User): Promise<User> {
     return await this.userService.delete(id, {
       currentUser: user,
@@ -102,7 +103,7 @@ export class UserResolver {
   /**
    * Set new password for user with token
    */
-  @Mutation((returns) => Boolean, { description: 'Set new password for user with token' })
+  @Mutation(() => Boolean, { description: 'Set new password for user with token' })
   async resetPassword(@Args('token') token: string, @Args('password') password: string): Promise<boolean> {
     return !!(await this.userService.resetPassword(token, password));
   }
@@ -111,7 +112,7 @@ export class UserResolver {
    * Update existing user
    */
   @Roles(RoleEnum.S_USER)
-  @Mutation((returns) => User, { description: 'Update existing user' })
+  @Mutation(() => User, { description: 'Update existing user' })
   async updateUser(
     @Args('input') input: UserInput,
     @Args('id') id: string,
@@ -130,7 +131,7 @@ export class UserResolver {
   /**
    * Verify user with email
    */
-  @Mutation((returns) => Boolean, { description: 'Verify user with email' })
+  @Mutation(() => Boolean, { description: 'Verify user with email' })
   async verifyUser(@Args('token') token: string): Promise<boolean> {
     return !!(await this.userService.verify(token));
   }
@@ -142,7 +143,7 @@ export class UserResolver {
   /**
    * Subscription for created user
    */
-  @Subscription((returns) => User, {
+  @Subscription(() => User, {
     filter(this: UserResolver, payload, variables, context) {
       return context.user.roles.include(RoleEnum.ADMIN);
     },

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

@@ -58,20 +58,12 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
       await this.pubSub.publish('userCreated', User.map(user));
     }
 
-    // Send email
-    await this.emailService.sendMail(user.email, 'Welcome', {
-      htmlTemplate: 'welcome',
-      templateData: { name: user.username, link: envConfig.email.verificationLink + '/' + user.verificationToken },
-    });
-
     // Return created user
     return user;
   }
 
   /**
    * Request password reset mail
-   *
-   * @param email
    */
   async sendPasswordResetMail(email: string, serviceOptions?: ServiceOptions): Promise<User> {
     // Set password reset token