utilitas 1989.9.46 → 1989.10.3

package/index.mjs

@@ -1,39 +1,97 @@
 // dependencies
-export { default as colors } from 'colors/safe.js';
-export { default as fetch } from 'node-fetch';
-export { Tail as tail } from 'tail';
-export * as base64url from 'base64url';
-export * as fileType from 'file-type';
-export * as geoIp from 'fast-geoip';
-export * as ini from 'ini';
-export * as jwt from 'jsonwebtoken';
-export * as mailgun from 'mailgun-js';
-export * as mailjet from 'node-mailjet';
-export * as math from 'mathjs';
-export * as mysql from 'mysql2/promise';
-export * as ping from 'ping';
-export * as qs from 'qs';
-export * as redis from 'ioredis';
-export * as sentry from '@sentry/node';
-export * as telegraf from 'telegraf';
-export * as telesign from 'telesignsdk';
-export * as twilio from 'twilio';
-export * as uuid from 'uuid';
-
+import { default as colors } from 'colors/safe.js';
+import { default as fetch } from 'node-fetch';
+import { Tail as tail } from 'tail';
+import * as base64url from 'base64url';
+import * as fileType from 'file-type';
+import * as geoIp from 'fast-geoip';
+import * as ini from 'ini';
+import * as jwt from 'jsonwebtoken';
+import * as mailgun from 'mailgun-js';
+import * as mailjet from 'node-mailjet';
+import * as math from 'mathjs';
+import * as mysql from 'mysql2/promise';
+import * as ping from 'ping';
+import * as qs from 'qs';
+import * as redis from 'ioredis';
+import * as sentry from '@sentry/node';
+import * as telegraf from 'telegraf';
+import * as telesign from 'telesignsdk';
+import * as twilio from 'twilio';
+import * as uuid from 'uuid';
 // features
-export * as bot from './lib/bot.mjs';
-export * as cache from './lib/cache.mjs';
-export * as dbio from './lib/dbio.mjs';
-export * as email from './lib/email.mjs';
-export * as encryption from './lib/encryption.mjs';
-export * as event from './lib/event.mjs';
-export * as network from './lib/network.mjs';
-export * as sentinel from './lib/sentinel.mjs';
-export * as shell from './lib/shell.mjs';
-export * as shot from './lib/shot.mjs';
-export * as sms from './lib/sms.mjs';
-export * as storage from './lib/storage.mjs';
-export * as tape from './lib/tape.mjs';
-export * as uoid from './lib/uoid.mjs';
-export * as utilitas from './lib/utilitas.mjs';
+import * as bot from './lib/bot.mjs';
+import * as cache from './lib/cache.mjs';
+import * as dbio from './lib/dbio.mjs';
+import * as email from './lib/email.mjs';
+import * as encryption from './lib/encryption.mjs';
+import * as event from './lib/event.mjs';
+import * as network from './lib/network.mjs';
+import * as sentinel from './lib/sentinel.mjs';
+import * as shell from './lib/shell.mjs';
+import * as shot from './lib/shot.mjs';
+import * as sms from './lib/sms.mjs';
+import * as storage from './lib/storage.mjs';
+import * as tape from './lib/tape.mjs';
+import * as uoid from './lib/uoid.mjs';
+import * as utilitas from './lib/utilitas.mjs';
+
+// Export
 export * as default from './lib/utilitas.mjs';
+export {
+    // dependencies
+    colors,
+    fetch,
+    tail,
+    base64url,
+    fileType,
+    geoIp,
+    ini,
+    jwt,
+    mailgun,
+    mailjet,
+    math,
+    mysql,
+    ping,
+    qs,
+    redis,
+    sentry,
+    telegraf,
+    telesign,
+    twilio,
+    uuid,
+    // features
+    bot,
+    cache,
+    dbio,
+    email,
+    encryption,
+    event,
+    network,
+    sentinel,
+    shell,
+    shot,
+    sms,
+    storage,
+    tape,
+    uoid,
+    utilitas,
+};
+
+// Browser
+let runningInBrowser = false;
+try { runningInBrowser = !!window; } catch (e) { }
+// import * as package from './package.json';
+// https://www.stefanjudis.com/snippets/how-to-import-json-files-in-es-modules-node-js/
+const pack = {
+    ...await storage.readJson('./package.json'),
+    runningInBrowser,
+};
+if (runningInBrowser) {
+    window._utilitas = pack;
+    window.utilitas = {
+        base64url, colors, encryption, event, fetch, fileType, ini, jwt, math,
+        network, qs, shell, shot, storage, uoid, utilitas, uuid,
+    };
+    console.log('[UTILITAS](https://github.com/Leask/utilitas) is ready!');
+} else { global._utilitas = pack; }

package/lib/shot.mjs

@@ -1,9 +1,14 @@
+import { promises as fs } from 'fs';
+import { sha256 } from './encryption.mjs';
 import * as fileType from 'file-type';
 import * as storage from './storage.mjs';
 import * as utilitas from './utilitas.mjs';
 import fetch from 'node-fetch';
+import path from 'path';
 
 const defFetchOpt = { redirect: 'follow', follow: 3, timeout: 1000 * 10 };
