aioaudiobookshelf 0.1.0__py3-none-any.whl

aioaudiobookshelf/schema/library.py

@@ -0,0 +1,221 @@
+"""Library Schema."""
+# Discriminators don't work together with aliases.
+# https://github.com/Fatal1ty/mashumaro/issues/254
+# ruff: noqa: N815
+
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Annotated
+
+from mashumaro.types import Alias, Discriminator
+
+from aioaudiobookshelf.schema.author import AuthorMinified
+from aioaudiobookshelf.schema.series import SeriesFilterData
+
+from . import _BaseModel
+from .book import Book, BookExpanded, BookMinified
+from .file import FileMetadata
+from .folder import Folder
+from .podcast import Podcast, PodcastExpanded, PodcastMinified
+
+
+class LibraryIcons(StrEnum):
+    """LibraryIcons."""
+
+    DATABASE = "database"
+    AUDIOBOOKSHELF = "audiobookshelf"
+    BOOKS1 = "books-1"
+    BOOKS2 = "books-2"
+    BOOK1 = "book-1"
+    MICROPHONE1 = "microphone-1"
+    MICROPHONE3 = "microphone-3"
+    RADIO = "radio"
+    PODCAST = "podcast"
+    RSS = "rss"
+    HEADPHONES = "headphones"
+    MUSIC = "music"
+    FILEPICTURE = "file-picture"
+    ROCKET = "rocket"
+    POWER = "power"
+    START = "star"
+    HEART = "heart"
+
+
+class LibraryMediaType(StrEnum):
+    """LibraryMediaType."""
+
+    BOOK = "book"
+    PODCAST = "podcast"
+
+
+@dataclass(kw_only=True)
+class LibraryFile(_BaseModel):
+    """LibraryFile."""
+
+    ino: str
+    metadata: FileMetadata
+    added_at: Annotated[int, Alias("addedAt")]  # ms epoch
+    updated_at: Annotated[int, Alias("updatedAt")]  # ms epoch
+    file_type: Annotated[str, Alias("fileType")]
+
+
+@dataclass(kw_only=True)
+class LibrarySettings(_BaseModel):
+    """LibrarySettings."""
+
+    cover_aspect_ratio: Annotated[int, Alias("coverAspectRatio")]
+    disable_watcher: Annotated[bool, Alias("disableWatcher")]
+    skip_matching_media_with_asin: Annotated[bool, Alias("skipMatchingMediaWithAsin")]
+    skip_matching_media_with_isbn: Annotated[bool, Alias("skipMatchingMediaWithIsbn")]
+    auto_scan_cron_expression: Annotated[str | None, Alias("autoScanCronExpression")] = None
+
+
+@dataclass(kw_only=True)
+class Library(_BaseModel):
+    """Library."""
+
+    id_: Annotated[str, Alias("id")]
+    name: str
+    folders: list[Folder]
+    display_order: Annotated[int, Alias("displayOrder")]
+    icon: LibraryIcons
+    media_type: Annotated[LibraryMediaType, Alias("mediaType")]
+    # TODO: add enum
+    provider: str
+    settings: LibrarySettings
+    created_at: Annotated[int, Alias("createdAt")]  # ms epoch
+    last_update: Annotated[int, Alias("lastUpdate")]  # ms epoch
+
+
+@dataclass(kw_only=True)
+class _LibraryItemBase(_BaseModel):
+    id_: Annotated[str, Alias("id")]
+    ino: str
+    library_id: Annotated[str, Alias("libraryId")]
+    folder_id: Annotated[str, Alias("folderId")]
+    path: str
+    relative_path: Annotated[str, Alias("relPath")]
+    is_file: Annotated[bool, Alias("isFile")]
+    modified_time_ms: Annotated[int, Alias("mtimeMs")]
+    changed_time_ms: Annotated[int, Alias("ctimeMs")]
+    created_time_ms: Annotated[int, Alias("birthtimeMs")]  # epoch
+    added_at: Annotated[int, Alias("addedAt")]
+    updated_at: Annotated[int, Alias("updatedAt")]  # ms epoch
+    is_missing: Annotated[bool, Alias("isMissing")]
+    is_invalid: Annotated[bool, Alias("isInvalid")]
+
+
+@dataclass(kw_only=True)
+class LibraryItem(_LibraryItemBase):
+    """LibraryItem."""
+
+    class Config(_LibraryItemBase.Config):
+        """Config."""
+
+        discriminator = Discriminator(
+            field="mediaType",
+            include_subtypes=True,
+        )
+
+    last_scan: Annotated[int | None, Alias("lastScan")] = None  # ms epoch
+    scan_version: Annotated[str | None, Alias("scanVersion")] = None
+    library_files: Annotated[list[LibraryFile], Alias("libraryFiles")]
+
+
+@dataclass(kw_only=True)
+class LibraryItemBook(LibraryItem):
+    """LibraryItemBook."""
+
+    media: Book
+    mediaType: LibraryMediaType = LibraryMediaType.BOOK
+
+
+@dataclass(kw_only=True)
+class LibraryItemPodcast(LibraryItem):
+    """LibraryItemPodcast."""
+
+    media: Podcast
+    mediaType: LibraryMediaType = LibraryMediaType.PODCAST
+
+
+@dataclass(kw_only=True)
+class LibraryItemMinified(_LibraryItemBase):
+    """LibraryItemMinified."""
+
+    class Config(_LibraryItemBase.Config):
+        """Config."""
+
+        discriminator = Discriminator(
+            field="mediaType",
+            include_subtypes=True,
+        )
+
+    num_files: Annotated[int, Alias("numFiles")]
+    size: int
+
+
+@dataclass(kw_only=True)
+class LibraryItemMinifiedBook(LibraryItemMinified):
+    """LibraryItemMinifiedBook."""
+
+    media: BookMinified
+    mediaType: LibraryMediaType = LibraryMediaType.BOOK
+    # media_type: Annotated[LibraryMediaType, Alias("mediaType")] = LibraryMediaType.BOOK
+    # media_type: LibraryMediaType = field(
+    #     metadata=field_options(alias="mediaType"), default=LibraryMediaType.BOOK
+    # )
+
+
+@dataclass(kw_only=True)
+class LibraryItemMinifiedPodcast(LibraryItemMinified):
+    """LibraryItemMinifiedPodcast."""
+
+    media: PodcastMinified
+    mediaType: LibraryMediaType = LibraryMediaType.PODCAST
+    # media_type: Annotated[LibraryMediaType, Alias("mediaType")] = LibraryMediaType.PODCAST
+    # media_type: LibraryMediaType = field(
+    #     metadata=field_options(alias="mediaType"), default=LibraryMediaType.PODCAST
+    # )
+
+
+@dataclass(kw_only=True)
+class LibraryItemExpanded(LibraryItem):
+    """LibraryItemExpanded."""
+
+    class Config(LibraryItem.Config):
+        """Config."""
+
+        discriminator = Discriminator(
+            field="mediaType",
+            include_subtypes=True,
+        )
+
+    size: int
+
+
+@dataclass(kw_only=True)
+class LibraryItemExpandedBook(LibraryItemExpanded):
+    """LibraryItemExpandedBook."""
+
+    media: BookExpanded
+    mediaType: LibraryMediaType = LibraryMediaType.BOOK
+
+
+@dataclass(kw_only=True)
+class LibraryItemExpandedPodcast(LibraryItemExpanded):
+    """LibraryItemExpandedPodcast."""
+
+    media: PodcastExpanded
+    mediaType: LibraryMediaType = LibraryMediaType.PODCAST
+
+
+@dataclass(kw_only=True)
+class LibraryFilterData(_BaseModel):
+    """LibraryFilterData."""
+
+    authors: list[AuthorMinified]
+    genres: list[str]
+    tags: list[str]
+    series: list[SeriesFilterData]
+    narrators: list[str]
+    languages: list[str]

