mbkbucket 1.0.2 → 1.1.0

package/.env.example

@@ -1,3 +1,10 @@
 mbkbucketVar={"APP_NAME":"mbkbucket","loginRedirectURL":"/dashboard","bucket":""}
 mbkauthShared={"Main_SECRET_TOKEN": 123,"DOMAIN":"mbktech.org","IS_DEPLOYED":"false","EncPass":"false","DEVICE_TRUST_DURATION_DAYS":7,"SESSION_SECRET_KEY":"123","LOGIN_DB":"postgres://","MBKAUTH_TWO_FA_ENABLE":"true","COOKIE_EXPIRE_TIME":2,"GITHUB_LOGIN_ENABLED":"f","GITHUB_CLIENT_ID":"123","GITHUB_CLIENT_SECRET":"123","GOOGLE_LOGIN_ENABLED":"f","GOOGLE_CLIENT_ID":"123","GOOGLE_CLIENT_SECRET":"123"}
-# See @node_modules/mbkauthe/docs/env.md for more details
+# See @node_modules/mbkauthe/docs/env.md for more details
+NODE_ENV=development
+
+R2_Bucket={"BUCKET_NAME":"","ACCESS_KEY_ID":"","SECRET_ACCESS_KEY":"","ENDPOINT":""}
+E2_Bucket={"BUCKET_NAME":"","ACCESS_KEY_ID":"","SECRET_ACCESS_KEY":"","ENDPOINT":"","Region":"ap-southeast-1"}
+# Region is optional
+
+PORT=3005

package/README.md

