pi-cursor-sdk 0.1.50 → 0.1.52

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 (279) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/README.md +1 -1
  3. package/docs/cursor-live-smoke-checklist.md +4 -4
  4. package/docs/cursor-model-ux-spec.md +5 -5
  5. package/docs/cursor-native-tool-replay.md +2 -2
  6. package/docs/cursor-native-tool-visual-audit.md +1 -1
  7. package/docs/cursor-testing-lessons.md +1 -1
  8. package/package.json +3 -12
  9. package/src/cursor-fallback-models.generated.ts +536 -302
  10. package/src/cursor-provider-errors.ts +29 -0
  11. package/src/cursor-provider-turn-runner.ts +1 -1
  12. package/src/cursor-provider.ts +9 -2
  13. package/src/cursor-session-turn-queue.ts +52 -0
  14. package/src/cursor-tool-manifest.ts +1 -1
  15. package/node_modules/@connectrpc/connect-node/README.md +0 -141
  16. package/node_modules/@connectrpc/connect-node/dist/cjs/compression.d.ts +0 -15
  17. package/node_modules/@connectrpc/connect-node/dist/cjs/compression.js +0 -89
  18. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.d.ts +0 -42
  19. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.js +0 -61
  20. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.d.ts +0 -100
  21. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.js +0 -25
  22. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.d.ts +0 -96
  23. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.js +0 -25
  24. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.d.ts +0 -96
  25. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.js +0 -25
  26. package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.d.ts +0 -146
  27. package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.js +0 -536
  28. package/node_modules/@connectrpc/connect-node/dist/cjs/index.d.ts +0 -15
  29. package/node_modules/@connectrpc/connect-node/dist/cjs/index.js +0 -36
  30. package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.d.ts +0 -45
  31. package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.js +0 -154
  32. package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.d.ts +0 -1
  33. package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.js +0 -29
  34. package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.d.ts +0 -89
  35. package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.js +0 -58
  36. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.d.ts +0 -54
  37. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.js +0 -326
  38. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.d.ts +0 -41
  39. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.js +0 -234
  40. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.d.ts +0 -19
  41. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.js +0 -97
  42. package/node_modules/@connectrpc/connect-node/dist/cjs/package.json +0 -1
  43. package/node_modules/@connectrpc/connect-node/dist/esm/compression.d.ts +0 -15
  44. package/node_modules/@connectrpc/connect-node/dist/esm/compression.js +0 -86
  45. package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.d.ts +0 -42
  46. package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.js +0 -58
  47. package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.d.ts +0 -100
  48. package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.js +0 -22
  49. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.d.ts +0 -96
  50. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.js +0 -22
  51. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.d.ts +0 -96
  52. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.js +0 -22
  53. package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.d.ts +0 -146
  54. package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.js +0 -532
  55. package/node_modules/@connectrpc/connect-node/dist/esm/index.d.ts +0 -15
  56. package/node_modules/@connectrpc/connect-node/dist/esm/index.js +0 -23
  57. package/node_modules/@connectrpc/connect-node/dist/esm/node-error.d.ts +0 -45
  58. package/node_modules/@connectrpc/connect-node/dist/esm/node-error.js +0 -147
  59. package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.d.ts +0 -1
  60. package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.js +0 -27
  61. package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.d.ts +0 -89
  62. package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.js +0 -58
  63. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.d.ts +0 -54
  64. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.js +0 -324
  65. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.d.ts +0 -41
  66. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.js +0 -230
  67. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.d.ts +0 -19
  68. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.js +0 -93
  69. package/node_modules/@connectrpc/connect-node/package.json +0 -46
  70. package/node_modules/undici/LICENSE +0 -21
  71. package/node_modules/undici/README.md +0 -741
  72. package/node_modules/undici/docs/docs/api/Agent.md +0 -84
  73. package/node_modules/undici/docs/docs/api/BalancedPool.md +0 -99
  74. package/node_modules/undici/docs/docs/api/CacheStorage.md +0 -30
  75. package/node_modules/undici/docs/docs/api/CacheStore.md +0 -164
  76. package/node_modules/undici/docs/docs/api/Client.md +0 -288
  77. package/node_modules/undici/docs/docs/api/ClientStats.md +0 -27
  78. package/node_modules/undici/docs/docs/api/Connector.md +0 -115
  79. package/node_modules/undici/docs/docs/api/ContentType.md +0 -57
  80. package/node_modules/undici/docs/docs/api/Cookies.md +0 -128
  81. package/node_modules/undici/docs/docs/api/Debug.md +0 -62
  82. package/node_modules/undici/docs/docs/api/DiagnosticsChannel.md +0 -315
  83. package/node_modules/undici/docs/docs/api/Dispatcher.md +0 -1392
  84. package/node_modules/undici/docs/docs/api/EnvHttpProxyAgent.md +0 -159
  85. package/node_modules/undici/docs/docs/api/Errors.md +0 -49
  86. package/node_modules/undici/docs/docs/api/EventSource.md +0 -45
  87. package/node_modules/undici/docs/docs/api/Fetch.md +0 -60
  88. package/node_modules/undici/docs/docs/api/GlobalInstallation.md +0 -139
  89. package/node_modules/undici/docs/docs/api/H2CClient.md +0 -263
  90. package/node_modules/undici/docs/docs/api/MockAgent.md +0 -603
  91. package/node_modules/undici/docs/docs/api/MockCallHistory.md +0 -197
  92. package/node_modules/undici/docs/docs/api/MockCallHistoryLog.md +0 -43
  93. package/node_modules/undici/docs/docs/api/MockClient.md +0 -81
  94. package/node_modules/undici/docs/docs/api/MockErrors.md +0 -12
  95. package/node_modules/undici/docs/docs/api/MockPool.md +0 -555
  96. package/node_modules/undici/docs/docs/api/Pool.md +0 -84
  97. package/node_modules/undici/docs/docs/api/PoolStats.md +0 -35
  98. package/node_modules/undici/docs/docs/api/ProxyAgent.md +0 -229
  99. package/node_modules/undici/docs/docs/api/RedirectHandler.md +0 -93
  100. package/node_modules/undici/docs/docs/api/RetryAgent.md +0 -50
  101. package/node_modules/undici/docs/docs/api/RetryHandler.md +0 -118
  102. package/node_modules/undici/docs/docs/api/RoundRobinPool.md +0 -145
  103. package/node_modules/undici/docs/docs/api/SnapshotAgent.md +0 -616
  104. package/node_modules/undici/docs/docs/api/Socks5ProxyAgent.md +0 -275
  105. package/node_modules/undici/docs/docs/api/Util.md +0 -25
  106. package/node_modules/undici/docs/docs/api/WebSocket.md +0 -141
  107. package/node_modules/undici/docs/docs/api/api-lifecycle.md +0 -91
  108. package/node_modules/undici/docs/docs/best-practices/client-certificate.md +0 -64
  109. package/node_modules/undici/docs/docs/best-practices/crawling.md +0 -58
  110. package/node_modules/undici/docs/docs/best-practices/mocking-request.md +0 -190
  111. package/node_modules/undici/docs/docs/best-practices/proxy.md +0 -127
  112. package/node_modules/undici/docs/docs/best-practices/undici-vs-builtin-fetch.md +0 -224
  113. package/node_modules/undici/docs/docs/best-practices/writing-tests.md +0 -63
  114. package/node_modules/undici/index-fetch.js +0 -65
  115. package/node_modules/undici/index.d.ts +0 -3
  116. package/node_modules/undici/index.js +0 -234
  117. package/node_modules/undici/lib/api/abort-signal.js +0 -59
  118. package/node_modules/undici/lib/api/api-connect.js +0 -110
  119. package/node_modules/undici/lib/api/api-pipeline.js +0 -252
  120. package/node_modules/undici/lib/api/api-request.js +0 -214
  121. package/node_modules/undici/lib/api/api-stream.js +0 -209
  122. package/node_modules/undici/lib/api/api-upgrade.js +0 -111
  123. package/node_modules/undici/lib/api/index.js +0 -7
  124. package/node_modules/undici/lib/api/readable.js +0 -580
  125. package/node_modules/undici/lib/cache/memory-cache-store.js +0 -234
  126. package/node_modules/undici/lib/cache/sqlite-cache-store.js +0 -461
  127. package/node_modules/undici/lib/core/connect.js +0 -153
  128. package/node_modules/undici/lib/core/constants.js +0 -143
  129. package/node_modules/undici/lib/core/diagnostics.js +0 -227
  130. package/node_modules/undici/lib/core/errors.js +0 -477
  131. package/node_modules/undici/lib/core/request.js +0 -453
  132. package/node_modules/undici/lib/core/socks5-client.js +0 -422
  133. package/node_modules/undici/lib/core/socks5-utils.js +0 -212
  134. package/node_modules/undici/lib/core/symbols.js +0 -75
  135. package/node_modules/undici/lib/core/tree.js +0 -160
  136. package/node_modules/undici/lib/core/util.js +0 -992
  137. package/node_modules/undici/lib/dispatcher/agent.js +0 -158
  138. package/node_modules/undici/lib/dispatcher/balanced-pool.js +0 -219
  139. package/node_modules/undici/lib/dispatcher/client-h1.js +0 -1722
  140. package/node_modules/undici/lib/dispatcher/client-h2.js +0 -995
  141. package/node_modules/undici/lib/dispatcher/client.js +0 -664
  142. package/node_modules/undici/lib/dispatcher/dispatcher-base.js +0 -184
  143. package/node_modules/undici/lib/dispatcher/dispatcher.js +0 -48
  144. package/node_modules/undici/lib/dispatcher/env-http-proxy-agent.js +0 -146
  145. package/node_modules/undici/lib/dispatcher/fixed-queue.js +0 -135
  146. package/node_modules/undici/lib/dispatcher/h2c-client.js +0 -51
  147. package/node_modules/undici/lib/dispatcher/pool-base.js +0 -214
  148. package/node_modules/undici/lib/dispatcher/pool.js +0 -118
  149. package/node_modules/undici/lib/dispatcher/proxy-agent.js +0 -319
  150. package/node_modules/undici/lib/dispatcher/retry-agent.js +0 -35
  151. package/node_modules/undici/lib/dispatcher/round-robin-pool.js +0 -137
  152. package/node_modules/undici/lib/dispatcher/socks5-proxy-agent.js +0 -260
  153. package/node_modules/undici/lib/encoding/index.js +0 -33
  154. package/node_modules/undici/lib/global.js +0 -59
  155. package/node_modules/undici/lib/handler/cache-handler.js +0 -578
  156. package/node_modules/undici/lib/handler/cache-revalidation-handler.js +0 -124
  157. package/node_modules/undici/lib/handler/decorator-handler.js +0 -67
  158. package/node_modules/undici/lib/handler/deduplication-handler.js +0 -460
  159. package/node_modules/undici/lib/handler/redirect-handler.js +0 -238
  160. package/node_modules/undici/lib/handler/retry-handler.js +0 -394
  161. package/node_modules/undici/lib/handler/unwrap-handler.js +0 -106
  162. package/node_modules/undici/lib/handler/wrap-handler.js +0 -105
  163. package/node_modules/undici/lib/interceptor/cache.js +0 -495
  164. package/node_modules/undici/lib/interceptor/decompress.js +0 -259
  165. package/node_modules/undici/lib/interceptor/deduplicate.js +0 -117
  166. package/node_modules/undici/lib/interceptor/dns.js +0 -571
  167. package/node_modules/undici/lib/interceptor/dump.js +0 -112
  168. package/node_modules/undici/lib/interceptor/redirect.js +0 -21
  169. package/node_modules/undici/lib/interceptor/response-error.js +0 -95
  170. package/node_modules/undici/lib/interceptor/retry.js +0 -19
  171. package/node_modules/undici/lib/llhttp/.gitkeep +0 -0
  172. package/node_modules/undici/lib/llhttp/constants.d.ts +0 -195
  173. package/node_modules/undici/lib/llhttp/constants.js +0 -531
  174. package/node_modules/undici/lib/llhttp/llhttp-wasm.js +0 -15
  175. package/node_modules/undici/lib/llhttp/llhttp_simd-wasm.js +0 -15
  176. package/node_modules/undici/lib/llhttp/utils.d.ts +0 -2
  177. package/node_modules/undici/lib/llhttp/utils.js +0 -12
  178. package/node_modules/undici/lib/mock/mock-agent.js +0 -232
  179. package/node_modules/undici/lib/mock/mock-call-history.js +0 -248
  180. package/node_modules/undici/lib/mock/mock-client.js +0 -68
  181. package/node_modules/undici/lib/mock/mock-errors.js +0 -29
  182. package/node_modules/undici/lib/mock/mock-interceptor.js +0 -209
  183. package/node_modules/undici/lib/mock/mock-pool.js +0 -68
  184. package/node_modules/undici/lib/mock/mock-symbols.js +0 -32
  185. package/node_modules/undici/lib/mock/mock-utils.js +0 -486
  186. package/node_modules/undici/lib/mock/pending-interceptors-formatter.js +0 -43
  187. package/node_modules/undici/lib/mock/snapshot-agent.js +0 -353
  188. package/node_modules/undici/lib/mock/snapshot-recorder.js +0 -588
  189. package/node_modules/undici/lib/mock/snapshot-utils.js +0 -158
  190. package/node_modules/undici/lib/util/cache.js +0 -414
  191. package/node_modules/undici/lib/util/date.js +0 -653
  192. package/node_modules/undici/lib/util/promise.js +0 -28
  193. package/node_modules/undici/lib/util/runtime-features.js +0 -124
  194. package/node_modules/undici/lib/util/stats.js +0 -32
  195. package/node_modules/undici/lib/util/timers.js +0 -425
  196. package/node_modules/undici/lib/web/cache/cache.js +0 -864
  197. package/node_modules/undici/lib/web/cache/cachestorage.js +0 -152
  198. package/node_modules/undici/lib/web/cache/util.js +0 -45
  199. package/node_modules/undici/lib/web/cookies/constants.js +0 -12
  200. package/node_modules/undici/lib/web/cookies/index.js +0 -199
  201. package/node_modules/undici/lib/web/cookies/parse.js +0 -314
  202. package/node_modules/undici/lib/web/cookies/util.js +0 -282
  203. package/node_modules/undici/lib/web/eventsource/eventsource-stream.js +0 -399
  204. package/node_modules/undici/lib/web/eventsource/eventsource.js +0 -501
  205. package/node_modules/undici/lib/web/eventsource/util.js +0 -29
  206. package/node_modules/undici/lib/web/fetch/LICENSE +0 -21
  207. package/node_modules/undici/lib/web/fetch/body.js +0 -509
  208. package/node_modules/undici/lib/web/fetch/constants.js +0 -131
  209. package/node_modules/undici/lib/web/fetch/data-url.js +0 -596
  210. package/node_modules/undici/lib/web/fetch/formdata-parser.js +0 -586
  211. package/node_modules/undici/lib/web/fetch/formdata.js +0 -259
  212. package/node_modules/undici/lib/web/fetch/global.js +0 -40
  213. package/node_modules/undici/lib/web/fetch/headers.js +0 -719
  214. package/node_modules/undici/lib/web/fetch/index.js +0 -2413
  215. package/node_modules/undici/lib/web/fetch/request.js +0 -1115
  216. package/node_modules/undici/lib/web/fetch/response.js +0 -641
  217. package/node_modules/undici/lib/web/fetch/util.js +0 -1522
  218. package/node_modules/undici/lib/web/infra/index.js +0 -229
  219. package/node_modules/undici/lib/web/subresource-integrity/Readme.md +0 -9
  220. package/node_modules/undici/lib/web/subresource-integrity/subresource-integrity.js +0 -307
  221. package/node_modules/undici/lib/web/webidl/index.js +0 -1006
  222. package/node_modules/undici/lib/web/websocket/connection.js +0 -329
  223. package/node_modules/undici/lib/web/websocket/constants.js +0 -126
  224. package/node_modules/undici/lib/web/websocket/events.js +0 -331
  225. package/node_modules/undici/lib/web/websocket/frame.js +0 -133
  226. package/node_modules/undici/lib/web/websocket/permessage-deflate.js +0 -100
  227. package/node_modules/undici/lib/web/websocket/receiver.js +0 -507
  228. package/node_modules/undici/lib/web/websocket/sender.js +0 -109
  229. package/node_modules/undici/lib/web/websocket/stream/websocketerror.js +0 -104
  230. package/node_modules/undici/lib/web/websocket/stream/websocketstream.js +0 -498
  231. package/node_modules/undici/lib/web/websocket/util.js +0 -347
  232. package/node_modules/undici/lib/web/websocket/websocket.js +0 -758
  233. package/node_modules/undici/package.json +0 -152
  234. package/node_modules/undici/scripts/strip-comments.js +0 -10
  235. package/node_modules/undici/types/README.md +0 -6
  236. package/node_modules/undici/types/agent.d.ts +0 -32
  237. package/node_modules/undici/types/api.d.ts +0 -43
  238. package/node_modules/undici/types/balanced-pool.d.ts +0 -30
  239. package/node_modules/undici/types/cache-interceptor.d.ts +0 -179
  240. package/node_modules/undici/types/cache.d.ts +0 -36
  241. package/node_modules/undici/types/client-stats.d.ts +0 -15
  242. package/node_modules/undici/types/client.d.ts +0 -139
  243. package/node_modules/undici/types/connector.d.ts +0 -36
  244. package/node_modules/undici/types/content-type.d.ts +0 -21
  245. package/node_modules/undici/types/cookies.d.ts +0 -30
  246. package/node_modules/undici/types/diagnostics-channel.d.ts +0 -74
  247. package/node_modules/undici/types/dispatcher.d.ts +0 -275
  248. package/node_modules/undici/types/env-http-proxy-agent.d.ts +0 -22
  249. package/node_modules/undici/types/errors.d.ts +0 -177
  250. package/node_modules/undici/types/eventsource.d.ts +0 -66
  251. package/node_modules/undici/types/fetch.d.ts +0 -231
  252. package/node_modules/undici/types/formdata.d.ts +0 -114
  253. package/node_modules/undici/types/global-dispatcher.d.ts +0 -9
  254. package/node_modules/undici/types/global-origin.d.ts +0 -7
  255. package/node_modules/undici/types/h2c-client.d.ts +0 -73
  256. package/node_modules/undici/types/handlers.d.ts +0 -14
  257. package/node_modules/undici/types/header.d.ts +0 -160
  258. package/node_modules/undici/types/index.d.ts +0 -91
  259. package/node_modules/undici/types/interceptors.d.ts +0 -80
  260. package/node_modules/undici/types/mock-agent.d.ts +0 -68
  261. package/node_modules/undici/types/mock-call-history.d.ts +0 -111
  262. package/node_modules/undici/types/mock-client.d.ts +0 -27
  263. package/node_modules/undici/types/mock-errors.d.ts +0 -12
  264. package/node_modules/undici/types/mock-interceptor.d.ts +0 -94
  265. package/node_modules/undici/types/mock-pool.d.ts +0 -27
  266. package/node_modules/undici/types/patch.d.ts +0 -29
  267. package/node_modules/undici/types/pool-stats.d.ts +0 -19
  268. package/node_modules/undici/types/pool.d.ts +0 -41
  269. package/node_modules/undici/types/proxy-agent.d.ts +0 -29
  270. package/node_modules/undici/types/readable.d.ts +0 -68
  271. package/node_modules/undici/types/retry-agent.d.ts +0 -8
  272. package/node_modules/undici/types/retry-handler.d.ts +0 -125
  273. package/node_modules/undici/types/round-robin-pool.d.ts +0 -41
  274. package/node_modules/undici/types/snapshot-agent.d.ts +0 -109
  275. package/node_modules/undici/types/socks5-proxy-agent.d.ts +0 -25
  276. package/node_modules/undici/types/util.d.ts +0 -18
  277. package/node_modules/undici/types/utility.d.ts +0 -7
  278. package/node_modules/undici/types/webidl.d.ts +0 -347
  279. package/node_modules/undici/types/websocket.d.ts +0 -188
