@hardfin/cli 0.1.0-dev.32 → 0.1.0-dev.33

package/README.md

@@ -208,6 +208,21 @@ On WSL the browser is opened through Windows, by `wslview`, then PowerShell, the
 The port changes every time, so Hardfin matches a loopback redirect by everything except its
 port, which is what RFC 8252 asks of an authorization server.
 
+### When an agent signs you in
+
+An agent that runs `hardfin login` reads its stderr, and you only see what the agent passes
+on. So when output is JSON, which it is whenever stdout is not a terminal, the command writes
+one line of JSON on stderr before it starts waiting.
+
+| `event`       | Also carries                                                         | The agent should                                    |
+| ------------- | -------------------------------------------------------------------- | --------------------------------------------------- |
+| `sign_in_url` | `url`, `browserOpened`, `waitSeconds`                                | Show you `url`, saying whether a browser tab opened |
+| `device_code` | `userCode`, `verificationUri`, `url`, `browserOpened`, `waitSeconds` | Show you the code and where to enter it             |
+
+The command then waits up to `waitSeconds` for you to approve, so the agent has to let it run
+that long. An agent with no way to open your browser, such as one in a cloud sandbox, signs
+in with `--device`.
+
 ### Signing in from a machine with no browser
 
 `hardfin login --device` prints a short code and a page to enter it on, and waits. Approve

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]="62437fed-ab84-53c5-9984-9bbadc0f2e15")}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]="3f5ddeb4-6ae9-5ded-b447-15c8483fc583")}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-B02z-kNH.js");
+		const { toCli, toParseExitCode, wasReportAttempted } = await import("./program-ByvcKNri.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-B02z-kNH.js");
+		const { toReported } = await import("./program-ByvcKNri.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=62437fed-ab84-53c5-9984-9bbadc0f2e15
+//# debugId=3f5ddeb4-6ae9-5ded-b447-15c8483fc583

package/dist/{program-B02z-kNH.js → program-ByvcKNri.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]="b1928379-e7e3-5a7e-9ade-d45695e05814")}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]="93b4bc8d-ebeb-59ca-967b-9fd10484e4a5")}catch(e){}}();
 import { a as defineCommand, i as GLOBAL_FLAGS, r as ExitCode, t as toInvocation } from "./scrub-BN3gyBpR.js";
 import { n as toCompletion, t as toAnswer$1 } from "./completion-tree-rR_Rmeij.js";
 import { createRequire } from "node:module";
@@ -987,6 +987,7 @@ function toGuide(commands, version) {
 		"## Before calling",
 		"",
 		"- Authenticate with `--api-key`, by setting `HARDFIN_API_KEY`, or by running `hardfin login`",
+		"- `hardfin login` writes one JSON line on stderr before it waits. Show the person its `url`, or its `userCode` and `verificationUri`, and let the command run for `waitSeconds`",
 		"- Every command prints JSON on stdout and diagnostics on stderr",
 		"- Output is JSON whenever stdout is not a terminal, so no flag is needed when calling from code",
 		"",
@@ -2154,7 +2155,13 @@ async function runLogin(input) {
 			challenge: pkce.challenge
 		});
 		const opened = input.flags["noBrowser"] !== true && !process.env["HARDFIN_NO_BROWSER"] && openBrowser(url);
-		process.stderr.write(opened ? `Opening your browser to sign in. If it did not open:\n\n${url}\n\n` : `Open this URL to sign in:\n\n${url}\n\n`);
+		if (input.isJSON) writeEvent({
+			event: "sign_in_url",
+			url,
+			browserOpened: opened,
+			waitSeconds: WAIT_MS / 1e3
+		});
+		else process.stderr.write(opened ? `Opening your browser to sign in. If it did not open:\n\n${url}\n\n` : `Open this URL to sign in:\n\n${url}\n\n`);
 		const prompt = toPrompt(url);
 		if (process.stdin.isTTY) process.stderr.write("Press c to copy the URL, or paste the code or redirect URL here: ");
 		let callback;
@@ -2164,7 +2171,7 @@ async function runLogin(input) {
 			listener.close();
 			prompt.close();
 		}
-		process.stderr.write(callback.error ? "\n" : "\nApproved, finishing the sign in\n");
+		if (!input.isJSON) process.stderr.write(callback.error ? "\n" : "\nApproved, finishing the sign in\n");
 		if (callback.error) {
 			writeFailure("sign_in_failed", `sign in was refused: ${callback.error}${callback.errorDescription ? `, ${callback.errorDescription}` : ""}`, input.isJSON);
 			return ExitCode.ERROR;
@@ -2200,7 +2207,15 @@ async function runDeviceLogin(input, metadata, scope) {
 	const device = await toDeviceAuthorization(metadata.device_authorization_endpoint, settings.clientId, scope);
 	const url = device.verificationUriComplete ?? device.verificationUri;
 	const opened = input.flags["noBrowser"] !== true && !process.env["HARDFIN_NO_BROWSER"] && openBrowser(url);
-	process.stderr.write([
+	if (input.isJSON) writeEvent({
+		event: "device_code",
+		userCode: device.userCode,
+		verificationUri: device.verificationUri,
+		url,
+		browserOpened: opened,
+		waitSeconds: Math.max(0, Math.round((device.expiresAt - Date.now()) / 1e3))
+	});
+	else process.stderr.write([
 		"",
 		`  Code  ${device.userCode}`,
 		`  At    ${device.verificationUri}`,
@@ -2252,6 +2267,10 @@ async function toSignedIn(input, metadata, tokens) {
 	].join("\n"));
 	return ExitCode.OK;
 }
+/** writeEvent tells a program what a sign in is waiting on, as one line of JSON on stderr. */
+function writeEvent(event) {
+	process.stderr.write(`${JSON.stringify(event)}\n`);
+}
 /** toAuthorizationUrl builds the URL the person approves this CLI at. */
 function toAuthorizationUrl(endpoint, request) {
 	const url = new URL(endpoint);
@@ -6168,5 +6187,5 @@ async function toReported(error, isJSON, resolved, level = "error") {
 //#endregion
 export { toCli, toParseExitCode, toReported, wasReportAttempted };
 
-//# sourceMappingURL=program-B02z-kNH.js.map
-//# debugId=b1928379-e7e3-5a7e-9ade-d45695e05814
+//# sourceMappingURL=program-ByvcKNri.js.map
+//# debugId=93b4bc8d-ebeb-59ca-967b-9fd10484e4a5

package/package.json

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