feat: send keypresses

Author: oleggtro

README.md

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

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, RemoveGroup, SpotifyAccountIntrospectResponse } from "./types.js";
+import { AudioDSPControls, AudioDSPMode, Bass, BassCapabilities, BluetoothInfo, Capabilities, ClockDisplay, ClockTime, ConfigurationStatus, DeviceInfo, DSPMonoStereo, Group, IntrospectRequest, Key, KeyPressResponse, KeyPressState, KeySender, RemoveGroup, SpotifyAccountIntrospectResponse } from "./types.js";
 
 export class SoundTouchApiClient {
   private client: AxiosInstance;
@@ -264,4 +264,20 @@ export class SoundTouchApiClient {
 
         return this.parseResponse<SpotifyAccountIntrospectResponse>(res as any);
     }
+
+    /** 
+     * Get Introspect Data for the current Playback
+     * @todo validate other Introspect responses
+     * @returns void
+     */
+    async sendKeyPress(key: Key, state: KeyPressState, sender: KeySender): Promise<KeyPressResponse> {
+        const xml = `<key state="${state}" sender="${sender}">${key}</key>`;
+        const res = await this.client.post(this.baseURL + "/key", xml, {
+          headers: { "Content-Type": "application/xml" },
+        });
+
+        return this.parseResponse<KeyPressResponse>(res as any);
+    }
+
+
 }

src/types.ts

@@ -234,4 +234,53 @@ export enum IntrospectSource {
   Spotify = "SPOTIFY",
   Pandora = "PANDORA",
   STORED_MUSIC = "STORED_MUSIC",
+}
+
+export enum Key {
+  AddFavorite = "ADD_FAVORITE",
+  AuxInput = "AUX_INPUT",
+  Bookmark = "BOOKMARK",
+  Mute = "MUTE",
+  NextTrack = "NEXT_TRACK",
+  Pause = "PAUSE",
+  Play = "PLAY",
+  PlayPause = "PLAY_PAUSE",
+  Power = "POWER",
+  Preset1 = "PRESET_1",
+  Preset2 = "PRESET_2",
+  Preset3 = "PRESET_3",
+  Preset4 = "PRESET_4",
+  Preset5 = "PRESET_5",
+  Preset6 = "PRESET_6",
+  PreviousTrack = "PREV_TRACK",
+  RemoveFavorite = "REMOVE_FAVORITE",
+  RepeatAll = "REPEAT_ALL",
+  RepeatOff = "REPEAT_OFF",
+  RepeatOne = "REPEAT_ONE",
+  ShuffleOff = "SHUFFLE_OFF",
+  ShuffleOn = "SHUFFLE_ON",
+  Stop = "STOP",
+  ThumbsDown = "THUMBS_DOWN",
+  ThumbsUp = "THUMBS_UP",
+  VolumeDown = "VOLUME_DOWN",
+  VolumeUp = "VOLUME_UP",
+}
+
+export enum KeyPressState {
+  Press = "press",
+  Release = "release",
+  Repeat = "repeat",
+}
+
+export enum KeySender {
+  Gabbo = "Gabbo",
+  IrRemote = "IrRemote",
+  Console = "Console",
+  LightswitchRemote = "LightswitchRemote",
+  BoselinkRemote = "BoselinkRemote",
+  Etap = "Etap",
+}
+
+export interface KeyPressResponse {
+  status: string;
 }

tests/key.test.ts

@@ -0,0 +1,42 @@
+import { describe, it, expect, beforeEach, afterEach } from "vitest";
+import nock from "nock";
+import { SoundTouchApiClient } from "../src/client.js";
+import { IntrospectRequest, IntrospectSource, IntrospectState, Key, KeyPressState, KeySender } from "../src/types.js";
+import { mock } from "node:test";
+
+const mockXML_response = `<?xml version="1.0" encoding="UTF-8" ?>
+<status>/key</status>`;
+
+describe("SoundTouchAPI /key endpoint", () => {
+  const baseURL = "http://localhost:8090";
+  let api: SoundTouchApiClient;
+
+  beforeEach(() => {
+    api = new SoundTouchApiClient(baseURL);
+    nock.cleanAll();
+  });
+
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+   it("parses /key response correctly", async () => {
+
+    const expected_request = `<key state="press" sender="Gabbo">POWER</key>`;
+
+
+    nock(baseURL)
+      .post("/key", expected_request)
+      .matchHeader("Content-Type", "application/xml")
+      .reply(200, mockXML_response, { "Content-Type": "application/xml" });
+
+
+    const keySendResponse = await api.sendKeyPress(Key.Power, KeyPressState.Press, KeySender.Gabbo);
+    // Ensure the mocked endpoint was called
+    expect(nock.isDone()).toBe(true);
+
+    expect(keySendResponse).toMatchObject({
+        status: "/key",
+    });
+    }); 
+});