audd.io/src/interface.ts

A NodeJS package used to interact with the music recognition API provided by Audd.io

import { URLSearchParams } from 'url';

export interface IExtra {
    /** Set to "true" to get accurate start and end offsets of the recognized tracks */
    accurate_offsets?: string;
    /** How many 12 seconds chunks are skipped after the ones that are recognized */
    skip?: number;
    /** How many chunks should be recognized in a row */
    every?: number;
    /** The upper bound for the number of chunks the server will recognize */
    limit?: number;
    /** How many chunks the server should skip before the first one to be recognized */
    skip_first?: number;
    /** Set to "true" if the URL links not to a file, but to a page that contains video or audio */
    process_content?: string;
    /** Set to "true" if you want the server to add the time represented in "t", "time_continue", or "start" parameters of the URL, if one exists, devided by 12 to the skip_first */
    use_timecode?: string;
    [index: string]: any;
}

export interface IResponse {
    /** error or success. Determines if the request was successful */
    status: 'error' | 'success' | string;
    /** Returned when a successful match was made. null if unable to match */
    result?: IResult | null;
    /** Contains information about the error */
    error?: IError;
    /** Contains a list of parameters you passed. Only displayed when the request fails */
    requested_params?: IParams;
}

export interface IEnterpriseResponse {
    status: 'error' | 'success' | string;
    result: IEnterpriseResult[];
    execution_time: string;
}

export interface IEnterpriseResult {
    songs: IEnterpriseGuess[];
    offset: string;
}

export interface IGuess {
    status: 'error' | 'success' | string;
    error?: IError;
    result: IGuessResult | null;
}

export interface IEnterpriseGuess {
    score: number;
    artist: string;
    title: string;
    album: string;
    release_date: string;
    label: string;
    isrc: string;
    upc: string;
    song_link: string;
}

interface IGuessResult {
    underground: string;
    humming: boolean;
    count: number;
    list: IGuessItem[];
}

interface IGuessItem {
    score: number;
    artist: string;
    title: string;
}

export interface IData {
    method: 'GET' | 'POST';
    params?: URLSearchParams;
    body?: {
        api_token: string;
        url: string;
    };
    headers?: { [key: string]: any };
    path: string;
}

interface IError {
    /** Error Code */
    error_code: number;
    /** Message detailing why the request failed */
    error_message: string;
}

interface IParams {
    url: string;
    method: string;
}

interface IResult {
    /** Artist name */
    artist: string;
    /** Song title */
    title: string;
    /** Song Album */
    album: string;
    release_date: string;
    label: string;
    timecode: string;
    /** Provides a lis.tn link to find the track across multiple services */
    song_link: string;
    apple_music?: AppleMusic;
    spotify?: Spotify;
}

interface AppleArtwork {
    width: number;
    height: number;
    url: string;
    bgColor: string;
    textColor1: string;
    textColor2: string;
    textColor3: string;
    textColor4: string;
}

interface ApplePreview {
    url: string;
}

interface AppleMusic {
    previews: ApplePreview[];
    artwork: AppleArtwork;
    artistName: string;
    url: string;
    discNumber: number;
    genreNames: string[];
    durationInMillis: number;
    releaseDate: string;
    name: string;
    isrc: string;
    albumName: string;
    playParams: {
        id: string;
        kind: string;
    };
    trackNumber: number;
    composerName: string;
}

interface Spotify {
    album: SpotifyAlbum;
    artists: Artist[];
    available_markets?: any;
    disc_number: number;
    duration_ms: number;
    explicit: boolean;
    external_ids: {
        isrc: string;
    };
    external_urls: SpotifyLinks;
    href: string;
    id: string;
    is_local: boolean;
    name: string;
    popularity: number;
    track_number: number;
    type: string;
    uri: string;
}

interface Image {
    height: number;
    url: string;
    width: number;
}

interface SpotifyAlbum {
    album_type: string;
    artists: Artist[];
    available_markets?: any;
    external_urls: SpotifyLinks;
    href: string;
    id: string;
    images: Image[];
    name: string;
    release_date: string;
    release_date_precision: string;
    total_tracks: number;
    type: string;
    uri: string;
}

interface SpotifyLinks {
    spotify: string;
}

interface Artist {
    external_urls: SpotifyLinks;
    href: string;
    id: string;
    name: string;
    type: string;
    uri: string;
}