@authuser/nest 0.1.0 → 0.1.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/README.md +13 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,13 @@
|
|
|
9
9
|
<img alt="Node 20+" src="https://img.shields.io/badge/node-%3E%3D20.11-339933?style=flat-square&logo=node.js&logoColor=white">
|
|
10
10
|
<img alt="NestJS 12" src="https://img.shields.io/badge/NestJS-12-E0234E?style=flat-square&logo=nestjs&logoColor=white">
|
|
11
11
|
<img alt="Fastify 5" src="https://img.shields.io/badge/Fastify-5-black?style=flat-square&logo=fastify">
|
|
12
|
-
<a href="
|
|
12
|
+
<a href="https://github.com/authuser-org/nest/blob/main/LICENSE"><img alt="MIT" src="https://img.shields.io/badge/license-MIT-green?style=flat-square"></a>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://github.com/authuser-org/nest/"><strong>GitHub</strong></a> ·
|
|
17
|
+
<a href="https://github.com/authuser-org/nest/tree/main/docs"><strong>Documentation</strong></a> ·
|
|
18
|
+
<a href="https://github.com/authuser-org/nest/tree/main/example"><strong>Example</strong></a>
|
|
13
19
|
</p>
|
|
14
20
|
|
|
15
21
|
`@authuser/nest` creates a normal `NestFastifyApplication` with careful production
|
|
@@ -160,8 +166,8 @@ The decorators intentionally do not provide authentication. Authentication polic
|
|
|
160
166
|
belongs to the consuming application; pretending otherwise would create a dangerous
|
|
161
167
|
security boundary.
|
|
162
168
|
|
|
163
|
-
See the [complete option reference](
|
|
164
|
-
[security model](
|
|
169
|
+
See the [complete option reference](https://github.com/authuser-org/nest/blob/main/docs/configuration.md), the
|
|
170
|
+
[security model](https://github.com/authuser-org/nest/blob/main/docs/security.md), and the [performance guide](https://github.com/authuser-org/nest/blob/main/docs/performance.md).
|
|
165
171
|
|
|
166
172
|
## Performance notes
|
|
167
173
|
|
|
@@ -173,7 +179,7 @@ application before trading away Nest maintainability.
|
|
|
173
179
|
|
|
174
180
|
For the hottest path, use `preset: 'minimal'`, leave request logging and compression
|
|
175
181
|
off, declare response schemas in Fastify-compatible routes, and benchmark with your
|
|
176
|
-
actual payloads. See [
|
|
182
|
+
actual payloads. See the [performance guide](https://github.com/authuser-org/nest/blob/main/docs/performance.md).
|
|
177
183
|
|
|
178
184
|
## Migration from `@authuser/nest-fastify-kit`
|
|
179
185
|
|
|
@@ -184,7 +190,7 @@ actual payloads. See [docs/performance.md](./docs/performance.md).
|
|
|
184
190
|
|
|
185
191
|
The new package targets Nest 12, uses ESM, calls Swagger configuration `openApi`, and
|
|
186
192
|
ships required integrations as normal dependencies. See the
|
|
187
|
-
[migration guide](
|
|
193
|
+
[migration guide](https://github.com/authuser-org/nest/blob/main/docs/migration.md).
|
|
188
194
|
|
|
189
195
|
## Development
|
|
190
196
|
|
|
@@ -194,8 +200,8 @@ npm run check
|
|
|
194
200
|
```
|
|
195
201
|
|
|
196
202
|
An executable API and an importable Postman collection are available in the
|
|
197
|
-
[`example`](
|
|
203
|
+
[`example`](https://github.com/authuser-org/nest/tree/main/example) directory.
|
|
198
204
|
|
|
199
205
|
## License
|
|
200
206
|
|
|
201
|
-
[MIT](
|
|
207
|
+
[MIT](https://github.com/authuser-org/nest/blob/main/LICENSE) © Authuser
|