pi-openai-toolkit 0.23.2 → 0.24.1

package/src/responses-headers.ts

@@ -1,180 +1,180 @@
-import type { ProviderHeaders } from "@earendil-works/pi-ai";
-import { mergeProviderHeaders } from "./provider-headers";
-
-export const CODEX_AFFINITY_SCOPE = "codex-session-v1" as const;
-export const CODEX_GATEWAY_ORIGINATOR = "codex_cli_rs" as const;
-
-/** Headers permitted from Pi/provider configuration onto the gateway hop. */
-export const CODEX_GATEWAY_FORWARD_HEADERS = [
-	"accept",
-	"content-type",
-	"session-id",
-	"thread-id",
-	"x-parent-session-id",
-	"x-codex-parent-thread-id",
-	"x-client-request-id",
-	"x-codex-model",
-	"x-codex-affinity-scope",
-	"x-codex-window-id",
-	"x-codex-turn-metadata",
-	"x-codex-beta-features",
-	"x-openai-encrypted-tool-arguments",
-	"x-openai-tool-output-truncation-policy",
-	"x-openai-internal-codex-responses-lite",
-	"version",
-	"originator",
-	"user-agent",
-] as const;
-
-const CODEX_GATEWAY_FORWARD_HEADER_SET = new Set<string>(CODEX_GATEWAY_FORWARD_HEADERS);
-
-export function filterCodexGatewayHeaders(headers: ProviderHeaders | undefined): Record<string, string> {
-	const result: Record<string, string> = {};
-	for (const [name, value] of Object.entries(headers ?? {})) {
-		if (typeof value !== "string" || !CODEX_GATEWAY_FORWARD_HEADER_SET.has(name.toLowerCase())) continue;
-		result[name] = value;
-	}
-	return result;
-}
-
-export type CodexAffinity = {
-	/** Bare model id used by the gateway route selector, never provider/model. */
-	model: string;
-	scope: typeof CODEX_AFFINITY_SCOPE;
-};
-
-export type ResponsesHeaderRuntime = {
-	api: string;
-	apiKey: string;
-	headers?: ProviderHeaders;
-	sessionId?: string;
-	/** Opt-in gateway Codex routing metadata for synthetic requests. */
-	codexAffinity?: CodexAffinity;
-	currentModel: {
-		headers?: ProviderHeaders;
-	};
-};
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-	return !!value && typeof value === "object" && !Array.isArray(value);
-}
-
-function decodeJwtPayload(token: string): Record<string, unknown> | undefined {
-	const parts = token.split(".");
-	if (parts.length !== 3) return undefined;
-	try {
-		const payload = JSON.parse(Buffer.from(parts[1]!, "base64url").toString("utf8")) as unknown;
-		return isRecord(payload) ? payload : undefined;
-	} catch {
-		return undefined;
-	}
-}
-
-function extractCodexAccountId(token: string): string | undefined {
-	const authClaims = decodeJwtPayload(token)?.["https://api.openai.com/auth"];
-	if (!isRecord(authClaims)) return undefined;
-	const accountId = authClaims.chatgpt_account_id;
-	return typeof accountId === "string" && accountId.trim() ? accountId.trim() : undefined;
-}
-
-function buildCodexUserAgent(): string {
-	const platform = typeof process !== "undefined" ? process.platform : "browser";
-	const arch = typeof process !== "undefined" ? process.arch : "unknown";
-	return `pi (${platform}; ${arch})`;
-}
-
-export function buildCodexCliUserAgent(version: string): string {
-	const platform = typeof process !== "undefined" ? process.platform : "browser";
-	const arch = typeof process !== "undefined" ? process.arch : "unknown";
-	return `codex_cli_rs/${version} (${platform}; ${arch})`;
-}
-
-/**
- * Codex client identity used by synthetic gateway requests in their User-Agent.
- * Native live and context-management requests do not generate a `version`
- * header; explicitly configured provider values remain caller-owned.
- */
-export const CODEX_CLIENT_VERSION = "0.153.0";
-
-/** Prompt cache keys are clamped by the same host rule (`OPENAI_PROMPT_CACHE_KEY_MAX_LENGTH`). */
-const CODEX_SESSION_ID_MAX_LENGTH = 64;
-
-export function clampCodexSessionId(sessionId: string | undefined): string | undefined {
-	if (!sessionId) return undefined;
-	const chars = Array.from(sessionId);
-	return chars.length <= CODEX_SESSION_ID_MAX_LENGTH ? sessionId : chars.slice(0, CODEX_SESSION_ID_MAX_LENGTH).join("");
-}
-
-export type ResponsesHeaderOptions = {
-	accept: string;
-	/** `null` omits content-type so a multipart FormData body can set its boundary. */
-	contentType?: string | null;
-	/** Conversation identity for Codex cache-affinity headers; clamped to 64 chars here. */
-	sessionId?: string;
-};
-
-export function buildResponsesRequestHeaders(
-	runtime: ResponsesHeaderRuntime,
-	options: ResponsesHeaderOptions,
-): Headers {
-	const mergedHeaders = mergeProviderHeaders(runtime.currentModel.headers, runtime.headers);
-	const headers = new Headers(
-		runtime.codexAffinity ? filterCodexGatewayHeaders(mergedHeaders) : mergedHeaders,
-	);
-	headers.set("accept", options.accept);
-	if (options.contentType === null) {
-		headers.delete("content-type");
-	} else {
-		headers.set("content-type", options.contentType ?? "application/json");
-	}
-	if (runtime.api === "azure-openai-responses") {
-		// Azure OpenAI authenticates Responses requests with `api-key`; do not
-		// forward an inherited bearer token from a model/provider header.
-		headers.delete("authorization");
-		headers.set("api-key", runtime.apiKey);
-	} else if (!headers.has("authorization")) {
-		headers.set("authorization", `Bearer ${runtime.apiKey}`);
-	}
-
-	const isNativeCodex = runtime.api === "openai-codex-responses";
-	const gatewayAffinity = runtime.codexAffinity;
-	if (isNativeCodex || gatewayAffinity) {
-		if (gatewayAffinity) {
-			// A gateway request must use the configured data-plane key, never an
-			// inherited OAuth/account header from the model registry.
-			headers.set("authorization", `Bearer ${runtime.apiKey}`);
-			headers.delete("chatgpt-account-id");
-			headers.delete("cookie");
-			headers.delete("x-api-key");
-			headers.set("originator", CODEX_GATEWAY_ORIGINATOR);
-			headers.set("user-agent", buildCodexCliUserAgent(CODEX_CLIENT_VERSION));
-			headers.set("x-codex-affinity-scope", gatewayAffinity.scope);
-			headers.set("x-codex-model", gatewayAffinity.model);
-		} else {
-			const accountId = extractCodexAccountId(runtime.apiKey);
-			if (accountId) headers.set("chatgpt-account-id", accountId);
-			headers.set("originator", "pi");
-			headers.set("user-agent", buildCodexUserAgent());
-			headers.set("openai-beta", "responses=experimental");
-		}
-		// Gateways own their version policy. Explicit versions still pass through
-		// the header merge and allowlist, but Toolkit does not generate one.
-		// Prompt-cache/session affinity rides on the conversation identity. The
-		// gateway path also uses the bare model hint above so NEWapi can route
-		// context/compact requests without inspecting their body.
-		const sessionId = clampCodexSessionId(options.sessionId ?? runtime.sessionId);
-		if (sessionId) {
-			// Header names match the installed host's live-request builder
-			// (`buildSSEHeaders`: `session-id` + `x-client-request-id`) so our
-			// synthetic requests land in the same conversation affinity group.
-			headers.set("session-id", sessionId);
-			headers.set("x-client-request-id", sessionId);
-		}
-	}
-
-	return headers;
-}
-
-export const _responsesHeadersTest = {
-	extractCodexAccountId,
-};
+import type { ProviderHeaders } from "@earendil-works/pi-ai";
+import { mergeProviderHeaders } from "./provider-headers";
+
+export const CODEX_AFFINITY_SCOPE = "codex-session-v1" as const;
+export const CODEX_GATEWAY_ORIGINATOR = "codex_cli_rs" as const;
+
+/** Headers permitted from Pi/provider configuration onto the gateway hop. */
+export const CODEX_GATEWAY_FORWARD_HEADERS = [
+	"accept",
+	"content-type",
+	"session-id",
+	"thread-id",
+	"x-parent-session-id",
+	"x-codex-parent-thread-id",
+	"x-client-request-id",
+	"x-codex-model",
+	"x-codex-affinity-scope",
+	"x-codex-window-id",
+	"x-codex-turn-metadata",
+	"x-codex-beta-features",
+	"x-openai-encrypted-tool-arguments",
+	"x-openai-tool-output-truncation-policy",
+	"x-openai-internal-codex-responses-lite",
+	"version",
+	"originator",
+	"user-agent",
+] as const;
+
+const CODEX_GATEWAY_FORWARD_HEADER_SET = new Set<string>(CODEX_GATEWAY_FORWARD_HEADERS);
+
+export function filterCodexGatewayHeaders(headers: ProviderHeaders | undefined): Record<string, string> {
+	const result: Record<string, string> = {};
+	for (const [name, value] of Object.entries(headers ?? {})) {
+		if (typeof value !== "string" || !CODEX_GATEWAY_FORWARD_HEADER_SET.has(name.toLowerCase())) continue;
+		result[name] = value;
+	}
+	return result;
+}
+
+export type CodexAffinity = {
+	/** Bare model id used by the gateway route selector, never provider/model. */
+	model: string;
+	scope: typeof CODEX_AFFINITY_SCOPE;
+};
+
+export type ResponsesHeaderRuntime = {
+	api: string;
+	apiKey: string;
+	headers?: ProviderHeaders;
+	sessionId?: string;
+	/** Opt-in gateway Codex routing metadata for synthetic requests. */
+	codexAffinity?: CodexAffinity;
+	currentModel: {
+		headers?: ProviderHeaders;
+	};
+};
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+	return !!value && typeof value === "object" && !Array.isArray(value);
+}
+
+function decodeJwtPayload(token: string): Record<string, unknown> | undefined {
+	const parts = token.split(".");
+	if (parts.length !== 3) return undefined;
+	try {
+		const payload = JSON.parse(Buffer.from(parts[1]!, "base64url").toString("utf8")) as unknown;
+		return isRecord(payload) ? payload : undefined;
+	} catch {
+		return undefined;
+	}
+}
+
+function extractCodexAccountId(token: string): string | undefined {
+	const authClaims = decodeJwtPayload(token)?.["https://api.openai.com/auth"];
+	if (!isRecord(authClaims)) return undefined;
+	const accountId = authClaims.chatgpt_account_id;
+	return typeof accountId === "string" && accountId.trim() ? accountId.trim() : undefined;
+}
+
+function buildCodexUserAgent(): string {
+	const platform = typeof process !== "undefined" ? process.platform : "browser";
+	const arch = typeof process !== "undefined" ? process.arch : "unknown";
+	return `pi (${platform}; ${arch})`;
+}
+
+export function buildCodexCliUserAgent(version: string): string {
+	const platform = typeof process !== "undefined" ? process.platform : "browser";
+	const arch = typeof process !== "undefined" ? process.arch : "unknown";
+	return `codex_cli_rs/${version} (${platform}; ${arch})`;
+}
+
+/**
+ * Codex client identity used by synthetic gateway requests in their User-Agent.
+ * Native live and shared synthetic requests do not generate a `version`
+ * header; explicitly configured provider values remain caller-owned.
+ */
+export const CODEX_CLIENT_VERSION = "0.153.0";
+
+/** Prompt cache keys are clamped by the same host rule (`OPENAI_PROMPT_CACHE_KEY_MAX_LENGTH`). */
+const CODEX_SESSION_ID_MAX_LENGTH = 64;
+
+export function clampCodexSessionId(sessionId: string | undefined): string | undefined {
+	if (!sessionId) return undefined;
+	const chars = Array.from(sessionId);
+	return chars.length <= CODEX_SESSION_ID_MAX_LENGTH ? sessionId : chars.slice(0, CODEX_SESSION_ID_MAX_LENGTH).join("");
+}
+
+export type ResponsesHeaderOptions = {
+	accept: string;
+	/** `null` omits content-type so a multipart FormData body can set its boundary. */
+	contentType?: string | null;
+	/** Conversation identity for Codex cache-affinity headers; clamped to 64 chars here. */
+	sessionId?: string;
+};
+
+export function buildResponsesRequestHeaders(
+	runtime: ResponsesHeaderRuntime,
+	options: ResponsesHeaderOptions,
+): Headers {
+	const mergedHeaders = mergeProviderHeaders(runtime.currentModel.headers, runtime.headers);
+	const headers = new Headers(
+		runtime.codexAffinity ? filterCodexGatewayHeaders(mergedHeaders) : mergedHeaders,
+	);
+	headers.set("accept", options.accept);
+	if (options.contentType === null) {
+		headers.delete("content-type");
+	} else {
+		headers.set("content-type", options.contentType ?? "application/json");
+	}
+	if (runtime.api === "azure-openai-responses") {
+		// Azure OpenAI authenticates Responses requests with `api-key`; do not
+		// forward an inherited bearer token from a model/provider header.
+		headers.delete("authorization");
+		headers.set("api-key", runtime.apiKey);
+	} else if (!headers.has("authorization")) {
+		headers.set("authorization", `Bearer ${runtime.apiKey}`);
+	}
+
+	const isNativeCodex = runtime.api === "openai-codex-responses";
+	const gatewayAffinity = runtime.codexAffinity;
+	if (isNativeCodex || gatewayAffinity) {
+		if (gatewayAffinity) {
+			// A gateway request must use the configured data-plane key, never an
+			// inherited OAuth/account header from the model registry.
+			headers.set("authorization", `Bearer ${runtime.apiKey}`);
+			headers.delete("chatgpt-account-id");
+			headers.delete("cookie");
+			headers.delete("x-api-key");
+			headers.set("originator", CODEX_GATEWAY_ORIGINATOR);
+			headers.set("user-agent", buildCodexCliUserAgent(CODEX_CLIENT_VERSION));
+			headers.set("x-codex-affinity-scope", gatewayAffinity.scope);
+			headers.set("x-codex-model", gatewayAffinity.model);
+		} else {
+			const accountId = extractCodexAccountId(runtime.apiKey);
+			if (accountId) headers.set("chatgpt-account-id", accountId);
+			headers.set("originator", "pi");
+			headers.set("user-agent", buildCodexUserAgent());
+			headers.set("openai-beta", "responses=experimental");
+		}
+		// Gateways own their version policy. Explicit versions still pass through
+		// the header merge and allowlist, but Toolkit does not generate one.
+		// Prompt-cache/session affinity rides on the conversation identity. The
+		// gateway path also uses the bare model hint above so NEWapi can route
+		// context/compact requests without inspecting their body.
+		const sessionId = clampCodexSessionId(options.sessionId ?? runtime.sessionId);
+		if (sessionId) {
+			// Header names match the installed host's live-request builder
+			// (`buildSSEHeaders`: `session-id` + `x-client-request-id`) so our
+			// synthetic requests land in the same conversation affinity group.
+			headers.set("session-id", sessionId);
+			headers.set("x-client-request-id", sessionId);
+		}
+	}
+
+	return headers;
+}
+
+export const _responsesHeadersTest = {
+	extractCodexAccountId,
+};

