Move artists tests

* Playlist icons working as rendered by ND

* remove duplication in cover art image url creation

* Remove unused ability to create collages of images

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+FROM node:23-bullseye
+
+LABEL maintainer=simojenki
+
+ENV JEST_TIMEOUT=60000
+EXPOSE 4534
+
+RUN apt-get update && \
+    apt-get -y upgrade && \
+    apt-get -y install --no-install-recommends \
+        libvips-dev \
+        python3 \
+        make \
+        git \
+        g++ \
+        vim

.devcontainer/devcontainer.json

@@ -0,0 +1,28 @@
+{
+    "name": "bonob",
+    "build": { 
+        "dockerfile": "Dockerfile" 
+    },
+    "containerEnv": {
+        // these env vars need to be configured appropriately for your local dev env
+        "BNB_DEV_SONOS_DEVICE_IP": "${localEnv:BNB_DEV_SONOS_DEVICE_IP}",
+        "BNB_DEV_HOST_IP": "${localEnv:BNB_DEV_HOST_IP}",
+        "BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}"
+    },
+    "remoteUser": "node",
+    "forwardPorts": [4534],
+    "features": {
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {
+            "version": "latest",
+            "moby": true
+        }
+    },
+    "customizations": {
+        "vscode": {
+          "extensions": [
+            "esbenp.prettier-vscode",
+            "redhat.vscode-xml"
+        ]
+        }
+    }
+}

.dockerignore

@@ -0,0 +1,6 @@
+.devcontainer
+.github
+.yarn/cache
+.yarn/install-state.gz
+build
+node_modules

.github/workflows/ci.yml

@@ -15,47 +15,64 @@ jobs:
   build_and_test:
     runs-on: ubuntu-latest
     steps:
-      - 
+      -
         name: Check out the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
-      - 
+      -
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: 16.6.x
+          node-version: 20
-      - 
+      -
-        run: yarn install
+        run: npm install
-      - 
+      -
-        run: yarn test
+        run: npm test
 
 
   push_to_registry:
-    name: Push Docker image to Docker Hub
+    name: Push Docker image to Docker registries
     needs: build_and_test
     runs-on: ubuntu-latest
     steps:
-      - 
+      -
         name: Check out the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
       -
         name: Docker meta
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v4
         with:
-          images: simojenki/bonob
+          images: |
+            simojenki/bonob
+            ghcr.io/simojenki/bonob
       -
         name: Login to DockerHub
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - 
+      -
-        name: Push to Docker Hub
+        name: Log in to GitHub Container registry
-        uses: docker/build-push-action@v2
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Push image
+        uses: docker/build-push-action@v4
         with:
           context: .
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -2,6 +2,7 @@
 .vscode
 build
 ignore
