musicbrainz-api 0.10.3 → 0.11.0

package/README.md

@@ -25,7 +25,7 @@ We are looking into making this package usable in the browser as well.
 
 ## Before using this library
 
-MusicBrainz asks that you [identifying your application](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2#User%20Data) by filling in the ['User-Agent' Header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent).
+MusicBrainz asks that you to [identify your application](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2#User%20Data) by filling in the ['User-Agent' Header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent).
 By passing `appName`, `appVersion`, `appMail` musicbrainz-api takes care of that.
 
 ## Submitting metadata

package/lib/digest-auth.d.ts

@@ -12,10 +12,10 @@ export declare class DigestAuth {
      * If the algorithm directive's value is "MD5-sess", then HA1 is
      *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
      */
-    static ha1Compute(algorithm: any, user: any, realm: any, pass: any, nonce: any, cnonce: any): string;
+    static ha1Compute(algorithm: string, user: string, realm: string, pass: string, nonce: string, cnonce: string): string;
     hasAuth: boolean;
     sentAuth: boolean;
-    bearerToken: string;
+    bearerToken: string | null;
     constructor(credentials: ICredentials);
     digest(method: string, path: string, authHeader: string): string;
 }

package/lib/digest-auth.js

@@ -64,16 +64,16 @@ class DigestAuth {
             opaque: challenge.opaque
         };
         const parts = [];
-        for (const k in authValues) {
-            if (authValues[k]) {
-                if (k === 'qop' || k === 'nc' || k === 'algorithm') {
-                    parts.push(k + '=' + authValues[k]);
+        Object.entries(authValues).forEach(([key, value]) => {
+            if (value) {
+                if (key === 'qop' || key === 'nc' || key === 'algorithm') {
+                    parts.push(key + '=' + value);
                 }
                 else {
-                    parts.push(k + '="' + authValues[k] + '"');
+                    parts.push(key + '="' + value + '"');
                 }
             }
-        }
+        });
         authHeader = 'Digest ' + parts.join(', ');
         this.sentAuth = true;
         return authHeader;

package/lib/musicbrainz-api.d.ts

@@ -42,13 +42,13 @@ export type ReleaseGroupIncludes = MiscIncludes | SubQueryIncludes | RelationsIn
 export type SeriesIncludes = MiscIncludes | RelationsIncludes;
 export type WorkIncludes = MiscIncludes | RelationsIncludes;
 export type UrlIncludes = RelationsIncludes;
-export interface IFormData {
+export type IFormData = {
     [key: string]: string | number;
-}
+};
 export interface IMusicBrainzConfig {
-    botAccount?: {
-        username: string;
-        password: string;
+    botAccount: {
+        username?: string;
+        password?: string;
     };
     baseUrl?: string;
     appName?: string;
@@ -62,11 +62,12 @@ export interface IMusicBrainzConfig {
      */
     appContactInfo?: string;
 }
+export interface ICsrfSession {
+    sessionKey: string;
+    token: string;
+}
 export interface ISessionInformation {
-    csrf: {
-        sessionKey: string;
-        token: string;
-    };
+    csrf: ICsrfSession;
     loggedIn?: boolean;
 }
 export declare class MusicBrainzApi {
@@ -74,11 +75,8 @@ export declare class MusicBrainzApi {
     readonly config: IMusicBrainzConfig;
     private rateLimiter;
     private options;
-    private session;
-    static fetchCsrf(html: string): {
-        sessionKey: string;
-        token: string;
-    };
+    private session?;
+    static fetchCsrf(html: string): ICsrfSession;
     private static fetchValue;
     private getCookies;
     constructor(_config?: IMusicBrainzConfig);

package/lib/musicbrainz-api.js

@@ -30,8 +30,9 @@ Object.defineProperty(exports, "XmlRecording", { enumerable: true, get: function
 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 = require("tough-cookie");
+const tough_cookie_1 = require("tough-cookie");
 __exportStar(require("./musicbrainz.types"), exports);
 const util_1 = require("util");
 const retries = 3;
@@ -86,10 +87,11 @@ class MusicBrainzApi {
     }
     constructor(_config) {
         this.config = {
-            baseUrl: 'https://musicbrainz.org'
+            baseUrl: 'https://musicbrainz.org',
+            botAccount: {}
         };
         Object.assign(this.config, _config);
-        const cookieJar = new tough.CookieJar();
+        const cookieJar = new tough_cookie_1.CookieJar();
         this.getCookies = (0, util_1.promisify)(cookieJar.getCookies.bind(cookieJar));
         this.options = {
             prefixUrl: this.config.baseUrl,
@@ -97,7 +99,7 @@ class MusicBrainzApi {
             headers: {
                 'User-Agent': `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
             },
-            cookieJar
+            cookieJar: cookieJar
         };
         this.rateLimiter = new rate_limiter_1.RateLimiter(60, 50);
     }
@@ -353,7 +355,7 @@ class MusicBrainzApi {
         const clientId = `${this.config.appName.replace(/-/g, '.')}-${this.config.appVersion}`;
         const path = `ws/2/${entity}/`;
         // Get digest challenge
-        let digest = null;
+        let digest;
         let n = 1;
         const postData = xmlMetadata.toXml();
         do {
@@ -384,7 +386,7 @@ class MusicBrainzApi {
                 }
             }
         }
-        this.session = await this.getSession(this.config.baseUrl);
+        this.session = await this.getSession();
         const redirectUri = '/success';
         const formData = {
             username: this.config.botAccount.username,
@@ -411,7 +413,7 @@ class MusicBrainzApi {
                 returnto: redirectUri
             } }, this.options));
         const success = response.statusCode === http_status_codes_1.StatusCodes.MOVED_TEMPORARILY && response.headers.location === redirectUri;
-        if (success) {
+        if (success && this.session) {
             this.session.loggedIn = true;
         }
         return success;
@@ -424,7 +426,7 @@ class MusicBrainzApi {
      */
     async editEntity(entity, mbid, formData) {
         await this.rateLimiter.limit();
-        this.session = await this.getSession(this.config.baseUrl);
+        this.session = await this.getSession();
         formData.csrf_session_key = this.session.csrf.sessionKey;
         formData.csrf_token = this.session.csrf.token;
         formData.username = this.config.botAccount.username;
@@ -444,15 +446,16 @@ class MusicBrainzApi {
      * @param editNote Edit note
      */
     async addUrlToRecording(recording, url2add, editNote = '') {
+        var _a;
         const formData = {};
         formData['edit-recording.name'] = recording.title; // Required
         formData['edit-recording.comment'] = recording.disambiguation;
         formData['edit-recording.make_votable'] = true;
         formData['edit-recording.url.0.link_type_id'] = url2add.linkTypeId;
         formData['edit-recording.url.0.text'] = url2add.text;
-        for (const i in recording.isrcs) {
-            formData[`edit-recording.isrcs.${i}`] = recording.isrcs[i];
-        }
+        (_a = recording.isrcs) === null || _a === void 0 ? void 0 : _a.forEach((isrcs, i) => {
+            formData[`edit-recording.isrcs.${i}`] = isrcs;
+        });
         formData['edit-recording.edit_note'] = editNote;
         return this.editEntity('recording', recording.id, formData);
     }
@@ -527,7 +530,7 @@ class MusicBrainzApi {
     searchUrl(query) {
         return this.search('url', query);
     }
-    async getSession(url) {
+    async getSession() {
         const response = await got_1.default.get('login', Object.assign({ followRedirect: false, responseType: 'text' }, this.options));
         return {
             csrf: MusicBrainzApi.fetchCsrf(response.body)

package/lib/musicbrainz.types.d.ts

@@ -33,7 +33,7 @@ export interface IArtist extends IEntity {
     disambiguation: string;
     'sort-name': string;
     'type-id'?: string;
-    'gender-id'?: any;
+    'gender-id'?: string;
     'life-span'?: IPeriod;
     country?: string;
     ipis?: any[];
@@ -183,6 +183,7 @@ export interface IAreaList extends ISearchResult {
 }
 export interface IReleaseList extends ISearchResult {
     releases: IReleaseMatch[];
+    'release-count': number;
 }
 export interface IReleaseGroupList extends ISearchResult {
     'release-groups': IReleaseGroupMatch[];

package/lib/rate-limiter.d.ts

@@ -1,6 +1,6 @@
 export declare class RateLimiter {
     private maxCalls;
-    static sleep(ms: any): Promise<void>;
+    static sleep(ms: number): Promise<void>;
     queue: number[];
     private readonly period;
     constructor(period: number, maxCalls: number);

package/lib/rate-limiter.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RateLimiter = void 0;
-const Debug = require("debug");
-const debug = Debug('musicbrainz-api:rate-limiter');
+const debug_1 = require("debug");
+const debug = (0, debug_1.default)('musicbrainz-api:rate-limiter');
 class RateLimiter {
     static sleep(ms) {
         return new Promise(resolve => setTimeout(resolve, ms));

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

@@ -13,5 +13,5 @@ export declare class XmlIsrcList {
                 id: string;
             };
         }[];
-    };
+    } | null;
 }

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

@@ -8,7 +8,7 @@ export declare class XmlRecording {
         attrs: {
             id: string;
         };
-        children: {
+        children: ({
             name: string;
             attrs: {
                 count: number;
@@ -19,6 +19,6 @@ export declare class XmlRecording {
                     id: string;
                 };
             }[];
-        }[];
+        } | null)[];
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.10.3",
+  "version": "0.11.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "main": "lib/musicbrainz-api",
   "types": "lib/musicbrainz-api",
@@ -45,13 +45,14 @@
     "json-stringify-safe": "^5.0.1",
     "jsontoxml": "^1.0.1",
     "source-map-support": "^0.5.16",
-    "tough-cookie": "^4.0.0",
+    "tough-cookie": "^4.1.3",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",
+    "@types/jsontoxml": "^1.0.5",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^18.6.1",
+    "@types/node": "^20.8.10",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
     "chai": "^4.2.0",
@@ -60,7 +61,7 @@
     "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-jsdoc": "^46.8.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^46.0.0",
     "mocha": "^9.0.1",
@@ -71,6 +72,10 @@
     "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",

package/.idea/checkstyle-idea.xml

@@ -1,16 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CheckStyle-IDEA" serialisationVersion="2">
-    <checkstyleVersion>10.5.0</checkstyleVersion>
-    <scanScope>JavaOnly</scanScope>
-    <copyLibs>true</copyLibs>
-    <option name="thirdPartyClasspath" />
-    <option name="activeLocationIds" />
-    <option name="locations">
-      <list>
-        <ConfigurationLocation id="bundled-sun-checks" type="BUNDLED" scope="All" description="Sun Checks">(bundled)</ConfigurationLocation>
-        <ConfigurationLocation id="bundled-google-checks" type="BUNDLED" scope="All" description="Google Checks">(bundled)</ConfigurationLocation>
-      </list>
-    </option>
-  </component>
-</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,7 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="TsLint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/musicbrainz-api.iml" filepath="$PROJECT_DIR$/.idea/musicbrainz-api.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>

package/lib/digest-auth.ts

@@ -1,101 +0,0 @@
-import { v4 as uuidv4 } from 'uuid';
-import * as crypto from 'crypto';
-
-interface IChallenge {
-  algorithm?: string;
-  realm?: string;
-  nonce?: string;
-  opaque?: string;
-  qop?: string;
-}
-
-export interface ICredentials {
-  username: string;
-  password: string;
-}
-
-function md5(str) {
-  return crypto.createHash('md5').update(str).digest('hex'); // lgtm [js/insufficient-password-hash]
-}
-
-export class DigestAuth {
-
-  /**
-   * RFC 2617: handle both MD5 and MD5-sess algorithms.
-   *
-   * If the algorithm directive's value is "MD5" or unspecified, then HA1 is
-   *   HA1=MD5(username:realm:password)
-   * If the algorithm directive's value is "MD5-sess", then HA1 is
-   *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
-   */
-  public static ha1Compute(algorithm, user, realm, pass, nonce, cnonce) {
-    const ha1 = md5(user + ':' + realm + ':' + pass); // lgtm [js/insufficient-password-hash]
-    return algorithm && algorithm.toLowerCase() === 'md5-sess' ? md5(ha1 + ':' + nonce + ':' + cnonce) : ha1;
-  }
-
-  public hasAuth: boolean;
-  public sentAuth: boolean;
-  public bearerToken: string;
-
-  public constructor(private credentials: ICredentials) {
-    this.hasAuth = false;
-    this.sentAuth = false;
-    this.bearerToken = null;
-  }
-
-  public digest(method: string, path: string, authHeader: string): string {
-    // TODO: More complete implementation of RFC 2617.
-    //   - support qop="auth-int" only
-    //   - handle Authentication-Info (not necessarily?)
-    //   - check challenge.stale (not necessarily?)
-    //   - increase nc (not necessarily?)
-    // For reference:
-    // http://tools.ietf.org/html/rfc2617#section-3
-    // https://github.com/bagder/curl/blob/master/lib/http_digest.c
-
-    const challenge: IChallenge = {};
-    const re = /([a-z0-9_-]+)=(?:"([^"]+)"|([a-z0-9_-]+))/gi;
-    while (true) {
-      const match = re.exec(authHeader);
-      if (!match) {
-        break;
-      }
-      challenge[match[1]] = match[2] || match[3];
-    }
-
-    const qop = /(^|,)\s*auth\s*($|,)/.test(challenge.qop) && 'auth';
-    const nc = qop && '00000001';
-    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
-      ? md5(ha1 + ':' + challenge.nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2) // lgtm [js/insufficient-password-hash]
-      : md5(ha1 + ':' + challenge.nonce + ':' + ha2); // lgtm [js/insufficient-password-hash]
-    const authValues = {
-      username: this.credentials.username,
-      realm: challenge.realm,
-      nonce: challenge.nonce,
-      uri: path,
-      qop,
-      response: digestResponse,
-      nc,
-      cnonce,
-      algorithm: challenge.algorithm,
-      opaque: challenge.opaque
-    };
-
-    const parts: string[] = [];
-    for (const k in authValues) {
-      if (authValues[k]) {
-        if (k === 'qop' || k === 'nc' || k === 'algorithm') {
-          parts.push(k + '=' + authValues[k]);
-        } else {
-          parts.push(k + '="' + authValues[k] + '"');
-        }
-      }
-    }
-    authHeader = 'Digest ' + parts.join(', ');
-    this.sentAuth = true;
-    return authHeader;
-  }
-}