@oh-my-pi/pi-coding-agent 14.5.9 → 14.5.11

package/src/web/search/providers/searxng.ts

@@ -9,14 +9,18 @@
  * and various authentication methods (bearer token, basic auth, or none).
  *
  * Configuration via settings:
- *   searxng.endpoint  - Base URL of the SearXNG instance (e.g. https://searx.example.org)
- *   searxng.token     - Optional bearer token for authentication
- *   searxng.categories - Optional comma-separated categories filter
- *   searxng.language  - Optional language code (e.g. en, zh-CN)
+ *   searxng.endpoint      - Base URL of the SearXNG instance (e.g. https://searx.example.org)
+ *   searxng.token         - Optional bearer token for authentication
+ *   searxng.basicUsername - Optional RFC 7617 Basic auth username
+ *   searxng.basicPassword - Optional RFC 7617 Basic auth password
+ *   searxng.categories    - Optional comma-separated categories filter
+ *   searxng.language      - Optional language code (e.g. en, zh-CN)
  *
  * Environment variable fallbacks:
- *   SEARXNG_ENDPOINT  - Base URL of the SearXNG instance
- *   SEARXNG_TOKEN     - Optional bearer token
+ *   SEARXNG_ENDPOINT       - Base URL of the SearXNG instance
+ *   SEARXNG_TOKEN          - Optional bearer token
+ *   SEARXNG_BASIC_USERNAME - Optional RFC 7617 Basic auth username
+ *   SEARXNG_BASIC_PASSWORD - Optional RFC 7617 Basic auth password
  *
  * Reference: https://docs.searxng.org/dev/search_api.html
  */
@@ -61,6 +65,11 @@ interface SearXNGResponse {
 	unresponsive_engines?: Array<[string, string]>;
 }
 
+interface SearXNGAuth {
+	type: "basic" | "bearer";
+	value: string;
+}
+
 /** Find SearXNG endpoint from settings or environment. */
 function findEndpoint(): string | null {
 	try {
@@ -83,6 +92,53 @@ function findToken(): string | null {
 	return process.env.SEARXNG_TOKEN ?? null;
 }
 
+/** Find SearXNG Basic auth username from settings or environment. */
+function findBasicUsername(): string | null {
+	try {
+		const username = settings.get("searxng.basicUsername");
+		if (username !== undefined) return username;
+	} catch {
+		// Settings not initialized yet
+	}
+	return process.env.SEARXNG_BASIC_USERNAME ?? null;
+}
+
+/** Find SearXNG Basic auth password from settings or environment. */
+function findBasicPassword(): string | null {
+	try {
+		const password = settings.get("searxng.basicPassword");
+		if (password !== undefined) return password;
+	} catch {
+		// Settings not initialized yet
+	}
+	return process.env.SEARXNG_BASIC_PASSWORD ?? null;
+}
+
+/** Build the RFC 7617 Basic auth credential using UTF-8 bytes. */
+function buildBasicAuthValue(username: string, password: string): string {
+	return Buffer.from(`${username}:${password}`, "utf-8").toString("base64");
+}
+
+/** Find SearXNG authentication from settings or environment. Basic auth takes precedence over bearer tokens. */
+function findAuth(): SearXNGAuth | null {
+	const basicUsername = findBasicUsername();
+	const basicPassword = findBasicPassword();
+	if (basicUsername !== null || basicPassword !== null) {
+		if (basicUsername === null || basicPassword === null) {
+			throw new Error(
+				"SearXNG Basic auth requires both searxng.basicUsername and searxng.basicPassword, or SEARXNG_BASIC_USERNAME and SEARXNG_BASIC_PASSWORD.",
+			);
+		}
+		if (basicUsername.includes(":")) {
+			throw new Error("SearXNG Basic auth username cannot contain ':' because RFC 7617 uses it as the separator.");
+		}
+		return { type: "basic", value: buildBasicAuthValue(basicUsername, basicPassword) };
+	}
+
+	const token = findToken();
+	return token ? { type: "bearer", value: token } : null;
+}
+
 /** Build the search URL and headers for a SearXNG request */
 function buildRequest(
 	endpoint: string,
@@ -94,7 +150,7 @@ function buildRequest(
 		language?: string;
 		signal?: AbortSignal;
 	},
-	token: string | null,
+	auth: SearXNGAuth | null,
 ): { url: URL; headers: Record<string, string> } {
 	const base = endpoint.replace(/\/+$/, "");
 	const url = new URL(`${base}/search`);
@@ -122,8 +178,10 @@ function buildRequest(
 		Accept: "application/json",
 	};
 
-	if (token) {
-		headers.Authorization = `Bearer ${token}`;
+	if (auth?.type === "basic") {
+		headers.Authorization = `Basic ${auth.value}`;
+	} else if (auth?.type === "bearer") {
+		headers.Authorization = `Bearer ${auth.value}`;
 	}
 
 	return { url, headers };
@@ -139,9 +197,9 @@ async function callSearXNGSearch(
 		language?: string;
 		signal?: AbortSignal;
 	},
-	token: string | null,
+	auth: SearXNGAuth | null,
 ): Promise<SearXNGResponse> {
-	const { url, headers } = buildRequest(endpoint, params, token);
+	const { url, headers } = buildRequest(endpoint, params, auth);
 
 	const response = await fetch(url, {
 		headers,
@@ -172,7 +230,7 @@ export async function searchSearXNG(params: {
 		);
 	}
 
-	const token = findToken();
+	const auth = findAuth();
 
 	let categories: string | undefined;
 	let language: string | undefined;
@@ -190,7 +248,7 @@ export async function searchSearXNG(params: {
 			categories,
 			language,
 		},
-		token,
+		auth,
 	);
 
 	const sources: SearchSource[] = [];

package/examples/custom-tools/todo/index.ts

@@ -1,211 +0,0 @@
-/**
- * Todo Tool - Demonstrates state management via session entries
- *
- * This tool stores state in tool result details (not external files),
- * which allows proper branching - when you branch, the todo state
- * is automatically correct for that point in history.
- *
- * The onSession callback reconstructs state by scanning past tool results.
- */
-import type {
-	CustomTool,
-	CustomToolContext,
-	CustomToolFactory,
-	CustomToolSessionEvent,
-} from "@oh-my-pi/pi-coding-agent";
-
-interface Todo {
-	id: number;
-	text: string;
-	done: boolean;
-}
-
-// State stored in tool result details
-interface TodoDetails {
-	action: "list" | "add" | "toggle" | "clear";
-	todos: Todo[];
-	nextId: number;
-	error?: string;
-}
-
-const factory: CustomToolFactory = pi => {
-	const { Type } = pi.typebox;
-	const { StringEnum, Text } = pi.pi;
-
-	// Define schema separately for proper type inference
-	const TodoParams = Type.Object({
-		action: StringEnum(["list", "add", "toggle", "clear"] as const),
-		text: Type.Optional(Type.String({ description: "Todo text (for add)" })),
-		id: Type.Optional(Type.Number({ description: "Todo ID (for toggle)" })),
-	});
-	// In-memory state (reconstructed from session on load)
-	let todos: Todo[] = [];
-	let nextId = 1;
-
-	/**
-	 * Reconstruct state from session entries.
-	 * Scans tool results for this tool and applies them in order.
-	 */
-	const reconstructState = (_event: CustomToolSessionEvent, ctx: CustomToolContext) => {
-		todos = [];
-		nextId = 1;
-
-		// Use getBranch() to get entries on the current branch
-		for (const entry of ctx.sessionManager.getBranch()) {
-			if (entry.type !== "message") continue;
-			const msg = entry.message;
-
-			// Tool results have role "toolResult"
-			if (msg.role !== "toolResult") continue;
-			if (msg.toolName !== "todo") continue;
-
-			const details = msg.details as TodoDetails | undefined;
-			if (details) {
-				todos = details.todos;
-				nextId = details.nextId;
-			}
-		}
-	};
-
-	const tool: CustomTool<typeof TodoParams, TodoDetails> = {
-		name: "todo",
-		label: "Todo",
-		description: "Manage a todo list. Actions: list, add (text), toggle (id), clear",
-		parameters: TodoParams,
-
-		// Called on session start/switch/branch/clear
-		onSession: reconstructState,
-
-		async execute(_toolCallId, params, _onUpdate, _ctx, _signal) {
-			switch (params.action) {
-				case "list":
-					return {
-						content: [
-							{
-								type: "text",
-								text: todos.length
-									? todos.map(t => `[${t.done ? "x" : " "}] #${t.id}: ${t.text}`).join("\n")
-									: "No todos",
-							},
-						],
-						details: { action: "list", todos: [...todos], nextId },
-					};
-
-				case "add": {
-					if (!params.text) {
-						return {
-							content: [{ type: "text", text: "Error: text required for add" }],
-							details: { action: "add", todos: [...todos], nextId, error: "text required" },
-						};
-					}
-					const newTodo: Todo = { id: nextId++, text: params.text, done: false };
-					todos.push(newTodo);
-					return {
-						content: [{ type: "text", text: `Added todo #${newTodo.id}: ${newTodo.text}` }],
-						details: { action: "add", todos: [...todos], nextId },
-					};
-				}
-
-				case "toggle": {
-					if (params.id === undefined) {
-						return {
-							content: [{ type: "text", text: "Error: id required for toggle" }],
-							details: { action: "toggle", todos: [...todos], nextId, error: "id required" },
-						};
-					}
-					const todo = todos.find(t => t.id === params.id);
-					if (!todo) {
-						return {
-							content: [{ type: "text", text: `Todo #${params.id} not found` }],
-							details: { action: "toggle", todos: [...todos], nextId, error: `#${params.id} not found` },
-						};
-					}
-					todo.done = !todo.done;
-					return {
-						content: [{ type: "text", text: `Todo #${todo.id} ${todo.done ? "completed" : "uncompleted"}` }],
-						details: { action: "toggle", todos: [...todos], nextId },
-					};
-				}
-
-				case "clear": {
-					const count = todos.length;
-					todos = [];
-					nextId = 1;
-					return {
-						content: [{ type: "text", text: `Cleared ${count} todos` }],
-						details: { action: "clear", todos: [], nextId: 1 },
-					};
-				}
-
-				default:
-					return {
-						content: [{ type: "text", text: `Unknown action: ${params.action}` }],
-						details: { action: "list", todos: [...todos], nextId, error: `unknown action: ${params.action}` },
-					};
-			}
-		},
-
-		renderCall(args, theme) {
-			let text = theme.fg("toolTitle", theme.bold("todo ")) + theme.fg("muted", String(args.action));
-			if (args.text) text += ` ${theme.fg("dim", `"${args.text}"`)}`;
-			if (args.id !== undefined) text += ` ${theme.fg("accent", `#${args.id}`)}`;
-			return new Text(text, 0, 0);
-		},
-
-		renderResult(result, { expanded }, theme) {
-			const { details } = result;
-			if (!details) {
-				const text = result.content[0];
-				return new Text(text?.type === "text" ? text.text : "", 0, 0);
-			}
-
-			// Error
-			if (details.error) {
-				return new Text(theme.fg("error", `Error: ${details.error}`), 0, 0);
-			}
-
-			const todoList = details.todos;
-
-			switch (details.action) {
-				case "list": {
-					if (todoList.length === 0) {
-						return new Text(theme.fg("dim", "No todos"), 0, 0);
-					}
-					let listText = theme.fg("muted", `${todoList.length} todo(s):`);
-					const display = expanded ? todoList : todoList.slice(0, 5);
-					for (const t of display) {
-						const check = t.done ? theme.fg("success", "✓") : theme.fg("dim", "○");
-						const itemText = t.done ? theme.fg("dim", t.text) : theme.fg("muted", t.text);
-						listText += `\n${check} ${theme.fg("accent", `#${t.id}`)} ${itemText}`;
-					}
-					if (!expanded && todoList.length > 5) {
-						listText += `\n${theme.fg("dim", `... ${todoList.length - 5} more`)}`;
-					}
-					return new Text(listText, 0, 0);
-				}
-
-				case "add": {
-					const added = todoList[todoList.length - 1];
-					return new Text(
-						`${theme.fg("success", "✓ Added ") + theme.fg("accent", `#${added.id}`)} ${theme.fg("muted", added.text)}`,
-						0,
-						0,
-					);
-				}
-
-				case "toggle": {
-					const text = result.content[0];
-					const msg = text?.type === "text" ? text.text : "";
-					return new Text(theme.fg("success", "✓ ") + theme.fg("muted", msg), 0, 0);
-				}
-
-				case "clear":
-					return new Text(theme.fg("success", "✓ ") + theme.fg("muted", "Cleared all todos"), 0, 0);
-			}
-		},
-	};
-
-	return tool;
-};
-
-export default factory;

package/examples/extensions/todo.ts

@@ -1,295 +0,0 @@
-/**
- * Todo Extension - Demonstrates state management via session entries
- *
- * This extension:
- * - Registers a `todo` tool for the LLM to manage todos
- * - Registers a `/todos` command for users to view the list
- *
- * State is stored in tool result details (not external files), which allows
- * proper branching - when you branch, the todo state is automatically
- * correct for that point in history.
- */
-import { StringEnum } from "@oh-my-pi/pi-ai";
-import type { ExtensionAPI, ExtensionContext, Theme } from "@oh-my-pi/pi-coding-agent";
-import { matchesKey, Text, truncateToWidth } from "@oh-my-pi/pi-tui";
-import { Type } from "@sinclair/typebox";
-
-interface Todo {
-	id: number;
-	text: string;
-	done: boolean;
-}
-
-interface TodoDetails {
-	action: "list" | "add" | "toggle" | "clear";
-	todos: Todo[];
-	nextId: number;
-	error?: string;
-}
-
-const TodoParams = Type.Object({
-	action: StringEnum(["list", "add", "toggle", "clear"] as const),
-	text: Type.Optional(Type.String({ description: "Todo text (for add)" })),
-	id: Type.Optional(Type.Number({ description: "Todo ID (for toggle)" })),
-});
-
-/**
- * UI component for the /todos command
- */
-class TodoListComponent {
-	private todos: Todo[];
-	private theme: Theme;
-	private onClose: () => void;
-	private cachedWidth?: number;
-	private cachedLines?: string[];
-
-	constructor(todos: Todo[], theme: Theme, onClose: () => void) {
-		this.todos = todos;
-		this.theme = theme;
-		this.onClose = onClose;
-	}
-
-	handleInput(data: string): void {
-		if (matchesKey(data, "escape") || matchesKey(data, "ctrl+c")) {
-			this.onClose();
-		}
-	}
-
-	render(width: number): string[] {
-		if (this.cachedLines && this.cachedWidth === width) {
-			return this.cachedLines;
-		}
-
-		const lines: string[] = [];
-		const th = this.theme;
-
-		lines.push("");
-		const title = th.fg("accent", " Todos ");
-		const headerLine =
-			th.fg("borderMuted", "─".repeat(3)) + title + th.fg("borderMuted", "─".repeat(Math.max(0, width - 10)));
-		lines.push(truncateToWidth(headerLine, width));
-		lines.push("");
-
-		if (this.todos.length === 0) {
-			lines.push(truncateToWidth(`  ${th.fg("dim", "No todos yet. Ask the agent to add some!")}`, width));
-		} else {
-			const done = this.todos.filter(t => t.done).length;
-			const total = this.todos.length;
-			lines.push(truncateToWidth(`  ${th.fg("muted", `${done}/${total} completed`)}`, width));
-			lines.push("");
-
-			for (const todo of this.todos) {
-				const check = todo.done ? th.fg("success", "✓") : th.fg("dim", "○");
-				const id = th.fg("accent", `#${todo.id}`);
-				const text = todo.done ? th.fg("dim", todo.text) : th.fg("text", todo.text);
-				lines.push(truncateToWidth(`  ${check} ${id} ${text}`, width));
-			}
-		}
-
-		lines.push("");
-		lines.push(truncateToWidth(`  ${th.fg("dim", "Press Escape to close")}`, width));
-		lines.push("");
-
-		this.cachedWidth = width;
-		this.cachedLines = lines;
-		return lines;
-	}
-
-	invalidate(): void {
-		this.cachedWidth = undefined;
-		this.cachedLines = undefined;
-	}
-}
-
-export default function (pi: ExtensionAPI) {
-	// In-memory state (reconstructed from session on load)
-	let todos: Todo[] = [];
-	let nextId = 1;
-
-	/**
-	 * Reconstruct state from session entries.
-	 * Scans tool results for this tool and applies them in order.
-	 */
-	const reconstructState = (ctx: ExtensionContext) => {
-		todos = [];
-		nextId = 1;
-
-		for (const entry of ctx.sessionManager.getBranch()) {
-			if (entry.type !== "message") continue;
-			const msg = (entry as { message?: { role?: string; toolName?: string; details?: unknown } }).message;
-			if (!msg || msg.role !== "toolResult" || msg.toolName !== "todo") continue;
-
-			const details = msg.details as TodoDetails | undefined;
-			if (details) {
-				todos = details.todos;
-				nextId = details.nextId;
-			}
-		}
-	};
-
-	// Reconstruct state on session events
-	pi.on("session_start", async (_event, ctx) => reconstructState(ctx));
-	pi.on("session_switch", async (_event, ctx) => reconstructState(ctx));
-	pi.on("session_branch", async (_event, ctx) => reconstructState(ctx));
-	pi.on("session_tree", async (_event, ctx) => reconstructState(ctx));
-
-	// Register the todo tool for the LLM
-	pi.registerTool({
-		name: "todo",
-		label: "Todo",
-		description: "Manage a todo list. Actions: list, add (text), toggle (id), clear",
-		parameters: TodoParams,
-
-		async execute(_toolCallId, params, _onUpdate, _ctx, _signal) {
-			switch (params.action) {
-				case "list":
-					return {
-						content: [
-							{
-								type: "text",
-								text: todos.length
-									? todos.map(t => `[${t.done ? "x" : " "}] #${t.id}: ${t.text}`).join("\n")
-									: "No todos",
-							},
-						],
-						details: { action: "list", todos: [...todos], nextId } as TodoDetails,
-					};
-
-				case "add": {
-					if (!params.text) {
-						return {
-							content: [{ type: "text", text: "Error: text required for add" }],
-							details: { action: "add", todos: [...todos], nextId, error: "text required" } as TodoDetails,
-						};
-					}
-					const newTodo: Todo = { id: nextId++, text: params.text, done: false };
-					todos.push(newTodo);
-					return {
-						content: [{ type: "text", text: `Added todo #${newTodo.id}: ${newTodo.text}` }],
-						details: { action: "add", todos: [...todos], nextId } as TodoDetails,
-					};
-				}
-
-				case "toggle": {
-					if (params.id === undefined) {
-						return {
-							content: [{ type: "text", text: "Error: id required for toggle" }],
-							details: { action: "toggle", todos: [...todos], nextId, error: "id required" } as TodoDetails,
-						};
-					}
-					const todo = todos.find(t => t.id === params.id);
-					if (!todo) {
-						return {
-							content: [{ type: "text", text: `Todo #${params.id} not found` }],
-							details: {
-								action: "toggle",
-								todos: [...todos],
-								nextId,
-								error: `#${params.id} not found`,
-							} as TodoDetails,
-						};
-					}
-					todo.done = !todo.done;
-					return {
-						content: [{ type: "text", text: `Todo #${todo.id} ${todo.done ? "completed" : "uncompleted"}` }],
-						details: { action: "toggle", todos: [...todos], nextId } as TodoDetails,
-					};
-				}
-
-				case "clear": {
-					const count = todos.length;
-					todos = [];
-					nextId = 1;
-					return {
-						content: [{ type: "text", text: `Cleared ${count} todos` }],
-						details: { action: "clear", todos: [], nextId: 1 } as TodoDetails,
-					};
-				}
-
-				default:
-					return {
-						content: [{ type: "text", text: `Unknown action: ${params.action}` }],
-						details: {
-							action: "list",
-							todos: [...todos],
-							nextId,
-							error: `unknown action: ${params.action}`,
-						} as TodoDetails,
-					};
-			}
-		},
-
-		renderCall(args, theme) {
-			let text = theme.fg("toolTitle", theme.bold("todo ")) + theme.fg("muted", args.action);
-			if (args.text) text += ` ${theme.fg("dim", `"${args.text}"`)}`;
-			if (args.id !== undefined) text += ` ${theme.fg("accent", `#${args.id}`)}`;
-			return new Text(text, 0, 0);
-		},
-
-		renderResult(result, { expanded }, theme) {
-			const details = result.details as TodoDetails | undefined;
-			if (!details) {
-				const text = result.content[0] as { type: string; text?: string } | undefined;
-				return new Text(text?.type === "text" && text.text ? text.text : "", 0, 0);
-			}
-
-			if (details.error) {
-				return new Text(theme.fg("error", `Error: ${details.error}`), 0, 0);
-			}
-
-			const todoList = details.todos;
-
-			switch (details.action) {
-				case "list": {
-					if (todoList.length === 0) {
-						return new Text(theme.fg("dim", "No todos"), 0, 0);
-					}
-					let listText = theme.fg("muted", `${todoList.length} todo(s):`);
-					const display = expanded ? todoList : todoList.slice(0, 5);
-					for (const t of display) {
-						const check = t.done ? theme.fg("success", "✓") : theme.fg("dim", "○");
-						const itemText = t.done ? theme.fg("dim", t.text) : theme.fg("muted", t.text);
-						listText += `\n${check} ${theme.fg("accent", `#${t.id}`)} ${itemText}`;
-					}
-					if (!expanded && todoList.length > 5) {
-						listText += `\n${theme.fg("dim", `... ${todoList.length - 5} more`)}`;
-					}
-					return new Text(listText, 0, 0);
-				}
-
-				case "add": {
-					const added = todoList[todoList.length - 1];
-					return new Text(
-						`${theme.fg("success", "✓ Added ") + theme.fg("accent", `#${added.id}`)} ${theme.fg("muted", added.text)}`,
-						0,
-						0,
-					);
-				}
-
-				case "toggle": {
-					const text = result.content[0] as { type: string; text?: string } | undefined;
-					const msg = text?.type === "text" && text.text ? text.text : "";
-					return new Text(theme.fg("success", "✓ ") + theme.fg("muted", msg), 0, 0);
-				}
-
-				case "clear":
-					return new Text(theme.fg("success", "✓ ") + theme.fg("muted", "Cleared all todos"), 0, 0);
-			}
-		},
-	});
-
-	// Register the /todos command for users
-	pi.registerCommand("todos", {
-		description: "Show all todos on the current branch",
-		handler: async (_args, ctx) => {
-			if (!ctx.hasUI) {
-				ctx.ui.notify("/todos requires interactive mode", "error");
-				return;
-			}
-
-			await ctx.ui.custom<void>((_tui, theme, done) => {
-				return new TodoListComponent(todos, theme, () => done());
-			});
-		},
-	});
-}