lastfm-nodejs-client 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.0.5
+
+- Fix local types
+- Update readme with current way of using the types
+- adds screenshot of it in use
+
+## 1.0.4
+
+- Export types
+
 ## 1.0.3
 
 - Adds types file to distribution

package/README.md

@@ -23,9 +23,16 @@ import { lastFm } from 'lastfm-nodejs-client';
 Import types
 
 ```js
-import { Artist, Track, User, WeeklyAlbum, ...} from 'lastfm-nodejs-client/types';
+import {
+  Artist,
+  Track,
+  User,
+  WeeklyAlbum,
+} from 'lastfm-nodejs-client/dist/types';
 ```
 
+_Working on getting these into [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)_
+
 ### Use it
 
 ```js
@@ -43,26 +50,32 @@ const getUser = async () => {
   return user;
 };
 
-const user: User = getUser();
+const user = getUser();
 
 console.log(user.name);
 ```
 
+🚀 Gives you
+
+![user](https://res.cloudinary.com/mannuel/image/upload/v1667372693/images/typescript.png)
+
 ## Developing client
 
 Written in TypeScript, compiles down to ES2015, provides the types for the lastFm entities.
 
+## Fork repo
+
+```bash
+gh repo fork git@github.com:mannuelf/lastfm-nodejs-client.git
+```
+
 ### Postman collections
 
 A list of endpoints currently mapped to this client. Still under development, not feature complete.
 
 [View collections](https://documenter.getpostman.com/view/4217/2s8YKJELqJ) ▶️
 
-## Clone repo
-
-```bash
-git clone git@github.com:mannuelf/lastfm-nodejs-client.git
-```
+### ENV
 
 Create `.env` file in project root:
 

package/package.json

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

package/src/types.d.ts

@@ -1,297 +1,402 @@
-declare module 'lastfm-nodejs-client' {
-  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 AuthResponse {
+  token: string;
+}
+
+export interface LovedTracksResponse {
+  lovedtracks: LovedTracks;
+}
+
+export interface LovedTracks {
+  track: Track[];
+  '@attr': Attr;
+}
+export interface TopAlbumsResponse {
+  topalbums: TopAlbums;
+}
 
-  export interface WeeklyalbumChartAttr {
-    from: string;
-    to: string;
-    user: string;
-  }
+export interface TopTrackResponse {
+  toptracks: TopTracks;
+}
 
-  export interface AlbumAttr {
-    rank: string;
-  }
+export interface TopTracks {
+  track: Track[];
+  '@attr': Attr2;
+}
 
-  export type Artist = {
-    '@attr': {
-      rank: number;
-    };
-    cover: ArtistImage;
-    image?: string;
+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;
-    name: string;
-    playcount: number;
-    streamable: number;
-    url: 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 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 AlbumAttr {
+  rank: string;
+}
 
-  export interface Attr {
-    nowplaying: 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 Date {
-    uts: string;
-    '#text': string;
-  }
+export interface ArtistImage {
+  name: string;
+  photo: string;
+  attribution: string;
+  playcount: number;
+}
 
-  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 Album {
+  mbid: string;
+  '#text': string;
+}
 
-  export interface WeeklyTrackChartArtist {
-    mbid: string;
-    '#text': string;
-  }
-
-  export interface WeeklyTrackChartAttr {
-    rank: string;
-  }
-
-  export interface WeeklyTrackChartAttr2 {
-    from: string;
-    user: string;
-    to: 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 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;
+    };
+    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,
 }

package/dist/types.d.ts

@@ -1,297 +0,0 @@
-declare module 'lastfm-nodejs-client' {
-  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 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,
-  }
-}