lastfm-nodejs-client 1.2.3 → 1.2.4

package/.github/workflows/playwright.yml

@@ -20,13 +20,15 @@ jobs:
         run: pnpm install
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps
+      - name: Install @playwright/test package
+        run: pnpm add -D @playwright/test
       - name: Creates environment variables
         run: |
           echo "LASTFM_API_BASE_URL: https://ws.audioscrobbler.com/2.0/"
           echo "LASTFM_API_KEY: abcdefghijklmnopqrstuvxyz"
       - name: Run Playwright tests
         run: pnpm dlx playwright test
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v2
         if: always()
         with:
           name: playwright-report

package/.nvmrc

@@ -0,0 +1 @@
+v20

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.4
+
+- 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

package/SECURITY.md

@@ -2,13 +2,12 @@
 
 ## Supported Versions
 
-Dependebot alerts have been enabled and security patches to any dependecies will be brought to light and merged manually by maintainer.
+Dependabot alerts have been enabled and security patches to any dependencies will be brought to light and merged manually by maintainer.
 
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.0.x   | :white_check_mark: |
 
-
 ## Reporting a Vulnerability
 
 If you find anything at all kindly report it as bug report here on github ✌️

package/dist/index.js

@@ -18,7 +18,13 @@ function LastFmApi() {
      * @returns Auth token
      */
     function auth(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: User profile information - LastFM
@@ -27,7 +33,13 @@ function LastFmApi() {
      * @returns User profile data
      */
     function getInfo(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Love Tracks - LastFM
@@ -36,7 +48,13 @@ function LastFmApi() {
      * @returns Loved Tracks;
      */
     function getLovedTracks(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Recent Tracks - LastFM
@@ -45,7 +63,13 @@ function LastFmApi() {
      * @returns Recent Tracks
      */
     function getRecentTracks(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Top Albums - LastFM
@@ -54,7 +78,13 @@ function LastFmApi() {
      * @returns Top Albums
      */
     function getTopAlbums(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Top Artist - LastFM
@@ -63,7 +93,13 @@ function LastFmApi() {
      * @returns Top Artists
      */
     function getTopArtists(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Top Tracks - LastFM
@@ -72,7 +108,13 @@ function LastFmApi() {
      * @returns Top Tracks
      */
     function getTopTracks(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Weekly album chart - LastFM
@@ -81,7 +123,13 @@ function LastFmApi() {
      * @returns Weekly album chart
      */
     function getWeeklyAlbumChart(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Weekly artist chart - LastFM
@@ -90,7 +138,13 @@ function LastFmApi() {
      * @returns Weekly artist chart
      */
     function getWeeklyArtistChart(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Weekly chart list - LastFM
@@ -99,7 +153,13 @@ function LastFmApi() {
      * @returns Weekly chart list
      */
     function getWeeklyChartList(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     /**
      * GET: Weekly track chart - LastFM
@@ -108,7 +168,13 @@ function LastFmApi() {
      * @returns Weekly track chart
      */
     function getWeeklyTrackChart(method, user, period, limit) {
-        return (0, request_1.default)(method, user, period, limit);
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
     }
     return {
         auth,

package/dist/request.d.ts

@@ -1,2 +1,8 @@
-declare const request: <Response_1>(method: string, user: string, period?: string, limit?: string) => Promise<Response_1>;
+interface RequestOptions {
+    method: string;
+    user?: string;
+    period?: string;
+    limit?: string;
+}
+declare const request: <Response_1>(options: RequestOptions) => Promise<Response_1>;
 export default request;

package/dist/request.js

@@ -14,9 +14,21 @@ 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 request = (method, user, period, limit) => __awaiter(void 0, void 0, void 0, function* () {
-    const url = `
-      ${config_1.default.base_url}?method=${method}${user ? '&user=' : ''}${user}${user ? '&user=' : ''}${user}${period ? '&period=' : ''}${period}&${limit ? '&limit=' : ''}${limit}&api_key=${config_1.default.api_key}&format=${config_1.default.format.json}`;
+const buildUrl = (options) => {
+    const params = new URLSearchParams();
+    params.append('method', options.method);
+    if (options.user)
+        params.append('user', options.user);
+    if (options.period)
+        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()}`;
+};
+const request = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = buildUrl(options);
     return (yield (0, cross_fetch_1.default)(url, {
         headers: {
             'Content-Type': 'application/json',

package/package.json

@@ -1,8 +1,14 @@
 {
   "name": "lastfm-nodejs-client",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "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",
+    "test": "npx playwright test --reporter=list"
+  },
   "keywords": [
     "client",
     "lastFm",
@@ -16,14 +22,14 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "cross-fetch": "^3.1.5",
-    "dotenv": "^16.0.3",
-    "rimraf": "^3.0.2"
+    "cross-fetch": "^4.0.0",
+    "dotenv": "^16.3.1",
+    "rimraf": "^5.0.1"
   },
   "devDependencies": {
-    "@playwright/test": "^1.28.1",
-    "@types/node": "^18.11.7",
-    "typescript": "^4.8.4"
+    "@playwright/test": "^1.37.1",
+    "@types/node": "^20.5.1",
+    "typescript": "^5.1.6"
   },
   "repository": {
     "type": "git",
@@ -32,11 +38,5 @@
   "bugs": {
     "url": "https://github.com/mannuelf/lastfm-nodejs-client/issues"
   },
-  "homepage": "https://github.com/mannuelf/lastfm-nodejs-client#readme",
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "clean": "rimraf dist",
-    "dev": "npm run clean && tsc --watch --project tsconfig.dev.json",
-    "test": "npx playwright test --reporter=list"
-  }
-}
+  "homepage": "https://github.com/mannuelf/lastfm-nodejs-client#readme"
+}

package/src/index.ts

@@ -32,7 +32,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<AuthResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<AuthResponse>(options);
   }
 
   /**
@@ -47,7 +53,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<UserResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<UserResponse>(options);
   }
 
   /**
@@ -62,7 +74,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<LovedTracksResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<LovedTracksResponse>(options);
   }
 
   /**
@@ -77,7 +95,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<RecentTracksResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<RecentTracksResponse>(options);
   }
 
   /**
@@ -92,7 +116,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<TopAlbumsResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<TopAlbumsResponse>(options);
   }
 
   /**
@@ -107,7 +137,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<TopArtistsResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<TopArtistsResponse>(options);
   }
 
   /**
@@ -122,7 +158,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<TopTrackResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<TopTrackResponse>(options);
   }
 
   /**
@@ -137,7 +179,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<WeeklyAlbumChartResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyAlbumChartResponse>(options);
   }
 
   /**
@@ -152,7 +200,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<WeeklyArtistChartResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyArtistChartResponse>(options);
   }
 
   /**
@@ -167,7 +221,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<WeeklyChartListResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyChartListResponse>(options);
   }
 
   /**
@@ -182,7 +242,13 @@ function LastFmApi() {
     period: string,
     limit: string,
   ): Promise<WeeklyTrackChartResponse> {
-    return request(method, user, period, limit);
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyTrackChartResponse>(options);
   }
 
   return {

package/src/request.ts

@@ -1,18 +1,26 @@
 import fetch from 'cross-fetch';
 import config from './config';
 
-const request = async <Response>(
-  method: string,
-  user: string,
-  period?: string,
-  limit?: string,
-): Promise<Response> => {
-  const url = `
-      ${config.base_url}?method=${method}${user ? '&user=' : ''}${user}${
-    user ? '&user=' : ''
-  }${user}${period ? '&period=' : ''}${period}&${limit ? '&limit=' : ''}${limit}&api_key=${
-    config.api_key
-  }&format=${config.format.json}`;
+interface RequestOptions {
+  method: string;
+  user?: string;
+  period?: string;
+  limit?: string;
+}
+
+const buildUrl = (options: RequestOptions): string => {
+  const params = new URLSearchParams();
+  params.append('method', options.method);
+  if (options.user) params.append('user', options.user);
+  if (options.period) params.append('period', options.period);
+  if (options.limit) params.append('limit', options.limit);
+  params.append('api_key', config.api_key);
+  params.append('format', config.format.json);
+  return `${config.base_url}?${params.toString()}`;
+}
+
+const request = async <Response>(options: RequestOptions): Promise<Response> => {
+  const url = buildUrl(options);
 
   return (await fetch(url, {
     headers: {