@buildplease/apikit 1.0.0 → 1.0.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 +33 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @buildplease/apikit
|
|
2
|
+
|
|
3
|
+
ApiKit is the BuildPlease backend runtime for Fastify applications. It combines typed application configuration with server infrastructure, dependency injection, validation, localization, HTTP primitives, and common backend services.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @buildplease/apikit
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
ApiKit applications are configured with `defineApiKit` and can use the backend primitives directly from the package:
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { defineApiKit, defineEnvironments, ServerController } from '@buildplease/apikit';
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
ApiKit also re-exports the Core and Core Node APIs used by backend applications.
|
|
20
|
+
|
|
21
|
+
## What’s included
|
|
22
|
+
|
|
23
|
+
- typed configuration and environment loading
|
|
24
|
+
- Fastify server, request, response, cookie, CORS, multipart, static, health, and metrics support
|
|
25
|
+
- dependency injection and application assemblies
|
|
26
|
+
- validation, errors, formatting, and normalization
|
|
27
|
+
- i18n and L10n resources
|
|
28
|
+
- OpenAPI helpers
|
|
29
|
+
- email and notification infrastructure
|
|
30
|
+
- files, images, database helpers, cryptography, and tokens
|
|
31
|
+
- `apikit` CLI
|
|
32
|
+
|
|
33
|
+
Part of [BuildPlease](https://github.com/BuildPlease/buildplease).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@buildplease/apikit",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"keywords": [],
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
"nodemailer": "9.0.5",
|
|
64
64
|
"uuid": "14.0.1",
|
|
65
65
|
"validator": "13.15.35",
|
|
66
|
-
"@buildplease/core": "1.0.
|
|
66
|
+
"@buildplease/core": "1.0.1"
|
|
67
67
|
},
|
|
68
68
|
"devDependencies": {
|
|
69
69
|
"@types/ejs": "3.1.5",
|