-
-
Notifications
You must be signed in to change notification settings - Fork 138
/
hooks.ts
194 lines (179 loc) · 8.67 KB
/
hooks.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
import type {
Aggregate,
AggregateExtract,
CallbackError,
Document,
MongooseQueryOrDocumentMiddleware,
ErrorHandlingMiddlewareFunction,
HydratedDocument,
Model,
MongooseDocumentMiddleware,
MongooseQueryMiddleware,
PostMiddlewareFunction,
PreMiddlewareFunction,
PreSaveMiddlewareFunction,
Query,
SchemaPostOptions,
SchemaPreOptions,
} from 'mongoose';
import { DecoratorKeys } from './internal/constants';
import { ExpectedTypeError } from './internal/errors';
import { assertion, getName } from './internal/utils';
import { logger } from './logSettings';
import type { AnyParamConstructor, DocumentType, HookOptionsEither, IHooksArray, ReturnModelType } from './types';
/** Type copied from mongoose, because it is not exported but used in hooks */
type QueryResultType<T> = T extends Query<infer ResultType, any> ? ResultType : never;
// Type below is to replace a "@post<typeof Class>" to just be "@post<Class>" regardless of what is used
// see https://github.com/microsoft/TypeScript/issues/51647
// current workaround is to use "extends object" instead of something like "AnyParamConstructor" to just allow classes
// type TypeofClass<T extends { prototype: AnyParamConstructor<any> }> = T extends { prototype: infer S } ? S : never;
/**
* Definitions for "pre" and "post" function overloads
* basically a copy of https://github.com/Automattic/mongoose/blob/260261d3c2a3593b34f1e3358f4a8c000575f082/types/index.d.ts#L302-L346
* only modifications done are:
* - moved options from second argument to be the last argument
* - de-duplicate function that were duplicated because of options being the second argument
* - changing the generics in use to support the classes or overwriting whatever is used
* VERSION COPY OF 7.0.0
*/
interface Hooks {
// post hooks with errorhandling option
post<S extends object | Query<any, any>, T = S extends Query<any, any> ? S : Query<DocumentType<S>, DocumentType<S>>>(
method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp,
fn: ErrorHandlingMiddlewareFunction<T>,
options: SchemaPostOptions & { errorHandler: true }
): ClassDecorator;
post<S extends object | HydratedDocument<any, any>, T = S extends Document ? S : HydratedDocument<DocumentType<S>, any>>(
method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp,
fn: ErrorHandlingMiddlewareFunction<T>,
options: SchemaPostOptions & { errorHandler: true }
): ClassDecorator;
post<T extends Aggregate<any>>(
method: 'aggregate' | RegExp,
fn: ErrorHandlingMiddlewareFunction<T, Array<any>>,
options: SchemaPostOptions & { errorHandler: true }
): ClassDecorator;
post<S extends AnyParamConstructor<any> | Model<any>, T = S extends Model<any> ? S : ReturnModelType<S>>(
method: 'insertMany' | RegExp,
fn: ErrorHandlingMiddlewareFunction<T>,
options: SchemaPostOptions & { errorHandler: true }
): ClassDecorator;
// normal post hooks
post<S extends object | Query<any, any>, T = S extends Query<any, any> ? S : Query<DocumentType<S>, DocumentType<S>>>(
method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp,
fn: PostMiddlewareFunction<T, QueryResultType<T>>,
options?: SchemaPostOptions
): ClassDecorator;
post<S extends object | HydratedDocument<any, any>, T = S extends Document ? S : HydratedDocument<DocumentType<S>, any>>(
method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp,
fn: PostMiddlewareFunction<T, T>,
options?: SchemaPostOptions
): ClassDecorator;
post<T extends Aggregate<any>>(
method: 'aggregate' | RegExp,
fn: PostMiddlewareFunction<T, Array<AggregateExtract<T>>>,
options?: SchemaPostOptions
): ClassDecorator;
post<S extends AnyParamConstructor<any> | Model<any>, T = S extends Model<any> ? S : ReturnModelType<S>>(
method: 'insertMany' | RegExp,
fn: PostMiddlewareFunction<T, T>,
options?: SchemaPostOptions
): ClassDecorator;
// error handling post hooks
post<S extends object | Query<any, any>, T = S extends Query<any, any> ? S : Query<DocumentType<S>, DocumentType<S>>>(
method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp,
fn: ErrorHandlingMiddlewareFunction<T>,
options?: SchemaPostOptions
): ClassDecorator;
post<S extends object | HydratedDocument<any, any>, T = S extends Document ? S : HydratedDocument<DocumentType<S>, any>>(
method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp,
fn: ErrorHandlingMiddlewareFunction<T>,
options?: SchemaPostOptions
): ClassDecorator;
post<T extends Aggregate<any>>(
method: 'aggregate' | RegExp,
fn: ErrorHandlingMiddlewareFunction<T, Array<any>>,
options?: SchemaPostOptions
): ClassDecorator;
post<S extends AnyParamConstructor<any> | Model<any>, T = S extends Model<any> ? S : ReturnModelType<S>>(
method: 'insertMany' | RegExp,
fn: ErrorHandlingMiddlewareFunction<T>,
options?: SchemaPostOptions
): ClassDecorator;
// special pre hooks for each "document: true, query: false" and "document: false, query: true"
pre<S extends object | HydratedDocument<any, any>, T = S extends Document ? S : HydratedDocument<DocumentType<S>, any>>(
method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[],
fn: PreMiddlewareFunction<T>,
options: SchemaPreOptions & { document: true; query: false }
): ClassDecorator;
pre<S extends object | Query<any, any>, T = S extends Query<any, any> ? S : Query<DocumentType<S>, DocumentType<S>>>(
method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[],
fn: PreMiddlewareFunction<T>,
options: SchemaPreOptions & { document: false; query: true }
): ClassDecorator;
// normal pre hooks
pre<S extends object | HydratedDocument<any, any>, T = S extends Document ? S : HydratedDocument<DocumentType<S>, any>>(
method: 'save',
fn: PreSaveMiddlewareFunction<T>,
options?: SchemaPreOptions
): ClassDecorator;
pre<S extends object | Query<any, any>, T = S extends Query<any, any> ? S : Query<DocumentType<S>, DocumentType<S>>>(
method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp,
fn: PreMiddlewareFunction<T>,
options?: SchemaPreOptions
): ClassDecorator;
pre<S extends object | HydratedDocument<any, any>, T = S extends Document ? S : HydratedDocument<DocumentType<S>, any>>(
method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp,
fn: PreMiddlewareFunction<T>,
options?: SchemaPreOptions
): ClassDecorator;
pre<T extends Aggregate<any>>(method: 'aggregate' | RegExp, fn: PreMiddlewareFunction<T>, options?: SchemaPreOptions): ClassDecorator;
pre<S extends AnyParamConstructor<any> | Model<any>, T = S extends Model<any> ? S : ReturnModelType<S>>(
method: 'insertMany' | RegExp,
fn: (this: T, next: (err?: CallbackError) => void, docs: any | Array<any>) => void | Promise<void>,
options?: SchemaPreOptions
): ClassDecorator;
}
// TSDoc for the hooks can't be added without adding it to *every* overload
const hooks: Hooks = {
pre(...args) {
return (target: any) => addToHooks(target, 'pre', args);
},
post(...args) {
return (target: any) => addToHooks(target, 'post', args);
},
};
/**
* Add a hook to the hooks Array
* @param target Target Class
* @param hookType What type is it
* @param args All Arguments, that should be passed-through
*/
function addToHooks(target: any, hookType: 'pre' | 'post', args: any[]): void {
// Convert Method to array if only a string is provided
const methods: IHooksArray['methods'] = Array.isArray(args[0]) ? args[0] : [args[0]];
const func: (...args: any[]) => void = args[1];
const hookOptions: HookOptionsEither | undefined = args[2];
assertion(typeof func === 'function', () => new ExpectedTypeError('fn', 'function', func));
if (args.length > 3) {
logger.warn(`"addToHooks" parameter "args" has a length of over 3 (length: ${args.length})`);
}
logger.info('Adding hooks for "[%s]" to "%s" as type "%s"', methods.join(','), getName(target), hookType);
switch (hookType) {
case 'post':
const postHooks: IHooksArray[] = Array.from(Reflect.getMetadata(DecoratorKeys.HooksPost, target) ?? []);
postHooks.push({ func, methods, options: hookOptions });
Reflect.defineMetadata(DecoratorKeys.HooksPost, postHooks, target);
break;
case 'pre':
const preHooks: IHooksArray[] = Array.from(Reflect.getMetadata(DecoratorKeys.HooksPre, target) ?? []);
preHooks.push({ func, methods, options: hookOptions });
Reflect.defineMetadata(DecoratorKeys.HooksPre, preHooks, target);
break;
}
}
export const pre = hooks.pre;
export const post = hooks.post;
// Export it PascalCased
export const Pre = hooks.pre;
export const Post = hooks.post;