tsoa-next 8.2.1 → 8.2.2-dev.74.74f8c5c4
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/README.MD +9 -5
- package/package.json +4 -4
package/README.MD
CHANGED
|
@@ -28,7 +28,7 @@ Where historical release notes or migration references still point upstream, the
|
|
|
28
28
|
## Goal
|
|
29
29
|
|
|
30
30
|
- TypeScript controllers and models as the single source of truth for your API
|
|
31
|
-
- A valid OpenAPI (formerly Swagger)
|
|
31
|
+
- A valid OpenAPI (formerly Swagger) 2.0, 3.0, or 3.1 spec is generated from your controllers and models, including:
|
|
32
32
|
- Paths (e.g. GET /users)
|
|
33
33
|
- Definitions based on TypeScript interfaces (models)
|
|
34
34
|
- Parameters/model properties marked as required or optional based on TypeScript (e.g. myProperty?: string is optional in the OpenAPI spec)
|
|
@@ -44,8 +44,8 @@ Where historical release notes or migration references still point upstream, the
|
|
|
44
44
|
- Use jsdoc for pure text metadata (e.g. endpoint descriptions)
|
|
45
45
|
- Minimize boilerplate
|
|
46
46
|
- Models are best represented by interfaces (pure data structures), but can also be represented by classes
|
|
47
|
-
- Runtime validation of tsoa-next should behave as closely as possible to the specifications that the generated OpenAPI
|
|
48
|
-
- Please note that by enabling OpenAPI 3 you minimize the chances of divergent validation logic since
|
|
47
|
+
- Runtime validation of tsoa-next should behave as closely as possible to the specifications that the generated OpenAPI schema describes. Any differences in validation logic are clarified by logging warnings during the generation of the OpenAPI Specification (OAS) and/or the routes.
|
|
48
|
+
- Please note that by enabling OpenAPI 3.0 or 3.1 you minimize the chances of divergent validation logic since the newer schema shapes are more expressive than OpenAPI 2.0.
|
|
49
49
|
|
|
50
50
|
## Feature List
|
|
51
51
|
|
|
@@ -62,18 +62,22 @@ Where historical release notes or migration references still point upstream, the
|
|
|
62
62
|
- Customize validation translation and failure formatting through the optional validation context accepted by generated `RegisterRoutes(...)` functions.
|
|
63
63
|
- Support authentication hooks, dependency injection, typed alternate responders, file uploads, custom middleware, and custom validation workflows.
|
|
64
64
|
- Use the `tsoa` CLI for spec and route generation, or call the programmatic APIs from `tsoa-next/cli`.
|
|
65
|
-
- Target
|
|
65
|
+
- Target Node.js 22 and newer, with the compatibility matrix running on Node.js 22, 24, and 26.
|
|
66
66
|
|
|
67
67
|
## Getting Started
|
|
68
68
|
|
|
69
69
|
- Requirements:
|
|
70
70
|
- Node.js 22 or newer
|
|
71
71
|
- npm 10 or newer
|
|
72
|
-
- We verify support
|
|
72
|
+
- We verify support on Node.js 22, 24, and 26 in CI
|
|
73
73
|
- [Documentation](https://tsoa-next.dev/)
|
|
74
74
|
- [API Reference](https://tsoa-next.dev/reference/)
|
|
75
75
|
- [Getting started guide](https://tsoa-next.dev/getting-started)
|
|
76
76
|
|
|
77
|
+
These are consumer requirements for the published packages. Contributors use the repository's pinned `npm@12.0.1` on a Node.js version supported by npm 12; the Node.js 22 compatibility jobs intentionally use the npm version bundled with that Node.js release.
|
|
78
|
+
|
|
79
|
+
Dependency update policy, intentional version holds, override rationale, and accepted upstream findings are documented in [Dependency Maintenance](https://github.com/tsoa-next/tsoa-next/blob/main/docs/DEPENDENCIES.md).
|
|
80
|
+
|
|
77
81
|
## Package Surface
|
|
78
82
|
|
|
79
83
|
- Import decorators, runtime helpers, and generated route support from `tsoa-next`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tsoa-next",
|
|
3
|
-
"version": "8.2.
|
|
3
|
+
"version": "8.2.2-dev.74.74f8c5c4",
|
|
4
4
|
"description": "Build swagger-compliant REST APIs using TypeScript and Node",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"typings": "./dist/index.d.ts",
|
|
@@ -32,11 +32,11 @@
|
|
|
32
32
|
"author": "Vanna DiCatania <vanna@dicatania.me> (http://www.dicatania.me)",
|
|
33
33
|
"license": "MIT",
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@tsoa-next/cli": "8.2.
|
|
36
|
-
"@tsoa-next/runtime": "8.2.
|
|
35
|
+
"@tsoa-next/cli": "8.2.2-dev.74.74f8c5c4",
|
|
36
|
+
"@tsoa-next/runtime": "8.2.2-dev.74.74f8c5c4"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@types/node": "
|
|
39
|
+
"@types/node": "22.20.0",
|
|
40
40
|
"typescript": "^5.9.3"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|