@ez4/gateway 0.18.0 → 0.20.0

package/dist/services/common.d.ts

@@ -131,6 +131,12 @@ export interface HttpResponse {
      */
     body?: HttpJsonBody;
 }
+export interface HttpProvider {
+    /**
+     * All services associated to the provider.
+     */
+    services: Record<string, unknown>;
+}
 /**
  * Incoming request.
  */
@@ -155,12 +161,18 @@ export type HttpIncoming<T extends HttpRequest | HttpAuthRequest> = T & {
 /**
  * Request listener.
  */
-export type HttpListener<T extends HttpRequest | HttpAuthRequest> = (event: Service.Event<HttpIncoming<T>>, context: Service.Context<Http.Service>) => Promise<void> | void;
+export type HttpListener<T extends HttpRequest | HttpAuthRequest> = (event: Service.Event<HttpIncoming<T>>, context: Service.Context<Http.Service | HttpProvider>) => Promise<void> | void;
 /**
  * Request authorizer.
  */
-export type HttpAuthorizer<T extends HttpAuthRequest> = (request: HttpIncoming<T> | T, context: Service.Context<Http.Service>) => Promise<HttpAuthResponse> | HttpAuthResponse;
+export type HttpAuthorizer<T extends HttpAuthRequest> = (request: HttpIncoming<T> | T, context: Service.Context<Http.Service | HttpProvider>) => Promise<HttpAuthResponse> | HttpAuthResponse;
 /**
  * Request handler.
  */
-export type HttpHandler<T extends HttpRequest> = (request: HttpIncoming<T> | T, context: Service.Context<Http.Service>) => Promise<HttpResponse> | HttpResponse;
+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,13 +1,11 @@
 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, HttpIncoming, HttpListener, HttpAuthorizer, HttpHandler, HttpCache } from './common.js';
+import type { HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody, 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;
@@ -17,6 +15,10 @@ export declare namespace Http {
     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>;
@@ -42,6 +44,10 @@ export declare namespace Http {
          * Route handler.
          */
         handler: Handler<T>;
+        /**
+         * Map status codes and errors for all known exceptions.
+         */
+        httpErrors?: Errors;
         /**
          * Variables associated to the route.
          */
@@ -67,10 +73,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/types/common.d.ts

@@ -1,6 +1,6 @@
+import type { ArraySchema, ObjectSchema, ScalarSchema, UnionSchema } from '@ez4/schema';
 import type { LinkedVariables } from '@ez4/project/library';
 import type { ServiceListener } from '@ez4/common/library';
-import type { BooleanSchema, NumberSchema, ObjectSchema, StringSchema, UnionSchema } from '@ez4/schema';
 export type HttpVerb = 'ANY' | 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
 export type HttpPath = `${HttpVerb} /${string}`;
 export type HttpAuthRequest = {
@@ -16,19 +16,19 @@ export type HttpRequest = {
     identity?: ObjectSchema | UnionSchema | null;
     parameters?: ObjectSchema | null;
     query?: ObjectSchema | null;
-    body?: ObjectSchema | UnionSchema | null;
+    body?: ObjectSchema | UnionSchema | ArraySchema | null;
 };
 export type HttpResponse = {
     status: number;
     headers?: ObjectSchema | null;
-    body?: ObjectSchema | UnionSchema | NumberSchema | StringSchema | BooleanSchema | null;
+    body?: ObjectSchema | UnionSchema | ArraySchema | ScalarSchema | null;
 };
 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.18.0",
+  "version": "0.20.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.18.0",
-    "@ez4/project": "^0.18.0",
-    "@ez4/reflection": "^0.18.0",
-    "@ez4/schema": "^0.18.0",
-    "@ez4/utils": "^0.18.0"
+    "@ez4/common": "^0.20.0",
+    "@ez4/project": "^0.20.0",
+    "@ez4/reflection": "^0.20.0",
+    "@ez4/schema": "^0.20.0",
+    "@ez4/utils": "^0.20.0"
   }
 }