@stainlessdev/xray 0.5.1

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 (390) hide show
  1. package/CHANGELOG.md +109 -0
  2. package/LICENSE +201 -0
  3. package/README.md +401 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +181 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +181 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +477 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +473 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/pagination.d.mts +57 -0
  37. package/core/pagination.d.mts.map +1 -0
  38. package/core/pagination.d.ts +57 -0
  39. package/core/pagination.d.ts.map +1 -0
  40. package/core/pagination.js +108 -0
  41. package/core/pagination.js.map +1 -0
  42. package/core/pagination.mjs +102 -0
  43. package/core/pagination.mjs.map +1 -0
  44. package/core/resource.d.mts +6 -0
  45. package/core/resource.d.mts.map +1 -0
  46. package/core/resource.d.ts +6 -0
  47. package/core/resource.d.ts.map +1 -0
  48. package/core/resource.js +11 -0
  49. package/core/resource.js.map +1 -0
  50. package/core/resource.mjs +7 -0
  51. package/core/resource.mjs.map +1 -0
  52. package/core/uploads.d.mts +3 -0
  53. package/core/uploads.d.mts.map +1 -0
  54. package/core/uploads.d.ts +3 -0
  55. package/core/uploads.d.ts.map +1 -0
  56. package/core/uploads.js +6 -0
  57. package/core/uploads.js.map +1 -0
  58. package/core/uploads.mjs +2 -0
  59. package/core/uploads.mjs.map +1 -0
  60. package/error.d.mts +2 -0
  61. package/error.d.mts.map +1 -0
  62. package/error.d.ts +2 -0
  63. package/error.d.ts.map +1 -0
  64. package/error.js +6 -0
  65. package/error.js.map +1 -0
  66. package/error.mjs +2 -0
  67. package/error.mjs.map +1 -0
  68. package/index.d.mts +7 -0
  69. package/index.d.mts.map +1 -0
  70. package/index.d.ts +7 -0
  71. package/index.d.ts.map +1 -0
  72. package/index.js +32 -0
  73. package/index.js.map +1 -0
  74. package/index.mjs +8 -0
  75. package/index.mjs.map +1 -0
  76. package/internal/builtin-types.d.mts +73 -0
  77. package/internal/builtin-types.d.mts.map +1 -0
  78. package/internal/builtin-types.d.ts +73 -0
  79. package/internal/builtin-types.d.ts.map +1 -0
  80. package/internal/builtin-types.js +4 -0
  81. package/internal/builtin-types.js.map +1 -0
  82. package/internal/builtin-types.mjs +3 -0
  83. package/internal/builtin-types.mjs.map +1 -0
  84. package/internal/detect-platform.d.mts +15 -0
  85. package/internal/detect-platform.d.mts.map +1 -0
  86. package/internal/detect-platform.d.ts +15 -0
  87. package/internal/detect-platform.d.ts.map +1 -0
  88. package/internal/detect-platform.js +162 -0
  89. package/internal/detect-platform.js.map +1 -0
  90. package/internal/detect-platform.mjs +157 -0
  91. package/internal/detect-platform.mjs.map +1 -0
  92. package/internal/errors.d.mts +3 -0
  93. package/internal/errors.d.mts.map +1 -0
  94. package/internal/errors.d.ts +3 -0
  95. package/internal/errors.d.ts.map +1 -0
  96. package/internal/errors.js +41 -0
  97. package/internal/errors.js.map +1 -0
  98. package/internal/errors.mjs +36 -0
  99. package/internal/errors.mjs.map +1 -0
  100. package/internal/headers.d.mts +20 -0
  101. package/internal/headers.d.mts.map +1 -0
  102. package/internal/headers.d.ts +20 -0
  103. package/internal/headers.d.ts.map +1 -0
  104. package/internal/headers.js +79 -0
  105. package/internal/headers.js.map +1 -0
  106. package/internal/headers.mjs +74 -0
  107. package/internal/headers.mjs.map +1 -0
  108. package/internal/parse.d.mts +12 -0
  109. package/internal/parse.d.mts.map +1 -0
  110. package/internal/parse.d.ts +12 -0
  111. package/internal/parse.d.ts.map +1 -0
  112. package/internal/parse.js +40 -0
  113. package/internal/parse.js.map +1 -0
  114. package/internal/parse.mjs +37 -0
  115. package/internal/parse.mjs.map +1 -0
  116. package/internal/qs/formats.d.mts +7 -0
  117. package/internal/qs/formats.d.mts.map +1 -0
  118. package/internal/qs/formats.d.ts +7 -0
  119. package/internal/qs/formats.d.ts.map +1 -0
  120. package/internal/qs/formats.js +13 -0
  121. package/internal/qs/formats.js.map +1 -0
  122. package/internal/qs/formats.mjs +9 -0
  123. package/internal/qs/formats.mjs.map +1 -0
  124. package/internal/qs/index.d.mts +10 -0
  125. package/internal/qs/index.d.mts.map +1 -0
  126. package/internal/qs/index.d.ts +10 -0
  127. package/internal/qs/index.d.ts.map +1 -0
  128. package/internal/qs/index.js +14 -0
  129. package/internal/qs/index.js.map +1 -0
  130. package/internal/qs/index.mjs +10 -0
  131. package/internal/qs/index.mjs.map +1 -0
  132. package/internal/qs/stringify.d.mts +3 -0
  133. package/internal/qs/stringify.d.mts.map +1 -0
  134. package/internal/qs/stringify.d.ts +3 -0
  135. package/internal/qs/stringify.d.ts.map +1 -0
  136. package/internal/qs/stringify.js +277 -0
  137. package/internal/qs/stringify.js.map +1 -0
  138. package/internal/qs/stringify.mjs +274 -0
  139. package/internal/qs/stringify.mjs.map +1 -0
  140. package/internal/qs/types.d.mts +57 -0
  141. package/internal/qs/types.d.mts.map +1 -0
  142. package/internal/qs/types.d.ts +57 -0
  143. package/internal/qs/types.d.ts.map +1 -0
  144. package/internal/qs/types.js +3 -0
  145. package/internal/qs/types.js.map +1 -0
  146. package/internal/qs/types.mjs +2 -0
  147. package/internal/qs/types.mjs.map +1 -0
  148. package/internal/qs/utils.d.mts +15 -0
  149. package/internal/qs/utils.d.mts.map +1 -0
  150. package/internal/qs/utils.d.ts +15 -0
  151. package/internal/qs/utils.d.ts.map +1 -0
  152. package/internal/qs/utils.js +230 -0
  153. package/internal/qs/utils.js.map +1 -0
  154. package/internal/qs/utils.mjs +217 -0
  155. package/internal/qs/utils.mjs.map +1 -0
  156. package/internal/request-options.d.mts +75 -0
  157. package/internal/request-options.d.mts.map +1 -0
  158. package/internal/request-options.d.ts +75 -0
  159. package/internal/request-options.d.ts.map +1 -0
  160. package/internal/request-options.js +14 -0
  161. package/internal/request-options.js.map +1 -0
  162. package/internal/request-options.mjs +10 -0
  163. package/internal/request-options.mjs.map +1 -0
  164. package/internal/shim-types.d.mts +17 -0
  165. package/internal/shim-types.d.mts.map +1 -0
  166. package/internal/shim-types.d.ts +17 -0
  167. package/internal/shim-types.d.ts.map +1 -0
  168. package/internal/shim-types.js +4 -0
  169. package/internal/shim-types.js.map +1 -0
  170. package/internal/shim-types.mjs +3 -0
  171. package/internal/shim-types.mjs.map +1 -0
  172. package/internal/shims.d.mts +20 -0
  173. package/internal/shims.d.mts.map +1 -0
  174. package/internal/shims.d.ts +20 -0
  175. package/internal/shims.d.ts.map +1 -0
  176. package/internal/shims.js +92 -0
  177. package/internal/shims.js.map +1 -0
  178. package/internal/shims.mjs +85 -0
  179. package/internal/shims.mjs.map +1 -0
  180. package/internal/to-file.d.mts +45 -0
  181. package/internal/to-file.d.mts.map +1 -0
  182. package/internal/to-file.d.ts +45 -0
  183. package/internal/to-file.d.ts.map +1 -0
  184. package/internal/to-file.js +91 -0
  185. package/internal/to-file.js.map +1 -0
  186. package/internal/to-file.mjs +88 -0
  187. package/internal/to-file.mjs.map +1 -0
  188. package/internal/tslib.js +81 -0
  189. package/internal/tslib.mjs +17 -0
  190. package/internal/types.d.mts +69 -0
  191. package/internal/types.d.mts.map +1 -0
  192. package/internal/types.d.ts +69 -0
  193. package/internal/types.d.ts.map +1 -0
  194. package/internal/types.js +4 -0
  195. package/internal/types.js.map +1 -0
  196. package/internal/types.mjs +3 -0
  197. package/internal/types.mjs.map +1 -0
  198. package/internal/uploads.d.mts +42 -0
  199. package/internal/uploads.d.mts.map +1 -0
  200. package/internal/uploads.d.ts +42 -0
  201. package/internal/uploads.d.ts.map +1 -0
  202. package/internal/uploads.js +141 -0
  203. package/internal/uploads.js.map +1 -0
  204. package/internal/uploads.mjs +131 -0
  205. package/internal/uploads.mjs.map +1 -0
  206. package/internal/utils/base64.d.mts +3 -0
  207. package/internal/utils/base64.d.mts.map +1 -0
  208. package/internal/utils/base64.d.ts +3 -0
  209. package/internal/utils/base64.d.ts.map +1 -0
  210. package/internal/utils/base64.js +38 -0
  211. package/internal/utils/base64.js.map +1 -0
  212. package/internal/utils/base64.mjs +33 -0
  213. package/internal/utils/base64.mjs.map +1 -0
  214. package/internal/utils/bytes.d.mts +4 -0
  215. package/internal/utils/bytes.d.mts.map +1 -0
  216. package/internal/utils/bytes.d.ts +4 -0
  217. package/internal/utils/bytes.d.ts.map +1 -0
  218. package/internal/utils/bytes.js +31 -0
  219. package/internal/utils/bytes.js.map +1 -0
  220. package/internal/utils/bytes.mjs +26 -0
  221. package/internal/utils/bytes.mjs.map +1 -0
  222. package/internal/utils/env.d.mts +9 -0
  223. package/internal/utils/env.d.mts.map +1 -0
  224. package/internal/utils/env.d.ts +9 -0
  225. package/internal/utils/env.d.ts.map +1 -0
  226. package/internal/utils/env.js +22 -0
  227. package/internal/utils/env.js.map +1 -0
  228. package/internal/utils/env.mjs +18 -0
  229. package/internal/utils/env.mjs.map +1 -0
  230. package/internal/utils/log.d.mts +37 -0
  231. package/internal/utils/log.d.mts.map +1 -0
  232. package/internal/utils/log.d.ts +37 -0
  233. package/internal/utils/log.d.ts.map +1 -0
  234. package/internal/utils/log.js +85 -0
  235. package/internal/utils/log.js.map +1 -0
  236. package/internal/utils/log.mjs +79 -0
  237. package/internal/utils/log.mjs.map +1 -0
  238. package/internal/utils/path.d.mts +15 -0
  239. package/internal/utils/path.d.mts.map +1 -0
  240. package/internal/utils/path.d.ts +15 -0
  241. package/internal/utils/path.d.ts.map +1 -0
  242. package/internal/utils/path.js +79 -0
  243. package/internal/utils/path.js.map +1 -0
  244. package/internal/utils/path.mjs +74 -0
  245. package/internal/utils/path.mjs.map +1 -0
  246. package/internal/utils/query.d.mts +2 -0
  247. package/internal/utils/query.d.mts.map +1 -0
  248. package/internal/utils/query.d.ts +2 -0
  249. package/internal/utils/query.d.ts.map +1 -0
  250. package/internal/utils/query.js +10 -0
  251. package/internal/utils/query.js.map +1 -0
  252. package/internal/utils/query.mjs +6 -0
  253. package/internal/utils/query.mjs.map +1 -0
  254. package/internal/utils/sleep.d.mts +2 -0
  255. package/internal/utils/sleep.d.mts.map +1 -0
  256. package/internal/utils/sleep.d.ts +2 -0
  257. package/internal/utils/sleep.d.ts.map +1 -0
  258. package/internal/utils/sleep.js +7 -0
  259. package/internal/utils/sleep.js.map +1 -0
  260. package/internal/utils/sleep.mjs +3 -0
  261. package/internal/utils/sleep.mjs.map +1 -0
  262. package/internal/utils/uuid.d.mts +5 -0
  263. package/internal/utils/uuid.d.mts.map +1 -0
  264. package/internal/utils/uuid.d.ts +5 -0
  265. package/internal/utils/uuid.d.ts.map +1 -0
  266. package/internal/utils/uuid.js +19 -0
  267. package/internal/utils/uuid.js.map +1 -0
  268. package/internal/utils/uuid.mjs +15 -0
  269. package/internal/utils/uuid.mjs.map +1 -0
  270. package/internal/utils/values.d.mts +18 -0
  271. package/internal/utils/values.d.mts.map +1 -0
  272. package/internal/utils/values.d.ts +18 -0
  273. package/internal/utils/values.d.ts.map +1 -0
  274. package/internal/utils/values.js +112 -0
  275. package/internal/utils/values.js.map +1 -0
  276. package/internal/utils/values.mjs +94 -0
  277. package/internal/utils/values.mjs.map +1 -0
  278. package/internal/utils.d.mts +8 -0
  279. package/internal/utils.d.mts.map +1 -0
  280. package/internal/utils.d.ts +8 -0
  281. package/internal/utils.d.ts.map +1 -0
  282. package/internal/utils.js +12 -0
  283. package/internal/utils.js.map +1 -0
  284. package/internal/utils.mjs +9 -0
  285. package/internal/utils.mjs.map +1 -0
  286. package/package.json +147 -0
  287. package/pagination.d.mts +2 -0
  288. package/pagination.d.mts.map +1 -0
  289. package/pagination.d.ts +2 -0
  290. package/pagination.d.ts.map +1 -0
  291. package/pagination.js +6 -0
  292. package/pagination.js.map +1 -0
  293. package/pagination.mjs +2 -0
  294. package/pagination.mjs.map +1 -0
  295. package/resource.d.mts +2 -0
  296. package/resource.d.mts.map +1 -0
  297. package/resource.d.ts +2 -0
  298. package/resource.d.ts.map +1 -0
  299. package/resource.js +6 -0
  300. package/resource.js.map +1 -0
  301. package/resource.mjs +2 -0
  302. package/resource.mjs.map +1 -0
  303. package/resources/index.d.mts +2 -0
  304. package/resources/index.d.mts.map +1 -0
  305. package/resources/index.d.ts +2 -0
  306. package/resources/index.d.ts.map +1 -0
  307. package/resources/index.js +7 -0
  308. package/resources/index.js.map +1 -0
  309. package/resources/index.mjs +3 -0
  310. package/resources/index.mjs.map +1 -0
  311. package/resources/request-logs.d.mts +324 -0
  312. package/resources/request-logs.d.mts.map +1 -0
  313. package/resources/request-logs.d.ts +324 -0
  314. package/resources/request-logs.d.ts.map +1 -0
  315. package/resources/request-logs.js +62 -0
  316. package/resources/request-logs.js.map +1 -0
  317. package/resources/request-logs.mjs +58 -0
  318. package/resources/request-logs.mjs.map +1 -0
  319. package/resources.d.mts +2 -0
  320. package/resources.d.mts.map +1 -0
  321. package/resources.d.ts +2 -0
  322. package/resources.d.ts.map +1 -0
  323. package/resources.js +5 -0
  324. package/resources.js.map +1 -0
  325. package/resources.mjs +2 -0
  326. package/resources.mjs.map +1 -0
  327. package/src/api-promise.ts +2 -0
  328. package/src/client.ts +768 -0
  329. package/src/core/README.md +3 -0
  330. package/src/core/api-promise.ts +92 -0
  331. package/src/core/error.ts +130 -0
  332. package/src/core/pagination.ts +169 -0
  333. package/src/core/resource.ts +11 -0
  334. package/src/core/uploads.ts +2 -0
  335. package/src/error.ts +2 -0
  336. package/src/index.ts +23 -0
  337. package/src/internal/README.md +3 -0
  338. package/src/internal/builtin-types.ts +93 -0
  339. package/src/internal/detect-platform.ts +196 -0
  340. package/src/internal/errors.ts +33 -0
  341. package/src/internal/headers.ts +97 -0
  342. package/src/internal/parse.ts +56 -0
  343. package/src/internal/qs/LICENSE.md +13 -0
  344. package/src/internal/qs/README.md +3 -0
  345. package/src/internal/qs/formats.ts +10 -0
  346. package/src/internal/qs/index.ts +13 -0
  347. package/src/internal/qs/stringify.ts +385 -0
  348. package/src/internal/qs/types.ts +71 -0
  349. package/src/internal/qs/utils.ts +265 -0
  350. package/src/internal/request-options.ts +91 -0
  351. package/src/internal/shim-types.ts +26 -0
  352. package/src/internal/shims.ts +107 -0
  353. package/src/internal/to-file.ts +154 -0
  354. package/src/internal/types.ts +95 -0
  355. package/src/internal/uploads.ts +187 -0
  356. package/src/internal/utils/base64.ts +40 -0
  357. package/src/internal/utils/bytes.ts +32 -0
  358. package/src/internal/utils/env.ts +18 -0
  359. package/src/internal/utils/log.ts +126 -0
  360. package/src/internal/utils/path.ts +88 -0
  361. package/src/internal/utils/query.ts +7 -0
  362. package/src/internal/utils/sleep.ts +3 -0
  363. package/src/internal/utils/uuid.ts +17 -0
  364. package/src/internal/utils/values.ts +105 -0
  365. package/src/internal/utils.ts +9 -0
  366. package/src/lib/.keep +4 -0
  367. package/src/pagination.ts +2 -0
  368. package/src/resource.ts +2 -0
  369. package/src/resources/index.ts +10 -0
  370. package/src/resources/request-logs.ts +405 -0
  371. package/src/resources.ts +1 -0
  372. package/src/tsconfig.json +11 -0
  373. package/src/uploads.ts +2 -0
  374. package/src/version.ts +1 -0
  375. package/uploads.d.mts +2 -0
  376. package/uploads.d.mts.map +1 -0
  377. package/uploads.d.ts +2 -0
  378. package/uploads.d.ts.map +1 -0
  379. package/uploads.js +6 -0
  380. package/uploads.js.map +1 -0
  381. package/uploads.mjs +2 -0
  382. package/uploads.mjs.map +1 -0
  383. package/version.d.mts +2 -0
  384. package/version.d.mts.map +1 -0
  385. package/version.d.ts +2 -0
  386. package/version.d.ts.map +1 -0
  387. package/version.js +5 -0
  388. package/version.js.map +1 -0
  389. package/version.mjs +2 -0
  390. package/version.mjs.map +1 -0
