@jxsuite/studio 4.1.0 → 5.1.0

package/src/settings/dependencies-editor.ts

@@ -18,13 +18,23 @@
  *
  * A row shows `—` only where there is genuinely nothing to show: a `workspace:`/`file:`/git spec, a
  * package the registry does not answer for, or a host with no registry lookup at all.
+ *
+ * **The markup left.** The section is the `settings-packages` surface
+ * (`surfaces/settings-packages.json`), mounted by `surfaces/settings-packages.ts`; what is here is
+ * the section itself — what the platform is asked, which of two versions is newer, what each verb
+ * runs and what it says when it fails. `renderDependenciesEditor` is unchanged as a contract: the
+ * registry hands a container to a `render`, and this one mounts a document into it instead of
+ * rendering lit.
+ *
+ * @docs studio/projects/settings
  */
 
-import { html, render as litRender } from "lit-html";
 import { getPlatform } from "../platform";
 import { notify } from "../services/notify";
 import { showProgressModal } from "../ui/progress-modal";
 import { isUpgrade, stripRange } from "../packages/semver";
+import { renderPackagesSurface } from "../surfaces/settings-packages";
+import type { PackageRow, PackagesActions, PackagesView } from "../surfaces/settings-packages";
 import type { PackageInfo } from "../types";
 
 interface Update {
@@ -56,6 +66,11 @@ function upgradeFor(p: PackageInfo): string | null {
   return latest && isUpgrade(p.version, latest) ? latest : null;
 }
 
+/** The package a row's button names, or undefined when the list has moved on since it was drawn. */
+function packageNamed(name: string): PackageInfo | undefined {
+  return (_packages ?? []).find((p) => p.name === name);
+}
+
 async function load() {
   const platform = getPlatform();
   try {
@@ -106,16 +121,18 @@ async function onAdd() {
   });
 }
 
-async function onRemove(p: PackageInfo) {
+async function onRemove(name: string) {
   await withBusy(async () => {
-    await getPlatform().removePackage(p.name);
-    notify.success(`Removed ${p.name}.`);
+    await getPlatform().removePackage(name);
+    notify.success(`Removed ${name}.`);
   });
 }
 
-async function onUpdate(p: PackageInfo, latest: string) {
+async function onUpdate(name: string) {
   const platform = getPlatform();
-  if (!platform.setPackageVersions) {
+  const p = packageNamed(name);
+  const latest = p ? upgradeFor(p) : null;
+  if (!platform.setPackageVersions || !p || !latest) {
     return;
   }
   await withBusy(async () => {
@@ -169,113 +186,68 @@ async function onReinstall() {
   });
 }
 
-function row(p: PackageInfo) {
-  const latest = latestFor(p);
-  const upgrade = upgradeFor(p);
-  return html`
-    <sp-table-row>
-      <sp-table-cell>
-        ${p.name}${
-          p.dev ? html`<span style="color:var(--fg-dim);font-size:10px"> · dev</span>` : ""
-        }
-      </sp-table-cell>
-      <sp-table-cell>${p.version}</sp-table-cell>
-      <sp-table-cell>${latest ?? "—"}</sp-table-cell>
-      <sp-table-cell>
-        ${
-          upgrade
-            ? html`<sp-action-button
-                size="s"
-                quiet
-                ?disabled=${_busy}
-                title="Update to ${upgrade}"
-                @click=${() => onUpdate(p, upgrade)}
-              >
-                <sp-icon-refresh slot="icon"></sp-icon-refresh>
-              </sp-action-button>`
-            : ""
-        }
-        <sp-action-button
-          size="s"
-          quiet
-          ?disabled=${_busy}
-          title="Remove"
-          @click=${() => onRemove(p)}
-        >
-          <sp-icon-delete slot="icon"></sp-icon-delete>
-        </sp-action-button>
-      </sp-table-cell>
-    </sp-table-row>
-  `;
+/**
+ * One dependency as the surface draws it.
+ *
+ * The two version columns are answered separately on purpose. `latest` is what the registry said
+ * and is shown whatever it says, `—` when it said nothing at all; `upgrade` is the far narrower
+ * claim that the row is BEHIND that version, and it is the only one an update button may act on.
+ */
+function row(p: PackageInfo): PackageRow {
+  return {
+    dev: Boolean(p.dev),
+    latest: latestFor(p) ?? "—",
+    name: p.name,
+    upgrade: upgradeFor(p) ?? "",
+    version: p.version,
+  };
 }
 
+/** What the section shows right now. */
+function view(): PackagesView {
+  return {
+    addName: _addName,
+    busy: _busy,
+    loading: _packages === null,
+    rows: (_packages ?? []).map((p) => row(p)),
+  };
+}
+
+/**
+ * What the reader may do. One set for the module, because the section's whole state is the module's
+ * — one project's dependencies, and one `bun` run at a time over them.
+ */
+const ACTIONS: PackagesActions = {
+  add: () => {
+    void onAdd();
+  },
+  edit: (value: string) => {
+    /* The echo. The scope has to be told what the field now holds even though nothing about the
+       section changes, because emptying it after a successful add is otherwise a write of "" over
+       a scope that already said "" — no change, no binding, and the installed package's name left
+       sitting in the field. */
+    _addName = value;
+    render();
+  },
+  reinstall: () => {
+    void onReinstall();
+  },
+  remove: (name: string) => {
+    void onRemove(name);
+  },
+  update: (name: string) => {
+    void onUpdate(name);
+  },
+  updateAll: () => {
+    void onUpdateAll();
+  },
+};
+
 function render() {
   if (!_container) {
     return;
   }
-  const pkgs = _packages ?? [];
-  const hasUpdates = pkgs.some((p) => upgradeFor(p) !== null);
-
-  const tpl = html`
-    <div class="settings-section">
-      <h3 class="settings-section-title">Packages</h3>
-      <p class="settings-field-desc">Manage this project's npm dependencies.</p>
-
-      <div style="display:flex;gap:8px;margin-bottom:12px;align-items:center">
-        <sp-textfield
-          size="s"
-          placeholder="package-name"
-          .value=${_addName}
-          ?disabled=${_busy}
-          @input=${(e: Event) => {
-            _addName = (e.target as HTMLInputElement).value;
-          }}
-        ></sp-textfield>
-        <sp-action-button size="s" ?disabled=${_busy} @click=${onAdd}>
-          <sp-icon-add slot="icon"></sp-icon-add>
-          Add
-        </sp-action-button>
-        <span style="flex:1"></span>
-        ${
-          hasUpdates
-            ? html`<sp-action-button size="s" ?disabled=${_busy} @click=${onUpdateAll}>
-                Update all
-              </sp-action-button>`
-            : ""
-        }
-        <sp-action-button
-          size="s"
-          quiet
-          ?disabled=${_busy}
-          title="Reinstall (bun install)"
-          @click=${onReinstall}
-        >
-          <sp-icon-refresh slot="icon"></sp-icon-refresh>
-          Reinstall
-        </sp-action-button>
-      </div>
-
-      ${
-        _packages === null
-          ? html`<p class="about-muted">Loading…</p>`
-          : pkgs.length === 0
-            ? html`<p class="about-muted">No dependencies.</p>`
-            : html`
-                <sp-table size="s">
-                  <sp-table-head>
-                    <sp-table-head-cell>Package</sp-table-head-cell>
-                    <sp-table-head-cell>Current</sp-table-head-cell>
-                    <sp-table-head-cell>Latest</sp-table-head-cell>
-                    <sp-table-head-cell></sp-table-head-cell>
-                  </sp-table-head>
-                  <sp-table-body> ${pkgs.map((p) => row(p))} </sp-table-body>
-                </sp-table>
-              `
-      }
-    </div>
-  `;
-
-  litRender(tpl, _container);
+  renderPackagesSurface(_container, view(), ACTIONS);
 }
 
 /** @param {HTMLElement} container */

package/src/settings/extension-commands.ts

@@ -0,0 +1,379 @@
+/// <reference lib="dom" />
+/**
+ * The three verbs over `project.json` `extensions[]`, and the operations behind them.
+ *
+ * **They are command records because the array has two writers.** The person flips a switch and the
+ * assistant calls a tool, and `specs/studio-ui-guidelines.md` §12.4 is about exactly that: "the
+ * agent counts as a surface", and a family over one piece of state declares ONE availability rule.
+ * The assistant's `enable_extension` / `disable_extension` ARE these records — the `aiTool`
+ * projection below is what `services/ai-command-tools.ts` lists, and its `execute` is
+ * `registry.run` — so the two gates cannot drift into the shape that table catalogues, where the
+ * loose member is always the one that writes. What the record cannot say for itself is what to tell
+ * the model afterwards, and that is `aiTool.report`, written beside `run`.
+ *
+ * **There is no `list_extensions` read tool, deliberately.** The system prompt already carries the
+ * catalogue, the enabled set and each entry's sections at turn start, so a read tool could only
+ * answer a question the prompt has answered. The one thing it would add — "what changed after I
+ * enabled that" — is served by `enable_extension`'s own report, which costs no prompt budget
+ * because it is a result rather than an advertisement.
+ *
+ * **`enablement` is `ctx.project.open` and nothing else, on all three.** A precondition that
+ * depends on an ARGUMENT cannot live there — `enablement` cannot see one — so "is this a real
+ * extension?", "can this backend run it?" and "is it still enabled?" are refused with a
+ * `RangeError` naming the value, the shape §12.4 prescribes and `pane.derive` already uses. The
+ * first two are answered by the derived enum that `registry.run` coerces `package` against — a
+ * value outside it reads `is not declared — declared: …` — and the sentences inside `run` remain
+ * for the callers that reach it directly (the Extensions section's switch) and for a row that
+ * changed between the schema being read and the verb running.
+ *
+ * **The in-flight latch lives here, not in the section**, because the assistant can run these too:
+ * a latch the renderer owned would let a tool call and a click install concurrently.
+ */
+
+import {
+  argsSchema,
+  derivedEnumProperty,
+  stringArg,
+  stringProperty,
+} from "../commands/command-args";
+import { beginActivity } from "../panels/activity-panel";
+import { buildRows, enabledSpecifiers } from "./extension-rows";
+import { getPlatform } from "../platform";
+import { notify } from "../services/notify";
+import { notifySettingsDocument } from "./section-registry";
+import { updateSiteConfig } from "../site-context";
+import type { AnyCommand, CommandRegistry } from "../commands/registry";
+
+/** The package an extension operation is running for, or null. */
+let _inFlight: string | null = null;
+
+/**
+ * The files the LAST enable wrote: `[]` for a run that found the row already enabled and returned,
+ * `["project.json"]` for one that only enabled, both files for one that installed first.
+ *
+ * A latch beside `_inFlight` rather than a return value, because `run` returns void and the report
+ * is a separate call: `enable_extension`'s ledger entry has to name `package.json` exactly when
+ * this run touched it, and the row's `installed` flag has already flipped by the time the report
+ * reads it. The empty case is the one that matters most — {@link enableExtension} is idempotent by
+ * design (its enum offers enabled rows), and a report that answered "Enabled X" with a
+ * `project.json` entry for a run that wrote nothing would be the phantom write the ledger exists to
+ * keep out. Runs are serialised by `_inFlight`, so one slot is enough.
+ */
+let _lastEnableWrote: readonly string[] = [];
+
+/**
+ * What an extension operation is currently running for, if anything.
+ *
+ * Read by every surface that offers one, so a second install cannot start while the first is
+ * writing `package.json` and `project.json`.
+ *
+ * @returns {string | null}
+ */
+export function extensionOpInFlight(): string | null {
+  return _inFlight;
+}
+
+/**
+ * Names this backend offers — the palette's and the agent's choice list, ENABLED rows included.
+ *
+ * The enum is what `registry.run` coerces `package` against before `run`, so it has to name the
+ * STATES the verb accepts rather than the changes it would make: a list that excluded enabled rows
+ * would refuse "enable what is already on" as an undeclared value, where {@link enableExtension}'s
+ * own early return keeps the verb idempotent. A row this backend cannot run stays out — a choice
+ * list that offered it would be offering a refusal.
+ */
+function enableable(): string[] {
+  return buildRows()
+    .filter((row) => row.unavailable === undefined)
+    .map((row) => row.name);
+}
+
+/**
+ * Install the package if it is missing, then add it to `project.json`.
+ *
+ * **The order is the point.** A `project.json` naming a package that is not installed is a hard
+ * registry failure at the next build, so config-first opens a window in which the whole project is
+ * broken, and on an install failure it never closes. Install-first can only ever leave an unused
+ * dependency, which is inert.
+ *
+ * So a failed install DOES NOT write the config: writing anyway would manufacture the very state
+ * this section exists to remove. A failed config write does not roll the install back either — that
+ * is the same asymmetry as turning an extension off, and an automatic uninstall triggered by an
+ * unrelated failure is a destructive act nobody asked for.
+ *
+ * Nothing here refreshes the extension surfaces: `commitProjectConfig` compares the `extensions`
+ * key and does it already, and it is awaited before `updateSiteConfig` resolves.
+ *
+ * @param {string} specifier
+ * @returns {Promise<void>}
+ */
+export async function enableExtension(specifier: string): Promise<void> {
+  if (_inFlight !== null) {
+    throw new Error(`Another extension operation is running (${_inFlight}).`);
+  }
+  const row = buildRows().find((r) => r.specifier === specifier || r.name === specifier);
+  if (row === undefined) {
+    throw new RangeError(
+      `command "project.enableExtension" argument "package": "${specifier}" is not an extension ` +
+        `this backend offers and is not installed — offered: ${enableable().join(", ") || "none"}`,
+    );
+  }
+  if (row.unavailable !== undefined) {
+    throw new RangeError(
+      `command "project.enableExtension" argument "package": "${specifier}" cannot be enabled on ` +
+        `this backend — ${row.unavailable}`,
+    );
+  }
+  /* Reset BEFORE the idempotent return, so the report of a no-op cannot read the previous run's
+     files — the same package enabled twice in a row would otherwise report its install twice. */
+  _lastEnableWrote = [];
+  if (row.enabled) {
+    return;
+  }
+
+  _inFlight = row.name;
+  let installed = false;
+  notifySettingsDocument();
+  try {
+    if (!row.installed && !row.bundled) {
+      /*
+       * `beginActivity`, not `showProgressModal`. §13.3 reserves blocking for an operation that
+       * cannot proceed while the author edits, and this one can — the only real hazard is a second
+       * concurrent write, which the latch closes for a fraction of the cost of freezing the app.
+       * `ui/progress-modal.ts` also enumerates its four call sites as a closed set, and a fifth
+       * would make a written invariant false.
+       */
+      const activity = beginActivity({
+        source: "Extensions",
+        status: "Running bun…",
+        title: `Install ${row.name}`,
+      });
+      try {
+        await getPlatform().addPackage(row.name);
+        installed = true;
+      } catch (error) {
+        activity.fail(
+          `Could not install ${row.name} — ${error instanceof Error ? error.message : String(error)}`,
+        );
+        throw error;
+      }
+      /*
+       * The activity ends HERE, before the config write, and that boundary is load-bearing:
+       * `ActivityHandle.fail` raises its own Problem and `commitProjectConfig` raises another keyed
+       * `save:project.json`, so an activity spanning both would post two Problems for one failure
+       * with different keys — undeduplicable, and exactly what §13.3 rule 3 forbids. It is also
+       * honest: the install did succeed.
+       */
+      activity.done();
+    }
+    await updateSiteConfig({ extensions: [...enabledSpecifiers(), row.specifier] });
+    /* Set after the write resolved, so the latch never claims a file the write did not reach. */
+    _lastEnableWrote = installed ? ["project.json", "package.json"] : ["project.json"];
+  } finally {
+    _inFlight = null;
+    notifySettingsDocument();
+  }
+}
+
+/**
+ * Remove an extension from `project.json`, leaving its package installed.
+ *
+ * Turning something off is always safe, so this refuses nothing but a no-op — including on a
+ * backend that reports the extension as unrunnable, which is the case where being able to remove it
+ * matters most. Through `registry.run` the no-op IS a refusal: `package` is coerced against
+ * `enabledSpecifiers()` before this is entered, so a name `project.json` does not hold reads `is
+ * not declared — declared: …`, which is what the palette already said by never offering it.
+ *
+ * @param {string} specifier
+ * @returns {Promise<void>}
+ */
+export async function disableExtension(specifier: string): Promise<void> {
+  if (_inFlight !== null) {
+    throw new Error(`Another extension operation is running (${_inFlight}).`);
+  }
+  const current = enabledSpecifiers();
+  if (!current.includes(specifier)) {
+    return;
+  }
+  _inFlight = specifier;
+  notifySettingsDocument();
+  try {
+    await updateSiteConfig({ extensions: current.filter((entry) => entry !== specifier) });
+  } finally {
+    _inFlight = null;
+    notifySettingsDocument();
+  }
+}
+
+/**
+ * Uninstall an extension's package.
+ *
+ * Refuses while `project.json` still names it, because removing the package under a live
+ * `extensions` entry produces precisely the enabled-but-missing state that fails the next build.
+ * §12.4's rule: the strict member's refusal is evidence the write is unsafe, so the loose member
+ * must not do it anyway.
+ *
+ * @param {string} name
+ * @returns {Promise<void>}
+ */
+export async function removeExtensionPackage(name: string): Promise<void> {
+  if (enabledSpecifiers().includes(name)) {
+    throw new RangeError(
+      `command "packages.remove" argument "package": "${name}" is still enabled in project.json ` +
+        `"extensions" — disable it first, or the next build will fail on a missing package.`,
+    );
+  }
+  if (_inFlight !== null) {
+    throw new Error(`Another extension operation is running (${_inFlight}).`);
+  }
+  _inFlight = name;
+  notifySettingsDocument();
+  try {
+    await getPlatform().removePackage(name);
+    // A toast, unlike enable/disable: this one leaves no Activity entry behind, and it is
+    // Destructive and not undoable, so silence would be the wrong report.
+    notify.success(`Removed ${name}.`);
+  } finally {
+    _inFlight = null;
+    notifySettingsDocument();
+  }
+}
+
+/** The `project.json` sections an extension owns, for the report. */
+function sectionsOf(name: string): string[] {
+  return buildRows().find((row) => row.name === name || row.specifier === name)?.sections ?? [];
+}
+
+/** The specifiers the project enables right now, for the report. */
+function enabledNow(): string {
+  return (
+    buildRows()
+      .filter((row) => row.enabled)
+      .map((row) => row.specifier)
+      .join(", ") || "none"
+  );
+}
+
+/** The three records, for `appCommandSet()` and the bootstrap registry. */
+export function extensionCommands(): AnyCommand[] {
+  return [
+    {
+      args: argsSchema({
+        package: derivedEnumProperty(
+          enableable,
+          'The extension package to turn on, e.g. "@jxsuite/parser". A package that is not ' +
+            "installed is installed first.",
+        ),
+      }),
+      category: "Project",
+      group: "7_settings_extensions",
+      id: "project.enableExtension",
+      level: "project",
+      menus: ["palette"],
+      requires: "an open project",
+      enablement: (ctx) => ctx.project.open,
+      /*
+       * `none`, not `project`. The `project.json` half IS a transaction and ⌘Z takes it back, but
+       * the install is not — a record claiming `project` would promise an undo that leaves the
+       * package on disk.
+       */
+      undo: "none",
+      aiTool: {
+        /* "Installing is not undoable" used to be this sentence's last clause; the bridge appends
+           `Not undoable.` from `undo` for every record, so saying it here would say it twice. */
+        description:
+          "Turn on a Jx extension for this project: install its npm package if it is missing and " +
+          'add it to project.json "extensions". Enable an extension BEFORE writing the ' +
+          "project.json section it owns, because a section belonging to a disabled extension is a " +
+          "schema error.",
+        name: "enable_extension",
+        /* The result carries what a read tool would otherwise have to be advertised to answer: the
+           sections that became legal and the enabled set. `wrote` is explicit because `undo` is
+           `none` — the ledger cannot infer a disk path — and is the latch's own list: `package.json`
+           only for the run that installed, and EMPTY for the run that found the row already on,
+           which is then a statement rather than a change and files nothing. */
+        report: ({ args }) => {
+          const name = stringArg("project.enableExtension", args, "package");
+          const sections = sectionsOf(name);
+          const owned =
+            sections.length > 0
+              ? ` Its project.json sections are ${_lastEnableWrote.length > 0 ? "now " : ""}valid: ${sections.join(", ")}.`
+              : "";
+          const verb =
+            _lastEnableWrote.length > 0 ? `Enabled ${name}.` : `${name} was already enabled.`;
+          return {
+            summary: `${verb}${owned} Enabled extensions: ${enabledNow()}.`,
+            wrote: _lastEnableWrote,
+          };
+        },
+      },
+      run: async (_ctx, args) =>
+        enableExtension(stringArg("project.enableExtension", args, "package")),
+      title: "Enable Extension",
+    },
+    {
+      args: argsSchema({
+        package: derivedEnumProperty(
+          enabledSpecifiers,
+          "The extension to turn off. Its npm package stays installed.",
+        ),
+      }),
+      category: "Project",
+      group: "7_settings_extensions",
+      id: "project.disableExtension",
+      level: "project",
+      menus: ["palette"],
+      requires: "an open project",
+      enablement: (ctx) => ctx.project.open,
+      undo: "project",
+      aiTool: {
+        description:
+          'Remove an extension from project.json "extensions". Its npm package stays installed, ' +
+          "and the settings sections it contributed disappear. Remove any project.json sections " +
+          "it owns first, or the configuration will not validate.",
+        name: "disable_extension",
+        /* "Ask before uninstalling" is the sentence that keeps `packages.remove` — deliberately not
+           projected — from being reached for by inference. `wrote` defaults from `undo: "project"`
+           to `project.json`, which is the one file this touches. */
+        report: ({ args }) =>
+          `Disabled ${stringArg("project.disableExtension", args, "package")}; its npm package ` +
+          `is still installed. Ask before uninstalling it. Enabled extensions: ${enabledNow()}.`,
+      },
+      run: async (_ctx, args) =>
+        disableExtension(stringArg("project.disableExtension", args, "package")),
+      title: "Disable Extension",
+    },
+    {
+      args: argsSchema({
+        package: stringProperty("The npm package to uninstall from this project."),
+      }),
+      category: "Project",
+      destructive: true,
+      group: "9_danger",
+      id: "packages.remove",
+      level: "project",
+      menus: ["palette"],
+      requires: "an open project",
+      enablement: (ctx) => ctx.project.open,
+      undo: "none",
+      /*
+       * Deliberately no `aiTool`. §12.4 binds an agent tool that WRITES what a command writes to
+       * the command's rule; it does not require every command to have one. The model has no read
+       * that tells it whether a dependency is load-bearing elsewhere in the project, so it cannot
+       * form the judgement this verb needs, and the act is destructive and not undoable.
+       */
+      run: async (_ctx, args) =>
+        removeExtensionPackage(stringArg("packages.remove", args, "package")),
+      title: "Remove Package",
+    },
+  ];
+}
+
+/**
+ * Register the three records.
+ *
+ * @param {CommandRegistry} registry
+ */
+export function registerExtensionCommands(registry: CommandRegistry): void {
+  registry.registerAll(extensionCommands());
+}