aioaudiobookshelf/schema/media_progress.py

@@ -0,0 +1,42 @@
+"""Schema for media progress."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .book import BookExpanded
+from .podcast import PodcastEpisode, PodcastExpanded
+
+
+@dataclass(kw_only=True)
+class MediaProgress(_BaseModel):
+    """MediaProgress."""
+
+    id_: Annotated[str, Alias("id")]
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    episode_id: Annotated[str | None, Alias("episodeId")] = None
+    duration: float  # seconds
+    progress: float  # percent 0->1
+    current_time: Annotated[float, Alias("currentTime")]  # seconds
+    is_finished: Annotated[bool, Alias("isFinished")]
+    hide_from_continue_listening: Annotated[bool, Alias("hideFromContinueListening")]
+    last_update: Annotated[int, Alias("lastUpdate")]  # ms epoch
+    started_at: Annotated[int, Alias("startedAt")]  # ms epoch
+    finished_at: Annotated[int | None, Alias("finishedAt")] = None  # ms epoch
+
+
+@dataclass(kw_only=True)
+class MediaProgressWithMediaBook(MediaProgress):
+    """MediaProgressWithMediaBook."""
+
+    media: BookExpanded
+
+
+@dataclass(kw_only=True)
+class MediaProgressWithMediaPodcast(MediaProgress):
+    """MediaProgressWithMediaPodcast."""
+
+    media: PodcastExpanded
+    episode: PodcastEpisode

aioaudiobookshelf/schema/playlist.py

@@ -0,0 +1,74 @@
+"""Schema for playlist."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias, Discriminator
+
+from aioaudiobookshelf.schema.podcast import PodcastEpisodeExpanded
+
+from . import _BaseModel
+from .library import LibraryItemExpandedBook, LibraryItemMinifiedPodcast
+
+
+@dataclass(kw_only=True)
+class PlaylistItem(_BaseModel):
+    """PlaylistItem."""
+
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    episode_id: Annotated[str | None, Alias("episodeId")] = None
+
+
+@dataclass(kw_only=True)
+class PlaylistItemExpanded(_BaseModel):
+    """PlaylistExpanded."""
+
+    class Config(PlaylistItem.Config):
+        """Config."""
+
+        # can't use field as episode_id is either existing or not.
+        discriminator = Discriminator(
+            include_subtypes=True,
+        )
+
+
+@dataclass(kw_only=True)
+class PlaylistItemExpandedBook(PlaylistItemExpanded):
+    """PlaylistExpanded."""
+
+    library_item: Annotated[LibraryItemExpandedBook, Alias("libraryItem")]
+
+
+@dataclass(kw_only=True)
+class PlaylistItemExpandedPodcast(PlaylistItemExpanded):
+    """PlaylistItemExpandedPodcast."""
+
+    library_item: Annotated[LibraryItemMinifiedPodcast, Alias("libraryItem")]
+    episode_id: Annotated[str, Alias("episodeId")]
+    episode: PodcastEpisodeExpanded
+
+
+@dataclass(kw_only=True)
+class _PlaylistBase(_BaseModel):
+    id_: Annotated[str, Alias("id")]
+    library_id: Annotated[str, Alias("libraryId")]
+    user_id: Annotated[str | None, Alias("userId")] = None
+    name: str
+    description: str | None = None
+    cover_path: Annotated[str | None, Alias("coverPath")] = None
+    last_update: Annotated[int, Alias("lastUpdate")]  # ms epoch
+    created_at: Annotated[int, Alias("createdAt")]  # ms epoch
+
+
+@dataclass(kw_only=True)
+class Playlist(_PlaylistBase):
+    """Playlist."""
+
+    items: list[PlaylistItem]
+
+
+@dataclass(kw_only=True)
+class PlaylistExpanded(_PlaylistBase):
+    """Playlist."""
+
+    items: list[PlaylistItemExpanded]

