codecartographer-pi 0.19.6 → 0.21.0

package/dist/core/broadside.d.ts

@@ -16,6 +16,16 @@ export declare const BROADSIDE_LENS_IDS: readonly ["architecture", "api", "secur
 export type BroadsideLensId = (typeof BROADSIDE_LENS_IDS)[number];
 export declare const BROADSIDE_POLL_INTERVAL_MS = 15000;
 export declare const BROADSIDE_DEFAULT_POLL_BUDGET_MS: number;
+/**
+ * The run expense limit in USD a repository gets before it configures one.
+ * Pi asks a human before submitting over the estimate; the MCP surface cannot,
+ * and shipped with no limit at all, so a host calling submit with the stock
+ * config spent whatever the estimate came to (#231). One dollar covers a
+ * six-lens run of a repository this size with room to spare; a larger one
+ * raises `max_cost` in config.yaml, passes `max_cost` on the call, or sets it
+ * to 0 for no limit.
+ */
+export declare const BROADSIDE_DEFAULT_MAX_COST = 1;
 export type ModelPricing = {
     /** USD per million input tokens. */
     inputPerM: number;
@@ -63,6 +73,14 @@ export type JsonSchemaDef = {
     strict: boolean;
     schema: Record<string, unknown>;
 };
+/**
+ * Where the file list and the file contents both came from — one source, so
+ * a run's results correspond to one state of the repository (#248).
+ * `working-tree`: git's view of the checkout (tracked plus untracked files,
+ * ignore rules applied, files deleted on disk left out); `walk`: a bounded
+ * directory walk, for a target that is not a git repository.
+ */
+export type RepoSnapshotSource = "working-tree" | "walk";
 export type RepoInfo = {
     name: string;
     path: string;
@@ -77,6 +95,13 @@ export type RepoInfo = {
     fileCounts: Record<string, number>;
     sourceGlob: string;
     sourceExts: string[];
+    /** How many slurpable files carry one of `sourceExts`; zero means no lens has code to scan. */
+    sourceFileCount: number;
+    snapshot: RepoSnapshotSource;
+    /** Files left out of every lens because their name says they hold secrets (#252). */
+    secretFilesSkipped: string[];
+    /** Secret-like values redacted from the entry point, manifest, and README excerpt. */
+    redactedValues: number;
 };
 export type FileSlice = {
     moduleName: string;
@@ -85,6 +110,10 @@ export type FileSlice = {
     chars: number;
     /** Repo-relative paths of the files folded into this slice. */
     files: string[];
+    /** Secret-like values redacted from this slice's files before upload (#252). */
+    redactedValues?: number;
+    /** The files in this slice that had at least one value redacted. */
+    redactedFiles?: string[];
 };
 /**
  * OpenRouter's unified `reasoning` control, as sent on a lens request.
@@ -202,6 +231,17 @@ export type BroadsideRun = {
     sourceDirty?: boolean;
     /** When incremental, the previous run's HEAD this run diffs against. */
     baseHead?: string | null;
+    /** Where the scanned files and their contents were read from (#248). */
+    snapshot?: RepoSnapshotSource;
+    /** The language the lenses scanned as. */
+    language?: string;
+    /** What the secret-redaction pass did before upload (#252); absent on runs from before it. */
+    redaction?: {
+        enabled: boolean;
+        values: number;
+        files: number;
+        skippedFiles: number;
+    };
 };
 export type BroadsideStateFile = {
     schema_version: number;
@@ -240,6 +280,13 @@ export type BroadsideConfig = {
     includeTriage: boolean;
     /** Default poll budget in seconds; 0 means "return immediately". */
     waitSeconds: number;
+    /**
+     * Replace secret-like values with `[REDACTED:<kind>]` and skip files named
+     * like credential stores before anything is uploaded (#252). On by default;
+     * off only for a repository whose maintainers have decided its contents may
+     * leave as they are.
+     */
+    redactSecrets: boolean;
 };
 /**
  * The pre-flight facts a caller needs to decide whether a run is worth its
@@ -276,6 +323,38 @@ export type BroadsideEstimate = {
     /** The provider's completion ceiling, when the catalog advertises one. */
     outputCap?: number;
 };
+/**
+ * OpenRouter rejected the API key (HTTP 401/403). Thrown from the catalog
+ * lookup rather than swallowed into "could not price" or a silent built-in
+ * fallback: a run that cannot authenticate cannot submit either, and the
+ * message that reaches the user has to say so (#251).
+ */
+export declare class BroadsideAuthError extends Error {
+    readonly httpStatus: number;
+    readonly detail: string;
+    constructor(httpStatus: number, detail: string);
+}
+/**
+ * `broadside/config.yaml` exists but cannot be used. A file that failed to
+ * parse used to be treated exactly like an absent one — defaults, including
+ * no spend cap and no lens routing, with no message — so a typo removed the
+ * user's own guard (#232). Only an absent file yields defaults now.
+ */
+export declare class BroadsideConfigError extends Error {
+    readonly path: string;
+    constructor(path: string, detail: string);
+}
+/**
+ * `broadside/state.json` exists but cannot be read. It used to be read as
+ * empty and the next checkpoint wrote that empty state over it, losing the
+ * batch ids of every in-flight, already-paid run (#233). The corrupt file is
+ * preserved beside itself and nothing writes over it until someone looks.
+ */
+export declare class BroadsideStateError extends Error {
+    readonly path: string;
+    readonly backupPath: string;
+    constructor(path: string, backupPath: string, detail: string);
+}
 /** Thrown when a confirm hook declines a run. Nothing was submitted. */
 export declare class BroadsideCancelledError extends Error {
     constructor(message?: string);
@@ -312,6 +391,21 @@ export type BroadsideSubmitResult = {
         expirationDate?: string | null;
     };
     incremental: BroadsideIncrementalOutcome;
+    /** What was scanned: the language the lenses ran as and the snapshot the files came from. */
+    repo: {
+        language: string;
+        sourceFiles: number;
+        snapshot: RepoSnapshotSource;
+        sourceHead: string | null;
+        sourceDirty: boolean;
+    };
+    /** What the secret-redaction pass did before upload (#252). */
+    redaction: {
+        enabled: boolean;
+        values: number;
+        files: number;
+        skippedFiles: string[];
+    };
 };
 export type BroadsideCollectResult = {
     runId: string;
@@ -328,6 +422,7 @@ export type BroadsideCollectResult = {
         cost?: number;
         resultCount?: number;
         truncated?: number;
+        error?: string;
     }>>;
     synthesis: BroadsideSynthesisEntry;
     triage: BroadsideTriageEntry;
@@ -355,8 +450,14 @@ type LensDefinition = {
 };
 export declare function getLens(lensId: BroadsideLensId): LensDefinition;
 export declare function listLenses(): LensDefinition[];
-export declare function collectRepoInfo(targetDir: string): Promise<RepoInfo>;
-export declare function gatherSlices(targetDir: string, lens: LensDefinition, info: RepoInfo): Promise<FileSlice[]>;
+/** The languages Broad-Side can scan; anything else is refused at submit. */
+export declare const BROADSIDE_LANGUAGES: readonly ["go", "python", "rust", "typescript", "javascript"];
+export declare function collectRepoInfo(targetDir: string, opts?: {
+    redact?: boolean;
+}): Promise<RepoInfo>;
+export declare function gatherSlices(targetDir: string, lens: LensDefinition, info: RepoInfo, opts?: {
+    redact?: boolean;
+}): Promise<FileSlice[]>;
 export declare function buildBatchRequest(lens: LensDefinition, info: RepoInfo, slice: FileSlice, index: number, sliceCount: number, model?: string, maxTokensOverride?: number, reasoningOverride?: BroadsideReasoning): BatchRequest;
 /**
  * Pre-flight cost estimate for one lens.
@@ -434,6 +535,10 @@ export declare function updateBroadsideStateAtomically(broadsideDir: string, mut
  */
 export declare function persistBroadsideRun(broadsideDir: string, run: BroadsideRun): Promise<BroadsideStateFile>;
 export declare function loadBroadsideConfig(broadsideDir: string): Promise<BroadsideConfig>;
+/** The shipped defaults: what an absent config.yaml means. */
+export declare function defaultBroadsideConfig(): BroadsideConfig;
+/** The catalog cache schema this build writes; a file from another is not read. */
+export declare const BROADSIDE_CATALOG_CACHE_SCHEMA = 3;
 export declare function builtInCatalogEntry(model: string): CatalogEntry | null;
 export declare function builtInPricing(model: string): ModelPricing | null;
 export declare function resolveCatalogEntry(broadsideDir: string, config: BroadsideConfig, model: string, apiKey: string, fetcher?: FetchLike): Promise<BroadsideCatalogResult>;
@@ -463,6 +568,14 @@ export declare function fetchBatch(batchId: string, apiKey: string, fetcher?: Fe
  * charged, so callers must come back for it rather than retire it.
  */
 export declare const BROADSIDE_DEAD_BATCH_STATUSES: string[];
+/**
+ * Batch entry statuses collect never polls again: the dead ones above, plus
+ * `completed`, plus the two a submit assigns without a batch (`skipped`: no
+ * matching files; `rejected`: the provider refused it). The 0.19.1 changelog
+ * called the dead set "a named constant rather than two hand-maintained
+ * lists"; this set was still three literal copies (self-audit sem 5.8).
+ */
+export declare const BROADSIDE_TERMINAL_ENTRY_STATUSES: string[];
 export declare function pollBatchUntilTerminal(batchId: string, apiKey: string, opts?: {
     deadlineMs?: number;
     onStatus?: (status: string, counts: Record<string, unknown>) => void;
@@ -545,6 +658,12 @@ export declare function runBroadsideCollect(cwd: string, apiKey: string, opts?:
     retryTruncated?: boolean;
     onStatus?: (lensId: string, status: string, counts: Record<string, unknown>) => void;
     fetcher?: FetchLike;
+    /**
+     * Which run to collect. Absent, the most recent — which used to be the
+     * only choice, so an older run still in flight could not be collected
+     * once a newer submit existed (#268). `status` lists the ids.
+     */
+    runId?: string;
 }): Promise<BroadsideCollectResult>;
 export declare function runBroadsideStatus(cwd: string): Promise<{
     state: BroadsideStateFile;