forked from heygrady/fetch-actions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.d.ts
296 lines (252 loc) · 8.83 KB
/
index.d.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
export const DEFAULT_FATAL_HANDLER: '@@fetch-actions/handleFatalActions/DEFAULT_HANDLER'
export const DEFAULT_REQUEST_CREATOR: '@@fetch-actions/handleRequestCreatorActions/DEFAULT_HANDLER'
export const DEFAULT_REQUEST_TRANSFORMER: '@@fetch-actions/handleRequestTransformerActions/DEFAULT_HANDLER'
export const DEFAULT_REQUEST_HANDLER: '@@fetch-actions/handleResponderActions/DEFAULT_HANDLER'
export const DEFAULT_RESPONSE_HANDLER: '@@fetch-actions/handleResponseActions/DEFAULT_HANDLER'
export const DEFAULT_TRANSFORMER: '@@fetch-actions/handleTransformerActions/DEFAULT_TRANSFORMER'
export type MaybePromise<T> = Promise<T> | T
export type NotAPromise = Exclude<any, Promise<any>>
export interface BaseAction<T extends string> {
type: T
}
export interface Action<T extends string, Payload> extends BaseAction<T> {
payload: Payload
error?: boolean
}
export interface ActionMeta<T extends string, Payload, Meta>
extends Action<T, Payload> {
meta: Meta
}
export type AnyAction = Action<string, any>
export type NarrowedAction<
Actions extends AnyAction,
ActionType extends string
> = {
[K in Actions['type']]: Actions extends ActionMeta<
K,
infer Payload,
infer Meta
>
? ActionMeta<K, Payload, Meta>
: Actions extends Action<K, infer Payload>
? Action<K, Payload>
: never
}[ActionType]
export type ResponseWithJson = Pick<Response, 'json'>
export type LooseResponse =
| ResponseWithJson
| string
| number
| boolean
| object
| ReadonlyArray<string | number | boolean | object>
export interface FatalHandler<ActionTypes extends AnyAction> {
(error: any, action: ActionTypes): any
}
export interface FetchAction<ActionTypes extends AnyAction> {
(action: ActionTypes): Promise<any>
}
export interface Finally<ActionTypes extends AnyAction> {
(action: ActionTypes, errored: boolean): MaybePromise<void>
}
export interface CreateFetchActionConfig<ActionTypes extends AnyAction> {
fetch?: typeof fetch
finally?: Finally<ActionTypes>
requestCreator?: RequestCreator<ActionTypes>
requestTransformer?: RequestTransformer<ActionTypes>
responder?: Responder<ActionTypes>
responseHandler?: ResponseHandler<ActionTypes>
transformer?: ResponseTransformer<ActionTypes>
fatalHandler?: FatalHandler<ActionTypes>
}
export interface Handler<State, ActionTypes extends AnyAction, Result = State> {
(state: State, action: ActionTypes): Result
}
export type RequestTransformer<ActionTypes extends AnyAction> = Handler<
Request,
ActionTypes,
MaybePromise<Request>
>
export type ResponseHandler<ActionTypes extends AnyAction> = Handler<
ResponseWithJson,
ActionTypes,
MaybePromise<ResponseWithJson | undefined>
>
export type ResponseTransformer<ActionTypes extends AnyAction> = Handler<
any,
ActionTypes
>
export type FatalHandlerMap<ActionTypes extends AnyAction> = Partial<
{
readonly [K in ActionTypes['type']]: FatalHandler<
NarrowedAction<ActionTypes, K>
>
} & { readonly [DEFAULT_FATAL_HANDLER]: FatalHandler<ActionTypes> }
>
export interface HandleFatalActions {
<ActionTypes extends AnyAction>(
fatalHandlerMap: FatalHandlerMap<ActionTypes>
): FatalHandler<ActionTypes>
}
export interface CreateFetchAction {
<ActionTypes extends AnyAction>(
config: CreateFetchActionConfig<ActionTypes>
): FetchAction<ActionTypes>
}
export type LooseRequest =
| Request
| ConstructorParameters<typeof Request>
| ConstructorParameters<typeof Request>[0]
| undefined
export interface RequestCreator<ActionTypes extends AnyAction> {
(action: ActionTypes): MaybePromise<Request | undefined>
}
export interface LooseRequestCreator<ActionTypes extends AnyAction> {
(action: ActionTypes): MaybePromise<LooseRequest>
}
export interface Responder<ActionTypes extends AnyAction> {
(request: Request, action: ActionTypes): MaybePromise<
ResponseWithJson | undefined
>
}
export interface IdentityResponder<ActionTypes extends AnyAction> {
(request: Request, action: ActionTypes): undefined
}
export interface LooseResponder<ActionTypes extends AnyAction> {
(request: Request, action: ActionTypes): MaybePromise<LooseResponse>
}
export interface IdentityHandler<ActionTypes extends AnyAction> {
<Payload>(payload: Payload, action: ActionTypes): Payload
}
export type ResponderMap<ActionTypes extends AnyAction> = Partial<
{
readonly [K in ActionTypes['type']]: LooseResponder<
NarrowedAction<ActionTypes, K>
>
} & { readonly [DEFAULT_REQUEST_HANDLER]: LooseResponder<ActionTypes> }
>
export interface HandleResponderActions {
<ActionTypes extends AnyAction>(
responderMap: ResponderMap<ActionTypes>
): Responder<ActionTypes>
}
export type ResponseHandlerMap<ActionTypes extends AnyAction> = Partial<
{
readonly [K in ActionTypes['type']]: ResponseHandler<
NarrowedAction<ActionTypes, K>
>
} & { readonly [DEFAULT_RESPONSE_HANDLER]: ResponseHandler<ActionTypes> }
>
export interface HandleResponseActions {
<ActionTypes extends AnyAction>(
responseHandlerMap: ResponseHandlerMap<ActionTypes>
): ResponseHandler<ActionTypes>
}
export type RequestCreatorMap<ActionTypes extends AnyAction> = Partial<
{
readonly [K in ActionTypes['type']]: LooseRequestCreator<
NarrowedAction<ActionTypes, K>
>
} & { readonly [DEFAULT_REQUEST_CREATOR]: LooseRequestCreator<ActionTypes> }
>
export interface HandleRequestCreatorActions {
<ActionTypes extends AnyAction>(
requestCreatorMap: RequestCreatorMap<ActionTypes>
): RequestCreator<ActionTypes>
}
export type RequestTransformerMap<ActionTypes extends AnyAction> = Partial<
{
readonly [K in ActionTypes['type']]: RequestTransformer<
NarrowedAction<ActionTypes, K>
>
} & {
readonly [DEFAULT_REQUEST_TRANSFORMER]: RequestTransformer<ActionTypes>
}
>
export interface HandleRequestTransformerActions {
<ActionTypes extends AnyAction>(
requestTransformerMap: RequestTransformerMap<ActionTypes>
): RequestTransformer<ActionTypes>
}
export type TransformerMap<ActionTypes extends AnyAction> = Partial<
{
readonly [K in ActionTypes['type']]: ResponseTransformer<
NarrowedAction<ActionTypes, K>
>
} & { readonly [DEFAULT_TRANSFORMER]: ResponseTransformer<ActionTypes> }
>
export interface HandleTransformerActions {
<ActionTypes extends AnyAction>(
transformerMap: TransformerMap<ActionTypes>
): ResponseTransformer<ActionTypes>
}
export interface ReduceConfigs {
<ActionTypes extends AnyAction>(
fetch: CreateFetchActionConfig<ActionTypes>['fetch'],
...configs: ReadonlyArray<
Omit<CreateFetchActionConfig<ActionTypes>, 'fetch'>
>
): CreateFetchActionConfig<ActionTypes>
}
export interface ReduceFinallies {
<ActionTypes extends AnyAction>(
...finallies: ReadonlyArray<Finally<ActionTypes>>
): Finally<ActionTypes>
}
export interface ReduceHandlers {
<State, ActionTypes extends AnyAction, Result>(
...handlers: ReadonlyArray<Handler<State, ActionTypes, Result>>
): Handler<State, ActionTypes, Result>
}
export interface SomeFatalHandlers {
<ActionTypes extends AnyAction>(
...handlers: ReadonlyArray<FatalHandler<ActionTypes>>
): FatalHandler<ActionTypes>
}
export interface SomeRequestCreators {
<ActionTypes extends AnyAction>(
...handlers: ReadonlyArray<RequestCreator<ActionTypes>>
): RequestCreator<ActionTypes>
}
export interface SomeResponders {
<ActionTypes extends AnyAction>(
...handlers: ReadonlyArray<Responder<ActionTypes>>
): Responder<ActionTypes>
}
export interface MakeJson {
<T>(json: Promise<T>): T
(json: any): any
}
export interface MakeRequest {
(request: MaybePromise<LooseRequest>): MaybePromise<Request>
}
export interface MakeRequestResponse {
(response: MaybePromise<LooseResponse>): MaybePromise<ResponseWithJson>
}
export interface MakeResponse {
<T extends MaybePromise<any>>(response: T): T extends MaybePromise<
ResponseWithJson
>
? T
: undefined
}
export const createFetchAction: CreateFetchAction
export const handleFatalActions: HandleFatalActions
export const handleRequestCreatorActions: HandleRequestCreatorActions
export const handleRequestTransformerActions: HandleRequestTransformerActions
export const handleResponderActions: HandleResponderActions
export const handleResponseActions: HandleResponseActions
export const handleTransformerActions: HandleTransformerActions
export const identityRequestCreator: RequestCreator<AnyAction>
export const identityResponder: IdentityResponder<AnyAction>
export const identityHandler: IdentityHandler<AnyAction>
export const makeJson: MakeJson
export const makeRequest: MakeRequest
export const makeRequestResponse: MakeRequestResponse
export const makeResponse: MakeResponse
export const reduceConfigs: ReduceConfigs
export const reduceFinallies: ReduceFinallies
export const reduceHandlers: ReduceHandlers
export const someFatalHandlers: SomeFatalHandlers
export const someRequestCreators: SomeRequestCreators
export const someResponders: SomeResponders