@lenne.tech/nest-server 3.0.0 → 3.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "3.0.0",
+  "version": "3.1.3",
   "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",
@@ -62,11 +62,13 @@
     "@nestjs/passport": "8.1.0",
     "@nestjs/platform-express": "8.2.6",
     "@nestjs/testing": "8.2.6",
+    "@shelf/jest-mongodb": "2.2.0",
     "@types/ejs": "3.1.0",
     "@types/jest": "27.4.0",
     "@types/lodash": "4.14.178",
     "@types/multer": "1.4.7",
     "@types/node": "16.11.21",
+    "@types/node-mailjet": "3.3.8",
     "@types/nodemailer": "6.4.4",
     "@types/passport": "1.0.7",
     "@types/supertest": "2.0.11",
@@ -92,8 +94,10 @@
     "json-to-graphql-query": "2.2.0",
     "light-my-request": "4.7.0",
     "lodash": "4.17.21",
+    "mongodb": "4.3.0",
     "mongoose": "6.1.7",
     "multer": "1.4.4",
+    "node-mailjet": "3.3.5",
     "nodemailer": "6.7.2",
     "nodemon": "2.0.15",
     "passport": "0.5.2",

package/src/config.env.ts

@@ -19,10 +19,16 @@ const config: { [env: string]: IServerOptions } = {
         port: 587,
         secure: false,
       },
+      mailjet: {
+        api_key_public: 'MAILJET_API_KEY_PUBLIC',
+        api_key_private: 'MAILJET_API_KEY_PRIVATE',
+      },
       defaultSender: {
         email: 'rebeca68@ethereal.email',
         name: 'Rebeca Sixtyeight',
       },
