Merge branch 'master' into feat-method-head

Author: RobinTail

CHANGELOG.md

@@ -2,10 +2,32 @@
 
 ## Version 24
 
+### v24.6.2
+
+- Correcting recommendations given in [v24.6.0](#v2460) regarding using with `zod@^4.0.0`:
+  - Make sure the `moduleResolution` in your `tsconfig.json` is either `node16`, `nodenext` or `bundler`;
+  - Consider the [recommended tsconfig base, Node 20+](https://github.com/tsconfig/bases/blob/main/bases/node20.json);
+  - Then you MAY `import { z } from "zod"`;
+  - Otherwise, you MUST keep `import { z } from "zod/v4"`;
+  - In some cases module augmentation (Zod plugin) did not work and caused schema assignment errors for some users;
+  - The issue was reported by [@MichaelHindley](https://github.com/MichaelHindley);
+- This potential inconvenience will be resolved by dropping `zod@^3` in the next version of Express Zod API:
+  - If you're having troubles using the framework with `zod@^4.0.0`, consider upgrading to v25 (currently beta).
+
+### v24.6.1
+
+- Compatibility fix for recently changed type of Express native middleware:
+  - Fixes error `TS2345` when passing over an Express middleware to:
+    - `EndpointsFactory::use()`;
+    - `EndpointsFactory::addExpressMiddleware()`;
+  - The issue caused by `@types/express-serve-static-core` v5.0.7;
+  - The issue reported by [@zoton2](https://github.com/zoton2).
+
 ### v24.6.0
 
 - Supporting `zod` versions `^3.25.35 || ^4.0.0`:
-  - If you use `zod@^4.0.0` then `import { z } from "zod"`;
+  - If you use `zod@^4.0.0` then you MAY `import { z } from "zod"`:
+    - If facing error, ensure `moduleResolution` in your `tsconfig.json` is either `node16`, `nodenext` or `bundler`;
   - If you use `zod@^3.25.35` then keep `import { z } from "zod/v4"`;
   - For more details, see the [Explanation of the versioning strategy](https://github.com/colinhacks/zod/issues/4371).
 

README.md

@@ -58,7 +58,8 @@ Start your API server with I/O schema validation and custom middlewares in minut
    5. [Graceful shutdown](#graceful-shutdown)
    6. [Subscriptions](#subscriptions)
 8. [Caveats](#caveats)
-   1. [Excessive properties in endpoint output](#excessive-properties-in-endpoint-output)
+   1. [Zod 4 schema assignment error](#zod-4-schema-assignment-error)
+   2. [Excessive properties in endpoint output](#excessive-properties-in-endpoint-output)
 9. [Your input to my output](#your-input-to-my-output)
 
 See also [Changelog](CHANGELOG.md) and [automated migration](https://www.npmjs.com/package/@express-zod-api/migration).
@@ -84,6 +85,8 @@ Therefore, many basic tasks can be accomplished faster and easier, in particular
 
 These people contributed to the improvement of the framework by reporting bugs, making changes and suggesting ideas:
 
+[<img src="https://github.com/MichaelHindley.png" alt="@MichaelHindley" width="50px" />](https://github.com/MichaelHindley)
+[<img src="https://github.com/zoton2.png" alt="@zoton2" width="50px" />](https://github.com/zoton2)
 [<img src="https://github.com/ThomasKientz.png" alt="@ThomasKientz" width="50px" />](https://github.com/ThomasKientz)
 [<img src="https://github.com/james10424.png" alt="@james10424" width="50px" />](https://github.com/james10424)
 [<img src="https://github.com/HeikoOsigus.png" alt="@HeikoOsigus" width="50px" />](https://github.com/HeikoOsigus)
@@ -174,7 +177,11 @@ pnpm add express-zod-api express zod typescript http-errors
 pnpm add -D @types/express @types/node @types/http-errors
 ```
 
-Ensure having the following options in your `tsconfig.json` file in order to make it work as expected:
+## Environment preparation
+
+Consider using the recommended `tsconfig.json` base for your project according to your Node.js version,
+for example [the base for Node.js 20+](https://github.com/tsconfig/bases/blob/main/bases/node20.json).
+Ensure having the following options in order to make it work as expected:
 
 ```json
 {
@@ -185,6 +192,8 @@ Ensure having the following options in your `tsconfig.json` file in order to mak
 }
 ```
 
+See also how `moduleResolution` may cause [Zod 4 schema assignment error](#zod-4-schema-assignment-error).
+
 ## Set up config
 
 Create a minimal configuration. Find out all configurable options
@@ -1376,6 +1385,18 @@ framework, [Zod Sockets](https://github.com/RobinTail/zod-sockets), which has si
 There are some well-known issues and limitations, or third party bugs that cannot be fixed in the usual way, but you
 should be aware of them.
 
+## Zod 4 schema assignment error
+
+When using `zod@^4` and doing `import { z } from "zod"` you may encounter the following error:
+
+```text
+TS2739: ZodObject<...> is missing the following properties from ZodType<...>: example, deprecated.
+```
+
+In this case make sure the `moduleResolution` in your `tsconfig.json` is either `node16`, `nodenext` or `bundler`.
+Consider the [recommended tsconfig base, Node 20+](https://github.com/tsconfig/bases/blob/main/bases/node20.json).
+Otherwise, keep importing `from "zod/v4"` or consider upgrading the framework to v25.
+
 ## Excessive properties in endpoint output
 
 The schema validator removes excessive properties by default. However, Typescript

SECURITY.md

@@ -8,7 +8,7 @@
 |  23.x.x | Sonia         | 04.2025 | :white_check_mark: |
 |  22.x.x | Tai           | 01.2025 | :white_check_mark: |
 |  21.x.x | Kesaria       | 11.2024 | :white_check_mark: |
-|  20.x.x | Zoey          | 06.2024 | :white_check_mark: |
+|  20.x.x | Zoey          | 06.2024 |        :x:         |
 |  19.x.x | Dime          | 05.2024 |        :x:         |
 |  18.x.x | Victoria      | 04.2024 |        :x:         |
 |  17.x.x | Tonya         | 02.2024 |        :x:         |

express-zod-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-zod-api",
-  "version": "24.6.0",
+  "version": "24.6.2",
   "description": "A Typescript framework to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
   "license": "MIT",
   "repository": {

express-zod-api/src/config-type.ts

@@ -159,7 +159,7 @@ export interface ServerConfig extends CommonConfig {
   /**
    * @desc Custom JSON parser.
    * @default express.json()
-   * @link https://expressjs.com/en/4x/api.html#express.json
+   * @link https://expressjs.com/en/5x/api.html#express.json
    * */
   jsonParser?: RequestHandler;
   /**
@@ -175,13 +175,13 @@ export interface ServerConfig extends CommonConfig {
   /**
    * @desc Custom raw parser (assigns Buffer to request body)
    * @default express.raw()
-   * @link https://expressjs.com/en/4x/api.html#express.raw
+   * @link https://expressjs.com/en/5x/api.html#express.raw
    * */
   rawParser?: RequestHandler;
   /**
    * @desc Custom parser for URL Encoded requests used for submitting HTML forms
    * @default express.urlencoded()
-   * @link https://expressjs.com/en/4x/api.html#express.urlencoded
+   * @link https://expressjs.com/en/5x/api.html#express.urlencoded
    * */
   formParser?: RequestHandler;
   /**

express-zod-api/src/middleware.ts

@@ -109,11 +109,8 @@ export class ExpressMiddleware<
   OUT extends FlatObject,
 > extends Middleware<FlatObject, OUT, string> {
   constructor(
-    nativeMw: (
-      request: R,
-      response: S,
-      next: NextFunction,
-    ) => void | Promise<void>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- issue #2824, assignment compatibility fix
+    nativeMw: (request: R, response: S, next: NextFunction) => any,
     {
       provider = () => ({}) as OUT,
       transformer = (err: Error) => err,