express-zod-api 12.5.1 → 14.0.0-beta2

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## Version 14
+
+### v14.0.0
+
+- **Breaking changes**:
+  - `http-errors` becomes a peer dependency — you have to install it manually.
+    - You might also need to install `@types/http-errors` if you're using `createHttpError` in your implementation.
+  - `typescript` is a required peer dependency.
+  - Minimum version of `zod` is 3.22.3.
+  - The class `DependsOnMethodError` is removed — catch `RoutingError` instead if needed.
+- **Potentially breaking changes**:
+  - The type `FlatObject` changed from `Record<string, any>` to `Record<string, unknown>`.
+    - If a custom `ResultHandler` handles properties of the `output`, it might need to ensure its actual type.
+  - In case of body parsing failure the `ResultHandler` receives `null` into its `input` argument instead of raw body.
+    - Utilize the `request.body` within a custom `ResultHandler` in that case if needed.
+  - The type of `ResultHandler`'s arguments `input` and `output` is changed from `any` to `FlatObject | null`.
+- Other changes:
+  - Ensure having the following packages installed for the types assistance:
+    - `yarn add --dev @types/express @types/node @types/http-errors`
+    - or `npm install -D @types/express @types/node @types/http-errors`
+  - The property `DependsOnMethod::methods` is renamed to `endpoints`.
+
+```typescript
+// before
+import { createHttpError } from "express-zod-api";
+// after
+import createHttpError from "http-errors";
+```
+
 ## Version 12
 
 ### v12.5.1

package/README.md

@@ -104,14 +104,18 @@ Much can be customized to fit your needs.
 
 ## Installation
 
