easywork-common-lib 1.0.432 → 1.0.433

package/dist/grpc/drive/drive.proto

@@ -3,80 +3,131 @@ syntax = "proto3";
 
 package drive;
 
+// Define el mensaje que representa una carpeta.
 message FolderObject {
   string name = 1; // Nombre de la carpeta
-  string metadata = 2; // Se espera un objeto serializado en JSON
+  string metadata = 2; // Metadatos en formato JSON
 }
 
+// Representa la entidad propietaria de un archivo o carpeta.
 message OwnerEntity {
-  string ownerId = 1;
-  string entityType = 2;
-  string relation = 3;
+  string ownerId = 1;      // Identificador del propietario
+  string entityType = 2;   // Tipo de entidad (e.g., usuario, organización)
+  string relation = 3;     // Relación del propietario con el recurso
 }
 
+// Representa un archivo para ser subido.
+message IFile {
+  string name = 1;        // Nombre del archivo
+  int64 size = 2;         // Tamaño del archivo en bytes
+  string mimeType = 3;    // Tipo MIME del archivo
+  string s3Key = 4;       // Clave del archivo en S3
+  bytes filecontent = 5;  // Contenido binario del archivo
+}
+
+// Categorías para clasificar las carpetas de un recibo.
+enum ReceiptFolderCategory {
+  FACTURA = 0;  // Categoría para facturas
+  PAGO = 1;     // Categoría para pagos recibidos
+}
+
+// Consulta para especificar la categoría de los archivos subidos.
+message UploadFileToReceiptQueryDto {
+  ReceiptFolderCategory category = 1; // Categoría del archivo
+}
 
+// Representa un usuario en el contexto del sistema.
+message User {
+  string id = 1;    // Identificador único del usuario
+  string name = 2;  // Nombre del usuario
+}
+
+// Solicitud para subir archivos a la carpeta de documentos de un recibo.
+message UploadFilesToReceiptRequest {
+  repeated IFile files = 1;                       // Lista de archivos a subir
+  string receiptId = 2;                           // ID del recibo al cual se asociarán los archivos
+  UploadFileToReceiptQueryDto query = 3;          // Parámetros de consulta relacionados con la categoría
+  User user = 4;                                  // Usuario que realiza la operación
+}
+
+// Respuesta tras subir archivos a la carpeta de documentos de un recibo.
+message UploadFilesToReceiptResponse {
+  repeated string filesIds = 1;  // Identificadores de los archivos subidos
+  bool success = 2;              // Indicador de éxito de la operación
+}
 
-// Define los mensajes para las operaciones de carpetas
+// Solicitud para crear una nueva carpeta.
 message CreateFolderRequest {
-  string name = 1;
-  string parentId = 2; // Opcional, puede ser nulo si es una carpeta raíz
-  repeated OwnerEntity ownersData = 3;
-  string metadata = 4; // Se espera un objeto serializado en JSON
+  string name = 1;                         // Nombre de la carpeta
+  string parentId = 2;                     // ID de la carpeta padre (opcional)
+  repeated OwnerEntity ownersData = 3;     // Información sobre los propietarios
+  string metadata = 4;                     // Metadatos en formato JSON
 }
 
-// Create Bulk Folder
+// Solicitud para crear múltiples carpetas en una sola operación.
 message CreateFolderBulkRequest {
-  repeated FolderObject folders = 1;
-  string parentId = 2; // Opcional, puede ser nulo si es una carpeta raíz
-  repeated OwnerEntity ownersData = 3;
+  repeated FolderObject folders = 1;       // Lista de carpetas a crear
+  string parentId = 2;                     // ID de la carpeta padre (opcional)
+  repeated OwnerEntity ownersData = 3;     // Información sobre los propietarios
 }
 
