museria 0.2.48 → 0.3.1

package/.eslintrc

@@ -1,6 +1,14 @@
 {
+  "parser": "@babel/eslint-parser",
   "parserOptions": {
-    "ecmaVersion": 2019
+    "ecmaVersion": 2021,
+    "sourceType": "module",
+    "requireConfigFile": false,
+    "babelOptions": {
+      "plugins": [
+        "@babel/plugin-syntax-import-assertions"
+      ]
+    }
   },
   "env": {
     "browser": true,
@@ -12,4 +20,4 @@
     "no-console": "warn"
   },
   "globals": {}
-}
+}

package/.github/workflows/build.yml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Run tests with ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install -g npm

package/.github/workflows/publish.yml

@@ -6,10 +6,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - run: npm install -g npm
       - run: npm ci
       - run: npm ddp

package/README.md

@@ -5,67 +5,63 @@ Museria is a decentralized music storage based on [spreadable](https://github.co
 There is [an article here](https://ortex.medium.com/museria-a-decentralized-music-storage-dc2041a5f196) with an explanation. 
 
 ```javascript
-const Node = require('museria').Node;
-
-(async () => {
-  try {
-    const node = new Node({
-      port: 4000,
-      hostname: 'localhost'
-    });
-    await node.init();
-  }
-  catch(err) {
-    console.error(err.stack);
-    process.exit(1);
-  }
-})();
+import { Node } from 'museria';
+
+try {
+  const node = new Node({
+    port: 4000,
+    hostname: 'localhost'
+  });
+  await node.init();
+}
+catch(err) {
+  console.error(err.stack);
+  process.exit(1);
+}
 ```
 
 ```javascript
-const Client = require('museria').Client;
-const utils = require('museria/src/utils');
-
-(async () => {  
-  try {
-    const client = new Client({
-      address: 'localhost:4000'
-    });
-    await client.init();
-    const title = 'Artist - Title';
-
-    // Prepare the song tags
-    await utils.addSongTags('./audio.mp3', {
-      fullTitle: title,
-      APIC: './cover.jpg'
-    });
-
-    // Add the song
-    await client.addSong('./audio.mp3');
-
-    // Get the song info
-    const info = await client.getSong(title);
-
-    // Find songs
-    const songs = await client.findSongs('arti', { limit: 5 });
-
-    // Find the artist songs
-    const artistSongs = await client.findArtistSongs('artist');
-
-    // Get the song audio link
-    const audioLink = await client.getSongAudioLink(title);
-
-    // Get the song cover link
-    const coverLink = await client.getSongCoverLink(title);
-    
-    // Remove the song
-    await client.removeSong(title);
-  }
-  catch(err) {
-    console.error(err.stack);
-    process.exit(1);
-  }
-})();
+import { Client } from 'museria';
+import utils from 'museria/src/utils.js';
+
+try {
+  const client = new Client({
+    address: 'localhost:4000'
+  });
+  await client.init();
+  const title = 'Artist - Title';
+
+  // Prepare the song tags
+  await utils.addSongTags('./audio.mp3', {
+    fullTitle: title,
+    APIC: './cover.jpg'
+  });
+
+  // Add the song
+  await client.addSong('./audio.mp3');
+
+  // Get the song info
+  const info = await client.getSong(title);
+
+  // Find songs
+  const songs = await client.findSongs('arti', { limit: 5 });
+
+  // Find the artist songs
+  const artistSongs = await client.findArtistSongs('artist');
+
+  // Get the song audio link
+  const audioLink = await client.getSongAudioLink(title);
+
+  // Get the song cover link
+  const coverLink = await client.getSongCoverLink(title);
+  
+  // Remove the song
+  await client.removeSong(title);
+}
+catch(err) {
+  console.error(err.stack);
+  process.exit(1);
+}
 ```
 
 ## Browser client
@@ -132,7 +128,7 @@ When you create an instance of the node you can pass options below. Only specifi
 
 * {boolean} __[music.prepareCover=true]__ - prepare the cover before addition or not. Preparation means bringing the size and image quality to the right values.
 
-* {integer} __[music.coverQuality=85]__ - prepared cover quality from 0 to 100. It works only when music.prepareCover is true.
+* {integer} __[music.coverQuality=80]__ - prepared cover quality from 0 to 100. It works only when music.prepareCover is true.
 
 * {integer} __[music.coverMinSize=200]__ - minimum cover size in px. It works only when music.prepareCover is true.
 
@@ -145,7 +141,7 @@ When you create an instance of the node you can pass options below. Only specifi
 ## Client interface
 
 async __Client.prototype.addSong()__ - add the file to the network.
-  * {string|fs.ReadStream|Buffer|Blob} __file__ - mp3 audio file  
+  * {string|fse.ReadStream|Buffer|Blob} __file__ - mp3 audio file  
   * {object} __[options]__ - addition options
   * {number} __[options.timeout]__ - addition timeout
   * {integer} __[options.priority=0]__ - song priority -1, 1 or 0

package/bin/actions.js

@@ -1,13 +1,17 @@
-const chalk = require('chalk');
-const argv = require('yargs').argv;
-const srcUtils = require('../src/utils');
-const utils = require('./utils');
-const actions = Object.assign({}, require('metastocle/bin/actions'), require('storacle/bin/actions'));
+import chalk from "chalk";
+import yargs from "yargs";
+import srcUtils from "../src/utils.js";
+import utils from "./utils.js";
+import mtActions from "metastocle/bin/actions.js";
+import stActions from "storacle/bin/actions.js";
+
+const argv = yargs(process.argv).argv;
+const actions = Object.assign({}, mtActions, stActions);
 
 /**
  * Clean up the music
  */
-actions.cleanUpMusic = async node => {
+actions.cleanUpMusic = async (node) => {
   await node.cleanUpMusic();
   //eslint-disable-next-line no-console
   console.log(chalk.cyan('The music has been cleaned up'));
@@ -16,7 +20,7 @@ actions.cleanUpMusic = async node => {
 /**
  * Export all songs to another node
  */
-actions.exportSongs = async node => {
+actions.exportSongs = async (node) => {
   await node.exportSongs(argv.address || argv.n);
   //eslint-disable-next-line no-console
   console.log(chalk.cyan('The songs have been exported'));
@@ -25,24 +29,22 @@ actions.exportSongs = async node => {
 /**
  * Add the song
  */
-actions.addSong = async node => {
+actions.addSong = async (node) => {
   const filePath = utils.getAbsolutePath(argv.filePath || argv.f);
   const result = await node.addSong(filePath);
   //eslint-disable-next-line no-console
-  console.log(chalk.cyan(`The song "${ result.title }" has been added`));
+  console.log(chalk.cyan(`The song "${result.title}" has been added`));
 };
 
 /**
  * Get the song audio link
  */
-actions.getSongAudioLink = async node => {
+actions.getSongAudioLink = async (node) => {
   const title = argv.title || argv.t;
   const link = await node.getSongAudioLink(title);
-
-  if(!link) {
-    throw new Error(`There is no song with the title ${title}`);
+  if (!link) {
+      throw new Error(`There is no song with the title ${title}`);
   }
-
   //eslint-disable-next-line no-console
   console.log(chalk.cyan(`The song audio link is "${link}"`));
 };
@@ -50,11 +52,11 @@ actions.getSongAudioLink = async node => {
 /**
  * Get the song cover link
  */
-actions.getSongCoverLink = async node => {
+actions.getSongCoverLink = async (node) => {
   const title = argv.title || argv.t;
   const link = await node.getSongCoverLink(title);
 
-  if(!link) {
+  if (!link) {
     throw new Error(`There is no song with the title ${title}`);
   }
 
@@ -65,17 +67,16 @@ actions.getSongCoverLink = async node => {
 /**
  * Get the song audio to the path
  */
-actions.getSongAudioToPath = async node => {
+actions.getSongAudioToPath = async (node) => {
   const title = argv.title || argv.t;
   const filePath = utils.getAbsolutePath(argv.filePath || argv.f);
   const link = await node.getSongAudioLink(title);
-
-  if(!link) {
-    throw new Error(`There is no song with the title ${title}`);
+  
+  if (!link) {
+    throw new Error(`There is no song with the title ${title}`);  
   }
 
   await srcUtils.fetchFileToPath(filePath, link, node.createDefaultRequestOptions());
-
   //eslint-disable-next-line no-console
   console.log(chalk.cyan(`The song "${title}" has been saved to "${filePath}"`));
 };
@@ -83,17 +84,16 @@ actions.getSongAudioToPath = async node => {
 /**
  * Get the song cover to the path
  */
-actions.getSongCoverToPath = async node => {
+actions.getSongCoverToPath = async (node) => {
   const title = argv.title || argv.t;
   const filePath = utils.getAbsolutePath(argv.filePath || argv.f);
   const link = await node.getSongCoverLink(title);
 
-  if(!link) {
-    throw new Error(`There is no song with the title ${title}`);
+  if (!link) {
+      throw new Error(`There is no song with the title ${title}`);
   }
-
+  
   await srcUtils.fetchFileToPath(filePath, link, node.createDefaultRequestOptions());
-
   //eslint-disable-next-line no-console
   console.log(chalk.cyan(`The song "${title}" has been saved to "${filePath}"`));
 };
@@ -101,11 +101,11 @@ actions.getSongCoverToPath = async node => {
 /**
  * Remove the song
  */
-actions.removeSong = async node => {
+actions.removeSong = async (node) => {
   const title = argv.title || argv.t;
   await node.removeSong(title);
   //eslint-disable-next-line no-console
   console.log(chalk.cyan(`The song "${title}" has been removed`));
 };
 
-module.exports = actions;
+export default actions;

package/bin/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
+import runner from "./runner.js";
+import { Node } from "../src/index.js";
+import actions from "./actions.js";
 
-const runner = require('./runner');
-const Node = require('../src').Node;
-const actions = require('./actions');
-runner('museria', Node, actions);
+runner('museria', Node, actions);

package/bin/runner.js

@@ -1 +1 @@
-module.exports = require('spreadable/bin/runner');
+export { default } from "spreadable/bin/runner";

package/bin/utils.js

@@ -1,2 +1,6 @@
-const utils = Object.assign({}, require('metastocle/bin/utils'), require('storacle/bin/utils'));
-module.exports = utils;
+import mtUtils from "metastocle/bin/utils.js";
+import stUtils from "storacle/bin/utils.js";
+
+const utils = Object.assign({}, mtUtils, stUtils);
+
+export default utils;