@copilotkit/aimock 1.45.1 → 1.47.0

package/dist/response/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","names":[],"sources":["../../src/response/errors.ts"],"sourcesContent":["import { errorProfiles, type ErrorWire } from \"./profiles.js\";\n\nexport type ErrorPurpose =\n  | \"validation\"\n  | \"strict-miss\"\n  | \"fixture-miss\"\n  | \"thinking\"\n  | \"fixture\"\n  | \"tool-argument\"\n  | \"misbehavior\"\n  | \"unknown-response\"\n  | \"transport-failure\"\n  | \"route-failure\"\n  | \"stream-failure\"\n  | \"invalid-misbehavior-header\"\n  | \"authentication\"\n  | \"legacy-auth\";\n\nexport interface ErrorDetails {\n  message: string;\n  type?: string | null;\n  param?: string | null;\n  /** Explicitly retain the native OpenAI param slot; omitted preserves legacy templates. */\n  includeParam?: true;\n  /** Normalized correlation metadata explicitly supplied by native header-policy rejects. */\n  requestId?: string;\n  code?: string | null;\n  bodyCode?: number;\n  status?: string | null;\n  googleDetails?: {\n    \"@type\": string;\n    reason: string;\n    domain: string;\n    metadata: { code: string };\n  }[];\n}\n\ntype OpenAIInnerDetails = Pick<\n  ErrorDetails,\n  \"message\" | \"type\" | \"param\" | \"code\" | \"includeParam\"\n>;\ntype OpenAIInnerBody = {\n  message: string;\n  type?: string | null;\n  param?: string | null;\n  code?: string | null;\n};\ntype ServiceValidationBody = { error: { message: string; type: string } };\ntype OpenRouterErrorBody = {\n  error: { code: number; message: string; metadata?: Record<string, unknown> };\n};\n\n/** Common error owner; fixed native forms preserve caller signatures and ordering. */\nexport function buildOpenAIError(details: OpenAIInnerDetails): OpenAIInnerBody;\nexport function buildOpenAIError(\n  purpose: \"service-validation\",\n  details: { message: string },\n): ServiceValidationBody;\nexport function buildOpenAIError(\n  purpose: \"openrouter-error\",\n  details: { code: number; message: string; metadata?: Record<string, unknown> },\n): OpenRouterErrorBody;\nexport function buildOpenAIError(\n  input: OpenAIInnerDetails | \"service-validation\" | \"openrouter-error\",\n  details?: { message: string; code?: number; metadata?: Record<string, unknown> },\n): OpenAIInnerBody | ServiceValidationBody | OpenRouterErrorBody {\n  if (input === \"service-validation\") {\n    if (!details) throw new TypeError(\"Missing service validation error details\");\n    return {\n      error: { message: details.message, type: errorProfiles.openai.validationType },\n    };\n  }\n  if (input === \"openrouter-error\") {\n    if (!details || typeof details.code !== \"number\")\n      throw new TypeError(\"Missing OpenRouter numeric error details\");\n    return {\n      error: {\n        code: details.code,\n        message: details.message,\n        ...(details.metadata !== undefined && { metadata: details.metadata }),\n      },\n    };\n  }\n  return {\n    message: input.message,\n    type: input.type,\n    ...(input.includeParam === true ? { param: input.param ?? null } : {}),\n    code: input.code,\n  };\n}\n\n/** Native purpose templates preserve field presence and insertion order. No status or I/O. */\nexport function renderError(\n  wire: ErrorWire,\n  purpose: ErrorPurpose,\n  details: ErrorDetails,\n): { body: string; headers?: Record<string, string> } {\n  if (wire === \"ollama-embed\") {\n    return { body: JSON.stringify({ error: details.message }) };\n  }\n  const profile = errorProfiles[wire];\n  if (\n    wire === \"interactions\" &&\n    (purpose === \"validation\" ||\n      purpose === \"strict-miss\" ||\n      purpose === \"fixture-miss\" ||\n      purpose === \"fixture\" ||\n      purpose === \"misbehavior\" ||\n      purpose === \"unknown-response\")\n  ) {\n    return {\n      body: JSON.stringify({\n        error: { code: details.code ?? \"INVALID_ARGUMENT\", message: details.message },\n      }),\n    };\n  }\n  switch (purpose) {\n    case \"authentication\":\n      if (wire === \"messages\") {\n        return {\n          body: JSON.stringify({\n            type: \"error\",\n            error: { type: \"authentication_error\", message: details.message },\n          }),\n        };\n      }\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: { code: 401, message: details.message, status: \"UNAUTHENTICATED\" },\n          }),\n        };\n      }\n      return renderError(wire, \"legacy-auth\", details);\n    case \"legacy-auth\":\n      return {\n        body: JSON.stringify({\n          error: {\n            message: details.message,\n            type: \"authentication_error\",\n            code: \"invalid_api_key\",\n          },\n        }),\n      };\n    case \"stream-failure\":\n      return { body: JSON.stringify({ error: { message: details.message } }) };\n    case \"route-failure\":\n      return {\n        body: JSON.stringify({ error: { message: details.message, type: details.type } }),\n      };\n    case \"invalid-misbehavior-header\":\n      if (wire === \"ollama\") return { body: JSON.stringify({ error: details.message }) };\n      if (wire === \"cohere\") return { body: JSON.stringify({ message: details.message }) };\n      if (wire === \"interactions\") {\n        return {\n          body: JSON.stringify({ error: { code: details.code, message: details.message } }),\n        };\n      }\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: { code: 400, message: details.message, status: \"INVALID_ARGUMENT\" },\n          }),\n        };\n      }\n      if (wire === \"messages\") {\n        return {\n          body: JSON.stringify({\n            type: \"error\",\n            error: { type: profile.validationType, code: details.code, message: details.message },\n          }),\n        };\n      }\n      if (wire === \"bedrock\" || wire === \"bedrock-converse\") {\n        return {\n          body: JSON.stringify({ __type: \"ValidationException\", message: details.message }),\n        };\n      }\n      return {\n        body: JSON.stringify({\n          error: { message: details.message, type: profile.validationType, code: details.code },\n        }),\n      };\n    case \"validation\":\n    case \"strict-miss\":\n    case \"fixture-miss\":\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: { message: details.message, code: details.bodyCode, status: details.status },\n          }),\n        };\n      }\n      if (wire === \"openai\") {\n        return {\n          body: JSON.stringify({\n            error: buildOpenAIError({\n              ...details,\n              type: details.type ?? profile.validationType,\n            }),\n          }),\n        };\n      }\n      return {\n        body: JSON.stringify({\n          error: { message: details.message, type: details.type ?? profile.validationType },\n        }),\n      };\n    case \"thinking\":\n      return {\n        body: JSON.stringify({\n          type: \"error\",\n          error: { type: details.type ?? profile.validationType, message: details.message },\n          ...(wire === \"messages\" && details.requestId !== undefined\n            ? { request_id: details.requestId }\n            : {}),\n        }),\n      };\n    case \"fixture\":\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: { code: details.bodyCode, message: details.message, status: details.status },\n          }),\n        };\n      }\n      if (wire === \"openai\") {\n        return {\n          body: JSON.stringify({\n            error: {\n              message: details.message,\n              type: details.type ?? profile.fixtureType,\n              param: details.param ?? null,\n              code: details.code ?? null,\n            },\n          }),\n        };\n      }\n      return {\n        body: JSON.stringify({\n          type: \"error\",\n          error: { type: details.type ?? profile.fixtureType, message: details.message },\n        }),\n      };\n    case \"tool-argument\":\n      if (wire === \"ollama\") {\n        return { body: JSON.stringify({ error: details.message, code: details.code }) };\n      }\n      if (wire === \"interactions\") {\n        return {\n          body: JSON.stringify({ error: { code: details.code, message: details.message } }),\n        };\n      }\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: {\n              code: 500,\n              message: details.message,\n              status: \"INTERNAL\",\n              details: details.googleDetails,\n            },\n          }),\n        };\n      }\n      if (wire === \"bedrock\" || wire === \"bedrock-converse\") {\n        return {\n          body: JSON.stringify({\n            __type: details.type ?? errorProfiles.bedrock.toolArgumentType,\n            message: details.message,\n            reason: details.code,\n          }),\n        };\n      }\n      if (wire === \"messages\") {\n        return {\n          body: JSON.stringify({\n            type: \"error\",\n            error: {\n              type: details.type ?? profile.fixtureType,\n              code: details.code,\n              message: details.message,\n            },\n          }),\n        };\n      }\n      return {\n        body: JSON.stringify({\n          error: {\n            message: details.message,\n            type: details.type ?? profile.fixtureType,\n            code: details.code,\n          },\n        }),\n      };\n    case \"misbehavior\":\n      if (wire === \"openai\") {\n        return { body: JSON.stringify({ error: buildOpenAIError(details) }) };\n      }\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: { code: details.bodyCode, message: details.message, status: details.status },\n          }),\n        };\n      }\n      if (wire === \"cohere\") {\n        return { body: JSON.stringify({ message: details.message, code: details.code }) };\n      }\n      if (wire === \"ollama\") {\n        return { body: JSON.stringify({ error: `${details.code}: ${details.message}` }) };\n      }\n      if (wire === \"bedrock-converse\") {\n        return {\n          body: JSON.stringify({\n            __type: details.type,\n            message: details.message,\n            code: details.code,\n          }),\n          headers:\n            details.type === undefined || details.type === null\n              ? undefined\n              : { \"x-amzn-errortype\": details.type },\n        };\n      }\n      if (wire === \"bedrock\") {\n        return {\n          body: JSON.stringify({\n            __type: details.type,\n            code: details.code,\n            message: details.message,\n          }),\n          headers:\n            details.type === undefined || details.type === null\n              ? undefined\n              : { \"x-amzn-errortype\": details.type },\n        };\n      }\n      return {\n        body: JSON.stringify({\n          type: \"error\",\n          error: { type: details.type, code: details.code, message: details.message },\n        }),\n      };\n    case \"unknown-response\":\n      if (wire === \"gemini\") {\n        return {\n          body: JSON.stringify({\n            error: { message: details.message, code: details.bodyCode, status: details.status },\n          }),\n        };\n      }\n      if (wire === \"openai\") {\n        return {\n          body: JSON.stringify({\n            error: buildOpenAIError({ ...details, type: details.type ?? \"server_error\" }),\n          }),\n        };\n      }\n      return {\n        body: JSON.stringify({\n          error: { message: details.message, type: details.type ?? \"server_error\" },\n        }),\n      };\n    case \"transport-failure\":\n      return {\n        body: JSON.stringify({\n          error: { message: details.message, type: details.type ?? \"proxy_error\" },\n        }),\n      };\n  }\n}\n"],"mappings":";;;AA8DA,SAAgB,iBACd,OACA,SAC+D;AAC/D,KAAI,UAAU,sBAAsB;AAClC,MAAI,CAAC,QAAS,OAAM,IAAI,UAAU,2CAA2C;AAC7E,SAAO,EACL,OAAO;GAAE,SAAS,QAAQ;GAAS,MAAM,cAAc,OAAO;GAAgB,EAC/E;;AAEH,KAAI,UAAU,oBAAoB;AAChC,MAAI,CAAC,WAAW,OAAO,QAAQ,SAAS,SACtC,OAAM,IAAI,UAAU,2CAA2C;AACjE,SAAO,EACL,OAAO;GACL,MAAM,QAAQ;GACd,SAAS,QAAQ;GACjB,GAAI,QAAQ,aAAa,UAAa,EAAE,UAAU,QAAQ,UAAU;GACrE,EACF;;AAEH,QAAO;EACL,SAAS,MAAM;EACf,MAAM,MAAM;EACZ,GAAI,MAAM,iBAAiB,OAAO,EAAE,OAAO,MAAM,SAAS,MAAM,GAAG,EAAE;EACrE,MAAM,MAAM;EACb;;;AAIH,SAAgB,YACd,MACA,SACA,SACoD;AACpD,KAAI,SAAS,eACX,QAAO,EAAE,MAAM,KAAK,UAAU,EAAE,OAAO,QAAQ,SAAS,CAAC,EAAE;CAE7D,MAAM,UAAU,cAAc;AAC9B,KACE,SAAS,mBACR,YAAY,gBACX,YAAY,iBACZ,YAAY,kBACZ,YAAY,aACZ,YAAY,iBACZ,YAAY,oBAEd,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;EAAE,MAAM,QAAQ,QAAQ;EAAoB,SAAS,QAAQ;EAAS,EAC9E,CAAC,EACH;AAEH,SAAQ,SAAR;EACE,KAAK;AACH,OAAI,SAAS,WACX,QAAO,EACL,MAAM,KAAK,UAAU;IACnB,MAAM;IACN,OAAO;KAAE,MAAM;KAAwB,SAAS,QAAQ;KAAS;IAClE,CAAC,EACH;AAEH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,MAAM;IAAK,SAAS,QAAQ;IAAS,QAAQ;IAAmB,EAC1E,CAAC,EACH;AAEH,UAAO,YAAY,MAAM,eAAe,QAAQ;EAClD,KAAK,cACH,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;GACL,SAAS,QAAQ;GACjB,MAAM;GACN,MAAM;GACP,EACF,CAAC,EACH;EACH,KAAK,iBACH,QAAO,EAAE,MAAM,KAAK,UAAU,EAAE,OAAO,EAAE,SAAS,QAAQ,SAAS,EAAE,CAAC,EAAE;EAC1E,KAAK,gBACH,QAAO,EACL,MAAM,KAAK,UAAU,EAAE,OAAO;GAAE,SAAS,QAAQ;GAAS,MAAM,QAAQ;GAAM,EAAE,CAAC,EAClF;EACH,KAAK;AACH,OAAI,SAAS,SAAU,QAAO,EAAE,MAAM,KAAK,UAAU,EAAE,OAAO,QAAQ,SAAS,CAAC,EAAE;AAClF,OAAI,SAAS,SAAU,QAAO,EAAE,MAAM,KAAK,UAAU,EAAE,SAAS,QAAQ,SAAS,CAAC,EAAE;AACpF,OAAI,SAAS,eACX,QAAO,EACL,MAAM,KAAK,UAAU,EAAE,OAAO;IAAE,MAAM,QAAQ;IAAM,SAAS,QAAQ;IAAS,EAAE,CAAC,EAClF;AAEH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,MAAM;IAAK,SAAS,QAAQ;IAAS,QAAQ;IAAoB,EAC3E,CAAC,EACH;AAEH,OAAI,SAAS,WACX,QAAO,EACL,MAAM,KAAK,UAAU;IACnB,MAAM;IACN,OAAO;KAAE,MAAM,QAAQ;KAAgB,MAAM,QAAQ;KAAM,SAAS,QAAQ;KAAS;IACtF,CAAC,EACH;AAEH,OAAI,SAAS,aAAa,SAAS,mBACjC,QAAO,EACL,MAAM,KAAK,UAAU;IAAE,QAAQ;IAAuB,SAAS,QAAQ;IAAS,CAAC,EAClF;AAEH,UAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,SAAS,QAAQ;IAAS,MAAM,QAAQ;IAAgB,MAAM,QAAQ;IAAM,EACtF,CAAC,EACH;EACH,KAAK;EACL,KAAK;EACL,KAAK;AACH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,SAAS,QAAQ;IAAS,MAAM,QAAQ;IAAU,QAAQ,QAAQ;IAAQ,EACpF,CAAC,EACH;AAEH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO,iBAAiB;IACtB,GAAG;IACH,MAAM,QAAQ,QAAQ,QAAQ;IAC/B,CAAC,EACH,CAAC,EACH;AAEH,UAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,SAAS,QAAQ;IAAS,MAAM,QAAQ,QAAQ,QAAQ;IAAgB,EAClF,CAAC,EACH;EACH,KAAK,WACH,QAAO,EACL,MAAM,KAAK,UAAU;GACnB,MAAM;GACN,OAAO;IAAE,MAAM,QAAQ,QAAQ,QAAQ;IAAgB,SAAS,QAAQ;IAAS;GACjF,GAAI,SAAS,cAAc,QAAQ,cAAc,SAC7C,EAAE,YAAY,QAAQ,WAAW,GACjC,EAAE;GACP,CAAC,EACH;EACH,KAAK;AACH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,MAAM,QAAQ;IAAU,SAAS,QAAQ;IAAS,QAAQ,QAAQ;IAAQ,EACpF,CAAC,EACH;AAEH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IACL,SAAS,QAAQ;IACjB,MAAM,QAAQ,QAAQ,QAAQ;IAC9B,OAAO,QAAQ,SAAS;IACxB,MAAM,QAAQ,QAAQ;IACvB,EACF,CAAC,EACH;AAEH,UAAO,EACL,MAAM,KAAK,UAAU;IACnB,MAAM;IACN,OAAO;KAAE,MAAM,QAAQ,QAAQ,QAAQ;KAAa,SAAS,QAAQ;KAAS;IAC/E,CAAC,EACH;EACH,KAAK;AACH,OAAI,SAAS,SACX,QAAO,EAAE,MAAM,KAAK,UAAU;IAAE,OAAO,QAAQ;IAAS,MAAM,QAAQ;IAAM,CAAC,EAAE;AAEjF,OAAI,SAAS,eACX,QAAO,EACL,MAAM,KAAK,UAAU,EAAE,OAAO;IAAE,MAAM,QAAQ;IAAM,SAAS,QAAQ;IAAS,EAAE,CAAC,EAClF;AAEH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IACL,MAAM;IACN,SAAS,QAAQ;IACjB,QAAQ;IACR,SAAS,QAAQ;IAClB,EACF,CAAC,EACH;AAEH,OAAI,SAAS,aAAa,SAAS,mBACjC,QAAO,EACL,MAAM,KAAK,UAAU;IACnB,QAAQ,QAAQ,QAAQ,cAAc,QAAQ;IAC9C,SAAS,QAAQ;IACjB,QAAQ,QAAQ;IACjB,CAAC,EACH;AAEH,OAAI,SAAS,WACX,QAAO,EACL,MAAM,KAAK,UAAU;IACnB,MAAM;IACN,OAAO;KACL,MAAM,QAAQ,QAAQ,QAAQ;KAC9B,MAAM,QAAQ;KACd,SAAS,QAAQ;KAClB;IACF,CAAC,EACH;AAEH,UAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IACL,SAAS,QAAQ;IACjB,MAAM,QAAQ,QAAQ,QAAQ;IAC9B,MAAM,QAAQ;IACf,EACF,CAAC,EACH;EACH,KAAK;AACH,OAAI,SAAS,SACX,QAAO,EAAE,MAAM,KAAK,UAAU,EAAE,OAAO,iBAAiB,QAAQ,EAAE,CAAC,EAAE;AAEvE,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,MAAM,QAAQ;IAAU,SAAS,QAAQ;IAAS,QAAQ,QAAQ;IAAQ,EACpF,CAAC,EACH;AAEH,OAAI,SAAS,SACX,QAAO,EAAE,MAAM,KAAK,UAAU;IAAE,SAAS,QAAQ;IAAS,MAAM,QAAQ;IAAM,CAAC,EAAE;AAEnF,OAAI,SAAS,SACX,QAAO,EAAE,MAAM,KAAK,UAAU,EAAE,OAAO,GAAG,QAAQ,KAAK,IAAI,QAAQ,WAAW,CAAC,EAAE;AAEnF,OAAI,SAAS,mBACX,QAAO;IACL,MAAM,KAAK,UAAU;KACnB,QAAQ,QAAQ;KAChB,SAAS,QAAQ;KACjB,MAAM,QAAQ;KACf,CAAC;IACF,SACE,QAAQ,SAAS,UAAa,QAAQ,SAAS,OAC3C,SACA,EAAE,oBAAoB,QAAQ,MAAM;IAC3C;AAEH,OAAI,SAAS,UACX,QAAO;IACL,MAAM,KAAK,UAAU;KACnB,QAAQ,QAAQ;KAChB,MAAM,QAAQ;KACd,SAAS,QAAQ;KAClB,CAAC;IACF,SACE,QAAQ,SAAS,UAAa,QAAQ,SAAS,OAC3C,SACA,EAAE,oBAAoB,QAAQ,MAAM;IAC3C;AAEH,UAAO,EACL,MAAM,KAAK,UAAU;IACnB,MAAM;IACN,OAAO;KAAE,MAAM,QAAQ;KAAM,MAAM,QAAQ;KAAM,SAAS,QAAQ;KAAS;IAC5E,CAAC,EACH;EACH,KAAK;AACH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,SAAS,QAAQ;IAAS,MAAM,QAAQ;IAAU,QAAQ,QAAQ;IAAQ,EACpF,CAAC,EACH;AAEH,OAAI,SAAS,SACX,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO,iBAAiB;IAAE,GAAG;IAAS,MAAM,QAAQ,QAAQ;IAAgB,CAAC,EAC9E,CAAC,EACH;AAEH,UAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;IAAE,SAAS,QAAQ;IAAS,MAAM,QAAQ,QAAQ;IAAgB,EAC1E,CAAC,EACH;EACH,KAAK,oBACH,QAAO,EACL,MAAM,KAAK,UAAU,EACnB,OAAO;GAAE,SAAS,QAAQ;GAAS,MAAM,QAAQ,QAAQ;GAAe,EACzE,CAAC,EACH"}

