ai 6.0.33 → 6.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (351) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/index.js +1 -1
  3. package/dist/index.mjs +1 -1
  4. package/dist/internal/index.js +1 -1
  5. package/dist/internal/index.mjs +1 -1
  6. package/docs/02-foundations/03-prompts.mdx +2 -2
  7. package/docs/03-ai-sdk-core/15-tools-and-tool-calling.mdx +1 -1
  8. package/docs/07-reference/01-ai-sdk-core/28-output.mdx +1 -1
  9. package/package.json +6 -4
  10. package/src/agent/agent.ts +116 -0
  11. package/src/agent/create-agent-ui-stream-response.test.ts +258 -0
  12. package/src/agent/create-agent-ui-stream-response.ts +50 -0
  13. package/src/agent/create-agent-ui-stream.ts +73 -0
  14. package/src/agent/index.ts +33 -0
  15. package/src/agent/infer-agent-tools.ts +7 -0
  16. package/src/agent/infer-agent-ui-message.test-d.ts +54 -0
  17. package/src/agent/infer-agent-ui-message.ts +11 -0
  18. package/src/agent/pipe-agent-ui-stream-to-response.ts +52 -0
  19. package/src/agent/tool-loop-agent-on-finish-callback.ts +31 -0
  20. package/src/agent/tool-loop-agent-on-step-finish-callback.ts +11 -0
  21. package/src/agent/tool-loop-agent-settings.ts +182 -0
  22. package/src/agent/tool-loop-agent.test-d.ts +114 -0
  23. package/src/agent/tool-loop-agent.test.ts +442 -0
  24. package/src/agent/tool-loop-agent.ts +114 -0
  25. package/src/embed/__snapshots__/embed-many.test.ts.snap +191 -0
  26. package/src/embed/__snapshots__/embed.test.ts.snap +81 -0
  27. package/src/embed/embed-many-result.ts +53 -0
  28. package/src/embed/embed-many.test.ts +653 -0
  29. package/src/embed/embed-many.ts +378 -0
  30. package/src/embed/embed-result.ts +50 -0
  31. package/src/embed/embed.test.ts +298 -0
  32. package/src/embed/embed.ts +211 -0
  33. package/src/embed/index.ts +4 -0
  34. package/src/error/index.ts +34 -0
  35. package/src/error/invalid-argument-error.ts +34 -0
  36. package/src/error/invalid-stream-part-error.ts +28 -0
  37. package/src/error/invalid-tool-approval-error.ts +26 -0
  38. package/src/error/invalid-tool-input-error.ts +33 -0
  39. package/src/error/no-image-generated-error.ts +39 -0
  40. package/src/error/no-object-generated-error.ts +70 -0
  41. package/src/error/no-output-generated-error.ts +26 -0
  42. package/src/error/no-speech-generated-error.ts +18 -0
  43. package/src/error/no-such-tool-error.ts +35 -0
  44. package/src/error/no-transcript-generated-error.ts +20 -0
  45. package/src/error/tool-call-not-found-for-approval-error.ts +32 -0
  46. package/src/error/tool-call-repair-error.ts +30 -0
  47. package/src/error/unsupported-model-version-error.ts +23 -0
  48. package/src/error/verify-no-object-generated-error.ts +27 -0
  49. package/src/generate-image/generate-image-result.ts +42 -0
  50. package/src/generate-image/generate-image.test.ts +1420 -0
  51. package/src/generate-image/generate-image.ts +360 -0
  52. package/src/generate-image/index.ts +18 -0
  53. package/src/generate-object/__snapshots__/generate-object.test.ts.snap +133 -0
  54. package/src/generate-object/__snapshots__/stream-object.test.ts.snap +297 -0
  55. package/src/generate-object/generate-object-result.ts +67 -0
  56. package/src/generate-object/generate-object.test-d.ts +49 -0
  57. package/src/generate-object/generate-object.test.ts +1191 -0
  58. package/src/generate-object/generate-object.ts +518 -0
  59. package/src/generate-object/index.ts +9 -0
  60. package/src/generate-object/inject-json-instruction.test.ts +181 -0
  61. package/src/generate-object/inject-json-instruction.ts +30 -0
  62. package/src/generate-object/output-strategy.ts +415 -0
  63. package/src/generate-object/parse-and-validate-object-result.ts +111 -0
  64. package/src/generate-object/repair-text.ts +12 -0
  65. package/src/generate-object/stream-object-result.ts +120 -0
  66. package/src/generate-object/stream-object.test-d.ts +74 -0
  67. package/src/generate-object/stream-object.test.ts +1950 -0
  68. package/src/generate-object/stream-object.ts +986 -0
  69. package/src/generate-object/validate-object-generation-input.ts +144 -0
  70. package/src/generate-speech/generate-speech-result.ts +30 -0
  71. package/src/generate-speech/generate-speech.test.ts +300 -0
  72. package/src/generate-speech/generate-speech.ts +190 -0
  73. package/src/generate-speech/generated-audio-file.ts +65 -0
  74. package/src/generate-speech/index.ts +3 -0
  75. package/src/generate-text/__snapshots__/generate-text.test.ts.snap +1872 -0
  76. package/src/generate-text/__snapshots__/stream-text.test.ts.snap +1255 -0
  77. package/src/generate-text/collect-tool-approvals.test.ts +553 -0
  78. package/src/generate-text/collect-tool-approvals.ts +116 -0
  79. package/src/generate-text/content-part.ts +25 -0
  80. package/src/generate-text/execute-tool-call.ts +129 -0
  81. package/src/generate-text/extract-reasoning-content.ts +17 -0
  82. package/src/generate-text/extract-text-content.ts +15 -0
  83. package/src/generate-text/generate-text-result.ts +168 -0
  84. package/src/generate-text/generate-text.test-d.ts +68 -0
  85. package/src/generate-text/generate-text.test.ts +7011 -0
  86. package/src/generate-text/generate-text.ts +1223 -0
  87. package/src/generate-text/generated-file.ts +70 -0
  88. package/src/generate-text/index.ts +57 -0
  89. package/src/generate-text/is-approval-needed.ts +29 -0
  90. package/src/generate-text/output-utils.ts +23 -0
  91. package/src/generate-text/output.test.ts +698 -0
  92. package/src/generate-text/output.ts +590 -0
  93. package/src/generate-text/parse-tool-call.test.ts +570 -0
  94. package/src/generate-text/parse-tool-call.ts +188 -0
  95. package/src/generate-text/prepare-step.ts +103 -0
  96. package/src/generate-text/prune-messages.test.ts +720 -0
  97. package/src/generate-text/prune-messages.ts +167 -0
  98. package/src/generate-text/reasoning-output.ts +20 -0
  99. package/src/generate-text/reasoning.ts +8 -0
  100. package/src/generate-text/response-message.ts +10 -0
  101. package/src/generate-text/run-tools-transformation.test.ts +1143 -0
  102. package/src/generate-text/run-tools-transformation.ts +420 -0
  103. package/src/generate-text/smooth-stream.test.ts +2101 -0
  104. package/src/generate-text/smooth-stream.ts +162 -0
  105. package/src/generate-text/step-result.ts +238 -0
  106. package/src/generate-text/stop-condition.ts +29 -0
  107. package/src/generate-text/stream-text-result.ts +463 -0
  108. package/src/generate-text/stream-text.test-d.ts +200 -0
  109. package/src/generate-text/stream-text.test.ts +19979 -0
  110. package/src/generate-text/stream-text.ts +2505 -0
  111. package/src/generate-text/to-response-messages.test.ts +922 -0
  112. package/src/generate-text/to-response-messages.ts +163 -0
  113. package/src/generate-text/tool-approval-request-output.ts +21 -0
  114. package/src/generate-text/tool-call-repair-function.ts +27 -0
  115. package/src/generate-text/tool-call.ts +47 -0
  116. package/src/generate-text/tool-error.ts +34 -0
  117. package/src/generate-text/tool-output-denied.ts +21 -0
  118. package/src/generate-text/tool-output.ts +7 -0
  119. package/src/generate-text/tool-result.ts +36 -0
  120. package/src/generate-text/tool-set.ts +14 -0
  121. package/src/global.ts +24 -0
  122. package/src/index.ts +50 -0
  123. package/src/logger/index.ts +6 -0
  124. package/src/logger/log-warnings.test.ts +351 -0
  125. package/src/logger/log-warnings.ts +119 -0
  126. package/src/middleware/__snapshots__/simulate-streaming-middleware.test.ts.snap +64 -0
  127. package/src/middleware/add-tool-input-examples-middleware.test.ts +476 -0
  128. package/src/middleware/add-tool-input-examples-middleware.ts +90 -0
  129. package/src/middleware/default-embedding-settings-middleware.test.ts +126 -0
  130. package/src/middleware/default-embedding-settings-middleware.ts +22 -0
  131. package/src/middleware/default-settings-middleware.test.ts +388 -0
  132. package/src/middleware/default-settings-middleware.ts +33 -0
  133. package/src/middleware/extract-json-middleware.test.ts +827 -0
  134. package/src/middleware/extract-json-middleware.ts +197 -0
  135. package/src/middleware/extract-reasoning-middleware.test.ts +1028 -0
  136. package/src/middleware/extract-reasoning-middleware.ts +238 -0
  137. package/src/middleware/index.ts +10 -0
  138. package/src/middleware/simulate-streaming-middleware.test.ts +911 -0
  139. package/src/middleware/simulate-streaming-middleware.ts +79 -0
  140. package/src/middleware/wrap-embedding-model.test.ts +358 -0
  141. package/src/middleware/wrap-embedding-model.ts +86 -0
  142. package/src/middleware/wrap-image-model.test.ts +423 -0
  143. package/src/middleware/wrap-image-model.ts +85 -0
  144. package/src/middleware/wrap-language-model.test.ts +518 -0
  145. package/src/middleware/wrap-language-model.ts +104 -0
  146. package/src/middleware/wrap-provider.test.ts +120 -0
  147. package/src/middleware/wrap-provider.ts +51 -0
  148. package/src/model/as-embedding-model-v3.test.ts +319 -0
  149. package/src/model/as-embedding-model-v3.ts +24 -0
  150. package/src/model/as-image-model-v3.test.ts +409 -0
  151. package/src/model/as-image-model-v3.ts +24 -0
  152. package/src/model/as-language-model-v3.test.ts +508 -0
  153. package/src/model/as-language-model-v3.ts +103 -0
  154. package/src/model/as-provider-v3.ts +36 -0
  155. package/src/model/as-speech-model-v3.test.ts +356 -0
  156. package/src/model/as-speech-model-v3.ts +24 -0
  157. package/src/model/as-transcription-model-v3.test.ts +529 -0
  158. package/src/model/as-transcription-model-v3.ts +24 -0
  159. package/src/model/resolve-model.test.ts +244 -0
  160. package/src/model/resolve-model.ts +126 -0
  161. package/src/prompt/call-settings.ts +148 -0
  162. package/src/prompt/content-part.ts +209 -0
  163. package/src/prompt/convert-to-language-model-prompt.test.ts +2018 -0
  164. package/src/prompt/convert-to-language-model-prompt.ts +442 -0
  165. package/src/prompt/create-tool-model-output.test.ts +508 -0
  166. package/src/prompt/create-tool-model-output.ts +34 -0
  167. package/src/prompt/data-content.test.ts +15 -0
  168. package/src/prompt/data-content.ts +134 -0
  169. package/src/prompt/index.ts +27 -0
  170. package/src/prompt/invalid-data-content-error.ts +29 -0
  171. package/src/prompt/invalid-message-role-error.ts +27 -0
  172. package/src/prompt/message-conversion-error.ts +28 -0
  173. package/src/prompt/message.ts +68 -0
  174. package/src/prompt/prepare-call-settings.test.ts +159 -0
  175. package/src/prompt/prepare-call-settings.ts +108 -0
  176. package/src/prompt/prepare-tools-and-tool-choice.test.ts +461 -0
  177. package/src/prompt/prepare-tools-and-tool-choice.ts +86 -0
  178. package/src/prompt/prompt.ts +43 -0
  179. package/src/prompt/split-data-url.ts +17 -0
  180. package/src/prompt/standardize-prompt.test.ts +82 -0
  181. package/src/prompt/standardize-prompt.ts +99 -0
  182. package/src/prompt/wrap-gateway-error.ts +29 -0
  183. package/src/registry/custom-provider.test.ts +211 -0
  184. package/src/registry/custom-provider.ts +155 -0
  185. package/src/registry/index.ts +7 -0
  186. package/src/registry/no-such-provider-error.ts +41 -0
  187. package/src/registry/provider-registry.test.ts +691 -0
  188. package/src/registry/provider-registry.ts +328 -0
  189. package/src/rerank/index.ts +2 -0
  190. package/src/rerank/rerank-result.ts +70 -0
  191. package/src/rerank/rerank.test.ts +516 -0
  192. package/src/rerank/rerank.ts +237 -0
  193. package/src/telemetry/assemble-operation-name.ts +21 -0
  194. package/src/telemetry/get-base-telemetry-attributes.ts +53 -0
  195. package/src/telemetry/get-tracer.ts +20 -0
  196. package/src/telemetry/noop-tracer.ts +69 -0
  197. package/src/telemetry/record-span.ts +63 -0
  198. package/src/telemetry/select-telemetry-attributes.ts +78 -0
  199. package/src/telemetry/select-temetry-attributes.test.ts +114 -0
  200. package/src/telemetry/stringify-for-telemetry.test.ts +114 -0
  201. package/src/telemetry/stringify-for-telemetry.ts +33 -0
  202. package/src/telemetry/telemetry-settings.ts +44 -0
  203. package/src/test/mock-embedding-model-v2.ts +35 -0
  204. package/src/test/mock-embedding-model-v3.ts +48 -0
  205. package/src/test/mock-image-model-v2.ts +28 -0
  206. package/src/test/mock-image-model-v3.ts +28 -0
  207. package/src/test/mock-language-model-v2.ts +72 -0
  208. package/src/test/mock-language-model-v3.ts +77 -0
  209. package/src/test/mock-provider-v2.ts +68 -0
  210. package/src/test/mock-provider-v3.ts +80 -0
  211. package/src/test/mock-reranking-model-v3.ts +25 -0
  212. package/src/test/mock-server-response.ts +69 -0
  213. package/src/test/mock-speech-model-v2.ts +24 -0
  214. package/src/test/mock-speech-model-v3.ts +24 -0
  215. package/src/test/mock-tracer.ts +156 -0
  216. package/src/test/mock-transcription-model-v2.ts +24 -0
  217. package/src/test/mock-transcription-model-v3.ts +24 -0
  218. package/src/test/mock-values.ts +4 -0
  219. package/src/test/not-implemented.ts +3 -0
  220. package/src/text-stream/create-text-stream-response.test.ts +38 -0
  221. package/src/text-stream/create-text-stream-response.ts +18 -0
  222. package/src/text-stream/index.ts +2 -0
  223. package/src/text-stream/pipe-text-stream-to-response.test.ts +38 -0
  224. package/src/text-stream/pipe-text-stream-to-response.ts +26 -0
  225. package/src/transcribe/index.ts +2 -0
  226. package/src/transcribe/transcribe-result.ts +60 -0
  227. package/src/transcribe/transcribe.test.ts +313 -0
  228. package/src/transcribe/transcribe.ts +173 -0
  229. package/src/types/embedding-model-middleware.ts +3 -0
  230. package/src/types/embedding-model.ts +18 -0
  231. package/src/types/image-model-middleware.ts +3 -0
  232. package/src/types/image-model-response-metadata.ts +16 -0
  233. package/src/types/image-model.ts +19 -0
  234. package/src/types/index.ts +29 -0
  235. package/src/types/json-value.ts +15 -0
  236. package/src/types/language-model-middleware.ts +3 -0
  237. package/src/types/language-model-request-metadata.ts +6 -0
  238. package/src/types/language-model-response-metadata.ts +21 -0
  239. package/src/types/language-model.ts +104 -0
  240. package/src/types/provider-metadata.ts +16 -0
  241. package/src/types/provider.ts +55 -0
  242. package/src/types/reranking-model.ts +6 -0
  243. package/src/types/speech-model-response-metadata.ts +21 -0
  244. package/src/types/speech-model.ts +6 -0
  245. package/src/types/transcription-model-response-metadata.ts +16 -0
  246. package/src/types/transcription-model.ts +9 -0
  247. package/src/types/usage.ts +200 -0
  248. package/src/types/warning.ts +7 -0
  249. package/src/ui/__snapshots__/append-response-messages.test.ts.snap +416 -0
  250. package/src/ui/__snapshots__/convert-to-model-messages.test.ts.snap +419 -0
  251. package/src/ui/__snapshots__/process-chat-text-response.test.ts.snap +142 -0
  252. package/src/ui/call-completion-api.ts +157 -0
  253. package/src/ui/chat-transport.ts +83 -0
  254. package/src/ui/chat.test-d.ts +233 -0
  255. package/src/ui/chat.test.ts +2695 -0
  256. package/src/ui/chat.ts +716 -0
  257. package/src/ui/convert-file-list-to-file-ui-parts.ts +36 -0
  258. package/src/ui/convert-to-model-messages.test.ts +2775 -0
  259. package/src/ui/convert-to-model-messages.ts +373 -0
  260. package/src/ui/default-chat-transport.ts +36 -0
  261. package/src/ui/direct-chat-transport.test.ts +446 -0
  262. package/src/ui/direct-chat-transport.ts +118 -0
  263. package/src/ui/http-chat-transport.test.ts +185 -0
  264. package/src/ui/http-chat-transport.ts +292 -0
  265. package/src/ui/index.ts +71 -0
  266. package/src/ui/last-assistant-message-is-complete-with-approval-responses.ts +44 -0
  267. package/src/ui/last-assistant-message-is-complete-with-tool-calls.test.ts +371 -0
  268. package/src/ui/last-assistant-message-is-complete-with-tool-calls.ts +39 -0
  269. package/src/ui/process-text-stream.test.ts +38 -0
  270. package/src/ui/process-text-stream.ts +16 -0
  271. package/src/ui/process-ui-message-stream.test.ts +8052 -0
  272. package/src/ui/process-ui-message-stream.ts +713 -0
  273. package/src/ui/text-stream-chat-transport.ts +23 -0
  274. package/src/ui/transform-text-to-ui-message-stream.test.ts +124 -0
  275. package/src/ui/transform-text-to-ui-message-stream.ts +27 -0
  276. package/src/ui/ui-messages.test.ts +48 -0
  277. package/src/ui/ui-messages.ts +534 -0
  278. package/src/ui/use-completion.ts +84 -0
  279. package/src/ui/validate-ui-messages.test.ts +1428 -0
  280. package/src/ui/validate-ui-messages.ts +476 -0
  281. package/src/ui-message-stream/create-ui-message-stream-response.test.ts +266 -0
  282. package/src/ui-message-stream/create-ui-message-stream-response.ts +32 -0
  283. package/src/ui-message-stream/create-ui-message-stream.test.ts +639 -0
  284. package/src/ui-message-stream/create-ui-message-stream.ts +124 -0
  285. package/src/ui-message-stream/get-response-ui-message-id.test.ts +55 -0
  286. package/src/ui-message-stream/get-response-ui-message-id.ts +24 -0
  287. package/src/ui-message-stream/handle-ui-message-stream-finish.test.ts +429 -0
  288. package/src/ui-message-stream/handle-ui-message-stream-finish.ts +135 -0
  289. package/src/ui-message-stream/index.ts +13 -0
  290. package/src/ui-message-stream/json-to-sse-transform-stream.ts +12 -0
  291. package/src/ui-message-stream/pipe-ui-message-stream-to-response.test.ts +90 -0
  292. package/src/ui-message-stream/pipe-ui-message-stream-to-response.ts +40 -0
  293. package/src/ui-message-stream/read-ui-message-stream.test.ts +122 -0
  294. package/src/ui-message-stream/read-ui-message-stream.ts +87 -0
  295. package/src/ui-message-stream/ui-message-chunks.test-d.ts +18 -0
  296. package/src/ui-message-stream/ui-message-chunks.ts +344 -0
  297. package/src/ui-message-stream/ui-message-stream-headers.ts +7 -0
  298. package/src/ui-message-stream/ui-message-stream-on-finish-callback.ts +32 -0
  299. package/src/ui-message-stream/ui-message-stream-response-init.ts +5 -0
  300. package/src/ui-message-stream/ui-message-stream-writer.ts +24 -0
  301. package/src/util/as-array.ts +3 -0
  302. package/src/util/async-iterable-stream.test.ts +241 -0
  303. package/src/util/async-iterable-stream.ts +94 -0
  304. package/src/util/consume-stream.ts +29 -0
  305. package/src/util/cosine-similarity.test.ts +57 -0
  306. package/src/util/cosine-similarity.ts +47 -0
  307. package/src/util/create-resolvable-promise.ts +30 -0
  308. package/src/util/create-stitchable-stream.test.ts +239 -0
  309. package/src/util/create-stitchable-stream.ts +112 -0
  310. package/src/util/data-url.ts +17 -0
  311. package/src/util/deep-partial.ts +84 -0
  312. package/src/util/detect-media-type.test.ts +670 -0
  313. package/src/util/detect-media-type.ts +184 -0
  314. package/src/util/download/download-function.ts +45 -0
  315. package/src/util/download/download.test.ts +69 -0
  316. package/src/util/download/download.ts +46 -0
  317. package/src/util/error-handler.ts +1 -0
  318. package/src/util/fix-json.test.ts +279 -0
  319. package/src/util/fix-json.ts +401 -0
  320. package/src/util/get-potential-start-index.test.ts +34 -0
  321. package/src/util/get-potential-start-index.ts +30 -0
  322. package/src/util/index.ts +11 -0
  323. package/src/util/is-deep-equal-data.test.ts +119 -0
  324. package/src/util/is-deep-equal-data.ts +48 -0
  325. package/src/util/is-non-empty-object.ts +5 -0
  326. package/src/util/job.ts +1 -0
  327. package/src/util/log-v2-compatibility-warning.ts +21 -0
  328. package/src/util/merge-abort-signals.test.ts +155 -0
  329. package/src/util/merge-abort-signals.ts +43 -0
  330. package/src/util/merge-objects.test.ts +118 -0
  331. package/src/util/merge-objects.ts +79 -0
  332. package/src/util/now.ts +4 -0
  333. package/src/util/parse-partial-json.test.ts +80 -0
  334. package/src/util/parse-partial-json.ts +30 -0
  335. package/src/util/prepare-headers.test.ts +51 -0
  336. package/src/util/prepare-headers.ts +14 -0
  337. package/src/util/prepare-retries.test.ts +10 -0
  338. package/src/util/prepare-retries.ts +47 -0
  339. package/src/util/retry-error.ts +41 -0
  340. package/src/util/retry-with-exponential-backoff.test.ts +446 -0
  341. package/src/util/retry-with-exponential-backoff.ts +154 -0
  342. package/src/util/serial-job-executor.test.ts +162 -0
  343. package/src/util/serial-job-executor.ts +36 -0
  344. package/src/util/simulate-readable-stream.test.ts +98 -0
  345. package/src/util/simulate-readable-stream.ts +39 -0
  346. package/src/util/split-array.test.ts +60 -0
  347. package/src/util/split-array.ts +20 -0
  348. package/src/util/value-of.ts +65 -0
  349. package/src/util/write-to-server-response.test.ts +266 -0
  350. package/src/util/write-to-server-response.ts +49 -0
  351. package/src/version.ts +5 -0
