musickitjs-v3-types/MusicKit.d.ts

import {
    Artwork,
    PlaybackBitrate
} from './enums';
import {
    MusicKitInstance
} from './MusicKitInstance';

export interface MusicKitConfiguration {
    /**
     * See https://js-cdn.music.apple.com/musickit/v3/docs/iframe.html?path=/story/get-started--page#configuring-musickit-on-the-web
     */
    'developerToken': string;

    /**
     * Your application configuration
     */
    'app': {
        /**
         * The name of your application
         */
        'name': string;

        /**
         * Build or version number of application
         */
        'build'?: string;

        /**
         * A URL to your application logo. Should be square at 152x152px
         */
        'icon'?: string;
    };

    'bitrate'?: PlaybackBitrate;

    /**
     * Set the storefront, which is set for the API requests.
     * If unset, then the authenticated user's storefrontId will be used.
     */
    'storefrontId'?: string;
}

export interface MusicKitObject {
    /**
     * Configure MusicKit
     * @param config - Configuration of MusicKit
     */
    'configure': ( config: MusicKitConfiguration ) => Promise<MusicKitInstance>;

    /**
     * Retrieve the MusicKit instance after configuring it.
     */
    'getInstance': () => MusicKitInstance;

    /**
     * Format an artwork object to get the formatted URL.
     * @param artwork - The artwork object as retrieved from the API
     * @param width - The desired width of the artwork
     * @param height - The desired height of the artwork
     */
    'formatArtworkURL': ( artwork: Artwork, width: number, height: number ) => string;
}