lastfm-nodejs-client 1.6.0 → 1.7.0

package/dist/auth/getSession.js.map

@@ -1 +1 @@
-{"version":3,"file":"getSession.js","sourceRoot":"","sources":["../../src/auth/getSession.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,KAAa;IAChE,OAAO,MAAM,aAAa,CAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC1F,CAAC"}
+{"version":3,"file":"getSession.js","sourceRoot":"","sources":["../../src/auth/getSession.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,cAAc,CAAC,MAAc,EAAE,KAAa;IAChE,OAAO,MAAM,aAAa,CAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;AAC1F,CAAC"}

package/dist/auth.js

@@ -1,14 +1,17 @@
 import { createOptions } from './createOptions.js';
 import request from './request.js';
 /**
- * POST: Auth - LastFM
+ * Fetch an unauthenticated token for the web auth flow.
  *
- * https://www.last.fm/api/show/auth.getToken
+ * Tokens are API-account-specific, valid for 60 minutes, and consumed
+ * once a session is created via `auth.getSession`.
  *
- * Authentication tokens are API account specific.
- * They are valid for 60 minutes from the moment they are granted.
- * Can only used once (they are consumed when a session is created).
- * @returns Auth token
+ * @see https://www.last.fm/api/show/auth.getToken
+ * @param method - The Last.fm API method string (`method.auth.getToken`)
+ * @param user - The Last.fm username
+ * @param period - The time period parameter
+ * @param limit - The limit parameter
+ * @returns An unauthenticated token to redirect the user to the Last.fm auth page
  */
 export async function auth(method, user, period, limit) {
     const options = createOptions(method, user, period, limit);

package/dist/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAc,EACd,IAAY,EACZ,MAAc,EACd,KAAa;IAEb,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,MAAM,OAAO,CAAe,OAAO,CAAC,CAAC;AAC9C,CAAC"}
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAc,EACd,IAAY,EACZ,MAAc,EACd,KAAa;IAEb,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,MAAM,OAAO,CAAe,OAAO,CAAC,CAAC;AAC9C,CAAC"}

package/dist/chart/topArtists.js

@@ -1,5 +1,16 @@
 import { createOptions } from '../createOptions.js';
 import request from '../request.js';
+/**
+ * Get the top artists chart on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/chart.getTopArtists
+ * @param method - The Last.fm API method string (`method.chart.getTopArtists`)
+ * @param user - The Last.fm username
+ * @param period - The time period over which to retrieve the chart
+ * @param page - Page number to fetch
+ * @param limit - Number of results per page
+ * @returns Paginated list of the most popular artists globally
+ */
 export async function chartTopArtists(method, user, period, page, limit) {
     const options = createOptions(method, user, period, page, limit);
     return await request(options);

package/dist/chart/topArtists.js.map

@@ -1 +1 @@
-{"version":3,"file":"topArtists.js","sourceRoot":"","sources":["../../src/chart/topArtists.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,MAAc,EACd,IAAY,EACZ,KAAa;IAEb,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACjE,OAAO,MAAM,OAAO,CAAyB,OAAO,CAAC,CAAC;AACxD,CAAC"}
+{"version":3,"file":"topArtists.js","sourceRoot":"","sources":["../../src/chart/topArtists.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,MAAc,EACd,IAAY,EACZ,KAAa;IAEb,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACjE,OAAO,MAAM,OAAO,CAAyB,OAAO,CAAC,CAAC;AACxD,CAAC"}

package/dist/chart/topTags.js

@@ -1,5 +1,13 @@
 import { createOptions } from '../createOptions.js';
 import request from '../request.js';
+/**
+ * Get the top tags chart on Last.fm, ordered by tag popularity.
+ *
+ * @see https://www.last.fm/api/show/chart.getTopTags
+ * @param method - The Last.fm API method string (`method.chart.getTopTags`)
+ * @param page - Page number to fetch
+ * @returns Paginated list of the most popular tags globally
+ */
 export async function chartTopTags(method, page) {
     const options = createOptions(method, page);
     return await request(options);

package/dist/chart/topTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"topTags.js","sourceRoot":"","sources":["../../src/chart/topTags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY;IAC7D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5C,OAAO,MAAM,OAAO,CAAuB,OAAO,CAAC,CAAC;AACtD,CAAC"}
+{"version":3,"file":"topTags.js","sourceRoot":"","sources":["../../src/chart/topTags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY;IAC7D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5C,OAAO,MAAM,OAAO,CAAuB,OAAO,CAAC,CAAC;AACtD,CAAC"}

package/dist/chart/topTracks.js

@@ -1,5 +1,13 @@
 import { createOptions } from '../createOptions.js';
 import request from '../request.js';
+/**
+ * Get the top tracks chart on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/chart.getTopTracks
+ * @param method - The Last.fm API method string (`method.chart.getTopTracks`)
+ * @param page - Page number to fetch
+ * @returns Paginated list of the most popular tracks globally
+ */
 export async function chartTopTracks(method, page) {
     const options = createOptions(method, page);
     return await request(options);

package/dist/chart/topTracks.js.map

@@ -1 +1 @@
-{"version":3,"file":"topTracks.js","sourceRoot":"","sources":["../../src/chart/topTracks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,IAAY;IAC/D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5C,OAAO,MAAM,OAAO,CAAyB,OAAO,CAAC,CAAC;AACxD,CAAC"}
+{"version":3,"file":"topTracks.js","sourceRoot":"","sources":["../../src/chart/topTracks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,IAAY;IAC/D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5C,OAAO,MAAM,OAAO,CAAyB,OAAO,CAAC,CAAC;AACxD,CAAC"}

package/dist/cjs/album/addTags.js

@@ -3,6 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.albumAddTags = albumAddTags;
 const request_js_1 = require("../request.js");
 const config_js_1 = require("../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
+ */
 async function albumAddTags(method, artist, album, tags, sk) {
     return await (0, request_js_1.signedRequest)({ method, artist, album, tags, sk }, config_js_1.config.share_secret);
 }

package/dist/cjs/album/addTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../../src/album/addTags.ts"],"names":[],"mappings":";;AAGA,oCAEC;AAJD,8CAA8C;AAC9C,4CAAsC;AAC/B,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,EAAU;IACxG,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AACrG,CAAC"}
+{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../../src/album/addTags.ts"],"names":[],"mappings":";;AAeA,oCAEC;AAhBD,8CAA8C;AAC9C,4CAAsC;AAEtC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,EAAU;IACxG,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AACrG,CAAC"}

package/dist/cjs/album/getInfo.js

@@ -5,6 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.albumGetInfo = albumGetInfo;
 const request_js_1 = __importDefault(require("../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
+ */
 async function albumGetInfo(method, artist, album, autocorrect = '1', lang = 'en') {
     return await (0, request_js_1.default)({ method, artist, album, autocorrect, lang });
 }

package/dist/cjs/album/getInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"getInfo.js","sourceRoot":"","sources":["../../../src/album/getInfo.ts"],"names":[],"mappings":";;;;;AAEA,oCAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAC9G,OAAO,MAAM,IAAA,oBAAO,EAAoB,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,oCAEC;AAfD,+DAAoC;AAEpC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAC9G,OAAO,MAAM,IAAA,oBAAO,EAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC"}

package/dist/cjs/album/getTags.js

@@ -5,6 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.albumGetTags = albumGetTags;
 const request_js_1 = __importDefault(require("../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
+ */
 async function albumGetTags(method, artist, album, user, autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, album, user, autocorrect });
 }

package/dist/cjs/album/getTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../../src/album/getTags.ts"],"names":[],"mappings":";;;;;AAEA,oCAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IAC/G,OAAO,MAAM,IAAA,oBAAO,EAAoB,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,oCAEC;AAfD,+DAAoC;AAEpC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IAC/G,OAAO,MAAM,IAAA,oBAAO,EAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AACxF,CAAC"}

package/dist/cjs/album/getTopTags.js

@@ -5,6 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.albumGetTopTags = albumGetTopTags;
 const request_js_1 = __importDefault(require("../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
+ */
 async function albumGetTopTags(method, artist, album, autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, album, autocorrect });
 }

package/dist/cjs/album/getTopTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopTags.js","sourceRoot":"","sources":["../../../src/album/getTopTags.ts"],"names":[],"mappings":";;;;;AAEA,0CAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,IAAA,oBAAO,EAAuB,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":";;;;;AAaA,0CAEC;AAdD,+DAAoC;AAEpC;;;;;;;;;GASG;AACI,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,IAAA,oBAAO,EAAuB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AACrF,CAAC"}

package/dist/cjs/album/removeTag.js

@@ -3,6 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.albumRemoveTag = albumRemoveTag;
 const request_js_1 = require("../request.js");
 const config_js_1 = require("../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
+ */
 async function albumRemoveTag(method, artist, album, tag, sk) {
     return await (0, request_js_1.signedRequest)({ method, artist, album, tag, sk }, config_js_1.config.share_secret);
 }

package/dist/cjs/album/removeTag.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../../src/album/removeTag.ts"],"names":[],"mappings":";;AAGA,wCAEC;AAJD,8CAA8C;AAC9C,4CAAsC;AAC/B,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,GAAW,EAAE,EAAU;IACzG,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AACpG,CAAC"}
+{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../../src/album/removeTag.ts"],"names":[],"mappings":";;AAeA,wCAEC;AAhBD,8CAA8C;AAC9C,4CAAsC;AAEtC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,KAAa,EAAE,GAAW,EAAE,EAAU;IACzG,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AACpG,CAAC"}

package/dist/cjs/album/search.js

@@ -5,6 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.albumSearch = albumSearch;
 const request_js_1 = __importDefault(require("../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
+ */
 async function albumSearch(method, album, limit = '30', page = '1') {
     return await (0, request_js_1.default)({ method, album, limit, page });
 }

package/dist/cjs/album/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/album/search.ts"],"names":[],"mappings":";;;;;AAEA,kCAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,KAAa,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACvF,OAAO,MAAM,IAAA,oBAAO,EAAsB,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":";;;;;AAaA,kCAEC;AAdD,+DAAoC;AAEpC;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,KAAa,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACvF,OAAO,MAAM,IAAA,oBAAO,EAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,CAAC"}

package/dist/cjs/artist/addTags.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistAddTags = artistAddTags;
 const request_js_1 = require("../request.js");
 const config_js_1 = require("../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
+ */
 async function artistAddTags(method, artist, tags, sk) {
     return await (0, request_js_1.signedRequest)({ method, artist, tags, sk }, config_js_1.config.share_secret);
 }

package/dist/cjs/artist/addTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../../src/artist/addTags.ts"],"names":[],"mappings":";;AAGA,sCAEC;AAJD,8CAA8C;AAC9C,4CAAsC;AAC/B,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,EAAU;IAC1F,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC9F,CAAC"}
+{"version":3,"file":"addTags.js","sourceRoot":"","sources":["../../../src/artist/addTags.ts"],"names":[],"mappings":";;AAcA,sCAEC;AAfD,8CAA8C;AAC9C,4CAAsC;AAEtC;;;;;;;;;GASG;AACI,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,EAAU;IAC1F,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC9F,CAAC"}

package/dist/cjs/artist/getCorrection.js

@@ -5,6 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetCorrection = artistGetCorrection;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetCorrection(method, artist) {
     return await (0, request_js_1.default)({ method, artist });
 }

package/dist/cjs/artist/getCorrection.js.map

@@ -1 +1 @@
-{"version":3,"file":"getCorrection.js","sourceRoot":"","sources":["../../../src/artist/getCorrection.ts"],"names":[],"mappings":";;;;;AAEA,kDAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,mBAAmB,CAAC,MAAc,EAAE,MAAc;IACtE,OAAO,MAAM,IAAA,oBAAO,EAA2B,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AACrE,CAAC"}
+{"version":3,"file":"getCorrection.js","sourceRoot":"","sources":["../../../src/artist/getCorrection.ts"],"names":[],"mappings":";;;;;AAYA,kDAEC;AAbD,+DAAoC;AAEpC;;;;;;;;GAQG;AACI,KAAK,UAAU,mBAAmB,CAAC,MAAc,EAAE,MAAc;IACtE,OAAO,MAAM,IAAA,oBAAO,EAA2B,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AACrE,CAAC"}

package/dist/cjs/artist/getInfo.js

@@ -5,6 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetInfo = artistGetInfo;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetInfo(method, artist, autocorrect = '1', lang = 'en') {
     return await (0, request_js_1.default)({ method, artist, autocorrect, lang });
 }

package/dist/cjs/artist/getInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"getInfo.js","sourceRoot":"","sources":["../../../src/artist/getInfo.ts"],"names":[],"mappings":";;;;;AAEA,sCAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAChG,OAAO,MAAM,IAAA,oBAAO,EAAqB,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":";;;;;AAaA,sCAEC;AAdD,+DAAoC;AAEpC;;;;;;;;;GASG;AACI,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAChG,OAAO,MAAM,IAAA,oBAAO,EAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAClF,CAAC"}

package/dist/cjs/artist/getSimilar.js

@@ -5,6 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetSimilar = artistGetSimilar;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetSimilar(method, artist, limit = '30', autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, limit, autocorrect });
 }

package/dist/cjs/artist/getSimilar.js.map

@@ -1 +1 @@
-{"version":3,"file":"getSimilar.js","sourceRoot":"","sources":["../../../src/artist/getSimilar.ts"],"names":[],"mappings":";;;;;AAEA,4CAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,IAAA,oBAAO,EAAwB,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":";;;;;AAaA,4CAEC;AAdD,+DAAoC;AAEpC;;;;;;;;;GASG;AACI,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,WAAW,GAAG,GAAG;IACpG,OAAO,MAAM,IAAA,oBAAO,EAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AACtF,CAAC"}

package/dist/cjs/artist/getTags.js

@@ -5,6 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetTags = artistGetTags;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetTags(method, artist, user, autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, user, autocorrect });
 }

package/dist/cjs/artist/getTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../../src/artist/getTags.ts"],"names":[],"mappings":";;;;;AAEA,sCAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IACjG,OAAO,MAAM,IAAA,oBAAO,EAAqB,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":";;;;;AAaA,sCAEC;AAdD,+DAAoC;AAEpC;;;;;;;;;GASG;AACI,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc,EAAE,IAAY,EAAE,WAAW,GAAG,GAAG;IACjG,OAAO,MAAM,IAAA,oBAAO,EAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAClF,CAAC"}

package/dist/cjs/artist/getTopAlbums.js

@@ -5,6 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetTopAlbums = artistGetTopAlbums;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetTopAlbums(method, artist, limit = '50', page = '1', autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, limit, page, autocorrect });
 }

package/dist/cjs/artist/getTopAlbums.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopAlbums.js","sourceRoot":"","sources":["../../../src/artist/getTopAlbums.ts"],"names":[],"mappings":";;;;;AAEA,gDAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,IAAA,oBAAO,EAA0B,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,gDAEC;AAfD,+DAAoC;AAEpC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,IAAA,oBAAO,EAA0B,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9F,CAAC"}

package/dist/cjs/artist/getTopTags.js

@@ -5,6 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetTopTags = artistGetTopTags;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetTopTags(method, artist, autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, autocorrect });
 }

package/dist/cjs/artist/getTopTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopTags.js","sourceRoot":"","sources":["../../../src/artist/getTopTags.ts"],"names":[],"mappings":";;;;;AAEA,4CAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG;IACtF,OAAO,MAAM,IAAA,oBAAO,EAAwB,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":";;;;;AAYA,4CAEC;AAbD,+DAAoC;AAEpC;;;;;;;;GAQG;AACI,KAAK,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc,EAAE,WAAW,GAAG,GAAG;IACtF,OAAO,MAAM,IAAA,oBAAO,EAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;AAC/E,CAAC"}

package/dist/cjs/artist/getTopTracks.js

@@ -5,6 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistGetTopTracks = artistGetTopTracks;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistGetTopTracks(method, artist, limit = '50', page = '1', autocorrect = '1') {
     return await (0, request_js_1.default)({ method, artist, limit, page, autocorrect });
 }

package/dist/cjs/artist/getTopTracks.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTopTracks.js","sourceRoot":"","sources":["../../../src/artist/getTopTracks.ts"],"names":[],"mappings":";;;;;AAEA,gDAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,IAAA,oBAAO,EAA0B,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,gDAEC;AAfD,+DAAoC;AAEpC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG,EAAE,WAAW,GAAG,GAAG;IAClH,OAAO,MAAM,IAAA,oBAAO,EAA0B,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9F,CAAC"}

package/dist/cjs/artist/removeTag.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistRemoveTag = artistRemoveTag;
 const request_js_1 = require("../request.js");
 const config_js_1 = require("../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
+ */
 async function artistRemoveTag(method, artist, tag, sk) {
     return await (0, request_js_1.signedRequest)({ method, artist, tag, sk }, config_js_1.config.share_secret);
 }

package/dist/cjs/artist/removeTag.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../../src/artist/removeTag.ts"],"names":[],"mappings":";;AAGA,0CAEC;AAJD,8CAA8C;AAC9C,4CAAsC;AAC/B,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,GAAW,EAAE,EAAU;IAC3F,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC7F,CAAC"}
+{"version":3,"file":"removeTag.js","sourceRoot":"","sources":["../../../src/artist/removeTag.ts"],"names":[],"mappings":";;AAcA,0CAEC;AAfD,8CAA8C;AAC9C,4CAAsC;AAEtC;;;;;;;;;GASG;AACI,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAc,EAAE,GAAW,EAAE,EAAU;IAC3F,OAAO,MAAM,IAAA,0BAAa,EAAe,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC7F,CAAC"}

package/dist/cjs/artist/search.js

@@ -5,6 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.artistSearch = artistSearch;
 const request_js_1 = __importDefault(require("../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
+ */
 async function artistSearch(method, artist, limit = '30', page = '1') {
     return await (0, request_js_1.default)({ method, artist, limit, page });
 }

package/dist/cjs/artist/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/artist/search.ts"],"names":[],"mappings":";;;;;AAEA,oCAEC;AAHD,+DAAoC;AAC7B,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACzF,OAAO,MAAM,IAAA,oBAAO,EAAuB,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":";;;;;AAaA,oCAEC;AAdD,+DAAoC;AAEpC;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,GAAG,GAAG;IACzF,OAAO,MAAM,IAAA,oBAAO,EAAuB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9E,CAAC"}

package/dist/cjs/auth/getMobileSession.js

@@ -3,6 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.authGetMobileSession = authGetMobileSession;
 const request_js_1 = require("../request.js");
 const config_js_1 = require("../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
+ */
 async function authGetMobileSession(method, username, password) {
     return await (0, request_js_1.signedRequest)({ method, username, password }, config_js_1.config.share_secret);
 }

package/dist/cjs/auth/getMobileSession.js.map

@@ -1 +1 @@
-{"version":3,"file":"getMobileSession.js","sourceRoot":"","sources":["../../../src/auth/getMobileSession.ts"],"names":[],"mappings":";;AAGA,oDAEC;AAJD,8CAA8C;AAC9C,4CAAsC;AAC/B,KAAK,UAAU,oBAAoB,CAAC,MAAc,EAAE,QAAgB,EAAE,QAAgB;IAC3F,OAAO,MAAM,IAAA,0BAAa,EAA4B,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC7G,CAAC"}
+{"version":3,"file":"getMobileSession.js","sourceRoot":"","sources":["../../../src/auth/getMobileSession.ts"],"names":[],"mappings":";;AAeA,oDAEC;AAhBD,8CAA8C;AAC9C,4CAAsC;AAEtC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,oBAAoB,CAAC,MAAc,EAAE,QAAgB,EAAE,QAAgB;IAC3F,OAAO,MAAM,IAAA,0BAAa,EAA4B,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC7G,CAAC"}

package/dist/cjs/auth/getSession.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.authGetSession = authGetSession;
 const request_js_1 = require("../request.js");
 const config_js_1 = require("../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
+ */
 async function authGetSession(method, token) {
     return await (0, request_js_1.signedRequest)({ method, token }, config_js_1.config.share_secret);
 }

package/dist/cjs/auth/getSession.js.map

@@ -1 +1 @@
-{"version":3,"file":"getSession.js","sourceRoot":"","sources":["../../../src/auth/getSession.ts"],"names":[],"mappings":";;AAGA,wCAEC;AAJD,8CAA8C;AAC9C,4CAAsC;AAC/B,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,KAAa;IAChE,OAAO,MAAM,IAAA,0BAAa,EAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC1F,CAAC"}
+{"version":3,"file":"getSession.js","sourceRoot":"","sources":["../../../src/auth/getSession.ts"],"names":[],"mappings":";;AAcA,wCAEC;AAfD,8CAA8C;AAC9C,4CAAsC;AAEtC;;;;;;;;;GASG;AACI,KAAK,UAAU,cAAc,CAAC,MAAc,EAAE,KAAa;IAChE,OAAO,MAAM,IAAA,0BAAa,EAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,kBAAM,CAAC,YAAY,CAAC,CAAC;AAC1F,CAAC"}

package/dist/cjs/auth.js

@@ -7,14 +7,17 @@ exports.auth = auth;
 const createOptions_js_1 = require("./createOptions.js");
 const request_js_1 = __importDefault(require("./request.js"));
 /**
- * POST: Auth - LastFM
+ * Fetch an unauthenticated token for the web auth flow.
  *
- * https://www.last.fm/api/show/auth.getToken
+ * Tokens are API-account-specific, valid for 60 minutes, and consumed
+ * once a session is created via `auth.getSession`.
  *
- * Authentication tokens are API account specific.
- * They are valid for 60 minutes from the moment they are granted.
- * Can only used once (they are consumed when a session is created).
- * @returns Auth token
+ * @see https://www.last.fm/api/show/auth.getToken
+ * @param method - The Last.fm API method string (`method.auth.getToken`)
+ * @param user - The Last.fm username
+ * @param period - The time period parameter
+ * @param limit - The limit parameter
+ * @returns An unauthenticated token to redirect the user to the Last.fm auth page
  */
 async function auth(method, user, period, limit) {
     const options = (0, createOptions_js_1.createOptions)(method, user, period, limit);

package/dist/cjs/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":";;;;;AAcA,oBAQC;AArBD,yDAAmD;AACnD,8DAAmC;AAEnC;;;;;;;;;GASG;AACI,KAAK,UAAU,IAAI,CACxB,MAAc,EACd,IAAY,EACZ,MAAc,EACd,KAAa;IAEb,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,MAAM,IAAA,oBAAO,EAAe,OAAO,CAAC,CAAC;AAC9C,CAAC"}
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":";;;;;AAiBA,oBAQC;AAxBD,yDAAmD;AACnD,8DAAmC;AAEnC;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,IAAI,CACxB,MAAc,EACd,IAAY,EACZ,MAAc,EACd,KAAa;IAEb,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,MAAM,IAAA,oBAAO,EAAe,OAAO,CAAC,CAAC;AAC9C,CAAC"}

package/dist/cjs/chart/topArtists.js

@@ -6,6 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.chartTopArtists = chartTopArtists;
 const createOptions_js_1 = require("../createOptions.js");
 const request_js_1 = __importDefault(require("../request.js"));
+/**
+ * Get the top artists chart on Last.fm.
+ *
+ * @see https://www.last.fm/api/show/chart.getTopArtists
+ * @param method - The Last.fm API method string (`method.chart.getTopArtists`)
+ * @param user - The Last.fm username
+ * @param period - The time period over which to retrieve the chart
+ * @param page - Page number to fetch
+ * @param limit - Number of results per page
+ * @returns Paginated list of the most popular artists globally
+ */
 async function chartTopArtists(method, user, period, page, limit) {
     const options = (0, createOptions_js_1.createOptions)(method, user, period, page, limit);
     return await (0, request_js_1.default)(options);

package/dist/cjs/chart/topArtists.js.map

@@ -1 +1 @@
-{"version":3,"file":"topArtists.js","sourceRoot":"","sources":["../../../src/chart/topArtists.ts"],"names":[],"mappings":";;;;;AAIA,0CASC;AAZD,0DAAoD;AACpD,+DAAoC;AAE7B,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,MAAc,EACd,IAAY,EACZ,KAAa;IAEb,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACjE,OAAO,MAAM,IAAA,oBAAO,EAAyB,OAAO,CAAC,CAAC;AACxD,CAAC"}
+{"version":3,"file":"topArtists.js","sourceRoot":"","sources":["../../../src/chart/topArtists.ts"],"names":[],"mappings":";;;;;AAeA,0CASC;AAvBD,0DAAoD;AACpD,+DAAoC;AAEpC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,MAAc,EACd,IAAY,EACZ,KAAa;IAEb,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACjE,OAAO,MAAM,IAAA,oBAAO,EAAyB,OAAO,CAAC,CAAC;AACxD,CAAC"}

package/dist/cjs/chart/topTags.js

@@ -6,6 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.chartTopTags = chartTopTags;
 const createOptions_js_1 = require("../createOptions.js");
 const request_js_1 = __importDefault(require("../request.js"));
+/**
+ * Get the top tags chart on Last.fm, ordered by tag popularity.
+ *
+ * @see https://www.last.fm/api/show/chart.getTopTags
+ * @param method - The Last.fm API method string (`method.chart.getTopTags`)
+ * @param page - Page number to fetch
+ * @returns Paginated list of the most popular tags globally
+ */
 async function chartTopTags(method, page) {
     const options = (0, createOptions_js_1.createOptions)(method, page);
     return await (0, request_js_1.default)(options);