Release 0.5.0 (#6)

* Refactor data provider service to use new request coordinator protocol

* Rename catalog resources objects

* Improve & restructure overall resources model definitions, project clean up

* Add async support to DataProvider class

* Fix encapsulation issues

* Add macOS API availability definitions

* Add async support for search methods

* Update README file

Author: jjotaum

README.md

@@ -32,146 +32,114 @@ amuseProvider.setUserToken("USER_TOKEN")
 amuseProvider.setUserCountryCode("USER_COUNTRY_CODE")
 ```
 
-### Retrieve multiple Albums from Apple Music catalog by ids.
+### Retrieve Apple Music catalog resources by ids.
 
-```swift
-amuseProvider.catalog(.albums, ids: ["123", "456", "789"])
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
-```
-
-### Retrieve multiple Artists from Apple Music catalog by ids.
+Supported values are: `albums, artists, musicVideos, playlists, songs`.
 
 ```swift
-amuseProvider.catalog(.artists, ids: ["123", "456", "789"])
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
+let response = try await amuseProvider.catalog(.albums, ids: ["123", "456", "789"])
+print(response.data)
 ```
 
-### Retrieve multiple Music Videos from Apple Music catalog by ids.
-
 ```swift
-amuseProvider.catalog(.musicVideos, ids: ["123", "456", "789"])
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
-```
-
-### Retrieve multiple Playlists from Apple Music catalog by ids.
-
-```swift
-amuseProvider.catalog(.playlists, ids: ["123", "456", "789"])
+amuseProvider.catalog(.albums, ids: ["123", "456", "789"])
     .sink { _ in
     } receiveValue: { response in
         print(response.data)
     }
 ```
 
-### Retrieve multiple Songs from Apple Music catalog by ids.
+### Search on Apple Music catalog.
 
 ```swift
-amuseProvider.catalog(.songs, ids: ["123", "456", "789"])
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
+let response = try await amuseProvider.catalogSearch(searchTerm: "YOUR_QUERY_TEXT")
+print(response.results?.albums)
+print(response.results?.artists)
+print(response.results?.musicVideos)
+print(response.results?.playlists)
+print(response.results?.songs)
+print(response.results?.stations)
 ```
 
-### Search on Apple Music catalog.
-
 ```swift
 amuseProvider.catalogSearch(searchTerm: "YOUR_QUERY_TEXT")
     .sink { _ in
     } receiveValue: { response in
         // content will be found under results properties.
         print(response.results?.albums)
         print(response.results?.artists)
+        print(response.results?.musicVideos)
         print(response.results?.playlists)
         print(response.results?.songs)
+        print(response.results?.stations)
     }
 ```
 
-### Search on Apple Music catalog for specific types.
+### Search on Apple Music catalog for specific resources types.
 
 ```swift
-amuseProvider.catalogSearch([.playlists, .songs], searchTerm: "YOUR_QUERY_TEXT")
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.results?.playlists)
-        print(response.results?.songs)
-    }
+let response = try await amuseProvider.catalogSearch([.playlists, .songs], searchTerm: "YOUR_QUERY_TEXT")
+print(response.results?.playlists)
+print(response.results?.songs)
 ```
 
-### Retrieve All User's Library Albums.
-
 ```swift
-amuseProvider.library(.albums)
+amuseProvider.catalogSearch([.playlists, .songs], searchTerm: "YOUR_QUERY_TEXT")
     .sink { _ in
     } receiveValue: { response in
-        print(response.data)
+        print(response.results?.playlists)
+        print(response.results?.songs)
     }
 ```
 
-### Retrieve All User's Library Artists.
+### Retrieve User Library resources.
 
-```swift
-amuseProvider.library(.artists)
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
-```
-
-### Retrieve All User Library Music Videos.
+Supported values are: `albums, artists, musicVideos, playlists, songs`.
 
 ```swift
-amuseProvider.library(.musicVideos)
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
+let response = try await dataProvider.library(.albums)
+print(response.data)
 ```
 
-### Retrieve All User's Library Playlists.
-
 ```swift
-amuseProvider.library(.playlists)
+amuseProvider.library(.albums)
     .sink { _ in
     } receiveValue: { response in
         print(response.data)
     }
 ```
 
-### Retrieve All User's Library Songs.
+### Search on User Library.
 
 ```swift