@@ -0,0 +1,266 @@
1
+ import { EventEmitter } from 'node:events';
2
+ import { ServerResponse } from 'node:http';
3
+ import { describe, it, expect } from 'vitest';
4
+ import { writeToServerResponse } from './write-to-server-response';
5
+ import { createMockServerResponse } from '../test/mock-server-response';
6
+
7
+ describe('writeToServerResponse', () => {
8
+ it('should write data to ServerResponse', async () => {
9
+ const mockResponse = createMockServerResponse();
10
+
11
+ const stream = new ReadableStream({
12
+ start(controller) {
13
+ controller.enqueue(new TextEncoder().encode('chunk1'));
14
+ controller.enqueue(new TextEncoder().encode('chunk2'));
15
+ controller.close();
16
+ },
17
+ });
18
+
19
+ writeToServerResponse({
20
+ response: mockResponse,
21
+ status: 200,
22
+ statusText: 'OK',
23
+ headers: { 'Content-Type': 'text/plain' },
24
+ stream,
25
+ });
26
+
27
+ await mockResponse.waitForEnd();
28
+
29
+ expect(mockResponse.statusCode).toBe(200);
30
+ expect(mockResponse.statusMessage).toBe('OK');
31
+ expect(mockResponse.writtenChunks).toHaveLength(2);
32
+ expect(mockResponse.ended).toBe(true);
33
+ });
34
+
35
+ it('should respect backpressure and wait for drain event', async () => {
36
+ const mockResponse = createBackpressureMockResponse();
37
+ let drainEventCount = 0;
38
+ let readyToEnqueue: ((value: unknown) => void) | null = null;
39
+
40
+ // Track drain events
41
+ mockResponse.on('drain', () => {
42
+ drainEventCount++;
43
+ });
44
+
45
+ // Create stream that provides chunks on-demand (async)
46
+ const stream = new ReadableStream({
47
+ start(controller) {
48
+ // First chunk available immediately
49
+ controller.enqueue(new TextEncoder().encode('chunk1'));
50
+ // Set up callback for additional chunks
51
+ readyToEnqueue = value => {
52
+ if (value === null) {
53
+ controller.close();
54
+ } else {
55
+ controller.enqueue(value as Uint8Array);
56
+ }
57
+ };
58
+ },
59
+ });
60
+
61
+ writeToServerResponse({
62
+ response: mockResponse,
63
+ status: 200,
64
+ stream,
65
+ });
66
+
67
+ // Wait for first chunk to be written
68
+ await new Promise(resolve => setTimeout(resolve, 10));
69
+ expect(mockResponse.writeCallCount).toBe(1);
70
+
71
+ // Enqueue second chunk - it should trigger write which returns false (backpressure)
72
+ readyToEnqueue!(new TextEncoder().encode('chunk2'));
73
+ await new Promise(resolve => setTimeout(resolve, 5));
74
+
75
+ // Second chunk write should have been called but returned false
76
+ expect(mockResponse.writeCallCount).toBe(2);
77
+ expect(mockResponse.writtenChunks.length).toBe(2);
78
+
79
+ // Enqueue third chunk - it should NOT trigger write yet (still waiting for drain from chunk 2)
80
+ readyToEnqueue!(new TextEncoder().encode('chunk3'));
81
+ await new Promise(resolve => setTimeout(resolve, 5));
82
+
83
+ // Third chunk shouldn't be written yet (waiting for drain)
84
+ expect(mockResponse.writeCallCount).toBe(2);
85
+
86
+ // Simulate drain to allow third write
87
+ mockResponse.simulateDrain();
88
+ await new Promise(resolve => setTimeout(resolve, 10));
89
+ expect(mockResponse.writeCallCount).toBe(3);
90
+
91
+ // Close the stream
92
+ readyToEnqueue!(null);
93
+ await mockResponse.waitForEnd();
94
+
95
+ // Verify that drain was called (indicating backpressure was respected)
96
+ expect(drainEventCount).toBeGreaterThanOrEqual(1);
97
+ // Verify all chunks were eventually written
98
+ expect(mockResponse.writtenChunks).toHaveLength(3);
99
+ });
100
+
101
+ it('should set headers correctly when statusText is undefined', async () => {
102
+ const mockResponse = createMockServerResponse();
103
+
104
+ const stream = new ReadableStream({
105
+ start(controller) {
106
+ controller.enqueue(new TextEncoder().encode('test data'));
107
+ controller.close();
108
+ },
109
+ });
110
+
111
+ const expectedHeaders = {
112
+ 'X-Example-Header': 'example-value',
113
+ 'X-Example-Chat-Title': 'My Conversation',
114
+ };
115
+
116
+ writeToServerResponse({
117
+ response: mockResponse,
118
+ status: 200,
119
+ statusText: undefined,
120
+ headers: expectedHeaders,
121
+ stream,
122
+ });
123
+
124
+ await mockResponse.waitForEnd();
125
+
126
+ expect(mockResponse.statusCode).toBe(200);
127
+ expect(mockResponse.headers).toEqual(expectedHeaders);
128
+ expect(mockResponse.ended).toBe(true);
129
+ expect(mockResponse.writtenChunks).toHaveLength(1);
130
+ });
131
+
132
+ it('should set headers correctly when statusText is provided', async () => {
133
+ const mockResponse = createMockServerResponse();
134
+
135
+ const stream = new ReadableStream({
136
+ start(controller) {
137
+ controller.enqueue(new TextEncoder().encode('test data'));
138
+ controller.close();
139
+ },
140
+ });
141
+
142
+ const expectedHeaders = {
143
+ 'X-Example-Header': 'example-value',
144
+ 'X-Example-Chat-Title': 'New Chat Session',
145
+ };
146
+
147
+ writeToServerResponse({
148
+ response: mockResponse,
149
+ status: 201,
150
+ statusText: 'Created',
151
+ headers: expectedHeaders,
152
+ stream,
153
+ });
154
+
155
+ await mockResponse.waitForEnd();
156
+
157
+ expect(mockResponse.statusCode).toBe(201);
158
+ expect(mockResponse.statusMessage).toBe('Created');
159
+ expect(mockResponse.headers).toEqual(expectedHeaders);
160
+ expect(mockResponse.ended).toBe(true);
161
+ expect(mockResponse.writtenChunks).toHaveLength(1);
162
+ });
163
+
164
+ it('should set headers correctly when statusText is not set and status is not set', async () => {
165
+ const mockResponse = createMockServerResponse();
166
+
167
+ const stream = new ReadableStream({
168
+ start(controller) {
169
+ controller.enqueue(new TextEncoder().encode('test data'));
170
+ controller.close();
171
+ },
172
+ });
173
+
174
+ const expectedHeaders = {
175
+ 'X-Example-Header': 'example-value',
176
+ 'X-Example-Message': 'Hello World',
177
+ };
178
+
179
+ writeToServerResponse({
180
+ response: mockResponse,
181
+ headers: expectedHeaders,
182
+ stream,
183
+ });
184
+
185
+ await mockResponse.waitForEnd();
186
+
187
+ expect(mockResponse.statusCode).toBe(200);
188
+ expect(mockResponse.headers).toEqual(expectedHeaders);
189
+ expect(mockResponse.ended).toBe(true);
190
+ expect(mockResponse.writtenChunks).toHaveLength(1);
191
+ });
192
+ });
193
+
194
+ class BackpressureMockResponse extends EventEmitter {
195
+ writtenChunks: any[] = [];
196
+ writeCallCount = 0;
197
+ statusCode = 0;
198
+ statusMessage = '';
199
+ headers: Record<string, string | number | string[]> | undefined;
200
+ ended = false;
201
+ private shouldApplyBackpressure = false;
202
+
203
+ write(chunk: any): boolean {
204
+ this.writtenChunks.push(chunk);
205
+ this.writeCallCount++;
206
+
207
+ // First write succeeds, subsequent writes signal backpressure
208
+ if (this.writeCallCount === 1) {
209
+ this.shouldApplyBackpressure = true;
210
+ return true; // First write is okay
211
+ }
212
+
213
+ // If we're in backpressure mode, return false
214
+ if (this.shouldApplyBackpressure) {
215
+ return false;
216
+ }
217
+
218
+ // After drain, this write succeeds, but next will need drain again
219
+ this.shouldApplyBackpressure = true;
220
+ return true;
221
+ }
222
+
223
+ simulateDrain(): void {
224
+ this.shouldApplyBackpressure = false;
225
+ this.emit('drain');
226
+ }
227
+
228
+ end(): void {
229
+ this.ended = true;
230
+ }
231
+
232
+ writeHead(
233
+ statusCode: number,
234
+ statusMessage?: string,
235
+ headers?: Record<string, string | number | string[]>,
236
+ ): void {
237
+ this.statusCode = statusCode;
238
+
239
+ if (typeof statusMessage === 'string') {
240
+ this.statusMessage = statusMessage;
241
+ this.headers = headers;
242
+ } else {
243
+ this.statusMessage = '';
244
+ this.headers = statusMessage;
245
+ }
246
+ }
247
+
248
+ async waitForEnd() {
249
+ await new Promise(resolve => {
250
+ const checkIfEnded = () => {
251
+ if (this.ended) {
252
+ resolve(undefined);
253
+ } else {
254
+ setImmediate(checkIfEnded);
255
+ }
256
+ };
257
+ checkIfEnded();
258
+ });
259
+ }
260
+ }
261
+
262
+ function createBackpressureMockResponse(): ServerResponse &
263
+ BackpressureMockResponse {
264
+ return new BackpressureMockResponse() as ServerResponse &
265
+ BackpressureMockResponse;
266
+ }
@@ -0,0 +1,49 @@
1
+ import { ServerResponse } from 'node:http';
2
+
3
+ /**
4
+ * Writes the content of a stream to a server response.
5
+ */
6
+ export function writeToServerResponse({
7
+ response,
8
+ status,
9
+ statusText,
10
+ headers,
11
+ stream,
12
+ }: {
13
+ response: ServerResponse;
14
+ status?: number;
15
+ statusText?: string;
16
+ headers?: Record<string, string | number | string[]>;
17
+ stream: ReadableStream<Uint8Array>;
18
+ }): void {
19
+ const statusCode = status ?? 200;
20
+ if (statusText !== undefined) {
21
+ response.writeHead(statusCode, statusText, headers);
22
+ } else {
23
+ response.writeHead(statusCode, headers);
24
+ }
25
+
26
+ const reader = stream.getReader();
27
+ const read = async () => {
28
+ try {
29
+ while (true) {
30
+ const { done, value } = await reader.read();
31
+ if (done) break;
32
+
33
+ // Respect backpressure: if write() returns false, wait for 'drain' event
34
+ const canContinue = response.write(value);
35
+ if (!canContinue) {
36
+ await new Promise<void>(resolve => {
37
+ response.once('drain', resolve);
38
+ });
39
+ }
40
+ }
41
+ } catch (error) {
42
+ throw error;
43
+ } finally {
44
+ response.end();
45
+ }
46
+ };
47
+
48
+ read();
49
+ }
package/src/version.ts ADDED
@@ -0,0 +1,5 @@
1
+ declare const __PACKAGE_VERSION__: string | undefined;
2
+ export const VERSION: string =
3
+ typeof __PACKAGE_VERSION__ !== 'undefined'
4
+ ? __PACKAGE_VERSION__
5
+ : '0.0.0-test';