lastfm-nodejs-client 1.2.4 → 1.4.0

package/.env.example

@@ -1,5 +1,6 @@
-LASTFM_API_BASE_URL="https://ws.audioscrobbler.com/2.0/"
-LASTFM_API_KEY="abcdefghijkhlmnopqrstuvwxyz"
-LASTFM_APPNAME="your app name"
-LASTFM_SHARED_SECRET="xxxxxxxxxxxxxxxxxxxxx"
-LASTFM_USER="your username"
+LASTFM_API_BASE_URL=https://ws.audioscrobbler.com/2.0/
+LASTFM_API_KEY=f7177932c78b9723d54e617d0d5695ee
+LASTFM_APPNAME=music-wall
+LASTFM_SHARED_SECRET=bcffbbc0ba4af16fc00415c94b138c74
+LASTFM_USER=mannuelf
+LASTFM_REGISTERTO=mannuelf

package/@types/index.d.ts

@@ -108,7 +108,7 @@ export type Artist = {
     rank: number;
   };
   cover: ArtistImage;
-  image?: string;
+  image?: Image[];
   mbid: string;
   name: string;
   playcount: number;
@@ -278,7 +278,7 @@ export interface WeeklyTrackChartAttr2 {
 }
 
 export const LastFmApi: () => {
-  auth: (method: string, user: string, period: string, limit: number) => Promise<AuthResponse>;
+  auth: (method: string, user: string) => Promise<AuthResponse>;
   config: {
     api_key: string;
     app_name: string;
@@ -290,7 +290,7 @@ export const LastFmApi: () => {
     share_secret: string;
     username: string;
   };
-  getInfo: (method: string, user: string, period: string, limit: number) => Promise<UserResponse>;
+  getInfo: (method: string, user: string) => Promise<UserResponse>;
   getLovedTracks: (
     method: string,
     user: string,
@@ -374,19 +374,19 @@ export interface method {
   };
 }
 
-export enum Errors {
-  'InvalidService' = 2,
-  'InvalidMethod' = 3,
-  'AuthenticationFailed' = 4,
-  'Invalid format' = 5,
-  'Invalid parameters' = 6,
-  'InvalidResourceSpecified' = 7,
-  'OperationFailed' = 8,
-  'Invalid session key' = 9,
-  'InvalidApiKey' = 10,
-  'ServiceOffline' = 11,
-  'InvalidMethodSignatureSupplied' = 13,
-  'TemporaryErrorRequest' = 16,
-  'SuspendedApiKey' = 26,
-  'RateLimitExceeded' = 29,
-}
+export enum ErrorResponse {
+    InvalidService = 2,
+    InvalidMethod = 3,
+    AuthenticationFailed = 4,
+    InvalidFormat = 5,
+    InvalidParameters = 6,
+    InvalidResource = 7,
+    OperationFailed = 8,
+    InvalidSessionKey = 9,
+    InvalidAPIKey = 10,
+    ServiceOffline = 11,
+    InvalidMethodSignature = 13,
+    TemporaryError = 16,
+    SuspendedAPIKey = 26,
+    RateLimitExceeded = 29
+}

package/CHANGELOG.md

@@ -1,15 +1,25 @@
 # Changelog
 
+## 1.4.0
+
+- update all api functions from snake case to camel case.
+
+## 1.3.0
+
+- Updates npm dependencies.
+- refactors request with new error handling and responses.
+- updates getInfo, removes  hte un-required params.
+
 ## 1.2.4
 
-- Updates npm dependencies
+- Updates npm dependencies.
 - Refactors request methods options and updates all callsites.
 - Add nvmrc file for easy switching node version.
 
 ## 1.2.3
 
-- Adds tests, using Playwright
-- Adds dotenv npm module as a new dependency
+- Adds tests, using Playwright.
+- Adds dotenv npm module as a new dependency.
 
 ## 1.2.2
 
@@ -17,7 +27,7 @@
 
 ## 1.2.1
 
-- Tidy up, removes console logs
+- Tidy up, removes console logs.
 
 ## 1.2.0
 
@@ -25,15 +35,15 @@
 
 ## 1.1.5
 
-- Fix incorrect type on request method
+- Fix incorrect type on request method.
 
 ## 1.1.4
 
-- Fix incorrect type on request method
+- Fix incorrect type on request method.
 
 ## 1.1.3
 
-- Fix incorrect type import
+- Fix incorrect type import.
 
 ## 1.1.2
 
@@ -41,44 +51,44 @@
 
 ## 1.1.1
 
-- update function declaration
-- re-add type declartion files for source code
+- update function declaration.
+- re-add type declartion files for source code.
 
 ## 1.1.0
 
-- Downgrade node-fetch to v2.6.7
-- Do not ship separate declaration files
-- TS now exports to CommonJs modules for better support older consumers
+- Downgrade node-fetch to v2.6.7.
+- Do not ship separate declaration files.
+- TS now exports to CommonJs modules for better support older consumers.
 
 ## 1.0.6
 
-- Forking repo README update
+- Forking repo README update.
 
 ## 1.0.5
 
-- Fix local types
-- Update readme with current way of using the types
-- adds screenshot of it in use
+- Fix local types.
+- Update readme with current way of using the types.
+- adds screenshot of it in use.
 
 ## 1.0.4
 
-- Export types
+- Export types.
 
 ## 1.0.3
 
-- Adds types file to distribution
-- Updates readme with types imports
+- Adds types file to distribution.
+- Updates readme with types imports.
 
 ## 1.0.2
 
-- Refactors types.d.ts to types.ts so can ship them with package and consumers can import them in their projects
+- Refactors types.d.ts to types.ts so can ship them with package and consumers can import them in their projects.
 
 ## 1.0.1
 
-- Refactors config and methods to own modules
-- tsconfig, generate types to allow shipping types in one package, no need to DefinitleyTyped right now
-- update docs with new way of interacting with API
+- Refactors config and methods to own modules.
+- tsconfig, generate types to allow shipping types in one package, no need to DefinitleyTyped right now.
+- update docs with new way of interacting with API.
 
 ## 1.0.0
 
-- Initial project setup
+- Initial project setup.

package/README.md

@@ -110,3 +110,7 @@ pnpm build
 ### Why I built this?
 
 I was building a scrobbles page [https://mannuelferreira.com/scrobbles](https://mannuelferreira.com/scrobbles) and I thought others might want it to.
+
+### TODO
+
+- move types into [DefinitelyTyped](https://github.com/mannuelf/DefinitelyTyped)

package/dist/auth.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.auth = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+* POST: Auth - LastFM
+*
+* https://www.last.fm/api/show/auth.getToken
+*
+* 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
+*/
+function auth(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.auth = auth;

package/dist/config.js

@@ -23,9 +23,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
 const dotenv = __importStar(require("dotenv"));
 dotenv.config();
-exports.default = {
+;
+/**
+ * @description Stores the Last.fm API key, app name, base url, format, shared secret, and username.
+ * Simply add a .env file to the root of the project and add the following:
+ * LASTFM_API_KEY=your_api_key
+ * LASTFM_APPNAME=your_app_name
+ * LASTFM_API_BASE_URL=your_base_url
+ * LASTFM_SHARED_SECRET=your_shared_secret
+ * LASTFM_USER=your_username
+ */
+exports.config = {
     api_key: `${process.env.LASTFM_API_KEY}`,
     app_name: `${process.env.LASTFM_APPNAME}`,
     base_url: `${process.env.LASTFM_API_BASE_URL}`,

package/dist/createOptions.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOptions = void 0;
+function createOptions(method, user, period, limit) {
+    return {
+        method,
+        user,
+        period,
+        limit,
+    };
+}
+exports.createOptions = createOptions;

package/dist/getInfo.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInfo = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: User profile information - LastFM
+ *
+ * https://www.last.fm/api/show/user.getInfo
+ * @returns User profile information
+ */
+function getInfo(method, user) {
+    const options = (0, createOptions_1.createOptions)(method, user);
+    return (0, request_1.default)(options);
+}
+exports.getInfo = getInfo;

package/dist/getLovedTracks.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLovedTracks = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Love Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getLovedTracks
+ * @returns Loved Tracks;
+ */
+function getLovedTracks(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getLovedTracks = getLovedTracks;

package/dist/getRecentTracks.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRecentTracks = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Recent Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getRecentTracks
+ * @returns Recent Tracks
+ */
+function getRecentTracks(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getRecentTracks = getRecentTracks;

package/dist/getTopAlbums.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTopAlbums = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Top Albums - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopAlbums
+ * @returns Top Albums
+ */
+function getTopAlbums(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getTopAlbums = getTopAlbums;

package/dist/getTopArtists.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTopArtists = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Top Artist - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopArtists
+ * @returns Top Artists
+ */
+function getTopArtists(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getTopArtists = getTopArtists;

package/dist/getTopTracks.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTopTracks = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Top Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopTracks
+ * @returns Top Tracks
+ */
+function getTopTracks(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getTopTracks = getTopTracks;

package/dist/getWeeklyAlbumChart.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWeeklyAlbumChart = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Weekly album chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyAlbumChart
+ * @returns Weekly album chart
+ */
+function getWeeklyAlbumChart(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getWeeklyAlbumChart = getWeeklyAlbumChart;

package/dist/getWeeklyArtistChart.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWeeklyArtistChart = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Weekly artist chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyArtistChart
+ * @returns Weekly artist chart
+ */
+function getWeeklyArtistChart(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getWeeklyArtistChart = getWeeklyArtistChart;

package/dist/getWeeklyChartList.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWeeklyChartList = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Weekly chart list - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyChartList
+ * @returns Weekly chart list
+ */
+function getWeeklyChartList(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getWeeklyChartList = getWeeklyChartList;

package/dist/getWeeklyTrackChart.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWeeklyTrackChart = void 0;
+const createOptions_1 = require("./createOptions");
+const request_1 = __importDefault(require("./request"));
+/**
+ * GET: Weekly track chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyTrackChart
+ * @returns Weekly track chart
+ */
+function getWeeklyTrackChart(method, user, period, limit) {
+    const options = (0, createOptions_1.createOptions)(method, user, period, limit);
+    return (0, request_1.default)(options);
+}
+exports.getWeeklyTrackChart = getWeeklyTrackChart;