Add series to metadata

music_assistant_models/media_items/__init__.py

@@ -30,7 +30,13 @@
     RecommendationFolder,
     Track,
 )
-from .metadata import MediaItemChapter, MediaItemImage, MediaItemLink, MediaItemMetadata
+from .metadata import (
+    MediaItemChapter,
+    MediaItemImage,
+    MediaItemLink,
+    MediaItemMetadata,
+    MediaItemSeries,
+)
 from .provider_mapping import ProviderMapping
 
 __all__ = [
@@ -46,6 +52,7 @@
     "MediaItemImage",
     "MediaItemLink",
     "MediaItemMetadata",
+    "MediaItemSeries",
     "MediaItemType",
     "Metadata",
     "MetadataProvider",

music_assistant_models/media_items/helpers.py

@@ -0,0 +1,19 @@
+"""API helper classes for media items."""
+
+from dataclasses import dataclass, field
+
+from mashumaro import DataClassDictMixin
+
+from .media_item import Audiobook
+
+
+@dataclass
+class AudiobookSeries(DataClassDictMixin):
+    """An audiobook series as acquired from the database.
+
+    This is used as API response, and not to be used by a provider.
+    """
+
+    title: str
+    # sorted list of audiobooks in this series
+    audiobooks: list[Audiobook] = field(default_factory=list)

music_assistant_models/media_items/metadata.py

@@ -69,6 +69,20 @@ def __hash__(self) -> int:
         return hash(self.position)
 
 
+@dataclass(frozen=True, kw_only=True)
+class MediaItemSeries(DataClassDictMixin):
+    """Model for a MediaItem's series."""
+
+    title: str
+    # sequence is used for sorting
+    # we will first sort by number, and then alphabetically
+    sequence: float | str | None = None
+
+    def __hash__(self) -> int:
+        """Return custom hash."""
+        return hash(self.title)
+
+
 @dataclass(kw_only=True)
 class MediaItemMetadata(DataClassDictMixin):
     """Model for a MediaItem's metadata."""
@@ -95,6 +109,7 @@ class MediaItemMetadata(DataClassDictMixin):
     # chapters is a list of available chapters, sorted by position
     # most commonly used for audiobooks and podcast episodes
     chapters: list[MediaItemChapter] | None = None
+    series: UniqueList[MediaItemSeries] | None = None
     # last_refresh: timestamp the (full) metadata was last collected
     last_refresh: int | None = None