@avocadostudio-ai/orchestrator-core 0.3.2 → 0.3.3

package/dist/checks/types.d.ts

@@ -0,0 +1,65 @@
+import type { BlockManifest, FieldKind, Operation, PageDoc, SiteConfig } from "@avocadostudio-ai/shared";
+import type { FindingEvidence, FindingSeverity } from "../durable/types.ts";
+/** One field on one block, located by the manifest rather than by block type. */
+export type FieldEntry = {
+    blockId: string;
+    blockType: string;
+    /** Editable-path form: `title`, `cards[0].imageAlt`. */
+    path: string;
+    kind: FieldKind;
+    label?: string;
+    /**
+     * What a reader would call the block this field belongs to — its own heading,
+     * not the block type. A page with three Card Grids produces three findings
+     * reading `cards[0].imageAlt`, and the type name distinguishes none of them.
+     */
+    blockLabel?: string;
+    value: unknown;
+    /**
+     * The container this field sits in — `""` for a top-level prop, `cards[0]`
+     * for a list item. Pairing an image with its alt text is a question about
+     * siblings, and the container is what makes "sibling" meaningful.
+     */
+    container: string;
+};
+/** The other pages, for the rules that cannot be answered from one page. */
+export type SiteView = {
+    slugs: string[];
+    pages: Array<Pick<PageDoc, "slug" | "title"> & {
+        meta?: PageDoc["meta"];
+    }>;
+    config: SiteConfig;
+};
+export type CheckContext = {
+    scopeKey: string;
+    page: PageDoc;
+    site: SiteView;
+    manifest: BlockManifest;
+    /** Every field on the page, already flattened. Rules should not re-walk. */
+    fields: FieldEntry[];
+};
+/**
+ * What a rule returns.
+ *
+ * Deliberately *not* a `FindingInput`: the fingerprint is computed by the
+ * runner from `(scopeKey, slug, ruleId, key)`, so a rule cannot accidentally
+ * fold the offending value into it. That mistake is invisible until the day
+ * somebody half-fixes a title and gets a second finding instead of an updated
+ * one, and the dismissal they made last week stops applying.
+ */
+export type RuleFinding = {
+    /** Distinguishes several findings from one rule on one page. Stable, not a value. */
+    key?: string;
+    severity?: FindingSeverity;
+    title: string;
+    detail?: string;
+    evidence?: FindingEvidence;
+    proposedOps?: Operation[];
+};
+export type CheckRule = {
+    id: string;
+    agent: string;
+    /** Used when a finding does not override it. */
+    severity: FindingSeverity;
+    run(ctx: CheckContext): RuleFinding[];
+};

package/dist/checks/types.js

@@ -0,0 +1 @@
+export {};

package/dist/durable/durable-store-singleton.d.ts

@@ -0,0 +1,37 @@
+import type { DurableStore } from "./types.ts";
+export declare function getDurableStore(): DurableStore;
+/**
+ * Whether findings, memory and proposals are reaching disk, and why not.
+ *
+ * Deliberately separate from `persistenceHealth()`, which answers the same
+ * question about page state and whose warning text is about losing edits.
+ */
+export declare function durableHealth(): {
+    ok: boolean;
+    reason: string | null;
+};
+/**
+ * Record a durable-store write failure. Separate from the page-state channel:
+ * a proposal row that did not save must not tell the user their edits are gone.
+ */
+export declare function noteDurableFailure(reason: string): void;
+/**
+ * True when findings, memory and proposals are living in memory only. Callers
+ * that are about to promise durability — a scheduled run leaving a plan for the
+ * morning — should say so rather than assume.
+ */
+export declare function durableStoreIsEphemeral(): boolean;
+/** Drop the singleton. Tests and graceful shutdown; `getStore()` owns closing. */
+export declare function resetDurableStore(): void;
+/** Swap in a store — for tests, and for a host that brings its own backend. */
+export declare function setDurableStore(next: DurableStore | null, ephemeral?: boolean): void;
+export declare function isDiscardInFlight(scopeKey: string): boolean;
+/**
+ * Discard any pending proposal for a session being deleted.
+ *
+ * Without this, deleting a session leaves a `pending` row behind, and the next
+ * session with that id would rehydrate a plan the user had already thrown away.
+ */
+export declare function discardPendingProposalsForSession(scopeKey: string): void;
+/** Sweep proposals past their TTL, alongside the ephemeral-map eviction pass. */
+export declare function sweepExpiredProposals(): void;

package/dist/durable/durable-store-singleton.js

