@tmlmobilidade/interfaces 20250906.141.55 → 20250908.1919.56

package/dist/src/interfaces/files/files.d.ts

@@ -1,6 +1,7 @@
 import { MongoCollectionClass } from '../../mongo-collection.js';
 import { CreateFileDto, File, UpdateFileDto } from '@tmlmobilidade/types';
 import { DeleteOptions, DeleteResult, IndexDescription, InsertOneOptions, WithId } from 'mongodb';
+import { Readable } from 'node:stream';
 import { z } from 'zod';
 declare class FilesClass extends MongoCollectionClass<File, CreateFileDto, UpdateFileDto> {
     private static _instance;
@@ -44,11 +45,15 @@ declare class FilesClass extends MongoCollectionClass<File, CreateFileDto, Updat
     }): Promise<string>;
     /**
      * Uploads a file to the storage service and inserts it into the database.
-     * @param file - The file to upload.
+     * @param file - The file to upload, either as a string, buffer, or readable stream.
      * @param createFileDto - The file type to create.
      * @returns The file that was uploaded.
      */
-    upload(file: Buffer, createFileDto: CreateFileDto, options?: InsertOneOptions): Promise<File>;
+    upload(file: Buffer | Readable | ReadableStream | string, createFileDto: CreateFileDto & {
+        _id?: string;
+    }, options?: InsertOneOptions & {
+        override?: boolean;
+    }): Promise<File>;
     protected getCollectionIndexes(): IndexDescription[];
     protected getCollectionName(): string;
     protected getEnvName(): string;

package/dist/src/interfaces/files/files.js

