steelseries-sonar-sdk 0.1.1

package/tests/unit/endpoint/get-sonar-endpoint.test.ts

@@ -0,0 +1,140 @@
+import { afterEach, beforeEach, describe, expect, it } from 'bun:test'
+import { InitializeErrorReason, SonarInitializationException } from '../../../src/exceptions'
+import { getSonarEndpoint } from '../../../src/functions/endpoint/get-sonar-endpoint'
+
+let originalFetch: typeof fetch
+
+const request = () => getSonarEndpoint('')
+
+describe('getSonarEndpoint', () => {
+	beforeEach(() => {
+		originalFetch = globalThis.fetch
+	})
+
+	afterEach(() => {
+		globalThis.fetch = originalFetch
+	})
+
+	it('throws NotEnabled Exception if sonar is not enabled', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({
+					subApps: {
+						sonar: {
+							isEnabled: false,
+							isReady: true,
+							isRunning: true,
+							metadata: { webServerAddress: '127.0.0.1:1234' }
+						}
+					}
+				})
+			}) as Response) as unknown as typeof fetch
+
+		const rejects = expect(request()).rejects
+		rejects.toThrow(SonarInitializationException)
+		rejects.toMatchObject({ reason: InitializeErrorReason.NotEnabled })
+	})
+
+	it('throws NotReady Exception if sonar is not ready', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({
+					subApps: {
+						sonar: {
+							isEnabled: true,
+							isReady: false,
+							isRunning: true,
+							metadata: { webServerAddress: '127.0.0.1:1234' }
+						}
+					}
+				})
+			}) as Response) as unknown as typeof fetch
+
+		const rejects = expect(request()).rejects
+		rejects.toThrow(SonarInitializationException)
+		rejects.toMatchObject({ reason: InitializeErrorReason.NotReady })
+	})
+
+	it('throws NotRunning Exception if sonar is not running', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({
+					subApps: {
+						sonar: {
+							isEnabled: true,
+							isReady: true,
+							isRunning: false,
+							metadata: { webServerAddress: '127.0.0.1:1234' }
+						}
+					}
+				})
+			}) as Response) as unknown as typeof fetch
+
+		const rejects = expect(request()).rejects
+		rejects.toThrow(SonarInitializationException)
+		rejects.toMatchObject({ reason: InitializeErrorReason.NotRunning })
+	})
+
+	it('throws NotResponding Exception if sonar server is not found', async () => {
+		globalThis.fetch = (async () => {
+			throw new Error('Failed to fetch')
+		}) as unknown as typeof fetch
+		const rejects = expect(request()).rejects
+		rejects.toThrow(SonarInitializationException)
+		rejects.toMatchObject({ reason: InitializeErrorReason.NotResponding })
+	})
+
+	it('throws NotResponding Exception if sonar server returns bad status code', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: false
+			}) as Response) as unknown as typeof fetch
+		const rejects = expect(request()).rejects
+		rejects.toThrow(SonarInitializationException)
+		rejects.toMatchObject({ reason: InitializeErrorReason.NotResponding })
+	})
+
+	it('throws NotAvailable Exception if sonar webServerAddress is not provided', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({
+					subApps: {
+						sonar: {
+							isEnabled: true,
+							isReady: true,
+							isRunning: true
+						}
+					}
+				})
+			}) as Response) as unknown as typeof fetch
+
+		const rejects = expect(request()).rejects
+		rejects.toThrow(SonarInitializationException)
+		rejects.toMatchObject({ reason: InitializeErrorReason.NotAvailable })
+	})
+
+	it('return Sonar webServerAddress when response is valid', async () => {
+		const expectedWebServerAddress = 'https://127.0.0.1:1234'
+
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({
+					subApps: {
+						sonar: {
+							isEnabled: true,
+							isReady: true,
+							isRunning: true,
+							metadata: { webServerAddress: expectedWebServerAddress }
+						}
+					}
+				})
+			}) as Response) as unknown as typeof fetch
+
+		expect(getSonarEndpoint('')).resolves.toBe(expectedWebServerAddress)
+	})
+})

package/tests/unit/profiles/get-channel-profiles.test.ts

@@ -0,0 +1,91 @@
+import { afterEach, beforeEach, describe, expect, it } from 'bun:test'
+import { ProfileChannel } from '@/enums'
+import { SonarRequestException } from '@/exceptions'
+import { getChannelProfiles } from '@/functions/profile/get-channel-profiles'
+import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
+
+let originalFetch: typeof fetch
+
+const request = (favorite?: boolean) => getChannelProfiles('http://localhost', ProfileChannel.Media, favorite)
+
+describe('getChannelProfiles', () => {
+	beforeEach(() => {
+		originalFetch = globalThis.fetch
+	})
+
+	afterEach(() => {
+		globalThis.fetch = originalFetch
+	})
+
+	it('throws SonarException when response not 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: false,
+				json: async () => 'Some error occurred'
+			}) as Response) as unknown as typeof fetch
+
+		expect(request()).rejects.toThrow(SonarRequestException)
+	})
+
+	it('throws SonarException when response 200 but not data', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({})
+			}) as Response) as unknown as typeof fetch
+
+		expect(request()).rejects.toThrow(SonarRequestException)
+	})
+
+	it('return data when response 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => [
+					{
+						id: 'one',
+						name: 'one',
+						isFavorite: true,
+						virtualAudioDevice: VirtualAudioDevice.Game,
+						image: 'string'
+					},
+					{
+						id: 'two',
+						name: 'two',
+						isFavorite: false,
+						virtualAudioDevice: VirtualAudioDevice.Game,
+						image: 'string'
+					}
+				]
+			}) as Response) as unknown as typeof fetch
+
+		const response = await request()
+		expect(response.length).toBe(2)
+	})
+
+	it('return favorites data when response 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => [
+					{
+						id: 'one',
+						name: 'one',
+						isFavorite: true,
+						virtualAudioDevice: VirtualAudioDevice.Game,
+						image: 'string'
+					},
+					{
+						id: 'two',
+						name: 'two',
+						isFavorite: false,
+						virtualAudioDevice: VirtualAudioDevice.Game,
+						image: 'string'
+					}
+				]
+			}) as Response) as unknown as typeof fetch
+
+		const response = await request(true)
+		expect(response.length).toBe(1)
+	})
+})

