pi-openai-toolkit 0.14.4 → 0.14.5

package/src/context-management/types.ts

@@ -1,161 +1,161 @@
-import type { ContextManagementMode } from "../types";
-
-export type { ContextManagementMode };
-
-export const CONTEXT_MANAGEMENT_PROTOCOL = 1 as const;
-export const CODEX_CONTEXT_WINDOW_MESSAGE_TYPE = "codex-context-window" as const;
-export const CONTEXT_WINDOW_COMPACTION_STRATEGY = "codex-context-window" as const;
-export const CONTEXT_WINDOW_REMINDER_THRESHOLD = 6_144;
-export const CONTEXT_WINDOW_FALLBACK_BUFFER = 16_384;
-
-export type ContextManagementMessageKind = "window" | "reminder" | "fallback";
-
-export type ContextWindowIdentity = {
-	firstWindowId: string;
-	currentWindowId: string;
-	previousWindowId?: string;
-	windowNumber: number;
-};
-
-export type CodexContextManagementMessageDetails = {
-	protocol: typeof CONTEXT_MANAGEMENT_PROTOCOL;
-	id: string;
-	sessionId?: string;
-	contextManagement: ContextWindowIdentity & {
-		protocol: typeof CONTEXT_MANAGEMENT_PROTOCOL;
-		kind: ContextManagementMessageKind;
-		trimPreviousWindow?: true;
-	};
-};
-
-export type ContextWindowCompactionDetails = {
-	protocol: typeof CONTEXT_MANAGEMENT_PROTOCOL;
-	strategy: typeof CONTEXT_WINDOW_COMPACTION_STRATEGY;
-	windowId?: string;
-};
-
-export type RemoteContextFailureReason =
-	| "context-management-inactive"
-	| "unsupported-model"
-	| "unsupported-api"
-	| "unsupported-backend"
-	| "auth-resolution-failed"
-	| "missing-token"
-	| "missing-api-key"
-	| "missing-account-id"
-	| "missing-base-url"
-	| "invalid-account-token"
-	| "backend-timeout"
-	| "aborted"
-	| "http-error"
-	| "invalid-json"
-	| "invalid-response"
-	| "protocol-error";
-
-export type NativeCodexContextProvider = {
-	kind: "native-codex";
-	route: "openai-codex";
-	provider: "openai-codex";
-	api: "openai-codex-responses";
-	model: string;
-	baseUrl: string;
-	token: string;
-	accountId: string;
-	headers: Record<string, string>;
-};
-
-export type GatewayCodexContextProvider = {
-	kind: "codex-gateway";
-	route: "codex-gateway";
-	/** Operator-defined provider name; matched via compaction.gatewayContextModels. */
-	provider: string;
-	api: "openai-responses";
-	model: string;
-	baseUrl: string;
-	apiKey: string;
-	headers: Record<string, string>;
-};
-
-export type CodexContextProvider = NativeCodexContextProvider | GatewayCodexContextProvider;
-
-export type CodexContextProviderResolution =
-	| { ok: true; provider: CodexContextProvider }
-	| {
-			ok: false;
-			reason: RemoteContextFailureReason;
-			provider?: string;
-			api?: string;
-			model?: string;
-			baseUrl?: string;
-		};
-
-export type HistoryAction =
-	| "list_windows"
-	| "list_items"
-	| "read_item"
-	| "search_contents";
-
-export type NotesAction =
-	| "list_files_by_prefix"
-	| "read_file"
-	| "search_contents"
-	| "append_to_file"
-	| "write_file";
-
-export type HistoryNotesResponse = Record<string, unknown>;
-
-export type HistoryNotesResult =
-	| { ok: true; value: HistoryNotesResponse }
-	| {
-			ok: false;
-			reason: Exclude<RemoteContextFailureReason, "context-management-inactive" | "unsupported-model" | "unsupported-api">;
-			status?: number;
-		};
-
-export function isRecord(value: unknown): value is Record<string, unknown> {
-	return Boolean(value && typeof value === "object" && !Array.isArray(value));
-}
-
-export function isNonEmptyString(value: unknown): value is string {
-	return typeof value === "string" && value.trim().length > 0;
-}
-
-export function isContextWindowIdentity(value: unknown): value is ContextWindowIdentity {
-	if (!isRecord(value)) return false;
-	return (
-		isNonEmptyString(value.firstWindowId) &&
-		isNonEmptyString(value.currentWindowId) &&
-		(value.previousWindowId === undefined || isNonEmptyString(value.previousWindowId)) &&
-		Number.isInteger(value.windowNumber) &&
-		(value.windowNumber as number) >= 0
-	);
-}
-
-export function isCodexContextManagementMessageDetails(
-	value: unknown,
-): value is CodexContextManagementMessageDetails {
-	if (!isRecord(value) || value.protocol !== CONTEXT_MANAGEMENT_PROTOCOL || !isNonEmptyString(value.id)) {
-		return false;
-	}
-	if (value.sessionId !== undefined && !isNonEmptyString(value.sessionId)) return false;
-	if (!isRecord(value.contextManagement) || value.contextManagement.protocol !== CONTEXT_MANAGEMENT_PROTOCOL) {
-		return false;
-	}
-	const context = value.contextManagement;
-	if (!isRecord(context)) return false;
-	const trimPreviousWindow = context.trimPreviousWindow;
-	return (
-		(context.kind === "window" || context.kind === "reminder" || context.kind === "fallback") &&
-		isContextWindowIdentity(context) &&
-		(trimPreviousWindow === undefined || trimPreviousWindow === true)
-	);
-}
-
-export function isContextWindowCompactionDetails(value: unknown): value is ContextWindowCompactionDetails {
-	return (
-		isRecord(value) &&
-		value.protocol === CONTEXT_MANAGEMENT_PROTOCOL &&
-		value.strategy === CONTEXT_WINDOW_COMPACTION_STRATEGY &&
-		(value.windowId === undefined || isNonEmptyString(value.windowId))
-	);
-}
+import type { ContextManagementMode } from "../types";
+
+export type { ContextManagementMode };
+
+export const CONTEXT_MANAGEMENT_PROTOCOL = 1 as const;
+export const CODEX_CONTEXT_WINDOW_MESSAGE_TYPE = "codex-context-window" as const;
+export const CONTEXT_WINDOW_COMPACTION_STRATEGY = "codex-context-window" as const;
+export const CONTEXT_WINDOW_REMINDER_THRESHOLD = 6_144;
+export const CONTEXT_WINDOW_FALLBACK_BUFFER = 16_384;
+
+export type ContextManagementMessageKind = "window" | "reminder" | "fallback";
+
+export type ContextWindowIdentity = {
+	firstWindowId: string;
+	currentWindowId: string;
+	previousWindowId?: string;
+	windowNumber: number;
+};
+
+export type CodexContextManagementMessageDetails = {
+	protocol: typeof CONTEXT_MANAGEMENT_PROTOCOL;
+	id: string;
+	sessionId?: string;
+	contextManagement: ContextWindowIdentity & {
+		protocol: typeof CONTEXT_MANAGEMENT_PROTOCOL;
+		kind: ContextManagementMessageKind;
+		trimPreviousWindow?: true;
+	};
+};
+
+export type ContextWindowCompactionDetails = {
+	protocol: typeof CONTEXT_MANAGEMENT_PROTOCOL;
+	strategy: typeof CONTEXT_WINDOW_COMPACTION_STRATEGY;
+	windowId?: string;
+};
+
+export type RemoteContextFailureReason =
+	| "context-management-inactive"
+	| "unsupported-model"
+	| "unsupported-api"
+	| "unsupported-backend"
+	| "auth-resolution-failed"
+	| "missing-token"
+	| "missing-api-key"
+	| "missing-account-id"
+	| "missing-base-url"
+	| "invalid-account-token"
+	| "backend-timeout"
+	| "aborted"
+	| "http-error"
+	| "invalid-json"
+	| "invalid-response"
+	| "protocol-error";
+
+export type NativeCodexContextProvider = {
+	kind: "native-codex";
+	route: "openai-codex";
+	provider: "openai-codex";
+	api: "openai-codex-responses";
+	model: string;
+	baseUrl: string;
+	token: string;
+	accountId: string;
+	headers: Record<string, string>;
+};
+
+export type GatewayCodexContextProvider = {
+	kind: "codex-gateway";
+	route: "codex-gateway";
+	/** Operator-defined provider name; matched via compaction.gatewayContextModels. */
+	provider: string;
+	api: "openai-responses";
+	model: string;
+	baseUrl: string;
+	apiKey: string;
+	headers: Record<string, string>;
+};
+
+export type CodexContextProvider = NativeCodexContextProvider | GatewayCodexContextProvider;
+
+export type CodexContextProviderResolution =
+	| { ok: true; provider: CodexContextProvider }
+	| {
+			ok: false;
+			reason: RemoteContextFailureReason;
+			provider?: string;
+			api?: string;
+			model?: string;
+			baseUrl?: string;
+		};
+
+export type HistoryAction =
+	| "list_windows"
+	| "list_items"
+	| "read_item"
+	| "search_contents";
+
+export type NotesAction =
+	| "list_files_by_prefix"
+	| "read_file"
+	| "search_contents"
+	| "append_to_file"
+	| "write_file";
+
+export type HistoryNotesResponse = Record<string, unknown>;
+
+export type HistoryNotesResult =
+	| { ok: true; value: HistoryNotesResponse }
+	| {
+			ok: false;
+			reason: Exclude<RemoteContextFailureReason, "context-management-inactive" | "unsupported-model" | "unsupported-api">;
+			status?: number;
+		};
+
+export function isRecord(value: unknown): value is Record<string, unknown> {
+	return Boolean(value && typeof value === "object" && !Array.isArray(value));
+}
+
+export function isNonEmptyString(value: unknown): value is string {
+	return typeof value === "string" && value.trim().length > 0;
+}
+
+export function isContextWindowIdentity(value: unknown): value is ContextWindowIdentity {
+	if (!isRecord(value)) return false;
+	return (
+		isNonEmptyString(value.firstWindowId) &&
+		isNonEmptyString(value.currentWindowId) &&
+		(value.previousWindowId === undefined || isNonEmptyString(value.previousWindowId)) &&
+		Number.isInteger(value.windowNumber) &&
+		(value.windowNumber as number) >= 0
+	);
+}
+
+export function isCodexContextManagementMessageDetails(
+	value: unknown,
+): value is CodexContextManagementMessageDetails {
+	if (!isRecord(value) || value.protocol !== CONTEXT_MANAGEMENT_PROTOCOL || !isNonEmptyString(value.id)) {
+		return false;
+	}
+	if (value.sessionId !== undefined && !isNonEmptyString(value.sessionId)) return false;
+	if (!isRecord(value.contextManagement) || value.contextManagement.protocol !== CONTEXT_MANAGEMENT_PROTOCOL) {
+		return false;
+	}
+	const context = value.contextManagement;
+	if (!isRecord(context)) return false;
+	const trimPreviousWindow = context.trimPreviousWindow;
+	return (
+		(context.kind === "window" || context.kind === "reminder" || context.kind === "fallback") &&
+		isContextWindowIdentity(context) &&
+		(trimPreviousWindow === undefined || trimPreviousWindow === true)
+	);
+}
+
+export function isContextWindowCompactionDetails(value: unknown): value is ContextWindowCompactionDetails {
+	return (
+		isRecord(value) &&
+		value.protocol === CONTEXT_MANAGEMENT_PROTOCOL &&
+		value.strategy === CONTEXT_WINDOW_COMPACTION_STRATEGY &&
+		(value.windowId === undefined || isNonEmptyString(value.windowId))
+	);
+}

