@flusys/nestjs-storage 1.1.0-beta → 2.0.0

package/fesm/utils/file-validator.util.js

@@ -0,0 +1,451 @@
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+import { Logger } from '@nestjs/common';
+/**
+ * Magic byte signatures for common file types.
+ * Each entry maps a hex signature pattern to its MIME type.
+ */ const MAGIC_BYTES = [
+    // Images
+    {
+        signature: [
+            0xff,
+            0xd8,
+            0xff
+        ],
+        offset: 0,
+        mimeType: 'image/jpeg'
+    },
+    {
+        signature: [
+            0x89,
+            0x50,
+            0x4e,
+            0x47,
+            0x0d,
+            0x0a,
+            0x1a,
+            0x0a
+        ],
+        offset: 0,
+        mimeType: 'image/png'
+    },
+    {
+        signature: [
+            0x47,
+            0x49,
+            0x46,
+            0x38,
+            0x37,
+            0x61
+        ],
+        offset: 0,
+        mimeType: 'image/gif'
+    },
+    {
+        signature: [
+            0x47,
+            0x49,
+            0x46,
+            0x38,
+            0x39,
+            0x61
+        ],
+        offset: 0,
+        mimeType: 'image/gif'
+    },
+    {
+        signature: [
+            0x42,
+            0x4d
+        ],
+        offset: 0,
+        mimeType: 'image/bmp'
+    },
+    {
+        signature: [
+            0x52,
+            0x49,
+            0x46,
+            0x46
+        ],
+        offset: 0,
+        mimeType: 'image/webp'
+    },
+    {
+        signature: [
+            0x00,
+            0x00,
+            0x01,
+            0x00
+        ],
+        offset: 0,
+        mimeType: 'image/x-icon'
+    },
+    {
+        signature: [
+            0x00,
+            0x00,
+            0x02,
+            0x00
+        ],
+        offset: 0,
+        mimeType: 'image/x-icon'
+    },
+    // Documents
+    {
+        signature: [
+            0x25,
+            0x50,
+            0x44,
+            0x46
+        ],
+        offset: 0,
+        mimeType: 'application/pdf'
+    },
+    {
+        signature: [
+            0x50,
+            0x4b,
+            0x03,
+            0x04
+        ],
+        offset: 0,
+        mimeType: 'application/zip'
+    },
+    // Audio
+    {
+        signature: [
+            0x49,
+            0x44,
+            0x33
+        ],
+        offset: 0,
+        mimeType: 'audio/mpeg'
+    },
+    {
+        signature: [
+            0xff,
+            0xfb
+        ],
+        offset: 0,
+        mimeType: 'audio/mpeg'
+    },
+    {
+        signature: [
+            0xff,
+            0xfa
+        ],
+        offset: 0,
+        mimeType: 'audio/mpeg'
+    },
+    {
+        signature: [
+            0x4f,
+            0x67,
+            0x67,
+            0x53
+        ],
+        offset: 0,
+        mimeType: 'audio/ogg'
+    },
+    {
+        signature: [
+            0x66,
+            0x4c,
+            0x61,
+            0x43
+        ],
+        offset: 0,
+        mimeType: 'audio/flac'
+    },
+    // Video
+    {
+        signature: [
+            0x00,
+            0x00,
+            0x00,
+            0x1c,
+            0x66,
+            0x74,
+            0x79,
+            0x70
+        ],
+        offset: 0,
+        mimeType: 'video/mp4'
+    },
+    {
+        signature: [
+            0x00,
+            0x00,
+            0x00,
+            0x20,
+            0x66,
+            0x74,
+            0x79,
+            0x70
+        ],
+        offset: 0,
+        mimeType: 'video/mp4'
+    },
+    {
+        signature: [
+            0x1a,
+            0x45,
+            0xdf,
+            0xa3
+        ],
+        offset: 0,
+        mimeType: 'video/webm'
+    },
+    {
+        signature: [
+            0x52,
+            0x49,
+            0x46,
+            0x46
+        ],
+        offset: 0,
+        mimeType: 'video/avi'
+    },
+    // Archives
+    {
+        signature: [
+            0x1f,
+            0x8b
+        ],
+        offset: 0,
+        mimeType: 'application/gzip'
+    },
+    {
+        signature: [
+            0x37,
+            0x7a,
+            0xbc,
+            0xaf,
+            0x27,
+            0x1c
+        ],
+        offset: 0,
+        mimeType: 'application/x-7z-compressed'
+    },
+    {
+        signature: [
+            0x52,
+            0x61,
+            0x72,
+            0x21,
+            0x1a,
+            0x07
+        ],
+        offset: 0,
+        mimeType: 'application/x-rar-compressed'
+    }
+];
+/**
+ * MIME type aliases - types that are equivalent.
+ */ const MIME_ALIASES = {
+    'image/jpeg': [
+        'image/jpg'
+    ],
+    'image/jpg': [
+        'image/jpeg'
+    ],
+    'video/mp4': [
+        'video/quicktime'
+    ],
+    'application/zip': [
+        'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+        'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+    ]
+};
+/**
+ * File types that are text-based and don't have magic bytes.
+ * SECURITY NOTE: Dangerous types (HTML, JS, SVG) are excluded as they can contain scripts.
+ * These types require explicit allowlisting and additional content scanning.
+ */ const TEXT_BASED_TYPES = [
+    'text/plain',
+    'text/csv',
+    'text/markdown',
+    'application/json',
+    'application/xml',
+    'application/typescript',
+    'text/css'
+];
+/**
+ * Dangerous text-based types that can execute scripts.
+ * These bypass magic-bytes validation but require explicit allowlisting.
+ */ const DANGEROUS_TEXT_TYPES = [
+    'text/html',
+    'application/javascript',
+    'text/javascript',
+    'image/svg+xml',
+    'application/xhtml+xml'
+];
+/**
+ * ZIP-based format prefixes that are valid when detected as application/zip.
+ */ const ZIP_VARIANT_PREFIXES = [
+    'application/vnd.openxmlformats-officedocument',
+    'application/x-zip',
+    'application/x-compressed'
+];
+/**
+ * Utility class for validating file content using magic bytes.
+ * Prevents file type spoofing by checking actual file content.
+ */ export class FileValidator {
+    // Result Helpers
+    static failureResult(message, detectedType, declaredType) {
+        return {
+            valid: false,
+            detectedType,
+            declaredType,
+            message
+        };
+    }
+    static successResult(detectedType, declaredType) {
+        return {
+            valid: true,
+            detectedType,
+            declaredType
+        };
+    }
+    /**
+   * Detect file type from buffer using magic bytes.
+   * @param buffer - File buffer to analyze
+   * @returns Detected MIME type or null if unknown
+   */ static detectFileType(buffer) {
+        for (const { signature, offset, mimeType } of MAGIC_BYTES){
+            if (buffer.length < offset + signature.length) continue;
+            let matches = true;
+            for(let i = 0; i < signature.length; i++){
+                if (buffer[offset + i] !== signature[i]) {
+                    matches = false;
+                    break;
+                }
+            }
+            if (matches) {
+                return mimeType;
+            }
+        }
+        return null;
+    }
+    /**
+   * Check if a MIME type is text-based (doesn't have magic bytes).
+   */ static isTextBasedType(mimeType) {
+        return TEXT_BASED_TYPES.some((t)=>mimeType.startsWith(t) || mimeType === t);
+    }
+    /**
+   * Check if a MIME type is a dangerous text type that can execute scripts.
+   */ static isDangerousTextType(mimeType) {
+        return DANGEROUS_TEXT_TYPES.some((t)=>mimeType === t);
+    }
+    /**
+   * Check if two MIME types are compatible (exact match or aliases).
+   */ static mimeTypesMatch(detected, declared) {
+        // Exact match
+        if (detected === declared) return true;
+        // Check aliases
+        const aliases = MIME_ALIASES[detected];
+        if (aliases?.includes(declared)) return true;
+        // Check reverse aliases
+        const reverseAliases = MIME_ALIASES[declared];
+        if (reverseAliases?.includes(detected)) return true;
+        // Check if both are in same category (e.g., both images)
+        const detectedCategory = detected.split('/')[0];
+        const declaredCategory = declared.split('/')[0];
+        // For ZIP-based formats, allow any ZIP-detected file if declared is a ZIP variant
+        if (detected === 'application/zip' && ZIP_VARIANT_PREFIXES.some((v)=>declared.startsWith(v))) {
+            return true;
+        }
+        return detectedCategory === declaredCategory;
+    }
+    /**
+   * Check if a MIME type is in the allowed list.
+   */ static isTypeAllowed(mimeType, allowedTypes) {
+        // Wildcard allows all
+        if (allowedTypes.includes('*/*')) return true;
+        return allowedTypes.some((allowed)=>{
+            // Category wildcard (e.g., "image/*")
+            if (allowed.endsWith('/*')) {
+                const category = allowed.slice(0, -2);
+                return mimeType.startsWith(category);
+            }
+            return allowed === mimeType;
+        });
+    }
+    /**
+   * Validate file content matches declared MIME type using magic bytes.
+   * @param buffer - File buffer
+   * @param declaredMimeType - MIME type declared by client
+   * @param allowedTypes - List of allowed MIME types/patterns
+   * @returns Validation result
+   */ static validateFileContent(buffer, declaredMimeType, allowedTypes = [
+        '*/*'
+    ]) {
+        try {
+            const detectedType = this.detectFileType(buffer);
+            // No magic bytes detected - handle text-based types
+            if (!detectedType) {
+                return this.validateUndetectedType(declaredMimeType, allowedTypes);
+            }
+            // Verify detected type matches declared type
+            if (!this.mimeTypesMatch(detectedType, declaredMimeType)) {
+                this.logger.warn(`MIME type mismatch: declared=${declaredMimeType}, detected=${detectedType}`);
+                return this.failureResult(`File content does not match declared type. Detected: ${detectedType}, Declared: ${declaredMimeType}`, detectedType, declaredMimeType);
+            }
+            // Verify type is in allowed list
+            if (!this.isTypeAllowed(detectedType, allowedTypes)) {
+                return this.failureResult(`File type "${detectedType}" is not allowed`, detectedType, declaredMimeType);
+            }
+            return this.successResult(detectedType, declaredMimeType);
+        } catch (error) {
+            this.logger.error('File validation error:', error);
+            return this.failureResult('File validation failed');
+        }
+    }
+    /**
+   * Handle validation for files without detectable magic bytes.
+   */ static validateUndetectedType(declaredMimeType, allowedTypes) {
+        // Check for dangerous text types first (HTML, JS, SVG)
+        if (this.isDangerousTextType(declaredMimeType)) {
+            const explicitlyAllowed = allowedTypes.some((t)=>t === declaredMimeType && t !== '*/*' && !t.endsWith('/*'));
+            if (!explicitlyAllowed) {
+                this.logger.warn(`Blocked dangerous file type: ${declaredMimeType} - requires explicit allowlisting`);
+                return this.failureResult(`File type "${declaredMimeType}" is potentially dangerous and not explicitly allowed`, declaredMimeType, declaredMimeType);
+            }
+            this.logger.warn(`Allowing explicitly permitted dangerous file type: ${declaredMimeType}`);
+        }
+        // Safe text-based files don't have magic bytes, trust declared type
+        if (this.isTextBasedType(declaredMimeType)) {
+            const isAllowed = this.isTypeAllowed(declaredMimeType, allowedTypes);
+            return isAllowed ? this.successResult(declaredMimeType, declaredMimeType) : this.failureResult(`File type "${declaredMimeType}" is not allowed`, declaredMimeType, declaredMimeType);
+        }
+        // Binary files without recognized signatures - be cautious
+        this.logger.warn(`Unable to detect file type for declared type: ${declaredMimeType}`);
+        return this.failureResult('Unable to verify file type. File may be corrupted or unsupported.', undefined, declaredMimeType);
+    }
+    /**
+   * Sanitize filename to prevent path traversal and special character issues.
+   * @param filename - Original filename
+   * @returns Sanitized filename
+   */ static sanitizeFilename(filename) {
+        return filename// Remove path components (prevent traversal)
+        .replace(/^.*[\\\/]/, '')// Remove null bytes
+        .replace(/\0/g, '')// Replace multiple dots with single
+        .replace(/\.{2,}/g, '.')// Remove special characters except allowed ones
+        .replace(/[^a-zA-Z0-9._-]/g, '_')// Limit length
+        .substring(0, 255);
+    }
+}
+_define_property(FileValidator, "logger", new Logger(FileValidator.name));

