musicbrainz-api 0.12.0 → 0.14.0

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 = 
 /**
@@ -37,7 +37,7 @@ 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 ReleaseIncludes = 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;
@@ -84,162 +84,58 @@ export declare class MusicBrainzApi {
         [key: string]: any;
     }, attempt?: number): Promise<T>;
     /**
-     * Generic lookup function
-     * @param entity
-     * @param mbid
-     * @param inc
-     */
-    lookupEntity<T, I extends string = never>(entity: mb.EntityType, mbid: string, inc?: I[]): Promise<T>;
-    /**
-     * Lookup area
-     * @param areaId Area MBID
-     * @param inc Sub-queries
-     */
-    lookupArea(areaId: string, inc?: AreaIncludes[]): Promise<mb.IArea>;
-    /**
-     * Lookup artist
-     * @param artistId Artist MBID
-     * @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
-     * @param inc Sub-queries
-     */
-    lookupInstrument(instrumentId: string, inc?: InstrumentIncludes[]): Promise<mb.IInstrument>;
-    /**
-     * Lookup label
-     * @param labelId Area MBID
-     * @param inc Sub-queries
-     */
-    lookupLabel(labelId: string, inc?: LabelIncludes[]): Promise<mb.ILabel>;
-    /**
-     * Lookup place
-     * @param placeId Area MBID
-     * @param inc Sub-queries
-     */
-    lookupPlace(placeId: string, inc?: PlaceIncludes[]): Promise<mb.IPlace>;
-    /**
-     * Lookup release
-     * @param releaseId Release MBID
-     * @param inc Include: artist-credits, labels, recordings, release-groups, media, discids, isrcs (with recordings)
-     * ToDo: ['recordings', 'artists', 'artist-credits', 'isrcs', 'url-rels', 'release-groups']
-     */
-    lookupRelease(releaseId: string, inc?: ReleasesIncludes[]): Promise<mb.IRelease>;
-    /**
-     * Lookup release-group
-     * @param releaseGroupId Release-group MBID
-     * @param inc Include: ToDo
-     */
-    lookupReleaseGroup(releaseGroupId: string, inc?: ReleaseGroupIncludes[]): Promise<mb.IReleaseGroup>;
-    /**
-     * Lookup recording
-     * @param recordingId Label MBID
-     * @param inc Include: artist-credits, isrcs
-     */
-    lookupRecording(recordingId: string, inc?: RecordingIncludes[]): Promise<mb.IRecording>;
-    /**
-     * Lookup series
-     * @param seriesId Series MBID
-     */
-    lookupSeries(seriesId: string): Promise<mb.ISeries>;
-    /**
-     * Lookup work
-     * @param workId Work MBID
-     */
-    lookupWork(workId: string, inc?: WorkIncludes[]): Promise<mb.IWork>;
-    /**
-     * Lookup URL
-     * @param urlId URL MBID
-     */
-    lookupUrl(urlId: string, inc?: UrlIncludes[]): Promise<mb.IUrl>;
-    /**
-     * Lookup Event
-     * @param eventId Event MBID
-     * @param eventIncludes List of sub-queries to enable
-     */
-    lookupEvent(eventId: string, eventIncludes?: EventIncludes[]): Promise<mb.IEvent>;
-    /**
-     * Generic browse function
+     * Lookup entity
+     * @param entity 'area', 'artist', collection', 'instrument', 'label', 'place', 'release', 'release-group', 'recording', 'series', 'work', 'url' or 'event'
+     * @param mbid Entity MBID
+     * @param inc Query, like: {<entity>: <MBID:}
+     */
+    lookup(entity: 'area', mbid: string, inc?: AreaIncludes[]): Promise<mb.IArea>;
+    lookup(entity: 'artist', mbid: string, inc?: ArtistIncludes[]): Promise<mb.IArtist>;
+    lookup(entity: 'collection', mbid: string, inc?: CollectionIncludes[]): Promise<mb.ICollection>;
+    lookup(entity: 'instrument', mbid: string, inc?: InstrumentIncludes[]): Promise<mb.IInstrument>;
+    lookup(entity: 'label', mbid: string, inc?: LabelIncludes[]): Promise<mb.ILabel>;
+    lookup(entity: 'place', mbid: string, inc?: PlaceIncludes[]): Promise<mb.IPlace>;
+    lookup(entity: 'release', mbid: string, inc?: ReleaseIncludes[]): Promise<mb.IRelease>;
+    lookup(entity: 'release-group', mbid: string, inc?: ReleaseGroupIncludes[]): Promise<mb.IReleaseGroup>;
+    lookup(entity: 'recording', mbid: string, inc?: RecordingIncludes[]): Promise<mb.IRecording>;
+    lookup(entity: 'series', mbid: string, inc?: SeriesIncludes[]): Promise<mb.ISeries>;
+    lookup(entity: 'work', mbid: string, inc?: WorkIncludes[]): Promise<mb.IWork>;
+    lookup(entity: 'url', mbid: string, inc?: UrlIncludes[]): Promise<mb.IUrl>;
+    lookup(entity: 'event', mbid: string, inc?: EventIncludes[]): Promise<mb.IEvent>;
+    /**
+     * Browse entity
+     * https://wiki.musicbrainz.org/MusicBrainz_API#Browse
+     * https://wiki.musicbrainz.org/MusicBrainz_API#Linked_entities
      * https://wiki.musicbrainz.org/Development/JSON_Web_Service#Browse_Requests
+     * For example: http://musicbrainz.org/ws/2/release?label=47e718e1-7ee4-460c-b1cc-1192a841c6e5&offset=12&limit=2
      * @param entity MusicBrainz entity
      * @param query Query, like: {<entity>: <MBID:}
      */