aioaudiobookshelf/schema/podcast.py

@@ -0,0 +1,129 @@
+"""Schema for podcasts."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .audio import AudioFile, AudioTrack
+
+
+@dataclass(kw_only=True)
+class PodcastMetadata(_BaseModel):
+    """PodcastMetadata."""
+
+    title: str | None = None
+    author: str | None = None
+    description: str | None = None
+    release_date: Annotated[str | None, Alias("releaseDate")] = None
+    genres: list[str]
+    feed_url: Annotated[str | None, Alias("feedUrl")] = None
+    image_url: Annotated[str | None, Alias("imageUrl")] = None
+    itunes_page_url: Annotated[str | None, Alias("itunesPageUrl")] = None
+    itunes_id: Annotated[int | str | None, Alias("itunesId")] = None
+    # str: is not documented
+    itunes_artist_id: Annotated[int | str | None, Alias("itunesArtistId")] = None
+    explicit: bool
+    language: str | None = None
+    type_: Annotated[str | None, Alias("type")] = None
+
+
+@dataclass(kw_only=True)
+class PodcastMetadataMinified(PodcastMetadata):
+    """PodcastMetadataMinified."""
+
+    title_ignore_prefix: Annotated[str | None, Alias("titleIgnorePrefix")] = None
+
+
+PodcastMetaDataExpanded = PodcastMetadataMinified
+
+
+@dataclass(kw_only=True)
+class PodcastEpisodeEnclosure(_BaseModel):
+    """PodcastEpisodeEnclosure."""
+
+    url: str
+    type_: Annotated[str, Alias("type")]
+    length: str
+
+
+@dataclass(kw_only=True)
+class _PodcastEpisodeBase(_BaseModel):
+    """PodcastEpisode."""
+
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    id_: Annotated[str, Alias("id")]
+    index: int | None = None
+    season: str
+    episode: str
+    episode_type: Annotated[str, Alias("episodeType")]
+    title: str
+    subtitle: str
+    description: str
+    pub_date: Annotated[str, Alias("pubDate")]
+    published_at: Annotated[int | None, Alias("publishedAt")] = None  # ms posix epoch
+    added_at: Annotated[int, Alias("addedAt")]  # ms posix epoch
+    updated_at: Annotated[int, Alias("updatedAt")]  # ms posix epoch
+
+
+@dataclass(kw_only=True)
+class PodcastEpisode(_PodcastEpisodeBase):
+    """PodcastEpisode."""
+
+    audio_file: AudioFile | None = None
+    enclosure: PodcastEpisodeEnclosure | None = None
+
+
+@dataclass(kw_only=True)
+class PodcastEpisodeExpanded(_PodcastEpisodeBase):
+    """PodcastEpisodeExpanded."""
+
+    audio_track: Annotated[AudioTrack, Alias("audioTrack")]
+    duration: float
+    size: int
+    audio_file: AudioFile | None = None
+    enclosure: PodcastEpisodeEnclosure | None = None
+
+
+@dataclass(kw_only=True)
+class _PodcastBase(_BaseModel):
+    """_PodcastBase."""
+
+    cover_path: Annotated[str | None, Alias("coverPath")] = None
+    auto_download_episodes: Annotated[bool, Alias("autoDownloadEpisodes")]
+    auto_download_schedule: Annotated[str, Alias("autoDownloadSchedule")]
+    # None is not documented
+    last_episode_check_ms: Annotated[int | None, Alias("lastEpisodeCheck")] = None
+    max_episodes_to_keep: Annotated[int, Alias("maxEpisodesToKeep")]  # 0 = all
+    max_new_episodes_to_download: Annotated[int, Alias("maxNewEpisodesToDownload")]
+
+
+@dataclass(kw_only=True)
+class Podcast(_PodcastBase):
+    """ABSPodcast."""
+
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    metadata: PodcastMetadata
+    tags: list[str]
+    episodes: list[PodcastEpisode]
+
+
+@dataclass(kw_only=True)
+class PodcastMinified(_PodcastBase):
+    """ABSPodcastMinified."""
+
+    metadata: PodcastMetadataMinified
+    size: int  # bytes
+    num_episodes: Annotated[int, Alias("numEpisodes")]
+
+
+@dataclass(kw_only=True)
+class PodcastExpanded(_PodcastBase):
+    """PodcastEpisodeExpanded."""
+
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    tags: list[str]
+    size: int  # bytes
+    metadata: PodcastMetaDataExpanded
+    episodes: list[PodcastEpisodeExpanded]

aioaudiobookshelf/schema/series.py

@@ -0,0 +1,45 @@
+"""Schema for series."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class _SeriesBase(_BaseModel):
+    """_SeriesBase."""
+
+    id_: Annotated[str, Alias("id")]
+    name: str
+
+
+# in get_library call including filterdata we get only id and name of series
+SeriesFilterData = _SeriesBase
+
+
+@dataclass(kw_only=True)
+class Series(_SeriesBase):
+    """Series."""
+
+    description: str | None = None
+    added_at: Annotated[int, Alias("addedAt")]  # ms epoch
+    updated_at: Annotated[int, Alias("updatedAt")]  # ms epoch
+
+
+@dataclass(kw_only=True)
+class SeriesNumBooks(_SeriesBase):
+    """SeriesNumBooks."""
+
+    name_ignore_prefix: Annotated[str, Alias("nameIgnorePrefix")]
+    library_item_ids: Annotated[list[str], Alias("libraryItemIds")]
+    num_books: Annotated[int, Alias("numBooks")]
+
+
+@dataclass(kw_only=True)
+class SeriesSequence(_SeriesBase):
+    """Series Sequence."""
+
+    sequence: str | None = None

