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,197 +0,0 @@
1
- # Class: MockCallHistory
2
-
3
- Access to an instance with :
4
-
5
- ```js
6
- const mockAgent = new MockAgent({ enableCallHistory: true })
7
- mockAgent.getCallHistory()
8
-
9
- // or
10
- const mockAgent = new MockAgent()
11
- mockAgent.enableMockHistory()
12
- mockAgent.getCallHistory()
13
-
14
- ```
15
-
16
- a MockCallHistory instance implements a **Symbol.iterator** letting you iterate on registered logs :
17
-
18
- ```ts
19
- for (const log of mockAgent.getCallHistory()) {
20
- //...
21
- }
22
-
23
- const array: Array<MockCallHistoryLog> = [...mockAgent.getCallHistory()]
24
- const set: Set<MockCallHistoryLog> = new Set(mockAgent.getCallHistory())
25
- ```
26
-
27
- ## class methods
28
-
29
- ### clear
30
-
31
- Clear all MockCallHistoryLog registered. This is automatically done when calling `mockAgent.close()`
32
-
33
- ```js
34
- mockAgent.clearCallHistory()
35
- // same as
36
- mockAgent.getCallHistory()?.clear()
37
- ```
38
-
39
- ### calls
40
-
41
- Get all MockCallHistoryLog registered as an array
42
-
43
- ```js
44
- mockAgent.getCallHistory()?.calls()
45
- ```
46
-
47
- ### firstCall
48
-
49
- Get the first MockCallHistoryLog registered or undefined
50
-
51
- ```js
52
- mockAgent.getCallHistory()?.firstCall()
53
- ```
54
-
55
- ### lastCall
56
-
57
- Get the last MockCallHistoryLog registered or undefined
58
-
59
- ```js
60
- mockAgent.getCallHistory()?.lastCall()
61
- ```
62
-
63
- ### nthCall
64
-
65
- Get the nth MockCallHistoryLog registered or undefined
66
-
67
- ```js
68
- mockAgent.getCallHistory()?.nthCall(3) // the third MockCallHistoryLog registered
69
- ```
70
-
71
- ### filterCallsByProtocol
72
-
73
- Filter MockCallHistoryLog by protocol.
74
-
75
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
76
-
77
- ```js
78
- mockAgent.getCallHistory()?.filterCallsByProtocol(/https/)
79
- mockAgent.getCallHistory()?.filterCallsByProtocol('https:')
80
- ```
81
-
82
- ### filterCallsByHost
83
-
84
- Filter MockCallHistoryLog by host.
85
-
86
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
87
-
88
- ```js
89
- mockAgent.getCallHistory()?.filterCallsByHost(/localhost/)
90
- mockAgent.getCallHistory()?.filterCallsByHost('localhost:3000')
91
- ```
92
-
93
- ### filterCallsByPort
94
-
95
- Filter MockCallHistoryLog by port.
96
-
97
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
98
-
99
- ```js
100
- mockAgent.getCallHistory()?.filterCallsByPort(/3000/)
101
- mockAgent.getCallHistory()?.filterCallsByPort('3000')
102
- mockAgent.getCallHistory()?.filterCallsByPort('')
103
- ```
104
-
105
- ### filterCallsByOrigin
106
-
107
- Filter MockCallHistoryLog by origin.
108
-
109
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
110
-
111
- ```js
112
- mockAgent.getCallHistory()?.filterCallsByOrigin(/http:\/\/localhost:3000/)
113
- mockAgent.getCallHistory()?.filterCallsByOrigin('http://localhost:3000')
114
- ```
115
-
116
- ### filterCallsByPath
117
-
118
- Filter MockCallHistoryLog by path.
119
-
120
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
121
-
122
- ```js
123
- mockAgent.getCallHistory()?.filterCallsByPath(/api\/v1\/graphql/)
124
- mockAgent.getCallHistory()?.filterCallsByPath('/api/v1/graphql')
125
- ```
126
-
127
- ### filterCallsByHash
128
-
129
- Filter MockCallHistoryLog by hash.
130
-
131
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
132
-
133
- ```js
134
- mockAgent.getCallHistory()?.filterCallsByPath(/hash/)
135
- mockAgent.getCallHistory()?.filterCallsByPath('#hash')
136
- ```
137
-
138
- ### filterCallsByFullUrl
139
-
140
- Filter MockCallHistoryLog by fullUrl. fullUrl contains protocol, host, port, path, hash, and query params
141
-
142
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
143
-
144
- ```js
145
- mockAgent.getCallHistory()?.filterCallsByFullUrl(/https:\/\/localhost:3000\/\?query=value#hash/)
146
- mockAgent.getCallHistory()?.filterCallsByFullUrl('https://localhost:3000/?query=value#hash')
147
- ```
148
-
149
- ### filterCallsByMethod
150
-
151
- Filter MockCallHistoryLog by method.
152
-
153
- > more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)
154
-
155
- ```js
156
- mockAgent.getCallHistory()?.filterCallsByMethod(/POST/)
157
- mockAgent.getCallHistory()?.filterCallsByMethod('POST')
158
- ```
159
-
160
- ### filterCalls
161
-
162
- This class method is a meta function / alias to apply complex filtering in a single way.
163
-
164
- Parameters :
165
-
166
- - criteria : the first parameter. a function, regexp or object.
167
- - function : filter MockCallHistoryLog when the function returns false
168
- - regexp : filter MockCallHistoryLog when the regexp does not match on MockCallHistoryLog.toString() ([see](./MockCallHistoryLog.md#to-string))
169
- - object : an object with MockCallHistoryLog properties as keys to apply multiple filters. each values are a [filter parameter](/docs/docs/api/MockCallHistory.md#filter-parameter)
170
- - options : the second parameter. an object.
171
- - options.operator : `'AND'` or `'OR'` (default `'OR'`). Used only if criteria is an object. see below
172
-
173
- ```js
174
- mockAgent.getCallHistory()?.filterCalls((log) => log.hash === value && log.headers?.['authorization'] !== undefined)
175
- mockAgent.getCallHistory()?.filterCalls(/"data": "{ "errors": "wrong body" }"/)
176
-
177
- // returns an Array of MockCallHistoryLog which all have
178
- // - a hash containing my-hash
179
- // - OR
180
- // - a path equal to /endpoint
181
- mockAgent.getCallHistory()?.filterCalls({ hash: /my-hash/, path: '/endpoint' })
182
-
183
- // returns an Array of MockCallHistoryLog which all have
184
- // - a hash containing my-hash
185
- // - AND
186
- // - a path equal to /endpoint
187
- mockAgent.getCallHistory()?.filterCalls({ hash: /my-hash/, path: '/endpoint' }, { operator: 'AND' })
188
- ```
189
-
190
- ## filter parameter
191
-
192
- Can be :
193
-
194
- - string. MockCallHistoryLog filtered if `value !== parameterValue`
195
- - null. MockCallHistoryLog filtered if `value !== parameterValue`
196
- - undefined. MockCallHistoryLog filtered if `value !== parameterValue`
197
- - regexp. MockCallHistoryLog filtered if `!parameterValue.test(value)`
@@ -1,43 +0,0 @@
1
- # Class: MockCallHistoryLog
2
-
3
- Access to an instance with :
4
-
5
- ```js
6
- const mockAgent = new MockAgent({ enableCallHistory: true })
7
- mockAgent.getCallHistory()?.firstCall()
8
- ```
9
-
10
- ## class properties
11
-
12
- - body `mockAgent.getCallHistory()?.firstCall()?.body`
13
- - headers `mockAgent.getCallHistory()?.firstCall()?.headers` an object
14
- - method `mockAgent.getCallHistory()?.firstCall()?.method` a string
15
- - fullUrl `mockAgent.getCallHistory()?.firstCall()?.fullUrl` a string containing the protocol, origin, path, query and hash
16
- - origin `mockAgent.getCallHistory()?.firstCall()?.origin` a string containing the protocol and the host
17
- - headers `mockAgent.getCallHistory()?.firstCall()?.headers` an object
18
- - path `mockAgent.getCallHistory()?.firstCall()?.path` a string always starting with `/`
19
- - searchParams `mockAgent.getCallHistory()?.firstCall()?.searchParams` an object
20
- - protocol `mockAgent.getCallHistory()?.firstCall()?.protocol` a string (`https:`)
21
- - host `mockAgent.getCallHistory()?.firstCall()?.host` a string
22
- - port `mockAgent.getCallHistory()?.firstCall()?.port` an empty string or a string containing numbers
23
- - hash `mockAgent.getCallHistory()?.firstCall()?.hash` an empty string or a string starting with `#`
24
-
25
- ## class methods
26
-
27
- ### toMap
28
-
29
- Returns a Map instance
30
-
31
- ```js
32
- mockAgent.getCallHistory()?.firstCall()?.toMap()?.get('hash')
33
- // #hash
34
- ```
35
-
36
- ### toString
37
-
38
- Returns a string computed with any class property name and value pair
39
-
40
- ```js
41
- mockAgent.getCallHistory()?.firstCall()?.toString()
42
- // protocol->https:|host->localhost:4000|port->4000|origin->https://localhost:4000|path->/endpoint|hash->#here|searchParams->{"query":"value"}|fullUrl->https://localhost:4000/endpoint?query=value#here|method->PUT|body->"{ "data": "hello" }"|headers->{"content-type":"application/json"}
43
- ```
@@ -1,81 +0,0 @@
1
- # Class: MockClient
2
-
3
- Extends: `undici.Client`
4
-
5
- A mock client class that implements the same api as [MockPool](/docs/docs/api/MockPool.md).
6
-
7
- ## `new MockClient(origin, [options])`
8
-
9
- Arguments:
10
-
11
- * **origin** `string` - It should only include the **protocol, hostname, and port**.
12
- * **options** `MockClientOptions` - It extends the `Client` options.
13
-
14
- Returns: `MockClient`
15
-
16
- ### Parameter: `MockClientOptions`
17
-
18
- Extends: `ClientOptions`
19
-
20
- * **agent** `Agent` - the agent to associate this MockClient with.
21
-
22
- ### Example - Basic MockClient instantiation
23
-
24
- We can use MockAgent to instantiate a MockClient ready to be used to intercept specified requests. It will not do anything until registered as the agent to use and any mock request are registered.
25
-
26
- ```js
27
- import { MockAgent } from 'undici'
28
-
29
- // Connections must be set to 1 to return a MockClient instance
30
- const mockAgent = new MockAgent({ connections: 1 })
31
-
32
- const mockClient = mockAgent.get('http://localhost:3000')
33
- ```
34
-
35
- ## Instance Methods
36
-
37
- ### `MockClient.intercept(options)`
38
-
39
- Implements: [`MockPool.intercept(options)`](/docs/docs/api/MockPool.md#mockpoolinterceptoptions)
40
-
41
- ### `MockClient.cleanMocks()`
42
-
43
- Implements: [`MockPool.cleanMocks()`](/docs/docs/api/MockPool.md#mockpoolcleanmocks)
44
-
45
- ### `MockClient.close()`
46
-
47
- Implements: [`MockPool.close()`](/docs/docs/api/MockPool.md#mockpoolclose)
48
-
49
- ### `MockClient.dispatch(options, handlers)`
50
-
51
- Implements [`Dispatcher.dispatch(options, handlers)`](/docs/docs/api/Dispatcher.md#dispatcherdispatchoptions-handler).
52
-
53
- ### `MockClient.request(options[, callback])`
54
-
55
- See [`Dispatcher.request(options [, callback])`](/docs/docs/api/Dispatcher.md#dispatcherrequestoptions-callback).
56
-
57
- #### Example - MockClient request
58
-
59
- ```js
60
- import { MockAgent } from 'undici'
61
-
62
- const mockAgent = new MockAgent({ connections: 1 })
63
-
64
- const mockClient = mockAgent.get('http://localhost:3000')
65
- mockClient.intercept({ path: '/foo' }).reply(200, 'foo')
66
-
67
- const {
68
- statusCode,
69
- body
70
- } = await mockClient.request({
71
- origin: 'http://localhost:3000',
72
- path: '/foo',
73
- method: 'GET'
74
- })
75
-
76
- console.log('response received', statusCode) // response received 200
77
-
78
- for await (const data of body) {
79
- console.log('data', data.toString('utf8')) // data foo
80
- }
81
- ```
@@ -1,12 +0,0 @@
1
- # MockErrors
2
-
3
- Undici exposes a variety of mock error objects that you can use to enhance your mock error handling.
4
- You can find all the mock error objects inside the `mockErrors` key.
5
-
6
- ```js
7
- import { mockErrors } from 'undici'
8
- ```
9
-
10
- | Mock Error | Mock Error Codes | Description |
11
- | --------------------- | ------------------------------- | ---------------------------------------------------------- |
12
- | `MockNotMatchedError` | `UND_MOCK_ERR_MOCK_NOT_MATCHED` | The request does not match any registered mock dispatches. |