Improve browser support

lib/coverartarchive-api.ts

@@ -1,5 +1,5 @@
 /* eslint-disable-next-line */
-import {HttpClient} from "./httpClient.js";
+import {HttpClient} from "./http-client.js";
 
 export type CovertType = 'Front' | 'Back' | 'Booklet' | 'Medium' | 'Obi' | 'Spine' | 'Track' | 'Tray' | 'Sticker' |
 'Poster' | 'Liner' | 'Watermark' | 'Raw/Unedited' | 'Matrix/Runout' | 'Top' | 'Bottom' | 'Other';

lib/default.cjs → lib/entry-default.cjs

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

lib/entry-node.cjs

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

lib/entry-node.ts

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

lib/http-client-node.ts

@@ -0,0 +1,27 @@
+import {type Cookie, CookieJar} from "tough-cookie";
+import {HttpClient, type IHttpClientOptions} from "./http-client.js";
+
+export type HttpFormData = { [key: string]: string; }
+
+export class HttpClientNode extends HttpClient {
+
+  private cookieJar: CookieJar;
+
+  public constructor(options: IHttpClientOptions) {
+    super(options);
+    this.cookieJar = new CookieJar();
+  }
+
+  protected registerCookies(response: Response): Promise<Cookie | undefined> {
+    const cookie = response.headers.get('set-cookie');
+    if (cookie) {
+      return this.cookieJar.setCookie(cookie, response.url);
+    }
+    return Promise.resolve(undefined);
+  }
+
+  public getCookies(): Promise<string | null> {
+    return this.cookieJar.getCookieString(this.options.baseUrl); // Get cookies for the request
+  }
+
+}

lib/httpClient.ts → lib/http-client.ts

@@ -1,4 +1,4 @@
-import {CookieJar} from "tough-cookie";
+import type {Cookie} from "tough-cookie";
 
 export type HttpFormData = { [key: string]: string; }
 
@@ -18,10 +18,7 @@ export interface IFetchOptions {
 
 export class HttpClient {
 
-  private cookieJar: CookieJar;
-
-  public constructor(private options: IHttpClientOptions) {
-    this.cookieJar = new CookieJar();
+  public constructor(protected options: IHttpClientOptions) {
   }
 
   public get(path: string, options?: IFetchOptions): Promise<Response> {
@@ -54,11 +51,11 @@ export class HttpClient {
 
     const cookies = await this.getCookies();
 
-    const headers: HeadersInit = {
-      ...options.headers,
-      'User-Agent': this.options.userAgent,
-      'Cookie': cookies
-    };
+    const headers: HeadersInit = new Headers(options.headers);
+    headers.set('User-Agent', this.options.userAgent);
+    if (cookies !== null) {
+      headers.set('Cookie', cookies);
+    }
 
     const response = await fetch(url, {
       method,
@@ -71,15 +68,12 @@ export class HttpClient {
     return response;
   }
 
-  private registerCookies(response: Response) {
-    const cookie = response.headers.get('set-cookie');
-    if (cookie) {
-      return this.cookieJar.setCookie(cookie, response.url);
-    }
+  protected registerCookies(response: Response): Promise<Cookie | undefined> {
+    return Promise.resolve(undefined);
   }
 
-  public getCookies(): Promise<string> {
-    return this.cookieJar.getCookieString(this.options.baseUrl); // Get cookies for the request
+  public async getCookies(): Promise<string | null> {
+    return Promise.resolve(null);
   }
 
 }

lib/musicbrainz-api-node.ts

@@ -0,0 +1,84 @@
+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, type HttpFormData} 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 {
+
+  protected initHttpClient(): HttpClientNode {
+    return new HttpClientNode({
+      baseUrl: this.config.baseUrl,
+      timeout: 20 * 1000,
+      userAgent: `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
+    });
+  }
+
+  public async login(): Promise<boolean> {
+
+    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() as string;
+      return cookies.indexOf('musicbrainz_server_session') !== -1;
+    }
+    this.session = await this.getSession();
+
+    const redirectUri = '/success';
+
+    const formData: HttpFormData = {
+      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
+   */
+  public async logout(): Promise<boolean> {
+    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;
+  }
+
+}

lib/musicbrainz-api.ts

@@ -11,7 +11,7 @@ import { DigestAuth } from './digest-auth.js';
 
 import { RateLimitThreshold } from 'rate-limit-threshold';
 import * as mb from './musicbrainz.types.js';
-import {HttpClient, type HttpFormData} from "./httpClient.js";
+import {HttpClient} from "./http-client.js";
 
 export * from './musicbrainz.types.js';
 
@@ -167,9 +167,9 @@ export class MusicBrainzApi {
 
   public readonly config: IInternalConfig;
 
-  private rateLimiter: RateLimitThreshold;
-  private httpClient: HttpClient;
-  private session?: ISessionInformation;
+  protected rateLimiter: RateLimitThreshold;
+  protected httpClient: HttpClient;
+  protected session?: ISessionInformation;
 
   public static fetchCsrf(html: string): ICsrfSession {
     return {
@@ -199,13 +199,17 @@ export class MusicBrainzApi {
       ..._config
     }
 
-    this.httpClient = new HttpClient({
+    this.httpClient = this.initHttpClient();
+
+    this.rateLimiter = new RateLimitThreshold(15, 18);
+  }
+
+  protected initHttpClient(): HttpClient {
+    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);
   }
 
   public async restGet<T>(relUrl: string, query: { [key: string]: string; } = {}): Promise<T> {
@@ -341,60 +345,6 @@ export class MusicBrainzApi {
     } while (n++ < 5);
   }
 
-  public async login(): Promise<boolean> {
-
-    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: HttpFormData = {
-      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
-   */
-  public async logout(): Promise<boolean> {
-    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'
@@ -498,7 +448,7 @@ export class MusicBrainzApi {
     }, editNote);
   }
 
-  private async getSession(): Promise<ISessionInformation> {
+  protected async getSession(): Promise<ISessionInformation> {
 
     const response = await this.httpClient.get('login', {
       followRedirects: false
@@ -508,7 +458,7 @@ export class MusicBrainzApi {
     };
   }
 
-  private async applyRateLimiter() {
+  protected 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...`);

package.json

@@ -3,14 +3,21 @@
   "version": "0.19.1",
   "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": {