lastfm-nodejs-client 1.2.3 → 1.3.0

package/src/index.ts

@@ -1,190 +1,18 @@
+import { auth } from './auth';
 import config from './config';
+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';
 import method from './method';
-import request from './request';
-import {
-  AuthResponse,
-  LovedTracksResponse,
-  RecentTracksResponse,
-  TopAlbumsResponse,
-  TopArtistsResponse,
-  TopTrackResponse,
-  UserResponse,
-  WeeklyAlbumChartResponse,
-  WeeklyArtistChartResponse,
-  WeeklyChartListResponse,
-  WeeklyTrackChartResponse,
-} from '../@types';
-
-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: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<AuthResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: User profile information - LastFM
-   *
-   * https://www.last.fm/api/show/user.getInfo
-   * @returns User profile data
-   */
-  function getInfo(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<UserResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Love Tracks - LastFM
-   *
-   * https://www.last.fm/api/show/user.getLovedTracks
-   * @returns Loved Tracks;
-   */
-  function getLovedTracks(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<LovedTracksResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Recent Tracks - LastFM
-   *
-   * https://www.last.fm/api/show/user.getRecentTracks
-   * @returns Recent Tracks
-   */
-  function getRecentTracks(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<RecentTracksResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Top Albums - LastFM
-   *
-   * https://www.last.fm/api/show/user.getTopAlbums
-   * @returns Top Albums
-   */
-  function getTopAlbums(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<TopAlbumsResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Top Artist - LastFM
-   *
-   * https://www.last.fm/api/show/user.getTopArtists
-   * @returns Top Artists
-   */
-  function getTopArtists(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<TopArtistsResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Top Tracks - LastFM
-   *
-   * https://www.last.fm/api/show/user.getTopTracks
-   * @returns Top Tracks
-   */
-  function getTopTracks(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<TopTrackResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Weekly album chart - LastFM
-   *
-   * https://www.last.fm/api/show/user.getWeeklyAlbumChart
-   * @returns Weekly album chart
-   */
-  function getWeeklyAlbumChart(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<WeeklyAlbumChartResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Weekly artist chart - LastFM
-   *
-   * https://www.last.fm/api/show/user.getWeeklyArtistChart
-   * @returns Weekly artist chart
-   */
-  function getWeeklyArtistChart(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<WeeklyArtistChartResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Weekly chart list - LastFM
-   *
-   * https://www.last.fm/api/show/user.getWeeklyChartList
-   * @returns Weekly chart list
-   */
-  function getWeeklyChartList(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<WeeklyChartListResponse> {
-    return request(method, user, period, limit);
-  }
-
-  /**
-   * GET: Weekly track chart - LastFM
-   *
-   * https://www.last.fm/api/show/user.getWeeklyTrackChart
-   * @returns Weekly track chart
-   */
-  function getWeeklyTrackChart(
-    method: string,
-    user: string,
-    period: string,
-    limit: string,
-  ): Promise<WeeklyTrackChartResponse> {
-    return request(method, user, period, limit);
-  }
 
+export default function LastFmApi() {
   return {
     auth,
     config,
@@ -201,5 +29,3 @@ function LastFmApi() {
     method,
   };
 }
-
-export default LastFmApi;

package/src/method.ts

@@ -1,3 +1,21 @@
+interface UserMethod {
+  getInfo: string;
+  loved_tracks: string;
+  recent_tracks: string;
+  top_albums: string;
+  top_artists: string;
+  top_tracks: string;
+  weekly_album_chart: string;
+  weekly_artist_chart: string;
+  weekly_chart_list: string;
+  weekly_track_chart: string;
+};
+
+export interface Method {
+  auth: string;
+  user: UserMethod;
+};
+
 export default {
   auth: 'auth.getToken',
   user: {
@@ -12,4 +30,4 @@ export default {
     weekly_chart_list: 'user.getWeeklyChartList',
     weekly_track_chart: 'user.getWeeklyTrackChart',
   },
-};
+} satisfies Method;

package/src/request.ts

@@ -1,18 +1,47 @@
 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;
+}
+
+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
+}
+
+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: {
@@ -20,10 +49,76 @@ const request = async <Response>(
     },
   })
     .then((res) => {
-      if (res.status >= 400) {
-        throw new Error('Bad response from server');
+      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) => {

package/tsconfig.json

@@ -51,7 +51,7 @@
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
     "outDir": "./dist" /* Specify an output folder for all emitted files. */,
-    // "removeComments": true,                           /* Disable emitting comments. */
+    "removeComments": false,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
     // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */