feat(internal): support Middy.js 5.x (#2748)

Author: dreamorosi

docs/core/logger.md

@@ -111,7 +111,7 @@ This functionality will include the following keys in your structured logs:
 === "Middy Middleware"
 
     !!! tip "A note about Middy"
-        We guarantee support only for Middy.js `v4.x`, that you can install it by running `npm i @middy/core@~4`.
+        We guarantee support for both Middy.js `v4.x` & `v5.x` with the latter being available only if you are using ES modules.
         Check their docs to learn more about [Middy and its middleware stack](https://middy.js.org/docs/intro/getting-started){target="_blank"} as well as [best practices when working with Powertools](https://middy.js.org/docs/integrations/lambda-powertools#best-practices){target="_blank"}.
 
     ```typescript hl_lines="2 14"

docs/core/metrics.md

@@ -199,7 +199,7 @@ You can add default dimensions to your metrics by passing them as parameters in
 === "Middy middleware"
 
     !!! tip "A note about Middy"
-        Currently we support up to Middy `v4.x` that you can install it by running `npm i @middy/core@~4`.
+        We guarantee support for both Middy.js `v4.x` & `v5.x` with the latter being available only if you are using ES modules.
         Check their docs to learn more about [Middy and its middleware stack](https://middy.js.org/docs/intro/getting-started){target="_blank"} as well as [best practices when working with Powertools](https://middy.js.org/docs/integrations/lambda-powertools#best-practices){target="_blank"}.
 
     ```typescript hl_lines="24-26"

docs/core/tracer.md

@@ -154,7 +154,7 @@ You can quickly start by importing the `Tracer` class, initialize it outside the
 === "Middy Middleware"
 
     !!! tip "A note about Middy"
-        We guarantee support only for Middy.js `v4.x`, that you can install it by running `npm i @middy/core@~4`.
+        We guarantee support for both Middy.js `v4.x` & `v5.x` with the latter being available only if you are using ES modules.
         Check their docs to learn more about [Middy and its middleware stack](https://middy.js.org/docs/intro/getting-started){target="_blank"} as well as [best practices when working with Powertools](https://middy.js.org/docs/integrations/lambda-powertools#best-practices){target="_blank"}.
 
     ```typescript hl_lines="2 15 17"

docs/index.md

@@ -299,7 +299,7 @@ aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{aws::region}:094274105
 
 Many of the utilities provided by Powertools for AWS Lambda (TypeScript) can be used with different programming paradigms:
 
-- **Middy** middleware. It is the best choice if your existing code base relies on the [Middy 4.x](https://middy.js.org/docs/) middleware engine. Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless.
+- **Middy** middleware. It is the best choice if your existing code base relies on the [Middy.js](https://middy.js.org/docs/) middleware engine. Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless.
 - **Method decorator**. Use [TypeScript method decorators](https://www.typescriptlang.org/docs/handbook/decorators.html#method-decorators) if you prefer writing your business logic using [TypeScript Classes](https://www.typescriptlang.org/docs/handbook/classes.html). If you aren’t using Classes, this requires the most significant refactoring.
 - **Manually**. It provides the most granular control. It’s the most verbose approach, with the added benefit of no additional dependency and no refactoring to TypeScript Classes.
 

docs/utilities/idempotency.md

@@ -189,7 +189,7 @@ The configuration options for the `@idempotent` decorator are the same as the on
 ### MakeHandlerIdempotent Middy middleware
 
 !!! tip "A note about Middy"
-    Currently we support Middy up to `v4.x` that you can install it by running `npm i @middy/core@~4`.
+    We guarantee support for both Middy.js `v4.x` & `v5.x` with the latter being available only if you are using ES modules.
     Check their docs to learn more about [Middy and its middleware stack](https://middy.js.org/docs/intro/getting-started){target="_blank"} as well as [best practices when working with Powertools](https://middy.js.org/docs/integrations/lambda-powertools#best-practices){target="_blank"}.
 
 If you are using [Middy.js](https://middy.js.org){target="_blank"} as your middleware engine, you can use the `makeHandlerIdempotent` middleware to make your Lambda handler idempotent.

package-lock.json

@@ -49,7 +49,6 @@
   },
   "homepage": "https://github.com/aws-powertools/powertools-lambda-typescript#readme",
   "devDependencies": {
-    "@middy/core": "^4.7.0",
     "@types/aws-lambda": "^8.10.140",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.9",
@@ -67,6 +66,8 @@
     "lerna": "8.1.2",
     "lint-staged": "^15.2.7",
     "markdownlint-cli2": "^0.13.0",
+    "middy4": "npm:@middy/core@^4.7.0",
+    "middy5": "npm:@middy/core@^5.4.3",
     "prettier": "^3.3.2",
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",

package.json

@@ -102,7 +102,7 @@
   "peerDependencies": {
     "@aws-sdk/client-dynamodb": ">=3.x",
     "@aws-sdk/lib-dynamodb": ">=3.x",
-    "@middy/core": ">=3.x"
+    "@middy/core": "4.x || 5.x"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/client-dynamodb": {

packages/idempotency/package.json

@@ -66,7 +66,7 @@
     "@types/lodash.merge": "^4.6.9"
   },
   "peerDependencies": {
-    "@middy/core": ">=3.x"
+    "@middy/core": "4.x || 5.x"
   },
   "peerDependenciesMeta": {
     "@middy/core": {

packages/logger/package.json

@@ -2,7 +2,7 @@ import { Logger } from '../../src/index.js';
 import { injectLambdaContext } from '../../src/middleware/middy.js';
 import type { Context, APIGatewayAuthorizerResult } from 'aws-lambda';
 import type { TestEvent, TestOutput } from '../helpers/types.js';
-import middy from '@middy/core';
+import middy from 'middy5';
 
 const PERSISTENT_KEY = process.env.PERSISTENT_KEY || 'persistentKey';
 const PERSISTENT_VALUE = process.env.PERSISTENT_VALUE || 'persistentValue';