Merge pull request #680 from Mastermindzh/renovate/node-abi-4.x-lockfile

chore(deps): update node-abi to 4.14.0

.drone.yml

@@ -4,12 +4,12 @@ name: default
 
 steps:
   - name: install
-    image: node:19.4.0
+    image: node:22.17.0
     commands:
       - npm install
 
   - name: build_with_linux
-    image: node:19.4.0
+    image: node:22.17.0
     commands:
       - apt-get update && apt-get upgrade -y
       - apt-get install -y libarchive-tools rpm

.github/workflows/build.yml

@@ -9,6 +9,7 @@ on:
     branches-ignore:
       - master
       - develop
+  workflow_dispatch:
 jobs:
   build_on_linux:
     runs-on: ubuntu-latest
@@ -20,26 +21,30 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.12.0
       - run: npm install
       - run: npm run build
+      # - uses: actions/upload-artifact@master
+      #   with:
+      #     name: linux-builds
+      #     path: dist/
 
-  build_on_mac:
+  # build_on_mac:
-    runs-on: macos-latest
+  #   runs-on: macos-latest
-    steps:
+  #   steps:
-      - uses: actions/checkout@master
+  #     - uses: actions/checkout@master
-      - uses: actions/setup-node@master
+  #     - uses: actions/setup-node@master
-        with:
+  #       with:
-          node-version: 19
+  #         node-version: 22.4
-      - run: npm install
+  #     - run: npm install
-      - run: npm run build
+  #     - run: npm run build
 
-  build_on_win:
+  # build_on_win:
-    runs-on: windows-latest
+  #   runs-on: windows-latest
-    steps:
+  #   steps:
-      - uses: actions/checkout@master
+  #     - uses: actions/checkout@master
-      - uses: actions/setup-node@master
+  #     - uses: actions/setup-node@master
-        with:
+  #       with:
-          node-version: 19
+  #         node-version: 22.4
-      - run: npm install
+  #     - run: npm install
-      - run: npm run build
+  #     - run: npm run build

.github/workflows/release.yml

@@ -8,6 +8,7 @@ on:
   pull_request:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
   build_on_linux:
@@ -20,7 +21,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.12.0
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master
@@ -28,30 +29,30 @@ jobs:
           name: linux-builds
           path: dist/
 
-  build_on_mac:
+  # build_on_mac:
-    runs-on: macos-latest
+  #   runs-on: macos-latest
-    steps:
+  #   steps:
-      - uses: actions/checkout@master
+  #     - uses: actions/checkout@master
-      - uses: actions/setup-node@master
+  #     - uses: actions/setup-node@master
-        with:
+  #       with:
-          node-version: 19
+  #         node-version: 22.4
-      - run: npm install
+  #     - run: npm install
-      - run: npm run build
+  #     - run: npm run build
-      - uses: actions/upload-artifact@master
+  #     - uses: actions/upload-artifact@master
-        with:
+  #       with:
-          name: mac-builds
+  #         name: mac-builds
-          path: ./dist/
+  #         path: ./dist/
 
-  build_on_win:
+  # build_on_win:
-    runs-on: windows-latest
+  #   runs-on: windows-latest
-    steps:
+  #   steps:
-      - uses: actions/checkout@master
+  #     - uses: actions/checkout@master
-      - uses: actions/setup-node@master
+  #     - uses: actions/setup-node@master
-        with:
+  #       with:
-          node-version: 19
+  #         node-version: 22.4
-      - run: npm install
+  #     - run: npm install
-      - run: npm run build
+  #     - run: npm run build
-      - uses: actions/upload-artifact@master
+  #     - uses: actions/upload-artifact@master
-        with:
+  #       with:
-          name: windows-builds
+  #         name: windows-builds
-          path: dist/
+  #         path: dist/

.nvmrc

@@ -1 +1 @@
-19.8.1
+v22.12.0

.vscode/http/settings/skipped-artists/addArtists.http

@@ -0,0 +1,5 @@
+POST /settings/skipped-artists HTTP/1.1
+Host: localhost:47836
+Content-Type: application/json
+
+["abc", "def"]

.vscode/http/settings/skipped-artists/addCurrent.http

@@ -0,0 +1,2 @@
+POST /settings/skipped-artists/current HTTP/1.1
+Host: localhost:47836

.vscode/http/settings/skipped-artists/removeArtists.http

@@ -0,0 +1,5 @@
+POST /settings/skipped-artists/delete HTTP/1.1
+Host: localhost:47836
+Content-Type: application/json
+
+["abc", "def"]

.vscode/http/settings/skipped-artists/removeCurrent.http

@@ -0,0 +1,2 @@
+DELETE /settings/skipped-artists/current HTTP/1.1
+Host: localhost:47836

.vscode/settings.json

