@jxsuite/studio 6.1.2 → 8.0.1

package/src/platforms/devserver.ts

@@ -195,6 +195,23 @@ export function createDevServerPlatform() {
     return `${_projectRoot}/${r}`;
   }
 
+  /**
+   * A `/__studio/git/*` route that names this session's project with `?dir=`.
+   *
+   * The server serves every Studio tab pointed at it, and its active project is whichever one was
+   * activated last; a git call that named no project ran in that one, so Initialize Repository in
+   * one session initialised another's project. With no project open, nothing is named and the
+   * server falls back to its own root (a clone from the welcome screen).
+   */
+  function gitRoute(command: string, params: Record<string, string> = {}): string {
+    const query = new URLSearchParams(params);
+    if (_projectRoot) {
+      query.set("dir", serverPath("."));
+    }
+    const search = query.toString();
+    return `/__studio/git/${command}${search ? `?${search}` : ""}`;
+  }
+
   /**
    * Strip the project root prefix from a server-root-relative path.
    *
@@ -427,13 +444,25 @@ export function createDevServerPlatform() {
       return entries;
     },
 
-    /** @param {string} path */
+    /**
+     * Read a file as text. A missing file still rejects, as the PAL says; it is only asked for with
+     * `optional=1` (`specs/server.md` §4.1), so the absence arrives as a `null` body rather than a 404.
+     * Studio probes for files it expects may be missing (a `.gitignore` per listed directory), and
+     * a failed request per probe was console noise that read as a fault.
+     *
+     * @param {string} path
+     */
     async readFile(path: string) {
-      const res = await fetch(`/__studio/file?path=${encodeURIComponent(serverPath(path))}`);
+      const res = await fetch(
+        `/__studio/file?path=${encodeURIComponent(serverPath(path))}&optional=1`,
+      );
       if (!res.ok) {
         throw new Error(`Failed to read file: ${path}`);
       }
-      const data = await readJson<{ content: string }>(res);
+      const data = await readJson<{ content: string | null }>(res);
+      if (data.content === null) {
+        throw new Error(`Failed to read file: ${path} (not found)`);
+      }
       return data.content;
     },
 
