@mstuercke/api-utils 0.0.2 → 0.0.3
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/RestApi.d.ts +2 -1
- package/dist/rest/RestApi.js +6 -1
- package/dist/rest/RestApi.js.map +1 -1
- package/dist/rest/types/RestApiRequestHandler.d.ts +8 -1
- package/dist/rest/types/RestApiRoute.d.ts +2 -1
- package/dist/rest/types/RestApiRouteHandler.d.ts +4 -3
- package/dist/rest/types/RestQueryParams.d.ts +1 -1
- package/dist/rest/types/RestRequestBody.d.ts +1 -1
- package/dist/rest/types/RestRequestHeaders.d.ts +5 -0
- package/dist/rest/types/RestRequestHeaders.js +2 -0
- package/dist/rest/types/RestRequestHeaders.js.map +1 -0
- package/dist/rest/types/RestRequestParams.d.ts +1 -1
- package/dist/rest/types/RestResponseBody.d.ts +1 -1
- package/package.json +2 -2
package/dist/rest/RestApi.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { RestApiRequestHandler, RestApiRoute, RestPathParams, RestQueryParams, RestRequestBody, RestResponseBody } from './types';
|
|
2
2
|
import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
|
|
3
|
+
import { RestRequestHeaders } from './types/RestRequestHeaders';
|
|
3
4
|
export declare class RestApi {
|
|
4
5
|
private routes;
|
|
5
|
-
addRouteHandler<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody>(route: RestApiRoute<PathParams, QueryParams, RequestBody, ResponseBody>, requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestBody, ResponseBody>): this;
|
|
6
|
+
addRouteHandler<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody>(route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>, requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>): this;
|
|
6
7
|
handleRequest(request: APIGatewayProxyEvent): Promise<APIGatewayProxyResult>;
|
|
7
8
|
private getMatchingRouteHandlers;
|
|
8
9
|
private getMatchingRouteHandler;
|
package/dist/rest/RestApi.js
CHANGED
|
@@ -33,7 +33,12 @@ export class RestApi {
|
|
|
33
33
|
body: `Method ${request.httpMethod} not allowed on ${request.path}`,
|
|
34
34
|
};
|
|
35
35
|
const { routeHandler: { requestHandler }, pathParams, queryParams } = routeHandler;
|
|
36
|
-
const responseBody = await requestHandler(
|
|
36
|
+
const responseBody = await requestHandler({
|
|
37
|
+
pathParams,
|
|
38
|
+
queryParams,
|
|
39
|
+
headers: request.headers,
|
|
40
|
+
body: request.body && JSON.parse(request.body),
|
|
41
|
+
});
|
|
37
42
|
return {
|
|
38
43
|
statusCode: responseBody.status,
|
|
39
44
|
body: responseBody.body ? JSON.stringify(responseBody.body) : '',
|
package/dist/rest/RestApi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RestApi.js","sourceRoot":"","sources":["../../src/rest/RestApi.ts"],"names":[],"mappings":"AAUA,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"RestApi.js","sourceRoot":"","sources":["../../src/rest/RestApi.ts"],"names":[],"mappings":"AAUA,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAGrC,MAAM,wBAAwB,GAAG;IAC/B,cAAc,EAAE,iCAAiC;IACjD,6BAA6B,EAAE,GAAG;IAClC,8BAA8B,EAAE,GAAG;IACnC,8BAA8B,EAAE,GAAG;CAC3B,CAAC;AAQX,MAAM,OAAO,OAAO;IACV,MAAM,GAAmD,EAAE,CAAC;IAEpE,eAAe,CAMX,KAAuF,EACvF,cAAyG;QAE3G,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,cAAc,EAAC,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAA6B;QAC/C,IAAI;YACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,mBAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1F,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAC3E,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE;gBACrD,MAAM,kBAAkB,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAC,YAAY,EAAC,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACjH,OAAO;oBACL,UAAU,EAAE,GAAG;oBACf,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE;wBACP,GAAG,wBAAwB;wBAC3B,8BAA8B,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC;qBAC7D;iBACF,CAAC;aACH;YAED,IAAI,CAAC,YAAY;gBACf,OAAO;oBACL,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,wBAAwB;oBACjC,IAAI,EAAE,UAAU,OAAO,CAAC,UAAU,mBAAmB,OAAO,CAAC,IAAI,EAAE;iBACpE,CAAC;YAEJ,MAAM,EAAC,YAAY,EAAE,EAAC,cAAc,EAAC,EAAE,UAAU,EAAE,WAAW,EAAC,GAAG,YAAY,CAAC;YAE/E,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC;gBACxC,UAAU;gBACV,WAAW;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;aAC/C,CAAC,CAAC;YACH,OAAO;gBACL,UAAU,EAAE,YAAY,CAAC,MAAM;gBAC/B,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;gBAChE,OAAO,EAAE;oBACP,GAAG,wBAAwB;oBAC3B,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI,EAAE,CAAC;iBAChC;aACF,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO;gBACL,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,wBAAwB;gBACjC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAC,KAAK,EAAC,CAAC;aAC9B,CAAC;SACH;IACH,CAAC;IAEO,wBAAwB,CAAC,GAAQ;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,EAAE,YAAY,EAAE,EAAE;YAChE,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;YAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACjD,MAAM,oBAAoB,GAAmC;gBAC3D,YAAY;gBACZ,UAAU;gBACV,WAAW;aACZ,CAAC;YACF,OAAO,UAAU;gBACb,CAAC,CAAC,CAAC,GAAG,qBAAqB,EAAE,oBAAoB,CAAC;gBAClD,CAAC,CAAC,qBAAqB,CAAC;QAC9B,CAAC,EAAE,EAAsC,CAAC,CAAC;IAC7C,CAAC;IAEO,uBAAuB,CAAC,GAAQ,EAAE,UAAkB;QAC1D,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC;aACpC,IAAI,CAAC,CAAC,EAAC,YAAY,EAAC,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC;IAC1E,CAAC;IAEO,iBAAiB,CAAC,YAA0D,EAAE,GAAQ;QAC5F,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,EAAC,MAAM,EAAE,kBAAkB,EAAC,CAAC,CAAC;QAC7E,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,EAAE,MAAM,CAAC;IACjD,CAAC;IAEO,kBAAkB,CAAC,GAAQ;QACjC,MAAM,WAAW,GAAyC,EAAE,CAAC;QAC7D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE;YACrD,IAAI,GAAG,IAAI,WAAW,EAAE;gBACtB,MAAM,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;gBACvC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;oBAC3C,CAAC,CAAC,CAAC,GAAG,aAAa,EAAE,KAAK,CAAC;oBAC3B,CAAC,CAAC,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;aAC9B;iBAAM;gBACL,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aAC1B;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}
|
|
@@ -2,7 +2,14 @@ import { RestPathParams } from './RestRequestParams';
|
|
|
2
2
|
import { RestRequestBody } from './RestRequestBody';
|
|
3
3
|
import { RestResponseBody } from './RestResponseBody';
|
|
4
4
|
import { RestQueryParams } from './RestQueryParams';
|
|
5
|
-
|
|
5
|
+
import { RestRequestHeaders } from './RestRequestHeaders';
|
|
6
|
+
export type RestApiRequestHandler<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> = (request: ApiRouteRequest<PathParams, QueryParams, RequestHeaders, RequestBody>) => Promise<ApiRouteResponse<ResponseBody>>;
|
|
7
|
+
export interface ApiRouteRequest<PathParams, QueryParams, RequestHeaders, RequestBody> {
|
|
8
|
+
pathParams: PathParams;
|
|
9
|
+
headers: RequestHeaders;
|
|
10
|
+
queryParams: QueryParams;
|
|
11
|
+
body: RequestBody;
|
|
12
|
+
}
|
|
6
13
|
export interface ApiRouteResponse<ResponseBody> {
|
|
7
14
|
status: number;
|
|
8
15
|
headers?: Record<string, string>;
|
|
@@ -2,9 +2,10 @@ 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';
|
|
5
6
|
export type RestHttpMethod = 'GET' | 'POST' | 'DELETE' | 'PATCH' | 'PUT' | 'OPTIONS';
|
|
6
7
|
export type RestRoutePath = `/${string}`;
|
|
7
|
-
export interface RestApiRoute<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> {
|
|
8
|
+
export interface RestApiRoute<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> {
|
|
8
9
|
method: RestHttpMethod;
|
|
9
10
|
path: RestRoutePath;
|
|
10
11
|
buildUrl: (pathParams: PathParams, queryParams: QueryParams) => RestRoutePath;
|
|
@@ -4,7 +4,8 @@ import { RestPathParams } from './RestRequestParams';
|
|
|
4
4
|
import { RestQueryParams } from './RestQueryParams';
|
|
5
5
|
import { RestRequestBody } from './RestRequestBody';
|
|
6
6
|
import { RestResponseBody } from './RestResponseBody';
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
import { RestRequestHeaders } from './RestRequestHeaders';
|
|
8
|
+
export interface RestApiRouteHandler<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody, ResponseBody extends RestResponseBody> {
|
|
9
|
+
route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>;
|
|
10
|
+
requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>;
|
|
10
11
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export type RestQueryParams = object |
|
|
1
|
+
export type RestQueryParams = object | never;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export type RestRequestBody =
|
|
1
|
+
export type RestRequestBody = object | never;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RestRequestHeaders.js","sourceRoot":"","sources":["../../../src/rest/types/RestRequestHeaders.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export type RestPathParams = object |
|
|
1
|
+
export type RestPathParams = object | never;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export type RestResponseBody = object | object[] |
|
|
1
|
+
export type RestResponseBody = object | object[] | never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mstuercke/api-utils",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"@types/aws-lambda": "^8.0.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
|
-
"@mstuercke/bun-utils": "^0.0.
|
|
28
|
+
"@mstuercke/bun-utils": "^0.0.10",
|
|
29
29
|
"@types/aws-lambda": "^8.10.123",
|
|
30
30
|
"@types/path-to-regexp": "^1.7.0",
|
|
31
31
|
"bump": "^0.2.5",
|