@hardfin/cli 0.1.1-dev.41 → 0.1.1-dev.42

package/README.md

@@ -109,6 +109,17 @@ stderr, so a pipe still carries only the result.
 | `requestId` | The API's request ID, or null when the request never reached it          |
 | `status`    | The HTTP status, or null for a failure caught before any request is made |
 
+Three codes cover failures that are easy to mistake for something else.
+
+| `code`                | Happens when                                                                                |
+| --------------------- | ------------------------------------------------------------------------------------------- |
+| `unexpected_response` | A 200 whose body is not the API's JSON, such as a proxy's page. It is never an empty result |
+| `timed_out`           | The server did not begin to answer within 60 seconds, or 300 for an upload                  |
+| `file_error`          | This machine refused a path the command was given                                           |
+
+A change that timed out may still have been made, and the message says so. Read the record
+before sending the change again.
+
 An agent branches on `code`. A code is never renamed and never changes meaning, while the
 message may be reworded at any time. `hardfin agent-guide` lists every code with what it
 means, and `src/output/failure.ts` defines them.
@@ -442,6 +453,10 @@ Nothing secret is printed. An API key and a refresh token are each reported as a
 `sha256:` fingerprint, which identifies a credential across two machines without disclosing
 it.
 
+`api.authenticated` is `true` only when the API answered who the credential is. A 401 or a
+403 makes it `false`, and `hardfin status` then exits with code 4. It is `null` when the API
+could not be asked, because no answer says nothing about the credential.
+
 `refreshExpiresAt` is what the server said when it issued the token. A sign in stored before
 the server reported one falls back to Hardfin's 90-day rule, and `refreshExpiryIsEstimated`
 says which of the two you are looking at.

package/dist/cli.js

@@ -1,6 +1,6 @@
 #!/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]="12877cfa-09aa-5239-8a24-ecc77a951641")}catch(e){}}();
+!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]="c2c38fd6-1925-561f-baf9-51faf8c4c4b8")}catch(e){}}();
 import module from "node:module";
 //#region src/cli.ts
 module.enableCompileCache?.();
