Bump libs (#179)

* Move stream destroy closer to where stream is retrieved

* Change BNB_SUBSONIC_URL to be of type URLBuilder to better handle URL construction rather than string concat, should addresse #169

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+FROM node:16-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,19 @@
+{
+    "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",
+    "features": {
+        "ghcr.io/devcontainers/features/docker-in-docker:1": {
+            "version": "latest",
+            "moby": true
+        }
+    }
+}

.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/setup-node@v1
+        uses: actions/checkout@v3
+      -
+        uses: actions/setup-node@v3
         with:
-          node-version: 16.6.x
-      - 
+          node-version: '16'
+      -
         run: yarn install
-      - 
+      -
         run: yarn 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
-        uses: docker/build-push-action@v2
+      -
+        name: Log in to GitHub Container registry
+        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

.yarnrc.yml

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

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16.6-alpine as build
+FROM node:16-bullseye-slim as build
 
 WORKDIR /bonob
 
@@ -16,22 +16,46 @@ COPY yarn.lock .
 COPY .yarnrc.yml .
 COPY .yarn/releases ./.yarn/releases
 
-RUN apk add --no-cache --update --virtual .gyp \
-        vips-dev \
+ENV JEST_TIMEOUT=60000
+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 && \
-    yarn gitinfo && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/* && \
+    yarn config set network-timeout 600000 -g && \
+    yarn install \
+        --prefer-offline \
+        --frozen-lockfile \
+        --non-interactive \
+        --production=false && \
     yarn test --no-cache && \
-    yarn build
+    yarn gitinfo && \
+    yarn build && \
+    rm -Rf node_modules && \
+    NODE_ENV=production yarn install \
+        --prefer-offline \
+        --pure-lockfile \
+        --non-interactive \
+        --production=true
 
 
+FROM node:16-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 BNB_PORT=4534
+ENV DEBIAN_FRONTEND=noninteractive
+ENV TZ=UTC
 
 EXPOSE $BNB_PORT
 
@@ -46,9 +70,18 @@ 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
 
-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

@@ -9,25 +9,39 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
 ## Features
 
 - 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
-- Artist Art
-- Album Art
+- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Recently Added Albums, Recently Played Albums, Most Played Albums
+- Artist & 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 supported currently, require translations for other languages).  [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-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 support for flacs using a specific player for the flac mimeType bonob/sonos
-- Ability to search by Album, Artist, Track
-- 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 | Laster build from master, probably works, however is currently under test in
+vX.Y.Z | Fixed release versions from tags, for those that want to pin to specific release
+
 
 ### Full sonos device auto-discovery and auto-registration using docker --network host
 
@@ -128,14 +142,18 @@ services:
       # ip address of your machine running bonob
       BNB_URL: http://192.168.1.111:4534  
       BNB_SECRET: changeme
-      BNB_SONOS_AUTO_REGISTER: true
-      BNB_SONOS_DEVICE_DISCOVERY: true
+      BNB_SONOS_AUTO_REGISTER: "true"
+      BNB_SONOS_DEVICE_DISCOVERY: "true"
       BNB_SONOS_SERVICE_ID: 246
       # ip address of one of your sonos devices
       BNB_SONOS_SEED_HOST: 192.168.1.121
       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
@@ -143,6 +161,10 @@ item | default value | description
 BNB_PORT | 4534 | Default http port for bonob to listen on
 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.**
 BNB_SECRET | bonob | secret used for encrypting credentials
+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
+BNB_LOG_LEVEL | info | Log level. One of ['debug', 'info', 'warn', 'error']
+BNB_DISABLE_PLAYLIST_ART | undefined | Disables playlist art generation, ie. when there are many playlists and art generation takes too long
+BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests
 BNB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup
 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.
 BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery
@@ -150,15 +172,17 @@ BNB_SONOS_SERVICE_NAME | bonob | service name for sonos
 BNB_SONOS_SERVICE_ID | 246 | service id for sonos
 BNB_SUBSONIC_URL | http://$(hostname):4533 | URL for subsonic clone
 BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. ie. "audio/flac,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.
+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 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 BNB_SONOS_SERVICE_NAME
@@ -169,6 +193,26 @@ BNB_ICON_BACKGROUND_COLOR | undefined | Icon background color in sonos app, must
 - You should now be able to play music on your sonos devices from you subsonic clone
 - Within the subsonic clone a new player will be created, 'bonob (username)', so you can configure transcoding specifically for sonos
 
+## 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
@@ -176,11 +220,9 @@ BNB_ICON_BACKGROUND_COLOR | undefined | Icon background color in sonos app, must
 
 ## A note on transcoding
 
-tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track.  Transcoding to flac works however, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below).
+tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track.  However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below).
 
-Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/).  When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track. 
-
-## Cusomisation
+Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/).  When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track.
 
 ### Audio File type specific transcoding options within Subsonic
 
@@ -192,10 +234,16 @@ In this case you could set;
 BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
 ```
 
-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);
+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 aresample=resampler=soxr:out_sample_fmt=s16:out_sample_rate=48000 -f flac -
+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 -
 ```
 
 ### Changing Icon colors
@@ -214,10 +262,20 @@ ffmpeg -i %s -af aresample=resampler=soxr:out_sample_fmt=s16:out_sample_rate=480
 
 ![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

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,66 @@
   "author": "simojenki <simojenki@users.noreply.github.com>",
   "license": "GPL-3.0-only",
   "dependencies": {
-    "@svrooij/sonos": "^2.4.0",
-    "@types/express": "^4.17.13",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^16.7.13",
-    "@types/sharp": "^0.28.6",
-    "@types/underscore": "^1.11.3",
-    "@types/uuid": "^8.3.1",
-    "axios": "^0.21.4",
-    "dayjs": "^1.10.6",
-    "eta": "^1.12.3",
-    "express": "^4.17.1",
-    "fp-ts": "^2.11.1",
-    "libxmljs2": "^0.28.0",
+    "@svrooij/sonos": "^2.5.0",
+    "@types/express": "^4.17.19",
+    "@types/fs-extra": "^11.0.2",
+    "@types/jsonwebtoken": "^9.0.3",
+    "@types/jws": "^3.2.6",
+    "@types/morgan": "^1.9.6",
+    "@types/node": "^16.11.7",
+    "@types/randomstring": "^1.1.9",
+    "@types/underscore": "^1.11.11",
+    "@types/uuid": "^9.0.5",
+    "@types/xmldom": "0.1.32",
+    "axios": "^1.5.1",
+    "dayjs": "^1.11.10",
+    "eta": "^2.0.1",
+    "express": "^4.18.2",
+    "fp-ts": "^2.16.1",
+    "fs-extra": "^11.1.1",
+    "jsonwebtoken": "^9.0.2",
+    "jws": "^4.0.0",
+    "libxmljs2": "^0.32.0",
     "morgan": "^1.10.0",
-    "node-html-parser": "^4.1.4",
-    "sharp": "^0.29.1",
-    "soap": "^0.42.0",
-    "ts-md5": "^1.2.9",
-    "typescript": "^4.4.2",
-    "underscore": "^1.13.1",
-    "uuid": "^8.3.2",
-    "winston": "^3.3.3",
-    "x2js": "^3.4.2"
+    "node-html-parser": "^6.1.10",
+    "randomstring": "^1.3.0",
+    "sharp": "^0.32.6",
+    "soap": "^1.0.0",
+    "ts-md5": "^1.3.1",
+    "typescript": "^5.2.2",
+    "underscore": "^1.13.6",
+    "urn-lib": "^2.0.0",
+    "uuid": "^9.0.1",
+    "winston": "^3.11.0",
+    "xmldom-ts": "^0.3.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.2.21",
-    "@types/jest": "^27.0.1",
-    "@types/mocha": "^9.0.0",
-    "@types/supertest": "^2.0.11",
-    "chai": "^4.3.4",
-    "get-port": "^5.1.1",
-    "image-js": "^0.33.0",
-    "jest": "^27.1.0",
-    "nodemon": "^2.0.12",
-    "supertest": "^6.1.6",
-    "ts-jest": "^27.0.5",
+    "@types/chai": "^4.3.7",
+    "@types/jest": "^29.5.5",
+    "@types/mocha": "^10.0.2",
+    "@types/supertest": "^2.0.14",
+    "@types/tmp": "^0.2.4",
+    "chai": "^4.3.10",
+    "get-port": "^7.0.0",
+    "image-js": "^0.35.4",
+    "jest": "^29.7.0",
+    "nodemon": "^3.0.1",
+    "supertest": "^6.3.3",
+    "tmp": "^0.2.1",
+    "ts-jest": "^29.1.1",
     "ts-mockito": "^2.6.1",
-    "ts-node": "^10.2.1",
+    "ts-node": "^10.9.1",
     "xmldom-ts": "^0.3.1",
     "xpath-ts": "^1.3.13"
   },
   "scripts": {
     "clean": "rm -Rf build node_modules",
     "build": "tsc",
-    "dev": "BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true nodemon -V ./src/app.ts",
-    "devr": "BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true nodemon -V ./src/app.ts",
-    "register-dev": "ts-node ./src/register.ts http://$(hostname):4534",
+    "dev": "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": "BNB_DISABLE_PLAYLIST_ART=true BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey 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://${BNB_DEV_HOST_IP}:4534",
     "test": "jest",
     "gitinfo": "git describe --tags > .gitinfo"
-  }
+  },
+  "packageManager": "yarn@1.22.19"
 }

src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl

@@ -2059,7 +2059,7 @@
 
     <wsdl:service name="Sonos">
         <wsdl:port name="SonosSoap" binding="tns:SonosSoap">
-		<soap:address location="http://moapi.sonos.com/Test/TestService.php"/>
+		<soap:address location="/about"/>
         </wsdl:port>
     </wsdl:service>
 

src/access_tokens.ts

@@ -1,116 +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";
-import { b64Encode, b64Decode } from "./b64";
-
-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 =>
-    b64Encode(JSON.stringify(this.encryption.encrypt(authToken)));
-
-  authTokenFor(value: string): string | undefined {
-    try {
-      return this.encryption.decrypt(
-        JSON.parse(b64Decode(value))
-      );
-    } 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,26 @@ import path from "path";
 import fs from "fs";
 import server from "./server";
 import logger from "./logger";
-import { appendMimeTypeToClientFor, DEFAULT, Subsonic } from "./subsonic";
-import encryption from "./encryption";
-import { InMemoryAccessTokens, sha256 } from "./access_tokens";
+
+import {
+  appendMimeTypeToClientFor,
+  axiosImageFetcher,
+  cachingImageFetcher,
+  DEFAULT,
+  Subsonic,
+} from "./subsonic";
+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 { 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,
@@ -28,16 +36,21 @@ const streamUserAgent = config.subsonic.customClientsFor
   ? appendMimeTypeToClientFor(config.subsonic.customClientsFor.split(","))
   : DEFAULT;
 
+const artistImageFetcher = config.subsonic.artistImageCache
+  ? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
+  : axiosImageFetcher;
+
 const subsonic = new Subsonic(
   config.subsonic.url,
-  encryption(config.secret),
-  streamUserAgent
+  streamUserAgent,
+  artistImageFetcher
 );
 
 const featureFlagAwareMusicService: MusicService = {
   generateToken: subsonic.generateToken,
-  login: (authToken: string) =>
-    subsonic.login(authToken).then((library) => {
+  refreshToken: subsonic.refreshToken,
+  login: (serviceToken: string) =>
+    subsonic.login(serviceToken).then((library) => {
       return {
         ...library,
         scrobble: (id: string) => {
@@ -60,7 +73,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 +84,18 @@ const app = server(
   featureFlagAwareMusicService,
   {
     linkCodes: () => new InMemoryLinkCodes(),
-    accessTokens: () =>  new InMemoryAccessTokens(sha256(config.secret)),
-    clock: SystemClock,
+    apiTokens: () => new InMemoryAPITokens(sha256(config.secret)),
+    clock,
     iconColors: config.icons,
     applyContextPath: true,
-    logRequests: true,
-    version
+    logRequests: config.logRequests,
+    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 +107,21 @@ if (config.sonos.autoRegister) {
       );
     }
   });
-} else if(config.sonos.discovery.enabled) {
-  sonosSystem.devices().then(devices => {
-    devices.forEach(d => {
-      logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`)
-    })
-  })
-}
+} else if (config.sonos.discovery.enabled) {
+  sonosSystem.devices().then((devices) => {
+    devices.forEach((d) => {
+      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/burn.ts

@@ -0,0 +1,90 @@
+import _ from "underscore";
+import { createUrnUtil } from "urn-lib";
+import randomstring from "randomstring";
+
+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 parse(encryptor.decrypt(x.resource));
+  } 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;
-export const isMay4 = (clock: Clock = SystemClock) => clock.now().month() == 4 && clock.now().date() == 4;
-export const isHalloween = (clock: Clock = SystemClock) => clock.now().month() == 9 && clock.now().date() == 31
-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
-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
-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 fixedDateMonthEvent(dateMonth: string) {
+  const date = Number.parseInt(dateMonth.split("/")[0]!);
+  const month = Number.parseInt(dateMonth.split("/")[1]!);
+  return (clock: Clock = SystemClock) => {
+    return clock.now().date() == date && clock.now().month() == month - 1;
+  };
+}
+
+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

@@ -3,21 +3,24 @@ import logger from "./logger";
 import url from "./url_builder";
 
 export const WORD = /^\w+$/;
+export const COLOR = /^#?\w+$/;
 
-type EnvVarOpts = {
-  default: string | undefined;
+type EnvVarOpts<T> = {
+  default: T | undefined;
   legacy: string[] | undefined;
   validationPattern: RegExp | undefined;
+  parser: ((value: string) => T) | undefined
 };
 
-export function envVar(
+export function envVar<T>(
   name: string,
-  opts: Partial<EnvVarOpts> = {
+  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);
@@ -35,17 +38,28 @@ export function envVar(
     logger.warn(`Configuration key '${result.key}' is deprecated, replace with '${name}'`)
   }
 
-  return result?.value || opts.default;
+  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 = (key: string, opts: Partial<EnvVarOpts> = {}) =>
+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 = +bnbEnvVar("PORT", { default: "4534" })!;
+  const port = bnbEnvVar<number>("PORT", { default: 4534, parser: asInt })!;
   const bonobUrl = bnbEnvVar("URL", {
     legacy: ["BONOB_WEB_ADDRESS"],
     default: `http://${hostname()}:${port}`,
@@ -61,32 +75,35 @@ export default function () {
   return {
     port,
     bonobUrl: url(bonobUrl),
-    secret: bnbEnvVar("SECRET", { default: "bonob" })!,
+    secret: bnbEnvVar<string>("SECRET", { default: "bonob" })!,
+    authTimeout: bnbEnvVar<string>("AUTH_TIMEOUT", { default: "1h" })!,
     icons: {
-      foregroundColor: bnbEnvVar("ICON_FOREGROUND_COLOR", {
-        validationPattern: WORD,
+      foregroundColor: bnbEnvVar<string>("ICON_FOREGROUND_COLOR", {
+        validationPattern: COLOR,
       }),
-      backgroundColor: bnbEnvVar("ICON_BACKGROUND_COLOR", {
-        validationPattern: WORD,
+      backgroundColor: bnbEnvVar<string>("ICON_BACKGROUND_COLOR", {
+        validationPattern: COLOR,
       }),
     },
+    logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
     sonos: {
-      serviceName: bnbEnvVar("SONOS_SERVICE_NAME", { default: "bonob" })!,
+      serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
       discovery: {
         enabled:
-          bnbEnvVar("SONOS_DEVICE_DISCOVERY", { default: "true" }) == "true",
-        seedHost: bnbEnvVar("SONOS_SEED_HOST"),
+          bnbEnvVar<boolean>("SONOS_DEVICE_DISCOVERY", { default: true, parser: asBoolean }),
+        seedHost: bnbEnvVar<string>("SONOS_SEED_HOST"),
       },
       autoRegister:
-        bnbEnvVar("SONOS_AUTO_REGISTER", { default: "false" }) == "true",
-      sid: Number(bnbEnvVar("SONOS_SERVICE_ID", { default: "246" })),
+        bnbEnvVar<boolean>("SONOS_AUTO_REGISTER", { default: false, parser: asBoolean }),
+      sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
     },
     subsonic: {
-      url: bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!,
-      customClientsFor: bnbEnvVar("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
+      url: url(bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!),
+      customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
+      artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"),
     },
-    scrobbleTracks: bnbEnvVar("SCROBBLE_TRACKS", { default: "true" }) == "true",
+    scrobbleTracks: bnbEnvVar<boolean>("SCROBBLE_TRACKS", { default: true, parser: asBoolean }),
     reportNowPlaying:
-      bnbEnvVar("REPORT_NOW_PLAYING", { default: "true" }) == "true",
+      bnbEnvVar<boolean>("REPORT_NOW_PLAYING", { default: true, parser: asBoolean }),
   };
 }

src/encryption.ts

@@ -1,33 +1,65 @@
-import { createCipheriv, createDecipheriv, randomBytes, createHash } from "crypto";
+import {
+  createCipheriv,
+  createDecipheriv,
+  randomBytes,
+  createHash,
+} from "crypto";
 
-const ALGORITHM = "aes-256-cbc"
+import jws from "jws";
+
+const ALGORITHM = "aes-256-cbc";
 const IV = randomBytes(16);
 
+
 export type Hash = {
-  iv: string,
-  encryptedData: string
-}
+  iv: string;
+  encryptedData: string;
+};
 
 export type Encryption = {
-  encrypt: (value:string) => Hash
-  decrypt: (hash: Hash) => string
-}
+  encrypt: (value: string) => string;
+  decrypt: (value: string) => string;
+};
 
-const encryption = (secret: string): Encryption => {
-  const key = createHash('sha256').update(String(secret)).digest('base64').substr(0, 32);
+export const jwsEncryption = (secret: string): Encryption => {
   return {
-    encrypt: (value: string) => {
-      const cipher = createCipheriv(ALGORITHM, key, IV);
-      return { 
-        iv: IV.toString("hex"), 
-        encryptedData: Buffer.concat([cipher.update(value), cipher.final()]).toString("hex") 
-      };
-    },
-    decrypt: (hash: Hash) => {
-      const decipher = createDecipheriv(ALGORITHM, key, Buffer.from(hash.iv, 'hex'));
-      return Buffer.concat([decipher.update(Buffer.from(hash.encryptedData, 'hex')), decipher.final()]).toString();
-    }
+    encrypt: (value: string) => jws.sign({
+      header: { alg: 'HS256' },
+      payload: value,
+      secret: secret,
+    }),
+    decrypt: (value: string) => jws.decode(value).payload
   }
 }
 
-export default encryption;
+export const cryptoEncryption = (secret: string): Encryption => {
+  const key = createHash("sha256")
+    .update(String(secret))
+    .digest("base64")
+    .substr(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) => {
+      const parts = value.split(".");
+      if(parts.length != 2) throw `Invalid value to decrypt`;
+
+      const decipher = createDecipheriv(
+        ALGORITHM,
+        key,
+        Buffer.from(parts[0]!, "hex")
+      );
+      return Buffer.concat([
+        decipher.update(Buffer.from(parts[1]!, "hex")),
+        decipher.final(),
+      ]).toString();
+    },
+  };
+};
+
+export default jwsEncryption;

src/i8n.ts

@@ -4,7 +4,7 @@ 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"
@@ -12,7 +12,7 @@ export type KEY =
   | "playlists"
   | "genres"
   | "random"
-  | "starred"
+  | "topRated"
   | "recentlyAdded"
   | "recentlyPlayed"
   | "mostPlayed"
@@ -37,7 +37,14 @@ export type KEY =
   | "invalidLinkCode"
   | "loginSuccessful"
   | "loginFailed" 
-  | "noSonosDevices";
+  | "noSonosDevices" 
+  | "favourites"
+  | "LOVE"
+  | "LOVE_SUCCESS"
+  | "STAR" 
+  | "UNSTAR"
+  | "STAR_SUCCESS"
+  | "UNSTAR_SUCCESS";
 
 const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
   "en-US": {
@@ -48,7 +55,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     playlists: "Playlists",
     genres: "Genres",
     random: "Random",
-    starred: "Starred",
+    topRated: "Top Rated",
     recentlyAdded: "Recently added",
     recentlyPlayed: "Recently played",
     mostPlayed: "Most played",
@@ -73,6 +80,95 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     loginSuccessful: "Login successful!",
     loginFailed: "Login failed!",
     noSonosDevices: "No sonos devices",
+    favourites: "Favourites",
+    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",
+    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",
+    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",
+    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",
+    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 $BNB_SONOS_SERVICE_NAME",
@@ -82,7 +178,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     playlists: "Afspeellijsten",
     genres: "Genres",
     random: "Willekeurig",
-    starred: "Favorieten",
+    topRated: "Best beoordeeld",
     recentlyAdded: "Onlangs toegevoegd",
     recentlyPlayed: "Onlangs afgespeeld",
     mostPlayed: "Meest afgespeeld",
@@ -107,6 +203,13 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     loginSuccessful: "Inloggen gelukt!",
     loginFailed: "Inloggen mislukt!",
     noSonosDevices: "Geen Sonos-apparaten",
+    favourites: "Favorieten",
+    STAR: "Ster ",
+    UNSTAR: "Een ster",
+    STAR_SUCCESS: "Nummer met ster",
+    UNSTAR_SUCCESS: "Track zonder ster",
+    LOVE: "Liefde",
+    LOVE_SUCCESS: "Volg geliefd"
   },
 };
 

src/icon.ts

@@ -166,7 +166,7 @@ export type ICON =
   | "playlists"
   | "genres"
   | "random"
-  | "starred"
+  | "topRated"
   | "recentlyAdded"
   | "recentlyPlayed"
   | "mostPlayed"
@@ -225,7 +225,10 @@ export type ICON =
   | "skywalker"
   | "leia"
   | "r2d2"
-  | "yoda";
+  | "yoda" 
+  | "heart"
+  | "star" 
+  | "solidStar";
 
 const iconFrom = (name: string) =>
   new SvgIcon(
@@ -241,7 +244,7 @@ export const ICONS: Record<ICON, SvgIcon> = {
   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 +303,9 @@ 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")
 };
 
 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_service.ts

@@ -1,48 +1,29 @@
+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 = {
-  message: string;
+export class AuthFailure extends Error {
+  constructor(message: string) {
+    super(message);
+  }
 };
 
 export type ArtistSummary = {
-  id: string;
+  id: string | undefined;
   name: string;
-};
-
-export type Images = {
-  small: string | undefined;
-  medium: string | undefined;
-  large: string | undefined;
-};
-
-export const NO_IMAGES: Images = {
-  small: undefined,
-  medium: undefined,
-  large: undefined,
+  image: BUrn | undefined;
 };
 
 export type SimilarArtist = ArtistSummary & { inLibrary: boolean };
 
 export type Artist = ArtistSummary & {
-  image: Images
   albums: AlbumSummary[];
   similarArtists: SimilarArtist[]
 };
@@ -52,10 +33,10 @@ export type AlbumSummary = {
   name: string;
   year: string | undefined;
   genre: Genre | undefined;
-  coverArt: string | undefined;
+  coverArt: BUrn | undefined;
 
-  artistName: string;
-  artistId: string;
+  artistName: string | undefined;
+  artistId: string | undefined;
 };
 
 export type Album = AlbumSummary & {};
@@ -65,6 +46,11 @@ export type Genre = {
   id: string;
 }
 
+export type Rating = {
+  love: boolean;
+  stars: number;
+}
+
 export type Track = {
   id: string;
   name: string;
@@ -72,9 +58,10 @@ export type Track = {
   duration: number;
   number: number | undefined;
   genre: Genre | undefined;
-  coverArt: string | undefined;
+  coverArt: BUrn | undefined;
   album: AlbumSummary;
   artist: ArtistSummary;
+  rating: Rating;
 };
 
 export type Paging = {
@@ -101,7 +88,7 @@ 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' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
 
 export type AlbumQuery = Paging & {
   type: AlbumQueryType;
@@ -111,6 +98,7 @@ export type AlbumQuery = Paging & {
 export const artistToArtistSummary = (it: Artist): ArtistSummary => ({
   id: it.id,
   name: it.name,
+  image: it.image
 });
 
 export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
@@ -158,8 +146,9 @@ export const asArtistAlbumPairs = (artists: Artist[]): [Artist, Album][] =>
   );
 
 export interface MusicService {
-  generateToken(credentials: Credentials): Promise<AuthSuccess | AuthFailure>;
-  login(authToken: string): Promise<MusicLibrary>;
+  generateToken(credentials: Credentials): TE.TaskEither<AuthFailure, AuthSuccess>;
+  refreshToken(serviceToken: string): TE.TaskEither<AuthFailure, AuthSuccess>;
+  login(serviceToken: string): Promise<MusicLibrary>;
 }
 
 export interface MusicLibrary {
@@ -177,7 +166,8 @@ export interface MusicLibrary {
     trackId: string;
     range: string | undefined;
   }): Promise<TrackStream>;
-  coverArt(id: string, 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[]>;

src/random_string.ts

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

src/server.ts

@@ -1,9 +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";
 
@@ -17,11 +18,13 @@ import {
   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_service";
 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";
@@ -31,6 +34,12 @@ import { Icon, ICONS, festivals, features } from "./icon";
 import _, { shuffle } 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";
 
@@ -73,7 +82,7 @@ export class RangeBytesFromFilter extends Transform {
 
 export type ServerOpts = {
   linkCodes: () => LinkCodes;
-  accessTokens: () => AccessTokens;
+  apiTokens: () => APITokens;
   clock: Clock;
   iconColors: {
     foregroundColor: string | undefined;
@@ -82,16 +91,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(
@@ -104,9 +121,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);
 
@@ -115,8 +135,7 @@ function server(
   }
   app.use(express.urlencoded({ extended: false }));
 
-  // todo: pass options in here?
-  app.use(express.static("./web/public"));
+  app.use(express.static(path.resolve(__dirname, "..", "web", "public")));
   app.engine("eta", Eta.renderFile);
 
   app.set("view engine", "eta");
@@ -150,7 +169,7 @@ function server(
           removeRegistrationRoute: bonobUrl
             .append({ pathname: REMOVE_REGISTRATION_ROUTE })
             .pathname(),
-          version: opts.version,
+          version: serverOpts.version || DEFAULT_SERVER_OPTS.version,
         });
       }
     );
@@ -212,28 +231,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({
-        username,
-        password,
-      });
-      if (isSuccess(authResult)) {
-        linkCodes.associate(linkCode, authResult);
-        res.render("success", {
-          lang,
-          message: lang("loginSuccessful"),
-        });
-      } else {
-        res.status(403).render("failure", {
-          lang,
-          message: lang("loginFailed"),
-          cause: authResult.message,
-        });
-      }
+      return pipe(
+        musicService.generateToken({
+          username,
+          password,
+        }),
+        TE.match(
+          (e: AuthFailure) => ({
+            status: 403,
+            template: "failure",
+            params: {
+              lang,
+              message: lang("loginFailed"),
+              cause: e.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)
+      );
     }
   });
 
@@ -253,15 +285,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) =>
-                `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-            ).join("")}
+      (size) =>
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+    ).join("")}
           </imageSizeMap>
         </Match>
       </PresentationMap>
@@ -270,9 +338,9 @@ function server(
           <browseIconSizeMap>
               <sizeEntry size="0" substitution="/size/legacy"/>
               ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
-                (size) =>
-                  `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-              ).join("")}
+      (size) =>
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+    ).join("")}
             </browseIconSizeMap>
         </Match>
       </PresentationMap>
@@ -285,6 +353,20 @@ 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>`);
   });
 
@@ -292,42 +374,56 @@ function server(
     const id = req.params["id"]!;
     const trace = uuid();
 
-    logger.info(
-      `${trace} bnb<- ${req.method} ${req.path}?${
-        JSON.stringify(req.query)
-      }, 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.query[BONOB_ACCESS_TOKEN_HEADER] as string,
-      O.fromNullable,
-      O.map((accessToken) => accessTokens.authTokenFor(accessToken)),
-      O.getOrElseW(() => undefined)
-    );
-    if (!authToken) {
+
+    const serviceToken = pipe(
+      E.fromNullable("Missing bnbt header")(req.headers["bnbt"] as string),
+      E.chain(token => pipe(
+        E.fromNullable("Missing bnbk header")(req.headers["bnbk"] as string),
+        E.map(key => ({ token, key }))
+      )),
+      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(({ stream }) => {
-          logger.info(
-            `${trace} bnb<- stream response from music service for ${id}, status=${
-              stream.status
-            }, headers=(${JSON.stringify(stream.headers)})`
+        .then(({ musicLibrary, stream }) => {
+          logger.debug(
+            `${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
           );
 
           const sonosisfyContentType = (contentType: string) =>
             contentType
               .split(";")
               .map((it) => it.trim())
-              .map((it) => sonosifyMimeType(it))
+              .map(sonosifyMimeType)
               .join("; ");
 
           const respondWith = ({
@@ -335,25 +431,30 @@ function server(
             filter,
             headers,
             sendStream,
+            nowPlaying,
           }: {
             status: number;
             filter: Transform;
             headers: Record<string, string>;
             sendStream: boolean;
+            nowPlaying: boolean;
           }) => {
-            logger.info(
-              `${trace} bnb-> ${
-                req.path
-              }, status=${status}, headers=${JSON.stringify(headers)}`
+            logger.debug(
+              `${trace} bnb-> ${req.path}, status=${status}, headers=${JSON.stringify(headers)}`
             );
-            res.status(status);
-            Object.entries(headers)
-              .filter(([_, v]) => v !== undefined)
-              .forEach(([header, value]) => {
-                res.setHeader(header, value!);
-              });
-            if (sendStream) stream.stream.pipe(filter).pipe(res);
-            else res.send();
+            (nowPlaying
+              ? musicLibrary.nowPlaying(id)
+              : Promise.resolve(true)
+            ).then((_) => {
+              res.status(status);
+              Object.entries(headers)
+                .filter(([_, v]) => v !== undefined)
+                .forEach(([header, value]) => {
+                  res.setHeader(header, value!);
+                });
+              if (sendStream) stream.stream.pipe(filter).pipe(res)
+              else res.send()
+            });
           };
 
           if (stream.status == 200) {
@@ -368,6 +469,7 @@ function server(
                 "accept-ranges": stream.headers["accept-ranges"],
               },
               sendStream: req.method == "GET",
+              nowPlaying: req.method == "GET",
             });
           } else if (stream.status == 206) {
             respondWith({
@@ -382,6 +484,7 @@ function server(
                 "accept-ranges": stream.headers["accept-ranges"],
               },
               sendStream: req.method == "GET",
+              nowPlaying: req.method == "GET",
             });
           } else {
             respondWith({
@@ -389,6 +492,7 @@ function server(
               filter: new PassThrough(),
               headers: {},
               sendStream: req.method == "GET",
+              nowPlaying: false,
             });
           }
         });
@@ -411,15 +515,15 @@ function server(
       const spec =
         size == "legacy"
           ? {
-              mimeType: "image/png",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
-                sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
-            }
+            mimeType: "image/png",
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
+              sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
+          }
           : {
-              mimeType: "image/svg+xml",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
-                Promise.resolve(svg),
-            };
+            mimeType: "image/svg+xml",
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
+              Promise.resolve(svg),
+          };
 
       return Promise.resolve(
         icon
@@ -466,22 +570,32 @@ function server(
     "centre",
   ];
 
-  app.get("/art/:ids/size/:size", (req, res) => {
-    const authToken = accessTokens.authTokenFor(
+  app.get("/art/:burns/size/:size", (req, res) => {
+    const serviceToken = apiTokens.authTokenFor(
       req.query[BONOB_ACCESS_TOKEN_HEADER] as string
     );
-    const ids = req.params["ids"]!.split("&");
+    const urns = req.params["burns"]!.split("&").map(parse);
     const size = Number.parseInt(req.params["size"]!);
 
-    if (!authToken) {
+    if (!serviceToken) {
       return res.status(401).send();
     } else if (!(size > 0)) {
       return res.status(400).send();
     }
 
     return musicService
-      .login(authToken)
-      .then((it) => Promise.all(ids.map((id) => it.coverArt(id, size))))
+      .login(serviceToken)
+      .then((musicLibrary) =>
+        Promise.all(
+          urns.map((it) => {
+            if (it.system == "external") {
+              return serverOpts.externalImageResolver(it.resource);
+            } else {
+              return musicLibrary.coverArt(it, size);
+            }
+          })
+        )
+      )
       .then((coverArts) => coverArts.filter((it) => it))
       .then(shuffle)
       .then((coverArts) => {
@@ -519,7 +633,7 @@ function server(
         }
       })
       .catch((e: Error) => {
-        logger.error(`Failed fetching image ${ids.join("&")}/size/${size}`, {
+        logger.error(`Failed fetching image ${urns.join("&")}/size/${size}`, {
           cause: e,
         });
         return res.status(500).send();
@@ -532,9 +646,10 @@ function server(
     bonobUrl,
     linkCodes,
     musicService,
-    accessTokens,
+    apiTokens,
     clock,
-    i8n
+    i8n,
+    serverOpts.smapiAuthTokens
   );
 
   if (serverOpts.applyContextPath) {

src/smapi.ts

@@ -3,6 +3,9 @@ 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";
@@ -14,15 +17,24 @@ import {
   Genre,
   MusicService,
   Playlist,
+  Rating,
   slice2,
   Track,
 } from "./music_service";
-import { AccessTokens } from "./access_tokens";
+import { APITokens } from "./api_tokens";
 import { Clock } from "./clock";
 import { URLBuilder } from "./url_builder";
 import { asLANGs, I8N } from "./i8n";
 import { ICON, iconForGenre } from "./icon";
-import { uniq } from "underscore";
+import _, { uniq } 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";
@@ -54,6 +66,7 @@ const WSDL_FILE = path.resolve(
 export type Credentials = {
   loginToken: {
     token: string;
+    key: string;
     householdId: string;
   };
   deviceId: string;
@@ -80,6 +93,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";
@@ -137,10 +157,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 {
@@ -169,10 +198,13 @@ class SonosSoap {
   }): GetDeviceAuthTokenResult {
     const association = this.linkCodes.associationFor(linkCode);
     if (association) {
+      const smapiAuthToken = this.smapiAuthTokens.issue(
+        association.serviceToken
+      );
       return {
         getDeviceAuthTokenResult: {
-          authToken: association.authToken,
-          privateKey: "",
+          authToken: smapiAuthToken.token,
+          privateKey: smapiAuthToken.key,
           userInfo: {
             nickname: association.nickname,
             userIdHashCode: crypto
@@ -234,25 +266,39 @@ export const playlistAlbumArtURL = (
   bonobUrl: URLBuilder,
   playlist: Playlist
 ) => {
-  const ids = uniq(
-    playlist.entries.map((it) => it.coverArt).filter((it) => it)
-  );
-  if (ids.length == 0) {
+  // todo: this should be put into config, or even just removed for the ND music source
+  if(process.env["BNB_DISABLE_PLAYLIST_ART"]) return iconArtURI(bonobUrl, "music");
+
+  const burns: BUrn[] = uniq(
+    playlist.entries.filter((it) => it.coverArt != undefined),
+    (it) => it.album.id
+  ).map((it) => it.coverArt!);
+  if (burns.length == 0) {
     return iconArtURI(bonobUrl, "error");
   } else {
     return bonobUrl.append({
-      pathname: `/art/${ids.slice(0, 9).join("&")}/size/180`,
+      pathname: `/art/${burns
+        .slice(0, 9)
+        .map((it) => encodeURIComponent(formatForURL(it)))
+        .join("&")}/size/180`,
     });
   }
 };
 
 export const defaultAlbumArtURI = (
   bonobUrl: URLBuilder,
-  { coverArt }: { coverArt: string | undefined }
+  { coverArt }: { coverArt: BUrn | undefined }
 ) =>
-  coverArt
-    ? bonobUrl.append({ pathname: `/art/${coverArt}/size/180` })
-    : iconArtURI(bonobUrl, "vinyl");
+  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) =>
   bonobUrl.append({
@@ -262,7 +308,17 @@ export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) =>
 export const defaultArtistArtURI = (
   bonobUrl: URLBuilder,
   artist: ArtistSummary
-) => bonobUrl.append({ pathname: `/art/artist:${artist.id}/size/180` });
+) =>
+  pipe(
+    artist.image,
+    O.fromNullable,
+    O.map((it) =>
+      bonobUrl.append({
+        pathname: `/art/${encodeURIComponent(formatForURL(it))}/size/180`,
+      })
+    ),
+    O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
+  );
 
 export const sonosifyMimeType = (mimeType: string) =>
   mimeType == "audio/x-flac" ? "audio/flac" : mimeType;
@@ -291,15 +347,18 @@ export const track = (bonobUrl: URLBuilder, track: Track) => ({
     album: track.album.name,
     albumId: `album:${track.album.id}`,
     albumArtist: track.artist.name,
-    albumArtistId: `artist:${track.artist.id}`,
+    albumArtistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
     albumArtURI: defaultAlbumArtURI(bonobUrl, track).href(),
     artist: track.artist.name,
-    artistId: `artist:${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) => ({
@@ -310,39 +369,6 @@ export const artist = (bonobUrl: URLBuilder, artist: ArtistSummary) => ({
   albumArtURI: defaultArtistArtURI(bonobUrl, artist).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) => ({
@@ -356,17 +382,28 @@ 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({
@@ -375,6 +412,67 @@ function bindSmapiSoapServiceToExpress(
       },
     });
 
+  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,
@@ -392,31 +490,72 @@ 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(({ credentials, type, typeId }) => ({
                 getMediaURIResult: bonobUrl
                   .append({
                     pathname: `/stream/${type}/${typeId}`,
-                    searchParams: { "bat": accessToken }
                   })
                   .href(),
+                httpHeaders: [
+                  {
+                    httpHeader: {
+                      header: "bnbt",
+                      value: credentials.loginToken.token,
+                    },
+                  },
+                  {
+                    httpHeader: {
+                      header: "bnbk",
+                      value: credentials.loginToken.key,
+                    },
+                  },
+                ],
               })),
           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, typeId }) =>
                 musicLibrary.track(typeId!).then((it) => ({
-                  getMediaMetadataResult: track(urlWithToken(accessToken), it),
+                  getMediaMetadataResult: track(urlWithToken(apiKey), it),
                 }))
               ),
           search: async (
@@ -424,16 +563,16 @@ function bindSmapiSoapServiceToExpress(
             _,
             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)
                         ),
                       })
                     );
@@ -442,7 +581,7 @@ function bindSmapiSoapServiceToExpress(
                       searchResult({
                         count: it.length,
                         mediaCollection: it.map((artistSummary) =>
-                          artist(urlWithToken(accessToken), artistSummary)
+                          artist(urlWithToken(apiKey), artistSummary)
                         ),
                       })
                     );
@@ -451,7 +590,7 @@ function bindSmapiSoapServiceToExpress(
                       searchResult({
                         count: it.length,
                         mediaCollection: it.map((aTrack) =>
-                          album(urlWithToken(accessToken), aTrack.album)
+                          album(urlWithToken(apiKey), aTrack.album)
                         ),
                       })
                     );
@@ -469,9 +608,9 @@ 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":
@@ -485,7 +624,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)
@@ -503,9 +642,7 @@ function bindSmapiSoapServiceToExpress(
                   case "track":
                     return musicLibrary.track(typeId).then((it) => ({
                       getExtendedMetadataResult: {
-                        mediaMetadata: {
-                          ...track(urlWithToken(accessToken), it),
-                        },
+                        mediaMetadata: track(urlWithToken(apiKey), it),
                       },
                     }));
                   case "album":
@@ -517,7 +654,7 @@ function bindSmapiSoapServiceToExpress(
                             userContent: false,
                             renameable: false,
                           },
-                          ...album(urlWithToken(accessToken), it),
+                          ...album(urlWithToken(apiKey), it),
                         },
                         // <mediaCollection readonly="true">
                         //   </mediaCollection>
@@ -543,9 +680,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(
@@ -557,7 +694,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,
@@ -580,6 +717,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"),
@@ -597,18 +752,6 @@ function bindSmapiSoapServiceToExpress(
                           albumArtURI: iconArtURI(bonobUrl, "genres").href(),
                           itemType: "container",
                         },
-                        {
-                          id: "randomAlbums",
-                          title: lang("random"),
-                          albumArtURI: iconArtURI(bonobUrl, "random").href(),
-                          itemType: "albumList",
-                        },
-                        {
-                          id: "starredAlbums",
-                          title: lang("starred"),
-                          albumArtURI: iconArtURI(bonobUrl, "starred").href(),
-                          itemType: "albumList",
-                        },
                         {
                           id: "recentlyAdded",
                           title: lang("recentlyAdded"),
@@ -637,8 +780,6 @@ function bindSmapiSoapServiceToExpress(
                           itemType: "albumList",
                         },
                       ],
-                      index: 0,
-                      total: 9,
                     });
                   case "search":
                     return getMetadataResult({
@@ -659,14 +800,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,
@@ -689,6 +828,11 @@ function bindSmapiSoapServiceToExpress(
                       type: "random",
                       ...paging,
                     });
+                  case "favouriteAlbums":
+                    return albums({
+                      type: "favourited",
+                      ...paging,
+                    });
                   case "starredAlbums":
                     return albums({
                       type: "starred",
@@ -696,17 +840,17 @@ 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 "genres":
@@ -727,8 +871,13 @@ function bindSmapiSoapServiceToExpress(
                       .playlists()
                       .then((it) =>
                         Promise.all(
-                          it.map((playlist) =>
-                            musicLibrary.playlist(playlist.id)
+                          it.map((playlist) => {
+                            return {
+                              id: playlist.id,
+                              name: playlist.name,
+                              entries: []
+                            };
+                           }
                           )
                         )
                       )
@@ -736,7 +885,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaCollection: page.map((it) =>
-                            playlist(urlWithToken(accessToken), it)
+                            playlist(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -750,7 +899,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaMetadata: page.map((it) =>
-                            track(urlWithToken(accessToken), it)
+                            track(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -764,7 +913,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaCollection: page.map((it) =>
-                            album(urlWithToken(accessToken), it)
+                            album(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -781,7 +930,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaCollection: page.map((it) =>
-                            artist(urlWithToken(accessToken), it)
+                            artist(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -794,7 +943,7 @@ function bindSmapiSoapServiceToExpress(
                       .then(([page, total]) => {
                         return getMetadataResult({
                           mediaMetadata: page.map((it) =>
-                            track(urlWithToken(accessToken), it)
+                            track(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
@@ -809,7 +958,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(({ musicLibrary }) =>
                 musicLibrary
                   .createPlaylist(title)
@@ -835,7 +984,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(({ musicLibrary }) => musicLibrary.deletePlaylist(id))
               .then((_) => ({ deleteContainerResult: {} })),
           addToContainer: async (
@@ -843,7 +992,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)
@@ -854,7 +1003,7 @@ function bindSmapiSoapServiceToExpress(
             _,
             soapyHeaders: SoapyHeaders
           ) =>
-            auth(musicService, accessTokens, soapyHeaders?.credentials)
+            login(soapyHeaders?.credentials)
               .then(splitId(id))
               .then((it) => ({
                 ...it,
@@ -872,36 +1021,38 @@ 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":
-                    return musicLibrary
-                      .track(typeId)
-                      .then(({ duration }) => {
-                        if (
-                          (duration < 30 && +seconds >= 10) ||
-                          (duration >= 30 && +seconds >= 30)
-                        ) {
-                          return musicLibrary.scrobble(typeId);
-                        } else {
-                          return Promise.resolve(true);
-                        }
-                      })
-                      .then(() => {
-                        if (+seconds > 0) {
-                          return musicLibrary.nowPlaying(typeId);
-                        } else {
-                          return Promise.resolve(true);
-                        }
-                      });
-                    break;
+                    return musicLibrary.track(typeId).then(({ duration }) => {
+                      if (
+                        (duration < 30 && +seconds >= 10) ||
+                        (duration >= 30 && +seconds >= 30)
+                      ) {
+                        return musicLibrary.scrobble(typeId);
+                      } else {
+                        return Promise.resolve(true);
+                      }
+                    });
                   default:
                     logger.info("Unsupported scrobble", { id, seconds });
                     return Promise.resolve(true);
@@ -923,8 +1074,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,
-// otherwise you will get an error trying to register
+// NOTE: manifest requires https for the URL, otherwise you will get an error trying to register
 export type Capability =
   | "search"
-  | "trFavorites"
-  | "alFavorites"
-  | "ucPlaylists"
-  | "extendedMD"
+  | "trFavorites" // Favorites: Adding/Removing Tracks (deprecated)
+  | "alFavorites" // Favorites: Adding/Removing Albums (deprecated)
+  | "ucPlaylists" // User Content Playlists
+  | "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",
@@ -247,9 +247,7 @@ export type Discovery = {
   seedHost?: string;
 };
 
-export default (
-  sonosDiscovery: Discovery = { enabled: true }
-): Sonos =>
+export default (sonosDiscovery: Discovery = { enabled: true }): Sonos =>
   sonosDiscovery.enabled
     ? autoDiscoverySonos(sonosDiscovery.seedHost)
     : SONOS_DISABLED;

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/builders.ts

@@ -1,11 +1,23 @@
 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 randomString from "../src/random_string";
+import {
+  Album,
+  Artist,
+  Track,
+  albumToAlbumSummary,
+  artistToArtistSummary,
+  PlaylistSummary,
+  Playlist,
+  SimilarArtist,
+  AlbumSummary,
+} from "../src/music_service";
+
 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)}`;
@@ -29,22 +41,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()}`,
-    ...fields
-  }
+    name: `playlistname-${randomstring.generate()}`,
+    ...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 {
@@ -76,10 +90,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",
@@ -87,32 +102,45 @@ export function someCredentials(token: string): Credentials {
   };
 }
 
+export function aSimilarArtist(
+  fields: Partial<SimilarArtist> = {}
+): SimilarArtist {
+  const id = fields.id || uuid();
+  return {
+    id,
+    name: `Similar Artist ${id}`,
+    image: artistImageURN({ artistId: id }),
+    inLibrary: true,
+    ...fields,
+  };
+}
+
 export function anArtist(fields: Partial<Artist> = {}): Artist {
-  const id = uuid();
+  const id = fields.id || uuid();
   const artist = {
     id,
     name: `Artist ${id}`,
     albums: [anAlbum(), anAlbum(), anAlbum()],
-    image: {
-      small: `/artist/art/${id}/small`,
-      medium: `/artist/art/${id}/small`,
-      large: `/artist/art/${id}/large`,
-    },
+    image: { system: "subsonic", resource: `art:${id}` },
     similarArtists: [
-      { id: uuid(), name: "Similar artist1", inLibrary: true },
-      { id: uuid(), name: "Similar artist2", inLibrary: true },
-      { id: "-1", name: "Artist not in library", inLibrary: false },
+      aSimilarArtist({ id: uuid(), name: "Similar artist1", inLibrary: true }),
+      aSimilarArtist({ id: uuid(), name: "Similar artist2", inLibrary: true }),
+      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 aGenre = (name: string) => ({ id: b64Encode(name), name })
+export const aGenre = (name: string) => ({ id: b64Encode(name), name });
 
 export const HIP_HOP = aGenre("Hip-Hop");
 export const METAL = aGenre("Metal");
@@ -125,13 +153,23 @@ 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 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 {
   const id = uuid();
   const artist = anArtist();
   const genre = fields.genre || randomGenre();
+  const rating = { love: false, stars: Math.floor(Math.random() * 5) };
   return {
     id,
     name: `Track ${id}`,
@@ -140,8 +178,11 @@ export function aTrack(fields: Partial<Track> = {}): Track {
     number: randomInt(100),
     genre,
     artist: artistToArtistSummary(artist),
-    album: albumToAlbumSummary(anAlbum({ artistId: artist.id, artistName: artist.name, genre })),
-    coverArt: `coverArt:${uuid()}`,
+    album: albumToAlbumSummary(
+      anAlbum({ artistId: artist.id, artistName: artist.name, genre })
+    ),
+    coverArt: { system: "subsonic", resource: `art:${uuid()}`},
+    rating,
     ...fields,
   };
 }
@@ -154,11 +195,25 @@ export function anAlbum(fields: Partial<Album> = {}): Album {
     genre: randomGenre(),
     year: `19${randomInt(99)}`,
     artistId: `Artist ${uuid()}`,
-    artistName: `Artist ${randomString()}`,
-    coverArt: `coverArt:${uuid()}`,
+    artistName: `Artist ${randomstring.generate()}`,
+    coverArt: { system: "subsonic", resource: `art:${uuid()}` },
     ...fields,
   };
-}
+};
+
+export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary {
+  const id = uuid();
+  return {
+    id,
+    name: `Album ${id}`,
+    year: `19${randomInt(99)}`,
+    genre: randomGenre(),
+    coverArt: { system: "subsonic", resource: `art:${uuid()}` },
+    artistId: `Artist ${uuid()}`,
+    artistName: `Artist ${randomstring.generate()}`,
+    ...fields
+  }
+};
 
 export const BLONDIE_ID = uuid();
 export const BLONDIE_NAME = "Blondie";
@@ -173,7 +228,7 @@ export const BLONDIE: Artist = {
       genre: NEW_WAVE,
       artistId: BLONDIE_ID,
       artistName: BLONDIE_NAME,
-      coverArt: `coverArt:${uuid()}`
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
     {
       id: uuid(),
@@ -182,14 +237,10 @@ export const BLONDIE: Artist = {
       genre: POP_ROCK,
       artistId: BLONDIE_ID,
       artistName: BLONDIE_NAME,
-      coverArt: `coverArt:${uuid()}`
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
   ],
-  image: {
-    small: undefined,
-    medium: undefined,
-    large: undefined,
-  },
+  image: { system: "external", resource: "http://localhost:1234/images/blondie.jpg" },
   similarArtists: [],
 };
 
@@ -199,15 +250,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, coverArt: `coverArt:${uuid()}` },
-    { id: uuid(), name: "Exodus", year: "1977", genre: REGGAE, artistId: BOB_MARLEY_ID, artistName: BOB_MARLEY_NAME, coverArt: `coverArt:${uuid()}` },
-    { id: uuid(), name: "Kaya", year: "1978", genre: SKA, artistId: BOB_MARLEY_ID, artistName: BOB_MARLEY_NAME, coverArt: `coverArt:${uuid()}` },
+    {
+      id: uuid(),
+      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: {
-    small: "http://localhost/BOB_MARLEY/sml",
-    medium: "http://localhost/BOB_MARLEY/med",
-    large: "http://localhost/BOB_MARLEY/lge",
-  },
+  image: { system: "subsonic", resource: BOB_MARLEY_ID },
   similarArtists: [],
 };
 
@@ -218,9 +289,8 @@ export const MADONNA: Artist = {
   name: MADONNA_NAME,
   albums: [],
   image: {
-    small: "http://localhost/MADONNA/sml",
-    medium: undefined,
-    large: "http://localhost/MADONNA/lge",
+    system: "external",
+    resource: "http://localhost:1234/images/madonna.jpg",
   },
   similarArtists: [],
 };
@@ -238,7 +308,7 @@ export const METALLICA: Artist = {
       genre: METAL,
       artistId: METALLICA_ID,
       artistName: METALLICA_NAME,
-      coverArt: `coverArt:${uuid()}`
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
     {
       id: uuid(),
@@ -246,15 +316,11 @@ export const METALLICA: Artist = {
       year: "1986",
       genre: METAL,
       artistId: METALLICA_ID,
-      artistName: METALLICA_NAME, 
-      coverArt: `coverArt:${uuid()}`
+      artistName: METALLICA_NAME,
+      coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     },
   ],
-  image: {
-    small: "http://localhost/METALLICA/sml",
-    medium: "http://localhost/METALLICA/med",
-    large: "http://localhost/METALLICA/lge",
-  },
+  image: { system: "subsonic", resource: METALLICA_ID },
   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 { isChristmas, isCNY, isHalloween, isHoli } from "../src/clock";
+import { randomInt } from "crypto";
+import dayjs, { Dayjs } from "dayjs";
+import timezone from "dayjs/plugin/timezone";
+dayjs.extend(timezone);
 
-describe("isChristmas", () => {
-  ["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);
+import { Clock, isChristmas, isCNY, isCNY_2022, isCNY_2023, isCNY_2024, isCNY_2025, isHalloween, isHoli, isMay4 } from "../src/clock";
+
+
+
+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) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isChristmas({ now: () => dayjs(date) })).toEqual(false);
+function describeFixedDateEvent(
+  name: string,
+  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", () => {
-  ["2000/10/31", "2022/10/31", "2030/10/31"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isHalloween({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
+describeFixedDateMonthEvent("christmas", "25/12", isChristmas);
+describeFixedDateMonthEvent("halloween", "31/10", isHalloween);
+describeFixedDateMonthEvent("may4", "04/05", isMay4);
 
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isHalloween({ now: () => dayjs(date) })).toEqual(false);
-    });
-  });
-});
-
-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);
-    });
-  });
-});
+describeFixedDateEvent("holi", ["2022-03-18", "2023-03-07", "2024-03-25", "2025-03-14"], isHoli);
+describeFixedDateEvent("cny", ["2022-02-01", "2023-01-22", "2024-02-10", "2025-02-29"], isCNY);
+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);

tests/config.test.ts

@@ -1,5 +1,5 @@
 import { hostname } from "os";
-import config, { envVar, WORD } from "../src/config";
+import config, { COLOR, envVar } from "../src/config";
 
 describe("envVar", () => {
   const OLD_ENV = process.env;
@@ -66,11 +66,13 @@ describe("envVar", () => {
 
   describe("validationPattern", () => {
     it("should fail when the value does not match the pattern", () => {
-      expect(
-        () => envVar("bnb-var", {
+      expect(() =>
+        envVar("bnb-var", {
           validationPattern: /^foobar$/,
         })
-      ).toThrowError(`Invalid value specified for 'bnb-var', must match ${/^foobar$/}`)
+      ).toThrowError(
+        `Invalid value specified for 'bnb-var', must match ${/^foobar$/}`
+      );
     });
   });
 });
@@ -94,42 +96,35 @@ describe("config", () => {
     propertyGetter: (config: any) => any
   ) {
     describe(name, () => {
-      function expecting({
-        value,
-        expected,
-      }: {
-        value: string;
-        expected: boolean;
-      }) {
-        describe(`when value is '${value}'`, () => {
-          it(`should be ${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 });
+      it.each([
+        [expectedDefault, ""],
+        [expectedDefault, undefined],
+        [true, "true"],
+        [false, "false"],
+        [false, "foo"],
+      ])("should be %s when env var is '%s'", (expected, value) => {
+        process.env[envVar] = value;
+        expect(propertyGetter(config())).toEqual(expected);
+      })
     });
   }
 
   describe("bonobUrl", () => {
-    ["BNB_URL", "BONOB_URL", "BONOB_WEB_ADDRESS"].forEach(key => {
-      describe(`when ${key} is specified`, () => {
+      describe.each([
+        "BNB_URL", 
+        "BONOB_URL", 
+        "BONOB_WEB_ADDRESS"
+      ])("when %s is specified", (k) => {
         it("should be used", () => {
           const url = "http://bonob1.example.com:8877/";
 
           process.env["BNB_URL"] = "";
           process.env["BONOB_URL"] = "";
           process.env["BONOB_WEB_ADDRESS"] = "";
-          process.env[key] = url;
-  
+          process.env[k] = url;
+
           expect(config().bonobUrl.href()).toEqual(url);
         });
-      });
     });
 
     describe("when none of BNB_URL, BONOB_URL, BONOB_WEB_ADDRESS are specified", () => {
@@ -163,32 +158,42 @@ describe("config", () => {
 
   describe("icons", () => {
     describe("foregroundColor", () => {
-      ["BNB_ICON_FOREGROUND_COLOR", "BONOB_ICON_FOREGROUND_COLOR"].forEach(k => {
+      describe.each([
+        "BNB_ICON_FOREGROUND_COLOR",
+        "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 ${k} is ''`, () => {
           it(`should default to undefined`, () => {
             process.env[k] = "";
             expect(config().icons.foregroundColor).toEqual(undefined);
           });
         });
-  
-        describe(`when ${k} is specified`, () => {
+
+        describe(`when ${k} is specified as a color`, () => {
           it(`should use it`, () => {
             process.env[k] = "pink";
             expect(config().icons.foregroundColor).toEqual("pink");
           });
         });
-  
+
+        describe(`when ${k} is specified as hex`, () => {
+          it(`should use it`, () => {
+            process.env[k] = "#1db954";
+            expect(config().icons.foregroundColor).toEqual("#1db954");
+          });
+        });
+
         describe(`when ${k} is an invalid string`, () => {
           it(`should blow up`, () => {
-            process.env[k] = "#dfasd";
+            process.env[k] = "!dfasd";
             expect(() => config()).toThrow(
-              `Invalid value specified for 'BNB_ICON_FOREGROUND_COLOR', must match ${WORD}`
+              `Invalid value specified for 'BNB_ICON_FOREGROUND_COLOR', must match ${COLOR}`
             );
           });
         });
@@ -196,32 +201,42 @@ describe("config", () => {
     });
 
     describe("backgroundColor", () => {
-      ["BNB_ICON_BACKGROUND_COLOR", "BONOB_ICON_BACKGROUND_COLOR"].forEach(k => {
+      describe.each([
+        "BNB_ICON_BACKGROUND_COLOR",
+        "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 ${k} is ''`, () => {
           it(`should default to undefined`, () => {
             process.env[k] = "";
             expect(config().icons.backgroundColor).toEqual(undefined);
           });
         });
-  
-        describe(`when ${k} is specified`, () => {
+
+        describe(`when ${k} is specified as a color`, () => {
           it(`should use it`, () => {
             process.env[k] = "blue";
             expect(config().icons.backgroundColor).toEqual("blue");
           });
         });
-  
+
+        describe(`when ${k} is specified as hex`, () => {
+          it(`should use it`, () => {
+            process.env[k] = "#1db954";
+            expect(config().icons.backgroundColor).toEqual("#1db954");
+          });
+        });
+
         describe(`when ${k} is an invalid string`, () => {
           it(`should blow up`, () => {
-            process.env[k] = "#red";
+            process.env[k] = "!red";
             expect(() => config()).toThrow(
-              `Invalid value specified for 'BNB_ICON_BACKGROUND_COLOR', must match ${WORD}`
+              `Invalid value specified for 'BNB_ICON_BACKGROUND_COLOR', must match ${COLOR}`
             );
           });
         });
@@ -234,29 +249,61 @@ describe("config", () => {
       expect(config().secret).toEqual("bonob");
     });
 
-    ["BNB_SECRET", "BONOB_SECRET"].forEach(key => {
-      it(`should be overridable using ${key}`, () => {
-        process.env[key] = "new secret";
+    describe.each([
+      "BNB_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");
       });
 
-      ["BNB_SONOS_SERVICE_NAME", "BONOB_SONOS_SERVICE_NAME"].forEach(k => {
-        it("should be overridable", () => {
-          process.env[k] = "foobar1000";
-          expect(config().sonos.serviceName).toEqual("foobar1000");
-        });
-      });
+      describe.each([
+        "BNB_SONOS_SERVICE_NAME", 
+        "BONOB_SONOS_SERVICE_NAME"
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "foobar1000";
+            expect(config().sonos.serviceName).toEqual("foobar1000");
+          });
+        }
+      );
     });
 
-    ["BNB_SONOS_DEVICE_DISCOVERY", "BONOB_SONOS_DEVICE_DISCOVERY"].forEach(k => {
+    describe.each([
+      "BNB_SONOS_DEVICE_DISCOVERY",
+      "BONOB_SONOS_DEVICE_DISCOVERY",
+    ])("%s", (k) => {
       describeBooleanConfigValue(
         "deviceDiscovery",
         k,
@@ -270,59 +317,88 @@ describe("config", () => {
         expect(config().sonos.discovery.seedHost).toBeUndefined();
       });
 
-      ["BNB_SONOS_SEED_HOST", "BONOB_SONOS_SEED_HOST"].forEach(k => {
-        it("should be overridable", () => {
-          process.env[k] = "123.456.789.0";
-          expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0");
-        });
-      });
-    });
-
-    ["BNB_SONOS_AUTO_REGISTER", "BONOB_SONOS_AUTO_REGISTER"].forEach(k => {
-      describeBooleanConfigValue(
-        "autoRegister",
-        k,
-        false,
-        (config) => config.sonos.autoRegister
+      describe.each([
+        "BNB_SONOS_SEED_HOST", 
+        "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");
+          });
+        }
       );
     });
 
+    describe.each([
+      "BNB_SONOS_AUTO_REGISTER", 
+      "BONOB_SONOS_AUTO_REGISTER"
+    ])(
+      "%s",
+      (k) => {
+        describeBooleanConfigValue(
+          "autoRegister",
+          k,
+          false,
+          (config) => config.sonos.autoRegister
+        );
+      }
+    );
 
     describe("sid", () => {
       it("should default to 246", () => {
         expect(config().sonos.sid).toEqual(246);
       });
 
-      ["BNB_SONOS_SERVICE_ID", "BONOB_SONOS_SERVICE_ID"].forEach(k => {
-        it("should be overridable", () => {
-          process.env[k] = "786";
-          expect(config().sonos.sid).toEqual(786);
-        });
-      });
+      describe.each([
+        "BNB_SONOS_SERVICE_ID", 
+        "BONOB_SONOS_SERVICE_ID"
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "786";
+            expect(config().sonos.sid).toEqual(786);
+          });
+        }
+      );
     });
   });
 
   describe("subsonic", () => {
     describe("url", () => {
-      ["BNB_SUBSONIC_URL", "BONOB_SUBSONIC_URL", "BONOB_NAVIDROME_URL"].forEach(k => {
+      describe.each([
+        "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).toEqual(`http://${hostname()}:4533`);
+          it(`should default to http://${hostname()}:4533/`, () => {
+            expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
           });
         });
-  
+
         describe(`when ${k} is ''`, () => {
-          it(`should default to http://${hostname()}:4533`, () => {
+          it(`should default to http://${hostname()}:4533/`, () => {
             process.env[k] = "";
-            expect(config().subsonic.url).toEqual(`http://${hostname()}:4533`);
+            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";
+            const url = "http://navidrome.example.com:1234/some-context-path";
             process.env[k] = url;
-            expect(config().subsonic.url).toEqual(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);
           });
         });
       });
@@ -333,17 +409,34 @@ describe("config", () => {
         expect(config().subsonic.customClientsFor).toBeUndefined();
       });
 
-      ["BNB_SUBSONIC_CUSTOM_CLIENTS", "BONOB_SUBSONIC_CUSTOM_CLIENTS", "BONOB_NAVIDROME_CUSTOM_CLIENTS"].forEach(k => {
+      describe.each([
+        "BNB_SUBSONIC_CUSTOM_CLIENTS",
+        "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();
+      });
 
-  ["BNB_SCROBBLE_TRACKS", "BONOB_SCROBBLE_TRACKS"].forEach(k => {
+      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");
+      });
+    });
+  });
+
+  describe.each([
+    "BNB_SCROBBLE_TRACKS", 
+    "BONOB_SCROBBLE_TRACKS"
+  ])("%s", (k) => {
     describeBooleanConfigValue(
       "scrobbleTracks",
       k,
@@ -352,12 +445,18 @@ describe("config", () => {
     );
   });
 
-  ["BNB_REPORT_NOW_PLAYING", "BONOB_REPORT_NOW_PLAYING"].forEach(k => {
-    describeBooleanConfigValue(
-      "reportNowPlaying",
-      k,
-      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,45 @@
-import encryption from '../src/encryption';
-
-describe("encrypt", () => {
-  const e = encryption("secret squirrel");
+import { cryptoEncryption, jwsEncryption } from '../src/encryption';
 
+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);
   });
-})
+
+  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(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);
+  });
+})

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 {
   contains,
@@ -556,12 +557,11 @@ describe("festivals", () => {
     backgroundColor: "black",
     foregroundColor: "black",
   });
-  let now = dayjs();
-  const clock = { now: () => now };
+  const clock = new FixedClock(dayjs());
 
   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 +587,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 +613,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 +638,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 +664,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 +689,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 +714,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 +740,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,6 +1,8 @@
+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,
@@ -18,6 +20,7 @@ import {
 } 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;
-      musicLibrary = (await service.login(token.authToken)) as MusicLibrary;
+      const token = await pipe(
+        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(artist2.id)).toEqual(artist2);
+          expect(await musicLibrary.artist(artist1.id!)).toEqual(artist1);
+          expect(await musicLibrary.artist(artist2.id!)).toEqual(artist2);
         });
       });
 
@@ -175,8 +170,8 @@ describe("InMemoryMusicService", () => {
       describe("fetching tracks for an album", () => {
         it("should return only tracks on that album", async () => {
           expect(await musicLibrary.tracks(artist1Album1.id)).toEqual([
-            track1,
-            track2,
+            { ...track1, rating: { love: false, stars: 0 } },
+            { ...track2, rating: { love: false, stars: 0 } },
           ]);
         });
       });
@@ -192,7 +187,7 @@ describe("InMemoryMusicService", () => {
       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 } },);
           });
         });
       });
@@ -221,7 +216,10 @@ describe("InMemoryMusicService", () => {
         ],
       });
       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 +256,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
           });
         });
@@ -282,9 +280,9 @@ describe("InMemoryMusicService", () => {
                     albumToAlbumSummary(artist1_album3),
                     albumToAlbumSummary(artist1_album4),
                     albumToAlbumSummary(artist1_album5),
-  
+
                     albumToAlbumSummary(artist2_album1),
-  
+
                     albumToAlbumSummary(artist3_album1),
                     albumToAlbumSummary(artist3_album2),
                   ],
@@ -302,13 +300,11 @@ describe("InMemoryMusicService", () => {
                     type: "alphabeticalByName",
                   })
                 ).toEqual({
-                  results:                   
-                  _.sortBy(allAlbums, 'name').map(albumToAlbumSummary),
+                  results: _.sortBy(allAlbums, "name").map(albumToAlbumSummary),
                   total: totalAlbumCount,
                 });
               });
             });
-
           });
 
           describe("fetching a page", () => {

tests/in_memory_music_service.ts

@@ -1,4 +1,4 @@
-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";
@@ -22,7 +22,9 @@ import {
   albumToAlbumSummary,
   Track,
   Genre,
+  Rating,
 } from "../src/music_service";
+import { BUrn } from "../src/burn";
 
 export class InMemoryMusicService implements MusicService {
   users: Record<string, string> = {};
@@ -32,24 +34,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({
-        authToken: b64Encode(JSON.stringify({ username, password })),
+      return TE.right({
+        serviceToken: b64Encode(JSON.stringify({ username, password })),
         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> {
-    const credentials = JSON.parse(b64Decode(token)) as Credentials;
+  refreshToken(serviceToken: string): TE.TaskEither<AuthFailure, AuthSuccess> {
+    return this.generateToken(JSON.parse(b64Decode(serviceToken)))
+  }
+
+  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");
 
@@ -75,9 +82,11 @@ export class InMemoryMusicService implements MusicService {
             switch (q.type) {
               case "alphabeticalByArtist":
                 return artist2Album;
-                case "alphabeticalByName":
-                  return artist2Album.sort((a, b) => a.album.name.localeCompare(b.album.name));
-                case "byGenre":
+              case "alphabeticalByName":
+                return artist2Album.sort((a, b) =>
+                  a.album.name.localeCompare(b.album.name)
+                );
+              case "byGenre":
                 return artist2Album.filter(
                   (it) => it.album.genre?.id === q.genre
                 );
@@ -107,26 +116,29 @@ 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(
-              fromCompare<Genre>((x, y) => ordString.compare(x.id, y.id))
-            )
+            A.sort(fromCompare<Genre>((x, y) => ordString.compare(x.id, y.id)))
           )
         ),
       tracks: (albumId: string) =>
-        Promise.resolve(this.tracks.filter((it) => it.album.id === albumId)),
+        Promise.resolve(
+          this.tracks
+            .filter((it) => it.album.id === albumId)
+            .map((it) => ({ ...it, rating: { love: false, stars: 0 } }))
+        ),
+      rate: (_: string, _2: Rating) => Promise.resolve(false),
       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, size?: number) =>
-        Promise.reject(`Cannot retrieve coverArt for ${id}, size ${size}`),
+      coverArt: (coverArtURN: BUrn, size?: number) =>
+        Promise.reject(`Cannot retrieve coverArt for ${coverArtURN}, size ${size}`),
       scrobble: async (_: string) => {
         return Promise.resolve(true);
       },
@@ -139,10 +151,14 @@ 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"),
-      deletePlaylist: async (_: string) => Promise.reject("Unsupported operation"),
-      addToPlaylist: async (_: string) => Promise.reject("Unsupported operation"),
-      removeFromPlaylist: async (_: string, _2: number[]) => Promise.reject("Unsupported operation"),
+      createPlaylist: async (_: string) =>
+        Promise.reject("Unsupported operation"),
+      deletePlaylist: async (_: string) =>
+        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([]),
     });

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_service.test.ts

@@ -0,0 +1,22 @@
+import { v4 as uuid } from "uuid";
+
+import { anArtist } from "./builders";
+import { artistToArtistSummary } from "../src/music_service";
+
+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/scenarios.test.ts

@@ -33,9 +33,10 @@ class LoggedInSonosDriver {
     this.client = client;
     this.token = token;
     this.client.addSoapHeader({
-      credentials: someCredentials(
-        this.token.getDeviceAuthTokenResult.authToken
-      ),
+      credentials: someCredentials({
+        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/tsconfig.json

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