lastfm-nodejs-client 1.6.0 → 1.7.0

package/dist/@types/tag/getWeeklyChartList.d.ts

@@ -1,2 +1,11 @@
 import type { TagWeeklyChartListResponse } from '../lastfm.types.js';
+/**
+ * Get a list of available charts for this tag, expressed as date ranges which can be
+ * sent to the chart services.
+ *
+ * @see https://www.last.fm/api/show/tag.getWeeklyChartList
+ * @param method - The Last.fm API method string (`method.tag.getWeeklyChartList`)
+ * @param tag - The tag name
+ * @returns A list of date ranges representing available weekly charts for this tag
+ */
 export declare function tagGetWeeklyChartList(method: string, tag: string): Promise<TagWeeklyChartListResponse>;

package/dist/@types/tag/topTracks.d.ts

@@ -1,8 +1,11 @@
 import type { TagTopTracksResponse } from '../lastfm.types.js';
 /**
- * GET: Tag Top Tracks - LastFM
+ * Get the top tracks tagged with a given tag on Last.fm, ordered by tag count.
  *
- * https://www.last.fm/api/show/tag.getTopTracks
- * @returns Top Tracks for a tag
+ * @see https://www.last.fm/api/show/tag.getTopTracks
+ * @param method - The Last.fm API method string (`method.tag.getTopTracks`)
+ * @param tag - The tag name
+ * @param limit - Number of results to return
+ * @returns Top tracks for the given tag ordered by tag count
  */
 export declare function tagTopTracks(method: string, tag: string, limit: string): Promise<TagTopTracksResponse>;

package/dist/@types/track/addTags.d.ts

@@ -1,2 +1,13 @@
 import type { AuthResponse } from '../lastfm.types.js';
+/**
+ * Tag a track using a list of user-supplied tags. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/track.addTags
+ * @param method - The Last.fm API method string (`method.track.addTags`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param tags - A comma-separated list of tags to apply (max 10)
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export declare function trackAddTags(method: string, artist: string, track: string, tags: string, sk: string): Promise<AuthResponse>;

package/dist/@types/track/getCorrection.d.ts

@@ -1,2 +1,12 @@
 import type { TrackCorrectionResponse } from '../lastfm.types.js';
+/**
+ * Use the Last.fm corrections data to check whether the supplied track has a correction
+ * to a canonical track and artist name.
+ *
+ * @see https://www.last.fm/api/show/track.getCorrection
+ * @param method - The Last.fm API method string (`method.track.getCorrection`)
+ * @param artist - The artist name
+ * @param track - The track name to check for a correction
+ * @returns The corrected canonical track and artist name if one exists
+ */
 export declare function trackGetCorrection(method: string, artist: string, track: string): Promise<TrackCorrectionResponse>;

package/dist/@types/track/getInfo.d.ts

@@ -1,2 +1,13 @@
 import type { TrackInfoResponse } from '../lastfm.types.js';
+/**
+ * Get the metadata for a track on Last.fm. Includes wiki text, tags, and similar tracks.
+ *
+ * @see https://www.last.fm/api/show/track.getInfo
+ * @param method - The Last.fm API method string (`method.track.getInfo`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @param lang - ISO 639 alpha-2 language code for the wiki text (default `'en'`)
+ * @returns Track metadata including duration, play count, wiki, and top tags
+ */
 export declare function trackGetInfo(method: string, artist: string, track: string, autocorrect?: string, lang?: string): Promise<TrackInfoResponse>;

package/dist/@types/track/getSimilar.d.ts

@@ -1,2 +1,13 @@
 import type { TrackSimilarResponse } from '../lastfm.types.js';
+/**
+ * Get the similar tracks for this track on Last.fm, based on listening data.
+ *
+ * @see https://www.last.fm/api/show/track.getSimilar
+ * @param method - The Last.fm API method string (`method.track.getSimilar`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param limit - Maximum number of similar tracks to return (default `'30'`)
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns A list of similar tracks with match scores
+ */
 export declare function trackGetSimilar(method: string, artist: string, track: string, limit?: string, autocorrect?: string): Promise<TrackSimilarResponse>;

package/dist/@types/track/getTags.d.ts

@@ -1,2 +1,13 @@
 import type { TrackTagsResponse } from '../lastfm.types.js';
