Merge pull request #435 from Mastermindzh/feature/docs

feat: dependency udpate & openapi extension

.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.4
       - run: npm install
       - run: npm run build
 
@@ -31,7 +31,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.4
       - run: npm install
       - run: npm run build
 
@@ -41,6 +41,6 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.4
       - run: npm install
       - run: npm run build

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.4
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master
@@ -35,7 +35,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.4
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master
@@ -49,7 +49,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 19
+          node-version: 22.4
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master

CHANGELOG.md

@@ -4,6 +4,15 @@ 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.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

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)
@@ -153,11 +153,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/)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "5.14.1",
+  "version": "5.15.0",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {
@@ -50,7 +50,7 @@
     "hotkeys-js": "^3.13.7",
     "mpris-service": "^2.1.2",
     "request": "^2.88.2",
-    "sass": "^1.77.6",
+    "sass": "^1.77.7",
     "swagger-ui-express": "^5.0.1"
   },
   "devDependencies": {
@@ -58,27 +58,27 @@
     "@types/cors": "^2.8.17",
     "@types/discord-rpc": "^4.0.8",
     "@types/express": "^4.17.21",
-    "@types/node": "^20.12.12",
+    "@types/node": "^20.14.10",
     "@types/request": "^2.48.12",
     "@types/swagger-ui-express": "^4.1.6",
-    "@typescript-eslint/eslint-plugin": "^6.18.0",
+    "@typescript-eslint/eslint-plugin": "^7.16.0",
-    "@typescript-eslint/parser": "^6.18.0",
+    "@typescript-eslint/parser": "^7.15.0",
     "copyfiles": "^2.4.1",
-    "electron": "git+https://github.com/castlabs/electron-releases#v28.1.1+wvcus",
+    "electron": "git+https://github.com/castlabs/electron-releases#v31.1.0+wvcus",
-    "electron-builder": "^24.9.1",
+    "electron-builder": "~24.9.4",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "js-yaml": "^4.1.0",
     "markdown-toc": "^1.2.0",
-    "nodemon": "^3.0.2",
+    "nodemon": "^3.1.4",
-    "prettier": "^3.1.1",
+    "prettier": "^3.3.2",
-    "stylelint": "^16.1.0",
+    "stylelint": "^16.6.1",
-    "stylelint-config-standard": "^36.0.0",
+    "stylelint-config-standard": "^36.0.1",
-    "stylelint-config-standard-scss": "^13.0.0",
+    "stylelint-config-standard-scss": "^13.1.0",
     "stylelint-prettier": "^5.0.0",
     "swagger-jsdoc": "^6.2.8",
     "ts-node": "^10.9.2",
-    "tsc-watch": "^6.0.4",
+    "tsc-watch": "^6.2.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.5.3"
   },
   "prettier": "@mastermindzh/prettier-config"
 }

src/constants/settings.ts

@@ -10,6 +10,10 @@
  */
 export const settings = {
   adBlock: "adBlock",
+  advanced: {
+    root: "advanced",
+    tidalUrl: "advanced.tidalUrl",
+  },
   api: "api",
   apiSettings: {
     root: "apiSettings",

src/features/api/features/current.ts

@@ -3,7 +3,110 @@ import fs from "fs";
 import { mediaInfo } from "../../../scripts/mediaInfo";
 
 export const addCurrentInfo = (expressApp: Router) => {
+  /**
+   * @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/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

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "TIDAL Hi-Fi API",
-    "version": "5.14.1",
+    "version": "5.15.0",
     "description": "",
     "license": {
       "name": "MIT",
@@ -18,6 +18,210 @@
     "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",
@@ -105,10 +309,250 @@
           }
         }
       }
+    },
+    "/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": {
@@ -122,6 +566,14 @@
     }
   },
   "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/main.ts

@@ -24,7 +24,6 @@ import {
   showSettingsWindow,
 } from "./scripts/settings";
 import { addTray, refreshTray } from "./scripts/tray";
-const tidalUrl = "https://listen.tidal.com";
 let mainInhibitorId = -1;
 
 initialize();
@@ -40,6 +39,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
  *

src/pages/settings/preload.ts

@@ -29,6 +29,7 @@ const switchesWithSettings = {
 
 let adBlock: HTMLInputElement,
   api: HTMLInputElement,
+  channel: HTMLSelectElement,
   customCSS: HTMLInputElement,
   disableBackgroundThrottle: HTMLInputElement,
   disableHardwareMediaKeys: HTMLInputElement,
@@ -121,6 +122,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);
@@ -238,6 +240,7 @@ window.addEventListener("DOMContentLoaded", () => {
 
   adBlock = get("adBlock");
   api = get("apiCheckbox");
+  channel = get<HTMLSelectElement>("channel");
   customCSS = get("customCSS");
   disableBackgroundThrottle = get("disableBackgroundThrottle");
   disableHardwareMediaKeys = get("disableHardwareMediaKeys");
@@ -272,6 +275,7 @@ window.addEventListener("DOMContentLoaded", () => {
   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);

src/pages/settings/settings.html

@@ -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" />
@@ -147,7 +147,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>
@@ -245,8 +245,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" />
@@ -278,7 +278,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>
@@ -316,7 +316,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>
@@ -338,6 +338,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>
@@ -443,7 +457,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.14.1">5.14.1</a>
+              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.15.0">5.15.0</a>
           </div>
           <div class="about-section__links">
             <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"

src/preload.ts

@@ -74,7 +74,7 @@ const elements = {
   },
 
   /**
-   * Get the icon of the current song
+   * Get the icon of the current media
    */
   getSongIcon: function () {
     const figure = this.get("media");
@@ -90,7 +90,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 () {
@@ -195,7 +195,7 @@ function getUpdateFrequency() {
 }
 
 /**
- * Play or pause the current song
+ * Play or pause the current media
  */
 function playPause() {
   const play = elements.get("play");

src/scripts/settings.ts

@@ -28,6 +28,9 @@ const buildMigration = (
 export const settingsStore = new Store({
   defaults: {
     adBlock: false,
+    advanced: {
+      tidalUrl: "https://listen.tidal.com",
+    },
     api: true,
     apiSettings: {
       port: 47836,
@@ -107,6 +110,11 @@ export const settingsStore = new Store({
         { 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" },
+      ]);
+    },
   },
 });