lastfm-nodejs-client 1.2.4 → 1.4.0

package/dist/index.js

@@ -1,195 +1,33 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = __importDefault(require("./config"));
-const method_1 = __importDefault(require("./method"));
-const request_1 = __importDefault(require("./request"));
+const auth_1 = require("./auth");
+const config_1 = require("./config");
+const getInfo_1 = require("./getInfo");
+const getLovedTracks_1 = require("./getLovedTracks");
+const getRecentTracks_1 = require("./getRecentTracks");
+const getTopAlbums_1 = require("./getTopAlbums");
+const getTopArtists_1 = require("./getTopArtists");
+const getTopTracks_1 = require("./getTopTracks");
+const getWeeklyAlbumChart_1 = require("./getWeeklyAlbumChart");
+const getWeeklyArtistChart_1 = require("./getWeeklyArtistChart");
+const getWeeklyChartList_1 = require("./getWeeklyChartList");
+const getWeeklyTrackChart_1 = require("./getWeeklyTrackChart");
+const method_1 = require("./method");
 function LastFmApi() {
-    /**
-     * 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 = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * GET: User profile information - LastFM
-     *
-     * https://www.last.fm/api/show/user.getInfo
-     * @returns User profile data
-     */
-    function getInfo(method, user, period, limit) {
-        const options = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * GET: Love Tracks - LastFM
-     *
-     * https://www.last.fm/api/show/user.getLovedTracks
-     * @returns Loved Tracks;
-     */
-    function getLovedTracks(method, user, period, limit) {
-        const options = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * GET: Recent Tracks - LastFM
-     *
-     * https://www.last.fm/api/show/user.getRecentTracks
-     * @returns Recent Tracks
-     */
-    function getRecentTracks(method, user, period, limit) {
-        const options = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * GET: Top Albums - LastFM
-     *
-     * https://www.last.fm/api/show/user.getTopAlbums
-     * @returns Top Albums
-     */
-    function getTopAlbums(method, user, period, limit) {
-        const options = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * GET: Top Artist - LastFM
-     *
-     * https://www.last.fm/api/show/user.getTopArtists
-     * @returns Top Artists
-     */
-    function getTopArtists(method, user, period, limit) {
-        const options = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * GET: Top Tracks - LastFM
-     *
-     * https://www.last.fm/api/show/user.getTopTracks
-     * @returns Top Tracks
-     */
-    function getTopTracks(method, user, period, limit) {
-        const options = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * 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 = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * 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 = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * 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 = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
-    /**
-     * 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 = {
-            method,
-            user,
-            period,
-            limit,
-        };
-        return (0, request_1.default)(options);
-    }
     return {
-        auth,
-        config: config_1.default,
-        getInfo,
-        getLovedTracks,
-        getRecentTracks,
-        getTopAlbums,
-        getTopArtists,
-        getTopTracks,
-        getWeeklyAlbumChart,
-        getWeeklyArtistChart,
-        getWeeklyChartList,
-        getWeeklyTrackChart,
-        method: method_1.default,
+        auth: auth_1.auth,
+        config: config_1.config,
+        getInfo: getInfo_1.getInfo,
+        getLovedTracks: getLovedTracks_1.getLovedTracks,
+        getRecentTracks: getRecentTracks_1.getRecentTracks,
+        getTopAlbums: getTopAlbums_1.getTopAlbums,
+        getTopArtists: getTopArtists_1.getTopArtists,
+        getTopTracks: getTopTracks_1.getTopTracks,
+        getWeeklyAlbumChart: getWeeklyAlbumChart_1.getWeeklyAlbumChart,
+        getWeeklyArtistChart: getWeeklyArtistChart_1.getWeeklyArtistChart,
+        getWeeklyChartList: getWeeklyChartList_1.getWeeklyChartList,
+        getWeeklyTrackChart: getWeeklyTrackChart_1.getWeeklyTrackChart,
+        method: method_1.method,
     };
 }
 exports.default = LastFmApi;

package/dist/method.js

@@ -1,17 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
+exports.method = void 0;
+;
+;
+exports.method = {
     auth: 'auth.getToken',
     user: {
         getInfo: 'user.getInfo',
-        loved_tracks: 'user.getLovedTracks',
-        recent_tracks: 'user.getRecentTracks',
-        top_albums: 'user.getTopAlbums',
-        top_artists: 'user.getTopArtists',
-        top_tracks: 'user.getTopTracks',
-        weekly_album_chart: 'user.getWeeklyAlbumChart',
-        weekly_artist_chart: 'user.getWeeklyArtistChart',
-        weekly_chart_list: 'user.getWeeklyChartList',
-        weekly_track_chart: 'user.getWeeklyTrackChart',
+        getLovedTracks: 'user.getLovedTracks',
+        getRecentTracks: 'user.getRecentTracks',
+        getTopAlbums: 'user.getTopAlbums',
+        getTopArtists: 'user.getTopArtists',
+        getTopTracks: 'user.getTopTracks',
+        getWeeklyAlbumChart: 'user.getWeeklyAlbumChart',
+        getWeeklyArtistChart: 'user.getWeeklyArtistChart',
+        getWeeklyChartList: 'user.getWeeklyChartList',
+        getWeeklyTrackChart: 'user.getWeeklyTrackChart',
     },
 };

package/dist/request.js

@@ -13,7 +13,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const cross_fetch_1 = __importDefault(require("cross-fetch"));
-const config_1 = __importDefault(require("./config"));
+const config_1 = require("./config");
+var ErrorResponse;
+(function (ErrorResponse) {
+    ErrorResponse[ErrorResponse["InvalidService"] = 2] = "InvalidService";
+    ErrorResponse[ErrorResponse["InvalidMethod"] = 3] = "InvalidMethod";
+    ErrorResponse[ErrorResponse["AuthenticationFailed"] = 4] = "AuthenticationFailed";
+    ErrorResponse[ErrorResponse["InvalidFormat"] = 5] = "InvalidFormat";
+    ErrorResponse[ErrorResponse["InvalidParameters"] = 6] = "InvalidParameters";
+    ErrorResponse[ErrorResponse["InvalidResource"] = 7] = "InvalidResource";
+    ErrorResponse[ErrorResponse["OperationFailed"] = 8] = "OperationFailed";
+    ErrorResponse[ErrorResponse["InvalidSessionKey"] = 9] = "InvalidSessionKey";
+    ErrorResponse[ErrorResponse["InvalidAPIKey"] = 10] = "InvalidAPIKey";
+    ErrorResponse[ErrorResponse["ServiceOffline"] = 11] = "ServiceOffline";
+    ErrorResponse[ErrorResponse["InvalidMethodSignature"] = 13] = "InvalidMethodSignature";
+    ErrorResponse[ErrorResponse["TemporaryError"] = 16] = "TemporaryError";
+    ErrorResponse[ErrorResponse["SuspendedAPIKey"] = 26] = "SuspendedAPIKey";
+    ErrorResponse[ErrorResponse["RateLimitExceeded"] = 29] = "RateLimitExceeded";
+})(ErrorResponse || (ErrorResponse = {}));
 const buildUrl = (options) => {
     const params = new URLSearchParams();
     params.append('method', options.method);
@@ -23,9 +40,9 @@ const buildUrl = (options) => {
         params.append('period', options.period);
     if (options.limit)
         params.append('limit', options.limit);
-    params.append('api_key', config_1.default.api_key);
-    params.append('format', config_1.default.format.json);
-    return `${config_1.default.base_url}?${params.toString()}`;
+    params.append('api_key', config_1.config.api_key);
+    params.append('format', config_1.config.format.json);
+    return `${config_1.config.base_url}?${params.toString()}`;
 };
 const request = (options) => __awaiter(void 0, void 0, void 0, function* () {
     const url = buildUrl(options);
@@ -35,14 +52,81 @@ const request = (options) => __awaiter(void 0, void 0, void 0, function* () {
         },
     })
         .then((res) => {
-        if (res.status >= 400) {
-            throw new Error('Bad response from server');
+        if (!res.ok) {
+            throw new Error(res.statusText);
+        }
+        switch (res.status) {
+            case 200: {
+                return res.json();
+            }
+            case 400: {
+                throw new Error('Bad request');
+            }
+            case 401: {
+                throw new Error('Unauthorized');
+            }
+            case 403: {
+                throw new Error('Forbidden');
+            }
+            case 404: {
+                throw new Error('Not found');
+            }
+            case 500: {
+                throw new Error('Internal server error');
+            }
+            case 503: {
+                throw new Error('Service unavailable');
+            }
+            case ErrorResponse.InvalidAPIKey: {
+                throw new Error('Invalid API key');
+            }
+            case ErrorResponse.InvalidMethod: {
+                throw new Error('Invalid method');
+            }
+            case ErrorResponse.InvalidParameters: {
+                throw new Error('Invalid parameters');
+            }
+            case ErrorResponse.InvalidResource: {
+                throw new Error('Invalid resource');
+            }
+            case ErrorResponse.InvalidSessionKey: {
+                throw new Error('Invalid session key');
+            }
+            case ErrorResponse.InvalidService: {
+                throw new Error('Invalid service');
+            }
+            case ErrorResponse.OperationFailed: {
+                throw new Error('Operation failed');
+            }
+            case ErrorResponse.RateLimitExceeded: {
+                throw new Error('Rate limit exceeded');
+            }
+            case ErrorResponse.ServiceOffline: {
+                throw new Error('Service offline');
+            }
+            case ErrorResponse.SuspendedAPIKey: {
+                throw new Error('Suspended API key');
+            }
+            case ErrorResponse.TemporaryError: {
+                throw new Error('Temporary error');
+            }
+            case ErrorResponse.AuthenticationFailed: {
+                throw new Error('Authentication failed');
+            }
+            case ErrorResponse.InvalidFormat: {
+                throw new Error('Invalid format');
+            }
+            case ErrorResponse.InvalidMethodSignature: {
+                throw new Error('Invalid method signature');
+            }
+            default: {
+                throw new Error('Unknown error');
+            }
         }
-        return res.json();
     })
         .then((json) => json)
         .catch((error) => {
-        console.log(error);
+        console.log('🚨 error:', error);
     }));
 });
 exports.default = request;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "lastfm-nodejs-client",
-  "version": "1.2.4",
+  "version": "1.4.0",
   "description": "A NodeJS wrapper client for LastFm API. Fetching public data by username using the LastFm public API",
   "main": "./dist",
   "scripts": {
     "build": "rimraf dist && tsc",
     "clean": "rimraf dist",
     "dev": "npm run clean && tsc --watch --project tsconfig.dev.json",
+    "publish": "npm run build && npm publish --access public",
     "test": "npx playwright test --reporter=list"
   },
   "keywords": [
@@ -27,9 +28,9 @@
     "rimraf": "^5.0.1"
   },
   "devDependencies": {
-    "@playwright/test": "^1.37.1",
-    "@types/node": "^20.5.1",
-    "typescript": "^5.1.6"
+    "@playwright/test": "^1.38.0",
+    "@types/node": "^20.6.2",
+    "typescript": "^5.2.2"
   },
   "repository": {
     "type": "git",
@@ -39,4 +40,4 @@
     "url": "https://github.com/mannuelf/lastfm-nodejs-client/issues"
   },
   "homepage": "https://github.com/mannuelf/lastfm-nodejs-client#readme"
-}
+}

package/src/auth.ts

@@ -0,0 +1,23 @@
+import { AuthResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './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
+*/
+export function auth(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<AuthResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<AuthResponse>(options);
+}

package/src/config.ts

@@ -1,7 +1,27 @@
 import * as dotenv from 'dotenv';
 dotenv.config();
 
-export default {
+interface Config {  
+  api_key: string; 
+  app_name: string;
+  base_url: string;
+  format: {
+    json: string;
+    xml: string;
+  };
+  share_secret: string;
+  username: string;
+};
+/**
+ * @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
+ */
+export const config = {
   api_key: `${process.env.LASTFM_API_KEY}`,
   app_name: `${process.env.LASTFM_APPNAME}`,
   base_url: `${process.env.LASTFM_API_BASE_URL}`,
@@ -11,4 +31,4 @@ export default {
   },
   share_secret: `${process.env.LASTFM_SHARED_SECRET}`,
   username: `${process.env.LASTFM_USER}`,
-};
+} satisfies Config;

package/src/createOptions.ts

@@ -0,0 +1,12 @@
+export function createOptions(
+  method: string,
+  user: string,
+  period?: string,
+  limit?: string) {
+  return {
+    method,
+    user,
+    period,
+    limit,
+  }
+}

package/src/getInfo.ts

@@ -0,0 +1,17 @@
+import { UserResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: User profile information - LastFM
+ *
+ * https://www.last.fm/api/show/user.getInfo
+ * @returns User profile information
+ */
+export function getInfo(
+  method: string,
+  user: string,
+): Promise<UserResponse> {
+  const options = createOptions(method, user);
+  return request<UserResponse>(options);
+}

package/src/getLovedTracks.ts

@@ -0,0 +1,19 @@
+import { LovedTracksResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Love Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getLovedTracks
+ * @returns Loved Tracks;
+ */
+export function getLovedTracks(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<LovedTracksResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<LovedTracksResponse>(options);
+}

package/src/getRecentTracks.ts

@@ -0,0 +1,19 @@
+import { RecentTracksResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Recent Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getRecentTracks
+ * @returns Recent Tracks
+ */
+export function getRecentTracks(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<RecentTracksResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<RecentTracksResponse>(options);
+}

package/src/getTopAlbums.ts

@@ -0,0 +1,19 @@
+import { TopAlbumsResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Top Albums - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopAlbums
+ * @returns Top Albums
+ */
+export function getTopAlbums(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<TopAlbumsResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<TopAlbumsResponse>(options);
+}

package/src/getTopArtists.ts

@@ -0,0 +1,19 @@
+import { TopArtistsResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Top Artist - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopArtists
+ * @returns Top Artists
+ */
+export function getTopArtists(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<TopArtistsResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<TopArtistsResponse>(options);
+}

package/src/getTopTracks.ts

@@ -0,0 +1,19 @@
+import { TopTrackResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Top Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopTracks
+ * @returns Top Tracks
+ */
+export function getTopTracks(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<TopTrackResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<TopTrackResponse>(options);
+}

package/src/getWeeklyAlbumChart.ts

@@ -0,0 +1,19 @@
+import { WeeklyAlbumChartResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Weekly album chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyAlbumChart
+ * @returns Weekly album chart
+ */
+export function getWeeklyAlbumChart(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<WeeklyAlbumChartResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<WeeklyAlbumChartResponse>(options);
+}

package/src/getWeeklyArtistChart.ts

@@ -0,0 +1,19 @@
+import { WeeklyArtistChartResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Weekly artist chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyArtistChart
+ * @returns Weekly artist chart
+ */
+export function getWeeklyArtistChart(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<WeeklyArtistChartResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<WeeklyArtistChartResponse>(options);
+}

package/src/getWeeklyChartList.ts

@@ -0,0 +1,19 @@
+import { WeeklyChartListResponse } from '../@types';
+import { createOptions } from './createOptions';
+import request from './request';
+
+/**
+ * GET: Weekly chart list - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyChartList
+ * @returns Weekly chart list
+ */
+export function getWeeklyChartList(
+  method: string,
+  user: string,
+  period: string,
+  limit: string,
+): Promise<WeeklyChartListResponse> {
+  const options = createOptions(method, user, period, limit);
+  return request<WeeklyChartListResponse>(options);
+}