steelseries-sonar-sdk 0.1.1

package/src/sonar/models/audio-settings/enums/chat-mix-state.ts

@@ -0,0 +1,6 @@
+export enum ChatMixState {
+	Enabled = 'enabled',
+	FiniteWheel = 'finiteWheel',
+	DifferentDeviceSelected = 'differentDeviceSelected',
+	NoDeviceSelected = 'noDeviceSelected'
+}

package/src/sonar/models/audio-settings/enums/device-data-flow.ts

@@ -0,0 +1,5 @@
+export enum DeviceDataFlow {
+	Render = 'render',
+	Capture = 'capture',
+	All = 'all'
+}

package/src/sonar/models/audio-settings/enums/device-default-roles.ts

@@ -0,0 +1,6 @@
+export enum DeviceDefaultRoles {
+	Console = 0,
+	Multimedia = 1,
+	Communications = 2,
+	All = Communications | Multimedia // 0x00000003
+}

package/src/sonar/models/audio-settings/enums/device-role.ts

@@ -0,0 +1,9 @@
+export enum DeviceRole {
+	None = 'none',
+	ChatRender = 'chatRender',
+	Game = 'game',
+	ChatCapture = 'chatCapture',
+	Stream = 'stream',
+	Media = 'media',
+	Aux = 'aux'
+}

package/src/sonar/models/audio-settings/enums/device-state.ts

@@ -0,0 +1,8 @@
+export enum DeviceState {
+	Active = 1,
+	Disabled = 2,
+	ActiveOrDisabled = 3,
+	Notpresent = 4,
+	Unplugged = 8,
+	All = 15 // 0x0000000F
+}

package/src/sonar/models/audio-settings/enums/sonar-channel.ts

@@ -0,0 +1,8 @@
+export enum SonarChannel {
+	Master = 'master',
+	ChatRender = 'chatRender',
+	Game = 'game',
+	ChatCapture = 'chatCapture',
+	Media = 'media',
+	Aux = 'aux'
+}

package/src/sonar/models/audio-settings/enums/streaming-path.ts

@@ -0,0 +1,4 @@
+export enum StreamingPath {
+	Streaming = 'streaming',
+	Monitoring = 'monitoring'
+}

package/src/sonar/models/audio-settings/volume-info-classic.ts

@@ -0,0 +1,4 @@
+export type VolumeInfoClassic = {
+	volume: number
+	muted: boolean
+}

package/src/sonar/models/audio-settings/volume-info-streamer.ts

@@ -0,0 +1,10 @@
+export type VolumeInfoStreamer = {
+	streaming: {
+		volume: number
+		muted: boolean
+	}
+	monitoring: {
+		volume: number
+		muted: boolean
+	}
+}

package/src/sonar/models/audio-settings/volume-settings-classic.ts

@@ -0,0 +1,13 @@
+import type { VolumeInfoClassic } from '@/sonar/models/audio-settings/volume-info-classic'
+
+export type VolumeSettingsClassic = {
+	masters: {
+		classic: VolumeInfoClassic
+	}
+	devices: Record<
+		string,
+		{
+			classic: VolumeInfoClassic
+		}
+	>
+}

package/src/sonar/models/audio-settings/volume-settings-streamer.ts

@@ -0,0 +1,13 @@
+import type { VolumeInfoStreamer } from '@/sonar/models/audio-settings/volume-info-streamer'
+
+export type VolumeSettingsStreamer = {
+	masters: {
+		stream: VolumeInfoStreamer
+	}
+	devices: Record<
+		string,
+		{
+			stream: VolumeInfoStreamer
+		}
+	>
+}

package/src/sonar/models/config/config.ts

