@imagekit/nodejs 7.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (622) hide show
  1. package/CHANGELOG.md +102 -0
  2. package/LICENSE +201 -0
  3. package/README.md +633 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +238 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +238 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +506 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +502 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +35 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +32 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +75 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +75 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +85 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +79 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/lib/crypto-utils.d.mts +16 -0
  231. package/lib/crypto-utils.d.mts.map +1 -0
  232. package/lib/crypto-utils.d.ts +16 -0
  233. package/lib/crypto-utils.d.ts.map +1 -0
  234. package/lib/crypto-utils.js +35 -0
  235. package/lib/crypto-utils.js.map +1 -0
  236. package/lib/crypto-utils.mjs +32 -0
  237. package/lib/crypto-utils.mjs.map +1 -0
  238. package/lib/serialization-utils.d.mts +11 -0
  239. package/lib/serialization-utils.d.mts.map +1 -0
  240. package/lib/serialization-utils.d.ts +11 -0
  241. package/lib/serialization-utils.d.ts.map +1 -0
  242. package/lib/serialization-utils.js +45 -0
  243. package/lib/serialization-utils.js.map +1 -0
  244. package/lib/serialization-utils.mjs +42 -0
  245. package/lib/serialization-utils.mjs.map +1 -0
  246. package/lib/transformation-utils.d.mts +18 -0
  247. package/lib/transformation-utils.d.mts.map +1 -0
  248. package/lib/transformation-utils.d.ts +18 -0
  249. package/lib/transformation-utils.d.ts.map +1 -0
  250. package/lib/transformation-utils.js +110 -0
  251. package/lib/transformation-utils.js.map +1 -0
  252. package/lib/transformation-utils.mjs +106 -0
  253. package/lib/transformation-utils.mjs.map +1 -0
  254. package/package.json +150 -0
  255. package/resource.d.mts +2 -0
  256. package/resource.d.mts.map +1 -0
  257. package/resource.d.ts +2 -0
  258. package/resource.d.ts.map +1 -0
  259. package/resource.js +6 -0
  260. package/resource.js.map +1 -0
  261. package/resource.mjs +2 -0
  262. package/resource.mjs.map +1 -0
  263. package/resources/accounts/accounts.d.mts +18 -0
  264. package/resources/accounts/accounts.d.mts.map +1 -0
  265. package/resources/accounts/accounts.d.ts +18 -0
  266. package/resources/accounts/accounts.d.ts.map +1 -0
  267. package/resources/accounts/accounts.js +25 -0
  268. package/resources/accounts/accounts.js.map +1 -0
  269. package/resources/accounts/accounts.mjs +20 -0
  270. package/resources/accounts/accounts.mjs.map +1 -0
  271. package/resources/accounts/index.d.mts +5 -0
  272. package/resources/accounts/index.d.mts.map +1 -0
  273. package/resources/accounts/index.d.ts +5 -0
  274. package/resources/accounts/index.d.ts.map +1 -0
  275. package/resources/accounts/index.js +13 -0
  276. package/resources/accounts/index.js.map +1 -0
  277. package/resources/accounts/index.mjs +6 -0
  278. package/resources/accounts/index.mjs.map +1 -0
  279. package/resources/accounts/origins.d.mts +945 -0
  280. package/resources/accounts/origins.d.mts.map +1 -0
  281. package/resources/accounts/origins.d.ts +945 -0
  282. package/resources/accounts/origins.d.ts.map +1 -0
  283. package/resources/accounts/origins.js +95 -0
  284. package/resources/accounts/origins.js.map +1 -0
  285. package/resources/accounts/origins.mjs +91 -0
  286. package/resources/accounts/origins.mjs.map +1 -0
  287. package/resources/accounts/url-endpoints.d.mts +226 -0
  288. package/resources/accounts/url-endpoints.d.mts.map +1 -0
  289. package/resources/accounts/url-endpoints.d.ts +226 -0
  290. package/resources/accounts/url-endpoints.d.ts.map +1 -0
  291. package/resources/accounts/url-endpoints.js +84 -0
  292. package/resources/accounts/url-endpoints.js.map +1 -0
  293. package/resources/accounts/url-endpoints.mjs +80 -0
  294. package/resources/accounts/url-endpoints.mjs.map +1 -0
  295. package/resources/accounts/usage.d.mts +58 -0
  296. package/resources/accounts/usage.d.mts.map +1 -0
  297. package/resources/accounts/usage.d.ts +58 -0
  298. package/resources/accounts/usage.d.ts.map +1 -0
  299. package/resources/accounts/usage.js +26 -0
  300. package/resources/accounts/usage.js.map +1 -0
  301. package/resources/accounts/usage.mjs +22 -0
  302. package/resources/accounts/usage.mjs.map +1 -0
  303. package/resources/accounts.d.mts +2 -0
  304. package/resources/accounts.d.mts.map +1 -0
  305. package/resources/accounts.d.ts +2 -0
  306. package/resources/accounts.d.ts.map +1 -0
  307. package/resources/accounts.js +6 -0
  308. package/resources/accounts.js.map +1 -0
  309. package/resources/accounts.mjs +3 -0
  310. package/resources/accounts.mjs.map +1 -0
  311. package/resources/assets.d.mts +75 -0
  312. package/resources/assets.d.mts.map +1 -0
  313. package/resources/assets.d.ts +75 -0
  314. package/resources/assets.d.ts.map +1 -0
  315. package/resources/assets.js +18 -0
  316. package/resources/assets.js.map +1 -0
  317. package/resources/assets.mjs +14 -0
  318. package/resources/assets.mjs.map +1 -0
  319. package/resources/beta/beta.d.mts +10 -0
  320. package/resources/beta/beta.d.mts.map +1 -0
  321. package/resources/beta/beta.d.ts +10 -0
  322. package/resources/beta/beta.d.ts.map +1 -0
  323. package/resources/beta/beta.js +17 -0
  324. package/resources/beta/beta.js.map +1 -0
  325. package/resources/beta/beta.mjs +12 -0
  326. package/resources/beta/beta.mjs.map +1 -0
  327. package/resources/beta/index.d.mts +3 -0
  328. package/resources/beta/index.d.mts.map +1 -0
  329. package/resources/beta/index.d.ts +3 -0
  330. package/resources/beta/index.d.ts.map +1 -0
  331. package/resources/beta/index.js +9 -0
  332. package/resources/beta/index.js.map +1 -0
  333. package/resources/beta/index.mjs +4 -0
  334. package/resources/beta/index.mjs.map +1 -0
  335. package/resources/beta/v2/files.d.mts +460 -0
  336. package/resources/beta/v2/files.d.mts.map +1 -0
  337. package/resources/beta/v2/files.d.ts +460 -0
  338. package/resources/beta/v2/files.d.ts.map +1 -0
  339. package/resources/beta/v2/files.js +52 -0
  340. package/resources/beta/v2/files.js.map +1 -0
  341. package/resources/beta/v2/files.mjs +48 -0
  342. package/resources/beta/v2/files.mjs.map +1 -0
  343. package/resources/beta/v2/index.d.mts +3 -0
  344. package/resources/beta/v2/index.d.mts.map +1 -0
  345. package/resources/beta/v2/index.d.ts +3 -0
  346. package/resources/beta/v2/index.d.ts.map +1 -0
  347. package/resources/beta/v2/index.js +9 -0
  348. package/resources/beta/v2/index.js.map +1 -0
  349. package/resources/beta/v2/index.mjs +4 -0
  350. package/resources/beta/v2/index.mjs.map +1 -0
  351. package/resources/beta/v2/v2.d.mts +10 -0
  352. package/resources/beta/v2/v2.d.mts.map +1 -0
  353. package/resources/beta/v2/v2.d.ts +10 -0
  354. package/resources/beta/v2/v2.d.ts.map +1 -0
  355. package/resources/beta/v2/v2.js +17 -0
  356. package/resources/beta/v2/v2.js.map +1 -0
  357. package/resources/beta/v2/v2.mjs +12 -0
  358. package/resources/beta/v2/v2.mjs.map +1 -0
  359. package/resources/beta/v2.d.mts +2 -0
  360. package/resources/beta/v2.d.mts.map +1 -0
  361. package/resources/beta/v2.d.ts +2 -0
  362. package/resources/beta/v2.d.ts.map +1 -0
  363. package/resources/beta/v2.js +6 -0
  364. package/resources/beta/v2.js.map +1 -0
  365. package/resources/beta/v2.mjs +3 -0
  366. package/resources/beta/v2.mjs.map +1 -0
  367. package/resources/beta.d.mts +2 -0
  368. package/resources/beta.d.mts.map +1 -0
  369. package/resources/beta.d.ts +2 -0
  370. package/resources/beta.d.ts.map +1 -0
  371. package/resources/beta.js +6 -0
  372. package/resources/beta.js.map +1 -0
  373. package/resources/beta.mjs +3 -0
  374. package/resources/beta.mjs.map +1 -0
  375. package/resources/cache/cache.d.mts +10 -0
  376. package/resources/cache/cache.d.mts.map +1 -0
  377. package/resources/cache/cache.d.ts +10 -0
  378. package/resources/cache/cache.d.ts.map +1 -0
  379. package/resources/cache/cache.js +17 -0
  380. package/resources/cache/cache.js.map +1 -0
  381. package/resources/cache/cache.mjs +12 -0
  382. package/resources/cache/cache.mjs.map +1 -0
  383. package/resources/cache/index.d.mts +3 -0
  384. package/resources/cache/index.d.mts.map +1 -0
  385. package/resources/cache/index.d.ts +3 -0
  386. package/resources/cache/index.d.ts.map +1 -0
  387. package/resources/cache/index.js +9 -0
  388. package/resources/cache/index.js.map +1 -0
  389. package/resources/cache/index.mjs +4 -0
  390. package/resources/cache/index.mjs.map +1 -0
  391. package/resources/cache/invalidation.d.mts +54 -0
  392. package/resources/cache/invalidation.d.mts.map +1 -0
  393. package/resources/cache/invalidation.d.ts +54 -0
  394. package/resources/cache/invalidation.d.ts.map +1 -0
  395. package/resources/cache/invalidation.js +40 -0
  396. package/resources/cache/invalidation.js.map +1 -0
  397. package/resources/cache/invalidation.mjs +36 -0
  398. package/resources/cache/invalidation.mjs.map +1 -0
  399. package/resources/cache.d.mts +2 -0
  400. package/resources/cache.d.mts.map +1 -0
  401. package/resources/cache.d.ts +2 -0
  402. package/resources/cache.d.ts.map +1 -0
  403. package/resources/cache.js +6 -0
  404. package/resources/cache.js.map +1 -0
  405. package/resources/cache.mjs +3 -0
  406. package/resources/cache.mjs.map +1 -0
  407. package/resources/custom-metadata-fields.d.mts +274 -0
  408. package/resources/custom-metadata-fields.d.mts.map +1 -0
  409. package/resources/custom-metadata-fields.d.ts +274 -0
  410. package/resources/custom-metadata-fields.d.ts.map +1 -0
  411. package/resources/custom-metadata-fields.js +79 -0
  412. package/resources/custom-metadata-fields.js.map +1 -0
  413. package/resources/custom-metadata-fields.mjs +75 -0
  414. package/resources/custom-metadata-fields.mjs.map +1 -0
  415. package/resources/files/bulk.d.mts +137 -0
  416. package/resources/files/bulk.d.mts.map +1 -0
  417. package/resources/files/bulk.d.ts +137 -0
  418. package/resources/files/bulk.d.ts.map +1 -0
  419. package/resources/files/bulk.js +85 -0
  420. package/resources/files/bulk.js.map +1 -0
  421. package/resources/files/bulk.mjs +81 -0
  422. package/resources/files/bulk.mjs.map +1 -0
  423. package/resources/files/files.d.mts +1133 -0
  424. package/resources/files/files.d.mts.map +1 -0
  425. package/resources/files/files.d.ts +1133 -0
  426. package/resources/files/files.d.ts.map +1 -0
  427. package/resources/files/files.js +164 -0
  428. package/resources/files/files.js.map +1 -0
  429. package/resources/files/files.mjs +159 -0
  430. package/resources/files/files.mjs.map +1 -0
  431. package/resources/files/index.d.mts +5 -0
  432. package/resources/files/index.d.mts.map +1 -0
  433. package/resources/files/index.d.ts +5 -0
  434. package/resources/files/index.d.ts.map +1 -0
  435. package/resources/files/index.js +11 -0
  436. package/resources/files/index.js.map +1 -0
  437. package/resources/files/index.mjs +5 -0
  438. package/resources/files/index.mjs.map +1 -0
  439. package/resources/files/metadata.d.mts +42 -0
  440. package/resources/files/metadata.d.mts.map +1 -0
  441. package/resources/files/metadata.d.ts +42 -0
  442. package/resources/files/metadata.d.ts.map +1 -0
  443. package/resources/files/metadata.js +39 -0
  444. package/resources/files/metadata.js.map +1 -0
  445. package/resources/files/metadata.mjs +35 -0
  446. package/resources/files/metadata.mjs.map +1 -0
  447. package/resources/files/versions.d.mts +81 -0
  448. package/resources/files/versions.d.mts.map +1 -0
  449. package/resources/files/versions.d.ts +81 -0
  450. package/resources/files/versions.d.ts.map +1 -0
  451. package/resources/files/versions.js +68 -0
  452. package/resources/files/versions.js.map +1 -0
  453. package/resources/files/versions.mjs +64 -0
  454. package/resources/files/versions.mjs.map +1 -0
  455. package/resources/files.d.mts +2 -0
  456. package/resources/files.d.mts.map +1 -0
  457. package/resources/files.d.ts +2 -0
  458. package/resources/files.d.ts.map +1 -0
  459. package/resources/files.js +6 -0
  460. package/resources/files.js.map +1 -0
  461. package/resources/files.mjs +3 -0
  462. package/resources/files.mjs.map +1 -0
  463. package/resources/folders/folders.d.mts +203 -0
  464. package/resources/folders/folders.d.mts.map +1 -0
  465. package/resources/folders/folders.d.ts +203 -0
  466. package/resources/folders/folders.d.ts.map +1 -0
  467. package/resources/folders/folders.js +97 -0
  468. package/resources/folders/folders.js.map +1 -0
  469. package/resources/folders/folders.mjs +92 -0
  470. package/resources/folders/folders.mjs.map +1 -0
  471. package/resources/folders/index.d.mts +3 -0
  472. package/resources/folders/index.d.mts.map +1 -0
  473. package/resources/folders/index.d.ts +3 -0
  474. package/resources/folders/index.d.ts.map +1 -0
  475. package/resources/folders/index.js +9 -0
  476. package/resources/folders/index.js.map +1 -0
  477. package/resources/folders/index.mjs +4 -0
  478. package/resources/folders/index.mjs.map +1 -0
  479. package/resources/folders/job.d.mts +37 -0
  480. package/resources/folders/job.d.mts.map +1 -0
  481. package/resources/folders/job.d.ts +37 -0
  482. package/resources/folders/job.d.ts.map +1 -0
  483. package/resources/folders/job.js +21 -0
  484. package/resources/folders/job.js.map +1 -0
  485. package/resources/folders/job.mjs +17 -0
  486. package/resources/folders/job.mjs.map +1 -0
  487. package/resources/folders.d.mts +2 -0
  488. package/resources/folders.d.mts.map +1 -0
  489. package/resources/folders.d.ts +2 -0
  490. package/resources/folders.d.ts.map +1 -0
  491. package/resources/folders.js +6 -0
  492. package/resources/folders.js.map +1 -0
  493. package/resources/folders.mjs +3 -0
  494. package/resources/folders.mjs.map +1 -0
  495. package/resources/helper.d.mts +42 -0
  496. package/resources/helper.d.mts.map +1 -0
  497. package/resources/helper.d.ts +42 -0
  498. package/resources/helper.d.ts.map +1 -0
  499. package/resources/helper.js +402 -0
  500. package/resources/helper.js.map +1 -0
  501. package/resources/helper.mjs +397 -0
  502. package/resources/helper.mjs.map +1 -0
  503. package/resources/index.d.mts +11 -0
  504. package/resources/index.d.mts.map +1 -0
  505. package/resources/index.d.ts +11 -0
  506. package/resources/index.d.ts.map +1 -0
  507. package/resources/index.js +25 -0
  508. package/resources/index.js.map +1 -0
  509. package/resources/index.mjs +12 -0
  510. package/resources/index.mjs.map +1 -0
  511. package/resources/shared.d.mts +817 -0
  512. package/resources/shared.d.mts.map +1 -0
  513. package/resources/shared.d.ts +817 -0
  514. package/resources/shared.d.ts.map +1 -0
  515. package/resources/shared.js +4 -0
  516. package/resources/shared.js.map +1 -0
  517. package/resources/shared.mjs +3 -0
  518. package/resources/shared.mjs.map +1 -0
  519. package/resources/webhooks.d.mts +811 -0
  520. package/resources/webhooks.d.mts.map +1 -0
  521. package/resources/webhooks.d.ts +811 -0
  522. package/resources/webhooks.d.ts.map +1 -0
  523. package/resources/webhooks.js +24 -0
  524. package/resources/webhooks.js.map +1 -0
  525. package/resources/webhooks.mjs +20 -0
  526. package/resources/webhooks.mjs.map +1 -0
  527. package/resources.d.mts +2 -0
  528. package/resources.d.mts.map +1 -0
  529. package/resources.d.ts +2 -0
  530. package/resources.d.ts.map +1 -0
  531. package/resources.js +5 -0
  532. package/resources.js.map +1 -0
  533. package/resources.mjs +2 -0
  534. package/resources.mjs.map +1 -0
  535. package/src/api-promise.ts +2 -0
  536. package/src/client.ts +929 -0
  537. package/src/core/README.md +3 -0
  538. package/src/core/api-promise.ts +92 -0
  539. package/src/core/error.ts +130 -0
  540. package/src/core/resource.ts +11 -0
  541. package/src/core/uploads.ts +2 -0
  542. package/src/error.ts +2 -0
  543. package/src/index.ts +22 -0
  544. package/src/internal/README.md +3 -0
  545. package/src/internal/builtin-types.ts +93 -0
  546. package/src/internal/detect-platform.ts +196 -0
  547. package/src/internal/errors.ts +33 -0
  548. package/src/internal/headers.ts +97 -0
  549. package/src/internal/parse.ts +50 -0
  550. package/src/internal/request-options.ts +91 -0
  551. package/src/internal/shim-types.ts +26 -0
  552. package/src/internal/shims.ts +107 -0
  553. package/src/internal/to-file.ts +154 -0
  554. package/src/internal/types.ts +95 -0
  555. package/src/internal/uploads.ts +187 -0
  556. package/src/internal/utils/base64.ts +40 -0
  557. package/src/internal/utils/bytes.ts +32 -0
  558. package/src/internal/utils/env.ts +18 -0
  559. package/src/internal/utils/log.ts +126 -0
  560. package/src/internal/utils/path.ts +88 -0
  561. package/src/internal/utils/sleep.ts +3 -0
  562. package/src/internal/utils/uuid.ts +17 -0
  563. package/src/internal/utils/values.ts +105 -0
  564. package/src/internal/utils.ts +8 -0
  565. package/src/lib/.keep +4 -0
  566. package/src/lib/crypto-utils.ts +37 -0
  567. package/src/lib/serialization-utils.ts +42 -0
  568. package/src/lib/transformation-utils.ts +117 -0
  569. package/src/resource.ts +2 -0
  570. package/src/resources/accounts/accounts.ts +55 -0
  571. package/src/resources/accounts/index.ts +20 -0
  572. package/src/resources/accounts/origins.ts +1250 -0
  573. package/src/resources/accounts/url-endpoints.ts +298 -0
  574. package/src/resources/accounts/usage.ts +70 -0
  575. package/src/resources/accounts.ts +3 -0
  576. package/src/resources/assets.ts +105 -0
  577. package/src/resources/beta/beta.ts +15 -0
  578. package/src/resources/beta/index.ts +4 -0
  579. package/src/resources/beta/v2/files.ts +546 -0
  580. package/src/resources/beta/v2/index.ts +4 -0
  581. package/src/resources/beta/v2/v2.ts +19 -0
  582. package/src/resources/beta/v2.ts +3 -0
  583. package/src/resources/beta.ts +3 -0
  584. package/src/resources/cache/cache.ts +25 -0
  585. package/src/resources/cache/index.ts +9 -0
  586. package/src/resources/cache/invalidation.ts +70 -0
  587. package/src/resources/cache.ts +3 -0
  588. package/src/resources/custom-metadata-fields.ts +337 -0
  589. package/src/resources/files/bulk.ts +171 -0
  590. package/src/resources/files/files.ts +1430 -0
  591. package/src/resources/files/index.ts +39 -0
  592. package/src/resources/files/metadata.ts +52 -0
  593. package/src/resources/files/versions.ts +117 -0
  594. package/src/resources/files.ts +3 -0
  595. package/src/resources/folders/folders.ts +249 -0
  596. package/src/resources/folders/index.ts +16 -0
  597. package/src/resources/folders/job.ts +47 -0
  598. package/src/resources/folders.ts +3 -0
  599. package/src/resources/helper.ts +462 -0
  600. package/src/resources/index.ts +60 -0
  601. package/src/resources/shared.ts +952 -0
  602. package/src/resources/webhooks.ts +999 -0
  603. package/src/resources.ts +1 -0
  604. package/src/tsconfig.json +11 -0
  605. package/src/uploads.ts +2 -0
  606. package/src/version.ts +1 -0
  607. package/uploads.d.mts +2 -0
  608. package/uploads.d.mts.map +1 -0
  609. package/uploads.d.ts +2 -0
  610. package/uploads.d.ts.map +1 -0
  611. package/uploads.js +6 -0
  612. package/uploads.js.map +1 -0
  613. package/uploads.mjs +2 -0
  614. package/uploads.mjs.map +1 -0
  615. package/version.d.mts +2 -0
  616. package/version.d.mts.map +1 -0
  617. package/version.d.ts +2 -0
  618. package/version.d.ts.map +1 -0
  619. package/version.js +5 -0
  620. package/version.js.map +1 -0
  621. package/version.mjs +2 -0
  622. package/version.mjs.map +1 -0
