@basein/runner 0.2.12 → 0.3.0

package/dist/control/recorder-main.d.ts

@@ -0,0 +1,73 @@
+/**
+ * recorder-main — the long-running half of `bir-hooks`: the control server
+ * that receives Claude Code's hooks and the proxies' step reports.
+ *
+ * Kept out of `bin/bir-hooks.ts` so the SessionStart hook (`bir-hooks ensure`),
+ * which runs on every session start, `/clear` and compaction, never loads the
+ * control server, the replay engine or the service client it does not use.
+ *
+ * THE ORDER OF START-UP IS THE POINT. Claude Code sends every hook of a
+ * session to this process's port. Until it listens, each one is refused, and
+ * Claude Code shows each refusal as a hook error. So, in order:
+ *
+ *   1. crash handlers — nothing after this can take the process down;
+ *   2. the log, the project's port and token, the journal — local files only;
+ *   3. the recorder, decided from disk alone (recorder-keeper.ts) — no network;
+ *   4. listen, and write the discovery file;
+ *   5. only then, in the background and bounded: refresh the token, check an
+ *      http address, notice a sign-in appearing — none of it ever delays a hook.
+ *
+ * It used to sign in (two network calls, no timeouts) between 2 and 4, and a
+ * slow service held the port closed for up to five minutes.
+ */
+import { ControlServer } from "./server.js";
+/**
+ * What a prompt waits for its scenario match by default (`BIR_MATCH_BUDGET_MS`).
+ * Past it the prompt goes on without one (K5): the service answering in 1-2 s
+ * must not add that to every prompt.
+ */
+export declare const DEFAULT_MATCH_BUDGET_MS = 1500;
+/**
+ * `BIR_CORRELATION_DECISION`, passed on only when it was set to `allow` or
+ * `ask`. Unset, nothing is passed and the control server decides — and by
+ * default (`auto`) it never answers `allow` for an ordinary wrapped call,
+ * which skipped the person's permission prompt.
+ */
+export declare function correlationDecisionFromEnv(): "allow" | "ask" | undefined;
+/**
+ * Which Anthropic key derivation may use, if any.
+ *
+ * In the background, only one the person set for this purpose. The
+ * hook-started recorder has Claude Code's environment, and an API-billed
+ * Claude Code carries its `ANTHROPIC_API_KEY` there: picking that up silently
+ * billed the person's own key for work the service does for a signed-in
+ * runner. It is dropped from this process (replay would otherwise read it
+ * from the environment) unless `BIR_USE_ANTHROPIC_API_KEY=1` says to use it.
+ *
+ * In a terminal (`bir-hooks` run by hand, `daemon` false) the environment is
+ * the operator's own, and older guides told them to set exactly this variable
+ * to keep derivation on the machine: it is used as it always was.
+ */
+export declare function derivationKey(daemon?: boolean): {
+    apiKey?: string;
+    source?: string;
+};
+/** Where the three replay switches came from, for `/health` and `bir doctor`. */
+export type ReplaySource = "env" | "sidecar" | "default";
+/** What a recorder still serves (K4, `ControlServer.activity()`). */
+export interface RecorderActivity {
+    /** Runs opened and not yet sealed. */
+    openRuns: number;
+    /** Sessions it has not forgotten (see the control server's reaper). */
+    knownSessions: number;
+    /** Registered proxies whose process is alive: an open window's MCP servers. */
+    liveProxyPids: number;
+}
+/**
+ * The control server's {@link RecorderActivity}. From its own accessor when it
+ * has one; otherwise the same, read from its `/health` body (heavier, and
+ * asked once a minute only while superseded).
+ */
+export declare function activityOf(server: ControlServer): RecorderActivity;
+export declare function runRecorder(): Promise<void>;
+//# sourceMappingURL=recorder-main.d.ts.map