@hardfin/cli 0.1.1-dev.67 → 0.1.1-dev.69

package/dist/notice-Bq9ifPV6.js

@@ -0,0 +1,134 @@
+#!/usr/bin/env node
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="85e43a08-810a-5f4e-9d70-a869c9a65ee1")}catch(e){}}();
+import { S as toLastFailureCode, c as toOutdatedTo, i as toUpdateCheckRefusal, n as isReminderDue, o as toPackageDirectory, r as toCheck, t as PACKAGE, u as API_VERSION, x as toJSON } from "./check-CDkHR_Qt.js";
+//#region src/update/notice.ts
+/**
+* The failures a newer CLI may not have, because each can mean the API changed under this one:
+* the API refusing the version or the request, or the CLI not knowing a command, flag or field.
+*/
+const SCHEMA_FAILURES = /* @__PURE__ */ new Set([
+	"cli_outdated",
+	"bad_request",
+	"invalid_request",
+	"invalid_input",
+	"invalid_flag",
+	"unknown_command"
+]);
+/** Commands that never print the notice: the server, which owns its streams, the update itself, and Tab completion. */
+const QUIET_COMMANDS = /* @__PURE__ */ new Set([
+	"mcp",
+	"update",
+	"__complete"
+]);
+/** The global flags that take a value, which come before the command's name. */
+const VALUE_FLAGS = /* @__PURE__ */ new Set([
+	"--api-url",
+	"--api-key",
+	"--issuer-url"
+]);
+/** How long a finished command waits for the registry before it gives up on the check. */
+const SETTLE_MS = 1500;
+/** startUpdateCheck begins the daily check, or answers nothing when this run should not ask. */
+function startUpdateCheck(args, env = process.env) {
+	if (toUpdateCheckRefusal(env) !== void 0 || QUIET_COMMANDS.has(toCommandName(args) ?? "")) return;
+	return toPending(false);
+}
+/**
+* writeUpdateNotice says on stderr when a newer CLI is published. It repeats a plain reminder
+* once a day, and says it every time a command fails in a way a newer CLI may fix.
+*/
+async function writeUpdateNotice(pending, args) {
+	if (!pending) return;
+	const failure = toLastFailureCode();
+	const outdatedTo = toOutdatedTo();
+	const reason = outdatedTo !== void 0 ? "api_version_outdated" : failure !== void 0 && SCHEMA_FAILURES.has(failure) ? "failure" : "reminder";
+	let check = await toSettled(pending);
+	if (reason !== "reminder" && (check === void 0 || check.isCached)) check = await toSettled(toPending(true)) ?? check;
+	const isJSON = args.includes("--json") || !process.stdout.isTTY;
+	if (check?.isOutdated && (reason !== "reminder" || isReminderDue(check.latest))) {
+		writeNotice(toUpdateNotice(check, reason), isJSON);
+		return;
+	}
+	if (outdatedTo !== void 0) writeNotice(toApiNotice(outdatedTo), isJSON);
+}
+function toUpdateNotice(check, reason) {
+	const command = toUpdateCommand(check.tag);
+	const because = reason === "api_version_outdated" ? ` The API has changed since version ${API_VERSION}, which this CLI speaks.` : reason === "failure" ? " What this command was refused for may be fixed in it." : "";
+	return {
+		fields: {
+			event: "update_available",
+			version: check.version,
+			latest: check.latest,
+			reason,
+			command
+		},
+		text: `hardfin ${check.latest} is available, and this is ${check.version}.${because} Run ${command} to update.`
+	};
+}
+function toApiNotice(latestVersion) {
+	return {
+		fields: {
+			event: "api_version_outdated",
+			apiVersion: API_VERSION,
+			latestVersion,
+			command: "hardfin update"
+		},
+		text: `The API answered from an earlier version of an endpoint, because this CLI speaks API version ${API_VERSION} and the endpoint changed by ${latestVersion}. Run hardfin update to look for a CLI that speaks it.`
+	};
+}
+function writeNotice(notice, isJSON) {
+	process.stderr.write(isJSON ? `${toJSON(notice.fields, process.stderr)}\n` : `${notice.text}\n`);
+}
+/**
+* toUpdateCommand names how to update. A copy npx runs has no hardfin update to run, because
+* the next npx run would start the cached copy again.
+*/
+function toUpdateCommand(tag) {
+	try {
+		return /[\\/]_npx[\\/]/.test(toPackageDirectory()) ? `npx -y ${PACKAGE}@${tag}` : "hardfin update";
+	} catch {
+		return "hardfin update";
+	}
+}
+function toPending(isFresh) {
+	const controller = new AbortController();
+	return {
+		answer: toCheck({
+			isFresh,
+			signal: controller.signal
+		}).catch(() => void 0),
+		controller
+	};
+}
+/** toSettled waits a short while for a check, and abandons it after that so the process can end. */
+async function toSettled(pending) {
+	let timer;
+	const late = new Promise((resolve) => {
+		timer = setTimeout(() => {
+			pending.controller.abort();
+			resolve(void 0);
+		}, SETTLE_MS);
+	});
+	try {
+		return await Promise.race([pending.answer, late]);
+	} finally {
+		clearTimeout(timer);
+	}
+}
+/** toCommandName finds the command a command line runs, past the global flags before it. */
+function toCommandName(args) {
+	for (let index = 0; index < args.length; index++) {
+		const argument = args[index] ?? "";
+		if (VALUE_FLAGS.has(argument)) {
+			index++;
+			continue;
+		}
+		if (!argument.startsWith("-")) return argument;
+	}
+}
+//#endregion
+export { startUpdateCheck, writeUpdateNotice };
+
+//# sourceMappingURL=notice-Bq9ifPV6.js.map
+//# debugId=85e43a08-810a-5f4e-9d70-a869c9a65ee1