mbkbucket 3.3.0 → 3.3.2

package/index.d.ts

@@ -1,444 +0,0 @@
-// Type definitions for mbkbucket
-// Project: https://github.com/MIbnEKhalid/mbkbucket
-
-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 type BucketConnectionMap = Record<string, BucketConfig>;
-
-export interface S3ObjectResult {
-  Body: Readable;
-  ContentLength?: number;
-  ContentType?: string;
-  LastModified?: Date;
-  Key?: string;
-  [key: string]: any;
-}
-
-export interface UploadOptions {
-  metadata?: Record<string, string>;
-  cacheControl?: string;
-  storageClass?: string;
-  serverSideEncryption?: string;
-  bucketName?: string;
-  preventOverwrite?: boolean;
-  [key: string]: any;
-}
-
-export interface ListFilesOptions {
-  maxKeys?: number;
-  continuationToken?: string | null;
-  delimiter?: string | null;
-  fetchOwner?: boolean;
-  startAfter?: string | null;
-  bucketName?: string;
-  [key: string]: any;
-}
-
-export interface ListFilesResult extends Record<string, any> {
-  requestedAt: string;
-  totalFiles: number;
-  hasMore: boolean;
-  nextToken: string | null;
-}
-
-export interface IncompleteMultipartUpload {
-  Key?: string;
-  UploadId?: string;
-  Initiated?: string;
-  Initiator?: { DisplayName?: string; [key: string]: any };
-  [key: string]: any;
-}
-
-export interface CleanupResult {
-  abortedCount: number;
-  uploads: Array<{ key: string; uploadId: string; initiated?: string }>;
-  cleanedAt?: string;
-  [key: string]: any;
-}
-
-export interface ConfigVars {
-  publiView_enabled: boolean;
-  p_view_inline: boolean;
-  [key: string]: any;
-}
-
-/**
- * S3 exports (re-exported from lib/s3.js at package root)
- */
-export function getAvailableBucketNames(): string[];
-export function resolveBucketName(bucketName?: string | null): string;
-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 checkHealth(): Promise<{ status: string; responseTime?: number; bucket?: string; error?: string; checkedAt: string; region?: string; }>;
-
-export function uploadFile(
-  key: string,
-  fileBuffer: Buffer | Uint8Array,
-  contentType: string,
-  options?: UploadOptions
-): 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 deleteFolder(prefix: string, bucketName?: string): Promise<{
-  results?: any[];
-  deletedCount: number;
-  errors?: any[];
-  deletedAt: string;
-  prefix?: string;
-}>;
-
-export function listfiles(prefix?: string, options?: ListFilesOptions): Promise<ListFilesResult>;
-
-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,
-  bucketName?: string
-): Promise<{
-  url: string;
-  key: string;
-  operation: string;
-  expiresIn: number;
-  expiresAt: string;
-  generatedAt: string;
-}>;
-
-export function createMultipartUpload(
-  key: string,
-  contentType?: string,
-  metadata?: Record<string, string>,
-  bucketName?: string
-): Promise<{ uploadId: string; key: string }>;
-
-export function uploadPart(
-  key: string,
-  uploadId: string,
-  partNumber: number,
-  buffer: Buffer | Uint8Array,
-  bucketName?: string
-): Promise<{ ETag: string; partNumber: number }>;
-
-export function completeMultipartUpload(
-  key: string,
-  uploadId: string,
-  parts: Array<{ partNumber: number; ETag: string }>,
-  bucketName?: string
-): Promise<{ key: string }>;
-
-export function abortMultipartUpload(
-  key: string,
-  uploadId: string,
-  bucketName?: string
-): Promise<{ key: string; abortedAt: string }>;
-
-export function listIncompleteMultipartUploads(
-  prefix?: string,
-  bucketName?: string
-): Promise<IncompleteMultipartUpload[]>;
-
-export function cleanupIncompleteMultipartUploads(
-  olderThanDays?: number,
-  prefix?: string,
-  bucketName?: string
-): Promise<CleanupResult>;
-
-/**
- * Config exports (re-exported from lib/config/index.js at package root)
- */
-export const packageJson: Record<string, any>;
-export const appVersion: string;
-export const mbkbucketVar: ConfigVars;
-export function getLatestVersion(): Promise<string | null>;
-export function checkVersion(): Promise<void>;
-export function parseAndValidateMbkbucketVar(rawValue?: string): ConfigVars;
-export function parseAndValidateBucketConnection(rawValue?: string): BucketConnectionMap | null;
-
-/**
- * Router export (re-exported from lib/routes/index.js at package root as `bucket`)
- */
-export const bucket: Router;
-
-/**
- * Root default export from index.js: configured Express application
- */
-declare const server: Application;
-export default server;
-
-/**
- * Subpath module declarations
- */
-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 type BucketConnectionMap = Record<string, BucketConfig>;
-
-  export interface S3ObjectResult {
-    Body: Readable;
-    ContentLength?: number;
-    ContentType?: string;
-    LastModified?: Date;
-    Key?: string;
-    [key: string]: any;
-  }
-
-  export interface UploadOptions {
-    metadata?: Record<string, string>;
-    cacheControl?: string;
-    storageClass?: string;
-    serverSideEncryption?: string;
-    bucketName?: string;
-    preventOverwrite?: boolean;
-    [key: string]: any;
-  }
-
-  export interface ListFilesOptions {
-    maxKeys?: number;
-    continuationToken?: string | null;
-    delimiter?: string | null;
-    fetchOwner?: boolean;
-    startAfter?: string | null;
-    bucketName?: string;
-    [key: string]: any;
-  }
-
-  export interface ListFilesResult extends Record<string, any> {
-    requestedAt: string;
-    totalFiles: number;
-    hasMore: boolean;
-    nextToken: string | null;
-  }
-
-  export interface IncompleteMultipartUpload {
-    Key?: string;
-    UploadId?: string;
-    Initiated?: string;
-    Initiator?: { DisplayName?: string; [key: string]: any };
-    [key: string]: any;
-  }
-
-  export interface CleanupResult {
-    abortedCount: number;
-    uploads: Array<{ key: string; uploadId: string; initiated?: string }>;
-    cleanedAt?: string;
-    [key: string]: any;
-  }
-
-  export function getAvailableBucketNames(): string[];
-  export function resolveBucketName(bucketName?: string | null): string;
-  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 checkHealth(): Promise<{ status: string; responseTime?: number; bucket?: string; error?: string; checkedAt: string; region?: string; }>;
-
-  export function uploadFile(
-    key: string,
-    fileBuffer: Buffer | Uint8Array,
-    contentType: string,
-    options?: UploadOptions
-  ): 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 deleteFolder(prefix: string, bucketName?: string): Promise<{
-    results?: any[];
-    deletedCount: number;
-    errors?: any[];
-    deletedAt: string;
-    prefix?: string;
-  }>;
-
-  export function listfiles(prefix?: string, options?: ListFilesOptions): Promise<ListFilesResult>;
-
-  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,
-    bucketName?: string
-  ): Promise<{
-    url: string;
-    key: string;
-    operation: string;
-    expiresIn: number;
-    expiresAt: string;
-    generatedAt: string;
-  }>;
-
-  export function createMultipartUpload(
-    key: string,
-    contentType?: string,
-    metadata?: Record<string, string>,
-    bucketName?: string
-  ): Promise<{ uploadId: string; key: string }>;
-
-  export function uploadPart(
-    key: string,
-    uploadId: string,
-    partNumber: number,
-    buffer: Buffer | Uint8Array,
-    bucketName?: string
-  ): Promise<{ ETag: string; partNumber: number }>;
-
-  export function completeMultipartUpload(
-    key: string,
-    uploadId: string,
-    parts: Array<{ partNumber: number; ETag: string }>,
-    bucketName?: string
-  ): Promise<{ key: string }>;
-
-  export function abortMultipartUpload(
-    key: string,
-    uploadId: string,
-    bucketName?: string
-  ): Promise<{ key: string; abortedAt: string }>;
-
-  export function listIncompleteMultipartUploads(
-    prefix?: string,
-    bucketName?: string
-  ): Promise<IncompleteMultipartUpload[]>;
-
-  export function cleanupIncompleteMultipartUploads(
-    olderThanDays?: number,
-    prefix?: string,
-    bucketName?: string
-  ): Promise<CleanupResult>;
-}
-
-declare module "mbkbucket/lib/config/index" {
-  export interface ConfigVars {
-    publiView_enabled: boolean;
-    p_view_inline: boolean;
-    [key: string]: any;
-  }
-
-  export interface BucketConfig {
-    BUCKET_NAME: string;
-    ENDPOINT?: string;
-    ACCESS_KEY_ID?: string;
-    SECRET_ACCESS_KEY?: string;
-    region?: string;
-    [key: string]: any;
-  }
-
-  export type BucketConnectionMap = Record<string, BucketConfig>;
-
-  export const packageJson: Record<string, any>;
-  export const appVersion: string;
-  export const mbkbucketVar: ConfigVars;
-  export function getLatestVersion(): Promise<string | null>;
-  export function checkVersion(): Promise<void>;
-  export function parseAndValidateMbkbucketVar(rawValue?: string): ConfigVars;
-  export function parseAndValidateBucketConnection(rawValue?: string): BucketConnectionMap | null;
-}
-
-declare module "mbkbucket/lib/config/validation" {
-  export function normalizeBooleanLike(value: any): any;
-  export function parseAndValidateMbkbucketVar(rawValue?: string): { [key: string]: any };
-  export function parseAndValidateBucketConnection(rawValue?: string): Record<string, any> | null;
-}
-
-declare module "mbkbucket/lib/routes/index" {
-  import { Router } from "express";
-  const router: Router;
-  export default router;
-}
-
-declare module "mbkbucket/lib/bucket" {
-  import { Router } from "express";
-  const router: Router;
-  export default router;
-}

