musicbrainz-api 0.14.0 → 0.16.0

package/README.md

@@ -98,7 +98,7 @@ const artist = await mbApi.lookup('artist', 'ab2528d9-719f-4261-8098-21849222a0f
 ### Browse artist
 
 ```js
-const artists = await browse('artist', query);
+const artists = await mbApi.browse('artist', query);
 ````
 
 | Query argument        | Query value        | 
@@ -112,7 +112,7 @@ const artists = await browse('artist', query);
 
 ### Browse collection
 ```js
-const collections = await browse('collection', query);
+const collections = await mbApi.browse('collection', query);
 ````
 
 | Query argument        | Query value        | 
@@ -130,7 +130,7 @@ const collections = await browse('collection', query);
 
 ### Browse events
 ```js
-const events = await browse('event', query);
+const events = await mbApi.browse('event', query);
 ````
 
 | Query argument        | Query value     | 
@@ -142,7 +142,7 @@ const events = await browse('event', query);
 
 ### Browse instruments
 ```js
-const instruments = await browse('event', query);
+const instruments = await mbApi.browse('event', query);
 ````
 
 | Query argument        | Query value        | 
@@ -151,7 +151,7 @@ const instruments = await browse('event', query);
 
 ### Browse labels
 ```js
-const labels = await browse('label', query);
+const labels = await mbApi.browse('label', query);
 ````
 
 | Query argument     | Query value     | 
@@ -162,7 +162,7 @@ const labels = await browse('label', query);
 
 ### Browse places
 ```js
-const places = await browse('place', query);
+const places = await mbApi.browse('place', query);
 ````
 
 | Query argument     | Query value     | 
@@ -172,7 +172,7 @@ const places = await browse('place', query);
 
 ### Browse recordings
 ```js
-const recordings = await browse('recording', query);
+const recordings = await mbApi.browse('recording', query);
 ````
 
 | Query argument     | Query value     | 
@@ -184,7 +184,7 @@ const recordings = await browse('recording', query);
 
 ### Browse releases
 ```js
-const releases = await browse('release', query);
+const releases = await mbApi.browse('release', query);
 ````
 
 | Query argument        | Query value        | 
@@ -202,7 +202,7 @@ const releases = await browse('release', query);
 
 ### Browse release-groups
 ```js
-const releaseGroups = await browse('release-group',query);
+const releaseGroups = await mbApi.browse('release-group',query);
 ```
 
 | Query argument     | Query value     | 
@@ -213,7 +213,7 @@ const releaseGroups = await browse('release-group',query);
 
 ### Browse series
 ```js
-const series = await browse('series');
+const series = await mbApi.browse('series');
 ````
 
 | Query argument        | Query value        | 
@@ -231,7 +231,7 @@ const series = await browse('series');
 
 ### Browse works
 ```js
-const works = await browse('work');
+const works = await mbApi.browse('work');
 ````
 
 | Query argument     | Query value     | 
@@ -241,7 +241,7 @@ const works = await browse('work');
 
 ### Browse urls
 ```js
-const urls = await browse('url');
+const urls = await mbApi.browse('url');
 ````
 
 | Query argument     | Query value     | 
@@ -277,7 +277,7 @@ Arguments:
 For example, to find any recordings of _'We Will Rock You'_ by Queen:
 ```js
 const query = 'query="We Will Rock You" AND arid:0383dadf-2a4e-4d10-a46a-e9e041da8eb3';
-const result = await mbApi.query<mb.IReleaseGroupList>('release-group', {query});
+const result = await mbApi.search('release-group', {query});
 ```
 
 ##### Example: search Île-de-France
@@ -391,6 +391,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 +409,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.d.ts

@@ -24,8 +24,25 @@ export declare class CoverArtArchiveApi {
     private host;
     private getJson;
     /**
-     *
+     * Fetch release
+     * @releaseId Release MBID
      * @param releaseId MusicBrainz Release MBID
+     * @param coverType Cover type
      */
     getReleaseCovers(releaseId: string, coverType?: 'front' | 'back'): Promise<ICoverInfo>;
+    /**
+     * Fetch release-group
+     * @releaseGroupId Release-group MBID
+     * @param releaseGroupId MusicBrainz Release Group MBID
+     * @param coverType Cover type
+     */
+    getReleaseGroupCovers(releaseGroupId: string, coverType?: 'front' | 'back'): Promise<ICoverInfo>;
+    /**
+     * Fetch covers
+     * @releaseId MBID
+     * @param releaseId MusicBrainz Release Group MBID
+     * @param releaseType Fetch covers for specific release or release-group
+     * @param coverType Cover type
+     */
+    private getCovers;
 }

package/lib/coverartarchive-api.js

@@ -5,27 +5,49 @@ 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'
         });
         return response.body;
     }
     /**
-     *
+     * Fetch release
+     * @releaseId Release MBID
      * @param releaseId MusicBrainz Release MBID
+     * @param coverType Cover type
      */
-    async getReleaseCovers(releaseId, coverType) {
-        const path = ['release', releaseId];
+    getReleaseCovers(releaseId, coverType) {
+        return this.getCovers(releaseId, 'release', coverType);
+    }
+    /**
+     * Fetch release-group
+     * @releaseGroupId Release-group MBID
+     * @param releaseGroupId MusicBrainz Release Group MBID
+     * @param coverType Cover type
+     */
+    getReleaseGroupCovers(releaseGroupId, coverType) {
+        return this.getCovers(releaseGroupId, 'release-group', coverType);
+    }
+    /**
+     * Fetch covers
+     * @releaseId MBID
+     * @param releaseId MusicBrainz Release Group MBID
+     * @param releaseType Fetch covers for specific release or release-group
+     * @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';
@@ -46,7 +46,7 @@ export type IFormData = {
     [key: string]: string | number;
 };
 export interface IMusicBrainzConfig {
-    botAccount: {
+    botAccount?: {
         username?: string;
         password?: string;
     };
@@ -71,7 +71,6 @@ export interface ISessionInformation {
     loggedIn?: boolean;
 }
 export declare class MusicBrainzApi {
-    private static escapeText;
     readonly config: IMusicBrainzConfig;
     private rateLimiter;
     private options;
@@ -82,7 +81,7 @@ export declare class MusicBrainzApi {
     constructor(_config?: IMusicBrainzConfig);
     restGet<T>(relUrl: string, query?: {
         [key: string]: any;
-    }, attempt?: number): Promise<T>;
+    }): Promise<T>;
     /**
      * Lookup entity
      * @param entity 'area', 'artist', collection', 'instrument', 'label', 'place', 'release', 'release-group', 'recording', 'series', 'work', 'url' or 'event'
@@ -164,9 +163,8 @@ export declare class MusicBrainzApi {
      * Add ISRC to recording
      * @param recording Recording to update
      * @param isrc ISRC code to add
-     * @param editNote Edit note
      */
-    addIsrc(recording: mb.IRecording, isrc: string, editNote?: string): Promise<void>;
+    addIsrc(recording: mb.IRecording, isrc: string): Promise<void>;
     /**
      * Add Spotify-ID to MusicBrainz recording.
      * This function will automatically lookup the recording title, which is required to submit the recording URL

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,38 +11,9 @@ 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 escapeText(text) {
-        let str = '';
-        for (const chr of text) {
-            // Escaping Special Characters: + - && || ! ( ) { } [ ] ^ " ~ * ? : \ /
-            // ToDo: && ||
-            switch (chr) {
-                case '+':
-                case '-':
-                case '!':
-                case '(':
-                case ')':
-                case '{':
-                case '}':
-                case '[':
-                case ']':
-                case '^':
-                case '"':
-                case '~':
-                case '*':
-                case '?':
-                case ':':
-                case '\\':
-                case '/':
-                    str += '\\';
-            }
-            str += chr;
-        }
-        return str;
-    }
     static fetchCsrf(html) {
         return {
             sessionKey: MusicBrainzApi.fetchValue(html, 'csrf_session_key'),
@@ -56,15 +27,13 @@ export class MusicBrainzApi {
             if (pos >= 0) {
                 pos += 7;
                 const endValuePos = html.indexOf('"', pos);
-                const value = html.substring(pos, endValuePos);
-                return value;
+                return html.substring(pos, endValuePos);
             }
         }
     }
     constructor(_config) {
         this.config = {
-            baseUrl: 'https://musicbrainz.org',
-            botAccount: {}
+            baseUrl: 'https://musicbrainz.org'
         };
         Object.assign(this.config, _config);
         const cookieJar = new CookieJar();
@@ -82,11 +51,11 @@ export class MusicBrainzApi {
         };
         this.rateLimiter = new RateLimitThreshold(15, 18);
     }
-    async restGet(relUrl, query = {}, attempt = 1) {
+    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, {
+        const response = await got.get(`ws/2${relUrl}`, {
             ...this.options,
             searchParams: query,
             responseType: 'json',
@@ -110,7 +79,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) {
@@ -118,7 +87,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}/`;
@@ -151,9 +120,10 @@ export class MusicBrainzApi {
         } while (n++ < 5);
     }
     async login() {
-        assert.ok(this.config.botAccount.username, 'bot username should be set');
-        assert.ok(this.config.botAccount.password, 'bot password should be set');
-        if (this.session && this.session.loggedIn) {
+        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 ((_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;
@@ -208,12 +178,13 @@ export class MusicBrainzApi {
      * @param formData
      */
     async editEntity(entity, mbid, formData) {
+        var _a, _b;
         await this.rateLimiter.limit();
         this.session = await this.getSession();
         formData.csrf_session_key = this.session.csrf.sessionKey;
         formData.csrf_token = this.session.csrf.token;
-        formData.username = this.config.botAccount.username;
-        formData.password = this.config.botAccount.password;
+        formData.username = (_a = this.config.botAccount) === null || _a === void 0 ? void 0 : _a.username;
+        formData.password = (_b = this.config.botAccount) === null || _b === void 0 ? void 0 : _b.password;
         formData.remember_me = 1;
         const response = await got.post(`${entity}/${mbid}/edit`, {
             ...this.options,
@@ -221,7 +192,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}`);
@@ -250,11 +221,10 @@ export class MusicBrainzApi {
      * Add ISRC to recording
      * @param recording Recording to update
      * @param isrc ISRC code to add
-     * @param editNote Edit note
      */
-    async addIsrc(recording, isrc, editNote = '') {
+    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');
         }
@@ -280,13 +250,13 @@ 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() {
         const response = await got.get('login', {
             ...this.options,
-            followRedirect: false,
+            followRedirect: false, // Disable redirects
             responseType: 'text'
         });
         return {

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.14.0",
+  "version": "0.16.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": "./lib/index.js",
   "types": "lib/index.d.ts",
@@ -34,7 +34,6 @@
     "download covers"
   ],
   "license": "MIT",
-  "private": false,
   "engines": {
     "node": "^14.13.1 || >=16.0.0"
   },
@@ -46,55 +45,47 @@
     "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": "^13.0.0",
+    "got": "^14.2.1",
     "http-status-codes": "^2.1.4",
     "json-stringify-safe": "^5.0.1",
     "jsontoxml": "^1.0.1",
     "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": "^8.0.1",
-    "chai": "^4.2.0",
+    "@types/node": "^22.1.0",
+    "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": "^46.8.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",
     "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": {
@@ -111,5 +102,6 @@
       "text"
     ],
     "report-dir": "coverage"
-  }
+  },
+  "packageManager": "yarn@4.1.1"
 }