utilitas 1989.8.84 → 1989.9.2

package/README.md

@@ -1,3 +1,8 @@
 # utilitas
 
 Just another common utility for Node.js.
+
+## Todo
+
+- Kept node-fetch back to v2 because v3 is not stable enough.
+- When move forward to node-fetch v3 be sure to upgrade timeout options.

package/index.mjs

@@ -0,0 +1,75 @@
+import * as fileType from 'file-type';
+import * as math from 'mathjs';
+import * as uuid from 'uuid';
+import base64url from 'base64url';
+import cache from './lib/cache.mjs';
+import colors from 'colors/safe.js';
+import dbio from './lib/dbio.mjs';
+import email from './lib/email.mjs';
+import encryption from './lib/encryption.mjs';
+import event from './lib/event.mjs';
+import fetch from 'node-fetch';
+import geoIp from 'fast-geoip';
+import ini from 'ini';
+import jwt from 'jsonwebtoken';
+import mailgun from 'mailgun-js';
+import mailjet from 'node-mailjet';
+import mysql from 'mysql2/promise';
+import network from './lib/network.mjs';
+import ping from 'ping';
+import publicIp from 'public-ip';
+import qs from 'qs';
+import redis from 'ioredis';
+import sentinel from './lib/sentinel.mjs';
+import sentry from '@sentry/node';
+import shell from './lib/shell.mjs';
+import shot from './lib/shot.mjs';
+import sms from './lib/sms.mjs';
+import storage from './lib/storage.mjs';
+import tape from './lib/tape.mjs';
+import telesign from 'telesignsdk';
+import twilio from 'twilio';
+import uoid from './lib/uoid.mjs';
+import utilitas from './lib/utilitas.mjs';
+import winston from 'winston';
+import winstonPapertrail from 'winston-papertrail-mproved';
+
+export default {
+    // dependencies
+    base64url,
+    colors,
+    fetch,
+    fileType,
+    geoIp,
+    ini,
+    jwt,
+    mailgun,
+    mailjet,
+    math,
+    mysql,
+    ping,
+    publicIp,
+    qs,
+    redis,
+    sentry,
+    telesign,
+    twilio,
+    uuid,
+    winston,
+    winstonPapertrail,
+    // features
+    cache,
+    dbio,
+    email,
+    encryption,
+    event,
+    network,
+    sentinel,
+    shell,
+    shot,
+    sms,
+    storage,
+    tape,
+    uoid,
+    utilitas,
+};

package/lib/{cache.js → cache.mjs}

@@ -1,16 +1,16 @@
-'use strict';
+import utilitas from './utilitas.mjs';
+
+const log = (content) => { return utilitas.modLog(content, 'cache'); };
+
+let redis;
 
 const defaultOptions = {
     port: 6379, host: '127.0.0.1', family: 4, db: 0, connectTimeout: 1000 * 3,
 };
 
