@flusys/nestjs-storage 1.0.0-rc → 1.0.0

package/dtos/file-manager.dto.d.ts

@@ -1,4 +1,3 @@
-import { FileLocationEnum } from '../enums';
 export declare class CreateFileManagerDto {
     name: string;
     key: string;
@@ -7,13 +6,22 @@ export declare class CreateFileManagerDto {
     isPrivate: boolean;
     folderId?: string;
     storageConfigId?: string;
-    location?: FileLocationEnum;
+    location?: string;
 }
 declare const UpdateFileManagerDto_base: import("@nestjs/common").Type<Partial<CreateFileManagerDto>>;
 export declare class UpdateFileManagerDto extends UpdateFileManagerDto_base {
     id: string;
 }
-export declare class FileManagerResponseDto extends UpdateFileManagerDto {
+export declare class FileManagerResponseDto {
+    id: string;
+    name: string;
+    key: string;
+    size: string;
+    contentType: string;
+    isPrivate: boolean;
+    folderId?: string;
+    storageConfigId?: string;
+    location?: string;
     providerName?: string;
 }
 export declare class GetFilesRequestDto {

package/dtos/folder.dto.d.ts

@@ -5,7 +5,9 @@ declare const UpdateFolderDto_base: import("@nestjs/common").Type<Partial<Create
 export declare class UpdateFolderDto extends UpdateFolderDto_base {
     id: string;
 }
-export declare class FolderResponseDto extends UpdateFolderDto {
+export declare class FolderResponseDto {
+    id: string;
+    name: string;
     slug: string;
 }
 export {};

package/dtos/storage-config.dto.d.ts

@@ -1,24 +1,20 @@
 import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
-import { FileLocationEnum } from '../enums';
 export declare class CreateStorageConfigDto {
     name: string;
-    storage: FileLocationEnum;
-    config: Record<string, any>;
+    storage: string;
+    config: Record<string, unknown>;
     isActive?: boolean;
     isDefault?: boolean;
 }
-export declare class UpdateStorageConfigDto {
+declare const UpdateStorageConfigDto_base: import("@nestjs/common").Type<Partial<Omit<CreateStorageConfigDto, never>>>;
+export declare class UpdateStorageConfigDto extends UpdateStorageConfigDto_base {
     id: string;
-    name?: string;
-    storage?: FileLocationEnum;
-    config?: Record<string, any>;
-    isActive?: boolean;
-    isDefault?: boolean;
 }
 export declare class StorageConfigResponseDto extends IdentityResponseDto {
     name: string;
-    storage: FileLocationEnum;
-    config: Record<string, any>;
+    storage: string;
+    config: Record<string, unknown>;
     isActive: boolean;
     isDefault: boolean;
 }
+export {};

package/entities/file-manager-with-company.entity.d.ts

@@ -1,6 +1,6 @@
-import { FileManagerBase } from './file-manager-base.entity';
+import { FileManager } from './file-manager.entity';
 import { FolderWithCompany } from './folder-with-company.entity';
-export declare class FileManagerWithCompany extends FileManagerBase {
+export declare class FileManagerWithCompany extends FileManager {
     companyId: string | null;
     folder: FolderWithCompany | null;
 }

package/entities/file-manager.entity.d.ts

@@ -1,5 +1,14 @@
-import { FileManagerBase } from './file-manager-base.entity';
+import { Identity } from '@flusys/nestjs-shared/entities';
 import { Folder } from './folder.entity';
-export declare class FileManager extends FileManagerBase {
+export declare class FileManager extends Identity {
+    name: string;
+    contentType: string;
+    size: string;
+    key: string;
+    url: string | null;
+    location: string;
+    storageConfigId: string | null;
+    expiresAt: number | null;
+    isPrivate: boolean;
     folder: Folder | null;
 }

package/entities/folder-with-company.entity.d.ts

@@ -1,5 +1,5 @@
-import { FolderBase } from './folder-base.entity';
-export declare class FolderWithCompany extends FolderBase {
+import { Folder } from './folder.entity';
+export declare class FolderWithCompany extends Folder {
     companyId: string | null;
     fileManager: any[];
 }

package/entities/folder.entity.d.ts

@@ -1,4 +1,6 @@
-import { FolderBase } from './folder-base.entity';
-export declare class Folder extends FolderBase {
+import { Identity } from '@flusys/nestjs-shared/entities';
+export declare class Folder extends Identity {
+    name: string;
+    slug: string;
     fileManager: any[];
 }

package/entities/index.d.ts

@@ -1,6 +1,3 @@
-export * from './file-manager-base.entity';
-export * from './folder-base.entity';
-export * from './storage-config-base.entity';
 export * from './file-manager.entity';
 export * from './folder.entity';
 export * from './storage-config.entity';
@@ -15,5 +12,7 @@ import { FolderWithCompany } from './folder-with-company.entity';
 import { StorageConfigWithCompany } from './storage-config-with-company.entity';
 export declare const StorageCoreEntities: (typeof Folder | typeof FileManager | typeof StorageConfig)[];
 export declare const StorageCompanyEntities: (typeof FolderWithCompany | typeof FileManagerWithCompany | typeof StorageConfigWithCompany)[];
-export declare const StorageAllEntities: (typeof Folder | typeof FileManager | typeof StorageConfig)[];
 export declare function getStorageEntitiesByConfig(enableCompanyFeature: boolean): any[];
+export { FileManager as FileManagerBase } from './file-manager.entity';
+export { Folder as FolderBase } from './folder.entity';
+export { StorageConfig as StorageConfigBase } from './storage-config.entity';

package/entities/storage-config-with-company.entity.d.ts

@@ -1,4 +1,4 @@
-import { StorageConfigBase } from './storage-config-base.entity';
-export declare class StorageConfigWithCompany extends StorageConfigBase {
+import { StorageConfig } from './storage-config.entity';
+export declare class StorageConfigWithCompany extends StorageConfig {
     companyId: string | null;
 }

package/entities/storage-config.entity.d.ts

@@ -1,3 +1,8 @@
-import { StorageConfigBase } from './storage-config-base.entity';
-export declare class StorageConfig extends StorageConfigBase {
+import { Identity } from '@flusys/nestjs-shared/entities';
+export declare class StorageConfig extends Identity {
+    name: string;
+    storage: string;
+    config: Record<string, any>;
+    isActive: boolean;
+    isDefault: boolean;
 }

package/fesm/config/index.js

@@ -1,2 +1 @@
 export * from './storage.constants';
-export * from './storage-config.service';

package/fesm/config/storage.constants.js

@@ -5,9 +5,3 @@ export const DEFAULT_MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
 export const DEFAULT_ALLOWED_FILE_TYPES = [
     '*/*'
 ]; // All file types
-export const FILE_VALIDATION_MESSAGES = {
-    FILE_TOO_LARGE: 'File size exceeds the maximum allowed size',
-    INVALID_FILE_TYPE: 'File type is not allowed',
-    NO_FILE_PROVIDED: 'No file was provided',
-    UPLOAD_FAILED: 'File upload failed'
-};

package/fesm/controllers/upload.controller.js

@@ -34,35 +34,30 @@ import { FileInterceptor, FilesInterceptor } from '@nestjs/platform-express';
 import { ApiBearerAuth, ApiBody, ApiConsumes, ApiOperation, ApiQuery, ApiTags } from '@nestjs/swagger';
 import { UploadService } from '../services/upload.service';
 export class UploadController {
+    toFileUploadResponse(file) {
+        return {
+            size: this.uploadService.bytesToKb(file.size),
+            name: file.name,
+            key: file.key,
+            contentType: file.contentType,
+            location: file.location || 'local',
+            storageConfigId: file.storageConfigId || ''
+        };
+    }
     async uploadSingleFile(file, options, user) {
         const result = await this.uploadService.uploadSingleFile(file, options, user);
         return {
             success: true,
             message: 'File uploaded successfully',
-            data: {
-                size: this.uploadService.bytesToKb(result.size),
-                name: result.name,
-                key: result.key,
-                contentType: result.contentType,
-                location: result.location || 'local',
-                storageConfigId: result.storageConfigId || ''
-            }
+            data: this.toFileUploadResponse(result)
         };
     }
     async uploadMultipleFiles(files, options, user) {
         const uploadResponses = await this.uploadService.uploadMultipleFiles(files, options, user);
-        const responseData = uploadResponses.map((file)=>({
-                size: this.uploadService.bytesToKb(file.size),
-                name: file.name,
-                key: file.key,
-                contentType: file.contentType,
-                location: file.location || 'local',
-                storageConfigId: file.storageConfigId || ''
-            }));
         return {
             success: true,
             message: 'Files uploaded successfully',
-            data: responseData
+            data: uploadResponses.map((file)=>this.toFileUploadResponse(file))
         };
     }
     async deleteSingleFile(dto, user) {

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

@@ -1,4 +1,4 @@
-/** Schema properties to exclude when company feature is disabled */ const COMPANY_SCHEMA_EXCLUSIONS = [
+const COMPANY_SCHEMA_EXCLUSIONS = [
     {
         schemaName: 'FileManagerResponseDto',
         properties: [
@@ -18,126 +18,18 @@
         ]
     }
 ];
-/**
- * Storage Module Swagger Configuration
- * Use this with setupSwaggerDocs() from @flusys/nestjs-core
- *
- * @param bootstrapConfig - Bootstrap configuration to determine feature visibility
- * @returns Swagger configuration with appropriate excludeSchemaProperties based on enableCompanyFeature
- */ export 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
@@ -151,27 +43,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
 
@@ -180,12 +56,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)
@@ -194,7 +70,7 @@ Complete file storage and management system.
 - Dynamic provider switching
 
 ### 🔒 Security
-- JWT authentication required
+- JWT authentication required${companyIsolation}
 - File access control
 - Presigned URL generation
 
@@ -219,7 +95,7 @@ Complete file storage and management system.
 - Same-server storage
 - Fast access
 - No external dependencies
-
+${multiTenantSection}
 ## File Validation
 
 ### Size Limits
@@ -267,7 +143,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
@@ -284,7 +160,16 @@ 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;
+    return {
+        title: 'Storage API',
+        description: buildDescription(enableCompanyFeature),
         version: '1.0',
         path: 'api/docs/storage',
         bearerAuth: true,

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

@@ -21,7 +21,7 @@ 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 { IsBoolean, IsEnum, IsNotEmpty, IsOptional, IsString } from 'class-validator';
+import { IsBoolean, IsEnum, IsNotEmpty, IsOptional, IsString, IsUUID } from 'class-validator';
 import { FileLocationEnum } from '../enums';
 export class CreateFileManagerDto {
     constructor(){
@@ -55,7 +55,7 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "key", void 0);
 _ts_decorate([
     ApiProperty({
-        description: 'Size of the FileManager item',
+        description: 'Size of the file in bytes',
         example: '1024'
     }),
     IsNotEmpty(),
@@ -64,7 +64,7 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "size", void 0);
 _ts_decorate([
     ApiProperty({
-        description: 'mime type of file',
+        description: 'MIME type of file',
         example: 'image/jpeg'
     }),
     IsNotEmpty(),
@@ -73,7 +73,7 @@ _ts_decorate([
 ], CreateFileManagerDto.prototype, "contentType", void 0);
 _ts_decorate([
     ApiProperty({
-        description: 'Indicates if the FileManager item is private',
+        description: 'Indicates if the file is private',
         example: true
     }),
     IsNotEmpty(),
@@ -81,21 +81,21 @@ _ts_decorate([
     _ts_metadata("design:type", Boolean)
 ], CreateFileManagerDto.prototype, "isPrivate", void 0);
 _ts_decorate([
-    ApiProperty({
+    ApiPropertyOptional({
         description: 'Folder ID (UUID)',
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
     IsOptional(),
-    IsString(),
+    IsUUID(),
     _ts_metadata("design:type", String)
 ], CreateFileManagerDto.prototype, "folderId", void 0);
 _ts_decorate([
     ApiPropertyOptional({
-        description: 'Storage configuration ID - if not provided, uses default',
+        description: 'Storage configuration ID',
         example: '123e4567-e89b-12d3-a456-426614174000'
     }),
     IsOptional(),
-    IsString(),
+    IsUUID(),
     _ts_metadata("design:type", String)
 ], CreateFileManagerDto.prototype, "storageConfigId", void 0);
 _ts_decorate([
@@ -106,7 +106,7 @@ _ts_decorate([
     }),
     IsOptional(),
     IsEnum(FileLocationEnum),
-    _ts_metadata("design:type", typeof FileLocationEnum === "undefined" ? Object : FileLocationEnum)
+    _ts_metadata("design:type", String)
 ], CreateFileManagerDto.prototype, "location", void 0);
 export class UpdateFileManagerDto extends PartialType(CreateFileManagerDto) {
     constructor(...args){
@@ -118,19 +118,63 @@ _ts_decorate([
         description: 'Unique identifier of the file',
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
+    IsUUID(),
     IsNotEmpty(),
-    IsString(),
     _ts_metadata("design:type", String)
 ], UpdateFileManagerDto.prototype, "id", void 0);
-export class FileManagerResponseDto extends UpdateFileManagerDto {
-    constructor(...args){
-        super(...args), _define_property(this, "providerName", 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([
+    ApiProperty(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "id", void 0);
+_ts_decorate([
+    ApiProperty(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "name", void 0);
+_ts_decorate([
+    ApiProperty(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "key", void 0);
+_ts_decorate([
+    ApiProperty(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "size", void 0);
+_ts_decorate([
+    ApiProperty(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "contentType", void 0);
+_ts_decorate([
+    ApiProperty(),
+    _ts_metadata("design:type", Boolean)
+], FileManagerResponseDto.prototype, "isPrivate", void 0);
+_ts_decorate([
+    ApiPropertyOptional(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "folderId", void 0);
+_ts_decorate([
+    ApiPropertyOptional(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "storageConfigId", void 0);
+_ts_decorate([
+    ApiPropertyOptional(),
+    _ts_metadata("design:type", String)
+], FileManagerResponseDto.prototype, "location", void 0);
 _ts_decorate([
     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);
@@ -143,8 +187,8 @@ _ts_decorate([
     ApiProperty({
         example: 'f2e9c8d0-7a2a-11eb-9439-0242ac130002'
     }),
+    IsUUID(),
     IsNotEmpty(),
-    IsString(),
     _ts_metadata("design:type", String)
 ], GetFilesRequestDto.prototype, "id", void 0);
 export class FilesResponseDto {
@@ -159,47 +203,36 @@ export class FilesResponseDto {
     }
 }
 _ts_decorate([
-    ApiProperty({
-        example: 'file123.jpg'
-    }),
+    ApiProperty(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "id", void 0);
 _ts_decorate([
-    ApiProperty({
-        example: 'file123.jpg'
-    }),
+    ApiProperty(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "name", void 0);
 _ts_decorate([
-    ApiProperty({
-        example: 'image/jpeg'
-    }),
+    ApiProperty(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "contentType", void 0);
 _ts_decorate([
-    ApiProperty({
-        example: 'https://example.com/file123.jpg'
-    }),
+    ApiProperty(),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "url", void 0);
 _ts_decorate([
     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([
     ApiPropertyOptional({
-        example: '123e4567-e89b-12d3-a456-426614174000',
         description: 'Storage configuration ID'
     }),
     _ts_metadata("design:type", String)
 ], FilesResponseDto.prototype, "storageConfigId", void 0);
 _ts_decorate([
     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);