@@ -0,0 +1,179 @@
+import { getStore } from "../state/sqlite-store-singleton.js";
+import { SqliteDurableStore } from "./sqlite-durable-store.js";
+import { InMemoryDurableStore } from "./in-memory-durable-store.js";
+/*
+ * Singleton access to the durable store, mirroring `getStore()` next door.
+ *
+ * The one interesting decision here is what to do when SQLite is unavailable.
+ * `getStore()` throws: the driver could not load, and there is no page state
+ * without it. This one falls back to `InMemoryDurableStore` instead, for the
+ * same reason `createOrchestrator()` already keeps serving edits in that
+ * situation — a findings panel that 500s because a native module is missing is
+ * worse than one that works and says it is not saving anything.
+ *
+ * The failure is recorded here rather than through `notePersistenceFailure`.
+ * That channel is about *page state*: its warning tells the user "this edit was
+ * applied in memory but could not be saved", and every mutation response starts
+ * carrying `persisted: false`. Reporting a failed *proposal* row through it
+ * would tell somebody their content edits are being lost when they are not —
+ * a worse lie than the one the channel exists to prevent.
+ *
+ * Findings and proposals are capable of exactly the same lie on their own
+ * account, and an overnight run is precisely when nobody is watching the log,
+ * so they get their own flag with its own wording.
+ */
+let store = null;
+let usingFallback = false;
+let overridden = false;
+let failureReason = null;
+let lastAttemptAt = 0;
+/** How long to stay on the fallback before re-trying SQLite. */
+const RETRY_COOLDOWN_MS = 30_000;
+/*
+ * The connection `store` was built against.
+ *
+ * `resetStore()` next door closes the database and drops its singleton, and the
+ * next `getStore()` opens a fresh one — which used to leave this module holding
+ * prepared statements on a closed handle. Rather than have `resetStore()` call
+ * in here (a cycle: this module imports that one), we notice: a different `db`
+ * object means a different database, and the store is rebuilt against it.
+ */
+let boundDb = null;
+export function getDurableStore() {
+    // An explicitly-set store is sticky; the fallback is not.
+    if (store && overridden)
+        return store;
+    /*
+     * The fallback must not be permanent. `getStore()` next door leaves its own
+     * singleton null on a constructor throw and retries on the next call, so page
+     * state recovers from a transient failure — a `.data` directory not yet
+     * writable at boot, say — while this store, if it latched, would stay
+     * memory-only for the life of the process with no way back.
+     *
+     * Retrying on a cooldown rather than every call keeps a genuinely broken
+     * install from paying for a constructor on every finding. Whatever the
+     * fallback accumulated is lost on a successful retry; it was never durable,
+     * and saying so is the honest trade.
+     */
+    if (store && usingFallback && Date.now() - lastAttemptAt < RETRY_COOLDOWN_MS)
+        return store;
+    try {
+        lastAttemptAt = Date.now();
+        // Share `SqliteStore`'s connection: one WAL, one backup, one VACUUM INTO.
+        const db = getStore().db;
+        if (!store || usingFallback || boundDb !== db) {
+            store = new SqliteDurableStore(db);
+            boundDb = db;
+            usingFallback = false;
+            failureReason = null;
+        }
+    }
+    catch (err) {
+        failureReason = err instanceof Error ? err.message : String(err);
+        if (!store || !usingFallback) {
+            store = new InMemoryDurableStore();
+            boundDb = null;
+            usingFallback = true;
+        }
+    }
+    return store;
+}
+/**
+ * Whether findings, memory and proposals are reaching disk, and why not.
+ *
+ * Deliberately separate from `persistenceHealth()`, which answers the same
+ * question about page state and whose warning text is about losing edits.
+ */
+export function durableHealth() {
+    return { ok: !usingFallback, reason: usingFallback ? failureReason : null };
+}
+/**
+ * Record a durable-store write failure. Separate from the page-state channel:
+ * a proposal row that did not save must not tell the user their edits are gone.
+ */
+export function noteDurableFailure(reason) {
+    failureReason ??= reason;
+}
+/**
+ * True when findings, memory and proposals are living in memory only. Callers
+ * that are about to promise durability — a scheduled run leaving a plan for the
+ * morning — should say so rather than assume.
+ */
+export function durableStoreIsEphemeral() {
+    if (!store)
+        getDurableStore();
+    return usingFallback;
+}
+/** Drop the singleton. Tests and graceful shutdown; `getStore()` owns closing. */
+export function resetDurableStore() {
+    store = null;
+    usingFallback = false;
+    overridden = false;
+    boundDb = null;
+    failureReason = null;
+    lastAttemptAt = 0;
+}
+/** Swap in a store — for tests, and for a host that brings its own backend. */
+export function setDurableStore(next, ephemeral = false) {
+    store = next;
+    usingFallback = next ? ephemeral : false;
+    overridden = next !== null;
+    boundDb = null;
+}
+/*
+ * The two lifecycle hooks `session-state.ts` needs, living here rather than in
+ * `pending-plan-store.ts` so that session-state can call them without importing
+ * a module that imports session-state back. The cycle would probably work —
+ * neither side touches the other at module scope — but this repo has already
+ * been bitten by ESM evaluation order once, and a cleanup call is not worth
+ * finding out a second time.
+ *
+ * Both are fire-and-forget: they are called from synchronous state mutators
+ * whose signatures a durability concern has no business changing, and neither
+ * result affects what the caller returns.
+ */
+/**
+ * Sessions whose pending rows are being discarded right now.
+ *
+ * The set is added to *synchronously*, before the async discard starts, and the
+ * rehydration path consults it. `forgetSession` is a synchronous mutator, so
+ * without this a caller that forgets a session and immediately opens a new chat
+ * on the same id — ids are caller-supplied and routinely reused — races the
+ * discard and reads back the plan the delete was meant to remove.
+ *
+ * It lives here rather than in `pending-plan-store.ts` for the same reason the
+ * hooks below do: session-state must be able to reach it without importing a
+ * module that imports session-state back.
+ */
+const discardInFlight = new Set();
+export function isDiscardInFlight(scopeKey) {
+    return discardInFlight.has(scopeKey);
+}
+/**
+ * Discard any pending proposal for a session being deleted.
+ *
+ * Without this, deleting a session leaves a `pending` row behind, and the next
+ * session with that id would rehydrate a plan the user had already thrown away.
+ */
+export function discardPendingProposalsForSession(scopeKey) {
+    discardInFlight.add(scopeKey);
+    void (async () => {
+        const active = getDurableStore();
+        const rows = await active.listProposals({ scopeKey, status: "pending" });
+        for (const row of rows)
+            await active.setProposalStatus(row.id, "discarded");
+    })()
+        .catch(() => {
+        /* best-effort: an orphan row is inert until something reads it, and the
+           read path re-checks expiry and payload validity anyway. */
+    })
+        .finally(() => discardInFlight.delete(scopeKey));
+}
+/** Sweep proposals past their TTL, alongside the ephemeral-map eviction pass. */
+export function sweepExpiredProposals() {
+    void getDurableStore()
+        .expireProposals()
+        .catch(() => {
+        /* best-effort */
+    });
+}

