lastfm-nodejs-client 1.4.3 → 1.4.4

package/dist/mjs/chart/topTags.js

@@ -0,0 +1,6 @@
+import { createOptions } from '../createOptions';
+import request from '../request';
+export async function chartTopTags(method, page) {
+    const options = createOptions(method, page);
+    return await request(options);
+}

package/dist/mjs/chart/topTracks.d.ts

@@ -0,0 +1,2 @@
+import { TopTrackResponse } from '../../@types';
+export declare function chartTopTracks(method: string, page: string): Promise<TopTrackResponse>;

package/dist/mjs/chart/topTracks.js

@@ -0,0 +1,6 @@
+import { createOptions } from '../createOptions';
+import request from '../request';
+export async function chartTopTracks(method, page) {
+    const options = createOptions(method, page);
+    return await request(options);
+}

package/dist/mjs/config.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare const config: {
+    api_key: string;
+    app_name: string;
+    base_url: string;
+    format: {
+        json: string;
+        xml: string;
+    };
+    share_secret: string;
+    username: string;
+};

package/dist/mjs/config.js

@@ -0,0 +1,22 @@
+import * as dotenv from 'dotenv';
+dotenv.config();
+/**
+ * @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}`,
+    format: {
+        json: 'json',
+        xml: 'xml',
+    },
+    share_secret: `${process.env.LASTFM_SHARED_SECRET}`,
+    username: `${process.env.LASTFM_USER}`,
+};

package/dist/mjs/createOptions.d.ts

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

package/dist/mjs/createOptions.js

@@ -0,0 +1,9 @@
+export function createOptions(method, user, period, limit, page) {
+    return {
+        method,
+        page,
+        user,
+        period,
+        limit,
+    };
+}

package/dist/mjs/getInfo.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getInfo.js

@@ -0,0 +1,12 @@
+import { createOptions } from "./createOptions";
+import request from "./request";
+/**
+ * GET: User profile information - LastFM
+ *
+ * https://www.last.fm/api/show/user.getInfo
+ * @returns User profile information
+ */
+export async function getInfo(method, user) {
+    const options = createOptions(method, user);
+    return await request(options);
+}

