@flusys/nestjs-storage 0.1.0-beta.3 → 1.0.0-rc

package/cjs/dtos/upload.dto.js

@@ -68,6 +68,8 @@ _ts_decorate([
         description: 'Key of the file to delete',
         example: '/uploads/some path'
     }),
+    (0, _classvalidator.IsNotEmpty)(),
+    (0, _classvalidator.IsString)(),
     _ts_metadata("design:type", String)
 ], DeleteSingleFileDto.prototype, "key", void 0);
 _ts_decorate([
@@ -96,6 +98,11 @@ _ts_decorate([
             String
         ]
     }),
+    (0, _classvalidator.IsNotEmpty)(),
+    (0, _classvalidator.IsArray)(),
+    (0, _classvalidator.IsString)({
+        each: true
+    }),
     _ts_metadata("design:type", Array)
 ], DeleteMultipleFileDto.prototype, "keys", void 0);
 _ts_decorate([

package/cjs/entities/storage-config-base.entity.js

@@ -35,8 +35,7 @@ function _ts_metadata(k, v) {
 }
 let StorageConfigBase = class StorageConfigBase extends _entities.Identity {
     constructor(...args){
-        super(...args), _define_property(this, "name", void 0), _define_property(this, "storage", void 0), // add config for storage
-        _define_property(this, "config", void 0);
+        super(...args), _define_property(this, "name", void 0), _define_property(this, "storage", void 0), _define_property(this, "config", void 0), _define_property(this, "isActive", void 0), _define_property(this, "isDefault", void 0);
     }
 };
 _ts_decorate([
@@ -62,3 +61,33 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], StorageConfigBase.prototype, "config", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'boolean',
+        default: true,
+        name: 'is_active'
+    }),
+    _ts_metadata("design:type", Boolean)
+], StorageConfigBase.prototype, "isActive", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'boolean',
+        default: false,
+        name: 'is_default'
+    }),
+    _ts_metadata("design:type", Boolean)
+], StorageConfigBase.prototype, "isDefault", void 0);
+StorageConfigBase = _ts_decorate([
+    (0, _typeorm.Index)([
+        'name'
+    ]),
+    (0, _typeorm.Index)([
+        'storage'
+    ]),
+    (0, _typeorm.Index)([
+        'isActive'
+    ]),
+    (0, _typeorm.Index)([
+        'isDefault'
+    ])
+], StorageConfigBase);

package/cjs/interfaces/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _export_star(require("./file-manager.interface"), exports);
-_export_star(require("./file-upload-response.interface"), exports);
 _export_star(require("./folder.interface"), exports);
 _export_star(require("./storage-config.interface"), exports);
 _export_star(require("./storage-module-options.interface"), exports);

package/cjs/middlewares/file-serve.middleware.js

