@soundretouch/api 1.0.0

package/dist/src/types/Enums.d.ts

@@ -0,0 +1,8 @@
+export type ArtStatus = 'INVALID' | 'SHOW_DEFAULT_IMAGE' | 'DOWNLOADING' | 'IMAGE_PRESENT';
+export type KeyValue = 'PLAY' | 'PAUSE' | 'STOP' | 'PREV_TRACK' | 'NEXT_TRACK' | 'THUMBS_UP' | 'THUMBS_DOWN' | 'BOOKMARK' | 'POWER' | 'MUTE' | 'VOLUME_UP' | 'VOLUME_DOWN' | 'PRESET_1' | 'PRESET_2' | 'PRESET_3' | 'PRESET_4' | 'PRESET_5' | 'PRESET_6' | 'AUX_INPUT' | 'SHUFFLE_OFF' | 'SHUFFLE_ON' | 'REPEAT_OFF' | 'REPEAT_ONE' | 'REPEAT_ALL' | 'PLAY_PAUSE' | 'ADD_FAVORITE' | 'REMOVE_FAVORITE' | 'INVALID_KEY';
+export type KeyState = 'press' | 'release';
+export type PlayStatus = 'PLAY_STATE' | 'PAUSE_STATE' | 'STOP_STATE' | 'BUFFERING_STATE' | 'INVALID_PLAY_STATUS';
+export type PresetId = 1 | 2 | 3 | 4 | 5 | 6;
+export type SourceStatus = 'UNAVAILABLE' | 'READY';
+export type AudioMode = 'AUDIO_MODE_DIRECT' | 'AUDIO_MODE_NORMAL' | 'AUDIO_MODE_DIALOG' | 'AUDIO_MODE_NIGHT';
+//# sourceMappingURL=Enums.d.ts.map

package/dist/src/types/Enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Enums.d.ts","sourceRoot":"","sources":["../../../src/types/Enums.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,oBAAoB,GAAG,aAAa,GAAG,eAAe,CAAA;AAE1F,MAAM,MAAM,QAAQ,GACd,MAAM,GACN,OAAO,GACP,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,aAAa,GACb,UAAU,GACV,OAAO,GACP,MAAM,GACN,WAAW,GACX,aAAa,GACb,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,WAAW,GACX,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,iBAAiB,GACjB,aAAa,CAAA;AAEnB,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAA;AAE1C,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,aAAa,GAAG,YAAY,GAAG,iBAAiB,GAAG,qBAAqB,CAAA;AAEhH,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAE5C,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,OAAO,CAAA;AAElD,MAAM,MAAM,SAAS,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,kBAAkB,CAAA"}

package/dist/src/types/Enums.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Enums.js.map

package/dist/src/types/Enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Enums.js","sourceRoot":"","sources":["../../../src/types/Enums.ts"],"names":[],"mappings":""}

package/dist/src/types/NowPlaying.d.ts

@@ -0,0 +1,25 @@
+import { ArtStatus, PlayStatus } from './Enums';
+export type NowPlayingContentItem = {
+    source?: string;
+    location?: string;
+    sourceAccount?: string;
+    isPresetable?: boolean;
+    itemName?: string;
+};
+export type NowPlaying = {
+    deviceID?: string;
+    source?: string;
+    ContentItem?: NowPlayingContentItem;
+    track?: string;
+    artist?: string;
+    album?: string;
+    stationName?: string;
+    art?: {
+        artImageStatus?: ArtStatus;
+        '#text'?: string;
+    };
+    playStatus?: PlayStatus;
+    description?: string;
+    stationLocation?: string;
+};
+//# sourceMappingURL=NowPlaying.d.ts.map

package/dist/src/types/NowPlaying.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NowPlaying.d.ts","sourceRoot":"","sources":["../../../src/types/NowPlaying.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAE/C,MAAM,MAAM,qBAAqB,GAAG;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,qBAAqB,CAAA;IACnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,GAAG,CAAC,EAAE;QACF,cAAc,CAAC,EAAE,SAAS,CAAA;QAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;IACD,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA"}

package/dist/src/types/NowPlaying.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=NowPlaying.js.map

package/dist/src/types/NowPlaying.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NowPlaying.js","sourceRoot":"","sources":["../../../src/types/NowPlaying.ts"],"names":[],"mappings":""}

package/dist/src/types/Presets.d.ts

