@copilotkit/aimock 1.45.0 → 1.46.0

package/dist/responses.js

@@ -1,11 +1,15 @@
+import { renderError } from "./response/errors.js";
 import { isReasoningModel } from "./model-utils.js";
-import { assertCustomToolCalls, assertResponsesToolCalls, extractOverrides, flattenHeaders, generateId, generateToolCallId, getContext, getTestId, isCombinedFixtureResponse, isErrorResponse, isJsonObject, isTextResponse, isToolCallResponse, prepareOpenAIChatMisbehavior, resolveFixtureBlocks, resolveOpenAIChatMisbehaviorUsage, resolveReasoningForModel, resolveResponse, resolveServedBlockOutcome, resolveStrictMode, serializeErrorResponse, servedToolCalls, strictNoMatchLogLine, strictNoMatchMessage, strictOverrideField, toolCallFixtureBlock, withoutLegacyNamespaces } from "./helpers.js";
+import { resolveRequestDecisions, strictOverrideField } from "./response/policy.js";
+import { assertCustomToolCalls, assertResponsesToolCalls, extractOverrides, flattenHeaders, generateId, generateToolCallId, getContext, getTestId, isCombinedFixtureResponse, isErrorResponse, isJsonObject, isTextResponse, isToolCallResponse, prepareOpenAIChatMisbehavior, resolveFixtureBlocks, resolveOpenAIChatMisbehaviorUsage, resolveReasoningForModel, resolveResponse, resolveServedBlockOutcome, serializeErrorResponse, servedToolCalls, strictNoMatchLogLine, strictNoMatchMessage, toolCallFixtureBlock, withoutLegacyNamespaces } from "./helpers.js";
 import { calculateDelay, delay, writeErrorResponse } from "./sse-writer.js";
 import { applyChaosAsync } from "./chaos.js";
 import { planMisbehavior, recordMisbehaviorOutcome } from "./misbehavior.js";
 import { matchFixtureDiagnostic, recordMatchOptions, setResponsesOfferedTools } from "./router.js";
 import { proxyAndRecord } from "./recorder.js";
 import { createInterruptionSignal } from "./interruption.js";
+import { render } from "./response/usage/codecs/responses.js";
+import { mapResponsesFinish } from "./response/finish.js";
 import { randomBytes } from "node:crypto";
 
 //#region src/responses.ts
@@ -310,25 +314,7 @@ function validateResponsesTools(tools) {
 }
 function responsesStatus(finishReason, defaultStatus) {
 	if (!finishReason) return defaultStatus;
-	if (finishReason === "stop") return "completed";
-	if (finishReason === "tool_calls") return "completed";
-	if (finishReason === "length") return "incomplete";
-	if (finishReason === "content_filter") return "failed";
-	return finishReason;
-}
-function responsesUsage(overrides) {
-	if (!overrides?.usage) return {
-		input_tokens: 0,
-		output_tokens: 0,
-		total_tokens: 0
-	};
-	const input = overrides.usage.input_tokens ?? overrides.usage.prompt_tokens ?? 0;
-	const output = overrides.usage.output_tokens ?? overrides.usage.completion_tokens ?? 0;
-	return {
-		input_tokens: input,
-		output_tokens: output,
-		total_tokens: overrides.usage.total_tokens ?? input + output
-	};
+	return mapResponsesFinish(finishReason);
 }
 function responseId() {
 	return generateId("resp");
@@ -338,7 +324,7 @@ function itemId() {
 }
 function buildTextStreamEvents(content, model, chunkSize, reasoning, webSearches, overrides, emitEncryptedReasoning = false, synthesizeSummarylessReasoning = false) {
 	const { respId, created, events, prefixOutputItems, nextOutputIndex } = buildResponsePreamble(model, chunkSize, reasoning, webSearches, overrides, emitEncryptedReasoning, synthesizeSummarylessReasoning);
-	const { events: msgEvents, msgItem } = buildMessageOutputEvents(content, chunkSize, nextOutputIndex);
+	const { events: msgEvents, msgItem } = buildMessageOutputEvents(content, chunkSize, nextOutputIndex, overrides?.phase);
 	events.push(...msgEvents);
 	events.push({
 		type: "response.completed",
@@ -349,7 +335,7 @@ function buildTextStreamEvents(content, model, chunkSize, reasoning, webSearches
 			model: overrides?.model ?? model,
 			status: responsesStatus(overrides?.finishReason, "completed"),
 			output: [...prefixOutputItems, msgItem],
-			usage: responsesUsage(overrides)
+			usage: render(overrides)
 		}
 	});
 	return events;
@@ -463,7 +449,7 @@ function toolCallStreamEvents(toolCalls, model, chunkSize, reasoning, webSearche
 			model: overrides?.model ?? model,
 			status: responsesStatus(overrides?.finishReason, "completed"),
 			output: [...prefixOutputItems, ...fcOutputItems],
-			usage: responsesUsage(overrides)
+			usage: render(overrides)
 		}
 	});
 	return events;
