lastfm-nodejs-client 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
-# 1.0.0
+# Changelog
+
+## 1.0.2
+
+- 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.
+
+## 1.0.0
 
 - Initial project setup

package/README.md

@@ -2,6 +2,10 @@
 
 A Node JS wrapper client for fetching public data from [LastFm API](https://www.last.fm/api).
 
+## But Why?
+
+I was building scrobbles page [https://mannuelferreira.com/scrobbles](https://mannuelferreira.com/scrobbles) and I thought other might want it to.
+
 ## How to use the client
 
 Install the npm package in your project.
@@ -21,9 +25,13 @@ import { lastFm } from 'lastfm-nodejs-client';
 ### Use it
 
 ```js
+const lastFm = LastFmApi();
+const { config } = lastFm;
+const { method } = lastFm;
+
 const getUser = async () => {
   const data = await lastFm.getInfo(
-    config.method.user.getInfo,
+    method.user.getInfo,
     config.username,
     'overall',
     12
@@ -76,9 +84,3 @@ Build
 ```bash
 pnpm build
 ```
-
-## Testing code
-
-```bash
-pnpm test
-```

package/dist/config.d.ts

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const config = {
+exports.default = {
     api_key: `${process.env.LASTFM_API_KEY}`,
     app_name: `${process.env.LASTFM_APPNAME}`,
     base_url: `${process.env.LASTFM_API_BASE_URL}`,
@@ -8,22 +8,6 @@ const config = {
         json: 'json',
         xml: 'xml',
     },
-    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',
-        },
-    },
     share_secret: `${process.env.LASTFM_SHARED_SECRET}`,
     username: `${process.env.LASTFM_USER}`,
 };
-exports.default = config;

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { AuthResponse, LovedTracksResponse, RecentTracksResponse, TopAlbumsResponse, TopArtistsResponse, TopTrackResponse, UserResponse, WeeklyAlbumChartResponse, WeeklyArtistChartResponse, WeeklyChartListResponse, WeeklyTrackChartResponse } from './types';
+declare const LastFmApi: () => {
+    auth: (method: string, user: string, period: string, limit: number) => Promise<AuthResponse>;
+    config: {
+        api_key: string;
+        app_name: string;
+        base_url: string;
+        format: {
+            json: string;
+            xml: string;
+        };
+        share_secret: string;
+        username: string;
+    };
+    getInfo: (method: string, user: string, period: string, limit: number) => Promise<UserResponse>;
+    getLovedTracks: (method: string, user: string, period: string, limit: number) => Promise<LovedTracksResponse>;
+    getRecentTracks: (method: string, user: string, period: string, limit: number) => Promise<RecentTracksResponse>;
+    getTopAlbums: (method: string, user: string, period: string, limit: number) => Promise<TopAlbumsResponse>;
+    getTopArtists: (method: string, user: string, period: string, limit: number) => Promise<TopArtistsResponse>;
+    getTopTracks: (method: string, user: string, period: string, limit: number) => Promise<TopTrackResponse>;
+    getWeeklyAlbumChart: (method: string, user: string, period: string, limit: number) => Promise<WeeklyAlbumChartResponse>;
+    getWeeklyArtistChart: (method: string, user: string, period: string, limit: number) => Promise<WeeklyArtistChartResponse>;
+    getWeeklyChartList: (method: string, user: string, period: string, limit: number) => Promise<WeeklyChartListResponse>;
+    getWeeklyTrackChart: (method: string, user: string, period: string, limit: number) => Promise<WeeklyTrackChartResponse>;
+    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;
+        };
+    };
+};
+export default LastFmApi;

package/dist/index.js

@@ -3,6 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = __importDefault(require("./config"));
+const method_1 = __importDefault(require("./method"));
 const request_1 = __importDefault(require("./request"));
 const LastFmApi = function LastFmApi() {
     /**
@@ -110,6 +112,7 @@ const LastFmApi = function LastFmApi() {
     };
     return {
         auth,
+        config: config_1.default,
         getInfo,
         getLovedTracks,
         getRecentTracks,
@@ -120,6 +123,7 @@ const LastFmApi = function LastFmApi() {
         getWeeklyArtistChart,
         getWeeklyChartList,
         getWeeklyTrackChart,
+        method: method_1.default,
     };
 };
 exports.default = LastFmApi;

package/dist/method.d.ts

@@ -0,0 +1,16 @@
+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/method.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    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',
+    },
+};

package/dist/request.d.ts

@@ -0,0 +1,2 @@
+declare const request: <Parameters_1, Response_1>(method: string, user: string, period?: string, limit?: number) => Promise<Response_1>;
+export default request;

package/dist/types.d.ts

@@ -0,0 +1,250 @@
+export interface AuthResponse {
+    token: string;
+}
+export interface LovedTracksResponse {
+    lovedtracks: LovedTracks;
+}
+export interface LovedTracks {
+    track: Track[];
+    '@attr': Attr;
+}
+export interface TopAlbumsResponse {
+    topalbums: TopAlbums;
+}
+export interface TopTrackResponse {
+    toptracks: TopTracks;
+}
+export interface TopTracks {
+    track: Track[];
+    '@attr': Attr2;
+}
+export interface UserResponse {
+    user: User;
+}
+export interface RecentTracksResponse {
+    recenttracks: RecentTracks;
+}
+export interface RecentTracks {
+    track: Track[];
+    '@attr': Attr2;
+}
+export interface LoveTracksResponse {
+    lovedtracks: LovedTracks;
+}
+export interface LovedTracks {
+    track: Track[];
+    '@attr': Attr;
+}
+export interface FriendsResponse {
+    friends: Friends;
+}
+export interface Friends {
+    '@attr': Attr;
+    user: User[];
+}
+export interface TopArtistsResponse {
+    topartists: TopArtists;
+}
+export interface TopArtists {
+    artist: Artist[];
+    '@attr': Attr2;
+}
+export interface WeeklyArtistChartResponse {
+    weeklyartistchart: WeeklyArtistChart;
+}
+export interface WeeklyArtistChart {
+    artist: Artist[];
+    '@attr': Attr2;
+}
+export interface WeeklyAlbumChartResponse {
+    weeklyalbumchart: WeeklyAlbumChart;
+}
+export interface WeeklyAlbumChart {
+    album: WeeklyAlbum[];
+    '@attr': WeeklyalbumChartAttr;
+}
+export declare type WeeklyAlbum = {
+    artist: {
+        mbid: string;
+        '#text': string;
+    };
+    mbid: string;
+    url: string;
+    name: string;
+    '@attr': {
+        rank: string;
+    };
+    playcount: string;
+    image?: string;
+};
+export interface WeeklyalbumChartAttr {
+    from: string;
+    to: string;
+    user: string;
+}
+export interface AlbumAttr {
+    rank: string;
+}
+export declare type Artist = {
+    '@attr': {
+        rank: number;
+    };
+    cover: ArtistImage;
+    image?: string;
+    mbid: string;
+    name: string;
+    playcount: number;
+    streamable: number;
+    url: string;
+    '#text': string;
+};
+export interface Attribs {
+    page: number;
+    perPage: number;
+    user: string;
+    total: number;
+    totalPages: number;
+}
+export interface ArtistImage {
+    name: string;
+    photo: string;
+    attribution: string;
+    playcount: number;
+}
+export interface Album {
+    mbid: string;
+    '#text': string;
+}
+export interface Attr {
+    nowplaying: string;
+}
+export interface Date {
+    uts: string;
+    '#text': string;
+}
+export interface Track {
+    artist: Artist;
+    streamable: string;
+    image: '';
+    mbid: string;
+    album: Album;
+    name: string;
+    '@attr': Attr;
+    url: string;
+    date: Date;
+}
+export interface Attr2 {
+    user: string;
+    totalPages: string;
+    page: string;
+    perPage: string;
+    total: string;
+}
+export interface RecentTracks {
+    track: Track[];
+    '@attr': Attr2;
+}
+export interface Image {
+    size: string;
+    '#text': string;
+}
+export interface Registered {
+    unixtime: string;
+    '#text': number;
+}
+export interface User {
+    name: string;
+    age: string;
+    subscriber: string;
+    realname: string;
+    bootstrap: string;
+    playcount: string;
+    artist_count: string;
+    playlists: string;
+    track_count: string;
+    album_count: string;
+    image: Image[];
+    registered: Registered;
+    country: string;
+    gender: string;
+    url: string;
+    type: string;
+}
+export interface TopAlbums {
+    album: Album[];
+    '@attr': Attr2;
+}
+export interface WeeklyArtistChartResponse {
+    weeklyartistchart: WeeklyArtistChart;
+}
+export interface WeeklyArtistChart {
+    artist: Artist[];
+    '@attr': Attr2;
+}
+export interface Attr1 {
+    rank: string;
+}
+export interface Attr2 {
+    from: string;
+    user: string;
+    to: string;
+}
+export interface WeeklyChartListResponse {
+    weeklychartlist: WeeklyChartList;
+}
+export interface WeeklyChartList {
+    chart: WeeklyChartListChart[];
+    '@attr': WeeklyChartListAttr;
+}
+export interface WeeklyChartListChart {
+    '#text': string;
+    from: string;
+    to: string;
+}
+export interface WeeklyChartListAttr {
+    user: string;
+}
+export interface WeeklyTrackChartResponse {
+    weeklytrackchart: WeeklyTrackChart;
+}
+export interface WeeklyTrackChart {
+    track: Track[];
+    '@attr': WeeklyTrackChartAttr2;
+}
+export interface WeeklyTrackChartTrack {
+    artist: WeeklyTrackChartArtist;
+    image: Image[];
+    mbid: string;
+    url: string;
+    name: string;
+    '@attr': Attr;
+    playcount: string;
+}
+export interface WeeklyTrackChartArtist {
+    mbid: string;
+    '#text': string;
+}
+export interface WeeklyTrackChartAttr {
+    rank: string;
+}
+export interface WeeklyTrackChartAttr2 {
+    from: string;
+    user: string;
+    to: string;
+}
+export declare 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
+}

package/dist/types.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Errors = void 0;
+var Errors;
+(function (Errors) {
+    Errors[Errors["InvalidService"] = 2] = "InvalidService";
+    Errors[Errors["InvalidMethod"] = 3] = "InvalidMethod";
+    Errors[Errors["AuthenticationFailed"] = 4] = "AuthenticationFailed";
+    Errors[Errors["Invalid format"] = 5] = "Invalid format";
+    Errors[Errors["Invalid parameters"] = 6] = "Invalid parameters";
+    Errors[Errors["InvalidResourceSpecified"] = 7] = "InvalidResourceSpecified";
+    Errors[Errors["OperationFailed"] = 8] = "OperationFailed";
+    Errors[Errors["Invalid session key"] = 9] = "Invalid session key";
+    Errors[Errors["InvalidApiKey"] = 10] = "InvalidApiKey";
+    Errors[Errors["ServiceOffline"] = 11] = "ServiceOffline";
+    Errors[Errors["InvalidMethodSignatureSupplied"] = 13] = "InvalidMethodSignatureSupplied";
+    Errors[Errors["TemporaryErrorRequest"] = 16] = "TemporaryErrorRequest";
+    Errors[Errors["SuspendedApiKey"] = 26] = "SuspendedApiKey";
+    Errors[Errors["RateLimitExceeded"] = 29] = "RateLimitExceeded";
+})(Errors = exports.Errors || (exports.Errors = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lastfm-nodejs-client",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A client for fetching public data with username using the LastFm public API",
   "main": "./dist/index.js",
   "scripts": {
@@ -10,11 +10,15 @@
   },
   "keywords": [
     "client",
-    "lastfm",
+    "lastFm",
     "nodejs",
-    "typescript"
+    "typescript",
+    "node"
   ],
   "author": "Mannuel Ferreira",
+  "maintainers": [
+    "Mannuel Ferreira"
+  ],
   "license": "MIT",
   "dependencies": {
     "node-fetch": "^3.2.10",

package/src/config.ts

@@ -1,4 +1,4 @@
-const config = {
+export default {
   api_key: `${process.env.LASTFM_API_KEY}`,
   app_name: `${process.env.LASTFM_APPNAME}`,
   base_url: `${process.env.LASTFM_API_BASE_URL}`,
@@ -6,23 +6,6 @@ const config = {
     json: 'json',
     xml: 'xml',
   },
-  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',
-    },
-  },
   share_secret: `${process.env.LASTFM_SHARED_SECRET}`,
   username: `${process.env.LASTFM_USER}`,
 };
-
-export default config;

package/src/index.ts

@@ -1,3 +1,6 @@
+import config from './config';
+import method from './method';
+import request from './request';
 import {
   AuthResponse,
   LovedTracksResponse,
@@ -11,7 +14,6 @@ import {
   WeeklyChartListResponse,
   WeeklyTrackChartResponse,
 } from './types';
-import request from './request';
 
 const LastFmApi = function LastFmApi() {
   /**
@@ -185,6 +187,7 @@ const LastFmApi = function LastFmApi() {
 
   return {
     auth,
+    config,
     getInfo,
     getLovedTracks,
     getRecentTracks,
@@ -195,6 +198,7 @@ const LastFmApi = function LastFmApi() {
     getWeeklyArtistChart,
     getWeeklyChartList,
     getWeeklyTrackChart,
+    method,
   };
 };
 

package/src/method.ts

@@ -0,0 +1,15 @@
+export default {
+  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',
+  },
+};

package/tsconfig.json

@@ -44,7 +44,7 @@
     // "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. */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
     // "declarationMap": true,                           /* 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. */