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

package/fesm/docs/index.js

@@ -1 +1,206 @@
-export { storageSwaggerConfig } from './storage-swagger.config';
+export const __rspack_esm_id = 428;
+export const __rspack_esm_ids = [428];
+export const __webpack_modules__ = {
+659(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+
+// EXPORTS
+__webpack_require__.d(__webpack_exports__, {
+  W: () => (/* reexport */ storageSwaggerConfig)
+});
+
+;// CONCATENATED MODULE: ./projects/nestjs-storage/src/docs/storage-swagger.config.ts
+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
+ */ 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
+    };
+}
+
+;// CONCATENATED MODULE: ./projects/nestjs-storage/src/docs/index.ts
+
+
+
+},
+
+};
+import { __webpack_require__ } from '../runtime.js';
+var __webpack_exec__ = function(moduleId) { return __webpack_require__(__webpack_require__.s = moduleId); }
+import * as __rspack_chunk_1 from './index.js';
+__webpack_require__.C(__rspack_chunk_1);
+var __webpack_exports__ = __webpack_exec__(659);var __webpack_exports__storageSwaggerConfig = __webpack_exports__.W;
+export { __webpack_exports__storageSwaggerConfig as storageSwaggerConfig };