Merge branch 'dev' of github.com:adamint/spotify-web-api-kotlin into dev

Author: adamint

src/commonMain/kotlin/com.adamratzman.spotify/models/Albums.kt

@@ -35,9 +35,9 @@ data class SimpleAlbum(
     @SerialName("album_type") private val albumTypeString: String,
     @SerialName("available_markets") private val availableMarketsString: List<String> = listOf(),
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
-    @SerialName("uri") private val uriString: String,
+    override val href: String,
+    override val id: String,
+    override val uri: AlbumUri,
 
     val artists: List<SimpleArtist>,
     val images: List<SpotifyImage>,
@@ -48,9 +48,7 @@ data class SimpleAlbum(
     @SerialName("release_date_precision") val releaseDatePrecision: String,
     @SerialName("total_tracks") val totalTracks: Int? = null,
     @SerialName("album_group") private val albumGroupString: String? = null
-) : CoreObject(href, id, AlbumUri(uriString), externalUrlsString) {
-    override val uri: AlbumUri get() = super.uri as AlbumUri
-
+) : CoreObject() {
     @Transient
     val availableMarkets = availableMarketsString.map { Market.valueOf(it) }
 
@@ -118,11 +116,11 @@ enum class AlbumResultType(internal val id: String) {
 data class Album(
     @SerialName("album_type") private val albumTypeString: String,
     @SerialName("available_markets") private val availableMarketsString: List<String> = listOf(),
-    @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
     @SerialName("external_ids") private val externalIdsString: Map<String, String> = hashMapOf(),
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
-    @SerialName("uri") private val uriString: String,
+    @SerialName("external_urls") override val externalUrlsString: Map<String, String> = mapOf(),
+    override val href: String,
+    override val id: String,
+    override val uri: AlbumUri,
 
     val artists: List<SimpleArtist>,
     val copyrights: List<SpotifyCopyright>,
@@ -137,8 +135,7 @@ data class Album(
     val type: String,
     @SerialName("total_tracks") val totalTracks: Int,
     val restrictions: Restrictions? = null
-) : CoreObject(href, id, AlbumUri(uriString), externalUrlsString) {
-    override val uri: AlbumUri get() = super.uri as AlbumUri
+) : CoreObject() {
 
     @Transient
     val availableMarkets = availableMarketsString.map { Market.valueOf(it) }

src/commonMain/kotlin/com.adamratzman.spotify/models/Artists.kt

@@ -15,14 +15,13 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class SimpleArtist(
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
-    @SerialName("uri") private val uriString: String,
+    override val href: String,
+    override val id: String,
+    override val uri: ArtistUri,
 
     val name: String,
     val type: String
-) : CoreObject(href, id, ArtistUri(uriString), externalUrlsString) {
-    override val uri: ArtistUri get() = super.uri as ArtistUri
+) : CoreObject() {
 
     /**
      * Converts this [SimpleArtist] into a full [Artist] object
@@ -47,19 +46,17 @@ data class SimpleArtist(
 @Serializable
 data class Artist(
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
-    @SerialName("uri") private val uriString: String,
+    override val href: String,
+    override val id: String,
+    override val uri: ArtistUri,
 
     val followers: Followers,
     val genres: List<String>,
     val images: List<SpotifyImage>,
     val name: String,
     val popularity: Int,
     val type: String
-) : CoreObject(href, id, ArtistUri(uriString), externalUrlsString) {
-    override val uri: ArtistUri get() = super.uri as ArtistUri
-}
+) : CoreObject()
 
 @Serializable
 internal data class ArtistList(val artists: List<Artist?>)

src/commonMain/kotlin/com.adamratzman.spotify/models/Browse.kt

@@ -14,12 +14,12 @@ import kotlinx.serialization.Serializable
  */
 @Serializable
 data class SpotifyCategory(
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
+    override val href: String,
+    override val id: String,
 
     val icons: List<SpotifyImage>,
     val name: String
-) : Identifiable(href, id)
+) : Identifiable()
 
 /**
  * Seed from which the recommendation was constructed
@@ -42,7 +42,7 @@ data class RecommendationSeed(
     val afterFilteringSize: Int,
     val afterRelinkingSize: Int? = null,
     val type: String
-) : Identifiable(href, id)
+) : Identifiable()
 
 /**
  * @property seeds An array of recommendation seed objects.

src/commonMain/kotlin/com.adamratzman.spotify/models/Player.kt

@@ -12,22 +12,15 @@ import kotlinx.serialization.Transient
  * @property type The object type, e.g. “artist”, “playlist”, “album”.
  * @property href A link to the Web API endpoint providing full details of the track.
  */
-@Serializable
+@Serializable // TODO remove id. It's wrong to extend CoreObject here, as it doesn't has any id
 data class PlayHistoryContext(
-    @SerialName("href") override val href: String,
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
-    @SerialName("uri") private val uriString: String,
-
-    val type: String
-) : CoreObject(
-    href, href, when (type) {
-        "artist" -> ArtistUri(uriString)
-        "playlist" -> PlaylistUri(uriString)
-        else -> AlbumUri(uriString)
-    }, externalUrlsString
-) {
-    override val uri: TrackUri get() = super.uri as TrackUri
-}
+    override val href: String,
+    override val uri: SpotifyUri,
+
+    val type: String,
+    override val id: String = TRANSIENT_EMPTY_STRING
+) : CoreObject()
 
 /**
  * Information about a previously-played track
@@ -56,17 +49,18 @@ data class PlayHistory(
  */
 @Serializable
 data class Device(
-    @SerialName("id") override val id: String? = null,
-
+    override val id: String? = null,
     @SerialName("is_active") val isActive: Boolean,
     @SerialName("is_private_session") val isPrivateSession: Boolean,
     @SerialName("is_restricted") val isRestricted: Boolean,
     val name: String,
     val typeString: String,
     @SerialName("volume_percent") val volumePercent: Int
-) : IdentifiableNullable(null, id) {
+) : IdentifiableNullable() {
     @Transient
     val type: DeviceType = DeviceType.values().first { it.identifier.equals(typeString, true) }
+
+    override val href: String? = null
 }
 
 /**

src/commonMain/kotlin/com.adamratzman.spotify/models/Playlist.kt

@@ -33,9 +33,9 @@ import kotlinx.serialization.Transient
 @Serializable
 data class SimplePlaylist(
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
-    @SerialName("uri") private val uriString: String,
+    override val href: String,
+    override val id: String,
+    override val uri: PlaylistUri,
 
     val collaborative: Boolean,
     val images: List<SpotifyImage>,
@@ -47,8 +47,7 @@ data class SimplePlaylist(
     @SerialName("snapshot_id") private val snapshotIdString: String,
     val tracks: PlaylistTrackInfo,
     val type: String
-) : CoreObject(href, id, PlaylistUri(uriString), externalUrlsString) {
-    override val uri: PlaylistUri get() = super.uri as PlaylistUri
+) : CoreObject() {
 
     @Transient
     val snapshot: PlaylistSnapshot = PlaylistSnapshot(snapshotIdString)
@@ -107,9 +106,9 @@ data class PlaylistTrack(
 @Serializable
 data class Playlist(
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
-    @SerialName("href") override val href: String,
-    @SerialName("id") override val id: String,
-    @SerialName("uri") private val uriString: String,
+    override val href: String,
+    override val id: String,
+    override val uri: PlaylistUri,
 
     val collaborative: Boolean,
     val description: String? = null,
@@ -122,8 +121,7 @@ data class Playlist(
     @SerialName("snapshot_id") private val snapshotIdString: String,
     val tracks: PagingObject<PlaylistTrack>,
     val type: String
-) : CoreObject(href, id, PlaylistUri(uriString), externalUrlsString) {
-    override val uri: PlaylistUri get() = super.uri as PlaylistUri
+) : CoreObject() {
 
     @Transient
     val snapshot: PlaylistSnapshot = PlaylistSnapshot(snapshotIdString)

src/commonMain/kotlin/com.adamratzman.spotify/models/ResultObjects.kt

@@ -10,17 +10,14 @@ import kotlinx.serialization.Serializable
 import kotlinx.serialization.Transient
 
 internal const val TRANSIENT_EMPTY_STRING = ""
-internal val TRANSIENT_NULL = null
-internal val TRANSIENT_URI = UserUri("TRANSIENT_URI")
 
 /**
  * Represents an identifiable Spotify object such as an Album or Recommendation Seed
  */
 @Serializable
-abstract class Identifiable(
-    @Transient override val href: String? = TRANSIENT_NULL,
-    @Transient override val id: String = TRANSIENT_EMPTY_STRING
-) : IdentifiableNullable(id, href)
+abstract class Identifiable : IdentifiableNullable() {
+    abstract override val id: String
+}
 
 /**
  * Represents an identifiable Spotify object such as an Album or Recommendation Seed
@@ -29,10 +26,10 @@ abstract class Identifiable(
  * @property id The Spotify id of the associated object
  */
 @Serializable
-abstract class IdentifiableNullable(
-    @Transient open val href: String? = TRANSIENT_NULL,
-    @Transient open val id: String? = TRANSIENT_NULL
-) : NeedsApi()
+abstract class IdentifiableNullable : NeedsApi() {
+    abstract val href: String?
+    abstract val id: String?
+}
 
 /**
  * Represents a core Spotify object such as a Track or Album
@@ -41,23 +38,16 @@ abstract class IdentifiableNullable(
  * @property externalUrls Known external URLs for this object
  */
 @Serializable
-abstract class CoreObject(
-    @Transient override val href: String = TRANSIENT_EMPTY_STRING,
-    @Transient override val id: String = TRANSIENT_EMPTY_STRING,
-    @Transient open val uri: SpotifyUri = TRANSIENT_URI,
-    @Transient internal open val externalUrlsString: Map<String, String> = mapOf()
-) : Identifiable(href, id) {
+abstract class CoreObject : Identifiable() {
+    protected abstract val externalUrlsString: Map<String, String>
+    abstract override val href: String
+    abstract val uri: SpotifyUri
     val externalUrls: List<ExternalUrl> get() = externalUrlsString.map { ExternalUrl(it.key, it.value) }
 }
 
 @Serializable
-abstract class RelinkingAvailableResponse(
-    @Transient val linkedTrack: LinkedTrack? = TRANSIENT_NULL,
-    @Transient override val href: String = TRANSIENT_EMPTY_STRING,
-    @Transient override val id: String = TRANSIENT_EMPTY_STRING,
-    @Transient override val uri: SpotifyUri = TRANSIENT_URI,
-    @Transient override val externalUrlsString: Map<String, String> = mapOf()
-) : CoreObject(href, id, uri, externalUrlsString) {
+abstract class RelinkingAvailableResponse : CoreObject() {
+    @SerialName("linked_from") abstract val linkedTrack: LinkedTrack?
     fun isRelinked() = linkedTrack != null
 }
 
@@ -80,6 +70,7 @@ class ExternalId(val key: String, val id: String)
  *
  * @property api The API client associated with the request
  */
+@Serializable
 abstract class NeedsApi {
     @Transient
     lateinit var api: SpotifyApi<*, *>