@design-edito/tools 0.4.5 → 0.4.11

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 (421) 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.d.ts +1 -1
  11. package/agnostic/arrays/make/index.js +11 -6
  12. package/agnostic/arrays/make/index.test.js +10 -0
  13. package/agnostic/arrays/random-pick/index.js +38 -22
  14. package/agnostic/arrays/random-pick/index.test.js +23 -0
  15. package/agnostic/arrays/shuffle/index.js +15 -11
  16. package/agnostic/arrays/shuffle/index.test.js +14 -0
  17. package/agnostic/booleans/is-falsy/index.js +24 -15
  18. package/agnostic/booleans/is-falsy/index.test.js +26 -0
  19. package/agnostic/colors/channels/index.js +139 -936
  20. package/agnostic/colors/channels/index.test.js +64 -0
  21. package/agnostic/colors/contrast/index.js +24 -643
  22. package/agnostic/colors/contrast/index.test.js +21 -0
  23. package/agnostic/colors/convert/index.js +811 -837
  24. package/agnostic/colors/convert/index.test.js +98 -0
  25. package/agnostic/colors/cssColorsMap.js +153 -0
  26. package/agnostic/colors/distance/index.js +66 -538
  27. package/agnostic/colors/distance/index.test.js +21 -0
  28. package/agnostic/colors/grayscale/index.js +95 -872
  29. package/agnostic/colors/grayscale/index.test.js +34 -0
  30. package/agnostic/colors/index.d.ts +4 -4
  31. package/agnostic/colors/index.js +4 -4
  32. package/agnostic/colors/invert/index.js +34 -719
  33. package/agnostic/colors/invert/index.test.js +31 -0
  34. package/agnostic/colors/lerp/index.js +75 -804
  35. package/agnostic/colors/lerp/index.test.js +55 -0
  36. package/agnostic/colors/luminance/index.js +17 -625
  37. package/agnostic/colors/luminance/index.test.js +30 -0
  38. package/agnostic/colors/palette/index.js +83 -917
  39. package/agnostic/colors/palette/index.test.js +35 -0
  40. package/agnostic/colors/rotate/index.js +35 -835
  41. package/agnostic/colors/rotate/index.test.js +45 -0
  42. package/agnostic/colors/tidy/index.js +79 -530
  43. package/agnostic/colors/tidy/index.test.js +45 -0
  44. package/agnostic/colors/typechecks/index.js +188 -250
  45. package/agnostic/colors/typechecks/index.test.js +113 -0
  46. package/agnostic/colors/types.js +1 -0
  47. package/agnostic/css/bem/index.js +134 -171
  48. package/agnostic/css/clss/index.js +64 -29
  49. package/agnostic/css/clss/index.test.js +60 -0
  50. package/agnostic/css/generate-nice-color/index.js +26 -71
  51. package/agnostic/css/generate-nice-color/index.test.js +8 -0
  52. package/agnostic/css/index.d.ts +2 -2
  53. package/agnostic/css/index.js +2 -2
  54. package/agnostic/css/is-valid-css-class-name/index.js +14 -8
  55. package/agnostic/css/is-valid-css-class-name/index.test.js +36 -0
  56. package/agnostic/css/scale/index.d.ts +46 -16
  57. package/agnostic/css/scale/index.js +70 -54
  58. package/agnostic/css/scale/index.test.js +88 -0
  59. package/agnostic/css/styles-set/index.js +151 -178
  60. package/agnostic/errors/index.d.ts +1 -1
  61. package/agnostic/errors/index.js +1 -1
  62. package/agnostic/errors/register/index.js +45 -49
  63. package/agnostic/errors/unknown-to-string/index.js +17 -10
  64. package/agnostic/errors/unknown-to-string/index.test.js +35 -0
  65. package/agnostic/html/get-node-ancestors/index.js +29 -29
  66. package/agnostic/html/get-node-ancestors/index.test.js +58 -0
  67. package/agnostic/html/get-position-inside-parent/index.js +13 -8
  68. package/agnostic/html/get-position-inside-parent/index.test.js +56 -0
  69. package/agnostic/html/hyper-json/cast/index.js +128 -2931
  70. package/agnostic/html/hyper-json/index.js +23 -2954
  71. package/agnostic/html/hyper-json/method/index.js +10 -14
  72. package/agnostic/html/hyper-json/serialize/index.js +88 -222
  73. package/agnostic/html/hyper-json/smart-tags/coalesced/add/index.js +14 -2938
  74. package/agnostic/html/hyper-json/smart-tags/coalesced/addclass/index.js +27 -2937
  75. package/agnostic/html/hyper-json/smart-tags/coalesced/and/index.js +13 -2938
  76. package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.js +34 -2938
  77. package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.js +42 -2935
  78. package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.js +47 -2937
  79. package/agnostic/html/hyper-json/smart-tags/coalesced/clone/index.js +10 -2939
  80. package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.js +45 -2936
  81. package/agnostic/html/hyper-json/smart-tags/coalesced/equals/index.js +22 -2938
  82. package/agnostic/html/hyper-json/smart-tags/coalesced/getattribute/index.js +26 -2938
  83. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperties/index.js +19 -2938
  84. package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.js +67 -2935
  85. package/agnostic/html/hyper-json/smart-tags/coalesced/hjparse/index.js +21 -2937
  86. package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.js +89 -2938
  87. package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.js +20 -2938
  88. package/agnostic/html/hyper-json/smart-tags/coalesced/index.d.ts +11 -11
  89. package/agnostic/html/hyper-json/smart-tags/coalesced/index.js +11 -11
  90. package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.js +37 -2938
  91. package/agnostic/html/hyper-json/smart-tags/coalesced/join/index.js +16 -2938
  92. package/agnostic/html/hyper-json/smart-tags/coalesced/length/index.js +21 -2938
  93. package/agnostic/html/hyper-json/smart-tags/coalesced/map/index.js +31 -2938
  94. package/agnostic/html/hyper-json/smart-tags/coalesced/negate/index.js +10 -2939
  95. package/agnostic/html/hyper-json/smart-tags/coalesced/notrailing/index.js +33 -2938
  96. package/agnostic/html/hyper-json/smart-tags/coalesced/or/index.js +13 -2938
  97. package/agnostic/html/hyper-json/smart-tags/coalesced/pickrandom/index.js +17 -2938
  98. package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.js +59 -2938
  99. package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.js +23 -2938
  100. package/agnostic/html/hyper-json/smart-tags/coalesced/push/index.js +10 -2939
  101. package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.js +26 -2938
  102. package/agnostic/html/hyper-json/smart-tags/coalesced/recordtoarray/index.js +10 -2939
  103. package/agnostic/html/hyper-json/smart-tags/coalesced/removeattribute/index.js +53 -2935
  104. package/agnostic/html/hyper-json/smart-tags/coalesced/removeclass/index.js +27 -2937
  105. package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.js +31 -2937
  106. package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.js +55 -2940
  107. package/agnostic/html/hyper-json/smart-tags/coalesced/select/index.js +29 -2935
  108. package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.js +29 -2938
  109. package/agnostic/html/hyper-json/smart-tags/coalesced/setattribute/index.js +53 -2935
  110. package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.js +232 -2936
  111. package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.js +89 -2936
  112. package/agnostic/html/hyper-json/smart-tags/coalesced/split/index.js +20 -2938
  113. package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.js +23 -2939
  114. package/agnostic/html/hyper-json/smart-tags/coalesced/toarray/index.js +11 -2939
  115. package/agnostic/html/hyper-json/smart-tags/coalesced/toboolean/index.js +11 -2939
  116. package/agnostic/html/hyper-json/smart-tags/coalesced/toelement/index.js +17 -2938
  117. package/agnostic/html/hyper-json/smart-tags/coalesced/toggleclass/index.js +27 -2937
  118. package/agnostic/html/hyper-json/smart-tags/coalesced/tonodelist/index.js +11 -2939
  119. package/agnostic/html/hyper-json/smart-tags/coalesced/tonull/index.js +10 -2939
  120. package/agnostic/html/hyper-json/smart-tags/coalesced/tonumber/index.js +11 -2939
  121. package/agnostic/html/hyper-json/smart-tags/coalesced/torecord/index.js +11 -2939
  122. package/agnostic/html/hyper-json/smart-tags/coalesced/toref/index.js +11 -2939
  123. package/agnostic/html/hyper-json/smart-tags/coalesced/tostring/index.js +11 -2939
  124. package/agnostic/html/hyper-json/smart-tags/coalesced/totext/index.js +11 -2939
  125. package/agnostic/html/hyper-json/smart-tags/coalesced/transformselected/index.js +84 -2938
  126. package/agnostic/html/hyper-json/smart-tags/coalesced/trim/index.js +14 -2938
  127. package/agnostic/html/hyper-json/smart-tags/index.js +28 -181
  128. package/agnostic/html/hyper-json/smart-tags/isolated/any/index.js +12 -195
  129. package/agnostic/html/hyper-json/smart-tags/isolated/array/index.js +12 -195
  130. package/agnostic/html/hyper-json/smart-tags/isolated/boolean/index.js +12 -2939
  131. package/agnostic/html/hyper-json/smart-tags/isolated/element/index.js +24 -2938
  132. package/agnostic/html/hyper-json/smart-tags/isolated/get/index.js +18 -2938
  133. package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.js +56 -2937
  134. package/agnostic/html/hyper-json/smart-tags/isolated/index.d.ts +2 -2
  135. package/agnostic/html/hyper-json/smart-tags/isolated/index.js +2 -2
  136. package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.js +18 -2938
  137. package/agnostic/html/hyper-json/smart-tags/isolated/null/index.js +9 -193
  138. package/agnostic/html/hyper-json/smart-tags/isolated/number/index.js +16 -2938
  139. package/agnostic/html/hyper-json/smart-tags/isolated/record/index.js +12 -2938
  140. package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.js +40 -2935
  141. package/agnostic/html/hyper-json/smart-tags/isolated/string/index.js +16 -2938
  142. package/agnostic/html/hyper-json/smart-tags/isolated/text/index.js +18 -2938
  143. package/agnostic/html/hyper-json/transformer/index.js +112 -148
  144. package/agnostic/html/hyper-json/tree/index.js +411 -2928
  145. package/agnostic/html/hyper-json/types/index.js +27 -18
  146. package/agnostic/html/hyper-json/utils/index.js +497 -2921
  147. package/agnostic/html/index.d.ts +2 -2
  148. package/agnostic/html/index.js +2 -2
  149. package/agnostic/html/insert-node/index.js +27 -16
  150. package/agnostic/html/insert-node/index.test.js +73 -0
  151. package/agnostic/html/placeholders/index.js +26 -29
  152. package/agnostic/html/replace-in-element/index.js +31 -48
  153. package/agnostic/html/replace-in-element/index.test.js +80 -0
  154. package/agnostic/html/selector-to-element/index.js +53 -39
  155. package/agnostic/html/selector-to-element/index.test.js +69 -0
  156. package/agnostic/html/string-to-nodes/index.js +24 -25
  157. package/agnostic/html/string-to-nodes/index.test.js +54 -0
  158. package/agnostic/index.d.ts +4 -4
  159. package/agnostic/index.js +4 -4
  160. package/agnostic/misc/assert/index.js +60 -66
  161. package/agnostic/misc/cast/index.js +123 -57
  162. package/agnostic/misc/cast/index.test.js +134 -0
  163. package/agnostic/misc/connection/index.js +55 -36
  164. package/agnostic/misc/connection/index.test.js +143 -0
  165. package/agnostic/misc/crawler/index.js +68 -46
  166. package/agnostic/misc/crawler/index.test.js +56 -0
  167. package/agnostic/misc/crossenv/detect-runtime/index.js +41 -13
  168. package/agnostic/misc/crossenv/detect-runtime/index.test.js +24 -0
  169. package/agnostic/misc/crossenv/types.js +21 -14
  170. package/agnostic/misc/crossenv/window/index.js +45 -24
  171. package/agnostic/misc/crossenv/window/index.test.js +24 -0
  172. package/agnostic/misc/data-size/index.js +182 -294
  173. package/agnostic/misc/data-size/index.test.js +100 -0
  174. package/agnostic/misc/data-size/types.js +1 -0
  175. package/agnostic/misc/index.d.ts +5 -5
  176. package/agnostic/misc/index.js +5 -5
  177. package/agnostic/misc/is-constructor-function/index.js +12 -6
  178. package/agnostic/misc/is-constructor-function/index.test.js +36 -0
  179. package/agnostic/misc/is-nullish/index.js +24 -11
  180. package/agnostic/misc/is-nullish/index.test.js +44 -0
  181. package/agnostic/misc/logs/index.d.ts +1 -1
  182. package/agnostic/misc/logs/index.js +1 -1
  183. package/agnostic/misc/logs/logger/index.js +115 -140
  184. package/agnostic/misc/logs/make-text-block/index.js +13 -13
  185. package/agnostic/misc/logs/styles/index.js +29 -48
  186. package/agnostic/misc/lorem-ipsum/index.js +51 -201
  187. package/agnostic/misc/lorem-ipsum/index.test.js +49 -0
  188. package/agnostic/misc/normalize-extension/index.js +99 -88
  189. package/agnostic/misc/normalize-extension/index.test.js +40 -0
  190. package/agnostic/misc/outcome/index.js +20 -14
  191. package/agnostic/misc/outcome/index.test.js +40 -0
  192. package/agnostic/numbers/absolute-modulo/index.js +9 -6
  193. package/agnostic/numbers/absolute-modulo/index.test.js +23 -0
  194. package/agnostic/numbers/approximate-rational/index.js +86 -69
  195. package/agnostic/numbers/approximate-rational/index.test.js +90 -0
  196. package/agnostic/numbers/clamp/index.js +12 -8
  197. package/agnostic/numbers/clamp/index.test.js +24 -0
  198. package/agnostic/numbers/geometric-progressions/index.js +25 -16
  199. package/agnostic/numbers/geometric-progressions/index.test.js +45 -0
  200. package/agnostic/numbers/index.d.ts +2 -2
  201. package/agnostic/numbers/index.js +2 -2
  202. package/agnostic/numbers/interpolate/index.js +25 -10
  203. package/agnostic/numbers/interpolate/index.test.js +40 -0
  204. package/agnostic/numbers/round/index.js +30 -15
  205. package/agnostic/numbers/round/index.test.js +56 -0
  206. package/agnostic/objects/deep-get-property/index.js +30 -27
  207. package/agnostic/objects/deep-get-property/index.test.js +59 -0
  208. package/agnostic/objects/enums/is-in-enum/index.js +17 -11
  209. package/agnostic/objects/enums/is-in-enum/index.test.js +100 -0
  210. package/agnostic/objects/flatten-getters/index.js +15 -14
  211. package/agnostic/objects/flatten-getters/index.test.js +78 -0
  212. package/agnostic/objects/index.d.ts +4 -4
  213. package/agnostic/objects/index.js +4 -4
  214. package/agnostic/objects/is-object/index.js +16 -9
  215. package/agnostic/objects/is-object/index.test.js +60 -0
  216. package/agnostic/objects/is-record/index.js +12 -7
  217. package/agnostic/objects/is-record/index.test.js +48 -0
  218. package/agnostic/objects/record-format/index.js +18 -12
  219. package/agnostic/objects/record-format/index.test.js +92 -0
  220. package/agnostic/objects/record-map/index.js +16 -11
  221. package/agnostic/objects/record-map/index.test.js +56 -0
  222. package/agnostic/objects/sort-keys/index.js +15 -11
  223. package/agnostic/objects/sort-keys/index.test.js +37 -0
  224. package/agnostic/objects/validation/index.js +21 -8
  225. package/agnostic/objects/validation/index.test.js +72 -0
  226. package/agnostic/optim/memoize/index.js +24 -16
  227. package/agnostic/optim/memoize/index.test.js +30 -0
  228. package/agnostic/optim/throttle-debounce/index.js +120 -102
  229. package/agnostic/optim/throttle-debounce/index.test.js +44 -0
  230. package/agnostic/optim/throttle-debounce/types.js +1 -0
  231. package/agnostic/random/hex-char/index.js +8 -10
  232. package/agnostic/random/hex-char/index.test.js +20 -0
  233. package/agnostic/random/index.d.ts +1 -1
  234. package/agnostic/random/index.js +1 -1
  235. package/agnostic/random/random/index.js +17 -14
  236. package/agnostic/random/random/index.test.js +73 -0
  237. package/agnostic/random/uuid/index.js +28 -20
  238. package/agnostic/random/uuid/index.test.js +45 -0
  239. package/agnostic/regexps/index.js +126 -84
  240. package/agnostic/regexps/index.test.js +108 -0
  241. package/agnostic/sanitization/file-name/index.js +24 -8
  242. package/agnostic/sanitization/file-name/index.test.js +23 -0
  243. package/agnostic/sanitization/html/index.js +172 -122
  244. package/agnostic/sanitization/index.d.ts +1 -1
  245. package/agnostic/sanitization/index.js +1 -1
  246. package/agnostic/sanitization/path/index.js +23 -15
  247. package/agnostic/sanitization/path/index.test.js +18 -0
  248. package/agnostic/sanitization/types.js +1 -0
  249. package/agnostic/sanitization/user-input/index.js +36 -24
  250. package/agnostic/sanitization/user-input/index.test.js +31 -0
  251. package/agnostic/strings/char-codes/index.js +123 -55
  252. package/agnostic/strings/index.d.ts +1 -1
  253. package/agnostic/strings/index.js +1 -1
  254. package/agnostic/strings/matches/index.js +35 -16
  255. package/agnostic/strings/normalize-indent/index.js +34 -16
  256. package/agnostic/strings/parse-table/index.js +153 -86
  257. package/agnostic/strings/replace-all/index.js +36 -15
  258. package/agnostic/strings/to-alphanum/index.js +23 -8
  259. package/agnostic/strings/trim/index.js +22 -9
  260. package/agnostic/time/dates/format-date/index.js +140 -72
  261. package/agnostic/time/duration/index.js +106 -140
  262. package/agnostic/time/timeout/index.js +24 -16
  263. package/agnostic/time/transitions/index.js +200 -158
  264. package/agnostic/time/wait/index.js +10 -8
  265. package/agnostic/typescript/types.js +1 -0
  266. package/components/BeforeAfter/index.controlled.js +95 -0
  267. package/components/BeforeAfter/index.js +54 -189
  268. package/components/BeforeAfter/utils.js +9 -0
  269. package/components/Disclaimer/index.js +50 -110
  270. package/components/Drawer/index.js +81 -196
  271. package/components/EventListener/index.js +29 -80
  272. package/components/Gallery/index.js +146 -221
  273. package/components/Gallery/utils.js +12 -0
  274. package/components/Image/index.js +66 -293
  275. package/components/IntersectionObserver/index.js +62 -110
  276. package/components/Overlayer/index.js +59 -103
  277. package/components/Paginator/index.js +124 -155
  278. package/components/ResizeObserver/index.js +66 -119
  279. package/components/ResizeObserver/style.module.css +0 -0
  280. package/components/Scrllgngn/index.js +171 -468
  281. package/components/ScrollListener/index.js +97 -276
  282. package/components/ScrollListener/utils.js +51 -0
  283. package/components/Sequencer/index.controlled.js +67 -0
  284. package/components/Sequencer/index.js +105 -262
  285. package/components/ShadowRoot/index.js +42 -96
  286. package/components/Subtitles/index.js +107 -244
  287. package/components/Subtitles/types.js +1 -0
  288. package/components/Subtitles/utils.js +102 -0
  289. package/components/Theatre/index.js +88 -136
  290. package/components/UIModule/index.js +156 -199
  291. package/components/Video/index.js +292 -857
  292. package/components/Video/utils.js +137 -0
  293. package/components/_WIP_AudioQuote/index.js +1 -0
  294. package/components/_WIP_Icon/index.js +1 -0
  295. package/components/index.d.ts +4 -4
  296. package/components/index.js +4 -4
  297. package/components/public-classnames.js +18 -0
  298. package/components/utils/index.js +11 -11
  299. package/components/utils/types.js +1 -0
  300. package/index.d.ts +1 -1
  301. package/index.js +1 -1
  302. package/node/@aws-s3/index.test.js +6 -0
  303. package/node/@aws-s3/storage/directory/copy-dir/index.js +66 -72
  304. package/node/@aws-s3/storage/directory/index.d.ts +1 -1
  305. package/node/@aws-s3/storage/directory/index.js +1 -1
  306. package/node/@aws-s3/storage/directory/list/index.js +32 -42
  307. package/node/@aws-s3/storage/directory/move-dir/index.js +68 -86
  308. package/node/@aws-s3/storage/directory/remove-dir/index.js +56 -67
  309. package/node/@aws-s3/storage/file/copy/index.js +41 -53
  310. package/node/@aws-s3/storage/file/download/index.js +29 -40
  311. package/node/@aws-s3/storage/file/exists/index.js +35 -43
  312. package/node/@aws-s3/storage/file/index.d.ts +1 -1
  313. package/node/@aws-s3/storage/file/index.js +1 -1
  314. package/node/@aws-s3/storage/file/move/index.js +57 -63
  315. package/node/@aws-s3/storage/file/remove/index.js +35 -43
  316. package/node/@aws-s3/storage/file/stat/index.js +33 -47
  317. package/node/@aws-s3/storage/file/upload/index.js +52 -63
  318. package/node/@design-edito/index.js +1 -0
  319. package/node/@express/@multer/index.js +61 -55
  320. package/node/@google-cloud/storage/bucket/get-metadata/index.js +25 -29
  321. package/node/@google-cloud/storage/directory/copy-dir/index.js +35 -41
  322. package/node/@google-cloud/storage/directory/index.d.ts +1 -1
  323. package/node/@google-cloud/storage/directory/index.js +1 -1
  324. package/node/@google-cloud/storage/directory/list/index.js +28 -35
  325. package/node/@google-cloud/storage/directory/move-dir/index.js +43 -42
  326. package/node/@google-cloud/storage/directory/remove-dir/index.js +34 -38
  327. package/node/@google-cloud/storage/file/copy/index.js +35 -40
  328. package/node/@google-cloud/storage/file/download/index.js +27 -34
  329. package/node/@google-cloud/storage/file/exists/index.js +25 -31
  330. package/node/@google-cloud/storage/file/generate-signed-url/index.js +33 -35
  331. package/node/@google-cloud/storage/file/get-metadata/index.js +28 -31
  332. package/node/@google-cloud/storage/file/get-permissions/index.js +25 -31
  333. package/node/@google-cloud/storage/file/index.d.ts +3 -3
  334. package/node/@google-cloud/storage/file/index.js +3 -3
  335. package/node/@google-cloud/storage/file/move/index.js +38 -42
  336. package/node/@google-cloud/storage/file/remove/index.js +34 -35
  337. package/node/@google-cloud/storage/file/revoke-signed-urls/index.js +32 -95
  338. package/node/@google-cloud/storage/file/stat/index.js +34 -38
  339. package/node/@google-cloud/storage/file/update-metadata/index.js +30 -31
  340. package/node/@google-cloud/storage/file/upload/index.js +44 -46
  341. package/node/@google-cloud/storage/index.d.ts +1 -1
  342. package/node/@google-cloud/storage/index.js +1 -1
  343. package/node/cloud-storage/clients/index.js +35 -15
  344. package/node/cloud-storage/operations/copy-dir/index.js +30 -203
  345. package/node/cloud-storage/operations/copy-file/index.js +30 -152
  346. package/node/cloud-storage/operations/download-file/index.js +30 -103
  347. package/node/cloud-storage/operations/exists-file/index.js +30 -103
  348. package/node/cloud-storage/operations/index.d.ts +2 -2
  349. package/node/cloud-storage/operations/index.js +2 -2
  350. package/node/cloud-storage/operations/list-dir/index.js +29 -98
  351. package/node/cloud-storage/operations/move-dir/index.js +30 -169
  352. package/node/cloud-storage/operations/move-file/index.js +30 -157
  353. package/node/cloud-storage/operations/remove-dir/index.js +29 -159
  354. package/node/cloud-storage/operations/remove-file/index.js +29 -121
  355. package/node/cloud-storage/operations/stat-file/index.js +29 -124
  356. package/node/cloud-storage/operations/upload-file/index.js +30 -162
  357. package/node/encryption/@aes-256-gcm/buffer/index.js +31 -72
  358. package/node/encryption/@aes-256-gcm/uint8-array/index.js +55 -55
  359. package/node/encryption/key/index.js +19 -12
  360. package/node/files/index.d.ts +1 -1
  361. package/node/files/index.js +1 -1
  362. package/node/files/is-in-directory/index.js +11 -8
  363. package/node/files/read-write/index.js +11 -15
  364. package/node/files/subpaths/index.js +156 -121
  365. package/node/ftps/directory/copy-dir/index.js +55 -62
  366. package/node/ftps/directory/list/index.js +24 -29
  367. package/node/ftps/directory/move-dir/index.js +38 -38
  368. package/node/ftps/directory/remove-dir/index.js +39 -42
  369. package/node/ftps/file/copy/index.js +42 -47
  370. package/node/ftps/file/download/index.js +29 -34
  371. package/node/ftps/file/exists/index.js +38 -36
  372. package/node/ftps/file/index.d.ts +2 -2
  373. package/node/ftps/file/index.js +2 -2
  374. package/node/ftps/file/move/index.js +46 -44
  375. package/node/ftps/file/remove/index.js +36 -39
  376. package/node/ftps/file/stat/index.js +30 -38
  377. package/node/ftps/file/upload/index.js +40 -44
  378. package/node/images/create/index.js +10 -562
  379. package/node/images/format/index.js +264 -815
  380. package/node/images/metadata/index.js +10 -571
  381. package/node/images/transform/index.js +169 -1022
  382. package/node/images/transform/operations/blur/index.js +11 -24
  383. package/node/images/transform/operations/brighten/index.js +11 -24
  384. package/node/images/transform/operations/extend/index.js +25 -589
  385. package/node/images/transform/operations/extract/index.js +15 -28
  386. package/node/images/transform/operations/flatten/index.js +20 -584
  387. package/node/images/transform/operations/flip/index.js +2 -6
  388. package/node/images/transform/operations/flop/index.js +2 -6
  389. package/node/images/transform/operations/hue/index.js +13 -26
  390. package/node/images/transform/operations/index.d.ts +3 -3
  391. package/node/images/transform/operations/index.js +3 -3
  392. package/node/images/transform/operations/level/index.js +14 -30
  393. package/node/images/transform/operations/lighten/index.js +13 -26
  394. package/node/images/transform/operations/normalize/index.js +14 -27
  395. package/node/images/transform/operations/overlay/index.js +89 -673
  396. package/node/images/transform/operations/resize/index.js +46 -610
  397. package/node/images/transform/operations/rotate/index.js +20 -584
  398. package/node/images/transform/operations/saturate/index.js +14 -27
  399. package/node/images/types.js +34 -31
  400. package/node/images/utils/index.js +84 -568
  401. package/node/index.d.ts +2 -2
  402. package/node/index.js +2 -2
  403. package/node/process/on-exit/index.js +45 -26
  404. package/node/process/prompt-continue/index.js +29 -14
  405. package/node/process/spawner/index.js +104 -134
  406. package/node/sftp/directory/copy-dir/index.js +52 -60
  407. package/node/sftp/directory/index.d.ts +1 -1
  408. package/node/sftp/directory/index.js +1 -1
  409. package/node/sftp/directory/list/index.js +22 -29
  410. package/node/sftp/directory/move-dir/index.js +35 -35
  411. package/node/sftp/directory/remove-dir/index.js +39 -42
  412. package/node/sftp/file/copy/index.js +37 -45
  413. package/node/sftp/file/download/index.js +26 -32
  414. package/node/sftp/file/exists/index.js +29 -29
  415. package/node/sftp/file/index.d.ts +2 -2
  416. package/node/sftp/file/index.js +2 -2
  417. package/node/sftp/file/move/index.js +39 -38
  418. package/node/sftp/file/remove/index.js +31 -34
  419. package/node/sftp/file/stat/index.js +26 -37
  420. package/node/sftp/file/upload/index.js +34 -38
  421. package/package.json +1 -1
