lastfm-nodejs-client 1.3.0 → 1.4.0

package/.env.example

@@ -1,5 +1,6 @@
-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"
+LASTFM_API_BASE_URL=https://ws.audioscrobbler.com/2.0/
+LASTFM_API_KEY=f7177932c78b9723d54e617d0d5695ee
+LASTFM_APPNAME=music-wall
+LASTFM_SHARED_SECRET=bcffbbc0ba4af16fc00415c94b138c74
+LASTFM_USER=mannuelf
+LASTFM_REGISTERTO=mannuelf

package/@types/index.d.ts

@@ -108,7 +108,7 @@ export type Artist = {
     rank: number;
   };
   cover: ArtistImage;
-  image?: string;
+  image?: Image[];
   mbid: string;
   name: string;
   playcount: number;
@@ -278,7 +278,7 @@ export interface WeeklyTrackChartAttr2 {
 }
 
 export const LastFmApi: () => {
-  auth: (method: string, user: string, period: string, limit: number) => Promise<AuthResponse>;
+  auth: (method: string, user: string) => Promise<AuthResponse>;
   config: {
     api_key: string;
     app_name: string;
@@ -290,7 +290,7 @@ export const LastFmApi: () => {
     share_secret: string;
     username: string;
   };
-  getInfo: (method: string, user: string, period: string, limit: number) => Promise<UserResponse>;
+  getInfo: (method: string, user: string) => Promise<UserResponse>;
   getLovedTracks: (
     method: string,
     user: string,

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.4.0
+
+- update all api functions from snake case to camel case.
+
 ## 1.3.0
 
 - Updates npm dependencies.

package/dist/config.js

@@ -23,10 +23,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
 const dotenv = __importStar(require("dotenv"));
 dotenv.config();
 ;
-exports.default = {
+/**
+ * @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
+ */
+exports.config = {
     api_key: `${process.env.LASTFM_API_KEY}`,
     app_name: `${process.env.LASTFM_APPNAME}`,
     base_url: `${process.env.LASTFM_API_BASE_URL}`,

package/dist/index.js

@@ -1,10 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const auth_1 = require("./auth");
-const config_1 = __importDefault(require("./config"));
+const config_1 = require("./config");
 const getInfo_1 = require("./getInfo");
 const getLovedTracks_1 = require("./getLovedTracks");
 const getRecentTracks_1 = require("./getRecentTracks");
@@ -15,11 +12,11 @@ const getWeeklyAlbumChart_1 = require("./getWeeklyAlbumChart");
 const getWeeklyArtistChart_1 = require("./getWeeklyArtistChart");
 const getWeeklyChartList_1 = require("./getWeeklyChartList");
 const getWeeklyTrackChart_1 = require("./getWeeklyTrackChart");
-const method_1 = __importDefault(require("./method"));
+const method_1 = require("./method");
 function LastFmApi() {
     return {
         auth: auth_1.auth,
-        config: config_1.default,
+        config: config_1.config,
         getInfo: getInfo_1.getInfo,
         getLovedTracks: getLovedTracks_1.getLovedTracks,
         getRecentTracks: getRecentTracks_1.getRecentTracks,
@@ -30,7 +27,7 @@ function LastFmApi() {
         getWeeklyArtistChart: getWeeklyArtistChart_1.getWeeklyArtistChart,
         getWeeklyChartList: getWeeklyChartList_1.getWeeklyChartList,
         getWeeklyTrackChart: getWeeklyTrackChart_1.getWeeklyTrackChart,
-        method: method_1.default,
+        method: method_1.method,
     };
 }
 exports.default = LastFmApi;

package/dist/method.js

@@ -1,19 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.method = void 0;
 ;
 ;
-exports.default = {
+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,7 @@ 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";
@@ -40,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);
@@ -52,6 +52,9 @@ const request = (options) => __awaiter(void 0, void 0, void 0, function* () {
         },
     })
         .then((res) => {
+        if (!res.ok) {
+            throw new Error(res.statusText);
+        }
         switch (res.status) {
             case 200: {
                 return res.json();
@@ -123,7 +126,7 @@ const request = (options) => __awaiter(void 0, void 0, void 0, function* () {
     })
         .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.3.0",
+  "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,10 +28,9 @@
     "rimraf": "^5.0.1"
   },
   "devDependencies": {
-    "@playwright/test": "^1.37.1",
-    "@types/node": "^20.6.0",
-    "typescript": "^5.2.2",
-    "bun-types": "latest"
+    "@playwright/test": "^1.38.0",
+    "@types/node": "^20.6.2",
+    "typescript": "^5.2.2"
   },
   "repository": {
     "type": "git",

package/src/config.ts

@@ -12,8 +12,16 @@ interface Config {
   share_secret: string;
   username: string;
 };
-
-export default {
+/**
+ * @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}`,

package/src/index.ts

@@ -1,5 +1,5 @@
 import { auth } from './auth';
-import config from './config';
+import { config } from './config';
 import { getInfo } from './getInfo';
 import { getLovedTracks } from './getLovedTracks';
 import { getRecentTracks } from './getRecentTracks';
@@ -10,7 +10,7 @@ import { getWeeklyAlbumChart } from './getWeeklyAlbumChart';
 import { getWeeklyArtistChart } from './getWeeklyArtistChart';
 import { getWeeklyChartList } from './getWeeklyChartList';
 import { getWeeklyTrackChart } from './getWeeklyTrackChart';
-import method from './method';
+import { method } from './method';
 
 export default function LastFmApi() {
   return {

package/src/method.ts

@@ -1,14 +1,14 @@
 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;
+  getLovedTracks: string;
+  getRecentTracks: string;
+  getTopAlbums: string;
+  getTopArtists: string;
+  getTopTracks: string;
+  getWeeklyAlbumChart: string;
+  getWeeklyArtistChart: string;
+  getWeeklyChartList: string;
+  getWeeklyTrackChart: string;
 };
 
 export interface Method {
@@ -16,18 +16,18 @@ export interface Method {
   user: UserMethod;
 };
 
-export default {
+export const 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',
   },
 } satisfies Method;

package/src/request.ts

@@ -1,5 +1,5 @@
 import fetch from 'cross-fetch';
-import config from './config';
+import { config } from './config';
 
 interface RequestOptions {
   method: string;
@@ -49,6 +49,10 @@ const request = async <Response>(options: RequestOptions): Promise<Response> =>
     },
   })
     .then((res) => {
+      if(!res.ok) {
+        throw new Error(res.statusText);
+      }
+
       switch (res.status) {
         case 200: {
           return res.json();
@@ -122,7 +126,7 @@ const request = async <Response>(options: RequestOptions): Promise<Response> =>
     })
     .then((json) => json)
     .catch((error) => {
-      console.log(error);
+      console.log('🚨 error:', error);
     })) as Response;
 };
 

package/tsconfig.json

@@ -26,9 +26,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "CommonJS" /* Specify what module code is generated. */,
+    "module": "NodeNext" /* Specify what module code is generated. */,
     "rootDir": "./src" /* Specify the root folder within your source files. */,
-    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    "moduleResolution": "NodeNext" /* Specify how TypeScript looks up a file from a given module specifier. */,
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
@@ -45,8 +45,8 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
     /* Emit */
-    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    "declaration": false /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    "declarationMap": false,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "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. */
@@ -55,7 +55,7 @@
     // "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. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    "downlevelIteration": false,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
     // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
     // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
     // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
@@ -101,4 +101,4 @@
     "skipDefaultLibCheck": true /* Skip type checking .d.ts files that are included with TypeScript. */,
     "skipLibCheck": true /* Skip type checking all .d.ts files. */
   }
-}
+}

package/dist/auth.d.ts

@@ -1,12 +0,0 @@
-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/config.d.ts

@@ -1,12 +0,0 @@
-declare const _default: {
-    api_key: string;
-    app_name: string;
-    base_url: string;
-    format: {
-        json: string;
-        xml: string;
-    };
-    share_secret: string;
-    username: string;
-};
-export default _default;

package/dist/createOptions.d.ts

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

package/dist/getInfo.d.ts

@@ -1,8 +0,0 @@
-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/getLovedTracks.d.ts

@@ -1,8 +0,0 @@
-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/getRecentTracks.d.ts

@@ -1,8 +0,0 @@
-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/getTopAlbums.d.ts

@@ -1,8 +0,0 @@
-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/getTopArtists.d.ts

@@ -1,8 +0,0 @@
-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/getTopTracks.d.ts

@@ -1,8 +0,0 @@
-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/getWeeklyAlbumChart.d.ts

@@ -1,8 +0,0 @@
-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/getWeeklyArtistChart.d.ts

@@ -1,8 +0,0 @@
-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/getWeeklyChartList.d.ts

@@ -1,8 +0,0 @@
-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/getWeeklyTrackChart.d.ts

@@ -1,8 +0,0 @@
-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/index.d.ts

@@ -1,50 +0,0 @@
-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;
-        base_url: string;
-        format: {
-            json: string;
-            xml: string;
-        };
-        share_secret: string;
-        username: string;
-    };
-    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: {
-            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;
-        };
-    };
-};

package/dist/method.d.ts

@@ -1,32 +0,0 @@
-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;
-}
-declare const _default: {
-    auth: string;
-    user: {
-        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 default _default;

package/dist/request.d.ts

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