steelseries-sonar-sdk 0.1.1 → 0.2.2

package/dist/consts/fetch-options-put.d.ts

@@ -0,0 +1,3 @@
+export declare const FETCH_OPTIONS_PUT: {
+    readonly method: "PUT";
+};

package/{src/enums.ts → dist/enums.d.ts}

@@ -7,24 +7,21 @@
  * @property {@link AudioChannel.Aux} - Auxiliary audio channel.
  * @property {@link AudioChannel.Mic} - Microphone audio channel.
  */
-export enum AudioChannel {
-	Master = 'master',
-	Game = 'game',
-	Chat = 'chat',
-	Media = 'media',
-	Aux = 'aux',
-	Mic = 'mic'
+export declare enum AudioChannel {
+    Master = "master",
+    Game = "game",
+    Chat = "chat",
+    Media = "media",
+    Aux = "aux",
+    Mic = "mic"
 }
-
-// TODO: Sort this channel duplication nonsense out.
-export enum ProfileChannel {
-	Game = 'game',
-	Chat = 'chat',
-	Media = 'media',
-	Aux = 'aux',
-	Mic = 'mic'
+export declare enum ProfileChannel {
+    Game = "game",
+    Chat = "chat",
+    Media = "media",
+    Aux = "aux",
+    Mic = "mic"
 }
-
 /**
  * Sonar device channels.
  * @property {@link DeviceChannel.Output} - All output channels.
@@ -34,35 +31,32 @@ export enum ProfileChannel {
  * @property {@link DeviceChannel.Aux} - Auxiliary output channel.
  * @property {@link DeviceChannel.Mic} - Microphone input channel.
  */
-export enum DeviceChannel {
-	Output = 'render',
-	Game = 'game',
-	Chat = 'chat',
-	Media = 'media',
-	Aux = 'aux',
-	Mic = 'mic'
+export declare enum DeviceChannel {
+    Output = "render",
+    Game = "game",
+    Chat = "chat",
+    Media = "media",
+    Aux = "aux",
+    Mic = "mic"
 }
-
 /**
  * Sonar Streamer Mode path.
  * @property {@link StreamerPath.Streaming} - What the audience will hear.
  * @property {@link StreamerPath.Monitoring} - What the owner will hear.
  */
-export enum StreamerPath {
-	Streaming = 'streaming',
-	Monitoring = 'monitoring'
+export declare enum StreamerPath {
+    Streaming = "streaming",
+    Monitoring = "monitoring"
 }
-
 /**
  * Sonar mixing state.
  * @property {@link AudioMode.Classic} - Basic mixing.
  * @property {@link AudioMode.Streamer} - Advanced mixing - has stream/monitor path each channel.
  */
-export enum AudioMode {
-	Classic = 'classic',
-	Streamer = 'stream'
+export declare enum AudioMode {
+    Classic = "classic",
+    Streamer = "stream"
 }
-
 /**
  * The state of CHATMIX availability.
  * @property {@link ChatMixState.Enabled} - CHATMIX is enabled and available.
@@ -70,19 +64,18 @@ export enum AudioMode {
  * @property {@link ChatMixState.DifferentDeviceSelected} - CHATMIX is unavailable because a different output device is selected.
  * @property {@link ChatMixState.NoDeviceSelected} - CHATMIX is unavailable because no output device is selected.
  */
-export enum ChatMixState {
-	Enabled = 'enabled',
-	FiniteWheel = 'finiteWheel',
-	DifferentDeviceSelected = 'differentDeviceSelected',
-	NoDeviceSelected = 'noDeviceSelected'
+export declare enum ChatMixState {
+    Enabled = "enabled",
+    FiniteWheel = "finiteWheel",
+    DifferentDeviceSelected = "differentDeviceSelected",
+    NoDeviceSelected = "noDeviceSelected"
 }
-
 /**
  * Type of audio device.
  * @property {@link DeviceFlow.Output} - Device used to render audio (e.g. speakers, headphones).
  * @property {@link DeviceFlow.Input} - Device used to capture audio (e.g. microphones).
  */
-export enum DeviceFlow {
-	Output = 'output',
-	Input = 'input'
+export declare enum DeviceFlow {
+    Output = "output",
+    Input = "input"
 }

package/dist/exceptions.d.ts

@@ -0,0 +1,32 @@
+type RequestErrorProps = {
+    message?: string;
+    innerException?: Error;
+};
+export declare enum InitializeErrorReason {
+    BadConfig = "Bad Config",
+    OSUnsupported = "OS Unsupported",
+    NotEnabled = "Not Enabled",
+    NotRunning = "Not Running",
+    NotReady = "Not Ready",
+    NotResponding = "Not Responding",
+    NotAvailable = "Not Available"
+}
+type InitializeErrorProps = {
+    message?: string;
+    innerException?: Error;
+    reason: InitializeErrorReason;
+};
+/** Base exception for all handled Sonar related exception. */
+export declare abstract class SonarException extends Error {
+    constructor(message: string, cause?: Error);
+}
+/** Thrown when the server responds in an unexpected way. */
+export declare class SonarRequestException extends SonarException {
+    constructor(error?: RequestErrorProps);
+}
+/** Thrown when the server cannot be determined. */
+export declare class SonarInitializationException extends SonarException {
+    reason: InitializeErrorReason;
+    constructor(error: InitializeErrorProps);
+}
+export {};

package/dist/functions/audio/get-audio-data-classic.d.ts

@@ -0,0 +1,7 @@
+import type { ChannelVolumesClassic } from '@/types/channel-volumes-classic';
+/**
+ * Gets audio data for all channels.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @returns volume in the range of 0 to 100,
+ */
+export declare function getAudioDataClassic(sonarEndpoint: string): Promise<ChannelVolumesClassic>;

package/dist/functions/audio/get-audio-data-stream.d.ts

@@ -0,0 +1,7 @@
+import type { ChannelVolumesStreamer } from '@/types/channel-volumes-streamer';
+/**
+ * Gets audio data for all channels.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @returns volume in the range of 0 to 100,
+ */
+export declare function getAudioDataStream(sonarEndpoint: string): Promise<ChannelVolumesStreamer>;

package/dist/functions/audio/get-audio-mode.d.ts

@@ -0,0 +1,7 @@
+import type { AudioMode } from '@/enums';
+/**
+ * Gets audio data for all channels.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @returns classic or streamer mode
+ */
+export declare function getAudioMode(sonarEndpoint: string): Promise<AudioMode>;

package/dist/functions/audio/set-audio-mode.d.ts

@@ -0,0 +1,8 @@
+import type { AudioMode } from '@/enums';
+/**
+ * Gets audio data for all channels.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @param audioMode Target audio mode
+ * @returns classic or streamer mode
+ */
+export declare function setAudioMode(sonarEndpoint: string, audioMode: AudioMode): Promise<AudioMode>;

package/dist/functions/audio/set-channel-mute-classic.d.ts

@@ -0,0 +1,9 @@
+import type { AudioChannel } from '@/enums';
+import type { ChannelVolumeClassic } from '@/types/channel-volume-classic';
+/**
+ * Sets audio data for target channel.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @param isMuted Will mute if true.
+ * @param channel Target audio channel
+ */
+export declare function setChannelMuteClassic(sonarEndpoint: string, isMuted: boolean, channel: AudioChannel): Promise<ChannelVolumeClassic>;

package/dist/functions/audio/set-channel-mute-streamer.d.ts

@@ -0,0 +1,10 @@
+import { type AudioChannel, StreamerPath } from '@/enums';
+import type { ChannelVolumeStreamerPath } from '@/types/channel-volume-streamer-path';
+/**
+ * Sets audio data for target channel.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @param isMuted Will mute if true.
+ * @param channel Target audio channel
+ * @param path Target streamer path
+ */
+export declare function setChannelMuteStreamer(sonarEndpoint: string, isMuted: boolean, channel: AudioChannel, path: StreamerPath): Promise<ChannelVolumeStreamerPath>;

package/dist/functions/audio/set-channel-volume-classic.d.ts

@@ -0,0 +1,9 @@
+import type { AudioChannel } from '@/enums';
+import type { ChannelVolumeClassic } from '@/types/channel-volume-classic';
+/**
+ * Sets audio data for target channel.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @param volumePercent Volume in the range of 0 to 100
+ * @param channel Target audio channel
+ */
+export declare function setChannelVolumeClassic(sonarEndpoint: string, volumePercent: number, channel: AudioChannel): Promise<ChannelVolumeClassic>;

package/dist/functions/audio/set-channel-volume-streamer.d.ts

@@ -0,0 +1,10 @@
+import { type AudioChannel, StreamerPath } from '@/enums';
+import type { ChannelVolumeStreamerPath } from '@/types/channel-volume-streamer-path';
+/**
+ * Sets audio data for target channel.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @param volumePercent Volume in the range of 0 to 100
+ * @param channel Target audio channel
+ * @param path Target streamer path
+ */
+export declare function setChannelVolumeStreamer(sonarEndpoint: string, volumePercent: number, channel: AudioChannel, path: StreamerPath): Promise<ChannelVolumeStreamerPath>;

package/dist/functions/chatmix/get-chat-mix-state.d.ts

@@ -0,0 +1,7 @@
+import type { ChatMixData } from '@/types/chat-mix-data';
+/**
+ * Gets CHATMIX state and data.
+ * @param sonarEndpoint Sonar endpoint URL
+ * @returns balance as 0 - 100,
+ */
+export declare function getChatMixState(sonarEndpoint: string): Promise<ChatMixData>;

package/dist/functions/chatmix/set-chat-mix-balance.d.ts

@@ -0,0 +1,7 @@
+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 declare function setChatMixBalance(sonarEndpoint: string, chatBalance: number): Promise<ChatMixData>;

package/dist/functions/converters/convert-channel-to-api.d.ts

@@ -0,0 +1,3 @@
+import { AudioChannel } from '@/enums';
+import { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel';
+export declare function convertChannelToApi(channel: AudioChannel): SonarChannel;

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

@@ -0,0 +1,2 @@
+/** convert [0 to 100] to [-1 to 1] */
+export declare function convertChatMixBalanceToApi(balance: number): number;

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

@@ -0,0 +1,2 @@
+/** convert [-1 to 1] to [0 to 100] */
+export declare function convertChatMixBalanceToUser(balance: number): number;

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

@@ -0,0 +1,3 @@
+import { ProfileChannel } from '@/enums';
+import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice';
+export declare function convertProfileChannelToApi(channel: ProfileChannel): VirtualAudioDevice;

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

@@ -0,0 +1,3 @@
+import { ProfileChannel } from '@/enums';
+import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice';
+export declare function convertProfileChannelToUser(channel: VirtualAudioDevice): ProfileChannel;

package/dist/functions/converters/convert-volume-to-api.d.ts

@@ -0,0 +1 @@
+export declare function convertVolumeToApi(value: number): number;

package/dist/functions/converters/convert-volume-to-user.d.ts

@@ -0,0 +1 @@
+export declare function convertVolumeToUser(value: number): number;

package/dist/functions/devices/get-audio-devices.d.ts

@@ -0,0 +1,3 @@
+import { DeviceFlow } from '@/enums';
+import type { AudioDevice } from '@/types/audio-device';
+export declare function getAudioDevices(sonarEndpoint: string, deviceType?: DeviceFlow): Promise<AudioDevice[]>;

package/dist/functions/devices/set-audio-device.d.ts

@@ -0,0 +1,3 @@
+import type { DeviceChannel } from '@/enums';
+import type { ChangedDevice } from '@/types/changed-device';
+export declare function setAudioDevice(sonarEndpoint: string, deviceChannel: DeviceChannel, deviceId: string): Promise<ChangedDevice[]>;

package/dist/functions/endpoint/get-app-endpoint.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 declare function getAppEndpoint(): Promise<string>;

package/dist/functions/endpoint/get-sonar-endpoint-cached.d.ts

@@ -0,0 +1 @@
+export declare function getSonarEndpointCached(appAddress: string, seconds?: number): Promise<string>;

package/dist/functions/endpoint/get-sonar-endpoint.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 declare function getSonarEndpoint(appEndpoint: string): Promise<string>;

package/dist/functions/profile/get-channel-profiles.d.ts

@@ -0,0 +1,3 @@
+import type { ProfileChannel } from '@/enums';
+import type { ProfileOption } from '@/types/profile-option';
+export declare function getChannelProfiles(sonarAddress: string, channel: ProfileChannel, favoritesOnly?: boolean): Promise<ProfileOption[]>;

package/dist/functions/profile/get-selected-profiles.d.ts

@@ -0,0 +1,2 @@
+import type { ProfileOption } from '@/types/profile-option';
+export declare function getSelectedProfiles(sonarAddress: string): Promise<ProfileOption[]>;

package/dist/functions/profile/set-selected-profile.d.ts

@@ -0,0 +1,2 @@
+import type { ProfileOption } from '@/types/profile-option';
+export declare function setSelectedProfile(sonarAddress: string, profileId: string): Promise<ProfileOption>;

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+export * from '@/enums';
+export * from '@/exceptions';
+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';
+export * from '@/functions/chatmix/get-chat-mix-state';
+export * from '@/functions/chatmix/set-chat-mix-balance';
+export * from '@/functions/devices/get-audio-devices';
+export * from '@/functions/devices/set-audio-device';
+export * from '@/functions/endpoint/get-app-endpoint';
+export * from '@/functions/endpoint/get-sonar-endpoint';
+export * from '@/functions/endpoint/get-sonar-endpoint-cached';
+export * from '@/functions/profile/get-channel-profiles';
+export * from '@/functions/profile/get-selected-profiles';
+export * from '@/functions/profile/set-selected-profile';
+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';