-    browseEntity<T>(entity: mb.EntityType, query?: {
-        [key: string]: any;
-    }): Promise<T>;
-    /**
-     * Browse areas
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseAreas(query?: mb.IBrowseAreasQuery): Promise<mb.IBrowseAreasResult>;
-    /**
-     * Browse artists
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseArtists(query?: mb.IBrowseArtistsQuery): Promise<mb.IBrowseArtistsResult>;
-    /**
-     * Browse collections
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseCollections(query?: mb.IBrowseCollectionsQuery): Promise<mb.IBrowseCollectionsResult>;
+    browse(entity: 'area', query?: mb.IBrowseAreasQuery): Promise<mb.IBrowseAreasResult>;
+    browse(entity: 'artist', query?: mb.IBrowseArtistsQuery): Promise<mb.IBrowseArtistsResult>;
+    browse(entity: 'collection', query?: mb.IBrowseCollectionsQuery): Promise<mb.IBrowseCollectionsResult>;
+    browse(entity: 'event', query?: mb.IBrowseEventsQuery): Promise<mb.IBrowseEventsResult>;
+    browse(entity: 'label', query?: mb.IBrowseLabelsQuery): Promise<mb.IBrowseLabelsResult>;
+    browse(entity: 'instrument', query?: mb.IBrowseInstrumentsQuery): Promise<mb.IBrowseInstrumentsResult>;
+    browse(entity: 'place', query?: mb.IBrowsePlacesQuery): Promise<mb.IBrowsePlacesResult>;
+    browse(entity: 'recording', query?: mb.IBrowseRecordingsQuery): Promise<mb.IBrowseRecordingsResult>;
+    browse(entity: 'release', query?: mb.IBrowseReleasesQuery): Promise<mb.IBrowseReleasesResult>;
+    browse(entity: 'release-group', query?: mb.IBrowseReleaseGroupsQuery): Promise<mb.IBrowseReleaseGroupsResult>;
+    browse(entity: 'series', query?: mb.IBrowseSeriesQuery): Promise<mb.IBrowseSeriesResult>;
+    browse(entity: 'url', query?: mb.IBrowseUrlsQuery): Promise<mb.IUrl>;
+    browse(entity: 'work', query?: mb.IBrowseWorksQuery): Promise<mb.IBrowseWorksResult>;
     /**
-     * Browse events
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseEvents(query?: mb.IBrowseEventsQuery): Promise<mb.IBrowseEventsResult>;
-    /**
-     * Browse instruments
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseInstruments(query?: mb.IBrowseInstrumentsQuery): Promise<mb.IBrowseInstrumentsResult>;
-    /**
-     * Browse labels
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseLabels(query?: mb.IBrowseLabelsQuery): Promise<mb.IBrowseLabelsResult>;
-    /**
-     * Browse places
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browsePlaces(query?: mb.IBrowsePlacesQuery): Promise<mb.IBrowsePlacesResult>;
-    /**
-     * Browse recordings
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseRecordings(query?: mb.IBrowseRecordingsQuery): Promise<mb.IBrowseRecordingsResult>;
-    /**
-     * Browse releases
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseReleases(query?: mb.IBrowseReleasesQuery): Promise<mb.IBrowseReleasesResult>;
-    /**
-     * Browse release-groups
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseReleaseGroups(query?: mb.IReleaseGroupsQuery): Promise<mb.IBrowseReleaseGroupsResult>;
-    /**
-     * Browse series
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseSeries(query?: mb.IBrowseSeriesQuery): Promise<mb.IBrowseSeriesResult>;
-    /**
-     * Browse works
-     * @param query Query, like: {<entity>: <MBID:}
-     */
-    browseWorks(query?: mb.IBrowseWorksQuery): Promise<mb.IBrowseWorksResult>;
-    /**
-     * Browse URLs
-     * @param query Query, like: {<entity>: <MBID:}
+     * Search an entity using a search query
+     * @param query e.g.: '" artist: Madonna, track: Like a virgin"' or object with search terms: {artist: Madonna}
+     * @param entity e.g. 'recording'
+     * @param query Arguments
      */
