@kontourai/flow-agents 3.12.1 → 4.1.0

package/build/src/narrative/intent.d.ts

@@ -0,0 +1,94 @@
+import { type Statement } from "./statements.js";
+/**
+ * Structural mirror of capability-declarations.ts:CapabilityStatus. Declared
+ * locally so this module never imports the capability table (which is outside
+ * the narrative import boundary); a real `CapabilityStatus` is assignable here.
+ */
+export type IntentCapabilityStatus = {
+    readonly status: "supported";
+} | {
+    readonly status: "partial";
+    readonly note: string;
+} | {
+    readonly status: "unsupported";
+    readonly reason: string;
+};
+export type IntentCaptureMode = "agent_stated" | "workflow_derived_purpose";
+export interface CaptureIntentInput {
+    /** Caller-resolved capability status (queryCapability(runtime,"intent_annotation")). */
+    capability: IntentCapabilityStatus;
+    /** Attributed actor for the self-report (required for agent_stated). */
+    actor: string;
+    /** Runtime id, recorded for provenance. */
+    runtimeId: string;
+    /** fa1 source id of the material action being annotated (the citation). */
+    actionRef: string;
+    /** fa1 source id of the active gate/operation — the ONLY input to the fallback derivation. */
+    activeGateRef: string;
+    /** Optional agent-supplied bounded purpose (redactable narrative source). */
+    purpose?: string;
+    /** Optional fa1 source id of the objective, cited by the fallback. */
+    objectiveRef?: string;
+    /** Effective redaction fields; defaults to effectiveNarrativeRedactionFields(). */
+    redactionFields?: readonly string[];
+    turnRef?: number;
+}
+export interface CapturedIntent {
+    mode: IntentCaptureMode;
+    statement: Statement;
+    runtime: string;
+    action_ref: string;
+    /**
+     * The action source's OWN frozen-manifest `captured_at` (R1 temporal co-binding).
+     * Derived from the resolved action entry — NOT a fresh clock read at bind time —
+     * so a forged or late annotation cannot claim at-action timing for an action it
+     * did not co-occur with.
+     */
+    action_captured_at: string;
+    /** Redaction field names that nulled the supplied purpose (empty when none applied). */
+    redactions: string[];
+}
+/**
+ * Dependencies for {@link captureIntent}. `resolveAction` resolves the material
+ * action's fa1 id to its FROZEN MANIFEST ENTRY (existence + the action's own
+ * `capturedAt`) — R1 co-binding. It returns `undefined` for an absent / fabricated
+ * ref (or an unreadable manifest), which captureIntent rejects. Injected so the pure
+ * capture logic stays testable and this module never itself does I/O — the CLI wires
+ * in `(ref) => resolveManifestEntry(narrativeDir, ref)`.
+ */
+export interface CaptureIntentDependencies {
+    resolveAction: (actionRef: string) => {
+        capturedAt: string;
+    } | undefined;
+}
+export declare function captureIntent(input: CaptureIntentInput, deps: CaptureIntentDependencies): CapturedIntent;
+export declare const INTENT_ANNOTATION_FILE = "intent-annotation.json";
+export declare const INTENT_ANNOTATION_SCHEMA_VERSION: "1.0";
+export interface IntentAnnotation {
+    schema_version: typeof INTENT_ANNOTATION_SCHEMA_VERSION;
+    mode: IntentCaptureMode;
+    /**
+     * The material action's OWN frozen-manifest captured_at (R1 temporal co-binding).
+     * Derived from the resolved action entry at capture time — NOT a fresh wall-clock
+     * read at bind time — so a fabricated/late annotation cannot claim at-action
+     * timing for an action it did not co-occur with.
+     */
+    captured_at: string;
+    runtime: string;
+    action_ref: string;
+    statement: Statement;
+    redactions: string[];
+}
+/**
+ * Freeze a captured annotation into a write-once channel (R1/AC3). Uses the same
+ * create-only link(2)/EEXIST discipline as snapshot.ts:createOnlyWriteManifest:
+ * a second/late write to an already-frozen channel throws (EEXIST), so a
+ * post-hoc-reconstructed rationale can never overwrite or masquerade as the
+ * at-action annotation. `captured_at` is carried from the resolved action entry
+ * (see {@link captureIntent}), co-binding the annotation to the real action
+ * capture rather than to bind-time wall-clock.
+ */
+export declare function bindIntentAnnotation(channelDir: string, captured: CapturedIntent): {
+    path: string;
+    annotation: IntentAnnotation;
+};

package/build/src/narrative/intent.js