@@ -734,7 +720,7 @@ function buildResponsePreamble(model, chunkSize, reasoning, webSearches, overrid
 		nextOutputIndex
 	};
 }
-function buildMessageOutputEvents(content, chunkSize, outputIndex) {
+function buildMessageOutputEvents(content, chunkSize, outputIndex, phase) {
 	const msgId = itemId();
 	const events = [];
 	events.push({
@@ -745,6 +731,7 @@ function buildMessageOutputEvents(content, chunkSize, outputIndex) {
 			id: msgId,
 			status: "in_progress",
 			role: "assistant",
+			...phase !== void 0 ? { phase } : {},
 			content: []
 		}
 	});
@@ -789,6 +776,7 @@ function buildMessageOutputEvents(content, chunkSize, outputIndex) {
 		id: msgId,
 		status: "completed",
 		role: "assistant",
+		...phase !== void 0 ? { phase } : {},
 		content: [{
 			type: "output_text",
 			text: content,
@@ -907,7 +895,7 @@ function buildCustomToolCallOutputEvents(call, chunkSize, outputIndex) {
 function buildToolCallOutputEvents(call, chunkSize, outputIndex) {
 	return isCustomEmittable(call) ? buildCustomToolCallOutputEvents(call, chunkSize, outputIndex) : buildFunctionCallOutputEvents(call, chunkSize, outputIndex);
 }
-function buildOutputPrefix(content, model, reasoning, webSearches, emitEncryptedReasoning = false, synthesizeSummarylessReasoning = false) {
+function buildOutputPrefix(content, model, reasoning, webSearches, emitEncryptedReasoning = false, synthesizeSummarylessReasoning = false, phase) {
 	const output = [];
 	if (reasoning || shouldSynthesizeBlobOnlyReasoning(reasoning, model, synthesizeSummarylessReasoning)) output.push(buildReasoningOutputItem(generateId("rs"), {
 		summaryText: reasoning,
@@ -927,6 +915,7 @@ function buildOutputPrefix(content, model, reasoning, webSearches, emitEncrypted
 		id: itemId(),
 		status: "completed",
 		role: "assistant",
+		...phase !== void 0 ? { phase } : {},
 		content: [{
 			type: "output_text",
 			text: content,
@@ -943,11 +932,11 @@ function buildResponseEnvelope(model, output, overrides) {
 		model: overrides?.model ?? model,
 		status: responsesStatus(overrides?.finishReason, "completed"),
 		output,
-		usage: responsesUsage(overrides)
+		usage: render(overrides)
 	};
 }
 function buildTextResponse(content, model, reasoning, webSearches, overrides, emitEncryptedReasoning = false, synthesizeSummarylessReasoning = false) {
-	return buildResponseEnvelope(model, buildOutputPrefix(content, model, reasoning, webSearches, emitEncryptedReasoning, synthesizeSummarylessReasoning), overrides);
+	return buildResponseEnvelope(model, buildOutputPrefix(content, model, reasoning, webSearches, emitEncryptedReasoning, synthesizeSummarylessReasoning, overrides?.phase), overrides);
 }
 function buildToolCallResponse(toolCalls, model, reasoning, webSearches, overrides, emitEncryptedReasoning = false, synthesizeSummarylessReasoning = false) {
 	assertResponsesToolCalls(toolCalls);
@@ -984,7 +973,7 @@ function contentWithToolCallsStreamEvents(content, toolCalls, model, chunkSize,
 		let outputIndex = nextOutputIndex;
 		for (const block of ordered) {
 			if (block.type === "text") {
-				const { events: msgEvents, msgItem } = buildMessageOutputEvents(block.text, chunkSize, outputIndex);
+				const { events: msgEvents, msgItem } = buildMessageOutputEvents(block.text, chunkSize, outputIndex, overrides?.phase);
 				events.push(...msgEvents);
 				orderedOutputItems.push(msgItem);
 			} else {
@@ -996,7 +985,7 @@ function contentWithToolCallsStreamEvents(content, toolCalls, model, chunkSize,
 		}
 	} else {
 		assertResponsesToolCalls(toolCalls);
-		const { events: msgEvents, msgItem } = buildMessageOutputEvents(content, chunkSize, nextOutputIndex);
+		const { events: msgEvents, msgItem } = buildMessageOutputEvents(content, chunkSize, nextOutputIndex, overrides?.phase);
 		events.push(...msgEvents);
 		orderedOutputItems.push(msgItem);
 		for (let idx = 0; idx < toolCalls.length; idx++) {
@@ -1014,7 +1003,7 @@ function contentWithToolCallsStreamEvents(content, toolCalls, model, chunkSize,
 			model: overrides?.model ?? model,
 			status: responsesStatus(overrides?.finishReason, "completed"),
 			output: [...prefixOutputItems, ...orderedOutputItems],
-			usage: responsesUsage(overrides)
+			usage: render(overrides)
 		}
 	});
 	return events;
@@ -1024,12 +1013,13 @@ function buildToolCallOutputItem(tc) {
 	if (isCustomEmittable(tc)) return customToolCallItem(tc, customToolCallItemId(), tc.id || generateToolCallId(), requireFixtureToolInput(tc.input), "completed");
 	return functionCallItem(tc, generateId("fc"), tc.id || generateToolCallId(), requireFixtureToolArguments(tc.arguments), "completed");
 }
-function buildMessageOutputItem(content) {
+function buildMessageOutputItem(content, phase) {
 	return {
 		type: "message",
 		id: itemId(),
 		status: "completed",
 		role: "assistant",
+		...phase !== void 0 ? { phase } : {},
 		content: [{
 			type: "output_text",
 			text: content,
@@ -1053,12 +1043,12 @@ function buildContentWithToolCallsResponse(content, toolCalls, model, reasoning,
 				query
 			}
 		});
-		for (const block of ordered) if (block.type === "text") output.push(buildMessageOutputItem(block.text));
+		for (const block of ordered) if (block.type === "text") output.push(buildMessageOutputItem(block.text, overrides?.phase));
 		else output.push(buildToolCallOutputItem(block));
 		return buildResponseEnvelope(model, output, overrides);
 	}
 	assertResponsesToolCalls(toolCalls);
-	const output = buildOutputPrefix(content, model, reasoning, webSearches, emitEncryptedReasoning, synthesizeSummarylessReasoning);
+	const output = buildOutputPrefix(content, model, reasoning, webSearches, emitEncryptedReasoning, synthesizeSummarylessReasoning, overrides?.phase);
 	for (const tc of toolCalls) output.push(buildToolCallOutputItem(tc));
 	return buildResponseEnvelope(model, output, overrides);
 }
@@ -1104,11 +1094,11 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 				fixture: null
 			}
 		});
-		writeErrorResponse(res, 400, JSON.stringify({ error: {
+		writeErrorResponse(res, 400, renderError("openai", "validation", {
 			message: `Malformed JSON: ${detail}`,
 			type: "invalid_request_error",
 			code: "invalid_json"
-		} }));
+		}).body);
 		return;
 	}
 	if (!isJsonObject(responsesReq)) {
@@ -1122,10 +1112,10 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 				fixture: null
 			}
 		});
-		writeErrorResponse(res, 400, JSON.stringify({ error: {
+		writeErrorResponse(res, 400, renderError("openai", "validation", {
 			message: "Request body must be a JSON object",
 			type: "invalid_request_error"
-		} }));
+		}).body);
 		return;
 	}
 	let inputError;
@@ -1152,10 +1142,10 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 				fixture: null
 			}
 		});
-		writeErrorResponse(res, 400, JSON.stringify({ error: {
+		writeErrorResponse(res, 400, renderError("openai", "validation", {
 			message: validationError,
 			type: "invalid_request_error"
-		} }));
+		}).body);
 		return;
 	}
 	const extendedTools = defaults.responsesTools === "extended";
@@ -1180,7 +1170,7 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 		body: completionReq
 	}, fixture ? "fixture" : "proxy", defaults.registry, defaults.logger)) return;
 	if (!fixture) {
-		if (resolveStrictMode(defaults.strict, req.headers)) {
+		if (resolveRequestDecisions(defaults.strict, req.headers).fixtureMiss) {
 			const strictStatus = 503;
 			const strictMessage = strictNoMatchMessage(skippedBySequenceOrTurn);
 			defaults.logger.error(strictNoMatchLogLine(req.method ?? "POST", req.url ?? "/v1/responses", skippedBySequenceOrTurn));
@@ -1195,11 +1185,11 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 					...strictOverrideField(defaults.strict, req.headers)
 				}
 			});
-			writeErrorResponse(res, strictStatus, JSON.stringify({ error: {
+			writeErrorResponse(res, strictStatus, renderError("openai", "strict-miss", {
 				message: strictMessage,
 				type: "invalid_request_error",
 				code: "no_fixture_match"
-			} }));
+			}).body);
 			return;
 		}
 		if (defaults.record) {
@@ -1231,11 +1221,11 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 				...strictOverrideField(defaults.strict, req.headers)
 			}
 		});
