express-zod-api 2.8.0 → 2.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/README.md +4 -4
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Version 2
|
|
4
4
|
|
|
5
|
+
### v2.8.1
|
|
6
|
+
|
|
7
|
+
- Fixed issue #169. Suddenly I found out that `yarn` does NOT respect `yarn.lock` files of sub-dependencies. So the
|
|
8
|
+
version of `zod` defined in my `yarn.lock` file does not actually mean anything when doing `yarn add express-zod-api`.
|
|
9
|
+
- The recently released version of Zod (3.10.x) seems to have some breaking changes, it should not be installed
|
|
10
|
+
according to my lock file.
|
|
11
|
+
- I'm locking the dependency versions in `package.json` file from now on.
|
|
12
|
+
- `npm` users are also affected since the distributed lock file is for `yarn`.
|
|
13
|
+
|
|
5
14
|
### v2.8.0
|
|
6
15
|
|
|
7
16
|
- I did my best in order to improve the documentation and list the recently implemented features.
|
package/README.md
CHANGED
|
@@ -78,7 +78,7 @@ Therefore, many basic tasks can be accomplished faster and easier, in particular
|
|
|
78
78
|
The API operates object schemas for input and output validation.
|
|
79
79
|
The object being validated is the combination of certain `request` properties.
|
|
80
80
|
It is available to the endpoint handler as the `input` parameter.
|
|
81
|
-
Middlewares have access all `request` properties, they can provide endpoints with `options`.
|
|
81
|
+
Middlewares have access to all `request` properties, they can provide endpoints with `options`.
|
|
82
82
|
The object returned by the endpoint handler is called `output`. It goes to the `ResultHandler` which is
|
|
83
83
|
responsible for transmission of the final response containing the `output` or possible error.
|
|
84
84
|
Much can be customized to fit your needs.
|
|
@@ -91,7 +91,7 @@ Much can be customized to fit your needs.
|
|
|
91
91
|
|
|
92
92
|
```shell
|
|
93
93
|
yarn add express-zod-api
|
|
94
|
-
# or
|
|
94
|
+
# or
|
|
95
95
|
npm install express-zod-api
|
|
96
96
|
```
|
|
97
97
|
|
|
@@ -235,7 +235,7 @@ const yourEndpoint = defaultEndpointsFactory
|
|
|
235
235
|
});
|
|
236
236
|
```
|
|
237
237
|
|
|
238
|
-
Here is an example the authentication middleware, that checks a `key` from input and `token` from headers:
|
|
238
|
+
Here is an example of the authentication middleware, that checks a `key` from input and `token` from headers:
|
|
239
239
|
|
|
240
240
|
```typescript
|
|
241
241
|
import {
|
|
@@ -498,7 +498,7 @@ const routing: Routing = {
|
|
|
498
498
|
|
|
499
499
|
## Customizing input sources
|
|
500
500
|
|
|
501
|
-
You customize the list of `request` properties that are combined into
|
|
501
|
+
You can customize the list of `request` properties that are combined into `input` that is being validated and available
|
|
502
502
|
to your endpoints and middlewares.
|
|
503
503
|
|
|
504
504
|
```typescript
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "express-zod-api",
|
|
3
|
-
"version": "2.8.
|
|
3
|
+
"version": "2.8.1",
|
|
4
4
|
"description": "A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"scripts": {
|
|
@@ -23,13 +23,13 @@
|
|
|
23
23
|
"main": "dist/index.js",
|
|
24
24
|
"types": "dist/index.d.ts",
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"express": "
|
|
27
|
-
"express-fileupload": "
|
|
28
|
-
"http-errors": "
|
|
29
|
-
"mime": "
|
|
30
|
-
"openapi3-ts": "
|
|
31
|
-
"winston": "
|
|
32
|
-
"zod": "
|
|
26
|
+
"express": "4.17.1",
|
|
27
|
+
"express-fileupload": "1.2.1",
|
|
28
|
+
"http-errors": "1.8.0",
|
|
29
|
+
"mime": "2.5.2",
|
|
30
|
+
"openapi3-ts": "2.0.1",
|
|
31
|
+
"winston": "3.3.3",
|
|
32
|
+
"zod": "3.9.8"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@tsconfig/node10": "^1.0.8",
|