@design-edito/tools 0.4.5 → 0.4.6

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 (415) hide show
  1. package/TODO.md +269 -0
  2. package/agnostic/arrays/dedupe/index.js +9 -7
  3. package/agnostic/arrays/dedupe/index.test.js +24 -0
  4. package/agnostic/arrays/find-duplicates/index.js +34 -22
  5. package/agnostic/arrays/find-duplicates/index.test.js +31 -0
  6. package/agnostic/arrays/index.d.ts +2 -2
  7. package/agnostic/arrays/index.js +2 -2
  8. package/agnostic/arrays/is-array-of/index.js +28 -26
  9. package/agnostic/arrays/is-array-of/index.test.js +56 -0
  10. package/agnostic/arrays/make/index.js +11 -6
  11. package/agnostic/arrays/make/index.test.js +10 -0
  12. package/agnostic/arrays/random-pick/index.js +38 -22
  13. package/agnostic/arrays/random-pick/index.test.js +23 -0
  14. package/agnostic/arrays/shuffle/index.js +15 -11
  15. package/agnostic/arrays/shuffle/index.test.js +14 -0
  16. package/agnostic/booleans/is-falsy/index.js +24 -15
  17. package/agnostic/booleans/is-falsy/index.test.js +26 -0
  18. package/agnostic/colors/channels/index.js +139 -936
  19. package/agnostic/colors/channels/index.test.js +64 -0
  20. package/agnostic/colors/contrast/index.js +24 -643
  21. package/agnostic/colors/contrast/index.test.js +21 -0
  22. package/agnostic/colors/convert/index.js +811 -837
  23. package/agnostic/colors/convert/index.test.js +98 -0
  24. package/agnostic/colors/cssColorsMap.js +153 -0
  25. package/agnostic/colors/distance/index.js +66 -538
  26. package/agnostic/colors/distance/index.test.js +21 -0
  27. package/agnostic/colors/grayscale/index.js +95 -872
  28. package/agnostic/colors/grayscale/index.test.js +34 -0
  29. package/agnostic/colors/index.d.ts +2 -2
  30. package/agnostic/colors/index.js +2 -2
  31. package/agnostic/colors/invert/index.js +34 -719
  32. package/agnostic/colors/invert/index.test.js +31 -0
  33. package/agnostic/colors/lerp/index.js +75 -804
  34. package/agnostic/colors/lerp/index.test.js +55 -0
  35. package/agnostic/colors/luminance/index.js +17 -625
  36. package/agnostic/colors/luminance/index.test.js +30 -0
  37. package/agnostic/colors/palette/index.js +83 -917
  38. package/agnostic/colors/palette/index.test.js +35 -0
  39. package/agnostic/colors/rotate/index.js +35 -835
  40. package/agnostic/colors/rotate/index.test.js +45 -0
  41. package/agnostic/colors/tidy/index.js +79 -530
  42. package/agnostic/colors/tidy/index.test.js +45 -0
  43. package/agnostic/colors/typechecks/index.js +188 -250
  44. package/agnostic/colors/typechecks/index.test.js +113 -0
  45. package/agnostic/colors/types.js +1 -0
  46. package/agnostic/css/bem/index.js +134 -171
  47. package/agnostic/css/clss/index.js +64 -29
  48. package/agnostic/css/clss/index.test.js +60 -0
  49. package/agnostic/css/generate-nice-color/index.js +26 -71
  50. package/agnostic/css/generate-nice-color/index.test.js +8 -0
  51. package/agnostic/css/index.d.ts +2 -2
  52. package/agnostic/css/index.js +2 -2
  53. package/agnostic/css/is-valid-css-class-name/index.js +14 -8
  54. package/agnostic/css/is-valid-css-class-name/index.test.js +36 -0
  55. package/agnostic/css/scale/index.js +37 -50
  56. package/agnostic/css/scale/index.test.js +71 -0
  57. package/agnostic/css/styles-set/index.js +151 -178
  58. package/agnostic/errors/index.d.ts +1 -1
  59. package/agnostic/errors/index.js +1 -1
  60. package/agnostic/errors/register/index.js +45 -49
  61. package/agnostic/errors/unknown-to-string/index.js +17 -10
  62. package/agnostic/errors/unknown-to-string/index.test.js +35 -0
  63. package/agnostic/html/get-node-ancestors/index.js +29 -29
  64. package/agnostic/html/get-node-ancestors/index.test.js +58 -0
  65. package/agnostic/html/get-position-inside-parent/index.js +13 -8
  66. package/agnostic/html/get-position-inside-parent/index.test.js +56 -0
  67. package/agnostic/html/hyper-json/cast/index.js +128 -2931
  68. package/agnostic/html/hyper-json/index.js +23 -2954
  69. package/agnostic/html/hyper-json/method/index.js +10 -14
  70. package/agnostic/html/hyper-json/serialize/index.js +88 -222
  71. package/agnostic/html/hyper-json/smart-tags/coalesced/add/index.js +14 -2938
  72. package/agnostic/html/hyper-json/smart-tags/coalesced/addclass/index.js +27 -2937
  73. package/agnostic/html/hyper-json/smart-tags/coalesced/and/index.js +13 -2938
  74. package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.js +34 -2938
  75. package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.js +42 -2935
  76. package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.js +47 -2937
  77. package/agnostic/html/hyper-json/smart-tags/coalesced/clone/index.js +10 -2939
  78. package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.js +45 -2936
  79. package/agnostic/html/hyper-json/smart-tags/coalesced/equals/index.js +22 -2938
  80. package/agnostic/html/hyper-json/smart-tags/coalesced/getattribute/index.js +26 -2938
  81. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperties/index.js +19 -2938
  82. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.js +67 -2935
  83. package/agnostic/html/hyper-json/smart-tags/coalesced/hjparse/index.js +21 -2937
  84. package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.js +89 -2938
  85. package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.js +20 -2938
  86. package/agnostic/html/hyper-json/smart-tags/coalesced/index.d.ts +18 -18
  87. package/agnostic/html/hyper-json/smart-tags/coalesced/index.js +18 -18
  88. package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.js +37 -2938
  89. package/agnostic/html/hyper-json/smart-tags/coalesced/join/index.js +16 -2938
  90. package/agnostic/html/hyper-json/smart-tags/coalesced/length/index.js +21 -2938
  91. package/agnostic/html/hyper-json/smart-tags/coalesced/map/index.js +31 -2938
  92. package/agnostic/html/hyper-json/smart-tags/coalesced/negate/index.js +10 -2939
  93. package/agnostic/html/hyper-json/smart-tags/coalesced/notrailing/index.js +33 -2938
  94. package/agnostic/html/hyper-json/smart-tags/coalesced/or/index.js +13 -2938
  95. package/agnostic/html/hyper-json/smart-tags/coalesced/pickrandom/index.js +17 -2938
  96. package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.js +59 -2938
  97. package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.js +23 -2938
  98. package/agnostic/html/hyper-json/smart-tags/coalesced/push/index.js +10 -2939
  99. package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.js +26 -2938
  100. package/agnostic/html/hyper-json/smart-tags/coalesced/recordtoarray/index.js +10 -2939
  101. package/agnostic/html/hyper-json/smart-tags/coalesced/removeattribute/index.js +53 -2935
  102. package/agnostic/html/hyper-json/smart-tags/coalesced/removeclass/index.js +27 -2937
  103. package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.js +31 -2937
  104. package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.js +55 -2940
  105. package/agnostic/html/hyper-json/smart-tags/coalesced/select/index.js +29 -2935
  106. package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.js +29 -2938
  107. package/agnostic/html/hyper-json/smart-tags/coalesced/setattribute/index.js +53 -2935
  108. package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.js +232 -2936
  109. package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.js +89 -2936
  110. package/agnostic/html/hyper-json/smart-tags/coalesced/split/index.js +20 -2938
  111. package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.js +23 -2939
  112. package/agnostic/html/hyper-json/smart-tags/coalesced/toarray/index.js +11 -2939
  113. package/agnostic/html/hyper-json/smart-tags/coalesced/toboolean/index.js +11 -2939
  114. package/agnostic/html/hyper-json/smart-tags/coalesced/toelement/index.js +17 -2938
  115. package/agnostic/html/hyper-json/smart-tags/coalesced/toggleclass/index.js +27 -2937
  116. package/agnostic/html/hyper-json/smart-tags/coalesced/tonodelist/index.js +11 -2939
  117. package/agnostic/html/hyper-json/smart-tags/coalesced/tonull/index.js +10 -2939
  118. package/agnostic/html/hyper-json/smart-tags/coalesced/tonumber/index.js +11 -2939
  119. package/agnostic/html/hyper-json/smart-tags/coalesced/torecord/index.js +11 -2939
  120. package/agnostic/html/hyper-json/smart-tags/coalesced/toref/index.js +11 -2939
  121. package/agnostic/html/hyper-json/smart-tags/coalesced/tostring/index.js +11 -2939
  122. package/agnostic/html/hyper-json/smart-tags/coalesced/totext/index.js +11 -2939
  123. package/agnostic/html/hyper-json/smart-tags/coalesced/transformselected/index.js +84 -2938
  124. package/agnostic/html/hyper-json/smart-tags/coalesced/trim/index.js +14 -2938
  125. package/agnostic/html/hyper-json/smart-tags/index.js +28 -181
  126. package/agnostic/html/hyper-json/smart-tags/isolated/any/index.js +12 -195
  127. package/agnostic/html/hyper-json/smart-tags/isolated/array/index.js +12 -195
  128. package/agnostic/html/hyper-json/smart-tags/isolated/boolean/index.js +12 -2939
  129. package/agnostic/html/hyper-json/smart-tags/isolated/element/index.js +24 -2938
  130. package/agnostic/html/hyper-json/smart-tags/isolated/get/index.js +18 -2938
  131. package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.js +56 -2937
  132. package/agnostic/html/hyper-json/smart-tags/isolated/index.d.ts +1 -1
  133. package/agnostic/html/hyper-json/smart-tags/isolated/index.js +1 -1
  134. package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.js +18 -2938
  135. package/agnostic/html/hyper-json/smart-tags/isolated/null/index.js +9 -193
  136. package/agnostic/html/hyper-json/smart-tags/isolated/number/index.js +16 -2938
  137. package/agnostic/html/hyper-json/smart-tags/isolated/record/index.js +12 -2938
  138. package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.js +40 -2935
  139. package/agnostic/html/hyper-json/smart-tags/isolated/string/index.js +16 -2938
  140. package/agnostic/html/hyper-json/smart-tags/isolated/text/index.js +18 -2938
  141. package/agnostic/html/hyper-json/transformer/index.js +112 -148
  142. package/agnostic/html/hyper-json/tree/index.js +411 -2928
  143. package/agnostic/html/hyper-json/types/index.js +27 -18
  144. package/agnostic/html/hyper-json/utils/index.js +497 -2921
  145. package/agnostic/html/index.d.ts +2 -2
  146. package/agnostic/html/index.js +2 -2
  147. package/agnostic/html/insert-node/index.js +27 -16
  148. package/agnostic/html/insert-node/index.test.js +73 -0
  149. package/agnostic/html/placeholders/index.js +26 -29
  150. package/agnostic/html/replace-in-element/index.js +31 -48
  151. package/agnostic/html/replace-in-element/index.test.js +80 -0
  152. package/agnostic/html/selector-to-element/index.js +53 -39
  153. package/agnostic/html/selector-to-element/index.test.js +69 -0
  154. package/agnostic/html/string-to-nodes/index.js +24 -25
  155. package/agnostic/html/string-to-nodes/index.test.js +54 -0
  156. package/agnostic/index.d.ts +6 -6
  157. package/agnostic/index.js +6 -6
  158. package/agnostic/misc/assert/index.js +60 -66
  159. package/agnostic/misc/cast/index.js +123 -57
  160. package/agnostic/misc/cast/index.test.js +134 -0
  161. package/agnostic/misc/connection/index.js +55 -36
  162. package/agnostic/misc/connection/index.test.js +143 -0
  163. package/agnostic/misc/crawler/index.js +68 -46
  164. package/agnostic/misc/crawler/index.test.js +56 -0
  165. package/agnostic/misc/crossenv/detect-runtime/index.js +41 -13
  166. package/agnostic/misc/crossenv/detect-runtime/index.test.js +24 -0
  167. package/agnostic/misc/crossenv/types.js +21 -14
  168. package/agnostic/misc/crossenv/window/index.js +45 -24
  169. package/agnostic/misc/crossenv/window/index.test.js +24 -0
  170. package/agnostic/misc/data-size/index.js +182 -294
  171. package/agnostic/misc/data-size/index.test.js +100 -0
  172. package/agnostic/misc/data-size/types.js +1 -0
  173. package/agnostic/misc/index.d.ts +5 -5
  174. package/agnostic/misc/index.js +5 -5
  175. package/agnostic/misc/is-constructor-function/index.js +12 -6
  176. package/agnostic/misc/is-constructor-function/index.test.js +36 -0
  177. package/agnostic/misc/is-nullish/index.js +24 -11
  178. package/agnostic/misc/is-nullish/index.test.js +44 -0
  179. package/agnostic/misc/logs/logger/index.js +115 -140
  180. package/agnostic/misc/logs/make-text-block/index.js +13 -13
  181. package/agnostic/misc/logs/styles/index.js +29 -48
  182. package/agnostic/misc/lorem-ipsum/index.js +51 -201
  183. package/agnostic/misc/lorem-ipsum/index.test.js +49 -0
  184. package/agnostic/misc/normalize-extension/index.js +99 -88
  185. package/agnostic/misc/normalize-extension/index.test.js +40 -0
  186. package/agnostic/misc/outcome/index.js +20 -14
  187. package/agnostic/misc/outcome/index.test.js +40 -0
  188. package/agnostic/numbers/absolute-modulo/index.js +9 -6
  189. package/agnostic/numbers/absolute-modulo/index.test.js +23 -0
  190. package/agnostic/numbers/approximate-rational/index.js +86 -69
  191. package/agnostic/numbers/approximate-rational/index.test.js +90 -0
  192. package/agnostic/numbers/clamp/index.js +12 -8
  193. package/agnostic/numbers/clamp/index.test.js +24 -0
  194. package/agnostic/numbers/geometric-progressions/index.js +25 -16
  195. package/agnostic/numbers/geometric-progressions/index.test.js +45 -0
  196. package/agnostic/numbers/index.d.ts +2 -2
  197. package/agnostic/numbers/index.js +2 -2
  198. package/agnostic/numbers/interpolate/index.js +25 -10
  199. package/agnostic/numbers/interpolate/index.test.js +40 -0
  200. package/agnostic/numbers/round/index.js +30 -15
  201. package/agnostic/numbers/round/index.test.js +56 -0
  202. package/agnostic/objects/deep-get-property/index.js +30 -27
  203. package/agnostic/objects/deep-get-property/index.test.js +59 -0
  204. package/agnostic/objects/enums/is-in-enum/index.js +17 -11
  205. package/agnostic/objects/enums/is-in-enum/index.test.js +100 -0
  206. package/agnostic/objects/flatten-getters/index.js +15 -14
  207. package/agnostic/objects/flatten-getters/index.test.js +78 -0
  208. package/agnostic/objects/index.d.ts +2 -2
  209. package/agnostic/objects/index.js +2 -2
  210. package/agnostic/objects/is-object/index.js +16 -9
  211. package/agnostic/objects/is-object/index.test.js +60 -0
  212. package/agnostic/objects/is-record/index.js +12 -7
  213. package/agnostic/objects/is-record/index.test.js +48 -0
  214. package/agnostic/objects/record-format/index.js +18 -12
  215. package/agnostic/objects/record-format/index.test.js +92 -0
  216. package/agnostic/objects/record-map/index.js +16 -11
  217. package/agnostic/objects/record-map/index.test.js +56 -0
  218. package/agnostic/objects/sort-keys/index.js +15 -11
  219. package/agnostic/objects/sort-keys/index.test.js +37 -0
  220. package/agnostic/objects/validation/index.js +21 -8
  221. package/agnostic/objects/validation/index.test.js +72 -0
  222. package/agnostic/optim/index.d.ts +1 -1
  223. package/agnostic/optim/index.js +1 -1
  224. package/agnostic/optim/memoize/index.js +24 -16
  225. package/agnostic/optim/memoize/index.test.js +30 -0
  226. package/agnostic/optim/throttle-debounce/index.js +120 -102
  227. package/agnostic/optim/throttle-debounce/index.test.js +44 -0
  228. package/agnostic/optim/throttle-debounce/types.js +1 -0
  229. package/agnostic/random/hex-char/index.js +8 -10
  230. package/agnostic/random/hex-char/index.test.js +20 -0
  231. package/agnostic/random/index.d.ts +1 -1
  232. package/agnostic/random/index.js +1 -1
  233. package/agnostic/random/random/index.js +17 -14
  234. package/agnostic/random/random/index.test.js +73 -0
  235. package/agnostic/random/uuid/index.js +28 -20
  236. package/agnostic/random/uuid/index.test.js +45 -0
  237. package/agnostic/regexps/index.js +126 -84
  238. package/agnostic/regexps/index.test.js +108 -0
  239. package/agnostic/sanitization/file-name/index.js +24 -8
  240. package/agnostic/sanitization/file-name/index.test.js +23 -0
  241. package/agnostic/sanitization/html/index.js +172 -122
  242. package/agnostic/sanitization/path/index.js +23 -15
  243. package/agnostic/sanitization/path/index.test.js +18 -0
  244. package/agnostic/sanitization/types.js +1 -0
  245. package/agnostic/sanitization/user-input/index.js +36 -24
  246. package/agnostic/sanitization/user-input/index.test.js +31 -0
  247. package/agnostic/strings/char-codes/index.js +123 -55
  248. package/agnostic/strings/matches/index.js +35 -16
  249. package/agnostic/strings/normalize-indent/index.js +34 -16
  250. package/agnostic/strings/parse-table/index.js +153 -86
  251. package/agnostic/strings/replace-all/index.js +36 -15
  252. package/agnostic/strings/to-alphanum/index.js +23 -8
  253. package/agnostic/strings/trim/index.js +22 -9
  254. package/agnostic/time/dates/format-date/index.js +140 -72
  255. package/agnostic/time/duration/index.js +106 -140
  256. package/agnostic/time/timeout/index.js +24 -16
  257. package/agnostic/time/transitions/index.js +200 -158
  258. package/agnostic/time/wait/index.js +10 -8
  259. package/agnostic/typescript/types.js +1 -0
  260. package/components/BeforeAfter/index.controlled.js +95 -0
  261. package/components/BeforeAfter/index.js +54 -189
  262. package/components/BeforeAfter/utils.js +9 -0
  263. package/components/Disclaimer/index.js +50 -110
  264. package/components/Drawer/index.js +81 -196
  265. package/components/EventListener/index.js +29 -80
  266. package/components/Gallery/index.js +146 -221
  267. package/components/Gallery/utils.js +12 -0
  268. package/components/Image/index.js +66 -293
  269. package/components/IntersectionObserver/index.js +62 -110
  270. package/components/Overlayer/index.js +59 -103
  271. package/components/Paginator/index.js +124 -155
  272. package/components/ResizeObserver/index.js +66 -119
  273. package/components/ResizeObserver/style.module.css +0 -0
  274. package/components/Scrllgngn/index.js +171 -468
  275. package/components/ScrollListener/index.js +97 -276
  276. package/components/ScrollListener/utils.js +51 -0
  277. package/components/Sequencer/index.controlled.js +67 -0
  278. package/components/Sequencer/index.js +105 -262
  279. package/components/ShadowRoot/index.js +42 -96
  280. package/components/Subtitles/index.js +107 -244
  281. package/components/Subtitles/types.js +1 -0
  282. package/components/Subtitles/utils.js +102 -0
  283. package/components/Theatre/index.js +88 -136
  284. package/components/UIModule/index.js +156 -199
  285. package/components/Video/index.js +292 -857
  286. package/components/Video/utils.js +137 -0
  287. package/components/_WIP_AudioQuote/index.js +1 -0
  288. package/components/_WIP_Icon/index.js +1 -0
  289. package/components/index.d.ts +5 -5
  290. package/components/index.js +5 -5
  291. package/components/public-classnames.js +18 -0
  292. package/components/utils/index.js +11 -11
  293. package/components/utils/types.js +1 -0
  294. package/index.d.ts +1 -1
  295. package/index.js +1 -1
  296. package/node/@aws-s3/index.test.js +6 -0
  297. package/node/@aws-s3/storage/directory/copy-dir/index.js +66 -72
  298. package/node/@aws-s3/storage/directory/index.d.ts +2 -2
  299. package/node/@aws-s3/storage/directory/index.js +2 -2
  300. package/node/@aws-s3/storage/directory/list/index.js +32 -42
  301. package/node/@aws-s3/storage/directory/move-dir/index.js +68 -86
  302. package/node/@aws-s3/storage/directory/remove-dir/index.js +56 -67
  303. package/node/@aws-s3/storage/file/copy/index.js +41 -53
  304. package/node/@aws-s3/storage/file/download/index.js +29 -40
  305. package/node/@aws-s3/storage/file/exists/index.js +35 -43
  306. package/node/@aws-s3/storage/file/index.d.ts +1 -1
  307. package/node/@aws-s3/storage/file/index.js +1 -1
  308. package/node/@aws-s3/storage/file/move/index.js +57 -63
  309. package/node/@aws-s3/storage/file/remove/index.js +35 -43
  310. package/node/@aws-s3/storage/file/stat/index.js +33 -47
  311. package/node/@aws-s3/storage/file/upload/index.js +52 -63
  312. package/node/@design-edito/index.js +1 -0
  313. package/node/@express/@multer/index.js +61 -55
  314. package/node/@google-cloud/storage/bucket/get-metadata/index.js +25 -29
  315. package/node/@google-cloud/storage/directory/copy-dir/index.js +35 -41
  316. package/node/@google-cloud/storage/directory/index.d.ts +1 -1
  317. package/node/@google-cloud/storage/directory/index.js +1 -1
  318. package/node/@google-cloud/storage/directory/list/index.js +28 -35
  319. package/node/@google-cloud/storage/directory/move-dir/index.js +43 -42
  320. package/node/@google-cloud/storage/directory/remove-dir/index.js +34 -38
  321. package/node/@google-cloud/storage/file/copy/index.js +35 -40
  322. package/node/@google-cloud/storage/file/download/index.js +27 -34
  323. package/node/@google-cloud/storage/file/exists/index.js +25 -31
  324. package/node/@google-cloud/storage/file/generate-signed-url/index.js +33 -35
  325. package/node/@google-cloud/storage/file/get-metadata/index.js +28 -31
  326. package/node/@google-cloud/storage/file/get-permissions/index.js +25 -31
  327. package/node/@google-cloud/storage/file/index.d.ts +2 -2
  328. package/node/@google-cloud/storage/file/index.js +2 -2
  329. package/node/@google-cloud/storage/file/move/index.js +38 -42
  330. package/node/@google-cloud/storage/file/remove/index.js +34 -35
  331. package/node/@google-cloud/storage/file/revoke-signed-urls/index.js +32 -95
  332. package/node/@google-cloud/storage/file/stat/index.js +34 -38
  333. package/node/@google-cloud/storage/file/update-metadata/index.js +30 -31
  334. package/node/@google-cloud/storage/file/upload/index.js +44 -46
  335. package/node/@google-cloud/storage/index.d.ts +1 -1
  336. package/node/@google-cloud/storage/index.js +1 -1
  337. package/node/cloud-storage/clients/index.js +35 -15
  338. package/node/cloud-storage/operations/copy-dir/index.js +30 -203
  339. package/node/cloud-storage/operations/copy-file/index.js +30 -152
  340. package/node/cloud-storage/operations/download-file/index.js +30 -103
  341. package/node/cloud-storage/operations/exists-file/index.js +30 -103
  342. package/node/cloud-storage/operations/index.d.ts +2 -2
  343. package/node/cloud-storage/operations/index.js +2 -2
  344. package/node/cloud-storage/operations/list-dir/index.js +29 -98
  345. package/node/cloud-storage/operations/move-dir/index.js +30 -169
  346. package/node/cloud-storage/operations/move-file/index.js +30 -157
  347. package/node/cloud-storage/operations/remove-dir/index.js +29 -159
  348. package/node/cloud-storage/operations/remove-file/index.js +29 -121
  349. package/node/cloud-storage/operations/stat-file/index.js +29 -124
  350. package/node/cloud-storage/operations/upload-file/index.js +30 -162
  351. package/node/encryption/@aes-256-gcm/buffer/index.js +31 -72
  352. package/node/encryption/@aes-256-gcm/uint8-array/index.js +55 -55
  353. package/node/encryption/key/index.js +19 -12
  354. package/node/files/index.d.ts +1 -1
  355. package/node/files/index.js +1 -1
  356. package/node/files/is-in-directory/index.js +11 -8
  357. package/node/files/read-write/index.js +11 -15
  358. package/node/files/subpaths/index.js +156 -121
  359. package/node/ftps/directory/copy-dir/index.js +55 -62
  360. package/node/ftps/directory/list/index.js +24 -29
  361. package/node/ftps/directory/move-dir/index.js +38 -38
  362. package/node/ftps/directory/remove-dir/index.js +39 -42
  363. package/node/ftps/file/copy/index.js +42 -47
  364. package/node/ftps/file/download/index.js +29 -34
  365. package/node/ftps/file/exists/index.js +38 -36
  366. package/node/ftps/file/index.d.ts +2 -2
  367. package/node/ftps/file/index.js +2 -2
  368. package/node/ftps/file/move/index.js +46 -44
  369. package/node/ftps/file/remove/index.js +36 -39
  370. package/node/ftps/file/stat/index.js +30 -38
  371. package/node/ftps/file/upload/index.js +40 -44
  372. package/node/images/create/index.js +10 -562
  373. package/node/images/format/index.js +264 -815
  374. package/node/images/metadata/index.js +10 -571
  375. package/node/images/transform/index.js +169 -1022
  376. package/node/images/transform/operations/blur/index.js +11 -24
  377. package/node/images/transform/operations/brighten/index.js +11 -24
  378. package/node/images/transform/operations/extend/index.js +25 -589
  379. package/node/images/transform/operations/extract/index.js +15 -28
  380. package/node/images/transform/operations/flatten/index.js +20 -584
  381. package/node/images/transform/operations/flip/index.js +2 -6
  382. package/node/images/transform/operations/flop/index.js +2 -6
  383. package/node/images/transform/operations/hue/index.js +13 -26
  384. package/node/images/transform/operations/index.d.ts +5 -5
  385. package/node/images/transform/operations/index.js +5 -5
  386. package/node/images/transform/operations/level/index.js +14 -30
  387. package/node/images/transform/operations/lighten/index.js +13 -26
  388. package/node/images/transform/operations/normalize/index.js +14 -27
  389. package/node/images/transform/operations/overlay/index.js +89 -673
  390. package/node/images/transform/operations/resize/index.js +46 -610
  391. package/node/images/transform/operations/rotate/index.js +20 -584
  392. package/node/images/transform/operations/saturate/index.js +14 -27
  393. package/node/images/types.js +34 -31
  394. package/node/images/utils/index.js +84 -568
  395. package/node/index.d.ts +5 -5
  396. package/node/index.js +5 -5
  397. package/node/process/on-exit/index.js +45 -26
  398. package/node/process/prompt-continue/index.js +29 -14
  399. package/node/process/spawner/index.js +104 -134
  400. package/node/sftp/directory/copy-dir/index.js +52 -60
  401. package/node/sftp/directory/index.d.ts +1 -1
  402. package/node/sftp/directory/index.js +1 -1
  403. package/node/sftp/directory/list/index.js +22 -29
  404. package/node/sftp/directory/move-dir/index.js +35 -35
  405. package/node/sftp/directory/remove-dir/index.js +39 -42
  406. package/node/sftp/file/copy/index.js +37 -45
  407. package/node/sftp/file/download/index.js +26 -32
  408. package/node/sftp/file/exists/index.js +29 -29
  409. package/node/sftp/file/index.d.ts +1 -1
  410. package/node/sftp/file/index.js +1 -1
  411. package/node/sftp/file/move/index.js +39 -38
  412. package/node/sftp/file/remove/index.js +31 -34
  413. package/node/sftp/file/stat/index.js +26 -37
  414. package/node/sftp/file/upload/index.js +34 -38
  415. package/package.json +1 -1
