musicbrainz-api 0.10.0 → 0.10.2

package/.idea/jpa-buddy.xml

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

package/.idea/vcs.xml

@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
+  <component name="GitSharedSettings">
+    <option name="FORCE_PUSH_PROHIBITED_PATTERNS">
+      <list />
+    </option>
+  </component>
   <component name="VcsDirectoryMappings">
     <mapping directory="" vcs="Git" />
   </component>

package/README.md

@@ -3,9 +3,8 @@
 [![npm downloads](http://img.shields.io/npm/dm/musicbrainz-api.svg)](https://npmcharts.com/compare/musicbrainz-api)
 [![Coverage Status](https://coveralls.io/repos/github/Borewit/musicbrainz-api/badge.svg?branch=master)](https://coveralls.io/github/Borewit/musicbrainz-api?branch=master)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2bc47b2006454bae8c737991f152e518)](https://www.codacy.com/gh/Borewit/musicbrainz-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Borewit/musicbrainz-api&utm_campaign=Badge_Grade)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Borewit/musicbrainz-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/musicbrainz-api/context:javascript)
+[![CodeQL](https://github.com/Borewit/musicbrainz-api/actions/workflows/codeql.yml/badge.svg)](https://github.com/Borewit/musicbrainz-api/actions/workflows/codeql.yml)
 [![Known Vulnerabilities](https://snyk.io/test/github/Borewit/musicbrainz-api/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Borewit/musicbrainz-api?targetFile=package.json)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/Borewit/musicbrainz-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/musicbrainz-api/alerts/)
 [![DeepScan grade](https://deepscan.io/api/teams/5165/projects/6991/branches/63373/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5165&pid=6991&bid=63373)
 [![Discord](https://img.shields.io/discord/460524735235883049.svg)](https://discord.gg/958xT5X)
 
@@ -94,13 +93,13 @@ Arguments:
 *   MBID [(MusicBrainz identifier)](https://wiki.musicbrainz.org/MusicBrainz_Identifier)
 
 ```js
-const artist = await mbApi.lookupEntity('artist', {query: 'ab2528d9-719f-4261-8098-21849222a0f2'});
+const artist = await mbApi.lookupEntity('artist', 'ab2528d9-719f-4261-8098-21849222a0f2');
 ```
 
 ### Lookup area
 
 ```js
-const area = await mbApi.lookupArea({query: 'ab2528d9-719f-4261-8098-21849222a0f2'});
+const area = await mbApi.lookupArea('ab2528d9-719f-4261-8098-21849222a0f2');
 ```
 
 ### Lookup artist
@@ -108,7 +107,7 @@ const area = await mbApi.lookupArea({query: 'ab2528d9-719f-4261-8098-21849222a0f
 Lookup an `artist` and include their `releases`, `release-groups` and `aliases`
 
 ```js
-const artist = await mbApi.lookupArtist({query: 'ab2528d9-719f-4261-8098-21849222a0f2'});
+const artist = await mbApi.lookupArtist('ab2528d9-719f-4261-8098-21849222a0f2');
 ```
 
 ### Lookup instrument
@@ -116,7 +115,7 @@ const artist = await mbApi.lookupArtist({query: 'ab2528d9-719f-4261-8098-2184922
 Lookup an instrument
 
 ```js
-const artist = await mbApi.lookupInstrument({query: 'b3eac5f9-7859-4416-ac39-7154e2e8d348'});
+const instrument = await mbApi.lookupInstrument('b3eac5f9-7859-4416-ac39-7154e2e8d348');
 ```
 
 ### Lookup label
@@ -124,13 +123,13 @@ const artist = await mbApi.lookupInstrument({query: 'b3eac5f9-7859-4416-ac39-715
 Lookup a label
 
 ```js
-const artist = await mbApi.lookupInstrument({query: '25dda9f9-f069-4898-82f0-59330a106c7f'});
+const label = await mbApi.lookupLabel('25dda9f9-f069-4898-82f0-59330a106c7f');
 ```
 
 ### Lookup place
 
 ```js
-const artist = await mbApi.lookupPlace({query: 'e6cfb74d-d69b-44c3-b890-1b3f509816e4'});
+const place = await mbApi.lookupPlace('e6cfb74d-d69b-44c3-b890-1b3f509816e4');
 ```
 
 The second argument can be used to pass [subqueries](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2#Subqueries), which will return more (nested) information:
@@ -142,32 +141,27 @@ const artist = await mbApi.lookupArtist('ab2528d9-719f-4261-8098-21849222a0f2',
 
 The second argument can be used to pass [subqueries](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2#Subqueries):
 ```js
-const artist = await mbApi.lookupRecording({query: '16afa384-174e-435e-bfa3-5591accda31c'}, ['artists', 'url-rels']);
+const recording = await mbApi.lookupRecording('16afa384-174e-435e-bfa3-5591accda31c', ['artists', 'url-rels']);
 ```
 
 ### Lookup release
 ```js
-const release = await mbApi.lookupRelease({query: '976e0677-a480-4a5e-a177-6a86c1900bbf'}, ['artists', 'url-rels']);
+const release = await mbApi.lookupRelease('976e0677-a480-4a5e-a177-6a86c1900bbf', ['artists', 'url-rels']);
 ```
 
 ### Lookup release-group
 ```js
-const releaseGroup = await mbApi.lookupReleaseGroup({query: '19099ea5-3600-4154-b482-2ec68815883e'});
+const releaseGroup = await mbApi.lookupReleaseGroup('19099ea5-3600-4154-b482-2ec68815883e');
 ```
 
 ### Lookup work
 ```js
-const work = await mbApi.lookupWork({query: 'b2aa02f4-6c95-43be-a426-aedb9f9a3805'});
+const work = await mbApi.lookupWork('b2aa02f4-6c95-43be-a426-aedb9f9a3805');
 ```
 
 ### Lookup URL
 ```js
-const url = await mbApi.lookupUrl({query: 'c69556a6-7ded-4c54-809c-afb45a1abe7d'});
-```
-
-### Lookup URL
-```js
-const url = await mbApi.lookupUrl({query: 'c69556a6-7ded-4c54-809c-afb45a1abe7d'});
+const url = await mbApi.lookupUrl('c69556a6-7ded-4c54-809c-afb45a1abe7d');
 ```
 
 ## Browse entities

package/lib/digest-auth.js

@@ -7,12 +7,6 @@ function md5(str) {
     return crypto.createHash('md5').update(str).digest('hex'); // lgtm [js/insufficient-password-hash]
 }
 class DigestAuth {
-    constructor(credentials) {
-        this.credentials = credentials;
-        this.hasAuth = false;
-        this.sentAuth = false;
-        this.bearerToken = null;
-    }
     /**
      * RFC 2617: handle both MD5 and MD5-sess algorithms.
      *
@@ -25,6 +19,12 @@ class DigestAuth {
         const ha1 = md5(user + ':' + realm + ':' + pass); // lgtm [js/insufficient-password-hash]
         return algorithm && algorithm.toLowerCase() === 'md5-sess' ? md5(ha1 + ':' + nonce + ':' + cnonce) : ha1;
     }
+    constructor(credentials) {
+        this.credentials = credentials;
+        this.hasAuth = false;
+        this.sentAuth = false;
+        this.bearerToken = null;
+    }
     digest(method, path, authHeader) {
         // TODO: More complete implementation of RFC 2617.
         //   - support qop="auth-int" only

package/lib/musicbrainz-api.d.ts

@@ -5,8 +5,8 @@ export { XmlRecording } from './xml/xml-recording';
 import { XmlMetadata } from './xml/xml-metadata';
 import * as mb from './musicbrainz.types';
 export * from './musicbrainz.types';
-export declare 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 declare type SubQueryIncludes = 
+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 = 
 /**
  * include discids for all media in the releases
  */
@@ -27,21 +27,21 @@ export declare type SubQueryIncludes =
  * include only those releases where the artist appears on one of the tracks, only valid on artists in combination with `releases`
  */
  | 'various-artists';
-export declare type MiscIncludes = 'aliases' | 'annotation' | 'tags' | 'genres' | 'ratings' | 'media';
-export declare type AreaIncludes = MiscIncludes | RelationsIncludes;
-export declare type ArtistIncludes = MiscIncludes | RelationsIncludes | 'recordings' | 'releases' | 'release-groups' | 'works';
-export declare type CollectionIncludes = MiscIncludes | RelationsIncludes | 'user-collections';
-export declare type EventIncludes = MiscIncludes | RelationsIncludes;
-export declare type GenreIncludes = MiscIncludes;
-export declare type InstrumentIncludes = MiscIncludes | RelationsIncludes;
-export declare type LabelIncludes = MiscIncludes | RelationsIncludes | 'releases';
-export declare type PlaceIncludes = MiscIncludes | RelationsIncludes;
-export declare type RecordingIncludes = MiscIncludes | RelationsIncludes | SubQueryIncludes | 'artists' | 'releases' | 'isrcs';
-export declare type ReleasesIncludes = MiscIncludes | SubQueryIncludes | RelationsIncludes | 'artists' | 'collections' | 'labels' | 'recordings' | 'release-groups';
-export declare type ReleaseGroupIncludes = MiscIncludes | SubQueryIncludes | RelationsIncludes | 'artists' | 'releases';
-export declare type SeriesIncludes = MiscIncludes | RelationsIncludes;
-export declare type WorkIncludes = MiscIncludes | RelationsIncludes;
-export declare type UrlIncludes = RelationsIncludes;
+export type MiscIncludes = 'aliases' | 'annotation' | 'tags' | 'genres' | 'ratings' | 'media';
+export type AreaIncludes = MiscIncludes | RelationsIncludes;
+export type ArtistIncludes = MiscIncludes | RelationsIncludes | 'recordings' | 'releases' | 'release-groups' | 'works';
+export type CollectionIncludes = MiscIncludes | RelationsIncludes | 'user-collections';
+export type EventIncludes = MiscIncludes | RelationsIncludes;
+export type GenreIncludes = MiscIncludes;
+export type InstrumentIncludes = MiscIncludes | RelationsIncludes;
+export type LabelIncludes = MiscIncludes | RelationsIncludes | 'releases';
+export type PlaceIncludes = MiscIncludes | RelationsIncludes;
+export type RecordingIncludes = MiscIncludes | RelationsIncludes | SubQueryIncludes | 'artists' | 'releases' | 'isrcs';
+export type ReleasesIncludes = MiscIncludes | SubQueryIncludes | RelationsIncludes | 'artists' | 'collections' | 'labels' | 'recordings' | 'release-groups';
+export type ReleaseGroupIncludes = MiscIncludes | SubQueryIncludes | RelationsIncludes | 'artists' | 'releases';
+export type SeriesIncludes = MiscIncludes | RelationsIncludes;
+export type WorkIncludes = MiscIncludes | RelationsIncludes;
+export type UrlIncludes = RelationsIncludes;
 export interface IFormData {
     [key: string]: string | number;
 }

package/lib/musicbrainz-api.js

@@ -37,23 +37,6 @@ const util_1 = require("util");
 const retries = 3;
 const debug = Debug('musicbrainz-api');
 class MusicBrainzApi {
-    constructor(_config) {
-        this.config = {
-            baseUrl: 'https://musicbrainz.org'
-        };
-        Object.assign(this.config, _config);
-        const cookieJar = new tough.CookieJar();
-        this.getCookies = (0, util_1.promisify)(cookieJar.getCookies.bind(cookieJar));
-        this.options = {
-            prefixUrl: this.config.baseUrl,
-            timeout: 20 * 1000,
-            headers: {
-                'User-Agent': `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
-            },
-            cookieJar
-        };
-        this.rateLimiter = new rate_limiter_1.RateLimiter(60, 50);
-    }
     static escapeText(text) {
         let str = '';
         for (const chr of text) {
@@ -101,6 +84,23 @@ class MusicBrainzApi {
             }
         }
     }
+    constructor(_config) {
+        this.config = {
+            baseUrl: 'https://musicbrainz.org'
+        };
+        Object.assign(this.config, _config);
+        const cookieJar = new tough.CookieJar();
+        this.getCookies = (0, util_1.promisify)(cookieJar.getCookies.bind(cookieJar));
+        this.options = {
+            prefixUrl: this.config.baseUrl,
+            timeout: 20 * 1000,
+            headers: {
+                'User-Agent': `${this.config.appName}/${this.config.appVersion} ( ${this.config.appContactInfo} )`
+            },
+            cookieJar
+        };
+        this.rateLimiter = new rate_limiter_1.RateLimiter(60, 50);
+    }
     async restGet(relUrl, query = {}, attempt = 1) {
         query.fmt = 'json';
         let response;

package/lib/musicbrainz.types.d.ts

@@ -39,7 +39,7 @@ export interface IArtist extends IEntity {
     ipis?: any[];
     isnis?: string[];
     aliases?: IAlias[];
-    gender?: null;
+    gender?: string;
     type?: string;
     area?: IArea;
     begin_area?: IArea;
@@ -81,7 +81,7 @@ export interface IInstrument extends IEntity {
     type: string;
     description: string;
 }
-export declare type ReleaseQuality = 'normal';
+export type ReleaseQuality = 'normal';
 export interface IRelease extends IEntity {
     title: string;
     'text-representation': {
@@ -109,7 +109,7 @@ export interface IReleaseEvent {
     area?: IArea;
     date?: string;
 }
-export declare type MediaFormatType = 'Digital Media';
+export type MediaFormatType = 'Digital Media';
 export interface IRecording extends IEntity {
     video: boolean;
     length: number;
@@ -185,7 +185,7 @@ export interface IReleaseGroupList extends ISearchResult {
 export interface IUrlList extends ISearchResult {
     urls: IUrlMatch[];
 }
-export declare type RelationDirection = 'backward' | 'forward';
+export type RelationDirection = 'backward' | 'forward';
 export interface IRelation {
     'attribute-ids': any;
     direction: RelationDirection;
@@ -237,8 +237,8 @@ export interface IReleaseSearchResult extends ISearchResult {
 /**
  * https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#Subqueries
  */
-export declare type EntityType = 'area' | 'artist' | 'collection' | 'event' | 'instrument' | 'label' | 'place' | 'recording' | 'release' | 'release-group' | 'series' | 'work' | 'url';
-export declare type Relationships = '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 EntityType = 'area' | 'artist' | 'collection' | 'event' | 'instrument' | 'label' | 'place' | 'recording' | 'release' | 'release-group' | 'series' | 'work' | 'url';
+export type Relationships = '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 declare enum LinkType {
     license = 302,
     production = 256,
@@ -569,7 +569,7 @@ export interface IBrowseReleasesResult {
     'release-offset': number;
 }
 export interface IBrowseReleaseGroupsResult {
-    'release-groups': IReleaseGroupsQuery[];
+    'release-groups': IReleaseGroup[];
     'release-group-count': number;
     'release-group-offset': number;
 }

package/lib/rate-limiter.js

@@ -4,14 +4,14 @@ exports.RateLimiter = void 0;
 const Debug = require("debug");
 const debug = Debug('musicbrainz-api:rate-limiter');
 class RateLimiter {
+    static sleep(ms) {
+        return new Promise(resolve => setTimeout(resolve, ms));
+    }
     constructor(period, maxCalls) {
         this.maxCalls = maxCalls;
         this.queue = [];
         this.period = 1000 * period;
     }
-    static sleep(ms) {
-        return new Promise(resolve => setTimeout(resolve, ms));
-    }
     async limit() {
         let now = new Date().getTime();
         const t0 = now - (this.period);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "main": "lib/musicbrainz-api",
   "types": "lib/musicbrainz-api",
@@ -37,7 +37,7 @@
   "dependencies": {
     "@types/caseless": "^0.12.1",
     "@types/request-promise-native": "^1.0.17",
-    "@types/uuid": "^8.3.0",
+    "@types/uuid": "^9.0.0",
     "caseless": "^0.12.0",
     "debug": "^4.1.1",
     "got": "^11.8.5",
@@ -46,7 +46,7 @@
     "jsontoxml": "^1.0.1",
     "source-map-support": "^0.5.16",
     "tough-cookie": "^4.0.0",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",
@@ -62,7 +62,7 @@
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jsdoc": "^39.3.3",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^43.0.2",
+    "eslint-plugin-unicorn": "^45.0.0",
     "mocha": "^9.0.1",
     "nyc": "^15.0.0",
     "remark-cli": "^11.0.0",