express-zod-api 14.0.0-beta1 → 14.0.0

package/CHANGELOG.md

@@ -9,15 +9,17 @@
     - You might also need to install `@types/http-errors` if you're using `createHttpError` in your implementation.
   - `typescript` is a required peer dependency.
   - Minimum version of `zod` is 3.22.3.
-  - The following ones are optional peer dependencies: `@types/compression`, `@types/express-fileupload`, `@types/node`.
   - The class `DependsOnMethodError` is removed — catch `RoutingError` instead if needed.
 - **Potentially breaking changes**:
   - The type `FlatObject` changed from `Record<string, any>` to `Record<string, unknown>`.
     - If a custom `ResultHandler` handles properties of the `output`, it might need to ensure its actual type.
-  - In case of body parsing failure the `ResultHandler` recieves `null` into its `input` argument instead of raw body.
+  - In case of body parsing failure the `ResultHandler` receives `null` into its `input` argument instead of raw body.
     - Utilize the `request.body` within a custom `ResultHandler` in that case if needed.
-  - The type of `ResultHandler`'s arguments `input` and `output` are changed from `any` to `FlatObject | null`.
-- Unlikely breaking changes:
+  - The type of `ResultHandler`'s arguments `input` and `output` is changed from `any` to `FlatObject | null`.
+- Other changes:
+  - Ensure having the following packages installed for the types assistance:
+    - `yarn add --dev @types/express @types/node @types/http-errors`
+    - or `npm install -D @types/express @types/node @types/http-errors`
   - The property `DependsOnMethod::methods` is renamed to `endpoints`.
 
 ```typescript
@@ -29,6 +31,12 @@ import createHttpError from "http-errors";
 
 ## Version 12
 
+### v12.5.1
+
+- Technical update before releasing next major version.
+- I also would like to remind you to upgrade your `zod` (peer dependency) to at least 3.22.3.
+  - Check out [the security advice](https://github.com/advisories/GHSA-m95q-7qp3-xv42) to find out why.
+
 ### v12.5.0
 
 - Featuring an ability to specify multiple server URLs when generating documentation.

package/README.md

@@ -104,12 +104,18 @@ Much can be customized to fit your needs.
 
 ## Installation
 
-Run one of the following commands to install the library and its peer dependencies.
+Run one of the following commands to install the library, its peer dependencies and packages for types assistance.
 
 ```shell
 yarn add express-zod-api express zod winston typescript http-errors
-# or
+yarn add --dev @types/express @types/node @types/http-errors
+```
+
+or
+
+```shell
 npm install express-zod-api express zod winston typescript http-errors
+npm install -D @types/express @types/node @types/http-errors
 ```
 
 Add the following option to your `tsconfig.json` file in order to make it work as expected:
@@ -820,9 +826,9 @@ const config = createConfig({
 const { app, httpServer, httpsServer, logger } = createServer(config, routing);
 ```
 
-At least you need to specify the port or socket (usually it is 443), certificate and the key, issued by the
-certifying authority. For example, you can acquire a free TLS certificate for your API at
-[Let's Encrypt](https://letsencrypt.org/).
+Ensure having `@types/node` package installed. At least you need to specify the port or socket (usually it is 443),
+certificate and the key, issued by the certifying authority. For example, you can acquire a free TLS certificate for
+your API at [Let's Encrypt](https://letsencrypt.org/).
 
 ## Generating a Frontend Client
 

package/SECURITY.md

@@ -24,6 +24,6 @@
 Found a vulnerability or other security issue?
 
 Please urgently inform me privately by
-[email](https://github.com/RobinTail/express-zod-api/blob/master/package.json#L146).
+[email](https://github.com/RobinTail/express-zod-api/blob/master/package.json#L137).
 
 I will try to fix it as soon as possible.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-zod-api",
-  "version": "14.0.0-beta1",
+  "version": "14.0.0",
   "description": "A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
   "license": "MIT",
   "scripts": {
@@ -46,15 +46,15 @@
     }
   },
   "dependencies": {
-    "compression": "1.7.4",
-    "express-fileupload": "1.4.1",
+    "@types/compression": "^1.7.3",
+    "@types/express-fileupload": "^1.4.2",
+    "compression": "~1.7.4",
+    "express-fileupload": "~1.4.1",
     "openapi3-ts": "^4.1.2",
-    "ramda": "0.29.1"
+    "ramda": "~0.29.1"
   },
   "peerDependencies": {
-    "@types/compression": "^1.7.3",
     "@types/express": "^4.17.13",
-    "@types/express-fileupload": "^1.4.2",
     "@types/http-errors": "^2.0.2",
     "@types/jest": "*",
     "@types/node": "*",
@@ -66,22 +66,16 @@
     "zod": "^3.22.3"
   },
   "peerDependenciesMeta": {
-    "@types/compression": {
-      "optional": true
-    },
     "@types/express": {
       "optional": true
     },
-    "@types/express-fileupload": {
-      "optional": true
-    },
     "@types/http-errors": {
       "optional": true
     },
-    "@types/jest": {
+    "@types/node": {
       "optional": true
     },
-    "@types/node": {
+    "@types/jest": {
       "optional": true
     },
     "jest": {
@@ -94,14 +88,11 @@
     "@swc/core": "^1.3.92",
     "@swc/jest": "^0.2.29",
     "@tsconfig/node18": "^18.2.1",
-    "@types/compression": "^1.7.3",
     "@types/cors": "^2.8.14",
     "@types/express": "^4.17.17",
-    "@types/express-fileupload": "^1.4.2",
     "@types/has-ansi": "^5.0.0",
     "@types/http-errors": "^2.0.2",
     "@types/jest": "^29.5.4",
-    "@types/mime": "^3.0.1",
     "@types/node": "^20.8.4",
     "@types/ramda": "^0.29.3",
     "@types/triple-beam": "^1.3.2",