feat(docs): Update README to reflect new modular architecture and expanded core utilities: add Project Architecture Overview, update export paths and API references, and mark plan tasks as completed

2025-05-09 22:11:56 +00:00
parent 5e97c088bf
commit 6b910587ab
9 changed files with 408 additions and 501 deletions
--- a/readme.plan.md
+++ b/readme.plan.md
@ -1,407 +1,255 @@
-# SmartProxy Project Restructuring Plan
+# SmartProxy Interface & Type Naming Standardization Plan

 ## Project Goal
-Reorganize the SmartProxy codebase to improve maintainability, readability, and developer experience through:
-1. Standardized naming conventions
-2. Consistent directory structure
-3. Modern TypeScript patterns
-4. Clear separation of concerns
-
-## Current Architecture Analysis
-
-Based on code analysis, SmartProxy has several well-defined but inconsistently named modules:
-
-1. **SmartProxy** - Primary TCP/SNI-based proxy with configurable routing
-2. **NetworkProxy** - HTTP/HTTPS reverse proxy with TLS termination
-3. **Port80Handler** - HTTP port 80 handling for ACME and redirects
-4. **NfTablesProxy** - Low-level port forwarding via nftables
-5. **Forwarding System** - New unified configuration for all forwarding types
-
-The codebase employs several strong design patterns:
- **Factory Pattern** for creating forwarding handlers
- **Strategy Pattern** for implementing different forwarding methods
- **Manager Pattern** for encapsulating domain, connection, and security logic
- **Event-Driven Architecture** for loose coupling between components
-
-## Target Directory Structure
-
-```
-/ts
-├── /core                     # Core functionality
-│   ├── /models               # Data models and interfaces
-│   ├── /utils                # Shared utilities (IP validation, logging, etc.)
-│   └── /events               # Common event definitions
-├── /certificate              # Certificate management
-│   ├── /acme                 # ACME-specific functionality
-│   ├── /providers            # Certificate providers (static, ACME)
-│   └── /storage              # Certificate storage mechanisms
-├── /forwarding               # Forwarding system
-│   ├── /handlers             # Various forwarding handlers
-│   │   ├── base-handler.ts   # Abstract base handler
-│   │   ├── http-handler.ts   # HTTP-only handler
-│   │   └── ...               # Other handlers
-│   ├── /config               # Configuration models
-│   │   ├── forwarding-types.ts     # Type definitions
-│   │   ├── domain-config.ts        # Domain config utilities
-│   │   └── domain-manager.ts       # Domain routing manager
-│   └── /factory              # Factory for creating handlers
-├── /proxies                  # Different proxy implementations
-│   ├── /smart-proxy          # SmartProxy implementation
-│   │   ├── /models           # SmartProxy-specific interfaces
-│   │   ├── smart-proxy.ts    # Main SmartProxy class
-│   │   └── ...               # Supporting classes
-│   ├── /network-proxy        # NetworkProxy implementation
-│   │   ├── /models           # NetworkProxy-specific interfaces
-│   │   ├── network-proxy.ts  # Main NetworkProxy class
-│   │   └── ...               # Supporting classes
-│   └── /nftables-proxy       # NfTablesProxy implementation
-├── /tls                      # TLS-specific functionality
-│   ├── /sni                  # SNI handling components
-│   └── /alerts               # TLS alerts system
-└── /http                     # HTTP-specific functionality
-    ├── /port80               # Port80Handler components
-    ├── /router               # HTTP routing system
-    └── /redirects            # Redirect handlers
-```
-
-## Implementation Plan
-
-### Phase 1: Project Setup & Core Structure (Week 1)
-
- [x] Create new directory structure
-  - [x] Create core subdirectories within `ts` directory
-  - [x] Set up barrel files (`index.ts`) in each directory
-
- [x] Migrate core utilities
-  - [x] Keep `ts/plugins.ts` in its current location per project requirements
-  - [x] Move `ts/common/types.ts` → `ts/core/models/common-types.ts`
-  - [x] Move `ts/common/eventUtils.ts` → `ts/core/utils/event-utils.ts`
-  - [x] Extract `ValidationUtils` → `ts/core/utils/validation-utils.ts`
-  - [x] Extract `IpUtils` → `ts/core/utils/ip-utils.ts`
-
- [x] Update build and test scripts
-  - [x] Modify `package.json` build script for new structure
-  - [x] Create parallel test structure
-
-### Phase 2: Forwarding System Migration (Weeks 1-2) ✅
-
-This component has the cleanest design, so we'll start migration here:
-
- [x] Migrate forwarding types and interfaces
-  - [x] Move `ts/smartproxy/types/forwarding.types.ts` → `ts/forwarding/config/forwarding-types.ts`
-  - [x] Normalize interface names (remove 'I' prefix where appropriate)
-
- [x] Migrate domain configuration
-  - [x] Move `ts/smartproxy/forwarding/domain-config.ts` → `ts/forwarding/config/domain-config.ts`
-  - [x] Move `ts/smartproxy/forwarding/domain-manager.ts` → `ts/forwarding/config/domain-manager.ts`
-
- [ ] Migrate handler implementations
-  - [x] Move base handler: `forwarding.handler.ts` → `ts/forwarding/handlers/base-handler.ts`
-  - [x] Move HTTP handler: `http.handler.ts` → `ts/forwarding/handlers/http-handler.ts`
-  - [x] Move passthrough handler: `https-passthrough.handler.ts` → `ts/forwarding/handlers/https-passthrough-handler.ts`
-  - [x] Move TLS termination handlers to respective files in `ts/forwarding/handlers/`
-    - [x] Move `https-terminate-to-http.handler.ts` → `ts/forwarding/handlers/https-terminate-to-http-handler.ts`
-    - [x] Move `https-terminate-to-https.handler.ts` → `ts/forwarding/handlers/https-terminate-to-https-handler.ts`
-  - [x] Move factory: `forwarding.factory.ts` → `ts/forwarding/factory/forwarding-factory.ts`
-
- [x] Create proper forwarding system exports
-  - [x] Update all imports in forwarding components using relative paths
-  - [x] Create comprehensive barrel file in `ts/forwarding/index.ts`
-  - [x] Test forwarding system in isolation
-
-### Phase 3: Certificate Management Migration (Week 2) ✅
-
- [x] Create certificate management structure
-  - [x] Create `ts/certificate/models/certificate-types.ts` for interfaces
-  - [x] Extract certificate events to `ts/certificate/events/certificate-events.ts`
-
- [x] Migrate certificate providers
-  - [x] Move `ts/smartproxy/classes.pp.certprovisioner.ts` → `ts/certificate/providers/cert-provisioner.ts`
-  - [x] Move `ts/common/acmeFactory.ts` → `ts/certificate/acme/acme-factory.ts`
-  - [x] Extract ACME challenge handling to `ts/certificate/acme/challenge-handler.ts`
-
- [x] Update certificate utilities
-  - [x] Move `ts/helpers.certificates.ts` → `ts/certificate/utils/certificate-helpers.ts`
-  - [x] Create certificate storage in `ts/certificate/storage/file-storage.ts`
-  - [x] Create proper exports in `ts/certificate/index.ts`
-
-### Phase 4: TLS & SNI Handling Migration (Week 2-3) ✅
-
- [x] Migrate TLS alert system
-  - [x] Move `ts/smartproxy/classes.pp.tlsalert.ts` → `ts/tls/alerts/tls-alert.ts`
-  - [x] Extract common TLS utilities to `ts/tls/utils/tls-utils.ts`
-
- [x] Migrate SNI handling
-  - [x] Move `ts/smartproxy/classes.pp.snihandler.ts` → `ts/tls/sni/sni-handler.ts`
-  - [x] Extract SNI extraction to `ts/tls/sni/sni-extraction.ts`
-  - [x] Extract ClientHello parsing to `ts/tls/sni/client-hello-parser.ts`
-
-### Phase 5: HTTP Component Migration (Week 3) ✅
-
- [x] Migrate Port80Handler
-  - [x] Move `ts/port80handler/classes.port80handler.ts` → `ts/http/port80/port80-handler.ts`
-  - [x] Extract ACME challenge handling to `ts/http/port80/challenge-responder.ts`
-  - [x] Create ACME interfaces in `ts/http/port80/acme-interfaces.ts`
-
- [x] Migrate redirect handlers
-  - [x] Move `ts/redirect/classes.redirect.ts` → `ts/http/redirects/redirect-handler.ts`
-  - [x] Create `ts/http/redirects/ssl-redirect.ts` for specialized redirects
-
- [x] Migrate router components
-  - [x] Move `ts/classes.router.ts` → `ts/http/router/proxy-router.ts`
-  - [x] Extract route matching to `ts/http/router/route-matcher.ts`
-
-### Phase 6: Proxy Implementation Migration (Weeks 3-4)
-
- [x] Migrate SmartProxy components
-  - [x] First, migrate interfaces to `ts/proxies/smart-proxy/models/`
-  - [x] Move core class: `ts/smartproxy/classes.smartproxy.ts` → `ts/proxies/smart-proxy/smart-proxy.ts`
-  - [x] Move supporting classes using consistent naming
-    - [x] Move ConnectionManager from classes.pp.connectionmanager.ts to connection-manager.ts
-    - [x] Move SecurityManager from classes.pp.securitymanager.ts to security-manager.ts
-    - [x] Move DomainConfigManager from classes.pp.domainconfigmanager.ts to domain-config-manager.ts
-    - [x] Move TimeoutManager from classes.pp.timeoutmanager.ts to timeout-manager.ts
-    - [x] Move TlsManager from classes.pp.tlsmanager.ts to tls-manager.ts
-    - [x] Move NetworkProxyBridge from classes.pp.networkproxybridge.ts to network-proxy-bridge.ts
-    - [x] Move PortRangeManager from classes.pp.portrangemanager.ts to port-range-manager.ts
-    - [x] Move ConnectionHandler from classes.pp.connectionhandler.ts to connection-handler.ts
-  - [x] Normalize interface names (SmartProxyOptions instead of IPortProxySettings)
-
- [x] Migrate NetworkProxy components
-  - [x] First, migrate interfaces to `ts/proxies/network-proxy/models/`
-  - [x] Move core class: `ts/networkproxy/classes.np.networkproxy.ts` → `ts/proxies/network-proxy/network-proxy.ts`
-  - [x] Move supporting classes using consistent naming
-
- [x] Migrate NfTablesProxy
-  - [x] Move `ts/nfttablesproxy/classes.nftablesproxy.ts` → `ts/proxies/nftables-proxy/nftables-proxy.ts`
-  - [x] Extract interfaces to `ts/proxies/nftables-proxy/models/interfaces.ts`
-  - [x] Extract error classes to `ts/proxies/nftables-proxy/models/errors.ts`
-  - [x] Create proper barrel files for module exports
-
-### Phase 7: Integration & Main Module (Week 4-5)
-
- [x] Create main entry points
-  - [x] Update `ts/index.ts` with all public exports
-  - [x] Ensure backward compatibility with type aliases
-  - [x] Implement proper namespace exports
-
- [x] Update module dependencies
-  - [x] Update relative import paths in all modules
-  - [x] Resolve circular dependencies if found
-  - [x] Test cross-module integration
-
-### Phase 8: Interface Normalization (Week 5)
-
- [x] Standardize interface naming
-  - [x] Rename `IPortProxySettings` → `SmartProxyOptions`
-  - [x] Rename `IDomainConfig` → `DomainConfig`
-  - [x] Rename `IConnectionRecord` → `ConnectionRecord`
-  - [x] Rename `INetworkProxyOptions` → `NetworkProxyOptions`
-  - [x] Rename other interfaces for consistency
-
- [x] Provide backward compatibility
-  - [x] Add type aliases for renamed interfaces
-  - [x] Ensure all exports are compatible with existing code
-
-### Phase 9: Testing & Validation (Weeks 5-6)
-
- [x] Update tests to work with new structure
-  - [x] Update test imports to use new module paths
-  - [x] Keep tests in the test/ directory per project guidelines
-  - [x] Fix type names and import paths
-  - [x] Ensure all tests pass with new structure
-
- [ ] Add test coverage for new components
-  - [ ] Create unit tests for extracted utilities
-  - [ ] Ensure integration tests cover all scenarios
-  - [ ] Validate backward compatibility
-
-### Phase 10: Documentation (Weeks 6-7)
-
- [ ] Update core documentation
-  - [ ] Update README.md with new structure and examples
-  - [ ] Create architecture diagram showing component relationships
-  - [ ] Document import patterns and best practices
-
- [ ] Integrate documentation sections into README.md
-  - [ ] Add architecture overview section
-  - [ ] Add forwarding system documentation section
-  - [ ] Add certificate management documentation section
-  - [ ] Add contributor guidelines section
-
- [ ] Update example files
-  - [ ] Update existing examples to use new structure
-  - [ ] Add new examples demonstrating key scenarios
-
-### Phase 11: Release & Migration Guide (Week 8)
-
- [ ] Prepare for release
-  - [ ] Final testing and validation
-  - [ ] Performance comparison with previous version
-  - [ ] Create detailed changelog
-
- [ ] Create migration guide
-  - [ ] Document breaking changes
-  - [ ] Provide upgrade instructions
-  - [ ] Include code examples for common scenarios
-
-## Detailed File Migration Table
-
-| Current File | New File | Status |
-|--------------|----------|--------|
-| **Core/Common Files** | | |
-| ts/common/types.ts | ts/core/models/common-types.ts | ✅ |
-| ts/common/eventUtils.ts | ts/core/utils/event-utils.ts | ✅ |
-| ts/common/acmeFactory.ts | ts/certificate/acme/acme-factory.ts | ❌ |
-| ts/plugins.ts | ts/plugins.ts (stays in original location) | ✅ |
-| ts/00_commitinfo_data.ts | ts/00_commitinfo_data.ts (stays in original location) | ✅ |
-| (new) | ts/core/utils/validation-utils.ts | ✅ |
-| (new) | ts/core/utils/ip-utils.ts | ✅ |
-| **Certificate Management** | | |
-| ts/helpers.certificates.ts | ts/certificate/utils/certificate-helpers.ts | ✅ |
-| ts/smartproxy/classes.pp.certprovisioner.ts | ts/certificate/providers/cert-provisioner.ts | ✅ |
-| ts/common/acmeFactory.ts | ts/certificate/acme/acme-factory.ts | ✅ |
-| (new) | ts/certificate/acme/challenge-handler.ts | ✅ |
-| (new) | ts/certificate/models/certificate-types.ts | ✅ |
-| (new) | ts/certificate/events/certificate-events.ts | ✅ |
-| (new) | ts/certificate/storage/file-storage.ts | ✅ |
-| **TLS and SNI Handling** | | |
-| ts/smartproxy/classes.pp.tlsalert.ts | ts/tls/alerts/tls-alert.ts | ✅ |
-| ts/smartproxy/classes.pp.snihandler.ts | ts/tls/sni/sni-handler.ts | ✅ |
-| (new) | ts/tls/utils/tls-utils.ts | ✅ |
-| (new) | ts/tls/sni/sni-extraction.ts | ✅ |
-| (new) | ts/tls/sni/client-hello-parser.ts | ✅ |
-| **HTTP Components** | | |
-| ts/port80handler/classes.port80handler.ts | ts/http/port80/port80-handler.ts | ✅ |
-| (new) | ts/http/port80/acme-interfaces.ts | ✅ |
-| ts/redirect/classes.redirect.ts | ts/http/redirects/redirect-handler.ts | ✅ |
-| ts/classes.router.ts | ts/http/router/proxy-router.ts | ✅ |
-| **SmartProxy Components** | | |
-| ts/smartproxy/classes.smartproxy.ts | ts/proxies/smart-proxy/smart-proxy.ts | ✅ |
-| ts/smartproxy/classes.pp.interfaces.ts | ts/proxies/smart-proxy/models/interfaces.ts | ✅ |
-| ts/smartproxy/classes.pp.connectionhandler.ts | ts/proxies/smart-proxy/connection-handler.ts | ✅ |
-| ts/smartproxy/classes.pp.connectionmanager.ts | ts/proxies/smart-proxy/connection-manager.ts | ✅ |
-| ts/smartproxy/classes.pp.domainconfigmanager.ts | ts/proxies/smart-proxy/domain-config-manager.ts | ✅ |
-| ts/smartproxy/classes.pp.portrangemanager.ts | ts/proxies/smart-proxy/port-range-manager.ts | ✅ |
-| ts/smartproxy/classes.pp.securitymanager.ts | ts/proxies/smart-proxy/security-manager.ts | ✅ |
-| ts/smartproxy/classes.pp.timeoutmanager.ts | ts/proxies/smart-proxy/timeout-manager.ts | ✅ |
-| ts/smartproxy/classes.pp.networkproxybridge.ts | ts/proxies/smart-proxy/network-proxy-bridge.ts | ✅ |
-| ts/smartproxy/classes.pp.tlsmanager.ts | ts/proxies/smart-proxy/tls-manager.ts | ✅ |
-| (new) | ts/proxies/smart-proxy/models/index.ts | ✅ |
-| (new) | ts/proxies/smart-proxy/index.ts | ✅ |
-| **NetworkProxy Components** | | |
-| ts/networkproxy/classes.np.networkproxy.ts | ts/proxies/network-proxy/network-proxy.ts | ✅ |
-| ts/networkproxy/classes.np.certificatemanager.ts | ts/proxies/network-proxy/certificate-manager.ts | ✅ |
-| ts/networkproxy/classes.np.connectionpool.ts | ts/proxies/network-proxy/connection-pool.ts | ✅ |
-| ts/networkproxy/classes.np.requesthandler.ts | ts/proxies/network-proxy/request-handler.ts | ✅ |
-| ts/networkproxy/classes.np.websockethandler.ts | ts/proxies/network-proxy/websocket-handler.ts | ✅ |
-| ts/networkproxy/classes.np.types.ts | ts/proxies/network-proxy/models/types.ts | ✅ |
-| (new) | ts/proxies/network-proxy/models/index.ts | ✅ |
-| (new) | ts/proxies/network-proxy/index.ts | ✅ |
-| **NFTablesProxy Components** | | |
-| ts/nfttablesproxy/classes.nftablesproxy.ts | ts/proxies/nftables-proxy/nftables-proxy.ts | ✅ |
-| (new) | ts/proxies/nftables-proxy/index.ts | ✅ |
-| (new) | ts/proxies/index.ts | ✅ |
-| **Forwarding System** | | |
-| ts/smartproxy/types/forwarding.types.ts | ts/forwarding/config/forwarding-types.ts | ✅ |
-| ts/smartproxy/forwarding/domain-config.ts | ts/forwarding/config/domain-config.ts | ✅ |
-| ts/smartproxy/forwarding/domain-manager.ts | ts/forwarding/config/domain-manager.ts | ✅ |
-| ts/smartproxy/forwarding/forwarding.handler.ts | ts/forwarding/handlers/base-handler.ts | ✅ |
-| ts/smartproxy/forwarding/http.handler.ts | ts/forwarding/handlers/http-handler.ts | ✅ |
-| ts/smartproxy/forwarding/https-passthrough.handler.ts | ts/forwarding/handlers/https-passthrough-handler.ts | ✅ |
-| ts/smartproxy/forwarding/https-terminate-to-http.handler.ts | ts/forwarding/handlers/https-terminate-to-http-handler.ts | ✅ |
-| ts/smartproxy/forwarding/https-terminate-to-https.handler.ts | ts/forwarding/handlers/https-terminate-to-https-handler.ts | ✅ |
-| ts/smartproxy/forwarding/forwarding.factory.ts | ts/forwarding/factory/forwarding-factory.ts | ✅ |
-| ts/smartproxy/forwarding/index.ts | ts/forwarding/index.ts | ✅ |
-| **Examples and Entry Points** | | |
-| ts/examples/forwarding-example.ts | ts/examples/forwarding-example.ts | ❌ |
-| ts/index.ts | ts/index.ts (updated) | ✅ |
-| **Tests** | | |
-| test/test.smartproxy.ts | (updated imports) | ✅ |
-| test/test.networkproxy.ts | (updated imports) | ✅ |
-| test/test.forwarding.ts | (updated imports) | ✅ |
-| test/test.forwarding.unit.ts | (updated imports) | ✅ |
-| test/test.forwarding.examples.ts | (updated imports) | ✅ |
-| test/test.router.ts | (updated imports) | ✅ |
-| test/test.certprovisioner.unit.ts | (updated imports) | ✅ |
-
-## Import Strategy
-
-Since path aliases will not be used, we'll maintain standard relative imports throughout the codebase:
-
-1. **Import Strategy for Deeply Nested Files**
-   ```typescript
-   // Example: Importing from another component in a nested directory
-   // From ts/forwarding/handlers/http-handler.ts to ts/core/utils/validation-utils.ts
-   import { validateConfig } from '../../../core/utils/validation-utils.js';
-   ```
-
-2. **Barrel Files for Convenience**
-   ```typescript
-   // ts/forwarding/index.ts
-   export * from './config/forwarding-types.js';
-   export * from './handlers/base-handler.js';
-   // ... other exports
-
-   // Then in consuming code:
-   import { ForwardingHandler, httpOnly } from '../../forwarding/index.js';
-   ```
-
-3. **Flattened Imports Where Sensible**
-   ```typescript
-   // Avoid excessive nesting with targeted exports
-   // ts/index.ts will export key components for external use
-   import { SmartProxy, NetworkProxy } from '../index.js';
-   ```
-
-## Expected Outcomes
-
-### Improved Code Organization
- Related code will be grouped together in domain-specific directories
- Consistent naming conventions will make code navigation intuitive
- Clear module boundaries will prevent unintended dependencies
-
-### Enhanced Developer Experience
- Standardized interface naming will improve type clarity
- Better documentation will help new contributors get started
- Clear and predictable file locations
-
-### Maintainability Benefits
- Smaller, focused files with clear responsibilities
- Unified patterns for common operations
- Improved separation of concerns between components
- Better test organization matching source structure
-
-### Performance and Compatibility
- No performance regression from structural changes
- Backward compatibility through type aliases and consistent exports
- Clear migration path for dependent projects
-
-## Migration Strategy
-
-To ensure a smooth transition, we'll follow this approach for each component:
-
-1. Create the new file structure first
-2. Migrate code while updating relative imports
-3. Test each component as it's migrated
-4. Only remove old files once all dependencies are updated
-5. Use a phased approach to allow parallel work
-
-This approach ensures the codebase remains functional throughout the restructuring process while progressively adopting the new organization.
-
-## Measuring Success
-
-We'll measure the success of this restructuring by:
-
-1. Reduced complexity in the directory structure
-2. Improved code coverage through better test organization
-3. Faster onboarding time for new developers
-4. Less time spent navigating the codebase
-5. Cleaner git blame output showing cohesive component changes
-
-## Special Considerations
-
- We'll maintain backward compatibility for all public APIs
- We'll provide detailed upgrade guides for any breaking changes
- We'll ensure the build process produces compatible output
- We'll preserve commit history using git move operations where possible
+Standardize interface and type naming throughout the SmartProxy codebase to improve maintainability, readability, and developer experience by:
+1. Ensuring all interfaces are prefixed with "I"
+2. Ensuring all type aliases are prefixed with "T"
+3. Maintaining backward compatibility through type aliases
+4. Updating documentation to reflect naming conventions
+
+## Phase 2: Core Module Standardization
+
+- [ ] Update core module interfaces and types
+  - [ ] Rename interfaces in `ts/core/models/common-types.ts`
+    - [ ] `AcmeOptions` → `IAcmeOptions`
+    - [ ] `DomainOptions` → `IDomainOptions`
+    - [ ] Other common interfaces
+  - [ ] Add backward compatibility aliases
+  - [ ] Update imports throughout core module
+
+- [ ] Update core utility type definitions
+  - [ ] Update `ts/core/utils/validation-utils.ts`
+  - [ ] Update `ts/core/utils/ip-utils.ts`
+  - [ ] Standardize event type definitions
+
+- [ ] Test core module changes
+  - [ ] Run unit tests for core modules
+  - [ ] Verify type compatibility
+  - [ ] Ensure backward compatibility
+
+## Phase 3: Certificate Module Standardization
+
+- [ ] Update certificate interfaces
+  - [ ] Rename interfaces in `ts/certificate/models/certificate-types.ts`
+    - [ ] `CertificateData` → `ICertificateData`
+    - [ ] `Certificates` → `ICertificates`
+    - [ ] `CertificateFailure` → `ICertificateFailure`
+    - [ ] `CertificateExpiring` → `ICertificateExpiring`
+    - [ ] `ForwardConfig` → `IForwardConfig`
+    - [ ] `DomainForwardConfig` → `IDomainForwardConfig`
+  - [ ] Update ACME challenge interfaces
+  - [ ] Standardize storage provider interfaces
+
+- [ ] Ensure certificate provider compatibility
+  - [ ] Update provider implementations
+  - [ ] Rename internal interfaces
+  - [ ] Maintain public API compatibility
+
+- [ ] Test certificate module
+  - [ ] Verify ACME functionality
+  - [ ] Test certificate provisioning
+  - [ ] Validate challenge handling
+
+## Phase 4: Forwarding System Standardization
+
+- [ ] Update forwarding configuration interfaces
+  - [ ] Rename interfaces in `ts/forwarding/config/forwarding-types.ts`
+    - [ ] `TargetConfig` → `ITargetConfig`
+    - [ ] `HttpOptions` → `IHttpOptions`
+    - [ ] `HttpsOptions` → `IHttpsOptions`
+    - [ ] `AcmeForwardingOptions` → `IAcmeForwardingOptions`
+    - [ ] `SecurityOptions` → `ISecurityOptions`
+    - [ ] `AdvancedOptions` → `IAdvancedOptions`
+    - [ ] `ForwardConfig` → `IForwardConfig`
+  - [ ] Rename type definitions
+    - [ ] `ForwardingType` → `TForwardingType`
+  - [ ] Update domain configuration interfaces
+
+- [ ] Standardize handler interfaces
+  - [ ] Update base handler interfaces
+  - [ ] Rename handler-specific interfaces
+  - [ ] Update factory interfaces
+
+- [ ] Verify forwarding system functionality
+  - [ ] Test all forwarding types
+  - [ ] Verify configuration parsing
+  - [ ] Ensure backward compatibility
+
+## Phase 5: Proxy Implementation Standardization
+
+- [ ] Update SmartProxy interfaces
+  - [ ] Rename interfaces in `ts/proxies/smart-proxy/models/interfaces.ts`
+  - [ ] Update domain configuration interfaces
+  - [ ] Standardize manager interfaces
+
+- [ ] Update NetworkProxy interfaces
+  - [ ] Rename in `ts/proxies/network-proxy/models/types.ts`
+    - [ ] `NetworkProxyOptions` → `INetworkProxyOptions`
+    - [ ] `CertificateEntry` → `ICertificateEntry`
+    - [ ] `ReverseProxyConfig` → `IReverseProxyConfig`
+    - [ ] `ConnectionEntry` → `IConnectionEntry`
+    - [ ] `WebSocketWithHeartbeat` → `IWebSocketWithHeartbeat`
+    - [ ] `Logger` → `ILogger`
+  - [ ] Update request handler interfaces
+  - [ ] Standardize connection interfaces
+
+- [ ] Update NfTablesProxy interfaces
+  - [ ] Rename interfaces in `ts/proxies/nftables-proxy/models/interfaces.ts`
+  - [ ] Update configuration interfaces
+  - [ ] Standardize firewall rule interfaces
+
+- [ ] Test proxy implementations
+  - [ ] Verify SmartProxy functionality
+  - [ ] Test NetworkProxy with renamed interfaces
+  - [ ] Validate NfTablesProxy operations
+
+## Phase 6: HTTP & TLS Module Standardization
+
+- [ ] Update HTTP interfaces
+  - [ ] Rename in `ts/http/port80/acme-interfaces.ts`
+    - [ ] `SmartAcmeCert` → `ISmartAcmeCert`
+    - [ ] `SmartAcmeOptions` → `ISmartAcmeOptions`
+    - [ ] `Http01Challenge` → `IHttp01Challenge`
+    - [ ] `SmartAcme` → `ISmartAcme`
+  - [ ] Standardize router interfaces
+  - [ ] Update port80 handler interfaces
+  - [ ] Update redirect interfaces
+
+- [ ] Update TLS/SNI interfaces
+  - [ ] Standardize SNI handler interfaces
+  - [ ] Update client hello parser types
+  - [ ] Rename TLS alert interfaces
+
+- [ ] Test HTTP & TLS functionality
+  - [ ] Verify router operation
+  - [ ] Test SNI extraction
+  - [ ] Validate redirect functionality
+
+## Phase 7: Backward Compatibility Layer
+
+- [ ] Implement comprehensive type aliases
+  - [ ] Create aliases for all renamed interfaces
+  - [ ] Add deprecation notices via JSDoc
+  - [ ] Ensure all exports include both named versions
+
+- [ ] Update main entry point
+  - [ ] Update `ts/index.ts` with all exports
+  - [ ] Include both prefixed and non-prefixed names
+  - [ ] Organize exports by module
+
+- [ ] Add compatibility documentation
+  - [ ] Document renaming strategy
+  - [ ] Provide migration examples
+  - [ ] Create deprecation timeline
+
+## Phase 8: Documentation & Examples
+
+- [ ] Update README and API documentation
+  - [ ] Update interface references in README.md
+  - [ ] Document naming convention in README.md
+  - [ ] Update API reference documentation
+
+- [ ] Update examples
+  - [ ] Modify example code to use new interface names
+  - [ ] Add compatibility notes
+  - [ ] Create migration examples
+
+- [ ] Add contributor guidelines
+  - [ ] Document naming conventions
+  - [ ] Add interface/type style guide
+  - [ ] Update PR templates
+
+## Phase 9: Testing & Validation
+
+- [ ] Run comprehensive test suite
+  - [ ] Run all unit tests
+  - [ ] Execute integration tests
+  - [ ] Verify example code
+
+- [ ] Build type declarations
+  - [ ] Generate TypeScript declaration files
+  - [ ] Verify exported types
+  - [ ] Validate documentation generation
+
+- [ ] Final compatibility check
+  - [ ] Verify import compatibility
+  - [ ] Test with existing dependent projects
+  - [ ] Validate backward compatibility claims
+
+## Implementation Strategy
+
+### Naming Pattern Rules
+
+1. **Interfaces**:
+   - All interfaces should be prefixed with "I"
+   - Example: `DomainConfig` → `IDomainConfig`
+
+2. **Type Aliases**:
+   - All type aliases should be prefixed with "T"
+   - Example: `ForwardingType` → `TForwardingType`
+
+3. **Enums**:
+   - Enums should be named in PascalCase without prefix
+   - Example: `CertificateSource`
+
+4. **Backward Compatibility**:
+   - No Backward compatibility. Remove old names.
+
+### Module Implementation Order
+
+1. Core module
+2. Certificate module
+3. Forwarding module
+4. Proxy implementations
+5. HTTP & TLS modules
+6. Main exports and entry points
+
+### Testing Strategy
+
+For each module:
+1. Rename interfaces and types
+2. Add backward compatibility aliases
+3. Update imports throughout the module
+4. Run tests to verify functionality
+5. Commit changes module by module
+
+## File-Specific Changes
+
+### Core Module Files
+- `ts/core/models/common-types.ts` - Primary interfaces
+- `ts/core/utils/validation-utils.ts` - Validation type definitions
+- `ts/core/utils/ip-utils.ts` - IP utility type definitions
+- `ts/core/utils/event-utils.ts` - Event type definitions 
+
+### Certificate Module Files
+- `ts/certificate/models/certificate-types.ts` - Certificate interfaces
+- `ts/certificate/acme/acme-factory.ts` - ACME factory types
+- `ts/certificate/providers/cert-provisioner.ts` - Provider interfaces
+- `ts/certificate/storage/file-storage.ts` - Storage interfaces
+
+### Forwarding Module Files
+- `ts/forwarding/config/forwarding-types.ts` - Forwarding interfaces and types
+- `ts/forwarding/config/domain-config.ts` - Domain configuration
+- `ts/forwarding/factory/forwarding-factory.ts` - Factory interfaces
+- `ts/forwarding/handlers/*.ts` - Handler interfaces
+
+### Proxy Module Files
+- `ts/proxies/network-proxy/models/types.ts` - NetworkProxy interfaces
+- `ts/proxies/smart-proxy/models/interfaces.ts` - SmartProxy interfaces
+- `ts/proxies/nftables-proxy/models/interfaces.ts` - NfTables interfaces
+- `ts/proxies/smart-proxy/connection-manager.ts` - Connection types
+
+### HTTP/TLS Module Files
+- `ts/http/models/http-types.ts` - HTTP module interfaces
+- `ts/http/port80/acme-interfaces.ts` - ACME interfaces
+- `ts/tls/sni/client-hello-parser.ts` - TLS parser types
+- `ts/tls/alerts/tls-alert.ts` - TLS alert interfaces
+
+## Success Criteria
+
+- All interfaces are prefixed with "I"
+- All type aliases are prefixed with "T"
+- All tests pass with new naming conventions
+- Documentation is updated with new naming conventions
+- Backward compatibility is maintained through type aliases
+- Declaration files correctly export both naming conventions