+.ignore
 node_modules
 .yarn/*
 !.yarn/patches

.npmrc

@@ -0,0 +1 @@
+fetch-timeout=60000

.nvmrc

@@ -1 +0,0 @@
-16.6.2

.yarnrc.yml

@@ -1,3 +0,0 @@
-nodeLinker: node-modules
-
-yarnPath: .yarn/releases/yarn-berry.cjs

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16.6-alpine as build
+FROM node:23-bullseye-slim AS build
 
 WORKDIR /bonob
 
@@ -9,46 +9,69 @@ COPY typings ./typings
 COPY web ./web
 COPY tests ./tests
 COPY jest.config.js .
-COPY package.json .
 COPY register.js .
+COPY .npmrc .
 COPY tsconfig.json .
-COPY yarn.lock .
+COPY package.json .
-COPY .yarnrc.yml .
+COPY package-lock.json .
-COPY .yarn/releases ./.yarn/releases
 
-RUN apk add --no-cache --update --virtual .gyp \
+ENV JEST_TIMEOUT=60000
-        vips-dev \
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && \
+    apt-get -y upgrade && \
+    apt-get -y install --no-install-recommends \
+        libvips-dev \
         python3 \
         make \
         git \
         g++ && \
-    yarn install --immutable && \
+    apt-get clean && \
-    yarn gitinfo && \
+    rm -rf /var/lib/apt/lists/* && \
-    yarn test --no-cache && \
+    npm install && \
-    yarn build
+    npm test && \
+    npm run gitinfo && \
+    npm run build && \
+    rm -Rf node_modules && \
+    NODE_ENV=production npm install --omit=dev
 
 
+FROM node:23-bullseye-slim
 
-FROM node:16.6-alpine
+LABEL   maintainer="simojenki" \
+        org.opencontainers.image.source="https://github.com/simojenki/bonob" \
+        org.opencontainers.image.description="bonob SONOS SMAPI implementation" \
+        org.opencontainers.image.licenses="GPLv3"
 
-ENV BONOB_PORT=4534
+ENV BNB_PORT=4534
+ENV DEBIAN_FRONTEND=noninteractive
+ENV TZ=UTC
 
-EXPOSE $BONOB_PORT
+EXPOSE $BNB_PORT
 
 WORKDIR /bonob
 
 COPY package.json .
-COPY yarn.lock .
+COPY package-lock.json .
 
 COPY --from=build /bonob/build/src ./src
 COPY --from=build /bonob/node_modules ./node_modules
 COPY --from=build /bonob/.gitinfo ./
 COPY web ./web
-COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl
+COPY src/Sonoswsdl-1.19.6-20231024.wsdl ./src/Sonoswsdl-1.19.6-20231024.wsdl
 
-RUN apk add --no-cache --update vips
+RUN apt-get update && \
+    apt-get -y upgrade && \
+    apt-get -y install --no-install-recommends \
+        libvips \
+        tzdata \
+        wget && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
 
 USER nobody 
 WORKDIR /bonob/src
 
+HEALTHCHECK CMD wget -O- http://localhost:${BNB_PORT}/about || exit 1   
+
 CMD ["node", "app.js"]

README.md

@@ -2,39 +2,54 @@
 
 A sonos SMAPI implementation to allow registering sources of music with sonos.  
 
-Currently only a single integration allowing Navidrome to be registered with sonos. In theory as Navidrome implements the subsonic API, it *may* work with other subsonic api clones.
+Support for Subsonic API clones (tested against Navidrome and Gonic).
 
 ![Build](https://github.com/simojenki/bonob/workflows/Build/badge.svg)
 
 ## Features
 
-- Integrates with Navidrome
+- Integrates with Subsonic API clones (Navidrome, Gonic)
-- Browse by Artist, Albums, Genres, Playlist, Random Albums, Starred Albums, Recently Added Albums, Recently Played Albums, Most Played Albums
+- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums
-- Artist Art
+- Artist & Album Art
-- Album Art
 - View Related Artists via Artist -> '...' -> Menu -> Related Arists
 - Now playing & Track Scrobbling
+- Search by Album, Artist, Track
+- Playlist editing through sonos app.
+- Marking of songs as favourites and with ratings through the sonos app.
+- Localization (only en-US, da-DK, nl-NL & fr-FR supported currently, require translations for other languages).  [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
 - Auto discovery of sonos devices
 - Discovery of sonos devices using seed IP address
-- Auto register bonob service with sonos system
+- Auto registration with sonos on start
 - Multiple registrations within a single household.
-- Transcoding performed by Navidrome with specific player for bonob/sonos, customisable by mimeType
+- Transcoding within subsonic clone
-- Ability to search by Album, Artist, Track
+- Custom players by mime type, allowing custom transcoding rules for different file types
-- Ability to play a playlist
-- Ability to add/remove playlists
-- Ability to add/remove tracks from a playlist
-- Localization (only en-US & nl-NL supported currently, require translations for other languages).  [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/)
 
 ## Running
 
-bonob is ditributed via docker and can be run in a number of ways
+bonob is packaged as an OCI image to both the docker hub registry and github registry.
+
+ie. 
+```bash
+docker pull docker.io/simojenki/bonob
+```
+or
+```bash
+docker pull ghcr.io/simojenki/bonob
+```
+
+tag | description
+--- | ---
+latest | Latest release, intended to be stable
+master | Lastest build from master, probably works, however is currently under test
+vX.Y.Z | Fixed release versions from tags, for those that want to pin to a specific release
+
 
 ### Full sonos device auto-discovery and auto-registration using docker --network host
 
 ```bash
 docker run \
-    -e BONOB_SONOS_AUTO_REGISTER=true \
+    -e BNB_SONOS_AUTO_REGISTER=true \
-    -e BONOB_SONOS_DEVICE_DISCOVERY=true \
+    -e BNB_SONOS_DEVICE_DISCOVERY=true \
     -p 4534:4534 \
     --network host \
     simojenki/bonob
@@ -46,10 +61,10 @@ Now open http://localhost:4534 in your browser, you should see sonos devices, an
 
 ```bash
 docker run \
-    -e BONOB_PORT=3000 \
+    -e BNB_PORT=3000 \
-    -e BONOB_SONOS_SEED_HOST=192.168.1.123 \
+    -e BNB_SONOS_SEED_HOST=192.168.1.123 \
-    -e BONOB_SONOS_AUTO_REGISTER=true \
+    -e BNB_SONOS_AUTO_REGISTER=true \
-    -e BONOB_SONOS_DEVICE_DISCOVERY=true \
+    -e BNB_SONOS_DEVICE_DISCOVERY=true \
     -p 3000:3000 \
     simojenki/bonob
 ```
@@ -66,13 +81,13 @@ Start bonob outside the LAN with sonos discovery & registration disabled as they
 
 ```bash
 docker run \
-    -e BONOB_PORT=4534 \
+    -e BNB_PORT=4534 \
-    -e BONOB_SONOS_SERVICE_NAME=MyAwesomeMusic \
+    -e BNB_SONOS_SERVICE_NAME=MyAwesomeMusic \
-    -e BONOB_SECRET=changeme \
+    -e BNB_SECRET=changeme \
-    -e BONOB_URL=https://my-server.example.com/bonob \
+    -e BNB_URL=https://my-server.example.com/bonob \
-    -e BONOB_SONOS_AUTO_REGISTER=false \
+    -e BNB_SONOS_AUTO_REGISTER=false \
-    -e BONOB_SONOS_DEVICE_DISCOVERY=false \
+    -e BNB_SONOS_DEVICE_DISCOVERY=false \
-    -e BONOB_NAVIDROME_URL=https://my-navidrome-service.com:4533 \
+    -e BNB_SUBSONIC_URL=https://my-navidrome-service.com:4533 \
     -p 4534:4534 \
     simojenki/bonob
 ```
@@ -93,11 +108,10 @@ docker run \
 ```bash
 docker run \
     --rm \
-    -e BONOB_SONOS_SEED_HOST=192.168.1.163 \
+    -e BNB_SONOS_SEED_HOST=192.168.1.163 \
     simojenki/bonob register https://my-server.example.com/bonob
 ```
 
-
 ### Running bonob and navidrome using docker-compose
 
 ```yaml
@@ -125,76 +139,156 @@ services:
       - "4534:4534"
     restart: unless-stopped
     environment:
-      BONOB_PORT: 4534
+      BNB_PORT: 4534
       # ip address of your machine running bonob
-      BONOB_URL: http://192.168.1.111:4534  
+      BNB_URL: http://192.168.1.111:4534  
-      BONOB_SECRET: changeme
+      BNB_SECRET: changeme
-      BONOB_SONOS_AUTO_REGISTER: true
+      BNB_SONOS_AUTO_REGISTER: "true"
-      BONOB_SONOS_DEVICE_DISCOVERY: true
+      BNB_SONOS_DEVICE_DISCOVERY: "true"
-      BONOB_SONOS_SERVICE_ID: 246
+      BNB_SONOS_SERVICE_ID: 246
       # ip address of one of your sonos devices
-      BONOB_SONOS_SEED_HOST: 192.168.1.121
+      BNB_SONOS_SEED_HOST: 192.168.1.121
-      BONOB_NAVIDROME_URL: http://navidrome:4533
+      BNB_SUBSONIC_URL: http://navidrome:4533
 ```
 
+### Running bonob on synology
+
+[See this issue](https://github.com/simojenki/bonob/issues/15)
+
 ## Configuration
 
 item | default value | description
 ---- | ------------- | -----------
-BONOB_PORT | 4534 | Default http port for bonob to listen on
+BNB_PORT | 4534 | Default http port for bonob to listen on
-BONOB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos devices can communicate. **This must be either the public IP or DNS entry of the bonob instance so that the sonos devices can communicate with it.**
+BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos devices can communicate. **This must be either the public IP or DNS entry of the bonob instance so that the sonos devices can communicate with it.**
-BONOB_SECRET | bonob | secret used for encrypting credentials
+BNB_SECRET | bonob | secret used for encrypting credentials
-BONOB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup
+BNB_AUTH_TIMEOUT | 1h | Timeout for the sonos auth token, described in the format [ms](https://github.com/vercel/ms), ie. '5s' == 5 seconds, '11h' == 11 hours.  In the case of using Navidrome this should be less than the value for ND_SESSIONTIMEOUT
-BONOB_SONOS_DEVICE_DISCOVERY | true | whether or not sonos device discovery should be enabled
+BNB_LOG_LEVEL | info | Log level. One of ['debug', 'info', 'warn', 'error']
-BONOB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery
+BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests
-BONOB_SONOS_SERVICE_NAME | bonob | service name for sonos
+BNB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup
-BONOB_SONOS_SERVICE_ID | 246 | service id for sonos
+BNB_SONOS_DEVICE_DISCOVERY | true | Enable/Disable sonos device discovery entirely.  Setting this to 'false' will disable sonos device search, regardless of whether a seed host is specified.
-BONOB_NAVIDROME_URL | http://$(hostname):4533 | URL for navidrome
+BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery
-BONOB_NAVIDROME_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom navidrome clients when streaming. ie. "audio/flac,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.
+BNB_SONOS_SERVICE_NAME | bonob | service name for sonos
-BONOB_SCROBBLE_TRACKS | true | Whether to scrobble the playing of a track if it has been played for >30s
+BNB_SONOS_SERVICE_ID | 246 | service id for sonos
-BONOB_REPORT_NOW_PLAYING | true | Whether to report a track as now playing
+BNB_SUBSONIC_URL | http://$(hostname):4533 | URL for subsonic clone
-BONOB_ICON_FOREGROUND_COLOR | undefined | Icon foreground color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
+BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. <P>Must specify the source mime type and optionally the transcoded mime type. <p>For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac".  <p>However; <p>if your subsonic server will transcode the track then you need to specify the resulting mime type, ie. "audio/flac>audio/mp3" <p>If you want to specify many something like; "audio/flac>audio/mp3,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.  <p>Disclaimer: Getting this configuration wrong will cause sonos to refuse to play your music, by all means experiment, however know that this may well break your setup.
-BONOB_ICON_BACKGROUND_COLOR | undefined | Icon background color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
+BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache.
+BNB_SCROBBLE_TRACKS | true | Whether to scrobble the playing of a track if it has been played for >30s
+BNB_REPORT_NOW_PLAYING | true | Whether to report a track as now playing
+BNB_ICON_FOREGROUND_COLOR | undefined | Icon foreground color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
+BNB_ICON_BACKGROUND_COLOR | undefined | Icon background color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
+TZ | UTC | Your timezone from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) ie. 'Australia/Melbourne'
 
 ## Initialising service within sonos app
 
-- Configure bonob, make sure to set BONOB_URL. **bonob must be accessible from your sonos devices on BONOB_URL, otherwise it will fail to initialise within the sonos app, so make sure you test this in your browser by putting BONOB_URL in the address bar and seeing the bonob information page**
+- Configure bonob, make sure to set BNB_URL. **bonob must be accessible from your sonos devices on BNB_URL, otherwise it will fail to initialise within the sonos app, so make sure you test this in your browser by putting BNB_URL in the address bar and seeing the bonob information page**
-- Start bonob, 
+- Start bonob
 - Open sonos app on your device
 - Settings -> Services & Voice -> + Add a Service
-- Select your Music Service, default name is 'bonob', can be overriden with configuration BONOB_SONOS_SERVICE_NAME
+- Select your Music Service, default name is 'bonob', can be overriden with configuration BNB_SONOS_SERVICE_NAME
 - Press 'Add to Sonos' -> 'Linking sonos with bonob' -> Authorize
-- Your device should open a browser and you should now see a login screen, enter your navidrome credentials
+- Your device should open a browser and you should now see a login screen, enter your subsonic clone credentials
 - You should get 'Login successful!'
 - Go back into the sonos app and complete the process
-- You should now be able to play music from navidrome
+- You should now be able to play music on your sonos devices from you subsonic clone
-- Within navidrome a new player will be created, 'bonob (username)', so you can configure transcoding specifically for sonos
+- Within the subsonic clone a new player will be created, 'bonob (username)', so you can configure transcoding specifically for sonos
 
-## Implementing a different music source other than navidrome
+## Re-registering your bonob service with sonos App
+
+Generally speaking you will not need to do this very often.  However on occassion bonob will change the implementation of the authentication between sonos and bonob, which will require a re-registration.  Your sonos app will complain about not being able to browse the service, to re-register execute the following steps (taken from the iOS app);
+
+- Open the sonos app
+- Settings -> Services & Voice
+- Your bonob service, will likely have name of either 'bonob' or $BNB_SONOS_SERVICE_NAME
+- Reauthorize Account
+- Authorize
+- Enter credentials, you should see 'Login Successful!'
+- Done
+
+Service should now be registered and everything should work as expected.
+
+## Multiple registrations within a single household.
+
+It's possible to register multiple Subsonic clone users for the bonob service in Sonos.
+Basically this consist of repeating the Sonos app ["Add a service"](#initialising-service-within-sonos-app) steps for each additional user.
+Afterwards the Sonos app displays a dropdown underneath the service, allowing to switch between users.
+
+## Implementing a different music source other than a subsonic clone
 
 - Implement the MusicService/MusicLibrary interface
 - Startup bonob with your new implementation.
 
-## Sample Icon colors
+## Transcoding
 
+### Transcode everything
+
+The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
+
+### Audio file type specific transcoding
+
+Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
+
+In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type.  For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
+
+In this case you could set;
+
+```bash
+# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
+BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
 ```
--e BONOB_ICON_FOREGROUND_COLOR=white \
+
--e BONOB_ICON_BACKGROUND_COLOR=darkgrey
+This would result in 2 players in Navidrome, one called 'bonob', the other called 'bonob+audio/flac'.  You could then configure a custom flac transcoder in Navidrome that re-samples the flacs to a sonos supported format, ie [Using something like this](https://stackoverflow.com/questions/41420391/ffmpeg-flac-24-bit-96khz-to-16-bit-48khz) or [this](https://stackoverflow.com/questions/52119489/ffmpeg-limit-audio-sample-rate):
+
+```bash
+ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
 ```
+
+**Note for Sonos S1:** [24-bit depth is only supported by Sonos S2](https://support.sonos.com/s/article/79?language=en_US), so if your system is still on Sonos S1, transcoding should convert all FLACs to 16-bit:
+
+```bash
+ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
+```
+
+Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files.  Let's say you want to transcode them to mp3s, you could set the following;
+
+```bash
+BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
+```
+
+And then configure the 'bonob+audio/mpeg' player in your subsonic server.
+
+
+## Changing Icon colors
+
+```bash
+-e BNB_ICON_FOREGROUND_COLOR=white \
+-e BNB_ICON_BACKGROUND_COLOR=darkgrey
+```
+
 ![White & Dark Grey](https://github.com/simojenki/bonob/blob/master/docs/images/whiteDarkGrey.png?raw=true)
 
+```bash
+-e BNB_ICON_FOREGROUND_COLOR=chartreuse \
+-e BNB_ICON_BACKGROUND_COLOR=fuchsia
+```
 
-```
--e BONOB_ICON_FOREGROUND_COLOR=chartreuse \
--e BONOB_ICON_BACKGROUND_COLOR=fuchsia
-```
 ![Chartreuse & Fuchsia](https://github.com/simojenki/bonob/blob/master/docs/images/chartreuseFuchsia.png?raw=true)
 
+```bash
+-e BNB_ICON_FOREGROUND_COLOR=lime \
+-e BNB_ICON_BACKGROUND_COLOR=aliceblue
+```
+
+![Lime & Alice Blue](https://github.com/simojenki/bonob/blob/master/docs/images/limeAliceBlue.png?raw=true)
+
+```bash
+-e 'BNB_ICON_FOREGROUND_COLOR=#1db954' \
+-e 'BNB_ICON_BACKGROUND_COLOR=#121212'
+```
+
+![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true)
+
 
 ## Credits
 
 - Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho
-
-## TODO
-
-- Artist Radio

etc/docker-compose.yaml

@@ -22,13 +22,13 @@ services:
       - "4534:4534"
     restart: unless-stopped
     environment:
-      BONOB_PORT: 4534
+      BNB_PORT: 4534
       # ip address of your machine running bonob
-      BONOB_URL: http://192.168.1.111:4534  
+      BNB_URL: http://192.168.1.111:4534  
-      BONOB_SECRET: changeme
+      BNB_SECRET: changeme
-      BONOB_SONOS_SERVICE_ID: 246 
+      BNB_SONOS_SERVICE_ID: 246 
-      BONOB_SONOS_AUTO_REGISTER: "true"
+      BNB_SONOS_AUTO_REGISTER: "true"
-      BONOB_SONOS_DEVICE_DISCOVERY: "true"
+      BNB_SONOS_DEVICE_DISCOVERY: "true"
       # ip address of one of your sonos devices
-      BONOB_SONOS_SEED_HOST: 192.168.1.121
+      BNB_SONOS_SEED_HOST: 192.168.1.121
-      BONOB_NAVIDROME_URL: http://navidrome:4533
+      BNB_SUBSONIC_URL: http://navidrome:4533

jest.config.js

@@ -5,5 +5,6 @@ module.exports = {
   modulePathIgnorePatterns: [
     '<rootDir>/node_modules',
     '<rootDir>/build',
-    ],
+  ],
+  testTimeout: Number.parseInt(process.env["JEST_TIMEOUT"] || "5000")
 };

package.json

@@ -6,54 +6,70 @@
   "author": "simojenki <simojenki@users.noreply.github.com>",
   "license": "GPL-3.0-only",
   "dependencies": {
-    "@svrooij/sonos": "^2.4.0",
+    "@svrooij/sonos": "^2.6.0-beta.11",
-    "@types/express": "^4.17.13",
+    "@types/express": "^4.17.21",
-    "@types/morgan": "^1.9.3",
+    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^16.7.13",
+    "@types/jsonwebtoken": "^9.0.7",
-    "@types/sharp": "^0.28.6",
+    "@types/jws": "^3.2.10",
-    "@types/underscore": "^1.11.3",
+    "@types/morgan": "^1.9.9",
-    "@types/uuid": "^8.3.1",
+    "@types/node": "^20.11.5",
-    "axios": "^0.21.4",
+    "@types/randomstring": "^1.3.0",
-    "dayjs": "^1.10.6",
+    "@types/underscore": "^1.13.0",
-    "eta": "^1.12.3",
+    "@types/uuid": "^10.0.0",
-    "express": "^4.17.1",
+    "@types/xmldom": "^0.1.34",
-    "fp-ts": "^2.11.1",
+    "@xmldom/xmldom": "^0.9.7",
-    "libxmljs2": "^0.28.0",
+    "axios": "^1.7.8",
+    "dayjs": "^1.11.13",
+    "eta": "^2.2.0",
+    "express": "^4.18.3",
+    "fp-ts": "^2.16.9",
+    "fs-extra": "^11.2.0",
+    "jsonwebtoken": "^9.0.2",
+    "jws": "^4.0.0",
     "morgan": "^1.10.0",
-    "node-html-parser": "^4.1.4",
+    "node-html-parser": "^6.1.13",
-    "sharp": "^0.29.1",
+    "randomstring": "^1.3.0",
-    "soap": "^0.42.0",
+    "sharp": "^0.33.5",
-    "ts-md5": "^1.2.9",
+    "soap": "^1.1.6",
-    "typescript": "^4.4.2",
+    "ts-md5": "^1.3.1",
-    "underscore": "^1.13.1",
+    "typescript": "^5.7.2",
-    "uuid": "^8.3.2",
+    "underscore": "^1.13.7",
-    "winston": "^3.3.3",
+    "urn-lib": "^2.0.0",
-    "x2js": "^3.4.2"
+    "uuid": "^11.0.3",
+    "winston": "^3.17.0",
+    "xmldom-ts": "^0.3.1",
+    "xpath": "^0.0.34"
   },
   "devDependencies": {
-    "@types/chai": "^4.2.21",
+    "@types/chai": "^5.0.1",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^29.5.14",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.10",
-    "@types/supertest": "^2.0.11",
+    "@types/supertest": "^6.0.2",
-    "chai": "^4.3.4",
+    "@types/tmp": "^0.2.6",
-    "get-port": "^5.1.1",
+    "chai": "^5.1.2",
-    "image-js": "^0.33.0",
+    "get-port": "^7.1.0",
-    "jest": "^27.1.0",
+    "image-js": "^0.35.6",
-    "nodemon": "^2.0.12",
+    "jest": "^29.7.0",
-    "supertest": "^6.1.6",
+    "nodemon": "^3.1.7",
-    "ts-jest": "^27.0.5",
+    "supertest": "^7.0.0",
+    "tmp": "^0.2.3",
+    "ts-jest": "^29.2.5",
     "ts-mockito": "^2.6.1",
-    "ts-node": "^10.2.1",
+    "ts-node": "^10.9.2",
-    "xmldom-ts": "^0.3.1",
     "xpath-ts": "^1.3.13"
   },
+  "overrides": {
+    "axios-ntlm": "npm:dry-uninstall",
+    "axios": "$axios"
+  },
   "scripts": {
     "clean": "rm -Rf build node_modules",
     "build": "tsc",
-    "dev": "BONOB_ICON_FOREGROUND_COLOR=white BONOB_ICON_BACKGROUND_COLOR=darkgrey BONOB_SONOS_SERVICE_NAME=bonobDev BONOB_SONOS_DEVICE_DISCOVERY=true nodemon -V ./src/app.ts",
+    "dev": "BNB_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
-    "devr": "BONOB_ICON_FOREGROUND_COLOR=white BONOB_ICON_BACKGROUND_COLOR=darkgrey BONOB_SONOS_SERVICE_NAME=bonobDev BONOB_SONOS_DEVICE_DISCOVERY=true BONOB_SONOS_AUTO_REGISTER=true nodemon -V ./src/app.ts",
+    "devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_ICON_FOREGROUND_COLOR=deeppink BNB_ICON_BACKGROUND_COLOR=darkslategray BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
-    "register-dev": "ts-node ./src/register.ts http://$(hostname):4534",
+    "register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
     "test": "jest",
+    "testw": "jest --watch",
     "gitinfo": "git describe --tags > .gitinfo"
   }
 }

src/Sonoswsdl-1.19.6-20231024.wsdl

@@ -97,7 +97,7 @@
                 <xs:complexType>
                     <xs:sequence>
                         <xs:element name="token" type="xs:string"/>
-                        <xs:element name="key" type="xs:string"/>
+                        <xs:element name="key" type="xs:string" minOccurs="0"/>
                         <xs:element name="householdId" type="xs:string"/>
                     </xs:sequence>
                 </xs:complexType>
@@ -111,11 +111,12 @@
                 </xs:simpleType>
             </xs:element>
 
-            <xs:simpleType name="userAccountType">
+            <xs:simpleType name="userAccountTier">
                 <xs:restriction base="xs:string">
-                    <xs:enumeration value="premium"/>
+                    <xs:enumeration value="paidPremium"/>
-                    <xs:enumeration value="trial"/>
+                    <xs:enumeration value="paidLimited"/>
                     <xs:enumeration value="free"/>
+                    <xs:enumeration value="none"/>
                 </xs:restriction>
             </xs:simpleType>
 
@@ -239,6 +240,12 @@
                 </xs:simpleContent>
             </xs:complexType>
 
+            <xs:complexType name="contentKeys">
+                <xs:sequence>
+                    <xs:element name="contentKey" type="tns:contentKey" maxOccurs="8"/>
+                </xs:sequence>
+            </xs:complexType>
+
             <xs:simpleType name="mediaUriAction">
                 <xs:restriction base="xs:string">
                     <xs:enumeration value="IMPLICIT"/>
@@ -355,13 +362,11 @@
 
             <xs:complexType name="userInfo">
                 <xs:sequence>
-                    <!-- Everything except userIdHashCode and nickname are for future use -->
+                    <!--  accountStatus potentially for future use -->
                     <xs:element name="userIdHashCode" type="xs:string" minOccurs="1"/>
-                    <xs:element name="accountType" type="tns:userAccountType" minOccurs="0"/>
+                    <xs:element name="accountTier" type="tns:userAccountTier" minOccurs="0"/>
                     <xs:element name="accountStatus" type="tns:userAccountStatus" minOccurs="0"/>
                     <xs:element ref="tns:nickname" minOccurs="0"/>
-                    <xs:element name="profileUrl" type="tns:sonosUri" minOccurs="0"/>
-                    <xs:element name="pictureUrl" type="tns:sonosUri" minOccurs="0"/>
                 </xs:sequence>
             </xs:complexType>
 
@@ -888,7 +893,10 @@
                         <xs:element name="getMediaURIResult" type="xs:anyURI"/>
                         <xs:element name="deviceSessionToken" type="tns:deviceSessionToken" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="deviceSessionKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
-                        <xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
+                        <xs:choice minOccurs="0">
+                            <xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
+                            <xs:element name="contentKeys" type="tns:contentKeys" minOccurs="0" maxOccurs="1"/>
+                        </xs:choice>
                         <xs:element name="httpHeaders" type="tns:httpHeaders" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="uriTimeout" type="xs:int" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="positionInformation" type="tns:positionInformation" minOccurs="0" maxOccurs="1"/>

src/access_tokens.ts

@@ -1,117 +0,0 @@
-import { Dayjs } from "dayjs";
-import { v4 as uuid } from "uuid";
-import crypto from "crypto";
-
-import { Encryption } from "./encryption";
-import logger from "./logger";
-import { Clock, SystemClock } from "./clock";
-
-type AccessToken = {
-  value: string;
-  authToken: string;
-  expiry: Dayjs;
-};
-
-export interface AccessTokens {
-  mint(authToken: string): string;
-  authTokenFor(value: string): string | undefined;
-}
-
-export class ExpiringAccessTokens implements AccessTokens {
-  tokens = new Map<string, AccessToken>();
-  clock: Clock;
-
-  constructor(clock: Clock = SystemClock) {
-    this.clock = clock;
-  }
-
-  mint(authToken: string): string {
-    this.clearOutExpired();
-    const accessToken = {
-      value: uuid(),
-      authToken,
-      expiry: this.clock.now().add(12, "hours"),
-    };
-    this.tokens.set(accessToken.value, accessToken);
-    return accessToken.value;
-  }
-
-  authTokenFor(value: string): string | undefined {
-    this.clearOutExpired();
-    return this.tokens.get(value)?.authToken;
-  }
-
-  clearOutExpired() {
-    Array.from(this.tokens.values())
-      .filter((it) => it.expiry.isBefore(this.clock.now()))
-      .forEach((expired) => {
-        this.tokens.delete(expired.value);
-      });
-  }
-
-  count = () => this.tokens.size;
-}
-
-export class EncryptedAccessTokens implements AccessTokens {
-  encryption: Encryption;
-
-  constructor(encryption: Encryption) {
-    this.encryption = encryption;
-  }
-
-  mint = (authToken: string): string =>
-    Buffer.from(JSON.stringify(this.encryption.encrypt(authToken))).toString(
-      "base64"
-    );
-
-  authTokenFor(value: string): string | undefined {
-    try {
-      return this.encryption.decrypt(
-        JSON.parse(Buffer.from(value, "base64").toString("ascii"))
-      );
-    } catch {
-      logger.warn("Failed to decrypt access token...");
-      return undefined;
-    }
-  }
-}
-
-export class AccessTokenPerAuthToken implements AccessTokens {
-  authTokenToAccessToken = new Map<string, string>();
-  accessTokenToAuthToken = new Map<string, string>();
-
-  mint = (authToken: string): string => {
-    if (this.authTokenToAccessToken.has(authToken)) {
-      return this.authTokenToAccessToken.get(authToken)!;
-    } else {
-      const accessToken = uuid();
-      this.authTokenToAccessToken.set(authToken, accessToken);
-      this.accessTokenToAuthToken.set(accessToken, authToken);
-      return accessToken;
-    }
-  };
-
-  authTokenFor = (value: string): string | undefined => this.accessTokenToAuthToken.get(value);
-}
-
-export const sha256 = (salt: string) => (authToken: string) => crypto
-  .createHash("sha256")
-  .update(`${authToken}${salt}`)
-  .digest("hex")
-
-export class InMemoryAccessTokens implements AccessTokens {
-  tokens = new Map<string, string>();
-  minter;
-
-  constructor(minter: (authToken: string) => string) {
-    this.minter = minter
-  }
-
-  mint = (authToken: string): string => {
-    const accessToken = this.minter(authToken);
-    this.tokens.set(accessToken, authToken);
-    return accessToken;
-  }
-
-  authTokenFor = (value: string): string | undefined => this.tokens.get(value);
-}

src/api_tokens.ts

@@ -0,0 +1,30 @@
+import crypto from "crypto";
+
+export interface APITokens {
+  mint(authToken: string): string;
+  authTokenFor(apiToken: string): string | undefined;
+}
+
+
+export const sha256 = (salt: string) => (value: string) => crypto
+  .createHash("sha256")
+  .update(`${value}${salt}`)
+  .digest("hex")
+
+
+export class InMemoryAPITokens implements APITokens {
+  tokens = new Map<string, string>();
+  minter;
+
+  constructor(minter: (authToken: string) => string = sha256('bonob')) {
+    this.minter = minter
+  }
+
+  mint = (authToken: string): string => {
+    const accessToken = this.minter(authToken);
+    this.tokens.set(accessToken, authToken);
+    return accessToken;
+  }
+
+  authTokenFor = (apiToken: string): string | undefined => this.tokens.get(apiToken);
+}

src/app.ts

@@ -2,18 +2,27 @@ import path from "path";
 import fs from "fs";
 import server from "./server";
 import logger from "./logger";
-import { appendMimeTypeToClientFor, DEFAULT, Navidrome } from "./navidrome";
+
-import encryption from "./encryption";
+import {
-import { InMemoryAccessTokens, sha256 } from "./access_tokens";
+  axiosImageFetcher,
+  cachingImageFetcher,
+  TranscodingCustomPlayers,
+  NO_CUSTOM_PLAYERS,
+  Subsonic
+} from "./subsonic";
+import { SubsonicMusicService} from "./subsonic_music_library";
+import { InMemoryAPITokens, sha256 } from "./api_tokens";
 import { InMemoryLinkCodes } from "./link_codes";
 import readConfig from "./config";
 import sonos, { bonobService } from "./sonos";
-import { MusicService } from "./music_service";
+import { MusicService } from "./music_library";
 import { SystemClock } from "./clock";
+import { JWTSmapiLoginTokens } from "./smapi_auth";
 
 const config = readConfig();
+const clock = SystemClock;
 
-logger.info(`Starting bonob with config ${JSON.stringify(config)}`);
+logger.info(`Starting bonob with config ${JSON.stringify({ ...config, secret: "*******" })}`);
 
 const bonob = bonobService(
   config.sonos.serviceName,
@@ -24,20 +33,28 @@ const bonob = bonobService(
 
 const sonosSystem = sonos(config.sonos.discovery);
 
-const streamUserAgent = config.navidrome.customClientsFor
+const customPlayers = config.subsonic.customClientsFor
-  ? appendMimeTypeToClientFor(config.navidrome.customClientsFor.split(","))
+  ? TranscodingCustomPlayers.from(config.subsonic.customClientsFor)
-  : DEFAULT;
+  : NO_CUSTOM_PLAYERS;
 
-const navidrome = new Navidrome(
+const artistImageFetcher = config.subsonic.artistImageCache
-  config.navidrome.url,
+  ? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
-  encryption(config.secret),
+  : axiosImageFetcher;
-  streamUserAgent
+
+const subsonic = new SubsonicMusicService(
+  new Subsonic(
+    config.subsonic.url,
+    customPlayers,
+    artistImageFetcher
+  ),
+  customPlayers
 );
 
 const featureFlagAwareMusicService: MusicService = {
-  generateToken: navidrome.generateToken,
+  generateToken: subsonic.generateToken,
-  login: (authToken: string) =>
+  refreshToken: subsonic.refreshToken,
-    navidrome.login(authToken).then((library) => {
+  login: (serviceToken: string) =>
+    subsonic.login(serviceToken).then((library) => {
       return {
         ...library,
         scrobble: (id: string) => {
@@ -60,7 +77,9 @@ const featureFlagAwareMusicService: MusicService = {
 
 export const GIT_INFO = path.join(__dirname, "..", ".gitinfo");
 
-const version = fs.existsSync(GIT_INFO) ? fs.readFileSync(GIT_INFO).toString().trim() : "v??"
+const version = fs.existsSync(GIT_INFO)
+  ? fs.readFileSync(GIT_INFO).toString().trim()
+  : "v??";
 
 const app = server(
   sonosSystem,
@@ -69,16 +88,18 @@ const app = server(
   featureFlagAwareMusicService,
   {
     linkCodes: () => new InMemoryLinkCodes(),
-    accessTokens: () =>  new InMemoryAccessTokens(sha256(config.secret)),
+    apiTokens: () => new InMemoryAPITokens(sha256(config.secret)),
-    clock: SystemClock,
+    clock,
     iconColors: config.icons,
     applyContextPath: true,
-    logRequests: true,
+    logRequests: config.logRequests,
-    version
+    version,
+    smapiAuthTokens: new JWTSmapiLoginTokens(clock, config.secret, config.authTimeout),
+    externalImageResolver: artistImageFetcher
   }
 );
 
-app.listen(config.port, () => {
+const expressServer = app.listen(config.port, () => {
   logger.info(`Listening on ${config.port} available @ ${config.bonobUrl}`);
 });
 
@@ -90,12 +111,21 @@ if (config.sonos.autoRegister) {
       );
     }
   });
-} else if(config.sonos.discovery.auto) {
+} else if (config.sonos.discovery.enabled) {
-  sonosSystem.devices().then(devices => {
+  sonosSystem.devices().then((devices) => {
-    devices.forEach(d => {
+    devices.forEach((d) => {
-      logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`)
+      logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`);
-    })
+    });
-  })
+  });
-}
+};
+
+process.on('SIGTERM', () => {
+  logger.info('SIGTERM signal received: closing HTTP server');
+  expressServer.close(() => {
+    logger.info('HTTP server closed');
+  });
+  process.exit(0);
+});
+
 
 export default app;

src/b64.ts

@@ -0,0 +1,2 @@
+export const b64Encode = (value: string) => Buffer.from(value).toString("base64");
+export const b64Decode = (value: string) => Buffer.from(value, "base64").toString("ascii");

src/burn.ts

@@ -0,0 +1,98 @@
+import _ from "underscore";
+import { createUrnUtil } from "urn-lib";
+import randomstring from "randomstring";
+import { pipe } from "fp-ts/lib/function";
+import { either as E } from "fp-ts";
+
+import jwsEncryption from "./encryption";
+
+const BURN = createUrnUtil("bnb", {
+  components: ["system", "resource"],
+  separator: ":",
+  allowEmpty: false,
+});
+
+export type BUrn = {
+  system: string;
+  resource: string;
+};
+
+const DEFAULT_FORMAT_OPTS = {
+  shorthand: false,
+  encrypt: false,
+}
+
+const SHORTHAND_MAPPINGS: Record<string, string> = {
+  "internal" : "i",
+  "external": "e",
+  "subsonic": "s",
+  "navidrome": "n",
+  "encrypted": "x"
+}
+const REVERSE_SHORTHAND_MAPPINGS: Record<string, string> = Object.keys(SHORTHAND_MAPPINGS).reduce((ret, key) => {
+  ret[SHORTHAND_MAPPINGS[key] as unknown as string] = key;
+  return ret;
+}, {} as Record<string, string>)
+if(SHORTHAND_MAPPINGS.length != REVERSE_SHORTHAND_MAPPINGS.length) {
+  throw `Invalid SHORTHAND_MAPPINGS, must be duplicate!`
+}
+
+export const BURN_SALT = randomstring.generate(5);
+const encryptor = jwsEncryption(BURN_SALT);
+
+export const format = (
+  burn: BUrn,
+  opts: Partial<{ shorthand: boolean; encrypt: boolean }> = {}
+): string => {
+  const o = { ...DEFAULT_FORMAT_OPTS, ...opts }
+  let toBurn = burn;
+  if(o.shorthand) {
+    toBurn = {
+      ...toBurn,
+      system: SHORTHAND_MAPPINGS[toBurn.system] || toBurn.system
+    }
+  }
+  if(o.encrypt) {
+    const encryptedToBurn = {
+      system: "encrypted",
+      resource: encryptor.encrypt(BURN.format(toBurn))
+    }
+    return format(encryptedToBurn, { ...opts, encrypt: false })
+  } else {
+    return BURN.format(toBurn);
+  }
+};
+
+export const formatForURL = (burn: BUrn) => {
+  if(burn.system == "external") return format(burn, { shorthand: true, encrypt: true })
+  else return format(burn, { shorthand: true })
+}
+
+export const parse = (burn: string): BUrn => {
+  const result = BURN.parse(burn)!;
+  const validationErrors = BURN.validate(result) || [];
+  if (validationErrors.length > 0) {
+    throw new Error(`Invalid burn: '${burn}'`);
+  }
+  const system = result.system as string;
+  const x = {
+    system: REVERSE_SHORTHAND_MAPPINGS[system] || system,
+    resource: result.resource as string,
+  };
+  if(x.system == "encrypted") {
+    return pipe(
+      encryptor.decrypt(x.resource),
+      E.match(
+        (err) => { throw new Error(err) },
+        (z) => parse(z)
+      )
+    );
+  } else {
+    return x;
+  }
+}
+
+export function assertSystem(urn: BUrn, system: string): BUrn {
+  if (urn.system != system) throw `Unsupported urn: '${format(urn)}'`;
+  else return urn;
+}

src/clock.ts

@@ -1,16 +1,54 @@
 import dayjs, { Dayjs } from "dayjs";
 
-export const isChristmas = (clock: Clock = SystemClock) => clock.now().month() == 11 && clock.now().date() == 25;
+function fixedDateMonthEvent(dateMonth: string) {
-export const isMay4 = (clock: Clock = SystemClock) => clock.now().month() == 4 && clock.now().date() == 4;
+  const date = Number.parseInt(dateMonth.split("/")[0]!);
-export const isHalloween = (clock: Clock = SystemClock) => clock.now().month() == 9 && clock.now().date() == 31
+  const month = Number.parseInt(dateMonth.split("/")[1]!);
-export const isHoli = (clock: Clock = SystemClock) => ["2022/03/18", "2023/03/07", "2024/03/25", "2025/03/14"].map(dayjs).find(it => it.isSame(clock.now())) != undefined
+  return (clock: Clock = SystemClock) => {
-export const isCNY = (clock: Clock = SystemClock) => ["2022/02/01", "2023/01/22", "2024/02/10", "2025/02/29"].map(dayjs).find(it => it.isSame(clock.now())) != undefined
+    return clock.now().date() == date && clock.now().month() == month - 1;
-export const isCNY_2022 = (clock: Clock = SystemClock) => clock.now().isSame(dayjs("2022/02/01"))
+  };
-export const isCNY_2023 = (clock: Clock = SystemClock) => clock.now().isSame(dayjs("2023/01/22"))
+}
-export const isCNY_2024 = (clock: Clock = SystemClock) => clock.now().isSame(dayjs("2024/02/10"))
+
+function fixedDateEvent(date: string) {
+  const dayjsDate = dayjs(date);
+  return (clock: Clock = SystemClock) => {
+    return clock.now().isSame(dayjsDate, "day");
+  };
+}
+
+function anyOf(rules: ((clock: Clock) => boolean)[]) {
+  return (clock: Clock = SystemClock) => {
+    return rules.find((rule) => rule(clock)) != undefined;
+  };
+}
+
+export const isChristmas = fixedDateMonthEvent("25/12");
+export const isMay4 = fixedDateMonthEvent("04/05");
+export const isHalloween = fixedDateMonthEvent("31/10");
+export const isHoli = anyOf(
+  ["2022/03/18", "2023/03/07", "2024/03/25", "2025/03/14"].map(fixedDateEvent)
+)
+
+export const isCNY_2022 = fixedDateEvent("2022/02/01");
+export const isCNY_2023 = fixedDateEvent("2023/01/22");
+export const isCNY_2024 = fixedDateEvent("2024/02/10");
+export const isCNY_2025 = fixedDateEvent("2025/02/29");
+export const isCNY = anyOf([isCNY_2022, isCNY_2023, isCNY_2024, isCNY_2025]);
 
 export interface Clock {
   now(): Dayjs;
 }
 
 export const SystemClock = { now: () => dayjs() };
+
+export class FixedClock implements Clock {
+  time: Dayjs;
+
+  constructor(time: Dayjs = dayjs()) {
+    this.time = time;
+  }
+
+  add = (t: number, unit: dayjs.UnitTypeShort) =>
+    (this.time = this.time.add(t, unit));
+
+  now = () => this.time;
+}

src/config.ts

@@ -2,56 +2,108 @@ import { hostname } from "os";
 import logger from "./logger";
 import url from "./url_builder";
 
+export const WORD = /^\w+$/;
+export const COLOR = /^#?\w+$/;
+
+type EnvVarOpts<T> = {
+  default: T | undefined;
+  legacy: string[] | undefined;
+  validationPattern: RegExp | undefined;
+  parser: ((value: string) => T) | undefined
+};
+
+export function envVar<T>(
+  name: string,
+  opts: Partial<EnvVarOpts<T>> = {
+    default: undefined,
+    legacy: undefined,
+    validationPattern: undefined,
+    parser: undefined
+  }
+): T {
+  const result = [name, ...(opts.legacy || [])]
+    .map((it) => ({ key: it, value: process.env[it] }))
+    .find((it) => it.value);
+
+  if (
+    result &&
+    result.value && 
+    opts.validationPattern &&
+    !result.value.match(opts.validationPattern)
+  ) {
+    throw `Invalid value specified for '${name}', must match ${opts.validationPattern}`;
+  }
+
+  if(result && result.value && result.key != name) {
+    logger.warn(`Configuration key '${result.key}' is deprecated, replace with '${name}'`)
+  }
+
+  let value: T | undefined = undefined;
+
+  if(result?.value && opts.parser) {
+    value = opts.parser(result?.value)
+  } else if(result?.value)
+    value = result?.value as any as T
+
+  return value == undefined ? opts.default as T : value;
+}
+
+export const bnbEnvVar = <T>(key: string, opts: Partial<EnvVarOpts<T>> = {}) =>
+  envVar(`BNB_${key}`, {
+    ...opts,
+    legacy: [`BONOB_${key}`, ...(opts.legacy || [])],
+  });
+
+const asBoolean = (value: string) => value == "true";
+
+const asInt = (value: string) => Number.parseInt(value);
+
 export default function () {
-  const port = +(process.env["BONOB_PORT"] || 4534);
+  const port = bnbEnvVar<number>("PORT", { default: 4534, parser: asInt })!;
-  const bonobUrl =
+  const bonobUrl = bnbEnvVar("URL", {
-    process.env["BONOB_URL"] ||
+    legacy: ["BONOB_WEB_ADDRESS"],
-    process.env["BONOB_WEB_ADDRESS"] ||
+    default: `http://${hostname()}:${port}`,
-    `http://${hostname()}:${port}`;
+  })!;
 
   if (bonobUrl.match("localhost")) {
     logger.error(
-      "BONOB_URL containing localhost is almost certainly incorrect, sonos devices will not be able to communicate with bonob using localhost, please specify either public IP or DNS entry"
+      "BNB_URL containing localhost is almost certainly incorrect, sonos devices will not be able to communicate with bonob using localhost, please specify either public IP or DNS entry"
     );
     process.exit(1);
   }
 
-  const wordFrom = (envVar: string) => {
-    const value = process.env[envVar];
-    if (value && value != "") {
-      if (value.match(/^\w+$/)) return value;
-      else throw `Invalid color specified for ${envVar}`;
-    } else {
-      return undefined;
-    }
-  };
-
   return {
     port,
     bonobUrl: url(bonobUrl),
-    secret: process.env["BONOB_SECRET"] || "bonob",
+    secret: bnbEnvVar<string>("SECRET", { default: "bonob" })!,
+    authTimeout: bnbEnvVar<string>("AUTH_TIMEOUT", { default: "1h" })!,
     icons: {
-      foregroundColor: wordFrom("BONOB_ICON_FOREGROUND_COLOR"),
+      foregroundColor: bnbEnvVar<string>("ICON_FOREGROUND_COLOR", {
-      backgroundColor: wordFrom("BONOB_ICON_BACKGROUND_COLOR"),
+        validationPattern: COLOR,
+      }),
+      backgroundColor: bnbEnvVar<string>("ICON_BACKGROUND_COLOR", {
+        validationPattern: COLOR,
+      }),
     },
+    logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
     sonos: {
-      serviceName: process.env["BONOB_SONOS_SERVICE_NAME"] || "bonob",
+      serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
       discovery: {
-        auto:
+        enabled:
-          (process.env["BONOB_SONOS_DEVICE_DISCOVERY"] || "true") == "true",
+          bnbEnvVar<boolean>("SONOS_DEVICE_DISCOVERY", { default: true, parser: asBoolean }),
-        seedHost: process.env["BONOB_SONOS_SEED_HOST"],
+        seedHost: bnbEnvVar<string>("SONOS_SEED_HOST"),
       },
       autoRegister:
-        (process.env["BONOB_SONOS_AUTO_REGISTER"] || "false") == "true",
+        bnbEnvVar<boolean>("SONOS_AUTO_REGISTER", { default: false, parser: asBoolean }),
-      sid: Number(process.env["BONOB_SONOS_SERVICE_ID"] || "246"),
+      sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
     },
-    navidrome: {
+    subsonic: {
-      url: process.env["BONOB_NAVIDROME_URL"] || `http://${hostname()}:4533`,
+      url: url(bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!),
-      customClientsFor:
+      customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
-        process.env["BONOB_NAVIDROME_CUSTOM_CLIENTS"] || undefined,
+      artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"),
     },
-    scrobbleTracks: (process.env["BONOB_SCROBBLE_TRACKS"] || "true") == "true",
+    scrobbleTracks: bnbEnvVar<boolean>("SCROBBLE_TRACKS", { default: true, parser: asBoolean }),
     reportNowPlaying:
-      (process.env["BONOB_REPORT_NOW_PLAYING"] || "true") == "true",
+      bnbEnvVar<boolean>("REPORT_NOW_PLAYING", { default: true, parser: asBoolean }),
   };
 }

src/encryption.ts

@@ -1,33 +1,78 @@
-import { createCipheriv, createDecipheriv, randomBytes, createHash } from "crypto";
+import {
+  createCipheriv,
+  createDecipheriv,
+  randomBytes,
+  createHash,
+} from "crypto";
+import { option as O, either as E } from "fp-ts";
+import { Either, left, right } from 'fp-ts/Either'
+import { pipe } from "fp-ts/lib/function";
+import jws from "jws";
 
-const ALGORITHM = "aes-256-cbc"
+const ALGORITHM = "aes-256-cbc";
 const IV = randomBytes(16);
 
 export type Hash = {
-  iv: string,
+  iv: string;
-  encryptedData: string
+  encryptedData: string;
-}
+};
 
 export type Encryption = {
-  encrypt: (value:string) => Hash
+  encrypt: (value: string) => string;
-  decrypt: (hash: Hash) => string
+  decrypt: (value: string) => Either<string, string>;
-}
+};
 
-const encryption = (secret: string): Encryption => {
+export const jwsEncryption = (secret: string): Encryption => {
-  const key = createHash('sha256').update(String(secret)).digest('base64').substr(0, 32);
   return {
-    encrypt: (value: string) => {
+    encrypt: (value: string) => jws.sign({
-      const cipher = createCipheriv(ALGORITHM, key, IV);
+      header: { alg: 'HS256' },
-      return { 
+      payload: value,
-        iv: IV.toString("hex"), 
+      secret: secret,
-        encryptedData: Buffer.concat([cipher.update(value), cipher.final()]).toString("hex") 
+    }),
-      };
+    decrypt: (value: string) => pipe(
-    },
+      jws.decode(value),
-    decrypt: (hash: Hash) => {
+      O.fromNullable,
-      const decipher = createDecipheriv(ALGORITHM, key, Buffer.from(hash.iv, 'hex'));
+      O.map(it => it.payload),
-      return Buffer.concat([decipher.update(Buffer.from(hash.encryptedData, 'hex')), decipher.final()]).toString();
+      O.match(
-    }
+        () => left("Failed to decrypt jws"),
+        (payload) => right(payload)
+      )
+    )
   }
 }
 
-export default encryption;
+export const cryptoEncryption = (secret: string): Encryption => {
+  const key = createHash("sha256")
+    .update(String(secret))
+    .digest("base64")
+    .substring(0, 32);
+
+  return {
+    encrypt: (value: string) => {
+      const cipher = createCipheriv(ALGORITHM, key, IV);
+      return `${IV.toString("hex")}.${Buffer.concat([
+        cipher.update(value),
+        cipher.final(),
+      ]).toString("hex")}`;
+    },
+    decrypt: (value: string) => pipe(
+      right(value),
+      E.map(it => it.split(".")),
+      E.flatMap(it => it.length == 2 ? right({ iv: it[0]!, data: it[1]! }) : left("Invalid value to decrypt")),
+      E.map(it => ({
+        hash: it,
+        decipher: createDecipheriv(
+          ALGORITHM,
+          key,
+          Buffer.from(it.iv, "hex")
+        )
+      })),
+      E.map(it => Buffer.concat([
+        it.decipher.update(Buffer.from(it.hash.data, "hex")),
+        it.decipher.final(),
+      ]).toString())
+    ),
+  };
+};
+
+export default jwsEncryption;

src/i8n.ts

@@ -4,15 +4,16 @@ import { option as O } from "fp-ts";
 import _ from "underscore";
 
 export type LANG = "en-US" | "da-DK" | "de-DE" | "es-ES" | "fr-FR" | "it-IT" | "ja-JP" | "nb-NO" | "nl-NL" | "pt-BR" | "sv-SE" | "zh-CN"
-export type SUPPORTED_LANG = "en-US" | "nl-NL";
+export type SUPPORTED_LANG = "en-US" | "da-DK" | "fr-FR" | "nl-NL";
 export type KEY =
   | "AppLinkMessage"
   | "artists"
   | "albums"
+  | "internetRadio"  
   | "playlists"
   | "genres"
   | "random"
-  | "starred"
+  | "topRated"
   | "recentlyAdded"
   | "recentlyPlayed"
   | "mostPlayed"
@@ -37,18 +38,27 @@ export type KEY =
   | "invalidLinkCode"
   | "loginSuccessful"
   | "loginFailed" 
-  | "noSonosDevices";
+  | "noSonosDevices" 
+  | "favourites"
+  | "years"
+  | "LOVE"
+  | "LOVE_SUCCESS"
+  | "STAR" 
+  | "UNSTAR"
+  | "STAR_SUCCESS"
+  | "UNSTAR_SUCCESS";
 
 const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
   "en-US": {
-    AppLinkMessage: "Linking sonos with $BONOB_SONOS_SERVICE_NAME",
+    AppLinkMessage: "Linking sonos with $BNB_SONOS_SERVICE_NAME",
     artists: "Artists",
     albums: "Albums",
+    internetRadio: "Internet Radio",
     tracks: "Tracks",
     playlists: "Playlists",
     genres: "Genres",
     random: "Random",
-    starred: "Starred",
+    topRated: "Top Rated",
     recentlyAdded: "Recently added",
     recentlyPlayed: "Recently played",
     mostPlayed: "Most played",
@@ -62,7 +72,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     devices: "Devices",
     services: "Services",
     login: "Login",
-    logInToBonob: "Log in to $BONOB_SONOS_SERVICE_NAME",
+    logInToBonob: "Log in to $BNB_SONOS_SERVICE_NAME",
     username: "Username",
     password: "Password",
     successfullyRegistered: "Successfully registered",
@@ -73,16 +83,111 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     loginSuccessful: "Login successful!",
     loginFailed: "Login failed!",
     noSonosDevices: "No sonos devices",
+    favourites: "Favourites",
+    years: "Years",
+    STAR: "Star",
+    UNSTAR: "Un-star",
+    STAR_SUCCESS: "Track starred",
+    UNSTAR_SUCCESS: "Track un-starred",
+    LOVE: "Love",
+    LOVE_SUCCESS: "Track loved"
+  },
+  "da-DK": {
+    AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME",
+    artists: "Kunstnere",
+    albums: "Album",
+    internetRadio: "Internet Radio",
+    tracks: "Numre",
+    playlists: "Afspilningslister",
+    genres: "Genre",
+    random: "Tilfældig",
+    topRated: "Højst vurderet",
+    recentlyAdded: "Senest tilføjet",
+    recentlyPlayed: "Senest afspillet",
+    mostPlayed: "Flest afspilninger",
+    success: "Succes",
+    failure: "Fejl",
+    expectedConfig: "Forventet konfiguration",
+    existingServiceConfig: "Eksisterende tjeneste konfiguration",
+    noExistingServiceRegistration: "Ingen eksisterende tjeneste registrering",
+    register: "Registrer",
+    removeRegistration: "Fjern registrering",
+    devices: "Enheder",
+    services: "Tjenester",
+    login: "Log på",
+    logInToBonob: "Log på $BNB_SONOS_SERVICE_NAME",
+    username: "Brugernavn",
+    password: "Adgangskode",
+    successfullyRegistered: "Registreret med succes",
+    registrationFailed: "Registrering fejlede!",
+    successfullyRemovedRegistration: "Registrering fjernet med succes",
+    failedToRemoveRegistration: "FJernelse af registrering fejlede!",
+    invalidLinkCode: "Ugyldig linkCode!",
+    loginSuccessful: "Log på succes!",
+    loginFailed: "Log på fejlede!",
+    noSonosDevices: "Ingen Sonos enheder",
+    favourites: "Favoritter",
+    years: "Flere år",
+    STAR: "Tilføj stjerne",
+    UNSTAR: "Fjern stjerne",
+    STAR_SUCCESS: "Stjerne tilføjet",
+    UNSTAR_SUCCESS: "Stjerne fjernet",
+    LOVE: "Synes godt om",
+    LOVE_SUCCESS: "Syntes godt om"
+  },
+  "fr-FR": {
+    AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
+    artists: "Artistes",
+    albums: "Albums",
+    internetRadio: "Radio Internet",
+    tracks: "Pistes",
+    playlists: "Playlists",
+    genres: "Genres",
+    random: "Aléatoire",
+    topRated: "Les mieux notés",
+    recentlyAdded: "Récemment ajouté",
+    recentlyPlayed: "Récemment joué",
+    mostPlayed: "Les plus joué",
+    success: "Succès",
+    failure: "Échec",
+    expectedConfig: "Configuration attendue",
+    existingServiceConfig: "La configuration de service existe",
+    noExistingServiceRegistration: "Aucun enregistrement de service existant",
+    register: "Inscription",
+    removeRegistration: "Supprimer l'inscription",
+    devices: "Appareils",
+    services: "Services",
+    login: "Se connecter",
+    logInToBonob: "Se connecter à $BNB_SONOS_SERVICE_NAME",
+    username: "Nom d'utilisateur",
+    password: "Mot de passe",
+    successfullyRegistered: "Connecté avec succès",
+    registrationFailed: "Échec de la connexion !",
+    successfullyRemovedRegistration: "Inscription supprimée avec succès",
+    failedToRemoveRegistration: "Échec de la suppression de l'inscription !",
+    invalidLinkCode: "Code non valide !",
+    loginSuccessful: "Connexion réussie !",
+    loginFailed: "La connexion a échoué !",
+    noSonosDevices: "Aucun appareil Sonos",
+    favourites: "Favoris",
+    years: "Années",
+    STAR: "Suivre",
+    UNSTAR: "Ne plus suivre",
+    STAR_SUCCESS: "Piste suivie",
+    UNSTAR_SUCCESS: "Piste non suivie",
+    LOVE: "Aimer",
+    LOVE_SUCCESS: "Pistes aimée"
   },
   "nl-NL": {
-    AppLinkMessage: "Sonos koppelen aan $BONOB_SONOS_SERVICE_NAME",
+    AppLinkMessage: "Sonos koppelen aan $BNB_SONOS_SERVICE_NAME",
     artists: "Artiesten",
     albums: "Albums",
+    internetRadio: "Internet Radio",
     tracks: "Nummers",
     playlists: "Afspeellijsten",
     genres: "Genres",
     random: "Willekeurig",
-    starred: "Favorieten",
+    topRated: "Best beoordeeld",
     recentlyAdded: "Onlangs toegevoegd",
     recentlyPlayed: "Onlangs afgespeeld",
     mostPlayed: "Meest afgespeeld",
@@ -96,7 +201,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     devices: "Apparaten",
     services: "Services",
     login: "Inloggen",
-    logInToBonob: "Login op $BONOB_SONOS_SERVICE_NAME",
+    logInToBonob: "Login op $BNB_SONOS_SERVICE_NAME",
     username: "Gebruikersnaam",
     password: "Wachtwoord",
     successfullyRegistered: "Registratie geslaagd",
@@ -107,6 +212,14 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     loginSuccessful: "Inloggen gelukt!",
     loginFailed: "Inloggen mislukt!",
     noSonosDevices: "Geen Sonos-apparaten",
+    favourites: "Favorieten",
+    years: "Jaren",
+    STAR: "Ster ",
+    UNSTAR: "Een ster",
+    STAR_SUCCESS: "Nummer met ster",
+    UNSTAR_SUCCESS: "Track zonder ster",
+    LOVE: "Liefde",
+    LOVE_SUCCESS: "Volg geliefd"
   },
 };
 
@@ -151,7 +264,7 @@ export default (serviceName: string): I8N =>
       translations["en-US"];
     return (key: KEY) => {
       const value = langToUse[key]?.replace(
-        "$BONOB_SONOS_SERVICE_NAME",
+        "$BNB_SONOS_SERVICE_NAME",
         serviceName
       );
       if (value) return value;

src/icon.ts

@@ -1,4 +1,5 @@
-import libxmljs, { Element, Attribute } from "libxmljs2";
+import * as xpath from "xpath";
+import { DOMParser, Node } from '@xmldom/xmldom';
 import _ from "underscore";
 import fs from "fs";
 
@@ -13,11 +14,10 @@ import {
   isMay4,
   SystemClock,
 } from "./clock";
+import { xmlTidy } from "./utils";
 import path from "path";
 
-const SVG_NS = {
+const SVG_NS = "http://www.w3.org/2000/svg";
-  svg: "http://www.w3.org/2000/svg",
-};
 
 class ViewBox {
   minX: number;
@@ -48,8 +48,16 @@ export type IconFeatures = {
   viewPortIncreasePercent: number | undefined;
   backgroundColor: string | undefined;
   foregroundColor: string | undefined;
+  text: string | undefined;
 };
 
+export const NO_FEATURES: IconFeatures = {
+  viewPortIncreasePercent: undefined,
+  backgroundColor: undefined,
+  foregroundColor: undefined,
+  text: undefined
+}
+
 export type IconSpec = {
   svg: string | undefined;
   features: Partial<IconFeatures> | undefined;
@@ -93,17 +101,11 @@ export class SvgIcon implements Icon {
 
   constructor(
     svg: string,
-    features: Partial<IconFeatures> = {
+    features: Partial<IconFeatures> = {}
-      viewPortIncreasePercent: undefined,
-      backgroundColor: undefined,
-      foregroundColor: undefined,
-    }
   ) {
     this.svg = svg;
     this.features = {
-      viewPortIncreasePercent: undefined,
+      ...NO_FEATURES,
-      backgroundColor: undefined,
-      foregroundColor: undefined,
       ...features,
     };
   }
@@ -117,38 +119,44 @@ export class SvgIcon implements Icon {
     });
 
   public toString = () => {
-    const xml = libxmljs.parseXmlString(this.svg, {
+    const doc = new DOMParser().parseFromString(this.svg, 'text/xml') as unknown as Document;
-      noblanks: true,
+    const select = xpath.useNamespaces({ svg: SVG_NS });
-      net: false,
+
-    });
+    const elements = (path: string) => (select(path, doc) as Element[])
-    const viewBoxAttr = xml.get("//svg:svg/@viewBox", SVG_NS) as Attribute;
+    const element = (path: string) => elements(path)[0]!
-    let viewBox = new ViewBox(viewBoxAttr.value());
+
+    let viewBox = new ViewBox(select("string(//svg:svg/@viewBox)", doc) as string);
     if (
       this.features.viewPortIncreasePercent &&
       this.features.viewPortIncreasePercent > 0
     ) {
       viewBox = viewBox.increasePercent(this.features.viewPortIncreasePercent);
-      viewBoxAttr.value(viewBox.toString());
+      element("//svg:svg").setAttribute("viewBox", viewBox.toString());
     }
-    if (this.features.backgroundColor) {
+    if(this.features.text) {
-      (xml.get("//svg:svg/*[1]", SVG_NS) as Element).addPrevSibling(
+      elements("//svg:text").forEach((text) => {
-        new Element(xml, "rect").attr({
+        text.textContent = this.features.text!
-          x: `${viewBox.minX}`,
-          y: `${viewBox.minY}`,
-          width: `${Math.abs(viewBox.minX) + viewBox.width}`,
-          height: `${Math.abs(viewBox.minY) + viewBox.height}`,
-          fill: this.features.backgroundColor,
-        })
-      );
-    }
-    if (this.features.foregroundColor) {
-      (xml.find("//svg:path", SVG_NS) as Element[]).forEach((path) => {
-        if (path.attr("fill"))
-          path.attr({ stroke: this.features.foregroundColor! });
-        else path.attr({ fill: this.features.foregroundColor! });
       });
     }
-    return xml.toString();
+    if (this.features.foregroundColor) {
+      elements("//svg:path|//svg:text").forEach((path) => {
+        if (path.getAttribute("fill")) path.setAttribute("stroke", this.features.foregroundColor!);
+        else path.setAttribute("fill", this.features.foregroundColor!);
+      });
+    }
+    if (this.features.backgroundColor) {
+      const rect = doc.createElementNS(SVG_NS, "rect");
+      rect.setAttribute("x", `${viewBox.minX}`);
+      rect.setAttribute("y", `${viewBox.minY}`);
+      rect.setAttribute("width", `${Math.abs(viewBox.minX) + viewBox.width}`);
+      rect.setAttribute("height", `${Math.abs(viewBox.minY) + viewBox.height}`);
+      rect.setAttribute("fill", this.features.backgroundColor);
+      
+      const svg = element("//svg:svg")
+      svg.insertBefore(rect, svg.childNodes[0]!);
+    }
+    
+    return xmlTidy(doc as unknown as Node);
   };
 }
 
@@ -163,10 +171,11 @@ export const HOLI_COLORS = [
 export type ICON =
   | "artists"
   | "albums"
+  | "radio"
   | "playlists"
   | "genres"
   | "random"
-  | "starred"
+  | "topRated"
   | "recentlyAdded"
   | "recentlyPlayed"
   | "mostPlayed"
@@ -225,23 +234,31 @@ export type ICON =
   | "skywalker"
   | "leia"
   | "r2d2"
-  | "yoda";
+  | "yoda" 
+  | "heart"
+  | "star" 
+  | "solidStar"
+  | "yy"
+  | "yyyy";
 
-const iconFrom = (name: string) =>
+const svgFrom = (name: string) =>
   new SvgIcon(
     fs
       .readFileSync(path.resolve(__dirname, "..", "web", "icons", name))
       .toString()
   );
 
+const iconFrom = (name: string) => svgFrom(name).with({ features: { viewPortIncreasePercent: 80 } });
+    
 export const ICONS: Record<ICON, SvgIcon> = {
   artists: iconFrom("navidrome-artists.svg"),
   albums: iconFrom("navidrome-all.svg"),
-  blank: iconFrom("blank.svg"),
+  radio: iconFrom("navidrome-radio.svg"),
+  blank: svgFrom("blank.svg"),
   playlists: iconFrom("navidrome-playlists.svg"),
   genres: iconFrom("Theatre-Mask-111172.svg"),
   random: iconFrom("navidrome-random.svg"),
-  starred: iconFrom("navidrome-topRated.svg"),
+  topRated: iconFrom("navidrome-topRated.svg"),
   recentlyAdded: iconFrom("navidrome-recentlyAdded.svg"),
   recentlyPlayed: iconFrom("navidrome-recentlyPlayed.svg"),
   mostPlayed: iconFrom("navidrome-mostPlayed.svg"),
@@ -300,6 +317,11 @@ export const ICONS: Record<ICON, SvgIcon> = {
   leia: iconFrom("Princess-Leia-68568.svg"),
   r2d2: iconFrom("R2-D2-39423.svg"),
   yoda: iconFrom("Yoda-68107.svg"),
+  heart: iconFrom("Heart-85038.svg"),
+  star: iconFrom("Star-16101.svg"),
+  solidStar: iconFrom("Star-43879.svg"),
+  yy: svgFrom("yy.svg"),
+  yyyy: svgFrom("yyyy.svg"),
 };
 
 export const STAR_WARS = [ICONS.c3po, ICONS.chewy, ICONS.darth, ICONS.skywalker, ICONS.leia, ICONS.r2d2, ICONS.yoda];

src/link_codes.ts

@@ -2,7 +2,7 @@ import { v4 as uuid } from 'uuid';
 
 
 export type Association = {
-  authToken: string
+  serviceToken: string
   userId: string
   nickname: string  
 }

src/logger.ts

@@ -6,7 +6,7 @@ export function debugIt<T>(thing: T): T {
 }
 
 const logger = createLogger({
-    level: 'debug',
+    level: process.env["BNB_LOG_LEVEL"] || 'info',
     format: format.combine(
       format.timestamp({
         format: 'YYYY-MM-DD HH:mm:ss'

src/music_library.ts

@@ -1,48 +1,30 @@
+import { BUrn } from "./burn";
+import { taskEither as TE } from "fp-ts";
+
 export type Credentials = { username: string; password: string };
 
-export function isSuccess(
-  authResult: AuthSuccess | AuthFailure
-): authResult is AuthSuccess {
-  return (authResult as AuthSuccess).authToken !== undefined;
-}
-
-export function isFailure(
-  authResult: any | AuthFailure
-): authResult is AuthFailure {
-  return (authResult as AuthFailure).message !== undefined;
-}
-
 export type AuthSuccess = {
-  authToken: string;
+  serviceToken: string;
   userId: string;
   nickname: string;
 };
 
-export type AuthFailure = {
+export class AuthFailure extends Error {
-  message: string;
+  constructor(message: string) {
+    super(message);
+  }
 };
 
 export type ArtistSummary = {
-  id: string;
+  id: string | undefined;
   name: string;
-};
+  image: BUrn | undefined;
-
-export type Images = {
-  small: string | undefined;
-  medium: string | undefined;
-  large: string | undefined;
-};
-
-export const NO_IMAGES: Images = {
-  small: undefined,
-  medium: undefined,
-  large: undefined,
 };
 
 export type SimilarArtist = ArtistSummary & { inLibrary: boolean };
 
-export type Artist = ArtistSummary & {
+// todo: maybe is should be artist.summary rather than an artist also being a summary?
-  image: Images
+export type Artist = Pick<ArtistSummary, "id" | "name" | "image">  & {
   albums: AlbumSummary[];
   similarArtists: SimilarArtist[]
 };
@@ -52,29 +34,55 @@ export type AlbumSummary = {
   name: string;
   year: string | undefined;
   genre: Genre | undefined;
-
+  coverArt: BUrn | undefined;
-  artistName: string;
+  artistName: string | undefined;
-  artistId: string;
+  artistId: string | undefined;
 };
 
-export type Album = AlbumSummary & {};
+export type Album = Pick<AlbumSummary, "id" | "name" | "year" | "genre" | "coverArt" | "artistName" | "artistId"> & { tracks: Track[] };
 
 export type Genre = {
   name: string;
   id: string;
 }
 
-export type Track = {
+export type Year = {
+  year: string;
+}
+
+export type Rating = {
+  love: boolean;
+  stars: number;
+}
+
+export type Encoding = {
+  player: string,
+  mimeType: string
+}
+
+export type TrackSummary = {
   id: string;
   name: string;
-  mimeType: string;
+  encoding: Encoding,
   duration: number;
   number: number | undefined;
   genre: Genre | undefined;
-  album: AlbumSummary;
+  coverArt: BUrn | undefined;
   artist: ArtistSummary;
+  rating: Rating;
+}
+
+export type Track = TrackSummary & {
+  album: AlbumSummary;
 };
 
+export type RadioStation = {
+  id: string,
+  name: string,
+  url: string,
+  homePage?: string
+}
+
 export type Paging = {
   _index: number;
   _count: number;
@@ -99,16 +107,19 @@ export const asResult = <T>([results, total]: [T[], number]) => ({
 
 export type ArtistQuery = Paging;
 
-export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'random' | 'recent' | 'frequent' | 'newest' | 'starred';
+export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'byYear' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
 
 export type AlbumQuery = Paging & {
   type: AlbumQueryType;
   genre?: string;
+  fromYear?: string;
+  toYear?: string;
 };
 
 export const artistToArtistSummary = (it: Artist): ArtistSummary => ({
   id: it.id,
   name: it.name,
+  image: it.image
 });
 
 export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
@@ -118,11 +129,25 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
   genre: it.genre,
   artistName: it.artistName,
   artistId: it.artistId,
+  coverArt: it.coverArt
+});
+
+export const trackToTrackSummary = (it: Track): TrackSummary => ({
+  id: it.id,
+  name: it.name,
+  encoding: it.encoding,
+  duration: it.duration,
+  number: it.number,
+  genre: it.genre,
+  coverArt: it.coverArt,
+  artist: it.artist,
+  rating: it.rating
 });
 
 export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({
   id: it.id,
-  name: it.name
+  name: it.name,
+  coverArt: it.coverArt
 })
 
 export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges";
@@ -140,7 +165,8 @@ export type CoverArt = {
 
 export type PlaylistSummary = {
   id: string,
-  name: string
+  name: string,
+  coverArt?: BUrn | undefined
 }
 
 export type Playlist = PlaylistSummary & {
@@ -155,8 +181,9 @@ export const asArtistAlbumPairs = (artists: Artist[]): [Artist, Album][] =>
   );
 
 export interface MusicService {
-  generateToken(credentials: Credentials): Promise<AuthSuccess | AuthFailure>;
+  generateToken(credentials: Credentials): TE.TaskEither<AuthFailure, AuthSuccess>;
-  login(authToken: string): Promise<MusicLibrary>;
+  refreshToken(serviceToken: string): TE.TaskEither<AuthFailure, AuthSuccess>;
+  login(serviceToken: string): Promise<MusicLibrary>;
 }
 
 export interface MusicLibrary {
@@ -164,9 +191,9 @@ export interface MusicLibrary {
   artist(id: string): Promise<Artist>;
   albums(q: AlbumQuery): Promise<Result<AlbumSummary>>;
   album(id: string): Promise<Album>;
-  tracks(albumId: string): Promise<Track[]>;
   track(trackId: string): Promise<Track>;
   genres(): Promise<Genre[]>;
+  years(): Promise<Year[]>;
   stream({
     trackId,
     range,
@@ -174,7 +201,8 @@ export interface MusicLibrary {
     trackId: string;
     range: string | undefined;
   }): Promise<TrackStream>;
-  coverArt(id: string, type: "album" | "artist", size?: number): Promise<CoverArt | undefined>;
+  rate(trackId: string, rating: Rating): Promise<boolean>;
+  coverArt(coverArtURN: BUrn, size?: number): Promise<CoverArt | undefined>;
   nowPlaying(id: string): Promise<boolean>
   scrobble(id: string): Promise<boolean>
   searchArtists(query: string): Promise<ArtistSummary[]>;
@@ -186,6 +214,8 @@ export interface MusicLibrary {
   deletePlaylist(id: string): Promise<boolean>
   addToPlaylist(playlistId: string, trackId: string): Promise<boolean>
   removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
-  similarSongs(id: string): Promise<Track[]>;
+  similarSongs(id: string): Promise<TrackSummary[]>;
-  topSongs(artistId: string): Promise<Track[]>;
+  topSongs(artistId: string): Promise<TrackSummary[]>;
+  radioStation(id: string): Promise<RadioStation>
+  radioStations(): Promise<RadioStation[]>
 }

src/navidrome.ts

@@ -1,798 +0,0 @@
-import { option as O } from "fp-ts";
-import * as A from "fp-ts/Array";
-import { ordString } from "fp-ts/lib/Ord";
-import { pipe } from "fp-ts/lib/function";
-import { Md5 } from "ts-md5/dist/md5";
-import {
-  Credentials,
-  MusicService,
-  Album,
-  Artist,
-  ArtistSummary,
-  Result,
-  slice2,
-  AlbumQuery,
-  ArtistQuery,
-  MusicLibrary,
-  Images,
-  AlbumSummary,
-  Genre,
-  Track,
-} from "./music_service";
-import X2JS from "x2js";
-import sharp from "sharp";
-import _, { pick } from "underscore";
-
-import axios, { AxiosRequestConfig } from "axios";
-import { Encryption } from "./encryption";
-import randomString from "./random_string";
-
-export const BROWSER_HEADERS = {
-  accept:
-    "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
-  "accept-encoding": "gzip, deflate, br",
-  "accept-language": "en-GB,en;q=0.5",
-  "upgrade-insecure-requests": "1",
-  "user-agent":
-    "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:86.0) Gecko/20100101 Firefox/86.0",
-};
-
-export const t = (password: string, s: string) =>
-  Md5.hashStr(`${password}${s}`);
-
-export const t_and_s = (password: string) => {
-  const s = randomString();
-  return {
-    t: t(password, s),
-    s,
-  };
-};
-
-export const DODGY_IMAGE_NAME = "2a96cbd8b46e442fc41c2b86b821562f.png";
-
-export const isDodgyImage = (url: string) => url.endsWith(DODGY_IMAGE_NAME);
-
-export const validate = (url: string | undefined) =>
-  url && !isDodgyImage(url) ? url : undefined;
-
-export type SubconicEnvelope = {
-  "subsonic-response": SubsonicResponse;
-};
-
-export type SubsonicResponse = {
-  _status: string;
-};
-
-export type album = {
-  _id: string;
-  _name: string;
-  _genre: string | undefined;
-  _year: string | undefined;
-  _coverArt: string | undefined;
-  _artist: string;
-  _artistId: string;
-};
-
-export type artistSummary = {
-  _id: string;
-  _name: string;
-  _albumCount: string;
-  _artistImageUrl: string | undefined;
-};
-
-export type GetArtistsResponse = SubsonicResponse & {
-  artists: {
-    index: {
-      artist: artistSummary[];
-      _name: string;
-    }[];
-  };
-};
-
-export type GetAlbumListResponse = SubsonicResponse & {
-  albumList2: {
-    album: album[];
-  };
-};
-
-export type genre = {
-  _songCount: string;
-  _albumCount: string;
-  __text: string;
-};
-
-export type GetGenresResponse = SubsonicResponse & {
-  genres: {
-    genre: genre[];
-  };
-};
-
-export type SubsonicError = SubsonicResponse & {
-  error: {
-    _code: string;
-    _message: string;
-  };
-};
-
-export type artistInfo = {
-  biography: string | undefined;
-  musicBrainzId: string | undefined;
-  lastFmUrl: string | undefined;
-  smallImageUrl: string | undefined;
-  mediumImageUrl: string | undefined;
-  largeImageUrl: string | undefined;
-  similarArtist: artistSummary[];
-};
-
-export type ArtistInfo = {
-  image: Images;
-  similarArtist: (ArtistSummary & { inLibrary: boolean })[];
-};
-
-export type GetArtistInfoResponse = SubsonicResponse & {
-  artistInfo2: artistInfo;
-};
-
-export type GetArtistResponse = SubsonicResponse & {
-  artist: artistSummary & {
-    album: album[];
-  };
-};
-
-export type song = {
-  _id: string;
-  _parent: string;
-  _title: string;
-  _album: string;
-  _artist: string;
-  _track: string | undefined;
-  _genre: string;
-  _coverArt: string;
-  _created: "2004-11-08T23:36:11";
-  _duration: string | undefined;
-  _bitRate: "128";
-  _suffix: "mp3";
-  _contentType: string;
-  _albumId: string;
-  _artistId: string;
-  _type: "music";
-};
-
-export type GetAlbumResponse = {
-  album: album & {
-    song: song[];
-  };
-};
-
-export type playlist = {
-  _id: string;
-  _name: string;
-};
-
-export type entry = {
-  _id: string;
-  _parent: string;
-  _title: string;
-  _album: string;
-  _artist: string;
-  _track: string;
-  _year: string;
-  _genre: string;
-  _contentType: string;
-  _duration: string;
-  _albumId: string;
-  _artistId: string;
-};
-
-export type GetPlaylistResponse = {
-  playlist: {
-    _id: string;
-    _name: string;
-    entry: entry[];
-  };
-};
-
-export type GetPlaylistsResponse = {
-  playlists: { playlist: playlist[] };
-};
-
-export type GetSimilarSongsResponse = {
-  similarSongs2: { song: song[] };
-};
-
-export type GetTopSongsResponse = {
-  topSongs: { song: song[] };
-};
-
-export type GetSongResponse = {
-  song: song;
-};
-
-export type Search3Response = SubsonicResponse & {
-  searchResult3: {
-    artist: artistSummary[];
-    album: album[];
-    song: song[];
-  };
-};
-
-export function isError(
-  subsonicResponse: SubsonicResponse
-): subsonicResponse is SubsonicError {
-  return (subsonicResponse as SubsonicError).error !== undefined;
-}
-
-export type IdName = {
-  id: string;
-  name: string;
-};
-
-export type getAlbumListParams = {
-  type: string;
-  size?: number;
-  offet?: number;
-  fromYear?: string;
-  toYear?: string;
-  genre?: string;
-};
-
-export const MAX_ALBUM_LIST = 500;
-
-const asTrack = (album: Album, song: song) => ({
-  id: song._id,
-  name: song._title,
-  mimeType: song._contentType,
-  duration: parseInt(song._duration || "0"),
-  number: parseInt(song._track || "0"),
-  genre: maybeAsGenre(song._genre),
-  album,
-  artist: {
-    id: song._artistId,
-    name: song._artist,
-  },
-});
-
-const asAlbum = (album: album) => ({
-  id: album._id,
-  name: album._name,
-  year: album._year,
-  genre: maybeAsGenre(album._genre),
-  artistId: album._artistId,
-  artistName: album._artist,
-});
-
-export const asGenre = (genreName: string) => ({
-  id: genreName,
-  name: genreName,
-});
-
-const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
-  pipe(
-    genreName,
-    O.fromNullable,
-    O.map(asGenre),
-    O.getOrElseW(() => undefined)
-  );
-
-export type StreamClientApplication = (track: Track) => string;
-
-export const DEFAULT_CLIENT_APPLICATION = "bonob";
-export const USER_AGENT = "bonob";
-
-export const DEFAULT: StreamClientApplication = (_: Track) =>
-  DEFAULT_CLIENT_APPLICATION;
-
-export function appendMimeTypeToClientFor(mimeTypes: string[]) {
-  return (track: Track) =>
-    mimeTypes.includes(track.mimeType) ? `bonob+${track.mimeType}` : "bonob";
-}
-
-export const asURLSearchParams = (q: any) => {
-  const urlSearchParams = new URLSearchParams();
-  Object.keys(q).forEach((k) => {
-    _.flatten([q[k]]).forEach((v) => {
-      urlSearchParams.append(k, `${v}`);
-    });
-  });
-  return urlSearchParams;
-};
-
-export class Navidrome implements MusicService {
-  url: string;
-  encryption: Encryption;
-  streamClientApplication: StreamClientApplication;
-
-  constructor(
-    url: string,
-    encryption: Encryption,
-    streamClientApplication: StreamClientApplication = DEFAULT
-  ) {
-    this.url = url;
-    this.encryption = encryption;
-    this.streamClientApplication = streamClientApplication;
-  }
-
-  get = async (
-    { username, password }: Credentials,
-    path: string,
-    q: {} = {},
-    config: AxiosRequestConfig | undefined = {}
-  ) =>
-    axios
-      .get(`${this.url}${path}`, {
-        params: asURLSearchParams({
-          u: username,
-          v: "1.16.1",
-          c: DEFAULT_CLIENT_APPLICATION,
-          ...t_and_s(password),
-          ...q,
-        }),
-        headers: {
-          "User-Agent": USER_AGENT,
-        },
-        ...config,
-      })
-      .then((response) => {
-        if (response.status != 200 && response.status != 206) {
-          throw `Navidrome failed with a ${response.status || "no!"} status`;
-        } else return response;
-      });
-
-  getJSON = async <T>(
-    { username, password }: Credentials,
-    path: string,
-    q: {} = {}
-  ): Promise<T> =>
-    this.get({ username, password }, path, q)
-      .then(
-        (response) =>
-          new X2JS({
-            arrayAccessFormPaths: [
-              "subsonic-response.album.song",
-              "subsonic-response.albumList2.album",
-              "subsonic-response.artist.album",
-              "subsonic-response.artists.index",
-              "subsonic-response.artists.index.artist",
-              "subsonic-response.artistInfo2.similarArtist",
-              "subsonic-response.genres.genre",
-              "subsonic-response.playlist.entry",
-              "subsonic-response.playlists.playlist",
-              "subsonic-response.searchResult3.album",
-              "subsonic-response.searchResult3.artist",
-              "subsonic-response.searchResult3.song",
-              "subsonic-response.similarSongs2.song",
-              "subsonic-response.topSongs.song",
-            ],
-          }).xml2js(response.data) as SubconicEnvelope
-      )
-      .then((json) => json["subsonic-response"])
-      .then((json) => {
-        if (isError(json)) throw `Navidrome error:${json.error._message}`;
-        else return json as unknown as T;
-      });
-
-  generateToken = async (credentials: Credentials) =>
-    this.getJSON(credentials, "/rest/ping.view")
-      .then(() => ({
-        authToken: Buffer.from(
-          JSON.stringify(this.encryption.encrypt(JSON.stringify(credentials)))
-        ).toString("base64"),
-        userId: credentials.username,
-        nickname: credentials.username,
-      }))
-      .catch((e) => ({ message: `${e}` }));
-
-  parseToken = (token: string): Credentials =>
-    JSON.parse(
-      this.encryption.decrypt(
-        JSON.parse(Buffer.from(token, "base64").toString("ascii"))
-      )
-    );
-
-  getArtists = (
-    credentials: Credentials
-  ): Promise<(IdName & { albumCount: number })[]> =>
-    this.getJSON<GetArtistsResponse>(credentials, "/rest/getArtists")
-      .then((it) => (it.artists.index || []).flatMap((it) => it.artist || []))
-      .then((artists) =>
-        artists.map((artist) => ({
-          id: artist._id,
-          name: artist._name,
-          albumCount: Number.parseInt(artist._albumCount),
-        }))
-      );
-
-  getArtistInfo = (credentials: Credentials, id: string): Promise<ArtistInfo> =>
-    this.getJSON<GetArtistInfoResponse>(credentials, "/rest/getArtistInfo2", {
-      id,
-      count: 50,
-      includeNotPresent: true,
-    }).then((it) => ({
-      image: {
-        small: validate(it.artistInfo2.smallImageUrl),
-        medium: validate(it.artistInfo2.mediumImageUrl),
-        large: validate(it.artistInfo2.largeImageUrl),
-      },
-      similarArtist: (it.artistInfo2.similarArtist || []).map((artist) => ({
-        id: artist._id,
-        name: artist._name,
-        inLibrary: artist._id != "-1",
-      })),
-    }));
-
-  getAlbum = (credentials: Credentials, id: string): Promise<Album> =>
-    this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id })
-      .then((it) => it.album)
-      .then((album) => ({
-        id: album._id,
-        name: album._name,
-        year: album._year,
-        genre: maybeAsGenre(album._genre),
-        artistId: album._artistId,
-        artistName: album._artist,
-      }));
-
-  getArtist = (
-    credentials: Credentials,
-    id: string
-  ): Promise<IdName & { albums: AlbumSummary[] }> =>
-    this.getJSON<GetArtistResponse>(credentials, "/rest/getArtist", {
-      id,
-    })
-      .then((it) => it.artist)
-      .then((it) => ({
-        id: it._id,
-        name: it._name,
-        albums: (it.album || []).map((album) => ({
-          id: album._id,
-          name: album._name,
-          year: album._year,
-          genre: maybeAsGenre(album._genre),
-          artistId: it._id,
-          artistName: it._name,
-        })),
-      }));
-
-  getArtistWithInfo = (credentials: Credentials, id: string) =>
-    Promise.all([
-      this.getArtist(credentials, id),
-      this.getArtistInfo(credentials, id),
-    ]).then(([artist, artistInfo]) => ({
-      id: artist.id,
-      name: artist.name,
-      image: artistInfo.image,
-      albums: artist.albums,
-      similarArtists: artistInfo.similarArtist,
-    }));
-
-  getCoverArt = (credentials: Credentials, id: string, size?: number) =>
-    this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, {
-      headers: { "User-Agent": "bonob" },
-      responseType: "arraybuffer",
-    });
-
-  getTrack = (credentials: Credentials, id: string) =>
-    this.getJSON<GetSongResponse>(credentials, "/rest/getSong", {
-      id,
-    })
-      .then((it) => it.song)
-      .then((song) =>
-        this.getAlbum(credentials, song._albumId).then((album) =>
-          asTrack(album, song)
-        )
-      );
-
-  toAlbumSummary = (albumList: album[]): AlbumSummary[] =>
-    albumList.map((album) => ({
-      id: album._id,
-      name: album._name,
-      year: album._year,
-      genre: maybeAsGenre(album._genre),
-      artistId: album._artistId,
-      artistName: album._artist,
-    }));
-
-  search3 = (credentials: Credentials, q: any) =>
-    this.getJSON<Search3Response>(credentials, "/rest/search3", {
-      artistCount: 0,
-      albumCount: 0,
-      songCount: 0,
-      ...q,
-    }).then((it) => ({
-      artists: it.searchResult3.artist || [],
-      albums: it.searchResult3.album || [],
-      songs: it.searchResult3.song || [],
-    }));
-
-  async login(token: string) {
-    const navidrome = this;
-    const credentials: Credentials = this.parseToken(token);
-
-    const musicLibrary: MusicLibrary = {
-      artists: (q: ArtistQuery): Promise<Result<ArtistSummary>> =>
-        navidrome
-          .getArtists(credentials)
-          .then(slice2(q))
-          .then(([page, total]) => ({
-            total,
-            results: page.map((it) => ({ id: it.id, name: it.name })),
-          })),
-      artist: async (id: string): Promise<Artist> =>
-        navidrome.getArtistWithInfo(credentials, id),
-      albums: async (q: AlbumQuery): Promise<Result<AlbumSummary>> => {
-        return Promise.all([
-          navidrome
-            .getArtists(credentials)
-            .then((it) =>
-              _.inject(it, (total, artist) => total + artist.albumCount, 0)
-            ),
-          navidrome
-            .getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", {
-              ...pick(q, "type", "genre"),
-              size: 500,
-              offset: q._index,
-            })
-            .then((response) => response.albumList2.album || [])
-            .then(navidrome.toAlbumSummary),
-        ]).then(([total, albums]) => ({
-          results: albums.slice(0, q._count),
-          total:
-            albums.length == 500
-              ? total
-              : q._index + albums.length,
-        }));
-      },
-      album: (id: string): Promise<Album> =>
-        navidrome.getAlbum(credentials, id),
-      genres: () =>
-        navidrome
-          .getJSON<GetGenresResponse>(credentials, "/rest/getGenres")
-          .then((it) =>
-            pipe(
-              it.genres.genre || [],
-              A.filter((it) => Number.parseInt(it._albumCount) > 0),
-              A.map((it) => it.__text),
-              A.sort(ordString),
-              A.map((it) => ({ id: it, name: it }))
-            )
-          ),
-      tracks: (albumId: string) =>
-        navidrome
-          .getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", {
-            id: albumId,
-          })
-          .then((it) => it.album)
-          .then((album) =>
-            (album.song || []).map((song) => asTrack(asAlbum(album), song))
-          ),
-      track: (trackId: string) => navidrome.getTrack(credentials, trackId),
-      stream: async ({
-        trackId,
-        range,
-      }: {
-        trackId: string;
-        range: string | undefined;
-      }) =>
-        navidrome.getTrack(credentials, trackId).then((track) =>
-          navidrome
-            .get(
-              credentials,
-              `/rest/stream`,
-              {
-                id: trackId,
-                c: this.streamClientApplication(track),
-              },
-              {
-                headers: pipe(
-                  range,
-                  O.fromNullable,
-                  O.map((range) => ({
-                    "User-Agent": USER_AGENT,
-                    Range: range,
-                  })),
-                  O.getOrElse(() => ({
-                    "User-Agent": USER_AGENT,
-                  }))
-                ),
-                responseType: "stream",
-              }
-            )
-            .then((res) => ({
-              status: res.status,
-              headers: {
-                "content-type": res.headers["content-type"],
-                "content-length": res.headers["content-length"],
-                "content-range": res.headers["content-range"],
-                "accept-ranges": res.headers["accept-ranges"],
-              },
-              stream: res.data,
-            }))
-        ),
-      coverArt: async (id: string, type: "album" | "artist", size?: number) => {
-        if (type == "album") {
-          return navidrome.getCoverArt(credentials, id, size).then((res) => ({
-            contentType: res.headers["content-type"],
-            data: Buffer.from(res.data, "binary"),
-          }));
-        } else {
-          return navidrome.getArtistWithInfo(credentials, id).then((artist) => {
-            if (artist.image.large) {
-              return axios
-                .get(artist.image.large!, {
-                  headers: BROWSER_HEADERS,
-                  responseType: "arraybuffer",
-                })
-                .then((res) => {
-                  const image = Buffer.from(res.data, "binary");
-                  if (size) {
-                    return sharp(image)
-                      .resize(size)
-                      .toBuffer()
-                      .then((resized) => ({
-                        contentType: res.headers["content-type"],
-                        data: resized,
-                      }));
-                  } else {
-                    return {
-                      contentType: res.headers["content-type"],
-                      data: image,
-                    };
-                  }
-                });
-            } else if (artist.albums.length > 0) {
-              return navidrome
-                .getCoverArt(credentials, artist.albums[0]!.id, size)
-                .then((res) => ({
-                  contentType: res.headers["content-type"],
-                  data: Buffer.from(res.data, "binary"),
-                }));
-            } else {
-              return undefined;
-            }
-          });
-        }
-      },
-      scrobble: async (id: string) =>
-        navidrome
-          .get(credentials, `/rest/scrobble`, {
-            id,
-            submission: true,
-          })
-          .then((_) => true)
-          .catch(() => false),
-      nowPlaying: async (id: string) =>
-        navidrome
-          .get(credentials, `/rest/scrobble`, {
-            id,
-            submission: false,
-          })
-          .then((_) => true)
-          .catch(() => false),
-      searchArtists: async (query: string) =>
-        navidrome
-          .search3(credentials, { query, artistCount: 20 })
-          .then(({ artists }) =>
-            artists.map((artist) => ({
-              id: artist._id,
-              name: artist._name,
-            }))
-          ),
-      searchAlbums: async (query: string) =>
-        navidrome
-          .search3(credentials, { query, albumCount: 20 })
-          .then(({ albums }) => navidrome.toAlbumSummary(albums)),
-      searchTracks: async (query: string) =>
-        navidrome
-          .search3(credentials, { query, songCount: 20 })
-          .then(({ songs }) =>
-            Promise.all(
-              songs.map((it) => navidrome.getTrack(credentials, it._id))
-            )
-          ),
-      playlists: async () =>
-        navidrome
-          .getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
-          .then((it) => it.playlists.playlist || [])
-          .then((playlists) =>
-            playlists.map((it) => ({ id: it._id, name: it._name }))
-          ),
-      playlist: async (id: string) =>
-        navidrome
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
-            id,
-          })
-          .then((it) => it.playlist)
-          .then((playlist) => {
-            let trackNumber = 1;
-            return {
-              id: playlist._id,
-              name: playlist._name,
-              entries: (playlist.entry || []).map((entry) => ({
-                id: entry._id,
-                name: entry._title,
-                mimeType: entry._contentType,
-                duration: parseInt(entry._duration || "0"),
-                number: trackNumber++,
-                genre: maybeAsGenre(entry._genre),
-                album: {
-                  id: entry._albumId,
-                  name: entry._album,
-                  year: entry._year,
-                  genre: maybeAsGenre(entry._genre),
-                  artistName: entry._artist,
-                  artistId: entry._artistId,
-                },
-                artist: {
-                  id: entry._artistId,
-                  name: entry._artist,
-                },
-              })),
-            };
-          }),
-      createPlaylist: async (name: string) =>
-        navidrome
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", {
-            name,
-          })
-          .then((it) => it.playlist)
-          .then((it) => ({ id: it._id, name: it._name })),
-      deletePlaylist: async (id: string) =>
-        navidrome
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", {
-            id,
-          })
-          .then((_) => true),
-      addToPlaylist: async (playlistId: string, trackId: string) =>
-        navidrome
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", {
-            playlistId,
-            songIdToAdd: trackId,
-          })
-          .then((_) => true),
-      removeFromPlaylist: async (playlistId: string, indicies: number[]) =>
-        navidrome
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", {
-            playlistId,
-            songIndexToRemove: indicies,
-          })
-          .then((_) => true),
-      similarSongs: async (id: string) =>
-        navidrome
-          .getJSON<GetSimilarSongsResponse>(
-            credentials,
-            "/rest/getSimilarSongs2",
-            { id, count: 50 }
-          )
-          .then((it) => it.similarSongs2.song || [])
-          .then((songs) =>
-            Promise.all(
-              songs.map((song) =>
-                navidrome
-                  .getAlbum(credentials, song._albumId)
-                  .then((album) => asTrack(album, song))
-              )
-            )
-          ),
-      topSongs: async (artistId: string) =>
-        navidrome.getArtist(credentials, artistId).then(({ name }) =>
-          navidrome
-            .getJSON<GetTopSongsResponse>(credentials, "/rest/getTopSongs", {
-              artist: name,
-              count: 50,
-            })
-            .then((it) => it.topSongs.song || [])
-            .then((songs) =>
-              Promise.all(
-                songs.map((song) =>
-                  navidrome
-                    .getAlbum(credentials, song._albumId)
-                    .then((album) => asTrack(album, song))
-                )
-              )
-            )
-        ),
-    };
-
-    return Promise.resolve(musicLibrary);
-  }
-}

src/random_string.ts

@@ -1,6 +0,0 @@
-import { randomBytes } from "crypto";
-
-const randomString = () => randomBytes(32).toString('hex')
-
-export default randomString
-

src/register.ts

@@ -13,7 +13,7 @@ const bonobUrl = new URLBuilder(params[0]!);
 
 const config = readConfig();
 
-registrar(bonobUrl, config.sonos.discovery)()
+registrar(bonobUrl, config.sonos.discovery.seedHost)()
   .then((success) => {
     if (success) {
       console.log(`Successfully registered bonob @ ${bonobUrl} with sonos`);

src/registrar.ts

@@ -1,15 +1,12 @@
 import axios from "axios";
 import _ from "underscore";
 import logger from "./logger";
-import sonos, { bonobService, Discovery } from "./sonos";
+import sonos, { bonobService } from "./sonos";
 import { URLBuilder } from "./url_builder";
 
 export default (
     bonobUrl: URLBuilder,
-    sonosDiscovery: Discovery = {
+    seedHost?: string
-      auto: true,
-      seedHost: undefined,
-    }
   ) =>
   async () => {
     const about = bonobUrl.append({ pathname: "/about" });
@@ -34,5 +31,5 @@ export default (
       .then(({ name, sid }: { name: string; sid: number }) =>
         bonobService(name, sid, bonobUrl)
       )
-      .then((service) => sonos(sonosDiscovery).register(service));
+      .then((service) => sonos({ enabled: true, seedHost }).register(service));
   };

src/server.ts

@@ -1,8 +1,10 @@
-import { option as O } from "fp-ts";
+import { either as E, taskEither as TE } from "fp-ts";
 import express, { Express, Request } from "express";
 import * as Eta from "eta";
 import path from "path";
 import sharp from "sharp";
+import { v4 as uuid } from "uuid";
+import dayjs from "dayjs";
 
 import { PassThrough, Transform, TransformCallback } from "stream";
 
@@ -15,20 +17,28 @@ import {
   LOGIN_ROUTE,
   CREATE_REGISTRATION_ROUTE,
   REMOVE_REGISTRATION_ROUTE,
+  sonosifyMimeType,
+  ratingFromInt,
+  ratingAsInt,
 } from "./smapi";
 import { LinkCodes, InMemoryLinkCodes } from "./link_codes";
-import { MusicService, isSuccess } from "./music_service";
+import { MusicService, AuthFailure, AuthSuccess } from "./music_library";
 import bindSmapiSoapServiceToExpress from "./smapi";
-import { AccessTokens, AccessTokenPerAuthToken } from "./access_tokens";
+import { APITokens, InMemoryAPITokens } from "./api_tokens";
 import logger from "./logger";
 import { Clock, SystemClock } from "./clock";
 import { pipe } from "fp-ts/lib/function";
 import { URLBuilder } from "./url_builder";
 import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n";
 import { Icon, ICONS, festivals, features } from "./icon";
-import _, { shuffle } from "underscore";
+import _ from "underscore";
 import morgan from "morgan";
-import { takeWithRepeats } from "./utils";
+import { parse } from "./burn";
+import { axiosImageFetcher, ImageFetcher } from "./subsonic";
+import {
+  JWTSmapiLoginTokens,
+  SmapiAuthTokens,
+} from "./smapi_auth";
 
 export const BONOB_ACCESS_TOKEN_HEADER = "bat";
 
@@ -71,7 +81,7 @@ export class RangeBytesFromFilter extends Transform {
 
 export type ServerOpts = {
   linkCodes: () => LinkCodes;
-  accessTokens: () => AccessTokens;
+  apiTokens: () => APITokens;
   clock: Clock;
   iconColors: {
     foregroundColor: string | undefined;
@@ -80,16 +90,24 @@ export type ServerOpts = {
   applyContextPath: boolean;
   logRequests: boolean;
   version: string;
+  smapiAuthTokens: SmapiAuthTokens;
+  externalImageResolver: ImageFetcher;
 };
 
 const DEFAULT_SERVER_OPTS: ServerOpts = {
   linkCodes: () => new InMemoryLinkCodes(),
-  accessTokens: () => new AccessTokenPerAuthToken(),
+  apiTokens: () => new InMemoryAPITokens(),
   clock: SystemClock,
   iconColors: { foregroundColor: undefined, backgroundColor: undefined },
   applyContextPath: true,
   logRequests: false,
   version: "v?",
+  smapiAuthTokens: new JWTSmapiLoginTokens(
+    SystemClock,
+    `bonob-${uuid()}`,
+    "1m"
+  ),
+  externalImageResolver: axiosImageFetcher,
 };
 
 function server(
@@ -102,9 +120,12 @@ function server(
   const serverOpts = { ...DEFAULT_SERVER_OPTS, ...opts };
 
   const linkCodes = serverOpts.linkCodes();
-  const accessTokens = serverOpts.accessTokens();
+  const smapiAuthTokens = serverOpts.smapiAuthTokens;
+  const apiTokens = serverOpts.apiTokens();
   const clock = serverOpts.clock;
 
+  const startUpTime = dayjs();
+
   const app = express();
   const i8n = makeI8N(service.name);
 
@@ -113,8 +134,7 @@ function server(
   }
   app.use(express.urlencoded({ extended: false }));
 
-  // todo: pass options in here?
+  app.use(express.static(path.resolve(__dirname, "..", "web", "public")));
-  app.use(express.static("./web/public"));
   app.engine("eta", Eta.renderFile);
 
   app.set("view engine", "eta");
@@ -148,7 +168,7 @@ function server(
           removeRegistrationRoute: bonobUrl
             .append({ pathname: REMOVE_REGISTRATION_ROUTE })
             .pathname(),
-          version: opts.version,
+          version: serverOpts.version || DEFAULT_SERVER_OPTS.version,
         });
       }
     );
@@ -210,28 +230,41 @@ function server(
     const lang = langFor(req);
     const { username, password, linkCode } = req.body;
     if (!linkCodes.has(linkCode)) {
-      res.status(400).render("failure", {
+      return res.status(400).render("failure", {
         lang,
         message: lang("invalidLinkCode"),
       });
     } else {
-      const authResult = await musicService.generateToken({
+      return pipe(
-        username,
+        musicService.generateToken({
-        password,
+          username,
-      });
+          password,
-      if (isSuccess(authResult)) {
+        }),
-        linkCodes.associate(linkCode, authResult);
+        TE.match(
-        res.render("success", {
+          (e: AuthFailure) => ({
-          lang,
+            status: 403,
-          message: lang("loginSuccessful"),
+            template: "failure",
-        });
+            params: {
-      } else {
+              lang,
-        res.status(403).render("failure", {
+              message: lang("loginFailed"),
-          lang,
+              cause: e.message,
-          message: lang("loginFailed"),
+            },
-          cause: authResult.message,
+          }),
-        });
+          (success: AuthSuccess) => {
-      }
+            linkCodes.associate(linkCode, success);
+            return {
+              status: 200,
+              template: "success",
+              params: {
+                lang,
+                message: lang("loginSuccessful"),
+              },
+            };
+          }
+        )
+      )().then(({ status, template, params }) =>
+        res.status(status).render(template, params)
+      );
     }
   });
 
@@ -251,15 +284,51 @@ function server(
   });
 
   app.get(PRESENTATION_MAP_ROUTE, (_, res) => {
+    const LastModified = startUpTime.format("HH:mm:ss D MMM YYYY");
+
+    const nowPlayingRatingsMatch = (value: number) => {
+      const rating = ratingFromInt(value);
+      const nextLove = { ...rating, love: !rating.love };
+      const nextStar = {
+        ...rating,
+        stars: rating.stars === 5 ? 0 : rating.stars + 1,
+      };
+
+      const loveRatingIcon = bonobUrl
+        .append({
+          pathname: rating.love ? "/love-selected.svg" : "/love-unselected.svg",
+        })
+        .href();
+      const starsRatingIcon = bonobUrl
+        .append({ pathname: `/star${rating.stars}.svg` })
+        .href();
+
+      return `<Match propname="rating" value="${value}">
+        <Ratings>
+          <Rating Id="${ratingAsInt(
+        nextLove
+      )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
+            <Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" />
+          </Rating>
+          <Rating Id="${-ratingAsInt(
+        nextStar
+      )}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR">
+            <Icon Controller="universal" LastModified="${LastModified}" Uri="${starsRatingIcon}" />
+          </Rating>
+        </Ratings>
+      </Match>`;
+    };
+
     res.type("application/xml").send(`<?xml version="1.0" encoding="utf-8" ?>
     <Presentation>
+      <BrowseOptions PageSize="30" />
       <PresentationMap type="ArtWorkSizeMap">
         <Match>
           <imageSizeMap>
             ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
-              (size) =>
+      (size) =>
-                `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-            ).join("")}
+    ).join("")}
           </imageSizeMap>
         </Match>
       </PresentationMap>
@@ -268,9 +337,9 @@ function server(
           <browseIconSizeMap>
               <sizeEntry size="0" substitution="/size/legacy"/>
               ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
-                (size) =>
+      (size) =>
-                  `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-              ).join("")}
+    ).join("")}
             </browseIconSizeMap>
         </Match>
       </PresentationMap>
@@ -283,40 +352,79 @@ function server(
           </SearchCategories>
         </Match>
       </PresentationMap>
+      <PresentationMap type="NowPlayingRatings" trackEnabled="true" programEnabled="false">
+        ${nowPlayingRatingsMatch(100)}
+        ${nowPlayingRatingsMatch(101)}
+        ${nowPlayingRatingsMatch(110)}
+        ${nowPlayingRatingsMatch(111)}
+        ${nowPlayingRatingsMatch(120)}
+        ${nowPlayingRatingsMatch(121)}
+        ${nowPlayingRatingsMatch(130)}
+        ${nowPlayingRatingsMatch(131)}
+        ${nowPlayingRatingsMatch(140)}
+        ${nowPlayingRatingsMatch(141)}
+        ${nowPlayingRatingsMatch(150)}
+        ${nowPlayingRatingsMatch(151)}
+      </PresentationMap>
     </Presentation>`);
   });
 
   app.get("/stream/track/:id", async (req, res) => {
     const id = req.params["id"]!;
-    logger.info(
+    const trace = uuid();
-      `-> /stream/track/${id}, headers=${JSON.stringify(req.headers)}`
+
+    logger.debug(
+      `${trace} bnb<- ${req.method} ${req.path}?${JSON.stringify(
+        req.query
+      )}, headers=${JSON.stringify({ ...req.headers, "bnbt": "*****", "bnbk": "*****" })}`
     );
-    const authToken = pipe(
+
-      req.header(BONOB_ACCESS_TOKEN_HEADER),
+    const serviceToken = pipe(
-      O.fromNullable,
+      E.fromNullable("Missing bnbt header")(req.headers["bnbt"] as string),
-      O.map((accessToken) => accessTokens.authTokenFor(accessToken)),
+      E.chain(token => pipe(
-      O.getOrElseW(() => undefined)
+        E.fromNullable("Missing bnbk header")(req.headers["bnbk"] as string),
-    );
+        E.map(key => ({ token, key }))
-    if (!authToken) {
+      )),
+      E.chain((auth) =>
+        pipe(
+          smapiAuthTokens.verify(auth),
+          E.mapLeft((_) => "Auth token failed to verify")
+        )
+      ),
+      E.getOrElseW(() => undefined)
+    )
+
+    if (!serviceToken) {
       return res.status(401).send();
     } else {
       return musicService
-        .login(authToken)
+        .login(serviceToken)
         .then((it) =>
           it
             .stream({
               trackId: id,
               range: req.headers["range"] || undefined,
             })
+            .then((stream) => {
+              res.on('close', () => {
+                stream.stream.destroy()
+              });
+              return stream;
+            })
             .then((stream) => ({ musicLibrary: it, stream }))
         )
         .then(({ musicLibrary, stream }) => {
-          logger.info(
+          logger.debug(
-            `stream response from music service for ${id}, status=${
+            `${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
-              stream.status
-            }, headers=(${JSON.stringify(stream.headers)})`
           );
 
+          const sonosisfyContentType = (contentType: string) =>
+            contentType
+              .split(";")
+              .map((it) => it.trim())
+              .map(sonosifyMimeType)
+              .join("; ");
+
           const respondWith = ({
             status,
             filter,
@@ -326,25 +434,25 @@ function server(
           }: {
             status: number;
             filter: Transform;
-            headers: Record<string, string | undefined>;
+            headers: Record<string, string>;
             sendStream: boolean;
             nowPlaying: boolean;
           }) => {
-            logger.info(
+            logger.debug(
-              `<- /stream/track/${id}, status=${status}, headers=${JSON.stringify(
+              `${trace} bnb-> ${req.path}, status=${status}, headers=${JSON.stringify(headers)}`
-                headers
-              )}`
             );
             (nowPlaying
               ? musicLibrary.nowPlaying(id)
               : Promise.resolve(true)
             ).then((_) => {
               res.status(status);
-              Object.entries(stream.headers)
+              Object.entries(headers)
                 .filter(([_, v]) => v !== undefined)
-                .forEach(([header, value]) => res.setHeader(header, value));
+                .forEach(([header, value]) => {
-              if (sendStream) stream.stream.pipe(filter).pipe(res);
+                  res.setHeader(header, value!);
-              else res.send();
+                });
+              if (sendStream) stream.stream.pipe(filter).pipe(res)
+              else res.send()
             });
           };
 
@@ -353,7 +461,9 @@ function server(
               status: 200,
               filter: new PassThrough(),
               headers: {
-                "content-type": stream.headers["content-type"],
+                "content-type": sonosisfyContentType(
+                  stream.headers["content-type"]
+                ),
                 "content-length": stream.headers["content-length"],
                 "accept-ranges": stream.headers["accept-ranges"],
               },
@@ -365,7 +475,9 @@ function server(
               status: 206,
               filter: new PassThrough(),
               headers: {
-                "content-type": stream.headers["content-type"],
+                "content-type": sonosisfyContentType(
+                  stream.headers["content-type"]
+                ),
                 "content-length": stream.headers["content-length"],
                 "content-range": stream.headers["content-range"],
                 "accept-ranges": stream.headers["accept-ranges"],
@@ -386,38 +498,40 @@ function server(
     }
   });
 
-  app.get("/icon/:type/size/:size", (req, res) => {
+  app.get("/icon/:type_text/size/:size", (req, res) => {
-    const type = req.params["type"]!;
+    const match = (req.params["type_text"] || "")!.match("^([A-Za-z0-9]+)(?:\:([A-Za-z0-9]+))?$")
+    if (!match)
+      return res.status(400).send();
+    
+    const type = match[1]!
+    const text = match[2]
     const size = req.params["size"]!;
 
     if (!Object.keys(ICONS).includes(type)) {
       return res.status(404).send();
-    } else if (
+    } else if (size != "legacy" && !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)) {
-      size != "legacy" &&
-      !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)
-    ) {
       return res.status(400).send();
     } else {
       let icon = (ICONS as any)[type]! as Icon;
       const spec =
         size == "legacy"
           ? {
-              mimeType: "image/png",
+            mimeType: "image/png",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
-                sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
+              sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
-            }
+          }
           : {
-              mimeType: "image/svg+xml",
+            mimeType: "image/svg+xml",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
-                Promise.resolve(svg),
+              Promise.resolve(svg),
-            };
+          };
 
       return Promise.resolve(
         icon
           .apply(
             features({
-              viewPortIncreasePercent: 80,
               ...serverOpts.iconColors,
+              text: text
             })
           )
           .apply(festivals(clock))
@@ -445,80 +559,41 @@ function server(
     });
   });
 
-  const GRAVITY_9 = [
+  app.get("/art/:burn/size/:size", (req, res) => {
-    "north",
+    const serviceToken = apiTokens.authTokenFor(
-    "northeast",
-    "east",
-    "southeast",
-    "south",
-    "southwest",
-    "west",
-    "northwest",
-    "centre",
-  ];
-
-  app.get("/art/:type/:ids/size/:size", (req, res) => {
-    const authToken = accessTokens.authTokenFor(
       req.query[BONOB_ACCESS_TOKEN_HEADER] as string
     );
-    const type = req.params["type"]!;
+    const urn = parse(req.params["burn"]!);
-    const ids = req.params["ids"]!.split("&");
     const size = Number.parseInt(req.params["size"]!);
 
-    if (!authToken) {
+    if (!serviceToken) {
       return res.status(401).send();
-    } else if (type != "artist" && type != "album") {
-      return res.status(400).send();
     } else if (!(size > 0)) {
       return res.status(400).send();
     }
 
     return musicService
-      .login(authToken)
+      .login(serviceToken)
-      .then((it) => Promise.all(ids.map((id) => it.coverArt(id, type, size))))
+      .then((musicLibrary) => {
-      .then((coverArts) => coverArts.filter((it) => it))
+        if (urn.system == "external") {
-      .then(shuffle)
+          return serverOpts.externalImageResolver(urn.resource);
-      .then((coverArts) => {
+        } else {
-        if (coverArts.length == 1) {
+          return musicLibrary.coverArt(urn, size);
-          const coverArt = coverArts[0]!;
+        }
+      })
+      .then((coverArt) => {
+        if(coverArt) {
           res.status(200);
           res.setHeader("content-type", coverArt.contentType);
           return res.send(coverArt.data);
-        } else if (coverArts.length > 1) {
-          const gravity = [...GRAVITY_9];
-          return sharp({
-            create: {
-              width: size * 3,
-              height: size * 3,
-              channels: 3,
-              background: { r: 255, g: 255, b: 255 },
-            },
-          })
-            .composite(
-              takeWithRepeats(coverArts, 9).map((art) => ({
-                input: art?.data,
-                gravity: gravity.pop(),
-              }))
-            )
-            .png()
-            .toBuffer()
-            .then((image) => sharp(image).resize(size).png().toBuffer())
-            .then((image) => {
-              res.status(200);
-              res.setHeader("content-type", "image/png");
-              return res.send(image);
-            });
         } else {
           return res.status(404).send();
         }
-      })
+    })
       .catch((e: Error) => {
-        logger.error(
+        logger.error(`Failed fetching image ${urn}/size/${size}`, {
-          `Failed fetching image ${type}/${ids.join("&")}/size/${size}`,
+          cause: e,
-          {
+        });
-            cause: e,
-          }
-        );
         return res.status(500).send();
       });
   });
@@ -529,9 +604,10 @@ function server(
     bonobUrl,
     linkCodes,
     musicService,
-    accessTokens,
+    apiTokens,
     clock,
-    i8n
+    i8n,
+    serverOpts.smapiAuthTokens
   );
 
   if (serverOpts.applyContextPath) {

src/smapi.ts

@@ -3,27 +3,39 @@ import { Express, Request } from "express";
 import { listen } from "soap";
 import { readFileSync } from "fs";
 import path from "path";
+import { option as O, either as E, taskEither as TE, task as T } from "fp-ts";
+import { pipe } from "fp-ts/lib/function";
+
 import logger from "./logger";
 
 import { LinkCodes } from "./link_codes";
 import {
-  Album,
   AlbumQuery,
   AlbumSummary,
   ArtistSummary,
   Genre,
+  Year,
   MusicService,
   Playlist,
+  RadioStation,
+  Rating,
   slice2,
   Track,
-} from "./music_service";
+} from "./music_library";
-import { AccessTokens } from "./access_tokens";
+import { APITokens } from "./api_tokens";
-import { BONOB_ACCESS_TOKEN_HEADER } from "./server";
 import { Clock } from "./clock";
 import { URLBuilder } from "./url_builder";
 import { asLANGs, I8N } from "./i8n";
 import { ICON, iconForGenre } from "./icon";
-import { uniq } from "underscore";
+import _ from "underscore";
+import { BUrn, formatForURL } from "./burn";
+import {
+  isExpiredTokenError,
+  MissingLoginTokenError,
+  SmapiAuthTokens,
+  SMAPI_FAULT_LOGIN_UNAUTHORIZED,
+  ToSmapiFault,
+} from "./smapi_auth";
 
 export const LOGIN_ROUTE = "/login";
 export const CREATE_REGISTRATION_ROUTE = "/registration/add";
@@ -49,12 +61,13 @@ export const SONOS_RECOMMENDED_IMAGE_SIZES = [
 
 const WSDL_FILE = path.resolve(
   __dirname,
-  "Sonoswsdl-1.19.4-20190411.142401-3.wsdl"
+  "Sonoswsdl-1.19.6-20231024.wsdl"
 );
 
 export type Credentials = {
   loginToken: {
     token: string;
+    key: string;
     householdId: string;
   };
   deviceId: string;
@@ -81,6 +94,13 @@ export type GetDeviceAuthTokenResult = {
   };
 };
 
+export const ratingAsInt = (rating: Rating): number =>
+  rating.stars * 10 + (rating.love ? 1 : 0) + 100;
+export const ratingFromInt = (value: number): Rating => {
+  const x = value - 100;
+  return { love: x % 10 == 1, stars: Math.floor(x / 10) };
+};
+
 export type MediaCollection = {
   id: string;
   itemType: "collection";
@@ -138,10 +158,19 @@ export function searchResult(
 class SonosSoap {
   linkCodes: LinkCodes;
   bonobUrl: URLBuilder;
+  smapiAuthTokens: SmapiAuthTokens;
+  clock: Clock;
 
-  constructor(bonobUrl: URLBuilder, linkCodes: LinkCodes) {
+  constructor(
+    bonobUrl: URLBuilder,
+    linkCodes: LinkCodes,
+    smapiAuthTokens: SmapiAuthTokens,
+    clock: Clock
+  ) {
     this.bonobUrl = bonobUrl;
     this.linkCodes = linkCodes;
+    this.smapiAuthTokens = smapiAuthTokens;
+    this.clock = clock;
   }
 
   getAppLink(): GetAppLinkResult {
@@ -170,10 +199,13 @@ class SonosSoap {
   }): GetDeviceAuthTokenResult {
     const association = this.linkCodes.associationFor(linkCode);
     if (association) {
+      const smapiAuthToken = this.smapiAuthTokens.issue(
+        association.serviceToken
+      );
       return {
         getDeviceAuthTokenResult: {
-          authToken: association.authToken,
+          authToken: smapiAuthToken.token,
-          privateKey: "",
+          privateKey: smapiAuthToken.key,
           userInfo: {
             nickname: association.nickname,
             userIdHashCode: crypto
@@ -212,20 +244,25 @@ export type Container = {
 };
 
 const genre = (bonobUrl: URLBuilder, genre: Genre) => ({
-  itemType: "container",
+  itemType: "albumList",
   id: `genre:${genre.id}`,
   title: genre.name,
-  albumArtURI: iconArtURI(
+  albumArtURI: iconArtURI(bonobUrl, iconForGenre(genre.name)).href(),
-    bonobUrl,
+});
-    iconForGenre(genre.name)
+
-  ).href(),
+const yyyy = (bonobUrl: URLBuilder, year: Year) => ({
+  itemType: "albumList",
+  id: `year:${year.year}`,
+  title: year.year,
+  // todo: maybe year.year should be nullable?
+  albumArtURI: year.year !== "?" ? iconArtURI(bonobUrl, "yyyy", year.year).href() : iconArtURI(bonobUrl, "music").href(),
 });
 
 const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
   itemType: "playlist",
   id: `playlist:${playlist.id}`,
   title: playlist.name,
-  albumArtURI: playlistAlbumArtURL(bonobUrl, playlist).href(),
+  albumArtURI: coverArtURI(bonobUrl, playlist).href(),
   canPlay: true,
   attributes: {
     readOnly: false,
@@ -234,35 +271,28 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
   },
 });
 
-export const playlistAlbumArtURL = (
+export const coverArtURI = (
   bonobUrl: URLBuilder,
-  playlist: Playlist
+  { coverArt }: { coverArt?: BUrn | undefined }
-) => {
-  const ids = uniq(playlist.entries.map((it) => it.album?.id).filter((it) => it));
-  if (ids.length == 0) {
-    return iconArtURI(bonobUrl, "error");
-  } else {
-    return bonobUrl.append({
-      pathname: `/art/album/${ids.slice(0, 9).join("&")}/size/180`
-    });
-  }
-};
-
-export const defaultAlbumArtURI = (bonobUrl: URLBuilder, album: AlbumSummary) =>
-  bonobUrl.append({ pathname: `/art/album/${album.id}/size/180` });
-
-export const iconArtURI = (
-  bonobUrl: URLBuilder,
-  icon: ICON
 ) =>
+  pipe(
+    coverArt,
+    O.fromNullable,
+    O.map((it) =>
+      bonobUrl.append({
+        pathname: `/art/${encodeURIComponent(formatForURL(it))}/size/180`,
+      })
+    ),
+    O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
+  );
+
+export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON, text: string | undefined = undefined) =>
   bonobUrl.append({
-    pathname: `/icon/${icon}/size/legacy`
+    pathname: `/icon/${text == undefined ? icon : `${icon}:${text}`}/size/legacy`,
   });
 
-export const defaultArtistArtURI = (
+export const sonosifyMimeType = (mimeType: string) =>
-  bonobUrl: URLBuilder,
+  mimeType == "audio/x-flac" ? "audio/flac" : mimeType;
-  artist: ArtistSummary
-) => bonobUrl.append({ pathname: `/art/artist/${artist.id}/size/180` });
 
 export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
   itemType: "album",
@@ -270,7 +300,7 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
   artist: album.artistName,
   artistId: `artist:${album.artistId}`,
   title: album.name,
-  albumArtURI: defaultAlbumArtURI(bonobUrl, album).href(),
+  albumArtURI: coverArtURI(bonobUrl, album).href(),
   canPlay: true,
   // defaults
   // canScroll: false,
@@ -278,25 +308,35 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
   // canAddToFavorites: true
 });
 
+export const internetRadioStation = (station: RadioStation) => ({
+  itemType: "stream",
+  id: `internetRadioStation:${station.id}`,
+  title: station.name,
+  mimeType: "audio/mpeg",
+});
+
 export const track = (bonobUrl: URLBuilder, track: Track) => ({
   itemType: "track",
   id: `track:${track.id}`,
-  mimeType: track.mimeType,
+  mimeType: sonosifyMimeType(track.encoding.mimeType),
   title: track.name,
 
   trackMetadata: {
     album: track.album.name,
-    albumId: track.album.id,
+    albumId: `album:${track.album.id}`,
     albumArtist: track.artist.name,
-    albumArtistId: track.artist.id,
+    albumArtistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
-    albumArtURI: defaultAlbumArtURI(bonobUrl, track.album).href(),
+    albumArtURI: coverArtURI(bonobUrl, track).href(),
     artist: track.artist.name,
-    artistId: track.artist.id,
+    artistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
     duration: track.duration,
     genre: track.album.genre?.name,
     genreId: track.album.genre?.id,
     trackNumber: track.number,
   },
+  dynamic: {
+    property: [{ name: "rating", value: `${ratingAsInt(track.rating)}` }],
+  },
 });
 
 export const artist = (bonobUrl: URLBuilder, artist: ArtistSummary) => ({
@@ -304,42 +344,9 @@ export const artist = (bonobUrl: URLBuilder, artist: ArtistSummary) => ({
   id: `artist:${artist.id}`,
   artistId: artist.id,
   title: artist.name,
-  albumArtURI: defaultArtistArtURI(bonobUrl, artist).href(),
+  albumArtURI: coverArtURI(bonobUrl, { coverArt: artist.image }).href(),
 });
 
-const auth = async (
-  musicService: MusicService,
-  accessTokens: AccessTokens,
-  credentials?: Credentials
-) => {
-  if (!credentials) {
-    throw {
-      Fault: {
-        faultcode: "Client.LoginUnsupported",
-        faultstring: "Missing credentials...",
-      },
-    };
-  }
-  const authToken = credentials.loginToken.token;
-  const accessToken = accessTokens.mint(authToken);
-
-  return musicService
-    .login(authToken)
-    .then((musicLibrary) => ({
-      musicLibrary,
-      authToken,
-      accessToken,
-    }))
-    .catch((_) => {
-      throw {
-        Fault: {
-          faultcode: "Client.LoginUnauthorized",
-          faultstring: "Credentials not found...",
-        },
-      };
-    });
-};
-
 function splitId<T>(id: string) {
   const [type, typeId] = id.split(":");
   return (t: T) => ({
@@ -353,25 +360,95 @@ type SoapyHeaders = {
   credentials?: Credentials;
 };
 
+type Auth = {
+  serviceToken: string;
+  credentials: Credentials;
+  apiKey: string;
+};
+
+function isAuth(thing: any): thing is Auth {
+  return thing.serviceToken;
+}
+
 function bindSmapiSoapServiceToExpress(
   app: Express,
   soapPath: string,
   bonobUrl: URLBuilder,
   linkCodes: LinkCodes,
   musicService: MusicService,
-  accessTokens: AccessTokens,
+  apiKeys: APITokens,
   clock: Clock,
-  i8n: I8N
+  i8n: I8N,
+  smapiAuthTokens: SmapiAuthTokens
 ) {
-  const sonosSoap = new SonosSoap(bonobUrl, linkCodes);
+  const sonosSoap = new SonosSoap(bonobUrl, linkCodes, smapiAuthTokens, clock);
 
   const urlWithToken = (accessToken: string) =>
     bonobUrl.append({
       searchParams: {
-        "bat": accessToken,
+        bat: accessToken,
       },
     });
 
+  const auth = (credentials?: Credentials): E.Either<ToSmapiFault, Auth> => {
+    const credentialsFrom = E.fromNullable(new MissingLoginTokenError());
+    return pipe(
+      credentialsFrom(credentials),
+      E.chain((credentials) =>
+        pipe(
+          smapiAuthTokens.verify({
+            token: credentials.loginToken.token,
+            key: credentials.loginToken.key,
+          }),
+          E.map((serviceToken) => ({
+            serviceToken,
+            credentials,
+          }))
+        )
+      ),
+      E.map(({ serviceToken, credentials }) => ({
+        serviceToken,
+        credentials,
+        apiKey: apiKeys.mint(serviceToken),
+      }))
+    );
+  };
+
+  const login = async (credentials?: Credentials) => {
+    const authOrFail = pipe(
+      auth(credentials),
+      E.getOrElseW((fault) => fault)
+    );
+    if (isAuth(authOrFail)) {
+      return musicService
+        .login(authOrFail.serviceToken)
+        .then((musicLibrary) => ({ ...authOrFail, musicLibrary }))
+        .catch((_) => {
+          throw SMAPI_FAULT_LOGIN_UNAUTHORIZED;
+        });
+    } else if (isExpiredTokenError(authOrFail)) {
+      throw await pipe(
+        musicService.refreshToken(authOrFail.expiredToken),
+        TE.map((it) => smapiAuthTokens.issue(it.serviceToken)),
+        TE.map((newToken) => ({
+          Fault: {
+            faultcode: "Client.TokenRefreshRequired",
+            faultstring: "Token has expired",
+            detail: {
+              refreshAuthTokenResult: {
+                authToken: newToken.token,
+                privateKey: newToken.key,
+              },
+            },
+          },
+        })),
+        TE.getOrElse(() => T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED))
+      )();
+    } else {
+      throw authOrFail.toSmapiFault();
+    }
+  };
+
   const soapyService = listen(
     app,
     soapPath,
@@ -389,53 +466,109 @@ function bindSmapiSoapServiceToExpress(
               pollInterval: 60,
             },
           }),
+          refreshAuthToken: async (_, _2, soapyHeaders: SoapyHeaders) => {
+            const serviceToken = pipe(
+              auth(soapyHeaders?.credentials),
+              E.fold(
+                (fault) =>
+                  isExpiredTokenError(fault)
+                    ? E.right(fault.expiredToken)
+                    : E.left(fault),
+                (creds) => E.right(creds.serviceToken)
+              ),
+              E.getOrElseW((fault) => {
+                throw fault.toSmapiFault();
+              })
+            );
+            return pipe(
+              musicService.refreshToken(serviceToken),
+              TE.map((it) => smapiAuthTokens.issue(it.serviceToken)),
+              TE.map((it) => ({
+                refreshAuthTokenResult: {
+                  authToken: it.token,
+                  privateKey: it.key,
+                },
+              })),
+              TE.getOrElse((_) => {
+                throw SMAPI_FAULT_LOGIN_UNAUTHORIZED;
+              })
+            )();
+          },
           getMediaURI: async (
             { id }: { id: string },
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(({ accessToken, type, typeId }) => ({
+              .then(({ musicLibrary, credentials, type, typeId }) => {
-                getMediaURIResult: bonobUrl
+                switch (type) {
-                  .append({
+                  case "internetRadioStation":
-                    pathname: `/stream/${type}/${typeId}`,
+                    return musicLibrary.radioStation(typeId).then((it) => ({
-                  })
+                      getMediaURIResult: it.url,
-                  .href(),
+                    }));
-                httpHeaders: [
+                  case "track":
-                  {
+                    return {
-                    header: BONOB_ACCESS_TOKEN_HEADER,
+                      getMediaURIResult: bonobUrl
-                    value: accessToken,
+                        .append({
-                  },
+                          pathname: `/stream/${type}/${typeId}`,
-                ],
+                        })
-              })),
+                        .href(),
+                      httpHeaders: [
+                        {
+                          httpHeader: {
+                            header: "bnbt",
+                            value: credentials.loginToken.token,
+                          },
+                        },
+                        {
+                          httpHeader: {
+                            header: "bnbk",
+                            value: credentials.loginToken.key,
+                          },
+                        },
+                      ],
+                    };
+                  default:
+                    throw `Unsupported type:${type}`;
+                  }
+              }),
           getMediaMetadata: async (
             { id }: { id: string },
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(async ({ musicLibrary, accessToken, typeId }) =>
+              .then(async ({ musicLibrary, apiKey, type, typeId }) => {
-                musicLibrary.track(typeId!).then((it) => ({
+                switch (type) {
-                  getMediaMetadataResult: track(urlWithToken(accessToken), it),
+                  case "internetRadioStation":
-                }))
+                    return musicLibrary.radioStation(typeId).then((it) => ({
-              ),
+                      getMediaMetadataResult: internetRadioStation(it),
+                    }));
+                  case "track":
+                    return musicLibrary.track(typeId!).then((it) => ({
+                      getMediaMetadataResult: track(urlWithToken(apiKey), it),
+                    }));
+                  default:
+                    throw `Unsupported type:${type}`;
+                }
+              }),
           search: async (
             { id, term }: { id: string; term: string },
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(async ({ musicLibrary, accessToken }) => {
+              .then(async ({ musicLibrary, apiKey }) => {
                 switch (id) {
                   case "albums":
                     return musicLibrary.searchAlbums(term).then((it) =>
                       searchResult({
                         count: it.length,
                         mediaCollection: it.map((albumSummary) =>
-                          album(urlWithToken(accessToken), albumSummary)
+                          album(urlWithToken(apiKey), albumSummary)
                         ),
                       })
                     );
@@ -444,7 +577,7 @@ function bindSmapiSoapServiceToExpress(
                       searchResult({
                         count: it.length,
                         mediaCollection: it.map((artistSummary) =>
-                          artist(urlWithToken(accessToken), artistSummary)
+                          artist(urlWithToken(apiKey), artistSummary)
                         ),
                       })
                     );
@@ -453,7 +586,7 @@ function bindSmapiSoapServiceToExpress(
                       searchResult({
                         count: it.length,
                         mediaCollection: it.map((aTrack) =>
-                          album(urlWithToken(accessToken), aTrack.album)
+                          album(urlWithToken(apiKey), aTrack.album)
                         ),
                       })
                     );
@@ -471,14 +604,14 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(async ({ musicLibrary, accessToken, type, typeId }) => {
+              .then(async ({ musicLibrary, apiKey, type, typeId }) => {
                 const paging = { _index: index, _count: count };
                 switch (type) {
                   case "artist":
                     return musicLibrary.artist(typeId).then((artist) => {
-                      const [page, total] = slice2<Album>(paging)(
+                      const [page, total] = slice2<AlbumSummary>(paging)(
                         artist.albums
                       );
                       return {
@@ -487,7 +620,7 @@ function bindSmapiSoapServiceToExpress(
                           index: paging._index,
                           total,
                           mediaCollection: page.map((it) =>
-                            album(urlWithToken(accessToken), it)
+                            album(urlWithToken(apiKey), it)
                           ),
                           relatedBrowse:
                             artist.similarArtists.filter((it) => it.inLibrary)
@@ -505,25 +638,7 @@ function bindSmapiSoapServiceToExpress(
                   case "track":
                     return musicLibrary.track(typeId).then((it) => ({
                       getExtendedMetadataResult: {
-                        mediaMetadata: {
+                        mediaMetadata: track(urlWithToken(apiKey), it),
-                          id: `track:${it.id}`,
-                          itemType: "track",
-                          title: it.name,
-                          mimeType: it.mimeType,
-                          trackMetadata: {
-                            artistId: `artist:${it.artist.id}`,
-                            artist: it.artist.name,
-                            albumId: `album:${it.album.id}`,
-                            album: it.album.name,
-                            genre: it.genre?.name,
-                            genreId: it.genre?.id,
-                            duration: it.duration,
-                            albumArtURI: defaultAlbumArtURI(
-                              urlWithToken(accessToken),
-                              it.album
-                            ).href(),
-                          },
-                        },
                       },
                     }));
                   case "album":
@@ -535,7 +650,7 @@ function bindSmapiSoapServiceToExpress(
                             userContent: false,
                             renameable: false,
                           },
-                          ...album(urlWithToken(accessToken), it),
+                          ...album(urlWithToken(apiKey), it),
                         },
                         // <mediaCollection readonly="true">
                         //   </mediaCollection>
@@ -561,9 +676,9 @@ function bindSmapiSoapServiceToExpress(
             soapyHeaders: SoapyHeaders,
             { headers }: Pick<Request, "headers">
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(({ musicLibrary, accessToken, type, typeId }) => {
+              .then(({ musicLibrary, apiKey, type, typeId }) => {
                 const paging = { _index: index, _count: count };
                 const acceptLanguage = headers["accept-language"];
                 logger.debug(
@@ -575,7 +690,7 @@ function bindSmapiSoapServiceToExpress(
                   musicLibrary.albums(q).then((result) => {
                     return getMetadataResult({
                       mediaCollection: result.results.map((it) =>
-                        album(urlWithToken(accessToken), it)
+                        album(urlWithToken(apiKey), it)
                       ),
                       index: paging._index,
                       total: result.total,
@@ -598,6 +713,24 @@ function bindSmapiSoapServiceToExpress(
                           albumArtURI: iconArtURI(bonobUrl, "albums").href(),
                           itemType: "albumList",
                         },
+                        {
+                          id: "randomAlbums",
+                          title: lang("random"),
+                          albumArtURI: iconArtURI(bonobUrl, "random").href(),
+                          itemType: "albumList",
+                        },
+                        {
+                          id: "favouriteAlbums",
+                          title: lang("favourites"),
+                          albumArtURI: iconArtURI(bonobUrl, "heart").href(),
+                          itemType: "albumList",
+                        },
+                        {
+                          id: "starredAlbums",
+                          title: lang("topRated"),
+                          albumArtURI: iconArtURI(bonobUrl, "star").href(),
+                          itemType: "albumList",
+                        },
                         {
                           id: "playlists",
                           title: lang("playlists"),
@@ -616,16 +749,10 @@ function bindSmapiSoapServiceToExpress(
                           itemType: "container",
                         },
                         {
-                          id: "randomAlbums",
+                          id: "years",
-                          title: lang("random"),
+                          title: lang("years"),
-                          albumArtURI: iconArtURI(bonobUrl, "random").href(),
+                          albumArtURI: iconArtURI(bonobUrl, "music").href(),
-                          itemType: "albumList",
+                          itemType: "container",
-                        },
-                        {
-                          id: "starredAlbums",
-                          title: lang("starred"),
-                          albumArtURI: iconArtURI(bonobUrl, "starred").href(),
-                          itemType: "albumList",
                         },
                         {
                           id: "recentlyAdded",
@@ -654,9 +781,13 @@ function bindSmapiSoapServiceToExpress(
                           ).href(),
                           itemType: "albumList",
                         },
+                        {
+                          id: "internetRadio",
+                          title: lang("internetRadio"),
+                          albumArtURI: iconArtURI(bonobUrl, "radio").href(),
+                          itemType: "stream",
+                        },
                       ],
-                      index: 0,
-                      total: 9,
                     });
                   case "search":
                     return getMetadataResult({
@@ -677,14 +808,12 @@ function bindSmapiSoapServiceToExpress(
                           title: lang("tracks"),
                         },
                       ],
-                      index: 0,
-                      total: 3,
                     });
                   case "artists":
                     return musicLibrary.artists(paging).then((result) => {
                       return getMetadataResult({
                         mediaCollection: result.results.map((it) =>
-                          artist(urlWithToken(accessToken), it)
+                          artist(urlWithToken(apiKey), it)
                         ),
                         index: paging._index,
                         total: result.total,
@@ -702,11 +831,23 @@ function bindSmapiSoapServiceToExpress(
                       genre: typeId,
                       ...paging,
                     });
+                  case "year":
+                    return albums({
+                      type: "byYear",
+                      fromYear: typeId,
+                      toYear: typeId,
+                      ...paging,
+                    });
                   case "randomAlbums":
                     return albums({
                       type: "random",
                       ...paging,
                     });
+                  case "favouriteAlbums":
+                    return albums({
+                      type: "favourited",
+                      ...paging,
+                    });
                   case "starredAlbums":
                     return albums({
                       type: "starred",
@@ -714,19 +855,45 @@ function bindSmapiSoapServiceToExpress(
                     });
                   case "recentlyAdded":
                     return albums({
-                      type: "newest",
+                      type: "recentlyAdded",
                       ...paging,
                     });
                   case "recentlyPlayed":
                     return albums({
-                      type: "recent",
+                      type: "recentlyPlayed",
                       ...paging,
                     });
                   case "mostPlayed":
                     return albums({
-                      type: "frequent",
+                      type: "mostPlayed",
                       ...paging,
                     });
+                  case "internetRadio":
+                    return musicLibrary
+                      .radioStations()
+                      .then(slice2(paging))
+                      .then(([page, total]) =>
+                        getMetadataResult({
+                          mediaMetadata: page.map((it) =>
+                            internetRadioStation(it)
+                          ),
+                          index: paging._index,
+                          total,
+                        })
+                      );
+                  case "years":
+                    return musicLibrary
+                      .years()
+                      .then(slice2(paging))
+                      .then(([page, total]) =>
+                        getMetadataResult({
+                          mediaCollection: page.map((it) =>
+                            yyyy(bonobUrl, it)
+                          ),
+                          index: paging._index,
+                          total,
+                        })
+                      );
                   case "genres":
                     return musicLibrary
                       .genres()
@@ -745,16 +912,23 @@ function bindSmapiSoapServiceToExpress(
                       .playlists()
                       .then((it) =>
                         Promise.all(
-                          it.map((playlist) =>
+                          it.map((playlist) => {
-                            musicLibrary.playlist(playlist.id)
+                            // todo: whats this odd copy all about, can we just delete it?
-                          )
+                            return {
+                              id: playlist.id,
+                              name: playlist.name,
+                              coverArt: playlist.coverArt,
+                              // todo: are these every important?
+                              entries: [],
+                            };
+                          })
                         )
                       )
                       .then(slice2(paging))
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaCollection: page.map((it) =>
-                            playlist(urlWithToken(accessToken), it)
+                            playlist(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -768,7 +942,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaMetadata: page.map((it) =>
-                            track(urlWithToken(accessToken), it)
+                            track(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -779,15 +953,15 @@ function bindSmapiSoapServiceToExpress(
                       .artist(typeId!)
                       .then((artist) => artist.albums)
                       .then(slice2(paging))
-                      .then(([page, total]) => {
+                      .then(([page, total]) =>
-                        return getMetadataResult({
+                        getMetadataResult({
                           mediaCollection: page.map((it) =>
-                            album(urlWithToken(accessToken), it)
+                            album(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
-                        });
+                        })
-                      });
+                      );
                   case "relatedArtists":
                     return musicLibrary
                       .artist(typeId!)
@@ -799,7 +973,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaCollection: page.map((it) =>
-                            artist(urlWithToken(accessToken), it)
+                            artist(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -807,12 +981,13 @@ function bindSmapiSoapServiceToExpress(
                       });
                   case "album":
                     return musicLibrary
-                      .tracks(typeId!)
+                      .album(typeId!)
+                      .then(it => it.tracks)
                       .then(slice2(paging))
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaMetadata: page.map((it) =>
-                            track(urlWithToken(accessToken), it)
+                            track(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -827,7 +1002,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(({ musicLibrary }) =>
                 musicLibrary
                   .createPlaylist(title)
@@ -853,7 +1028,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(({ musicLibrary }) => musicLibrary.deletePlaylist(id))
               .then((_) => ({ deleteContainerResult: {} })),
           addToContainer: async (
@@ -861,7 +1036,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
               .then(({ musicLibrary, typeId }) =>
                 musicLibrary.addToPlaylist(parentId.split(":")[1]!, typeId)
@@ -872,7 +1047,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
               .then((it) => ({
                 ...it,
@@ -890,28 +1065,41 @@ function bindSmapiSoapServiceToExpress(
                 }
               })
               .then((_) => ({ removeFromContainerResult: { updateId: "" } })),
+          rateItem: async (
+            { id, rating }: { id: string; rating: number },
+            _,
+            soapyHeaders: SoapyHeaders
+          ) =>
+            login(soapyHeaders?.credentials)
+              .then(splitId(id))
+              .then(({ musicLibrary, typeId }) =>
+                musicLibrary.rate(typeId, ratingFromInt(Math.abs(rating)))
+              )
+              .then((_) => ({ rateItemResult: { shouldSkip: false } })),
+
           setPlayedSeconds: async (
             { id, seconds }: { id: string; seconds: string },
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
               .then(({ musicLibrary, type, typeId }) => {
                 switch (type) {
                   case "track":
-                    musicLibrary.track(typeId).then(({ duration }) => {
+                    return musicLibrary.track(typeId).then(({ duration }) => {
                       if (
                         (duration < 30 && +seconds >= 10) ||
                         (duration >= 30 && +seconds >= 30)
                       ) {
-                        musicLibrary.scrobble(typeId);
+                        return musicLibrary.scrobble(typeId);
+                      } else {
+                        return Promise.resolve(true);
                       }
                     });
-                    break;
                   default:
                     logger.info("Unsupported scrobble", { id, seconds });
-                    break;
+                    return Promise.resolve(true);
                 }
               })
               .then((_) => ({
@@ -930,8 +1118,9 @@ function bindSmapiSoapServiceToExpress(
 
   soapyService.log = (type, data) => {
     switch (type) {
+      // routing all soap info messages to debug so less noisy
       case "info":
-        logger.info({ level: "info", data });
+        logger.debug({ level: "info", data });
         break;
       case "warn":
         logger.warn({ level: "warn", data });

src/smapi_auth.ts

@@ -0,0 +1,177 @@
+import { either as E } from "fp-ts";
+import jwt from "jsonwebtoken";
+import { v4 as uuid } from "uuid";
+import { b64Decode, b64Encode } from "./b64";
+import { Clock } from "./clock";
+
+export type SmapiFault = { Fault: { faultcode: string; faultstring: string } };
+export type SmapiRefreshTokenResultFault = SmapiFault & {
+  Fault: {
+    detail: {
+      refreshAuthTokenResult: { authToken: string; privateKey: string };
+    };
+  };
+};
+
+function isError(thing: any): thing is Error {
+  return thing.name && thing.message;
+}
+
+export function isSmapiRefreshTokenResultFault(
+  fault: SmapiFault
+): fault is SmapiRefreshTokenResultFault {
+  return (fault.Fault as any).detail?.refreshAuthTokenResult != undefined;
+}
+
+export type SmapiToken = {
+  token: string;
+  key: string;
+};
+
+export interface ToSmapiFault {
+  _tag: string;
+  toSmapiFault(): SmapiFault
+}
+
+export const SMAPI_FAULT_LOGIN_UNAUTHORIZED = {
+  Fault: {
+    faultcode: "Client.LoginUnauthorized",
+    faultstring:
+      "Failed to authenticate, try Re-Authorising your account in the sonos app",
+  },
+};
+
+export const SMAPI_FAULT_LOGIN_UNSUPPORTED = {
+  Fault: {
+    faultcode: "Client.LoginUnsupported",
+    faultstring: "Missing credentials...",
+  },
+};
+
+export class MissingLoginTokenError extends Error implements ToSmapiFault {
+  _tag = "MissingLoginTokenError";
+
+  constructor() {
+    super("Missing Login Token");
+  }
+
+  toSmapiFault = () => SMAPI_FAULT_LOGIN_UNSUPPORTED;
+}
+
+
+export class InvalidTokenError extends Error implements ToSmapiFault {
+  _tag = "InvalidTokenError";
+
+  constructor(message: string) {
+    super(message);
+  }
+
+  toSmapiFault = () => SMAPI_FAULT_LOGIN_UNAUTHORIZED;
+}
+
+export function isExpiredTokenError(thing: any): thing is ExpiredTokenError {
+  return thing._tag == "ExpiredTokenError";
+}
+
+export class ExpiredTokenError extends Error implements ToSmapiFault {
+  _tag = "ExpiredTokenError";
+  expiredToken: string;
+
+  constructor(expiredToken: string) {
+    super("SMAPI token has expired");
+    this.expiredToken = expiredToken;
+  }
+
+  toSmapiFault = () => ({
+    Fault: {
+      faultcode: "Client.TokenRefreshRequired",
+      faultstring: "Token has expired",
+    },
+  });
+}
+
+export type SmapiAuthTokens = {
+  issue: (serviceToken: string) => SmapiToken;
+  verify: (smapiToken: SmapiToken) => E.Either<ToSmapiFault, string>;
+};
+
+type TokenExpiredError = {
+  name: string;
+  message: string;
+  expiredAt: number;
+};
+
+function isTokenExpiredError(thing: any): thing is TokenExpiredError {
+  return thing.name == "TokenExpiredError";
+}
+
+export const smapiTokenAsString = (smapiToken: SmapiToken) =>
+  b64Encode(
+    JSON.stringify({
+      token: smapiToken.token,
+      key: smapiToken.key,
+    })
+  );
+export const smapiTokenFromString = (smapiTokenString: string): SmapiToken =>
+  JSON.parse(b64Decode(smapiTokenString));
+
+export const SMAPI_TOKEN_VERSION = 2;
+
+export class JWTSmapiLoginTokens implements SmapiAuthTokens {
+  private readonly clock: Clock;
+  private readonly secret: string;
+  private readonly expiresIn: string;
+  private readonly version: number;
+  private readonly keyGenerator: () => string;
+
+  constructor(
+    clock: Clock,
+    secret: string,
+    expiresIn: string,
+    keyGenerator: () => string = uuid,
+    version: number = SMAPI_TOKEN_VERSION
+  ) {
+    this.clock = clock;
+    this.secret = secret;
+    this.expiresIn = expiresIn;
+    this.version = version;
+    this.keyGenerator = keyGenerator;
+  }
+
+  issue = (serviceToken: string) => {
+    const key = this.keyGenerator();
+    return {
+      token: jwt.sign(
+        { serviceToken, iat: this.clock.now().unix() },
+        this.secret + this.version + key,
+        { expiresIn: this.expiresIn }
+      ),
+      key,
+    };
+  };
+
+  verify = (smapiToken: SmapiToken): E.Either<ToSmapiFault, string> => {
+    try {
+      return E.right(
+        (
+          jwt.verify(
+            smapiToken.token,
+            this.secret + this.version + smapiToken.key
+          ) as any
+        ).serviceToken
+      );
+    } catch (e) {
+      if (isTokenExpiredError(e)) {
+        const serviceToken = (
+          jwt.verify(
+            smapiToken.token,
+            this.secret + this.version + smapiToken.key,
+            { ignoreExpiration: true }
+          ) as any
+        ).serviceToken;
+        return E.left(new ExpiredTokenError(serviceToken));
+      } else if (isError(e)) return E.left(new InvalidTokenError(e.message));
+      else return E.left(new InvalidTokenError("Failed to verify token"));
+    }
+  };
+}

src/sonos.ts

@@ -24,25 +24,25 @@ export const SONOS_LANG: LANG[] = [
   "zh-CN",
 ];
 
-export const PRESENTATION_AND_STRINGS_VERSION = "21";
+export const PRESENTATION_AND_STRINGS_VERSION =
+  process.env["BNB_DEBUG"] === "true"
+    ? `${Math.round(new Date().getTime() / 1000)}`
+    : "23";
 
-// NOTE: manifest requires https for the URL,
+// NOTE: manifest requires https for the URL, otherwise you will get an error trying to register
-// otherwise you will get an error trying to register
 export type Capability =
   | "search"
-  | "trFavorites"
+  | "trFavorites" // Favorites: Adding/Removing Tracks (deprecated)
-  | "alFavorites"
+  | "alFavorites" // Favorites: Adding/Removing Albums (deprecated)
-  | "ucPlaylists"
+  | "ucPlaylists" // User Content Playlists
-  | "extendedMD"
+  | "extendedMD" // Extended Metadata (More Menu, Info & Options)
   | "contextHeaders"
   | "authorizationHeader"
-  | "logging"
+  | "logging" // Playback duration logging at track end (deprecated)
   | "manifest";
 
 export const BONOB_CAPABILITIES: Capability[] = [
   "search",
-  // "trFavorites",
-  // "alFavorites",
   "ucPlaylists",
   "extendedMD",
   "logging",
@@ -101,8 +101,8 @@ export interface Sonos {
 export const SONOS_DISABLED: Sonos = {
   devices: () => Promise.resolve([]),
   services: () => Promise.resolve([]),
-  remove: (_: number) => Promise.resolve(true),
+  remove: (_: number) => Promise.resolve(false),
-  register: (_: Service) => Promise.resolve(true),
+  register: (_: Service) => Promise.resolve(false),
 };
 
 export const asService = (musicService: MusicService): Service => ({
@@ -176,7 +176,7 @@ export function autoDiscoverySonos(sonosSeedHost?: string): Sonos {
         }
       })
       .catch((e) => {
-        logger.error(`Failed looking for sonos devices`, { cause: e });
+        logger.error(`Failed looking for sonos devices - ${e}`, { cause: e });
         return [];
       });
   };
@@ -243,13 +243,11 @@ export function autoDiscoverySonos(sonosSeedHost?: string): Sonos {
 }
 
 export type Discovery = {
-  auto: boolean;
+  enabled: boolean;
   seedHost?: string;
 };
 
-export default (
+export default (sonosDiscovery: Discovery = { enabled: true }): Sonos =>
-  sonosDiscovery: Discovery = { auto: true }
+  sonosDiscovery.enabled
-): Sonos =>
-  sonosDiscovery.auto
     ? autoDiscoverySonos(sonosDiscovery.seedHost)
     : SONOS_DISABLED;

src/subsonic.ts

@@ -0,0 +1,893 @@
+import { option as O, taskEither as TE } from "fp-ts";
+import * as A from "fp-ts/Array";
+import { ordString } from "fp-ts/lib/Ord";
+import { pipe } from "fp-ts/lib/function";
+import { Md5 } from "ts-md5";
+import {
+  Credentials,
+  Album,
+  AlbumQuery,
+  AlbumSummary,
+  Genre,
+  Track,
+  CoverArt,
+  AlbumQueryType,
+  Encoding,
+  albumToAlbumSummary,
+  TrackSummary,
+  AuthFailure
+} from "./music_library";
+import sharp from "sharp";
+import _ from "underscore";
+import fse from "fs-extra";
+import path from "path";
+
+import axios, { AxiosRequestConfig } from "axios";
+import randomstring from "randomstring";
+import { b64Encode, b64Decode } from "./b64";
+import { BUrn } from "./burn";
+import { album, artist } from "./smapi";
+import { URLBuilder } from "./url_builder";
+
+export const BROWSER_HEADERS = {
+  accept:
+    "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
+  "accept-encoding": "gzip, deflate, br",
+  "accept-language": "en-GB,en;q=0.5",
+  "upgrade-insecure-requests": "1",
+  "user-agent":
+    "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:86.0) Gecko/20100101 Firefox/86.0",
+};
+
+export const t = (password: string, s: string) =>
+  Md5.hashStr(`${password}${s}`);
+
+export const t_and_s = (password: string) => {
+  const s = randomstring.generate();
+  return {
+    t: t(password, s),
+    s,
+  };
+};
+
+export const DODGY_IMAGE_NAME = "2a96cbd8b46e442fc41c2b86b821562f.png";
+
+export const isValidImage = (url: string | undefined) =>
+  url != undefined && !url.endsWith(DODGY_IMAGE_NAME);
+
+type SubsonicEnvelope = {
+  "subsonic-response": SubsonicResponse;
+};
+
+type SubsonicResponse = {
+  status: string;
+};
+
+type album = {
+  id: string;
+  name: string;
+  artist: string | undefined;
+  artistId: string | undefined;
+  coverArt: string | undefined;
+  genre: string | undefined;
+  year: string | undefined;
+};
+
+type artist = {
+  id: string;
+  name: string;
+  albumCount: number;
+  artistImageUrl: string | undefined;
+};
+
+type GetArtistsResponse = SubsonicResponse & {
+  artists: {
+    index: {
+      artist: artist[];
+      name: string;
+    }[];
+  };
+};
+
+type GetAlbumListResponse = SubsonicResponse & {
+  albumList2: {
+    album: album[];
+  };
+};
+
+type genre = {
+  songCount: number;
+  albumCount: number;
+  value: string;
+};
+
+export type GetGenresResponse = SubsonicResponse & {
+  genres: {
+    genre: genre[];
+  };
+};
+
+type SubsonicError = SubsonicResponse & {
+  error: {
+    code: string;
+    message: string;
+  };
+};
+
+export type images = {
+  smallImageUrl: string | undefined;
+  mediumImageUrl: string | undefined;
+  largeImageUrl: string | undefined;
+};
+
+type artistInfo = images & {
+  biography: string | undefined;
+  musicBrainzId: string | undefined;
+  lastFmUrl: string | undefined;
+  similarArtist: artist[];
+};
+
+type ArtistSummary = IdName & {
+  image: BUrn | undefined;
+};
+
+type GetArtistInfoResponse = SubsonicResponse & {
+  artistInfo2: artistInfo;
+};
+
+type GetArtistResponse = SubsonicResponse & {
+  artist: artist & {
+    album: album[];
+  };
+};
+
+export type song = {
+  id: string;
+  parent: string | undefined;
+  title: string;
+  album: string | undefined;
+  albumId: string | undefined;
+  artist: string | undefined;
+  artistId: string | undefined;
+  track: number | undefined;
+  year: string | undefined;
+  genre: string | undefined;
+  coverArt: string | undefined;
+  created: string | undefined;
+  duration: number | undefined;
+  bitRate: number | undefined;
+  suffix: string | undefined;
+  contentType: string;
+  transcodedContentType: string | undefined;
+  type: string | undefined;
+  userRating: number | undefined;
+  // todo: this field shouldnt be on song?
+  starred: string | undefined;
+};
+
+export type GetAlbumResponse = {
+  album: album & {
+    song: song[];
+  };
+};
+
+export type GetPlaylistResponse = {
+  // todo: isnt the type here a composite? playlistSummary && { entry: song[]; }
+  playlist: {
+    id: string;
+    name: string;
+    entry: song[];
+
+    // todo: this is an ND specific field?
+    coverArt: string | undefined;
+  };
+};
+
+export type GetPlaylistsResponse = {
+  playlists: { 
+    playlist: {
+      id: string;
+      name: string;
+      //owner: string,
+      //public: boolean,
+      //created: string,
+      //changed: string,
+      //songCount: int,
+      //duration: int,
+
+      // todo: this is an ND specific field.
+      coverArt: string | undefined;
+    }[] 
+  };
+};
+
+export type GetSimilarSongsResponse = {
+  similarSongs2: { song: song[] };
+};
+
+export type GetTopSongsResponse = {
+  topSongs: { song: song[] };
+};
+
+export type GetInternetRadioStationsResponse = {
+  internetRadioStations: {
+    internetRadioStation: {
+      id: string;
+      name: string;
+      streamUrl: string;
+      homePageUrl?: string;
+    }[];
+  };
+};
+
+export type GetSongResponse = {
+  song: song;
+};
+
+export type GetStarredResponse = {
+  starred2: {
+    song: song[];
+    album: album[];
+  };
+};
+
+export type PingResponse = {
+  status: string;
+  version: string;
+  type: string;
+  serverVersion: string;
+};
+
+export type Search3Response = SubsonicResponse & {
+  searchResult3: {
+    artist: artist[];
+    album: album[];
+    song: song[];
+  };
+};
+
+export function isError(
+  subsonicResponse: SubsonicResponse
+): subsonicResponse is SubsonicError {
+  return (subsonicResponse as SubsonicError).error !== undefined;
+}
+
+export type IdName = {
+  id: string;
+  name: string;
+};
+
+export const coverArtURN = (coverArt: string | undefined): BUrn | undefined =>
+  pipe(
+    coverArt,
+    O.fromNullable,
+    O.map((it: string) => ({ system: "subsonic", resource: `art:${it}` })),
+    O.getOrElseW(() => undefined)
+  );
+
+export const artistImageURN = (
+  spec: Partial<{
+    artistId: string | undefined;
+    artistImageURL: string | undefined;
+  }>
+): BUrn | undefined => {
+  const deets = {
+    artistId: undefined,
+    artistImageURL: undefined,
+    ...spec,
+  };
+  if (deets.artistImageURL && isValidImage(deets.artistImageURL)) {
+    return {
+      system: "external",
+      resource: deets.artistImageURL,
+    };
+  } else if (artistIsInLibrary(deets.artistId)) {
+    return {
+      system: "subsonic",
+      resource: `art:${deets.artistId!}`,
+    };
+  } else {
+    return undefined;
+  }
+};
+
+export const asTrackSummary = (
+  song: song,
+  customPlayers: CustomPlayers
+): TrackSummary => ({
+  id: song.id,
+  name: song.title,
+  encoding: pipe(
+    customPlayers.encodingFor({ mimeType: song.contentType }),
+    O.getOrElse(() => ({
+      player: DEFAULT_CLIENT_APPLICATION,
+      mimeType: song.transcodedContentType
+        ? song.transcodedContentType
+        : song.contentType,
+    }))
+  ),
+  duration: song.duration || 0,
+  number: song.track || 0,
+  genre: maybeAsGenre(song.genre),
+  coverArt: coverArtURN(song.coverArt),
+  artist: {
+    id: song.artistId,
+    name: song.artist ? song.artist : "?",
+    image: song.artistId
+      ? artistImageURN({ artistId: song.artistId })
+      : undefined,
+  },
+  rating: {
+    love: song.starred != undefined,
+    stars:
+      song.userRating && song.userRating <= 5 && song.userRating >= 0
+        ? song.userRating
+        : 0,
+  },
+});
+
+export const asTrack = (
+  album: AlbumSummary,
+  song: song,
+  customPlayers: CustomPlayers
+): Track => ({
+  ...asTrackSummary(song, customPlayers),
+  album: album,
+});
+
+export const asAlbumSummary = (album: album): AlbumSummary => ({
+  id: album.id,
+  name: album.name,
+  year: album.year,
+  genre: maybeAsGenre(album.genre),
+  artistId: album.artistId,
+  artistName: album.artist,
+  coverArt: coverArtURN(album.coverArt),
+});
+
+export const asGenre = (genreName: string) => ({
+  id: b64Encode(genreName),
+  name: genreName,
+});
+
+export const maybeAsGenre = (
+  genreName: string | undefined
+): Genre | undefined =>
+  pipe(
+    genreName,
+    O.fromNullable,
+    O.map(asGenre),
+    O.getOrElseW(() => undefined)
+  );
+
+export const asYear = (year: string) => ({
+  year: year,
+});
+
+export interface CustomPlayers {
+  encodingFor({ mimeType }: { mimeType: string }): O.Option<Encoding>;
+}
+
+export type CustomClient = {
+  mimeType: string;
+  transcodedMimeType: string;
+};
+
+export class TranscodingCustomPlayers implements CustomPlayers {
+  transcodings: Map<string, string>;
+
+  constructor(transcodings: Map<string, string>) {
+    this.transcodings = transcodings;
+  }
+
+  static from(config: string): TranscodingCustomPlayers {
+    const parts: [string, string][] = config
+      .split(",")
+      .map((it) => it.split(">"))
+      .map((pair) => {
+        if (pair.length == 1) return [pair[0]!, pair[0]!];
+        else if (pair.length == 2) return [pair[0]!, pair[1]!];
+        else throw new Error(`Invalid configuration item ${config}`);
+      });
+    return new TranscodingCustomPlayers(new Map(parts));
+  }
+
+  encodingFor = ({ mimeType }: { mimeType: string }): O.Option<Encoding> =>
+    pipe(
+      this.transcodings.get(mimeType),
+      O.fromNullable,
+      O.map((transcodedMimeType) => ({
+        player: `${DEFAULT_CLIENT_APPLICATION}+${mimeType}`,
+        mimeType: transcodedMimeType,
+      }))
+    );
+}
+
+export const NO_CUSTOM_PLAYERS: CustomPlayers = {
+  encodingFor(_) {
+    return O.none;
+  },
+};
+
+export const DEFAULT_CLIENT_APPLICATION = "bonob";
+export const USER_AGENT = "bonob";
+
+export const asURLSearchParams = (q: any) => {
+  const urlSearchParams = new URLSearchParams();
+  Object.keys(q).forEach((k) => {
+    _.flatten([q[k]]).forEach((v) => {
+      urlSearchParams.append(k, `${v}`);
+    });
+  });
+  return urlSearchParams;
+};
+
+export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>;
+
+export const cachingImageFetcher =
+  (cacheDir: string, delegate: ImageFetcher, makeSharp = sharp) =>
+  async (url: string): Promise<CoverArt | undefined> => {
+    const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
+    return fse
+      .readFile(filename)
+      .then((data) => ({ contentType: "image/png", data }))
+      .catch(() =>
+        delegate(url).then((image) => {
+          if (image) {
+            return makeSharp(image.data)
+              .png()
+              .toBuffer()
+              .then((png) => {
+                return fse
+                  .writeFile(filename, png)
+                  .then(() => ({ contentType: "image/png", data: png }));
+              });
+          } else {
+            return undefined;
+          }
+        })
+      );
+  };
+
+export const axiosImageFetcher = (url: string): Promise<CoverArt | undefined> =>
+  axios
+    .get(url, {
+      headers: BROWSER_HEADERS,
+      responseType: "arraybuffer",
+    })
+    .then((res) => ({
+      contentType: res.headers["content-type"],
+      data: Buffer.from(res.data, "binary"),
+    }))
+    .catch(() => undefined);
+
+const AlbumQueryTypeToSubsonicType: Record<AlbumQueryType, string> = {
+  alphabeticalByArtist: "alphabeticalByArtist",
+  alphabeticalByName: "alphabeticalByName",
+  byGenre: "byGenre",
+  byYear: "byYear",
+  random: "random",
+  recentlyPlayed: "recent",
+  mostPlayed: "frequent",
+  recentlyAdded: "newest",
+  favourited: "starred",
+  starred: "highest",
+};
+
+const artistIsInLibrary = (artistId: string | undefined) =>
+  artistId != undefined && artistId != "-1";
+
+type SubsonicCredentials = Credentials & {
+  type: string;
+  bearer: string | undefined;
+};
+
+export const asToken = (credentials: SubsonicCredentials) =>
+  b64Encode(JSON.stringify(credentials));
+
+export const parseToken = (token: string): SubsonicCredentials =>
+  JSON.parse(b64Decode(token));
+
+export class Subsonic {
+  url: URLBuilder;
+  customPlayers: CustomPlayers;
+  externalImageFetcher: ImageFetcher;
+
+  constructor(
+    url: URLBuilder,
+    customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS,
+    externalImageFetcher: ImageFetcher = axiosImageFetcher
+  ) {
+    this.url = url;
+    this.customPlayers = customPlayers;
+    this.externalImageFetcher = externalImageFetcher;
+  }
+
+  private get = async (
+    { username, password }: Credentials,
+    path: string,
+    q: {} = {},
+    config: AxiosRequestConfig | undefined = {}
+  ) =>
+    axios
+      .get(this.url.append({ pathname: path }).href(), {
+        params: asURLSearchParams({
+          u: username,
+          v: "1.16.1",
+          c: DEFAULT_CLIENT_APPLICATION,
+          ...t_and_s(password),
+          ...q,
+        }),
+        headers: {
+          "User-Agent": USER_AGENT,
+        },
+        ...config,
+      })
+      .catch((e) => {
+        throw `Subsonic failed with: ${e}`;
+      })
+      .then((response) => {
+        if (response.status != 200 && response.status != 206) {
+          throw `Subsonic failed with a ${response.status || "no!"} status`;
+        } else return response;
+      });
+
+  // todo: should I put a catch in here and force a subsonic fail status?
+  // or there is a catch above, that then throws, perhaps can go in there?
+  private getJSON = async <T>(
+    { username, password }: Credentials,
+    path: string,
+    q: {} = {}
+  ): Promise<T> =>
+    this.get({ username, password }, path, { f: "json", ...q })
+      .then((response) => response.data as SubsonicEnvelope)
+      .then((json) => json["subsonic-response"])
+      .then((json) => {
+        if (isError(json)) throw `Subsonic error:${json.error.message}`;
+        else return json as unknown as T;
+      });
+
+  ping = (credentials: Credentials): TE.TaskEither<AuthFailure, { authenticated: Boolean, type: string}> => 
+    TE.tryCatch(
+      () => this.getJSON<PingResponse>(credentials, "/rest/ping.view")
+      .then(it => ({
+        authenticated: it.status == "ok",
+        type: it.type
+      })),
+      (e) => new AuthFailure(e as string)
+    )
+    
+
+  getArtists = (
+    credentials: Credentials
+  ): Promise<(IdName & { albumCount: number; image: BUrn | undefined })[]> =>
+    this.getJSON<GetArtistsResponse>(credentials, "/rest/getArtists")
+      .then((it) => (it.artists.index || []).flatMap((it) => it.artist || []))
+      .then((artists) =>
+        artists.map((artist) => ({
+          id: `${artist.id}`,
+          name: artist.name,
+          albumCount: artist.albumCount,
+          image: artistImageURN({
+            artistId: artist.id,
+            artistImageURL: artist.artistImageUrl,
+          }),
+        }))
+      );
+
+      // todo: should be getArtistInfo2?
+  getArtistInfo = (
+    credentials: Credentials,
+    id: string
+  ): Promise<{
+    similarArtist: (ArtistSummary & { inLibrary: boolean })[];
+    images: {
+      s: string | undefined;
+      m: string | undefined;
+      l: string | undefined;
+    };
+  }> =>
+    this.getJSON<GetArtistInfoResponse>(credentials, "/rest/getArtistInfo2", {
+      id,
+      count: 50,
+      includeNotPresent: true,
+    })
+      .then((it) => it.artistInfo2)
+      .then((it) => ({
+        images: {
+          s: it.smallImageUrl,
+          m: it.mediumImageUrl,
+          l: it.largeImageUrl,
+        },
+        //todo: this does seem to be in OpenSubsonic?? it is also singular
+        similarArtist: (it.similarArtist || []).map((artist) => ({
+          id: `${artist.id}`,
+          name: artist.name,
+          // todo: whats this inLibrary used for? it probably should be filtered on??
+          inLibrary: artistIsInLibrary(artist.id),
+          image: artistImageURN({
+            artistId: artist.id,
+            artistImageURL: artist.artistImageUrl,
+          }),
+        })),
+        })
+      );
+
+  getAlbum = (credentials: Credentials, id: string): Promise<Album>  =>
+    this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id })
+      .then((it) => it.album)
+      .then((album) => {
+        const x: AlbumSummary = {
+          id: album.id,
+          name: album.name,
+          year: album.year,
+          genre: maybeAsGenre(album.genre),
+          artistId: album.artistId,
+          artistName: album.artist,
+          coverArt: coverArtURN(album.coverArt)
+        }
+        return { summary: x, songs: album.song }
+      }).then(({ summary, songs }) => {
+        const x: AlbumSummary = summary
+        const y: Track[] = songs.map((it) => asTrack(summary, it, this.customPlayers))
+        return {
+          ...x,
+          tracks: y
+        };
+      });
+   
+  getArtist = (
+    credentials: Credentials,
+    id: string
+  ): Promise<
+    IdName & { artistImageUrl: string | undefined; albums: AlbumSummary[] }
+  > =>
+    this.getJSON<GetArtistResponse>(credentials, "/rest/getArtist", {
+      id,
+    })
+      .then((it) => it.artist)
+      .then((it) => ({
+        id: it.id,
+        name: it.name,
+        artistImageUrl: it.artistImageUrl,
+        albums: this.toAlbumSummary(it.album || []),
+      }));
+
+  getCoverArt = (credentials: Credentials, id: string, size?: number) =>
+    this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, {
+      headers: { "User-Agent": "bonob" },
+      responseType: "arraybuffer",
+    });
+
+  getTrack = (credentials: Credentials, id: string) =>
+    this.getJSON<GetSongResponse>(credentials, "/rest/getSong", {
+      id,
+    })
+      .then((it) => it.song)
+      .then((song) =>
+        this.getAlbum(credentials, song.albumId!).then((album) =>
+          asTrack(albumToAlbumSummary(album), song, this.customPlayers)
+        )
+      );
+
+  getStarred = (credentials: Credentials) =>
+    this.getJSON<GetStarredResponse>(credentials, "/rest/getStarred2").then(
+      (it) => new Set(it.starred2.song.map((it) => it.id))
+    );
+
+  toAlbumSummary = (albumList: album[]): AlbumSummary[] =>
+    albumList.map((album) => ({
+      id: album.id,
+      name: album.name,
+      year: album.year,
+      genre: maybeAsGenre(album.genre),
+      artistId: album.artistId,
+      artistName: album.artist,
+      coverArt: coverArtURN(album.coverArt),
+    }));
+
+  search3 = (credentials: Credentials, q: any) =>
+    this.getJSON<Search3Response>(credentials, "/rest/search3", {
+      artistCount: 0,
+      albumCount: 0,
+      songCount: 0,
+      ...q,
+    }).then((it) => ({
+      artists: it.searchResult3.artist || [],
+      albums: it.searchResult3.album || [],
+      songs: it.searchResult3.song || [],
+    }));
+
+  getAlbumList2 = (credentials: Credentials, q: AlbumQuery) =>
+    Promise.all([
+      this.getArtists(credentials).then((it) =>
+        _.inject(it, (total, artist) => total + artist.albumCount, 0)
+      ),
+      this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", {
+        type: AlbumQueryTypeToSubsonicType[q.type],
+        ...(q.genre ? { genre: b64Decode(q.genre) } : {}),
+        ...(q.fromYear ? { fromYear: q.fromYear } : {}),
+        ...(q.toYear ? { toYear: q.toYear } : {}),
+        size: 500,
+        offset: q._index,
+      })
+        .then((response) => response.albumList2.album || [])
+        .then(this.toAlbumSummary),
+    ]).then(([total, albums]) => ({
+      results: albums.slice(0, q._count),
+      total: albums.length == 500 ? total : q._index + albums.length,
+    }));
+
+  getGenres = (credentials: Credentials) =>
+    this.getJSON<GetGenresResponse>(credentials, "/rest/getGenres").then((it) =>
+      pipe(
+        it.genres.genre || [],
+        A.filter((it) => it.albumCount > 0),
+        A.map((it) => it.value),
+        A.sort(ordString),
+        A.map(maybeAsGenre),
+        A.filter((it) => it != undefined)
+      )
+    );
+
+  private st4r = (credentials: Credentials, action: string,  { id } : { id: string }) => 
+    this.getJSON<SubsonicResponse>(credentials, `/rest/${action}`, { id }).then(it => 
+      it.status == "ok"
+    );
+
+  star = (credentials: Credentials, ids : { id: string }) => 
+    this.st4r(credentials, "star", ids)
+
+  unstar = (credentials: Credentials, ids : { id: string }) => 
+    this.st4r(credentials, "unstar", ids)
+
+  setRating = (credentials: Credentials, id: string, rating: number) => 
+    this.getJSON<SubsonicResponse>(credentials, `/rest/setRating`, {
+      id,
+      rating,
+    })
+    .then(it => it.status == "ok");
+
+  scrobble = (credentials: Credentials, id: string, submission: boolean) =>
+    this.getJSON<SubsonicResponse>(credentials, `/rest/scrobble`, {
+        id,
+        submission,
+      })
+      .then(it => it.status == "ok")
+
+  stream = (credentials: Credentials, id: string, c: string, range: string | undefined) =>
+    this.get(
+      credentials,
+      `/rest/stream`,
+      {
+        id,
+        c,
+      },
+      {
+        headers: pipe(
+          range,
+          O.fromNullable,
+          O.map((range) => ({
+            "User-Agent": USER_AGENT,
+            Range: range,
+          })),
+          O.getOrElse(() => ({
+            "User-Agent": USER_AGENT,
+          }))
+        ),
+        responseType: "stream",
+      }
+    )
+    .then((stream) => ({
+      status: stream.status,
+      headers: {
+        "content-type": stream.headers["content-type"],
+        "content-length": stream.headers["content-length"],
+        "content-range": stream.headers["content-range"],
+        "accept-ranges": stream.headers["accept-ranges"],
+      },
+      stream: stream.data,
+    }));
+
+  playlists = (credentials: Credentials) =>
+    this.getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
+    .then(({ playlists }) => (playlists.playlist || []).map( it => ({
+        id: it.id,
+        name: it.name,
+        coverArt: coverArtURN(it.coverArt),
+      }))
+    );
+
+  playlist = (credentials: Credentials, id: string) =>
+    this.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
+      id,
+    })
+    .then(({ playlist }) => {
+      let trackNumber = 1;
+      return {
+        id: playlist.id,
+        name: playlist.name,
+        coverArt: coverArtURN(playlist.coverArt),
+        entries: (playlist.entry || []).map((entry) => ({
+          ...asTrack(
+            {
+              id: entry.albumId!,
+              name: entry.album!,
+              year: entry.year,
+              genre: maybeAsGenre(entry.genre),
+              artistName: entry.artist,
+              artistId: entry.artistId,
+              coverArt: coverArtURN(entry.coverArt),
+            },
+            entry,
+            this.customPlayers
+          ),
+          number: trackNumber++,
+        })),
+      };
+    });
+
+    createPlayList = (credentials: Credentials, name: string) =>
+      this.getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", {
+        name,
+      })
+      .then(({ playlist }) => ({
+        id: playlist.id,
+        name: playlist.name,
+        coverArt: coverArtURN(playlist.coverArt),
+      }));
+
+    deletePlayList = (credentials: Credentials, id: string) => 
+      this.getJSON<SubsonicResponse>(credentials, "/rest/deletePlaylist", {
+        id,
+      })
+      .then(it => it.status == "ok");
+
+    updatePlaylist = (
+      credentials: Credentials, 
+      playlistId: string, 
+      changes : Partial<{ songIdToAdd: string | undefined, songIndexToRemove: number[] | undefined }> = {}
+    ) => 
+      this.getJSON<SubsonicResponse>(credentials, "/rest/updatePlaylist", {
+        playlistId,
+        ...changes
+      })
+      .then(it => it.status == "ok");
+
+    getSimilarSongs2 = (credentials: Credentials, id: string) =>
+      this.getJSON<GetSimilarSongsResponse>(
+        credentials,
+        "/rest/getSimilarSongs2",
+        //todo: remove this hard coded 50?
+        { id, count: 50 }
+      )
+      .then((it) => 
+        (it.similarSongs2.song || []).map(it => asTrackSummary(it, this.customPlayers))
+      );
+
+    getTopSongs = (credentials: Credentials, artist: string) =>
+      this.getJSON<GetTopSongsResponse>(
+        credentials,
+        "/rest/getTopSongs",
+        //todo: remove this hard coded 50?
+        { artist, count: 50 }
+      )
+      .then((it) => 
+        (it.topSongs.song || []).map(it => asTrackSummary(it, this.customPlayers))
+      );
+
+  getInternetRadioStations = (credentials: Credentials) =>
+    this.getJSON<GetInternetRadioStationsResponse>(
+      credentials,
+      "/rest/getInternetRadioStations"
+    )
+    .then((it) => it.internetRadioStations.internetRadioStation || [])
+    .then((stations) =>
+      stations.map((it) => ({
+        id: it.id,
+        name: it.name,
+        url: it.streamUrl,
+        homePage: it.homePageUrl,
+      }))
+    ); 
+};

src/subsonic_music_library.ts

@@ -0,0 +1,320 @@
+import { taskEither as TE } from "fp-ts";
+import { pipe } from "fp-ts/lib/function";
+import {
+  Credentials,
+  MusicService,
+  ArtistSummary,
+  Result,
+  slice2,
+  AlbumQuery,
+  ArtistQuery,
+  MusicLibrary,
+  Album,
+  AlbumSummary,
+  Rating,
+  Artist,
+  AuthFailure,
+  AuthSuccess,
+} from "./music_library";
+import {
+  Subsonic,
+  CustomPlayers,
+  NO_CUSTOM_PLAYERS,
+  asToken,
+  parseToken,
+  artistImageURN,
+  asYear,
+  isValidImage
+} from "./subsonic";
+import _ from "underscore";
+
+import axios from "axios";
+import logger from "./logger";
+import { assertSystem, BUrn } from "./burn";
+
+export class SubsonicMusicService implements MusicService {
+  subsonic: Subsonic;
+  customPlayers: CustomPlayers;
+
+  constructor(
+    subsonic: Subsonic,
+    customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS
+  ) {
+    this.subsonic = subsonic;
+    this.customPlayers = customPlayers;
+  }
+
+  generateToken = (
+    credentials: Credentials
+  ): TE.TaskEither<AuthFailure, AuthSuccess> => 
+    pipe(
+      this.subsonic.ping(credentials),
+      TE.flatMap(({ type }) => TE.tryCatch(
+        () => this.libraryFor({ ...credentials, type }).then(library => ({ type, library })),
+        () => new AuthFailure("Failed to get library")
+      )),
+      TE.flatMap(({ library, type }) => pipe(
+        library.bearerToken(credentials),
+        TE.map(bearer => ({ bearer, type }))
+      )),
+      TE.map(({ bearer, type}) => ({
+        serviceToken: asToken({ ...credentials, bearer, type }),
+        userId: credentials.username,
+        nickname: credentials.username,
+      }))
+    );
+
+  refreshToken = (serviceToken: string) =>
+    this.generateToken(parseToken(serviceToken));
+
+  login = async (token: string) => this.libraryFor(parseToken(token));
+
+  private libraryFor = (
+    credentials: Credentials & { type: string }
+  ): Promise<SubsonicMusicLibrary> => {
+    const genericSubsonic = new SubsonicMusicLibrary(
+      this.subsonic,
+      credentials,
+      this.customPlayers
+    );
+    // return Promise.resolve(genericSubsonic);
+
+    if (credentials.type == "navidrome") {
+      // todo: there does not seem to be a test for this??
+      const nd: SubsonicMusicLibrary = {
+        ...genericSubsonic,
+        flavour: () => "navidrome",
+        bearerToken: (credentials: Credentials) =>
+          pipe(
+            TE.tryCatch(
+              () =>
+                axios.post(
+                  this.subsonic.url.append({ pathname: "/auth/login" }).href(),
+                  _.pick(credentials, "username", "password")
+                ),
+              () => new AuthFailure("Failed to get bearerToken")
+            ),
+            TE.map((it) => it.data.token as string | undefined)
+          ),
+      };
+      return Promise.resolve(nd);
+    } else {
+      return Promise.resolve(genericSubsonic);
+    }
+  };
+}
+
+export class SubsonicMusicLibrary implements MusicLibrary {
+  subsonic: Subsonic;
+  credentials: Credentials;
+  customPlayers: CustomPlayers;
+
+  constructor(
+    subsonic: Subsonic,
+    credentials: Credentials,
+    customPlayers: CustomPlayers
+  ) {
+    this.subsonic = subsonic;
+    this.credentials = credentials;
+    this.customPlayers = customPlayers;
+  }
+
+  flavour = () => "subsonic";
+
+  bearerToken = (_: Credentials) =>
+    TE.right<AuthFailure, string | undefined>(undefined);
+
+  // todo: q needs to support greater than the max page size supported by subsonic
+  // maybe subsonic should error?
+  artists = (q: ArtistQuery): Promise<Result<ArtistSummary>> =>
+    this.subsonic
+      .getArtists(this.credentials)
+      .then(slice2(q))
+      .then(([page, total]) => ({
+        total,
+        results: page,
+      }));
+
+  artist = async (id: string): Promise<Artist> =>
+    Promise.all([
+      this.subsonic.getArtist(this.credentials, id),
+      this.subsonic.getArtistInfo(this.credentials, id),
+    ]).then(([artist, artistInfo]) => ({
+      id: artist.id,
+      name: artist.name,
+      image: artistImageURN({
+        artistId: artist.id,
+        artistImageURL: [
+          artist.artistImageUrl,
+          // todo: subsonic.artistInfo should just return a valid image or undefined, then the music lib just chooses first undefined
+          // out of artist.image and artistInfo.image
+          artistInfo.images.l,
+          artistInfo.images.m,
+          artistInfo.images.s,
+          // todo: do we still need this isValidImage?
+        ].find(isValidImage),
+      }),
+      albums: artist.albums,
+      similarArtists: artistInfo.similarArtist,
+    }));
+
+  albums = async (q: AlbumQuery): Promise<Result<AlbumSummary>> =>
+    this.subsonic.getAlbumList2(this.credentials, q);
+
+  album = (id: string): Promise<Album> =>
+    this.subsonic.getAlbum(this.credentials, id);
+
+  genres = () => 
+    this.subsonic.getGenres(this.credentials);
+
+  track = (trackId: string) =>
+    this.subsonic.getTrack(this.credentials, trackId);
+
+  rate = (trackId: string, rating: Rating) => 
+    // todo: this is a bit odd
+    Promise.resolve(true)
+      .then(() => {
+        if (rating.stars >= 0 && rating.stars <= 5) {
+          return this.subsonic.getTrack(this.credentials, trackId);
+        } else {
+          throw `Invalid rating.stars value of ${rating.stars}`;
+        }
+      })
+      .then((track) => {
+        const thingsToUpdate = [];
+        if (track.rating.love != rating.love) {
+          thingsToUpdate.push(
+            (rating.love ? this.subsonic.star : this.subsonic.unstar)(this.credentials,{ id: trackId })
+          );
+        }
+        if (track.rating.stars != rating.stars) {
+          thingsToUpdate.push(
+            this.subsonic.setRating(this.credentials, trackId, rating.stars)
+          );
+        }
+        return Promise.all(thingsToUpdate);
+      })
+      .then(() => true)
+      .catch(() => false);
+
+  stream = async ({
+    trackId,
+    range,
+  }: {
+    trackId: string;
+    range: string | undefined;
+  }) =>
+    this.subsonic
+      .getTrack(this.credentials, trackId)
+      .then((track) =>
+        this.subsonic.stream(this.credentials, trackId, track.encoding.player, range)
+      );
+
+  coverArt = async (coverArtURN: BUrn, size?: number) =>
+    Promise.resolve(coverArtURN)
+      .then((it) => assertSystem(it, "subsonic"))
+      .then((it) =>
+        this.subsonic.getCoverArt(
+          this.credentials,
+          it.resource.split(":")[1]!,
+          size
+        )
+      )
+      .then((res) => ({
+        contentType: res.headers["content-type"],
+        data: Buffer.from(res.data, "binary"),
+      }))
+      .catch((e) => {
+        logger.error(`Failed getting coverArt for urn:'${coverArtURN}': ${e}`);
+        return undefined;
+      });
+
+  // todo: unit test the difference between scrobble and nowPlaying
+  scrobble = async (id: string) =>
+    this.subsonic.scrobble(this.credentials, id, true);
+
+  nowPlaying = async (id: string) =>
+    this.subsonic.scrobble(this.credentials, id, false);
+
+  searchArtists = async (query: string) =>
+    this.subsonic
+      .search3(this.credentials, { query, artistCount: 20 })
+      .then(({ artists }) =>
+        artists.map((artist) => ({
+          id: artist.id,
+          name: artist.name,
+          image: artistImageURN({
+            artistId: artist.id,
+            artistImageURL: artist.artistImageUrl,
+          }),
+        }))
+      );
+
+  searchAlbums = async (query: string) =>
+    this.subsonic
+      .search3(this.credentials, { query, albumCount: 20 })
+      .then(({ albums }) => this.subsonic.toAlbumSummary(albums));
+
+  searchTracks = async (query: string) =>
+    this.subsonic
+      .search3(this.credentials, { query, songCount: 20 })
+      .then(({ songs }) =>
+        Promise.all(
+          songs.map((it) => this.subsonic.getTrack(this.credentials, it.id))
+        )
+      );
+
+  playlists = async () =>
+    this.subsonic.playlists(this.credentials);
+
+  playlist = async (id: string) =>
+    this.subsonic.playlist(this.credentials, id);
+
+  createPlaylist = async (name: string) =>
+    this.subsonic.createPlayList(this.credentials, name);
+
+  deletePlaylist = async (id: string) =>
+    this.subsonic.deletePlayList(this.credentials, id);
+
+  addToPlaylist = async (playlistId: string, trackId: string) =>
+    this.subsonic.updatePlaylist(this.credentials, playlistId, { songIdToAdd: trackId });
+
+  removeFromPlaylist = async (playlistId: string, indicies: number[]) =>
+    this.subsonic.updatePlaylist(this.credentials, playlistId, { songIndexToRemove: indicies });
+
+  similarSongs = async (id: string) => 
+    this.subsonic.getSimilarSongs2(this.credentials, id)
+
+  topSongs = async (artistId: string) =>
+    this.subsonic.getArtist(this.credentials, artistId)
+      .then(({ name }) =>
+        this.subsonic.getTopSongs(this.credentials, name)
+      );
+
+  radioStations = async () =>
+    this.subsonic.getInternetRadioStations(this.credentials);
+
+  radioStation = async (id: string) =>
+    this.radioStations().then((it) => it.find((station) => station.id === id)!);
+
+  years = async () => {
+    const q: AlbumQuery = {
+      _index: 0,
+      _count: 100000, // FIXME: better than this, probably doesnt work anyway as max _count is 500 or something
+      type: "alphabeticalByArtist",
+    };
+    const years = this.subsonic
+      .getAlbumList2(this.credentials, q)
+      .then(({ results }) =>
+        results
+          .map((album) => album.year || "?")
+          .filter((item, i, ar) => ar.indexOf(item) === i)
+          .sort()
+          .map((year) => ({
+            ...asYear(year),
+          }))
+          .reverse()
+      );
+    return years;
+  };
+}

src/utils.ts

@@ -1,7 +1,34 @@
+import { DOMParser, XMLSerializer, Node } from '@xmldom/xmldom';
+
 export function takeWithRepeats<T>(things:T[], count: number) {
   const result = [];
   for(let i = 0; i < count; i++) {
     result.push(things[i % things.length])
   }
   return result;
-}
+}
+
+function xmlRemoveWhitespaceNodes(node: Node) {
+  let child = node.firstChild;
+  while (child) {
+      const nextSibling = child.nextSibling;
+      if (child.nodeType === 3 && !child.nodeValue?.trim()) {
+          // Remove empty text nodes
+          node.removeChild(child);
+      } else {
+          // Recursively process child nodes
+          xmlRemoveWhitespaceNodes(child);
+      }
+      child = nextSibling;
+  }
+}
+
+export function xmlTidy(xml: string | Node) {
+  const xmlToString = new XMLSerializer().serializeToString
+
+  const xmlString = xml instanceof Node ? xmlToString(xml as any) : xml
+  const doc = new DOMParser().parseFromString(xmlString, 'text/xml') as unknown as Node;
+  xmlRemoveWhitespaceNodes(doc);
+  return xmlToString(doc as any);
+}
+

tests/access_tokens.test.ts

@@ -1,273 +0,0 @@
-import { v4 as uuid } from "uuid";
-import dayjs from "dayjs";
-
-import {
-  AccessTokenPerAuthToken,
-  EncryptedAccessTokens,
-  ExpiringAccessTokens,
-  InMemoryAccessTokens,
-  sha256
-} from "../src/access_tokens";
-import { Encryption } from "../src/encryption";
-
-describe("ExpiringAccessTokens", () => {
-  let now = dayjs();
-
-  const accessTokens = new ExpiringAccessTokens({ now: () => now });
-
-  describe("tokens", () => {
-    it("they should be unique", () => {
-      const authToken = uuid();
-      expect(accessTokens.mint(authToken)).not.toEqual(
-        accessTokens.mint(authToken)
-      );
-    });
-  });
-
-  describe("tokens that dont exist", () => {
-    it("should return undefined", () => {
-      expect(accessTokens.authTokenFor("doesnt exist")).toBeUndefined();
-    });
-  });
-
-  describe("tokens that have not expired", () => {
-    it("should be able to return them", () => {
-      const authToken = uuid();
-
-      const accessToken = accessTokens.mint(authToken);
-
-      expect(accessTokens.authTokenFor(accessToken)).toEqual(authToken);
-    });
-
-    it("should be able to have many per authToken", () => {
-      const authToken = uuid();
-
-      const accessToken1 = accessTokens.mint(authToken);
-      const accessToken2 = accessTokens.mint(authToken);
-
-      expect(accessTokens.authTokenFor(accessToken1)).toEqual(authToken);
-      expect(accessTokens.authTokenFor(accessToken2)).toEqual(authToken);
-    });
-  });
-
-  describe("tokens that have expired", () => {
-    describe("retrieving it", () => {
-      it("should return undefined", () => {
-        const authToken = uuid();
-
-        now = dayjs();
-        const accessToken = accessTokens.mint(authToken);
-
-        now = now.add(12, "hours").add(1, "second");
-
-        expect(accessTokens.authTokenFor(accessToken)).toBeUndefined();
-      });
-    });
-
-    describe("should be cleared out", () => {
-      const authToken1 = uuid();
-      const authToken2 = uuid();
-
-      now = dayjs();
-
-      const accessToken1_1 = accessTokens.mint(authToken1);
-      const accessToken2_1 = accessTokens.mint(authToken2);
-
-      expect(accessTokens.count()).toEqual(2);
-      expect(accessTokens.authTokenFor(accessToken1_1)).toEqual(authToken1);
-      expect(accessTokens.authTokenFor(accessToken2_1)).toEqual(authToken2);
-
-      now = now.add(12, "hours").add(1, "second");
-
-      const accessToken1_2 = accessTokens.mint(authToken1);
-
-      expect(accessTokens.count()).toEqual(1);
-      expect(accessTokens.authTokenFor(accessToken1_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken2_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken1_2)).toEqual(authToken1);
-
-      now = now.add(6, "hours");
-
-      const accessToken2_2 = accessTokens.mint(authToken2);
-
-      expect(accessTokens.count()).toEqual(2);
-      expect(accessTokens.authTokenFor(accessToken1_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken2_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken1_2)).toEqual(authToken1);
-      expect(accessTokens.authTokenFor(accessToken2_2)).toEqual(authToken2);
-
-      now = now.add(6, "hours").add(1, "minute");
-
-      expect(accessTokens.authTokenFor(accessToken1_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken2_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken1_2)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken2_2)).toEqual(authToken2);
-      expect(accessTokens.count()).toEqual(1);
-
-      now = now.add(6, "hours").add(1, "minute");
-
-      expect(accessTokens.authTokenFor(accessToken1_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken2_1)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken1_2)).toBeUndefined();
-      expect(accessTokens.authTokenFor(accessToken2_2)).toBeUndefined();
-      expect(accessTokens.count()).toEqual(0);
-    });
-  });
-});
-
-describe("EncryptedAccessTokens", () => {
-  const encryption = {
-    encrypt: jest.fn(),
-    decrypt: jest.fn(),
-  };
-
-  const accessTokens = new EncryptedAccessTokens(
-    (encryption as unknown) as Encryption
-  );
-
-  beforeEach(() => {
-    jest.clearAllMocks();
-    jest.resetAllMocks();
-  });
-
-  describe("encrypt and decrypt", () => {
-    it("should be able to round trip the token", () => {
-      const authToken = `the token - ${uuid()}`;
-      const hash = {
-        encryptedData: "the encrypted token",
-        iv: "vi",
-      };
-
-      encryption.encrypt.mockReturnValue(hash);
-      encryption.decrypt.mockReturnValue(authToken);
-
-      const accessToken = accessTokens.mint(authToken);
-
-      expect(accessToken).not.toContain(authToken);
-      expect(accessToken).toEqual(
-        Buffer.from(JSON.stringify(hash)).toString("base64")
-      );
-
-      expect(accessTokens.authTokenFor(accessToken)).toEqual(authToken);
-
-      expect(encryption.encrypt).toHaveBeenCalledWith(authToken);
-      expect(encryption.decrypt).toHaveBeenCalledWith(hash);
-    });
-  });
-
-  describe("when the token is a valid Hash but doesnt decrypt", () => {
-    it("should return undefined", () => {
-      const hash = {
-        encryptedData: "valid hash",
-        iv: "vi",
-      };
-      encryption.decrypt.mockImplementation(() => {
-        throw "Boooooom decryption failed!!!";
-      });
-      expect(
-        accessTokens.authTokenFor(
-          Buffer.from(JSON.stringify(hash)).toString("base64")
-        )
-      ).toBeUndefined();
-    });
-  });
-
-  describe("when the token is not even a valid hash", () => {
-    it("should return undefined", () => {
-      encryption.decrypt.mockImplementation(() => {
-        throw "Boooooom decryption failed!!!";
-      });
-      expect(accessTokens.authTokenFor("some rubbish")).toBeUndefined();
-    });
-  });
-});
-
-describe("AccessTokenPerAuthToken", () => {
-  const accessTokens = new AccessTokenPerAuthToken();
-
-  it("should return the same access token for the same auth token", () => {
-    const authToken = "token1";
-    
-    const accessToken1 = accessTokens.mint(authToken);
-    const accessToken2 = accessTokens.mint(authToken);
-
-    expect(accessToken1).not.toEqual(authToken);
-    expect(accessToken1).toEqual(accessToken2);
-  });
-
-  describe("when there is an auth token for the access token", () => {
-    it("should be able to retrieve it", () => {
-      const authToken = uuid();
-      const accessToken = accessTokens.mint(authToken);
-
-      expect(accessTokens.authTokenFor(accessToken)).toEqual(authToken);
-    });
-  });
-
-  describe("when there is no auth token for the access token", () => {
-    it("should return undefined", () => {
-      expect(accessTokens.authTokenFor(uuid())).toBeUndefined();
-    });
-  });
-});
-
-describe('sha256 minter', () => {
-  it('should return the same value for the same salt and authToken', () => {
-    const authToken = uuid();
-    const token1 = sha256("salty")(authToken);
-    const token2 = sha256("salty")(authToken);
-
-    expect(token1).not.toEqual(authToken);
-    expect(token1).toEqual(token2);
-  });
-
-  it('should returrn different values for the same salt but different authTokens', () => {
-    const authToken1 = uuid();
-    const authToken2 = uuid();
-
-    const token1 = sha256("salty")(authToken1);
-    const token2= sha256("salty")(authToken2);
-
-    expect(token1).not.toEqual(token2);
-  });
-
-  it('should return different values for the same authToken but different salts', () => {
-    const authToken = uuid();
-
-    const token1 = sha256("salt1")(authToken);
-    const token2= sha256("salt2")(authToken);
-
-    expect(token1).not.toEqual(token2);
-  });
-});
-
-describe("InMemoryAccessTokens", () => {
-  const reverseAuthToken = (authToken: string) => authToken.split("").reverse().join("");
-
-  const accessTokens = new InMemoryAccessTokens(reverseAuthToken);
-
-  it("should return the same access token for the same auth token", () => {
-    const authToken = "token1";
-    
-    const accessToken1 = accessTokens.mint(authToken);
-    const accessToken2 = accessTokens.mint(authToken);
-
-    expect(accessToken1).not.toEqual(authToken);
-    expect(accessToken1).toEqual(accessToken2);
-  });
-
-  describe("when there is an auth token for the access token", () => {
-    it("should be able to retrieve it", () => {
-      const authToken = uuid();
-      const accessToken = accessTokens.mint(authToken);
-
-      expect(accessTokens.authTokenFor(accessToken)).toEqual(authToken);
-    });
-  });
-
-  describe("when there is no auth token for the access token", () => {
-    it("should return undefined", () => {
-      expect(accessTokens.authTokenFor(uuid())).toBeUndefined();
-    });
-  });
-});

tests/api_tokens.test.ts

@@ -0,0 +1,67 @@
+import { v4 as uuid } from "uuid";
+
+import {
+  InMemoryAPITokens,
+  sha256
+} from "../src/api_tokens";
+
+describe('sha256 minter', () => {
+  it('should return the same value for the same salt and authToken', () => {
+    const authToken = uuid();
+    const token1 = sha256("salty")(authToken);
+    const token2 = sha256("salty")(authToken);
+
+    expect(token1).not.toEqual(authToken);
+    expect(token1).toEqual(token2);
+  });
+
+  it('should returrn different values for the same salt but different authTokens', () => {
+    const authToken1 = uuid();
+    const authToken2 = uuid();
+
+    const token1 = sha256("salty")(authToken1);
+    const token2= sha256("salty")(authToken2);
+
+    expect(token1).not.toEqual(token2);
+  });
+
+  it('should return different values for the same authToken but different salts', () => {
+    const authToken = uuid();
+
+    const token1 = sha256("salt1")(authToken);
+    const token2= sha256("salt2")(authToken);
+
+    expect(token1).not.toEqual(token2);
+  });
+});
+
+describe("InMemoryAPITokens", () => {
+  const reverseAuthToken = (authToken: string) => authToken.split("").reverse().join("");
+
+  const accessTokens = new InMemoryAPITokens(reverseAuthToken);
+
+  it("should return the same access token for the same auth token", () => {
+    const authToken = "token1";
+    
+    const accessToken1 = accessTokens.mint(authToken);
+    const accessToken2 = accessTokens.mint(authToken);
+
+    expect(accessToken1).not.toEqual(authToken);
+    expect(accessToken1).toEqual(accessToken2);
+  });
+
+  describe("when there is an auth token for the access token", () => {
+    it("should be able to retrieve it", () => {
+      const authToken = uuid();
+      const accessToken = accessTokens.mint(authToken);
+
+      expect(accessTokens.authTokenFor(accessToken)).toEqual(authToken);
+    });
+  });
+
+  describe("when there is no auth token for the access token", () => {
+    it("should return undefined", () => {
+      expect(accessTokens.authTokenFor(uuid())).toBeUndefined();
+    });
+  });
+});

tests/b64.test.ts

@@ -0,0 +1,17 @@
+import { b64Encode, b64Decode } from "../src/b64";
+
+describe("b64", () => {
+    const value = "foobar100";
+    const encoded = Buffer.from(value).toString("base64");
+
+    describe("encode", () => {
+        it("should encode", () => {
+            expect(b64Encode(value)).toEqual(encoded);
+        });
+    });
+    describe("decode", () => {
+        it("should decode", () => {
+            expect(b64Decode(encoded)).toEqual(value);
+        });
+    });
+});

tests/builders.ts

@@ -1,10 +1,24 @@
 import { SonosDevice } from "@svrooij/sonos/lib";
 import { v4 as uuid } from "uuid";
-import { Credentials } from "../src/smapi";
+import randomstring from "randomstring";
 
+import { Credentials } from "../src/smapi";
 import { Service, Device } from "../src/sonos";
-import { Album, Artist, Track, albumToAlbumSummary, artistToArtistSummary, PlaylistSummary, Playlist } from "../src/music_service";
+import {
-import randomString from "../src/random_string";
+  Album,
+  Artist,
+  Track,
+  PlaylistSummary,
+  Playlist,
+  SimilarArtist,
+  AlbumSummary,
+  RadioStation,
+  ArtistSummary,
+  TrackSummary
+} from "../src/music_library";
+
+import { b64Encode } from "../src/b64";
+import { artistImageURN } from "../src/subsonic";
 
 const randomInt = (max: number) => Math.floor(Math.random() * Math.floor(max));
 const randomIpAddress = () => `127.0.${randomInt(255)}.${randomInt(255)}`;
@@ -28,22 +42,24 @@ export const aService = (fields: Partial<Service> = {}): Service => ({
   ...fields,
 });
 
-export function aPlaylistSummary(fields: Partial<PlaylistSummary> = {}): PlaylistSummary {
+export function aPlaylistSummary(
+  fields: Partial<PlaylistSummary> = {}
+): PlaylistSummary {
   return {
     id: `playlist-${uuid()}`,
-    name: `playlistname-${randomString()}`,
+    name: `playlistname-${randomstring.generate()}`,
-    ...fields
+    ...fields,
-  }
+  };
 }
 
 export function aPlaylist(fields: Partial<Playlist> = {}): Playlist {
   return {
     id: `playlist-${uuid()}`,
-    name: `playlist-${randomString()}`,
+    name: `playlist-${randomstring.generate()}`,
     entries: [aTrack(), aTrack()],
-    ...fields
+    ...fields,
-  }
+  };
-} 
+}
 
 export function aDevice(fields: Partial<Device> = {}): Device {
   return {
@@ -75,10 +91,11 @@ export function getAppLinkMessage() {
   };
 }
 
-export function someCredentials(token: string): Credentials {
+export function someCredentials({ token, key } : { token: string, key: string }): Credentials {
   return {
     loginToken: {
       token,
+      key,
       householdId: "hh1",
     },
     deviceId: "d1",
@@ -86,73 +103,155 @@ export function someCredentials(token: string): Credentials {
   };
 }
 
-export function anArtist(fields: Partial<Artist> = {}): Artist {
+export function aSimilarArtist(
-  const id = uuid();
+  fields: Partial<SimilarArtist> = {}
-  const artist = {
+): SimilarArtist {
+  const id = fields.id || uuid();
+  return {
+    id,
+    name: `Similar Artist ${id}`,
+    image: artistImageURN({ artistId: id }),
+    inLibrary: true,
+    ...fields,
+  };
+}
+
+export function anArtistSummary(fields: Partial<ArtistSummary> = {}): ArtistSummary {
+  const id = fields.id || uuid();
+  return {
     id,
     name: `Artist ${id}`,
-    albums: [anAlbum(), anAlbum(), anAlbum()],
+    image: { system: "subsonic", resource: `art:${id}` },
-    image: {
+  }
-      small: `/artist/art/${id}/small`,
+}
-      medium: `/artist/art/${id}/small`,
+
-      large: `/artist/art/${id}/large`,
+export function anArtist(fields: Partial<Artist> = {}): Artist {
-    },
+  const id = fields.id || uuid();
+  const name = `Artist ${randomstring.generate()}`
+  const albums = fields.albums || [
+    anAlbumSummary({ artistId: id, artistName: name }), 
+    anAlbumSummary({ artistId: id, artistName: name }), 
+    anAlbumSummary({ artistId: id, artistName: name })
+  ];
+  const artist = {
+    ...anArtistSummary({ id, name }),
+    albums,
     similarArtists: [
-      { id: uuid(), name: "Similar artist1", inLibrary: true },
+      aSimilarArtist({ id: uuid(), name: "Similar artist1", inLibrary: true }),
-      { id: uuid(), name: "Similar artist2", inLibrary: true },
+      aSimilarArtist({ id: uuid(), name: "Similar artist2", inLibrary: true }),
-      { id: "-1", name: "Artist not in library", inLibrary: false },
+      aSimilarArtist({
+        id: "-1",
+        name: "Artist not in library",
+        inLibrary: false,
+      }),
     ],
     ...fields,
   };
-  artist.albums.forEach(album => {
+  artist.albums.forEach((album) => {
     album.artistId = artist.id;
     album.artistName = artist.name;
-  })
+  });
   return artist;
 }
 
-export const HIP_HOP = { id: "genre_hip_hop", name: "Hip-Hop" };
+export const aGenre = (name: string) => ({ id: b64Encode(name), name });
-export const METAL = { id: "genre_metal", name: "Metal" };
-export const NEW_WAVE = { id: "genre_new_wave", name: "New Wave" };
-export const POP = { id: "genre_pop", name: "Pop" };
-export const POP_ROCK = { id: "genre_pop_rock", name: "Pop Rock" };
-export const REGGAE = { id: "genre_reggae", name: "Reggae" };
-export const ROCK = { id: "genre_rock", name: "Rock" };
-export const SKA = { id: "genre_ska", name: "Ska" };
-export const PUNK = { id: "genre_punk", name: "Punk" };
-export const TRIP_HOP = { id: "genre_trip_hop", name: "Trip Hop" };
 
-export const SAMPLE_GENRES = [HIP_HOP, METAL, NEW_WAVE, POP, POP_ROCK, REGGAE, ROCK, SKA];
+export const HIP_HOP = aGenre("Hip-Hop");
+export const METAL = aGenre("Metal");
+export const NEW_WAVE = aGenre("New Wave");
+export const POP = aGenre("Pop");
+export const POP_ROCK = aGenre("Pop Rock");
+export const REGGAE = aGenre("Reggae");
+export const ROCK = aGenre("Rock");
+export const SKA = aGenre("Ska");
+export const PUNK = aGenre("Punk");
+export const TRIP_HOP = aGenre("Trip Hop");
+
+export const SAMPLE_GENRES = [
+  HIP_HOP,
+  METAL,
+  NEW_WAVE,
+  POP,
+  POP_ROCK,
+  REGGAE,
+  ROCK,
+  SKA,
+];
 export const randomGenre = () => SAMPLE_GENRES[randomInt(SAMPLE_GENRES.length)];
 
-export function aTrack(fields: Partial<Track> = {}): Track {
+export function aTrackSummary(fields: Partial<TrackSummary> = {}): TrackSummary {
   const id = uuid();
-  const artist = anArtist();
+  const artist = fields.artist || anArtistSummary();
   const genre = fields.genre || randomGenre();
+  const rating = { love: false, stars: Math.floor(Math.random() * 5) };
   return {
     id,
     name: `Track ${id}`,
-    mimeType: `audio/mp3-${id}`,
+    encoding: {
+      player: "bonob",
+      mimeType: `audio/mp3-${id}`
+    },
     duration: randomInt(500),
     number: randomInt(100),
     genre,
-    artist: artistToArtistSummary(artist),
+    artist,
-    album: albumToAlbumSummary(anAlbum({ artistId: artist.id, artistName: artist.name, genre })),
+    coverArt: { system: "subsonic", resource: `art:${uuid()}`},
+    rating,
     ...fields,
   };
-}
+};
 
-export function anAlbum(fields: Partial<Album> = {}): Album {
+export function aTrack(fields: Partial<Track> = {}): Track {
+  const summary = aTrackSummary(fields);
+  const album = fields.album || anAlbumSummary({ artistId: summary.artist.id, artistName: summary.artist.name, genre: summary.genre })
+  return {
+    ...summary,
+    album,
+    ...fields
+  };
+};
+
+export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary {
   const id = uuid();
   return {
     id,
     name: `Album ${id}`,
-    genre: randomGenre(),
     year: `19${randomInt(99)}`,
+    genre: randomGenre(),
+    coverArt: { system: "subsonic", resource: `art:${uuid()}` },
     artistId: `Artist ${uuid()}`,
-    artistName: `Artist ${randomString()}`,
+    artistName: `Artist ${randomstring.generate()}`,
+    ...fields
+  };
+};
+
+export function anAlbum(fields: Partial<Album> = {}): Album {
+  const albumSummary = anAlbumSummary()
+  const album = {
+    ...albumSummary,
+    tracks: [],
     ...fields,
   };
+  const artistSummary = anArtistSummary({ id: album.artistId, name: album.artistName })
+  const tracks = fields.tracks || [ 
+    aTrack({ album: albumSummary, artist: artistSummary }),
+    aTrack({ album: albumSummary, artist: artistSummary }) 
+  ]
+  return {
+    ...album,
+    tracks
+  };
+};
+
+export function aRadioStation(fields: Partial<RadioStation> = {}): RadioStation {
+  const id = uuid()
+  const name = `Station-${id}`;
+  return {
+    id,
+    name,
+    url: `http://example.com/${name}`,
+    ...fields
+  }
 }
 
 export const BLONDIE_ID = uuid();
@@ -167,7 +266,8 @@ export const BLONDIE: Artist = {
       year: "1976",
       genre: NEW_WAVE,
       artistId: BLONDIE_ID,
-      artistName: BLONDIE_NAME
+      artistName: BLONDIE_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
     {
       id: uuid(),
@@ -175,14 +275,11 @@ export const BLONDIE: Artist = {
       year: "1978",
       genre: POP_ROCK,
       artistId: BLONDIE_ID,
-      artistName: BLONDIE_NAME
+      artistName: BLONDIE_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
   ],
-  image: {
+  image: { system: "external", resource: "http://localhost:1234/images/blondie.jpg" },
-    small: undefined,
-    medium: undefined,
-    large: undefined,
-  },
   similarArtists: [],
 };
 
@@ -192,15 +289,35 @@ export const BOB_MARLEY: Artist = {
   id: BOB_MARLEY_ID,
   name: BOB_MARLEY_NAME,
   albums: [
-    { id: uuid(), name: "Burin'", year: "1973", genre: REGGAE, artistId: BOB_MARLEY_ID, artistName: BOB_MARLEY_NAME },
+    {
-    { id: uuid(), name: "Exodus", year: "1977", genre: REGGAE, artistId: BOB_MARLEY_ID, artistName: BOB_MARLEY_NAME },
+      id: uuid(),
-    { id: uuid(), name: "Kaya", year: "1978", genre: SKA, artistId: BOB_MARLEY_ID, artistName: BOB_MARLEY_NAME },
+      name: "Burin'",
+      year: "1973",
+      genre: REGGAE,
+      artistId: BOB_MARLEY_ID,
+      artistName: BOB_MARLEY_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
+    },
+    {
+      id: uuid(),
+      name: "Exodus",
+      year: "1977",
+      genre: REGGAE,
+      artistId: BOB_MARLEY_ID,
+      artistName: BOB_MARLEY_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
+    },
+    {
+      id: uuid(),
+      name: "Kaya",
+      year: "1978",
+      genre: SKA,
+      artistId: BOB_MARLEY_ID,
+      artistName: BOB_MARLEY_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
+    },
   ],
-  image: {
+  image: { system: "subsonic", resource: BOB_MARLEY_ID },
-    small: "http://localhost/BOB_MARLEY/sml",
-    medium: "http://localhost/BOB_MARLEY/med",
-    large: "http://localhost/BOB_MARLEY/lge",
-  },
   similarArtists: [],
 };
 
@@ -211,9 +328,8 @@ export const MADONNA: Artist = {
   name: MADONNA_NAME,
   albums: [],
   image: {
-    small: "http://localhost/MADONNA/sml",
+    system: "external",
-    medium: undefined,
+    resource: "http://localhost:1234/images/madonna.jpg",
-    large: "http://localhost/MADONNA/lge",
   },
   similarArtists: [],
 };
@@ -231,6 +347,7 @@ export const METALLICA: Artist = {
       genre: METAL,
       artistId: METALLICA_ID,
       artistName: METALLICA_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
     {
       id: uuid(),
@@ -239,13 +356,10 @@ export const METALLICA: Artist = {
       genre: METAL,
       artistId: METALLICA_ID,
       artistName: METALLICA_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
   ],
-  image: {
+  image: { system: "subsonic", resource: METALLICA_ID },
-    small: "http://localhost/METALLICA/sml",
-    medium: "http://localhost/METALLICA/med",
-    large: "http://localhost/METALLICA/lge",
-  },
   similarArtists: [],
 };
 

tests/burn.test.ts

@@ -0,0 +1,114 @@
+import { assertSystem, BUrn, format, formatForURL, parse } from "../src/burn";
+
+type BUrnSpec = {
+  burn: BUrn;
+  asString: string;
+  shorthand: string;
+};
+
+describe("BUrn", () => {
+  describe("format", () => {
+    (
+      [
+        {
+          burn: { system: "internal", resource: "icon:error" },
+          asString: "bnb:internal:icon:error",
+          shorthand: "bnb:i:icon:error",
+        },
+        {
+          burn: {
+            system: "external",
+            resource: "http://example.com/widget.jpg",
+          },
+          asString: "bnb:external:http://example.com/widget.jpg",
+          shorthand: "bnb:e:http://example.com/widget.jpg",
+        },
+        {
+          burn: { system: "subsonic", resource: "art:1234" },
+          asString: "bnb:subsonic:art:1234",
+          shorthand: "bnb:s:art:1234",
+        },
+        {
+          burn: { system: "navidrome", resource: "art:1234" },
+          asString: "bnb:navidrome:art:1234",
+          shorthand: "bnb:n:art:1234",
+        },
+      ] as BUrnSpec[]
+    ).forEach(({ burn, asString, shorthand }) => {
+      describe(asString, () => {
+        it("can be formatted as string and then roundtripped back into BUrn", () => {
+          const stringValue = format(burn);
+          expect(stringValue).toEqual(asString);
+          expect(parse(stringValue)).toEqual(burn);
+        });
+
+        it("can be formatted as shorthand string and then roundtripped back into BUrn", () => {
+          const stringValue = format(burn, { shorthand: true });
+          expect(stringValue).toEqual(shorthand);
+          expect(parse(stringValue)).toEqual(burn);
+        });
+
+        describe(`encrypted ${asString}`, () => {
+          it("can be formatted as an encrypted string and then roundtripped back into BUrn", () => {
+            const stringValue = format(burn, { encrypt: true });
+            expect(stringValue.startsWith("bnb:encrypted:")).toBeTruthy();
+            expect(stringValue).not.toContain(burn.system);
+            expect(stringValue).not.toContain(burn.resource);
+            expect(parse(stringValue)).toEqual(burn);
+          });
+
+          it("can be formatted as an encrypted shorthand string and then roundtripped back into BUrn", () => {
+            const stringValue = format(burn, {
+              shorthand: true,
+              encrypt: true,
+            });
+            expect(stringValue.startsWith("bnb:x:")).toBeTruthy();
+            expect(stringValue).not.toContain(burn.system);
+            expect(stringValue).not.toContain(burn.resource);
+            expect(parse(stringValue)).toEqual(burn);
+          });
+        });
+      });
+    });
+  });
+
+  describe("formatForURL", () => {
+    describe("external", () => {
+      it("should be encrypted", () => {
+        const burn = {
+          system: "external",
+          resource: "http://example.com/foo.jpg",
+        };
+        const formatted = formatForURL(burn);
+        expect(formatted.startsWith("bnb:x:")).toBeTruthy();
+        expect(formatted).not.toContain("http://example.com/foo.jpg");
+
+        expect(parse(formatted)).toEqual(burn);
+      });
+    });
+
+    describe("not external", () => {
+      it("should be shorthand form", () => {
+        expect(formatForURL({ system: "internal", resource: "foo" })).toEqual(
+          "bnb:i:foo"
+        );
+        expect(
+          formatForURL({ system: "subsonic", resource: "foo:bar" })
+        ).toEqual("bnb:s:foo:bar");
+      });
+    });
+  });
+
+  describe("assertSystem", () => {
+    it("should fail if the system is not equal", () => {
+      const burn = { system: "external", resource: "something"};
+      expect(() => assertSystem(burn, "subsonic")).toThrow(`Unsupported urn: '${format(burn)}'`)
+    });
+
+    it("should pass if the system is equal", () => {
+      const burn = { system: "external", resource: "something"};
+      expect(assertSystem(burn, "external")).toEqual(burn);
+    });
+  });
+});
+

tests/clock.test.ts

@@ -1,58 +1,85 @@
-import dayjs from "dayjs";
+import { randomInt } from "crypto";
-import { isChristmas, isCNY, isHalloween, isHoli } from "../src/clock";
+import dayjs, { Dayjs } from "dayjs";
+import timezone from "dayjs/plugin/timezone";
+dayjs.extend(timezone);
 
-describe("isChristmas", () => {
+import { Clock, isChristmas, isCNY, isCNY_2022, isCNY_2023, isCNY_2024, isCNY_2025, isHalloween, isHoli, isMay4 } from "../src/clock";
-  ["2000/12/25", "2022/12/25", "2030/12/25"].forEach((date) => {
+
-    it(`should return true for ${date} regardless of year`, () => {
+
-      expect(isChristmas({ now: () => dayjs(date) })).toEqual(true);
+
+const randomDate = () => dayjs().subtract(randomInt(1, 1000), 'days');
+const randomDates = (count: number, exclude: string[]) => {
+  const result: Dayjs[] = [];
+  while(result.length < count) {
+    const next = randomDate();
+    if(!exclude.find(it => dayjs(it).isSame(next, 'date'))) {
+      result.push(next)
+    }
+  }
+  return result
+}
+
+function describeFixedDateMonthEvent(
+  name: string, 
+  dateMonth: string,
+  f: (clock: Clock) => boolean
+) {
+  const randomYear = randomInt(2020, 3000);
+  const date = dateMonth.split("/")[0];
+  const month = dateMonth.split("/")[1];
+
+  describe(name, () => {
+    it(`should return true for ${randomYear}-${month}-${date}T00:00:00 ragardless of year`, () => {
+      expect(f({ now: () => dayjs(`${randomYear}-${month}-${date}T00:00:00Z`) })).toEqual(true);
+    });
+  
+    it(`should return true for ${randomYear}-${month}-${date}T12:00:00 regardless of year`, () => {
+      expect(f({ now: () => dayjs(`${randomYear}-${month}-${date}T12:00:00Z`) })).toEqual(true);
+    });
+  
+    it(`should return true for ${randomYear}-${month}-${date}T23:59:00 regardless of year`, () => {
+      expect(f({ now: () => dayjs(`${randomYear}-${month}-${date}T23:59:00`) })).toEqual(true);
+    });
+  
+    ["2000/12/24", "2000/12/26", "2021/01/01"].forEach((date) => {
+      it(`should return false for ${date}`, () => {
+        expect(f({ now: () => dayjs(date) })).toEqual(false);
+      });
     });
   });
+}
 
-  ["2000/12/24", "2000/12/26", "2021/01/01"].forEach((date) => {
+function describeFixedDateEvent(
-    it(`should return false for ${date} regardless of year`, () => {
+  name: string,
-      expect(isChristmas({ now: () => dayjs(date) })).toEqual(false);
+  dates: string[],
+  f: (clock: Clock) => boolean
+) {
+  describe(name, () => {
+    dates.forEach((date) => {
+      it(`should return true for ${date}T00:00:00`, () => {
+        expect(f({ now: () => dayjs(`${date}T00:00:00`) })).toEqual(true);
+      });
+  
+      it(`should return true for ${date}T23:59:59`, () => {
+        expect(f({ now: () => dayjs(`${date}T23:59:59`) })).toEqual(true);
+      });
+    });
+    
+    randomDates(10, dates).forEach((date) => {
+      it(`should return false for ${date}`, () => {
+        expect(f({ now: () => dayjs(date) })).toEqual(false);
+      });
     });
   });
-});
+}
 
-describe("isHalloween", () => {
+describeFixedDateMonthEvent("christmas", "25/12", isChristmas);
-  ["2000/10/31", "2022/10/31", "2030/10/31"].forEach((date) => {
+describeFixedDateMonthEvent("halloween", "31/10", isHalloween);
-    it(`should return true for ${date} regardless of year`, () => {
+describeFixedDateMonthEvent("may4", "04/05", isMay4);
-      expect(isHalloween({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
 
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
+describeFixedDateEvent("holi", ["2022-03-18", "2023-03-07", "2024-03-25", "2025-03-14"], isHoli);
-    it(`should return false for ${date} regardless of year`, () => {
+describeFixedDateEvent("cny", ["2022-02-01", "2023-01-22", "2024-02-10", "2025-02-29"], isCNY);
-      expect(isHalloween({ now: () => dayjs(date) })).toEqual(false);
+describeFixedDateEvent("cny 2022", ["2022-02-01"], isCNY_2022);
-    });
+describeFixedDateEvent("cny 2023", ["2023/01/22"], isCNY_2023);
-  });
+describeFixedDateEvent("cny 2024", ["2024/02/10"], isCNY_2024);
-});
+describeFixedDateEvent("cny 2025", ["2025/02/29"], isCNY_2025);
-
-describe("isHoli", () => {
-  ["2022/03/18", "2023/03/07", "2024/03/25", "2025/03/14"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isHoli({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
-
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isHoli({ now: () => dayjs(date) })).toEqual(false);
-    });
-  });
-});
-
-describe("isCNY", () => {
-  ["2022/02/01", "2023/01/22", "2024/02/10", "2025/02/29"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isCNY({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
-
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isCNY({ now: () => dayjs(date) })).toEqual(false);
-    });
-  });
-});

tests/config.test.ts

@@ -1,5 +1,81 @@
 import { hostname } from "os";
-import config from "../src/config";
+import config, { COLOR, envVar } from "../src/config";
+
+describe("envVar", () => {
+  const OLD_ENV = process.env;
+
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = { ...OLD_ENV };
+
+    process.env["bnb-var"] = "bnb-var-value";
+    process.env["bnb-legacy2"] = "bnb-legacy2-value";
+    process.env["bnb-legacy3"] = "bnb-legacy3-value";
+  });
+
+  afterEach(() => {
+    process.env = OLD_ENV;
+  });
+
+  describe("when the env var exists", () => {
+    describe("and there are no legacy env vars that match", () => {
+      it("should return the env var", () => {
+        expect(envVar("bnb-var")).toEqual("bnb-var-value");
+      });
+    });
+
+    describe("and there are legacy env vars that match", () => {
+      it("should return the env var", () => {
+        expect(
+          envVar("bnb-var", {
+            default: "not valid",
+            legacy: ["bnb-legacy1", "bnb-legacy2", "bnb-legacy3"],
+          })
+        ).toEqual("bnb-var-value");
+      });
+    });
+  });
+
+  describe("when the env var doesnt exist", () => {
+    describe("and there are no legacy env vars specified", () => {
+      describe("and there is no default value specified", () => {
+        it("should be undefined", () => {
+          expect(envVar("bnb-not-set")).toBeUndefined();
+        });
+      });
+
+      describe("and there is a default value specified", () => {
+        it("should return the default", () => {
+          expect(envVar("bnb-not-set", { default: "widget" })).toEqual(
+            "widget"
+          );
+        });
+      });
+    });
+
+    describe("when there are legacy env vars specified", () => {
+      it("should return the value from the first matched legacy env var", () => {
+        expect(
+          envVar("bnb-not-set", {
+            legacy: ["bnb-legacy1", "bnb-legacy2", "bnb-legacy3"],
+          })
+        ).toEqual("bnb-legacy2-value");
+      });
+    });
+  });
+
+  describe("validationPattern", () => {
+    it("should fail when the value does not match the pattern", () => {
+      expect(() =>
+        envVar("bnb-var", {
+          validationPattern: /^foobar$/,
+        })
+      ).toThrowError(
+        `Invalid value specified for 'bnb-var', must match ${/^foobar$/}`
+      );
+    });
+  });
+});
 
 describe("config", () => {
   const OLD_ENV = process.env;
@@ -20,49 +96,38 @@ describe("config", () => {
     propertyGetter: (config: any) => any
   ) {
     describe(name, () => {
-      function expecting({
+      it.each([
-        value,
+        [expectedDefault, ""],
-        expected,
+        [expectedDefault, undefined],
-      }: {
+        [true, "true"],
-        value: string;
+        [false, "false"],
-        expected: boolean;
+        [false, "foo"],
-      }) {
+      ])("should be %s when env var is '%s'", (expected, value) => {
-        describe(`when value is '${value}'`, () => {
+        process.env[envVar] = value;
-          it(`should be ${expected}`, () => {
+        expect(propertyGetter(config())).toEqual(expected);
-            process.env[envVar] = value;
+      })
-            expect(propertyGetter(config())).toEqual(expected);
-          });
-        });
-      }
-
-      expecting({ value: "", expected: expectedDefault });
-      expecting({ value: "true", expected: true });
-      expecting({ value: "false", expected: false });
-      expecting({ value: "foo", expected: false });
     });
   }
 
   describe("bonobUrl", () => {
-    describe("when BONOB_URL is specified", () => {
+      describe.each([
-      it("should be used", () => {
+        "BNB_URL", 
-        const url = "http://bonob1.example.com:8877/";
+        "BONOB_URL", 
-        process.env["BONOB_URL"] = url;
+        "BONOB_WEB_ADDRESS"
+      ])("when %s is specified", (k) => {
+        it("should be used", () => {
+          const url = "http://bonob1.example.com:8877/";
 
-        expect(config().bonobUrl.href()).toEqual(url);
+          process.env["BNB_URL"] = "";
-      });
+          process.env["BONOB_URL"] = "";
+          process.env["BONOB_WEB_ADDRESS"] = "";
+          process.env[k] = url;
+
+          expect(config().bonobUrl.href()).toEqual(url);
+        });
     });
 
-    describe("when BONOB_URL is not specified, however legacy BONOB_WEB_ADDRESS is specified", () => {
+    describe("when none of BNB_URL, BONOB_URL, BONOB_WEB_ADDRESS are specified", () => {
-      it("should be used", () => {
-        const url = "http://bonob2.example.com:9988/";
-        process.env["BONOB_URL"] = "";
-        process.env["BONOB_WEB_ADDRESS"] = url;
-
-        expect(config().bonobUrl.href()).toEqual(url);
-      });
-    });
-
-    describe("when neither BONOB_URL nor BONOB_WEB_ADDRESS are specified", () => {
       describe("when BONOB_PORT is not specified", () => {
         it(`should default to http://${hostname()}:4534`, () => {
           expect(config().bonobUrl.href()).toEqual(
@@ -71,6 +136,15 @@ describe("config", () => {
         });
       });
 
+      describe("when BNB_PORT is specified as 3322", () => {
+        it(`should default to http://${hostname()}:3322`, () => {
+          process.env["BNB_PORT"] = "3322";
+          expect(config().bonobUrl.href()).toEqual(
+            `http://${hostname()}:3322/`
+          );
+        });
+      });
+
       describe("when BONOB_PORT is specified as 3322", () => {
         it(`should default to http://${hostname()}:3322`, () => {
           process.env["BONOB_PORT"] = "3322";
@@ -82,90 +156,89 @@ describe("config", () => {
     });
   });
 
-  describe("navidrome", () => {
-    describe("url", () => {
-      describe("when BONOB_NAVIDROME_URL is not specified", () => {
-        it(`should default to http://${hostname()}:4533`, () => {
-          expect(config().navidrome.url).toEqual(`http://${hostname()}:4533`);
-        });
-      });
-
-      describe("when BONOB_NAVIDROME_URL is ''", () => {
-        it(`should default to http://${hostname()}:4533`, () => {
-          process.env["BONOB_NAVIDROME_URL"] = "";
-          expect(config().navidrome.url).toEqual(`http://${hostname()}:4533`);
-        });
-      });
-
-      describe("when BONOB_NAVIDROME_URL is specified", () => {
-        it(`should use it`, () => {
-          const url = "http://navidrome.example.com:1234";
-          process.env["BONOB_NAVIDROME_URL"] = url;
-          expect(config().navidrome.url).toEqual(url);
-        });
-      });
-    });
-  });
-
   describe("icons", () => {
     describe("foregroundColor", () => {
-      describe("when BONOB_ICON_FOREGROUND_COLOR is not specified", () => {
+      describe.each([
-        it(`should default to undefined`, () => {
+        "BNB_ICON_FOREGROUND_COLOR",
-          expect(config().icons.foregroundColor).toEqual(undefined);
+        "BONOB_ICON_FOREGROUND_COLOR",
+      ])("%s", (k) => {
+        describe(`when ${k} is not specified`, () => {
+          it(`should default to undefined`, () => {
+            expect(config().icons.foregroundColor).toEqual(undefined);
+          });
         });
-      });
 
-      describe("when BONOB_ICON_FOREGROUND_COLOR is ''", () => {
+        describe(`when ${k} is ''`, () => {
-        it(`should default to undefined`, () => {
+          it(`should default to undefined`, () => {
-          process.env["BONOB_ICON_FOREGROUND_COLOR"] = "";
+            process.env[k] = "";
-          expect(config().icons.foregroundColor).toEqual(undefined);
+            expect(config().icons.foregroundColor).toEqual(undefined);
+          });
         });
-      });
 
-      describe("when BONOB_ICON_FOREGROUND_COLOR is specified", () => {
+        describe(`when ${k} is specified as a color`, () => {
-        it(`should use it`, () => {
+          it(`should use it`, () => {
-          process.env["BONOB_ICON_FOREGROUND_COLOR"] = "pink";
+            process.env[k] = "pink";
-          expect(config().icons.foregroundColor).toEqual("pink");
+            expect(config().icons.foregroundColor).toEqual("pink");
+          });
         });
-      });
 
-      describe("when BONOB_ICON_FOREGROUND_COLOR is an invalid string", () => {
+        describe(`when ${k} is specified as hex`, () => {
-        it(`should blow up`, () => {
+          it(`should use it`, () => {
-          process.env["BONOB_ICON_FOREGROUND_COLOR"] = "#dfasd";
+            process.env[k] = "#1db954";
-          expect(() => config()).toThrow(
+            expect(config().icons.foregroundColor).toEqual("#1db954");
-            "Invalid color specified for BONOB_ICON_FOREGROUND_COLOR"
+          });
-          );
+        });
+
+        describe(`when ${k} is an invalid string`, () => {
+          it(`should blow up`, () => {
+            process.env[k] = "!dfasd";
+            expect(() => config()).toThrow(
+              `Invalid value specified for 'BNB_ICON_FOREGROUND_COLOR', must match ${COLOR}`
+            );
+          });
         });
       });
     });
 
     describe("backgroundColor", () => {
-      describe("when BONOB_ICON_BACKGROUND_COLOR is not specified", () => {
+      describe.each([
-        it(`should default to undefined`, () => {
+        "BNB_ICON_BACKGROUND_COLOR",
-          expect(config().icons.backgroundColor).toEqual(undefined);
+        "BONOB_ICON_BACKGROUND_COLOR",
+      ])("%s", (k) => {
+        describe(`when ${k} is not specified`, () => {
+          it(`should default to undefined`, () => {
+            expect(config().icons.backgroundColor).toEqual(undefined);
+          });
         });
-      });
 
-      describe("when BONOB_ICON_BACKGROUND_COLOR is ''", () => {
+        describe(`when ${k} is ''`, () => {
-        it(`should default to undefined`, () => {
+          it(`should default to undefined`, () => {
-          process.env["BONOB_ICON_BACKGROUND_COLOR"] = "";
+            process.env[k] = "";
-          expect(config().icons.backgroundColor).toEqual(undefined);
+            expect(config().icons.backgroundColor).toEqual(undefined);
+          });
         });
-      });
 
-      describe("when BONOB_ICON_BACKGROUND_COLOR is specified", () => {
+        describe(`when ${k} is specified as a color`, () => {
-        it(`should use it`, () => {
+          it(`should use it`, () => {
-          process.env["BONOB_ICON_BACKGROUND_COLOR"] = "blue";
+            process.env[k] = "blue";
-          expect(config().icons.backgroundColor).toEqual("blue");
+            expect(config().icons.backgroundColor).toEqual("blue");
+          });
         });
-      });
 
-      describe("when BONOB_ICON_BACKGROUND_COLOR is an invalid string", () => {
+        describe(`when ${k} is specified as hex`, () => {
-        it(`should blow up`, () => {
+          it(`should use it`, () => {
-          process.env["BONOB_ICON_BACKGROUND_COLOR"] = "#red";
+            process.env[k] = "#1db954";
-          expect(() => config()).toThrow(
+            expect(config().icons.backgroundColor).toEqual("#1db954");
-            "Invalid color specified for BONOB_ICON_BACKGROUND_COLOR"
+          });
-          );
+        });
+
+        describe(`when ${k} is an invalid string`, () => {
+          it(`should blow up`, () => {
+            process.env[k] = "!red";
+            expect(() => config()).toThrow(
+              `Invalid value specified for 'BNB_ICON_BACKGROUND_COLOR', must match ${COLOR}`
+            );
+          });
         });
       });
     });
@@ -176,47 +249,101 @@ describe("config", () => {
       expect(config().secret).toEqual("bonob");
     });
 
-    it("should be overridable", () => {
+    describe.each([
-      process.env["BONOB_SECRET"] = "new secret";
+      "BNB_SECRET", 
-      expect(config().secret).toEqual("new secret");
+      "BONOB_SECRET"
+    ])("%s", (k) => {
+      it(`should be overridable using ${k}`, () => {
+        process.env[k] = "new secret";
+        expect(config().secret).toEqual("new secret");
+      });
     });
   });
 
+  describe("authTimeout", () => {
+    it("should default to 1h", () => {
+      expect(config().authTimeout).toEqual("1h");
+    });
+
+    it(`should be overridable using BNB_AUTH_TIMEOUT`, () => {
+      process.env["BNB_AUTH_TIMEOUT"] = "33s";
+      expect(config().authTimeout).toEqual("33s");
+    });
+  });
+  
+  describe("logRequests", () => {
+    describeBooleanConfigValue(
+      "logRequests",
+      "BNB_SERVER_LOG_REQUESTS",
+      false,
+      (config) => config.logRequests
+    );
+  });
+
   describe("sonos", () => {
     describe("serviceName", () => {
       it("should default to bonob", () => {
         expect(config().sonos.serviceName).toEqual("bonob");
       });
 
-      it("should be overridable", () => {
+      describe.each([
-        process.env["BONOB_SONOS_SERVICE_NAME"] = "foobar1000";
+        "BNB_SONOS_SERVICE_NAME", 
-        expect(config().sonos.serviceName).toEqual("foobar1000");
+        "BONOB_SONOS_SERVICE_NAME"
-      });
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "foobar1000";
+            expect(config().sonos.serviceName).toEqual("foobar1000");
+          });
+        }
+      );
     });
 
-    describeBooleanConfigValue(
+    describe.each([
-      "deviceDiscovery",
+      "BNB_SONOS_DEVICE_DISCOVERY",
       "BONOB_SONOS_DEVICE_DISCOVERY",
-      true,
+    ])("%s", (k) => {
-      (config) => config.sonos.discovery.auto
+      describeBooleanConfigValue(
-    );
+        "deviceDiscovery",
+        k,
+        true,
+        (config) => config.sonos.discovery.enabled
+      );
+    });
 
     describe("seedHost", () => {
       it("should default to undefined", () => {
         expect(config().sonos.discovery.seedHost).toBeUndefined();
       });
 
-      it("should be overridable", () => {
+      describe.each([
-        process.env["BONOB_SONOS_SEED_HOST"] = "123.456.789.0";
+        "BNB_SONOS_SEED_HOST", 
-        expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0");
+        "BONOB_SONOS_SEED_HOST"
-      });
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "123.456.789.0";
+            expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0");
+          });
+        }
+      );
     });
 
-    describeBooleanConfigValue(
+    describe.each([
-      "autoRegister",
+      "BNB_SONOS_AUTO_REGISTER", 
-      "BONOB_SONOS_AUTO_REGISTER",
+      "BONOB_SONOS_AUTO_REGISTER"
-      false,
+    ])(
-      (config) => config.sonos.autoRegister
+      "%s",
+      (k) => {
+        describeBooleanConfigValue(
+          "autoRegister",
+          k,
+          false,
+          (config) => config.sonos.autoRegister
+        );
+      }
     );
 
     describe("sid", () => {
@@ -224,47 +351,112 @@ describe("config", () => {
         expect(config().sonos.sid).toEqual(246);
       });
 
-      it("should be overridable", () => {
+      describe.each([
-        process.env["BONOB_SONOS_SERVICE_ID"] = "786";
+        "BNB_SONOS_SERVICE_ID", 
-        expect(config().sonos.sid).toEqual(786);
+        "BONOB_SONOS_SERVICE_ID"
-      });
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "786";
+            expect(config().sonos.sid).toEqual(786);
+          });
+        }
+      );
     });
   });
 
-  describe("navidrome", () => {
+  describe("subsonic", () => {
     describe("url", () => {
-      it("should default to http://${hostname()}:4533", () => {
+      describe.each([
-        expect(config().navidrome.url).toEqual(`http://${hostname()}:4533`);
+        "BNB_SUBSONIC_URL",
-      });
+        "BONOB_SUBSONIC_URL",
+        "BONOB_NAVIDROME_URL",
+      ])("%s", (k) => {
+        describe(`when ${k} is not specified`, () => {
+          it(`should default to http://${hostname()}:4533/`, () => {
+            expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
+          });
+        });
 
-      it("should be overridable", () => {
+        describe(`when ${k} is ''`, () => {
-        process.env["BONOB_NAVIDROME_URL"] = "http://farfaraway.com";
+          it(`should default to http://${hostname()}:4533/`, () => {
-        expect(config().navidrome.url).toEqual("http://farfaraway.com");
+            process.env[k] = "";
+            expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
+          });
+        });
+
+        describe(`when ${k} is specified`, () => {
+          it(`should use it for ${k}`, () => {
+            const url = "http://navidrome.example.com:1234/some-context-path";
+            process.env[k] = url;
+            expect(config().subsonic.url.href()).toEqual(url);
+          });
+        });
+
+        describe(`when ${k} is specified with trailing slash`, () => {
+          it(`should maintain the trailing slash as URLBuilder will remove it when required ${k}`, () => {
+            const url = "http://navidrome.example.com:1234/";
+            process.env[k] = url;
+            expect(config().subsonic.url.href()).toEqual(url);
+          });
+        });
       });
     });
 
     describe("customClientsFor", () => {
       it("should default to undefined", () => {
-        expect(config().navidrome.customClientsFor).toBeUndefined();
+        expect(config().subsonic.customClientsFor).toBeUndefined();
       });
 
-      it("should be overridable", () => {
+      describe.each([
-        process.env["BONOB_NAVIDROME_CUSTOM_CLIENTS"] = "whoop/whoop";
+        "BNB_SUBSONIC_CUSTOM_CLIENTS",
-        expect(config().navidrome.customClientsFor).toEqual("whoop/whoop");
+        "BONOB_SUBSONIC_CUSTOM_CLIENTS",
+        "BONOB_NAVIDROME_CUSTOM_CLIENTS",
+      ])("%s", (k) => {
+        it(`should be overridable for ${k}`, () => {
+          process.env[k] = "whoop/whoop";
+          expect(config().subsonic.customClientsFor).toEqual("whoop/whoop");
+        });
+      });
+    });
+
+    describe("artistImageCache", () => {
+      it("should default to undefined", () => {
+        expect(config().subsonic.artistImageCache).toBeUndefined();
+      });
+
+      it(`should be overridable for BNB_SUBSONIC_ARTIST_IMAGE_CACHE`, () => {
+        process.env["BNB_SUBSONIC_ARTIST_IMAGE_CACHE"] = "/some/path";
+        expect(config().subsonic.artistImageCache).toEqual("/some/path");
       });
     });
   });
 
-  describeBooleanConfigValue(
+  describe.each([
-    "scrobbleTracks",
+    "BNB_SCROBBLE_TRACKS", 
-    "BONOB_SCROBBLE_TRACKS",
+    "BONOB_SCROBBLE_TRACKS"
-    true,
+  ])("%s", (k) => {
-    (config) => config.scrobbleTracks
+    describeBooleanConfigValue(
-  );
+      "scrobbleTracks",
-  describeBooleanConfigValue(
+      k,
-    "reportNowPlaying",
+      true,
-    "BONOB_REPORT_NOW_PLAYING",
+      (config) => config.scrobbleTracks
-    true,
+    );
-    (config) => config.reportNowPlaying
+  });
+
+  describe.each([
+    "BNB_REPORT_NOW_PLAYING", 
+    "BONOB_REPORT_NOW_PLAYING"
+  ])(
+    "%s",
+    (k) => {
+      describeBooleanConfigValue(
+        "reportNowPlaying",
+        k,
+        true,
+        (config) => config.reportNowPlaying
+      );
+    }
   );
 });

tests/encryption.test.ts

@@ -1,12 +1,53 @@
-import encryption from '../src/encryption';
+import { left, right } from 'fp-ts/Either'
 
-describe("encrypt", () => {
+import { cryptoEncryption, jwsEncryption } from '../src/encryption';
-  const e = encryption("secret squirrel");
 
+describe("jwsEncryption", () => {
   it("can encrypt and decrypt", () => {
+    const e = jwsEncryption("secret squirrel");
+
     const value = "bobs your uncle"
     const hash = e.encrypt(value)
-    expect(hash.encryptedData).not.toEqual(value);
+    expect(hash).not.toContain(value);
-    expect(e.decrypt(hash)).toEqual(value);
+    expect(e.decrypt(hash)).toEqual(right(value));
   });
-})
+
+  it("returns different values for different secrets", () => {
+    const e1 = jwsEncryption("e1");
+    const e2 = jwsEncryption("e2");
+
+    const value = "bobs your uncle"
+    const h1 = e1.encrypt(value)
+    const h2 = e2.encrypt(value)
+
+    expect(h1).not.toEqual(h2);
+  });
+})
+
+describe("cryptoEncryption", () => {
+  it("can encrypt and decrypt", () => {
+    const e = cryptoEncryption("secret squirrel");
+
+    const value = "bobs your uncle"
+    const hash = e.encrypt(value)
+    expect(hash).not.toContain(value);
+    expect(e.decrypt(hash)).toEqual(right(value));
+  });
+
+  it("returns different values for different secrets", () => {
+    const e1 = cryptoEncryption("e1");
+    const e2 = cryptoEncryption("e2");
+
+    const value = "bobs your uncle"
+    const h1 = e1.encrypt(value)
+    const h2 = e2.encrypt(value)
+
+    expect(h1).not.toEqual(h2);
+  });
+  
+  it("should return left on invalid value", () => {
+    const e = cryptoEncryption("secret squirrel");
+
+    expect(e.decrypt("not-valid")).toEqual(left("Invalid value to decrypt"));
+  });
+})

tests/i8n.test.ts

@@ -34,7 +34,7 @@ describe("i8n", () => {
 
   describe("langs", () => {
     it("should be all langs that are explicitly defined", () => {
-      expect(langs()).toEqual(["en-US", "nl-NL"]);
+      expect(langs()).toEqual(["en-US", "da-DK", "fr-FR", "nl-NL"]);
     });
   });
 

tests/icon.test.ts

@@ -1,5 +1,6 @@
 import dayjs from "dayjs";
-import libxmljs from "libxmljs2";
+import { FixedClock } from "../src/clock";
+import { xmlTidy } from "../src/utils";
 
 import {
   contains,
@@ -19,17 +20,17 @@ import {
   allOf,
   features,
   STAR_WARS,
+  NO_FEATURES,
 } from "../src/icon";
 
 describe("SvgIcon", () => {
-  const xmlTidy = (xml: string) =>
-    libxmljs.parseXmlString(xml, { noblanks: true, net: false }).toString();
-
   const svgIcon24 = `<?xml version="1.0" encoding="UTF-8"?>
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
   <path d="path1"/>
   <path d="path2" fill="none" stroke="#000"/>
+  <text font-size="25" fill="none">80's</text>
   <path d="path3"/>
+  <text font-size="25">80's</text>
 </svg>
 `;
 
@@ -60,7 +61,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -4 32 32">
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
           `)
           );
@@ -109,7 +112,9 @@ describe("SvgIcon", () => {
               <rect x="0" y="0" width="24" height="24" fill="red"/>
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -133,7 +138,9 @@ describe("SvgIcon", () => {
               <rect x="-4" y="-4" width="36" height="36" fill="pink"/>
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -151,7 +158,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -171,7 +180,9 @@ describe("SvgIcon", () => {
               <rect x="0" y="0" width="24" height="24" fill="red"/>
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -181,7 +192,7 @@ describe("SvgIcon", () => {
 
   describe("foreground color", () => {
     describe("with no viewPort increase", () => {
-      it("should add a rectangle the same size as the original viewPort", () => {
+      it("should change the fill values", () => {
         expect(
           new SvgIcon(svgIcon24)
             .with({ features: { foregroundColor: "red" } })
@@ -191,7 +202,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1" fill="red"/>
               <path d="path2" fill="none" stroke="red"/>
+              <text font-size="25" fill="none" stroke="red">80's</text>
               <path d="path3" fill="red"/>
+              <text font-size="25" fill="red">80's</text>
             </svg>
         `)
         );
@@ -199,7 +212,7 @@ describe("SvgIcon", () => {
     });
 
     describe("with a viewPort increase", () => {
-      it("should add a rectangle the same size as the original viewPort", () => {
+      it("should change the fill values", () => {
         expect(
           new SvgIcon(svgIcon24)
             .with({
@@ -214,7 +227,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -4 32 32">
               <path d="path1" fill="pink"/>
               <path d="path2" fill="none" stroke="pink"/>
+              <text font-size="25" fill="none" stroke="pink">80's</text>
               <path d="path3" fill="pink"/>
+              <text font-size="25" fill="pink">80's</text>
             </svg>
         `)
         );
@@ -232,7 +247,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>              
               <path d="path3"/>
+              <text font-size="25">80's</text>              
             </svg>
         `)
         );
@@ -251,7 +268,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1" fill="red"/>
               <path d="path2" fill="none" stroke="red"/>
+              <text font-size="25" fill="none" stroke="red">80's</text>              
               <path d="path3" fill="red"/>
+              <text font-size="25" fill="red">80's</text>              
             </svg>
         `)
         );
@@ -259,6 +278,48 @@ describe("SvgIcon", () => {
     });
   });
 
+  describe("text", () => {
+    describe("when text value specified", () => {
+      it("should change the text values", () => {
+        expect(
+          new SvgIcon(svgIcon24)
+            .with({ features: { text: "yipppeeee" } })
+            .toString()
+        ).toEqual(
+          xmlTidy(`<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+  <path d="path1"/>
+  <path d="path2" fill="none" stroke="#000"/>
+  <text font-size="25" fill="none">yipppeeee</text>
+  <path d="path3"/>
+  <text font-size="25">yipppeeee</text>
+</svg>
+        `)
+        );
+      });
+    });
+
+    describe("of undefined", () => {
+      it("should not do anything", () => {
+        expect(
+          new SvgIcon(svgIcon24)
+            .with({ features: { text: undefined } })
+            .toString()
+        ).toEqual(
+          xmlTidy(`<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+  <path d="path1"/>
+  <path d="path2" fill="none" stroke="#000"/>
+  <text font-size="25" fill="none">80's</text>
+  <path d="path3"/>
+  <text font-size="25">80's</text>
+</svg>
+        `)
+        );
+      });
+    });
+  });
+
   describe("swapping the svg", () => {
     describe("with no other changes", () => {
       it("should swap out the svg, but maintain the IconFeatures", () => {
@@ -317,10 +378,14 @@ describe("SvgIcon", () => {
 
 class DummyIcon implements Icon {
   svg: string;
-  features: Partial<IconFeatures>;
+  features: IconFeatures;
+
   constructor(svg: string, features: Partial<IconFeatures>) {
     this.svg = svg;
-    this.features = features;
+    this.features = {
+      ...NO_FEATURES,
+      ...features
+    };
   }
 
   public apply = (transformer: Transformer): Icon => transformer(this);
@@ -349,6 +414,7 @@ describe("transform", () => {
             viewPortIncreasePercent: 100,
             foregroundColor: "blue",
             backgroundColor: "blue",
+            text: "a",
           },
         })
         .apply(
@@ -356,6 +422,7 @@ describe("transform", () => {
             features: {
               foregroundColor: "override1",
               backgroundColor: "override2",
+              text: "b",
             },
           })
         ) as DummyIcon;
@@ -365,6 +432,7 @@ describe("transform", () => {
         viewPortIncreasePercent: 100,
         foregroundColor: "override1",
         backgroundColor: "override2",
+        text: "b",
       });
     });
   });
@@ -381,6 +449,7 @@ describe("transform", () => {
             viewPortIncreasePercent: 100,
             foregroundColor: "blue",
             backgroundColor: "blue",
+            text: "bob",
           },
         })
         .apply(
@@ -394,6 +463,7 @@ describe("transform", () => {
         viewPortIncreasePercent: 100,
         foregroundColor: "blue",
         backgroundColor: "blue",
+        text: "bob"
       });
     });
   });
@@ -410,6 +480,7 @@ describe("features", () => {
         viewPortIncreasePercent: 100,
         foregroundColor: "blue",
         backgroundColor: "blue",
+        text: "foobar"
       })
     ) as DummyIcon;
 
@@ -417,6 +488,7 @@ describe("features", () => {
       viewPortIncreasePercent: 100,
       foregroundColor: "blue",
       backgroundColor: "blue",
+      text: "foobar"
     });
   });
 });
@@ -556,12 +628,11 @@ describe("festivals", () => {
     backgroundColor: "black",
     foregroundColor: "black",
   });
-  let now = dayjs();
+  const clock = new FixedClock(dayjs());
-  const clock = { now: () => now };
 
   describe("on a day that isn't festive", () => {
     beforeEach(() => {
-      now = dayjs("2022/10/12");
+      clock.time = dayjs("2022/10/12");
     });
 
     it("should use the given colors", () => {
@@ -587,7 +658,7 @@ describe("festivals", () => {
 
   describe("on christmas day", () => {
     beforeEach(() => {
-      now = dayjs("2022/12/25");
+      clock.time = dayjs("2022/12/25");
     });
 
     it("should use the christmas theme colors", () => {
@@ -613,7 +684,7 @@ describe("festivals", () => {
 
   describe("on halloween", () => {
     beforeEach(() => {
-      now = dayjs("2022/10/31");
+      clock.time = dayjs("2022/10/31");
     });
 
     it("should use the given colors", () => {
@@ -638,7 +709,7 @@ describe("festivals", () => {
 
   describe("on may 4", () => {
     beforeEach(() => {
-      now = dayjs("2022/5/4");
+      clock.time = dayjs("2022/5/4");
     });
 
     it("should use the undefined colors, so no color", () => {
@@ -664,7 +735,7 @@ describe("festivals", () => {
   describe("on cny", () => {
     describe("2022", () => {
       beforeEach(() => {
-        now = dayjs("2022/02/01");
+        clock.time = dayjs("2022/02/01");
       });
 
       it("should use the cny theme", () => {
@@ -689,7 +760,7 @@ describe("festivals", () => {
 
     describe("2023", () => {
       beforeEach(() => {
-        now = dayjs("2023/01/22");
+        clock.time = dayjs("2023/01/22");
       });
 
       it("should use the cny theme", () => {
@@ -714,7 +785,7 @@ describe("festivals", () => {
 
     describe("2024", () => {
       beforeEach(() => {
-        now = dayjs("2024/02/10");
+        clock.time = dayjs("2024/02/10");
       });
 
       it("should use the cny theme", () => {
@@ -740,7 +811,7 @@ describe("festivals", () => {
 
   describe("on holi", () => {
     beforeEach(() => {
-      now = dayjs("2022/03/18");
+      clock.time = dayjs("2022/03/18");
     });
 
     it("should use the given colors", () => {

tests/in_memory_music_service.test.ts

@@ -1,10 +1,11 @@
+import { taskEither as TE } from "fp-ts";
+import { pipe } from "fp-ts/lib/function";
+
 import { InMemoryMusicService } from "./in_memory_music_service";
 import {
-  AuthSuccess,
   MusicLibrary,
   artistToArtistSummary,
-  albumToAlbumSummary,
+} from "../src/music_library";
-} from "../src/music_service";
 import { v4 as uuid } from "uuid";
 import {
   anArtist,
@@ -15,9 +16,11 @@ import {
   METAL,
   HIP_HOP,
   SKA,
+  anAlbumSummary,
 } from "./builders";
 import _ from "underscore";
 
+
 describe("InMemoryMusicService", () => {
   const service = new InMemoryMusicService();
 
@@ -27,12 +30,15 @@ describe("InMemoryMusicService", () => {
 
       service.hasUser(credentials);
 
-      const token = (await service.generateToken(credentials)) as AuthSuccess;
+      const token = await pipe(
+        service.generateToken(credentials),
+        TE.getOrElse(e => { throw e })
+      )();
 
       expect(token.userId).toEqual(credentials.username);
       expect(token.nickname).toEqual(credentials.username);
 
-      const musicLibrary = service.login(token.authToken);
+      const musicLibrary = service.login(token.serviceToken);
 
       expect(musicLibrary).toBeDefined();
     });
@@ -42,34 +48,19 @@ describe("InMemoryMusicService", () => {
 
       service.hasUser(credentials);
 
-      const token = (await service.generateToken(credentials)) as AuthSuccess;
+      const token = await pipe(
+        service.generateToken(credentials),
+        TE.getOrElse(e => { throw e })
+      )();
 
       service.clear();
 
-      return expect(service.login(token.authToken)).rejects.toEqual(
+      return expect(service.login(token.serviceToken)).rejects.toEqual(
         "Invalid auth token"
       );
     });
   });
-
+  
-  describe("artistToArtistSummary", () => {
-    it("should map fields correctly", () => {
-      const artist = anArtist({
-        id: uuid(),
-        name: "The Artist",
-        image: {
-          small: "/path/to/small/jpg",
-          medium: "/path/to/medium/jpg",
-          large: "/path/to/large/jpg",
-        },
-      });
-      expect(artistToArtistSummary(artist)).toEqual({
-        id: artist.id,
-        name: artist.name,
-      });
-    });
-  });
-
   describe("Music Library", () => {
     const user = { username: "user100", password: "password100" };
     let musicLibrary: MusicLibrary;
@@ -79,8 +70,12 @@ describe("InMemoryMusicService", () => {
 
       service.hasUser(user);
 
-      const token = (await service.generateToken(user)) as AuthSuccess;
+      const token = await pipe(
-      musicLibrary = (await service.login(token.authToken)) as MusicLibrary;
+        service.generateToken(user),
+        TE.getOrElse(e => { throw e })
+      )();
+
+      musicLibrary = (await service.login(token.serviceToken)) as MusicLibrary;
     });
 
     describe("artists", () => {
@@ -143,8 +138,8 @@ describe("InMemoryMusicService", () => {
 
       describe("when it exists", () => {
         it("should provide an artist", async () => {
-          expect(await musicLibrary.artist(artist1.id)).toEqual(artist1);
+          expect(await musicLibrary.artist(artist1.id!)).toEqual(artist1);
-          expect(await musicLibrary.artist(artist2.id)).toEqual(artist2);
+          expect(await musicLibrary.artist(artist2.id!)).toEqual(artist2);
         });
       });
 
@@ -172,43 +167,26 @@ describe("InMemoryMusicService", () => {
         service.hasTracks(track1, track2, track3, track4);
       });
 
-      describe("fetching tracks for an album", () => {
-        it("should return only tracks on that album", async () => {
-          expect(await musicLibrary.tracks(artist1Album1.id)).toEqual([
-            track1,
-            track2,
-          ]);
-        });
-      });
-
-      describe("fetching tracks for an album that doesnt exist", () => {
-        it("should return empty array", async () => {
-          expect(await musicLibrary.tracks("non existant album id")).toEqual(
-            []
-          );
-        });
-      });
-
       describe("fetching a single track", () => {
         describe("when it exists", () => {
           it("should return the track", async () => {
-            expect(await musicLibrary.track(track3.id)).toEqual(track3);
+            expect(await musicLibrary.track(track3.id)).toEqual({ ...track3, rating: { love: false, stars: 0 } },);
           });
         });
       });
     });
 
     describe("albums", () => {
-      const artist1_album1 = anAlbum({ genre: POP });
+      const artist1_album1 = anAlbumSummary({ genre: POP });
-      const artist1_album2 = anAlbum({ genre: ROCK });
+      const artist1_album2 = anAlbumSummary({ genre: ROCK });
-      const artist1_album3 = anAlbum({ genre: METAL });
+      const artist1_album3 = anAlbumSummary({ genre: METAL });
-      const artist1_album4 = anAlbum({ genre: POP });
+      const artist1_album4 = anAlbumSummary({ genre: POP });
-      const artist1_album5 = anAlbum({ genre: POP });
+      const artist1_album5 = anAlbumSummary({ genre: POP });
 
-      const artist2_album1 = anAlbum({ genre: METAL });
+      const artist2_album1 = anAlbumSummary({ genre: METAL });
 
-      const artist3_album1 = anAlbum({ genre: HIP_HOP });
+      const artist3_album1 = anAlbumSummary({ genre: HIP_HOP });
-      const artist3_album2 = anAlbum({ genre: POP });
+      const artist3_album2 = anAlbumSummary({ genre: POP });
 
       const artist1 = anArtist({
         name: "artist1",
@@ -217,11 +195,14 @@ describe("InMemoryMusicService", () => {
           artist1_album2,
           artist1_album3,
           artist1_album4,
-          artist1_album5,
+          artist1_album5
-        ],
+        ]
       });
       const artist2 = anArtist({ name: "artist2", albums: [artist2_album1] });
-      const artist3 = anArtist({ name: "artist3", albums: [artist3_album1, artist3_album2] });
+      const artist3 = anArtist({
+        name: "artist3",
+        albums: [artist3_album1, artist3_album2],
+      });
       const artistWithNoAlbums = anArtist({ albums: [] });
 
       const allAlbums = [artist1, artist2, artist3, artistWithNoAlbums].flatMap(
@@ -258,7 +239,7 @@ describe("InMemoryMusicService", () => {
             });
 
             expect(albums.total).toEqual(totalAlbumCount);
-            expect(albums.results.length).toEqual(3)
+            expect(albums.results.length).toEqual(3);
             // cannot really assert the results and they will change every time
           });
         });
@@ -277,16 +258,16 @@ describe("InMemoryMusicService", () => {
                   })
                 ).toEqual({
                   results: [
-                    albumToAlbumSummary(artist1_album1),
+                    artist1_album1,
-                    albumToAlbumSummary(artist1_album2),
+                    artist1_album2,
-                    albumToAlbumSummary(artist1_album3),
+                    artist1_album3,
-                    albumToAlbumSummary(artist1_album4),
+                    artist1_album4,
-                    albumToAlbumSummary(artist1_album5),
+                    artist1_album5,
-  
+
-                    albumToAlbumSummary(artist2_album1),
+                    artist2_album1,
-  
+
-                    albumToAlbumSummary(artist3_album1),
+                    artist3_album1,
-                    albumToAlbumSummary(artist3_album2),
+                    artist3_album2,
                   ],
                   total: totalAlbumCount,
                 });
@@ -302,13 +283,11 @@ describe("InMemoryMusicService", () => {
                     type: "alphabeticalByName",
                   })
                 ).toEqual({
-                  results:                   
+                  results: _.sortBy(allAlbums, "name"),
-                  _.sortBy(allAlbums, 'name').map(albumToAlbumSummary),
                   total: totalAlbumCount,
                 });
               });
             });
-
           });
 
           describe("fetching a page", () => {
@@ -321,9 +300,9 @@ describe("InMemoryMusicService", () => {
                 })
               ).toEqual({
                 results: [
-                  albumToAlbumSummary(artist1_album5),
+                  artist1_album5,
-                  albumToAlbumSummary(artist2_album1),
+                  artist2_album1,
-                  albumToAlbumSummary(artist3_album1),
+                  artist3_album1,
                 ],
                 total: totalAlbumCount,
               });
@@ -340,8 +319,8 @@ describe("InMemoryMusicService", () => {
                 })
               ).toEqual({
                 results: [
-                  albumToAlbumSummary(artist3_album1),
+                  artist3_album1,
-                  albumToAlbumSummary(artist3_album2),
+                  artist3_album2,
                 ],
                 total: totalAlbumCount,
               });
@@ -361,10 +340,10 @@ describe("InMemoryMusicService", () => {
                 })
               ).toEqual({
                 results: [
-                  albumToAlbumSummary(artist1_album1),
+                  artist1_album1,
-                  albumToAlbumSummary(artist1_album4),
+                  artist1_album4,
-                  albumToAlbumSummary(artist1_album5),
+                  artist1_album5,
-                  albumToAlbumSummary(artist3_album2),
+                  artist3_album2,
                 ],
                 total: 4,
               });
@@ -383,8 +362,8 @@ describe("InMemoryMusicService", () => {
                   })
                 ).toEqual({
                   results: [
-                    albumToAlbumSummary(artist1_album4),
+                    artist1_album4,
-                    albumToAlbumSummary(artist1_album5),
+                    artist1_album5,
                   ],
                   total: 4,
                 });
@@ -401,7 +380,7 @@ describe("InMemoryMusicService", () => {
                     _count: 100,
                   })
                 ).toEqual({
-                  results: [albumToAlbumSummary(artist3_album2)],
+                  results: [artist3_album2],
                   total: 4,
                 });
               });
@@ -428,7 +407,10 @@ describe("InMemoryMusicService", () => {
         describe("when it exists", () => {
           it("should provide an album", async () => {
             expect(await musicLibrary.album(artist1_album5.id)).toEqual(
-              artist1_album5
+              {
+                ...artist1_album5,
+                tracks: []
+              }
             );
           });
         });
@@ -467,9 +449,9 @@ describe("InMemoryMusicService", () => {
         it("should provide an array of artists", async () => {
           expect(await musicLibrary.genres()).toEqual([
             HIP_HOP,
+            SKA,
             POP,
             ROCK,
-            SKA,
           ]);
         });
       });

tests/in_memory_music_service.ts

@@ -1,10 +1,12 @@
-import { option as O } from "fp-ts";
+import { option as O, taskEither as TE } from "fp-ts";
 import * as A from "fp-ts/Array";
 import { fromEquals } from "fp-ts/lib/Eq";
 import { pipe } from "fp-ts/lib/function";
 import { ordString, fromCompare } from "fp-ts/lib/Ord";
 import { shuffle } from "underscore";
 
+import { b64Encode, b64Decode } from "../src/b64";
+
 import {
   MusicService,
   Credentials,
@@ -17,10 +19,11 @@ import {
   slice2,
   asResult,
   artistToArtistSummary,
-  albumToAlbumSummary,
   Track,
   Genre,
-} from "../src/music_service";
+  Rating,
+} from "../src/music_library";
+import { BUrn } from "../src/burn";
 
 export class InMemoryMusicService implements MusicService {
   users: Record<string, string> = {};
@@ -30,28 +33,29 @@ export class InMemoryMusicService implements MusicService {
   generateToken({
     username,
     password,
-  }: Credentials): Promise<AuthSuccess | AuthFailure> {
+  }: Credentials): TE.TaskEither<AuthFailure, AuthSuccess> {
     if (
       username != undefined &&
       password != undefined &&
       this.users[username] == password
     ) {
-      return Promise.resolve({
+      return TE.right({
-        authToken: Buffer.from(JSON.stringify({ username, password })).toString(
+        serviceToken: b64Encode(JSON.stringify({ username, password })),
-          "base64"
-        ),
         userId: username,
         nickname: username,
+        type: "in-memory"
       });
     } else {
-      return Promise.resolve({ message: `Invalid user:${username}` });
+      return TE.left(new AuthFailure(`Invalid user:${username}`));
     }
   }
 
-  login(token: string): Promise<MusicLibrary> {
+  refreshToken(serviceToken: string): TE.TaskEither<AuthFailure, AuthSuccess> {
-    const credentials = JSON.parse(
+    return this.generateToken(JSON.parse(b64Decode(serviceToken)))
-      Buffer.from(token, "base64").toString("ascii")
+  }
-    ) as Credentials;
+
+  login(serviceToken: string): Promise<MusicLibrary> {
+    const credentials = JSON.parse(b64Decode(serviceToken)) as Credentials;
     if (this.users[credentials.username] != credentials.password)
       return Promise.reject("Invalid auth token");
 
@@ -77,9 +81,11 @@ export class InMemoryMusicService implements MusicService {
             switch (q.type) {
               case "alphabeticalByArtist":
                 return artist2Album;
-                case "alphabeticalByName":
+              case "alphabeticalByName":
-                  return artist2Album.sort((a, b) => a.album.name.localeCompare(b.album.name));
+                return artist2Album.sort((a, b) =>
-                case "byGenre":
+                  a.album.name.localeCompare(b.album.name)
+                );
+              case "byGenre":
                 return artist2Album.filter(
                   (it) => it.album.genre?.id === q.genre
                 );
@@ -90,14 +96,13 @@ export class InMemoryMusicService implements MusicService {
             }
           })
           .then((matches) => matches.map((it) => it.album))
-          .then((it) => it.map(albumToAlbumSummary))
           .then(slice2(q))
           .then(asResult),
       album: (id: string) =>
         pipe(
           this.artists.flatMap((it) => it.albums).find((it) => it.id === id),
           O.fromNullable,
-          O.map((it) => Promise.resolve(it)),
+          O.map((it) => Promise.resolve({ ...it, tracks: [] })),
           O.getOrElse(() => Promise.reject(`No album with id '${id}'`))
         ),
       genres: () =>
@@ -109,26 +114,23 @@ export class InMemoryMusicService implements MusicService {
             A.map((it) => O.fromNullable(it.genre)),
             A.compact,
             A.uniq(fromEquals((x, y) => x.id === y.id)),
-            A.sort(
+            A.sort(fromCompare<Genre>((x, y) => ordString.compare(x.id, y.id)))
-              fromCompare<Genre>((x, y) => ordString.compare(x.id, y.id))
-            )
           )
         ),
-      tracks: (albumId: string) =>
+      rate: (_: string, _2: Rating) => Promise.resolve(false),
-        Promise.resolve(this.tracks.filter((it) => it.album.id === albumId)),
       track: (trackId: string) =>
         pipe(
           this.tracks.find((it) => it.id === trackId),
           O.fromNullable,
-          O.map((it) => Promise.resolve(it)),
+          O.map((it) => Promise.resolve({ ...it, rating: { love: false, stars: 0 } })),
           O.getOrElse(() =>
             Promise.reject(`Failed to find track with id ${trackId}`)
           )
         ),
       stream: (_: { trackId: string; range: string | undefined }) =>
         Promise.reject("unsupported operation"),
-      coverArt: (id: string, _: "album" | "artist", size?: number) =>
+      coverArt: (coverArtURN: BUrn, size?: number) =>
-        Promise.reject(`Cannot retrieve coverArt for ${id}, size ${size}`),
+        Promise.reject(`Cannot retrieve coverArt for ${coverArtURN}, size ${size}`),
       scrobble: async (_: string) => {
         return Promise.resolve(true);
       },
@@ -141,12 +143,19 @@ export class InMemoryMusicService implements MusicService {
       playlists: async () => Promise.resolve([]),
       playlist: async (id: string) =>
         Promise.reject(`No playlist with id ${id}`),
-      createPlaylist: async (_: string) => Promise.reject("Unsupported operation"),
+      createPlaylist: async (_: string) =>
-      deletePlaylist: async (_: string) => Promise.reject("Unsupported operation"),
+        Promise.reject("Unsupported operation"),
-      addToPlaylist: async (_: string) => Promise.reject("Unsupported operation"),
+      deletePlaylist: async (_: string) =>
-      removeFromPlaylist: async (_: string, _2: number[]) => Promise.reject("Unsupported operation"),
+        Promise.reject("Unsupported operation"),
+      addToPlaylist: async (_: string) =>
+        Promise.reject("Unsupported operation"),
+      removeFromPlaylist: async (_: string, _2: number[]) =>
+        Promise.reject("Unsupported operation"),
       similarSongs: async (_: string) => Promise.resolve([]),
       topSongs: async (_: string) => Promise.resolve([]),
+      radioStations: async () => Promise.resolve([]),
+      radioStation: async (_: string) => Promise.reject("Unsupported operation"),
+      years: async () => Promise.resolve([]),
     });
   }
 

tests/link_codes.test.ts

@@ -18,7 +18,7 @@ describe("InMemoryLinkCodes", () => {
     describe('when token is valid', () => {
       it('should associate the token', () => {
         const linkCode = linkCodes.mint();
-        const association = { authToken: "token123", nickname: "bob", userId: "1" };
+        const association = { serviceToken: "token123", nickname: "bob", userId: "1" };
 
         linkCodes.associate(linkCode, association);
 
@@ -29,7 +29,7 @@ describe("InMemoryLinkCodes", () => {
     describe('when token is valid', () => {
       it('should throw an error', () => {
         const invalidLinkCode = "invalidLinkCode";
-        const association = { authToken: "token456", nickname: "bob", userId: "1" };
+        const association = { serviceToken: "token456", nickname: "bob", userId: "1" };
 
         expect(() => linkCodes.associate(invalidLinkCode, association)).toThrow(`Invalid linkCode ${invalidLinkCode}`)
       }); 

tests/music_library.test.ts

@@ -0,0 +1,22 @@
+import { v4 as uuid } from "uuid";
+
+import { anArtist } from "./builders";
+import { artistToArtistSummary } from "../src/music_library";
+
+describe("artistToArtistSummary", () => {
+  it("should map fields correctly", () => {
+    const artist = anArtist({
+      id: uuid(),
+      name: "The Artist",
+      image: {
+        system: "external",
+        resource: "http://example.com:1234/image.jpg",
+      },
+    });
+    expect(artistToArtistSummary(artist)).toEqual({
+      id: artist.id,
+      name: artist.name,
+      image: artist.image,
+    });
+  });
+});

tests/random_string.test.ts

@@ -1,16 +0,0 @@
-import randomString from "../src/random_string";
-
-describe('randomString', () => {
-  it('should produce different strings...', () => {
-    const s1 = randomString()
-    const s2 = randomString()
-    const s3 = randomString()
-    const s4 = randomString()
-
-    expect(s1.length).toEqual(64)
-    
-    expect(s1).not.toEqual(s2);
-    expect(s1).not.toEqual(s3);
-    expect(s1).not.toEqual(s4);
-  });
-});

tests/registrar.test.ts

@@ -75,41 +75,62 @@ describe("registrar", () => {
       (sonos as jest.Mock).mockReturnValue(fakeSonos);
     });
 
+    describe("seedHost", () => {
+      describe("is specified", () => {
+        it("should register using the seed host", async () => {
+          fakeSonos.register.mockResolvedValue(true);
+          const seedHost = "127.0.0.11";
+  
+          expect(await registrar(bonobUrl, seedHost)()).toEqual(
+            true
+          );
+  
+          expect(bonobService).toHaveBeenCalledWith(
+            serviceDetails.name,
+            serviceDetails.sid,
+            bonobUrl
+          );
+          expect(sonos).toHaveBeenCalledWith({ enabled: true, seedHost });
+          expect(fakeSonos.register).toHaveBeenCalledWith(service);
+        });
+      });
+
+      describe("is not specified", () => {
+        it("should register without using the seed host", async () => {
+          fakeSonos.register.mockResolvedValue(true);
+
+          expect(await registrar(bonobUrl)()).toEqual(
+            true
+          );
+  
+          expect(bonobService).toHaveBeenCalledWith(
+            serviceDetails.name,
+            serviceDetails.sid,
+            bonobUrl
+          );
+          expect(sonos).toHaveBeenCalledWith({ enabled: true });
+          expect(fakeSonos.register).toHaveBeenCalledWith(service);
+        });
+      });
+    });
+
     describe("when registration succeeds", () => {
       it("should fetch the service details and register", async () => {
         fakeSonos.register.mockResolvedValue(true);
-        const sonosDiscovery = { auto: true };
 
-        expect(await registrar(bonobUrl, sonosDiscovery)()).toEqual(
+        expect(await registrar(bonobUrl)()).toEqual(
           true
         );
-
-        expect(bonobService).toHaveBeenCalledWith(
-          serviceDetails.name,
-          serviceDetails.sid,
-          bonobUrl
-        );
-        expect(sonos).toHaveBeenCalledWith(sonosDiscovery);
-        expect(fakeSonos.register).toHaveBeenCalledWith(service);
       });
     });
 
     describe("when registration fails", () => {
       it("should fetch the service details and register", async () => {
         fakeSonos.register.mockResolvedValue(false);
-        const sonosDiscovery = { auto: false, seedHost: "192.168.1.163" };
 
-        expect(await registrar(bonobUrl, sonosDiscovery)()).toEqual(
+        expect(await registrar(bonobUrl)()).toEqual(
           false
         );
-
-        expect(bonobService).toHaveBeenCalledWith(
-          serviceDetails.name,
-          serviceDetails.sid,
-          bonobUrl
-        );
-        expect(sonos).toHaveBeenCalledWith(sonosDiscovery);
-        expect(fakeSonos.register).toHaveBeenCalledWith(service);
       });
     });
   });

tests/scenarios.test.ts

@@ -18,7 +18,7 @@ import {
 } from "./builders";
 import { InMemoryMusicService } from "./in_memory_music_service";
 import { InMemoryLinkCodes } from "../src/link_codes";
-import { Credentials } from "../src/music_service";
+import { Credentials } from "../src/music_library";
 import makeServer from "../src/server";
 import { Service, bonobService, Sonos } from "../src/sonos";
 import supersoap from "./supersoap";
@@ -33,9 +33,10 @@ class LoggedInSonosDriver {
     this.client = client;
     this.token = token;
     this.client.addSoapHeader({
-      credentials: someCredentials(
+      credentials: someCredentials({
-        this.token.getDeviceAuthTokenResult.authToken
+        token: this.token.getDeviceAuthTokenResult.authToken,
-      ),
+        key: this.token.getDeviceAuthTokenResult.privateKey
+      }),
     });
   }
 
@@ -272,7 +273,7 @@ describe("scenarios", () => {
       bonobUrl,
       musicService,
       {
-        linkCodes: () => linkCodes
+        linkCodes: () => linkCodes,
       }
     );
 

tests/smapi_auth.test.ts

@@ -0,0 +1,188 @@
+import { v4 as uuid } from "uuid";
+import jwt from "jsonwebtoken";
+
+import {
+  ExpiredTokenError,
+  InvalidTokenError,
+  isSmapiRefreshTokenResultFault,
+  JWTSmapiLoginTokens,
+  smapiTokenAsString,
+  smapiTokenFromString,
+  SMAPI_TOKEN_VERSION,
+} from "../src/smapi_auth";
+import { either as E } from "fp-ts";
+import { FixedClock } from "../src/clock";
+import dayjs from "dayjs";
+import { b64Encode } from "../src/b64";
+
+describe("smapiTokenAsString", () => {
+  it("can round trip token to and from string", () => {
+    const smapiToken = { token: uuid(), key: uuid(), someOtherStuff: 'this needs to be explicitly ignored' };
+    const asString = smapiTokenAsString(smapiToken)
+
+    expect(asString).toEqual(b64Encode(JSON.stringify({
+      token: smapiToken.token,
+      key: smapiToken.key,
+    })));
+    expect(smapiTokenFromString(asString)).toEqual({
+      token: smapiToken.token,
+      key: smapiToken.key
+    });
+  });
+});
+
+describe("isSmapiRefreshTokenResultFault", () => {
+  it("should return true for a refreshAuthTokenResult fault", () => {
+    const faultWithRefreshAuthToken = {
+      Fault: {
+        faultcode: "",
+        faultstring: "",
+        detail: {
+          refreshAuthTokenResult: {
+            authToken: "x",
+            privateKey: "x",
+          },
+        },
+      },
+    };
+    expect(isSmapiRefreshTokenResultFault(faultWithRefreshAuthToken)).toEqual(
+      true
+    );
+  });
+
+  it("should return false when is not a refreshAuthTokenResult", () => {
+    expect(isSmapiRefreshTokenResultFault({ Fault: { faultcode: "", faultstring:" " }})).toEqual(
+      false
+    );
+  });
+});
+
+describe("auth", () => {
+  describe("JWTSmapiLoginTokens", () => {
+    const clock = new FixedClock(dayjs());
+
+    const expiresIn = "1h";
+    const secret = `secret-${uuid()}`;
+    const key = uuid();
+    const smapiLoginTokens = new JWTSmapiLoginTokens(clock, secret, expiresIn, () => key);
+
+    describe("issuing a new token", () => {
+      it("should issue a token that can then be verified", () => {
+        const serviceToken = `service-token-${uuid()}`;
+
+        const smapiToken = smapiLoginTokens.issue(serviceToken);
+
+        const expected = jwt.sign(
+          {
+            serviceToken,
+            iat: clock.now().unix(),
+          },
+          secret + SMAPI_TOKEN_VERSION + key,
+          { expiresIn }
+        );
+
+        expect(smapiToken.token).toEqual(expected);
+        expect(smapiToken.token).not.toContain(serviceToken);
+        expect(smapiToken.token).not.toContain(secret);
+        expect(smapiToken.token).not.toContain(":");
+
+        const roundTripped = smapiLoginTokens.verify(smapiToken);
+
+        expect(roundTripped).toEqual(E.right(serviceToken));
+      });
+    });
+
+    describe("when verifying the token fails", () => {
+      describe("due to the version changing", () => {
+        it("should return an error", () => {
+          const authToken = uuid();
+
+          const vXSmapiTokens = new JWTSmapiLoginTokens(
+            clock,
+            secret,
+            expiresIn,
+            uuid,
+            SMAPI_TOKEN_VERSION
+          );
+
+          const vXPlus1SmapiTokens = new JWTSmapiLoginTokens(
+            clock,
+            secret,
+            expiresIn,
+            () => uuid(),
+            SMAPI_TOKEN_VERSION + 1
+          );
+
+          const v1Token = vXSmapiTokens.issue(authToken);
+          expect(vXSmapiTokens.verify(v1Token)).toEqual(E.right(authToken));
+
+          const result = vXPlus1SmapiTokens.verify(v1Token);
+          expect(result).toEqual(
+            E.left(new InvalidTokenError("invalid signature"))
+          );
+        });
+      });
+      
+      describe("due to secret changing", () => {
+        it("should return an error", () => {
+          const authToken = uuid();
+
+          const smapiToken = new JWTSmapiLoginTokens(
+            clock,
+            "A different secret",
+            expiresIn
+          ).issue(authToken);
+
+          const result = smapiLoginTokens.verify(smapiToken);
+          expect(result).toEqual(
+            E.left(new InvalidTokenError("invalid signature"))
+          );
+        });
+      });
+
+      describe("due to key changing", () => {
+        it("should return an error", () => {
+          const authToken = uuid();
+
+          const smapiToken = smapiLoginTokens.issue(authToken);
+
+          const result = smapiLoginTokens.verify({
+            ...smapiToken,
+            key: "some other key",
+          });
+          expect(result).toEqual(
+            E.left(new InvalidTokenError("invalid signature"))
+          );
+        });
+      });
+    });
+
+    describe("when the token has expired", () => {
+      it("should return an ExpiredTokenError, with the authToken", () => {
+        const authToken = uuid();
+        const now = dayjs();
+        const tokenIssuedAt = now.subtract(31, "seconds");
+
+        const tokensWith30SecondExpiry = new JWTSmapiLoginTokens(
+          clock,
+          uuid(),
+          "30s"
+        );
+
+        clock.time = tokenIssuedAt;
+        const expiredToken = tokensWith30SecondExpiry.issue(authToken);
+
+        clock.time = now;
+
+        const result = tokensWith30SecondExpiry.verify(expiredToken);
+        expect(result).toEqual(
+          E.left(
+            new ExpiredTokenError(
+              authToken
+            )
+          )
+        );
+      });
+    });
+  });
+});

tests/sonos.test.ts

@@ -274,12 +274,13 @@ describe("sonos", () => {
 
   describe("when is disabled", () => {
     it("should return a disabled client", async () => {
-      const disabled = sonos({ auto: false });
+      const disabled = sonos({ enabled: false });
 
       expect(disabled).toEqual(SONOS_DISABLED);
       expect(await disabled.devices()).toEqual([]);
       expect(await disabled.services()).toEqual([]);
-      expect(await disabled.register(aService())).toEqual(true);
+      expect(await disabled.register(aService())).toEqual(false);
+      expect(await disabled.remove(123)).toEqual(false);
     });
   });
 
@@ -310,7 +311,7 @@ describe("sonos", () => {
         );
         sonosManager.InitializeWithDiscovery.mockResolvedValue(true);
 
-        const actualDevices = await sonos({ auto: true }).devices();
+        const actualDevices = await sonos({ enabled: true }).devices();
 
         expect(SonosManager).toHaveBeenCalledTimes(1);
         expect(sonosManager.InitializeWithDiscovery).toHaveBeenCalledWith(10);
@@ -331,7 +332,7 @@ describe("sonos", () => {
         );
         sonosManager.InitializeWithDiscovery.mockResolvedValue(true);
 
-        const actualDevices = await sonos({ auto: true, seedHost: "" }).devices();
+        const actualDevices = await sonos({ enabled: true, seedHost: "" }).devices();
 
         expect(SonosManager).toHaveBeenCalledTimes(1);
         expect(sonosManager.InitializeWithDiscovery).toHaveBeenCalledWith(10);
@@ -354,7 +355,7 @@ describe("sonos", () => {
         );
         sonosManager.InitializeFromDevice.mockResolvedValue(true);
 
-        const actualDevices = await sonos({ auto: true, seedHost }).devices();
+        const actualDevices = await sonos({ enabled: true, seedHost }).devices();
 
         expect(SonosManager).toHaveBeenCalledTimes(1);
         expect(sonosManager.InitializeFromDevice).toHaveBeenCalledWith(
@@ -377,7 +378,7 @@ describe("sonos", () => {
         );
         sonosManager.InitializeWithDiscovery.mockResolvedValue(true);
 
-        const actualDevices = await sonos({ auto: true, seedHost: undefined }).devices();
+        const actualDevices = await sonos({ enabled: true, seedHost: undefined }).devices();
 
         expect(actualDevices).toEqual([
           {
@@ -408,7 +409,7 @@ describe("sonos", () => {
         );
         sonosManager.InitializeWithDiscovery.mockResolvedValue(false);
 
-        expect(await sonos({ auto: true, seedHost: "" }).devices()).toEqual([]);
+        expect(await sonos({ enabled: true, seedHost: "" }).devices()).toEqual([]);
       });
     });
   });

tests/tsconfig.json

@@ -1,23 +1,23 @@
 {
-    "extends": "../tsconfig.json",
+  "extends": "../tsconfig.json",
-    "compilerOptions": {
+  "compilerOptions": {
-      "target": "es2019",
+    "target": "es2019",
-      "baseUrl": "./",
+    "baseUrl": "./",
-      "module": "commonjs",
+    "module": "commonjs",
-      "experimentalDecorators": true,
+    "experimentalDecorators": true,
-      "strictPropertyInitialization": false,
+    "strictPropertyInitialization": false,
-      "isolatedModules": false,
+    "isolatedModules": false,
-      "strict": true,
+    "strict": true,
-      "noImplicitAny": false,
+    "noImplicitAny": false,
-      "typeRoots" : [
+    "typeRoots" : [
-        "../typings",
+      "../typings",
-        "../node_modules/@types"
+      "../node_modules/@types"
-      ]
-    },
-    "exclude": [
-      "../node_modules"
-    ],
-    "include": [
-      "./**/*.ts"
     ]
