musicbrainz-api 0.15.0 → 0.17.0

package/README.md

@@ -69,7 +69,10 @@ const config = {
    },
 
   // Your e-mail address, required for submitting ISRCs
-  appMail: string
+  appMail: string,
+
+  // Helpful if you have your own MusicBrainz server, default: false (optional)
+  disableRateLimiting: false,
 }
 
 const mbApi = new MusicbrainzApi(config);
@@ -391,6 +394,7 @@ await mbApi.addSpotifyIdToRecording(recording, '2AMysGXOe0zzZJMtH3Nizb');
 
 Implementation of the [Cover Art Archive API](https://musicbrainz.org/doc/Cover_Art_Archive/API).
 
+### Release Cover Art
 ```js
 import {CoverArtArchiveApi} from 'musicbrainz-api';
 
@@ -408,6 +412,25 @@ coverArtArchiveApiClient.getReleaseCovers(releaseMbid, 'back').then(releaseCover
 
 ```
 
+### Release Group Cover Art
+```js
+import {CoverArtArchiveApi} from 'musicbrainz-api';
+
+coverArtArchiveApiClient.getReleaseGroupCovers(releaseGroupMbid).then(releaseGroupCoverInfo => {
+    console.log('Release cover info', releaseGroupCoverInfo);
+});
+
+coverArtArchiveApiClient.getReleaseGroupCovers(releaseGroupMbid, 'front').then(releaseGroupCoverInfo => {
+    console.log('Get best front cover', releaseGroupCoverInfo);
+});
+
+coverArtArchiveApiClient.getReleaseGroupCovers(releaseGroupMbid, 'back').then(releaseGroupCoverInfo => {
+    console.log('Get best back cover', releaseGroupCoverInfo);
+});
+
+```
+
+
 ## Compatibility
 
 The JavaScript in runtime is compliant with [ECMAScript 2017 (ES8)](https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_-_ECMAScript_2017).

package/lib/coverartarchive-api.js

@@ -5,9 +5,9 @@ export class CoverArtArchiveApi {
         this.host = 'coverartarchive.org';
     }
     async getJson(path) {
-        const response = await got.get('https://' + this.host + path, {
+        const response = await got.get(`https://${this.host}${path}`, {
             headers: {
-                Accept: `application/json`
+                Accept: "application/json"
             },
             responseType: 'json'
         });
@@ -39,14 +39,15 @@ export class CoverArtArchiveApi {
      * @param coverType Cover type
      */
     async getCovers(releaseId, releaseType = 'release', coverType) {
+        var _a;
         const path = [releaseType, releaseId];
         if (coverType) {
             path.push(coverType);
         }
-        const info = await this.getJson('/' + path.join('/'));
+        const info = await this.getJson(`/${path.join('/')}`);
         // Hack to correct http addresses into https
-        if (info.release && info.release.startsWith('http:')) {
-            info.release = 'https' + info.release.substring(4);
+        if ((_a = info.release) === null || _a === void 0 ? void 0 : _a.startsWith('http:')) {
+            info.release = `https${info.release.substring(4)}`;
         }
         return info;
     }

package/lib/digest-auth.js

@@ -1,5 +1,5 @@
 import { v4 as uuidv4 } from 'uuid';
-import * as crypto from 'crypto';
+import * as crypto from 'node:crypto';
 function md5(str) {
     return crypto.createHash('md5').update(str).digest('hex'); // lgtm [js/insufficient-password-hash]
 }
@@ -13,8 +13,8 @@ export class DigestAuth {
      *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
      */
     static ha1Compute(algorithm, user, realm, pass, nonce, cnonce) {
-        const ha1 = md5(user + ':' + realm + ':' + pass); // lgtm [js/insufficient-password-hash]
-        return algorithm && algorithm.toLowerCase() === 'md5-sess' ? md5(ha1 + ':' + nonce + ':' + cnonce) : ha1;
+        const ha1 = md5(`${user}:${realm}:${pass}`); // lgtm [js/insufficient-password-hash]
+        return algorithm && algorithm.toLowerCase() === 'md5-sess' ? md5(`${ha1}:${nonce}:${cnonce}`) : ha1;
     }
     constructor(credentials) {
         this.credentials = credentials;
@@ -44,10 +44,10 @@ export class DigestAuth {
         const nc = qop && '00000001';
         const cnonce = qop && uuidv4().replace(/-/g, '');
         const ha1 = DigestAuth.ha1Compute(challenge.algorithm, this.credentials.username, challenge.realm, this.credentials.password, challenge.nonce, cnonce);
-        const ha2 = md5(method + ':' + path); // lgtm [js/insufficient-password-hash]
+        const ha2 = md5(`${method}:${path}`); // lgtm [js/insufficient-password-hash]
         const digestResponse = qop
-            ? md5(ha1 + ':' + challenge.nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2) // lgtm [js/insufficient-password-hash]
-            : md5(ha1 + ':' + challenge.nonce + ':' + ha2); // lgtm [js/insufficient-password-hash]
+            ? md5(`${ha1}:${challenge.nonce}:${nc}:${cnonce}:${qop}:${ha2}`) // lgtm [js/insufficient-password-hash]
+            : md5(`${ha1}:${challenge.nonce}:${ha2}`); // lgtm [js/insufficient-password-hash]
         const authValues = {
             username: this.credentials.username,
             realm: challenge.realm,
@@ -64,16 +64,16 @@ export class DigestAuth {
         Object.entries(authValues).forEach(([key, value]) => {
             if (value) {
                 if (key === 'qop' || key === 'nc' || key === 'algorithm') {
-                    parts.push(key + '=' + value);
+                    parts.push(`${key}=${value}`);
                 }
                 else {
-                    parts.push(key + '="' + value + '"');
+                    parts.push(`${key}="${value}"`);
                 }
             }
         });
-        authHeader = 'Digest ' + parts.join(', ');
+        const digest = `Digest ${parts.join(', ')}`;
         this.sentAuth = true;
-        return authHeader;
+        return digest;
     }
 }
 //# sourceMappingURL=digest-auth.js.map

package/lib/musicbrainz-api.d.ts

@@ -2,7 +2,7 @@ export { XmlMetadata } from './xml/xml-metadata.js';
 export { XmlIsrc } from './xml/xml-isrc.js';
 export { XmlIsrcList } from './xml/xml-isrc-list.js';
 export { XmlRecording } from './xml/xml-recording.js';
-import { XmlMetadata } from './xml/xml-metadata.js';
+import type { XmlMetadata } from './xml/xml-metadata.js';
 import * as mb from './musicbrainz.types.js';
 export * from './musicbrainz.types.js';
 export type RelationsIncludes = 'area-rels' | 'artist-rels' | 'event-rels' | 'instrument-rels' | 'label-rels' | 'place-rels' | 'recording-rels' | 'release-rels' | 'release-group-rels' | 'series-rels' | 'url-rels' | 'work-rels';
@@ -61,6 +61,7 @@ export interface IMusicBrainzConfig {
      * User e-mail address or application URL
      */
     appContactInfo?: string;
+    disableRateLimiting?: boolean;
 }
 export interface ICsrfSession {
     sessionKey: string;
@@ -174,5 +175,6 @@ export declare class MusicBrainzApi {
      */
     addSpotifyIdToRecording(recording: mb.IRecording, spotifyId: string, editNote: string): Promise<void>;
     private getSession;
+    private applyRateLimiter;
 }
 export declare function makeAndQueryString(keyValuePairs: IFormData): string;

package/lib/musicbrainz-api.js

@@ -1,4 +1,4 @@
-import * as assert from 'assert';
+import * as assert from 'node:assert';
 import { StatusCodes as HttpStatus } from 'http-status-codes';
 import Debug from 'debug';
 export { XmlMetadata } from './xml/xml-metadata.js';
@@ -11,7 +11,7 @@ import * as mb from './musicbrainz.types.js';
 import got from 'got';
 import { CookieJar } from 'tough-cookie';
 export * from './musicbrainz.types.js';
-import { promisify } from 'util';
+import { promisify } from 'node:util';
 const debug = Debug('musicbrainz-api');
 export class MusicBrainzApi {
     static fetchCsrf(html) {
@@ -53,9 +53,8 @@ export class MusicBrainzApi {
     }
     async restGet(relUrl, query = {}) {
         query.fmt = 'json';
-        const delay = await this.rateLimiter.limit();
-        debug(`Client side rate limiter activated: cool down for ${Math.round(delay / 100) / 10} s...`);
-        const response = await got.get('ws/2' + relUrl, {
+        await this.applyRateLimiter();
+        const response = await got.get(`ws/2${relUrl}`, {
             ...this.options,
             searchParams: query,
             responseType: 'json',
@@ -79,7 +78,7 @@ export class MusicBrainzApi {
         if (Array.isArray(query.inc)) {
             urlQuery.inc = urlQuery.inc.join(' ');
         }
-        return this.restGet('/' + entity + '/', urlQuery);
+        return this.restGet(`/${entity}/`, urlQuery);
     }
     // ---------------------------------------------------------------------------
     async postRecording(xmlMetadata) {
@@ -87,7 +86,7 @@ export class MusicBrainzApi {
     }
     async post(entity, xmlMetadata) {
         if (!this.config.appName || !this.config.appVersion) {
-            throw new Error(`XML-Post requires the appName & appVersion to be defined`);
+            throw new Error("XML-Post requires the appName & appVersion to be defined");
         }
         const clientId = `${this.config.appName.replace(/-/g, '.')}-${this.config.appVersion}`;
         const path = `ws/2/${entity}/`;
@@ -96,7 +95,7 @@ export class MusicBrainzApi {
         let n = 1;
         const postData = xmlMetadata.toXml();
         do {
-            await this.rateLimiter.limit();
+            await this.applyRateLimiter();
             const response = await got.post(path, {
                 ...this.options,
                 searchParams: { client: clientId },
@@ -120,10 +119,10 @@ export class MusicBrainzApi {
         } while (n++ < 5);
     }
     async login() {
-        var _a, _b;
+        var _a, _b, _c;
         assert.ok((_a = this.config.botAccount) === null || _a === void 0 ? void 0 : _a.username, 'bot username should be set');
         assert.ok((_b = this.config.botAccount) === null || _b === void 0 ? void 0 : _b.password, 'bot password should be set');
-        if (this.session && this.session.loggedIn) {
+        if ((_c = this.session) === null || _c === void 0 ? void 0 : _c.loggedIn) {
             for (const cookie of await this.getCookies(this.options.prefixUrl)) {
                 if (cookie.key === 'remember_login') {
                     return true;
@@ -179,7 +178,7 @@ export class MusicBrainzApi {
      */
     async editEntity(entity, mbid, formData) {
         var _a, _b;
-        await this.rateLimiter.limit();
+        await this.applyRateLimiter();
         this.session = await this.getSession();
         formData.csrf_session_key = this.session.csrf.sessionKey;
         formData.csrf_token = this.session.csrf.token;
@@ -192,7 +191,7 @@ export class MusicBrainzApi {
             followRedirect: false
         });
         if (response.statusCode === HttpStatus.OK)
-            throw new Error(`Failed to submit form data`);
+            throw new Error("Failed to submit form data");
         if (response.statusCode === HttpStatus.MOVED_TEMPORARILY)
             return;
         throw new Error(`Unexpected status code: ${response.statusCode}`);
@@ -224,7 +223,7 @@ export class MusicBrainzApi {
      */
     async addIsrc(recording, isrc) {
         const formData = {};
-        formData[`edit-recording.name`] = recording.title; // Required
+        formData["edit-recording.name"] = recording.title; // Required
         if (!recording.isrcs) {
             throw new Error('You must retrieve recording with existing ISRC values');
         }
@@ -250,7 +249,7 @@ export class MusicBrainzApi {
         assert.strictEqual(spotifyId.length, 22);
         return this.addUrlToRecording(recording, {
             linkTypeId: mb.LinkType.stream_for_free,
-            text: 'https://open.spotify.com/track/' + spotifyId
+            text: `https://open.spotify.com/track/${spotifyId}`
         }, editNote);
     }
     async getSession() {
@@ -263,6 +262,12 @@ export class MusicBrainzApi {
             csrf: MusicBrainzApi.fetchCsrf(response.body)
         };
     }
+    async applyRateLimiter() {
+        if (!this.config.disableRateLimiting) {
+            const delay = await this.rateLimiter.limit();
+            debug(`Client side rate limiter activated: cool down for ${Math.round(delay / 100) / 10} s...`);
+        }
+    }
 }
 export function makeAndQueryString(keyValuePairs) {
     return Object.keys(keyValuePairs).map(key => `${key}:"${keyValuePairs[key]}"`).join(' AND ');

package/lib/musicbrainz.types.d.ts

@@ -36,7 +36,7 @@ export interface IArtist extends IEntity {
     'gender-id'?: string;
     'life-span'?: IPeriod;
     country?: string;
-    ipis?: any[];
+    ipis?: string[];
     isnis?: string[];
     aliases?: IAlias[];
     gender?: string;
@@ -200,13 +200,13 @@ export interface IUrlList extends ISearchResult {
 }
 export type RelationDirection = 'backward' | 'forward';
 export interface IRelation {
-    'attribute-ids': any;
+    'attribute-ids': unknown[];
     direction: RelationDirection;
     'target-credit': string;
     end: null | unknown;
     'source-credit': string;
     ended: boolean;
-    'attribute-values': unknown;
+    'attribute-values': unknown[];
     attributes?: any[];
     type: string;
     begin?: null | unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": "./lib/index.js",
   "types": "lib/index.d.ts",
@@ -45,9 +45,10 @@
     "url": "https://github.com/Borewit/musicbrainz-api/issues"
   },
   "dependencies": {
+    "@biomejs/biome": "1.8.3",
     "@types/caseless": "^0.12.1",
     "@types/request-promise-native": "^1.0.17",
-    "@types/uuid": "^9.0.0",
+    "@types/uuid": "^10.0.0",
     "caseless": "^0.12.0",
     "debug": "^4.3.4",
     "got": "^14.2.1",
@@ -57,43 +58,36 @@
     "rate-limit-threshold": "^0.1.5",
     "source-map-support": "^0.5.16",
     "tough-cookie": "^4.1.3",
-    "uuid": "^9.0.0"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",
     "@types/jsontoxml": "^1.0.5",
     "@types/mocha": "^10.0.4",
-    "@types/node": "^20.8.10",
-    "@typescript-eslint/eslint-plugin": "^5.13.0",
-    "@typescript-eslint/parser": "^5.13.0",
-    "c8": "^9.1.0",
+    "@types/node": "^22.1.0",
+    "@types/sinon": "^17.0.3",
+    "c8": "^10.1.2",
     "chai": "^5.1.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.10.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-import-resolver-typescript": "^3.3.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^48.2.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^49.0.0",
     "mocha": "^10.1.0",
     "remark-cli": "^12.0.0",
-    "remark-preset-lint-recommended": "^6.1.2",
+    "remark-preset-lint-recommended": "^7.0.0",
+    "sinon": "^18.0.0",
     "ts-node": "^10.0.0",
     "typescript": "^5.0.2"
   },
   "scripts": {
-    "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.js test/**/*.js.map",
+    "clean": "del-cli 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'test/**/*.js' 'test/**/*.js.map'",
     "compile-lib": "tsc -p lib",
     "compile-test": "tsc -p test",
-    "compile": "npm run compile-lib && npm run compile-test",
-    "eslint": "eslint lib/**/*.ts --ignore-pattern lib/**/*.d.ts test/**/*.ts",
+    "compile": "yarn run compile-lib && yarn run compile-test",
     "lint-md": "remark -u preset-lint-recommended .",
-    "lint": "npm run lint-md && npm run eslint",
+    "lint-ts": "biome check",
+    "lint": "yarn run lint-md && yarn run lint-ts",
     "test": "mocha",
-    "build": "npm run clean && npm run compile",
-    "start": "npm-run-all compile lint cover-test",
-    "test-coverage": "c8 npm run test",
+    "build": "yarn run clean && yarn run compile",
+    "start": "yarn run compile && yarn run lint && yarn run cover-test",
+    "test-coverage": "c8 yarn run test",
     "send-codacy": "nyc report --reporter=text-lcov | codacy-coverage"
   },
   "nyc": {