package/client.d.ts ADDED
@@ -0,0 +1,181 @@
1
+ import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
2
+ import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
3
+ export type { Logger, LogLevel } from "./internal/utils/log.js";
4
+ import * as Opts from "./internal/request-options.js";
5
+ import * as Errors from "./core/error.js";
6
+ import * as Pagination from "./core/pagination.js";
7
+ import { type CursorIDPageParams, CursorIDPageResponse } from "./core/pagination.js";
8
+ import * as Uploads from "./core/uploads.js";
9
+ import * as API from "./resources/index.js";
10
+ import { APIPromise } from "./core/api-promise.js";
11
+ import { RequestLogListParams, RequestLogListResponse, RequestLogListResponsesCursorIDPage, RequestLogRetrieveParams, RequestLogRetrieveResponse, RequestLogs } from "./resources/request-logs.js";
12
+ import { type Fetch } from "./internal/builtin-types.js";
13
+ import { HeadersLike, NullableHeaders } from "./internal/headers.js";
14
+ import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
15
+ import { type LogLevel, type Logger } from "./internal/utils/log.js";
16
+ export interface ClientOptions {
17
+ apiKey?: string | null | undefined;
18
+ /**
19
+ * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
20
+ *
21
+ * Defaults to process.env['STAINLESS_XRAY_BASE_URL'].
22
+ */
23
+ baseURL?: string | null | undefined;
24
+ /**
25
+ * The maximum amount of time (in milliseconds) that the client should wait for a response
26
+ * from the server before timing out a single request.
27
+ *
28
+ * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
29
+ * much longer than this timeout before the promise succeeds or fails.
30
+ *
31
+ * @unit milliseconds
32
+ */
33
+ timeout?: number | undefined;
34
+ /**
35
+ * Additional `RequestInit` options to be passed to `fetch` calls.
36
+ * Properties will be overridden by per-request `fetchOptions`.
37
+ */
38
+ fetchOptions?: MergedRequestInit | undefined;
39
+ /**
40
+ * Specify a custom `fetch` function implementation.
41
+ *
42
+ * If not provided, we expect that `fetch` is defined globally.
43
+ */
44
+ fetch?: Fetch | undefined;
45
+ /**
46
+ * The maximum number of times that the client will retry a request in case of a
47
+ * temporary failure, like a network error or a 5XX error from the server.
48
+ *
49
+ * @default 2
50
+ */
51
+ maxRetries?: number | undefined;
52
+ /**
53
+ * Default headers to include with every request to the API.
54
+ *
55
+ * These can be removed in individual requests by explicitly setting the
56
+ * header to `null` in request options.
57
+ */
58
+ defaultHeaders?: HeadersLike | undefined;
59
+ /**
60
+ * Default query parameters to include with every request to the API.
61
+ *
62
+ * These can be removed in individual requests by explicitly setting the
63
+ * param to `undefined` in request options.
64
+ */
65
+ defaultQuery?: Record<string, string | undefined> | undefined;
66
+ /**
67
+ * Set the log level.
68
+ *
69
+ * Defaults to process.env['STAINLESS_XRAY_LOG'] or 'warn' if it isn't set.
70
+ */
71
+ logLevel?: LogLevel | undefined;
72
+ /**
73
+ * Set the logger.
74
+ *
75
+ * Defaults to globalThis.console.
76
+ */
77
+ logger?: Logger | undefined;
78
+ }
79
+ /**
80
+ * API Client for interfacing with the X-ray API.
81
+ */
82
+ export declare class Xray {
83
+ #private;
84
+ apiKey: string | null;
85
+ baseURL: string;
86
+ maxRetries: number;
87
+ timeout: number;
88
+ logger: Logger;
89
+ logLevel: LogLevel | undefined;
90
+ fetchOptions: MergedRequestInit | undefined;
91
+ private fetch;
92
+ protected idempotencyHeader?: string;
93
+ private _options;
94
+ /**
95
+ * API Client for interfacing with the X-ray API.
96
+ *
97
+ * @param {string | null | undefined} [opts.apiKey]
98
+ * @param {string} [opts.baseURL=process.env['STAINLESS_XRAY_BASE_URL'] ?? https://xray-staging.stainless.dev] - Override the default base URL for the API.
99
+ * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
100
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
101
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
102
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
103
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
104
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
105
+ */
106
+ constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
107
+ /**
108
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
109
+ */
110
+ withOptions(options: Partial<ClientOptions>): this;
111
+ protected defaultQuery(): Record<string, string | undefined> | undefined;
112
+ protected validateHeaders({ values, nulls }: NullableHeaders): void;
113
+ protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
114
+ protected stringifyQuery(query: object | Record<string, unknown>): string;
115
+ private getUserAgent;
116
+ protected defaultIdempotencyKey(): string;
117
+ protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
118
+ buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
119
+ /**
120
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
121
+ */
122
+ protected prepareOptions(options: FinalRequestOptions): Promise<void>;
123
+ /**
124
+ * Used as a callback for mutating the given `RequestInit` object.
125
+ *
126
+ * This is useful for cases where you want to add certain headers based off of
127
+ * the request properties, e.g. `method` or `url`.
128
+ */
129
+ protected prepareRequest(request: RequestInit, { url, options }: {
130
+ url: string;
131
+ options: FinalRequestOptions;
132
+ }): Promise<void>;
133
+ get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
134
+ post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
135
+ patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
136
+ put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
137
+ delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
138
+ private methodRequest;
139
+ request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
140
+ private makeRequest;
141
+ getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(path: string, Page: new (...args: any[]) => PageClass, opts?: PromiseOrValue<RequestOptions>): Pagination.PagePromise<PageClass, Item>;
142
+ requestAPIList<Item = unknown, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass, options: PromiseOrValue<FinalRequestOptions>): Pagination.PagePromise<PageClass, Item>;
143
+ fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
144
+ private shouldRetry;
145
+ private retryRequest;
146
+ private calculateDefaultRetryTimeoutMillis;
147
+ buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
148
+ retryCount?: number;
149
+ }): Promise<{
150
+ req: FinalizedRequestInit;
151
+ url: string;
152
+ timeout: number;
153
+ }>;
154
+ private buildHeaders;
155
+ private _makeAbort;
156
+ private buildBody;
157
+ static Xray: typeof Xray;
158
+ static DEFAULT_TIMEOUT: number;
159
+ static XrayError: typeof Errors.XrayError;
160
+ static APIError: typeof Errors.APIError;
161
+ static APIConnectionError: typeof Errors.APIConnectionError;
162
+ static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
163
+ static APIUserAbortError: typeof Errors.APIUserAbortError;
164
+ static NotFoundError: typeof Errors.NotFoundError;
165
+ static ConflictError: typeof Errors.ConflictError;
166
+ static RateLimitError: typeof Errors.RateLimitError;
167
+ static BadRequestError: typeof Errors.BadRequestError;
168
+ static AuthenticationError: typeof Errors.AuthenticationError;
169
+ static InternalServerError: typeof Errors.InternalServerError;
170
+ static PermissionDeniedError: typeof Errors.PermissionDeniedError;
171
+ static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
172
+ static toFile: typeof Uploads.toFile;
173
+ requestLogs: API.RequestLogs;
174
+ }
175
+ export declare namespace Xray {
176
+ export type RequestOptions = Opts.RequestOptions;
177
+ export import CursorIDPage = Pagination.CursorIDPage;
178
+ export { type CursorIDPageParams as CursorIDPageParams, type CursorIDPageResponse as CursorIDPageResponse };
179
+ export { RequestLogs as RequestLogs, type RequestLogRetrieveResponse as RequestLogRetrieveResponse, type RequestLogListResponse as RequestLogListResponse, type RequestLogListResponsesCursorIDPage as RequestLogListResponsesCursorIDPage, type RequestLogRetrieveParams as RequestLogRetrieveParams, type RequestLogListParams as RequestLogListParams, };
180
+ }
181
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAGT,KAAK,MAAM;OACX,KAAK,UAAU;OACf,EAAgB,KAAK,kBAAkB,EAAE,oBAAoB,EAAE;OAC/D,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EACL,oBAAoB,EACpB,sBAAsB,EACtB,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,WAAW,EACZ;OACM,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,IAAI;;IACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EAAE,OAA4C,EAAE,MAAa,EAAE,GAAG,IAAI,EAAE,GAAE,aAAkB;IA2BxG;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;cAa5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAO5F,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAmBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA6JzB,UAAU,CAAC,IAAI,EAAE,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAC9F,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,EACvC,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GACpC,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAS1C,cAAc,CACZ,IAAI,GAAG,OAAO,EACd,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAE/E,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,SAAS,EACvF,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,GAC3C,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAKpC,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;YA+BN,WAAW;YAuBX,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAepC,YAAY,CAChB,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C,OAAO,CAAC;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;YAwBzD,YAAY;IAqC1B,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,SAAS;IA6CjB,MAAM,CAAC,IAAI,cAAQ;IACnB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,SAAS,0BAAoB;IACpC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,WAAW,EAAE,GAAG,CAAC,WAAW,CAA6B;CAC1D;AAID,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;IACrD,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;IAE5G,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
package/client.js ADDED
@@ -0,0 +1,477 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ var _Xray_instances, _a, _Xray_encoder, _Xray_baseURLOverridden;
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
+ exports.Xray = void 0;
6
+ const tslib_1 = require("./internal/tslib.js");
7
+ const uuid_1 = require("./internal/utils/uuid.js");
8
+ const values_1 = require("./internal/utils/values.js");
9
+ const sleep_1 = require("./internal/utils/sleep.js");
10
+ const errors_1 = require("./internal/errors.js");
11
+ const detect_platform_1 = require("./internal/detect-platform.js");
12
+ const Shims = tslib_1.__importStar(require("./internal/shims.js"));
13
+ const Opts = tslib_1.__importStar(require("./internal/request-options.js"));
14
+ const query_1 = require("./internal/utils/query.js");
15
+ const version_1 = require("./version.js");
16
+ const Errors = tslib_1.__importStar(require("./core/error.js"));
17
+ const Pagination = tslib_1.__importStar(require("./core/pagination.js"));
18
+ const Uploads = tslib_1.__importStar(require("./core/uploads.js"));
19
+ const API = tslib_1.__importStar(require("./resources/index.js"));
20
+ const api_promise_1 = require("./core/api-promise.js");
21
+ const request_logs_1 = require("./resources/request-logs.js");
22
+ const headers_1 = require("./internal/headers.js");
23
+ const env_1 = require("./internal/utils/env.js");
24
+ const log_1 = require("./internal/utils/log.js");
25
+ const values_2 = require("./internal/utils/values.js");
26
+ /**
27
+ * API Client for interfacing with the X-ray API.
28
+ */
29
+ class Xray {
30
+ /**
31
+ * API Client for interfacing with the X-ray API.
32
+ *
33
+ * @param {string | null | undefined} [opts.apiKey]
34
+ * @param {string} [opts.baseURL=process.env['STAINLESS_XRAY_BASE_URL'] ?? https://xray-staging.stainless.dev] - Override the default base URL for the API.
35
+ * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
36
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
37
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
38
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
39
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
40
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
41
+ */
42
+ constructor({ baseURL = (0, env_1.readEnv)('STAINLESS_XRAY_BASE_URL'), apiKey = null, ...opts } = {}) {
43
+ _Xray_instances.add(this);
44
+ _Xray_encoder.set(this, void 0);
45
+ this.requestLogs = new API.RequestLogs(this);
46
+ const options = {
47
+ apiKey,
48
+ ...opts,
49
+ baseURL: baseURL || `https://xray-staging.stainless.dev`,
50
+ };
51
+ this.baseURL = options.baseURL;
52
+ this.timeout = options.timeout ?? _a.DEFAULT_TIMEOUT /* 1 minute */;
53
+ this.logger = options.logger ?? console;
54
+ const defaultLogLevel = 'warn';
55
+ // Set default logLevel early so that we can log a warning in parseLogLevel.
56
+ this.logLevel = defaultLogLevel;
57
+ this.logLevel =
58
+ (0, log_1.parseLogLevel)(options.logLevel, 'ClientOptions.logLevel', this) ??
59
+ (0, log_1.parseLogLevel)((0, env_1.readEnv)('STAINLESS_XRAY_LOG'), "process.env['STAINLESS_XRAY_LOG']", this) ??
60
+ defaultLogLevel;
61
+ this.fetchOptions = options.fetchOptions;
62
+ this.maxRetries = options.maxRetries ?? 2;
63
+ this.fetch = options.fetch ?? Shims.getDefaultFetch();
64
+ tslib_1.__classPrivateFieldSet(this, _Xray_encoder, Opts.FallbackEncoder, "f");
65
+ this._options = options;
66
+ this.apiKey = apiKey;
67
+ }
68
+ /**
69
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
70
+ */
71
+ withOptions(options) {
72
+ const client = new this.constructor({
73
+ ...this._options,
74
+ baseURL: this.baseURL,
75
+ maxRetries: this.maxRetries,
76
+ timeout: this.timeout,
77
+ logger: this.logger,
78
+ logLevel: this.logLevel,
79
+ fetch: this.fetch,
80
+ fetchOptions: this.fetchOptions,
81
+ apiKey: this.apiKey,
82
+ ...options,
83
+ });
84
+ return client;
85
+ }
86
+ defaultQuery() {
87
+ return this._options.defaultQuery;
88
+ }
89
+ validateHeaders({ values, nulls }) {
90
+ if (this.apiKey && values.get('authorization')) {
91
+ return;
92
+ }
93
+ if (nulls.has('authorization')) {
94
+ return;
95
+ }
96
+ throw new Error('Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted');
97
+ }
98
+ async authHeaders(opts) {
99
+ if (this.apiKey == null) {
100
+ return undefined;
101
+ }
102
+ return (0, headers_1.buildHeaders)([{ Authorization: `Bearer ${this.apiKey}` }]);
103
+ }
104
+ stringifyQuery(query) {
105
+ return (0, query_1.stringifyQuery)(query);
106
+ }
107
+ getUserAgent() {
108
+ return `${this.constructor.name}/JS ${version_1.VERSION}`;
109
+ }
110
+ defaultIdempotencyKey() {
111
+ return `stainless-node-retry-${(0, uuid_1.uuid4)()}`;
112
+ }
113
+ makeStatusError(status, error, message, headers) {
114
+ return Errors.APIError.generate(status, error, message, headers);
115
+ }
116
+ buildURL(path, query, defaultBaseURL) {
117
+ const baseURL = (!tslib_1.__classPrivateFieldGet(this, _Xray_instances, "m", _Xray_baseURLOverridden).call(this) && defaultBaseURL) || this.baseURL;
118
+ const url = (0, values_1.isAbsoluteURL)(path) ?
119
+ new URL(path)
120
+ : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
121
+ const defaultQuery = this.defaultQuery();
122
+ if (!(0, values_2.isEmptyObj)(defaultQuery)) {
123
+ query = { ...defaultQuery, ...query };
124
+ }
125
+ if (typeof query === 'object' && query && !Array.isArray(query)) {
126
+ url.search = this.stringifyQuery(query);
127
+ }
128
+ return url.toString();
129
+ }
130
+ /**
131
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
132
+ */
133
+ async prepareOptions(options) { }
134
+ /**
135
+ * Used as a callback for mutating the given `RequestInit` object.
136
+ *
137
+ * This is useful for cases where you want to add certain headers based off of
138
+ * the request properties, e.g. `method` or `url`.
139
+ */
140
+ async prepareRequest(request, { url, options }) { }
141
+ get(path, opts) {
142
+ return this.methodRequest('get', path, opts);
143
+ }
144
+ post(path, opts) {
145
+ return this.methodRequest('post', path, opts);
146
+ }
147
+ patch(path, opts) {
148
+ return this.methodRequest('patch', path, opts);
149
+ }
150
+ put(path, opts) {
151
+ return this.methodRequest('put', path, opts);
152
+ }
153
+ delete(path, opts) {
154
+ return this.methodRequest('delete', path, opts);
155
+ }
156
+ methodRequest(method, path, opts) {
157
+ return this.request(Promise.resolve(opts).then((opts) => {
158
+ return { method, path, ...opts };
159
+ }));
160
+ }
161
+ request(options, remainingRetries = null) {
162
+ return new api_promise_1.APIPromise(this, this.makeRequest(options, remainingRetries, undefined));
163
+ }
164
+ async makeRequest(optionsInput, retriesRemaining, retryOfRequestLogID) {
165
+ const options = await optionsInput;
166
+ const maxRetries = options.maxRetries ?? this.maxRetries;
167
+ if (retriesRemaining == null) {
168
+ retriesRemaining = maxRetries;
169
+ }
170
+ await this.prepareOptions(options);
171
+ const { req, url, timeout } = await this.buildRequest(options, {
172
+ retryCount: maxRetries - retriesRemaining,
173
+ });
174
+ await this.prepareRequest(req, { url, options });
175
+ /** Not an API request ID, just for correlating local log entries. */
176
+ const requestLogID = 'log_' + ((Math.random() * (1 << 24)) | 0).toString(16).padStart(6, '0');
177
+ const retryLogStr = retryOfRequestLogID === undefined ? '' : `, retryOf: ${retryOfRequestLogID}`;
178
+ const startTime = Date.now();
179
+ (0, log_1.loggerFor)(this).debug(`[${requestLogID}] sending request`, (0, log_1.formatRequestDetails)({
180
+ retryOfRequestLogID,
181
+ method: options.method,
182
+ url,
183
+ options,
184
+ headers: req.headers,
185
+ }));
186
+ if (options.signal?.aborted) {
187
+ throw new Errors.APIUserAbortError();
188
+ }
189
+ const controller = new AbortController();
190
+ const response = await this.fetchWithTimeout(url, req, timeout, controller).catch(errors_1.castToError);
191
+ const headersTime = Date.now();
192
+ if (response instanceof globalThis.Error) {
193
+ const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
194
+ if (options.signal?.aborted) {
195
+ throw new Errors.APIUserAbortError();
196
+ }
197
+ // detect native connection timeout errors
198
+ // deno throws "TypeError: error sending request for url (https://example/): client error (Connect): tcp connect error: Operation timed out (os error 60): Operation timed out (os error 60)"
199
+ // undici throws "TypeError: fetch failed" with cause "ConnectTimeoutError: Connect Timeout Error (attempted address: example:443, timeout: 1ms)"
200
+ // others do not provide enough information to distinguish timeouts from other connection errors
201
+ const isTimeout = (0, errors_1.isAbortError)(response) ||
202
+ /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : ''));
203
+ if (retriesRemaining) {
204
+ (0, log_1.loggerFor)(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`);
205
+ (0, log_1.loggerFor)(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`, (0, log_1.formatRequestDetails)({
206
+ retryOfRequestLogID,
207
+ url,
208
+ durationMs: headersTime - startTime,
209
+ message: response.message,
210
+ }));
211
+ return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID);
212
+ }
213
+ (0, log_1.loggerFor)(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`);
214
+ (0, log_1.loggerFor)(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`, (0, log_1.formatRequestDetails)({
215
+ retryOfRequestLogID,
216
+ url,
217
+ durationMs: headersTime - startTime,
218
+ message: response.message,
219
+ }));
220
+ if (isTimeout) {
221
+ throw new Errors.APIConnectionTimeoutError();
222
+ }
223
+ throw new Errors.APIConnectionError({ cause: response });
224
+ }
225
+ const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${response.ok ? 'succeeded' : 'failed'} with status ${response.status} in ${headersTime - startTime}ms`;
226
+ if (!response.ok) {
227
+ const shouldRetry = await this.shouldRetry(response);
228
+ if (retriesRemaining && shouldRetry) {
229
+ const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
230
+ // We don't need the body of this response.
231
+ await Shims.CancelReadableStream(response.body);
232
+ (0, log_1.loggerFor)(this).info(`${responseInfo} - ${retryMessage}`);
233
+ (0, log_1.loggerFor)(this).debug(`[${requestLogID}] response error (${retryMessage})`, (0, log_1.formatRequestDetails)({
234
+ retryOfRequestLogID,
235
+ url: response.url,
236
+ status: response.status,
237
+ headers: response.headers,
238
+ durationMs: headersTime - startTime,
239
+ }));
240
+ return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID, response.headers);
241
+ }
242
+ const retryMessage = shouldRetry ? `error; no more retries left` : `error; not retryable`;
243
+ (0, log_1.loggerFor)(this).info(`${responseInfo} - ${retryMessage}`);
244
+ const errText = await response.text().catch((err) => (0, errors_1.castToError)(err).message);
245
+ const errJSON = (0, values_1.safeJSON)(errText);
246
+ const errMessage = errJSON ? undefined : errText;
247
+ (0, log_1.loggerFor)(this).debug(`[${requestLogID}] response error (${retryMessage})`, (0, log_1.formatRequestDetails)({
248
+ retryOfRequestLogID,
249
+ url: response.url,
250
+ status: response.status,
251
+ headers: response.headers,
252
+ message: errMessage,
253
+ durationMs: Date.now() - startTime,
254
+ }));
255
+ const err = this.makeStatusError(response.status, errJSON, errMessage, response.headers);
256
+ throw err;
257
+ }
258
+ (0, log_1.loggerFor)(this).info(responseInfo);
259
+ (0, log_1.loggerFor)(this).debug(`[${requestLogID}] response start`, (0, log_1.formatRequestDetails)({
260
+ retryOfRequestLogID,
261
+ url: response.url,
262
+ status: response.status,
263
+ headers: response.headers,
264
+ durationMs: headersTime - startTime,
265
+ }));
266
+ return { response, options, controller, requestLogID, retryOfRequestLogID, startTime };
267
+ }
268
+ getAPIList(path, Page, opts) {
269
+ return this.requestAPIList(Page, opts && 'then' in opts ?
270
+ opts.then((opts) => ({ method: 'get', path, ...opts }))
271
+ : { method: 'get', path, ...opts });
272
+ }
273
+ requestAPIList(Page, options) {
274
+ const request = this.makeRequest(options, null, undefined);
275
+ return new Pagination.PagePromise(this, request, Page);
276
+ }
277
+ async fetchWithTimeout(url, init, ms, controller) {
278
+ const { signal, method, ...options } = init || {};
279
+ const abort = this._makeAbort(controller);
280
+ if (signal)
281
+ signal.addEventListener('abort', abort, { once: true });
282
+ const timeout = setTimeout(abort, ms);
283
+ const isReadableBody = (globalThis.ReadableStream && options.body instanceof globalThis.ReadableStream) ||
284
+ (typeof options.body === 'object' && options.body !== null && Symbol.asyncIterator in options.body);
285
+ const fetchOptions = {
286
+ signal: controller.signal,
287
+ ...(isReadableBody ? { duplex: 'half' } : {}),
288
+ method: 'GET',
289
+ ...options,
290
+ };
291
+ if (method) {
292
+ // Custom methods like 'patch' need to be uppercased
293
+ // See https://github.com/nodejs/undici/issues/2294
294
+ fetchOptions.method = method.toUpperCase();
295
+ }
296
+ try {
297
+ // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
298
+ return await this.fetch.call(undefined, url, fetchOptions);
299
+ }
300
+ finally {
301
+ clearTimeout(timeout);
302
+ }
303
+ }
304
+ async shouldRetry(response) {
305
+ // Note this is not a standard header.
306
+ const shouldRetryHeader = response.headers.get('x-should-retry');
307
+ // If the server explicitly says whether or not to retry, obey.
308
+ if (shouldRetryHeader === 'true')
309
+ return true;
310
+ if (shouldRetryHeader === 'false')
311
+ return false;
312
+ // Retry on request timeouts.
313
+ if (response.status === 408)
314
+ return true;
315
+ // Retry on lock timeouts.
316
+ if (response.status === 409)
317
+ return true;
318
+ // Retry on rate limits.
319
+ if (response.status === 429)
320
+ return true;
321
+ // Retry internal errors.
322
+ if (response.status >= 500)
323
+ return true;
324
+ return false;
325
+ }
326
+ async retryRequest(options, retriesRemaining, requestLogID, responseHeaders) {
327
+ let timeoutMillis;
328
+ // Note the `retry-after-ms` header may not be standard, but is a good idea and we'd like proactive support for it.
329
+ const retryAfterMillisHeader = responseHeaders?.get('retry-after-ms');
330
+ if (retryAfterMillisHeader) {
331
+ const timeoutMs = parseFloat(retryAfterMillisHeader);
332
+ if (!Number.isNaN(timeoutMs)) {
333
+ timeoutMillis = timeoutMs;
334
+ }
335
+ }
336
+ // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
337
+ const retryAfterHeader = responseHeaders?.get('retry-after');
338
+ if (retryAfterHeader && !timeoutMillis) {
339
+ const timeoutSeconds = parseFloat(retryAfterHeader);
340
+ if (!Number.isNaN(timeoutSeconds)) {
341
+ timeoutMillis = timeoutSeconds * 1000;
342
+ }
343
+ else {
344
+ timeoutMillis = Date.parse(retryAfterHeader) - Date.now();
345
+ }
346
+ }
347
+ // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
348
+ // just do what it says, but otherwise calculate a default
349
+ if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
350
+ const maxRetries = options.maxRetries ?? this.maxRetries;
351
+ timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
352
+ }
353
+ await (0, sleep_1.sleep)(timeoutMillis);
354
+ return this.makeRequest(options, retriesRemaining - 1, requestLogID);
355
+ }
356
+ calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries) {
357
+ const initialRetryDelay = 0.5;
358
+ const maxRetryDelay = 8.0;
359
+ const numRetries = maxRetries - retriesRemaining;
360
+ // Apply exponential backoff, but not more than the max.
361
+ const sleepSeconds = Math.min(initialRetryDelay * Math.pow(2, numRetries), maxRetryDelay);
362
+ // Apply some jitter, take up to at most 25 percent of the retry time.
363
+ const jitter = 1 - Math.random() * 0.25;
364
+ return sleepSeconds * jitter * 1000;
365
+ }
366
+ async buildRequest(inputOptions, { retryCount = 0 } = {}) {
367
+ const options = { ...inputOptions };
368
+ const { method, path, query, defaultBaseURL } = options;
369
+ const url = this.buildURL(path, query, defaultBaseURL);
370
+ if ('timeout' in options)
371
+ (0, values_1.validatePositiveInteger)('timeout', options.timeout);
372
+ options.timeout = options.timeout ?? this.timeout;
373
+ const { bodyHeaders, body } = this.buildBody({ options });
374
+ const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
375
+ const req = {
376
+ method,
377
+ headers: reqHeaders,
378
+ ...(options.signal && { signal: options.signal }),
379
+ ...(globalThis.ReadableStream &&
380
+ body instanceof globalThis.ReadableStream && { duplex: 'half' }),
381
+ ...(body && { body }),
382
+ ...(this.fetchOptions ?? {}),
383
+ ...(options.fetchOptions ?? {}),
384
+ };
385
+ return { req, url, timeout: options.timeout };
386
+ }
387
+ async buildHeaders({ options, method, bodyHeaders, retryCount, }) {
388
+ let idempotencyHeaders = {};
389
+ if (this.idempotencyHeader && method !== 'get') {
390
+ if (!options.idempotencyKey)
391
+ options.idempotencyKey = this.defaultIdempotencyKey();
392
+ idempotencyHeaders[this.idempotencyHeader] = options.idempotencyKey;
393
+ }
394
+ const headers = (0, headers_1.buildHeaders)([
395
+ idempotencyHeaders,
396
+ {
397
+ Accept: 'application/json',
398
+ 'User-Agent': this.getUserAgent(),
399
+ 'X-Stainless-Retry-Count': String(retryCount),
400
+ ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
401
+ ...(0, detect_platform_1.getPlatformHeaders)(),
402
+ },
403
+ await this.authHeaders(options),
404
+ this._options.defaultHeaders,
405
+ bodyHeaders,
406
+ options.headers,
407
+ ]);
408
+ this.validateHeaders(headers);
409
+ return headers.values;
410
+ }
411
+ _makeAbort(controller) {
412
+ // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
413
+ // would capture all request options, and cause a memory leak.
414
+ return () => controller.abort();
415
+ }
416
+ buildBody({ options: { body, headers: rawHeaders } }) {
417
+ if (!body) {
418
+ return { bodyHeaders: undefined, body: undefined };
419
+ }
420
+ const headers = (0, headers_1.buildHeaders)([rawHeaders]);
421
+ if (
422
+ // Pass raw type verbatim
423
+ ArrayBuffer.isView(body) ||
424
+ body instanceof ArrayBuffer ||
425
+ body instanceof DataView ||
426
+ (typeof body === 'string' &&
427
+ // Preserve legacy string encoding behavior for now
428
+ headers.values.has('content-type')) ||
429
+ // `Blob` is superset of `File`
430
+ (globalThis.Blob && body instanceof globalThis.Blob) ||
431
+ // `FormData` -> `multipart/form-data`
432
+ body instanceof FormData ||
433
+ // `URLSearchParams` -> `application/x-www-form-urlencoded`
434
+ body instanceof URLSearchParams ||
435
+ // Send chunked stream (each chunk has own `length`)
436
+ (globalThis.ReadableStream && body instanceof globalThis.ReadableStream)) {
437
+ return { bodyHeaders: undefined, body: body };
438
+ }
439
+ else if (typeof body === 'object' &&
440
+ (Symbol.asyncIterator in body ||
441
+ (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))) {
442
+ return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body) };
443
+ }
444
+ else if (typeof body === 'object' &&
445
+ headers.values.get('content-type') === 'application/x-www-form-urlencoded') {
446
+ return {
447
+ bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
448
+ body: this.stringifyQuery(body),
449
+ };
450
+ }
451
+ else {
452
+ return tslib_1.__classPrivateFieldGet(this, _Xray_encoder, "f").call(this, { body, headers });
453
+ }
454
+ }
455
+ }
456
+ exports.Xray = Xray;
457
+ _a = Xray, _Xray_encoder = new WeakMap(), _Xray_instances = new WeakSet(), _Xray_baseURLOverridden = function _Xray_baseURLOverridden() {
458
+ return this.baseURL !== 'https://xray-staging.stainless.dev';
459
+ };
460
+ Xray.Xray = _a;
461
+ Xray.DEFAULT_TIMEOUT = 60000; // 1 minute
462
+ Xray.XrayError = Errors.XrayError;
463
+ Xray.APIError = Errors.APIError;
464
+ Xray.APIConnectionError = Errors.APIConnectionError;
465
+ Xray.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
466
+ Xray.APIUserAbortError = Errors.APIUserAbortError;
467
+ Xray.NotFoundError = Errors.NotFoundError;
468
+ Xray.ConflictError = Errors.ConflictError;
469
+ Xray.RateLimitError = Errors.RateLimitError;
470
+ Xray.BadRequestError = Errors.BadRequestError;
471
+ Xray.AuthenticationError = Errors.AuthenticationError;
472
+ Xray.InternalServerError = Errors.InternalServerError;
473
+ Xray.PermissionDeniedError = Errors.PermissionDeniedError;
474
+ Xray.UnprocessableEntityError = Errors.UnprocessableEntityError;
475
+ Xray.toFile = Uploads.toFile;
476
+ Xray.RequestLogs = request_logs_1.RequestLogs;
477
+ //# sourceMappingURL=client.js.map