-  }
+  },
+  "exclude": [
+    "../node_modules"
+  ],
+  "include": [
+    "./**/*.ts"
+  ]
+}

tsconfig.json

@@ -50,11 +50,11 @@
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     "typeRoots": [
       "./typings",
-      "node_modules/@types"
+      "./node_modules/@types"
     ]
      /* List of folders to include type definitions from. */,
     // "types": ["src/customTypes/scale-that-svg.d.ts"],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

web/icons/Heart-85038.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+    <path d="M16.5,3C13.605,3,12,5.09,12,5.09S10.395,3,7.5,3C4.462,3,2,5.462,2,8.5c0,4.171,4.912,8.213,6.281,9.49C9.858,19.46,12,21.35,12,21.35s2.142-1.89,3.719-3.36C17.088,16.713,22,12.671,22,8.5C22,5.462,19.538,3,16.5,3z M14.811,16.11c-0.177,0.16-0.331,0.299-0.456,0.416c-0.751,0.7-1.639,1.503-2.355,2.145c-0.716-0.642-1.605-1.446-2.355-2.145c-0.126-0.117-0.28-0.257-0.456-0.416C7.769,14.827,4,11.419,4,8.5C4,6.57,5.57,5,7.5,5c1.827,0,2.886,1.275,2.914,1.308L12,8l1.586-1.692C13.596,6.295,14.673,5,16.5,5C18.43,5,20,6.57,20,8.5C20,11.419,16.231,14.827,14.811,16.11z"/>
+</svg>

