steelseries-sonar-sdk 0.2.0 → 0.2.2

package/src/functions/chatmix/get-chat-mix-state.ts

@@ -1,20 +0,0 @@
-import { ChatMixState } from '@/enums'
-import { convertChatMixBalanceToUser } from '@/functions/converters/convert-chat-mix-balance-to-user'
-import { requestChatMixState } from '@/sonar/requests/chatmix/request-chat-mix-state'
-import type { ChatMixData } from '@/types/chat-mix-data'
-
-/**
- * Gets CHATMIX state and data.
- * @param sonarEndpoint Sonar endpoint URL
- * @returns balance as 0 - 100,
- */
-export async function getChatMixState(sonarEndpoint: string): Promise<ChatMixData> {
-	const data = await requestChatMixState(sonarEndpoint)
-
-	const chatMixData: ChatMixData = {
-		chatBalance: convertChatMixBalanceToUser(data.balance),
-		state: data.state,
-		isEnabled: data.state === ChatMixState.Enabled
-	}
-	return chatMixData
-}

package/src/functions/chatmix/set-chat-mix-balance.ts

@@ -1,22 +0,0 @@
-import { ChatMixState } from '@/enums'
-import { convertChatMixBalanceToApi } from '@/functions/converters/convert-chat-mix-balance-to-api'
-import { convertChatMixBalanceToUser } from '@/functions/converters/convert-chat-mix-balance-to-user'
-import { changeChatMixBalance } from '@/sonar/requests/chatmix/change-chat-mix-balance'
-import type { ChatMixData } from '@/types/chat-mix-data'
-
-/**
- * Set CHATMIX balance between audio(0%) and chat(100%).
- * @param sonarEndpoint Sonar endpoint URL
- * @param chatBalance Balance as 0 - 100,
- */
-export async function setChatMixBalance(sonarEndpoint: string, chatBalance: number): Promise<ChatMixData> {
-	const balance = convertChatMixBalanceToApi(chatBalance)
-	const data = await changeChatMixBalance(sonarEndpoint, balance)
-
-	const chatMixData: ChatMixData = {
-		chatBalance: convertChatMixBalanceToUser(data.balance),
-		state: data.state,
-		isEnabled: data.state === ChatMixState.Enabled
-	}
-	return chatMixData
-}

package/src/functions/converters/convert-channel-to-api.ts

