musicbrainz-api 0.24.0 → 0.25.0

package/README.md

@@ -340,14 +340,21 @@ Searches can be performed using the generic search function: `query(entity: mb.E
 
 Arguments:
 - Entity type, which can be one of:
-  - `artist`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Artist)
-  - `label`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Label)
-  - `recording`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Recording)
-  - `release`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Release)
-  - `release-group`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Release_Group)
-  - `work`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Work)
-  - `area`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Area)
-  - `url`: [search fields](https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#URL)
+  - `annotation`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Annotation)
+  - `area`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Area)
+  - `artist`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Artist)
+  - `cdstub`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#CDStubs)
+  - `event`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Event)
+  - `instrument`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Instrument)
+  - `label`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Label)
+  - `place`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Place)
+  - `recording`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Recording)
+  - `release`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Release)
+  - `release-group`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Release_Group)
+  - `series`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Series)
+  - `tag`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Tag)
+  - `url`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#URL)
+  - `work`: [search fields](https://wiki.musicbrainz.org/MusicBrainz_API/Search#Work)
 - `query {query: string, offset: number, limit: number}`
   - `query.query`: supports the full Lucene Search syntax; you can find a detailed guide at [Lucene Search Syntax](https://lucene.apache.org/core/4_3_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description). For example, you can set conditions while searching for a name with the AND operator.
   - `query.offset`: optional, return search results starting at a given offset. Used for paging through more than one page of results.

package/lib/musicbrainz-api.d.ts

@@ -132,16 +132,24 @@ export declare class MusicBrainzApi {
     browse(entity: 'work', query?: mb.IBrowseWorksQuery, inc?: WorkIncludes[]): Promise<mb.IBrowseWorksResult>;
     /**
      * 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
+     * @param query e.g.: '" artist: Madonna, track: Like a virgin"' or object with search terms: {artist: Madonna}
      */
+    search(entity: 'annotation', query: mb.ISearchQuery<(MiscIncludes | RelationsIncludes)>): Promise<mb.IAnnotationList>;
     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>;
+    search(entity: 'artist', query: mb.ISearchQuery<ArtistIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IArtistList>;
+    search(entity: 'cdstub', query: mb.ISearchQuery<(MiscIncludes | RelationsIncludes)>): Promise<mb.ICdStubList>;
+    search(entity: 'event', query: mb.ISearchQuery<EventIncludes> & mb.ILinkedEntitiesEvent): Promise<mb.IEventList>;
+    search(entity: 'instrument', query: mb.ISearchQuery<InstrumentIncludes> & mb.ILinkedEntitiesInstrument): Promise<mb.IInstrumentList>;
+    search(entity: 'label', query: mb.ISearchQuery<LabelIncludes> & mb.ILinkedEntitiesLabel): Promise<mb.ILabelList>;
+    search(entity: 'place', query: mb.ISearchQuery<PlaceIncludes> & mb.ILinkedEntitiesPlace): Promise<mb.IPlaceList>;
+    search(entity: 'recording', query: mb.ISearchQuery<RecordingIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IRecordingList>;
+    search(entity: 'release', query: mb.ISearchQuery<ReleaseIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IReleaseList>;
+    search(entity: 'release-group', query: mb.ISearchQuery<ReleaseGroupIncludes> & mb.ILinkedEntitiesArea): Promise<mb.IReleaseGroupList>;
+    search(entity: 'series', query: mb.ISearchQuery<SeriesIncludes> & mb.ILinkedEntitiesSeries): Promise<mb.ISeriesList>;
+    search(entity: 'tag', query: mb.ISearchQuery<MiscIncludes | RelationsIncludes>): Promise<mb.ITagList>;
+    search(entity: 'url', query: mb.ISearchQuery<UrlIncludes> & mb.ILinkedEntitiesUrl): Promise<mb.IUrlList>;
+    search(entity: 'work', query: mb.ISearchQuery<WorkIncludes> & mb.ILinkedEntitiesWork): Promise<mb.IWorkList>;
     postRecording(xmlMetadata: XmlMetadata): Promise<void>;
     post(entity: mb.EntityType, xmlMetadata: XmlMetadata): Promise<void>;
     /**

package/lib/musicbrainz.types.d.ts

@@ -18,6 +18,12 @@ export interface LifeSpan {
     begin: null | string;
     end: null | string;
 }
+export interface IAnnotation {
+    entity: string;
+    name: string;
+    text: string;
+    type: string;
+}
 export interface IArea extends ITypedEntity {
     type: 'Country' | 'Subdivision' | 'Municipality' | 'City' | 'District' | 'Island';
     'iso-3166-1-codes'?: string[];
@@ -61,6 +67,13 @@ export interface IArtist extends ITypedEntity {
     releases?: IRelease[];
     'release-groups'?: IReleaseGroup[];
 }
+export interface ICdStub {
+    id: string;
+    title: string;
+    artist: string;
+    barcode: string;
+    comment: string;
+}
 export interface IArtistCredit {
     artist: IArtist;
     joinphrase: string;
@@ -115,6 +128,7 @@ export interface IRelease extends IEntity {
     'release-group'?: IReleaseGroup;
     collections?: ICollection[];
     'track-count'?: number;
+    count?: number;
 }
 export interface IReleaseEvent {
     area?: IArea;
@@ -174,42 +188,73 @@ export interface IReleaseGroup extends IEntity {
     }[];
     releases?: IRelease[];
 }
-export interface IAreaMatch extends IArea, IMatch {
-}
-export interface IArtistMatch extends IArtist, IMatch {
-}
-export interface IRecordingMatch extends IRecording, IMatch {
-}
-export interface IReleaseGroupMatch extends IReleaseGroup, IMatch {
-}
-export interface IReleaseMatch extends IRelease, IMatch {
-    count: number;
-}
 export interface ISearchResult {
     created: DateTimeFormat;
     count: number;
     offset: number;
 }
-export interface IArtistList extends ISearchResult {
-    artists: IArtistMatch[];
+export type IAnnotationMatch = IAnnotation & IMatch;
+export interface IAnnotationList extends ISearchResult {
+    annotations: IAnnotationMatch[];
 }
+export type IAreaMatch = IArea & IMatch;
 export interface IAreaList extends ISearchResult {
     areas: IAreaMatch[];
 }
+export type IArtistMatch = IArtist & IMatch;
+export interface IArtistList extends ISearchResult {
+    artists: IArtistMatch[];
+}
+export type ICdStubMatch = ICdStub & IMatch;
+export interface ICdStubList extends ISearchResult {
+    cdstubs: ICdStubMatch[];
+}
+export type IEventMatch = IEvent & IMatch;
+export interface IEventList extends ISearchResult {
+    events: IEventMatch[];
+}
+export type IInstrumentMatch = IInstrument & IMatch;
+export interface IInstrumentList extends ISearchResult {
+    instruments: IInstrumentMatch[];
+}
+export type ILabelMatch = ILabel & IMatch;
+export interface ILabelList extends ISearchResult {
+    labels: ILabelMatch[];
+}
+export type IPlacesMatch = IPlace & IMatch;
+export interface IPlaceList extends ISearchResult {
+    places: IPlacesMatch[];
+}
+export type IReleaseMatch = IRelease & IMatch;
 export interface IReleaseList extends ISearchResult {
     releases: IReleaseMatch[];
     'release-count': number;
 }
+export type IRecordingMatch = IRecording & IMatch;
 export interface IRecordingList extends ISearchResult {
     recordings: IRecordingMatch[];
     'recordings-count': number;
 }
+export type IReleaseGroupMatch = IReleaseGroup & IMatch;
 export interface IReleaseGroupList extends ISearchResult {
     'release-groups': IReleaseGroupMatch[];
 }
+export type ISeriesGroupMatch = ISeries & IMatch;
+export interface ISeriesList extends ISearchResult {
+    series: ISeriesGroupMatch[];
+}
+export type ITagMatch = ITag & IMatch;
+export interface ITagList extends ISearchResult {
+    tags: ITagMatch[];
+}
+export type IUrlMatch = IUrl & IMatch;
 export interface IUrlList extends ISearchResult {
     urls: IUrlMatch[];
 }
+export type IWorkMatch = IWork & IMatch;
+export interface IWorkList extends ISearchResult {
+    works: IWorkMatch[];
+}
 export type RelationDirection = 'backward' | 'forward';
 export interface IRelation {
     artist?: IArtist;
@@ -253,30 +298,28 @@ export interface ISeries extends ITypedEntity {
     name: string;
     disambiguation: string;
 }
+export interface ITag {
+    name: string;
+}
 export interface IUrl extends IEntity {
     id: string;
     resource: string;
     relations?: IRelationList[];
 }
-export interface IUrlMatch extends IMatch, IUrl {
-}
-export interface IUrlSearchResult extends ISearchResult {
-    urls: IUrlMatch[];
-}
-export interface IIsrcSearchResult extends ISearchResult {
-    'isrc': string;
-    'recordings': IRecording[];
-}
 export interface IExernalIds {
     [type: string]: string;
 }
 export interface IReleaseSearchResult extends ISearchResult {
     releases: IRelease[];
 }
+/**
+ * Entities without MBID
+ */
+export type OtherEntityTypes = 'annotation' | 'cdstub' | 'tag';
 /**
  * https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#Subqueries
  */
-export type EntityType = 'area' | 'artist' | 'collection' | 'event' | 'instrument' | 'label' | 'place' | 'recording' | 'release' | 'release-group' | 'series' | 'work' | 'url';
+export type EntityType = 'annotation' | '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,
@@ -375,6 +418,13 @@ export interface ILinkedEntitiesLabel {
     collection?: string;
     release?: string;
 }
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/place             area, collection, release
+ */
+export interface ILinkedEntitiesPlace {
+    place?: string;
+}
 /**
  * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
  * /ws/2/place             area, collection

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": {
     "node": {