@umituz/react-native-design-system 4.23.100 → 4.23.101

package/src/media/presentation/hooks/useMediaValidation.README.md

@@ -1,134 +0,0 @@
-# useMediaValidation
-
-## Purpose
-React hook for validating media files before upload, checking file size, type, and providing improvement recommendations.
-
-## File Location
-`src/presentation/hooks/useMediaValidation.ts`
-
-## Strategy
-- Provide comprehensive media file validation before upload
-- Check file size limits with appropriate warnings
-- Validate MIME types against supported formats
-- Provide three-tier feedback: errors (blocking), warnings (performance), recommendations (improvements)
-- Support validation state management
-- Enable pre-upload validation workflow
-- Return actionable feedback for each validation issue
-
-## Forbidden
-- **DO NOT** upload files that fail validation (errors present)
-- **DO NOT** ignore warnings - they indicate performance issues
-- **DO NOT** bypass file type validation
-- **DO NOT** use mock validation in production
-- **DO NOT** allow files exceeding maximum size limits
-- **DO NOT** modify file during validation process
-- **DO NOT** store validation results permanently in hook state
-- **DO NOT** validate empty or missing files
-- **DO NOT** suppress validation errors for user convenience
-
-## Rules
-1. Always validate before upload operations
-2. Files over 50 MB must be rejected with error
-3. Files over 10 MB must trigger warning and recommendation
-4. Unsupported MIME types must be rejected
-5. Validation must check file size, type, and format
-6. Return errors array for blocking issues
-7. Return warnings array for performance concerns
-8. Return recommendations array for improvements
-9. Clear validation state on new validation requests
-10. Support synchronous and asynchronous validation
-
-## AI Agent Guidelines
-
-When working with useMediaValidation hook:
-
-1. **Pre-upload Check**: Always validate before useMediaUpload calls
-2. **Three-Tier Feedback**: Distinguish between errors, warnings, recommendations
-3. **User Decision**: Show warnings but allow user to proceed
-4. **File Size**: Be strict with maximum limits, flexible with warnings
-5. **Type Safety**: Validate MIME types against supported formats
-
-### Validation Levels
-
-**Errors** (Blocking - Must fix before upload):
-- File size exceeds 50 MB
-- Unsupported file type
-- Invalid file format
-- Missing required properties
-
-**Warnings** (Performance - Should fix but can proceed):
-- File size over 10 MB (performance impact)
-- Large dimensions (may need optimization)
-- Non-standard format (compatibility issues)
-
-**Recommendations** (Improvements - Optional suggestions):
-- Reduce file size for better performance
-- Use recommended format (JPEG for images, MP4 for video)
-- Optimize dimensions for target use case
-- Compress to balance quality and size
-
-### Supported File Types
-
-**Images:**
-- image/jpeg (JPEG photos)
-- image/png (PNG graphics with transparency)
-- image/webp (WebP format)
-
-**Audio:**
-- audio/mp3 (MP3 compressed audio)
-- audio/wav (WAV uncompressed audio)
-- audio/m4a (M4A audio format)
-
-**Video:**
-- video/mp4 (MP4 video)
-- video/mov (QuickTime video)
-
-### Validation Workflow
-
-1. Receive file object with name, type, size, uri
-2. Check file size against limits (50 MB max, 10 MB warning)
-3. Validate MIME type against supported formats
-4. Generate appropriate errors, warnings, recommendations
-5. Return MediaValidation object with results
-6. Display feedback to user for action
-
-### Validation State Management
-
-- isValid: Boolean (true if no errors)
-- errors: String array (blocking issues)
-- warnings: String array (performance concerns)
-- recommendations: String array (improvement suggestions)
-
-### Integration with Upload Flow
-
-Typical validation-upload workflow:
-1. Select file from picker or file system
-2. Call validateMedia(file)
-3. Check validation.isValid
-4. If errors: Show to user, block upload
-5. If warnings: Show to user, ask confirmation
-6. If recommendations: Show to user for reference
-7. Proceed to upload if no errors or user confirms warnings
-
-### File Size Guidelines
-
-**Images:**
-- Optimal: Under 2 MB
-- Warning: 2-10 MB
-- Error: Over 50 MB
-
-**Audio:**
-- Optimal: Under 5 MB
-- Warning: 5-10 MB
-- Error: Over 50 MB
-
-**Video:**
-- Optimal: Under 10 MB
-- Warning: 10-50 MB
-- Error: Over 50 MB
-
-## Dependencies
-
-- MediaValidationService (infrastructure layer)
-- Domain types: MediaValidation, file input interfaces
-- Media constants (size limits, supported types)

package/src/media/presentation/hooks/useMultimediaFlashcard.README.md

