musicbrainz-api 0.14.0 → 0.15.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

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

@@ -14,11 +14,32 @@ export class CoverArtArchiveApi {
         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) {
+        const path = [releaseType, releaseId];
         if (coverType) {
             path.push(coverType);
         }

package/lib/musicbrainz-api.d.ts

@@ -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

@@ -14,35 +14,6 @@ export * from './musicbrainz.types.js';
 import { promisify } from '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,7 +51,7 @@ 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...`);
@@ -151,8 +120,9 @@ 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');
+        var _a, _b;
+        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) {
             for (const cookie of await this.getCookies(this.options.prefixUrl)) {
                 if (cookie.key === 'remember_login') {
@@ -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,
@@ -250,9 +221,8 @@ 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
         if (!recording.isrcs) {
@@ -286,7 +256,7 @@ export class MusicBrainzApi {
     async getSession() {
         const response = await got.get('login', {
             ...this.options,
-            followRedirect: false,
+            followRedirect: false, // Disable redirects
             responseType: 'text'
         });
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.14.0",
+  "version": "0.15.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"
   },
@@ -51,7 +50,7 @@
     "@types/uuid": "^9.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",
@@ -67,14 +66,14 @@
     "@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",
+    "c8": "^9.1.0",
+    "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-jsdoc": "^48.2.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^49.0.0",
     "mocha": "^10.1.0",
@@ -111,5 +110,6 @@
       "text"
     ],
     "report-dir": "coverage"
-  }
+  },
+  "packageManager": "yarn@4.1.1"
 }