@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.
- package/TODO.md +269 -0
- package/agnostic/arrays/dedupe/index.js +9 -7
- package/agnostic/arrays/dedupe/index.test.js +24 -0
- package/agnostic/arrays/find-duplicates/index.js +34 -22
- package/agnostic/arrays/find-duplicates/index.test.js +31 -0
- package/agnostic/arrays/index.d.ts +2 -2
- package/agnostic/arrays/index.js +2 -2
- package/agnostic/arrays/is-array-of/index.js +28 -26
- package/agnostic/arrays/is-array-of/index.test.js +56 -0
- package/agnostic/arrays/make/index.js +11 -6
- package/agnostic/arrays/make/index.test.js +10 -0
- package/agnostic/arrays/random-pick/index.js +38 -22
- package/agnostic/arrays/random-pick/index.test.js +23 -0
- package/agnostic/arrays/shuffle/index.js +15 -11
- package/agnostic/arrays/shuffle/index.test.js +14 -0
- package/agnostic/booleans/is-falsy/index.js +24 -15
- package/agnostic/booleans/is-falsy/index.test.js +26 -0
- package/agnostic/colors/channels/index.js +139 -936
- package/agnostic/colors/channels/index.test.js +64 -0
- package/agnostic/colors/contrast/index.js +24 -643
- package/agnostic/colors/contrast/index.test.js +21 -0
- package/agnostic/colors/convert/index.js +811 -837
- package/agnostic/colors/convert/index.test.js +98 -0
- package/agnostic/colors/cssColorsMap.js +153 -0
- package/agnostic/colors/distance/index.js +66 -538
- package/agnostic/colors/distance/index.test.js +21 -0
- package/agnostic/colors/grayscale/index.js +95 -872
- package/agnostic/colors/grayscale/index.test.js +34 -0
- package/agnostic/colors/index.d.ts +2 -2
- package/agnostic/colors/index.js +2 -2
- package/agnostic/colors/invert/index.js +34 -719
- package/agnostic/colors/invert/index.test.js +31 -0
- package/agnostic/colors/lerp/index.js +75 -804
- package/agnostic/colors/lerp/index.test.js +55 -0
- package/agnostic/colors/luminance/index.js +17 -625
- package/agnostic/colors/luminance/index.test.js +30 -0
- package/agnostic/colors/palette/index.js +83 -917
- package/agnostic/colors/palette/index.test.js +35 -0
- package/agnostic/colors/rotate/index.js +35 -835
- package/agnostic/colors/rotate/index.test.js +45 -0
- package/agnostic/colors/tidy/index.js +79 -530
- package/agnostic/colors/tidy/index.test.js +45 -0
- package/agnostic/colors/typechecks/index.js +188 -250
- package/agnostic/colors/typechecks/index.test.js +113 -0
- package/agnostic/colors/types.js +1 -0
- package/agnostic/css/bem/index.js +134 -171
- package/agnostic/css/clss/index.js +64 -29
- package/agnostic/css/clss/index.test.js +60 -0
- package/agnostic/css/generate-nice-color/index.js +26 -71
- package/agnostic/css/generate-nice-color/index.test.js +8 -0
- package/agnostic/css/index.d.ts +2 -2
- package/agnostic/css/index.js +2 -2
- package/agnostic/css/is-valid-css-class-name/index.js +14 -8
- package/agnostic/css/is-valid-css-class-name/index.test.js +36 -0
- package/agnostic/css/scale/index.js +37 -50
- package/agnostic/css/scale/index.test.js +71 -0
- package/agnostic/css/styles-set/index.js +151 -178
- package/agnostic/errors/index.d.ts +1 -1
- package/agnostic/errors/index.js +1 -1
- package/agnostic/errors/register/index.js +45 -49
- package/agnostic/errors/unknown-to-string/index.js +17 -10
- package/agnostic/errors/unknown-to-string/index.test.js +35 -0
- package/agnostic/html/get-node-ancestors/index.js +29 -29
- package/agnostic/html/get-node-ancestors/index.test.js +58 -0
- package/agnostic/html/get-position-inside-parent/index.js +13 -8
- package/agnostic/html/get-position-inside-parent/index.test.js +56 -0
- package/agnostic/html/hyper-json/cast/index.js +128 -2931
- package/agnostic/html/hyper-json/index.js +23 -2954
- package/agnostic/html/hyper-json/method/index.js +10 -14
- package/agnostic/html/hyper-json/serialize/index.js +88 -222
- package/agnostic/html/hyper-json/smart-tags/coalesced/add/index.js +14 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/addclass/index.js +27 -2937
- package/agnostic/html/hyper-json/smart-tags/coalesced/and/index.js +13 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/append/index.js +34 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/at/index.js +42 -2935
- package/agnostic/html/hyper-json/smart-tags/coalesced/call/index.js +47 -2937
- package/agnostic/html/hyper-json/smart-tags/coalesced/clone/index.js +10 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/deleteproperties/index.js +45 -2936
- package/agnostic/html/hyper-json/smart-tags/coalesced/equals/index.js +22 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/getattribute/index.js +26 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/getproperties/index.js +19 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/getproperty/index.js +67 -2935
- package/agnostic/html/hyper-json/smart-tags/coalesced/hjparse/index.js +21 -2937
- package/agnostic/html/hyper-json/smart-tags/coalesced/hjstringify/index.js +89 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/if/index.js +20 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/index.d.ts +18 -18
- package/agnostic/html/hyper-json/smart-tags/coalesced/index.js +18 -18
- package/agnostic/html/hyper-json/smart-tags/coalesced/initialize/index.js +37 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/join/index.js +16 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/length/index.js +21 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/map/index.js +31 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/negate/index.js +10 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/notrailing/index.js +33 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/or/index.js +13 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/pickrandom/index.js +17 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/populate/index.js +59 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/print/index.js +23 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/push/index.js +10 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/pusheach/index.js +26 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/recordtoarray/index.js +10 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/removeattribute/index.js +53 -2935
- package/agnostic/html/hyper-json/smart-tags/coalesced/removeclass/index.js +27 -2937
- package/agnostic/html/hyper-json/smart-tags/coalesced/renameproperty/index.js +31 -2937
- package/agnostic/html/hyper-json/smart-tags/coalesced/replace/index.js +55 -2940
- package/agnostic/html/hyper-json/smart-tags/coalesced/select/index.js +29 -2935
- package/agnostic/html/hyper-json/smart-tags/coalesced/set/index.js +29 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/setattribute/index.js +53 -2935
- package/agnostic/html/hyper-json/smart-tags/coalesced/setproperty/index.js +232 -2936
- package/agnostic/html/hyper-json/smart-tags/coalesced/sorton/index.js +89 -2936
- package/agnostic/html/hyper-json/smart-tags/coalesced/split/index.js +20 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/spread/index.js +23 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/toarray/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/toboolean/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/toelement/index.js +17 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/toggleclass/index.js +27 -2937
- package/agnostic/html/hyper-json/smart-tags/coalesced/tonodelist/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/tonull/index.js +10 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/tonumber/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/torecord/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/toref/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/tostring/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/totext/index.js +11 -2939
- package/agnostic/html/hyper-json/smart-tags/coalesced/transformselected/index.js +84 -2938
- package/agnostic/html/hyper-json/smart-tags/coalesced/trim/index.js +14 -2938
- package/agnostic/html/hyper-json/smart-tags/index.js +28 -181
- package/agnostic/html/hyper-json/smart-tags/isolated/any/index.js +12 -195
- package/agnostic/html/hyper-json/smart-tags/isolated/array/index.js +12 -195
- package/agnostic/html/hyper-json/smart-tags/isolated/boolean/index.js +12 -2939
- package/agnostic/html/hyper-json/smart-tags/isolated/element/index.js +24 -2938
- package/agnostic/html/hyper-json/smart-tags/isolated/get/index.js +18 -2938
- package/agnostic/html/hyper-json/smart-tags/isolated/guess/index.js +56 -2937
- package/agnostic/html/hyper-json/smart-tags/isolated/index.d.ts +1 -1
- package/agnostic/html/hyper-json/smart-tags/isolated/index.js +1 -1
- package/agnostic/html/hyper-json/smart-tags/isolated/nodelist/index.js +18 -2938
- package/agnostic/html/hyper-json/smart-tags/isolated/null/index.js +9 -193
- package/agnostic/html/hyper-json/smart-tags/isolated/number/index.js +16 -2938
- package/agnostic/html/hyper-json/smart-tags/isolated/record/index.js +12 -2938
- package/agnostic/html/hyper-json/smart-tags/isolated/ref/index.js +40 -2935
- package/agnostic/html/hyper-json/smart-tags/isolated/string/index.js +16 -2938
- package/agnostic/html/hyper-json/smart-tags/isolated/text/index.js +18 -2938
- package/agnostic/html/hyper-json/transformer/index.js +112 -148
- package/agnostic/html/hyper-json/tree/index.js +411 -2928
- package/agnostic/html/hyper-json/types/index.js +27 -18
- package/agnostic/html/hyper-json/utils/index.js +497 -2921
- package/agnostic/html/index.d.ts +2 -2
- package/agnostic/html/index.js +2 -2
- package/agnostic/html/insert-node/index.js +27 -16
- package/agnostic/html/insert-node/index.test.js +73 -0
- package/agnostic/html/placeholders/index.js +26 -29
- package/agnostic/html/replace-in-element/index.js +31 -48
- package/agnostic/html/replace-in-element/index.test.js +80 -0
- package/agnostic/html/selector-to-element/index.js +53 -39
- package/agnostic/html/selector-to-element/index.test.js +69 -0
- package/agnostic/html/string-to-nodes/index.js +24 -25
- package/agnostic/html/string-to-nodes/index.test.js +54 -0
- package/agnostic/index.d.ts +6 -6
- package/agnostic/index.js +6 -6
- package/agnostic/misc/assert/index.js +60 -66
- package/agnostic/misc/cast/index.js +123 -57
- package/agnostic/misc/cast/index.test.js +134 -0
- package/agnostic/misc/connection/index.js +55 -36
- package/agnostic/misc/connection/index.test.js +143 -0
- package/agnostic/misc/crawler/index.js +68 -46
- package/agnostic/misc/crawler/index.test.js +56 -0
- package/agnostic/misc/crossenv/detect-runtime/index.js +41 -13
- package/agnostic/misc/crossenv/detect-runtime/index.test.js +24 -0
- package/agnostic/misc/crossenv/types.js +21 -14
- package/agnostic/misc/crossenv/window/index.js +45 -24
- package/agnostic/misc/crossenv/window/index.test.js +24 -0
- package/agnostic/misc/data-size/index.js +182 -294
- package/agnostic/misc/data-size/index.test.js +100 -0
- package/agnostic/misc/data-size/types.js +1 -0
- package/agnostic/misc/index.d.ts +5 -5
- package/agnostic/misc/index.js +5 -5
- package/agnostic/misc/is-constructor-function/index.js +12 -6
- package/agnostic/misc/is-constructor-function/index.test.js +36 -0
- package/agnostic/misc/is-nullish/index.js +24 -11
- package/agnostic/misc/is-nullish/index.test.js +44 -0
- package/agnostic/misc/logs/logger/index.js +115 -140
- package/agnostic/misc/logs/make-text-block/index.js +13 -13
- package/agnostic/misc/logs/styles/index.js +29 -48
- package/agnostic/misc/lorem-ipsum/index.js +51 -201
- package/agnostic/misc/lorem-ipsum/index.test.js +49 -0
- package/agnostic/misc/normalize-extension/index.js +99 -88
- package/agnostic/misc/normalize-extension/index.test.js +40 -0
- package/agnostic/misc/outcome/index.js +20 -14
- package/agnostic/misc/outcome/index.test.js +40 -0
- package/agnostic/numbers/absolute-modulo/index.js +9 -6
- package/agnostic/numbers/absolute-modulo/index.test.js +23 -0
- package/agnostic/numbers/approximate-rational/index.js +86 -69
- package/agnostic/numbers/approximate-rational/index.test.js +90 -0
- package/agnostic/numbers/clamp/index.js +12 -8
- package/agnostic/numbers/clamp/index.test.js +24 -0
- package/agnostic/numbers/geometric-progressions/index.js +25 -16
- package/agnostic/numbers/geometric-progressions/index.test.js +45 -0
- package/agnostic/numbers/index.d.ts +2 -2
- package/agnostic/numbers/index.js +2 -2
- package/agnostic/numbers/interpolate/index.js +25 -10
- package/agnostic/numbers/interpolate/index.test.js +40 -0
- package/agnostic/numbers/round/index.js +30 -15
- package/agnostic/numbers/round/index.test.js +56 -0
- package/agnostic/objects/deep-get-property/index.js +30 -27
- package/agnostic/objects/deep-get-property/index.test.js +59 -0
- package/agnostic/objects/enums/is-in-enum/index.js +17 -11
- package/agnostic/objects/enums/is-in-enum/index.test.js +100 -0
- package/agnostic/objects/flatten-getters/index.js +15 -14
- package/agnostic/objects/flatten-getters/index.test.js +78 -0
- package/agnostic/objects/index.d.ts +2 -2
- package/agnostic/objects/index.js +2 -2
- package/agnostic/objects/is-object/index.js +16 -9
- package/agnostic/objects/is-object/index.test.js +60 -0
- package/agnostic/objects/is-record/index.js +12 -7
- package/agnostic/objects/is-record/index.test.js +48 -0
- package/agnostic/objects/record-format/index.js +18 -12
- package/agnostic/objects/record-format/index.test.js +92 -0
- package/agnostic/objects/record-map/index.js +16 -11
- package/agnostic/objects/record-map/index.test.js +56 -0
- package/agnostic/objects/sort-keys/index.js +15 -11
- package/agnostic/objects/sort-keys/index.test.js +37 -0
- package/agnostic/objects/validation/index.js +21 -8
- package/agnostic/objects/validation/index.test.js +72 -0
- package/agnostic/optim/index.d.ts +1 -1
- package/agnostic/optim/index.js +1 -1
- package/agnostic/optim/memoize/index.js +24 -16
- package/agnostic/optim/memoize/index.test.js +30 -0
- package/agnostic/optim/throttle-debounce/index.js +120 -102
- package/agnostic/optim/throttle-debounce/index.test.js +44 -0
- package/agnostic/optim/throttle-debounce/types.js +1 -0
- package/agnostic/random/hex-char/index.js +8 -10
- package/agnostic/random/hex-char/index.test.js +20 -0
- package/agnostic/random/index.d.ts +1 -1
- package/agnostic/random/index.js +1 -1
- package/agnostic/random/random/index.js +17 -14
- package/agnostic/random/random/index.test.js +73 -0
- package/agnostic/random/uuid/index.js +28 -20
- package/agnostic/random/uuid/index.test.js +45 -0
- package/agnostic/regexps/index.js +126 -84
- package/agnostic/regexps/index.test.js +108 -0
- package/agnostic/sanitization/file-name/index.js +24 -8
- package/agnostic/sanitization/file-name/index.test.js +23 -0
- package/agnostic/sanitization/html/index.js +172 -122
- package/agnostic/sanitization/path/index.js +23 -15
- package/agnostic/sanitization/path/index.test.js +18 -0
- package/agnostic/sanitization/types.js +1 -0
- package/agnostic/sanitization/user-input/index.js +36 -24
- package/agnostic/sanitization/user-input/index.test.js +31 -0
- package/agnostic/strings/char-codes/index.js +123 -55
- package/agnostic/strings/matches/index.js +35 -16
- package/agnostic/strings/normalize-indent/index.js +34 -16
- package/agnostic/strings/parse-table/index.js +153 -86
- package/agnostic/strings/replace-all/index.js +36 -15
- package/agnostic/strings/to-alphanum/index.js +23 -8
- package/agnostic/strings/trim/index.js +22 -9
- package/agnostic/time/dates/format-date/index.js +140 -72
- package/agnostic/time/duration/index.js +106 -140
- package/agnostic/time/timeout/index.js +24 -16
- package/agnostic/time/transitions/index.js +200 -158
- package/agnostic/time/wait/index.js +10 -8
- package/agnostic/typescript/types.js +1 -0
- package/components/BeforeAfter/index.controlled.js +95 -0
- package/components/BeforeAfter/index.js +54 -189
- package/components/BeforeAfter/utils.js +9 -0
- package/components/Disclaimer/index.js +50 -110
- package/components/Drawer/index.js +81 -196
- package/components/EventListener/index.js +29 -80
- package/components/Gallery/index.js +146 -221
- package/components/Gallery/utils.js +12 -0
- package/components/Image/index.js +66 -293
- package/components/IntersectionObserver/index.js +62 -110
- package/components/Overlayer/index.js +59 -103
- package/components/Paginator/index.js +124 -155
- package/components/ResizeObserver/index.js +66 -119
- package/components/ResizeObserver/style.module.css +0 -0
- package/components/Scrllgngn/index.js +171 -468
- package/components/ScrollListener/index.js +97 -276
- package/components/ScrollListener/utils.js +51 -0
- package/components/Sequencer/index.controlled.js +67 -0
- package/components/Sequencer/index.js +105 -262
- package/components/ShadowRoot/index.js +42 -96
- package/components/Subtitles/index.js +107 -244
- package/components/Subtitles/types.js +1 -0
- package/components/Subtitles/utils.js +102 -0
- package/components/Theatre/index.js +88 -136
- package/components/UIModule/index.js +156 -199
- package/components/Video/index.js +292 -857
- package/components/Video/utils.js +137 -0
- package/components/_WIP_AudioQuote/index.js +1 -0
- package/components/_WIP_Icon/index.js +1 -0
- package/components/index.d.ts +5 -5
- package/components/index.js +5 -5
- package/components/public-classnames.js +18 -0
- package/components/utils/index.js +11 -11
- package/components/utils/types.js +1 -0
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/node/@aws-s3/index.test.js +6 -0
- package/node/@aws-s3/storage/directory/copy-dir/index.js +66 -72
- package/node/@aws-s3/storage/directory/index.d.ts +2 -2
- package/node/@aws-s3/storage/directory/index.js +2 -2
- package/node/@aws-s3/storage/directory/list/index.js +32 -42
- package/node/@aws-s3/storage/directory/move-dir/index.js +68 -86
- package/node/@aws-s3/storage/directory/remove-dir/index.js +56 -67
- package/node/@aws-s3/storage/file/copy/index.js +41 -53
- package/node/@aws-s3/storage/file/download/index.js +29 -40
- package/node/@aws-s3/storage/file/exists/index.js +35 -43
- package/node/@aws-s3/storage/file/index.d.ts +1 -1
- package/node/@aws-s3/storage/file/index.js +1 -1
- package/node/@aws-s3/storage/file/move/index.js +57 -63
- package/node/@aws-s3/storage/file/remove/index.js +35 -43
- package/node/@aws-s3/storage/file/stat/index.js +33 -47
- package/node/@aws-s3/storage/file/upload/index.js +52 -63
- package/node/@design-edito/index.js +1 -0
- package/node/@express/@multer/index.js +61 -55
- package/node/@google-cloud/storage/bucket/get-metadata/index.js +25 -29
- package/node/@google-cloud/storage/directory/copy-dir/index.js +35 -41
- package/node/@google-cloud/storage/directory/index.d.ts +1 -1
- package/node/@google-cloud/storage/directory/index.js +1 -1
- package/node/@google-cloud/storage/directory/list/index.js +28 -35
- package/node/@google-cloud/storage/directory/move-dir/index.js +43 -42
- package/node/@google-cloud/storage/directory/remove-dir/index.js +34 -38
- package/node/@google-cloud/storage/file/copy/index.js +35 -40
- package/node/@google-cloud/storage/file/download/index.js +27 -34
- package/node/@google-cloud/storage/file/exists/index.js +25 -31
- package/node/@google-cloud/storage/file/generate-signed-url/index.js +33 -35
- package/node/@google-cloud/storage/file/get-metadata/index.js +28 -31
- package/node/@google-cloud/storage/file/get-permissions/index.js +25 -31
- package/node/@google-cloud/storage/file/index.d.ts +2 -2
- package/node/@google-cloud/storage/file/index.js +2 -2
- package/node/@google-cloud/storage/file/move/index.js +38 -42
- package/node/@google-cloud/storage/file/remove/index.js +34 -35
- package/node/@google-cloud/storage/file/revoke-signed-urls/index.js +32 -95
- package/node/@google-cloud/storage/file/stat/index.js +34 -38
- package/node/@google-cloud/storage/file/update-metadata/index.js +30 -31
- package/node/@google-cloud/storage/file/upload/index.js +44 -46
- package/node/@google-cloud/storage/index.d.ts +1 -1
- package/node/@google-cloud/storage/index.js +1 -1
- package/node/cloud-storage/clients/index.js +35 -15
- package/node/cloud-storage/operations/copy-dir/index.js +30 -203
- package/node/cloud-storage/operations/copy-file/index.js +30 -152
- package/node/cloud-storage/operations/download-file/index.js +30 -103
- package/node/cloud-storage/operations/exists-file/index.js +30 -103
- package/node/cloud-storage/operations/index.d.ts +2 -2
- package/node/cloud-storage/operations/index.js +2 -2
- package/node/cloud-storage/operations/list-dir/index.js +29 -98
- package/node/cloud-storage/operations/move-dir/index.js +30 -169
- package/node/cloud-storage/operations/move-file/index.js +30 -157
- package/node/cloud-storage/operations/remove-dir/index.js +29 -159
- package/node/cloud-storage/operations/remove-file/index.js +29 -121
- package/node/cloud-storage/operations/stat-file/index.js +29 -124
- package/node/cloud-storage/operations/upload-file/index.js +30 -162
- package/node/encryption/@aes-256-gcm/buffer/index.js +31 -72
- package/node/encryption/@aes-256-gcm/uint8-array/index.js +55 -55
- package/node/encryption/key/index.js +19 -12
- package/node/files/index.d.ts +1 -1
- package/node/files/index.js +1 -1
- package/node/files/is-in-directory/index.js +11 -8
- package/node/files/read-write/index.js +11 -15
- package/node/files/subpaths/index.js +156 -121
- package/node/ftps/directory/copy-dir/index.js +55 -62
- package/node/ftps/directory/list/index.js +24 -29
- package/node/ftps/directory/move-dir/index.js +38 -38
- package/node/ftps/directory/remove-dir/index.js +39 -42
- package/node/ftps/file/copy/index.js +42 -47
- package/node/ftps/file/download/index.js +29 -34
- package/node/ftps/file/exists/index.js +38 -36
- package/node/ftps/file/index.d.ts +2 -2
- package/node/ftps/file/index.js +2 -2
- package/node/ftps/file/move/index.js +46 -44
- package/node/ftps/file/remove/index.js +36 -39
- package/node/ftps/file/stat/index.js +30 -38
- package/node/ftps/file/upload/index.js +40 -44
- package/node/images/create/index.js +10 -562
- package/node/images/format/index.js +264 -815
- package/node/images/metadata/index.js +10 -571
- package/node/images/transform/index.js +169 -1022
- package/node/images/transform/operations/blur/index.js +11 -24
- package/node/images/transform/operations/brighten/index.js +11 -24
- package/node/images/transform/operations/extend/index.js +25 -589
- package/node/images/transform/operations/extract/index.js +15 -28
- package/node/images/transform/operations/flatten/index.js +20 -584
- package/node/images/transform/operations/flip/index.js +2 -6
- package/node/images/transform/operations/flop/index.js +2 -6
- package/node/images/transform/operations/hue/index.js +13 -26
- package/node/images/transform/operations/index.d.ts +5 -5
- package/node/images/transform/operations/index.js +5 -5
- package/node/images/transform/operations/level/index.js +14 -30
- package/node/images/transform/operations/lighten/index.js +13 -26
- package/node/images/transform/operations/normalize/index.js +14 -27
- package/node/images/transform/operations/overlay/index.js +89 -673
- package/node/images/transform/operations/resize/index.js +46 -610
- package/node/images/transform/operations/rotate/index.js +20 -584
- package/node/images/transform/operations/saturate/index.js +14 -27
- package/node/images/types.js +34 -31
- package/node/images/utils/index.js +84 -568
- package/node/index.d.ts +5 -5
- package/node/index.js +5 -5
- package/node/process/on-exit/index.js +45 -26
- package/node/process/prompt-continue/index.js +29 -14
- package/node/process/spawner/index.js +104 -134
- package/node/sftp/directory/copy-dir/index.js +52 -60
- package/node/sftp/directory/index.d.ts +1 -1
- package/node/sftp/directory/index.js +1 -1
- package/node/sftp/directory/list/index.js +22 -29
- package/node/sftp/directory/move-dir/index.js +35 -35
- package/node/sftp/directory/remove-dir/index.js +39 -42
- package/node/sftp/file/copy/index.js +37 -45
- package/node/sftp/file/download/index.js +26 -32
- package/node/sftp/file/exists/index.js +29 -29
- package/node/sftp/file/index.d.ts +1 -1
- package/node/sftp/file/index.js +1 -1
- package/node/sftp/file/move/index.js +39 -38
- package/node/sftp/file/remove/index.js +31 -34
- package/node/sftp/file/stat/index.js +26 -37
- package/node/sftp/file/upload/index.js +34 -38
- package/package.json +1 -1
|
@@ -1,30 +1,49 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
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
|
-
|
|
7
|
-
|
|
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
|
-
|
|
10
|
-
|
|
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
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
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
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
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
|
-
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
} from
|
|
6
|
-
import
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
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
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
`
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
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
|
-
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
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
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
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,30 +1,23 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
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
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
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
|
-
|
|
27
|
-
|
|
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
|
-
};
|