pi-advisor-flow 0.5.0 → 0.5.2

package/src/tools/types.ts

@@ -0,0 +1,119 @@
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import type { appendOutcome } from "../outcomes.js";
+import type { ScoutOutcome } from "../scout.js";
+import type {
+  AdvisorSessionState,
+  ConsultationTrigger,
+  GateDecision,
+  GateTrigger,
+} from "../session-state.js";
+import type { consultAdvisor, runAdvisorGate } from "./consultation.js";
+import type { ScoutStatusManager } from "./scout-status.js";
+
+export type {
+  AdvisorInvocationRecord,
+  ConsultationTrigger,
+  GateDecision,
+  GateTrigger,
+} from "../session-state.js";
+
+export interface ScoutToolDetails {
+  availableCount?: number;
+  fallbackReason?: string;
+  latencyMs?: number;
+  model: string;
+  omittedBeforeScout?: number;
+  selectedCount?: number;
+  selectedLabels?: string[];
+  status: "calling" | "streaming" | "curated" | "fallback" | "cancelled";
+  synthesis?: string;
+  text?: string;
+  thinking?: string;
+  usage?: unknown;
+}
+
+export interface AdvisorGateFailure {
+  category: GateFailureCategory;
+  markdown?: string;
+  message: string;
+  ok: false;
+  usage?: unknown;
+}
+
+export interface AdvisorConsultationResult {
+  adviceId: string;
+  draftBytes?: number;
+  markdown: string;
+  model: string;
+  preferenceBytes?: number;
+  scout?: Exclude<ScoutOutcome, { cancelled: true }>;
+  thinkingText: string;
+  trackedBytes?: number;
+  trigger: ConsultationTrigger;
+  untrackedBytes?: number;
+  usage?: unknown;
+}
+
+export interface AdvisorGateResult {
+  decision: GateDecision;
+  markdown: string;
+  model: string;
+  ok: true;
+  thinkingText: string;
+  trigger: GateTrigger;
+  usage?: unknown;
+}
+
+export type AdvisorGateOutcome = AdvisorGateResult | AdvisorGateFailure;
+
+export type GateFailureCategory =
+  | "provider-error"
+  | "empty-response"
+  | "missing-decision"
+  | "malformed-decision"
+  | "duplicate-decision"
+  | "contradictory-decision"
+  | "budget-exhausted";
+
+export interface AdvisorToolDetails {
+  adviceId?: string;
+  advisor?: string;
+  draftBytes?: number;
+  preferenceBytes?: number;
+  question?: string;
+  scout?: ScoutToolDetails;
+  text?: string;
+  thinking?: string;
+  trackedBytes?: number;
+  untrackedBytes?: number;
+  usage?: unknown;
+}
+
+export interface AdvisorRenderState {
+  phase?: string;
+  scout?: ScoutToolDetails;
+  timerId?: ReturnType<typeof setInterval>;
+}
+
+export interface AdvisorToolContext {
+  invalidate: () => void;
+  lastComponent: unknown;
+  state: AdvisorRenderState;
+}
+
+export interface ToolRegistrationContext {
+  appendOutcome: typeof appendOutcome;
+  consult: typeof consultAdvisor;
+  pi: ExtensionAPI;
+  reservedCalls: Set<string>;
+  runGate: typeof runAdvisorGate;
+  scoutStatus: ScoutStatusManager;
+  session: AdvisorSessionState;
+}
+
+export interface ToolRegistrationDependencies {
+  appendOutcome?: typeof appendOutcome;
+  consult?: typeof consultAdvisor;
+  runGate?: typeof runAdvisorGate;
+  statusManager?: ScoutStatusManager;
+}