explodingcamera / subsonic-api

typescript/javascript library for interacting with subsonic-compatible apis

Subsonic-API

A simple API library for interacting with Subsonic-compatible servers (Up to API version 1.16.1) written in TypeScript. Supports Node.js >= 18, bun >= 1 and modern Browsers. No dependencies and less than 4kb minified and gzipped.

Installation

$ npm install subsonic-api

Example Usage

You can also try out the example on CodeSandbox here.

import { SubsonicAPI } from "subsonic-api";

const api = new SubsonicAPI({
  url: "https://demo.navidrome.org",
  type: "navidrome", // or "generic" or "subsonic"
});

await api.login({
  username: "demo",
  password: "demo",
});

const { randomSongs } = await api.getRandomSongs();
console.log(randomSongs);

API

subsonic-api supports all of the Subsonic API methods as documented here, up to API version 1.16.1 / Subsonic 6.1.4. All methods return a promise that resolves to the JSON response from the server.

Additionally, the following methods are available:

login

login(options: LoginOptions): Promise<void>

Logs in to the server and stores the password for future requests.

interface LoginOptions {
  username: string;
  password: string;
}

navidromeSession

subsonicSession(): Promise<SessionInfo>

Creates a new Navidrome session

interface SessionInfo {
  id: string;
  isAdmin: boolean;
  name: string;
  subsonicSalt: string;
  subsonicToken: string;
  token: string;
  username: string;
}

baseURL

baseURL(): string

Returns the base URL of the server. Useful for interacting with other APIs like Navidrome's.

custom

custom(method: string, params: Params): Promise<Response>

Allows you to make a custom request to the server.

customJSON

customJSON<T>(method: string, params: Params): Promise<T>

Allows you to make a custom request to the server and parse the response as JSON.

subsonic-api's Issues

Is there a way to get all albums from an artistId?

Hello ✌️

I'm currently using Navidrome.

Navidrome seems to have a private API with different endpoints and parameters like we see here:

Is there a way to get all albums from an artistId like Navidrome does? I can only see the getAlbumList method which only has the id (of the album) parameter. This returns a list of albums that all have the artistId. I could get the albums from an artist by using both the getArtists and getAlbumList but it's not practical.

Is there a cleaner/simpler way of doing this?

Thanks ;)

Issue when importing package

Hi @explodingcamera ✌️

After installing the package with npm in the following project I get the following error:

Did I miss something?

Login method errors with "Unknown encoding: base64url"

The environment is in Electron v24.1.3, Node v19.1.0 (trying to implement in https://github.com/Geoxor/amethyst)

Sample code:

import { SubsonicAPI } from "subsonic-api";

const api = new SubsonicAPI({
  url: "https://demo.navidrome.org",
  type: "navidrome", // or "generic" or "subsonic"
});

api.login({
  username: "demo",
  password: "demo",
}).then(() => {
  api.getTopSongs({count: 50}).then(songs => console.log(songs));
  console.log("logged in");
}).catch(err => {
  console.log("subsonic error:", err);
});

Error in console:

subsonic error: TypeError: Unknown encoding: base64url
    at Uint8Array.slowToString (index.js:544:32)
    at Uint8Array.toString (index.js:606:23)
    at M (index.js:1:9081)
    at n.E_fn (index.js:1:10196)
    at n.G_fn (index.js:1:10257)
    at n.C_fn (index.js:1:11207)
    at n.R_fn (index.js:1:10408)
    at n.ping (index.js:1:11393)
    at n.login (index.js:1:9663)

Scrobble() method doesn't take into account submission param

I'm creating a player component that gets the current song that is playing.

From Subsonic API I see I need to call the following methods in this exact order:

1. stream(songId)
2. scrobble(songId)
3. getNowPlaying

The scrobble method needs to have the submission param set to false to add the a song in the playing queue.

Issue: the scrobble method doesn't seem to take into account the submission param. The id and time params work well though.

When directly using the Subsonic API in Postman with the same params everything works well.

My code:

The request in the browser doesn't send the submission param:

Did I miss something?

Thanks in advance ;)

EDIT
After setting the submission value as a string it works. It may be coming from this line in your package :)