package/dist/response/finish.cjs

@@ -0,0 +1,39 @@
+
+//#region src/response/finish.ts
+/** Caller defaults stay with the wire; unknown native reasons pass through unchanged. */
+function mapAnthropicFinish(finishReason) {
+	if (finishReason === "stop") return "end_turn";
+	if (finishReason === "tool_calls") return "tool_use";
+	if (finishReason === "length") return "max_tokens";
+	return finishReason;
+}
+/** Responses status has its own table; caller defaults remain outside the mapper. */
+function mapResponsesFinish(finishReason) {
+	if (finishReason === "stop") return "completed";
+	if (finishReason === "tool_calls") return "completed";
+	if (finishReason === "length") return "incomplete";
+	if (finishReason === "content_filter") return "failed";
+	return finishReason;
+}
+/** Gemini and Vertex keep their distinct native finish reasons and caller defaults. */
+function mapGeminiFinish(finishReason) {
+	if (finishReason === "stop") return "STOP";
+	if (finishReason === "tool_calls") return "FUNCTION_CALL";
+	if (finishReason === "length") return "MAX_TOKENS";
+	if (finishReason === "content_filter") return "SAFETY";
+	return finishReason;
+}
+/** Cohere has its own native finish table; callers retain their falsy defaults. */
+function mapCohereFinish(finishReason) {
+	if (finishReason === "stop") return "COMPLETE";
+	if (finishReason === "tool_calls") return "TOOL_CALL";
+	if (finishReason === "length") return "MAX_TOKENS";
+	return finishReason;
+}
+
+//#endregion
+exports.mapAnthropicFinish = mapAnthropicFinish;
+exports.mapCohereFinish = mapCohereFinish;
+exports.mapGeminiFinish = mapGeminiFinish;
+exports.mapResponsesFinish = mapResponsesFinish;
+//# sourceMappingURL=finish.cjs.map

