@elchinabilov/nestjs-media-library 1.0.3 → 1.2.0

package/README.md

@@ -7,6 +7,7 @@ Complete NestJS media management library with S3 integration, automatic image op
 ✅ **Database Migrations** - TypeORM migrations included  
 ✅ **Single/Multiple File Upload** - Support for both single and multiple file uploads  
 ✅ **Retrieve Files** - Get files as objects or arrays  
+✅ **Custom Meta Data** - Add custom metadata (userId, organizationId, etc.) to each file  
 ✅ **Automatic Image Optimization** - Built-in image compression to WebP format  
 ✅ **Multiple Conversions** - Generate thumbnails, medium, large sizes automatically  
 ✅ **AWS S3 Integration** - Seamless S3 upload support  
@@ -92,24 +93,44 @@ import { MediaService } from "@elchinabilov/nestjs-media-library";
 export class YourService {
   constructor(private mediaService: MediaService) {}
 
-  async uploadFile(file: Express.Multer.File) {
-    const media = await this.mediaService.uploadSingle(file);
+  // Upload with custom meta data
+  async uploadFile(file: Express.Multer.File, userId: string, orgId: string) {
+    const media = await this.mediaService.uploadSingle(file, {
+      userId: userId,
+      organizationId: orgId,
+      category: "document",
+      uploadedBy: "admin",
+    });
+
     console.log("Original:", media.url);
     console.log("Thumbnail:", media.conversions.thumbnail);
-    console.log("Medium:", media.conversions.medium);
+    console.log("Meta:", media.meta);
     return media;
   }
 
-  async uploadMultiple(files: Express.Multer.File[]) {
-    return await this.mediaService.uploadMultiple(files);
+  async uploadMultiple(files: Express.Multer.File[], projectId: string) {
+    return await this.mediaService.uploadMultiple(files, {
+      projectId: projectId,
+      type: "gallery",
+    });
   }
 
   async getMedia(id: string) {
     return await this.mediaService.findOne(id);
   }
 
-  async getAllMedia() {
-    return await this.mediaService.findAll();
+  // Filter by meta data
+  async getOrganizationMedia(orgId: string) {
+    return await this.mediaService.findAll({ organizationId: orgId });
+  }
+
+  // Update meta data
+  async approveDocument(mediaId: string, adminId: string) {
+    return await this.mediaService.updateMeta(mediaId, {
+      status: "approved",
+      approvedBy: adminId,
+      approvedAt: new Date().toISOString(),
+    });
   }
 
   async deleteMedia(id: string) {
@@ -127,7 +148,14 @@ The package provides ready-to-use REST endpoints:
 ```bash
 POST /media/upload
 Content-Type: multipart/form-data
-Body: file (form-data)
+Body:
+  - file (form-data)
+  - meta (optional JSON string)
+
+# Example with cURL:
+curl -X POST http://localhost:3000/media/upload \
+  -F "file=@photo.jpg" \
+  -F 'meta={"userId":"123","organizationId":"org_456","category":"profile"}'
 ```
 
 Response:
@@ -146,6 +174,11 @@ Response:
     "medium": "https://bucket.s3.amazonaws.com/media/uuid-medium.webp",
     "large": "https://bucket.s3.amazonaws.com/media/uuid-large.webp"
   },
+  "meta": {
+    "userId": "123",
+    "organizationId": "org_456",
+    "category": "profile"
+  },
   "disk": "s3",
   "createdAt": "2024-01-01T00:00:00.000Z"
 }
@@ -156,13 +189,17 @@ Response:
 ```bash
 POST /media/upload-multiple
 Content-Type: multipart/form-data
-Body: files (form-data, multiple)
+Body:
+  - files (form-data, multiple)
+  - meta (optional JSON string)
 ```
 
-### Get All Media
+### Get All Media (with optional filter)
 
 ```bash
 GET /media
+GET /media?organizationId=org_123
+GET /media?userId=user_456&category=profile
 ```
 
 ### Get Single Media
@@ -171,6 +208,18 @@ GET /media
 GET /media/:id
 ```
 
+### Update Meta Data
+
+```bash
+PATCH /media/:id/meta
+Content-Type: application/json
+
+{
+  "status": "approved",
+  "approvedBy": "admin_123"
+}
+```
+
 ### Delete Media
 
 ```bash
@@ -244,15 +293,61 @@ export class CustomController {
   @Post("avatar")
   @UseInterceptors(FileInterceptor("avatar"))
   async uploadAvatar(@UploadedFile() file: Express.Multer.File) {
-    const media = await this.mediaService.uploadSingle(file);
+    const media = await this.mediaService.uploadSingle(file, {
+      type: "avatar",
+      category: "profile",
+    });
+
     return {
       avatarUrl: media.url,
       thumbnailUrl: media.conversions?.thumbnail,
+      metadata: media.meta,
     };
   }
 }
 ```
 
+### Meta Data Usage Examples
+
+```typescript
+// E-commerce: Product image with metadata
+await this.mediaService.uploadSingle(file, {
+  productId: "prod_123",
+  category: "product-image",
+  sku: "SKU-12345",
+  color: "red",
+  position: 0,
+});
+
+// SaaS: Company logo
+await this.mediaService.uploadSingle(file, {
+  organizationId: "org_456",
+  companyName: "Acme Corp",
+  type: "logo",
+  planType: "premium",
+});
+
+// Social Media: Post images
+await this.mediaService.uploadMultiple(files, {
+  userId: "user_789",
+  postId: "post_123",
+  hashtags: ["travel", "nature"],
+  location: "Baku, Azerbaijan",
+});
+
+// Filter by meta
+const orgMedia = await this.mediaService.findAll({
+  organizationId: "org_456",
+});
+
+// Update meta
+await this.mediaService.updateMeta("media-id", {
+  status: "approved",
+  approvedBy: "admin_123",
+  approvedAt: new Date().toISOString(),
+});
+```
+
 ### Direct S3 Service Usage
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@elchinabilov/nestjs-media-library",
-	"version": "1.0.3",
+	"version": "1.2.0",
 	"description": "Complete NestJS media management library with S3, image optimization, and automatic conversions",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",