MusicMetaFinder/src/api/lyricRetrieval.js

import axiosRetry from '../services/retryAxios.js';
import { handleError } from '../errors/generalApiErrorHandler.js';

/**
 * Fetches lyrics for a specific song using the provided artist name and title.
 * Makes a call to the `lyrics.ovh` API and returns the lyrics found, if any.
 *
 * @param {string} artist - The name of the artist.
 * @param {string} title - The title of the song.
 * @returns {Promise<string|null>} Promise object representing the lyrics for the song or null if not found or in case of an error.
 */
export default function fetchLyrics(artist, title) {
  const endpoint = `https://api.lyrics.ovh/v1/${encodeURIComponent(artist)}/${encodeURIComponent(title)}`;

  return axiosRetry.get(endpoint)
    .then((response) =>
      // Access the lyrics from the response data object
      response.data.lyrics || null, // If no lyrics are found, return null
    )
    .catch((error) => {
      // Use the general API error handler to handle the error
      const errorMessage = handleError(error, `${artist} - ${title}`);
      console.error(errorMessage);
      return null; // Return null to indicate failure to retrieve lyrics
    });
}