musicbrainz-api 0.10.1 → 0.10.3

package/lib/rate-limiter.ts

@@ -0,0 +1,34 @@
+import * as Debug from 'debug';
+
+const debug = Debug('musicbrainz-api:rate-limiter');
+
+export class RateLimiter {
+
+  public static sleep(ms): Promise<void> {
+    return new Promise(resolve => setTimeout(resolve, ms));
+  }
+
+  public queue: number[] = [];
+  private readonly period: number;
+
+  public constructor(period: number, private maxCalls: number) {
+    this.period = 1000 * period;
+  }
+
+  public async limit(): Promise<void> {
+    let now = new Date().getTime();
+    const t0 = now - (this.period);
+    while (this.queue.length > 0 && this.queue[0] < t0) {
+      this.queue.shift();
+    }
+    if (this.queue.length >= this.maxCalls) {
+      const delay = this.queue[0] + this.period - now;
+      debug(`Client side rate limiter activated: cool down for ${delay / 1000} s...`);
+      return RateLimiter.sleep(delay);
+    }
+    now = new Date().getTime();
+    this.queue.push(now);
+    // const ratePerSec = 1000 * this.queue.length / (now - this.queue[0]);
+  }
+
+}

package/lib/xml/xml-isrc-list.ts

@@ -0,0 +1,20 @@
+import { XmlIsrc } from './xml-isrc';
+
+export class XmlIsrcList {
+
+  public items: XmlIsrc[] = [];
+
+  public pushIsrc(isrc: string) {
+    this.items.push(new XmlIsrc(isrc));
+  }
+
+  public toXml() {
+    return this.items.length === 0 ? null : {
+      name: 'isrc-list',
+      attrs: {
+        count: this.items.length
+      },
+      children: this.items.map(isrc => isrc.toXml())
+    };
+  }
+}

package/lib/xml/xml-isrc.ts

@@ -0,0 +1,15 @@
+
+export class XmlIsrc {
+
+  public constructor(public isrc: string) {
+  }
+
+  public toXml() {
+    return {
+      name: 'isrc',
+      attrs: {
+        id: this.isrc
+      }
+    };
+  }
+}

package/lib/xml/xml-metadata.ts

@@ -0,0 +1,30 @@
+// https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#ISRC_submission
+
+import * as jsontoxml from 'jsontoxml';
+import { XmlRecording } from './xml-recording';
+
+const ns_metadata = 'http://musicbrainz.org/ns/mmd-2.0#';
+
+export class XmlMetadata {
+
+  public recordings: XmlRecording[] = [];
+
+  public pushRecording(id: string): XmlRecording {
+    const rec = new XmlRecording(id);
+    this.recordings.push(rec);
+    return rec;
+  }
+
+  public toXml(): string {
+
+    return jsontoxml([{
+      name: 'metadata',
+      attrs: {
+        xmlns: ns_metadata
+      },
+      children: [{
+        'recording-list': this.recordings.map(rec => rec.toXml())
+      }]
+    }], {prettyPrint: false, escape: true, xmlHeader: true});
+  }
+}

package/lib/xml/xml-recording.ts

@@ -0,0 +1,19 @@
+import { XmlIsrcList } from './xml-isrc-list';
+
+export class XmlRecording {
+
+  public isrcList: XmlIsrcList = new XmlIsrcList();
+
+  public constructor(public id: string) {
+  }
+
+  public toXml() {
+    return {
+      name: 'recording',
+      attrs: {
+        id: this.id
+      },
+      children: [this.isrcList.toXml()]
+    };
+  }
+}

package/package.json