+const fakeRsp = { status: 200, statusText: 'OK', headers: { get() { }, raw() { } } };
+const buf2utf = buf => buf.toString('utf8');
 
 const getVersionOnNpm = async (packName) => {
     utilitas.assert(packName, 'Package name is required.', 400);
@@ -40,15 +45,29 @@ const getCurrentPosition = async () => {
     return rp;
 };
 
+// @todo: support etag cache and expire time features:
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
 const get = async (url, options) => {
     utilitas.assert(url, 'URL is required.');
     options = options || {};
     options.encode = utilitas.ensureString(options.encode, { case: 'UP' });
-    const r = await fetch(url, { defFetchOpt, ...options.fetch || {} });
-    const ts = (b) => { return b.toString('utf8'); };
+    const requestHash = sha256(JSON.stringify({ url, ...options }));
+    const cachePath = options.cache?.tmp || process.env.TMPDIR;
+    const cacheFile = cachePath ? path.join(cachePath, requestHash) : null;
+    const cacheable = options.cache && cacheFile;
+    let cacheAction, content;
+    const cache = cacheable && await utilitas.ignoreErrFunc(async () => {
+        const resp = await fs.readFile(cacheFile);
+        cacheAction = 'READ';
+        return resp;
+    });
+    const r = cache
+        ? { ...fakeRsp, async buffer() { return cache } }
+        : await fetch(url, { defFetchOpt, ...options.fetch || {} });
     const [htpMime, buffer] = [r.headers.get('content-type'), await r.buffer()];
     const bufMime = utilitas.extract(await fileType.fileTypeFromBuffer(buffer), 'mime');
-    let [mimeType, content] = [bufMime || htpMime, null];
+    const mimeType = bufMime || htpMime;
+    const length = buffer.length;
     switch (options.encode) {
         case 'BUFFER':
             content = buffer;
@@ -60,18 +79,25 @@ const get = async (url, options) => {
             content = storage.encodeBase64DataURL(mimeType, buffer);
             break;
         case 'JSON':
-            try { content = JSON.parse(ts(buffer)); } catch (e) { }
+            try { content = JSON.parse(buf2utf(buffer)); } catch (e) { }
             break;
         case 'TEXT':
-            content = ts(buffer);
+            content = buf2utf(buffer);
             break;
         default:
             utilitas.assert(!options.encode, 'Invalid encoding.', 400);
-            content = ts(buffer);
+            content = buf2utf(buffer);
     }
+    cacheable && !cache && length && r.status === 200
+        && await utilitas.ignoreErrFunc(async () => {
+            const resp = await fs.writeFile(cacheFile, buffer);
+            cacheAction = 'WRITE';
+            return resp;
+        });
     return {
-        statusCode: r.status, statusText: r.statusText, length: buffer.length,
+        statusCode: r.status, statusText: r.statusText, length,
         mimeType, content, headers: r.headers.raw(), response: r,
+        cache: cacheable && { filename: cacheFile, action: cacheAction },
     };
 }
 

package/lib/uoid.mjs

@@ -4,7 +4,6 @@ import * as uuid from 'uuid';
 
 const fileURLToPath = (await import('url')).fileURLToPath
     || ((url) => { return new URL('', url).pathname; });
-
 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 compactUuid = (uuid) => uuid.replace(/\-/ig, '');

package/lib/utilitas.mjs

@@ -14,7 +14,6 @@ RegExp.escape = RegExp.escape || ((str) => { //$& means the whole matched string
 
 const fileURLToPath = (await import('url')).fileURLToPath
     || ((url) => { return new URL('', url).pathname; });
-
 const __filename = fileURLToPath(import.meta.url);
 const invalidTime = 'Invalid time.';
 
@@ -591,8 +590,8 @@ const checkInterval = (itv, sed) => {
     return !((Math.round(Date.now() / 1000) + ensureInt(sed)) % ensureInt(itv));
 };
 
-const ignoreErrFunc = async (f, o) => {
-    try { return await f(); } catch (e) { return o?.log ? console.error(e) : e }
+const ignoreErrFunc = async (func, options) => {
+    try { return await func(); } catch (e) { options?.log && console.error(e); }
 };
 
 const tryUntil = async (fnTry, options) => {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "utilitas",
     "description": "Just another common utility for Node.js.",
-    "version": "1989.9.46",
+    "version": "1989.10.3",
     "private": false,
     "homepage": "https://github.com/Leask/utilitas",
     "main": "index.mjs",
@@ -16,7 +16,8 @@
         "ncuinit": "npm install -g npm-check-updates",
         "updep": "npx ncu -u && npm install && npm install node-fetch@2 && ( git commit -am 'update dependencies' || true )",
         "gitsync": "git pull && git push",
-        "prepublishOnly": "npm version patch && npm run updep && npm run gitsync"
+        "build": "./node_modules/.bin/webpack-cli --config webpack.config.mjs",
+        "prepublishOnly": "npm run build && npm version patch && npm run updep && npm run gitsync"
     },
     "author": "Leask Wong <i@leaskh.com>",
     "license": "MIT",
@@ -45,5 +46,10 @@
         "telesignsdk": "^2.2.1",
         "twilio": "^3.75.1",
         "uuid": "^8.3.2"
+    },
+    "devDependencies": {
+        "browserify-fs": "^1.0.0",
+        "node-polyfill-webpack-plugin": "^1.1.4",
+        "webpack-cli": "^4.9.2"
     }
 }