package/fesm/utils/image-compressor.util.js

@@ -99,17 +99,12 @@ const sharp = sharpModule.default || sharpModule;
                 break;
         }
         try {
-            // Process main image
-            const { data, info } = await image.toBuffer({
-                resolveWithObject: true
-            });
+            const compressedBuffer = await image.toBuffer();
             return {
-                buffer: data,
+                buffer: compressedBuffer,
                 format: `image/${targetFormat}`
             };
-        } catch (error) {
-            // Fallback to original if processing fails
-            console.warn(`Image processing failed: ${error instanceof Error ? error.message : String(error)}`);
+        } catch  {
             return {
                 buffer,
                 format: mimetype

package/interfaces/file-manager.interface.d.ts

@@ -3,12 +3,15 @@ export interface IFileManager extends IIdentity {
     name?: string;
     key?: string;
     url?: string;
-    folder?: number;
-    size?: number;
-    expiresAt?: number;
+    folder?: {
+        id: string;
+        name?: string;
+    } | null;
+    size?: string;
+    expiresAt?: number | null;
     contentType?: string;
     location?: string;
-    storageConfigId?: string;
+    storageConfigId?: string | null;
     providerName?: string;
     isPrivate?: boolean;
     companyId?: string | null;

package/interfaces/index.d.ts

@@ -1,5 +1,4 @@
 export * from './file-manager.interface';
-export * from './file-upload-response.interface';
 export * from './folder.interface';
 export * from './storage-config.interface';
 export * from './storage-module-options.interface';

package/interfaces/storage-config.interface.d.ts

@@ -8,23 +8,3 @@ export interface IStorageConfig extends IIdentity {
     isDefault: boolean;
     companyId?: string | null;
 }
-export interface IAwsS3Config {
-    region: string;
-    bucket: string;
-    accessKeyId: string;
-    secretAccessKey: string;
-    endpoint?: string;
-}
-export interface IAzureBlobConfig {
-    accountName: string;
-    accountKey: string;
-    containerName: string;
-}
-export interface ISftpConfig {
-    host: string;
-    port: number;
-    username: string;
-    password?: string;
-    privateKey?: string;
-    basePath: string;
-}

package/interfaces/storage-module-options.interface.d.ts

@@ -7,17 +7,12 @@ export interface IStorageModuleConfig extends IDataSourceServiceOptions {
     localStoragePath?: string;
     appUrl?: string;
 }
-export interface IStorageModuleConfigFull {
-    bootstrapAppConfig?: IBootstrapAppConfig;
-    config?: IStorageModuleConfig;
-}
 export interface StorageModuleOptions extends IDynamicModuleConfig {
     bootstrapAppConfig?: IBootstrapAppConfig;
     config?: IStorageModuleConfig;
 }
 export interface StorageOptionsFactory extends IModuleOptionsFactory<IStorageModuleConfig> {
     createStorageOptions(): Promise<IStorageModuleConfig> | IStorageModuleConfig;
-    createOptions(): Promise<IStorageModuleConfig> | IStorageModuleConfig;
 }
 export interface StorageModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'>, IDynamicModuleConfig {
     bootstrapAppConfig: IBootstrapAppConfig;

package/middlewares/file-serve.middleware.d.ts

@@ -3,7 +3,15 @@ import { Request, Response, NextFunction } from 'express';
 import { UploadService } from '../services/upload.service';
 export declare class FileServeMiddleware implements NestMiddleware {
     private uploadService;
-    private logger;
+    private readonly logger;
+    private readonly uploadDir;
     constructor(uploadService: UploadService);
     use(req: Request, res: Response, next: NextFunction): Promise<void>;
+    private extractFilePath;
+    private resolveFilePath;
+    private tryFallbackPaths;
+    private getMimeType;
+    private setResponseHeaders;
+    private streamFile;
+    private sendErrorResponse;
 }

package/modules/storage.module.d.ts

@@ -4,7 +4,6 @@ export declare class StorageModule implements NestModule {
     configure(consumer: MiddlewareConsumer): void;
     static forRoot(options: StorageModuleOptions): DynamicModule;
     static forRootAsync(options: StorageModuleAsyncOptions): DynamicModule;
-    private static getControllers;
-    private static getProviders;
+    private static buildProviders;
     private static createAsyncProviders;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-storage",
-  "version": "1.1.0-beta",
+  "version": "2.0.0",
   "description": "Modular storage package with optional AWS S3, Azure Blob, and SFTP providers",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -94,15 +94,15 @@
     "class-transformer": "^0.5.0",
     "class-validator": "^0.14.0",
     "typeorm": "^0.3.0",
-    "multer": "^1.4.0",
-    "sharp": "^0.33.0",
+    "multer": "^2.0.0",
+    "sharp": "^0.34.0",
     "mime-types": "^2.1.0",
     "uuid": "^9.0.0 || ^11.0.0",
     "@aws-sdk/client-s3": "^3.400.0",
     "@aws-sdk/lib-storage": "^3.400.0",
     "@aws-sdk/s3-request-presigner": "^3.400.0",
     "@azure/storage-blob": "^12.15.0",
-    "ssh2-sftp-client": "^10.0.0"
+    "ssh2-sftp-client": "^12.0.0"
   },
   "peerDependenciesMeta": {
     "sharp": {
@@ -128,7 +128,7 @@
     }
   },
   "dependencies": {
-    "@flusys/nestjs-core": "1.1.0-beta",
-    "@flusys/nestjs-shared": "1.1.0-beta"
+    "@flusys/nestjs-core": "2.0.0",
+    "@flusys/nestjs-shared": "2.0.0"
   }
 }

package/providers/azure-provider.optional.d.ts

@@ -1,17 +1,18 @@
 import { UploadOptionsDto } from '../dtos';
 import { IStorageProvider, IUploadedFileInfo } from '../interfaces';
+interface AzureConfig {
+    accountName: string;
+    accountKey: string;
+    containerName: string;
+    connectionString?: string;
+}
 export declare class AzureProvider implements IStorageProvider {
     private logger;
     private blobServiceClient;
     private containerClient;
     private containerName;
     private accountName;
-    initialize(config: {
-        accountName: string;
-        accountKey: string;
-        containerName: string;
-        connectionString?: string;
-    }): Promise<void>;
+    initialize(config: AzureConfig): Promise<void>;
     uploadFile(file: Express.Multer.File, options: UploadOptionsDto): Promise<IUploadedFileInfo>;
     uploadMultipleFiles(files: Express.Multer.File[], options: UploadOptionsDto): Promise<IUploadedFileInfo[]>;
     deleteFile(key: string): Promise<void>;
@@ -19,3 +20,4 @@ export declare class AzureProvider implements IStorageProvider {
     generatePresignedUrl(key: string, expiresInSeconds?: number): Promise<string>;
     healthCheck(): Promise<boolean>;
 }
+export {};

package/providers/local-provider.d.ts

@@ -5,6 +5,8 @@ export declare class LocalProvider implements IStorageProvider {
     private basePath;
     private baseUrl;
     private relativeBasePath;
+    private validatePathWithinBase;
+    private validateKeyFormat;
     initialize(config: {
         basePath?: string;
         baseUrl?: string;
@@ -15,11 +17,4 @@ export declare class LocalProvider implements IStorageProvider {
     deleteMultipleFiles(keys: string[]): Promise<void>;
     generatePresignedUrl(key: string, _expiresInSeconds?: number): Promise<string>;
     healthCheck(): Promise<boolean>;
-    getAbsolutePath(key: string): string;
-    fileExists(key: string): Promise<boolean>;
-    getFileStats(key: string): Promise<{
-        size: number;
-        createdAt: Date;
-        modifiedAt: Date;
-    }>;
 }

package/providers/s3-provider.optional.d.ts

@@ -1,17 +1,18 @@
 import { UploadOptionsDto } from '../dtos';
 import { IStorageProvider, IUploadedFileInfo } from '../interfaces';
+interface S3Config {
+    region: string;
+    bucket: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    endpoint?: string;
+}
 export declare class S3Provider implements IStorageProvider {
     private logger;
     private s3;
     private bucketName;
     private region;
-    initialize(config: {
-        region: string;
-        bucket: string;
-        accessKeyId?: string;
-        secretAccessKey?: string;
-        endpoint?: string;
-    }): Promise<void>;
+    initialize(config: S3Config): Promise<void>;
     uploadFile(file: Express.Multer.File, options: UploadOptionsDto): Promise<IUploadedFileInfo>;
     uploadMultipleFiles(files: Express.Multer.File[], options: UploadOptionsDto): Promise<IUploadedFileInfo[]>;
     deleteFile(key: string): Promise<void>;
@@ -19,3 +20,4 @@ export declare class S3Provider implements IStorageProvider {
     generatePresignedUrl(key: string, expiresInSeconds?: number): Promise<string>;
     healthCheck(): Promise<boolean>;
 }
+export {};