@vbarbarosh/node-helpers 3.63.1 → 3.64.0

package/README.md

@@ -1,6 +1,5 @@
 A set of helpers for JavaScript/Node.js
 
-
 <p align="center">
 <a href="https://github.com/vbarbarosh/node-helpers/actions"><img src="https://github.com/vbarbarosh/node-helpers/actions/workflows/node.js.yml/badge.svg" alt="@vbarbarosh/node-helpers CI status" /></a>
 <a href="https://opensource.org/licenses/MIT" rel="nofollow"><img src="https://img.shields.io/github/license/vbarbarosh/node-helpers" alt="License" /></a>
@@ -24,7 +23,7 @@ A subset of `@vbarbarosh/node-helpers` is available for browser:
 <script src="https://unpkg.com/@vbarbarosh/node-helpers@latest/dist/browser.js"></script>
 ```
 
-⚠️ All supported functions are exposed globally.
+⚠️ All browser functions are exposed globally.
 
 ## Test
 

package/dist/browser.js

@@ -38,10 +38,10 @@ function serializer(replacer, cycleReplacer) {
 
 /***/ }),
 
-/***/ "./src sync recursive \\b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\\.test)\\.js$":
-/*!***************************************************************************************************************************************************************************************************************************************************************************************************************************************!*\
-  !*** ./src/ sync \b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\.test)\.js$ ***!
-  \***************************************************************************************************************************************************************************************************************************************************************************************************************************************/
+/***/ "./src sync recursive \\b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cfcmp%7Cfilter%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\\.test)\\.js$":
+/*!*******************************************************************************************************************************************************************************************************************************************************************************************************************************************************!*\
+  !*** ./src/ sync \b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cfcmp%7Cfilter%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\.test)\.js$ ***!
+  \*******************************************************************************************************************************************************************************************************************************************************************************************************************************************************/
 /***/ ((module, __unused_webpack_exports, __webpack_require__) => {
 
 var map = {
@@ -61,6 +61,11 @@ var map = {
 	"./array_unique_last.js": "./src/array_unique_last.js",
 	"./date_add_months.js": "./src/date_add_months.js",
 	"./date_is_leap_year.js": "./src/date_is_leap_year.js",
+	"./fcmp_dates.js": "./src/fcmp_dates.js",
+	"./fcmp_from_spec.js": "./src/fcmp_from_spec.js",
+	"./fcmp_numbers.js": "./src/fcmp_numbers.js",
+	"./fcmp_strings.js": "./src/fcmp_strings.js",
+	"./filter1_from_spec.js": "./src/filter1_from_spec.js",
 	"./format_bytes.js": "./src/format_bytes.js",
 	"./format_date.js": "./src/format_date.js",
 	"./format_date_ymd.js": "./src/format_date_ymd.js",
@@ -113,7 +118,7 @@ webpackContext.keys = function webpackContextKeys() {
 };
 webpackContext.resolve = webpackContextResolve;
 module.exports = webpackContext;
-webpackContext.id = "./src sync recursive \\b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\\.test)\\.js$";
+webpackContext.id = "./src sync recursive \\b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cfcmp%7Cfilter%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\\.test)\\.js$";
 
 /***/ }),
 
@@ -630,6 +635,103 @@ function factorize_ms(v)
 module.exports = factorize_ms;
 
 
+/***/ }),
+
+/***/ "./src/fcmp_dates.js":
+/*!***************************!*\
+  !*** ./src/fcmp_dates.js ***!
+  \***************************/
+/***/ ((module) => {
+
+function fcmp_dates(a, b)
+{
+    return a.getTime() - b.getTime();
+}
+
+module.exports = fcmp_dates;
+
+
+/***/ }),
+
+/***/ "./src/fcmp_from_spec.js":
+/*!*******************************!*\
+  !*** ./src/fcmp_from_spec.js ***!
+  \*******************************/
+/***/ ((module) => {
+
+/**
+ * Create fcmp from an array of props. For desc order a prop should be prefixed
+ * with minus sign (e.g. -price).
+ */
+function fcmp_from_spec(props)
+{
+    const fcmp = props.map(one);
+    switch (fcmp.length) {
+    case 0:
+        return () => 0;
+    case 1:
+        return fcmp[0];
+    case 2:
+        return function (a, b) {
+            return fcmp[0](a, b) || fcmp[1](a, b);
+        };
+    case 3:
+        return function (a, b) {
+            return fcmp[0](a, b) || fcmp[1](a, b) || fcmp[2](a, b);
+        };
+    default:
+        return function (a, b) {
+            for (let i = 0; i < fcmp.length; ++i) {
+                const tmp = fcmp[i](a, b);
+                if (tmp) {
+                    return tmp;
+                }
+            }
+            return 0;
+        };
+    }
+}
+
+function one(prop)
+{
+    if (prop[0] === '-') {
+        prop = prop.slice(1);
+        return function (b, a) {
+            return comp_types(a[prop], b[prop]);
+        };
+    }
+    return function (a, b) {
+        return comp_types(a[prop], b[prop]);
+    };
+}
+
+function comp_types(a, b)
+{
+    if (typeof a === 'string' && typeof b === 'string') {
+        return a.localeCompare(b);
+    }
+    return a - b;
+}
+
+module.exports = fcmp_from_spec;
+
+
+/***/ }),
+
+/***/ "./src/fcmp_numbers.js":
+/*!*****************************!*\
+  !*** ./src/fcmp_numbers.js ***!
+  \*****************************/
+/***/ ((module) => {
+
+function fcmp_numbers(a, b)
+{
+    return Number(a) - b;
+}
+
+module.exports = fcmp_numbers;
+
+
 /***/ }),
 
 /***/ "./src/fcmp_strings.js":
@@ -646,6 +748,91 @@ function fcmp_strings(a, b)
 module.exports = fcmp_strings;
 
 
+/***/ }),
+
+/***/ "./src/filter1_from_spec.js":
+/*!**********************************!*\
+  !*** ./src/filter1_from_spec.js ***!
+  \**********************************/
+/***/ ((module) => {
+
+/**
+ * Creates a filtering function based on the following spec:
+ * 1. Substrings are separated by `/`.
+ * 2. Each substring may have special characters:
+ *    - `^`: Substring must appear at the beginning.
+ *    - `$`: Substring must appear at the end.
+ *    - `!`: Negates the condition (substring must not appear).
+ */
+function filter1_from_spec(spec)
+{
+    let a, b, c, d;
+    const parts = parse_spec(spec);
+    switch (parts.length) {
+    case 0:
+        // No filters, always true
+        return () => true;
+    case 1:
+        return parts[0];
+    case 2:
+        [a, b] = parts;
+        return s => a(s) && b(s);
+    case 3:
+        [a, b, c] = parts;
+        return s => a(s) && b(s) && c(s);
+    case 4:
+        [a, b, c, d] = parts;
+        return s => a(s) && b(s) && c(s) && d(s);
+    default:
+        return s => parts.every(fn => fn(s));
+    }
+}
+
+function parse_spec(spec)
+{
+    return spec.split('/').filter(v => v).map(parse_expr);
+}
+
+// convert expr into an array of objects {substr, starts, ends}
+function parse_expr(expr)
+{
+    let substr;
+    let starts = false; // ^
+    let ends = false; // $
+    substr = expr.replaceAll('^', '');
+    starts = (substr.length !== expr.length);
+    expr = substr;
+    substr = expr.replaceAll('$', '');
+    ends = (substr.length !== expr.length);
+    expr = substr;
+    substr = expr.replaceAll('!', '');
+    if ((expr.length - substr.length) % 2) { // not
+        if (starts && ends) {
+            return s => !s.startsWith(substr) && !s.endsWith(substr);
+        }
+        if (starts) {
+            return s => !s.startsWith(substr);
+        }
+        if (ends) {
+            return s => !s.endsWith(substr);
+        }
+        return s => !s.includes(substr);
+    }
+    if (starts && ends) {
+        return s => s.startsWith(substr) && s.endsWith(substr);
+    }
+    if (starts) {
+        return s => s.startsWith(substr);
+    }
+    if (ends) {
+        return s => s.endsWith(substr);
+    }
+    return s => s.includes(substr);
+}
+
+module.exports = filter1_from_spec;
+
+
 /***/ }),
 
 /***/ "./src/format_bytes.js":
@@ -1582,7 +1769,7 @@ var __webpack_exports__ = {};
   \******************************/
 // https://github.com/webpack/webpack/issues/625
 // https://webpack.js.org/guides/dependency-management/#require-context
-const require_tmp = __webpack_require__("./src sync recursive \\b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\\.test)\\.js$");
+const require_tmp = __webpack_require__("./src sync recursive \\b(array%7Cdate%7Chttp_delete%7Chttp_get_blob%7Chttp_get_buffer%7Chttp_get_json%7Chttp_get_utf8%7Chttp_head%7Chttp_patch_json%7Chttp_post_json%7Chttp_post_multipart%7Chttp_put_buffer%7Chttp_put_json%7Chttp_put_utf8%7Cidentity%7Cignore%7Cfcmp%7Cfilter%7Cformat%7Cplural%7Crandom_int%7Curlmod%7Cwaitcb)[^/]*(?<%21\\.test)\\.js$");
 require_tmp.keys().forEach(function (key) {
     const [, basename] = key.match(/([^/]+)\.js$/);
     window[basename] = require_tmp(key);

package/package.json

@@ -2,7 +2,7 @@
     "author": "Vladimir Barbarosh <vladimir.barbarosh@gmail.com>",
     "license": "MIT",
     "name": "@vbarbarosh/node-helpers",
-    "version": "3.63.1",
+    "version": "3.64.0",
     "description": "A set of helpers for JavaScript/Node.js",
     "unpkg": "dist/browser.js",
     "jsdelivr": "dist/browser.js",
@@ -28,6 +28,7 @@
         "url": "https://github.com/vbarbarosh/node-helpers/issues"
     },
     "peerDependencies": {
+        "@vbarbarosh/type-helpers": "^0.1.0",
         "axios": "^1.7.9",
         "bluebird": "^3.7.2",
         "csv-parse": "^5.6.0",

package/src/browser/index.js

@@ -1,6 +1,6 @@
 // https://github.com/webpack/webpack/issues/625
 // https://webpack.js.org/guides/dependency-management/#require-context
-const require_tmp = require.context('..', true, /\b(array|date|http_delete|http_get_blob|http_get_buffer|http_get_json|http_get_utf8|http_head|http_patch_json|http_post_json|http_post_multipart|http_put_buffer|http_put_json|http_put_utf8|identity|ignore|format|plural|random_int|urlmod|waitcb)[^/]*(?<!\.test)\.js$/);
+const require_tmp = require.context('..', true, /\b(array|date|http_delete|http_get_blob|http_get_buffer|http_get_json|http_get_utf8|http_head|http_patch_json|http_post_json|http_post_multipart|http_put_buffer|http_put_json|http_put_utf8|identity|ignore|fcmp|filter|format|plural|random_int|urlmod|waitcb)[^/]*(?<!\.test)\.js$/);
 require_tmp.keys().forEach(function (key) {
     const [, basename] = key.match(/([^/]+)\.js$/);
     window[basename] = require_tmp(key);

package/src/format_progress_bytes.js

@@ -1,7 +1,7 @@
 const format_bytes = require('./format_bytes');
 const format_percents = require('./format_percents');
 const format_seconds = require('./format_seconds');
-const is_number_gt = require('./is_number_gt');
+const is_number_gt = require('@vbarbarosh/type-helpers/src/is_number_gt');
 
 function format_progress_bytes({percents, total, done, rate, eta, duration})
 {

package/src/format_progress_kilo.js

@@ -1,7 +1,7 @@
 const format_kilo = require('./format_kilo');
 const format_percents = require('./format_percents');
 const format_seconds = require('./format_seconds');
-const is_number_gt = require('./is_number_gt');
+const is_number_gt = require('@vbarbarosh/type-helpers/src/is_number_gt');
 
 function format_progress_kilo({percents, total, done, rate, eta, duration})
 {

package/src/fs_copy_excl.js

@@ -0,0 +1,8 @@
+const fs = require('fs');
+
+function fs_copy_excl(src, dest)
+{
+    return fs.promises.copyFile(src, dest, fs.constants.COPYFILE_EXCL);
+}
+
+module.exports = fs_copy_excl;

package/src/fs_path_relative.js

@@ -0,0 +1,8 @@
+const path = require('path');
+
+function fs_path_relative(from, to)
+{
+    return path.relative(from, to);
+}
+
+module.exports = fs_path_relative;

package/src/http_get_stream.js

@@ -1,5 +1,5 @@
 const axios = require('axios');
-const make_int = require('./make_int');
+const make_int = require('@vbarbarosh/type-helpers/src/make_int');
 
 async function http_get_stream(url, options)
 {

package/src/parallel.js

@@ -1,11 +1,20 @@
 const NotImplemented = require('./errors/NotImplemented');
+const Promise = require('bluebird');
+const is_async_function = require('@vbarbarosh/type-helpers/src/is_async_function');
+const is_async_generator = require('@vbarbarosh/type-helpers/src/is_async_generator');
 
 /**
  * - Run until `spawn` return `null`.
  * - Keep no more than `concurrency` number of workers at a time.
+ *
+ * ⚠️ Warning: `spawn` should not be async function (async functions are always return `promise`).
+ *    Instead, it should be a simple function returning either `null` or a `promise`.
  */
 async function parallel({concurrency, spawn, progress})
 {
+    if (is_async_function(spawn) || is_async_generator(spawn)) {
+        throw new Error('[spawn] should not be async function. Instead, it should be a simple function returning either [null] or a [promise].');
+    }
     const running = [];
     return new Promise(function (resolve, reject) {
         let failed = false;

package/src/parallel.test.js

@@ -0,0 +1,11 @@
+const assert = require('assert');
+const parallel = require('./parallel');
+
+describe('parallel', function () {
+    it('should reject when [spawn] is async function', function () {
+        assert.rejects(parallel({spawn: async function () {}}));
+    })
+    it('should reject when [spawn] is async generator', function () {
+        assert.rejects(parallel({spawn: async function* () {}}));
+    })
+});

package/src/is_number.js

@@ -1,6 +0,0 @@
-function is_number(value)
-{
-    return (typeof value === 'number') && isFinite(value);
-}
-
-module.exports = is_number;

package/src/is_number.test.js

@@ -1,20 +0,0 @@
-const assert = require('assert');
-const is_number = require('./is_number');
-
-const items = [
-    ['-inf → false', -Infinity, false],
-    ['+inf → false', +Infinity, false],
-    ['null → false', null, false],
-    ['{} → false', {}, false],
-    ['Symbol() → false', Symbol(), false],
-    ['Function → false', () => 1, false],
-    ['BigInt(1) → false', 1n, false],
-];
-
-describe('is_number', function () {
-    items.forEach(function ([title, input, expected]) {
-        it(title, function () {
-            assert.deepStrictEqual(is_number(input), expected);
-        });
-    });
-});

package/src/is_number_gt.js

@@ -1,8 +0,0 @@
-const is_number = require('./is_number');
-
-function is_number_gt(value, min)
-{
-    return is_number(value) && value > min;
-}
-
-module.exports = is_number_gt;

package/src/make_int.js

@@ -1,15 +0,0 @@
-function make_int(value, default_value = 0, min = Number.MIN_SAFE_INTEGER, max = Number.MAX_SAFE_INTEGER)
-{
-    switch (typeof value) {
-    case 'bigint':
-        return Math.max(min, Math.min(max, Number(value)));
-    case 'symbol':
-        return default_value;
-    }
-    if (value === null || value === undefined || !isFinite(value)) {
-        return default_value;
-    }
-    return Math.max(min, Math.min(max, Math.round(value === 0 ? value : (+value||default_value))));
-}
-
-module.exports = make_int;

package/src/make_number.js

@@ -1,15 +0,0 @@
-function make_number(value, default_value = 0, min = Number.MIN_SAFE_INTEGER, max = Number.MAX_SAFE_INTEGER)
-{
-    switch (typeof value) {
-    case 'bigint':
-        return Number(value);
-    case 'symbol':
-        return default_value;
-    }
-    if (value === null || value === undefined || !isFinite(value)) {
-        return default_value;
-    }
-    return Math.max(min, Math.min(max, Math.round(value === 0 ? value : (+value||default_value))));
-}
-
-module.exports = make_number;

package/src/make_number.test.js

@@ -1,25 +0,0 @@
-const assert = require('assert');
-const make_number = require('./make_number');
-
-const items = [
-    ['null → 0', null, 0],
-    ['undefined → 0', undefined, 0],
-    ['{} → 0', {}, 0],
-    ['nan → 0', NaN, 0],
-    ['-inf → 0', -Infinity, 0],
-    ['+inf → 0', +Infinity, 0],
-    ['false → 0', false, 0],
-    ['true → 1', true, 1],
-    ['Symbol() → 0', Symbol(), 0],
-    ['Function → 0', () => 1, 0],
-    ['BigInt(1) → 1', 1n, 1],
-    ['"123" → 123', '123', 123],
-];
-
-describe('make_number', function () {
-    items.forEach(function ([title, input, expected]) {
-        it(title, function () {
-            assert.deepStrictEqual(make_number(input), expected);
-        });
-    });
-});