express-endpoints-collection 1.0.0 → 1.0.2

package/README.md

@@ -12,16 +12,16 @@ You can configure exposed endpoints, request and response schemas, and validatio
 
 ## Features
 
-* Fully typed endpoints (TypeScript hints and checks)
-  * Request body
-  * Response body
-  * Query parameters
-  * Path parameters
-  * Headers
-* Automatic OpenAPI 3 schema generation
-* Request and response validation using Zod
-* Middleware support
-* Minimal setup
+- Fully typed endpoints (TypeScript hints and checks)
+  - Request body
+  - Response body
+  - Query parameters
+  - Path parameters
+  - Headers
+- Automatic OpenAPI 3 schema generation
+- Request and response validation using Zod
+- Middleware support
+- Minimal setup
 
 ## Installation
 
@@ -128,7 +128,7 @@ paths:
                 - a
                 - b
       responses:
-        '200':
+        "200":
           description: Response for status code 200
           content:
             application/json:
@@ -171,10 +171,7 @@ or as JSON
                     "type": "number"
                   }
                 },
-                "required": [
-                  "a",
-                  "b"
-                ]
+                "required": ["a", "b"]
               }
             }
           }
@@ -191,9 +188,7 @@ or as JSON
                       "type": "number"
                     }
                   },
-                  "required": [
-                    "result"
-                  ]
+                  "required": ["result"]
                 }
               }
             }
@@ -216,4 +211,5 @@ Type inference and checks:
 ![infer1](./img/infer1.png)
 
 ### License
-MIT
+
+MIT

package/dist/generator.d.ts

@@ -0,0 +1,7 @@
+import { EndpointInfo } from "./types/EndpointInfo";
+export declare function generateOpenAPI({ title, version, endpoints, }: {
+    title: string;
+    version: string;
+    endpoints: EndpointInfo[];
+}): import("openapi3-ts/oas30").OpenAPIObject;
+//# sourceMappingURL=generator.d.ts.map

package/dist/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAWpD,wBAAgB,eAAe,CAAC,EAC9B,KAAK,EACL,OAAO,EACP,SAAS,GACV,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B,6CAmDA"}

package/dist/generator.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOpenAPI = generateOpenAPI;
+const zod_to_openapi_1 = require("@asteasolutions/zod-to-openapi");
+const zod_1 = require("zod");
+(0, zod_to_openapi_1.extendZodWithOpenApi)(zod_1.z);
+function generateOpenAPI({ title, version, endpoints, }) {
+    const registry = new zod_to_openapi_1.OpenAPIRegistry();
+    endpoints.forEach((endpoint) => {
+        const openapiPath = endpoint.path.replace(/:(\w+)/g, "{$1}");
+        const responses = {};
+        for (const outputSchema of endpoint.outputSchema) {
+            responses[outputSchema.status.toString()] = {
+                description: outputSchema.description ||
+                    `Response for status code ${outputSchema.status}`,
+                content: outputSchema.body
+                    ? {
+                        "application/json": {
+                            schema: outputSchema.body,
+                        },
+                    }
+                    : undefined,
+            };
+        }
+        registry.registerPath({
+            method: endpoint.method,
+            path: openapiPath,
+            summary: endpoint.summary || "",
+            request: {
+                params: endpoint.inputSchema?.params,
+                query: endpoint.inputSchema?.query,
+                body: endpoint.inputSchema?.body
+                    ? {
+                        content: {
+                            "application/json": { schema: endpoint.inputSchema.body },
+                        },
+                    }
+                    : undefined,
+                headers: endpoint.inputSchema?.headers,
+            },
+            responses,
+        });
+    });
+    const generator = new zod_to_openapi_1.OpenApiGeneratorV3(registry.definitions);
+    return generator.generateDocument({
+        openapi: "3.0.0",
+        info: {
+            title,
+            version,
+        },
+    });
+}
+//# sourceMappingURL=generator.js.map

