spotify-api / spotify-types

All the typings for the various Spotify API Object typings written in typescript.

Spotify Types

Module Documentation Reference: https://spotify-api.js.org/apiTypes/
Spotify Object Index Reference: https://developer.spotify.com/documentation/web-api/reference/#objects-index

All the typings for the various Spotify API Object typings written in typescript. You can view the Spotify web api reference for all the objects here.

This is a typings modules made for Spotify-api.js v9. This can also be used separately just for typescript debugging when working with Spotify API. This package can be even used in deno using the cdn urls.

import { SearchContent } from "spotify-types";
import axios, { AxiosResponse } from "axios";

const response: AxiosResponse<SearchContent> = await axios.get('https://api.spotify.com/v1/search', {
    headers: { "Authorization": "Bearer " + process.env.SPOTIFY_TOKEN },
    params: {
        q: "search query",
        type: "track",
        market: "US"
    }
});

spotify-types's Issues

Allow users to narrow down type

Hi! Thank you for creating a great package. However, while using it, I noticed I couldn't narrow down the object types using standard TS type guards. For example, given an item: Track | Episode; I can't narrow it down to Track by simply checking item.type === "episode".

This happens because all interfaces share the same SpotifyType, which doesn't guarantee an Episode will always have a "episode" as a type.

Could we change them to simple literal types to benefit from type narrowing? I'd like to file a PR if you're interested.

Missing types for the `recently-played` endpoint

I could not find any typings for the recently-played endpoint.
https://developer.spotify.com/console/get-recently-played/

Add types for token

I would like to have types for the token object returned from the access token request.

interface Token {
  accessToken: string;
  tokenType: string;
  expiresIn: number;
}

I can open a PR for it. Thank you

Missing return type for '/me/following' endpoint

See docs here. Suggested type below:

interface FollowedArtistCursors {
  /** The cursor to use as key to find the next page of items. */
  after: string;
  /** The cursor to use as key to find the previous page of items. */
  before: string;
}

interface FollowedArtistCursorPaging<T> {
  /** A link to the Web API endpoint returning the full result of the request. */
  href: string;
  /** The maximum number of items in the response (as set in the query or by default). */
  limit: number;
  /** URL to the next page of items. (null if none) */
  next: string;
  /** The cursors used to find the next set of items. */
  cursors: FollowedArtistCursors;
  /** The total number of items available to return. */
  total: number;
  /** The requested data. */
  items: T[];
}

interface FollowedArtistsResults {
  artists: FollowedArtistCursorPaging<Artist>;
}