Newer
Older
function searchPlaylists(query: string): PlaylistPager {
check_and_update_token()
return new SpotifyPlaylistsPager(query, 0, 10)
}
class SpotifyPlaylistsPager extends PlaylistPager {
private offset: number
constructor(
private readonly query: string,
offset: number,
private readonly limit: number
) {
const { url, headers } = search_args(query, offset, limit)
const search_response: SearchResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const has_more = are_more_playlist_results(search_response, offset, limit)
super(format_playlist_results(search_response), has_more)
this.offset = offset + limit
}
override nextPage(this: SpotifyPlaylistsPager): SpotifyPlaylistsPager {
const { url, headers } = search_args(this.query, this.offset, this.limit)
const search_response: SearchResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
this.results = format_playlist_results(search_response)
this.hasMore = are_more_playlist_results(search_response, this.offset, this.limit)
this.offset = this.offset + this.limit
return this
}
override hasMorePagers(this: SpotifyPlaylistsPager): boolean {
return this.hasMore
}
}
function format_playlist_results(search_response: SearchResponse) {
return [
...search_response.data.searchV2.albumsV2.items.map(function (album) {
const album_artist = album.data.artists.items[0]
if (album_artist === undefined) {
throw new ScriptException("missing album artist")
}
return new PlatformPlaylist({
id: new PlatformID(PLATFORM, id_from_uri(album.data.uri), plugin.config.id),
name: album.data.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, id_from_uri(album_artist.uri), plugin.config.id),
album_artist.profile.name,
`${ARTIST_URL_PREFIX}${id_from_uri(album_artist.uri)}`
),
datetime: new Date(album.data.date.year, 0).getTime() / 1000,
url: `${ALBUM_URL_PREFIX}${id_from_uri(album.data.uri)}`,
// TODO load this some other way videoCount?: number
thumbnail: album.data.coverArt.sources[0]?.url ?? HARDCODED_EMPTY_STRING
})
}),
...search_response.data.searchV2.playlists.items.map(function (playlist) {
const created_iso = playlist.data.attributes.find(function (attribute) {
return attribute.key === "created"
})?.value
const platform_playlist = {
id: new PlatformID(PLATFORM, id_from_uri(playlist.data.uri), plugin.config.id),
name: playlist.data.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, playlist.data.ownerV2.data.username, plugin.config.id),
playlist.data.ownerV2.data.name,
`${USER_URL_PREFIX}${playlist.data.ownerV2.data.username}`
),
url: `${PLAYLIST_URL_PREFIX}${id_from_uri(playlist.data.uri)}`,
// TODO load this some other way videoCount?: number
thumbnail: playlist.data.images.items[0]?.sources[0]?.url ?? HARDCODED_EMPTY_STRING
}
if (created_iso === undefined) {
return new PlatformPlaylist(platform_playlist)
}
return new PlatformPlaylist({
...platform_playlist,
datetime: new Date(created_iso).getTime() / 1000,
})
})
]
}
function are_more_playlist_results(search_response: SearchResponse, current_offset: number, limit: number): boolean {
return search_response.data.searchV2.albumsV2.totalCount > current_offset + limit
|| search_response.data.searchV2.playlists.totalCount > current_offset + limit
}
function getPlaylist(url: string): PlatformPlaylistDetails {
check_and_update_token()
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
const match_result = url.match(PLAYLIST_REGEX)
if (match_result === null) {
throw new ScriptException("regex error")
}
const maybe_playlist_type = match_result[1]
if (maybe_playlist_type === undefined) {
throw new ScriptException("regex error")
}
const playlist_type: PlaylistType = maybe_playlist_type as PlaylistType
const playlist_uri_id = match_result[2]
if (playlist_uri_id === undefined) {
throw new ScriptException("regex error")
}
switch (playlist_type) {
case "album": {
// if the author is the same as the album then include the artist pick otherwise nothing
// TODO we could load in extra info for all the other artists but it might be hard to do that in a request efficient way
const pagination_limit = 50 as const
const offset = 0
const { url, headers } = album_metadata_args(playlist_uri_id, offset, pagination_limit)
const album_metadata_response: AlbumResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
const album_artist = album_metadata_response.data.albumUnion.artists.items[0]
if (album_artist === undefined) {
throw new ScriptException("missing album artist")
}
const unix_time = new Date(album_metadata_response.data.albumUnion.date.isoString).getTime() / 1000
return new PlatformPlaylistDetails({
id: new PlatformID(PLATFORM, playlist_uri_id, plugin.config.id),
name: album_metadata_response.data.albumUnion.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, album_artist.id, plugin.config.id),
album_artist.profile.name,
`${ARTIST_URL_PREFIX}${album_artist.id}`,
album_artist.visuals.avatarImage.sources[album_artist.visuals.avatarImage.sources.length - 1]?.url
),
datetime: unix_time,
url: `${ALBUM_URL_PREFIX}${playlist_uri_id}`,
videoCount: album_metadata_response.data.albumUnion.tracks.totalCount,
contents: new AlbumPager(playlist_uri_id, offset, pagination_limit, album_metadata_response, album_artist, unix_time)
})
}
case "playlist": {
if (!bridge.isLoggedIn()) {
throw new LoginRequiredException("login to open playlists")
}
const pagination_limit = 25 as const
const offset = 0
const { url, headers } = fetch_playlist_args(playlist_uri_id, offset, pagination_limit)
const playlist_response: PlaylistResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const owner = playlist_response.data.playlistV2.ownerV2.data
return new PlatformPlaylistDetails({
id: new PlatformID(PLATFORM, playlist_uri_id, plugin.config.id),
name: playlist_response.data.playlistV2.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, owner.username, plugin.config.id),
owner.name,
`${ARTIST_URL_PREFIX}${owner.username}`,
owner.avatar?.sources[owner.avatar.sources.length - 1]?.url
),
url: `${ALBUM_URL_PREFIX}${playlist_uri_id}`,
videoCount: playlist_response.data.playlistV2.content.totalCount,
contents: new SpotifyPlaylistPager(playlist_uri_id, offset, pagination_limit, playlist_response)
})
}
case "collection": {
if (!bridge.isLoggedIn()) {
throw new LoginRequiredException("login to open collections")
}
const collection_type: CollectionType = playlist_uri_id as CollectionType
switch (collection_type) {
case "your-episodes": {
const limit = 50
const { url, headers } = liked_episodes_args(0, limit)
const response: LikedEpisodesResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const username = local_state.username
if (username === undefined) {
throw new ScriptException("unreachable")
}
return new PlatformPlaylistDetails({
id: new PlatformID(PLATFORM, collection_type, plugin.config.id),
name: "Your Episodes",
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, username, plugin.config.id),
username, // TODO replace this with the signed in user's display name
`${USER_URL_PREFIX}${username}`
),
url: "https://open.spotify.com/collection/your-episodes",
videoCount: response.data.me.library.episodes.totalCount,
contents: new LikedEpisodesPager(0, limit, response)
})
}
case "tracks": {
const limit = 50
const { url, headers } = liked_songs_args(0, limit)
const response: LikedTracksResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
const username = local_state.username
if (username === undefined) {
throw new ScriptException("unreachable")
}
return new PlatformPlaylistDetails({
id: new PlatformID(PLATFORM, collection_type, plugin.config.id),
name: "Liked Songs",
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, username, plugin.config.id),
username, // TODO replace this with the signed in user's display name
`${USER_URL_PREFIX}${username}`
),
url: "https://open.spotify.com/collection/tracks",
videoCount: response.data.me.library.tracks.totalCount,
contents: new LikedTracksPager(0, limit, response)
})
}
default:
throw assert_exhaustive(collection_type, "unreachable")
}
}
throw assert_exhaustive(playlist_type, "unreachable")
class LikedEpisodesPager extends VideoPager {
private offset: number
private readonly total_tracks: number
constructor(
offset: number,
private readonly pagination_limit: number,
collection_response: LikedEpisodesResponse
) {
const total_tracks = collection_response.data.me.library.episodes.totalCount
const episodes = format_collection_episodes(collection_response)
super(episodes, total_tracks > offset + pagination_limit)
this.offset = offset + pagination_limit
this.total_tracks = total_tracks
}
override nextPage(this: LikedEpisodesPager): LikedEpisodesPager {
const { url, headers } = liked_episodes_args(this.offset, this.pagination_limit)
const response: LikedEpisodesResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const episodes = format_collection_episodes(response)
this.results = episodes
this.hasMore = this.total_tracks > this.offset + this.pagination_limit
this.offset += this.pagination_limit
return this
}
override hasMorePagers(this: LikedEpisodesPager): boolean {
return this.hasMore
}
}
function format_collection_episodes(response: LikedEpisodesResponse) {
return response.data.me.library.episodes.items.map(function (episode) {
if (episode.episode.data.podcastV2.data.__typename === "NotFound" || episode.episode.data.releaseDate === null) {
throw new ScriptException("unreachable")
}
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
return new PlatformVideo({
id: new PlatformID(PLATFORM, id_from_uri(episode.episode._uri), plugin.config.id),
name: episode.episode.data.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, id_from_uri(episode.episode.data.podcastV2.data.uri), plugin.config.id),
episode.episode.data.podcastV2.data.name,
`${SHOW_URL_PREFIX}${id_from_uri(episode.episode.data.podcastV2.data.uri)}`,
episode.episode.data.podcastV2.data.coverArt?.sources[0]?.url
),
datetime: new Date(episode.episode.data.releaseDate.isoString).getTime() / 1000,
url: `${EPISODE_URL_PREFIX}${id_from_uri(episode.episode._uri)}`,
thumbnails: new Thumbnails(episode.episode.data.coverArt.sources.map(function (image) {
return new Thumbnail(image.url, image.height)
})),
duration: episode.episode.data.duration.totalMilliseconds / 1000,
viewCount: HARDCODED_ZERO,
isLive: false,
shareUrl: `${EPISODE_URL_PREFIX}${id_from_uri(episode.episode._uri)}`
})
})
}
class LikedTracksPager extends VideoPager {
private offset: number
private readonly total_tracks: number
constructor(
offset: number,
private readonly pagination_limit: number,
collection_response: LikedTracksResponse
) {
const total_tracks = collection_response.data.me.library.tracks.totalCount
const episodes = format_collection_tracks(collection_response)
super(episodes, total_tracks > offset + pagination_limit)
this.offset = offset + pagination_limit
this.total_tracks = total_tracks
}
override nextPage(this: LikedTracksPager): LikedTracksPager {
const { url, headers } = liked_songs_args(this.offset, this.pagination_limit)
const response: LikedTracksResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
const episodes = format_collection_tracks(response)
this.results = episodes
this.hasMore = this.total_tracks > this.offset + this.pagination_limit
this.offset += this.pagination_limit
return this
}
override hasMorePagers(this: LikedTracksPager): boolean {
return this.hasMore
}
}
function format_collection_tracks(response: LikedTracksResponse) {
return response.data.me.library.tracks.items.map(function (track) {
const artist = track.track.data.artists.items[0]
if (artist === undefined) {
throw new ScriptException("missing song artist")
}
return new PlatformVideo({
id: new PlatformID(PLATFORM, id_from_uri(track.track._uri), plugin.config.id),
name: track.track.data.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, id_from_uri(artist.uri), plugin.config.id),
artist.profile.name,
`${ARTIST_URL_PREFIX}${id_from_uri(artist.uri)}`,
),
datetime: HARDCODED_ZERO,
url: `${SONG_URL_PREFIX}${id_from_uri(track.track._uri)}`,
thumbnails: new Thumbnails(track.track.data.albumOfTrack.coverArt.sources.map(function (image) {
return new Thumbnail(image.url, image.height)
})),
duration: track.track.data.duration.totalMilliseconds / 1000,
viewCount: HARDCODED_ZERO,
isLive: false,
shareUrl: `${SONG_URL_PREFIX}${id_from_uri(track.track._uri)}`
})
})
}
class SpotifyPlaylistPager extends VideoPager {
private offset: number
private readonly total_tracks: number
constructor(
private readonly playlist_uri_id: string,
offset: number,
private readonly pagination_limit: number,
playlist_response: PlaylistResponse
) {
const total_tracks = playlist_response.data.playlistV2.content.totalCount
const songs = format_playlist_tracks(playlist_response.data.playlistV2.content)
super(songs, total_tracks > offset + pagination_limit)
this.offset = offset + pagination_limit
this.total_tracks = total_tracks
}
override nextPage(this: SpotifyPlaylistPager): SpotifyPlaylistPager {
const { url, headers } = fetch_playlist_contents_args(this.playlist_uri_id, this.offset, this.pagination_limit)
const playlist_content_response: PlaylistContentResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const songs = format_playlist_tracks(playlist_content_response.data.playlistV2.content)
this.results = songs
this.hasMore = this.total_tracks > this.offset + this.pagination_limit
this.offset += this.pagination_limit
return this
}
override hasMorePagers(this: SpotifyPlaylistPager): boolean {
return this.hasMore
}
}
function format_playlist_tracks(content: PlaylistContent) {
return content.items.flatMap(function (playlist_track_metadata) {
if (playlist_track_metadata.itemV2.__typename === "LocalTrackResponseWrapper") {
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
const song = playlist_track_metadata.itemV2.data
const track_uri_id = id_from_uri(song.uri)
const artist = song.artists.items[0]
if (artist === undefined) {
throw new ScriptException("missing artist")
}
const url = `${SONG_URL_PREFIX}${track_uri_id}`
return new PlatformVideo({
id: new PlatformID(PLATFORM, track_uri_id, plugin.config.id),
name: song.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, id_from_uri(artist.uri), plugin.config.id),
artist.profile.name,
`${ARTIST_URL_PREFIX}${id_from_uri(artist.uri)}`
// TODO figure out a way to get the artist thumbnail
),
url,
thumbnails: new Thumbnails(song.albumOfTrack.coverArt.sources.map(function (source) {
return new Thumbnail(source.url, source.height)
})),
duration: song.trackDuration.totalMilliseconds / 1000,
viewCount: parseInt(song.playcount),
isLive: false,
shareUrl: url,
datetime: new Date(playlist_track_metadata.addedAt.isoString).getTime() / 1000
})
})
}
/**
*
* @param playlist_uri_id
* @param offset the track to start loading from in the album (0 is the first track)
* @param limit the maximum number of tracks to load information about
* @returns
*/
function fetch_playlist_contents_args(playlist_uri_id: string, offset: number, limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:playlist:${playlist_uri_id}`,
offset: offset,
limit: limit
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "91d4c2bc3e0cd1bc672281c4f1f59f43ff55ba726ca04a45810d99bd091f3f0e"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "fetchPlaylistContents")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
/**
*
* @param playlist_uri_id
* @param offset the track to start loading from in the album (0 is the first track)
* @param limit the maximum number of tracks to load information about
* @returns
*/
function fetch_playlist_args(playlist_uri_id: string, offset: number, limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:playlist:${playlist_uri_id}`,
offset: offset,
limit: limit
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "91d4c2bc3e0cd1bc672281c4f1f59f43ff55ba726ca04a45810d99bd091f3f0e"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "fetchPlaylist")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
class AlbumPager extends VideoPager {
private offset: number
private readonly thumbnails: Thumbnails
private readonly album_artist: ArtistDetails
private readonly unix_time: number
private readonly total_tracks: number
constructor(
private readonly album_uri_id: string,
offset: number,
private readonly pagination_limit: number,
album_metadata_response: AlbumResponse,
album_artist: ArtistDetails,
unix_time: number,
) {
const total_tracks = album_metadata_response.data.albumUnion.tracks.totalCount
const thumbnails = new Thumbnails(album_metadata_response.data.albumUnion.coverArt.sources.map(function (source) {
return new Thumbnail(source.url, source.height)
}))
const songs = format_album_tracks(album_metadata_response.data.albumUnion.tracks, thumbnails, album_artist, unix_time)
super(songs, total_tracks > offset + pagination_limit)
this.offset = offset + pagination_limit
this.thumbnails = thumbnails
this.album_artist = album_artist
this.unix_time = unix_time
this.total_tracks = total_tracks
}
override nextPage(this: AlbumPager): AlbumPager {
const { url, headers } = album_tracks_args(this.album_uri_id, this.offset, this.pagination_limit)
const album_tracks_response: AlbumTracksResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
const songs = format_album_tracks(album_tracks_response.data.albumUnion.tracks, this.thumbnails, this.album_artist, this.unix_time)
this.results = songs
this.hasMore = this.total_tracks > this.offset + this.pagination_limit
this.offset += this.pagination_limit
return this
}
override hasMorePagers(this: AlbumPager): boolean {
return this.hasMore
}
}
function format_album_tracks(tracks: Tracks, thumbnails: Thumbnails, album_artist: ArtistDetails, unix_time: number) {
return tracks.items.map(function (track) {
const track_uri_id = id_from_uri(track.track.uri)
const artist = track.track.artists.items[0]
if (artist === undefined) {
throw new ScriptException("missing artist")
}
const url = `${SONG_URL_PREFIX}${track_uri_id}`
return new PlatformVideo({
id: new PlatformID(PLATFORM, track_uri_id, plugin.config.id),
name: track.track.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, id_from_uri(artist.uri), plugin.config.id),
artist.profile.name,
`${ARTIST_URL_PREFIX}${id_from_uri(artist.uri)}`,
id_from_uri(artist.uri) === album_artist.id ? album_artist.visuals.avatarImage.sources[album_artist.visuals.avatarImage.sources.length - 1]?.url : undefined
),
url,
thumbnails,
duration: track.track.duration.totalMilliseconds / 1000,
viewCount: parseInt(track.track.playcount),
isLive: false,
shareUrl: url,
datetime: unix_time
})
})
}
/**
*
* @param album_uri_id
* @param offset the track to start loading from in the album (0 is the first track)
* @param limit the maximum number of tracks to load information about
* @returns
*/
function album_tracks_args(album_uri_id: string, offset: number, limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:album:${album_uri_id}`,
offset: offset,
limit: limit
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "469874edcad37b7a379d4f22f0083a49ea3d6ae097916120d9bbe3e36ca79e9d"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "queryAlbumTracks")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
/**
*
* @param album_uri_id
* @param offset the track to start loading from in the album (0 is the first track)
* @param limit the maximum number of tracks to load information about
* @returns
*/
function album_metadata_args(album_uri_id: string, offset: number, limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:album:${album_uri_id}`,
locale: "",
offset: offset,
limit: limit
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "469874edcad37b7a379d4f22f0083a49ea3d6ae097916120d9bbe3e36ca79e9d"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "getAlbum")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
//#region channel
// https://open.spotify.com/show/4Pgcpzc9b3qTxyUr9DkXEn
// https://open.spotify.com/show/5VzFvh1JlEhBMS6ZHZ8CNO
// https://open.spotify.com/artist/1HtB6hptdVyK6cBTm9SMTu
// https://open.spotify.com/user/zelladay
// https://open.spotify.com/genre/0JQ5DAt0tbjZptfcdMSKl3
// https://open.spotify.com/genre/section0JQ5DACFo5h0jxzOyHOsIe
function isChannelUrl(url: string): boolean {
return CHANNEL_REGEX.test(url)
}
function searchChannels(query: string): ChannelPager {
check_and_update_token()
return new SpotifyChannelPager(query, 0, 10)
}
class SpotifyChannelPager extends ChannelPager {
private offset: number
constructor(
private readonly query: string,
offset: number,
private readonly limit: number
) {
const { url, headers } = search_args(query, offset, limit)
const search_response: SearchResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const has_more = are_more_channel_results(search_response, offset, limit)
super(format_channel_results(search_response), has_more)
this.offset = offset + limit
}
override nextPage(this: SpotifyChannelPager): SpotifyChannelPager {
const { url, headers } = search_args(this.query, this.offset, this.limit)
const search_response: SearchResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
this.results = format_channel_results(search_response)
this.hasMore = are_more_channel_results(search_response, this.offset, this.limit)
this.offset = this.offset + this.limit
return this
}
override hasMorePagers(this: SpotifyChannelPager): boolean {
return this.hasMore
}
}
function are_more_channel_results(search_response: SearchResponse, current_offset: number, limit: number): boolean {
return search_response.data.searchV2.artists.totalCount > current_offset + limit
|| search_response.data.searchV2.podcasts.totalCount > current_offset + limit
|| search_response.data.searchV2.audiobooks.totalCount > current_offset + limit
|| search_response.data.searchV2.users.totalCount > current_offset + limit
|| search_response.data.searchV2.genres.totalCount > current_offset + limit
}
function format_channel_results(search_response: SearchResponse): PlatformChannel[] {
return [
...search_response.data.searchV2.artists.items.map(function (artist) {
const thumbnail = artist.data.visuals.avatarImage?.sources[0]?.url ?? HARDCODED_EMPTY_STRING
return new PlatformChannel({
id: new PlatformID(PLATFORM, id_from_uri(artist.data.uri), plugin.config.id),
name: artist.data.profile.name,
thumbnail,
url: `${ARTIST_URL_PREFIX}${id_from_uri(artist.data.uri)}`
})
}),
...search_response.data.searchV2.podcasts.items.map(function (podcasts) {
const thumbnail = podcasts.data.coverArt.sources[0]?.url
if (thumbnail === undefined) {
throw new ScriptException("missing podcast cover image")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, id_from_uri(podcasts.data.uri), plugin.config.id),
name: podcasts.data.name,
thumbnail,
url: `${SHOW_URL_PREFIX}${id_from_uri(podcasts.data.uri)}`
})
}),
...search_response.data.searchV2.audiobooks.items.map(function (audiobook) {
const thumbnail = audiobook.data.coverArt.sources[0]?.url
if (thumbnail === undefined) {
throw new ScriptException("missing audiobook cover image")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, id_from_uri(audiobook.data.uri), plugin.config.id),
name: audiobook.data.name,
thumbnail,
url: `${SHOW_URL_PREFIX}${id_from_uri(audiobook.data.uri)}`
})
}),
...search_response.data.searchV2.users.items.map(function (user) {
const thumbnail = user.data.avatar?.sources[0]?.url ?? HARDCODED_EMPTY_STRING
return new PlatformChannel({
id: new PlatformID(PLATFORM, user.data.username, plugin.config.id),
name: user.data.displayName,
thumbnail,
url: `${USER_URL_PREFIX}${user.data.username}`
})
}),
...search_response.data.searchV2.genres.items.map(function (genre) {
const thumbnail = genre.data.image.sources[0]?.url
if (thumbnail === undefined) {
throw new ScriptException("missing genre cover image")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, id_from_uri(genre.data.uri), plugin.config.id),
name: genre.data.name,
thumbnail,
url: `${PAGE_URL_PREFIX}${id_from_uri(genre.data.uri)}`
})
}),
]
}
/**
*
* @param query
* @param offset
* @param limit really only works set to 10
* @returns
*/
function search_args(query: string, offset: number, limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
searchTerm: query,
offset,
// really only works set to 10
limit,
numberOfTopResults: 5,
includeAudiobooks: true,
includeArtistHasConcertsField: false,
includePreReleases: true,
includeLocalConcertsField: false
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "7a60179c5d6b6c385e849438efb1398392ef159d82f2ad7158be5e80bf7817a9"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "searchDesktop")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
function getChannel(url: string): PlatformChannel {
check_and_update_token()
const { channel_type, channel_uri_id } = parse_channel_url(url)
switch (channel_type) {
case "section": {
// use limit of 4 to load minimal data but try to guarantee that we can get a cover photo
const limit = 4
const { url, headers } = browse_section_args(channel_uri_id, 0, limit)
const browse_section_response: BrowseSectionResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
const name = browse_section_response.data.browseSection.data.title.transformedLabel
const channel_url = `${SECTION_URL_PREFIX}${channel_uri_id}`
const section = browse_section_response.data.browseSection
const section_items = section.sectionItems.items.flatMap(function (section_item) {
const section_item_content = section_item.content.data
if (section_item_content.__typename === "Playlist" || section_item_content.__typename === "Album") {
return [section_item_content]
}
return []
})
const first_section_item = section_items?.[0]
if (first_section_item === undefined) {
throw new LoginRequiredException("login to view custom genres")
}
const first_playlist_image = first_section_item.__typename === "Album"
? first_section_item.coverArt.sources[0]?.url
: first_section_item.images.items[0]?.sources[0]?.url
if (first_playlist_image === undefined) {
throw new ScriptException("missing playlist image")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
name,
thumbnail: first_playlist_image,
url: channel_url
})
}
case "genre": {
if (channel_uri_id === "recently-played") {
if (!bridge.isLoggedIn()) {
throw new LoginRequiredException("login to open recently-played")
}
// Spotify just load the first 50
const { url: uri_url, headers: uri_headers } = recently_played_ids_args(0, 50)
const recently_played_ids: RecentlyPlayedUris = JSON.parse(throw_if_not_ok(local_http.GET(uri_url, uri_headers, false)).body)
const { url, headers } = recently_played_details_args(recently_played_ids.playContexts.map(function (uri_obj) {
return uri_obj.uri
}))
const recently_played_response: RecentlyPlayedDetails = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const section_items = recently_played_response.data.lookup.flatMap(function (section_item): (SectionItemAlbum | SectionItemPlaylist | SectionItemPseudoPlaylist)[] {
if (section_item.__typename === "UnknownTypeWrapper") {
return [{
image: {
sources: [{
"height": 640,
"url": "https://misc.scdn.co/liked-songs/liked-songs-640.png",
}]
},
name: "Liked Songs",
__typename: "PseudoPlaylist",
uri: "spotify:collection:tracks"
}]
}
const section_item_content = section_item.data
if (section_item_content.__typename === "Playlist" || section_item_content.__typename === "Album") {
return [section_item_content]
}
return []
})
const first_section_item = section_items?.[0]
if (first_section_item === undefined) {
throw new ScriptException("unreachable")
}
const first_section_first_playlist_image = function (section_item) {
switch (section_item.__typename) {
case "Album":
return section_item.coverArt.sources[0]?.url
case "Playlist":
return section_item.images.items[0]?.sources[0]?.url
case "PseudoPlaylist":
return section_item.image.sources[0]?.url
default:
throw assert_exhaustive(section_item)
}
}(first_section_item)
if (first_section_first_playlist_image === undefined) {
throw new ScriptException("missing playlist image")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
name: "Recently played",
thumbnail: first_section_first_playlist_image,
url: "https://open.spotify.com/genre/recently-played"
})
}
// use limit of 4 to load minimal data but try to guarantee that we can get a cover photo
const limit = 4
const { url, headers } = browse_page_args(channel_uri_id, { offset: 0, limit }, { offset: 0, limit })
const browse_page_response: BrowsePageResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
if (browse_page_response.data.browse.__typename === "GenericError") {
throw new ScriptException("error loading genre page")
}
const name = browse_page_response.data.browse.header.title.transformedLabel
const sections = browse_page_response.data.browse.sections.items.flatMap(function (item): (GenrePlaylistSection | HomePlaylistSection | WhatsNewSection | RecentlyPlayedSection)[] {
if (is_playlist_section(item)) {
return [item]
}
return []
})
const channel_url = `${PAGE_URL_PREFIX}${channel_uri_id}`
const section_items = sections[0]?.sectionItems.items.flatMap(function (section_item) {
if (section_item.content.__typename === "UnknownType") {
return []
}
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
const section_item_content = section_item.content.data
if (section_item_content.__typename === "Playlist" || section_item_content.__typename === "Album") {
return [section_item_content]
}
return []
})
const first_section_item = section_items?.[0]
if (first_section_item === undefined) {
throw new LoginRequiredException("login to view custom genres")
}
const first_section_first_playlist_image = first_section_item.__typename === "Album"
? first_section_item.coverArt.sources[0]?.url
: first_section_item.images.items[0]?.sources[0]?.url
if (first_section_first_playlist_image === undefined) {
throw new ScriptException("missing playlist image")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
name,
thumbnail: first_section_first_playlist_image,
url: channel_url
})
}
case "show": {
const { url, headers } = show_metadata_args(channel_uri_id)
const show_response: ShowMetadataResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
const sources = show_response.data.podcastUnionV2.coverArt.sources
const thumbnail = sources[sources.length - 1]?.url
if (thumbnail === undefined) {
throw new ScriptException("missing cover art")
}
return new PlatformChannel({
id: new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
name: show_response.data.podcastUnionV2.name,
thumbnail,
url: `${SHOW_URL_PREFIX}${channel_uri_id}`,
description: show_response.data.podcastUnionV2.htmlDescription
})
}
case "user": {
const url = `https://spclient.wg.spotify.com/user-profile-view/v3/profile/${channel_uri_id}?playlist_limit=0&artist_limit=0&episode_limit=0`
const user_response: {
readonly name: string
readonly image_url: string
readonly followers_count: number
url,
{ Authorization: `Bearer ${local_state.bearer_token}` },
false
return new PlatformChannel({
id: new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
name: user_response.name,
thumbnail: user_response.image_url,
url: `${USER_URL_PREFIX}${channel_uri_id}`,
subscribers: user_response.followers_count
})
}
const { url, headers } = artist_metadata_args(channel_uri_id)
const artist_metadata_response: ArtistMetadataResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
const thumbnail = artist_metadata_response.data.artistUnion.visuals.avatarImage?.sources[0]?.url ?? HARDCODED_EMPTY_STRING
const banner = artist_metadata_response.data.artistUnion.visuals.headerImage?.sources[0]?.url
const channel = {
id: new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
name: artist_metadata_response.data.artistUnion.profile.name,
thumbnail,
url: `${ARTIST_URL_PREFIX}${channel_uri_id}`,
subscribers: artist_metadata_response.data.artistUnion.stats.monthlyListeners,
description: artist_metadata_response.data.artistUnion.profile.biography.text
}
if (banner === undefined) {
return new PlatformChannel(channel)
}
return new PlatformChannel({
...channel,
banner
})
case "content-feed":
throw new ScriptException("not implemented")
default:
throw assert_exhaustive(channel_type, "unreachable")
}
}
function is_playlist_section(item: Section): item is GenrePlaylistSection | HomePlaylistSection | WhatsNewSection | RecentlyPlayedSection {
return item.data.__typename === "BrowseGenericSectionData"
|| item.data.__typename === "HomeGenericSectionData"
|| item.data.__typename === "WhatsNewSectionData"
|| item.data.__typename === "CustomRecentlyPlayedSectionData"
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
}
function browse_page_args(
page_uri_id: string,
pagePagination: {
offset: number,
limit: number
},
sectionPagination: {
offset: number,
limit: number
}): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:page:${page_uri_id}`,
pagePagination,
sectionPagination
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "177a4ae12a90e35d335f060216ce5df7864a228c6ca262bd5ed90b37c2419dd9"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "browsePage")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
function recently_played_ids_args(
offset: number,
limit: number
) {
const url = `https://spclient.wg.spotify.com/recently-played/v3/user/${local_state.username}/recently-played?format=json&offset=${offset}&limit=${limit}&filter=default,collection-new-episodes`
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
function recently_played_details_args(uris: string[]): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uris
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "8e4eb5eafa2837eca337dc11321ac285a01f9a056a7ac83f77a66f9998b06a73"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "fetchEntitiesForRecentlyPlayed")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
function parse_channel_url(url: string): { channel_type: ChannelType, channel_uri_id: "recently-played" | string } {
const match_result = url.match(CHANNEL_REGEX)
if (match_result === null) {
throw new ScriptException("regex error")
}
const maybe_channel_type = match_result[1]
if (maybe_channel_type === undefined) {
throw new ScriptException("regex error")
}
const is_section = match_result[2] === "section"
let channel_type: ChannelType = maybe_channel_type as ChannelType
if (is_section) {
channel_type = "section"
}
const channel_uri_id = match_result[3]
if (channel_uri_id === undefined) {
throw new ScriptException("regex error")
}
return { channel_type, channel_uri_id: channel_uri_id === "recently-played" ? "recently-played" : channel_uri_id }
}
//#endregion
//#region channel content
function getChannelCapabilities() {
return new ResultCapabilities<string, ChannelTypeCapabilities>(
[
Type.Feed.Playlists,
Type.Feed.Albums,
Type.Feed.Videos
],
[
Type.Order.Chronological
],