@ez4/gateway 0.23.0 → 0.24.0

package/dist/services/common.d.ts

@@ -1,5 +1,15 @@
 import type { Service } from '@ez4/common';
+import type { NamingStyle } from '@ez4/schema';
 import type { Http } from './contract.js';
+/**
+ * Contract for HTTP preferences.
+ */
+export interface HttpPreferences {
+    /**
+     * Determines the naming style for the query strings and body payloads.
+     */
+    namingStyle?: NamingStyle;
+}
 /**
  * HTTP CORS configuration.
  */
@@ -71,6 +81,10 @@ export type HttpRawBody = string;
  * Authorizer request.
  */
 export interface HttpAuthRequest {
+    /**
+     * Auth request preferences.
+     */
+    preferences?: HttpPreferences;
     /**
      * Expected HTTP headers.
      */
@@ -97,6 +111,10 @@ export interface HttpAuthResponse {
  * HTTP request.
  */
 export interface HttpRequest {
+    /**
+     * Request preferences.
+     */
+    preferences?: HttpPreferences;
     /**
      * Expected identity.
      */
@@ -122,6 +140,10 @@ export interface HttpRequest {
  * HTTP response.
  */
 export interface HttpResponse {
+    /**
+     * Response preferences.
+     */
+    preferences?: HttpPreferences;
     /**
      * HTTP status code.
      */
@@ -169,7 +191,7 @@ 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 | HttpProvider>) => Promise<void> | void;
+export type HttpListener<T extends HttpRequest | HttpAuthRequest> = (event: Service.AnyEvent<HttpIncoming<T>>, context: Service.Context<Http.Service | HttpProvider>) => Promise<void> | void;
 /**
  * Request authorizer.
  */

package/dist/services/contract.d.ts

@@ -1,8 +1,8 @@
-import type { Service } from '@ez4/common';
+import type { Service as CommonService } from '@ez4/common';
 import type { LinkedVariables } from '@ez4/project/library';
 import type { HttpPath } from '../types/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';
+import type { HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody, HttpRawBody, HttpPreferences, HttpAuthRequest, HttpAuthResponse, HttpRequest, HttpResponse, HttpErrors, HttpProvider, HttpIncoming, HttpListener, HttpAuthorizer, HttpHandler, HttpCache, HttpCors } from './common.js';
 /**
  * Provide all contracts for a self-managed HTTP service.
  */
@@ -13,6 +13,7 @@ export declare namespace Http {
     type QueryStrings = HttpQueryStrings;
     type JsonBody = HttpJsonBody;
     type RawBody = HttpRawBody;
+    type Preferences = HttpPreferences;
     type AuthRequest = HttpAuthRequest;
     type Request = HttpRequest;
     type AuthResponse = HttpAuthResponse;
@@ -25,7 +26,7 @@ export declare namespace Http {
     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 ServiceEvent<T extends Request | AuthRequest = Request> = CommonService.AnyEvent<Incoming<T>>;
     type EmptySuccessResponse<S extends HttpSuccessStatuses = 204> = HttpEmptySuccessResponse<S>;
     type SuccessResponse<S extends HttpSuccessStatuses, T extends HttpRawBody | HttpJsonBody> = HttpSuccessResponse<S, T>;
     /**
@@ -48,14 +49,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;
+        /**
+         * Default log retention (in days) for the handlers.
+         */
+        logRetention?: number;
         /**
          * Variables associated to the route.
          */
@@ -85,6 +86,10 @@ export declare namespace Http {
          * Status codes for all known exceptions.
          */
         httpErrors?: Errors;
+        /**
+         * Default preferences for all handlers and routes.
+         */
+        preferences?: Preferences;
         /**
          * Default log retention (in days) for the handlers.
          */
@@ -101,7 +106,7 @@ export declare namespace Http {
     /**
      * HTTP service.
      */
-    abstract class Service implements Service.Provider {
+    abstract class Service implements CommonService.Provider {
         /**
          * All expected routes.
          */

package/dist/services/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * HTTP naming style.
+ */
+export declare const enum NamingStyle {
+    CamelCase = "camel",
+    PascalCase = "pascal",
+    SnakeCase = "snake",
+    KebabCase = "kebab"
+}

package/dist/types/common.d.ts

@@ -1,8 +1,11 @@
-import type { ArraySchema, ObjectSchema, ScalarSchema, UnionSchema } from '@ez4/schema';
+import type { ArraySchema, NamingStyle, ObjectSchema, ScalarSchema, UnionSchema } from '@ez4/schema';
 import type { LinkedVariables } from '@ez4/project/library';
 import type { ServiceListener } from '@ez4/common/library';
 export type HttpVerb = 'ANY' | 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
 export type HttpPath = `${HttpVerb} /${string}`;
+export type HttpPreferences = {
+    namingStyle?: NamingStyle;
+};
 export type HttpAuthRequest = {
     headers?: ObjectSchema | null;
     parameters?: ObjectSchema | null;
@@ -12,8 +15,8 @@ export type HttpAuthResponse = {
     identity?: ObjectSchema | UnionSchema | null;
 };
 export type HttpRequest = {
-    headers?: ObjectSchema | null;
     identity?: ObjectSchema | UnionSchema | null;
+    headers?: ObjectSchema | null;
     parameters?: ObjectSchema | null;
     query?: ObjectSchema | null;
     body?: ObjectSchema | UnionSchema | ArraySchema | ScalarSchema | null;
@@ -29,9 +32,11 @@ export type HttpHandler = {
     response: HttpResponse;
     request?: HttpRequest;
     file: string;
+    module?: string;
 };
 export type HttpAuthorizer = {
     name: string;
+    module?: string;
     file: string;
     description?: string;
     response?: HttpAuthResponse;
@@ -46,16 +51,18 @@ export type HttpRoute = {
     listener?: ServiceListener | null;
     authorizer?: HttpAuthorizer | null;
     variables?: LinkedVariables | null;
-    logRetention?: number | null;
     httpErrors?: HttpErrors | null;
+    preferences?: HttpPreferences;
+    logRetention?: number | null;
     timeout?: number | null;
     memory?: number | null;
     cors?: boolean | null;
 };
 export type HttpDefaults = {
-    logRetention?: number | null;
-    httpErrors?: HttpErrors | null;
     listener?: ServiceListener | null;
+    httpErrors?: HttpErrors | null;
+    preferences?: HttpPreferences;
+    logRetention?: number | null;
     timeout?: number | null;
     memory?: number | null;
 };

package/dist/utils/body.d.ts

@@ -1,4 +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;
+export declare const getRequestBody: <T extends Http.JsonBody | Http.RawBody>(input: T, schema: AnySchema, preferences?: Http.Preferences | null) => Promise<T>;
+export declare const getResponseBody: (body: unknown, schema: AnySchema, preferences?: Http.Preferences) => unknown;

package/dist/utils/query.d.ts

@@ -1,3 +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>;
+export declare const getQueryStrings: <T extends Http.QueryStrings>(input: T, schema: ObjectSchema, preferences?: Http.Preferences | null) => Promise<T>;

package/dist/utils.cjs

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

@@ -1,19 +1,25 @@
-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};
+var y=Object.defineProperty;var a=(e,t)=>y(e,"name",{value:t,configurable:!0});import{createTransformContext as d,transform as l}from"@ez4/transform";import{validate as g,
+getUniqueErrorMessages as h,createValidatorContext as x}from"@ez4/validator";import{
+HttpBadRequestError as u}from"@ez4/gateway";var D=a(async(e,t)=>{let r=l(e,t,d({convert:!1})),o=await g(r,t,x({property:"$pa\
+th"}));if(o.length){let s=h(o);throw new u("Malformed path parameters.",s)}return r},
+"getPathParameters");import{createTransformContext as T,transform as H}from"@ez4/transform";import{validate as w,
+createValidatorContext as S,getUniqueErrorMessages as v}from"@ez4/validator";import{
+HttpBadRequestError as E}from"@ez4/gateway";var W=a(async(e,t,r)=>{let o=r?.namingStyle,s=T({convert:!0,inputStyle:o}),n=H(e,
+t,s),m=S({property:"$query"}),p=await w(n,t,m);if(p.length){let i=v(p);throw new E(
+"Malformed query strings.",i)}return n},"getQueryStrings");import{createTransformContext as q,transform as C}from"@ez4/transform";import{validate as P,
+createValidatorContext as b,getUniqueErrorMessages as z}from"@ez4/validator";import{
+HttpBadRequestError as M}from"@ez4/gateway";var et=a(async(e,t)=>{let r=C(e,t,q({convert:!1})),o=await P(r,t,b({property:"$h\
+eader"}));if(o.length){let s=z(o);throw new M("Malformed request headers.",s)}return r},
+"getHeaders");import{validate as j,createValidatorContext as B,getUniqueErrorMessages as O}from"@ez4/validator";
+import{HttpBadRequestError as R}from"@ez4/gateway";var nt=a(async(e,t)=>{let r=await j(e,t,B({property:"$identity"}));if(r.length){
+let o=O(r);throw new R("Malformed authorizer identity.",o)}return e},"getIdentit\
+y");import{createTransformContext as c,transform as f}from"@ez4/transform";import{validate as U,
+createValidatorContext as V,getUniqueErrorMessages as $}from"@ez4/validator";import{
+HttpBadRequestError as A}from"@ez4/gateway";var yt=a(async(e,t,r)=>{let o=r?.namingStyle,s=V({property:"$body",inputStyle:o}),
+n=await U(e,t,s);if(n.length){let i=$(n);throw new A("Malformed body payload.",i)}
+let m=c({convert:!1,inputStyle:o});return f(e,t,m)},"getRequestBody"),dt=a((e,t,r)=>{
+let o=r?.namingStyle,s=c({convert:!1,outputStyle:o});return f(e,t,s)},"getRespon\
+seBody");var ht=a(({status:e,message:t,details:r})=>({status:e,body:{message:t,details:r}}),
+"getJsonError");export{et as getHeaders,nt as getIdentity,ht as getJsonError,D as getPathParameters,
+W as getQueryStrings,yt as getRequestBody,dt 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.23.0",
+  "version": "0.24.0",
   "author": "Silas B.",
   "license": "MIT",
   "type": "module",
@@ -37,6 +37,7 @@
     "packages/*"
   ],
   "scripts": {
+    "lint": "eslint --cache",
     "clean": "rm -f *.tsbuildinfo && rm -rf dist/*",
     "build": "tsc -p tsconfig.json && node tools/bundler.mjs",
     "test": "npm run test:types && node --test --import ../../tools/tsnode.mjs test/*.spec.ts",
@@ -47,10 +48,12 @@
     "live:publish": "npm run test && npm publish --access public"
   },
   "dependencies": {
-    "@ez4/common": "^0.23.0",
-    "@ez4/project": "^0.23.0",
-    "@ez4/reflection": "^0.23.0",
-    "@ez4/schema": "^0.23.0",
-    "@ez4/utils": "^0.23.0"
+    "@ez4/common": "^0.24.0",
+    "@ez4/project": "^0.24.0",
+    "@ez4/reflection": "^0.24.0",
+    "@ez4/schema": "^0.24.0",
+    "@ez4/transform": "^0.24.0",
+    "@ez4/utils": "^0.24.0",
+    "@ez4/validator": "^0.24.0"
   }
 }