@umituz/react-native-ai-generation-content 1.17.231 → 1.17.233

package/src/features/inpainting/README.md

@@ -1,302 +1,406 @@
-# Inpainting
+# Inpainting Feature
 
 Fill in missing or hidden parts of images using AI.
 
-## Features
+## 📍 Import Path
 
-- Fill in missing areas of images
-- Remove unwanted objects seamlessly
-- Extend image boundaries
-- Smart content-aware fill
-- Natural-looking reconstruction
+```typescript
+import { useInpaintingFeature } from '@umituz/react-native-ai-generation-content';
+```
 
-## Installation
+**Location**: `src/features/inpainting/`
 
-This feature is part of `@umituz/react-native-ai-generation-content`.
+## 🎯 Feature Purpose
 
-```bash
-npm install @umituz/react-native-ai-generation-content
-```
+Intelligently fill in missing areas, remove unwanted objects, or extend image boundaries using AI-powered content-aware fill. Supports smart reconstruction, contextual filling, and pattern matching for natural-looking results.
 
-## Basic Usage
+---
 
-### Using the Hook
+## 📋 Usage Strategy
 
-```tsx
-import { useInpaintingFeature } from '@umituz/react-native-ai-generation-content';
-import * as ImagePicker from 'react-native-image-picker';
-
-function InpaintingScreen() {
-  const [image, setImage] = useState<string | null>(null);
-  const [mask, setMask] = useState<string | null>(null);
-
-  const feature = useInpaintingFeature({
-    config: {
-      fillMethod: 'smart',
-      onProcessingStart: () => console.log('Filling area...'),
-      onProcessingComplete: (result) => console.log('Complete:', result),
-      onError: (error) => console.error('Error:', error),
-    },
-    onSelectImage: async () => {
-      const result = await ImagePicker.launchImageLibrary({ mediaType: 'photo' });
-      if (result.assets && result.assets[0].uri) {
-        const base64 = await convertToBase64(result.assets[0].uri);
-        setImage(base64);
-        return base64;
-      }
-      return null;
-    },
-    onCreateMask: async () => {
-      // User paints over the area to fill
-      const maskImage = await paintMaskOverImage(image);
-      setMask(maskImage);
-      return maskImage;
-    },
-    onSaveResult: async (imageUrl) => {
-      await saveToGallery(imageUrl);
-    },
-  });
-
-  return (
-    <View>
-      <PhotoUploadCard
-        image={image}
-        onSelectImage={feature.selectImage}
-        title="Select Image"
-      />
-
-      <MaskEditor
-        image={image}
-        mask={mask}
-        onMaskCreated={feature.createMask}
-      />
-
-      <FillMethodSelector
-        selectedMethod={feature.state.fillMethod}
-        onSelectMethod={feature.setFillMethod}
-      />
-
-      <Button
-        title="Fill Area"
-        onPress={feature.process}
-        disabled={!feature.isReady || feature.state.isProcessing}
-      />
-
-      {feature.state.isProcessing && (
-        <ActivityIndicator />
-      )}
-
-      {feature.state.result && (
-        <ResultDisplay
-          originalImage={image}
-          resultImage={feature.state.result.imageUrl}
-          onSave={() => feature.saveResult()}
-        />
-      )}
-    </View>
-  );
-}
-```
+### When to Use This Feature
 
-### Using the Unified AI Feature Screen
+✅ **Use Cases:**
+- Removing unwanted objects from photos
+- Repairing damaged or torn areas
+- Extending image boundaries
+- Filling in missing parts of images
+- Cleaning up sensor dust or scratches
 
