i18ntk 1.6.2 → 1.7.0

package/README.md

@@ -2,34 +2,32 @@
 
 ![i18ntk Logo](docs/screenshots/i18ntk-logo-public.PNG)
 
-**Version:** 1.6.2 
-**Last Updated:** 2025-08-09  
+**Version:** 1.7.0
+**Last Updated:** 2025-08-10  
 **GitHub Repository:** [vladnoskv/i18ntk](https://github.com/vladnoskv/i18ntk)
 
 [![npm](https://img.shields.io/npm/dt/i18ntk.svg)](https://www.npmjs.com/package/i18ntk) [![npm version](https://badge.fury.io/js/i18ntk.svg)](https://badge.fury.io/js/i18ntk) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D16.0.0-brightgreen.svg)](https://nodejs.org/) [![Downloads](https://img.shields.io/npm/dm/i18ntk.svg)](https://www.npmjs.com/package/i18ntk) [![GitHub stars](https://img.shields.io/github/stars/vladnoskv/i18ntk?style=social)](https://github.com/vladnoskv/i18ntk)
 
-> **🚨 Latest Update (v1.6.2)**: Critical npm package installation bug resolved from 1.6.0 and 1.6.1.
-
 **🚀 The fastest way to manage translations across any framework or vanilla JavaScript projects**
 
 **Framework Support:** Auto-detects popular libraries (React i18next, Vue i18n, i18next, Nuxt i18n, Svelte i18n) or works without a framework. i18ntk manages translation files and validation—it does NOT implement translations on pages.
 
-> **Zero dependencies** | **Optimized smaller package** | **Works with any framework** | **Enterprise-grade security**
+> **Zero dependencies** | **Works with any framework** | **Enterprise-grade security**
 
-> **v1.6.0** - **Ultra-extreme performance improvements to the i18ntk toolkit with 97% speed improvement** ⚡ Under 30ms for 200k keys (vs 1.2 seconds), up to 86% package size reduction, zero runtime dependencies.
+> **v1.7.0** – 97% speed improvement (**15.38ms** for 200k keys), new watch helper, and a lite English-only UI locale framework; up to 86% package size reduction, zero runtime dependencies, enhanced security with PIN protection, and comprehensive edge case handling.
 
 ## 🚀 Quick Start
 
 ```bash
 # Install globally
-npm install -g i18ntk@1.6.0
+npm i i18ntk
 
 # Interactive setup
-npx i18ntk init
+npx i18ntk
 
 # Basic commands
 i18ntk analyze --source ./src
-i18ntk complete --config=extreme
+i18ntk complete --source ./src
 i18ntk validate --source ./locales
 ```
 
@@ -37,18 +35,25 @@ i18ntk validate --source ./locales
 
 | Mode | Time (200k keys) | Memory | Package Size |
 |------|------------------|--------|--------------|
+| **Ultra-Extreme** | **15.38ms** | 1.62MB | 115KB-830KB |
 | **Extreme** | **38.90ms** | 0.61MB | 115KB-830KB |
 | Ultra | 336.8ms | 0.64MB | Configurable |
 | Optimized | 847.9ms | 0.45MB | Full package |
 
 ## 🎯 Key Features
 
-- **Ultra Performance**: 97% speed improvement with extreme optimization
+- **Ultra-Extreme Performance**: 97% speed improvement - **15.38ms** for 200k keys
+- **Enhanced Security**: Advanced PIN protection with exponential backoff & AES-256 encryption
+- **Edge Case Handling**: Robust handling of corrupt files, encoding issues, and network failures
 - **Smart Sizing**: Interactive locale optimizer (up to 86% size reduction)
-- **Enterprise Security**: Admin PIN protection & comprehensive validation
+- **Enterprise Backup**: Automated encrypted backups with cloud integration
 - **Zero Dependencies**: Lightweight, production-ready
-- **7 Languages**: English, Spanish, French, German, Japanese, Russian, Chinese 
-- **Framework Support**: Auto-detects React i18next, Vue i18n, Angular, Next i18next, Nuxt i18n, Svelte i18n
+- **Watch Helper**: Optional `--watch` mode keeps translations synced in real time
+- **Lite Package Framework**: Build an English-only UI locale bundle for minimal footprint
+- **8 Languages**: English, Spanish, French, German, Japanese, Russian, Chinese, and more
+- **Framework Support**: Auto-detects React i18next, Vue i18n, Angular, Next i18next, Nuxt i18next, Svelte i18n
+- **Memory Optimization**: 67% memory reduction with streaming processing
+- **Scalability**: Linear scaling up to 5M keys with ultra-extreme settings
 
 ### 📸 Screenshots
 
@@ -70,10 +75,12 @@ i18ntk validate --source ./locales
 |---------|---------|---------|
 | `init` | Setup project | `i18ntk init --interactive` |
 | `analyze` | Find missing translations | `i18ntk analyze --source ./src` |
-| `complete` | Generate translations | `i18ntk complete --config=extreme` |
+| `complete` | Generate translations | `i18ntk complete --config=ultra-extreme` |
 | `validate` | Check translation quality | `i18ntk validate --strict` |
 | `sync` | Sync across languages | `i18ntk sync --languages en,es,fr` |
 | `usage` | Analyze usage patterns | `i18ntk usage --format=json` |
+| `doctor` | Diagnose configuration issues | `i18ntk doctor` |
+| `sizing` | Optimize package size | `i18ntk sizing --interactive` |
 
 ## 🔧 Configuration
 
@@ -81,19 +88,45 @@ Configuration is managed through the `settings/i18ntk-config.json` file:
 
 ```json
 {
-  "version": "1.6.2",
+  "version": "1.7.0",
   "sourceDir": "./locales",
   "outputDir": "./i18ntk-reports",
   "defaultLanguage": "en",
-  "supportedLanguages": ["en", "es", "fr", "de"],
+  "supportedLanguages": ["en", "es", "fr", "de", "ja", "ru", "zh"],
   "performance": {
-    "mode": "extreme",
-    "batchSize": 1000,
-    "concurrency": 16
+    "mode": "ultra-extreme",
+    "batchSize": 2000,
+    "concurrency": 32,
+    "memoryLimit": "256MB",
+    "streaming": true,
+    "compression": "brotli"
+  },
+  "security": {
+    "adminPinEnabled": true,
+    "sessionTimeout": 30,
+    "maxFailedAttempts": 3
+  },
+  "backup": {
+    "enabled": true,
+    "retentionDays": 30,
+    "maxBackups": 100
   }
 }
 ```
 
+### Environment Variables
+
+You can override common path settings with environment variables:
+
+| Variable | Overrides | Description |
+|----------|-----------|-------------|
+| `I18NTK_PROJECT_ROOT` | `projectRoot` | Base project directory |
+| `I18NTK_SOURCE_DIR` | `sourceDir` | Location of source translation files |
+| `I18NTK_I18N_DIR` | `i18nDir` | Working i18n directory |
+| `I18NTK_OUTPUT_DIR` | `outputDir` | Output directory for generated reports |
+
+These values are merged into the loaded configuration at runtime.
+
 ## 🌍 Language Optimization
 
 ```bash
@@ -132,13 +165,20 @@ import { createI18n } from 'vue-i18n';
 const i18n = createI18n({ locale: 'en', messages: translations });
 ```
 
-
 ## 🔒 Security Features
 
-- **Admin PIN Protection**: File role-based access control
-- **Input Sanitization**: Path traversal prevention
-- **File Validation**: Safe file operations
-- **Session Management**: Automatic timeout & cleanup
+- **Admin PIN Protection**: AES-256-GCM encryption with 30-min sessions
+- **Advanced Input Sanitization**: Comprehensive path traversal prevention
+- **Zero-Trust Architecture**: All inputs validated and sanitized
+- **Session Management**: Automatic timeout & cleanup with exponential backoff
+- **File Validation**: Safe file operations with permission checks
+- **Edge Case Security**: Robust handling of security edge cases
+- **Encrypted Backups**: AES-256 encrypted backup storage
+
+### 🎯 **NEW INTERACTIVE LOCALE OPTIMIZER** - up to 86% Package Size Reduction
+- **Package Size**: 830.4KB → 115.3KB (86% reduction for English only)
+- **Smart Management**: Interactive selection with automatic backups
+- **Zero Breaking Changes**: Safe restoration from backups
 
 ## 📋 Project Structure
 
@@ -159,7 +199,8 @@ your-project/
 
 - **Locale files are backed up automatically** before optimization
 - **Use interactive optimizer** for safe locale management
-- **Zero breaking changes** from v1.5.x to v1.6.0
+- **Zero breaking changes** from v1.6.x to v1.7.0
+- **All versions prior to 1.7.0 are deprecated**
 - **All improvements applied automatically** on update
 
 ## 📞 Support
@@ -171,4 +212,53 @@ your-project/
 
 ---
 
-**Made for the global development community** ❤️
+**Made for the global development community** ❤️
+
+## Migration Guide
+
+### Upgrading from Deprecated Versions
+
+#### From any version < 1.7.0 (DEPRECATED - use latest version)
+1. **Backup your current configuration**:
+   ```bash
+   cp -r ./.i18ntk ./.i18ntk-backup-$(date +%Y%m%d)
+   ```
+
+2. **Install the latest version**:
+   ```bash
+   npm install i18ntk@1.7.0
+   ```
+
+3. **Verify installation**:
+   ```bash
+   i18ntk --version
+   i18ntk doctor
+   ```
+
+3. **Run configuration migration**:
+   ```bash
+   npx i18ntk@1.6.3 --migrate
+   ```
+
+4. **Verify installation**:
+   ```bash
+   npx i18ntk@1.6.3--validate
+   ```
+
+#### Preserved Features from 1.6.3
+- ✅ Ultra-extreme performance improvements
+- ✅ Enhanced security with PIN protection
+- ✅ Comprehensive backup & recovery
+- ✅ Edge case handling
+- ✅ Memory optimization
+- ✅ Advanced configuration management
+
+#### Breaking Changes
+- **None** - 1.6.3 is fully backward compatible
+
+### Migration Support
+If you encounter issues during migration:
+1. Check the [troubleshooting guide](docs/TROUBLESHOOTING.md)
+2. Open an issue on [GitHub](https://github.com/vladnoskv/i18ntk/issues)
+3. Join our [Discord community](https://discord.gg/i18ntk)
+