@quickchatai/pi-quickreview 1.2.0 → 1.3.2

package/dist/src/scan/scanverbs.d.ts

@@ -0,0 +1,208 @@
+import { type CutVerbs } from "./cutrender.js";
+import type { FindingsStore, ScanFinding } from "./findings.js";
+import type { Refusal } from "./scanports.js";
+import { type ScanVerbs, type TicketsClosed } from "./scanrender.js";
+import type { ScanRunner, ScanRun, ScanSettings } from "./scanrun.js";
+import type { UnitCutPort } from "./unitcutstore.js";
+export declare const SCAN_USAGE: string;
+/** How often `status --wait` and `stop` look again. */
+export declare const POLL_MS = 2000;
+export interface FindingsQuery {
+    state?: string;
+    lens?: string;
+    unit?: string;
+    severity?: string;
+    validity?: string;
+    doubted?: boolean;
+    limit?: number;
+}
+export type ScanCommand = {
+    verb: "preview";
+    sha?: string;
+    delta: boolean;
+} | {
+    verb: "start";
+    key: string;
+    sha?: string;
+    delta: boolean;
+    foreground: boolean;
+} | {
+    verb: "status";
+    wait: boolean;
+    timeout?: number;
+} | {
+    verb: "stop";
+} | {
+    verb: "findings";
+    query: FindingsQuery;
+} | {
+    verb: "matches";
+} | {
+    verb: "match";
+    key: string;
+    pairs: Array<{
+        old: string;
+        new: string;
+    }>;
+} | {
+    verb: "suggestions";
+} | {
+    verb: "stage2-propose";
+    rows?: string;
+    budget?: number;
+    deep?: boolean;
+    sha?: string;
+} | {
+    verb: "stage2-start";
+    key: string;
+    rows?: string[];
+    foreground: boolean;
+} | {
+    verb: "dismiss";
+    fingerprints: string[];
+    reason: string;
+} | {
+    verb: "units-show";
+} | {
+    verb: "units-propose";
+    file?: string;
+} | {
+    verb: "units-adjust";
+    file: string;
+} | {
+    verb: "units-save";
+} | {
+    verb: "login";
+    provider?: string;
+} | {
+    verb: "doctor";
+} | {
+    verb: "rebuild";
+};
+/** A usage error: the usage line, and why when there is one. */
+export declare const usage: (why?: string) => Error;
+/** `qcr scan`'s arguments (`--json` taken off before). An unknown token is
+ * refused, so a mistyped flag never runs something else. */
+export declare function parseScanArgs(rest: readonly string[]): ScanCommand;
+/** One stored finding as `--json` carries it. */
+export interface FindingJson {
+    fingerprint: string;
+    file: string;
+    range: {
+        start: number;
+        end: number;
+    };
+    lens: string;
+    lenses: string[];
+    unit: string;
+    kind: string;
+    severity: string;
+    validity: string;
+    state: string;
+    claim: string;
+    /** Marked "may not be valid" by the validator. */
+    doubted: boolean;
+    doubt: {
+        word: string;
+        reason: string;
+        class: string | null;
+    } | null;
+    /** A dismissed finding it resembles — flagged, never auto-dismissed. */
+    looks_like_dismissed: {
+        fingerprint: string;
+        reason: string;
+    } | null;
+    dismissal_reason: string | null;
+    ticket: string | null;
+    first_seen: {
+        run: string;
+        sha: string;
+    };
+    last_seen: {
+        run: string;
+        sha: string;
+    };
+}
+export declare function findingJson(f: ScanFinding): FindingJson;
+/** A run as `status --json` and a foreground start carry it. */
+export declare function runJson(run: ScanRun & {
+    display?: string;
+}): Record<string, unknown>;
+/** What a detached driver answers once it has recorded its run (or refused);
+ * a sandboxed one names its container. */
+export type DetachOutcome = {
+    ok: true;
+    run: ScanRun;
+    log: string;
+    container?: string;
+} | {
+    ok: false;
+    errors: string[];
+};
+/** The dismissal a host offers (the app's triage, over reviewer memory and
+ * the tracker): a finding marked not worth reporting, with the reason PR
+ * rounds will read. */
+export interface ScanDismissPort {
+    dismiss(args: {
+        fingerprint?: unknown;
+        reason?: unknown;
+    }): Promise<{
+        ok: true;
+        finding: {
+            fingerprint: string;
+        };
+        again: boolean;
+        memory: "written" | {
+            problem: string;
+        };
+    } | Refusal>;
+}
+/** What one scan verb runs over: the engine, the host's ports, and the words
+ * its answers name the next step in. */
+export interface ScanVerbDeps {
+    scan: ScanRunner;
+    findings: FindingsStore;
+    settingsOf: () => ScanSettings | null;
+    triage: ScanDismissPort | null;
+    /** After a match answer: close the tickets of the promoted findings it fixed. */
+    afterMatch: (() => Promise<TicketsClosed>) | null;
+    /** The state home. */
+    home: string;
+    /** Where a foreground start's output goes, as its start outcome names it. */
+    driverLog: string;
+    out: (line: string) => void;
+    /** Launch `qcr scan <argv> --foreground` detached; resolves once it started. */
+    detach: (argv: string[]) => Promise<DetachOutcome>;
+    sleep: (ms: number) => Promise<void>;
+    now: () => number;
+    /** While a foreground driver runs: answer the stop channel (and signals).
+     * Returns the stop. Absent: nothing is watched. */
+    watchStops?: (scan: ScanRunner) => () => void;
+    /** A foreground driver's start outcome, for the process that detached it. */
+    onStart?: (r: DetachOutcome) => void;
+    /** `units`: the setup engine over the reviewed checkout. Absent: refused. */
+    units?: UnitCutPort | null;
+    /** `doctor`: the sandbox's readiness report, rendered. */
+    doctor?: () => Promise<{
+        ok: boolean;
+        human: string;
+        data: Record<string, unknown>;
+    }>;
+    /** `login`: pi, interactive, over the companion's pi home (in the running companion, or a throwaway container); its exit code. */
+    login?: (provider?: string) => Promise<number>;
+    /** `rebuild`: build `[scan] image` alone, stamped; no container touched. */
+    rebuild?: () => Promise<{
+        ok: true;
+        image: string;
+        stamp: string;
+    } | {
+        ok: false;
+        errors: string[];
+    }>;
+    /** How the answers name the next step (default the `qcr scan` CLI's). */
+    verbs?: ScanVerbs;
+    cutVerbs?: CutVerbs;
+}
+/** Run one scan subcommand (`qcr scan …`, `/qcr-scan …`); resolves its exit code. */
+export declare function runScanVerb(rest: readonly string[], json: boolean, deps: ScanVerbDeps): Promise<number>;
+//# sourceMappingURL=scanverbs.d.ts.map

