lastfm-nodejs-client 1.2.3 → 1.3.0

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/@types/index.d.ts

@@ -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,9 +1,21 @@
 # Changelog
 
+## 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.
+- 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
 
@@ -11,7 +23,7 @@
 
 ## 1.2.1
 
-- Tidy up, removes console logs
+- Tidy up, removes console logs.
 
 ## 1.2.0
 
@@ -19,15 +31,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
 
@@ -35,44 +47,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/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/auth.d.ts

@@ -0,0 +1,12 @@
+import { AuthResponse } from '../@types';
+/**
+* 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 declare function auth(method: string, user: string, period: string, limit: string): Promise<AuthResponse>;

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

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 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/createOptions.d.ts

@@ -0,0 +1,6 @@
+export declare function createOptions(method: string, user: string, period?: string, limit?: string): {
+    method: string;
+    user: string;
+    period: string | undefined;
+    limit: string | undefined;
+};

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

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

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.d.ts

@@ -0,0 +1,8 @@
+import { WeeklyTrackChartResponse } from '../@types';
+/**
+ * GET: Weekly track chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyTrackChart
+ * @returns Weekly track chart
+ */
+export declare function getWeeklyTrackChart(method: string, user: string, period: string, limit: string): Promise<WeeklyTrackChartResponse>;

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;

package/dist/index.d.ts

@@ -1,6 +1,16 @@
-import { AuthResponse, LovedTracksResponse, RecentTracksResponse, TopAlbumsResponse, TopArtistsResponse, TopTrackResponse, UserResponse, WeeklyAlbumChartResponse, WeeklyArtistChartResponse, WeeklyChartListResponse, WeeklyTrackChartResponse } from '../@types';
-declare function LastFmApi(): {
-    auth: (method: string, user: string, period: string, limit: string) => Promise<AuthResponse>;
+import { auth } from './auth';
+import { getInfo } from './getInfo';
+import { getLovedTracks } from './getLovedTracks';
+import { getRecentTracks } from './getRecentTracks';
+import { getTopAlbums } from './getTopAlbums';
+import { getTopArtists } from './getTopArtists';
+import { getTopTracks } from './getTopTracks';
+import { getWeeklyAlbumChart } from './getWeeklyAlbumChart';
+import { getWeeklyArtistChart } from './getWeeklyArtistChart';
+import { getWeeklyChartList } from './getWeeklyChartList';
+import { getWeeklyTrackChart } from './getWeeklyTrackChart';
+export default function LastFmApi(): {
+    auth: typeof auth;
     config: {
         api_key: string;
         app_name: string;
@@ -12,16 +22,16 @@ declare function LastFmApi(): {
         share_secret: string;
         username: string;
     };
-    getInfo: (method: string, user: string, period: string, limit: string) => Promise<UserResponse>;
-    getLovedTracks: (method: string, user: string, period: string, limit: string) => Promise<LovedTracksResponse>;
-    getRecentTracks: (method: string, user: string, period: string, limit: string) => Promise<RecentTracksResponse>;
-    getTopAlbums: (method: string, user: string, period: string, limit: string) => Promise<TopAlbumsResponse>;
-    getTopArtists: (method: string, user: string, period: string, limit: string) => Promise<TopArtistsResponse>;
-    getTopTracks: (method: string, user: string, period: string, limit: string) => Promise<TopTrackResponse>;
-    getWeeklyAlbumChart: (method: string, user: string, period: string, limit: string) => Promise<WeeklyAlbumChartResponse>;
-    getWeeklyArtistChart: (method: string, user: string, period: string, limit: string) => Promise<WeeklyArtistChartResponse>;
-    getWeeklyChartList: (method: string, user: string, period: string, limit: string) => Promise<WeeklyChartListResponse>;
-    getWeeklyTrackChart: (method: string, user: string, period: string, limit: string) => Promise<WeeklyTrackChartResponse>;
+    getInfo: typeof getInfo;
+    getLovedTracks: typeof getLovedTracks;
+    getRecentTracks: typeof getRecentTracks;
+    getTopAlbums: typeof getTopAlbums;
+    getTopArtists: typeof getTopArtists;
+    getTopTracks: typeof getTopTracks;
+    getWeeklyAlbumChart: typeof getWeeklyAlbumChart;
+    getWeeklyArtistChart: typeof getWeeklyArtistChart;
+    getWeeklyChartList: typeof getWeeklyChartList;
+    getWeeklyTrackChart: typeof getWeeklyTrackChart;
     method: {
         auth: string;
         user: {
@@ -38,4 +48,3 @@ declare function LastFmApi(): {
         };
     };
 };
-export default LastFmApi;