mbkbucket 2.1.1 → 3.0.0

package/index.js

@@ -1,151 +1,29 @@
-import express from "express";
-import path from "path";
 import dotenv from "dotenv";
-import { fileURLToPath } from "url";
-import mbkautheRoutes from "mbkauthe";
-import { engine } from "express-handlebars";
-import compression from "compression";
-import rateLimit from 'express-rate-limit';
-import bucketRoutes from "./lib/routes/index.js";
-import { checkVersion } from "./lib/config/index.js";
-import { packageJson } from "./lib/config/index.js";
-import { createLogger } from "./lib/debug.js";
+import { createApp } from "./src/app.js";
+import { checkVersion } from "./src/config/index.js";
+import { runHealthCheck } from "./src/services/s3.service.js";
+import { createLogger } from "./src/utils/logger.js";
 
 dotenv.config();
-const debugServer = createLogger('server');
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const isDevMode = process.env.NODE_ENV === "dev";
-
-const server = express();
-server.set('trust proxy', 1);
 
-server.use(compression());
-
-// Rate limiting: general limiter for typical browsing/API usage and a stricter
-// limiter for dashboard (admin) routes.
-const generalLimiter = rateLimit({
-  windowMs: 2 * 60 * 1000, // 2 minutes
-  max: 150, // limit each IP to 150 requests per windowMs
-  standardHeaders: true, // Return rate limit info in the `RateLimit-*` headers
-  legacyHeaders: false, // Disable the `X-RateLimit-*` headers
-  handler: (req, res) => {
-    res.status(429).render('error.handlebars', { message: 'Too many requests from your IP. Try again later.', code: 429 });
-  }
-});
+const debugServer = createLogger('server');
+const port = process.env.PORT || 3004;
 
-// Increase body size limits to support larger form submissions (e.g., multipart upload init/complete payloads).
-// Multipart/form-data uploads themselves are handled separately via multer in the upload endpoints.
-server.use(express.json({ limit: '10mb' }));
-server.use(express.urlencoded({ extended: true, limit: '10mb' }));
+// Check for package updates and S3 connectivity on startup
+await checkVersion();
+await runHealthCheck();
 
-// Serve only specific static assets (limit exposure): CSS and JS used by the dashboard.
-// Avoid immutable long cache here because dashboard routes change frequently and stale JS
-// can keep writing old URLs in browser history.
-const dashboardAssetCacheControl = 'public, max-age=300, must-revalidate';
-server.get('/mbkbucket/bucketadmin.css', (req, res) => {
-  res.set('Cache-Control', dashboardAssetCacheControl);
-  res.sendFile(path.join(__dirname, 'public', 'bucketadmin.css'), (err) => {
-    if (err) res.status(err.status || 404).end();
-  });
-});
+// Create and start the Express application
+const server = createApp();
 
