musicbrainz-api 1.1.0 → 1.2.1

package/README.md

@@ -6,8 +6,6 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2bc47b2006454bae8c737991f152e518)](https://app.codacy.com/gh/Borewit/musicbrainz-api/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Known Vulnerabilities](https://snyk.io/test/github/Borewit/musicbrainz-api/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Borewit/musicbrainz-api?targetFile=package.json)
 [![DeepScan grade](https://deepscan.io/api/teams/5165/projects/6991/branches/63373/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5165&pid=6991&bid=63373)
-[![Discord](https://img.shields.io/discord/460524735235883049.svg)](https://discord.gg/958xT5X)
-[![bundlejs.com badge](https://deno.bundlejs.com/?q=musicbrainz-api&badge)](https://bundlejs.com/?q=musicbrainz-api)
 
 # musicbrainz-api
 

package/lib/entry-node.js

@@ -1,3 +1,2 @@
 export * from './coverartarchive-api.js';
 export * from './musicbrainz-api-node.js';
-//# sourceMappingURL=entry-node.js.map

package/lib/musicbrainz-api.d.ts

@@ -7,7 +7,7 @@ export { XmlIsrc } from './xml/xml-isrc.js';
 export { XmlIsrcList } from './xml/xml-isrc-list.js';
 export { XmlRecording } from './xml/xml-recording.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 RelationsIncludes = 'area-rels' | 'artist-rels' | 'event-rels' | 'genre-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

package/lib/musicbrainz.types.d.ts

@@ -24,7 +24,7 @@ export interface IAnnotation {
     text: string;
     type: string;
 }
-export interface IArea extends ITypedEntity {
+export interface IArea extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres {
     type: 'Country' | 'Subdivision' | 'Municipality' | 'City' | 'District' | 'Island';
     'iso-3166-1-codes'?: string[];
     primary: boolean;
@@ -46,7 +46,7 @@ export interface IMatch {
     score: number;
 }
 export type Gender = 'male' | 'female' | 'other' | 'not applicable';
-export interface IArtist extends ITypedEntity, IMayHaveRelations {
+export interface IArtist extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
     name: string;
     disambiguation: string;
     'sort-name': string;
@@ -60,9 +60,6 @@ export interface IArtist extends ITypedEntity, IMayHaveRelations {
     area?: IArea;
     begin_area?: IArea;
     end_area?: IArea;
-    genres?: IGenre[];
-    tags?: IArtistTag[];
-    rating?: IRating;
     /**
      * Only defined if 'releases' are includes
      */
@@ -88,7 +85,7 @@ export interface ICollection extends ITypedEntity {
     editor: string;
     'entity-type': string;
 }
-export interface IEvent extends ITypedEntity {
+export interface IEvent extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
     cancelled: boolean;
     'life-span': IPeriod;
     disambiguation: string;
@@ -97,7 +94,7 @@ export interface IEvent extends ITypedEntity {
     name: string;
 }
 export type InstrumentType = 'Wind instrument' | 'String instrument' | 'Percussion instrument' | 'Electronic instrument' | 'Family' | 'Ensemble' | 'Other instrument';
-export interface IInstrument extends ITypedEntity {
+export interface IInstrument extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres {
     disambiguation: string;
     name: string;
     type: InstrumentType;
@@ -106,7 +103,7 @@ export interface IInstrument extends ITypedEntity {
 export type ReleaseQuality = 'normal' | 'high';
 export type ReleaseStatus = 'Official' | 'Promotion' | 'Bootleg' | 'Pseudo-release' | 'Withdrawn' | 'Expunged' | 'Cancelled';
 export type ReleasePackaging = 'Book' | 'Box' | 'Cardboard/Paper Sleeve' | 'Cassette Case' | 'Clamshell Case' | 'Digibook' | 'Digifile' | 'Digipak' | 'Discbox Slider' | 'Fatbox' | 'Gatefold Cover' | 'Jewel case' | 'Keep Case' | 'Longbox' | 'Metal Tin' | 'Plastic sleeve' | 'Slidepack' | 'Slim Jewel Case' | 'Snap Case' | 'SnapPack' | 'Super Jewel Box' | 'Other' | 'None';
-export interface IRelease extends IEntity, IMayHaveRelations {
+export interface IRelease extends IEntity, IMayHaveRelations, IMayHaveTagsAndGenres {
     title: string;
     'text-representation': {
         'language': string;
@@ -130,13 +127,14 @@ export interface IRelease extends IEntity, IMayHaveRelations {
     collections?: ICollection[];
     'track-count'?: number;
     count?: number;
+    'label-info'?: ILabelInfo[];
 }
 export interface IReleaseEvent {
     area?: IArea;
     date?: string;
 }
 export type MediaFormatType = 'Digital Media';
-export interface IRecording extends IEntity, IMayHaveRelations {
+export interface IRecording extends IEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
     video: boolean;
     length: number;
     title: string;
@@ -171,7 +169,7 @@ export interface ICoverArtArchive {
     artwork: boolean;
     back: boolean;
 }
-export interface IReleaseGroup extends IEntity {
+export interface IReleaseGroup extends IEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
     count: number;
     disambiguation?: string;
     title: string;
@@ -221,6 +219,10 @@ export type ILabelMatch = ILabel & IMatch;
 export interface ILabelList extends ISearchResult {
     labels: ILabelMatch[];
 }
+export interface ILabelInfo {
+    label: ILabel | null;
+    'catalog-number': string | null;
+}
 export type IPlacesMatch = IPlace & IMatch;
 export interface IPlaceList extends ISearchResult {
     places: IPlacesMatch[];
@@ -272,29 +274,55 @@ export interface IRelation {
     'type-id': string;
     url?: IUrl;
     release?: IRelease;
+    area?: IArea;
+    event?: IEvent;
+    genre?: IGenre;
+    instrument?: IInstrument;
+    label?: ILabel;
+    place?: IPlace;
+    recording?: IRecording;
+    release_group?: IReleaseGroup;
+    series?: ISeries;
+    work?: IWork;
 }
 export interface IMayHaveRelations {
     relations?: IRelation[];
 }
-export interface IWork extends IEntity {
+export interface IWork extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
     title: string;
+    disambiguation: string;
+    language: string;
+    languages: string[];
+    iswcs: string[];
+    attributes: IWorkAttribute[];
 }
-export interface ILabel extends IEntity {
-    asin: null | string;
-    barcode: null | string;
-    country: null | string;
+export interface IWorkAttribute extends ITypedEntity {
+    value: string;
+}
+export interface ILabel extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
+    country?: null | string;
     name: string;
     'sort-name': string;
-    'life-span': LifeSpan;
+    'life-span'?: LifeSpan;
     disambiguation?: string;
     'label-code': null | string;
-    ipis: string[];
-    area: IArea;
+    ipis?: string[];
+    isnis?: string[];
+    area?: IArea;
 }
-export interface IPlace extends IEntity {
+export interface IPlace extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres, IMayHaveRating {
     name: string;
+    disambiguation: string;
+    address: string;
+    coordinates: ICoordinates | null;
+    'life-span': LifeSpan;
+    area: IArea | null;
+}
+export interface ICoordinates {
+    latitude: number;
+    longitude: number;
 }
-export interface ISeries extends ITypedEntity {
+export interface ISeries extends ITypedEntity, IMayHaveRelations, IMayHaveTagsAndGenres {
     name: string;
     disambiguation: string;
 }
@@ -304,15 +332,22 @@ export interface ITag {
 export interface IUserVote {
     count: number;
 }
-export type IArtistTag = ITag & IUserVote;
+export type IUserTag = ITag & IUserVote;
 export interface IGenre extends IEntity, IUserVote {
     name: string;
     disambiguation: string;
 }
+export interface IMayHaveTagsAndGenres {
+    tags?: IUserTag[];
+    genres?: IGenre[];
+}
 export interface IRating {
     value: number | null;
     'votes-count': number;
 }
+export interface IMayHaveRating {
+    rating?: IRating;
+}
 export interface IUrl extends IEntity, IMayHaveRelations {
     id: string;
     resource: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicbrainz-api",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "MusicBrainz API client for reading and submitting metadata",
   "exports": {
     "node": {
@@ -58,10 +58,10 @@
     "rate-limit-threshold": "^0.2.0",
     "spark-md5": "^3.0.2",
     "tough-cookie": "^5.0.0",
-    "uuid": "^13.0.0"
+    "uuid": "^14.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.3.14",
+    "@biomejs/biome": "2.4.14",
     "@types/chai": "^5.0.0",
     "@types/jsontoxml": "^1.0.5",
     "@types/mocha": "^10.0.4",
@@ -71,7 +71,7 @@
     "@types/spark-md5": "^3",
     "@types/tough-cookie": "^4.0.5",
     "@types/uuid": "^11.0.0",
-    "c8": "^10.1.2",
+    "c8": "^11.0.0",
     "chai": "^6.2.0",
     "del-cli": "^7.0.0",
     "mocha": "^11.0.1",
@@ -80,23 +80,27 @@
     "sinon": "^21.0.0",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.4"
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "clean": "del-cli 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'test/**/*.js' 'test/**/*.js.map'",
-    "compile-lib": "tsc -p lib",
+    "compile-lib:dev": "tsc -p lib/tsconfig.json",
+    "compile-lib:prod": "tsc -p lib/tsconfig.prod.json",
     "compile-test": "tsc -p test",
-    "compile": "yarn run compile-lib && yarn run compile-test",
+    "compile:dev": "yarn run compile-lib:dev && yarn run compile-test",
+    "compile:prod": "yarn run compile-lib:prod && yarn run compile-test",
     "lint:md": "remark -u preset-lint-recommended .",
     "lint:ts": "biome check",
     "lint:fix": "biome check --write",
     "lint": "yarn run lint:md && yarn run lint:ts",
-    "test": "mocha",
-    "build": "yarn run clean && yarn run compile",
+    "test": "TS_NODE_PROJECT=test/tsconfig.json mocha",
+    "build:dev": "yarn run clean && yarn run compile:dev",
+    "build:prod": "yarn run clean && yarn run compile:prod",
+    "build": "yarn run build:prod",
     "start": "yarn run compile && yarn run lint && yarn run cover-test",
     "test-coverage": "c8 yarn run test",
     "send-codacy": "c8 report --reporter=text-lcov | codacy-coverage",
-    "prepublishOnly": "yarn run build",
+    "prepublishOnly": "yarn run build:prod",
     "update-biome": "yarn add -D --exact @biomejs/biome && npx @biomejs/biome migrate --write && npm run lint:fix"
   },
   "nyc": {