lastfm-nodejs-client 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

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.
@@ -80,15 +84,3 @@ Build
 ```bash
 pnpm build
 ```
-
-## Testing code
-
-```bash
-pnpm test
-```
-
-## TODO
-
-- [ ] Add types to DefinitelyTyped project
-- [ ] Write tests
-- [ ] Write more endpoints

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.1",
+  "version": "1.0.2",
   "description": "A client for fetching public data with username using the LastFm public API",
   "main": "./dist/index.js",
   "scripts": {
@@ -16,6 +16,9 @@
     "node"
   ],
   "author": "Mannuel Ferreira",
+  "maintainers": [
+    "Mannuel Ferreira"
+  ],
   "license": "MIT",
   "dependencies": {
     "node-fetch": "^3.2.10",