@heyhuynhgiabuu/pi-pretty 0.5.3 → 0.6.0

package/src/types.ts

@@ -0,0 +1,227 @@
+/**
+ * pi-pretty shared types.
+ */
+
+import type { TextContent, ImageContent } from "@earendil-works/pi-ai";
+import type { AgentToolResult } from "@earendil-works/pi-coding-agent";
+
+// ---------------------------------------------------------------------------
+// Re-export FFF types needed by tools
+// ---------------------------------------------------------------------------
+
+export type { FileFinder, FileItem, GrepResult, SearchResult, GrepMatch, GrepCursor } from "@ff-labs/fff-node";
+
+// ---------------------------------------------------------------------------
+// Content / Result types
+// ---------------------------------------------------------------------------
+
+export type ToolContent = TextContent | ImageContent;
+export type { TextContent, ImageContent };
+// ---------------------------------------------------------------------------
+// Theme / rendering context types
+// ---------------------------------------------------------------------------
+
+export interface ThemeLike {
+	fg: (key: string, text: string) => string;
+	bold: (text: string) => string;
+	getBgAnsi?: (key: string) => string;
+}
+
+export interface RenderCtxLike {
+	lastComponent?: ComponentLike;
+	isError?: boolean;
+	state: Record<string, string | undefined>;
+	expanded?: boolean;
+}
+
+export interface TextLike {
+	setText(v: string): void;
+	getText?(): string;
+}
+
+/** Minimal Component interface matching pi-tui's Component. */
+export interface ComponentLike {
+	setText(v: string): void;
+	render(width: number): string[];
+	invalidate?(): void;
+}
+
+// ---------------------------------------------------------------------------
+// Render detail types
+// ---------------------------------------------------------------------------
+
+export type ReadDetails =
+	| { _type: "readImage"; filePath: string; data: string; mimeType: string }
+	| { _type: "readFile"; filePath: string; content: string; offset: number; lineCount: number };
+
+export interface BashDetails extends Record<string, unknown> {
+	_type: "bashResult";
+	text: string;
+	exitCode: number | null;
+	command: string;
+}
+
+export interface LsDetails extends Record<string, unknown> {
+	_type: "lsResult";
+	text: string;
+	path: string;
+	entryCount: number;
+}
+
+export interface FindDetails extends Record<string, unknown> {
+	_type: "findResult";
+	text: string;
+	pattern: string;
+	matchCount: number;
+}
+
+export interface GrepDetails extends Record<string, unknown> {
+	_type: "grepResult";
+	text: string;
+	pattern: string;
+	matchCount: number;
+}
+
+export type AnyDetails = ReadDetails | BashDetails | LsDetails | FindDetails | GrepDetails;
+
+// ---------------------------------------------------------------------------
+// Tool input types
+// ---------------------------------------------------------------------------
+
+export interface ReadInput {
+	path: string;
+	offset?: number;
+	limit?: number;
+}
+
+export interface BashInput {
+	command: string;
+	timeout?: number;
+}
+
+export interface LsInput {
+	path?: string;
+}
+
+export interface FindInput {
+	pattern: string;
+	path?: string;
+	limit?: number;
+}
+
+export interface GrepInput {
+	pattern: string;
+	path?: string;
+	glob?: string;
+	context?: number;
+	limit?: number;
+	literal?: boolean;
+	ignoreCase?: boolean;
+}
+
+export interface MultiGrepInput {
+	patterns: string[];
+	path?: string;
+	constraints?: string;
+	context?: number;
+	limit?: number;
+}
+
+// ---------------------------------------------------------------------------
+// SDK tool definition shape (DI-friendly — accepts both mock and real SDK)
+// ---------------------------------------------------------------------------
+
+/**
+ * Minimal structural type for an SDK-produced tool definition.
+ * Accepts both the real SDK's ToolDefinition<> return type and test mocks.
+ */
+export interface SdkToolDef {
+	name?: string;
+	description?: string;
+	label?: string;
+	parameters?: unknown;
+	execute: (...args: any[]) => Promise<AgentToolResult<any>>;
+}
+
+export interface SdkTools {
+	createReadTool?: (cwd: string) => SdkToolDef;
+	createBashTool?: (cwd: string) => SdkToolDef;
+	createLsTool?: (cwd: string) => SdkToolDef;
+	createFindTool?: (cwd: string) => SdkToolDef;
+	createGrepTool?: (cwd: string) => SdkToolDef;
+	getAgentDir?: () => string;
+}
+
+// ---------------------------------------------------------------------------
+// Multi-grep fallback types
+// ---------------------------------------------------------------------------
+
+export interface MultiGrepFallbackParams {
+	cwd: string;
+	patterns: string[];
+	path?: string;
+	constraints?: string;
+	context?: number;
+	limit: number;
+	ignoreCase: boolean;
+	signal?: AbortSignal;
+}
+
+export interface MultiGrepFallbackResult {
+	text: string;
+	matchCount: number;
+	limitReached: boolean;
+}
+
+export type MultiGrepFallback = (params: MultiGrepFallbackParams) => Promise<MultiGrepFallbackResult>;
+
+// ---------------------------------------------------------------------------
+// FFF service interfaces
+// ---------------------------------------------------------------------------
+
+/** Minimal FFF service shape for tools that only need fileSearch. */
+export interface FffServiceLike {
+	readonly isAvailable: boolean;
+	readonly partialIndex: boolean;
+	getFinder(): import("@ff-labs/fff-node").FileFinder | null;
+}
+
+/** Full FFF service for grep tools that also need cursor store. */
+export interface FffServiceWithCursor extends FffServiceLike {
+	getCursorStore(): CursorStore;
+}
+
+/** FFF lifecycle interface (used by session lifecycle code). */
+export interface FffService extends FffServiceWithCursor {
+	ensureFinder(cwd: string): Promise<void>;
+	destroy(): void;
+	isModuleLoaded(): boolean;
+	tryLoadModule(): Promise<boolean>;
+}
+
+export interface CursorStore {
+	store(cursor: unknown): string;
+	get(id: string): unknown | undefined;
+}
+
+// ---------------------------------------------------------------------------
+// Constraint parsing
+// ---------------------------------------------------------------------------
+
+export interface ConstraintParseResult {
+	ok: boolean;
+	globs: string[];
+	tokens: string[];
+	error?: string;
+}
+
+// ---------------------------------------------------------------------------
+// DI
+// ---------------------------------------------------------------------------
+
+export interface PiPrettyDeps {
+	sdk?: SdkTools;
+	TextComponent?: new (text?: string, x?: number, y?: number) => ComponentLike;
+	fffModule?: typeof import("@ff-labs/fff-node");
+	multiGrepRipgrepFallback?: MultiGrepFallback;
+}

package/test/bash-rendering.test.ts

@@ -184,7 +184,7 @@ describe("bash renderCall expansion", () => {
 			});
 
 			const lines = stripAnsi(rendered.getText()).split("\n");
-			expect(lines[0]).toMatch(/^bash false/);
+			expect(lines[1]).toMatch(/^  bash false/);
 		});
 	});
 
@@ -215,7 +215,7 @@ describe("bash renderCall expansion", () => {
 		});
 	});
 
-	it("does not emit internal ANSI background padding or resets for bash results", () => {
+	it("applies tool background correctly to bash results without unnecessary resets", () => {
 		withStdoutColumns(64, () => {
 			const bashTool = loadBashTool();
 			const rendered = bashTool.renderResult(
@@ -234,7 +234,7 @@ describe("bash renderCall expansion", () => {
 				},
 			);
 
-			expect(rendered.getText()).not.toMatch(/\x1b\[48;/);
+			expect(rendered.getText()).toMatch(/\x1b\[48;/); // tool background is applied
 			expect(rendered.getText()).not.toContain("\x1b[0m");
 			expect(rendered.getText()).not.toContain("\x1b[49m");
 			for (const line of rendered.getText().split("\n")) {