musicbrainz-api 0.16.0 → 0.17.0

package/README.md

@@ -69,7 +69,10 @@ const config = {
    },
 
   // Your e-mail address, required for submitting ISRCs
-  appMail: string
+  appMail: string,
+
+  // Helpful if you have your own MusicBrainz server, default: false (optional)
+  disableRateLimiting: false,
 }
 
 const mbApi = new MusicbrainzApi(config);

package/lib/musicbrainz-api.d.ts

@@ -61,6 +61,7 @@ export interface IMusicBrainzConfig {
      * User e-mail address or application URL
      */
     appContactInfo?: string;
+    disableRateLimiting?: boolean;
 }
 export interface ICsrfSession {
     sessionKey: string;
@@ -174,5 +175,6 @@ export declare class MusicBrainzApi {
      */
     addSpotifyIdToRecording(recording: mb.IRecording, spotifyId: string, editNote: string): Promise<void>;
     private getSession;
+    private applyRateLimiter;
 }
 export declare function makeAndQueryString(keyValuePairs: IFormData): string;

package/lib/musicbrainz-api.js

@@ -53,8 +53,7 @@ export class MusicBrainzApi {
     }
     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...`);
+        await this.applyRateLimiter();
         const response = await got.get(`ws/2${relUrl}`, {
             ...this.options,
             searchParams: query,
@@ -96,7 +95,7 @@ export class MusicBrainzApi {
         let n = 1;
         const postData = xmlMetadata.toXml();
         do {
-            await this.rateLimiter.limit();
+            await this.applyRateLimiter();
             const response = await got.post(path, {
                 ...this.options,
                 searchParams: { client: clientId },
@@ -179,7 +178,7 @@ export class MusicBrainzApi {
      */
     async editEntity(entity, mbid, formData) {
         var _a, _b;
-        await this.rateLimiter.limit();
+        await this.applyRateLimiter();
         this.session = await this.getSession();
         formData.csrf_session_key = this.session.csrf.sessionKey;
         formData.csrf_token = this.session.csrf.token;
@@ -263,6 +262,12 @@ export class MusicBrainzApi {
             csrf: MusicBrainzApi.fetchCsrf(response.body)
         };
     }
+    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...`);
+        }
+    }
 }
 export function makeAndQueryString(keyValuePairs) {
     return Object.keys(keyValuePairs).map(key => `${key}:"${keyValuePairs[key]}"`).join(' AND ');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": "./lib/index.js",
   "types": "lib/index.d.ts",
@@ -65,12 +65,14 @@
     "@types/jsontoxml": "^1.0.5",
     "@types/mocha": "^10.0.4",
     "@types/node": "^22.1.0",
+    "@types/sinon": "^17.0.3",
     "c8": "^10.1.2",
     "chai": "^5.1.0",
     "del-cli": "^5.0.0",
     "mocha": "^10.1.0",
     "remark-cli": "^12.0.0",
     "remark-preset-lint-recommended": "^7.0.0",
+    "sinon": "^18.0.0",
     "ts-node": "^10.0.0",
     "typescript": "^5.0.2"
   },