mbkbucket 3.6.0 → 3.7.0

package/lib/src/routes/index.js

@@ -7,32 +7,52 @@
 
 import express from "express";
 import { sessRole } from "mbkauthe";
+import path from "path";
+import { fileURLToPath } from "url";
 import { bucketResolver } from "../middleware/bucket-resolver.js";
 import { renderBucketDashboard } from "../controllers/dashboard.controller.js";
 import infoRoutes from "./info.routes.js";
 import { createViewRoutes } from "./view.routes.js";
 import { createApiRoutes } from "./api.routes.js";
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const publicDir = path.resolve(__dirname, "..", "..", "public");
+
+const serveAsset = (filename) => (_req, res) => {
+  res.set("Cache-Control", "public, max-age=300, must-revalidate");
+  res.sendFile(path.join(publicDir, filename), (err) => {
+    if (err) res.status(err.status || 404).end();
+  });
+};
+
 export function createBucketRouter({ authorization } = {}) {
-	const router = express.Router();
-	const defaultAuthorization = sessRole('superadmin');
-	const authorizations = typeof authorization === 'function'
-		? { view: authorization, upload: authorization, delete: authorization }
-		: authorization || {};
-	const viewAuthorization = authorizations.view || defaultAuthorization;
-	const uploadAuthorization = authorizations.upload || defaultAuthorization;
-	const deleteAuthorization = authorizations.delete || defaultAuthorization;
-
-	router.get('/mbkbucket', viewAuthorization, renderBucketDashboard);
-	router.use(
-		'/mbkbucket',
-		bucketResolver,
-		infoRoutes,
-		createViewRoutes({ authorization: viewAuthorization }),
-		createApiRoutes({ viewAuthorization, uploadAuthorization, deleteAuthorization }),
-	);
-
-	return router;
+  const router = express.Router();
+  const defaultAuth = sessRole('superadmin');
+  const auths = typeof authorization === 'function'
+    ? { view: authorization, upload: authorization, delete: authorization }
+    : authorization ?? {};
+  const viewAuth = auths.view ?? defaultAuth;
+  const uploadAuth = auths.upload ?? defaultAuth;
+  const deleteAuth = auths.delete ?? defaultAuth;
+
+  // Static dashboard & helper assets
+  router.get('/mbkbucket/bucketadmin.css', serveAsset('bucketadmin.css'));
+  router.get('/mbkbucket/bucketadmin.js', serveAsset('bucketadmin.js'));
+  router.get('/mbkbucket/mbkbucket-helper.css', serveAsset('mbkbucket-helper.css'));
+  router.get('/mbkbucket/mbkbucket-helper.js', serveAsset('mbkbucket-helper.js'));
+  router.get('/mbkbucket/helper-demo', serveAsset('mbkbucket-helper-demo.html'));
+
+  router.get('/mbkbucket', viewAuth, renderBucketDashboard);
+  router.use(
+    '/mbkbucket',
+    bucketResolver,
+    infoRoutes,
+    createViewRoutes({ authorization: viewAuth }),
+    createApiRoutes({ viewAuthorization: viewAuth, uploadAuthorization: uploadAuth, deleteAuthorization: deleteAuth })
+  );
+
+  return router;
 }
 
 const router = createBucketRouter();

package/lib/src/services/s3.service.js

