@programisto/edrm-storage 1.0.4 → 1.0.6

package/README.md

@@ -21,7 +21,7 @@ The Endurance Framework is a highly modular and scalable Node.js project templat
 
 ### Installation
 
-1. Install our CLI:
+1. Install our CLI (optionnal):
 
     ```sh
     npm install -g endurance

package/dist/modules/edrm-storage/models/file.model.d.ts

@@ -40,6 +40,7 @@ export interface IFile {
     tenantId?: string;
     entityName?: string;
     entityId?: string;
+    portalEntityId?: string;
     uploadedBy?: string;
     expiresAt?: Date;
     lastAccessedAt?: Date;
@@ -65,6 +66,8 @@ declare class File extends EnduranceSchema implements IFile {
     tenantId: string;
     entityName: string;
     entityId: string;
+    /** Identifiant de l'entité du portail (multi-entités). Optionnel pour rétrocompatibilité. */
+    portalEntityId: string;
     uploadedBy: string;
     expiresAt: Date;
     lastAccessedAt: Date;

package/dist/modules/edrm-storage/models/file.model.js

@@ -56,6 +56,8 @@ let File = class File extends EnduranceSchema {
     tenantId;
     entityName;
     entityId;
+    /** Identifiant de l'entité du portail (multi-entités). Optionnel pour rétrocompatibilité. */
+    portalEntityId;
     uploadedBy;
     expiresAt;
     lastAccessedAt;
@@ -140,6 +142,10 @@ __decorate([
     EnduranceModelType.prop({ required: false }),
     __metadata("design:type", String)
 ], File.prototype, "entityId", void 0);
+__decorate([
+    EnduranceModelType.prop({ required: false }),
+    __metadata("design:type", String)
+], File.prototype, "portalEntityId", void 0);
 __decorate([
     EnduranceModelType.prop({ required: false }),
     __metadata("design:type", String)

package/dist/modules/edrm-storage/routes/edrm-storage.router.js

@@ -14,7 +14,60 @@ class EdrmStorageRouter extends EnduranceRouter {
         const userOptions = {
             requireAuth: true
         };
-        // Routes publiques pour l'initialisation d'upload
+        /**
+         * @swagger
+         * /files/init:
+         *   post:
+         *     summary: Initialiser un upload de fichier
+         *     description: Crée un enregistrement de fichier et retourne une URL signée pour commencer l’upload. Authentification utilisateur requise.
+         *     tags: [Stockage]
+         *     requestBody:
+         *       required: true
+         *       content:
+         *         application/json:
+         *           schema:
+         *             type: object
+         *             required: [originalName, mimeType, size, tenantId, entityName, entityId]
+         *             properties:
+         *               originalName:
+         *                 type: string
+         *                 description: Nom d’origine du fichier
+         *               mimeType:
+         *                 type: string
+         *                 description: Type MIME du fichier
+         *               size:
+         *                 type: integer
+         *                 description: Taille du fichier en octets
+         *               tenantId:
+         *                 type: string
+         *                 description: Identifiant du tenant
+         *               entityName:
+         *                 type: string
+         *                 description: Entité métier associée (ex. "invoice")
+         *               entityId:
+         *                 type: string
+         *                 description: Identifiant de l’entité métier associée
+         *               provider:
+         *                 type: string
+         *                 enum: [S3]
+         *                 default: S3
+         *                 description: Provider de stockage
+         *               metadata:
+         *                 type: object
+         *                 description: Métadonnées supplémentaires
+         *               tags:
+         *                 type: array
+         *                 items:
+         *                   type: string
+         *                 description: Liste de tags libres
+         *     responses:
+         *       200:
+         *         description: URL signée et informations d’initialisation
+         *       400:
+         *         description: Paramètres manquants ou invalides
+         *       500:
+         *         description: Erreur serveur
+         */
         this.post('/files/init', userOptions, async (req, res) => {
             try {
                 const { originalName, mimeType, size, tenantId, entityName, entityId, provider = 'S3', metadata, tags } = req.body;
@@ -24,7 +77,7 @@ class EdrmStorageRouter extends EnduranceRouter {
                         message: 'Paramètres manquants: originalName, mimeType, size, tenantId, entityName, entityId'
                     });
                 }
-                const result = await this.storageService.initUpload(originalName, mimeType, size, tenantId, entityName, entityId, provider, metadata, tags);
+                const result = await this.storageService.initUpload(originalName, mimeType, size, tenantId, entityName, entityId, provider, metadata, tags, req.entity?._id?.toString());
                 return res.json({
                     success: true,
                     data: result
@@ -38,11 +91,30 @@ class EdrmStorageRouter extends EnduranceRouter {
                 });
             }
         });
-        // Finaliser un upload
+        /**
+         * @swagger
+         * /files/{fileId}/complete:
+         *   post:
+         *     summary: Finaliser un upload
+         *     description: Marque l’upload comme terminé et met à jour le statut du fichier. Authentification utilisateur requise.
+         *     tags: [Stockage]
+         *     parameters:
+         *       - in: path
+         *         name: fileId
+         *         required: true
+         *         schema:
+         *           type: string
+         *         description: Identifiant du fichier
+         *     responses:
+         *       200:
+         *         description: Upload finalisé avec succès
+         *       500:
+         *         description: Erreur serveur
+         */
         this.post('/files/:fileId/complete', userOptions, async (req, res) => {
             try {
                 const { fileId } = req.params;
-                const result = await this.storageService.completeUpload(fileId);
+                const result = await this.storageService.completeUpload(fileId, req.entity?._id?.toString());
                 return res.json({
                     success: true,
                     data: result
@@ -56,12 +128,42 @@ class EdrmStorageRouter extends EnduranceRouter {
                 });
             }
         });
-        // Obtenir une URL de téléchargement
+        /**
+         * @swagger
+         * /files/{fileId}/download:
+         *   get:
+         *     summary: Obtenir une URL de téléchargement
+         *     description: Retourne une URL signée pour télécharger le fichier. Authentification utilisateur requise.
+         *     tags: [Stockage]
+         *     parameters:
+         *       - in: path
+         *         name: fileId
+         *         required: true
+         *         schema:
+         *           type: string
+         *         description: Identifiant du fichier
+         *       - in: query
+         *         name: filename
+         *         schema:
+         *           type: string
+         *         description: Nom de fichier à proposer au téléchargement
+         *       - in: query
+         *         name: expiresIn
+         *         schema:
+         *           type: integer
+         *           default: 3600
+         *         description: Durée de validité du lien en secondes
+         *     responses:
+         *       200:
+         *         description: URL de téléchargement générée
+         *       500:
+         *         description: Erreur serveur
+         */
         this.get('/files/:fileId/download', userOptions, async (req, res) => {
             try {
                 const { fileId } = req.params;
                 const { filename, expiresIn = 3600 } = req.query;
-                const result = await this.storageService.getDownloadUrl(fileId, filename, parseInt(expiresIn));
+                const result = await this.storageService.getDownloadUrl(fileId, filename, parseInt(expiresIn), req.entity?._id?.toString());
                 return res.json({
                     success: true,
                     data: result
@@ -75,11 +177,30 @@ class EdrmStorageRouter extends EnduranceRouter {
                 });
             }
         });
-        // Supprimer un fichier
+        /**
+         * @swagger
+         * /files/{fileId}:
+         *   delete:
+         *     summary: Supprimer un fichier
+         *     description: Supprime un fichier et ses métadonnées. Authentification et permission Admin_ManageFiles requises.
+         *     tags: [Stockage]
+         *     parameters:
+         *       - in: path
+         *         name: fileId
+         *         required: true
+         *         schema:
+         *           type: string
+         *         description: Identifiant du fichier
+         *     responses:
+         *       200:
+         *         description: Fichier supprimé
+         *       500:
+         *         description: Erreur serveur
+         */
         this.delete('/files/:fileId', adminOptions, async (req, res) => {
             try {
                 const { fileId } = req.params;
-                await this.storageService.deleteFile(fileId);
+                await this.storageService.deleteFile(fileId, req.entity?._id?.toString());
                 return res.json({
                     success: true,
                     message: 'Fichier supprimé avec succès'
@@ -93,11 +214,57 @@ class EdrmStorageRouter extends EnduranceRouter {
                 });
             }
         });
-        // Lister les fichiers
+        /**
+         * @swagger
+         * /files:
+         *   get:
+         *     summary: Lister les fichiers
+         *     description: Retourne une liste paginée des fichiers avec filtres. Authentification et permission Admin_ManageFiles requises.
+         *     tags: [Stockage]
+         *     parameters:
+         *       - in: query
+         *         name: tenantId
+         *         schema:
+         *           type: string
+         *         description: Filtrer par tenant
+         *       - in: query
+         *         name: entityName
+         *         schema:
+         *           type: string
+         *         description: Filtrer par entité
+         *       - in: query
+         *         name: entityId
+         *         schema:
+         *           type: string
+         *         description: Filtrer par identifiant d’entité
+         *       - in: query
+         *         name: status
+         *         schema:
+         *           type: string
+         *           enum: [PENDING, COMPLETED, FAILED]
+         *         description: Filtrer par statut de fichier
+         *       - in: query
+         *         name: page
+         *         schema:
+         *           type: integer
+         *           default: 1
+         *         description: Numéro de page
+         *       - in: query
+         *         name: limit
+         *         schema:
+         *           type: integer
+         *           default: 20
+         *         description: Nombre d’éléments par page
+         *     responses:
+         *       200:
+         *         description: Liste paginée de fichiers
+         *       500:
+         *         description: Erreur serveur
+         */
         this.get('/files', adminOptions, async (req, res) => {
             try {
                 const { tenantId, entityName, entityId, status, page = 1, limit = 20 } = req.query;
-                const result = await this.storageService.listFiles(tenantId, entityName, entityId, status, parseInt(page), parseInt(limit));
+                const result = await this.storageService.listFiles(tenantId, entityName, entityId, status, parseInt(page), parseInt(limit), req.entity?._id?.toString());
                 return res.json({
                     success: true,
                     data: result
@@ -111,11 +278,30 @@ class EdrmStorageRouter extends EnduranceRouter {
                 });
             }
         });
-        // Obtenir les détails d'un fichier
+        /**
+         * @swagger
+         * /files/{fileId}:
+         *   get:
+         *     summary: Récupérer un fichier par ID
+         *     description: Retourne les métadonnées d’un fichier. Authentification utilisateur requise.
+         *     tags: [Stockage]
+         *     parameters:
+         *       - in: path
+         *         name: fileId
+         *         required: true
+         *         schema:
+         *           type: string
+         *         description: Identifiant du fichier
+         *     responses:
+         *       200:
+         *         description: Détails du fichier
+         *       500:
+         *         description: Erreur serveur
+         */
         this.get('/files/:fileId', userOptions, async (req, res) => {
             try {
                 const { fileId } = req.params;
-                const result = await this.storageService.getFileById(fileId);
+                const result = await this.storageService.getFileById(fileId, req.entity?._id?.toString());
                 return res.json({
                     success: true,
                     data: result
@@ -129,7 +315,26 @@ class EdrmStorageRouter extends EnduranceRouter {
                 });
             }
         });
-        // Route de callback pour les événements S3 (optionnel)
+        /**
+         * @swagger
+         * /files/s3-callback:
+         *   post:
+         *     summary: Callback d’événements S3
+         *     description: Réception et traitement des webhooks S3. Authentification non requise.
+         *     tags: [Stockage]
+         *     requestBody:
+         *       required: false
+         *       content:
+         *         application/json:
+         *           schema:
+         *             type: object
+         *             description: Payload du webhook S3
+         *     responses:
+         *       200:
+         *         description: Callback traité
+         *       500:
+         *         description: Erreur serveur
+         */
         this.post('/files/s3-callback', { requireAuth: false, permissions: [] }, async (req, res) => {
             try {
                 // Cette route peut être utilisée pour recevoir des webhooks S3

package/dist/modules/edrm-storage/services/edrm-storage.service.d.ts

@@ -7,7 +7,7 @@ export declare class EdrmStorageService {
     private getProvider;
     private generateKey;
     private detectFileType;
-    initUpload(originalName: string, mimeType: string, size: number, tenantId: string, entityName: string, entityId: string, provider?: FileProvider, metadata?: Record<string, any>, tags?: string[]): Promise<{
+    initUpload(originalName: string, mimeType: string, size: number, tenantId: string, entityName: string, entityId: string, provider?: FileProvider, metadata?: Record<string, any>, tags?: string[], portalEntityId?: string): Promise<{
         fileId: import("mongoose").Types.ObjectId;
         uploadId: string;
         presignedUrl: string;
@@ -15,14 +15,14 @@ export declare class EdrmStorageService {
         bucket: string;
         key: string;
     }>;
-    completeUpload(fileId: string): Promise<any>;
-    getDownloadUrl(fileId: string, filename?: string, expiresIn?: number): Promise<any>;
-    deleteFile(fileId: string): Promise<void>;
-    listFiles(tenantId?: string, entityName?: string, entityId?: string, status?: FileStatus, page?: number, limit?: number): Promise<{
+    completeUpload(fileId: string, portalEntityId?: string): Promise<any>;
+    getDownloadUrl(fileId: string, filename?: string, expiresIn?: number, portalEntityId?: string): Promise<any>;
+    deleteFile(fileId: string, portalEntityId?: string): Promise<void>;
+    listFiles(tenantId?: string, entityName?: string, entityId?: string, status?: FileStatus, page?: number, limit?: number, portalEntityId?: string): Promise<{
         files: any[];
         total: number;
         page: number;
         totalPages: number;
     }>;
-    getFileById(fileId: string): Promise<any>;
+    getFileById(fileId: string, portalEntityId?: string): Promise<any>;
 }

package/dist/modules/edrm-storage/services/edrm-storage.service.js

@@ -41,7 +41,7 @@ export class EdrmStorageService {
             return FileType.ARCHIVE;
         return FileType.OTHER;
     }
-    async initUpload(originalName, mimeType, size, tenantId, entityName, entityId, provider = this.defaultProvider, metadata, tags) {
+    async initUpload(originalName, mimeType, size, tenantId, entityName, entityId, provider = this.defaultProvider, metadata, tags, portalEntityId) {
         const bucket = process.env.S3_BUCKET || 'edrm-storage';
         const key = this.generateKey(tenantId, entityName, entityId, originalName);
         const storageProvider = this.getProvider(provider);
@@ -64,6 +64,7 @@ export class EdrmStorageService {
             tenantId,
             entityName,
             entityId,
+            ...(portalEntityId && { portalEntityId }),
             uploadedBy: 'system', // À remplacer par l'utilisateur connecté
             accessCount: 0
         });
@@ -77,11 +78,14 @@ export class EdrmStorageService {
             key
         };
     }
-    async completeUpload(fileId) {
+    async completeUpload(fileId, portalEntityId) {
         const fileRecord = await FileModel.findById(fileId);
         if (!fileRecord) {
             throw new Error('Fichier non trouvé');
         }
+        if (portalEntityId && fileRecord.portalEntityId && fileRecord.portalEntityId !== portalEntityId) {
+            throw new Error('Fichier non trouvé');
+        }
         const storageProvider = this.getProvider(fileRecord.provider);
         try {
             // Vérifier que le fichier existe dans le stockage
@@ -102,11 +106,14 @@ export class EdrmStorageService {
             throw new Error(`Erreur lors de la finalisation de l'upload: ${error}`);
         }
     }