@@ -1,19 +0,0 @@
-import { AudioChannel } from '@/enums'
-import { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel'
-
-export function convertChannelToApi(channel: AudioChannel): SonarChannel {
-	switch (channel) {
-		case AudioChannel.Master:
-			return SonarChannel.Master
-		case AudioChannel.Game:
-			return SonarChannel.ChatRender
-		case AudioChannel.Media:
-			return SonarChannel.Media
-		case AudioChannel.Aux:
-			return SonarChannel.Aux
-		case AudioChannel.Mic:
-			return SonarChannel.ChatCapture
-		default:
-			throw new Error(`Unsupported AudioChannel: ${channel}`)
-	}
-}

package/src/functions/converters/convert-chat-mix-balance-to-api.ts

@@ -1,6 +0,0 @@
-/** convert [0 to 100] to [-1 to 1] */
-export function convertChatMixBalanceToApi(balance: number): number {
-	let result = (balance / 100) * 2 - 1
-	result = Math.min(Math.max(result, -1), 1)
-	return result
-}

package/src/functions/converters/convert-chat-mix-balance-to-user.ts

@@ -1,7 +0,0 @@
-/** convert [-1 to 1] to [0 to 100] */
-export function convertChatMixBalanceToUser(balance: number): number {
-	let result = ((balance + 1) / 2) * 100
-	result = Math.floor(result)
-	result = Math.min(Math.max(result, 0), 100)
-	return result
-}

package/src/functions/converters/convert-profile-channel-to-api.ts

@@ -1,19 +0,0 @@
-import { ProfileChannel } from '@/enums'
-import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
-
-export function convertProfileChannelToApi(channel: ProfileChannel): VirtualAudioDevice {
-	switch (channel) {
-		case ProfileChannel.Game:
-			return VirtualAudioDevice.Game
-		case ProfileChannel.Chat:
-			return VirtualAudioDevice.ChatRender
-		case ProfileChannel.Media:
-			return VirtualAudioDevice.Media
-		case ProfileChannel.Aux:
-			return VirtualAudioDevice.Aux
-		case ProfileChannel.Mic:
-			return VirtualAudioDevice.ChatCapture
-		default:
-			throw new Error(`Unsupported ProfileChannel: ${channel}`)
-	}
-}

package/src/functions/converters/convert-profile-channel-to-user.ts

@@ -1,19 +0,0 @@
-import { ProfileChannel } from '@/enums'
-import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
-
-export function convertProfileChannelToUser(channel: VirtualAudioDevice): ProfileChannel {
-	switch (channel) {
-		case VirtualAudioDevice.Game:
-			return ProfileChannel.Game
-		case VirtualAudioDevice.ChatRender:
-			return ProfileChannel.Chat
-		case VirtualAudioDevice.Media:
-			return ProfileChannel.Media
-		case VirtualAudioDevice.Aux:
-			return ProfileChannel.Aux
-		case VirtualAudioDevice.ChatCapture:
-			return ProfileChannel.Mic
-		default:
-			throw new Error(`Unsupported ProfileChannel: ${channel}`)
-	}
-}

package/src/functions/converters/convert-volume-to-api.ts

@@ -1,5 +0,0 @@
-export function convertVolumeToApi(value: number): number {
-	let result = value / 100
-	result = Math.min(Math.max(result, 0), 1)
-	return result
-}

package/src/functions/converters/convert-volume-to-user.ts

@@ -1,6 +0,0 @@
-export function convertVolumeToUser(value: number): number {
-	let result = value * 100
-	result = Math.min(Math.max(result, 0), 100)
-	result = Math.floor(result)
-	return result
-}

package/src/functions/devices/get-audio-devices.ts

@@ -1,40 +0,0 @@
-import { DeviceFlow } from '@/enums'
-import { SonarRequestException } from '@/exceptions'
-import { DeviceDataFlow } from '@/sonar/models/audio-settings/enums/device-data-flow'
-import { requestAudioDevices } from '@/sonar/requests/audio-devices/request-audio-devices'
-import type { AudioDevice } from '@/types/audio-device'
-
-export async function getAudioDevices(sonarEndpoint: string, deviceType?: DeviceFlow): Promise<AudioDevice[]> {
-	let deviceDataFlow: DeviceDataFlow
-	switch (deviceType) {
-		case DeviceFlow.Input:
-			deviceDataFlow = DeviceDataFlow.Capture
-			break
-		case DeviceFlow.Output:
-			deviceDataFlow = DeviceDataFlow.Render
-			break
-		case undefined:
-			deviceDataFlow = DeviceDataFlow.All
-			break
-	}
-	const data = await requestAudioDevices(sonarEndpoint, { deviceDataFlow, removeSteelSeriesVAD: true })
-
-	const audioDevices: AudioDevice[] = data.map((device) => ({
-		id: device.id,
-		name: device.friendlyName,
-		type: getDeviceTypeFromDataFlow(device.dataFlow)
-	}))
-
-	return audioDevices
-}
-
-function getDeviceTypeFromDataFlow(dataFlow: DeviceDataFlow): DeviceFlow {
-	switch (dataFlow) {
-		case DeviceDataFlow.Capture:
-			return DeviceFlow.Input
-		case DeviceDataFlow.Render:
-			return DeviceFlow.Output
-		default:
-			throw new SonarRequestException({ message: `Unknown device data flow: ${dataFlow}` })
-	}
-}

package/src/functions/devices/set-audio-device.ts

@@ -1,19 +0,0 @@
-import type { DeviceChannel } from '@/enums'
-import { changeAudioDevice } from '@/sonar/requests/audio-devices/change-audio-device'
-import type { ChangedDevice } from '@/types/changed-device'
-
-export async function setAudioDevice(
-	sonarEndpoint: string,
-	deviceChannel: DeviceChannel,
-	deviceId: string
-): Promise<ChangedDevice[]> {
-	const data = await changeAudioDevice(sonarEndpoint, deviceChannel, deviceId)
-
-	const result: ChangedDevice[] = data.map((x) => ({
-		deviceId: x.deviceId,
-		deviceChannel: x.id,
-		isRunning: x.isRunning
-	}))
-
-	return result
-}

package/src/functions/endpoint/get-app-endpoint.ts

@@ -1,73 +0,0 @@
-import { promises as fsAsync } from 'node:fs'
-import { platform as getPlatform } from 'node:os'
-import { join as joinPath } from 'node:path'
-import { InitializeErrorReason, SonarInitializationException } from '@/exceptions'
-
-const WINDOWS_PATHS = ['SteelSeries', 'SteelSeries Engine 3', 'coreProps.json']
-
-type CoreProps = {
-	ggEncryptedAddress: string
-}
-
-/**
- * Retrieves the SteelSeries GG application's encrypted address from the coreProps.json file.
- *
- * @returns A promise that resolves to the GG application's secure address string (e.g., "https://..."),
- *          as found in the ggEncryptedAddress property of coreProps.json.
- *
- * @throws {SonarInitializationException} If the GG server cannot be determined.
- *
- * @remarks
- * - Only supports Windows OS; throws on other platforms.
- * - Locates coreProps.json in the ProgramData directory under SteelSeries folders.
- * - Reads and parses the file, returning the encrypted address as a secure URL.
- */
-export async function getAppEndpoint(): Promise<string> {
-	const appDataPath = getPath()
-	const fileContents = await getContents(appDataPath)
-	const data = parseContents(fileContents)
-
-	if (data.ggEncryptedAddress) {
-		return `https://${data.ggEncryptedAddress}`
-	}
-
-	throw new SonarInitializationException({
-		reason: InitializeErrorReason.BadConfig
-	})
-}
-
-function getPath(): string {
-	const os = getPlatform()
-	switch (os) {
-		case 'win32': {
-			const programData = process.env.ProgramData ?? 'C:\\ProgramData'
-			return joinPath(programData, ...WINDOWS_PATHS)
-		}
-		default:
-			throw new SonarInitializationException({
-				reason: InitializeErrorReason.OSUnsupported
-			})
-	}
-}
-
-async function getContents(path: string): Promise<string> {
-	try {
-		return await fsAsync.readFile(path, 'utf8')
-	} catch (error) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.BadConfig,
-			innerException: error as Error
-		})
-	}
-}
-
-function parseContents(contents: string): CoreProps {
-	try {
-		return JSON.parse(contents) as CoreProps
-	} catch (error) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.BadConfig,
-			innerException: error as Error
-		})
-	}
-}

