@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,74 +1,33 @@
1
- // src/node/encryption/@aes-256-gcm/buffer/index.ts
2
- import { Buffer as Buffer3 } from "node:buffer";
3
-
4
- // src/agnostic/misc/outcome/index.ts
5
- function makeSuccess(payload) {
6
- return { success: true, payload };
1
+ import { Buffer } from 'node:buffer';
2
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
3
+ import { encryptUint8Array, decryptUint8Array } from '../uint8-array/index.js';
4
+ /**
5
+ * Encrypts a `Buffer` by converting it to a `Uint8Array`, performing encryption, and then returning the result as a `Buffer`.
6
+ *
7
+ * @param {Buffer} inputBuffer - The input data to encrypt.
8
+ * @param {string} encryptionKey - The encryption key to use.
9
+ *
10
+ * @returns {Outcome.Either<Buffer, string>} The result of the encryption. Success returns the encrypted data as a `Buffer` (with IV prepended), or failure returns an error message.
11
+ */
12
+ export function encrypt(inputBuffer, encryptionKey) {
13
+ const fileArray = new Uint8Array(inputBuffer);
14
+ const encryptionOutcome = encryptUint8Array(fileArray, encryptionKey);
15
+ if (!encryptionOutcome.success)
16
+ return encryptionOutcome;
17
+ return Outcome.makeSuccess(Buffer.from(encryptionOutcome.payload));
7
18
  }
8
- function makeFailure(error) {
9
- return { success: false, error };
19
+ /**
20
+ * Decrypts an encrypted `Buffer` by converting it to a `Uint8Array`, performing decryption, and then returning the result as a `Buffer`.
21
+ *
22
+ * @param {Buffer} encryptedBuffer - The encrypted data to decrypt.
23
+ * @param {string} encryptionKey - The encryption key to use.
24
+ *
25
+ * @returns {Outcome.Either<Buffer, string>} The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
26
+ */
27
+ export function decrypt(encryptedBuffer, encryptionKey) {
28
+ const encryptedArray = new Uint8Array(encryptedBuffer);
29
+ const decryptionOutcome = decryptUint8Array(encryptedArray, encryptionKey);
30
+ if (!decryptionOutcome.success)
31
+ return decryptionOutcome;
32
+ return Outcome.makeSuccess(Buffer.from(decryptionOutcome.payload));
10
33
  }
11
-
12
- // src/node/encryption/@aes-256-gcm/uint8-array/index.ts
13
- import { Buffer as Buffer2 } from "node:buffer";
14
- import { createCipheriv, createDecipheriv, randomBytes } from "node:crypto";
15
-
16
- // src/agnostic/errors/unknown-to-string/index.ts
17
- function unknownToString(unk, encoding) {
18
- if (unk instanceof Error) return unk.message;
19
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
20
- if (typeof unk === "string") return unk;
21
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
22
- return `${unk}`;
23
- }
24
-
25
- // src/node/encryption/@aes-256-gcm/uint8-array/index.ts
26
- function encryptUint8Array(fileArray, encryptionKey) {
27
- const ivLength = 12;
28
- const keyBuffer = Buffer2.from(encryptionKey, "utf-8");
29
- if (keyBuffer.length !== 32) return makeFailure("Encryption key must be 32 bytes for AES-256-GCM.");
30
- try {
31
- const iv = randomBytes(ivLength);
32
- const cipher = createCipheriv("aes-256-gcm", keyBuffer, iv);
33
- let encrypted = cipher.update(fileArray);
34
- encrypted = Buffer2.concat([encrypted, cipher.final()]);
35
- return makeSuccess(new Uint8Array(Buffer2.concat([iv, encrypted])));
36
- } catch (err) {
37
- const errStr = unknownToString(err);
38
- return makeFailure(errStr);
39
- }
40
- }
41
- function decryptUint8Array(encryptedFile, encryptionKey) {
42
- const ivLength = 12;
43
- const iv = encryptedFile.subarray(0, ivLength);
44
- const keyBuffer = Buffer2.from(encryptionKey, "utf-8");
45
- if (keyBuffer.length !== 32) return makeFailure("Encryption key must be 32 bytes for AES-256-GCM.");
46
- try {
47
- const encryptedData = encryptedFile.subarray(ivLength);
48
- const decipher = createDecipheriv("aes-256-gcm", keyBuffer, iv);
49
- let decrypted = decipher.update(encryptedData);
50
- decrypted = Buffer2.concat([decrypted, decipher.final()]);
51
- return makeSuccess(new Uint8Array(decrypted));
52
- } catch (err) {
53
- const errStr = unknownToString(err);
54
- return makeFailure(errStr);
55
- }
56
- }
57
-
58
- // src/node/encryption/@aes-256-gcm/buffer/index.ts
59
- function encrypt(inputBuffer, encryptionKey) {
60
- const fileArray = new Uint8Array(inputBuffer);
61
- const encryptionOutcome = encryptUint8Array(fileArray, encryptionKey);
62
- if (!encryptionOutcome.success) return encryptionOutcome;
63
- return makeSuccess(Buffer3.from(encryptionOutcome.payload));
64
- }
65
- function decrypt(encryptedBuffer, encryptionKey) {
66
- const encryptedArray = new Uint8Array(encryptedBuffer);
67
- const decryptionOutcome = decryptUint8Array(encryptedArray, encryptionKey);
68
- if (!decryptionOutcome.success) return decryptionOutcome;
69
- return makeSuccess(Buffer3.from(decryptionOutcome.payload));
70
- }
71
- export {
72
- decrypt,
73
- encrypt
74
- };
@@ -1,57 +1,57 @@
1
- // src/node/encryption/@aes-256-gcm/uint8-array/index.ts
2
- import { Buffer as Buffer2 } from "node:buffer";
3
- import { createCipheriv, createDecipheriv, randomBytes } from "node:crypto";
4
-
5
- // src/agnostic/errors/unknown-to-string/index.ts
6
- function unknownToString(unk, encoding) {
7
- if (unk instanceof Error) return unk.message;
8
- if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
9
- if (typeof unk === "string") return unk;
10
- if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
11
- return `${unk}`;
1
+ import { Buffer } from 'node:buffer';
2
+ import { createCipheriv, createDecipheriv, randomBytes } from 'node:crypto';
3
+ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
4
+ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
5
+ /**
6
+ * Encrypts a `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
7
+ *
8
+ * @param {Uint8Array} fileArray - The input data to encrypt.
9
+ * @param {string} encryptionKey - The encryption key to use.
10
+ * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
11
+ *
12
+ * @returns {Outcome.Either<Uint8Array, string>} The result of the encryption. Success returns the encrypted data as a `Uint8Array` (with IV prepended), or failure returns an error message.
13
+ */
14
+ export function encryptUint8Array(fileArray, encryptionKey) {
15
+ const ivLength = 12;
16
+ const keyBuffer = Buffer.from(encryptionKey, 'utf-8');
17
+ if (keyBuffer.length !== 32)
18
+ return Outcome.makeFailure('Encryption key must be 32 bytes for AES-256-GCM.');
19
+ try {
20
+ const iv = randomBytes(ivLength);
21
+ const cipher = createCipheriv('aes-256-gcm', keyBuffer, iv);
22
+ let encrypted = cipher.update(fileArray);
23
+ encrypted = Buffer.concat([encrypted, cipher.final()]);
24
+ return Outcome.makeSuccess(new Uint8Array(Buffer.concat([iv, encrypted])));
25
+ }
26
+ catch (err) {
27
+ const errStr = unknownToString(err);
28
+ return Outcome.makeFailure(errStr);
29
+ }
12
30
  }
13
-
14
- // src/agnostic/misc/outcome/index.ts
15
- function makeSuccess(payload) {
16
- return { success: true, payload };
31
+ /**
32
+ * Decrypts an encrypted `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
33
+ *
34
+ * @param {Uint8Array} encryptedFile - The encrypted data to decrypt.
35
+ * @param {string} encryptionKey - The encryption key to use.
36
+ * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
37
+ *
38
+ * @returns {Outcome.Either<Uint8Array, string>} The result of the decryption. Success returns the decrypted data as a `Uint8Array`, or failure returns an error message.
39
+ */
40
+ export function decryptUint8Array(encryptedFile, encryptionKey) {
41
+ const ivLength = 12;
42
+ const iv = encryptedFile.subarray(0, ivLength);
43
+ const keyBuffer = Buffer.from(encryptionKey, 'utf-8');
44
+ if (keyBuffer.length !== 32)
45
+ return Outcome.makeFailure('Encryption key must be 32 bytes for AES-256-GCM.');
46
+ try {
47
+ const encryptedData = encryptedFile.subarray(ivLength);
48
+ const decipher = createDecipheriv('aes-256-gcm', keyBuffer, iv);
49
+ let decrypted = decipher.update(encryptedData);
50
+ decrypted = Buffer.concat([decrypted, decipher.final()]);
51
+ return Outcome.makeSuccess(new Uint8Array(decrypted));
52
+ }
53
+ catch (err) {
54
+ const errStr = unknownToString(err);
55
+ return Outcome.makeFailure(errStr);
56
+ }
17
57
  }
18
- function makeFailure(error) {
19
- return { success: false, error };
20
- }
21
-
22
- // src/node/encryption/@aes-256-gcm/uint8-array/index.ts
23
- function encryptUint8Array(fileArray, encryptionKey) {
24
- const ivLength = 12;
25
- const keyBuffer = Buffer2.from(encryptionKey, "utf-8");
26
- if (keyBuffer.length !== 32) return makeFailure("Encryption key must be 32 bytes for AES-256-GCM.");
27
- try {
28
- const iv = randomBytes(ivLength);
29
- const cipher = createCipheriv("aes-256-gcm", keyBuffer, iv);
30
- let encrypted = cipher.update(fileArray);
31
- encrypted = Buffer2.concat([encrypted, cipher.final()]);
32
- return makeSuccess(new Uint8Array(Buffer2.concat([iv, encrypted])));
33
- } catch (err) {
34
- const errStr = unknownToString(err);
35
- return makeFailure(errStr);
36
- }
37
- }
38
- function decryptUint8Array(encryptedFile, encryptionKey) {
39
- const ivLength = 12;
40
- const iv = encryptedFile.subarray(0, ivLength);
41
- const keyBuffer = Buffer2.from(encryptionKey, "utf-8");
42
- if (keyBuffer.length !== 32) return makeFailure("Encryption key must be 32 bytes for AES-256-GCM.");
43
- try {
44
- const encryptedData = encryptedFile.subarray(ivLength);
45
- const decipher = createDecipheriv("aes-256-gcm", keyBuffer, iv);
46
- let decrypted = decipher.update(encryptedData);
47
- decrypted = Buffer2.concat([decrypted, decipher.final()]);
48
- return makeSuccess(new Uint8Array(decrypted));
49
- } catch (err) {
50
- const errStr = unknownToString(err);
51
- return makeFailure(errStr);
52
- }
53
- }
54
- export {
55
- decryptUint8Array,
56
- encryptUint8Array
57
- };
@@ -1,13 +1,20 @@
1
- // src/node/encryption/key/index.ts
2
- import { pbkdf2Sync, randomBytes } from "node:crypto";
3
- function generate(passphrase, outputByteLength, options) {
4
- const { saltLength = 16, iterations = 1e5 } = options ?? {};
5
- const salt = randomBytes(saltLength);
6
- const key = pbkdf2Sync(passphrase, salt, iterations, outputByteLength, "sha256");
7
- const saltString = salt.toString("hex");
8
- const keyString = key.toString("hex");
9
- return `${saltString}:${keyString}`;
1
+ import { pbkdf2Sync, randomBytes } from 'node:crypto';
2
+ /**
3
+ * Generates an encryption key from a passphrase using PBKDF2.
4
+ *
5
+ * @param {string} passphrase - The passphrase to derive the key from.
6
+ * @param {number} outputByteLength - The length of the output encryption key in bytes.
7
+ * @param {GenerateOptions} [options] - Optional options.
8
+ * @param {number} [options.saltLength=16] - The length of the salt in bytes. Defaults to 16 bytes.
9
+ * @param {number} [options.iterations=100000] - The number of PBKDF2 iterations. Defaults to 100,000 iterations.
10
+ *
11
+ * @returns {string} The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
12
+ */
13
+ export function generate(passphrase, outputByteLength, options) {
14
+ const { saltLength = 16, iterations = 100000 } = options ?? {};
15
+ const salt = randomBytes(saltLength);
16
+ const key = pbkdf2Sync(passphrase, salt, iterations, outputByteLength, 'sha256');
17
+ const saltString = salt.toString('hex');
18
+ const keyString = key.toString('hex');
19
+ return `${saltString}:${keyString}`;
10
20
  }
11
- export {
12
- generate
13
- };
@@ -1,3 +1,3 @@
1
1
  export * as isInDirectory from './is-in-directory/index.js'
2
- export * as subpaths from './subpaths/index.js'
3
2
  export * as readWrite from './read-write/index.js'
3
+ export * as subpaths from './subpaths/index.js'
@@ -1,3 +1,3 @@
1
1
  export * as isInDirectory from './is-in-directory/index.js'
2
- export * as subpaths from './subpaths/index.js'
3
2
  export * as readWrite from './read-write/index.js'
3
+ export * as subpaths from './subpaths/index.js'
@@ -1,9 +1,12 @@
1
- // src/node/files/is-in-directory/index.ts
2
- import path from "node:path";
3
- function isInDirectory(childPath, parentPath) {
4
- const rel = path.relative(parentPath, childPath);
5
- return rel !== "" && !rel.startsWith("..");
1
+ import path from 'node:path';
2
+ /**
3
+ * Checks whether a child path is contained within a parent directory.
4
+ *
5
+ * @param childPath - The path to check if it's within the parent.
6
+ * @param parentPath - The parent directory path.
7
+ * @returns `true` if `childPath` is within `parentPath`, `false` otherwise.
8
+ */
9
+ export function isInDirectory(childPath, parentPath) {
10
+ const rel = path.relative(parentPath, childPath);
11
+ return rel !== '' && !rel.startsWith('..');
6
12
  }
7
- export {
8
- isInDirectory
9
- };
@@ -1,16 +1,12 @@
1
- // src/node/files/read-write/index.ts
2
- import { promises as fs } from "node:fs";
3
- async function readWrite(path, editor, opts = {}) {
4
- const readData = await fs.readFile(path, opts.readOptions);
5
- const edited = typeof editor === "function" ? editor(readData) : Object.entries(editor).reduce(
6
- (acc, [from, to]) => acc.replaceAll(from, to),
7
- readData.toString()
8
- );
9
- const actualWriteOptions = opts.writeOptions ?? opts.readOptions;
10
- const targetOutput = opts.output ?? path;
11
- if (opts.dryRun !== true) await fs.writeFile(targetOutput, edited, actualWriteOptions);
12
- return edited;
1
+ import { promises as fs } from 'node:fs';
2
+ export async function readWrite(path, editor, opts = {}) {
3
+ const readData = await fs.readFile(path, opts.readOptions);
4
+ const edited = typeof editor === 'function'
5
+ ? editor(readData)
6
+ : Object.entries(editor).reduce((acc, [from, to]) => acc.replaceAll(from, to), readData.toString());
7
+ const actualWriteOptions = opts.writeOptions ?? opts.readOptions;
8
+ const targetOutput = opts.output ?? path;
9
+ if (opts.dryRun !== true)
10
+ await fs.writeFile(targetOutput, edited, actualWriteOptions);
11
+ return edited;
13
12
  }
14
- export {
15
- readWrite
16
- };
@@ -1,130 +1,165 @@
1
- // src/node/files/subpaths/index.ts
2
- import { promises as fs } from "node:fs";
3
- import path from "node:path";
4
-
5
- // src/agnostic/strings/matches/index.ts
6
- function matches(input, matcher) {
7
- if (typeof matcher === "string") return input === matcher;
8
- if (typeof matcher === "function") return matcher(input);
9
- return input.match(matcher) !== null;
10
- }
11
- function matchesSome(input, matchers) {
12
- if (!Array.isArray(matchers)) return matches(input, matchers);
13
- return matchers.some((matcher) => matches(input, matcher));
14
- }
15
-
16
- // src/node/files/subpaths/index.ts
17
- var defaultListContext = {
18
- depth: 0,
19
- lstats: null,
20
- rootPath: null
1
+ /* eslint-disable @typescript-eslint/no-throw-literal */
2
+ import { promises as fs } from 'node:fs';
3
+ import path from 'node:path';
4
+ import { matchesSome as stringMatchesSome } from '../../../agnostic/strings/matches/index.js';
5
+ export const defaultListContext = {
6
+ depth: 0,
7
+ lstats: null,
8
+ rootPath: null
21
9
  };
22
- var fillListContext = (input) => {
23
- return {
24
- ...defaultListContext,
25
- ...input
26
- };
10
+ /**
11
+ * Fills missing properties in a list context with default values.
12
+ *
13
+ * @param {ListContext} input - The partial list context to fill.
14
+ * @returns {Required<ListContext>} A complete list context with all properties set.
15
+ */
16
+ export const fillListContext = (input) => {
17
+ return {
18
+ ...defaultListContext,
19
+ ...input
20
+ };
27
21
  };
28
- var defaultListOptions = {
29
- directories: true,
30
- files: true,
31
- symlinks: true,
32
- hidden: true,
33
- followSimlinks: false,
34
- dedupeSimlinksContents: false,
35
- maxDepth: Infinity,
36
- returnRelative: false,
37
- exclude: null,
38
- include: null,
39
- filter: () => true
22
+ export const defaultListOptions = {
23
+ directories: true,
24
+ files: true,
25
+ symlinks: true,
26
+ hidden: true,
27
+ followSimlinks: false,
28
+ dedupeSimlinksContents: false,
29
+ maxDepth: Infinity,
30
+ returnRelative: false,
31
+ exclude: null,
32
+ include: null,
33
+ filter: () => true
40
34
  };
41
- var fillOptions = (input) => {
42
- return {
43
- ...defaultListOptions,
44
- ...input
45
- };
35
+ /**
36
+ * Fills missing properties in list options with default values.
37
+ *
38
+ * @param {ListOptions} input - The partial list options to fill.
39
+ * @returns {Required<ListOptions>} A complete list options object with all properties set.
40
+ */
41
+ export const fillOptions = (input) => {
42
+ return {
43
+ ...defaultListOptions,
44
+ ...input
45
+ };
46
46
  };
47
- async function list(...args) {
48
- const [inputPath, _options] = args;
49
- const options = fillOptions(_options ?? {});
50
- const subpaths = await listAbsoluteSubpaths(...args);
51
- return options.returnRelative ? subpaths.map((subpath) => path.relative(inputPath, subpath)) : subpaths;
47
+ /**
48
+ * Lists all subpaths under a given directory path.
49
+ *
50
+ * The function recursively traverses the directory tree and returns all matching
51
+ * files, directories, and symlinks based on the provided options.
52
+ *
53
+ * @param inputPath - The root directory path to list subpaths from.
54
+ * @param [options] - Optional configuration for filtering and behavior. See `ListOptions` for details.
55
+ * @returns Array of subpaths (absolute or relative based on `returnRelative` option).
56
+ */
57
+ export async function list(...args) {
58
+ const [inputPath, _options] = args;
59
+ const options = fillOptions(_options ?? {});
60
+ const subpaths = await listAbsoluteSubpaths(...args);
61
+ return options.returnRelative
62
+ ? subpaths.map(subpath => path.relative(inputPath, subpath))
63
+ : subpaths;
52
64
  }
53
- async function listAbsoluteSubpaths(inputPath, _options = {}, __private_context = {}) {
54
- const options = fillOptions(_options);
55
- const _private_context = fillListContext(__private_context);
56
- if (_private_context.rootPath === null) {
57
- _private_context.rootPath = inputPath;
58
- }
59
- const subpaths = [];
60
- if (_private_context.depth > options.maxDepth) return subpaths;
61
- try {
62
- const pathStat = _private_context.lstats ?? await fs.lstat(inputPath);
63
- if (!pathStat.isDirectory()) return subpaths;
64
- } catch (err) {
65
- return subpaths;
66
- }
67
- const childrenRelPaths = await fs.readdir(inputPath);
68
- await Promise.all(childrenRelPaths.map(async (childRelPath) => {
69
- const childAbsPath = path.join(inputPath, childRelPath);
70
- const childRelFromRootPath = path.relative(_private_context.rootPath ?? inputPath, childAbsPath);
71
- const childLstats = await fs.lstat(childAbsPath);
65
+ /**
66
+ * Internal function that lists absolute subpaths recursively.
67
+ *
68
+ * @param {string} inputPath - The directory path to list.
69
+ * @param {ListOptions} [_options] - Optional configuration.
70
+ * @param {ListContext} [__private_context] - Internal recursion context.
71
+ * @returns {Promise<string[]>} Array of absolute subpaths.
72
+ */
73
+ async function listAbsoluteSubpaths(inputPath, _options = {},
74
+ // eslint-disable-next-line @typescript-eslint/naming-convention
75
+ __private_context = {}) {
76
+ const options = fillOptions(_options);
77
+ // eslint-disable-next-line @typescript-eslint/naming-convention
78
+ const _private_context = fillListContext(__private_context);
79
+ if (_private_context.rootPath === null) {
80
+ _private_context.rootPath = inputPath;
81
+ }
82
+ const subpaths = [];
83
+ if (_private_context.depth > options.maxDepth)
84
+ return subpaths;
72
85
  try {
73
- const isDirectory = childLstats.isDirectory();
74
- const isSymlink = childLstats.isSymbolicLink();
75
- const isFile = !isDirectory && !isSymlink;
76
- const isHidden = path.basename(childAbsPath).startsWith(".");
77
- const type = isDirectory ? "directory" : isSymlink ? "symlink" : "file";
78
- if (isDirectory && !options.directories) throw true;
79
- if (isSymlink && !options.symlinks) throw false;
80
- if (isFile && !options.files) throw false;
81
- if (isHidden && !options.hidden) throw false;
82
- const realPath = isSymlink ? await fs.realpath(childAbsPath) : childAbsPath;
83
- const childPathForFilters = options.returnRelative ? childRelFromRootPath : childAbsPath;
84
- const isInExclude = matchesSome(childPathForFilters, options.exclude ?? []);
85
- const isInInclude = matchesSome(childPathForFilters, options.include ?? []);
86
- if (isInExclude && !isInInclude) throw false;
87
- const isInFilter = await options.filter(childPathForFilters, { type, hidden: isHidden, realPath });
88
- if (!isInFilter) throw true;
89
- if (isSymlink) {
90
- if (!options.followSimlinks) subpaths.push(childAbsPath);
91
- else {
92
- const childSubpaths = await listAbsoluteSubpaths(realPath, options, {
93
- ..._private_context,
94
- depth: _private_context.depth + 1
95
- });
96
- subpaths.push(realPath, ...childSubpaths);
86
+ const pathStat = _private_context.lstats ?? await fs.lstat(inputPath);
87
+ if (!pathStat.isDirectory())
88
+ return subpaths;
89
+ }
90
+ catch (err) {
91
+ return subpaths;
92
+ }
93
+ const childrenRelPaths = await fs.readdir(inputPath);
94
+ await Promise.all(childrenRelPaths.map(async (childRelPath) => {
95
+ const childAbsPath = path.join(inputPath, childRelPath);
96
+ const childRelFromRootPath = path.relative(_private_context.rootPath ?? inputPath, childAbsPath);
97
+ const childLstats = await fs.lstat(childAbsPath);
98
+ try {
99
+ const isDirectory = childLstats.isDirectory();
100
+ const isSymlink = childLstats.isSymbolicLink();
101
+ const isFile = !isDirectory && !isSymlink;
102
+ const isHidden = path.basename(childAbsPath).startsWith('.');
103
+ const type = isDirectory ? 'directory' : (isSymlink ? 'symlink' : 'file');
104
+ if (isDirectory && !options.directories)
105
+ throw true;
106
+ if (isSymlink && !options.symlinks)
107
+ throw false;
108
+ if (isFile && !options.files)
109
+ throw false;
110
+ if (isHidden && !options.hidden)
111
+ throw false;
112
+ const realPath = isSymlink
113
+ ? await fs.realpath(childAbsPath)
114
+ : childAbsPath;
115
+ const childPathForFilters = options.returnRelative ? childRelFromRootPath : childAbsPath;
116
+ const isInExclude = stringMatchesSome(childPathForFilters, options.exclude ?? []);
117
+ const isInInclude = stringMatchesSome(childPathForFilters, options.include ?? []);
118
+ if (isInExclude && !isInInclude)
119
+ throw false;
120
+ const isInFilter = await options.filter(childPathForFilters, { type, hidden: isHidden, realPath });
121
+ if (!isInFilter)
122
+ throw true;
123
+ if (isSymlink) {
124
+ if (!options.followSimlinks)
125
+ subpaths.push(childAbsPath);
126
+ else {
127
+ const childSubpaths = await listAbsoluteSubpaths(realPath, options, {
128
+ ..._private_context,
129
+ depth: _private_context.depth + 1
130
+ });
131
+ subpaths.push(realPath, ...childSubpaths);
132
+ }
133
+ }
134
+ else {
135
+ if (isDirectory) {
136
+ const childSubpaths = await listAbsoluteSubpaths(childAbsPath, options, {
137
+ ..._private_context,
138
+ depth: _private_context.depth + 1,
139
+ lstats: childLstats
140
+ });
141
+ subpaths.push(childAbsPath, ...childSubpaths);
142
+ }
143
+ else {
144
+ subpaths.push(childAbsPath);
145
+ }
146
+ }
97
147
  }
98
- } else {
99
- if (isDirectory) {
100
- const childSubpaths = await listAbsoluteSubpaths(childAbsPath, options, {
101
- ..._private_context,
102
- depth: _private_context.depth + 1,
103
- lstats: childLstats
104
- });
105
- subpaths.push(childAbsPath, ...childSubpaths);
106
- } else {
107
- subpaths.push(childAbsPath);
148
+ catch (err) {
149
+ if (typeof err !== 'boolean')
150
+ throw new Error('This try/catch block should only throw booleans');
151
+ const shouldDiveDeeper = err;
152
+ if (!shouldDiveDeeper)
153
+ return [];
154
+ const childSubpaths = await listAbsoluteSubpaths(childAbsPath, options, {
155
+ ..._private_context,
156
+ depth: _private_context.depth + 1,
157
+ lstats: childLstats
158
+ });
159
+ subpaths.push(...childSubpaths);
108
160
  }
109
- }
110
- } catch (err) {
111
- if (typeof err !== "boolean") throw new Error("This try/catch block should only throw booleans");
112
- const shouldDiveDeeper = err;
113
- if (!shouldDiveDeeper) return [];
114
- const childSubpaths = await listAbsoluteSubpaths(childAbsPath, options, {
115
- ..._private_context,
116
- depth: _private_context.depth + 1,
117
- lstats: childLstats
118
- });
119
- subpaths.push(...childSubpaths);
120
- }
121
- }));
122
- return options.dedupeSimlinksContents ? Array.from(new Set(subpaths)) : subpaths;
161
+ }));
162
+ return options.dedupeSimlinksContents
163
+ ? Array.from(new Set(subpaths))
164
+ : subpaths;
123
165
  }
124
- export {
125
- defaultListContext,
126
- defaultListOptions,
127
- fillListContext,
128
- fillOptions,
129
- list
130
- };