types: add overwriteMiddlewareResult and skipMiddlewareFunction to types

Fix #14289

Author: vkarpov15

test/types/base.test.ts

@@ -8,6 +8,15 @@ Object.values(mongoose.models).forEach(model => {
 
 mongoose.pluralize(null);
 
+mongoose.overwriteMiddlewareResult('foo');
+const schema = new mongoose.Schema({ name: String });
+schema.pre('save', function() {
+  return mongoose.skipMiddlewareFunction('foobar');
+});
+schema.post('save', function() {
+  return mongoose.overwriteMiddlewareResult('foobar');
+});
+
 function gh10746() {
   type A = string extends Function ? never : string;
 

types/index.d.ts

@@ -677,5 +677,11 @@ declare module 'mongoose' {
   /* for ts-mongoose */
   export class mquery { }
 
+  export class OverwriteMiddlewareResult {}
+  export function overwriteMiddlewareResult(val: any): OverwriteMiddlewareResult;
+
+  export class SkipWrappedFunction {}
+  export function skipMiddlewareFunction(val: any): SkipWrappedFunction;
+
   export default mongoose;
 }

types/middlewares.d.ts

@@ -37,13 +37,13 @@ declare module 'mongoose' {
     this: ThisType,
     next: CallbackWithoutResultAndOptionalError,
     opts?: Record<string, any>
-  ) => void | Promise<void>;
+  ) => void | Promise<void> | SkipWrappedFunction;
   type PreSaveMiddlewareFunction<ThisType = any> = (
     this: ThisType,
     next: CallbackWithoutResultAndOptionalError,
     opts: SaveOptions
-  ) => void | Promise<void>;
-  type PostMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, res: ResType, next: CallbackWithoutResultAndOptionalError) => void | Promise<void>;
+  ) => void | Promise<void> | SkipWrappedFunction;
+  type PostMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, res: ResType, next: CallbackWithoutResultAndOptionalError) => void | Promise<void> | OverwriteMiddlewareResult;
   type ErrorHandlingMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, err: NativeError, res: ResType, next: CallbackWithoutResultAndOptionalError) => void;
-  type ErrorHandlingMiddlewareWithOption<ThisType = any, ResType = any> = (this: ThisType, err: NativeError, res: ResType | null, next: CallbackWithoutResultAndOptionalError) => void | Promise<void>;
+  type ErrorHandlingMiddlewareWithOption<ThisType = any, ResType = any> = (this: ThisType, err: NativeError, res: ResType | null, next: CallbackWithoutResultAndOptionalError) => void | Promise<void> | OverwriteMiddlewareResult;
 }