@gonvex/protocol 0.1.0 → 0.1.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.
- package/README.md +42 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @gonvex/protocol
|
|
2
|
+
|
|
3
|
+
Shared TypeScript protocol types for Gonvex browser clients, React bindings, and
|
|
4
|
+
tooling.
|
|
5
|
+
|
|
6
|
+
Most applications do not need to import this package directly. It is primarily
|
|
7
|
+
used by `@gonvex/client`, `@gonvex/react`, and generated bindings.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @gonvex/protocol
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Types
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import type {
|
|
19
|
+
ClientMessage,
|
|
20
|
+
FunctionKind,
|
|
21
|
+
GonvexManifest,
|
|
22
|
+
JsonValue,
|
|
23
|
+
ServerMessage,
|
|
24
|
+
} from "@gonvex/protocol";
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The package includes:
|
|
28
|
+
|
|
29
|
+
- JSON-safe value types
|
|
30
|
+
- function manifest types
|
|
31
|
+
- WebSocket client and server message unions
|
|
32
|
+
- browser telemetry and message trace types
|
|
33
|
+
|
|
34
|
+
## Related Packages
|
|
35
|
+
|
|
36
|
+
- `@gonvex/client` - uses these messages over WebSocket
|
|
37
|
+
- `@gonvex/react` - React hooks for generated functions
|
|
38
|
+
- `@gonvex/cli` - generates bindings and syncs manifests
|
|
39
|
+
|
|
40
|
+
## Documentation
|
|
41
|
+
|
|
42
|
+
Full docs live at https://desarso.github.io/gonvex/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gonvex/protocol",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -17,7 +17,8 @@
|
|
|
17
17
|
},
|
|
18
18
|
"main": "./dist/index.js",
|
|
19
19
|
"files": [
|
|
20
|
-
"dist"
|
|
20
|
+
"dist",
|
|
21
|
+
"README.md"
|
|
21
22
|
],
|
|
22
23
|
"scripts": {
|
|
23
24
|
"build": "tsc -p tsconfig.json",
|