djhtmx 1.0.0__tar.gz → 1.1.1__tar.gz

{djhtmx-1.0.0 → djhtmx-1.1.1}/CHANGELOG.md

@@ -7,16 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.1] - 2025-08-23
+
+- Remove `get_model_subscriptions` `Action` annotation as string literals, as this does not reflect model relationships
+
+## [1.1.0] - 2025-08-15
+
+### Changed
+- **BREAKING**: Refactored `get_model_subscriptions` to use explicit action parameters instead of auto-subscribing to all actions by default
+- Changed default behavior from implicit subscription to all actions to explicit opt-in only
+- Updated command queue to subscribe to both instance and model-level signals for better coverage
+
 ### Added
 - **Custom Context Support for Render Command**: The `Render` command now accepts an optional `context` parameter of type `dict[str, Any]`. When provided, this context will override the component's default context during template rendering, while preserving essential HTMX variables (`htmx_repo`, `hx_oob`, `this`). This enables more flexible template rendering scenarios where you need to pass custom data that differs from the component's state.
+- Added type annotation `Action = Literal["created", "updated", "deleted"]` for better type safety
+- Support for `None` in actions parameter to include bare prefix subscriptions
 
-### Changed
-- The `Render` dataclass now includes a `context: dict[str, Any] | None = None` field
+### Technical Details
+- The `Render` dataclass now includes a `context: dict[str, Any] | None = None` field  
 - The `Repository.render_html` method signature now includes an optional `context` parameter
 - Template rendering logic now supports context override while maintaining backwards compatibility
-
-### Technical Details
-- All changes are fully backwards compatible - existing code continues to work without modification
+- All custom context changes are fully backwards compatible - existing code continues to work without modification
 - When `context=None` (default), behavior is identical to previous versions
 - When `context` is provided, it takes precedence over component context but essential HTMX context variables are preserved
-- Comprehensive test coverage added for the new functionality
+- Comprehensive test coverage added for all new functionality
+
+### Migration Guide
+- If you were relying on `get_model_subscriptions()` to automatically subscribe to all actions, you now need to explicitly pass the actions you want: `get_model_subscriptions(instance, actions=["created", "updated", "deleted"])`

{djhtmx-1.0.0 → djhtmx-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djhtmx
-Version: 1.0.0
+Version: 1.1.1
 Summary: Interactive UI Components for Django using HTMX
 Project-URL: Homepage, https://github.com/edelvalle/djhtmx
 Project-URL: Documentation, https://github.com/edelvalle/djhtmx#readme
@@ -54,8 +54,19 @@ Interactive UI Components for Django using [htmx](https://htmx.org)
 
 ## Install
 
-Add `djhtmx` to your `INSTALLED_APPS` and install the Middleware as the last one
-of the list:
+```bash
+uv add djhtmx
+```
+
+or 
+
+```bash
+pip install djhtmx
+```
+
+# Configuration
+
+Add `djhtmx` to your `INSTALLED_APPS`.
 
 ```python
 INSTALLED_APPS = [
@@ -63,11 +74,33 @@ INSTALLED_APPS = [
     "djhtmx",
     ...
 ]
+```
 
+Install the Middleware as the last one  of the list 
+
+```python
 MIDDLEWARE = [
     ...,
     "djhtmx.middleware",
 ]
+```
+
+Add `djhtmx.context.component_repo` to the list of context processors:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                ...,
+                "djhtmx.context.component_repo",
+            ],
+        },
+    },
+]
 
 ```
 

{djhtmx-1.0.0 → djhtmx-1.1.1}/README.md

@@ -7,8 +7,19 @@ Interactive UI Components for Django using [htmx](https://htmx.org)
 
 ## Install
 
-Add `djhtmx` to your `INSTALLED_APPS` and install the Middleware as the last one
-of the list:
+```bash
+uv add djhtmx
+```
+
+or 
+
+```bash
+pip install djhtmx
+```
+
+# Configuration
+
+Add `djhtmx` to your `INSTALLED_APPS`.
 
 ```python
 INSTALLED_APPS = [
@@ -16,11 +27,33 @@ INSTALLED_APPS = [
     "djhtmx",
     ...
 ]
+```
 
+Install the Middleware as the last one  of the list 
+
+```python
 MIDDLEWARE = [
     ...,
     "djhtmx.middleware",
 ]
+```
+
+Add `djhtmx.context.component_repo` to the list of context processors:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                ...,
+                "djhtmx.context.component_repo",
+            ],
+        },
+    },
+]
 
 ```
 

{djhtmx-1.0.0 → djhtmx-1.1.1}/src/djhtmx/__init__.py

@@ -1,4 +1,4 @@
 from .middleware import middleware
 
-__version__ = "1.0.0"
+__version__ = "1.1.1"
 __all__ = ("middleware",)

{djhtmx-1.0.0 → djhtmx-1.1.1}/src/djhtmx/command_queue.py

@@ -48,7 +48,10 @@ class CommandQueue:
         else:
             action = "updated"
 
-        signals = get_model_subscriptions(instance, actions=(action,))
+        signals = get_model_subscriptions(
+            instance, actions=(action, None)
+        ) | get_model_subscriptions(type(instance), actions=(action, None))
+
         for field in get_related_fields(sender):
             fk_id = getattr(instance, field.name)
             signal = f"{field.related_model_name}.{fk_id}.{field.relation_name}"

{djhtmx-1.0.0 → djhtmx-1.1.1}/src/djhtmx/utils.py

@@ -65,7 +65,7 @@ def get_instance_subscriptions(
 
 def get_model_subscriptions(
     obj: type[models.Model] | models.Model,
-    actions: t.Sequence[str] = ("created", "updated", "deleted"),
+    actions: t.Sequence[str | None] = (),
 ) -> set[str]:
     """Get the subscriptions to actions of the model.
 
@@ -77,6 +77,7 @@ def get_model_subscriptions(
     possible relation (e.g 'users.deleted').
 
     """
+    actions = actions or (None,)
     if isinstance(obj, models.Model):
         cls = type(obj)
         instance = obj
@@ -85,10 +86,9 @@ def get_model_subscriptions(
         instance = None
     app = cls._meta.app_label
     name = cls._meta.model_name
-    result = {(model_prefix := f"{app}.{name}")}
-    if instance:
-        result.add(prefix := f"{model_prefix}.{instance.pk}")
-        result.update(f"{prefix}.{action}" for action in actions)
+    model_prefix = f"{app}.{name}"
+    prefix = f"{model_prefix}.{instance.pk}" if instance else model_prefix
+    result = {(f"{prefix}.{action}" if action else prefix) for action in actions}
     return result