musicbrainz-api 0.12.0 → 0.13.0

package/README.md

@@ -34,32 +34,20 @@ If you plan to use this module for submitting metadata, please ensure you comply
 
 ## Example
 
-Import the module
-JavaScript example, how to import 'musicbrainz-api:
-```js
-const MusicBrainzApi = require('musicbrainz-api').MusicBrainzApi;
-
-const mbApi = new MusicBrainzApi({
-  appName: 'my-app',
-  appVersion: '0.1.0',
-  appContactInfo: 'user@mail.org'
-});
-```
-
-In TypeScript it would look like this:
+Example, how to import 'musicbrainz-api:
 ```js
 import {MusicBrainzApi} from 'musicbrainz-api';
 
 const mbApi = new MusicBrainzApi({
   appName: 'my-app',
   appVersion: '0.1.0',
-  appContactInfo: 'user@mail.org' // Or URL to application home page
+  appContactInfo: 'user@mail.org'
 });
 ```
 
 The following configuration settings can be passed 
 ```js
-import {MusicBrainzApi} from '../src/musicbrainz-api';
+import {MusicBrainzApi} from 'musicbrainz-api';
 
 const config = {
   // MusicBrainz bot account username & password (optional)

package/lib/coverartarchive-api.js

@@ -1,14 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoverArtArchiveApi = void 0;
 /* eslint-disable-next-line */
-const got_1 = require("got");
-class CoverArtArchiveApi {
+import got from 'got';
+export class CoverArtArchiveApi {
     constructor() {
         this.host = 'coverartarchive.org';
     }
     async getJson(path) {
-        const response = await got_1.default.get('https://' + this.host + path, {
+        const response = await got.get('https://' + this.host + path, {
             headers: {
                 Accept: `application/json`
             },
@@ -33,5 +30,4 @@ class CoverArtArchiveApi {
         return info;
     }
 }
-exports.CoverArtArchiveApi = CoverArtArchiveApi;
 //# sourceMappingURL=coverartarchive-api.js.map

package/lib/digest-auth.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DigestAuth = void 0;
-const uuid_1 = require("uuid");
-const crypto = require("crypto");
+import { v4 as uuidv4 } from 'uuid';
+import * as crypto from 'crypto';
 function md5(str) {
     return crypto.createHash('md5').update(str).digest('hex'); // lgtm [js/insufficient-password-hash]
 }
-class DigestAuth {
+export class DigestAuth {
     /**
      * RFC 2617: handle both MD5 and MD5-sess algorithms.
      *
@@ -45,7 +42,7 @@ class DigestAuth {
         }
         const qop = /(^|,)\s*auth\s*($|,)/.test(challenge.qop) && 'auth';
         const nc = qop && '00000001';
-        const cnonce = qop && (0, uuid_1.v4)().replace(/-/g, '');
+        const cnonce = qop && uuidv4().replace(/-/g, '');
         const ha1 = DigestAuth.ha1Compute(challenge.algorithm, this.credentials.username, challenge.realm, this.credentials.password, challenge.nonce, cnonce);
         const ha2 = md5(method + ':' + path); // lgtm [js/insufficient-password-hash]
         const digestResponse = qop
@@ -79,5 +76,4 @@ class DigestAuth {
         return authHeader;
     }
 }
-exports.DigestAuth = DigestAuth;
 //# sourceMappingURL=digest-auth.js.map

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,19 +1,3 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./coverartarchive-api"), exports);
-__exportStar(require("./musicbrainz-api"), exports);
+export * from './coverartarchive-api.js';
+export * from './musicbrainz-api.js';
 //# sourceMappingURL=index.js.map

package/lib/musicbrainz-api.d.ts

@@ -1,10 +1,10 @@
-export { XmlMetadata } from './xml/xml-metadata';
-export { XmlIsrc } from './xml/xml-isrc';
-export { XmlIsrcList } from './xml/xml-isrc-list';
-export { XmlRecording } from './xml/xml-recording';
-import { XmlMetadata } from './xml/xml-metadata';
-import * as mb from './musicbrainz.types';
-export * from './musicbrainz.types';
+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 { XmlMetadata } from './xml/xml-metadata.js';
+import * as mb from './musicbrainz.types.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 = 
 /**

package/lib/musicbrainz-api.js

@@ -1,42 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAndQueryString = exports.MusicBrainzApi = exports.XmlRecording = exports.XmlIsrcList = exports.XmlIsrc = exports.XmlMetadata = void 0;
-const assert = require("assert");
-const http_status_codes_1 = require("http-status-codes");
-const Url = require("url");
-const Debug = require("debug");
-var xml_metadata_1 = require("./xml/xml-metadata");
-Object.defineProperty(exports, "XmlMetadata", { enumerable: true, get: function () { return xml_metadata_1.XmlMetadata; } });
-var xml_isrc_1 = require("./xml/xml-isrc");
-Object.defineProperty(exports, "XmlIsrc", { enumerable: true, get: function () { return xml_isrc_1.XmlIsrc; } });
-var xml_isrc_list_1 = require("./xml/xml-isrc-list");
-Object.defineProperty(exports, "XmlIsrcList", { enumerable: true, get: function () { return xml_isrc_list_1.XmlIsrcList; } });
-var xml_recording_1 = require("./xml/xml-recording");
-Object.defineProperty(exports, "XmlRecording", { enumerable: true, get: function () { return xml_recording_1.XmlRecording; } });
-const digest_auth_1 = require("./digest-auth");
-const rate_limiter_1 = require("./rate-limiter");
-const mb = require("./musicbrainz.types");
-/* eslint-disable-next-line */
-const got_1 = require("got");
-const tough_cookie_1 = require("tough-cookie");
-__exportStar(require("./musicbrainz.types"), exports);
-const util_1 = require("util");
+import * as assert from 'assert';
+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 { DigestAuth } from './digest-auth.js';
+import { RateLimiter } from './rate-limiter.js';
+import * as mb from './musicbrainz.types.js';
+import got from 'got';
+import { CookieJar } from 'tough-cookie';
+export * from './musicbrainz.types.js';
+import { promisify } from 'util';
 const debug = Debug('musicbrainz-api');
-class MusicBrainzApi {
+export class MusicBrainzApi {
     static escapeText(text) {
         let str = '';
         for (const chr of text) {
@@ -90,24 +67,32 @@ class MusicBrainzApi {
             botAccount: {}
         };
         Object.assign(this.config, _config);
-        const cookieJar = new tough_cookie_1.CookieJar();
-        this.getCookies = (0, util_1.promisify)(cookieJar.getCookies.bind(cookieJar));
+        const cookieJar = new CookieJar();
+        this.getCookies = promisify(cookieJar.getCookies.bind(cookieJar));
+        // @ts-ignore
         this.options = {
             prefixUrl: this.config.baseUrl,
-            timeout: 20 * 1000,
+            timeout: {
+                read: 20 * 1000
+            },
             headers: {
                 'User-Agent': `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
             },
             cookieJar: cookieJar
         };
