musicbrainz-api 1.0.0 → 1.1.0

package/README.md

@@ -90,7 +90,7 @@ const config = {
     // Required: Application details
     appName: 'my-app',
     appVersion: '0.1.0',
-    appMail: 'user@mail.org',
+    appContactInfo: 'user@mail.org',
 
     // Optional: Proxy settings (default: no proxy server)
     proxy: {

package/lib/http-client.js

@@ -1,5 +1,5 @@
 import Debug from "debug";
-const debug = Debug('musicbrainz-api-node');
+const debug = Debug('musicbrainz-api:http-client');
 function isConnectionReset(err) {
     // Undici puts the OS error on .cause, with .code like 'ECONNRESET'
     const code = err?.cause?.code ?? err?.code;
@@ -18,7 +18,11 @@ export class HttpClient {
     }
     postForm(path, formData, options) {
         const encodedFormData = new URLSearchParams(formData).toString();
-        return this._fetch('post', path, { ...options, body: encodedFormData, headers: { 'Content-Type': 'application/x-www-form-urlencoded' } });
+        return this._fetch('post', path, {
+            ...options,
+            body: encodedFormData,
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
+        });
     }
     postJson(path, json, options) {
         const encodedJson = JSON.stringify(json);
@@ -63,6 +67,7 @@ export class HttpClient {
                     continue;
                 }
             }
+            debug(`Received status=${response.status}`);
             await this.registerCookies(response);
             return response;
         }

package/lib/musicbrainz-api.d.ts

@@ -87,6 +87,18 @@ export interface ISessionInformation {
     csrf: ICsrfSession;
     loggedIn?: boolean;
 }
+export declare class MusicBrainzApiError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    readonly body?: unknown;
+    readonly url?: string;
+    constructor(message: string, opts: {
+        status: number;
+        statusText: string;
+        body?: unknown;
+        url?: string;
+    });
+}
 export declare class MusicBrainzApi {
     readonly config: IInternalConfig;
     protected rateLimiter: RateLimitThreshold;

package/lib/musicbrainz-api.js

@@ -10,6 +10,25 @@ export { XmlIsrcList } from './xml/xml-isrc-list.js';
 export { XmlRecording } from './xml/xml-recording.js';
 export * from './musicbrainz.types.js';
 const debug = Debug('musicbrainz-api');
+async function safeJson(res) {
+    // Some responses might not be JSON, or the client may have already consumed the body.
+    try {
+        return await res.json();
+    }
+    catch {
+        return undefined;
+    }
+}
+export class MusicBrainzApiError extends Error {
+    constructor(message, opts) {
+        super(message);
+        this.name = "MusicBrainzApiError";
+        this.status = opts.status;
+        this.statusText = opts.statusText;
+        this.body = opts.body;
+        this.url = opts.url;
+    }
+}
 export class MusicBrainzApi {
     static fetchCsrf(html) {
         return {
@@ -53,6 +72,20 @@ export class MusicBrainzApi {
             query,
             retryLimit: 10
         });
+        if (response.status === 400) {
+            const body = await safeJson(response);
+            const mb = (body ?? {});
+            // Prefer the API-provided message when available.
+            const message = mb.error
+                ? `MusicBrainz request failed (${response.status}): ${mb.error}`
+                : `MusicBrainz request failed (${response.status}): ${response.statusText}`;
+            throw new MusicBrainzApiError(message, {
+                status: response.status,
+                statusText: response.statusText,
+                body,
+                url: response.url,
+            });
+        }
         return response.json();
     }
     lookup(entity, mbid, inc = []) {
@@ -83,7 +116,7 @@ export class MusicBrainzApi {
         }
         return this.restGet(`/${entity}`, query);
     }
-    search(entity, query) {
+    async search(entity, query) {
         const urlQuery = { ...query };
         if (typeof query.query === 'object') {
             urlQuery.query = makeAndQueryString(query.query);
@@ -91,7 +124,20 @@ export class MusicBrainzApi {
         if (Array.isArray(query.inc)) {
             urlQuery.inc = urlQuery.inc.join(' ');
         }
-        return this.restGet(`/${entity}/`, urlQuery);
+        const result = await this.restGet(`/${entity}/`, urlQuery);
+        // Temporary workaround for https://tickets.metabrainz.org/browse/SEARCH-444
+        // Should be resolved by https://github.com/metabrainz/mb-solr/pull/69
+        if (entity === 'url') {
+            // @ts-expect-error
+            result.urls.forEach(url => {
+                // @ts-expect-error
+                if (!url.relations && url['relation-list']) {
+                    // @ts-expect-error
+                    url.relations = url['relation-list'];
+                }
+            });
+        }
+        return result;
     }
     // ---------------------------------------------------------------------------
     async postRecording(xmlMetadata) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": {
     "node": {
@@ -61,7 +61,7 @@
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.3.11",
+    "@biomejs/biome": "2.3.14",
     "@types/chai": "^5.0.0",
     "@types/jsontoxml": "^1.0.5",
     "@types/mocha": "^10.0.4",