@@ -1,160 +1,30 @@
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 { removeDir as ftpRemoveDir } from '../../../ftps/directory/remove-dir/index.js';
4
+ import { removeDir as sftpRemoveDir } from '../../../sftp/directory/remove-dir/index.js';
5
+ import { removeDir as s3RemoveDir } from '../../../@aws-s3/storage/directory/remove-dir/index.js';
6
+ import { removeDir as gcsRemoveDir } from '../../../@google-cloud/storage/directory/remove-dir/index.js';
7
+ /**
8
+ * Removes a directory 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).
12
+ *
13
+ * @param {AnyClient} client - The cloud storage client instance.
14
+ * @param {string} sourcePath - The directory path to remove.
15
+ * @param {GcsRemoveDirOptions | S3RemoveDirOptions | FtpsRemoveDirOptions | SftpRemoveDirOptions} [options] - Optional remove configuration.
16
+ * @returns {Promise<Outcome.Either<true, string>>}
17
+ * - On success: `Outcome.makeSuccess(true)`.
18
+ * - On failure: `Outcome.makeFailure(errStr)`.
19
+ */
20
+ export async function removeDir(client, sourcePath, options) {
21
+ if (isGcsBucket(client))
22
+ return await gcsRemoveDir(client, sourcePath, options);
23
+ if (isS3ClientWithBucket(client))
24
+ return await s3RemoveDir(client.client, client.bucketName, sourcePath, options);
25
+ if (isFtpClient(client))
26
+ return await ftpRemoveDir(client, sourcePath, options);
27
+ if (isSftpClient(client))
28
+ return await sftpRemoveDir(client, sourcePath, options);
29
+ return Outcome.makeFailure('Invalid client type');
4
30
  }
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/agnostic/errors/unknown-to-string/index.ts
20
- function unknownToString(unk, encoding) {
21
- if (unk instanceof Error) return unk.message;
22
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
23
- if (typeof unk === "string") return unk;
24
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
25
- return `${unk}`;
26
- }
27
-
28
- // src/node/ftps/directory/remove-dir/index.ts
29
- async function removeDir(ftpClient, directoryPath, options) {
30
- const { ignoreMissing = true } = options ?? {};
31
- async function recurse(dir) {
32
- const list = await ftpClient.list(dir);
33
- for (const entry of list) {
34
- const full = dir.endsWith("/") ? dir + entry.name : `${dir}/${entry.name}`;
35
- if (entry.isDirectory) {
36
- await recurse(full);
37
- } else if (entry.isFile) {
38
- await ftpClient.remove(full);
39
- }
40
- }
41
- await ftpClient.removeDir(dir);
42
- }
43
- try {
44
- await recurse(directoryPath);
45
- return makeSuccess(true);
46
- } catch (err) {
47
- if (ignoreMissing && err.code === 550) {
48
- return makeSuccess(true);
49
- }
50
- return makeFailure(unknownToString(err));
51
- }
52
- }
53
-
54
- // src/node/sftp/directory/remove-dir/index.ts
55
- async function removeDir2(sftp, directoryPath, options) {
56
- const { ignoreMissing = true } = options ?? {};
57
- async function recurse(dir) {
58
- const list = await sftp.list(dir);
59
- for (const entry of list) {
60
- const full = dir.endsWith("/") ? dir + entry.name : `${dir}/${entry.name}`;
61
- if (entry.type === "d") {
62
- await recurse(full);
63
- } else if (entry.type === "-") {
64
- await sftp.delete(full);
65
- }
66
- }
67
- await sftp.rmdir(dir);
68
- }
69
- try {
70
- await recurse(directoryPath);
71
- return makeSuccess(true);
72
- } catch (err) {
73
- if (ignoreMissing && (err.code === 2 || err.code === "ENOENT")) {
74
- return makeSuccess(true);
75
- }
76
- return makeFailure(unknownToString(err));
77
- }
78
- }
79
-
80
- // src/node/@aws-s3/storage/directory/remove-dir/index.ts
81
- import {
82
- ListObjectsV2Command,
83
- DeleteObjectsCommand
84
- } from "@aws-sdk/client-s3";
85
- async function removeDir3(client, bucketName, directoryPath, options) {
86
- const {
87
- listObjectsOptions,
88
- deleteObjectsOptions,
89
- ignoreMissing = true
90
- } = options ?? {};
91
- const prefix = directoryPath.endsWith("/") ? directoryPath : `${directoryPath}/`;
92
- let continuationToken;
93
- let anyFound = false;
94
- try {
95
- do {
96
- const listResp = await client.send(
97
- new ListObjectsV2Command({
98
- Bucket: bucketName,
99
- Prefix: prefix,
100
- ContinuationToken: continuationToken,
101
- ...listObjectsOptions
102
- })
103
- );
104
- const keys = (listResp.Contents ?? []).map((o) => o.Key).filter((e) => e !== void 0);
105
- if (keys.length > 0) {
106
- anyFound = true;
107
- for (let i = 0; i < keys.length; i += 1e3) {
108
- const chunk = keys.slice(i, i + 1e3);
109
- await client.send(
110
- new DeleteObjectsCommand({
111
- Bucket: bucketName,
112
- Delete: { Objects: chunk.map((Key) => ({ Key })) },
113
- ...deleteObjectsOptions
114
- })
115
- );
116
- }
117
- }
118
- continuationToken = listResp.IsTruncated === true ? listResp.NextContinuationToken : void 0;
119
- } while (continuationToken !== void 0);
120
- if (!anyFound && !ignoreMissing) {
121
- return makeFailure(`No objects found for prefix "${prefix}".`);
122
- }
123
- return makeSuccess(true);
124
- } catch (err) {
125
- return makeFailure(unknownToString(err));
126
- }
127
- }
128
-
129
- // src/node/@google-cloud/storage/directory/remove-dir/index.ts
130
- async function removeDir4(bucket, directoryPath, options) {
131
- const {
132
- deleteOptions,
133
- ignoreMissing = true
134
- } = options ?? {};
135
- const prefix = directoryPath.endsWith("/") ? directoryPath : `${directoryPath}/`;
136
- try {
137
- if (!ignoreMissing) {
138
- const [some] = await bucket.getFiles({ prefix, maxResults: 1 });
139
- if (some.length === 0) {
140
- return makeFailure(`No objects found for prefix "${prefix}".`);
141
- }
142
- }
143
- await bucket.deleteFiles({ prefix, ...deleteOptions });
144
- return makeSuccess(true);
145
- } catch (err) {
146
- return makeFailure(unknownToString(err));
147
- }
148
- }
149
-
150
- // src/node/cloud-storage/operations/remove-dir/index.ts
151
- async function removeDir5(client, sourcePath, options) {
152
- if (isGcsBucket(client)) return await removeDir4(client, sourcePath, options);
153
- if (isS3ClientWithBucket(client)) return await removeDir3(client.client, client.bucketName, sourcePath, options);
154
- if (isFtpClient(client)) return await removeDir(client, sourcePath, options);
155
- if (isSftpClient(client)) return await removeDir2(client, sourcePath, options);
156
- return makeFailure("Invalid client type");
157
- }
158
- export {
159
- removeDir5 as removeDir
160
- };
@@ -1,122 +1,30 @@
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 { remove as ftpRemove } from '../../../ftps/file/remove/index.js';
4
+ import { remove as sftpRemove } from '../../../sftp/file/remove/index.js';
5
+ import { remove as s3Remove } from '../../../@aws-s3/storage/file/remove/index.js';
6
+ import { remove as gcsRemove } from '../../../@google-cloud/storage/file/remove/index.js';
7
+ /**
8
+ * Removes 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).
12
+ *
13
+ * @param {AnyClient} client - The cloud storage client instance.
14
+ * @param {string} path - The file path to remove.
15
+ * @param {GcsRemoveOptions | S3RemoveOptions | FtpRemoveOptions | SftpRemoveOptions} [options] - Optional remove configuration.
16
+ * @returns {Promise<Outcome.Either<true, string>>}
17
+ * - On success: `Outcome.makeSuccess(true)`.
18
+ * - On failure: `Outcome.makeFailure(errStr)`.
19
+ */
20
+ export async function removeFile(client, path, options) {
21
+ if (isGcsBucket(client))
22
+ return await gcsRemove(client, path, options);
23
+ if (isS3ClientWithBucket(client))
24
+ return await s3Remove(client.client, path, client.bucketName, options);
25
+ if (isFtpClient(client))
26
+ return await ftpRemove(client, path, options);
27
+ if (isSftpClient(client))
28
+ return await sftpRemove(client, path, options);
29
+ return Outcome.makeFailure('Invalid client type');
4
30
  }
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/agnostic/errors/unknown-to-string/index.ts
20
- function unknownToString(unk, encoding) {
21
- if (unk instanceof Error) return unk.message;
22
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
23
- if (typeof unk === "string") return unk;
24
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
25
- return `${unk}`;
26
- }
27
-
28
- // src/node/ftps/file/remove/index.ts
29
- async function remove(ftpClient, targetPath, options) {
30
- const { ignoreMissing = true } = options ?? {};
31
- try {
32
- let fileExists = true;
33
- try {
34
- await ftpClient.size(targetPath);
35
- } catch {
36
- fileExists = false;
37
- }
38
- if (!fileExists) {
39
- if (ignoreMissing) {
40
- return makeSuccess(true);
41
- }
42
- return makeFailure(`File not found at ${targetPath}.`);
43
- }
44
- await ftpClient.remove(targetPath);
45
- return makeSuccess(true);
46
- } catch (err) {
47
- const errStr = unknownToString(err);
48
- return makeFailure(errStr);
49
- }
50
- }
51
-
52
- // src/node/sftp/file/remove/index.ts
53
- async function remove2(sftp, targetPath, options) {
54
- const { ignoreMissing = true } = options ?? {};
55
- try {
56
- const exists = await sftp.exists(targetPath) !== false;
57
- if (!exists) {
58
- if (ignoreMissing) return makeSuccess(true);
59
- return makeFailure(`File not found at ${targetPath}.`);
60
- }
61
- await sftp.delete(targetPath);
62
- return makeSuccess(true);
63
- } catch (err) {
64
- const errStr = unknownToString(err);
65
- return makeFailure(errStr);
66
- }
67
- }
68
-
69
- // src/node/@aws-s3/storage/file/remove/index.ts
70
- import {
71
- HeadObjectCommand,
72
- DeleteObjectCommand
73
- } from "@aws-sdk/client-s3";
74
- async function remove3(s3, bucketName, targetPath, options) {
75
- const { ignoreMissing = true } = options ?? {};
76
- try {
77
- try {
78
- await s3.send(new HeadObjectCommand({ Bucket: bucketName, Key: targetPath }));
79
- } catch (err) {
80
- const code = err?.name ?? err?.Code ?? err?.code;
81
- if (code === "NotFound" || code === "NoSuchKey" || code === "NotFoundException") {
82
- if (ignoreMissing) return makeSuccess(true);
83
- return makeFailure(`File not found at ${targetPath}.`);
84
- }
85
- return makeFailure(unknownToString(err));
86
- }
87
- await s3.send(new DeleteObjectCommand({ Bucket: bucketName, Key: targetPath }));
88
- return makeSuccess(true);
89
- } catch (err) {
90
- return makeFailure(unknownToString(err));
91
- }
92
- }
93
-
94
- // src/node/@google-cloud/storage/file/remove/index.ts
95
- async function remove4(bucket, targetPath, options) {
96
- const { fileOptions, deleteOptions, ignoreMissing = true } = options ?? {};
97
- try {
98
- const file = bucket.file(targetPath, fileOptions);
99
- const [exists] = await file.exists();
100
- if (!exists) {
101
- if (ignoreMissing) return makeSuccess(true);
102
- return makeFailure(`File not found at ${targetPath}.`);
103
- }
104
- await file.delete(deleteOptions);
105
- return makeSuccess(true);
106
- } catch (err) {
107
- const errStr = unknownToString(err);
108
- return makeFailure(errStr);
109
- }
110
- }
111
-
112
- // src/node/cloud-storage/operations/remove-file/index.ts
113
- async function removeFile(client, path, options) {
114
- if (isGcsBucket(client)) return await remove4(client, path, options);
115
- if (isS3ClientWithBucket(client)) return await remove3(client.client, path, client.bucketName, options);
116
- if (isFtpClient(client)) return await remove(client, path, options);
117
- if (isSftpClient(client)) return await remove2(client, path, options);
118
- return makeFailure("Invalid client type");
119
- }
120
- export {
121
- removeFile
122
- };
@@ -1,125 +1,30 @@
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 { stat as ftpStat } from '../../../ftps/file/stat/index.js';
4
+ import { stat as sftpStat } from '../../../sftp/file/stat/index.js';
5
+ import { stat as s3Stat } from '../../../@aws-s3/storage/file/stat/index.js';
6
+ import { stat as gcsStat } from '../../../@google-cloud/storage/file/stat/index.js';
7
+ /**
8
+ * Retrieves metadata for a file 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 file path to stat.
15
+ * @param {GcsStatOptions | S3StatOptions} [options] - Optional stat configuration.
16
+ * @returns {Promise<Outcome.Either<GcsStat | S3Stat | FtpStat | SftpStat, string>>}
17
+ * - On success: `Outcome.makeSuccess(stat)` containing file metadata.
18
+ * - On failure: `Outcome.makeFailure(errStr)`.
19
+ */
20
+ export async function statFile(client, path, options) {
21
+ if (isGcsBucket(client))
22
+ return await gcsStat(client, path, options);
23
+ if (isS3ClientWithBucket(client))
24
+ return await s3Stat(client.client, path, client.bucketName, options);
25
+ if (isFtpClient(client))
26
+ return await ftpStat(client, path);
27
+ if (isSftpClient(client))
28
+ return await sftpStat(client, path);
29
+ return Outcome.makeFailure('Invalid client type');
4
30
  }
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/agnostic/errors/unknown-to-string/index.ts
20
- function unknownToString(unk, encoding) {
21
- if (unk instanceof Error) return unk.message;
22
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
23
- if (typeof unk === "string") return unk;
24
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
25
- return `${unk}`;
26
- }
27
-
28
- // src/node/ftps/file/stat/index.ts
29
- async function stat(ftp, path) {
30
- try {
31
- const slash = path.lastIndexOf("/");
32
- const dir = slash === -1 ? "." : path.slice(0, slash) || "/";
33
- const name = slash === -1 ? path : path.slice(slash + 1);
34
- const list = await ftp.list(dir);
35
- const entry = list.find((e) => e.name === name && e.isFile);
36
- if (entry === void 0) return makeFailure(`File not found: ${path}`);
37
- return makeSuccess({
38
- size: entry.size,
39
- modifiedAt: entry.modifiedAt ?? void 0,
40
- permissions: entry.rawModifiedAt.toString(),
41
- raw: entry
42
- });
43
- } catch (err) {
44
- return makeFailure(unknownToString(err));
45
- }
46
- }
47
-
48
- // src/node/sftp/file/stat/index.ts
49
- async function stat2(sftp, path) {
50
- try {
51
- const info = await sftp.stat(path);
52
- return makeSuccess({
53
- size: info.size,
54
- modifiedAt: new Date(info.modifyTime * 1e3),
55
- mode: info.mode,
56
- uid: info.uid,
57
- gid: info.gid,
58
- raw: info
59
- });
60
- } catch (err) {
61
- if (err.code === 2 || err.code === "ENOENT") {
62
- return makeFailure(`File not found: ${path}`);
63
- }
64
- return makeFailure(unknownToString(err));
65
- }
66
- }
67
-
68
- // src/node/@aws-s3/storage/file/stat/index.ts
69
- import {
70
- HeadObjectCommand
71
- } from "@aws-sdk/client-s3";
72
- async function stat3(client, bucket, key, options) {
73
- const { headObjectOptions } = options ?? {};
74
- try {
75
- const res = await client.send(
76
- new HeadObjectCommand({ Bucket: bucket, Key: key, ...headObjectOptions })
77
- );
78
- const stat5 = {
79
- size: res.ContentLength,
80
- modifiedAt: res.LastModified,
81
- checksum: res.ETag?.replace(/"/g, ""),
82
- contentType: res.ContentType,
83
- metadata: res.Metadata,
84
- storageClass: res.StorageClass,
85
- raw: res
86
- };
87
- return makeSuccess(stat5);
88
- } catch (err) {
89
- const notFound = err.$metadata?.httpStatusCode === 404 || err.name === "NotFound";
90
- if (notFound) return makeFailure(`Object not found: ${key}`);
91
- return makeFailure(unknownToString(err));
92
- }
93
- }
94
-
95
- // src/node/@google-cloud/storage/file/stat/index.ts
96
- async function stat4(bucket, path, options) {
97
- const { fileOptions, getMetadataOptions } = options ?? {};
98
- try {
99
- const [meta] = await bucket.file(path, fileOptions).getMetadata(getMetadataOptions);
100
- const res = {
101
- size: meta.size !== void 0 ? Number(meta.size) : void 0,
102
- modifiedAt: meta.updated !== void 0 ? new Date(meta.updated) : void 0,
103
- checksum: meta.md5Hash ?? meta.crc32c,
104
- contentType: meta.contentType,
105
- metadata: meta.metadata,
106
- storageClass: meta.storageClass,
107
- raw: meta
108
- };
109
- return makeSuccess(res);
110
- } catch (err) {
111
- return makeFailure(unknownToString(err));
112
- }
113
- }
114
-
115
- // src/node/cloud-storage/operations/stat-file/index.ts
116
- async function statFile(client, path, options) {
117
- if (isGcsBucket(client)) return await stat4(client, path, options);
118
- if (isS3ClientWithBucket(client)) return await stat3(client.client, path, client.bucketName, options);
119
- if (isFtpClient(client)) return await stat(client, path);
120
- if (isSftpClient(client)) return await stat2(client, path);
121
- return makeFailure("Invalid client type");
122
- }
123
- export {
124
- statFile
125
- };
@@ -1,163 +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 { upload as ftpUpload } from '../../../ftps/file/upload/index.js';
4
+ import { upload as sftpUpload } from '../../../sftp/file/upload/index.js';
5
+ import { upload as s3Upload } from '../../../@aws-s3/storage/file/upload/index.js';
6
+ import { upload as gcsUpload } from '../../../@google-cloud/storage/file/upload/index.js';
7
+ /**
8
+ * Uploads a file stream to 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 {Readable} fileStream - The file content as a stream.
14
+ * @param {string} path - The path to upload the file to.
15
+ * @param {AnyClient} client - The cloud storage client instance.
16
+ * @param {GcsUploadOptions | S3UploadOptions | FtpUploadOptions | SftpUploadOptions} [options] - Optional upload 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 uploadFile(fileStream, path, client, options) {
22
+ if (isGcsBucket(client))
23
+ return await gcsUpload(client, path, fileStream, options);
24
+ if (isS3ClientWithBucket(client))
25
+ return await s3Upload(client.client, client.bucketName, path, fileStream, options);
26
+ if (isFtpClient(client))
27
+ return await ftpUpload(client, path, fileStream, options);
28
+ if (isSftpClient(client))
29
+ return await sftpUpload(client, path, fileStream, 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/agnostic/errors/unknown-to-string/index.ts
20
- function unknownToString(unk, encoding) {
21
- if (unk instanceof Error) return unk.message;
22
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
23
- if (typeof unk === "string") return unk;
24
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
25
- return `${unk}`;
26
- }
27
-
28
- // src/node/ftps/file/upload/index.ts
29
- async function upload(ftpClient, targetPath, fileStream, options) {
30
- const {
31
- ensureDir = true,
32
- overwrite = false
33
- } = options ?? {};
34
- try {
35
- if (ensureDir) {
36
- const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
37
- await ftpClient.ensureDir(dirPath);
38
- }
39
- let fileExists = false;
40
- try {
41
- await ftpClient.size(targetPath);
42
- fileExists = true;
43
- } catch {
44
- fileExists = false;
45
- }
46
- if (fileExists && !overwrite) {
47
- return makeFailure(`File already exists at ${targetPath}.`);
48
- }
49
- await ftpClient.uploadFrom(fileStream, targetPath, options);
50
- return makeSuccess(true);
51
- } catch (err) {
52
- const errStr = unknownToString(err);
53
- return makeFailure(errStr);
54
- }
55
- }
56
-
57
- // src/node/sftp/file/upload/index.ts
58
- async function upload2(sftp, targetPath, fileStream, options) {
59
- const {
60
- ensureDir = true,
61
- overwrite = false
62
- } = options ?? {};
63
- try {
64
- const exists = await sftp.exists(targetPath) !== false;
65
- if (exists && !overwrite) return makeFailure(`File already exists at ${targetPath}.`);
66
- if (ensureDir) {
67
- const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
68
- await sftp.mkdir(dirPath, true);
69
- }
70
- await sftp.put(fileStream, targetPath, options);
71
- return makeSuccess(true);
72
- } catch (err) {
73
- const errStr = unknownToString(err);
74
- return makeFailure(errStr);
75
- }
76
- }
77
-
78
- // src/node/@aws-s3/storage/file/upload/index.ts
79
- import {
80
- HeadObjectCommand
81
- } from "@aws-sdk/client-s3";
82
- import { Upload } from "@aws-sdk/lib-storage";
83
- async function upload3(s3, bucketName, targetPath, fileStream, options) {
84
- const {
85
- uploadSettings,
86
- fileMetadata,
87
- overwrite = false
88
- } = options ?? {};
89
- if (!overwrite) {
90
- try {
91
- const headCommand = new HeadObjectCommand({
92
- Bucket: bucketName,
93
- Key: targetPath
94
- });
95
- await s3.send(headCommand);
96
- return makeFailure(`File already exists at ${targetPath}.`);
97
- } catch (err) {
98
- const code = err?.name ?? err?.$metadata?.httpStatusCode;
99
- if (code !== "NotFound" && code !== 404) {
100
- return makeFailure(unknownToString(err));
101
- }
102
- }
103
- }
104
- const params = {
105
- ...fileMetadata,
106
- Bucket: bucketName,
107
- Key: targetPath,
108
- Body: fileStream
109
- };
110
- try {
111
- const upload5 = new Upload({
112
- client: s3,
113
- params,
114
- ...uploadSettings
115
- });
116
- await upload5.done();
117
- return makeSuccess(true);
118
- } catch (err) {
119
- return makeFailure(unknownToString(err));
120
- }
121
- }
122
-
123
- // src/node/@google-cloud/storage/file/upload/index.ts
124
- async function upload4(bucket, targetPath, fileStream, options) {
125
- const { fileOptions, saveOptions, overwrite = false } = options ?? {};
126
- const file = bucket.file(targetPath, fileOptions);
127
- if (!overwrite) {
128
- try {
129
- const [exists] = await file.exists();
130
- if (exists) {
131
- return makeFailure(`File already exists at ${targetPath}.`);
132
- }
133
- } catch (err) {
134
- const errStr = unknownToString(err);
135
- return makeFailure(errStr);
136
- }
137
- }
138
- try {
139
- await new Promise((resolve, reject) => {
140
- const writeStream = file.createWriteStream(saveOptions);
141
- fileStream.pipe(writeStream);
142
- fileStream.on("error", reject);
143
- writeStream.on("finish", resolve);
144
- writeStream.on("error", reject);
145
- });
146
- return makeSuccess(true);
147
- } catch (err) {
148
- const errStr = unknownToString(err);
149
- return makeFailure(errStr);
150
- }
151
- }
152
-
153
- // src/node/cloud-storage/operations/upload-file/index.ts
154
- async function uploadFile(fileStream, path, client, options) {
155
- if (isGcsBucket(client)) return await upload4(client, path, fileStream, options);
156
- if (isS3ClientWithBucket(client)) return await upload3(client.client, client.bucketName, path, fileStream, options);
157
- if (isFtpClient(client)) return await upload(client, path, fileStream, options);
158
- if (isSftpClient(client)) return await upload2(client, path, fileStream, options);
159
- return makeFailure("Invalid client type");
160
- }
161
- export {
162
- uploadFile
163
- };