-Run one of the following commands to install the library and its peer dependencies.
-Typescript is an optional dependency, however, it's required if you're going to
-[generate a frontend client](#generating-a-frontend-client) for your API.
+Run one of the following commands to install the library, its peer dependencies and packages for types assistance.
 
 ```shell
-yarn add express-zod-api express zod winston typescript
-# or
-npm install express-zod-api express zod winston typescript
+yarn add express-zod-api express zod winston typescript http-errors
+yarn add --dev @types/express @types/node @types/http-errors
+```
+
+or
+
+```shell
+npm install express-zod-api express zod winston typescript http-errors
+npm install -D @types/express @types/node @types/http-errors
 ```
 
 Add the following option to your `tsconfig.json` file in order to make it work as expected:
@@ -252,7 +256,8 @@ Here is an example of the authentication middleware, that checks a `key` from in
 
 ```typescript
 import { z } from "zod";
-import { createMiddleware, createHttpError } from "express-zod-api";
+import createHttpError from "http-errors";
+import { createMiddleware } from "express-zod-api";
 
 const authMiddleware = createMiddleware({
   security: {
@@ -589,8 +594,9 @@ There are also two optional features available: a provider of options and an err
 In case the error in middleware is not a `HttpError`, the `ResultHandler` will send the status `500`.
 
 ```typescript
-import { defaultEndpointsFactory, createHttpError } from "express-zod-api";
+import { defaultEndpointsFactory } from "express-zod-api";
 import cors from "cors";
+import createHttpError from "http-errors";
 import { auth } from "express-oauth2-jwt-bearer";
 
 const simpleUsage = defaultEndpointsFactory.addExpressMiddleware(
@@ -820,9 +826,9 @@ const config = createConfig({
 const { app, httpServer, httpsServer, logger } = createServer(config, routing);
 ```
 
-At least you need to specify the port or socket (usually it is 443), certificate and the key, issued by the
-certifying authority. For example, you can acquire a free TLS certificate for your API at
-[Let's Encrypt](https://letsencrypt.org/).
+Ensure having `@types/node` package installed. At least you need to specify the port or socket (usually it is 443),
+certificate and the key, issued by the certifying authority. For example, you can acquire a free TLS certificate for
+your API at [Let's Encrypt](https://letsencrypt.org/).
 
 ## Generating a Frontend Client
 

package/SECURITY.md

@@ -2,27 +2,28 @@
 
 ## Supported Versions
 
-| Version |     Supported      |
-| ------: | :----------------: |
-|  12.x.x | :white_check_mark: |
-|  11.x.x | :white_check_mark: |
-|  10.x.x |        :x:         |
-|   9.x.x |        :x:         |
-|   8.x.x |        :x:         |
-|   7.x.x |        :x:         |
-|   6.x.x |        :x:         |
-|   5.x.x |        :x:         |
-|   4.x.x |        :x:         |
-|   3.x.x |        :x:         |
-|   2.x.x |        :x:         |
-|   1.x.x |        :x:         |
-|   0.x.x |        :x:         |
+| Version | Release |     Supported      |
+| ------: | :------ | :----------------: |
+|  14.x.x | 10.2023 | :white_check_mark: |
+|  12.x.x | 09.2023 | :white_check_mark: |
+|  11.x.x | 06.2023 | :white_check_mark: |
+|  10.x.x | 03.2023 |        :x:         |
+|   9.x.x | 03.2023 |        :x:         |
+|   8.x.x | 09.2022 |        :x:         |
+|   7.x.x | 05.2022 |        :x:         |
+|   6.x.x | 03.2022 |        :x:         |
+|   5.x.x | 12.2021 |        :x:         |
+|   4.x.x | 11.2021 |        :x:         |
+|   3.x.x | 11.2021 |        :x:         |
+|   2.x.x | 07.2021 |        :x:         |
+|   1.x.x | 05.2021 |        :x:         |
+|   0.x.x | 03.2021 |        :x:         |
 
 ## Reporting a Vulnerability
 
 Found a vulnerability or other security issue?
 
 Please urgently inform me privately by
-[email](https://github.com/RobinTail/express-zod-api/blob/master/package.json#L135).
+[email](https://github.com/RobinTail/express-zod-api/blob/master/package.json#L137).
 
 I will try to fix it as soon as possible.

package/dist/index.d.mts

@@ -1,12 +1,10 @@
 import compression from 'compression';
-import { NextHandleFunction } from 'connect';
-import express, { Request, Response, Express } from 'express';
+import express, { Request, Response, NextFunction, RequestHandler, Express } from 'express';
 import fileUpload, { UploadedFile } from 'express-fileupload';
 import https, { ServerOptions } from 'node:https';
 import winston, { Logger } from 'winston';
 import { z, ZodTypeDef, ZodType, ParseInput, ParseReturnType, ZodError } from 'zod';
 import { HttpError } from 'http-errors';
-export { default as createHttpError } from 'http-errors';
 import * as qs from 'qs';
 import * as express_serve_static_core from 'express-serve-static-core';
 import * as http from 'http';
@@ -112,7 +110,7 @@ interface MiddlewareDefinition<IN extends IOSchema<"strip">, OPT, OUT extends Fl
 }
 type AnyMiddlewareDef = MiddlewareDefinition<any, any, any, any>;
 declare const createMiddleware: <IN extends IOSchema<"strip">, OPT, OUT extends FlatObject, SCO extends string>(props: MiddlewareCreationProps<IN, OPT, OUT, SCO>) => MiddlewareDefinition<IN, OPT, OUT, SCO>;
-type ExpressMiddleware<R extends Request, S extends Response> = (request: R, response: S, next: (error?: any) => void) => void | Promise<void>;
+type ExpressMiddleware<R extends Request, S extends Response> = (request: R, response: S, next: NextFunction) => void | Promise<void>;
 interface ExpressMiddlewareFeatures<R extends Request, S extends Response, OUT extends FlatObject> {
     provider?: (request: R, response: S) => OUT | Promise<OUT>;
     transformer?: (err: Error) => HttpError | Error;
@@ -127,13 +125,8 @@ type IOSchema<U extends z.UnknownKeysParam = any> = z.ZodObject<any, U> | z.ZodU
 type ProbableIntersection<A extends IOSchema<"strip"> | null, B extends IOSchema> = A extends null ? B : A extends IOSchema<"strip"> ? z.ZodIntersection<A, B> : never;
 
 type Method = "get" | "post" | "put" | "delete" | "patch";
-type MethodsDefinition<M extends Method> = {
-    methods: M[];
-} | {
-    method: M;
-};
 
-type FlatObject = Record<string, any>;
+type FlatObject = Record<string, unknown>;
 declare const getMessageFromError: (error: Error) => string;
 declare const getStatusCodeFromError: (error: Error) => number;
 declare const getExamples: <T extends z.ZodTypeAny, V extends "original" | "parsed" | undefined>({ schema, variant, validate, }: {
@@ -153,13 +146,12 @@ declare const getExamples: <T extends z.ZodTypeAny, V extends "original" | "pars
 }) => readonly (V extends "parsed" ? z.output<T> : z.input<T>)[];
 type ErrMessage = Exclude<Parameters<typeof z.ZodString.prototype.email>[0], undefined>;
 
+interface Metadata<T extends z.ZodTypeAny> {
+    examples: z.input<T>[];
+}
 declare const metaProp = "expressZodApiMeta";
 type MetaProp = typeof metaProp;
-type MetaDef<T extends z.ZodTypeAny> = {
-    [K in MetaProp]: {
-        examples: z.input<T>[];
-    };
-};
+type MetaDef<T extends z.ZodTypeAny> = Record<MetaProp, Metadata<T>>;
 type ExampleSetter<T extends z.ZodTypeAny> = (example: z.input<T>) => WithMeta<T>;
 type WithMeta<T extends z.ZodTypeAny> = T & {
     _def: T["_def"] & MetaDef<T>;
@@ -231,7 +223,7 @@ declare class ZodUpload extends ZodType<UploadedFile, ZodUploadDef> {
     static create: () => ZodUpload;
 }
 
-interface OpenAPIContext {
+interface OpenAPIContext extends FlatObject {
     isResponse: boolean;
     serializer: (schema: z.ZodTypeAny) => string;
     getRef: (name: string) => ReferenceObject | undefined;
@@ -244,10 +236,6 @@ interface OpenAPIContext {
 declare class RoutingError extends Error {
     name: string;
 }
-/** @desc An error related to the issues of using DependsOnMethod class */
-declare class DependsOnMethodError extends RoutingError {
-    name: string;
-}
 /**
  * @desc An error related to the generating of the documentation
  * */
@@ -275,9 +263,11 @@ declare class InputValidationError extends IOSchemaError {
 }
 
 interface ResultHandlerParams<RES> {
+    /** null in case of failure to parse or to find the matching endpoint (error: not found) */
+    input: FlatObject | null;
+    /** null in case of errors or failures */
+    output: FlatObject | null;
     error: Error | null;
-    input: any;
-    output: any;
     request: Request;
     response: Response<RES>;
     logger: Logger;
@@ -288,6 +278,7 @@ interface ResultHandlerDefinition<POS extends z.ZodTypeAny, NEG extends z.ZodTyp
     getNegativeResponse: () => NEG | ApiResponse<NEG>;
     handler: ResultHandler<z.output<POS> | z.output<NEG>>;
 }
+type AnyResultHandlerDefinition = ResultHandlerDefinition<z.ZodTypeAny, z.ZodTypeAny>;
 declare const createResultHandler: <POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny>(definition: ResultHandlerDefinition<POS, NEG>) => ResultHandlerDefinition<POS, NEG>;
 declare const defaultResultHandler: ResultHandlerDefinition<z.ZodObject<{
     status: z.ZodLiteral<"success">;
@@ -405,9 +396,9 @@ declare const defaultResultHandler: ResultHandlerDefinition<z.ZodObject<{
  * @desc Responding with array is a bad practice keeping your endpoints from evolving without breaking changes.
  * @desc This handler expects your endpoint to have the property 'items' in the output object schema
  * */
-declare const arrayResultHandler: ResultHandlerDefinition<z.ZodArray<any, "many"> & {
-    _def: z.ZodArrayDef<any> & MetaDef<z.ZodArray<any, "many">>;
-    example: (example: any[]) => z.ZodArray<any, "many"> & any;
+declare const arrayResultHandler: ResultHandlerDefinition<z.ZodArray<z.ZodTypeAny, "many"> & {
+    _def: z.ZodArrayDef<z.ZodTypeAny> & MetaDef<z.ZodArray<z.ZodTypeAny, "many">>;
+    example: (example: any[]) => z.ZodArray<z.ZodTypeAny, "many"> & any;
 }, z.ZodString & {
     _def: z.ZodStringDef & MetaDef<z.ZodString>;
     example: (example: string) => z.ZodString & any;
@@ -441,34 +432,28 @@ declare abstract class AbstractEndpoint {
     abstract _setSiblingMethods(methods: Method[]): void;
     abstract getOperationId(method: Method): string | undefined;
 }
-type EndpointProps<IN extends IOSchema, OUT extends IOSchema, OPT extends FlatObject, M extends Method, POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, SCO extends string, TAG extends string> = {
-    middlewares: AnyMiddlewareDef[];
-    inputSchema: IN;
-    outputSchema: OUT;
-    handler: Handler<z.output<IN>, z.input<OUT>, OPT>;
-    resultHandler: ResultHandlerDefinition<POS, NEG>;
-    description?: string;
-    shortDescription?: string;
-    operationId?: string | ((method: Method) => string);
-} & ({
-    scopes?: SCO[];
-} | {
-    scope?: SCO;
-}) & ({
-    tags?: TAG[];
-} | {
-    tag?: TAG;
-}) & MethodsDefinition<M>;
-declare class Endpoint<IN extends IOSchema, OUT extends IOSchema, OPT extends FlatObject, M extends Method, POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, SCO extends string, TAG extends string> extends AbstractEndpoint {
+declare class Endpoint<IN extends IOSchema, OUT extends IOSchema, OPT extends FlatObject, POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, SCO extends string, TAG extends string> extends AbstractEndpoint {
     #private;
-    constructor({ middlewares, inputSchema, outputSchema, handler, resultHandler, description, shortDescription, ...rest }: EndpointProps<IN, OUT, OPT, M, POS, NEG, SCO, TAG>);
+    constructor({ methods, inputSchema, outputSchema, handler, resultHandler, getOperationId, scopes, middlewares, tags, description: long, shortDescription: short, }: {
+        middlewares?: AnyMiddlewareDef[];
+        inputSchema: IN;
+        outputSchema: OUT;
+        handler: Handler<z.output<IN>, z.input<OUT>, OPT>;
+        resultHandler: ResultHandlerDefinition<POS, NEG>;
+        description?: string;
+        shortDescription?: string;
+        getOperationId?: (method: Method) => string | undefined;
+        methods: Method[];
+        scopes?: SCO[];
+        tags?: TAG[];
+    });
     /**
      * @desc Sets the other methods supported by the same path. Used by Routing in DependsOnMethod case, for options.
      * @deprecated This method is for internal needs of the library, please avoid using it.
      * */
     _setSiblingMethods(methods: Method[]): void;
     getDescription(variant: DescriptionVariant): string | undefined;
-    getMethods(): M[];
+    getMethods(): Method[];
     getSchema(variant: "input"): IN;
     getSchema(variant: "output"): OUT;
     getSchema(variant: "positive"): POS;
@@ -507,7 +492,7 @@ interface ServerConfig {
          * @desc Custom JSON parser.
          * @default express.json()
          * */
-        jsonParser?: NextHandleFunction;
+        jsonParser?: RequestHandler;
         /**
          * @desc Enable or configure uploads handling.
          * @default false
@@ -557,7 +542,7 @@ interface CommonConfig<TAG extends string = string> {
      * @default defaultResultHandler
      * @see defaultResultHandler
      */
-    errorHandler?: ResultHandlerDefinition<any, any>;
+    errorHandler?: AnyResultHandlerDefinition;
     /** @desc Logger configuration or your custom winston logger. */
     logger: LoggerConfig | Logger;
     /**
@@ -580,7 +565,7 @@ interface CommonConfig<TAG extends string = string> {
 }
 declare const createConfig: <TAG extends string, T extends (ServerConfig | AppConfig) & CommonConfig<TAG>>(config: T) => T;
 
-type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<"strip"> | null, OPT extends FlatObject, M extends Method, SCO extends string, TAG extends string> = {
+type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<"strip"> | null, OPT extends FlatObject, SCO extends string, TAG extends string> = {
     input: IN;
     output: OUT;
     handler: Handler<z.output<ProbableIntersection<MIN, IN>>, z.input<OUT>, OPT>;
@@ -588,6 +573,10 @@ type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<
     shortDescription?: string;
     operationId?: string | ((method: Method) => string);
 } & ({
+    method: Method;
+} | {
+    methods: Method[];
+}) & ({
     scopes?: SCO[];
 } | {
     scope?: SCO;
@@ -595,7 +584,7 @@ type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<
     tags?: TAG[];
 } | {
     tag?: TAG;
-}) & MethodsDefinition<M>;
+});
 declare class EndpointsFactory<POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, IN extends IOSchema<"strip"> | null = null, OUT extends FlatObject = {}, SCO extends string = string, TAG extends string = string> {
     #private;
     protected resultHandler: ResultHandlerDefinition<POS, NEG>;
@@ -610,7 +599,7 @@ declare class EndpointsFactory<POS extends z.ZodTypeAny, NEG extends z.ZodTypeAn
     use: <R extends Request<express_serve_static_core.ParamsDictionary, any, any, qs.ParsedQs, Record<string, any>>, S extends Response<any, Record<string, any>>, AOUT extends FlatObject = {}>(middleware: ExpressMiddleware<R, S>, features?: ExpressMiddlewareFeatures<R, S, AOUT> | undefined) => EndpointsFactory<POS, NEG, IN, OUT & AOUT, SCO, TAG>;
     addExpressMiddleware<R extends Request, S extends Response, AOUT extends FlatObject = {}>(middleware: ExpressMiddleware<R, S>, features?: ExpressMiddlewareFeatures<R, S, AOUT>): EndpointsFactory<POS, NEG, IN, OUT & AOUT, SCO, TAG>;
     addOptions<AOUT extends FlatObject>(options: AOUT): EndpointsFactory<POS, NEG, IN, OUT & AOUT, SCO, TAG>;
-    build<BIN extends IOSchema, BOUT extends IOSchema, M extends Method>({ input, handler, output: outputSchema, ...rest }: BuildProps<BIN, BOUT, IN, OUT, M, SCO, TAG>): Endpoint<ProbableIntersection<IN, BIN>, BOUT, OUT, M, POS, NEG, SCO, TAG>;
+    build<BIN extends IOSchema, BOUT extends IOSchema>({ input, handler, output: outputSchema, description, shortDescription, operationId, ...rest }: BuildProps<BIN, BOUT, IN, OUT, SCO, TAG>): Endpoint<ProbableIntersection<IN, BIN>, BOUT, OUT, POS, NEG, SCO, TAG>;
 }
 declare const defaultEndpointsFactory: EndpointsFactory<z.ZodObject<{
     status: z.ZodLiteral<"success">;
@@ -728,9 +717,9 @@ declare const defaultEndpointsFactory: EndpointsFactory<z.ZodObject<{
  * @desc Responding with array is a bad practice keeping your endpoints from evolving without breaking changes.
  * @desc The result handler of this factory expects your endpoint to have the property 'items' in the output schema
  */
-declare const arrayEndpointsFactory: EndpointsFactory<z.ZodArray<any, "many"> & {
-    _def: z.ZodArrayDef<any> & MetaDef<z.ZodArray<any, "many">>;
-    example: (example: any[]) => z.ZodArray<any, "many"> & any;
+declare const arrayEndpointsFactory: EndpointsFactory<z.ZodArray<z.ZodTypeAny, "many"> & {
+    _def: z.ZodArrayDef<z.ZodTypeAny> & MetaDef<z.ZodArray<z.ZodTypeAny, "many">>;
+    example: (example: any[]) => z.ZodArray<z.ZodTypeAny, "many"> & any;
 }, z.ZodString & {
     _def: z.ZodStringDef & MetaDef<z.ZodString>;
     example: (example: string) => z.ZodString & any;
@@ -739,12 +728,8 @@ declare const arrayEndpointsFactory: EndpointsFactory<z.ZodArray<any, "many"> &
 declare const createLogger: (loggerConfig: LoggerConfig) => winston.Logger;
 
 declare class DependsOnMethod {
-    readonly methods: {
-        [K in Method]?: Endpoint<any, any, any, K, any, any, any, any> | Endpoint<any, any, any, Method, any, any, any, any>;
-    };
-    constructor(methods: {
-        [K in Method]?: Endpoint<any, any, any, K, any, any, any, any> | Endpoint<any, any, any, Method, any, any, any, any>;
-    });
+    readonly endpoints: Partial<Record<Method, AbstractEndpoint>>;
+    constructor(endpoints: Partial<Record<Method, AbstractEndpoint>>);
 }
 
 type OriginalStatic = typeof express.static;
@@ -820,7 +805,7 @@ declare const testEndpoint: <REQ extends Partial<Record<keyof Request<express_se
         writableEnded: boolean;
         statusCode: number;
         statusMessage: string;
-    } & Record<"status" | "header" | "set" | "json" | "end" | "send" | "setHeader", jest.Mock<any, any, any>> & (RES extends undefined ? {} : RES);
+    } & Record<"status" | "header" | "set" | "end" | "send" | "json" | "setHeader", jest.Mock<any, any, any>> & (RES extends undefined ? {} : RES);
     loggerMock: Record<"error" | "warn" | "debug" | "info", jest.Mock<any, any, any>> & (LOG extends undefined ? {} : LOG);
 }>;
 
@@ -890,4 +875,4 @@ declare namespace proprietarySchemas {
   };
 }
 
-export { AbstractEndpoint, BasicSecurity, BearerSecurity, CommonConfig, CookieSecurity, CustomHeaderSecurity, DependsOnMethod, DependsOnMethodError, Documentation, DocumentationError, EndpointsFactory, FlatObject, IOSchema, InputSecurity, InputValidationError, Integration, LoggerConfig, Method, MiddlewareDefinition, OAuth2Security, OpenIdSecurity, OutputValidationError, ResultHandlerDefinition, Routing, RoutingError, ServeStatic, ZodDateInDef, ZodDateOutDef, ZodFileDef, ZodUploadDef, arrayEndpointsFactory, arrayResultHandler, attachRouting, createConfig, createLogger, createMiddleware, createResultHandler, createServer, defaultEndpointsFactory, defaultResultHandler, proprietarySchemas as ez, getExamples, getMessageFromError, getStatusCodeFromError, testEndpoint, withMeta };
+export { AbstractEndpoint, BasicSecurity, BearerSecurity, CommonConfig, CookieSecurity, CustomHeaderSecurity, DependsOnMethod, Documentation, DocumentationError, EndpointsFactory, FlatObject, IOSchema, InputSecurity, InputValidationError, Integration, LoggerConfig, Method, MiddlewareDefinition, OAuth2Security, OpenIdSecurity, OutputValidationError, ResultHandlerDefinition, Routing, RoutingError, ServeStatic, ZodDateInDef, ZodDateOutDef, ZodFileDef, ZodUploadDef, arrayEndpointsFactory, arrayResultHandler, attachRouting, createConfig, createLogger, createMiddleware, createResultHandler, createServer, defaultEndpointsFactory, defaultResultHandler, proprietarySchemas as ez, getExamples, getMessageFromError, getStatusCodeFromError, testEndpoint, withMeta };

package/dist/index.d.ts

@@ -1,12 +1,10 @@
 import compression from 'compression';
-import { NextHandleFunction } from 'connect';
-import express, { Request, Response, Express } from 'express';
+import express, { Request, Response, NextFunction, RequestHandler, Express } from 'express';
 import fileUpload, { UploadedFile } from 'express-fileupload';
 import https, { ServerOptions } from 'node:https';
 import winston, { Logger } from 'winston';
 import { z, ZodTypeDef, ZodType, ParseInput, ParseReturnType, ZodError } from 'zod';
 import { HttpError } from 'http-errors';
-export { default as createHttpError } from 'http-errors';
 import * as qs from 'qs';
 import * as express_serve_static_core from 'express-serve-static-core';
 import * as http from 'http';
@@ -112,7 +110,7 @@ interface MiddlewareDefinition<IN extends IOSchema<"strip">, OPT, OUT extends Fl
 }
 type AnyMiddlewareDef = MiddlewareDefinition<any, any, any, any>;
 declare const createMiddleware: <IN extends IOSchema<"strip">, OPT, OUT extends FlatObject, SCO extends string>(props: MiddlewareCreationProps<IN, OPT, OUT, SCO>) => MiddlewareDefinition<IN, OPT, OUT, SCO>;
-type ExpressMiddleware<R extends Request, S extends Response> = (request: R, response: S, next: (error?: any) => void) => void | Promise<void>;
+type ExpressMiddleware<R extends Request, S extends Response> = (request: R, response: S, next: NextFunction) => void | Promise<void>;
 interface ExpressMiddlewareFeatures<R extends Request, S extends Response, OUT extends FlatObject> {
     provider?: (request: R, response: S) => OUT | Promise<OUT>;
     transformer?: (err: Error) => HttpError | Error;
@@ -127,13 +125,8 @@ type IOSchema<U extends z.UnknownKeysParam = any> = z.ZodObject<any, U> | z.ZodU
 type ProbableIntersection<A extends IOSchema<"strip"> | null, B extends IOSchema> = A extends null ? B : A extends IOSchema<"strip"> ? z.ZodIntersection<A, B> : never;
 
 type Method = "get" | "post" | "put" | "delete" | "patch";
-type MethodsDefinition<M extends Method> = {
-    methods: M[];
-} | {
-    method: M;
-};
 
-type FlatObject = Record<string, any>;
+type FlatObject = Record<string, unknown>;
 declare const getMessageFromError: (error: Error) => string;
 declare const getStatusCodeFromError: (error: Error) => number;
 declare const getExamples: <T extends z.ZodTypeAny, V extends "original" | "parsed" | undefined>({ schema, variant, validate, }: {
@@ -153,13 +146,12 @@ declare const getExamples: <T extends z.ZodTypeAny, V extends "original" | "pars
 }) => readonly (V extends "parsed" ? z.output<T> : z.input<T>)[];
 type ErrMessage = Exclude<Parameters<typeof z.ZodString.prototype.email>[0], undefined>;
 
+interface Metadata<T extends z.ZodTypeAny> {
+    examples: z.input<T>[];
+}
 declare const metaProp = "expressZodApiMeta";
 type MetaProp = typeof metaProp;
-type MetaDef<T extends z.ZodTypeAny> = {
-    [K in MetaProp]: {
-        examples: z.input<T>[];
-    };
-};
+type MetaDef<T extends z.ZodTypeAny> = Record<MetaProp, Metadata<T>>;
 type ExampleSetter<T extends z.ZodTypeAny> = (example: z.input<T>) => WithMeta<T>;
 type WithMeta<T extends z.ZodTypeAny> = T & {
     _def: T["_def"] & MetaDef<T>;
@@ -231,7 +223,7 @@ declare class ZodUpload extends ZodType<UploadedFile, ZodUploadDef> {
     static create: () => ZodUpload;
 }
 
-interface OpenAPIContext {
+interface OpenAPIContext extends FlatObject {
     isResponse: boolean;
     serializer: (schema: z.ZodTypeAny) => string;
     getRef: (name: string) => ReferenceObject | undefined;
@@ -244,10 +236,6 @@ interface OpenAPIContext {
 declare class RoutingError extends Error {
     name: string;
 }
-/** @desc An error related to the issues of using DependsOnMethod class */
-declare class DependsOnMethodError extends RoutingError {
-    name: string;
-}
 /**
  * @desc An error related to the generating of the documentation
  * */
@@ -275,9 +263,11 @@ declare class InputValidationError extends IOSchemaError {
 }
 
 interface ResultHandlerParams<RES> {
+    /** null in case of failure to parse or to find the matching endpoint (error: not found) */
+    input: FlatObject | null;
+    /** null in case of errors or failures */
+    output: FlatObject | null;
     error: Error | null;
-    input: any;
-    output: any;
     request: Request;
     response: Response<RES>;
     logger: Logger;
@@ -288,6 +278,7 @@ interface ResultHandlerDefinition<POS extends z.ZodTypeAny, NEG extends z.ZodTyp
     getNegativeResponse: () => NEG | ApiResponse<NEG>;
     handler: ResultHandler<z.output<POS> | z.output<NEG>>;
 }
+type AnyResultHandlerDefinition = ResultHandlerDefinition<z.ZodTypeAny, z.ZodTypeAny>;
 declare const createResultHandler: <POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny>(definition: ResultHandlerDefinition<POS, NEG>) => ResultHandlerDefinition<POS, NEG>;
 declare const defaultResultHandler: ResultHandlerDefinition<z.ZodObject<{
     status: z.ZodLiteral<"success">;
@@ -405,9 +396,9 @@ declare const defaultResultHandler: ResultHandlerDefinition<z.ZodObject<{
  * @desc Responding with array is a bad practice keeping your endpoints from evolving without breaking changes.
  * @desc This handler expects your endpoint to have the property 'items' in the output object schema
  * */
-declare const arrayResultHandler: ResultHandlerDefinition<z.ZodArray<any, "many"> & {
-    _def: z.ZodArrayDef<any> & MetaDef<z.ZodArray<any, "many">>;
-    example: (example: any[]) => z.ZodArray<any, "many"> & any;
+declare const arrayResultHandler: ResultHandlerDefinition<z.ZodArray<z.ZodTypeAny, "many"> & {
+    _def: z.ZodArrayDef<z.ZodTypeAny> & MetaDef<z.ZodArray<z.ZodTypeAny, "many">>;
+    example: (example: any[]) => z.ZodArray<z.ZodTypeAny, "many"> & any;
 }, z.ZodString & {
     _def: z.ZodStringDef & MetaDef<z.ZodString>;
     example: (example: string) => z.ZodString & any;
@@ -441,34 +432,28 @@ declare abstract class AbstractEndpoint {
     abstract _setSiblingMethods(methods: Method[]): void;
     abstract getOperationId(method: Method): string | undefined;
 }
-type EndpointProps<IN extends IOSchema, OUT extends IOSchema, OPT extends FlatObject, M extends Method, POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, SCO extends string, TAG extends string> = {
-    middlewares: AnyMiddlewareDef[];
-    inputSchema: IN;
-    outputSchema: OUT;
-    handler: Handler<z.output<IN>, z.input<OUT>, OPT>;
-    resultHandler: ResultHandlerDefinition<POS, NEG>;
-    description?: string;
-    shortDescription?: string;
-    operationId?: string | ((method: Method) => string);
-} & ({
-    scopes?: SCO[];
-} | {
-    scope?: SCO;
-}) & ({
-    tags?: TAG[];
-} | {
-    tag?: TAG;
-}) & MethodsDefinition<M>;
-declare class Endpoint<IN extends IOSchema, OUT extends IOSchema, OPT extends FlatObject, M extends Method, POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, SCO extends string, TAG extends string> extends AbstractEndpoint {
+declare class Endpoint<IN extends IOSchema, OUT extends IOSchema, OPT extends FlatObject, POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, SCO extends string, TAG extends string> extends AbstractEndpoint {
     #private;
-    constructor({ middlewares, inputSchema, outputSchema, handler, resultHandler, description, shortDescription, ...rest }: EndpointProps<IN, OUT, OPT, M, POS, NEG, SCO, TAG>);
+    constructor({ methods, inputSchema, outputSchema, handler, resultHandler, getOperationId, scopes, middlewares, tags, description: long, shortDescription: short, }: {
+        middlewares?: AnyMiddlewareDef[];
+        inputSchema: IN;
+        outputSchema: OUT;
+        handler: Handler<z.output<IN>, z.input<OUT>, OPT>;
+        resultHandler: ResultHandlerDefinition<POS, NEG>;
+        description?: string;
+        shortDescription?: string;
+        getOperationId?: (method: Method) => string | undefined;
+        methods: Method[];
+        scopes?: SCO[];
+        tags?: TAG[];
+    });
     /**
      * @desc Sets the other methods supported by the same path. Used by Routing in DependsOnMethod case, for options.
      * @deprecated This method is for internal needs of the library, please avoid using it.
      * */
     _setSiblingMethods(methods: Method[]): void;
     getDescription(variant: DescriptionVariant): string | undefined;
-    getMethods(): M[];
+    getMethods(): Method[];
     getSchema(variant: "input"): IN;
     getSchema(variant: "output"): OUT;
     getSchema(variant: "positive"): POS;
@@ -507,7 +492,7 @@ interface ServerConfig {
          * @desc Custom JSON parser.
          * @default express.json()
          * */
-        jsonParser?: NextHandleFunction;
+        jsonParser?: RequestHandler;
         /**
          * @desc Enable or configure uploads handling.
          * @default false
@@ -557,7 +542,7 @@ interface CommonConfig<TAG extends string = string> {
      * @default defaultResultHandler
      * @see defaultResultHandler
      */
-    errorHandler?: ResultHandlerDefinition<any, any>;
+    errorHandler?: AnyResultHandlerDefinition;
     /** @desc Logger configuration or your custom winston logger. */
     logger: LoggerConfig | Logger;
     /**
@@ -580,7 +565,7 @@ interface CommonConfig<TAG extends string = string> {
 }
 declare const createConfig: <TAG extends string, T extends (ServerConfig | AppConfig) & CommonConfig<TAG>>(config: T) => T;
 
-type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<"strip"> | null, OPT extends FlatObject, M extends Method, SCO extends string, TAG extends string> = {
+type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<"strip"> | null, OPT extends FlatObject, SCO extends string, TAG extends string> = {
     input: IN;
     output: OUT;
     handler: Handler<z.output<ProbableIntersection<MIN, IN>>, z.input<OUT>, OPT>;
@@ -588,6 +573,10 @@ type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<
     shortDescription?: string;
     operationId?: string | ((method: Method) => string);
 } & ({
+    method: Method;
+} | {
+    methods: Method[];
+}) & ({
     scopes?: SCO[];
 } | {
     scope?: SCO;
@@ -595,7 +584,7 @@ type BuildProps<IN extends IOSchema, OUT extends IOSchema, MIN extends IOSchema<
     tags?: TAG[];
 } | {
     tag?: TAG;
-}) & MethodsDefinition<M>;
+});
 declare class EndpointsFactory<POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny, IN extends IOSchema<"strip"> | null = null, OUT extends FlatObject = {}, SCO extends string = string, TAG extends string = string> {
     #private;
     protected resultHandler: ResultHandlerDefinition<POS, NEG>;
@@ -610,7 +599,7 @@ declare class EndpointsFactory<POS extends z.ZodTypeAny, NEG extends z.ZodTypeAn
     use: <R extends Request<express_serve_static_core.ParamsDictionary, any, any, qs.ParsedQs, Record<string, any>>, S extends Response<any, Record<string, any>>, AOUT extends FlatObject = {}>(middleware: ExpressMiddleware<R, S>, features?: ExpressMiddlewareFeatures<R, S, AOUT> | undefined) => EndpointsFactory<POS, NEG, IN, OUT & AOUT, SCO, TAG>;
     addExpressMiddleware<R extends Request, S extends Response, AOUT extends FlatObject = {}>(middleware: ExpressMiddleware<R, S>, features?: ExpressMiddlewareFeatures<R, S, AOUT>): EndpointsFactory<POS, NEG, IN, OUT & AOUT, SCO, TAG>;
     addOptions<AOUT extends FlatObject>(options: AOUT): EndpointsFactory<POS, NEG, IN, OUT & AOUT, SCO, TAG>;
-    build<BIN extends IOSchema, BOUT extends IOSchema, M extends Method>({ input, handler, output: outputSchema, ...rest }: BuildProps<BIN, BOUT, IN, OUT, M, SCO, TAG>): Endpoint<ProbableIntersection<IN, BIN>, BOUT, OUT, M, POS, NEG, SCO, TAG>;
+    build<BIN extends IOSchema, BOUT extends IOSchema>({ input, handler, output: outputSchema, description, shortDescription, operationId, ...rest }: BuildProps<BIN, BOUT, IN, OUT, SCO, TAG>): Endpoint<ProbableIntersection<IN, BIN>, BOUT, OUT, POS, NEG, SCO, TAG>;
 }
 declare const defaultEndpointsFactory: EndpointsFactory<z.ZodObject<{
     status: z.ZodLiteral<"success">;
@@ -728,9 +717,9 @@ declare const defaultEndpointsFactory: EndpointsFactory<z.ZodObject<{
  * @desc Responding with array is a bad practice keeping your endpoints from evolving without breaking changes.
  * @desc The result handler of this factory expects your endpoint to have the property 'items' in the output schema
  */
-declare const arrayEndpointsFactory: EndpointsFactory<z.ZodArray<any, "many"> & {
-    _def: z.ZodArrayDef<any> & MetaDef<z.ZodArray<any, "many">>;
-    example: (example: any[]) => z.ZodArray<any, "many"> & any;
+declare const arrayEndpointsFactory: EndpointsFactory<z.ZodArray<z.ZodTypeAny, "many"> & {
+    _def: z.ZodArrayDef<z.ZodTypeAny> & MetaDef<z.ZodArray<z.ZodTypeAny, "many">>;
+    example: (example: any[]) => z.ZodArray<z.ZodTypeAny, "many"> & any;
 }, z.ZodString & {
     _def: z.ZodStringDef & MetaDef<z.ZodString>;
     example: (example: string) => z.ZodString & any;
@@ -739,12 +728,8 @@ declare const arrayEndpointsFactory: EndpointsFactory<z.ZodArray<any, "many"> &
 declare const createLogger: (loggerConfig: LoggerConfig) => winston.Logger;
 
 declare class DependsOnMethod {
-    readonly methods: {
-        [K in Method]?: Endpoint<any, any, any, K, any, any, any, any> | Endpoint<any, any, any, Method, any, any, any, any>;
-    };
-    constructor(methods: {
-        [K in Method]?: Endpoint<any, any, any, K, any, any, any, any> | Endpoint<any, any, any, Method, any, any, any, any>;
-    });
+    readonly endpoints: Partial<Record<Method, AbstractEndpoint>>;
+    constructor(endpoints: Partial<Record<Method, AbstractEndpoint>>);
 }
 
 type OriginalStatic = typeof express.static;
@@ -820,7 +805,7 @@ declare const testEndpoint: <REQ extends Partial<Record<keyof Request<express_se
         writableEnded: boolean;
         statusCode: number;
         statusMessage: string;
-    } & Record<"status" | "header" | "set" | "json" | "end" | "send" | "setHeader", jest.Mock<any, any, any>> & (RES extends undefined ? {} : RES);
+    } & Record<"status" | "header" | "set" | "end" | "send" | "json" | "setHeader", jest.Mock<any, any, any>> & (RES extends undefined ? {} : RES);
     loggerMock: Record<"error" | "warn" | "debug" | "info", jest.Mock<any, any, any>> & (LOG extends undefined ? {} : LOG);
 }>;
 
@@ -890,4 +875,4 @@ declare namespace proprietarySchemas {
   };
 }
 
-export { AbstractEndpoint, BasicSecurity, BearerSecurity, CommonConfig, CookieSecurity, CustomHeaderSecurity, DependsOnMethod, DependsOnMethodError, Documentation, DocumentationError, EndpointsFactory, FlatObject, IOSchema, InputSecurity, InputValidationError, Integration, LoggerConfig, Method, MiddlewareDefinition, OAuth2Security, OpenIdSecurity, OutputValidationError, ResultHandlerDefinition, Routing, RoutingError, ServeStatic, ZodDateInDef, ZodDateOutDef, ZodFileDef, ZodUploadDef, arrayEndpointsFactory, arrayResultHandler, attachRouting, createConfig, createLogger, createMiddleware, createResultHandler, createServer, defaultEndpointsFactory, defaultResultHandler, proprietarySchemas as ez, getExamples, getMessageFromError, getStatusCodeFromError, testEndpoint, withMeta };
+export { AbstractEndpoint, BasicSecurity, BearerSecurity, CommonConfig, CookieSecurity, CustomHeaderSecurity, DependsOnMethod, Documentation, DocumentationError, EndpointsFactory, FlatObject, IOSchema, InputSecurity, InputValidationError, Integration, LoggerConfig, Method, MiddlewareDefinition, OAuth2Security, OpenIdSecurity, OutputValidationError, ResultHandlerDefinition, Routing, RoutingError, ServeStatic, ZodDateInDef, ZodDateOutDef, ZodFileDef, ZodUploadDef, arrayEndpointsFactory, arrayResultHandler, attachRouting, createConfig, createLogger, createMiddleware, createResultHandler, createServer, defaultEndpointsFactory, defaultResultHandler, proprietarySchemas as ez, getExamples, getMessageFromError, getStatusCodeFromError, testEndpoint, withMeta };