package/tests/unit/profiles/get-selected-profiles.test.ts

@@ -0,0 +1,64 @@
+import { afterEach, beforeEach, describe, expect, it } from 'bun:test'
+import { SonarRequestException } from '@/exceptions'
+import { getSelectedProfiles } from '@/functions/profile/get-selected-profiles'
+import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
+
+let originalFetch: typeof fetch
+
+const request = () => getSelectedProfiles('http://localhost')
+
+describe('getSelectedProfiles', () => {
+	beforeEach(() => {
+		originalFetch = globalThis.fetch
+	})
+
+	afterEach(() => {
+		globalThis.fetch = originalFetch
+	})
+
+	it('throws SonarException when response not 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: false,
+				json: async () => 'Some error occurred'
+			}) as Response) as unknown as typeof fetch
+
+		expect(request()).rejects.toThrow(SonarRequestException)
+	})
+
+	it('throws SonarException when response 200 but not data', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({})
+			}) as Response) as unknown as typeof fetch
+
+		expect(request()).rejects.toThrow(SonarRequestException)
+	})
+
+	it('return data when response 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => [
+					{
+						id: 'one',
+						name: 'one',
+						isFavorite: true,
+						virtualAudioDevice: VirtualAudioDevice.Game,
+						image: 'string'
+					},
+					{
+						id: 'two',
+						name: 'two',
+						isFavorite: false,
+						virtualAudioDevice: VirtualAudioDevice.Media,
+						image: 'string'
+					}
+				]
+			}) as Response) as unknown as typeof fetch
+
+		const response = await request()
+		expect(response.length).toBe(2)
+	})
+})

package/tests/unit/profiles/set-selected-profile.test.ts

@@ -0,0 +1,55 @@
+import { afterEach, beforeEach, describe, expect, it } from 'bun:test'
+import { SonarRequestException } from '@/exceptions'
+import { setSelectedProfile } from '@/functions/profile/set-selected-profile'
+import { VirtualAudioDevice } from '@/sonar/models/config/enums/VirtualAudioDevice'
+
+let originalFetch: typeof fetch
+
+const request = () => setSelectedProfile('http://localhost', 'one')
+
+describe('setSelectedProfile', () => {
+	beforeEach(() => {
+		originalFetch = globalThis.fetch
+	})
+
+	afterEach(() => {
+		globalThis.fetch = originalFetch
+	})
+
+	it('throws SonarException when response not 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: false,
+				json: async () => 'Some error occurred'
+			}) as Response) as unknown as typeof fetch
+
+		expect(request()).rejects.toThrow(SonarRequestException)
+	})
+
+	it('throws SonarException when response 200 but not data', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({})
+			}) as Response) as unknown as typeof fetch
+
+		expect(request()).rejects.toThrow(SonarRequestException)
+	})
+
+	it('return data when response 200', async () => {
+		globalThis.fetch = (async () =>
+			({
+				ok: true,
+				json: async () => ({
+					id: 'one',
+					name: 'one',
+					isFavorite: true,
+					virtualAudioDevice: VirtualAudioDevice.Game,
+					image: 'string'
+				})
+			}) as Response) as unknown as typeof fetch
+
+		const response = await request()
+		expect(response.id).toBe('one')
+	})
+})

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+	"compilerOptions": {
+		// Environment setup & latest features
+		"lib": ["ESNext"],
+		"target": "ESNext",
+		"module": "Preserve",
+		"moduleDetection": "force",
+		"jsx": "react-jsx",
+		"allowJs": true,
+
+		// Bundler mode
+		"moduleResolution": "bundler",
+		"allowImportingTsExtensions": true,
+		"verbatimModuleSyntax": true,
+		"noEmit": true,
+
+		// Best practices
+		"strict": true,
+		"skipLibCheck": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedIndexedAccess": true,
+		"noImplicitOverride": true,
+
+		// Some stricter flags (disabled by default)
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+		"noPropertyAccessFromIndexSignature": false,
+
+		// Path alias for '@' to 'src/'
+		"baseUrl": ".",
+		"paths": {
+			"@/*": ["src/*"]
+		}
+	},
+	"exclude": ["dist"]
+}