-server.get('/mbkbucket/bucketadmin.js', (req, res) => {
-  res.set('Cache-Control', dashboardAssetCacheControl);
-  res.sendFile(path.join(__dirname, 'public', 'bucketadmin.js'), (err) => {
-    if (err) res.status(err.status || 404).end();
-  });
+server.listen(port, () => {
+  debugServer("Server running on http://localhost:%s", port);
 });
 
-// Configure Handlebars (single setup)
-server.engine("handlebars", engine({
-  extname: ".handlebars",
-  defaultLayout: "main",
-  layoutsDir: path.join(__dirname, "../../views/layouts"),
-  partialsDir: [
-    path.join(__dirname, "views/templates"),
-    path.join(__dirname, "views/templates/notice"),
-    path.join(__dirname, "views"),
-    path.join(__dirname, "views/partial"),
-    path.join(__dirname, "node_modules/mbkauthe/views"),
-    path.join(__dirname, "../mbkauthe/views")
-  ],
-  cache: process.env.NODE_ENV === "production",
-  helpers: {
-    eq: function (a, b) {
-      return a === b;
-    },
-    mbkbucket_cachebuster: function () {
-      return "?v=" + packageJson.version;
-    }
-  }
-}));
-
-server.set("view engine", "handlebars");
-server.set("views", [
-  path.join(__dirname, "views"),
-  path.join(__dirname, "node_modules/mbkauthe/views"),
-  path.join(__dirname, "../mbkauthe/views")
-]);
-
-server.use(mbkautheRoutes);
-server.use(generalLimiter);
-server.use(bucketRoutes);
-if (isDevMode) {
-  debugServer("Dev mode is enabled. Starting server in dev mode.");
-
-  // Request timing middleware: logs method, url, status and elapsed ms
-  server.use((req, res, next) => {
-    const start = process.hrtime();
-    res.on('finish', () => {
-      const diff = process.hrtime(start);
-      const ms = diff[0] * 1000 + diff[1] / 1e6;
-      debugServer("[%s] %s %s %s - %s ms", new Date().toISOString(), req.method, req.originalUrl, res.statusCode, ms.toFixed(3));
-    });
-    next();
-  });
-
-  server.get("/", async (req, res) => {
-    res.redirect("/mbkbucket");
-  });
-
-  // 404 handler
-  server.use((req, res) => {
-    debugServer("Path not found: %s %s", req.method, req.url);
-    return res.status(404).render("Error/dError.handlebars", {
-      layout: false,
-      code: 404,
-      error: "Not Found",
-      message: "The requested page was not found.",
-      pagename: "Home",
-      page: "/",
-    });
-  });
-
-  // Error handler
-  server.use((err, req, res, next) => {
-    console.error(`[mbkbucket] ${err.stack}`);
-    return res.status(500).render("Error/dError.handlebars", {
-      layout: false,
-      code: 500,
-      error: "Internal app Error",
-      message: "An unexpected error occurred on the app.",
-      details: err.message,
-      pagename: "Home",
-      page: "/",
-    });
-  });
-
-  const port = process.env.PORT || 3004;
-  server.listen(port, async() => {
-    debugServer("Server running on http://localhost:%s", port);
-  });
-
-}
-
-await checkVersion();
-
+// Re-export the public API for consumers of this package (named exports only)
+export * from "./src/services/s3.service.js";
+export * from "./src/config/index.js";
+export { default as bucket } from "./src/routes/index.js";
 
-export * from "./lib/index.js";
+// Default export: the Express application instance
 export default server;

package/lib/index.js

@@ -1,11 +1,11 @@
-// Barrel file: re-export all public items from lib
-export * from './s3.js';
-export * from './config/index.js';
-export { default as bucket } from './routes/index.js';
+// Barrel file: re-export all public items from the restructured src/ directory
+export * from '../src/services/s3.service.js';
+export * from '../src/config/index.js';
+export { default as bucket } from '../src/routes/index.js';
 
-import * as s3 from './s3.js';
-import * as config from './config/index.js';
-import bucket from './routes/index.js';
+import * as s3 from '../src/services/s3.service.js';
+import * as config from '../src/config/index.js';
+import bucket from '../src/routes/index.js';
 
 // Default aggregate export for convenience
 const defaultExport = {

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "mbkbucket",
-  "version": "2.1.1",
-  "description": "Flexible S3/R2 bucket management library and Express router for mbktech.org applications, providing upload, download, listing, and multipart utilities with built-in configuration validation and health checks",
+  "version": "3.0.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",
   "license": "LGPL-3.0-only",
   "main": "index.js",
   "type": "module",
   "types": "index.d.ts",
+  "bin": {
+    "mbkbucket": "./cli.js"
+  },
   "scripts": {
     "dev": "cross-env NODE_ENV=dev nodemon index.js",
     "test": "node --test"
@@ -21,7 +24,7 @@
     "express": "^4.22.1",
     "express-handlebars": "^8.0.3",
     "express-rate-limit": "^7.0.1",
-    "mbkauthe": "5.1.1",
+    "mbkauthe": "5.3.2",
     "multer": "^2.0.2",
     "pg": "^8.16.3"
   },
@@ -53,6 +56,10 @@
     "idrivee2",
     "storage",
     "mbkauthe",
-    "mbktech.org"
+    "mbktech.org",
+    "cli",
+    "command-line",
+    "file-upload",
+    "file-download"
   ]
 }

package/public/bucketadmin.js

@@ -37,6 +37,35 @@ function getDownloadUrl(encodedKey) {
     return withBucketUrl(`/mbkbucket/download/${encodedKey}`);
 }
 
+/**
+ * Download a file via fetch + Blob, which allows multiple concurrent downloads
+ * (unlike <a href> navigation which cancels the previous download).
+ * @param {string} url - The download URL
+ * @param {string} filename - The filename to save as
+ */
+async function downloadFileViaFetch(url, filename) {
+    try {
+        const response = await fetch(url);
+        if (!response.ok) {
+            const err = await response.json().catch(() => ({}));
+            throw new Error(err.message || err.error || `Download failed (${response.status})`);
+        }
+        const blob = await response.blob();
+        const objectUrl = URL.createObjectURL(blob);
+        const a = document.createElement('a');
+        a.href = objectUrl;
+        a.download = filename;
+        document.body.appendChild(a);
+        a.click();
+        document.body.removeChild(a);
+        // Revoke the object URL after a short delay to allow the browser to start the download
+        setTimeout(() => URL.revokeObjectURL(objectUrl), 1000);
+    } catch (err) {
+        console.error('Download failed:', err);
+        alert('Download failed: ' + err.message);
+    }
+}
+
 function stripApiPrefixFromPath(path, apiPrefix = '') {
     const normalizedPath = String(path || '').replace(/^\/+/, '');
     const normalizedApiPrefix = String(apiPrefix || '').replace(/^\/+/, '').replace(/\/+$/, '');
@@ -686,7 +715,7 @@ function renderFilesTable(files, folders = [], prefix = '', apiPrefix = '') {
               <button type="button" class="btn btn-info btn-sm copy-btn" data-key-enc="${encodedKey}" title="Copy Link">
                 <i class="fas fa-link"></i>
               </button>
-                            <a href="${getDownloadUrl(encodedKey)}" class="btn btn-success btn-sm"
+                            <a href="#" onclick="event.preventDefault(); downloadFileViaFetch('${getDownloadUrl(encodedKey)}', '${escapeAttr(filename)}')" class="btn btn-success btn-sm"
                 title="Download file">
                 <i class="fas fa-download"></i>
               </a>
@@ -1601,9 +1630,12 @@ function showPreviewModal(encodedKey, filename, extension, previewMode = 'auto')
     titleEl.textContent = filename;
     titleEl.title = filename;
     openBtn.href = getViewUrl(encodedKey);
-    downloadBtn.href = getDownloadUrl(encodedKey);
-    // Ensure downloaded file has the original filename
-    downloadBtn.setAttribute('download', filename);
+    downloadBtn.href = '#';
+    downloadBtn.onclick = (e) => {
+      e.preventDefault();
+      downloadFileViaFetch(getDownloadUrl(encodedKey), filename);
+    };
+    downloadBtn.removeAttribute('download');
 
     // Reset sizing classes
     dialog.classList.remove('preview-large', 'preview-compact');

package/src/app.js

@@ -0,0 +1,110 @@
+import express from "express";
+import path from "path";
+import { fileURLToPath } from "url";
+import { engine } from "express-handlebars";
+import compression from "compression";
+import mbkautheRoutes from "mbkauthe";
+import { generalLimiter } from "./middleware/rate-limiter.js";
+import { notFoundHandler, globalErrorHandler } from "./middleware/error-handler.js";
+import bucketRoutes from "./routes/index.js";
+import { packageJson } from "./config/index.js";
+import { createLogger } from "./utils/logger.js";
+
+const debugServer = createLogger('server');
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const isDevMode = process.env.NODE_ENV === "dev";
+
+/**
+ * Creates and configures the Express application.
+ * @returns {express.Application}
+ */
+export function createApp() {
+  const server = express();
+  server.set('trust proxy', 1);
+
+  // Compression
+  server.use(compression());
+
+  // Body parsing
+  server.use(express.json({ limit: '10mb' }));
+  server.use(express.urlencoded({ extended: true, limit: '10mb' }));
+
+  // Static assets (CSS/JS for dashboard)
+  const dashboardAssetCacheControl = 'public, max-age=300, must-revalidate';
+  const serveAsset = (filename) => (req, res) => {
+    res.set('Cache-Control', dashboardAssetCacheControl);
+    res.sendFile(path.join(__dirname, '..', 'public', filename), (err) => {
+      if (err) res.status(err.status || 404).end();
+    });
+  };
+
+  server.get('/mbkbucket/bucketadmin.css', serveAsset('bucketadmin.css'));
+  server.get('/mbkbucket/bucketadmin.js', serveAsset('bucketadmin.js'));
+
+  // Handlebars configuration
+  server.engine("handlebars", engine({
+    extname: ".handlebars",
+    defaultLayout: "main",
+    layoutsDir: path.join(__dirname, "..", "views", "layouts"),
+    partialsDir: [
+      path.join(__dirname, "..", "views", "templates"),
+      path.join(__dirname, "..", "views", "templates", "notice"),
+      path.join(__dirname, "..", "views"),
+      path.join(__dirname, "..", "views", "partial"),
+      path.join(__dirname, "..", "node_modules", "mbkauthe", "views"),
+      path.join(__dirname, "..", "..", "mbkauthe", "views")
+    ],
+    cache: process.env.NODE_ENV === "production",
+    helpers: {
+      eq: function (a, b) {
+        return a === b;
+      },
+      mbkbucket_cachebuster: function () {
+        return "?v=" + packageJson.version;
+      }
+    }
+  }));
+
+  server.set("view engine", "handlebars");
+  server.set("views", [
+    path.join(__dirname, "..", "views"),
+    path.join(__dirname, "..", "node_modules", "mbkauthe", "views"),
+    path.join(__dirname, "..", "..", "mbkauthe", "views")
+  ]);
+
+  // Auth routes
+  server.use(mbkautheRoutes);
+
+  // Rate limiting
+  server.use(generalLimiter);
+
+  // Bucket routes
+  server.use(bucketRoutes);
+
+  // Dev-mode request timing
+  if (isDevMode) {
+    debugServer("Dev mode is enabled. Starting server in dev mode.");
+
+    server.use((req, res, next) => {
+      const start = process.hrtime();
+      res.on('finish', () => {
+        const diff = process.hrtime(start);
+        const ms = diff[0] * 1000 + diff[1] / 1e6;
+        debugServer("[%s] %s %s %s - %s ms", new Date().toISOString(), req.method, req.originalUrl, res.statusCode, ms.toFixed(3));
+      });
+      next();
+    });
+
+    server.get("/", async (req, res) => {
+      res.redirect("/mbkbucket");
+    });
+  }
+
+  // Error handlers
+  server.use(notFoundHandler);
+  server.use(globalErrorHandler);
+
+  return server;
+}

package/src/cli/auth-helper.js

@@ -0,0 +1,223 @@
+/**
+ * CLI Authentication Helper
+ *
+ * Handles mbkauthe device-flow login for the mbkbucket CLI.
+ * Stores credentials in ~/.mbkbucket/config.json
+ */
+
+import fs from 'node:fs';
+import path from 'node:path';
+import os from 'node:os';
+import { createLogger } from '../utils/logger.js';
+
+const debugCli = createLogger('cli:auth');
+
+export const CONFIG_DIR = path.join(os.homedir(), '.mbkbucket');
+export const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+const POLL_INTERVAL_MS = 5000;
+const MAX_POLL_TIME_MS = 15 * 60 * 1000; // 15 minutes
+
+/**
+ * Read the stored CLI config.
+ * @returns {{ token?: string, tokenPrefix?: string, username?: string, serverUrl?: string, profile?: object }}
+ */
+export function readConfig() {
+  try {
+    if (!fs.existsSync(CONFIG_FILE)) return {};
+    const raw = fs.readFileSync(CONFIG_FILE, 'utf-8');
+    return JSON.parse(raw);
+  } catch (err) {
+    debugCli('Failed to read config: %s', err.message);
+    return {};
+  }
+}
+
+/**
+ * Write config to disk.
+ * @param {object} config
+ */
+export function writeConfig(config) {
+  try {
+    if (!fs.existsSync(CONFIG_DIR)) {
+      fs.mkdirSync(CONFIG_DIR, { recursive: true });
+    }
+    fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), { mode: 0o600 });
+  } catch (err) {
+    console.error(`❌ Failed to write config: ${err.message}`);
+    throw err;
+  }
+}
+
+/**
+ * Clear stored credentials (logout).
+ */
+export function clearConfig() {
+  try {
+    if (fs.existsSync(CONFIG_FILE)) {
+      fs.unlinkSync(CONFIG_FILE);
+    }
+    return true;
+  } catch (err) {
+    debugCli('Failed to clear config: %s', err.message);
+    return false;
+  }
+}
+
+/**
+ * Merge partial config into stored config.
+ * @param {object} partial
+ */
+export function updateConfig(partial) {
+  const current = readConfig();
+  const updated = { ...current, ...partial };
+  writeConfig(updated);
+  return updated;
+}
+
+/**
+ * Check if the user is logged in (has a stored token).
+ */
+export function isLoggedIn() {
+  const cfg = readConfig();
+  return !!(cfg.token && cfg.serverUrl);
+}
+
+/**
+ * Get the stored API token.
+ */
+export function getStoredToken() {
+  return readConfig().token || null;
+}
+
+/**
+ * Get the stored server URL.
+ */
+export function getStoredServerUrl() {
+  return readConfig().serverUrl || null;
+}
+
+/**
+ * Perform a device-flow login against an mbkauthe-powered server.
+ *
+ * @param {{ serverUrl: string, profileKey?: string }} options
+ * @returns {Promise<{ token: string, tokenPrefix: string, username: string, profile: object }>}
+ */
+export async function deviceFlowLogin({ serverUrl, profileKey }) {
+  const baseUrl = String(serverUrl).replace(/\/+$/, '');
+
+  // --- Step 1: Request a device code ---
+  console.log(`🔑 Requesting device login from ${baseUrl} ...`);
+
+  let deviceResp;
+  try {
+    const res = await fetch(`${baseUrl}/api/cli/device`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        clientName: `mbkbucket-cli-${os.hostname()}`,
+        ...(profileKey ? { profileKey } : {}),
+      }),
+    });
+
+    deviceResp = await res.json();
+
+    if (!deviceResp.success) {
+      throw new Error(deviceResp.message || 'Failed to initiate device login');
+    }
+  } catch (err) {
+    if (err.message.includes('Failed to initiate') || err.message.includes('fetch')) {
+      throw new Error(
+        `Could not reach mbkauthe server at ${baseUrl}/api/cli/device.\n` +
+        `Verify the server URL and that CLI_AUTH_ENABLED=true on the server.`
+      );
+    }
+    throw err;
+  }
+
+  const {
+    verificationUrl,
+    userCode,
+    deviceCode,
+    expiresIn,
+    interval,
+    profile,
+  } = deviceResp;
+
+  // --- Step 2: Prompt user to approve ---
+  console.log('');
+  console.log('┌─────────────────────────────────────────────────────────┐');
+  console.log('│                                                         │');
+  console.log(`│   🌐 Open this URL in your browser to approve:           │`);
+  console.log(`│   ${verificationUrl.padEnd(53)}│`);
+  console.log(`│                                                         │`);
+  console.log(`│   🔢 Or enter this code:  ${userCode.padEnd(30)}│`);
+  console.log('│                                                         │');
+  console.log('└─────────────────────────────────────────────────────────┘');
+  console.log('');
+
+  if (profile) {
+    console.log(`   Profile: ${profile.name} (scope: ${profile.scope || 'full'})`);
+  }
+  console.log(`   Waiting for approval (expires in ${Math.floor(expiresIn / 60)} minutes)...`);
+  console.log('');
+
+  // --- Step 3: Poll for token ---
+  const pollInterval = (interval || 5) * 1000;
+  const deadline = Date.now() + MAX_POLL_TIME_MS;
+  let attempts = 0;
+
+  while (Date.now() < deadline) {
+    await sleep(pollInterval);
+    attempts++;
+
+    try {
+      const pollRes = await fetch(`${baseUrl}/api/cli/device/token`, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ deviceCode }),
+      });
+
+      const pollBody = await pollRes.json();
+
+      if (pollBody.status === 'approved' && pollBody.success) {
+        console.log(`✅ Login approved! Welcome, ${pollBody.username}.`);
+        console.log(`   Token prefix: ${pollBody.tokenPrefix}...`);
+        return {
+          token: pollBody.token,
+          tokenPrefix: pollBody.tokenPrefix,
+          username: pollBody.username,
+          profile: profile || null,
+        };
+      }
+
+      if (pollBody.status === 'denied') {
+        throw new Error('Login request was denied.');
+      }
+
+      if (pollBody.status === 'expired') {
+        throw new Error('Login request expired. Please try again.');
+      }
+
+      if (pollBody.status === 'completed') {
+        throw new Error('This login session has already been completed.');
+      }
+
+      // Still pending — show a dot every 5 polls
+      if (attempts % 5 === 0) {
+        process.stdout.write('.');
+      }
+    } catch (err) {
+      if (err.message.includes('denied') || err.message.includes('expired') || err.message.includes('completed')) {
+        throw err;
+      }
+      // Network errors during poll — retry
+      debugCli('Poll error (will retry): %s', err.message);
+    }
+  }
+
+  throw new Error('Login timed out. Please try again.');
+}
+
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}