package/lib/index.js

@@ -1,17 +0,0 @@
-// 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 '../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 = {
-  ...s3,
-  ...config,
-  bucket,
-};
-
-export default defaultExport;

package/src/config/index.js

@@ -1,133 +0,0 @@
-import { createRequire } from "module";
-import dotenv from "dotenv";
-import { parseAndValidateMbkbucketVar, parseAndValidateBucketConnection } from "./validation.js";
-import { createLogger } from "../utils/logger.js";
-
-dotenv.config();
-const debugConfig = createLogger('config');
-
-// Load package.json from mbkbucket package (not parent project)
-const require = createRequire(import.meta.url);
-let packageJson;
-try {
-    // Try to load from mbkbucket package directory
-    packageJson = require("mbkbucket/package.json");
-} catch {
-    // Fallback to relative path (for development/testing)
-    packageJson = require("../../package.json");
-}
-
-// Parent project version
-let appVersion;
-try {
-    appVersion = require("../../../../package.json")?.version || "unknown";
-} catch {
-    // Fallback if path doesn't work
-    try {
-        appVersion = require(process.cwd() + "/package.json")?.version || "unknown";
-    } catch {
-        appVersion = "unknown";
-    }
-}
-
-function compareVersions(a, b) {
-    const left = String(a || '').split(/[.-]/).map((part) => parseInt(part, 10) || 0);
-    const right = String(b || '').split(/[.-]/).map((part) => parseInt(part, 10) || 0);
-    const length = Math.max(left.length, right.length);
-
-    for (let i = 0; i < length; i += 1) {
-        const diff = (left[i] || 0) - (right[i] || 0);
-        if (diff !== 0) return diff;
-    }
-    return 0;
-}
-
-// Fetch latest version from GitHub
-async function getLatestVersion() {
-  try {
-    const response = await fetch('https://raw.githubusercontent.com/MIbnEKhalid/mbkbucket/master/package.json');
-    if (!response.ok) {
-      debugConfig('GitHub API responded with status %s', response.status);
-      return "0.0.0";
-    }
-
-    const latestPackageJson = await response.json();
-    return latestPackageJson.version;
-  } catch (error) {
-    debugConfig('Error fetching latest version from GitHub: %s', error.message);
-    return null;
-  }
-}
-
-// Version check with error handling
-async function checkVersion() {
-    try {
-        const latestVersion = await getLatestVersion();
-        if (latestVersion && compareVersions(latestVersion, packageJson.version) > 0) {
-            debugConfig('Current version (%s) is outdated. Latest version: %s.', packageJson.version, latestVersion);
-        } else if (latestVersion && compareVersions(latestVersion, packageJson.version) < 0) {
-            debugConfig('Current version (%s) is newer than published version: %s.', packageJson.version, latestVersion);
-        } else if (latestVersion) {
-            debugConfig('Running latest version (%s).', packageJson.version);
-        }
-    } catch (error) {
-        debugConfig('Failed to check for updates: %s', error.message);
-    }
-}
-
-// Comprehensive validation function
-function validateConfiguration() {
-    try {
-        const parsed = parseAndValidateMbkbucketVar(process.env.mbkbucketVar);
-        if (!process.env.mbkbucketVar) {
-            debugConfig('mbkbucketVar not defined, using defaults');
-        }
-        debugConfig('Configuration loaded');
-        return parsed;
-    } catch (error) {
-        throw new Error(`[mbkbucket] Configuration Validation Failed:\n  - ${error.message}`);
-    }
-}
-
-// Validate BucketConnection configuration
-function validateBucketConnection() {
-    if (!process.env.BucketConnection) {
-        console.warn(`[mbkbucket] ⚠️  BucketConnection not configured. You need to set this environment variable.`);
-        console.warn(`[mbkbucket] Example format:`);
-        console.warn(`[mbkbucket] BucketConnection={"r2":{"BUCKET_NAME":"my-bucket","ACCESS_KEY_ID":"key","SECRET_ACCESS_KEY":"secret","ENDPOINT":"https://..."}}`);
-        return;
-    }
-
-    try {
-        parseAndValidateBucketConnection(process.env.BucketConnection);
-        debugConfig('BucketConnection configuration validated successfully');
-    } catch (error) {
-        throw new Error(`[mbkbucket] BucketConnection validation failed:\n  - ${error.message}`);
-    }
-}
-
-// Validate all configuration at startup
-function validateAllConfiguration() {
-    try {
-        validateConfiguration();
-        validateBucketConnection();
-        debugConfig('All configurations validated successfully');
-        return true;
-    } catch (error) {
-        console.error(error.message);
-        return false;
-    }
-}
-
-const mbkbucketVar = validateConfiguration();
-
-export {
-    packageJson,
-    appVersion,
-    mbkbucketVar,
-    checkVersion,
-    getLatestVersion,
-    validateConfiguration,
-    validateBucketConnection,
-    validateAllConfiguration
-};

