@velajs/studio-protocol 2.0.0
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/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +21 -0
- package/dist/index.d.ts +1285 -0
- package/dist/index.js +775 -0
- package/dist/index.js.map +1 -0
- package/package.json +57 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ksh
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# @velajs/studio-protocol
|
|
2
|
+
|
|
3
|
+
Shared wire types, constants and boundary validators for Studio host, server and UI.
|
|
4
|
+
|
|
5
|
+
Protocol v2 introduces `StudioConnection`, validated with `parseStudioConnection`, and
|
|
6
|
+
`StudioCapabilities.operations`. `api.authorizeTryIt` replaces in-process `api.tryit`:
|
|
7
|
+
it authorizes the local host to execute actual Worker HTTP. `TryItRequest` and
|
|
8
|
+
`TryItResponse` are validated at the host/browser boundary. Model descriptors include
|
|
9
|
+
`supports.bulkWrites` for adapters with transaction support.
|
|
10
|
+
|
|
11
|
+
`parseStudioResponse(op, value)` validates every result against the operation's
|
|
12
|
+
concrete Zod schema. `parseStudioRpcResponse(op, value)` also checks the envelope,
|
|
13
|
+
operation identity, metadata and error fields. The browser client uses these
|
|
14
|
+
parsers before exposing typed results; callers cannot choose an arbitrary result
|
|
15
|
+
type. Dynamic model rows and OpenAPI documents retain their declared unknown data.
|
|
16
|
+
|
|
17
|
+
Upgrade host, server and UI together. There is no protocol-v1 compatibility path.
|
|
18
|
+
|
|
19
|
+
## License
|
|
20
|
+
|
|
21
|
+
MIT
|