package/src/image-generation/extension.ts

@@ -8,6 +8,7 @@ import {
 	IMAGE_GENERATION_QUALITIES,
 	IMAGE_GENERATION_SIZES,
 	IMAGE_GENERATION_TOOL_NAME,
+	MAX_IMAGE_MODEL_ID_CHARS,
 	MAX_IMAGE_PATH_CHARS,
 	MAX_IMAGE_PROMPT_CHARS,
 	MAX_REFERENCE_IMAGE_COUNT,
@@ -65,6 +66,21 @@ const GenerateImageParameters = Type.Object(
 				description: "Requested image quality, or auto.",
 			}),
 		),
+		model: Type.Optional(
+			Type.Union(
+				[
+					Type.Null(),
+					Type.String({
+						minLength: 1,
+						maxLength: MAX_IMAGE_MODEL_ID_CHARS,
+					}),
+				],
+				{
+					description:
+						"Use null to accept the default image model, which is the first entry of imageGeneration.models; otherwise provide another model id exactly as it appears in that configured list.",
+				},
+			),
+		),
 	},
 	{ additionalProperties: false },
 );
@@ -98,14 +114,15 @@ export function registerImageGenerationExtension(
 		name: IMAGE_GENERATION_TOOL_NAME,
 		label: "OpenAI Generate Image",
 		description:
-			"Generate a PNG image, or edit from one to five user-approved local reference images, through the current Responses-capable model and the hosted gpt-image-2 image_generation tool. This is a paid provider operation.",
-		promptSnippet: "Generate or edit PNG images through the current Responses-capable model and gpt-image-2.",
+			"Generate a PNG image, or edit from one to five user-approved local reference images, through the current Responses-capable model and a configured hosted image_generation model. This is a paid provider operation.",
+		promptSnippet: "Generate or edit PNG images through the current Responses-capable model and a configured imageGeneration.models entry.",
 		promptGuidelines: [
 			"Use openai_generate_image when the user explicitly asks to create, draw, render, or edit a raster image and the active model speaks a Responses API.",
 			"Do not call openai_generate_image speculatively: it consumes the user's provider or gateway image quota.",
 			"Keep the image prompt faithful to the user's requested subject and constraints; do not invent unrequested style details.",
 			"Set referenceImagePaths to null unless the user explicitly identified local files; never invent paths or placeholder strings, and remember upload requires user approval.",
 			"Set outputPath to null unless the user explicitly asks for a destination; never invent a destination or placeholder string, and otherwise use the default Pi agent artifact.",
+			"Set model to null unless the user named an image model configured in imageGeneration.models; never invent or guess a model id, and remember an unlisted model fails before the paid request.",
 			"Do not substitute Python, browser automation, shell scripts, or unrelated image tools for an eligible image request.",
 		],
 		parameters: GenerateImageParameters,