@kikimoradev/kcloud 1.7.0 → 1.8.0

package/dist/main.js

@@ -2856,6 +2856,8 @@ z.object({
 		"agent.state",
 		"notification",
 		"notification.count",
+		"dashboard.agent",
+		"dashboard.removed",
 		"stream.closed",
 		"error"
 	]),
@@ -2918,6 +2920,78 @@ z.object({
 	contentDigest: agentBackupContentDigestSchema
 });
 z.object({ backupId: idSchema.nullable() });
+//#endregion
+//#region ../../packages/contracts/src/agent-phase.ts
+const agentPhaseKinds = [
+	"offHours",
+	"limitWait",
+	"authBlocked",
+	"queued",
+	"waiting",
+	"patrolling",
+	"sleeping",
+	"working",
+	"summarising"
+];
+const dashboardStatusSchema = z.enum([
+	"working",
+	"waiting",
+	"paused",
+	"stopped",
+	"error",
+	"transitioning"
+]);
+const dashboardFrameNames = [
+	"dashboard.agent",
+	"dashboard.removed",
+	"stream.closed",
+	"error"
+];
+const dashboardActivitySchema = z.object({
+	role: agentRoleSchema,
+	kind: z.enum(agentPhaseKinds),
+	taskId: z.string().nullable(),
+	title: z.string().nullable(),
+	cycle: z.int().nullable(),
+	sessionId: z.string().nullable(),
+	startedAt: z.iso.datetime()
+}).meta({ id: "DashboardActivity" });
+const dashboardAgentSchema = z.object({
+	id: idSchema,
+	projectId: idSchema,
+	name: z.string(),
+	slug: slugSchema,
+	state: agentStateSchema,
+	status: dashboardStatusSchema,
+	since: z.iso.datetime(),
+	until: z.iso.datetime().nullable(),
+	failureReason: z.string().nullable(),
+	retryAt: z.iso.datetime().nullable(),
+	activity: dashboardActivitySchema.nullable(),
+	costTodayUsd: z.number().nonnegative()
+}).meta({ id: "DashboardAgent" });
+const dashboardProjectSchema = z.object({
+	id: idSchema,
+	name: z.string(),
+	slug: slugSchema,
+	color: colorSchema,
+	logoHash: logoHashSchema.nullable(),
+	agents: z.array(dashboardAgentSchema)
+}).meta({ id: "DashboardProject" });
+z.object({
+	day: z.iso.date(),
+	projects: z.array(dashboardProjectSchema)
+}).meta({ id: "OrganizationDashboard" });
+const dashboardRemovalSchema = z.object({ agentId: idSchema }).meta({ id: "DashboardRemoval" });
+z.object({
+	event: z.enum(dashboardFrameNames),
+	data: z.union([
+		dashboardAgentSchema,
+		dashboardRemovalSchema,
+		z.object({ reason: z.string() }),
+		z.object({ code: errorCodeSchema })
+	])
+}).meta({ id: "DashboardFrame" });
 [
 	"application/vnd.oci.image.index.v1+json",
 	"application/vnd.oci.image.manifest.v1+json",
@@ -4207,10 +4281,10 @@ const splitHints = {
 	"node.split_exceeds_host": "The split asks for more than the host has; kcloud nodes split <node> shows the host."
 };
 const nodesOf = async (api, organizationId) => dataOf("list the nodes", await api.GET("/organizations/{organizationId}/nodes", { params: { path: { organizationId } } }), nodeHints).items;
-const namesOf = (nodes) => nodes.map(({ name }) => name).join(", ");
+const namesOf$1 = (nodes) => nodes.map(({ name }) => name).join(", ");
 const nodeIn = (nodes, reference, organization) => {
 	const found = nodes.find((node) => node.id === reference.toLowerCase() || node.name === reference);
-	if (found === void 0) throw new CliError(`There is no node ${reference} in ${organization}.`, nodes.length === 0 ? "kcloud nodes create <name> creates one." : `kcloud nodes list shows ${namesOf(nodes)}.`);
+	if (found === void 0) throw new CliError(`There is no node ${reference} in ${organization}.`, nodes.length === 0 ? "kcloud nodes create <name> creates one." : `kcloud nodes list shows ${namesOf$1(nodes)}.`);
 	return found;
 };
 const resolveNode = async (scope, reference) => {
@@ -5233,6 +5307,284 @@ const createCommand = (adaptersOf) => defineCommand({
 	}
 });
 //#endregion
+//#region src/client/stream.ts
+const firstBackoffMs = 1e3;
+const lastBackoffMs = 3e4;
+const defaultIdleMs = 1e3;
+const fatalStatuses = /* @__PURE__ */ new Set([
+	400,
+	401,
+	403,
+	404
+]);
+const fatalReasons = /* @__PURE__ */ new Set(["session.expired", "member.removed"]);
+const jittered = (milliseconds) => Math.round(milliseconds * (.8 + Math.random() * .2));
+const nextBackoff = (previous) => Math.min(previous === 0 ? firstBackoffMs : previous * 2, lastBackoffMs);
+const framesOf = (block) => {
+	let event = "message";
+	let id = null;
+	const data = [];
+	for (const line of block.split("\n")) {
+		if (line === "" || line.startsWith(":")) continue;
+		const separator = line.indexOf(":");
+		const field = separator === -1 ? line : line.slice(0, separator);
+		const value = separator === -1 ? "" : line.slice(separator + 1).trimStart();
+		if (field === "event") event = value;
+		else if (field === "id") id = value;
+		else if (field === "data") data.push(value);
+	}
+	if (data.length === 0) return null;
+	const text = data.join("\n");
+	try {
+		return {
+			event,
+			id,
+			data: JSON.parse(text)
+		};
+	} catch {
+		return {
+			event,
+			id,
+			data: text
+		};
+	}
+};
+const readBody = async (response, request, onId) => {
+	const body = response.body;
+	if (body === null) return {
+		closed: null,
+		frames: 0
+	};
+	const reader = body.getReader();
+	const decoder = new TextDecoder();
+	const timer = { current: null };
+	let buffer = "";
+	let frames = 0;
+	let closed = null;
+	const armIdle = () => {
+		if (request.follow) return;
+		if (timer.current !== null) clearTimeout(timer.current);
+		timer.current = setTimeout(() => {
+			reader.cancel();
+		}, request.idleMs ?? 1e3);
+	};
+	const stop = () => {
+		reader.cancel().catch(() => void 0);
+	};
+	request.signal?.addEventListener("abort", stop, { once: true });
+	if (request.signal?.aborted === true) stop();
+	armIdle();
+	try {
+		for (;;) {
+			const chunk = await reader.read().catch((error) => {
+				if (request.signal?.aborted === true) return { done: true };
+				throw error;
+			});
+			if (chunk.done) break;
+			buffer += decoder.decode(chunk.value, { stream: true });
+			let boundary = buffer.indexOf("\n\n");
+			while (boundary !== -1) {
+				const block = buffer.slice(0, boundary);
+				buffer = buffer.slice(boundary + 2);
+				const frame = framesOf(block);
+				if (frame !== null) {
+					frames += 1;
+					if (frame.id !== null) onId(frame.id);
+					if (frame.event === "stream.closed") closed = reasonOf(frame.data);
+					else if (frame.event === "error") throw new CliError(`${request.action} failed on the instance: ${codeOf(frame.data) ?? "internal.error"}.`);
+					else {
+						request.onFrame(frame);
+						armIdle();
+					}
+				}
+				boundary = buffer.indexOf("\n\n");
+			}
+			if (closed !== null) break;
+		}
+	} finally {
+		if (timer.current !== null) clearTimeout(timer.current);
+		request.signal?.removeEventListener("abort", stop);
+	}
+	return {
+		closed,
+		frames
+	};
+};
+const reasonOf = (data) => {
+	if (typeof data === "object" && data !== null && "reason" in data) {
+		const { reason } = data;
+		if (typeof reason === "string") return reason;
+	}
+	return "unknown";
+};
+const streamFrames = async (request) => {
+	const fetching = request.fetch ?? globalThis.fetch;
+	const query = new URLSearchParams(request.query ?? {});
+	const url = `${request.origin}/api/v1${request.path}${query.size === 0 ? "" : `?${query.toString()}`}`;
+	const resume = { lastEventId: null };
+	let backoff = 0;
+	const aborted = () => request.signal?.aborted === true;
+	for (;;) {
+		if (aborted()) return;
+		let response;
+		try {
+			response = await fetching(url, {
+				headers: {
+					accept: "text/event-stream",
+					authorization: `Bearer ${request.token}`,
+					...request.resumable === true && resume.lastEventId !== null ? { "last-event-id": resume.lastEventId } : {}
+				},
+				redirect: "error",
+				...request.signal === void 0 ? {} : { signal: request.signal }
+			});
+		} catch (error) {
+			if (aborted()) return;
+			throw unreachable(request.origin, error);
+		}
+		if (!response.ok) {
+			const body = await response.json().catch(() => void 0);
+			const failure = new ApiError(response.status, codeOf(body), request.action, detailsOf$1(body));
+			if (fatalStatuses.has(response.status) || !request.follow) throw failure;
+			request.onNotice?.(`${failure.message} Waiting to try again.`);
+			backoff = nextBackoff(backoff);
+			await request.wait(jittered(backoff));
+			continue;
+		}
+		backoff = 0;
+		const { closed } = await readBody(response, request, (id) => {
+			resume.lastEventId = id;
+		});
+		if (closed !== null && fatalReasons.has(closed)) throw new CliError(`The instance closed the stream: ${closed}.`, closed === "session.expired" ? "The token is no longer valid; run kcloud login again." : "You are no longer a member of that project.");
+		if (!request.follow || aborted()) return;
+		request.onNotice?.(closed === null ? "The stream ended; opening it again." : `The instance closed the stream: ${closed}. Opening it again.`);
+		backoff = nextBackoff(backoff);
+		await request.wait(jittered(backoff));
+	}
+};
+//#endregion
+//#region src/commands/agents/dashboard.ts
+const noTask = "-";
+const workKinds = /* @__PURE__ */ new Set([
+	"working",
+	"patrolling",
+	"summarising"
+]);
+const organizationDashboardOf = async (api, organizationId) => dataOf("show the dashboard of the organization", await api.GET("/organizations/{organizationId}/dashboard", { params: { path: { organizationId } } }), organizationHints);
+const statusOf = (agent) => agent.status === "transitioning" ? `${agent.status} (${agent.state})` : agent.status;
+const taskOf = (agent) => {
+	const { activity } = agent;
+	if (activity === null) return noTask;
+	if (!workKinds.has(activity.kind)) return agent.until === null ? activity.kind : `${activity.kind} until ${agent.until}`;
+	if (activity.kind === "patrolling") return activity.cycle === null ? "cycle" : `cycle ${activity.cycle}`;
+	if (activity.kind === "summarising") return "summary";
+	return activity.title ?? activity.taskId ?? noTask;
+};
+const dashboardText = (dashboard) => {
+	const rows = dashboard.projects.flatMap((project) => project.agents.map((agent) => [
+		project.slug,
+		agent.slug,
+		statusOf(agent),
+		agent.since,
+		taskOf(agent),
+		agent.costTodayUsd.toFixed(2)
+	]));
+	return rows.length === 0 ? `No agent in the projects you can see on ${dashboard.day}.` : renderTable([
+		{ header: "PROJECT" },
+		{ header: "AGENT" },
+		{ header: "STATUS" },
+		{ header: "SINCE" },
+		{ header: "TASK" },
+		{
+			header: "COST TODAY",
+			align: "right"
+		}
+	], rows);
+};
+const namesOf = (dashboard) => ({
+	projects: new Map(dashboard.projects.map(({ id, slug }) => [id, slug])),
+	agents: new Map(dashboard.projects.flatMap((project) => project.agents.map(({ id, slug }) => [id, {
+		projectId: project.id,
+		slug
+	}])))
+});
+const frameLineOf = (names, frame, at) => {
+	const changed = dashboardAgentSchema.safeParse(frame.data);
+	if (frame.event === "dashboard.agent" && changed.success) {
+		const agent = changed.data;
+		names.agents.set(agent.id, {
+			projectId: agent.projectId,
+			slug: agent.slug
+		});
+		const project = names.projects.get(agent.projectId) ?? agent.projectId;
+		return `${at.toISOString()} ${project}/${agent.slug} ${statusOf(agent)} ${taskOf(agent)}`;
+	}
+	const removed = dashboardRemovalSchema.safeParse(frame.data);
+	if (frame.event === "dashboard.removed" && removed.success) {
+		const known = names.agents.get(removed.data.agentId);
+		names.agents.delete(removed.data.agentId);
+		const project = known === void 0 ? "-" : names.projects.get(known.projectId) ?? known.projectId;
+		return `${at.toISOString()} ${project}/${known?.slug ?? removed.data.agentId} removed ${noTask}`;
+	}
+	return null;
+};
+const dashboardCommand = (adaptersOf) => defineCommand({
+	name: "dashboard",
+	summary: "Show what each agent of the organization is doing now, by project.",
+	usage: "agents dashboard [--follow]",
+	optionsUsage: [["-f, --follow", "keep printing a line for each change of an agent after the table"]],
+	options: { follow: {
+		type: "boolean",
+		short: "f",
+		default: false
+	} },
+	positionals: {
+		min: 0,
+		max: 0
+	},
+	run: async ({ values, settings, context }) => {
+		const adapters = adaptersOf(context);
+		const session = await openSession({
+			settings,
+			context,
+			api: adapters.api
+		});
+		const { id } = await session.organization();
+		const dashboard = await organizationDashboardOf(session.api, id);
+		if (!values.follow) {
+			if (settings.json) context.terminal.json(dashboard);
+			else context.terminal.line(dashboardText(dashboard));
+			return exitCodes.ok;
+		}
+		context.terminal.line(settings.json ? JSON.stringify(dashboard) : dashboardText(dashboard));
+		const names = namesOf(dashboard);
+		await streamFrames({
+			origin: session.origin,
+			token: session.token,
+			path: `/organizations/${encodeURIComponent(id)}/dashboard/stream`,
+			follow: true,
+			resumable: false,
+			idleMs: defaultIdleMs,
+			action: "follow the dashboard of the organization",
+			wait: adapters.wait,
+			onNotice: (text) => {
+				context.terminal.error(context.terminal.errorStyles.dim(text));
+			},
+			onFrame: (frame) => {
+				if (settings.json) {
+					context.terminal.line(JSON.stringify({
+						event: frame.event,
+						data: frame.data
+					}));
+					return;
+				}
+				const line = frameLineOf(names, frame, adapters.now());
+				if (line !== null) context.terminal.line(line);
+			}
+		});
+		return exitCodes.ok;
+	}
+});
+//#endregion
 //#region src/commands/agents/lifecycle.ts
 const summaries = {
 	start: "Start the agent and let it work.",
@@ -5645,161 +5997,6 @@ const observabilityCommands = (adaptersOf) => [
 	})
 ];
 //#endregion
