lastfm-nodejs-client 1.4.3 → 1.4.5

package/dist/mjs/request.js

@@ -0,0 +1,119 @@
+import fetch from 'cross-fetch';
+import { config } from './config';
+var ErrorResponse;
+(function (ErrorResponse) {
+    ErrorResponse[ErrorResponse["InvalidService"] = 2] = "InvalidService";
+    ErrorResponse[ErrorResponse["InvalidMethod"] = 3] = "InvalidMethod";
+    ErrorResponse[ErrorResponse["AuthenticationFailed"] = 4] = "AuthenticationFailed";
+    ErrorResponse[ErrorResponse["InvalidFormat"] = 5] = "InvalidFormat";
+    ErrorResponse[ErrorResponse["InvalidParameters"] = 6] = "InvalidParameters";
+    ErrorResponse[ErrorResponse["InvalidResource"] = 7] = "InvalidResource";
+    ErrorResponse[ErrorResponse["OperationFailed"] = 8] = "OperationFailed";
+    ErrorResponse[ErrorResponse["InvalidSessionKey"] = 9] = "InvalidSessionKey";
+    ErrorResponse[ErrorResponse["InvalidAPIKey"] = 10] = "InvalidAPIKey";
+    ErrorResponse[ErrorResponse["ServiceOffline"] = 11] = "ServiceOffline";
+    ErrorResponse[ErrorResponse["InvalidMethodSignature"] = 13] = "InvalidMethodSignature";
+    ErrorResponse[ErrorResponse["TemporaryError"] = 16] = "TemporaryError";
+    ErrorResponse[ErrorResponse["SuspendedAPIKey"] = 26] = "SuspendedAPIKey";
+    ErrorResponse[ErrorResponse["RateLimitExceeded"] = 29] = "RateLimitExceeded";
+})(ErrorResponse || (ErrorResponse = {}));
+const buildUrl = (options) => {
+    const params = new URLSearchParams();
+    params.append('method', options.method);
+    if (options.user)
+        params.append('user', options.user);
+    if (options.period)
+        params.append('period', options.period);
+    if (options.limit)
+        params.append('limit', options.limit);
+    params.append('api_key', config.api_key);
+    params.append('format', config.format.json);
+    return `${config.base_url}?${params.toString()}`;
+};
+const request = async (options) => {
+    const url = buildUrl(options);
+    return (await fetch(url, {
+        headers: {
+            'Content-Type': 'application/json',
+        },
+    })
+        .then(async (res) => {
+        if (!res.ok) {
+            throw new Error(res.statusText);
+        }
+        switch (res.status) {
+            case 200: {
+                return await res.json();
+            }
+            case 400: {
+                throw new Error('Bad request');
+            }
+            case 401: {
+                throw new Error('Unauthorized');
+            }
+            case 403: {
+                throw new Error('Forbidden');
+            }
+            case 404: {
+                throw new Error('Not found');
+            }
+            case 500: {
+                throw new Error('Internal server error');
+            }
+            case 503: {
+                throw new Error('Service unavailable');
+            }
+            case ErrorResponse.InvalidAPIKey: {
+                throw new Error('Invalid API key');
+            }
+            case ErrorResponse.InvalidMethod: {
+                throw new Error('Invalid method');
+            }
+            case ErrorResponse.InvalidParameters: {
+                throw new Error('Invalid parameters');
+            }
+            case ErrorResponse.InvalidResource: {
+                throw new Error('Invalid resource');
+            }
+            case ErrorResponse.InvalidSessionKey: {
+                throw new Error('Invalid session key');
+            }
+            case ErrorResponse.InvalidService: {
+                throw new Error('Invalid service');
+            }
+            case ErrorResponse.OperationFailed: {
+                throw new Error('Operation failed');
+            }
+            case ErrorResponse.RateLimitExceeded: {
+                throw new Error('Rate limit exceeded');
+            }
+            case ErrorResponse.ServiceOffline: {
+                throw new Error('Service offline');
+            }
+            case ErrorResponse.SuspendedAPIKey: {
+                throw new Error('Suspended API key');
+            }
+            case ErrorResponse.TemporaryError: {
+                throw new Error('Temporary error');
+            }
+            case ErrorResponse.AuthenticationFailed: {
+                throw new Error('Authentication failed');
+            }
+            case ErrorResponse.InvalidFormat: {
+                throw new Error('Invalid format');
+            }
+            case ErrorResponse.InvalidMethodSignature: {
+                throw new Error('Invalid method signature');
+            }
+            default: {
+                throw new Error('Unknown error');
+            }
+        }
+    })
+        .then((json) => json)
+        .catch((error) => {
+        // eslint-disable-next-line no-console
+        console.error('🚨 error:', error);
+    }));
+};
+export default request;

package/lastfm-nodejs-client/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "lastfm-nodejs-client",
+  "description": "A client for interacting with the lastFm API",
+  "main": "../dist/cjs/index.js",
+  "module": "../dist/mjs/indext.js",
+  "types": "../dist/mjs/index.d.ts"
+}

package/package.json

@@ -1,8 +1,36 @@
 {
   "name": "lastfm-nodejs-client",
-  "version": "1.4.3",
+  "version": "1.4.5",
   "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 && mkdir dist/@types && cp -a @types/* dist/@types",
+    "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/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.

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-9pd5r3wqq@mozmail.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,9 +0,0 @@
-# Contributing
-
-Hi thanks for stopping by, so glad you decided to contribute 😎
-
-1. make an issue or bug report
-2. fork repo
-3. do your magic
-4. make pull request
-5. we merge it

package/SECURITY.md

@@ -1,13 +0,0 @@
-# 🔐 Security Policy
-
-## Supported Versions
-
-Dependabot alerts have been enabled and security patches to any dependencies will be brought to light and merged manually by maintainer.
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.0.x   | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-If you find anything at all kindly report it as bug report here on github ✌️

package/dist/auth.d.ts

@@ -1,13 +0,0 @@
-import { AuthResponse } from '../@types';
-/**
-* POST: Auth - LastFM
-*
-* https://www.last.fm/api/show/auth.getToken
-*
-* Authentication tokens are API account specific.
-* They are valid for 60 minutes from the moment they are granted.
-* Can only used once (they are consumed when a session is created).
-* @returns Auth token
-*/
-export declare function auth(method: string, user: string, period: string, limit: string): Promise<AuthResponse>;
-//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAIzC;;;;;;;;;EASE;AACF,wBAAgB,IAAI,CAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,YAAY,CAAC,CAGvB"}