-    browseUrls(query?: mb.IBrowseUrlsQuery): Promise<mb.IUrl>;
+    search(entity: 'area', query: mb.ISearchQuery<AreaIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IAreaList>;
+    search(artist: 'artist', query: mb.ISearchQuery<ArtistIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IArtistList>;
+    search(artist: 'recording', query: mb.ISearchQuery<AreaIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IRecordingList>;
+    search(artist: 'release', query: mb.ISearchQuery<ReleaseIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IReleaseList>;
+    search(artist: 'release-group', query: mb.ISearchQuery<ReleaseGroupIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IReleaseGroupList>;
+    search(artist: 'url', query: mb.ISearchQuery<UrlIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IUrlList>;
     postRecording(xmlMetadata: XmlMetadata): Promise<void>;
     post(entity: mb.EntityType, xmlMetadata: XmlMetadata): Promise<void>;
     login(): Promise<boolean>;
@@ -271,13 +167,6 @@ export declare class MusicBrainzApi {
      * @param editNote Edit note
      */
     addIsrc(recording: mb.IRecording, isrc: string, editNote?: string): Promise<void>;
-    /**
-     * Search an entity using a search query
-     * @param query e.g.: '" artist: Madonna, track: Like a virgin"' or object with search terms: {artist: Madonna}
-     * @param entity e.g. 'recording'
-     * @param query Arguments
-     */
-    search<T extends mb.ISearchResult, I extends string = never>(entity: mb.EntityType, query: mb.ISearchQuery<I>): Promise<T>;
     /**
      * Add Spotify-ID to MusicBrainz recording.
      * This function will automatically lookup the recording title, which is required to submit the recording URL
@@ -286,11 +175,6 @@ export declare class MusicBrainzApi {
      * @param editNote Comment to add.
      */
     addSpotifyIdToRecording(recording: mb.IRecording, spotifyId: string, editNote: string): Promise<void>;
-    searchArea(query: mb.ISearchQuery<AreaIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IAreaList>;
-    searchArtist(query: mb.ISearchQuery<ArtistIncludes> & mb.ILinkedEntitiesArtist): Promise<mb.IArtistList>;
-    searchRelease(query: mb.ISearchQuery<ReleasesIncludes> & mb.ILinkedEntitiesRelease): Promise<mb.IReleaseList>;
-    searchReleaseGroup(query: mb.ISearchQuery<ReleaseGroupIncludes> & mb.ILinkedEntitiesReleaseGroup): Promise<mb.IReleaseGroupList>;
-    searchUrl(query: mb.ISearchQuery<UrlIncludes> & mb.ILinkedEntitiesUrl): Promise<mb.IUrlList>;
     private getSession;
 }
 export declare function makeAndQueryString(keyValuePairs: IFormData): string;