lastfm-nodejs-client 1.2.2 → 1.2.4

package/.env.example

@@ -1,5 +1,5 @@
-LASTFM_API_BASE_URL=""
-LASTFM_API_KEY=""
-LASTFM_APPNAME=""
-LASTFM_SHARED_SECRET=""
-LASTFM_USER=""
+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"

package/.github/workflows/playwright.yml

@@ -0,0 +1,36 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7.14.1
+      - name: Install dependencies
+        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@v2
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

package/.nvmrc

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

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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
+- Adds dotenv npm module as a new dependency
+
 ## 1.2.2
 
 - Put log back, some APIs do get Bad Request for MBIDs that don't exist, don't have solve for this yet, so not throwing any more as it grinds future request to a halt. This is a working version.

package/SECURITY.md

@@ -1,14 +1,13 @@
-# Security Policy
+# 🔐 Security Policy
 
 ## 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/config.js

@@ -1,5 +1,30 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv = __importStar(require("dotenv"));
+dotenv.config();
 exports.default = {
     api_key: `${process.env.LASTFM_API_KEY}`,
     app_name: `${process.env.LASTFM_APPNAME}`,

package/dist/index.js

@@ -17,99 +17,165 @@ function LastFmApi() {
      * Can only used once (they are consumed when a session is created).
      * @returns Auth token
      */
-    const auth = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getInfo = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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;
      */
-    const getLovedTracks = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getRecentTracks = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getTopAlbums = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getTopArtists = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getTopTracks = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getWeeklyAlbumChart = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getWeeklyArtistChart = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getWeeklyChartList = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    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
      */
-    const getWeeklyTrackChart = (method, user, period, limit) => {
-        return (0, request_1.default)(method, user, period, limit);
-    };
+    function getWeeklyTrackChart(method, user, period, limit) {
+        const options = {
+            method,
+            user,
+            period,
+            limit,
+        };
+        return (0, request_1.default)(options);
+    }
     return {
         auth,
         config: config_1.default,

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.2",
+  "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,12 +22,14 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "cross-fetch": "^3.1.5",
-    "rimraf": "^3.0.2"
+    "cross-fetch": "^4.0.0",
+    "dotenv": "^16.3.1",
+    "rimraf": "^5.0.1"
   },
   "devDependencies": {
-    "@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",
@@ -30,10 +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",
-    "dev": "tsc --watch",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}
+  "homepage": "https://github.com/mannuelf/lastfm-nodejs-client#readme"
+}

package/playwright.config.ts

@@ -0,0 +1,37 @@
+import { devices, PlaywrightTestConfig } from '@playwright/test';
+import * as dotenv from 'dotenv'; // see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
+dotenv.config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+const config: PlaywrightTestConfig = {
+  testDir: './tests',
+  timeout: 30 * 1000,
+  expect: {
+    timeout: 5000,
+  },
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: 'html',
+  use: {
+    actionTimeout: 0,
+    trace: 'on-first-retry',
+    headless: true,
+  },
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+  // outputDir: 'test-results/',
+  // webServer: {
+  //   command: 'npm run dev',
+  //   port: 3000,
+  // },
+};
+
+export default config;

package/src/config.ts

@@ -1,3 +1,6 @@
+import * as dotenv from 'dotenv';
+dotenv.config();
+
 export default {
   api_key: `${process.env.LASTFM_API_KEY}`,
   app_name: `${process.env.LASTFM_APPNAME}`,

package/src/index.ts

@@ -26,14 +26,20 @@ function LastFmApi() {
    * Can only used once (they are consumed when a session is created).
    * @returns Auth token
    */
-  const auth = (
+  function auth(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<AuthResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<AuthResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<AuthResponse>(options);
+  }
 
   /**
    * GET: User profile information - LastFM
@@ -41,14 +47,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getInfo
    * @returns User profile data
    */
-  const getInfo = (
+  function getInfo(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<UserResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<UserResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<UserResponse>(options);
+  }
 
   /**
    * GET: Love Tracks - LastFM
@@ -56,14 +68,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getLovedTracks
    * @returns Loved Tracks;
    */
-  const getLovedTracks = (
+  function getLovedTracks(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<LovedTracksResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<LovedTracksResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<LovedTracksResponse>(options);
+  }
 
   /**
    * GET: Recent Tracks - LastFM
@@ -71,14 +89,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getRecentTracks
    * @returns Recent Tracks
    */
-  const getRecentTracks = (
+  function getRecentTracks(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<RecentTracksResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<RecentTracksResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<RecentTracksResponse>(options);
+  }
 
   /**
    * GET: Top Albums - LastFM
@@ -86,14 +110,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getTopAlbums
    * @returns Top Albums
    */
-  const getTopAlbums = (
+  function getTopAlbums(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<TopAlbumsResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<TopAlbumsResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<TopAlbumsResponse>(options);
+  }
 
   /**
    * GET: Top Artist - LastFM
@@ -101,14 +131,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getTopArtists
    * @returns Top Artists
    */
-  const getTopArtists = (
+  function getTopArtists(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<TopArtistsResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<TopArtistsResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<TopArtistsResponse>(options);
+  }
 
   /**
    * GET: Top Tracks - LastFM
@@ -116,14 +152,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getTopTracks
    * @returns Top Tracks
    */
-  const getTopTracks = (
+  function getTopTracks(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<TopTrackResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<TopTrackResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<TopTrackResponse>(options);
+  }
 
   /**
    * GET: Weekly album chart - LastFM
@@ -131,14 +173,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getWeeklyAlbumChart
    * @returns Weekly album chart
    */
-  const getWeeklyAlbumChart = (
+  function getWeeklyAlbumChart(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<WeeklyAlbumChartResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<WeeklyAlbumChartResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyAlbumChartResponse>(options);
+  }
 
   /**
    * GET: Weekly artist chart - LastFM
@@ -146,14 +194,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getWeeklyArtistChart
    * @returns Weekly artist chart
    */
-  const getWeeklyArtistChart = (
+  function getWeeklyArtistChart(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<WeeklyArtistChartResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<WeeklyArtistChartResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyArtistChartResponse>(options);
+  }
 
   /**
    * GET: Weekly chart list - LastFM
@@ -161,14 +215,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getWeeklyChartList
    * @returns Weekly chart list
    */
-  const getWeeklyChartList = (
+  function getWeeklyChartList(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<WeeklyChartListResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<WeeklyChartListResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyChartListResponse>(options);
+  }
 
   /**
    * GET: Weekly track chart - LastFM
@@ -176,14 +236,20 @@ function LastFmApi() {
    * https://www.last.fm/api/show/user.getWeeklyTrackChart
    * @returns Weekly track chart
    */
-  const getWeeklyTrackChart = (
+  function getWeeklyTrackChart(
     method: string,
     user: string,
     period: string,
     limit: string,
-  ): Promise<WeeklyTrackChartResponse> => {
-    return request(method, user, period, limit);
-  };
+  ): Promise<WeeklyTrackChartResponse> {
+    const options = {
+      method,
+      user,
+      period,
+      limit,
+    }
+    return request<WeeklyTrackChartResponse>(options);
+  }
 
   return {
     auth,

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: {

package/tests/env.spec.ts

@@ -0,0 +1,21 @@
+import { test, expect } from '@playwright/test';
+import dotenv from 'dotenv';
+import path from 'path';
+
+dotenv.config();
+dotenv.config({ path: path.resolve(__dirname, '..', process.env.CI ? '.env.example' : '.env') });
+
+const { LASTFM_API_BASE_URL, LASTFM_API_KEY } = process.env;
+
+let environmentVarWarning =
+  '❗ No environment variable found, use the .env.example file to create your own .env file with required properties and values.';
+
+test.describe('Environment variables present and configured', async () => {
+  test('LASTFM_API_BASE_URL is present', async () => {
+    expect(LASTFM_API_BASE_URL, environmentVarWarning).toBeDefined();
+  });
+
+  test('LASTFM_API_KEY is present', async () => {
+    expect(LASTFM_API_KEY, environmentVarWarning).toBeDefined();
+  });
+});

package/tsconfig.dev.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": false
+  },
+  "exclude": ["tests/**/*.spec.ts", "tests/**/*.test.ts", "./playwright.config.ts"]
+}

package/tsconfig.json

@@ -1,4 +1,5 @@
 {
+  "exclude": ["tests/**/*.spec.ts", "tests/**/*.test.ts", "./playwright.config.ts"],
   "compilerOptions": {
     /* Visit https://aka.ms/tsconfig to read more about this file */