Merge pull request #414 from Mastermindzh/version/next

fix: Fixed  not finding album name whilst on queue page

.github/workflows/build.yml

@@ -9,6 +9,7 @@ on:
     branches-ignore:
       - master
       - develop
+  workflow_dispatch:
 jobs:
   build_on_linux:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -8,6 +8,7 @@ on:
   pull_request:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
   build_on_linux:

.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",

CHANGELOG.md

@@ -4,6 +4,88 @@ 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.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
+  - made the original API "legacy" (still works the same)
+  - Now using the correct HTTP verb for all new endpoints
+- Implemented TIDAL's universal links. All links are now universal.
+- Custom `tidal://` protocol fixed - By [TheRockYT](https://github.com/TheRockYT)
+- Global media shortcuts removed since TIDAL includes them by default - By [TheRockYT](https://github.com/TheRockYT)
+
+- Fixes
+  - [#390](https://github.com/Mastermindzh/tidal-hifi/issues/390)
+  - [#376](https://github.com/Mastermindzh/tidal-hifi/issues/376)
+  - [#383](https://github.com/Mastermindzh/tidal-hifi/issues/383)
+  - [#393](https://github.com/Mastermindzh/tidal-hifi/issues/393)
+
+## [5.10.0]
+
+- TIDAL will now close the previous notification if a new one is sent whilst the old is still visible. [#364](https://github.com/Mastermindzh/tidal-hifi/pull/364)
+- Updated developer documentation to get started in README [#365](https://github.com/Mastermindzh/tidal-hifi/pull/365)
+- Links in the about window now open in the user's default browser. fixes [#360](https://github.com/Mastermindzh/tidal-hifi/issues/360)
+- Refactored "nowPlaying" code to always display the current state, even when the built-in UI is updated.
+  - fixes [#351](https://github.com/Mastermindzh/tidal-hifi/issues/351)
+  - fixes [#356](https://github.com/Mastermindzh/tidal-hifi/issues/356)
+  - fixes [#370](https://github.com/Mastermindzh/tidal-hifi/issues/370)
+- Reverted to using old icon syntax with icons in the build directory. fixes [#350](https://github.com/Mastermindzh/tidal-hifi/issues/350)
+- Enabled wayland platform flags by default when launching through .desktop file
+  - fixes [#273](https://github.com/Mastermindzh/tidal-hifi/issues/273)
+  - fixes [#347](https://github.com/Mastermindzh/tidal-hifi/issues/347)
+
+## [5.9.0]
+
+- More Discord options:
+  - Added the ability to hide the current song from the discord activity and display a custom text instead
+  - Added the ability to customize the text that is shown when no song is playing
+  - Discord now reacts to pausing/unpausing events
+- Refactored media info updates so it only updates the required info, fixes #342, #306
+- Added 5.9.0 logs/versions/migrations
+
+### Fixed
+
+- Fixed chromium mediaSession instance showing up. fixes #338 #198
+- Set a new icon, should fix #302
+- Made sure settingsWindow exists before operating on it. fixes #344
+
 ## [5.8.0]
 
 - Updated Electron to 28.1.1 (fixes [325](https://github.com/Mastermindzh/tidal-hifi/issues/325))

README.md

@@ -43,13 +43,14 @@ 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,10 +131,13 @@ 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)
-- cd TIDAL Hi-Fi
-- npm install
-- npm start
+- `git clone [https://github.com/Mastermindzh/tidal-hifi.git](https://github.com/Mastermindzh/tidal-hifi.git)`
+- `cd tidal-hifi`
+- `npm install`
+- `npm run watch` to watch for auto-reload of Typescript/SCSS changes.
+  - `npm run compile` can be used to trigger it once
+- `npm watchStart` to auto watch for any updates files and reload Tidal Hi-Fi
+  - `npm start` can be used to run Tidal Hi-Fi manually once
 
 ## Integrations
 

build/electron-builder.base.yml

@@ -11,10 +11,16 @@ extraResources:
   - "themes/**"
 linux:
   category: AudioVideo
-  icon: assets/icons
+  icon: build/icons
   target:
     - dir
   executableName: tidal-hifi
+  executableArgs:
+    [
+      "--enable-features=UseOzonePlatform",
+      "--ozone-platform-hint=auto",
+      "--enable-features=WaylandWindowDecorations",
+    ]
   desktop:
     Encoding: UTF-8
     Name: TIDAL Hi-Fi

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "5.8.0",
+  "version": "5.14.1",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {
@@ -8,9 +8,10 @@
     "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,22 +40,27 @@
   "homepage": "https://github.com/Mastermindzh/tidal-hifi",
   "license": "MIT",
   "dependencies": {
-    "@electron/remote": "^2.1.1",
-    "axios": "^1.6.5",
+    "@electron/remote": "^2.1.2",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "axios": "^1.6.8",
+    "cors": "^2.8.5",
     "discord-rpc": "^4.0.1",
-    "electron-store": "^8.1.0",
-    "express": "^4.18.2",
-    "hotkeys-js": "^3.13.3",
+    "electron-store": "^8.2.0",
+    "express": "^4.19.2",
+    "hotkeys-js": "^3.13.7",
     "mpris-service": "^2.1.2",
     "request": "^2.88.2",
-    "sass": "^1.69.7"
+    "sass": "^1.75.0",
+    "swagger-ui-express": "^5.0.0"
   },
   "devDependencies": {
     "@mastermindzh/prettier-config": "^1.0.0",
+    "@types/cors": "^2.8.17",
     "@types/discord-rpc": "^4.0.8",
     "@types/express": "^4.17.21",
-    "@types/node": "^20.10.6",
+    "@types/node": "^20.12.12",
     "@types/request": "^2.48.12",
+    "@types/swagger-ui-express": "^4.1.6",
     "@typescript-eslint/eslint-plugin": "^6.18.0",
     "@typescript-eslint/parser": "^6.18.0",
     "copyfiles": "^2.4.1",
@@ -69,6 +75,8 @@
     "stylelint-config-standard": "^36.0.0",
     "stylelint-config-standard-scss": "^13.0.0",
     "stylelint-prettier": "^5.0.0",
+    "swagger-jsdoc": "^6.2.8",
+    "ts-node": "^10.9.2",
     "tsc-watch": "^6.0.4",
     "typescript": "^5.3.3"
   },

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

@@ -25,7 +25,8 @@
     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)',
+    playingFrom: '*[class^="playingFrom"] 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

@@ -13,4 +13,6 @@ export const globalEvents = {
   whip: "whip",
   log: "log",
   toggleFavorite: "toggleFavorite",
+  toggleShuffle: "toggleShuffle",
+  toggleRepeat: "toggleRepeat",
 };

src/constants/settings.ts

@@ -14,6 +14,7 @@ export const settings = {
   apiSettings: {
     root: "apiSettings",
     port: "apiSettings.port",
+    hostname: "apiSettings.hostname",
   },
   customCSS: "customCSS",
   disableBackgroundThrottle: "disableBackgroundThrottle",
@@ -24,6 +25,9 @@ export const settings = {
     detailsPrefix: "discord.detailsPrefix",
     buttonText: "discord.buttonText",
     includeTimestamps: "discord.includeTimestamps",
+    showSong: "discord.showSong",
+    idleText: "discord.idleText",
+    usingText: "discord.usingText",
   },
   ListenBrainz: {
     root: "ListenBrainz",

src/features/api/features/current.ts

@@ -0,0 +1,20 @@
+import { Request, Response, Router } from "express";
+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 }));
+  expressApp.get("/current/image", getCurrentImage);
+};
+
+export const getCurrentImage = (req: Request, res: Response) => {
+  const stream = fs.createReadStream(mediaInfo.icon);
+  stream.on("open", function () {
+    res.set("Content-Type", "image/png");
+    stream.pipe(res);
+  });
+  stream.on("error", function () {
+    res.set("Content-Type", "text/plain");
+    res.status(404).end("Not found");
+  });
+};

src/features/api/features/player.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { BrowserWindow } from "electron";
+import { Router } from "express";
+import { globalEvents } from "../../../constants/globalEvents";
+import { settings } from "../../../constants/settings";
+import { MediaStatus } from "../../../models/mediaStatus";
+import { mediaInfo } from "../../../scripts/mediaInfo";
+import { settingsStore } from "../../../scripts/settings";
+import { handleWindowEvent } from "../helpers/handleWindowEvent";
+
+export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow) => {
+  const windowEvent = handleWindowEvent(mainWindow);
+  const createRoute = (route: string) => `/player${route}`;
+
+  const createPlayerAction = (route: string, action: string) => {
+    expressApp.post(createRoute(route), (req, res) => windowEvent(res, action));
+  };
+
+  if (settingsStore.get(settings.playBackControl)) {
+    createPlayerAction("/play", globalEvents.play);
+    createPlayerAction("/favorite/toggle", globalEvents.toggleFavorite);
+    createPlayerAction("/pause", globalEvents.pause);
+    createPlayerAction("/next", globalEvents.next);
+    createPlayerAction("/previous", globalEvents.previous);
+    createPlayerAction("/shuffle/toggle", globalEvents.toggleShuffle);
+    createPlayerAction("/repeat/toggle", globalEvents.toggleRepeat);
+
+    expressApp.post(createRoute("/playpause"), (req, res) => {
+      if (mediaInfo.status === MediaStatus.playing) {
+        windowEvent(res, globalEvents.pause);
+      } else {
+        windowEvent(res, globalEvents.play);
+      }
+    });
+  }
+};

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/helpers/handleWindowEvent.ts

@@ -0,0 +1,12 @@
+import { BrowserWindow } from "electron";
+import { Response } from "express";
+
+/**
+ * Shorthand to handle a fire and forget global event
+ * @param {*} res
+ * @param {*} action
+ */
+export const handleWindowEvent = (mainWindow: BrowserWindow) => (res: Response, action: string) => {
+  mainWindow.webContents.send("globalEvent", action);
+  res.sendStatus(200);
+};

src/features/api/index.ts

@@ -0,0 +1,42 @@
+import cors from "cors";
+import { BrowserWindow, dialog } from "electron";
+import express from "express";
+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.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 expressInstance = expressApp.listen(port, hostname);
+  expressInstance.on("error", function (e: { code: string }) {
+    let message = e.code;
+    if (e.code === "EADDRINUSE") {
+      message = `Port ${port} in use.`;
+    }
+
+    dialog.showErrorBox("Api failed to start.", message);
+  });
+};

src/features/api/legacy.ts

@@ -0,0 +1,47 @@
+import { BrowserWindow } from "electron";
+import { Response, Router } from "express";
+import { globalEvents } from "../../constants/globalEvents";
+import { settings } from "../../constants/settings";
+import { MediaStatus } from "../../models/mediaStatus";
+import { mediaInfo } from "../../scripts/mediaInfo";
+import { settingsStore } from "../../scripts/settings";
+import { getCurrentImage } from "./features/current";
+
+/**
+ * The legacy API, this will not be maintained and probably has duplicate code :)
+ * @param expressApp
+ * @param mainWindow
+ */
+export const addLegacyApi = (expressApp: Router, mainWindow: BrowserWindow) => {
+  expressApp.get("/image", getCurrentImage);
+
+  if (settingsStore.get(settings.playBackControl)) {
+    addLegacyControls();
+  }
+  function addLegacyControls() {
+    expressApp.get("/play", ({ res }) => handleGlobalEvent(res, globalEvents.play));
+    expressApp.post("/favorite/toggle", (req, res) =>
+      handleGlobalEvent(res, globalEvents.toggleFavorite)
+    );
+    expressApp.get("/pause", (req, res) => handleGlobalEvent(res, globalEvents.pause));
+    expressApp.get("/next", (req, res) => handleGlobalEvent(res, globalEvents.next));
+    expressApp.get("/previous", (req, res) => handleGlobalEvent(res, globalEvents.previous));
+    expressApp.get("/playpause", (req, res) => {
+      if (mediaInfo.status === MediaStatus.playing) {
+        handleGlobalEvent(res, globalEvents.pause);
+      } else {
+        handleGlobalEvent(res, globalEvents.play);
+      }
+    });
+  }
+
+  /**
+   * Shorthand to handle a fire and forget global event
+   * @param {*} res
+   * @param {*} action
+   */
+  function handleGlobalEvent(res: Response, action: string) {
+    mainWindow.webContents.send("globalEvent", action);
+    res.sendStatus(200);
+  }
+};

src/features/api/swagger.json

@@ -0,0 +1,130 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "TIDAL Hi-Fi API",
+    "version": "5.14.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": {
+    "/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"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "StringArray": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "example": [
+          "Artist1",
+          "Artist2"
+        ]
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "settings",
+      "description": "The settings management API"
+    }
+  ]
+}

src/features/time/parse.ts

@@ -0,0 +1,14 @@
+/**
+ * Convert a HH:MM:SS string (or variants such as MM:SS or SS) to plain seconds
+ * @param duration in HH:MM:SS format
+ * @returns number of seconds in duration
+ */
+export const convertDurationToSeconds = (duration: string) => {
+  return duration
+    .split(":")
+    .reverse()
+    .map((val) => Number(val))
+    .reduce((previous, current, index) => {
+      return index === 0 ? current : previous + current * Math.pow(60, index);
+    }, 0);
+};

src/main.ts

@@ -1,17 +1,9 @@
 import { enable, initialize } from "@electron/remote/main";
-import {
-  app,
-  BrowserWindow,
-  components,
-  globalShortcut,
-  ipcMain,
-  protocol,
-  session,
-} from "electron";
+import { BrowserWindow, app, components, ipcMain, session } from "electron";
 import path from "path";
 import { globalEvents } from "./constants/globalEvents";
-import { mediaKeys } from "./constants/mediaKeys";
 import { settings } from "./constants/settings";
+import { startApi } from "./features/api";
 import { setDefaultFlags, setManagedFlagsFromSettings } from "./features/flags/flags";
 import {
   acquireInhibitorIfInactive,
@@ -22,7 +14,6 @@ import { Songwhip } from "./features/songwhip/songwhip";
 import { MediaInfo } from "./models/mediaInfo";
 import { MediaStatus } from "./models/mediaStatus";
 import { initRPC, rpc, unRPC } from "./scripts/discord";
-import { startExpress } from "./scripts/express";
 import { updateMediaInfo } from "./scripts/mediaInfo";
 import { addMenu } from "./scripts/menu";
 import {
@@ -61,20 +52,31 @@ function syncMenuBarWithStore() {
 }
 
 /**
- * Determine whether the current window is the main window
- * if singleInstance is requested.
- * If singleInstance isn't requested simply return true
- * @returns true if singInstance is not requested, otherwise true/false based on whether the current window is the main window
+ * @returns true/false based on whether the current window is the main window
  */
-function isMainInstanceOrMultipleInstancesAllowed() {
-  if (settingsStore.get(settings.singleInstance)) {
-    const gotTheLock = app.requestSingleInstanceLock();
+function isMainInstance() {
+  return app.requestSingleInstanceLock();
+}
 
-    if (!gotTheLock) {
-      return false;
-    }
+/**
+ * @returns true/false based on whether multiple instances are allowed
+ */
+function isMultipleInstancesAllowed() {
+  return !settingsStore.get(settings.singleInstance);
+}
+
+/**
+ * @param args the arguments passed to the app
+ * @returns the custom protocol url if it exists, otherwise null
+ */
+function getCustomProtocolUrl(args: string[]) {
+  const customProtocolArg = args.find((arg) => arg.startsWith(PROTOCOL_PREFIX));
+
+  if (!customProtocolArg) {
+    return null;
   }
-  return true;
+
+  return tidalUrl + "/" + customProtocolArg.substring(PROTOCOL_PREFIX.length + 3);
 }
 
 function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
@@ -98,8 +100,16 @@ function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
   registerHttpProtocols();
   syncMenuBarWithStore();
 
-  // load the Tidal website
-  mainWindow.loadURL(tidalUrl);
+  // find the custom protocol argument
+  const customProtocolUrl = getCustomProtocolUrl(process.argv);
+
+  if (customProtocolUrl) {
+    // load the url received from the custom protocol
+    mainWindow.loadURL(customProtocolUrl);
+  } else {
+    // load the Tidal website
+    mainWindow.loadURL(tidalUrl);
+  }
 
   if (settingsStore.get(settings.disableBackgroundThrottle)) {
     // prevent setInterval lag
@@ -139,27 +149,32 @@ function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
 }
 
 function registerHttpProtocols() {
-  protocol.registerHttpProtocol(PROTOCOL_PREFIX, (request) => {
-    mainWindow.loadURL(`${tidalUrl}/${request.url.substring(PROTOCOL_PREFIX.length + 3)}`);
-  });
   if (!app.isDefaultProtocolClient(PROTOCOL_PREFIX)) {
     app.setAsDefaultProtocolClient(PROTOCOL_PREFIX);
   }
 }
 
-function addGlobalShortcuts() {
-  Object.keys(mediaKeys).forEach((key) => {
-    globalShortcut.register(`${key}`, () => {
-      mainWindow.webContents.send("globalEvent", `${(mediaKeys as any)[key]}`);
-    });
-  });
-}
-
 // This method will be called when Electron has finished
 // initialization and is ready to create browser windows.
 // Some APIs can only be used after this event occurs.
 app.on("ready", async () => {
-  if (isMainInstanceOrMultipleInstancesAllowed()) {
+  // check if the app is the main instance and multiple instances are not allowed
+  if (isMainInstance() && !isMultipleInstancesAllowed()) {
+    app.on("second-instance", (_, commandLine) => {
+      const customProtocolUrl = getCustomProtocolUrl(commandLine);
+
+      if (customProtocolUrl) {
+        mainWindow.loadURL(customProtocolUrl);
+      }
+
+      if (mainWindow) {
+        if (mainWindow.isMinimized()) mainWindow.restore();
+        mainWindow.focus();
+      }
+    });
+  }
+
+  if (isMainInstance() || isMultipleInstancesAllowed()) {
     await components.whenReady();
 
     // Adblock
@@ -174,12 +189,11 @@ app.on("ready", async () => {
     createWindow();
     addMenu(mainWindow);
     createSettingsWindow();
-    addGlobalShortcuts();
     if (settingsStore.get(settings.trayIcon)) {
       addTray(mainWindow, { icon });
       refreshTray(mainWindow);
     }
-    settingsStore.get(settings.api) && startExpress(mainWindow);
+    settingsStore.get(settings.api) && startApi(mainWindow);
     settingsStore.get(settings.enableDiscord) && initRPC();
   } else {
     app.quit();

src/models/mediaInfo.ts

@@ -1,3 +1,4 @@
+import { MediaPlayerInfo } from "./mediaPlayerInfo";
 import { MediaStatus } from "./mediaStatus";
 
 export interface MediaInfo {
@@ -7,8 +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,13 +0,0 @@
-export interface Options {
-  title: string;
-  artists: string;
-  album: string;
-  status: string;
-  url: string;
-  current: string;
-  duration: string;
-  "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

@@ -20,6 +20,11 @@ const switchesWithSettings = {
     classToHide: "discord_options",
     settingsKey: settings.enableDiscord,
   },
+  discord_show_song: {
+    switch: "discord_show_song",
+    classToHide: "discord_show_song_options",
+    settingsKey: settings.discord.showSong,
+  },
 };
 
 let adBlock: HTMLInputElement,
@@ -30,6 +35,7 @@ let adBlock: HTMLInputElement,
   enableCustomHotkeys: HTMLInputElement,
   enableDiscord: HTMLInputElement,
   gpuRasterization: HTMLInputElement,
+  hostname: HTMLInputElement,
   menuBar: HTMLInputElement,
   minimizeOnClose: HTMLInputElement,
   mpris: HTMLInputElement,
@@ -49,7 +55,10 @@ let adBlock: HTMLInputElement,
   enableWaylandSupport: HTMLInputElement,
   discord_details_prefix: HTMLInputElement,
   discord_include_timestamps: HTMLInputElement,
-  discord_button_text: HTMLInputElement;
+  discord_button_text: HTMLInputElement,
+  discord_show_song: HTMLInputElement,
+  discord_idle_text: HTMLInputElement,
+  discord_using_text: HTMLInputElement;
 
 addCustomCss(app);
 
@@ -119,6 +128,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);
@@ -138,6 +148,9 @@ function refreshSettings() {
     discord_details_prefix.value = settingsStore.get(settings.discord.detailsPrefix);
     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_idle_text.value = settingsStore.get(settings.discord.idleText);
+    discord_using_text.value = settingsStore.get(settings.discord.usingText);
 
     // set state of all switches with additional settings
     Object.values(switchesWithSettings).forEach((settingSwitch) => {
@@ -232,6 +245,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");
@@ -251,6 +265,9 @@ window.addEventListener("DOMContentLoaded", () => {
   discord_include_timestamps = get("discord_include_timestamps");
   listenbrainz_delay = get("listenbrainz_delay");
   discord_button_text = get("discord_button_text");
+  discord_show_song = get("discord_show_song");
+  discord_using_text = get("discord_using_text");
+  discord_idle_text = get("discord_idle_text");
 
   refreshSettings();
   addInputListener(adBlock, settings.adBlock);
@@ -262,6 +279,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);
@@ -285,4 +303,11 @@ 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_idle_text, settings.discord.idleText);
+  addInputListener(discord_using_text, settings.discord.usingText);
 });

src/pages/settings/settings.html

@@ -167,6 +167,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>
@@ -216,32 +226,64 @@
               </label>
             </div>
             <div id="discord_options">
+
               <div class="group__option" class="hidden">
                 <div class="group__description">
-                  <h4>Include timestamps</h4>
-                  <p>Show current/end playtime in the Discord client</p>
+                  <h4>Idle Text</h4>
+                  <p>The text displayed on Discord's rich presence while idling in the app.</p>
+                  <input id="discord_idle_text" type="text" class="text-input" name="discord_idle_text" />
+                </div>
+              </div>
+
+              <div class="group__option" class="hidden">
+                <div class="group__description">
+                  <h4>Using Tidal Text</h4>
+                  <p>The text displayed on Discord's rich presence while "showSong" is turned off</p>
+                  <input id="discord_using_text" type="text" class="text-input" name="discord_using_text" />
+                </div>
+              </div>
+
+              <div class="group__option" class="hidden">
+                <div class="group__description">
+                  <h4>Show song</h4>
+                  <p>Show the current song in the Discord client</p>
                 </div>
                 <label class="switch">
-                  <input id="discord_include_timestamps" type="checkbox" />
+                  <input id="discord_show_song" type="checkbox" />
                   <span class="switch__slider"></span>
                 </label>
               </div>
 
-              <div class="group__option" class="hidden">
-                <div class="group__description">
-                  <h4>Details prefix</h4>
-                  <p>Prefix for the "details" field of Discord's rich presence.</p>
-                  <input id="discord_details_prefix" type="text" class="text-input" name="discord_details_prefix" />
+              <div id="discord_show_song_options" class="hidden">
+
+                <div class="group__option" class="hidden">
+                  <div class="group__description">
+                    <h4>Include timestamps</h4>
+                    <p>Show current/end playtime in the Discord client</p>
+                  </div>
+                  <label class="switch">
+                    <input id="discord_include_timestamps" type="checkbox" />
+                    <span class="switch__slider"></span>
+                  </label>
+                </div>
+
+                <div class="group__option" class="hidden">
+                  <div class="group__description">
+                    <h4>Details prefix</h4>
+                    <p>Prefix for the "details" field of Discord's rich presence.</p>
+                    <input id="discord_details_prefix" type="text" class="text-input" name="discord_details_prefix" />
+                  </div>
+                </div>
+
+                <div class="group__option">
+                  <div class="group__description">
+                    <h4>Button text</h4>
+                    <p>Text to display on the button below the song information.</p>
+                    <input id="discord_button_text" type="text" class="text-input" name="discord_button_text" />
+                  </div>
                 </div>
               </div>
 
-              <div class="group__option">
-                <div class="group__description">
-                  <h4>Button text</h4>
-                  <p>Text to display on the button below the song information.</p>
-                  <input id="discord_button_text" type="text" class="text-input" name="discord_button_text" />
-                </div>
-              </div>
             </div>
           </div>
           <div class="group">
@@ -400,14 +442,16 @@
           <img alt="tidal icon" class="about-section__icon" src="./icon.png" />
           <h4>TIDAL Hi-Fi</h4>
           <div class="about-section__version">
-            <a href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.8.0">5.8.0</a>
+            <a target="_blank" rel="noopener"
+              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.14.1">5.14.1</a>
           </div>
           <div class="about-section__links">
-            <a href="https://github.com/mastermindzh/tidal-hifi/" class="about-section__button">Github <i
-                class="fa fa-external-link"></i></a>
-            <a href="https://github.com/Mastermindzh/tidal-hifi/issues" class="about-section__button">Report an issue <i
-                class="fa fa-external-link"></i></a>
-            <a href="https://github.com/Mastermindzh/tidal-hifi/graphs/contributors"
+            <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"
+              class="about-section__button">Github
+              <i class="fa fa-external-link"></i></a>
+            <a target="_blank" rel="noopener" href="https://github.com/Mastermindzh/tidal-hifi/issues"
+              class="about-section__button">Report an issue <i class="fa fa-external-link"></i></a>
+            <a target="_blank" rel="noopener" href="https://github.com/Mastermindzh/tidal-hifi/graphs/contributors"
               class="about-section__button">Contributors <i class="fa fa-external-link"></i></a>
           </div>
         </section>

src/pages/settings/settings.scss

@@ -415,7 +415,6 @@ html {
 }
 
 // file upload
-
 .file-drop-area {
   position: relative;
   display: flex;

src/preload.ts

@@ -12,21 +12,29 @@ import { StoreData } from "./features/listenbrainz/models/storeData";
 import { Logger } from "./features/logger";
 import { Songwhip } from "./features/songwhip/songwhip";
 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;
 let currentListenBrainzDelayId: ReturnType<typeof setTimeout>;
 let scrobbleWaitingForDelay = false;
 
+let currentlyPlaying = MediaStatus.paused;
+let currentRepeatState: RepeatState = RepeatState.off;
+let currentShuffleState = false;
+let currentMediaInfo: MediaInfo;
+let currentNotification: Electron.Notification;
+
 const elements = {
   play: '*[data-test="play"]',
   pause: '*[data-test="pause"]',
@@ -49,7 +57,9 @@ const elements = {
   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"]',
@@ -125,6 +135,12 @@ const elements = {
       }
     }
 
+    // see whether we're on the queue page and get it from there
+    const queueAlbumName = elements.getText("queue_album");
+    if (queueAlbumName) {
+      return queueAlbumName;
+    }
+
     return "";
   },
 
@@ -301,6 +317,8 @@ function addIPCEventListeners() {
     ipcRenderer.on("globalEvent", (_event, args) => {
       switch (args) {
         case globalEvents.playPause:
+        case globalEvents.play:
+        case globalEvents.pause:
           playPause();
           break;
         case globalEvents.next:
@@ -309,15 +327,15 @@ function addIPCEventListeners() {
         case globalEvents.previous:
           elements.click("previous");
           break;
-        case globalEvents.play:
-          elements.click("play");
-          break;
-        case globalEvents.pause:
-          elements.click("pause");
-          break;
         case globalEvents.toggleFavorite:
           elements.click("favorite");
           break;
+        case globalEvents.toggleShuffle:
+          elements.click("shuffle");
+          break;
+        case globalEvents.toggleRepeat:
+          elements.click("repeat");
+          break;
         default:
           break;
       }
@@ -341,6 +359,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
@@ -353,16 +388,24 @@ function convertDuration(duration: string) {
 /**
  * Update Tidal-hifi's media info
  *
- * @param {*} options
+ * @param {*} mediaInfo
  */
-function updateMediaInfo(options: Options, notify: boolean) {
-  if (options) {
-    ipcRenderer.send(globalEvents.updateInfo, options);
+function updateMediaInfo(mediaInfo: MediaInfo, notify: boolean) {
+  if (mediaInfo) {
+    currentMediaInfo = mediaInfo;
+    ipcRenderer.send(globalEvents.updateInfo, mediaInfo);
     if (settingsStore.get(settings.notifications) && notify) {
-      new Notification({ title: options.title, body: options.artists, icon: options.icon }).show();
+      if (currentNotification) currentNotification.close();
+      currentNotification = new Notification({
+        title: mediaInfo.title,
+        body: mediaInfo.artists,
+        icon: mediaInfo.icon,
+      });
+      currentNotification.show();
     }
-    updateMpris(options);
-    updateListenBrainz(options);
+
+    updateMpris(mediaInfo);
+    updateListenBrainz(mediaInfo);
   }
 }
 
@@ -420,32 +463,33 @@ function addMPRIS() {
   }
 }
 
-function updateMpris(options: Options) {
+function updateMpris(mediaInfo: MediaInfo) {
   if (player) {
     player.metadata = {
       ...player.metadata,
       ...{
-        "xesam:title": options.title,
-        "xesam:artist": [options.artists],
-        "xesam:album": options.album,
-        "mpris:artUrl": options.image,
-        "mpris:length": convertDuration(options.duration) * 1000 * 1000,
+        "xesam:title": mediaInfo.title,
+        "xesam:artist": [mediaInfo.artists],
+        "xesam:album": mediaInfo.album,
+        "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 && oldData.title !== options.title)
+      (!oldData && mediaInfo.status === MediaStatus.playing) ||
+      (oldData && oldData.title !== mediaInfo.title)
     ) {
       if (!scrobbleWaitingForDelay) {
         scrobbleWaitingForDelay = true;
@@ -453,10 +497,10 @@ function updateListenBrainz(options: Options) {
         currentListenBrainzDelayId = setTimeout(
           () => {
             ListenBrainz.scrobble(
-              options.title,
-              options.artists,
-              options.status,
-              convertDuration(options.duration)
+              mediaInfo.title,
+              mediaInfo.artists,
+              mediaInfo.status,
+              convertDuration(mediaInfo.duration)
             );
             scrobbleWaitingForDelay = false;
           },
@@ -486,23 +530,6 @@ function getTrackID() {
   return window.location;
 }
 
-function updateMediaSession(options: Options) {
-  if ("mediaSession" in navigator) {
-    navigator.mediaSession.metadata = new MediaMetadata({
-      title: options.title,
-      artist: options.artists,
-      album: options.album,
-      artwork: [
-        {
-          src: options.icon,
-          sizes: "640x640",
-          type: "image/png",
-        },
-      ],
-    });
-  }
-}
-
 /**
  * Watch for song changes and update title + notify
  */
@@ -510,60 +537,85 @@ setInterval(function () {
   const title = elements.getText("title");
   const artistsArray = elements.getArtistsArray();
   const artistsString = elements.getArtistsString(artistsArray);
-  skipArtistsIfFoundInSkippedArtistsList(artistsArray);
-
-  const album = elements.getAlbumName();
-  const current = elements.getText("current");
-  const duration = elements.getText("duration");
   const songDashArtistTitle = `${title} - ${artistsString}`;
-  const currentStatus = getCurrentlyPlayingStatus();
-  const options = {
-    title,
-    artists: artistsString,
-    album: album,
-    status: currentStatus,
-    url: getTrackURL(),
-    current,
-    duration,
-    "app-name": appName,
-    image: "",
-    icon: "",
-    favorite: elements.isFavorite(),
-  };
-
   const titleOrArtistsChanged = currentSong !== songDashArtistTitle;
+  const current = elements.getText("current");
+  const currentStatus = getCurrentlyPlayingStatus();
+  const shuffleState = getCurrentShuffleState();
+  const repeatState = getCurrentRepeatState();
 
-  // update title, url and play info with new info
-  setTitle(songDashArtistTitle);
-  getTrackURL();
-  currentSong = songDashArtistTitle;
-  currentPlayStatus = currentStatus;
+  const playStateChanged = currentStatus != currentlyPlaying;
+  const shuffleStateChanged = shuffleState != currentShuffleState;
+  const repeatStateChanged = repeatState != currentRepeatState;
 
-  const image = elements.getSongIcon();
+  const hasStateChanged = playStateChanged || shuffleStateChanged || repeatStateChanged;
 
-  new Promise<void>((resolve) => {
-    if (image.startsWith("http")) {
-      options.image = image;
-      downloadFile(image, notificationPath).then(
-        () => {
-          options.icon = notificationPath;
-          resolve();
-        },
-        () => {
-          // if the image can't be downloaded then continue without it
-          resolve();
-        }
-      );
-    } else {
-      // if the image can't be found on the page continue without it
-      resolve();
-    }
-  }).then(() => {
-    updateMediaInfo(options, titleOrArtistsChanged);
-    if (titleOrArtistsChanged) {
-      updateMediaSession(options);
-    }
-  });
+  // update info if song changed or was just paused/resumed
+  if (titleOrArtistsChanged || hasStateChanged) {
+    if (playStateChanged) currentlyPlaying = currentStatus;
+    if (shuffleStateChanged) currentShuffleState = shuffleState;
+    if (repeatStateChanged) currentRepeatState = repeatState;
+
+    skipArtistsIfFoundInSkippedArtistsList(artistsArray);
+    const album = elements.getAlbumName();
+    const duration = elements.getText("duration");
+    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),
+      image: "",
+      icon: "",
+      favorite: elements.isFavorite(),
+
+      player: {
+        status: currentStatus,
+        shuffle: shuffleState,
+        repeat: repeatState,
+      },
+    };
+
+    // update title, url and play info with new info
+    setTitle(songDashArtistTitle);
+    getTrackURL();
+    currentSong = songDashArtistTitle;
+    currentPlayStatus = currentStatus;
+
+    const image = elements.getSongIcon();
+
+    new Promise<void>((resolve) => {
+      if (image.startsWith("http")) {
+        options.image = image;
+        downloadFile(image, notificationPath).then(
+          () => {
+            options.icon = notificationPath;
+            resolve();
+          },
+          () => {
+            // if the image can't be downloaded then continue without it
+            resolve();
+          }
+        );
+      } else {
+        // if the image can't be found on the page continue without it
+        resolve();
+      }
+    }).then(() => {
+      updateMediaInfo(options, titleOrArtistsChanged);
+    });
+  } else {
+    // just update the time
+    updateMediaInfo(
+      { ...currentMediaInfo, ...{ current, currentInSeconds: convertDurationToSeconds(current) } },
+      false
+    );
+  }
 
   /**
    * automatically skip a song if the artists are found in the list of artists to skip

src/scripts/discord.ts

@@ -1,75 +1,85 @@
-import { Client } from "discord-rpc";
+import { Client, Presence } from "discord-rpc";
 import { app, ipcMain } from "electron";
 import { globalEvents } from "../constants/globalEvents";
 import { settings } from "../constants/settings";
 import { Logger } from "../features/logger";
+import { convertDurationToSeconds } from "../features/time/parse";
 import { MediaStatus } from "../models/mediaStatus";
 import { mediaInfo } from "./mediaInfo";
 import { settingsStore } from "./settings";
 
 const clientId = "833617820704440341";
 
-function timeToSeconds(timeArray: string[]) {
-  const minutes = parseInt(timeArray[0]) * 1;
-  const seconds = minutes * 60 + parseInt(timeArray[1]) * 1;
-  return seconds;
-}
-
 export let rpc: Client;
 
 const observer = () => {
-  if (mediaInfo.status === MediaStatus.paused && rpc) {
-    rpc.setActivity(idleStatus);
-  } else if (rpc) {
-    const currentSeconds = timeToSeconds(mediaInfo.current.split(":"));
-    const durationSeconds = timeToSeconds(mediaInfo.duration.split(":"));
-    const date = new Date();
-    const now = (date.getTime() / 1000) | 0;
-    const remaining = date.setSeconds(date.getSeconds() + (durationSeconds - currentSeconds));
+  if (rpc) {
+    rpc.setActivity(getActivity());
+  }
+};
+
+const defaultPresence = {
+  largeImageKey: "tidal-hifi-icon",
+  largeImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
+  instance: false,
+};
+
+const getActivity = (): Presence => {
+  const presence: Presence = { ...defaultPresence };
+
+  if (mediaInfo.status === MediaStatus.paused) {
+    presence.details =
+      settingsStore.get<string, string>(settings.discord.idleText) ?? "Browsing Tidal";
+  } else {
+    const showSong = settingsStore.get<string, boolean>(settings.discord.showSong) ?? false;
+    if (showSong) {
+      const { includeTimestamps, detailsPrefix, buttonText } = getFromStore();
+      includeTimeStamps(includeTimestamps);
+      setPresenceFromMediaInfo(detailsPrefix, buttonText);
+    } else {
+      presence.details =
+        settingsStore.get<string, string>(settings.discord.usingText) ?? "Playing media on TIDAL";
+    }
+  }
+  return presence;
+
+  function getFromStore() {
+    const includeTimestamps =
+      settingsStore.get<string, boolean>(settings.discord.includeTimestamps) ?? true;
     const detailsPrefix =
       settingsStore.get<string, string>(settings.discord.detailsPrefix) ?? "Listening to ";
     const buttonText =
       settingsStore.get<string, string>(settings.discord.buttonText) ?? "Play on TIDAL";
-    const includeTimestamps =
-      settingsStore.get<string, boolean>(settings.discord.includeTimestamps) ?? true;
 
-    let activity = {
-      ...idleStatus,
-      ...{
-        startTimestamp: includeTimestamps ? now : undefined,
-        endTimestamp: includeTimestamps ? remaining : undefined,
-      },
-    };
-    if (mediaInfo.url) {
-      activity = {
-        ...activity,
-        ...{
-          details: `${detailsPrefix}${mediaInfo.title}`,
-          state: mediaInfo.artists ? mediaInfo.artists : "unknown artist(s)",
-          largeImageKey: mediaInfo.image,
-          largeImageText: mediaInfo.album ? mediaInfo.album : `${idleStatus.largeImageText}`,
-          buttons: [{ label: buttonText, url: mediaInfo.url }],
-        },
-      };
-    } else {
-      activity = {
-        ...activity,
-        ...{
-          details: `Watching ${mediaInfo.title}`,
-          state: mediaInfo.artists,
-        },
-      };
-    }
-
-    rpc.setActivity(activity);
+    return { includeTimestamps, detailsPrefix, buttonText };
   }
-};
 
-const idleStatus = {
-  details: `Browsing Tidal`,
-  largeImageKey: "tidal-hifi-icon",
-  largeImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
-  instance: false,
+  function setPresenceFromMediaInfo(detailsPrefix: string, buttonText: string) {
+    if (mediaInfo.url) {
+      presence.details = `${detailsPrefix}${mediaInfo.title}`;
+      presence.state = mediaInfo.artists ? mediaInfo.artists : "unknown artist(s)";
+      presence.largeImageKey = mediaInfo.image;
+      if (mediaInfo.album) {
+        presence.largeImageText = mediaInfo.album;
+      }
+      presence.buttons = [{ label: buttonText, url: mediaInfo.url }];
+    } else {
+      presence.details = `Watching ${mediaInfo.title}`;
+      presence.state = mediaInfo.artists;
+    }
+  }
+
+  function includeTimeStamps(includeTimestamps: boolean) {
+    if (includeTimestamps) {
+      const currentSeconds = convertDurationToSeconds(mediaInfo.current);
+      const durationSeconds = convertDurationToSeconds(mediaInfo.duration);
+      const date = new Date();
+      const now = (date.getTime() / 1000) | 0;
+      const remaining = date.setSeconds(date.getSeconds() + (durationSeconds - currentSeconds));
+      presence.startTimestamp = now;
+      presence.endTimestamp = remaining;
+    }
+  }
 };
 
 /**
@@ -80,7 +90,7 @@ export const initRPC = () => {
   rpc.login({ clientId }).then(
     () => {
       rpc.on("ready", () => {
-        rpc.setActivity(idleStatus);
+        rpc.setActivity(getActivity());
       });
       ipcMain.on(globalEvents.updateInfo, observer);
     },

src/scripts/express.ts

@@ -1,69 +0,0 @@
-import { BrowserWindow, dialog } from "electron";
-import express, { Response } from "express";
-import fs from "fs";
-import { settings } from "../constants/settings";
-import { MediaStatus } from "../models/mediaStatus";
-import { globalEvents } from "./../constants/globalEvents";
-import { mediaInfo } from "./mediaInfo";
-import { settingsStore } from "./settings";
-
-/**
- * Function to enable TIDAL Hi-Fi's express api
- */
-
-// expressModule.run = function (mainWindow)
-export const startExpress = (mainWindow: BrowserWindow) => {
-  /**
-   * Shorthand to handle a fire and forget global event
-   * @param {*} res
-   * @param {*} action
-   */
-  function handleGlobalEvent(res: Response, action: string) {
-    mainWindow.webContents.send("globalEvent", action);
-    res.sendStatus(200);
-  }
-
-  const expressApp = express();
-  expressApp.get("/", (req, res) => res.send("Hello World!"));
-  expressApp.get("/current", (req, res) => res.json({ ...mediaInfo, artist: mediaInfo.artists }));
-  expressApp.get("/image", (req, res) => {
-    const stream = fs.createReadStream(mediaInfo.icon);
-    stream.on("open", function () {
-      res.set("Content-Type", "image/png");
-      stream.pipe(res);
-    });
-    stream.on("error", function () {
-      res.set("Content-Type", "text/plain");
-      res.status(404).end("Not found");
-    });
-  });
-
-  if (settingsStore.get(settings.playBackControl)) {
-    expressApp.get("/play", (req, res) => handleGlobalEvent(res, globalEvents.play));
-    expressApp.post("/favorite/toggle", (req, res) =>
-      handleGlobalEvent(res, globalEvents.toggleFavorite)
-    );
-    expressApp.get("/pause", (req, res) => handleGlobalEvent(res, globalEvents.pause));
-    expressApp.get("/next", (req, res) => handleGlobalEvent(res, globalEvents.next));
-    expressApp.get("/previous", (req, res) => handleGlobalEvent(res, globalEvents.previous));
-    expressApp.get("/playpause", (req, res) => {
-      if (mediaInfo.status === MediaStatus.playing) {
-        handleGlobalEvent(res, globalEvents.pause);
-      } else {
-        handleGlobalEvent(res, globalEvents.play);
-      }
-    });
-  }
-
-  const port = settingsStore.get<string, number>(settings.apiSettings.port);
-
-  const expressInstance = expressApp.listen(port, "127.0.0.1");
-  expressInstance.on("error", function (e: { code: string }) {
-    let message = e.code;
-    if (e.code === "EADDRINUSE") {
-      message = `Port ${port} in use.`;
-    }
-
-    dialog.showErrorBox("Api failed to start.", message);
-  });
-};

src/scripts/mediaInfo.ts

@@ -1,37 +1,45 @@
 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,
   duration: "",
+  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.artists = propOrDefault(arg.artists);
-  mediaInfo.album = propOrDefault(arg.album);
-  mediaInfo.icon = propOrDefault(arg.icon);
-  mediaInfo.url = propOrDefault(arg.url);
-  mediaInfo.status = propOrDefault(arg.status);
-  mediaInfo.current = propOrDefault(arg.current);
-  mediaInfo.duration = propOrDefault(arg.duration);
-  mediaInfo.image = propOrDefault(arg.image);
-  mediaInfo.favorite = arg.favorite;
+  mediaInfo = { ...defaultInfo, ...arg };
+  mediaInfo.url = toUniversalUrl(mediaInfo.url);
 };
 
 /**
- * Return the property or a default value
- * @param {*} prop property to check
- * @param {*} defaultValue defaults to ""
+ * Append the universal link syntax (?u) to any url
+ * @param url url to append the universal link syntax to
+ * @returns url with `?u` appended, or the original value of url if falsy
  */
-function propOrDefault(prop: string, defaultValue = "") {
-  return prop ? prop : defaultValue;
+function toUniversalUrl(url: string) {
+  if (url) {
+    const queryParamsSet = url.indexOf("?");
+    return queryParamsSet > -1 ? `${url}&u` : `${url}?u`;
+  }
+  return url;
 }

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

@@ -1,10 +1,29 @@
 import Store from "electron-store";
 
-import { BrowserWindow } from "electron";
+import { BrowserWindow, shell } from "electron";
 import path from "path";
 import { settings } from "../constants/settings";
 
 let settingsWindow: BrowserWindow;
+/**
+ * Build a migration step for several settings.
+ * All settings will be checked and set to the default if non-existent.
+ * @param version
+ * @param migrationStore
+ * @param options
+ */
+const buildMigration = (
+  version: string,
+  migrationStore: { get: (str: string) => string; set: (str: string, val: unknown) => void },
+  options: Array<{ key: string; value: unknown }>
+) => {
+  console.log(`running migrations for ${version}`);
+  options.forEach(({ key, value }) => {
+    const valueToSet = migrationStore.get(key) ?? value;
+    console.log(`  - setting ${key} to ${value}`);
+    migrationStore.set(key, valueToSet);
+  });
+};
 
 export const settingsStore = new Store({
   defaults: {
@@ -12,6 +31,7 @@ export const settingsStore = new Store({
     api: true,
     apiSettings: {
       port: 47836,
+      hostname: "127.0.0.1",
     },
     customCSS: [],
     disableBackgroundThrottle: true,
@@ -19,9 +39,12 @@ export const settingsStore = new Store({
     enableCustomHotkeys: false,
     enableDiscord: false,
     discord: {
+      showSong: true,
+      idleText: "Browsing Tidal",
+      usingText: "Playing media on TIDAL",
+      includeTimestamps: true,
       detailsPrefix: "Listening to ",
       buttonText: "Play on Tidal",
-      includeTimestamps: true,
     },
     ListenBrainz: {
       enabled: false,
@@ -69,6 +92,21 @@ export const settingsStore = new Store({
         migrationStore.get(settings.discord.includeTimestamps) ?? true
       );
     },
+    "5.9.0": (migrationStore) => {
+      buildMigration("5.9.0", migrationStore, [
+        { key: settings.discord.showSong, value: "true" },
+        { key: settings.discord.idleText, value: "Browsing Tidal" },
+        {
+          key: settings.discord.usingText,
+          value: "Playing media on TIDAL",
+        },
+      ]);
+    },
+    "5.14.0": (migrationStore) => {
+      buildMigration("5.14.0", migrationStore, [
+        { key: settings.apiSettings.hostname, value: "127.0.0.1" },
+      ]);
+    },
   },
 });
 
@@ -102,10 +140,18 @@ export const createSettingsWindow = function () {
 
   settingsWindow.loadURL(`file://${__dirname}/../pages/settings/settings.html`);
 
+  settingsWindow.webContents.setWindowOpenHandler(({ url }) => {
+    shell.openExternal(url);
+    return { action: "deny" };
+  });
   settingsModule.settingsWindow = settingsWindow;
 };
 
 export const showSettingsWindow = function (tab = "general") {
+  if (!settingsWindow) {
+    console.log("Settings window is not initialized. Attempting to create it.");
+    createSettingsWindow();
+  }
   settingsWindow.webContents.send("goToTab", tab);
 
   // refresh data just before showing the window
@@ -119,3 +165,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": {