@@ -1,204 +1,31 @@
1
- // src/agnostic/misc/outcome/index.ts
2
- function makeSuccess(payload) {
3
- return { success: true, payload };
1
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
2
+ import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
3
+ import { copyDir as ftpCopyDir } from '../../../ftps/directory/copy-dir/index.js';
4
+ import { copyDir as sftpCopyDir } from '../../../sftp/directory/copy-dir/index.js';
5
+ import { copyDir as s3CopyDir } from '../../../@aws-s3/storage/directory/copy-dir/index.js';
6
+ import { copyDir as gcsCopyDir } from '../../../@google-cloud/storage/directory/copy-dir/index.js';
7
+ /**
8
+ * Recursively copies a directory from one path to another.
9
+ *
10
+ * The function automatically dispatches to the appropriate implementation based on
11
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP).
12
+ *
13
+ * @param {AnyClient} client - The cloud storage client instance.
14
+ * @param {string} sourcePath - The source directory path to copy from.
15
+ * @param {string} targetPath - The target directory path to copy to.
16
+ * @param {GcsCopyDirOptions | S3CopyDirOptions | FtpsCopyDirOptions | SftpCopyDirOptions} [options] - Optional copy configuration.
17
+ * @returns {Promise<Outcome.Either<true, string>>}
18
+ * - On success: `Outcome.makeSuccess(true)`.
19
+ * - On failure: `Outcome.makeFailure(errStr)`.
20
+ */
21
+ export async function copyDir(client, sourcePath, targetPath, options) {
22
+ if (isGcsBucket(client))
23
+ return await gcsCopyDir(client, sourcePath, targetPath, options);
24
+ if (isS3ClientWithBucket(client))
25
+ return await s3CopyDir(client.client, client.bucketName, sourcePath, targetPath, options);
26
+ if (isFtpClient(client))
27
+ return await ftpCopyDir(client, sourcePath, targetPath);
28
+ if (isSftpClient(client))
29
+ return await sftpCopyDir(client, sourcePath, targetPath);
30
+ return Outcome.makeFailure('Invalid client type');
4
31
  }
5
- function makeFailure(error) {
6
- return { success: false, error };
7
- }
8
-
9
- // src/node/cloud-storage/clients/index.ts
10
- import { Bucket as GCSBucket } from "@google-cloud/storage";
11
- import { S3Client } from "@aws-sdk/client-s3";
12
- import { Client as FtpClient } from "basic-ftp";
13
- import SftpClient from "ssh2-sftp-client";
14
- var isGcsBucket = (client) => client instanceof GCSBucket;
15
- var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
16
- var isFtpClient = (client) => client instanceof FtpClient;
17
- var isSftpClient = (client) => client instanceof SftpClient;
18
-
19
- // src/node/ftps/directory/copy-dir/index.ts
20
- import { PassThrough } from "node:stream";
21
-
22
- // src/agnostic/errors/unknown-to-string/index.ts
23
- function unknownToString(unk, encoding) {
24
- if (unk instanceof Error) return unk.message;
25
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
26
- if (typeof unk === "string") return unk;
27
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
28
- return `${unk}`;
29
- }
30
-
31
- // src/node/ftps/directory/copy-dir/index.ts
32
- async function copyDir(ftpClient, sourceDir, targetDir, options) {
33
- const {
34
- overwrite = false,
35
- ensureDir = true
36
- } = options ?? {};
37
- async function recurse(dir) {
38
- const list = await ftpClient.list(dir);
39
- for (const entry of list) {
40
- const src = dir.endsWith("/") ? dir + entry.name : dir + "/" + entry.name;
41
- const rel = src.substring(sourceDir.length + (sourceDir.endsWith("/") ? 0 : 1));
42
- const dst = targetDir.endsWith("/") ? targetDir + rel : `${targetDir}/${rel}`;
43
- if (entry.isDirectory) {
44
- if (ensureDir) await ftpClient.ensureDir(dst);
45
- await recurse(src);
46
- } else if (entry.isFile) {
47
- if (!overwrite) {
48
- try {
49
- await ftpClient.size(dst);
50
- throw new Error(`File already exists at ${dst}.`);
51
- } catch {
52
- }
53
- }
54
- if (ensureDir) {
55
- const dirPath = dst.substring(0, dst.lastIndexOf("/"));
56
- await ftpClient.ensureDir(dirPath);
57
- }
58
- const pass = new PassThrough();
59
- const upload = ftpClient.uploadFrom(pass, dst);
60
- await ftpClient.downloadTo(pass, src);
61
- await upload;
62
- }
63
- }
64
- }
65
- try {
66
- if (ensureDir) await ftpClient.ensureDir(targetDir);
67
- await recurse(sourceDir);
68
- return makeSuccess(true);
69
- } catch (err) {
70
- return makeFailure(unknownToString(err));
71
- }
72
- }
73
-
74
- // src/node/sftp/directory/copy-dir/index.ts
75
- import { PassThrough as PassThrough2 } from "node:stream";
76
- async function copyDir2(sftp, sourceDir, targetDir, options) {
77
- const {
78
- overwrite = false,
79
- ensureDir = true,
80
- ...transferOptions
81
- } = options ?? {};
82
- async function recurse(dir) {
83
- const list = await sftp.list(dir);
84
- for (const entry of list) {
85
- const src = dir.endsWith("/") ? dir + entry.name : dir + "/" + entry.name;
86
- const rel = src.substring(sourceDir.length + (sourceDir.endsWith("/") ? 0 : 1));
87
- const dst = targetDir.endsWith("/") ? targetDir + rel : `${targetDir}/${rel}`;
88
- if (entry.type === "d") {
89
- if (ensureDir) await sftp.mkdir(dst, true);
90
- await recurse(src);
91
- } else if (entry.type === "-") {
92
- if (!overwrite) {
93
- const exists = await sftp.exists(dst);
94
- if (exists !== false) throw new Error(`File already exists at ${dst}.`);
95
- }
96
- if (ensureDir) {
97
- const dirPath = dst.substring(0, dst.lastIndexOf("/"));
98
- await sftp.mkdir(dirPath, true);
99
- }
100
- const pass = new PassThrough2();
101
- const upload = sftp.put(pass, dst, transferOptions);
102
- await sftp.get(src, pass, transferOptions);
103
- await upload;
104
- }
105
- }
106
- }
107
- try {
108
- if (ensureDir) await sftp.mkdir(targetDir, true);
109
- await recurse(sourceDir);
110
- return makeSuccess(true);
111
- } catch (err) {
112
- return makeFailure(unknownToString(err));
113
- }
114
- }
115
-
116
- // src/node/@aws-s3/storage/directory/copy-dir/index.ts
117
- import {
118
- ListObjectsV2Command,
119
- CopyObjectCommand,
120
- HeadObjectCommand
121
- } from "@aws-sdk/client-s3";
122
- async function copyDir3(client, bucketName, sourceDir, targetDir, options) {
123
- const { listObjectsOptions, copyOptions, overwrite = false } = options ?? {};
124
- const from = sourceDir.endsWith("/") ? sourceDir : `${sourceDir}/`;
125
- const to = targetDir.endsWith("/") ? targetDir : `${targetDir}/`;
126
- try {
127
- let token;
128
- do {
129
- const listResp = await client.send(
130
- new ListObjectsV2Command({
131
- Bucket: bucketName,
132
- Prefix: from,
133
- ContinuationToken: token,
134
- ...listObjectsOptions
135
- })
136
- );
137
- for (const obj of listResp.Contents ?? []) {
138
- if (obj.Key === void 0) continue;
139
- const rel = obj.Key.substring(from.length);
140
- const dest = `${to}${rel}`;
141
- if (!overwrite) {
142
- try {
143
- await client.send(new HeadObjectCommand({ Bucket: bucketName, Key: dest }));
144
- continue;
145
- } catch (err) {
146
- const code = err?.name ?? err?.$metadata?.httpStatusCode;
147
- if (code !== "NotFound" && code !== 404) {
148
- return makeFailure(unknownToString(err));
149
- }
150
- }
151
- }
152
- await client.send(
153
- new CopyObjectCommand({
154
- Bucket: bucketName,
155
- Key: dest,
156
- CopySource: `${bucketName}/${obj.Key}`,
157
- ...copyOptions
158
- })
159
- );
160
- }
161
- token = listResp.IsTruncated === true ? listResp.NextContinuationToken : void 0;
162
- } while (token !== void 0);
163
- return makeSuccess(true);
164
- } catch (err) {
165
- return makeFailure(unknownToString(err));
166
- }
167
- }
168
-
169
- // src/node/@google-cloud/storage/directory/copy-dir/index.ts
170
- async function copyDir4(bucket, sourceDir, targetDir, options) {
171
- const { getFileOptions, copyOptions, overwrite = false } = options ?? {};
172
- const from = sourceDir.endsWith("/") ? sourceDir : `${sourceDir}/`;
173
- const to = targetDir.endsWith("/") ? targetDir : `${targetDir}/`;
174
- try {
175
- const [files] = await bucket.getFiles({ ...getFileOptions, prefix: from });
176
- for (const f of files) {
177
- const rel = f.name.substring(from.length);
178
- const dest = `${to}${rel}`;
179
- if (!overwrite) {
180
- const destFile = bucket.file(dest);
181
- const [exists] = await destFile.exists();
182
- if (exists) {
183
- continue;
184
- }
185
- }
186
- await f.copy(dest, copyOptions);
187
- }
188
- return makeSuccess(true);
189
- } catch (err) {
190
- return makeFailure(unknownToString(err));
191
- }
192
- }
193
-
194
- // src/node/cloud-storage/operations/copy-dir/index.ts
195
- async function copyDir5(client, sourcePath, targetPath, options) {
196
- if (isGcsBucket(client)) return await copyDir4(client, sourcePath, targetPath, options);
197
- if (isS3ClientWithBucket(client)) return await copyDir3(client.client, client.bucketName, sourcePath, targetPath, options);
198
- if (isFtpClient(client)) return await copyDir(client, sourcePath, targetPath);
199
- if (isSftpClient(client)) return await copyDir2(client, sourcePath, targetPath);
200
- return makeFailure("Invalid client type");
201
- }
202
- export {
203
- copyDir5 as copyDir
204
- };
@@ -1,153 +1,31 @@
1
- // src/agnostic/misc/outcome/index.ts
2
- function makeSuccess(payload) {
3
- return { success: true, payload };
1
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
2
+ import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
3
+ import { copy as ftpCopy } from '../../../ftps/file/copy/index.js';
4
+ import { copy as sftpCopy } from '../../../sftp/file/copy/index.js';
5
+ import { copy as s3Copy } from '../../../@aws-s3/storage/file/copy/index.js';
6
+ import { copy as gcsCopy } from '../../../@google-cloud/storage/file/copy/index.js';
7
+ /**
8
+ * Copies a file from one path to another.
9
+ *
10
+ * The function automatically dispatches to the appropriate implementation based on
11
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP).
12
+ *
13
+ * @param {AnyClient} client - The cloud storage client instance.
14
+ * @param {string} sourcePath - The source file path to copy from.
15
+ * @param {string} targetPath - The target file path to copy to.
16
+ * @param {GcsCopyOptions | S3CopyOptions | FtpsCopyOptions | SftpCopyOptions} [options] - Optional copy configuration.
17
+ * @returns {Promise<Outcome.Either<true, string>>}
18
+ * - On success: `Outcome.makeSuccess(true)`.
19
+ * - On failure: `Outcome.makeFailure(errStr)`.
20
+ */
21
+ export async function copyFile(client, sourcePath, targetPath, options) {
22
+ if (isGcsBucket(client))
23
+ return await gcsCopy(client, sourcePath, targetPath, options);
24
+ if (isS3ClientWithBucket(client))
25
+ return await s3Copy(client.client, client.bucketName, sourcePath, targetPath, options);
26
+ if (isFtpClient(client))
27
+ return await ftpCopy(client, sourcePath, targetPath, options);
28
+ if (isSftpClient(client))
29
+ return await sftpCopy(client, sourcePath, targetPath, options);
30
+ return Outcome.makeFailure('Invalid client type');
4
31
  }
5
- function makeFailure(error) {
6
- return { success: false, error };
7
- }
8
-
9
- // src/node/cloud-storage/clients/index.ts
10
- import { Bucket as GCSBucket } from "@google-cloud/storage";
11
- import { S3Client } from "@aws-sdk/client-s3";
12
- import { Client as FtpClient } from "basic-ftp";
13
- import SftpClient from "ssh2-sftp-client";
14
- var isGcsBucket = (client) => client instanceof GCSBucket;
15
- var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
16
- var isFtpClient = (client) => client instanceof FtpClient;
17
- var isSftpClient = (client) => client instanceof SftpClient;
18
-
19
- // src/node/ftps/file/copy/index.ts
20
- import { PassThrough } from "node:stream";
21
-
22
- // src/agnostic/errors/unknown-to-string/index.ts
23
- function unknownToString(unk, encoding) {
24
- if (unk instanceof Error) return unk.message;
25
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
26
- if (typeof unk === "string") return unk;
27
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
28
- return `${unk}`;
29
- }
30
-
31
- // src/node/ftps/file/copy/index.ts
32
- async function copy(ftpClient, sourcePath, targetPath, options) {
33
- const {
34
- overwrite = false,
35
- ensureDir = true
36
- } = options ?? {};
37
- try {
38
- if (!overwrite) {
39
- try {
40
- await ftpClient.size(targetPath);
41
- return makeFailure(`File already exists at ${targetPath}.`);
42
- } catch {
43
- }
44
- }
45
- if (ensureDir) {
46
- const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
47
- await ftpClient.ensureDir(dirPath);
48
- }
49
- const pass = new PassThrough();
50
- const uploadPromise = ftpClient.uploadFrom(pass, targetPath);
51
- await ftpClient.downloadTo(pass, sourcePath);
52
- await uploadPromise;
53
- return makeSuccess(true);
54
- } catch (err) {
55
- return makeFailure(unknownToString(err));
56
- }
57
- }
58
-
59
- // src/node/sftp/file/copy/index.ts
60
- import { PassThrough as PassThrough2 } from "node:stream";
61
- async function copy2(sftp, sourcePath, targetPath, options) {
62
- const {
63
- overwrite = false,
64
- ensureDir = true,
65
- ...transferOptions
66
- } = options ?? {};
67
- try {
68
- if (!overwrite) {
69
- const exists = await sftp.exists(targetPath);
70
- if (exists !== false) return makeFailure(`File already exists at ${targetPath}.`);
71
- }
72
- if (ensureDir) {
73
- const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
74
- await sftp.mkdir(dirPath, true);
75
- }
76
- const pass = new PassThrough2();
77
- const uploadPromise = sftp.put(pass, targetPath, transferOptions);
78
- await sftp.get(sourcePath, pass, transferOptions);
79
- await uploadPromise;
80
- return makeSuccess(true);
81
- } catch (err) {
82
- return makeFailure(unknownToString(err));
83
- }
84
- }
85
-
86
- // src/node/@aws-s3/storage/file/copy/index.ts
87
- import {
88
- CopyObjectCommand,
89
- HeadObjectCommand
90
- } from "@aws-sdk/client-s3";
91
- async function copy3(client, bucketName, sourcePath, targetPath, options) {
92
- const {
93
- copyOptions,
94
- overwrite = false
95
- } = options ?? {};
96
- try {
97
- if (!overwrite) {
98
- try {
99
- await client.send(new HeadObjectCommand({ Bucket: bucketName, Key: targetPath }));
100
- return makeFailure(`Object already exists at ${targetPath}.`);
101
- } catch (err) {
102
- const notFound = err.$metadata?.httpStatusCode === 404 || err.name === "NotFound";
103
- if (!notFound) throw err;
104
- }
105
- }
106
- await client.send(
107
- new CopyObjectCommand({
108
- Bucket: bucketName,
109
- Key: targetPath,
110
- CopySource: `${bucketName}/${sourcePath}`,
111
- ...copyOptions
112
- })
113
- );
114
- return makeSuccess(true);
115
- } catch (err) {
116
- return makeFailure(unknownToString(err));
117
- }
118
- }
119
-
120
- // src/node/@google-cloud/storage/file/copy/index.ts
121
- async function copy4(bucket, sourcePath, targetPath, options) {
122
- const {
123
- fileOptions,
124
- copyOptions,
125
- overwrite = false
126
- } = options ?? {};
127
- try {
128
- const srcFile = bucket.file(sourcePath, fileOptions);
129
- const destFile = bucket.file(targetPath, fileOptions);
130
- if (!overwrite) {
131
- const [destExists] = await destFile.exists();
132
- if (destExists) {
133
- return makeFailure(`Object already exists at ${targetPath}.`);
134
- }
135
- }
136
- await srcFile.copy(destFile, copyOptions);
137
- return makeSuccess(true);
138
- } catch (err) {
139
- return makeFailure(unknownToString(err));
140
- }
141
- }
142
-
143
- // src/node/cloud-storage/operations/copy-file/index.ts
144
- async function copyFile(client, sourcePath, targetPath, options) {
145
- if (isGcsBucket(client)) return await copy4(client, sourcePath, targetPath, options);
146
- if (isS3ClientWithBucket(client)) return await copy3(client.client, client.bucketName, sourcePath, targetPath, options);
147
- if (isFtpClient(client)) return await copy(client, sourcePath, targetPath, options);
148
- if (isSftpClient(client)) return await copy2(client, sourcePath, targetPath, options);
149
- return makeFailure("Invalid client type");
150
- }
151
- export {
152
- copyFile
153
- };
@@ -1,104 +1,31 @@
1
- // src/agnostic/misc/outcome/index.ts
2
- function makeSuccess(payload) {
3
- return { success: true, payload };
1
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
2
+ import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
3
+ import { download as ftpDownload } from '../../../ftps/file/download/index.js';
4
+ import { download as sftpDownload } from '../../../sftp/file/download/index.js';
5
+ import { download as s3Download } from '../../../@aws-s3/storage/file/download/index.js';
6
+ import { download as gcsDownload } from '../../../@google-cloud/storage/file/download/index.js';
7
+ /**
8
+ * Downloads a file from cloud storage.
9
+ *
10
+ * The function automatically dispatches to the appropriate implementation based on
11
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP) and streams the file's
12
+ * content back as a Node `Readable`.
13
+ *
14
+ * @param {AnyClient} client - The cloud storage client instance.
15
+ * @param {string} path - The path of the file to download.
16
+ * @param {GcsDownloadOptions | S3DownloadOptions | FtpDownloadOptions | SftpDownloadOptions} [options] - Optional download configuration.
17
+ * @returns {Promise<Outcome.Either<Readable, string>>}
18
+ * - On success: `Outcome.makeSuccess(stream)` containing the file content.
19
+ * - On failure: `Outcome.makeFailure(errStr)`.
20
+ */
21
+ export async function downloadFile(client, path, options) {
22
+ if (isGcsBucket(client))
23
+ return await gcsDownload(client, path, options);
24
+ if (isS3ClientWithBucket(client))
25
+ return await s3Download(client.client, client.bucketName, path, options);
26
+ if (isFtpClient(client))
27
+ return await ftpDownload(client, path, options);
28
+ if (isSftpClient(client))
29
+ return await sftpDownload(client, path, options);
30
+ return Outcome.makeFailure('Invalid client type');
4
31
  }
5
- function makeFailure(error) {
6
- return { success: false, error };
7
- }
8
-
9
- // src/node/cloud-storage/clients/index.ts
10
- import { Bucket as GCSBucket } from "@google-cloud/storage";
11
- import { S3Client } from "@aws-sdk/client-s3";
12
- import { Client as FtpClient } from "basic-ftp";
13
- import SftpClient from "ssh2-sftp-client";
14
- var isGcsBucket = (client) => client instanceof GCSBucket;
15
- var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
16
- var isFtpClient = (client) => client instanceof FtpClient;
17
- var isSftpClient = (client) => client instanceof SftpClient;
18
-
19
- // src/node/ftps/file/download/index.ts
20
- import { PassThrough } from "node:stream";
21
-
22
- // src/agnostic/errors/unknown-to-string/index.ts
23
- function unknownToString(unk, encoding) {
24
- if (unk instanceof Error) return unk.message;
25
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
26
- if (typeof unk === "string") return unk;
27
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
28
- return `${unk}`;
29
- }
30
-
31
- // src/node/ftps/file/download/index.ts
32
- async function download(ftpClient, sourcePath, options) {
33
- const { startAt } = options ?? {};
34
- const stream = new PassThrough();
35
- try {
36
- await ftpClient.downloadTo(stream, sourcePath, startAt);
37
- return makeSuccess(stream);
38
- } catch (err) {
39
- const errStr = unknownToString(err);
40
- return makeFailure(errStr);
41
- }
42
- }
43
-
44
- // src/node/sftp/file/download/index.ts
45
- async function download2(sftp, sourcePath, options) {
46
- try {
47
- const stream = sftp.createReadStream(sourcePath, options);
48
- stream.on("error", (err) => {
49
- throw err;
50
- });
51
- return makeSuccess(stream);
52
- } catch (err) {
53
- const errStr = unknownToString(err);
54
- return makeFailure(errStr);
55
- }
56
- }
57
-
58
- // src/node/@aws-s3/storage/file/download/index.ts
59
- import {
60
- GetObjectCommand
61
- } from "@aws-sdk/client-s3";
62
- async function download3(client, bucketName, sourcePath, options) {
63
- try {
64
- const response = await client.send(
65
- new GetObjectCommand({
66
- Bucket: bucketName,
67
- Key: sourcePath,
68
- ...options
69
- })
70
- );
71
- const stream = response.Body;
72
- return makeSuccess(stream);
73
- } catch (err) {
74
- return makeFailure(unknownToString(err));
75
- }
76
- }
77
-
78
- // src/node/@google-cloud/storage/file/download/index.ts
79
- async function download4(bucket, sourcePath, options) {
80
- const { fileOptions, downloadOptions } = options ?? {};
81
- try {
82
- const file = bucket.file(sourcePath, fileOptions);
83
- const stream = file.createReadStream(downloadOptions);
84
- stream.on("error", (err) => {
85
- throw err;
86
- });
87
- return makeSuccess(stream);
88
- } catch (err) {
89
- const errStr = unknownToString(err);
90
- return makeFailure(errStr);
91
- }
92
- }
93
-
94
- // src/node/cloud-storage/operations/download-file/index.ts
95
- async function downloadFile(client, path, options) {
96
- if (isGcsBucket(client)) return await download4(client, path, options);
97
- if (isS3ClientWithBucket(client)) return await download3(client.client, client.bucketName, path, options);
98
- if (isFtpClient(client)) return await download(client, path, options);
99
- if (isSftpClient(client)) return await download2(client, path, options);
100
- return makeFailure("Invalid client type");
101
- }
102
- export {
103
- downloadFile
104
- };
@@ -1,104 +1,31 @@
1
- // src/agnostic/misc/outcome/index.ts
2
- function makeSuccess(payload) {
3
- return { success: true, payload };
1
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
2
+ import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
3
+ import { exists as ftpExists } from '../../../ftps/file/exists/index.js';
4
+ import { exists as sftpExists } from '../../../sftp/file/exists/index.js';
5
+ import { exists as s3Exists } from '../../../@aws-s3/storage/file/exists/index.js';
6
+ import { exists as gcsExists } from '../../../@google-cloud/storage/file/exists/index.js';
7
+ /**
8
+ * Checks whether a file exists in cloud storage.
9
+ *
10
+ * The function automatically dispatches to the appropriate implementation based on
11
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP).
12
+ *
13
+ * @param {AnyClient} client - The cloud storage client instance.
14
+ * @param {string} path - The path of the file to check.
15
+ * @param {GcsExistsOptions | S3ExistsOptions} [options] - Optional configuration.
16
+ * @returns {Promise<Outcome.Either<boolean, string>>}
17
+ * - On success: `Outcome.makeSuccess(true)` if the file exists,
18
+ * `Outcome.makeSuccess(false)` if it does not.
19
+ * - On failure: `Outcome.makeFailure(errStr)` for unexpected errors.
20
+ */
21
+ export async function existsFile(client, path, options) {
22
+ if (isGcsBucket(client))
23
+ return await gcsExists(client, path, options);
24
+ if (isS3ClientWithBucket(client))
25
+ return await s3Exists(client.client, client.bucketName, path, options);
26
+ if (isFtpClient(client))
27
+ return await ftpExists(client, path);
28
+ if (isSftpClient(client))
29
+ return await sftpExists(client, path);
30
+ return Outcome.makeFailure('Invalid client type');
4
31
  }
5
- function makeFailure(error) {
6
- return { success: false, error };
7
- }
8
-
9
- // src/node/cloud-storage/clients/index.ts
10
- import { Bucket as GCSBucket } from "@google-cloud/storage";
11
- import { S3Client } from "@aws-sdk/client-s3";
12
- import { Client as FtpClient } from "basic-ftp";
13
- import SftpClient from "ssh2-sftp-client";
14
- var isGcsBucket = (client) => client instanceof GCSBucket;
15
- var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
16
- var isFtpClient = (client) => client instanceof FtpClient;
17
- var isSftpClient = (client) => client instanceof SftpClient;
18
-
19
- // src/node/ftps/file/exists/index.ts
20
- import { FileType } from "basic-ftp";
21
-
22
- // src/agnostic/errors/unknown-to-string/index.ts
23
- function unknownToString(unk, encoding) {
24
- if (unk instanceof Error) return unk.message;
25
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
26
- if (typeof unk === "string") return unk;
27
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
28
- return `${unk}`;
29
- }
30
-
31
- // src/node/ftps/file/exists/index.ts
32
- async function exists(ftpClient, sourcePath) {
33
- try {
34
- const lastSlash = sourcePath.lastIndexOf("/");
35
- const parentDir = lastSlash === -1 ? "." : sourcePath.slice(0, lastSlash) || "/";
36
- const baseName = lastSlash === -1 ? sourcePath : sourcePath.slice(lastSlash + 1);
37
- const list = await ftpClient.list(parentDir);
38
- const entry = list.find((e) => e.name === baseName);
39
- const isFile = entry !== void 0 ? entry.type === FileType.File || entry.type === FileType.SymbolicLink : false;
40
- return makeSuccess(isFile);
41
- } catch (err) {
42
- return makeFailure(unknownToString(err));
43
- }
44
- }
45
-
46
- // src/node/sftp/file/exists/index.ts
47
- async function exists2(sftp, sourcePath) {
48
- try {
49
- const res = await sftp.exists(sourcePath);
50
- const isFile = res === "-" || res === "l";
51
- return makeSuccess(isFile);
52
- } catch (err) {
53
- return makeFailure(unknownToString(err));
54
- }
55
- }
56
-
57
- // src/node/@aws-s3/storage/file/exists/index.ts
58
- import {
59
- HeadObjectCommand
60
- } from "@aws-sdk/client-s3";
61
- async function exists3(client, bucketName, sourcePath, options) {
62
- const { headObjectOptions } = options ?? {};
63
- try {
64
- await client.send(
65
- new HeadObjectCommand({
66
- Bucket: bucketName,
67
- Key: sourcePath,
68
- ...headObjectOptions
69
- })
70
- );
71
- return makeSuccess(true);
72
- } catch (err) {
73
- const notFound = err.$metadata?.httpStatusCode === 404 || err.name === "NotFound" || err.Code === "NotFound" || err.Code === "NoSuchKey";
74
- if (notFound) {
75
- return makeSuccess(false);
76
- }
77
- return makeFailure(unknownToString(err));
78
- }
79
- }
80
-
81
- // src/node/@google-cloud/storage/file/exists/index.ts
82
- async function exists4(bucket, sourcePath, options) {
83
- const { fileOptions, existsOptions } = options ?? {};
84
- try {
85
- const file = bucket.file(sourcePath, fileOptions);
86
- const [exists5] = await file.exists(existsOptions);
87
- return makeSuccess(exists5);
88
- } catch (err) {
89
- const errStr = unknownToString(err);
90
- return makeFailure(errStr);
91
- }
92
- }
93
-
94
- // src/node/cloud-storage/operations/exists-file/index.ts
95
- async function existsFile(client, path, options) {
96
- if (isGcsBucket(client)) return await exists4(client, path, options);
97
- if (isS3ClientWithBucket(client)) return await exists3(client.client, client.bucketName, path, options);
98
- if (isFtpClient(client)) return await exists(client, path);
99
- if (isSftpClient(client)) return await exists2(client, path);
100
- return makeFailure("Invalid client type");
101
- }
102
- export {
103
- existsFile
104
- };