package/dist/mjs/getLovedTracks.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getLovedTracks.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Love Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getLovedTracks
+ * @returns Loved Tracks;
+ */
+export async function getLovedTracks(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getRecentTracks.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getRecentTracks.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Recent Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getRecentTracks
+ * @returns Recent Tracks
+ */
+export async function getRecentTracks(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getTopAlbums.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getTopAlbums.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Top Albums - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopAlbums
+ * @returns Top Albums
+ */
+export async function getTopAlbums(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getTopArtists.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getTopArtists.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Top Artist - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopArtists
+ * @returns Top Artists
+ */
+export async function getTopArtists(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getTopTracks.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getTopTracks.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Top Tracks - LastFM
+ *
+ * https://www.last.fm/api/show/user.getTopTracks
+ * @returns Top Tracks
+ */
+export async function getTopTracks(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getWeeklyAlbumChart.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getWeeklyAlbumChart.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Weekly album chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyAlbumChart
+ * @returns Weekly album chart
+ */
+export async function getWeeklyAlbumChart(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getWeeklyArtistChart.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getWeeklyArtistChart.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Weekly artist chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyArtistChart
+ * @returns Weekly artist chart
+ */
+export async function getWeeklyArtistChart(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getWeeklyChartList.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getWeeklyChartList.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Weekly chart list - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyChartList
+ * @returns Weekly chart list
+ */
+export async function getWeeklyChartList(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/getWeeklyTrackChart.d.ts

@@ -0,0 +1,8 @@
+import { type 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/mjs/getWeeklyTrackChart.js

@@ -0,0 +1,12 @@
+import { createOptions } from './createOptions';
+import request from './request';
+/**
+ * GET: Weekly track chart - LastFM
+ *
+ * https://www.last.fm/api/show/user.getWeeklyTrackChart
+ * @returns Weekly track chart
+ */
+export async function getWeeklyTrackChart(method, user, period, limit) {
+    const options = createOptions(method, user, period, limit);
+    return await request(options);
+}

package/dist/mjs/index.d.ts

@@ -0,0 +1,63 @@
+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';
+import { chartTopTags } from './chart/topTags';
+import { chartTopTracks } from './chart/topTracks';
+import { chartTopArtists } from './chart/topArtists';
+export default function LastFmApi(): {
+    auth: typeof auth;
+    chart: {
+        chartTopArtists: typeof chartTopArtists;
+        chartTopTracks: typeof chartTopTracks;
+        chartTopTags: typeof chartTopTags;
+    };
+    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;
+        chart: {
+            getTopTracks: string;
+            getTopTags: string;
+            getTopArtists: string;
+        };
+        user: {
+            getInfo: string;
+            getLovedTracks: string;
+            getRecentTracks: string;
+            getTopAlbums: string;
+            getTopArtists: string;
+            getTopTracks: string;
+            getWeeklyAlbumChart: string;
+            getWeeklyArtistChart: string;
+            getWeeklyChartList: string;
+            getWeeklyTrackChart: string;
+        };
+    };
+};

package/{src/index.ts → dist/mjs/index.js}

@@ -11,21 +11,28 @@ import { getWeeklyArtistChart } from './getWeeklyArtistChart';
 import { getWeeklyChartList } from './getWeeklyChartList';
 import { getWeeklyTrackChart } from './getWeeklyTrackChart';
 import { method } from './method';
-
-const LastFmApi = () => ({
-  auth,
-  config,
-  getInfo,
-  getLovedTracks,
-  getRecentTracks,
-  getTopAlbums,
-  getTopArtists,
-  getTopTracks,
-  getWeeklyAlbumChart,
-  getWeeklyArtistChart,
-  getWeeklyChartList,
-  getWeeklyTrackChart,
-  method,
-})
-
-export default LastFmApi;
+import { chartTopTags } from './chart/topTags';
+import { chartTopTracks } from './chart/topTracks';
+import { chartTopArtists } from './chart/topArtists';
+export default function LastFmApi() {
+    return {
+        auth,
+        chart: {
+            chartTopArtists,
+            chartTopTracks,
+            chartTopTags,
+        },
+        config,
+        getInfo,
+        getLovedTracks,
+        getRecentTracks,
+        getTopAlbums,
+        getTopArtists,
+        getTopTracks,
+        getWeeklyAlbumChart,
+        getWeeklyArtistChart,
+        getWeeklyChartList,
+        getWeeklyTrackChart,
+        method,
+    };
+}

package/dist/mjs/method.d.ts

@@ -0,0 +1,43 @@
+interface ChartMethod {
+    getTopArtists: string;
+    getTopTags: string;
+    getTopTracks: string;
+}
+interface UserMethod {
+    getInfo: string;
+    getLovedTracks: string;
+    getRecentTracks: string;
+    getTopAlbums: string;
+    getTopArtists: string;
+    getTopTracks: string;
+    getWeeklyAlbumChart: string;
+    getWeeklyArtistChart: string;
+    getWeeklyChartList: string;
+    getWeeklyTrackChart: string;
+}
+export interface Method {
+    auth: string;
+    chart: ChartMethod;
+    user: UserMethod;
+}
+export declare const method: {
+    auth: string;
+    chart: {
+        getTopTracks: string;
+        getTopTags: string;
+        getTopArtists: string;
+    };
+    user: {
+        getInfo: string;
+        getLovedTracks: string;
+        getRecentTracks: string;
+        getTopAlbums: string;
+        getTopArtists: string;
+        getTopTracks: string;
+        getWeeklyAlbumChart: string;
+        getWeeklyArtistChart: string;
+        getWeeklyChartList: string;
+        getWeeklyTrackChart: string;
+    };
+};
+export {};

package/dist/mjs/method.js

@@ -0,0 +1,20 @@
+export const method = {
+    auth: 'auth.getToken',
+    chart: {
+        getTopTracks: 'chart.getTopTracks',
+        getTopTags: 'chart.getTopTags',
+        getTopArtists: 'chart.getTopArtists',
+    },
+    user: {
+        getInfo: 'user.getInfo',
+        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/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/mjs/request.d.ts

@@ -0,0 +1,8 @@
+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/mjs/request.js

@@ -0,0 +1,119 @@
+import fetch from 'cross-fetch';
+import { config } from './config';
+var ErrorResponse;
+(function (ErrorResponse) {
+    ErrorResponse[ErrorResponse["InvalidService"] = 2] = "InvalidService";
+    ErrorResponse[ErrorResponse["InvalidMethod"] = 3] = "InvalidMethod";
+    ErrorResponse[ErrorResponse["AuthenticationFailed"] = 4] = "AuthenticationFailed";
+    ErrorResponse[ErrorResponse["InvalidFormat"] = 5] = "InvalidFormat";
+    ErrorResponse[ErrorResponse["InvalidParameters"] = 6] = "InvalidParameters";
+    ErrorResponse[ErrorResponse["InvalidResource"] = 7] = "InvalidResource";
+    ErrorResponse[ErrorResponse["OperationFailed"] = 8] = "OperationFailed";
+    ErrorResponse[ErrorResponse["InvalidSessionKey"] = 9] = "InvalidSessionKey";
+    ErrorResponse[ErrorResponse["InvalidAPIKey"] = 10] = "InvalidAPIKey";
+    ErrorResponse[ErrorResponse["ServiceOffline"] = 11] = "ServiceOffline";
+    ErrorResponse[ErrorResponse["InvalidMethodSignature"] = 13] = "InvalidMethodSignature";
+    ErrorResponse[ErrorResponse["TemporaryError"] = 16] = "TemporaryError";
+    ErrorResponse[ErrorResponse["SuspendedAPIKey"] = 26] = "SuspendedAPIKey";
+    ErrorResponse[ErrorResponse["RateLimitExceeded"] = 29] = "RateLimitExceeded";
+})(ErrorResponse || (ErrorResponse = {}));
+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.api_key);
+    params.append('format', config.format.json);
+    return `${config.base_url}?${params.toString()}`;
+};
+const request = async (options) => {
+    const url = buildUrl(options);
+    return (await fetch(url, {
+        headers: {
+            'Content-Type': 'application/json',
+        },
+    })
+        .then(async (res) => {
+        if (!res.ok) {
+            throw new Error(res.statusText);
+        }
+        switch (res.status) {
+            case 200: {
+                return await 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');
+            }
+        }
+    })
+        .then((json) => json)
+        .catch((error) => {
+        // eslint-disable-next-line no-console
+        console.error('🚨 error:', error);
+    }));
+};
+export default request;

package/lastfm-nodejs-client/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "lastfm-nodejs-client",
+  "description": "A client for interacting with the lastFm API",
+  "main": "../dist/cjs/index.js",
+  "module": "../dist/mjs/indext.js",
+  "types": "../dist/mjs/index.d.ts"
+}