package/dist/durable/finding-impact.d.ts

@@ -0,0 +1,30 @@
+import type { FindingSeverity } from "./types.ts";
+/**
+ * What a severity is worth before the page is taken into account.
+ *
+ * Not linear, and deliberately: `info` is defined in `rules-draft.ts` as "worth
+ * a look, and safe to ignore forever", so an info finding on the home page
+ * should sit below a warning on a secondary page, and 0.3 × 1.0 < 0.6 × 0.55
+ * is what makes that true.
+ */
+export declare const SEVERITY_WEIGHT: Record<FindingSeverity, number>;
+/**
+ * The weight given to a page nothing has scored — a row written by a build
+ * before impact existed, or by a caller that supplied no weights.
+ *
+ * Mid-scale rather than 1, so old rows interleave with scored ones instead of
+ * sorting above every finding on the site until the next run corrects them.
+ */
+export declare const NEUTRAL_PAGE_WEIGHT = 0.5;
+/** Severity × page weight, rounded to something a human can read in a log. */
+export declare function impactFor(severity: FindingSeverity, pageWeight: number): number;
+/** What an unscored finding is worth. Must match `IMPACT_FALLBACK_SQL`. */
+export declare function fallbackImpact(severity: FindingSeverity): number;
+/**
+ * The same fallback, for SQLite's ORDER BY.
+ *
+ * Generated from the constants above rather than written out, because the one
+ * failure mode here is the two drifting apart — the list would then be sorted
+ * by one rule and explained by another, and nothing would look wrong.
+ */
+export declare const IMPACT_FALLBACK_SQL: string;

package/dist/durable/finding-impact.js

