pi-openai-toolkit 0.14.4 → 0.14.6

package/src/types.ts

@@ -107,6 +107,12 @@ export type WebSearchConfig = {
 
 export type ImageGenerationConfig = {
 	enabled: boolean;
+	/**
+	 * Bare `image_generation` tool model ids this toolkit may send, without a `provider/` prefix.
+	 * The first entry is the default; `openai_generate_image`'s optional `model` argument may
+	 * select any other entry in this order-preserving list.
+	 */
+	models: string[];
 };
 
 /** `side-effect` reviews bash/write/edit plus extras; `all` reviews every tool call. */
@@ -527,8 +533,13 @@ export const DEFAULT_WEB_SEARCH_CONFIG: WebSearchConfig = {
 	models: [],
 };
 
+/** Single source of truth for the hosted image model used when nothing is configured. */
+export const DEFAULT_IMAGE_GENERATION_MODEL = "gpt-image-2.5";
+export const DEFAULT_IMAGE_GENERATION_MODELS: readonly string[] = [DEFAULT_IMAGE_GENERATION_MODEL];
+
 export const DEFAULT_IMAGE_GENERATION_CONFIG: ImageGenerationConfig = {
 	enabled: false,
+	models: [...DEFAULT_IMAGE_GENERATION_MODELS],
 };
 
 export const DEFAULT_AUTO_MODE_CONFIG: AutoModeConfig = {

package/src/web-search/extension.ts

@@ -1,80 +1,80 @@
-import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
-import { loadToolkitConfig } from "../config";
-import { transformWebSearchPayload } from "./payload";
-import { appendWebSearchPrompt } from "./prompt";
-import { isWebSearchEnabledForModel, type WebSearchModel } from "./types";
-
-function syncLocalWebSearchTool(
-	pi: ExtensionAPI,
-	model: WebSearchModel | undefined,
-	config: Parameters<typeof isWebSearchEnabledForModel>[1],
-	state: { wasActiveBeforeOwnership?: boolean; toolkitOwnsTool: boolean },
-): void {
-	const eligible = isWebSearchEnabledForModel(model, config);
-	const activeTools = pi.getActiveTools();
-
-	if (eligible) {
-		if (!state.toolkitOwnsTool) {
-			state.wasActiveBeforeOwnership = activeTools.includes("web_search");
-			state.toolkitOwnsTool = true;
-		}
-
-		if (activeTools.includes("web_search")) {
-			pi.setActiveTools(activeTools.filter((name) => name !== "web_search"));
-		}
-		return;
-	}
-
-	if (!state.toolkitOwnsTool) return;
-
-	if (state.wasActiveBeforeOwnership && !activeTools.includes("web_search")) {
-		pi.setActiveTools([...activeTools, "web_search"]);
-	}
-	state.wasActiveBeforeOwnership = undefined;
-	state.toolkitOwnsTool = false;
-}
-
-export function registerWebSearchExtension(
-	pi: ExtensionAPI,
-	loadConfig: typeof loadToolkitConfig = loadToolkitConfig,
-): void {
-	const toolState = { wasActiveBeforeOwnership: undefined as boolean | undefined, toolkitOwnsTool: false };
-
-	pi.on("session_start", (_event, ctx) => {
-		const { config } = loadConfig();
-		syncLocalWebSearchTool(pi, ctx.model, config.webSearch, toolState);
-	});
-
-	pi.on("model_select", (event) => {
-		const { config } = loadConfig();
-		syncLocalWebSearchTool(pi, event.model, config.webSearch, toolState);
-	});
-
-	pi.on("before_agent_start", (event, ctx) => {
-		const { config } = loadConfig();
-		syncLocalWebSearchTool(pi, ctx.model, config.webSearch, toolState);
-		const systemPrompt = appendWebSearchPrompt({
-			model: ctx.model,
-			config: config.webSearch,
-			systemPrompt: event.systemPrompt,
-		});
-
-		return systemPrompt === event.systemPrompt ? undefined : { systemPrompt };
-	});
-
-	pi.on("before_provider_request", (event, ctx) => {
-		const { config } = loadConfig();
-		syncLocalWebSearchTool(pi, ctx.model, config.webSearch, toolState);
-		const transformed = transformWebSearchPayload({
-			model: ctx.model,
-			config: config.webSearch,
-			payload: event.payload,
-		});
-
-		return transformed.changed ? transformed.payload : undefined;
-	});
-}
-
-export default function webSearchExtension(pi: ExtensionAPI): void {
-	registerWebSearchExtension(pi);
-}
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { loadToolkitConfig } from "../config";
+import { transformWebSearchPayload } from "./payload";
+import { appendWebSearchPrompt } from "./prompt";
+import { isWebSearchEnabledForModel, type WebSearchModel } from "./types";
+
+function syncLocalWebSearchTool(
+	pi: ExtensionAPI,
+	model: WebSearchModel | undefined,
+	config: Parameters<typeof isWebSearchEnabledForModel>[1],
+	state: { wasActiveBeforeOwnership?: boolean; toolkitOwnsTool: boolean },
+): void {
+	const eligible = isWebSearchEnabledForModel(model, config);
+	const activeTools = pi.getActiveTools();
+
+	if (eligible) {
+		if (!state.toolkitOwnsTool) {
+			state.wasActiveBeforeOwnership = activeTools.includes("web_search");
+			state.toolkitOwnsTool = true;
+		}
+
+		if (activeTools.includes("web_search")) {
+			pi.setActiveTools(activeTools.filter((name) => name !== "web_search"));
+		}
+		return;
+	}
+
+	if (!state.toolkitOwnsTool) return;
+
+	if (state.wasActiveBeforeOwnership && !activeTools.includes("web_search")) {
+		pi.setActiveTools([...activeTools, "web_search"]);
+	}
+	state.wasActiveBeforeOwnership = undefined;
+	state.toolkitOwnsTool = false;
+}
+
+export function registerWebSearchExtension(
+	pi: ExtensionAPI,
+	loadConfig: typeof loadToolkitConfig = loadToolkitConfig,
+): void {
+	const toolState = { wasActiveBeforeOwnership: undefined as boolean | undefined, toolkitOwnsTool: false };
+
+	pi.on("session_start", (_event, ctx) => {
+		const { config } = loadConfig();
+		syncLocalWebSearchTool(pi, ctx.model, config.webSearch, toolState);
+	});
+
+	pi.on("model_select", (event) => {
+		const { config } = loadConfig();
+		syncLocalWebSearchTool(pi, event.model, config.webSearch, toolState);
+	});
+
+	pi.on("before_agent_start", (event, ctx) => {
+		const { config } = loadConfig();
+		syncLocalWebSearchTool(pi, ctx.model, config.webSearch, toolState);
+		const systemPrompt = appendWebSearchPrompt({
+			model: ctx.model,
+			config: config.webSearch,
+			systemPrompt: event.systemPrompt,
+		});
+
+		return systemPrompt === event.systemPrompt ? undefined : { systemPrompt };
+	});
+
+	pi.on("before_provider_request", (event, ctx) => {
+		const { config } = loadConfig();
+		syncLocalWebSearchTool(pi, ctx.model, config.webSearch, toolState);
+		const transformed = transformWebSearchPayload({
+			model: ctx.model,
+			config: config.webSearch,
+			payload: event.payload,
+		});
+
+		return transformed.changed ? transformed.payload : undefined;
+	});
+}
+
+export default function webSearchExtension(pi: ExtensionAPI): void {
+	registerWebSearchExtension(pi);
+}

package/src/web-search/payload.ts

@@ -1,96 +1,96 @@
-import type { WebSearchConfig } from "../types";
-import {
-	WEB_SEARCH_SOURCE_INCLUDE,
-	isWebSearchEnabledForModel,
-	type WebSearchModel,
-	type WebSearchPayloadTransform,
-} from "./types";
-
-type JsonObject = Record<string, unknown>;
-
-function isRecord(value: unknown): value is JsonObject {
-	return !!value && typeof value === "object" && !Array.isArray(value);
-}
-
-function isLocalWebSearchFunction(tool: unknown): boolean {
-	return isRecord(tool) && tool.type === "function" && tool.name === "web_search";
-}
-
-function isNativeWebSearchTool(tool: unknown): boolean {
-	return isRecord(tool) && (tool.type === "web_search" || tool.type === "web_search_preview");
-}
-
-export function transformWebSearchPayload(args: {
-	model: WebSearchModel | undefined;
-	config: WebSearchConfig;
-	payload: unknown;
-}): WebSearchPayloadTransform {
-	const { model, config, payload } = args;
-	if (!config.enabled) {
-		return { payload, outcome: "disabled", changed: false };
-	}
-	if (!isWebSearchEnabledForModel(model, config)) {
-		return { payload, outcome: "unsupported-model", changed: false };
-	}
-	if (!isRecord(payload)) {
-		return { payload, outcome: "non-object-payload", changed: false };
-	}
-
-	const toolsValue = payload.tools;
-	if (toolsValue !== undefined && !Array.isArray(toolsValue)) {
-		return { payload, outcome: "invalid-tools", changed: false };
-	}
-	const tools = toolsValue ?? [];
-	const includeValue = payload.include;
-	if (includeValue !== undefined && !Array.isArray(includeValue)) {
-		return { payload, outcome: "invalid-include", changed: false };
-	}
-	const include = includeValue ?? [];
-	const normalizedTools: unknown[] = [];
-	let nativeToolCount = 0;
-	let localToolRemoved = false;
-	for (const tool of tools) {
-		if (isLocalWebSearchFunction(tool)) {
-			localToolRemoved = true;
-			continue;
-		}
-		if (isNativeWebSearchTool(tool)) {
-			nativeToolCount += 1;
-			if (nativeToolCount > 1) continue;
-		}
-		normalizedTools.push(tool);
-	}
-	const hasNativeTool = nativeToolCount > 0;
-	if (!hasNativeTool) {
-		normalizedTools.push({ type: "web_search" });
-	}
-
-	const normalizedInclude: unknown[] = [];
-	let sourceIncludeCount = 0;
-	for (const item of include) {
-		if (item === WEB_SEARCH_SOURCE_INCLUDE) {
-			sourceIncludeCount += 1;
-			if (sourceIncludeCount > 1) continue;
-		}
-		normalizedInclude.push(item);
-	}
-	if (sourceIncludeCount === 0) {
-		normalizedInclude.push(WEB_SEARCH_SOURCE_INCLUDE);
-	}
-
-	const toolsChanged = localToolRemoved || !hasNativeTool || nativeToolCount > 1;
-	const includeChanged = sourceIncludeCount !== 1;
-	if (!toolsChanged && !includeChanged) {
-		return { payload, outcome: "existing-native-tool", changed: false };
-	}
-
-	return {
-		payload: {
-			...payload,
-			...(toolsChanged ? { tools: normalizedTools } : {}),
-			...(includeChanged ? { include: normalizedInclude } : {}),
-		},
-		outcome: hasNativeTool ? "existing-native-tool" : "injected-native-tool",
-		changed: true,
-	};
-}
+import type { WebSearchConfig } from "../types";
+import {
+	WEB_SEARCH_SOURCE_INCLUDE,
+	isWebSearchEnabledForModel,
+	type WebSearchModel,
+	type WebSearchPayloadTransform,
+} from "./types";
+
+type JsonObject = Record<string, unknown>;
+
+function isRecord(value: unknown): value is JsonObject {
+	return !!value && typeof value === "object" && !Array.isArray(value);
+}
+
+function isLocalWebSearchFunction(tool: unknown): boolean {
+	return isRecord(tool) && tool.type === "function" && tool.name === "web_search";
+}
+
+function isNativeWebSearchTool(tool: unknown): boolean {
+	return isRecord(tool) && (tool.type === "web_search" || tool.type === "web_search_preview");
+}
+
+export function transformWebSearchPayload(args: {
+	model: WebSearchModel | undefined;
+	config: WebSearchConfig;
+	payload: unknown;
+}): WebSearchPayloadTransform {
+	const { model, config, payload } = args;
+	if (!config.enabled) {
+		return { payload, outcome: "disabled", changed: false };
+	}
+	if (!isWebSearchEnabledForModel(model, config)) {
+		return { payload, outcome: "unsupported-model", changed: false };
+	}
+	if (!isRecord(payload)) {
+		return { payload, outcome: "non-object-payload", changed: false };
+	}
+
+	const toolsValue = payload.tools;
+	if (toolsValue !== undefined && !Array.isArray(toolsValue)) {
+		return { payload, outcome: "invalid-tools", changed: false };
+	}
+	const tools = toolsValue ?? [];
+	const includeValue = payload.include;
+	if (includeValue !== undefined && !Array.isArray(includeValue)) {
+		return { payload, outcome: "invalid-include", changed: false };
+	}
+	const include = includeValue ?? [];
+	const normalizedTools: unknown[] = [];
+	let nativeToolCount = 0;
+	let localToolRemoved = false;
+	for (const tool of tools) {
+		if (isLocalWebSearchFunction(tool)) {
+			localToolRemoved = true;
+			continue;
+		}
+		if (isNativeWebSearchTool(tool)) {
+			nativeToolCount += 1;
+			if (nativeToolCount > 1) continue;
+		}
+		normalizedTools.push(tool);
+	}
+	const hasNativeTool = nativeToolCount > 0;
+	if (!hasNativeTool) {
+		normalizedTools.push({ type: "web_search" });
+	}
+
+	const normalizedInclude: unknown[] = [];
+	let sourceIncludeCount = 0;
+	for (const item of include) {
+		if (item === WEB_SEARCH_SOURCE_INCLUDE) {
+			sourceIncludeCount += 1;
+			if (sourceIncludeCount > 1) continue;
+		}
+		normalizedInclude.push(item);
+	}
+	if (sourceIncludeCount === 0) {
+		normalizedInclude.push(WEB_SEARCH_SOURCE_INCLUDE);
+	}
+
+	const toolsChanged = localToolRemoved || !hasNativeTool || nativeToolCount > 1;
+	const includeChanged = sourceIncludeCount !== 1;
+	if (!toolsChanged && !includeChanged) {
+		return { payload, outcome: "existing-native-tool", changed: false };
+	}
+
+	return {
+		payload: {
+			...payload,
+			...(toolsChanged ? { tools: normalizedTools } : {}),
+			...(includeChanged ? { include: normalizedInclude } : {}),
+		},
+		outcome: hasNativeTool ? "existing-native-tool" : "injected-native-tool",
+		changed: true,
+	};
+}

package/src/web-search/prompt.ts

@@ -1,20 +1,20 @@
-import type { WebSearchConfig } from "../types";
-import { isWebSearchEnabledForModel, WEB_SEARCH_PROMPT_MARKER, type WebSearchModel } from "./types";
-
-export const WEB_SEARCH_PROMPT_SECTION = `${WEB_SEARCH_PROMPT_MARKER}
-## Web Search
-
-The hosted \`web_search\` tool is part of your tool list for this model. The API executes it server-side: it is a real callable tool even though no client-side function schema or description accompanies it. Call it whenever current or online information matters instead of guessing, cite the returned sources in the answer, and never claim that web search or internet access is unavailable while this section is present.`;
-
-export function appendWebSearchPrompt(args: {
-	model: WebSearchModel | undefined;
-	config: WebSearchConfig;
-	systemPrompt: string;
-}): string {
-	const { model, config, systemPrompt } = args;
-	if (!isWebSearchEnabledForModel(model, config) || systemPrompt.includes(WEB_SEARCH_PROMPT_MARKER)) {
-		return systemPrompt;
-	}
-
-	return `${systemPrompt.trimEnd()}\n\n${WEB_SEARCH_PROMPT_SECTION}`;
-}
+import type { WebSearchConfig } from "../types";
+import { isWebSearchEnabledForModel, WEB_SEARCH_PROMPT_MARKER, type WebSearchModel } from "./types";
+
+export const WEB_SEARCH_PROMPT_SECTION = `${WEB_SEARCH_PROMPT_MARKER}
+## Web Search
+
+The hosted \`web_search\` tool is part of your tool list for this model. The API executes it server-side: it is a real callable tool even though no client-side function schema or description accompanies it. Call it whenever current or online information matters instead of guessing, cite the returned sources in the answer, and never claim that web search or internet access is unavailable while this section is present.`;
+
+export function appendWebSearchPrompt(args: {
+	model: WebSearchModel | undefined;
+	config: WebSearchConfig;
+	systemPrompt: string;
+}): string {
+	const { model, config, systemPrompt } = args;
+	if (!isWebSearchEnabledForModel(model, config) || systemPrompt.includes(WEB_SEARCH_PROMPT_MARKER)) {
+		return systemPrompt;
+	}
+
+	return `${systemPrompt.trimEnd()}\n\n${WEB_SEARCH_PROMPT_SECTION}`;
+}

package/src/web-search/types.ts

@@ -1,45 +1,45 @@
-import { getExactModelKey, isExactModelAllowed } from "../model-scope";
-import type { WebSearchConfig } from "../types";
-
-export const WEB_SEARCH_CAPABLE_APIS = ["openai-responses", "openai-codex-responses"] as const;
-export const WEB_SEARCH_SOURCE_INCLUDE = "web_search_call.action.sources";
-export const WEB_SEARCH_PROMPT_MARKER = "<!-- pi-openai-toolkit:web-search -->";
-
-export type WebSearchCapableApi = (typeof WEB_SEARCH_CAPABLE_APIS)[number];
-
-export type WebSearchModel = {
-	api?: string;
-	provider?: string;
-	id?: string;
-};
-
-export type WebSearchPayloadOutcome =
-	| "disabled"
-	| "unsupported-model"
-	| "non-object-payload"
-	| "invalid-tools"
-	| "invalid-include"
-	| "existing-native-tool"
-	| "injected-native-tool";
-
-export type WebSearchPayloadTransform = {
-	payload: unknown;
-	outcome: WebSearchPayloadOutcome;
-	changed: boolean;
-};
-
-export function getWebSearchModelKey(model: WebSearchModel | undefined): string | undefined {
-	return getExactModelKey(model);
-}
-
-export function isWebSearchEnabledForModel(
-	model: WebSearchModel | undefined,
-	config: WebSearchConfig,
-): boolean {
-	return (
-		config.enabled &&
-		typeof model?.api === "string" &&
-		(WEB_SEARCH_CAPABLE_APIS as readonly string[]).includes(model.api) &&
-		isExactModelAllowed(model, config.models)
-	);
-}
+import { getExactModelKey, isExactModelAllowed } from "../model-scope";
+import type { WebSearchConfig } from "../types";
+
+export const WEB_SEARCH_CAPABLE_APIS = ["openai-responses", "openai-codex-responses"] as const;
+export const WEB_SEARCH_SOURCE_INCLUDE = "web_search_call.action.sources";
+export const WEB_SEARCH_PROMPT_MARKER = "<!-- pi-openai-toolkit:web-search -->";
+
+export type WebSearchCapableApi = (typeof WEB_SEARCH_CAPABLE_APIS)[number];
+
+export type WebSearchModel = {
+	api?: string;
+	provider?: string;
+	id?: string;
+};
+
+export type WebSearchPayloadOutcome =
+	| "disabled"
+	| "unsupported-model"
+	| "non-object-payload"
+	| "invalid-tools"
+	| "invalid-include"
+	| "existing-native-tool"
+	| "injected-native-tool";
+
+export type WebSearchPayloadTransform = {
+	payload: unknown;
+	outcome: WebSearchPayloadOutcome;
+	changed: boolean;
+};
+
+export function getWebSearchModelKey(model: WebSearchModel | undefined): string | undefined {
+	return getExactModelKey(model);
+}
+
+export function isWebSearchEnabledForModel(
+	model: WebSearchModel | undefined,
+	config: WebSearchConfig,
+): boolean {
+	return (
+		config.enabled &&
+		typeof model?.api === "string" &&
+		(WEB_SEARCH_CAPABLE_APIS as readonly string[]).includes(model.api) &&
+		isExactModelAllowed(model, config.models)
+	);
+}