Improve ValidateOpts type

[Freezystem]

Summary

As the documention mentions it, the propsParameter property does not exists on the ValidateOpts<T> type and cause TypeScript to generate an error.

Examples

I have created a validator to check if the ObjectId references existing mongoDB collection document.

export const refExists: ValidateOpts<string> = {
  async validator(_id, props): Promise<boolean> {
    const self = this.constructor as Model<any>;
    const {ref} = self.schema.paths[props.path].options;
    const model = models[ref];
    
    return await model.exists({_id}).exec() !== null;
  },
  propsParameter: true,
};

This snippet generate two TypeScript errors:

error TS2322: Type '{ validator(_id: string, props: (result: boolean) => void): Promise; propsParameter: boolean; }' is not assignable to type 'ValidateOpts'.
Object literal may only specify known properties, and 'propsParameter' does not exist in type 'ValidateOpts'.

Here, the compiler is thinking we are using LegacyAsyncValidateFn<T> because it's the only one validator to have two parameters.

and

error TS2322: Type '{ validator(_id: any, opts: any): Promise; propsParameter: boolean; }' is not assignable to type 'ValidateOpts'.
Object literal may only specify known properties, and 'propsParameter' does not exist in type 'ValidateOpts'.

Here, the compiler is saying that propsParameter is not a valid property on that type.

[vkarpov15]

Thanks 👍