@@ -0,0 +1,53 @@
+/*
+ * Impact — severity times how much the page matters.
+ *
+ * It lives beside the types rather than in `checks/` because both stores need
+ * it: a finding written before this shipped has no `impact` column, and the
+ * ORDER BY has to put it somewhere defensible rather than at one end.
+ *
+ * The two axes stay separate on the record. Severity is a claim about the
+ * problem and belongs to the rule; impact is a claim about the page and is
+ * recomputed by every run, because the link graph moves. Multiplying them into
+ * one stored number instead would make a finding's severity unrecoverable, and
+ * severity is what the icon in the panel means.
+ */
+/**
+ * What a severity is worth before the page is taken into account.
+ *
+ * Not linear, and deliberately: `info` is defined in `rules-draft.ts` as "worth
+ * a look, and safe to ignore forever", so an info finding on the home page
+ * should sit below a warning on a secondary page, and 0.3 × 1.0 < 0.6 × 0.55
+ * is what makes that true.
+ */
+export const SEVERITY_WEIGHT = {
+    error: 1,
+    warning: 0.6,
+    info: 0.3
+};
+/**
+ * The weight given to a page nothing has scored — a row written by a build
+ * before impact existed, or by a caller that supplied no weights.
+ *
+ * Mid-scale rather than 1, so old rows interleave with scored ones instead of
+ * sorting above every finding on the site until the next run corrects them.
+ */
+export const NEUTRAL_PAGE_WEIGHT = 0.5;
+/** Severity × page weight, rounded to something a human can read in a log. */
+export function impactFor(severity, pageWeight) {
+    const clamped = Math.max(0, Math.min(pageWeight, 1));
+    return Math.round(SEVERITY_WEIGHT[severity] * clamped * 1000) / 1000;
+}
+/** What an unscored finding is worth. Must match `IMPACT_FALLBACK_SQL`. */
+export function fallbackImpact(severity) {
+    return impactFor(severity, NEUTRAL_PAGE_WEIGHT);
+}
+/**
+ * The same fallback, for SQLite's ORDER BY.
+ *
+ * Generated from the constants above rather than written out, because the one
+ * failure mode here is the two drifting apart — the list would then be sorted
+ * by one rule and explained by another, and nothing would look wrong.
+ */
+export const IMPACT_FALLBACK_SQL = `COALESCE(impact, CASE severity ${Object.keys(SEVERITY_WEIGHT)
+    .map((severity) => `WHEN '${severity}' THEN ${fallbackImpact(severity)}`)
+    .join(" ")} END)`;

package/dist/durable/in-memory-durable-store.d.ts

