Spaces:
Paused
Paused
File size: 12,209 Bytes
347f81b fadda70 347f81b 7366e72 ab2754a 1531084 ab2754a 1531084 ab2754a 1531084 ab2754a 8068f1c cf0807a 347f81b 7366e72 347f81b ab2754a 8068f1c 1531084 8068f1c ab2754a cf0807a 347f81b fadda70 347f81b 7366e72 347f81b ab2754a 1531084 ab2754a 1531084 ab2754a cf0807a 8068f1c 347f81b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 | /**
* Type-safe Codex SSE event definitions and type guards.
*
* The Codex Responses API sends these SSE events during streaming.
* Using discriminated unions eliminates unsafe `as` casts in translators.
*/
import type { CodexSSEEvent } from "../proxy/codex-api.js";
// ββ Event data shapes ββββββββββββββββββββββββββββββββββββββββββββ
export interface CodexResponseData {
id?: string;
usage?: {
input_tokens: number;
output_tokens: number;
cached_tokens?: number;
reasoning_tokens?: number;
};
[key: string]: unknown;
}
export interface CodexCreatedEvent {
type: "response.created";
response: CodexResponseData;
}
export interface CodexInProgressEvent {
type: "response.in_progress";
response: CodexResponseData;
}
export interface CodexTextDeltaEvent {
type: "response.output_text.delta";
delta: string;
}
export interface CodexTextDoneEvent {
type: "response.output_text.done";
text: string;
}
export interface CodexCompletedEvent {
type: "response.completed";
response: CodexResponseData;
}
// ββ Reasoning summary event data shapes βββββββββββββββββββββββββ
export interface CodexReasoningSummaryDeltaEvent {
type: "response.reasoning_summary_text.delta";
delta: string;
}
export interface CodexReasoningSummaryDoneEvent {
type: "response.reasoning_summary_text.done";
text: string;
}
// ββ Function call event data shapes βββββββββββββββββββββββββββββ
export interface CodexOutputItemAddedEvent {
type: "response.output_item.added";
outputIndex: number;
item: {
type: string;
id: string;
call_id?: string;
name?: string;
};
}
export interface CodexContentPartAddedEvent {
type: "response.content_part.added";
contentIndex: number;
outputIndex: number;
itemId: string;
part: Record<string, unknown>;
}
export interface CodexContentPartDoneEvent {
type: "response.content_part.done";
contentIndex: number;
outputIndex: number;
itemId: string;
part: Record<string, unknown>;
}
export interface CodexFunctionCallArgsDeltaEvent {
type: "response.function_call_arguments.delta";
delta: string;
outputIndex: number;
call_id: string;
}
export interface CodexFunctionCallArgsDoneEvent {
type: "response.function_call_arguments.done";
arguments: string;
call_id: string;
name: string;
}
export interface CodexOutputItemDoneEvent {
type: "response.output_item.done";
outputIndex: number;
item: {
type: string;
id?: string;
call_id?: string;
name?: string;
arguments?: string;
[key: string]: unknown;
};
}
export interface CodexIncompleteEvent {
type: "response.incomplete";
response: CodexResponseData;
}
export interface CodexQueuedEvent {
type: "response.queued";
response: CodexResponseData;
}
export interface CodexErrorEvent {
type: "error";
error: { type: string; code: string; message: string };
}
export interface CodexResponseFailedEvent {
type: "response.failed";
error: { type: string; code: string; message: string };
response: CodexResponseData;
}
export interface CodexUnknownEvent {
type: "unknown";
raw: unknown;
}
export type TypedCodexEvent =
| CodexCreatedEvent
| CodexInProgressEvent
| CodexTextDeltaEvent
| CodexTextDoneEvent
| CodexReasoningSummaryDeltaEvent
| CodexReasoningSummaryDoneEvent
| CodexCompletedEvent
| CodexOutputItemAddedEvent
| CodexOutputItemDoneEvent
| CodexContentPartAddedEvent
| CodexContentPartDoneEvent
| CodexIncompleteEvent
| CodexQueuedEvent
| CodexFunctionCallArgsDeltaEvent
| CodexFunctionCallArgsDoneEvent
| CodexErrorEvent
| CodexResponseFailedEvent
| CodexUnknownEvent;
// ββ Type guard / parser ββββββββββββββββββββββββββββββββββββββββββ
function isRecord(v: unknown): v is Record<string, unknown> {
return typeof v === "object" && v !== null && !Array.isArray(v);
}
function parseResponseData(data: unknown): CodexResponseData | undefined {
if (!isRecord(data)) return undefined;
const resp = data.response;
if (!isRecord(resp)) return undefined;
const result: CodexResponseData = {};
if (typeof resp.id === "string") result.id = resp.id;
if (isRecord(resp.usage)) {
result.usage = {
input_tokens: typeof resp.usage.input_tokens === "number" ? resp.usage.input_tokens : 0,
output_tokens: typeof resp.usage.output_tokens === "number" ? resp.usage.output_tokens : 0,
};
// Extract cached_tokens from input_tokens_details
const inputDetails = isRecord(resp.usage.input_tokens_details) ? resp.usage.input_tokens_details : undefined;
if (inputDetails && typeof inputDetails.cached_tokens === "number") {
result.usage.cached_tokens = inputDetails.cached_tokens;
}
// Extract reasoning_tokens from output_tokens_details
const outputDetails = isRecord(resp.usage.output_tokens_details) ? resp.usage.output_tokens_details : undefined;
if (outputDetails && typeof outputDetails.reasoning_tokens === "number") {
result.usage.reasoning_tokens = outputDetails.reasoning_tokens;
}
}
return result;
}
/**
* Parse a raw CodexSSEEvent into a typed event.
* Safely extracts fields with runtime checks β no `as` casts.
*/
export function parseCodexEvent(evt: CodexSSEEvent): TypedCodexEvent {
const data = evt.data;
switch (evt.event) {
case "response.created": {
const resp = parseResponseData(data);
return resp
? { type: "response.created", response: resp }
: { type: "unknown", raw: data };
}
case "response.in_progress": {
const resp = parseResponseData(data);
return resp
? { type: "response.in_progress", response: resp }
: { type: "unknown", raw: data };
}
case "response.output_text.delta": {
if (isRecord(data) && typeof data.delta === "string") {
return { type: "response.output_text.delta", delta: data.delta };
}
return { type: "unknown", raw: data };
}
case "response.output_text.done": {
if (isRecord(data) && typeof data.text === "string") {
return { type: "response.output_text.done", text: data.text };
}
return { type: "unknown", raw: data };
}
case "response.reasoning_summary_text.delta": {
if (isRecord(data) && typeof data.delta === "string") {
return { type: "response.reasoning_summary_text.delta", delta: data.delta };
}
return { type: "unknown", raw: data };
}
case "response.reasoning_summary_text.done": {
if (isRecord(data) && typeof data.text === "string") {
return { type: "response.reasoning_summary_text.done", text: data.text };
}
return { type: "unknown", raw: data };
}
case "response.completed": {
const resp = parseResponseData(data);
return resp
? { type: "response.completed", response: resp }
: { type: "unknown", raw: data };
}
case "response.output_item.added": {
if (isRecord(data) && isRecord(data.item) && typeof data.item.type === "string") {
const item: CodexOutputItemAddedEvent["item"] = {
type: data.item.type,
id: typeof data.item.id === "string" ? data.item.id : "",
};
if (typeof data.item.call_id === "string") item.call_id = data.item.call_id;
if (typeof data.item.name === "string") item.name = data.item.name;
return {
type: "response.output_item.added",
outputIndex: typeof data.output_index === "number" ? data.output_index : 0,
item,
};
}
return { type: "unknown", raw: data };
}
case "response.content_part.added":
case "response.content_part.done": {
if (isRecord(data) && isRecord(data.part)) {
return {
type: evt.event as "response.content_part.added" | "response.content_part.done",
contentIndex: typeof data.content_index === "number" ? data.content_index : 0,
outputIndex: typeof data.output_index === "number" ? data.output_index : 0,
itemId: typeof data.item_id === "string" ? data.item_id : "",
part: data.part as Record<string, unknown>,
};
}
return { type: "unknown", raw: data };
}
case "response.function_call_arguments.delta": {
// Codex uses item_id (not call_id) on delta events
const deltaCallId = isRecord(data)
? (typeof data.call_id === "string" ? data.call_id : typeof data.item_id === "string" ? data.item_id : "")
: "";
if (
isRecord(data) &&
typeof data.delta === "string" &&
deltaCallId
) {
return {
type: "response.function_call_arguments.delta",
delta: data.delta,
outputIndex: typeof data.output_index === "number" ? data.output_index : 0,
call_id: deltaCallId,
};
}
return { type: "unknown", raw: data };
}
case "response.function_call_arguments.done": {
// Codex uses item_id (not call_id); name may be absent
const doneCallId = isRecord(data)
? (typeof data.call_id === "string" ? data.call_id : typeof data.item_id === "string" ? data.item_id : "")
: "";
if (
isRecord(data) &&
typeof data.arguments === "string" &&
doneCallId
) {
return {
type: "response.function_call_arguments.done",
arguments: data.arguments,
call_id: doneCallId,
name: typeof data.name === "string" ? data.name : "",
};
}
return { type: "unknown", raw: data };
}
case "error": {
if (isRecord(data)) {
const err = isRecord(data.error) ? data.error : data;
return {
type: "error",
error: {
type: typeof err.type === "string" ? err.type : "error",
code: typeof err.code === "string" ? err.code : "unknown",
message: typeof err.message === "string" ? err.message : JSON.stringify(data),
},
};
}
return {
type: "error",
error: { type: "error", code: "unknown", message: String(data) },
};
}
case "response.failed": {
const resp = parseResponseData(data);
if (isRecord(data)) {
const err = isRecord(data.error) ? data.error : {};
return {
type: "response.failed",
error: {
type: typeof err.type === "string" ? err.type : "error",
code: typeof err.code === "string" ? err.code : "unknown",
message: typeof err.message === "string" ? err.message : JSON.stringify(data),
},
response: resp ?? {},
};
}
return { type: "unknown", raw: data };
}
case "response.output_item.done": {
if (isRecord(data) && isRecord(data.item)) {
return {
type: "response.output_item.done",
outputIndex: typeof data.output_index === "number" ? data.output_index : 0,
item: {
type: typeof data.item.type === "string" ? data.item.type : "unknown",
...(typeof data.item.id === "string" ? { id: data.item.id } : {}),
...(typeof data.item.call_id === "string" ? { call_id: data.item.call_id } : {}),
...(typeof data.item.name === "string" ? { name: data.item.name } : {}),
...(typeof data.item.arguments === "string" ? { arguments: data.item.arguments } : {}),
},
};
}
return { type: "unknown", raw: data };
}
case "response.incomplete": {
const resp = parseResponseData(data);
return resp
? { type: "response.incomplete", response: resp }
: { type: "unknown", raw: data };
}
case "response.queued": {
const resp = parseResponseData(data);
return resp
? { type: "response.queued", response: resp }
: { type: "unknown", raw: data };
}
default:
return { type: "unknown", raw: data };
}
}
|