+// Respuesta tras la creación de una carpeta.
 message FolderResponse {
-  string id = 1;
-  string name = 2;
-  string parentId = 3; // Opcional, puede ser nulo si es una carpeta raíz
-  string createdAt = 4;
+  string id = 1;           // Identificador de la carpeta creada
+  string name = 2;         // Nombre de la carpeta
+  string parentId = 3;     // ID de la carpeta padre (opcional)
+  string createdAt = 4;    // Fecha de creación
 }
 
-
+// Respuesta tras la creación de múltiples carpetas.
 message CreateFolderBulkResponse {
-  bool success = 1;
+  bool success = 1;  // Indicador de éxito de la operación
 }
 
+// Solicitud para crear un archivo.
 message CreateFileRequest {
-  string name = 1; // Nombre del archivo
-  string folderId = 2; // UUID del folder, opcional
-  int64 size = 3; // Tamaño del archivo, opcional
-  string mimeType = 4; // Tipo MIME del archivo, opcional
-  string s3Key = 5; // Clave S3, opcional
-  bool isDefault = 6; // Si es el archivo por defecto, opcional
-  repeated OwnerEntity ownersData = 7;
-  bytes filecontent = 8; // Contenido del archivo en bytes
-  string encoding = 9; // Codificación del archivo
-}
-
-message AttachFileRequest {
-  
+  string name = 1;                         // Nombre del archivo
+  string folderId = 2;                     // ID de la carpeta donde se almacenará el archivo (opcional)
+  int64 size = 3;                          // Tamaño del archivo en bytes (opcional)
+  string mimeType = 4;                     // Tipo MIME del archivo (opcional)
+  string s3Key = 5;                        // Clave del archivo en S3 (opcional)
+  bool isDefault = 6;                      // Indicador de si es el archivo por defecto (opcional)
+  repeated OwnerEntity ownersData = 7;     // Información sobre los propietarios
+  bytes filecontent = 8;                   // Contenido binario del archivo
+  string encoding = 9;                     // Codificación del archivo (opcional)
 }
 
+// Solicitud para adjuntar múltiples archivos.
 message CreateFilesRequest {
-  repeated CreateFileRequest files = 1; // Archivos
+  repeated CreateFileRequest files = 1;  // Lista de archivos a crear
 }
 
+// Respuesta tras la creación de múltiples archivos.
 message CreateFilesResponse {
-  repeated string filesIds = 1;
+  repeated string filesIds = 1;  // Identificadores de los archivos creados
 }
 
+// Respuesta tras la creación de un archivo.
 message CreateFileResponse {
-  string message = 1;
-  bool success = 2;
-  string url = 3; // URL del archivo almacenado
+  string message = 1;  // Mensaje de respuesta
+  bool success = 2;    // Indicador de éxito de la operación
+  string url = 3;      // URL del archivo almacenado
 }
 
-// Define el servicio que será implementado
+// Define el servicio de gestión de carpetas y archivos.
 service DriveService {
+  // Crea una carpeta.
   rpc CreateFolder(CreateFolderRequest) returns (FolderResponse);
+  
+  // Crea múltiples carpetas en una sola operación.
+  rpc CreateFolders(CreateFolderBulkRequest) returns (CreateFolderBulkResponse);
+
+  // Crea un archivo.
   rpc CreateFile(CreateFileRequest) returns (CreateFileResponse);
+  
+  // Crea múltiples archivos en una sola operación.
   rpc CreateFiles(CreateFilesRequest) returns (CreateFilesResponse);
-  rpc CreateFolders(CreateFolderBulkRequest) returns (CreateFolderBulkResponse);
-}
+
+  // Sube archivos a la carpeta de documentos de un recibo.
+  rpc UploadFilesToReceipt(UploadFilesToReceiptRequest) returns (UploadFilesToReceiptResponse);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easywork-common-lib",
-  "version": "1.0.432",
+  "version": "1.0.433",
   "description": "Librería común de Easywork",
   "main": "dist/index.js",
   "scripts": {