package/src/functions/endpoint/get-sonar-endpoint-cached.ts

@@ -1,28 +0,0 @@
-import { getSonarEndpoint } from '@/functions/endpoint/get-sonar-endpoint'
-
-const cache = {
-	appAddress: null as string | null,
-	sonarAddress: null as string | null,
-	timestamp: 0
-}
-
-export async function getSonarEndpointCached(appAddress: string, seconds: number = 60): Promise<string> {
-	const now = Date.now()
-
-	if (cache.appAddress === appAddress && cache.sonarAddress && now - cache.timestamp < seconds * 1000) {
-		return cache.sonarAddress
-	}
-
-	try {
-		const sonarAddress = await getSonarEndpoint(appAddress)
-		cache.appAddress = appAddress
-		cache.sonarAddress = sonarAddress
-		cache.timestamp = now
-		return sonarAddress
-	} catch (error) {
-		cache.appAddress = null
-		cache.sonarAddress = null
-		cache.timestamp = 0
-		throw error
-	}
-}

package/src/functions/endpoint/get-sonar-endpoint.ts

@@ -1,88 +0,0 @@
-import { InitializeErrorReason, SonarInitializationException } from '@/exceptions'
-
-type SubAppsResponse = {
-	subApps: {
-		sonar?: {
-			isEnabled: boolean
-			isReady: boolean
-			isRunning: boolean
-			metadata: {
-				webServerAddress: string
-			}
-		}
-	}
-}
-
-/**
- * Retrieves the Sonar web server address from an application server's /subApps endpoint.
- *
- * @param appEndpoint - The base URL of the application server (e.g. "https://localhost:1234").
- * @returns A promise that resolves to the Sonar web server address.
- *
- * @throws {SonarInitializationException} If the sonar server cannot be determined.
- *
- * @remarks
- * - Performs a GET request to `${appAddress}/subApps`.
- * - The response body is expected to conform to the SubAppsResponse shape and contain `subApps.sonar`.
- * - Uses a fetch TLS option that disables certificate verification (rejectUnauthorized: false).
- */
-export async function getSonarEndpoint(appEndpoint: string): Promise<string> {
-	let response: Response
-
-	try {
-		response = await fetch(`${appEndpoint}/subApps`, {
-			tls: {
-				rejectUnauthorized: false
-			}
-		})
-	} catch (error) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotResponding,
-			innerException: error as Error
-		})
-	}
-
-	if (!response.ok) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotResponding
-		})
-	}
-
-	const result: SubAppsResponse = (await response.json()) as SubAppsResponse
-
-	const sonar = result?.subApps?.sonar
-
-	if (!sonar) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotAvailable
-		})
-	}
-
-	if (!sonar.isEnabled) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotEnabled
-		})
-	}
-
-	if (!sonar.isRunning) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotRunning
-		})
-	}
-
-	if (!sonar.isReady) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotReady
-		})
-	}
-
-	const sonarAddress = sonar.metadata?.webServerAddress
-
-	if (!sonarAddress) {
-		throw new SonarInitializationException({
-			reason: InitializeErrorReason.NotAvailable
-		})
-	}
-
-	return sonarAddress
-}

package/src/functions/profile/get-channel-profiles.ts

