@ez4/gateway 0.19.0 → 0.21.0

package/dist/services/common.d.ts

@@ -59,24 +59,28 @@ export interface HttpPathParameters {
 export interface HttpQueryStrings {
 }
 /**
- * Request body payload.
+ * Json body payload.
  */
 export interface HttpJsonBody {
 }
+/**
+ * Raw body payload.
+ */
+export type HttpRawBody = string;
 /**
  * Authorizer request.
  */
 export interface HttpAuthRequest {
     /**
-     * Expected headers.
+     * Expected HTTP headers.
      */
     headers?: HttpHeaders;
     /**
-     * Expected path parameters.
+     * Expected HTTP path parameters.
      */
     parameters?: HttpPathParameters;
     /**
-     * Expected query strings.
+     * Expected HTTP query strings.
      */
     query?: HttpQueryStrings;
 }
@@ -93,43 +97,43 @@ export interface HttpAuthResponse {
  * HTTP request.
  */
 export interface HttpRequest {
-    /**
-     * Expected headers.
-     */
-    headers?: HttpHeaders;
     /**
      * Expected identity.
      */
     identity?: HttpIdentity;
     /**
-     * Expected path parameters.
+     * Expected HTTP headers.
+     */
+    headers?: HttpHeaders;
+    /**
+     * Expected HTTP path parameters.
      */
     parameters?: HttpPathParameters;
     /**
-     * Expected query strings.
+     * Expected HTTP query strings.
      */
     query?: HttpQueryStrings;
     /**
-     * Expected JSON body payload.
+     * Expected HTTP body payload.
      */
-    body?: HttpJsonBody;
+    body?: HttpJsonBody | HttpRawBody;
 }
 /**
  * HTTP response.
  */
 export interface HttpResponse {
     /**
-     * Response status code.
+     * HTTP status code.
      */
     status: number;
     /**
-     * Response headers.
+     * HTTP headers.
      */
     headers?: HttpHeaders;
     /**
-     * Response body.
+     * HTTP body payload.
      */
-    body?: HttpJsonBody;
+    body?: HttpJsonBody | HttpRawBody;
 }
 export interface HttpProvider {
     /**
@@ -145,6 +149,10 @@ export type HttpIncoming<T extends HttpRequest | HttpAuthRequest> = T & {
      * Request tracking Id.
      */
     requestId: string;
+    /**
+     * Determines whether request is base64 encoded or not.
+     */
+    encoded?: boolean;
     /**
      * Request timestamp.
      */
@@ -170,3 +178,9 @@ export type HttpAuthorizer<T extends HttpAuthRequest> = (request: HttpIncoming<T
  * Request handler.
  */
 export type HttpHandler<T extends HttpRequest> = (request: HttpIncoming<T> | T, context: Service.Context<Http.Service | HttpProvider>) => Promise<HttpResponse> | HttpResponse;
+/**
+ * HTTP errors.
+ */
+export type HttpErrors = {
+    [code: number]: Error[];
+};

package/dist/services/contract.d.ts

@@ -1,28 +1,33 @@
 import type { Service } from '@ez4/common';
 import type { LinkedVariables } from '@ez4/project/library';
 import type { HttpPath } from '../types/common.js';
-import type { HttpCors, HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody, HttpAuthRequest, HttpAuthResponse, HttpRequest, HttpResponse, HttpProvider, HttpIncoming, HttpListener, HttpAuthorizer, HttpHandler, HttpCache } from './common.js';
+import type { HttpSuccessStatuses, HttpEmptySuccessResponse, HttpSuccessResponse } from './utils.js';
+import type { HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody, HttpRawBody, HttpAuthRequest, HttpAuthResponse, HttpRequest, HttpResponse, HttpErrors, HttpProvider, HttpIncoming, HttpListener, HttpAuthorizer, HttpHandler, HttpCache, HttpCors } from './common.js';
 /**
  * Provide all contracts for a self-managed HTTP service.
  */
 export declare namespace Http {
-    type Cors = HttpCors;
-    type Cache = HttpCache;
     type Headers = HttpHeaders;
     type Identity = HttpIdentity;
     type PathParameters = HttpPathParameters;
     type QueryStrings = HttpQueryStrings;
     type JsonBody = HttpJsonBody;
+    type RawBody = HttpRawBody;
     type AuthRequest = HttpAuthRequest;
     type Request = HttpRequest;
     type AuthResponse = HttpAuthResponse;
     type Response = HttpResponse;
+    type Errors = HttpErrors;
     type Provider = HttpProvider;
+    type Cache = HttpCache;
+    type Cors = HttpCors;
     type Incoming<T extends Request | AuthRequest> = HttpIncoming<T>;
     type Listener<T extends Request | AuthRequest> = HttpListener<T>;
     type Authorizer<T extends AuthRequest> = HttpAuthorizer<T>;
     type Handler<T extends Request> = HttpHandler<T>;
     type ServiceEvent<T extends Request | AuthRequest = Request> = Service.Event<Incoming<T>>;
+    type EmptySuccessResponse<S extends HttpSuccessStatuses = 204> = HttpEmptySuccessResponse<S>;
+    type SuccessResponse<S extends HttpSuccessStatuses, T extends HttpRawBody | HttpJsonBody> = HttpSuccessResponse<S, T>;
     /**
      * HTTP route.
      */
@@ -43,6 +48,14 @@ export declare namespace Http {
          * Route handler.
          */
         handler: Handler<T>;
+        /**
+         * Default log retention (in days) for the handlers.
+         */
+        logRetention?: number;
+        /**
+         * Map status codes and errors for all known exceptions.
+         */
+        httpErrors?: Errors;
         /**
          * Variables associated to the route.
          */
@@ -68,10 +81,14 @@ export declare namespace Http {
          * Default route listener.
          */
         listener?: Listener<T>;
+        /**
+         * Status codes for all known exceptions.
+         */
+        httpErrors?: Errors;
         /**
          * Default log retention (in days) for the handlers.
          */
-        retention?: number;
+        logRetention?: number;
         /**
          * Default execution time (in seconds) for handlers and routes.
          */

package/dist/services/utils.d.ts

@@ -0,0 +1,24 @@
+import type { HttpResponse, HttpJsonBody, HttpRawBody } from './common.js';
+export type HttpSuccessStatuses = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208;
+/**
+ * Common HTTP success response without a response body.
+ */
+export declare class HttpEmptySuccessResponse<S extends HttpSuccessStatuses> implements HttpResponse {
+    /**
+     * HTTP status code.
+     */
+    status: S;
+}
+/**
+ * Common HTTP success response.
+ */
+export declare class HttpSuccessResponse<S extends HttpSuccessStatuses, T extends HttpJsonBody | HttpRawBody> implements HttpResponse {
+    /**
+     * HTTP status code.
+     */
+    status: S;
+    /**
+     * HTTP response payload.
+     */
+    body: T;
+}

package/dist/types/common.d.ts

@@ -16,7 +16,7 @@ export type HttpRequest = {
     identity?: ObjectSchema | UnionSchema | null;
     parameters?: ObjectSchema | null;
     query?: ObjectSchema | null;
-    body?: ObjectSchema | UnionSchema | ArraySchema | null;
+    body?: ObjectSchema | UnionSchema | ArraySchema | ScalarSchema | null;
 };
 export type HttpResponse = {
     status: number;
@@ -25,10 +25,10 @@ export type HttpResponse = {
 };
 export type HttpHandler = {
     name: string;
-    file: string;
     description?: string;
     response: HttpResponse;
     request?: HttpRequest;
+    file: string;
 };
 export type HttpAuthorizer = {
     name: string;
@@ -37,23 +37,31 @@ export type HttpAuthorizer = {
     response?: HttpAuthResponse;
     request?: HttpAuthRequest;
 };
+export type HttpErrors = {
+    [name: string]: number;
+};
 export type HttpRoute = {
     path: HttpPath;
-    listener?: ServiceListener;
-    authorizer?: HttpAuthorizer;
     handler: HttpHandler;
+    listener?: ServiceListener | null;
+    authorizer?: HttpAuthorizer | null;
     variables?: LinkedVariables | null;
-    retention?: number;
-    timeout?: number;
-    memory?: number;
-    cors?: boolean;
+    logRetention?: number | null;
+    httpErrors?: HttpErrors | null;
+    timeout?: number | null;
+    memory?: number | null;
+    cors?: boolean | null;
 };
 export type HttpDefaults = {
-    retention?: number | null;
+    logRetention?: number | null;
+    httpErrors?: HttpErrors | null;
     listener?: ServiceListener | null;
     timeout?: number | null;
     memory?: number | null;
 };
+export type HttpCache = {
+    authorizerTTL?: number;
+};
 export type HttpCors = {
     allowOrigins: string[];
     allowMethods?: string[];
@@ -62,6 +70,3 @@ export type HttpCors = {
     allowHeaders?: string[];
     maxAge?: number;
 };
-export type HttpCache = {
-    authorizerTTL?: number;
-};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ez4/gateway",
   "description": "EZ4: Components to build gateway services",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "author": "Silas B.",
   "license": "MIT",
   "type": "module",
@@ -42,10 +42,10 @@
     "live:publish": "npm run test && npm publish --access public"
   },
   "dependencies": {
-    "@ez4/common": "^0.19.0",
-    "@ez4/project": "^0.19.0",
-    "@ez4/reflection": "^0.19.0",
-    "@ez4/schema": "^0.19.0",
-    "@ez4/utils": "^0.19.0"
+    "@ez4/common": "^0.21.0",
+    "@ez4/project": "^0.21.0",
+    "@ez4/reflection": "^0.21.0",
+    "@ez4/schema": "^0.21.0",
+    "@ez4/utils": "^0.21.0"
   }
 }