@@ -14,7 +14,7 @@ process.on("unhandledRejection", (error) => void toCrash(error));
 try {
 	const answer = await toQuickAnswer(process.argv.slice(2));
 	if (answer === void 0) {
-		const { toCli, toParseExitCode, wasReportAttempted } = await import("./program-C1-jZp6K.js");
+		const { toCli, toParseExitCode, wasReportAttempted } = await import("./program-CqO1St9H.js");
 		try {
 			await toCli().parseAsync(process.argv);
 		} catch (error) {
@@ -33,7 +33,7 @@ async function toCrash(error) {
 	isCrashing = true;
 	process.stderr.write(`error: ${error instanceof Error ? error.message : String(error)}\n`);
 	try {
-		const { toReported } = await import("./program-C1-jZp6K.js");
+		const { toReported } = await import("./program-CqO1St9H.js");
 		await toReported(error, false, void 0, "fatal");
 	} finally {
 		process.exit(1);
@@ -51,4 +51,4 @@ async function toQuickAnswer(args) {
 export {};
 
 //# sourceMappingURL=cli.js.map
-//# debugId=12877cfa-09aa-5239-8a24-ecc77a951641
+//# debugId=c2c38fd6-1925-561f-baf9-51faf8c4c4b8

package/dist/{program-C1-jZp6K.js → program-CqO1St9H.js}

@@ -1,6 +1,6 @@
 #!/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]="8cef3750-26c4-5378-89b9-1b3b5b7aaaa7")}catch(e){}}();
+!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]="0a793a7f-2311-5aaf-b27d-0877574e2d18")}catch(e){}}();
 import { a as defineCommand, i as GLOBAL_FLAGS, r as ExitCode, t as toInvocation } from "./scrub-BN3gyBpR.js";
 import { n as toAnswer$1, r as toCompletion, t as PATH_VALUES } from "./completion-tree-DLC6ARLR.js";
 import { createRequire } from "node:module";
@@ -261,30 +261,208 @@ function toOrigin(apiUrl) {
 	}
 }
 //#endregion
-//#region src/auth/jwt.ts
+//#region src/http/reach.ts
+/** Unreachable is a request that never reached a server, so there is no answer to report. */
+var Unreachable = class extends ExpectedFailure {
+	constructor(message) {
+		super(message);
+		this.name = "Unreachable";
+	}
+};
+const OFFLINE = "Couldn't connect to Hardfin. Check your internet connection and try again.";
+const INSECURE = "Couldn't connect to Hardfin securely, so nothing was sent. A work network or security software may be blocking the connection. If this keeps happening, contact your IT team.";
+/** The reasons Node gives, by the code on the error behind fetch's own. */
+const REASONS = {
+	ECONNREFUSED: {
+		message: OFFLINE,
+		detail: "connection refused"
+	},
+	ENOTFOUND: {
+		message: OFFLINE,
+		detail: "address not found"
+	},
+	EAI_AGAIN: {
+		message: OFFLINE,
+		detail: "address lookup failed"
+	},
+	ETIMEDOUT: {
+		message: OFFLINE,
+		detail: "timed out"
+	},
+	UND_ERR_CONNECT_TIMEOUT: {
+		message: OFFLINE,
+		detail: "timed out"
+	},
+	EHOSTUNREACH: {
+		message: OFFLINE,
+		detail: "no route to host"
+	},
+	ENETUNREACH: {
+		message: OFFLINE,
+		detail: "network unreachable"
+	},
+	ECONNRESET: {
+		message: OFFLINE,
+		detail: "connection closed"
+	},
+	UND_ERR_SOCKET: {
+		message: OFFLINE,
+		detail: "connection closed"
+	},
+	DEPTH_ZERO_SELF_SIGNED_CERT: {
+		message: INSECURE,
+		detail: "certificate not trusted"
+	},
+	SELF_SIGNED_CERT_IN_CHAIN: {
+		message: INSECURE,
+		detail: "certificate not trusted"
+	},
+	UNABLE_TO_VERIFY_LEAF_SIGNATURE: {
+		message: INSECURE,
+		detail: "certificate not trusted"
+	},
+	UNABLE_TO_GET_ISSUER_CERT_LOCALLY: {
+		message: INSECURE,
+		detail: "certificate not trusted"
+	},
+	CERT_HAS_EXPIRED: {
+		message: INSECURE,
+		detail: "certificate expired"
+	},
+	ERR_TLS_CERT_ALTNAME_INVALID: {
+		message: INSECURE,
+		detail: "certificate is for another host"
+	},
+	ERR_SSL_WRONG_VERSION_NUMBER: {
+		message: OFFLINE,
+		detail: "not an HTTPS server"
+	},
+	EPROTO: {
+		message: OFFLINE,
+		detail: "not an HTTPS server"
+	}
+};
+/** How long a server may take to begin its answer, before the request is given up on. */
+const ANSWER_TIMEOUT_MS = 6e4;
 /**
-* toClaims reads an access token's payload for display. Nothing here verifies the
-* signature, because the API is what decides whether a token is good.
+* send is fetch, with a failure to connect reported in words anyone can act on. It gives up
+* on a server that has not begun to answer in time, because a caller with no person watching
+* would otherwise wait on a stalled connection for as long as it stayed open.
 */
-function toClaims(token) {
-	const payload = token.split(".")[1];
-	if (!payload) return {};
+async function send(url, init, timeoutMs = ANSWER_TIMEOUT_MS) {
+	const deadline = new AbortController();
+	const timer = setTimeout(() => {
+		deadline.abort();
+	}, timeoutMs);
 	try {
-		const decoded = JSON.parse(Buffer.from(payload, "base64url").toString("utf8"));
-		return {
-			expiresAt: typeof decoded["exp"] === "number" ? decoded["exp"] * 1e3 : void 0,
-			issuedAt: typeof decoded["iat"] === "number" ? decoded["iat"] * 1e3 : void 0,
-			scopes: toScopes(decoded),
-			subject: typeof decoded["sub"] === "string" ? decoded["sub"] : void 0
-		};
-	} catch {
-		return {};
+		return await fetch(url, {
+			...init,
+			signal: init?.signal ? AbortSignal.any([init.signal, deadline.signal]) : deadline.signal
+		});
+	} catch (error) {
+		if (deadline.signal.aborted) throw toTimedOut(url, init?.method ?? "GET", timeoutMs);
+		throw toUnreachable(url, error);
+	} finally {
+		clearTimeout(timer);
 	}
 }
-/** toScopes reads scp, which is where Hardfin puts an access token's scopes. */
-function toScopes(decoded) {
-	if (Array.isArray(decoded["scp"])) return decoded["scp"].map(String);
-	return typeof decoded["scope"] === "string" ? decoded["scope"].split(" ") : void 0;
+/** toTimedOut describes a request given up on, and says when it may have gone through anyway. */
+function toTimedOut(url, method, timeoutMs) {
+	const waited = `${new URL(url).host} did not answer within ${timeoutMs / 1e3} seconds`;
+	return new TimedOut(["GET", "HEAD"].includes(method.toUpperCase()) ? waited : `${waited}. The change may still have been made, so read the record before sending it again`);
+}
+/**
+* toUnreachable describes a request that could not connect. Fetch reports every such failure
+* as "fetch failed", and the reason is on the error it wraps. The person reads a plain
+* message, and the line after it names the reason and host for whoever helps them.
+*/
+function toUnreachable(url, error) {
+	const host = new URL(url).host;
+	const cause = error instanceof Error ? error.cause : void 0;
+	const code = cause instanceof Error ? cause.code : void 0;
+	const reason = (error instanceof Error && error.name === "TimeoutError" ? REASONS["ETIMEDOUT"] : code === void 0 ? void 0 : REASONS[code]) ?? {
+		message: OFFLINE,
+		detail: cause instanceof Error ? cause.message : error instanceof Error ? error.message : String(error)
+	};
+	return new Unreachable(`${reason.message}\nDetails: ${reason.detail} (${host})`);
+}
+//#endregion
+//#region src/auth/grant.ts
+const TokenResponse = z.looseObject({
+	access_token: z.string(),
+	token_type: z.string(),
+	expires_in: z.number().optional(),
+	refresh_token: z.string().optional(),
+	refresh_token_expires_in: z.number().optional(),
+	scope: z.string().optional()
+});
+/** GrantFailure is a token request the authorization server refused. */
+var GrantFailure = class extends ExpectedFailure {
+	code;
+	constructor(code, description) {
+		super(description ? `${code}: ${description}` : code);
+		this.name = "GrantFailure";
+		this.code = code;
+	}
+};
+/** SignInStopped is a sign in the person ended themselves, in a way other than Ctrl-C. */
+var SignInStopped = class extends ExpectedFailure {
+	constructor(message) {
+		super(message);
+		this.name = "SignInStopped";
+	}
+};
+/** toTokensFromCode trades an authorization code for tokens. */
+async function toTokensFromCode(tokenUrl, clientId, code, redirectUri, pkce) {
+	return await toTokens(tokenUrl, {
+		grant_type: "authorization_code",
+		client_id: clientId,
+		code,
+		redirect_uri: redirectUri,
+		code_verifier: pkce.verifier
+	});
+}
+/** toTokensFromRefresh trades a refresh token for a fresh pair. */
+async function toTokensFromRefresh(tokenUrl, clientId, refreshToken) {
+	return await toTokens(tokenUrl, {
+		grant_type: "refresh_token",
+		client_id: clientId,
+		refresh_token: refreshToken
+	});
+}
+/** revoke tells the server to forget a token, so signing out reaches every machine. */
+async function revoke(revocationUrl, clientId, token) {
+	await send(revocationUrl, {
+		method: "POST",
+		headers: { "Content-Type": "application/x-www-form-urlencoded" },
+		body: new URLSearchParams({
+			client_id: clientId,
+			token,
+			token_type_hint: "refresh_token"
+		})
+	});
+}
+/** toTokens asks the token endpoint, which answers a flat RFC 6749 body, not the envelope. */
+async function toTokens(url, form) {
+	const response = await send(url, {
+		method: "POST",
+		headers: {
+			"Content-Type": "application/x-www-form-urlencoded",
+			Accept: "application/json"
+		},
+		body: new URLSearchParams(form)
+	});
+	const body = await response.json().catch(() => void 0);
+	if (!response.ok) throw new GrantFailure(toText(body?.["error"] ?? `http_${response.status}`), body?.["error_description"] === void 0 ? void 0 : toText(body["error_description"]));
+	const parsed = TokenResponse.safeParse(body);
+	if (!parsed.success) throw new GrantFailure("invalid_response", "the token endpoint did not answer with a token");
+	return {
+		accessToken: parsed.data.access_token,
+		refreshToken: parsed.data.refresh_token,
+		refreshExpiresAt: parsed.data.refresh_token_expires_in === void 0 ? void 0 : Date.now() + parsed.data.refresh_token_expires_in * 1e3,
+		scope: parsed.data.scope,
+		expiresAt: parsed.data.expires_in === void 0 ? void 0 : Date.now() + parsed.data.expires_in * 1e3
+	};
 }
 //#endregion
 //#region src/credential/store.ts
@@ -418,111 +596,6 @@ function writeFile(held) {
 	renameSync(pending, path);
 }
 //#endregion
-//#region src/http/reach.ts
-/** Unreachable is a request that never reached a server, so there is no answer to report. */
-var Unreachable = class extends ExpectedFailure {
-	constructor(message) {
-		super(message);
-		this.name = "Unreachable";
-	}
-};
-const OFFLINE = "Couldn't connect to Hardfin. Check your internet connection and try again.";
-const INSECURE = "Couldn't connect to Hardfin securely, so nothing was sent. A work network or security software may be blocking the connection. If this keeps happening, contact your IT team.";
-/** The reasons Node gives, by the code on the error behind fetch's own. */
-const REASONS = {
-	ECONNREFUSED: {
-		message: OFFLINE,
-		detail: "connection refused"
-	},
-	ENOTFOUND: {
-		message: OFFLINE,
-		detail: "address not found"
-	},
-	EAI_AGAIN: {
-		message: OFFLINE,
-		detail: "address lookup failed"
-	},
-	ETIMEDOUT: {
-		message: OFFLINE,
-		detail: "timed out"
-	},
-	UND_ERR_CONNECT_TIMEOUT: {
-		message: OFFLINE,
-		detail: "timed out"
-	},
-	EHOSTUNREACH: {
-		message: OFFLINE,
-		detail: "no route to host"
-	},
-	ENETUNREACH: {
-		message: OFFLINE,
-		detail: "network unreachable"
-	},
-	ECONNRESET: {
-		message: OFFLINE,
-		detail: "connection closed"
-	},
-	UND_ERR_SOCKET: {
-		message: OFFLINE,
-		detail: "connection closed"
-	},
-	DEPTH_ZERO_SELF_SIGNED_CERT: {
-		message: INSECURE,
-		detail: "certificate not trusted"
-	},
-	SELF_SIGNED_CERT_IN_CHAIN: {
-		message: INSECURE,
-		detail: "certificate not trusted"
-	},
-	UNABLE_TO_VERIFY_LEAF_SIGNATURE: {
-		message: INSECURE,
-		detail: "certificate not trusted"
-	},
-	UNABLE_TO_GET_ISSUER_CERT_LOCALLY: {
-		message: INSECURE,
-		detail: "certificate not trusted"
-	},
-	CERT_HAS_EXPIRED: {
-		message: INSECURE,
-		detail: "certificate expired"
-	},
-	ERR_TLS_CERT_ALTNAME_INVALID: {
-		message: INSECURE,
-		detail: "certificate is for another host"
-	},
-	ERR_SSL_WRONG_VERSION_NUMBER: {
-		message: OFFLINE,
-		detail: "not an HTTPS server"
-	},
-	EPROTO: {
-		message: OFFLINE,
-		detail: "not an HTTPS server"
-	}
-};
-/** send is fetch, with a failure to connect reported in words anyone can act on. */
-async function send(url, init) {
-	try {
-		return await fetch(url, init);
-	} catch (error) {
-		throw toUnreachable(url, error);
-	}
-}
-/**
-* toUnreachable describes a request that could not connect. Fetch reports every such failure
-* as "fetch failed", and the reason is on the error it wraps. The person reads a plain
-* message, and the line after it names the reason and host for whoever helps them.
-*/
-function toUnreachable(url, error) {
-	const host = new URL(url).host;
-	const cause = error instanceof Error ? error.cause : void 0;
-	const code = cause instanceof Error ? cause.code : void 0;
-	const reason = (error instanceof Error && error.name === "TimeoutError" ? REASONS["ETIMEDOUT"] : code === void 0 ? void 0 : REASONS[code]) ?? {
-		message: OFFLINE,
-		detail: cause instanceof Error ? cause.message : error instanceof Error ? error.message : String(error)
-	};
-	return new Unreachable(`${reason.message}\nDetails: ${reason.detail} (${host})`);
-}
-//#endregion
 //#region src/auth/metadata.ts
 const METADATA_PATH = "/.well-known/oauth-authorization-server";
 const AuthorizationServerMetadata = z.looseObject({
@@ -591,75 +664,30 @@ function keep(issuer, document) {
 	} catch {}
 }
 //#endregion
-//#region src/auth/grant.ts
-const TokenResponse = z.looseObject({
-	access_token: z.string(),
-	token_type: z.string(),
-	expires_in: z.number().optional(),
-	refresh_token: z.string().optional(),
-	refresh_token_expires_in: z.number().optional(),
-	scope: z.string().optional()
-});
-/** GrantFailure is a token request the authorization server refused. */
-var GrantFailure = class extends ExpectedFailure {
-	code;
-	constructor(code, description) {
-		super(description ? `${code}: ${description}` : code);
-		this.name = "GrantFailure";
-		this.code = code;
+//#region src/auth/jwt.ts
+/**
+* toClaims reads an access token's payload for display. Nothing here verifies the
+* signature, because the API is what decides whether a token is good.
+*/
+function toClaims(token) {
+	const payload = token.split(".")[1];
+	if (!payload) return {};
+	try {
+		const decoded = JSON.parse(Buffer.from(payload, "base64url").toString("utf8"));
+		return {
+			expiresAt: typeof decoded["exp"] === "number" ? decoded["exp"] * 1e3 : void 0,
+			issuedAt: typeof decoded["iat"] === "number" ? decoded["iat"] * 1e3 : void 0,
+			scopes: toScopes(decoded),
+			subject: typeof decoded["sub"] === "string" ? decoded["sub"] : void 0
+		};
+	} catch {
+		return {};
 	}
-};
-/** toTokensFromCode trades an authorization code for tokens. */
-async function toTokensFromCode(tokenUrl, clientId, code, redirectUri, pkce) {
-	return await toTokens(tokenUrl, {
-		grant_type: "authorization_code",
-		client_id: clientId,
-		code,
-		redirect_uri: redirectUri,
-		code_verifier: pkce.verifier
-	});
-}
-/** toTokensFromRefresh trades a refresh token for a fresh pair. */
-async function toTokensFromRefresh(tokenUrl, clientId, refreshToken) {
-	return await toTokens(tokenUrl, {
-		grant_type: "refresh_token",
-		client_id: clientId,
-		refresh_token: refreshToken
-	});
-}
-/** revoke tells the server to forget a token, so signing out reaches every machine. */
-async function revoke(revocationUrl, clientId, token) {
-	await send(revocationUrl, {
-		method: "POST",
-		headers: { "Content-Type": "application/x-www-form-urlencoded" },
-		body: new URLSearchParams({
-			client_id: clientId,
-			token,
-			token_type_hint: "refresh_token"
-		})
-	});
 }
-/** toTokens asks the token endpoint, which answers a flat RFC 6749 body, not the envelope. */
-async function toTokens(url, form) {
-	const response = await send(url, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/x-www-form-urlencoded",
-			Accept: "application/json"
-		},
-		body: new URLSearchParams(form)
-	});
-	const body = await response.json().catch(() => void 0);
-	if (!response.ok) throw new GrantFailure(toText(body?.["error"] ?? `http_${response.status}`), body?.["error_description"] === void 0 ? void 0 : toText(body["error_description"]));
-	const parsed = TokenResponse.safeParse(body);
-	if (!parsed.success) throw new GrantFailure("invalid_response", "the token endpoint did not answer with a token");
-	return {
-		accessToken: parsed.data.access_token,
-		refreshToken: parsed.data.refresh_token,
-		refreshExpiresAt: parsed.data.refresh_token_expires_in === void 0 ? void 0 : Date.now() + parsed.data.refresh_token_expires_in * 1e3,
-		scope: parsed.data.scope,
-		expiresAt: parsed.data.expires_in === void 0 ? void 0 : Date.now() + parsed.data.expires_in * 1e3
-	};
+/** toScopes reads scp, which is where Hardfin puts an access token's scopes. */
+function toScopes(decoded) {
+	if (Array.isArray(decoded["scp"])) return decoded["scp"].map(String);
+	return typeof decoded["scope"] === "string" ? decoded["scope"].split(" ") : void 0;
 }
 //#endregion
 //#region src/credential/lock.ts
@@ -916,6 +944,18 @@ var RequestFailure = class extends ExpectedFailure {
 		this.requestId = requestId;
 	}
 };
+/**
+* UnexpectedAnswer is a successful response that is not the API's envelope. A captive portal
+* or a proxy answers 200 with a page of its own, which must not pass for an empty result.
+*/
+var UnexpectedAnswer = class extends ExpectedFailure {
+	constructor(host, contentType) {
+		super(`${host} answered with ${contentType ?? "something"} that is not the API's JSON, so nothing can be read from it. A proxy, a firewall or a network sign-in page may be answering in its place`);
+		this.name = "UnexpectedAnswer";
+	}
+};
+/** How long an upload may take to be answered, which is longer than any other request. */
+const UPLOAD_TIMEOUT_MS = 3e5;
 /** request calls one /v2 endpoint and returns the envelope it answered with. */
 async function request$1(options) {
 	const url = new URL(`${options.apiUrl}${toLeadingSlash(options.path)}`);
@@ -931,13 +971,14 @@ async function request$1(options) {
 		signal: options.signal,
 		headers,
 		body: options.form ?? (options.body === void 0 ? void 0 : JSON.stringify(options.body))
-	});
+	}, options.form ? UPLOAD_TIMEOUT_MS : void 0);
 	if (options.downloads && response.ok) return { data: {
 		bytes: Buffer.from(await response.arrayBuffer()),
 		contentType: response.headers.get("content-type"),
 		fileName: toFileName(response.headers.get("content-disposition"))
 	} };
-	const envelope = toEnvelope(await response.text());
+	const text = await response.text();
+	const envelope = toEnvelope(text);
 	if (!response.ok && envelope === void 0) throw new RequestFailure(response.status, [{
 		error: toStatusMessage(response.status),
 		statusCode: response.status
@@ -949,6 +990,7 @@ async function request$1(options) {
 			statusCode: response.status
 		}], envelope?.metadata?.requestId);
 	}
+	if (envelope === void 0 && text.trim() !== "") throw new UnexpectedAnswer(url.host, response.headers.get("content-type"));
 	return envelope ?? { data: null };
 }
 /** toFileName reads the name a download was offered under, when the server names one. */
@@ -962,7 +1004,8 @@ function toLeadingSlash(path) {
 function toEnvelope(text) {
 	if (text.trim() === "") return;
 	try {
-		return JSON.parse(text);
+		const parsed = JSON.parse(text);
+		return typeof parsed === "object" && parsed !== null && !Array.isArray(parsed) ? parsed : void 0;
 	} catch {
 		return;
 	}
@@ -973,6 +1016,36 @@ function toStatusMessage(status) {
 	return `the request failed with status ${status}`;
 }
 //#endregion
+//#region src/report/classify.ts
+/**
+* The codes Node gives when the machine refuses something: permissions, a full or read-only
+* disk, a path that is missing or of the wrong kind, and a reader that closed the pipe.
+*/
+const ENVIRONMENT_CODES = /* @__PURE__ */ new Set([
+	"EACCES",
+	"EPERM",
+	"ENOSPC",
+	"EROFS",
+	"ENOENT",
+	"EISDIR",
+	"ENOTDIR",
+	"EEXIST",
+	"EPIPE"
+]);
+/**
+* isReportable answers whether an error is a defect in the CLI. Everything the CLI anticipated
+* extends ExpectedFailure, so a failure nobody has classified yet is reported until someone
+* decides it is expected.
+*/
+function isReportable(error) {
+	return !(error instanceof ExpectedFailure) && !isMachineRefusal(error);
+}
+/** isMachineRefusal answers whether an error is the machine refusing a file or a folder. */
+function isMachineRefusal(error) {
+	const code = error instanceof Error ? error.code : void 0;
+	return typeof code === "string" && ENVIRONMENT_CODES.has(code);
+}
+//#endregion
 //#region src/output/failure.ts
 /** FAILURE_CODES is every code a failure can carry, and none is ever renamed or given a new meaning. */
 const FAILURE_CODES = {
@@ -986,6 +1059,7 @@ const FAILURE_CODES = {
 	not_confirmed: "The change was not confirmed. Pass --yes to confirm it without a terminal",
 	shell_unavailable: "The shell did not say where its startup file is",
 	invalid_config: "A config file or setting cannot be read",
+	file_error: "This machine refused a file or folder the command needed, such as a path that does not exist",
 	not_signed_in: "No usable credential. Run hardfin login, or set HARDFIN_API_KEY",
 	sign_in_failed: "Signing in did not finish",
 	unreachable: "The CLI could not connect to the server",
@@ -1001,6 +1075,7 @@ const FAILURE_CODES = {
 	rate_limited: "Too many requests. Wait, then try again (HTTP 429)",
 	server_error: "The API failed to answer (HTTP 5xx)",
 	api_error: "The API refused the request with another status",
+	unexpected_response: "The answer was not the API's JSON, as when a proxy or a sign-in page answers in its place",
 	internal_error: "A problem in hardfin itself, which has been reported"
 };
 /** toStatusCode names a refusal by the HTTP status the API answered with. */
@@ -1025,6 +1100,9 @@ function toErrorCode(error) {
 	if (error instanceof Unreachable) return "unreachable";
 	if (error instanceof TimedOut) return "timed_out";
 	if (error instanceof LockHeld) return "busy";
+	if (error instanceof UnexpectedAnswer) return "unexpected_response";
+	if (error instanceof GrantFailure || error instanceof DiscoveryFailure || error instanceof SignInStopped) return "sign_in_failed";
+	if (isMachineRefusal(error)) return "file_error";
 	return "internal_error";
 }
 //#endregion
@@ -2496,7 +2574,7 @@ async function runLogin(input) {
 		}
 		return await toSignedIn(input, metadata, await toTokensFromCode(metadata.token_endpoint, clientId, callback.code, listener.redirectUri, pkce));
 	} catch (error) {
-		if (error instanceof DiscoveryFailure || error instanceof GrantFailure) {
+		if (error instanceof DiscoveryFailure || error instanceof GrantFailure || error instanceof SignInStopped) {
 			writeFailure("sign_in_failed", error.message, input.isJSON);
 			return ExitCode.ERROR;
 		}
@@ -2542,7 +2620,7 @@ async function runDeviceLogin(input, metadata, scope) {
 */
 async function toDeviceTokens(approved, typed) {
 	return await Promise.race([approved, typed.then(() => {
-		throw new ExpectedFailure("Sign in stopped. The code goes on the page in your browser, not here. Run hardfin login to try again.");
+		throw new SignInStopped("Sign in stopped. The code goes on the page in your browser, not here. Run hardfin login to try again.");
 	})]);
 }
 /** toSignedIn stores what a sign in issued, whichever flow issued it. */
@@ -3210,6 +3288,8 @@ function toServerReport(metadata) {
 		scopes: metadata.scopes_supported ?? []
 	};
 }
+/** The statuses the API answers when it will not take the credential. */
+const REFUSED_STATUSES = /* @__PURE__ */ new Set([401, 403]);
 /** toApiReport asks the API who this credential is, which is the only authoritative answer. */
 async function toApiReport(resolved, options) {
 	const settings = resolved.settings;
@@ -3222,6 +3302,7 @@ async function toApiReport(resolved, options) {
 		};
 		const claims = credential.kind === "access token" ? toClaims(credential.value.replace(/^Bearer /, "")) : {};
 		let isReachable = true;
+		let isAuthenticated = true;
 		const identity = await request$1({
 			apiUrl: settings.apiUrl,
 			credential,
@@ -3229,12 +3310,13 @@ async function toApiReport(resolved, options) {
 			path: "/token",
 			signal: options.signal
 		}).then((envelope) => envelope.data).catch((error) => {
-			isReachable = !(error instanceof Unreachable);
+			isReachable = !(error instanceof Unreachable || error instanceof TimedOut);
+			isAuthenticated = error instanceof RequestFailure && REFUSED_STATUSES.has(error.status) ? false : null;
 			return { unavailable: error instanceof Error ? error.message : String(error) };
 		});
 		return {
 			reachable: isReachable,
-			authenticated: true,
+			authenticated: isAuthenticated,
 			url: settings.apiUrl,
 			accessTokenExpiresAt: claims.expiresAt === void 0 ? null : new Date(claims.expiresAt).toISOString(),
 			accessTokenScopes: claims.scopes ?? [],
@@ -3300,33 +3382,6 @@ function toLines(report, depth = 0) {
 	return lines;
 }
 //#endregion
-//#region src/report/classify.ts
-/**
-* The codes Node gives when the machine refuses something: permissions, a full or read-only
-* disk, a path that is missing or of the wrong kind, and a reader that closed the pipe.
-*/
-const ENVIRONMENT_CODES = /* @__PURE__ */ new Set([
-	"EACCES",
-	"EPERM",
-	"ENOSPC",
-	"EROFS",
-	"ENOENT",
-	"EISDIR",
-	"ENOTDIR",
-	"EEXIST",
-	"EPIPE"
-]);
-/**
-* isReportable answers whether an error is a defect in the CLI. Everything the CLI anticipated
-* extends ExpectedFailure, so a failure nobody has classified yet is reported until someone
-* decides it is expected.
-*/
-function isReportable(error) {
-	if (error instanceof ExpectedFailure) return false;
-	const code = error instanceof Error ? error.code : void 0;
-	return !(typeof code === "string" && ENVIRONMENT_CODES.has(code));
-}
-//#endregion
 //#region src/report/report.ts
 /** True once a report has been sent or tried, which the entry point reads before it exits. */
 let isAttempted = false;
@@ -6634,5 +6689,5 @@ async function toReported(error, isJSON, resolved, level = "error") {
 //#endregion
 export { toCli, toParseExitCode, toReported, wasReportAttempted };
 
-//# sourceMappingURL=program-C1-jZp6K.js.map
-//# debugId=8cef3750-26c4-5378-89b9-1b3b5b7aaaa7
+//# sourceMappingURL=program-CqO1St9H.js.map
+//# debugId=0a793a7f-2311-5aaf-b27d-0877574e2d18

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hardfin/cli",
-    "version": "0.1.1-dev.41",
+    "version": "0.1.1-dev.42",
     "description": "Command line interface for the Hardfin API",
     "license": "Apache-2.0",
     "author": "Hardfin, Inc.",

package/skills/hardfin-cli/SKILL.md

@@ -124,13 +124,17 @@ The exit code says what kind of failure it was.
 
 The error is JSON on stderr. Branch on its `code`, never on the message.
 
-| `code`                                              | Do this                                                          |
-| --------------------------------------------------- | ---------------------------------------------------------------- |
-| `not_signed_in`, `unauthorized`                     | Sign in again                                                    |
-| `invalid_flag`, `missing_flag`, `invalid_arguments` | Read `--help` for that command                                   |
-| `not_found`                                         | Check you passed a key, not an ID, where the command wants a key |
-| `bad_request`, `invalid_request`, `conflict`        | Read `errors`, which names the field                             |
-| `rate_limited`                                      | Wait a minute, then retry once                                   |
-| `unreachable`, `server_error`                       | Tell the person, and include `requestId` if there is one         |
+| `code`                                              | Do this                                                            |
+| --------------------------------------------------- | ------------------------------------------------------------------ |
+| `not_signed_in`, `unauthorized`                     | Sign in again                                                      |
+| `invalid_flag`, `missing_flag`, `invalid_arguments` | Read `--help` for that command                                     |
+| `not_found`                                         | Check you passed a key, not an ID, where the command wants a key   |
+| `bad_request`, `invalid_request`, `conflict`        | Read `errors`, which names the field                               |
+| `rate_limited`                                      | Wait a minute, then retry once                                     |
+| `unreachable`, `server_error`                       | Tell the person, and include `requestId` if there is one           |
+| `timed_out`                                         | For a change, read the record first, because it may have been made |
+| `unexpected_response`                               | Tell the person a proxy or network page answered, not Hardfin      |
+| `file_error`                                        | Check the path you gave exists and can be read or written          |
+| `sign_in_failed`                                    | Tell the person, and have them run `hardfin login`                 |
 
 `hardfin agent-guide` lists every code.