-//#region src/client/stream.ts
-const firstBackoffMs = 1e3;
-const lastBackoffMs = 3e4;
-const defaultIdleMs = 1e3;
-const fatalStatuses = /* @__PURE__ */ new Set([
-	400,
-	401,
-	403,
-	404
-]);
-const fatalReasons = /* @__PURE__ */ new Set(["session.expired", "member.removed"]);
-const jittered = (milliseconds) => Math.round(milliseconds * (.8 + Math.random() * .2));
-const nextBackoff = (previous) => Math.min(previous === 0 ? firstBackoffMs : previous * 2, lastBackoffMs);
-const framesOf = (block) => {
-	let event = "message";
-	let id = null;
-	const data = [];
-	for (const line of block.split("\n")) {
-		if (line === "" || line.startsWith(":")) continue;
-		const separator = line.indexOf(":");
-		const field = separator === -1 ? line : line.slice(0, separator);
-		const value = separator === -1 ? "" : line.slice(separator + 1).trimStart();
-		if (field === "event") event = value;
-		else if (field === "id") id = value;
-		else if (field === "data") data.push(value);
-	}
-	if (data.length === 0) return null;
-	const text = data.join("\n");
-	try {
-		return {
-			event,
-			id,
-			data: JSON.parse(text)
-		};
-	} catch {
-		return {
-			event,
-			id,
-			data: text
-		};
-	}
-};
-const readBody = async (response, request, onId) => {
-	const body = response.body;
-	if (body === null) return {
-		closed: null,
-		frames: 0
-	};
-	const reader = body.getReader();
-	const decoder = new TextDecoder();
-	const timer = { current: null };
-	let buffer = "";
-	let frames = 0;
-	let closed = null;
-	const armIdle = () => {
-		if (request.follow) return;
-		if (timer.current !== null) clearTimeout(timer.current);
-		timer.current = setTimeout(() => {
-			reader.cancel();
-		}, request.idleMs ?? 1e3);
-	};
-	const stop = () => {
-		reader.cancel().catch(() => void 0);
-	};
-	request.signal?.addEventListener("abort", stop, { once: true });
-	if (request.signal?.aborted === true) stop();
-	armIdle();
-	try {
-		for (;;) {
-			const chunk = await reader.read().catch((error) => {
-				if (request.signal?.aborted === true) return { done: true };
-				throw error;
-			});
-			if (chunk.done) break;
-			buffer += decoder.decode(chunk.value, { stream: true });
-			let boundary = buffer.indexOf("\n\n");
-			while (boundary !== -1) {
-				const block = buffer.slice(0, boundary);
-				buffer = buffer.slice(boundary + 2);
-				const frame = framesOf(block);
-				if (frame !== null) {
-					frames += 1;
-					if (frame.id !== null) onId(frame.id);
-					if (frame.event === "stream.closed") closed = reasonOf(frame.data);
-					else if (frame.event === "error") throw new CliError(`${request.action} failed on the instance: ${codeOf(frame.data) ?? "internal.error"}.`);
-					else {
-						request.onFrame(frame);
-						armIdle();
-					}
-				}
-				boundary = buffer.indexOf("\n\n");
-			}
-			if (closed !== null) break;
-		}
-	} finally {
-		if (timer.current !== null) clearTimeout(timer.current);
-		request.signal?.removeEventListener("abort", stop);
-	}
-	return {
-		closed,
-		frames
-	};
-};
-const reasonOf = (data) => {
-	if (typeof data === "object" && data !== null && "reason" in data) {
-		const { reason } = data;
-		if (typeof reason === "string") return reason;
-	}
-	return "unknown";
-};
-const streamFrames = async (request) => {
-	const fetching = request.fetch ?? globalThis.fetch;
-	const query = new URLSearchParams(request.query ?? {});
-	const url = `${request.origin}/api/v1${request.path}${query.size === 0 ? "" : `?${query.toString()}`}`;
-	const resume = { lastEventId: null };
-	let backoff = 0;
-	const aborted = () => request.signal?.aborted === true;
-	for (;;) {
-		if (aborted()) return;
-		let response;
-		try {
-			response = await fetching(url, {
-				headers: {
-					accept: "text/event-stream",
-					authorization: `Bearer ${request.token}`,
-					...request.resumable === true && resume.lastEventId !== null ? { "last-event-id": resume.lastEventId } : {}
-				},
-				redirect: "error",
-				...request.signal === void 0 ? {} : { signal: request.signal }
-			});
-		} catch (error) {
-			if (aborted()) return;
-			throw unreachable(request.origin, error);
-		}
-		if (!response.ok) {
-			const body = await response.json().catch(() => void 0);
-			const failure = new ApiError(response.status, codeOf(body), request.action, detailsOf$1(body));
-			if (fatalStatuses.has(response.status) || !request.follow) throw failure;
-			request.onNotice?.(`${failure.message} Waiting to try again.`);
-			backoff = nextBackoff(backoff);
-			await request.wait(jittered(backoff));
-			continue;
-		}
-		backoff = 0;
-		const { closed } = await readBody(response, request, (id) => {
-			resume.lastEventId = id;
-		});
-		if (closed !== null && fatalReasons.has(closed)) throw new CliError(`The instance closed the stream: ${closed}.`, closed === "session.expired" ? "The token is no longer valid; run kcloud login again." : "You are no longer a member of that project.");
-		if (!request.follow || aborted()) return;
-		request.onNotice?.(closed === null ? "The stream ended; opening it again." : `The instance closed the stream: ${closed}. Opening it again.`);
-		backoff = nextBackoff(backoff);
-		await request.wait(jittered(backoff));
-	}
-};
-//#endregion
 //#region src/commands/agents/streams.ts
 const streamOptions = {
 	...agentOption,
@@ -6165,7 +6362,8 @@ const createAgentsCommand = (adaptersOf) => defineGroup({
 		backupsCommand(adaptersOf),
 		restoreCommand(adaptersOf),
 		...observabilityCommands(adaptersOf),
-		...streamCommands(adaptersOf)
+		...streamCommands(adaptersOf),
+		dashboardCommand(adaptersOf)
 	]
 });
 //#endregion
@@ -8567,6 +8765,15 @@ const organizationTools = [
 			return organizationCostsOf(run.api, id, costWindowFrom(from, to, run.now()));
 		}
 	}),
+	defineTool({
+		name: "organization_dashboard",
+		title: "Show what each agent of the organization is doing",
+		description: "Show the agents of the organization this server acts in, by project, each with its status and since when, the task or the cycle it works on, and what it spent today, a UTC day. A member sees the projects they belong to.",
+		operations: ["getOrganizationDashboard"],
+		safety: "read",
+		input: z.object({}),
+		run: async (_, run) => organizationDashboardOf(run.api, (await run.organization()).id)
+	}),
 	defineTool({
 		name: "organization_members_list",
 		title: "List the members of the organization",

package/package.json

@@ -15,7 +15,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.0",
+  "version": "1.8.0",
   "dependencies": {
     "@clack/prompts": "1.8.1",
     "@modelcontextprotocol/server": "2.3.0",