-		writeErrorResponse(res, 404, JSON.stringify({ error: {
+		writeErrorResponse(res, 404, renderError("openai", "fixture-miss", {
 			message: "No fixture matched",
 			type: "invalid_request_error",
 			code: "no_fixture_match"
-		} }));
+		}).body);
 		return;
 	}
 	const resolvedResponse = await resolveResponse(fixture, completionReq);
@@ -1268,11 +1258,11 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 			testId
 		});
 		if (!misbehavior.summary?.evaluations.some((evaluation) => evaluation.outcome === "error")) defaults.logger.error(misbehavior.message);
-		writeErrorResponse(res, misbehavior.status, JSON.stringify({ error: {
+		writeErrorResponse(res, misbehavior.status, renderError("openai", "misbehavior", {
 			message: misbehavior.message,
 			type: "invalid_request_error",
 			code: misbehavior.code
-		} }));
+		}).body);
 		return;
 	}
 	const latency = fixture.latency ?? defaults.latency;
@@ -1349,7 +1339,7 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 	}
 	if (isCombinedFixtureResponse(response)) {
 		const overrides = extractOverrides(response);
-		const effectiveStrict = resolveStrictMode(defaults.strict, req.headers);
+		const effectiveStrict = resolveRequestDecisions(defaults.strict, req.headers).reasoningSuppression;
 		const effReasoning = resolveReasoningForModel(response.reasoning, completionReq.model, effectiveStrict, defaults.logger);
 		const journalEntry = journal.add({
 			method: req.method ?? "POST",
@@ -1395,7 +1385,7 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 	}
 	if (isTextResponse(response)) {
 		const overrides = extractOverrides(response);
-		const effectiveStrict = resolveStrictMode(defaults.strict, req.headers);
+		const effectiveStrict = resolveRequestDecisions(defaults.strict, req.headers).reasoningSuppression;
 		const effReasoning = resolveReasoningForModel(response.reasoning, completionReq.model, effectiveStrict, defaults.logger);
 		const journalEntry = journal.add({
 			method: req.method ?? "POST",
@@ -1438,7 +1428,7 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 	}
 	if (isToolCallResponse(response)) {
 		const overrides = extractOverrides(response);
-		const effectiveStrict = resolveStrictMode(defaults.strict, req.headers);
+		const effectiveStrict = resolveRequestDecisions(defaults.strict, req.headers).reasoningSuppression;
 		const effReasoning = resolveReasoningForModel(response.reasoning, completionReq.model, effectiveStrict, defaults.logger);
 		const journalEntry = journal.add({
 			method: req.method ?? "POST",
@@ -1495,10 +1485,10 @@ async function handleResponses(req, res, raw, fixtures, journal, defaults, setCo
 		defaults,
 		testId
 	});
-	writeErrorResponse(res, 500, JSON.stringify({ error: {
+	writeErrorResponse(res, 500, renderError("openai", "unknown-response", {
 		message: "Fixture response did not match any known type",
 		type: "server_error"
-	} }));
+	}).body);
 }
 /** Prepare call IDs once, retaining the engine's effective blocks and exact served-call metadata. */
 function prepareResponsesMisbehavior(plan) {
@@ -1526,6 +1516,7 @@ function buildResponsesMisbehavior(plan, request, chunkSize, emitEncryptedReason
 			type: "message",
 			role: "assistant",
 			status: "completed",
+			...overrides.phase !== void 0 ? { phase: overrides.phase } : {},
 			content: [part]
 		};
 		const position = {
@@ -1577,7 +1568,7 @@ function buildResponsesMisbehavior(plan, request, chunkSize, emitEncryptedReason
 		let callIndex = 0;
 		for (const block of blocks) {
 			if (block.type === "text") {
-				const message = buildMessageOutputEvents(block.text, chunkSize, outputIndex);
+				const message = buildMessageOutputEvents(block.text, chunkSize, outputIndex, overrides.phase);
 				events.push(...message.events);
 				output.push(message.msgItem);
 			} else {
@@ -1606,11 +1597,7 @@ function buildResponsesMisbehavior(plan, request, chunkSize, emitEncryptedReason
 		status: incomplete ? "incomplete" : responsesStatus(overrides?.finishReason, "completed"),
 		...incomplete ? { incomplete_details: { reason: plan.stop === "content_filter" ? "content_filter" : "max_output_tokens" } } : {},
 		output,
-		usage: {
-			input_tokens: usage.prompt_tokens,
-			output_tokens: usage.completion_tokens,
-			total_tokens: usage.total_tokens
-		}
+		usage: render({ usage })
 	};
 	events.push({
 		type: incomplete ? "response.incomplete" : "response.completed",