Merge branch 'new-version' of github.com:Mastermindzh/tidal-hifi into api/add_cors

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

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

src/features/api/index.ts

@@ -1,9 +1,12 @@
 import { BrowserWindow, dialog } from "electron";
 import express from "express";
-import { settings } from "../../constants/settings";
+import swaggerjsdoc from "swagger-jsdoc";
+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 cors from "cors";
 
@@ -11,16 +14,49 @@ import cors from "cors";
  * Function to enable TIDAL Hi-Fi's express api
  */
 export const startApi = (mainWindow: BrowserWindow) => {
+  const port = settingsStore.get<string, number>(settings.apiSettings.port);
+  const specs = swaggerjsdoc({
+    definition: {
+      openapi: "3.1.0",
+      info: {
+        title: "TIDAL Hi-Fi API",
+        version: "5.13.0",
+        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",
+        },
+      },
+      servers: [
+        {
+          url: `http://localhost:${port}`,
+        },
+      ],
+      externalDocs: {
+        description: "swagger.json",
+        url: "swagger.json",
+      },
+    },
+    apis: ["**/*.ts"],
+  });
+
   const expressApp = express();
   expressApp.use(cors());
+  expressApp.use(express.json());
+  expressApp.use("/docs", swaggerUi.serve, swaggerUi.setup(specs));
   expressApp.get("/", (req, res) => res.send("Hello World!"));
+  expressApp.get("/swagger.json", (req, res) => res.json(specs));
 
   // add features
   addLegacyApi(expressApp, mainWindow);
   addPlaybackControl(expressApp, mainWindow);
   addCurrentInfo(expressApp);
+  addSettingsAPI(expressApp, mainWindow);
 
-  const port = settingsStore.get<string, number>(settings.apiSettings.port);
   const expressInstance = expressApp.listen(port, "127.0.0.1");
   expressInstance.on("error", function (e: { code: string }) {
     let message = e.code;

src/models/mediaInfo.ts

@@ -1,4 +1,5 @@
 import { MediaStatus } from "./mediaStatus";
+import { MediaPlayerInfo } from "./mediaPlayerInfo";
 
 export interface MediaInfo {
   title: string;
@@ -13,4 +14,5 @@ export interface MediaInfo {
   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/repeatState.ts

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

src/pages/settings/settings.html

@@ -433,7 +433,7 @@
           <h4>TIDAL Hi-Fi</h4>
           <div class="about-section__version">
             <a target="_blank" rel="noopener"
-              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.11.0">5.11.0</a>
+              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.13.0">5.13.0</a>
           </div>
           <div class="about-section__links">
             <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"

src/preload.ts

@@ -19,6 +19,7 @@ import { downloadFile } from "./scripts/download";
 import { addHotkey } from "./scripts/hotkeys";
 import { settingsStore } from "./scripts/settings";
 import { setTitle } from "./scripts/window-functions";
+import { RepeatState } from "./models/repeatState";
 
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
 const appName = "TIDAL Hi-Fi";
@@ -29,6 +30,8 @@ let currentListenBrainzDelayId: ReturnType<typeof setTimeout>;
 let scrobbleWaitingForDelay = false;
 
 let currentlyPlaying = MediaStatus.paused;
+let currentRepeatState: RepeatState = RepeatState.off;
+let currentShuffleState = false;
 let currentMediaInfo: Options;
 let currentNotification: Electron.Notification;
 
@@ -348,6 +351,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
@@ -511,14 +531,21 @@ setInterval(function () {
   const titleOrArtistsChanged = currentSong !== songDashArtistTitle;
   const current = elements.getText("current");
   const currentStatus = getCurrentlyPlayingStatus();
+  const shuffleState = getCurrentShuffleState();
+  const repeatState = getCurrentRepeatState();
 
   const playStateChanged = currentStatus != currentlyPlaying;
+  const shuffleStateChanged = shuffleState != currentShuffleState;
+  const repeatStateChanged = repeatState != currentRepeatState;
+
+  const hasStateChanged = playStateChanged || shuffleStateChanged || repeatStateChanged;
 
   // update info if song changed or was just paused/resumed
-  if (titleOrArtistsChanged || playStateChanged) {
-    if (playStateChanged) {
-      currentlyPlaying = currentStatus;
-    }
+  if (titleOrArtistsChanged || hasStateChanged) {
+    if (playStateChanged) currentlyPlaying = currentStatus;
+    if (shuffleStateChanged) currentShuffleState = shuffleState;
+    if (repeatStateChanged) currentRepeatState = repeatState;
+
     skipArtistsIfFoundInSkippedArtistsList(artistsArray);
 
     const album = elements.getAlbumName();
@@ -537,6 +564,12 @@ setInterval(function () {
       image: "",
       icon: "",
       favorite: elements.isFavorite(),
+
+      player: {
+        status: currentStatus,
+        shuffle: shuffleState,
+        repeat: repeatState,
+      },
     };
 
     // update title, url and play info with new info

src/scripts/mediaInfo.ts

@@ -1,5 +1,6 @@
 import { MediaInfo } from "../models/mediaInfo";
 import { MediaStatus } from "../models/mediaStatus";
+import { RepeatState } from "../models/repeatState";
 
 export const mediaInfo = {
   title: "",
@@ -14,6 +15,12 @@ export const mediaInfo = {
   durationInSeconds: 0,
   image: "tidal-hifi-icon",
   favorite: false,
+
+  player: {
+    status: MediaStatus.paused as string,
+    shuffle: false,
+    repeat: RepeatState.off as string,
+  },
 };
 
 export const updateMediaInfo = (arg: MediaInfo) => {
@@ -29,6 +36,12 @@ export const updateMediaInfo = (arg: MediaInfo) => {
   mediaInfo.durationInSeconds = arg.durationInSeconds ?? 0;
   mediaInfo.image = propOrDefault(arg.image);
   mediaInfo.favorite = arg.favorite;
+
+  mediaInfo.player = {
+    status: propOrDefault(arg.player?.status),
+    shuffle: arg.player?.shuffle ?? false,
+    repeat: propOrDefault(arg.player?.repeat),
+  };
 };
 
 /**

src/scripts/settings.ts

@@ -159,3 +159,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);
+};