approval-md 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +584 -553
- package/SPEC.md +42 -13
- package/dist/src/adapters/agentmail.d.ts +426 -0
- package/dist/src/adapters/agentmail.js +2 -2
- package/dist/src/adapters/conformance.d.ts +149 -0
- package/dist/src/adapters/contract.d.ts +628 -0
- package/dist/src/adapters/contract.js +110 -16
- package/dist/src/adapters/contract.js.map +1 -1
- package/dist/src/adapters/email.d.ts +324 -0
- package/dist/src/adapters/env-passphrase.d.ts +93 -0
- package/dist/src/adapters/public.d.ts +11 -0
- package/dist/src/adapters/public.js +11 -0
- package/dist/src/adapters/public.js.map +1 -0
- package/dist/src/adapters/registry.d.ts +59 -0
- package/dist/src/adapters/registry.js +2 -1
- package/dist/src/adapters/registry.js.map +1 -1
- package/dist/src/adapters/smtp.d.ts +213 -0
- package/dist/src/adapters/vault-provider.d.ts +114 -0
- package/dist/src/adapters/vault-provider.js +3 -3
- package/dist/src/adapters/zzz.d.ts +66 -0
- package/dist/src/adapters/zzz.js +299 -0
- package/dist/src/adapters/zzz.js.map +1 -0
- package/dist/src/channels/batch.d.ts +109 -0
- package/dist/src/channels/cli.d.ts +193 -0
- package/dist/src/channels/conformance.d.ts +92 -0
- package/dist/src/channels/contract.d.ts +623 -0
- package/dist/src/channels/payload-view.d.ts +35 -0
- package/dist/src/channels/render-queue.d.ts +149 -0
- package/dist/src/channels/tagging.d.ts +196 -0
- package/dist/src/channels/telegram.d.ts +1832 -0
- package/dist/src/channels/web.d.ts +341 -0
- package/dist/src/cli/adapter.d.ts +90 -0
- package/dist/src/cli/adapter.js +25 -15
- package/dist/src/cli/adapter.js.map +1 -1
- package/dist/src/cli/amend.d.ts +59 -0
- package/dist/src/cli/args.d.ts +43 -0
- package/dist/src/cli/attest.d.ts +41 -0
- package/dist/src/cli/audit-card.d.ts +62 -0
- package/dist/src/cli/audit.d.ts +59 -0
- package/dist/src/cli/channel-telegram.d.ts +806 -0
- package/dist/src/cli/channel-web.d.ts +131 -0
- package/dist/src/cli/channel.d.ts +71 -0
- package/dist/src/cli/checkpoint-tap.d.ts +169 -0
- package/dist/src/cli/codex.d.ts +2 -0
- package/dist/src/cli/codex.js +172 -0
- package/dist/src/cli/codex.js.map +1 -0
- package/dist/src/cli/coverage.d.ts +61 -0
- package/dist/src/cli/daemon.d.ts +120 -0
- package/dist/src/cli/doctor.d.ts +129 -0
- package/dist/src/cli/doctor.js +119 -5
- package/dist/src/cli/doctor.js.map +1 -1
- package/dist/src/cli/env.d.ts +65 -0
- package/dist/src/cli/execute.d.ts +202 -0
- package/dist/src/cli/exit-codes.d.ts +73 -0
- package/dist/src/cli/feedback.d.ts +60 -0
- package/dist/src/cli/gate-window.d.ts +40 -0
- package/dist/src/cli/gate.d.ts +68 -0
- package/dist/src/cli/git-scope.d.ts +190 -0
- package/dist/src/cli/gloss-attach.d.ts +85 -0
- package/dist/src/cli/gloss-codex-child.d.ts +9 -0
- package/dist/src/cli/gloss-codex.d.ts +24 -0
- package/dist/src/cli/gloss-options.d.ts +42 -0
- package/dist/src/cli/gloss.d.ts +265 -0
- package/dist/src/cli/help.d.ts +103 -0
- package/dist/src/cli/help.js +173 -51
- package/dist/src/cli/help.js.map +1 -1
- package/dist/src/cli/hook-codex.d.ts +78 -0
- package/dist/src/cli/hook-codex.js +167 -0
- package/dist/src/cli/hook-codex.js.map +1 -0
- package/dist/src/cli/hook.d.ts +331 -0
- package/dist/src/cli/hook.js +186 -80
- package/dist/src/cli/hook.js.map +1 -1
- package/dist/src/cli/import.d.ts +35 -0
- package/dist/src/cli/init.d.ts +84 -0
- package/dist/src/cli/init.js +2 -2
- package/dist/src/cli/init.js.map +1 -1
- package/dist/src/cli/instructions.d.ts +23 -0
- package/dist/src/cli/journal.d.ts +41 -0
- package/dist/src/cli/log-advance.d.ts +287 -0
- package/dist/src/cli/log-advance.js +102 -11
- package/dist/src/cli/log-advance.js.map +1 -1
- package/dist/src/cli/log-anchor.d.ts +176 -0
- package/dist/src/cli/log-checkpoint.d.ts +22 -0
- package/dist/src/cli/log-sync.d.ts +243 -0
- package/dist/src/cli/log-verbs.d.ts +16 -0
- package/dist/src/cli/log-verbs.js +7 -1
- package/dist/src/cli/log-verbs.js.map +1 -1
- package/dist/src/cli/long-help.d.ts +70 -0
- package/dist/src/cli/main.d.ts +77 -0
- package/dist/src/cli/main.js +155 -5
- package/dist/src/cli/main.js.map +1 -1
- package/dist/src/cli/mcp.d.ts +52 -0
- package/dist/src/cli/paths.d.ts +56 -0
- package/dist/src/cli/payload.d.ts +58 -0
- package/dist/src/cli/policy.d.ts +43 -0
- package/dist/src/cli/preflight.d.ts +363 -0
- package/dist/src/cli/preflight.js +294 -7
- package/dist/src/cli/preflight.js.map +1 -1
- package/dist/src/cli/progress.d.ts +78 -0
- package/dist/src/cli/prompt.d.ts +209 -0
- package/dist/src/cli/quickstart.d.ts +46 -0
- package/dist/src/cli/quickstart.js +297 -0
- package/dist/src/cli/quickstart.js.map +1 -0
- package/dist/src/cli/records.d.ts +34 -0
- package/dist/src/cli/render.d.ts +22 -0
- package/dist/src/cli/sandbox.d.ts +51 -0
- package/dist/src/cli/scaffold.d.ts +79 -0
- package/dist/src/cli/setup-adapter.d.ts +137 -0
- package/dist/src/cli/setup-adapter.js +38 -4
- package/dist/src/cli/setup-adapter.js.map +1 -1
- package/dist/src/cli/setup-channel.d.ts +117 -0
- package/dist/src/cli/setup-checkpoint.d.ts +57 -0
- package/dist/src/cli/setup-common.d.ts +275 -0
- package/dist/src/cli/setup-flow.d.ts +287 -0
- package/dist/src/cli/setup-service.d.ts +96 -0
- package/dist/src/cli/setup.d.ts +202 -0
- package/dist/src/cli/style.d.ts +320 -0
- package/dist/src/cli/token.d.ts +39 -0
- package/dist/src/cli/up.d.ts +155 -0
- package/dist/src/cli/up.js +4 -2
- package/dist/src/cli/up.js.map +1 -1
- package/dist/src/cli/usage.d.ts +37 -0
- package/dist/src/cli/values.d.ts +40 -0
- package/dist/src/cli/vault.d.ts +59 -0
- package/dist/src/cli/vault.js +2 -2
- package/dist/src/cli/vault.js.map +1 -1
- package/dist/src/cli/verb-registry.d.ts +76 -0
- package/dist/src/cli/verb-registry.js +176 -8
- package/dist/src/cli/verb-registry.js.map +1 -1
- package/dist/src/cli/wordmark.d.ts +31 -0
- package/dist/src/cli/wordmark.js +2 -2
- package/dist/src/codex/doctor.d.ts +13 -0
- package/dist/src/codex/doctor.js +41 -0
- package/dist/src/codex/doctor.js.map +1 -0
- package/dist/src/codex/manifest.d.ts +49 -0
- package/dist/src/codex/manifest.js +103 -0
- package/dist/src/codex/manifest.js.map +1 -0
- package/dist/src/codex/templates.d.ts +41 -0
- package/dist/src/codex/templates.js +319 -0
- package/dist/src/codex/templates.js.map +1 -0
- package/dist/src/codex/trust.d.ts +19 -0
- package/dist/src/codex/trust.js +183 -0
- package/dist/src/codex/trust.js.map +1 -0
- package/dist/src/codex/workspace-plan.d.ts +131 -0
- package/dist/src/codex/workspace-plan.js +561 -0
- package/dist/src/codex/workspace-plan.js.map +1 -0
- package/dist/src/core/actor.d.ts +2 -0
- package/dist/src/core/actor.js +5 -0
- package/dist/src/core/actor.js.map +1 -0
- package/dist/src/core/advance-cycle.d.ts +170 -0
- package/dist/src/core/agents-md.d.ts +276 -0
- package/dist/src/core/apply-patch.d.ts +49 -0
- package/dist/src/core/apply-patch.js +266 -0
- package/dist/src/core/apply-patch.js.map +1 -0
- package/dist/src/core/attest.d.ts +420 -0
- package/dist/src/core/attest.js +13 -1
- package/dist/src/core/attest.js.map +1 -1
- package/dist/src/core/audit.d.ts +492 -0
- package/dist/src/core/budgets.d.ts +238 -0
- package/dist/src/core/checkpoint.d.ts +500 -0
- package/dist/src/core/child-env.d.ts +88 -0
- package/dist/src/core/clock.d.ts +52 -0
- package/dist/src/core/command-class.d.ts +543 -0
- package/dist/src/core/command-class.js +43 -8
- package/dist/src/core/command-class.js.map +1 -1
- package/dist/src/core/coverage-sources/adapter.d.ts +40 -0
- package/dist/src/core/coverage-sources/gh.d.ts +48 -0
- package/dist/src/core/coverage-sources/git.d.ts +101 -0
- package/dist/src/core/coverage.d.ts +217 -0
- package/dist/src/core/credential-spec.d.ts +72 -0
- package/dist/src/core/dark-session.d.ts +331 -0
- package/dist/src/core/decision-refusal.d.ts +185 -0
- package/dist/src/core/env-file.d.ts +450 -0
- package/dist/src/core/execute.d.ts +858 -0
- package/dist/src/core/execute.js +44 -6
- package/dist/src/core/execute.js.map +1 -1
- package/dist/src/core/frontmatter.d.ts +78 -0
- package/dist/src/core/gate-window.d.ts +312 -0
- package/dist/src/core/gate.d.ts +1364 -0
- package/dist/src/core/gate.js +68 -13
- package/dist/src/core/gate.js.map +1 -1
- package/dist/src/core/git-run.d.ts +73 -0
- package/dist/src/core/harness-version.d.ts +157 -0
- package/dist/src/core/harness-version.js +2 -1
- package/dist/src/core/harness-version.js.map +1 -1
- package/dist/src/core/harness-wait.d.ts +55 -0
- package/dist/src/core/head-retry.d.ts +107 -0
- package/dist/src/core/instance.d.ts +253 -0
- package/dist/src/core/intake-limits.d.ts +247 -0
- package/dist/src/core/jcs.d.ts +52 -0
- package/dist/src/core/journal.d.ts +144 -0
- package/dist/src/core/live-draw.d.ts +436 -0
- package/dist/src/core/log-reconcile.d.ts +89 -0
- package/dist/src/core/log-subscribe.d.ts +36 -0
- package/dist/src/core/log-subscribe.js +162 -0
- package/dist/src/core/log-subscribe.js.map +1 -0
- package/dist/src/core/log.d.ts +278 -0
- package/dist/src/core/loop.d.ts +274 -0
- package/dist/src/core/loop.js +11 -0
- package/dist/src/core/loop.js.map +1 -1
- package/dist/src/core/md-fence.d.ts +41 -0
- package/dist/src/core/money.d.ts +147 -0
- package/dist/src/core/payload-census.d.ts +74 -0
- package/dist/src/core/payload-store.d.ts +175 -0
- package/dist/src/core/payload.d.ts +71 -0
- package/dist/src/core/policy-diff.d.ts +292 -0
- package/dist/src/core/policy-diff.js +27 -4
- package/dist/src/core/policy-diff.js.map +1 -1
- package/dist/src/core/policy-expectations.d.ts +199 -0
- package/dist/src/core/policy-explain.d.ts +150 -0
- package/dist/src/core/policy-explain.js +31 -3
- package/dist/src/core/policy-explain.js.map +1 -1
- package/dist/src/core/policy-load.d.ts +527 -0
- package/dist/src/core/policy-load.js +15 -3
- package/dist/src/core/policy-load.js.map +1 -1
- package/dist/src/core/policy-match.d.ts +281 -0
- package/dist/src/core/policy-match.js +20 -9
- package/dist/src/core/policy-match.js.map +1 -1
- package/dist/src/core/policy-proposal.d.ts +265 -0
- package/dist/src/core/prompt-layout.d.ts +221 -0
- package/dist/src/core/protected-path-guard.d.ts +453 -0
- package/dist/src/core/protected-path-guard.js +514 -35
- package/dist/src/core/protected-path-guard.js.map +1 -1
- package/dist/src/core/registration.d.ts +25 -0
- package/dist/src/core/reindex.d.ts +99 -0
- package/dist/src/core/sampler.d.ts +313 -0
- package/dist/src/core/sandbox.d.ts +290 -0
- package/dist/src/core/seal.d.ts +165 -0
- package/dist/src/core/state.d.ts +505 -0
- package/dist/src/core/task-file.d.ts +185 -0
- package/dist/src/core/telegram-config.d.ts +93 -0
- package/dist/src/core/token.d.ts +409 -0
- package/dist/src/core/token.js +21 -38
- package/dist/src/core/token.js.map +1 -1
- package/dist/src/core/validate.d.ts +138 -0
- package/dist/src/core/values.d.ts +137 -0
- package/dist/src/core/vault.d.ts +291 -0
- package/dist/src/core/verified-snapshot.d.ts +204 -0
- package/dist/src/core/verify.d.ts +336 -0
- package/dist/src/core/version.d.ts +8 -0
- package/dist/src/core/wysiwys.d.ts +370 -0
- package/dist/src/daemon/advance-child.d.ts +39 -0
- package/dist/src/daemon/advance.d.ts +466 -0
- package/dist/src/daemon/audit.d.ts +87 -0
- package/dist/src/daemon/daemon.d.ts +1180 -0
- package/dist/src/daemon/dark-session.d.ts +64 -0
- package/dist/src/daemon/draw-child.d.ts +36 -0
- package/dist/src/daemon/draw.d.ts +154 -0
- package/dist/src/daemon/git-evidence.d.ts +173 -0
- package/dist/src/daemon/git-evidence.js +1 -1
- package/dist/src/daemon/projection.d.ts +180 -0
- package/dist/src/daemon/prune.d.ts +207 -0
- package/dist/src/mcp/http.d.ts +113 -0
- package/dist/src/mcp/server.d.ts +265 -0
- package/dist/src/mcp/server.js +9 -1
- package/dist/src/mcp/server.js.map +1 -1
- package/docs/adapter-api.md +106 -0
- package/docs/cli-reference.md +389 -36
- package/docs/codex-enforced-session.md +30 -0
- package/package.json +12 -2
- package/schema/codex-instance.schema.json +82 -0
- package/schema/event.schema.json +2 -1
- package/schema/fixtures/codex-instance/invalid/unpinned-codex-version.json +40 -0
- package/schema/fixtures/codex-instance/valid/canonical.json +40 -0
- package/schema/policy.schema.json +21 -1
- package/templates/codex/README.md +9 -0
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Coverage of observed side effects (APRV-245, SPEC.md §10.1).
|
|
3
|
+
*
|
|
4
|
+
* ## Why a verb that witnesses rather than gates
|
|
5
|
+
*
|
|
6
|
+
* MCP use is voluntary. An agent connected to `approval mcp serve --http` can
|
|
7
|
+
* call `request`, `wait` and `run`, or it can simply act. Nothing in this
|
|
8
|
+
* runtime observes the act, because the runtime is not in the path: a gate an
|
|
9
|
+
* agent may route around reports only on the actions routed through it, and a
|
|
10
|
+
* report that counts only its own inputs is a report that cannot go down.
|
|
11
|
+
*
|
|
12
|
+
* What makes the arrangement honest is that side effects leave witnesses THIS
|
|
13
|
+
* PROJECT DOES NOT WRITE. Git history records commits, merges and tags. `gh`
|
|
14
|
+
* records pull requests. AgentMail records the messages an inbox actually sent.
|
|
15
|
+
* None of those are appended by approval.md, none of them are reachable by an
|
|
16
|
+
* agent editing its own log, and each of them can be read back and joined
|
|
17
|
+
* against the verified records to ask one question per effect: does the log say
|
|
18
|
+
* a human, or a policy, ever saw this?
|
|
19
|
+
*
|
|
20
|
+
* This module is that join, and nothing else. It performs no IO, reads no clock,
|
|
21
|
+
* spawns nothing and appends nothing. The sources under `coverage-sources/`
|
|
22
|
+
* gather the effects; `cli/coverage.ts` prints the answer.
|
|
23
|
+
*
|
|
24
|
+
* ## What counts as evidence, stated exactly
|
|
25
|
+
*
|
|
26
|
+
* The strongest answer first (APRV-251): an `execution.completed` may carry
|
|
27
|
+
* `payload.provider_ref`, the identifier the provider filed the effect under
|
|
28
|
+
* (SPEC.md §8), and an effect whose source and id match one is covered by that
|
|
29
|
+
* record, reported as `provider-ref`. No window is applied to it, because an id
|
|
30
|
+
* names one effect and a class in a span of time names a period. That is the
|
|
31
|
+
* whole difference the reference buys: without it, a gated send covers an
|
|
32
|
+
* ungated one of the same class sitting beside it in the window, and with it
|
|
33
|
+
* the log answers about the message actually in front of the reader.
|
|
34
|
+
*
|
|
35
|
+
* Otherwise, for one {@link ObservedEffect}, evidence is the EARLIEST record
|
|
36
|
+
* that is all three of:
|
|
37
|
+
*
|
|
38
|
+
* 1. one of `task.registered`, `approval.granted`, `execution.started`,
|
|
39
|
+
* `execution.completed` — the four records that mean "this runtime was told
|
|
40
|
+
* about an action of this class", from the declaration through the human's
|
|
41
|
+
* decision to the spend;
|
|
42
|
+
* 2. of a matching class: EXACT first ({@link classesOf} against the effect's
|
|
43
|
+
* class), and only if nothing matches exactly, a FAMILY match on the first
|
|
44
|
+
* two dotted segments, reported distinctly as `family` so a reader is never
|
|
45
|
+
* shown a weaker match dressed as a strong one;
|
|
46
|
+
* 3. inside the window `[at - 24h, at + 5m]`.
|
|
47
|
+
*
|
|
48
|
+
* The window is asymmetric on purpose and both halves are arguable, so both are
|
|
49
|
+
* written down. **24 hours back**, because the ordinary shape is register →
|
|
50
|
+
* request → grant → act, and the gap between the human's tap and the effect is
|
|
51
|
+
* a working day at worst; a week back would let one grant carry every later
|
|
52
|
+
* effect of its class, which is the laundering hole APRV-202 closed in the
|
|
53
|
+
* protected-path guard. **5 minutes forward**, because that is clock skew
|
|
54
|
+
* between git's author date (or a provider's timestamp) and this log, and not an
|
|
55
|
+
* ordering allowance: a record appended an hour after an effect is a record
|
|
56
|
+
* about some other action, whatever its class.
|
|
57
|
+
*
|
|
58
|
+
* The one place this rule is not used is a protected FILE path. Those already
|
|
59
|
+
* have a stronger answer: `core/protected-path-guard.ts` matches a change's
|
|
60
|
+
* BYTES against the material a grant bound, and its `attested` and
|
|
61
|
+
* `granted-file` verdicts are content-level rather than time-level. So an effect
|
|
62
|
+
* carrying a `path` takes the guard's verdict when the caller supplies a report
|
|
63
|
+
* that covers it, and the class-and-window rule is what everything else gets.
|
|
64
|
+
*
|
|
65
|
+
* ## Verified records only, and no writes
|
|
66
|
+
*
|
|
67
|
+
* The caller reads through `readVerifiedRecords` (SPEC.md §11.1 invariant 1);
|
|
68
|
+
* this function is handed records that already passed chain verification and has
|
|
69
|
+
* no way to read any others. It writes nothing anywhere, which is what lets it be
|
|
70
|
+
* informational: the whole report is derived, and running it changes no state
|
|
71
|
+
* that any later verdict depends on.
|
|
72
|
+
*
|
|
73
|
+
* ## What a green line does NOT say
|
|
74
|
+
*
|
|
75
|
+
* Coverage is a witness, not a control. An effect made with a credential the
|
|
76
|
+
* AGENT itself holds — an API key pasted into a chat surface, a token in a
|
|
77
|
+
* shell profile — leaves a witness only where the provider keeps one this verb
|
|
78
|
+
* can read. The remedy for that tier is custody (SPEC.md §10.4: adapters hold
|
|
79
|
+
* the credentials and answer only to a token), not a bigger report, and
|
|
80
|
+
* `docs/cli-reference.md#coverage` writes the three tiers out so that a green
|
|
81
|
+
* coverage line is never read as the claim that nothing else happened.
|
|
82
|
+
*/
|
|
83
|
+
import type { EventRecord } from "./log.js";
|
|
84
|
+
import type { GuardReport } from "./protected-path-guard.js";
|
|
85
|
+
/**
|
|
86
|
+
* One side effect a witness outside this runtime recorded.
|
|
87
|
+
*
|
|
88
|
+
* Every field is a FACT ABOUT THE WORLD, gathered from git, `gh` or a provider,
|
|
89
|
+
* and none of it is self-reported by the party under oversight. `actorHint` is
|
|
90
|
+
* named a hint deliberately: a commit author email is whatever the committer
|
|
91
|
+
* configured, so it is printed for a reader and never matched on (SPEC.md §11.1
|
|
92
|
+
* invariant 4 — a self-reported field never reduces scrutiny).
|
|
93
|
+
*/
|
|
94
|
+
export interface ObservedEffect {
|
|
95
|
+
/** Which source saw it: `git`, `gh`, `agentmail`. */
|
|
96
|
+
source: string;
|
|
97
|
+
/** The witness's own identifier: a commit sha, a PR number, a message id. */
|
|
98
|
+
id: string;
|
|
99
|
+
/** The side-effect class (SPEC.md §7) this effect would have been declared under. */
|
|
100
|
+
class: string;
|
|
101
|
+
/** When the witness says it happened, RFC 3339. */
|
|
102
|
+
at: string;
|
|
103
|
+
/** Who the witness says did it, or `null`. Printed, never matched on. */
|
|
104
|
+
actorHint: string | null;
|
|
105
|
+
/** One line a person can read. Never a message body, never a secret. */
|
|
106
|
+
detail: string;
|
|
107
|
+
/** For a file effect, the repository-relative path it changed. */
|
|
108
|
+
path?: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* The span an observation covers, as two RFC 3339 instants.
|
|
112
|
+
*
|
|
113
|
+
* Both ends are supplied by the caller and neither is read from a clock here,
|
|
114
|
+
* so two runs over the same window ask every provider the same question.
|
|
115
|
+
*/
|
|
116
|
+
export interface ObservationWindow {
|
|
117
|
+
since: string;
|
|
118
|
+
until: string;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* What the log says about one effect.
|
|
122
|
+
*
|
|
123
|
+
* `null` is a GAP: no record of a matching class sits in the window. The two
|
|
124
|
+
* shapes carry different kinds of proof, so they are different shapes rather
|
|
125
|
+
* than one object with optional halves — a record seq is something a reader can
|
|
126
|
+
* paste into `approval log tail`, and a guard verdict is a statement about
|
|
127
|
+
* bytes.
|
|
128
|
+
*/
|
|
129
|
+
export type Evidence = {
|
|
130
|
+
seq: number;
|
|
131
|
+
event: string;
|
|
132
|
+
} | {
|
|
133
|
+
verdict: "attested" | "granted-file";
|
|
134
|
+
} | null;
|
|
135
|
+
/** How the evidence was found, so a weaker match is never read as a stronger one. */
|
|
136
|
+
export type CoverageMatch =
|
|
137
|
+
/**
|
|
138
|
+
* An `execution.completed` names this exact effect by the provider's own
|
|
139
|
+
* identifier (APRV-251). The strongest answer this join can give: it is about
|
|
140
|
+
* one effect rather than about a class in a span of time.
|
|
141
|
+
*/
|
|
142
|
+
"provider-ref"
|
|
143
|
+
/** The record's declared class equals the effect's class. */
|
|
144
|
+
| "exact"
|
|
145
|
+
/** Only the class FAMILY matched (the first two dotted segments). */
|
|
146
|
+
| "family"
|
|
147
|
+
/** The protected-path guard answered for this path, on bytes rather than time. */
|
|
148
|
+
| "protected-path"
|
|
149
|
+
/** Nothing matched. `evidence` is `null`. */
|
|
150
|
+
| "none";
|
|
151
|
+
/** One effect, and what the log had to say about it. */
|
|
152
|
+
export interface CoverageEntry {
|
|
153
|
+
effect: ObservedEffect;
|
|
154
|
+
evidence: Evidence;
|
|
155
|
+
match: CoverageMatch;
|
|
156
|
+
}
|
|
157
|
+
/** Observed and covered counts for one grouping key. */
|
|
158
|
+
export interface CoverageTotals {
|
|
159
|
+
key: string;
|
|
160
|
+
observed: number;
|
|
161
|
+
covered: number;
|
|
162
|
+
}
|
|
163
|
+
export interface CoverageReport {
|
|
164
|
+
entries: readonly CoverageEntry[];
|
|
165
|
+
/** Totals per source, sorted by source name. */
|
|
166
|
+
bySource: readonly CoverageTotals[];
|
|
167
|
+
/** Totals per class, sorted by class name. */
|
|
168
|
+
byClass: readonly CoverageTotals[];
|
|
169
|
+
observed: number;
|
|
170
|
+
covered: number;
|
|
171
|
+
}
|
|
172
|
+
/** How far BACK of an effect a record may sit and still be about it: 24 hours. */
|
|
173
|
+
export declare const COVERAGE_LOOKBACK_MS: number;
|
|
174
|
+
/**
|
|
175
|
+
* How far AHEAD of an effect a record may sit: five minutes.
|
|
176
|
+
*
|
|
177
|
+
* A skew allowance between two clocks, not an ordering allowance. See the
|
|
178
|
+
* module note for why the window is asymmetric.
|
|
179
|
+
*/
|
|
180
|
+
export declare const COVERAGE_AHEAD_MS: number;
|
|
181
|
+
/** The record types that can be evidence, in the order they occur in a life. */
|
|
182
|
+
export declare const EVIDENCE_EVENTS: readonly string[];
|
|
183
|
+
export interface CoverageOptions {
|
|
184
|
+
/** Override {@link COVERAGE_LOOKBACK_MS}. */
|
|
185
|
+
lookbackMs?: number;
|
|
186
|
+
/** Override {@link COVERAGE_AHEAD_MS}. */
|
|
187
|
+
aheadMs?: number;
|
|
188
|
+
/**
|
|
189
|
+
* The protected-path guard's report for the same range, when the caller ran
|
|
190
|
+
* one. An effect whose `path` has a passing finding there takes that verdict
|
|
191
|
+
* instead of the class-and-window rule: it is content-level evidence, and
|
|
192
|
+
* content beats time.
|
|
193
|
+
*/
|
|
194
|
+
guard?: GuardReport | null;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* The family of a class: its first two dotted segments.
|
|
198
|
+
*
|
|
199
|
+
* `vcs.push.main` and `vcs.push.branch` are one family; `vcs.push.main` and
|
|
200
|
+
* `vcs.commit.branch` are not. Two segments rather than one, because a single
|
|
201
|
+
* segment would make every `vcs.*` record evidence for every other, and the
|
|
202
|
+
* pushes and the commits are different decisions. A class with fewer than two
|
|
203
|
+
* segments is its own family.
|
|
204
|
+
*/
|
|
205
|
+
export declare function classFamily(cls: string): string;
|
|
206
|
+
/**
|
|
207
|
+
* Join observed effects against verified records.
|
|
208
|
+
*
|
|
209
|
+
* Deterministic and total: the same effects and the same records produce the
|
|
210
|
+
* same report, in the same order, every time. Entries come back in the order the
|
|
211
|
+
* effects were given, and the totals are sorted by key so that a `--json`
|
|
212
|
+
* consumer can pin the whole object with a `deepEqual`.
|
|
213
|
+
*
|
|
214
|
+
* @param effects what the witnesses outside this runtime saw
|
|
215
|
+
* @param records records that have ALREADY passed chain verification
|
|
216
|
+
*/
|
|
217
|
+
export declare function coverageReport(effects: readonly ObservedEffect[], records: readonly EventRecord[], options?: CoverageOptions): CoverageReport;
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The credential manifest type (SPEC.md §10.4; APRV-78).
|
|
3
|
+
*
|
|
4
|
+
* An adapter reads named values out of the vault, and until this file existed
|
|
5
|
+
* the only place those names were written down was the adapter's own `act`,
|
|
6
|
+
* where a human setting the vault up cannot read them. A manifest moves that
|
|
7
|
+
* knowledge one level out: the adapter DECLARES what it needs, and a generic
|
|
8
|
+
* interactive writer (`cli/setup-flow.ts`) asks for it, validates it, stores it
|
|
9
|
+
* and reports on it without knowing anything about email or SMTP.
|
|
10
|
+
*
|
|
11
|
+
* **This module is a type and nothing else.** No I/O, no imports, no runtime
|
|
12
|
+
* values, deliberately: it is imported by `src/adapters/*` (which must not
|
|
13
|
+
* depend on the CLI) and by `src/cli/*` (which must not depend on a particular
|
|
14
|
+
* adapter), so anything with behaviour in it would make one of those two edges
|
|
15
|
+
* a dependency on the other. The behaviour lives at both ends; the vocabulary
|
|
16
|
+
* lives here.
|
|
17
|
+
*
|
|
18
|
+
* A spec carries no default for a `secret`, and it never carries a VALUE of any
|
|
19
|
+
* kind: the manifest is printed, in checklists and in non-interactive hints, and
|
|
20
|
+
* a field that could hold a credential would be a credential in a terminal.
|
|
21
|
+
*/
|
|
22
|
+
/**
|
|
23
|
+
* What kind of thing a credential is, from the operator's point of view.
|
|
24
|
+
*
|
|
25
|
+
* Three, not two, because the collection differs for each: a `config` value is
|
|
26
|
+
* typed in the clear with its default shown, a `choice` is picked from a
|
|
27
|
+
* numbered list so a typo cannot become a silently wrong transport, and a
|
|
28
|
+
* `secret` is read with no echo. The vault stores all three identically — it
|
|
29
|
+
* has no notion of a non-secret entry — so this distinction exists purely to
|
|
30
|
+
* decide what the human is asked and what may be echoed back at them.
|
|
31
|
+
*/
|
|
32
|
+
export type CredentialKind = "secret" | "config" | "choice";
|
|
33
|
+
/** One value an adapter reads from the vault, described well enough to ask for. */
|
|
34
|
+
export interface CredentialSpec {
|
|
35
|
+
/** The vault name, exactly as the adapter's `act` asks for it. */
|
|
36
|
+
name: string;
|
|
37
|
+
kind: CredentialKind;
|
|
38
|
+
/** A short label for a prompt: `SMTP host`. */
|
|
39
|
+
label: string;
|
|
40
|
+
/** One sentence for the checklist: what this is and why the adapter wants it. */
|
|
41
|
+
describe: string;
|
|
42
|
+
/**
|
|
43
|
+
* Must the vault hold this before the adapter can work?
|
|
44
|
+
*
|
|
45
|
+
* `false` does not mean "unimportant": the email adapter's user and password
|
|
46
|
+
* are both optional and both-or-neither, which no per-field flag can express.
|
|
47
|
+
* That is what {@link CredentialSpec.validate}'s cross-field companion (the
|
|
48
|
+
* flow's `check` hook) is for.
|
|
49
|
+
*/
|
|
50
|
+
required: boolean;
|
|
51
|
+
/** Offered as `[default]` at the prompt. Never present on a `secret`. */
|
|
52
|
+
default?: string;
|
|
53
|
+
/** For `kind: "choice"`: the closed set, each with a one-line explanation. */
|
|
54
|
+
choices?: readonly {
|
|
55
|
+
value: string;
|
|
56
|
+
describe: string;
|
|
57
|
+
}[];
|
|
58
|
+
/**
|
|
59
|
+
* Per-field validation, run on the value the operator typed.
|
|
60
|
+
*
|
|
61
|
+
* Returns the refusal SENTENCE rather than a code, because the sentence is
|
|
62
|
+
* the whole point: it must be the same one the adapter's own `act` would
|
|
63
|
+
* print later, so an operator does not learn at send time that the port they
|
|
64
|
+
* typed at setup time was never a port.
|
|
65
|
+
*/
|
|
66
|
+
validate?(value: string): {
|
|
67
|
+
ok: true;
|
|
68
|
+
} | {
|
|
69
|
+
ok: false;
|
|
70
|
+
message: string;
|
|
71
|
+
};
|
|
72
|
+
}
|
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The dark-session detector (APRV-192): the log is asked what git already knows.
|
|
3
|
+
*
|
|
4
|
+
* ## The hole this closes
|
|
5
|
+
*
|
|
6
|
+
* APRV-151 built the CI-side grant cross-check, and its root cause is the thing
|
|
7
|
+
* that check cannot reach. A session whose harness never invoked the hook writes
|
|
8
|
+
* NO records at all: not a grant, not a refusal, not a request. Nothing inside
|
|
9
|
+
* such a session is in a position to notice, because the component that would
|
|
10
|
+
* have written the record is the component that did not run, and asking a
|
|
11
|
+
* session whether it is hooked asks the party under oversight to report its own
|
|
12
|
+
* oversight (SPEC.md §11). The CI guard sees only the diffs that reach a pull
|
|
13
|
+
* request; a session that ran dark and pushed nothing, or pushed to a branch
|
|
14
|
+
* nobody opened a pull request for, leaves the guard with nothing to read.
|
|
15
|
+
*
|
|
16
|
+
* So the direction is reversed. APRV-42's git evidence asks "does every log
|
|
17
|
+
* entry match git?"; this asks **"does every piece of git activity match a log
|
|
18
|
+
* entry?"** Git is the artifact a session cannot help producing: a commit has an
|
|
19
|
+
* author, a date and a tree, a linked worktree has a root and a birth, and none
|
|
20
|
+
* of those is authored by the runtime's hook. The absence of a record beside
|
|
21
|
+
* them is the signal.
|
|
22
|
+
*
|
|
23
|
+
* ## Two arms, because there are two questions
|
|
24
|
+
*
|
|
25
|
+
* **Arm A, evidence.** For each commit in the window, every guarded path it
|
|
26
|
+
* changed must carry evidence in the verified log that a human decided it. This
|
|
27
|
+
* is not reimplemented: it is {@link evaluateProtectedPaths}, APRV-151's own
|
|
28
|
+
* evaluator, called per commit, so the verdict vocabulary (`attested`,
|
|
29
|
+
* `granted-file`, `granted-command`), the recency bound, the exempt evidence
|
|
30
|
+
* surface and the `no-evidence` code are one implementation with two callers.
|
|
31
|
+
* Arm A runs over EVERY checkout, the primary included, because a guarded-path
|
|
32
|
+
* commit with no evidence is dark wherever it was made.
|
|
33
|
+
*
|
|
34
|
+
* **Arm B, silence.** A linked worktree that produced commits in the window (or
|
|
35
|
+
* that came into existence in it) and to which NOT ONE record in the window can
|
|
36
|
+
* be attributed is a dark session, whatever it touched. This is the arm that
|
|
37
|
+
* catches the APRV-151 root cause on paths the CI guard never sees, and it is
|
|
38
|
+
* the arm that needs an attribution rule.
|
|
39
|
+
*
|
|
40
|
+
* ## How a record is attributed to a worktree
|
|
41
|
+
*
|
|
42
|
+
* Hook task ids are `hook:<session>:<tool-use>` and carry no checkout, so the
|
|
43
|
+
* id is not the key. The bound material is. Every gated file-tool call binds
|
|
44
|
+
* `{tool, rule, file, …}` with `file` ABSOLUTE (`cli/hook.ts`), and every gated
|
|
45
|
+
* shell call binds `{command, cwd}` with `cwd` absolute. A record whose bound
|
|
46
|
+
* material names a path inside a worktree root was written by a session working
|
|
47
|
+
* in that worktree. That is PR #169's checkout-root anchoring, which APRV-151's
|
|
48
|
+
* notes recorded as the stronger answer to the two-checkouts problem and did not
|
|
49
|
+
* have a caller for; it has one now.
|
|
50
|
+
*
|
|
51
|
+
* The branch name is the second key, and a weak one: a branch `aprv-192-…`
|
|
52
|
+
* names task `APRV-192`, and a `task.registered` for that id in the window is
|
|
53
|
+
* attribution. Weak because a branch name is chosen by the party under
|
|
54
|
+
* oversight, so it may only ever ADD attribution (SPEC.md §11.1 invariant 4:
|
|
55
|
+
* a self-reported field may raise scrutiny and never lower it) — which is
|
|
56
|
+
* exactly what it does here, since attribution is what stops an alarm. Stated
|
|
57
|
+
* plainly rather than hidden: a session that names its branch after a task some
|
|
58
|
+
* other session registered escapes arm B. It does not escape arm A, and the
|
|
59
|
+
* cost of the alternative (no branch key at all) is an alarm on every worktree
|
|
60
|
+
* whose session worked entirely outside the payload store's reach.
|
|
61
|
+
*
|
|
62
|
+
* ## Fail closed in the report
|
|
63
|
+
*
|
|
64
|
+
* Uncertainty is never "fine". A log that does not verify, a payload whose
|
|
65
|
+
* bytes will not resolve, a commit git could not date, a worktree whose root
|
|
66
|
+
* cannot be placed: each is its own `undetermined` verdict with its own code,
|
|
67
|
+
* counted separately from the clean ones, and the renderer never folds an
|
|
68
|
+
* undetermined subject into the pass count. What this module does NOT do is
|
|
69
|
+
* escalate on uncertainty, because a detector is not an enforcement path: it
|
|
70
|
+
* reports, a human reads, and nothing here changes what the gate authorizes.
|
|
71
|
+
*
|
|
72
|
+
* ## What keeps the human's own commits quiet (AC4)
|
|
73
|
+
*
|
|
74
|
+
* Three exemptions, narrow and documented, and each of them fails NOISY when it
|
|
75
|
+
* does not apply:
|
|
76
|
+
*
|
|
77
|
+
* 1. A commit that touches only the daemon's own append surface
|
|
78
|
+
* ({@link EXEMPT_PREFIXES}) is a records advance carrying evidence, not a
|
|
79
|
+
* session doing work. Requiring evidence for the evidence is circular.
|
|
80
|
+
* 2. A commit authored by the git-evidence identity is the daemon's own
|
|
81
|
+
* (`daemon/git-evidence.ts`), and the daemon is not a session.
|
|
82
|
+
* 3. Arm B's subject is LINKED WORKTREES ONLY. The agent-session artifact is
|
|
83
|
+
* the worktree; the human commits in the primary checkout, where the policy
|
|
84
|
+
* ceremony and the genesis events are made. The primary is not thereby
|
|
85
|
+
* passed: it stays wholly subject to arm A, so a ceremony commit passes on
|
|
86
|
+
* its attestation and an unevidenced guarded-path commit there is still
|
|
87
|
+
* reported. And the limit is stated on every report as its own coverage
|
|
88
|
+
* line, so an agent session that ran in the primary checkout shows up as a
|
|
89
|
+
* gap in the report rather than as silence.
|
|
90
|
+
*
|
|
91
|
+
* ## Layout
|
|
92
|
+
*
|
|
93
|
+
* The evaluator ({@link evaluateDarkSessions}) is PURE: no IO, no clock, no
|
|
94
|
+
* git, so a fixture is enough to test it and a repository is never required.
|
|
95
|
+
* The observing half below the fold does run git and read the payload store,
|
|
96
|
+
* and it lives here rather than under `daemon/` because `approval doctor`
|
|
97
|
+
* reports the same findings and `src/cli/` may not import `src/daemon/`
|
|
98
|
+
* (APRV-59). The one thing that stays in `daemon/dark-session.ts` is the
|
|
99
|
+
* append, which is the one thing a reader must never do.
|
|
100
|
+
*/
|
|
101
|
+
import type { ProtectedPathEntry } from "./command-class.js";
|
|
102
|
+
import { type Clock } from "./clock.js";
|
|
103
|
+
import type { EventRecord } from "./log.js";
|
|
104
|
+
/**
|
|
105
|
+
* The events a hooked session cannot avoid writing.
|
|
106
|
+
*
|
|
107
|
+
* A registration opens the question, a request puts it to a human, and a start
|
|
108
|
+
* records that something ran. A session that made any gated tool call at all
|
|
109
|
+
* wrote at least one of these; a session that wrote none of them made no gated
|
|
110
|
+
* call the runtime ever saw, which is the definition of dark.
|
|
111
|
+
*/
|
|
112
|
+
export declare const SESSION_EVENTS: readonly string[];
|
|
113
|
+
/**
|
|
114
|
+
* How a subject came out. **Frozen union**, additive-only, in the same sense as
|
|
115
|
+
* every other verdict vocabulary here (SPEC.md §11.1 invariant 6).
|
|
116
|
+
*/
|
|
117
|
+
export declare const DARK_SESSION_VERDICTS: readonly ["hooked", "dark", "exempt", "undetermined"];
|
|
118
|
+
export type DarkSessionVerdict = (typeof DARK_SESSION_VERDICTS)[number];
|
|
119
|
+
/**
|
|
120
|
+
* Why a subject got the verdict it got. **Frozen union**, additive-only.
|
|
121
|
+
*
|
|
122
|
+
* `no-evidence` is spelled exactly as APRV-151 spells it, because it IS
|
|
123
|
+
* APRV-151's finding, arrived at through the same evaluator.
|
|
124
|
+
*/
|
|
125
|
+
export declare const DARK_SESSION_CODES: readonly [
|
|
126
|
+
/** Arm B: git activity in the window, and not one attributable record. */
|
|
127
|
+
"no-records",
|
|
128
|
+
/** Arm A: a guarded path changed and the log carries no evidence for it. */
|
|
129
|
+
"no-evidence",
|
|
130
|
+
/** Exempt: the commits touch only the daemon's own append surface. */
|
|
131
|
+
"evidence-surface",
|
|
132
|
+
/** Exempt: authored by the daemon's own git identity. */
|
|
133
|
+
"daemon-authored",
|
|
134
|
+
/** Exempt from arm B (never from arm A): the primary checkout. */
|
|
135
|
+
"primary-checkout",
|
|
136
|
+
/** Undetermined: the log did not verify, so nothing may be read from it. */
|
|
137
|
+
"log-unverified",
|
|
138
|
+
/** Undetermined: git could not be run, or answered nothing. */
|
|
139
|
+
"git-unavailable",
|
|
140
|
+
/** Undetermined: bound material would not resolve, so records cannot be placed. */
|
|
141
|
+
"payload-unresolvable",
|
|
142
|
+
/** Undetermined: git named no usable date for the activity. */
|
|
143
|
+
"activity-undated"];
|
|
144
|
+
export type DarkSessionCode = (typeof DARK_SESSION_CODES)[number];
|
|
145
|
+
/** One commit the observer saw, as git reported it. */
|
|
146
|
+
export interface ObservedCommit {
|
|
147
|
+
/** The full sha. */
|
|
148
|
+
sha: string;
|
|
149
|
+
/** Author instant, ISO-8601, or `null` when git would not say. */
|
|
150
|
+
ts: string | null;
|
|
151
|
+
/** `Name <email>`, verbatim from git. */
|
|
152
|
+
author: string;
|
|
153
|
+
/** The author's email alone, lowercased, or `""` when git named none. */
|
|
154
|
+
authorEmail: string;
|
|
155
|
+
/** Repository-relative, `/`-separated paths this commit changed. */
|
|
156
|
+
changedPaths: readonly string[];
|
|
157
|
+
/** The branch or worktree this commit was observed on, for the message. */
|
|
158
|
+
ref: string;
|
|
159
|
+
}
|
|
160
|
+
/** One checkout the observer saw: the primary, or a linked worktree. */
|
|
161
|
+
export interface ObservedCheckout {
|
|
162
|
+
/** Absolute, symlink-resolved root. */
|
|
163
|
+
root: string;
|
|
164
|
+
/** How it is named in the report (the worktree directory's base name). */
|
|
165
|
+
name: string;
|
|
166
|
+
/** True for the primary checkout, false for a linked worktree. */
|
|
167
|
+
primary: boolean;
|
|
168
|
+
/** The checked-out branch, or `null` on a detached HEAD. */
|
|
169
|
+
branch: string | null;
|
|
170
|
+
/** Its birth instant, when the observer could stat it; else `null`. */
|
|
171
|
+
born: string | null;
|
|
172
|
+
/** Commits observed on it inside the window. */
|
|
173
|
+
commits: readonly ObservedCommit[];
|
|
174
|
+
}
|
|
175
|
+
/** What the observer gathered, and what it could not. */
|
|
176
|
+
export interface GitActivity {
|
|
177
|
+
checkouts: readonly ObservedCheckout[];
|
|
178
|
+
/**
|
|
179
|
+
* Why git could not be asked, when it could not. A non-null value makes every
|
|
180
|
+
* subject `undetermined` rather than passing them for lack of evidence.
|
|
181
|
+
*/
|
|
182
|
+
unavailable: string | null;
|
|
183
|
+
}
|
|
184
|
+
/** The window the sweep judged, as instants. */
|
|
185
|
+
export interface DarkSessionWindow {
|
|
186
|
+
from: string;
|
|
187
|
+
to: string;
|
|
188
|
+
}
|
|
189
|
+
export interface DarkSessionInput {
|
|
190
|
+
activity: GitActivity;
|
|
191
|
+
/**
|
|
192
|
+
* Records from the log that have passed chain verification, or `null` when it
|
|
193
|
+
* did not verify. `null` makes every subject `undetermined`; nothing here
|
|
194
|
+
* reads an unverified record (SPEC.md §11.1 invariant 1).
|
|
195
|
+
*/
|
|
196
|
+
records: readonly EventRecord[] | null;
|
|
197
|
+
/** Why the log could not be used, when `records` is `null`. */
|
|
198
|
+
logDetail?: string;
|
|
199
|
+
/** `policy.protected_paths`, widening the built-in guarded set. */
|
|
200
|
+
policyProtectedPaths: readonly ProtectedPathEntry[];
|
|
201
|
+
/** The policy file's repository-relative path, e.g. `APPROVAL.md`. */
|
|
202
|
+
policyPath: string;
|
|
203
|
+
/** SHA-256 of the policy bytes now on disk, for the `attested` verdict. */
|
|
204
|
+
policySha256: string | null;
|
|
205
|
+
/** Resolve bound material by hash from the live payload store. */
|
|
206
|
+
payloadFor: (hash: string) => unknown | null;
|
|
207
|
+
/** Author emails whose commits are the daemon's own, lowercased. */
|
|
208
|
+
daemonEmails: readonly string[];
|
|
209
|
+
/** The instants the observer swept between. */
|
|
210
|
+
window: DarkSessionWindow;
|
|
211
|
+
/** Override the recency bound `evaluateProtectedPaths` applies. */
|
|
212
|
+
lookbackMs?: number;
|
|
213
|
+
}
|
|
214
|
+
/** One subject's verdict. A subject is one checkout. */
|
|
215
|
+
export interface DarkSessionFinding {
|
|
216
|
+
/** The checkout's name — the worktree directory, or `primary`. */
|
|
217
|
+
subject: string;
|
|
218
|
+
root: string;
|
|
219
|
+
primary: boolean;
|
|
220
|
+
branch: string | null;
|
|
221
|
+
verdict: DarkSessionVerdict;
|
|
222
|
+
code: DarkSessionCode | null;
|
|
223
|
+
/** Commits observed on this subject in the window. */
|
|
224
|
+
commits: number;
|
|
225
|
+
/** Guarded paths this subject changed in the window. */
|
|
226
|
+
guardedPaths: readonly string[];
|
|
227
|
+
/** Records in the window attributed to this subject. */
|
|
228
|
+
attributed: readonly number[];
|
|
229
|
+
/**
|
|
230
|
+
* The newest sha observed on this subject, or `null` when it produced no
|
|
231
|
+
* commit. Half of the observation key: an alarm is about a state of the
|
|
232
|
+
* world, and the same state must not be recorded twice.
|
|
233
|
+
*/
|
|
234
|
+
newestSha: string | null;
|
|
235
|
+
/** Stable across ticks for one observation; see {@link observationKey}. */
|
|
236
|
+
key: string;
|
|
237
|
+
/** Prose a reader can act on, on every verdict. */
|
|
238
|
+
detail: string;
|
|
239
|
+
}
|
|
240
|
+
export interface DarkSessionReport {
|
|
241
|
+
/** True when no subject came out `dark`. Says nothing about what was seen. */
|
|
242
|
+
ok: boolean;
|
|
243
|
+
/**
|
|
244
|
+
* True when every subject was ESTABLISHED, one way or the other.
|
|
245
|
+
*
|
|
246
|
+
* Kept separate from {@link DarkSessionReport.ok} on purpose. A report with
|
|
247
|
+
* no dark subject and three undetermined ones is not a clean sweep, and a
|
|
248
|
+
* single boolean would have to lie about one of the two facts: either it
|
|
249
|
+
* alarms on uncertainty (and an operator learns to ignore the alarm) or it
|
|
250
|
+
* calls uncertainty fine (and the detector reports a pass it did not earn).
|
|
251
|
+
* Two booleans say both things, and every surface reads the one it means.
|
|
252
|
+
*/
|
|
253
|
+
settled: boolean;
|
|
254
|
+
findings: readonly DarkSessionFinding[];
|
|
255
|
+
window: DarkSessionWindow;
|
|
256
|
+
/**
|
|
257
|
+
* What this sweep could not see, always stated. Arm B covers linked worktrees
|
|
258
|
+
* only, so a session that ran in the primary checkout is outside it, and a
|
|
259
|
+
* report that did not say so would be claiming coverage it does not have.
|
|
260
|
+
*/
|
|
261
|
+
coverage: string;
|
|
262
|
+
}
|
|
263
|
+
/** The observation key: one subject, one state of the world. */
|
|
264
|
+
export declare function observationKey(subject: string, newestSha: string | null, born: string | null): string;
|
|
265
|
+
/** The Backlog.md task id a branch name begins with, upper-cased (`aprv-192-x`). */
|
|
266
|
+
export declare function taskIdFromBranch(branch: string | null): string | null;
|
|
267
|
+
/**
|
|
268
|
+
* Evaluate what git showed against what the log carries. Pure: no IO, no clock.
|
|
269
|
+
*/
|
|
270
|
+
export declare function evaluateDarkSessions(input: DarkSessionInput): DarkSessionReport;
|
|
271
|
+
/** The report as lines an operator reads. Pure. */
|
|
272
|
+
export declare function renderDarkSessionReport(report: DarkSessionReport): string;
|
|
273
|
+
/**
|
|
274
|
+
* Everything below this line does IO, and it lives here rather than in
|
|
275
|
+
* `daemon/` for one reason: `approval doctor` reports the same findings and
|
|
276
|
+
* `src/cli/` may not import `src/daemon/` (APRV-59, `tests/layering.test.ts`).
|
|
277
|
+
* Two observers would be two answers to one question, so there is one, and the
|
|
278
|
+
* daemon's module keeps only the thing a reader must never do — the append.
|
|
279
|
+
*/
|
|
280
|
+
/** How far back a sweep looks, absent an operator saying otherwise. */
|
|
281
|
+
export declare const DEFAULT_DARK_WINDOW_MS: number;
|
|
282
|
+
/** How often the sweep runs, absent an operator saying otherwise. */
|
|
283
|
+
export declare const DEFAULT_DARK_INTERVAL_MS: number;
|
|
284
|
+
/**
|
|
285
|
+
* The git identities whose commits are the runtime's own.
|
|
286
|
+
*
|
|
287
|
+
* Spelled here rather than imported from `daemon/git-evidence.ts`, which is
|
|
288
|
+
* where the daemon's commit identity is defined: core must not depend on the
|
|
289
|
+
* daemon. `tests/dark-session.test.ts` pins the two against each other so they
|
|
290
|
+
* cannot drift apart, the same device `APPROVALD_VERSION` uses for its own
|
|
291
|
+
* duplicate of the package version.
|
|
292
|
+
*/
|
|
293
|
+
export declare const DAEMON_EVIDENCE_EMAILS: readonly string[];
|
|
294
|
+
/** The opt-in, as the daemon carries it. */
|
|
295
|
+
export interface DarkSessionWatch {
|
|
296
|
+
/** How far back each sweep looks. */
|
|
297
|
+
windowMs: number;
|
|
298
|
+
/** How often a sweep runs. The tick interval is the floor. */
|
|
299
|
+
intervalMs: number;
|
|
300
|
+
}
|
|
301
|
+
/** Everything git could tell the sweep about a repository in one window. */
|
|
302
|
+
export declare function observeGitActivity(root: string, from: string, to: string): GitActivity;
|
|
303
|
+
export interface DarkSessionSweepOptions {
|
|
304
|
+
logPath: string;
|
|
305
|
+
/** The checkout to observe. The daemon's own `cwd`; never an agent worktree. */
|
|
306
|
+
root: string;
|
|
307
|
+
/** Policy location, with `loadPolicy`'s semantics. */
|
|
308
|
+
policy: {
|
|
309
|
+
dir?: string;
|
|
310
|
+
file?: string;
|
|
311
|
+
};
|
|
312
|
+
schemaDir?: string;
|
|
313
|
+
/** The write-boundary clock (amended SPEC.md §8). */
|
|
314
|
+
clock?: Clock;
|
|
315
|
+
windowMs: number;
|
|
316
|
+
/** Verified records. The caller has already read them; nothing re-reads. */
|
|
317
|
+
records: readonly EventRecord[] | null;
|
|
318
|
+
logDetail?: string;
|
|
319
|
+
/** Test seam: an observer that answers without running git. */
|
|
320
|
+
observe?: (root: string, from: string, to: string) => GitActivity;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Observe and judge, appending nothing.
|
|
324
|
+
*
|
|
325
|
+
* The read-only half, which is the half `approval doctor` calls: doctor reports
|
|
326
|
+
* and the daemon writes, so two processes never become two writers of one fact.
|
|
327
|
+
*/
|
|
328
|
+
export declare function reportDarkSessions(options: DarkSessionSweepOptions): {
|
|
329
|
+
report: DarkSessionReport;
|
|
330
|
+
window: DarkSessionWindow;
|
|
331
|
+
};
|