package/dist/src/scan/scanverbs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanverbs.d.ts","sourceRoot":"","sources":["../../../src/scan/scanverbs.ts"],"names":[],"mappings":"AAiBA,OAAO,EAKL,KAAK,QAAQ,EACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEhE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAkBL,KAAK,SAAS,EACd,KAAK,aAAa,EACnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAc,MAAM,cAAc,CAAC;AAGlF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,eAAO,MAAM,UAAU,QAOsL,CAAC;AAE9M,uDAAuD;AACvD,eAAO,MAAM,OAAO,OAAO,CAAC;AAE5B,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,GACjF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,aAAa,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAAE,GAC1E;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GACxF;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,GAC3E;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GACtB;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GACtB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,gEAAgE;AAChE,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,KAAG,KACoB,CAAC;AAE1D;4DAC4D;AAC5D,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,WAAW,CA2MlE;AAID,iDAAiD;AACjD,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IACrE,wEAAwE;IACxE,oBAAoB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACrE,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACzC;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,WAAW,GAAG,WAAW,CAwBvD;AAED,gEAAgE;AAChE,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAkCpF;AA0BD;0CAC0C;AAC1C,MAAM,MAAM,aAAa,GACvB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,GAAG,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEhG;;uBAEuB;AACvB,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,IAAI,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAC/D;QACE,EAAE,EAAE,IAAI,CAAC;QACT,OAAO,EAAE;YAAE,WAAW,EAAE,MAAM,CAAA;SAAE,CAAC;QACjC,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,SAAS,GAAG;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;KACzC,GACD,OAAO,CACV,CAAC;CACH;AAED;wCACwC;AACxC,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,MAAM,YAAY,GAAG,IAAI,CAAC;IACtC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,iFAAiF;IACjF,UAAU,EAAE,CAAC,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG,IAAI,CAAC;IAClD,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,gFAAgF;IAChF,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IACnD,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,GAAG,EAAE,MAAM,MAAM,CAAC;IAClB;uDACmD;IACnD,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,MAAM,IAAI,CAAC;IAC9C,6EAA6E;IAC7E,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IACrC,6EAA6E;IAC7E,KAAK,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAC3B,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;IACtF,kIAAkI;IAClI,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,OAAO,CACrB;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,EAAE,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,CAC7E,CAAC;IACF,yEAAyE;IACzE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAID,qFAAqF;AACrF,wBAAsB,WAAW,CAC/B,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,IAAI,EAAE,OAAO,EACb,IAAI,EAAE,YAAY,GACjB,OAAO,CAAC,MAAM,CAAC,CAoRjB"}