express-zod-api 3.1.2 → 4.2.0

package/CHANGELOG.md

@@ -1,7 +1,54 @@
 # Changelog
 
+## Version 4
+
+### v4.2.0
+
+- `express` version is 4.17.2.
+- `http-errors` version is 2.0.0.
+
+### v4.1.0
+
+- Feature #230. The shorthand method `EndpointsFactory::addOptions()`.
+  - You may find it useful in case you'd like to provide your Endpoint's handler with some entities that do not depend
+    on Request, maybe a database connection instance of similar.
+  - Under the hood the method creates a middleware with an empty input and attaches it to the factory.
+  - The argument supplied to the method is available within `options` parameter of the Endpoint's `handler`.
+
+```typescript
+import { defaultEndpointsFactory } from "express-zod-api";
+
+const newFactory = defaultEndpointsFactory.addOptions({
+  db: mongoose.connect("mongodb://connection.string"),
+  privateKey: fs.readFileSync("private-key.pem", "utf-8"),
+});
+
+const endpoint = newFactory.build({
+  method: "get",
+  input: z.object({}),
+  output: z.object({}),
+  handler: async ({ options }) => {
+    return {}; // options: { db, privateKey }
+  },
+});
+```
+
+### v4.0.0
+
+- The deprecated parameter `type` of `EndpointsFactory::build({...})` has been removed.
+- The OpenAPI generator now requires `config` parameter to be supplied in `new OpenAPI({...})`.
+- The OpenAPI generator takes into account possibly customized `inputSources` from `config`.
+
 ## Version 3
 
+### v3.2.0
+
+- Feature #204. Detecting usage of `z.upload()` within Endpoint's input schema automatically.
+  - There is no longer need to specify `type: "upload"` for `EndpointsFactory::build({...})`.
+  - In case you are using `z.upload()` in endpoint's input schema, inputs will be parsed by the
+    `multipart/form-data` parser.
+  - The optional parameter `type?: "json" | "upload"` of `build({...})` is deprecated.
+
 ### v3.1.2
 
 - Fixed issue #202, originally reported in PR #201.

package/README.md

