lastfm-nodejs-client 1.4.3 → 1.4.4

package/package.json

@@ -1,8 +1,36 @@
 {
   "name": "lastfm-nodejs-client",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "description": "A NodeJS wrapper client for LastFm API. Fetching public data by username using the LastFm public API",
-  "main": "./dist",
+  "main": "dist/cjs/index.js",
+  "module": "dist/mjs/index.js",
+  "types": "dist/mjs/index.d.ts",
+  "files": [
+    "dist",
+    "lastfm-nodejs-client"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/mjs/index.d.ts"
+    },
+    "./lastfm-nodejs-client": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/mjs/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && bash ./generate-package-json-files.sh",
+    "lint": "eslint src",
+    "lint-fix": "eslint src --fix",
+    "prepare": "npm run build",
+    "_prepublishOnly": "npm test && npm run lint",
+    "clean": "rimraf dist",
+    "publish": "npm run build && npm publish --access public",
+    "test": "npx playwright test --reporter=list"
+  },
   "keywords": [
     "client",
     "lastFm",
@@ -18,11 +46,17 @@
   "dependencies": {
     "cross-fetch": "^4.0.0",
     "dotenv": "^16.3.1",
-    "rimraf": "^5.0.1"
+    "rimraf": "^5.0.5"
   },
   "devDependencies": {
-    "@playwright/test": "^1.38.0",
-    "@types/node": "^20.6.2",
+    "@playwright/test": "^1.38.1",
+    "@types/node": "^20.7.1",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "eslint": "^8.0.1",
+    "eslint-config-standard-with-typescript": "^39.1.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
+    "eslint-plugin-promise": "^6.0.0",
     "typescript": "^5.2.2"
   },
   "repository": {
@@ -32,11 +66,5 @@
   "bugs": {
     "url": "https://github.com/mannuelf/lastfm-nodejs-client/issues"
   },
-  "homepage": "https://github.com/mannuelf/lastfm-nodejs-client#readme",
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "clean": "rimraf dist",
-    "dev": "npm run clean && tsc --watch --project tsconfig.dev.json",
-    "test": "npx playwright test --reporter=list"
-  }
-}
+  "homepage": "https://github.com/mannuelf/lastfm-nodejs-client#readme"
+}

package/.env.example

@@ -1,6 +0,0 @@
-LASTFM_API_BASE_URL=https://ws.audioscrobbler.com/2.0/
-LASTFM_API_KEY=f7177932c78b9723d54e617d0d5695ee
-LASTFM_APPNAME=music-wall
-LASTFM_SHARED_SECRET=bcffbbc0ba4af16fc00415c94b138c74
-LASTFM_USER=mannuelf
-LASTFM_REGISTERTO=mannuelf

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"

package/.github/workflows/codeql.yml

@@ -1,74 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '29 13 * * 4'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"

package/.github/workflows/playwright.yml

@@ -1,36 +0,0 @@
-name: Playwright Tests
-on:
-  push:
-    branches: [main, master]
-  pull_request:
-    branches: [main, master]
-jobs:
-  test:
-    timeout-minutes: 60
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 7.14.1
-      - name: Install dependencies
-        run: pnpm install
-      - name: Install Playwright Browsers
-        run: npx playwright install --with-deps
-      - name: Install @playwright/test package
-        run: pnpm add -D @playwright/test
-      - name: Creates environment variables
-        run: |
-          echo "LASTFM_API_BASE_URL: https://ws.audioscrobbler.com/2.0/"
-          echo "LASTFM_API_KEY: abcdefghijklmnopqrstuvxyz"
-      - name: Run Playwright tests
-        run: pnpm dlx playwright test
-      - uses: actions/upload-artifact@v2
-        if: always()
-        with:
-          name: playwright-report
-          path: playwright-report/
-          retention-days: 30

package/.nvmrc

@@ -1 +0,0 @@
-v20

package/.prettierrc.yaml

@@ -1,6 +0,0 @@
-semi: true
-trailingComma: all
-singleQuote: true
-jsxSingleQuote: true
-printWidth: 100
-tabWidth: 2

package/@types/index.d.ts

