feat: getLangugage route

Author: oleggtro

README.md

@@ -31,7 +31,7 @@ Completed features so far:
 - [x] Group - Update Name
 - [x] Introspect Data
 - [x] Key Press, Release
-- [ ] Language
+- [x] Language
 - [ ] Media Servers List
 - [ ] Music Library - Get Items
 - [ ] Music Library - Search

src/client.ts

@@ -1,6 +1,6 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
 import { XMLParser, XMLBuilder } from "fast-xml-parser";
-import { AudioDSPControls, AudioDSPMode, Bass, BassCapabilities, BluetoothInfo, Capabilities, ClockDisplay, ClockTime, ConfigurationStatus, DeviceInfo, DSPMonoStereo, Group, IntrospectRequest, Key, KeyPressResponse, KeyPressState, KeySender, RemoveGroup, SpotifyAccountIntrospectResponse } from "./types.js";
+import { AudioDSPControls, AudioDSPMode, Bass, BassCapabilities, BluetoothInfo, Capabilities, ClockDisplay, ClockTime, ConfigurationStatus, DeviceInfo, DSPMonoStereo, Group, IntrospectRequest, Key, KeyPressResponse, KeyPressState, KeySender, Language, RemoveGroup, SpotifyAccountIntrospectResponse } from "./types.js";
 
 export class SoundTouchApiClient {
   private client: AxiosInstance;
@@ -279,5 +279,12 @@ export class SoundTouchApiClient {
         return this.parseResponse<KeyPressResponse>(res as any);
     }
 
+    /**
+     * Gets the current Language of the device
+     * @returns Language
+     */
+    async getLanguage(): Promise<Language> {
+      return this.get<Language>("/language");
+    }
 
 }

src/types.ts

@@ -283,4 +283,9 @@ export enum KeySender {
 
 export interface KeyPressResponse {
   status: string;
+}
+
+export interface Language {
+  // i dont know what the numbers mean
+  sysLanguage: number;
 }

tests/language.test.ts

@@ -0,0 +1,34 @@
+import { describe, it, expect, beforeEach, afterEach } from "vitest";
+import nock from "nock";
+import { SoundTouchApiClient } from "../src/client.js";
+import { SoundTouchConfigurationStatus } from "../src/types.js";
+
+const mockXML = `<?xml version="1.0" encoding="UTF-8" ?>
+<sysLanguage>3</sysLanguage>`;
+
+describe("SoundTouchAPI /language endpoint", () => {
+  const baseURL = "http://localhost:8090";
+  let api: SoundTouchApiClient;
+
+  beforeEach(() => {
+    api = new SoundTouchApiClient(baseURL);
+    nock.cleanAll();
+  });
+
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+  it("parses /language response correctly", async () => {
+    nock(baseURL)
+      .get("/language")
+      .reply(200, mockXML, { "Content-Type": "application/xml" });
+
+    const language = await api.getLanguage();
+
+    expect(language).toMatchObject({
+        sysLanguage: 3,
+    });
+  });
+
+});