+/**
+ * Get the tags applied by an individual user to a track on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/track.getTags
+ * @param method - The Last.fm API method string (`method.track.getTags`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param user - The Last.fm username whose tags to retrieve
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Tags applied by the user to this track
+ */
 export declare function trackGetTags(method: string, artist: string, track: string, user: string, autocorrect?: string): Promise<TrackTagsResponse>;

package/dist/@types/track/getTopTags.d.ts

@@ -1,2 +1,12 @@
 import type { TrackTopTagsResponse } from '../lastfm.types.js';
+/**
+ * Get the top tags for a track on Last.fm, ordered by popularity.
+ *
+ * @see https://www.last.fm/api/show/track.getTopTags
+ * @param method - The Last.fm API method string (`method.track.getTopTags`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Top tags for the track ordered by tag count
+ */
 export declare function trackGetTopTags(method: string, artist: string, track: string, autocorrect?: string): Promise<TrackTopTagsResponse>;

package/dist/@types/track/love.d.ts

@@ -1,2 +1,12 @@
 import type { AuthResponse } from '../lastfm.types.js';
+/**
+ * Love a track for the authenticated user. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/track.love
+ * @param method - The Last.fm API method string (`method.track.love`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export declare function trackLove(method: string, artist: string, track: string, sk: string): Promise<AuthResponse>;

package/dist/@types/track/removeTag.d.ts

@@ -1,2 +1,13 @@
 import type { AuthResponse } from '../lastfm.types.js';
+/**
+ * Remove a user-applied tag from a track. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/track.removeTag
+ * @param method - The Last.fm API method string (`method.track.removeTag`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param tag - A single tag to remove from the track
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export declare function trackRemoveTag(method: string, artist: string, track: string, tag: string, sk: string): Promise<AuthResponse>;

package/dist/@types/track/scrobble.d.ts

@@ -1,2 +1,14 @@
 import type { ScrobbleResponse } from '../lastfm.types.js';
+/**
+ * Add a track-play to a user's scrobble history. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/track.scrobble
+ * @param method - The Last.fm API method string (`method.track.scrobble`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param timestamp - Unix timestamp of when the track was listened to
+ * @param album - The album name
+ * @param sk - A session key obtained via the auth flow
+ * @returns The accepted and ignored scrobble counts
+ */
 export declare function trackScrobble(method: string, artist: string, track: string, timestamp: string, album: string, sk: string): Promise<ScrobbleResponse>;

package/dist/@types/track/search.d.ts

@@ -1,2 +1,13 @@
 import type { TrackSearchResponse } from '../lastfm.types.js';
+/**
+ * Search for a track by track name, optionally filtered by artist. Returns paginated results.
+ *
+ * @see https://www.last.fm/api/show/track.search
+ * @param method - The Last.fm API method string (`method.track.search`)
+ * @param track - The track name to search for
+ * @param artist - Optionally narrow results to tracks by this artist
+ * @param limit - Number of results per page (default `'30'`)
+ * @param page - Page number to fetch (default `'1'`)
+ * @returns Paginated track search results
+ */
 export declare function trackSearch(method: string, track: string, artist?: string, limit?: string, page?: string): Promise<TrackSearchResponse>;

package/dist/@types/track/unlove.d.ts

@@ -1,2 +1,12 @@
 import type { AuthResponse } from '../lastfm.types.js';
+/**
+ * UnLove a track for the authenticated user. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/track.unlove
+ * @param method - The Last.fm API method string (`method.track.unlove`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export declare function trackUnlove(method: string, artist: string, track: string, sk: string): Promise<AuthResponse>;

package/dist/@types/track/updateNowPlaying.d.ts

@@ -1,2 +1,13 @@
 import type { AuthResponse } from '../lastfm.types.js';
+/**
+ * Notify Last.fm that a user has started listening to a track. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/track.updateNowPlaying
+ * @param method - The Last.fm API method string (`method.track.updateNowPlaying`)
+ * @param artist - The artist name
+ * @param track - The track name
+ * @param album - The album name
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the now-playing update
+ */
 export declare function trackUpdateNowPlaying(method: string, artist: string, track: string, album: string, sk: string): Promise<AuthResponse>;

package/dist/@types/user/getPersonalTags.d.ts

@@ -1,2 +1,14 @@
 import type { UserPersonalTagsResponse } from '../lastfm.types.js';
