@inflexa-ai/harness 0.23.0 → 0.24.0

package/dist/tools/iterate-report.d.ts

@@ -1,227 +0,0 @@
-/**
- * Report authoring tools for the conversation agent: `plan_report` + `submit_report`.
- *
- * WHY TWO TOOLS. The report brief (title/audience/sources plus the section
- * union — narrative/metrics/figure/table/chart, each with its own
- * encoding/transform/asset sub-fields) is a ~12k-char JSON schema. Every
- * registered tool's schema ships on EVERY conversation turn, so parking that
- * brief on an always-on tool would tax every turn for a tool used only when a
- * report is actually built. We split the single former tool in two and deliver
- * the heavy schema just-in-time:
- *
- *  - `plan_report` — a tiny, always-on trigger (no-arg). Its `execute` RETURNS
- *    the brief schema (`z.toJSONSchema(ReportBriefSchema)`) plus the authoring
- *    rules as its tool RESULT, so the full contract enters context only on a
- *    report-building turn — and thereafter rides in the cached history prefix,
- *    not at full price on every request.
- *  - `submit_report` — takes the composed brief and does the real work
- *    (pre-flight staging, previewId/versioning, `runReportIteration`, preview
- *    publishing). It accepts the brief as `unknown` so the 12k schema stays off
- *    the always-on surface, then validates it against `ReportBriefSchema` INSIDE
- *    `execute`, returning `{ ok: false, issues }` as DATA the model can fix (not
- *    a thrown error). That is the same trade `validate_plan` makes: a runtime
- *    contract in exchange for keeping the schema out of every request. The small
- *    iterate-mode + common fields (modifications / previewId / baseVersion /
- *    sources / format) stay fully typed — they cost little and guide iteration.
- *
- * On a valid brief, `submit_report`'s behaviour is identical to the former
- * `iterate_report`: two modes (Create v1 via `report`; Iterate v2+ via
- * `modifications` + `previewId`), pre-flight stages every source into the
- * preview's assets/ dir, and it emits a `data-report-preview` chat data part on
- * success or `data-report-preview-failed` on pre-flight/builder failure. The
- * hosted preview surface is reached through an injected `PreviewPublisher` seam
- * (managed default mints a short-lived run-authorization grant; local default
- * returns "unavailable"). The 4 custom report tools the builder drives are
- * constructed inside `runReportIteration` — see design.md Decision #9.
- *
- * Naming note: the report-builder SUB-agent has its OWN same-id `submit_report`
- * terminal tool (`tools/report/submit-report.ts`). The two never share a tool
- * roster — this one is the conversation agent's brief-submission entry point;
- * that one is the builder's finalize gate.
- */
-import type { Pool } from "pg";
-import { z } from "zod";
-import type { ChatProvider } from "../providers/types.js";
-import { type Tool } from "./define-tool.js";
-import { type ResolveWorkspaceRoot } from "../workspace/paths.js";
-import { type StagedAsset } from "./lib/report-preflight.js";
-import type { PreviewPublisher } from "./report/preview-publisher.js";
-import type { ChromeConfig } from "../lib/chrome.js";
-import type { Logger } from "../lib/logger.js";
-import type { UsageRecorder } from "../billing/usage-recorder.js";
-/**
- * The report brief the conversation agent composes: title/audience + sources +
- * the section union. This is the ~12k-char schema that `plan_report` hands back
- * just-in-time and that `submit_report` validates its `report` field against
- * inside `execute`. Exported for `plan_report`, `submit_report`, and the
- * brief-shape tests.
- */
-export declare const ReportBriefSchema: z.ZodObject<{
-    title: z.ZodString;
-    audience: z.ZodString;
-    styleGuidance: z.ZodOptional<z.ZodString>;
-    sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        path: z.ZodString;
-        as: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>>;
-    sections: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
-        type: z.ZodLiteral<"narrative">;
-        title: z.ZodString;
-        intent: z.ZodString;
-        content: z.ZodObject<{
-            prose: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"metrics">;
-        title: z.ZodString;
-        intent: z.ZodString;
-        content: z.ZodObject<{
-            stats: z.ZodArray<z.ZodObject<{
-                label: z.ZodString;
-                value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
-                unit: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>>;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"figure">;
-        title: z.ZodString;
-        intent: z.ZodString;
-        content: z.ZodObject<{
-            imageAsset: z.ZodString;
-            caption: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"table">;
-        title: z.ZodString;
-        intent: z.ZodString;
-        content: z.ZodObject<{
-            dataAsset: z.ZodString;
-            columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            topN: z.ZodOptional<z.ZodNumber>;
-            sortBy: z.ZodOptional<z.ZodObject<{
-                column: z.ZodString;
-                order: z.ZodEnum<{
-                    desc: "desc";
-                    asc: "asc";
-                }>;
-            }, z.core.$strip>>;
-            transform: z.ZodOptional<z.ZodString>;
-            caption: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"chart">;
-        title: z.ZodString;
-        intent: z.ZodString;
-        content: z.ZodObject<{
-            dataAsset: z.ZodOptional<z.ZodString>;
-            data: z.ZodOptional<z.ZodObject<{
-                columns: z.ZodArray<z.ZodString>;
-                rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull]>>>;
-                source: z.ZodString;
-            }, z.core.$strip>>;
-            chartType: z.ZodEnum<{
-                bar: "bar";
-                line: "line";
-                scatter: "scatter";
-                histogram: "histogram";
-                box: "box";
-                heatmap: "heatmap";
-                pie: "pie";
-            }>;
-            encoding: z.ZodObject<{
-                x: z.ZodOptional<z.ZodString>;
-                y: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-                group: z.ZodOptional<z.ZodString>;
-                value: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>;
-            topN: z.ZodOptional<z.ZodNumber>;
-            sortBy: z.ZodOptional<z.ZodObject<{
-                column: z.ZodString;
-                order: z.ZodEnum<{
-                    desc: "desc";
-                    asc: "asc";
-                }>;
-            }, z.core.$strip>>;
-            transform: z.ZodOptional<z.ZodString>;
-            caption: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"methods">;
-        title: z.ZodString;
-        intent: z.ZodString;
-        content: z.ZodObject<{
-            prose: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>], "type">>;
-}, z.core.$strip>;
-/**
- * `submit_report`'s always-on input surface. The heavy brief rides in `report`
- * as `unknown` — typed that way ON PURPOSE so the ~12k `ReportBriefSchema` does
- * NOT ship on every conversation turn; `execute` validates it against
- * `ReportBriefSchema` and returns issues as data. The iterate-mode + common
- * fields stay fully typed (they are small and guide iteration). Exported for
- * the envelope-validation tests.
- */
-export declare const submitReportInputSchema: z.ZodObject<{
-    previewId: z.ZodOptional<z.ZodString>;
-    baseVersion: z.ZodOptional<z.ZodNumber>;
-    format: z.ZodDefault<z.ZodEnum<{
-        html: "html";
-    }>>;
-    report: z.ZodOptional<z.ZodUnknown>;
-    modifications: z.ZodOptional<z.ZodString>;
-    sources: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        path: z.ZodString;
-        as: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>;
-/**
- * `plan_report` — the tiny, always-on trigger (no args). Its result delivers
- * the brief schema + authoring rules just-in-time, so the ~12k contract enters
- * context only on a report-building turn (and thereafter rides in the cached
- * history prefix). Compose the brief from what it returns, then call
- * `submit_report`. Pure logic, no deps — hence a module-scope leaf tool.
- */
-export declare const planReportTool: Tool;
-export interface SubmitReportDeps {
-    /** Operational logging seam; omitted falls back to no-op. */
-    readonly logger?: Logger;
-    readonly provider: ChatProvider;
-    readonly pool: Pool;
-    /** Embedder-supplied workspace-root resolution seam (see workspace/paths.ts). */
-    readonly resolveWorkspaceRoot: ResolveWorkspaceRoot;
-    /** Model id — provenance / metric label; provider owns the wire model. */
-    readonly model: string;
-    /** Root templates dir; report-runner joins `report-html`. */
-    readonly templatesDir: string;
-    /** Skills root; report-runner gives the report-builder `report-html` skill tools. */
-    readonly skillsDir: string;
-    readonly chrome: ChromeConfig;
-    /**
-     * Builds the preview-publishing seam for this iteration. A managed
-     * embedder's realization mints a short-lived access grant + client eagerly
-     * at iteration start; the local default returns an "unavailable" publisher.
-     * Rejection (e.g. grant-mint failure) surfaces as a failed-preview tool result.
-     */
-    readonly createPreviewPublisher: (args: {
-        session: import("../auth/types.js").AgentSession;
-        resourceId: string;
-        runId: string;
-        previewId: string;
-        ttlSeconds: number;
-    }) => Promise<PreviewPublisher>;
-    /** LLM usage-accounting seam for the report-builder loop; omitted falls back to the no-op recorder. */
-    readonly usageRecorder?: UsageRecorder;
-}
-/**
- * `submit_report` — takes the composed brief and drives the report iteration.
- * On a valid brief its behaviour is byte-for-byte the former `iterate_report`:
- * pre-flight staging, previewId/versioning, `runReportIteration`, preview
- * publishing. The brief rides as `unknown` on the wire (keeping its ~12k schema
- * off the always-on surface) and is validated against `ReportBriefSchema` here.
- */
-export declare function createReportSubmitTool(deps: SubmitReportDeps): Tool;
-/** Exported for unit tests — pipe-escape correctness. */
-export declare function stagedAssetsBlock(staged: StagedAsset[], opts?: {
-    newOnly?: boolean;
-}): string;