package/dist/response/finish.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"finish.cjs","names":[],"sources":["../../src/response/finish.ts"],"sourcesContent":["/** Caller defaults stay with the wire; unknown native reasons pass through unchanged. */\nexport function mapAnthropicFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"end_turn\";\n  if (finishReason === \"tool_calls\") return \"tool_use\";\n  if (finishReason === \"length\") return \"max_tokens\";\n  return finishReason;\n}\n\n/** Responses status has its own table; caller defaults remain outside the mapper. */\nexport function mapResponsesFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"completed\";\n  if (finishReason === \"tool_calls\") return \"completed\";\n  if (finishReason === \"length\") return \"incomplete\";\n  if (finishReason === \"content_filter\") return \"failed\";\n  return finishReason;\n}\n\n/** Gemini and Vertex keep their distinct native finish reasons and caller defaults. */\nexport function mapGeminiFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"STOP\";\n  if (finishReason === \"tool_calls\") return \"FUNCTION_CALL\";\n  if (finishReason === \"length\") return \"MAX_TOKENS\";\n  if (finishReason === \"content_filter\") return \"SAFETY\";\n  return finishReason;\n}\n\n/** Cohere has its own native finish table; callers retain their falsy defaults. */\nexport function mapCohereFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"COMPLETE\";\n  if (finishReason === \"tool_calls\") return \"TOOL_CALL\";\n  if (finishReason === \"length\") return \"MAX_TOKENS\";\n  return finishReason;\n}\n"],"mappings":";;;AACA,SAAgB,mBAAmB,cAA8B;AAC/D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,QAAO;;;AAIT,SAAgB,mBAAmB,cAA8B;AAC/D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,KAAI,iBAAiB,iBAAkB,QAAO;AAC9C,QAAO;;;AAIT,SAAgB,gBAAgB,cAA8B;AAC5D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,KAAI,iBAAiB,iBAAkB,QAAO;AAC9C,QAAO;;;AAIT,SAAgB,gBAAgB,cAA8B;AAC5D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,QAAO"}

package/dist/response/finish.js

@@ -0,0 +1,35 @@
+//#region src/response/finish.ts
+/** Caller defaults stay with the wire; unknown native reasons pass through unchanged. */
+function mapAnthropicFinish(finishReason) {
+	if (finishReason === "stop") return "end_turn";
+	if (finishReason === "tool_calls") return "tool_use";
+	if (finishReason === "length") return "max_tokens";
+	return finishReason;
+}
+/** Responses status has its own table; caller defaults remain outside the mapper. */
+function mapResponsesFinish(finishReason) {
+	if (finishReason === "stop") return "completed";
+	if (finishReason === "tool_calls") return "completed";
+	if (finishReason === "length") return "incomplete";
+	if (finishReason === "content_filter") return "failed";
+	return finishReason;
+}
+/** Gemini and Vertex keep their distinct native finish reasons and caller defaults. */
+function mapGeminiFinish(finishReason) {
+	if (finishReason === "stop") return "STOP";
+	if (finishReason === "tool_calls") return "FUNCTION_CALL";
+	if (finishReason === "length") return "MAX_TOKENS";
+	if (finishReason === "content_filter") return "SAFETY";
+	return finishReason;
+}
+/** Cohere has its own native finish table; callers retain their falsy defaults. */
+function mapCohereFinish(finishReason) {
+	if (finishReason === "stop") return "COMPLETE";
+	if (finishReason === "tool_calls") return "TOOL_CALL";
+	if (finishReason === "length") return "MAX_TOKENS";
+	return finishReason;
+}
+
+//#endregion
+export { mapAnthropicFinish, mapCohereFinish, mapGeminiFinish, mapResponsesFinish };
+//# sourceMappingURL=finish.js.map

package/dist/response/finish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"finish.js","names":[],"sources":["../../src/response/finish.ts"],"sourcesContent":["/** Caller defaults stay with the wire; unknown native reasons pass through unchanged. */\nexport function mapAnthropicFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"end_turn\";\n  if (finishReason === \"tool_calls\") return \"tool_use\";\n  if (finishReason === \"length\") return \"max_tokens\";\n  return finishReason;\n}\n\n/** Responses status has its own table; caller defaults remain outside the mapper. */\nexport function mapResponsesFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"completed\";\n  if (finishReason === \"tool_calls\") return \"completed\";\n  if (finishReason === \"length\") return \"incomplete\";\n  if (finishReason === \"content_filter\") return \"failed\";\n  return finishReason;\n}\n\n/** Gemini and Vertex keep their distinct native finish reasons and caller defaults. */\nexport function mapGeminiFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"STOP\";\n  if (finishReason === \"tool_calls\") return \"FUNCTION_CALL\";\n  if (finishReason === \"length\") return \"MAX_TOKENS\";\n  if (finishReason === \"content_filter\") return \"SAFETY\";\n  return finishReason;\n}\n\n/** Cohere has its own native finish table; callers retain their falsy defaults. */\nexport function mapCohereFinish(finishReason: string): string {\n  if (finishReason === \"stop\") return \"COMPLETE\";\n  if (finishReason === \"tool_calls\") return \"TOOL_CALL\";\n  if (finishReason === \"length\") return \"MAX_TOKENS\";\n  return finishReason;\n}\n"],"mappings":";;AACA,SAAgB,mBAAmB,cAA8B;AAC/D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,QAAO;;;AAIT,SAAgB,mBAAmB,cAA8B;AAC/D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,KAAI,iBAAiB,iBAAkB,QAAO;AAC9C,QAAO;;;AAIT,SAAgB,gBAAgB,cAA8B;AAC5D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,KAAI,iBAAiB,iBAAkB,QAAO;AAC9C,QAAO;;;AAIT,SAAgB,gBAAgB,cAA8B;AAC5D,KAAI,iBAAiB,OAAQ,QAAO;AACpC,KAAI,iBAAiB,aAAc,QAAO;AAC1C,KAAI,iBAAiB,SAAU,QAAO;AACtC,QAAO"}

package/dist/response/frame-loop.cjs

@@ -0,0 +1,102 @@
+const require_sse_writer = require('../sse-writer.cjs');
+
+//#region src/response/frame-loop.ts
+/** An HTTP response as a frame sink. Gone means destroyed. */
+function httpSink(res) {
+	return {
+		gone: () => res.destroyed,
+		writableEnded: () => res.writableEnded,
+		headersSent: () => res.headersSent,
+		write: (chunk) => {
+			res.write(chunk);
+		},
+		end: () => {
+			res.end();
+		},
+		setHeader: (name, value) => {
+			res.setHeader(name, value);
+		},
+		writeHead: (status, headers) => {
+			res.writeHead(status, headers);
+		}
+	};
+}
+/** A WebSocket connection as a frame sink. Gone means closed; it never ends. */
+function wsSink(ws) {
+	return {
+		gone: () => ws.isClosed,
+		writableEnded: () => false,
+		write: (chunk) => {
+			ws.send(typeof chunk === "string" ? chunk : chunk.toString("utf8"));
+		},
+		end: () => {}
+	};
+}
+/**
+* The shared streaming loop. Per frame, in order: gone check (with
+* `checkGoneBeforeDelay`) → `calculateDelay` → `delay(d, signal)` → abort
+* check → gone check (with `checkGoneBeforeDelay`) → `writableEnded` (return
+* `true`) → write → advance the index and tick (counting frames only) → abort
+* re-check. After the last frame the trailer and `end()` run if the response
+* has not ended. Returns `false` when stopped by an abort, or by a gone sink
+* (with a lifecycle or `checkGoneBeforeDelay`), including an abort before the
+* first frame or with no frames, and `true` otherwise. Rejects with a
+* `TypeError` when given both a lifecycle and a signal, or a status for a sink
+* without `writeHead`.
+*
+* With a lifecycle, a response that other code already answered is not a
+* completed delivery: an ended response (at entry or at the `writableEnded`
+* check) returns `false`, and so does a head already committed at entry,
+* which `setHeader`/`writeHead` would reject with `ERR_HTTP_HEADERS_SENT`.
+* Without a lifecycle (the exported writers) an ended response still returns
+* `true`, as base did.
+*/
+async function runFrameLoop(sink, frames, codec, timing, opts = {}) {
+	const { lifecycle } = opts;
+	if (lifecycle !== void 0 && opts.signal !== void 0) throw new TypeError("runFrameLoop: pass a lifecycle or a signal, not both");
+	const signal = lifecycle?.signal ?? opts.signal;
+	const stopped = () => signal?.aborted === true || lifecycle !== void 0 && sink.gone();
+	const endedIsCompleted = lifecycle === void 0;
+	if (sink.writableEnded()) return endedIsCompleted;
+	if (lifecycle && sink.gone()) return false;
+	if (lifecycle && sink.headersSent?.() === true) return false;
+	const headers = opts.headers === void 0 ? codec.headers : {
+		...codec.headers,
+		...opts.headers
+	};
+	if (opts.status !== void 0 || codec.writeHeadImmediately) {
+		if (!sink.writeHead) throw new TypeError("runFrameLoop: a status was requested but the sink has no writeHead");
+		sink.writeHead(opts.status ?? 200, headers);
+	} else if (sink.setHeader) for (const [name, value] of Object.entries(headers)) sink.setHeader(name, value);
+	if (codec.prelude && !sink.writableEnded()) {
+		const prelude = codec.prelude();
+		if (prelude !== void 0) sink.write(prelude);
+	}
+	let chunkIndex = 0;
+	for (const frame of frames) {
+		if (codec.checkGoneBeforeDelay && sink.gone()) return false;
+		const chunkDelay = require_sse_writer.calculateDelay(chunkIndex, timing.streamingProfile, timing.latency ?? 0, timing.recordedTimings, timing.replaySpeed);
+		if (chunkDelay > 0) await require_sse_writer.delay(chunkDelay, signal);
+		if (stopped()) return false;
+		if (codec.checkGoneBeforeDelay && sink.gone()) return false;
+		if (sink.writableEnded()) return endedIsCompleted;
+		sink.write(codec.encode(frame));
+		if (codec.counts?.(frame) !== false) {
+			chunkIndex++;
+			opts.onChunkSent?.();
+		}
+		if (stopped()) return false;
+	}
+	if (stopped()) return false;
+	if (!sink.writableEnded()) {
+		for (const part of codec.trailer?.(false) ?? []) sink.write(part);
+		sink.end();
+	}
+	return true;
+}
+
+//#endregion
+exports.httpSink = httpSink;
+exports.runFrameLoop = runFrameLoop;
+exports.wsSink = wsSink;
+//# sourceMappingURL=frame-loop.cjs.map

