@mstuercke/api-utils 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/rest/fetchRestApi.d.ts +3 -0
- package/dist/rest/fetchRestApi.js +15 -0
- package/dist/rest/fetchRestApi.js.map +1 -0
- package/dist/rest/types/RestApiRequest.d.ts +8 -0
- package/dist/rest/types/RestApiRequest.js +2 -0
- package/dist/rest/types/RestApiRequest.js.map +1 -0
- package/dist/rest/types/RestApiRequestHandler.d.ts +4 -13
- package/dist/rest/types/RestApiResponse.d.ts +5 -0
- package/dist/rest/types/RestApiResponse.js +2 -0
- package/dist/rest/types/RestApiResponse.js.map +1 -0
- package/dist/rest/types/RestApiRoute.d.ts +1 -1
- package/dist/rest/types/RestApiRouteHandler.d.ts +1 -1
- package/dist/rest/types/RestRequestHeaders.d.ts +3 -4
- package/dist/rest/types/index.d.ts +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { RestApiRoute, RestResponseBody } from './types';
|
|
2
|
+
import { RestApiRequest } from './types/RestApiRequest';
|
|
3
|
+
export declare const fetchRestApi: <PathParams extends object, QueryParams extends object, RequestHeaders extends Record<string, string>, RequestBody extends object, ResponseBody extends RestResponseBody>(route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>, restApiUrl: string, request: RestApiRequest<PathParams, QueryParams, RequestHeaders, RequestBody>) => Promise<ResponseBody>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export const fetchRestApi = async (route, restApiUrl, request) => {
|
|
2
|
+
const url = `${restApiUrl}${route.buildUrl(request.pathParams, request.queryParams)}`;
|
|
3
|
+
const response = await fetch(url, {
|
|
4
|
+
method: route.method,
|
|
5
|
+
headers: request.headers,
|
|
6
|
+
body: request.body ? JSON.stringify(request.body) : null,
|
|
7
|
+
});
|
|
8
|
+
if (!response.ok && response.status !== 404)
|
|
9
|
+
throw `Request ${route.method} ${url} failed`;
|
|
10
|
+
const text = (await response.text()).trim();
|
|
11
|
+
return response.ok && response.status !== 204
|
|
12
|
+
? JSON.parse(text)
|
|
13
|
+
: null;
|
|
14
|
+
};
|
|
15
|
+
//# sourceMappingURL=fetchRestApi.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fetchRestApi.js","sourceRoot":"","sources":["../../src/rest/fetchRestApi.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAM7B,KAAuF,EACvF,UAAkB,EAClB,OAA6E,EACxD,EAAE;IACzB,MAAM,GAAG,GAAG,GAAG,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;IACtF,MAAM,QAAQ,GAAG,MAAM,KAAK,CACxB,GAAG,EACH;QACE,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;KACzD,CAAC,CAAC;IAEP,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QACzC,MAAM,WAAW,KAAK,CAAC,MAAM,IAAI,GAAG,SAAS,CAAC;IAEhD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5C,OAAO,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QACzC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC,IAAI,CAAC;AACb,CAAC,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { RestPathParams, RestQueryParams, RestRequestBody } from './index';
|
|
2
|
+
import { RestRequestHeaders } from './RestRequestHeaders';
|
|
3
|
+
export type RestApiRequest<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody> = {
|
|
4
|
+
pathParams: PathParams;
|
|
5
|
+
queryParams: QueryParams;
|
|
6
|
+
headers: RequestHeaders;
|
|
7
|
+
body: RequestBody;
|
|
8
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RestApiRequest.js","sourceRoot":"","sources":["../../../src/rest/types/RestApiRequest.ts"],"names":[],"mappings":""}
|
|
@@ -2,16 +2,7 @@ import { RestPathParams } from './RestRequestParams';
|
|
|
2
2
|
import { RestRequestBody } from './RestRequestBody';
|
|
3
3
|
import { RestResponseBody } from './RestResponseBody';
|
|
4
4
|
import { RestQueryParams } from './RestQueryParams';
|
|
5
|
-
import { RestRequestHeaders } from './RestRequestHeaders';
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
headers: RequestHeaders;
|
|
10
|
-
queryParams: QueryParams;
|
|
11
|
-
body: RequestBody;
|
|
12
|
-
}
|
|
13
|
-
export interface ApiRouteResponse<ResponseBody> {
|
|
14
|
-
status: number;
|
|
15
|
-
headers?: Record<string, string>;
|
|
16
|
-
body?: ResponseBody;
|
|
17
|
-
}
|
|
5
|
+
import { RestRequestBaseHeaders, RestRequestHeaders } from './RestRequestHeaders';
|
|
6
|
+
import { RestApiRequest } from './RestApiRequest';
|
|
7
|
+
import { RestApiResponse } from './RestApiResponse';
|
|
8
|
+
export type RestApiRequestHandler<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders & RestRequestBaseHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> = (request: RestApiRequest<PathParams, QueryParams, RequestHeaders, RequestBody>) => Promise<RestApiResponse<ResponseBody>>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RestApiResponse.js","sourceRoot":"","sources":["../../../src/rest/types/RestApiResponse.ts"],"names":[],"mappings":""}
|
|
@@ -5,7 +5,7 @@ import { RestQueryParams } from './RestQueryParams';
|
|
|
5
5
|
import { RestRequestHeaders } from './RestRequestHeaders';
|
|
6
6
|
export type RestHttpMethod = 'GET' | 'POST' | 'DELETE' | 'PATCH' | 'PUT' | 'OPTIONS';
|
|
7
7
|
export type RestRoutePath = `/${string}`;
|
|
8
|
-
export interface RestApiRoute<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> {
|
|
8
|
+
export interface RestApiRoute<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never> {
|
|
9
9
|
method: RestHttpMethod;
|
|
10
10
|
path: RestRoutePath;
|
|
11
11
|
buildUrl: (pathParams: PathParams, queryParams: QueryParams) => RestRoutePath;
|
|
@@ -5,7 +5,7 @@ import { RestQueryParams } from './RestQueryParams';
|
|
|
5
5
|
import { RestRequestBody } from './RestRequestBody';
|
|
6
6
|
import { RestResponseBody } from './RestResponseBody';
|
|
7
7
|
import { RestRequestHeaders } from './RestRequestHeaders';
|
|
8
|
-
export interface RestApiRouteHandler<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> {
|
|
8
|
+
export interface RestApiRouteHandler<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never> {
|
|
9
9
|
route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>;
|
|
10
10
|
requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>;
|
|
11
11
|
}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
export type RestRequestHeaders =
|
|
1
|
+
export type RestRequestHeaders = Record<string, string> | never;
|
|
2
|
+
export type RestRequestBaseHeaders = {
|
|
2
3
|
origin?: string | undefined;
|
|
3
|
-
|
|
4
|
-
[name: string]: string | undefined;
|
|
5
|
-
} | never;
|
|
4
|
+
};
|