@flusys/nestjs-storage 7.1.0 → 8.0.0-beta.1

package/fesm/controllers/upload.controller.spec.js

@@ -1,128 +0,0 @@
-import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
-import { UploadController } from './upload.controller';
-describe('UploadController', ()=>{
-    let controller;
-    let mockUploadService;
-    beforeEach(()=>{
-        mockUploadService = {
-            bytesToKb: jest.fn((bytes)=>bytes / 1024),
-            uploadSingleFile: jest.fn(),
-            uploadMultipleFiles: jest.fn(),
-            deleteSingleFile: jest.fn(),
-            deleteMultipleFile: jest.fn()
-        };
-        controller = new UploadController(mockUploadService);
-    });
-    describe('uploadSingleFile', ()=>{
-        it('uploads a file and maps the response payload', async ()=>{
-            const user = buildMockUser();
-            const file = {
-                originalname: 'photo.png'
-            };
-            mockUploadService.uploadSingleFile.mockResolvedValue({
-                size: 2048,
-                name: 'photo.png',
-                key: 'files/photo.png',
-                contentType: 'image/png',
-                location: 's3',
-                storageConfigId: 'storage-1'
-            });
-            const result = await controller.uploadSingleFile(file, {
-                folderPath: 'photos'
-            }, user);
-            expect(mockUploadService.uploadSingleFile).toHaveBeenCalledWith(file, {
-                folderPath: 'photos'
-            }, user);
-            expect(mockUploadService.bytesToKb).toHaveBeenCalledWith(2048);
-            expect(result).toEqual({
-                success: true,
-                message: 'File uploaded successfully',
-                messageKey: expect.any(String),
-                data: {
-                    size: 2,
-                    name: 'photo.png',
-                    key: 'files/photo.png',
-                    contentType: 'image/png',
-                    location: 's3',
-                    storageConfigId: 'storage-1'
-                }
-            });
-        });
-        it('defaults location to "local" and storageConfigId to an empty string when absent', async ()=>{
-            const user = buildMockUser();
-            mockUploadService.uploadSingleFile.mockResolvedValue({
-                size: 100,
-                name: 'file.txt',
-                key: 'files/file.txt',
-                contentType: 'text/plain'
-            });
-            const result = await controller.uploadSingleFile({}, {}, user);
-            expect(result.data.location).toBe('local');
-            expect(result.data.storageConfigId).toBe('');
-        });
-    });
-    describe('uploadMultipleFiles', ()=>{
-        it('uploads multiple files and maps each response payload', async ()=>{
-            const user = buildMockUser();
-            const files = [
-                {
-                    originalname: 'a.png'
-                },
-                {
-                    originalname: 'b.png'
-                }
-            ];
-            mockUploadService.uploadMultipleFiles.mockResolvedValue([
-                {
-                    size: 100,
-                    name: 'a.png',
-                    key: 'files/a.png',
-                    contentType: 'image/png'
-                },
-                {
-                    size: 200,
-                    name: 'b.png',
-                    key: 'files/b.png',
-                    contentType: 'image/png'
-                }
-            ]);
-            const result = await controller.uploadMultipleFiles(files, {}, user);
-            expect(mockUploadService.uploadMultipleFiles).toHaveBeenCalledWith(files, {}, user);
-            expect(result.data).toHaveLength(2);
-            expect(result.data[0]).toEqual(expect.objectContaining({
-                name: 'a.png',
-                key: 'files/a.png'
-            }));
-        });
-    });
-    describe('deleteSingleFile', ()=>{
-        it('deletes a file by key and storage config', async ()=>{
-            const user = buildMockUser();
-            mockUploadService.deleteSingleFile.mockResolvedValue(true);
-            const result = await controller.deleteSingleFile({
-                key: 'files/a.png',
-                storageConfigId: 'storage-1'
-            }, user);
-            expect(mockUploadService.deleteSingleFile).toHaveBeenCalledWith('files/a.png', 'storage-1', user);
-            expect(result.data).toBe(true);
-        });
-    });
-    describe('deleteMultipleFile', ()=>{
-        it('deletes multiple files by keys and storage config', async ()=>{
-            const user = buildMockUser();
-            mockUploadService.deleteMultipleFile.mockResolvedValue(true);
-            const result = await controller.deleteMultipleFile({
-                keys: [
-                    'files/a.png',
-                    'files/b.png'
-                ],
-                storageConfigId: 'storage-1'
-            }, user);
-            expect(mockUploadService.deleteMultipleFile).toHaveBeenCalledWith([
-                'files/a.png',
-                'files/b.png'
-            ], 'storage-1', user);
-            expect(result.data).toBe(true);
-        });
-    });
-});

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