@@ -0,0 +1,15 @@
+export type PresetContentItem = {
+    source?: string;
+    location?: string;
+    sourceAccount?: string;
+    isPresetable?: boolean;
+    itemName?: string;
+};
+export type Preset = {
+    id?: string;
+    createdOn?: string;
+    updateOn?: string;
+    ContentItem?: PresetContentItem;
+};
+export type Presets = Preset[];
+//# sourceMappingURL=Presets.d.ts.map

package/dist/src/types/Presets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Presets.d.ts","sourceRoot":"","sources":["../../../src/types/Presets.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,iBAAiB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,EAAE,CAAA"}

package/dist/src/types/Presets.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Presets.js.map

package/dist/src/types/Presets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Presets.js","sourceRoot":"","sources":["../../../src/types/Presets.ts"],"names":[],"mappings":""}

package/dist/src/types/Recents.d.ts

@@ -0,0 +1,14 @@
+export type RecentContentItem = {
+    source?: string;
+    location?: string;
+    sourceAccount?: string;
+    isPresetable?: boolean;
+    itemName?: string;
+};
+export type Recent = {
+    deviceID?: string;
+    utcTime?: string;
+    contentItem?: RecentContentItem;
+};
+export type Recents = Recent[];
+//# sourceMappingURL=Recents.d.ts.map

package/dist/src/types/Recents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Recents.d.ts","sourceRoot":"","sources":["../../../src/types/Recents.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,EAAE,CAAA"}

package/dist/src/types/Recents.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Recents.js.map

package/dist/src/types/Recents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Recents.js","sourceRoot":"","sources":["../../../src/types/Recents.ts"],"names":[],"mappings":""}

package/dist/src/types/Sources.d.ts

@@ -0,0 +1,12 @@
+import { SourceStatus } from './Enums';
+export type SourceItem = {
+    source?: string;
+    sourceAccount?: string;
+    status?: SourceStatus;
+    '#text'?: string;
+};
+export type Sources = {
+    deviceID?: string;
+    sourceItem?: SourceItem | SourceItem[];
+};
+//# sourceMappingURL=Sources.d.ts.map

package/dist/src/types/Sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sources.d.ts","sourceRoot":"","sources":["../../../src/types/Sources.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEtC,MAAM,MAAM,UAAU,GAAG;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAA;CACzC,CAAA"}

package/dist/src/types/Sources.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Sources.js.map

package/dist/src/types/Sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sources.js","sourceRoot":"","sources":["../../../src/types/Sources.ts"],"names":[],"mappings":""}

package/dist/src/types/Updates.d.ts

@@ -0,0 +1,37 @@
+import type { NowPlaying } from './NowPlaying';
+import type { Preset } from './Presets';
+import type { Recent } from './Recents';
+import type { Volume } from './Volume';
+export type Updates = {
+    deviceID?: string;
+    nowPlayingUpdated?: {
+        nowPlaying?: NowPlaying;
+    };
+    presetsUpdated?: {
+        presets?: {
+            preset?: Preset | Preset[];
+        };
+    };
+    acctModeUpdated?: Record<string, never>;
+    bassUpdated?: Record<string, never>;
+    errorNotification?: Record<string, unknown>;
+    nowSelectionUpdated?: {
+        preset?: Preset;
+    };
+    connectionStateUpdated?: Record<string, never>;
+    infoUpdated?: Record<string, never>;
+    siteSurveyResultsUpdated?: Record<string, never>;
+    sourcesUpdated?: Record<string, never>;
+    swUpdateStatusUpdated?: Record<string, never>;
+    zoneUpdated?: Record<string, never>;
+    recentsUpdated?: {
+        recents?: {
+            recent?: Recent | Recent[];
+        };
+    };
+    volumeUpdated?: {
+        volume?: Volume;
+    };
+    [key: string]: unknown;
+};
+//# sourceMappingURL=Updates.d.ts.map

package/dist/src/types/Updates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Updates.d.ts","sourceRoot":"","sources":["../../../src/types/Updates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,MAAM,MAAM,OAAO,GAAG;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iBAAiB,CAAC,EAAE;QAChB,UAAU,CAAC,EAAE,UAAU,CAAA;KAC1B,CAAA;IACD,cAAc,CAAC,EAAE;QACb,OAAO,CAAC,EAAE;YACN,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;SAC7B,CAAA;KACJ,CAAA;IACD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,mBAAmB,CAAC,EAAE;QAClB,MAAM,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACnC,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACtC,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACnC,cAAc,CAAC,EAAE;QACb,OAAO,CAAC,EAAE;YACN,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;SAC7B,CAAA;KACJ,CAAA;IACD,aAAa,CAAC,EAAE;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB,CAAA"}

