deezer-js/deezer/api.js

const got = require('got')

// Possible values for order parameter in search
const SearchOrder = {
  RANKING       : "RANKING",
  TRACK_ASC     : "TRACK_ASC",
  TRACK_DESC    : "TRACK_DESC",
  ARTIST_ASC    : "ARTIST_ASC",
  ARTIST_DESC   : "ARTIST_DESC",
  ALBUM_ASC     : "ALBUM_ASC",
  ALBUM_DESC    : "ALBUM_DESC",
  RATING_ASC    : "RATING_ASC",
  RATING_DESC   : "RATING_DESC",
  DURATION_ASC  : "DURATION_ASC",
  DURATION_DESC : "DURATION_DESC"
}

class API{
  constructor(cookie_jar, headers){
    this.http_headers = headers
    this.cookie_jar = cookie_jar
    this.access_token = null
  }

  async api_call(method, args){
    if (typeof args == "undefined") args = {}
    if (this.access_token) args.access_token = this.access_token
    let result_json;
    try {
      result_json = await got.get("https://api.deezer.com/" + method, {
        searchParams: args,
        cookieJar: this.cookie_jar,
        headers: this.http_headers,
        timeout: 30000
      }).json()
    } catch (e) {
      console.log(e)
      await new Promise(r => setTimeout(r, 2000)) // sleep(2000ms)
      return this.api_call(method, args)
    }
    if (result_json.error){
      if (result_json.error.code){
        if ([4, 700].indexOf(result_json.error.code) != -1) {
          await new Promise(r => setTimeout(r, 5000)) // sleep(5000ms)
          return await this.api_call(method, args)
        }
        if (result_json.error.code == 100) throw new ItemsLimitExceededException(`ItemsLimitExceededException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 200) throw new PermissionException(`PermissionException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 300) throw new InvalidTokenException(`InvalidTokenException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 500) throw new WrongParameterException(`ParameterException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 501) throw new MissingParameterException(`MissingParameterException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 600) throw new InvalidQueryException(`InvalidQueryException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 800) throw new DataException(`DataException: ${method} ${result_json.error.message || ""}`)
        if (result_json.error.code == 901) throw new IndividualAccountChangedNotAllowedException(`IndividualAccountChangedNotAllowedException: ${method} ${result_json.error.message || ""}`)
      }
      throw APIError(result_json.error)
    }
    return result_json
  }

  get_album(album_id){
    return this.api_call(`album/${album_id}`)
  }

  get_album_by_UPC(upc){
    return this.get_album(`upc:${upc}`)
  }

