musicbrainz-api 0.5.2 → 0.7.2

package/lib/musicbrainz.types.d.ts

@@ -1,252 +1,379 @@
-import DateTimeFormat = Intl.DateTimeFormat;
-export interface IPeriod {
-    'begin': string;
-    'ended': boolean;
-    'end': string;
-}
-export interface IArea {
-    id: string;
-    'iso-3166-1-codes': string[];
-    name: string;
-    'sort-name': string;
-    disambiguation: string;
-}
-export interface IAlias {
-    name: string;
-    'sort-name': string;
-    ended: boolean;
-    'type-id': string;
-    type: string;
-    locale: string;
-    primary: string;
-    begin: string;
-    end: string;
-}
-export interface IMatch {
-    score: number;
-}
-export interface IArtist {
-    id: string;
-    name: string;
-    disambiguation: string;
-    'sort-name': string;
-    'type-id'?: string;
-    'gender-id'?: any;
-    'life-span'?: IPeriod;
-    country?: string;
-    ipis?: any[];
-    isnis?: string[];
-    aliases?: IAlias[];
-    gender?: null;
-    type?: string;
-    area?: IArea;
-    begin_area?: IArea;
-    end_area?: IArea;
-    relations?: IRelation[];
-    /**
-     * Only defined if 'releases' are includes
-     */
-    releases?: IRelease[];
-}
-export interface IArtistCredit {
-    artist: IArtist;
-    joinphrase: string;
-    name: string;
-}
-export declare type ReleaseQuality = 'normal';
-export interface IRelease {
-    id: string;
-    title: string;
-    'text-representation': {
-        'language': string;
-        'script': string;
-    };
-    disambiguation: string;
-    asin: string;
-    'status-id': string;
-    packaging?: string;
-    status: string;
-    'packaging-id'?: string;
-    'release-events'?: IReleaseEvent[];
-    date: string;
-    media: IMedium[];
-    'cover-art-archive': ICoverArtArchive;
-    country: string;
-    quality: string;
-    barcode: string;
-    relations?: IRelation[];
-    'artist-credit'?: IArtistCredit[];
-    'release-group'?: IReleaseGroup;
-}
-export interface IReleaseEvent {
-    area?: IArea;
-    date?: string;
-}
-export declare type MediaFormatType = 'Digital Media';
-export interface IRecording {
-    id: string;
-    video: boolean;
-    length: number;
-    title: string;
-    disambiguation: string;
-    isrcs?: string[];
-    releases?: IRelease;
-    relations?: IRelation[];
-    'artist-credit'?: IArtistCredit[];
-    aliases?: IAlias[];
-}
-export interface ITrack {
-    id: string;
-    position: number;
-    recording: IRecording;
-    number: string;
-    length: number;
-    title: string;
-    'artist-credit'?: IArtistCredit[];
-}
-export interface IMedium {
-    title: string;
-    format?: string;
-    'format-id': string;
-    'tracks': ITrack[];
-    'track-count': number;
-    'track-offset': number;
-    'position': number;
-}
-export interface ICoverArtArchive {
-    count: number;
-    front: boolean;
-    darkened: boolean;
-    artwork: boolean;
-    back: boolean;
-}
-export interface IReleaseGroup {
-    id: string;
-    count: number;
-    title: string;
-    'primary-type': string;
-    'sort-name': string;
-    'artist-credit': Array<{
-        artist: IArtist;
-    }>;
-    releases?: IRelease[];
-}
-export interface IArtistMatch extends IArtist, IMatch {
-}
-export interface IReleaseGroupMatch extends IReleaseGroup, IMatch {
-}
-export interface IReleaseMatch extends IRelease, IMatch {
-}
-export interface IAreaMatch extends IArea, IMatch {
-}
-export interface ISearchResult {
-    created: DateTimeFormat;
-    count: number;
-    offset: number;
-}
-export interface IArtistList extends ISearchResult {
-    artists: IArtistMatch[];
-}
-export interface IAreaList extends ISearchResult {
-    areas: IAreaMatch[];
-}
-export interface IReleaseList extends ISearchResult {
-    releases: IReleaseMatch[];
-}
-export interface IReleaseGroupList extends ISearchResult {
-    'release-groups': IReleaseGroupMatch[];
-}
-export interface IUrlList extends ISearchResult {
-    urls: IUrlMatch[];
-}
-export declare type RelationDirection = 'backward' | 'forward';
-export interface IRelation {
-    'attribute-ids': {};
-    direction: RelationDirection;
-    'target-credit': string;
-    end: null | object;
-    'source-credit': string;
-    ended: boolean;
-    'attribute-values': object;
-    attributes?: any[];
-    type: string;
-    begin?: null | object;
-    'target-type'?: 'url';
-    'type-id': string;
-    url?: IURL;
-    release?: IRelease;
-}
-export interface IURL {
-    id: string;
-    resource: string;
-}
-export interface IRelationList {
-    relations: IRelation[];
-}
-export interface IWork {
-    id: string;
-    title: string;
-}
-export interface ILabel {
-    id: string;
-    name: string;
-}
-export interface IUrl {
-    id: string;
-    resource: string;
-    'relation-list': IRelationList[];
-}
-export interface IUrlMatch extends IMatch, IUrl {
-}
-export interface IUrlSearchResult extends ISearchResult {
-    urls?: IUrlMatch[];
-}
-export interface IIsrcSearchResult {
-    'isrc': string;
-    'recordings': IRecording[];
-}
-export interface IExernalIds {
-    [type: string]: string;
-}
-export interface IReleaseSearchResult extends ISearchResult {
-    releases: IRelease[];
-}
-/**
- * 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 declare enum LinkType {
-    license = 302,
-    production = 256,
-    samples_IMDb_entry = 258,
-    get_the_music = 257,
-    purchase_for_download = 254,
-    download_for_free = 255,
-    stream_for_free = 268,
-    crowdfunding_page = 905,
-    other_databases = 306,
-    Allmusic = 285
-}
-/**
- * https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Artist
- */
-export interface IPagination {
-    /**
-     * Return search results starting at a given offset. Used for paging through more than one page of results.
-     */
-    offset?: number;
-    /**
-     * An integer value defining how many entries should be returned. Only values between 1 and 100 (both inclusive) are allowed. If not given, this defaults to 25.
-     */
-    limit?: number;
-}
-/**
- * https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Artist
- */
-export interface ISearchQuery extends IPagination {
-    /**
-     * Lucene search query, this is mandatory
-     */
-    query: string;
-}
+import DateTimeFormat = Intl.DateTimeFormat;
+import { IFormData, Includes } from './musicbrainz-api';
+export interface IPeriod {
+    'begin': string;
+    'ended': boolean;
+    'end': string;
+}
+export interface IArea {
+    id: string;
+    'iso-3166-1-codes': string[];
+    name: string;
+    'sort-name': string;
+    disambiguation: string;
+}
+export interface IAlias {
+    name: string;
+    'sort-name': string;
+    ended: boolean;
+    'type-id': string;
+    type: string;
+    locale: string;
+    primary: string;
+    begin: string;
+    end: string;
+}
+export interface IMatch {
+    score: number;
+}
+export interface IArtist {
+    id: string;
+    name: string;
+    disambiguation: string;
+    'sort-name': string;
+    'type-id'?: string;
+    'gender-id'?: any;
+    'life-span'?: IPeriod;
+    country?: string;
+    ipis?: any[];
+    isnis?: string[];
+    aliases?: IAlias[];
+    gender?: null;
+    type?: string;
+    area?: IArea;
+    begin_area?: IArea;
+    end_area?: IArea;
+    relations?: IRelation[];
+    /**
+     * Only defined if 'releases' are includes
+     */
+    releases?: IRelease[];
+    'release-groups'?: IReleaseGroup[];
+}
+export interface IArtistCredit {
+    artist: IArtist;
+    joinphrase: string;
+    name: string;
+}
+export declare type ReleaseQuality = 'normal';
+export interface IRelease {
+    id: string;
+    title: string;
+    'text-representation': {
+        'language': string;
+        'script': string;
+    };
+    disambiguation: string;
+    asin: string;
+    'status-id': string;
+    packaging?: string;
+    status: string;
+    'packaging-id'?: string;
+    'release-events'?: IReleaseEvent[];
+    date: string;
+    media: IMedium[];
+    'cover-art-archive': ICoverArtArchive;
+    country: string;
+    quality: string;
+    barcode: string;
+    relations?: IRelation[];
+    'artist-credit'?: IArtistCredit[];
+    'release-group'?: IReleaseGroup;
+}
+export interface IReleaseEvent {
+    area?: IArea;
+    date?: string;
+}
+export declare type MediaFormatType = 'Digital Media';
+export interface IRecording {
+    id: string;
+    video: boolean;
+    length: number;
+    title: string;
+    disambiguation: string;
+    isrcs?: string[];
+    releases?: IRelease;
+    relations?: IRelation[];
+    'artist-credit'?: IArtistCredit[];
+    aliases?: IAlias[];
+}
+export interface ITrack {
+    id: string;
+    position: number;
+    recording: IRecording;
+    number: string;
+    length: number;
+    title: string;
+    'artist-credit'?: IArtistCredit[];
+}
+export interface IMedium {
+    title: string;
+    format?: string;
+    'format-id': string;
+    'tracks': ITrack[];
+    'track-count': number;
+    'track-offset': number;
+    'position': number;
+}
+export interface ICoverArtArchive {
+    count: number;
+    front: boolean;
+    darkened: boolean;
+    artwork: boolean;
+    back: boolean;
+}
+export interface IReleaseGroup {
+    id: string;
+    count: number;
+    title: string;
+    'primary-type': string;
+    'sort-name': string;
+    'artist-credit': [{
+        artist: IArtist;
+    }];
+    releases?: IRelease[];
+}
+export interface IArtistMatch extends IArtist, IMatch {
+}
+export interface IReleaseGroupMatch extends IReleaseGroup, IMatch {
+}
+export interface IReleaseMatch extends IRelease, IMatch {
+}
+export interface IAreaMatch extends IArea, IMatch {
+}
+export interface ISearchResult {
+    created: DateTimeFormat;
+    count: number;
+    offset: number;
+}
+export interface IArtistList extends ISearchResult {
+    artists: IArtistMatch[];
+}
+export interface IAreaList extends ISearchResult {
+    areas: IAreaMatch[];
+}
+export interface IReleaseList extends ISearchResult {
+    releases: IReleaseMatch[];
+}
+export interface IReleaseGroupList extends ISearchResult {
+    'release-groups': IReleaseGroupMatch[];
+}
+export interface IUrlList extends ISearchResult {
+    urls: IUrlMatch[];
+}
+export declare type RelationDirection = 'backward' | 'forward';
+export interface IRelation {
+    'attribute-ids': {};
+    direction: RelationDirection;
+    'target-credit': string;
+    end: null | object;
+    'source-credit': string;
+    ended: boolean;
+    'attribute-values': object;
+    attributes?: any[];
+    type: string;
+    begin?: null | object;
+    'target-type'?: 'url';
+    'type-id': string;
+    url?: IURL;
+    release?: IRelease;
+}
+export interface IURL {
+    id: string;
+    resource: string;
+}
+export interface IRelationList {
+    relations: IRelation[];
+}
+export interface IWork {
+    id: string;
+    title: string;
+}
+export interface ILabel {
+    id: string;
+    name: string;
+}
+export interface IUrl {
+    id: string;
+    resource: string;
+    'relation-list': IRelationList[];
+}
+export interface IUrlMatch extends IMatch, IUrl {
+}
+export interface IUrlSearchResult extends ISearchResult {
+    urls?: IUrlMatch[];
+}
+export interface IIsrcSearchResult {
+    'isrc': string;
+    'recordings': IRecording[];
+}
+export interface IExernalIds {
+    [type: string]: string;
+}
+export interface IReleaseSearchResult extends ISearchResult {
+    releases: IRelease[];
+}
+/**
+ * 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 declare enum LinkType {
+    license = 302,
+    production = 256,
+    samples_IMDb_entry = 258,
+    get_the_music = 257,
+    purchase_for_download = 254,
+    download_for_free = 255,
+    stream_for_free = 268,
+    crowdfunding_page = 905,
+    other_databases = 306,
+    Allmusic = 285
+}
+/**
+ * https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Artist
+ */
+export interface IPagination {
+    /**
+     * Return search results starting at a given offset. Used for paging through more than one page of results.
+     */
+    offset?: number;
+    /**
+     * An integer value defining how many entries should be returned. Only values between 1 and 100 (both inclusive) are allowed. If not given, this defaults to 25.
+     */
+    limit?: number;
+}
+/**
+ * https://wiki.musicbrainz.org/Development/XML_Web_Service/Version_2/Search#Artist
+ */
+export interface ISearchQuery extends IPagination {
+    /**
+     * Lucene search query, this is mandatory
+     */
+    query?: string | IFormData;
+    inc?: Includes[];
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Browse
+ * /ws/2/area              collection
+ */
+export interface ILinkedEntitiesArea {
+    collection?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Browse
+ * /ws/2/artist            area, collection, recording, release, release-group, work
+ */
+export interface ILinkedEntitiesArtist {
+    area?: string;
+    collection?: string;
+    recording?: string;
+    release?: string;
+    'release-group'?: string;
+    work?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Browse
+ * /ws/2/collection        area, artist, editor, event, label, place, recording, release, release-group, work
+ */
+export interface ILinkedEntitiesCollection {
+    area?: string;
+    artist?: string;
+    editor?: string;
+    event?: string;
+    label?: string;
+    place?: string;
+    recording?: string;
+    release?: string;
+    'release-group'?: string;
+    work?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/event             area, artist, collection, place
+ */
+export interface ILinkedEntitiesEvent {
+    area?: string;
+    artist?: string;
+    collection?: string;
+    place?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/instrument        collection
+ */
+export interface ILinkedEntitiesInstrument {
+    collection?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/label             area, collection, release
+ */
+export interface ILinkedEntitiesLabel {
+    area?: string;
+    collection?: string;
+    release?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/place             area, collection
+ */
+export interface IBrowseArgumentPlace {
+    area?: string;
+    collection?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/recording         artist, collection, release, work
+ */
+export interface ILinkedEntitiesRecording {
+    area?: string;
+    collection?: string;
+    release?: string;
+    work?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/release           area, artist, collection, label, track, track_artist, recording, release-group
+ */
+export interface ILinkedEntitiesRelease {
+    area?: string;
+    artist?: string;
+    collection?: string;
+    label?: string;
+    track?: string;
+    track_artist?: string;
+    recording?: string;
+    'release-group'?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/release-group     artist, collection, release
+ */
+export interface ILinkedEntitiesReleaseGroup {
+    artist?: string;
+    collection?: string;
+    release?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Subqueries
+ * /ws/2/series            collection
+ */
+export interface ILinkedEntitiesSeries {
+    collection?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Browse
+ * /ws/2/work              artist, collection
+ */
+export interface ILinkedEntitiesWork {
+    artist?: string;
+    collection?: string;
+}
+/**
+ * https://musicbrainz.org/doc/MusicBrainz_API#Browse
+ * /ws/2/url               resource
+ */
+export interface ILinkedEntitiesUrl {
+    resource?: string;
+}

package/lib/musicbrainz.types.js

@@ -1,16 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var LinkType;
-(function (LinkType) {
-    LinkType[LinkType["license"] = 302] = "license";
-    LinkType[LinkType["production"] = 256] = "production";
-    LinkType[LinkType["samples_IMDb_entry"] = 258] = "samples_IMDb_entry";
-    LinkType[LinkType["get_the_music"] = 257] = "get_the_music";
-    LinkType[LinkType["purchase_for_download"] = 254] = "purchase_for_download";
-    LinkType[LinkType["download_for_free"] = 255] = "download_for_free";
-    LinkType[LinkType["stream_for_free"] = 268] = "stream_for_free";
-    LinkType[LinkType["crowdfunding_page"] = 905] = "crowdfunding_page";
-    LinkType[LinkType["other_databases"] = 306] = "other_databases";
-    LinkType[LinkType["Allmusic"] = 285] = "Allmusic";
-})(LinkType = exports.LinkType || (exports.LinkType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkType = void 0;
+var LinkType;
+(function (LinkType) {
+    LinkType[LinkType["license"] = 302] = "license";
+    LinkType[LinkType["production"] = 256] = "production";
+    LinkType[LinkType["samples_IMDb_entry"] = 258] = "samples_IMDb_entry";
+    LinkType[LinkType["get_the_music"] = 257] = "get_the_music";
+    LinkType[LinkType["purchase_for_download"] = 254] = "purchase_for_download";
+    LinkType[LinkType["download_for_free"] = 255] = "download_for_free";
+    LinkType[LinkType["stream_for_free"] = 268] = "stream_for_free";
+    LinkType[LinkType["crowdfunding_page"] = 905] = "crowdfunding_page";
+    LinkType[LinkType["other_databases"] = 306] = "other_databases";
+    LinkType[LinkType["Allmusic"] = 285] = "Allmusic";
+})(LinkType = exports.LinkType || (exports.LinkType = {}));
 //# sourceMappingURL=musicbrainz.types.js.map