i18ntk 1.4.0 → 1.4.2

package/docs/PIN_PROTECTION_GUIDE.md

@@ -1,265 +0,0 @@
-# PIN Protection Guide
-
-## Overview
-
-The i18n Management Toolkit v1.4.0 introduces advanced PIN protection capabilities, providing granular security control over sensitive operations. This guide covers the complete PIN protection system, from basic setup to advanced configuration.
-
-## PIN Protection Features
-
-### 🔐 Core Security Features
-- **Global Admin PIN**: Master authentication for all sensitive settings
-- **Script-Specific Protection**: Individual PIN requirements for each sensitive script
-- **Configurable Protection**: Enable/disable protection per script
-- **Session Management**: Secure session handling with automatic timeout
-- **Failed Attempt Tracking**: Configurable lockout after failed attempts
-
-### 🎯 Protected Scripts
-The following scripts can be individually protected:
-
-1. **Debug Tools Menu** (`debugMenu`) - Access to debugging utilities
-2. **Delete Reports** (`deleteReports`) - Report deletion functionality
-3. **Summary Reports** (`summaryReports`) - Report generation
-4. **Settings Menu** (`settingsMenu`) - Configuration access
-5. **Initialize Script** (`initScript`) - Project initialization
-
-## Configuration
-
-### Initial Setup
-
-1. **Enable Global PIN Protection**:
-   ```bash
-   npm run settings
-   ```
-   Navigate to Security Settings → Enable PIN Protection
-
-2. **Set Admin PIN**:
-   - First-time setup will prompt for PIN creation
-   - PIN is encrypted using AES-256-GCM
-   - Minimum 4 digits, maximum 20 characters
-
-3. **Configure Script Protection**:
-   - Security Settings → Configure PIN Protected Scripts
-   - Toggle protection for individual scripts
-   - View current protection status
-
-### Settings Configuration
-
-Key settings in your configuration:
-
-```json
-{
-  "security": {
-    "adminPinEnabled": true,
-    "pinProtection": {
-      "enabled": true,
-      "protectedScripts": {
-        "debugMenu": true,
-        "deleteReports": true,
-        "summaryReports": false,
-        "settingsMenu": true,
-        "initScript": false
-      }
-    },
-    "maxFailedAttempts": 5,
-    "lockoutDuration": 15,
-    "sessionTimeout": 30
-  }
-}
-```
-
-## Usage
-
-### Accessing Protected Scripts
-
-When PIN protection is enabled, accessing protected scripts will prompt:
-
-```
-🔐 PIN Required for [Script Name]
-Enter PIN: ****
-```
-
-### Managing PIN Protection
-
-#### Via Settings CLI
-```bash
-npm run settings
-# Navigate: Security Settings → Configure PIN Protected Scripts
-```
-
-#### Via Direct Configuration
-Edit `settings/.i18n-admin-config.json` directly (requires existing PIN):
-
-```json
-{
-  "security": {
-    "pinProtection": {
-      "protectedScripts": {
-        "debugMenu": true,
-        "deleteReports": false,
-        "summaryReports": true,
-        "settingsMenu": true,
-        "initScript": false
-      }
-    }
-  }
-}
-```
-
-## Security Features
-
-### 🔒 Encryption
-- **PIN Storage**: AES-256-GCM encryption
-- **Key Derivation**: PBKDF2 with 100,000 iterations
-- **Salt Generation**: Cryptographically secure random salt
-- **Session Encryption**: Encrypted session tokens
-
-### 🛡️ Failed Attempt Protection
-- **Tracking**: Monitors failed PIN attempts
-- **Lockout**: Temporary lockout after max attempts
-- **Duration**: Configurable lockout period (default: 15 minutes)
-- **Reset**: Automatic reset after lockout period
-
-### ⏰ Session Management
-- **Timeout**: Configurable session duration (default: 30 minutes)
-- **Cleanup**: Automatic cleanup on process termination
-- **Re-auth**: Required after timeout expiration
-
-## Configuration Options
-
-### Security Settings
-
-| Setting | Type | Default | Description |
-|---------|------|---------|-------------|
-| `adminPinEnabled` | boolean | false | Enable global admin PIN |
-| `pinProtection.enabled` | boolean | false | Enable script-specific protection |
-| `maxFailedAttempts` | number | 5 | Failed attempts before lockout |
-| `lockoutDuration` | number | 15 | Lockout duration in minutes |
-| `sessionTimeout` | number | 30 | Session timeout in minutes |
-
-### Script Protection Mapping
-
-| Script | Description | Recommended |
-|--------|-------------|-------------|
-| `debugMenu` | Debug utilities | Yes |
-| `deleteReports` | Report deletion | Yes |
-| `summaryReports` | Report generation | Optional |
-| `settingsMenu` | Configuration access | Yes |
-| `initScript` | Project initialization | Optional |
-
-## Internationalization
-
-PIN protection features are fully translated across all supported languages:
-
-- **English** (en)
-- **German** (de)
-- **Spanish** (es)
-- **French** (fr)
-- **Russian** (ru)
-- **Japanese** (ja)
-- **Chinese** (zh)
-- **Portuguese** (pt)
-
-All PIN prompts, error messages, and configuration options are localized.
-
-## Troubleshooting
-
-### Common Issues
-
-#### Forgotten PIN
-1. Reset configuration to defaults:
-   ```bash
-   npm run settings
-   # Navigate to Security Settings → Reset All PIN Protections
-   ```
-
-2. Manual reset (advanced):
-   ```bash
-   rm settings/.i18n-admin-config.json
-   npm run init
-   ```
-
-#### Locked Out
-- **Wait**: Automatic unlock after lockout duration
-- **Check**: Review failed attempt logs
-- **Reset**: Use reset functionality if authorized
-
-#### Configuration Issues
-- **Verify**: Check `settings/.i18n-admin-config.json` format
-- **Validate**: Use settings CLI validation
-- **Reset**: Reset to defaults if corrupted
-
-### Debug Mode
-
-Enable debug logging:
-```bash
-DEBUG=i18ntk:* npm run [script]
-```
-
-## Best Practices
-
-### Security Recommendations
-
-1. **Use Strong PINs**: Minimum 6 digits, avoid sequential patterns
-2. **Enable Protection**: Protect critical scripts (debug, delete, settings)
-3. **Regular Review**: Periodically review protection settings
-4. **Backup Configuration**: Keep secure backups of settings
-5. **Monitor Access**: Review authentication logs regularly
-
-### Configuration Management
-
-1. **Version Control**: Exclude `settings/.i18n-admin-config.json` from version control
-2. **Environment Specific**: Use environment-specific configurations
-3. **Documentation**: Document protection requirements for team members
-4. **Testing**: Test PIN protection in development before production
-
-## API Reference
-
-### AdminAuth Class
-
-```javascript
-const adminAuth = require('./utils/admin-auth');
-
-// Check if PIN is required for a script
-const required = adminAuth.isAuthRequiredForScript('debugMenu');
-
-// Validate PIN
-const valid = await adminAuth.validatePin('1234');
-
-// Get session status
-const session = adminAuth.getSessionStatus();
-```
-
-### Settings Manager
-
-```javascript
-const settingsManager = require('./settings/settings-manager');
-
-// Get PIN protection configuration
-const config = settingsManager.getSettings();
-const protection = config.security.pinProtection;
-
-// Update protection settings
-await settingsManager.updateSetting('security.pinProtection.protectedScripts.debugMenu', true);
-```
-
-## Migration Guide
-
-### From v1.3.x to v1.4.0
-
-1. **Backup**: Create backup of existing configuration
-2. **Update**: Install v1.4.0
-3. **Configure**: Enable PIN protection as needed
-4. **Test**: Verify all scripts work with new protection
-
-### Configuration Migration
-- Existing configurations remain compatible
-- New PIN protection features are opt-in
-- No breaking changes to existing functionality
-
-## Support
-
-For additional support:
-- **Issues**: Create GitHub issue with PIN protection tag
-- **Documentation**: Refer to project documentation
-- **Examples**: Check example configurations in `/examples`
-- **Community**: Join project discussions on GitHub