@@ -1,26 +0,0 @@
-import type { ProfileChannel } from '@/enums'
-import { convertProfileChannelToApi } from '@/functions/converters/convert-profile-channel-to-api'
-import { convertProfileChannelToUser } from '@/functions/converters/convert-profile-channel-to-user'
-import { requestConfigs } from '@/sonar/requests/profiles/request-configs'
-import type { ProfileOption } from '@/types/profile-option'
-
-export async function getChannelProfiles(
-	sonarAddress: string,
-	channel: ProfileChannel,
-	favoritesOnly?: boolean
-): Promise<ProfileOption[]> {
-	const vad = convertProfileChannelToApi(channel)
-	const data = await requestConfigs(sonarAddress, vad)
-	const workingSetData = favoritesOnly ? data.filter((x) => x.isFavorite) : data
-
-	return workingSetData.map((x) => {
-		const profile: ProfileOption = {
-			id: x.id,
-			name: x.name,
-			isFavorite: x.isFavorite,
-			channel: convertProfileChannelToUser(x.virtualAudioDevice),
-			image: x.image
-		}
-		return profile
-	})
-}

package/src/functions/profile/get-selected-profiles.ts

@@ -1,17 +0,0 @@
-import { convertProfileChannelToUser } from '@/functions/converters/convert-profile-channel-to-user'
-import { requestSelectedConfigs } from '@/sonar/requests/profiles/request-selected-configs'
-import type { ProfileOption } from '@/types/profile-option'
-
-export async function getSelectedProfiles(sonarAddress: string): Promise<ProfileOption[]> {
-	const data = await requestSelectedConfigs(sonarAddress)
-	return data.map((x) => {
-		const profile: ProfileOption = {
-			id: x.id,
-			name: x.name,
-			isFavorite: x.isFavorite,
-			channel: convertProfileChannelToUser(x.virtualAudioDevice),
-			image: x.image
-		}
-		return profile
-	})
-}

package/src/functions/profile/set-selected-profile.ts

@@ -1,17 +0,0 @@
-import { convertProfileChannelToUser } from '@/functions/converters/convert-profile-channel-to-user'
-import { changeSelectedConfig } from '@/sonar/requests/profiles/change-selected-config'
-import type { ProfileOption } from '@/types/profile-option'
-
-export async function setSelectedProfile(sonarAddress: string, profileId: string): Promise<ProfileOption> {
-	const data = await changeSelectedConfig(sonarAddress, profileId)
-
-	const result: ProfileOption = {
-		id: data.id,
-		name: data.name,
-		isFavorite: data.isFavorite,
-		channel: convertProfileChannelToUser(data.virtualAudioDevice),
-		image: data.image
-	}
-
-	return result
-}

package/src/index.ts

@@ -1,41 +0,0 @@
-export * from '@/enums'
-export * from '@/exceptions'
-
-// Audio
-export * from '@/functions/audio/get-audio-data-classic'
-export * from '@/functions/audio/get-audio-data-stream'
-export * from '@/functions/audio/get-audio-mode'
-export * from '@/functions/audio/set-audio-mode'
-export * from '@/functions/audio/set-channel-mute-classic'
-export * from '@/functions/audio/set-channel-mute-streamer'
-export * from '@/functions/audio/set-channel-volume-classic'
-export * from '@/functions/audio/set-channel-volume-streamer'
-
-// Chatmix
-export * from '@/functions/chatmix/get-chat-mix-state'
-export * from '@/functions/chatmix/set-chat-mix-balance'
-
-// Devices
-export * from '@/functions/devices/get-audio-devices'
-export * from '@/functions/devices/set-audio-device'
-
-// Endpoint
-export * from '@/functions/endpoint/get-app-endpoint'
-export * from '@/functions/endpoint/get-sonar-endpoint'
-export * from '@/functions/endpoint/get-sonar-endpoint-cached'
-
-// Profile
-export * from '@/functions/profile/get-channel-profiles'
-export * from '@/functions/profile/get-selected-profiles'
-export * from '@/functions/profile/set-selected-profile'
-
-// Types
-export * from '@/types/audio-device'
-export * from '@/types/changed-device'
-export * from '@/types/channel-volume-classic'
-export * from '@/types/channel-volume-streamer'
-export * from '@/types/channel-volume-streamer-path'
-export * from '@/types/channel-volumes-classic'
-export * from '@/types/channel-volumes-streamer'
-export * from '@/types/chat-mix-data'
-export * from '@/types/profile-option'

package/src/sonar/models/audio-settings/chatmix-data.ts

@@ -1,6 +0,0 @@
-import type { ChatMixState } from '@/sonar/models/audio-settings/enums/chat-mix-state'
-
-export type ChatMixData = {
-	balance: number
-	state: ChatMixState
-}

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

@@ -1,4 +0,0 @@
-export enum AudioMode {
-	Classic = 'classic',
-	Streamer = 'stream'
-}

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

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

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

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

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

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

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

@@ -1,9 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

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

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

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

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

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

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

@@ -1,13 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

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

@@ -1,17 +0,0 @@
-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

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