package/dist/src/types/Updates.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Updates.js.map

package/dist/src/types/Updates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Updates.js","sourceRoot":"","sources":["../../../src/types/Updates.ts"],"names":[],"mappings":""}

package/dist/src/types/Volume.d.ts

@@ -0,0 +1,6 @@
+export type Volume = {
+    targetvolume?: number;
+    actualvolume?: number;
+    muteenabled?: boolean;
+};
+//# sourceMappingURL=Volume.d.ts.map

package/dist/src/types/Volume.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Volume.d.ts","sourceRoot":"","sources":["../../../src/types/Volume.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;CACxB,CAAA"}

package/dist/src/types/Volume.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Volume.js.map

package/dist/src/types/Volume.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Volume.js","sourceRoot":"","sources":["../../../src/types/Volume.ts"],"names":[],"mappings":""}

package/dist/src/types/Zone.d.ts

@@ -0,0 +1,22 @@
+export type ZoneMember = {
+    ipaddress?: string;
+    '#text'?: string;
+};
+export type Zone = {
+    master?: string;
+    member?: ZoneMember | ZoneMember[];
+};
+export type ZoneConfigMember = {
+    ipaddress: string;
+    macAddress: string;
+};
+export type ZoneConfig = {
+    master: string;
+    senderIPAddress: string;
+    members: ZoneConfigMember[];
+};
+export type ZoneSlaveConfig = {
+    master: string;
+    members: ZoneConfigMember[];
+};
+//# sourceMappingURL=Zone.d.ts.map

package/dist/src/types/Zone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Zone.d.ts","sourceRoot":"","sources":["../../../src/types/Zone.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC9B,CAAA"}

package/dist/src/types/Zone.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Zone.js.map

package/dist/src/types/Zone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Zone.js","sourceRoot":"","sources":["../../../src/types/Zone.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,86 @@
+{
+    "name": "@soundretouch/api",
+    "version": "1.0.0",
+    "description": "Unofficial TypeScript API wrapper for managing Bose SoundTouch devices.",
+    "keywords": [
+        "bose",
+        "soundtouch",
+        "soundtouch-api",
+        "speaker",
+        "audio",
+        "web-api",
+        "websocket",
+        "mdns",
+        "bonjour"
+    ],
+    "homepage": "https://github.com/RemcoS2000/soundretouch-api/",
+    "bugs": {
+        "url": "https://github.com/RemcoS2000/soundretouch-api/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/RemcoS2000/soundretouch-api.git"
+    },
+    "license": "MIT",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "docs",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.build.json",
+        "clean": "rimraf dist",
+        "format": "prettier --write .",
+        "lint": "eslint . --ext .ts",
+        "prepare": "husky",
+        "prepublishOnly": "npm run build",
+        "start": "tsx index.ts",
+        "test": "vitest"
+    },
+    "lint-staged": {
+        "*.{ts,tsx,js,jsx}": [
+            "eslint --fix",
+            "prettier --write"
+        ],
+        "*.{json,yml,yaml,md}": [
+            "prettier --write"
+        ]
+    },
+    "dependencies": {
+        "bonjour-service": "^1.2.1",
+        "debug": "^4.4.3",
+        "fast-xml-parser": "^5.3.3"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^20.3.1",
+        "@commitlint/config-conventional": "^20.3.1",
+        "@trivago/prettier-plugin-sort-imports": "^6.0.2",
+        "@types/debug": "^4.1.12",
+        "@types/node": "^25.0.6",
+        "@typescript-eslint/eslint-plugin": "^8.53.0",
+        "@typescript-eslint/parser": "^8.53.0",
+        "eslint": "^9.39.2",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-unused-imports": "^4.3.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^16.2.7",
+        "prettier": "^3.7.4",
+        "prettier-plugin-packagejson": "^2.5.21",
+        "rimraf": "^6.0.1",
+        "tsx": "^4.21.0",
+        "typescript": "5.9.3",
+        "typescript-eslint": "^8.53.0",
+        "vitest": "^4.0.17"
+    }
+}