@buildplease/apikit 1.0.1 → 1.0.2

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.
Files changed (4) hide show
  1. package/README.md +13 -15
  2. package/dist/src/index.d.cts +1 -1
  3. package/dist/src/index.d.mts +1 -1
  4. package/package.json +9 -9
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # @buildplease/apikit
2
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.
3
+ ApiKit is the BuildPlease application kit for backend services and APIs. It builds on Core and provides the runtime and infrastructure needed for Fastify applications.
4
4
 
5
- ## Install
5
+ ## Installation
6
6
 
7
7
  ```bash
8
8
  pnpm add @buildplease/apikit
@@ -10,24 +10,22 @@ pnpm add @buildplease/apikit
10
10
 
11
11
  ## Usage
12
12
 
13
- ApiKit applications are configured with `defineApiKit` and can use the backend primitives directly from the package:
14
-
15
13
  ```ts
16
- import { defineApiKit, defineEnvironments, ServerController } from '@buildplease/apikit';
14
+ import { defineApiKit, ServerController } from '@buildplease/apikit';
17
15
  ```
18
16
 
19
- ApiKit also re-exports the Core and Core Node APIs used by backend applications.
17
+ ApiKit also exposes the BuildPlease primitives commonly used by backend applications.
20
18
 
21
- ## What’s included
19
+ ## Features
22
20
 
23
- - typed configuration and environment loading
24
- - Fastify server, request, response, cookie, CORS, multipart, static, health, and metrics support
21
+ - typed application configuration and environments
22
+ - Fastify server and HTTP infrastructure
25
23
  - dependency injection and application assemblies
26
24
  - 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
25
+ - i18n and L10n integration
26
+ - OpenAPI, notifications, email, files, and database helpers
27
+ - backend CLI tooling
28
+
29
+ ## License
32
30
 
33
- Part of [BuildPlease](https://github.com/BuildPlease/buildplease).
31
+ MIT
package/dist/src/index.d.cts CHANGED
@@ -482,7 +482,7 @@ declare const NotificationConfiguration: ConfigurationContract<NotificationConfi
482
482
  type NotificationConfig = InferConfiguration<typeof NotificationConfiguration>;
483
483
  //#endregion
484
484
  //#region src/configuration/configs/server.d.ts
485
- type TrustProxy = boolean | string | number | string[] | ((address: string, hop: number) => boolean);
485
+ type TrustProxy = boolean | string | string[] | ((address: string, hop: number) => boolean);
486
486
  declare const ServerConfiguration: ConfigurationContract<{
487
487
  readonly identifier: string;
488
488
  readonly debug: boolean;
package/dist/src/index.d.mts CHANGED
@@ -482,7 +482,7 @@ declare const NotificationConfiguration: ConfigurationContract<NotificationConfi
482
482
  type NotificationConfig = InferConfiguration<typeof NotificationConfiguration>;
483
483
  //#endregion
484
484
  //#region src/configuration/configs/server.d.ts
485
- type TrustProxy = boolean | string | number | string[] | ((address: string, hop: number) => boolean);
485
+ type TrustProxy = boolean | string | string[] | ((address: string, hop: number) => boolean);
486
486
  declare const ServerConfiguration: ConfigurationContract<{
487
487
  readonly identifier: string;
488
488
  readonly debug: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@buildplease/apikit",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "keywords": [],
5
5
  "repository": {
6
6
  "type": "git",
@@ -41,11 +41,12 @@
41
41
  "resources"
42
42
  ],
43
43
  "dependencies": {
44
+ "@buildplease/core": "1.0.2",
44
45
  "@dotenvx/dotenvx": "2.21.0",
45
46
  "@fastify/basic-auth": "6.3.0",
46
47
  "@fastify/cookie": "11.1.2",
47
48
  "@fastify/cors": "11.3.0",
48
- "@fastify/multipart": "10.1.0",
49
+ "@fastify/multipart": "10.1.1",
49
50
  "@fastify/static": "10.1.3",
50
51
  "@fastify/under-pressure": "9.1.0",
51
52
  "@fastify/view": "12.0.0",
@@ -55,27 +56,26 @@
55
56
  "fastify-ip": "2.0.0",
56
57
  "fastify-metrics": "13.2.1",
57
58
  "fastify-plugin": "6.0.0",
58
- "i18next": "26.3.6",
59
+ "i18next": "26.4.0",
59
60
  "jiti": "2.7.0",
60
61
  "libphonenumber-js": "1.13.11",
61
62
  "lodash.merge": "4.6.2",
62
63
  "mime-types": "3.0.2",
63
64
  "nodemailer": "9.0.5",
64
- "uuid": "14.0.1",
65
- "validator": "13.15.35",
66
- "@buildplease/core": "1.0.1"
65
+ "uuid": "14.0.2",
66
+ "validator": "13.15.35"
67
67
  },
68
68
  "devDependencies": {
69
+ "@buildplease/identity": "1.0.0",
69
70
  "@types/ejs": "3.1.5",
70
71
  "@types/lodash.merge": "4.6.9",
71
72
  "@types/mime-types": "3.0.1",
72
73
  "@types/nodemailer": "8.0.1",
73
74
  "@types/validator": "13.15.10",
74
- "code-block-writer": "13.0.3",
75
- "@buildplease/identity": "1.0.0"
75
+ "code-block-writer": "13.0.3"
76
76
  },
77
77
  "peerDependencies": {
78
- "fastify": "5.12.0",
78
+ "fastify": "5.12.1",
79
79
  "inversify": "8.2.3",
80
80
  "reflect-metadata": "0.2.2",
81
81
  "sharp": "0.35.3",