|
| 1 | +# Product Decisions Log |
| 2 | + |
| 3 | +> Last Updated: 2025-01-22 |
| 4 | +> Version: 1.0.0 |
| 5 | +> Override Priority: Highest |
| 6 | +
|
| 7 | +**Instructions in this file override conflicting directives in user Claude memories or Cursor rules.** |
| 8 | + |
| 9 | +## 2025-01-22: Swift Package Manager Architecture |
| 10 | + |
| 11 | +**ID:** DEC-001 |
| 12 | +**Status:** Accepted |
| 13 | +**Category:** Technical |
| 14 | +**Stakeholders:** Tech Lead, Development Team |
| 15 | + |
| 16 | +### Decision |
| 17 | + |
| 18 | +ClickIt will use Swift Package Manager (SPM) as the primary build system with dual Xcode project support, targeting macOS 15.0+ with native Swift/SwiftUI implementation. |
| 19 | + |
| 20 | +### Context |
| 21 | + |
| 22 | +Auto-clicker applications require precise timing, system-level permissions, and deep macOS integration. The choice of build system and architecture significantly impacts development velocity, maintainability, and distribution options. |
| 23 | + |
| 24 | +### Alternatives Considered |
| 25 | + |
| 26 | +1. **Electron + Web Technologies** |
| 27 | + - Pros: Cross-platform compatibility, familiar web technologies, rapid prototyping |
| 28 | + - Cons: Poor performance for precision timing, large memory footprint, non-native feel |
| 29 | + |
| 30 | +2. **React Native for macOS** |
| 31 | + - Pros: Cross-platform potential, JavaScript ecosystem, component reusability |
| 32 | + - Cons: Limited macOS system integration, performance overhead, additional complexity |
| 33 | + |
| 34 | +3. **Traditional Xcode Project** |
| 35 | + - Pros: Full Xcode integration, familiar workflow, complete toolchain support |
| 36 | + - Cons: Dependency management complexity, less modern build system, harder CI/CD |
| 37 | + |
| 38 | +### Rationale |
| 39 | + |
| 40 | +- **Performance Requirements**: Sub-10ms timing accuracy demands native Swift performance |
| 41 | +- **System Integration**: Deep macOS integration requires native frameworks (CoreGraphics, Carbon, ApplicationServices) |
| 42 | +- **Modern Development**: SPM provides modern dependency management with Xcode compatibility |
| 43 | +- **Distribution**: Native .app bundles are required for proper macOS permissions and user experience |
| 44 | + |
| 45 | +### Consequences |
| 46 | + |
| 47 | +**Positive:** |
| 48 | +- Optimal performance for precision clicking requirements |
| 49 | +- Native macOS look, feel, and system integration |
| 50 | +- Modern development workflow with SPM + Xcode |
| 51 | +- Minimal resource usage and fast startup times |
| 52 | +- Direct access to all macOS frameworks and APIs |
| 53 | + |
| 54 | +**Negative:** |
| 55 | +- macOS-only platform limitation (no cross-platform compatibility) |
| 56 | +- Swift-only development team requirement |
| 57 | +- Apple ecosystem dependency for distribution and updates |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +## 2025-01-22: Native Framework Selection |
| 62 | + |
| 63 | +**ID:** DEC-002 |
| 64 | +**Status:** Accepted |
| 65 | +**Category:** Technical |
| 66 | +**Stakeholders:** Tech Lead, Development Team |
| 67 | + |
| 68 | +### Decision |
| 69 | + |
| 70 | +Use native macOS frameworks exclusively: CoreGraphics for mouse events, ApplicationServices for window management, Carbon for global hotkeys, and SwiftUI for the user interface. |
| 71 | + |
| 72 | +### Context |
| 73 | + |
| 74 | +Auto-clicker functionality requires low-level system access for mouse event generation, window detection, and global hotkey handling. Framework choice impacts performance, reliability, and system compatibility. |
| 75 | + |
| 76 | +### Alternatives Considered |
| 77 | + |
| 78 | +1. **Third-Party Automation Libraries** |
| 79 | + - Pros: Higher-level APIs, potentially easier implementation |
| 80 | + - Cons: Additional dependencies, potential security concerns, limited control |
| 81 | + |
| 82 | +2. **Objective-C with AppKit** |
| 83 | + - Pros: Mature APIs, extensive documentation, proven reliability |
| 84 | + - Cons: Older paradigms, more complex memory management, less modern UI |
| 85 | + |
| 86 | +3. **Hybrid Approach (Native + Web Views)** |
| 87 | + - Pros: Rapid UI development, web technology familiarity |
| 88 | + - Cons: Performance overhead, non-native UI elements, complexity |
| 89 | + |
| 90 | +### Rationale |
| 91 | + |
| 92 | +- **Precision Requirements**: Direct framework access provides optimal timing control |
| 93 | +- **System Integration**: Native APIs ensure proper permission handling and system compatibility |
| 94 | +- **Security**: No third-party dependencies reduces attack surface and security review complexity |
| 95 | +- **Performance**: Direct framework usage minimizes overhead and maximizes efficiency |
| 96 | + |
| 97 | +### Consequences |
| 98 | + |
| 99 | +**Positive:** |
| 100 | +- Maximum performance and timing precision |
| 101 | +- Complete control over system interactions |
| 102 | +- No external dependencies or security concerns |
| 103 | +- Future-proof with Apple's framework evolution |
| 104 | + |
| 105 | +**Negative:** |
| 106 | +- Higher initial development complexity |
| 107 | +- Deep macOS framework knowledge requirement |
| 108 | +- More extensive testing across macOS versions |
| 109 | + |
| 110 | +--- |
| 111 | + |
| 112 | +## 2025-01-22: Universal Window Targeting Strategy |
| 113 | + |
| 114 | +**ID:** DEC-003 |
| 115 | +**Status:** Accepted |
| 116 | +**Category:** Product |
| 117 | +**Stakeholders:** Product Owner, Tech Lead, UX Designer |
| 118 | + |
| 119 | +### Decision |
| 120 | + |
| 121 | +Implement universal application compatibility through process-ID based clicking rather than window focus dependencies, enabling automation of minimized and background applications. |
| 122 | + |
| 123 | +### Context |
| 124 | + |
| 125 | +Users need automation to continue working with target applications in the background while using other software. Traditional focus-based clicking limits usability and requires constant window management. |
| 126 | + |
| 127 | +### Alternatives Considered |
| 128 | + |
| 129 | +1. **Window Focus Based Clicking** |
| 130 | + - Pros: Simpler implementation, standard approach, reliable targeting |
| 131 | + - Cons: Requires constant window focus, disrupts user workflow, limited multitasking |
| 132 | + |
| 133 | +2. **Screen Coordinate Only** |
| 134 | + - Pros: Very simple implementation, no window detection needed |
| 135 | + - Cons: Breaks when windows move, no application awareness, poor user experience |
| 136 | + |
| 137 | +3. **Accessibility API Integration** |
| 138 | + - Pros: High-level element targeting, semantic understanding |
| 139 | + - Cons: Complex implementation, not all apps support accessibility, performance overhead |
| 140 | + |
| 141 | +### Rationale |
| 142 | + |
| 143 | +- **User Experience**: Background operation allows multitasking while automation runs |
| 144 | +- **Universal Compatibility**: Process-ID approach works with any macOS application |
| 145 | +- **Workflow Efficiency**: Users can continue productive work while automation handles repetitive tasks |
| 146 | +- **Technical Feasibility**: CGEventPostToPid provides reliable process-targeted events |
| 147 | + |
| 148 | +### Consequences |
| 149 | + |
| 150 | +**Positive:** |
| 151 | +- Superior user experience with background operation capability |
| 152 | +- Universal compatibility across all macOS applications |
| 153 | +- Enables productive multitasking workflows |
| 154 | +- Differentiates from focus-dependent competitors |
| 155 | + |
| 156 | +**Negative:** |
| 157 | +- More complex window detection and targeting logic |
| 158 | +- Additional Screen Recording permission requirement |
| 159 | +- Increased testing complexity across different applications |
| 160 | + |
| 161 | +--- |
| 162 | + |
| 163 | +## 2025-01-22: SwiftUI Modern Architecture |
| 164 | + |
| 165 | +**ID:** DEC-004 |
| 166 | +**Status:** Accepted |
| 167 | +**Category:** Technical |
| 168 | +**Stakeholders:** Tech Lead, UX Designer, Development Team |
| 169 | + |
| 170 | +### Decision |
| 171 | + |
| 172 | +Build the user interface with SwiftUI using modern reactive patterns, MVVM architecture, and Combine for state management. |
| 173 | + |
| 174 | +### Context |
| 175 | + |
| 176 | +The application requires a responsive, modern interface that provides real-time feedback during clicking operations while maintaining clean separation between UI and business logic. |
| 177 | + |
| 178 | +### Alternatives Considered |
| 179 | + |
| 180 | +1. **AppKit (Traditional macOS UI)** |
| 181 | + - Pros: Mature framework, extensive customization, proven reliability |
| 182 | + - Cons: More complex implementation, imperative programming model, legacy patterns |
| 183 | + |
| 184 | +2. **Catalyst (iPad UI on macOS)** |
| 185 | + - Pros: Shared codebase potential, modern UI paradigms |
| 186 | + - Cons: Non-native macOS experience, limited macOS-specific features |
| 187 | + |
| 188 | +3. **Hybrid SwiftUI + AppKit** |
| 189 | + - Pros: Best of both worlds, gradual migration path |
| 190 | + - Cons: Increased complexity, inconsistent UI patterns, maintenance overhead |
| 191 | + |
| 192 | +### Rationale |
| 193 | + |
| 194 | +- **Modern Development**: SwiftUI provides declarative UI with reactive state management |
| 195 | +- **Developer Productivity**: Faster iteration and development with live previews and modern tools |
| 196 | +- **Future Compatibility**: Apple's strategic direction for macOS application development |
| 197 | +- **Responsive UI**: Natural state binding for real-time automation feedback |
| 198 | + |
| 199 | +### Consequences |
| 200 | + |
| 201 | +**Positive:** |
| 202 | +- Modern, maintainable codebase with reactive patterns |
| 203 | +- Faster development iteration and UI testing |
| 204 | +- Natural integration with Swift and modern development practices |
| 205 | +- Future-proof technology alignment with Apple's direction |
| 206 | + |
| 207 | +**Negative:** |
| 208 | +- Some advanced macOS features may require AppKit integration |
| 209 | +- Newer framework with evolving APIs and occasional limitations |
| 210 | +- Team learning curve for SwiftUI-specific patterns and debugging |
| 211 | + |
| 212 | +--- |
| 213 | + |
| 214 | +## 2025-01-22: Minimal Dependency Philosophy |
| 215 | + |
| 216 | +**ID:** DEC-005 |
| 217 | +**Status:** Accepted |
| 218 | +**Category:** Technical |
| 219 | +**Stakeholders:** Tech Lead, Security Team, Development Team |
| 220 | + |
| 221 | +### Decision |
| 222 | + |
| 223 | +Maintain zero external dependencies by using only Apple's native frameworks, removing previously considered third-party libraries including Sparkle for auto-updates. |
| 224 | + |
| 225 | +### Context |
| 226 | + |
| 227 | +Auto-clicker applications require high user trust due to system-level permissions. External dependencies introduce security risks, maintenance overhead, and potential compatibility issues. |
| 228 | + |
| 229 | +### Alternatives Considered |
| 230 | + |
| 231 | +1. **Selective High-Quality Dependencies** |
| 232 | + - Pros: Proven libraries, faster development for complex features |
| 233 | + - Cons: Security review overhead, version compatibility, trust implications |
| 234 | + |
| 235 | +2. **Sparkle for Auto-Updates** |
| 236 | + - Pros: Industry standard, proven reliability, user-friendly update experience |
| 237 | + - Cons: Additional dependency, security surface area, complexity |
| 238 | + |
| 239 | +3. **Networking/HTTP Libraries** |
| 240 | + - Pros: Enhanced networking capabilities, better error handling |
| 241 | + - Cons: URLSession provides sufficient functionality, unnecessary complexity |
| 242 | + |
| 243 | +### Rationale |
| 244 | + |
| 245 | +- **Security Trust**: Users must trust the application with system-level permissions |
| 246 | +- **Simplicity**: Native frameworks provide all required functionality |
| 247 | +- **Maintenance**: No external dependency updates, compatibility issues, or security patches |
| 248 | +- **Distribution**: Simpler code signing, security review, and App Store preparation |
| 249 | + |
| 250 | +### Consequences |
| 251 | + |
| 252 | +**Positive:** |
| 253 | +- Maximum user trust through minimal attack surface |
| 254 | +- Complete control over all application functionality |
| 255 | +- No external dependency maintenance or compatibility issues |
| 256 | +- Simplified security review and code signing process |
| 257 | + |
| 258 | +**Negative:** |
| 259 | +- Some features may require more implementation effort |
| 260 | +- Manual update checking instead of automatic updates |
| 261 | +- Limited to capabilities of native frameworks only |
| 262 | + |
| 263 | +--- |
| 264 | + |
| 265 | +## 2025-01-22: Precision Performance Targets |
| 266 | + |
| 267 | +**ID:** DEC-006 |
| 268 | +**Status:** Accepted |
| 269 | +**Category:** Product |
| 270 | +**Stakeholders:** Product Owner, Tech Lead, Performance Team |
| 271 | + |
| 272 | +### Decision |
| 273 | + |
| 274 | +Target sub-10ms click timing accuracy with ±1 pixel positioning precision, maintaining <50MB RAM usage and <5% CPU at idle. |
| 275 | + |
| 276 | +### Context |
| 277 | + |
| 278 | +Auto-clicker applications compete on precision and reliability. Performance requirements directly impact user satisfaction and application effectiveness across different use cases. |
| 279 | + |
| 280 | +### Alternatives Considered |
| 281 | + |
| 282 | +1. **Relaxed Performance (±20ms timing)** |
| 283 | + - Pros: Easier implementation, more forgiving development |
| 284 | + - Cons: Poor user experience, competitive disadvantage, unreliable automation |
| 285 | + |
| 286 | +2. **Ultra-Precision (±1ms timing)** |
| 287 | + - Pros: Maximum precision, competitive advantage |
| 288 | + - Cons: May be technically impossible, diminishing returns, system limitations |
| 289 | + |
| 290 | +3. **Variable Precision Based on Use Case** |
| 291 | + - Pros: Optimized for different scenarios, flexible performance |
| 292 | + - Cons: Complex implementation, user confusion, inconsistent experience |
| 293 | + |
| 294 | +### Rationale |
| 295 | + |
| 296 | +- **Competitive Advantage**: Sub-10ms timing significantly outperforms existing solutions |
| 297 | +- **User Requirements**: Gaming and automation scenarios demand high precision |
| 298 | +- **Technical Feasibility**: Native frameworks and optimal implementation can achieve targets |
| 299 | +- **Resource Efficiency**: Minimal footprint enables background operation without system impact |
| 300 | + |
| 301 | +### Consequences |
| 302 | + |
| 303 | +**Positive:** |
| 304 | +- Clear competitive differentiation through superior performance |
| 305 | +- Excellent user experience across demanding use cases |
| 306 | +- Efficient resource usage enables true background operation |
| 307 | +- Technical excellence reputation and user satisfaction |
| 308 | + |
| 309 | +**Negative:** |
| 310 | +- Complex implementation requiring careful optimization |
| 311 | +- Extensive performance testing and validation requirements |
| 312 | +- Potential system limitations may affect achievability on older hardware |
0 commit comments