@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,30 +1,49 @@
1
- // src/node/process/on-exit/index.ts
2
- var forceExitEvents = ["SIGINT", "SIGTERM", "uncaughtException"];
3
- function beforeForcedExit(callback) {
4
- forceExitEvents.forEach((ev) => process.on(ev, callback));
1
+ /** Events that trigger a forced exit of the process. */
2
+ export const forceExitEvents = ['SIGINT', 'SIGTERM', 'uncaughtException'];
3
+ /**
4
+ * Registers a callback to run before forced exit events (SIGINT, SIGTERM, uncaughtException).
5
+ *
6
+ * @param callback - Function to execute before forced exit. Can be async.
7
+ */
8
+ export function beforeForcedExit(callback) {
9
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
10
+ forceExitEvents.forEach(ev => process.on(ev, callback));
5
11
  }
6
- function beforeExit(callback) {
7
- process.on("beforeExit", callback);
12
+ /**
13
+ * Registers a callback to run before the process exits normally.
14
+ *
15
+ * @param callback - Function to execute before exit. Can be async.
16
+ */
17
+ export function beforeExit(callback) {
18
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
19
+ process.on('beforeExit', callback);
8
20
  }
9
- function onExit(callback) {
10
- process.on("exit", callback);
21
+ /**
22
+ * Registers a callback to run when the process exits.
23
+ *
24
+ * @param callback - Function to execute on exit. Can be async.
25
+ */
26
+ export function onExit(callback) {
27
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
28
+ process.on('exit', callback);
11
29
  }
12
- function onAllExits(callback) {
13
- let alreadyCalled = false;
14
- const actualCallback = () => {
15
- if (!alreadyCalled) {
16
- alreadyCalled = true;
17
- callback();
18
- }
19
- };
20
- beforeForcedExit(actualCallback);
21
- beforeExit(actualCallback);
22
- onExit(actualCallback);
30
+ /**
31
+ * Registers a callback to run on all exit scenarios (forced exit, before exit, and exit).
32
+ *
33
+ * The callback is guaranteed to be called only once, even if multiple exit events occur.
34
+ *
35
+ * @param callback - Function to execute on any exit. Can be async.
36
+ */
37
+ export function onAllExits(callback) {
38
+ let alreadyCalled = false;
39
+ const actualCallback = () => {
40
+ if (!alreadyCalled) {
41
+ alreadyCalled = true;
42
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises, @typescript-eslint/no-floating-promises
43
+ callback();
44
+ }
45
+ };
46
+ beforeForcedExit(actualCallback);
47
+ beforeExit(actualCallback);
48
+ onExit(actualCallback);
23
49
  }
24
- export {
25
- beforeExit,
26
- beforeForcedExit,
27
- forceExitEvents,
28
- onAllExits,
29
- onExit
30
- };
@@ -1,15 +1,30 @@
1
- // src/node/process/prompt-continue/index.ts
2
- import * as inquirer from "@inquirer/prompts";
3
- async function promptContinue(message, throws = false) {
4
- console.log("");
5
- const answer = await inquirer.confirm({
6
- message: message ?? "Continue?",
7
- default: false
8
- });
9
- if (answer) return true;
10
- if (throws) throw new Error("Aborted");
11
- return false;
1
+ import * as inquirer from '@inquirer/prompts';
2
+ /**
3
+ * Prompts the user with a yes/no confirmation in the terminal.
4
+ *
5
+ * @param {string} [message] - The message to display in the prompt. Defaults to "Continue?" if not provided.
6
+ * @param {boolean} [throws=false] - If true, the function will throw an error when the user declines.
7
+ * @returns {Promise<boolean>} - Resolves to `true` if the user confirms, `false` if the user declines and `throws` is false.
8
+ *
9
+ * @throws {Error} - Throws an error with message 'Aborted' if the user declines and `throws` is true.
10
+ *
11
+ * @example
12
+ * const result = await promptContinue('Do you want to proceed?');
13
+ * if (result) {
14
+ * console.log('User confirmed');
15
+ * } else {
16
+ * console.log('User declined');
17
+ * }
18
+ */
19
+ export async function promptContinue(message, throws = false) {
20
+ console.log('');
21
+ const answer = await inquirer.confirm({
22
+ message: message ?? 'Continue?',
23
+ default: false
24
+ });
25
+ if (answer)
26
+ return true;
27
+ if (throws)
28
+ throw new Error('Aborted');
29
+ return false;
12
30
  }
13
- export {
14
- promptContinue
15
- };
@@ -1,137 +1,107 @@
1
- // src/node/process/spawner/index.ts
2
- import {
3
- spawn,
4
- spawnSync
5
- } from "node:child_process";
6
- import ansiRegex from "ansi-regex";
7
- import chalk from "chalk";
8
-
9
- // src/agnostic/misc/outcome/index.ts
10
- function makeSuccess(payload) {
11
- return { success: true, payload };
12
- }
13
- function makeFailure(error) {
14
- return { success: false, error };
15
- }
16
-
17
- // src/agnostic/misc/logs/make-text-block/index.ts
18
- function makeTextBlock(text, vPadding = 1, hPadding = vPadding) {
19
- const lines = text.split("\n");
20
- const longestLine = Math.max(...lines.map((line) => line.length));
21
- const textBlockArr = new Array(lines.length + 2 * vPadding).fill(null).map(() => new Array(longestLine + hPadding * 2).fill(" "));
22
- lines.forEach((line, linePos) => {
23
- const chars = line.split("");
24
- textBlockArr[linePos + vPadding]?.splice(hPadding, chars.length, ...chars);
25
- });
26
- return textBlockArr.map((lineArr) => lineArr.join("")).join("\n");
27
- }
28
-
29
- // src/agnostic/misc/logs/styles/index.ts
30
- var ansi = {
31
- reset: "\x1B[0m",
32
- bold: "\x1B[1m",
33
- italic: "\x1B[3m",
34
- underline: "\x1B[4m",
35
- fg: {
36
- red: "\x1B[31m",
37
- green: "\x1B[32m",
38
- yellow: "\x1B[33m",
39
- blue: "\x1B[34m",
40
- gray: "\x1B[90m",
41
- whiteBright: "\x1B[97m"
42
- },
43
- bg: {
44
- red: "\x1B[41m"
45
- }
46
- };
47
- var wrap = (...ansiCodes) => (text) => `${ansiCodes.join("")}${text}${ansi.reset}`;
48
- var styles = {
49
- regular: (text) => text,
50
- light: wrap(ansi.fg.gray),
51
- danger: (text) => wrap(ansi.bold, ansi.bg.red, ansi.fg.whiteBright)(makeTextBlock(`/!\\
52
-
53
- ${text}
54
- `, 2, 6)),
55
- important: wrap(ansi.bold),
56
- title: (text) => `# ${wrap(ansi.bold, ansi.underline)(`${text}
57
- `)}`,
58
- info: wrap(ansi.fg.blue),
59
- success: wrap(ansi.fg.green),
60
- error: wrap(ansi.fg.red),
61
- warning: wrap(ansi.fg.yellow),
62
- italic: wrap(ansi.italic)
63
- };
64
-
65
- // src/agnostic/errors/unknown-to-string/index.ts
66
- function unknownToString(unk, encoding) {
67
- if (unk instanceof Error) return unk.message;
68
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
69
- if (typeof unk === "string") return unk;
70
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
71
- return `${unk}`;
72
- }
73
-
74
- // src/node/process/spawner/index.ts
75
- async function spawner(label, command, args, options) {
76
- return await new Promise((resolve, reject) => {
77
- if (label !== null) console.log("\n" + styles.info(label) + "\n");
78
- const printableArgs = options?.argsPrintFormat !== void 0 ? options.argsPrintFormat(args) : args;
79
- console.log(styles.light(`> ${command} ${printableArgs.join(" ")}
80
- `));
81
- const prcss = spawn(command, args, { stdio: "pipe", ...options });
82
- let stdout = "";
83
- let stderr = "";
84
- let err = null;
85
- prcss.stdout?.on("data", (data) => {
86
- const strData = unknownToString(data);
87
- stdout += strData;
88
- console.log(styles.light(strData.replace(ansiRegex(), "").trim()));
89
- });
90
- prcss.stderr?.on("data", (data) => {
91
- const strData = unknownToString(data);
92
- stderr += strData;
93
- console.log(styles.warning(strData.replace(ansiRegex(), "").trim()));
94
- });
95
- prcss.on("error", (e) => {
96
- err = e;
97
- console.log(styles.error(unknownToString(err).replace(ansiRegex(), "").trim()));
98
- });
99
- prcss.on("close", (code) => {
100
- if (code !== 0 && options?.throwOnError === true) reject(new Error(stderr + "\n" + stdout));
101
- else if (code !== 0) return resolve(makeFailure({ stdout, stderr, err }));
102
- else return resolve(makeSuccess({ stdout, stderr, err }));
1
+ import { spawn, spawnSync } from 'node:child_process';
2
+ import ansiRegex from 'ansi-regex';
3
+ import chalk from 'chalk';
4
+ import * as Outcome from '../../../agnostic/misc/outcome/index.js';
5
+ import { styles } from '../../../agnostic/misc/logs/styles/index.js';
6
+ import { unknownToString } from '../../../agnostic/errors/unknown-to-string/index.js';
7
+ /**
8
+ * Spawns a child process asynchronously and logs its execution and output.
9
+ *
10
+ * Stdout and stderr are streamed, logged in real time, and collected.
11
+ * The result is returned as an `Outcome.Either`, representing success or failure.
12
+ *
13
+ * @param label - Optional label printed before execution to visually group logs.
14
+ * @param command - The command to execute.
15
+ * @param args - Arguments passed to the command.
16
+ * @param options - Optional spawn configuration and utility-specific options:
17
+ * - `argsPrintFormat`: Function to format arguments for logging.
18
+ * - `throwOnError`: If `true`, rejects on non-zero exit code instead of resolving a failure.
19
+ * @returns A promise resolving to an `Outcome.Either`:
20
+ * - success: `{ stdout, stderr, err }` when the command exits with code `0`
21
+ * - failure: `{ stdout, stderr, err }` when the command exits with a non-zero code
22
+ */
23
+ export async function spawner(label, command, args, options) {
24
+ return await new Promise((resolve, reject) => {
25
+ if (label !== null)
26
+ console.log('\n' + styles.info(label) + '\n');
27
+ const printableArgs = options?.argsPrintFormat !== undefined
28
+ ? options.argsPrintFormat(args)
29
+ : args;
30
+ console.log(styles.light(`> ${command} ${printableArgs.join(' ')}\n`));
31
+ const prcss = spawn(command, args, { stdio: 'pipe', ...options });
32
+ let stdout = '';
33
+ let stderr = '';
34
+ let err = null;
35
+ prcss.stdout?.on('data', data => {
36
+ const strData = unknownToString(data);
37
+ stdout += strData;
38
+ console.log(styles.light(strData.replace(ansiRegex(), '').trim()));
39
+ });
40
+ prcss.stderr?.on('data', data => {
41
+ const strData = unknownToString(data);
42
+ stderr += strData;
43
+ console.log(styles.warning(strData.replace(ansiRegex(), '').trim()));
44
+ });
45
+ prcss.on('error', e => {
46
+ err = e;
47
+ console.log(styles.error(unknownToString(err).replace(ansiRegex(), '').trim()));
48
+ });
49
+ prcss.on('close', code => {
50
+ if (code !== 0 && options?.throwOnError === true)
51
+ reject(new Error(stderr + '\n' + stdout));
52
+ else if (code !== 0)
53
+ return resolve(Outcome.makeFailure({ stdout, stderr, err }));
54
+ else
55
+ return resolve(Outcome.makeSuccess({ stdout, stderr, err }));
56
+ });
103
57
  });
104
- });
105
58
  }
106
- function spawnerSync(label, command, args, options) {
107
- if (label !== null) console.log("\n" + styles.info(label) + "\n");
108
- const printableArgs = options?.argsPrintFormat !== void 0 ? options.argsPrintFormat(args) : args;
109
- console.log(styles.light(`> ${command} ${printableArgs.join(" ")}
110
- `));
111
- const result = spawnSync(command, args, { stdio: "pipe", encoding: "utf8", ...options });
112
- const stderr = result.stderr?.toString().trim();
113
- const stdout = result.stdout?.toString().trim();
114
- const err = result.error;
115
- if (err !== void 0) {
116
- console.log(styles.light(chalk.italic("err:\n")));
117
- console.log(styles.error(unknownToString(err).replace(ansiRegex(), "")));
118
- console.log("");
119
- }
120
- if (stderr !== "") {
121
- console.log(styles.light(chalk.italic("stderr:\n")));
122
- console.log(styles.warning(stderr.replace(ansiRegex(), "")));
123
- console.log("");
124
- }
125
- if (stdout !== "") {
126
- console.log(styles.light(chalk.italic("stdout:\n")));
127
- console.log(styles.light(stdout.replace(ansiRegex(), "")));
128
- console.log("");
129
- }
130
- if (result.status !== 0 && options?.throwOnError === true) throw new Error(stderr + "\n" + stdout);
131
- else if (result.status !== 0) return makeFailure({ stdout, stderr, err });
132
- return makeSuccess({ stdout, stderr, err });
59
+ /**
60
+ * Spawns a child process synchronously and logs its execution and output.
61
+ *
62
+ * Stdout, stderr, and execution errors are logged after the process completes.
63
+ * The result is returned as an `Outcome.Either`, representing success or failure.
64
+ *
65
+ * @param label - Optional label printed before execution to visually group logs.
66
+ * @param command - The command to execute.
67
+ * @param args - Arguments passed to the command.
68
+ * @param options - Optional spawn configuration and utility-specific options:
69
+ * - `argsPrintFormat`: Function to format arguments for logging.
70
+ * - `throwOnError`: If `true`, throws on non-zero exit code instead of returning a failure.
71
+ * @returns An `Outcome.Either`:
72
+ * - success: `{ stdout, stderr, err }` when the command exits with code `0`
73
+ * - failure: `{ stdout, stderr, err }` when the command exits with a non-zero code
74
+ * @throws Error if `throwOnError` is `true` and the process exits with a non-zero status
75
+ */
76
+ export function spawnerSync(label, command, args, options) {
77
+ if (label !== null)
78
+ console.log('\n' + styles.info(label) + '\n');
79
+ const printableArgs = options?.argsPrintFormat !== undefined
80
+ ? options.argsPrintFormat(args)
81
+ : args;
82
+ console.log(styles.light(`> ${command} ${printableArgs.join(' ')}\n`));
83
+ const result = spawnSync(command, args, { stdio: 'pipe', encoding: 'utf8', ...options });
84
+ const stderr = result.stderr?.toString().trim();
85
+ const stdout = result.stdout?.toString().trim();
86
+ const err = result.error;
87
+ if (err !== undefined) {
88
+ console.log(styles.light(chalk.italic('err:\n')));
89
+ console.log(styles.error(unknownToString(err).replace(ansiRegex(), '')));
90
+ console.log('');
91
+ }
92
+ if (stderr !== '') {
93
+ console.log(styles.light(chalk.italic('stderr:\n')));
94
+ console.log(styles.warning(stderr.replace(ansiRegex(), '')));
95
+ console.log('');
96
+ }
97
+ if (stdout !== '') {
98
+ console.log(styles.light(chalk.italic('stdout:\n')));
99
+ console.log(styles.light(stdout.replace(ansiRegex(), '')));
100
+ console.log('');
101
+ }
102
+ if (result.status !== 0 && options?.throwOnError === true)
103
+ throw new Error(stderr + '\n' + stdout);
104
+ else if (result.status !== 0)
105
+ return Outcome.makeFailure({ stdout, stderr, err });
106
+ return Outcome.makeSuccess({ stdout, stderr, err });
133
107
  }
134
- export {
135
- spawner,
136
- spawnerSync
137
- };
@@ -1,63 +1,55 @@
1
- // src/node/sftp/directory/copy-dir/index.ts
2
- import { PassThrough } from "node:stream";
3
-
4
- // src/agnostic/misc/outcome/index.ts
5
- function makeSuccess(payload) {
6
- return { success: true, payload };
7
- }
8
- function makeFailure(error) {
9
- return { success: false, error };
10
- }
11
-
12
- // src/agnostic/errors/unknown-to-string/index.ts
13
- function unknownToString(unk, encoding) {
14
- if (unk instanceof Error) return unk.message;
15
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
16
- if (typeof unk === "string") return unk;
17
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
18
- return `${unk}`;
19
- }
20
-
21
- // src/node/sftp/directory/copy-dir/index.ts
22
- async function copyDir(sftp, sourceDir, targetDir, options) {
23
- const {
24
- overwrite = false,
25
- ensureDir = true,
26
- ...transferOptions
27
- } = options ?? {};
28
- async function recurse(dir) {
29
- const list = await sftp.list(dir);
30
- for (const entry of list) {
31
- const src = dir.endsWith("/") ? dir + entry.name : dir + "/" + entry.name;
32
- const rel = src.substring(sourceDir.length + (sourceDir.endsWith("/") ? 0 : 1));
33
- const dst = targetDir.endsWith("/") ? targetDir + rel : `${targetDir}/${rel}`;
34
- if (entry.type === "d") {
35
- if (ensureDir) await sftp.mkdir(dst, true);
36
- await recurse(src);
37
- } else if (entry.type === "-") {
38
- if (!overwrite) {
39
- const exists = await sftp.exists(dst);
40
- if (exists !== false) throw new Error(`File already exists at ${dst}.`);
1
+ import { PassThrough } from 'node:stream';
2
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
3
+ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
4
+ /**
5
+ * Recursively copies every file under `sourceDir` to the same relative path
6
+ * beneath `targetDir` on an SFTP server, streaming data to minimize memory usage.
7
+ *
8
+ * @param {Client} sftp - The SFTP client instance.
9
+ * @param {string} sourceDir - The source directory path to copy from.
10
+ * @param {string} targetDir - The target directory path to copy to.
11
+ * @param {CopyDirOptions} [options] - Optional parameters for the operation.
12
+ * @returns {Promise<Outcome.Either<true, string>>}
13
+ * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
14
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
15
+ */
16
+ export async function copyDir(sftp, sourceDir, targetDir, options) {
17
+ const { overwrite = false, ensureDir = true, ...transferOptions } = options ?? {};
18
+ async function recurse(dir) {
19
+ const list = await sftp.list(dir);
20
+ for (const entry of list) {
21
+ const src = dir.endsWith('/') ? dir + entry.name : dir + '/' + entry.name;
22
+ const rel = src.substring(sourceDir.length + (sourceDir.endsWith('/') ? 0 : 1));
23
+ const dst = targetDir.endsWith('/') ? targetDir + rel : `${targetDir}/${rel}`;
24
+ if (entry.type === 'd') {
25
+ if (ensureDir)
26
+ await sftp.mkdir(dst, true);
27
+ await recurse(src);
28
+ }
29
+ else if (entry.type === '-') {
30
+ if (!overwrite) {
31
+ const exists = await sftp.exists(dst);
32
+ if (exists !== false)
33
+ throw new Error(`File already exists at ${dst}.`);
34
+ }
35
+ if (ensureDir) {
36
+ const dirPath = dst.substring(0, dst.lastIndexOf('/'));
37
+ await sftp.mkdir(dirPath, true);
38
+ }
39
+ const pass = new PassThrough();
40
+ const upload = sftp.put(pass, dst, transferOptions);
41
+ await sftp.get(src, pass, transferOptions);
42
+ await upload;
43
+ }
41
44
  }
42
- if (ensureDir) {
43
- const dirPath = dst.substring(0, dst.lastIndexOf("/"));
44
- await sftp.mkdir(dirPath, true);
45
- }
46
- const pass = new PassThrough();
47
- const upload = sftp.put(pass, dst, transferOptions);
48
- await sftp.get(src, pass, transferOptions);
49
- await upload;
50
- }
51
45
  }
52
- }
53
- try {
54
- if (ensureDir) await sftp.mkdir(targetDir, true);
55
- await recurse(sourceDir);
56
- return makeSuccess(true);
57
- } catch (err) {
58
- return makeFailure(unknownToString(err));
59
- }
46
+ try {
47
+ if (ensureDir)
48
+ await sftp.mkdir(targetDir, true);
49
+ await recurse(sourceDir);
50
+ return Outcome.makeSuccess(true);
51
+ }
52
+ catch (err) {
53
+ return Outcome.makeFailure(unknownToString(err));
54
+ }
60
55
  }
61
- export {
62
- copyDir
63
- };
@@ -1,4 +1,4 @@
1
1
  export * as copyDir from './copy-dir/index.js'
2
2
  export * as list from './list/index.js'
3
- export * as removeDir from './remove-dir/index.js'
4
3
  export * as moveDir from './move-dir/index.js'
4
+ export * as removeDir from './remove-dir/index.js'
@@ -1,4 +1,4 @@
1
1
  export * as copyDir from './copy-dir/index.js'
2
2
  export * as list from './list/index.js'
3
- export * as removeDir from './remove-dir/index.js'
4
3
  export * as moveDir from './move-dir/index.js'
4
+ export * as removeDir from './remove-dir/index.js'
@@ -1,30 +1,23 @@
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 { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
3
+ /**
4
+ * Lists all direct children files under a given directory on an SFTP server.
5
+ *
6
+ * This function returns only the immediate files (not recursive) under the specified directory.
7
+ *
8
+ * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
9
+ * @param {string} directoryPath - The directory path to list files under.
10
+ * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
11
+ */
12
+ export async function list(sftp, directoryPath) {
13
+ try {
14
+ const list = await sftp.list(directoryPath);
15
+ const files = list
16
+ .filter(entry => entry.type === '-')
17
+ .map(entry => (directoryPath.endsWith('/') ? directoryPath + entry.name : directoryPath + '/' + entry.name));
18
+ return Outcome.makeSuccess(files);
19
+ }
20
+ catch (err) {
21
+ return Outcome.makeFailure(unknownToString(err));
22
+ }
4
23
  }
5
- function makeFailure(error) {
6
- return { success: false, error };
7
- }
8
-
9
- // src/agnostic/errors/unknown-to-string/index.ts
10
- function unknownToString(unk, encoding) {
11
- if (unk instanceof Error) return unk.message;
12
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
13
- if (typeof unk === "string") return unk;
14
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
15
- return `${unk}`;
16
- }
17
-
18
- // src/node/sftp/directory/list/index.ts
19
- async function list(sftp, directoryPath) {
20
- try {
21
- const list2 = await sftp.list(directoryPath);
22
- const files = list2.filter((entry) => entry.type === "-").map((entry) => directoryPath.endsWith("/") ? directoryPath + entry.name : directoryPath + "/" + entry.name);
23
- return makeSuccess(files);
24
- } catch (err) {
25
- return makeFailure(unknownToString(err));
26
- }
27
- }
28
- export {
29
- list
30
- };
@@ -1,38 +1,38 @@
1
- // src/agnostic/misc/outcome/index.ts
2
- function makeSuccess(payload) {
3
- return { success: true, payload };
4
- }
5
- function makeFailure(error) {
6
- return { success: false, error };
7
- }
8
-
9
- // src/agnostic/errors/unknown-to-string/index.ts
10
- function unknownToString(unk, encoding) {
11
- if (unk instanceof Error) return unk.message;
12
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
13
- if (typeof unk === "string") return unk;
14
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
15
- return `${unk}`;
16
- }
17
-
18
- // src/node/sftp/directory/move-dir/index.ts
19
- async function moveDir(sftp, sourceDir, targetDir, options) {
20
- const { overwrite = false, ensureDir = true } = options ?? {};
21
- try {
22
- if (ensureDir) {
23
- const parentDir = targetDir.substring(0, targetDir.lastIndexOf("/"));
24
- await sftp.mkdir(parentDir, true);
1
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
2
+ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
3
+ /**
4
+ * Renames (moves) a directory on an SFTP server using `rename`, which moves
5
+ * the entire tree in one operation when supported by the server.
6
+ *
7
+ * If `ensureDir` is true (default), the parent directory of `targetDir` is
8
+ * created if it does not exist.
9
+ *
10
+ * @param {Client} sftp - The SFTP client instance.
11
+ * @param {string} sourceDir - The source directory path to move from.
12
+ * @param {string} targetDir - The target directory path to move to.
13
+ * @param {MoveDirOptions} [options] - Optional parameters for the operation.
14
+ * @param {boolean} [options.overwrite=false] - If false and `targetDir` exists, abort.
15
+ * @param {boolean} [options.ensureDir=true] - Whether to create the parent directory of `targetDir`.
16
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
17
+ * - On success: `Outcome.makeSuccess(true)` indicating the move was successful.
18
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the move fails.
19
+ */
20
+ export async function moveDir(sftp, sourceDir, targetDir, options) {
21
+ const { overwrite = false, ensureDir = true } = options ?? {};
22
+ try {
23
+ if (ensureDir) {
24
+ const parentDir = targetDir.substring(0, targetDir.lastIndexOf('/'));
25
+ await sftp.mkdir(parentDir, true);
26
+ }
27
+ if (!overwrite) {
28
+ const exists = await sftp.exists(targetDir);
29
+ if (exists !== false)
30
+ return Outcome.makeFailure(`Target ${targetDir} already exists.`);
31
+ }
32
+ await sftp.rename(sourceDir, targetDir);
33
+ return Outcome.makeSuccess(true);
25
34
  }
26
- if (!overwrite) {
27
- const exists = await sftp.exists(targetDir);
28
- if (exists !== false) return makeFailure(`Target ${targetDir} already exists.`);
35
+ catch (err) {
36
+ return Outcome.makeFailure(unknownToString(err));
29
37
  }
30
- await sftp.rename(sourceDir, targetDir);
31
- return makeSuccess(true);
32
- } catch (err) {
33
- return makeFailure(unknownToString(err));
34
- }
35
38
  }
36
- export {
37
- moveDir
38
- };