@backblaze-labs/b2-sdk 0.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 (512) hide show
  1. package/CHANGELOG.md +121 -0
  2. package/LICENSE +21 -0
  3. package/README.md +664 -0
  4. package/dist/auth/account-info.d.cts +51 -0
  5. package/dist/auth/account-info.d.cts.map +1 -0
  6. package/dist/auth/account-info.d.ts +51 -0
  7. package/dist/auth/account-info.d.ts.map +1 -0
  8. package/dist/auth/file.cjs +210 -0
  9. package/dist/auth/file.cjs.map +1 -0
  10. package/dist/auth/file.d.cts +157 -0
  11. package/dist/auth/file.d.cts.map +1 -0
  12. package/dist/auth/file.d.ts +157 -0
  13. package/dist/auth/file.d.ts.map +1 -0
  14. package/dist/auth/file.js +210 -0
  15. package/dist/auth/file.js.map +1 -0
  16. package/dist/auth/in-memory.cjs +184 -0
  17. package/dist/auth/in-memory.cjs.map +1 -0
  18. package/dist/auth/in-memory.d.cts +147 -0
  19. package/dist/auth/in-memory.d.cts.map +1 -0
  20. package/dist/auth/in-memory.d.ts +147 -0
  21. package/dist/auth/in-memory.d.ts.map +1 -0
  22. package/dist/auth/in-memory.js +184 -0
  23. package/dist/auth/in-memory.js.map +1 -0
  24. package/dist/auth/index.cjs +10 -0
  25. package/dist/auth/index.cjs.map +1 -0
  26. package/dist/auth/index.d.cts +6 -0
  27. package/dist/auth/index.d.cts.map +1 -0
  28. package/dist/auth/index.d.ts +6 -0
  29. package/dist/auth/index.d.ts.map +1 -0
  30. package/dist/auth/index.js +10 -0
  31. package/dist/auth/index.js.map +1 -0
  32. package/dist/auth/realms.cjs +12 -0
  33. package/dist/auth/realms.cjs.map +1 -0
  34. package/dist/auth/realms.d.cts +12 -0
  35. package/dist/auth/realms.d.cts.map +1 -0
  36. package/dist/auth/realms.d.ts +12 -0
  37. package/dist/auth/realms.d.ts.map +1 -0
  38. package/dist/auth/realms.js +12 -0
  39. package/dist/auth/realms.js.map +1 -0
  40. package/dist/auth/upload-url-pool.cjs +52 -0
  41. package/dist/auth/upload-url-pool.cjs.map +1 -0
  42. package/dist/auth/upload-url-pool.d.cts +35 -0
  43. package/dist/auth/upload-url-pool.d.cts.map +1 -0
  44. package/dist/auth/upload-url-pool.d.ts +35 -0
  45. package/dist/auth/upload-url-pool.d.ts.map +1 -0
  46. package/dist/auth/upload-url-pool.js +52 -0
  47. package/dist/auth/upload-url-pool.js.map +1 -0
  48. package/dist/bucket.cjs +789 -0
  49. package/dist/bucket.cjs.map +1 -0
  50. package/dist/bucket.d.cts +659 -0
  51. package/dist/bucket.d.cts.map +1 -0
  52. package/dist/bucket.d.ts +659 -0
  53. package/dist/bucket.d.ts.map +1 -0
  54. package/dist/bucket.js +789 -0
  55. package/dist/bucket.js.map +1 -0
  56. package/dist/client.cjs +230 -0
  57. package/dist/client.cjs.map +1 -0
  58. package/dist/client.d.cts +222 -0
  59. package/dist/client.d.cts.map +1 -0
  60. package/dist/client.d.ts +222 -0
  61. package/dist/client.d.ts.map +1 -0
  62. package/dist/client.js +230 -0
  63. package/dist/client.js.map +1 -0
  64. package/dist/copy/large.cjs +74 -0
  65. package/dist/copy/large.cjs.map +1 -0
  66. package/dist/copy/large.d.cts +53 -0
  67. package/dist/copy/large.d.cts.map +1 -0
  68. package/dist/copy/large.d.ts +53 -0
  69. package/dist/copy/large.d.ts.map +1 -0
  70. package/dist/copy/large.js +74 -0
  71. package/dist/copy/large.js.map +1 -0
  72. package/dist/download/parallel.cjs +122 -0
  73. package/dist/download/parallel.cjs.map +1 -0
  74. package/dist/download/parallel.d.cts +42 -0
  75. package/dist/download/parallel.d.cts.map +1 -0
  76. package/dist/download/parallel.d.ts +42 -0
  77. package/dist/download/parallel.d.ts.map +1 -0
  78. package/dist/download/parallel.js +122 -0
  79. package/dist/download/parallel.js.map +1 -0
  80. package/dist/download/single.cjs +117 -0
  81. package/dist/download/single.cjs.map +1 -0
  82. package/dist/download/single.d.cts +152 -0
  83. package/dist/download/single.d.cts.map +1 -0
  84. package/dist/download/single.d.ts +152 -0
  85. package/dist/download/single.d.ts.map +1 -0
  86. package/dist/download/single.js +117 -0
  87. package/dist/download/single.js.map +1 -0
  88. package/dist/errors/index.cjs +268 -0
  89. package/dist/errors/index.cjs.map +1 -0
  90. package/dist/errors/index.d.cts +264 -0
  91. package/dist/errors/index.d.cts.map +1 -0
  92. package/dist/errors/index.d.ts +264 -0
  93. package/dist/errors/index.d.ts.map +1 -0
  94. package/dist/errors/index.js +268 -0
  95. package/dist/errors/index.js.map +1 -0
  96. package/dist/http/retry.cjs +36 -0
  97. package/dist/http/retry.cjs.map +1 -0
  98. package/dist/http/retry.d.cts +34 -0
  99. package/dist/http/retry.d.cts.map +1 -0
  100. package/dist/http/retry.d.ts +34 -0
  101. package/dist/http/retry.d.ts.map +1 -0
  102. package/dist/http/retry.js +36 -0
  103. package/dist/http/retry.js.map +1 -0
  104. package/dist/http/transport.cjs +143 -0
  105. package/dist/http/transport.cjs.map +1 -0
  106. package/dist/http/transport.d.cts +122 -0
  107. package/dist/http/transport.d.cts.map +1 -0
  108. package/dist/http/transport.d.ts +122 -0
  109. package/dist/http/transport.d.ts.map +1 -0
  110. package/dist/http/transport.js +143 -0
  111. package/dist/http/transport.js.map +1 -0
  112. package/dist/http/url-guard.cjs +97 -0
  113. package/dist/http/url-guard.cjs.map +1 -0
  114. package/dist/http/url-guard.d.cts +88 -0
  115. package/dist/http/url-guard.d.cts.map +1 -0
  116. package/dist/http/url-guard.d.ts +88 -0
  117. package/dist/http/url-guard.d.ts.map +1 -0
  118. package/dist/http/url-guard.js +97 -0
  119. package/dist/http/url-guard.js.map +1 -0
  120. package/dist/http/user-agent.cjs +51 -0
  121. package/dist/http/user-agent.cjs.map +1 -0
  122. package/dist/http/user-agent.d.cts +28 -0
  123. package/dist/http/user-agent.d.cts.map +1 -0
  124. package/dist/http/user-agent.d.ts +28 -0
  125. package/dist/http/user-agent.d.ts.map +1 -0
  126. package/dist/http/user-agent.js +51 -0
  127. package/dist/http/user-agent.js.map +1 -0
  128. package/dist/index.cjs +78 -0
  129. package/dist/index.cjs.map +1 -0
  130. package/dist/index.d.cts +39 -0
  131. package/dist/index.d.cts.map +1 -0
  132. package/dist/index.d.ts +39 -0
  133. package/dist/index.d.ts.map +1 -0
  134. package/dist/index.js +78 -0
  135. package/dist/index.js.map +1 -0
  136. package/dist/notifications/index.cjs +7 -0
  137. package/dist/notifications/index.cjs.map +1 -0
  138. package/dist/notifications/index.d.cts +3 -0
  139. package/dist/notifications/index.d.cts.map +1 -0
  140. package/dist/notifications/index.d.ts +3 -0
  141. package/dist/notifications/index.d.ts.map +1 -0
  142. package/dist/notifications/index.js +7 -0
  143. package/dist/notifications/index.js.map +1 -0
  144. package/dist/notifications/webhook.cjs +106 -0
  145. package/dist/notifications/webhook.cjs.map +1 -0
  146. package/dist/notifications/webhook.d.cts +146 -0
  147. package/dist/notifications/webhook.d.cts.map +1 -0
  148. package/dist/notifications/webhook.d.ts +146 -0
  149. package/dist/notifications/webhook.d.ts.map +1 -0
  150. package/dist/notifications/webhook.js +106 -0
  151. package/dist/notifications/webhook.js.map +1 -0
  152. package/dist/object.cjs +212 -0
  153. package/dist/object.cjs.map +1 -0
  154. package/dist/object.d.cts +263 -0
  155. package/dist/object.d.cts.map +1 -0
  156. package/dist/object.d.ts +263 -0
  157. package/dist/object.d.ts.map +1 -0
  158. package/dist/object.js +212 -0
  159. package/dist/object.js.map +1 -0
  160. package/dist/package.json.cjs +9 -0
  161. package/dist/package.json.cjs.map +1 -0
  162. package/dist/package.json.js +9 -0
  163. package/dist/package.json.js.map +1 -0
  164. package/dist/raw/encoding.cjs +47 -0
  165. package/dist/raw/encoding.cjs.map +1 -0
  166. package/dist/raw/encoding.d.cts +46 -0
  167. package/dist/raw/encoding.d.cts.map +1 -0
  168. package/dist/raw/encoding.d.ts +46 -0
  169. package/dist/raw/encoding.d.ts.map +1 -0
  170. package/dist/raw/encoding.js +47 -0
  171. package/dist/raw/encoding.js.map +1 -0
  172. package/dist/raw/index.cjs +600 -0
  173. package/dist/raw/index.cjs.map +1 -0
  174. package/dist/raw/index.d.cts +381 -0
  175. package/dist/raw/index.d.cts.map +1 -0
  176. package/dist/raw/index.d.ts +381 -0
  177. package/dist/raw/index.d.ts.map +1 -0
  178. package/dist/raw/index.js +601 -0
  179. package/dist/raw/index.js.map +1 -0
  180. package/dist/s3/index.cjs +23 -0
  181. package/dist/s3/index.cjs.map +1 -0
  182. package/dist/s3/index.d.cts +74 -0
  183. package/dist/s3/index.d.cts.map +1 -0
  184. package/dist/s3/index.d.ts +74 -0
  185. package/dist/s3/index.d.ts.map +1 -0
  186. package/dist/s3/index.js +23 -0
  187. package/dist/s3/index.js.map +1 -0
  188. package/dist/simulator/capabilities.cjs +53 -0
  189. package/dist/simulator/capabilities.cjs.map +1 -0
  190. package/dist/simulator/capabilities.d.cts +15 -0
  191. package/dist/simulator/capabilities.d.cts.map +1 -0
  192. package/dist/simulator/capabilities.d.ts +15 -0
  193. package/dist/simulator/capabilities.d.ts.map +1 -0
  194. package/dist/simulator/capabilities.js +53 -0
  195. package/dist/simulator/capabilities.js.map +1 -0
  196. package/dist/simulator/index.cjs +1559 -0
  197. package/dist/simulator/index.cjs.map +1 -0
  198. package/dist/simulator/index.d.cts +495 -0
  199. package/dist/simulator/index.d.cts.map +1 -0
  200. package/dist/simulator/index.d.ts +495 -0
  201. package/dist/simulator/index.d.ts.map +1 -0
  202. package/dist/simulator/index.js +1560 -0
  203. package/dist/simulator/index.js.map +1 -0
  204. package/dist/simulator/validation.cjs +174 -0
  205. package/dist/simulator/validation.cjs.map +1 -0
  206. package/dist/simulator/validation.d.cts +104 -0
  207. package/dist/simulator/validation.d.cts.map +1 -0
  208. package/dist/simulator/validation.d.ts +104 -0
  209. package/dist/simulator/validation.d.ts.map +1 -0
  210. package/dist/simulator/validation.js +174 -0
  211. package/dist/simulator/validation.js.map +1 -0
  212. package/dist/streams/collect.cjs +26 -0
  213. package/dist/streams/collect.cjs.map +1 -0
  214. package/dist/streams/collect.d.cts +18 -0
  215. package/dist/streams/collect.d.cts.map +1 -0
  216. package/dist/streams/collect.d.ts +18 -0
  217. package/dist/streams/collect.d.ts.map +1 -0
  218. package/dist/streams/collect.js +26 -0
  219. package/dist/streams/collect.js.map +1 -0
  220. package/dist/streams/hash.cjs +123 -0
  221. package/dist/streams/hash.cjs.map +1 -0
  222. package/dist/streams/hash.d.cts +42 -0
  223. package/dist/streams/hash.d.cts.map +1 -0
  224. package/dist/streams/hash.d.ts +42 -0
  225. package/dist/streams/hash.d.ts.map +1 -0
  226. package/dist/streams/hash.js +101 -0
  227. package/dist/streams/hash.js.map +1 -0
  228. package/dist/streams/index.cjs +13 -0
  229. package/dist/streams/index.cjs.map +1 -0
  230. package/dist/streams/index.d.cts +7 -0
  231. package/dist/streams/index.d.cts.map +1 -0
  232. package/dist/streams/index.d.ts +7 -0
  233. package/dist/streams/index.d.ts.map +1 -0
  234. package/dist/streams/index.js +13 -0
  235. package/dist/streams/index.js.map +1 -0
  236. package/dist/streams/progress.cjs +47 -0
  237. package/dist/streams/progress.cjs.map +1 -0
  238. package/dist/streams/progress.d.cts +53 -0
  239. package/dist/streams/progress.d.cts.map +1 -0
  240. package/dist/streams/progress.d.ts +53 -0
  241. package/dist/streams/progress.d.ts.map +1 -0
  242. package/dist/streams/progress.js +47 -0
  243. package/dist/streams/progress.js.map +1 -0
  244. package/dist/streams/source.cjs +155 -0
  245. package/dist/streams/source.cjs.map +1 -0
  246. package/dist/streams/source.d.cts +140 -0
  247. package/dist/streams/source.d.cts.map +1 -0
  248. package/dist/streams/source.d.ts +140 -0
  249. package/dist/streams/source.d.ts.map +1 -0
  250. package/dist/streams/source.js +155 -0
  251. package/dist/streams/source.js.map +1 -0
  252. package/dist/sync/actions/index.cjs +191 -0
  253. package/dist/sync/actions/index.cjs.map +1 -0
  254. package/dist/sync/actions/index.d.cts +167 -0
  255. package/dist/sync/actions/index.d.cts.map +1 -0
  256. package/dist/sync/actions/index.d.ts +167 -0
  257. package/dist/sync/actions/index.d.ts.map +1 -0
  258. package/dist/sync/actions/index.js +191 -0
  259. package/dist/sync/actions/index.js.map +1 -0
  260. package/dist/sync/index.cjs +23 -0
  261. package/dist/sync/index.cjs.map +1 -0
  262. package/dist/sync/index.d.cts +21 -0
  263. package/dist/sync/index.d.cts.map +1 -0
  264. package/dist/sync/index.d.ts +21 -0
  265. package/dist/sync/index.d.ts.map +1 -0
  266. package/dist/sync/index.js +23 -0
  267. package/dist/sync/index.js.map +1 -0
  268. package/dist/sync/pairing.cjs +31 -0
  269. package/dist/sync/pairing.cjs.map +1 -0
  270. package/dist/sync/pairing.d.cts +13 -0
  271. package/dist/sync/pairing.d.cts.map +1 -0
  272. package/dist/sync/pairing.d.ts +13 -0
  273. package/dist/sync/pairing.d.ts.map +1 -0
  274. package/dist/sync/pairing.js +31 -0
  275. package/dist/sync/pairing.js.map +1 -0
  276. package/dist/sync/policies/compare.cjs +14 -0
  277. package/dist/sync/policies/compare.cjs.map +1 -0
  278. package/dist/sync/policies/compare.d.cts +13 -0
  279. package/dist/sync/policies/compare.d.cts.map +1 -0
  280. package/dist/sync/policies/compare.d.ts +13 -0
  281. package/dist/sync/policies/compare.d.ts.map +1 -0
  282. package/dist/sync/policies/compare.js +14 -0
  283. package/dist/sync/policies/compare.js.map +1 -0
  284. package/dist/sync/policies/index.cjs +74 -0
  285. package/dist/sync/policies/index.cjs.map +1 -0
  286. package/dist/sync/policies/index.d.cts +42 -0
  287. package/dist/sync/policies/index.d.cts.map +1 -0
  288. package/dist/sync/policies/index.d.ts +42 -0
  289. package/dist/sync/policies/index.d.ts.map +1 -0
  290. package/dist/sync/policies/index.js +74 -0
  291. package/dist/sync/policies/index.js.map +1 -0
  292. package/dist/sync/scanners/b2.cjs +57 -0
  293. package/dist/sync/scanners/b2.cjs.map +1 -0
  294. package/dist/sync/scanners/b2.d.cts +20 -0
  295. package/dist/sync/scanners/b2.d.cts.map +1 -0
  296. package/dist/sync/scanners/b2.d.ts +20 -0
  297. package/dist/sync/scanners/b2.d.ts.map +1 -0
  298. package/dist/sync/scanners/b2.js +57 -0
  299. package/dist/sync/scanners/b2.js.map +1 -0
  300. package/dist/sync/scanners/local.cjs +58 -0
  301. package/dist/sync/scanners/local.cjs.map +1 -0
  302. package/dist/sync/scanners/local.d.cts +24 -0
  303. package/dist/sync/scanners/local.d.cts.map +1 -0
  304. package/dist/sync/scanners/local.d.ts +24 -0
  305. package/dist/sync/scanners/local.d.ts.map +1 -0
  306. package/dist/sync/scanners/local.js +58 -0
  307. package/dist/sync/scanners/local.js.map +1 -0
  308. package/dist/sync/synchronizer.cjs +203 -0
  309. package/dist/sync/synchronizer.cjs.map +1 -0
  310. package/dist/sync/synchronizer.d.cts +52 -0
  311. package/dist/sync/synchronizer.d.cts.map +1 -0
  312. package/dist/sync/synchronizer.d.ts +52 -0
  313. package/dist/sync/synchronizer.d.ts.map +1 -0
  314. package/dist/sync/synchronizer.js +181 -0
  315. package/dist/sync/synchronizer.js.map +1 -0
  316. package/dist/sync/types.d.cts +121 -0
  317. package/dist/sync/types.d.cts.map +1 -0
  318. package/dist/sync/types.d.ts +121 -0
  319. package/dist/sync/types.d.ts.map +1 -0
  320. package/dist/types/auth.cjs +58 -0
  321. package/dist/types/auth.cjs.map +1 -0
  322. package/dist/types/auth.d.cts +150 -0
  323. package/dist/types/auth.d.cts.map +1 -0
  324. package/dist/types/auth.d.ts +150 -0
  325. package/dist/types/auth.d.ts.map +1 -0
  326. package/dist/types/auth.js +58 -0
  327. package/dist/types/auth.js.map +1 -0
  328. package/dist/types/bucket.cjs +44 -0
  329. package/dist/types/bucket.cjs.map +1 -0
  330. package/dist/types/bucket.d.cts +245 -0
  331. package/dist/types/bucket.d.cts.map +1 -0
  332. package/dist/types/bucket.d.ts +245 -0
  333. package/dist/types/bucket.d.ts.map +1 -0
  334. package/dist/types/bucket.js +44 -0
  335. package/dist/types/bucket.js.map +1 -0
  336. package/dist/types/download.d.cts +110 -0
  337. package/dist/types/download.d.cts.map +1 -0
  338. package/dist/types/download.d.ts +110 -0
  339. package/dist/types/download.d.ts.map +1 -0
  340. package/dist/types/encryption.cjs +343 -0
  341. package/dist/types/encryption.cjs.map +1 -0
  342. package/dist/types/encryption.d.cts +132 -0
  343. package/dist/types/encryption.d.cts.map +1 -0
  344. package/dist/types/encryption.d.ts +132 -0
  345. package/dist/types/encryption.d.ts.map +1 -0
  346. package/dist/types/encryption.js +321 -0
  347. package/dist/types/encryption.js.map +1 -0
  348. package/dist/types/errors.d.cts +16 -0
  349. package/dist/types/errors.d.cts.map +1 -0
  350. package/dist/types/errors.d.ts +16 -0
  351. package/dist/types/errors.d.ts.map +1 -0
  352. package/dist/types/file.cjs +23 -0
  353. package/dist/types/file.cjs.map +1 -0
  354. package/dist/types/file.d.cts +220 -0
  355. package/dist/types/file.d.cts.map +1 -0
  356. package/dist/types/file.d.ts +220 -0
  357. package/dist/types/file.d.ts.map +1 -0
  358. package/dist/types/file.js +23 -0
  359. package/dist/types/file.js.map +1 -0
  360. package/dist/types/ids.cjs +27 -0
  361. package/dist/types/ids.cjs.map +1 -0
  362. package/dist/types/ids.d.cts +84 -0
  363. package/dist/types/ids.d.cts.map +1 -0
  364. package/dist/types/ids.d.ts +84 -0
  365. package/dist/types/ids.d.ts.map +1 -0
  366. package/dist/types/ids.js +27 -0
  367. package/dist/types/ids.js.map +1 -0
  368. package/dist/types/index.d.cts +25 -0
  369. package/dist/types/index.d.cts.map +1 -0
  370. package/dist/types/index.d.ts +25 -0
  371. package/dist/types/index.d.ts.map +1 -0
  372. package/dist/types/key.d.cts +84 -0
  373. package/dist/types/key.d.cts.map +1 -0
  374. package/dist/types/key.d.ts +84 -0
  375. package/dist/types/key.d.ts.map +1 -0
  376. package/dist/types/lock.cjs +17 -0
  377. package/dist/types/lock.cjs.map +1 -0
  378. package/dist/types/lock.d.cts +92 -0
  379. package/dist/types/lock.d.cts.map +1 -0
  380. package/dist/types/lock.d.ts +92 -0
  381. package/dist/types/lock.d.ts.map +1 -0
  382. package/dist/types/lock.js +17 -0
  383. package/dist/types/lock.js.map +1 -0
  384. package/dist/types/notifications.cjs +24 -0
  385. package/dist/types/notifications.cjs.map +1 -0
  386. package/dist/types/notifications.d.cts +97 -0
  387. package/dist/types/notifications.d.cts.map +1 -0
  388. package/dist/types/notifications.d.ts +97 -0
  389. package/dist/types/notifications.d.ts.map +1 -0
  390. package/dist/types/notifications.js +24 -0
  391. package/dist/types/notifications.js.map +1 -0
  392. package/dist/types/replication.d.cts +42 -0
  393. package/dist/types/replication.d.cts.map +1 -0
  394. package/dist/types/replication.d.ts +42 -0
  395. package/dist/types/replication.d.ts.map +1 -0
  396. package/dist/types/upload.d.cts +219 -0
  397. package/dist/types/upload.d.cts.map +1 -0
  398. package/dist/types/upload.d.ts +219 -0
  399. package/dist/types/upload.d.ts.map +1 -0
  400. package/dist/upload/cancel.cjs +10 -0
  401. package/dist/upload/cancel.cjs.map +1 -0
  402. package/dist/upload/cancel.d.cts +23 -0
  403. package/dist/upload/cancel.d.cts.map +1 -0
  404. package/dist/upload/cancel.d.ts +23 -0
  405. package/dist/upload/cancel.d.ts.map +1 -0
  406. package/dist/upload/cancel.js +10 -0
  407. package/dist/upload/cancel.js.map +1 -0
  408. package/dist/upload/concurrency.cjs +54 -0
  409. package/dist/upload/concurrency.cjs.map +1 -0
  410. package/dist/upload/concurrency.d.cts +46 -0
  411. package/dist/upload/concurrency.d.cts.map +1 -0
  412. package/dist/upload/concurrency.d.ts +46 -0
  413. package/dist/upload/concurrency.d.ts.map +1 -0
  414. package/dist/upload/concurrency.js +54 -0
  415. package/dist/upload/concurrency.js.map +1 -0
  416. package/dist/upload/large.cjs +222 -0
  417. package/dist/upload/large.cjs.map +1 -0
  418. package/dist/upload/large.d.cts +71 -0
  419. package/dist/upload/large.d.cts.map +1 -0
  420. package/dist/upload/large.d.ts +71 -0
  421. package/dist/upload/large.d.ts.map +1 -0
  422. package/dist/upload/large.js +222 -0
  423. package/dist/upload/large.js.map +1 -0
  424. package/dist/upload/resume.cjs +34 -0
  425. package/dist/upload/resume.cjs.map +1 -0
  426. package/dist/upload/resume.d.cts +33 -0
  427. package/dist/upload/resume.d.cts.map +1 -0
  428. package/dist/upload/resume.d.ts +33 -0
  429. package/dist/upload/resume.d.ts.map +1 -0
  430. package/dist/upload/resume.js +34 -0
  431. package/dist/upload/resume.js.map +1 -0
  432. package/dist/upload/single.cjs +47 -0
  433. package/dist/upload/single.cjs.map +1 -0
  434. package/dist/upload/single.d.cts +51 -0
  435. package/dist/upload/single.d.cts.map +1 -0
  436. package/dist/upload/single.d.ts +51 -0
  437. package/dist/upload/single.d.ts.map +1 -0
  438. package/dist/upload/single.js +47 -0
  439. package/dist/upload/single.js.map +1 -0
  440. package/dist/upload/stream.cjs +198 -0
  441. package/dist/upload/stream.cjs.map +1 -0
  442. package/dist/upload/stream.d.cts +61 -0
  443. package/dist/upload/stream.d.cts.map +1 -0
  444. package/dist/upload/stream.d.ts +61 -0
  445. package/dist/upload/stream.d.ts.map +1 -0
  446. package/dist/upload/stream.js +198 -0
  447. package/dist/upload/stream.js.map +1 -0
  448. package/dist/util/best-effort.cjs +10 -0
  449. package/dist/util/best-effort.cjs.map +1 -0
  450. package/dist/util/best-effort.d.cts +31 -0
  451. package/dist/util/best-effort.d.cts.map +1 -0
  452. package/dist/util/best-effort.d.ts +31 -0
  453. package/dist/util/best-effort.d.ts.map +1 -0
  454. package/dist/util/best-effort.js +10 -0
  455. package/dist/util/best-effort.js.map +1 -0
  456. package/dist/util/defaults.cjs +11 -0
  457. package/dist/util/defaults.cjs.map +1 -0
  458. package/dist/util/defaults.d.cts +54 -0
  459. package/dist/util/defaults.d.cts.map +1 -0
  460. package/dist/util/defaults.d.ts +54 -0
  461. package/dist/util/defaults.d.ts.map +1 -0
  462. package/dist/util/defaults.js +11 -0
  463. package/dist/util/defaults.js.map +1 -0
  464. package/dist/util/normalize.cjs +16 -0
  465. package/dist/util/normalize.cjs.map +1 -0
  466. package/dist/util/normalize.d.cts +62 -0
  467. package/dist/util/normalize.d.cts.map +1 -0
  468. package/dist/util/normalize.d.ts +62 -0
  469. package/dist/util/normalize.d.ts.map +1 -0
  470. package/dist/util/normalize.js +16 -0
  471. package/dist/util/normalize.js.map +1 -0
  472. package/dist/util/paginator.cjs +20 -0
  473. package/dist/util/paginator.cjs.map +1 -0
  474. package/dist/util/paginator.d.cts +120 -0
  475. package/dist/util/paginator.d.cts.map +1 -0
  476. package/dist/util/paginator.d.ts +120 -0
  477. package/dist/util/paginator.d.ts.map +1 -0
  478. package/dist/util/paginator.js +20 -0
  479. package/dist/util/paginator.js.map +1 -0
  480. package/dist/util/plan-ranges.cjs +28 -0
  481. package/dist/util/plan-ranges.cjs.map +1 -0
  482. package/dist/util/plan-ranges.d.cts +56 -0
  483. package/dist/util/plan-ranges.d.cts.map +1 -0
  484. package/dist/util/plan-ranges.d.ts +56 -0
  485. package/dist/util/plan-ranges.d.ts.map +1 -0
  486. package/dist/util/plan-ranges.js +28 -0
  487. package/dist/util/plan-ranges.js.map +1 -0
  488. package/dist/util/text-codec.cjs +7 -0
  489. package/dist/util/text-codec.cjs.map +1 -0
  490. package/dist/util/text-codec.d.cts +26 -0
  491. package/dist/util/text-codec.d.cts.map +1 -0
  492. package/dist/util/text-codec.d.ts +26 -0
  493. package/dist/util/text-codec.d.ts.map +1 -0
  494. package/dist/util/text-codec.js +7 -0
  495. package/dist/util/text-codec.js.map +1 -0
  496. package/dist/util/to-error.cjs +7 -0
  497. package/dist/util/to-error.cjs.map +1 -0
  498. package/dist/util/to-error.d.cts +15 -0
  499. package/dist/util/to-error.d.cts.map +1 -0
  500. package/dist/util/to-error.d.ts +15 -0
  501. package/dist/util/to-error.d.ts.map +1 -0
  502. package/dist/util/to-error.js +7 -0
  503. package/dist/util/to-error.js.map +1 -0
  504. package/dist/version.cjs +6 -0
  505. package/dist/version.cjs.map +1 -0
  506. package/dist/version.d.cts +14 -0
  507. package/dist/version.d.cts.map +1 -0
  508. package/dist/version.d.ts +14 -0
  509. package/dist/version.d.ts.map +1 -0
  510. package/dist/version.js +6 -0
  511. package/dist/version.js.map +1 -0
  512. package/package.json +198 -0
