@devframes/hub-ui-onboard 1.3.1 → 1.3.3

package/dist/client/embedded.js

@@ -1,4 +1,4 @@
-//#region src/client/.generated/css.ts
+// src/client/.generated/css.ts
 var e = import.meta.url, t = new URL("./", e), n = 1e3, r = "devframes-onboard-hidden", i = (e, n) => fetch(new URL(`__onboard/${e}`, t), n);
 async function a() {
 	return (await i("status")).json();
@@ -112,21 +112,13 @@ function p(e) {
 	}
 	async function W() {
 		let e = await a();
-		if (e.state === "ready") {
-			t.remove(), await o();
-			return;
-		}
-		U(e), e.state === "installing" && setTimeout(() => void W(), n);
+		e.state === "ready" ? (t.remove(), await o()) : (U(e), e.state === "installing" && setTimeout(() => void W(), n));
 	}
 	async function G() {
-		if (P.disabled = !0, I.textContent = h.confirming, !(await i("install", { method: "POST" })).ok) {
-			await W(), N.hidden = !1, N.textContent = h.refused;
-			return;
-		}
-		U({
+		P.disabled = !0, I.textContent = h.confirming, (await i("install", { method: "POST" })).ok ? (U({
 			...e,
 			state: "installing"
-		}), await W();
+		}), await W()) : (await W(), N.hidden = !1, N.textContent = h.refused);
 	}
 	async function K() {
 		(await i("disable", { method: "POST" })).ok && t.remove();
@@ -136,13 +128,6 @@ function p(e) {
 async function m() {
 	if (window.parent !== window || sessionStorage.getItem(r)) return;
 	let e = await a();
-	if (e.state !== "disabled" && e.state !== "installed") {
-		if (e.state === "ready") {
-			await o();
-			return;
-		}
-		p(e);
-	}
+	e.state !== "disabled" && e.state !== "installed" && (e.state === "ready" ? await o() : p(e));
 }
 m();
-//#endregion

package/dist/index.d.mts

@@ -1,4 +1,3 @@
-//#region src/types.d.ts
 /** A logo URL, or one per color scheme. Same shape as hub-ui's `BrandingLogo`. */
 type OnboardingLogo = string | {
   light: string;
@@ -54,6 +53,12 @@ interface CreateOnboardingOptions {
   stateDir?: string;
   /** Install as a devDependency. Default: `true`. */
   dev?: boolean;
+  /**
+   * Stop the install when it runs longer than this many milliseconds, and
+   * show an error that asks the user to run the command in a terminal.
+   * Default: `300_000` (5 minutes).
+   */
+  installTimeout?: number;
   branding?: OnboardingBranding;
   messages?: Partial<OnboardingMessages>;
   /**
@@ -102,8 +107,6 @@ interface Onboarding {
   /** `<base>embedded.js`: the `<script type="module">` URL to inject. */
   scriptSrc: string;
 }
-//#endregion
-//#region src/index.d.ts
 export declare function defaultMessages(productName: string): OnboardingMessages;
 /**
  * Create the stand-in for a hub UI that is not installed yet: a request
@@ -111,5 +114,4 @@ export declare function defaultMessages(productName: string): OnboardingMessages
  * `__onboard/*` routes it talks to.
  */
 export declare function createOnboarding(options: CreateOnboardingOptions): Onboarding;
-//#endregion
 export type { CreateOnboardingOptions, Onboarding, OnboardingBranding, OnboardingConfirmation, OnboardingHandler, OnboardingLogo, OnboardingMessages, OnboardingState, OnboardingStatus };

package/dist/index.mjs

@@ -9,7 +9,7 @@ import { fileURLToPath } from "node:url";
 import { Diagnostic, createConsoleReporter, defineDiagnostics } from "nostics";
 import { detect, resolveCommand } from "package-manager-detector";
 import { exec } from "tinyexec";
-//#region src/diagnostics.ts
+// src/diagnostics.ts
 /**
 * `DF90xx` is this package's range (see `.agents/08-diagnostics.md`). It
 * uses `nostics` directly: the package must stay free of `devframe` so a
@@ -54,11 +54,14 @@ const diagnostics = defineDiagnostics({
 		DF9008: {
 			why: (p) => `Nobody allowed \`${p.command}\` within ${p.minutes} minutes. The install was refused.`,
 			fix: "Click Install again and answer in the terminal that runs the dev server. If the answer does not arrive, another program reads that terminal: pass an `onConfirm` function to `createOnboarding()`."
+		},
+		DF9009: {
+			why: (p) => `\`${p.command}\` did not finish within ${p.seconds} seconds, so it was stopped.`,
+			fix: "Run the command in a terminal to see where the package manager stops, then click Install again. If the install is only slow, raise `installTimeout`."
 		}
 	}
 });
-//#endregion
-//#region src/install.ts
+// src/install.ts
 /** The `add` command for the project's package manager, `npm` when none is detected. */
 async function resolveInstallCommand(plan) {
 	const agent = (await detect({ cwd: plan.cwd }))?.agent ?? "npm";
@@ -67,18 +70,35 @@ async function resolveInstallCommand(plan) {
 }
 /**
 * Run the install and make sure that each named package landed in
-* `<cwd>/node_modules`. Throws a `DF9001` / `DF9002` diagnostic on failure.
+* `<cwd>/node_modules`. Throws a `DF9001` / `DF9002` / `DF9009` diagnostic on failure.
 */
 async function runInstall(plan, command) {
-	const result = await exec(command.command, command.args, { nodeOptions: {
+	const commandLine = [command.command, ...command.args].join(" ");
+	const child = exec(command.command, command.args, { nodeOptions: {
 		cwd: plan.cwd,
 		env: {
 			...process.env,
 			CI: "1"
 		}
 	} });
+	let timer;
+	let killed;
+	const timedOut = new Promise((resolve) => {
+		timer = setTimeout(() => {
+			killed = killTree(child);
+			killed.then(() => resolve(void 0));
+		}, plan.timeout);
+	});
+	const result = await Promise.race([child, timedOut]).finally(() => clearTimeout(timer));
+	if (killed || !result) {
+		await killed;
+		throw diagnostics.DF9009({
+			command: commandLine,
+			seconds: Math.round(plan.timeout / 1e3)
+		});
+	}
 	if (result.exitCode !== 0) throw diagnostics.DF9001({
-		command: [command.command, ...command.args].join(" "),
+		command: commandLine,
 		exitCode: result.exitCode,
 		stderr: result.stderr.trim().slice(-2048)
 	});
@@ -88,6 +108,23 @@ async function runInstall(plan, command) {
 	});
 }
 /**
+* Kill the install with everything it started. On Windows, tinyexec runs a
+* package manager's `.cmd` shim through `cmd.exe`, and a kill does not reach
+* child processes, so `taskkill /T /F` ends the whole tree.
+*/
+async function killTree(child) {
+	const pid = child.process?.pid;
+	if (process.platform === "win32" && pid !== void 0) {
+		if ((await exec("taskkill", [
+			"/pid",
+			String(pid),
+			"/T",
+			"/F"
+		]).then((r) => r, () => void 0))?.exitCode === 0) return;
+	}
+	child.kill();
+}
+/**
 * `true` when every named package is already in `<cwd>/node_modules`, so the
 * onboarding has nothing to install. Path, URL and alias specs cannot be
 * checked by name, so a plan made only of those is never "already installed".
@@ -109,8 +146,7 @@ function namedPackages(plan) {
 function packageName(spec) {
 	return /^((?:@[\w.~-]+\/)?[\w.~-]+)(?:@[^/]*)?$/.exec(spec)?.[1];
 }
-//#endregion
-//#region src/terminal-confirm.ts
+// src/terminal-confirm.ts
 const ANSWER_MINUTES = 5;
 /**
 * The default `onConfirm`: a `y/N` question in the terminal that runs the dev
@@ -149,9 +185,9 @@ function confirmInTerminal(command, input = process.stdin) {
 		input.on("data", onData);
 	});
 }
-//#endregion
-//#region src/index.ts
+// src/index.ts
 const STATE_FILE = "hub-ui-onboard.json";
+const DEFAULT_INSTALL_TIMEOUT = 3e5;
 /** `devframes` → `/devframes/`, same rule as `normalizeHubBase` in `@devframes/hub`. */
 function normalizeBase(base) {
 	return `/${base}/`.replace(/\/{2,}/g, "/");
@@ -245,7 +281,8 @@ function createOnboarding(options) {
 	const plan = {
 		cwd,
 		packages: options.packages,
-		dev: options.dev ?? true
+		dev: options.dev ?? true,
+		timeout: options.installTimeout ?? DEFAULT_INSTALL_TIMEOUT
 	};
 	const branding = options.branding ?? {};
 	const messages = {
@@ -375,5 +412,4 @@ function createOnboarding(options) {
 		scriptSrc: `${base}embedded.js`
 	};
 }
-//#endregion
 export { createOnboarding, defaultMessages };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devframes/hub-ui-onboard",
   "type": "module",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "A tiny stand-in for the devframe hub UI: a floating button that installs it on demand.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -33,12 +33,12 @@
     "tinyexec": "^1.3.1"
   },
   "devDependencies": {
-    "@types/node": "^26.6.5",
-    "tsdown": "0.23.0",
+    "@types/node": "^26.6.6",
+    "tsdown": "^0.23.7",
     "tsx": "^4.23.15",
-    "unocss": "^66.11.0",
-    "vite": "^8.3.4",
-    "vitest": "^5.0.5"
+    "unocss": "^66.12.0",
+    "vite": "^8.3.6",
+    "vitest": "^5.1.0"
   },
   "scripts": {
     "build": "pnpm run build:css && tsdown && vite build --config vite.client.config.ts",