-```tsx
-import { AIFeatureScreen } from '@umituz/react-native-ai-generation-content';
+❌ **When NOT to Use:**
+- Simple background removal (use Remove Background)
+- General object removal without precise masking (use Remove Object)
+- Photo restoration (use Photo Restoration)
+- Adding new elements not present in image
+
+### Implementation Strategy
+
+1. **Select image** with missing or unwanted areas
+2. **Create mask** by painting over areas to fill
+3. **Choose fill method** (smart, contextual, pattern)
+4. **Configure options** (edge blending, context preservation)
+5. **Process inpainting** with progress tracking
+6. **Preview and compare** with original
+7. **Save or adjust** result
+
+---
+
+## ⚠️ Critical Rules (MUST FOLLOW)
+
+### 1. Image Requirements
+- **MUST** provide ONE image to inpaint
+- **MUST** use high-quality images (min 512x512 recommended)
+- **MUST** have clear areas to fill
+- **MUST NOT** exceed file size limits (10MB max)
+- **MUST** create accurate mask for areas to fill
+
+### 2. Mask Requirements
+- **MUST** provide valid mask image
+- **MUST** paint mask carefully over areas to fill
+- **MUST** ensure mask covers entire area to inpaint
+- **MUST** include mask creation interface
+- **MUST** validate mask before processing
+
+### 3. Configuration
+- **MUST** provide valid `userId` for tracking
+- **MUST** specify `fillMethod` (smart, contextual, pattern)
+- **MUST** implement `onError` callback
+- **MUST** implement `onSelectImage` callback
+- **MUST** implement `onCreateMask` callback
+
+### 4. State Management
+- **MUST** check `isReady` before enabling fill button
+- **MUST** verify both image and mask are provided
+- **MUST** display progress during inpainting
+- **MUST** display `error` state with clear messages
+- **MUST** implement proper cleanup on unmount
+
+### 5. Performance
+- **MUST** implement image compression before upload
+- **MUST** show progress indicator for processing
+- **MUST** cache results locally
+- **MUST** allow users to cancel processing
+- **MUST NOT** inpaint multiple areas simultaneously
+
+---
+
+## 🚫 Prohibitions (MUST AVOID)
+
+### Strictly Forbidden
+
+❌ **NEVER** do the following:
+
+1. **No Missing Mask**
+   - Always validate mask is created
+   - Never call process() without mask
+
+2. **No Auto-Processing**
+   - Never start inpainting without user action
+   - Always require explicit "Fill" button press
+   - Show mask preview before processing
+
+3. **No Hardcoded Credentials**
+   - Never store API keys in component files
+   - Use environment variables or secure storage
+
+4. **No Unhandled Errors**
+   - Never ignore inpainting failures
+   - Always explain what went wrong
+   - Provide retry or alternative options
+
+5. **No Memory Leaks**
+   - Never store both original and result simultaneously
+   - Clean up temporary mask images
+   - Implement proper image disposal
+
+6. **No Blocked UI**
+   - Never block main thread with mask processing
+   - Always show progress indicator
+   - Allow cancellation
+
+7. **No Imprecise Masking**
+   - Never use rough or inaccurate masks
+   - Always provide tools for precise mask creation
+   - Allow mask adjustment before processing
+
+---
+
+## 🤖 AI Agent Directions
+
+### For AI Code Generation Tools
+
+When using this feature with AI code generation tools, follow these guidelines:
+
+#### Prompt Template for AI Agents
 
-function App() {
-  return (
-    <AIFeatureScreen
-      featureId="inpainting"
-      userId="user-123"
-    />
-  );
-}
 ```