-    async getDownloadUrl(fileId, filename, expiresIn = 3600) {
+    async getDownloadUrl(fileId, filename, expiresIn = 3600, portalEntityId) {
         const fileRecord = await FileModel.findById(fileId);
         if (!fileRecord) {
             throw new Error('Fichier non trouvé');
         }
+        if (portalEntityId && fileRecord.portalEntityId && fileRecord.portalEntityId !== portalEntityId) {
+            throw new Error('Fichier non trouvé');
+        }
         if (fileRecord.status !== FileStatus.COMPLETED) {
             throw new Error('Fichier non encore finalisé');
         }
@@ -123,11 +130,14 @@ export class EdrmStorageService {
             contentType: downloadResponse.contentType
         };
     }
-    async deleteFile(fileId) {
+    async deleteFile(fileId, portalEntityId) {
         const fileRecord = await FileModel.findById(fileId);
         if (!fileRecord) {
             throw new Error('Fichier non trouvé');
         }
+        if (portalEntityId && fileRecord.portalEntityId && fileRecord.portalEntityId !== portalEntityId) {
+            throw new Error('Fichier non trouvé');
+        }
         const storageProvider = this.getProvider(fileRecord.provider);
         try {
             // Supprimer du stockage
@@ -141,7 +151,7 @@ export class EdrmStorageService {
             throw new Error(`Erreur lors de la suppression: ${error}`);
         }
     }
-    async listFiles(tenantId, entityName, entityId, status, page = 1, limit = 20) {
+    async listFiles(tenantId, entityName, entityId, status, page = 1, limit = 20, portalEntityId) {
         const query = {};
         if (tenantId)
             query.tenantId = tenantId;
@@ -149,6 +159,8 @@ export class EdrmStorageService {
             query.entityName = entityName;
         if (entityId)
             query.entityId = entityId;
+        if (portalEntityId)
+            query.portalEntityId = portalEntityId;
         if (status)
             query.status = status;
         const skip = (page - 1) * limit;
@@ -167,11 +179,14 @@ export class EdrmStorageService {
             totalPages: Math.ceil(total / limit)
         };
     }
-    async getFileById(fileId) {
+    async getFileById(fileId, portalEntityId) {
         const fileRecord = await FileModel.findById(fileId);
         if (!fileRecord) {
             throw new Error('Fichier non trouvé');
         }
+        if (portalEntityId && fileRecord.portalEntityId && fileRecord.portalEntityId !== portalEntityId) {
+            throw new Error('Fichier non trouvé');
+        }
         return fileRecord;
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@programisto/edrm-storage",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "publishConfig": {
     "access": "public"
   },