geniURL-Mirror/src/types.d.ts

//#SECTION server

export type ServerResponse<T> = SuccessResponse<T> | ErrorResponse;

export type SuccessResponse<T> = {
  error: false;
  matches: number;
} & T;

export type ErrorResponse = {
  error: true;
  matches: 0 | null;
  message: string;
}

//#SECTION meta

interface Artist {
  name: string | null;
  url: string | null;
  image: string | null;
  headerImage: string | null;
}

/** geniURL song meta object */
export interface SongMeta {
  url: string;
  path: string;
  language: string | null;
  meta: {
    title: string;
    fullTitle: string;
    artists: string;
    releaseDate: {
      year: number | null;
      month: number | null;
      day: number | null;
    };
    primaryArtist: Artist | null;
    featuredArtists: Artist[];
  };
  resources: {
    thumbnail: string | null;
    image: string | null;
  };
  lyricsState: string;
  id: number;
}

export type MetaSearchHit = SongMeta & { uuid?: string; };

export interface GetMetaArgs {
  q?: string;
  artist?: string;
  song?: string;
  threshold?: number;
  preferLang?: string;
}

export type SearchFilterArgs = GetMetaArgs;

export type ScoredResults<T> = {
  score: number;
  result: T;
};

export interface GetMetaResult {
  top: SongMeta;
  all: SongMeta[];
}

//#SECTION translations

export interface SongTranslation {
  language: string;
  id: number;
  path: string;
  title: string;
  url: string;
}

export interface GetTranslationsArgs {
  preferLang?: string;
}

//#SECTION server

export type ResponseType = "serverError" | "clientError" | "success";

export type ResponseFormat = "json" | "xml";

//#SECTION API

/** The entire object returned by the search endpoint of the genius API */
export type ApiSearchResult = {
  response: {
    hits: SearchHit[];
  };
};

/** The entire object returned by the songs endpoint of the genius API */
export type ApiSongResult = {
  response: {
    song: SongObj;
  }
}

/** One result returned by the genius API search */
export type SearchHit = {
  type: "song";
  result: SongBaseObj & {
    release_date_components: {
      year: number;
      month: number;
      day: number;
    };
    featured_artists: ArtistObj[];
  };
};

/** Result returned by the songs endpoint of the genius API */
export type SongObj = SongBaseObj & {
  album: {
    api_path: string;
    cover_art_url: string;
    full_title: string;
    id: number;
    name: string;
    url: string;
    artist: ArtistObj;
  },
  translation_songs: {
    api_path: string;
    id: number;
    language: string;
    lyrics_state: string;
    path: string;
    title: string;
    url: string;
  }[];
};

type SongBaseObj = {
  api_path: string;
  artist_names: string;
  primary_artist: ArtistObj;
  full_title: string;
  header_image_thumbnail_url: string;
  header_image_url: string;
  id: number;
  language: string;
  lyrics_owner_id: number;
  lyrics_state: "complete";
  path: string;
  pyongs_count: number;
  relationships_index_url: string;
  song_art_image_thumbnail_url: string;
  song_art_image_url: string;
  title: string;
  title_with_featured: string;
  url: string;
};

type ArtistObj = {
  api_path: string;
  header_image_url: string;
  id: number;
  image_url: string;
  name: string;
  url: string;
}

export interface Album {
  name: string;
  fullTitle: string;
  url: string;
  coverArt: string | null;
  id: number;
  artist: Artist;
}

//#SECTION internal
export type SupportedMethods = "GET";