Changelog 🚧

Attribution

<!-- BEGIN INCLUDE ../../../CHANGELOG.md '&lt;!--attr-start--&gt;' '&lt;!--attr-end--&gt;' -->

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!-- END INCLUDE -->

Unreleased

• Nothing (yet)

2.2.0 - 2022-12-28

Added

• Add options: QueryOptions parameter to use_query to allow for configuration of this hook.

Changed

• By default, use_query will recursively prefetch all many-to-many or many-to-one relationships to prevent SynchronousOnlyOperation exceptions.

Removed

• django_idom.hooks._fetch_lazy_fields has been deleted. The equivalent replacement is django_idom.utils.django_query_postprocessor.

2.1.0 - 2022-11-01

Changed

• Minimum channels version is now 4.0.0.

Fixed

• Change type hint on view_to_component callable to have request argument be optional.
• Change type hint on view_to_component to represent it as a decorator with parenthesis (such as @view_to_component(compatibility=True))

Security

• Add note to docs about potential information exposure via view_to_component when using compatibility=True.

2.0.1 - 2022-10-18

Fixed

• Ability to use key=... parameter on all prefabricated components.

2.0.0 - 2022-10-17

Added

• use_origin hook for returning the browser's location.origin.

Changed

• view_to_component now returns a Callable, instead of directly returning a Component. Check the docs for new usage info.
• use_mutation and use_query will now log any query failures.

Fixed

• Allow use_mutation to have refetch=None, as the docs suggest is possible.
• use_query will now prefetch all fields to prevent SynchronousOnlyOperation exceptions.
• view_to_component, django_css, and django_js type hints will now display like normal functions.
• IDOM preloader no longer attempts to parse commented out IDOM components.
• Tests are now fully functional on Windows

1.2.0 - 2022-09-19

Added

• auth_required decorator to prevent your components from rendering to unauthenticated users.
• use_query hook for fetching database values.
• use_mutation hook for modifying database values.
• view_to_component utility to convert legacy Django views to IDOM components.

Changed

• Bumped the minimum IDOM version to 0.40.2
• Testing suite now uses playwright instead of selenium

Fixed

• IDOM preloader is no longer sensitive to whitespace within template tags.

1.1.0 - 2022-07-01

Added

• django_css and django_js components to defer loading CSS & JS files until needed.

Changed

• Bumped the minimum IDOM version to 0.39.0

1.0.0 - 2022-05-22

Added

• Django-specific hooks! use_websocket, use_scope, and use_location are now available within the django_idom.hooks module.
• Documentation has been placed into a formal docs webpage.
• Logging for when a component fails to import, or if no components were found within Django.

Changed

• idom_component template tag has been renamed to component
• Bumped the minimum IDOM version to 0.38.0

Removed

• websocket parameter for components has been removed. Functionally, it is replaced with django_idom.hooks.use_websocket.

0.0.5 - 2022-04-04

Changed

• Bumped the minimum IDOM version to 0.37.2

Fixed

• ModuleNotFoundError: No module named idom.core.proto caused by IDOM 0.37.2

0.0.4 - 2022-03-05

Changed

• Bumped the minimum IDOM version to 0.37.1

0.0.3 - 2022-02-19

Changed

• Bumped the minimum IDOM version to 0.36.3

0.0.2 - 2022-01-30

Added

• Ability to declare the HTML class of the top-level component div
• name = ... parameter to IDOM HTTP paths for use with django.urls.reverse()
• Cache versioning to automatically invalidate old web module files from the cache back-end
• Automatic pre-population of the IDOM component registry
• Type hinting for IdomWebsocket

Changed

• Fetching web modules from disk and/or cache is now fully async
• Static files are now contained within a django_idom/ parent folder
• Upgraded IDOM to version 0.36.0
• Minimum Django version required is now 4.0
• Minimum Python version required is now 3.8

Removed

• IDOM_WEB_MODULES_PATH has been replaced with Django include(...)
• IDOM_WS_MAX_RECONNECT_DELAY has been renamed to IDOM_WS_MAX_RECONNECT_TIMEOUT
• idom_web_modules cache back-end has been renamed to idom

Fixed

• Increase test timeout values to prevent false positives
• Windows compatibility for building Django-IDOM

Security

• Fixed potential directory traversal attack on the IDOM web modules URL

0.0.1 - 2021-08-18

Added

• Support for IDOM within the Django