web/icons/Heart-85339.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+    <path d="M16.5,3C13.605,3,12,5.09,12,5.09S10.395,3,7.5,3C4.462,3,2,5.462,2,8.5c0,4.171,4.912,8.213,6.281,9.49C9.858,19.46,12,21.35,12,21.35s2.142-1.89,3.719-3.36C17.088,16.713,22,12.671,22,8.5C22,5.462,19.538,3,16.5,3z"/>
+</svg>

web/icons/Star-16101.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+    <path fill="none" stroke="#000" stroke-miterlimit="10" stroke-width="2" d="M16 4.587L19.486 12.407 28 13.306 21.64 19.037 23.416 27.413 16 23.135 8.584 27.413 10.36 19.037 4 13.306 12.514 12.407z"/>
+</svg>

web/icons/Star-43879.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16">
+  <path fill="none" stroke="#000" stroke-miterlimit="10" d="M8 2.25L9.701 6.283 13.875 6.738 10.753 9.686 11.631 14 8 11.788 4.369 14 5.247 9.686 2.125 6.738 6.299 6.283z"/>
+</svg>

web/icons/navidrome-radio.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+    <path d="M20 6H8.3l8.26-3.34L15.88 1 3.24 6.15C2.51 6.43 2 7.17 2 8v12c0 1.1.89 2 2 2h16c1.11 0 2-.9 2-2V8c0-1.11-.89-2-2-2zm0 2v3h-2V9h-2v2H4V8h16zM4 20v-7h16v7H4z"></path>
+    <circle cx="8" cy="16.48" r="2.5"></circle>
+</svg>