@@ -76,6 +76,11 @@ function _ts_decorate(decorators, target, key, desc) {
 function _ts_metadata(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
+function _ts_param(paramIndex, decorator) {
+    return function(target, key) {
+        decorator(target, key, paramIndex);
+    };
+}
 let FileServeMiddleware = class FileServeMiddleware {
     async use(req, res, next) {
         try {
@@ -197,6 +202,7 @@ let FileServeMiddleware = class FileServeMiddleware {
 };
 FileServeMiddleware = _ts_decorate([
     (0, _common.Injectable)(),
+    _ts_param(0, (0, _common.Inject)(_uploadservice.UploadService)),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [
         typeof _uploadservice.UploadService === "undefined" ? Object : _uploadservice.UploadService

package/cjs/modules/storage.module.js

@@ -117,10 +117,8 @@ let StorageModule = class StorageModule {
             ]
         };
     }
-    // ==================== Private Helper Methods ====================
-    /**
-   * Get controllers (all controllers always loaded)
-   */ static getControllers(options) {
+    // Private Helper Methods
+    /** Get controllers (all controllers always loaded) */ static getControllers(options) {
         return [
             _controllers.FileManagerController,
             _controllers.FolderController,

package/cjs/providers/local-provider.js

@@ -80,6 +80,29 @@ function _interop_require_wildcard(obj, nodeInterop) {
 }
 let LocalProvider = class LocalProvider {
     /**
+   * SECURITY: Validates that a target path does not escape the base directory
+   * Prevents path traversal attacks using ../ sequences
+   * @throws Error if path traversal is detected
+   */ validatePathWithinBase(targetPath) {
+        const normalizedBasePath = _path.resolve(this.basePath);
+        const normalizedTargetPath = _path.resolve(targetPath);
+        if (!normalizedTargetPath.startsWith(normalizedBasePath + _path.sep) && normalizedTargetPath !== normalizedBasePath) {
+            this.logger.warn(`Path traversal attempt detected: ${targetPath}`);
+            throw new Error('Invalid path: Path traversal attempt detected');
+        }
+    }
+    /**
+   * SECURITY: Validates file key format to prevent malicious input
+   * @throws Error if key contains suspicious patterns
+   */ validateKeyFormat(key) {
+        if (!key || typeof key !== 'string' || key.trim().length === 0) {
+            throw new Error('Invalid file key: empty or invalid');
+        }
+        if (key.includes('\0')) {
+            throw new Error('Invalid file key: contains null bytes');
+        }
+    }
+    /**
    * Initialize Local File System provider with configuration
    * @param config.basePath - Base path for file storage (default: './uploads')
    * @param config.baseUrl - Optional base URL for generating file URLs
@@ -112,7 +135,11 @@ let LocalProvider = class LocalProvider {
         }
         // Build file path
         const folderPath = options.folderPath ? _path.join(this.basePath, options.folderPath) : this.basePath;
+        // SECURITY: Validate path does not escape base directory
+        this.validatePathWithinBase(folderPath);
         const filePath = _path.join(folderPath, fileName);
+        // SECURITY: Double-check final file path
+        this.validatePathWithinBase(filePath);
         // Ensure directory exists
         await _promises.mkdir(folderPath, {
             recursive: true
@@ -135,14 +162,20 @@ let LocalProvider = class LocalProvider {
     }
     async deleteFile(key) {
         try {
+            // SECURITY: Validate key format first
+            this.validateKeyFormat(key);
             // Key now includes the basePath, resolve from cwd
             let filePath = _path.resolve(key);
+            // SECURITY: Validate resolved path is within base directory
+            this.validatePathWithinBase(filePath);
             // Check if file exists at the resolved path
             try {
                 await _promises.access(filePath);
             } catch  {
                 // Fallback: try with basePath prefix (for old keys without basePath)
                 const fallbackPath = _path.join(this.basePath, key);
+                // SECURITY: Validate fallback path as well
+                this.validatePathWithinBase(fallbackPath);
                 try {
                     await _promises.access(fallbackPath);
                     filePath = fallbackPath;
@@ -155,7 +188,11 @@ let LocalProvider = class LocalProvider {
             }
             await _promises.unlink(filePath);
             this.logger.log(`Deleted file from local storage: ${key}`);
-        } catch (_error) {
+        } catch (error) {
+            // Re-throw security errors
+            if (error instanceof Error && error.message.includes('Invalid')) {
+                throw error;
+            }
             this.logger.warn(`Failed to delete file from local storage: ${key}`);
         }
     }
@@ -186,14 +223,23 @@ let LocalProvider = class LocalProvider {
    * Get the absolute path for a file key
    * Key now includes basePath, so resolve from cwd
    */ getAbsolutePath(key) {
-        return _path.resolve(key);
+        // SECURITY: Validate key format
+        this.validateKeyFormat(key);
+        const filePath = _path.resolve(key);
+        // SECURITY: Validate path is within base directory
+        this.validatePathWithinBase(filePath);
+        return filePath;
     }
     /**
    * Check if a file exists
    */ async fileExists(key) {
         try {
+            // SECURITY: Validate key format
+            this.validateKeyFormat(key);
             // Key now includes basePath, resolve from cwd
             const filePath = _path.resolve(key);
+            // SECURITY: Validate path is within base directory
+            this.validatePathWithinBase(filePath);
             await _promises.access(filePath);
             return true;
         } catch  {
@@ -203,8 +249,12 @@ let LocalProvider = class LocalProvider {
     /**
    * Get file stats
    */ async getFileStats(key) {
+        // SECURITY: Validate key format
+        this.validateKeyFormat(key);
         // Key now includes basePath, resolve from cwd
         const filePath = _path.resolve(key);
+        // SECURITY: Validate path is within base directory
+        this.validatePathWithinBase(filePath);
         const stats = await _promises.stat(filePath);
         return {
             size: stats.size,

package/cjs/providers/storage-factory.service.js

@@ -130,8 +130,8 @@ let StorageFactoryService = class StorageFactoryService {
         } catch (error) {
             this.logger.error(`Failed to create provider ${config.provider}:`, error);
             // Preserve original error message for better debugging
-            const originalMessage = error?.message || 'Unknown error';
-            throw new Error(`Failed to initialize storage provider '${config.provider}': ${originalMessage}`);
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            throw new Error(`Failed to initialize storage provider '${config.provider}': ${errorMessage}`);
         }
     }
     /**

package/cjs/services/file-manager.service.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "FileManagerService", {
 });
 const _classes = require("@flusys/nestjs-shared/classes");
 const _modules = require("@flusys/nestjs-shared/modules");
+const _utils = require("@flusys/nestjs-shared/utils");
 const _common = require("@nestjs/common");
 const _typeorm = require("typeorm");
 const _config = require("../config");
@@ -154,8 +155,9 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
                 const enableCompanyFeature = this.storageConfig.isCompanyFeatureEnabled();
                 const storageConfigEntity = enableCompanyFeature ? (await Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("../entities")))).StorageConfigWithCompany : (await Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("../entities")))).StorageConfig;
                 const storageConfigRepository = await this.dataSourceProvider.getRepository(storageConfigEntity);
+                const storageConfigId = dto.storageConfigId;
                 const whereCondition = {
-                    id: dto.storageConfigId
+                    id: storageConfigId
                 };
                 // Filter by company if company feature is enabled
                 if (enableCompanyFeature && user?.companyId) {
@@ -165,25 +167,30 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
                     where: whereCondition
                 });
                 if (storageConfig) {
-                    storageLocation = storageConfig.storage;
+                    const typedConfig = storageConfig;
+                    if (typedConfig.storage) {
+                        storageLocation = typedConfig.storage;
+                    }
                 }
             } catch (error) {
-                this.logger.warn(`Failed to get storage location from config: ${error}`);
+                const errorMessage = _utils.ErrorHandler.getErrorMessage(error);
+                this.logger.warn(`Failed to get storage location from config ${dto.storageConfigId}: ${errorMessage}`);
             // Fall back to DTO location or default
             }
         }
-        // Set basic fields
-        fileManager = {
+        // Set basic fields - merge existing data with DTO
+        const mergedFileManager = {
             ...fileManager,
             ...dto,
             location: storageLocation,
             folder: validatedFolder
         };
-        // Only set company fields if they exist on the entity (when company feature is enabled)
-        if ('companyId' in fileManager) {
-            fileManager.companyId = user?.companyId ?? null;
+        // Only set company fields if company feature is enabled
+        const enableCompanyFeatureForEntity = this.storageConfig.isCompanyFeatureEnabled();
+        if (enableCompanyFeatureForEntity) {
+            mergedFileManager.companyId = user?.companyId ?? null;
         }
-        return fileManager;
+        return mergedFileManager;
     }
     async getSelectQuery(query, _user, select) {
         if (!select || !select.length) {
@@ -260,7 +267,8 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
             this.logger.debug(`enrichWithProviderNames: First enriched item: ${JSON.stringify(enrichedItems[0])}`);
             return enrichedItems;
         } catch (error) {
-            this.logger.warn(`Failed to fetch provider names: ${error}`);
+            const errorMessage = _utils.ErrorHandler.getErrorMessage(error);
+            this.logger.warn(`Failed to fetch provider names: ${errorMessage}`);
             return items.map((item)=>({
                     ...item,
                     providerName: undefined
@@ -298,13 +306,12 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
    * Override: Extra query manipulation - Auto-filter by user's company and private file permissions
    */ async getExtraManipulateQuery(query, filterDto, user) {
         const result = await super.getExtraManipulateQuery(query, filterDto, user);
-        // If company feature enabled and user has companyId, filter by user's company
+        // Apply company filter using shared utility
         const enableCompanyFeature = this.storageConfig.isCompanyFeatureEnabled();
-        if (enableCompanyFeature && user?.companyId) {
-            query.andWhere('file_manager.companyId = :companyId', {
-                companyId: user.companyId
-            });
-        }
+        (0, _utils.applyCompanyFilter)(query, {
+            isCompanyFeatureEnabled: enableCompanyFeature,
+            entityAlias: 'file_manager'
+        }, user);
         // Check if user has permission to see private files
         if (user) {
             const cacheKey = enableCompanyFeature ? `${USER_ACTION_PERMISSION_CACHE_KEY}_${user.id}_${user.companyId}` : `${USER_ACTION_PERMISSION_CACHE_KEY}_${user.id}`;
@@ -367,8 +374,9 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
                                 'config'
                             ]
                         });
-                        if (config && config.config?.basePath) {
-                            const basePath = config.config.basePath.replace(/^\.\//, '');
+                        const typedConfig = config;
+                        if (typedConfig?.config?.basePath) {
+                            const basePath = typedConfig.config.basePath.replace(/^\.\//, '');
                             // Convert old keys to new format
                             deleteKeys = keys.map((key)=>{
                                 if (!key.includes('/')) {
@@ -378,7 +386,8 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
                             });
                         }
                     } catch (error) {
-                        this.logger.warn(`Failed to get basePath for delete: ${error}`);
+                        const errorMessage = _utils.ErrorHandler.getErrorMessage(error);
+                        this.logger.warn(`Failed to get basePath for delete: ${errorMessage}`);
                     }
                 }
                 await this.uploadService.deleteMultipleFile(deleteKeys, configId === 'default' ? undefined : configId, user ?? undefined, location);
@@ -412,7 +421,8 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
                     file.expiresAt = now + expiresIn * 1000;
                     shouldUpdate = true;
                 } catch (error) {
-                    this.logger.error(`Failed to generate URL for file ${file.id}: ${error?.message || 'Unknown error'}`);
+                    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                    this.logger.error(`Failed to generate URL for file ${file.id}: ${errorMessage}`);
                     // Use fallback URL with appUrl from config
                     const baseUrl = this.getFileBaseUrl(protocol, host);
                     file.url = `${baseUrl}/storage/upload/file/${file.key}`;
@@ -439,13 +449,15 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
                                 'config'
                             ]
                         });
-                        if (config && config.config?.basePath) {
-                            const basePath = config.config.basePath.replace(/^\.\//, ''); // Remove leading ./
+                        const typedConfig = config;
+                        if (typedConfig?.config?.basePath) {
+                            const basePath = typedConfig.config.basePath.replace(/^\.\//, ''); // Remove leading ./
                             fileKey = `${basePath}/${file.key}`;
                             this.logger.debug(`Prefixed old key with basePath: ${fileKey}`);
                         }
                     } catch (error) {
-                        this.logger.warn(`Failed to get basePath for file ${file.id}: ${error}`);
+                        const errorMessage = _utils.ErrorHandler.getErrorMessage(error);
+                        this.logger.warn(`Failed to get basePath for file ${file.id}: ${errorMessage}`);
                     }
                 }
                 const baseUrl = this.getFileBaseUrl(protocol, host);
@@ -470,7 +482,8 @@ let FileManagerService = class FileManagerService extends _classes.RequestScoped
             try {
                 await this.repository.save(updatedFiles);
             } catch (error) {
-                this.logger.error(`Failed to save updated file URLs: ${error?.message || 'Unknown error'}`);
+                const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                this.logger.error(`Failed to save updated file URLs: ${errorMessage}`);
             }
         }
         return responses;

package/cjs/services/folder.service.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "FolderService", {
 });
 const _classes = require("@flusys/nestjs-shared/classes");
 const _modules = require("@flusys/nestjs-shared/modules");
+const _utils = require("@flusys/nestjs-shared/utils");
 const _common = require("@nestjs/common");
 const _config = require("../config");
 const _entities = require("../entities");
@@ -42,46 +43,21 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 let FolderService = class FolderService extends _classes.RequestScopedApiService {
-    /**
-   * Resolve entity class for this service
-   * @returns Folder or FolderWithCompany based on configuration
-   */ resolveEntity() {
-        const enableCompanyFeature = this.storageConfig.isCompanyFeatureEnabled();
-        return enableCompanyFeature ? _entities.FolderWithCompany : _entities.Folder;
+    resolveEntity() {
+        return this.storageConfig.isCompanyFeatureEnabled() ? _entities.FolderWithCompany : _entities.Folder;
     }
-    /**
-   * Get DataSource provider for this service
-   * @returns StorageDataSourceProvider instance
-   */ getDataSourceProvider() {
+    getDataSourceProvider() {
         return this.dataSourceProvider;
     }
     async convertSingleDtoToEntity(dto, user) {
-        let folder = {};
-        // NOTE: Using 'id' in dto check instead of instanceof - instanceof may not work after esbuild bundling
-        if ('id' in dto && dto.id && typeof dto.id === 'string') {
-            const dbData = await this.repository.findOne({
-                where: {
-                    id: dto.id
-                }
-            });
-            if (!dbData) {
-                throw new _common.NotFoundException('No such entity data found for update! Please, Try Again.');
-            }
-            folder = dbData;
-        }
-        // Set company/branch IDs if company feature is enabled
-        folder = {
-            ...folder,
-            ...dto
-        };
-        // Only set company fields if they exist on the entity (when company feature is enabled)
-        if ('companyId' in folder) {
-            folder.companyId = user?.companyId ?? null;
+        const entity = await super.convertSingleDtoToEntity(dto, user);
+        if (this.storageConfig.isCompanyFeatureEnabled()) {
+            entity.companyId = user?.companyId ?? null;
         }
-        return folder;
+        return entity;
     }
     async getSelectQuery(query, _user, select) {
-        if (!select || !select.length) {
+        if (!select?.length) {
             select = [
                 'id',
                 'name',
@@ -89,35 +65,25 @@ let FolderService = class FolderService extends _classes.RequestScopedApiService
                 'createdAt',
                 'deletedAt'
             ];
+            if (this.storageConfig.isCompanyFeatureEnabled()) {
+                select.push('companyId');
+            }
         }
-        const selectFields = select.map((field)=>`${this.entityName}.${field}`);
-        // Add company context fields if company feature is enabled
-        // The entity will have these fields only if company feature is enabled
-        if (this.storageConfig.isCompanyFeatureEnabled()) {
-            selectFields.push('folder.companyId');
-        }
-        query.select(selectFields);
+        query.select(select.map((f)=>`${this.entityName}.${f}`));
         return {
             query,
             isRaw: false
         };
     }
-    /**
-   * Override: Extra query manipulation - Auto-filter by user's company
-   */ async getExtraManipulateQuery(query, filterDto, user) {
+    async getExtraManipulateQuery(query, filterDto, user) {
         const result = await super.getExtraManipulateQuery(query, filterDto, user);
-        // If company feature enabled and user has companyId, filter by user's company
-        const enableCompanyFeature = this.storageConfig.isCompanyFeatureEnabled();
-        if (enableCompanyFeature && user?.companyId) {
-            query.andWhere('folder.companyId = :companyId', {
-                companyId: user.companyId
-            });
-        }
+        (0, _utils.applyCompanyFilter)(query, {
+            isCompanyFeatureEnabled: this.storageConfig.isCompanyFeatureEnabled(),
+            entityAlias: 'folder'
+        }, user);
         return result;
     }
-    // NOTE: @Inject() required for bundled code - type metadata may be lost during esbuild
     constructor(cacheManager, utilsService, storageConfig, dataSourceProvider){
-        // Repository will be set asynchronously by RequestScopedApiService
         super('folder', null, cacheManager, utilsService, FolderService.name, true), _define_property(this, "cacheManager", void 0), _define_property(this, "utilsService", void 0), _define_property(this, "storageConfig", void 0), _define_property(this, "dataSourceProvider", void 0), this.cacheManager = cacheManager, this.utilsService = utilsService, this.storageConfig = storageConfig, this.dataSourceProvider = dataSourceProvider;
     }
 };

package/cjs/services/storage-datasource.provider.js

@@ -83,10 +83,8 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 let StorageDataSourceProvider = class StorageDataSourceProvider extends _modules.MultiTenantDataSourceService {
-    // ==================== Factory Methods ====================
-    /**
-   * Build parent options from StorageModuleOptions
-   */ static buildParentOptions(options) {
+    // Factory Methods
+    /** Build parent options from StorageModuleOptions */ static buildParentOptions(options) {
         return {
             bootstrapAppConfig: options.bootstrapAppConfig,
             defaultDatabaseConfig: options.config?.defaultDatabaseConfig,
@@ -94,10 +92,8 @@ let StorageDataSourceProvider = class StorageDataSourceProvider extends _modules
             tenants: options.config?.tenants
         };
     }
-    // ==================== Feature Flags ====================
-    /**
-   * Get global enable company feature flag
-   */ getEnableCompanyFeature() {
+    // Feature Flags
+    /** Get global enable company feature flag */ getEnableCompanyFeature() {
         return this.storageOptions.bootstrapAppConfig?.enableCompanyFeature ?? false;
     }
     /**
@@ -111,11 +107,11 @@ let StorageDataSourceProvider = class StorageDataSourceProvider extends _modules
    */ getEnableCompanyFeatureForCurrentTenant() {
         return this.getEnableCompanyFeatureForTenant(this.getCurrentTenant() ?? undefined);
     }
-    // ==================== Entity Management ====================
+    // Entity Management
     /**
-   * Get storage entities for migrations based on company feature flag
-   * Note: For TypeORM repositories, we always use the base entities (FileManager, etc.)
-   * But for migrations, we need the correct entity based on the feature flag
+   * Get storage entities for migrations based on company feature flag.
+   * For TypeORM repositories, we always use the base entities (FileManager, etc.)
+   * but for migrations, we need the correct entity based on the feature flag.
    */ async getStorageEntities(enableCompanyFeature) {
         const enable = enableCompanyFeature ?? this.getEnableCompanyFeature();
         const { FileManager, Folder, StorageConfig } = await Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("../entities")));
@@ -135,10 +131,8 @@ let StorageDataSourceProvider = class StorageDataSourceProvider extends _modules
             StorageConfig
         ];
     }
-    // ==================== Overrides ====================
-    /**
-   * Override to dynamically set entities based on tenant config
-   */ async createDataSourceFromConfig(config) {
+    // Overrides
+    /** Override to dynamically set entities based on tenant config */ async createDataSourceFromConfig(config) {
         const currentTenant = this.getCurrentTenant();
         const enableCompanyFeature = this.getEnableCompanyFeatureForTenant(currentTenant ?? undefined);
         const entities = await this.getStorageEntities(enableCompanyFeature);