@jxsuite/protocol 4.0.0 → 5.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/package.json +2 -2
- package/src/routes.ts +0 -23
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jxsuite/protocol",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
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": {
|
|
@@ -27,6 +27,6 @@
|
|
|
27
27
|
"test:coverage": "bun test --isolate --coverage"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@jxsuite/schema": "^4.
|
|
30
|
+
"@jxsuite/schema": "^4.1.0"
|
|
31
31
|
}
|
|
32
32
|
}
|
package/src/routes.ts
CHANGED
|
@@ -12,17 +12,6 @@
|
|
|
12
12
|
/** Bumped when a route's request/response shape changes incompatibly. */
|
|
13
13
|
export const STUDIO_PROTOCOL_VERSION = 1;
|
|
14
14
|
|
|
15
|
-
/**
|
|
16
|
-
* Hidden file a browser-hosted Studio drops into a folder chosen with `showDirectoryPicker()` so
|
|
17
|
-
* the backend can find it (specs/desktop.md §8.2.1). Its contents are a one-shot random id; the
|
|
18
|
-
* backend matches on those contents, not on the filename, and deletes the file once it matches.
|
|
19
|
-
*
|
|
20
|
-
* Lives here because the writer (`@jxsuite/studio/directory-picker`) and the reader (the backend
|
|
21
|
-
* serving `locateDirectory`) must agree on it, and this package is the contract both already
|
|
22
|
-
* share.
|
|
23
|
-
*/
|
|
24
|
-
export const LOCATION_ID_FILE = ".jx-loc-id";
|
|
25
|
-
|
|
26
15
|
export type StudioRouteMethod = "GET" | "POST" | "PUT" | "DELETE";
|
|
27
16
|
|
|
28
17
|
export interface StudioRoute {
|
|
@@ -81,18 +70,6 @@ export const STUDIO_ROUTES = {
|
|
|
81
70
|
"Enumerate site projects [{config, path}] (backs listProjects)",
|
|
82
71
|
"The welcome screen's Projects catalogue stays hidden.",
|
|
83
72
|
),
|
|
84
|
-
findProject: route(
|
|
85
|
-
"GET",
|
|
86
|
-
"/__studio/find-project",
|
|
87
|
-
"Locate a project directory by name outside the root",
|
|
88
|
-
"openProject falls back to config-matching only.",
|
|
89
|
-
),
|
|
90
|
-
locateDirectory: route(
|
|
91
|
-
"GET",
|
|
92
|
-
"/__studio/locate-directory",
|
|
93
|
-
`Resolve the absolute path of a showDirectoryPicker() folder by the id in its ${LOCATION_ID_FILE}`,
|
|
94
|
-
"Browse… reports that the folder could not be placed; the Location is typed by hand.",
|
|
95
|
-
),
|
|
96
73
|
createProject: route(
|
|
97
74
|
"POST",
|
|
98
75
|
"/__studio/create-project",
|