simplepush 3.5.0__tar.gz → 3.6.1__tar.gz

{simplepush-3.5.0 → simplepush-3.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: simplepush
-Version: 3.5.0
+Version: 3.6.1
 Summary: Python client for Simplepush (tasks, notifications, events, end-to-end encryption).
 Project-URL: Homepage, https://simplepu.sh
 Project-URL: Documentation, https://simplepu.sh/guide/python-sdk

{simplepush-3.5.0 → simplepush-3.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "simplepush"
-version = "3.5.0"
+version = "3.6.1"
 description = "Python client for Simplepush (tasks, notifications, events, end-to-end encryption)."
 readme = "README.md"
 license = { file = "LICENSE" }

{simplepush-3.5.0 → simplepush-3.6.1}/src/simplepush/api.py

@@ -683,6 +683,7 @@ class _BaseClient:
         input: NotificationInput | None = None,
         image: "str | os.PathLike | None" = None,
         audio: "str | os.PathLike | None" = None,
+        link: str | None = None,
         password: str | None = None,
         tag: str | None = None,
         critical: bool = False,
@@ -725,6 +726,10 @@ class _BaseClient:
             audio: Optional single audio clip (URL or local path), like `image`.
                    Plays inline on iOS; Android has no inline audio. Mutually
                    exclusive with `image` (a notification shows at most one media).
+            link: Optional URL shown as an "Open link" button on the push. Any
+                  scheme: an https URL opens the browser, an app's deep link
+                  (`unifi-protect://...`) opens that app. Mutually exclusive
+                  with `input` (the input's buttons take the action slots).
             password: Optional password to encrypt body fields with. Requires a
                       topic (used as the salt for key derivation). Falls back to
                       the client's default `password` when omitted. Not accepted
@@ -750,7 +755,7 @@ class _BaseClient:
         return self._create_notification(
             topic=topic, member=member, broadcast=broadcast,
             title=title, content=content, input=input,
-            image=image, audio=audio,
+            image=image, audio=audio, link=link,
             password=password if password is not None else self._send_password(topic),
             tag=tag, critical=critical, shared=shared,
         )
@@ -966,7 +971,7 @@ class _BaseClient:
 
     def _create_notification(self, *, topic=None, member=None, broadcast=False,
                              title=None, content=None, input=None, image=None, audio=None,
-                             password=None, tag=None, critical=False,
+                             link=None, password=None, tag=None, critical=False,
                              shared=False) -> "Notification | NotificationGroup":
         if not content and input is None:
             raise ValueError("Either content or an input must be provided")
@@ -990,6 +995,8 @@ class _BaseClient:
             _validate_actions(input.actions)
         if image is not None and audio is not None:
             raise ValueError("a notification can carry at most one media attachment (image or audio, not both)")
+        if link is not None and input is not None:
+            raise ValueError("a notification carries either an input or a link, not both: the input's buttons take the action slots, so the link would never be shown")
 
         # A notification carries at most one input, sent as `textInput {}` XOR
         # `choiceInput {options}` XOR `actionInput {actions}`. For actions, both
@@ -1029,6 +1036,8 @@ class _BaseClient:
                 tag = encrypt(tag, dk.symmetric_key)
             if choice_options is not None:
                 choice_options = [encrypt(opt, dk.symmetric_key) for opt in choice_options]
+            if link is not None:
+                link = encrypt(link, dk.symmetric_key)
             if action_defs is not None:
                 # Key AND label, exactly like a task's ActionsInput: the key
                 # usually carries the same meaning as the label ("approve"), so
@@ -1053,6 +1062,8 @@ class _BaseClient:
                 tag = encrypt(tag, key)
             if choice_options is not None:
                 choice_options = [encrypt(opt, key) for opt in choice_options]
+            if link is not None:
+                link = encrypt(link, key)
             if action_defs is not None:
                 for a in action_defs:   # key AND label, as above
                     a["key"] = encrypt(a["key"], key)
@@ -1069,6 +1080,8 @@ class _BaseClient:
         }
         if media_dict is not None:
             payload["media"] = media_dict
+        if link is not None:
+            payload["link"] = link
         if topic is not None:
             payload["topic"] = topic
         if member is not None:

{simplepush-3.5.0 → simplepush-3.6.1}/src/simplepush/client.py

@@ -1471,7 +1471,7 @@ class Task:
     def append(self, *, title: str | None = None, content: str | None = None,
                inputs=None, links: list[str] | None = None,
                files: "list[str | os.PathLike] | None" = None,
-               auto_commit: bool = True, critical: bool = False,
+               auto_commit: bool = False, critical: bool = False,
                reply: "ReplyMode | Literal['one-shot', 'sticky', 'one-time-per-user'] | None" = None,
                content_format: "ContentFormat | Literal['plain', 'markdown'] | None" = None) -> "Subtask":
         """Append a subtask to this task's chain and return a `Subtask` handle.
@@ -1643,7 +1643,7 @@ class TaskGroup:
                inputs=None, links: "list[str] | None" = None,
                files: "list[str | os.PathLike] | None" = None,
                instances: "list[str | Task] | None" = None,
-               auto_commit: bool = True, critical: bool = False,
+               auto_commit: bool = False, critical: bool = False,
                reply: "ReplyMode | Literal['one-shot', 'sticky', 'one-time-per-user'] | None" = None,
                content_format: "ContentFormat | Literal['plain', 'markdown'] | None" = None) -> "list[Subtask]":
         """Append a subtask to every member instance's chain atomically — or