package/dist/response/frame-loop.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame-loop.cjs","names":["calculateDelay","delay"],"sources":["../../src/response/frame-loop.ts"],"sourcesContent":["import type * as http from \"node:http\";\nimport type { RecordedTimings, StreamingProfile } from \"../types.js\";\nimport type { WebSocketConnection } from \"../ws-framing.js\";\nimport { calculateDelay, delay } from \"../sse-writer.js\";\nimport type { DeliveryLifecycle } from \"./lifecycle.js\";\n\n/**\n * How one wire frames a stream. The frame loop is the same for every wire;\n * only these parts differ.\n */\nexport interface FrameCodec<F> {\n  /** Response headers, set before the first write (skipped if the response already ended). */\n  headers: Record<string, string>;\n  /** Written once before the first frame, when it returns a value (the OpenRouter keepalive in `sseCodec`). */\n  prelude?: () => string | Buffer | undefined;\n  /** The bytes for one frame. */\n  encode(frame: F): string | Buffer;\n  /**\n   * Whether a frame advances the chunk index and the fixture tick (default\n   * true). A frame that does not count still pays the delay at the current\n   * index.\n   */\n  counts?(frame: F): boolean;\n  /**\n   * Written after the last frame, before `end()`, when the response has not\n   * ended. Only a completed delivery reaches it: an aborted one returns `false`\n   * with no trailer and no `end()`, so `aborted` is always `false` here.\n   */\n  trailer?(aborted: boolean): Array<string | Buffer>;\n  /** Send the head with `writeHead` up front instead of `setHeader`. */\n  writeHeadImmediately?: boolean;\n  /**\n   * Check `sink.gone()` before each delay as well as after it, with or\n   * without a lifecycle, and return `false` when gone.\n   */\n  checkGoneBeforeDelay?: boolean;\n}\n\n/**\n * Where frames go: an HTTP response or a WebSocket connection. A sink with no\n * HTTP head (WebSocket) omits `setHeader` and `writeHead`; asking such a sink\n * for a status (`status` or `writeHeadImmediately`) is a programming error.\n */\nexport interface FrameSink {\n  gone(): boolean;\n  writableEnded(): boolean;\n  write(chunk: string | Buffer): void;\n  end(): void;\n  /** Whether the head was already committed (HTTP only). */\n  headersSent?(): boolean;\n  setHeader?(name: string, value: string): void;\n  writeHead?(status: number, headers: Record<string, string>): void;\n}\n\n/** Per-frame delay inputs, passed straight to `calculateDelay`. */\nexport interface FrameTiming {\n  latency?: number;\n  streamingProfile?: StreamingProfile;\n  recordedTimings?: RecordedTimings;\n  replaySpeed?: number;\n}\n\ninterface FrameLoopCommonOptions {\n  onChunkSent?: () => void;\n  /** When given, `writeHead(status, headers)` is sent before the first frame. */\n  status?: number;\n  /** Extra headers, merged over the codec's headers. */\n  headers?: Record<string, string>;\n}\n\n/**\n * The stop source is a `lifecycle` or a bare `signal`, never both: passing both\n * is a programming error and rejects with a `TypeError`.\n */\nexport type FrameLoopOptions = FrameLoopCommonOptions &\n  (\n    | {\n        /**\n         * Its signal stops the loop and `sink.gone()` is checked next to every\n         * abort check.\n         */\n        lifecycle: DeliveryLifecycle;\n        signal?: never;\n      }\n    | {\n        lifecycle?: never;\n        /**\n         * Without a lifecycle, `signal` stops the loop, and a gone sink stops it\n         * only when the codec sets `checkGoneBeforeDelay`.\n         */\n        signal?: AbortSignal;\n      }\n  );\n\n/** An HTTP response as a frame sink. Gone means destroyed. */\nexport function httpSink(res: http.ServerResponse): FrameSink {\n  return {\n    gone: () => res.destroyed,\n    writableEnded: () => res.writableEnded,\n    headersSent: () => res.headersSent,\n    write: (chunk) => {\n      res.write(chunk);\n    },\n    end: () => {\n      res.end();\n    },\n    setHeader: (name, value) => {\n      res.setHeader(name, value);\n    },\n    writeHead: (status, headers) => {\n      res.writeHead(status, headers);\n    },\n  };\n}\n\n/** A WebSocket connection as a frame sink. Gone means closed; it never ends. */\nexport function wsSink(ws: WebSocketConnection): FrameSink {\n  return {\n    gone: () => ws.isClosed,\n    writableEnded: () => false,\n    write: (chunk) => {\n      ws.send(typeof chunk === \"string\" ? chunk : chunk.toString(\"utf8\"));\n    },\n    end: () => {},\n  };\n}\n\n/**\n * The shared streaming loop. Per frame, in order: gone check (with\n * `checkGoneBeforeDelay`) → `calculateDelay` → `delay(d, signal)` → abort\n * check → gone check (with `checkGoneBeforeDelay`) → `writableEnded` (return\n * `true`) → write → advance the index and tick (counting frames only) → abort\n * re-check. After the last frame the trailer and `end()` run if the response\n * has not ended. Returns `false` when stopped by an abort, or by a gone sink\n * (with a lifecycle or `checkGoneBeforeDelay`), including an abort before the\n * first frame or with no frames, and `true` otherwise. Rejects with a\n * `TypeError` when given both a lifecycle and a signal, or a status for a sink\n * without `writeHead`.\n *\n * With a lifecycle, a response that other code already answered is not a\n * completed delivery: an ended response (at entry or at the `writableEnded`\n * check) returns `false`, and so does a head already committed at entry,\n * which `setHeader`/`writeHead` would reject with `ERR_HTTP_HEADERS_SENT`.\n * Without a lifecycle (the exported writers) an ended response still returns\n * `true`, as base did.\n */\nexport async function runFrameLoop<F>(\n  sink: FrameSink,\n  frames: readonly F[],\n  codec: FrameCodec<F>,\n  timing: FrameTiming,\n  opts: FrameLoopOptions = {},\n): Promise<boolean> {\n  const { lifecycle } = opts;\n  if (lifecycle !== undefined && opts.signal !== undefined) {\n    throw new TypeError(\"runFrameLoop: pass a lifecycle or a signal, not both\");\n  }\n  const signal = lifecycle?.signal ?? opts.signal;\n  const stopped = (): boolean =>\n    signal?.aborted === true || (lifecycle !== undefined && sink.gone());\n\n  // With a lifecycle, a response that other code answered is not a completed delivery.\n  const endedIsCompleted = lifecycle === undefined;\n  if (sink.writableEnded()) return endedIsCompleted;\n  if (lifecycle && sink.gone()) return false;\n  if (lifecycle && sink.headersSent?.() === true) return false;\n\n  const headers =\n    opts.headers === undefined ? codec.headers : { ...codec.headers, ...opts.headers };\n  if (opts.status !== undefined || codec.writeHeadImmediately) {\n    if (!sink.writeHead) {\n      throw new TypeError(\"runFrameLoop: a status was requested but the sink has no writeHead\");\n    }\n    sink.writeHead(opts.status ?? 200, headers);\n  } else if (sink.setHeader) {\n    for (const [name, value] of Object.entries(headers)) sink.setHeader(name, value);\n  }\n\n  if (codec.prelude && !sink.writableEnded()) {\n    const prelude = codec.prelude();\n    if (prelude !== undefined) sink.write(prelude);\n  }\n\n  let chunkIndex = 0;\n  for (const frame of frames) {\n    if (codec.checkGoneBeforeDelay && sink.gone()) return false;\n    const chunkDelay = calculateDelay(\n      chunkIndex,\n      timing.streamingProfile,\n      timing.latency ?? 0,\n      timing.recordedTimings,\n      timing.replaySpeed,\n    );\n    if (chunkDelay > 0) await delay(chunkDelay, signal);\n    if (stopped()) return false;\n    if (codec.checkGoneBeforeDelay && sink.gone()) return false;\n    if (sink.writableEnded()) return endedIsCompleted;\n    sink.write(codec.encode(frame));\n    if (codec.counts?.(frame) !== false) {\n      chunkIndex++;\n      opts.onChunkSent?.();\n    }\n    if (stopped()) return false;\n  }\n\n  // An abort the loop never observed (no frames) still stops the delivery.\n  if (stopped()) return false;\n  if (!sink.writableEnded()) {\n    for (const part of codec.trailer?.(false) ?? []) sink.write(part);\n    sink.end();\n  }\n  return true;\n}\n"],"mappings":";;;;AA+FA,SAAgB,SAAS,KAAqC;AAC5D,QAAO;EACL,YAAY,IAAI;EAChB,qBAAqB,IAAI;EACzB,mBAAmB,IAAI;EACvB,QAAQ,UAAU;AAChB,OAAI,MAAM,MAAM;;EAElB,WAAW;AACT,OAAI,KAAK;;EAEX,YAAY,MAAM,UAAU;AAC1B,OAAI,UAAU,MAAM,MAAM;;EAE5B,YAAY,QAAQ,YAAY;AAC9B,OAAI,UAAU,QAAQ,QAAQ;;EAEjC;;;AAIH,SAAgB,OAAO,IAAoC;AACzD,QAAO;EACL,YAAY,GAAG;EACf,qBAAqB;EACrB,QAAQ,UAAU;AAChB,MAAG,KAAK,OAAO,UAAU,WAAW,QAAQ,MAAM,SAAS,OAAO,CAAC;;EAErE,WAAW;EACZ;;;;;;;;;;;;;;;;;;;;;AAsBH,eAAsB,aACpB,MACA,QACA,OACA,QACA,OAAyB,EAAE,EACT;CAClB,MAAM,EAAE,cAAc;AACtB,KAAI,cAAc,UAAa,KAAK,WAAW,OAC7C,OAAM,IAAI,UAAU,uDAAuD;CAE7E,MAAM,SAAS,WAAW,UAAU,KAAK;CACzC,MAAM,gBACJ,QAAQ,YAAY,QAAS,cAAc,UAAa,KAAK,MAAM;CAGrE,MAAM,mBAAmB,cAAc;AACvC,KAAI,KAAK,eAAe,CAAE,QAAO;AACjC,KAAI,aAAa,KAAK,MAAM,CAAE,QAAO;AACrC,KAAI,aAAa,KAAK,eAAe,KAAK,KAAM,QAAO;CAEvD,MAAM,UACJ,KAAK,YAAY,SAAY,MAAM,UAAU;EAAE,GAAG,MAAM;EAAS,GAAG,KAAK;EAAS;AACpF,KAAI,KAAK,WAAW,UAAa,MAAM,sBAAsB;AAC3D,MAAI,CAAC,KAAK,UACR,OAAM,IAAI,UAAU,qEAAqE;AAE3F,OAAK,UAAU,KAAK,UAAU,KAAK,QAAQ;YAClC,KAAK,UACd,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,CAAE,MAAK,UAAU,MAAM,MAAM;AAGlF,KAAI,MAAM,WAAW,CAAC,KAAK,eAAe,EAAE;EAC1C,MAAM,UAAU,MAAM,SAAS;AAC/B,MAAI,YAAY,OAAW,MAAK,MAAM,QAAQ;;CAGhD,IAAI,aAAa;AACjB,MAAK,MAAM,SAAS,QAAQ;AAC1B,MAAI,MAAM,wBAAwB,KAAK,MAAM,CAAE,QAAO;EACtD,MAAM,aAAaA,kCACjB,YACA,OAAO,kBACP,OAAO,WAAW,GAClB,OAAO,iBACP,OAAO,YACR;AACD,MAAI,aAAa,EAAG,OAAMC,yBAAM,YAAY,OAAO;AACnD,MAAI,SAAS,CAAE,QAAO;AACtB,MAAI,MAAM,wBAAwB,KAAK,MAAM,CAAE,QAAO;AACtD,MAAI,KAAK,eAAe,CAAE,QAAO;AACjC,OAAK,MAAM,MAAM,OAAO,MAAM,CAAC;AAC/B,MAAI,MAAM,SAAS,MAAM,KAAK,OAAO;AACnC;AACA,QAAK,eAAe;;AAEtB,MAAI,SAAS,CAAE,QAAO;;AAIxB,KAAI,SAAS,CAAE,QAAO;AACtB,KAAI,CAAC,KAAK,eAAe,EAAE;AACzB,OAAK,MAAM,QAAQ,MAAM,UAAU,MAAM,IAAI,EAAE,CAAE,MAAK,MAAM,KAAK;AACjE,OAAK,KAAK;;AAEZ,QAAO"}

package/dist/response/frame-loop.js

