@middy/core 2.4.3 → 2.5.3

package/index.d.ts

@@ -1,11 +1,12 @@
 import {
   Context as LambdaContext,
-  Handler as LambdaHandler
+  Handler as LambdaHandler,
+  Callback as LambdaCallback
 } from 'aws-lambda'
 
 declare type PluginHook = () => void
 declare type PluginHookWithMiddlewareName = (middlewareName: string) => void
-declare type PluginHookPromise = () => Promise<any>
+declare type PluginHookPromise = (request: Request) => Promise<unknown> | unknown
 
 interface PluginObject {
   beforePrefetch?: PluginHook
@@ -17,9 +18,9 @@ interface PluginObject {
   requestEnd?: PluginHookPromise
 }
 
-interface Request<TEvent = any, TResult = any, TErr = Error> {
+interface Request<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> {
   event: TEvent
-  context: LambdaContext
+  context: TContext
   response: TResult | null
   error: TErr | null
   internal: {
@@ -27,41 +28,49 @@ interface Request<TEvent = any, TResult = any, TErr = Error> {
   }
 }
 
-declare type MiddlewareFn<TEvent = any, TResult = any, TErr = Error> = (request: Request<TEvent, TResult, TErr>) => any
+declare type MiddlewareFn<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> = (request: Request<TEvent, TResult, TErr, TContext>) => any
 
-export interface MiddlewareObj<TEvent = any, TResult = any, TErr = Error> {
-  before?: MiddlewareFn<TEvent, TResult, TErr>
-  after?: MiddlewareFn<TEvent, TResult, TErr>
+export interface MiddlewareObj<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> {
+  before?: MiddlewareFn<TEvent, TResult, TErr, TContext>
+  after?: MiddlewareFn<TEvent, TResult, TErr, TContext>
   onError?: MiddlewareFn<TEvent, TResult, TErr>
 }
 
-export interface MiddyfiedHandler<TEvent = any, TResult = any, TErr = Error> {
-  use: UseFn<TEvent, TResult, TErr>
-  applyMiddleware: AttachMiddlewareObj<TEvent, TResult, TErr>
-  before: AttachMiddlewareFn<TEvent, TResult, TErr>
-  after: AttachMiddlewareFn<TEvent, TResult, TErr>
-  onError: AttachMiddlewareFn<TEvent, TResult, TErr>
+// The AWS provided Handler type uses void | Promise<TResult> so we have no choice but to follow and suppress the linter warning
+// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+type MiddyInputHandler<TEvent, TResult, TContext extends LambdaContext = LambdaContext> = (event: TEvent, context: TContext, callback: LambdaCallback<TResult>) => void | Promise<TResult>
+
+export interface MiddyfiedHandler<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> extends MiddyInputHandler<TEvent, TResult, TContext> {
+  use: UseFn<TEvent, TResult, TErr, TContext>
+  applyMiddleware: AttachMiddlewareObj<TEvent, TResult, TErr, TContext>
+  before: AttachMiddlewareFn<TEvent, TResult, TErr, TContext>
+  after: AttachMiddlewareFn<TEvent, TResult, TErr, TContext>
+  onError: AttachMiddlewareFn<TEvent, TResult, TErr, TContext>
   __middlewares: {
-    before: Array<MiddlewareFn<TEvent, TResult, TErr>>
-    after: Array<MiddlewareFn<TEvent, TResult, TErr>>
-    onError: Array<MiddlewareFn<TEvent, TResult, TErr>>
+    before: Array<MiddlewareFn<TEvent, TResult, TErr, TContext>>
+    after: Array<MiddlewareFn<TEvent, TResult, TErr, TContext>>
+    onError: Array<MiddlewareFn<TEvent, TResult, TErr, TContext>>
   }
-  (event: TEvent, context: LambdaContext): Promise<TResult>
 }
 
-declare type AttachMiddlewareFn<TEvent = any, TResult = any, TErr = Error> = (middleware: MiddlewareFn) => MiddyfiedHandler<TEvent, TResult, TErr>
+declare type AttachMiddlewareFn<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> = (middleware: MiddlewareFn) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
+
+declare type AttachMiddlewareObj<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> = (middleware: MiddlewareObj) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
 
-declare type AttachMiddlewareObj<TEvent = any, TResult = any, TErr = Error> = (middleware: MiddlewareObj) => MiddyfiedHandler<TEvent, TResult, TErr>
+declare type UseFn<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> =
+  (middlewares: MiddlewareObj<TEvent, TResult, TErr, TContext> | Array<MiddlewareObj<TEvent, TResult, TErr, TContext>>) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
 
-declare type UseFn<TEvent = any, TResult = any, TErr = Error> =
-  (middlewares: MiddlewareObj<TEvent, TResult, TErr> | Array<MiddlewareObj<TEvent, TResult, TErr>>) => MiddyfiedHandler<TEvent, TResult, TErr>
+declare type MiddlewareHandler<THandler extends LambdaHandler<any, any>, TContext extends LambdaContext = LambdaContext> =
+  THandler extends LambdaHandler<infer TEvent, infer TResult> // always true
+    ? MiddyInputHandler<TEvent, TResult, TContext>
+    : never
 
 /**
  * Middy factory function. Use it to wrap your existing handler to enable middlewares on it.
  * @param handler your original AWS Lambda function
  * @param plugin wraps around each middleware and handler to add custom lifecycle behaviours (e.g. to profile performance)
  */
-declare function middy<TEvent = any, TResult = any, TErr = Error> (handler?: LambdaHandler<TEvent, TResult>, plugin?: PluginObject): MiddyfiedHandler<TEvent, TResult, TErr>
+declare function middy<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> (handler?: MiddlewareHandler<LambdaHandler<TEvent, TResult>, TContext>, plugin?: PluginObject): MiddyfiedHandler<TEvent, TResult, TErr, TContext>
 
 declare namespace middy {
   export {

package/index.js

@@ -106,7 +106,7 @@ const runRequest = async (request, beforeMiddlewares, baseHandler, afterMiddlewa
   } finally {
     var _plugin$requestEnd;
 
-    await (plugin === null || plugin === void 0 ? void 0 : (_plugin$requestEnd = plugin.requestEnd) === null || _plugin$requestEnd === void 0 ? void 0 : _plugin$requestEnd.call(plugin));
+    await (plugin === null || plugin === void 0 ? void 0 : (_plugin$requestEnd = plugin.requestEnd) === null || _plugin$requestEnd === void 0 ? void 0 : _plugin$requestEnd.call(plugin, request));
   }
 
   return request.response;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/core",
-  "version": "2.4.3",
+  "version": "2.5.3",
   "description": "🛵 The stylish Node.js middleware engine for AWS Lambda (core package)",
   "type": "commonjs",
   "engines": {
@@ -45,5 +45,5 @@
     "@types/aws-lambda": "^8.10.76",
     "@types/node": "^16.0.0"
   },
-  "gitHead": "969313c44d557dddf81849b10407652e7c533a46"
+  "gitHead": "690884d43b9cd632aeca9a5eba1612160b987cd4"
 }