Merge branch 'master' of github.com:Mastermindzh/tidal-hifi into develop

.stylelintrc.json

@@ -1,13 +1,7 @@
 {
-  "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,

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`

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

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

src/pages/settings/settings.html

@@ -1,25 +1,34 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
-
+  <head>
-<head>
     <title>Tidal Hi-Fi settings</title>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta http-equiv="X-UA-Compatible" content="ie=edge" />
     <link rel="stylesheet" href="./settings.css" />
-  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
+    <link
-</head>
+      rel="stylesheet"
+      href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"
+    />
+  </head>
 
-<body class="settings-window">
+  <body class="settings-window">
     <div class="settings-window__wrapper">
       <div class="settings-window__drag-area"></div>
       <a id="close" class="settings-window__close-button" title="Close settings">
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 348.333 348.334" class="settings-window__svg-icon">
+        <svg
-        <path fill="white" d="M336.559,68.611L231.016,174.165l105.543,105.549c15.699,15.705,15.699,41.145,0,56.85
+          xmlns="http://www.w3.org/2000/svg"
+          viewBox="0 0 348.333 348.334"
+          class="settings-window__svg-icon"
+        >
+          <path
+            fill="white"
+            d="M336.559,68.611L231.016,174.165l105.543,105.549c15.699,15.705,15.699,41.145,0,56.85
             c-7.844,7.844-18.128,11.769-28.407,11.769c-10.296,0-20.581-3.919-28.419-11.769L174.167,231.003L68.609,336.563
             c-7.843,7.844-18.128,11.769-28.416,11.769c-10.285,0-20.563-3.919-28.413-11.769c-15.699-15.698-15.699-41.139,0-56.85
             l105.54-105.549L11.774,68.611c-15.699-15.699-15.699-41.145,0-56.844c15.696-15.687,41.127-15.687,56.829,0l105.563,105.554
-            L279.721,11.767c15.705-15.687,41.139-15.687,56.832,0C352.258,27.466,352.258,52.912,336.559,68.611z" />
+            L279.721,11.767c15.705-15.687,41.139-15.687,56.832,0C352.258,27.466,352.258,52.912,336.559,68.611z"
+          />
         </svg>
       </a>
 
@@ -66,7 +75,13 @@
                   <span class="switch__slider"></span>
                 </label>
               </div>
-            <textarea id="skippedArtists" class="textarea" cols="40" rows="5" spellcheck="false"></textarea>
+              <textarea
+                id="skippedArtists"
+                class="textarea"
+                cols="40"
+                rows="5"
+                spellcheck="false"
+              ></textarea>
               <div class="group__option">
                 <div class="group__description">
                   <h4>Block ads</h4>
@@ -109,7 +124,10 @@
               <div class="group__option">
                 <div class="group__description">
                   <h4>Static Window Title</h4>
-                <p>Makes the window title "TIDAL Hi-Fi" instead of changing to the currently playing song.</p>
+                  <p>
+                    Makes the window title "TIDAL Hi-Fi" instead of changing to the currently
+                    playing song.
+                  </p>
                 </div>
                 <label class="switch">
                   <input id="staticWindowTitle" type="checkbox" />
@@ -131,7 +149,9 @@
                   <h4>Hotkeys</h4>
                   <p>
                     Enable extra hotkeys to achieve feature parity with the
-                  <a class="external-link" data-url="https://defkey.com/tidal-desktop-shortcuts">desktop apps</a>.
+                    <a class="external-link" data-url="https://defkey.com/tidal-desktop-shortcuts"
+                      >desktop apps</a
+                    >.
                   </p>
                 </div>
                 <label class="switch">
@@ -157,8 +177,8 @@
               <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 media information.
+                  TIDAL Hi-Fi has a built-in web API to allow users to get current media
-                You can optionally enable playback control as well.
+                  information. You can optionally enable playback control as well.
                 </p>
               </div>
               <div class="group__option">
@@ -180,7 +200,8 @@
               <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 />
+                  <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>
@@ -236,7 +257,6 @@
                 </label>
               </div>
               <div id="discord_options">
-
                 <div class="group__option" class="hidden">
                   <div class="group__description">
                     <h4>Show Idle Text</h4>
@@ -252,15 +272,27 @@
                   <div class="group__description">
                     <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" />
+                    <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>
+                    <p>
-                  <input id="discord_using_text" type="text" class="text-input" name="discord_using_text" />
+                      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>
 
@@ -276,7 +308,6 @@
                 </div>
 
                 <div id="discord_show_song_options" class="hidden">
-
                   <div class="group__option" class="hidden">
                     <div class="group__description">
                       <h4>Include timestamps</h4>
@@ -292,7 +323,12 @@
                     <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" />
+                      <input
+                        id="discord_details_prefix"
+                        type="text"
+                        class="text-input"
+                        name="discord_details_prefix"
+                      />
                     </div>
                   </div>
 
@@ -300,11 +336,15 @@
                     <div class="group__description">
                       <h4>Button text</h4>
                       <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" />
+                      <input
+                        id="discord_button_text"
+                        type="text"
+                        class="text-input"
+                        name="discord_button_text"
+                      />
                     </div>
                   </div>
                 </div>
-
               </div>
             </div>
             <div class="group">
@@ -323,23 +363,43 @@
                 <div class="group__option">
                   <div class="group__description">
                     <h4>ListenBrainz API Url</h4>
-                  <p>There are multiple instances for ListenBrainz you can set the corresponding API url below.</p>
+                    <p>
-                  <input id="ListenBrainzAPI" type="text" class="text-input" name="ListenBrainzAPI" />
+                      There are multiple instances for ListenBrainz you can set the corresponding
+                      API url below.
+                    </p>
+                    <input
+                      id="ListenBrainzAPI"
+                      type="text"
+                      class="text-input"
+                      name="ListenBrainzAPI"
+                    />
                   </div>
                 </div>
                 <div class="group__option">
                   <div class="group__description">
                     <h4>ListenBrainz User Token</h4>
                     <p>Provide the user token you can get from the settings page.</p>
-                  <input id="ListenBrainzToken" type="text" class="text-input" name="ListenBrainzToken" />
+                    <input
+                      id="ListenBrainzToken"
+                      type="text"
+                      class="text-input"
+                      name="ListenBrainzToken"
+                    />
                   </div>
                 </div>
               </div>
               <div class="group__description">
                 <h4>ScrobbleDelay</h4>
-              <p>The delay (in ms) to send a listen to ListenBrainz. Prevents spamming the API when you fast forward
+                <p>
-                immediately</p>
+                  The delay (in ms) to send a listen to ListenBrainz. Prevents spamming the API when
-              <input id="listenbrainz_delay" type="number" class="text-input" name="listenbrainz_delay" />
+                  you fast forward immediately
+                </p>
+                <input
+                  id="listenbrainz_delay"
+                  type="number"
+                  class="text-input"
+                  name="listenbrainz_delay"
+                />
               </div>
             </div>
           </section>
@@ -351,12 +411,16 @@
                 <div class="group__description">
                   <h4>Update frequency</h4>
                   <p>
-                  The amount of time, in milliseconds, that TIDAL Hi-Fi will refresh its playback info by scraping the
+                    The amount of time, in milliseconds, that TIDAL Hi-Fi will refresh its playback
-                  website.
+                    info by scraping the website. The default of 500 seems to work in more cases but
-                  The default of 500 seems to work in more cases but if you are fine with a bit more resource usage you
+                    if you are fine with a bit more resource usage you can decrease it as well.
-                  can decrease it as well.
                   </p>
-                <input id="updateFrequency" type="number" class="text-input" name="updateFrequency" />
+                  <input
+                    id="updateFrequency"
+                    type="number"
+                    class="text-input"
+                    name="updateFrequency"
+                  />
                 </div>
               </div>
 
@@ -369,7 +433,9 @@
                   </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>
+                    <option value="https://listen.stage.tidal.com">
+                      Staging (listen.stage.tidal.com)
+                    </option>
                   </select>
                 </div>
               </div>
@@ -415,7 +481,8 @@
                 <div class="group__description">
                   <h4>Wayland support</h4>
                   <p>
-                  Adds a couple of Electron flags to help TIDAL Hi-Fi run smoothly on the Wayland window system.
+                    Adds a couple of Electron flags to help TIDAL Hi-Fi run smoothly on the Wayland
+                    window system.
                   </p>
                 </div>
                 <label class="switch">
@@ -433,12 +500,19 @@
                 <div class="group__description">
                   <h4>Custom CSS</h4>
                   <p>
-                  The css that you put in here will be injected into a style tag in the head of the document.
+                    The css that you put in here will be injected into a style tag in the head of
+                    the document.
                   </p>
                 </div>
               </div>
             </div>
-          <textarea id="customCSS" class="textarea" cols="40" rows="8" spellcheck="false"></textarea>
+            <textarea
+              id="customCSS"
+              class="textarea"
+              cols="40"
+              rows="8"
+              spellcheck="false"
+            ></textarea>
 
             <div class="group">
               <p class="group__title">Theme files</p>
@@ -448,9 +522,7 @@
                   <p>
                     Select a theme below or "Tidal - Default" to return to the original Tidal look.
                   </p>
-                <select class="select-input" id="themesList" name="themesList">
+                  <select class="select-input" id="themesList" name="themesList"></select>
-
-                </select>
                 </div>
               </div>
 
@@ -458,14 +530,20 @@
                 <div class="group__description">
                   <h4>Upload new themes</h4>
                   <p>
-                  Click the button and select the css files to import. They will be added to the theme list
+                    Click the button and select the css files to import. They will be added to the
-                  automatically.
+                    theme list automatically.
                   </p>
                   <div class="file-drop-area">
                     <div>
                       <span class="file-btn">Choose files</span>
                       <span id="file-message" class="file-msg">or drag and drop files here</span>
-                    <input id="theme-files" class="file-input" type="file" accept=".css" multiple>
+                      <input
+                        id="theme-files"
+                        class="file-input"
+                        type="file"
+                        accept=".css"
+                        multiple
+                      />
                     </div>
                   </div>
                 </div>
@@ -477,17 +555,35 @@
             <img alt="tidal icon" class="about-section__icon" src="./icon.png" />
             <h4>TIDAL Hi-Fi</h4>
             <div class="about-section__version">
-            <a target="_blank" rel="noopener"
+              <a
-              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.17.0">5.17.0</a>
+                target="_blank"
+                rel="noopener"
+                href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.17.0"
+                >5.17.0</a
+              >
             </div>
             <div class="about-section__links">
-            <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"
+              <a
-              class="about-section__button">Github
+                target="_blank"
-              <i class="fa fa-external-link"></i></a>
+                rel="noopener"
-            <a target="_blank" rel="noopener" href="https://github.com/Mastermindzh/tidal-hifi/issues"
+                href="https://github.com/mastermindzh/tidal-hifi/"
-              class="about-section__button">Report an issue <i class="fa fa-external-link"></i></a>
+                class="about-section__button"
-            <a target="_blank" rel="noopener" href="https://github.com/Mastermindzh/tidal-hifi/graphs/contributors"
+                >Github <i class="fa fa-external-link"></i
-              class="about-section__button">Contributors <i class="fa fa-external-link"></i></a>
+              ></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>
 
@@ -499,6 +595,5 @@
         </div>
       </main>
     </div>
-</body>
+  </body>
-
 </html>

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