-let ioredis, redis;
-
-const log = (content) => { return utilitas.modLog(content, 'cache'); };
-
 const init = async (options) => {
     if ((options = options === '@' ? defaultOptions : options)) {
-        ioredis = require('ioredis');
+        const ioredis = await import('ioredis');
         redis = new ioredis(options);
         if (!options.silent) {
             log(`Initialized: redis://${redis.options.host}`
@@ -21,7 +21,7 @@ const init = async (options) => {
     return redis;
 };
 
-module.exports = {
+export default {
     init,
     //     set,
     //     get,
@@ -42,8 +42,6 @@ module.exports = {
     //     pUnLock
 };
 
-const utilitas = require('./utilitas');
-
 // https://github.com/luin/ioredis
 
 // var getKey = function(type, id, callback) {

package/lib/{dbio.js → dbio.mjs}

@@ -1,4 +1,4 @@
-'use strict';
+import utilitas from './utilitas.mjs';
 
 const defaultPort = 3306;
 const orders = { '+': 'ASC', '-': 'DESC' };
@@ -9,11 +9,11 @@ const comparison = ['=', '>', '<', '<>', '!='];
 const fieldNoQuote = [fieldAny, fieldCount];
 const log = (content) => { return utilitas.modLog(content, 'dbio'); };
 
-let mysql, pool;
+let pool;
 
 const init = async (options) => {
     if (options) {
-        mysql = require('mysql2/promise');
+        const mysql = await import('mysql2/promise.js');
         pool = mysql.createPool(options);
         if (!options.silent) {
             log(`Initialized: mysql://${options.user}@${options.host}`
@@ -261,7 +261,7 @@ const deleteAll = async (table, options) => {
     return await execute(assembleDelete(table));
 };
 
-module.exports = {
+export default {
     assembleInsert,
     assembleQuery,
     assembleSet,
@@ -287,5 +287,3 @@ module.exports = {
     updateByKeyValue,
     upsert,
 };
-
-const utilitas = require('./utilitas');

package/lib/{email.js → email.mjs}

@@ -1,8 +1,8 @@
-'use strict';
+import utilitas from './utilitas.mjs';
 
 const log = (content) => { return utilitas.modLog(content, 'email'); };
 
-let senderName, senderEmail, provider, engine, client;
+let senderName, senderEmail, provider, client;
 
 const throwInvalidProvider = (message, status) => {
     utilitas.throwError(message || 'Invalid email provider.', status || 500);
@@ -14,13 +14,14 @@ const init = async (options) => {
         senderEmail = options.senderEmail;
         senderName = options.senderName || (await utilitas.which()).name;
         provider = utilitas.trim(options.provider, { case: 'UP' });
+        let engine;
         switch (provider) {
             case 'MAILGUN':
-                engine = require('mailgun-js');
+                engine = await import('mailgun-js');
                 client = engine(options);
                 break;
             case 'MAILJET':
-                engine = require('node-mailjet');
+                engine = await import('node-mailjet');
                 client = engine.connect(options.apiKey, options.apiSecret);
                 break;
             default:
@@ -87,14 +88,14 @@ const send = async (email, subject, text, html, args, options) => {
     }, html ? { html } : {}));
 }
 
-module.exports = {
+export default {
     getSenderName,
     init,
     rawSend,
     send,
 };
 
-const utilitas = require('./utilitas');
+
 
 // (async () => {
 //     init({

package/lib/{encryption.js → encryption.mjs}

@@ -1,4 +1,6 @@
-'use strict';
+import crypto from 'crypto';
+import fs from 'fs';
+import qs from 'qs';
 
 const defaultAlgorithm = 'sha256';
 
@@ -45,7 +47,7 @@ const digestObject = (object, algorithm) => {
     return hash(getSortedQueryString(object), algorithm);
 };
 
-module.exports = {
+export default {
     defaultAlgorithm,
     digestObject,
     getSortedQueryString,
@@ -56,7 +58,3 @@ module.exports = {
     sha256,
     sha256File,
 };
-
-const crypto = require('crypto');
-const fs = require('fs');
-const qs = require('qs');

package/lib/{event.js → event.mjs}

@@ -1,15 +1,17 @@
-'use strict';
+import { fileURLToPath } from 'url';
+import { v4 as uuidv4 } from 'uuid';
+import fs from 'fs';
+import path from 'path';
+import utilitas from './utilitas.mjs';
 
+const __filename = fileURLToPath(import.meta.url);
 const jobs = {};
-
-let timer = null;
-
 const sToMs = (sec) => { return 1000 * (isNaN(sec = Number(sec)) ? 0 : sec); };
-
 const unLock = (name) => { return jobs[name].lock = 0; };
-
 const list = () => { return jobs; };
 
+let timer = null;
+
 const log = (content, job, options) => {
     options = Object.assign({ time: true }, options || {});
     if (!job || !jobs[job] || !jobs[job].silent
@@ -34,14 +36,11 @@ const exec = async () => {
             jobs[i].lastRun = now;
             try {
                 if (tryLock(i, now, jobs[i].timeout)) {
-                    log('Locked, skipped.', i);
-                    continue;
+                    log('Locked, skipped.', i); continue;
                 }
                 log('Emit...', i);
                 await jobs[i].function();
-            } catch (err) {
-                log(err, i);
-            }
+            } catch (err) { log(err, i); }
             log('Done.', i);
             unLock(i);
         }
@@ -78,10 +77,10 @@ const bulk = async (absDir, options) => {
     const pms = [];
     log(`SERVICES: ${absDir}`);
     (fs.readdirSync(absDir) || []).filter((file) => {
-        return /\.js$/i.test(file) && file.indexOf('.') !== 0;
-    }).forEach((file) => {
-        const filename = file.replace(/^(.*)\.js$/i, '$1');
-        const mod = require(path.join(absDir, file));
+        return /\.mjs$/i.test(file) && file.indexOf('.') !== 0;
+    }).forEach(async (file) => {
+        const filename = file.replace(/^(.*)\.mjs$/i, '$1');
+        const mod = await import(path.join(absDir, file));
         if (mod.run) {
             mod.name = mod.name || filename;
             pms.push(load(mod, options));
@@ -104,15 +103,10 @@ const end = async () => {
     log('Terminated.');
 };
 
-module.exports = {
+export default {
     bulk,
+    end,
     list,
     load,
     loop,
-    end,
 };
-
-const utilitas = require('./utilitas');
-const uuidv4 = require('uuid').v4;
-const path = require('path');
-const fs = require('fs');

package/lib/{network.js → network.mjs}

@@ -1,4 +1,9 @@
-'use strict';
+import fetch from 'node-fetch';
+import geoIp from 'fast-geoip';
+import libPing from 'ping';
+import publicIp from 'public-ip';
+import shell from './shell.mjs';
+import utilitas from './utilitas.mjs';
 
 const log = (content) => { return utilitas.modLog(content, 'network'); };
 
@@ -89,17 +94,10 @@ const getCurrentPosition = async () => {
     return Object.assign(loc, { ip });
 };
 
-module.exports = {
+export default {
     getCurrentPosition,
     httping,
     pickFastestHost,
     pickFastestHttpServer,
     ping,
 };
-
-const utilitas = require('./utilitas');
-const publicIp = require('public-ip');
-const libPing = require('ping');
-const fetch = require('node-fetch').default;
-const geoIp = require('fast-geoip');
-const shell = require('./shell');

package/lib/{sentinel.js → sentinel.mjs}

@@ -1,8 +1,8 @@
-'use strict';
+import utilitas from './utilitas.mjs';
 
 const log = (str, opts) => { return utilitas.modLog(str, 'sentinel', opts); };
 
-let sentry = null;
+let sentry;
 
 const integrations = (integrations) => {
     return integrations.filter(x => {
@@ -13,7 +13,7 @@ const integrations = (integrations) => {
 
 const init = async (options) => {
     if (options) {
-        sentry = require('@sentry/node');
+        sentry = await import('@sentry/node');
         sentry.init(Object.assign({ integrations }, options));
         if (!options.silent) { log(`Initialized, dsn: ${options.dsn} .`); }
     }
@@ -21,8 +21,6 @@ const init = async (options) => {
     return sentry;
 };
 
-module.exports = {
+export default {
     init,
 };
-
-const utilitas = require('./utilitas');

package/lib/{shell.js → shell.mjs}

@@ -1,7 +1,10 @@
-'use strict';
+import childProcess from 'child_process';
+import util from 'util';
+import utilitas from './utilitas.mjs';
 
 const log = (content) => { return utilitas.modLog(content, 'shell'); };
 const vF = (cmd, cbf) => { log(`Can not run in browser: ${cmd}`); cbf(); };
+const pmsExec = util.promisify(childProcess && childProcess?.exec || vF);
 
 const assertCommand = (command) => {
     utilitas.assert(command, 'Command is required.', 500);
@@ -31,14 +34,9 @@ const assertExist = async (bin, er, code = 500) => {
     utilitas.assert(await exist(bin), er || `Command not found: ${bin}.`, code);
 };
 
-module.exports = {
+export default {
     assertExist,
     exec,
     exist,
     which,
 };
-
-const childProcess = require('child_process');
-const utilitas = require('./utilitas');
-const util = require('util');
-const pmsExec = util.promisify(childProcess && childProcess?.exec || vF);

package/lib/{shot.js → shot.mjs}

@@ -1,4 +1,7 @@
-'use strict';
+import * as fileType from 'file-type';
+import fetch from 'node-fetch';
+import storage from './storage.mjs';
+import utilitas from './utilitas.mjs';
 
 const defFetchOpt = { redirect: 'follow', follow: 3, timeout: 1000 * 10 };
 
@@ -22,7 +25,7 @@ const checkVersion = async (pack) => {
 };
 
 const getCurrentPosition = async () => {
-    const url = `https://geolocation-db.com/json`;
+    const url = 'https://geolocation-db.com/json/';
     const rp = await fetch(url).then(res => res.json());
     utilitas.assert(rp, 'Network is unreachable.', 500);
     utilitas.assert(rp.country_code, 'Error detecting geolocation.', 500);
@@ -36,7 +39,7 @@ const get = async (url, options) => {
     const r = await fetch(url, { defFetchOpt, ...options.fetch || {} });
     const ts = (b) => { return b.toString('utf8'); };
     const [htpMime, buffer] = [r.headers.get('content-type'), await r.buffer()];
-    const bufMime = utilitas.extract(await fileType.fromBuffer(buffer), 'mime');
+    const bufMime = utilitas.extract(await fileType.fileTypeFromBuffer(buffer), 'mime');
     let [mimeType, content] = [bufMime || htpMime, null];
     switch (options.encode) {
         case 'BUFFER':
@@ -64,14 +67,9 @@ const get = async (url, options) => {
     };
 }
 
-module.exports = {
-    get,
+export default {
     checkVersion,
+    get,
     getCurrentPosition,
     getVersionOnNpm,
 };
-
-const utilitas = require('./utilitas');
-const fileType = require('file-type');
-const storage = require('./storage');
-const fetch = require('node-fetch').default;

package/lib/{sms.js → sms.mjs}

@@ -1,10 +1,11 @@
-'use strict';
+import util from 'util';
+import utilitas from './utilitas.mjs';
 
 const defaultTeleSignApi = 'https://rest-api.telesign.com';
 const defaultTimeout = 1000 * 10 // 10 secs
 const log = (content) => { return utilitas.modLog(content, 'sms'); };
 
-let sender, engine, provider, client, sendFunc;
+let sender, provider, client, sendFunc;
 
 const throwInvalidProvider = (message, status) => {
     utilitas.throwError(message || 'Invalid SMS provider.', status || 500);
@@ -13,15 +14,16 @@ const throwInvalidProvider = (message, status) => {
 const init = async (options) => {
     if (options) {
         provider = utilitas.trim(options.provider, { case: 'UP' });
+        let engine;
         switch (provider) {
             case 'TWILIO':
                 utilitas.assert(sender = options.phoneNumber,
                     'Sender phone number is required.', 500);
-                engine = require('twilio');
+                engine = await import('twilio');
                 client = new engine(options.accountSid, options.authToken);
                 break;
             case 'TELESIGN':
-                engine = require('telesignsdk');
+                engine = await import('telesignsdk');
                 client = new engine(
                     options.customerId, options.apiKey,
                     options.rest_endpoint || defaultTeleSignApi,
@@ -58,10 +60,7 @@ const send = async (phone, message) => {
     }
 };
 
-module.exports = {
+export default {
     init,
     send,
 };
-
-const utilitas = require('./utilitas');
-const util = require('util');

package/lib/{storage.js → storage.mjs}

@@ -1,4 +1,9 @@
-'use strict';
+import { v4 as uuidv4 } from 'uuid';
+import fs from 'fs';
+import ini from 'ini';
+import os from 'os';
+import path from 'path';
+import utilitas from './utilitas.mjs';
 
 const [encoding, mode] = ['utf8', '0644'];
 
@@ -12,7 +17,7 @@ const stringify = (data, opts) => {
 
 const writeTempFile = async (data, options) => {
     let { filename, encoding: ec, mode: md, prefix, suffix: s } = options || {};
-    filename = `${prefix || ''}${filename || uuid.v4()}${s ? `.${s}` : ''}`;
+    filename = `${prefix || ''}${filename || uuidv4()}${s ? `.${s}` : ''}`;
     if (String(ec).toUpperCase() === 'JSON') {
         data = stringify(data, options); ec = null;
     }
@@ -144,7 +149,7 @@ const exists = async (fp) => {
     try { return await fs.promises.stat(fp); } catch (_) { return null; }
 };
 
-module.exports = {
+export default {
     assertPath,
     encodeBase64DataURL,
     exists,
@@ -157,11 +162,4 @@ module.exports = {
     writeIni,
     writeJson,
     writeTempFile,
-}
-
-const fs = require('fs');
-const ini = require('ini');
-const os = require('os');
-const path = require('path');
-const utilitas = require('./utilitas');
-const uuid = require('uuid');
+};

package/lib/{tape.js → tape.mjs}

@@ -1,4 +1,4 @@
-'use strict';
+import utilitas from './utilitas.mjs';
 
 // https://github.com/winstonjs/winston#logging-levels
 // const levels = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
@@ -61,8 +61,8 @@ const init = async (options) => {
             options.provider, { case: 'UP' }
         ) || providerDefault;
         options = await getDefaultOptions(provider, options);
-        winston = require('winston');
-        papertrail = require('winston-papertrail-mproved');
+        winston = await import('winston');
+        papertrail = await import('winston-papertrail-mproved');
         papertrailConnection = new papertrail.PapertrailConnection(options);
         papertrailConnection.on('error', handleError);
         papertrailConnection.on('connect', handleConnect);
@@ -88,10 +88,8 @@ const end = async () => {
     }, 1000);
 };
 
-module.exports = {
-    init,
-    getLogger,
+export default {
     end,
+    getLogger,
+    init,
 };
-
-const utilitas = require('./utilitas');

package/lib/{uoid.js → uoid.mjs}

@@ -1,5 +1,9 @@
-'use strict';
+import { fileURLToPath } from 'url';
+import * as uuid from 'uuid';
+import encryption from './encryption.mjs';
+import utilitas from './utilitas.mjs';
 
+const __filename = fileURLToPath(import.meta.url);
 const uuidRegTxt = '[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}';
 
 const getTimestampFromUuid = (uuid) => {
@@ -26,13 +30,9 @@ const getRfcUrlNamespaceUuid = (url) => {
     return uuid.v5(url, uuid.v5.URL);
 };
 
-module.exports = {
+export default {
     uuidRegTxt,
     create,
     getRfcUrlNamespaceUuid,
     getTimestampFromUuid,
 };
-
-const encryption = require('./encryption');
-const utilitas = require('./utilitas');
-const uuid = require('uuid');

package/lib/{utilitas.js → utilitas.mjs}

@@ -1,4 +1,7 @@
-'use strict';
+import { fileURLToPath } from 'url';
+import colors from 'colors/safe.js';
+import path from 'path';
+import storage from './storage.mjs';
 
 Object.values = Object.values || ((obj) => {
     return Object.keys(obj).map((key) => {
@@ -10,6 +13,7 @@ RegExp.escape = RegExp.escape || ((str) => { //$& means the whole matched string
     return String(str).replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 }); // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 
+const __filename = fileURLToPath(import.meta.url);
 const invalidTime = 'Invalid time.';
 
 const tryOpts = {
@@ -609,7 +613,7 @@ const purgeEmoji = (any, replace = '') => {
     );
 };
 
-module.exports = {
+export default {
     arrayEqual,
     assembleApiUrl,
     assembleUrl,
@@ -689,7 +693,3 @@ module.exports = {
     verifyUuid,
     which,
 };
-
-const storage = require('./storage');
-const colors = require('colors/safe');
-const path = require('path');

package/package.json

@@ -1,19 +1,19 @@
 {
     "name": "utilitas",
     "description": "Just another common utility for Node.js.",
-    "version": "1989.8.84",
+    "version": "1989.9.2",
     "private": false,
     "homepage": "https://github.com/Leask/utilitas",
-    "main": "index.js",
+    "main": "index.mjs",
+    "type": "module",
     "scripts": {
-        "start": "node index.js",
-        "debug": "node --inspect --trace-warnings debug.js",
-        "test": "node --inspect --trace-warnings test.js",
+        "start": "node index.mjs",
+        "debug": "node --inspect --trace-warnings debug.mjs",
+        "test": "node --inspect --trace-warnings test.mjs",
         "ncuinit": "npm install -g npm-check-updates",
-        "updep": "npx ncu -u && npm install && npm install file-type@16 && npm install node-fetch@2 && npm install public-ip@4 && npm install colors@1.4.0 && ( git commit -am 'update dependencies' || true )",
+        "updep": "npx ncu -u && npm install && npm install node-fetch@2 && ( git commit -am 'update dependencies' || true )",
         "gitsync": "git pull && git push",
-        "prepublishOnlyOld": "npm version patch && npm run updep && npm run gitsync",
-        "prepublishOnly": "npm version patch && npm run gitsync"
+        "prepublishOnly": "npm version patch && npm run updep && npm run gitsync"
     },
     "author": "Leask Wong <i@leaskh.com>",
     "license": "MIT",
@@ -25,23 +25,23 @@
         "@sentry/node": "^6.16.1",
         "base64url": "^3.0.1",
         "colors": "1.4.0",
-        "fast-geoip": "^1.1.53",
-        "file-type": "^16.5.3",
+        "fast-geoip": "^1.1.54",
+        "file-type": "^17.1.1",
         "ini": "github:Leask/ini",
-        "ioredis": "^4.28.2",
+        "ioredis": "^4.28.3",
         "jsonwebtoken": "^8.5.1",
         "mailgun-js": "^0.22.0",
-        "mathjs": "^10.0.2",
+        "mathjs": "^10.1.0",
         "mysql2": "^2.3.3",
-        "node-fetch": "^2.6.6",
+        "node-fetch": "^2.6.7",
         "node-mailjet": "^3.3.4",
         "ping": "^0.4.1",
-        "public-ip": "^4.0.4",
-        "qs": "^6.10.2",
+        "public-ip": "^5.0.0",
+        "qs": "^6.10.3",
         "telesignsdk": "^2.2.1",
-        "twilio": "^3.72.0",
+        "twilio": "^3.73.0",
         "uuid": "^8.3.2",
-        "winston": "^3.3.4",
+        "winston": "^3.4.0",
         "winston-papertrail-mproved": "^1.0.7"
     }
 }

package/index.js

@@ -1,41 +0,0 @@
-'use strict';
-
-module.exports = {
-    // dependencies
-    base64url: require('base64url'),
-    colors: require('colors/safe'),
-    fetch: require('node-fetch').default,
-    fileType: require('file-type'),
-    geoIp: require('fast-geoip'),
-    ini: require('ini'),
-    jwt: require('jsonwebtoken'),
-    mailgun: require('mailgun-js'),
-    mailjet: require('node-mailjet'),
-    math: require('mathjs'),
-    mysql: require('mysql2/promise'),
-    ping: require('ping'),
-    publicIp: require('public-ip'),
-    qs: require('qs'),
-    redis: require('ioredis'),
-    sentry: require('@sentry/node'),
-    telesign: require('telesignsdk'),
-    twilio: require('twilio'),
-    uuid: require('uuid'),
-    winston: require('winston'),
-    winstonPapertrail: require('winston-papertrail-mproved'),
-    // features
-    cache: require('./lib/cache'),
-    dbio: require('./lib/dbio'),
-    email: require('./lib/email'),
-    encryption: require('./lib/encryption'),
-    event: require('./lib/event'),
-    network: require('./lib/network'),
-    sentinel: require('./lib/sentinel'),
-    shell: require('./lib/shell'),
-    shot: require('./lib/shot'),
-    sms: require('./lib/sms'),
-    storage: require('./lib/storage'),
-    tape: require('./lib/tape'),
-    uoid: require('./lib/uoid'),
-    utilitas: require('./lib/utilitas'),
-};