musicbrainz-api 0.9.0 → 0.10.1

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/README.md

@@ -94,13 +94,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 +108,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 +116,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 +124,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 +142,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
@@ -316,7 +311,6 @@ const places = await browseSeries();
 | `query.release-group` | Release-group MBID |
 | `query.work`          | Work MBID          |
 
-
 ### Browse works
 ```js
 const places = await browseWorks();
@@ -327,7 +321,6 @@ const places = await browseWorks();
 | `query.artist`     | Artist MBID     |
 | `query.xollection` | Collection MBID |
 
-
 ### Browse urls
 ```js
 const urls = await browseUrls();

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,22 +5,43 @@ 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 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 | 'artists' | 'releases' | 'isrcs';
-export declare type ReleasesIncludes = MiscIncludes | RelationsIncludes | 'artists' | 'collections' | 'labels' | 'recordings' | 'release-groups';
-export declare type ReleaseGroupIncludes = MiscIncludes | RelationsIncludes | 'artists' | 'releases';
-export declare type SeriesIncludes = MiscIncludes | RelationsIncludes;
-export declare type WorkIncludes = MiscIncludes | RelationsIncludes;
-export declare type UrlIncludes = RelationsIncludes;
+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
+ */
+'discids'
+/**
+ * include media for all releases, this includes the # of tracks on each medium and its format.
+ */
+ | 'media'
+/**
+ * include isrcs for all recordings
+ */
+ | 'isrcs'
+/**
+ * include artists credits for all releases and recordings
+ */
+ | 'artist-credits'
+/**
+ * include only those releases where the artist appears on one of the tracks, only valid on artists in combination with `releases`
+ */
+ | 'various-artists';
+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;
 }
@@ -83,6 +104,12 @@ export declare class MusicBrainzApi {
      * @param inc Sub-queries
      */
     lookupArtist(artistId: string, inc?: ArtistIncludes[]): Promise<mb.IArtist>;
+    /**
+     * Lookup collection
+     * @param collectionId Collection MBID
+     * @param inc List of additional information to be included about the entity. Any of the entities directly linked to the entity can be included.
+     */
+    lookupCollection(collectionId: string, inc?: ArtistIncludes[]): Promise<mb.ICollection>;
     /**
      * Lookup instrument
      * @param artistId Instrument MBID

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;
@@ -157,6 +157,14 @@ class MusicBrainzApi {
     lookupArtist(artistId, inc = []) {
         return this.lookupEntity('artist', artistId, inc);
     }
+    /**
+     * Lookup collection
+     * @param collectionId Collection MBID
+     * @param inc List of additional information to be included about the entity. Any of the entities directly linked to the entity can be included.
+     */
+    lookupCollection(collectionId, inc = []) {
+        return this.lookupEntity('collection', collectionId, inc);
+    }
     /**
      * Lookup instrument
      * @param artistId Instrument MBID

package/lib/musicbrainz.types.d.ts

@@ -56,6 +56,14 @@ export interface IArtistCredit {
     joinphrase: string;
     name: string;
 }
+export interface ICollection extends IEntity {
+    type: string;
+    name: string;
+    'type-id': string;
+    'recording-count': number;
+    editor: string;
+    'entity-type': string;
+}
 export interface IEvent extends IEntity {
     cancelled: boolean;
     type: string;
@@ -73,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': {
@@ -101,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;
@@ -177,18 +185,18 @@ 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;
     'target-credit': string;
-    end: null | object;
+    end: null | unknown;
     'source-credit': string;
     ended: boolean;
-    'attribute-values': object;
+    'attribute-values': unknown;
     attributes?: any[];
     type: string;
-    begin?: null | object;
+    begin?: null | unknown;
     'target-type'?: 'url';
     'type-id': string;
     url?: IUrl;
@@ -229,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,
@@ -493,13 +501,6 @@ export interface IReleaseGroupsQuery extends IPagination {
     collection?: string;
     release?: string;
 }
-/**
- * Browse series query <entity>: <MBID>
- * https://wiki.musicbrainz.org/MusicBrainz_API#Linked_entities
- */
-export interface IBrowseSeriesQuery extends IPagination {
-    recording?: string;
-}
 /**
  * Browse release query <entity>: <MBID>
  * https://wiki.musicbrainz.org/MusicBrainz_API#Linked_entities
@@ -533,27 +534,27 @@ export interface IBrowseArtistsResult {
     'artist-offset': number;
 }
 export interface IBrowseCollectionsResult {
-    collections: IArtist[];
+    collections: ICollection[];
     'collection-count': number;
     'collection-offset': number;
 }
 export interface IBrowseEventsResult {
-    events: IArtist[];
+    events: IEvent[];
     'event-count': number;
     'event-offset': number;
 }
 export interface IBrowseInstrumentsResult {
-    instruments: IArtist[];
+    instruments: IInstrument[];
     'instrument-count': number;
     'instrument-offset': number;
 }
 export interface IBrowseLabelsResult {
-    label: IArtist[];
+    label: ILabel[];
     'label-count': number;
     'label-offset': number;
 }
 export interface IBrowsePlacesResult {
-    place: IArtist[];
+    place: IPlace[];
     'place-count': number;
     'place-offset': number;
 }
@@ -568,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.9.0",
+  "version": "0.10.1",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "main": "lib/musicbrainz-api",
   "types": "lib/musicbrainz-api",
@@ -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",
@@ -55,17 +55,17 @@
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
     "chai": "^4.2.0",
-    "del-cli": "^4.0.1",
+    "del-cli": "^5.0.0",
     "eslint": "^8.10.0",
     "eslint-config-prettier": "^8.4.0",
-    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-import-resolver-typescript": "^3.3.0",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^37.9.5",
+    "eslint-plugin-jsdoc": "^39.3.3",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^42.0.0",
+    "eslint-plugin-unicorn": "^44.0.2",
     "mocha": "^9.0.1",
     "nyc": "^15.0.0",
-    "remark-cli": "^10.0.1",
+    "remark-cli": "^11.0.0",
     "remark-preset-lint-recommended": "^6.1.2",
     "ts-node": "^10.0.0",
     "tslint": "^6.1.1",