lastfm-nodejs-client 1.0.7 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.1
+
+- update function declaration
+- re-add type declartion files for source code
+
 ## 1.1.0
 
 - Downgrade node-fetch to v2.6.7

package/README.md

@@ -23,7 +23,7 @@ import { lastFm } from 'lastfm-nodejs-client';
 Import as types
 
 ```js
-import type { Artist, Track, User, WeeklyAlbum } from 'lastfm-nodejs-client-1.0.6/@types';
+import type { Artist, Track, User, WeeklyAlbum } from 'lastfm-nodejs-client/@types';
 ```
 
 _Working on getting these into [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)_

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

@@ -1,392 +1,41 @@
-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 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 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 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;
+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: 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;
+        };
     };
-    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>;
 };
-export interface config {
-  api_key: string;
-  app_name: string;
-  base_url: string;
-  format: {
-    json: string;
-    xml: string;
-  };
-  share_secret: string;
-  username: string;
-}
-
-export interface 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 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 default LastFmApi;

package/dist/index.js

@@ -6,7 +6,7 @@ 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() {
+function LastFmApi() {
     /**
      * POST: Auth - LastFM
      *
@@ -125,5 +125,5 @@ const LastFmApi = function LastFmApi() {
         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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lastfm-nodejs-client",
-  "version": "1.0.7",
+  "version": "1.1.1",
   "description": "A client for fetching public data with username using the LastFm public API",
   "main": "./dist",
   "scripts": {

package/src/index.ts

@@ -15,7 +15,7 @@ import {
   WeeklyTrackChartResponse,
 } from './types';
 
-const LastFmApi = function LastFmApi() {
+function LastFmApi() {
   /**
    * POST: Auth - LastFM
    *
@@ -200,6 +200,6 @@ const LastFmApi = function LastFmApi() {
     getWeeklyTrackChart,
     method,
   };
-};
+}
 
 export default LastFmApi;

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": false /* 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. */