@@ -1,181 +0,0 @@
-const COMPANY_SCHEMA_EXCLUSIONS = [
-    {
-        schemaName: 'FileManagerResponseDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'FolderResponseDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'StorageConfigResponseDto',
-        properties: [
-            'companyId'
-        ]
-    }
-];
-function buildDescription(enableCompanyFeature, isMultiTenant) {
-    const multiTenantNote = isMultiTenant ? `\n> **Multi-Tenant Mode**: Include \`x-tenant-id\` header to target a specific tenant database.\n` : '';
-    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.
-` : '';
-    const examplesSection = enableCompanyFeature ? `
-## Examples
-
-### Upload a File
-
-POST /storage/upload/single-file with multipart/form-data containing file and optional folderId
-
-### Get All Files
-
-POST /storage/file-manager/get-all with JSON body containing page and pageSize parameters
-
-### Create Folder
-
-POST /storage/folder/insert with JSON body containing folder name
-` : '';
-    return `
-# Storage Management API
-${multiTenantNote}
-Complete file storage and management system${enableCompanyFeature ? ' 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${companyIsolation}
-
-### 🗂️ Folder Organization
-- Create folder hierarchies
-- Organize files by folders${companyPermissions}
-- 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${companyIsolation}
-- 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
-${multiTenantSection}
-## 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
-${examplesSection}
-## 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
-`;
-}
-/**
- * Storage Module Swagger Configuration
- * Use this with setupSwaggerDocs() from @flusys/nestjs-core
- */ export function storageSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    const isMultiTenant = bootstrapConfig?.databaseMode === 'multi-tenant';
-    return {
-        title: 'Storage API',
-        description: buildDescription(enableCompanyFeature, isMultiTenant),
-        version: '1.0',
-        path: 'api/docs/storage',
-        bearerAuth: true,
-        excludeTags: [],
-        excludeSchemaProperties: enableCompanyFeature ? undefined : COMPANY_SCHEMA_EXCLUSIONS
-    };
-}

package/fesm/docs/storage-swagger.config.spec.js

@@ -1,68 +0,0 @@
-import { storageSwaggerConfig } from './storage-swagger.config';
-describe('storageSwaggerConfig', ()=>{
-    it('should default to company feature enabled and single-database mode when no config is given', ()=>{
-        const config = storageSwaggerConfig();
-        expect(config.title).toBe('Storage API');
-        expect(config.path).toBe('api/docs/storage');
-        expect(config.bearerAuth).toBe(true);
-        expect(config.excludeTags).toEqual([]);
-        expect(config.excludeSchemaProperties).toBeUndefined();
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-        expect(config.description).toContain('with multi-tenant support');
-    });
-    it('should exclude companyId schema properties when the company feature is disabled', ()=>{
-        const config = storageSwaggerConfig({
-            enableCompanyFeature: false
-        });
-        expect(config.excludeSchemaProperties).toEqual([
-            {
-                schemaName: 'FileManagerResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'FolderResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'StorageConfigResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            }
-        ]);
-    });
-    it('should not exclude any schema properties when the company feature is enabled', ()=>{
-        const config = storageSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        expect(config.excludeSchemaProperties).toBeUndefined();
-    });
-    it('should describe company isolation and multi-tenant sections only when the company feature is enabled', ()=>{
-        const withCompany = storageSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = storageSwaggerConfig({
-            enableCompanyFeature: false
-        });
-        expect(withCompany.description).toContain('Company isolation');
-        expect(withCompany.description).toContain('## Multi-Tenant Support');
-        expect(withCompany.description).toContain('## Examples');
-        expect(withoutCompany.description).not.toContain('Company isolation');
-        expect(withoutCompany.description).not.toContain('## Multi-Tenant Support');
-        expect(withoutCompany.description).not.toContain('## Examples');
-    });
-    it('should mention multi-tenant mode in the description only for multi-tenant database mode', ()=>{
-        const multiTenant = storageSwaggerConfig({
-            databaseMode: 'multi-tenant'
-        });
-        const single = storageSwaggerConfig({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-});

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

@@ -1,300 +0,0 @@
-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;
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Expose } from 'class-transformer';
-import { IsBoolean, IsEnum, IsNotEmpty, IsOptional, IsString, IsUUID } from 'class-validator';
-import { FileLocationEnum } from '../enums';
-export class CreateFileManagerDto {
-    constructor(){
-        _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);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Original file name',
-        example: 'vacation-photo.jpg'
-    }),
-    IsNotEmpty(),
-    IsString(),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "name", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Storage key or path of the file',
-        example: 'uploads/abc123-vacation-photo.jpg'
-    }),
-    IsNotEmpty(),
-    IsString(),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "key", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Size of the file in bytes',
-        example: '1024'
-    }),
-    IsNotEmpty(),
-    IsString(),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "size", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'MIME type of file',
-        example: 'image/jpeg'
-    }),
-    IsNotEmpty(),
-    IsString(),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "contentType", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Indicates if the file is private',
-        example: true
-    }),
-    IsNotEmpty(),
-    IsBoolean(),
-    _ts_metadata("design:type", Boolean)
-], CreateFileManagerDto.prototype, "isPrivate", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'Folder ID (UUID)',
-        example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
-    }),
-    IsOptional(),
-    IsUUID(),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "folderId", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'Storage configuration ID',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsOptional(),
-    IsUUID(),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "storageConfigId", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'Storage location type',
-        enum: FileLocationEnum,
-        example: FileLocationEnum.AWS
-    }),
-    IsOptional(),
-    IsEnum(FileLocationEnum),
-    _ts_metadata("design:type", String)
-], CreateFileManagerDto.prototype, "location", void 0);
-export class UpdateFileManagerDto extends PartialType(CreateFileManagerDto) {
-    constructor(...args){
-        super(...args), _define_property(this, "id", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Unique identifier of the file',
-        example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], UpdateFileManagerDto.prototype, "id", void 0);
-export 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([
-    Expose(),
-    ApiProperty({
-        description: 'Unique identifier of the file',
-        example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "id", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'Original filename as uploaded',
-        example: 'profile-photo.png'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'Storage key / path used to retrieve the file from the provider',
-        example: 'uploads/users/abc123/profile-photo.png'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "key", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'File size in bytes',
-        example: '204800'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "size", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'MIME type of the file',
-        example: 'image/png'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "contentType", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'Whether the file is private and requires signed URL access',
-        example: false
-    }),
-    _ts_metadata("design:type", Boolean)
-], FileManagerResponseDto.prototype, "isPrivate", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'ID of the folder this file belongs to; absent if in root',
-        example: 'a1b2c3d4-0000-0000-0000-000000000001'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "folderId", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'ID of the storage configuration used to store this file',
-        example: 'a1b2c3d4-0000-0000-0000-000000000002'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "storageConfigId", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'Storage provider type (e.g. s3, gcs, local)',
-        example: 's3'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "location", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'Human-readable name of the storage provider',
-        example: 'AWS S3 — Production Bucket'
-    }),
-    _ts_metadata("design:type", String)
-], FileManagerResponseDto.prototype, "providerName", void 0);
-export class GetFilesRequestDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Unique identifier of the file to retrieve',
-        example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], GetFilesRequestDto.prototype, "id", void 0);
-export class FilesResponseDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _define_property(this, "name", void 0);
-        _define_property(this, "contentType", void 0);
-        _define_property(this, "url", void 0);
-        _define_property(this, "location", void 0);
-        _define_property(this, "storageConfigId", void 0);
-        _define_property(this, "providerName", void 0);
-    }
-}
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'Unique identifier of the file',
-        example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "id", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'Original filename as uploaded',
-        example: 'quarterly-report.pdf'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'MIME type of the file',
-        example: 'application/pdf'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "contentType", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        description: 'Publicly accessible or pre-signed URL to download the file',
-        example: 'https://cdn.example.com/uploads/quarterly-report.pdf'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "url", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'Storage provider type (e.g. s3, gcs, local)',
-        example: 'gcs'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "location", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'ID of the storage configuration used to store this file',
-        example: 'a1b2c3d4-0000-0000-0000-000000000002'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "storageConfigId", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        description: 'Human-readable name of the storage provider',
-        example: 'Google Cloud Storage — EU'
-    }),
-    _ts_metadata("design:type", String)
-], FilesResponseDto.prototype, "providerName", void 0);