@@ -0,0 +1,132 @@
+/**
+ * #622: bounded, capability-declared, at-action stated-intent capture.
+ *
+ * `captureIntent` is PURE (no I/O). It takes a caller-resolved capability status
+ * (the CLI resolves it via queryCapability(runtime, "intent_annotation") — this
+ * module deliberately does NOT import the capability table so it stays inside the
+ * #619 narrative import boundary) and an OPTIONAL agent-supplied bounded purpose:
+ *
+ *   - supported + a purpose that survives the policy filter -> an `agent_stated`
+ *     statement (typed self-report, never proof).
+ *   - otherwise -> a deterministic `workflow_derived_purpose` statement derived
+ *     ONLY from the active gate reference. The else-branch is STRUCTURALLY
+ *     incapable of emitting `agent_stated` (R4: no fabricated rationale).
+ *
+ * `bindIntentAnnotation` freezes the captured annotation into a write-once
+ * channel (link(2)/EEXIST, mirroring snapshot.ts:createOnlyWriteManifest). A
+ * post-hoc / second write to an already-frozen channel fails EEXIST and is
+ * structurally rejected (R1/AC3): there is no mutable, late-writable side
+ * channel for reconstructed rationale.
+ *
+ * Imports are restricted to node builtins, ./-relative narrative files, and the
+ * shared ../lib/fs.js helper (the #619 arch-isolation test enforces this).
+ *
+ * @module
+ */
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { atomicWriteFile } from "../lib/fs.js";
+import { effectiveNarrativeRedactionFields, filterNarrativeRecord } from "./policy-filter.js";
+import { agentStatedIntent, workflowDerivedPurpose } from "./statements.js";
+/**
+ * Route the agent-supplied purpose through the policy-filtered view (D5/R7). A
+ * redacted `purpose` field is nulled BEFORE emission — a nulled purpose never
+ * reaches an agent_stated statement (capture falls back to workflow_derived).
+ * A policy that is unresolvable/invalid fails closed (treated as redacted).
+ */
+function filterPurpose(purpose, redactionFields) {
+    const filtered = filterNarrativeRecord({ purpose }, redactionFields);
+    if (filtered.kind !== "filtered")
+        return { redactions: filtered.fields };
+    const value = filtered.record.purpose;
+    // #622 (review LOW): the record handed to filterNarrativeRecord is the FLAT
+    // single-key shape `{ purpose }`, so an actual purpose redaction is reported as
+    // exactly the field `"purpose"`. Matching `.endsWith(".purpose")` would let an
+    // unrelated `foo.purpose`-style redaction masquerade as a purpose redaction; only
+    // the exact flat key is a real purpose redaction for this record.
+    const redactions = filtered.redactions.filter((field) => field === "purpose");
+    return typeof value === "string" && value.length > 0 ? { purpose: value, redactions } : { redactions };
+}
+export function captureIntent(input, deps) {
+    // R1 (review HIGH): the annotation MUST cite a material action that actually
+    // exists in the FROZEN narrative manifest. Resolve the action ref to its frozen
+    // manifest entry; a fabricated / nonexistent action (absent from the manifest, or
+    // an unreadable manifest) is rejected outright — you cannot annotate an action
+    // that is not in the frozen manifest.
+    const actionEntry = deps.resolveAction(input.actionRef);
+    if (actionEntry === undefined) {
+        throw new Error(`intent capture requires a resolvable frozen action source: ${input.actionRef} is not present in the frozen narrative manifest`);
+    }
+    // Co-bind timing to the action's OWN frozen captured_at (not a fresh clock),
+    // so a forged/late annotation cannot claim at-action timing.
+    const actionCapturedAt = actionEntry.capturedAt;
+    const redactionFields = input.redactionFields ?? effectiveNarrativeRedactionFields();
+    const { purpose, redactions } = typeof input.purpose === "string" && input.purpose.length > 0
+        ? filterPurpose(input.purpose, redactionFields)
+        : { purpose: undefined, redactions: [] };
+    if (input.capability.status === "supported" && purpose !== undefined) {
+        return {
+            mode: "agent_stated",
+            statement: agentStatedIntent({
+                sourceId: input.actionRef,
+                purpose,
+                actor: input.actor,
+                ...(input.turnRef !== undefined ? { turnRef: input.turnRef } : {}),
+            }),
+            runtime: input.runtimeId,
+            action_ref: input.actionRef,
+            action_captured_at: actionCapturedAt,
+            redactions,
+        };
+    }
+    // Structural guarantee (R4): the fallback branch can NEVER emit agent_stated —
+    // it only ever constructs a deterministic_derived workflow_derived_purpose.
+    return {
+        mode: "workflow_derived_purpose",
+        statement: workflowDerivedPurpose({
+            activeGateRef: input.activeGateRef,
+            ...(input.objectiveRef ? { objectiveRef: input.objectiveRef } : {}),
+        }),
+        runtime: input.runtimeId,
+        action_ref: input.actionRef,
+        action_captured_at: actionCapturedAt,
+        redactions,
+    };
+}
+export const INTENT_ANNOTATION_FILE = "intent-annotation.json";
+export const INTENT_ANNOTATION_SCHEMA_VERSION = "1.0";
+/**
+ * Freeze a captured annotation into a write-once channel (R1/AC3). Uses the same
+ * create-only link(2)/EEXIST discipline as snapshot.ts:createOnlyWriteManifest:
+ * a second/late write to an already-frozen channel throws (EEXIST), so a
+ * post-hoc-reconstructed rationale can never overwrite or masquerade as the
+ * at-action annotation. `captured_at` is carried from the resolved action entry
+ * (see {@link captureIntent}), co-binding the annotation to the real action
+ * capture rather than to bind-time wall-clock.
+ */
+export function bindIntentAnnotation(channelDir, captured) {
+    const annotation = {
+        schema_version: INTENT_ANNOTATION_SCHEMA_VERSION,
+        mode: captured.mode,
+        captured_at: captured.action_captured_at,
+        runtime: captured.runtime,
+        action_ref: captured.action_ref,
+        statement: captured.statement,
+        redactions: captured.redactions,
+    };
+    const file = path.join(channelDir, INTENT_ANNOTATION_FILE);
+    const temp = path.join(channelDir, `.intent-annotation.${process.pid}.${Date.now().toString(36)}.tmp`);
+    atomicWriteFile(channelDir, temp, Buffer.from(`${JSON.stringify(annotation, null, 2)}\n`));
+    try {
+        fs.linkSync(temp, file);
+    }
+    catch (error) {
+        if (error.code === "EEXIST")
+            throw new Error("intent annotation channel already frozen");
+        throw error;
+    }
+    finally {
+        fs.rmSync(temp, { force: true });
+    }
+    return { path: file, annotation };
+}

