musicbrainz-api 0.19.1 → 0.20.0

package/README.md

@@ -308,9 +308,9 @@ Arguments:
   - `query.offset`: optional, return search results starting at a given offset. Used for paging through more than one page of results.
   - `limit.query`: optional, an integer value defining how many entries should be returned. Only values between 1 and 100 (both inclusive) are allowed. If not given, this defaults to 25.
 
-For example, to find any recordings of _'We Will Rock You'_ by Queen:
+For example, to search for _release-group_: _"We Will Rock You"_ by _Queen_:
 ```js
-const query = 'query="We Will Rock You" AND arid:0383dadf-2a4e-4d10-a46a-e9e041da8eb3';
+const query = 'query=artist:"Queen" AND release:"We Will Rock You"';
 const result = await mbApi.search('release-group', {query});
 ```
 

package/lib/coverartarchive-api.js

@@ -1,5 +1,5 @@
 /* eslint-disable-next-line */
-import { HttpClient } from "./httpClient.js";
+import { HttpClient } from "./http-client.js";
 export class CoverArtArchiveApi {
     constructor() {
         this.httpClient = new HttpClient({ baseUrl: 'https://coverartarchive.org', userAgent: 'Node.js musicbrains-api', timeout: 20000 });

package/lib/entry-default.cjs

@@ -0,0 +1,5 @@
+// CommonJS entry point
+"use strict";
+module.exports = {
+  loadMusicBrainzApi: () => import('./entry-default.js'),
+};

package/lib/{index.js → entry-default.js}

@@ -1,3 +1,3 @@
 export * from './coverartarchive-api.js';
 export * from './musicbrainz-api.js';
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=entry-default.js.map

package/lib/entry-node.cjs

@@ -0,0 +1,5 @@
+// Node.js CommonJS entry point
+"use strict";
+module.exports = {
+    loadMusicBrainzApi: () => import('./entry-node.js'),
+};

package/lib/entry-node.d.ts

@@ -0,0 +1,2 @@
+export * from './coverartarchive-api.js';
+export * from './musicbrainz-api-node.js';

package/lib/entry-node.js

@@ -0,0 +1,3 @@
+export * from './coverartarchive-api.js';
+export * from './musicbrainz-api-node.js';
+//# sourceMappingURL=entry-node.js.map

package/lib/http-client-node.d.ts

@@ -0,0 +1,11 @@
+import { type Cookie } from "tough-cookie";
+import { HttpClient, type IHttpClientOptions } from "./http-client.js";
+export type HttpFormData = {
+    [key: string]: string;
+};
+export declare class HttpClientNode extends HttpClient {
+    private cookieJar;
+    constructor(options: IHttpClientOptions);
+    protected registerCookies(response: Response): Promise<Cookie | undefined>;
+    getCookies(): Promise<string | null>;
+}

package/lib/http-client-node.js

@@ -0,0 +1,19 @@
+import { CookieJar } from "tough-cookie";
+import { HttpClient } from "./http-client.js";
+export class HttpClientNode extends HttpClient {
+    constructor(options) {
+        super(options);
+        this.cookieJar = new CookieJar();
+    }
+    registerCookies(response) {
+        const cookie = response.headers.get('set-cookie');
+        if (cookie) {
+            return this.cookieJar.setCookie(cookie, response.url);
+        }
+        return Promise.resolve(undefined);
+    }
+    getCookies() {
+        return this.cookieJar.getCookieString(this.options.baseUrl); // Get cookies for the request
+    }
+}
+//# sourceMappingURL=http-client-node.js.map

package/lib/{httpClient.d.ts → http-client.d.ts}

@@ -1,3 +1,4 @@
+import type { Cookie } from "tough-cookie";
 export type HttpFormData = {
     [key: string]: string;
 };
@@ -14,14 +15,13 @@ export interface IFetchOptions {
     followRedirects?: boolean;
 }
 export declare class HttpClient {
-    private options;
-    private cookieJar;
+    protected options: IHttpClientOptions;
     constructor(options: IHttpClientOptions);
     get(path: string, options?: IFetchOptions): Promise<Response>;
     post(path: string, options?: IFetchOptions): Promise<Response>;
     postForm(path: string, formData: HttpFormData, options?: IFetchOptions): Promise<Response>;
     postJson(path: string, json: Object, options?: IFetchOptions): Promise<Response>;
     private _fetch;
-    private registerCookies;
-    getCookies(): Promise<string>;
+    protected registerCookies(response: Response): Promise<Cookie | undefined>;
+    getCookies(): Promise<string | null>;
 }

package/lib/{httpClient.js → http-client.js}

@@ -1,8 +1,6 @@
-import { CookieJar } from "tough-cookie";
 export class HttpClient {
     constructor(options) {
         this.options = options;
-        this.cookieJar = new CookieJar();
     }
     get(path, options) {
         return this._fetch('get', path, options);
@@ -27,11 +25,11 @@ export class HttpClient {
             url += `?${new URLSearchParams(options.query)}`;
         }
         const cookies = await this.getCookies();
-        const headers = {
-            ...options.headers,
-            'User-Agent': this.options.userAgent,
-            'Cookie': cookies
-        };
+        const headers = new Headers(options.headers);
+        headers.set('User-Agent', this.options.userAgent);
+        if (cookies !== null) {
+            headers.set('Cookie', cookies);
+        }
         const response = await fetch(url, {
             method,
             ...options,
@@ -43,13 +41,10 @@ export class HttpClient {
         return response;
     }
     registerCookies(response) {
-        const cookie = response.headers.get('set-cookie');
-        if (cookie) {
-            return this.cookieJar.setCookie(cookie, response.url);
-        }
+        return Promise.resolve(undefined);
     }
-    getCookies() {
-        return this.cookieJar.getCookieString(this.options.baseUrl); // Get cookies for the request
+    async getCookies() {
+        return Promise.resolve(null);
     }
 }
-//# sourceMappingURL=httpClient.js.map
+//# sourceMappingURL=http-client.js.map

package/lib/musicbrainz-api-node.d.ts

@@ -0,0 +1,16 @@
+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 { HttpClientNode } from "./http-client-node.js";
+import { MusicBrainzApi as MusicBrainzApiDefault } from "./musicbrainz-api.js";
+export * from './musicbrainz.types.js';
+export * from './http-client.js';
+export declare class MusicBrainzApi extends MusicBrainzApiDefault {
+    protected initHttpClient(): HttpClientNode;
+    login(): Promise<boolean>;
+    /**
+     * Logout
+     */
+    logout(): Promise<boolean>;
+}

package/lib/musicbrainz-api-node.js

@@ -0,0 +1,71 @@
+import { StatusCodes as HttpStatus } from 'http-status-codes';
+import Debug from 'debug';
+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 { HttpClientNode } from "./http-client-node.js";
+import { MusicBrainzApi as MusicBrainzApiDefault } from "./musicbrainz-api.js";
+export * from './musicbrainz.types.js';
+export * from './http-client.js';
+/*
+ * https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#Subqueries
+ */
+const debug = Debug('musicbrainz-api-node');
+export class MusicBrainzApi extends MusicBrainzApiDefault {
+    initHttpClient() {
+        return new HttpClientNode({
+            baseUrl: this.config.baseUrl,
+            timeout: 20 * 1000,
+            userAgent: `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
+        });
+    }
+    async login() {
+        if (!this.config.botAccount?.username)
+            throw new Error('bot username should be set');
+        if (!this.config.botAccount?.password)
+            throw new Error('bot password should be set');
+        if (this.session?.loggedIn) {
+            const cookies = await this.httpClient.getCookies();
+            return cookies.indexOf('musicbrainz_server_session') !== -1;
+        }
+        this.session = await this.getSession();
+        const redirectUri = '/success';
+        const formData = {
+            username: this.config.botAccount.username,
+            password: this.config.botAccount.password,
+            csrf_session_key: this.session.csrf.sessionKey,
+            csrf_token: this.session.csrf.token,
+            remember_me: '1'
+        };
+        const response = await this.httpClient.postForm('login', formData, {
+            query: {
+                returnto: redirectUri
+            },
+            followRedirects: false
+        });
+        const success = response.status === HttpStatus.MOVED_TEMPORARILY && response.headers.get('location') === redirectUri;
+        if (success) {
+            this.session.loggedIn = true;
+        }
+        return success;
+    }
+    /**
+     * Logout
+     */
+    async logout() {
+        const redirectUri = '/success';
+        const response = await this.httpClient.post('logout', {
+            followRedirects: false,
+            query: {
+                returnto: redirectUri
+            }
+        });
+        const success = response.status === HttpStatus.MOVED_TEMPORARILY && response.headers.get('location') === redirectUri;
+        if (success && this.session) {
+            this.session.loggedIn = true;
+        }
+        return success;
+    }
+}
+//# sourceMappingURL=musicbrainz-api-node.js.map

package/lib/musicbrainz-api.d.ts

@@ -3,7 +3,9 @@ export { XmlIsrc } from './xml/xml-isrc.js';
 export { XmlIsrcList } from './xml/xml-isrc-list.js';
 export { XmlRecording } from './xml/xml-recording.js';
 import type { XmlMetadata } from './xml/xml-metadata.js';
+import { RateLimitThreshold } from 'rate-limit-threshold';
 import * as mb from './musicbrainz.types.js';
+import { HttpClient } from "./http-client.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';
 export type SubQueryIncludes = 
@@ -76,12 +78,13 @@ export interface ISessionInformation {
 }
 export declare class MusicBrainzApi {
     readonly config: IInternalConfig;
-    private rateLimiter;
-    private httpClient;
-    private session?;
+    protected rateLimiter: RateLimitThreshold;
+    protected httpClient: HttpClient;
+    protected session?: ISessionInformation;
     static fetchCsrf(html: string): ICsrfSession;
     private static fetchValue;
     constructor(_config?: IMusicBrainzConfig);
+    protected initHttpClient(): HttpClient;
     restGet<T>(relUrl: string, query?: {
         [key: string]: string;
     }): Promise<T>;
@@ -140,11 +143,6 @@ export declare class MusicBrainzApi {
     search(artist: 'url', query: mb.ISearchQuery<UrlIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IUrlList>;
     postRecording(xmlMetadata: XmlMetadata): Promise<void>;
     post(entity: mb.EntityType, xmlMetadata: XmlMetadata): Promise<void>;
-    login(): Promise<boolean>;
-    /**
-     * Logout
-     */
-    logout(): Promise<boolean>;
     /**
      * Submit entity
      * @param entity Entity type e.g. 'recording'
@@ -176,7 +174,7 @@ export declare class MusicBrainzApi {
      * @param editNote Comment to add.
      */
     addSpotifyIdToRecording(recording: mb.IRecording, spotifyId: string, editNote: string): Promise<void>;
-    private getSession;
-    private applyRateLimiter;
+    protected getSession(): Promise<ISessionInformation>;
+    protected applyRateLimiter(): Promise<void>;
 }
 export declare function makeAndQueryString(keyValuePairs: IFormData): string;

package/lib/musicbrainz-api.js

@@ -7,7 +7,7 @@ export { XmlRecording } from './xml/xml-recording.js';
 import { DigestAuth } from './digest-auth.js';
 import { RateLimitThreshold } from 'rate-limit-threshold';
 import * as mb from './musicbrainz.types.js';
-import { HttpClient } from "./httpClient.js";
+import { HttpClient } from "./http-client.js";
 export * from './musicbrainz.types.js';
 const debug = Debug('musicbrainz-api');
 export class MusicBrainzApi {
@@ -35,12 +35,15 @@ export class MusicBrainzApi {
             },
             ..._config
         };
-        this.httpClient = new HttpClient({
+        this.httpClient = this.initHttpClient();
+        this.rateLimiter = new RateLimitThreshold(15, 18);
+    }
+    initHttpClient() {
+        return new HttpClient({
             baseUrl: this.config.baseUrl,
             timeout: 20 * 1000,
             userAgent: `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
         });
-        this.rateLimiter = new RateLimitThreshold(15, 18);
     }
     async restGet(relUrl, query = {}) {
         query.fmt = 'json';
@@ -103,53 +106,6 @@ export class MusicBrainzApi {
             }
         } while (n++ < 5);
     }
-    async login() {
-        if (!this.config.botAccount?.username)
-            throw new Error('bot username should be set');
-        if (!this.config.botAccount?.password)
-            throw new Error('bot password should be set');
-        if (this.session?.loggedIn) {
-            const cookies = await this.httpClient.getCookies();
-            return cookies.indexOf('musicbrainz_server_session') !== -1;
-        }
-        this.session = await this.getSession();
-        const redirectUri = '/success';
-        const formData = {
-            username: this.config.botAccount.username,
-            password: this.config.botAccount.password,
-            csrf_session_key: this.session.csrf.sessionKey,
-            csrf_token: this.session.csrf.token,
-            remember_me: '1'
-        };
-        const response = await this.httpClient.postForm('login', formData, {
-            query: {
-                returnto: redirectUri
-            },
-            followRedirects: false
-        });
-        const success = response.status === HttpStatus.MOVED_TEMPORARILY && response.headers.get('location') === redirectUri;
-        if (success) {
-            this.session.loggedIn = true;
-        }
-        return success;
-    }
-    /**
-     * Logout
-     */
-    async logout() {
-        const redirectUri = '/success';
-        const response = await this.httpClient.post('logout', {
-            followRedirects: false,
-            query: {
-                returnto: redirectUri
-            }
-        });
-        const success = response.status === HttpStatus.MOVED_TEMPORARILY && response.headers.get('location') === redirectUri;
-        if (success && this.session) {
-            this.session.loggedIn = true;
-        }
-        return success;
-    }
     /**
      * Submit entity
      * @param entity Entity type e.g. 'recording'

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": {
-    "import": "./lib/index.js",
-    "require": "./lib/default.cjs"
+    "node": {
+      "import": "./lib/entry-node.js",
+      "require": "./lib/entry-node.cjs"
+    },
+    "default": {
+      "import": "./lib/entry-default.js",
+      "require": "./lib/entry-default.cjs"
+    }
   },
   "types": "lib/index.d.ts",
   "files": [
     "lib/**/*.js",
     "lib/**/*.d.ts",
-    "lib/default.cjs"
+    "lib/entry-node.cjs",
+    "lib/entry-default.cjs"
   ],
   "type": "module",
   "author": {
@@ -56,11 +63,11 @@
     "rate-limit-threshold": "^0.2.0",
     "spark-md5": "^3.0.2",
     "tough-cookie": "^5.0.0",
-    "uuid": "^10.0.0"
+    "uuid": "^11.0.3"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.8.3",
-    "@types/chai": "^4.3.0",
+    "@types/chai": "^5.0.0",
     "@types/jsontoxml": "^1.0.5",
     "@types/mocha": "^10.0.4",
     "@types/node": "^22.5.0",
@@ -71,8 +78,8 @@
     "@types/uuid": "^10.0.0",
     "c8": "^10.1.2",
     "chai": "^5.1.1",
-    "del-cli": "^5.1.0",
-    "mocha": "^10.7.3",
+    "del-cli": "^6.0.0",
+    "mocha": "^11.0.1",
     "remark-cli": "^12.0.0",
     "remark-preset-lint-recommended": "^7.0.0",
     "sinon": "^19.0.2",
@@ -109,5 +116,5 @@
     ],
     "report-dir": "coverage"
   },
-  "packageManager": "yarn@4.1.1"
+  "packageManager": "yarn@4.6.0"
 }

package/lib/default.cjs

@@ -1,5 +0,0 @@
-// CommonJS entry point
-"use strict";
-module.exports = {
-  loadMusicBrainzApi: () => import('./index.js'),
-};