@jeffusion/bungee-types 5.21.0 → 5.21.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 +7 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -13,13 +13,13 @@ bun add @jeffusion/bungee-types
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type { AppConfig, RouteConfig
|
|
16
|
+
import type { AppConfig, RouteConfig } from '@jeffusion/bungee-types';
|
|
17
17
|
|
|
18
18
|
const config: AppConfig = {
|
|
19
19
|
routes: [
|
|
20
20
|
{
|
|
21
21
|
path: '/api',
|
|
22
|
-
|
|
22
|
+
endpoints: [
|
|
23
23
|
{ target: 'http://localhost:3000' }
|
|
24
24
|
]
|
|
25
25
|
}
|
|
@@ -32,8 +32,7 @@ const config: AppConfig = {
|
|
|
32
32
|
### Core Configuration Types
|
|
33
33
|
- `AppConfig` - Main application configuration
|
|
34
34
|
- `RouteConfig` - Route configuration with upstreams and plugins
|
|
35
|
-
- `
|
|
36
|
-
- `Upstream` - Upstream server configuration
|
|
35
|
+
- `Endpoint` - Upstream target, weight, conditions and directional rules
|
|
37
36
|
|
|
38
37
|
### Modification and Plugin Types
|
|
39
38
|
- `ModificationRules` - Request/response modification rules
|
|
@@ -42,7 +41,7 @@ const config: AppConfig = {
|
|
|
42
41
|
|
|
43
42
|
## Type Exports
|
|
44
43
|
|
|
45
|
-
###
|
|
44
|
+
### Root Entry
|
|
46
45
|
```typescript
|
|
47
46
|
import type { AppConfig } from '@jeffusion/bungee-types';
|
|
48
47
|
```
|
|
@@ -54,7 +53,9 @@ import type { RouteConfig } from '@jeffusion/bungee-types/types';
|
|
|
54
53
|
|
|
55
54
|
## Documentation
|
|
56
55
|
|
|
57
|
-
For
|
|
56
|
+
For storage aggregates and runtime validation, see [configuration reference](../../docs/reference/configuration.md). Management identity and proxy Keys are plugin capabilities; an exported TypeScript shape does not bypass configuration validation.
|
|
57
|
+
|
|
58
|
+
Plugin runtime interfaces use `@jeffusion/bungee-core/plugin`, not this package.
|
|
58
59
|
|
|
59
60
|
## License
|
|
60
61
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jeffusion/bungee-types",
|
|
3
|
-
"version": "5.21.
|
|
3
|
+
"version": "5.21.1",
|
|
4
4
|
"description": "TypeScript type definitions for Bungee",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"scripts": {
|
|
9
9
|
"build": "tsc",
|
|
10
10
|
"prepublishOnly": "bun run build",
|
|
11
|
-
"test": "bun run build && bun test tests/
|
|
11
|
+
"test": "bun run build && bun test tests/"
|
|
12
12
|
},
|
|
13
13
|
"exports": {
|
|
14
14
|
".": {
|