@@ -0,0 +1,100 @@
+import { calculateDelay, delay } from "../sse-writer.js";
+
+//#region src/response/frame-loop.ts
+/** An HTTP response as a frame sink. Gone means destroyed. */
+function httpSink(res) {
+	return {
+		gone: () => res.destroyed,
+		writableEnded: () => res.writableEnded,
+		headersSent: () => res.headersSent,
+		write: (chunk) => {
+			res.write(chunk);
+		},
+		end: () => {
+			res.end();
+		},
+		setHeader: (name, value) => {
+			res.setHeader(name, value);
+		},
+		writeHead: (status, headers) => {
+			res.writeHead(status, headers);
+		}
+	};
+}
+/** A WebSocket connection as a frame sink. Gone means closed; it never ends. */
+function wsSink(ws) {
+	return {
+		gone: () => ws.isClosed,
+		writableEnded: () => false,
+		write: (chunk) => {
+			ws.send(typeof chunk === "string" ? chunk : chunk.toString("utf8"));
+		},
+		end: () => {}
+	};
+}
+/**
+* The shared streaming loop. Per frame, in order: gone check (with
+* `checkGoneBeforeDelay`) → `calculateDelay` → `delay(d, signal)` → abort
+* check → gone check (with `checkGoneBeforeDelay`) → `writableEnded` (return
+* `true`) → write → advance the index and tick (counting frames only) → abort
+* re-check. After the last frame the trailer and `end()` run if the response
+* has not ended. Returns `false` when stopped by an abort, or by a gone sink
+* (with a lifecycle or `checkGoneBeforeDelay`), including an abort before the
+* first frame or with no frames, and `true` otherwise. Rejects with a
+* `TypeError` when given both a lifecycle and a signal, or a status for a sink
+* without `writeHead`.
+*
+* With a lifecycle, a response that other code already answered is not a
+* completed delivery: an ended response (at entry or at the `writableEnded`
+* check) returns `false`, and so does a head already committed at entry,
+* which `setHeader`/`writeHead` would reject with `ERR_HTTP_HEADERS_SENT`.
+* Without a lifecycle (the exported writers) an ended response still returns
+* `true`, as base did.
+*/
+async function runFrameLoop(sink, frames, codec, timing, opts = {}) {
+	const { lifecycle } = opts;
+	if (lifecycle !== void 0 && opts.signal !== void 0) throw new TypeError("runFrameLoop: pass a lifecycle or a signal, not both");
+	const signal = lifecycle?.signal ?? opts.signal;
+	const stopped = () => signal?.aborted === true || lifecycle !== void 0 && sink.gone();
+	const endedIsCompleted = lifecycle === void 0;
+	if (sink.writableEnded()) return endedIsCompleted;
+	if (lifecycle && sink.gone()) return false;
+	if (lifecycle && sink.headersSent?.() === true) return false;
+	const headers = opts.headers === void 0 ? codec.headers : {
+		...codec.headers,
+		...opts.headers
+	};
+	if (opts.status !== void 0 || codec.writeHeadImmediately) {
+		if (!sink.writeHead) throw new TypeError("runFrameLoop: a status was requested but the sink has no writeHead");
+		sink.writeHead(opts.status ?? 200, headers);
+	} else if (sink.setHeader) for (const [name, value] of Object.entries(headers)) sink.setHeader(name, value);
+	if (codec.prelude && !sink.writableEnded()) {
+		const prelude = codec.prelude();
+		if (prelude !== void 0) sink.write(prelude);
+	}
+	let chunkIndex = 0;
+	for (const frame of frames) {
+		if (codec.checkGoneBeforeDelay && sink.gone()) return false;
+		const chunkDelay = calculateDelay(chunkIndex, timing.streamingProfile, timing.latency ?? 0, timing.recordedTimings, timing.replaySpeed);
+		if (chunkDelay > 0) await delay(chunkDelay, signal);
+		if (stopped()) return false;
+		if (codec.checkGoneBeforeDelay && sink.gone()) return false;
+		if (sink.writableEnded()) return endedIsCompleted;
+		sink.write(codec.encode(frame));
+		if (codec.counts?.(frame) !== false) {
+			chunkIndex++;
+			opts.onChunkSent?.();
+		}
+		if (stopped()) return false;
+	}
+	if (stopped()) return false;
+	if (!sink.writableEnded()) {
+		for (const part of codec.trailer?.(false) ?? []) sink.write(part);
+		sink.end();
+	}
+	return true;
+}
+
+//#endregion
+export { httpSink, runFrameLoop, wsSink };
+//# sourceMappingURL=frame-loop.js.map

package/dist/response/frame-loop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame-loop.js","names":[],"sources":["../../src/response/frame-loop.ts"],"sourcesContent":["import type * as http from \"node:http\";\nimport type { RecordedTimings, StreamingProfile } from \"../types.js\";\nimport type { WebSocketConnection } from \"../ws-framing.js\";\nimport { calculateDelay, delay } from \"../sse-writer.js\";\nimport type { DeliveryLifecycle } from \"./lifecycle.js\";\n\n/**\n * How one wire frames a stream. The frame loop is the same for every wire;\n * only these parts differ.\n */\nexport interface FrameCodec<F> {\n  /** Response headers, set before the first write (skipped if the response already ended). */\n  headers: Record<string, string>;\n  /** Written once before the first frame, when it returns a value (the OpenRouter keepalive in `sseCodec`). */\n  prelude?: () => string | Buffer | undefined;\n  /** The bytes for one frame. */\n  encode(frame: F): string | Buffer;\n  /**\n   * Whether a frame advances the chunk index and the fixture tick (default\n   * true). A frame that does not count still pays the delay at the current\n   * index.\n   */\n  counts?(frame: F): boolean;\n  /**\n   * Written after the last frame, before `end()`, when the response has not\n   * ended. Only a completed delivery reaches it: an aborted one returns `false`\n   * with no trailer and no `end()`, so `aborted` is always `false` here.\n   */\n  trailer?(aborted: boolean): Array<string | Buffer>;\n  /** Send the head with `writeHead` up front instead of `setHeader`. */\n  writeHeadImmediately?: boolean;\n  /**\n   * Check `sink.gone()` before each delay as well as after it, with or\n   * without a lifecycle, and return `false` when gone.\n   */\n  checkGoneBeforeDelay?: boolean;\n}\n\n/**\n * Where frames go: an HTTP response or a WebSocket connection. A sink with no\n * HTTP head (WebSocket) omits `setHeader` and `writeHead`; asking such a sink\n * for a status (`status` or `writeHeadImmediately`) is a programming error.\n */\nexport interface FrameSink {\n  gone(): boolean;\n  writableEnded(): boolean;\n  write(chunk: string | Buffer): void;\n  end(): void;\n  /** Whether the head was already committed (HTTP only). */\n  headersSent?(): boolean;\n  setHeader?(name: string, value: string): void;\n  writeHead?(status: number, headers: Record<string, string>): void;\n}\n\n/** Per-frame delay inputs, passed straight to `calculateDelay`. */\nexport interface FrameTiming {\n  latency?: number;\n  streamingProfile?: StreamingProfile;\n  recordedTimings?: RecordedTimings;\n  replaySpeed?: number;\n}\n\ninterface FrameLoopCommonOptions {\n  onChunkSent?: () => void;\n  /** When given, `writeHead(status, headers)` is sent before the first frame. */\n  status?: number;\n  /** Extra headers, merged over the codec's headers. */\n  headers?: Record<string, string>;\n}\n\n/**\n * The stop source is a `lifecycle` or a bare `signal`, never both: passing both\n * is a programming error and rejects with a `TypeError`.\n */\nexport type FrameLoopOptions = FrameLoopCommonOptions &\n  (\n    | {\n        /**\n         * Its signal stops the loop and `sink.gone()` is checked next to every\n         * abort check.\n         */\n        lifecycle: DeliveryLifecycle;\n        signal?: never;\n      }\n    | {\n        lifecycle?: never;\n        /**\n         * Without a lifecycle, `signal` stops the loop, and a gone sink stops it\n         * only when the codec sets `checkGoneBeforeDelay`.\n         */\n        signal?: AbortSignal;\n      }\n  );\n\n/** An HTTP response as a frame sink. Gone means destroyed. */\nexport function httpSink(res: http.ServerResponse): FrameSink {\n  return {\n    gone: () => res.destroyed,\n    writableEnded: () => res.writableEnded,\n    headersSent: () => res.headersSent,\n    write: (chunk) => {\n      res.write(chunk);\n    },\n    end: () => {\n      res.end();\n    },\n    setHeader: (name, value) => {\n      res.setHeader(name, value);\n    },\n    writeHead: (status, headers) => {\n      res.writeHead(status, headers);\n    },\n  };\n}\n\n/** A WebSocket connection as a frame sink. Gone means closed; it never ends. */\nexport function wsSink(ws: WebSocketConnection): FrameSink {\n  return {\n    gone: () => ws.isClosed,\n    writableEnded: () => false,\n    write: (chunk) => {\n      ws.send(typeof chunk === \"string\" ? chunk : chunk.toString(\"utf8\"));\n    },\n    end: () => {},\n  };\n}\n\n/**\n * The shared streaming loop. Per frame, in order: gone check (with\n * `checkGoneBeforeDelay`) → `calculateDelay` → `delay(d, signal)` → abort\n * check → gone check (with `checkGoneBeforeDelay`) → `writableEnded` (return\n * `true`) → write → advance the index and tick (counting frames only) → abort\n * re-check. After the last frame the trailer and `end()` run if the response\n * has not ended. Returns `false` when stopped by an abort, or by a gone sink\n * (with a lifecycle or `checkGoneBeforeDelay`), including an abort before the\n * first frame or with no frames, and `true` otherwise. Rejects with a\n * `TypeError` when given both a lifecycle and a signal, or a status for a sink\n * without `writeHead`.\n *\n * With a lifecycle, a response that other code already answered is not a\n * completed delivery: an ended response (at entry or at the `writableEnded`\n * check) returns `false`, and so does a head already committed at entry,\n * which `setHeader`/`writeHead` would reject with `ERR_HTTP_HEADERS_SENT`.\n * Without a lifecycle (the exported writers) an ended response still returns\n * `true`, as base did.\n */\nexport async function runFrameLoop<F>(\n  sink: FrameSink,\n  frames: readonly F[],\n  codec: FrameCodec<F>,\n  timing: FrameTiming,\n  opts: FrameLoopOptions = {},\n): Promise<boolean> {\n  const { lifecycle } = opts;\n  if (lifecycle !== undefined && opts.signal !== undefined) {\n    throw new TypeError(\"runFrameLoop: pass a lifecycle or a signal, not both\");\n  }\n  const signal = lifecycle?.signal ?? opts.signal;\n  const stopped = (): boolean =>\n    signal?.aborted === true || (lifecycle !== undefined && sink.gone());\n\n  // With a lifecycle, a response that other code answered is not a completed delivery.\n  const endedIsCompleted = lifecycle === undefined;\n  if (sink.writableEnded()) return endedIsCompleted;\n  if (lifecycle && sink.gone()) return false;\n  if (lifecycle && sink.headersSent?.() === true) return false;\n\n  const headers =\n    opts.headers === undefined ? codec.headers : { ...codec.headers, ...opts.headers };\n  if (opts.status !== undefined || codec.writeHeadImmediately) {\n    if (!sink.writeHead) {\n      throw new TypeError(\"runFrameLoop: a status was requested but the sink has no writeHead\");\n    }\n    sink.writeHead(opts.status ?? 200, headers);\n  } else if (sink.setHeader) {\n    for (const [name, value] of Object.entries(headers)) sink.setHeader(name, value);\n  }\n\n  if (codec.prelude && !sink.writableEnded()) {\n    const prelude = codec.prelude();\n    if (prelude !== undefined) sink.write(prelude);\n  }\n\n  let chunkIndex = 0;\n  for (const frame of frames) {\n    if (codec.checkGoneBeforeDelay && sink.gone()) return false;\n    const chunkDelay = calculateDelay(\n      chunkIndex,\n      timing.streamingProfile,\n      timing.latency ?? 0,\n      timing.recordedTimings,\n      timing.replaySpeed,\n    );\n    if (chunkDelay > 0) await delay(chunkDelay, signal);\n    if (stopped()) return false;\n    if (codec.checkGoneBeforeDelay && sink.gone()) return false;\n    if (sink.writableEnded()) return endedIsCompleted;\n    sink.write(codec.encode(frame));\n    if (codec.counts?.(frame) !== false) {\n      chunkIndex++;\n      opts.onChunkSent?.();\n    }\n    if (stopped()) return false;\n  }\n\n  // An abort the loop never observed (no frames) still stops the delivery.\n  if (stopped()) return false;\n  if (!sink.writableEnded()) {\n    for (const part of codec.trailer?.(false) ?? []) sink.write(part);\n    sink.end();\n  }\n  return true;\n}\n"],"mappings":";;;;AA+FA,SAAgB,SAAS,KAAqC;AAC5D,QAAO;EACL,YAAY,IAAI;EAChB,qBAAqB,IAAI;EACzB,mBAAmB,IAAI;EACvB,QAAQ,UAAU;AAChB,OAAI,MAAM,MAAM;;EAElB,WAAW;AACT,OAAI,KAAK;;EAEX,YAAY,MAAM,UAAU;AAC1B,OAAI,UAAU,MAAM,MAAM;;EAE5B,YAAY,QAAQ,YAAY;AAC9B,OAAI,UAAU,QAAQ,QAAQ;;EAEjC;;;AAIH,SAAgB,OAAO,IAAoC;AACzD,QAAO;EACL,YAAY,GAAG;EACf,qBAAqB;EACrB,QAAQ,UAAU;AAChB,MAAG,KAAK,OAAO,UAAU,WAAW,QAAQ,MAAM,SAAS,OAAO,CAAC;;EAErE,WAAW;EACZ;;;;;;;;;;;;;;;;;;;;;AAsBH,eAAsB,aACpB,MACA,QACA,OACA,QACA,OAAyB,EAAE,EACT;CAClB,MAAM,EAAE,cAAc;AACtB,KAAI,cAAc,UAAa,KAAK,WAAW,OAC7C,OAAM,IAAI,UAAU,uDAAuD;CAE7E,MAAM,SAAS,WAAW,UAAU,KAAK;CACzC,MAAM,gBACJ,QAAQ,YAAY,QAAS,cAAc,UAAa,KAAK,MAAM;CAGrE,MAAM,mBAAmB,cAAc;AACvC,KAAI,KAAK,eAAe,CAAE,QAAO;AACjC,KAAI,aAAa,KAAK,MAAM,CAAE,QAAO;AACrC,KAAI,aAAa,KAAK,eAAe,KAAK,KAAM,QAAO;CAEvD,MAAM,UACJ,KAAK,YAAY,SAAY,MAAM,UAAU;EAAE,GAAG,MAAM;EAAS,GAAG,KAAK;EAAS;AACpF,KAAI,KAAK,WAAW,UAAa,MAAM,sBAAsB;AAC3D,MAAI,CAAC,KAAK,UACR,OAAM,IAAI,UAAU,qEAAqE;AAE3F,OAAK,UAAU,KAAK,UAAU,KAAK,QAAQ;YAClC,KAAK,UACd,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,CAAE,MAAK,UAAU,MAAM,MAAM;AAGlF,KAAI,MAAM,WAAW,CAAC,KAAK,eAAe,EAAE;EAC1C,MAAM,UAAU,MAAM,SAAS;AAC/B,MAAI,YAAY,OAAW,MAAK,MAAM,QAAQ;;CAGhD,IAAI,aAAa;AACjB,MAAK,MAAM,SAAS,QAAQ;AAC1B,MAAI,MAAM,wBAAwB,KAAK,MAAM,CAAE,QAAO;EACtD,MAAM,aAAa,eACjB,YACA,OAAO,kBACP,OAAO,WAAW,GAClB,OAAO,iBACP,OAAO,YACR;AACD,MAAI,aAAa,EAAG,OAAM,MAAM,YAAY,OAAO;AACnD,MAAI,SAAS,CAAE,QAAO;AACtB,MAAI,MAAM,wBAAwB,KAAK,MAAM,CAAE,QAAO;AACtD,MAAI,KAAK,eAAe,CAAE,QAAO;AACjC,OAAK,MAAM,MAAM,OAAO,MAAM,CAAC;AAC/B,MAAI,MAAM,SAAS,MAAM,KAAK,OAAO;AACnC;AACA,QAAK,eAAe;;AAEtB,MAAI,SAAS,CAAE,QAAO;;AAIxB,KAAI,SAAS,CAAE,QAAO;AACtB,KAAI,CAAC,KAAK,eAAe,EAAE;AACzB,OAAK,MAAM,QAAQ,MAAM,UAAU,MAAM,IAAI,EAAE,CAAE,MAAK,MAAM,KAAK;AACjE,OAAK,KAAK;;AAEZ,QAAO"}

