-
Notifications
You must be signed in to change notification settings - Fork 2k
/
index.ts
109 lines (104 loc) · 4.1 KB
/
index.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
import {
AnyFunctionMap,
BaseContext,
DefaultContext,
GraphQLServiceContext,
GraphQLRequestContext,
GraphQLRequest,
GraphQLResponse,
ValueOrPromise,
WithRequired,
GraphQLRequestContextDidResolveSource,
GraphQLRequestContextParsingDidStart,
GraphQLRequestContextValidationDidStart,
GraphQLRequestContextDidResolveOperation,
GraphQLRequestContextDidEncounterErrors,
GraphQLRequestContextResponseForOperation,
GraphQLRequestContextExecutionDidStart,
GraphQLRequestContextWillSendResponse,
} from 'apollo-server-types';
import { GraphQLFieldResolver } from "graphql";
// We re-export all of these so plugin authors only need to depend on a single
// package. The overall concept of `apollo-server-types` and this package
// is that they not depend directly on "core", in order to avoid close
// coupling of plugin support with server versions. They are duplicated
// concepts right now where one package is intended to be for public plugin
// exposure, while the other (`-types`) is meant to be used internally.
// In the future, `apollo-server-types` and `apollo-server-plugin-base` will
// probably roll into the same "types" package, but that is not today!
export {
BaseContext,
DefaultContext,
GraphQLServiceContext,
GraphQLRequestContext,
GraphQLRequest,
GraphQLResponse,
ValueOrPromise,
WithRequired,
GraphQLRequestContextDidResolveSource,
GraphQLRequestContextParsingDidStart,
GraphQLRequestContextValidationDidStart,
GraphQLRequestContextDidResolveOperation,
GraphQLRequestContextDidEncounterErrors,
GraphQLRequestContextResponseForOperation,
GraphQLRequestContextExecutionDidStart,
GraphQLRequestContextWillSendResponse,
};
export interface ApolloServerPlugin<
TContext extends BaseContext = DefaultContext
> {
serverWillStart?(service: GraphQLServiceContext): ValueOrPromise<void>;
requestDidStart?(
requestContext: GraphQLRequestContext<TContext>,
): GraphQLRequestListener<TContext> | void;
}
export type GraphQLRequestListenerParsingDidEnd = (err?: Error) => void;
export type GraphQLRequestListenerValidationDidEnd =
((err?: ReadonlyArray<Error>) => void);
export type GraphQLRequestListenerExecutionDidEnd = ((err?: Error) => void);
export type GraphQLRequestListenerDidResolveField =
((error: Error | null, result?: any) => void);
export interface GraphQLRequestListener<
TContext extends BaseContext = DefaultContext
> extends AnyFunctionMap {
didResolveSource?(
requestContext: GraphQLRequestContextDidResolveSource<TContext>,
): ValueOrPromise<void>;
parsingDidStart?(
requestContext: GraphQLRequestContextParsingDidStart<TContext>,
): GraphQLRequestListenerParsingDidEnd | void;
validationDidStart?(
requestContext: GraphQLRequestContextValidationDidStart<TContext>,
): GraphQLRequestListenerValidationDidEnd | void;
didResolveOperation?(
requestContext: GraphQLRequestContextDidResolveOperation<TContext>,
): ValueOrPromise<void>;
didEncounterErrors?(
requestContext: GraphQLRequestContextDidEncounterErrors<TContext>,
): ValueOrPromise<void>;
// If this hook is defined, it is invoked immediately before GraphQL execution
// would take place. If its return value resolves to a non-null
// GraphQLResponse, that result is used instead of executing the query.
// Hooks from different plugins are invoked in series and the first non-null
// response is used.
responseForOperation?(
requestContext: GraphQLRequestContextResponseForOperation<TContext>,
): ValueOrPromise<GraphQLResponse | null>;
executionDidStart?(
requestContext: GraphQLRequestContextExecutionDidStart<TContext>,
):
| GraphQLRequestExecutionListener
| GraphQLRequestListenerExecutionDidEnd
| void;
willSendResponse?(
requestContext: GraphQLRequestContextWillSendResponse<TContext>,
): ValueOrPromise<void>;
}
export interface GraphQLRequestExecutionListener<
TContext extends BaseContext = DefaultContext
> extends AnyFunctionMap {
executionDidEnd?: GraphQLRequestListenerExecutionDidEnd;
willResolveField?(
...fieldResolverArgs: Parameters<GraphQLFieldResolver<any, TContext>>
): GraphQLRequestListenerDidResolveField | void;
}