-        this.rateLimiter = new rate_limiter_1.RateLimiter(15, 18);
+        this.rateLimiter = new RateLimiter(15, 18);
     }
     async restGet(relUrl, query = {}, attempt = 1) {
         query.fmt = 'json';
         await this.rateLimiter.limit();
-        const response = await got_1.default.get('ws/2' + relUrl, Object.assign(Object.assign({}, this.options), { searchParams: query, responseType: 'json', retry: {
+        const response = await got.get('ws/2' + relUrl, {
+            ...this.options,
+            searchParams: query,
+            responseType: 'json',
+            retry: {
                 limit: 10
-            } }));
+            }
+        });
         return response.body;
     }
     // -----------------------------------------------------------------------------------------------------------------
@@ -346,14 +331,20 @@ class MusicBrainzApi {
         const postData = xmlMetadata.toXml();
         do {
             await this.rateLimiter.limit();
-            const response = await got_1.default.post(path, Object.assign(Object.assign({}, this.options), { searchParams: { client: clientId }, headers: {
+            const response = await got.post(path, {
+                ...this.options,
+                searchParams: { client: clientId },
+                headers: {
                     authorization: digest,
                     'Content-Type': 'application/xml'
-                }, body: postData, throwHttpErrors: false }));
-            if (response.statusCode === http_status_codes_1.StatusCodes.UNAUTHORIZED) {
+                },
+                body: postData,
+                throwHttpErrors: false
+            });
+            if (response.statusCode === HttpStatus.UNAUTHORIZED) {
                 // Respond to digest challenge
-                const auth = new digest_auth_1.DigestAuth(this.config.botAccount);
-                const relPath = Url.parse(response.requestUrl).path; // Ensure path is relative
+                const auth = new DigestAuth(this.config.botAccount);
+                const relPath = response.requestUrl.pathname; // Ensure path is relative
                 digest = auth.digest(response.request.method, relPath, response.headers['www-authenticate']);
                 ++n;
             }
@@ -381,10 +372,15 @@ class MusicBrainzApi {
             csrf_token: this.session.csrf.token,
             remember_me: 1
         };
-        const response = await got_1.default.post('login', Object.assign(Object.assign({}, this.options), { followRedirect: false, searchParams: {
+        const response = await got.post('login', {
+            ...this.options,
+            followRedirect: false,
+            searchParams: {
                 returnto: redirectUri
-            }, form: formData }));
-        const success = response.statusCode === http_status_codes_1.StatusCodes.MOVED_TEMPORARILY && response.headers.location === redirectUri;
+            },
+            form: formData
+        });
+        const success = response.statusCode === HttpStatus.MOVED_TEMPORARILY && response.headers.location === redirectUri;
         if (success) {
             this.session.loggedIn = true;
         }
@@ -395,10 +391,14 @@ class MusicBrainzApi {
      */
     async logout() {
         const redirectUri = '/success';
-        const response = await got_1.default.get('logout', Object.assign(Object.assign({}, this.options), { followRedirect: false, searchParams: {
+        const response = await got.get('logout', {
+            ...this.options,
+            followRedirect: false,
+            searchParams: {
                 returnto: redirectUri
-            } }));
-        const success = response.statusCode === http_status_codes_1.StatusCodes.MOVED_TEMPORARILY && response.headers.location === redirectUri;
+            }
+        });
+        const success = response.statusCode === HttpStatus.MOVED_TEMPORARILY && response.headers.location === redirectUri;
         if (success && this.session) {
             this.session.loggedIn = true;
         }
@@ -418,10 +418,14 @@ class MusicBrainzApi {
         formData.username = this.config.botAccount.username;
         formData.password = this.config.botAccount.password;
         formData.remember_me = 1;
-        const response = await got_1.default.post(`${entity}/${mbid}/edit`, Object.assign(Object.assign({}, this.options), { form: formData, followRedirect: false }));
-        if (response.statusCode === http_status_codes_1.StatusCodes.OK)
+        const response = await got.post(`${entity}/${mbid}/edit`, {
+            ...this.options,
+            form: formData,
+            followRedirect: false
+        });
+        if (response.statusCode === HttpStatus.OK)
             throw new Error(`Failed to submit form data`);
-        if (response.statusCode === http_status_codes_1.StatusCodes.MOVED_TEMPORARILY)
+        if (response.statusCode === HttpStatus.MOVED_TEMPORARILY)
             return;
         throw new Error(`Unexpected status code: ${response.statusCode}`);
     }
@@ -475,7 +479,7 @@ class MusicBrainzApi {
      * @param query Arguments
      */
     search(entity, query) {
-        const urlQuery = Object.assign({}, query);
+        const urlQuery = { ...query };
         if (typeof query.query === 'object') {
             urlQuery.query = makeAndQueryString(query.query);
         }
@@ -517,15 +521,17 @@ class MusicBrainzApi {
         return this.search('url', query);
     }
     async getSession() {
-        const response = await got_1.default.get('login', Object.assign(Object.assign({}, this.options), { followRedirect: false, responseType: 'text' }));
+        const response = await got.get('login', {
+            ...this.options,
+            followRedirect: false,
+            responseType: 'text'
+        });
         return {
             csrf: MusicBrainzApi.fetchCsrf(response.body)
         };
     }
 }
-exports.MusicBrainzApi = MusicBrainzApi;
-function makeAndQueryString(keyValuePairs) {
+export function makeAndQueryString(keyValuePairs) {
     return Object.keys(keyValuePairs).map(key => `${key}:"${keyValuePairs[key]}"`).join(' AND ');
 }
-exports.makeAndQueryString = makeAndQueryString;
 //# sourceMappingURL=musicbrainz-api.js.map

package/lib/musicbrainz.types.d.ts

@@ -1,5 +1,5 @@
 import DateTimeFormat = Intl.DateTimeFormat;
-import { IFormData } from './musicbrainz-api';
+import type { IFormData } from './musicbrainz-api.js';
 export interface IPeriod {
     'begin': string;
     'ended': boolean;

package/lib/musicbrainz.types.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LinkType = void 0;
-var LinkType;
+export var LinkType;
 (function (LinkType) {
     LinkType[LinkType["license"] = 302] = "license";
     LinkType[LinkType["production"] = 256] = "production";
@@ -13,5 +10,5 @@ var LinkType;
     LinkType[LinkType["crowdfunding_page"] = 905] = "crowdfunding_page";
     LinkType[LinkType["other_databases"] = 306] = "other_databases";
     LinkType[LinkType["Allmusic"] = 285] = "Allmusic";
-})(LinkType = exports.LinkType || (exports.LinkType = {}));
+})(LinkType = LinkType || (LinkType = {}));
 //# sourceMappingURL=musicbrainz.types.js.map

package/lib/rate-limiter.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RateLimiter = void 0;
-const debug_1 = require("debug");
-const debug = (0, debug_1.default)('musicbrainz-api:rate-limiter');
-class RateLimiter {
+import Debug from 'debug';
+const debug = Debug('musicbrainz-api:rate-limiter');
+export class RateLimiter {
     static sleep(ms) {
         return new Promise(resolve => setTimeout(resolve, ms));
     }
@@ -30,5 +27,4 @@ class RateLimiter {
         // const ratePerSec = 1000 * this.queue.length / (now - this.queue[0]);
     }
 }
-exports.RateLimiter = RateLimiter;
 //# sourceMappingURL=rate-limiter.js.map

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

@@ -1,4 +1,4 @@
-import { XmlIsrc } from './xml-isrc';
+import { XmlIsrc } from './xml-isrc.js';
 export declare class XmlIsrcList {
     items: XmlIsrc[];
     pushIsrc(isrc: string): void;

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

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XmlIsrcList = void 0;
-const xml_isrc_1 = require("./xml-isrc");
-class XmlIsrcList {
+import { XmlIsrc } from './xml-isrc.js';
+export class XmlIsrcList {
     constructor() {
         this.items = [];
     }
     pushIsrc(isrc) {
-        this.items.push(new xml_isrc_1.XmlIsrc(isrc));
+        this.items.push(new XmlIsrc(isrc));
     }
     toXml() {
         return this.items.length === 0 ? null : {
@@ -19,5 +16,4 @@ class XmlIsrcList {
         };
     }
 }
-exports.XmlIsrcList = XmlIsrcList;
 //# sourceMappingURL=xml-isrc-list.js.map

package/lib/xml/xml-isrc.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XmlIsrc = void 0;
-class XmlIsrc {
+export class XmlIsrc {
     constructor(isrc) {
         this.isrc = isrc;
     }
@@ -14,5 +11,4 @@ class XmlIsrc {
         };
     }
 }
-exports.XmlIsrc = XmlIsrc;
 //# sourceMappingURL=xml-isrc.js.map

package/lib/xml/xml-metadata.d.ts

@@ -1,4 +1,4 @@
-import { XmlRecording } from './xml-recording';
+import { XmlRecording } from './xml-recording.js';
 export declare class XmlMetadata {
     recordings: XmlRecording[];
     pushRecording(id: string): XmlRecording;

package/lib/xml/xml-metadata.js

@@ -1,16 +1,13 @@
-"use strict";
 // https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#ISRC_submission
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XmlMetadata = void 0;
-const jsontoxml = require("jsontoxml");
-const xml_recording_1 = require("./xml-recording");
+import jsontoxml from 'jsontoxml';
+import { XmlRecording } from './xml-recording.js';
 const ns_metadata = 'http://musicbrainz.org/ns/mmd-2.0#';
-class XmlMetadata {
+export class XmlMetadata {
     constructor() {
         this.recordings = [];
     }
     pushRecording(id) {
-        const rec = new xml_recording_1.XmlRecording(id);
+        const rec = new XmlRecording(id);
         this.recordings.push(rec);
         return rec;
     }
@@ -26,5 +23,4 @@ class XmlMetadata {
             }], { prettyPrint: false, escape: true, xmlHeader: true });
     }
 }
-exports.XmlMetadata = XmlMetadata;
 //# sourceMappingURL=xml-metadata.js.map

package/lib/xml/xml-recording.d.ts

@@ -1,4 +1,4 @@
-import { XmlIsrcList } from './xml-isrc-list';
+import { XmlIsrcList } from './xml-isrc-list.js';
 export declare class XmlRecording {
     id: string;
     isrcList: XmlIsrcList;

package/lib/xml/xml-recording.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XmlRecording = void 0;
-const xml_isrc_list_1 = require("./xml-isrc-list");
-class XmlRecording {
+import { XmlIsrcList } from './xml-isrc-list.js';
+export class XmlRecording {
     constructor(id) {
         this.id = id;
-        this.isrcList = new xml_isrc_list_1.XmlIsrcList();
+        this.isrcList = new XmlIsrcList();
     }
     toXml() {
         return {
@@ -17,5 +14,4 @@ class XmlRecording {
         };
     }
 }
-exports.XmlRecording = XmlRecording;
 //# sourceMappingURL=xml-recording.js.map

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
-  "main": "lib/index",
-  "types": "lib/index",
+  "exports": "./lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts"
+  ],
+  "type": "module",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -31,7 +36,7 @@
   "license": "MIT",
   "private": false,
   "engines": {
-    "node": "*"
+    "node": "^14.13.1 || >=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -45,8 +50,8 @@
     "@types/request-promise-native": "^1.0.17",
     "@types/uuid": "^9.0.0",
     "caseless": "^0.12.0",
-    "debug": "^4.1.1",
-    "got": "^11.8.5",
+    "debug": "^4.3.4",
+    "got": "^13.0.0",
     "http-status-codes": "^2.1.4",
     "json-stringify-safe": "^5.0.1",
     "jsontoxml": "^1.0.1",
@@ -61,6 +66,7 @@
     "@types/node": "^20.8.10",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
+    "c8": "^8.0.1",
     "chai": "^4.2.0",
     "del-cli": "^5.0.0",
     "eslint": "^8.10.0",
@@ -70,18 +76,13 @@
     "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^46.0.0",
-    "mocha": "^9.0.1",
-    "nyc": "^15.0.0",
+    "mocha": "^10.1.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"
   },
-  "files": [
-    "lib/**/*.js",
-    "lib/**/*.d.ts"
-  ],
   "scripts": {
     "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.js test/**/*.js.map",
     "compile-lib": "tsc -p lib",
@@ -90,10 +91,10 @@
     "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",
+    "test": "mocha",
     "build": "npm run clean && npm run compile",
     "start": "npm-run-all compile lint cover-test",
-    "test-coverage": "nyc npm run test",
+    "test-coverage": "c8 npm run test",
     "send-codacy": "nyc report --reporter=text-lcov | codacy-coverage"
   },
   "nyc": {