@@ -1,104 +1,103 @@
-{
-  "name": "musicbrainz-api",
-  "version": "0.10.1",
-  "description": "MusicBrainz API client for reading and submitting metadata",
-  "main": "lib/musicbrainz-api",
-  "types": "lib/musicbrainz-api",
-  "author": {
-    "name": "Borewit",
-    "url": "https://github.com/Borewit"
-  },
-  "keywords": [
-    "MusicBrainz",
-    "metadata",
-    "meta",
-    "tag",
-    "tags",
-    "Picard",
-    "json",
-    "xml",
-    "web",
-    "service",
-    "submit",
-    "metabrainz"
-  ],
-  "license": "MIT",
-  "private": false,
-  "engines": {
-    "node": "*"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Borewit/musicbrainz-api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Borewit/musicbrainz-api/issues"
-  },
-  "dependencies": {
-    "@types/caseless": "^0.12.1",
-    "@types/request-promise-native": "^1.0.17",
-    "@types/uuid": "^8.3.0",
-    "caseless": "^0.12.0",
-    "debug": "^4.1.1",
-    "got": "^11.8.5",
-    "http-status-codes": "^2.1.4",
-    "json-stringify-safe": "^5.0.1",
-    "jsontoxml": "^1.0.1",
-    "source-map-support": "^0.5.16",
-    "tough-cookie": "^4.0.0",
-    "uuid": "^9.0.0"
-  },
-  "devDependencies": {
-    "@types/chai": "^4.3.0",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "^5.13.0",
-    "@typescript-eslint/parser": "^5.13.0",
-    "chai": "^4.2.0",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.10.0",
-    "eslint-config-prettier": "^8.4.0",
-    "eslint-import-resolver-typescript": "^3.3.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^39.3.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^44.0.2",
-    "mocha": "^9.0.1",
-    "nyc": "^15.0.0",
-    "remark-cli": "^11.0.0",
-    "remark-preset-lint-recommended": "^6.1.2",
-    "ts-node": "^10.0.0",
-    "tslint": "^6.1.1",
-    "typescript": "^4.0.2"
-  },
-  "scripts": {
-    "clean": "del-cli src/**/*.js src/**/*.js.map src/**/*.d.ts test/**/*.js test/**/*.js.map",
-    "compile-src": "tsc -p src",
-    "compile-test": "tsc -p test",
-    "compile": "npm run compile-src && npm run compile-test",
-    "eslint": "eslint src/**/*.ts --ignore-pattern src/**/*.d.ts test/**/*.ts",
-    "lint-md": "remark -u preset-lint-recommended .",
-    "lint": "npm run lint-md && npm run eslint",
-    "test": "mocha --require ts-node/register --require source-map-support/register --full-trace test/test-*.ts",
-    "build": "npm run clean && npm run compile",
-    "start": "npm-run-all compile lint cover-test",
-    "test-coverage": "nyc npm run test",
-    "send-codacy": "nyc report --reporter=text-lcov | codacy-coverage"
-  },
-  "nyc": {
-    "exclude": [
-      "test/**/*.ts",
-      "src/**/*.js"
-    ],
-    "extension": [
-      ".ts"
-    ],
-    "sourceMap": true,
-    "instrument": true,
-    "reporter": [
-      "lcov",
-      "text"
-    ],
-    "report-dir": "coverage"
-  }
-}
+{
+  "name": "musicbrainz-api",
+  "version": "0.10.3",
+  "description": "MusicBrainz API client for reading and submitting metadata",
+  "main": "lib/musicbrainz-api",
+  "types": "lib/musicbrainz-api",
+  "author": {
+    "name": "Borewit",
+    "url": "https://github.com/Borewit"
+  },
+  "keywords": [
+    "MusicBrainz",
+    "metadata",
+    "meta",
+    "tag",
+    "tags",
+    "Picard",
+    "json",
+    "xml",
+    "web",
+    "service",
+    "submit",
+    "metabrainz"
+  ],
+  "license": "MIT",
+  "private": false,
+  "engines": {
+    "node": "*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Borewit/musicbrainz-api.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Borewit/musicbrainz-api/issues"
+  },
+  "dependencies": {
+    "@types/caseless": "^0.12.1",
+    "@types/request-promise-native": "^1.0.17",
+    "@types/uuid": "^9.0.0",
+    "caseless": "^0.12.0",
+    "debug": "^4.1.1",
+    "got": "^11.8.5",
+    "http-status-codes": "^2.1.4",
+    "json-stringify-safe": "^5.0.1",
+    "jsontoxml": "^1.0.1",
+    "source-map-support": "^0.5.16",
+    "tough-cookie": "^4.0.0",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^18.6.1",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "chai": "^4.2.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.4.0",
+    "eslint-import-resolver-typescript": "^3.3.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^40.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^46.0.0",
+    "mocha": "^9.0.1",
+    "nyc": "^15.0.0",
+    "remark-cli": "^11.0.0",
+    "remark-preset-lint-recommended": "^6.1.2",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.1",
+    "typescript": "^5.0.2"
+  },
+  "scripts": {
+    "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.js test/**/*.js.map",
+    "compile-lib": "tsc -p lib",
+    "compile-test": "tsc -p test",
+    "compile": "npm run compile-lib && npm run compile-test",
+    "eslint": "eslint lib/**/*.ts --ignore-pattern lib/**/*.d.ts test/**/*.ts",
+    "lint-md": "remark -u preset-lint-recommended .",
+    "lint": "npm run lint-md && npm run eslint",
+    "test": "mocha --require ts-node/register --require source-map-support/register --full-trace test/test-*.ts",
+    "build": "npm run clean && npm run compile",
+    "start": "npm-run-all compile lint cover-test",
+    "test-coverage": "nyc npm run test",
+    "send-codacy": "nyc report --reporter=text-lcov | codacy-coverage"
+  },
+  "nyc": {
+    "exclude": [
+      "test/**/*.ts"
+    ],
+    "extension": [
+      ".ts"
+    ],
+    "sourceMap": true,
+    "instrument": true,
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "report-dir": "coverage"
+  }
+}

package/.idea/$CACHE_FILE$

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="NodePackageJsonFileManager">
-    <packageJsonPaths />
-  </component>
-</project>

package/.idea/$PRODUCT_WORKSPACE_FILE$

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="masterDetails">
-    <states>
-      <state key="ProjectJDKs.UI">
-        <settings>
-          <last-edited>1.8</last-edited>
-          <splitter-proportions>
-            <option name="proportions">
-              <list>
-                <option value="0.2" />
-              </list>
-            </option>
-          </splitter-proportions>
-        </settings>
-      </state>
-    </states>
-  </component>
-</project>

package/.idea/jpa-buddy.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JpaBuddyIdeaProjectConfig">
-    <option name="renamerInitialized" value="true" />
-  </component>
-</project>