|
| 1 | +# Changelog |
| 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 | +<!-- |
| 9 | +Types of changes are to be listed in this order |
| 10 | + - "Added" for new features. |
| 11 | + - "Changed" for changes in existing functionality. |
| 12 | + - "Deprecated" for soon-to-be removed features. |
| 13 | + - "Removed" for now removed features. |
| 14 | + - "Fixed" for any bug fixes. |
| 15 | + - "Security" in case of vulnerabilities. |
| 16 | + --> |
| 17 | + |
| 18 | +## [Unreleased] |
| 19 | + |
| 20 | +### Added |
| 21 | + |
| 22 | +- Nothing (yet) |
| 23 | + |
| 24 | +## [0.0.2] - 2022-01-30 |
| 25 | + |
| 26 | +### Added |
| 27 | + |
| 28 | +- Ability to declare the HTML class of the top-level component `div` |
| 29 | +- `name = ...` parameter to IDOM HTTP paths for use with `django.urls.reverse()` |
| 30 | +- Cache versioning to automatically invalidate old web module files from the cache backend |
| 31 | +- Automatic pre-population of the IDOM component registry |
| 32 | +- Type hinting for `IdomWebsocket` |
| 33 | + |
| 34 | +### Changed |
| 35 | + |
| 36 | +- Fetching web modules from disk and/or cache is now fully async |
| 37 | +- Static files are now contained within a `django_idom/` parent folder |
| 38 | +- Upgraded IDOM to version `0.36.0` |
| 39 | +- Minimum Django version required is now `4.0` |
| 40 | +- Minimum Python version required is now `3.8` |
| 41 | + |
| 42 | +### Removed |
| 43 | + |
| 44 | +- `IDOM_WEB_MODULES_PATH` has been replaced with Django `include(...)` |
| 45 | +- `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` |
| 46 | +- `idom_web_modules` cache backend has been renamed to `idom` |
| 47 | + |
| 48 | +### Fixed |
| 49 | + |
| 50 | +- Increase test timeout values to prevent false positives |
| 51 | +- Windows compatibility for building Django-IDOM |
| 52 | + |
| 53 | +### Security |
| 54 | + |
| 55 | +- Fixed potential directory travesal attack on the IDOM web modules URL |
| 56 | + |
| 57 | +## [0.0.1] - 2021-08-18 |
| 58 | + |
| 59 | +### Added |
| 60 | + |
| 61 | +- Support for IDOM within the Django |
| 62 | + |
| 63 | +[unreleased]: https://github.com/idom-team/django-idom/compare/0.0.2...HEAD |
| 64 | +[0.0.2]: https://github.com/idom-team/django-idom/compare/0.0.1...0.0.2 |
| 65 | +[0.0.1]: https://github.com/idom-team/django-idom/releases/tag/0.0.1 |
0 commit comments