@@ -3,4 +3,10 @@
 [![Version](https://img.shields.io/npm/v/mbkbucket.svg)](https://www.npmjs.com/package/mbkbucket)
 [![License](https://img.shields.io/badge/License-GPL--2.0-blue.svg)](LICENSE)
 [![Node.js](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen.svg)](https://nodejs.org/)
-[![Publish](https://github.com/MIbnEKhalid/mbkbucket/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/MIbnEKhalid/mbkbucket/actions/workflows/publish.yml)
+[![Publish](https://github.com/MIbnEKhalid/mbkbucket/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/MIbnEKhalid/mbkbucket/actions/workflows/publish.yml)
+
+## Contact
+
+For questions or contributions, please contact Muhammad Bin Khalid at [mbktechstudio.com/Support](https://mbktechstudio.com/Support/?Project=MIbnEKhalidWeb), [support@mbktechstudio.com](mailto:support@mbktechstudio.com) or [chmuhammadbinkhalid28@gmail.com](mailto:chmuhammadbinkhalid28@gmail.com). 
+
+Developed by [Muhammad Bin Khalid](https://github.com/MIbnEKhalid) at [MBK Tech Studio](https://mbktech.org/).

package/index.d.ts

@@ -1,6 +1,237 @@
-// Type definitions for mbkbucket
+// Type definitions for mbkbucket 1.1.0
 // Project: https://github.com/MIbnEKhalid/mbkbucket
-// Definitions by: Muhammad Bin Khalid <https://github.com/MIbnEKhalid>
+// Definitions by: Muhammad Bin Khalid <https://github.com/MIbnEKhalid">
 
-import { Request, Response, NextFunction, Router } from 'express';
-import { Pool } from 'pg';
+import { Readable } from "stream";
+import { Router, Application } from "express";
+
+/**
+ * Shared types used across the package
+ */
+export interface BucketConfig {
+  BUCKET_NAME: string;
+  ENDPOINT?: string;
+  ACCESS_KEY_ID?: string;
+  SECRET_ACCESS_KEY?: string;
+  region?: string;
+  [key: string]: any;
+}
+
+export interface S3ObjectResult {
+  Body: Readable;
+  ContentLength?: number;
+  ContentType?: string;
+  LastModified?: Date;
+  Key?: string;
+  [key: string]: any;
+}
+
+/**
+ * S3-related functions (available from `mbkbucket/lib/s3` and re-exported at package root)
+ */
+export function getBucketConfig(bucketName?: string): BucketConfig;
+export const bucketClient: any;
+export function getAppName(): string;
+export function ensureKeyHasAppPrefix(key?: string): string;
+export function ensurePrefix(prefix?: string): string;
+export function getBucketClient(bucketName?: string): any;
+export function checkR2Health(): Promise<{ status: string; responseTime?: number; bucket?: string; error?: string; checkedAt: string; region?: string }>;
+
+export function uploadFile(
+  key: string,
+  fileBuffer: Buffer | Uint8Array,
+  contentType: string,
+  options?: {
+    metadata?: Record<string, string>;
+    cacheControl?: string;
+    storageClass?: string;
+    serverSideEncryption?: string;
+    bucketName?: string;
+    [key: string]: any;
+  }
+): Promise<{ fileSize?: number; key: string; contentType?: string; uploadedAt?: string } & Record<string, any>>;
+
+export function downloadFile(
+  key: string,
+  options?: {
+    range?: string | null;
+    ifNoneMatch?: string | null;
+    ifModifiedSince?: Date | string | null;
+    responseCacheControl?: string | null;
+    responseContentType?: string | null;
+    bucketName?: string;
+    [key: string]: any;
+  }
+): Promise<S3ObjectResult>;
+
+export function deleteFile(key: string, bucketName?: string): Promise<{ key: string; deletedAt?: string } & Record<string, any>>;
+
+export function deleteFiles(keys: string[], bucketName?: string): Promise<{
+  results: any[];
+  deletedCount: number;
+  errors: any[];
+  deletedAt: string;
+}>;
+
+export function listfiles(
+  prefix?: string,
+  options?: {
+    maxKeys?: number;
+    continuationToken?: string | null;
+    delimiter?: string | null;
+    fetchOwner?: boolean;
+    startAfter?: string | null;
+    bucketName?: string;
+    [key: string]: any;
+  }
+): Promise<Record<string, any>>;
+
+export function getFileMetadata(key: string, bucketName?: string): Promise<{
+  key: string;
+  exists: boolean;
+  queriedAt: string;
+  ContentLength?: number;
+  ContentType?: string;
+  LastModified?: Date;
+  [key: string]: any;
+}>;
+
+export function fileExists(key: string, bucketName?: string): Promise<boolean>;
+export function getFileSize(key: string, bucketName?: string): Promise<number | null>;
+
+export function generateSignedUrl(
+  key: string,
+  operation?: 'getObject' | 'putObject' | string,
+  expiresIn?: number
+): Promise<{
+  url: string;
+  key: string;
+  operation: string;
+  expiresIn: number;
+  expiresAt: string;
+  generatedAt: string;
+}>;
+
+/**
+ * Exported router from `lib/bucket` (re-exported at package root as `bucket`)
+ */
+export const bucket: Router;
+
+/**
+ * Root default export: the configured Express application
+ */
+declare const server: Application;
+export default server;
+
+/**
+ * Module declarations for subpath imports so TypeScript consumers can import:
+ * import { uploadFile } from 'mbkbucket/lib/s3';
+ * import { packageJson } from 'mbkbucket/lib/config/index';
+ * import bucketRouter from 'mbkbucket/lib/bucket';
+ */
+declare module "mbkbucket/lib/s3" {
+  import { Readable } from "stream";
+  export interface BucketConfig {
+    BUCKET_NAME: string;
+    ENDPOINT?: string;
+    ACCESS_KEY_ID?: string;
+    SECRET_ACCESS_KEY?: string;
+    region?: string;
+    [key: string]: any;
+  }
+  export interface S3ObjectResult {
+    Body: Readable;
+    ContentLength?: number;
+    ContentType?: string;
+    LastModified?: Date;
+    Key?: string;
+    [key: string]: any;
+  }
+  export function getBucketConfig(bucketName?: string): BucketConfig;
+  export const bucketClient: any;
+  export function getAppName(): string;
+  export function ensureKeyHasAppPrefix(key?: string): string;
+  export function ensurePrefix(prefix?: string): string;
+  export function getBucketClient(bucketName?: string): any;
+  export function checkR2Health(): Promise<{ status: string; responseTime?: number; bucket?: string; error?: string; checkedAt: string; region?: string }>;
+  export function uploadFile(
+    key: string,
+    fileBuffer: Buffer | Uint8Array,
+    contentType: string,
+    options?: {
+      metadata?: Record<string, string>;
+      cacheControl?: string;
+      storageClass?: string;
+      serverSideEncryption?: string;
+      bucketName?: string;
+      [key: string]: any;
+    }
+  ): Promise<{ fileSize?: number; key: string; contentType?: string; uploadedAt?: string } & Record<string, any>>;
+  export function downloadFile(
+    key: string,
+    options?: {
+      range?: string | null;
+      ifNoneMatch?: string | null;
+      ifModifiedSince?: Date | string | null;
+      responseCacheControl?: string | null;
+      responseContentType?: string | null;
+      bucketName?: string;
+      [key: string]: any;
+    }
+  ): Promise<S3ObjectResult>;
+  export function deleteFile(key: string, bucketName?: string): Promise<{ key: string; deletedAt?: string } & Record<string, any>>;
+  export function deleteFiles(keys: string[], bucketName?: string): Promise<{
+    results: any[];
+    deletedCount: number;
+    errors: any[];
+    deletedAt: string;
+  }>;
+  export function listfiles(
+    prefix?: string,
+    options?: {
+      maxKeys?: number;
+      continuationToken?: string | null;
+      delimiter?: string | null;
+      fetchOwner?: boolean;
+      startAfter?: string | null;
+      bucketName?: string;
+      [key: string]: any;
+    }
+  ): Promise<Record<string, any>>;
+  export function getFileMetadata(key: string, bucketName?: string): Promise<{
+    key: string;
+    exists: boolean;
+    queriedAt: string;
+    ContentLength?: number;
+    ContentType?: string;
+    LastModified?: Date;
+    [key: string]: any;
+  }>;
+  export function fileExists(key: string, bucketName?: string): Promise<boolean>;
+  export function getFileSize(key: string, bucketName?: string): Promise<number | null>;
+  export function generateSignedUrl(
+    key: string,
+    operation?: 'getObject' | 'putObject' | string,
+    expiresIn?: number
+  ): Promise<{
+    url: string;
+    key: string;
+    operation: string;
+    expiresIn: number;
+    expiresAt: string;
+    generatedAt: string;
+  }>;
+}
+
+declare module "mbkbucket/lib/config/index" {
+  export const packageJson: Record<string, any>;
+  export const appVersion: string;
+  export function getLatestVersion(): Promise<string | null>;
+  export function checkVersion(): Promise<void>;
+}
+
+declare module "mbkbucket/lib/bucket" {
+  import { Router } from "express";
+  const router: Router;
+  export default router;
+}

package/index.js

@@ -1,9 +1,198 @@
+import express from "express";
+import path from "path";
+import dotenv from "dotenv";
+import { fileURLToPath } from "url";
+import mbkauthe from "mbkauthe";
+import { engine } from "express-handlebars";
+import compression from "compression";
+import rateLimit from 'express-rate-limit';
+import bucket from "./lib/bucket.js";
 import { checkVersion } from "./lib/config/index.js";
 
+dotenv.config();
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+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 });
+  }
+});
+
+server.use(express.json());
+server.use(express.urlencoded({ extended: true }));
+
+// Configure Handlebars (single setup)
+server.engine("handlebars", engine({
+  extname: ".handlebars",
+  defaultLayout: "main",
+  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"),
+  ],
+  cache: process.env.NODE_ENV === "production",
+  helpers: {
+    formatDate: (date) => {
+      return new Date(date).toLocaleString('en-US', {
+        year: 'numeric',
+        month: 'long',
+        day: 'numeric',
+        hour: '2-digit',
+        minute: '2-digit',
+        second: '2-digit',
+        hour12: true
+      });
+    },
+    in: function (value, list) {
+      if (!list || !Array.isArray(list)) return false;
+      return list.includes(parseInt(value) || value);
+    },
+    trim: function (str) {
+      return str ? str.trim() : '';
+    },
+    eq: function (a, b) {
+      return a === b;
+    },
+    encodeURIComponent: function (str) {
+      return encodeURIComponent(str);
+    },
+    formatTimestamp: function (timestamp) {
+      return new Date(timestamp).toLocaleString();
+    },
+    jsonStringify: function (context) {
+      return JSON.stringify(context);
+    },
+    truncate: (str, len) => {
+      if (!str) return '';
+      if (str.length > len) {
+        return str.substring(0, len) + '...';
+      }
+      return str;
+    },
+    section: function (name, options) {
+      if (!this._sections) this._sections = {};
+      this._sections[name] = options.fn(this);
+      return null;
+    },
+    getCanonicalUrl: function (req, path) {
+      const protocol = req.protocol || 'https';
+      const host = req.get('host') || 'blog.mbktechstudio.com';
+      return `${protocol}://${host}${path}`;
+    },
+    index: function (array, idx) {
+      return array ? array[idx] : null;
+    },
+    add: function (a, b) {
+      return Number(a) + Number(b);
+    },
+    subtract: function (a, b) {
+      return Number(a) - Number(b);
+    },
+    gt: function (a, b) {
+      return Number(a) > Number(b);
+    },
+    gte: function (a, b) {
+      return Number(a) >= Number(b);
+    },
+    lte: function (a, b) {
+      return Number(a) <= Number(b);
+    },
+    and: function () {
+      return Array.prototype.slice.call(arguments, 0, -1).every(Boolean);
+    },
+    or: function () {
+      return Array.prototype.slice.call(arguments, 0, -1).some(Boolean);
+    },
+    range: function (start, end) {
+      const result = [];
+      for (let i = start; i < end; i++) {
+        result.push(i);
+      }
+      return result;
+    }
+  }
+}));
+
+server.set("view engine", "handlebars");
+server.set("views", [
+  path.join(__dirname, "views"),
+  path.join(__dirname, "node_modules/mbkauthe/views"),
+]);
+
+server.use(mbkauthe);
+server.use(generalLimiter);
+server.use(bucket);
+
 if (process.env.test === "dev") {
-    console.log("[mbkbucket] Dev mode is enabled. Starting server in dev mode.");
+
+  console.log("[mbkbucket] 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;
+      console.log(`[mbkbucket] [${new Date().toISOString()}] ${req.method} ${req.originalUrl} ${res.statusCode} - ${ms.toFixed(3)} ms`);
+    });
+    next();
+  });
+
+  server.get("/", async (req, res) => {
+    res.redirect("/mbkbucket");
+  });
+
+  // 404 handler
+  server.use((req, res) => {
+    console.log(`[mbkbucket] Path not found: ${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 () => {
+    console.log(`[mbkbucket] Server running on http://localhost:${port}`);
+  });
+
 }
 
-if (process.env.test !== "dev") {
-    await checkVersion();
-}
+await checkVersion();
+
+
+export default server;