@design-edito/tools 0.4.22 → 0.5.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 (505) hide show
  1. package/agnostic/arrays/find-duplicates/index.d.ts +1 -1
  2. package/agnostic/arrays/find-duplicates/index.js +3 -2
  3. package/agnostic/arrays/is-array-of/index.d.ts +1 -1
  4. package/agnostic/arrays/is-array-of/index.js +3 -1
  5. package/agnostic/arrays/make/index.d.ts +1 -1
  6. package/agnostic/arrays/random-pick/index.js +2 -1
  7. package/agnostic/arrays/shuffle/index.js +1 -1
  8. package/agnostic/booleans/is-falsy/index.d.ts +3 -3
  9. package/agnostic/booleans/is-falsy/index.js +2 -3
  10. package/agnostic/colors/channels/index.d.ts +16 -16
  11. package/agnostic/colors/channels/index.js +15 -15
  12. package/agnostic/colors/contrast/index.d.ts +6 -6
  13. package/agnostic/colors/contrast/index.js +6 -8
  14. package/agnostic/colors/contrast/index.test.js +1 -1
  15. package/agnostic/colors/convert/index.d.ts +43 -43
  16. package/agnostic/colors/convert/index.js +60 -55
  17. package/agnostic/colors/distance/index.d.ts +5 -5
  18. package/agnostic/colors/distance/index.js +5 -4
  19. package/agnostic/colors/grayscale/index.d.ts +3 -3
  20. package/agnostic/colors/grayscale/index.js +3 -3
  21. package/agnostic/colors/index.d.ts +1 -1
  22. package/agnostic/colors/index.js +1 -1
  23. package/agnostic/colors/invert/index.d.ts +4 -4
  24. package/agnostic/colors/invert/index.js +3 -3
  25. package/agnostic/colors/lerp/index.d.ts +6 -7
  26. package/agnostic/colors/lerp/index.js +5 -6
  27. package/agnostic/colors/luminance/index.d.ts +4 -4
  28. package/agnostic/colors/luminance/index.js +3 -3
  29. package/agnostic/colors/palette/index.d.ts +3 -3
  30. package/agnostic/colors/palette/index.js +4 -3
  31. package/agnostic/colors/rotate/index.d.ts +4 -4
  32. package/agnostic/colors/rotate/index.js +4 -4
  33. package/agnostic/colors/tidy/index.d.ts +2 -2
  34. package/agnostic/colors/tidy/index.js +2 -2
  35. package/agnostic/colors/typechecks/index.d.ts +21 -21
  36. package/agnostic/colors/typechecks/index.js +22 -21
  37. package/agnostic/colors/types.d.ts +33 -33
  38. package/agnostic/css/bem/index.d.ts +11 -11
  39. package/agnostic/css/bem/index.js +9 -8
  40. package/agnostic/css/clss/index.d.ts +1 -1
  41. package/agnostic/css/clss/index.js +1 -1
  42. package/agnostic/css/index.d.ts +1 -1
  43. package/agnostic/css/index.js +1 -1
  44. package/agnostic/css/is-valid-css-class-name/index.d.ts +2 -2
  45. package/agnostic/css/is-valid-css-class-name/index.js +3 -3
  46. package/agnostic/css/scale/index.d.ts +18 -18
  47. package/agnostic/css/scale/index.js +18 -18
  48. package/agnostic/css/styles-set/index.d.ts +1 -1
  49. package/agnostic/css/styles-set/index.js +0 -2
  50. package/agnostic/errors/register/index.d.ts +1 -1
  51. package/agnostic/errors/register/index.js +3 -0
  52. package/agnostic/errors/unknown-to-string/index.d.ts +2 -2
  53. package/agnostic/errors/unknown-to-string/index.js +2 -3
  54. package/agnostic/html/deep-select/index.d.ts +3 -3
  55. package/agnostic/html/deep-select/index.js +11 -7
  56. package/agnostic/html/get-node-ancestors/index.d.ts +3 -3
  57. package/agnostic/html/get-node-ancestors/index.js +3 -3
  58. package/agnostic/html/get-position-inside-parent/index.d.ts +2 -2
  59. package/agnostic/html/get-position-inside-parent/index.js +2 -2
  60. package/agnostic/html/hyper-json/cast/index.d.ts +1 -1
  61. package/agnostic/html/hyper-json/cast/index.js +6 -5
  62. package/agnostic/html/hyper-json/method/index.d.ts +2 -2
  63. package/agnostic/html/hyper-json/serialize/index.d.ts +1 -1
  64. package/agnostic/html/hyper-json/serialize/index.js +9 -5
  65. package/agnostic/html/hyper-json/smart-tags/coalesced/addclass/index.js +1 -0
  66. package/agnostic/html/hyper-json/smart-tags/coalesced/and/index.d.ts +1 -1
  67. package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.d.ts +1 -1
  68. package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.js +1 -0
  69. package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.d.ts +1 -1
  70. package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.js +1 -0
  71. package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.d.ts +1 -1
  72. package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.js +1 -1
  73. package/agnostic/html/hyper-json/smart-tags/coalesced/clone/index.d.ts +1 -1
  74. package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.d.ts +1 -1
  75. package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.js +0 -1
  76. package/agnostic/html/hyper-json/smart-tags/coalesced/equals/index.d.ts +1 -1
  77. package/agnostic/html/hyper-json/smart-tags/coalesced/getattribute/index.js +1 -0
  78. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperties/index.d.ts +1 -1
  79. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.d.ts +1 -1
  80. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.js +1 -2
  81. package/agnostic/html/hyper-json/smart-tags/coalesced/hjparse/index.d.ts +1 -1
  82. package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.d.ts +1 -1
  83. package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.js +4 -0
  84. package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.d.ts +1 -1
  85. package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.js +1 -0
  86. package/agnostic/html/hyper-json/smart-tags/coalesced/index.d.ts +11 -11
  87. package/agnostic/html/hyper-json/smart-tags/coalesced/index.js +11 -11
  88. package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.d.ts +1 -1
  89. package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.js +1 -0
  90. package/agnostic/html/hyper-json/smart-tags/coalesced/join/index.d.ts +1 -1
  91. package/agnostic/html/hyper-json/smart-tags/coalesced/length/index.d.ts +1 -1
  92. package/agnostic/html/hyper-json/smart-tags/coalesced/map/index.d.ts +1 -1
  93. package/agnostic/html/hyper-json/smart-tags/coalesced/or/index.d.ts +1 -1
  94. package/agnostic/html/hyper-json/smart-tags/coalesced/pickrandom/index.d.ts +1 -1
  95. package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.d.ts +1 -1
  96. package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.js +1 -0
  97. package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.d.ts +1 -1
  98. package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.js +2 -0
  99. package/agnostic/html/hyper-json/smart-tags/coalesced/push/index.d.ts +1 -1
  100. package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.d.ts +1 -1
  101. package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.js +1 -0
  102. package/agnostic/html/hyper-json/smart-tags/coalesced/recordtoarray/index.d.ts +1 -1
  103. package/agnostic/html/hyper-json/smart-tags/coalesced/removeattribute/index.js +3 -0
  104. package/agnostic/html/hyper-json/smart-tags/coalesced/removeclass/index.js +1 -0
  105. package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.d.ts +1 -1
  106. package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.js +1 -0
  107. package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.d.ts +1 -1
  108. package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.js +1 -0
  109. package/agnostic/html/hyper-json/smart-tags/coalesced/select/index.js +1 -0
  110. package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.d.ts +1 -1
  111. package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.js +1 -0
  112. package/agnostic/html/hyper-json/smart-tags/coalesced/setattribute/index.js +3 -0
  113. package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.d.ts +1 -1
  114. package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.js +4 -2
  115. package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.d.ts +1 -1
  116. package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.js +5 -0
  117. package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.d.ts +1 -1
  118. package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.js +1 -0
  119. package/agnostic/html/hyper-json/smart-tags/coalesced/toarray/index.d.ts +1 -1
  120. package/agnostic/html/hyper-json/smart-tags/coalesced/toboolean/index.d.ts +1 -1
  121. package/agnostic/html/hyper-json/smart-tags/coalesced/toelement/index.d.ts +1 -1
  122. package/agnostic/html/hyper-json/smart-tags/coalesced/toggleclass/index.js +3 -2
  123. package/agnostic/html/hyper-json/smart-tags/coalesced/tonodelist/index.d.ts +1 -1
  124. package/agnostic/html/hyper-json/smart-tags/coalesced/tonull/index.d.ts +1 -1
  125. package/agnostic/html/hyper-json/smart-tags/coalesced/tonumber/index.d.ts +1 -1
  126. package/agnostic/html/hyper-json/smart-tags/coalesced/torecord/index.d.ts +1 -1
  127. package/agnostic/html/hyper-json/smart-tags/coalesced/toref/index.d.ts +1 -1
  128. package/agnostic/html/hyper-json/smart-tags/coalesced/tostring/index.d.ts +1 -1
  129. package/agnostic/html/hyper-json/smart-tags/coalesced/totext/index.d.ts +1 -1
  130. package/agnostic/html/hyper-json/smart-tags/coalesced/transformselected/index.d.ts +1 -1
  131. package/agnostic/html/hyper-json/smart-tags/coalesced/trim/index.js +1 -1
  132. package/agnostic/html/hyper-json/smart-tags/index.d.ts +1 -1
  133. package/agnostic/html/hyper-json/smart-tags/isolated/any/index.d.ts +1 -1
  134. package/agnostic/html/hyper-json/smart-tags/isolated/array/index.d.ts +1 -1
  135. package/agnostic/html/hyper-json/smart-tags/isolated/get/index.d.ts +1 -1
  136. package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.d.ts +1 -1
  137. package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.js +3 -1
  138. package/agnostic/html/hyper-json/smart-tags/isolated/index.d.ts +1 -1
  139. package/agnostic/html/hyper-json/smart-tags/isolated/index.js +1 -1
  140. package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.d.ts +1 -1
  141. package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.js +1 -0
  142. package/agnostic/html/hyper-json/smart-tags/isolated/null/index.d.ts +1 -1
  143. package/agnostic/html/hyper-json/smart-tags/isolated/record/index.d.ts +1 -1
  144. package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.d.ts +1 -1
  145. package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.js +3 -1
  146. package/agnostic/html/hyper-json/smart-tags/isolated/text/index.js +2 -2
  147. package/agnostic/html/hyper-json/transformer/index.d.ts +5 -5
  148. package/agnostic/html/hyper-json/tree/index.d.ts +1 -1
  149. package/agnostic/html/hyper-json/tree/index.js +14 -8
  150. package/agnostic/html/hyper-json/types/index.d.ts +11 -11
  151. package/agnostic/html/hyper-json/utils/index.d.ts +3 -3
  152. package/agnostic/html/hyper-json/utils/index.js +8 -3
  153. package/agnostic/html/index.d.ts +1 -1
  154. package/agnostic/html/index.js +1 -1
  155. package/agnostic/html/insert-node/index.d.ts +4 -4
  156. package/agnostic/html/insert-node/index.js +4 -4
  157. package/agnostic/html/replace-in-element/index.d.ts +3 -3
  158. package/agnostic/html/replace-in-element/index.js +4 -4
  159. package/agnostic/html/selector-to-element/index.d.ts +2 -2
  160. package/agnostic/html/selector-to-element/index.js +11 -11
  161. package/agnostic/html/string-to-nodes/index.d.ts +3 -3
  162. package/agnostic/html/string-to-nodes/index.js +3 -3
  163. package/agnostic/html/watch-selection/index.d.ts +4 -5
  164. package/agnostic/html/watch-selection/index.js +5 -6
  165. package/agnostic/misc/assert/index.js +3 -1
  166. package/agnostic/misc/cast/index.d.ts +16 -16
  167. package/agnostic/misc/cast/index.js +18 -18
  168. package/agnostic/misc/connection/index.d.ts +5 -5
  169. package/agnostic/misc/connection/index.js +4 -2
  170. package/agnostic/misc/crawler/index.d.ts +18 -18
  171. package/agnostic/misc/crawler/index.js +10 -9
  172. package/agnostic/misc/crawler/index.test.js +2 -2
  173. package/agnostic/misc/crossenv/detect-runtime/index.d.ts +1 -1
  174. package/agnostic/misc/crossenv/detect-runtime/index.js +10 -11
  175. package/agnostic/misc/crossenv/window/index.d.ts +6 -6
  176. package/agnostic/misc/crossenv/window/index.js +6 -5
  177. package/agnostic/misc/data-size/index.js +2 -0
  178. package/agnostic/misc/index.d.ts +3 -3
  179. package/agnostic/misc/index.js +3 -3
  180. package/agnostic/misc/is-constructor-function/index.d.ts +2 -2
  181. package/agnostic/misc/is-constructor-function/index.js +3 -2
  182. package/agnostic/misc/is-constructor-function/index.test.js +2 -2
  183. package/agnostic/misc/is-nullish/index.d.ts +5 -5
  184. package/agnostic/misc/is-nullish/index.js +5 -4
  185. package/agnostic/misc/logs/index.d.ts +1 -1
  186. package/agnostic/misc/logs/index.js +1 -1
  187. package/agnostic/misc/logs/logger/index.js +2 -2
  188. package/agnostic/misc/lorem-ipsum/index.js +4 -4
  189. package/agnostic/misc/normalize-extension/index.d.ts +3 -3
  190. package/agnostic/misc/normalize-extension/index.js +4 -4
  191. package/agnostic/misc/outcome/index.d.ts +14 -14
  192. package/agnostic/misc/outcome/index.js +6 -4
  193. package/agnostic/numbers/absolute-modulo/index.d.ts +3 -3
  194. package/agnostic/numbers/absolute-modulo/index.js +3 -3
  195. package/agnostic/numbers/approximate-rational/index.d.ts +6 -6
  196. package/agnostic/numbers/approximate-rational/index.js +9 -9
  197. package/agnostic/numbers/clamp/index.d.ts +4 -4
  198. package/agnostic/numbers/clamp/index.js +4 -4
  199. package/agnostic/numbers/geometric-progressions/index.d.ts +5 -5
  200. package/agnostic/numbers/geometric-progressions/index.js +7 -5
  201. package/agnostic/numbers/geometric-progressions/index.test.js +2 -2
  202. package/agnostic/numbers/index.d.ts +1 -1
  203. package/agnostic/numbers/index.js +1 -1
  204. package/agnostic/numbers/interpolate/index.d.ts +8 -8
  205. package/agnostic/numbers/interpolate/index.js +8 -8
  206. package/agnostic/numbers/round/index.d.ts +9 -9
  207. package/agnostic/numbers/round/index.js +9 -9
  208. package/agnostic/objects/deep-get-property/index.d.ts +4 -4
  209. package/agnostic/objects/deep-get-property/index.js +3 -3
  210. package/agnostic/objects/enums/is-in-enum/index.d.ts +3 -3
  211. package/agnostic/objects/enums/is-in-enum/index.js +3 -3
  212. package/agnostic/objects/flatten-getters/index.d.ts +2 -2
  213. package/agnostic/objects/flatten-getters/index.js +3 -2
  214. package/agnostic/objects/index.d.ts +1 -1
  215. package/agnostic/objects/index.js +1 -1
  216. package/agnostic/objects/is-object/index.d.ts +4 -4
  217. package/agnostic/objects/is-object/index.js +4 -4
  218. package/agnostic/objects/is-record/index.d.ts +2 -2
  219. package/agnostic/objects/is-record/index.js +2 -2
  220. package/agnostic/objects/record-format/index.d.ts +9 -9
  221. package/agnostic/objects/record-format/index.js +8 -3
  222. package/agnostic/objects/record-map/index.d.ts +4 -4
  223. package/agnostic/objects/record-map/index.js +5 -3
  224. package/agnostic/objects/sort-keys/index.d.ts +3 -3
  225. package/agnostic/objects/sort-keys/index.js +4 -3
  226. package/agnostic/objects/validation/index.d.ts +3 -3
  227. package/agnostic/objects/validation/index.js +4 -3
  228. package/agnostic/optim/memoize/index.d.ts +2 -2
  229. package/agnostic/optim/memoize/index.js +4 -2
  230. package/agnostic/optim/throttle-debounce/index.d.ts +2 -2
  231. package/agnostic/optim/throttle-debounce/index.js +7 -6
  232. package/agnostic/optim/throttle-debounce/types.d.ts +2 -1
  233. package/agnostic/random/random/index.d.ts +7 -8
  234. package/agnostic/random/random/index.js +3 -3
  235. package/agnostic/random/uuid/index.d.ts +6 -6
  236. package/agnostic/random/uuid/index.js +6 -6
  237. package/agnostic/regexps/index.d.ts +30 -60
  238. package/agnostic/regexps/index.js +27 -26
  239. package/agnostic/sanitization/file-name/index.d.ts +3 -3
  240. package/agnostic/sanitization/file-name/index.js +10 -10
  241. package/agnostic/sanitization/html/index.d.ts +6 -6
  242. package/agnostic/sanitization/html/index.js +9 -6
  243. package/agnostic/sanitization/path/index.d.ts +2 -2
  244. package/agnostic/sanitization/path/index.js +2 -2
  245. package/agnostic/sanitization/user-input/index.js +1 -0
  246. package/agnostic/strings/char-codes/index.js +2 -6
  247. package/agnostic/strings/index.d.ts +1 -1
  248. package/agnostic/strings/index.js +1 -1
  249. package/agnostic/strings/normalize-indent/index.js +2 -2
  250. package/agnostic/strings/parse-table/index.d.ts +13 -13
  251. package/agnostic/strings/parse-table/index.js +31 -16
  252. package/agnostic/strings/replace-all/index.d.ts +1 -1
  253. package/agnostic/strings/replace-all/index.js +1 -0
  254. package/agnostic/strings/to-alphanum/index.js +2 -2
  255. package/agnostic/strings/trim/index.js +2 -2
  256. package/agnostic/time/dates/format-date/index.js +3 -1
  257. package/agnostic/time/dates/index.d.ts +1 -0
  258. package/agnostic/time/dates/index.js +1 -0
  259. package/agnostic/time/dates/to-french-republican/index.d.ts +16 -0
  260. package/agnostic/time/dates/to-french-republican/index.js +82 -0
  261. package/agnostic/time/dates/to-french-republican/index.test.d.ts +1 -0
  262. package/agnostic/time/dates/to-french-republican/index.test.js +112 -0
  263. package/agnostic/time/dates/to-french-republican/types.d.ts +91 -0
  264. package/agnostic/time/dates/to-french-republican/types.js +47 -0
  265. package/agnostic/time/dates/to-french-republican/utils.d.ts +32 -0
  266. package/agnostic/time/dates/to-french-republican/utils.js +155 -0
  267. package/agnostic/time/duration/index.js +2 -0
  268. package/agnostic/time/index.d.ts +2 -2
  269. package/agnostic/time/index.js +2 -2
  270. package/agnostic/time/timeout/index.js +9 -9
  271. package/agnostic/time/transitions/index.js +8 -7
  272. package/components/BeforeAfter/index.controlled.js +1 -0
  273. package/components/BeforeAfter/index.js +4 -0
  274. package/components/Button/index.d.ts +2 -7
  275. package/components/Button/index.js +2 -2
  276. package/components/Clippable/index.js +1 -0
  277. package/components/Drawer/index.js +1 -1
  278. package/components/Gallery/index.js +2 -1
  279. package/components/Gallery/utils.js +5 -1
  280. package/components/Iframe/index.d.ts +16 -34
  281. package/components/Iframe/index.js +70 -27
  282. package/components/Image/index.js +2 -0
  283. package/components/Input/index.controlled.d.ts +42 -0
  284. package/components/Input/index.controlled.js +54 -0
  285. package/components/Input/index.d.ts +21 -17
  286. package/components/Input/index.js +27 -18
  287. package/components/IntersectionObserver/index.js +5 -2
  288. package/components/JsonEditor/index.js +1 -1
  289. package/components/Overlayer/index.d.ts +1 -1
  290. package/components/ScrollListener/utils.d.ts +29 -0
  291. package/components/Select/index.controlled.d.ts +43 -0
  292. package/components/Select/index.controlled.js +54 -0
  293. package/components/Select/index.d.ts +22 -18
  294. package/components/Select/index.js +27 -18
  295. package/components/Sequencer/index.controlled.js +1 -1
  296. package/components/Subtitles/index.js +3 -1
  297. package/components/Subtitles/types.d.ts +14 -0
  298. package/components/Subtitles/utils.d.ts +19 -15
  299. package/components/Subtitles/utils.js +29 -24
  300. package/components/Textarea/index.controlled.d.ts +50 -0
  301. package/components/Textarea/index.controlled.js +75 -0
  302. package/components/Textarea/index.d.ts +22 -17
  303. package/components/Textarea/index.js +27 -18
  304. package/components/UIModule/index.js +3 -1
  305. package/components/Video/index.controlled.d.ts +1 -1
  306. package/components/Video/index.controlled.js +11 -10
  307. package/components/Video/index.js +27 -20
  308. package/components/Video/utils.d.ts +1 -1
  309. package/components/Video/utils.js +11 -2
  310. package/components/index.d.ts +1 -1
  311. package/components/index.js +1 -1
  312. package/components/utils/types.d.ts +5 -0
  313. package/node/@aws-s3/storage/directory/copy-dir/index.d.ts +9 -9
  314. package/node/@aws-s3/storage/directory/copy-dir/index.js +15 -12
  315. package/node/@aws-s3/storage/directory/index.d.ts +1 -1
  316. package/node/@aws-s3/storage/directory/index.js +1 -1
  317. package/node/@aws-s3/storage/directory/list/index.d.ts +5 -5
  318. package/node/@aws-s3/storage/directory/list/index.js +5 -5
  319. package/node/@aws-s3/storage/directory/move-dir/index.d.ts +6 -6
  320. package/node/@aws-s3/storage/directory/move-dir/index.js +11 -7
  321. package/node/@aws-s3/storage/directory/remove-dir/index.d.ts +5 -5
  322. package/node/@aws-s3/storage/directory/remove-dir/index.js +5 -5
  323. package/node/@aws-s3/storage/file/copy/index.d.ts +8 -8
  324. package/node/@aws-s3/storage/file/copy/index.js +12 -9
  325. package/node/@aws-s3/storage/file/download/index.d.ts +6 -6
  326. package/node/@aws-s3/storage/file/download/index.js +6 -5
  327. package/node/@aws-s3/storage/file/exists/index.d.ts +6 -6
  328. package/node/@aws-s3/storage/file/exists/index.js +15 -12
  329. package/node/@aws-s3/storage/file/index.d.ts +1 -1
  330. package/node/@aws-s3/storage/file/index.js +1 -1
  331. package/node/@aws-s3/storage/file/move/index.d.ts +9 -9
  332. package/node/@aws-s3/storage/file/move/index.js +18 -15
  333. package/node/@aws-s3/storage/file/remove/index.d.ts +5 -5
  334. package/node/@aws-s3/storage/file/remove/index.js +16 -11
  335. package/node/@aws-s3/storage/file/stat/index.d.ts +5 -5
  336. package/node/@aws-s3/storage/file/stat/index.js +10 -7
  337. package/node/@aws-s3/storage/file/upload/index.d.ts +7 -7
  338. package/node/@aws-s3/storage/file/upload/index.js +11 -9
  339. package/node/@express/@multer/index.d.ts +12 -12
  340. package/node/@express/@multer/index.js +27 -25
  341. package/node/@google-cloud/storage/bucket/get-metadata/index.d.ts +4 -4
  342. package/node/@google-cloud/storage/bucket/get-metadata/index.js +3 -3
  343. package/node/@google-cloud/storage/directory/copy-dir/index.d.ts +7 -7
  344. package/node/@google-cloud/storage/directory/copy-dir/index.js +6 -6
  345. package/node/@google-cloud/storage/directory/index.d.ts +1 -1
  346. package/node/@google-cloud/storage/directory/index.js +1 -1
  347. package/node/@google-cloud/storage/directory/list/index.d.ts +6 -6
  348. package/node/@google-cloud/storage/directory/list/index.js +5 -5
  349. package/node/@google-cloud/storage/directory/move-dir/index.d.ts +6 -6
  350. package/node/@google-cloud/storage/directory/move-dir/index.js +5 -5
  351. package/node/@google-cloud/storage/directory/remove-dir/index.d.ts +7 -7
  352. package/node/@google-cloud/storage/directory/remove-dir/index.js +6 -6
  353. package/node/@google-cloud/storage/file/copy/index.d.ts +9 -9
  354. package/node/@google-cloud/storage/file/copy/index.js +8 -8
  355. package/node/@google-cloud/storage/file/download/index.d.ts +7 -7
  356. package/node/@google-cloud/storage/file/download/index.js +5 -5
  357. package/node/@google-cloud/storage/file/exists/index.d.ts +7 -7
  358. package/node/@google-cloud/storage/file/exists/index.js +6 -6
  359. package/node/@google-cloud/storage/file/generate-signed-url/index.d.ts +7 -7
  360. package/node/@google-cloud/storage/file/generate-signed-url/index.js +6 -6
  361. package/node/@google-cloud/storage/file/get-metadata/index.d.ts +5 -5
  362. package/node/@google-cloud/storage/file/get-metadata/index.js +4 -4
  363. package/node/@google-cloud/storage/file/get-permissions/index.d.ts +6 -6
  364. package/node/@google-cloud/storage/file/get-permissions/index.js +4 -4
  365. package/node/@google-cloud/storage/file/index.d.ts +1 -1
  366. package/node/@google-cloud/storage/file/index.js +1 -1
  367. package/node/@google-cloud/storage/file/move/index.d.ts +10 -10
  368. package/node/@google-cloud/storage/file/move/index.js +9 -9
  369. package/node/@google-cloud/storage/file/remove/index.d.ts +5 -5
  370. package/node/@google-cloud/storage/file/remove/index.js +4 -4
  371. package/node/@google-cloud/storage/file/revoke-signed-urls/index.d.ts +5 -5
  372. package/node/@google-cloud/storage/file/revoke-signed-urls/index.js +5 -5
  373. package/node/@google-cloud/storage/file/stat/index.d.ts +5 -5
  374. package/node/@google-cloud/storage/file/stat/index.js +4 -4
  375. package/node/@google-cloud/storage/file/update-metadata/index.d.ts +7 -7
  376. package/node/@google-cloud/storage/file/update-metadata/index.js +5 -5
  377. package/node/@google-cloud/storage/file/upload/index.d.ts +7 -7
  378. package/node/@google-cloud/storage/file/upload/index.js +5 -5
  379. package/node/@google-cloud/storage/index.d.ts +1 -1
  380. package/node/@google-cloud/storage/index.js +1 -1
  381. package/node/cloud-storage/clients/index.d.ts +8 -8
  382. package/node/cloud-storage/clients/index.js +8 -8
  383. package/node/cloud-storage/operations/copy-dir/index.d.ts +22 -22
  384. package/node/cloud-storage/operations/copy-dir/index.js +5 -5
  385. package/node/cloud-storage/operations/copy-file/index.d.ts +22 -22
  386. package/node/cloud-storage/operations/copy-file/index.js +5 -5
  387. package/node/cloud-storage/operations/download-file/index.d.ts +19 -19
  388. package/node/cloud-storage/operations/download-file/index.js +6 -6
  389. package/node/cloud-storage/operations/exists-file/index.d.ts +15 -26
  390. package/node/cloud-storage/operations/exists-file/index.js +4 -4
  391. package/node/cloud-storage/operations/index.d.ts +1 -1
  392. package/node/cloud-storage/operations/index.js +1 -1
  393. package/node/cloud-storage/operations/list-dir/index.d.ts +15 -25
  394. package/node/cloud-storage/operations/list-dir/index.js +4 -4
  395. package/node/cloud-storage/operations/move-dir/index.d.ts +22 -22
  396. package/node/cloud-storage/operations/move-dir/index.js +5 -5
  397. package/node/cloud-storage/operations/move-file/index.d.ts +22 -22
  398. package/node/cloud-storage/operations/move-file/index.js +5 -5
  399. package/node/cloud-storage/operations/remove-dir/index.d.ts +18 -18
  400. package/node/cloud-storage/operations/remove-dir/index.js +4 -4
  401. package/node/cloud-storage/operations/remove-file/index.d.ts +18 -18
  402. package/node/cloud-storage/operations/remove-file/index.js +4 -4
  403. package/node/cloud-storage/operations/stat-file/index.d.ts +16 -16
  404. package/node/cloud-storage/operations/stat-file/index.js +4 -4
  405. package/node/cloud-storage/operations/upload-file/index.d.ts +23 -23
  406. package/node/cloud-storage/operations/upload-file/index.js +5 -5
  407. package/node/encryption/@aes-256-gcm/buffer/index.d.ts +6 -6
  408. package/node/encryption/@aes-256-gcm/buffer/index.js +6 -6
  409. package/node/encryption/@aes-256-gcm/uint8-array/index.d.ts +8 -8
  410. package/node/encryption/@aes-256-gcm/uint8-array/index.js +8 -8
  411. package/node/encryption/key/index.d.ts +6 -6
  412. package/node/encryption/key/index.js +6 -6
  413. package/node/files/read-write/index.d.ts +16 -16
  414. package/node/files/subpaths/index.d.ts +8 -8
  415. package/node/files/subpaths/index.js +11 -13
  416. package/node/ftps/directory/copy-dir/index.d.ts +6 -6
  417. package/node/ftps/directory/copy-dir/index.js +6 -6
  418. package/node/ftps/directory/list/index.d.ts +4 -4
  419. package/node/ftps/directory/list/index.js +3 -3
  420. package/node/ftps/directory/move-dir/index.d.ts +6 -6
  421. package/node/ftps/directory/move-dir/index.js +5 -5
  422. package/node/ftps/directory/remove-dir/index.d.ts +6 -6
  423. package/node/ftps/directory/remove-dir/index.js +8 -7
  424. package/node/ftps/file/copy/index.d.ts +6 -6
  425. package/node/ftps/file/copy/index.js +5 -5
  426. package/node/ftps/file/download/index.d.ts +6 -6
  427. package/node/ftps/file/download/index.js +5 -5
  428. package/node/ftps/file/exists/index.d.ts +3 -3
  429. package/node/ftps/file/exists/index.js +3 -3
  430. package/node/ftps/file/move/index.d.ts +8 -8
  431. package/node/ftps/file/move/index.js +11 -9
  432. package/node/ftps/file/remove/index.d.ts +5 -5
  433. package/node/ftps/file/remove/index.js +4 -4
  434. package/node/ftps/file/stat/index.d.ts +4 -4
  435. package/node/ftps/file/stat/index.js +4 -4
  436. package/node/ftps/file/upload/index.d.ts +7 -7
  437. package/node/ftps/file/upload/index.js +5 -5
  438. package/node/images/create/index.d.ts +2 -2
  439. package/node/images/create/index.js +1 -1
  440. package/node/images/format/index.d.ts +8 -8
  441. package/node/images/metadata/index.d.ts +2 -2
  442. package/node/images/transform/index.d.ts +2 -2
  443. package/node/images/transform/index.js +12 -2
  444. package/node/images/transform/operations/blur/index.d.ts +2 -2
  445. package/node/images/transform/operations/blur/index.js +1 -0
  446. package/node/images/transform/operations/brighten/index.d.ts +2 -2
  447. package/node/images/transform/operations/brighten/index.js +1 -0
  448. package/node/images/transform/operations/extend/index.d.ts +2 -2
  449. package/node/images/transform/operations/extend/index.js +1 -0
  450. package/node/images/transform/operations/extract/index.d.ts +2 -2
  451. package/node/images/transform/operations/extract/index.js +1 -0
  452. package/node/images/transform/operations/flatten/index.d.ts +2 -2
  453. package/node/images/transform/operations/flatten/index.js +1 -0
  454. package/node/images/transform/operations/flip/index.d.ts +2 -2
  455. package/node/images/transform/operations/flip/index.js +1 -0
  456. package/node/images/transform/operations/flop/index.d.ts +2 -2
  457. package/node/images/transform/operations/flop/index.js +1 -0
  458. package/node/images/transform/operations/hue/index.d.ts +2 -2
  459. package/node/images/transform/operations/hue/index.js +1 -0
  460. package/node/images/transform/operations/index.d.ts +1 -1
  461. package/node/images/transform/operations/index.js +1 -1
  462. package/node/images/transform/operations/level/index.d.ts +2 -2
  463. package/node/images/transform/operations/level/index.js +1 -0
  464. package/node/images/transform/operations/lighten/index.d.ts +2 -2
  465. package/node/images/transform/operations/lighten/index.js +1 -0
  466. package/node/images/transform/operations/normalize/index.d.ts +2 -2
  467. package/node/images/transform/operations/normalize/index.js +1 -0
  468. package/node/images/transform/operations/overlay/index.d.ts +2 -2
  469. package/node/images/transform/operations/resize/index.d.ts +2 -2
  470. package/node/images/transform/operations/resize/index.js +1 -0
  471. package/node/images/transform/operations/rotate/index.d.ts +2 -2
  472. package/node/images/transform/operations/rotate/index.js +1 -0
  473. package/node/images/transform/operations/saturate/index.d.ts +2 -2
  474. package/node/images/transform/operations/saturate/index.js +1 -0
  475. package/node/images/types.d.ts +41 -2
  476. package/node/images/utils/index.d.ts +10 -5
  477. package/node/index.d.ts +1 -1
  478. package/node/index.js +1 -1
  479. package/node/process/on-exit/index.js +2 -4
  480. package/node/process/prompt-continue/index.d.ts +3 -3
  481. package/node/process/prompt-continue/index.js +4 -3
  482. package/node/process/spawner/index.js +7 -6
  483. package/node/sftp/directory/copy-dir/index.d.ts +6 -6
  484. package/node/sftp/directory/copy-dir/index.js +6 -6
  485. package/node/sftp/directory/list/index.d.ts +3 -3
  486. package/node/sftp/directory/list/index.js +4 -4
  487. package/node/sftp/directory/move-dir/index.d.ts +7 -7
  488. package/node/sftp/directory/move-dir/index.js +7 -7
  489. package/node/sftp/directory/remove-dir/index.d.ts +5 -5
  490. package/node/sftp/directory/remove-dir/index.js +8 -7
  491. package/node/sftp/file/copy/index.d.ts +6 -6
  492. package/node/sftp/file/copy/index.js +5 -5
  493. package/node/sftp/file/download/index.d.ts +7 -7
  494. package/node/sftp/file/download/index.js +5 -5
  495. package/node/sftp/file/exists/index.d.ts +3 -3
  496. package/node/sftp/file/exists/index.js +3 -3
  497. package/node/sftp/file/move/index.d.ts +7 -7
  498. package/node/sftp/file/move/index.js +7 -7
  499. package/node/sftp/file/remove/index.d.ts +4 -4
  500. package/node/sftp/file/remove/index.js +4 -4
  501. package/node/sftp/file/stat/index.d.ts +3 -3
  502. package/node/sftp/file/stat/index.js +6 -5
  503. package/node/sftp/file/upload/index.d.ts +6 -6
  504. package/node/sftp/file/upload/index.js +5 -5
  505. package/package.json +40 -39
