@mstuercke/api-utils 0.0.11 → 0.0.12

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.
@@ -1,10 +1,9 @@
1
- import { RestApiRequestHandler, RestApiRoute, RestPathParams, RestQueryParams, RestRequestBody, RestResponseBody } from './types';
1
+ import { RestApiRequestHandler, RestApiRoute, RestPathParams, RestQueryParams, RestRequestBody, RestRequestHeaders, RestRequireAuthentication, RestResponseBody } from './types';
2
2
  import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
3
- import { RestRequestHeaders } from './types/RestRequestHeaders';
4
3
  export declare class RestApi {
5
4
  private routes;
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;
7
- handleRequest(request: APIGatewayProxyEvent): Promise<APIGatewayProxyResult>;
5
+ addRouteHandler<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never, RequireAuthentication extends RestRequireAuthentication = never>(route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody, RequireAuthentication>, requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody, RequireAuthentication>): this;
6
+ handleRequest(proxyEvent: APIGatewayProxyEvent): Promise<APIGatewayProxyResult>;
8
7
  private getMatchingRouteHandlers;
9
8
  private getMatchingRouteHandler;
10
9
  private extractPathParams;
@@ -8,14 +8,20 @@ const DEFAULT_RESPONSE_HEADERS = {
8
8
  export class RestApi {
9
9
  routes = [];
10
10
  addRouteHandler(route, requestHandler) {
11
- this.routes = [...this.routes, { route, requestHandler }];
11
+ this.routes = [
12
+ ...this.routes,
13
+ {
14
+ route,
15
+ requestHandler,
16
+ },
17
+ ];
12
18
  return this;
13
19
  }
14
- async handleRequest(request) {
20
+ async handleRequest(proxyEvent) {
15
21
  try {
16
- const url = new URL(`${request.headers['origin'] || 'https://no-origin'}${request.path}`);
17
- const routeHandler = this.getMatchingRouteHandler(url, request.httpMethod);
18
- if (!routeHandler && request.httpMethod === 'OPTIONS') {
22
+ const url = new URL(`${proxyEvent.headers['origin'] || 'https://no-origin'}${proxyEvent.path}`);
23
+ const routeHandler = this.getMatchingRouteHandler(url, proxyEvent.httpMethod);
24
+ if (!routeHandler && proxyEvent.httpMethod === 'OPTIONS') {
19
25
  const allowedHttpMethods = this.getMatchingRouteHandlers(url).map(({ routeHandler }) => routeHandler.route.method);
20
26
  return {
21
27
  statusCode: 200,
@@ -30,14 +36,18 @@ export class RestApi {
30
36
  return {
31
37
  statusCode: 405,
32
38
  headers: DEFAULT_RESPONSE_HEADERS,
33
- body: `Method ${request.httpMethod} not allowed on ${request.path}`,
39
+ body: `Method ${proxyEvent.httpMethod} not allowed on ${proxyEvent.path}`,
34
40
  };
35
- const { routeHandler: { requestHandler }, pathParams, queryParams } = routeHandler;
41
+ const { routeHandler: { requestHandler, route }, pathParams, queryParams } = routeHandler;
42
+ const userId = proxyEvent.requestContext.authorizer?.principalId;
43
+ if (route.requireAuthentication && !userId)
44
+ return { statusCode: 401, body: '' };
36
45
  const responseBody = await requestHandler({
37
46
  pathParams,
38
47
  queryParams,
39
- headers: request.headers,
40
- body: request.body && JSON.parse(request.body),
48
+ headers: proxyEvent.headers,
49
+ body: proxyEvent.body && JSON.parse(proxyEvent.body),
50
+ userId,
41
51
  });
42
52
  return {
43
53
  statusCode: responseBody.status,
@@ -1 +1 @@
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"}
1
+ {"version":3,"file":"RestApi.js","sourceRoot":"","sources":["../../src/rest/RestApi.ts"],"names":[],"mappings":"AAYA,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,GAAwD,EAAE,CAAC;IAEzE,eAAe,CAQX,KAA8G,EAC9G,cAAgI;QAClI,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd;gBACE,KAAK;gBACL,cAAc;aACmG;SACpH,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,UAAgC;QAClD,IAAI;YACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,mBAAmB,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;YAChG,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;YAC9E,IAAI,CAAC,YAAY,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;gBACxD,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,UAAU,CAAC,UAAU,mBAAmB,UAAU,CAAC,IAAI,EAAE;iBAC1E,CAAC;YAEJ,MAAM,EAAC,YAAY,EAAE,EAAC,cAAc,EAAE,KAAK,EAAC,EAAE,UAAU,EAAE,WAAW,EAAC,GAAG,YAAY,CAAC;YACtF,MAAM,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC;YACjE,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,MAAM;gBACxC,OAAO,EAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAC,CAAC;YAErC,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC;gBACxC,UAAU;gBACV,WAAW;gBACX,OAAO,EAAE,UAAU,CAAC,OAAiC;gBACrD,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;gBACpD,MAAM;aACP,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,GAAyB;gBACjD,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,EAA4B,CAAC,CAAC;IACnC,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,YAAqC,EAAE,GAAQ;QACvE,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,MAAwB,CAAC;IACnE,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"}
@@ -1,8 +1,11 @@
1
1
  import { RestPathParams, RestQueryParams, RestRequestBody } from './index';
2
2
  import { RestRequestHeaders } from './RestRequestHeaders';
3
- export type RestApiRequest<PathParams extends RestPathParams, QueryParams extends RestQueryParams, RequestHeaders extends RestRequestHeaders, RequestBody extends RestRequestBody> = {
3
+ import { RestRequireAuthentication } from './RestRequireAuthentication';
4
+ export type RestApiRequest<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, RequireAuthentication extends RestRequireAuthentication = never> = {
4
5
  pathParams: PathParams;
5
6
  queryParams: QueryParams;
6
7
  headers: RequestHeaders;
7
8
  body: RequestBody;
9
+ userId: RequireAuthentication extends true ? string : never;
8
10
  };
11
+ export type RestApiRequestBase = RestApiRequest<any, any, any, any, true | never>;
@@ -1,8 +1,10 @@
1
- import { RestPathParams } from './RestRequestParams';
1
+ import { RestPathParams } from './RestPathParams';
2
2
  import { RestRequestBody } from './RestRequestBody';
3
3
  import { RestResponseBody } from './RestResponseBody';
4
4
  import { RestQueryParams } from './RestQueryParams';
5
- import { RestRequestBaseHeaders, RestRequestHeaders } from './RestRequestHeaders';
5
+ import { RestRequestHeaders } from './RestRequestHeaders';
6
6
  import { RestApiRequest } from './RestApiRequest';
7
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>>;
8
+ import { RestRequireAuthentication } from './RestRequireAuthentication';
9
+ export type RestApiRequestHandler<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never, RequireAuthentication extends RestRequireAuthentication = never> = (request: RestApiRequest<PathParams, QueryParams, RequestHeaders, RequestBody, RequireAuthentication>) => Promise<RestApiResponse<ResponseBody>>;
10
+ export type RestApiRequestHandlerBase = RestApiRequestHandler<RestPathParams, RestQueryParams, RestRequestHeaders, RestRequestBody, RestResponseBody, RestRequireAuthentication>;
@@ -1,17 +1,20 @@
1
- import { RestPathParams } from './RestRequestParams';
1
+ import { RestPathParams } from './RestPathParams';
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
+ import { RestRequireAuthentication } from './RestRequireAuthentication';
6
7
  export type RestHttpMethod = 'GET' | 'POST' | 'DELETE' | 'PATCH' | 'PUT' | 'OPTIONS';
7
8
  export type RestRoutePath = `/${string}`;
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
+ export interface RestApiRoute<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never, RequireAuthentication extends RestRequireAuthentication = never> {
9
10
  method: RestHttpMethod;
10
11
  path: RestRoutePath;
11
12
  buildUrl: (pathParams: PathParams, queryParams: QueryParams) => RestRoutePath;
13
+ requireAuthentication?: RequireAuthentication;
12
14
  __types?: {
13
15
  RequestHeaders: RequestHeaders;
14
16
  RequestBody: RequestBody;
15
17
  ResponseBody: ResponseBody;
16
18
  };
17
19
  }
20
+ export type RestApiRouteBase = RestApiRoute<RestPathParams, RestQueryParams, RestRequestHeaders, RestRequestBody, RestResponseBody, RestRequireAuthentication>;
@@ -1,11 +1,13 @@
1
1
  import { RestApiRoute } from './RestApiRoute';
2
2
  import { RestApiRequestHandler } from './RestApiRequestHandler';
3
- import { RestPathParams } from './RestRequestParams';
3
+ import { RestPathParams } from './RestPathParams';
4
4
  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 = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never> {
9
- route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>;
10
- requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody>;
8
+ import { RestRequireAuthentication } from './RestRequireAuthentication';
9
+ export interface RestApiRouteHandler<PathParams extends RestPathParams = never, QueryParams extends RestQueryParams = never, RequestHeaders extends RestRequestHeaders = never, RequestBody extends RestRequestBody = never, ResponseBody extends RestResponseBody = never, RequireAuthentication extends RestRequireAuthentication = never> {
10
+ route: RestApiRoute<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody, RequireAuthentication>;
11
+ requestHandler: RestApiRequestHandler<PathParams, QueryParams, RequestHeaders, RequestBody, ResponseBody, RequireAuthentication>;
11
12
  }
13
+ export type RestApiRouteHandlerBase = RestApiRouteHandler<RestPathParams, RestQueryParams, RestRequestHeaders, RestRequestBody, RestResponseBody, RestRequireAuthentication>;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=RestPathParams.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RestPathParams.js","sourceRoot":"","sources":["../../../src/rest/types/RestPathParams.ts"],"names":[],"mappings":""}
@@ -1,4 +1 @@
1
1
  export type RestRequestHeaders = Record<string, string> | never;
2
- export type RestRequestBaseHeaders = {
3
- origin?: string | undefined;
4
- };
@@ -0,0 +1 @@
1
+ export type RestRequireAuthentication = true | never;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=RestRequireAuthentication.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RestRequireAuthentication.js","sourceRoot":"","sources":["../../../src/rest/types/RestRequireAuthentication.ts"],"names":[],"mappings":""}
@@ -1,10 +1,11 @@
1
- export * from './RestApiRequest';
2
- export * from './RestApiRequestHandler';
3
- export * from './RestApiResponse';
4
- export * from './RestApiRoute';
5
- export * from './RestApiRouteHandler';
6
- export * from './RestQueryParams';
7
- export * from './RestRequestBody';
8
- export * from './RestRequestHeaders';
9
- export * from './RestRequestParams';
10
- export * from './RestResponseBody';
1
+ export { RestApiRequest } from './RestApiRequest';
2
+ export { RestApiRequestHandler } from './RestApiRequestHandler';
3
+ export { RestApiResponse } from './RestApiResponse';
4
+ export { RestApiRoute, RestRoutePath, RestHttpMethod } from './RestApiRoute';
5
+ export { RestApiRouteHandler } from './RestApiRouteHandler';
6
+ export { RestPathParams } from './RestPathParams';
7
+ export { RestQueryParams } from './RestQueryParams';
8
+ export { RestRequestBody } from './RestRequestBody';
9
+ export { RestRequestHeaders } from './RestRequestHeaders';
10
+ export { RestRequireAuthentication } from './RestRequireAuthentication';
11
+ export { RestResponseBody } from './RestResponseBody';
@@ -1,11 +1,2 @@
1
- export * from './RestApiRequest';
2
- export * from './RestApiRequestHandler';
3
- export * from './RestApiResponse';
4
- export * from './RestApiRoute';
5
- export * from './RestApiRouteHandler';
6
- export * from './RestQueryParams';
7
- export * from './RestRequestBody';
8
- export * from './RestRequestHeaders';
9
- export * from './RestRequestParams';
10
- export * from './RestResponseBody';
1
+ export {};
11
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rest/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rest/types/index.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mstuercke/api-utils",
3
- "version": "0.0.11",
3
+ "version": "0.0.12",
4
4
  "main": "dist/index.js",
5
5
  "type": "module",
6
6
  "files": [
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=RestRequestParams.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"RestRequestParams.js","sourceRoot":"","sources":["../../../src/rest/types/RestRequestParams.ts"],"names":[],"mappings":""}