  get_album_comments(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`album/${album_id}/comments`, {index, limit})
  }

  get_album_fans(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 100
    return this.api_call(`album/${album_id}/fans`, {index, limit})
  }

  get_album_tracks(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || -1
    return this.api_call(`album/${album_id}/tracks`, {index, limit})
  }

  get_artist(artist_id){
    return this.api_call(`artist/${artist_id}`)
  }

  get_artist_top(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`artist/${artist_id}/top`, {index, limit})
  }

  get_artist_albums(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || -1
    return this.api_call(`artist/${artist_id}/albums`, {index, limit})
  }

  get_artist_comments(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`artist/${artist_id}/comments`, {index, limit})
  }

  get_artist_fans(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 100
    return this.api_call(`artist/${artist_id}/fans`, {index, limit})
  }

  get_artist_related(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 20
    return this.api_call(`artist/${artist_id}/related`, {index, limit})
  }

  get_artist_radio(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`artist/${artist_id}/radio`, {index, limit})
  }

  get_artist_playlists(artist_id, options={}){
    const index = options.index || 0
    const limit = options.limit || -1
    return this.api_call(`artist/${artist_id}/playlists`, {index, limit})
  }

  get_chart(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`chart/${genre_id}`, {index, limit})
  }

  get_chart_tracks(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`chart/${genre_id}/tracks`, {index, limit})
  }

  get_chart_albums(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`chart/${genre_id}/albums`, {index, limit})
  }

  get_chart_artists(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`chart/${genre_id}/artists`, {index, limit})
  }

  get_chart_playlists(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`chart/${genre_id}/playlists`, {index, limit})
  }

  get_chart_podcasts(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`chart/${genre_id}/podcasts`, {index, limit})
  }

  get_comment(comment_id){
    return this.api_call(`comment/${comment_id}`)
  }

  get_editorials(options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call('editorial', {index, limit})
  }

  get_editorial(genre_id=0){
    return this.api_call(`editorial/${genre_id}`)
  }

  get_editorial_selection(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`editorial/${genre_id}/selection`, {index, limit})
  }

  get_editorial_charts(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`editorial/${genre_id}/charts`, {index, limit})
  }

  get_editorial_releases(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`editorial/${genre_id}/releases`, {index, limit})
  }

  get_genres(options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call('genre', {index, limit})
  }

  get_genre(genre_id=0){
    return this.api_call(`genre/${genre_id}`)
  }

  get_genre_artists(genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`genre/${genre_id}/artists`, {index, limit})
  }

  get_genre_radios( genre_id=0, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`genre/${genre_id}/radios`, {index, limit})
  }

  get_infos(){
    return this.api_call('infos')
  }

  get_options(){
    return this.api_call('options')
  }

  get_playlist(playlist_id){
    return this.api_call(`playlist/${playlist_id}`)
  }

  get_playlist_comments(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call(`playlist/${album_id}/comments`, {index, limit})
  }

  get_playlist_fans(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 100
    return this.api_call(`playlist/${album_id}/fans`, {index, limit})
  }

  get_playlist_tracks(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || -1
    return this.api_call(`playlist/${album_id}/tracks`, {index, limit})
  }

  get_playlist_radio(album_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 100
    return this.api_call(`playlist/${album_id}/radio`, {index, limit})
  }

  get_radios(options={}){
    const index = options.index || 0
    const limit = options.limit || 10
    return this.api_call('radio', {index, limit})
  }

  get_radios_genres(options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call('radio/genres', {index, limit})
  }

  get_radios_top(options={}){
    const index = options.index || 0
    const limit = options.limit || 50
    return this.api_call('radio/top', {index, limit})
  }

  get_radios_lists(options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call('radio/lists', {index, limit})
  }

  get_radio(radio_id){
    return this.api_call(`radio/${radio_id}`)
  }

  get_radio_tracks(radio_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 40
    return this.api_call(`radio/${radio_id}/tracks`, {index, limit})
  }

  _generate_search_advanced_query(filters){
    let query = ""
    if (filters.artist) query += `artist:"${filters.artist}" `
    if (filters.album) query += `album:"${filters.album}" `
    if (filters.track) query += `track:"${filters.track}" `
    if (filters.label) query += `label:"${filters.label}" `
    if (filters.dur_min) query += `dur_min:"${filters.dur_min}" `
    if (filters.dur_max) query += `dur_max:"${filters.dur_max}" `
    if (filters.bpm_min) query += `bpm_min:"${filters.bpm_min}" `
    if (filters.bpm_max) query += `bpm_max:"${filters.bpm_max}" `
    return query.trim()
  }

  _generate_search_args(query, options={}){
    const strict = options.strict || false
    const order = options.order || SearchOrder.RANKING
    const index = options.index || 0
    const limit = options.limit || 25
    let args = {q: query, index, limit}
    if (strict) args.strict = 'on'
    if (order) args.order = order
    return args
  }

  search(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search', args)
  }

  advanced_search(filters, options={}){
    const query = this._generate_search_advanced_query(filters)
    return this.search(query, options={})
  }

  search_album(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search/album', args)
  }

  search_artist(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search/artist', args)
  }

  search_playlist(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search/playlist', args)
  }

  search_radio(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search/radio', args)
  }

  search_track(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search/track', args)
  }

  search_user(query, options={}){
    const args = this._generate_search_args(query, options={})
    return this.api_call('search/user', args)
  }

  get_track(song_id){
    return this.api_call(`track/${song_id}`)
  }

  get_track_by_ISRC(isrc){
    return this.get_track(`isrc:${isrc}`)
  }

  get_user(user_id){
    return this.api_call(`user/${user_id}`)
  }

  get_user_albums(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/albums`, {index, limit})
  }

  get_user_artists(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/artists`, {index, limit})
  }

  get_user_flow(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/flow`, {index, limit})
  }

  get_user_following(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/followings`, {index, limit})
  }

  get_user_followers(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/followers`, {index, limit})
  }

  get_user_playlists(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/playlists`, {index, limit})
  }

  get_user_radios(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/radios`, {index, limit})
  }

  get_user_tracks(user_id, options={}){
    const index = options.index || 0
    const limit = options.limit || 25
    return this.api_call(`user/${user_id}/tracks`, {index, limit})
  }

  // Extra calls

  async get_countries_charts(){
    let temp = await this.get_user_playlists('637006841', {index:0, limit:-1})
    let result = temp['data'].sort((a, b) => a.title.localeCompare(b.title)) // Sort all playlists
    if (!result[0].title.startsWith('Top')) result.shift() // Remove loved tracks playlist
    return result
  }


  async get_track_id_from_metadata(artist, track, album){
    artist = artist.replace("–", "-").replace("’", "'")
    track = track.replace("–", "-").replace("’", "'")
    album = album.replace("–", "-").replace("’", "'")

    let resp = await this.advanced_search({artist, track, album})
    if (resp.data.length) return resp.data[0].id

    resp = await this.advanced_search({artist, track})
    if (resp.data.length) return resp.data[0].id

    // Try removing version
    if ( track.indexOf("(") != -1 && track.indexOf(")") != -1 && track.indexOf("(") < track.indexOf(")") ){
      resp = await this.advanced_search({artist, track: track.split("(")[0]})
      if (resp.data.length) return resp.data[0].id
    } else if ( track.indexOf(" - ") != -1) {
      resp = await this.advanced_search({artist, track: track.split(" - ")[0]})
      if (resp.data.length) return resp.data[0].id
    }

    return "0"
  }
}

// Base class for Deezer exceptions
class APIError extends Error {
  constructor(message) {
    super(message);
    this.name = "APIError";
  }
}
class ItemsLimitExceededException extends APIError {
  constructor(message) {
    super(message);
    this.name = "ItemsLimitExceededException";
  }
}
class PermissionException extends APIError {
  constructor(message) {
    super(message);
    this.name = "PermissionException";
  }
}
class InvalidTokenException extends APIError {
  constructor(message) {
    super(message);
    this.name = "InvalidTokenException";
  }
}
class WrongParameterException extends APIError {
  constructor(message) {
    super(message);
    this.name = "WrongParameterException";
  }
}
class MissingParameterException extends APIError {
  constructor(message) {
    super(message);
    this.name = "MissingParameterException";
  }
}
class InvalidQueryException extends APIError {
  constructor(message) {
    super(message);
    this.name = "InvalidQueryException";
  }
}
class DataException extends APIError {
  constructor(message) {
    super(message);
    this.name = "DataException";
  }
}
class IndividualAccountChangedNotAllowedException extends APIError {
  constructor(message) {
    super(message);
    this.name = "IndividualAccountChangedNotAllowedException";
  }
}

module.exports = {
  SearchOrder,
  API,
  APIError,
  ItemsLimitExceededException,
  PermissionException,
  InvalidTokenException,
  WrongParameterException,
  MissingParameterException,
  InvalidQueryException,
  DataException,
  IndividualAccountChangedNotAllowedException
}