@@ -0,0 +1,381 @@
1
+ import { HttpTransport } from '../http/transport.js';
2
+ import { ApplicationKey, AuthorizeAccountResponse, BucketInfo, CancelLargeFileRequest, CancelLargeFileResponse, CopyFileRequest, CopyPartRequest, CopyPartResponse, CreateBucketRequest, CreateKeyRequest, DeleteBucketRequest, DeleteFileVersionRequest, DeleteFileVersionResponse, DeleteKeyRequest, DownloadAuthorizationRequest, DownloadAuthorizationResponse, FileVersion, FinishLargeFileRequest, FullApplicationKey, GetBucketNotificationRulesRequest, GetBucketNotificationRulesResponse, GetFileInfoRequest, GetUploadPartUrlRequest, GetUploadPartUrlResponse, GetUploadUrlRequest, GetUploadUrlResponse, HideFileRequest, ListBucketsRequest, ListBucketsResponse, ListFileNamesRequest, ListFileNamesResponse, ListFileVersionsRequest, ListFileVersionsResponse, ListKeysRequest, ListKeysResponse, ListPartsRequest, ListPartsResponse, ListUnfinishedLargeFilesRequest, ListUnfinishedLargeFilesResponse, SetBucketNotificationRulesRequest, SetBucketNotificationRulesResponse, StartLargeFileRequest, StartLargeFileResponse, UpdateBucketRequest, UpdateFileLegalHoldRequest, UpdateFileLegalHoldResponse, UpdateFileRetentionRequest, UpdateFileRetentionResponse } from '../types/index.js';
3
+ import { UploadFileHeaders, UploadPartHeaders, UploadPartResponse } from '../types/upload.js';
4
+ import { EncryptionAlgorithm } from '../types/encryption.js';
5
+ /** Configuration for constructing a {@link RawClient}. */
6
+ export interface RawClientOptions {
7
+ /** The HTTP transport used to send requests (e.g., FetchTransport or RetryTransport). */
8
+ readonly transport: HttpTransport;
9
+ }
10
+ /**
11
+ * Low-level client providing 1:1 bindings to all B2 native API endpoints.
12
+ *
13
+ * Each method maps directly to a single B2 API call. Most methods accept
14
+ * `(apiUrl, authToken, request)` and return the JSON response. Upload and
15
+ * download methods accept endpoint-specific parameters instead.
16
+ */
17
+ export declare class RawClient {
18
+ /** @internal */
19
+ private readonly transport;
20
+ /**
21
+ * Creates a new RawClient with the given transport.
22
+ * @param options - The constructor configuration.
23
+ */
24
+ constructor(options: RawClientOptions);
25
+ /**
26
+ * Calls {@link https://www.backblaze.com/apidocs/b2-authorize-account | b2_authorize_account}.
27
+ * @param applicationKeyId - The application key ID for authentication.
28
+ * @param applicationKey - The application key secret.
29
+ * @param realmUrl - The B2 realm URL to authenticate against.
30
+ *
31
+ * @returns The authorization response with API URLs and credentials.
32
+ */
33
+ authorizeAccount(applicationKeyId: string, applicationKey: string, realmUrl?: string): Promise<AuthorizeAccountResponse>;
34
+ /**
35
+ * Calls {@link https://www.backblaze.com/apidocs/b2-create-bucket | b2_create_bucket}.
36
+ * @param apiUrl - The B2 API base URL.
37
+ * @param authToken - The authorization token.
38
+ * @param request - The API request parameters.
39
+ *
40
+ * @returns The created bucket metadata.
41
+ */
42
+ createBucket(apiUrl: string, authToken: string, request: CreateBucketRequest): Promise<BucketInfo>;
43
+ /**
44
+ * Calls {@link https://www.backblaze.com/apidocs/b2-delete-bucket | b2_delete_bucket}.
45
+ * @param apiUrl - The B2 API base URL.
46
+ * @param authToken - The authorization token.
47
+ * @param request - The API request parameters.
48
+ *
49
+ * @returns The deleted bucket metadata.
50
+ */
51
+ deleteBucket(apiUrl: string, authToken: string, request: DeleteBucketRequest): Promise<BucketInfo>;
52
+ /**
53
+ * Calls {@link https://www.backblaze.com/apidocs/b2-list-buckets | b2_list_buckets}.
54
+ * @param apiUrl - The B2 API base URL.
55
+ * @param authToken - The authorization token.
56
+ * @param request - The API request parameters.
57
+ *
58
+ * @returns The list of matching buckets.
59
+ */
60
+ listBuckets(apiUrl: string, authToken: string, request: ListBucketsRequest): Promise<ListBucketsResponse>;
61
+ /**
62
+ * Calls {@link https://www.backblaze.com/apidocs/b2-update-bucket | b2_update_bucket}.
63
+ * @param apiUrl - The B2 API base URL.
64
+ * @param authToken - The authorization token.
65
+ * @param request - The API request parameters.
66
+ *
67
+ * @returns The updated bucket metadata.
68
+ */
69
+ updateBucket(apiUrl: string, authToken: string, request: UpdateBucketRequest): Promise<BucketInfo>;
70
+ /**
71
+ * Calls {@link https://www.backblaze.com/apidocs/b2-get-upload-url | b2_get_upload_url}.
72
+ * @param apiUrl - The B2 API base URL.
73
+ * @param authToken - The authorization token.
74
+ * @param request - The API request parameters.
75
+ *
76
+ * @returns The upload URL and authorization token.
77
+ */
78
+ getUploadUrl(apiUrl: string, authToken: string, request: GetUploadUrlRequest): Promise<GetUploadUrlResponse>;
79
+ /**
80
+ * Calls {@link https://www.backblaze.com/apidocs/b2-upload-file | b2_upload_file}.
81
+ *
82
+ * Unlike most methods, this posts directly to the `uploadUrl` obtained
83
+ * from {@link getUploadUrl} rather than the API URL.
84
+ * @param uploadUrl - The upload endpoint URL.
85
+ * @param headers - The request headers including authorization and content metadata.
86
+ * @param body - The file data to upload.
87
+ * @param signal - An optional abort signal for cancellation.
88
+ *
89
+ * @returns The uploaded file version metadata.
90
+ */
91
+ uploadFile(uploadUrl: string, headers: UploadFileHeaders, body: BodyInit, signal?: AbortSignal): Promise<FileVersion>;
92
+ /**
93
+ * Calls {@link https://www.backblaze.com/apidocs/b2-list-file-names | b2_list_file_names}.
94
+ * @param apiUrl - The B2 API base URL.
95
+ * @param authToken - The authorization token.
96
+ * @param request - The API request parameters.
97
+ *
98
+ * @returns The list of file names and optional continuation token.
99
+ */
100
+ listFileNames(apiUrl: string, authToken: string, request: ListFileNamesRequest): Promise<ListFileNamesResponse>;
101
+ /**
102
+ * Calls {@link https://www.backblaze.com/apidocs/b2-list-file-versions | b2_list_file_versions}.
103
+ * @param apiUrl - The B2 API base URL.
104
+ * @param authToken - The authorization token.
105
+ * @param request - The API request parameters.
106
+ *
107
+ * @returns The list of file versions and optional continuation token.
108
+ */
109
+ listFileVersions(apiUrl: string, authToken: string, request: ListFileVersionsRequest): Promise<ListFileVersionsResponse>;
110
+ /**
111
+ * Calls {@link https://www.backblaze.com/apidocs/b2-get-file-info | b2_get_file_info}.
112
+ * @param apiUrl - The B2 API base URL.
113
+ * @param authToken - The authorization token.
114
+ * @param request - The API request parameters.
115
+ *
116
+ * @returns The file version metadata.
117
+ */
118
+ getFileInfo(apiUrl: string, authToken: string, request: GetFileInfoRequest): Promise<FileVersion>;
119
+ /**
120
+ * Calls {@link https://www.backblaze.com/apidocs/b2-hide-file | b2_hide_file}.
121
+ * @param apiUrl - The B2 API base URL.
122
+ * @param authToken - The authorization token.
123
+ * @param request - The API request parameters.
124
+ *
125
+ * @returns The hidden file version metadata.
126
+ */
127
+ hideFile(apiUrl: string, authToken: string, request: HideFileRequest): Promise<FileVersion>;
128
+ /**
129
+ * Calls {@link https://www.backblaze.com/apidocs/b2-delete-file-version | b2_delete_file_version}.
130
+ * @param apiUrl - The B2 API base URL.
131
+ * @param authToken - The authorization token.
132
+ * @param request - The API request parameters.
133
+ *
134
+ * @returns The deleted file version identifier.
135
+ */
136
+ deleteFileVersion(apiUrl: string, authToken: string, request: DeleteFileVersionRequest): Promise<DeleteFileVersionResponse>;
137
+ /**
138
+ * Calls {@link https://www.backblaze.com/apidocs/b2-copy-file | b2_copy_file}.
139
+ * @param apiUrl - The B2 API base URL.
140
+ * @param authToken - The authorization token.
141
+ * @param request - The API request parameters.
142
+ *
143
+ * @returns The copied file version metadata.
144
+ */
145
+ copyFile(apiUrl: string, authToken: string, request: CopyFileRequest): Promise<FileVersion>;
146
+ /**
147
+ * Calls {@link https://www.backblaze.com/apidocs/b2-copy-part | b2_copy_part}.
148
+ * @param apiUrl - The B2 API base URL.
149
+ * @param authToken - The authorization token.
150
+ * @param request - The API request parameters.
151
+ *
152
+ * @returns The copied part metadata.
153
+ */
154
+ copyPart(apiUrl: string, authToken: string, request: CopyPartRequest): Promise<CopyPartResponse>;
155
+ /**
156
+ * Calls {@link https://www.backblaze.com/apidocs/b2-start-large-file | b2_start_large_file}.
157
+ * @param apiUrl - The B2 API base URL.
158
+ * @param authToken - The authorization token.
159
+ * @param request - The API request parameters.
160
+ *
161
+ * @returns The started large file metadata with file ID.
162
+ */
163
+ startLargeFile(apiUrl: string, authToken: string, request: StartLargeFileRequest): Promise<StartLargeFileResponse>;
164
+ /**
165
+ * Calls {@link https://www.backblaze.com/apidocs/b2-get-upload-part-url | b2_get_upload_part_url}.
166
+ * @param apiUrl - The B2 API base URL.
167
+ * @param authToken - The authorization token.
168
+ * @param request - The API request parameters.
169
+ *
170
+ * @returns The upload part URL and authorization token.
171
+ */
172
+ getUploadPartUrl(apiUrl: string, authToken: string, request: GetUploadPartUrlRequest): Promise<GetUploadPartUrlResponse>;
173
+ /**
174
+ * Calls {@link https://www.backblaze.com/apidocs/b2-upload-part | b2_upload_part}.
175
+ *
176
+ * Posts directly to the `uploadUrl` obtained from {@link getUploadPartUrl}
177
+ * rather than the API URL.
178
+ * @param uploadUrl - The upload endpoint URL.
179
+ * @param headers - The request headers including authorization and content metadata.
180
+ * @param body - The file data to upload.
181
+ * @param signal - An optional abort signal for cancellation.
182
+ *
183
+ * @returns The uploaded part metadata.
184
+ */
185
+ uploadPart(uploadUrl: string, headers: UploadPartHeaders, body: BodyInit, signal?: AbortSignal): Promise<UploadPartResponse>;
186
+ /**
187
+ * Calls {@link https://www.backblaze.com/apidocs/b2-finish-large-file | b2_finish_large_file}.
188
+ * @param apiUrl - The B2 API base URL.
189
+ * @param authToken - The authorization token.
190
+ * @param request - The API request parameters.
191
+ *
192
+ * @returns The completed file version metadata.
193
+ */
194
+ finishLargeFile(apiUrl: string, authToken: string, request: FinishLargeFileRequest): Promise<FileVersion>;
195
+ /**
196
+ * Calls {@link https://www.backblaze.com/apidocs/b2-cancel-large-file | b2_cancel_large_file}.
197
+ * @param apiUrl - The B2 API base URL.
198
+ * @param authToken - The authorization token.
199
+ * @param request - The API request parameters.
200
+ *
201
+ * @returns The cancelled large file metadata.
202
+ */
203
+ cancelLargeFile(apiUrl: string, authToken: string, request: CancelLargeFileRequest): Promise<CancelLargeFileResponse>;
204
+ /**
205
+ * Calls {@link https://www.backblaze.com/apidocs/b2-list-unfinished-large-files | b2_list_unfinished_large_files}.
206
+ * @param apiUrl - The B2 API base URL.
207
+ * @param authToken - The authorization token.
208
+ * @param request - The API request parameters.
209
+ *
210
+ * @returns The list of unfinished large files and optional continuation token.
211
+ */
212
+ listUnfinishedLargeFiles(apiUrl: string, authToken: string, request: ListUnfinishedLargeFilesRequest): Promise<ListUnfinishedLargeFilesResponse>;
213
+ /**
214
+ * Calls {@link https://www.backblaze.com/apidocs/b2-list-parts | b2_list_parts}.
215
+ * @param apiUrl - The B2 API base URL.
216
+ * @param authToken - The authorization token.
217
+ * @param request - The API request parameters.
218
+ *
219
+ * @returns The list of uploaded parts and optional continuation token.
220
+ */
221
+ listParts(apiUrl: string, authToken: string, request: ListPartsRequest): Promise<ListPartsResponse>;
222
+ /**
223
+ * Calls {@link https://www.backblaze.com/apidocs/b2-download-file-by-id | b2_download_file_by_id}.
224
+ * @param downloadUrl - The B2 download base URL.
225
+ * @param authToken - The authorization token.
226
+ * @param fileId - The unique identifier of the file to download.
227
+ * @param options - Optional download parameters for range requests and cancellation.
228
+ *
229
+ * @returns The response headers, streaming body, and HTTP status code.
230
+ */
231
+ downloadFileById(downloadUrl: string, authToken: string, fileId: string, options?: DownloadFileOptions): Promise<{
232
+ /** Response headers containing file metadata and B2 info headers. */
233
+ headers: Headers;
234
+ /** Streaming response body, or `null` for HEAD-like responses. */
235
+ body: ReadableStream<Uint8Array> | null;
236
+ /** HTTP status code (200 for full content, 206 for partial content). */
237
+ status: number;
238
+ }>;
239
+ /**
240
+ * Calls {@link https://www.backblaze.com/apidocs/b2-download-file-by-name | b2_download_file_by_name}.
241
+ * @param downloadUrl - The B2 download base URL.
242
+ * @param authToken - The authorization token.
243
+ * @param bucketName - The name of the bucket containing the file.
244
+ * @param fileName - The name of the file to download.
245
+ * @param options - Optional download parameters for range requests and cancellation.
246
+ *
247
+ * @returns The response headers, streaming body, and HTTP status code.
248
+ */
249
+ downloadFileByName(downloadUrl: string, authToken: string, bucketName: string, fileName: string, options?: DownloadFileOptions): Promise<{
250
+ /** Response headers containing file metadata and B2 info headers. */
251
+ headers: Headers;
252
+ /** Streaming response body, or `null` for HEAD-like responses. */
253
+ body: ReadableStream<Uint8Array> | null;
254
+ /** HTTP status code (200 for full content, 206 for partial content). */
255
+ status: number;
256
+ }>;
257
+ /**
258
+ * Calls {@link https://www.backblaze.com/apidocs/b2-get-download-authorization | b2_get_download_authorization}.
259
+ * @param apiUrl - The B2 API base URL.
260
+ * @param authToken - The current session authorization token.
261
+ * @param request - The API request parameters.
262
+ *
263
+ * @returns The download authorization token for the specified file prefix.
264
+ */
265
+ getDownloadAuthorization(apiUrl: string, authToken: string, request: DownloadAuthorizationRequest): Promise<DownloadAuthorizationResponse>;
266
+ /**
267
+ * Calls {@link https://www.backblaze.com/apidocs/b2-create-key | b2_create_key}.
268
+ * @param apiUrl - The B2 API base URL.
269
+ * @param authToken - The authorization token.
270
+ * @param request - The API request parameters.
271
+ *
272
+ * @returns The newly created application key with secret.
273
+ */
274
+ createKey(apiUrl: string, authToken: string, request: CreateKeyRequest): Promise<FullApplicationKey>;
275
+ /**
276
+ * Calls {@link https://www.backblaze.com/apidocs/b2-list-keys | b2_list_keys}.
277
+ * @param apiUrl - The B2 API base URL.
278
+ * @param authToken - The authorization token.
279
+ * @param request - The API request parameters.
280
+ *
281
+ * @returns The list of application keys and optional continuation token.
282
+ */
283
+ listKeys(apiUrl: string, authToken: string, request: ListKeysRequest): Promise<ListKeysResponse>;
284
+ /**
285
+ * Calls {@link https://www.backblaze.com/apidocs/b2-delete-key | b2_delete_key}.
286
+ * @param apiUrl - The B2 API base URL.
287
+ * @param authToken - The authorization token.
288
+ * @param request - The API request parameters.
289
+ *
290
+ * @returns The deleted application key metadata.
291
+ */
292
+ deleteKey(apiUrl: string, authToken: string, request: DeleteKeyRequest): Promise<ApplicationKey>;
293
+ /**
294
+ * Calls {@link https://www.backblaze.com/apidocs/b2-update-file-retention | b2_update_file_retention}.
295
+ * @param apiUrl - The B2 API base URL.
296
+ * @param authToken - The authorization token.
297
+ * @param request - The API request parameters.
298
+ *
299
+ * @returns The updated file retention settings.
300
+ */
301
+ updateFileRetention(apiUrl: string, authToken: string, request: UpdateFileRetentionRequest): Promise<UpdateFileRetentionResponse>;
302
+ /**
303
+ * Calls {@link https://www.backblaze.com/apidocs/b2-update-file-legal-hold | b2_update_file_legal_hold}.
304
+ * @param apiUrl - The B2 API base URL.
305
+ * @param authToken - The authorization token.
306
+ * @param request - The API request parameters.
307
+ *
308
+ * @returns The updated file legal hold status.
309
+ */
310
+ updateFileLegalHold(apiUrl: string, authToken: string, request: UpdateFileLegalHoldRequest): Promise<UpdateFileLegalHoldResponse>;
311
+ /**
312
+ * Calls {@link https://www.backblaze.com/apidocs/b2-get-bucket-notification-rules | b2_get_bucket_notification_rules}.
313
+ * @param apiUrl - The B2 API base URL.
314
+ * @param authToken - The authorization token.
315
+ * @param request - The API request parameters.
316
+ *
317
+ * @returns The configured event notification rules for the specified bucket.
318
+ */
319
+ getBucketNotificationRules(apiUrl: string, authToken: string, request: GetBucketNotificationRulesRequest): Promise<GetBucketNotificationRulesResponse>;
320
+ /**
321
+ * Calls {@link https://www.backblaze.com/apidocs/b2-set-bucket-notification-rules | b2_set_bucket_notification_rules}.
322
+ * @param apiUrl - The B2 API base URL.
323
+ * @param authToken - The authorization token.
324
+ * @param request - The API request parameters.
325
+ *
326
+ * @returns The updated bucket notification rules.
327
+ */
328
+ setBucketNotificationRules(apiUrl: string, authToken: string, request: SetBucketNotificationRulesRequest): Promise<SetBucketNotificationRulesResponse>;
329
+ /**
330
+ * Sends a JSON POST request to the specified B2 API endpoint.
331
+ * @param apiUrl - The B2 API base URL.
332
+ * @param authToken - The authorization token.
333
+ * @param endpoint - The B2 API endpoint name.
334
+ * @param body - The JSON request body.
335
+ *
336
+ * @returns The parsed JSON response.
337
+ */
338
+ private postJson;
339
+ }
340
+ /**
341
+ * SSE-C decryption parameters supplied to downloads of files that were
342
+ * uploaded with customer-managed keys.
343
+ */
344
+ export interface SseCDownloadKey {
345
+ /** Encryption algorithm. Always `EncryptionAlgorithm.Aes256` (`'AES256'`). */
346
+ readonly algorithm: EncryptionAlgorithm;
347
+ /** Base64-encoded customer-provided decryption key. */
348
+ readonly customerKey: string;
349
+ /** Base64-encoded MD5 digest of the decryption key. */
350
+ readonly customerKeyMd5: string;
351
+ }
352
+ /**
353
+ * Options accepted by {@link RawClient.downloadFileById} and
354
+ * {@link RawClient.downloadFileByName}. Mirrors the B2 native API: range +
355
+ * SSE-C decryption headers + the documented `b2Content*` response-header
356
+ * overrides (query-string parameters on the request URL).
357
+ */
358
+ export interface DownloadFileOptions {
359
+ /** HTTP method. Defaults to `'GET'`. Use `'HEAD'` to fetch headers without the body. */
360
+ readonly method?: 'GET' | 'HEAD';
361
+ /** HTTP Range header value for partial content requests. */
362
+ readonly range?: string;
363
+ /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */
364
+ readonly serverSideEncryption?: SseCDownloadKey;
365
+ /** Override the `Content-Disposition` header in the download response. */
366
+ readonly b2ContentDisposition?: string;
367
+ /** Override the `Content-Language` header in the download response. */
368
+ readonly b2ContentLanguage?: string;
369
+ /** Override the `Content-Encoding` header in the download response. */
370
+ readonly b2ContentEncoding?: string;
371
+ /** Override the `Content-Type` header in the download response. */
372
+ readonly b2ContentType?: string;
373
+ /** Override the `Cache-Control` header in the download response. */
374
+ readonly b2CacheControl?: string;
375
+ /** Override the `Expires` header in the download response. */
376
+ readonly b2Expires?: string;
377
+ /** Signal to abort the download. */
378
+ readonly signal?: AbortSignal;
379
+ }
380
+ export { encodeFileName, decodeFileName, buildFileInfoHeaders, parseFileInfoHeaders, } from './encoding.js';
381
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/raw/index.js"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EACV,cAAc,EACd,wBAAwB,EACxB,UAAU,EACV,sBAAsB,EACtB,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,gBAAgB,EAChB,4BAA4B,EAC5B,6BAA6B,EAC7B,WAAW,EACX,sBAAsB,EACtB,kBAAkB,EAClB,iCAAiC,EACjC,kCAAkC,EAClC,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAIlG,0DAA0D;AAC1D,MAAM,WAAW,gBAAgB;IAC/B,yFAAyF;IACzF,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAA;CAClC;AAED;;;;;;GAMG;AACH,qBAAa,SAAS;IACpB,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAEzC;;;OAGG;gBACS,OAAO,EAAE,gBAAgB;IAMrC;;;;;;;OAOG;IACG,gBAAgB,CACpB,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,EACtB,QAAQ,SAAgC,GACvC,OAAO,CAAC,wBAAwB,CAAC;IAapC;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,UAAU,CAAC;IAItB;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,UAAU,CAAC;IAItB;;;;;;;OAOG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAI/B;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,UAAU,CAAC;IAMtB;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;;;;;;;;OAWG;IACG,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,QAAQ,EACd,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,CAAC;IA2CvB;;;;;;;OAOG;IACG,aAAa,CACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,qBAAqB,CAAC;IAMjC;;;;;;;OAOG;IACG,gBAAgB,CACpB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAWpC;;;;;;;OAOG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,WAAW,CAAC;IAMvB;;;;;;;OAOG;IACG,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,WAAW,CAAC;IAMvB;;;;;;;OAOG;IACG,iBAAiB,CACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IASrC;;;;;;;OAOG;IACG,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,WAAW,CAAC;IAMvB;;;;;;;OAOG;IACG,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,gBAAgB,CAAC;IAM5B;;;;;;;OAOG;IACG,cAAc,CAClB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,sBAAsB,CAAC;IAIlC;;;;;;;OAOG;IACG,gBAAgB,CACpB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IASpC;;;;;;;;;;;OAWG;IACG,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,QAAQ,EACd,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,kBAAkB,CAAC;IAoB9B;;;;;;;OAOG;IACG,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAMvB;;;;;;;OAOG;IACG,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,uBAAuB,CAAC;IASnC;;;;;;;OAOG;IACG,wBAAwB,CAC5B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,gCAAgC,CAAC;IAS5C;;;;;;;OAOG;IACG,SAAS,CACb,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAM7B;;;;;;;;OAQG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QACT,qEAAqE;QACrE,OAAO,EAAE,OAAO,CAAA;QAChB,kEAAkE;QAClE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;QACvC,wEAAwE;QACxE,MAAM,EAAE,MAAM,CAAA;KACf,CAAC;IAiBF;;;;;;;;;OASG;IACG,kBAAkB,CACtB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QACT,qEAAqE;QACrE,OAAO,EAAE,OAAO,CAAA;QAChB,kEAAkE;QAClE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;QACvC,wEAAwE;QACxE,MAAM,EAAE,MAAM,CAAA;KACf,CAAC;IAiBF;;;;;;;OAOG;IACG,wBAAwB,CAC5B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,6BAA6B,CAAC;IAWzC;;;;;;;OAOG;IACG,SAAS,CACb,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAI9B;;;;;;;OAOG;IACG,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,gBAAgB,CAAC;IAI5B;;;;;;;OAOG;IACG,SAAS,CACb,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,cAAc,CAAC;IAM1B;;;;;;;OAOG;IACG,mBAAmB,CACvB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;IASvC;;;;;;;OAOG;IACG,mBAAmB,CACvB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;IAWvC;;;;;;;OAOG;IACG,0BAA0B,CAC9B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,kCAAkC,CAAC;IAS9C;;;;;;;OAOG;IACG,0BAA0B,CAC9B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,kCAAkC,CAAC;IAW9C;;;;;;;;OAQG;YACW,QAAQ;CAiBvB;AAID,OAAO,EAAE,mBAAmB,EAA0C,MAAM,wBAAwB,CAAA;AAsBpG;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,mBAAmB,CAAA;IACvC,uDAAuD;IACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,wFAAwF;IACxF,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,eAAe,CAAA;IAC/C,0EAA0E;IAC1E,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,uEAAuE;IACvE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,uEAAuE;IACvE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,mEAAmE;IACnE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,oEAAoE;IACpE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B,oCAAoC;IACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAC9B;AA0FD,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,eAAe,CAAA"}