moosicbox_app_models 0.3.0

//! Data models for `MoosicBox` application configuration.
//!
//! This crate provides the core data structures used by `MoosicBox` applications
//! to manage connections, music API integrations, and library settings.
//!
//! # Main Types
//!
//! * [`Connection`] - Server connection configuration
//! * [`MusicApiSettings`] - Music API integration settings
//! * [`DownloadSettings`] - Download location management
//! * [`ScanSettings`] - Library scanning configuration

#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
#![allow(clippy::multiple_crate_versions)]
#![allow(clippy::branches_sharing_code)]

use serde::{Deserialize, Serialize};

/// Re-exported authentication method type from the music API module.
///
/// Used by [`MusicApiSettings`] to specify the authentication mechanism
/// for external music API integrations.
#[cfg(feature = "music-api-api")]
pub use moosicbox_music_api_api::models::AuthMethod;

/// Represents a connection to a `MoosicBox` server.
///
/// Contains the server name and API URL for establishing connections.
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
pub struct Connection {
    /// Display name for the connection
    pub name: String,
    /// Base URL for the API endpoint
    pub api_url: String,
}

impl AsRef<Self> for Connection {
    /// Returns a reference to this connection.
    fn as_ref(&self) -> &Self {
        self
    }
}

/// Settings for a music API integration.
///
/// Stores configuration and capabilities for integrating with external music APIs.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[allow(clippy::struct_excessive_bools)]
pub struct MusicApiSettings {
    /// Unique identifier for the music API
    pub id: String,
    /// Display name of the music API
    pub name: String,
    /// Whether the user is currently logged in to the API
    pub logged_in: bool,
    /// Whether the API supports library scanning
    pub supports_scan: bool,
    /// Whether library scanning is enabled for this API
    pub scan_enabled: bool,
    /// Endpoint URL for triggering a library scan
    pub run_scan_endpoint: Option<String>,
    /// Authentication method used by the API
    #[cfg(feature = "music-api-api")]
    pub auth_method: Option<AuthMethod>,
}

impl AsRef<Self> for MusicApiSettings {
    /// Returns a reference to these music API settings.
    fn as_ref(&self) -> &Self {
        self
    }
}

#[cfg(feature = "music-api-api")]
pub mod music_api_api {
    //! Conversions between music API models.
    //!
    //! Provides `From` trait implementations to convert from API-level
    //! music API models to application-level settings.

    use moosicbox_music_api_api::models::ApiMusicApi;

    use crate::MusicApiSettings;

    /// Converts from API-level music API model to application-level settings.
    ///
    /// This conversion automatically generates the `run_scan_endpoint` URL
    /// based on the API name if scanning is supported.
    impl From<ApiMusicApi> for MusicApiSettings {
        fn from(value: ApiMusicApi) -> Self {
            Self {
                logged_in: value.logged_in,
                supports_scan: value.supports_scan,
                scan_enabled: value.scan_enabled,
                run_scan_endpoint: value
                    .supports_scan
                    .then(|| format!("/music-api/scan?apiSource={}", value.name)),
                auth_method: value.auth_method,
                name: value.name,
                id: value.id,
            }
        }
    }
}

/// Settings for managing download locations.
///
/// Stores configured download paths and the default location for new downloads.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct DownloadSettings {
    /// List of download locations as (ID, path) pairs
    pub download_locations: Vec<(u64, String)>,
    /// Default path for new downloads
    pub default_download_location: Option<String>,
}

impl AsRef<Self> for DownloadSettings {
    /// Returns a reference to these download settings.
    fn as_ref(&self) -> &Self {
        self
    }
}

/// Settings for library scanning.
///
/// Contains the filesystem paths to scan for media files.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ScanSettings {
    /// List of filesystem paths to scan for media files
    pub scan_paths: Vec<String>,
}

impl AsRef<Self> for ScanSettings {
    /// Returns a reference to these scan settings.
    fn as_ref(&self) -> &Self {
        self
    }
}