@@ -1,4 +1,4 @@
1
- import { type Request, type Response } from 'express';
1
+ import type { Request, Response } from 'express';
2
2
  import multer from 'multer';
3
3
  import * as Outcome from '../../../agnostic/misc/outcome/index.js';
4
4
  export type WithMulterModeOptions = {
@@ -39,17 +39,17 @@ export type WithMulterError = {
39
39
  * applies the appropriate middleware based on the upload mode. Errors are
40
40
  * captured and returned as a structured `WithMulterError` object.
41
41
  *
42
- * @param {Request} req - The Express request object.
43
- * @param {Response} res - The Express response object.
44
- * @param {WithMulterOptions} options - Multer configuration and upload mode.
45
- * @param {multer.StorageEngine} [options.storage] - Storage engine (defaults to memory).
46
- * @param {multer.Options['limits']} [options.limits] - File size and count limits.
47
- * @param {multer.Options['fileFilter']} [options.fileFilter] - File filter function.
48
- * @param {'none'|'any'|'single'|'array'|'fields'} options.mode - Upload mode.
49
- * @param {string} [options.fieldName] - Field name (required for 'single' and 'array' modes).
50
- * @param {number} [options.maxCount] - Max file count (for 'array' mode).
51
- * @param {multer.Field[]} [options.fields] - Field configurations (for 'fields' mode).
52
- * @returns {Promise<Outcome.Either<true, WithMulterError>>}
42
+ * @param req - The Express request object.
43
+ * @param res - The Express response object.
44
+ * @param options - Multer configuration and upload mode.
45
+ * @param [options.storage] - Storage engine (defaults to memory).
46
+ * @param [options.limits] - File size and count limits.
47
+ * @param [options.fileFilter] - File filter function.
48
+ * @param options.mode - Upload mode.
49
+ * @param [options.fieldName] - Field name (required for 'single' and 'array' modes).
50
+ * @param [options.maxCount] - Max file count (for 'array' mode).
51
+ * @param [options.fields] - Field configurations (for 'fields' mode).
52
+ * @returns
53
53
  * - On success: `Outcome.makeSuccess(true)`.
54
54
  * - On failure: `Outcome.makeFailure(error)` with structured error details.
55
55
  */
@@ -8,17 +8,17 @@ import { unknownToString } from '../../../agnostic/errors/unknown-to-string/inde
8
8
  * applies the appropriate middleware based on the upload mode. Errors are
9
9
  * captured and returned as a structured `WithMulterError` object.
10
10
  *
11
- * @param {Request} req - The Express request object.
12
- * @param {Response} res - The Express response object.
13
- * @param {WithMulterOptions} options - Multer configuration and upload mode.
14
- * @param {multer.StorageEngine} [options.storage] - Storage engine (defaults to memory).
15
- * @param {multer.Options['limits']} [options.limits] - File size and count limits.
16
- * @param {multer.Options['fileFilter']} [options.fileFilter] - File filter function.
17
- * @param {'none'|'any'|'single'|'array'|'fields'} options.mode - Upload mode.
18
- * @param {string} [options.fieldName] - Field name (required for 'single' and 'array' modes).
19
- * @param {number} [options.maxCount] - Max file count (for 'array' mode).
20
- * @param {multer.Field[]} [options.fields] - Field configurations (for 'fields' mode).
21
- * @returns {Promise<Outcome.Either<true, WithMulterError>>}
11
+ * @param req - The Express request object.
12
+ * @param res - The Express response object.
13
+ * @param options - Multer configuration and upload mode.
14
+ * @param [options.storage] - Storage engine (defaults to memory).
15
+ * @param [options.limits] - File size and count limits.
16
+ * @param [options.fileFilter] - File filter function.
17
+ * @param options.mode - Upload mode.
18
+ * @param [options.fieldName] - Field name (required for 'single' and 'array' modes).
19
+ * @param [options.maxCount] - Max file count (for 'array' mode).
20
+ * @param [options.fields] - Field configurations (for 'fields' mode).
21
+ * @returns
22
22
  * - On success: `Outcome.makeSuccess(true)`.
23
23
  * - On failure: `Outcome.makeFailure(error)` with structured error details.
24
24
  */
@@ -46,18 +46,20 @@ export async function useMulterMiddleware(req, res, options) {
46
46
  else {
47
47
  middleware = uploader.any();
48
48
  }
49
- return await new Promise(resolve => middleware(req, res, (err) => {
50
- if (err instanceof multer.MulterError)
51
- return resolve(Outcome.makeFailure({
52
- code: err.code,
53
- message: err.message,
54
- field: err.field
55
- }));
56
- return resolve(err !== undefined
57
- ? Outcome.makeFailure({
58
- code: 'UNKNOWN',
59
- message: unknownToString(err)
60
- })
61
- : Outcome.makeSuccess(true));
62
- }));
49
+ return await new Promise(resolve => {
50
+ middleware(req, res, (err) => {
51
+ if (err instanceof multer.MulterError)
52
+ return resolve(Outcome.makeFailure({
53
+ code: err.code,
54
+ message: err.message,
55
+ field: err.field
56
+ }));
57
+ return resolve(err !== undefined
58
+ ? Outcome.makeFailure({
59
+ code: 'UNKNOWN',
60
+ message: unknownToString(err)
61
+ })
62
+ : Outcome.makeSuccess(true));
63
+ });
64
+ });
63
65
  }
@@ -1,4 +1,4 @@
1
- import { type Bucket, type BucketMetadata, type GetBucketMetadataOptions as GCSGetBucketMetadataOptions } from '@google-cloud/storage';
1
+ import type { Bucket, BucketMetadata, GetBucketMetadataOptions as GCSGetBucketMetadataOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type GetBucketMetadataOptions = GCSGetBucketMetadataOptions;
4
4
  /**
@@ -7,9 +7,9 @@ export type GetBucketMetadataOptions = GCSGetBucketMetadataOptions;
7
7
  * This function calls the Google Cloud Storage API to get information about the bucket,
8
8
  * such as its location, storage class, and other configuration details.
9
9
  *
10
- * @param {Bucket} bucket - The Google Cloud Storage bucket object.
11
- * @param {GetBucketMetadataOptions} [options] - Optional configuration options to pass to the `getMetadata` method.
12
- * @returns {Promise<Outcome.Either<BucketMetadata, string>>} A promise that resolves to an `Outcome.Either`.
10
+ * @param bucket - The Google Cloud Storage bucket object.
11
+ * @param [options] - Optional configuration options to pass to the `getMetadata` method.
12
+ * @returns A promise that resolves to an `Outcome.Either`.
13
13
  * - On success: `Outcome.makeSuccess(metadata)` with the bucket metadata.
14
14
  * - On failure: `Outcome.makeFailure(errStr)` with an error message.
15
15
  *
@@ -6,9 +6,9 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
6
6
  * This function calls the Google Cloud Storage API to get information about the bucket,
7
7
  * such as its location, storage class, and other configuration details.
8
8
  *
9
- * @param {Bucket} bucket - The Google Cloud Storage bucket object.
10
- * @param {GetBucketMetadataOptions} [options] - Optional configuration options to pass to the `getMetadata` method.
11
- * @returns {Promise<Outcome.Either<BucketMetadata, string>>} A promise that resolves to an `Outcome.Either`.
9
+ * @param bucket - The Google Cloud Storage bucket object.
10
+ * @param [options] - Optional configuration options to pass to the `getMetadata` method.
11
+ * @returns A promise that resolves to an `Outcome.Either`.
12
12
  * - On success: `Outcome.makeSuccess(metadata)` with the bucket metadata.
13
13
  * - On failure: `Outcome.makeFailure(errStr)` with an error message.
14
14
  *
@@ -1,4 +1,4 @@
1
- import { type Bucket, type GetFileOptions, type CopyOptions as GCSCopyOptions } from '@google-cloud/storage';
1
+ import type { Bucket, GetFileOptions, CopyOptions as GCSCopyOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type CopyDirOptions = {
4
4
  getFileOptions?: GetFileOptions;
@@ -10,12 +10,12 @@ export type CopyDirOptions = {
10
10
  };
11
11
  /** Recursively copies every object under `sourceDir` to the same relative path
12
12
  * beneath `targetDir` within a single GCS bucket.
13
- * @param {Bucket} bucket - The GCS bucket instance.
14
- * @param {string} sourceDir - The source directory path (prefix) to copy from.
15
- * @param {string} targetDir - The target directory path (prefix) to copy to.
16
- * @param {CopyDirOptions} [options] - Optional parameters for the operation.
17
- * @param {boolean} [options.overwrite=false] - Whether to overwrite existing files at target.
18
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
13
+ * @param bucket - The GCS bucket instance.
14
+ * @param sourceDir - The source directory path (prefix) to copy from.
15
+ * @param targetDir - The target directory path (prefix) to copy to.
16
+ * @param [options] - Optional parameters for the operation.
17
+ * @param [options.overwrite=false] - Whether to overwrite existing files at target.
18
+ * @returns A promise that resolves to an `Outcome.Either`:
19
19
  * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
20
20
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
21
21
  * */
@@ -2,12 +2,12 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
2
2
  import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
3
3
  /** Recursively copies every object under `sourceDir` to the same relative path
4
4
  * beneath `targetDir` within a single GCS bucket.
5
- * @param {Bucket} bucket - The GCS bucket instance.
6
- * @param {string} sourceDir - The source directory path (prefix) to copy from.
7
- * @param {string} targetDir - The target directory path (prefix) to copy to.
8
- * @param {CopyDirOptions} [options] - Optional parameters for the operation.
9
- * @param {boolean} [options.overwrite=false] - Whether to overwrite existing files at target.
10
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
5
+ * @param bucket - The GCS bucket instance.
6
+ * @param sourceDir - The source directory path (prefix) to copy from.
7
+ * @param targetDir - The target directory path (prefix) to copy to.
8
+ * @param [options] - Optional parameters for the operation.
9
+ * @param [options.overwrite=false] - Whether to overwrite existing files at target.
10
+ * @returns A promise that resolves to an `Outcome.Either`:
11
11
  * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
12
12
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
13
13
  * */
@@ -1,4 +1,4 @@
1
1
  export * as copyDir from './copy-dir/index.js'
2
- export * as moveDir from './move-dir/index.js'
3
2
  export * as list from './list/index.js'
4
3
  export * as removeDir from './remove-dir/index.js'
4
+ export * as moveDir from './move-dir/index.js'
@@ -1,4 +1,4 @@
1
1
  export * as copyDir from './copy-dir/index.js'
2
- export * as moveDir from './move-dir/index.js'
3
2
  export * as list from './list/index.js'
4
3
  export * as removeDir from './remove-dir/index.js'
4
+ export * as moveDir from './move-dir/index.js'
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type ListOptions = {
4
4
  fileOptions?: FileOptions;
@@ -8,10 +8,10 @@ export type ListOptions = {
8
8
  *
9
9
  * This function returns only the immediate files (not recursive) under the specified directory prefix.
10
10
  *
11
- * @param {Bucket} bucket - The GCS bucket to list files from.
12
- * @param {string} directoryPath - The directory prefix to list files under.
13
- * @param {ListOptions} [options] - Optional configuration for the listing.
14
- * @param {FileOptions} [options.fileOptions] - Additional options for file retrieval.
15
- * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
11
+ * @param bucket - The GCS bucket to list files from.
12
+ * @param directoryPath - The directory prefix to list files under.
13
+ * @param [options] - Optional configuration for the listing.
14
+ * @param [options.fileOptions] - Additional options for file retrieval.
15
+ * @returns Returns either a success with an array of file paths, or a failure with an error message.
16
16
  */
17
17
  export declare function list(bucket: Bucket, directoryPath: string, options?: ListOptions): Promise<Outcome.Either<string[], string>>;
@@ -5,11 +5,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
5
5
  *
6
6
  * This function returns only the immediate files (not recursive) under the specified directory prefix.
7
7
  *
8
- * @param {Bucket} bucket - The GCS bucket to list files from.
9
- * @param {string} directoryPath - The directory prefix to list files under.
10
- * @param {ListOptions} [options] - Optional configuration for the listing.
11
- * @param {FileOptions} [options.fileOptions] - Additional options for file retrieval.
12
- * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
8
+ * @param bucket - The GCS bucket to list files from.
9
+ * @param directoryPath - The directory prefix to list files under.
10
+ * @param [options] - Optional configuration for the listing.
11
+ * @param [options.fileOptions] - Additional options for file retrieval.
12
+ * @returns Returns either a success with an array of file paths, or a failure with an error message.
13
13
  */
14
14
  export async function list(bucket, directoryPath, options) {
15
15
  const { fileOptions } = options ?? {};
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions, type CopyOptions as GCSCopyOptions, type DeleteFileOptions as GCSDeleteOptions } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions, CopyOptions as GCSCopyOptions, DeleteFileOptions as GCSDeleteOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type MoveDirOptions = {
4
4
  fileOptions?: FileOptions;
@@ -20,11 +20,11 @@ export type MoveDirOptions = {
20
20
  * If `overwrite` is false (default), the operation aborts if any destination file
21
21
  * already exists.
22
22
  *
23
- * @param {Bucket} bucket - The GCS bucket instance.
24
- * @param {string} sourceDir - The source directory prefix to move from.
25
- * @param {string} targetDir - The target directory prefix to move to.
26
- * @param {MoveDirOptions} [options] - Optional parameters for the operation.
27
- * @returns {Promise<Outcome.Either<true, string>>}
23
+ * @param bucket - The GCS bucket instance.
24
+ * @param sourceDir - The source directory prefix to move from.
25
+ * @param targetDir - The target directory prefix to move to.
26
+ * @param [options] - Optional parameters for the operation.
27
+ * @returns
28
28
  * - On success: `Outcome.makeSuccess(true)`.
29
29
  * - On failure: `Outcome.makeFailure(errStr)`.
30
30
  */
@@ -10,11 +10,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
10
10
  * If `overwrite` is false (default), the operation aborts if any destination file
11
11
  * already exists.
12
12
  *
13
- * @param {Bucket} bucket - The GCS bucket instance.
14
- * @param {string} sourceDir - The source directory prefix to move from.
15
- * @param {string} targetDir - The target directory prefix to move to.
16
- * @param {MoveDirOptions} [options] - Optional parameters for the operation.
17
- * @returns {Promise<Outcome.Either<true, string>>}
13
+ * @param bucket - The GCS bucket instance.
14
+ * @param sourceDir - The source directory prefix to move from.
15
+ * @param targetDir - The target directory prefix to move to.
16
+ * @param [options] - Optional parameters for the operation.
17
+ * @returns
18
18
  * - On success: `Outcome.makeSuccess(true)`.
19
19
  * - On failure: `Outcome.makeFailure(errStr)`.
20
20
  */
@@ -1,4 +1,4 @@
1
- import { type Bucket, type DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
1
+ import type { Bucket, DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type RemoveDirOptions = {
4
4
  /** Extra parameters forwarded to `bucket.deleteFiles`. */
@@ -17,12 +17,12 @@ export type RemoveDirOptions = {
17
17
  * Recursively deletes all objects under a directory prefix in a GCS bucket
18
18
  * (including the directory placeholder itself, if present).
19
19
  *
20
- * @param {Bucket} bucket - The GCS bucket instance.
21
- * @param {string} directoryPath - The “directory” prefix to delete.
22
- * @param {RemoveDirOptions} [options] - Optional configuration.
23
- * @param {GCSDeleteFileOptions & {force?: boolean}} [options.deleteOptions] - Extra delete parameters.
24
- * @param {boolean} [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
25
- * @returns {Promise<Outcome.Either<true, string>>}
20
+ * @param bucket - The GCS bucket instance.
21
+ * @param directoryPath - The “directory” prefix to delete.
22
+ * @param [options] - Optional configuration.
23
+ * @param [options.deleteOptions] - Extra delete parameters.
24
+ * @param [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
25
+ * @returns
26
26
  * - On success: `Outcome.makeSuccess(true)` if deletion succeeds
27
27
  * (or prefix absent and `ignoreMissing` is true).
28
28
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails
@@ -4,12 +4,12 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
4
4
  * Recursively deletes all objects under a directory prefix in a GCS bucket
5
5
  * (including the directory placeholder itself, if present).
6
6
  *
7
- * @param {Bucket} bucket - The GCS bucket instance.
8
- * @param {string} directoryPath - The “directory” prefix to delete.
9
- * @param {RemoveDirOptions} [options] - Optional configuration.
10
- * @param {GCSDeleteFileOptions & {force?: boolean}} [options.deleteOptions] - Extra delete parameters.
11
- * @param {boolean} [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
12
- * @returns {Promise<Outcome.Either<true, string>>}
7
+ * @param bucket - The GCS bucket instance.
8
+ * @param directoryPath - The “directory” prefix to delete.
9
+ * @param [options] - Optional configuration.
10
+ * @param [options.deleteOptions] - Extra delete parameters.
11
+ * @param [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
12
+ * @returns
13
13
  * - On success: `Outcome.makeSuccess(true)` if deletion succeeds
14
14
  * (or prefix absent and `ignoreMissing` is true).
15
15
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions, type CopyOptions as GCSFileCopyOptions } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions, CopyOptions as GCSFileCopyOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type CopyOptions = {
4
4
  /** Additional options for constructing the `File` handles. */
@@ -18,14 +18,14 @@ export type CopyOptions = {
18
18
  * If `overwrite` is **false** (default) and the destination object already
19
19
  * exists, the operation aborts.
20
20
  *
21
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
22
- * @param {string} sourcePath - The path of the source object to copy.
23
- * @param {string} targetPath - The destination path for the copied object.
24
- * @param {CopyOptions} [options] - Optional copy configuration.
25
- * @param {FileOptions} [options.fileOptions] - Extra options for `bucket.file`.
26
- * @param {GCSFileCopyOptions} [options.copyOptions] - Extra options for `file.copy`.
27
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination object.
28
- * @returns {Promise<Outcome.Either<true, string>>}
21
+ * @param bucket - The Google Cloud Storage bucket containing the file.
22
+ * @param sourcePath - The path of the source object to copy.
23
+ * @param targetPath - The destination path for the copied object.
24
+ * @param [options] - Optional copy configuration.
25
+ * @param [options.fileOptions] - Extra options for `bucket.file`.
26
+ * @param [options.copyOptions] - Extra options for `file.copy`.
27
+ * @param [options.overwrite=false] - Whether to overwrite an existing destination object.
28
+ * @returns
29
29
  * - On success: `Outcome.makeSuccess(true)`.
30
30
  * - On failure: `Outcome.makeFailure(errStr)`.
31
31
  */
@@ -6,14 +6,14 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
6
6
  * If `overwrite` is **false** (default) and the destination object already
7
7
  * exists, the operation aborts.
8
8
  *
9
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
10
- * @param {string} sourcePath - The path of the source object to copy.
11
- * @param {string} targetPath - The destination path for the copied object.
12
- * @param {CopyOptions} [options] - Optional copy configuration.
13
- * @param {FileOptions} [options.fileOptions] - Extra options for `bucket.file`.
14
- * @param {GCSFileCopyOptions} [options.copyOptions] - Extra options for `file.copy`.
15
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination object.
16
- * @returns {Promise<Outcome.Either<true, string>>}
9
+ * @param bucket - The Google Cloud Storage bucket containing the file.
10
+ * @param sourcePath - The path of the source object to copy.
11
+ * @param targetPath - The destination path for the copied object.
12
+ * @param [options] - Optional copy configuration.
13
+ * @param [options.fileOptions] - Extra options for `bucket.file`.
14
+ * @param [options.copyOptions] - Extra options for `file.copy`.
15
+ * @param [options.overwrite=false] - Whether to overwrite an existing destination object.
16
+ * @returns
17
17
  * - On success: `Outcome.makeSuccess(true)`.
18
18
  * - On failure: `Outcome.makeFailure(errStr)`.
19
19
  */
@@ -1,5 +1,5 @@
1
- import { type Readable } from 'node:stream';
2
- import { type Bucket, type FileOptions, type DownloadOptions as GCSFileDownloadOptions } from '@google-cloud/storage';
1
+ import type { Readable } from 'node:stream';
2
+ import type { Bucket, FileOptions, DownloadOptions as GCSFileDownloadOptions } from '@google-cloud/storage';
3
3
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
4
4
  export type DownloadOptions = {
5
5
  fileOptions?: FileOptions;
@@ -11,11 +11,11 @@ export type DownloadOptions = {
11
11
  * This function downloads a file from the given bucket and path, returning the file content as a `Readable`.
12
12
  * The download process can be customized using optional `fileOptions` and `downloadOptions`.
13
13
  *
14
- * @param {Bucket} bucket - The Google Cloud Storage bucket object from which to download the file.
15
- * @param {string} sourcePath - The path of the file to be downloaded in the bucket.
16
- * @param {DownloadOptions} [options] - Optional configuration options for the download.
17
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an `Outcome.Either`.
14
+ * @param bucket - The Google Cloud Storage bucket object from which to download the file.
15
+ * @param sourcePath - The path of the file to be downloaded in the bucket.
16
+ * @param [options] - Optional configuration options for the download.
17
+ * @returns A promise that resolves to an `Outcome.Either`.
18
18
  * - On success: `Outcome.makeSuccess(stream)` containing the downloaded file's content as a `Readable`.
19
19
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the download fails.
20
20
  */
21
- export declare function download(bucket: Bucket, sourcePath: string, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;
21
+ export declare function download(bucket: Bucket, sourcePath: string, options?: DownloadOptions): Outcome.Either<Readable, string>;
@@ -6,14 +6,14 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
6
6
  * This function downloads a file from the given bucket and path, returning the file content as a `Readable`.
7
7
  * The download process can be customized using optional `fileOptions` and `downloadOptions`.
8
8
  *
9
- * @param {Bucket} bucket - The Google Cloud Storage bucket object from which to download the file.
10
- * @param {string} sourcePath - The path of the file to be downloaded in the bucket.
11
- * @param {DownloadOptions} [options] - Optional configuration options for the download.
12
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an `Outcome.Either`.
9
+ * @param bucket - The Google Cloud Storage bucket object from which to download the file.
10
+ * @param sourcePath - The path of the file to be downloaded in the bucket.
11
+ * @param [options] - Optional configuration options for the download.
12
+ * @returns A promise that resolves to an `Outcome.Either`.
13
13
  * - On success: `Outcome.makeSuccess(stream)` containing the downloaded file's content as a `Readable`.
14
14
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the download fails.
15
15
  */
16
- export async function download(bucket, sourcePath, options) {
16
+ export function download(bucket, sourcePath, options) {
17
17
  const { fileOptions, downloadOptions } = options ?? {};
18
18
  try {
19
19
  const file = bucket.file(sourcePath, fileOptions);
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions, type FileExistsOptions as GCSFileExistsOptions } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions, FileExistsOptions as GCSFileExistsOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type ExistsOptions = {
4
4
  fileOptions?: FileOptions;
@@ -9,11 +9,11 @@ export type ExistsOptions = {
9
9
  *
10
10
  * This function verifies whether a file at the given `sourcePath` exists in the bucket. It can be configured with options to customize the behavior of the check.
11
11
  *
12
- * @param {Bucket} bucket - The GCS bucket to check for the file existence.
13
- * @param {string} sourcePath - The path of the file to check within the bucket.
14
- * @param {ExistsOptions} [options] - Optional configuration for the file existence check.
15
- * @param {FileOptions} [options.fileOptions] - Additional options for the file, such as custom metadata or ACL settings.
16
- * @param {ExistsOptions} [options.existsOptions] - Options for controlling the `exists` method (if any).
17
- * @returns {Promise<Outcome.Either<boolean, string>>} - Returns either a success with `true` or `false` indicating whether the file exists, or a failure with an error message.
12
+ * @param bucket - The GCS bucket to check for the file existence.
13
+ * @param sourcePath - The path of the file to check within the bucket.
14
+ * @param [options] - Optional configuration for the file existence check.
15
+ * @param [options.fileOptions] - Additional options for the file, such as custom metadata or ACL settings.
16
+ * @param [options.existsOptions] - Options for controlling the `exists` method (if any).
17
+ * @returns - Returns either a success with `true` or `false` indicating whether the file exists, or a failure with an error message.
18
18
  */
19
19
  export declare function exists(bucket: Bucket, sourcePath: string, options?: ExistsOptions): Promise<Outcome.Either<boolean, string>>;
@@ -5,12 +5,12 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
5
5
  *
6
6
  * This function verifies whether a file at the given `sourcePath` exists in the bucket. It can be configured with options to customize the behavior of the check.
7
7
  *
8
- * @param {Bucket} bucket - The GCS bucket to check for the file existence.
9
- * @param {string} sourcePath - The path of the file to check within the bucket.
10
- * @param {ExistsOptions} [options] - Optional configuration for the file existence check.
11
- * @param {FileOptions} [options.fileOptions] - Additional options for the file, such as custom metadata or ACL settings.
12
- * @param {ExistsOptions} [options.existsOptions] - Options for controlling the `exists` method (if any).
13
- * @returns {Promise<Outcome.Either<boolean, string>>} - Returns either a success with `true` or `false` indicating whether the file exists, or a failure with an error message.
8
+ * @param bucket - The GCS bucket to check for the file existence.
9
+ * @param sourcePath - The path of the file to check within the bucket.
10
+ * @param [options] - Optional configuration for the file existence check.
11
+ * @param [options.fileOptions] - Additional options for the file, such as custom metadata or ACL settings.
12
+ * @param [options.existsOptions] - Options for controlling the `exists` method (if any).
13
+ * @returns - Returns either a success with `true` or `false` indicating whether the file exists, or a failure with an error message.
14
14
  */
15
15
  export async function exists(bucket, sourcePath, options) {
16
16
  const { fileOptions, existsOptions } = options ?? {};
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions, type GetSignedUrlConfig } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions, GetSignedUrlConfig } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type GenerateSignedUrlOptions = {
4
4
  fileOptions?: FileOptions;
@@ -11,12 +11,12 @@ export type GenerateSignedUrlOptions = {
11
11
  * allows users to perform an action on the file (e.g., `read`, `write`) for a limited time as defined by the `expiresOn` parameter.
12
12
  * The behavior can be customized using optional `fileOptions` and `getSignedUrlOptions`.
13
13
  *
14
- * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file.
15
- * @param {string} sourcePath - The path of the file for which the signed URL is being generated.
16
- * @param {GetSignedUrlConfig['action']} action - The action allowed by the signed URL (e.g., 'read', 'write', 'delete').
17
- * @param {GetSignedUrlConfig['expires']} expiresOn - The expiration time of the signed URL, after which it is no longer valid.
18
- * @param {GenerateSignedUrlOptions} [options] - Optional configuration options for generating the signed URL.
19
- * @returns {Promise<Outcome.Either<string, string>>} A promise that resolves to an `Outcome.Either`.
14
+ * @param bucket - The Google Cloud Storage bucket object containing the file.
15
+ * @param sourcePath - The path of the file for which the signed URL is being generated.
16
+ * @param action - The action allowed by the signed URL (e.g., 'read', 'write', 'delete').
17
+ * @param expiresOn - The expiration time of the signed URL, after which it is no longer valid.
18
+ * @param [options] - Optional configuration options for generating the signed URL.
19
+ * @returns A promise that resolves to an `Outcome.Either`.
20
20
  * - On success: `Outcome.makeSuccess(url)` containing the generated signed URL.
21
21
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the signed URL generation fails.
22
22
  */
@@ -7,12 +7,12 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
7
7
  * allows users to perform an action on the file (e.g., `read`, `write`) for a limited time as defined by the `expiresOn` parameter.
8
8
  * The behavior can be customized using optional `fileOptions` and `getSignedUrlOptions`.
9
9
  *
10
- * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file.
11
- * @param {string} sourcePath - The path of the file for which the signed URL is being generated.
12
- * @param {GetSignedUrlConfig['action']} action - The action allowed by the signed URL (e.g., 'read', 'write', 'delete').
13
- * @param {GetSignedUrlConfig['expires']} expiresOn - The expiration time of the signed URL, after which it is no longer valid.
14
- * @param {GenerateSignedUrlOptions} [options] - Optional configuration options for generating the signed URL.
15
- * @returns {Promise<Outcome.Either<string, string>>} A promise that resolves to an `Outcome.Either`.
10
+ * @param bucket - The Google Cloud Storage bucket object containing the file.
11
+ * @param sourcePath - The path of the file for which the signed URL is being generated.
12
+ * @param action - The action allowed by the signed URL (e.g., 'read', 'write', 'delete').
13
+ * @param expiresOn - The expiration time of the signed URL, after which it is no longer valid.
14
+ * @param [options] - Optional configuration options for generating the signed URL.
15
+ * @returns A promise that resolves to an `Outcome.Either`.
16
16
  * - On success: `Outcome.makeSuccess(url)` containing the generated signed URL.
17
17
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the signed URL generation fails.
18
18
  */
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions, type GetFileMetadataOptions as GCSGetFileMetadataOptions, type FileMetadata } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions, GetFileMetadataOptions as GCSGetFileMetadataOptions, FileMetadata } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type GetMetadataOptions = {
4
4
  fileOptions?: FileOptions;
@@ -10,10 +10,10 @@ export type GetMetadataOptions = {
10
10
  * This function fetches the metadata for a file located at `sourcePath` in the given bucket.
11
11
  * It can be customized using optional `fileOptions` and `getFileMetadataOptions` to control the retrieval behavior.
12
12
  *
13
- * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file whose metadata is being retrieved.
14
- * @param {string} sourcePath - The path of the file whose metadata is to be fetched.
15
- * @param {GetMetadataOptions} [options] - Optional configuration options for the file metadata retrieval.
16
- * @returns {Promise<Outcome.Either<FileMetadata, string>>} A promise that resolves to an `Outcome.Either`.
13
+ * @param bucket - The Google Cloud Storage bucket object containing the file whose metadata is being retrieved.
14
+ * @param sourcePath - The path of the file whose metadata is to be fetched.
15
+ * @param [options] - Optional configuration options for the file metadata retrieval.
16
+ * @returns A promise that resolves to an `Outcome.Either`.
17
17
  * - On success: `Outcome.makeSuccess(metadata)` containing the file's metadata.
18
18
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the metadata retrieval fails.
19
19
  *
@@ -6,10 +6,10 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
6
6
  * This function fetches the metadata for a file located at `sourcePath` in the given bucket.
7
7
  * It can be customized using optional `fileOptions` and `getFileMetadataOptions` to control the retrieval behavior.
8
8
  *
9
- * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file whose metadata is being retrieved.
10
- * @param {string} sourcePath - The path of the file whose metadata is to be fetched.
11
- * @param {GetMetadataOptions} [options] - Optional configuration options for the file metadata retrieval.
12
- * @returns {Promise<Outcome.Either<FileMetadata, string>>} A promise that resolves to an `Outcome.Either`.
9
+ * @param bucket - The Google Cloud Storage bucket object containing the file whose metadata is being retrieved.
10
+ * @param sourcePath - The path of the file whose metadata is to be fetched.
11
+ * @param [options] - Optional configuration options for the file metadata retrieval.
12
+ * @returns A promise that resolves to an `Outcome.Either`.
13
13
  * - On success: `Outcome.makeSuccess(metadata)` containing the file's metadata.
14
14
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the metadata retrieval fails.
15
15
  *
@@ -1,4 +1,4 @@
1
- import { type Bucket, type FileOptions, type GetAclOptions } from '@google-cloud/storage';
1
+ import type { Bucket, FileOptions, GetAclOptions } from '@google-cloud/storage';
2
2
  import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
3
3
  export type GetPermissionsOptions = {
4
4
  fileOptions?: FileOptions;
@@ -9,11 +9,11 @@ export type GetPermissionsOptions = {
9
9
  *
10
10
  * This function fetches the ACL settings of a given file to determine the permissions assigned to different users or roles.
11
11
  *
12
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
13
- * @param {string} sourcePath - The path of the file whose permissions need to be retrieved.
14
- * @param {GetPermissionsOptions} [options] - Optional configuration options for the file and ACL retrieval.
15
- * @returns {Promise<Outcome.Either<any, string>>} A promise that resolves to an `Outcome.Either`.
12
+ * @param bucket - The Google Cloud Storage bucket containing the file.
13
+ * @param sourcePath - The path of the file whose permissions need to be retrieved.
14
+ * @param [options] - Optional configuration options for the file and ACL retrieval.
15
+ * @returns A promise that resolves to an `Outcome.Either`.
16
16
  * - On success: `Outcome.makeSuccess(acl)` containing the file's ACL settings.
17
17
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the ACL retrieval fails.
18
18
  */
19
- export declare function getPermissions(bucket: Bucket, sourcePath: string, options?: GetPermissionsOptions): Promise<Outcome.Either<any, string>>;
19
+ export declare function getPermissions(bucket: Bucket, sourcePath: string, options?: GetPermissionsOptions): Promise<Outcome.Either<unknown, string>>;
@@ -5,10 +5,10 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
5
5
  *
6
6
  * This function fetches the ACL settings of a given file to determine the permissions assigned to different users or roles.
7
7
  *
8
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
9
- * @param {string} sourcePath - The path of the file whose permissions need to be retrieved.
10
- * @param {GetPermissionsOptions} [options] - Optional configuration options for the file and ACL retrieval.
11
- * @returns {Promise<Outcome.Either<any, string>>} A promise that resolves to an `Outcome.Either`.
8
+ * @param bucket - The Google Cloud Storage bucket containing the file.
9
+ * @param sourcePath - The path of the file whose permissions need to be retrieved.
10
+ * @param [options] - Optional configuration options for the file and ACL retrieval.
11
+ * @returns A promise that resolves to an `Outcome.Either`.
12
12
  * - On success: `Outcome.makeSuccess(acl)` containing the file's ACL settings.
13
13
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the ACL retrieval fails.
14
14
  */
@@ -1,6 +1,6 @@
1
+ export * as copy from './copy/index.js'
1
2
  export * as download from './download/index.js'
2
3
  export * as exists from './exists/index.js'
3
- export * as copy from './copy/index.js'
4
4
  export * as generateSignedUrl from './generate-signed-url/index.js'
5
5
  export * as getMetadata from './get-metadata/index.js'
6
6
  export * as getPermissions from './get-permissions/index.js'