@@ -151,14 +151,56 @@ class FilesClass extends MongoCollectionClass {
     }
     /**
      * Uploads a file to the storage service and inserts it into the database.
-     * @param file - The file to upload.
+     * @param file - The file to upload, either as a string, buffer, or readable stream.
      * @param createFileDto - The file type to create.
      * @returns The file that was uploaded.
      */
     async upload(file, createFileDto, options) {
-        const _id = generateRandomString({ length: 5 });
-        await this.storageService.uploadFile(`${createFileDto.scope}/${createFileDto.resource_id}/${_id}.${Files.getFileExtension(createFileDto.name)}`, file, Files.getMimeTypeFromFileExtension(createFileDto.name));
-        return await this.insertOne({ ...createFileDto, _id }, { options });
+        //
+        //
+        // A. Define variables
+        if (createFileDto._id && !options?.override) {
+            throw new HttpException(HttpStatus.INTERNAL_SERVER_ERROR, 'When File ID is provided, override must be true');
+        }
+        const fileId = createFileDto._id || generateRandomString({ length: 5 });
+        const fileExtension = Files.getFileExtension(createFileDto.name);
+        const mimeType = Files.getMimeTypeFromFileExtension(createFileDto.name);
+        const filePath = `${createFileDto.scope}/${createFileDto.resource_id}/${fileId}.${fileExtension}`;
+        //
+        // C. Handle database transaction
+        const session = this.getMongoConnector().client.startSession();
+        let result;
+        try {
+            session.startTransaction();
+            //
+            // C.1. Handle file override if specified
+            if (options?.override) {
+                const existingFile = await this.findOne({ _id: fileId });
+                if (existingFile) {
+                    const existingFileExtension = Files.getFileExtension(existingFile.name);
+                    const existingFilePath = `${existingFile.scope}/${existingFile.resource_id}/${existingFile._id}.${existingFileExtension}`;
+                    if (existingFilePath !== filePath) {
+                        throw new HttpException(HttpStatus.INTERNAL_SERVER_ERROR, 'File ID is provided, but the file path is different from the existing file', { cause: { existingFilePath, filePath } });
+                    }
+                    await super.deleteById(fileId);
+                }
+            }
+            //
+            // C.2. Upload file to storage
+            await this.storageService.uploadFile(filePath, file, mimeType);
+            //
+            // C.3. Insert file record
+            result = await this.insertOne({ ...createFileDto, _id: fileId }, { options });
+            await session.commitTransaction();
+        }
+        catch (error) {
+            await session.abortTransaction();
+            throw error;
+        }
+        finally {
+            session.endSession();
+        }
+        return result;
     }
     getCollectionIndexes() {
         return [

package/dist/src/providers/storage/oci-storage.d.ts

@@ -1,4 +1,5 @@
 import { IStorageProvider } from './storage.interface.js';
+import { Readable } from 'node:stream';
 export interface OCIStorageProviderConfiguration {
     bucket_name: string;
     fingerprint: string;
@@ -25,5 +26,5 @@ export declare class OCIStorageProvider implements IStorageProvider {
     fileExists(key: string): Promise<boolean>;
     getFileUrl(key: string): Promise<string>;
     listFiles(prefix?: string): Promise<string[]>;
-    uploadFile(key: string, body: Buffer, mimeType?: string): Promise<void>;
+    uploadFile(key: string, body: Buffer | Readable | ReadableStream, mimeType?: string): Promise<void>;
 }

package/dist/src/providers/storage/oci-storage.js

@@ -88,17 +88,23 @@ export class OCIStorageProvider {
     async uploadFile(key, body, mimeType) {
         const isImage = mimeType === mimeTypes.png || mimeType === mimeTypes.jpg || mimeType === mimeTypes.jpeg || mimeType === mimeTypes.gif || mimeType === mimeTypes.svg;
         const uploadManager = new UploadManager(this.ociClient, { enforceMD5: true });
-        await uploadManager.upload({
-            content: {
-                blob: new Blob([body], { type: mimeType }),
-            },
-            requestDetails: {
-                bucketName: this.bucketName,
-                contentDisposition: isImage ? 'inline' : 'attachment',
-                contentType: mimeType,
-                namespaceName: this.namespace,
-                objectName: key,
-            },
-        });
+        try {
+            await uploadManager.upload({
+                content: body instanceof Buffer
+                    ? { blob: new Blob([body], { type: mimeType }) }
+                    : { stream: body },
+                requestDetails: {
+                    bucketName: this.bucketName,
+                    contentDisposition: isImage ? 'inline' : 'attachment',
+                    contentType: mimeType,
+                    namespaceName: this.namespace,
+                    objectName: key,
+                },
+            });
+        }
+        catch (error) {
+            console.error('Error uploading file:', JSON.stringify(error, null, 2));
+            throw error;
+        }
     }
 }

package/dist/src/providers/storage/s3-storage.d.ts

@@ -60,5 +60,5 @@ export declare class S3StorageProvider implements IStorageProvider {
      * @param key - The file path and name in S3.
      * @param body - The content to upload, either as a string, buffer, or readable stream.
      */
-    uploadFile(key: string, body: Buffer | Readable | string, mimeType?: string): Promise<void>;
+    uploadFile(key: string, body: Buffer | Readable | ReadableStream | string, mimeType?: string): Promise<void>;
 }

package/dist/src/providers/storage/storage.interface.d.ts

@@ -1,3 +1,4 @@
+import { Readable } from 'node:stream';
 export interface IStorageProvider {
     copyFile(source: string, destination: string): Promise<void>;
     deleteFile(key: string): Promise<void>;
@@ -5,5 +6,5 @@ export interface IStorageProvider {
     fileExists(key: string): Promise<boolean>;
     getFileUrl(key: string): Promise<string>;
     listFiles(prefix?: string): Promise<string[]>;
-    uploadFile(key: string, body: Buffer, mimeType?: string): Promise<void>;
+    uploadFile(key: string, body: Buffer | Readable | ReadableStream | string, mimeType?: string): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/interfaces",
-	"version": "20250906.141.55",
+	"version": "20250908.1919.56",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",