web/icons/yy.svg

@@ -0,0 +1,3 @@
+<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
+  <text x="50" y="75" font-size="65" text-anchor="middle" font-family="Arial, sans-serif" font-weight="bold">80s</text>
+</svg>

web/icons/yyyy.svg

@@ -0,0 +1,3 @@
+<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
+  <text x="50" y="65" font-size="35" text-anchor="middle" font-family="Arial, sans-serif" font-weight="bold">1980</text>
+</svg>

web/public/love-selected.svg

@@ -0,0 +1,4 @@
+<svg width="44" height="44" viewBox="0 0 44 44" fill="none"
+  xmlns="http://www.w3.org/2000/svg">
+  <path d="M26.4287 14.0097C25.1137 13.9677 23.7987 14.4057 22.7378 15.3397L22.2507 15.7707L21.7618 15.3377C19.6558 13.4727 16.4607 13.5687 14.4717 15.5577L14.4647 15.5657C12.5117 17.5177 12.5117 20.6837 14.4647 22.6367L21.8897 30.0607C22.0847 30.2567 22.4018 30.2567 22.5968 30.0607L29.8757 22.7817C31.8717 20.7867 31.9697 17.4207 29.9277 15.4747C28.9507 14.5427 27.6967 14.0437 26.4287 14.0097Z" fill="white"/>
+</svg>

