express-zod-safe 1.0.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,109 @@
+<h1 align="center">🛡️ Express Zod Safe</h1>
+<p align="center">
+    <a href="https://www.npmjs.com/package/express-zod-safe" target="_blank">
+  <img alt="GitHub tag (latest by date)" src="https://img.shields.io/github/v/tag/AngaBlue/express-zod-safe?label=Version">
+  </a>
+  <a href="https://github.com/AngaBlue/express-zod-safe/blob/master/LICENSE" target="_blank">
+    <img alt="License: LGPL--3.0--or--later" src="https://img.shields.io/github/license/AngaBlue/express-zod-safe?color=green" />
+  </a>
+</p>
+
+Express Zod Safe is a strict, typesafe middleware designed for Node.js applications, leveraging the robustness of Zod schemas to validate incoming request bodies, parameters, and queries. This package seamlessly integrates with Express.js (or similar frameworks) to provide developers with a typesafe, declarative approach to ensure data integrity and prevent invalid or malicious data from affecting their applications.
+
+### 🏠 [Homepage](https://github.com/AngaBlue/express-zod-safe)
+
+## 🔒 Features
+
+ - **Typesafe**: Built with TypeScript, offering complete typesafe interfaces that enrich your development experience.
+ - **Zod Integration**: Utilizes Zod schemas for comprehensive and customizable request validation.
+ - **Middleware Flexibility**: Easily integrates with Express.js middleware stack, ensuring a smooth validation process without compromising performance.
+ - **Parameter & Query Validation**: Validates not just request bodies but also URL parameters and query strings, covering all facets of incoming data.
+ - **Error Handling**: Provides detailed, developer-friendly error responses to aid in debugging and informing API consumers.
+ - **Simple & Intuitive**: Designed to be easy to use and understand, with a declarative API that is both concise and powerful.
+
+## ⬇️ Install
+
+Install this package using your package manager of choice.
+
+```sh
+npm i express-zod-safe
+```
+
+`zod`, `express` and `@types/express` are peer dependencies and must be installed separately.  This means you can bring your own version of these packages, and this package will not force you to use a specific version.
+
+```sh
+npm i zod express && npm i -D @types/express
+```
+
+## 🛠️ Usage
+
+```ts
+import express from 'express';
+import validate from 'express-zod-safe';
+import { z } from 'zod';
+ 
+const app = express();
+ 
+// Define your Zod schemas
+const params = {
+  userId: z.string().uuid(),
+};
+const query = {
+  age: z.coerce.number().optional(), // Given all query params and url params are strings, this will coerce the value to a number.
+};
+const body = {
+  name: z.string(),
+  email: z.string().email(),
+};
+ 
+// Use the validate middleware in your route
+app.post('/user/:userId', validate({ params, query, body }), (req, res) => {
+  // Your route logic here
+  res.send('User data is valid!');
+});
+
+app.listen(3000, () => console.log('Server running on port 3000'));
+```
+
+__Note:__ The `validate` middleware must be used __after__ any other middleware that parses/modifies the request body, such as `express.json()` or `express.urlencoded()`.
+
+### ⚠️ URL Parameters & Query Strings Coercion
+As mentioned in the example above, all URL parameters and query strings are parsed as strings.  This means that if you have a URL parameter or query string that is expected to be a number, you must use the `z.coerce.number()` method to coerce the value to a number.  This is because Zod will not coerce the value for you, and will instead throw an error if the value is not a string.
+
+```ts
+const params = {
+  userId: z.coerce.number(),
+};
+
+app.get('/user/:userId', validate({ params }), (req, res) => {
+  // req.params.userId -> number
+});
+```
+
+### ⚠️ Missing Validation Schemas
+If you do not provide a validation schema for a particular request component (e.g. `params`, `query`, or `body`), then that component will be assumed to be empty.  This means that requests with non-empty components will be rejected, and requests with empty components will be accepted.  The types on the `req` object will also reflect this, and will be `undefined` if the component is not provided.
+
+```ts
+const body = {
+  name: z.string(),
+  email: z.string().email(),
+};
+
+app.post('/user', validate({ body }), (req, res) => {
+  // req.body.name -> string
+  // req.body.email -> string
+  // req.params.age -> undefined
+  // req.query.age -> undefined
+});
+```
+
+This behaviour is intentional and ensures that you do not try to access or use a property that does not exist on the `req` object.
+
+## ⭐️ Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © [AngaBlue](https://github.com/AngaBlue).<br />
+This project is [LGPL--3.0--or--later](https://github.com/AngaBlue/express-zod-safe/blob/master/LICENSE) licensed.

package/dist/index.d.ts

@@ -0,0 +1,69 @@
+import { RequestHandler } from 'express';
+import { z } from 'zod';
+/**
+ * Generates a middleware function for Express.js that validates request params, query, and body.
+ * This function uses Zod schemas to perform validation against the provided schema definitions.
+ *
+ * @param schemas - An object containing Zod schemas for params, query, and body.
+ * @returns An Express.js middleware function that validates the request based on the provided schemas.
+ *          It attaches validated data to the request object and sends error details if validation fails.
+ * @template TParams - Type definition for params schema.
+ * @template TQuery - Type definition for query schema.
+ * @template TBody - Type definition for body schema.
+ * @example
+ * // Example usage in an Express.js route
+ * import express from 'express';
+ * import validate from 'express-zod-safe';
+ * import { z } from 'zod';
+ *
+ * const app = express();
+ *
+ * // Define your Zod schemas
+ * const params = {
+ *   userId: z.string().uuid(),
+ * };
+ * const query = {
+ *   age: z.coerce.number().optional(),
+ * };
+ * const body = {
+ *   name: z.string(),
+ *   email: z.string().email(),
+ * };
+ *
+ * // Use the validate middleware in your route
+ * app.post('/user/:userId', validate({ params, query, body }), (req, res) => {
+ *   // Your route logic here
+ *   res.send('User data is valid!');
+ * });
+ *
+ * app.listen(3000, () => console.log('Server running on port 3000'));
+ */
+declare function validate<TParams extends Validation = {}, TQuery extends Validation = {}, TBody extends Validation = {}>(schemas: ValidationSchemas<TParams, TQuery, TBody>): RequestHandler<ZodOutput<TParams>, any, ZodOutput<TBody>, ZodOutput<TQuery>>;
+/**
+ * Represents a generic type for route validation, which can be applied to params, query, or body.
+ * Each key-value pair represents a field and its corresponding Zod validation schema.
+ */
+type Validation = Record<string, z.ZodTypeAny>;
+/**
+ * Defines the structure for the schemas provided to the validate middleware.
+ * Each property corresponds to a different part of the request (params, query, body)
+ * and should be a record of Zod types for validation.
+ *
+ * @template TParams - Type definition for params schema.
+ * @template TQuery - Type definition for query schema.
+ * @template TBody - Type definition for body schema.
+ */
+interface ValidationSchemas<TParams extends Validation, TQuery extends Validation, TBody extends Validation> {
+    params?: TParams;
+    query?: TQuery;
+    body?: TBody;
+}
+/**
+ * Represents the output type of a Zod validation schema.
+ * This is used to infer the TypeScript type from a Zod schema,
+ * providing typesafe access to the validated data.
+ *
+ * @template T - The validation type (params, query, or body).
+ */
+type ZodOutput<T extends Validation> = z.ZodObject<T>['_output'];
+export = validate;

package/dist/index.js

@@ -0,0 +1,67 @@
+"use strict";
+const zod_1 = require("zod");
+const types = ['query', 'params', 'body'];
+/**
+ * Generates a middleware function for Express.js that validates request params, query, and body.
+ * This function uses Zod schemas to perform validation against the provided schema definitions.
+ *
+ * @param schemas - An object containing Zod schemas for params, query, and body.
+ * @returns An Express.js middleware function that validates the request based on the provided schemas.
+ *          It attaches validated data to the request object and sends error details if validation fails.
+ * @template TParams - Type definition for params schema.
+ * @template TQuery - Type definition for query schema.
+ * @template TBody - Type definition for body schema.
+ * @example
+ * // Example usage in an Express.js route
+ * import express from 'express';
+ * import validate from 'express-zod-safe';
+ * import { z } from 'zod';
+ *
+ * const app = express();
+ *
+ * // Define your Zod schemas
+ * const params = {
+ *   userId: z.string().uuid(),
+ * };
+ * const query = {
+ *   age: z.coerce.number().optional(),
+ * };
+ * const body = {
+ *   name: z.string(),
+ *   email: z.string().email(),
+ * };
+ *
+ * // Use the validate middleware in your route
+ * app.post('/user/:userId', validate({ params, query, body }), (req, res) => {
+ *   // Your route logic here
+ *   res.send('User data is valid!');
+ * });
+ *
+ * app.listen(3000, () => console.log('Server running on port 3000'));
+ */
+function validate(schemas) {
+    var _a, _b, _c;
+    // Create validation objects for each type
+    const validation = {
+        params: zod_1.z.object((_a = schemas.params) !== null && _a !== void 0 ? _a : {}).strict(),
+        query: zod_1.z.object((_b = schemas.query) !== null && _b !== void 0 ? _b : {}).strict(),
+        body: zod_1.z.object((_c = schemas.body) !== null && _c !== void 0 ? _c : {}).strict()
+    };
+    return (req, res, next) => {
+        const errors = [];
+        // Validate all types (params, query, body)
+        for (const type of types) {
+            const parsed = validation[type].safeParse(req[type]);
+            // @ts-expect-error This is fine
+            if (parsed.success)
+                req[type] = parsed.data;
+            else
+                errors.push({ type, errors: parsed.error });
+        }
+        // Return all errors if there are any
+        if (errors.length > 0)
+            return res.status(400).send(errors.map(error => ({ type: error.type, errors: error.errors })));
+        return next();
+    };
+}
+module.exports = validate;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "express-zod-safe",
+  "version": "1.0.0",
+  "description": "TypeScript-friendly middleware designed for Express applications, leveraging the robustness of Zod schemas to validate incoming request bodies, parameters, and queries.",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AngaBlue/exe.git"
+  },
+  "keywords": [
+    "zod",
+    "express",
+    "middleware",
+    "validation",
+    "guard",
+    "typesafe"
+  ],
+  "author": "AngaBlue <contact@anga.blue>",
+  "license": "LGPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/AngaBlue/exe/issues"
+  },
+  "homepage": "https://github.com/AngaBlue/exe#readme",
+  "devDependencies": {
+    "@angablue/eslint-config": "^1.4.4",
+    "@types/node": "^20.10.7",
+    "eslint": "^8.56.0",
+    "express": "^4.18.2",
+    "prettier": "^3.1.1",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.3.3",
+    "zod": "^3.22.4"
+  },
+  "peerDependencies": {
+    "@types/express": "^4.0.0",
+    "express": "^4.0.0",
+    "zod": "^3.0.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "pnpm run clean && tsc",
+    "lint": "eslint . --ext js,jsx,ts,tsx --fix"
+  }
+}