@@ -1,289 +0,0 @@
-export interface AuthResponse {
-  token: string;
-}
-
-export interface LovedTracksResponse {
-  lovedtracks: LovedTracks;
-}
-
-export interface LovedTracks {
-  track: Track[];
-  '@attr': AttrNowPlaying;
-}
-export interface TopAlbumsResponse {
-  topalbums: TopAlbums;
-}
-
-export interface TopTrackResponse {
-  toptracks: TopTracks;
-}
-
-export interface TopTracks {
-  track: Track[];
-  '@attr': AttrLimit;
-}
-
-export interface UserResponse {
-  user: User;
-}
-
-export interface RecentTracksResponse {
-  recenttracks: RecentTracks;
-}
-
-export interface RecentTracks {
-  track: Track[];
-  '@attr': AttrLimit;
-}
-
-export interface LoveTracksResponse {
-  lovedtracks: LovedTracks;
-}
-
-export interface LovedTracks {
-  track: Track[];
-  '@attr': AttrNowPlaying;
-}
-export interface FriendsResponse {
-  friends: Friends;
-}
-
-export interface Friends {
-  '@attr': AttrNowPlaying;
-  user: User[];
-}
-
-export interface TopArtistsResponse {
-  topartists: TopArtists;
-}
-
-export interface TopArtists {
-  artist: Artist[];
-  '@attr': AttrLimit;
-}
-
-export interface WeeklyArtistChartResponse {
-  weeklyartistchart: WeeklyArtistChart;
-}
-
-export interface WeeklyArtistChart {
-  artist: Artist[];
-  '@attr': AttrLimit;
-}
-
-export interface WeeklyAlbumChartResponse {
-  weeklyalbumchart: WeeklyAlbumChart;
-}
-
-export interface WeeklyAlbumChart {
-  album: WeeklyAlbum[];
-  '@attr': WeeklyalbumChartAttr;
-}
-
-export interface 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?: Image[];
-  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 extends Track {
-  album: Album;
-  artist: Artist;
-  name: string;
-  url: string
-};
-
-export interface AttrNowPlaying {
-  nowplaying: string;
-}
-
-export interface Date {
-  uts: string;
-  '#text': string;
-}
-
-export interface Track {
-  '@attr'?: AttrRank;
-  album: Album;
-  artist: Artist;  
-  date?: Date;
-  duration?: string;
-  image?: Image[];
-  mbid: string;
-  name: string;
-  playcount?: string;
-  streamable?: string;
-  url: string;
-}
-
-export interface AttrLimit {
-  user: string;
-  totalPages: string;
-  page: string;
-  perPage: string;
-  total: string;
-}
-
-export interface RecentTracks {
-  track: Track[];
-  '@attr': AttrLimit;
-}
-
-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': AttrLimit;
-}
-
-export interface WeeklyArtistChartResponse {
-  weeklyartistchart: WeeklyArtistChart;
-}
-
-export interface WeeklyArtistChart {
-  artist: Artist[];
-  '@attr': AttrLimit;
-}
-
-export interface AttrRank {
-  rank?: string;
-}
-
-export interface AttrLimit {
-  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': AttrLimit;
-}
-
-export interface WeeklyTrackChartTrack {
-  artist: WeeklyTrackChartArtist;
-  image: Image[];
-  mbid: string;
-  url: string;
-  name: string;
-  '@attr': AttrNowPlaying;
-  playcount: string;
-}
-
-export interface WeeklyTrackChartArtist {
-  mbid: string;
-  '#text': string;
-}
-
-export enum ErrorResponse {
-    InvalidService = 2,
-    InvalidMethod = 3,
-    AuthenticationFailed = 4,
-    InvalidFormat = 5,
-    InvalidParameters = 6,
-    InvalidResource = 7,
-    OperationFailed = 8,
-    InvalidSessionKey = 9,
-    InvalidAPIKey = 10,
-    ServiceOffline = 11,
-    InvalidMethodSignature = 13,
-    TemporaryError = 16,
-    SuspendedAPIKey = 26,
-    RateLimitExceeded = 29
-}

package/CHANGELOG.md

@@ -1,108 +0,0 @@
-# Changelog
-
-## 1.4.3
-
-- fix missmatched types for Album and Track, added some optionals pity, but it works, that just how they give us the data.
-
-## 1.4.2
-
-- bug, release dist
-
-## 1.4.1
-
-- export esm modules modern js only.
-- add all dts and dts map files to dist
-- adds lastfm types to dist
-
-## 1.4.0
-
-- update all api functions from snake case to camel case.
-
-## 1.3.0
-
-- Updates npm dependencies.
-- refactors request with new error handling and responses.
-- updates getInfo, removes  hte un-required params.
-
-## 1.2.4
-
-- Updates npm dependencies.
-- Refactors request methods options and updates all callsites.
-- Add nvmrc file for easy switching node version.
-
-## 1.2.3
-
-- Adds tests, using Playwright.
-- Adds dotenv npm module as a new dependency.
-
-## 1.2.2
-
-- Put log back, some APIs do get Bad Request for MBIDs that don't exist, don't have solve for this yet, so not throwing any more as it grinds future request to a halt. This is a working version.
-
-## 1.2.1
-
-- Tidy up, removes console logs.
-
-## 1.2.0
-
-- Swops `node-fetch` for `cross-fetch` for server and browser fetching support in one.
-
-## 1.1.5
-
-- Fix incorrect type on request method.
-
-## 1.1.4
-
-- Fix incorrect type on request method.
-
-## 1.1.3
-
-- Fix incorrect type import.
-
-## 1.1.2
-
-- Fix broken type, Track image type is an array of Images.
-
-## 1.1.1
-
-- update function declaration.
-- re-add type declartion files for source code.
-
-## 1.1.0
-
-- Downgrade node-fetch to v2.6.7.
-- Do not ship separate declaration files.
-- TS now exports to CommonJs modules for better support older consumers.
-
-## 1.0.6
-
-- Forking repo README update.
-
-## 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.
-- 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.
-
-## 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.