Newer
Older
import {
type AlbumResponse,
type AlbumTracksResponse,
type ArtistDetails,
type ArtistMetadataResponse,
type ContentType,
type EpisodeMetadataResponse,
type FileManifestResponse,
type GetLicenseResponse,
type LyricsResponse,
type PlaylistContent,
type PlaylistContentResponse,
type PlaylistResponse,
type PlaylistType,
type ShowMetadataResponse,
type SongMetadataResponse,
type State,
type TrackMetadataResponse,
type Tracks,
type ProfileAttributesResponse,
type ChannelType,
type BrowsePageResponse,
type GenrePlaylistSection,
type ChannelTypeCapabilities,
type SectionItemAlbum,
type SectionItemPlaylist,
type BrowseSectionResponse,
type Section,
type BookChaptersResponse,
type PodcastEpisodesResponse,
type UserPlaylistsResponse,
type DiscographyResponse,
type HomeResponse,
type HomePlaylistSection,
type SectionItemEpisode,
type WhatsNewResponse,
type WhatsNewSection,
type SearchResponse,
type SearchTypes,
type CollectionType,
type LikedEpisodesResponse,
type LikedTracksResponse,
type LibraryResponse,
type FollowingResponse,
type UriType,
type SpotifySource,
type RecentlyPlayedUris,
type RecentlyPlayedDetails,
type RecentlyPlayedSection,
type SectionItemPseudoPlaylist,
} from "./types.js"
const CONTENT_REGEX = /^https:\/\/open\.spotify\.com\/(track|episode)\/([a-zA-Z0-9]*)($|\/)/
const PLAYLIST_REGEX = /^https:\/\/open\.spotify\.com\/(album|playlist|collection)\/([a-zA-Z0-9]*|your-episodes|tracks)($|\/)/
const CHANNEL_REGEX = /^https:\/\/open\.spotify\.com\/(show|artist|user|genre|section|content-feed)\/(section|)([a-zA-Z0-9]*|recently-played)($|\/)/
const SONG_URL_PREFIX = "https://open.spotify.com/track/" as const
const EPISODE_URL_PREFIX = "https://open.spotify.com/episode/" as const
const SHOW_URL_PREFIX = "https://open.spotify.com/show/" as const
const ARTIST_URL_PREFIX = "https://open.spotify.com/artist/" as const
const USER_URL_PREFIX = "https://open.spotify.com/user/" as const
const ALBUM_URL_PREFIX = "https://open.spotify.com/album/" as const
const PAGE_URL_PREFIX = "https://open.spotify.com/genre/" as const
const SECTION_URL_PREFIX = "https://open.spotify.com/section/" as const
const PLAYLIST_URL_PREFIX = "https://open.spotify.com/playlist/" as const
const COLLECTION_UR_PREFIX = "https://open.spotify.com/collection/" as const
const QUERY_URL = "https://api-partner.spotify.com/pathfinder/v1/query" as const
const IMAGE_URL_PREFIX = "https://i.scdn.co/image/" as const
const PLATFORM = "Spotify" as const
// const USER_AGENT = "Mozilla/5.0 (X11; Linux x86_64; rv:124.0) Gecko/20100101 Firefox/124.0" as const
const PLATFORM_IDENTIFIER = "web_player linux undefined;firefox 126.0;desktop" as const
const SPOTIFY_CONNECT_NAME = "Web Player (Grayjay)" as const
const CLIENT_VERSION = "harmony:4.42.0-2780565f" as const
const HARDCODED_ZERO = 0 as const
const HARDCODED_EMPTY_STRING = "" as const
const EMPTY_AUTHOR = new PlatformAuthorLink(new PlatformID(PLATFORM, "", plugin.config.id), "", "")
const local_http = http
// const local_utility = utility
// set missing constants
Type.Order.Chronological = "Latest releases"
Type.Order.Views = "Most played"
Type.Order.Favorites = "Most favorited"
Type.Feed.Playlists = "PLAYLISTS"
Type.Feed.Albums = "ALBUMS"
let local_settings: ISettings
/** State */
let local_state: State
//#region source methods
source.enable = enable
source.disable = disable
source.saveState = saveState
source.getHome = getHome
source.getSearchCapabilities = getSearchCapabilities
source.search = search
source.isChannelUrl = isChannelUrl
source.getChannel = getChannel
source.getChannelCapabilities = getChannelCapabilities
source.getChannelContents = getChannelContents
Kai DeLorenzo
committed
source.getChannelPlaylists = getChannelPlaylists
source.isContentDetailsUrl = isContentDetailsUrl
source.getContentDetails = getContentDetails
source.getUserSubscriptions = getUserSubscriptions
source.getUserPlaylists = getUserPlaylists
source.getPlaybackTracker = getPlaybackTracker
if (IS_TESTING) {
const assert_source: SpotifySource = {
enable,
disable,
saveState,
getHome,
search,
getSearchCapabilities,
isContentDetailsUrl,
getContentDetails,
isChannelUrl,
getChannel,
getChannelContents,
Kai DeLorenzo
committed
getChannelPlaylists,
getChannelCapabilities,
searchChannels,
isPlaylistUrl,
getPlaylist,
searchPlaylists,
getUserPlaylists,
getUserSubscriptions,
getPlaybackTracker
}
if (source.enable === undefined) { assert_never(source.enable) }
if (source.disable === undefined) { assert_never(source.disable) }
if (source.saveState === undefined) { assert_never(source.saveState) }
if (source.getHome === undefined) { assert_never(source.getHome) }
if (source.search === undefined) { assert_never(source.search) }
if (source.getSearchCapabilities === undefined) { assert_never(source.getSearchCapabilities) }
if (source.isContentDetailsUrl === undefined) { assert_never(source.isContentDetailsUrl) }
if (source.getContentDetails === undefined) { assert_never(source.getContentDetails) }
if (source.isChannelUrl === undefined) { assert_never(source.isChannelUrl) }
if (source.getChannel === undefined) { assert_never(source.getChannel) }
if (source.getChannelContents === undefined) { assert_never(source.getChannelContents) }
Kai DeLorenzo
committed
if (source.getChannelPlaylists === undefined) { assert_never(source.getChannelPlaylists) }
if (source.getChannelCapabilities === undefined) { assert_never(source.getChannelCapabilities) }
if (source.searchChannels === undefined) { assert_never(source.searchChannels) }
if (source.isPlaylistUrl === undefined) { assert_never(source.isPlaylistUrl) }
if (source.getPlaylist === undefined) { assert_never(source.getPlaylist) }
if (source.searchPlaylists === undefined) { assert_never(source.searchPlaylists) }
if (source.getUserPlaylists === undefined) { assert_never(source.getUserPlaylists) }
if (source.getUserSubscriptions === undefined) { assert_never(source.getUserSubscriptions) }
if (source.getPlaybackTracker === undefined) { assert_never(source.getPlaybackTracker) }
if (IS_TESTING) {
log(assert_source)
}
}
function enable(conf: SourceConfig, settings: ISettings, savedState: string | null) {
if (IS_TESTING) {
log("IS_TESTING true")
log("logging configuration")
log(conf)
log("logging settings")
log(settings)
log("logging savedState")
log(savedState)
}
local_settings = settings
if (savedState !== null) {
const state: State = JSON.parse(savedState)
local_state = state
// the token stored in state might be old
check_and_update_token()
} else {
const home_page = "https://open.spotify.com"
const token_regex = /<script id="config" data-testid="config" type="application\/json">({.*?})<\/script><script id="session" data-testid="session" type="application\/json">({.*?})<\/script>/
const web_player_js_regex = /https:\/\/open\.spotifycdn\.com\/cdn\/build\/web-player\/web-player\..{8}\.js/
// use the authenticated client to get a logged in bearer token
const html = throw_if_not_ok(local_http.GET(home_page, {}, true)).body
const web_player_js_match_result = html.match(web_player_js_regex)
if (web_player_js_match_result === null || web_player_js_match_result[0] === undefined) {
throw new ScriptException("regex error")
}
const token_match_result = html.match(token_regex)
if (token_match_result === null || token_match_result[1] === undefined || token_match_result[2] === undefined) {
throw new ScriptException("regex error")
}
const user_data: {
readonly isPremium: boolean
readonly userCountry: string
} = JSON.parse(token_match_result[1])
const token_response: {
readonly accessToken: string,
readonly accessTokenExpirationTimestampMs: number
} = JSON.parse(token_match_result[2])
const bearer_token = token_response.accessToken
// download license uri and get logged in user
const get_license_url_url = "https://gue1-spclient.spotify.com/melody/v1/license_url?keysystem=com.widevine.alpha&sdk_name=harmony&sdk_version=4.41.0"
const profile_attributes_url = "https://api-partner.spotify.com/pathfinder/v1/query?operationName=profileAttributes&variables=%7B%7D&extensions=%7B%22persistedQuery%22%3A%7B%22version%22%3A1%2C%22sha256Hash%22%3A%2253bcb064f6cd18c23f752bc324a791194d20df612d8e1239c735144ab0399ced%22%7D%7D"
const web_player_js_url = web_player_js_match_result[0]
const responses = local_http
.batch()
.GET(
get_license_url_url,
{ Authorization: `Bearer ${bearer_token}` },
false
)
.GET(
profile_attributes_url,
{ Authorization: `Bearer ${bearer_token}` },
false
)
.GET(
web_player_js_url,
{ Authorization: `Bearer ${bearer_token}` },
false
)
if (responses[0] === undefined || responses[1] === undefined || responses[2] === undefined) {
throw new ScriptException("unreachable")
}
const get_license_response: GetLicenseResponse = JSON.parse(
)
const license_uri = `https://gue1-spclient.spotify.com/${get_license_response.uri}`
const profile_attributes_response: ProfileAttributesResponse = JSON.parse(
const feature_version_match_result = throw_if_not_ok(responses[2]).body.match(/"(web-player_(.*?))"/)
throw new ScriptException("regex error")
}
const feature_version = feature_version_match_result[1]
if (feature_version === undefined) {
throw new ScriptException("regex error")
}
expiration_timestamp_ms: token_response.accessTokenExpirationTimestampMs,
license_uri: license_uri,
is_premium: user_data.isPremium
}
if (profile_attributes_response.data.me !== null) {
state = {
...state,
username: profile_attributes_response.data.me.profile.username
}
if ("userCountry" in user_data) {
state = { ...state, country: user_data.userCountry }
}
local_state = state
}
}
function download_bearer_token() {
const get_access_token_url = "https://open.spotify.com/get_access_token?reason=transport&productType=web-player"
// use the authenticated client to get a logged in bearer token
const access_token_response = throw_if_not_ok(local_http.GET(get_access_token_url, {}, true)).body
const token_response: {
readonly accessToken: string,
readonly accessTokenExpirationTimestampMs: number
} = JSON.parse(access_token_response)
}
function check_and_update_token() {
// renew the token with 30 seconds to spare
if (Date.now() - 30 * 1000 < local_state.expiration_timestamp_ms) {
return
}
log("Spotify log: refreshing bearer token")
const token_response = download_bearer_token()
feature_version: local_state.feature_version,
bearer_token: token_response.accessToken,
expiration_timestamp_ms: token_response.accessTokenExpirationTimestampMs,
license_uri: local_state.license_uri,
}
if (local_state.username !== undefined) {
state = { ...state, username: local_state.username }
}
if (local_state.country !== undefined) {
state = { ...state, country: local_state.country }
}
local_state = state
}
function disable() {
log("Spotify log: disabling")
}
function saveState() {
return JSON.stringify(local_state)
}
function getHome() {
check_and_update_token()
const { url, headers } = home_args(10)
const { url: new_url, headers: new_headers } = whats_new_args(0, 50)
const { url: recent_url, headers: recent_headers } = recently_played_ids_args(0, 50)
const responses = local_http
.batch()
.GET(url, headers, false)
.GET(new_url, new_headers, false)
.GET(recent_url, recent_headers, false)
if (responses[0] === undefined || responses[1] === undefined || responses[2] === undefined) {
throw new ScriptException("unreachable")
}
const home_response: HomeResponse = JSON.parse(throw_if_not_ok(responses[0]).body)
const sections: Section[] = home_response.data.home.sectionContainer.sections.items
if (bridge.isLoggedIn()) {
const whats_new_response: WhatsNewResponse = JSON.parse(throw_if_not_ok(responses[1]).body)
sections.push({
data: {
__typename: "WhatsNewSectionData",
title: {
text: "What's New"
},
},
section_url: "https://open.spotify.com/content-feed",
sectionItems: whats_new_response.data.whatsNewFeedItems
if (responses[2].code !== 404) {
const recently_played_ids: RecentlyPlayedUris = JSON.parse(throw_if_not_ok(responses[2]).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)
sections.unshift({
data: {
__typename: "CustomRecentlyPlayedSectionData",
title: {
text: "Recently played"
},
section_url: "https://open.spotify.com/genre/recently-played",
sectionItems: {
items: recently_played_response.data.lookup.flatMap(function (section_item) {
if (section_item.__typename === "UnknownTypeWrapper") {
if (section_item._uri !== `spotify:user:${local_state.username}:collection`) {
throw new ScriptException("unexpected uri")
}
return {
content: {
data: {
image: {
sources: [{
"height": 640,
"url": "https://misc.scdn.co/liked-songs/liked-songs-640.png",
"width": 640
}]
},
name: "Liked Songs",
__typename: "PseudoPlaylist",
uri: "spotify:collection:tracks"
},
__typename: "LibraryPseudoPlaylistResponseWrapper"
}
}
}
return {
content: {
data: section_item.data,
__typename: section_item.__typename
})
}
})
}
const playlists = format_page(sections, 4, "Home")
return new ContentPager(playlists, false)
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
}
function whats_new_args(offset: number, limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
offset,
limit,
onlyUnPlayedItems: false,
includedContentTypes: []
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "4c3281ff1c1c0b67f56e4a77568d6b143da7cf1260266ed5d5147a5e49481493"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "queryWhatsNewFeed")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
/**
*
* @param limit has incosistent behavior use 10 because that's what the spotify homepage uses
* @returns
*/
function home_args(limit: number): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
/** usually something like America/Chicago */
timeZone: "America/Chicago", // TODO figure out a way to calculate this in Grayjay (maybe a setting) Intl.DateTimeFormat().resolvedOptions().timeZone,
/** usually the logged in user cookie */
sp_t: "",
/** usually something like US */
country: "US",
facet: null,
sectionItemsLimit: limit
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "a68635e823cd71d9f6810ec221d339348371ef0b878ec6b846fc36b234219c59"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "home")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
//#region search
function getSearchCapabilities() {
return new ResultCapabilities<string, SearchTypes>(
[
Type.Feed.Videos
],
[],
[]
)
}
function search(query: string, type: SearchTypes | null, order: Order | null, filters: FilterQuery<string> | null): VideoPager {
if (filters !== null && Object.keys(filters).length !== 0) {
throw new ScriptException("unreachable")
}
if (order !== null) {
throw new ScriptException("unreachable")
}
if (type !== null) {
throw new ScriptException("unreachable")
}
check_and_update_token()
return new SearchPager(query, 0, 100)
}
class SearchPager extends VideoPager {
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_song_and_episode_results(search_response, offset, limit)
super(format_song_and_episode_results(search_response), has_more)
this.offset = offset + limit
}
override nextPage(this: SearchPager): SearchPager {
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)
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
this.results = format_song_and_episode_results(search_response)
this.hasMore = are_more_song_and_episode_results(search_response, this.offset, this.limit)
this.offset = this.offset + this.limit
return this
}
override hasMorePagers(this: SearchPager): boolean {
return this.hasMore
}
}
function format_song_and_episode_results(search_response: SearchResponse) {
return [
...search_response.data.searchV2.tracksV2.items.map(function (track) {
const artist = track.item.data.artists.items[0]
if (artist === undefined) {
throw new ScriptException("missing artist")
}
return new PlatformVideo({
id: new PlatformID(PLATFORM, track.item.data.id, plugin.config.id),
name: track.item.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)}`
),
url: `${SONG_URL_PREFIX}${track.item.data.id}`,
thumbnails: new Thumbnails(track.item.data.albumOfTrack.coverArt.sources.map(function (image) {
return new Thumbnail(image.url, image.height)
})),
duration: track.item.data.duration.totalMilliseconds / 1000,
viewCount: HARDCODED_ZERO,
isLive: false,
shareUrl: `${SONG_URL_PREFIX}${track.item.data.id}`,
datetime: HARDCODED_ZERO
})
}),
...search_response.data.searchV2.episodes.items.map(function (episode) {
return new PlatformVideo({
id: new PlatformID(PLATFORM, id_from_uri(episode.data.uri), plugin.config.id),
name: episode.data.name,
author: episode.data.podcastV2.data.__typename === "Podcast" ? new PlatformAuthorLink(
new PlatformID(PLATFORM, id_from_uri(episode.data.podcastV2.data.uri), plugin.config.id),
episode.data.podcastV2.data.name,
`${ARTIST_URL_PREFIX}${id_from_uri(episode.data.podcastV2.data.uri)}`,
episode.data.podcastV2.data.coverArt?.sources[0]?.url
url: `${EPISODE_URL_PREFIX}${id_from_uri(episode.data.uri)}`,
thumbnails: new Thumbnails(episode.data.coverArt.sources.map(function (image) {
return new Thumbnail(image.url, image.height)
})),
duration: episode.data.duration.totalMilliseconds / 1000,
viewCount: HARDCODED_ZERO,
isLive: false,
shareUrl: `${EPISODE_URL_PREFIX}${id_from_uri(episode.data.uri)}`,
datetime: episode.data.releaseDate === null ? HARDCODED_ZERO : new Date(episode.data.releaseDate.isoString).getTime() / 1000
})
})
]
}
function are_more_song_and_episode_results(search_response: SearchResponse, current_offset: number, limit: number): boolean {
return search_response.data.searchV2.tracksV2.totalCount > current_offset + limit
|| search_response.data.searchV2.episodes.totalCount > current_offset + limit
}
//#endregion
// https://open.spotify.com/track/6XXxKsu3RJeN3ZvbMYrgQW
// https://open.spotify.com/episode/3Z88ZE0i3L7AIrymrBwtqg
function isContentDetailsUrl(url: string) {
return CONTENT_REGEX.test(url)
}
function getContentDetails(url: string) {
if (!bridge.isLoggedIn()) {
throw new LoginRequiredException("login to listen to songs")
}
const { content_uri_id, content_type } = parse_content_url(url)
switch (content_type) {
case "track": {
const song_url = `${SONG_URL_PREFIX}${content_uri_id}`
const { url: metadata_url, headers: metadata_headers } = song_metadata_args(content_uri_id)
const { url: track_metadata_url, headers: _track_metadata_headers } = track_metadata_args(content_uri_id)
const batch = local_http
.batch()
.GET(metadata_url, metadata_headers, false)
.GET(track_metadata_url, _track_metadata_headers, false)
if (local_state.is_premium) {
const { url, headers } = lyrics_args(content_uri_id)
batch.GET(url, headers, false)
}
const results = batch
.execute()
if (results[0] === undefined || results[1] === undefined) {
throw new ScriptException("unreachable")
}
const song_metadata_response: SongMetadataResponse = JSON.parse(throw_if_not_ok(results[0]).body)
const track_metadata_response: TrackMetadataResponse = JSON.parse(throw_if_not_ok(results[1]).body)
const first_artist = track_metadata_response.data.trackUnion.firstArtist.items[0]
if (first_artist === undefined) {
throw new ScriptException("missing artist")
}
const artist_url = `https://open.spotify.com/artist/${first_artist.id}`
const highest_quality_artist_cover_art = first_artist.visuals.avatarImage.sources.reduce(function (accumulator, current) {
return accumulator.height > current.height ? accumulator : current
})
let subtitles: ISubtitleSource[] = []
if (results[2] !== undefined && results[2].code !== 404) {
const lyrics_response: LyricsResponse = JSON.parse(throw_if_not_ok(results[2]).body)
const subtitle_name = function () {
switch (lyrics_response.lyrics.language) {
case "en":
return "English"
throw assert_exhaustive(lyrics_response.lyrics.language, "unreachable")
}
}()
const convert = milliseconds_to_WebVTT_timestamp
let vtt_text = `WEBVTT ${subtitle_name}\n`
vtt_text += "\n"
lyrics_response.lyrics.lines.forEach(function (line, index) {
const next = lyrics_response.lyrics.lines[index + 1]
let end = next?.startTimeMs
if (end === undefined) {
end = track_metadata_response.data.trackUnion.duration.totalMilliseconds.toString()
}
vtt_text += `${convert(parseInt(line.startTimeMs))} --> ${convert(parseInt(end))}\n`
vtt_text += `${line.words}\n`
vtt_text += "\n"
})
subtitles = [{
url: song_url,
name: subtitle_name,
getSubtitles() {
return vtt_text
},
format: "text/vtt",
}]
}
const format = local_state.is_premium ? "MP4_256" : "MP4_128"
const files = song_metadata_response.file === undefined ? song_metadata_response.alternative?.[0]?.file : song_metadata_response.file
throw new ScriptException("missing alternative file list")
}
const maybe_file_id = files.find(function (file) { return file.format === format })?.file_id
if (maybe_file_id === undefined) {
throw new ScriptException("missing expected format")
}
const { url, headers } = file_manifest_args(maybe_file_id)
const { url: artist_metadata_url, headers: artist_metadata_headers } = artist_metadata_args(first_artist.id)
const second_results = local_http
.batch()
.GET(url, headers, false)
.GET(artist_metadata_url, artist_metadata_headers, false)
.execute()
if (second_results[0] === undefined || second_results[1] === undefined) {
throw new ScriptException("unreachable")
}
const file_manifest: FileManifestResponse = JSON.parse(throw_if_not_ok(second_results[0]).body)
const artist_metadata_response: ArtistMetadataResponse = JSON.parse(throw_if_not_ok(second_results[1]).body)
const duration = track_metadata_response.data.trackUnion.duration.totalMilliseconds / 1000
if (file_url === undefined) {
throw new ScriptException("unreachable")
}
const audio_sources = [new AudioUrlWidevineSource({
//audio/mp4; codecs="mp4a.40.2
name: codecs,
bitrate: function (format: "MP4_128" | "MP4_256") {
switch (format) {
case "MP4_128":
return 128000
case "MP4_256":
return 256000
default:
throw assert_exhaustive(format, "unreachable")
duration,
url: file_url,
language: Language.UNKNOWN,
bearerToken: local_state.bearer_token,
licenseUri: local_state.license_uri
})]
return new PlatformVideoDetails({
id: new PlatformID(PLATFORM, content_uri_id, plugin.config.id),
name: song_metadata_response.name,
author: new PlatformAuthorLink(
new PlatformID(PLATFORM, first_artist.id, plugin.config.id),
first_artist.profile.name,
artist_url,
highest_quality_artist_cover_art.url,
artist_metadata_response.data.artistUnion.stats.monthlyListeners
),
url: song_url,
thumbnails: new Thumbnails(song_metadata_response.album.cover_group.image.map(function (image) {
return new Thumbnail(`${IMAGE_URL_PREFIX}${image.file_id}`, image.height)
})),
duration,
viewCount: parseInt(track_metadata_response.data.trackUnion.playcount),
datetime: new Date(track_metadata_response.data.trackUnion.albumOfTrack.date.isoString).getTime() / 1000,
description: HARDCODED_EMPTY_STRING,
video: new UnMuxVideoSourceDescriptor([], audio_sources),
rating: new RatingLikes(HARDCODED_ZERO),
subtitles
})
}
case "episode": {
const episode_url = `https://open.spotify.com/episode/${content_uri_id}`
const { url, headers } = episode_metadata_args(content_uri_id)
const episode_metadata_response: EpisodeMetadataResponse = JSON.parse(
throw_if_not_ok(local_http.GET(url, headers, false)).body
)
if (!episode_metadata_response.data.episodeUnionV2.playability.playable) {
throw new UnavailableException("login or purchase to play premium content")
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
if (episode_metadata_response.data.episodeUnionV2.mediaTypes.length === 2) {
function assert_video(_mediaTypes: ["AUDIO", "VIDEO"]) { }
assert_video(episode_metadata_response.data.episodeUnionV2.mediaTypes)
//TODO since we don't use the transcript we should only load it when audio only podcasts are played
// TODO handle video podcasts. Grayjay doesn't currently support the websocket functionality necessary
// the basic process to get the video play info is
// connect to the websocket wss://gue1-dealer.spotify.com/?access_token=<bearer-token>
// register the device https://gue1-spclient.spotify.com/track-playback/v1/devices
// generate the device id using code found in the min js like this
/*
web player js
const t = Math.ceil(e / 2);
return function(e) {
let t = "";
for (let n = 0; n < e.length; n++) {
const i = e[n];
i < 16 && (t += "0"),
t += i.toString(16)
}
return t
}(Oe(t))
*/
// load devices info https://gue1-spclient.spotify.com/connect-state/v1/devices/hobs_aced97d86694f14d304dd4e6f1f7f8c3bff
// transfer to our device https://gue1-spclient.spotify.com/connect-state/v1/connect/transfer/from/9a7079bd5b5605839c1d9080d0f4368bfcd6d2eb/to/aced97d86694f14d304dd4e6f1f7f8c3bff
// signal the play of the given podcast (not quite sure how this works :/)
// recieve the video play info via the websocket connection
//
}
const format = "MP4_128"
const maybe_file_id = episode_metadata_response.data.episodeUnionV2.audio.items.find(function (file) { return file.format === format })?.fileId
if (maybe_file_id === undefined) {
throw new ScriptException("missing expected format")
}
const limited_show_metadata =
episode_metadata_response.data.episodeUnionV2.__typename === "Chapter"
? episode_metadata_response.data.episodeUnionV2.audiobookV2.data
: episode_metadata_response.data.episodeUnionV2.podcastV2.data
const show_uri_id = id_from_uri(limited_show_metadata.uri)
const highest_quality_cover_art = limited_show_metadata.coverArt.sources.reduce(function (accumulator, current) {
return accumulator.height > current.height ? accumulator : current
})
const { url: manifest_url, headers: manifest_headers } = file_manifest_args(maybe_file_id)
const { url: show_metadata_url, headers: show_metadata_headers } = show_metadata_args(show_uri_id)
const batch = local_http
.GET(show_metadata_url, show_metadata_headers, false)
.GET(manifest_url, manifest_headers, false)
if (episode_metadata_response.data.episodeUnionV2.transcripts !== undefined) {
const { url, headers } = transcript_args(content_uri_id)
batch.GET(url, headers, false)
}
const results = batch.execute()
if (results[0] === undefined || results[1] === undefined) {
throw new ScriptException("unreachable")
}
const full_show_metadata: ShowMetadataResponse = JSON.parse(throw_if_not_ok(results[0]).body)
const file_manifest: FileManifestResponse = JSON.parse(throw_if_not_ok(results[1]).body)
const subtitles = function (): ISubtitleSource[] {
if (results[2] === undefined || results[2].code === 404) {
return []
}
const transcript_response: TranscriptResponse = JSON.parse(throw_if_not_ok(results[2]).body)
const subtitle_name = function () {
switch (transcript_response.language) {
case "en":
return "English"
default:
throw assert_exhaustive(transcript_response.language, "unreachable")
}
}()
let vtt_text = `WEBVTT ${subtitle_name}\n`
vtt_text += "\n"
transcript_response.section.forEach(function (section, index) {
if ("title" in section) {
return
}
const next = transcript_response.section[index + 1]
let end = next?.startMs
if (end === undefined) {
end = episode_metadata_response.data.episodeUnionV2.duration.totalMilliseconds
}
vtt_text += `${milliseconds_to_WebVTT_timestamp(section.startMs)} --> ${milliseconds_to_WebVTT_timestamp(end)}\n`
vtt_text += `${"text" in section ? section.text.sentence.text : section.fallback.sentence.text}\n`
vtt_text += "\n"
})
return [{
url: episode_url,
name: subtitle_name,
getSubtitles() {
return vtt_text
},
format: "text/vtt",
}]
}()
const duration = episode_metadata_response.data.episodeUnionV2.duration.totalMilliseconds / 1000
const file_url = file_manifest.cdnurl[0]
if (file_url === undefined) {
throw new ScriptException("unreachable")
}
const codecs = "mp4a.40.2"
const audio_sources = [new AudioUrlWidevineSource({
//audio/mp4; codecs="mp4a.40.2
name: codecs,
bitrate: 128000,
container: "audio/mp4",
codecs,
duration,
url: file_url,
language: Language.UNKNOWN,
bearerToken: local_state.bearer_token,
licenseUri: local_state.license_uri
})]
const datetime = function () {
if (episode_metadata_response.data.episodeUnionV2.__typename === "Episode") {
return new Date(episode_metadata_response.data.episodeUnionV2.releaseDate.isoString).getTime() / 1000
} else if (full_show_metadata.data.podcastUnionV2.__typename === "Audiobook") {
return new Date(full_show_metadata.data.podcastUnionV2.publishDate.isoString).getTime() / 1000
throw new ScriptException("unreachable")
}()
return new PlatformVideoDetails({
id: new PlatformID(PLATFORM, content_uri_id, plugin.config.id),
name: episode_metadata_response.data.episodeUnionV2.name,
new PlatformID(PLATFORM, show_uri_id, plugin.config.id),
limited_show_metadata.name,
`${SHOW_URL_PREFIX}${show_uri_id}`,
url: episode_url,
thumbnails: new Thumbnails(episode_metadata_response.data.episodeUnionV2.coverArt.sources.map(function (image) {
return new Thumbnail(image.url, image.height)
})),
duration,
viewCount: HARDCODED_ZERO,
isLive: false,
description: episode_metadata_response.data.episodeUnionV2.htmlDescription,
video: new UnMuxVideoSourceDescriptor([], audio_sources),
rating: new RatingScaler(full_show_metadata.data.podcastUnionV2.rating.averageRating.average),
subtitles
throw assert_exhaustive(content_type, "unreachable")
function parse_content_url(url: string) {
const match_result = url.match(CONTENT_REGEX)
if (match_result === null) {
throw new ScriptException("regex error")
}
const maybe_content_type = match_result[1]
if (maybe_content_type === undefined) {
throw new ScriptException("regex error")
}
const content_type: ContentType = maybe_content_type as ContentType
const content_uri_id = match_result[2]
if (content_uri_id === undefined) {
throw new ScriptException("regex error")
}
return { content_uri_id, content_type }
}
function show_metadata_args(show_uri_id: string): { readonly url: string, readonly headers: { Authorization: string } } {
uri: `spotify:show:${show_uri_id}`
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "5fb034a236a3e8301e9eca0e23def3341ed66c891ea2d4fea374c091dc4b4a6a"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "queryShowMetadataV2")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
function transcript_args(episode_uri_id: string): { readonly url: string, readonly headers: { Authorization: string } } {
const transcript_url_prefix = "https://spclient.wg.spotify.com/transcript-read-along/v2/episode/"
const url = new URL(`${transcript_url_prefix}${episode_uri_id}`)
url.searchParams.set("format", "json")
return {
url: url.toString(),
headers: { Authorization: `Bearer ${local_state.bearer_token}` }
}
function lyrics_args(song_uri_id: string): {
readonly url: string, readonly headers: {
Authorization: string,
Accept: string,
"app-platform": "WebPlayer"
}
} {
const url = new URL(`https://spclient.wg.spotify.com/color-lyrics/v2/track/${song_uri_id}`)
return {
url: url.toString(),
headers: {
Accept: "application/json",
"app-platform": "WebPlayer",
Authorization: `Bearer ${local_state.bearer_token}`
}
}
}
function file_manifest_args(file_id: string): { readonly url: string, readonly headers: { Authorization: string } } {
const file_manifest_url_prefix = "https://gue1-spclient.spotify.com/storage-resolve/v2/files/audio/interactive/10/"
const file_manifest_params = "?product=9&alt=json"
return {
url: `${file_manifest_url_prefix}${file_id}${file_manifest_params}`,
headers: { Authorization: `Bearer ${local_state.bearer_token}` }
}
}
function episode_metadata_args(episode_uri_id: string): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:episode:${episode_uri_id}`
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "9697538fe993af785c10725a40bb9265a20b998ccd2383bd6f586e01303824e9"
}
})
url.searchParams.set("operationName", "getEpisodeOrChapter")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
function track_metadata_args(song_uri_id: string): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:track:${song_uri_id}`
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "ae85b52abb74d20a4c331d4143d4772c95f34757bfa8c625474b912b9055b5c0"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "getTrack")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
function song_metadata_args(song_uri_id: string): {
readonly url: string,
readonly headers: {
Authorization: string,
Accept: "application/json"
}
} {
const song_metadata_url = "https://spclient.wg.spotify.com/metadata/4/track/"
return {
url: `${song_metadata_url}${get_gid(song_uri_id)}`,
headers: {
Authorization: `Bearer ${local_state.bearer_token}`,
Accept: "application/json"
}
}
}
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
function artist_metadata_args(artist_uri_id: string): { readonly url: string, readonly headers: { Authorization: string } } {
const variables = JSON.stringify({
uri: `spotify:artist:${artist_uri_id}`,
locale: "",
includePrerelease: true
})
const extensions = JSON.stringify({
persistedQuery: {
version: 1,
sha256Hash: "da986392124383827dc03cbb3d66c1de81225244b6e20f8d78f9f802cc43df6e"
}
})
const url = new URL(QUERY_URL)
url.searchParams.set("operationName", "queryArtistOverview")
url.searchParams.set("variables", variables)
url.searchParams.set("extensions", extensions)
return { url: url.toString(), headers: { Authorization: `Bearer ${local_state.bearer_token}` } }
}
//#endregion
//#region playlists
// https://open.spotify.com/album/6BzxX6zkDsYKFJ04ziU5xQ
// https://open.spotify.com/playlist/37i9dQZF1E38112qhvV3BT
// https://open.spotify.com/collection/your-episodes
function isPlaylistUrl(url: string): boolean {
return PLAYLIST_REGEX.test(url)
}
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)
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
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()
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
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)
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
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)
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
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")
}
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
1327
1328
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)
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
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)
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
1471
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
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.map(function (playlist_track_metadata) {
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)
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
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
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)
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
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
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
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)
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
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 []
}
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
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)
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
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
})
}
case "artist":
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
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
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"
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
}
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}` } }
}
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
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
],
[]
)
}
function getChannelContents(url: string, type: ChannelTypeCapabilities | null, order: Order | null, filters: FilterQuery<string> | null) {
if (filters !== null) {
throw new ScriptException("unreachable")
}
if (order !== "CHRONOLOGICAL") {
throw new ScriptException("unreachable")
}
if (type !== Type.Feed.Videos) {
throw new ScriptException("unreachable")
}
check_and_update_token()
const { channel_type, channel_uri_id } = parse_channel_url(url)
switch (channel_type) {
case "section": {
const initial_limit = 20
const { url, headers } = browse_section_args(channel_uri_id, 0, initial_limit)
const browse_section_response: BrowseSectionResponse = JSON.parse(throw_if_not_ok(local_http.GET(url, headers, false)).body)
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
const name = browse_section_response.data.browseSection.data.title.transformedLabel
const section = browse_section_response.data.browseSection
const section_uri_id = channel_uri_id
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 []
})
if (section_items.length === 0) {
return new ContentPager([], false)
}
const first_section_item = section_items[0]
if (first_section_item === undefined) {
throw new ScriptException("no section items")
}
const author = new PlatformAuthorLink(
new PlatformID(PLATFORM, section_uri_id, plugin.config.id),
name,
`${SECTION_URL_PREFIX}${section_uri_id}`,
first_section_item.__typename === "Album"
? first_section_item.coverArt.sources[0]?.url
: first_section_item.images.items[0]?.sources[0]?.url
)
return new SectionPager(channel_uri_id, section_items, 0, initial_limit, author, section.sectionItems.totalCount > initial_limit)
}
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")
}
const author = new PlatformAuthorLink(
new PlatformID(PLATFORM, "recently-played", plugin.config.id),
"Recently played",
`${PAGE_URL_PREFIX}recently-played`,
first_section_first_playlist_image
)
const playlists = section_items.map(function (section_item) {
return format_section_item(section_item, author)
})
return new ContentPager(playlists, false)
}
const limit = 4
const { url, headers } = browse_page_args(channel_uri_id, { offset: 0, limit: 50 }, { offset: 0, limit: 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 playlists = format_page(browse_page_response.data.browse.sections.items, limit, browse_page_response.data.browse.header.title.transformedLabel)
return new ContentPager(playlists, false)
}
case "show":
const { url: metadata_url, headers: metadata_headers } = show_metadata_args(channel_uri_id)
const chapters_limit = 50
const episodes_limit = 6
const { url: chapters_url, headers: chapters_headers } = book_chapters_args(channel_uri_id, 0, chapters_limit)
const { url: episodes_url, headers: episodes_headers } = podcast_episodes_args(channel_uri_id, 0, episodes_limit)
const responses = local_http
.batch()
.GET(metadata_url, metadata_headers, false)
.GET(chapters_url, chapters_headers, false)
.GET(episodes_url, episodes_headers, false)
.execute()
if (responses[0] === undefined || responses[1] === undefined || responses[2] === undefined) {
throw new ScriptException("unreachable")
}
const show_metadata_response: ShowMetadataResponse = JSON.parse(throw_if_not_ok(responses[0]).body)
const author = new PlatformAuthorLink(
new PlatformID(PLATFORM, channel_uri_id, plugin.config.id),
show_metadata_response.data.podcastUnionV2.name,
`${SHOW_URL_PREFIX}${channel_uri_id}`,
show_metadata_response.data.podcastUnionV2.coverArt.sources[0]?.url
)
switch (show_metadata_response.data.podcastUnionV2.__typename) {
case "Audiobook": {
const chapters_response: BookChaptersResponse = JSON.parse(throw_if_not_ok(responses[1]).body)
const publish_date_time = new Date(show_metadata_response.data.podcastUnionV2.publishDate.isoString).getTime() / 1000
return new ChapterPager(channel_uri_id, chapters_response, 0, chapters_limit, author, publish_date_time)
}
case "Podcast": {
const episodes_response: PodcastEpisodesResponse = JSON.parse(throw_if_not_ok(responses[2]).body)
return new EpisodePager(channel_uri_id, episodes_response, 0, episodes_limit, author)
}
Loading
Loading full blame...