@@ -1055,7 +1084,7 @@ export function createDevServerPlatform() {
     // ─── Git operations ──────────────────────────────────────────────────
 
     async gitStatus() {
-      const res = await fetch("/__studio/git/status");
+      const res = await fetch(gitRoute("status"));
       if (!res.ok) {
         throw new Error(await res.text());
       }
@@ -1063,7 +1092,7 @@ export function createDevServerPlatform() {
     },
 
     async gitBranches() {
-      const res = await fetch("/__studio/git/branches");
+      const res = await fetch(gitRoute("branches"));
       if (!res.ok) {
         throw new Error(await res.text());
       }
@@ -1072,8 +1101,7 @@ export function createDevServerPlatform() {
 
     /** @param {number} [limit] */
     async gitLog(limit?: number) {
-      const q = limit ? `?limit=${limit}` : "";
-      const res = await fetch(`/__studio/git/log${q}`);
+      const res = await fetch(gitRoute("log", limit ? { limit: String(limit) } : {}));
       if (!res.ok) {
         throw new Error(await res.text());
       }
@@ -1082,7 +1110,7 @@ export function createDevServerPlatform() {
 
     /** @param {string[]} files */
     async gitStage(files: string[]) {
-      const res = await fetch("/__studio/git/stage", {
+      const res = await fetch(gitRoute("stage"), {
         body: JSON.stringify({ files }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1096,7 +1124,7 @@ export function createDevServerPlatform() {
 
     /** @param {string[]} files */
     async gitUnstage(files: string[]) {
-      const res = await fetch("/__studio/git/unstage", {
+      const res = await fetch(gitRoute("unstage"), {
         body: JSON.stringify({ files }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1110,7 +1138,7 @@ export function createDevServerPlatform() {
 
     /** @param {string} message */
     async gitCommit(message: string) {
-      const res = await fetch("/__studio/git/commit", {
+      const res = await fetch(gitRoute("commit"), {
         body: JSON.stringify({ message }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1124,7 +1152,7 @@ export function createDevServerPlatform() {
 
     /** @param {{ setUpstream?: boolean }} [opts] */
     async gitPush(opts?: { setUpstream?: boolean }) {
-      const res = await fetch("/__studio/git/push", {
+      const res = await fetch(gitRoute("push"), {
         body: JSON.stringify(opts || {}),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1137,7 +1165,7 @@ export function createDevServerPlatform() {
     },
 
     async gitPull() {
-      const res = await fetch("/__studio/git/pull", { method: "POST" });
+      const res = await fetch(gitRoute("pull"), { method: "POST" });
       if (!res.ok) {
         const body = await readJson<ErrorBody>(res);
         throw new Error(problemMessage(body));
@@ -1146,7 +1174,7 @@ export function createDevServerPlatform() {
     },
 
     async gitFetch() {
-      const res = await fetch("/__studio/git/fetch", { method: "POST" });
+      const res = await fetch(gitRoute("fetch"), { method: "POST" });
       if (!res.ok) {
         const body = await readJson<ErrorBody>(res);
         throw new Error(problemMessage(body));
@@ -1156,7 +1184,7 @@ export function createDevServerPlatform() {
 
     /** @param {string} branch */
     async gitCheckout(branch: string) {
-      const res = await fetch("/__studio/git/checkout", {
+      const res = await fetch(gitRoute("checkout"), {
         body: JSON.stringify({ branch }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1170,7 +1198,7 @@ export function createDevServerPlatform() {
 
     /** @param {string} name */
     async gitCreateBranch(name: string) {
-      const res = await fetch("/__studio/git/create-branch", {
+      const res = await fetch(gitRoute("create-branch"), {
         body: JSON.stringify({ name }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1184,7 +1212,7 @@ export function createDevServerPlatform() {
 
     /** @param {string} [path] */
     async gitDiff(path?: string) {
-      const res = await fetch(`/__studio/git/diff?path=${encodeURIComponent(path ?? "")}`);
+      const res = await fetch(gitRoute("diff", { path: path ?? "" }));
       if (!res.ok) {
         throw new Error(await res.text());
       }
@@ -1193,11 +1221,9 @@ export function createDevServerPlatform() {
 
     /** @param {{ path: string; ref?: string }} opts */
     async gitShow(opts: { path: string; ref?: string }) {
-      const params = new URLSearchParams({ path: opts.path });
-      if (opts.ref) {
-        params.set("ref", opts.ref);
-      }
-      const res = await fetch(`/__studio/git/show?${params}`);
+      const res = await fetch(
+        gitRoute("show", opts.ref ? { path: opts.path, ref: opts.ref } : { path: opts.path }),
+      );
       if (!res.ok) {
         throw new Error(await res.text());
       }
@@ -1207,7 +1233,7 @@ export function createDevServerPlatform() {
 
     /** @param {string[]} files */
     async gitDiscard(files: string[]) {
-      const res = await fetch("/__studio/git/discard", {
+      const res = await fetch(gitRoute("discard"), {
         body: JSON.stringify({ files }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1221,7 +1247,7 @@ export function createDevServerPlatform() {
 
     /** @param {string} url */
     async gitClone(url: string) {
-      const res = await fetch("/__studio/git/clone", {
+      const res = await fetch(gitRoute("clone"), {
         body: JSON.stringify({ url }),
         headers: { "Content-Type": "application/json" },
         method: "POST",
@@ -1234,7 +1260,7 @@ export function createDevServerPlatform() {
     },
 
     async gitInit() {
-      const res = await fetch("/__studio/git/init", { method: "POST" });
+      const res = await fetch(gitRoute("init"), { method: "POST" });
       if (!res.ok) {
         const body = await readJson<ErrorBody>(res);
         throw new Error(problemMessage(body));
@@ -1289,7 +1315,7 @@ export function createDevServerPlatform() {
      * @param {string} url
      */
     async gitAddRemote(name: string, url: string) {
-      const res = await fetch("/__studio/git/add-remote", {
+      const res = await fetch(gitRoute("add-remote"), {
         body: JSON.stringify({ name, url }),
         headers: { "Content-Type": "application/json" },
         method: "POST",

package/src/publish/deploy-checklist.ts

@@ -319,17 +319,22 @@ export function deployStatusItem(): DeployStatusItem | null {
 
 // ─── The surface ──────────────────────────────────────────────────────────────
 
-/** Which glyph a link's state wears. One character, so it fits the row it labels. */
-const STEP_ICON: Readonly<Record<DeployStepState, string>> = {
-  done: "✓",
-  todo: "·",
-  unknown: "?",
+/**
+ * The kit icon a link's state wears, and the state in words for a reader who cannot see it. Names
+ * from the kit's glyph manifest rather than text glyphs: a `·` or a `?` beside a sentence read as
+ * punctuation and said nothing to a screen reader.
+ */
+const STEP_ICON: Readonly<Record<DeployStepState, { icon: string; label: string }>> = {
+  done: { icon: "check", label: "Done" },
+  todo: { icon: "warning-circle", label: "To do" },
+  unknown: { icon: "question", label: "Not checked yet" },
 };
 
-/** One prerequisite, flattened for the document: a key, a state, a glyph and a sentence. */
+/** One prerequisite, flattened for the document: a key, a state, an icon and a sentence. */
 function stepView(step: DeployStep): DeployStepRowView {
   return {
-    icon: STEP_ICON[step.state],
+    icon: STEP_ICON[step.state].icon,
+    iconLabel: STEP_ICON[step.state].label,
     id: step.id,
     state: step.state,
     /* The detail is dropped once the link is forged: what a done step buys you is not news, and

package/src/publish/pages-service.ts

@@ -29,6 +29,12 @@ export interface PagesDeploymentInfo {
   stage: string;
   status: string;
   createdOn: string;
+  /**
+   * The branch the deployment was built from, when Cloudflare says (its trigger metadata). A
+   * preview's branch is what names it in Publish › Deploys; a production deployment usually carries
+   * the production branch.
+   */
+  branch?: string;
 }
 
 export interface ConnectOptions {
@@ -146,25 +152,43 @@ interface DeploymentWire {
   environment: string;
   latest_stage?: { name?: string; status?: string };
   created_on: string;
+  deployment_trigger?: { metadata?: { branch?: string } };
 }
 
-/** The most recent deployment of the connected project, or null when none. */
-export async function latestDeployment(deploy: DeployConfig): Promise<PagesDeploymentInfo | null> {
+/** One wire row as the app reads it: the stage flattened, the branch kept only when it is said. */
+function deploymentInfo(row: DeploymentWire): PagesDeploymentInfo {
+  const info: PagesDeploymentInfo = {
+    id: row.id,
+    url: row.url,
+    environment: row.environment,
+    stage: row.latest_stage?.name ?? "unknown",
+    status: row.latest_stage?.status ?? "unknown",
+    createdOn: row.created_on,
+  };
+  const branch = row.deployment_trigger?.metadata?.branch;
+  if (branch) {
+    info.branch = branch;
+  }
+  return info;
+}
+
+/**
+ * Every deployment of the connected project Cloudflare returns, newest first, as it orders them.
+ *
+ * All of them, not the latest alone: Publish › Deploys draws the history and the branch previews
+ * from this one list (studio.md §22.8), and the latest is simply its first row.
+ */
+export async function listDeployments(deploy: DeployConfig): Promise<PagesDeploymentInfo[]> {
   const deployments = await cfApi<DeploymentWire[]>(
     `/accounts/${deploy.accountId}/pages/projects/${deploy.projectName}/deployments`,
   );
-  const [latest] = deployments;
-  if (!latest) {
-    return null;
-  }
-  return {
-    id: latest.id,
-    url: latest.url,
-    environment: latest.environment,
-    stage: latest.latest_stage?.name ?? "unknown",
-    status: latest.latest_stage?.status ?? "unknown",
-    createdOn: latest.created_on,
-  };
+  return deployments.map((row) => deploymentInfo(row));
+}
+
+/** The most recent deployment of the connected project, or null when none. */
+export async function latestDeployment(deploy: DeployConfig): Promise<PagesDeploymentInfo | null> {
+  const [latest] = await listDeployments(deploy);
+  return latest ?? null;
 }
 
 /**