@flusys/nestjs-storage 7.1.0 → 8.0.0

package/fesm/modules/storage.module.js

@@ -1,156 +0,0 @@
-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;
-}
-import { CacheModule, UtilsModule, createModuleEventsProvider } from '@flusys/nestjs-shared/modules';
-import { Logger, Module, RequestMethod } from '@nestjs/common';
-import { FileServeMiddleware } from '../middlewares';
-import { StorageConfigService } from '../services';
-import { STORAGE_MODULE_OPTIONS } from '../config/storage.constants';
-import { FileManagerController, FolderController, StorageConfigController, UploadController } from '../controllers';
-import { FileLocationEnum } from '../enums/file-location.enum';
-import { StorageFactoryService, StorageProviderRegistry } from '../providers';
-import { LocalProvider } from '../providers/local-provider';
-import { FileManagerService, FolderService, StorageDataSourceProvider, UploadService } from '../services';
-import { StorageProviderConfigService } from '../services/storage-provider-config.service';
-const logger = new Logger('StorageModule');
-const CONTROLLERS = [
-    FileManagerController,
-    FolderController,
-    StorageConfigController,
-    UploadController
-];
-const EXPORTED_SERVICES = [
-    StorageConfigService,
-    StorageDataSourceProvider,
-    FileManagerService,
-    FolderService,
-    StorageProviderConfigService,
-    UploadService,
-    StorageFactoryService
-];
-// Register built-in provider
-StorageProviderRegistry.register(FileLocationEnum.LOCAL, LocalProvider);
-logger.log('Registered LocalProvider');
-// Register optional providers (skip if dependencies not installed)
-const OPTIONAL_PROVIDERS = [
-    {
-        location: FileLocationEnum.AWS,
-        path: '../providers/s3-provider.optional',
-        name: 'S3Provider',
-        dep: '@aws-sdk/client-s3'
-    },
-    {
-        location: FileLocationEnum.AZURE,
-        path: '../providers/azure-provider.optional',
-        name: 'AzureProvider',
-        dep: '@azure/storage-blob'
-    },
-    {
-        location: FileLocationEnum.SFTP,
-        path: '../providers/sftp-provider.optional',
-        name: 'SftpProvider',
-        dep: 'ssh2-sftp-client'
-    }
-];
-for (const { location, path, name, dep } of OPTIONAL_PROVIDERS){
-    try {
-        StorageProviderRegistry.register(location, require(path)[name]);
-        logger.log(`Registered ${name}`);
-    } catch  {
-        logger.debug(`${name} not available (install ${dep} to enable)`);
-    }
-}
-export class StorageModule {
-    configure(consumer) {
-        consumer.apply(FileServeMiddleware).forRoutes({
-            path: 'storage/upload/file/*',
-            method: RequestMethod.GET
-        });
-    }
-    static forRoot(options) {
-        return {
-            module: StorageModule,
-            global: options.global ?? false,
-            imports: [
-                CacheModule,
-                UtilsModule
-            ],
-            controllers: options.includeController !== false ? CONTROLLERS : [],
-            providers: this.buildProviders(options),
-            exports: EXPORTED_SERVICES
-        };
-    }
-    static forRootAsync(options) {
-        return {
-            module: StorageModule,
-            global: options.global ?? false,
-            imports: [
-                ...options.imports || [],
-                CacheModule,
-                UtilsModule
-            ],
-            controllers: options.includeController !== false ? CONTROLLERS : [],
-            providers: [
-                ...this.createAsyncProviders(options),
-                ...this.buildProviders()
-            ],
-            exports: EXPORTED_SERVICES
-        };
-    }
-    // ─── Private Helpers ──────────────────────────────────────────────────────────
-    static buildProviders(options) {
-        const providers = [
-            ...EXPORTED_SERVICES,
-            FileServeMiddleware
-        ];
-        if (options) {
-            providers.unshift({
-                provide: STORAGE_MODULE_OPTIONS,
-                useValue: options
-            });
-        }
-        providers.push(createModuleEventsProvider('storage', STORAGE_MODULE_OPTIONS));
-        return providers;
-    }
-    static createAsyncProviders(options) {
-        if (options.useFactory) {
-            return [
-                {
-                    provide: STORAGE_MODULE_OPTIONS,
-                    useFactory: async (...args)=>({
-                            ...options,
-                            config: await options.useFactory(...args)
-                        }),
-                    inject: options.inject || []
-                }
-            ];
-        }
-        const factoryClass = options.useClass || options.useExisting;
-        if (!factoryClass) return [];
-        const providers = [
-            {
-                provide: STORAGE_MODULE_OPTIONS,
-                useFactory: async (factory)=>({
-                        ...options,
-                        config: await factory.createStorageOptions()
-                    }),
-                inject: [
-                    factoryClass
-                ]
-            }
-        ];
-        if (options.useClass) {
-            providers.push({
-                provide: options.useClass,
-                useClass: options.useClass
-            });
-        }
-        return providers;
-    }
-}
-StorageModule = _ts_decorate([
-    Module({})
-], StorageModule);

