feat: chore and reward library (#1118)

Author: tempus2016

custom_components/taskmate/coord_rewards.py

@@ -9,7 +9,7 @@
 from homeassistant.util import dt as dt_util
 
 from .coord_rejections import clean_reject_reason
-from .models import Child, PointsTransaction, PoolAllocation, Reward, RewardClaim
+from .models import Child, PointsTransaction, PoolAllocation, Reward, RewardClaim, clean_template_id
 from .timewindow import has_window, is_within_window
 
 if TYPE_CHECKING:
@@ -100,8 +100,12 @@ async def async_add_reward(
         quantity: int | None = None,
         expires_at: str | None = None,
         refresh: bool = True,
+        template_id: str = "",
     ) -> Reward:
-        """Add a new reward. ``refresh=False`` defers the refresh to a batch."""
+        """Add a new reward. ``refresh=False`` defers the refresh to a batch.
+
+        ``template_id`` names the 📚 library entry it came from, if any.
+        """
         reward = Reward(
             name=name,
             cost=cost,
@@ -112,6 +116,7 @@ async def async_add_reward(
             pool_enabled=pool_enabled,  # Reward.__post_init__ forces this on for jackpots (#552)
             quantity=quantity,
             expires_at=expires_at,
+            template_id=clean_template_id(template_id),
         )
         self.storage.add_reward(reward)
         await self.storage.async_save()

custom_components/taskmate/coord_setup.py

@@ -8,9 +8,10 @@
 
 Everything is checked before anything is written, so a bad birthday or an
 unknown child leaves the family exactly as it was. The wizard only ever adds:
-a chore or reward whose name the family already has is skipped, a child whose
-name already exists is reused, and an existing child's birthday or age group is
-only filled in when it is still empty.
+a chore or reward the family already has (same name, or added from the same
+library entry) is skipped, a child whose name already exists is reused, and an
+existing child's birthday or age group is only filled in when it is still
+empty. The 📚 library adds through here too (``taskmate/library/add``).
 """
 
 from __future__ import annotations
@@ -20,6 +21,7 @@
 
 from .const import AGE_GROUPS
 from .coord_birthdays import normalize_birthday
+from .models import clean_template_id
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -37,6 +39,7 @@
     "recurrence",
     "recurrence_day",
     "assignment_mode",
+    "template_id",
 )
 
 
@@ -126,33 +129,45 @@ def resolve(who: str) -> str:
                 return who
             raise ValueError(f"Chore assigned to an unknown child {who!r}")
 
-        have_chores = {_fold(c.name) for c in self.storage.get_chores()}
+        existing_chores = self.storage.get_chores()
+        have_chores = {_fold(c.name) for c in existing_chores}
+        have_chore_tpls = {c.template_id for c in existing_chores if c.template_id}
         chore_defs: list[dict] = []
         skipped_chores = 0
         for spec in chores:
             name = (spec.get("name") or "").strip()
             if not name:
                 raise ValueError("A chore needs a name")
             assigned = [resolve(str(w)) for w in spec.get("assigned_to") or []]
-            if _fold(name) in have_chores:
+            tpl = clean_template_id(spec.get("template_id"))
+            if _fold(name) in have_chores or (tpl and tpl in have_chore_tpls):
                 skipped_chores += 1
                 continue
+            # Sent twice in one batch: the second is a duplicate too.
+            have_chores.add(_fold(name))
+            if tpl:
+                have_chore_tpls.add(tpl)
             chore_def = {k: spec[k] for k in _CHORE_KEYS if k in spec}
             chore_def["name"] = name
             chore_def["assigned_to"] = assigned
             chore_defs.append(chore_def)
 
-        have_rewards = {_fold(r.name) for r in self.storage.get_rewards()}
+        existing_rewards = self.storage.get_rewards()
+        have_rewards = {_fold(r.name) for r in existing_rewards}
+        have_reward_tpls = {r.template_id for r in existing_rewards if r.template_id}
         reward_specs: list[dict] = []
         skipped_rewards = 0
         for spec in rewards:
             name = (spec.get("name") or "").strip()
             if not name:
                 raise ValueError("A reward needs a name")
-            if _fold(name) in have_rewards:
+            tpl = clean_template_id(spec.get("template_id"))
+            if _fold(name) in have_rewards or (tpl and tpl in have_reward_tpls):
                 skipped_rewards += 1
                 continue
             have_rewards.add(_fold(name))
+            if tpl:
+                have_reward_tpls.add(tpl)
             reward_specs.append(spec)
 
         # --- write, deferring every refresh to the end -----------------------
@@ -184,6 +199,7 @@ def resolve(who: str) -> str:
                 description=spec.get("description", ""),
                 icon=spec.get("icon") or "mdi:gift",
                 refresh=False,
+                template_id=spec.get("template_id", ""),
             )
 
         await self.async_refresh()

custom_components/taskmate/coord_templates.py

@@ -6,7 +6,7 @@
 from typing import TYPE_CHECKING
 
 from .const import ASSIGNMENT_MODES, SCHEDULE_MODES, TIME_CATEGORIES
-from .models import Chore, generate_id, optional_float
+from .models import Chore, clean_template_id, generate_id, optional_float
 from .templates import BUILT_IN_IDS, BUILT_IN_TEMPLATES, TEMPLATE_CHORE_FIELDS
 
 if TYPE_CHECKING:
@@ -110,6 +110,9 @@ async def async_apply_template(self, chores: list[dict], refresh: bool = True) -
             # packs don't, and keep the chore's default.
             if chore_def.get("icon"):
                 chore.icon = chore_def["icon"]
+            # Added from the 📚 library or the wizard: remembered so the
+            # library shows it as already added.
+            chore.template_id = clean_template_id(chore_def.get("template_id"))
             self.storage.add_chore(chore)
             created_ids.append(chore.id)
         await self.storage.async_save()

custom_components/taskmate/models.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import logging
+import re
 import uuid
 from dataclasses import dataclass, field
 from datetime import date, datetime, timezone
@@ -101,6 +102,22 @@ def format_datetime(dt: datetime | None) -> str | None:
     return utc_dt.isoformat().replace("+00:00", "Z")
 
 
+TEMPLATE_ID_MAX_LENGTH = 80
+_TEMPLATE_ID_RE = re.compile(r"[a-z0-9_.]+")
+
+
+def clean_template_id(raw: Any) -> str:
+    """A library template id (``make_bed``, ``pack.pet_care.2``) or "".
+
+    Anything else — a restored backup's junk, a too-long string — reads as
+    "", which only means the library won't recognise the item as added.
+    """
+    value = str(raw or "").strip()
+    if len(value) > TEMPLATE_ID_MAX_LENGTH or not _TEMPLATE_ID_RE.fullmatch(value):
+        return ""
+    return value
+
+
 def normalize_tag_ids(raw: Any) -> list[str]:
     """Clean a chore's linked HA tag ids (#923).
 
@@ -491,6 +508,10 @@ class Chore:
     # one completion (0 = no cap).
     quantity_unit: str = ""
     quantity_max: int = 0
+    # The library entry this chore was added from (a catalogue id such as
+    # ``make_bed``, or ``pack.<pack>.<n>``), so the 📚 library can show it as
+    # already added. "" for chores made by hand.
+    template_id: str = ""
     id: str = field(default_factory=generate_id)
 
     @classmethod
@@ -576,6 +597,7 @@ def from_dict(cls, data: dict[str, Any]) -> Chore:
             reference_image_url=str(data.get("reference_image_url", "") or ""),
             quantity_unit=str(data.get("quantity_unit", "") or "").strip()[:QUANTITY_UNIT_MAX_LENGTH],
             quantity_max=_clamp_int(data.get("quantity_max"), 0, MAX_QUANTITY),
+            template_id=clean_template_id(data.get("template_id")),
             id=data.get("id") or generate_id(),
         )
 
@@ -648,6 +670,7 @@ def to_dict(self) -> dict[str, Any]:
             "reference_image_url": self.reference_image_url,
             "quantity_unit": self.quantity_unit,
             "quantity_max": self.quantity_max,
+            "template_id": self.template_id,
             "id": self.id,
         }
 
@@ -741,6 +764,10 @@ class Reward:
     # Streak freeze (#925): approving a claim hands the child one streak-freeze
     # token instead of anything physical. Always a fixed cost like any reward.
     streak_freeze: bool = False
+    # The library entry this reward was added from (a catalogue id such as
+    # ``sleepover``); "" for rewards made by hand. Only used to show "already
+    # added".
+    template_id: str = ""
     id: str = field(default_factory=generate_id)
 
     def __post_init__(self) -> None:
@@ -783,6 +810,7 @@ def from_dict(cls, data: dict[str, Any]) -> Reward:
             available_from=str(data.get("available_from", "") or ""),
             available_until=str(data.get("available_until", "") or ""),
             streak_freeze=bool(data.get("streak_freeze", False)),
+            template_id=clean_template_id(data.get("template_id")),
             id=data.get("id") or generate_id(),
         )
 
@@ -809,6 +837,7 @@ def to_dict(self) -> dict[str, Any]:
             "available_from": self.available_from,
             "available_until": self.available_until,
             "streak_freeze": self.streak_freeze,
+            "template_id": self.template_id,
             "id": self.id,
         }