lastfm-nodejs-client 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.3
+
+- Adds types file to distribution
+- Updates readme with types imports
+
 ## 1.0.2
 
 - Refactors types.d.ts to types.ts so can ship them with package and consumers can import them in their projects.

package/README.md

@@ -2,10 +2,6 @@
 
 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.
@@ -18,16 +14,23 @@ Consider [PNPM](https://pnpm.io/) ▶️
 
 ### Import it
 
+Import module
+
 ```js
 import { lastFm } from 'lastfm-nodejs-client';
 ```
 
+Import types
+
+```js
+import { Artist, Track, User, WeeklyAlbum, ...} from 'lastfm-nodejs-client/types';
+```
+
 ### Use it
 
 ```js
 const lastFm = LastFmApi();
-const { config } = lastFm;
-const { method } = lastFm;
+const { config, method } = lastFm;
 
 const getUser = async () => {
   const data = await lastFm.getInfo(
@@ -47,7 +50,7 @@ console.log(user.name);
 
 ## Developing client
 
-Written in TypeScript and compiles down to ES2015.
+Written in TypeScript, compiles down to ES2015, provides the types for the lastFm entities.
 
 ### Postman collections
 
@@ -55,32 +58,41 @@ A list of endpoints currently mapped to this client. Still under development, no
 
 [View collections](https://documenter.getpostman.com/view/4217/2s8YKJELqJ) ▶️
 
-Clone repo
+## Clone repo
 
 ```bash
 git clone git@github.com:mannuelf/lastfm-nodejs-client.git
 ```
 
-create `.env` file in project root.
-Requirements for environment are:
+Create `.env` file in project root.
+Requirements for environment are at minimum a username. You do not need an API key to query the public USER entity.
+
+```bash
+LASTFM_USER=""
+```
+
+For everything else you will need:
 
 ```bash
 LASTFM_API_BASE_URL=""
 LASTFM_API_KEY=""
 LASTFM_APPNAME=""
-LASTFM_USER=""
 ```
 
-Get it [here](https://www.last.fm/api/account/create)
+Create them [here](https://www.last.fm/api/account/create).
 
-Develop
+### Develop
 
 ```bash
 pnpm dev
 ```
 
-Build
+### Build
 
 ```bash
 pnpm build
 ```
+
+### Why I built this?
+
+I was building a scrobbles page [https://mannuelferreira.com/scrobbles](https://mannuelferreira.com/scrobbles) and I thought others might want it to.

package/dist/types.ts

@@ -0,0 +1,295 @@
+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,
+}

package/package.json

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