@valtown/sdk 2.1.0 → 3.1.0

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 (717) hide show
  1. package/CHANGELOG.md +50 -1232
  2. package/README.md +127 -80
  3. package/api-promise.d.mts +2 -0
  4. package/api-promise.d.mts.map +1 -0
  5. package/api-promise.d.ts +2 -0
  6. package/api-promise.d.ts.map +1 -0
  7. package/api-promise.js +6 -0
  8. package/api-promise.js.map +1 -0
  9. package/api-promise.mjs +2 -0
  10. package/api-promise.mjs.map +1 -0
  11. package/bin/cli +53 -0
  12. package/bin/migration-config.json +176 -0
  13. package/client.d.mts +248 -0
  14. package/client.d.mts.map +1 -0
  15. package/client.d.ts +248 -0
  16. package/client.d.ts.map +1 -0
  17. package/client.js +513 -0
  18. package/client.js.map +1 -0
  19. package/client.mjs +509 -0
  20. package/client.mjs.map +1 -0
  21. package/core/api-promise.d.mts +46 -0
  22. package/core/api-promise.d.mts.map +1 -0
  23. package/core/api-promise.d.ts +46 -0
  24. package/core/api-promise.d.ts.map +1 -0
  25. package/core/api-promise.js +74 -0
  26. package/core/api-promise.js.map +1 -0
  27. package/core/api-promise.mjs +70 -0
  28. package/core/api-promise.mjs.map +1 -0
  29. package/core/error.d.mts +46 -0
  30. package/core/error.d.mts.map +1 -0
  31. package/core/error.d.ts +46 -0
  32. package/core/error.d.ts.map +1 -0
  33. package/core/error.js +113 -0
  34. package/core/error.js.map +1 -0
  35. package/core/error.mjs +97 -0
  36. package/core/error.mjs.map +1 -0
  37. package/core/pagination.d.mts +79 -0
  38. package/core/pagination.d.mts.map +1 -0
  39. package/core/pagination.d.ts +79 -0
  40. package/core/pagination.d.ts.map +1 -0
  41. package/core/pagination.js +129 -0
  42. package/core/pagination.js.map +1 -0
  43. package/core/pagination.mjs +122 -0
  44. package/core/pagination.mjs.map +1 -0
  45. package/core/resource.d.mts +6 -0
  46. package/core/resource.d.mts.map +1 -0
  47. package/core/resource.d.ts +6 -0
  48. package/core/resource.d.ts.map +1 -0
  49. package/core/resource.js +11 -0
  50. package/core/resource.js.map +1 -0
  51. package/core/resource.mjs +7 -0
  52. package/core/resource.mjs.map +1 -0
  53. package/core/uploads.d.mts +3 -0
  54. package/core/uploads.d.mts.map +1 -0
  55. package/core/uploads.d.ts +3 -0
  56. package/core/uploads.d.ts.map +1 -0
  57. package/core/uploads.js +6 -0
  58. package/core/uploads.js.map +1 -0
  59. package/core/uploads.mjs +2 -0
  60. package/core/uploads.mjs.map +1 -0
  61. package/error.d.mts +2 -0
  62. package/error.d.mts.map +1 -0
  63. package/error.d.ts +1 -46
  64. package/error.d.ts.map +1 -1
  65. package/error.js +3 -110
  66. package/error.js.map +1 -1
  67. package/error.mjs +1 -96
  68. package/error.mjs.map +1 -1
  69. package/index.d.mts +7 -189
  70. package/index.d.mts.map +1 -0
  71. package/index.d.ts +6 -188
  72. package/index.d.ts.map +1 -1
  73. package/index.js +14 -177
  74. package/index.js.map +1 -1
  75. package/index.mjs +6 -150
  76. package/index.mjs.map +1 -1
  77. package/internal/builtin-types.d.mts +73 -0
  78. package/internal/builtin-types.d.mts.map +1 -0
  79. package/internal/builtin-types.d.ts +73 -0
  80. package/internal/builtin-types.d.ts.map +1 -0
  81. package/internal/builtin-types.js +4 -0
  82. package/internal/builtin-types.js.map +1 -0
  83. package/{resources/search.mjs → internal/builtin-types.mjs} +2 -2
  84. package/internal/builtin-types.mjs.map +1 -0
  85. package/internal/detect-platform.d.mts +15 -0
  86. package/internal/detect-platform.d.mts.map +1 -0
  87. package/internal/detect-platform.d.ts +15 -0
  88. package/internal/detect-platform.d.ts.map +1 -0
  89. package/internal/detect-platform.js +162 -0
  90. package/internal/detect-platform.js.map +1 -0
  91. package/internal/detect-platform.mjs +157 -0
  92. package/internal/detect-platform.mjs.map +1 -0
  93. package/internal/errors.d.mts +3 -0
  94. package/internal/errors.d.mts.map +1 -0
  95. package/internal/errors.d.ts +3 -0
  96. package/internal/errors.d.ts.map +1 -0
  97. package/internal/errors.js +41 -0
  98. package/internal/errors.js.map +1 -0
  99. package/internal/errors.mjs +36 -0
  100. package/internal/errors.mjs.map +1 -0
  101. package/internal/headers.d.mts +20 -0
  102. package/internal/headers.d.mts.map +1 -0
  103. package/internal/headers.d.ts +20 -0
  104. package/internal/headers.d.ts.map +1 -0
  105. package/internal/headers.js +79 -0
  106. package/internal/headers.js.map +1 -0
  107. package/internal/headers.mjs +74 -0
  108. package/internal/headers.mjs.map +1 -0
  109. package/internal/parse.d.mts +12 -0
  110. package/internal/parse.d.mts.map +1 -0
  111. package/internal/parse.d.ts +12 -0
  112. package/internal/parse.d.ts.map +1 -0
  113. package/internal/parse.js +35 -0
  114. package/internal/parse.js.map +1 -0
  115. package/internal/parse.mjs +32 -0
  116. package/internal/parse.mjs.map +1 -0
  117. package/internal/qs/formats.d.mts +7 -0
  118. package/internal/qs/formats.d.mts.map +1 -0
  119. package/internal/qs/formats.d.ts +1 -0
  120. package/internal/qs/formats.d.ts.map +1 -1
  121. package/internal/qs/formats.js +4 -2
  122. package/internal/qs/formats.js.map +1 -1
  123. package/internal/qs/formats.mjs +2 -1
  124. package/internal/qs/formats.mjs.map +1 -1
  125. package/internal/qs/index.d.mts +10 -0
  126. package/internal/qs/index.d.mts.map +1 -0
  127. package/internal/qs/index.d.ts.map +1 -1
  128. package/internal/qs/stringify.d.mts +3 -0
  129. package/internal/qs/stringify.d.mts.map +1 -0
  130. package/internal/qs/stringify.d.ts.map +1 -1
  131. package/internal/qs/stringify.js +16 -19
  132. package/internal/qs/stringify.js.map +1 -1
  133. package/internal/qs/stringify.mjs +17 -19
  134. package/internal/qs/stringify.mjs.map +1 -1
  135. package/internal/qs/types.d.mts +57 -0
  136. package/internal/qs/types.d.mts.map +1 -0
  137. package/internal/qs/utils.d.mts +15 -0
  138. package/internal/qs/utils.d.mts.map +1 -0
  139. package/internal/qs/utils.d.ts +1 -0
  140. package/internal/qs/utils.d.ts.map +1 -1
  141. package/internal/qs/utils.js +22 -21
  142. package/internal/qs/utils.js.map +1 -1
  143. package/internal/qs/utils.mjs +12 -12
  144. package/internal/qs/utils.mjs.map +1 -1
  145. package/internal/request-options.d.mts +75 -0
  146. package/internal/request-options.d.mts.map +1 -0
  147. package/internal/request-options.d.ts +75 -0
  148. package/internal/request-options.d.ts.map +1 -0
  149. package/internal/request-options.js +14 -0
  150. package/internal/request-options.js.map +1 -0
  151. package/internal/request-options.mjs +10 -0
  152. package/internal/request-options.mjs.map +1 -0
  153. package/internal/shim-types.d.mts +17 -0
  154. package/internal/shim-types.d.mts.map +1 -0
  155. package/internal/shim-types.d.ts +17 -0
  156. package/internal/shim-types.d.ts.map +1 -0
  157. package/internal/shim-types.js +4 -0
  158. package/internal/shim-types.js.map +1 -0
  159. package/{src/resources/search/index.ts → internal/shim-types.mjs} +2 -3
  160. package/internal/shim-types.mjs.map +1 -0
  161. package/internal/shims.d.mts +20 -0
  162. package/internal/shims.d.mts.map +1 -0
  163. package/internal/shims.d.ts +20 -0
  164. package/internal/shims.d.ts.map +1 -0
  165. package/internal/shims.js +92 -0
  166. package/internal/shims.js.map +1 -0
  167. package/internal/shims.mjs +85 -0
  168. package/internal/shims.mjs.map +1 -0
  169. package/internal/to-file.d.mts +45 -0
  170. package/internal/to-file.d.mts.map +1 -0
  171. package/internal/to-file.d.ts +45 -0
  172. package/internal/to-file.d.ts.map +1 -0
  173. package/internal/to-file.js +91 -0
  174. package/internal/to-file.js.map +1 -0
  175. package/internal/to-file.mjs +88 -0
  176. package/internal/to-file.mjs.map +1 -0
  177. package/internal/tslib.js +81 -0
  178. package/internal/tslib.mjs +17 -0
  179. package/internal/types.d.mts +69 -0
  180. package/internal/types.d.mts.map +1 -0
  181. package/internal/types.d.ts +69 -0
  182. package/internal/types.d.ts.map +1 -0
  183. package/internal/types.js +4 -0
  184. package/internal/types.js.map +1 -0
  185. package/{src/resources/search.ts → internal/types.mjs} +2 -2
  186. package/internal/types.mjs.map +1 -0
  187. package/internal/uploads.d.mts +42 -0
  188. package/internal/uploads.d.mts.map +1 -0
  189. package/internal/uploads.d.ts +42 -0
  190. package/internal/uploads.d.ts.map +1 -0
  191. package/internal/uploads.js +141 -0
  192. package/internal/uploads.js.map +1 -0
  193. package/internal/uploads.mjs +131 -0
  194. package/internal/uploads.mjs.map +1 -0
  195. package/internal/utils/base64.d.mts +3 -0
  196. package/internal/utils/base64.d.mts.map +1 -0
  197. package/internal/utils/base64.d.ts +3 -0
  198. package/internal/utils/base64.d.ts.map +1 -0
  199. package/internal/utils/base64.js +38 -0
  200. package/internal/utils/base64.js.map +1 -0
  201. package/internal/utils/base64.mjs +33 -0
  202. package/internal/utils/base64.mjs.map +1 -0
  203. package/internal/utils/bytes.d.mts +4 -0
  204. package/internal/utils/bytes.d.mts.map +1 -0
  205. package/internal/utils/bytes.d.ts +4 -0
  206. package/internal/utils/bytes.d.ts.map +1 -0
  207. package/internal/utils/bytes.js +31 -0
  208. package/internal/utils/bytes.js.map +1 -0
  209. package/internal/utils/bytes.mjs +26 -0
  210. package/internal/utils/bytes.mjs.map +1 -0
  211. package/internal/utils/env.d.mts +9 -0
  212. package/internal/utils/env.d.mts.map +1 -0
  213. package/internal/utils/env.d.ts +9 -0
  214. package/internal/utils/env.d.ts.map +1 -0
  215. package/internal/utils/env.js +22 -0
  216. package/internal/utils/env.js.map +1 -0
  217. package/internal/utils/env.mjs +18 -0
  218. package/internal/utils/env.mjs.map +1 -0
  219. package/internal/utils/log.d.mts +37 -0
  220. package/internal/utils/log.d.mts.map +1 -0
  221. package/internal/utils/log.d.ts +37 -0
  222. package/internal/utils/log.d.ts.map +1 -0
  223. package/internal/utils/log.js +85 -0
  224. package/internal/utils/log.js.map +1 -0
  225. package/internal/utils/log.mjs +79 -0
  226. package/internal/utils/log.mjs.map +1 -0
  227. package/internal/utils/path.d.mts +15 -0
  228. package/internal/utils/path.d.mts.map +1 -0
  229. package/internal/utils/path.d.ts +15 -0
  230. package/internal/utils/path.d.ts.map +1 -0
  231. package/internal/utils/path.js +79 -0
  232. package/internal/utils/path.js.map +1 -0
  233. package/internal/utils/path.mjs +74 -0
  234. package/internal/utils/path.mjs.map +1 -0
  235. package/internal/utils/sleep.d.mts +2 -0
  236. package/internal/utils/sleep.d.mts.map +1 -0
  237. package/internal/utils/sleep.d.ts +2 -0
  238. package/internal/utils/sleep.d.ts.map +1 -0
  239. package/internal/utils/sleep.js +7 -0
  240. package/internal/utils/sleep.js.map +1 -0
  241. package/internal/utils/sleep.mjs +3 -0
  242. package/internal/utils/sleep.mjs.map +1 -0
  243. package/internal/utils/uuid.d.mts +5 -0
  244. package/internal/utils/uuid.d.mts.map +1 -0
  245. package/internal/utils/uuid.d.ts +5 -0
  246. package/internal/utils/uuid.d.ts.map +1 -0
  247. package/internal/utils/uuid.js +19 -0
  248. package/internal/utils/uuid.js.map +1 -0
  249. package/internal/utils/uuid.mjs +15 -0
  250. package/internal/utils/uuid.mjs.map +1 -0
  251. package/internal/utils/values.d.mts +18 -0
  252. package/internal/utils/values.d.mts.map +1 -0
  253. package/internal/utils/values.d.ts +18 -0
  254. package/internal/utils/values.d.ts.map +1 -0
  255. package/internal/utils/values.js +112 -0
  256. package/internal/utils/values.js.map +1 -0
  257. package/internal/utils/values.mjs +94 -0
  258. package/internal/utils/values.mjs.map +1 -0
  259. package/internal/utils.d.mts +7 -0
  260. package/internal/utils.d.mts.map +1 -0
  261. package/internal/utils.d.ts +7 -0
  262. package/internal/utils.d.ts.map +1 -0
  263. package/internal/utils.js +11 -0
  264. package/internal/utils.js.map +1 -0
  265. package/internal/utils.mjs +8 -0
  266. package/internal/utils.mjs.map +1 -0
  267. package/package.json +113 -64
  268. package/pagination.d.mts +2 -0
  269. package/pagination.d.mts.map +1 -0
  270. package/pagination.d.ts +1 -43
  271. package/pagination.d.ts.map +1 -1
  272. package/pagination.js +3 -66
  273. package/pagination.js.map +1 -1
  274. package/pagination.mjs +1 -63
  275. package/pagination.mjs.map +1 -1
  276. package/resource.d.mts +2 -0
  277. package/resource.d.mts.map +1 -0
  278. package/resource.d.ts +1 -5
  279. package/resource.d.ts.map +1 -1
  280. package/resource.js +3 -8
  281. package/resource.js.map +1 -1
  282. package/resource.mjs +1 -6
  283. package/resource.mjs.map +1 -1
  284. package/resources/alias/alias.d.mts +13 -0
  285. package/resources/alias/alias.d.mts.map +1 -0
  286. package/resources/alias/alias.d.ts +1 -1
  287. package/resources/alias/alias.d.ts.map +1 -1
  288. package/resources/alias/alias.js +3 -25
  289. package/resources/alias/alias.js.map +1 -1
  290. package/resources/alias/alias.mjs +1 -1
  291. package/resources/alias/index.d.mts +3 -0
  292. package/resources/alias/index.d.mts.map +1 -0
  293. package/resources/alias/index.d.ts.map +1 -1
  294. package/resources/alias/username/index.d.mts +3 -0
  295. package/resources/alias/username/index.d.mts.map +1 -0
  296. package/resources/alias/username/index.d.ts +1 -1
  297. package/resources/alias/username/index.d.ts.map +1 -1
  298. package/resources/alias/username/index.js.map +1 -1
  299. package/resources/alias/username/index.mjs.map +1 -1
  300. package/resources/alias/username/username.d.mts +24 -0
  301. package/resources/alias/username/username.d.mts.map +1 -0
  302. package/resources/alias/username/username.d.ts +6 -5
  303. package/resources/alias/username/username.d.ts.map +1 -1
  304. package/resources/alias/username/username.js +5 -26
  305. package/resources/alias/username/username.js.map +1 -1
  306. package/resources/alias/username/username.mjs +3 -2
  307. package/resources/alias/username/username.mjs.map +1 -1
  308. package/resources/alias/username/val-name.d.mts +28 -0
  309. package/resources/alias/username/val-name.d.mts.map +1 -0
  310. package/resources/alias/username/val-name.d.ts +14 -4
  311. package/resources/alias/username/val-name.d.ts.map +1 -1
  312. package/resources/alias/username/val-name.js +6 -4
  313. package/resources/alias/username/val-name.js.map +1 -1
  314. package/resources/alias/username/val-name.mjs +6 -4
  315. package/resources/alias/username/val-name.mjs.map +1 -1
  316. package/resources/alias/username.d.mts +2 -0
  317. package/resources/alias/username.d.mts.map +1 -0
  318. package/resources/alias/username.d.ts.map +1 -1
  319. package/resources/alias/username.js +2 -15
  320. package/resources/alias/username.js.map +1 -1
  321. package/resources/alias.d.mts +2 -0
  322. package/resources/alias.d.mts.map +1 -0
  323. package/resources/alias.d.ts.map +1 -1
  324. package/resources/alias.js +2 -15
  325. package/resources/alias.js.map +1 -1
  326. package/resources/blobs.d.mts +58 -0
  327. package/resources/blobs.d.mts.map +1 -0
  328. package/resources/blobs.d.ts +14 -10
  329. package/resources/blobs.d.ts.map +1 -1
  330. package/resources/blobs.js +18 -17
  331. package/resources/blobs.js.map +1 -1
  332. package/resources/blobs.mjs +18 -17
  333. package/resources/blobs.mjs.map +1 -1
  334. package/resources/emails.d.mts +147 -0
  335. package/resources/emails.d.mts.map +1 -0
  336. package/resources/emails.d.ts +4 -4
  337. package/resources/emails.d.ts.map +1 -1
  338. package/resources/emails.js +13 -5
  339. package/resources/emails.js.map +1 -1
  340. package/resources/emails.mjs +13 -5
  341. package/resources/emails.mjs.map +1 -1
  342. package/resources/files.d.mts +51 -0
  343. package/resources/files.d.mts.map +1 -0
  344. package/resources/files.d.ts +4 -3
  345. package/resources/files.d.ts.map +1 -1
  346. package/resources/files.js +4 -3
  347. package/resources/files.js.map +1 -1
  348. package/resources/files.mjs +4 -3
  349. package/resources/files.mjs.map +1 -1
  350. package/resources/index.d.mts +12 -0
  351. package/resources/index.d.mts.map +1 -0
  352. package/resources/index.d.ts +1 -2
  353. package/resources/index.d.ts.map +1 -1
  354. package/resources/index.js +3 -19
  355. package/resources/index.js.map +1 -1
  356. package/resources/index.mjs +1 -2
  357. package/resources/index.mjs.map +1 -1
  358. package/resources/me/index.d.mts +4 -0
  359. package/resources/me/index.d.mts.map +1 -0
  360. package/resources/me/index.d.ts.map +1 -1
  361. package/resources/me/me.d.mts +17 -0
  362. package/resources/me/me.d.mts.map +1 -0
  363. package/resources/me/me.d.ts +1 -1
  364. package/resources/me/me.d.ts.map +1 -1
  365. package/resources/me/me.js +4 -26
  366. package/resources/me/me.js.map +1 -1
  367. package/resources/me/me.mjs +1 -1
  368. package/resources/me/profile.d.mts +59 -0
  369. package/resources/me/profile.d.mts.map +1 -0
  370. package/resources/me/profile.d.ts +4 -3
  371. package/resources/me/profile.d.ts.map +1 -1
  372. package/resources/me/profile.js +1 -1
  373. package/resources/me/profile.js.map +1 -1
  374. package/resources/me/profile.mjs +1 -1
  375. package/resources/me/profile.mjs.map +1 -1
  376. package/resources/me/vals.d.mts +18 -0
  377. package/resources/me/vals.d.mts.map +1 -0
  378. package/resources/me/vals.d.ts +5 -5
  379. package/resources/me/vals.d.ts.map +1 -1
  380. package/resources/me/vals.js +4 -5
  381. package/resources/me/vals.js.map +1 -1
  382. package/resources/me/vals.mjs +3 -4
  383. package/resources/me/vals.mjs.map +1 -1
  384. package/resources/me.d.mts +2 -0
  385. package/resources/me.d.mts.map +1 -0
  386. package/resources/me.d.ts.map +1 -1
  387. package/resources/me.js +2 -15
  388. package/resources/me.js.map +1 -1
  389. package/resources/orgs.d.mts +29 -0
  390. package/resources/orgs.d.mts.map +1 -0
  391. package/resources/orgs.d.ts +6 -7
  392. package/resources/orgs.d.ts.map +1 -1
  393. package/resources/orgs.js +4 -8
  394. package/resources/orgs.js.map +1 -1
  395. package/resources/orgs.mjs +3 -6
  396. package/resources/orgs.mjs.map +1 -1
  397. package/resources/shared.d.mts +294 -0
  398. package/resources/shared.d.mts.map +1 -0
  399. package/resources/shared.d.ts +3 -7
  400. package/resources/shared.d.ts.map +1 -1
  401. package/resources/shared.js +0 -11
  402. package/resources/shared.js.map +1 -1
  403. package/resources/shared.mjs +1 -7
  404. package/resources/shared.mjs.map +1 -1
  405. package/resources/sqlite.d.mts +86 -0
  406. package/resources/sqlite.d.mts.map +1 -0
  407. package/resources/sqlite.d.ts +5 -4
  408. package/resources/sqlite.d.ts.map +1 -1
  409. package/resources/sqlite.js +1 -1
  410. package/resources/sqlite.js.map +1 -1
  411. package/resources/sqlite.mjs +1 -1
  412. package/resources/sqlite.mjs.map +1 -1
  413. package/resources/telemetry/index.d.mts +4 -0
  414. package/resources/telemetry/index.d.mts.map +1 -0
  415. package/resources/telemetry/index.d.ts.map +1 -1
  416. package/resources/telemetry/logs.d.mts +90 -0
  417. package/resources/telemetry/logs.d.mts.map +1 -0
  418. package/resources/telemetry/logs.d.ts +4 -3
  419. package/resources/telemetry/logs.d.ts.map +1 -1
  420. package/resources/telemetry/logs.js +1 -1
  421. package/resources/telemetry/logs.js.map +1 -1
  422. package/resources/telemetry/logs.mjs +1 -1
  423. package/resources/telemetry/logs.mjs.map +1 -1
  424. package/resources/telemetry/telemetry.d.mts +17 -0
  425. package/resources/telemetry/telemetry.d.mts.map +1 -0
  426. package/resources/telemetry/telemetry.d.ts +1 -1
  427. package/resources/telemetry/telemetry.d.ts.map +1 -1
  428. package/resources/telemetry/telemetry.js +4 -26
  429. package/resources/telemetry/telemetry.js.map +1 -1
  430. package/resources/telemetry/telemetry.mjs +1 -1
  431. package/resources/telemetry/traces.d.mts +95 -0
  432. package/resources/telemetry/traces.d.mts.map +1 -0
  433. package/resources/telemetry/traces.d.ts +4 -3
  434. package/resources/telemetry/traces.d.ts.map +1 -1
  435. package/resources/telemetry/traces.js +1 -1
  436. package/resources/telemetry/traces.js.map +1 -1
  437. package/resources/telemetry/traces.mjs +1 -1
  438. package/resources/telemetry/traces.mjs.map +1 -1
  439. package/resources/telemetry.d.mts +2 -0
  440. package/resources/telemetry.d.mts.map +1 -0
  441. package/resources/telemetry.d.ts.map +1 -1
  442. package/resources/telemetry.js +2 -15
  443. package/resources/telemetry.js.map +1 -1
  444. package/resources/users.d.mts +21 -0
  445. package/resources/users.d.mts.map +1 -0
  446. package/resources/users.d.ts +4 -3
  447. package/resources/users.d.ts.map +1 -1
  448. package/resources/users.js +4 -3
  449. package/resources/users.js.map +1 -1
  450. package/resources/users.mjs +4 -3
  451. package/resources/users.mjs.map +1 -1
  452. package/resources/vals/branches.d.mts +177 -0
  453. package/resources/vals/branches.d.mts.map +1 -0
  454. package/resources/vals/branches.d.ts +24 -12
  455. package/resources/vals/branches.d.ts.map +1 -1
  456. package/resources/vals/branches.js +18 -18
  457. package/resources/vals/branches.js.map +1 -1
  458. package/resources/vals/branches.mjs +17 -16
  459. package/resources/vals/branches.mjs.map +1 -1
  460. package/resources/vals/environment-variables.d.mts +148 -0
  461. package/resources/vals/environment-variables.d.mts.map +1 -0
  462. package/resources/vals/environment-variables.d.ts +32 -21
  463. package/resources/vals/environment-variables.d.ts.map +1 -1
  464. package/resources/vals/environment-variables.js +26 -26
  465. package/resources/vals/environment-variables.js.map +1 -1
  466. package/resources/vals/environment-variables.mjs +25 -24
  467. package/resources/vals/environment-variables.mjs.map +1 -1
  468. package/resources/vals/files.d.mts +328 -0
  469. package/resources/vals/files.d.mts.map +1 -0
  470. package/resources/vals/files.d.ts +11 -12
  471. package/resources/vals/files.d.ts.map +1 -1
  472. package/resources/vals/files.js +27 -27
  473. package/resources/vals/files.js.map +1 -1
  474. package/resources/vals/files.mjs +26 -25
  475. package/resources/vals/files.mjs.map +1 -1
  476. package/resources/vals/index.d.mts +5 -0
  477. package/resources/vals/index.d.mts.map +1 -0
  478. package/resources/vals/index.d.ts +3 -3
  479. package/resources/vals/index.d.ts.map +1 -1
  480. package/resources/vals/index.js +1 -4
  481. package/resources/vals/index.js.map +1 -1
  482. package/resources/vals/index.mjs +3 -3
  483. package/resources/vals/index.mjs.map +1 -1
  484. package/resources/vals/vals.d.mts +99 -0
  485. package/resources/vals/vals.d.mts.map +1 -0
  486. package/resources/vals/vals.d.ts +14 -13
  487. package/resources/vals/vals.d.ts.map +1 -1
  488. package/resources/vals/vals.js +15 -39
  489. package/resources/vals/vals.js.map +1 -1
  490. package/resources/vals/vals.mjs +13 -15
  491. package/resources/vals/vals.mjs.map +1 -1
  492. package/resources/vals.d.mts +2 -0
  493. package/resources/vals.d.mts.map +1 -0
  494. package/resources/vals.d.ts.map +1 -1
  495. package/resources/vals.js +2 -15
  496. package/resources/vals.js.map +1 -1
  497. package/resources.d.mts +2 -0
  498. package/resources.d.mts.map +1 -0
  499. package/resources.d.ts.map +1 -1
  500. package/resources.js +2 -15
  501. package/resources.js.map +1 -1
  502. package/src/api-promise.ts +2 -0
  503. package/src/client.ts +848 -0
  504. package/src/core/README.md +3 -0
  505. package/src/core/api-promise.ts +92 -0
  506. package/src/core/error.ts +130 -0
  507. package/src/core/pagination.ts +218 -0
  508. package/src/core/resource.ts +11 -0
  509. package/src/core/uploads.ts +2 -0
  510. package/src/error.ts +2 -130
  511. package/src/index.ts +6 -310
  512. package/src/internal/README.md +3 -0
  513. package/src/internal/builtin-types.ts +93 -0
  514. package/src/internal/detect-platform.ts +196 -0
  515. package/src/internal/errors.ts +33 -0
  516. package/src/internal/headers.ts +97 -0
  517. package/src/internal/parse.ts +50 -0
  518. package/src/internal/qs/formats.ts +2 -1
  519. package/src/internal/qs/stringify.ts +17 -20
  520. package/src/internal/qs/utils.ts +14 -14
  521. package/src/internal/request-options.ts +91 -0
  522. package/src/internal/shim-types.ts +26 -0
  523. package/src/internal/shims.ts +107 -0
  524. package/src/internal/to-file.ts +154 -0
  525. package/src/internal/types.ts +95 -0
  526. package/src/internal/uploads.ts +187 -0
  527. package/src/internal/utils/base64.ts +40 -0
  528. package/src/internal/utils/bytes.ts +32 -0
  529. package/src/internal/utils/env.ts +18 -0
  530. package/src/internal/utils/log.ts +126 -0
  531. package/src/internal/utils/path.ts +88 -0
  532. package/src/internal/utils/sleep.ts +3 -0
  533. package/src/internal/utils/uuid.ts +17 -0
  534. package/src/internal/utils/values.ts +105 -0
  535. package/src/internal/utils.ts +8 -0
  536. package/src/pagination.ts +2 -123
  537. package/src/resource.ts +2 -11
  538. package/src/resources/alias/alias.ts +1 -1
  539. package/src/resources/alias/username/index.ts +1 -1
  540. package/src/resources/alias/username/username.ts +8 -6
  541. package/src/resources/alias/username/val-name.ts +19 -5
  542. package/src/resources/blobs.ts +28 -31
  543. package/src/resources/emails.ts +6 -11
  544. package/src/resources/files.ts +6 -4
  545. package/src/resources/index.ts +1 -2
  546. package/src/resources/me/me.ts +1 -1
  547. package/src/resources/me/profile.ts +4 -3
  548. package/src/resources/me/vals.ts +6 -6
  549. package/src/resources/orgs.ts +8 -10
  550. package/src/resources/shared.ts +3 -5
  551. package/src/resources/sqlite.ts +5 -4
  552. package/src/resources/telemetry/logs.ts +4 -3
  553. package/src/resources/telemetry/telemetry.ts +1 -1
  554. package/src/resources/telemetry/traces.ts +4 -3
  555. package/src/resources/users.ts +6 -4
  556. package/src/resources/vals/branches.ts +43 -24
  557. package/src/resources/vals/environment-variables.ts +50 -35
  558. package/src/resources/vals/files.ts +32 -42
  559. package/src/resources/vals/index.ts +6 -3
  560. package/src/resources/vals/vals.ts +24 -18
  561. package/src/tsconfig.json +2 -2
  562. package/src/uploads.ts +2 -255
  563. package/src/version.ts +1 -1
  564. package/uploads.d.mts +2 -0
  565. package/uploads.d.mts.map +1 -0
  566. package/uploads.d.ts +1 -74
  567. package/uploads.d.ts.map +1 -1
  568. package/uploads.js +3 -168
  569. package/uploads.js.map +1 -1
  570. package/uploads.mjs +1 -157
  571. package/uploads.mjs.map +1 -1
  572. package/version.d.mts +2 -0
  573. package/version.d.mts.map +1 -0
  574. package/version.d.ts +1 -1
  575. package/version.js +1 -1
  576. package/version.mjs +1 -1
  577. package/_shims/MultipartBody.d.ts +0 -9
  578. package/_shims/MultipartBody.d.ts.map +0 -1
  579. package/_shims/MultipartBody.js +0 -16
  580. package/_shims/MultipartBody.js.map +0 -1
  581. package/_shims/MultipartBody.mjs +0 -12
  582. package/_shims/MultipartBody.mjs.map +0 -1
  583. package/_shims/README.md +0 -46
  584. package/_shims/auto/runtime-bun.d.ts +0 -5
  585. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  586. package/_shims/auto/runtime-bun.js +0 -21
  587. package/_shims/auto/runtime-bun.js.map +0 -1
  588. package/_shims/auto/runtime-bun.mjs +0 -2
  589. package/_shims/auto/runtime-bun.mjs.map +0 -1
  590. package/_shims/auto/runtime-node.d.ts +0 -5
  591. package/_shims/auto/runtime-node.d.ts.map +0 -1
  592. package/_shims/auto/runtime-node.js +0 -21
  593. package/_shims/auto/runtime-node.js.map +0 -1
  594. package/_shims/auto/runtime-node.mjs +0 -2
  595. package/_shims/auto/runtime-node.mjs.map +0 -1
  596. package/_shims/auto/runtime.d.ts +0 -5
  597. package/_shims/auto/runtime.d.ts.map +0 -1
  598. package/_shims/auto/runtime.js +0 -21
  599. package/_shims/auto/runtime.js.map +0 -1
  600. package/_shims/auto/runtime.mjs +0 -2
  601. package/_shims/auto/runtime.mjs.map +0 -1
  602. package/_shims/auto/types-node.d.ts +0 -5
  603. package/_shims/auto/types-node.d.ts.map +0 -1
  604. package/_shims/auto/types-node.js +0 -21
  605. package/_shims/auto/types-node.js.map +0 -1
  606. package/_shims/auto/types-node.mjs +0 -2
  607. package/_shims/auto/types-node.mjs.map +0 -1
  608. package/_shims/auto/types.d.ts +0 -101
  609. package/_shims/auto/types.js +0 -3
  610. package/_shims/auto/types.mjs +0 -3
  611. package/_shims/bun-runtime.d.ts +0 -6
  612. package/_shims/bun-runtime.d.ts.map +0 -1
  613. package/_shims/bun-runtime.js +0 -14
  614. package/_shims/bun-runtime.js.map +0 -1
  615. package/_shims/bun-runtime.mjs +0 -10
  616. package/_shims/bun-runtime.mjs.map +0 -1
  617. package/_shims/index.d.ts +0 -83
  618. package/_shims/index.js +0 -17
  619. package/_shims/index.mjs +0 -11
  620. package/_shims/manual-types.d.ts +0 -12
  621. package/_shims/manual-types.js +0 -3
  622. package/_shims/manual-types.mjs +0 -3
  623. package/_shims/node-runtime.d.ts +0 -3
  624. package/_shims/node-runtime.d.ts.map +0 -1
  625. package/_shims/node-runtime.js +0 -89
  626. package/_shims/node-runtime.js.map +0 -1
  627. package/_shims/node-runtime.mjs +0 -56
  628. package/_shims/node-runtime.mjs.map +0 -1
  629. package/_shims/node-types.d.ts +0 -42
  630. package/_shims/node-types.js +0 -3
  631. package/_shims/node-types.mjs +0 -3
  632. package/_shims/registry.d.ts +0 -37
  633. package/_shims/registry.d.ts.map +0 -1
  634. package/_shims/registry.js +0 -41
  635. package/_shims/registry.js.map +0 -1
  636. package/_shims/registry.mjs +0 -37
  637. package/_shims/registry.mjs.map +0 -1
  638. package/_shims/web-runtime.d.ts +0 -5
  639. package/_shims/web-runtime.d.ts.map +0 -1
  640. package/_shims/web-runtime.js +0 -78
  641. package/_shims/web-runtime.js.map +0 -1
  642. package/_shims/web-runtime.mjs +0 -71
  643. package/_shims/web-runtime.mjs.map +0 -1
  644. package/_shims/web-types.d.ts +0 -83
  645. package/_shims/web-types.js +0 -3
  646. package/_shims/web-types.mjs +0 -3
  647. package/core.d.ts +0 -255
  648. package/core.d.ts.map +0 -1
  649. package/core.js +0 -924
  650. package/core.js.map +0 -1
  651. package/core.mjs +0 -892
  652. package/core.mjs.map +0 -1
  653. package/resources/search/index.d.ts +0 -3
  654. package/resources/search/index.d.ts.map +0 -1
  655. package/resources/search/index.js +0 -9
  656. package/resources/search/index.js.map +0 -1
  657. package/resources/search/index.mjs +0 -4
  658. package/resources/search/index.mjs.map +0 -1
  659. package/resources/search/search.d.ts +0 -13
  660. package/resources/search/search.d.ts.map +0 -1
  661. package/resources/search/search.js +0 -42
  662. package/resources/search/search.js.map +0 -1
  663. package/resources/search/search.mjs +0 -15
  664. package/resources/search/search.mjs.map +0 -1
  665. package/resources/search/vals.d.ts +0 -22
  666. package/resources/search/vals.d.ts.map +0 -1
  667. package/resources/search/vals.js +0 -17
  668. package/resources/search/vals.js.map +0 -1
  669. package/resources/search/vals.mjs +0 -13
  670. package/resources/search/vals.mjs.map +0 -1
  671. package/resources/search.d.ts +0 -2
  672. package/resources/search.d.ts.map +0 -1
  673. package/resources/search.js +0 -19
  674. package/resources/search.js.map +0 -1
  675. package/resources/search.mjs.map +0 -1
  676. package/shims/node.d.ts +0 -30
  677. package/shims/node.d.ts.map +0 -1
  678. package/shims/node.js +0 -31
  679. package/shims/node.js.map +0 -1
  680. package/shims/node.mjs +0 -5
  681. package/shims/node.mjs.map +0 -1
  682. package/shims/web.d.ts +0 -26
  683. package/shims/web.d.ts.map +0 -1
  684. package/shims/web.js +0 -31
  685. package/shims/web.js.map +0 -1
  686. package/shims/web.mjs +0 -5
  687. package/shims/web.mjs.map +0 -1
  688. package/src/_shims/MultipartBody.ts +0 -9
  689. package/src/_shims/README.md +0 -46
  690. package/src/_shims/auto/runtime-bun.ts +0 -4
  691. package/src/_shims/auto/runtime-node.ts +0 -4
  692. package/src/_shims/auto/runtime.ts +0 -4
  693. package/src/_shims/auto/types-node.ts +0 -4
  694. package/src/_shims/auto/types.d.ts +0 -101
  695. package/src/_shims/auto/types.js +0 -3
  696. package/src/_shims/auto/types.mjs +0 -3
  697. package/src/_shims/bun-runtime.ts +0 -14
  698. package/src/_shims/index.d.ts +0 -83
  699. package/src/_shims/index.js +0 -17
  700. package/src/_shims/index.mjs +0 -11
  701. package/src/_shims/manual-types.d.ts +0 -12
  702. package/src/_shims/manual-types.js +0 -3
  703. package/src/_shims/manual-types.mjs +0 -3
  704. package/src/_shims/node-runtime.ts +0 -81
  705. package/src/_shims/node-types.d.ts +0 -42
  706. package/src/_shims/node-types.js +0 -3
  707. package/src/_shims/node-types.mjs +0 -3
  708. package/src/_shims/registry.ts +0 -67
  709. package/src/_shims/web-runtime.ts +0 -103
  710. package/src/_shims/web-types.d.ts +0 -83
  711. package/src/_shims/web-types.js +0 -3
  712. package/src/_shims/web-types.mjs +0 -3
  713. package/src/core.ts +0 -1236
  714. package/src/resources/search/search.ts +0 -18
  715. package/src/resources/search/vals.ts +0 -32
  716. package/src/shims/node.ts +0 -50
  717. package/src/shims/web.ts +0 -50
