How to represent and call methods, hooks on mongoose ES6 Classes

I’m submitting a…

[ ] Regression 
[ ] Bug report
[ ] Feature request
[x] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

I have seen that in the latest nestjs mongoose release Cat Schema you have added the support for ES6 class, so that we can now write our mongoose schema definitions quite well in a class format. Thats awesome. But i had a quick question on the additional attributes that go along with the mongoose schema like methods, hooks. How do we represent them in our schema definitions and get that called in the services?

user.ts

import { Document } from 'mongoose';
import { SchemaFactory, Prop, Schema } from '@nestjs/mongoose';
import * as bcrypt from 'bcryptjs';

@Schema()
export class User extends Document {
    @Prop({ required: true })
    firstName: string;

    @Prop({ required: true })
    lastName: string;

    @Prop({ required: true })
    email: string;

    @Prop({ required: true, select: false })
    password: string;
    
    // For comparing passwords
    comparePassword(password: string) {
        return bcrypt.compareSync(password, this.password);
    }
}

export const UserSchema = SchemaFactory.createForClass(User);

Expected behavior

The expected behavior was that i could call the comparePassword function in my auth service like so:

auth.service.ts

   async validateUser(username: string, pass: string): Promise<any> {
        const user = await this.usersService.findOne(username);
        
        if (user && user.comparePassword(pass)) {
            const { password, ...result } = user;
            return result;
        }
        return null;
    }

But here i get an error from the typescript compiler that Property 'comparePassword' does not exist on type 'User'.ts

Any thoughts would be helpful.

Environment

Nest version: 7.0.0

 
For Tooling issues:
- Node version: v10.16.0
- Platform:  Mac

Others:

[j]

@sandeepsuvit @beaucafe

What happens if you do this:

import { Document } from 'mongoose';
import { SchemaFactory, Prop, Schema } from '@nestjs/mongoose';
import * as bcrypt from 'bcryptjs';

@Schema()
export class User extends Document {
    @Prop({ required: true })
    firstName: string;

    @Prop({ required: true })
    lastName: string;

    @Prop({ required: true })
    email: string;

    @Prop({ required: true, select: false })
    password: string;
    
    // For comparing passwords
    comparePassword(password: string) {
        return bcrypt.compareSync(password, this.password);
    }
}

export const UserSchema = SchemaFactory.createForClass(User);

// This part here (see https://mongoosejs.com/docs/guide.html#es6-classes)
UserSchema.loadClass(User);

[beaucafe]

import { Document } from 'mongoose';
import { SchemaFactory, Prop, Schema } from '@nestjs/mongoose';
import * as bcrypt from 'bcryptjs';

@Schema()
export class User extends Document {
    @Prop({ required: true })
    firstName: string;

    @Prop({ required: true })
    lastName: string;

    @Prop({ required: true })
    email: string;

    @Prop({ required: true, select: false })
    password: string;
    
    // Revise to Function
    comparePassword : Function
}

export const UserSchema = SchemaFactory.createForClass(User);

And create new methods under UserSchema.

UserSchema.methods.comparePassword = async function (password : string) {
  const isValid = await bcrypt.compare(password, this.password)
  return isValid
}

mongoos#es6-classes