-amuseProvider.library(.songs)
-    .sink { _ in
-    } receiveValue: { response in
-        print(response.data)
-    }
+let response = try await amuseProvider.librarySearch(searchTerm: "YOUR_QUERY_TEXT")
+print(response.results?.albums)
+print(response.results?.artists)
+print(response.results?.musicVideos)
+print(response.results?.playlists)
+print(response.results?.songs)
 ```
 
-### Search on User's Library.
-
 ```swift
 amuseProvider.librarySearch(searchTerm: "YOUR_QUERY_TEXT")
     .sink { _ in
     } receiveValue: { response in
         // content will be found under results properties.
         print(response.results?.albums)
         print(response.results?.artists)
+        print(response.results?.musicVideos)
         print(response.results?.playlists)
         print(response.results?.songs)
     }
 ```
 
-### Search on User's Library for specific types.
+### Search on User Library for specific resources types.
+
+```swift
+let response = try await amuseProvider.librarySearch([.playlists, .songs], searchTerm: "YOUR_QUERY_TEXT")
+print(response.results?.playlists)
+print(response.results?.songs)
+```
 
 ```swift
 amuseProvider.librarySearch([.playlists, .songs], searchTerm: "YOUR_QUERY_TEXT")

Sources/AmuseKit/AmuseKit.swift

@@ -7,16 +7,14 @@
 
 import Foundation
 
-protocol AmuseOption: RawRepresentable, Hashable, CaseIterable {}
+public enum AmuseKit {}
 
-public class AmuseKit {
-    enum AmuseError: Error {
-        case missingDevToken
-        case missingUserToken
-    }
+enum AmuseKitError: Error {
+    case missingDevToken
+    case missingUserToken
 }
 
-extension AmuseKit.AmuseError: LocalizedError {
+extension AmuseKitError: LocalizedError {
     public var errorDescription: String? {
         switch self {
         case .missingDevToken:
@@ -26,3 +24,4 @@ extension AmuseKit.AmuseError: LocalizedError {
         }
     }
 }
+

Sources/AmuseKit/Models/Relationship.swift

@@ -17,14 +17,15 @@ public extension AmuseKit {
         public let href: String
         public let next: String?
     }
+    
+    typealias CuratorsRelationship = Relationship<CuratorResource>
+    typealias GenresRelationship = Relationship<GenreResource>
 
-    typealias AlbumsRelationship = Relationship<Album>
-    typealias ArtistsRelationship = Relationship<Artist>
-    typealias CuratorsRelationship = Relationship<Curator>
-    typealias GenresRelationship = Relationship<Genre>
-    typealias MusicVideosRelationship = Relationship<MusicVideo>
-    typealias PlaylistRelationship = Relationship<Playlist>
-    typealias SongRelationship = Relationship<Song>
+    typealias CatalogAlbumsRelationship = Relationship<CatalogAlbum>
+    typealias CatalogArtistsRelationship = Relationship<CatalogArtist>
+    typealias CatalogMusicVideosRelationship = Relationship<CatalogMusicVideo>
+    typealias CatalogPlaylistsRelationship = Relationship<CatalogPlaylist>
+    typealias CatalogSongsRelationship = Relationship<CatalogSong>
 
     typealias LibraryAlbumsRelationship = Relationship<LibraryAlbum>
     typealias LibraryArtistsRelationship = Relationship<LibraryArtist>

Sources/AmuseKit/Models/Resource.swift

@@ -19,3 +19,58 @@ protocol Resource: Codable, Identifiable {
     var relationships: Relationships? { get }
     var type: String { get }
 }
+
+// An object that represents artwork.
+// https://developer.apple.com/documentation/applemusicapi/artwork
+
+public struct ResourceArtwork: Codable {
+    public let bgColor: String?
+    public let height: Int?
+    public let width: Int?
+    public let textColor1: String?
+    public let textColor2: String?
+    public let textColor3: String?
+    public let textColor4: String?
+    public let url: String
+}
+
+public extension ResourceArtwork {
+    typealias ArtworkSize = (width: Int, height: Int)
+    /// Returns artwork formatted url for specific size when possible.
+    /// if `size` parameter is nil `width` & `height` properties will be used as default values for size.
+    /// if `width` and `height` property are also nil full size image URL will be returned.
+    func formattedURL(size: ArtworkSize? = nil) -> URL? {
+        guard let width = size?.width ?? width, let height = size?.height ?? height else {
+            return URL(string: url)
+        }
+        
+        return URL(string: url.replacingOccurrences(of: "{w}x{h}", with: "\(width)x\(height)"))
+    }
+}
+
+// An object that represents notes.
+// https://developer.apple.com/documentation/applemusicapi/editorialnotes
+
+public struct ResourceEditorialNotes: Codable {
+    public var short: String?
+    public var standard: String?
+}
+
+// An object that represents play parameters for resources.
+// https://developer.apple.com/documentation/applemusicapi/playparameters
+
+public struct ResourcePlayParameters: Codable {
+    public let id: String
+    public let kind: String
+    public let catalogId: String?
+    public let isLibrary: Bool?
+    public let reporting: Bool?
+}
+
+// An object that represents a preview for resources.
+// https://developer.apple.com/documentation/applemusicapi/preview
+
+public struct ResourcePreview: Codable {
+    public let artwork: ResourceArtwork?
+    public let url: String
+}