+/**
+ * Get the items tagged by a user, of the type specified, filtered by tag.
+ *
+ * @see https://www.last.fm/api/show/user.getPersonalTags
+ * @param method - The Last.fm API method string (`method.user.getPersonalTags`)
+ * @param user - The Last.fm username
+ * @param tag - The tag to filter by
+ * @param taggingtype - The type of items tagged (`artist`, `album`, or `track`)
+ * @param limit - Number of results per page (default `'50'`)
+ * @param page - Page number to fetch (default `'1'`)
+ * @returns Paginated list of items tagged by the user with the given tag
+ */
 export declare function userGetPersonalTags(method: string, user: string, tag: string, taggingtype: string, limit?: string, page?: string): Promise<UserPersonalTagsResponse>;

package/dist/album/addTags.js

@@ -1,5 +1,16 @@
 import { signedRequest } from '../request.js';
 import { config } from '../config.js';
+/**
+ * Tag an album using a list of user-supplied tags. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/album.addTags
+ * @param method - The Last.fm API method string (`method.album.addTags`)
+ * @param artist - The artist name
+ * @param album - The album name
+ * @param tags - A comma-separated list of tags to apply (max 10)
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export async function albumAddTags(method, artist, album, tags, sk) {
     return await signedRequest({ method, artist, album, tags, sk }, config.share_secret);
 }

package/dist/album/addTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../src/album/addTags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,EAAU;IACxG,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AACrG,CAAC"}
+{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../src/album/addTags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,EAAU;IACxG,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AACrG,CAAC"}

package/dist/album/getInfo.js

@@ -1,4 +1,15 @@
 import request from '../request.js';
+/**
+ * Get the metadata and tracklist for an album on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/album.getInfo
+ * @param method - The Last.fm API method string (`method.album.getInfo`)
+ * @param artist - The artist name
+ * @param album - The album name
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @param lang - ISO 639 alpha-2 language code for the biography text (default `'en'`)
+ * @returns Album metadata including tracklist, wiki, and tags
+ */
 export async function albumGetInfo(method, artist, album, autocorrect = '1', lang = 'en') {
     return await request({ method, artist, album, autocorrect, lang });
 }