package/build/src/narrative/policy-filter.d.ts

@@ -0,0 +1,15 @@
+/** Mirrors scripts/telemetry/lib/config.sh TELEMETRY_CHANNEL_FULL_REDACT. */
+export declare const TELEMETRY_CHANNEL_FULL_REDACT_DEFAULT: readonly ["hook.raw_input", "turn.prompt_text", "tool.input", "tool.output"];
+/** Mirrors scripts/telemetry/lib/config.sh TELEMETRY_CHANNEL_ANALYTICS_REDACT. */
+export declare const TELEMETRY_CHANNEL_ANALYTICS_REDACT_DEFAULT: readonly ["tool.input", "tool.output", "turn.prompt_text", "delegation.targets.query", "context.cwd", "hook.raw_input", "hook.last_assistant_message", "hook.transcript_path"];
+export type NarrativePolicyFilterResult = {
+    kind: "filtered";
+    record: Record<string, unknown>;
+    redactions: string[];
+} | {
+    kind: "redacted";
+    fields: string[];
+    diagnostic: string;
+};
+export declare function effectiveNarrativeRedactionFields(narrativeFields?: readonly string[]): string[];
+export declare function filterNarrativeRecord(input: unknown, effectiveFields: readonly string[] | null | undefined): NarrativePolicyFilterResult;

package/build/src/narrative/policy-filter.js