web/public/love-unselected.svg

@@ -0,0 +1,4 @@
+<svg width="44" height="44" viewBox="0 0 44 44" fill="none"
+  xmlns="http://www.w3.org/2000/svg">
+  <path d="M28.5217 21.3077L22.2437 27.5867L15.8788 21.2227C14.5428 19.8857 14.7378 17.5727 16.4758 16.5097C17.7548 15.7267 19.4187 15.9657 20.5557 16.9447L20.7367 17.0997L21.9117 18.1417C22.1007 18.3097 22.3857 18.3097 22.5747 18.1417L23.7498 17.0997L24.0597 16.8307C25.4047 15.6457 27.4587 15.7457 28.6877 17.0637C29.8018 18.2567 29.6757 20.1537 28.5217 21.3077ZM26.4287 14.0097C25.1137 13.9677 23.7987 14.4057 22.7378 15.3397L22.2507 15.7707L21.7618 15.3377C19.6558 13.4727 16.4607 13.5687 14.4717 15.5577L14.4647 15.5657C12.5117 17.5177 12.5117 20.6837 14.4647 22.6367L21.8897 30.0607C22.0847 30.2567 22.4018 30.2567 22.5968 30.0607L29.8757 22.7817C31.8717 20.7867 31.9697 17.4207 29.9277 15.4747C28.9507 14.5427 27.6967 14.0437 26.4287 14.0097Z" fill="white" fill-opacity="0.6"/>
+</svg>