@@ -27,24 +27,25 @@ Start your API server with I/O schema validation and custom middlewares in minut
    7. [Try it](#try-it)
 4. [Fascinating features](#fascinating-features)
    1. [Middlewares](#middlewares)
-   2. [Refinements](#refinements)
-   3. [Transformations](#transformations)
-   4. [Route path params](#route-path-params)
-   5. [Response customization](#response-customization)
-   6. [Non-object response](#non-object-response) including file downloads
-   7. [File uploads](#file-uploads)
-   8. [Customizing logger](#customizing-logger)
-   9. [Usage with your own express app](#usage-with-your-own-express-app)
-   10. [Multiple schemas for one route](#multiple-schemas-for-one-route)
-   11. [Customizing input sources](#customizing-input-sources)
-   12. [Exporting endpoint types to frontend](#exporting-endpoint-types-to-frontend)
-   13. [Creating a documentation](#creating-a-documentation)
+   2. [Options](#options)
+   3. [Refinements](#refinements)
+   4. [Transformations](#transformations)
+   5. [Route path params](#route-path-params)
+   6. [Response customization](#response-customization)
+   7. [Non-object response](#non-object-response) including file downloads
+   8. [File uploads](#file-uploads)
+   9. [Customizing logger](#customizing-logger)
+   10. [Usage with your own express app](#usage-with-your-own-express-app)
+   11. [Multiple schemas for one route](#multiple-schemas-for-one-route)
+   12. [Customizing input sources](#customizing-input-sources)
+   13. [Exporting endpoint types to frontend](#exporting-endpoint-types-to-frontend)
+   14. [Creating a documentation](#creating-a-documentation)
 5. [Known issues](#known-issues)
    1. [Excessive properties in endpoint output](#excessive-properties-in-endpoint-output)
 6. [Your input to my output](#your-input-to-my-output)
 
 You can find the release notes in [Changelog](CHANGELOG.md). Along with recommendations for migrating from
-[from v2](CHANGELOG.md#v300-beta1) and [from v1](CHANGELOG.md#v200-beta1).
+[v3](CHANGELOG.md#v400), [v2](CHANGELOG.md#v300-beta1) and [v1](CHANGELOG.md#v200-beta1).
 
 # Why and what is it for
 
@@ -265,6 +266,20 @@ const endpointsFactory = defaultEndpointsFactory.addMiddleware(authMiddleware);
 
 You can connect as many middlewares as you want, they will be executed in order.
 
+## Options
+
+In case you'd like to provide your endpoints with options that do not depend on Request, like database connection
+instance, consider shorthand method `addOptions`.
+
+```typescript
+import { defaultEndpointsFactory } from "express-zod-api";
+
+const endpointsFactory = defaultEndpointsFactory.addOptions({
+  db: mongoose.connect("mongodb://connection.string"),
+  privateKey: fs.readFileSync("private-key.pem", "utf-8"),
+});
+```
+
 ## Refinements
 
 By the way, you can implement additional validation within schema.
@@ -443,8 +458,8 @@ const fileStreamingEndpointsFactory = new EndpointsFactory(
 
 ## File uploads
 
-You can switch the `Endpoint` to handle requests with the `multipart/formdata` content type instead of JSON.
-Together with a corresponding configuration option, this makes it possible to handle file uploads.
+You can switch the `Endpoint` to handle requests with the `multipart/form-data` content type instead of JSON by using
+`z.upload()` schema. Together with a corresponding configuration option, this makes it possible to handle file uploads.
 Here is a simplified example:
 
 ```typescript
@@ -459,9 +474,8 @@ const config = createConfig({
 
 const fileUploadEndpoint = defaultEndpointsFactory.build({
   method: "post",
-  type: "upload", // <- required
   input: z.object({
-    avatar: z.upload(),
+    avatar: z.upload(), // <--
   }),
   output: z.object({
     /* ... */
@@ -469,9 +483,6 @@ const fileUploadEndpoint = defaultEndpointsFactory.build({
   handler: async ({ input: { avatar } }) => {
     // avatar: {name, mv(), mimetype, data, size, etc}
     // avatar.truncated is true on failure
-    return {
-      /* ... */
-    };
   },
 });
 ```
@@ -589,7 +600,8 @@ You can generate the specification of your API and write it to a `.yaml` file, t
 import { OpenAPI } from "express-zod-api";
 
 const yamlString = new OpenAPI({
-  routing,
+  routing, // the same routing and config that you use to start the server
+  config,
   version: "1.2.3",
   title: "Example API",
   serverUrl: "https://example.com",

package/SECURITY.md

@@ -4,6 +4,7 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 4.x.x   | :white_check_mark: |
 | 3.x.x   | :white_check_mark: |
 | 2.x.x   | :white_check_mark: |
 | 1.x.x   | :x:                |

package/dist/common-helpers.d.ts

@@ -1,6 +1,6 @@
 import { Request } from "express";
 import { z } from "zod";
-import { CommonConfig, LoggerConfig } from "./config-type";
+import { CommonConfig, InputSources, LoggerConfig } from "./config-type";
 import { MiddlewareDefinition } from "./middleware";
 export declare type FlatObject = Record<string, any>;
 declare type ObjectSchema = z.AnyZodObject;
@@ -24,6 +24,7 @@ export declare type ReplaceMarkerInShape<S extends z.ZodRawShape, OUT extends IO
 };
 export declare function extractObjectSchema(subject: IOSchema): ObjectSchema;
 export declare function combineEndpointAndMiddlewareInputSchemas<IN extends IOSchema, MwIN>(input: IN, middlewares: MiddlewareDefinition<IOSchema, any, any>[]): Merge<IN, MwIN>;
+export declare const defaultInputSources: InputSources;
 export declare function getInitialInput(request: Request, inputAssignment: CommonConfig["inputSources"]): any;
 export declare function isLoggerConfig(logger: any): logger is LoggerConfig;
 export declare function getMessageFromError(error: Error): string;
@@ -38,6 +39,7 @@ export declare const combinations: <T extends unknown>(a: T[], b: T[]) => {
     value: [T, T][];
 };
 export declare function getRoutePathParams(path: string): string[];
+export declare function hasUpload(schema: z.ZodTypeAny): boolean;
 export declare type ErrMessage = Exclude<Parameters<typeof z.ZodString.prototype.email>[0], undefined>;
 export declare const errToObj: (message: ErrMessage | undefined) => {
     message?: string | undefined;

package/dist/common-helpers.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errToObj = exports.getRoutePathParams = exports.combinations = exports.getExamples = exports.getStatusCodeFromError = exports.getMessageFromError = exports.isLoggerConfig = exports.getInitialInput = exports.combineEndpointAndMiddlewareInputSchemas = exports.extractObjectSchema = exports.routePathParamsRegex = exports.markOutput = void 0;
+exports.errToObj = exports.hasUpload = exports.getRoutePathParams = exports.combinations = exports.getExamples = exports.getStatusCodeFromError = exports.getMessageFromError = exports.isLoggerConfig = exports.getInitialInput = exports.defaultInputSources = exports.combineEndpointAndMiddlewareInputSchemas = exports.extractObjectSchema = exports.routePathParamsRegex = exports.markOutput = void 0;
 const http_errors_1 = require("http-errors");
 const zod_1 = require("zod");
 const config_type_1 = require("./config-type");
 const metadata_1 = require("./metadata");
 const mime_1 = require("./mime");
+const upload_schema_1 = require("./upload-schema");
 const markOutput = (output) => output;
 exports.markOutput = markOutput;
 /** @see https://expressjs.com/en/guide/routing.html */
@@ -45,19 +46,19 @@ function areFilesAvailable(request) {
     const isMultipart = contentType.substr(0, mime_1.mimeMultipart.length).toLowerCase() === mime_1.mimeMultipart;
     return "files" in request && isMultipart;
 }
-const defaultInputSources = {
+exports.defaultInputSources = {
     get: ["query", "params"],
     post: ["body", "params", "files"],
     put: ["body", "params"],
     patch: ["body", "params"],
     delete: ["body", "query", "params"],
 };
-const fallbackInputSource = defaultInputSources.delete;
+const fallbackInputSource = exports.defaultInputSources.delete;
 function getInitialInput(request, inputAssignment) {
     const method = request.method.toLowerCase();
     let props = fallbackInputSource;
-    if (method in defaultInputSources) {
-        props = defaultInputSources[method];
+    if (method in exports.defaultInputSources) {
+        props = exports.defaultInputSources[method];
     }
     if (inputAssignment && method in inputAssignment) {
         props = inputAssignment[method] || props;
@@ -136,6 +137,38 @@ function getRoutePathParams(path) {
     return match.map((param) => param.slice(1));
 }
 exports.getRoutePathParams = getRoutePathParams;
+function hasUpload(schema) {
+    if (schema instanceof upload_schema_1.ZodUpload) {
+        return true;
+    }
+    const reduceBool = (arr) => arr.reduce((carry, check) => carry || check, false);
+    if (schema instanceof zod_1.z.ZodObject) {
+        return reduceBool(Object.values(schema.shape).map(hasUpload));
+    }
+    if (schema instanceof zod_1.z.ZodUnion) {
+        return reduceBool(schema._def.options.map(hasUpload));
+    }
+    if (schema instanceof zod_1.z.ZodIntersection) {
+        return reduceBool([schema._def.left, schema._def.right].map(hasUpload));
+    }
+    if (schema instanceof zod_1.z.ZodOptional || schema instanceof zod_1.z.ZodNullable) {
+        return hasUpload(schema.unwrap());
+    }
+    if (schema instanceof zod_1.z.ZodEffects || schema instanceof zod_1.z.ZodTransformer) {
+        return hasUpload(schema._def.schema);
+    }
+    if (schema instanceof zod_1.z.ZodRecord) {
+        return hasUpload(schema._def.valueType);
+    }
+    if (schema instanceof zod_1.z.ZodArray) {
+        return hasUpload(schema._def.type);
+    }
+    if (schema instanceof zod_1.z.ZodDefault) {
+        return hasUpload(schema._def.innerType);
+    }
+    return false;
+}
+exports.hasUpload = hasUpload;
 // the copy of the private Zod errorUtil.errToObj
 const errToObj = (message) => typeof message === "string" ? { message } : message || {};
 exports.errToObj = errToObj;

package/dist/common-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"common-helpers.js","sourceRoot":"","sources":["../src/common-helpers.ts"],"names":[],"mappings":";;;AACA,6CAAwC;AACxC,6BAAwB;AACxB,+CAKuB;AACvB,yCAA+C;AAG/C,iCAAuC;AAgDhC,MAAM,UAAU,GAAG,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAsB,CAAC;AAA1D,QAAA,UAAU,cAAgD;AAEvE,uDAAuD;AAC1C,QAAA,oBAAoB,GAAG,mBAAmB,CAAC;AASxD,SAAgB,mBAAmB,CAAC,OAAiB;IACnD,IAAI,OAAO,YAAY,OAAC,CAAC,SAAS,EAAE;QAClC,OAAO,OAAO,CAAC;KAChB;IACD,IAAI,YAA0B,CAAC;IAC/B,IAAI,OAAO,YAAY,OAAC,CAAC,QAAQ,EAAE;QACjC,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACpD,GAAG,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CACtC,CAAC;KACH;SAAM;QACL,sBAAsB;QACtB,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC5D;IACD,OAAO,IAAA,mBAAQ,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AACzC,CAAC;AAdD,kDAcC;AAED,SAAgB,wCAAwC,CAItD,KAAS,EACT,WAAuD;IAEvD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,OAAO,mBAAmB,CAAC,KAAK,CAAoB,CAAC;KACtD;IACD,MAAM,OAAO,GAAG,WAAW;SACxB,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;SACrC,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CACxB,mBAAmB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAC9D,CAAC;IACJ,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAC/C,mBAAmB,CAAC,KAAK,CAAC,CACR,CAAC;IACrB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,IAAA,mBAAQ,EAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KACpC;IACD,IAAA,mBAAQ,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAvBD,4FAuBC;AAED,SAAS,iBAAiB,CAAC,OAAgB;IACzC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IACzD,MAAM,WAAW,GACf,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,oBAAa,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,KAAK,oBAAa,CAAC;IAC9E,OAAO,OAAO,IAAI,OAAO,IAAI,WAAW,CAAC;AAC3C,CAAC;AAED,MAAM,mBAAmB,GAAiB;IACxC,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IACxB,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC;IACjC,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IACvB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IACzB,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;CACpC,CAAC;AACF,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,MAAM,CAAC;AAEvD,SAAgB,eAAe,CAC7B,OAAgB,EAChB,eAA6C;IAE7C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAY,CAAC;IACtD,IAAI,KAAK,GAAG,mBAAmB,CAAC;IAChC,IAAI,MAAM,IAAI,mBAAmB,EAAE;QACjC,KAAK,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;KACrC;IACD,IAAI,eAAe,IAAI,MAAM,IAAI,eAAe,EAAE;QAChD,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;KAC1C;IACD,OAAO,KAAK;SACT,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACxE,MAAM,CACL,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAChB,GAAG,KAAK;QACR,GAAG,OAAO,CAAC,IAAI,CAAC;KACjB,CAAC,EACF,EAAE,CACH,CAAC;AACN,CAAC;AArBD,0CAqBC;AAED,SAAgB,cAAc,CAAC,MAAW;IACxC,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,OAAO,IAAI,MAAM;QACjB,OAAO,IAAI,MAAM;QACjB,MAAM,CAAC,IAAI,CAAC,0BAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC;QAChD,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAClC,CAAC;AACJ,CAAC;AARD,wCAQC;AAED,SAAgB,mBAAmB,CAAC,KAAY;IAC9C,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE;QAC/B,OAAO,KAAK,CAAC,MAAM;aAChB,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;aAC3D,IAAI,CAAC,IAAI,CAAC,CAAC;KACf;IACD,OAAO,KAAK,CAAC,OAAO,CAAC;AACvB,CAAC;AAPD,kDAOC;AAED,SAAgB,sBAAsB,CAAC,KAAY;IACjD,IAAI,KAAK,YAAY,uBAAS,EAAE;QAC9B,OAAO,KAAK,CAAC,UAAU,CAAC;KACzB;IACD,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE;QAC/B,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AARD,wDAQC;AAGM,MAAM,WAAW,GAAG,CACzB,MAAS,EACT,aAAsB,EACT,EAAE;IACf,MAAM,QAAQ,GAAG,IAAA,kBAAO,EAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,EAAE,CAAC;KACX;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACxC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAChD,OAAO,KAAK,CAAC,MAAM,CACjB,aAAa,CAAC,OAAO;YACnB,CAAC,CAAC,aAAa;gBACb,CAAC,CAAC,aAAa,CAAC,IAAI;gBACpB,CAAC,CAAC,OAAO;YACX,CAAC,CAAC,EAAE,CACP,CAAC;IACJ,CAAC,EAAE,EAA+B,CAAC,CAAC;AACtC,CAAC,CAAC;AAlBW,QAAA,WAAW,eAkBtB;AAEK,MAAM,YAAY,GAAG,CAC1B,CAAM,EACN,CAAM,EAC+D,EAAE;IACvE,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAClB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;KACrC;IACD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAClB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;KACrC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,KAAK,IAAI,CAAC,EAAE;QACrB,KAAK,MAAM,KAAK,IAAI,CAAC,EAAE;YACrB,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;SAC7B;KACF;IACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC1C,CAAC,CAAC;AAjBW,QAAA,YAAY,gBAiBvB;AAEF,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,4BAAoB,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,EAAE,CAAC;KACX;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAND,gDAMC;AAQD,iDAAiD;AAC1C,MAAM,QAAQ,GAAG,CAAC,OAA+B,EAAE,EAAE,CAC1D,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;AAD/C,QAAA,QAAQ,YACuC"}
+{"version":3,"file":"common-helpers.js","sourceRoot":"","sources":["../src/common-helpers.ts"],"names":[],"mappings":";;;AACA,6CAAwC;AACxC,6BAAwB;AACxB,+CAKuB;AACvB,yCAA+C;AAG/C,iCAAuC;AACvC,mDAA4C;AAgDrC,MAAM,UAAU,GAAG,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAsB,CAAC;AAA1D,QAAA,UAAU,cAAgD;AAEvE,uDAAuD;AAC1C,QAAA,oBAAoB,GAAG,mBAAmB,CAAC;AASxD,SAAgB,mBAAmB,CAAC,OAAiB;IACnD,IAAI,OAAO,YAAY,OAAC,CAAC,SAAS,EAAE;QAClC,OAAO,OAAO,CAAC;KAChB;IACD,IAAI,YAA0B,CAAC;IAC/B,IAAI,OAAO,YAAY,OAAC,CAAC,QAAQ,EAAE;QACjC,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACpD,GAAG,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CACtC,CAAC;KACH;SAAM;QACL,sBAAsB;QACtB,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC5D;IACD,OAAO,IAAA,mBAAQ,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AACzC,CAAC;AAdD,kDAcC;AAED,SAAgB,wCAAwC,CAItD,KAAS,EACT,WAAuD;IAEvD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,OAAO,mBAAmB,CAAC,KAAK,CAAoB,CAAC;KACtD;IACD,MAAM,OAAO,GAAG,WAAW;SACxB,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;SACrC,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CACxB,mBAAmB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAC9D,CAAC;IACJ,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAC/C,mBAAmB,CAAC,KAAK,CAAC,CACR,CAAC;IACrB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,IAAA,mBAAQ,EAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KACpC;IACD,IAAA,mBAAQ,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAvBD,4FAuBC;AAED,SAAS,iBAAiB,CAAC,OAAgB;IACzC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IACzD,MAAM,WAAW,GACf,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,oBAAa,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,KAAK,oBAAa,CAAC;IAC9E,OAAO,OAAO,IAAI,OAAO,IAAI,WAAW,CAAC;AAC3C,CAAC;AAEY,QAAA,mBAAmB,GAAiB;IAC/C,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IACxB,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC;IACjC,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IACvB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IACzB,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;CACpC,CAAC;AACF,MAAM,mBAAmB,GAAG,2BAAmB,CAAC,MAAM,CAAC;AAEvD,SAAgB,eAAe,CAC7B,OAAgB,EAChB,eAA6C;IAE7C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAY,CAAC;IACtD,IAAI,KAAK,GAAG,mBAAmB,CAAC;IAChC,IAAI,MAAM,IAAI,2BAAmB,EAAE;QACjC,KAAK,GAAG,2BAAmB,CAAC,MAAM,CAAC,CAAC;KACrC;IACD,IAAI,eAAe,IAAI,MAAM,IAAI,eAAe,EAAE;QAChD,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;KAC1C;IACD,OAAO,KAAK;SACT,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACxE,MAAM,CACL,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAChB,GAAG,KAAK;QACR,GAAG,OAAO,CAAC,IAAI,CAAC;KACjB,CAAC,EACF,EAAE,CACH,CAAC;AACN,CAAC;AArBD,0CAqBC;AAED,SAAgB,cAAc,CAAC,MAAW;IACxC,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,OAAO,IAAI,MAAM;QACjB,OAAO,IAAI,MAAM;QACjB,MAAM,CAAC,IAAI,CAAC,0BAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC;QAChD,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAClC,CAAC;AACJ,CAAC;AARD,wCAQC;AAED,SAAgB,mBAAmB,CAAC,KAAY;IAC9C,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE;QAC/B,OAAO,KAAK,CAAC,MAAM;aAChB,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;aAC3D,IAAI,CAAC,IAAI,CAAC,CAAC;KACf;IACD,OAAO,KAAK,CAAC,OAAO,CAAC;AACvB,CAAC;AAPD,kDAOC;AAED,SAAgB,sBAAsB,CAAC,KAAY;IACjD,IAAI,KAAK,YAAY,uBAAS,EAAE;QAC9B,OAAO,KAAK,CAAC,UAAU,CAAC;KACzB;IACD,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE;QAC/B,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AARD,wDAQC;AAGM,MAAM,WAAW,GAAG,CACzB,MAAS,EACT,aAAsB,EACT,EAAE;IACf,MAAM,QAAQ,GAAG,IAAA,kBAAO,EAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,EAAE,CAAC;KACX;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACxC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAChD,OAAO,KAAK,CAAC,MAAM,CACjB,aAAa,CAAC,OAAO;YACnB,CAAC,CAAC,aAAa;gBACb,CAAC,CAAC,aAAa,CAAC,IAAI;gBACpB,CAAC,CAAC,OAAO;YACX,CAAC,CAAC,EAAE,CACP,CAAC;IACJ,CAAC,EAAE,EAA+B,CAAC,CAAC;AACtC,CAAC,CAAC;AAlBW,QAAA,WAAW,eAkBtB;AAEK,MAAM,YAAY,GAAG,CAC1B,CAAM,EACN,CAAM,EAC+D,EAAE;IACvE,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAClB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;KACrC;IACD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAClB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;KACrC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,KAAK,IAAI,CAAC,EAAE;QACrB,KAAK,MAAM,KAAK,IAAI,CAAC,EAAE;YACrB,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;SAC7B;KACF;IACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC1C,CAAC,CAAC;AAjBW,QAAA,YAAY,gBAiBvB;AAEF,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,4BAAoB,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,EAAE,CAAC;KACX;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAND,gDAMC;AAED,SAAgB,SAAS,CAAC,MAAoB;IAC5C,IAAI,MAAM,YAAY,yBAAS,EAAE;QAC/B,OAAO,IAAI,CAAC;KACb;IACD,MAAM,UAAU,GAAG,CAAC,GAAc,EAAE,EAAE,CACpC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,KAAK,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,MAAM,YAAY,OAAC,CAAC,SAAS,EAAE;QACjC,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAe,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;KAC7E;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,EAAE;QAChC,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;KACvD;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,eAAe,EAAE;QACvC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;KACzE;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,WAAW,IAAI,MAAM,YAAY,OAAC,CAAC,WAAW,EAAE;QACtE,OAAO,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;KACnC;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,UAAU,IAAI,MAAM,YAAY,OAAC,CAAC,cAAc,EAAE;QACxE,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACtC;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,SAAS,EAAE;QACjC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACzC;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,EAAE;QAChC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACpC;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,UAAU,EAAE;QAClC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACzC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AA/BD,8BA+BC;AAQD,iDAAiD;AAC1C,MAAM,QAAQ,GAAG,CAAC,OAA+B,EAAE,EAAE,CAC1D,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;AAD/C,QAAA,QAAQ,YACuC"}

package/dist/endpoints-factory.d.ts

@@ -10,7 +10,6 @@ declare type BuildProps<IN extends IOSchema, OUT extends IOSchema, MwIN, MwOUT,
     output: OUT;
     handler: Handler<z.output<Merge<IN, MwIN>>, z.input<OUT>, MwOUT>;
     description?: string;
-    type?: "json" | "upload";
 } & MethodsDefinition<M>;
 export declare class EndpointsFactory<MwIN, MwOUT, POS extends ApiResponse, NEG extends ApiResponse> {
     #private;
@@ -18,7 +17,8 @@ export declare class EndpointsFactory<MwIN, MwOUT, POS extends ApiResponse, NEG
     protected middlewares: MiddlewareDefinition<any, any, any>[];
     constructor(resultHandler: ResultHandlerDefinition<POS, NEG>);
     addMiddleware<IN extends IOSchema, OUT extends FlatObject>(definition: MiddlewareDefinition<IN, MwOUT, OUT>): EndpointsFactory<Merge<IN, MwIN>, MwOUT & OUT, POS, NEG>;
-    build<IN extends IOSchema, OUT extends IOSchema, M extends Method>({ input, output, handler, description, type, ...rest }: BuildProps<IN, OUT, MwIN, MwOUT, M>): Endpoint<IN, OUT, MwIN, MwOUT, M, POS, NEG>;
+    addOptions<OUT extends FlatObject>(options: OUT): EndpointsFactory<MwIN, MwOUT & OUT, POS, NEG>;
+    build<IN extends IOSchema, OUT extends IOSchema, M extends Method>({ input, output, handler, description, ...rest }: BuildProps<IN, OUT, MwIN, MwOUT, M>): Endpoint<IN, OUT, MwIN, MwOUT, M, POS, NEG>;
 }
 export declare const defaultEndpointsFactory: EndpointsFactory<unknown, unknown, ApiResponse<z.ZodObject<{
     status: z.ZodLiteral<"success">;

package/dist/endpoints-factory.js

@@ -7,7 +7,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _a, _EndpointsFactory_create;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultEndpointsFactory = exports.EndpointsFactory = void 0;
+const zod_1 = require("zod");
 const endpoint_1 = require("./endpoint");
+const common_helpers_1 = require("./common-helpers");
+const middleware_1 = require("./middleware");
 const mime_1 = require("./mime");
 const result_handler_1 = require("./result-handler");
 class EndpointsFactory {
@@ -19,7 +22,13 @@ class EndpointsFactory {
     addMiddleware(definition) {
         return __classPrivateFieldGet(EndpointsFactory, _a, "m", _EndpointsFactory_create).call(EndpointsFactory, this.middlewares.concat(definition), this.resultHandler);
     }
-    build({ input, output, handler, description, type, ...rest }) {
+    addOptions(options) {
+        return __classPrivateFieldGet(EndpointsFactory, _a, "m", _EndpointsFactory_create).call(EndpointsFactory, this.middlewares.concat((0, middleware_1.createMiddleware)({
+            input: zod_1.z.object({}),
+            middleware: async () => options,
+        })), this.resultHandler);
+    }
+    build({ input, output, handler, description, ...rest }) {
         return new endpoint_1.Endpoint({
             handler,
             description,
@@ -27,7 +36,7 @@ class EndpointsFactory {
             inputSchema: input,
             outputSchema: output,
             resultHandler: this.resultHandler,
-            mimeTypes: type === "upload" ? [mime_1.mimeMultipart] : [mime_1.mimeJson],
+            mimeTypes: (0, common_helpers_1.hasUpload)(input) ? [mime_1.mimeMultipart] : [mime_1.mimeJson],
             ...rest,
         });
     }

package/dist/endpoints-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"endpoints-factory.js","sourceRoot":"","sources":["../src/endpoints-factory.ts"],"names":[],"mappings":";;;;;;;;;AAEA,yCAA+C;AAI/C,iCAAiD;AACjD,qDAG0B;AAgB1B,MAAa,gBAAgB;IAQ3B,YAAsB,aAAgD;QAAhD,kBAAa,GAAb,aAAa,CAAmC;QAF5D,gBAAW,GAA0C,EAAE,CAAC;QAGhE,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAkBM,aAAa,CAClB,UAAgD;QAEhD,OAAO,uBAAA,gBAAgB,oCAAQ,MAAxB,gBAAgB,EACrB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,EACnC,IAAI,CAAC,aAAa,CACnB,CAAC;IACJ,CAAC;IAEM,KAAK,CAA8D,EACxE,KAAK,EACL,MAAM,EACN,OAAO,EACP,WAAW,EACX,IAAI,EACJ,GAAG,IAAI,EAC6B;QACpC,OAAO,IAAI,mBAAQ,CAAoC;YACrD,OAAO;YACP,WAAW;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,KAAK;YAClB,YAAY,EAAE,MAAM;YACpB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAa,CAAC,CAAC,CAAC,CAAC,CAAC,eAAQ,CAAC;YAC3D,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;CACF;AAxDD,4CAwDC;oFAtCG,WAAkD,EAClD,aAAoD;IAEpD,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAClC,aAAa,CACd,CAAC;IACF,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IAClC,OAAO,OAAO,CAAC;AACjB,CAAC;AAgCU,QAAA,uBAAuB,GAAG,IAAI,gBAAgB,CACzD,qCAAoB,CACrB,CAAC"}
+{"version":3,"file":"endpoints-factory.js","sourceRoot":"","sources":["../src/endpoints-factory.ts"],"names":[],"mappings":";;;;;;;;;AAAA,6BAAwB;AAExB,yCAA+C;AAC/C,qDAA0E;AAE1E,6CAAsE;AACtE,iCAAiD;AACjD,qDAG0B;AAe1B,MAAa,gBAAgB;IAQ3B,YAAsB,aAAgD;QAAhD,kBAAa,GAAb,aAAa,CAAmC;QAF5D,gBAAW,GAA0C,EAAE,CAAC;QAGhE,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAkBM,aAAa,CAClB,UAAgD;QAEhD,OAAO,uBAAA,gBAAgB,oCAAQ,MAAxB,gBAAgB,EACrB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,EACnC,IAAI,CAAC,aAAa,CACnB,CAAC;IACJ,CAAC;IAEM,UAAU,CAAyB,OAAY;QACpD,OAAO,uBAAA,gBAAgB,oCAAQ,MAAxB,gBAAgB,EACrB,IAAI,CAAC,WAAW,CAAC,MAAM,CACrB,IAAA,6BAAgB,EAAC;YACf,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;YACnB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO;SAChC,CAAC,CACH,EACD,IAAI,CAAC,aAAa,CACnB,CAAC;IACJ,CAAC;IAEM,KAAK,CAA8D,EACxE,KAAK,EACL,MAAM,EACN,OAAO,EACP,WAAW,EACX,GAAG,IAAI,EAC6B;QACpC,OAAO,IAAI,mBAAQ,CAAoC;YACrD,OAAO;YACP,WAAW;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,KAAK;YAClB,YAAY,EAAE,MAAM;YACpB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,IAAA,0BAAS,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAa,CAAC,CAAC,CAAC,CAAC,CAAC,eAAQ,CAAC;YAC1D,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;CACF;AAnED,4CAmEC;oFAjDG,WAAkD,EAClD,aAAoD;IAEpD,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAClC,aAAa,CACd,CAAC;IACF,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IAClC,OAAO,OAAO,CAAC;AACjB,CAAC;AA2CU,QAAA,uBAAuB,GAAG,IAAI,gBAAgB,CACzD,qCAAoB,CACrB,CAAC"}

package/dist/open-api-helpers.d.ts

@@ -1,8 +1,13 @@
-import { ParameterObject, SchemaObject } from "openapi3-ts";
+import { MediaTypeObject, ParameterObject, SchemaObject } from "openapi3-ts";
 import { RequestBodyObject, ResponseObject } from "openapi3-ts/src/model/OpenApi";
 import { z } from "zod";
+import { IOSchema } from "./common-helpers";
+import { InputSources } from "./config-type";
 import { AbstractEndpoint } from "./endpoint";
+import { ZodFile } from "./file-schema";
 import { Method } from "./method";
+import { ZodUpload } from "./upload-schema";
+declare type MediaExamples = Pick<MediaTypeObject, "examples">;
 declare type DepictHelper<T extends z.ZodType<any>> = (params: {
     schema: T;
     initial?: SchemaObject;
@@ -13,10 +18,38 @@ interface ReqResDepictHelperCommonProps {
     path: string;
     endpoint: AbstractEndpoint;
 }
-export declare function reformatParamsInPath(path: string): string;
-export declare const depictRequestParams: ({ path, method, endpoint, }: ReqResDepictHelperCommonProps) => ParameterObject[];
+export declare const reformatParamsInPath: (path: string) => string;
+export declare const depictDefault: DepictHelper<z.ZodDefault<z.ZodTypeAny>>;
+export declare const depictAny: DepictHelper<z.ZodAny>;
+export declare const depictUpload: DepictHelper<ZodUpload>;
+export declare const depictFile: DepictHelper<ZodFile>;
+export declare const depictUnion: DepictHelper<z.ZodUnion<[z.ZodTypeAny, ...z.ZodTypeAny[]]>>;
+export declare const depictIntersection: DepictHelper<z.ZodIntersection<z.ZodTypeAny, z.ZodTypeAny>>;
+export declare const depictOptionalOrNullable: DepictHelper<z.ZodOptional<any> | z.ZodNullable<any>>;
+export declare const depictEnum: DepictHelper<z.ZodEnum<any> | z.ZodNativeEnum<any>>;
+export declare const depictLiteral: DepictHelper<z.ZodLiteral<any>>;
+export declare const depictObject: DepictHelper<z.AnyZodObject>;
+/** @see https://swagger.io/docs/specification/data-models/data-types/ */
+export declare const depictNull: DepictHelper<z.ZodNull>;
+export declare const depictDate: DepictHelper<z.ZodDate>;
+export declare const depictBoolean: DepictHelper<z.ZodBoolean>;
+export declare const depictBigInt: DepictHelper<z.ZodBigInt>;
+export declare const depictRecord: DepictHelper<z.ZodRecord<z.ZodTypeAny>>;
+export declare const depictArray: DepictHelper<z.ZodArray<z.ZodTypeAny>>;
+/** @todo improve it when OpenAPI 3.1.0 will be released */
+export declare const depictTuple: DepictHelper<z.ZodTuple>;
+export declare const depictString: DepictHelper<z.ZodString>;
+export declare const depictNumber: DepictHelper<z.ZodNumber>;
+export declare const depictObjectProperties: ({ schema: { shape }, isResponse, }: Parameters<DepictHelper<z.AnyZodObject>>[0]) => Record<string, SchemaObject>;
+export declare const depictEffect: DepictHelper<z.ZodEffects<z.ZodTypeAny>>;
+export declare const depictIOExamples: <T extends IOSchema>(schema: T, isResponse: boolean, omitProps?: string[]) => MediaExamples;
+export declare const depictIOParamExamples: <T extends IOSchema>(schema: T, isResponse: boolean, param: string) => MediaExamples;
+export declare const depictRequestParams: ({ path, method, endpoint, inputSources, }: ReqResDepictHelperCommonProps & {
+    inputSources: InputSources[Method];
+}) => ParameterObject[];
 export declare const depictSchema: DepictHelper<z.ZodTypeAny>;
 export declare const excludeParamsFromDepiction: (depicted: SchemaObject, pathParams: string[]) => SchemaObject;
+export declare const excludeExampleFromDepiction: (depicted: SchemaObject) => SchemaObject;
 export declare const depictResponse: ({ method, path, description, endpoint, isPositive, }: ReqResDepictHelperCommonProps & {
     description: string;
     isPositive: boolean;