|
1 | 1 | # Changelog |
2 | 2 |
|
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +### Added |
| 11 | +- Comprehensive type specifications (`@type` and `@spec`) for all public functions |
| 12 | +- Enhanced module documentation with detailed examples and usage patterns |
| 13 | +- New `Phoenix.React.Config` module for centralized configuration management |
| 14 | +- Improved error handling and logging across all runtime implementations |
| 15 | +- Better type safety with strict typing for component names, props, and rendering methods |
| 16 | +- Enhanced file watcher documentation and configuration options |
| 17 | +- Production deployment guides and best practices |
| 18 | + |
| 19 | +### Changed |
| 20 | +- Completely rewritten README with comprehensive documentation and examples |
| 21 | +- Improved runtime module architecture with better separation of concerns |
| 22 | +- Enhanced cache module with proper type specifications and documentation |
| 23 | +- Better error messages and debugging information |
| 24 | +- Optimized configuration validation and defaults |
| 25 | + |
| 26 | +### Fixed |
| 27 | +- Type specification inconsistencies across modules |
| 28 | +- Documentation gaps in runtime implementations |
| 29 | +- Missing error handling in edge cases |
| 30 | + |
| 31 | +## [0.7.3] - 2024-XX-XX |
| 32 | + |
| 33 | +### Added |
| 34 | +- Support for Deno 2.x runtime |
| 35 | +- Enhanced security features for Deno runtime |
| 36 | +- File watching improvements with throttling |
| 37 | +- Better error reporting and logging |
| 38 | + |
| 39 | +### Changed |
| 40 | +- Improved performance for component rendering |
| 41 | +- Enhanced development experience with hot reloading |
| 42 | +- Better memory management and cleanup |
| 43 | + |
| 44 | +## [0.7.2] - 2024-XX-XX |
| 45 | + |
| 46 | +### Fixed |
| 47 | +- Runtime process cleanup issues |
| 48 | +- Memory leaks in long-running applications |
| 49 | +- Port handling in production environments |
| 50 | + |
| 51 | +### Changed |
| 52 | +- Updated dependencies for better compatibility |
| 53 | +- Improved error handling for network requests |
| 54 | + |
| 55 | +## [0.7.1] - 2024-XX-XX |
| 56 | + |
| 57 | +### Fixed |
| 58 | +- Component bundling issues in production |
| 59 | +- File watcher not detecting changes properly |
| 60 | +- Configuration validation errors |
| 61 | + |
| 62 | +### Changed |
| 63 | +- Better default configuration values |
| 64 | +- Improved documentation and examples |
| 65 | + |
| 66 | +## [0.7.0] - 2024-XX-XX |
| 67 | + |
| 68 | +### Added |
| 69 | +- Dual runtime support (Bun and Deno) |
| 70 | +- Enhanced caching system with TTL |
| 71 | +- File watching for development |
| 72 | +- Production bundling tools |
| 73 | +- LiveView integration examples |
| 74 | + |
| 75 | +### Changed |
| 76 | +- Complete rewrite of runtime architecture |
| 77 | +- Improved API design with better type safety |
| 78 | +- Enhanced error handling and logging |
| 79 | + |
| 80 | +### Breaking Changes |
| 81 | +- Updated configuration structure |
| 82 | +- Changed module names for better organization |
| 83 | +- Modified API for component rendering |
| 84 | + |
| 85 | +## [0.6.x] - Earlier Versions |
| 86 | + |
| 87 | +### Added |
| 88 | +- Initial React server-side rendering support |
| 89 | +- Basic component rendering functionality |
| 90 | +- Phoenix integration helpers |
| 91 | + |
| 92 | +### Known Issues |
| 93 | +- Limited runtime support |
| 94 | +- Basic error handling |
| 95 | +- No production optimization features |
| 96 | + |
| 97 | +--- |
| 98 | + |
| 99 | +## Migration Guide |
| 100 | + |
| 101 | +### From 0.6.x to 0.7.x |
| 102 | + |
| 103 | +1. **Update Configuration** |
| 104 | + ```elixir |
| 105 | + # Old configuration |
| 106 | + config :phoenix_react_server, :runtime, :bun |
| 107 | + |
| 108 | + # New configuration |
| 109 | + config :phoenix_react_server, Phoenix.React, |
| 110 | + runtime: Phoenix.React.Runtime.Bun |
| 111 | + ``` |
| 112 | + |
| 113 | +2. **Update Module Imports** |
| 114 | + ```elixir |
| 115 | + # Old |
| 116 | + import PhoenixReact.Helpers |
| 117 | + |
| 118 | + # New |
| 119 | + import Phoenix.React.Helper |
| 120 | + ``` |
| 121 | + |
| 122 | +3. **Update Component Usage** |
| 123 | + ```elixir |
| 124 | + # Old |
| 125 | + react_render("component", props) |
| 126 | + |
| 127 | + # New |
| 128 | + react_component(component: "component", props: props) |
| 129 | + ``` |
| 130 | + |
| 131 | +### From 0.7.2 to 0.7.3 |
| 132 | + |
| 133 | +No breaking changes. Simply update the dependency and enjoy enhanced documentation and type safety. |
| 134 | + |
| 135 | +--- |
| 136 | + |
| 137 | +## Development |
| 138 | + |
| 139 | +For information about contributing to this project, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file. |
| 140 | + |
| 141 | +For release procedures, see the [RELEASE.md](RELEASE.md) file. |
0 commit comments