@@ -0,0 +1,58 @@
+/** Mirrors scripts/telemetry/lib/config.sh TELEMETRY_CHANNEL_FULL_REDACT. */
+export const TELEMETRY_CHANNEL_FULL_REDACT_DEFAULT = ["hook.raw_input", "turn.prompt_text", "tool.input", "tool.output"];
+/** Mirrors scripts/telemetry/lib/config.sh TELEMETRY_CHANNEL_ANALYTICS_REDACT. */
+export const TELEMETRY_CHANNEL_ANALYTICS_REDACT_DEFAULT = [
+    "tool.input", "tool.output", "turn.prompt_text", "delegation.targets.query",
+    "context.cwd", "hook.raw_input", "hook.last_assistant_message", "hook.transcript_path",
+];
+function uniqueFields(fields) {
+    return [...new Set(fields.map((field) => field.trim()).filter(Boolean))];
+}
+export function effectiveNarrativeRedactionFields(narrativeFields = []) {
+    return uniqueFields([...TELEMETRY_CHANNEL_FULL_REDACT_DEFAULT, ...narrativeFields]);
+}
+function failure(fields, diagnostic) {
+    return { kind: "redacted", fields: uniqueFields(fields), diagnostic };
+}
+export function filterNarrativeRecord(input, effectiveFields) {
+    if (!Array.isArray(effectiveFields))
+        return failure([], "redaction policy is unresolvable");
+    const fields = uniqueFields(effectiveFields);
+    if (fields.some((field) => !field.split(".").every((part) => part.length > 0 && part !== "__proto__" && part !== "prototype" && part !== "constructor"))) {
+        return failure(fields, `redaction policy contains an invalid field name: ${fields.join(", ")}`);
+    }
+    let parsed;
+    try {
+        parsed = typeof input === "string" || Buffer.isBuffer(input) ? JSON.parse(input.toString()) : structuredClone(input);
+    }
+    catch {
+        return failure(fields, `record could not be parsed under fields: ${fields.join(", ")}`);
+    }
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed))
+        return failure(fields, `record is not an object under fields: ${fields.join(", ")}`);
+    const record = parsed;
+    try {
+        for (const field of fields) {
+            const parts = field.split(".");
+            let cursor = record;
+            for (const part of parts.slice(0, -1)) {
+                const next = cursor[part];
+                if (next === undefined || next === null) {
+                    cursor[part] = {};
+                    cursor = cursor[part];
+                }
+                else if (typeof next === "object" && !Array.isArray(next)) {
+                    cursor = next;
+                }
+                else {
+                    throw new Error(field);
+                }
+            }
+            cursor[parts.at(-1)] = null;
+        }
+    }
+    catch {
+        return failure(fields, `field nulling failed for fields: ${fields.join(", ")}`);
+    }
+    return { kind: "filtered", record, redactions: fields };
+}

package/build/src/narrative/projection.d.ts

@@ -0,0 +1,58 @@
+import type { CaptureCompleteness } from "./integrity.js";
+import { type Statement } from "./statements.js";
+import { type TurnBoundary } from "./turn-spine.js";
+export declare const NARRATIVE_RUNTIME_PROJECTION_SCHEMA_VERSION: "grounded-runtime-projection/v1";
+export declare const NARRATIVE_RUNTIME_PROJECTOR: {
+    readonly name: "flow-agents-runtime-projector";
+    readonly version: "1.0.0";
+};
+export type NarrativeProjectionErrorCode = "manifest_invalid" | "malformed_snapshot" | "coverage_gap";
+export declare class NarrativeProjectionError extends Error {
+    readonly code: NarrativeProjectionErrorCode;
+    readonly sourceId?: string | undefined;
+    readonly name = "NarrativeProjectionError";
+    constructor(code: NarrativeProjectionErrorCode, message: string, sourceId?: string | undefined);
+}
+export interface RuntimePurpose {
+    step: string;
+    gate: string;
+}
+export interface RuntimeProjectionTurn {
+    ordinal: number;
+    sessionId: string;
+    turnId?: string;
+    boundary: TurnBoundary;
+    purpose?: RuntimePurpose;
+    known_gap_refs: string[];
+    statements: Statement[];
+}
+export interface NarrativeRuntimeProjection {
+    schema_version: typeof NARRATIVE_RUNTIME_PROJECTION_SCHEMA_VERSION;
+    narrative_id: string;
+    provenance: {
+        projector: typeof NARRATIVE_RUNTIME_PROJECTOR;
+        projected_at: string;
+        manifest_sha256: string;
+    };
+    capture_completeness: CaptureCompleteness;
+    turns: RuntimeProjectionTurn[];
+    document_statements: Statement[];
+    coverage: {
+        sources: number;
+        cited: number;
+        unavailable: number;
+    };
+}
+export interface ProjectRuntimeNarrativeOptions {
+    projectedAt: string;
+}
+type SchemaIssue = {
+    path: string;
+    message: string;
+};
+export declare function validateNarrativeRuntimeProjection(value: unknown): SchemaIssue[];
+/** JSON with lexicographically sorted object keys; array order is preserved. */
+export declare function stableStringify(value: unknown): string;
+/** Compile only from the frozen narrative manifest and its snapshot blobs. */
+export declare function projectRuntimeNarrative(narrativeDir: string, opts: ProjectRuntimeNarrativeOptions): NarrativeRuntimeProjection;
+export {};