@@ -12,7 +12,7 @@ function parseJsonEnv(envVar, fallback = {}) {
   try {
     return JSON.parse(envVar);
   } catch (e) {
-    console.error(`❌ Error parsing JSON for envVar: ${envVar ? String(envVar).slice(0, 200) : 'undefined'} - ${e.message}`);
+    console.error(`❌ Error parsing JSON for envVar: ${String(envVar).slice(0, 200)} - ${e.message}`);
     console.error(`💡 Tip: Check that inner objects are NOT quoted as strings. Use {"key":{"field":"value"}} not {"key":"{"field":"value"}"}`);
     return fallback;
   }
@@ -24,13 +24,9 @@ const hasBucketConfigs = availableBucketNames.length > 0;
 
 const escapeRegExp = value => String(value).replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 
-export function getAvailableBucketNames() {
-  return availableBucketNames;
-}
+export const getAvailableBucketNames = () => availableBucketNames;
 
-function getDefaultBucketName() {
-  return mbkautheVar?.bucket || (availableBucketNames.length > 0 ? availableBucketNames[0] : null);
-}
+const getDefaultBucketName = () => mbkautheVar?.bucket || (availableBucketNames.length > 0 ? availableBucketNames[0] : null);
 
 export function resolveBucketName(bucketName) {
   const raw = typeof bucketName === 'string' ? bucketName.trim() : bucketName;
@@ -53,10 +49,7 @@ export function getAppName() {
   return typeof app === 'string' && app.trim() ? app.trim() : '';
 }
 
-function isRootModeApp(appName) {
-  const app = String(appName || '').toLowerCase();
-  return app === 'portal' || app === 'mbkbucket';
-}
+const isRootModeApp = appName => ['portal', 'mbkbucket'].includes(String(appName || '').toLowerCase());
 
 function validateKeySafety(str, isKey = false) {
   if (isKey && !str) throw new Error('Key is required');
@@ -73,7 +66,7 @@ export function ensureKeyHasAppPrefix(key = '') {
   validateKeySafety(key, true);
 
   const app = getAppName();
-  let cleaned = trimLeadingSlashes(key);
+  const cleaned = trimLeadingSlashes(key);
   if (isRootModeApp(app)) return cleaned;
   if (!app) throw new Error('APP_NAME is not configured; set mbkautheVar.APP_NAME or MBKAUTHE_APP_NAME');
 
@@ -86,16 +79,14 @@ export function ensurePrefix(prefix = '') {
   validateKeySafety(prefix, false);
 
   const app = getAppName();
-  let p = trimLeadingSlashes(prefix);
+  const p = trimLeadingSlashes(prefix);
   if (isRootModeApp(app)) return p;
   if (!app) throw new Error('APP_NAME is not configured; set mbkautheVar.APP_NAME or MBKAUTHE_APP_NAME');
-  if (!p) return app;
-  if (p === app || p === `${app}/`) return p;
+  if (!p || p === app || p === `${app}/`) return p || app;
 
-  if (p.startsWith(`${app}/`)) {
-    return p.replace(new RegExp(`^(?:${escapeRegExp(app)}\/)+`), `${app}/`);
-  }
-  return `${app}/${p}`;
+  return p.startsWith(`${app}/`)
+    ? p.replace(new RegExp(`^(?:${escapeRegExp(app)}\/)+`), `${app}/`)
+    : `${app}/${p}`;
 }
 
 // ---------------------------------------------------------------------------

package/lib/src/utils/errors.js

@@ -26,23 +26,15 @@ function matchError(rules, error, fallbackMessage) {
   return { status: found?.status ?? 500, code: found?.code ?? 'INTERNAL_ERROR', message };
 }
 
-export function classifyApiError(error, fallbackMessage = 'Request failed') {
-  return matchError(API_ERROR_RULES, error, fallbackMessage);
-}
-
-export function classifyViewError(error, fallbackMessage = 'Request failed') {
-  return matchError(VIEW_ERROR_RULES, error, fallbackMessage);
-}
+export const classifyApiError = (error, fallbackMessage = 'Request failed') => matchError(API_ERROR_RULES, error, fallbackMessage);
+export const classifyViewError = (error, fallbackMessage = 'Request failed') => matchError(VIEW_ERROR_RULES, error, fallbackMessage);
 
 export function sendApiError(res, error, fallbackMessage = 'Request failed') {
   const { status, code, message } = classifyApiError(error, fallbackMessage);
   return res.status(status).json({
     success: false,
     code,
-    error: {
-      code,
-      message,
-    },
+    error: { code, message },
     message,
     timestamp: new Date().toISOString(),
   });

package/lib/src/utils/helpers.js

@@ -4,14 +4,12 @@
 
 const HTML_ESCAPE_MAP = { '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&#39;' };
 
-export function escapeHtml(value = '') {
-  return String(value ?? '').replace(/[&<>"']/g, c => HTML_ESCAPE_MAP[c]);
-}
+export const escapeHtml = (value = '') => String(value ?? '').replace(/[&<>"']/g, c => HTML_ESCAPE_MAP[c]);
 
 export function getBaseName(path = '') {
   const value = String(path ?? '');
-  const lastSlashIndex = value.lastIndexOf('/');
-  return lastSlashIndex === -1 ? value : value.slice(lastSlashIndex + 1);
+  const lastSlash = value.lastIndexOf('/');
+  return lastSlash === -1 ? value : value.slice(lastSlash + 1);
 }
 
 export function getFileExt(fileName = '') {
@@ -20,13 +18,8 @@ export function getFileExt(fileName = '') {
   return dotIndex === -1 ? '' : name.slice(dotIndex + 1).toLowerCase();
 }
 
-export function trimSlashes(str = '') {
-  return String(str ?? '').replace(/^\/+/, '').replace(/\/+$/, '');
-}
-
-export function trimLeadingSlashes(str = '') {
-  return String(str ?? '').replace(/^\/+/, '');
-}
+export const trimSlashes = (str = '') => String(str ?? '').replace(/^\/+|\/+$/g, '');
+export const trimLeadingSlashes = (str = '') => String(str ?? '').replace(/^\/+/, '');
 
 export function getFolderPath(key = '') {
   const s = String(key ?? '');
@@ -34,9 +27,7 @@ export function getFolderPath(key = '') {
   return lastSlash === -1 ? '' : s.slice(0, lastSlash + 1);
 }
 
-export function normalizeKeyParam(rawKey) {
-  return Array.isArray(rawKey) ? rawKey.join('/') : String(rawKey || '');
-}
+export const normalizeKeyParam = rawKey => Array.isArray(rawKey) ? rawKey.join('/') : String(rawKey || '');
 
 export function buildKey(prefix, fileName) {
   const cleanPrefix = trimSlashes(prefix);
@@ -44,15 +35,13 @@ export function buildKey(prefix, fileName) {
   return cleanPrefix ? `${cleanPrefix}/${cleanName}` : cleanName;
 }
 
-export function nowIso() {
-  return new Date().toISOString();
-}
+export const nowIso = () => new Date().toISOString();
 
 export function formatBytes(bytes) {
-  if (!bytes || bytes === 0) return '0 B';
+  if (!bytes) return '0 B';
   const units = ['B', 'KB', 'MB', 'GB', 'TB'];
   const i = Math.floor(Math.log(bytes) / Math.log(1024));
-  return `${(bytes / Math.pow(1024, i)).toFixed(i > 0 ? 1 : 0)} ${units[i]}`;
+  return `${(bytes / 1024 ** i).toFixed(i > 0 ? 1 : 0)} ${units[i]}`;
 }
 
 export function formatDate(iso) {
@@ -67,25 +56,18 @@ export async function streamToBuffer(stream) {
   if (Buffer.isBuffer(stream)) return stream;
   const chunks = [];
   if (stream?.[Symbol.asyncIterator] || stream?.transformToWeb) {
-    for await (const chunk of stream) {
-      chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
-    }
-    return Buffer.concat(chunks);
-  }
-  if (stream?.getReader) {
+    for await (const chunk of stream) chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+  } else if (stream?.getReader) {
     const reader = stream.getReader();
-    while (true) {
-      const { done, value } = await reader.read();
-      if (done) break;
-      chunks.push(Buffer.isBuffer(value) ? value : Buffer.from(value));
+    for (let res = await reader.read(); !res.done; res = await reader.read()) {
+      chunks.push(Buffer.isBuffer(res.value) ? res.value : Buffer.from(res.value));
     }
-    return Buffer.concat(chunks);
   }
   return Buffer.concat(chunks);
 }
 
 export function destroyStream(stream) {
-  if (stream && typeof stream.destroy === 'function') {
+  if (typeof stream?.destroy === 'function') {
     stream.removeAllListeners?.();
     stream.destroy();
   }
@@ -111,17 +93,10 @@ export const VIDEO_TYPES = new Set(['mp4', 'webm', 'ogg', 'avi', 'mov']);
 export const AUDIO_TYPES = new Set(['mp3', 'wav', 'flac', 'aac', 'm4a']);
 
 export const MIME_TYPES = {
-  // Images
-  jpg: 'image/jpeg', jpeg: 'image/jpeg', png: 'image/png',
-  gif: 'image/gif', webp: 'image/webp', svg: 'image/svg+xml',
-  bmp: 'image/bmp', ico: 'image/x-icon',
-  // Videos
-  mp4: 'video/mp4', webm: 'video/webm', ogg: 'video/ogg',
-  avi: 'video/x-msvideo', mov: 'video/quicktime',
-  // Audio
-  mp3: 'audio/mpeg', wav: 'audio/wav', flac: 'audio/flac',
-  aac: 'audio/aac', m4a: 'audio/mp4',
-  // Text / Code
+  jpg: 'image/jpeg', jpeg: 'image/jpeg', png: 'image/png', gif: 'image/gif',
+  webp: 'image/webp', svg: 'image/svg+xml', bmp: 'image/bmp', ico: 'image/x-icon',
+  mp4: 'video/mp4', webm: 'video/webm', ogg: 'video/ogg', avi: 'video/x-msvideo', mov: 'video/quicktime',
+  mp3: 'audio/mpeg', wav: 'audio/wav', flac: 'audio/flac', aac: 'audio/aac', m4a: 'audio/mp4',
   txt: 'text/plain; charset=utf-8', md: 'text/markdown; charset=utf-8',
   json: 'application/json; charset=utf-8', xml: 'application/xml; charset=utf-8',
   csv: 'text/csv; charset=utf-8', log: 'text/plain; charset=utf-8',
@@ -137,14 +112,10 @@ export const MIME_TYPES = {
   ps1: 'text/x-powershell; charset=utf-8', yaml: 'text/x-yaml; charset=utf-8',
   yml: 'text/x-yaml; charset=utf-8', toml: 'text/x-toml; charset=utf-8',
   ini: 'text/x-ini; charset=utf-8', conf: 'text/x-conf; charset=utf-8',
-  // Archives & Documents
-  zip: 'application/zip', gz: 'application/gzip', tar: 'application/x-tar',
-  pdf: 'application/pdf'
+  zip: 'application/zip', gz: 'application/gzip', tar: 'application/x-tar', pdf: 'application/pdf'
 };
 
-export function getMimeType(fileName, fallback = 'application/octet-stream') {
-  return MIME_TYPES[getFileExt(fileName)] || fallback;
-}
+export const getMimeType = (fileName, fallback = 'application/octet-stream') => MIME_TYPES[getFileExt(fileName)] || fallback;
 
 export function isSensitiveTextType(contentType = '') {
   const type = String(contentType ?? '').toLowerCase();
@@ -154,8 +125,7 @@ export function isSensitiveTextType(contentType = '') {
 export function buildCacheControl(contentType, { isStaticAsset = false, supportsRanges = false, publicCache = false } = {}) {
   if (publicCache) {
     if (isStaticAsset) return 'public, max-age=3600, immutable';
-    if (supportsRanges) return 'public, max-age=86400, must-revalidate';
-    return 'public, max-age=300, must-revalidate';
+    return supportsRanges ? 'public, max-age=86400, must-revalidate' : 'public, max-age=300, must-revalidate';
   }
   if (isSensitiveTextType(contentType)) return 'private, no-store';
   return supportsRanges ? 'private, max-age=1800, must-revalidate' : 'private, max-age=300, must-revalidate';
@@ -185,15 +155,11 @@ export function parseRangeHeader(rangeHeader, totalSize) {
   } else {
     start = parseInt(startStr, 10);
     if (isNaN(start) || start < 0) return null;
-    if (endStr === '') {
-      end = Math.min(start + DEFAULT_CHUNK_SIZE - 1, totalSize - 1);
-    } else {
-      end = parseInt(endStr, 10);
-      if (isNaN(end) || end < start) return null;
-    }
+    end = endStr === '' ? Math.min(start + DEFAULT_CHUNK_SIZE - 1, totalSize - 1) : parseInt(endStr, 10);
+    if (isNaN(end) || end < start) return null;
   }
 
-  if (start >= totalSize || start > end || end >= totalSize) return null;
+  if (start >= totalSize || end >= totalSize) return null;
   return { start, end, total: totalSize, size: end - start + 1 };
 }
 
@@ -201,8 +167,7 @@ export function parseRangeHeader(rangeHeader, totalSize) {
 // Player page HTML template
 // ---------------------------------------------------------------------------
 
-export function renderPlayerPage(safeFileName, encodedKey, bucketQuery) {
-  return `<!doctype html>
+export const renderPlayerPage = (safeFileName, encodedKey, bucketQuery) => `<!doctype html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
@@ -225,7 +190,6 @@ export function renderPlayerPage(safeFileName, encodedKey, bucketQuery) {
   </div>
 </body>
 </html>`;
-}
 
 // ---------------------------------------------------------------------------
 // Common Handlebars helpers
@@ -236,16 +200,13 @@ export const commonHandlebarsHelpers = {
   neq: (a, b) => a !== b,
   or: (...args) => args.slice(0, -1).some(Boolean),
   and: (...args) => args.slice(0, -1).every(Boolean),
-  not: (val) => !val,
+  not: val => !val,
   gt: (a, b) => a > b,
   gte: (a, b) => a >= b,
   lt: (a, b) => a < b,
   lte: (a, b) => a <= b,
   includes: (arr, val) => Array.isArray(arr) && arr.includes(val),
-  json: (obj) => JSON.stringify(obj, null, 2),
-  jsonStringify: (obj) => JSON.stringify(obj),
-  getInitials: (username) => {
-    if (!username) return '?';
-    return username.split(/[._]/).map(p => p.charAt(0)).join('').toUpperCase().slice(0, 2);
-  },
+  json: obj => JSON.stringify(obj, null, 2),
+  jsonStringify: obj => JSON.stringify(obj),
+  getInitials: username => username ? username.split(/[._]/).map(p => p.charAt(0)).join('').toUpperCase().slice(0, 2) : '?',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mbkbucket",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Flexible S3/R2 bucket management — library, Express router, and CLI for mbktech.org applications. Provides upload, download, listing, multipart utilities, signed URLs, and a command-line interface with built-in configuration validation and health checks",
   "author": "Muhammad Bin Khalid",
   "homepage": "https://github.com/MIbnEKhalid/mbkbucket#readme",
@@ -20,15 +20,15 @@
     "#logger": "./lib/src/utils/logger.js"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.968.0",
-    "@aws-sdk/s3-request-presigner": "^3.1000.0",
+    "@aws-sdk/client-s3": "^3.1127.0",
+    "@aws-sdk/s3-request-presigner": "^3.1127.0",
     "compression": "^1.8.0",
     "debug": "^4.4.3",
     "dotenv": "^16.6.1",
     "express": "^5.1.0",
     "express-handlebars": "^9.0.1",
-    "express-rate-limit": "^7.5.0",
-    "mbkauthe": "^5.8.0",
+    "express-rate-limit": "^7.5.1",
+    "mbkauthe": "^5.10.0",
     "multer": "^2.0.2",
     "pg": "^8.16.3"
   },