@@ -1,159 +0,0 @@
1
- # Class: EnvHttpProxyAgent
2
-
3
- Extends: `undici.Dispatcher`
4
-
5
- EnvHttpProxyAgent automatically reads the proxy configuration from the environment variables `http_proxy`, `https_proxy`, and `no_proxy` and sets up the proxy agents accordingly. When `http_proxy` and `https_proxy` are set, `http_proxy` is used for HTTP requests and `https_proxy` is used for HTTPS requests. If only `http_proxy` is set, `http_proxy` is used for both HTTP and HTTPS requests. If only `https_proxy` is set, it is only used for HTTPS requests.
6
-
7
- `no_proxy` is a comma or space-separated list of hostnames that should not be proxied. The list may contain leading wildcard characters (`*`). If `no_proxy` is set, the EnvHttpProxyAgent will bypass the proxy for requests to hosts that match the list. If `no_proxy` is set to `"*"`, the EnvHttpProxyAgent will bypass the proxy for all requests.
8
-
9
- Uppercase environment variables are also supported: `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`. However, if both the lowercase and uppercase environment variables are set, the uppercase environment variables will be ignored.
10
-
11
- ## `new EnvHttpProxyAgent([options])`
12
-
13
- Arguments:
14
-
15
- * **options** `EnvHttpProxyAgentOptions` (optional) - extends the `Agent` options.
16
-
17
- Returns: `EnvHttpProxyAgent`
18
-
19
- ### Parameter: `EnvHttpProxyAgentOptions`
20
-
21
- Extends: [`AgentOptions`](/docs/docs/api/Agent.md#parameter-agentoptions)
22
-
23
- * **httpProxy** `string` (optional) - When set, it will override the `HTTP_PROXY` environment variable.
24
- * **httpsProxy** `string` (optional) - When set, it will override the `HTTPS_PROXY` environment variable.
25
- * **noProxy** `string` (optional) - When set, it will override the `NO_PROXY` environment variable.
26
-
27
- Examples:
28
-
29
- ```js
30
- import { EnvHttpProxyAgent } from 'undici'
31
-
32
- const envHttpProxyAgent = new EnvHttpProxyAgent()
33
- // or
34
- const envHttpProxyAgent = new EnvHttpProxyAgent({ httpProxy: 'my.proxy.server:8080', httpsProxy: 'my.proxy.server:8443', noProxy: 'localhost' })
35
- ```
36
-
37
- #### Example - EnvHttpProxyAgent instantiation
38
-
39
- This will instantiate the EnvHttpProxyAgent. It will not do anything until registered as the agent to use with requests.
40
-
41
- ```js
42
- import { EnvHttpProxyAgent } from 'undici'
43
-
44
- const envHttpProxyAgent = new EnvHttpProxyAgent()
45
- ```
46
-
47
- #### Example - Basic Proxy Fetch with global agent dispatcher
48
-
49
- ```js
50
- import { setGlobalDispatcher, fetch, EnvHttpProxyAgent } from 'undici'
51
-
52
- const envHttpProxyAgent = new EnvHttpProxyAgent()
53
- setGlobalDispatcher(envHttpProxyAgent)
54
-
55
- const { status, json } = await fetch('http://localhost:3000/foo')
56
-
57
- console.log('response received', status) // response received 200
58
-
59
- const data = await json() // data { foo: "bar" }
60
- ```
61
-
62
- #### Example - Basic Proxy Request with global agent dispatcher
63
-
64
- ```js
65
- import { setGlobalDispatcher, request, EnvHttpProxyAgent } from 'undici'
66
-
67
- const envHttpProxyAgent = new EnvHttpProxyAgent()
68
- setGlobalDispatcher(envHttpProxyAgent)
69
-
70
- const { statusCode, body } = await request('http://localhost:3000/foo')
71
-
72
- console.log('response received', statusCode) // response received 200
73
-
74
- for await (const data of body) {
75
- console.log('data', data.toString('utf8')) // data foo
76
- }
77
- ```
78
-
79
- #### Example - Basic Proxy Request with local agent dispatcher
80
-
81
- ```js
82
- import { EnvHttpProxyAgent, request } from 'undici'
83
-
84
- const envHttpProxyAgent = new EnvHttpProxyAgent()
85
-
86
- const {
87
- statusCode,
88
- body
89
- } = await request('http://localhost:3000/foo', { dispatcher: envHttpProxyAgent })
90
-
91
- console.log('response received', statusCode) // response received 200
92
-
93
- for await (const data of body) {
94
- console.log('data', data.toString('utf8')) // data foo
95
- }
96
- ```
97
-
98
- #### Example - Basic Proxy Fetch with local agent dispatcher
99
-
100
- ```js
101
- import { EnvHttpProxyAgent, fetch } from 'undici'
102
-
103
- const envHttpProxyAgent = new EnvHttpProxyAgent()
104
-
105
- const {
106
- status,
107
- json
108
- } = await fetch('http://localhost:3000/foo', { dispatcher: envHttpProxyAgent })
109
-
110
- console.log('response received', status) // response received 200
111
-
112
- const data = await json() // data { foo: "bar" }
113
- ```
114
-
115
- ## Instance Methods
116
-
117
- ### `EnvHttpProxyAgent.close([callback])`
118
-
119
- Implements [`Dispatcher.close([callback])`](/docs/docs/api/Dispatcher.md#dispatcherclosecallback-promise).
120
-
121
- ### `EnvHttpProxyAgent.destroy([error, callback])`
122
-
123
- Implements [`Dispatcher.destroy([error, callback])`](/docs/docs/api/Dispatcher.md#dispatcherdestroyerror-callback-promise).
124
-
125
- ### `EnvHttpProxyAgent.dispatch(options, handler: AgentDispatchOptions)`
126
-
127
- Implements [`Dispatcher.dispatch(options, handler)`](/docs/docs/api/Dispatcher.md#dispatcherdispatchoptions-handler).
128
-
129
- #### Parameter: `AgentDispatchOptions`
130
-
131
- Extends: [`DispatchOptions`](/docs/docs/api/Dispatcher.md#parameter-dispatchoptions)
132
-
133
- * **origin** `string | URL`
134
-
135
- Implements [`Dispatcher.destroy([error, callback])`](/docs/docs/api/Dispatcher.md#dispatcherdestroyerror-callback-promise).
136
-
137
- ### `EnvHttpProxyAgent.connect(options[, callback])`
138
-
139
- See [`Dispatcher.connect(options[, callback])`](/docs/docs/api/Dispatcher.md#dispatcherconnectoptions-callback).
140
-
141
- ### `EnvHttpProxyAgent.dispatch(options, handler)`
142
-
143
- Implements [`Dispatcher.dispatch(options, handler)`](/docs/docs/api/Dispatcher.md#dispatcherdispatchoptions-handler).
144
-
145
- ### `EnvHttpProxyAgent.pipeline(options, handler)`
146
-
147
- See [`Dispatcher.pipeline(options, handler)`](/docs/docs/api/Dispatcher.md#dispatcherpipelineoptions-handler).
148
-
149
- ### `EnvHttpProxyAgent.request(options[, callback])`
150
-
151
- See [`Dispatcher.request(options [, callback])`](/docs/docs/api/Dispatcher.md#dispatcherrequestoptions-callback).
152
-
153
- ### `EnvHttpProxyAgent.stream(options, factory[, callback])`
154
-
155
- See [`Dispatcher.stream(options, factory[, callback])`](/docs/docs/api/Dispatcher.md#dispatcherstreamoptions-factory-callback).
156
-
157
- ### `EnvHttpProxyAgent.upgrade(options[, callback])`
158
-
159
- See [`Dispatcher.upgrade(options[, callback])`](/docs/docs/api/Dispatcher.md#dispatcherupgradeoptions-callback).
@@ -1,49 +0,0 @@
1
- # Errors
2
-
3
- Undici exposes a variety of error objects that you can use to enhance your error handling.
4
- You can find all the error objects inside the `errors` key.
5
-
6
- ```js
7
- import { errors } from 'undici'
8
- ```
9
-
10
- | Error | Error Codes | Description |
11
- | ------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------- |
12
- | `UndiciError` | `UND_ERR` | all errors below are extended from `UndiciError`. |
13
- | `ConnectTimeoutError` | `UND_ERR_CONNECT_TIMEOUT` | socket is destroyed due to connect timeout. |
14
- | `HeadersTimeoutError` | `UND_ERR_HEADERS_TIMEOUT` | socket is destroyed due to headers timeout. |
15
- | `HeadersOverflowError` | `UND_ERR_HEADERS_OVERFLOW` | socket is destroyed due to headers' max size being exceeded. |
16
- | `BodyTimeoutError` | `UND_ERR_BODY_TIMEOUT` | socket is destroyed due to body timeout. |
17
- | `InvalidArgumentError` | `UND_ERR_INVALID_ARG` | passed an invalid argument. |
18
- | `InvalidReturnValueError` | `UND_ERR_INVALID_RETURN_VALUE` | returned an invalid value. |
19
- | `RequestAbortedError` | `UND_ERR_ABORTED` | the request has been aborted by the user |
20
- | `ClientDestroyedError` | `UND_ERR_DESTROYED` | trying to use a destroyed client. |
21
- | `ClientClosedError` | `UND_ERR_CLOSED` | trying to use a closed client. |
22
- | `SocketError` | `UND_ERR_SOCKET` | there is an error with the socket. |
23
- | `NotSupportedError` | `UND_ERR_NOT_SUPPORTED` | encountered unsupported functionality. |
24
- | `RequestContentLengthMismatchError` | `UND_ERR_REQ_CONTENT_LENGTH_MISMATCH` | request body does not match content-length header |
25
- | `ResponseContentLengthMismatchError` | `UND_ERR_RES_CONTENT_LENGTH_MISMATCH` | response body does not match content-length header |
26
- | `InformationalError` | `UND_ERR_INFO` | expected error with reason |
27
- | `ResponseExceededMaxSizeError` | `UND_ERR_RES_EXCEEDED_MAX_SIZE` | response body exceed the max size allowed |
28
- | `SecureProxyConnectionError` | `UND_ERR_PRX_TLS` | tls connection to a proxy failed |
29
- | `MessageSizeExceededError` | `UND_ERR_WS_MESSAGE_SIZE_EXCEEDED` | WebSocket decompressed message exceeded the maximum allowed size |
30
-
31
- Be aware of the possible difference between the global dispatcher version and the actual undici version you might be using. We recommend to avoid the check `instanceof errors.UndiciError` and seek for the `error.code === '<error_code>'` instead to avoid inconsistencies.
32
- ### `SocketError`
33
-
34
- The `SocketError` has a `.socket` property which holds socket metadata:
35
-
36
- ```ts
37
- interface SocketInfo {
38
- localAddress?: string
39
- localPort?: number
40
- remoteAddress?: string
41
- remotePort?: number
42
- remoteFamily?: string
43
- timeout?: number
44
- bytesWritten?: number
45
- bytesRead?: number
46
- }
47
- ```
48
-
49
- Be aware that in some cases the `.socket` property can be `null`.
@@ -1,45 +0,0 @@
1
- # EventSource
2
-
3
- > ⚠️ Warning: the EventSource API is experimental.
4
-
5
- Undici exposes a WHATWG spec-compliant implementation of [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource)
6
- for [Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events).
7
-
8
- ## Instantiating EventSource
9
-
10
- Undici exports a EventSource class. You can instantiate the EventSource as
11
- follows:
12
-
13
- ```mjs
14
- import { EventSource } from 'undici'
15
-
16
- const eventSource = new EventSource('http://localhost:3000')
17
- eventSource.onmessage = (event) => {
18
- console.log(event.data)
19
- }
20
- ```
21
-
22
- ## Using a custom Dispatcher
23
-
24
- undici allows you to set your own Dispatcher in the EventSource constructor.
25
-
26
- An example which allows you to modify the request headers is:
27
-
28
- ```mjs
29
- import { EventSource, Agent } from 'undici'
30
-
31
- class CustomHeaderAgent extends Agent {
32
- dispatch (opts) {
33
- opts.headers['x-custom-header'] = 'hello world'
34
- return super.dispatch(...arguments)
35
- }
36
- }
37
-
38
- const eventSource = new EventSource('http://localhost:3000', {
39
- dispatcher: new CustomHeaderAgent()
40
- })
41
-
42
- ```
43
-
44
- More information about the EventSource API can be found on
45
- [MDN](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
@@ -1,60 +0,0 @@
1
- # Fetch
2
-
3
- Undici exposes a fetch() method starts the process of fetching a resource from the network.
4
-
5
- Documentation and examples can be found on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
6
-
7
- ## FormData
8
-
9
- This API is implemented as per the standard, you can find documentation on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/FormData).
10
-
11
- If any parameters are passed to the FormData constructor other than `undefined`, an error will be thrown. Other parameters are ignored.
12
-
13
- When you use `FormData` as a request body, keep `fetch` and `FormData` from the
14
- same implementation. Use the built-in global `FormData` with the built-in
15
- global `fetch()`, and use `undici`'s `FormData` with `undici.fetch()`.
16
-
17
- If you want the installed `undici` package to provide the globals, call
18
- [`install()`](/docs/api/GlobalInstallation.md) so `fetch`, `Headers`,
19
- `Response`, `Request`, and `FormData` are installed together as a matching set.
20
-
21
- ## Response
22
-
23
- This API is implemented as per the standard, you can find documentation on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Response)
24
-
25
- ## Request
26
-
27
- This API is implemented as per the standard, you can find documentation on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Request)
28
-
29
- ## Header
30
-
31
- This API is implemented as per the standard, you can find documentation on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Headers)
32
-
33
- # Body Mixins
34
-
35
- `Response` and `Request` body inherit body mixin methods. These methods include:
36
-
37
- - [`.arrayBuffer()`](https://fetch.spec.whatwg.org/#dom-body-arraybuffer)
38
- - [`.blob()`](https://fetch.spec.whatwg.org/#dom-body-blob)
39
- - [`.bytes()`](https://fetch.spec.whatwg.org/#dom-body-bytes)
40
- - [`.formData()`](https://fetch.spec.whatwg.org/#dom-body-formdata)
41
- - [`.json()`](https://fetch.spec.whatwg.org/#dom-body-json)
42
- - [`.text()`](https://fetch.spec.whatwg.org/#dom-body-text)
43
-
44
- There is an ongoing discussion regarding `.formData()` and its usefulness and performance in server environments. It is recommended to use a dedicated library for parsing `multipart/form-data` bodies, such as [Busboy](https://www.npmjs.com/package/busboy) or [@fastify/busboy](https://www.npmjs.com/package/@fastify/busboy).
45
-
46
- These libraries can be interfaced with fetch with the following example code:
47
-
48
- ```mjs
49
- import { Busboy } from '@fastify/busboy'
50
- import { Readable } from 'node:stream'
51
-
52
- const response = await fetch('...')
53
- const busboy = new Busboy({
54
- headers: {
55
- 'content-type': response.headers.get('content-type')
56
- }
57
- })
58
-
59
- Readable.fromWeb(response.body).pipe(busboy)
60
- ```
@@ -1,139 +0,0 @@
1
- # Global Installation
2
-
3
- Undici provides an `install()` function to add all WHATWG fetch classes to `globalThis`, making them available globally without requiring imports.
4
-
5
- ## `install()`
6
-
7
- Install all WHATWG fetch classes globally on `globalThis`.
8
-
9
- **Example:**
10
-
11
- ```js
12
- import { install } from 'undici'
13
-
14
- // Install all WHATWG fetch classes globally
15
- install()
16
-
17
- // Now you can use fetch classes globally without importing
18
- const response = await fetch('https://api.example.com/data')
19
- const data = await response.json()
20
-
21
- // All classes are available globally:
22
- const headers = new Headers([['content-type', 'application/json']])
23
- const request = new Request('https://example.com')
24
- const formData = new FormData()
25
- const ws = new WebSocket('wss://example.com')
26
- const eventSource = new EventSource('https://example.com/events')
27
- ```
28
-
29
- ## Installed Classes
30
-
31
- The `install()` function adds the following classes to `globalThis`:
32
-
33
- | Class | Description |
34
- |-------|-------------|
35
- | `fetch` | The fetch function for making HTTP requests |
36
- | `Headers` | HTTP headers management |
37
- | `Response` | HTTP response representation |
38
- | `Request` | HTTP request representation |
39
- | `FormData` | Form data handling |
40
- | `WebSocket` | WebSocket client |
41
- | `CloseEvent` | WebSocket close event |
42
- | `ErrorEvent` | WebSocket error event |
43
- | `MessageEvent` | WebSocket message event |
44
- | `EventSource` | Server-sent events client |
45
-
46
- ## Using `FormData` with `fetch`
47
-
48
- If you send a `FormData` body, use matching implementations for `fetch` and
49
- `FormData`.
50
-
51
- These two patterns are safe:
52
-
53
- ```js
54
- // Built-in globals from Node.js
55
- const body = new FormData()
56
- await fetch('https://example.com', {
57
- method: 'POST',
58
- body
59
- })
60
- ```
61
-
62
- ```js
63
- // Globals installed from the undici package
64
- import { install } from 'undici'
65
-
66
- install()
67
-
68
- const body = new FormData()
69
- await fetch('https://example.com', {
70
- method: 'POST',
71
- body
72
- })
73
- ```
74
-
75
- After `install()`, `fetch`, `Headers`, `Response`, `Request`, and `FormData`
76
- all come from the installed `undici` package, so they work as a matching set.
77
-
78
- If you do not want to install globals, import both from `undici` instead:
79
-
80
- ```js
81
- import { fetch, FormData } from 'undici'
82
-
83
- const body = new FormData()
84
- await fetch('https://example.com', {
85
- method: 'POST',
86
- body
87
- })
88
- ```
89
-
90
- Avoid mixing a global `FormData` with `undici.fetch()`, or `undici.FormData`
91
- with the built-in global `fetch()`. Keeping them paired avoids surprising
92
- multipart behavior across Node.js and undici versions.
93
-
94
- ## Use Cases
95
-
96
- Global installation is useful for:
97
-
98
- - **Polyfilling environments** that don't have native fetch support
99
- - **Ensuring consistent behavior** across different Node.js versions
100
- - **Library compatibility** when third-party libraries expect global fetch
101
- - **Migration scenarios** where you want to replace built-in implementations
102
- - **Testing environments** where you need predictable fetch behavior
103
-
104
- ## Example: Polyfilling an Environment
105
-
106
- ```js
107
- import { install } from 'undici'
108
-
109
- // Check if fetch is available and install if needed
110
- if (typeof globalThis.fetch === 'undefined') {
111
- install()
112
- console.log('Undici fetch installed globally')
113
- }
114
-
115
- // Now fetch is guaranteed to be available
116
- const response = await fetch('https://api.example.com')
117
- ```
118
-
119
- ## Example: Testing Environment
120
-
121
- ```js
122
- import { install } from 'undici'
123
-
124
- // In test setup, ensure consistent fetch behavior
125
- install()
126
-
127
- // Now all tests use undici's implementations
128
- test('fetch API test', async () => {
129
- const response = await fetch('https://example.com')
130
- expect(response).toBeInstanceOf(Response)
131
- })
132
- ```
133
-
134
- ## Notes
135
-
136
- - The `install()` function overwrites any existing global implementations
137
- - Classes installed are undici's implementations, not Node.js built-ins
138
- - This provides access to undici's latest features and performance improvements
139
- - The global installation persists for the lifetime of the process