package/dist/response/lifecycle.cjs

@@ -0,0 +1,223 @@
+const require_chaos = require('../chaos.cjs');
+const require_interruption = require('../interruption.cjs');
+
+//#region src/response/lifecycle.ts
+/** The journal `interruptReason` for a client that left before the reply finished. */
+const CLIENT_ABORTED = "client aborted";
+/**
+* The journal `interruptReason` for a response aimock tore down itself: the
+* chaos `disconnect` action or a server-side `destroy`. It is the name the
+* chaos journal entry records (`chaosAction: "disconnect"`), so a teardown
+* aimock caused is never blamed on the client.
+*/
+const AIMOCK_DISCONNECTED = "disconnect";
+/**
+* Subscribe to `close`, guarded the same way as `awaitChaosLatency`: a partial
+* test double without `once` is not subscribed, and only a listener that was
+* added is ever removed, through a remover that exists.
+*/
+function subscribeClose(source, onClose) {
+	if (typeof source.once !== "function") return void 0;
+	source.once("close", onClose);
+	if (typeof source.off === "function") return () => source.off?.("close", onClose);
+	if (typeof source.removeListener === "function") return () => source.removeListener?.("close", onClose);
+}
+function createLifecycle(interruption, goneAtStart, subscribe) {
+	const controller = new AbortController();
+	let firstCause;
+	const abortWith = (cause) => {
+		if (controller.signal.aborted) return;
+		firstCause = cause;
+		controller.abort();
+	};
+	const onFixtureAbort = () => abortWith("fixture");
+	interruption?.signal.addEventListener("abort", onFixtureAbort, { once: true });
+	let unsubscribe;
+	if (goneAtStart !== void 0) abortWith(goneAtStart);
+	else unsubscribe = subscribe(abortWith);
+	return {
+		signal: controller.signal,
+		cause: () => firstCause,
+		reason: () => {
+			if (firstCause === "fixture") return interruption?.reason();
+			if (firstCause === "client") return CLIENT_ABORTED;
+			if (firstCause === "server") return AIMOCK_DISCONNECTED;
+		},
+		tick: () => {
+			interruption?.tick();
+		},
+		dispose: () => {
+			unsubscribe?.();
+			unsubscribe = void 0;
+			interruption?.signal.removeEventListener("abort", onFixtureAbort);
+			interruption?.cleanup();
+		}
+	};
+}
+/** The request socket of `res`, or `undefined` when it carries none. */
+function requestSocket(res) {
+	const owner = res;
+	return owner.req?.socket ?? owner.socket ?? void 0;
+}
+/**
+* THE client hang-up rule, shared by the delivery lifecycle and the proxy
+* relay: the client's socket closed or reset.
+*
+* - A reset, or a write into a socket the peer closed, leaves `errored` set
+*   (ECONNRESET / EPIPE).
+* - aimock's server keeps Node's default `httpAllowHalfOpen: false`, so a
+*   client FIN makes Node end our write side: the socket is `writableEnded`
+*   while the response is not. That is the evidence the client closed.
+*
+* A FIN alone (`readableEnded` with neither of those) is not a hang-up: it is
+* what the socket shows when aimock tore the response down before Node
+* answered the FIN. A real client FIN that Node has not answered yet looks the
+* same, so this rule also classifies it as not a hang-up. aimock's own
+* `destroy()` leaves neither signal.
+*/
+function closedByClient(socket) {
+	return (socket.errored ?? null) !== null || socket.writableEnded === true;
+}
+/**
+* Who tore down a response that is gone without having ended. After the fact
+* `res.destroyed` reads the same either way, so this reads the evidence:
+*
+* - a chaos `disconnect` marked the response before destroying it: aimock;
+* - the request socket meets {@link closedByClient}: the client;
+* - neither: aimock destroyed it server-side.
+*
+* `socket` defaults to the response's request socket. With no socket to read
+* (a partial test double) the client attribution is kept.
+*/
+function teardownCause(res, socket = requestSocket(res)) {
+	if (require_chaos.responseGoneReason(res) === "chaos-disconnected") return "server";
+	if (!socket) return "client";
+	return closedByClient(socket) ? "client" : "server";
+}
+/**
+* The request socket's `bytesWritten` when each delivery started, so the
+* status-line rule counts only this response's bytes on a keep-alive socket.
+*/
+const deliveryStartBytes = /* @__PURE__ */ new WeakMap();
+/**
+* Record where this response's bytes start on its socket. A response whose
+* head was already committed when the delivery started is not recorded:
+* {@link statusLineSent} keeps the `headersSent` rule for it.
+*/
+function noteDeliveryStart(res) {
+	if (deliveryStartBytes.has(res) || res.headersSent) return;
+	const bytes = requestSocket(res)?.bytesWritten;
+	if (typeof bytes === "number") deliveryStartBytes.set(res, bytes);
+}
+/**
+* Whether this response's status line reached the client's socket: a byte of
+* it was handed to the socket after {@link noteDeliveryStart}. `headersSent`
+* is not that test: `writeHead` sets it before any byte is written. With no
+* recorded start, or no socket to read, `headersSent` is the fallback.
+*/
+function statusLineSent(res) {
+	const start = deliveryStartBytes.get(res);
+	const bytes = requestSocket(res)?.bytesWritten;
+	if (start === void 0 || typeof bytes !== "number") return res.headersSent;
+	return bytes > start;
+}
+/** The journal `interruptReason` for {@link teardownCause}. */
+function teardownReason(res) {
+	return teardownCause(res) === "client" ? CLIENT_ABORTED : AIMOCK_DISCONNECTED;
+}
+/**
+* HTTP delivery lifecycle. A `close` before `res.writableFinished` aborts it,
+* and {@link teardownCause} decides whose teardown it was: the client
+* (`"client"`) or aimock itself (`"server"`). A response that is already gone
+* at construction aborts at once with the same attribution. A chaos
+* `disconnect` destroys without ending, so no `writableEnded` check stops a
+* writer for it. Only an already-ended response does not abort: the frame
+* loop exits on its `writableEnded` check. The fixture interruption is
+* created only when `streaming` is true (it is streaming-only).
+*/
+function httpLifecycle(res, fixture, opts) {
+	const interruption = opts.streaming && fixture ? require_interruption.createInterruptionSignal(fixture) : null;
+	const gone = require_chaos.responseGoneReason(res);
+	return createLifecycle(interruption, gone === null || gone === "already-ended" ? void 0 : teardownCause(res), (onGone) => subscribeClose(res, () => {
+		if (!res.writableFinished) onGone(teardownCause(res));
+	}));
+}
+/**
+* Per watched connection: whether its `close` event has fired. Only sockets
+* watched while open are recorded, so an entry is evidence, not a guess.
+*/
+const wsCloseEmitted = /* @__PURE__ */ new WeakMap();
+/**
+* Start recording when `ws` emits `close`, so {@link wsClosedCause} can tell
+* aimock's own close from the client's. Each WS transport calls it when the
+* connection opens. Idempotent, and a no-op once closed.
+*/
+function watchWsClose(ws) {
+	if (ws.isClosed || wsCloseEmitted.has(ws)) return;
+	const source = ws;
+	if (typeof source.once !== "function") return;
+	wsCloseEmitted.set(ws, false);
+	source.once("close", () => wsCloseEmitted.set(ws, true));
+}
+/**
+* Who closed a socket that reads `isClosed`, or `undefined` while it is open.
+*
+* `WebSocketConnection` marks itself closed and emits `close` in the same step
+* for a client close frame, a lost connection, and `destroy()`. Only aimock's
+* own `close()` (a write or buffer limit, a bad frame, a strict miss, shutdown)
+* marks it closed at once and emits `close` about 100ms later. So a socket
+* watched while open ({@link watchWsClose}) that is closed with no `close` yet
+* was closed by aimock (`"server"`). Any other closed socket reads as the
+* client leaving, as before.
+*/
+function wsClosedCause(ws) {
+	if (!ws.isClosed) return void 0;
+	return wsCloseEmitted.get(ws) === false ? "server" : "client";
+}
+/**
+* WebSocket turn lifecycle. A WS turn is always a stream, so it always owns
+* the fixture interruption. A `close` means the client left. A socket already
+* closed at construction aborts at once with {@link wsClosedCause}. Callers
+* never create their own interruption object.
+*/
+function wsLifecycle(ws, fixture) {
+	return createLifecycle(fixture ? require_interruption.createInterruptionSignal(fixture) : null, wsClosedCause(ws), (onGone) => subscribeClose(ws, () => onGone("client")));
+}
+/**
+* Journal a WS turn that stopped because its lifecycle aborted or its socket
+* closed. This is the closed-socket rule every WS transport uses: the
+* lifecycle's reason when it has one, else the closed socket's cause
+* ({@link wsClosedCause}): {@link AIMOCK_DISCONNECTED} for aimock's own close,
+* {@link CLIENT_ABORTED} for the client. A turn with no lifecycle (it never
+* waits) passes none.
+*/
+function markWsTurnStopped(entry, ws, lifecycle) {
+	const cause = wsClosedCause(ws);
+	const socketReason = cause === "server" ? AIMOCK_DISCONNECTED : cause === "client" ? CLIENT_ABORTED : void 0;
+	markInterrupted(entry, lifecycle?.reason() ?? socketReason);
+}
+/**
+* Mark a journal entry interrupted. The reason is set only when the entry has
+* none, so a later `undefined` never erases an earlier reason. The status is
+* never changed: the entry keeps the status it was journaled with.
+*/
+function markInterrupted(entry, reason) {
+	entry.response.interrupted = true;
+	if (entry.response.interruptReason === void 0 && reason !== void 0) entry.response.interruptReason = reason;
+}
+
+//#endregion
+exports.AIMOCK_DISCONNECTED = AIMOCK_DISCONNECTED;
+exports.CLIENT_ABORTED = CLIENT_ABORTED;
+exports.closedByClient = closedByClient;
+exports.httpLifecycle = httpLifecycle;
+exports.markInterrupted = markInterrupted;
+exports.markWsTurnStopped = markWsTurnStopped;
+exports.noteDeliveryStart = noteDeliveryStart;
+exports.requestSocket = requestSocket;
+exports.statusLineSent = statusLineSent;
+exports.teardownCause = teardownCause;
+exports.teardownReason = teardownReason;
+exports.watchWsClose = watchWsClose;
+exports.wsLifecycle = wsLifecycle;
+//# sourceMappingURL=lifecycle.cjs.map

