v23.0.0

v23 is for Sonia

This version of the framework aims to improve its maintainability and perform several corrections. Since Express v5.1 finally tagged latest, the support of Express 4 is dropped in order to take advantage of the better support of asynchronous handlers. The default value for wrongMethodBehavior changed from 404 to 405 as the more suitable one for response in that case. Removed errorHandler option from testMiddleware() to avoid confusion with config option having same name. Several public methods and properties intended for internal usage are removed from types declaration so that potential changes to them would not be considered breaking, enabling more improvements in the future.

Breaking changes

• Minimum version of express (required peer dependency) is 5.1.0 (first release of v5 marked as latest);
• Minimum version of compression (optional peer dependency) is 1.8.0 (it supports Brotli);
• The default value for wrongMethodBehavior config option is changed to 405;
• Publicly exposed interfaces: CustomHeaderSecurity renamed to HeaderSecurity, NormalizedResponse removed.
• The errorHandler property removed from testMiddleware() argument in favor of config option having same name;
• Only the following methods remained public, while other methods and properties were marked internal or removed:
  • Endpoint: .execute() and .deprecated();
  • Middleware: .execute();
  • ResultHandler: .execute();
  • DependsOnMethod: .deprecated();
  • Documentation: constructor only;
  • Integration: .print() and .printFormatted();
  • ServeStatic: constructor only;

Migration

Consider the automated migration using the built-in ESLint rule.

// eslint.config.mjs — minimal ESLint 9 config to apply migrations automatically using "eslint --fix"
import parser from "@typescript-eslint/parser";
import migration from "express-zod-api/migration";

export default [
  { languageOptions: { parser }, plugins: { migration } },
  { files: ["**/*.ts"], rules: { "migration/v23": "error" } },
];

Full Changelog: v22.13.2...v23.0.0

v22.13.2

Fix

• Aligning catcher with documentation by @RobinTail in #2525

Chores

• Bump the typescript-eslint group with 2 updates by @dependabot in #2531

Full Changelog: v22.13.1...v22.13.2

v22.13.1

Fix

• Fix for ez.raw() without extension by @RobinTail in #2526

Chores

• Add ez.form() symbol to issue #952 test by @RobinTail in #2527

Full Changelog: v22.13.0...v22.13.1

v22.13.0

Feature

• Ability to configure and disable accessLogger by @RobinTail in #2521

Fixes

• Fix dead link in SECURITY.md by @danmichaelo in #2516
• Improving JSDoc by @RobinTail in #2517

Chores

• Replacing deprecated type assertions by @RobinTail in #2523
• Add contributor by @RobinTail in #2515
• dependabot in #2519, #2518

New Contributors

• @danmichaelo made their first contribution in #2516

Full Changelog: v22.12.0...v22.13.0

v22.12.0

Feature

• Supporting HTML forms (URL encoded) by @RobinTail in #2514

Chores

• Fixing several minor typos by @RobinTail in #2452
• Organising createServer() by @RobinTail in #2473
• Renaming protected method in BuiltinLogger by @RobinTail in #2496
• Addressing express 5 became latest by @RobinTail in #2505
• Well-known headers update by @github-actions in #2456
• Deprecating v18 by @RobinTail in #2476
• Dependencies update by @dependabot in #2459, #2457, #2460, #2461, #2462, #2463, #2467, #2466, #2469, #2477, #2479, #2482, #2481, #2488, #2487, #2486, #2485, #2489, #2492, #2491, #2490, #2498, #2499, #2502, #2501, #2503, #2508, #2506, #2511, #2513
• Transitive dependencies update by @github-actions in #2453, #2454, #2464, #2472, #2478, #2483, #2493, #2504

Full Changelog: v22.11.2...v22.12.0

v22.11.2

Fix

• Express 5 allowed range by @RobinTail in #2447

Chores

• dependabot in 2446, #2445, #2444

Full Changelog: v22.11.1...v22.11.2

v22.11.1

Fix

• Simpler return type for makeRequestMock() by @RobinTail in #2443

Chores

• Sync swagger docs example by @RobinTail in #2439
• Enforce node: prefix for built-in modules by @RobinTail in #2440
• Control allowed dependencies only for sources by @RobinTail in #2441
• Preshaped compat test directory by @RobinTail in #2442
• Running "quick start" test within compat test matrix by @RobinTail in #2430

Full Changelog: v22.11.0...v22.11.1

v22.11.0

Feature

• configurable numeric range in Documentation by @RobinTail in #2432

Chores

• dependabot in #2434, #2437, #2438, #2435, #2436 and #2433

Full Changelog: v22.10.1...v22.11.0

v22.10.1

Fix

• Async errorHandler for not found case by @RobinTail in #2425

Chores

• Upgrading all dependencies by @github-actions in #2426

Full Changelog: v22.10.0...v22.10.1

v22.10.0

Enhancement

• Documentation: requestBody.required by @RobinTail in #2423

Refactoring

• Improving Documentation helper intersect() by @RobinTail in #2409

Chores

• Diagram corrections by @RobinTail in #2413
• Upgrading tsx to address esbuild vuln. by @RobinTail in #2420
• Forcing esbuild 0.25 by @RobinTail in #2422
• Using allowed dependencies plugin instead of unicorn by @RobinTail in #2419
• dependabot in #2412, #2416, #2418, #2421

Full Changelog: v22.9.1...v22.10.0