aioaudiobookshelf/schema/series_books.py

@@ -0,0 +1,34 @@
+"""SeriesBase classes."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from .library import LibraryItemBook, LibraryItemMinifiedBook
+from .series import _SeriesBase
+
+
+@dataclass(kw_only=True)
+class _SeriesBooksBase(_SeriesBase):
+    """SeriesBooks."""
+
+    added_at: Annotated[int, Alias("addedAt")]  # ms epoch
+    name_ignore_prefix: Annotated[str, Alias("nameIgnorePrefix")]
+    name_ignore_prefix_sort: Annotated[str, Alias("nameIgnorePrefixSort")]
+    type_: Annotated[str, Alias("type")]
+    total_duration: Annotated[float, Alias("totalDuration")]  # s
+
+
+@dataclass(kw_only=True)
+class SeriesBooks(_SeriesBooksBase):
+    """SeriesBooks."""
+
+    books: list[LibraryItemBook]
+
+
+@dataclass(kw_only=True)
+class SeriesBooksMinified(_SeriesBase):
+    """SeriesBooks."""
+
+    books: list[LibraryItemMinifiedBook]

aioaudiobookshelf/schema/server.py

@@ -0,0 +1,76 @@
+"""Server Schema."""
+
+from dataclasses import dataclass
+from enum import Enum, StrEnum
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+
+
+class ServerSettingsMetadataFileFormat(StrEnum):
+    """ServerSettingsMetadataFileFormat."""
+
+    ABS = "abs"
+    JSON = "json"
+
+
+class ServerSettingsDateFormat(StrEnum):
+    """ServerSettingsDateFormat."""
+
+    MM_DD_YYYY = "MM/dd/yyyy"
+    DD_MM_YYYY = "dd/MM/yyyy"
+    DDpMMpYYYY = "dd.MM.yyyy"
+    YYYY_MM_DD = "yyyy-MM-dd"
+    MMM_DO_YYYY = "MMM do, yyyy"
+    MMMM_DO_YYYY = "MMMM do, yyyy"
+    DD_MMM_YYYY = "dd MMM yyyy"
+    DD_MMMM_YYYY = "dd MMMM yyyy"
+
+
+class ServerSettingsTimeFormat(StrEnum):
+    """ServerSettingsTimeFormat."""
+
+    TWENTY_FOUR_HOOUR = "HH:mm"
+    TWELVE_HOUR = "h:mma"
+
+
+class ServerLogLevel(Enum):
+    """ServerLogLevel."""
+
+    DEBUG = 1
+    INFO = 2
+    WARNING = 3
+
+
+@dataclass(kw_only=True)
+class ServerSettings(_BaseModel):
+    """ServerSettings."""
+
+    id: Annotated[str, Alias("id")]
+    scanner_find_covers: Annotated[bool, Alias("scannerFindCovers")]
+    scanner_cover_provider: Annotated[str, Alias("scannerCoverProvider")]
+    scanner_parse_subtitle: Annotated[bool, Alias("scannerParseSubtitle")]
+    scanner_prefer_matched_metadata: Annotated[bool, Alias("scannerPreferMatchedMetadata")]
+    scanner_disable_watcher: Annotated[bool, Alias("scannerDisableWatcher")]
+    store_cover_with_item: Annotated[bool, Alias("storeCoverWithItem")]
+    store_metadata_with_item: Annotated[bool, Alias("storeMetadataWithItem")]
+    metadata_file_format: Annotated[ServerSettingsMetadataFileFormat, Alias("metadataFileFormat")]
+    rate_limit_login_requests: Annotated[int, Alias("rateLimitLoginRequests")]
+    rate_limit_login_window: Annotated[int, Alias("rateLimitLoginWindow")]  # ms
+    backup_schedule: Annotated[str, Alias("backupSchedule")]
+    backups_to_keep: Annotated[int, Alias("backupsToKeep")]
+    max_backup_size: Annotated[int, Alias("maxBackupSize")]  # GB
+    logger_daily_logs_to_keep: Annotated[int, Alias("loggerDailyLogsToKeep")]
+    logger_scanner_logs_to_keep: Annotated[int, Alias("loggerScannerLogsToKeep")]
+    home_bookshelf_view: Annotated[int, Alias("homeBookshelfView")]
+    bookshelf_view: Annotated[int, Alias("bookshelfView")]
+    sorting_ignore_prefix: Annotated[bool, Alias("sortingIgnorePrefix")]
+    sorting_prefixes: Annotated[list[str], Alias("sortingPrefixes")]
+    chromecast_enabled: Annotated[bool, Alias("chromecastEnabled")]
+    date_format: Annotated[ServerSettingsDateFormat, Alias("dateFormat")]
+    time_format: Annotated[ServerSettingsTimeFormat, Alias("timeFormat")]
+    language: str
+    log_level: Annotated[ServerLogLevel, Alias("logLevel")]
+    version: str