@kubb/studio 5.3.17 → 5.3.19
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 +8 -1
- package/dist/index.cjs +367 -355
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +28 -14
- package/dist/index.js +367 -355
- package/dist/index.js.map +1 -1
- package/dist/protocol.cjs.map +1 -1
- package/dist/protocol.d.ts +5 -16
- package/dist/protocol.js.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -68,6 +68,14 @@ The runtime discovers nothing on its own: the host injects the config loader, th
|
|
|
68
68
|
own version. That is what lets one runtime serve a CLI running in a developer's project and a
|
|
69
69
|
container running a fixed plugin set.
|
|
70
70
|
|
|
71
|
+
## Package layers
|
|
72
|
+
|
|
73
|
+
`src/protocol` defines the shared wire contracts and imports no Studio implementation. `src/operations`
|
|
74
|
+
contains focused work such as pairing, generation, config edits, snapshots, and transport; it may
|
|
75
|
+
import the protocol. `src/runtime` owns connection state and coordinates operations; it may import
|
|
76
|
+
both lower layers. Keep new code in the lowest layer that can own it, with direct internal imports.
|
|
77
|
+
Only `@kubb/studio` and `@kubb/studio/protocol` are public entry points.
|
|
78
|
+
|
|
71
79
|
## Hosts and the runtime
|
|
72
80
|
|
|
73
81
|
Three hosts run this package: `kubb studio`, the `kubblabs/kubb-agent` Docker image, and
|
|
@@ -97,7 +105,6 @@ Every permission is off by default, and each covers one trust boundary:
|
|
|
97
105
|
| Option | What it grants |
|
|
98
106
|
| ----------------- | ---------------------------------------------------------------------------------------------- |
|
|
99
107
|
| `allowWrite` | Generated files are written to disk. Off means they exist only in memory and stream to Studio. |
|
|
100
|
-
| `allowInput` | An OpenAPI spec sent by Studio replaces the one on disk. |
|
|
101
108
|
| `allowExec` | The formatter, the linter, and `output.postGenerate` run as child processes. |
|
|
102
109
|
| `allowConfigEdit` | Studio may change plugin options in `kubb.config.ts`. |
|
|
103
110
|
| `allowRead` | Studio may read back the files a generation produced. |
|