i18ntk 1.4.0 → 1.4.2

package/docs/api/COMPONENTS.md

@@ -1,492 +0,0 @@
-# I18N Management Toolkit - Components Documentation
-
-**Version:** 1.4.6  
-**Last Updated:** 26/07/2025  
-**Maintainer:** Vladimir Noskov  
-
-## 📋 Overview
-
-This document provides detailed information about all components, utilities, and modules within the I18N Management Toolkit.
-
-## 🏗️ Core Components
-
-### Main Modules
-
-#### `i18ntk-manage.js`
-**Location:** `main/i18ntk-manage.js`  
-**Purpose:** Main management interface and interactive menu  
-**Dependencies:**
-- UIi18n
-- AdminAuth
-- SecurityUtils
-- AdminCLI
-- settingsManager
-- All analyzer modules
-
-**Key Features:**
-- Interactive CLI menu
-- Command-line argument parsing
-- Framework detection
-- Admin authentication
-- Settings management
-
-#### `i18ntk-init.js`
-**Location:** `main/i18ntk-init.js`  
-**Purpose:** Project initialization and setup  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-
-**Key Features:**
-- Project structure initialization
-- Language file creation
-- Framework configuration
-- Source code scanning
-
-#### `i18ntk-analyze.js`
-**Location:** `main/i18ntk-analyze.js`  
-**Purpose:** Translation analysis and completeness checking  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-
-**Key Features:**
-- Translation completeness analysis
-- Missing key detection
-- Progress reporting
-- Multi-language support
-
-#### `i18ntk-validate.js`
-**Location:** `main/i18ntk-validate.js`  
-**Purpose:** Translation validation and quality assurance  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-- AdminCLI
-
-**Key Features:**
-- JSON/YAML validation
-- Syntax error detection
-- Consistency checking
-- Auto-fix capabilities
-
-#### `i18ntk-usage.js`
-**Location:** `main/i18ntk-usage.js`  
-**Purpose:** Translation key usage analysis  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-- AdminCLI
-
-**Key Features:**
-- Unused key detection
-- Missing key identification
-- Source code scanning
-- Usage statistics
-
-#### `i18ntk-complete.js`
-**Location:** `main/i18ntk-complete.js`  
-**Purpose:** Translation completion and auto-translation  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-
-**Key Features:**
-- Missing translation completion
-- AI-powered translation
-- Manual translation input
-- Batch processing
-
-#### `i18ntk-sizing.js`
-**Location:** `main/i18ntk-sizing.js`  
-**Purpose:** Translation file sizing analysis  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-
-**Key Features:**
-- File size analysis
-- Memory usage calculation
-- Performance optimization
-- Size reporting
-
-#### `i18ntk-summary.js`
-**Location:** `main/i18ntk-summary.js`  
-**Purpose:** Comprehensive project summary generation  
-**Dependencies:**
-- UIi18n
-- i18n-helper
-- settings-manager
-- security
-
-**Key Features:**
-- Project overview generation
-- Multi-format reporting
-- Statistical analysis
-- Visual charts and graphs
-
-#### `i18ntk-autorun.js`
-**Location:** `main/i18ntk-autorun.js`  
-**Purpose:** Automated workflow execution  
-**Dependencies:**
-- All main modules
-- Workflow configuration
-
-**Key Features:**
-- Automated task execution
-- Workflow orchestration
-- Progress tracking
-- Error handling
-
-## 🛠️ Utility Components
-
-### Core Utilities
-
-#### `i18ntk-ui.js`
-**Location:** Root directory  
-**Purpose:** User interface internationalization  
-**Features:**
-- Multi-language UI support
-- Dynamic language switching
-- Message formatting
-- Locale-specific formatting
-
-#### `settings-manager.js`
-**Location:** Root directory  
-**Purpose:** Configuration and settings management  
-**Features:**
-- Configuration file handling
-- Settings validation
-- Default value management
-- Environment variable support
-
-#### `settings-cli.js`
-**Location:** Root directory  
-**Purpose:** Command-line settings interface  
-**Features:**
-- CLI-based settings management
-- Interactive configuration
-- Settings import/export
-- Validation and error handling
-
-### Security Components
-
-#### `utils/security.js`
-**Location:** `utils/security.js`  
-**Purpose:** Security utilities and encryption  
-**Features:**
-- Data encryption/decryption
-- Secure key storage
-- Authentication helpers
-- Security validation
-
-#### `utils/admin-auth.js`
-**Location:** `utils/admin-auth.js`  
-**Purpose:** Administrative authentication  
-**Features:**
-- Admin user authentication
-- Permission management
-- Session handling
-- Security logging
-
-#### `utils/admin-cli.js`
-**Location:** `utils/admin-cli.js`  
-**Purpose:** Administrative command-line interface  
-**Features:**
-- Admin-only commands
-- Privileged operations
-- Audit logging
-- Security enforcement
-
-### Helper Components
-
-#### `utils/i18n-helper.js`
-**Location:** `utils/i18n-helper.js`  
-**Purpose:** Core i18n functionality and helpers  
-**Features:**
-- File system operations
-- JSON/YAML parsing
-- Key extraction
-- Language detection
-
-#### `utils/detect-language-mismatches.js`
-**Location:** `utils/detect-language-mismatches.js`  
-**Purpose:** Language mismatch detection  
-**Features:**
-- Cross-language validation
-- Inconsistency detection
-- Mismatch reporting
-- Auto-correction suggestions
-
-#### `utils/maintain-language-purity.js`
-**Location:** `utils/maintain-language-purity.js`  
-**Purpose:** Language purity maintenance  
-**Features:**
-- Language consistency checking
-- Purity score calculation
-- Quality assurance
-- Improvement suggestions
-
-#### `utils/validate-language-purity.js`
-**Location:** `utils/validate-language-purity.js`  
-**Purpose:** Language purity validation  
-**Features:**
-- Purity validation rules
-- Quality metrics
-- Validation reporting
-- Compliance checking
-
-#### `utils/translate-mismatches.js`
-**Location:** `utils/translate-mismatches.js`  
-**Purpose:** Mismatch translation and correction  
-**Features:**
-- Automatic mismatch correction
-- Translation suggestions
-- Batch processing
-- Quality improvement
-
-#### `utils/native-translations.js`
-**Location:** `utils/native-translations.js`  
-**Purpose:** Native language translation support  
-**Features:**
-- Native speaker validation
-- Cultural context checking
-- Localization best practices
-- Regional variations
-
-#### `utils/update-console-i18n.js`
-**Location:** `utils/update-console-i18n.js`  
-**Purpose:** Console message internationalization  
-**Features:**
-- Console message translation
-- Dynamic message updates
-- Logging internationalization
-- Debug message localization
-
-## 🐛 Debug Components
-
-### Debug Tools
-
-#### `dev/debug/debugger.js`
-**Location:** `dev/debug/debugger.js`  
-**Purpose:** Main debugging interface  
-**Features:**
-- Comprehensive debugging
-- Error analysis
-- Performance monitoring
-- Diagnostic reporting
-
-#### `dev/debug/console-key-checker.js`
-**Location:** `dev/debug/console-key-checker.js`  
-**Purpose:** Console key validation and checking  
-**Features:**
-- Console message key validation
-- Missing key detection
-- Usage analysis
-- Consistency checking
-
-#### `dev/debug/console-translations.js`
-**Location:** `dev/debug/console-translations.js`  
-**Purpose:** Console message translation management  
-**Features:**
-- Console message translation
-- Dynamic updates
-- Language switching
-- Message formatting
-
-#### `dev/debug/complete-console-translations.js`
-**Location:** `dev/debug/complete-console-translations.js`  
-**Purpose:** Complete console translation coverage  
-**Features:**
-- Full console translation
-- Missing translation completion
-- Batch processing
-- Quality assurance
-
-#### `dev/debug/replace-hardcoded-console.js`
-**Location:** `dev/debug/replace-hardcoded-console.js`  
-**Purpose:** Replace hardcoded console messages  
-**Features:**
-- Hardcoded message detection
-- Automatic replacement
-- Code transformation
-- Internationalization conversion
-
-#### `dev/debug/export-missing-keys.js`
-**Location:** `dev/debug/export-missing-keys.js`  
-**Purpose:** Export missing translation keys  
-**Features:**
-- Missing key identification
-- Export functionality
-- Multiple format support
-- Batch processing
-
-## 🧪 Test Components
-
-### Test Utilities
-
-#### `dev/tests/test-complete-system.js`
-**Location:** `dev/tests/test-complete-system.js`  
-**Purpose:** Complete system testing  
-**Features:**
-- End-to-end testing
-- System integration tests
-- Performance testing
-- Regression testing
-
-#### `dev/tests/test-console-i18n.js`
-**Location:** `dev/tests/test-console-i18n.js`  
-**Purpose:** Console internationalization testing  
-**Features:**
-- Console message testing
-- Translation validation
-- Language switching tests
-- Message formatting tests
-
-#### `dev/tests/test-features.js`
-**Location:** `dev/tests/test-features.js`  
-**Purpose:** Feature-specific testing  
-**Features:**
-- Individual feature testing
-- Unit testing
-- Integration testing
-- Feature validation
-
-#### `utils/test-complete-system.js`
-**Location:** `utils/test-complete-system.js`  
-**Purpose:** System testing utilities  
-**Features:**
-- Testing framework integration
-- Test data management
-- Result validation
-- Report generation
-
-#### `utils/test-console-i18n.js`
-**Location:** `utils/test-console-i18n.js`  
-**Purpose:** Console i18n testing utilities  
-**Features:**
-- Console testing helpers
-- Message validation
-- Translation testing
-- Assertion utilities
-
-## 📊 Component Dependencies
-
-### Dependency Graph
-
-```
-i18ntk-manage.js
-├── UIi18n
-├── AdminAuth
-├── SecurityUtils
-├── AdminCLI
-├── settingsManager
-├── I18nInitializer
-├── I18nAnalyzer
-├── I18nValidator
-├── I18nUsageAnalyzer
-├── I18nSizingAnalyzer
-└── I18nDebugger
-
-Core Utilities
-├── i18ntk-ui.js
-├── settings-manager.js
-├── settings-cli.js
-└── utils/
-    ├── security.js
-    ├── admin-auth.js
-    ├── admin-cli.js
-    ├── i18n-helper.js
-    └── [other utilities]
-
-Debug Components
-└── dev/debug/
-    ├── debugger.js
-    ├── console-key-checker.js
-    ├── console-translations.js
-    └── [other debug tools]
-```
-
-## 🔧 Component Configuration
-
-### Configuration Options
-
-Each component can be configured through:
-
-1. **Environment Variables**
-2. **Configuration Files** (`i18ntk-config.json`, `admin-config.json`)
-3. **Command-line Arguments**
-4. **Programmatic Configuration**
-
-### Example Component Configuration
-
-```javascript
-// Component initialization with configuration
-const analyzer = new I18nAnalyzer({
-  sourceDir: './src',
-  localesDir: './locales',
-  languages: ['en', 'es', 'fr'],
-  framework: 'react-i18next',
-  validation: {
-    strict: true,
-    autoFix: false
-  },
-  reporting: {
-    format: 'html',
-    detailed: true
-  }
-});
-```
-
-## 📈 Performance Considerations
-
-### Component Performance
-
-| Component | Performance Impact | Optimization Tips |
-|-----------|-------------------|-------------------|
-| i18ntk-analyze | Medium | Use caching, limit file scanning |
-| i18ntk-validate | Low | Batch validation, async processing |
-| i18ntk-usage | High | Optimize regex patterns, use indexing |
-| i18ntk-complete | High | Batch API calls, implement rate limiting |
-| i18ntk-sizing | Low | Cache file sizes, use streaming |
-
-### Memory Usage
-
-- **Small Projects** (<100 files): ~50MB
-- **Medium Projects** (100-1000 files): ~150MB
-- **Large Projects** (>1000 files): ~300MB+
-
-## 🔄 Component Lifecycle
-
-### Initialization Sequence
-
-1. **Configuration Loading**
-2. **Dependency Resolution**
-3. **Framework Detection**
-4. **Security Initialization**
-5. **UI Language Setup**
-6. **Component Registration**
-
-### Cleanup Sequence
-
-1. **Resource Cleanup**
-2. **File Handle Closure**
-3. **Memory Deallocation**
-4. **Temporary File Removal**
-5. **Log Finalization**
-
----
-
-**Note:** This component documentation is maintained for version 1.4.6. For implementation details, refer to the source code and [API Reference](./API_REFERENCE.md).