package/dist/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":";;AAWA,0CA2DC;AArED,mEAKwC;AACxC,6BAAwB;AAExB,IAAA,qCAAoB,EAAC,OAAC,CAAC,CAAC;AAExB,SAAgB,eAAe,CAAC,EAC9B,KAAK,EACL,OAAO,EACP,SAAS,GAKV;IACC,MAAM,QAAQ,GAAG,IAAI,gCAAe,EAAE,CAAC;IAEvC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAmC,EAAE,CAAC;QAErD,KAAK,MAAM,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;YACjD,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG;gBAC1C,WAAW,EACT,YAAY,CAAC,WAAW;oBACxB,4BAA4B,YAAY,CAAC,MAAM,EAAE;gBACnD,OAAO,EAAE,YAAY,CAAC,IAAI;oBACxB,CAAC,CAAC;wBACE,kBAAkB,EAAE;4BAClB,MAAM,EAAE,YAAY,CAAC,IAAI;yBAC1B;qBACF;oBACH,CAAC,CAAC,SAAS;aACd,CAAC;QACJ,CAAC;QAED,QAAQ,CAAC,YAAY,CAAC;YACpB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,EAAE;YAC/B,OAAO,EAAE;gBACP,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE,MAAM;gBACpC,KAAK,EAAE,QAAQ,CAAC,WAAW,EAAE,KAAK;gBAClC,IAAI,EAAE,QAAQ,CAAC,WAAW,EAAE,IAAI;oBAC9B,CAAC,CAAC;wBACE,OAAO,EAAE;4BACP,kBAAkB,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE;yBAC1D;qBACF;oBACH,CAAC,CAAC,SAAS;gBACb,OAAO,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO;aACvC;YACD,SAAS;SACV,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,mCAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAE/D,OAAO,SAAS,CAAC,gBAAgB,CAAC;QAChC,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK;YACL,OAAO;SACR;KACF,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { RequestHandler } from "express";
+import { EndpointInputSchema } from "./types/EndpointInputSchema";
+import { EndpointOutputSchema } from "./types/EndpointOutputSchema";
+import { EndpointInfo } from "./types/EndpointInfo";
+import { EndpointArgs } from "./types/EndpointArgs";
+import { HttpMethod } from "./types/HttpMethod";
+import { TypedRequestHandler } from "./types/TypedRequestHandler";
+export declare class EndpointsCollection {
+    private endpoints;
+    private router;
+    constructor();
+    private static validateInput;
+    private static validateOutput;
+    callOriginal(method: HttpMethod, path: string, { inputSchema, outputSchema, summary, afterOutput, beforeOutput, afterInput, beforeInput, }: EndpointArgs<EndpointInputSchema, EndpointOutputSchema>, handlers: RequestHandler | RequestHandler[] | TypedRequestHandler<any, any>): import("express-serve-static-core").Router;
+    get<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    post<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handler: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    put<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    delete<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    patch<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    options<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    head<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    trace<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema>(path: string, args: EndpointArgs<TInput, TOutput>, handlers: TypedRequestHandler<TInput, TOutput>): import("express-serve-static-core").Router;
+    getEndpoints(): EndpointInfo[];
+    getRouter(): import("express-serve-static-core").Router;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,cAAc,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,MAAM,CAAY;;IAI1B,OAAO,CAAC,MAAM,CAAC,aAAa;IAmB5B,OAAO,CAAC,MAAM,CAAC,cAAc;IA6BtB,YAAY,CACjB,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,MAAM,EACZ,EACE,WAAW,EACX,YAAY,EACZ,OAAO,EACP,WAAgB,EAChB,YAAiB,EACjB,UAAe,EACf,WAAgB,GACjB,EAAE,YAAY,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,EAC1D,QAAQ,EAAE,cAAc,GAAG,cAAc,EAAE,GAAG,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC;IAyCtE,GAAG,CACR,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,IAAI,CACT,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKxC,GAAG,CACR,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,MAAM,CACX,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,KAAK,CACV,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,OAAO,CACZ,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,IAAI,CACT,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,KAAK,CACV,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,EAEpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzC,YAAY;IAIZ,SAAS;CAGjB"}

package/dist/index.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EndpointsCollection = void 0;
+const express_1 = require("express");
+const zod_1 = require("zod");
+class EndpointsCollection {
+    constructor() {
+        this.endpoints = [];
+        this.router = (0, express_1.Router)();
+    }
+    static validateInput(schema) {
+        return (req, res, next) => {
+            try {
+                if (schema.query)
+                    schema.query.parse(req.query);
+                if (schema.body)
+                    schema.body.parse(req.body);
+                if (schema.params)
+                    schema.params.parse(req.params);
+                if (schema.headers)
+                    schema.headers.parse(req.headers);
+                next();
+            }
+            catch (error) {
+                if (error instanceof zod_1.z.ZodError) {
+                    return res.status(400).json({
+                        error: error.errors,
+                    });
+                }
+                next(error);
+            }
+        };
+    }
+    static validateOutput(schema) {
+        return (req, res, next) => {
+            const originalJson = res.json;
+            // @ts-ignore
+            res.json = (body) => {
+                const status = res.statusCode;
+                const schemaForStatus = schema.find((s) => s.status === status);
+                try {
+                    if (schemaForStatus?.body) {
+                        schemaForStatus.body.parse(body);
+                    }
+                    originalJson.call(res, body);
+                }
+                catch (error) {
+                    if (error instanceof zod_1.z.ZodError) {
+                        console.error("Error in response validation", error.errors);
+                        return res.status(500).json({
+                            error: "Internal server error",
+                        });
+                    }
+                    next(error);
+                }
+            };
+            next();
+        };
+    }
+    callOriginal(method, path, { inputSchema, outputSchema, summary, afterOutput = [], beforeOutput = [], afterInput = [], beforeInput = [], }, handlers) {
+        this.endpoints.push({
+            path,
+            method: method,
+            inputSchema,
+            outputSchema,
+            summary,
+        });
+        const combinedHandlers = [];
+        if (beforeInput) {
+            combinedHandlers.push(beforeInput);
+        }
+        if (inputSchema) {
+            combinedHandlers.push(EndpointsCollection.validateInput(inputSchema));
+        }
+        if (afterInput) {
+            combinedHandlers.push(afterInput);
+        }
+        combinedHandlers.push(handlers);
+        if (beforeOutput) {
+            combinedHandlers.push(beforeOutput);
+        }
+        if (outputSchema) {
+            combinedHandlers.push(EndpointsCollection.validateOutput(outputSchema));
+        }
+        if (afterOutput) {
+            combinedHandlers.push(afterOutput);
+        }
+        return this.router[method](path, ...combinedHandlers);
+    }
+    get(path, args, handlers) {
+        return this.callOriginal("get", path, args, handlers);
+    }
+    post(path, args, handler) {
+        return this.callOriginal("post", path, args, handler);
+    }
+    put(path, args, handlers) {
+        return this.callOriginal("put", path, args, handlers);
+    }
+    delete(path, args, handlers) {
+        return this.callOriginal("delete", path, args, handlers);
+    }
+    patch(path, args, handlers) {
+        return this.callOriginal("patch", path, args, handlers);
+    }
+    options(path, args, handlers) {
+        return this.callOriginal("options", path, args, handlers);
+    }
+    head(path, args, handlers) {
+        return this.callOriginal("head", path, args, handlers);
+    }
+    trace(path, args, handlers) {
+        return this.callOriginal("trace", path, args, handlers);
+    }
+    getEndpoints() {
+        return this.endpoints;
+    }
+    getRouter() {
+        return this.router;
+    }
+}
+exports.EndpointsCollection = EndpointsCollection;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAMiB;AAMjB,6BAAwB;AAGxB,MAAa,mBAAmB;IAI9B;QAHQ,cAAS,GAAmB,EAAE,CAAC;QAC/B,WAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;IAEJ,CAAC;IAEf,MAAM,CAAC,aAAa,CAAC,MAA2B;QACtD,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACzD,IAAI,CAAC;gBACH,IAAI,MAAM,CAAC,KAAK;oBAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAChD,IAAI,MAAM,CAAC,IAAI;oBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7C,IAAI,MAAM,CAAC,MAAM;oBAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,OAAO;oBAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACtD,IAAI,EAAE,CAAC;YACT,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;oBAChC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBAC1B,KAAK,EAAE,KAAK,CAAC,MAAM;qBACpB,CAAC,CAAC;gBACL,CAAC;gBACD,IAAI,CAAC,KAAK,CAAC,CAAC;YACd,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAA4B;QACxD,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACzD,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC;YAE9B,aAAa;YACb,GAAG,CAAC,IAAI,GAAG,CAAC,IAAS,EAAE,EAAE;gBACvB,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC;gBAC9B,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;gBAEhE,IAAI,CAAC;oBACH,IAAI,eAAe,EAAE,IAAI,EAAE,CAAC;wBAC1B,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACnC,CAAC;oBACD,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAC/B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;wBAChC,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;wBAC5D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BAC1B,KAAK,EAAE,uBAAuB;yBAC/B,CAAC,CAAC;oBACL,CAAC;oBACD,IAAI,CAAC,KAAK,CAAC,CAAC;gBACd,CAAC;YACH,CAAC,CAAC;YAEF,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;IACJ,CAAC;IAEM,YAAY,CACjB,MAAkB,EAClB,IAAY,EACZ,EACE,WAAW,EACX,YAAY,EACZ,OAAO,EACP,WAAW,GAAG,EAAE,EAChB,YAAY,GAAG,EAAE,EACjB,UAAU,GAAG,EAAE,EACf,WAAW,GAAG,EAAE,GACwC,EAC1D,QAA2E;QAE3E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAClB,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,WAAW;YACX,YAAY;YACZ,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAA0C,EAAE,CAAC;QAEnE,IAAI,WAAW,EAAE,CAAC;YAChB,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;QAED,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC,IAAI,YAAY,EAAE,CAAC;YACjB,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,YAAY,EAAE,CAAC;YACjB,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,gBAAgB,CAAC,CAAC;IACxD,CAAC;IAEM,GAAG,CAIR,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,IAAI,CAIT,IAAY,EACZ,IAAmC,EACnC,OAA6C;QAE7C,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAEM,GAAG,CAIR,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,MAAM,CAIX,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAEM,KAAK,CAIV,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEM,OAAO,CAIZ,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAEM,IAAI,CAIT,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAIV,IAAY,EACZ,IAAmC,EACnC,QAA8C;QAE9C,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AA1MD,kDA0MC"}

package/dist/types/EndpointArgs.d.ts

@@ -0,0 +1,13 @@
+import { EndpointInputSchema } from "./EndpointInputSchema";
+import { EndpointOutputSchema } from "./EndpointOutputSchema";
+import { RequestHandler } from "express";
+export type EndpointArgs<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema> = {
+    inputSchema?: TInput;
+    outputSchema: TOutput;
+    summary?: string;
+    beforeInput?: RequestHandler | RequestHandler[];
+    afterInput?: RequestHandler | RequestHandler[];
+    beforeOutput?: RequestHandler | RequestHandler[];
+    afterOutput?: RequestHandler | RequestHandler[];
+};
+//# sourceMappingURL=EndpointArgs.d.ts.map

package/dist/types/EndpointArgs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointArgs.d.ts","sourceRoot":"","sources":["../../src/types/EndpointArgs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,MAAM,MAAM,YAAY,CACtB,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,IAClC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,CAAC;IAChD,UAAU,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,CAAC;IAC/C,YAAY,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,CAAC;IACjD,WAAW,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,CAAC;CACjD,CAAC"}

package/dist/types/EndpointArgs.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EndpointArgs.js.map

package/dist/types/EndpointArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointArgs.js","sourceRoot":"","sources":["../../src/types/EndpointArgs.ts"],"names":[],"mappings":""}

package/dist/types/EndpointInfo.d.ts

@@ -0,0 +1,11 @@
+import { EndpointInputSchema } from "./EndpointInputSchema";
+import { EndpointOutputSchema } from "./EndpointOutputSchema";
+import { HttpMethod } from "./HttpMethod";
+export type EndpointInfo = {
+    path: string;
+    method: HttpMethod;
+    inputSchema?: EndpointInputSchema;
+    outputSchema: EndpointOutputSchema;
+    summary?: string;
+};
+//# sourceMappingURL=EndpointInfo.d.ts.map

package/dist/types/EndpointInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointInfo.d.ts","sourceRoot":"","sources":["../../src/types/EndpointInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,YAAY,EAAE,oBAAoB,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/types/EndpointInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EndpointInfo.js.map

package/dist/types/EndpointInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointInfo.js","sourceRoot":"","sources":["../../src/types/EndpointInfo.ts"],"names":[],"mappings":""}

package/dist/types/EndpointInputSchema.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+export type EndpointInputSchema = {
+    query?: z.ZodObject<any>;
+    body?: z.ZodObject<any>;
+    params?: z.ZodObject<any>;
+    headers?: z.ZodObject<any>;
+};
+//# sourceMappingURL=EndpointInputSchema.d.ts.map

package/dist/types/EndpointInputSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointInputSchema.d.ts","sourceRoot":"","sources":["../../src/types/EndpointInputSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzB,IAAI,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACxB,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC1B,OAAO,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;CAC5B,CAAC"}

package/dist/types/EndpointInputSchema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EndpointInputSchema.js.map

package/dist/types/EndpointInputSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointInputSchema.js","sourceRoot":"","sources":["../../src/types/EndpointInputSchema.ts"],"names":[],"mappings":""}

package/dist/types/EndpointOutputSchema.d.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+export type EndpointOutputSchema = {
+    status: number;
+    description?: string;
+    body?: z.ZodType;
+}[];
+//# sourceMappingURL=EndpointOutputSchema.d.ts.map

package/dist/types/EndpointOutputSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointOutputSchema.d.ts","sourceRoot":"","sources":["../../src/types/EndpointOutputSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;CAClB,EAAE,CAAC"}

package/dist/types/EndpointOutputSchema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EndpointOutputSchema.js.map

package/dist/types/EndpointOutputSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EndpointOutputSchema.js","sourceRoot":"","sources":["../../src/types/EndpointOutputSchema.ts"],"names":[],"mappings":""}

package/dist/types/HttpMethod.d.ts

@@ -0,0 +1,2 @@
+export type HttpMethod = "get" | "post" | "put" | "delete" | "patch" | "options" | "head" | "trace";
+//# sourceMappingURL=HttpMethod.d.ts.map

package/dist/types/HttpMethod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpMethod.d.ts","sourceRoot":"","sources":["../../src/types/HttpMethod.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,MAAM,GACN,KAAK,GACL,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,OAAO,CAAC"}

package/dist/types/HttpMethod.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=HttpMethod.js.map

package/dist/types/HttpMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpMethod.js","sourceRoot":"","sources":["../../src/types/HttpMethod.ts"],"names":[],"mappings":""}

package/dist/types/TypedRequest.d.ts

@@ -0,0 +1,9 @@
+import { EndpointInputSchema } from "./EndpointInputSchema";
+import { z } from "zod";
+export type TypedRequest<T extends EndpointInputSchema> = {
+    body: z.infer<NonNullable<T["body"]>>;
+    query: z.infer<NonNullable<T["query"]>>;
+    params: z.infer<NonNullable<T["params"]>>;
+    headers: z.infer<NonNullable<T["headers"]>>;
+};
+//# sourceMappingURL=TypedRequest.d.ts.map

package/dist/types/TypedRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypedRequest.d.ts","sourceRoot":"","sources":["../../src/types/TypedRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,mBAAmB,IAAI;IACxD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAC"}

package/dist/types/TypedRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TypedRequest.js.map

package/dist/types/TypedRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypedRequest.js","sourceRoot":"","sources":["../../src/types/TypedRequest.ts"],"names":[],"mappings":""}

package/dist/types/TypedRequestHandler.d.ts

@@ -0,0 +1,6 @@
+import { EndpointInputSchema } from "./EndpointInputSchema";
+import { EndpointOutputSchema } from "./EndpointOutputSchema";
+import { TypedRequest } from "./TypedRequest";
+import { TypedResponse } from "./TypedResponse";
+export type TypedRequestHandler<TInput extends EndpointInputSchema, TOutput extends EndpointOutputSchema> = (req: TypedRequest<TInput>, res: TypedResponse<TOutput>) => void | Promise<void>;
+//# sourceMappingURL=TypedRequestHandler.d.ts.map

package/dist/types/TypedRequestHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypedRequestHandler.d.ts","sourceRoot":"","sources":["../../src/types/TypedRequestHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,MAAM,mBAAmB,CAC7B,MAAM,SAAS,mBAAmB,EAClC,OAAO,SAAS,oBAAoB,IAClC,CACF,GAAG,EAAE,YAAY,CAAC,MAAM,CAAC,EACzB,GAAG,EAAE,aAAa,CAAC,OAAO,CAAC,KACxB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/types/TypedRequestHandler.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TypedRequestHandler.js.map

package/dist/types/TypedRequestHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypedRequestHandler.js","sourceRoot":"","sources":["../../src/types/TypedRequestHandler.ts"],"names":[],"mappings":""}

package/dist/types/TypedResponse.d.ts

@@ -0,0 +1,11 @@
+import { EndpointOutputSchema } from "./EndpointOutputSchema";
+import { z } from "zod";
+export type TypedResponse<T extends EndpointOutputSchema> = {
+    json: (data: z.infer<NonNullable<T[number]["body"]>>) => void;
+    status: <S extends T[number]["status"]>(code: S) => Omit<TypedResponse<T>, "status"> & {
+        json: (data: z.infer<NonNullable<Extract<T[number], {
+            status: S;
+        }>["body"]>>) => void;
+    };
+};
+//# sourceMappingURL=TypedResponse.d.ts.map

package/dist/types/TypedResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypedResponse.d.ts","sourceRoot":"","sources":["../../src/types/TypedResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,oBAAoB,IAAI;IAC1D,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAC9D,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EACpC,IAAI,EAAE,CAAC,KACJ,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;QACtC,IAAI,EAAE,CACJ,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;YAAE,MAAM,EAAE,CAAC,CAAA;SAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAClE,IAAI,CAAC;KACX,CAAC;CACH,CAAC"}

package/dist/types/TypedResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TypedResponse.js.map

package/dist/types/TypedResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypedResponse.js","sourceRoot":"","sources":["../../src/types/TypedResponse.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-endpoints-collection",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "./dist/index.js",
   "repository": "https://github.com/pilotpirxie/express-endpoints-collection.git",
   "author": "pilotpirxie <10637666+pilotpirxie@users.noreply.github.com>",
@@ -30,5 +30,23 @@
   },
   "files": [
     "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "express",
+    "endpoints",
+    "collection",
+    "api",
+    "rest",
+    "restful",
+    "openapi",
+    "swagger",
+    "zod",
+    "typescript",
+    "ts",
+    "validation",
+    "inference"
   ]
 }