package/src/retired-remote-windows.ts

@@ -0,0 +1,35 @@
+/** Reserved persisted identifiers, retained only to refuse retired sessions. */
+export const RETIRED_REMOTE_WINDOW_TYPE = "codex-context-window" as const;
+export const RETIRED_MANUAL_COMPACT_TYPE = "pi-openai-toolkit:manual-compact" as const;
+export const RETIRED_REMOTE_WINDOW_SUMMARY =
+	"[Pi Codex context-window boundary; no conversation summary was generated.]";
+
+export type RetiredRemoteWindowsReason =
+	| "window-message"
+	| "window-compaction"
+	| "window-summary"
+	| "manual-compact-record";
+
+export const RETIRED_REMOTE_WINDOWS_MESSAGE =
+	"Remote Windows has been removed. This branch contains retired window or manual-compaction records and cannot continue. Start a new session and explicitly choose the model you want to use. Existing history is unchanged; no model or thinking level was restored.";
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+	return !!value && typeof value === "object" && !Array.isArray(value);
+}
+
+/**
+ * Inspect only the supplied active branch. Reserved identifiers suffice even
+ * when their data is damaged, terminal or superseded by a newer checkpoint.
+ * This deliberately interprets no ownership, recovery or migration state.
+ */
+export function detectRetiredRemoteWindows(entries: readonly unknown[]): RetiredRemoteWindowsReason | undefined {
+	for (const entry of entries) {
+		if (!isRecord(entry)) continue;
+		if (entry.type === "custom_message" && entry.customType === RETIRED_REMOTE_WINDOW_TYPE) return "window-message";
+		if (entry.type === "custom" && entry.customType === RETIRED_MANUAL_COMPACT_TYPE) return "manual-compact-record";
+		if (entry.type !== "compaction") continue;
+		if (isRecord(entry.details) && entry.details.strategy === RETIRED_REMOTE_WINDOW_TYPE) return "window-compaction";
+		if (entry.summary === RETIRED_REMOTE_WINDOW_SUMMARY) return "window-summary";
+	}
+	return undefined;
+}