package/src/routes/api.routes.js

@@ -1,66 +0,0 @@
-import express from "express";
-import { sessRole } from "mbkauthe";
-import multer from "multer";
-import { requireBucketApi } from "../middleware/bucket-resolver.js";
-import {
-  cleanupUploads, listIncompleteUploads, listFiles,
-  uploadSingleFile, initiateMultipartUpload, uploadChunk,
-  completeUpload, abortUpload, createFolder, deleteItems,
-  downloadFileHandler
-} from "../controllers/api.controller.js";
-
-const router = express.Router();
-
-const MAX_CHUNK_SIZE = 50 * 1024 * 1024; // 50 MB
-
-const upload = multer({
-  storage: multer.memoryStorage(),
-  limits: { fileSize: MAX_CHUNK_SIZE }
-});
-
-const uploadChunkMiddleware = (req, res, next) => {
-  upload.single('chunk')(req, res, (err) => {
-    if (err) {
-      if (err.code === 'LIMIT_FILE_SIZE') {
-        return res.status(413).json({
-          success: false,
-          error: `Chunk too large (max ${Math.round(MAX_CHUNK_SIZE / (1024 * 1024))} MB).`,
-        });
-      }
-      return next(err);
-    }
-    next();
-  });
-};
-
-// Bucket guard for all API routes
-router.use(requireBucketApi);
-
-// Multipart upload cleanup
-router.post('/api/cleanup-uploads', sessRole('SuperAdmin'), cleanupUploads);
-
-// List incomplete multipart uploads
-router.get('/api/incomplete-uploads', sessRole('SuperAdmin'), listIncompleteUploads);
-
-// List files
-router.get('/api/files', sessRole('SuperAdmin'), listFiles);
-
-// Single-file upload
-router.post('/upload', sessRole('SuperAdmin'), upload.single('file'), uploadSingleFile);
-
-// Multipart upload flow
-router.post('/upload-init', sessRole('SuperAdmin'), initiateMultipartUpload);
-router.post('/upload-chunk', sessRole('SuperAdmin'), uploadChunkMiddleware, uploadChunk);
-router.post('/upload-complete', sessRole('SuperAdmin'), completeUpload);
-router.post('/upload-abort', sessRole('SuperAdmin'), abortUpload);
-
-// Folder operations
-router.post('/create-folder', sessRole('SuperAdmin'), createFolder);
-
-// Delete operations
-router.post('/delete', sessRole('SuperAdmin'), deleteItems);
-
-// Download
-router.get('/download/*key', sessRole('SuperAdmin'), downloadFileHandler);
-
-export default router;