@@ -1,16 +1,17 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  export {
4
- BranchListResponsesPageCursorURL,
5
4
  Branches,
6
5
  type BranchCreateResponse,
7
6
  type BranchRetrieveResponse,
8
7
  type BranchListResponse,
9
8
  type BranchCreateParams,
9
+ type BranchRetrieveParams,
10
10
  type BranchListParams,
11
+ type BranchDeleteParams,
12
+ type BranchListResponsesPageCursorURL,
11
13
  } from './branches';
12
14
  export {
13
- EnvironmentVariableListResponsesPageCursorURL,
14
15
  EnvironmentVariables,
15
16
  type EnvironmentVariableCreateResponse,
16
17
  type EnvironmentVariableUpdateResponse,
@@ -18,9 +19,10 @@ export {
18
19
  type EnvironmentVariableCreateParams,
19
20
  type EnvironmentVariableUpdateParams,
20
21
  type EnvironmentVariableListParams,
22
+ type EnvironmentVariableDeleteParams,
23
+ type EnvironmentVariableListResponsesPageCursorURL,
21
24
  } from './environment-variables';
22
25
  export {
23
- FileRetrieveResponsesPageCursorURL,
24
26
  Files,
25
27
  type FileCreateResponse,
26
28
  type FileRetrieveResponse,
@@ -30,5 +32,6 @@ export {
30
32
  type FileUpdateParams,
31
33
  type FileDeleteParams,
32
34
  type FileGetContentParams,
35
+ type FileRetrieveResponsesPageCursorURL,
33
36
  } from './files';
34
37
  export { Vals, type ValCreateParams, type ValListParams } from './vals';
@@ -1,16 +1,17 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
- import { APIResource } from '../../resource';
4
- import * as Core from '../../core';
3
+ import { APIResource } from '../../core/resource';
5
4
  import * as Shared from '../shared';
6
5
  import { ValsCursor } from '../shared';
7
6
  import * as BranchesAPI from './branches';
8
7
  import {
9
8
  BranchCreateParams,
10
9
  BranchCreateResponse,
10
+ BranchDeleteParams,
11
11
  BranchListParams,
12
12
  BranchListResponse,
13
13
  BranchListResponsesPageCursorURL,
14
+ BranchRetrieveParams,
14
15
  BranchRetrieveResponse,
15
16
  Branches,
16
17
  } from './branches';
@@ -18,6 +19,7 @@ import * as EnvironmentVariablesAPI from './environment-variables';
18
19
  import {
19
20
  EnvironmentVariableCreateParams,
20
21
  EnvironmentVariableCreateResponse,
22
+ EnvironmentVariableDeleteParams,
21
23
  EnvironmentVariableListParams,
22
24
  EnvironmentVariableListResponse,
23
25
  EnvironmentVariableListResponsesPageCursorURL,
@@ -38,7 +40,11 @@ import {
38
40
  FileUpdateResponse,
39
41
  Files,
40
42
  } from './files';
41
- import { type CursorParams } from '../../pagination';
43
+ import { APIPromise } from '../../core/api-promise';
44
+ import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
45
+ import { buildHeaders } from '../../internal/headers';
46
+ import { RequestOptions } from '../../internal/request-options';
47
+ import { path } from '../../internal/utils/path';
42
48
 
43
49
  /**
44
50
  * Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules
@@ -61,7 +67,7 @@ export class Vals extends APIResource {
61
67
  * });
62
68
  * ```
63
69
  */
64
- create(body: ValCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
70
+ create(body: ValCreateParams, options?: RequestOptions): APIPromise<Shared.Val> {
65
71
  return this._client.post('/v2/vals', { body, ...options });
66
72
  }
67
73
 
@@ -75,8 +81,8 @@ export class Vals extends APIResource {
75
81
  * );
76
82
  * ```
77
83
  */
78
- retrieve(valId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
79
- return this._client.get(`/v2/vals/${valId}`, options);
84
+ retrieve(valID: string, options?: RequestOptions): APIPromise<Shared.Val> {
85
+ return this._client.get(path`/v2/vals/${valID}`, options);
80
86
  }
81
87
 
82
88
  /**
@@ -90,8 +96,8 @@ export class Vals extends APIResource {
90
96
  * }
91
97
  * ```
92
98
  */
93
- list(query: ValListParams, options?: Core.RequestOptions): Core.PagePromise<ValsCursor, Shared.Val> {
94
- return this._client.getAPIList('/v2/vals', ValsCursor, { query, ...options });
99
+ list(query: ValListParams, options?: RequestOptions): PagePromise<ValsCursor, Shared.Val> {
100
+ return this._client.getAPIList('/v2/vals', Cursor<Shared.Val>, { query, ...options });
95
101
  }
96
102
 
97
103
  /**
@@ -104,10 +110,10 @@ export class Vals extends APIResource {
104
110
  * );
105
111
  * ```
106
112
  */
107
- delete(valId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
108
- return this._client.delete(`/v2/vals/${valId}`, {
113
+ delete(valID: string, options?: RequestOptions): APIPromise<void> {
114
+ return this._client.delete(path`/v2/vals/${valID}`, {
109
115
  ...options,
110
- headers: { Accept: '*/*', ...options?.headers },
116
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
111
117
  });
112
118
  }
113
119
  }
@@ -144,11 +150,8 @@ export interface ValListParams extends CursorParams {
144
150
  }
145
151
 
146
152
  Vals.Branches = Branches;
147
- Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
148
153
  Vals.Files = Files;
149
- Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
150
154
  Vals.EnvironmentVariables = EnvironmentVariables;
151
- Vals.EnvironmentVariableListResponsesPageCursorURL = EnvironmentVariableListResponsesPageCursorURL;
152
155
 
153
156
  export declare namespace Vals {
154
157
  export { type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
@@ -158,9 +161,11 @@ export declare namespace Vals {
158
161
  type BranchCreateResponse as BranchCreateResponse,
159
162
  type BranchRetrieveResponse as BranchRetrieveResponse,
160
163
  type BranchListResponse as BranchListResponse,
161
- BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
164
+ type BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
162
165
  type BranchCreateParams as BranchCreateParams,
166
+ type BranchRetrieveParams as BranchRetrieveParams,
163
167
  type BranchListParams as BranchListParams,
168
+ type BranchDeleteParams as BranchDeleteParams,
164
169
  };
165
170
 
166
171
  export {
@@ -168,7 +173,7 @@ export declare namespace Vals {
168
173
  type FileCreateResponse as FileCreateResponse,
169
174
  type FileRetrieveResponse as FileRetrieveResponse,
170
175
  type FileUpdateResponse as FileUpdateResponse,
171
- FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
176
+ type FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
172
177
  type FileCreateParams as FileCreateParams,
173
178
  type FileRetrieveParams as FileRetrieveParams,
174
179
  type FileUpdateParams as FileUpdateParams,
@@ -181,11 +186,12 @@ export declare namespace Vals {
181
186
  type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse,
182
187
  type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse,
183
188
  type EnvironmentVariableListResponse as EnvironmentVariableListResponse,
184
- EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
189
+ type EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
185
190
  type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams,
186
191
  type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams,
187
192
  type EnvironmentVariableListParams as EnvironmentVariableListParams,
193
+ type EnvironmentVariableDeleteParams as EnvironmentVariableDeleteParams,
188
194
  };
189
195
  }
190
196
 
191
- export { ValsCursor };
197
+ export { type ValsCursor };
package/src/tsconfig.json CHANGED
@@ -4,8 +4,8 @@
4
4
  // via declaration maps
5
5
  "include": ["index.ts"],
6
6
  "compilerOptions": {
7
- "target": "es2015",
8
- "lib": ["DOM"],
7
+ "target": "ES2015",
8
+ "lib": ["DOM", "DOM.Iterable", "ES2018"],
9
9
  "moduleResolution": "node"
10
10
  }
11
11
  }
package/src/uploads.ts CHANGED
@@ -1,255 +1,2 @@
1
- import { type RequestOptions } from './core';
2
- import {
3
- FormData,
4
- File,
5
- type Blob,
6
- type FilePropertyBag,
7
- getMultipartRequestOptions,
8
- type FsReadStream,
9
- isFsReadStream,
10
- } from './_shims/index';
11
- import { MultipartBody } from './_shims/MultipartBody';
12
- export { fileFromPath } from './_shims/index';
13
-
14
- type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
15
- export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
16
-
17
- /**
18
- * Typically, this is a native "File" class.
19
- *
20
- * We provide the {@link toFile} utility to convert a variety of objects
21
- * into the File class.
22
- *
23
- * For convenience, you can also pass a fetch Response, or in Node,
24
- * the result of fs.createReadStream().
25
- */
26
- export type Uploadable = FileLike | ResponseLike | FsReadStream;
27
-
28
- /**
29
- * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
30
- */
31
- export interface BlobLike {
32
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
33
- readonly size: number;
34
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
35
- readonly type: string;
36
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
37
- text(): Promise<string>;
38
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
39
- slice(start?: number, end?: number): BlobLike;
40
- // unfortunately @types/node-fetch@^2.6.4 doesn't type the arrayBuffer method
41
- }
42
-
43
- /**
44
- * Intended to match web.File, node.File, node-fetch.File, etc.
45
- */
46
- export interface FileLike extends BlobLike {
47
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
48
- readonly lastModified: number;
49
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
50
- readonly name: string;
51
- }
52
-
53
- /**
54
- * Intended to match web.Response, node.Response, node-fetch.Response, etc.
55
- */
56
- export interface ResponseLike {
57
- url: string;
58
- blob(): Promise<BlobLike>;
59
- }
60
-
61
- export const isResponseLike = (value: any): value is ResponseLike =>
62
- value != null &&
63
- typeof value === 'object' &&
64
- typeof value.url === 'string' &&
65
- typeof value.blob === 'function';
66
-
67
- export const isFileLike = (value: any): value is FileLike =>
68
- value != null &&
69
- typeof value === 'object' &&
70
- typeof value.name === 'string' &&
71
- typeof value.lastModified === 'number' &&
72
- isBlobLike(value);
73
-
74
- /**
75
- * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
76
- * adds the arrayBuffer() method type because it is available and used at runtime
77
- */
78
- export const isBlobLike = (value: any): value is BlobLike & { arrayBuffer(): Promise<ArrayBuffer> } =>
79
- value != null &&
80
- typeof value === 'object' &&
81
- typeof value.size === 'number' &&
82
- typeof value.type === 'string' &&
83
- typeof value.text === 'function' &&
84
- typeof value.slice === 'function' &&
85
- typeof value.arrayBuffer === 'function';
86
-
87
- export const isUploadable = (value: any): value is Uploadable => {
88
- return isFileLike(value) || isResponseLike(value) || isFsReadStream(value);
89
- };
90
-
91
- export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
92
-
93
- /**
94
- * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
95
- * @param value the raw content of the file. Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
96
- * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
97
- * @param {Object=} options additional properties
98
- * @param {string=} options.type the MIME type of the content
99
- * @param {number=} options.lastModified the last modified timestamp
100
- * @returns a {@link File} with the given properties
101
- */
102
- export async function toFile(
103
- value: ToFileInput | PromiseLike<ToFileInput>,
104
- name?: string | null | undefined,
105
- options?: FilePropertyBag | undefined,
106
- ): Promise<FileLike> {
107
- // If it's a promise, resolve it.
108
- value = await value;
109
-
110
- // If we've been given a `File` we don't need to do anything
111
- if (isFileLike(value)) {
112
- return value;
113
- }
114
-
115
- if (isResponseLike(value)) {
116
- const blob = await value.blob();
117
- name ||= new URL(value.url).pathname.split(/[\\/]/).pop() ?? 'unknown_file';
118
-
119
- // we need to convert the `Blob` into an array buffer because the `Blob` class
120
- // that `node-fetch` defines is incompatible with the web standard which results
121
- // in `new File` interpreting it as a string instead of binary data.
122
- const data = isBlobLike(blob) ? [(await blob.arrayBuffer()) as any] : [blob];
123
-
124
- return new File(data, name, options);
125
- }
126
-
127
- const bits = await getBytes(value);
128
-
129
- name ||= getName(value) ?? 'unknown_file';
130
-
131
- if (!options?.type) {
132
- const type = (bits[0] as any)?.type;
133
- if (typeof type === 'string') {
134
- options = { ...options, type };
135
- }
136
- }
137
-
138
- return new File(bits, name, options);
139
- }
140
-
141
- async function getBytes(value: ToFileInput): Promise<Array<BlobPart>> {
142
- let parts: Array<BlobPart> = [];
143
- if (
144
- typeof value === 'string' ||
145
- ArrayBuffer.isView(value) || // includes Uint8Array, Buffer, etc.
146
- value instanceof ArrayBuffer
147
- ) {
148
- parts.push(value);
149
- } else if (isBlobLike(value)) {
150
- parts.push(await value.arrayBuffer());
151
- } else if (
152
- isAsyncIterableIterator(value) // includes Readable, ReadableStream, etc.
153
- ) {
154
- for await (const chunk of value) {
155
- parts.push(chunk as BlobPart); // TODO, consider validating?
156
- }
157
- } else {
158
- throw new Error(
159
- `Unexpected data type: ${typeof value}; constructor: ${value?.constructor
160
- ?.name}; props: ${propsForError(value)}`,
161
- );
162
- }
163
-
164
- return parts;
165
- }
166
-
167
- function propsForError(value: any): string {
168
- const props = Object.getOwnPropertyNames(value);
169
- return `[${props.map((p) => `"${p}"`).join(', ')}]`;
170
- }
171
-
172
- function getName(value: any): string | undefined {
173
- return (
174
- getStringFromMaybeBuffer(value.name) ||
175
- getStringFromMaybeBuffer(value.filename) ||
176
- // For fs.ReadStream
177
- getStringFromMaybeBuffer(value.path)?.split(/[\\/]/).pop()
178
- );
179
- }
180
-
181
- const getStringFromMaybeBuffer = (x: string | Buffer | unknown): string | undefined => {
182
- if (typeof x === 'string') return x;
183
- if (typeof Buffer !== 'undefined' && x instanceof Buffer) return String(x);
184
- return undefined;
185
- };
186
-
187
- const isAsyncIterableIterator = (value: any): value is AsyncIterableIterator<unknown> =>
188
- value != null && typeof value === 'object' && typeof value[Symbol.asyncIterator] === 'function';
189
-
190
- export const isMultipartBody = (body: any): body is MultipartBody =>
191
- body && typeof body === 'object' && body.body && body[Symbol.toStringTag] === 'MultipartBody';
192
-
193
- /**
194
- * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
195
- * Otherwise returns the request as is.
196
- */
197
- export const maybeMultipartFormRequestOptions = async <T = Record<string, unknown>>(
198
- opts: RequestOptions<T>,
199
- ): Promise<RequestOptions<T | MultipartBody>> => {
200
- if (!hasUploadableValue(opts.body)) return opts;
201
-
202
- const form = await createForm(opts.body);
203
- return getMultipartRequestOptions(form, opts);
204
- };
205
-
206
- export const multipartFormRequestOptions = async <T = Record<string, unknown>>(
207
- opts: RequestOptions<T>,
208
- ): Promise<RequestOptions<T | MultipartBody>> => {
209
- const form = await createForm(opts.body);
210
- return getMultipartRequestOptions(form, opts);
211
- };
212
-
213
- export const createForm = async <T = Record<string, unknown>>(body: T | undefined): Promise<FormData> => {
214
- const form = new FormData();
215
- await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
216
- return form;
217
- };
218
-
219
- const hasUploadableValue = (value: unknown): boolean => {
220
- if (isUploadable(value)) return true;
221
- if (Array.isArray(value)) return value.some(hasUploadableValue);
222
- if (value && typeof value === 'object') {
223
- for (const k in value) {
224
- if (hasUploadableValue((value as any)[k])) return true;
225
- }
226
- }
227
- return false;
228
- };
229
-
230
- const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
231
- if (value === undefined) return;
232
- if (value == null) {
233
- throw new TypeError(
234
- `Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
235
- );
236
- }
237
-
238
- // TODO: make nested formats configurable
239
- if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
240
- form.append(key, String(value));
241
- } else if (isUploadable(value)) {
242
- const file = await toFile(value);
243
- form.append(key, file as File);
244
- } else if (Array.isArray(value)) {
245
- await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
246
- } else if (typeof value === 'object') {
247
- await Promise.all(
248
- Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
249
- );
250
- } else {
251
- throw new TypeError(
252
- `Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
253
- );
254
- }
255
- };
1
+ /** @deprecated Import from ./core/uploads instead */
2
+ export * from './core/uploads';
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '2.1.0'; // x-release-please-version
1
+ export const VERSION = '3.1.0'; // x-release-please-version
package/uploads.d.mts ADDED
@@ -0,0 +1,2 @@
1
+ export * from "./core/uploads.mjs";
2
+ //# sourceMappingURL=uploads.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
package/uploads.d.ts CHANGED
@@ -1,75 +1,2 @@
1
- import { type RequestOptions } from "./core.js";
2
- import { FormData, type Blob, type FilePropertyBag, type FsReadStream } from "./_shims/index.js";
3
- import { MultipartBody } from "./_shims/MultipartBody.js";
4
- export { fileFromPath } from "./_shims/index.js";
5
- type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
6
- export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
7
- /**
8
- * Typically, this is a native "File" class.
9
- *
10
- * We provide the {@link toFile} utility to convert a variety of objects
11
- * into the File class.
12
- *
13
- * For convenience, you can also pass a fetch Response, or in Node,
14
- * the result of fs.createReadStream().
15
- */
16
- export type Uploadable = FileLike | ResponseLike | FsReadStream;
17
- /**
18
- * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
19
- */
20
- export interface BlobLike {
21
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
22
- readonly size: number;
23
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
24
- readonly type: string;
25
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
26
- text(): Promise<string>;
27
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
28
- slice(start?: number, end?: number): BlobLike;
29
- }
30
- /**
31
- * Intended to match web.File, node.File, node-fetch.File, etc.
32
- */
33
- export interface FileLike extends BlobLike {
34
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
35
- readonly lastModified: number;
36
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
37
- readonly name: string;
38
- }
39
- /**
40
- * Intended to match web.Response, node.Response, node-fetch.Response, etc.
41
- */
42
- export interface ResponseLike {
43
- url: string;
44
- blob(): Promise<BlobLike>;
45
- }
46
- export declare const isResponseLike: (value: any) => value is ResponseLike;
47
- export declare const isFileLike: (value: any) => value is FileLike;
48
- /**
49
- * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
50
- * adds the arrayBuffer() method type because it is available and used at runtime
51
- */
52
- export declare const isBlobLike: (value: any) => value is BlobLike & {
53
- arrayBuffer(): Promise<ArrayBuffer>;
54
- };
55
- export declare const isUploadable: (value: any) => value is Uploadable;
56
- export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
57
- /**
58
- * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
59
- * @param value the raw content of the file. Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
60
- * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
61
- * @param {Object=} options additional properties
62
- * @param {string=} options.type the MIME type of the content
63
- * @param {number=} options.lastModified the last modified timestamp
64
- * @returns a {@link File} with the given properties
65
- */
66
- export declare function toFile(value: ToFileInput | PromiseLike<ToFileInput>, name?: string | null | undefined, options?: FilePropertyBag | undefined): Promise<FileLike>;
67
- export declare const isMultipartBody: (body: any) => body is MultipartBody;
68
- /**
69
- * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
70
- * Otherwise returns the request as is.
71
- */
72
- export declare const maybeMultipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
73
- export declare const multipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
74
- export declare const createForm: <T = Record<string, unknown>>(body: T | undefined) => Promise<FormData>;
1
+ export * from "./core/uploads.js";
75
2
  //# sourceMappingURL=uploads.d.ts.map
package/uploads.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EACL,QAAQ,EAER,KAAK,IAAI,EACT,KAAK,eAAe,EAEpB,KAAK,YAAY,EAElB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,KAAK,YAAY,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC9F,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,YAAY,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,6EAA6E;IAC7E,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAE/C;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,oFAAoF;IACpF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3B;AAED,eAAO,MAAM,cAAc,UAAW,GAAG,0BAIP,CAAC;AAEnC,eAAO,MAAM,UAAU,UAAW,GAAG,sBAKlB,CAAC;AAEpB;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,GAAG;mBAAwC,QAAQ,WAAW,CAAC;CAOxD,CAAC;AAE1C,eAAO,MAAM,YAAY,UAAW,GAAG,wBAEtC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAEnG;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAC1B,KAAK,EAAE,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,EAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,GACpC,OAAO,CAAC,QAAQ,CAAC,CAiCnB;AAmDD,eAAO,MAAM,eAAe,SAAU,GAAG,0BACsD,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,gCAAgC,sGAO5C,CAAC;AAEF,eAAO,MAAM,2BAA2B,sGAKvC,CAAC;AAEF,eAAO,MAAM,UAAU,wDAA6D,QAAQ,QAAQ,CAInG,CAAC"}
1
+ {"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}