web/public/ratingIcons.html

@@ -0,0 +1,10 @@
+<html>
+  <body style="background-color: black;">
+    <img src="star0.svg" width="80px"><br>
+    <img src="star1.svg" width="80px"><br>
+    <img src="star2.svg" width="80px"><br>
+    <img src="star3.svg" width="80px"><br>
+    <img src="star4.svg" width="80px"><br>
+    <img src="star5.svg" width="80px"><br>
+  </body>
+</html>

web/public/star0.svg

@@ -0,0 +1,5 @@
+<svg version="1.1" baseProfile="basic" id="_x38_8"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 44 44" xml:space="preserve">
+	<path id="star" fill="#FFFFFF" d="M28,31l-6-4.3L16,31l2.6-6.8l-5.1-4.3h6l2.5-6.9l2.6,6.9h6l-5.1,4.3L28,31z"/>
+</svg>

web/public/star1.svg

@@ -0,0 +1,6 @@
+<svg version="1.1" baseProfile="basic" id="_x38_8"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 44 44" xml:space="preserve">
+	<path id="star" fill="#FBB040" d="M28,31l-6-4.3L16,31l2.6-6.8l-5.1-4.3h6l2.5-6.9l2.6,6.9h6l-5.1,4.3L28,31z"/>
+	<circle cx="22" cy="32" r="2" fill="#FBB040"/>
+</svg>