@@ -0,0 +1,999 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import { toBase64 } from '../internal/utils';
5
+ import * as FilesAPI from './files/files';
6
+ import { Webhook } from 'standardwebhooks';
7
+
8
+ export class Webhooks extends APIResource {
9
+ unsafeUnwrap(body: string): UnsafeUnwrapWebhookEvent {
10
+ return JSON.parse(body) as UnsafeUnwrapWebhookEvent;
11
+ }
12
+
13
+ unwrap(
14
+ body: string,
15
+ { headers, key }: { headers: Record<string, string>; key?: string },
16
+ ): UnwrapWebhookEvent {
17
+ if (headers !== undefined) {
18
+ const keyStr: string | null = key === undefined ? this._client.webhookSecret : key;
19
+ if (keyStr === null) throw new Error('Webhook key must not be null in order to unwrap');
20
+ const wh = new Webhook(toBase64(keyStr));
21
+ wh.verify(body, headers);
22
+ }
23
+ return JSON.parse(body) as UnwrapWebhookEvent;
24
+ }
25
+ }
26
+
27
+ export interface BaseWebhookEvent {
28
+ /**
29
+ * Unique identifier for the event.
30
+ */
31
+ id: string;
32
+
33
+ /**
34
+ * The type of webhook event.
35
+ */
36
+ type: string;
37
+ }
38
+
39
+ /**
40
+ * Triggered when a post-transformation fails. The original file remains available,
41
+ * but the requested transformation could not be generated.
42
+ */
43
+ export interface UploadPostTransformErrorEvent extends BaseWebhookEvent {
44
+ /**
45
+ * Timestamp of when the event occurred in ISO8601 format.
46
+ */
47
+ created_at: string;
48
+
49
+ data: UploadPostTransformErrorEvent.Data;
50
+
51
+ request: UploadPostTransformErrorEvent.Request;
52
+
53
+ type: 'upload.post-transform.error';
54
+ }
55
+
56
+ export namespace UploadPostTransformErrorEvent {
57
+ export interface Data {
58
+ /**
59
+ * Unique identifier of the originally uploaded file.
60
+ */
61
+ fileId: string;
62
+
63
+ /**
64
+ * Name of the file.
65
+ */
66
+ name: string;
67
+
68
+ /**
69
+ * Path of the file.
70
+ */
71
+ path: string;
72
+
73
+ transformation: Data.Transformation;
74
+
75
+ /**
76
+ * URL of the attempted post-transformation.
77
+ */
78
+ url: string;
79
+ }
80
+
81
+ export namespace Data {
82
+ export interface Transformation {
83
+ error: Transformation.Error;
84
+ }
85
+
86
+ export namespace Transformation {
87
+ export interface Error {
88
+ /**
89
+ * Reason for the post-transformation failure.
90
+ */
91
+ reason: string;
92
+ }
93
+ }
94
+ }
95
+
96
+ export interface Request {
97
+ transformation: Request.Transformation;
98
+
99
+ /**
100
+ * Unique identifier for the originating request.
101
+ */
102
+ x_request_id: string;
103
+ }
104
+
105
+ export namespace Request {
106
+ export interface Transformation {
107
+ /**
108
+ * Type of the requested post-transformation.
109
+ */
110
+ type: 'transformation' | 'abs' | 'gif-to-video' | 'thumbnail';
111
+
112
+ /**
113
+ * Only applicable if transformation type is 'abs'. Streaming protocol used.
114
+ */
115
+ protocol?: 'hls' | 'dash';
116
+
117
+ /**
118
+ * Value for the requested transformation type.
119
+ */
120
+ value?: string;
121
+ }
122
+ }
123
+ }
124
+
125
+ /**
126
+ * Triggered when a post-transformation completes successfully. The transformed
127
+ * version of the file is now ready and can be accessed via the provided URL. Note
128
+ * that each post-transformation generates a separate webhook event.
129
+ */
130
+ export interface UploadPostTransformSuccessEvent extends BaseWebhookEvent {
131
+ /**
132
+ * Timestamp of when the event occurred in ISO8601 format.
133
+ */
134
+ created_at: string;
135
+
136
+ data: UploadPostTransformSuccessEvent.Data;
137
+
138
+ request: UploadPostTransformSuccessEvent.Request;
139
+
140
+ type: 'upload.post-transform.success';
141
+ }
142
+
143
+ export namespace UploadPostTransformSuccessEvent {
144
+ export interface Data {
145
+ /**
146
+ * Unique identifier of the originally uploaded file.
147
+ */
148
+ fileId: string;
149
+
150
+ /**
151
+ * Name of the file.
152
+ */
153
+ name: string;
154
+
155
+ /**
156
+ * URL of the generated post-transformation.
157
+ */
158
+ url: string;
159
+ }
160
+
161
+ export interface Request {
162
+ transformation: Request.Transformation;
163
+
164
+ /**
165
+ * Unique identifier for the originating request.
166
+ */
167
+ x_request_id: string;
168
+ }
169
+
170
+ export namespace Request {
171
+ export interface Transformation {
172
+ /**
173
+ * Type of the requested post-transformation.
174
+ */
175
+ type: 'transformation' | 'abs' | 'gif-to-video' | 'thumbnail';
176
+
177
+ /**
178
+ * Only applicable if transformation type is 'abs'. Streaming protocol used.
179
+ */
180
+ protocol?: 'hls' | 'dash';
181
+
182
+ /**
183
+ * Value for the requested transformation type.
184
+ */
185
+ value?: string;
186
+ }
187
+ }
188
+ }
189
+
190
+ /**
191
+ * Triggered when a pre-transformation fails. The file upload may have been
192
+ * accepted, but the requested transformation could not be applied.
193
+ */
194
+ export interface UploadPreTransformErrorEvent extends BaseWebhookEvent {
195
+ /**
196
+ * Timestamp of when the event occurred in ISO8601 format.
197
+ */
198
+ created_at: string;
199
+
200
+ data: UploadPreTransformErrorEvent.Data;
201
+
202
+ request: UploadPreTransformErrorEvent.Request;
203
+
204
+ type: 'upload.pre-transform.error';
205
+ }
206
+
207
+ export namespace UploadPreTransformErrorEvent {
208
+ export interface Data {
209
+ /**
210
+ * Name of the file.
211
+ */
212
+ name: string;
213
+
214
+ /**
215
+ * Path of the file.
216
+ */
217
+ path: string;
218
+
219
+ transformation: Data.Transformation;
220
+ }
221
+
222
+ export namespace Data {
223
+ export interface Transformation {
224
+ error: Transformation.Error;
225
+ }
226
+
227
+ export namespace Transformation {
228
+ export interface Error {
229
+ /**
230
+ * Reason for the pre-transformation failure.
231
+ */
232
+ reason: string;
233
+ }
234
+ }
235
+ }
236
+
237
+ export interface Request {
238
+ /**
239
+ * The requested pre-transformation string.
240
+ */
241
+ transformation: string;
242
+
243
+ /**
244
+ * Unique identifier for the originating request.
245
+ */
246
+ x_request_id: string;
247
+ }
248
+ }
249
+
250
+ /**
251
+ * Triggered when a pre-transformation completes successfully. The file has been
252
+ * processed with the requested transformation and is now available in the Media
253
+ * Library.
254
+ */
255
+ export interface UploadPreTransformSuccessEvent extends BaseWebhookEvent {
256
+ /**
257
+ * Timestamp of when the event occurred in ISO8601 format.
258
+ */
259
+ created_at: string;
260
+
261
+ /**
262
+ * Object containing details of a successful upload.
263
+ */
264
+ data: UploadPreTransformSuccessEvent.Data;
265
+
266
+ request: UploadPreTransformSuccessEvent.Request;
267
+
268
+ type: 'upload.pre-transform.success';
269
+ }
270
+
271
+ export namespace UploadPreTransformSuccessEvent {
272
+ /**
273
+ * Object containing details of a successful upload.
274
+ */
275
+ export interface Data {
276
+ /**
277
+ * An array of tags assigned to the uploaded file by auto tagging.
278
+ */
279
+ AITags?: Array<Data.AITag> | null;
280
+
281
+ /**
282
+ * The audio codec used in the video (only for video).
283
+ */
284
+ audioCodec?: string;
285
+
286
+ /**
287
+ * The bit rate of the video in kbps (only for video).
288
+ */
289
+ bitRate?: number;
290
+
291
+ /**
292
+ * Value of custom coordinates associated with the image in the format
293
+ * `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`.
294
+ * Send `customCoordinates` in `responseFields` in API request to get the value of
295
+ * this field.
296
+ */
297
+ customCoordinates?: string | null;
298
+
299
+ /**
300
+ * A key-value data associated with the asset. Use `responseField` in API request
301
+ * to get `customMetadata` in the upload API response. Before setting any custom
302
+ * metadata on an asset, you have to create the field using custom metadata fields
303
+ * API. Send `customMetadata` in `responseFields` in API request to get the value
304
+ * of this field.
305
+ */
306
+ customMetadata?: { [key: string]: unknown };
307
+
308
+ /**
309
+ * Optional text to describe the contents of the file. Can be set by the user or
310
+ * the ai-auto-description extension.
311
+ */
312
+ description?: string;
313
+
314
+ /**
315
+ * The duration of the video in seconds (only for video).
316
+ */
317
+ duration?: number;
318
+
319
+ /**
320
+ * Consolidated embedded metadata associated with the file. It includes exif, iptc,
321
+ * and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get
322
+ * embeddedMetadata in the upload API response.
323
+ */
324
+ embeddedMetadata?: { [key: string]: unknown };
325
+
326
+ /**
327
+ * Extension names with their processing status at the time of completion of the
328
+ * request. It could have one of the following status values:
329
+ *
330
+ * `success`: The extension has been successfully applied. `failed`: The extension
331
+ * has failed and will not be retried. `pending`: The extension will finish
332
+ * processing in some time. On completion, the final status (success / failed) will
333
+ * be sent to the `webhookUrl` provided.
334
+ *
335
+ * If no extension was requested, then this parameter is not returned.
336
+ */
337
+ extensionStatus?: Data.ExtensionStatus;
338
+
339
+ /**
340
+ * Unique fileId. Store this fileld in your database, as this will be used to
341
+ * perform update action on this file.
342
+ */
343
+ fileId?: string;
344
+
345
+ /**
346
+ * The relative path of the file in the media library e.g.
347
+ * `/marketing-assets/new-banner.jpg`.
348
+ */
349
+ filePath?: string;
350
+
351
+ /**
352
+ * Type of the uploaded file. Possible values are `image`, `non-image`.
353
+ */
354
+ fileType?: string;
355
+
356
+ /**
357
+ * Height of the image in pixels (Only for images)
358
+ */
359
+ height?: number;
360
+
361
+ /**
362
+ * Is the file marked as private. It can be either `true` or `false`. Send
363
+ * `isPrivateFile` in `responseFields` in API request to get the value of this
364
+ * field.
365
+ */
366
+ isPrivateFile?: boolean;
367
+
368
+ /**
369
+ * Is the file published or in draft state. It can be either `true` or `false`.
370
+ * Send `isPublished` in `responseFields` in API request to get the value of this
371
+ * field.
372
+ */
373
+ isPublished?: boolean;
374
+
375
+ /**
376
+ * Legacy metadata. Send `metadata` in `responseFields` in API request to get
377
+ * metadata in the upload API response.
378
+ */
379
+ metadata?: FilesAPI.Metadata;
380
+
381
+ /**
382
+ * Name of the asset.
383
+ */
384
+ name?: string;
385
+
386
+ /**
387
+ * Size of the image file in Bytes.
388
+ */
389
+ size?: number;
390
+
391
+ /**
392
+ * The array of tags associated with the asset. If no tags are set, it will be
393
+ * `null`. Send `tags` in `responseFields` in API request to get the value of this
394
+ * field.
395
+ */
396
+ tags?: Array<string> | null;
397
+
398
+ /**
399
+ * In the case of an image, a small thumbnail URL.
400
+ */
401
+ thumbnailUrl?: string;
402
+
403
+ /**
404
+ * A publicly accessible URL of the file.
405
+ */
406
+ url?: string;
407
+
408
+ /**
409
+ * An object containing the file or file version's `id` (versionId) and `name`.
410
+ */
411
+ versionInfo?: Data.VersionInfo;
412
+
413
+ /**
414
+ * The video codec used in the video (only for video).
415
+ */
416
+ videoCodec?: string;
417
+
418
+ /**
419
+ * Width of the image in pixels (Only for Images)
420
+ */
421
+ width?: number;
422
+ }
423
+
424
+ export namespace Data {
425
+ export interface AITag {
426
+ /**
427
+ * Confidence score of the tag.
428
+ */
429
+ confidence?: number;
430
+
431
+ /**
432
+ * Name of the tag.
433
+ */
434
+ name?: string;
435
+
436
+ /**
437
+ * Array of `AITags` associated with the image. If no `AITags` are set, it will be
438
+ * null. These tags can be added using the `google-auto-tagging` or
439
+ * `aws-auto-tagging` extensions.
440
+ */
441
+ source?: string;
442
+ }
443
+
444
+ /**
445
+ * Extension names with their processing status at the time of completion of the
446
+ * request. It could have one of the following status values:
447
+ *
448
+ * `success`: The extension has been successfully applied. `failed`: The extension
449
+ * has failed and will not be retried. `pending`: The extension will finish
450
+ * processing in some time. On completion, the final status (success / failed) will
451
+ * be sent to the `webhookUrl` provided.
452
+ *
453
+ * If no extension was requested, then this parameter is not returned.
454
+ */
455
+ export interface ExtensionStatus {
456
+ 'ai-auto-description'?: 'success' | 'pending' | 'failed';
457
+
458
+ 'aws-auto-tagging'?: 'success' | 'pending' | 'failed';
459
+
460
+ 'google-auto-tagging'?: 'success' | 'pending' | 'failed';
461
+
462
+ 'remove-bg'?: 'success' | 'pending' | 'failed';
463
+ }
464
+
465
+ /**
466
+ * An object containing the file or file version's `id` (versionId) and `name`.
467
+ */
468
+ export interface VersionInfo {
469
+ /**
470
+ * Unique identifier of the file version.
471
+ */
472
+ id?: string;
473
+
474
+ /**
475
+ * Name of the file version.
476
+ */
477
+ name?: string;
478
+ }
479
+ }
480
+
481
+ export interface Request {
482
+ /**
483
+ * The requested pre-transformation string.
484
+ */
485
+ transformation: string;
486
+
487
+ /**
488
+ * Unique identifier for the originating request.
489
+ */
490
+ x_request_id: string;
491
+ }
492
+ }
493
+
494
+ /**
495
+ * Triggered when a new video transformation request is accepted for processing.
496
+ * This event confirms that ImageKit has received and queued your transformation
497
+ * request. Use this for debugging and tracking transformation lifecycle.
498
+ */
499
+ export interface VideoTransformationAcceptedEvent extends BaseWebhookEvent {
500
+ /**
501
+ * Timestamp when the event was created in ISO8601 format.
502
+ */
503
+ created_at: string;
504
+
505
+ data: VideoTransformationAcceptedEvent.Data;
506
+
507
+ /**
508
+ * Information about the original request that triggered the video transformation.
509
+ */
510
+ request: VideoTransformationAcceptedEvent.Request;
511
+
512
+ type: 'video.transformation.accepted';
513
+ }
514
+
515
+ export namespace VideoTransformationAcceptedEvent {
516
+ export interface Data {
517
+ /**
518
+ * Information about the source video asset being transformed.
519
+ */
520
+ asset: Data.Asset;
521
+
522
+ /**
523
+ * Base information about a video transformation request.
524
+ */
525
+ transformation: Data.Transformation;
526
+ }
527
+
528
+ export namespace Data {
529
+ /**
530
+ * Information about the source video asset being transformed.
531
+ */
532
+ export interface Asset {
533
+ /**
534
+ * URL to download or access the source video file.
535
+ */
536
+ url: string;
537
+ }
538
+
539
+ /**
540
+ * Base information about a video transformation request.
541
+ */
542
+ export interface Transformation {
543
+ /**
544
+ * Type of video transformation:
545
+ *
546
+ * - `video-transformation`: Standard video processing (resize, format conversion,
547
+ * etc.)
548
+ * - `gif-to-video`: Convert animated GIF to video format
549
+ * - `video-thumbnail`: Generate thumbnail image from video
550
+ */
551
+ type: 'video-transformation' | 'gif-to-video' | 'video-thumbnail';
552
+
553
+ /**
554
+ * Configuration options for video transformations.
555
+ */
556
+ options?: Transformation.Options;
557
+ }
558
+
559
+ export namespace Transformation {
560
+ /**
561
+ * Configuration options for video transformations.
562
+ */
563
+ export interface Options {
564
+ /**
565
+ * Audio codec used for encoding (aac or opus).
566
+ */
567
+ audio_codec?: 'aac' | 'opus';
568
+
569
+ /**
570
+ * Whether to automatically rotate the video based on metadata.
571
+ */
572
+ auto_rotate?: boolean;
573
+
574
+ /**
575
+ * Output format for the transformed video or thumbnail.
576
+ */
577
+ format?: 'mp4' | 'webm' | 'jpg' | 'png' | 'webp';
578
+
579
+ /**
580
+ * Quality setting for the output video.
581
+ */
582
+ quality?: number;
583
+
584
+ /**
585
+ * Streaming protocol for adaptive bitrate streaming.
586
+ */
587
+ stream_protocol?: 'HLS' | 'DASH';
588
+
589
+ /**
590
+ * Array of quality representations for adaptive bitrate streaming.
591
+ */
592
+ variants?: Array<string>;
593
+
594
+ /**
595
+ * Video codec used for encoding (h264, vp9, or av1).
596
+ */
597
+ video_codec?: 'h264' | 'vp9' | 'av1';
598
+ }
599
+ }
600
+ }
601
+
602
+ /**
603
+ * Information about the original request that triggered the video transformation.
604
+ */
605
+ export interface Request {
606
+ /**
607
+ * Full URL of the transformation request that was submitted.
608
+ */
609
+ url: string;
610
+
611
+ /**
612
+ * Unique identifier for the originating transformation request.
613
+ */
614
+ x_request_id: string;
615
+
616
+ /**
617
+ * User-Agent header from the original request that triggered the transformation.
618
+ */
619
+ user_agent?: string;
620
+ }
621
+ }
622
+
623
+ /**
624
+ * Triggered when an error occurs during video encoding. Listen to this webhook to
625
+ * log error reasons and debug issues. Check your origin and URL endpoint settings
626
+ * if the reason is related to download failure. For other errors, contact ImageKit
627
+ * support.
628
+ */
629
+ export interface VideoTransformationErrorEvent extends BaseWebhookEvent {
630
+ /**
631
+ * Timestamp when the event was created in ISO8601 format.
632
+ */
633
+ created_at: string;
634
+
635
+ data: VideoTransformationErrorEvent.Data;
636
+
637
+ /**
638
+ * Information about the original request that triggered the video transformation.
639
+ */
640
+ request: VideoTransformationErrorEvent.Request;
641
+
642
+ type: 'video.transformation.error';
643
+ }
644
+
645
+ export namespace VideoTransformationErrorEvent {
646
+ export interface Data {
647
+ /**
648
+ * Information about the source video asset being transformed.
649
+ */
650
+ asset: Data.Asset;
651
+
652
+ transformation: Data.Transformation;
653
+ }
654
+
655
+ export namespace Data {
656
+ /**
657
+ * Information about the source video asset being transformed.
658
+ */
659
+ export interface Asset {
660
+ /**
661
+ * URL to download or access the source video file.
662
+ */
663
+ url: string;
664
+ }
665
+
666
+ export interface Transformation {
667
+ /**
668
+ * Type of video transformation:
669
+ *
670
+ * - `video-transformation`: Standard video processing (resize, format conversion,
671
+ * etc.)
672
+ * - `gif-to-video`: Convert animated GIF to video format
673
+ * - `video-thumbnail`: Generate thumbnail image from video
674
+ */
675
+ type: 'video-transformation' | 'gif-to-video' | 'video-thumbnail';
676
+
677
+ /**
678
+ * Details about the transformation error.
679
+ */
680
+ error?: Transformation.Error;
681
+
682
+ /**
683
+ * Configuration options for video transformations.
684
+ */
685
+ options?: Transformation.Options;
686
+ }
687
+
688
+ export namespace Transformation {
689
+ /**
690
+ * Details about the transformation error.
691
+ */
692
+ export interface Error {
693
+ /**
694
+ * Specific reason for the transformation failure:
695
+ *
696
+ * - `encoding_failed`: Error during video encoding process
697
+ * - `download_failed`: Could not download source video
698
+ * - `internal_server_error`: Unexpected server error
699
+ */
700
+ reason: 'encoding_failed' | 'download_failed' | 'internal_server_error';
701
+ }
702
+
703
+ /**
704
+ * Configuration options for video transformations.
705
+ */
706
+ export interface Options {
707
+ /**
708
+ * Audio codec used for encoding (aac or opus).
709
+ */
710
+ audio_codec?: 'aac' | 'opus';
711
+
712
+ /**
713
+ * Whether to automatically rotate the video based on metadata.
714
+ */
715
+ auto_rotate?: boolean;
716
+
717
+ /**
718
+ * Output format for the transformed video or thumbnail.
719
+ */
720
+ format?: 'mp4' | 'webm' | 'jpg' | 'png' | 'webp';
721
+
722
+ /**
723
+ * Quality setting for the output video.
724
+ */
725
+ quality?: number;
726
+
727
+ /**
728
+ * Streaming protocol for adaptive bitrate streaming.
729
+ */
730
+ stream_protocol?: 'HLS' | 'DASH';
731
+
732
+ /**
733
+ * Array of quality representations for adaptive bitrate streaming.
734
+ */
735
+ variants?: Array<string>;
736
+
737
+ /**
738
+ * Video codec used for encoding (h264, vp9, or av1).
739
+ */
740
+ video_codec?: 'h264' | 'vp9' | 'av1';
741
+ }
742
+ }
743
+ }
744
+
745
+ /**
746
+ * Information about the original request that triggered the video transformation.
747
+ */
748
+ export interface Request {
749
+ /**
750
+ * Full URL of the transformation request that was submitted.
751
+ */
752
+ url: string;
753
+
754
+ /**
755
+ * Unique identifier for the originating transformation request.
756
+ */
757
+ x_request_id: string;
758
+
759
+ /**
760
+ * User-Agent header from the original request that triggered the transformation.
761
+ */
762
+ user_agent?: string;
763
+ }
764
+ }
765
+
766
+ /**
767
+ * Triggered when video encoding is finished and the transformed resource is ready
768
+ * to be served. This is the key event to listen for - update your database or CMS
769
+ * flags when you receive this so your application can start showing the
770
+ * transformed video to users.
771
+ */
772
+ export interface VideoTransformationReadyEvent extends BaseWebhookEvent {
773
+ /**
774
+ * Timestamp when the event was created in ISO8601 format.
775
+ */
776
+ created_at: string;
777
+
778
+ data: VideoTransformationReadyEvent.Data;
779
+
780
+ /**
781
+ * Information about the original request that triggered the video transformation.
782
+ */
783
+ request: VideoTransformationReadyEvent.Request;
784
+
785
+ type: 'video.transformation.ready';
786
+
787
+ /**
788
+ * Performance metrics for the transformation process.
789
+ */
790
+ timings?: VideoTransformationReadyEvent.Timings;
791
+ }
792
+
793
+ export namespace VideoTransformationReadyEvent {
794
+ export interface Data {
795
+ /**
796
+ * Information about the source video asset being transformed.
797
+ */
798
+ asset: Data.Asset;
799
+
800
+ transformation: Data.Transformation;
801
+ }
802
+
803
+ export namespace Data {
804
+ /**
805
+ * Information about the source video asset being transformed.
806
+ */
807
+ export interface Asset {
808
+ /**
809
+ * URL to download or access the source video file.
810
+ */
811
+ url: string;
812
+ }
813
+
814
+ export interface Transformation {
815
+ /**
816
+ * Type of video transformation:
817
+ *
818
+ * - `video-transformation`: Standard video processing (resize, format conversion,
819
+ * etc.)
820
+ * - `gif-to-video`: Convert animated GIF to video format
821
+ * - `video-thumbnail`: Generate thumbnail image from video
822
+ */
823
+ type: 'video-transformation' | 'gif-to-video' | 'video-thumbnail';
824
+
825
+ /**
826
+ * Configuration options for video transformations.
827
+ */
828
+ options?: Transformation.Options;
829
+
830
+ /**
831
+ * Information about the transformed output video.
832
+ */
833
+ output?: Transformation.Output;
834
+ }
835
+
836
+ export namespace Transformation {
837
+ /**
838
+ * Configuration options for video transformations.
839
+ */
840
+ export interface Options {
841
+ /**
842
+ * Audio codec used for encoding (aac or opus).
843
+ */
844
+ audio_codec?: 'aac' | 'opus';
845
+
846
+ /**
847
+ * Whether to automatically rotate the video based on metadata.
848
+ */
849
+ auto_rotate?: boolean;
850
+
851
+ /**
852
+ * Output format for the transformed video or thumbnail.
853
+ */
854
+ format?: 'mp4' | 'webm' | 'jpg' | 'png' | 'webp';
855
+
856
+ /**
857
+ * Quality setting for the output video.
858
+ */
859
+ quality?: number;
860
+
861
+ /**
862
+ * Streaming protocol for adaptive bitrate streaming.
863
+ */
864
+ stream_protocol?: 'HLS' | 'DASH';
865
+
866
+ /**
867
+ * Array of quality representations for adaptive bitrate streaming.
868
+ */
869
+ variants?: Array<string>;
870
+
871
+ /**
872
+ * Video codec used for encoding (h264, vp9, or av1).
873
+ */
874
+ video_codec?: 'h264' | 'vp9' | 'av1';
875
+ }
876
+
877
+ /**
878
+ * Information about the transformed output video.
879
+ */
880
+ export interface Output {
881
+ /**
882
+ * URL to access the transformed video.
883
+ */
884
+ url: string;
885
+
886
+ /**
887
+ * Metadata of the output video file.
888
+ */
889
+ video_metadata?: Output.VideoMetadata;
890
+ }
891
+
892
+ export namespace Output {
893
+ /**
894
+ * Metadata of the output video file.
895
+ */
896
+ export interface VideoMetadata {
897
+ /**
898
+ * Bitrate of the output video in bits per second.
899
+ */
900
+ bitrate: number;
901
+
902
+ /**
903
+ * Duration of the output video in seconds.
904
+ */
905
+ duration: number;
906
+
907
+ /**
908
+ * Height of the output video in pixels.
909
+ */
910
+ height: number;
911
+
912
+ /**
913
+ * Width of the output video in pixels.
914
+ */
915
+ width: number;
916
+ }
917
+ }
918
+ }
919
+ }
920
+
921
+ /**
922
+ * Information about the original request that triggered the video transformation.
923
+ */
924
+ export interface Request {
925
+ /**
926
+ * Full URL of the transformation request that was submitted.
927
+ */
928
+ url: string;
929
+
930
+ /**
931
+ * Unique identifier for the originating transformation request.
932
+ */
933
+ x_request_id: string;
934
+
935
+ /**
936
+ * User-Agent header from the original request that triggered the transformation.
937
+ */
938
+ user_agent?: string;
939
+ }
940
+
941
+ /**
942
+ * Performance metrics for the transformation process.
943
+ */
944
+ export interface Timings {
945
+ /**
946
+ * Time spent downloading the source video from your origin or media library, in
947
+ * milliseconds.
948
+ */
949
+ download_duration?: number;
950
+
951
+ /**
952
+ * Time spent encoding the video, in milliseconds.
953
+ */
954
+ encoding_duration?: number;
955
+ }
956
+ }
957
+
958
+ /**
959
+ * Triggered when a new video transformation request is accepted for processing.
960
+ * This event confirms that ImageKit has received and queued your transformation
961
+ * request. Use this for debugging and tracking transformation lifecycle.
962
+ */
963
+ export type UnsafeUnwrapWebhookEvent =
964
+ | VideoTransformationAcceptedEvent
965
+ | VideoTransformationReadyEvent
966
+ | VideoTransformationErrorEvent
967
+ | UploadPreTransformSuccessEvent
968
+ | UploadPreTransformErrorEvent
969
+ | UploadPostTransformSuccessEvent
970
+ | UploadPostTransformErrorEvent;
971
+
972
+ /**
973
+ * Triggered when a new video transformation request is accepted for processing.
974
+ * This event confirms that ImageKit has received and queued your transformation
975
+ * request. Use this for debugging and tracking transformation lifecycle.
976
+ */
977
+ export type UnwrapWebhookEvent =
978
+ | VideoTransformationAcceptedEvent
979
+ | VideoTransformationReadyEvent
980
+ | VideoTransformationErrorEvent
981
+ | UploadPreTransformSuccessEvent
982
+ | UploadPreTransformErrorEvent
983
+ | UploadPostTransformSuccessEvent
984
+ | UploadPostTransformErrorEvent;
985
+
986
+ export declare namespace Webhooks {
987
+ export {
988
+ type BaseWebhookEvent as BaseWebhookEvent,
989
+ type UploadPostTransformErrorEvent as UploadPostTransformErrorEvent,
990
+ type UploadPostTransformSuccessEvent as UploadPostTransformSuccessEvent,
991
+ type UploadPreTransformErrorEvent as UploadPreTransformErrorEvent,
992
+ type UploadPreTransformSuccessEvent as UploadPreTransformSuccessEvent,
993
+ type VideoTransformationAcceptedEvent as VideoTransformationAcceptedEvent,
994
+ type VideoTransformationErrorEvent as VideoTransformationErrorEvent,
995
+ type VideoTransformationReadyEvent as VideoTransformationReadyEvent,
996
+ type UnsafeUnwrapWebhookEvent as UnsafeUnwrapWebhookEvent,
997
+ type UnwrapWebhookEvent as UnwrapWebhookEvent,
998
+ };
999
+ }