mbkbucket 1.4.0 → 1.5.0

package/.env.example

@@ -1,4 +1,4 @@
-mbkbucketVar={"APP_NAME":"mbkbucket","loginRedirectURL":"/dashboard","bucket":""}
+mbkautheVar={"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
 NODE_ENV=development

package/.github/PACKAGE.md

@@ -8,10 +8,6 @@ This package is published on npm: [mbkbucket](https://www.npmjs.com/package/mbkb
 npm install mbkbucket
 ```
 
-## Version
-
-Current Version: 1.0.0
-
 ## Registry
 
 Published to: npm Registry (https://registry.npmjs.org/)

package/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for mbkbucket 1.4.0
+// Type definitions for mbkbucket 1.5.0
 // Project: https://github.com/MIbnEKhalid/mbkbucket
 // Definitions by: Muhammad Bin Khalid <https://github.com/MIbnEKhalid">
 
@@ -26,6 +26,53 @@ export interface S3ObjectResult {
   [key: string]: any;
 }
 
+// Options passed to uploadFile
+export interface UploadOptions {
+  metadata?: Record<string, string>;
+  cacheControl?: string;
+  storageClass?: string;
+  serverSideEncryption?: string;
+  bucketName?: string;
+  preventOverwrite?: boolean; // added in 1.4.1
+  [key: string]: any;
+}
+
+// Options for listing files
+export interface ListFilesOptions {
+  maxKeys?: number;
+  continuationToken?: string | null;
+  delimiter?: string | null;
+  fetchOwner?: boolean;
+  startAfter?: string | null;
+  bucketName?: string;
+  [key: string]: any;
+}
+
+// Result returned from listfiles calls
+export interface ListFilesResult extends Record<string, any> {
+  requestedAt: string;
+  totalFiles: number;
+  hasMore: boolean;
+  nextToken: string | null;
+}
+
+// Incomplete multipart upload descriptor returned by AWS
+export interface IncompleteMultipartUpload {
+  Key?: string;
+  UploadId?: string;
+  Initiated?: string;
+  Initiator?: { DisplayName?: string; [key: string]: any };
+  [key: string]: any;
+}
+
+// Result returned by cleanupIncompleteMultipartUploads
+export interface CleanupResult {
+  abortedCount: number;
+  uploads: Array<{ key: string; uploadId: string; initiated?: string }>;
+  cleanedAt?: string;
+  [key: string]: any;
+}
+
 /**
  * S3-related functions (available from `mbkbucket/lib/s3` and re-exported at package root)
  */
@@ -41,14 +88,7 @@ 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;
-  }
+  options?: UploadOptions
 ): Promise<{ fileSize?: number; key: string; contentType?: string; uploadedAt?: string } & Record<string, any>>;
 
 export function downloadFile(
@@ -83,16 +123,8 @@ export function deleteFolder(prefix: string, bucketName?: string): Promise<{
 
 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>>;
+  options?: ListFilesOptions
+): Promise<ListFilesResult>;
 
 export function getFileMetadata(key: string, bucketName?: string): Promise<{
   key: string;
@@ -147,6 +179,17 @@ export function abortMultipartUpload(
   uploadId: 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>;
+
 /**
  * Configuration variables from mbkbucket
  */
@@ -193,6 +236,46 @@ declare module "mbkbucket/lib/s3" {
     Key?: string;
     [key: string]: any;
   }
+
+  // re-use shared interfaces defined at top of index.d.ts
+  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 getBucketConfig(bucketName?: string): BucketConfig;
   export const bucketClient: any;
   export function getAppName(): string;
@@ -200,19 +283,14 @@ declare module "mbkbucket/lib/s3" {
   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?: {
-      metadata?: Record<string, string>;
-      cacheControl?: string;
-      storageClass?: string;
-      serverSideEncryption?: string;
-      bucketName?: string;
-      [key: string]: any;
-    }
+    options?: UploadOptions
   ): Promise<{ fileSize?: number; key: string; contentType?: string; uploadedAt?: string } & Record<string, any>>;
+
   export function downloadFile(
     key: string,
     options?: {
@@ -225,6 +303,7 @@ declare module "mbkbucket/lib/s3" {
       [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[];
@@ -240,18 +319,12 @@ declare module "mbkbucket/lib/s3" {
     deletedAt: string;
     prefix?: 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>>;
+    options?: ListFilesOptions
+  ): Promise<ListFilesResult>;
+
   export function getFileMetadata(key: string, bucketName?: string): Promise<{
     key: string;
     exists: boolean;
@@ -261,6 +334,7 @@ declare module "mbkbucket/lib/s3" {
     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(
@@ -275,26 +349,41 @@ declare module "mbkbucket/lib/s3" {
     expiresAt: string;
     generatedAt: string;
   }>;
+
   export function createMultipartUpload(
     key: string,
     contentType?: string,
     metadata?: Record<string, string>
   ): Promise<{ uploadId: string; key: string }>;
+
   export function uploadPart(
     key: string,
     uploadId: string,
     partNumber: number,
     buffer: Buffer | Uint8Array
   ): Promise<{ ETag: string; partNumber: number }>;
+
   export function completeMultipartUpload(
     key: string,
     uploadId: string,
     parts: Array<{ partNumber: number; ETag: string }>
   ): Promise<{ key: string }>;
+
   export function abortMultipartUpload(
     key: string,
     uploadId: 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" {

package/index.js

@@ -6,7 +6,7 @@ import mbkautheRoutes from "mbkauthe";
 import { engine } from "express-handlebars";
 import compression from "compression";
 import rateLimit from 'express-rate-limit';
-import bucketRoutes from "./lib/bucket.js";
+import bucketRoutes from "./lib/routes/index.js";
 import { checkVersion } from "./lib/config/index.js";
 import { appVersion } from "./lib/config/index.js";
 

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 './bucket.js';
+export { default as bucket } from './routes/index.js';
 
 import * as s3 from './s3.js';
 import * as config from './config/index.js';
-import bucket from './bucket.js';
+import bucket from './routes/index.js';
 
 // Default aggregate export for convenience
 const defaultExport = {