@jxsuite/protocol 5.0.0 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jxsuite/protocol",
-  "version": "5.0.0",
+  "version": "6.1.0",
   "description": "The Studio Backend Protocol — wire types and the canonical route table every Jx Studio backend implements",
   "license": "MIT",
   "repository": {
@@ -27,6 +27,6 @@
     "test:coverage": "bun test --isolate --coverage"
   },
   "dependencies": {
-    "@jxsuite/schema": "^4.1.0"
+    "@jxsuite/schema": "^5.0.0"
   }
 }

package/src/routes.ts

@@ -335,13 +335,21 @@ export const STUDIO_ROUTES = {
 
   // ─── Packages ─────────────────────────────────────────────────────────────
   packages: route("GET", "/__studio/packages", "List dependencies (PackageInfo[])"),
-  packagesAdd: route("POST", "/__studio/packages/add", "Add a dependency"),
-  packagesRemove: route("POST", "/__studio/packages/remove", "Remove a dependency"),
+  packagesAdd: route(
+    "POST",
+    "/__studio/packages/add",
+    "Add a registry dependency, writing package.json and package-lock.json together",
+  ),
+  packagesRemove: route(
+    "POST",
+    "/__studio/packages/remove",
+    "Remove a dependency, writing package.json and package-lock.json together",
+  ),
   packagesInstall: route(
     "POST",
     "/__studio/packages/install",
-    "Run the package manager install",
-    "Install/reinstall affordances are hidden; manifest-only edits still work.",
+    "Install the declared dependencies (npm's installer, writing package-lock.json)",
+    "Install/reinstall affordances are hidden; add, remove and version updates still work where the backend serves them (a cloud session updates the lockfile without installing).",
   ),
   packagesNeedsInstall: route(
     "GET",
@@ -358,7 +366,7 @@ export const STUDIO_ROUTES = {
   packagesSetVersions: route(
     "POST",
     "/__studio/packages/set-versions",
-    "Rewrite dependency ranges and install",
+    "Rewrite dependency ranges and install (lockfile-only where nothing installs)",
     "Bulk version updates are hidden.",
   ),
 
@@ -374,6 +382,14 @@ export const STUDIO_ROUTES = {
   gitFetch: route("POST", "/__studio/git/fetch", "Refresh remote tracking state"),
   gitCheckout: route("POST", "/__studio/git/checkout", "Switch branches"),
   gitCreateBranch: route("POST", "/__studio/git/create-branch", "Create a branch"),
+  gitCommitBranch: route(
+    "POST",
+    "/__studio/git/commit-branch",
+    "Commit the change set as a NEW branch off the session's base, then take it out of this one " +
+      "→ GitCommitBranchResult; 409 branch_exists",
+    "A publish the remote conflicts with reports the conflict alone, and Send for review stays " +
+      "refused on a branch whose every commit is live.",
+  ),
   gitDiff: route("GET", "/__studio/git/diff", "Unified diff of dirty files (or one path)"),
   gitShow: route("GET", "/__studio/git/show", "File content at a ref"),
   gitDiscard: route("POST", "/__studio/git/discard", "Discard working changes"),

package/src/types.ts

@@ -238,6 +238,18 @@ export interface GitLogEntry {
   date: string;
 }
 
+/**
+ * Response of `git/commit-branch` (see StudioPlatform.gitCommitBranch): the branch the change set
+ * now lives on, its commit, and which files left this session (`moved`) or stayed because they were
+ * edited while it was made (`kept`).
+ */
+export interface GitCommitBranchResult {
+  branch: string;
+  sha: string;
+  moved: string[];
+  kept: string[];
+}
+
 /** Response of the pull-request route (see StudioPlatform.createPullRequest). */
 export interface PullRequestInfo {
   url: string;
@@ -328,7 +340,7 @@ export interface ExtensionSectionInfo {
 
 /** One extension a backend can offer a project, whether or not the project enables it. */
 export interface ExtensionCatalogEntry {
-  /** Package name: the identity, and the `bun add` argument. */
+  /** Package name: the identity, and the argument an add passes the installer. */
   name: string;
   /**
    * The string that goes in `project.json` `extensions[]`. Usually `name`, but a linked or
@@ -350,12 +362,6 @@ export interface ExtensionCatalogEntry {
   formats?: string[];
   /** Other catalogue members it depends on — auth needs connector. */
   requires?: string[];
-  /**
-   * THIS host resolves the package without a project install, so enabling it is a config write
-   * alone. Probed per host, never declared: what a desktop build stages and what a Worker bundles
-   * are different facts, and neither is knowable from the package list.
-   */
-  bundled?: boolean;
   /**
    * The PROJECT resolves it.
    *
@@ -590,7 +596,7 @@ export interface PackageVersionInfo {
   dev?: boolean;
 }
 
-/** Result of a package mutation that runs `bun install` (install / set-versions). */
+/** Result of a package mutation that runs an install (install / set-versions). */
 export interface PackageOpResult {
   ok: boolean;
   /** Combined stdout/stderr from the bun invocation, surfaced to the user on failure. */