web/public/star2.svg

@@ -0,0 +1,7 @@
+<svg version="1.1" baseProfile="basic" id="_x38_8"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 44 44" xml:space="preserve">
+	<path id="star" fill="#FBB040" d="M28,31l-6-4.3L16,31l2.6-6.8l-5.1-4.3h6l2.5-6.9l2.6,6.9h6l-5.1,4.3L28,31z"/>
+	<circle cx="22" cy="32" r="2" fill="#FBB040"/>
+	<circle cx="14" cy="26" r="2" fill="#FBB040"/>
+</svg>

web/public/star3.svg

@@ -0,0 +1,8 @@
+<svg version="1.1" baseProfile="basic" id="_x38_8"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 44 44" xml:space="preserve">
+	<path id="star" fill="#FBB040" d="M28,31l-6-4.3L16,31l2.6-6.8l-5.1-4.3h6l2.5-6.9l2.6,6.9h6l-5.1,4.3L28,31z"/>
+	<circle cx="22" cy="32" r="2" fill="#FBB040"/>
+	<circle cx="14" cy="26" r="2" fill="#FBB040"/>
+	<circle cx="17" cy="16" r="2" fill="#FBB040"/>
+</svg>

web/public/star4.svg

@@ -0,0 +1,9 @@
+<svg version="1.1" baseProfile="basic" id="_x38_8"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 44 44" xml:space="preserve">
+	<path id="star" fill="#FBB040" d="M28,31l-6-4.3L16,31l2.6-6.8l-5.1-4.3h6l2.5-6.9l2.6,6.9h6l-5.1,4.3L28,31z"/>
+	<circle cx="22" cy="32" r="2" fill="#FBB040"/>
+	<circle cx="14" cy="26" r="2" fill="#FBB040"/>
+	<circle cx="17" cy="16" r="2" fill="#FBB040"/>
+	<circle cx="27" cy="16" r="2" fill="#FBB040"/>
+</svg>

web/public/star5.svg

@@ -0,0 +1,10 @@
+<svg version="1.1" baseProfile="basic" id="_x38_8"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 44 44" xml:space="preserve">
+	<path id="star" fill="#FBB040" d="M28,31l-6-4.3L16,31l2.6-6.8l-5.1-4.3h6l2.5-6.9l2.6,6.9h6l-5.1,4.3L28,31z"/>
+	<circle cx="22" cy="32" r="2" fill="#FBB040"/>
+	<circle cx="14" cy="26" r="2" fill="#FBB040"/>
+	<circle cx="17" cy="16" r="2" fill="#FBB040"/>
+	<circle cx="27" cy="16" r="2" fill="#FBB040"/>
+	<circle cx="30" cy="26" r="2" fill="#FBB040"/>
+</svg>