musicbrainz-api 0.18.1 → 0.19.0

package/README.md

@@ -11,7 +11,9 @@
 
 # musicbrainz-api
 
-A MusicBrainz-API-client for reading and submitting metadata
+A MusicBrainz-API-client for reading and submitting metadata.
+
+<img src="doc/musicbrainz-api-logo.png" width="40%" style="center"></img>
 
 ## Features
 - **Access Metadata**: Retrieve detailed metadata from the [MusicBrainz database](https://musicbrainz.org/).
@@ -24,6 +26,9 @@ A MusicBrainz-API-client for reading and submitting metadata
 Module: version 8 migrated from [CommonJS](https://en.wikipedia.org/wiki/CommonJS) to [pure ECMAScript Module (ESM)](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
 The distributed JavaScript codebase is compliant with the [ECMAScript 2020 (11th Edition)](https://en.wikipedia.org/wiki/ECMAScript_version_history#11th_Edition_%E2%80%93_ECMAScript_2020) standard.
 
+> [!NOTE]
+> See also [CommonJS backward compatibility](#commonjs-backward-compatibility)
+
 ### Requirements
 - Node.js: Requires [Node.js version 16](https://nodejs.org/en/about/previous-releases) or higher.
 - Browser: Can be used in browser environments when bundled with a module bundler (not actively tested).
@@ -66,6 +71,9 @@ const mbApi = new MusicBrainzApi({
 });
 ```
 
+> [!NOTE]
+> See also [CommonJS backward compatibility](#commonjs-backward-compatibility)
+
 ### Configuration Options
 
 ```js
@@ -463,3 +471,29 @@ async function getCoverArt(releaseGroupMbid, coverType = '') {
 
 ```
 
+## CommonJS backward compatibility
+
+For legacy CommonJS projects needing to load the `music-metadata` ESM module, you can use the `loadMusicMetadata` function:
+```js
+const { loadMusicBrainzApi } = require('musicbrainz-api');
+
+(async () => {
+
+    // Dynamically loads the ESM module in a CommonJS project
+    const  {MusicBrainzApi} = await loadMusicBrainzApi();
+
+    const mbApi = new MusicBrainzApi({
+        appName: 'my-app',
+        appVersion: '0.1.0',
+        appContactInfo: 'user@mail.org',
+    });
+
+    const releaseList = await mbApi.search('release', {query: {barcode: 602537479870}});
+    for(const release of releaseList.releases) {
+        console.log(release.title);
+    }
+})();
+```
+
+> [!NOTE]
+> The `loadMusicMetadata` function is experimental.

package/lib/default.cjs

@@ -0,0 +1,5 @@
+// CommonJS entry point
+"use strict";
+module.exports = {
+  loadMusicBrainzApi: () => import('./index.js'),
+};

package/lib/index.d.ts

@@ -1,2 +1,6 @@
 export * from './coverartarchive-api.js';
 export * from './musicbrainz-api.js';
+/**
+ * CommonJS (only) function to load `musicbrainz-api` ESM module
+ */
+export declare function loadMusicBrainzApi(): Promise<typeof import('musicbrainz-api')>;

package/lib/musicbrainz-api.d.ts

@@ -50,7 +50,7 @@ export interface IMusicBrainzConfig {
         username?: string;
         password?: string;
     };
-    baseUrl: string;
+    baseUrl?: string;
     appName?: string;
     appVersion?: string;
     /**
@@ -63,6 +63,9 @@ export interface IMusicBrainzConfig {
     appContactInfo?: string;
     disableRateLimiting?: boolean;
 }
+interface IInternalConfig extends IMusicBrainzConfig {
+    baseUrl: string;
+}
 export interface ICsrfSession {
     sessionKey: string;
     token: string;
@@ -72,7 +75,7 @@ export interface ISessionInformation {
     loggedIn?: boolean;
 }
 export declare class MusicBrainzApi {
-    readonly config: IMusicBrainzConfig;
+    readonly config: IInternalConfig;
     private rateLimiter;
     private httpClient;
     private session?;

package/lib/musicbrainz-api.js

@@ -30,9 +30,11 @@ export class MusicBrainzApi {
     }
     constructor(_config) {
         this.config = {
-            baseUrl: 'https://musicbrainz.org'
+            ...{
+                baseUrl: 'https://musicbrainz.org'
+            },
+            ..._config
         };
-        Object.assign(this.config, _config);
         this.httpClient = new HttpClient({
             baseUrl: this.config.baseUrl,
             timeout: 20 * 1000,

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "musicbrainz-api",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "description": "MusicBrainz API client for reading and submitting metadata",
-  "exports": "./lib/index.js",
+  "exports": {
+    "import": "./lib/index.js",
+    "require": "./lib/default.cjs"
+  },
   "types": "lib/index.d.ts",
   "files": [
     "lib/**/*.js",
-    "lib/**/*.d.ts"
+    "lib/**/*.d.ts",
+    "lib/default.cjs"
   ],
   "type": "module",
   "author": {