mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-19 11:26:02 +00:00
`--status`, `--stop`, `--list` and `--kill-all` emit a schema-versioned envelope with an `ok` discriminant under `--json`, from one writer and one failure-payload builder. Human output is unchanged; the JSON path is additive. The value is in the failure paths. An agent that gets a bare error line on stderr and an empty stdout cannot tell a crash from a "not running", so every failure is a document too — including a missing project, which under `--json` resolves through the throwing resolver rather than the human-shaped nudge.
71 lines
2.0 KiB
TypeScript
71 lines
2.0 KiB
TypeScript
export type PreviewLifecycleOperation = "start" | "status" | "stop" | "list" | "kill-all";
|
|
|
|
export type PreviewLifecycleState = "started" | "reused" | "running";
|
|
|
|
export interface PreviewLifecycleSession {
|
|
state: PreviewLifecycleState;
|
|
mode: "background" | "foreground" | "unknown";
|
|
projectName: string;
|
|
projectDir: string;
|
|
host: string;
|
|
port: number;
|
|
pid: number | null;
|
|
serverUrl: string;
|
|
studioUrl: string;
|
|
ready: boolean;
|
|
logPath?: string;
|
|
}
|
|
|
|
export type PreviewLifecycleResult =
|
|
| PreviewLifecycleSession
|
|
| { state: "not-running"; projectDir?: string }
|
|
| { state: "stopped"; projectDir: string }
|
|
| { state: "listed"; sessions: readonly PreviewLifecycleSession[] }
|
|
/**
|
|
* `failed` carries the records a stop pass could not prove ownership of;
|
|
* `unverifiedPorts` the ones skipped because the OS would not confirm which
|
|
* process owns the socket. Both are omissions from `stopped`, so an agent
|
|
* that only reads the count would otherwise see a silent shortfall.
|
|
*/
|
|
| {
|
|
state: "killed-all";
|
|
stopped: number;
|
|
failed?: readonly string[];
|
|
unverifiedPorts?: readonly number[];
|
|
};
|
|
|
|
export interface PreviewLifecyclePayload {
|
|
schemaVersion: 1;
|
|
operation: PreviewLifecycleOperation;
|
|
ok: true;
|
|
result: PreviewLifecycleResult;
|
|
}
|
|
|
|
export interface PreviewLifecycleFailurePayload {
|
|
schemaVersion: 1;
|
|
operation: PreviewLifecycleOperation;
|
|
ok: false;
|
|
error: { code: string; message: string };
|
|
}
|
|
|
|
export function lifecyclePayload(
|
|
operation: PreviewLifecycleOperation,
|
|
result: PreviewLifecycleResult,
|
|
): PreviewLifecyclePayload {
|
|
return { schemaVersion: 1, operation, ok: true, result };
|
|
}
|
|
|
|
export function lifecycleFailurePayload(
|
|
operation: PreviewLifecycleOperation,
|
|
code: string,
|
|
message: string,
|
|
): PreviewLifecycleFailurePayload {
|
|
return { schemaVersion: 1, operation, ok: false, error: { code, message } };
|
|
}
|
|
|
|
export function writeLifecycleJson(
|
|
payload: PreviewLifecyclePayload | PreviewLifecycleFailurePayload,
|
|
): void {
|
|
console.log(JSON.stringify(payload));
|
|
}
|