Compare commits

...

161 Commits

Author SHA1 Message Date
8e207fd483 Udpates to docs 2025-10-26 12:01:07 +01:00
Wolfgang Kulhanek
2403d6cdc6 Another token expiration fix. 2025-10-24 15:07:09 +02:00
Wolfgang Kulhanek
03434fb362 More token refresh fixes 2025-10-24 14:56:56 +02:00
Wolfgang Kulhanek
a47581c3fe Fix tests 2025-10-24 14:47:53 +02:00
Wolfgang Kulhanek
48a71031c6 Update token management again 2025-10-24 13:42:55 +02:00
Wolfgang Kulhanek
d0d51b02f6 More formatting 2025-10-23 14:30:30 +02:00
Wolfgang Kulhanek
1bec5957b9 Formatting? 2025-10-23 14:29:42 +02:00
Wolfgang Kulhanek
95ea4ac54f Formatting 2025-10-23 14:28:00 +02:00
Wolfgang Kulhanek
cba84f669a Add source tag 2025-10-23 14:27:39 +02:00
Wolfgang Kulhanek
dfdb62bea4 More details in Updates.adoc 2025-10-23 14:25:43 +02:00
Wolfgang Kulhanek
1fd8e13668 Playlist update again 2025-10-22 18:25:15 +02:00
Wolfgang Kulhanek
ba52f201b9 Another attempt to fix playlists 2025-10-22 18:15:17 +02:00
Wolfgang Kulhanek
d69b442019 Change playlist handling 2025-10-22 17:53:46 +02:00
Wolfgang Kulhanek
53021a9da1 Fix tests 2025-10-22 17:33:00 +02:00
Wolfgang Kulhanek
f8ff9f30fb Add BNB_TOKEN_CLEANUP_INTERVAL variable and re-design login page 2025-10-22 17:24:56 +02:00
Wolfgang Kulhanek
f08004a4f1 Replace json config with SQLite database 2025-10-22 16:51:40 +02:00
c122b9ac90 More formatting 2025-10-17 17:40:07 +02:00
0a7915570e Fix formatting 2025-10-17 17:38:10 +02:00
330b661a4e Fix docs 2025-10-17 17:35:25 +02:00
b777f4fd00 Setup docs 2025-10-17 17:33:04 +02:00
57c60dd462 Added Artwork 2025-10-17 15:05:27 +02:00
Wolfgang Kulhanek
87592e7fc0 Fix overeager token cleanup 2025-10-17 14:49:19 +02:00
Wolfgang Kulhanek
2ac62974c6 Change expired logs from error to debug 2025-10-17 11:42:24 +02:00
Wolfgang Kulhanek
87309fdf67 Cleanup expired tokens at startup 2025-10-17 11:33:44 +02:00
Wolfgang Kulhanek
f2fa858bd4 Token refresh logs 2025-10-17 11:24:04 +02:00
Wolfgang Kulhanek
fb1a6d9eac Fix token expiration 2025-10-17 11:14:10 +02:00
Wolfgang Kulhanek
593555bc82 Fix tests 2025-10-17 10:59:29 +02:00
Wolfgang Kulhanek
254bd5a149 More test fixes 2025-10-17 10:32:12 +02:00
Wolfgang Kulhanek
8ef6e2064d Fix tests 2025-10-17 10:28:15 +02:00
Wolfgang Kulhanek
96b27d3cdb More test errors 2025-10-17 10:22:54 +02:00
Wolfgang Kulhanek
54a3e5c1f0 Fix test error 2025-10-17 10:16:07 +02:00
Wolfgang Kulhanek
2da4530647 Fix build errors 2025-10-17 10:06:28 +02:00
Wolfgang Kulhanek
788d3e14e3 Fix test error 2025-10-17 10:02:57 +02:00
Wolfgang Kulhanek
42ecea42c2 Fix token refresh 2025-10-17 09:54:48 +02:00
Wolfgang Kulhanek
ef17fbdcff Fix playlists? 2025-10-17 09:34:22 +02:00
Wolfgang Kulhanek
665fcaf5cb Fix tests for search 2025-10-16 17:23:37 +02:00
Wolfgang Kulhanek
cafbb8f19b First attempt at fixing search 2025-10-16 17:19:33 +02:00
Wolfgang Kulhanek
4b2fb29cc1 More scrobble fixes 2025-10-16 17:05:40 +02:00
Wolfgang Kulhanek
e722aa4b7c Update gitignore 2025-10-16 17:01:50 +02:00
Wolfgang Kulhanek
ab91a6190c Update Debian to trixie 2025-10-16 15:35:55 +02:00
Wolfgang Kulhanek
892b95d0f6 Fix scrobbling. For real? 2025-10-16 15:28:47 +02:00
Wolfgang Kulhanek
d88767cbe6 Remove log.txt 2025-10-16 15:14:05 +02:00
Wolfgang Kulhanek
4965e2f8df Update scrobble logic 2025-10-16 15:13:41 +02:00
Wolfgang Kulhanek
53d06721fb Implement /report/v1 2025-10-16 14:58:11 +02:00
Wolfgang Kulhanek
55e2ea353f Implement reportPlaySeconds and reportPlayStatus 2025-10-16 14:12:28 +02:00
Wolfgang Kulhanek
c2596cb01f Ad debug info for now playing issue 2025-10-16 13:21:20 +02:00
Wolfgang Kulhanek
7da0bc627c Don't always log headers 2025-10-16 11:44:23 +02:00
Wolfgang Kulhanek
9609cbd7f0 Fix token store 2025-10-16 11:20:55 +02:00
Wolfgang Kulhanek
fee5f74a2c Save tokens 2025-10-16 10:51:40 +02:00
01f0dc942b More debug 2025-10-15 16:21:12 +02:00
cd77eda226 More debug 2025-10-15 16:18:23 +02:00
16f71e2d13 More debug statements 2025-10-15 16:11:57 +02:00
de185aa31f Add debug 2025-10-15 16:05:39 +02:00
02d6f4d01e Import missing symbol 2025-10-15 15:56:49 +02:00
17cd091325 More edits 2025-10-15 15:54:20 +02:00
7e7830f57d Change mapping 2025-10-14 19:13:36 +02:00
d6a1771768 Try non async 2025-10-14 19:04:55 +02:00
33ab815996 Mark parameters optional 2025-10-14 18:51:26 +02:00
dbc2f1f2c2 Implement dummy reportAccountAction 2025-10-14 18:47:21 +02:00
Simon
46f52b82ed Set push:true to publish image, upgrade build-push action 2025-09-22 05:09:28 +00:00
simojenki
8791430ab3 Push PR images to registries 2025-09-20 22:36:33 +07:00
chxx
419333399d update support 80.0.0 2025-09-14 23:52:37 +08:00
Simon J
2961b651d9 Icons for years (#220) 2025-02-07 11:52:59 +11:00
Simon J
d8d532e35f bump node to v22 (#218) 2025-02-04 20:14:46 +11:00
Simon J
a581100d29 Removed libxmljs2 (#219) 2025-02-04 19:56:45 +11:00
Simon J
6bc4c79f02 pull subsonic out into proper class (#217) 2025-02-04 06:28:45 +11:00
Simon J
dd52c5706b Update sonos wsdl (#215) 2025-02-01 15:03:37 +11:00
Simon J
996582ce93 bump libs (#211) 2024-11-30 21:30:30 +11:00
Jonathan Virga
0488f398c1 Add years menu (#202) 2024-04-23 10:06:18 +10:00
Simon J
e7f5f5871e Ability to play radio stations from subsonic api (#199) 2024-02-26 05:51:30 +11:00
Simon J
eb3124b705 README updates (#197) 2024-02-08 15:49:35 +11:00
Simon J
4b7be66385 Upgrade @svrooij/sonos to ^2.6.0-beta.7 (#195) 2024-02-08 12:36:36 +11:00
Simon J
212f6e34dc Update README.md (#196) 2024-02-08 12:36:26 +11:00
Simon J
9b9a348b20 Fix issue where transcoded files would not play, provide support for custom clients to transcode (#194) 2024-02-07 16:21:28 +11:00
Simon J
6bf89b87e2 Feature/no more sharp (#193)
* Playlist icons working as rendered by ND

* remove duplication in cover art image url creation

* Remove unused ability to create collages of images
2024-02-05 17:22:27 +11:00
Simon J
66c248fe44 Use transcodedContentType when available to indicate to sonos device the transcoded mimeType #191 (#192) 2024-02-02 19:43:53 +11:00
Daniel Hammer
1a251400ec Update README.md (#189) 2024-01-25 08:48:14 +11:00
Simon J
0c9513bec9 Rollback version of fast-xml-parser used by @svrooij/sonos as newest version causes error (#188) 2024-01-24 20:40:25 +11:00
Simon J
b7beb4c610 - Upgrade to node v20 (#187) 2024-01-24 12:25:48 +11:00
Simon J
5ce2e4efb7 Bump libs (#179) 2023-10-11 17:19:24 +11:00
Simon J
8ef9ca80b6 Fix issue #177 (#178) 2023-10-11 12:45:27 +11:00
Simon J
a5689c3d4b Feature/move close stream (#176)
* 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
2023-10-10 11:25:55 +11:00
dependabot[bot]
b8caf90e06 Bump semver from 5.7.1 to 5.7.2 (#165)
Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v5.7.1...v5.7.2)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-10 10:59:57 +11:00
dependabot[bot]
9b01f07484 Bump get-func-name from 2.0.0 to 2.0.2 (#173)
Bumps [get-func-name](https://github.com/chaijs/get-func-name) from 2.0.0 to 2.0.2.
- [Release notes](https://github.com/chaijs/get-func-name/releases)
- [Commits](https://github.com/chaijs/get-func-name/commits/v2.0.2)

---
updated-dependencies:
- dependency-name: get-func-name
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-10 10:59:46 +11:00
Simon J
fb5f8e81ec Ensure streams and destroyed on end of /stream request to see if addressess TCP leak issue (#175) 2023-10-09 16:19:00 +11:00
Simon J
9786d9f1dd Support for fr-FR LANG (#172) 2023-09-14 16:38:56 +10:00
dhalem
a9d88bd9eb No longer fetch entities for playlists when getting the list. (#161) 2023-04-27 19:34:59 +10:00
Simon J
f6fc7ab920 Ability to disable album art for playlists (#159) 2023-04-22 10:54:38 +10:00
simojenki
8111041551 Additional documentation around where to pull image from 2023-03-18 08:47:16 +11:00
simojenki
df2ef9b152 Add some labels to docker image 2023-03-17 10:37:42 +11:00
Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs
33473cd387 ci: Push image to GHCR (#153)
* ci: Push image to GHCR

* ci: Update build actions
2023-03-17 10:26:43 +11:00
Simon J
7f743aaa7e Change some messages from info to debug, route all soap info to debug (#151) 2023-03-13 08:47:32 +11:00
simojenki
d4bed77c54 Set default log level to info 2023-03-12 07:52:43 +00:00
Simon J
29531a6e01 Ability to configure log level, default to 'warn' (#150) 2023-03-12 13:52:38 +11:00
Simon J
e78b6c4fbc Ability to configure whether to log http requests (#149) 2023-03-12 09:21:49 +11:00
Simon J
2941f6f595 Add wget to image 2023-03-09 06:55:58 +11:00
Daniel Hammer
2c48d08b0e Expanded BNB_SUBSONIC_ARTIST_IMAGE_CACHE description to reflect maintainer insights. (#146)
@see https://github.com/simojenki/bonob/issues/138#issuecomment-1455001557

Co-authored-by: Daniel Hammer <daniel.hammer+oss@gmail.com>
2023-03-08 16:16:03 +11:00
Daniel Hammer
de48ee0fca Added initial da-DK i18n. (#140) 2023-03-06 18:40:08 +11:00
Simon J
cefdf5e2d5 Switch to node:16-bullsys-slim images to reduce final image size (#144) 2023-03-06 18:39:40 +11:00
Daniel Hammer
f86a78b338 Added initial documentation for multiple registrations. (#141)
@see https://github.com/simojenki/bonob/issues/139

Co-authored-by: Daniel Hammer <daniel.hammer+oss@gmail.com>
2023-03-06 10:41:55 +11:00
dependabot[bot]
4d23885d7c Bump @xmldom/xmldom from 0.7.6 to 0.7.9 (#143)
Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.7.6 to 0.7.9.
- [Release notes](https://github.com/xmldom/xmldom/releases)
- [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md)
- [Commits](https://github.com/xmldom/xmldom/compare/0.7.6...0.7.9)

---
updated-dependencies:
- dependency-name: "@xmldom/xmldom"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:41:19 +11:00
dependabot[bot]
8c80c00089 Bump qs from 6.10.1 to 6.11.0 (#142)
Bumps [qs](https://github.com/ljharb/qs) from 6.10.1 to 6.11.0.
- [Release notes](https://github.com/ljharb/qs/releases)
- [Changelog](https://github.com/ljharb/qs/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ljharb/qs/compare/v6.10.1...v6.11.0)

---
updated-dependencies:
- dependency-name: qs
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:41:08 +11:00
dependabot[bot]
ebf385e918 Bump http-cache-semantics from 4.1.0 to 4.1.1 (#133)
Bumps [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/kornelski/http-cache-semantics/releases)
- [Commits](https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: http-cache-semantics
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:40:52 +11:00
dependabot[bot]
a20fdcbc5f Bump eta from 1.12.3 to 2.0.0 (#131)
Bumps [eta](https://github.com/eta-dev/eta) from 1.12.3 to 2.0.0.
- [Release notes](https://github.com/eta-dev/eta/releases)
- [Commits](https://github.com/eta-dev/eta/compare/v1.12.3...v2.0.0)

---
updated-dependencies:
- dependency-name: eta
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:40:40 +11:00
dependabot[bot]
f763dbd8b9 Bump cookiejar from 2.1.2 to 2.1.4 (#130)
Bumps [cookiejar](https://github.com/bmeck/node-cookiejar) from 2.1.2 to 2.1.4.
- [Release notes](https://github.com/bmeck/node-cookiejar/releases)
- [Commits](https://github.com/bmeck/node-cookiejar/commits)

---
updated-dependencies:
- dependency-name: cookiejar
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:40:25 +11:00
dependabot[bot]
2d3e5dc635 Bump json5 from 2.2.0 to 2.2.3 (#126) 2023-03-06 08:10:21 +11:00
dependabot[bot]
6091308266 Bump jsonwebtoken from 8.5.1 to 9.0.0 (#125) 2023-03-06 08:10:14 +11:00
dependabot[bot]
fed6e9663d Bump express from 4.17.1 to 4.17.3 (#124) 2023-03-06 08:10:01 +11:00
dependabot[bot]
03b5b04c73 Bump minimatch from 3.0.4 to 3.1.2 (#120) 2023-03-06 07:54:15 +11:00
simojenki
4a529b46e1 Fix incorrect boolean usage with docker-compose, had to quote the "true" 2022-11-14 00:34:04 +00:00
simojenki
5c9fbede7a Add devcontainer for building bonob 2022-11-14 00:33:35 +00:00
dependabot[bot]
94e25e03ea Bump follow-redirects from 1.14.3 to 1.15.2 (#119)
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.3 to 1.15.2.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.3...v1.15.2)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:34:27 +11:00
dependabot[bot]
d9c3a3edcb Bump jpeg-js from 0.4.3 to 0.4.4 (#118)
Bumps [jpeg-js](https://github.com/eugeneware/jpeg-js) from 0.4.3 to 0.4.4.
- [Release notes](https://github.com/eugeneware/jpeg-js/releases)
- [Commits](https://github.com/eugeneware/jpeg-js/compare/v0.4.3...v0.4.4)

---
updated-dependencies:
- dependency-name: jpeg-js
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:34:17 +11:00
dependabot[bot]
f22b094d83 Bump minimist from 1.2.5 to 1.2.7 (#117)
Bumps [minimist](https://github.com/minimistjs/minimist) from 1.2.5 to 1.2.7.
- [Release notes](https://github.com/minimistjs/minimist/releases)
- [Changelog](https://github.com/minimistjs/minimist/blob/main/CHANGELOG.md)
- [Commits](https://github.com/minimistjs/minimist/compare/v1.2.5...v1.2.7)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:34:06 +11:00
dependabot[bot]
4ae71675e8 Bump async from 3.2.0 to 3.2.4 (#116)
Bumps [async](https://github.com/caolan/async) from 3.2.0 to 3.2.4.
- [Release notes](https://github.com/caolan/async/releases)
- [Changelog](https://github.com/caolan/async/blob/master/CHANGELOG.md)
- [Commits](https://github.com/caolan/async/compare/v3.2.0...v3.2.4)

---
updated-dependencies:
- dependency-name: async
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:33:53 +11:00
simojenki
84866dfd60 Trying to make server tests more stable 2022-10-20 16:35:18 +11:00
simojenki
719fd998b1 Set jest timeout globally for all tests as tests break in GH actions due to timeout 2022-10-20 13:29:37 +11:00
dependabot[bot]
91995678a4 Bump tar from 6.1.8 to 6.1.11 (#115) 2022-10-18 09:06:15 +11:00
dependabot[bot]
67d6c4a730 Bump node-fetch from 2.6.1 to 2.6.7 (#114) 2022-10-18 09:05:58 +11:00
dependabot[bot]
3df4f4daa7 Bump nth-check from 2.0.0 to 2.1.1 (#113) 2022-10-18 09:05:19 +11:00
dependabot[bot]
bd63408ec3 Bump tmpl from 1.0.4 to 1.0.5 (#112) 2022-10-18 09:04:50 +11:00
dependabot[bot]
da5491b474 Bump sharp from 0.29.1 to 0.30.5 (#106) 2022-10-18 09:04:27 +11:00
dependabot[bot]
bbd676b5b8 Bump @xmldom/xmldom from 0.7.4 to 0.7.6 (#111)
Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.7.4 to 0.7.6.
- [Release notes](https://github.com/xmldom/xmldom/releases)
- [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md)
- [Commits](https://github.com/xmldom/xmldom/compare/0.7.4...0.7.6)

---
updated-dependencies:
- dependency-name: "@xmldom/xmldom"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-18 08:03:05 +11:00
simojenki
d01c747c96 handling SIGTERM 2022-07-30 17:28:30 +10:00
Laurent le Beau-Martin
192f65a56b Improve ffmpeg command to transcode flac (#99)
* Improve ffmpeg command to transcode flac

The command previously suggested forced the output sample rate to 48 kHz, even if the input was lower, at 44.1 kHz. 
This new command lets `ffmpeg` select the appropriate output sample rate to minimize conversion. 
Documentation: https://www.ffmpeg.org/ffmpeg-filters.html#aformat-1

* Update transcoding command

- Support more sample rates and bit depths.
- Add note about S1
2022-03-10 15:06:56 +11:00
Simon J
9b3df4ce1a Support for using boolean values when using yaml docker-compose files rather than strings for booleans (#98) 2022-02-28 22:07:17 +11:00
Simon J
df9a6d4663 Improve date handling (#94) 2022-02-02 13:26:01 +11:00
simojenki
d0c80b2f20 Add linux/arm64 to platforms supported 2021-12-30 09:30:49 +11:00
simojenki
4fcfb0cb71 Update README 2021-12-28 17:45:41 +11:00
simojenki
616283b3c6 Add TZ to README 2021-12-25 12:25:50 +11:00
Simon J
8f8c3c77f2 Add tzdata to image (#89) 2021-12-25 10:04:39 +11:00
simojenki
7d28b7bf4b Use debian bullseye base images for better arm support, build only amd64 * arm/v7 images 2021-12-22 16:29:20 +11:00
simojenki
a217886ce5 Add linux/arm/v7 to images built 2021-12-22 14:46:42 +11:00
Simon J
e22d451833 arm64 and amd64 image support (#88)
* Ability to build arm7 docker image using buildx

* Build arm64 and amd64 images
2021-12-22 13:05:55 +11:00
Simon J
ddb26e11b8 Fix bug where authorisation token being truncated by sonos (#86) 2021-12-12 14:12:56 +11:00
Simon J
1c94654fb3 Refreshing bearer tokens when smapi token is refreshed (#85) 2021-12-09 14:41:52 +11:00
Simon J
7c0db619c9 Fix bug where streaming didnt work due to correct use of Bearer token (#84) 2021-12-03 13:51:51 +11:00
Simon J
075538f029 Feature/flavour in subsonic token (#83)
* Add type of subsonic clone to serviceToken so can specialise client for navidrome

* Ability to add bearer token to subsonic credentials for flavours of subsonic
2021-12-03 13:17:03 +11:00
Simon J
8a0140b728 Ability to define auth timeout (#82) 2021-12-02 14:24:44 +11:00
Simon J
d1300b8119 SmapiAuthTokens that expire, with sonos refreshAuthToken functionality (#81)
Bearer token to Authorization header for stream requests
Versioned SMAPI Tokens
2021-12-02 11:03:52 +11:00
Simon J
89340dd454 Fix bug where sonos app cannot navigate from track to artist when subsonic returns null artistId on song (#79) 2021-11-20 18:22:24 +11:00
Simon J
6321cb71a4 URN for image info (#78)
* Allow music service to return a URN identifying cover art for an entity

* Fix bug with playlist cover art rending same album multiple times
2021-11-15 17:33:51 +11:00
Simon J
bb4172acf4 Catch any unexpected error during login and return 403 (#76) 2021-11-08 17:26:09 +11:00
Simon J
c804627a0a Catch unhandled io errors in subsonic (#75) 2021-11-08 17:20:50 +11:00
Simon J
9851ee46b3 jws encryption support (#74) 2021-11-06 09:03:46 +11:00
Simon J
eea102891d Updating README (#73) 2021-11-05 17:44:31 +11:00
Simon J
602cb6b820 Ability to specify hex colors (#72) 2021-11-04 14:33:37 +11:00
Simon J
9d76c92e69 Make Smapi responsible for turning app token into encrypted jwt (#71) 2021-11-04 14:04:56 +11:00
Simon J
2d4f201d08 Add PageSize of 30 to presentation map to reduce load when requesting artists (#69) 2021-10-27 13:08:12 +11:00
Simon J
e58dae5eb9 Fix bug where menu item dropped from root container (#68) 2021-10-27 08:28:06 +11:00
simojenki
b6963cbb8c Update README 2021-10-23 11:18:22 +11:00
Simon J
09269216b0 Add HEALTHCHECK to Dockerfile (#67) 2021-10-20 14:24:28 +11:00
Simon J
a3a30455d0 Revert "Marking nowPlaying in smapi setPlayedSeconds handler so does not mark when sonos pre-caches a track (#57)" (#66)
This reverts commit c312778e13.
2021-10-16 14:51:07 +11:00
simojenki
a64947f603 Gonic color icons 2021-10-16 14:40:16 +11:00
simojenki
c1010df803 Update README 2021-10-08 11:48:56 +11:00
Simon J
cc95beb4f2 Ability to see TopRated/starred albums (#63) 2021-10-08 00:08:32 +11:00
simojenki
6116975d7a Fix issue fetching public resources from web container when running out of docker 2021-10-07 19:57:21 +11:00
Simon J
8f3d2bddf7 Ability to heart and star tracks whilst playing
Ability to heart and star tracks whilst playing
2021-10-07 15:57:09 +11:00
simojenki
a02b8c1ecd Re-enable tests removed with .only 2021-10-03 18:49:16 +11:00
simojenki
effb02f46e Removed http://moapi.sonos.com/Test/TestService.php from sonos wsdl as causes noise in logs 2021-10-03 18:47:26 +11:00
Simon J
d7a7747fab Ability to cache subsonic artist images locally on disk (#61) 2021-10-03 16:36:50 +11:00
96 changed files with 17622 additions and 13740 deletions

16
.devcontainer/Dockerfile Normal file
View File

@@ -0,0 +1,16 @@
FROM node:22-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

View File

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

6
.dockerignore Normal file
View File

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

View File

@@ -15,47 +15,62 @@ 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
-
run: yarn install
-
run: yarn test
node-version: 20
-
run: npm install
-
run: npm test
push_to_registry:
name: Push Docker image to Docker Hub
name: Push Docker image to Docker registries
needs: build_and_test
runs-on: ubuntu-latest
steps:
-
-
name: Check out the repo
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0
-
name: Set up QEMU
uses: docker/setup-qemu-action@v2
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
-
name: Docker meta
id: meta
uses: docker/metadata-action@v3
uses: docker/metadata-action@v5
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
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
-
name: Push image
uses: docker/build-push-action@v6
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
platforms: linux/amd64,linux/arm/v7,linux/arm64
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
labels: ${{ steps.meta.outputs.labels }}

6
.gitignore vendored
View File

@@ -2,6 +2,7 @@
.vscode
build
ignore
.ignore
node_modules
.yarn/*
!.yarn/patches
@@ -9,4 +10,7 @@ node_modules
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*
.pnp.*
log.txt
navidrome.txt
bonob.txt

1
.npmrc Normal file
View File

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

1
.nvmrc
View File

@@ -1 +0,0 @@
16.6.2

File diff suppressed because one or more lines are too long

View File

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

187
CLAUDE.md Normal file
View File

@@ -0,0 +1,187 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
bonob is a Sonos SMAPI (Sonos Music API) implementation that bridges Subsonic API clones (like Navidrome and Gonic) with Sonos devices. It acts as a middleware service that translates between the Subsonic API and Sonos's proprietary music service protocol, allowing users to stream their personal music libraries to Sonos speakers.
## Development Commands
### Building and Running
```bash
# Build TypeScript to JavaScript
npm run build
# Development mode with auto-reload (requires environment variables)
npm run dev
# OR with auto-registration
npm run devr
# Register bonob service with Sonos devices
npm run register-dev
```
### Testing
```bash
# Run all tests
npm test
# Run tests in watch mode
npm run testw
# Set custom test timeout (default: 5000ms)
JEST_TIMEOUT=10000 npm test
```
### Environment Variables for Development
When running locally, you need to set several environment variables:
- `BNB_DEV_HOST_IP`: Your machine's IP address (so Sonos can reach bonob)
- `BNB_DEV_SONOS_DEVICE_IP`: IP address of a Sonos device for discovery
- `BNB_DEV_SUBSONIC_URL`: URL of your Subsonic API server (e.g., Navidrome)
## Architecture
### Core Components
**`src/app.ts`** - Application entry point
- Reads configuration from environment variables
- Initializes all services (Subsonic, Sonos, authentication)
- Wires together the Express server with appropriate dependencies
- Handles SIGTERM for graceful shutdown
**`src/server.ts`** - Express HTTP server
- Serves web UI for service registration and login
- Handles music streaming (`/stream/track/:id`)
- Generates icons and cover art (`/icon/...`, `/art/...`)
- Serves Sonos-specific XML files (strings, presentation map)
- Binds SOAP service for Sonos SMAPI communication
**`src/smapi.ts`** - Sonos SMAPI SOAP implementation (1200+ lines)
- Implements the Sonos Music API Protocol via SOAP/XML
- Core operations: `getMetadata`, `getMediaURI`, `search`, `getExtendedMetadata`
- Handles authentication flow with link codes and device auth tokens
- Manages token refresh and session management
- Maps music library concepts to Sonos browse hierarchy
**`src/subsonic.ts`** - Subsonic API client
- Implements `MusicService` and `MusicLibrary` interfaces
- Handles authentication with Subsonic servers using token-based auth
- Translates between Subsonic data models and bonob's domain types
- Supports custom player configurations for transcoding
- Special handling for Navidrome (bearer token authentication)
- Implements artist image fetching with optional caching
**`src/music_service.ts`** - Core domain types and interfaces
- Defines `MusicService` interface (auth and login)
- Defines `MusicLibrary` interface (browsing, search, streaming, rating, scrobbling)
- Domain types: `Artist`, `Album`, `Track`, `Playlist`, `Genre`, `Rating`, etc.
- Uses `fp-ts` for functional programming patterns (`TaskEither`, `Option`, `Either`)
**`src/sonos.ts`** - Sonos device discovery and registration
- Discovers Sonos devices on the network using SSDP/UPnP
- Registers/unregisters bonob as a music service with Sonos systems
- Supports both auto-discovery and seed-host based discovery
- Uses `@svrooij/sonos` library for device communication
**`src/smapi_auth.ts`** - Authentication token management
- Implements JWT-based SMAPI tokens (token + key pairs)
- Handles token verification and expiry
- Token refresh flow using `fp-ts` `TaskEither`
**`src/config.ts`** - Configuration management
- Reads and validates environment variables (all prefixed with `BNB_`)
- Legacy environment variable support (BONOB_ prefix)
- Type-safe configuration with defaults
### Key Abstractions
**BUrn (Bonob URN)** - Resource identifier system (`src/burn.ts`)
- Format: `{ system: string, resource: string }`
- Systems: `subsonic` (for cover art), `external` (for URLs like Spotify images)
- Used for abstracting art/image sources across different backends
**URL Builder** (`src/url_builder.ts`)
- Wraps URL manipulation with a builder pattern
- Handles context path for reverse proxy deployments
- Used throughout for generating URLs that Sonos devices can access
**Custom Players** (`src/subsonic.ts`)
- Allows mime-type specific transcoding configurations
- Maps source mime types to transcoded types
- Creates custom "client" names in Subsonic (e.g., "bonob+audio/flac")
- Example: `BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/mp3"`
### Data Flow
1. **Sonos App Request** → SOAP endpoint (`/ws/sonos`)
2. **SOAP Service** → Verifies auth token, calls `MusicLibrary` methods
3. **MusicLibrary** → Makes Subsonic API calls, transforms data
4. **SOAP Response** → Returns XML formatted for Sonos
For streaming:
1. **Sonos Device**`GET /stream/track/:id` with custom headers (bnbt, bnbk)
2. **Stream Handler** → Verifies token, calls `MusicLibrary.stream()`
3. **Subsonic Stream** → Proxies audio with proper mime-type handling
4. **Response** → Streams audio to Sonos, reports "now playing"
### Icon System (`src/icon.ts`)
- SVG-based icon generation with dynamic colors
- Supports foreground/background color customization via `BNB_ICON_FOREGROUND_COLOR` and `BNB_ICON_BACKGROUND_COLOR`
- Genre-specific icons
- Text overlay support (e.g., year icons like "1984")
- Holiday/festival decorations (auto-applied based on date)
- Legacy mode: renders to 80x80 PNG for older Sonos systems
### Authentication Flow
1. Sonos app requests link code via `getAppLink()`
2. User visits login URL with link code
3. User enters Subsonic credentials
4. bonob validates with Subsonic, generates service token
5. bonob associates link code with service token
6. Sonos polls `getDeviceAuthToken()` with link code
7. bonob returns SMAPI token (JWT) to Sonos
8. Subsequent requests use SMAPI token, which maps to service token
### Testing Philosophy
- Jest with ts-jest preset
- In-memory implementations for `LinkCodes`, `APITokens` for testing
- Mocking with `ts-mockito`
- Test helpers in `tests/` directory
- Console.log suppressed in tests (see `tests/setup.js`)
## Common Patterns
### Error Handling
- Use `fp-ts` `TaskEither<AuthFailure, T>` for async operations that can fail with auth errors
- SOAP faults for Sonos-specific errors (see SMAPI_FAULT_* constants)
- Promise-based error handling with `.catch()` for most async operations
### Type Safety
- Strict TypeScript (`strict: true`, `noImplicitAny: true`, `noUncheckedIndexedAccess: true`)
- Extensive use of discriminated unions
- Interface-based design for pluggable services
### Logging
- Winston-based logger (`src/logger.ts`)
- Log level controlled by `BNB_LOG_LEVEL`
- Request logging optional via `BNB_SERVER_LOG_REQUESTS`
### Functional Programming
- Heavy use of `fp-ts` for `Option`, `Either`, `TaskEither`
- Pipe-based composition (`pipe(data, fn1, fn2, ...)`)
- Immutable data transformations
## File Organization
- `src/` - TypeScript source code
- `tests/` - Jest test files (mirrors src/ structure)
- `build/` - Compiled JavaScript (gitignored)
- `web/` - HTML templates (Eta templating) and static assets
- `typings/` - Custom TypeScript definitions
## Important Constraints
- bonob must be accessible from Sonos devices at `BNB_URL`
- `BNB_URL` cannot contain "localhost" (validation error)
- Sonos requires specific XML formats (SMAPI WSDL v1.19.6)
- Streaming must handle HTTP range requests for seek functionality
- Token lifetime (`BNB_AUTH_TIMEOUT`) should be less than Subsonic session timeout

91
DOCUMENTATION.md Normal file
View File

@@ -0,0 +1,91 @@
# Bonob Source Code Documentation
This document provides an overview of the source files in the `src` directory, explaining the purpose and functionality of each.
### `api_tokens.ts`
Manages API tokens for authentication. It includes an in-memory implementation for storing and retrieving tokens, using SHA256 to mint new tokens.
### `app.ts`
This is the main entry point of the application. It initializes the server, configures the music service (Subsonic), and sets up the integration with Sonos. It reads the application config, sets up the Subsonic connection, and starts the Express server.
### `b64.ts`
Provides simple utility functions for Base64 encoding and decoding of strings.
### `burn.ts`
Handles the creation and parsing of "Bonob URNs" (BURNs), which are unique resource identifiers used within the system. It supports encryption and shorthand notations for more compact URNs.
### `clock.ts`
Provides an abstraction for time-related functions, which is useful for testing. It includes a `SystemClock` that uses the actual system time and a `FixedClock` for tests. It also contains logic for detecting special dates like Christmas and Halloween for seasonal features.
### `config.ts`
Manages the application's configuration by reading environment variables. It defines settings for the server, Sonos integration, Subsonic connection, and other features like scrobbling.
### `encryption.ts`
Implements encryption and decryption functionality using JSON Web Signatures (JWS). It provides a simple interface for encrypting and decrypting strings.
### `i8n.ts`
Handles internationalization (i18n) by providing translations for different languages supported by the Sonos app. It includes translations for UI elements and messages.
### `icon.ts`
Manages SVG icons used in the Sonos app. It allows for transformations like changing colors and applying special styles for festivals and holidays.
### `link_codes.ts`
Implements a system for linking Sonos devices with user accounts. It generates temporary codes that users can use to log in and associate their accounts.
### `logger.ts`
Configures the application-wide logger using Winston. It sets up logging levels and formats.
### `music_service.ts`
Defines the interfaces for a generic music service. This includes methods for authentication, browsing content (artists, albums, tracks), streaming audio, and managing playlists.
### `register.ts`
A command-line script used to register the Bonob service with Sonos devices on the local network.
### `registrar.ts`
Contains the core logic for registering the Bonob service with Sonos devices. It fetches service details from the Bonob server and sends the registration request to a Sonos device.
### `server.ts`
Sets up the Express web server. It defines the routes for the web interface, the Sonos Music API (SMAPI) endpoints, and audio streaming. It also handles user authentication and session management.
### `smapi_auth.ts`
Handles authentication for the Sonos Music API (SMAPI). It is responsible for issuing and verifying JWTs (JSON Web Tokens) that secure the communication between Sonos devices and the Bonob server.
### `smapi_token_store.ts`
Provides an interface and two implementations (in-memory and file-based) for storing SMAPI authentication tokens. This allows the server to persist user sessions.
### `smapi.ts`
Implements the Sonos Music API (SMAPI) using SOAP. This file is responsible for handling all the requests from Sonos devices, such as browsing music, searching, and getting track metadata.
### `sonos.ts`
Manages interactions with Sonos devices on the local network. This includes device discovery and service registration.
### `subsonic.ts`
Implements the `MusicService` interface for Subsonic-compatible media servers (like Navidrome). It handles all communication with the Subsonic API to fetch music data and stream audio.
### `url_builder.ts`
A utility class for building and manipulating URLs in a structured way.
### `utils.ts`
Contains miscellaneous utility functions used throughout the application, such as a function for tidying up XML strings.

View File

@@ -1,4 +1,4 @@
FROM node:16.6-alpine as build
FROM node:22-trixie-slim AS build
WORKDIR /bonob
@@ -9,46 +9,69 @@ COPY typings ./typings
COPY web ./web
COPY tests ./tests
COPY jest.config.js .
COPY package.json .
COPY register.js .
COPY .npmrc .
COPY tsconfig.json .
COPY yarn.lock .
COPY .yarnrc.yml .
COPY .yarn/releases ./.yarn/releases
COPY package.json .
COPY package-lock.json .
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 && \
yarn test --no-cache && \
yarn build
apt-get clean && \
rm -rf /var/lib/apt/lists/* && \
npm install && \
npm test && \
npm run gitinfo && \
npm run build && \
rm -Rf node_modules && \
NODE_ENV=production npm install --omit=dev
FROM node:22-trixie-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
WORKDIR /bonob
COPY package.json .
COPY yarn.lock .
COPY package-lock.json .
COPY --from=build /bonob/build/src ./src
COPY --from=build /bonob/node_modules ./node_modules
COPY --from=build /bonob/.gitinfo ./
COPY web ./web
COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl
COPY src/Sonoswsdl-1.19.6-20231024.wsdl ./src/Sonoswsdl-1.19.6-20231024.wsdl
RUN apk add --no-cache --update vips
RUN apt-get update && \
apt-get -y upgrade && \
apt-get -y install --no-install-recommends \
libvips \
tzdata \
wget && \
apt-get clean && \
rm -rf /var/lib/apt/lists/*
USER nobody
WORKDIR /bonob/src
HEALTHCHECK CMD wget -O- http://localhost:${BNB_PORT}/about || exit 1
CMD ["node", "app.js"]

127
README.md
View File

@@ -9,25 +9,40 @@ 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, Years, 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 & fr-FR supported currently, require translations for other languages). [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
- Auto discovery of sonos devices
- Discovery of sonos devices using seed IP address
- Auto register bonob service with sonos system
- Auto registration with sonos on start
- Multiple registrations within a single household.
- Transcoding 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/)
- Transcoding within subsonic clone
- Custom players by mime type, allowing custom transcoding rules for different file types
## Running
bonob is ditributed via docker and can be run in a number of ways
bonob is packaged as an OCI image to both the docker hub registry and github registry.
ie.
```bash
docker pull docker.io/simojenki/bonob
```
or
```bash
docker pull ghcr.io/simojenki/bonob
```
tag | description
--- | ---
latest | Latest release, intended to be stable
master | Lastest build from master, probably works, however is currently under test
vX.Y.Z | Fixed release versions from tags, for those that want to pin to a specific release
### Full sonos device auto-discovery and auto-registration using docker --network host
@@ -128,14 +143,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,22 +162,27 @@ 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_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
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_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. <P>Must specify the source mime type and optionally the transcoded mime type. <p>For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac". <p>However; <p>if your subsonic server will transcode the track then you need to specify the resulting mime type, ie. "audio/flac>audio/mp3" <p>If you want to specify many something like; "audio/flac>audio/mp3,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs. <p>Disclaimer: Getting this configuration wrong will cause sonos to refuse to play your music, by all means experiment, however know that this may well break your setup.
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,36 +193,72 @@ 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
- Startup bonob with your new implementation.
## A note on transcoding
## 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).
### Transcode everything
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.
The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
## Cusomisation
### Audio file type specific transcoding
### Audio File type specific transcoding options within Subsonic
Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/)
In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
In this case you could set;
```bash
# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
```
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 -
```
### Changing Icon colors
**Note for Sonos S1:** [24-bit depth is only supported by Sonos S2](https://support.sonos.com/s/article/79?language=en_US), so if your system is still on Sonos S1, transcoding should convert all FLACs to 16-bit:
```bash
ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
```
Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files. Let's say you want to transcode them to mp3s, you could set the following;
```bash
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
```
And then configure the 'bonob+audio/mpeg' player in your subsonic server.
## Changing Icon colors
```bash
-e BNB_ICON_FOREGROUND_COLOR=white \
@@ -214,10 +274,21 @@ 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

69
UPDATES.adoc Normal file
View File

@@ -0,0 +1,69 @@
= Updates for SMAPI
Run Bonob on your server.
== Updates made to original code
* Proper Token handling after login. Also handling of periodic token refresh. Something is still funky here after a day or two...
* Store Tokens in an SQLite database (in mounted `/config` directory).
* Added variable `BNB_TOKEN_CLEANUP_INTERVAL` with a default of `60` (minutes) to set how often expired tokens should be cleaned up out of the database.
* Multi-account logins. Register one Bonob and log in with multiple Navidrome users for easy account switching in the Sonos app.
* Global Search integration (Artist, Album, Track)
* Scrobbling support to Navidrome. After one song has been completely played the album will show up in the "Recently played" section.
* Playlist support. It shows both public and private (for the current account) playlists.
* Modernized Login page.
== To be done
* Remove all now unnecessary logic:
** Handling of `BNB_SONOS_SEED_HOST`
** Autoregistration with Sonos devices (`BNB_SONOS_AUTO_REGISTER`)
** Handling of `BNB_SONOS_DEVICE_DISCOVERY`
* Implement Thumbs Up/Down or Star ratings (this is probably a Sonos Service configuration thing - with maybe some code changes).
* Implement Playlist editing
== Running Bonob
Bonob now needs a volume to store the token database. In the example below that directory is `/var/containers/bonob`. Adapt as needed.
Also the example below uses a `bonob` user on the system with ID `1210` and group `100`. The database directory should be owned by that user.
Also for `BNB_SUBSONIC_URL` you can use the internal or external URL. So instead of `https://music.mydomain.com` you could use `http://192.168.1.100:4533` if your Navidrome runs on a server with IP `192.168.1.100`.
.Example systemd file (`/usr/lib/systemd/system/bonob.service`)
[source]
----
[Unit]
Description=Bonob container service
Wants=network.target
After=network-online.target
[Service]
Environment=PODMAN_SYSTEMD_UNIT=%n
Restart=always
ExecStartPre=-/usr/bin/podman rm -f bonob
ExecStart=/usr/bin/podman run --rm \
--name bonob \
--label "io.containers.autoupdate=image" \
--user 1210:100 \
--env BNB_SONOS_SERVICE_NAME="Navidrome" \
--env BNB_PORT=8200 \
--env BNB_URL="https://bonob.mydomain.com" \
--env BNB_SECRET="Some random string" \
--env BNB_SONOS_SERVICE_ID=Your Sonos ID \
--env BNB_SUBSONIC_URL=https://music.mydomain.com \
--env BNB_ICON_FOREGROUND_COLOR="black" \
--env BNB_ICON_BACKGROUND_COLOR="#65d7f4" \
--env BNB_SONOS_AUTO_REGISTER=false \
--env BNB_SONOS_DEVICE_DISCOVERY=false \
--env BNB_LOG_LEVEL="info" \
--env TZ="Europe/Vienna" \
--volume /var/containers/bonob:/config:Z \
--publish 8200:8200 \
quay.io/wkulhanek/bonob:latest
ExecStop=/usr/bin/podman rm -f bonob
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=bonob
[Install]
WantedBy=multi-user.target default.target
----

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
docs/images/spotify-ish.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

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

7831
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -6,54 +6,72 @@
"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.6.0-beta.11",
"@types/express": "^4.17.21",
"@types/fs-extra": "^11.0.4",
"@types/jsonwebtoken": "^9.0.7",
"@types/jws": "^3.2.10",
"@types/morgan": "^1.9.9",
"@types/node": "^20.11.5",
"@types/randomstring": "^1.3.0",
"@types/underscore": "^1.13.0",
"@types/uuid": "^10.0.0",
"@types/xmldom": "^0.1.34",
"@xmldom/xmldom": "^0.9.7",
"axios": "^1.7.8",
"better-sqlite3": "^12.4.1",
"dayjs": "^1.11.13",
"eta": "^2.2.0",
"express": "^4.18.3",
"fp-ts": "^2.16.9",
"fs-extra": "^11.2.0",
"jsonwebtoken": "^9.0.2",
"jws": "^4.0.0",
"morgan": "^1.10.0",
"node-html-parser": "^4.1.4",
"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.13",
"randomstring": "^1.3.0",
"sharp": "^0.33.5",
"soap": "^1.1.6",
"ts-md5": "^1.3.1",
"typescript": "^5.7.2",
"underscore": "^1.13.7",
"urn-lib": "^2.0.0",
"uuid": "^11.0.3",
"winston": "^3.17.0",
"xmldom-ts": "^0.3.1",
"xpath": "^0.0.34"
},
"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/better-sqlite3": "^7.6.13",
"@types/chai": "^5.0.1",
"@types/jest": "^29.5.14",
"@types/mocha": "^10.0.10",
"@types/supertest": "^6.0.2",
"@types/tmp": "^0.2.6",
"chai": "^5.1.2",
"get-port": "^7.1.0",
"image-js": "^0.35.6",
"jest": "^29.7.0",
"nodemon": "^3.1.7",
"supertest": "^7.0.0",
"tmp": "^0.2.3",
"ts-jest": "^29.2.5",
"ts-mockito": "^2.6.1",
"ts-node": "^10.2.1",
"xmldom-ts": "^0.3.1",
"ts-node": "^10.9.2",
"xpath-ts": "^1.3.13"
},
"overrides": {
"axios-ntlm": "npm:dry-uninstall",
"axios": "$axios"
},
"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_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_ICON_FOREGROUND_COLOR=deeppink BNB_ICON_BACKGROUND_COLOR=darkslategray BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
"test": "jest",
"testw": "jest --watch",
"gitinfo": "git describe --tags > .gitinfo"
}
}

View File

@@ -0,0 +1,85 @@
= Setting up Sonos Service
== Prerequisites
* In your Sonos App get your Sonos ID (About my Sonos System)
+
image::images/about.png[]
* Navidrome running and available from the server that Bonob is running on. This can be a public URL like https://music.mydomain.com or just a local URL like http://192.168.1.100:4533.
* Bonob running and available from the Internet. E.g. via https://bonob.mydomain.com
You can use any method to make these URLs available. Cloudflare Tunnels, Pangolin, reverse proxy, etc.
== Sonos Service Integration
* Log into https://play.sonos.com
* Once logged in go to https://developer.sonos.com/s/integrations
* Create a *New Content Integration*
** General Information
*** Service Name: Navidrome
*** Service Availability: Global
*** Checkbox checked
*** Website/Social Media URLs: https://music.mydomain.com (Some URL - e.g. your Navidrome server). This has to be a valid URL.
** Sonos Music API
*** Integration ID: com.mydomain.music (your domain in reverse)
*** Configuration Label: 1.0
*** SMAPI Endpoint: https://bonob.mydomain.com/ws/sonos
*** SMAPI Endpoint Version: 1.1
*** Radio Endpoint: empty
*** Reporting Endpoint: https://bonob.mydomain.com/report/v1
*** Reporting Endpoint Version: 2.3
*** Authentication Method: OAuth
*** Redirect: https://bonob.mydomain.com/login
*** Auth Token Time To Life: Empty
*** Browse/Search Results Page Size: 100
*** Polling Interval: 60
** Brand Assets
*** Just upload the various assets from the `sonos_artwork` directory.
** Localization Resources
*** Write something about your service in the various fields (except Explicit Filter Description).
** Integration Capabilities
*** Check the first two (*Enable Extended Metadata* and *Enable Extended Metadata for Playlists*) and nothing else.
** Image Replacement Rules
*** No changes
** Browse Options
*** No changes
** Search Capabilities
*** API Catalog Type: SMAPI Catalog
*** Catalog Title: Music
*** Catalog Type: GLOBAL
*** Add Three Categories with ID and Mapped ID:
+
Albums - albums
Artists - artists
Tracks - tracks
** Content Actions
*** No changes
** Service Deployment Settings
*** Sonos ID: Your Sonos ID (from About my system). This is how only your controller sees the new service.
*** System Name: Whatever you want
** Service Configuration
*** Click on *Refresh* and then *Send*. You should get a success message that you can dismiss with *Done*.
* In your app search for your service name and add Service in your app as usual.

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

View File

@@ -0,0 +1,18 @@
<svg xmlns="http://www.w3.org/2000/svg" width="800" height="200" viewBox="0 0 800 200" role="img" aria-labelledby="title desc">
<title id="title">Bonob Subsonic Logo</title>
<desc id="desc">A blue music-note icon with family dots on the left, followed by stacked text Bonob Navidrome in blue.</desc>
<!-- Icon (scaled and positioned) -->
<g transform="translate(20,20) scale(4)">
<rect x="0" y="0" width="40" height="40" rx="6" ry="6" fill="#1976d2"/>
<circle cx="11.5" cy="15.5" r="1.6" fill="#ffffff"/>
<circle cx="11.5" cy="22.5" r="1.6" fill="#ffffff"/>
<circle cx="22" cy="26" r="4" fill="#ffffff"/>
<rect x="24" y="10" width="1.6" height="16" rx="0.8" fill="#ffffff"/>
<path d="M25.6 11.2 C29.0 10.6 30.2 13.6 27.4 14.6 C29.2 15.4 27.6 16.6 25.6 15.8 Z" fill="#ffffff"/>
</g>
<!-- Text stacked in two lines -->
<text x="240" y="90" font-family="Arial, Helvetica, sans-serif" font-size="80" fill="#1976d2">Bonob</text>
<text x="240" y="160" font-family="Arial, Helvetica, sans-serif" font-size="80" fill="#1976d2">Navidrome</text>
</svg>

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@@ -0,0 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="180" height="20" viewBox="0 0 180 20" role="img" aria-labelledby="title desc">
<title id="title">Bonob Subsonic Logo</title>
<desc id="desc">A blue music-note icon with family dots, followed by the text Bonob Subsonic in blue.</desc>
<!-- Icon scaled down to fit height -->
<g transform="scale(0.45) translate(0,0)">
<rect x="0" y="0" width="40" height="40" rx="6" ry="6" fill="#1976d2"/>
<circle cx="11.5" cy="15.5" r="1.6" fill="#ffffff"/>
<circle cx="11.5" cy="22.5" r="1.6" fill="#ffffff"/>
<circle cx="22" cy="26" r="4" fill="#ffffff"/>
<rect x="24" y="10" width="1.6" height="16" rx="0.8" fill="#ffffff"/>
<path d="M25.6 11.2 C29.0 10.6 30.2 13.6 27.4 14.6 C29.2 15.4 27.6 16.6 25.6 15.8 Z" fill="#ffffff"/>
</g>
<!-- Text -->
<text x="28" y="15" font-family="Arial, Helvetica, sans-serif" font-size="12" fill="#1976d2">
Bonob Subsonic
</text>
</svg>

After

Width:  |  Height:  |  Size: 950 B

View File

@@ -0,0 +1,20 @@
<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" role="img" aria-labelledby="title desc">
<title id="title">Bonob Navidrome Music Server</title>
<desc id="desc">Blue rounded square with a white music note and two small circles representing family.</desc>
<!-- Blue rounded background -->
<rect x="0" y="0" width="40" height="40" rx="6" ry="6" fill="#1976d2"/>
<!-- Family dots (simple, symbolic) -->
<circle cx="11.5" cy="15.5" r="1.6" fill="#ffffff"/>
<circle cx="11.5" cy="22.5" r="1.6" fill="#ffffff"/>
<!-- Note head -->
<circle cx="22" cy="26" r="4" fill="#ffffff"/>
<!-- Note stem -->
<rect x="24" y="10" width="1.6" height="16" rx="0.8" fill="#ffffff"/>
<!-- Note flag (simple, filled shape) -->
<path d="M25.6 11.2 C29.0 10.6 30.2 13.6 27.4 14.6 C29.2 15.4 27.6 16.6 25.6 15.8 Z" fill="#ffffff"/>
</svg>

After

Width:  |  Height:  |  Size: 877 B

View File

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

View File

@@ -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);
}

30
src/api_tokens.ts Normal file
View File

@@ -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);
}

View File

@@ -2,18 +2,28 @@ 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 {
axiosImageFetcher,
cachingImageFetcher,
SubsonicMusicService,
TranscodingCustomPlayers,
NO_CUSTOM_PLAYERS,
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";
import { SQLiteSmapiTokenStore } from "./smapi_token_store";
const config = readConfig();
const clock = SystemClock;
logger.info(`Starting bonob with config ${JSON.stringify(config)}`);
logger.info(`Starting bonob with config ${JSON.stringify({ ...config, secret: "*******" })}`);
const bonob = bonobService(
config.sonos.serviceName,
@@ -24,20 +34,28 @@ const bonob = bonobService(
const sonosSystem = sonos(config.sonos.discovery);
const streamUserAgent = config.subsonic.customClientsFor
? appendMimeTypeToClientFor(config.subsonic.customClientsFor.split(","))
: DEFAULT;
const customPlayers = config.subsonic.customClientsFor
? TranscodingCustomPlayers.from(config.subsonic.customClientsFor)
: NO_CUSTOM_PLAYERS;
const subsonic = new Subsonic(
config.subsonic.url,
encryption(config.secret),
streamUserAgent
const artistImageFetcher = config.subsonic.artistImageCache
? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
: axiosImageFetcher;
const subsonic = new SubsonicMusicService(
new Subsonic(
config.subsonic.url,
customPlayers,
artistImageFetcher
),
customPlayers
);
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 +78,19 @@ 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??";
// Initialize SQLite token store
const smapiTokenStore = new SQLiteSmapiTokenStore(config.tokenStore.dbPath);
// Migrate existing JSON tokens if they exist
const legacyJsonPath = "/config/tokens.json";
if (fs.existsSync(legacyJsonPath)) {
logger.info(`Found legacy JSON token file at ${legacyJsonPath}, attempting migration...`);
smapiTokenStore.migrateFromJSON(legacyJsonPath);
}
const app = server(
sonosSystem,
@@ -69,16 +99,20 @@ 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,
smapiTokenStore,
tokenCleanupIntervalMinutes: config.tokenStore.cleanupIntervalMinutes
}
);
app.listen(config.port, () => {
const expressServer = app.listen(config.port, () => {
logger.info(`Listening on ${config.port} available @ ${config.bonobUrl}`);
});
@@ -90,12 +124,22 @@ 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');
});
smapiTokenStore.close();
process.exit(0);
});
export default app;

98
src/burn.ts Normal file
View File

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

View File

@@ -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;
}

View File

@@ -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,39 @@ 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 }),
tokenStore: {
dbPath: bnbEnvVar<string>("TOKEN_DB_PATH", { default: "/config/tokens.db" })!,
cleanupIntervalMinutes: bnbEnvVar<number>("TOKEN_CLEANUP_INTERVAL", { default: 60, parser: asInt })!,
},
};
}

View File

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

View File

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

View File

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

View File

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

View File

@@ -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'

View File

@@ -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,18 +46,40 @@ export type Genre = {
id: string;
}
export type Year = {
year: string;
}
export type Rating = {
love: boolean;
stars: number;
}
export type Encoding = {
player: string,
mimeType: string
}
export type Track = {
id: string;
name: string;
mimeType: string;
encoding: Encoding,
duration: number;
number: number | undefined;
genre: Genre | undefined;
coverArt: string | undefined;
coverArt: BUrn | undefined;
album: AlbumSummary;
artist: ArtistSummary;
rating: Rating;
};
export type RadioStation = {
id: string,
name: string,
url: string,
homePage?: string
}
export type Paging = {
_index: number;
_count: number;
@@ -101,16 +104,19 @@ export const asResult = <T>([results, total]: [T[], number]) => ({
export type ArtistQuery = Paging;
export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'random' | 'recent' | 'frequent' | 'newest' | 'starred';
export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'byYear' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
export type AlbumQuery = Paging & {
type: AlbumQueryType;
genre?: string;
fromYear?: string;
toYear?: string;
};
export const artistToArtistSummary = (it: Artist): ArtistSummary => ({
id: it.id,
name: it.name,
image: it.image
});
export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
@@ -125,7 +131,8 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({
id: it.id,
name: it.name
name: it.name,
coverArt: it.coverArt
})
export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges";
@@ -143,7 +150,8 @@ export type CoverArt = {
export type PlaylistSummary = {
id: string,
name: string
name: string,
coverArt?: BUrn | undefined
}
export type Playlist = PlaylistSummary & {
@@ -158,8 +166,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 {
@@ -170,6 +179,7 @@ export interface MusicLibrary {
tracks(albumId: string): Promise<Track[]>;
track(trackId: string): Promise<Track>;
genres(): Promise<Genre[]>;
years(): Promise<Year[]>;
stream({
trackId,
range,
@@ -177,7 +187,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[]>;
@@ -191,4 +202,6 @@ export interface MusicLibrary {
removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
similarSongs(id: string): Promise<Track[]>;
topSongs(artistId: string): Promise<Track[]>;
radioStation(id: string): Promise<RadioStation>
radioStations(): Promise<RadioStation[]>
}

View File

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

View File

@@ -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,23 +18,50 @@ 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";
import { URLBuilder } from "./url_builder";
import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n";
import { Icon, ICONS, festivals, features } from "./icon";
import _, { shuffle } from "underscore";
import _ from "underscore";
import morgan from "morgan";
import { takeWithRepeats } from "./utils";
import { parse } from "./burn";
import { axiosImageFetcher, ImageFetcher } from "./subsonic";
import {
JWTSmapiLoginTokens,
SmapiAuthTokens,
} from "./smapi_auth";
import { SmapiTokenStore, InMemorySmapiTokenStore } from "./smapi_token_store";
export const BONOB_ACCESS_TOKEN_HEADER = "bat";
// Session storage for tracking active streams (for scrobbling)
type StreamSession = {
serviceToken: string;
trackId: string;
timestamp: number;
};
const streamSessions = new Map<string, StreamSession>();
// Clean up old sessions (older than 1 hour)
setInterval(() => {
const oneHourAgo = Date.now() - (60 * 60 * 1000);
for (const [sid, session] of streamSessions.entries()) {
if (session.timestamp < oneHourAgo) {
streamSessions.delete(sid);
}
}
}, 5 * 60 * 1000).unref(); // Run every 5 minutes, but don't prevent process exit
interface RangeFilter extends Transform {
range: (length: number) => string;
}
@@ -73,7 +101,7 @@ export class RangeBytesFromFilter extends Transform {
export type ServerOpts = {
linkCodes: () => LinkCodes;
accessTokens: () => AccessTokens;
apiTokens: () => APITokens;
clock: Clock;
iconColors: {
foregroundColor: string | undefined;
@@ -82,16 +110,28 @@ export type ServerOpts = {
applyContextPath: boolean;
logRequests: boolean;
version: string;
smapiAuthTokens: SmapiAuthTokens;
externalImageResolver: ImageFetcher;
smapiTokenStore: SmapiTokenStore;
tokenCleanupIntervalMinutes: number;
};
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,
smapiTokenStore: new InMemorySmapiTokenStore(),
tokenCleanupIntervalMinutes: 60,
};
function server(
@@ -104,9 +144,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);
@@ -114,9 +157,9 @@ function server(
app.use(morgan("combined"));
}
app.use(express.urlencoded({ extended: false }));
app.use(express.json());
// 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 +193,7 @@ function server(
removeRegistrationRoute: bonobUrl
.append({ pathname: REMOVE_REGISTRATION_ROUTE })
.pathname(),
version: opts.version,
version: serverOpts.version || DEFAULT_SERVER_OPTS.version,
});
}
);
@@ -212,28 +255,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 +309,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 +362,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 +377,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 +398,64 @@ 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 {
// Store session for scrobbling later (when Sonos reports playback)
streamSessions.set(id, {
serviceToken,
trackId: id,
timestamp: Date.now(),
});
logger.debug(`Stored stream session for track ${id}`);
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 +463,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 +501,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 +516,7 @@ function server(
"accept-ranges": stream.headers["accept-ranges"],
},
sendStream: req.method == "GET",
nowPlaying: req.method == "GET",
});
} else {
respondWith({
@@ -389,44 +524,47 @@ function server(
filter: new PassThrough(),
headers: {},
sendStream: req.method == "GET",
nowPlaying: false,
});
}
});
}
});
app.get("/icon/:type/size/:size", (req, res) => {
const type = req.params["type"]!;
app.get("/icon/:type_text/size/:size", (req, res) => {
const match = (req.params["type_text"] || "")!.match("^([A-Za-z0-9]+)(?:\:([A-Za-z0-9]+))?$")
if (!match)
return res.status(400).send();
const type = match[1]!
const text = match[2]
const size = req.params["size"]!;
if (!Object.keys(ICONS).includes(type)) {
return res.status(404).send();
} else if (
size != "legacy" &&
!SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)
) {
} else if (size != "legacy" && !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)) {
return res.status(400).send();
} else {
let icon = (ICONS as any)[type]! as Icon;
const spec =
size == "legacy"
? {
mimeType: "image/png",
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
.apply(
features({
viewPortIncreasePercent: 80,
...serverOpts.iconColors,
text: text
})
)
.apply(festivals(clock))
@@ -454,87 +592,165 @@ function server(
});
});
const GRAVITY_9 = [
"north",
"northeast",
"east",
"southeast",
"south",
"southwest",
"west",
"northwest",
"centre",
];
app.get("/art/:ids/size/:size", (req, res) => {
const authToken = accessTokens.authTokenFor(
app.get("/art/:burn/size/:size", (req, res) => {
const serviceToken = apiTokens.authTokenFor(
req.query[BONOB_ACCESS_TOKEN_HEADER] as string
);
const ids = req.params["ids"]!.split("&");
const urn = parse(req.params["burn"]!);
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))))
.then((coverArts) => coverArts.filter((it) => it))
.then(shuffle)
.then((coverArts) => {
if (coverArts.length == 1) {
const coverArt = coverArts[0]!;
.login(serviceToken)
.then((musicLibrary) => {
if (urn.system == "external") {
return serverOpts.externalImageResolver(urn.resource);
} else {
return musicLibrary.coverArt(urn, size);
}
})
.then((coverArt) => {
if(coverArt) {
res.status(200);
res.setHeader("content-type", coverArt.contentType);
return res.send(coverArt.data);
} else if (coverArts.length > 1) {
const gravity = [...GRAVITY_9];
return sharp({
create: {
width: size * 3,
height: size * 3,
channels: 3,
background: { r: 255, g: 255, b: 255 },
},
})
.composite(
takeWithRepeats(coverArts, 9).map((art) => ({
input: art?.data,
gravity: gravity.pop(),
}))
)
.png()
.toBuffer()
.then((image) => sharp(image).resize(size).png().toBuffer())
.then((image) => {
res.status(200);
res.setHeader("content-type", "image/png");
return res.send(image);
});
} else {
return res.status(404).send();
}
})
})
.catch((e: Error) => {
logger.error(`Failed fetching image ${ids.join("&")}/size/${size}`, {
logger.error(`Failed fetching image ${urn}/size/${size}`, {
cause: e,
});
return res.status(500).send();
});
});
// Sonos Reporting Endpoint for playback analytics
app.post("/report/:version/timePlayed", async (req, res) => {
const version = req.params["version"];
logger.debug(`Received Sonos reporting event (v${version}): ${JSON.stringify(req.body)}`);
try {
// Sonos may send an array of reports or a single report with items array
const reports = Array.isArray(req.body) ? req.body : [req.body];
for (const report of reports) {
// Handle both direct report format and items array format
const items = report.items || [report];
for (const item of items) {
const {
reportId,
mediaUrl,
durationPlayedMillis,
positionMillis,
type,
} = item;
// Extract track ID from mediaUrl (format: /stream/track/{id} or x-sonos-http:track%3a{id}.mp3)
let trackId: string | undefined;
if (mediaUrl) {
// Try standard URL format first
const standardMatch = mediaUrl.match(/\/stream\/track\/([^?]+)/);
if (standardMatch) {
trackId = standardMatch[1];
} else {
// Try x-sonos-http format (track%3a{id}.mp3)
const sonosMatch = mediaUrl.match(/track%3[aA]([^.?&]+)/);
if (sonosMatch) {
trackId = sonosMatch[1];
}
}
}
if (!trackId) {
logger.warn(`Could not extract track ID from mediaUrl: ${mediaUrl}, full report: ${JSON.stringify(report)}`);
continue; // Skip this report, process next one
}
const durationPlayedSeconds = Math.floor((durationPlayedMillis || 0) / 1000);
logger.info(
`Sonos reporting: type=${type}, trackId=${trackId}, reportId=${reportId}, ` +
`durationPlayed=${durationPlayedSeconds}s, position=${positionMillis}ms`
);
// For "final" reports, determine if we should scrobble
if (type === "final" && durationPlayedSeconds > 0) {
// Retrieve authentication from stream session storage
const session = streamSessions.get(trackId!);
let serviceToken: string | undefined = session?.serviceToken;
if (!serviceToken) {
// Fallback: try to extract from Authorization header (if present)
const authHeader = req.headers["authorization"];
if (authHeader && authHeader.startsWith("Bearer ")) {
const token = authHeader.substring(7);
const smapiToken = serverOpts.smapiTokenStore.get(token);
if (smapiToken) {
serviceToken = pipe(
smapiAuthTokens.verify({ token, key: smapiToken.key }),
E.getOrElseW(() => undefined)
);
}
}
}
if (serviceToken) {
await musicService.login(serviceToken).then((musicLibrary) => {
// Get track duration to determine scrobbling threshold
return musicLibrary.track(trackId!).then((track) => {
const shouldScrobble =
(track.duration < 30 && durationPlayedSeconds >= 10) ||
(track.duration >= 30 && durationPlayedSeconds >= 30);
if (shouldScrobble) {
logger.info(`Scrobbling track ${trackId} after ${durationPlayedSeconds}s playback`);
return musicLibrary.scrobble(trackId!);
} else {
logger.debug(
`Not scrobbling track ${trackId}: duration=${track.duration}s, played=${durationPlayedSeconds}s`
);
return Promise.resolve(false);
}
});
}).catch((e) => {
logger.error(`Failed to process scrobble for track ${trackId}`, { error: e });
});
} else {
logger.debug("No authentication available for reporting endpoint scrobble");
}
}
}
}
return res.status(200).json({ status: "ok" });
} catch (error) {
logger.error("Error processing Sonos reporting event", { error });
return res.status(500).json({ status: "error" });
}
});
bindSmapiSoapServiceToExpress(
app,
SOAP_PATH,
bonobUrl,
linkCodes,
musicService,
accessTokens,
apiTokens,
clock,
i8n
i8n,
serverOpts.smapiAuthTokens,
serverOpts.smapiTokenStore,
serverOpts.logRequests,
serverOpts.tokenCleanupIntervalMinutes
);
if (serverOpts.applyContextPath) {

File diff suppressed because it is too large Load Diff

192
src/smapi_auth.ts Normal file
View File

@@ -0,0 +1,192 @@
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";
import logger from "./logger";
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 {
logger.debug("isError check", { thing });
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> => {
logger.debug("Verifying JWT", {
token: smapiToken.token,
key: smapiToken.key,
secret: this.secret,
version: this.version,
secretKey: this.secret + this.version + smapiToken.key,
});
try {
return E.right(
(
jwt.verify(
smapiToken.token,
this.secret + this.version + smapiToken.key
) as any
).serviceToken
);
} catch (e) {
const err = e as Error;
if (isTokenExpiredError(e)) {
logger.debug("JWT token expired, will attempt refresh", { expiredAt: (e as TokenExpiredError).expiredAt });
const serviceToken = (
jwt.verify(
smapiToken.token,
this.secret + this.version + smapiToken.key,
{ ignoreExpiration: true }
) as any
).serviceToken;
return E.left(new ExpiredTokenError(serviceToken));
} else {
logger.warn("JWT verification failed - token may be invalid or from different secret", { message: err.message });
if (isError(e)) return E.left(new InvalidTokenError(err.message));
else return E.left(new InvalidTokenError("Failed to verify token"));
}
}
};
}

166
src/smapi_token_store.ts Normal file
View File

@@ -0,0 +1,166 @@
import fs from "fs";
import path from "path";
import logger from "./logger";
import { SmapiToken, SmapiAuthTokens } from "./smapi_auth";
import { either as E } from "fp-ts";
export { SQLiteSmapiTokenStore } from "./sqlite_smapi_token_store";
export interface SmapiTokenStore {
get(token: string): SmapiToken | undefined;
set(token: string, fullSmapiToken: SmapiToken): void;
delete(token: string): void;
getAll(): { [tokenKey: string]: SmapiToken };
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number;
}
export class InMemorySmapiTokenStore implements SmapiTokenStore {
private tokens: { [tokenKey: string]: SmapiToken } = {};
get(token: string): SmapiToken | undefined {
return this.tokens[token];
}
set(token: string, fullSmapiToken: SmapiToken): void {
this.tokens[token] = fullSmapiToken;
}
delete(token: string): void {
delete this.tokens[token];
}
getAll(): { [tokenKey: string]: SmapiToken } {
return this.tokens;
}
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number {
const tokenKeys = Object.keys(this.tokens);
let deletedCount = 0;
for (const tokenKey of tokenKeys) {
const smapiToken = this.tokens[tokenKey];
if (smapiToken) {
const verifyResult = smapiAuthTokens.verify(smapiToken);
// Only delete if token verification fails with InvalidTokenError
// Do NOT delete ExpiredTokenError as those can still be refreshed
if (E.isLeft(verifyResult)) {
const error = verifyResult.left;
// Delete both invalid and expired tokens to prevent accumulation
if (error._tag === 'InvalidTokenError' || error._tag === 'ExpiredTokenError') {
logger.debug(`Deleting ${error._tag} token from in-memory store`);
delete this.tokens[tokenKey];
deletedCount++;
}
}
}
}
if (deletedCount > 0) {
logger.info(`Cleaned up ${deletedCount} invalid token(s) from in-memory store`);
}
return deletedCount;
}
}
export class FileSmapiTokenStore implements SmapiTokenStore {
private tokens: { [tokenKey: string]: SmapiToken } = {};
private readonly filePath: string;
constructor(filePath: string) {
this.filePath = filePath;
this.loadFromFile();
}
private loadFromFile(): void {
try {
// Ensure the directory exists
const dir = path.dirname(this.filePath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
logger.info(`Created token storage directory: ${dir}`);
}
// Load existing tokens if file exists
if (fs.existsSync(this.filePath)) {
const data = fs.readFileSync(this.filePath, "utf8");
this.tokens = JSON.parse(data);
logger.info(
`Loaded ${Object.keys(this.tokens).length} token(s) from ${this.filePath}`
);
} else {
logger.info(`No existing token file found at ${this.filePath}, starting fresh`);
this.tokens = {};
this.saveToFile();
}
} catch (error) {
logger.error(`Failed to load tokens from ${this.filePath}`, { error });
this.tokens = {};
}
}
private saveToFile(): void {
try {
// Ensure the directory exists before writing
const dir = path.dirname(this.filePath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
logger.info(`Created token storage directory: ${dir}`);
}
const data = JSON.stringify(this.tokens, null, 2);
fs.writeFileSync(this.filePath, data, "utf8");
logger.debug(`Saved ${Object.keys(this.tokens).length} token(s) to ${this.filePath}`);
} catch (error) {
logger.error(`Failed to save tokens to ${this.filePath}`, { error });
}
}
get(token: string): SmapiToken | undefined {
return this.tokens[token];
}
set(token: string, fullSmapiToken: SmapiToken): void {
this.tokens[token] = fullSmapiToken;
this.saveToFile();
}
delete(token: string): void {
delete this.tokens[token];
this.saveToFile();
}
getAll(): { [tokenKey: string]: SmapiToken } {
return this.tokens;
}
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number {
const tokenKeys = Object.keys(this.tokens);
let deletedCount = 0;
for (const tokenKey of tokenKeys) {
const smapiToken = this.tokens[tokenKey];
if (smapiToken) {
const verifyResult = smapiAuthTokens.verify(smapiToken);
// Only delete if token verification fails with InvalidTokenError
// Do NOT delete ExpiredTokenError as those can still be refreshed
if (E.isLeft(verifyResult)) {
const error = verifyResult.left;
// Delete both invalid and expired tokens to prevent accumulation
if (error._tag === 'InvalidTokenError' || error._tag === 'ExpiredTokenError') {
logger.debug(`Deleting ${error._tag} token from file store`);
delete this.tokens[tokenKey];
deletedCount++;
}
}
}
}
if (deletedCount > 0) {
logger.info(`Cleaned up ${deletedCount} invalid token(s) from file store`);
this.saveToFile();
}
return deletedCount;
}
}

View File

@@ -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",
@@ -176,7 +176,7 @@ export function autoDiscoverySonos(sonosSeedHost?: string): Sonos {
}
})
.catch((e) => {
logger.error(`Failed looking for sonos devices`, { cause: e });
logger.error(`Failed looking for sonos devices - ${e}`, { cause: e });
return [];
});
};
@@ -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;

View File

@@ -0,0 +1,200 @@
import Database from "better-sqlite3";
import path from "path";
import fs from "fs";
import logger from "./logger";
import { SmapiToken, SmapiAuthTokens } from "./smapi_auth";
import { either as E } from "fp-ts";
import { SmapiTokenStore } from "./smapi_token_store";
export class SQLiteSmapiTokenStore implements SmapiTokenStore {
private db!: Database.Database;
private readonly dbPath: string;
constructor(dbPath: string) {
this.dbPath = dbPath;
this.initializeDatabase();
}
private initializeDatabase(): void {
try {
// Ensure the directory exists
const dir = path.dirname(this.dbPath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
logger.info(`Created token storage directory: ${dir}`);
}
// Open database connection
this.db = new Database(this.dbPath);
// Create table if it doesn't exist
this.db.exec(`
CREATE TABLE IF NOT EXISTS smapi_tokens (
token_key TEXT PRIMARY KEY,
token TEXT NOT NULL,
key TEXT NOT NULL,
created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now'))
)
`);
// Create index for faster lookups
this.db.exec(`
CREATE INDEX IF NOT EXISTS idx_created_at ON smapi_tokens(created_at)
`);
const count = this.db.prepare("SELECT COUNT(*) as count FROM smapi_tokens").get() as { count: number };
logger.info(`SQLite token store initialized at ${this.dbPath} with ${count.count} token(s)`);
} catch (error) {
logger.error(`Failed to initialize SQLite token store at ${this.dbPath}`, { error });
throw error;
}
}
get(tokenKey: string): SmapiToken | undefined {
try {
const stmt = this.db.prepare("SELECT token, key FROM smapi_tokens WHERE token_key = ?");
const row = stmt.get(tokenKey) as { token: string; key: string } | undefined;
if (!row) {
return undefined;
}
return {
token: row.token,
key: row.key,
};
} catch (error) {
logger.error(`Failed to get token from SQLite store`, { error });
return undefined;
}
}
set(tokenKey: string, fullSmapiToken: SmapiToken): void {
try {
const stmt = this.db.prepare(`
INSERT OR REPLACE INTO smapi_tokens (token_key, token, key)
VALUES (?, ?, ?)
`);
stmt.run(tokenKey, fullSmapiToken.token, fullSmapiToken.key);
logger.debug(`Saved token to SQLite store`);
} catch (error) {
logger.error(`Failed to save token to SQLite store`, { error });
}
}
delete(tokenKey: string): void {
try {
const stmt = this.db.prepare("DELETE FROM smapi_tokens WHERE token_key = ?");
stmt.run(tokenKey);
logger.debug(`Deleted token from SQLite store`);
} catch (error) {
logger.error(`Failed to delete token from SQLite store`, { error });
}
}
getAll(): { [tokenKey: string]: SmapiToken } {
try {
const stmt = this.db.prepare("SELECT token_key, token, key FROM smapi_tokens");
const rows = stmt.all() as Array<{ token_key: string; token: string; key: string }>;
const tokens: { [tokenKey: string]: SmapiToken } = {};
for (const row of rows) {
tokens[row.token_key] = {
token: row.token,
key: row.key,
};
}
return tokens;
} catch (error) {
logger.error(`Failed to get all tokens from SQLite store`, { error });
return {};
}
}
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number {
try {
const tokens = this.getAll();
const tokenKeys = Object.keys(tokens);
let deletedCount = 0;
for (const tokenKey of tokenKeys) {
const smapiToken = tokens[tokenKey];
if (smapiToken) {
const verifyResult = smapiAuthTokens.verify(smapiToken);
// Only delete if token verification fails with InvalidTokenError
// Do NOT delete ExpiredTokenError as those can still be refreshed
if (E.isLeft(verifyResult)) {
const error = verifyResult.left;
// Delete both invalid and expired tokens to prevent accumulation
if (error._tag === 'InvalidTokenError' || error._tag === 'ExpiredTokenError') {
logger.debug(`Deleting ${error._tag} token from SQLite store`);
this.delete(tokenKey);
deletedCount++;
}
}
}
}
if (deletedCount > 0) {
logger.info(`Cleaned up ${deletedCount} invalid token(s) from SQLite store`);
}
return deletedCount;
} catch (error) {
logger.error(`Failed to cleanup expired tokens from SQLite store`, { error });
return 0;
}
}
/**
* Migrate tokens from a JSON file to the SQLite database
* @param jsonFilePath Path to the JSON file containing tokens
* @returns Number of tokens migrated
*/
migrateFromJSON(jsonFilePath: string): number {
try {
if (!fs.existsSync(jsonFilePath)) {
logger.info(`No JSON token file found at ${jsonFilePath}, skipping migration`);
return 0;
}
const data = fs.readFileSync(jsonFilePath, "utf8");
const tokens: { [tokenKey: string]: SmapiToken } = JSON.parse(data);
const tokenKeys = Object.keys(tokens);
let migratedCount = 0;
for (const tokenKey of tokenKeys) {
const token = tokens[tokenKey];
if (token) {
this.set(tokenKey, token);
migratedCount++;
}
}
logger.info(`Migrated ${migratedCount} token(s) from ${jsonFilePath} to SQLite`);
// Optionally rename the old JSON file to .bak
const backupPath = `${jsonFilePath}.bak`;
fs.renameSync(jsonFilePath, backupPath);
logger.info(`Backed up original JSON file to ${backupPath}`);
return migratedCount;
} catch (error) {
logger.error(`Failed to migrate tokens from JSON file ${jsonFilePath}`, { error });
return 0;
}
}
/**
* Close the database connection
*/
close(): void {
try {
this.db.close();
logger.info("SQLite token store connection closed");
} catch (error) {
logger.error("Failed to close SQLite token store connection", { error });
}
}
}

File diff suppressed because it is too large Load Diff

View File

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

View File

@@ -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();
});
});
});

67
tests/api_tokens.test.ts Normal file
View File

@@ -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();
});
});
});

View File

@@ -1,11 +1,24 @@
import { SonosDevice } from "@svrooij/sonos/lib";
import { v4 as uuid } from "uuid";
import { Credentials } from "../src/smapi";
import randomstring from "randomstring";
import { Credentials } from "../src/smapi";
import { Service, Device } from "../src/sonos";
import { Album, Artist, Track, albumToAlbumSummary, artistToArtistSummary, PlaylistSummary, Playlist } from "../src/music_service";
import randomString from "../src/random_string";
import {
Album,
Artist,
Track,
albumToAlbumSummary,
artistToArtistSummary,
PlaylistSummary,
Playlist,
SimilarArtist,
AlbumSummary,
RadioStation
} 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 +42,24 @@ export const aService = (fields: Partial<Service> = {}): Service => ({
...fields,
});
export function aPlaylistSummary(fields: Partial<PlaylistSummary> = {}): PlaylistSummary {
export function aPlaylistSummary(
fields: Partial<PlaylistSummary> = {}
): PlaylistSummary {
return {
id: `playlist-${uuid()}`,
name: `playlistname-${randomString()}`,
...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 +91,11 @@ export function getAppLinkMessage() {
};
}
export function someCredentials(token: string): Credentials {
export function someCredentials({ token, key } : { token: string, key: string }): Credentials {
return {
loginToken: {
token,
key,
householdId: "hh1",
},
deviceId: "d1",
@@ -87,32 +103,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,23 +154,39 @@ 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}`,
mimeType: `audio/mp3-${id}`,
encoding: {
player: "bonob",
mimeType: `audio/mp3-${id}`
},
duration: randomInt(500),
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,12 +199,37 @@ 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 aRadioStation(fields: Partial<RadioStation> = {}): RadioStation {
const id = uuid()
const name = `Station-${id}`;
return {
id,
name,
url: `http://example.com/${name}`,
...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";
export const BLONDIE: Artist = {
@@ -173,7 +243,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 +252,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 +265,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 +304,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 +323,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 +331,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: [],
};

114
tests/burn.test.ts Normal file
View File

@@ -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);
});
});
});

View File

@@ -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);

View File

@@ -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
);
}
);
});

View File

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

View File

@@ -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"]);
});
});

View File

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

View File

@@ -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", () => {

View File

@@ -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,12 +151,19 @@ export class InMemoryMusicService implements MusicService {
playlists: async () => Promise.resolve([]),
playlist: async (id: string) =>
Promise.reject(`No playlist with id ${id}`),
createPlaylist: async (_: string) => Promise.reject("Unsupported operation"),
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([]),
radioStations: async () => Promise.resolve([]),
radioStation: async (_: string) => Promise.reject("Unsupported operation"),
years: async () => Promise.resolve([]),
});
}

View File

@@ -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}`)
});

View File

@@ -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,
});
});
});

View File

@@ -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);
});
});

View File

@@ -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
}),
});
}
@@ -93,7 +94,7 @@ class SonosDriver {
.get(this.bonobUrl.append({ pathname: "/" }).pathname())
.expect(200)
.then((response) => {
const m = response.text.match(/ action="(.*)" /i);
const m = response.text.match(/ action="([^"]+)"/i);
return m![1]!;
});
@@ -272,7 +273,7 @@ describe("scenarios", () => {
bonobUrl,
musicService,
{
linkCodes: () => linkCodes
linkCodes: () => linkCodes,
}
);

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

188
tests/smapi_auth.test.ts Normal file
View File

@@ -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
)
)
);
});
});
});
});

View File

@@ -0,0 +1,234 @@
import fs from "fs";
import path from "path";
import { SQLiteSmapiTokenStore } from "../src/sqlite_smapi_token_store";
import { SmapiToken } from "../src/smapi_auth";
import { JWTSmapiLoginTokens } from "../src/smapi_auth";
import { SystemClock } from "../src/clock";
describe("SQLiteSmapiTokenStore", () => {
const testDbPath = path.join(__dirname, "test-tokens.db");
const testJsonPath = path.join(__dirname, "test-tokens.json");
let tokenStore: SQLiteSmapiTokenStore;
beforeEach(() => {
// Clean up any existing test files
if (fs.existsSync(testDbPath)) {
fs.unlinkSync(testDbPath);
}
if (fs.existsSync(testJsonPath)) {
fs.unlinkSync(testJsonPath);
}
if (fs.existsSync(`${testJsonPath}.bak`)) {
fs.unlinkSync(`${testJsonPath}.bak`);
}
tokenStore = new SQLiteSmapiTokenStore(testDbPath);
});
afterEach(() => {
tokenStore.close();
// Clean up test files
if (fs.existsSync(testDbPath)) {
fs.unlinkSync(testDbPath);
}
if (fs.existsSync(testJsonPath)) {
fs.unlinkSync(testJsonPath);
}
if (fs.existsSync(`${testJsonPath}.bak`)) {
fs.unlinkSync(`${testJsonPath}.bak`);
}
});
describe("Database Initialization", () => {
it("should create database file on initialization", () => {
expect(fs.existsSync(testDbPath)).toBe(true);
});
it("should create parent directory if it doesn't exist", () => {
const nestedPath = path.join(__dirname, "nested", "dir", "tokens.db");
const nestedStore = new SQLiteSmapiTokenStore(nestedPath);
expect(fs.existsSync(nestedPath)).toBe(true);
nestedStore.close();
fs.unlinkSync(nestedPath);
fs.rmdirSync(path.dirname(nestedPath));
fs.rmdirSync(path.dirname(path.dirname(nestedPath)));
});
});
describe("Token Operations", () => {
const testToken: SmapiToken = {
token: "test-jwt-token",
key: "test-key-123",
};
it("should set and get a token", () => {
tokenStore.set("token1", testToken);
const retrieved = tokenStore.get("token1");
expect(retrieved).toEqual(testToken);
});
it("should return undefined for non-existent token", () => {
const retrieved = tokenStore.get("non-existent");
expect(retrieved).toBeUndefined();
});
it("should update existing token", () => {
tokenStore.set("token1", testToken);
const updatedToken: SmapiToken = {
token: "updated-jwt-token",
key: "updated-key-456",
};
tokenStore.set("token1", updatedToken);
const retrieved = tokenStore.get("token1");
expect(retrieved).toEqual(updatedToken);
});
it("should delete a token", () => {
tokenStore.set("token1", testToken);
tokenStore.delete("token1");
const retrieved = tokenStore.get("token1");
expect(retrieved).toBeUndefined();
});
it("should get all tokens", () => {
const token1: SmapiToken = { token: "jwt1", key: "key1" };
const token2: SmapiToken = { token: "jwt2", key: "key2" };
const token3: SmapiToken = { token: "jwt3", key: "key3" };
tokenStore.set("tokenKey1", token1);
tokenStore.set("tokenKey2", token2);
tokenStore.set("tokenKey3", token3);
const allTokens = tokenStore.getAll();
expect(Object.keys(allTokens).length).toBe(3);
expect(allTokens["tokenKey1"]).toEqual(token1);
expect(allTokens["tokenKey2"]).toEqual(token2);
expect(allTokens["tokenKey3"]).toEqual(token3);
});
it("should return empty object when no tokens exist", () => {
const allTokens = tokenStore.getAll();
expect(allTokens).toEqual({});
});
});
describe("Token Cleanup", () => {
it("should cleanup invalid tokens", () => {
const smapiAuthTokens = new JWTSmapiLoginTokens(SystemClock, "test-secret", "1h");
// Create valid tokens
const validToken1 = smapiAuthTokens.issue("service-token-1");
const validToken2 = smapiAuthTokens.issue("service-token-2");
// Create invalid token (wrong secret)
const invalidAuthTokens = new JWTSmapiLoginTokens(SystemClock, "different-secret", "1h");
const invalidToken = invalidAuthTokens.issue("service-token-3");
tokenStore.set("valid1", validToken1);
tokenStore.set("valid2", validToken2);
tokenStore.set("invalid", invalidToken);
// Clean up
const deletedCount = tokenStore.cleanupExpired(smapiAuthTokens);
expect(deletedCount).toBe(1);
expect(tokenStore.get("valid1")).toBeDefined();
expect(tokenStore.get("valid2")).toBeDefined();
expect(tokenStore.get("invalid")).toBeUndefined();
});
it("should not cleanup expired tokens that can be refreshed", () => {
// Note: This test would require mocking time to create an expired token
// For now, we just verify the function runs without error
const smapiAuthTokens = new JWTSmapiLoginTokens(SystemClock, "test-secret", "1h");
const validToken = smapiAuthTokens.issue("service-token-1");
tokenStore.set("token1", validToken);
const deletedCount = tokenStore.cleanupExpired(smapiAuthTokens);
expect(deletedCount).toBe(0);
expect(tokenStore.get("token1")).toBeDefined();
});
});
describe("JSON Migration", () => {
it("should migrate tokens from JSON file", () => {
const jsonTokens = {
token1: { token: "jwt1", key: "key1" },
token2: { token: "jwt2", key: "key2" },
token3: { token: "jwt3", key: "key3" },
};
fs.writeFileSync(testJsonPath, JSON.stringify(jsonTokens, null, 2), "utf8");
const migratedCount = tokenStore.migrateFromJSON(testJsonPath);
expect(migratedCount).toBe(3);
expect(tokenStore.get("token1")).toEqual(jsonTokens.token1);
expect(tokenStore.get("token2")).toEqual(jsonTokens.token2);
expect(tokenStore.get("token3")).toEqual(jsonTokens.token3);
});
it("should create backup of original JSON file", () => {
const jsonTokens = {
token1: { token: "jwt1", key: "key1" },
};
fs.writeFileSync(testJsonPath, JSON.stringify(jsonTokens, null, 2), "utf8");
tokenStore.migrateFromJSON(testJsonPath);
expect(fs.existsSync(`${testJsonPath}.bak`)).toBe(true);
expect(fs.existsSync(testJsonPath)).toBe(false);
});
it("should return 0 when JSON file does not exist", () => {
const migratedCount = tokenStore.migrateFromJSON(testJsonPath);
expect(migratedCount).toBe(0);
});
it("should handle empty JSON file", () => {
fs.writeFileSync(testJsonPath, JSON.stringify({}), "utf8");
const migratedCount = tokenStore.migrateFromJSON(testJsonPath);
expect(migratedCount).toBe(0);
});
});
describe("Persistence", () => {
it("should persist tokens across instances", () => {
const testToken: SmapiToken = { token: "jwt1", key: "key1" };
tokenStore.set("token1", testToken);
tokenStore.close();
// Create new instance with same database
const newStore = new SQLiteSmapiTokenStore(testDbPath);
const retrieved = newStore.get("token1");
expect(retrieved).toEqual(testToken);
newStore.close();
});
});
describe("Close", () => {
it("should close database connection without error", () => {
expect(() => tokenStore.close()).not.toThrow();
});
it("should handle multiple close calls gracefully", () => {
tokenStore.close();
// Second close should not throw
expect(() => tokenStore.close()).not.toThrow();
});
});
});

File diff suppressed because it is too large Load Diff

View File

@@ -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"
]
}

View File

@@ -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. */

View File

@@ -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>

After

Width:  |  Height:  |  Size: 638 B

View File

@@ -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>

After

Width:  |  Height:  |  Size: 293 B

3
web/icons/Star-16101.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 270 B

3
web/icons/Star-43879.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 241 B

View File

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

After

Width:  |  Height:  |  Size: 293 B

3
web/icons/yy.svg Normal file
View File

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

After

Width:  |  Height:  |  Size: 189 B

3
web/icons/yyyy.svg Normal file
View File

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

After

Width:  |  Height:  |  Size: 190 B

View File

@@ -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>

After

Width:  |  Height:  |  Size: 518 B

View File

@@ -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>

After

Width:  |  Height:  |  Size: 890 B

View File

@@ -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>

5
web/public/star0.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 312 B

6
web/public/star1.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 361 B

7
web/public/star2.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 410 B

8
web/public/star3.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 459 B

9
web/public/star4.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 508 B

10
web/public/star5.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 557 B

View File

@@ -1,6 +1,12 @@
<% layout('./layout', { title: it.lang("failure") }) %>
<div id="content">
<h1 class="failure"><%= it.message %></h1>
<h1 class="cause"><%= it.cause || "" %></h1>
<div class="message-container">
<div class="logo">✗</div>
<h1><%= it.message %></h1>
<% if (it.cause) { %>
<p style="color: #dc3545; margin-top: 15px;"><%= it.cause %></p>
<% } %>
<p style="color: #dc3545; font-weight: 600; margin-top: 10px;"><%= it.lang("failure") %></p>
</div>
</div>

View File

@@ -1,45 +1,61 @@
<% layout('./layout') %>
<div id="content">
<div width="100%" style="text-align:right;color:grey"><%= it.version %></div>
<h1><%= it.bonobService.name %> (<%= it.bonobService.sid %>)</h1>
<h3><%= it.lang("expectedConfig") %></h3>
<div><%= JSON.stringify(it.bonobService) %></div>
<br/>
<div id="content" class="index-content">
<div style="text-align:right;color:#999;font-size:0.85rem;margin-bottom:20px"><%= it.version %></div>
<div class="logo">🎵</div>
<h1><%= it.bonobService.name %></h1>
<p style="color:#999;margin-bottom:30px">Service ID: <%= it.bonobService.sid %></p>
<% if(it.devices.length > 0) { %>
<form action="<%= it.createRegistrationRoute %>" method="POST">
<input type="submit" value="<%= it.lang("register") %>">
<form action="<%= it.createRegistrationRoute %>" method="POST" style="margin-bottom:30px">
<input type="submit" value="<%= it.lang("register") %>" id="submit">
</form>
<br/>
<% } else { %>
<h3><%= it.lang("noSonosDevices") %></h3>
<br/>
<p style="color:#dc3545;font-weight:600;margin:30px 0"><%= it.lang("noSonosDevices") %></p>
<% } %>
<% if(it.registeredBonobService) { %>
<h3><%= it.lang("existingServiceConfig") %></h3>
<div><%= JSON.stringify(it.registeredBonobService) %></div>
<div style="margin:20px 0;padding:15px;background:#f8f9fa;border-radius:8px">
<h3 style="font-size:1.1rem;margin-bottom:10px;color:#667eea"><%= it.lang("existingServiceConfig") %></h3>
<pre style="font-size:0.85rem;text-align:left;overflow-x:auto"><%= JSON.stringify(it.registeredBonobService, null, 2) %></pre>
</div>
<% } else { %>
<h3><%= it.lang("noExistingServiceRegistration") %></h3>
<p style="color:#999;margin:20px 0"><%= it.lang("noExistingServiceRegistration") %></p>
<% } %>
<% if(it.registeredBonobService) { %>
<br/>
<form action="<%= it.removeRegistrationRoute %>" method="POST">
<input type="submit" value="<%= it.lang("removeRegistration") %>">
<form action="<%= it.removeRegistrationRoute %>" method="POST" style="margin:20px 0">
<input type="submit" value="<%= it.lang("removeRegistration") %>" id="submit" style="background:#dc3545">
</form>
<% } %>
<br/>
<h2><%= it.lang("devices") %> (<%= it.devices.length %>)</h2>
<ul>
<% it.devices.forEach(function(d){ %>
<li><%= d.name %> (<%= d.ip %>:<%= d.port %>)</li>
<% }) %>
</ul>
<h2><%= it.lang("services") %> (<%= it.services.length %>)</h2>
<ul>
<% it.services.forEach(function(s){ %>
<li><%= s.name %> (<%= s.sid %>)</li>
<% }) %>
</ul>
<div style="margin-top:40px;padding-top:30px;border-top:2px solid #e0e0e0">
<h2 style="font-size:1.5rem;margin-bottom:15px"><%= it.lang("devices") %> (<%= it.devices.length %>)</h2>
<% if(it.devices.length > 0) { %>
<ul style="list-style:none;text-align:left;padding:0">
<% it.devices.forEach(function(d){ %>
<li style="padding:10px;margin:5px 0;background:#f8f9fa;border-radius:6px">
<strong><%= d.name %></strong> <span style="color:#999">(<%= d.ip %>:<%= d.port %>)</span>
</li>
<% }) %>
</ul>
<% } else { %>
<p style="color:#999">No devices found</p>
<% } %>
</div>
<div style="margin-top:30px">
<h2 style="font-size:1.5rem;margin-bottom:15px"><%= it.lang("services") %> (<%= it.services.length %>)</h2>
<% if(it.services.length > 0) { %>
<ul style="list-style:none;text-align:left;padding:0">
<% it.services.forEach(function(s){ %>
<li style="padding:10px;margin:5px 0;background:#f8f9fa;border-radius:6px">
<strong><%= s.name %></strong> <span style="color:#999">(SID: <%= s.sid %>)</span>
</li>
<% }) %>
</ul>
<% } else { %>
<p style="color:#999">No services registered</p>
<% } %>
</div>
</div>

View File

@@ -1,46 +1,189 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><%= it.title || "bonob" %></title>
<style>
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body {
font-family: -apple-system,BlinkMacSystemFont,"Segoe UI","Roboto","Oxygen","Ubuntu","Cantarell","Fira Sans","Droid Sans","Helvetica Neue",sans-serif;
}
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
min-height: 100vh;
display: flex;
align-items: center;
justify-content: center;
padding: 20px;
}
div#content {
margin: auto;
width: 60%;
background: white;
border-radius: 20px;
box-shadow: 0 20px 60px rgba(0, 0, 0, 0.3);
padding: 50px 40px;
max-width: 450px;
width: 100%;
animation: slideIn 0.5s ease-out;
}
@keyframes slideIn {
from {
opacity: 0;
transform: translateY(-30px);
}
to {
opacity: 1;
transform: translateY(0);
}
}
h1 {
font-size: 700%;
font-size: 2.5rem;
font-weight: 700;
color: #333;
text-align: center;
margin-bottom: 40px;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
form {
display: flex;
flex-direction: column;
gap: 25px;
}
.form-group {
display: flex;
flex-direction: column;
gap: 8px;
}
label {
font-size: 300%;
font-size: 0.95rem;
font-weight: 600;
color: #555;
margin-left: 5px;
}
input {
font-size: 300%;
width: 80%;
input[type="text"],
input[type="password"] {
width: 100%;
padding: 15px 20px;
font-size: 1rem;
border: 2px solid #e0e0e0;
border-radius: 12px;
transition: all 0.3s ease;
background: #f8f9fa;
}
input[type="text"]:focus,
input[type="password"]:focus {
outline: none;
border-color: #667eea;
background: white;
box-shadow: 0 0 0 4px rgba(102, 126, 234, 0.1);
transform: translateY(-2px);
}
input#submit {
margin-top: 100px
width: 100%;
padding: 16px;
font-size: 1.1rem;
font-weight: 600;
color: white;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
border: none;
border-radius: 12px;
cursor: pointer;
transition: all 0.3s ease;
margin-top: 10px;
box-shadow: 0 4px 15px rgba(102, 126, 234, 0.4);
}
.one-word-per-line {
word-spacing: 100000px;
input#submit:hover {
transform: translateY(-2px);
box-shadow: 0 6px 20px rgba(102, 126, 234, 0.5);
}
.login{
width: min-intrinsic;
width: -webkit-min-content;
width: -moz-min-content;
width: min-content;
display: table-caption;
display: -ms-grid;
-ms-grid-columns: min-content;
input#submit:active {
transform: translateY(0);
}
.logo {
text-align: center;
margin-bottom: 20px;
font-size: 3rem;
opacity: 0.9;
}
/* Success and failure page styles */
.message-container {
text-align: center;
padding: 20px 0;
}
.message-container h1 {
font-size: 2rem;
margin-bottom: 20px;
}
.message-container p {
font-size: 1.1rem;
color: #666;
line-height: 1.6;
}
/* Index page styles */
.index-content {
text-align: center;
}
.index-content h1 {
font-size: 2.5rem;
margin-bottom: 20px;
}
.index-content p {
font-size: 1.1rem;
color: #666;
line-height: 1.8;
margin-bottom: 15px;
}
.index-content a {
color: #667eea;
text-decoration: none;
font-weight: 600;
transition: color 0.3s ease;
}
.index-content a:hover {
color: #764ba2;
text-decoration: underline;
}
/* Responsive design */
@media (max-width: 500px) {
div#content {
padding: 40px 30px;
}
h1 {
font-size: 2rem;
}
input[type="text"],
input[type="password"] {
padding: 12px 16px;
}
}
</style>
</head>

View File

@@ -1,12 +1,17 @@
<% layout('./layout', { title: it.lang("login") }) %>
<div id="content">
<h1 class="login one-word-per-line"><%= it.lang("logInToBonob") %></h1>
<div class="logo">🎵</div>
<h1><%= it.lang("logInToBonob") %></h1>
<form action="<%= it.loginRoute %>" method="POST">
<label for="username"><%= it.lang("username") %>:</label><br>
<input type="text" id="username" name="username"><br><br>
<label for="password"><%= it.lang("password") %>:</label><br>
<input type="password" id="password" name="password"><br>
<div class="form-group">
<label for="username"><%= it.lang("username") %></label>
<input type="text" id="username" name="username" required autofocus>
</div>
<div class="form-group">
<label for="password"><%= it.lang("password") %></label>
<input type="password" id="password" name="password" required>
</div>
<input type="hidden" name="linkCode" value="<%= it.linkCode %>">
<input type="submit" value="<%= it.lang("login") %>" id="submit">
</form>

View File

@@ -1,5 +1,9 @@
<% layout('./layout', { title: it.lang("success") }) %>
<div id="content">
<h1 class="success"><%= it.message %></h1>
<div class="message-container">
<div class="logo">✓</div>
<h1><%= it.message %></h1>
<p style="color: #28a745; font-weight: 600; margin-top: 10px;"><%= it.lang("success") %></p>
</div>
</div>

7372
yarn.lock

File diff suppressed because it is too large Load Diff