package/fesm/modules/storage.module.spec.js

@@ -1,180 +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;
-}
-import { StorageModule } from './storage.module';
-import { STORAGE_MODULE_OPTIONS } from '../config/storage.constants';
-import { FileManagerController, FolderController, StorageConfigController, UploadController } from '../controllers';
-import { FileServeMiddleware } from '../middlewares';
-function providerTokens(providers) {
-    return providers.map((p)=>typeof p === 'function' ? p : p.provide);
-}
-describe('StorageModule', ()=>{
-    describe('forRoot', ()=>{
-        it('should default to a non-global module with all controllers registered', ()=>{
-            const dynamicModule = StorageModule.forRoot({});
-            expect(dynamicModule.module).toBe(StorageModule);
-            expect(dynamicModule.global).toBe(false);
-            expect(dynamicModule.controllers).toEqual([
-                FileManagerController,
-                FolderController,
-                StorageConfigController,
-                UploadController
-            ]);
-        });
-        it('should respect global: true', ()=>{
-            expect(StorageModule.forRoot({
-                global: true
-            }).global).toBe(true);
-        });
-        it('should register no controllers when includeController is false', ()=>{
-            expect(StorageModule.forRoot({
-                includeController: false
-            }).controllers).toEqual([]);
-        });
-        it('should register controllers when includeController is anything other than exactly false', ()=>{
-            expect(StorageModule.forRoot({
-                includeController: true
-            }).controllers).toHaveLength(4);
-            expect(StorageModule.forRoot({}).controllers).toHaveLength(4);
-        });
-        it('should register a STORAGE_MODULE_OPTIONS provider carrying the given options', ()=>{
-            const options = {
-                bootstrapAppConfig: {
-                    enableCompanyFeature: true
-                }
-            };
-            const dynamicModule = StorageModule.forRoot(options);
-            const provider = dynamicModule.providers.find((p)=>p.provide === STORAGE_MODULE_OPTIONS);
-            expect(provider.useValue).toBe(options);
-        });
-        it('should always export the same fixed set of services', ()=>{
-            const dynamicModule = StorageModule.forRoot({});
-            expect(dynamicModule.exports).toHaveLength(7);
-        });
-    });
-    describe('forRootAsync', ()=>{
-        it('should forward external imports alongside CacheModule/UtilsModule', ()=>{
-            let FakeImportedModule = class FakeImportedModule {
-            };
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {},
-                imports: [
-                    FakeImportedModule
-                ]
-            });
-            expect(dynamicModule.imports).toEqual(expect.arrayContaining([
-                FakeImportedModule
-            ]));
-        });
-        it('should register no controllers when includeController is false', ()=>{
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {},
-                includeController: false
-            });
-            expect(dynamicModule.controllers).toEqual([]);
-        });
-        it('useFactory: builds a STORAGE_MODULE_OPTIONS provider that merges resolved config into the static options', async ()=>{
-            const useFactory = jest.fn().mockResolvedValue({
-                maxFileSize: 1024
-            });
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useFactory,
-                inject: [
-                    'SOME_TOKEN'
-                ]
-            });
-            const provider = dynamicModule.providers.find((p)=>p.provide === STORAGE_MODULE_OPTIONS);
-            expect(provider.inject).toEqual([
-                'SOME_TOKEN'
-            ]);
-            const resolved = await provider.useFactory('injected');
-            expect(useFactory).toHaveBeenCalledWith('injected');
-            expect(resolved.config).toEqual({
-                maxFileSize: 1024
-            });
-        });
-        it('useClass: registers both the class provider and an options provider calling createStorageOptions()', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createStorageOptions", jest.fn().mockResolvedValue({
-                        maxFileSize: 2048
-                    }));
-                }
-            };
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useClass: MyOptionsFactory
-            });
-            const classProvider = dynamicModule.providers.find((p)=>p.provide === MyOptionsFactory);
-            expect(classProvider.useClass).toBe(MyOptionsFactory);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === STORAGE_MODULE_OPTIONS);
-            const instance = new MyOptionsFactory();
-            const resolved = await optionsProvider.useFactory(instance);
-            expect(instance.createStorageOptions).toHaveBeenCalled();
-            expect(resolved.config).toEqual({
-                maxFileSize: 2048
-            });
-        });
-        it('useExisting: registers a single options provider without a duplicate class registration', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createStorageOptions", jest.fn().mockResolvedValue({
-                        maxFileSize: 4096
-                    }));
-                }
-            };
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useExisting: MyOptionsFactory
-            });
-            expect(dynamicModule.providers.filter((p)=>p.provide === MyOptionsFactory)).toHaveLength(0);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === STORAGE_MODULE_OPTIONS);
-            expect(optionsProvider.inject).toEqual([
-                MyOptionsFactory
-            ]);
-        });
-        it('should register no STORAGE_MODULE_OPTIONS provider when neither useFactory, useClass, nor useExisting is given', ()=>{
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {}
-            });
-            expect(providerTokens(dynamicModule.providers)).not.toContain(STORAGE_MODULE_OPTIONS);
-        });
-        it('should still register the fixed exported services as providers alongside async options', ()=>{
-            const dynamicModule = StorageModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useFactory: jest.fn()
-            });
-            expect(dynamicModule.providers).toEqual(expect.arrayContaining([
-                ...dynamicModule.exports
-            ]));
-        });
-    });
-    describe('configure (NestModule)', ()=>{
-        it('should wire FileServeMiddleware to the file GET route', ()=>{
-            const forRoutes = jest.fn();
-            const apply = jest.fn().mockReturnValue({
-                forRoutes
-            });
-            const consumer = {
-                apply
-            };
-            new StorageModule().configure(consumer);
-            expect(apply).toHaveBeenCalledWith(FileServeMiddleware);
-            expect(forRoutes).toHaveBeenCalledWith({
-                path: 'storage/upload/file/*',
-                method: expect.anything()
-            });
-        });
-    });
-});