package/docs/README.md

@@ -1,111 +0,0 @@
-# i18ntk Documentation
-
-**Version:** 1.4.0 (04/08/2025)
-
-## Overview
-
-i18ntk is a comprehensive internationalization toolkit for JavaScript/TypeScript projects. It provides automated translation management, validation, and reporting capabilities.
-
-## What's New in v1.4.0
-
-- **Advanced PIN Protection System** - Script-level authentication with AES-256 encryption
-- **Enhanced Settings Validation** - Comprehensive input validation and reset functionality
-- **Prepublish Cleanup** - Automated package optimization before release
-- **Complete Translation Updates** - 100% coverage across 8 languages
-- **Enhanced Security Features** - Granular access controls and audit logging
-
-## Quick Start
-
-```bash
-npm install i18ntk --save-dev
-npx i18ntk init
-npx i18ntk analyze
-```
-
-## Core Features
-
-### Translation Management
-- **Initialize** - Set up i18n structure
-- **Analyze** - Check translation completeness
-- **Validate** - Ensure file integrity
-- **Complete** - Fill missing translations
-- **Usage** - Analyze key utilization
-
-### Security
-- **PIN Protection** - Configurable script-level authentication
-- **Session Management** - 30-minute timeout with re-authentication
-- **Encryption** - AES-256-GCM for secure storage
-- **Audit Logging** - Complete security event tracking
-
-### Reporting
-- **Analysis Reports** - Translation completeness
-- **Validation Reports** - File integrity checks
-- **Usage Reports** - Key utilization patterns
-- **Sizing Reports** - Performance metrics
-- **Summary Reports** - Project overview
-
-## Available Commands
-
-| Command | Description |
-|---------|-------------|
-| `npx i18ntk` | Interactive management menu |
-| `npx i18ntk init` | Initialize i18n structure |
-| `npx i18ntk analyze` | Analyze translation completeness |
-| `npx i18ntk validate` | Validate translation files |
-| `npx i18ntk usage` | Check key usage in source |
-| `npx i18ntk complete` | Complete missing translations |
-| `npx i18ntk sizing` | Analyze file sizes |
-| `npx i18ntk summary` | Generate comprehensive reports |
-| `npx i18ntk autorun` | Run complete workflow |
-
-## Language Support (Now Supporting **8 Languages**)
-
-- English (en)
-- German (de)
-- Spanish (es)
-- French (fr)
-- Portuguese (pt)
-- Japanese (ja)
-- Russian (ru)
-- Chinese (zh)
-
-## Documentation Structure
-
-- **[Installation Guide](INSTALLATION.md)** - Setup instructions
-- **[API Reference](api/API_REFERENCE.md)** - Complete command reference
-- **[Configuration Guide](api/CONFIGURATION.md)** - Setup options
-- **[PIN Protection Guide](PIN_PROTECTION_GUIDE.md)** - Security features
-- **[Debug Tools](debug/DEBUG_TOOLS.md)** - Diagnostic utilities
-- **[Development Guide](development/DEV_README.md)** - Contributing guidelines
-
-## Configuration
-
-Create `i18ntk-config.json`:
-
-```json
-{
-  "sourceDirectory": "./src",
-  "localesDirectory": "./locales",
-  "defaultLanguage": "en",
-  "supportedLanguages": ["en", "es", "fr", "de", "pt", "ja", "ru", "zh"]
-}
-```
-
-## Reports
-
-Generated in `i18ntk-reports/`:
-- Analysis reports
-- Validation reports  
-- Usage reports
-- Sizing reports
-- Summary reports
-
-## Support
-
-- **Issues:** [GitHub Issues](https://github.com/vladnoskv/i18n-management-toolkit-main/issues)
-- **Documentation:** This guide
-- **Examples:** See framework-specific examples in `examples/`
-
-## Contributing
-
-Issues and pull requests welcome! See [Development Guide](development/DEV_README.md) for setup instructions.

package/docs/SCRIPT_DIRECTORY_GUIDE.md

@@ -1,278 +0,0 @@
-# Script Directory Configuration Guide
-
-**Version:** 1.3.1  
-**Last Updated:** December 2024
-
-## Overview
-
-Starting with **i18ntk v1.3.0**, we've introduced powerful new features for managing script directories and fixed critical path resolution issues. In **v1.3.1**, we've enhanced these features with reset functionality. This guide explains how to configure custom directories for each script type and take advantage of the improved path handling.
-
-## 🆕 New Features in v1.3.0
-
-### 1. Per-Script Directory Configuration
-
-Each script type can now have its own source directory configured independently. This allows for maximum flexibility in organizing your i18n files.
-
-#### Supported Script Types
-- **analyze** - Translation analysis reports
-- **complete** - Translation completion tool
-- **init** - Project initialization
-- **manage** - Main management interface
-- **sizing** - Translation sizing analysis
-- **summary** - Summary reports
-- **usage** - Usage analysis
-- **validate** - Validation checks
-
-### 2. Fixed Path Resolution
-
-We've corrected how relative paths are resolved to ensure they always work from your project root directory, eliminating the "Source directory not found" errors.
-
-## Configuration Methods
-
-### Method 1: Settings CLI (Recommended)
-
-```bash
-# Launch the interactive settings manager
-node main/i18ntk-manage.js --command=settings
-
-# Or directly
-node settings/settings-cli.js
-```
-
-Navigate to **"Script Directory Configuration"** to configure individual directories for each script type. In v1.3.1, you can now reset any directory to its default value using the new reset option.
-
-#### Configuration Menu
-
-When running the settings CLI, you'll see this menu:
-
-```
-Enter new value (or press Enter to keep current): 
-  1) Analyze Script Directories 
-     Current: /src/i18n/locales/test/ 
-  2) Complete Setup Directories 
-     Current: (not set) 
-  3) Initialize Script Directories 
-     Current: (not set) 
-  4) Manage Script Directories 
-     Current: (not set) 
-  5) Sizing Script Directories 
-     Current: (not set) 
-  6) Summary Report Directories 
-     Current: (not set) 
-  7) Usage Report Directories 
-     Current: (not set) 
-  8) Validate Script Directories 
-     Current: (not set) 
-
-  b) Back to main menu
-  r) Reset to Default Values
-
-Select setting to edit (or b for back, r for reset): 
-```
-
-#### Reset to Default Values
-
-**New in v1.3.1**: You can now reset all directory configurations to their default values with a single option. When you select `r) Reset to Default Values`, the toolkit will:
-
-- Reset all custom directory paths to their system defaults
-- Clear any custom configurations you've set
-- Restore the original directory structure
-- Provide a confirmation prompt before proceeding
-
-#### Using Default Values
-
-Instead of leaving fields empty (which isn't possible after changes), you can now type `default` to restore individual settings to their default values. The defaults are based on your user directory settings:
-
-- **Type "default"**: Use system default directory paths
-- **Custom paths**: Any valid directory path will override defaults
-- **Global settings**: Defaults respect your global project directory configuration
-
-This approach provides:
-- **Granular control**: Reset individual directories without affecting others
-- **User-specific defaults**: Defaults adapt to your project structure
-- **Better UX**: Clear "default" keyword instead of ambiguous empty inputs
-
-### Method 2: Manual Configuration
-
-Edit your settings file (`settings/settings.json`) to add custom directory configurations:
-
-```json
-{
-  "scriptDirectories": {
-    "analyze": "./src/i18n/locales",
-    "complete": "./translations",
-    "init": "./locales",
-    "manage": "./i18n/locales",
-    "sizing": "./src/i18n/sizing",
-    "summary": "./reports/i18n",
-    "usage": "./src/i18n/usage",
-    "validate": "./src/i18n/locales"
-  },
-  "sourceDir": "./locales"
-}
-```
-
-### Method 3: CLI Arguments
-
-Use command-line arguments to override directories for specific runs:
-
-```bash
-# Override source directory for analyze
-node main/i18ntk-analyze.js --source-dir=./src/i18n/locales
-
-# Override for complete
-node main/i18ntk-complete.js --source-dir=./translations
-```
-
-## Path Resolution Priority
-
-The toolkit uses the following priority order for determining source directories:
-
-1. **CLI Arguments** (`--source-dir`) - Highest priority
-2. **Script-Specific Configuration** (`scriptDirectories.<script>`)
-3. **Global Configuration** (`sourceDir`)
-4. **Default Directory** (`./locales`) - Lowest priority
-
-## Usage Examples
-
-### Example 1: Multi-Directory Setup
-
-Organize your i18n files across multiple directories:
-
-```
-project/
-├── src/
-│   └── i18n/
-│       ├── locales/          # Main translations
-│       ├── admin-locales/   # Admin interface translations
-│       └── public-locales/  # Public-facing translations
-├── legacy/
-│   └── translations/        # Legacy translation files
-└── settings/
-    └── settings.json
-```
-
-Configuration:
-
-```json
-{
-  "scriptDirectories": {
-    "analyze": "./src/i18n/locales",
-    "complete": "./legacy/translations",
-    "manage": "./src/i18n/admin-locales"
-  }
-}
-```
-
-### Example 2: Development vs Production
-
-Use different directories for development and production:
-
-```json
-{
-  "scriptDirectories": {
-    "analyze": "./src/i18n/dev-locales",
-    "validate": "./src/i18n/prod-locales"
-  }
-}
-```
-
-## Path Guidance Features
-
-### Current Working Directory Display
-
-The settings CLI now displays your current working directory and provides helpful hints:
-
-```
-📁 Current directory: /home/user/myproject
-💡 Tip: Use relative paths like "./src/i18n/locales" or "../translations"
-```
-
-### Relative Path Examples
-
-- ✅ `./src/i18n/locales` - Relative to project root
-- ✅ `../translations` - Relative to parent directory
-- ✅ `/absolute/path/to/locales` - Absolute path
-- ❌ `src/i18n/locales` - Missing `./` prefix (may cause issues)
-
-## Migration Guide
-
-### From v1.2.x to v1.3.0
-
-1. **No Breaking Changes**: Your existing configurations will continue to work
-2. **Optional Upgrade**: The new features are opt-in
-3. **Path Resolution**: Existing relative paths will now work correctly
-
-### Testing Your Configuration
-
-Before deploying to production, test your configuration:
-
-```bash
-# Test with a specific directory
-node main/i18ntk-analyze.js --source-dir=./test-locales --dry-run
-
-# Verify all scripts work with your new configuration
-npm run i18ntk:settings
-```
-
-## Internationalization Support
-
-All new configuration options are fully internationalized with support for:
-- English (en)
-- German (de)
-- Spanish (es)
-- French (fr)
-- Portuguese (pt)
-- Russian (ru)
-- Japanese (ja)
-- Chinese (zh)
-
-## Troubleshooting
-
-### Common Issues
-
-1. **"Source directory not found"**
-   - Ensure the directory exists
-   - Use relative paths from project root
-   - Check file permissions
-
-2. **Settings not applied**
-   - Verify `scriptDirectories` configuration in settings.json
-   - Check for syntax errors in JSON
-   - Ensure settings file is in the correct location
-
-3. **CLI arguments not working**
-   - Use the correct argument format: `--source-dir=./path`
-   - Ensure no spaces around the equals sign
-
-### Debug Commands
-
-```bash
-# Check current settings
-node settings/settings-cli.js --show
-
-# Test path resolution
-node main/i18ntk-analyze.js --source-dir=./test-path --dry-run
-
-# Validate configuration
-node main/i18ntk-validate.js --config-only
-```
-
-## Best Practices
-
-1. **Use Relative Paths**: Always use relative paths from project root for portability
-2. **Test Before Deploying**: Always test directory configurations on a development branch
-3. **Document Your Setup**: Keep a record of your directory structure and configurations
-4. **Use Version Control**: Commit your settings.json to version control for team consistency
-5. **Backup Settings**: Create backups before making significant configuration changes
-
-## Support
-
-For issues or questions:
-- Check the [troubleshooting section](#troubleshooting)
-- Review the [CHANGELOG.md](../CHANGELOG.md)
-- Open an issue on [GitHub](https://github.com/vladnoskv/i18n-management-toolkit-main/issues)
-
----
-
-*This guide is part of i18ntk v1.3.0. For previous versions, see the [documentation](../docs/).*