@@ -1,141 +0,0 @@
-# useMultimediaFlashcard
-
-## Purpose
-Main hook for creating and managing flashcards with media attachments, providing all multimedia operations in one place.
-
-## File Location
-`src/presentation/hooks/useMultimediaFlashcard.ts`
-
-## Strategy
-- Provide unified interface for flashcard creation with media support
-- Support adding, updating, and deleting media on flashcards
-- Automatically analyze media composition (types, sizes, positions)
-- Calculate estimated storage requirements
-- Track download status for offline support
-- Enable rich multimedia flashcard experiences
-- Maintain separation between card data and media management
-
-## Forbidden
-- **DO NOT** create flashcards without required fields (front, back)
-- **DO NOT** add media without proper validation first
-- **DO NOT** allow duplicate media attachments with same ID
-- **DO NOT** mock card operations in production without backend integration
-- **DO NOT** assume all media is downloaded (check isDownloaded flag)
-- **DO NOT** modify card structure after creation (use update functions)
-- **DO NOT** exceed practical media limits per card (performance)
-- **DO NOT** store large media directly in card object (use references)
-- **DO NOT** bypass media analysis for size estimation
-
-## Rules
-1. Always validate media before adding to flashcard
-2. Calculate estimatedSize from all media attachments
-3. Generate unique ID for each flashcard
-4. Analyze media types and populate mediaType array
-5. Set hasMedia flag based on media array length
-6. Set isDownloaded based on all media download status
-7. Support front, back, and both positions for media
-8. Return complete MultimediaFlashcard object
-9. Clear processing state on completion or error
-10. Support empty media array for text-only cards
-
-## AI Agent Guidelines
-
-When working with useMultimediaFlashcard hook:
-
-1. **Media First**: Upload and validate media before creating card
-2. **Size Awareness**: Monitor estimatedSize for performance implications
-3. **Type Analysis**: Use mediaType array to determine card capabilities
-4. **Download Status**: Check isDownloaded before displaying media
-5. **Position Strategy**: Assign appropriate position (front, back, both)
-
-### Card Creation Workflow
-
-1. Prepare card content (front text, back text)
-2. Upload and validate media files separately
-3. Collect MediaAttachment objects
-4. Call createMultimediaCard with data
-5. Receive complete MultimediaFlashcard object
-6. Use returned card for display and storage
-
-### Flashcard Structure
-
-MultimediaFlashcard includes:
-- id: Unique card identifier
-- front: Front side content (question/prompt)
-- back: Back side content (answer/explanation)
-- difficulty: easy/medium/hard
-- tags: Array of topic tags
-- media: Array of MediaAttachment objects
-- hasMedia: Boolean flag for media presence
-- mediaType: Array of unique media types present
-- isDownloaded: Boolean (all media downloaded)
-- estimatedSize: Total size in bytes
-- createdAt: ISO timestamp
-
-### Media Analysis
-
-**hasMedia**: True if media array has items
-**mediaType**: Unique array of media types (image, audio, video)
-**isDownloaded**: True if all media.isDownloaded are true
-**estimatedSize**: Sum of all media.fileSize values
-
-### Media Positioning
-
-Media can be assigned to:
-- **front**: Displayed on front side of card
-- **back**: Displayed on back side of card
-- **both**: Displayed on both sides
-
-### Card Management Operations
-
-**createMultimediaCard**: Create new card with media
-- Validates required fields (front, back)
-- Processes media array
-- Generates unique ID
-- Analyzes media composition
-- Calculates estimated size
-
-**updateMedia**: Replace media on existing card
-- Updates media array
-- Re-analyzes composition
-- Recalculates size
-- Preserves card ID and metadata
-
-**deleteMedia**: Remove specific media attachment
-- Removes from media array by ID
-- Updates analysis
-- Recalculates size
-
-### Integration with Other Hooks
-
-Typical workflow combining multiple hooks:
-1. useMedia: Select images/videos
-2. useMediaUpload: Upload selected media
-3. useMediaValidation: Validate before upload
-4. useMediaGeneration: Generate AI media (optional)
-5. useMultimediaFlashcard: Create card with media
-
-### Performance Considerations
-
-- Limit media count per card (recommend 5-10 items)
-- Monitor estimatedSize (warn over 25 MB)
-- Use thumbnails for previews
-- Lazy load media when displaying cards
-- Cache cards with downloaded media
-
-### Best Practices
-
-1. Always validate media before adding to cards
-2. Use descriptive tags for card organization
-3. Set appropriate difficulty levels
-4. Balance media types (don't overload with videos)
-5. Consider offline usage (isDownloaded flag)
-6. Provide captions for accessibility
-
-## Dependencies
-
-- MultimediaFlashcardService (infrastructure layer)
-- Domain types: MultimediaFlashcard, MediaAttachment
-- useMediaUpload (for media upload)
-- useMediaValidation (for media validation)
-- useMediaGeneration (for AI media generation)