+You are implementing an inpainting feature using @umituz/react-native-ai-generation-content.
+
+REQUIREMENTS:
+1. Import from: @umituz/react-native-ai-generation-content
+2. Use the useInpaintingFeature hook
+3. Implement image selection UI
+4. Implement mask creation UI with drawing tools
+5. Select fill method (smart, contextual, pattern)
+6. Configure options (preserveContext, blendEdges)
+7. Validate both image and mask before processing
+8. Show before/after comparison
+9. Handle long processing times with progress
+10. Implement proper error handling
+11. Implement cleanup on unmount
+
+CRITICAL RULES:
+- MUST validate both image and mask before calling process()
+- MUST provide mask drawing/creation interface
+- MUST show before/after comparison
+- MUST handle fill method selection
+- MUST implement debouncing (300ms)
+- MUST allow multiple inpainting attempts
+
+CONFIGURATION:
+- Provide valid userId (string)
+- Set fillMethod: 'smart' | 'contextual' | 'pattern'
+- Set preserveContext: boolean (maintain surroundings)
+- Set blendEdges: boolean (seamless integration)
+- Implement onSelectImage callback
+- Implement onCreateMask callback
+- Implement onSaveResult callback
+- Configure callbacks: onProcessingStart, onProcessingComplete, onError
+
+FILL METHODS:
+- smart: AI-powered intelligent reconstruction
+- contextual: Fill based on surrounding content
+- pattern: Fill with detected patterns
+
+OPTIONS:
+- preserveContext: Maintain surrounding context (default: true)
+- blendEdges: Blend filled area with surroundings (default: true)
+
+STRICTLY FORBIDDEN:
+- No missing mask validation
+- No auto-processing without user action
+- No hardcoded API keys
+- No unhandled errors
+- No memory leaks
+- No blocking UI
+- No imprecise masking
+
+QUALITY CHECKLIST:
+- [ ] Image selection implemented
+- [ ] Mask creation/drawing interface added
+- [ ] Fill method selector included
+- [ ] Mask validation before processing
+- [ ] Before/after comparison view
+- [ ] Progress indicator during processing
+- [ ] Error display with retry option
+- [ ] Download/share functionality
+- [ ] Multiple inpainting attempts supported
+```
+
+#### AI Implementation Checklist
+
+Use this checklist when generating code:
+
+- [ ] Feature imported from correct path
+- [ ] Image selection implemented
+- [ ] Mask drawing interface implemented
+- [ ] Fill method selector added
+- [ ] Validation before process() (image + mask)
+- [ ] Before/after comparison view
+- [ ] Progress indicator during processing
+- [ ] Error display with user-friendly message
+- [ ] Download/share buttons
+- [ ] Multiple inpainting attempts option
+- [ ] Cleanup on unmount
+- [ ] Original image preserved
 
-## Configuration Options
+---
 
-### Feature Config
+## 🛠️ Configuration Strategy
 
-```tsx
-interface InpaintingFeatureConfig {
-  fillMethod?: 'smart' | 'contextual' | 'pattern';
-  onProcessingStart?: () => void;
-  onProcessingComplete?: (result: InpaintingResult) => void;
-  onError?: (error: string) => void;
+### Essential Configuration
+
+```typescript
+// Required fields
+{
+  userId: string
+  fillMethod: 'smart' | 'contextual' | 'pattern'
+  onSelectImage: () => Promise<string | null>
+  onCreateMask: () => Promise<string | null>
+}
+
+// Optional callbacks
+{
+  onProcessingStart?: () => void
+  onProcessingComplete?: (result) => void
+  onError?: (error: string) => void
 }
 ```
 
-### Processing Options
+### Recommended Settings
+
+1. **Fill Methods**
+   - Smart: AI-powered intelligent reconstruction (recommended for most cases)
+   - Contextual: Fill based on surrounding content (good for consistent backgrounds)
+   - Pattern: Fill with detected patterns (good for repeating elements)
+
+2. **Options**
+   - preserveContext: Maintain surrounding context (default: true)
+   - blendEdges: Blend filled area seamlessly (default: true)
+
+3. **Image Quality**
+   - Minimum: 512x512 resolution
+   - Recommended: 1024x1024 or higher
+   - Format: JPEG or PNG
+   - Max size: 10MB
+
+4. **Mask Quality**
+   - Precise masking around edges
+   - Complete coverage of area to fill
+   - Semi-transparent for preview
+
+---
+
+## 📊 State Management
+
+### Feature States
+
+**isReady**: boolean
+- Image selected and mask created
+- Check before enabling fill button
+
+**isProcessing**: boolean
+- Inpainting in progress
+- Show loading/progress indicator
+- Disable fill button
 
-```tsx
-interface InpaintingOptions {
-  mask: string; // Base64 mask of area to fill
-  fillMethod: 'smart' | 'contextual' | 'pattern';
-  preserveContext?: boolean; // Maintain surrounding context (default: true)
-  blendEdges?: boolean; // Blend filled area with surroundings (default: true)
+**progress**: number (0-100)
+- Inpainting progress percentage
+- Update progress bar
+
+**error**: string | null
+- Error message if inpainting failed
+- Display to user with clear message
+
+**result**: {
+  imageUrl: string
+  originalImageUrl?: string
+  fillMethod?: string
+  metadata?: any
 }
-```
 
-## Fill Methods
+---
 
-### Smart Fill
+## 🎨 Best Practices
 
-AI-powered intelligent reconstruction:
+### Mask Creation
 
-```tsx
-const result = await feature.process({
-  mask: maskImage,
-  fillMethod: 'smart',
-  preserveContext: true,
-});
-```
+1. **Precision**
+   - Good: Carefully painted edges around area
+   - Bad: Rough, imprecise masking
 
-### Contextual Fill
+2. **Coverage**
+   - Ensure mask covers entire area to fill
+   - Include some surrounding context
+   - Avoid leaving gaps
 
-Fill based on surrounding content:
+3. **Fill Method Selection**
+   - Use Smart Fill for most cases
+   - Use Contextual for consistent backgrounds
+   - Use Pattern for repeating elements
 
-```tsx
-const result = await feature.process({
-  mask: maskImage,
-  fillMethod: 'contextual',
-  blendEdges: true,
-});
-```
+### User Experience
 
-### Pattern Fill
+1. **Mask Drawing Tools**
+   - Brush size adjustment
+   - Eraser for corrections
+   - Undo/redo support
+   - Zoom for precision
 
-Fill with detected patterns:
+2. **Preview**
+   - Show mask overlay before processing
+   - Allow mask adjustments
+   - Preview fill method settings
 
-```tsx
-const result = await feature.process({
-  mask: maskImage,
-  fillMethod: 'pattern',
-});
-```
+3. **Before/After Comparison**
+   - Side-by-side comparison
+   - Slider for easy comparison
+   - Zoom for detail inspection
 
-## Usage Flow
+---
 
-1. Select **Image** - Choose an image with missing or unwanted areas
-2. Create **Mask** - Paint over the area to fill
-3. Choose **Fill Method** - Select the fill strategy
-4. Tap **Fill** - Start the inpainting process
-5. View **Result** - See the filled image
-6. Save or Adjust - Save or make further adjustments
+## 🐛 Common Pitfalls
 
-## Component Examples
+### Mask Issues
 
-### Fill Method Selector
+❌ **Problem**: Poor inpainting results
+✅ **Solution**: Use precise mask, try different fill method
 
-```tsx
-import { GridSelector } from '@umituz/react-native-ai-generation-content';
+### Edge Issues
 
-const fillMethods = [
-  { id: 'smart', name: 'Smart Fill', description: 'AI reconstruction' },
-  { id: 'contextual', name: 'Contextual', description: 'Based on surroundings' },
-  { id: 'pattern', name: 'Pattern', description: 'Pattern matching' },
-];
+❌ **Problem**: Visible edges around filled area
+✅ **Solution**: Enable blendEdges, improve mask precision
 
-<GridSelector
-  options={fillMethods}
-  selectedOption={selectedMethod}
-  onSelectOption={setSelectedMethod}
-/>
-```
+### Performance Issues
 
-### Mask Editor
-
-```tsx
-import { View, Image } from 'react-native';
-
-function MaskEditor({ image, mask, onMaskCreated }) {
-  return (
-    <View style={{ position: 'relative' }}>
-      <Image source={{ uri: image }} style={{ width: 300, height: 300 }} />
-      {mask && (
-        <Image
-          source={{ uri: mask }}
-          style={{ width: 300, height: 300, position: 'absolute', opacity: 0.5 }}
-        />
-      )}
-      <Button title="Paint Mask" onPress={onMaskCreated} />
-    </View>
-  );
-}
-```
+❌ **Problem**: Slow inpainting
+✅ **Solution**: Compress images, show progress, allow cancellation
 
-### Before/After Comparison
+### Selection Issues
 
-```tsx
-import { ResultDisplay } from '@umituz/react-native-ai-generation-content';
+❌ **Problem**: Wrong fill method for content
+✅ **Solution**: Try different fill method, adjust context preservation
 
-{feature.state.result && image && (
-  <ResultDisplay
-    originalImage={image}
-    resultImage={feature.state.result.imageUrl}
-    onSave={() => feature.saveResult()}
-    onShare={() => shareImage(feature.state.result.imageUrl)}
-  />
-)}
-```
+---
 
-## Use Cases
+## 📦 Related Components
 
-### Remove Objects
+Use these components from the library:
 
-```tsx
-// Remove unwanted objects
-const result = await feature.process({
-  mask: objectMask,
-  fillMethod: 'smart',
-});
-```
+- **PhotoUploadCard**: Upload image interface
+- **MaskEditor**: Create mask with drawing tools
+- **FillMethodSelector**: Choose fill strategy
+- **ResultDisplay**: Before/after comparison
+- **ProgressBar**: Progress display
 
-### Repair Damaged Photos
+Located at: `src/presentation/components/`
 
-```tsx
-// Fix tears or damaged areas
-const result = await feature.process({
-  mask: damageMask,
-  fillMethod: 'contextual',
-  blendEdges: true,
-});
-```
+---
 
-### Extend Image
+## 🔄 Migration Strategy
 
-```tsx
-// Expand image boundaries
-const result = await feature.process({
-  mask: extensionMask,
-  fillMethod: 'smart',
-});
-```
+If migrating from previous implementation:
 
-### Fill Missing Parts
+1. **Update imports** to new path
+2. **Add mask creation interface**
+3. **Implement fill method selector**
+4. **Update state handling** for new structure
+5. **Add before/after comparison**
+6. **Test all fill methods**
 
-```tsx
-// Complete missing elements
-const result = await feature.process({
-  mask: missingPartMask,
-  fillMethod: 'smart',
-  preserveContext: true,
-});
-```
+---
+
+## 📚 Additional Resources
+
+- Main documentation: `/docs/`
+- API reference: `/docs/api/`
+- Examples: `/docs/examples/basic/inpainting/`
+- Architecture: `/ARCHITECTURE.md`
 
-## Best Practices
+---
 
-1. **Mask Precision**: Paint carefully around the edges
-2. **Fill Method**: Use Smart Fill for most cases
-3. **Context Preservation**: Enable for natural results
-4. **Multiple Tries**: May need multiple attempts for complex areas
-5. **Edge Blending**: Enable for seamless integration
+**Last Updated**: 2025-01-08
+**Version**: 2.0.0 (Strategy-based Documentation)
 
-## Related Features
+---
 
-- [Remove Object](../remove-object) - Remove unwanted objects
-- [Remove Background](../remove-background) - Remove backgrounds
-- [Photo Restoration](../photo-restoration) - Restore old photos
+## 📝 Changelog
 
-## License
+### v2.0.0 - 2025-01-08
+- **BREAKING**: Documentation format changed to strategy-based
+- Removed extensive code examples
+- Added rules, prohibitions, and AI agent directions
+- Focus on best practices and implementation guidance
 
-MIT
+### v1.0.0 - Initial Release
+- Initial feature documentation