package/dist/response/lifecycle.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle.cjs","names":["responseGoneReason","createInterruptionSignal"],"sources":["../../src/response/lifecycle.ts"],"sourcesContent":["import type * as http from \"node:http\";\nimport type { Fixture, JournalEntry } from \"../types.js\";\nimport type { WebSocketConnection } from \"../ws-framing.js\";\nimport { createInterruptionSignal, type InterruptionControl } from \"../interruption.js\";\nimport { responseGoneReason } from \"../chaos.js\";\n\n/** The journal `interruptReason` for a client that left before the reply finished. */\nexport const CLIENT_ABORTED = \"client aborted\";\n\n/**\n * The journal `interruptReason` for a response aimock tore down itself: the\n * chaos `disconnect` action or a server-side `destroy`. It is the name the\n * chaos journal entry records (`chaosAction: \"disconnect\"`), so a teardown\n * aimock caused is never blamed on the client.\n */\nexport const AIMOCK_DISCONNECTED = \"disconnect\";\n\n/**\n * Which side stopped a delivery first: the client, the fixture's own\n * interruption, or aimock tearing the response down (`\"server\"`).\n */\nexport type InterruptCause = \"client\" | \"fixture\" | \"server\";\n\n/**\n * One delivery's stop signal. It merges the fixture interruption\n * (`truncateAfterChunks` / `disconnectAfterMs`) with the client going away\n * and with aimock tearing the response down (`\"server\"`).\n * The first cause wins: a later cause never reclassifies it.\n */\nexport interface DeliveryLifecycle {\n  /** Aborts on the first cause: fixture, client, or server. */\n  readonly signal: AbortSignal;\n  /** The cause that aborted `signal`, or `undefined` while it has not aborted. */\n  cause(): InterruptCause | undefined;\n  /**\n   * The fixture's reason, {@link CLIENT_ABORTED}, {@link AIMOCK_DISCONNECTED},\n   * or `undefined` while running.\n   */\n  reason(): string | undefined;\n  /** Forwards a sent chunk to the fixture interruption (counts toward `truncateAfterChunks`). */\n  tick(): void;\n  /** Removes the close and fixture-abort listeners and clears the fixture's `disconnectAfterMs` timer. */\n  dispose(): void;\n}\n\n/** The part of an EventEmitter a close source may expose. Test doubles may carry less. */\ninterface CloseSource {\n  once?: (event: \"close\", listener: () => void) => unknown;\n  off?: (event: \"close\", listener: () => void) => unknown;\n  removeListener?: (event: \"close\", listener: () => void) => unknown;\n}\n\n/**\n * Subscribe to `close`, guarded the same way as `awaitChaosLatency`: a partial\n * test double without `once` is not subscribed, and only a listener that was\n * added is ever removed, through a remover that exists.\n */\nfunction subscribeClose(source: CloseSource, onClose: () => void): (() => void) | undefined {\n  if (typeof source.once !== \"function\") return undefined;\n  source.once(\"close\", onClose);\n  if (typeof source.off === \"function\") return () => source.off?.(\"close\", onClose);\n  if (typeof source.removeListener === \"function\")\n    return () => source.removeListener?.(\"close\", onClose);\n  return undefined;\n}\n\nfunction createLifecycle(\n  interruption: InterruptionControl | null,\n  goneAtStart: InterruptCause | undefined,\n  subscribe: (onGone: (cause: InterruptCause) => void) => (() => void) | undefined,\n): DeliveryLifecycle {\n  const controller = new AbortController();\n  let firstCause: InterruptCause | undefined;\n  const abortWith = (cause: InterruptCause): void => {\n    if (controller.signal.aborted) return;\n    firstCause = cause;\n    controller.abort();\n  };\n  const onFixtureAbort = (): void => abortWith(\"fixture\");\n  interruption?.signal.addEventListener(\"abort\", onFixtureAbort, { once: true });\n  let unsubscribe: (() => void) | undefined;\n  if (goneAtStart !== undefined) abortWith(goneAtStart);\n  else unsubscribe = subscribe(abortWith);\n  return {\n    signal: controller.signal,\n    cause: () => firstCause,\n    reason: () => {\n      if (firstCause === \"fixture\") return interruption?.reason();\n      if (firstCause === \"client\") return CLIENT_ABORTED;\n      if (firstCause === \"server\") return AIMOCK_DISCONNECTED;\n      return undefined;\n    },\n    tick: () => {\n      interruption?.tick();\n    },\n    dispose: () => {\n      unsubscribe?.();\n      unsubscribe = undefined;\n      interruption?.signal.removeEventListener(\"abort\", onFixtureAbort);\n      interruption?.cleanup();\n    },\n  };\n}\n\n/** The request socket fields the teardown rule and the status-line rule read. */\nexport interface PeerSocket {\n  readonly errored?: Error | null;\n  readonly writableEnded?: boolean;\n  readonly bytesWritten?: number;\n}\n\n/** Where a response's request socket can be read from. Test doubles may carry neither. */\ninterface SocketOwner {\n  readonly req?: { readonly socket?: PeerSocket | null };\n  readonly socket?: PeerSocket | null;\n}\n\n/** The request socket of `res`, or `undefined` when it carries none. */\nexport function requestSocket(res: http.ServerResponse): PeerSocket | undefined {\n  const owner: SocketOwner = res;\n  return owner.req?.socket ?? owner.socket ?? undefined;\n}\n\n/**\n * THE client hang-up rule, shared by the delivery lifecycle and the proxy\n * relay: the client's socket closed or reset.\n *\n * - A reset, or a write into a socket the peer closed, leaves `errored` set\n *   (ECONNRESET / EPIPE).\n * - aimock's server keeps Node's default `httpAllowHalfOpen: false`, so a\n *   client FIN makes Node end our write side: the socket is `writableEnded`\n *   while the response is not. That is the evidence the client closed.\n *\n * A FIN alone (`readableEnded` with neither of those) is not a hang-up: it is\n * what the socket shows when aimock tore the response down before Node\n * answered the FIN. A real client FIN that Node has not answered yet looks the\n * same, so this rule also classifies it as not a hang-up. aimock's own\n * `destroy()` leaves neither signal.\n */\nexport function closedByClient(socket: PeerSocket): boolean {\n  return (socket.errored ?? null) !== null || socket.writableEnded === true;\n}\n\n/**\n * Who tore down a response that is gone without having ended. After the fact\n * `res.destroyed` reads the same either way, so this reads the evidence:\n *\n * - a chaos `disconnect` marked the response before destroying it: aimock;\n * - the request socket meets {@link closedByClient}: the client;\n * - neither: aimock destroyed it server-side.\n *\n * `socket` defaults to the response's request socket. With no socket to read\n * (a partial test double) the client attribution is kept.\n */\nexport function teardownCause(\n  res: http.ServerResponse,\n  socket: PeerSocket | null | undefined = requestSocket(res),\n): \"client\" | \"server\" {\n  if (responseGoneReason(res) === \"chaos-disconnected\") return \"server\";\n  if (!socket) return \"client\";\n  return closedByClient(socket) ? \"client\" : \"server\";\n}\n\n/**\n * The request socket's `bytesWritten` when each delivery started, so the\n * status-line rule counts only this response's bytes on a keep-alive socket.\n */\nconst deliveryStartBytes = new WeakMap<http.ServerResponse, number>();\n\n/**\n * Record where this response's bytes start on its socket. A response whose\n * head was already committed when the delivery started is not recorded:\n * {@link statusLineSent} keeps the `headersSent` rule for it.\n */\nexport function noteDeliveryStart(res: http.ServerResponse): void {\n  if (deliveryStartBytes.has(res) || res.headersSent) return;\n  const bytes = requestSocket(res)?.bytesWritten;\n  if (typeof bytes === \"number\") deliveryStartBytes.set(res, bytes);\n}\n\n/**\n * Whether this response's status line reached the client's socket: a byte of\n * it was handed to the socket after {@link noteDeliveryStart}. `headersSent`\n * is not that test: `writeHead` sets it before any byte is written. With no\n * recorded start, or no socket to read, `headersSent` is the fallback.\n */\nexport function statusLineSent(res: http.ServerResponse): boolean {\n  const start = deliveryStartBytes.get(res);\n  const bytes = requestSocket(res)?.bytesWritten;\n  if (start === undefined || typeof bytes !== \"number\") return res.headersSent;\n  return bytes > start;\n}\n\n/** The journal `interruptReason` for {@link teardownCause}. */\nexport function teardownReason(res: http.ServerResponse): string {\n  return teardownCause(res) === \"client\" ? CLIENT_ABORTED : AIMOCK_DISCONNECTED;\n}\n\n/**\n * HTTP delivery lifecycle. A `close` before `res.writableFinished` aborts it,\n * and {@link teardownCause} decides whose teardown it was: the client\n * (`\"client\"`) or aimock itself (`\"server\"`). A response that is already gone\n * at construction aborts at once with the same attribution. A chaos\n * `disconnect` destroys without ending, so no `writableEnded` check stops a\n * writer for it. Only an already-ended response does not abort: the frame\n * loop exits on its `writableEnded` check. The fixture interruption is\n * created only when `streaming` is true (it is streaming-only).\n */\nexport function httpLifecycle(\n  res: http.ServerResponse,\n  fixture: Fixture | null,\n  opts: { streaming: boolean },\n): DeliveryLifecycle {\n  const interruption = opts.streaming && fixture ? createInterruptionSignal(fixture) : null;\n  const gone = responseGoneReason(res);\n  const goneAtStart = gone === null || gone === \"already-ended\" ? undefined : teardownCause(res);\n  return createLifecycle(interruption, goneAtStart, (onGone) =>\n    subscribeClose(res, () => {\n      if (!res.writableFinished) onGone(teardownCause(res));\n    }),\n  );\n}\n\n/**\n * Per watched connection: whether its `close` event has fired. Only sockets\n * watched while open are recorded, so an entry is evidence, not a guess.\n */\nconst wsCloseEmitted = new WeakMap<WebSocketConnection, boolean>();\n\n/**\n * Start recording when `ws` emits `close`, so {@link wsClosedCause} can tell\n * aimock's own close from the client's. Each WS transport calls it when the\n * connection opens. Idempotent, and a no-op once closed.\n */\nexport function watchWsClose(ws: WebSocketConnection): void {\n  if (ws.isClosed || wsCloseEmitted.has(ws)) return;\n  const source: CloseSource = ws;\n  if (typeof source.once !== \"function\") return;\n  wsCloseEmitted.set(ws, false);\n  source.once(\"close\", () => wsCloseEmitted.set(ws, true));\n}\n\n/**\n * Who closed a socket that reads `isClosed`, or `undefined` while it is open.\n *\n * `WebSocketConnection` marks itself closed and emits `close` in the same step\n * for a client close frame, a lost connection, and `destroy()`. Only aimock's\n * own `close()` (a write or buffer limit, a bad frame, a strict miss, shutdown)\n * marks it closed at once and emits `close` about 100ms later. So a socket\n * watched while open ({@link watchWsClose}) that is closed with no `close` yet\n * was closed by aimock (`\"server\"`). Any other closed socket reads as the\n * client leaving, as before.\n */\nexport function wsClosedCause(ws: WebSocketConnection): \"client\" | \"server\" | undefined {\n  if (!ws.isClosed) return undefined;\n  return wsCloseEmitted.get(ws) === false ? \"server\" : \"client\";\n}\n\n/**\n * WebSocket turn lifecycle. A WS turn is always a stream, so it always owns\n * the fixture interruption. A `close` means the client left. A socket already\n * closed at construction aborts at once with {@link wsClosedCause}. Callers\n * never create their own interruption object.\n */\nexport function wsLifecycle(ws: WebSocketConnection, fixture: Fixture | null): DeliveryLifecycle {\n  const interruption = fixture ? createInterruptionSignal(fixture) : null;\n  return createLifecycle(interruption, wsClosedCause(ws), (onGone) =>\n    subscribeClose(ws, () => onGone(\"client\")),\n  );\n}\n\n/**\n * Journal a WS turn that stopped because its lifecycle aborted or its socket\n * closed. This is the closed-socket rule every WS transport uses: the\n * lifecycle's reason when it has one, else the closed socket's cause\n * ({@link wsClosedCause}): {@link AIMOCK_DISCONNECTED} for aimock's own close,\n * {@link CLIENT_ABORTED} for the client. A turn with no lifecycle (it never\n * waits) passes none.\n */\nexport function markWsTurnStopped(\n  entry: JournalEntry,\n  ws: WebSocketConnection,\n  lifecycle?: DeliveryLifecycle,\n): void {\n  const cause = wsClosedCause(ws);\n  const socketReason =\n    cause === \"server\" ? AIMOCK_DISCONNECTED : cause === \"client\" ? CLIENT_ABORTED : undefined;\n  markInterrupted(entry, lifecycle?.reason() ?? socketReason);\n}\n\n/**\n * Mark a journal entry interrupted. The reason is set only when the entry has\n * none, so a later `undefined` never erases an earlier reason. The status is\n * never changed: the entry keeps the status it was journaled with.\n */\nexport function markInterrupted(entry: JournalEntry, reason: string | undefined): void {\n  entry.response.interrupted = true;\n  if (entry.response.interruptReason === undefined && reason !== undefined) {\n    entry.response.interruptReason = reason;\n  }\n}\n"],"mappings":";;;;;AAOA,MAAa,iBAAiB;;;;;;;AAQ9B,MAAa,sBAAsB;;;;;;AA0CnC,SAAS,eAAe,QAAqB,SAA+C;AAC1F,KAAI,OAAO,OAAO,SAAS,WAAY,QAAO;AAC9C,QAAO,KAAK,SAAS,QAAQ;AAC7B,KAAI,OAAO,OAAO,QAAQ,WAAY,cAAa,OAAO,MAAM,SAAS,QAAQ;AACjF,KAAI,OAAO,OAAO,mBAAmB,WACnC,cAAa,OAAO,iBAAiB,SAAS,QAAQ;;AAI1D,SAAS,gBACP,cACA,aACA,WACmB;CACnB,MAAM,aAAa,IAAI,iBAAiB;CACxC,IAAI;CACJ,MAAM,aAAa,UAAgC;AACjD,MAAI,WAAW,OAAO,QAAS;AAC/B,eAAa;AACb,aAAW,OAAO;;CAEpB,MAAM,uBAA6B,UAAU,UAAU;AACvD,eAAc,OAAO,iBAAiB,SAAS,gBAAgB,EAAE,MAAM,MAAM,CAAC;CAC9E,IAAI;AACJ,KAAI,gBAAgB,OAAW,WAAU,YAAY;KAChD,eAAc,UAAU,UAAU;AACvC,QAAO;EACL,QAAQ,WAAW;EACnB,aAAa;EACb,cAAc;AACZ,OAAI,eAAe,UAAW,QAAO,cAAc,QAAQ;AAC3D,OAAI,eAAe,SAAU,QAAO;AACpC,OAAI,eAAe,SAAU,QAAO;;EAGtC,YAAY;AACV,iBAAc,MAAM;;EAEtB,eAAe;AACb,kBAAe;AACf,iBAAc;AACd,iBAAc,OAAO,oBAAoB,SAAS,eAAe;AACjE,iBAAc,SAAS;;EAE1B;;;AAiBH,SAAgB,cAAc,KAAkD;CAC9E,MAAM,QAAqB;AAC3B,QAAO,MAAM,KAAK,UAAU,MAAM,UAAU;;;;;;;;;;;;;;;;;;AAmB9C,SAAgB,eAAe,QAA6B;AAC1D,SAAQ,OAAO,WAAW,UAAU,QAAQ,OAAO,kBAAkB;;;;;;;;;;;;;AAcvE,SAAgB,cACd,KACA,SAAwC,cAAc,IAAI,EACrC;AACrB,KAAIA,iCAAmB,IAAI,KAAK,qBAAsB,QAAO;AAC7D,KAAI,CAAC,OAAQ,QAAO;AACpB,QAAO,eAAe,OAAO,GAAG,WAAW;;;;;;AAO7C,MAAM,qCAAqB,IAAI,SAAsC;;;;;;AAOrE,SAAgB,kBAAkB,KAAgC;AAChE,KAAI,mBAAmB,IAAI,IAAI,IAAI,IAAI,YAAa;CACpD,MAAM,QAAQ,cAAc,IAAI,EAAE;AAClC,KAAI,OAAO,UAAU,SAAU,oBAAmB,IAAI,KAAK,MAAM;;;;;;;;AASnE,SAAgB,eAAe,KAAmC;CAChE,MAAM,QAAQ,mBAAmB,IAAI,IAAI;CACzC,MAAM,QAAQ,cAAc,IAAI,EAAE;AAClC,KAAI,UAAU,UAAa,OAAO,UAAU,SAAU,QAAO,IAAI;AACjE,QAAO,QAAQ;;;AAIjB,SAAgB,eAAe,KAAkC;AAC/D,QAAO,cAAc,IAAI,KAAK,WAAW,iBAAiB;;;;;;;;;;;;AAa5D,SAAgB,cACd,KACA,SACA,MACmB;CACnB,MAAM,eAAe,KAAK,aAAa,UAAUC,8CAAyB,QAAQ,GAAG;CACrF,MAAM,OAAOD,iCAAmB,IAAI;AAEpC,QAAO,gBAAgB,cADH,SAAS,QAAQ,SAAS,kBAAkB,SAAY,cAAc,IAAI,GAC3C,WACjD,eAAe,WAAW;AACxB,MAAI,CAAC,IAAI,iBAAkB,QAAO,cAAc,IAAI,CAAC;GACrD,CACH;;;;;;AAOH,MAAM,iCAAiB,IAAI,SAAuC;;;;;;AAOlE,SAAgB,aAAa,IAA+B;AAC1D,KAAI,GAAG,YAAY,eAAe,IAAI,GAAG,CAAE;CAC3C,MAAM,SAAsB;AAC5B,KAAI,OAAO,OAAO,SAAS,WAAY;AACvC,gBAAe,IAAI,IAAI,MAAM;AAC7B,QAAO,KAAK,eAAe,eAAe,IAAI,IAAI,KAAK,CAAC;;;;;;;;;;;;;AAc1D,SAAgB,cAAc,IAA0D;AACtF,KAAI,CAAC,GAAG,SAAU,QAAO;AACzB,QAAO,eAAe,IAAI,GAAG,KAAK,QAAQ,WAAW;;;;;;;;AASvD,SAAgB,YAAY,IAAyB,SAA4C;AAE/F,QAAO,gBADc,UAAUC,8CAAyB,QAAQ,GAAG,MAC9B,cAAc,GAAG,GAAG,WACvD,eAAe,UAAU,OAAO,SAAS,CAAC,CAC3C;;;;;;;;;;AAWH,SAAgB,kBACd,OACA,IACA,WACM;CACN,MAAM,QAAQ,cAAc,GAAG;CAC/B,MAAM,eACJ,UAAU,WAAW,sBAAsB,UAAU,WAAW,iBAAiB;AACnF,iBAAgB,OAAO,WAAW,QAAQ,IAAI,aAAa;;;;;;;AAQ7D,SAAgB,gBAAgB,OAAqB,QAAkC;AACrF,OAAM,SAAS,cAAc;AAC7B,KAAI,MAAM,SAAS,oBAAoB,UAAa,WAAW,OAC7D,OAAM,SAAS,kBAAkB"}