rename to TidalController

.stylelintrc.json

@@ -1,16 +1,10 @@
 {
-  "plugins": [
+  "plugins": ["stylelint-prettier"],
-    "stylelint-prettier"
+  "extends": ["stylelint-config-standard-scss"],
-  ],
+  "ignoreFiles": ["src/themes/**.scss"],
-  "extends": [
-    "stylelint-config-standard-scss"
-  ],
-  "ignoreFiles": [
-    "src/themes/**.scss"
-  ],
   "rules": {
     "prettier/prettier": true,
     "scss/at-extend-no-missing-placeholder": null,
     "no-descending-specificity": null
   }
-}
+}

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.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
@@ -112,10 +113,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Updated Electron to 28.1.1 (fixes [325](https://github.com/Mastermindzh/tidal-hifi/issues/325))
 - Updated dependencies to latest
+
   - added theme files to stylelint ignore
   - fixed other stylelint errors
 
 - Added functionality to favorite a song (fixes [#323](https://github.com/Mastermindzh/tidal-hifi/issues/323))
+
   - Added a hotkey to favorite ("Add to collection") songs: Control+a
   - Added the "favorite" field in the `mediaInfo` and the API `/current` endpoint
   - Added an endpoint to toggle favoriting a song: `http://localhost:47836/favorite/toggle`
@@ -136,10 +139,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added settings to customize the Discord rich presence information
   - Discord settings are now also collapsible like the ListenBrainz ones are
 - Restyled settings menu to include version number and useful links on the about page
-    ![The new about page](./docs/images/new-about.png)
+  ![The new about page](./docs/images/new-about.png)
 - The ListenBrainz integration has been extended with a configurable (5 seconds by default) delay in song reporting so that it doesn't spam the API when you are cycling through songs.
 - Custom CSS now also applies to settings window
-    ![Tokyo Night theme on settings window](./docs/images/customcss-menu.png)
+  ![Tokyo Night theme on settings window](./docs/images/customcss-menu.png)
 
 ## [5.6.0]
 

SECURITY.md

@@ -8,4 +8,3 @@ Only the very latest 😄.
 
 If you find a vulnerability just add it as an issue.
 If there's an especially bad vulnerability that you don't want to make public just send me a private message (email, discord, wherever).
-

package.json

@@ -23,6 +23,7 @@
     "build-mac": "npm run builder -- -c ./build/electron-builder.yml -m",
     "build-base": "npm run builder -- -c ./build/electron-builder.base.yml",
     "prebuilder": "npm run compile",
+    "prettier": "prettier . --write",
     "builder": "electron-builder --publish=never",
     "sass": "sass ./src/pages/settings/settings.scss ./src/pages/settings/settings.css && sass --no-source-map src/themes:themes",
     "style-lint": "npx stylelint **/*.scss",
@@ -80,4 +81,4 @@
     "typescript": "^5.5.3"
   },
   "prettier": "@mastermindzh/prettier-config"
-}
+}

src/TidalControllers/DomTidalController.ts

@@ -0,0 +1,168 @@
+import { TidalController } from "./TidalController";
+
+export class DomTidalController implements TidalController {
+  public elements = {
+    play: '*[data-test="play"]',
+    pause: '*[data-test="pause"]',
+    next: '*[data-test="next"]',
+    previous: 'button[data-test="previous"]',
+    title: '*[data-test^="footer-track-title"]',
+    artists: '*[data-test^="grid-item-detail-text-title-artist"]',
+    home: '*[data-test="menu--home"]',
+    back: '[title^="Back"]',
+    forward: '[title^="Next"]',
+    search: '[class^="searchField"]',
+    shuffle: '*[data-test="shuffle"]',
+    repeat: '*[data-test="repeat"]',
+    account: '*[data-test^="profile-image-button"]',
+    settings: '*[data-test^="sidebar-menu-button"]',
+    openSettings: '*[data-test^="open-settings"]',
+    media: '*[data-test="current-media-imagery"]',
+    image: "img",
+    current: '*[data-test="current-time"]',
+    duration: '*[class^=playbackControlsContainer] *[data-test="duration"]',
+    bar: '*[data-test="progress-bar"]',
+    footer: "#footerPlayer",
+    mediaItem: "[data-type='mediaItem']",
+    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"]',
+    volume: '*[data-test="volume"]',
+    favorite: '*[data-test="footer-favorite-button"]',
+    /**
+     * Get an element from the dom
+     * @param {*} key key in elements object to fetch
+     */
+    get: function (key: string) {
+      return globalThis.document.querySelector(this[key.toLowerCase()]);
+    },
+
+    /**
+     * Get the icon of the current media
+     */
+    getSongIcon: function () {
+      const figure = this.get("media");
+
+      if (figure) {
+        const mediaElement = figure.querySelector(this["image"]);
+        if (mediaElement) {
+          return mediaElement.src.replace("80x80", "640x640");
+        }
+      }
+
+      return "";
+    },
+
+    /**
+     * returns an array of all artists in the current media
+     * @returns {Array} artists
+     */
+    getArtistsArray: function () {
+      const footer = this.get("footer");
+
+      if (footer) {
+        const artists = footer.querySelectorAll(this.artists);
+        if (artists)
+          return Array.from(artists).map((artist) => (artist as HTMLElement).textContent);
+      }
+      return [];
+    },
+
+    /**
+     * unify the artists array into a string separated by commas
+     * @param {Array} artistsArray
+     * @returns {String} artists
+     */
+    getArtistsString: function (artistsArray: string[]) {
+      if (artistsArray.length > 0) return artistsArray.join(", ");
+      return "unknown artist(s)";
+    },
+
+    getAlbumName: function () {
+      //If listening to an album, get its name from the header title
+      if (globalThis.location.href.includes("/album/")) {
+        const albumName = globalThis.document.querySelector(this.album_header_title);
+        if (albumName) {
+          return albumName.textContent;
+        }
+        //If listening to a playlist or a mix, get album name from the list
+      } else if (
+        globalThis.location.href.includes("/playlist/") ||
+        globalThis.location.href.includes("/mix/")
+      ) {
+        // TODO: fix
+        // if (currentPlayStatus === MediaStatus.playing) {
+        //   // find the currently playing element from the list (which might be in an album icon), traverse back up to the mediaItem (row) and select the album cell.
+        //   // document.querySelector("[class^='isPlayingIcon'], [data-test-is-playing='true']").closest('[data-type="mediaItem"]').querySelector('[class^="album"]').textContent
+        //   const row = window.document.querySelector(this.currentlyPlaying).closest(this.mediaItem);
+        //   if (row) {
+        //     return row.querySelector(this.album_name_cell).textContent;
+        //   }
+        // }
+      }
+
+      // see whether we're on the queue page and get it from there
+      const queueAlbumName = this.getText("queue_album");
+      if (queueAlbumName) {
+        return queueAlbumName;
+      }
+
+      return "";
+    },
+
+    isMuted: function () {
+      return this.get("volume").getAttribute("aria-checked") === "false"; // it's muted if aria-checked is false
+    },
+
+    isFavorite: function () {
+      return this.get("favorite").getAttribute("aria-checked") === "true";
+    },
+
+    /**
+     * Shorthand function to get the text of a dom element
+     * @param {*} key key in elements object to fetch
+     */
+    getText: function (key: string) {
+      const element = this.get(key);
+      return element ? element.textContent : "";
+    },
+
+    /**
+     * Shorthand function to click a dom element
+     * @param {*} key key in elements object to fetch
+     */
+    click: function (key: string) {
+      this.get(key).click();
+      return this;
+    },
+
+    /**
+     * Shorthand function to focus a dom element
+     * @param {*} key key in elements object to fetch
+     */
+    focus: function (key: string) {
+      return this.get(key).focus();
+    },
+  };
+
+  playPause = (): void => {
+    const play = this.elements.get("play");
+
+    if (play) {
+      this.elements.click("play");
+    } else {
+      this.elements.click("pause");
+    }
+  };
+
+  goToHome(): void {
+    this.elements.click("home");
+  }
+
+  hookup = (): void => {
+    throw new Error("Method not implemented.");
+  };
+}

src/TidalControllers/MediaSessionTidalController.ts

@@ -0,0 +1,19 @@
+import { DomTidalController } from "./DomTidalController";
+import { TidalController } from "./TidalController";
+
+export class MediaSessionTidalController implements TidalController {
+  public domMediaController: TidalController;
+
+  constructor() {
+    this.domMediaController = new DomTidalController();
+  }
+  goToHome(): void {
+    this.domMediaController.goToHome();
+  }
+  playPause(): void {
+    globalThis.alert("Method not implemented");
+  }
+  hookup(): void {
+    globalThis.alert("Method not implemented");
+  }
+}

src/TidalControllers/TidalController.ts

@@ -0,0 +1,13 @@
+export interface TidalController {
+  /**
+   * Play or pause the current media
+   */
+  playPause(): void;
+
+  /**
+   * Hook up the controller to the current web instance
+   */
+  hookup(): void;
+
+  goToHome(): void;
+}

src/features/api/swagger.json

@@ -21,9 +21,7 @@
     "/current": {
       "get": {
         "summary": "Get current media info",
-        "tags": [
+        "tags": ["current"],
-          "current"
-        ],
         "responses": {
           "200": {
             "description": "Current media info",
@@ -41,9 +39,7 @@
     "/current/image": {
       "get": {
         "summary": "Get current media image",
-        "tags": [
+        "tags": ["current"],
-          "current"
-        ],
         "responses": {
           "200": {
             "description": "Current media image",
@@ -65,9 +61,7 @@
     "/player/play": {
       "post": {
         "summary": "Play the current media",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -85,9 +79,7 @@
     "/player/favorite/toggle": {
       "post": {
         "summary": "Add the current media to your favorites, or remove it if its already added to your favorites",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -105,9 +97,7 @@
     "/player/pause": {
       "post": {
         "summary": "Pause the current media",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -125,9 +115,7 @@
     "/player/next": {
       "post": {
         "summary": "Play the next song",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -145,9 +133,7 @@
     "/player/previous": {
       "post": {
         "summary": "Play the previous song",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -165,9 +151,7 @@
     "/player/shuffle/toggle": {
       "post": {
         "summary": "Play the previous song",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -185,9 +169,7 @@
     "/player/repeat/toggle": {
       "post": {
         "summary": "Toggle the repeat status, toggles between \"off\" , \"single\" and \"all\"",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -205,9 +187,7 @@
     "/player/playpause": {
       "post": {
         "summary": "Start playing the media if paused, or pause the media if playing",
-        "tags": [
+        "tags": ["player"],
-          "player"
-        ],
         "responses": {
           "200": {
             "description": "Ok",
@@ -225,9 +205,7 @@
     "/settings/skipped-artists": {
       "get": {
         "summary": "get a list of artists that TIDAL Hi-Fi will skip if skipping is enabled",
-        "tags": [
+        "tags": ["settings"],
-          "settings"
-        ],
         "responses": {
           "200": {
             "description": "The list book.",
@@ -243,9 +221,7 @@
       },
       "post": {
         "summary": "Add new artists to the list of skipped artists",
-        "tags": [
+        "tags": ["settings"],
-          "settings"
-        ],
         "requestBody": {
           "required": true,
           "content": {
@@ -266,9 +242,7 @@
     "/settings/skipped-artists/delete": {
       "post": {
         "summary": "Remove artists from the list of skipped artists",
-        "tags": [
+        "tags": ["settings"],
-          "settings"
-        ],
         "requestBody": {
           "required": true,
           "content": {
@@ -289,9 +263,7 @@
     "/settings/skipped-artists/current": {
       "post": {
         "summary": "Add the current artist to the list of skipped artists",
-        "tags": [
+        "tags": ["settings"],
-          "settings"
-        ],
         "responses": {
           "200": {
             "description": "Ok"
@@ -300,9 +272,7 @@
       },
       "delete": {
         "summary": "Remove the current artist from the list of skipped artists",
-        "tags": [
+        "tags": ["settings"],
-          "settings"
-        ],
         "responses": {
           "200": {
             "description": "Ok"
@@ -313,9 +283,7 @@
     "/image": {
       "get": {
         "summary": "Get current image",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -338,9 +306,7 @@
     "/play": {
       "get": {
         "summary": "Play the current media",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -359,9 +325,7 @@
     "/favorite/toggle": {
       "get": {
         "summary": "Add the current media to your favorites, or remove it if its already added to your favorites",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -380,9 +344,7 @@
     "/pause": {
       "get": {
         "summary": "Pause the current media",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -401,9 +363,7 @@
     "/next": {
       "get": {
         "summary": "Play the next song",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -422,9 +382,7 @@
     "/previous": {
       "get": {
         "summary": "Play the previous song",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -443,9 +401,7 @@
     "/playpause": {
       "get": {
         "summary": "Toggle play/pause",
-        "tags": [
+        "tags": ["legacy"],
-          "legacy"
-        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -558,10 +514,7 @@
         "items": {
           "type": "string"
         },
-        "example": [
+        "example": ["Artist1", "Artist2"]
-          "Artist1",
-          "Artist2"
-        ]
       }
     }
   },
@@ -579,4 +532,4 @@
       "description": "The settings management API"
     }
   ]
-}
+}

src/preload.ts

@@ -21,6 +21,9 @@ import { addHotkey } from "./scripts/hotkeys";
 import { ObjectToDotNotation } from "./scripts/objectUtilities";
 import { settingsStore } from "./scripts/settings";
 import { setTitle } from "./scripts/window-functions";
+import { DomTidalController } from "./TidalControllers/DomTidalController";
+import { MediaSessionTidalController } from "./TidalControllers/MediaSessionTidalController";
+import { TidalController } from "./TidalControllers/TidalController";
 
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
 let currentSong = "";
@@ -35,6 +38,16 @@ let currentShuffleState = false;
 let currentMediaInfo: MediaInfo;
 let currentNotification: Electron.Notification;
 
+let tidalController: TidalController;
+
+// TODO: replace with setting
+// eslint-disable-next-line no-constant-condition
+if (true) {
+  tidalController = new DomTidalController();
+} else {
+  tidalController = new MediaSessionTidalController();
+}
+
 const elements = {
   play: '*[data-test="play"]',
   pause: '*[data-test="pause"]',
@@ -195,19 +208,6 @@ function getUpdateFrequency() {
   }
 }
 
-/**
- * Play or pause the current media
- */
-function playPause() {
-  const play = elements.get("play");
-
-  if (play) {
-    elements.click("play");
-  } else {
-    elements.click("pause");
-  }
-}
-
 /**
  * Clears the old listenbrainz data on launch
  */
@@ -235,7 +235,7 @@ function addHotKeys() {
     });
 
     addHotkey("Control+h", function () {
-      elements.click("home");
+      tidalController.goToHome();
     });
 
     addHotkey("backspace", function () {
@@ -319,7 +319,7 @@ function addIPCEventListeners() {
         case globalEvents.playPause:
         case globalEvents.play:
         case globalEvents.pause:
-          playPause();
+          tidalController.playPause();
           break;
         case globalEvents.next:
           elements.click("next");
@@ -455,7 +455,7 @@ function addMPRIS() {
           const eventValue = events[eventName];
           switch (events[eventValue]) {
             case events.playpause:
-              playPause();
+              tidalController.playPause();
               break;
             default:
               elements.click(eventValue);

src/scripts/discord.ts

@@ -26,7 +26,7 @@ const defaultPresence = {
   largeImageKey: "tidal-hifi-icon",
   largeImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
   instance: false,
-  type: ACTIVITY_LISTENING
+  type: ACTIVITY_LISTENING,
 };
 
 const updateActivity = () => {
@@ -118,15 +118,17 @@ const getActivity = (): SetActivity => {
 const connectWithRetry = async (retryCount = 0) => {
   try {
     await rpc.login();
-    Logger.log('Connected to Discord');
+    Logger.log("Connected to Discord");
     rpc.on("ready", updateActivity);
-    Object.values(globalEvents).forEach(event => ipcMain.on(event, observer));
+    Object.values(globalEvents).forEach((event) => ipcMain.on(event, observer));
   } catch (error) {
     if (retryCount < MAX_RETRIES) {
-      Logger.log(`Failed to connect to Discord, retrying in ${RETRY_DELAY/1000} seconds... (Attempt ${retryCount + 1}/${MAX_RETRIES})`);
+      Logger.log(
+        `Failed to connect to Discord, retrying in ${RETRY_DELAY / 1000} seconds... (Attempt ${retryCount + 1}/${MAX_RETRIES})`
+      );
       setTimeout(() => connectWithRetry(retryCount + 1), RETRY_DELAY);
     } else {
-      Logger.log('Failed to connect to Discord after maximum retry attempts');
+      Logger.log("Failed to connect to Discord after maximum retry attempts");
     }
   }
 };
@@ -135,7 +137,7 @@ const connectWithRetry = async (retryCount = 0) => {
  * Set up the discord rpc and listen on globalEvents.updateInfo
  */
 export const initRPC = () => {
-  rpc = new Client({ transport: {type: "ipc"}, clientId });
+  rpc = new Client({ transport: { type: "ipc" }, clientId });
   connectWithRetry();
 };