moosicbox_app_models 0.2.0

MoosicBox App models package
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# MoosicBox App Models

Data models and structures for MoosicBox native applications.

## Overview

The MoosicBox App Models package provides:

- **Connection Models**: API connection configuration and management
- **Music API Settings**: Music service authentication and configuration
- **Download Settings**: Download location and management configuration
- **Scan Settings**: Music library scan path configuration
- **Feature Integration**: Optional integration with music API authentication

## Models

### Connection

- **name**: Display name for the connection
- **api_url**: MoosicBox server API endpoint URL

### MusicApiSettings

- **id**: Unique identifier for the music service
- **name**: Display name of the music service
- **logged_in**: Authentication status
- **supports_scan**: Whether the service supports library scanning
- **scan_enabled**: Whether scanning is currently enabled
- **run_scan_endpoint**: Optional API endpoint for triggering scans
- **auth_method**: Optional authentication method configuration (requires `music-api-api` feature)

### DownloadSettings

- **download_locations**: List of available download locations with IDs
- **default_download_location**: Default download path

### ScanSettings

- **scan_paths**: List of local filesystem paths to scan for music

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
moosicbox_app_models = { path = "../app/models" }

# Or disable default features and enable only specific features
moosicbox_app_models = {
    path = "../app/models",
    default-features = false,
    features = ["music-api-api"]
}
```

## Usage

### Connection Management

```rust
use moosicbox_app_models::Connection;

let connection = Connection {
    name: "Home Server".to_string(),
    api_url: "https://moosicbox.local:8686".to_string(),
};
```

### Music API Configuration

```rust
use moosicbox_app_models::MusicApiSettings;

#[cfg(feature = "music-api-api")]
use moosicbox_app_models::AuthMethod;

let tidal_settings = MusicApiSettings {
    id: "tidal".to_string(),
    name: "Tidal".to_string(),
    logged_in: true,
    supports_scan: false,
    scan_enabled: false,
    run_scan_endpoint: None,
    #[cfg(feature = "music-api-api")]
    auth_method: Some(AuthMethod::UsernamePassword),
};
```

### Download Configuration

```rust
use moosicbox_app_models::DownloadSettings;

let download_settings = DownloadSettings {
    download_locations: vec![
        (1, "/home/user/Music".to_string()),
        (2, "/mnt/storage/Music".to_string()),
    ],
    default_download_location: Some("/home/user/Music".to_string()),
};
```

## Feature Flags

### Default Features

- **`music-api-api`**: Integration with MoosicBox music API authentication (includes `AuthMethod`)
- **`auth-poll`**: Support for poll-based authentication flows
- **`auth-username-password`**: Support for username/password authentication

### Additional Features

- **`fail-on-warnings`**: Treat compiler warnings as errors

## Dependencies

- **serde**: Serialization and deserialization
- **log**: Logging functionality
- **moosicbox_music_api_api**: Music API authentication integration (optional, enabled by default)