@jxsuite/protocol 0.1.0 → 0.3.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 +3 -1
- package/package.json +3 -3
- package/src/routes.ts +10 -0
package/README.md
CHANGED
|
@@ -62,4 +62,6 @@ doc?, options? }` through the project's format registry; without it only
|
|
|
62
62
|
|
|
63
63
|
The types are published as TypeScript source (like every `@jxsuite` package)
|
|
64
64
|
and follow the monorepo's release train. Within the monorepo, packages depend
|
|
65
|
-
on it via `workspace:^`.
|
|
65
|
+
on it via `workspace:^`. Consumers install `@jxsuite/protocol` and import its
|
|
66
|
+
`/types` and `/routes` entrypoints; its only runtime dependency is
|
|
67
|
+
`@jxsuite/schema`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jxsuite/protocol",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "The Studio Backend Protocol — wire types and the canonical route table every Jx Studio backend implements",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -18,13 +18,13 @@
|
|
|
18
18
|
"./routes": "./src/routes.ts"
|
|
19
19
|
},
|
|
20
20
|
"publishConfig": {
|
|
21
|
-
"provenance":
|
|
21
|
+
"provenance": true
|
|
22
22
|
},
|
|
23
23
|
"scripts": {
|
|
24
24
|
"test": "bun test --isolate",
|
|
25
25
|
"test:coverage": "bun test --isolate --coverage"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@jxsuite/schema": "
|
|
28
|
+
"@jxsuite/schema": "^0.35.0"
|
|
29
29
|
}
|
|
30
30
|
}
|
package/src/routes.ts
CHANGED
|
@@ -84,6 +84,16 @@ export const STUDIO_ROUTES = {
|
|
|
84
84
|
fileUpload: route("POST", "/__studio/file/upload", "Upload binary content to a path"),
|
|
85
85
|
fileRename: route("POST", "/__studio/file/rename", "Rename/move (+ refactor report)"),
|
|
86
86
|
locate: route("POST", "/__studio/locate", "Find a file by name → {path | null}"),
|
|
87
|
+
collab: route(
|
|
88
|
+
"GET",
|
|
89
|
+
"/__studio/collab",
|
|
90
|
+
"Realtime co-editing: a WebSocket upgrade speaking the @jxsuite/collab wire envelope (one " +
|
|
91
|
+
"socket per project, documents multiplexed by path; y-protocols sync + project-level " +
|
|
92
|
+
"awareness in lib0 binary frames — see @jxsuite/collab/envelope for the frame layout and " +
|
|
93
|
+
"the docEpoch/doc-reset lifecycle). A plain GET (no Upgrade) answers {collab: true, " +
|
|
94
|
+
"version} as the capability probe.",
|
|
95
|
+
"Realtime co-editing is unavailable; Studio edits solo with file-level saves",
|
|
96
|
+
),
|
|
87
97
|
|
|
88
98
|
// ─── Documents / components / formats ─────────────────────────────────────
|
|
89
99
|
components: route("GET", "/__studio/components", "Discover components (ComponentMeta[])"),
|