steelseries-sonar-sdk 0.1.1 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "steelseries-sonar-sdk",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"description": "An SDK for interacting with the SteelSeries Sonar software.",
 	"author": "Harley Torrisi <mail@harleycodes.com>",
 	"license": "MIT",
@@ -25,7 +25,7 @@
 		"test-e2e-endpoint": "bun test ./tests/e2e/**/*.test.ts -t getSonarEndpoint",
 		"test-unit": "bun test ./tests/unit/**/*.test.ts",
 		"test-all": "bun test-unit && bun test-e2e",
-		"package": "bun build ./src/index.ts --outdir=./dist --target node",
-		"package-minify": "bun build ./src/index.ts --outdir=./dist --minify --target node"
+		"package": "bunx tsc --emitDeclarationOnly --outDir dist -p tsconfig.build.json && bun build src/index.ts --outdir dist --target=node",
+		"package-minify": "bunx tsc --emitDeclarationOnly --outDir dist -p tsconfig.build.json && bun build src/index.ts --outdir dist --minify --target=node"
 	}
 }

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

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

package/src/enums.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Sonar audio mixing channels.
+ * @property {@link AudioChannel.Master} - Master volume channel.
+ * @property {@link AudioChannel.Game} - Game audio channel.
+ * @property {@link AudioChannel.Chat} - Chat audio channel.
+ * @property {@link AudioChannel.Media} - Media audio channel.
+ * @property {@link AudioChannel.Aux} - Auxiliary audio channel.
+ * @property {@link AudioChannel.Mic} - Microphone audio channel.
+ */
+export declare enum AudioChannel {
+    Master = "master",
+    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.
+ * @property {@link DeviceChannel.Game} - Game output channel.
+ * @property {@link DeviceChannel.Chat} - Chat output channel.
+ * @property {@link DeviceChannel.Media} - Media output channel.
+ * @property {@link DeviceChannel.Aux} - Auxiliary output channel.
+ * @property {@link DeviceChannel.Mic} - Microphone input channel.
+ */
+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 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 declare enum AudioMode {
+    Classic = "classic",
+    Streamer = "stream"
+}
+/**
+ * The state of CHATMIX availability.
+ * @property {@link ChatMixState.Enabled} - CHATMIX is enabled and available.
+ * @property {@link ChatMixState.FiniteWheel} - CHATMIX is available but the user cannot interact with it via software.
+ * @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 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 declare enum DeviceFlow {
+    Output = "output",
+    Input = "input"
+}

package/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/functions/converters/convert-volume-to-api.d.ts

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

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

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

package/src/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/src/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/src/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/src/functions/endpoint/get-sonar-endpoint-cached.d.ts

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

package/src/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/src/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/src/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/src/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/src/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';

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

@@ -0,0 +1,5 @@
+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.d.ts

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+export declare enum DeviceDefaultRoles {
+    Console = 0,
+    Multimedia = 1,
+    Communications = 2,
+    All = 3
+}

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

@@ -0,0 +1,9 @@
+export declare 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.d.ts

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

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

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

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

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

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

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

package/src/sonar/models/audio-settings/volume-info-streamer.d.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.d.ts

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

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

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

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

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

@@ -0,0 +1,16 @@
+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.d.ts

@@ -0,0 +1,6 @@
+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.d.ts

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

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

@@ -0,0 +1,9 @@
+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 declare function requestAudioDevices(sonarEndpoint: string, params: Params): Promise<SonarAudioDevice[]>;
+export {};

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

@@ -0,0 +1,2 @@
+import type { ChatMixData } from '@/sonar/models/audio-settings/chatmix-data';
+export declare function changeChatMixBalance(sonarEndpoint: string, chatBalance: number): Promise<ChatMixData>;

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

@@ -0,0 +1,2 @@
+import type { ChatMixData } from '@/sonar/models/audio-settings/chatmix-data';
+export declare function requestChatMixState(sonarEndpoint: string): Promise<ChatMixData>;

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

@@ -0,0 +1,2 @@
+import type { AudioMode } from '@/sonar/models/audio-settings/enums/audio-mode';
+export declare function changeAudioMode(sonarEndpoint: string, audioMode: AudioMode): Promise<AudioMode>;

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

@@ -0,0 +1,2 @@
+import { AudioMode } from '@/sonar/models/audio-settings/enums/audio-mode';
+export declare function requestAudioMode(sonarEndpoint: string): Promise<AudioMode>;

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

@@ -0,0 +1,2 @@
+import type { Config } from '@/sonar/models/config/config';
+export declare function changeSelectedConfig(sonarAddress: string, configId: string): Promise<Config>;

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

@@ -0,0 +1,3 @@
+import type { Config } from '@/sonar/models/config/config';
+import type { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice';
+export declare function requestConfigs(sonarAddress: string, channel: VirtualAudioDevice): Promise<Config[]>;

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

@@ -0,0 +1,2 @@
+import type { Config } from '@/sonar/models/config/config';
+export declare function requestSelectedConfigs(sonarAddress: string): Promise<Config[]>;

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

@@ -0,0 +1,3 @@
+import type { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel';
+import type { VolumeSettingsClassic } from '@/sonar/models/audio-settings/volume-settings-classic';
+export declare function changeVolumeLevelClassic(sonarEndpoint: string, volume: number, deviceRole: SonarChannel): Promise<VolumeSettingsClassic>;

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

@@ -0,0 +1,4 @@
+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 declare function changeVolumeLevelStreamer(sonarEndpoint: string, volume: number, channel: SonarChannel, path: StreamingPath): Promise<VolumeSettingsStreamer>;

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

@@ -0,0 +1,3 @@
+import type { SonarChannel } from '@/sonar/models/audio-settings/enums/sonar-channel';
+import type { VolumeSettingsClassic } from '@/sonar/models/audio-settings/volume-settings-classic';
+export declare function changeVolumeMuteClassic(sonarEndpoint: string, isMuted: boolean, deviceRole: SonarChannel): Promise<VolumeSettingsClassic>;

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

@@ -0,0 +1,4 @@
+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 declare function changeVolumeMuteStreamer(sonarEndpoint: string, isMuted: boolean, deviceRole: SonarChannel, path: StreamingPath): Promise<VolumeSettingsStreamer>;

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

@@ -0,0 +1,2 @@
+import type { VolumeSettingsClassic } from '@/sonar/models/audio-settings/volume-settings-classic';
+export declare function requestVolumeSettingsClassic(sonarEndpoint: string): Promise<VolumeSettingsClassic>;

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

@@ -0,0 +1,2 @@
+import type { VolumeSettingsStreamer } from '@/sonar/models/audio-settings/volume-settings-streamer';
+export declare function requestVolumeSettingsStreamer(sonarEndpoint: string): Promise<VolumeSettingsStreamer>;

package/src/types/audio-device.d.ts

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

package/src/types/changed-device.d.ts

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+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.d.ts

@@ -0,0 +1,7 @@
+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.d.ts

@@ -0,0 +1,7 @@
+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.d.ts

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

package/src/types/profile-option.d.ts

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

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"noEmit": false,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"declarationMap": false,
+		"outDir": "dist",
+		"rootDir": "src"
+	},
+	"exclude": ["tests"]
+}