+      verificationLink: 'http://localhost:4200/user/verification',
+      passwordResetLink: 'http://localhost:4200/user/password-reset',
     },
     env: 'development',
     graphQl: {
@@ -60,10 +66,16 @@ const config: { [env: string]: IServerOptions } = {
         port: 587,
         secure: false,
       },
+      mailjet: {
+        api_key_public: 'MAILJET_API_KEY_PUBLIC',
+        api_key_private: 'MAILJET_API_KEY_PRIVATE',
+      },
       defaultSender: {
         email: 'rebeca68@ethereal.email',
         name: 'Rebeca Sixtyeight',
       },
+      verificationLink: 'http://localhost:4200/user/verification',
+      passwordResetLink: 'http://localhost:4200/user/password-reset',
     },
     env: 'productive',
     graphQl: {
@@ -93,7 +105,8 @@ const config: { [env: string]: IServerOptions } = {
  *
  * default: development
  */
-const envConfig = config[process.env.NODE_ENV || 'development'] || config.development;
+const envConfig = config[process.env['NODE' + '_ENV'] || 'development'] || config.development;
+console.log('Server starts in mode: ', process.env['NODE' + '_ENV'] || 'development');
 
 /**
  * Export envConfig as default

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

@@ -65,11 +65,11 @@ export class ServiceHelper {
   /**
    * Prepare output before return
    */
-  static async prepareOutput(
+  static async prepareOutput<T = Record<string, any>>(
     output: any,
     userModel: new () => any,
     userService: any,
-    options: { [key: string]: any; clone?: boolean } = {},
+    options: { [key: string]: any; clone?: boolean; targetModel?: Partial<T> } = {},
     ...args: any[]
   ) {
     // Configuration
@@ -83,9 +83,20 @@ export class ServiceHelper {
       output = JSON.parse(JSON.stringify(output));
     }
 
+    // Map output if target model exist
+    if (options.targetModel) {
+      (options.targetModel as any).map(output);
+    }
+
     // Remove password if exists
     delete output.password;
 
+    // Remove verification token if exists
+    delete output.verificationToken;
+
+    // Remove password reset token if exists
+    delete output.passwordResetToken;
+
     // Return prepared user
     return output;
   }

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

@@ -0,0 +1,4 @@
+export interface MailjetOptions {
+  api_key_public: string;
+  api_key_private: string;
+}

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

@@ -3,6 +3,7 @@ import { JwtModuleOptions } from '@nestjs/jwt';
 import { ServeStaticOptions } from '@nestjs/platform-express/interfaces/serve-static-options.interface';
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport';
 import { MongooseModuleOptions } from '@nestjs/mongoose/dist/interfaces/mongoose-options.interface';
+import { MailjetOptions } from './mailjet-options.interface';
 
 /**
  * Options for the server
@@ -101,6 +102,17 @@ export interface IServerOptions {
      */
     smtp?: SMTPTransport | SMTPTransport.Options | string;
 
+    mailjet?: MailjetOptions;
+    /**
+     * Verification link for email
+     */
+    verificationLink?: string;
+
+    /**
+     * Password reset link for email
+     */
+    passwordResetLink?: string;
+
     /**
      * Data for default sender
      */

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

@@ -0,0 +1,84 @@
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from './config.service';
+import * as mailjet from 'node-mailjet';
+
+/**
+ * Mailjet service
+ */
+@Injectable()
+export class MailjetService {
+  /**
+   * Inject services
+   */
+  constructor(protected configService: ConfigService) {}
+
+  /**
+   * Send a mail
+   */
+  public async sendMail(
+    recipients: string | string[],
+    subject: string,
+    templateId: number,
+    config: {
+      senderEmail?: string;
+      senderName?: string;
+      attachments?: mailjet.Email.Attachment[];
+      templateData?: { [key: string]: any };
+      sandbox?: boolean;
+    }
+  ): Promise<mailjet.Email.PostResponse> {
+    // Process config
+    const { senderName, senderEmail, templateData, attachments, sandbox } = {
+      senderEmail: this.configService.get('email.defaultSender.email'),
+      senderName: this.configService.get('email.defaultSender.name'),
+      sandbox: false,
+      attachments: null,
+      templateData: null,
+      ...config,
+    };
+
+    // Parse recipients
+    let to;
+    if (Array.isArray(recipients)) {
+      to = [];
+      for (const recipient of recipients) {
+        to.push({ Email: recipient });
+      }
+    } else {
+      to = [{ Email: recipients }];
+    }
+
+    // Parse body for mailjet request
+    const body: mailjet.Email.SendParams = {
+      Messages: [
+        {
+          From: {
+            Email: senderEmail,
+            Name: senderName,
+          },
+          To: to,
+          TemplateID: templateId,
+          TemplateLanguage: true,
+          Variables: templateData,
+          Subject: subject,
+          Attachments: attachments,
+        },
+      ],
+      SandboxMode: sandbox,
+    };
+
+    let connection: mailjet.Email.Client;
+    try {
+      // Connect to mailjet
+      connection = await mailjet.connect(
+        this.configService.get('email.mailjet.api_key_public'),
+        this.configService.get('email.mailjet.api_key_private')
+      );
+    } catch (e) {
+      throw new Error('Cannot connect to mailjet.');
+    }
+
+    // Send mail with mailjet
+    return connection.post('send', { version: 'v3.1' }).request(body);
+  }
+}

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

@@ -59,6 +59,27 @@ export abstract class CoreUserModel extends CorePersistenceModel {
   @Prop()
   username: string = undefined;
 
+  /**
+   * Password reset token of the user
+   */
+  @IsOptional()
+  @Prop()
+  passwordResetToken: string = undefined;
+
+  /**
+   * Verification token of the user
+   */
+  @IsOptional()
+  @Prop()
+  verificationToken: string = undefined;
+
+  /**
+   * Verification of the user
+   */
+  @Field((type) => Boolean, { description: 'Verification state of the user', nullable: true })
+  @Prop({ type: Boolean })
+  verified = false;
+
   // ===================================================================================================================
   // Methods
   // ===================================================================================================================

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

@@ -15,6 +15,9 @@ import { CoreUserCreateInput } from './inputs/core-user-create.input';
 import { CoreUserInput } from './inputs/core-user.input';
 import { Model } from 'mongoose';
 import * as _ from 'lodash';
+import * as crypto from 'crypto';
+import envConfig from '../../../config.env';
+import { EmailService } from '../../common/services/email.service';
 
 // Subscription
 const pubSub = new PubSub();
@@ -27,7 +30,7 @@ export abstract class CoreUserService<
   TUserInput extends CoreUserInput,
   TUserCreateInput extends CoreUserCreateInput
 > extends CoreBasicUserService<TUser, TUserInput, TUserCreateInput> {
-  protected constructor(protected readonly userModel: Model<any>) {
+  protected constructor(protected readonly userModel: Model<any>, protected emailService: EmailService) {
     super(userModel);
   }
 
@@ -42,8 +45,11 @@ export abstract class CoreUserService<
     // Prepare input
     await this.prepareInput(input, currentUser, { create: true });
 
+    // Generate verification token
+    const newUser = { ...input, ...{ verificationToken: crypto.randomBytes(32).toString('hex') } };
+
     // Create new user
-    const createdUser = new this.userModel(this.model.map(input));
+    const createdUser = new this.userModel(this.model.map(newUser));
 
     try {
       // Save created user
@@ -115,6 +121,75 @@ export abstract class CoreUserService<
     );
   }
 
+  /**
+   * Verify user with token
+   *
+   * @param token
+   */
+  async verify(token: string): Promise<boolean> {
+    const user = await this.userModel.findOne({ verificationToken: token }).exec();
+
+    if (!user) {
+      throw new NotFoundException();
+    }
+
+    if (!user.verificationToken) {
+      throw new Error('User has no token');
+    }
+
+    if (user.verified) {
+      throw new Error('User already verified');
+    }
+
+    await this.userModel.findByIdAndUpdate(user.id, { $set: { verified: true, verificationToken: null } }).exec();
+
+    return true;
+  }
+
+  /**
+   * Set newpassword for user with token
+   *
+   * @param token
+   * @param newPassword
+   */
+  async resetPassword(token: string, newPassword: string): Promise<boolean> {
+    const user = await this.userModel.findOne({ passwordResetToken: token }).exec();
+
+    if (!user) {
+      throw new NotFoundException();
+    }
+
+    const cryptedPassword = await bcrypt.hash(newPassword, 10);
+    await this.userModel
+      .findByIdAndUpdate(user.id, { $set: { password: cryptedPassword, passwordResetToken: null } })
+      .exec();
+
+    return true;
+  }
+
+  /**
+   * Request email with password reset link
+   *
+   * @param email
+   */
+  async requestPasswordResetMail(email: string): Promise<boolean> {
+    const user = await this.userModel.findOne({ email }).exec();
+
+    if (!user) {
+      throw new NotFoundException();
+    }
+
+    const resetToken = crypto.randomBytes(32).toString('hex');
+    await this.userModel.findByIdAndUpdate(user.id, { $set: { passwordResetToken: resetToken } }).exec();
+
+    await this.emailService.sendMail(user.email, 'Password reset', {
+      htmlTemplate: 'password-reset',
+      templateData: { name: user.username, link: envConfig.email.passwordResetLink + '/' + resetToken },
+    });
+
+    return true;
+  }
+
   /**
    * Set roles for specified user
    */
@@ -230,6 +305,12 @@ export abstract class CoreUserService<
     // Remove password if exists
     delete (user as any).password;
 
+    // Remove verification token if exists
+    delete (user as any).verificationToken;
+
+    // Remove password reset token if exists
+    delete (user as any).passwordResetToken;
+
     // Return prepared user
     return user;
   }

package/src/core.module.ts

@@ -9,6 +9,7 @@ import { ConfigService } from './core/common/services/config.service';
 import { EmailService } from './core/common/services/email.service';
 import { TemplateService } from './core/common/services/template.service';
 import { MongooseModule } from '@nestjs/mongoose';
+import { MailjetService } from './core/common/services/mailjet.service';
 
 /**
  * Core module (dynamic)
@@ -91,6 +92,7 @@ export class CoreModule {
       // Core Services
       EmailService,
       TemplateService,
+      MailjetService,
     ];
 
     // Return dynamic module
@@ -101,7 +103,7 @@ export class CoreModule {
         GraphQLModule.forRoot(config.graphQl),
       ],
       providers,
-      exports: [ConfigService, EmailService, TemplateService],
+      exports: [ConfigService, EmailService, TemplateService, MailjetService],
     };
   }
 }

package/src/index.ts

@@ -41,6 +41,7 @@ export * from './core/common/scalars/json.scalar';
 export * from './core/common/services/config.service';
 export * from './core/common/services/email.service';
 export * from './core/common/services/template.service';
+export * from './core/common/services/mailjet.service';
 
 // =====================================================================================================================
 // Core - Modules - Auth

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

@@ -43,9 +43,33 @@ export class UserResolver {
     return await this.usersService.find(args, info);
   }
 
+  /**
+   * Request new password for user with email
+   */
+  @Query((returns) => Boolean, { description: 'Request new password for user with email' })
+  async requestPasswordResetMail(@Args('email') email: string) {
+    return await this.usersService.requestPasswordResetMail(email);
+  }
+
   // ===========================================================================
   // Mutations
   // ===========================================================================
+  /**
+   * Verify user with email
+   */
+  @Mutation((returns) => Boolean, { description: 'Verify user with email' })
+  async verifyUser(@Args('token') token: string) {
+    return await this.usersService.verify(token);
+  }
+
+  /**
+   * Set new password for user with token
+   */
+  @Mutation((returns) => Boolean, { description: 'Set new password for user with token' })
+  async resetPassword(@Args('token') token: string, @Args('password') password: string) {
+    return await this.usersService.resetPassword(token, password);
+  }
+
   /**
    * Create new user
    */

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

@@ -42,7 +42,7 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
     @InjectModel('User') protected readonly userModel: Model<User>,
     @Inject('PUB_SUB') protected readonly pubSub: PubSub
   ) {
-    super(userModel);
+    super(userModel, emailService);
     this.model = User;
   }
 
@@ -55,12 +55,14 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
    */
   async create(input: UserCreateInput, currentUser?: User, ...args: any[]): Promise<User> {
     const user = await super.create(input, currentUser);
-    const text = `Welcome ${user.firstName}, this is plain text from server.`;
+
+    await this.prepareOutput(user, args[0]);
+
     await this.pubSub.publish('userCreated', User.map(user));
+
     await this.emailService.sendMail(user.email, 'Welcome', {
       htmlTemplate: 'welcome',
-      templateData: user,
-      text,
+      templateData: { name: user.username, link: envConfig.email.verificationLink + '/' + user.verificationToken },
     });
 
     return user;

package/src/templates/password-reset.ejs

@@ -0,0 +1,3 @@
+<h1>Hello <%= name %>,</h1>
+<p>you requested a link for setting a new password. Here it is.</p><br />
+<a href="<%= link %>">Passwort zurücksetzten</a>

package/src/templates/welcome.ejs

@@ -1,2 +1,3 @@
-<h1>Welcome <%= firstName %></h1>
-<p>This is a EJS template from server.</p>
+<h1>Welcome <%= name %>,</h1>
+<p>please confirm your email address.</p>
+<a href="<%= link %>">E-Mail bestätigen</a>

package/src/test/test.helper.ts

@@ -113,7 +113,7 @@ export class TestHelper {
   /**
    * GraphQL request
    * @param graphql
-   * @param statusCode
+   * @param options
    */
   async graphQl(graphql: string | TestGraphQLConfig, options: TestGraphQLOptions = {}): Promise<any> {
     // Default options
@@ -148,7 +148,7 @@ export class TestHelper {
       graphql = Object.assign(
         {
           arguments: null,
-          fields: ['id'],
+          fields: [],
           name: null,
           type: TestGraphQLType.QUERY,
         },