@flusys/nestjs-storage 1.1.0-beta → 2.0.0

package/cjs/docs/storage-swagger.config.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "storageSwaggerConfig", {
         return storageSwaggerConfig;
     }
 });
-/** Schema properties to exclude when company feature is disabled */ const COMPANY_SCHEMA_EXCLUSIONS = [
+const COMPANY_SCHEMA_EXCLUSIONS = [
     {
         schemaName: 'FileManagerResponseDto',
         properties: [
@@ -28,120 +28,18 @@ Object.defineProperty(exports, "storageSwaggerConfig", {
         ]
     }
 ];
-function storageSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    return {
-        title: 'Storage API',
-        description: enableCompanyFeature ? `
-# Storage Management API
-
-Complete file storage and management system with multi-tenant support.
-
-## Features
-
-### 📁 File Management
-- Upload single or multiple files
-- Download files with presigned URLs
-- Delete files (single or batch)
-- File metadata management
-- Automatic compression and optimization
-- **Company isolation**
-
-### 🗂️ Folder Company
-- Create folder hierarchies
-- Organize files by folders
-- **Company-level permissions**
-- Automatic context filtering
-
-### ⚙️ Storage Configuration
-- Multiple storage providers (AWS S3, Azure, SFTP, Local)
-- Provider-specific configurations
-- Default storage settings
-- Dynamic provider switching
-
-### 🔒 Security
-- JWT authentication required
-- **Company isolation**
-- File access control
-- Presigned URL generation
-
-## Storage Providers
-
-### AWS S3
-- Scalable cloud storage
-- Automatic redundancy
-- Global CDN integration
-
-### Azure Blob Storage
-- Microsoft Azure integration
-- Geo-redundant storage
-- Advanced security features
-
-### SFTP
-- Secure file transfer
-- Legacy system integration
-- Custom server support
-
-### Local Storage
-- Same-server storage
-- Fast access
-- No external dependencies
-
+function buildDescription(enableCompanyFeature) {
+    const companyIsolation = enableCompanyFeature ? '\n- **Company isolation**' : '';
+    const companyPermissions = enableCompanyFeature ? '\n- **Company-level permissions**' : '';
+    const multiTenantSection = enableCompanyFeature ? `
 ## Multi-Tenant Support
 
 Files are automatically isolated by:
 - **Company ID**: Company-level storage
 
 All queries automatically filter by current user's company context.
-
-## File Validation
-
-### Size Limits
-Configure maximum file size per upload (default: 10MB)
-
-### File Types
-Restrict allowed file types (default: images, PDFs)
-
-### Image Compression
-- Automatic image optimization
-- Format conversion (JPEG, PNG, WebP, AVIF)
-- Resize to maximum dimensions
-- Quality control
-
-## Response Format
-
-All endpoints return standardized responses with success status, data, message, and timestamp.
-
-## Error Handling
-
-Errors return structured responses with success false, error message, error code, and timestamp.
-
-## Common Error Codes
-
-- **400 Bad Request**: Invalid input data
-- **401 Unauthorized**: Missing or invalid authentication
-- **403 Forbidden**: Insufficient permissions
-- **404 Not Found**: Resource not found
-- **413 Payload Too Large**: File exceeds size limit
-- **415 Unsupported Media Type**: File type not allowed
-- **500 Internal Server Error**: Server error
-
-## Getting Started
-
-1. **Authenticate**: Obtain JWT token from /auth/login
-2. **Configure Storage**: Create storage configuration via /storage/storage-config/insert
-3. **Create Folders**: Organize files with /storage/folder/insert
-4. **Upload Files**: Upload files via /storage/upload/single-file
-5. **Manage Files**: Track uploads in /storage/file-manager
-
-## API Endpoints
-
-All storage endpoints are prefixed with \`/storage\`:
-- \`/storage/file-manager/*\` - File metadata management
-- \`/storage/folder/*\` - Folder organization
-- \`/storage/storage-config/*\` - Storage configuration
-- \`/storage/upload/*\` - File upload/download
-
+` : '';
+    const examplesSection = enableCompanyFeature ? `
 ## Examples
 
 ### Upload a File
@@ -155,27 +53,11 @@ POST /storage/file-manager/get-all with JSON body containing page and pageSize p
 ### Create Folder
 
 POST /storage/folder/insert with JSON body containing folder name
-
-## Best Practices
-
-1. **Always authenticate**: Include JWT token in Authorization header
-2. **Use folders**: Organize files hierarchically
-3. **Check file size**: Validate before upload
-4. **Handle errors**: Implement proper error handling
-5. **Clean up**: Delete unused files regularly
-6. **Use presigned URLs**: Generate temporary URLs for file access
-7. **Compress images**: Enable compression for faster loading
-
-## Rate Limiting
-
-All endpoints are rate-limited to prevent abuse. Default limits:
-- **Upload**: 100 requests per hour
-- **Download**: 1000 requests per hour
-- **Delete**: 50 requests per hour
-      ` : `
+` : '';
+    return `
 # Storage Management API
 
-Complete file storage and management system.
+Complete file storage and management system${enableCompanyFeature ? ' with multi-tenant support' : ''}.
 
 ## Features
 
@@ -184,12 +66,12 @@ Complete file storage and management system.
 - Download files with presigned URLs
 - Delete files (single or batch)
 - File metadata management
-- Automatic compression and optimization
+- Automatic compression and optimization${companyIsolation}
 
-### 🗂️ Folder Company
+### 🗂️ Folder Organization
 - Create folder hierarchies
-- Organize files by folders
-- Folder-level company
+- Organize files by folders${companyPermissions}
+- Automatic context filtering
 
 ### ⚙️ Storage Configuration
 - Multiple storage providers (AWS S3, Azure, SFTP, Local)
@@ -198,7 +80,7 @@ Complete file storage and management system.
 - Dynamic provider switching
 
 ### 🔒 Security
-- JWT authentication required
+- JWT authentication required${companyIsolation}
 - File access control
 - Presigned URL generation
 
@@ -223,7 +105,7 @@ Complete file storage and management system.
 - Same-server storage
 - Fast access
 - No external dependencies
-
+${multiTenantSection}
 ## File Validation
 
 ### Size Limits
@@ -271,7 +153,7 @@ All storage endpoints are prefixed with \`/storage\`:
 - \`/storage/folder/*\` - Folder organization
 - \`/storage/storage-config/*\` - Storage configuration
 - \`/storage/upload/*\` - File upload/download
-
+${examplesSection}
 ## Best Practices
 
 1. **Always authenticate**: Include JWT token in Authorization header
@@ -288,7 +170,13 @@ All endpoints are rate-limited to prevent abuse. Default limits:
 - **Upload**: 100 requests per hour
 - **Download**: 1000 requests per hour
 - **Delete**: 50 requests per hour
-      `,
+`;
+}
+function storageSwaggerConfig(bootstrapConfig) {
+    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
+    return {
+        title: 'Storage API',
+        description: buildDescription(enableCompanyFeature),
         version: '1.0',
         path: 'api/docs/storage',
         bearerAuth: true,

package/cjs/dtos/file-manager.dto.js

@@ -64,8 +64,8 @@ let CreateFileManagerDto = class CreateFileManagerDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        description: 'Name of the FileManager item',
-        example: 'Summer Vacation 2025'
+        description: 'Original file name',
+        example: 'vacation-photo.jpg'
     }),
     (0, _classvalidator.IsNotEmpty)(),
     (0, _classvalidator.IsString)(),
@@ -73,8 +73,8 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "name", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        description: 'Name of the FileManager item',
-        example: 'Summer Vacation 2025'
+        description: 'Storage key or path of the file',
+        example: 'uploads/abc123-vacation-photo.jpg'
     }),
     (0, _classvalidator.IsNotEmpty)(),
     (0, _classvalidator.IsString)(),
@@ -82,7 +82,7 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "key", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        description: 'Size of the FileManager item',
+        description: 'Size of the file in bytes',
         example: '1024'
     }),
     (0, _classvalidator.IsNotEmpty)(),
@@ -91,7 +91,7 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "size", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        description: 'mime type of file',
+        description: 'MIME type of file',
         example: 'image/jpeg'
     }),
     (0, _classvalidator.IsNotEmpty)(),
@@ -100,7 +100,7 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "contentType", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        description: 'Indicates if the FileManager item is private',
+        description: 'Indicates if the file is private',
         example: true
     }),
     (0, _classvalidator.IsNotEmpty)(),
@@ -108,21 +108,21 @@ _ts_decorate([
     _ts_metadata("design:type", Boolean)
 ], CreateFileManagerDto.prototype, "isPrivate", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)({
+    (0, _swagger.ApiPropertyOptional)({
         description: 'Folder ID (UUID)',
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
     (0, _classvalidator.IsOptional)(),
-    (0, _classvalidator.IsString)(),
+    (0, _classvalidator.IsUUID)(),
     _ts_metadata("design:type", String)
 ], CreateFileManagerDto.prototype, "folderId", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        description: 'Storage configuration ID - if not provided, uses default',
+        description: 'Storage configuration ID',
         example: '123e4567-e89b-12d3-a456-426614174000'
     }),
     (0, _classvalidator.IsOptional)(),
-    (0, _classvalidator.IsString)(),
+    (0, _classvalidator.IsUUID)(),
     _ts_metadata("design:type", String)
 ], CreateFileManagerDto.prototype, "storageConfigId", void 0);
 _ts_decorate([
@@ -142,21 +142,66 @@ let UpdateFileManagerDto = class UpdateFileManagerDto extends (0, _swagger.Parti
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        description: 'Unique identifier of the folder',
+        description: 'Unique identifier of the file',
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
+    (0, _classvalidator.IsUUID)(),
     (0, _classvalidator.IsNotEmpty)(),
     _ts_metadata("design:type", String)
 ], UpdateFileManagerDto.prototype, "id", void 0);
-let FileManagerResponseDto = class FileManagerResponseDto extends UpdateFileManagerDto {
-    constructor(...args){
-        super(...args), _define_property(this, "providerName", void 0);
+let FileManagerResponseDto = class FileManagerResponseDto {
+    constructor(){
+        _define_property(this, "id", void 0);
+        _define_property(this, "name", void 0);
+        _define_property(this, "key", void 0);
+        _define_property(this, "size", void 0);
+        _define_property(this, "contentType", void 0);
+        _define_property(this, "isPrivate", void 0);
+        _define_property(this, "folderId", void 0);
+        _define_property(this, "storageConfigId", void 0);
+        _define_property(this, "location", void 0);
+        _define_property(this, "providerName", void 0);
     }
 };
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "id", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "name", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "key", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "size", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "contentType", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", Boolean)
+], FileManagerResponseDto.prototype, "isPrivate", void 0);
+_ts_decorate([
+    (0, _swagger.ApiPropertyOptional)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "folderId", void 0);
+_ts_decorate([
+    (0, _swagger.ApiPropertyOptional)(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "storageConfigId", void 0);
+_ts_decorate([
+    (0, _swagger.ApiPropertyOptional)(),
+    _ts_metadata("design:type", typeof _enums.FileLocationEnum === "undefined" ? Object : _enums.FileLocationEnum)
+], FileManagerResponseDto.prototype, "location", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 'My S3 Storage',
-        description: 'Name of the storage configuration/provider'
+        description: 'Name of the storage provider'
     }),
     _ts_metadata("design:type", String)
 ], FileManagerResponseDto.prototype, "providerName", void 0);
@@ -169,6 +214,8 @@ _ts_decorate([
     (0, _swagger.ApiProperty)({
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
+    (0, _classvalidator.IsUUID)(),
+    (0, _classvalidator.IsNotEmpty)(),
     _ts_metadata("design:type", String)
 ], GetFilesRequestDto.prototype, "id", void 0);
 let FilesResponseDto = class FilesResponseDto {
@@ -183,47 +230,36 @@ let FilesResponseDto = class FilesResponseDto {
     }
 };
 _ts_decorate([
-    (0, _swagger.ApiProperty)({
-        example: 'file123.jpg'
-    }),
+    (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "id", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)({
-        example: 'file123.jpg'
-    }),
+    (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "name", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)({
-        example: 'image/jpeg'
-    }),
+    (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "contentType", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)({
-        example: 'https://example.com/file123.jpg'
-    }),
+    (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "url", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 'local',
-        description: 'Storage provider type (local, aws, azure, sftp)'
+        description: 'Storage provider type'
     }),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "location", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: '123e4567-e89b-12d3-a456-426614174000',
         description: 'Storage configuration ID'
     }),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "storageConfigId", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 'My S3 Storage',
-        description: 'Name of the storage configuration/provider'
+        description: 'Name of the storage provider'
     }),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "providerName", void 0);

package/cjs/dtos/folder.dto.js

@@ -67,20 +67,26 @@ _ts_decorate([
         description: 'Unique identifier of the folder',
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
+    (0, _classvalidator.IsUUID)(),
     (0, _classvalidator.IsNotEmpty)(),
     _ts_metadata("design:type", String)
 ], UpdateFolderDto.prototype, "id", void 0);
-let FolderResponseDto = class FolderResponseDto extends UpdateFolderDto {
-    constructor(...args){
-        super(...args), _define_property(this, "slug", void 0);
+let FolderResponseDto = class FolderResponseDto {
+    constructor(){
+        _define_property(this, "id", void 0);
+        _define_property(this, "name", void 0);
+        _define_property(this, "slug", void 0);
     }
 };
 _ts_decorate([
-    (0, _swagger.ApiProperty)({
-        description: 'Name of the folder',
-        example: 'Invoices'
-    }),
-    (0, _classvalidator.IsNotEmpty)(),
-    (0, _classvalidator.IsString)(),
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FolderResponseDto.prototype, "id", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
+    _ts_metadata("design:type", String)
+], FolderResponseDto.prototype, "name", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
 ], FolderResponseDto.prototype, "slug", void 0);

package/cjs/dtos/storage-config.dto.js

@@ -75,20 +75,6 @@ _ts_decorate([
 ], CreateStorageConfigDto.prototype, "storage", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        type: 'object',
-        properties: {
-            region: {
-                type: 'string',
-                example: 'us-east-1',
-                description: 'Cloud region'
-            },
-            bucket: {
-                type: 'string',
-                example: 'my-bucket',
-                description: 'Bucket name'
-            }
-        },
-        additionalProperties: true,
         description: 'Provider-specific configuration',
         example: {
             region: 'us-east-1',
@@ -117,86 +103,19 @@ _ts_decorate([
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", Boolean)
 ], CreateStorageConfigDto.prototype, "isDefault", void 0);
-let UpdateStorageConfigDto = class UpdateStorageConfigDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _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);
+let UpdateStorageConfigDto = class UpdateStorageConfigDto extends (0, _swagger.PartialType)((0, _swagger.OmitType)(CreateStorageConfigDto, [])) {
+    constructor(...args){
+        super(...args), _define_property(this, "id", void 0);
     }
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
         example: '123e4567-e89b-12d3-a456-426614174000'
     }),
-    (0, _classvalidator.IsString)(),
+    (0, _classvalidator.IsUUID)(),
     (0, _classvalidator.IsNotEmpty)(),
     _ts_metadata("design:type", String)
 ], UpdateStorageConfigDto.prototype, "id", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: 'Production AWS S3'
-    }),
-    (0, _classvalidator.IsString)(),
-    (0, _classvalidator.IsOptional)(),
-    (0, _classvalidator.MaxLength)(255),
-    _ts_metadata("design:type", String)
-], UpdateStorageConfigDto.prototype, "name", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        enum: _enums.FileLocationEnum,
-        example: _enums.FileLocationEnum.AWS
-    }),
-    (0, _classvalidator.IsEnum)(_enums.FileLocationEnum),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", typeof _enums.FileLocationEnum === "undefined" ? Object : _enums.FileLocationEnum)
-], UpdateStorageConfigDto.prototype, "storage", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        type: 'object',
-        properties: {
-            region: {
-                type: 'string',
-                example: 'us-east-1',
-                description: 'Cloud region'
-            },
-            bucket: {
-                type: 'string',
-                example: 'my-bucket',
-                description: 'Bucket name'
-            }
-        },
-        additionalProperties: true,
-        description: 'Provider-specific configuration',
-        example: {
-            region: 'us-east-1',
-            bucket: 'my-bucket'
-        }
-    }),
-    (0, _classvalidator.IsObject)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], UpdateStorageConfigDto.prototype, "config", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: true,
-        description: 'Whether storage configuration is active'
-    }),
-    (0, _classvalidator.IsBoolean)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", Boolean)
-], UpdateStorageConfigDto.prototype, "isActive", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: false,
-        description: 'Set as default storage configuration'
-    }),
-    (0, _classvalidator.IsBoolean)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", Boolean)
-], UpdateStorageConfigDto.prototype, "isDefault", void 0);
 let StorageConfigResponseDto = class StorageConfigResponseDto extends _dtos.IdentityResponseDto {
     constructor(...args){
         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);