package/fesm/providers/azure-provider.optional.spec.js

@@ -1,224 +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;
-}
-const mockCreateIfNotExists = jest.fn();
-const mockBlockBlobUpload = jest.fn();
-const mockDeleteIfExists = jest.fn();
-const mockContainerExists = jest.fn();
-function buildBlockBlobClient() {
-    return {
-        upload: mockBlockBlobUpload,
-        deleteIfExists: mockDeleteIfExists,
-        url: 'https://account.blob.core.windows.net/container/blob-key.jpg',
-        credential: 'shared-key-credential'
-    };
-}
-const mockGetBlockBlobClient = jest.fn().mockImplementation(()=>buildBlockBlobClient());
-const mockGetContainerClient = jest.fn().mockImplementation(()=>({
-        createIfNotExists: mockCreateIfNotExists,
-        getBlockBlobClient: mockGetBlockBlobClient,
-        exists: mockContainerExists
-    }));
-const mockFromConnectionString = jest.fn().mockImplementation(()=>({
-        getContainerClient: mockGetContainerClient
-    }));
-const mockBlobServiceClientCtor = jest.fn().mockImplementation(()=>({
-        getContainerClient: mockGetContainerClient
-    }));
-mockBlobServiceClientCtor.fromConnectionString = mockFromConnectionString;
-const mockGenerateBlobSASQueryParameters = jest.fn().mockReturnValue({
-    toString: ()=>'sv=2022&sig=abc123'
-});
-let MockStorageSharedKeyCredential = class MockStorageSharedKeyCredential {
-    constructor(accountName, accountKey){
-        _define_property(this, "accountName", void 0);
-        _define_property(this, "accountKey", void 0);
-        this.accountName = accountName;
-        this.accountKey = accountKey;
-    }
-};
-let MockBlobSASPermissions = class MockBlobSASPermissions {
-    static parse(input) {
-        return {
-            permissions: input
-        };
-    }
-};
-jest.mock('@azure/storage-blob', ()=>({
-        BlobServiceClient: mockBlobServiceClientCtor,
-        StorageSharedKeyCredential: MockStorageSharedKeyCredential,
-        BlobSASPermissions: MockBlobSASPermissions,
-        generateBlobSASQueryParameters: (...args)=>mockGenerateBlobSASQueryParameters(...args)
-    }));
-jest.mock('../utils/image-compressor.util', ()=>({
-        ImageCompressor: {
-            compress: jest.fn()
-        }
-    }));
-import { AzureProvider } from './azure-provider.optional';
-import { ImageCompressor } from '../utils/image-compressor.util';
-function buildMulterFile(overrides = {}) {
-    return {
-        fieldname: 'file',
-        originalname: 'photo.jpg',
-        encoding: '7bit',
-        mimetype: 'image/jpeg',
-        buffer: Buffer.from('file-bytes'),
-        size: 10,
-        stream: undefined,
-        destination: '',
-        filename: '',
-        path: '',
-        ...overrides
-    };
-}
-describe('AzureProvider', ()=>{
-    let provider;
-    beforeEach(async ()=>{
-        jest.clearAllMocks();
-        mockCreateIfNotExists.mockResolvedValue(undefined);
-        mockBlockBlobUpload.mockResolvedValue(undefined);
-        mockDeleteIfExists.mockResolvedValue(undefined);
-        mockContainerExists.mockResolvedValue(true);
-        mockGetBlockBlobClient.mockImplementation(()=>buildBlockBlobClient());
-        mockGetContainerClient.mockImplementation(()=>({
-                createIfNotExists: mockCreateIfNotExists,
-                getBlockBlobClient: mockGetBlockBlobClient,
-                exists: mockContainerExists
-            }));
-        provider = new AzureProvider();
-        await provider.initialize({
-            accountName: 'myaccount',
-            accountKey: 'key123',
-            containerName: 'my-container'
-        });
-    });
-    describe('initialize', ()=>{
-        it('builds a BlobServiceClient using an account key credential when no connection string is given', ()=>{
-            expect(mockBlobServiceClientCtor).toHaveBeenCalledWith('https://myaccount.blob.core.windows.net', expect.any(MockStorageSharedKeyCredential));
-            expect(mockCreateIfNotExists).toHaveBeenCalled();
-        });
-        it('builds a BlobServiceClient from a connection string when provided', async ()=>{
-            jest.clearAllMocks();
-            mockCreateIfNotExists.mockResolvedValue(undefined);
-            const p = new AzureProvider();
-            await p.initialize({
-                accountName: 'acct2',
-                accountKey: 'key2',
-                containerName: 'container2',
-                connectionString: 'DefaultEndpointsProtocol=https;AccountName=acct2;AccountKey=key2'
-            });
-            expect(mockFromConnectionString).toHaveBeenCalledWith('DefaultEndpointsProtocol=https;AccountName=acct2;AccountKey=key2');
-        });
-        it('throws InternalServerErrorException when the Azure SDK cannot be initialized', async ()=>{
-            mockBlobServiceClientCtor.mockImplementationOnce(()=>{
-                throw new Error('boom');
-            });
-            const brokenProvider = new AzureProvider();
-            await expect(brokenProvider.initialize({
-                accountName: 'a',
-                accountKey: 'b',
-                containerName: 'c'
-            })).rejects.toThrow('Azure Storage SDK not found');
-        });
-    });
-    describe('uploadFile', ()=>{
-        it('uploads the blob and returns file metadata', async ()=>{
-            const file = buildMulterFile();
-            const result = await provider.uploadFile(file, {});
-            expect(mockBlockBlobUpload).toHaveBeenCalledWith(file.buffer, file.buffer.length, expect.objectContaining({
-                blobHTTPHeaders: {
-                    blobContentType: 'image/jpeg'
-                }
-            }));
-            expect(result.name).toMatch(/photo\.jpg$/);
-            expect(result.key).toBe(result.name);
-        });
-        it('prefixes blob name with folderPath when provided', async ()=>{
-            const file = buildMulterFile();
-            const result = await provider.uploadFile(file, {
-                folderPath: 'docs'
-            });
-            expect(result.key).toMatch(/^docs\//);
-        });
-        it('compresses image files when options.compress is true', async ()=>{
-            ImageCompressor.compress.mockResolvedValue({
-                buffer: Buffer.from('small'),
-                format: 'image/webp'
-            });
-            const file = buildMulterFile();
-            const result = await provider.uploadFile(file, {
-                compress: true
-            });
-            expect(ImageCompressor.compress).toHaveBeenCalled();
-            expect(result.contentType).toBe('image/webp');
-        });
-    });
-    describe('uploadMultipleFiles', ()=>{
-        it('uploads all files', async ()=>{
-            const files = [
-                buildMulterFile({
-                    originalname: 'a.jpg'
-                }),
-                buildMulterFile({
-                    originalname: 'b.jpg'
-                })
-            ];
-            const results = await provider.uploadMultipleFiles(files, {});
-            expect(results).toHaveLength(2);
-            expect(mockBlockBlobUpload).toHaveBeenCalledTimes(2);
-        });
-    });
-    describe('deleteFile', ()=>{
-        it('calls deleteIfExists on the block blob client for the given key', async ()=>{
-            await provider.deleteFile('blob-key.jpg');
-            expect(mockGetBlockBlobClient).toHaveBeenCalledWith('blob-key.jpg');
-            expect(mockDeleteIfExists).toHaveBeenCalled();
-        });
-    });
-    describe('deleteMultipleFiles', ()=>{
-        it('deletes every provided key', async ()=>{
-            await provider.deleteMultipleFiles([
-                'a.jpg',
-                'b.jpg'
-            ]);
-            expect(mockDeleteIfExists).toHaveBeenCalledTimes(2);
-        });
-    });
-    describe('generatePresignedUrl', ()=>{
-        it('generates a SAS URL appended with the query string', async ()=>{
-            const url = await provider.generatePresignedUrl('blob-key.jpg', 1800);
-            expect(mockGenerateBlobSASQueryParameters).toHaveBeenCalledWith(expect.objectContaining({
-                containerName: 'my-container',
-                blobName: 'blob-key.jpg'
-            }), 'shared-key-credential');
-            expect(url).toBe('https://account.blob.core.windows.net/container/blob-key.jpg?sv=2022&sig=abc123');
-        });
-        it('defaults the expiry window to 3600 seconds', async ()=>{
-            await provider.generatePresignedUrl('blob-key.jpg');
-            const call = mockGenerateBlobSASQueryParameters.mock.calls[0][0];
-            const diffSeconds = (call.expiresOn.getTime() - call.startsOn.getTime()) / 1000;
-            expect(diffSeconds).toBeCloseTo(3600, 0);
-        });
-    });
-    describe('healthCheck', ()=>{
-        it('returns true when the container exists', async ()=>{
-            mockContainerExists.mockResolvedValue(true);
-            await expect(provider.healthCheck()).resolves.toBe(true);
-        });
-        it('returns false when checking existence throws', async ()=>{
-            mockContainerExists.mockRejectedValue(new Error('network error'));
-            await expect(provider.healthCheck()).resolves.toBe(false);
-        });
-    });
-});