@@ -2,6 +2,7 @@
   "cSpell.words": [
     "Brainz",
     "Castlabs",
+    "Fi's",
     "flac",
     "Flatpak",
     "geqnfr",
@@ -13,11 +14,12 @@
     "rescrobbler",
     "scrobble",
     "scrobbling",
-    "Songwhip",
     "trackid",
     "tracklist",
     "widevine",
-    "xesam"
+    "wvcus",
+    "xesam",
+    "xhayper"
   ],
   "sonarlint.connectedMode.project": {
     "connectionId": "public-sonarcloud",

CHANGELOG.md

@@ -4,6 +4,102 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.20.1]
+
+- Updated electron to 37.2.5
+
+## [5.20.0]
+
+- Removes the `--enable-features=UseOzonePlatform` flag, as the Ozone platform has been the default on Linux since Electron 28 and this flag is no longer necessary.
+- Adds the `--enable-wayland-ime` flag to enable Input Method Editor (IME) support in Wayland environments, improving the input experience for CJK and other users.
+- Updated various dependencies
+- Updated Electron to 37, potentially fixing [#580](https://github.com/Mastermindzh/tidal-hifi/issues/580)
+
+## [5.19.0]
+
+- Fixed the issue where media updates would cease to work after album names can't be found
+  - Will simply report an empty string when it can't find the album
+- Updated various dependencies
+
+## [5.18.2]
+
+- Reverted to sass 1.79.4 to fix `Nix` builds
+- Changed electron-builder.base.yml to now generate the correct .desktop entries again
+  - Should fix flatpak build
+
+## [5.18.1]
+
+- Fixed the login bug
+- Upgraded electron to 35.1.1
+- Added Widevine/CDM info to startup
+- delayed remote electron initializer
+
+## [5.18.0]
+
+- [Dianoga](https://github.com/Dianoga) fixed the duration selector, restoring mpris & partial API data.
+  - PR: #554
+- Added `xesam:url` property to mpris metadata fixes [#506](https://github.com/Mastermindzh/tidal-hifi/issues/506)
+
+## [5.17.0]
+
+- Added an option to disable the dynamic title and set it to a static one, [#491](https://github.com/Mastermindzh/tidal-hifi/pull/491)
+- Discord integration now says "Listening to" instead of "playing" [#488](https://github.com/Mastermindzh/tidal-hifi/pull/488) && [#454](https://github.com/Mastermindzh/tidal-hifi/pull/454)
+- Fixed several element names in the dom scraper
+- Removed the Songwhip (they shut down) integration and replaced it with TIDAL's universal link system
+
+## [5.16.0]
+
+- Fix issue #449 Discord RPC stuck on "Browsing Tidal".
+- Fix issue #448 Add option to disable the discord rpc idle text
+- Notifications are now send at the end of the update process, allowing other events to happen sooner.
+
+## [5.15.0]
+
+- Added all missing swagger/openApi info with the help of [Times-Z](https://github.com/Times-Z)
+- Updated most dependency versions
+  - This includes Electron 31!
+
+- Added a channel selector so we can now use Tidal's staging environment directly from the app
+  - implements [#437](https://github.com/Mastermindzh/tidal-hifi/issues/437)
+
+## [5.14.1]
+
+- Fixed `getAlbumName` not finding album name whilst on queue page
+- Added all mediaInfo to mpris interface using the `custom:` prefix
+
+## [5.14]
+
+- Simplified `MediaInfo` & `Options` types
+- Added `playingFrom` information to the info API
+  - also changed the way we update Album info since Playing From now shows the correct Album.
+- API now allows you to set the `hostname` so you can control who can interact with the API.
+- Reworked swagger generation hotfix to properly generate `swagger.json` during the compile step
+  - Might switch to tsoa in the future, idk yet.
+- Added [Tidal Magazine](https://tidal.com/magazine/) integration (in the menubar or use `Ctrl + M`)
+
+## [5.13.1]
+
+- removed Swagger generation step in favor of pre-generated file.
+  - This also fixes the API issue [#409](https://github.com/Mastermindzh/tidal-hifi/issues/409)
+  - This also stops TIDAL-hifi from scanning your entire home directory... the glob was very broad apparently.
+
+## [5.13.0]
+
+- Fixed [#403](https://github.com/Mastermindzh/tidal-hifi/issues/403) "cannot read shuffle of undefined" error
+- Added an API to add & delete entries from the skippedArtists list in the settings. fixes [#405](https://github.com/Mastermindzh/tidal-hifi/issues/405)
+  - `GET /settings/skipped-artists` -> get list of skipped artists
+  - `POST /settings/skipped-artists` -> add to the list of skipped artists
+  - `POST /settings/skipped-artists/delete` -> delete from the list of skipped artists
+  - `POST /settings/skipped-artists/current` -> skip the current artist
+  - `DELETE /settings/skipped-artists/current` -> delete the current artist from the skip list
+  - Added Swagger documentation to the new endpoints:
+    ![picture of swagger documentation](./docs/images/swagger.png)
+- CORS support added by [Mjokfox](https://github.com/Mjokfox)
+
+## [5.12.0]
+
+- Added Shuffle and Repeat state to API response - By [ThatGravyBoat](https://github.com/ThatGravyBoat)
+
 ## [5.11.0]
 
 - Re-implemented the API, added support for duration/current in seconds & shuffle+repeat

README.md

@@ -26,7 +26,7 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
     - [Using source](#using-source)
   - [Integrations](#integrations)
   - [Known bugs](#known-bugs)
-    - [DRM not working on Windows](#drm-not-working-on-windows)
+    - [DRM not working on Windows (error S6007)](#drm-not-working-on-windows-error-s6007)
   - [Special thanks to](#special-thanks-to)
   - [Donations](#donations)
   - [Images](#images)
@@ -43,13 +43,13 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
 - Custom hotkeys ([source](https://defkey.com/tidal-desktop-shortcuts))
 - Better icons thanks to [Papirus-icon-theme](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme/)
 - [Settings feature](./docs/images/settings.png) to disable certain functionality. (`ctrl+=` or `ctrl+0`)
-- API for status and playback
+- API for status, playback and settings (see the [/docs](http://localhost:47836/docs/) route)
 - Disabled audio & visual ads, unlocked lyrics, suggested track, track info, and unlimited skips thanks to uBlockOrigin custom filters ([source](https://github.com/uBlockOrigin/uAssets/issues/17495))
 - AlbumArt in integrations ([best-effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847))
 - Custom [integrations](#integrations)
   - [ListenBrainz](https://listenbrainz.org/?redirect=false) integration
-  - Songwhip.com integration (hotkey `ctrl + w`)
   - Discord RPC integration (showing "now listening", "Browsing", etc)
+    - Flatpak version only works if both Discord and Tidal-HiFi are flatpaks
   - MPRIS integration
 - UI + Json config (`~/.config/tidal-hifi/`, or `~/.var/app/com.mastermindzh.tidal-hifi/` for Flatpak)
 
@@ -130,7 +130,7 @@ nix-env -iA nixpkgs.tidal-hifi
 
 To install and work with the code on this project follow these steps:
 
-- `git clone [https://github.com/Mastermindzh/tidal-hifi.git](https://github.com/Mastermindzh/tidal-hifi.git)`
+- `git clone https://github.com/Mastermindzh/tidal-hifi.git`
 - `cd tidal-hifi`
 - `npm install`
 - `npm run watch` to watch for auto-reload of Typescript/SCSS changes.
@@ -152,11 +152,13 @@ Integrations with other projects that are not included natively:
 
 ## Known bugs
 
-### DRM not working on Windows
+### DRM not working on Windows (error S6007)
 
 Most Windows users run into DRM issues when trying to use TIDAL Hi-Fi.
 Nothing I can do about that I'm afraid... Tidal is working on removing/changing DRM so when they finish with that we can give it another shot.
 
+Until then you'll have to use the official app unfortunately.
+
 ## Special thanks to
 
 - [Castlabs](https://castlabs.com/)

build/electron-builder.base.yml

@@ -1,7 +1,7 @@
 appId: com.rickvanlieshout.tidal-hifi
-electronVersion: 28.1.1
+electronVersion: 37.2.5
 electronDownload:
-  version: 28.1.1+wvcus
+  version: 37.2.5+wvcus
   mirror: https://github.com/castlabs/electron-releases/releases/download/v
 snap:
   plugs:
@@ -17,24 +17,25 @@ linux:
   executableName: tidal-hifi
   executableArgs:
     [
-      "--enable-features=UseOzonePlatform",
       "--ozone-platform-hint=auto",
       "--enable-features=WaylandWindowDecorations",
+      "--enable-wayland-ime",
+      "--use-angle",
     ]
   desktop:
-    Encoding: UTF-8
+    entry:
-    Name: TIDAL Hi-Fi
+      Encoding: "UTF-8"
-    GenericName: TIDAL Hi-Fi
+      Name: "TIDAL Hi-Fi"
-    Comment: The web version of listen.tidal.com running in electron with hifi support thanks to widevine.
+      GenericName: "TIDAL Hi-Fi"
-    Icon: tidal-hifi
+      Comment: "The web version of listen.tidal.com running in electron with hifi support thanks to widevine."
-    StartupNotify: true
+      Icon: "tidal-hifi"
-    Terminal: false
+      StartupNotify: "true"
-    Type: Application
+      Terminal: "false"
-    Categories: Network;Application;AudioVideo;Audio;Video
+      Type: "Application"
-    StartupWMClass: tidal-hifi
+      Categories: "Network;Application;AudioVideo;Audio;Video"
-    X-PulseAudio-Properties: media.role=music
+      StartupWMClass: "tidal-hifi"
-    MimeType: x-scheme-handler/tidal;
+      X-PulseAudio-Properties: "media.role=music"
-
+      MimeType: "x-scheme-handler/tidal;"
 mac:
   category: public.app-category.entertainment
 win:

package.json

@@ -1,16 +1,17 @@
 {
   "name": "tidal-hifi",
-  "version": "5.11.0",
+  "version": "5.20.1",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {
-    "start": "electron --inspect=0.0.0.0:5858 .",
+    "start": "electron --inspect=0.0.0.0:5858 --remote-debugging-port=8315 --remote-allow-origins=* .",
     "watchStart": "nodemon dist -x \"npm run start\"",
     "compile": "tsc && npm run sass-and-copy",
     "deps": "npm run watch",
-    "watch": "tsc-watch --onSuccess \"npm run sass-and-copy\"",
+    "watch": "tsc-watch --onSuccess \"npm run compile-all\"",
     "copy-files": "copyfiles -u 1 --exclude './src/**/*.ts' --exclude './src/**/*.scss' \"./src/**/*\" ts-dist",
     "copy-themes-dev": "copyfiles -u 1 \"./themes/*\" node_modules/electron/dist/resources",
+    "compile-all": "npm run sass-and-copy && ts-node scripts/generate-swagger.ts",
     "sass-and-copy": "npm run sass && npm run copy-files && npm run copy-themes-dev",
     "build": "npm run builder -- -c ./build/electron-builder.yml",
     "build-deb": "npm run builder -- -c ./build/electron-builder.deb.yml",
@@ -39,38 +40,45 @@
   "homepage": "https://github.com/Mastermindzh/tidal-hifi",
   "license": "MIT",
   "dependencies": {
-    "@electron/remote": "^2.1.2",
+    "@electron/remote": "^2.1.3",
-    "axios": "^1.6.8",
+    "@types/swagger-jsdoc": "^6.0.4",
-    "discord-rpc": "^4.0.1",
+    "@xhayper/discord-rpc": "1.3.0",
+    "axios": "^1.10.0",
+    "cors": "^2.8.5",
     "electron-store": "^8.2.0",
-    "express": "^4.19.2",
+    "express": "^5.1.0",
-    "hotkeys-js": "^3.13.7",
+    "hotkeys-js": "^3.13.15",
     "mpris-service": "^2.1.2",
     "request": "^2.88.2",
-    "sass": "^1.75.0"
+    "sass": "1.92.0",
+    "swagger-ui-express": "^5.0.1"
   },
   "devDependencies": {
     "@mastermindzh/prettier-config": "^1.0.0",
-    "@types/discord-rpc": "^4.0.8",
+    "@types/cors": "^2.8.19",
-    "@types/express": "^4.17.21",
+    "@types/express": "^5.0.3",
-    "@types/node": "^20.10.6",
+    "@types/node": "^22.16.2",
     "@types/request": "^2.48.12",
-    "@typescript-eslint/eslint-plugin": "^6.18.0",
+    "@types/swagger-ui-express": "^4.1.8",
-    "@typescript-eslint/parser": "^6.18.0",
+    "@typescript-eslint/eslint-plugin": "^8.36.0",
+    "@typescript-eslint/parser": "^8.36.0",
     "copyfiles": "^2.4.1",
-    "electron": "git+https://github.com/castlabs/electron-releases#v28.1.1+wvcus",
+    "electron": "github:castlabs/electron-releases#v37.2.5+wvcus",
-    "electron-builder": "^24.9.1",
+    "electron-builder": "~26.0.12",
-    "eslint": "^8.56.0",
+    "eslint": "^9.30.1",
     "js-yaml": "^4.1.0",
     "markdown-toc": "^1.2.0",
-    "nodemon": "^3.0.2",
+    "node-abi": "^4.12.0",
-    "prettier": "^3.1.1",
+    "nodemon": "^3.1.10",
-    "stylelint": "^16.1.0",
+    "prettier": "^3.6.2",
-    "stylelint-config-standard": "^36.0.0",
+    "stylelint": "^16.21.1",
-    "stylelint-config-standard-scss": "^13.0.0",
+    "stylelint-config-standard": "^39.0.0",
-    "stylelint-prettier": "^5.0.0",
+    "stylelint-config-standard-scss": "^15.0.1",
-    "tsc-watch": "^6.0.4",
+    "stylelint-prettier": "^5.0.3",
-    "typescript": "^5.3.3"
+    "swagger-jsdoc": "^6.2.8",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^7.1.1",
+    "typescript": "^5.8.3"
   },
   "prettier": "@mastermindzh/prettier-config"
 }

renovate.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "ignoreDeps": ["@types/node", "electron-store", "@xhayper/discord-rpc"]
+}

scripts/generate-swagger.ts

@@ -0,0 +1,30 @@
+import fs from "fs";
+import swaggerjsdoc from "swagger-jsdoc";
+import packagejson from "./../package.json";
+
+const specs = swaggerjsdoc({
+  definition: {
+    openapi: "3.1.0",
+    info: {
+      title: "TIDAL Hi-Fi API",
+      version: packagejson.version,
+      description: "",
+      license: {
+        name: packagejson.license,
+        url: "https://github.com/Mastermindzh/tidal-hifi/blob/master/LICENSE",
+      },
+      contact: {
+        name: "Rick <mastermindzh> van Lieshout",
+        url: "https://www.rickvanlieshout.com",
+      },
+    },
+    externalDocs: {
+      description: "swagger.json",
+      url: "swagger.json",
+    },
+  },
+  apis: ["**/*.ts"],
+});
+
+fs.writeFileSync("src/features/api/swagger.json", JSON.stringify(specs, null, 2), "utf8");
+console.log("Written swagger.json");

scripts/verifyElements.js

@@ -16,16 +16,19 @@
     search: '[class^="searchField"]',
     shuffle: '*[data-test="shuffle"]',
     repeat: '*[data-test="repeat"]',
-    account: '*[class^="profileOptions"]',
+    account: '*[data-test^="profile-image-button"]',
-    settings: '*[data-test^="open-settings"]',
+    settings: '*[data-test^="sidebar-menu-button"]',
+    openSettings: '*[data-test^="open-settings"]',
     media: '*[data-test="current-media-imagery"]',
     image: "img",
     current: '*[data-test="current-time"]',
-    duration: '*[class^=playbackControlsContainer] *[data-test="duration"]',
+    duration: '*[class^=_playbackControlsContainer] *[data-test="duration"]',
     bar: '*[data-test="progress-bar"]',
     footer: "#footerPlayer",
     mediaItem: "[data-type='mediaItem']",
-    album_header_title: '.header-details [data-test="title"]',
+    album_header_title: '*[class^="_playingFrom"] span:nth-child(2)',
+    playing_from: '*[class^="_playingFrom"] span:nth-child(2)',
+    queue_album: "*[class^=playQueueItemsContainer] *[class^=groupTitle] span:nth-child(2)",
     currentlyPlaying: "[class^='isPlayingIcon'], [data-test-is-playing='true']",
     album_name_cell: '[class^="album"]',
     tracklist_row: '[data-test="tracklist-row"]',

src/constants/globalEvents.ts

@@ -10,7 +10,7 @@ export const globalEvents = {
   showSettings: "showSettings",
   storeChanged: "storeChanged",
   error: "error",
-  whip: "whip",
+  getUniversalLink: "getUniversalLink",
   log: "log",
   toggleFavorite: "toggleFavorite",
   toggleShuffle: "toggleShuffle",

src/constants/settings.ts

@@ -10,10 +10,15 @@
  */
 export const settings = {
   adBlock: "adBlock",
+  advanced: {
+    root: "advanced",
+    tidalUrl: "advanced.tidalUrl",
+  },
   api: "api",
   apiSettings: {
     root: "apiSettings",
     port: "apiSettings.port",
+    hostname: "apiSettings.hostname",
   },
   customCSS: "customCSS",
   disableBackgroundThrottle: "disableBackgroundThrottle",
@@ -25,6 +30,7 @@ export const settings = {
     buttonText: "discord.buttonText",
     includeTimestamps: "discord.includeTimestamps",
     showSong: "discord.showSong",
+    showIdle: "discord.showIdle",
     idleText: "discord.idleText",
     usingText: "discord.usingText",
   },
@@ -49,6 +55,7 @@ export const settings = {
   singleInstance: "singleInstance",
   skipArtists: "skipArtists",
   skippedArtists: "skippedArtists",
+  staticWindowTitle: "staticWindowTitle",
   theme: "theme",
   trayIcon: "trayIcon",
   updateFrequency: "updateFrequency",

src/features/api/features/current.ts

@@ -3,7 +3,111 @@ import fs from "fs";
 import { mediaInfo } from "../../../scripts/mediaInfo";
 
 export const addCurrentInfo = (expressApp: Router) => {
-  expressApp.get("/current", (req, res) => res.json({ ...mediaInfo, artist: mediaInfo.artists }));
+  /**
+   * @swagger
+   * tags:
+   *   name: current
+   *   description: The current media info API
+   * components:
+   *   schemas:
+   *     MediaInfo:
+   *       type: object
+   *       properties:
+   *         title:
+   *           type: string
+   *         artists:
+   *           type: string
+   *         album:
+   *           type: string
+   *         icon:
+   *           type: string
+   *           format: uri
+   *         playingFrom:
+   *           type: string
+   *         status:
+   *           type: string
+   *         url:
+   *           type: string
+   *           format: uri
+   *         current:
+   *           type: string
+   *         currentInSeconds:
+   *           type: integer
+   *         duration:
+   *           type: string
+   *         durationInSeconds:
+   *           type: integer
+   *         image:
+   *           type: string
+   *           format: uri
+   *         favorite:
+   *           type: boolean
+   *         player:
+   *           type: object
+   *           properties:
+   *             status:
+   *               type: string
+   *             shuffle:
+   *               type: boolean
+   *             repeat:
+   *               type: string
+   *         artist:
+   *           type: string
+   *       example:
+   *         title: "Sample Title"
+   *         artists: "Sample Artist"
+   *         album: "Sample Album"
+   *         icon: "/path/to/sample/icon.jpg"
+   *         playingFrom: "Sample Playlist"
+   *         status: "playing"
+   *         url: "https://tidal.com/browse/track/sample"
+   *         current: "1:23"
+   *         currentInSeconds: 83
+   *         duration: "3:45"
+   *         durationInSeconds: 225
+   *         image: "https://example.com/sample-image.jpg"
+   *         favorite: true
+   *         player:
+   *           status: "playing"
+   *           shuffle: true
+   *           repeat: "one"
+   *         artist: "Sample Artist"
+   */
+
+  /**
+   * @swagger
+   * /current:
+   *   get:
+   *     summary: Get current media info
+   *     tags: [current]
+   *     responses:
+   *       200:
+   *         description: Current media info
+   *         content:
+   *           application/json:
+   *             schema:
+   *               $ref: '#/components/schemas/MediaInfo'
+   */
+  expressApp.get("/current", (_req, res) => {
+    res.json({ ...mediaInfo, artist: mediaInfo.artists });
+  });
+  /**
+   * @swagger
+   * /current/image:
+   *   get:
+   *     summary: Get current media image
+   *     tags: [current]
+   *     responses:
+   *       200:
+   *         description: Current media image
+   *         content:
+   *           image/png:
+   *             schema:
+   *               type: string
+   *               format: binary
+   *       404:
+   *         description: Not found
+   */
   expressApp.get("/current/image", getCurrentImage);
 };
 

src/features/api/features/player.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import { BrowserWindow } from "electron";
 import { Router } from "express";
 import { globalEvents } from "../../../constants/globalEvents";
@@ -12,19 +11,148 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
   const windowEvent = handleWindowEvent(mainWindow);
   const createRoute = (route: string) => `/player${route}`;
 
+  /**
+   * @swagger
+   * tags:
+   *   name: player
+   *   description: The player control API
+   * components:
+   *   schemas:
+   *     OkResponse:
+   *       type: string
+   *       example: "OK"
+   */
   const createPlayerAction = (route: string, action: string) => {
     expressApp.post(createRoute(route), (req, res) => windowEvent(res, action));
   };
 
   if (settingsStore.get(settings.playBackControl)) {
+    /**
+     * @swagger
+     * /player/play:
+     *   post:
+     *     summary: Play the current media
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/play", globalEvents.play);
+
+    /**
+     * @swagger
+     * /player/favorite/toggle:
+     *   post:
+     *     summary: Add the current media to your favorites, or remove it if its already added to your favorites
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/favorite/toggle", globalEvents.toggleFavorite);
+
+    /**
+     * @swagger
+     * /player/pause:
+     *   post:
+     *     summary: Pause the current media
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/pause", globalEvents.pause);
+
+    /**
+     * @swagger
+     * /player/next:
+     *   post:
+     *     summary: Play the next song
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/next", globalEvents.next);
+
+    /**
+     * @swagger
+     * /player/previous:
+     *   post:
+     *     summary: Play the previous song
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/previous", globalEvents.previous);
+
+    /**
+     * @swagger
+     * /player/shuffle/toggle:
+     *   post:
+     *     summary: Play the previous song
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/shuffle/toggle", globalEvents.toggleShuffle);
+
+    /**
+     * @swagger
+     * /player/repeat/toggle:
+     *   post:
+     *     summary: Toggle the repeat status, toggles between "off" , "single" and "all"
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/repeat/toggle", globalEvents.toggleRepeat);
 
+    /**
+     * @swagger
+     * /player/playpause:
+     *   post:
+     *     summary: Start playing the media if paused, or pause the media if playing
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.post(createRoute("/playpause"), (req, res) => {
       if (mediaInfo.status === MediaStatus.playing) {
         windowEvent(res, globalEvents.pause);

src/features/api/features/settings/settings.ts

@@ -0,0 +1,121 @@
+import { Request, Router } from "express";
+import { settings } from "../../../../constants/settings";
+import { mediaInfo } from "../../../../scripts/mediaInfo";
+import {
+  addSkippedArtists,
+  removeSkippedArtists,
+  settingsStore,
+} from "../../../../scripts/settings";
+import { BrowserWindow } from "electron";
+import { globalEvents } from "../../../../constants/globalEvents";
+
+/**
+ * @swagger
+ * tags:
+ *   name: settings
+ *   description: The settings management API
+ * components:
+ *   schemas:
+ *     StringArray:
+ *       type: array
+ *       items:
+ *         type: string
+ *       example: ["Artist1", "Artist2"]
+ *
+ * @param expressApp
+ * @param mainWindow
+ */
+export const addSettingsAPI = (expressApp: Router, mainWindow: BrowserWindow) => {
+  /**
+   * @swagger
+   * /settings/skipped-artists:
+   *   get:
+   *     summary: get a list of artists that TIDAL Hi-Fi will skip if skipping is enabled
+   *     tags: [settings]
+   *     responses:
+   *       200:
+   *         description: The list book.
+   *         content:
+   *           application/json:
+   *             schema:
+   *              $ref: '#/components/schemas/StringArray'
+   */
+  expressApp.get("/settings/skipped-artists", (req, res) => {
+    res.json(settingsStore.get<string, string[]>(settings.skippedArtists));
+  });
+
+  /**
+   * @swagger
+   * /settings/skipped-artists:
+   *   post:
+   *     summary: Add new artists to the list of skipped artists
+   *     tags: [settings]
+   *     requestBody:
+   *       required: true
+   *       content:
+   *         application/json:
+   *           schema:
+   *             $ref: '#/components/schemas/StringArray'
+   *     responses:
+   *       200:
+   *         description: Ok
+   */
+  expressApp.post("/settings/skipped-artists", (req: Request<object, object, string[]>, res) => {
+    addSkippedArtists(req.body);
+    res.sendStatus(200);
+  });
+
+  /**
+   * @swagger
+   * /settings/skipped-artists/delete:
+   *   post:
+   *     summary: Remove artists from the list of skipped artists
+   *     tags: [settings]
+   *     requestBody:
+   *       required: true
+   *       content:
+   *         application/json:
+   *           schema:
+   *             $ref: '#/components/schemas/StringArray'
+   *     responses:
+   *       200:
+   *         description: Ok
+   */
+  expressApp.post(
+    "/settings/skipped-artists/delete",
+    (req: Request<object, object, string[]>, res) => {
+      removeSkippedArtists(req.body);
+      res.sendStatus(200);
+    }
+  );
+
+  /**
+   * @swagger
+   * /settings/skipped-artists/current:
+   *   post:
+   *     summary: Add the current artist to the list of skipped artists
+   *     tags: [settings]
+   *     responses:
+   *       200:
+   *        description: Ok
+   */
+  expressApp.post("/settings/skipped-artists/current", (req, res) => {
+    addSkippedArtists([mediaInfo.artists]);
+    mainWindow.webContents.send("globalEvent", globalEvents.next);
+    res.sendStatus(200);
+  });
+  /**
+   * @swagger
+   * /settings/skipped-artists/current:
+   *   delete:
+   *     summary: Remove the current artist from the list of skipped artists
+   *     tags: [settings]
+   *     responses:
+   *       200:
+   *        description: Ok
+   */
+  expressApp.delete("/settings/skipped-artists/current", (req, res) => {
+    removeSkippedArtists([mediaInfo.artists]);
+    res.sendStatus(200);
+  });
+};

src/features/api/index.ts

@@ -1,25 +1,40 @@
+import cors from "cors";
 import { BrowserWindow, dialog } from "electron";
 import express from "express";
-import { settings } from "../../constants/settings";
+import swaggerUi from "swagger-ui-express";
 import { settingsStore } from "../../scripts/settings";
+import { settings } from "./../../constants/settings";
 import { addCurrentInfo } from "./features/current";
 import { addPlaybackControl } from "./features/player";
+import { addSettingsAPI } from "./features/settings/settings";
 import { addLegacyApi } from "./legacy";
+import swaggerSpec from "./swagger.json";
 
 /**
  * Function to enable TIDAL Hi-Fi's express api
  */
 export const startApi = (mainWindow: BrowserWindow) => {
+  const port = settingsStore.get<string, number>(settings.apiSettings.port);
+  const hostname = settingsStore.get<string, string>(settings.apiSettings.hostname) ?? "127.0.0.1";
+
   const expressApp = express();
-  expressApp.get("/", (req, res) => res.send("Hello World!"));
+  expressApp.use(cors());
+  expressApp.use(express.json());
+  expressApp.use("/docs", swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+  expressApp.get("/", (req, res) => {
+    res.send("Hello World!");
+  });
+  expressApp.get("/swagger.json", (req, res) => {
+    res.json(swaggerSpec);
+  });
 
   // add features
   addLegacyApi(expressApp, mainWindow);
   addPlaybackControl(expressApp, mainWindow);
   addCurrentInfo(expressApp);
+  addSettingsAPI(expressApp, mainWindow);
 
-  const port = settingsStore.get<string, number>(settings.apiSettings.port);
+  const expressInstance = expressApp.listen(port, hostname);
-  const expressInstance = expressApp.listen(port, "127.0.0.1");
   expressInstance.on("error", function (e: { code: string }) {
     let message = e.code;
     if (e.code === "EADDRINUSE") {

src/features/api/legacy.ts

@@ -13,19 +13,132 @@ import { getCurrentImage } from "./features/current";
  * @param mainWindow
  */
 export const addLegacyApi = (expressApp: Router, mainWindow: BrowserWindow) => {
+  /**
+   * @swagger
+   * /image:
+   *   get:
+   *     summary: Get current image
+   *     tags: [legacy]
+   *     deprecated: true
+   *     responses:
+   *       200:
+   *         description: Current image
+   *         content:
+   *           image/png:
+   *             schema:
+   *               type: string
+   *               format: binary
+   *       404:
+   *         description: Not found
+   */
   expressApp.get("/image", getCurrentImage);
 
   if (settingsStore.get(settings.playBackControl)) {
     addLegacyControls();
   }
   function addLegacyControls() {
+    /**
+     * @swagger
+     * /play:
+     *   get:
+     *     summary: Play the current media
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Action performed
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/play", ({ res }) => handleGlobalEvent(res, globalEvents.play));
+
+    /**
+     * @swagger
+     * /favorite/toggle:
+     *   get:
+     *     summary: Add the current media to your favorites, or remove it if its already added to your favorites
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.post("/favorite/toggle", (req, res) =>
       handleGlobalEvent(res, globalEvents.toggleFavorite)
     );
+
+    /**
+     * @swagger
+     * /pause:
+     *   get:
+     *     summary: Pause the current media
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/pause", (req, res) => handleGlobalEvent(res, globalEvents.pause));
+
+    /**
+     * @swagger
+     * /next:
+     *   get:
+     *     summary: Play the next song
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/next", (req, res) => handleGlobalEvent(res, globalEvents.next));
+
+    /**
+     * @swagger
+     * /previous:
+     *   get:
+     *     summary: Play the previous song
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/previous", (req, res) => handleGlobalEvent(res, globalEvents.previous));
+
+    /**
+     * @swagger
+     * /playpause:
+     *   get:
+     *     summary: Toggle play/pause
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/playpause", (req, res) => {
       if (mediaInfo.status === MediaStatus.playing) {
         handleGlobalEvent(res, globalEvents.pause);

src/features/api/swagger.json

@@ -0,0 +1,535 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "TIDAL Hi-Fi API",
+    "version": "5.20.1",
+    "description": "",
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/Mastermindzh/tidal-hifi/blob/master/LICENSE"
+    },
+    "contact": {
+      "name": "Rick <mastermindzh> van Lieshout",
+      "url": "https://www.rickvanlieshout.com"
+    }
+  },
+  "externalDocs": {
+    "description": "swagger.json",
+    "url": "swagger.json"
+  },
+  "paths": {
+    "/current": {
+      "get": {
+        "summary": "Get current media info",
+        "tags": ["current"],
+        "responses": {
+          "200": {
+            "description": "Current media info",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MediaInfo"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/current/image": {
+      "get": {
+        "summary": "Get current media image",
+        "tags": ["current"],
+        "responses": {
+          "200": {
+            "description": "Current media image",
+            "content": {
+              "image/png": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not found"
+          }
+        }
+      }
+    },
+    "/player/play": {
+      "post": {
+        "summary": "Play the current media",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/favorite/toggle": {
+      "post": {
+        "summary": "Add the current media to your favorites, or remove it if its already added to your favorites",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/pause": {
+      "post": {
+        "summary": "Pause the current media",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/next": {
+      "post": {
+        "summary": "Play the next song",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/previous": {
+      "post": {
+        "summary": "Play the previous song",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/shuffle/toggle": {
+      "post": {
+        "summary": "Play the previous song",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/repeat/toggle": {
+      "post": {
+        "summary": "Toggle the repeat status, toggles between \"off\" , \"single\" and \"all\"",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/playpause": {
+      "post": {
+        "summary": "Start playing the media if paused, or pause the media if playing",
+        "tags": ["player"],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/settings/skipped-artists": {
+      "get": {
+        "summary": "get a list of artists that TIDAL Hi-Fi will skip if skipping is enabled",
+        "tags": ["settings"],
+        "responses": {
+          "200": {
+            "description": "The list book.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/StringArray"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "summary": "Add new artists to the list of skipped artists",
+        "tags": ["settings"],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/StringArray"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Ok"
+          }
+        }
+      }
+    },
+    "/settings/skipped-artists/delete": {
+      "post": {
+        "summary": "Remove artists from the list of skipped artists",
+        "tags": ["settings"],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/StringArray"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Ok"
+          }
+        }
+      }
+    },
+    "/settings/skipped-artists/current": {
+      "post": {
+        "summary": "Add the current artist to the list of skipped artists",
+        "tags": ["settings"],
+        "responses": {
+          "200": {
+            "description": "Ok"
+          }
+        }
+      },
+      "delete": {
+        "summary": "Remove the current artist from the list of skipped artists",
+        "tags": ["settings"],
+        "responses": {
+          "200": {
+            "description": "Ok"
+          }
+        }
+      }
+    },
+    "/image": {
+      "get": {
+        "summary": "Get current image",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Current image",
+            "content": {
+              "image/png": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not found"
+          }
+        }
+      }
+    },
+    "/play": {
+      "get": {
+        "summary": "Play the current media",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Action performed",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/favorite/toggle": {
+      "get": {
+        "summary": "Add the current media to your favorites, or remove it if its already added to your favorites",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/pause": {
+      "get": {
+        "summary": "Pause the current media",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/next": {
+      "get": {
+        "summary": "Play the next song",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/previous": {
+      "get": {
+        "summary": "Play the previous song",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/playpause": {
+      "get": {
+        "summary": "Toggle play/pause",
+        "tags": ["legacy"],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "MediaInfo": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string"
+          },
+          "artists": {
+            "type": "string"
+          },
+          "album": {
+            "type": "string"
+          },
+          "icon": {
+            "type": "string",
+            "format": "uri"
+          },
+          "playingFrom": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          },
+          "url": {
+            "type": "string",
+            "format": "uri"
+          },
+          "current": {
+            "type": "string"
+          },
+          "currentInSeconds": {
+            "type": "integer"
+          },
+          "duration": {
+            "type": "string"
+          },
+          "durationInSeconds": {
+            "type": "integer"
+          },
+          "image": {
+            "type": "string",
+            "format": "uri"
+          },
+          "favorite": {
+            "type": "boolean"
+          },
+          "player": {
+            "type": "object",
+            "properties": {
+              "status": {
+                "type": "string"
+              },
+              "shuffle": {
+                "type": "boolean"
+              },
+              "repeat": {
+                "type": "string"
+              }
+            }
+          },
+          "artist": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "title": "Sample Title",
+          "artists": "Sample Artist",
+          "album": "Sample Album",
+          "icon": "/path/to/sample/icon.jpg",
+          "playingFrom": "Sample Playlist",
+          "status": "playing",
+          "url": "https://tidal.com/browse/track/sample",
+          "current": "1:23",
+          "currentInSeconds": 83,
+          "duration": "3:45",
+          "durationInSeconds": 225,
+          "image": "https://example.com/sample-image.jpg",
+          "favorite": true,
+          "player": {
+            "status": "playing",
+            "shuffle": true,
+            "repeat": "one"
+          },
+          "artist": "Sample Artist"
+        }
+      },
+      "OkResponse": {
+        "type": "string",
+        "example": "OK"
+      },
+      "StringArray": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "example": ["Artist1", "Artist2"]
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "current",
+      "description": "The current media info API"
+    },
+    {
+      "name": "player",
+      "description": "The player control API"
+    },
+    {
+      "name": "settings",
+      "description": "The settings management API"
+    }
+  ]
+}

src/features/listenbrainz/listenbrainz.ts

@@ -48,6 +48,9 @@ export class ListenBrainz {
       } else {
         // Fetches the oldData required for scrobbling and proceeds to construct a playing_now data payload for the Playing Now area
         const oldData = ListenBrainzStore.get(ListenBrainzConstants.oldData) as StoreData;
+        const tidalUrl =
+          settingsStore.get<string, string>(settings.advanced.tidalUrl) ||
+          "https://listen.tidal.com";
         const playing_data = {
           listen_type: "playing_now",
           payload: [
@@ -95,7 +98,7 @@ export class ListenBrainz {
                     additional_info: {
                       media_player: "Tidal Hi-Fi",
                       submission_client: "Tidal Hi-Fi",
-                      music_service: "listen.tidal.com",
+                      music_service: tidalUrl,
                       duration: oldData.duration,
                     },
                     artist_name: oldData.artists,

src/features/sharingService/sharingService.ts

@@ -0,0 +1,10 @@
+export class SharingService {
+  /**
+   * Retrieve the universal link given a regular track link
+   * @param currentUrl
+   * @returns
+   */
+  public static getUniversalLink(currentUrl: string): string {
+    return `${currentUrl}?u`;
+  }
+}

src/features/songwhip/models/Artist.ts

@@ -1,21 +0,0 @@
-import { ServiceLinks } from "./ServiceLinks";
-
-export interface Artist {
-  type: string;
-  id: number;
-  path: string;
-  name: string;
-  sourceUrl: string;
-  sourceCountry: string;
-  url: string;
-  image: string;
-  createdAt: string;
-  updatedAt: string;
-  refreshedAt: string;
-  serviceIds: { [key: string]: string };
-  orchardId: string;
-  spotifyId: string;
-  links: { [key: string]: ServiceLinks[] };
-  linksCountries: string[];
-  description: string;
-}

src/features/songwhip/models/ServiceLinks.ts

@@ -1,4 +0,0 @@
-export interface ServiceLinks {
-  link: string;
-  countries: string[];
-}

src/features/songwhip/models/whip.ts

@@ -1,27 +0,0 @@
-import { Artist } from "./Artist";
-import { ServiceLinks } from "./ServiceLinks";
-
-export interface WhippedResult {
-  status: string;
-  data: {
-    item: {
-      type: string;
-      id: number;
-      path: string;
-      name: string;
-      url: string;
-      sourceUrl: string;
-      sourceCountry: string;
-      releaseDate: string;
-      createdAt: string;
-      updatedAt: string;
-      refreshedAt: string;
-      image: string;
-      isrc: string;
-      isExplicit: boolean;
-      links: { [key: string]: ServiceLinks[] };
-      linksCountries: string[];
-      artists: Artist[];
-    };
-  };
-}

src/features/songwhip/songwhip.ts

@@ -1,32 +0,0 @@
-import { WhippedResult } from "./models/whip";
-import axios from "axios";
-
-export class Songwhip {
-  /**
-   * Call the songwhip API and create a shareable songwhip page
-   * @param currentUrl
-   * @returns
-   */
-  public static async whip(currentUrl: string): Promise<WhippedResult> {
-    try {
-      const response = await axios.post("https://songwhip.com/api/songwhip/create", {
-        url: currentUrl,
-        // doesn't actually matter.. returns everything the same way anyway
-        country: "NL",
-      });
-
-      return response.data;
-    } catch (error) {
-      console.log(JSON.stringify(error));
-    }
-  }
-
-  /**
-   * Transform a songwhip response into a shareable url
-   * @param response
-   * @returns
-   */
-  public static getWhipUrl(response: WhippedResult) {
-    return `https://songwhip.com${response.data.item.url}`;
-  }
-}

src/main.ts

@@ -10,7 +10,7 @@ import {
   releaseInhibitorIfActive,
 } from "./features/idleInhibitor/idleInhibitor";
 import { Logger } from "./features/logger";
-import { Songwhip } from "./features/songwhip/songwhip";
+import { SharingService } from "./features/sharingService/sharingService";
 import { MediaInfo } from "./models/mediaInfo";
 import { MediaStatus } from "./models/mediaStatus";
 import { initRPC, rpc, unRPC } from "./scripts/discord";
@@ -24,10 +24,8 @@ import {
   showSettingsWindow,
 } from "./scripts/settings";
 import { addTray, refreshTray } from "./scripts/tray";
-const tidalUrl = "https://listen.tidal.com";
 let mainInhibitorId = -1;
 
-initialize();
 let mainWindow: BrowserWindow;
 const icon = path.join(__dirname, "../assets/icon.png");
 const PROTOCOL_PREFIX = "tidal";
@@ -40,6 +38,9 @@ const windowPreferences = {
 setDefaultFlags(app);
 setManagedFlagsFromSettings(app);
 
+const tidalUrl =
+  settingsStore.get<string, string>(settings.advanced.tidalUrl) || "https://listen.tidal.com";
+
 /**
  * Update the menuBarVisibility according to the store value
  *
@@ -96,6 +97,7 @@ function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
       },
     },
   });
+
   enable(mainWindow.webContents);
   registerHttpProtocols();
   syncMenuBarWithStore();
@@ -124,6 +126,7 @@ function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
     }
     return false;
   });
+
   // Emitted when the window is closed.
   mainWindow.on("closed", function () {
     releaseInhibitorIfActive(mainInhibitorId);
@@ -176,6 +179,7 @@ app.on("ready", async () => {
 
   if (isMainInstance() || isMultipleInstancesAllowed()) {
     await components.whenReady();
+    initialize();
 
     // Adblock
     if (settingsStore.get(settings.adBlock)) {
@@ -186,6 +190,8 @@ app.on("ready", async () => {
       });
     }
 
+    Logger.log("components ready:", components.status());
+
     createWindow();
     addMenu(mainWindow);
     createSettingsWindow();
@@ -248,8 +254,8 @@ ipcMain.on(globalEvents.error, (event) => {
   console.log(event);
 });
 
-ipcMain.handle(globalEvents.whip, async (event, url) => {
+ipcMain.handle(globalEvents.getUniversalLink, async (event, url) => {
-  return Songwhip.whip(url);
+  return SharingService.getUniversalLink(url);
 });
 
 Logger.watch(ipcMain);

src/models/mediaInfo.ts

@@ -1,3 +1,4 @@
+import { MediaPlayerInfo } from "./mediaPlayerInfo";
 import { MediaStatus } from "./mediaStatus";
 
 export interface MediaInfo {
@@ -7,10 +8,12 @@ export interface MediaInfo {
   icon: string;
   status: MediaStatus;
   url: string;
+  playingFrom: string;
   current: string;
   currentInSeconds?: number;
   duration: string;
   durationInSeconds?: number;
   image: string;
   favorite: boolean;
+  player?: MediaPlayerInfo;
 }

src/models/mediaPlayerInfo.ts

@@ -0,0 +1,8 @@
+import { RepeatState } from "./repeatState";
+import { MediaStatus } from "./mediaStatus";
+
+export interface MediaPlayerInfo {
+  status: MediaStatus;
+  shuffle: boolean;
+  repeat: RepeatState;
+}

src/models/options.ts

@@ -1,15 +0,0 @@
-export interface Options {
-  title: string;
-  artists: string;
-  album: string;
-  status: string;
-  url: string;
-  current: string;
-  currentInSeconds: number;
-  duration: string;
-  durationInSeconds: number;
-  "app-name": string;
-  image: string;
-  icon: string;
-  favorite: boolean;
-}

src/models/repeatState.ts

@@ -0,0 +1,5 @@
+export enum RepeatState {
+  off = "off",
+  all = "all",
+  single = "single",
+}

src/pages/settings/preload.ts

@@ -24,17 +24,19 @@ const switchesWithSettings = {
     switch: "discord_show_song",
     classToHide: "discord_show_song_options",
     settingsKey: settings.discord.showSong,
-  }
+  },
 };
 
 let adBlock: HTMLInputElement,
   api: HTMLInputElement,
+  channel: HTMLSelectElement,
   customCSS: HTMLInputElement,
   disableBackgroundThrottle: HTMLInputElement,
   disableHardwareMediaKeys: HTMLInputElement,
   enableCustomHotkeys: HTMLInputElement,
   enableDiscord: HTMLInputElement,
   gpuRasterization: HTMLInputElement,
+  hostname: HTMLInputElement,
   menuBar: HTMLInputElement,
   minimizeOnClose: HTMLInputElement,
   mpris: HTMLInputElement,
@@ -44,6 +46,7 @@ let adBlock: HTMLInputElement,
   singleInstance: HTMLInputElement,
   skipArtists: HTMLInputElement,
   skippedArtists: HTMLInputElement,
+  staticWindowTitle: HTMLInputElement,
   theme: HTMLSelectElement,
   trayIcon: HTMLInputElement,
   updateFrequency: HTMLInputElement,
@@ -56,6 +59,7 @@ let adBlock: HTMLInputElement,
   discord_include_timestamps: HTMLInputElement,
   discord_button_text: HTMLInputElement,
   discord_show_song: HTMLInputElement,
+  discord_show_idle: HTMLInputElement,
   discord_idle_text: HTMLInputElement,
   discord_using_text: HTMLInputElement;
 
@@ -120,6 +124,7 @@ function refreshSettings() {
   try {
     adBlock.checked = settingsStore.get(settings.adBlock);
     api.checked = settingsStore.get(settings.api);
+    channel.value = settingsStore.get(settings.advanced.tidalUrl);
     customCSS.value = settingsStore.get<string, string[]>(settings.customCSS).join("\n");
     disableBackgroundThrottle.checked = settingsStore.get(settings.disableBackgroundThrottle);
     disableHardwareMediaKeys.checked = settingsStore.get(settings.flags.disableHardwareMediaKeys);
@@ -127,6 +132,7 @@ function refreshSettings() {
     enableDiscord.checked = settingsStore.get(settings.enableDiscord);
     enableWaylandSupport.checked = settingsStore.get(settings.flags.enableWaylandSupport);
     gpuRasterization.checked = settingsStore.get(settings.flags.gpuRasterization);
+    hostname.value = settingsStore.get(settings.apiSettings.hostname);
     menuBar.checked = settingsStore.get(settings.menuBar);
     minimizeOnClose.checked = settingsStore.get(settings.minimizeOnClose);
     mpris.checked = settingsStore.get(settings.mpris);
@@ -135,8 +141,9 @@ function refreshSettings() {
     port.value = settingsStore.get(settings.apiSettings.port);
     singleInstance.checked = settingsStore.get(settings.singleInstance);
     skipArtists.checked = settingsStore.get(settings.skipArtists);
-    theme.value = settingsStore.get(settings.theme);
     skippedArtists.value = settingsStore.get<string, string[]>(settings.skippedArtists).join("\n");
+    staticWindowTitle.checked = settingsStore.get(settings.staticWindowTitle);
+    theme.value = settingsStore.get(settings.theme);
     trayIcon.checked = settingsStore.get(settings.trayIcon);
     updateFrequency.value = settingsStore.get(settings.updateFrequency);
     enableListenBrainz.checked = settingsStore.get(settings.ListenBrainz.enabled);
@@ -147,6 +154,7 @@ function refreshSettings() {
     discord_include_timestamps.checked = settingsStore.get(settings.discord.includeTimestamps);
     discord_button_text.value = settingsStore.get(settings.discord.buttonText);
     discord_show_song.checked = settingsStore.get(settings.discord.showSong);
+    discord_show_idle.checked = settingsStore.get(settings.discord.showIdle);
     discord_idle_text.value = settingsStore.get(settings.discord.idleText);
     discord_using_text.value = settingsStore.get(settings.discord.usingText);
 
@@ -236,6 +244,7 @@ window.addEventListener("DOMContentLoaded", () => {
 
   adBlock = get("adBlock");
   api = get("apiCheckbox");
+  channel = get<HTMLSelectElement>("channel");
   customCSS = get("customCSS");
   disableBackgroundThrottle = get("disableBackgroundThrottle");
   disableHardwareMediaKeys = get("disableHardwareMediaKeys");
@@ -243,6 +252,7 @@ window.addEventListener("DOMContentLoaded", () => {
   enableDiscord = get("enableDiscord");
   enableWaylandSupport = get("enableWaylandSupport");
   gpuRasterization = get("gpuRasterization");
+  hostname = get("hostname");
   menuBar = get("menuBar");
   minimizeOnClose = get("minimizeOnClose");
   mpris = get("mprisCheckbox");
@@ -253,6 +263,7 @@ window.addEventListener("DOMContentLoaded", () => {
   trayIcon = get("trayIcon");
   skipArtists = get("skipArtists");
   skippedArtists = get("skippedArtists");
+  staticWindowTitle = get("staticWindowTitle");
   singleInstance = get("singleInstance");
   updateFrequency = get("updateFrequency");
   enableListenBrainz = get("enableListenBrainz");
@@ -263,12 +274,14 @@ window.addEventListener("DOMContentLoaded", () => {
   listenbrainz_delay = get("listenbrainz_delay");
   discord_button_text = get("discord_button_text");
   discord_show_song = get("discord_show_song");
+  discord_show_idle = get("discord_show_idle");
   discord_using_text = get("discord_using_text");
-  discord_idle_text = get("discord_idle_text")
+  discord_idle_text = get("discord_idle_text");
 
   refreshSettings();
   addInputListener(adBlock, settings.adBlock);
   addInputListener(api, settings.api);
+  addSelectListener(channel, settings.advanced.tidalUrl);
   addTextAreaListener(customCSS, settings.customCSS);
   addInputListener(disableBackgroundThrottle, settings.disableBackgroundThrottle);
   addInputListener(disableHardwareMediaKeys, settings.flags.disableHardwareMediaKeys);
@@ -276,6 +289,7 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(enableDiscord, settings.enableDiscord, switchesWithSettings.discord);
   addInputListener(enableWaylandSupport, settings.flags.enableWaylandSupport);
   addInputListener(gpuRasterization, settings.flags.gpuRasterization);
+  addInputListener(hostname, settings.apiSettings.hostname);
   addInputListener(menuBar, settings.menuBar);
   addInputListener(minimizeOnClose, settings.minimizeOnClose);
   addInputListener(mpris, settings.mpris);
@@ -284,6 +298,7 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(port, settings.apiSettings.port);
   addInputListener(skipArtists, settings.skipArtists);
   addTextAreaListener(skippedArtists, settings.skippedArtists);
+  addInputListener(staticWindowTitle, settings.staticWindowTitle);
   addInputListener(singleInstance, settings.singleInstance);
   addSelectListener(theme, settings.theme);
   addInputListener(trayIcon, settings.trayIcon);
@@ -299,7 +314,12 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(discord_details_prefix, settings.discord.detailsPrefix);
   addInputListener(discord_include_timestamps, settings.discord.includeTimestamps);
   addInputListener(discord_button_text, settings.discord.buttonText);
-  addInputListener(discord_show_song, settings.discord.showSong, switchesWithSettings.discord_show_song);
+  addInputListener(
+    discord_show_song,
+    settings.discord.showSong,
+    switchesWithSettings.discord_show_song
+  );
+  addInputListener(discord_show_idle, settings.discord.showIdle);
   addInputListener(discord_idle_text, settings.discord.idleText);
   addInputListener(discord_using_text, settings.discord.usingText);
 });

src/pages/settings/settings.html

@@ -7,7 +7,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta http-equiv="X-UA-Compatible" content="ie=edge" />
   <link rel="stylesheet" href="./settings.css" />
-  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/7.0.1/css/font-awesome.min.css">
 </head>
 
 <body class="settings-window">
@@ -49,7 +49,7 @@
             <div class="group__option">
               <div class="group__description">
                 <h4>Notifications</h4>
-                <p>Show a notification when a new song starts.</p>
+                <p>Show a notification when new media starts.</p>
               </div>
               <label class="switch">
                 <input id="notifications" type="checkbox" />
@@ -106,6 +106,16 @@
                 <span class="switch__slider"></span>
               </label>
             </div>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Static Window Title</h4>
+                <p>Makes the window title "TIDAL Hi-Fi" instead of changing to the currently playing song.</p>
+              </div>
+              <label class="switch">
+                <input id="staticWindowTitle" type="checkbox" />
+                <span class="switch__slider"></span>
+              </label>
+            </div>
             <div class="group__option">
               <div class="group__description">
                 <h4>Minimize on Close</h4>
@@ -147,7 +157,7 @@
             <p class="group__title">API</p>
             <div class="group__description">
               <p>
-                TIDAL Hi-Fi has a built-in web API to allow users to get current song information.
+                TIDAL Hi-Fi has a built-in web API to allow users to get current media information.
                 You can optionally enable playback control as well.
               </p>
             </div>
@@ -167,6 +177,16 @@
                 <input id="port" type="number" class="text-input" name="port" />
               </div>
             </div>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>API hostname</h4>
+                <p>By default (127.0.0.1) only local apps can interface with the API. <br />
+                  Change to 0.0.0.0 to allow <strong>anyone</strong> to interact with it. <br />
+                  Other options are available
+                </p>
+                <input id="hostname" type="text" class="text-input" name="hostname" />
+              </div>
+            </div>
             <div class="group__option">
               <div class="group__description">
                 <h4>Playback control</h4>
@@ -217,6 +237,17 @@
             </div>
             <div id="discord_options">
 
+              <div class="group__option" class="hidden">
+                <div class="group__description">
+                  <h4>Show Idle Text</h4>
+                  <p>Should the idle text be shown when idle?</p>
+                </div>
+                <label class="switch">
+                  <input id="discord_show_idle" type="checkbox" />
+                  <span class="switch__slider"></span>
+                </label>
+              </div>
+
               <div class="group__option" class="hidden">
                 <div class="group__description">
                   <h4>Idle Text</h4>
@@ -235,8 +266,8 @@
 
               <div class="group__option" class="hidden">
                 <div class="group__description">
-                  <h4>Show song</h4>
+                  <h4>Show media</h4>
-                  <p>Show the current song in the Discord client</p>
+                  <p>Show the current media in the Discord client</p>
                 </div>
                 <label class="switch">
                   <input id="discord_show_song" type="checkbox" />
@@ -268,7 +299,7 @@
                 <div class="group__option">
                   <div class="group__description">
                     <h4>Button text</h4>
-                    <p>Text to display on the button below the song information.</p>
+                    <p>Text to display on the button below the media information.</p>
                     <input id="discord_button_text" type="text" class="text-input" name="discord_button_text" />
                   </div>
                 </div>
@@ -306,7 +337,7 @@
             </div>
             <div class="group__description">
               <h4>ScrobbleDelay</h4>
-              <p>The delay (in ms) to send a song to ListenBrainz. Prevents spamming the API when you fast forward
+              <p>The delay (in ms) to send a listen to ListenBrainz. Prevents spamming the API when you fast forward
                 immediately</p>
               <input id="listenbrainz_delay" type="number" class="text-input" name="listenbrainz_delay" />
             </div>
@@ -328,6 +359,20 @@
                 <input id="updateFrequency" type="number" class="text-input" name="updateFrequency" />
               </div>
             </div>
+
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Tidal channel / URL</h4>
+                <p>
+                  Which URL Tidal Hi-Fi should use.
+                  <strong>note! Beta might break at any time</strong>
+                </p>
+                <select class="select-input" id="channel" name="channel">
+                  <option value="https://listen.tidal.com">Stable (listen.tidal.com)</option>
+                  <option value="https://listen.stage.tidal.com">Staging (listen.stage.tidal.com)</option>
+                </select>
+              </div>
+            </div>
           </div>
           <div class="group">
             <p class="group__title">Flags</p>
@@ -433,7 +478,7 @@
           <h4>TIDAL Hi-Fi</h4>
           <div class="about-section__version">
             <a target="_blank" rel="noopener"
-              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.11.0">5.11.0</a>
+              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.20.1">5.20.1</a>
           </div>
           <div class="about-section__links">
             <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"

src/preload.ts

@@ -10,18 +10,19 @@ import {
 } from "./features/listenbrainz/listenbrainz";
 import { StoreData } from "./features/listenbrainz/models/storeData";
 import { Logger } from "./features/logger";
-import { Songwhip } from "./features/songwhip/songwhip";
+import { SharingService } from "./features/sharingService/sharingService";
 import { addCustomCss } from "./features/theming/theming";
 import { convertDurationToSeconds } from "./features/time/parse";
+import { MediaInfo } from "./models/mediaInfo";
 import { MediaStatus } from "./models/mediaStatus";
-import { Options } from "./models/options";
+import { RepeatState } from "./models/repeatState";
 import { downloadFile } from "./scripts/download";
 import { addHotkey } from "./scripts/hotkeys";
+import { ObjectToDotNotation } from "./scripts/objectUtilities";
 import { settingsStore } from "./scripts/settings";
 import { setTitle } from "./scripts/window-functions";
 
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
-const appName = "TIDAL Hi-Fi";
 let currentSong = "";
 let player: Player;
 let currentPlayStatus = MediaStatus.paused;
@@ -29,7 +30,9 @@ let currentListenBrainzDelayId: ReturnType<typeof setTimeout>;
 let scrobbleWaitingForDelay = false;
 
 let currentlyPlaying = MediaStatus.paused;
-let currentMediaInfo: Options;
+let currentRepeatState: RepeatState = RepeatState.off;
+let currentShuffleState = false;
+let currentMediaInfo: MediaInfo;
 let currentNotification: Electron.Notification;
 
 const elements = {
@@ -45,16 +48,19 @@ const elements = {
   search: '[class^="searchField"]',
   shuffle: '*[data-test="shuffle"]',
   repeat: '*[data-test="repeat"]',
-  account: '*[class^="profileOptions"]',
+  account: '*[data-test^="profile-image-button"]',
-  settings: '*[data-test^="open-settings"]',
+  settings: '*[data-test^="sidebar-menu-button"]',
+  openSettings: '*[data-test^="open-settings"]',
   media: '*[data-test="current-media-imagery"]',
   image: "img",
   current: '*[data-test="current-time"]',
-  duration: '*[class^=playbackControlsContainer] *[data-test="duration"]',
+  duration: '*[class^=_playbackControlsContainer] *[data-test="duration"]',
   bar: '*[data-test="progress-bar"]',
   footer: "#footerPlayer",
   mediaItem: "[data-type='mediaItem']",
-  album_header_title: '.header-details [data-test="title"]',
+  album_header_title: '*[class^="_playingFrom"] span:nth-child(2)',
+  playing_from: '*[class^="_playingFrom"] span:nth-child(2)',
+  queue_album: "*[class^=playQueueItemsContainer] *[class^=groupTitle] span:nth-child(2)",
   currentlyPlaying: "[class^='isPlayingIcon'], [data-test-is-playing='true']",
   album_name_cell: '[class^="album"]',
   tracklist_row: '[data-test="tracklist-row"]',
@@ -69,7 +75,7 @@ const elements = {
   },
 
   /**
-   * Get the icon of the current song
+   * Get the icon of the current media
    */
   getSongIcon: function () {
     const figure = this.get("media");
@@ -85,7 +91,7 @@ const elements = {
   },
 
   /**
-   * returns an array of all artists in the current song
+   * returns an array of all artists in the current media
    * @returns {Array} artists
    */
   getArtistsArray: function () {
@@ -109,18 +115,19 @@ const elements = {
   },
 
   getAlbumName: function () {
+    try {
       //If listening to an album, get its name from the header title
-    if (window.location.href.includes("/album/")) {
+      if (globalThis.location.href.includes("/album/")) {
-      const albumName = window.document.querySelector(this.album_header_title);
+        const albumName = globalThis.document.querySelector(this.album_header_title);
         if (albumName) {
           return albumName.textContent;
         }
         //If listening to a playlist or a mix, get album name from the list
       } else if (
-      window.location.href.includes("/playlist/") ||
+        globalThis.location.href.includes("/playlist/") ||
-      window.location.href.includes("/mix/")
+        globalThis.location.href.includes("/mix/")
       ) {
-      if (currentPlayStatus === MediaStatus.playing) {
+        if (this.currentlyPlaying === MediaStatus.playing) {
           // find the currently playing element from the list (which might be in an album icon), traverse back up to the mediaItem (row) and select the album cell.
           // document.querySelector("[class^='isPlayingIcon'], [data-test-is-playing='true']").closest('[data-type="mediaItem"]').querySelector('[class^="album"]').textContent
           const row = window.document.querySelector(this.currentlyPlaying).closest(this.mediaItem);
@@ -130,7 +137,16 @@ const elements = {
         }
       }
 
+      // see whether we're on the queue page and get it from there
+      const queueAlbumName = this.getText("queue_album");
+      if (queueAlbumName) {
+        return queueAlbumName;
+      }
+
       return "";
+    } catch {
+      return "";
+    }
   },
 
   isMuted: function () {
@@ -184,7 +200,7 @@ function getUpdateFrequency() {
 }
 
 /**
- * Play or pause the current song
+ * Play or pause the current media
  */
 function playPause() {
   const play = elements.get("play");
@@ -209,9 +225,9 @@ ListenBrainzStore.clear();
 function addHotKeys() {
   if (settingsStore.get(settings.enableCustomHotkeys)) {
     addHotkey("Control+p", function () {
-      elements.click("account");
-      setTimeout(() => {
       elements.click("settings");
+      setTimeout(() => {
+        elements.click("openSettings");
       }, 100);
     });
     addHotkey("Control+l", function () {
@@ -243,11 +259,10 @@ function addHotKeys() {
       elements.click("repeat");
     });
     addHotkey("control+w", async function () {
-      const result = await ipcRenderer.invoke(globalEvents.whip, getTrackURL());
+      const url = SharingService.getUniversalLink(getTrackURL());
-      const url = Songwhip.getWhipUrl(result);
       clipboard.writeText(url);
       new Notification({
-        title: `Successfully whipped: `,
+        title: `Universal link generated: `,
         body: `URL copied to clipboard: ${url}`,
       }).show();
     });
@@ -348,6 +363,23 @@ function getCurrentlyPlayingStatus() {
   return status;
 }
 
+function getCurrentShuffleState() {
+  const shuffle = elements.get("shuffle");
+  return shuffle?.getAttribute("aria-checked") === "true";
+}
+
+function getCurrentRepeatState() {
+  const repeat = elements.get("repeat");
+  switch (repeat?.getAttribute("data-type")) {
+    case "button__repeatAll":
+      return RepeatState.all;
+    case "button__repeatSingle":
+      return RepeatState.single;
+    default:
+      return RepeatState.off;
+  }
+}
+
 /**
  * Convert the duration from MM:SS to seconds
  * @param {*} duration
@@ -360,24 +392,37 @@ function convertDuration(duration: string) {
 /**
  * Update Tidal-hifi's media info
  *
- * @param {*} options
+ * @param {*} mediaInfo
  */
-function updateMediaInfo(options: Options, notify: boolean) {
+function updateMediaInfo(mediaInfo: MediaInfo, notify: boolean) {
-  if (options) {
+  if (mediaInfo) {
-    currentMediaInfo = options;
+    currentMediaInfo = mediaInfo;
-    ipcRenderer.send(globalEvents.updateInfo, options);
+    ipcRenderer.send(globalEvents.updateInfo, mediaInfo);
-    if (settingsStore.get(settings.notifications) && notify) {
+    updateMpris(mediaInfo);
-      if (currentNotification) currentNotification.close();
+    updateListenBrainz(mediaInfo);
+    if (notify) {
+      sendNotification(mediaInfo);
+    }
+  }
+}
+
+/**
+ * send a desktop notification if enabled in settings
+ * @param mediaInfo
+ * @param notify Whether to notify
+ */
+async function sendNotification(mediaInfo: MediaInfo) {
+  if (settingsStore.get(settings.notifications)) {
+    if (currentNotification) {
+      currentNotification.close();
+    }
     currentNotification = new Notification({
-        title: options.title,
+      title: mediaInfo.title,
-        body: options.artists,
+      body: mediaInfo.artists,
-        icon: options.icon,
+      icon: mediaInfo.icon,
     });
     currentNotification.show();
   }
-    updateMpris(options);
-    updateListenBrainz(options);
-  }
 }
 
 function addMPRIS() {
@@ -434,32 +479,34 @@ function addMPRIS() {
   }
 }
 
-function updateMpris(options: Options) {
+function updateMpris(mediaInfo: MediaInfo) {
   if (player) {
     player.metadata = {
       ...player.metadata,
       ...{
-        "xesam:title": options.title,
+        "xesam:title": mediaInfo.title,
-        "xesam:artist": [options.artists],
+        "xesam:artist": [mediaInfo.artists],
-        "xesam:album": options.album,
+        "xesam:album": mediaInfo.album,
-        "mpris:artUrl": options.image,
+        "xesam:url": mediaInfo.url,
-        "mpris:length": convertDuration(options.duration) * 1000 * 1000,
+        "mpris:artUrl": mediaInfo.image,
+        "mpris:length": convertDuration(mediaInfo.duration) * 1000 * 1000,
         "mpris:trackid": "/org/mpris/MediaPlayer2/track/" + getTrackID(),
       },
+      ...ObjectToDotNotation(mediaInfo, "custom:"),
     };
-    player.playbackStatus = options.status === MediaStatus.paused ? "Paused" : "Playing";
+    player.playbackStatus = mediaInfo.status === MediaStatus.paused ? "Paused" : "Playing";
   }
 }
 
 /**
  * Update the listenbrainz service with new data based on a few conditions
  */
-function updateListenBrainz(options: Options) {
+function updateListenBrainz(mediaInfo: MediaInfo) {
   if (settingsStore.get(settings.ListenBrainz.enabled)) {
     const oldData = ListenBrainzStore.get(ListenBrainzConstants.oldData) as StoreData;
     if (
-      (!oldData && options.status === MediaStatus.playing) ||
+      (!oldData && mediaInfo.status === MediaStatus.playing) ||
-      (oldData && oldData.title !== options.title)
+      (oldData && oldData.title !== mediaInfo.title)
     ) {
       if (!scrobbleWaitingForDelay) {
         scrobbleWaitingForDelay = true;
@@ -467,10 +514,10 @@ function updateListenBrainz(options: Options) {
         currentListenBrainzDelayId = setTimeout(
           () => {
             ListenBrainz.scrobble(
-              options.title,
+              mediaInfo.title,
-              options.artists,
+              mediaInfo.artists,
-              options.status,
+              mediaInfo.status,
-              convertDuration(options.duration)
+              convertDuration(mediaInfo.duration)
             );
             scrobbleWaitingForDelay = false;
           },
@@ -508,39 +555,54 @@ setInterval(function () {
   const artistsArray = elements.getArtistsArray();
   const artistsString = elements.getArtistsString(artistsArray);
   const songDashArtistTitle = `${title} - ${artistsString}`;
+  const staticTitle = "TIDAL Hi-Fi";
   const titleOrArtistsChanged = currentSong !== songDashArtistTitle;
   const current = elements.getText("current");
   const currentStatus = getCurrentlyPlayingStatus();
+  const shuffleState = getCurrentShuffleState();
+  const repeatState = getCurrentRepeatState();
 
   const playStateChanged = currentStatus != currentlyPlaying;
+  const shuffleStateChanged = shuffleState != currentShuffleState;
+  const repeatStateChanged = repeatState != currentRepeatState;
+
+  const hasStateChanged = playStateChanged || shuffleStateChanged || repeatStateChanged;
 
   // update info if song changed or was just paused/resumed
-  if (titleOrArtistsChanged || playStateChanged) {
+  if (titleOrArtistsChanged || hasStateChanged) {
-    if (playStateChanged) {
+    if (playStateChanged) currentlyPlaying = currentStatus;
-      currentlyPlaying = currentStatus;
+    if (shuffleStateChanged) currentShuffleState = shuffleState;
-    }
+    if (repeatStateChanged) currentRepeatState = repeatState;
-    skipArtistsIfFoundInSkippedArtistsList(artistsArray);
 
+    skipArtistsIfFoundInSkippedArtistsList(artistsArray);
     const album = elements.getAlbumName();
     const duration = elements.getText("duration");
-    const options = {
+    const options: MediaInfo = {
       title,
       artists: artistsString,
       album: album,
+      playingFrom: elements.getText("playing_from"),
       status: currentStatus,
       url: getTrackURL(),
       current,
       currentInSeconds: convertDurationToSeconds(current),
       duration,
       durationInSeconds: convertDurationToSeconds(duration),
-      "app-name": appName,
       image: "",
       icon: "",
       favorite: elements.isFavorite(),
+
+      player: {
+        status: currentStatus,
+        shuffle: shuffleState,
+        repeat: repeatState,
+      },
     };
 
     // update title, url and play info with new info
-    setTitle(songDashArtistTitle);
+    settingsStore.get(settings.staticWindowTitle)
+      ? setTitle(staticTitle)
+      : setTitle(songDashArtistTitle);
     getTrackURL();
     currentSong = songDashArtistTitle;
     currentPlayStatus = currentStatus;

src/scripts/discord.ts

@@ -1,4 +1,4 @@
-import { Client, Presence } from "discord-rpc";
+import { Client, SetActivity } from "@xhayper/discord-rpc";
 import { app, ipcMain } from "electron";
 import { globalEvents } from "../constants/globalEvents";
 import { settings } from "../constants/settings";
@@ -12,9 +12,13 @@ const clientId = "833617820704440341";
 
 export let rpc: Client;
 
+const ACTIVITY_LISTENING = 2;
+const MAX_RETRIES = 5;
+const RETRY_DELAY = 10000;
+
 const observer = () => {
   if (rpc) {
-    rpc.setActivity(getActivity());
+    updateActivity();
   }
 };
 
@@ -22,10 +26,20 @@ const defaultPresence = {
   largeImageKey: "tidal-hifi-icon",
   largeImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
   instance: false,
+  type: ACTIVITY_LISTENING
 };
 
-const getActivity = (): Presence => {
+const updateActivity = () => {
-  const presence: Presence = { ...defaultPresence };
+  const showIdle = settingsStore.get<string, boolean>(settings.discord.showIdle) ?? true;
+  if (mediaInfo.status === MediaStatus.paused && !showIdle) {
+    rpc.user?.clearActivity();
+  } else {
+    rpc.user?.setActivity(getActivity());
+  }
+};
+
+const getActivity = (): SetActivity => {
+  const presence: SetActivity = { ...defaultPresence };
 
   if (mediaInfo.status === MediaStatus.paused) {
     presence.details =
@@ -41,6 +55,7 @@ const getActivity = (): Presence => {
         settingsStore.get<string, string>(settings.discord.usingText) ?? "Playing media on TIDAL";
     }
   }
+
   return presence;
 
   function getFromStore() {
@@ -54,18 +69,33 @@ const getActivity = (): Presence => {
     return { includeTimestamps, detailsPrefix, buttonText };
   }
 
-  function setPresenceFromMediaInfo(detailsPrefix: string, buttonText: string) {
+  /**
-    if (mediaInfo.url) {
+   * Pad a string using spaces to at least 2 characters
-      presence.details = `${detailsPrefix}${mediaInfo.title}`;
+   * @param input string to pad with 2 characters
-      presence.state = mediaInfo.artists ? mediaInfo.artists : "unknown artist(s)";
+   * @returns
-      presence.largeImageKey = mediaInfo.image;
+   */
-      if (mediaInfo.album) {
+  function pad(input: string): string {
-        presence.largeImageText = mediaInfo.album;
+    return input.padEnd(2, " ");
   }
+
+  function setPresenceFromMediaInfo(detailsPrefix: string, buttonText: string) {
+    // discord requires a minimum of 2 characters
+    const title = pad(mediaInfo.title);
+    const album = pad(mediaInfo.album);
+    const artists = pad(mediaInfo.artists);
+
+    if (mediaInfo.url) {
+      presence.details = `${detailsPrefix}${title}`;
+      presence.state = artists ? artists : "unknown artist(s)";
+      presence.largeImageKey = mediaInfo.image;
+      if (album) {
+        presence.largeImageText = album;
+      }
+
       presence.buttons = [{ label: buttonText, url: mediaInfo.url }];
     } else {
-      presence.details = `Watching ${mediaInfo.title}`;
+      presence.details = `Watching ${title}`;
-      presence.state = mediaInfo.artists;
+      presence.state = artists;
     }
   }
 
@@ -73,11 +103,29 @@ const getActivity = (): Presence => {
     if (includeTimestamps) {
       const currentSeconds = convertDurationToSeconds(mediaInfo.current);
       const durationSeconds = convertDurationToSeconds(mediaInfo.duration);
-      const date = new Date();
+      const now = Math.trunc((Date.now() + 500) / 1000);
-      const now = (date.getTime() / 1000) | 0;
+      presence.startTimestamp = now - currentSeconds;
-      const remaining = date.setSeconds(date.getSeconds() + (durationSeconds - currentSeconds));
+      presence.endTimestamp = presence.startTimestamp + durationSeconds;
-      presence.startTimestamp = now;
+    }
-      presence.endTimestamp = remaining;
+  }
+};
+
+/**
+ * Try to login to RPC and retry if it errors
+ * @param retryCount Max retry count
+ */
+const connectWithRetry = async (retryCount = 0) => {
+  try {
+    await rpc.login();
+    Logger.log('Connected to Discord');
+    rpc.on("ready", updateActivity);
+    Object.values(globalEvents).forEach(event => ipcMain.on(event, observer));
+  } catch (error) {
+    if (retryCount < MAX_RETRIES) {
+      Logger.log(`Failed to connect to Discord, retrying in ${RETRY_DELAY/1000} seconds... (Attempt ${retryCount + 1}/${MAX_RETRIES})`);
+      setTimeout(() => connectWithRetry(retryCount + 1), RETRY_DELAY);
+    } else {
+      Logger.log('Failed to connect to Discord after maximum retry attempts');
     }
   }
 };
@@ -86,18 +134,8 @@ const getActivity = (): Presence => {
  * Set up the discord rpc and listen on globalEvents.updateInfo
  */
 export const initRPC = () => {
-  rpc = new Client({ transport: "ipc" });
+  rpc = new Client({ transport: {type: "ipc"}, clientId });
-  rpc.login({ clientId }).then(
+  connectWithRetry();
-    () => {
-      rpc.on("ready", () => {
-        rpc.setActivity(getActivity());
-      });
-      ipcMain.on(globalEvents.updateInfo, observer);
-    },
-    () => {
-      Logger.log("Can't connect to Discord, is it running?");
-    }
-  );
 };
 
 /**
@@ -105,7 +143,7 @@ export const initRPC = () => {
  */
 export const unRPC = () => {
   if (rpc) {
-    rpc.clearActivity();
+    rpc.user?.clearActivity();
     rpc.destroy();
     rpc = null;
     ipcMain.removeListener(globalEvents.updateInfo, observer);

src/scripts/mediaInfo.ts

@@ -1,12 +1,14 @@
 import { MediaInfo } from "../models/mediaInfo";
 import { MediaStatus } from "../models/mediaStatus";
+import { RepeatState } from "../models/repeatState";
 
-export const mediaInfo = {
+const defaultInfo: MediaInfo = {
   title: "",
   artists: "",
   album: "",
   icon: "",
-  status: MediaStatus.paused as string,
+  playingFrom: "",
+  status: MediaStatus.paused,
   url: "",
   current: "",
   currentInSeconds: 0,
@@ -14,32 +16,21 @@ export const mediaInfo = {
   durationInSeconds: 0,
   image: "tidal-hifi-icon",
   favorite: false,
+
+  player: {
+    status: MediaStatus.paused,
+    shuffle: false,
+    repeat: RepeatState.off,
+  },
 };
 
+export let mediaInfo: MediaInfo = { ...defaultInfo };
+
 export const updateMediaInfo = (arg: MediaInfo) => {
-  mediaInfo.title = propOrDefault(arg.title);
+  mediaInfo = { ...defaultInfo, ...arg };
-  mediaInfo.artists = propOrDefault(arg.artists);
+  mediaInfo.url = toUniversalUrl(mediaInfo.url);
-  mediaInfo.album = propOrDefault(arg.album);
-  mediaInfo.icon = propOrDefault(arg.icon);
-  mediaInfo.url = toUniversalUrl(propOrDefault(arg.url));
-  mediaInfo.status = propOrDefault(arg.status);
-  mediaInfo.current = propOrDefault(arg.current);
-  mediaInfo.currentInSeconds = arg.currentInSeconds ?? 0;
-  mediaInfo.duration = propOrDefault(arg.duration);
-  mediaInfo.durationInSeconds = arg.durationInSeconds ?? 0;
-  mediaInfo.image = propOrDefault(arg.image);
-  mediaInfo.favorite = arg.favorite;
 };
 
-/**
- * Return the property or a default value
- * @param {*} prop property to check
- * @param {*} defaultValue defaults to ""
- */
-function propOrDefault(prop: string, defaultValue = "") {
-  return prop || defaultValue;
-}
-
 /**
  * Append the universal link syntax (?u) to any url
  * @param url url to append the universal link syntax to

src/scripts/menu.ts

@@ -11,6 +11,23 @@ const settingsMenuEntry = {
   accelerator: "Control+=",
 };
 
+const tidalMagazineEntry = {
+  label: "Magazine",
+  click() {
+    const magazineWindow = new BrowserWindow({
+      autoHideMenuBar: true,
+      webPreferences: {
+        sandbox: false,
+        plugins: true,
+        devTools: true, // I like tinkering, others might too
+      },
+    });
+    magazineWindow.loadURL("https://tidal.com/magazine/");
+    magazineWindow.show();
+  },
+  accelerator: "Control+M",
+};
+
 const quitMenuEntry = {
   label: "Quit",
   click() {
@@ -41,6 +58,7 @@ export const getMenu = function (mainWindow: BrowserWindow) {
               { role: "hideothers" },
               { role: "unhide" },
               { type: "separator" },
+              tidalMagazineEntry,
               quitMenuEntry,
             ],
           },
@@ -48,7 +66,7 @@ export const getMenu = function (mainWindow: BrowserWindow) {
       : []),
     {
       label: "File",
-      submenu: [settingsMenuEntry, isMac ? { role: "close" } : quitMenuEntry],
+      submenu: [settingsMenuEntry, tidalMagazineEntry, isMac ? { role: "close" } : quitMenuEntry],
     },
     {
       label: "Edit",
@@ -101,6 +119,7 @@ export const getMenu = function (mainWindow: BrowserWindow) {
     },
     settingsMenuEntry,
     toggleWindow,
+    tidalMagazineEntry,
     quitMenuEntry,
   ];
 

src/scripts/objectUtilities.ts

@@ -0,0 +1,13 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const ObjectToDotNotation = (obj: any, prefix: string = "", target: any = {}) => {
+  Object.keys(obj).forEach((key: string) => {
+    if (typeof obj[key] === "object" && obj[key] !== null) {
+      ObjectToDotNotation(obj[key], prefix + key + ".", target);
+    } else {
+      const dotLocation = prefix + key;
+      target[dotLocation] = obj[key];
+      return target;
+    }
+  });
+  return target;
+};

src/scripts/settings.ts

@@ -28,9 +28,13 @@ const buildMigration = (
 export const settingsStore = new Store({
   defaults: {
     adBlock: false,
+    advanced: {
+      tidalUrl: "https://listen.tidal.com",
+    },
     api: true,
     apiSettings: {
       port: 47836,
+      hostname: "127.0.0.1",
     },
     customCSS: [],
     disableBackgroundThrottle: true,
@@ -39,6 +43,7 @@ export const settingsStore = new Store({
     enableDiscord: false,
     discord: {
       showSong: true,
+      showIdle: true,
       idleText: "Browsing Tidal",
       usingText: "Playing media on TIDAL",
       includeTimestamps: true,
@@ -64,6 +69,7 @@ export const settingsStore = new Store({
     singleInstance: true,
     skipArtists: false,
     skippedArtists: [""],
+    staticWindowTitle: false,
     theme: "none",
     trayIcon: true,
     updateFrequency: 500,
@@ -101,6 +107,19 @@ export const settingsStore = new Store({
         },
       ]);
     },
+    "5.14.0": (migrationStore) => {
+      buildMigration("5.14.0", migrationStore, [
+        { key: settings.apiSettings.hostname, value: "127.0.0.1" },
+      ]);
+    },
+    "5.15.0": (migrationStore) => {
+      buildMigration("5.15.0", migrationStore, [
+        { key: settings.advanced.tidalUrl, value: "https://listen.tidal.com" },
+      ]);
+    },
+    "5.16.0": (migrationStore) => {
+      buildMigration("5.16.0", migrationStore, [{ key: settings.discord.showIdle, value: "true" }]);
+    },
   },
 });
 
@@ -159,3 +178,25 @@ export const hideSettingsWindow = function () {
 export const closeSettingsWindow = function () {
   settingsWindow = null;
 };
+
+/**
+ * add artists to the list of skipped artists
+ * @param artists list of artists to append
+ */
+export const addSkippedArtists = (artists: string[]) => {
+  const { skippedArtists } = settings;
+  const previousStoreValue = settingsStore.get<string, string[]>(skippedArtists);
+  settingsStore.set(skippedArtists, Array.from(new Set([...previousStoreValue, ...artists])));
+};
+
+/**
+ * Remove artists from the list of skipped artists
+ * @param artists list of artists to remove
+ */
+export const removeSkippedArtists = (artists: string[]) => {
+  const { skippedArtists } = settings;
+  const previousStoreValue = settingsStore.get<string, string[]>(skippedArtists);
+  const filteredArtists = previousStoreValue.filter((value) => ![...artists].includes(value));
+
+  settingsStore.set(skippedArtists, filteredArtists);
+};

tsconfig.json

@@ -8,6 +8,7 @@
     "sourceMap": true,
     "allowJs": true,
     "outDir": "ts-dist",
+    "resolveJsonModule": true,
     "esModuleInterop": true,
     "baseUrl": ".",
     "paths": {