package/dist/album/getInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"getInfo.js","sourceRoot":"","sources":["../../src/album/getInfo.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAC9G,OAAO,MAAM,OAAO,CAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC"}
+{"version":3,"file":"getInfo.js","sourceRoot":"","sources":["../../src/album/getInfo.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAC9G,OAAO,MAAM,OAAO,CAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC"}

package/dist/album/getTags.js

@@ -1,4 +1,15 @@
 import request from '../request.js';
+/**
+ * Get the tags applied by an individual user to an album on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/album.getTags
+ * @param method - The Last.fm API method string (`method.album.getTags`)
+ * @param artist - The artist name
+ * @param album - The album name
+ * @param user - The Last.fm username whose tags to retrieve
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Tags applied by the user to this album
+ */
 export async function albumGetTags(method, artist, album, user, autocorrect = '1') {
     return await request({ method, artist, album, user, autocorrect });
 }

package/dist/album/getTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../src/album/getTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IAC/G,OAAO,MAAM,OAAO,CAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AACxF,CAAC"}
+{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../src/album/getTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IAC/G,OAAO,MAAM,OAAO,CAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AACxF,CAAC"}

package/dist/album/getTopTags.js

@@ -1,4 +1,14 @@
 import request from '../request.js';
+/**
+ * Get the top tags applied to an album on Last.fm, ordered by tag count.
+ *
+ * @see https://www.last.fm/api/show/album.getTopTags
+ * @param method - The Last.fm API method string (`method.album.getTopTags`)
+ * @param artist - The artist name
+ * @param album - The album name
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Top tags for the album ordered by tag count
+ */
 export async function albumGetTopTags(method, artist, album, autocorrect = '1') {
     return await request({ method, artist, album, autocorrect });
 }

package/dist/album/getTopTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopTags.js","sourceRoot":"","sources":["../../src/album/getTopTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,OAAO,CAAuB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AACrF,CAAC"}
+{"version":3,"file":"getTopTags.js","sourceRoot":"","sources":["../../src/album/getTopTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,OAAO,CAAuB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AACrF,CAAC"}

package/dist/album/removeTag.js

@@ -1,5 +1,16 @@
 import { signedRequest } from '../request.js';
 import { config } from '../config.js';
+/**
+ * Remove a user-applied tag from an album. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/album.removeTag
+ * @param method - The Last.fm API method string (`method.album.removeTag`)
+ * @param artist - The artist name
+ * @param album - The album name
+ * @param tag - A single tag to remove from the album
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export async function albumRemoveTag(method, artist, album, tag, sk) {
     return await signedRequest({ method, artist, album, tag, sk }, config.share_secret);
 }

package/dist/album/removeTag.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../src/album/removeTag.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,GAAW,EAAE,EAAU;IACzG,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AACpG,CAAC"}
+{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../src/album/removeTag.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,GAAW,EAAE,EAAU;IACzG,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AACpG,CAAC"}

package/dist/album/search.js

@@ -1,4 +1,14 @@
 import request from '../request.js';
+/**
+ * Search for an album by name on Last.fm. Returns paginated results.
+ *
+ * @see https://www.last.fm/api/show/album.search
+ * @param method - The Last.fm API method string (`method.album.search`)
+ * @param album - The album name to search for
+ * @param limit - Number of results per page (default `'30'`)
+ * @param page - Page number to fetch (default `'1'`)
+ * @returns Paginated album search results
+ */
 export async function albumSearch(method, album, limit = '30', page = '1') {
     return await request({ method, album, limit, page });
 }

package/dist/album/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/album/search.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,KAAa,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACvF,OAAO,MAAM,OAAO,CAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,CAAC"}
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/album/search.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,KAAa,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACvF,OAAO,MAAM,OAAO,CAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,CAAC"}

package/dist/artist/addTags.js

@@ -1,5 +1,15 @@
 import { signedRequest } from '../request.js';
 import { config } from '../config.js';
+/**
+ * Tag an artist using a list of user-supplied tags. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/artist.addTags
+ * @param method - The Last.fm API method string (`method.artist.addTags`)
+ * @param artist - The artist name
+ * @param tags - A comma-separated list of tags to apply (max 10)
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export async function artistAddTags(method, artist, tags, sk) {
     return await signedRequest({ method, artist, tags, sk }, config.share_secret);
 }

package/dist/artist/addTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../src/artist/addTags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,EAAU;IAC1F,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC9F,CAAC"}
+{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../src/artist/addTags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,EAAU;IAC1F,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC9F,CAAC"}

package/dist/artist/getCorrection.js

@@ -1,4 +1,13 @@
 import request from '../request.js';
+/**
+ * Use the Last.fm corrections data to check whether the supplied artist has a correction
+ * to a canonical artist name.
+ *
+ * @see https://www.last.fm/api/show/artist.getCorrection
+ * @param method - The Last.fm API method string (`method.artist.getCorrection`)
+ * @param artist - The artist name to check for a correction
+ * @returns The corrected canonical artist name if one exists
+ */
 export async function artistGetCorrection(method, artist) {
     return await request({ method, artist });
 }

package/dist/artist/getCorrection.js.map

@@ -1 +1 @@
-{"version":3,"file":"getCorrection.js","sourceRoot":"","sources":["../../src/artist/getCorrection.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAAc,EAAE,MAAc;IACtE,OAAO,MAAM,OAAO,CAA2B,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AACrE,CAAC"}
+{"version":3,"file":"getCorrection.js","sourceRoot":"","sources":["../../src/artist/getCorrection.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAAc,EAAE,MAAc;IACtE,OAAO,MAAM,OAAO,CAA2B,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AACrE,CAAC"}

package/dist/artist/getInfo.js

@@ -1,4 +1,14 @@
 import request from '../request.js';
+/**
+ * Get the metadata for an artist on Last.fm. Includes biography, tags, and similar artists.
+ *
+ * @see https://www.last.fm/api/show/artist.getInfo
+ * @param method - The Last.fm API method string (`method.artist.getInfo`)
+ * @param artist - The artist name
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @param lang - ISO 639 alpha-2 language code for the biography text (default `'en'`)
+ * @returns Artist metadata including biography, similar artists, and top tags
+ */
 export async function artistGetInfo(method, artist, autocorrect = '1', lang = 'en') {
     return await request({ method, artist, autocorrect, lang });
 }

package/dist/artist/getInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"getInfo.js","sourceRoot":"","sources":["../../src/artist/getInfo.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAChG,OAAO,MAAM,OAAO,CAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAClF,CAAC"}
+{"version":3,"file":"getInfo.js","sourceRoot":"","sources":["../../src/artist/getInfo.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAChG,OAAO,MAAM,OAAO,CAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAClF,CAAC"}

package/dist/artist/getSimilar.js

@@ -1,4 +1,14 @@
 import request from '../request.js';
+/**
+ * Get all the artists similar to this artist.
+ *
+ * @see https://www.last.fm/api/show/artist.getSimilar
+ * @param method - The Last.fm API method string (`method.artist.getSimilar`)
+ * @param artist - The artist name
+ * @param limit - Maximum number of similar artists to return (default `'30'`)
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns A list of similar artists with match scores
+ */
 export async function artistGetSimilar(method, artist, limit = '30', autocorrect = '1') {
     return await request({ method, artist, limit, autocorrect });
 }

package/dist/artist/getSimilar.js.map

@@ -1 +1 @@
-{"version":3,"file":"getSimilar.js","sourceRoot":"","sources":["../../src/artist/getSimilar.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,OAAO,CAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AACtF,CAAC"}
+{"version":3,"file":"getSimilar.js","sourceRoot":"","sources":["../../src/artist/getSimilar.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,OAAO,CAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AACtF,CAAC"}

package/dist/artist/getTags.js

@@ -1,4 +1,14 @@
 import request from '../request.js';
+/**
+ * Get the tags applied by an individual user to an artist on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/artist.getTags
+ * @param method - The Last.fm API method string (`method.artist.getTags`)
+ * @param artist - The artist name
+ * @param user - The Last.fm username whose tags to retrieve
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Tags applied by the user to this artist
+ */
 export async function artistGetTags(method, artist, user, autocorrect = '1') {
     return await request({ method, artist, user, autocorrect });
 }

package/dist/artist/getTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../src/artist/getTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IACjG,OAAO,MAAM,OAAO,CAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAClF,CAAC"}
+{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../src/artist/getTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IACjG,OAAO,MAAM,OAAO,CAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAClF,CAAC"}

package/dist/artist/getTopAlbums.js

@@ -1,4 +1,15 @@
 import request from '../request.js';
+/**
+ * Get the top albums for an artist on Last.fm, ordered by popularity.
+ *
+ * @see https://www.last.fm/api/show/artist.getTopAlbums
+ * @param method - The Last.fm API method string (`method.artist.getTopAlbums`)
+ * @param artist - The artist name
+ * @param limit - Number of results per page (default `'50'`)
+ * @param page - Page number to fetch (default `'1'`)
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Paginated list of the artist's top albums
+ */
 export async function artistGetTopAlbums(method, artist, limit = '50', page = '1', autocorrect = '1') {
     return await request({ method, artist, limit, page, autocorrect });
 }

package/dist/artist/getTopAlbums.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopAlbums.js","sourceRoot":"","sources":["../../src/artist/getTopAlbums.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,OAAO,CAA0B,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9F,CAAC"}
+{"version":3,"file":"getTopAlbums.js","sourceRoot":"","sources":["../../src/artist/getTopAlbums.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,OAAO,CAA0B,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9F,CAAC"}

package/dist/artist/getTopTags.js

@@ -1,4 +1,13 @@
 import request from '../request.js';
+/**
+ * Get the top tags for an artist on Last.fm, ordered by popularity.
+ *
+ * @see https://www.last.fm/api/show/artist.getTopTags
+ * @param method - The Last.fm API method string (`method.artist.getTopTags`)
+ * @param artist - The artist name
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Top tags for the artist ordered by tag count
+ */
 export async function artistGetTopTags(method, artist, autocorrect = '1') {
     return await request({ method, artist, autocorrect });
 }

package/dist/artist/getTopTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopTags.js","sourceRoot":"","sources":["../../src/artist/getTopTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG;IACtF,OAAO,MAAM,OAAO,CAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;AAC/E,CAAC"}
+{"version":3,"file":"getTopTags.js","sourceRoot":"","sources":["../../src/artist/getTopTags.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG;IACtF,OAAO,MAAM,OAAO,CAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;AAC/E,CAAC"}

package/dist/artist/getTopTracks.js

@@ -1,4 +1,15 @@
 import request from '../request.js';
+/**
+ * Get the top tracks for an artist on Last.fm, ordered by popularity.
+ *
+ * @see https://www.last.fm/api/show/artist.getTopTracks
+ * @param method - The Last.fm API method string (`method.artist.getTopTracks`)
+ * @param artist - The artist name
+ * @param limit - Number of results per page (default `'50'`)
+ * @param page - Page number to fetch (default `'1'`)
+ * @param autocorrect - Set to `'1'` to auto-correct misspelled names (default `'1'`)
+ * @returns Paginated list of the artist's top tracks
+ */
 export async function artistGetTopTracks(method, artist, limit = '50', page = '1', autocorrect = '1') {
     return await request({ method, artist, limit, page, autocorrect });
 }

package/dist/artist/getTopTracks.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopTracks.js","sourceRoot":"","sources":["../../src/artist/getTopTracks.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,OAAO,CAA0B,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9F,CAAC"}
+{"version":3,"file":"getTopTracks.js","sourceRoot":"","sources":["../../src/artist/getTopTracks.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,OAAO,CAA0B,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9F,CAAC"}

package/dist/artist/removeTag.js

@@ -1,5 +1,15 @@
 import { signedRequest } from '../request.js';
 import { config } from '../config.js';
+/**
+ * Remove a user-applied tag from an artist. Requires authentication.
+ *
+ * @see https://www.last.fm/api/show/artist.removeTag
+ * @param method - The Last.fm API method string (`method.artist.removeTag`)
+ * @param artist - The artist name
+ * @param tag - A single tag to remove from the artist
+ * @param sk - A session key obtained via the auth flow
+ * @returns Authentication response confirming the operation
+ */
 export async function artistRemoveTag(method, artist, tag, sk) {
     return await signedRequest({ method, artist, tag, sk }, config.share_secret);
 }

package/dist/artist/removeTag.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../src/artist/removeTag.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,GAAW,EAAE,EAAU;IAC3F,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC7F,CAAC"}
+{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../src/artist/removeTag.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,GAAW,EAAE,EAAU;IAC3F,OAAO,MAAM,aAAa,CAAe,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC7F,CAAC"}

package/dist/artist/search.js

@@ -1,4 +1,14 @@
 import request from '../request.js';
+/**
+ * Search for an artist by name on Last.fm. Returns paginated results.
+ *
+ * @see https://www.last.fm/api/show/artist.search
+ * @param method - The Last.fm API method string (`method.artist.search`)
+ * @param artist - The artist name to search for
+ * @param limit - Number of results per page (default `'30'`)
+ * @param page - Page number to fetch (default `'1'`)
+ * @returns Paginated artist search results
+ */
 export async function artistSearch(method, artist, limit = '30', page = '1') {
     return await request({ method, artist, limit, page });
 }

package/dist/artist/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/artist/search.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACzF,OAAO,MAAM,OAAO,CAAuB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9E,CAAC"}
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/artist/search.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACzF,OAAO,MAAM,OAAO,CAAuB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9E,CAAC"}

package/dist/auth/getMobileSession.js

@@ -1,5 +1,16 @@
 import { signedRequest } from '../request.js';
 import { config } from '../config.js';
+/**
+ * Create a session for a user using their username and password (mobile auth flow).
+ *
+ * The returned session key can be used for authenticated write operations.
+ *
+ * @see https://www.last.fm/api/show/auth.getMobileSession
+ * @param method - The Last.fm API method string (`method.auth.getMobileSession`)
+ * @param username - The Last.fm username
+ * @param password - The user's plaintext password
+ * @returns A session key valid for write operations
+ */
 export async function authGetMobileSession(method, username, password) {
     return await signedRequest({ method, username, password }, config.share_secret);
 }

package/dist/auth/getMobileSession.js.map

@@ -1 +1 @@
-{"version":3,"file":"getMobileSession.js","sourceRoot":"","sources":["../../src/auth/getMobileSession.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,MAAc,EAAE,QAAgB,EAAE,QAAgB;IAC3F,OAAO,MAAM,aAAa,CAA4B,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC7G,CAAC"}
+{"version":3,"file":"getMobileSession.js","sourceRoot":"","sources":["../../src/auth/getMobileSession.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,MAAc,EAAE,QAAgB,EAAE,QAAgB;IAC3F,OAAO,MAAM,aAAa,CAA4B,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC7G,CAAC"}

package/dist/auth/getSession.js

@@ -1,5 +1,15 @@
 import { signedRequest } from '../request.js';
 import { config } from '../config.js';
+/**
+ * Fetch a session key for a user after they have authorised a token via the Last.fm web auth flow.
+ *
+ * Tokens are valid for 60 minutes and can only be used once.
+ *
+ * @see https://www.last.fm/api/show/auth.getSession
+ * @param method - The Last.fm API method string (`method.auth.getSession`)
+ * @param token - The token previously granted by `auth.getToken` and authorised by the user
+ * @returns A session key valid for write operations
+ */
 export async function authGetSession(method, token) {
     return await signedRequest({ method, token }, config.share_secret);
 }