express-zod-api 22.12.0-beta.1 → 22.13.0

package/dist/index.d.cts

@@ -69,7 +69,7 @@ declare class BuiltinLogger implements AbstractLogger {
     protected readonly config: BuiltinLoggerConfig;
     /** @example new BuiltinLogger({ level: "debug", color: true, depth: 4 }) */
     constructor({ color, level, depth, ctx, }?: Partial<BuiltinLoggerConfig>);
-    protected prettyPrint(subject: unknown): string;
+    protected format(subject: unknown): string;
     protected print(method: Severity, message: string, meta?: unknown): void;
     debug(message: string, meta?: unknown): void;
     info(message: string, meta?: unknown): void;
@@ -116,6 +116,10 @@ interface NormalizedResponse {
     mimeTypes: [string, ...string[]] | null;
 }
 
+/** @desc Accepts an object shape or a custom object schema */
+declare const form: <S extends z.ZodRawShape>(base: S | z.ZodObject<S>) => z.ZodBranded<z.ZodObject<S, z.UnknownKeysParam, z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<S>, any> extends infer T ? { [k in keyof T]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<S>, any>[k]; } : never, z.baseObjectInputType<S> extends infer T_1 ? { [k_1 in keyof T_1]: z.baseObjectInputType<S>[k_1]; } : never>, symbol>;
+type FormSchema = ReturnType<typeof form>;
+
 type LogicalOr<T> = {
     or: T[];
 };
@@ -199,10 +203,18 @@ interface OAuth2Security<S extends string> {
 type Security<K extends string = string, S extends string = string> = BasicSecurity | BearerSecurity | InputSecurity<K> | CustomHeaderSecurity | CookieSecurity | OpenIdSecurity | OAuth2Security<S>;
 
 type Handler$2<IN, OPT, OUT> = (params: {
+    /** @desc The inputs from the enabled input sources validated against final input schema of the Middleware */
     input: IN;
+    /**
+     * @desc The returns of the previously executed Middlewares (typed when chaining Middlewares)
+     * @link https://github.com/RobinTail/express-zod-api/discussions/1250
+     * */
     options: OPT;
+    /** @link https://expressjs.com/en/5x/api.html#req */
     request: Request;
+    /** @link https://expressjs.com/en/5x/api.html#res */
     response: Response;
+    /** @desc The instance of the configured logger */
     logger: ActualLogger;
 }) => Promise<OUT>;
 declare abstract class AbstractMiddleware {
@@ -219,8 +231,15 @@ declare abstract class AbstractMiddleware {
 declare class Middleware<OPT extends FlatObject, OUT extends FlatObject, SCO extends string, IN extends IOSchema<"strip"> = EmptySchema> extends AbstractMiddleware {
     #private;
     constructor({ input, security, handler, }: {
+        /**
+         * @desc Input schema of the Middleware, combining properties from all the enabled input sources
+         * @default z.object({})
+         * @see defaultInputSources
+         * */
         input?: IN;
+        /** @desc Declaration of the security schemas implemented within the handler */
         security?: LogicalContainer<Security<Extract<keyof z.input<IN>, string>, SCO>>;
+        /** @desc The handler returning options available to Endpoints */
         handler: Handler$2<z.output<IN>, OPT, OUT>;
     });
     getSecurity(): LogicalContainer<Security<Extract<keyof z.input<IN>, string>, SCO>> | undefined;
@@ -263,7 +282,7 @@ type EffectsChain<U extends z.UnknownKeysParam> = ObjectBasedEffect<BaseObject<U
  * @desc The type allowed on the top level of Middlewares and Endpoints
  * @param U — only "strip" is allowed for Middlewares due to intersection issue (Zod) #600
  * */
-type IOSchema<U extends z.UnknownKeysParam = z.UnknownKeysParam> = BaseObject<U> | EffectsChain<U> | RawSchema | z.ZodUnion<[IOSchema<U>, ...IOSchema<U>[]]> | z.ZodIntersection<IOSchema<U>, IOSchema<U>> | z.ZodDiscriminatedUnion<string, BaseObject<U>[]> | z.ZodPipeline<ObjectBasedEffect<BaseObject<U>>, BaseObject<U>>;
+type IOSchema<U extends z.UnknownKeysParam = z.UnknownKeysParam> = BaseObject<U> | EffectsChain<U> | RawSchema | FormSchema | z.ZodUnion<[IOSchema<U>, ...IOSchema<U>[]]> | z.ZodIntersection<IOSchema<U>, IOSchema<U>> | z.ZodDiscriminatedUnion<string, BaseObject<U>[]> | z.ZodPipeline<ObjectBasedEffect<BaseObject<U>>, BaseObject<U>>;
 
 declare const methods: ("get" | "post" | "put" | "delete" | "patch")[];
 type Method = (typeof methods)[number];
@@ -273,6 +292,7 @@ declare const contentTypes: {
     upload: string;
     raw: string;
     sse: string;
+    form: string;
 };
 type ContentType = keyof typeof contentTypes;
 
@@ -384,8 +404,11 @@ declare abstract class Routable {
 }
 
 type Handler<IN, OUT, OPT> = (params: {
+    /** @desc The inputs from the enabled input sources validated against the final input schema (incl. Middlewares) */
     input: IN;
+    /** @desc The returns of the assigned Middlewares */
     options: OPT;
+    /** @desc The instance of the configured logger */
     logger: ActualLogger;
 }) => Promise<OUT>;
 type DescriptionVariant = "short" | "long";
@@ -430,7 +453,7 @@ declare class Endpoint<IN extends IOSchema, OUT extends IOSchema, OPT extends Fl
     getMethods(): Readonly<("get" | "post" | "put" | "delete" | "patch")[] | undefined>;
     getSchema(variant: "input"): IN;
     getSchema(variant: "output"): OUT;
-    getRequestType(): "json" | "upload" | "raw";
+    getRequestType(): "form" | "json" | "upload" | "raw";
     getResponses(variant: ResponseVariant): readonly NormalizedResponse[];
     getSecurity(): LogicalContainer<Security>[];
     getScopes(): readonly string[];
@@ -458,6 +481,7 @@ type ChildLoggerProvider = (params: {
     request: Request;
     parent: ActualLogger;
 }) => ActualLogger | Promise<ActualLogger>;
+type LogAccess = (request: Request, logger: ActualLogger) => void;
 interface CommonConfig {
     /**
      * @desc Enables cross-origin resource sharing.
@@ -490,6 +514,12 @@ interface CommonConfig {
      * @example ({ parent }) => parent.child({ requestId: uuid() })
      * */
     childLoggerProvider?: ChildLoggerProvider;
+    /**
+     * @desc The function for producing access logs
+     * @default ({ method, path }, logger) => logger.debug(`${method}: ${path}`)
+     * @example null — disables the feature
+     * */
+    accessLogger?: null | LogAccess;
     /**
      * @desc You can disable the startup logo.
      * @default true
@@ -517,7 +547,6 @@ type UploadOptions = Pick<express_fileupload__default.Options, "createParentPath
     limitError?: Error;
     /**
      * @desc A handler to execute before uploading — it can be used for restrictions by throwing an error.
-     * @default undefined
      * @example ({ request }) => { throw createHttpError(403, "Not authorized"); }
      * */
     beforeUpload?: BeforeUpload;
@@ -562,13 +591,11 @@ interface ServerConfig extends CommonConfig {
     jsonParser?: RequestHandler;
     /**
      * @desc Enable or configure uploads handling.
-     * @default undefined
      * @requires express-fileupload
      * */
     upload?: boolean | UploadOptions;
     /**
      * @desc Enable or configure response compression.
-     * @default undefined
      * @requires compression
      */
     compression?: boolean | CompressionOptions;
@@ -578,17 +605,21 @@ interface ServerConfig extends CommonConfig {
      * @link https://expressjs.com/en/4x/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
+     * */
+    formParser?: RequestHandler;
     /**
      * @desc A code to execute before processing the Routing of your API (and before parsing).
      * @desc This can be a good place for express middlewares establishing their own routes.
      * @desc It can help to avoid making a DIY solution based on the attachRouting() approach.
-     * @default undefined
      * @example ({ app }) => { app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); }
      * */
     beforeRouting?: BeforeRouting;
     /**
      * @desc Rejects new connections and attempts to finish ongoing ones in the specified time before exit.
-     * @default undefined
      * */
     gracefulShutdown?: boolean | GracefulOptions;
 }
@@ -684,15 +715,39 @@ declare module "zod" {
 }
 
 interface BuildProps<IN extends IOSchema, OUT extends IOSchema | z.ZodVoid, MIN extends IOSchema<"strip">, OPT extends FlatObject, SCO extends string> {
+    /**
+     * @desc Input schema of the Endpoint, combining properties from all the enabled input sources (path params, headers)
+     * @default z.object({})
+     * @see defaultInputSources
+     * */
     input?: IN;
+    /** @desc The schema by which the returns of the Endpoint handler is validated */
     output: OUT;
+    /** @desc The Endpoint handler receiving the validated inputs, returns of added Middlewares (options) and a logger */
     handler: Handler<z.output<z.ZodIntersection<MIN, IN>>, z.input<OUT>, OPT>;
+    /** @desc The operation description for the generated Documentation */
     description?: string;
+    /** @desc The operation summary for the generated Documentation (50 symbols max) */
     shortDescription?: string;
+    /** @desc The operation ID for the generated Documentation (must be unique) */
     operationId?: string | ((method: Method) => string);
+    /**
+     * @desc HTTP method(s) this endpoint can handle
+     * @default "get" unless the Endpoint is assigned within DependsOnMethod
+     * @see DependsOnMethod
+     * */
     method?: Method | [Method, ...Method[]];
+    /**
+     * @desc Scope(s) from the list of the ones defined by the added Middlewares having "oauth2" security type
+     * @see OAuth2Security
+     * */
     scope?: SCO | SCO[];
+    /**
+     * @desc Tag(s) for generating Documentation. For establishing constraints:
+     * @see TagOverrides
+     * */
     tag?: Tag | Tag[];
+    /** @desc Marks the operation deprecated in the generated Documentation */
     deprecated?: boolean;
 }
 declare class EndpointsFactory<IN extends IOSchema<"strip"> = EmptySchema, OUT extends FlatObject = EmptyObject, SCO extends string = string> {
@@ -743,6 +798,7 @@ declare function file<K extends Variant>(variant: K): ReturnType<Variants[K]>;
 declare const ez: {
     dateIn: () => zod.ZodBranded<zod.ZodPipeline<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodString, zod.ZodString]>, Date, string>, zod.ZodEffects<zod.ZodDate, Date, Date>>, symbol>;
     dateOut: () => zod.ZodBranded<zod.ZodEffects<zod.ZodEffects<zod.ZodDate, Date, Date>, string, Date>, symbol>;
+    form: <S extends zod.ZodRawShape>(base: S | zod.ZodObject<S>) => zod.ZodBranded<zod.ZodObject<S, zod.UnknownKeysParam, zod.ZodTypeAny, zod.objectUtil.addQuestionMarks<zod.baseObjectOutputType<S>, any> extends infer T ? { [k in keyof T]: zod.objectUtil.addQuestionMarks<zod.baseObjectOutputType<S>, any>[k]; } : never, zod.baseObjectInputType<S> extends infer T_1 ? { [k_1 in keyof T_1]: zod.baseObjectInputType<S>[k_1]; } : never>, symbol>;
     file: typeof file;
     upload: () => zod.ZodBranded<zod.ZodType<express_fileupload.UploadedFile, zod.ZodTypeDef, express_fileupload.UploadedFile>, symbol>;
     raw: <S extends zod.ZodRawShape>(extra?: S) => zod.ZodBranded<zod.ZodObject<zod.objectUtil.extendShape<{
@@ -912,7 +968,10 @@ declare const testMiddleware: <LOG extends FlatObject, REQ extends RequestOption
     middleware: AbstractMiddleware;
     /** @desc The aggregated output from previously executed middlewares */
     options?: FlatObject;
-    /** @desc Enables transforming possible middleware errors into response, so that test Middleware does not throw */
+    /**
+     * @desc Enables transforming possible middleware errors into response, so that test Middleware does not throw
+     * @todo consider utilizing errorHandler from config instead in v23
+     * */
     errorHandler?: (error: Error, response: Response) => void;
 }) => Promise<{
     requestMock: node_mocks_http.MockRequest<Request<express_serve_static_core.ParamsDictionary, any, any, qs.ParsedQs, Record<string, any>> & REQ>;
@@ -1070,7 +1129,7 @@ type EventsMap = Record<string, z.ZodTypeAny>;
 interface Emitter<E extends EventsMap> extends FlatObject {
     /** @desc Returns true when the connection was closed or terminated */
     isClosed: () => boolean;
-    /** @desc Sends an event to the stream accordin to the declared schema */
+    /** @desc Sends an event to the stream according to the declared schema */
     emit: <K extends keyof E>(event: K, data: z.input<E[K]>) => void;
 }
 declare class EventStreamFactory<E extends EventsMap> extends EndpointsFactory<EmptySchema, Emitter<E>> {

package/dist/index.d.ts

@@ -69,7 +69,7 @@ declare class BuiltinLogger implements AbstractLogger {
     protected readonly config: BuiltinLoggerConfig;
     /** @example new BuiltinLogger({ level: "debug", color: true, depth: 4 }) */
     constructor({ color, level, depth, ctx, }?: Partial<BuiltinLoggerConfig>);
-    protected prettyPrint(subject: unknown): string;
+    protected format(subject: unknown): string;
     protected print(method: Severity, message: string, meta?: unknown): void;
     debug(message: string, meta?: unknown): void;
     info(message: string, meta?: unknown): void;
@@ -116,6 +116,10 @@ interface NormalizedResponse {
     mimeTypes: [string, ...string[]] | null;
 }
 
+/** @desc Accepts an object shape or a custom object schema */
+declare const form: <S extends z.ZodRawShape>(base: S | z.ZodObject<S>) => z.ZodBranded<z.ZodObject<S, z.UnknownKeysParam, z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<S>, any> extends infer T ? { [k in keyof T]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<S>, any>[k]; } : never, z.baseObjectInputType<S> extends infer T_1 ? { [k_1 in keyof T_1]: z.baseObjectInputType<S>[k_1]; } : never>, symbol>;
+type FormSchema = ReturnType<typeof form>;
+
 type LogicalOr<T> = {
     or: T[];
 };
@@ -199,10 +203,18 @@ interface OAuth2Security<S extends string> {
 type Security<K extends string = string, S extends string = string> = BasicSecurity | BearerSecurity | InputSecurity<K> | CustomHeaderSecurity | CookieSecurity | OpenIdSecurity | OAuth2Security<S>;
 
 type Handler$2<IN, OPT, OUT> = (params: {
+    /** @desc The inputs from the enabled input sources validated against final input schema of the Middleware */
     input: IN;
+    /**
+     * @desc The returns of the previously executed Middlewares (typed when chaining Middlewares)
+     * @link https://github.com/RobinTail/express-zod-api/discussions/1250
+     * */
     options: OPT;
+    /** @link https://expressjs.com/en/5x/api.html#req */
     request: Request;
+    /** @link https://expressjs.com/en/5x/api.html#res */
     response: Response;
+    /** @desc The instance of the configured logger */
     logger: ActualLogger;
 }) => Promise<OUT>;
 declare abstract class AbstractMiddleware {
@@ -219,8 +231,15 @@ declare abstract class AbstractMiddleware {
 declare class Middleware<OPT extends FlatObject, OUT extends FlatObject, SCO extends string, IN extends IOSchema<"strip"> = EmptySchema> extends AbstractMiddleware {
     #private;
     constructor({ input, security, handler, }: {
+        /**
+         * @desc Input schema of the Middleware, combining properties from all the enabled input sources
+         * @default z.object({})
+         * @see defaultInputSources
+         * */
         input?: IN;
+        /** @desc Declaration of the security schemas implemented within the handler */
         security?: LogicalContainer<Security<Extract<keyof z.input<IN>, string>, SCO>>;
+        /** @desc The handler returning options available to Endpoints */
         handler: Handler$2<z.output<IN>, OPT, OUT>;
     });
     getSecurity(): LogicalContainer<Security<Extract<keyof z.input<IN>, string>, SCO>> | undefined;
@@ -263,7 +282,7 @@ type EffectsChain<U extends z.UnknownKeysParam> = ObjectBasedEffect<BaseObject<U
  * @desc The type allowed on the top level of Middlewares and Endpoints
  * @param U — only "strip" is allowed for Middlewares due to intersection issue (Zod) #600
  * */
-type IOSchema<U extends z.UnknownKeysParam = z.UnknownKeysParam> = BaseObject<U> | EffectsChain<U> | RawSchema | z.ZodUnion<[IOSchema<U>, ...IOSchema<U>[]]> | z.ZodIntersection<IOSchema<U>, IOSchema<U>> | z.ZodDiscriminatedUnion<string, BaseObject<U>[]> | z.ZodPipeline<ObjectBasedEffect<BaseObject<U>>, BaseObject<U>>;
+type IOSchema<U extends z.UnknownKeysParam = z.UnknownKeysParam> = BaseObject<U> | EffectsChain<U> | RawSchema | FormSchema | z.ZodUnion<[IOSchema<U>, ...IOSchema<U>[]]> | z.ZodIntersection<IOSchema<U>, IOSchema<U>> | z.ZodDiscriminatedUnion<string, BaseObject<U>[]> | z.ZodPipeline<ObjectBasedEffect<BaseObject<U>>, BaseObject<U>>;
 
 declare const methods: ("get" | "post" | "put" | "delete" | "patch")[];
 type Method = (typeof methods)[number];
@@ -273,6 +292,7 @@ declare const contentTypes: {
     upload: string;
     raw: string;
     sse: string;
+    form: string;
 };
 type ContentType = keyof typeof contentTypes;
 
@@ -384,8 +404,11 @@ declare abstract class Routable {
 }
 
 type Handler<IN, OUT, OPT> = (params: {
+    /** @desc The inputs from the enabled input sources validated against the final input schema (incl. Middlewares) */
     input: IN;
+    /** @desc The returns of the assigned Middlewares */
     options: OPT;
+    /** @desc The instance of the configured logger */
     logger: ActualLogger;
 }) => Promise<OUT>;
 type DescriptionVariant = "short" | "long";
@@ -430,7 +453,7 @@ declare class Endpoint<IN extends IOSchema, OUT extends IOSchema, OPT extends Fl
     getMethods(): Readonly<("get" | "post" | "put" | "delete" | "patch")[] | undefined>;
     getSchema(variant: "input"): IN;
     getSchema(variant: "output"): OUT;
-    getRequestType(): "json" | "upload" | "raw";
+    getRequestType(): "form" | "json" | "upload" | "raw";
     getResponses(variant: ResponseVariant): readonly NormalizedResponse[];
     getSecurity(): LogicalContainer<Security>[];
     getScopes(): readonly string[];
@@ -458,6 +481,7 @@ type ChildLoggerProvider = (params: {
     request: Request;
     parent: ActualLogger;
 }) => ActualLogger | Promise<ActualLogger>;
+type LogAccess = (request: Request, logger: ActualLogger) => void;
 interface CommonConfig {
     /**
      * @desc Enables cross-origin resource sharing.
@@ -490,6 +514,12 @@ interface CommonConfig {
      * @example ({ parent }) => parent.child({ requestId: uuid() })
      * */
     childLoggerProvider?: ChildLoggerProvider;
+    /**
+     * @desc The function for producing access logs
+     * @default ({ method, path }, logger) => logger.debug(`${method}: ${path}`)
+     * @example null — disables the feature
+     * */
+    accessLogger?: null | LogAccess;
     /**
      * @desc You can disable the startup logo.
      * @default true
@@ -517,7 +547,6 @@ type UploadOptions = Pick<express_fileupload__default.Options, "createParentPath
     limitError?: Error;
     /**
      * @desc A handler to execute before uploading — it can be used for restrictions by throwing an error.
-     * @default undefined
      * @example ({ request }) => { throw createHttpError(403, "Not authorized"); }
      * */
     beforeUpload?: BeforeUpload;
@@ -562,13 +591,11 @@ interface ServerConfig extends CommonConfig {
     jsonParser?: RequestHandler;
     /**
      * @desc Enable or configure uploads handling.
-     * @default undefined
      * @requires express-fileupload
      * */
     upload?: boolean | UploadOptions;
     /**
      * @desc Enable or configure response compression.
-     * @default undefined
      * @requires compression
      */
     compression?: boolean | CompressionOptions;
@@ -578,17 +605,21 @@ interface ServerConfig extends CommonConfig {
      * @link https://expressjs.com/en/4x/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
+     * */
+    formParser?: RequestHandler;
     /**
      * @desc A code to execute before processing the Routing of your API (and before parsing).
      * @desc This can be a good place for express middlewares establishing their own routes.
      * @desc It can help to avoid making a DIY solution based on the attachRouting() approach.
-     * @default undefined
      * @example ({ app }) => { app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); }
      * */
     beforeRouting?: BeforeRouting;
     /**
      * @desc Rejects new connections and attempts to finish ongoing ones in the specified time before exit.
-     * @default undefined
      * */
     gracefulShutdown?: boolean | GracefulOptions;
 }
@@ -684,15 +715,39 @@ declare module "zod" {
 }
 
 interface BuildProps<IN extends IOSchema, OUT extends IOSchema | z.ZodVoid, MIN extends IOSchema<"strip">, OPT extends FlatObject, SCO extends string> {
+    /**
+     * @desc Input schema of the Endpoint, combining properties from all the enabled input sources (path params, headers)
+     * @default z.object({})
+     * @see defaultInputSources
+     * */
     input?: IN;
+    /** @desc The schema by which the returns of the Endpoint handler is validated */
     output: OUT;
+    /** @desc The Endpoint handler receiving the validated inputs, returns of added Middlewares (options) and a logger */
     handler: Handler<z.output<z.ZodIntersection<MIN, IN>>, z.input<OUT>, OPT>;
+    /** @desc The operation description for the generated Documentation */
     description?: string;
+    /** @desc The operation summary for the generated Documentation (50 symbols max) */
     shortDescription?: string;
+    /** @desc The operation ID for the generated Documentation (must be unique) */
     operationId?: string | ((method: Method) => string);
+    /**
+     * @desc HTTP method(s) this endpoint can handle
+     * @default "get" unless the Endpoint is assigned within DependsOnMethod
+     * @see DependsOnMethod
+     * */
     method?: Method | [Method, ...Method[]];
+    /**
+     * @desc Scope(s) from the list of the ones defined by the added Middlewares having "oauth2" security type
+     * @see OAuth2Security
+     * */
     scope?: SCO | SCO[];
+    /**
+     * @desc Tag(s) for generating Documentation. For establishing constraints:
+     * @see TagOverrides
+     * */
     tag?: Tag | Tag[];
+    /** @desc Marks the operation deprecated in the generated Documentation */
     deprecated?: boolean;
 }
 declare class EndpointsFactory<IN extends IOSchema<"strip"> = EmptySchema, OUT extends FlatObject = EmptyObject, SCO extends string = string> {
@@ -743,6 +798,7 @@ declare function file<K extends Variant>(variant: K): ReturnType<Variants[K]>;
 declare const ez: {
     dateIn: () => zod.ZodBranded<zod.ZodPipeline<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodString, zod.ZodString]>, Date, string>, zod.ZodEffects<zod.ZodDate, Date, Date>>, symbol>;
     dateOut: () => zod.ZodBranded<zod.ZodEffects<zod.ZodEffects<zod.ZodDate, Date, Date>, string, Date>, symbol>;
+    form: <S extends zod.ZodRawShape>(base: S | zod.ZodObject<S>) => zod.ZodBranded<zod.ZodObject<S, zod.UnknownKeysParam, zod.ZodTypeAny, zod.objectUtil.addQuestionMarks<zod.baseObjectOutputType<S>, any> extends infer T ? { [k in keyof T]: zod.objectUtil.addQuestionMarks<zod.baseObjectOutputType<S>, any>[k]; } : never, zod.baseObjectInputType<S> extends infer T_1 ? { [k_1 in keyof T_1]: zod.baseObjectInputType<S>[k_1]; } : never>, symbol>;
     file: typeof file;
     upload: () => zod.ZodBranded<zod.ZodType<express_fileupload.UploadedFile, zod.ZodTypeDef, express_fileupload.UploadedFile>, symbol>;
     raw: <S extends zod.ZodRawShape>(extra?: S) => zod.ZodBranded<zod.ZodObject<zod.objectUtil.extendShape<{
@@ -912,7 +968,10 @@ declare const testMiddleware: <LOG extends FlatObject, REQ extends RequestOption
     middleware: AbstractMiddleware;
     /** @desc The aggregated output from previously executed middlewares */
     options?: FlatObject;
-    /** @desc Enables transforming possible middleware errors into response, so that test Middleware does not throw */
+    /**
+     * @desc Enables transforming possible middleware errors into response, so that test Middleware does not throw
+     * @todo consider utilizing errorHandler from config instead in v23
+     * */
     errorHandler?: (error: Error, response: Response) => void;
 }) => Promise<{
     requestMock: node_mocks_http.MockRequest<Request<express_serve_static_core.ParamsDictionary, any, any, qs.ParsedQs, Record<string, any>> & REQ>;
@@ -1070,7 +1129,7 @@ type EventsMap = Record<string, z.ZodTypeAny>;
 interface Emitter<E extends EventsMap> extends FlatObject {
     /** @desc Returns true when the connection was closed or terminated */
     isClosed: () => boolean;
-    /** @desc Sends an event to the stream accordin to the declared schema */
+    /** @desc Sends an event to the stream according to the declared schema */
     emit: <K extends keyof E>(event: K, data: z.input<E[K]>) => void;
 }
 declare class EventStreamFactory<E extends EventsMap> extends EndpointsFactory<EmptySchema, Emitter<E>> {