@@ -0,0 +1,9 @@
+import type { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
+
+export type Config = {
+	id: string
+	name: string
+	isFavorite: boolean
+	virtualAudioDevice: VirtualAudioDevice
+	image?: string
+}

package/src/sonar/models/config/enums/VirtualAudioDevice.ts

@@ -0,0 +1,7 @@
+export enum VirtualAudioDevice {
+	Game = 'game',
+	ChatRender = 'chatRender',
+	ChatCapture = 'chatCapture',
+	Media = 'media',
+	Aux = 'aux'
+}

package/src/sonar/models/devices/audio-device.ts

@@ -0,0 +1,17 @@
+import type { DeviceDataFlow } from '@/sonar/models/audio-settings/enums/device-data-flow'
+import type { DeviceDefaultRoles } from '@/sonar/models/audio-settings/enums/device-default-roles'
+import type { DeviceRole } from '@/sonar/models/audio-settings/enums/device-role'
+import type { DeviceState } from '@/sonar/models/audio-settings/enums/device-state'
+
+export type AudioDevice = {
+	id: string
+	friendlyName: string
+	dataFlow: DeviceDataFlow
+	role: DeviceRole
+	channels: number
+	defaultRole: DeviceDefaultRoles
+	fwUpdateRequired: boolean
+	state: DeviceState
+	/** `true` if {@link DeviceRole} ≠ {@link DeviceRole.None} */
+	isVad: boolean
+}

package/src/sonar/models/devices/changed-device.ts

@@ -0,0 +1,7 @@
+import type { DeviceChannel } from '@/enums'
+
+export type ChangedDevice = {
+	id: Exclude<DeviceChannel, DeviceChannel.Output>
+	deviceId: string
+	isRunning: boolean
+}

package/src/sonar/requests/audio-devices/change-audio-device.ts

@@ -0,0 +1,37 @@
+import type { DeviceChannel } from '@/enums'
+import { SonarRequestException } from '@/exceptions'
+import type { ChangedDevice } from '@/sonar/models/devices/changed-device'
+
+export async function changeAudioDevice(
+	sonarEndpoint: string,
+	deviceChannel: DeviceChannel,
+	deviceId: string
+): Promise<ChangedDevice[]> {
+	let response: Response
+	const url = new URL(`${sonarEndpoint}/classicRedirections/${deviceChannel}/deviceId/${deviceId}`)
+
+	try {
+		response = await fetch(url, { method: 'PUT' })
+	} catch (error) {
+		throw new SonarRequestException({
+			innerException: error as Error
+		})
+	}
+
+	if (!response.ok) {
+		const error = await response.text()
+		throw new SonarRequestException({ message: `Failed to get audio devices: ${error}` })
+	}
+
+	const unknownData = (await response.json()) as ChangedDevice[] | ChangedDevice
+
+	const data = Array.isArray(unknownData) ? unknownData : [unknownData]
+
+	const devices = data.filter((x) => x?.deviceId === deviceId)
+
+	if (devices.length === 0) {
+		throw new SonarRequestException({ message: 'The changed audio devices list is empty.' })
+	}
+
+	return devices
+}

package/src/sonar/requests/audio-devices/request-audio-devices.ts

@@ -0,0 +1,42 @@
+import { SonarRequestException } from '@/exceptions'
+import type { DeviceDataFlow } from '@/sonar/models/audio-settings/enums/device-data-flow'
+import type { AudioDevice as SonarAudioDevice } from '@/sonar/models/devices/audio-device'
+
+type Params = {
+	deviceDataFlow?: DeviceDataFlow
+	onlySteelSeriesVAD?: boolean
+	removeSteelSeriesVAD?: boolean
+}
+
+export async function requestAudioDevices(sonarEndpoint: string, params: Params): Promise<SonarAudioDevice[]> {
+	const { deviceDataFlow, onlySteelSeriesVAD = false, removeSteelSeriesVAD = false } = params
+
+	const url = new URL(`${sonarEndpoint}/audioDevices`)
+	url.searchParams.append('onlySteelSeriesVAD', String(onlySteelSeriesVAD))
+	url.searchParams.append('removeSteelSeriesVAD', String(removeSteelSeriesVAD))
+	if (deviceDataFlow !== undefined) {
+		url.searchParams.append('deviceDataFlow', deviceDataFlow.toString())
+	}
+
+	let response: Response
+	try {
+		response = await fetch(url)
+	} catch (error) {
+		throw new SonarRequestException({
+			innerException: error as Error
+		})
+	}
+
+	if (!response.ok) {
+		const error = await response.text()
+		throw new SonarRequestException({ message: `Failed to get audio devices: ${error}` })
+	}
+
+	const data = (await response.json()) as SonarAudioDevice[]
+
+	if (!Array.isArray(data)) {
+		throw new SonarRequestException({ message: 'Invalid audio devices response format.' })
+	}
+
+	return data
+}

package/src/sonar/requests/chatmix/change-chat-mix-balance.ts

@@ -0,0 +1,25 @@
+import { SonarRequestException } from '@/exceptions'
+import type { ChatMixData } from '@/sonar/models/audio-settings/chatmix-data'
+
+export async function changeChatMixBalance(sonarEndpoint: string, chatBalance: number) {
+	const url = new URL(`${sonarEndpoint}/chatMix?balance=${chatBalance}`)
+	let response: Response
+	try {
+		response = await fetch(url, {
+			method: 'PUT'
+		})
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+
+	if (response.ok) {
+		const data = (await response.json()) as ChatMixData
+		if (data?.balance == null || data?.state == null) {
+			throw new SonarRequestException({ message: 'Missing required data in response' })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { Message?: string }
+		throw new SonarRequestException({ message: data.Message })
+	}
+}

package/src/sonar/requests/chatmix/request-chat-mix-state.ts

@@ -0,0 +1,24 @@
+import { SonarRequestException } from '@/exceptions'
+import type { ChatMixData } from '@/sonar/models/audio-settings/chatmix-data'
+
+export async function requestChatMixState(sonarEndpoint: string): Promise<ChatMixData> {
+	const url = new URL(`${sonarEndpoint}/chatMix`)
+	let response: Response
+
+	try {
+		response = await fetch(url)
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+
+	if (response.ok) {
+		const data = (await response.json()) as ChatMixData
+		if (data?.balance == null || data?.state == null) {
+			throw new SonarRequestException({ message: 'Missing required data in response' })
+		}
+		return data
+	} else {
+		const data = await response.text()
+		throw new SonarRequestException({ innerException: new Error(data) })
+	}
+}

package/src/sonar/requests/mode/change-audio-mode.ts

@@ -0,0 +1,24 @@
+import { SonarRequestException } from '@/exceptions'
+import type { AudioMode } from '@/sonar/models/audio-settings/enums/audio-mode'
+
+export async function changeAudioMode(sonarEndpoint: string, audioMode: AudioMode): Promise<AudioMode> {
+	let response: Response
+	const url = new URL(`${sonarEndpoint}/mode/${audioMode}`)
+	try {
+		response = await fetch(url, {
+			method: 'PUT'
+		})
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = await response.json()
+		if (data !== audioMode) {
+			throw new SonarRequestException({ message: 'Returned audio mode does not match requested mode' })
+		}
+		return data as AudioMode
+	} else {
+		const data = await response.text()
+		throw new SonarRequestException({ innerException: new Error(data) })
+	}
+}

package/src/sonar/requests/mode/request-audio-mode.ts

@@ -0,0 +1,24 @@
+import { SonarRequestException } from '@/exceptions'
+import { AudioMode } from '@/sonar/models/audio-settings/enums/audio-mode'
+
+export async function requestAudioMode(sonarEndpoint: string): Promise<AudioMode> {
+	let response: Response
+	const url = new URL(`${sonarEndpoint}/mode`)
+
+	try {
+		response = await fetch(url)
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+
+	if (response.ok) {
+		const data = (await response.json()) as AudioMode
+		if (Object.values(AudioMode).includes(data)) {
+			return data
+		}
+		throw new SonarRequestException({ message: 'Received unhandled audio mode from Sonar server' })
+	} else {
+		const data = await response.text()
+		throw new SonarRequestException({ innerException: new Error(data) })
+	}
+}

package/src/sonar/requests/profiles/change-selected-config.ts

@@ -0,0 +1,25 @@
+import { SonarRequestException } from '@/exceptions'
+import type { Config } from '@/sonar/models/config/config'
+
+export async function changeSelectedConfig(sonarAddress: string, configId: string): Promise<Config> {
+	let response: Response
+
+	try {
+		response = await fetch(`${sonarAddress}/configs/${configId}/select`, {
+			method: 'PUT'
+		})
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+
+	if (response.ok) {
+		const data = (await response.json()) as Config
+		if (!data?.id) {
+			throw new SonarRequestException({ message: 'Missing required data in response' })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/profiles/request-configs.ts

@@ -0,0 +1,24 @@
+import { SonarRequestException } from '@/exceptions'
+import type { Config } from '@/sonar/models/config/config'
+import type { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
+
+export async function requestConfigs(sonarAddress: string, channel: VirtualAudioDevice): Promise<Config[]> {
+	let response: Response
+
+	try {
+		response = await fetch(`${sonarAddress}/configs?vad=${channel}`)
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+
+	if (response.ok) {
+		const data = (await response.json()) as Config[]
+		if (!Array.isArray(data)) {
+			throw new SonarRequestException({ message: 'Missing required data in response' })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/profiles/request-selected-configs.ts

@@ -0,0 +1,22 @@
+import { SonarRequestException } from '@/exceptions'
+import type { Config } from '@/sonar/models/config/config'
+export async function requestSelectedConfigs(sonarAddress: string): Promise<Config[]> {
+	let response: Response
+
+	try {
+		response = await fetch(`${sonarAddress}/configs/selected`)
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+
+	if (response.ok) {
+		const data = (await response.json()) as Config[]
+		if (!Array.isArray(data)) {
+			throw new SonarRequestException({ message: 'Missing required data in response' })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/volume-settings/change-volume-level-classic.ts

@@ -0,0 +1,27 @@
+import { SonarRequestException } from '@/exceptions'
+import type { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel'
+import type { VolumeSettingsClassic } from '@/sonar/models/audio-settings/volume-settings-classic'
+
+export async function changeVolumeLevelClassic(
+	sonarEndpoint: string,
+	volume: number,
+	deviceRole: SonarChannel
+): Promise<VolumeSettingsClassic> {
+	let response: Response
+	try {
+		const url = new URL(`${sonarEndpoint}/volumeSettings/classic/${deviceRole}/volume/${volume}`)
+		response = await fetch(url, { method: 'PUT' })
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = (await response.json()) as VolumeSettingsClassic
+		if (data?.masters?.classic == null) {
+			throw new SonarRequestException({ innerException: new Error('Missing required data in response.') })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/volume-settings/change-volume-level-streamer.ts

@@ -0,0 +1,29 @@
+import { SonarRequestException } from '@/exceptions'
+import type { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel'
+import type { StreamingPath } from '@/sonar/models/audio-settings/enums/streaming-path'
+import type { VolumeSettingsStreamer } from '@/sonar/models/audio-settings/volume-settings-streamer'
+
+export async function changeVolumeLevelStreamer(
+	sonarEndpoint: string,
+	volume: number,
+	channel: SonarChannel,
+	path: StreamingPath
+): Promise<VolumeSettingsStreamer> {
+	let response: Response
+	try {
+		const url = new URL(`${sonarEndpoint}/volumeSettings/streamer/${path}/${channel}/volume/${volume}`)
+		response = await fetch(url, { method: 'PUT' })
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = (await response.json()) as VolumeSettingsStreamer
+		if (data?.masters?.stream == null) {
+			throw new SonarRequestException({ innerException: new Error('Missing required data in response.') })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/volume-settings/change-volume-mute-classic.ts

@@ -0,0 +1,27 @@
+import { SonarRequestException } from '@/exceptions'
+import type { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel'
+import type { VolumeSettingsClassic } from '@/sonar/models/audio-settings/volume-settings-classic'
+
+export async function changeVolumeMuteClassic(
+	sonarEndpoint: string,
+	isMuted: boolean,
+	deviceRole: SonarChannel
+): Promise<VolumeSettingsClassic> {
+	let response: Response
+	try {
+		const url = new URL(`${sonarEndpoint}/volumeSettings/classic/${deviceRole}/mute/${isMuted}`)
+		response = await fetch(url, { method: 'PUT' })
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = (await response.json()) as VolumeSettingsClassic
+		if (data?.masters?.classic == null) {
+			throw new SonarRequestException({ innerException: new Error('Missing required data in response.') })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/volume-settings/change-volume-mute-streamer.ts

@@ -0,0 +1,29 @@
+import { SonarRequestException } from '@/exceptions'
+import type { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel'
+import type { StreamingPath } from '@/sonar/models/audio-settings/enums/streaming-path'
+import type { VolumeSettingsStreamer } from '@/sonar/models/audio-settings/volume-settings-streamer'
+
+export async function changeVolumeMuteStreamer(
+	sonarEndpoint: string,
+	isMuted: boolean,
+	deviceRole: SonarChannel,
+	path: StreamingPath
+): Promise<VolumeSettingsStreamer> {
+	let response: Response
+	try {
+		const url = new URL(`${sonarEndpoint}/volumeSettings/streamer/${path}/${deviceRole}/isMuted/${isMuted}`)
+		response = await fetch(url, { method: 'PUT' })
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = (await response.json()) as VolumeSettingsStreamer
+		if (data?.masters?.stream == null) {
+			throw new SonarRequestException({ innerException: new Error('Missing required data in response.') })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/volume-settings/request-volume-settings-classic.ts

@@ -0,0 +1,22 @@
+import { SonarRequestException } from '@/exceptions'
+import type { VolumeSettingsClassic } from '@/sonar/models/audio-settings/volume-settings-classic'
+
+export async function requestVolumeSettingsClassic(sonarEndpoint: string): Promise<VolumeSettingsClassic> {
+	let response: Response
+	try {
+		const url = new URL(`${sonarEndpoint}/volumeSettings/classic`)
+		response = await fetch(url)
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = (await response.json()) as VolumeSettingsClassic
+		if (data?.masters?.classic == null) {
+			throw new SonarRequestException({ innerException: new Error('Missing required data in response.') })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/sonar/requests/volume-settings/request-volume-settings-streamer.ts

@@ -0,0 +1,22 @@
+import { SonarRequestException } from '@/exceptions'
+import type { VolumeSettingsStreamer } from '@/sonar/models/audio-settings/volume-settings-streamer'
+
+export async function requestVolumeSettingsStreamer(sonarEndpoint: string): Promise<VolumeSettingsStreamer> {
+	let response: Response
+	try {
+		const url = new URL(`${sonarEndpoint}/volumeSettings/streamer`)
+		response = await fetch(url)
+	} catch (error) {
+		throw new SonarRequestException({ innerException: error as Error })
+	}
+	if (response.ok) {
+		const data = (await response.json()) as VolumeSettingsStreamer
+		if (data?.masters?.stream == null) {
+			throw new SonarRequestException({ innerException: new Error('Missing required data in response.') })
+		}
+		return data
+	} else {
+		const data = (await response.json()) as { error: string }
+		throw new SonarRequestException({ innerException: new Error(data?.error ?? data) })
+	}
+}

package/src/types/audio-device.ts

@@ -0,0 +1,7 @@
+import type { DeviceFlow } from '@/enums'
+
+export type AudioDevice = {
+	id: string
+	name: string
+	type: DeviceFlow
+}

package/src/types/changed-device.ts

@@ -0,0 +1,7 @@
+import type { DeviceChannel } from '@/enums'
+
+export type ChangedDevice = {
+	deviceId: string
+	deviceChannel: Exclude<DeviceChannel, DeviceChannel.Output>
+	isRunning: boolean
+}

package/src/types/channel-volume-classic.ts

@@ -0,0 +1,4 @@
+export type ChannelVolumeClassic = {
+	volume: number
+	isMuted: boolean
+}

package/src/types/channel-volume-streamer-path.ts

@@ -0,0 +1,4 @@
+export type ChannelVolumeStreamerPath = {
+	volume: number
+	isMuted: boolean
+}

package/src/types/channel-volume-streamer.ts

@@ -0,0 +1,6 @@
+import type { StreamerPath } from '@/enums'
+import type { ChannelVolumeStreamerPath } from '@/types/channel-volume-streamer-path'
+
+export type ChannelVolumeStreamer = {
+	[K in StreamerPath]: ChannelVolumeStreamerPath
+}

package/src/types/channel-volumes-classic.ts

@@ -0,0 +1,8 @@
+import type { AudioChannel } from '@/enums'
+import type { ChannelVolumeClassic } from '@/types/channel-volume-classic'
+
+export type ChannelVolumesClassic = {
+	[AudioChannel.Master]: ChannelVolumeClassic
+} & {
+	[K in Exclude<AudioChannel, 'master'>]?: ChannelVolumeClassic
+}

package/src/types/channel-volumes-streamer.ts

@@ -0,0 +1,8 @@
+import type { AudioChannel } from '@/enums'
+import type { ChannelVolumeStreamer } from '@/types/channel-volume-streamer'
+
+export type ChannelVolumesStreamer = {
+	[AudioChannel.Master]: ChannelVolumeStreamer
+} & {
+	[K in AudioChannel]?: ChannelVolumeStreamer
+}

package/src/types/chat-mix-data.ts

@@ -0,0 +1,7 @@
+import type { ChatMixState } from '@/enums'
+
+export type ChatMixData = {
+	chatBalance: number
+	state: ChatMixState
+	isEnabled: boolean
+}

package/src/types/profile-option.ts

@@ -0,0 +1,9 @@
+import type { ProfileChannel } from '@/enums'
+
+export type ProfileOption = {
+	id: string
+	name: string
+	isFavorite: boolean
+	channel: ProfileChannel
+	image?: string
+}