@@ -0,0 +1,203 @@
+import type { CheckRunInput, CheckRunPatch, CorrectionInput, CorrectionQuery, DurableStore, FindingInput, FindingQuery, FindingSeverity, FindingStatus, MemoryInput, MemoryQuery, MemoryStatus, ProposalInput, ProposalQuery, ProposalStatus } from "./types.ts";
+export type InMemoryDurableStoreOptions = {
+    now?: () => number;
+};
+export declare class InMemoryDurableStore implements DurableStore {
+    private readonly findings;
+    /** (scopeKey, fingerprint) → finding id. Mirrors the SQLite unique index. */
+    private readonly byFingerprint;
+    private readonly runs;
+    private readonly memory;
+    private readonly corrections;
+    private readonly proposals;
+    private readonly now;
+    constructor(options?: InMemoryDurableStoreOptions);
+    /** Keep the newest `cap` rows per scope, matching the SQLite store's trim. */
+    private trim;
+    recordFindings(runId: string, findings: FindingInput[]): Promise<{
+        opened: number;
+        updated: number;
+    }>;
+    reconcileFindings(args: {
+        runId: string;
+        scopeKey: string;
+        slugs: string[];
+        agent?: string;
+        at?: number;
+    }): Promise<{
+        closed: number;
+    }>;
+    listFindings(query: FindingQuery): Promise<{
+        fingerprint: string;
+        scopeKey: string;
+        slug: string;
+        ruleId: string;
+        agent: string;
+        severity: FindingSeverity;
+        impact: number;
+        title: string;
+        detail?: string;
+        evidence?: import("./types.ts").FindingEvidence;
+        proposedOps?: import("@avocadostudio-ai/shared").Operation[];
+        id: string;
+        status: FindingStatus;
+        lastRunId: string;
+        firstSeenAt: number;
+        lastSeenAt: number;
+        resolvedAt?: number;
+        snoozedUntil?: number;
+    }[]>;
+    getFinding(id: string): Promise<{
+        fingerprint: string;
+        scopeKey: string;
+        slug: string;
+        ruleId: string;
+        agent: string;
+        severity: FindingSeverity;
+        impact: number;
+        title: string;
+        detail?: string;
+        evidence?: import("./types.ts").FindingEvidence;
+        proposedOps?: import("@avocadostudio-ai/shared").Operation[];
+        id: string;
+        status: FindingStatus;
+        lastRunId: string;
+        firstSeenAt: number;
+        lastSeenAt: number;
+        resolvedAt?: number;
+        snoozedUntil?: number;
+    } | null>;
+    setFindingStatus(id: string, status: FindingStatus, at?: number): Promise<void>;
+    wakeSnoozedFindings(scopeKey: string, now?: number): Promise<{
+        woken: number;
+    }>;
+    startCheckRun(run: CheckRunInput): Promise<{
+        id: string;
+        scopeKey: string;
+        agent: string;
+        trigger: import("./types.ts").CheckRunTrigger;
+        startedAt: number;
+        finishedAt?: number;
+        pagesScanned: number;
+        findingsOpened: number;
+        findingsClosed: number;
+        costUsd: number;
+        error?: string;
+    }>;
+    finishCheckRun(id: string, patch: CheckRunPatch): Promise<void>;
+    listCheckRuns(scopeKey: string, limit?: number): Promise<{
+        id: string;
+        scopeKey: string;
+        agent: string;
+        trigger: import("./types.ts").CheckRunTrigger;
+        startedAt: number;
+        finishedAt?: number;
+        pagesScanned: number;
+        findingsOpened: number;
+        findingsClosed: number;
+        costUsd: number;
+        error?: string;
+    }[]>;
+    putMemory(input: MemoryInput, at?: number): Promise<{
+        confidence: number;
+        scope: import("./types.ts").MemoryScope;
+        scopeKey: string;
+        kind: import("./types.ts").MemoryKind;
+        key: string;
+        value: string;
+        source: import("./types.ts").MemorySource;
+        sourceRef?: string;
+        id: string;
+        status: MemoryStatus;
+        supersedesId?: string;
+        createdAt: number;
+        lastUsedAt?: number;
+        useCount: number;
+    }>;
+    listMemory(query?: MemoryQuery): Promise<{
+        confidence: number;
+        scope: import("./types.ts").MemoryScope;
+        scopeKey: string;
+        kind: import("./types.ts").MemoryKind;
+        key: string;
+        value: string;
+        source: import("./types.ts").MemorySource;
+        sourceRef?: string;
+        id: string;
+        status: MemoryStatus;
+        supersedesId?: string;
+        createdAt: number;
+        lastUsedAt?: number;
+        useCount: number;
+    }[]>;
+    touchMemory(ids: string[], at?: number): Promise<void>;
+    setMemoryStatus(id: string, status: MemoryStatus): Promise<void>;
+    recordCorrection(input: CorrectionInput, at?: number): Promise<{
+        traceId: string;
+        scopeKey: string;
+        slug?: string;
+        request: string;
+        proposed: import("@avocadostudio-ai/shared").Operation[];
+        outcome: import("./types.ts").CorrectionOutcome;
+        applied?: import("@avocadostudio-ai/shared").Operation[];
+        id: string;
+        at: number;
+    }>;
+    listCorrections(query?: CorrectionQuery): Promise<{
+        traceId: string;
+        scopeKey: string;
+        slug?: string;
+        request: string;
+        proposed: import("@avocadostudio-ai/shared").Operation[];
+        outcome: import("./types.ts").CorrectionOutcome;
+        applied?: import("@avocadostudio-ai/shared").Operation[];
+        id: string;
+        at: number;
+    }[]>;
+    putProposal(input: ProposalInput): Promise<{
+        id: string;
+        scopeKey: string;
+        origin: string;
+        summary: string;
+        ops: import("@avocadostudio-ai/shared").Operation[];
+        slugs: string[];
+        findingId?: string;
+        payload?: Record<string, unknown>;
+        createdAt: number;
+        expiresAt?: number;
+        status: ProposalStatus;
+        resolvedAt?: number;
+    }>;
+    getProposal(id: string): Promise<{
+        id: string;
+        scopeKey: string;
+        origin: string;
+        summary: string;
+        ops: import("@avocadostudio-ai/shared").Operation[];
+        slugs: string[];
+        findingId?: string;
+        payload?: Record<string, unknown>;
+        createdAt: number;
+        expiresAt?: number;
+        status: ProposalStatus;
+        resolvedAt?: number;
+    } | null>;
+    listProposals(query: ProposalQuery): Promise<{
+        id: string;
+        scopeKey: string;
+        origin: string;
+        summary: string;
+        ops: import("@avocadostudio-ai/shared").Operation[];
+        slugs: string[];
+        findingId?: string;
+        payload?: Record<string, unknown>;
+        createdAt: number;
+        expiresAt?: number;
+        status: ProposalStatus;
+        resolvedAt?: number;
+    }[]>;
+    setProposalStatus(id: string, status: ProposalStatus, at?: number): Promise<void>;
+    expireProposals(now?: number): Promise<{
+        expired: number;
+    }>;
+}