@ekwoka/spotify-api - npm Package Compare versions

Comparing version 0.11.5 to 0.12.0

dist/endpoints/index.d.ts

@@ -17,2 +17,3 @@ export { albumIsSaved } from './albums/albumIsSaved';
 export { getPlaylist } from './playlists/getPlaylist';
+export { getPlaylistItems } from './playlists/getPlaylistItems';
 export { getUsersPlaylists } from './playlists/getUsersPlaylists';
@@ -36,3 +37,3 @@ export { search } from './search/search';
 export type { Context } from './player/types';
-export type { Playlist, PlaylistStub } from './playlists/types';
+export type { Playlist, PlaylistItem, PlaylistStub } from './playlists/types';
 export type { QueryType, PageType, SearchResults } from './search/types';
@@ -39,0 +40,0 @@ export type { Recommendations } from './tracks/getRecommendations';

dist/endpoints/index.js

@@ -17,2 +17,3 @@ export { albumIsSaved } from './albums/albumIsSaved';
 export { getPlaylist } from './playlists/getPlaylist';
+export { getPlaylistItems } from './playlists/getPlaylistItems';
 export { getUsersPlaylists } from './playlists/getUsersPlaylists';
@@ -19,0 +20,0 @@ export { search } from './search/search';

dist/endpoints/playlists/index.d.ts

 export { getPlaylist } from './getPlaylist';
+export { getPlaylistItems } from './getPlaylistItems';
 export { getUsersPlaylists } from './getUsersPlaylists';
-export type { Playlist, PlaylistStub } from './types';
+export type { Playlist, PlaylistItem, PlaylistStub } from './types';
 //# sourceMappingURL=index.d.ts.map

dist/endpoints/playlists/index.js

 export { getPlaylist } from './getPlaylist';
+export { getPlaylistItems } from './getPlaylistItems';
 export { getUsersPlaylists } from './getUsersPlaylists';

dist/endpoints/playlists/types.d.ts

@@ -11,3 +11,3 @@ import { PaginatedList } from '../../core';
 };
-declare type PlaylistItem = {
+export declare type PlaylistItem = {
     added_at: string;
@@ -27,2 +27,3 @@ added_by: {
         episode: boolean;
+        track: boolean;
     };
@@ -63,3 +64,2 @@ video_thumbnail: {
 };
-export {};
 //# sourceMappingURL=types.d.ts.map

dist/index.d.ts

 export { fetchOptions, makeAuthURL, refreshToken, tokensFromCode, } from './auth';
 export { resetCache, setToken, spotifyApiClient } from './core';
-export { albumIsSaved, addToQueue, currentlyPlayingTrack, getAlbum, getAlbums, getAlbumTracks, getArtist, getArtists, getCurrentUser, getPlaylist, getRecommendations, getSavedAlbums, getTopItems, getUserProfile, getUsersPlaylists, newReleases, recentlyPlayedTracks, removeAlbums, removeTracks, saveAlbums, saveTracks, search, trackIsSaved, } from './endpoints';
+export { albumIsSaved, addToQueue, currentlyPlayingTrack, getAlbum, getAlbums, getAlbumTracks, getArtist, getArtists, getCurrentUser, getPlaylist, getPlaylistItems, getRecommendations, getSavedAlbums, getTopItems, getUserProfile, getUsersPlaylists, newReleases, recentlyPlayedTracks, removeAlbums, removeTracks, saveAlbums, saveTracks, search, trackIsSaved, } from './endpoints';
 export { spotifyFetch } from './utils/spotifyFetch';
@@ -5,0 +5,0 @@ export type { RefreshedToken, SpotifyTokens } from './auth';

dist/index.js

 export { fetchOptions, makeAuthURL, refreshToken, tokensFromCode, } from './auth';
 export { resetCache, setToken, spotifyApiClient } from './core';
-export { albumIsSaved, addToQueue, currentlyPlayingTrack, getAlbum, getAlbums, getAlbumTracks, getArtist, getArtists, getCurrentUser, getPlaylist, getRecommendations, getSavedAlbums, getTopItems, getUserProfile, getUsersPlaylists, newReleases, recentlyPlayedTracks, removeAlbums, removeTracks, saveAlbums, saveTracks, search, trackIsSaved, } from './endpoints';
+export { albumIsSaved, addToQueue, currentlyPlayingTrack, getAlbum, getAlbums, getAlbumTracks, getArtist, getArtists, getCurrentUser, getPlaylist, getPlaylistItems, getRecommendations, getSavedAlbums, getTopItems, getUserProfile, getUsersPlaylists, newReleases, recentlyPlayedTracks, removeAlbums, removeTracks, saveAlbums, saveTracks, search, trackIsSaved, } from './endpoints';
 export { spotifyFetch } from './utils/spotifyFetch';

package.json

@@ -16,3 +16,3 @@ {
   "license": "MIT",
-  "version": "0.11.5",
+  "version": "0.12.0",
   "description": "Composable Wrapper for the Spotify Web Api and Spotify Web Playback SDK",
@@ -30,7 +30,7 @@ "repository": "github:ekwoka/spotify-api",
   "devDependencies": {
-    "@types/node": "^18.11.0",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
-    "@typescript-eslint/parser": "^5.40.0",
+    "@types/node": "^18.11.3",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
     "@vitest/coverage-c8": "^0.24.3",
-    "esbuild": "^0.15.11",
+    "esbuild": "^0.15.12",
     "eslint": "^8.25.0",
@@ -37,0 +37,0 @@ "gzip-size": "^7.0.0",

README.md

@@ -334,2 +334,3 @@ # ⚡️A tree-shakable, composable, lightweight wrapper for the multiple Spotify APIs🔥
 - `getPlaylist` - Gets complete playlist information by playlist ID
+- `getPlaylistItems` - Gets Items from playlist by ID
 - `getUsersPlaylists` - Gets playlists created by or saved by the current user
@@ -352,2 +353,23 @@
 
+#### getPlaylistItems
+
+Gets the items in a playlist (tracks and episodes)
+
+> Note: When using `getPlaylist` the first 100 items are returned automatically, making this endpoint unnecessary when that suffices
+
+```js
+const tracks = await client(getPlaylistItems('37i9dQZF1DX5g856aiKiDS'));
+const tracks = await client(
+  getPlaylistItems('37i9dQZF1DX5g856aiKiDS', { limit: Infinity })
+);
+```
+
+Options:
+
+- `limit`: How many playlists to return in the results. (default: `100`)
+- `offset`: How far into the list to start the results (default: `0`)
+- `market`: Which markets to filter the returned items by
+
+This endpoint dynamically bypasses the server-side limit cap of `100`. When larger limits are provided (and a playlist that has more than 100 items), this library will performa multiple requests to satisfy the limit. To retrieve the entire playlist, just provide a limit of `Infinity`
+
 #### getUsersPlaylists
@@ -354,0 +376,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

123914

increased by3.07%

Number of package files

200

increased by1.52%

Lines of code

1699

increased by2.47%

Number of lines in readme file

645

increased by3.53%

No dependency changes