Files
AstralRinth/packages/api-client/src/platform/nuxt.ts
Calum H. 70e2138248 feat: base api-client impl (#4694)
* feat: base api-client impl

* fix: doc

* feat: start work on module stuff

* feat: migrate v2/v3 projects into module system

* fix: lint & README.md contributing

* refactor: remove utils old api client prototype

* fix: lint

* fix: api url issues

* fix: baseurl in error.vue

* fix: readme

* fix typo in readme

* Update apps/frontend/src/providers/api-client.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Calum H. <hendersoncal117@gmail.com>

* Update packages/api-client/src/features/verbose-logging.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Calum H. <hendersoncal117@gmail.com>

* Update packages/api-client/src/features/retry.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Calum H. <hendersoncal117@gmail.com>

---------

Signed-off-by: Calum H. <hendersoncal117@gmail.com>
Co-authored-by: Prospector <6166773+Prospector@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-11-12 20:29:12 +00:00

114 lines
3.1 KiB
TypeScript

import { FetchError } from 'ofetch'
import { AbstractModrinthClient } from '../core/abstract-client'
import type { ModrinthApiError } from '../core/errors'
import type { CircuitBreakerState, CircuitBreakerStorage } from '../features/circuit-breaker'
import type { ClientConfig } from '../types/client'
import type { RequestOptions } from '../types/request'
/**
* Circuit breaker storage using Nuxt's useState
*
* This provides cross-request persistence in SSR while also working in client-side.
* State is shared between requests in the same Nuxt context.
*/
export class NuxtCircuitBreakerStorage implements CircuitBreakerStorage {
private getState(): Map<string, CircuitBreakerState> {
// @ts-expect-error - useState is provided by Nuxt runtime
const state = useState<Map<string, CircuitBreakerState>>(
'circuit-breaker-state',
() => new Map(),
)
return state.value
}
get(key: string): CircuitBreakerState | undefined {
return this.getState().get(key)
}
set(key: string, state: CircuitBreakerState): void {
this.getState().set(key, state)
}
clear(key: string): void {
this.getState().delete(key)
}
}
/**
* Nuxt-specific configuration
*/
export interface NuxtClientConfig extends ClientConfig {
// TODO: do we want to provide this for tauri+base as well? its not used on app
/**
* Rate limit key for server-side requests
* This is injected as x-ratelimit-key header on server-side
*/
rateLimitKey?: string
}
/**
* Nuxt platform client using Nuxt's $fetch
*
* This client is optimized for Nuxt applications and handles SSR/CSR automatically.
*
* @example
* ```typescript
* // In a Nuxt composable
* const config = useRuntimeConfig()
* const auth = await useAuth()
*
* const client = new NuxtModrinthClient({
* userAgent: 'my-nuxt-app/1.0.0',
* rateLimitKey: import.meta.server ? config.rateLimitKey : undefined,
* features: [
* new AuthFeature({ token: () => auth.value.token })
* ]
* })
*
* const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 })
* ```
*/
export class NuxtModrinthClient extends AbstractModrinthClient {
protected declare config: NuxtClientConfig
protected async executeRequest<T>(url: string, options: RequestOptions): Promise<T> {
try {
// @ts-expect-error - $fetch is provided by Nuxt runtime
const response = await $fetch<T>(url, {
method: options.method ?? 'GET',
headers: options.headers,
body: options.body,
params: options.params,
timeout: options.timeout,
signal: options.signal,
})
return response
} catch (error) {
throw this.normalizeError(error)
}
}
protected normalizeError(error: unknown): ModrinthApiError {
if (error instanceof FetchError) {
return this.createNormalizedError(error, error.response?.status, error.data)
}
return super.normalizeError(error)
}
protected buildDefaultHeaders(): Record<string, string> {
const headers: Record<string, string> = {
...super.buildDefaultHeaders(),
}
// @ts-expect-error - import.meta is provided by Nuxt
if (import.meta.server && this.config.rateLimitKey) {
headers['x-ratelimit-key'] = this.config.rateLimitKey
}
return headers
}
}