| 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 |
1x
1x
1x
91x
91x
91x
91x
91x
91x
91x
91x
91x
91x
3x
2x
1x
90x
90x
3x
87x
4x
91x
91x
91x
182x
91x
91x
91x
1x
2x
1x
67x
1x
12x
1x
6x
1x
4x
1x
9x
8x
8x
8x
1x
1x
18x
17x
17x
2x
2x
15x
2x
2x
13x
13x
| import IDictionary from './interfaces/IDictionary';
import IHeaders from './interfaces/IHeaders';
import IRawResponse from './interfaces/IRawResponse';
import IRequestOptions from './interfaces/IRequestOptions';
import IResponseHeaders from './interfaces/IResponseHeaders';
import * as JsonApi from './interfaces/JsonApi';
import {Record} from './Record';
import {Response as LibResponse} from './Response';
import {Store} from './Store';
import {assign, isBrowser} from './utils';
export type FetchType = (
method: string,
url: string,
body?: object,
requestHeaders?: IHeaders,
) => Promise<IRawResponse>;
export interface IStoreFetchOpts {
url: string;
options?: IRequestOptions;
data?: object;
method: string;
store: Store;
}
export type StoreFetchType = (options: IStoreFetchOpts) => Promise<LibResponse>;
export interface IConfigType {
baseFetch: FetchType;
baseUrl: string;
defaultHeaders: IHeaders;
fetchReference: Function;
storeFetch: StoreFetchType;
}
export const config: IConfigType = {
/** Base URL for all API calls */
baseUrl: '/',
/** Default headers that will be sent to the server */
defaultHeaders: {
'content-type': 'application/vnd.api+json',
},
/** Reference of the fetch method that should be used */
/* istanbul ignore next */
fetchReference: isBrowser && window.fetch.bind(window),
/**
* Base implementation of the fetch function (can be overriden)
*
* @param {string} method API call method
* @param {string} url API call URL
* @param {object} [body] API call body
* @param {IHeaders} [requestHeaders] Headers that will be sent
* @returns {Promise<IRawResponse>} Resolves with a raw response object
*/
baseFetch(
method: string,
url: string,
body?: object,
requestHeaders?: IHeaders,
): Promise<IRawResponse> {
let data: JsonApi.IResponse;
let status: number;
let headers: IResponseHeaders;
const request: Promise<void> = Promise.resolve();
const uppercaseMethod = method.toUpperCase();
const isBodySupported = uppercaseMethod !== 'GET' && uppercaseMethod !== 'HEAD';
return request
.then(() => {
const reqHeaders: IHeaders = assign({}, config.defaultHeaders, requestHeaders) as IHeaders;
return this.fetchReference(url, {
body: isBodySupported && JSON.stringify(body) || undefined,
headers: reqHeaders,
method,
});
})
.then((response: Response) => {
status = response.status;
headers = response.headers;
return response.json();
})
.catch((e: Error) => {
if (status === 204) {
return null;
}
throw e;
})
.then((responseData: JsonApi.IResponse) => {
data = responseData;
if (status >= 400) {
throw {
message: `Invalid HTTP status: ${status}`,
status,
};
}
return {data, headers, requestHeaders, status};
})
.catch((error) => {
return {data, error, headers, requestHeaders, status};
});
},
/**
* Base implementation of the stateful fetch function (can be overriden)
*
* @param {IStoreFetchOpts} options API request options
* @returns {Promise<Response>} Resolves with a response object
*/
storeFetch({
url,
options,
data,
method = 'GET',
store,
}: IStoreFetchOpts): Promise<LibResponse> {
return config.baseFetch(method, url, data, options && options.headers)
.then((response: IRawResponse) => new LibResponse(response, store, options));
},
};
export function fetch(options: IStoreFetchOpts) {
return config.storeFetch(options);
}
/**
* API call used to get data from the server
*
* @export
* @param {Store} store Related Store
* @param {string} url API call URL
* @param {IHeaders} [headers] Headers to be sent
* @param {IRequestOptions} [options] Server options
* @returns {Promise<Response>} Resolves with a Response object
*/
export function read(
store: Store,
url: string,
headers?: IHeaders,
options?: IRequestOptions,
): Promise<LibResponse> {
return config.storeFetch({
data: null,
method: 'GET',
options: {...options, headers},
store,
url,
});
}
/**
* API call used to create data on the server
*
* @export
* @param {Store} store Related Store
* @param {string} url API call URL
* @param {object} [data] Request body
* @param {IHeaders} [headers] Headers to be sent
* @param {IRequestOptions} [options] Server options
* @returns {Promise<Response>} Resolves with a Response object
*/
export function create(
store: Store,
url: string,
data?: object,
headers?: IHeaders,
options?: IRequestOptions,
): Promise<LibResponse> {
return config.storeFetch({
data,
method: 'POST',
options: {...options, headers},
store,
url,
});
}
/**
* API call used to update data on the server
*
* @export
* @param {Store} store Related Store
* @param {string} url API call URL
* @param {object} [data] Request body
* @param {IHeaders} [headers] Headers to be sent
* @param {IRequestOptions} [options] Server options
* @returns {Promise<Response>} Resolves with a Response object
*/
export function update(
store: Store,
url: string,
data?: object,
headers?: IHeaders,
options?: IRequestOptions,
): Promise<LibResponse> {
return config.storeFetch({
data,
method: 'PATCH',
options: {...options, headers},
store,
url,
});
}
/**
* API call used to remove data from the server
*
* @export
* @param {Store} store Related Store
* @param {string} url API call URL
* @param {IHeaders} [headers] Headers to be sent
* @param {IRequestOptions} [options] Server options
* @returns {Promise<Response>} Resolves with a Response object
*/
export function remove(
store: Store,
url: string,
headers?: IHeaders,
options?: IRequestOptions,
): Promise<LibResponse> {
return config.storeFetch({
data: null,
method: 'DELETE',
options: {...options, headers},
store,
url,
});
}
/**
* Fetch a link from the server
*
* @export
* @param {JsonApi.ILink} link Link URL or a link object
* @param {Store} store Store that will be used to save the response
* @param {IDictionary<string>} [requestHeaders] Request headers
* @param {IRequestOptions} [options] Server options
* @returns {Promise<LibResponse>} Response promise
*/
export function fetchLink(
link: JsonApi.ILink,
store: Store,
requestHeaders?: IDictionary<string>,
options?: IRequestOptions,
): Promise<LibResponse> {
if (link) {
const href: string = typeof link === 'object' ? link.href : link;
/* istanbul ignore else */
if (href) {
return read(store, href, requestHeaders, options);
}
}
return Promise.resolve(new LibResponse({data: null}, store));
}
export function handleResponse(record: Record, prop?: string): (LibResponse) => Record {
return (response: LibResponse): Record => {
/* istanbul ignore if */
if (response.error) {
throw response.error;
}
if (response.status === 204) {
record['__persisted'] = true;
return record as Record;
} else if (response.status === 202) {
(response.data as Record).update({
__prop__: prop,
__queue__: true,
__related__: record,
} as Object);
return response.data as Record;
} else {
record['__persisted'] = true;
return response.replaceData(record).data as Record;
}
};
}
|