musicbrainz-api 0.9.0 → 0.10.0

package/README.md

@@ -316,7 +316,6 @@ const places = await browseSeries();
 | `query.release-group` | Release-group MBID |
 | `query.work`          | Work MBID          |
 
-
 ### Browse works
 ```js
 const places = await browseWorks();
@@ -327,7 +326,6 @@ const places = await browseWorks();
 | `query.artist`     | Artist MBID     |
 | `query.xollection` | Collection MBID |
 
-
 ### Browse urls
 ```js
 const urls = await browseUrls();

package/lib/musicbrainz-api.d.ts

@@ -6,6 +6,27 @@ 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 = 
+/**
+ * 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 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';
@@ -15,9 +36,9 @@ 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 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;
@@ -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

@@ -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;
@@ -182,13 +190,13 @@ 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;
@@ -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;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "main": "lib/musicbrainz-api",
   "types": "lib/musicbrainz-api",
@@ -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": "^43.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",