@ez4/gateway 0.20.0 → 0.22.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.
      */

package/dist/services/contract.d.ts

@@ -1,7 +1,8 @@
 import type { Service } from '@ez4/common';
 import type { LinkedVariables } from '@ez4/project/library';
 import type { HttpPath } from '../types/common.js';
-import type { HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody, HttpAuthRequest, HttpAuthResponse, HttpRequest, HttpResponse, HttpErrors, HttpProvider, HttpIncoming, HttpListener, HttpAuthorizer, HttpHandler, HttpCache, HttpCors } 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.
  */
@@ -11,6 +12,7 @@ export declare namespace Http {
     type PathParameters = HttpPathParameters;
     type QueryStrings = HttpQueryStrings;
     type JsonBody = HttpJsonBody;
+    type RawBody = HttpRawBody;
     type AuthRequest = HttpAuthRequest;
     type Request = HttpRequest;
     type AuthResponse = HttpAuthResponse;
@@ -24,6 +26,8 @@ export declare namespace Http {
     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.
      */
@@ -44,6 +48,10 @@ 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.
          */

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;

package/dist/utils/body.d.ts

@@ -0,0 +1,4 @@
+import type { AnySchema } from '@ez4/schema';
+import type { Http } from '../services/contract.js';
+export declare const getRequestBody: <T extends Http.JsonBody | Http.RawBody>(input: T, schema: AnySchema) => Promise<T>;
+export declare const getResponseBody: (body: unknown, schema: AnySchema) => unknown;

package/dist/utils/errors.d.ts

@@ -0,0 +1,13 @@
+import type { HttpError } from '@ez4/gateway';
+/**
+ * Get a JSON error response for the given HTTP error.
+ *
+ * @returns Returns an error response containing `status`, `message` and `details`.
+ */
+export declare const getJsonError: ({ status, message, details }: HttpError) => {
+    status: number;
+    body: {
+        message: string;
+        details: string[] | undefined;
+    };
+};

package/dist/utils/headers.d.ts

@@ -0,0 +1,3 @@
+import type { ObjectSchema } from '@ez4/schema';
+import type { Http } from '@ez4/gateway';
+export declare const getHeaders: <T extends Http.Headers>(input: T, schema: ObjectSchema) => Promise<T>;

package/dist/utils/identity.d.ts

@@ -0,0 +1,3 @@
+import type { ObjectSchema, UnionSchema } from '@ez4/schema';
+import type { Http } from '@ez4/gateway';
+export declare const getIdentity: <T extends Http.Identity>(input: T, schema: ObjectSchema | UnionSchema) => Promise<T>;

package/dist/utils/parameters.d.ts

@@ -0,0 +1,3 @@
+import type { ObjectSchema } from '@ez4/schema';
+import type { Http } from '@ez4/gateway';
+export declare const getPathParameters: <T extends Http.PathParameters>(input: T, schema: ObjectSchema) => Promise<T>;

package/dist/utils/query.d.ts

@@ -0,0 +1,3 @@
+import type { ObjectSchema } from '@ez4/schema';
+import type { Http } from '@ez4/gateway';
+export declare const getQueryStrings: <T extends Http.QueryStrings>(input: T, schema: ObjectSchema) => Promise<T>;

package/dist/utils.cjs

@@ -0,0 +1,23 @@
+"use strict";var y=Object.defineProperty;var H=Object.getOwnPropertyDescriptor;var q=Object.getOwnPropertyNames;var S=Object.prototype.hasOwnProperty;var s=(e,t)=>y(e,"name",{value:t,configurable:!0});var b=(e,t)=>{for(var r in t)y(e,r,{get:t[r],enumerable:!0})},E=(e,t,r,o)=>{if(t&&
+typeof t=="object"||typeof t=="function")for(let a of q(t))!S.call(e,a)&&a!==r&&
+y(e,a,{get:()=>t[a],enumerable:!(o=H(t,a))||o.enumerable});return e};var v=e=>E(y({},"__esModule",{value:!0}),e);var R={};b(R,{getHeaders:()=>j,getIdentity:()=>B,getJsonError:()=>O,getPathParameters:()=>z,
+getQueryStrings:()=>M,getRequestBody:()=>C,getResponseBody:()=>P});module.exports=
+v(R);var m=require("@ez4/validator"),d=require("@ez4/transform"),x=require("@ez4/gateway");var z=s(async(e,t)=>{let r=(0,d.transform)(e,t,(0,d.createTransformContext)({convert:!1})),
+o=await(0,m.validate)(r,t,(0,m.createValidatorContext)({property:"$path"}));if(o.
+length){let a=(0,m.getUniqueErrorMessages)(o);throw new x.HttpBadRequestError("M\
+alformed path parameters.",a)}return r},"getPathParameters");var n=require("@ez4/validator"),g=require("@ez4/transform"),l=require("@ez4/gateway");var M=s(async(e,t)=>{let r=(0,g.transform)(e,t,(0,g.createTransformContext)({convert:!0})),
+o=await(0,n.validate)(r,t,(0,n.createValidatorContext)({property:"$query"}));if(o.
+length){let a=(0,n.getUniqueErrorMessages)(o);throw new l.HttpBadRequestError("M\
+alformed query strings.",a)}return r},"getQueryStrings");var p=require("@ez4/validator"),h=require("@ez4/transform"),u=require("@ez4/gateway");var j=s(async(e,t)=>{let r=(0,h.transform)(e,t,(0,h.createTransformContext)({convert:!1})),
+o=await(0,p.validate)(r,t,(0,p.createValidatorContext)({property:"$header"}));if(o.
+length){let a=(0,p.getUniqueErrorMessages)(o);throw new u.HttpBadRequestError("M\
+alformed request headers.",a)}return r},"getHeaders");var i=require("@ez4/validator"),T=require("@ez4/gateway");var B=s(async(e,t)=>{let r=await(0,i.validate)(e,t,(0,i.createValidatorContext)(
+{property:"$identity"}));if(r.length){let o=(0,i.getUniqueErrorMessages)(r);throw new T.HttpBadRequestError(
+"Malformed authorizer identity.",o)}return e},"getIdentity");var c=require("@ez4/validator"),f=require("@ez4/transform"),w=require("@ez4/gateway");var C=s(async(e,t)=>{let r=await(0,c.validate)(e,t,(0,c.createValidatorContext)(
+{property:"$body"}));if(r.length){let a=(0,c.getUniqueErrorMessages)(r);throw new w.HttpBadRequestError(
+"Malformed body payload.",a)}return(0,f.transform)(e,t,(0,f.createTransformContext)(
+{convert:!1}))},"getRequestBody"),P=s((e,t)=>(0,f.transform)(e,t,(0,f.createTransformContext)(
+{convert:!1})),"getResponseBody");var O=s(({status:e,message:t,details:r})=>({status:e,body:{message:t,details:r}}),
+"getJsonError");0&&(module.exports={getHeaders,getIdentity,getJsonError,getPathParameters,getQueryStrings,
+getRequestBody,getResponseBody});
+//# sourceMappingURL=utils.cjs.map

package/dist/utils.d.ts

@@ -0,0 +1,6 @@
+export * from './utils/parameters.js';
+export * from './utils/query.js';
+export * from './utils/headers.js';
+export * from './utils/identity.js';
+export * from './utils/body.js';
+export * from './utils/errors.js';

package/dist/utils.mjs

@@ -0,0 +1,19 @@
+var p=Object.defineProperty;var o=(e,t)=>p(e,"name",{value:t,configurable:!0});import{validate as i,getUniqueErrorMessages as c,createValidatorContext as f}from"@ez4/validator";
+import{createTransformContext as y,transform as d}from"@ez4/transform";import{HttpBadRequestError as g}from"@ez4/gateway";var I=o(async(e,t)=>{let r=d(e,t,y({convert:!1})),a=await i(r,t,f({property:"$pa\
+th"}));if(a.length){let s=c(a);throw new g("Malformed path parameters.",s)}return r},
+"getPathParameters");import{validate as h,createValidatorContext as x,getUniqueErrorMessages as l}from"@ez4/validator";
+import{createTransformContext as u,transform as T}from"@ez4/transform";import{HttpBadRequestError as w}from"@ez4/gateway";var G=o(async(e,t)=>{let r=T(e,t,u({convert:!0})),a=await h(r,t,x({property:"$qu\
+ery"}));if(a.length){let s=l(a);throw new w("Malformed query strings.",s)}return r},
+"getQueryStrings");import{validate as H,createValidatorContext as q,getUniqueErrorMessages as S}from"@ez4/validator";
+import{createTransformContext as b,transform as E}from"@ez4/transform";import{HttpBadRequestError as v}from"@ez4/gateway";var Y=o(async(e,t)=>{let r=E(e,t,b({convert:!1})),a=await H(r,t,q({property:"$he\
+ader"}));if(a.length){let s=S(a);throw new v("Malformed request headers.",s)}return r},
+"getHeaders");import{validate as z,createValidatorContext as M,getUniqueErrorMessages as j}from"@ez4/validator";
+import{HttpBadRequestError as B}from"@ez4/gateway";var rt=o(async(e,t)=>{let r=await z(e,t,M({property:"$identity"}));if(r.length){
+let a=j(r);throw new B("Malformed authorizer identity.",a)}return e},"getIdentit\
+y");import{validate as C,createValidatorContext as P,getUniqueErrorMessages as O}from"@ez4/validator";
+import{createTransformContext as m,transform as n}from"@ez4/transform";import{HttpBadRequestError as R}from"@ez4/gateway";var pt=o(async(e,t)=>{let r=await C(e,t,P({property:"$body"}));if(r.length){let s=O(
+r);throw new R("Malformed body payload.",s)}return n(e,t,m({convert:!1}))},"getR\
+equestBody"),it=o((e,t)=>n(e,t,m({convert:!1})),"getResponseBody");var yt=o(({status:e,message:t,details:r})=>({status:e,body:{message:t,details:r}}),
+"getJsonError");export{Y as getHeaders,rt as getIdentity,yt as getJsonError,I as getPathParameters,
+G as getQueryStrings,pt as getRequestBody,it as getResponseBody};
+//# sourceMappingURL=utils.mjs.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ez4/gateway",
   "description": "EZ4: Components to build gateway services",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "author": "Silas B.",
   "license": "MIT",
   "type": "module",
@@ -14,7 +14,7 @@
     "directory": "packages/gateway"
   },
   "engines": {
-    "node": ">=22.3.0"
+    "node": ">=22.7"
   },
   "exports": {
     ".": {
@@ -26,6 +26,11 @@
       "types": "./dist/library.d.ts",
       "require": "./dist/library.cjs",
       "import": "./dist/library.mjs"
+    },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "require": "./dist/utils.cjs",
+      "import": "./dist/utils.mjs"
     }
   },
   "workspaces": [
@@ -42,10 +47,10 @@
     "live:publish": "npm run test && npm publish --access public"
   },
   "dependencies": {
-    "@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"
+    "@ez4/common": "^0.22.0",
+    "@ez4/project": "^0.22.0",
+    "@ez4/reflection": "^0.22.0",
+    "@ez4/schema": "^0.22.0",
+    "@ez4/utils": "^0.22.0"
   }
 }