@modrinth/api-client 0.31.0 → 0.32.0

package/dist/platform/tauri.d.ts

@@ -1,35 +0,0 @@
-import type { ModrinthApiError } from '../core/errors';
-import type { ClientConfig } from '../types/client';
-import type { RequestOptions } from '../types/request';
-import { XHRUploadClient } from './xhr-upload-client';
-/**
- * Tauri-specific configuration
- * TODO: extend into interface if needed.
- */
-export type TauriClientConfig = ClientConfig;
-/**
- * Tauri platform client using Tauri v2 HTTP plugin
- *
- * Extends XHRUploadClient to provide upload with progress tracking.
- *
- * @example
- * ```typescript
- * import { getVersion } from '@tauri-apps/api/app'
- *
- * const client = new TauriModrinthClient({
- *   userAgent: async () => `modrinth/theseus/${await getVersion()} (support@modrinth.com)`,
- *   features: [
- *     new AuthFeature({ token: async () => getOAuthToken() })
- *   ]
- * })
- *
- * const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 })
- * ```
- */
-export declare class TauriModrinthClient extends XHRUploadClient {
-    protected config: TauriClientConfig;
-    constructor(config: TauriClientConfig);
-    protected executeRequest<T>(url: string, options: RequestOptions): Promise<T>;
-    protected executeStreamRequest(url: string, options: RequestOptions): Promise<ReadableStream<Uint8Array>>;
-    protected normalizeError(error: unknown): ModrinthApiError;
-}

package/dist/platform/websocket-generic.d.ts

@@ -1,16 +0,0 @@
-import { AbstractWebSocketClient } from '../core/abstract-websocket';
-import type { Archon } from '../modules/archon/types';
-type WSEventMap = {
-    [K in Archon.Websocket.v0.WSEvent as `${string}:${K['event']}`]: K;
-};
-export declare class GenericWebSocketClient extends AbstractWebSocketClient {
-    protected emitter: import("mitt").Emitter<WSEventMap>;
-    connect(serverId: string, auth: Archon.Websocket.v0.WSAuth): Promise<void>;
-    disconnect(serverId: string): void;
-    private closeConnection;
-    disconnectAll(): void;
-    send(serverId: string, message: Archon.Websocket.v0.WSOutgoingMessage): void;
-    private scheduleReconnect;
-    private handleAuthExpiring;
-}
-export {};

package/dist/platform/xhr-upload-client.d.ts

@@ -1,15 +0,0 @@
-import { AbstractModrinthClient } from '../core/abstract-client';
-import { ModrinthApiError } from '../core/errors';
-import type { RequestContext } from '../types/request';
-import type { UploadHandle, UploadProgress, UploadRequestOptions } from '../types/upload';
-/**
- * Abstract client with XHR-based upload implementation
- *
- * Platform-specific clients should extend this instead of AbstractModrinthClient
- * to inherit the XHR upload implementation.
- */
-export declare abstract class XHRUploadClient extends AbstractModrinthClient {
-    upload<T = void>(path: string, options: UploadRequestOptions): UploadHandle<T>;
-    protected executeXHRUpload<T>(context: RequestContext, progressCallbacks: Array<(p: UploadProgress) => void>, abortController: AbortController): Promise<T>;
-    protected createUploadError(xhr: XMLHttpRequest): ModrinthApiError;
-}

package/dist/state/node-auth.d.ts

@@ -1,36 +0,0 @@
-import type { NodeAuth } from '../features/node-auth';
-/**
- * Global node auth state.
- * Set by server management pages, read by NodeAuthFeature.
- */
-export declare const nodeAuthState: {
-    getAuth: (() => NodeAuth | null) | null;
-    refreshAuth: (() => Promise<void>) | null;
-};
-/**
- * Configure the node auth state. Call this when entering server management.
- *
- * @param getAuth - Function that returns current auth or null
- * @param refreshAuth - Function to refresh the auth token
- *
- * @example
- * ```typescript
- * // In server management page setup
- * setNodeAuthState(
- *   () => fsAuth.value,
- *   refreshFsAuth,
- * )
- * ```
- */
-export declare function setNodeAuthState(getAuth: () => NodeAuth | null, refreshAuth: () => Promise<void>): void;
-/**
- * Clear the node auth state. Call this when leaving server management.
- *
- * @example
- * ```typescript
- * onUnmounted(() => {
- *   clearNodeAuthState()
- * })
- * ```
- */
-export declare function clearNodeAuthState(): void;

package/dist/types/client.d.ts

@@ -1,70 +0,0 @@
-import type { AbstractFeature } from '../core/abstract-feature';
-import type { RequestContext } from './request';
-export type MaybePromise<T> = T | Promise<T>;
-export type UserAgentProvider = string | (() => MaybePromise<string | undefined>);
-export type BaseUrlConfig = string | (() => string);
-/**
- * Request lifecycle hooks
- */
-export type RequestHooks = {
-    /**
-     * Called before request is sent (after all features have processed)
-     */
-    onRequest?: (context: RequestContext) => void | Promise<void>;
-    /**
-     * Called after successful response (before features process response)
-     */
-    onResponse?: <T>(data: T, context: RequestContext) => void | Promise<void>;
-    /**
-     * Called when request fails (after all features have processed error)
-     */
-    onError?: (error: Error, context: RequestContext) => void | Promise<void>;
-};
-/**
- * Client configuration
- */
-export interface ClientConfig {
-    /**
-     * User agent string or provider for requests
-     * Should identify your application (e.g., 'my-app/1.0.0')
-     * If not provided, the platform's default user agent will be used
-     */
-    userAgent?: UserAgentProvider;
-    /**
-     * Base URL for Labrinth API (main Modrinth API)
-     * @default 'https://api.modrinth.com'
-     */
-    labrinthBaseUrl?: BaseUrlConfig;
-    /**
-     * Base URL for Archon API (Modrinth Hosting API)
-     * Can be a callback so apps can drive this from runtime feature flags.
-     *
-     * @default 'https://archon.modrinth.com'
-     */
-    archonBaseUrl?: BaseUrlConfig;
-    /**
-     * Default request timeout in milliseconds
-     * @default 10000
-     */
-    timeout?: number;
-    /**
-     * Additional default headers to include in all requests
-     */
-    headers?: Record<string, string>;
-    /**
-     * Whether to attach `modrinth-sentry-capture: 1` to Archon requests.
-     * Can be a callback so apps can drive this from runtime feature flags.
-     *
-     * @default false
-     */
-    archonSentryCapture?: boolean | (() => boolean);
-    /**
-     * Features to enable for this client
-     * Features are applied in the order they appear in this array
-     */
-    features?: AbstractFeature[];
-    /**
-     * Request lifecycle hooks
-     */
-    hooks?: RequestHooks;
-}

package/dist/types/errors.d.ts

@@ -1,43 +0,0 @@
-/**
- * Data for API errors
- */
-export type ApiErrorData = {
-    /**
-     * HTTP status code (if available)
-     */
-    statusCode?: number;
-    /**
-     * Original error that was caught
-     */
-    originalError?: Error;
-    /**
-     * Response data from the API (if available)
-     */
-    responseData?: unknown;
-    /**
-     * Error context (e.g., module name, operation being performed)
-     */
-    context?: string;
-};
-/**
- * Modrinth V1 error response format
- * Used by kyros + archon APIs
- */
-export type ModrinthErrorResponse = {
-    /**
-     * Error code/identifier
-     */
-    error: string;
-    /**
-     * Human-readable error description
-     */
-    description: string;
-    /**
-     * Optional context about where the error occurred
-     */
-    context?: string;
-};
-/**
- * Type guard to check if an object is a ModrinthErrorResponse
- */
-export declare function isModrinthErrorResponse(obj: unknown): obj is ModrinthErrorResponse;

package/dist/types/index.d.ts

@@ -1,10 +0,0 @@
-export type { FeatureConfig } from '../core/abstract-feature';
-export type { AuthConfig } from '../features/auth';
-export type { CircuitBreakerConfig, CircuitBreakerState, CircuitBreakerStorage, } from '../features/circuit-breaker';
-export type { BackoffStrategy, RetryConfig } from '../features/retry';
-export type { Archon } from '../modules/archon/types';
-export type { BaseUrlConfig, ClientConfig, RequestHooks } from './client';
-export type { ApiErrorData, ModrinthErrorResponse } from './errors';
-export { isModrinthErrorResponse } from './errors';
-export type { HttpMethod, RequestContext, RequestOptions, ResponseData } from './request';
-export type { UploadHandle, UploadMetadata, UploadProgress, UploadRequestOptions, UploadState, } from './upload';

package/dist/types/request.d.ts

@@ -1,124 +0,0 @@
-/**
- * HTTP method types
- */
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-/**
- * Options for making a request
- */
-export type RequestOptions = {
-    /**
-     * API to use for this request
-     * - 'labrinth': Main Modrinth API (resolves to labrinthBaseUrl)
-     * - 'archon': Modrinth Hosting API (resolves to archonBaseUrl)
-     * - string: Custom base URL (e.g., 'https://custom-api.com')
-     */
-    api: 'labrinth' | 'archon' | string;
-    /**
-     * API version to use
-     * - number: version number (e.g., 2 for v2, 3 for v3)
-     * - 'internal': use internal API
-     */
-    version: number | 'internal' | string;
-    /**
-     * HTTP method to use
-     * @default 'GET'
-     */
-    method?: HttpMethod;
-    /**
-     * Request headers
-     */
-    headers?: Record<string, string>;
-    /**
-     * Request body (will be JSON stringified if object)
-     */
-    body?: unknown;
-    /**
-     * URL query parameters
-     */
-    params?: Record<string, unknown>;
-    /**
-     * Request timeout in milliseconds
-     */
-    timeout?: number;
-    /**
-     * Abort signal for cancelling requests
-     */
-    signal?: AbortSignal;
-    /**
-     * Retry configuration for this specific request
-     * - false: no retries
-     * - true: use default retry config
-     * - number: max retry attempts
-     */
-    retry?: boolean | number;
-    /**
-     * Circuit breaker configuration for this specific request
-     * - false: disable circuit breaker
-     * - true: use default circuit breaker config
-     */
-    circuitBreaker?: boolean;
-    /**
-     * Whether to skip authentication for this request
-     * @default false
-     */
-    skipAuth?: boolean;
-    /**
-     * Use node authentication for this request.
-     * When true, NodeAuthFeature will handle auth injection and URL building.
-     * @default false
-     */
-    useNodeAuth?: boolean;
-};
-/**
- * Full context passed to features during request execution
- */
-export type RequestContext = {
-    /**
-     * Full URL being requested (with base URL and versioning applied)
-     */
-    url: string;
-    /**
-     * Original path (before base URL and versioning)
-     */
-    path: string;
-    /**
-     * Request options
-     */
-    options: RequestOptions;
-    /**
-     * Current attempt number (1-indexed)
-     */
-    attempt: number;
-    /**
-     * Timestamp when request started
-     */
-    startTime: number;
-    /**
-     * Additional metadata that features can attach
-     *
-     * For uploads, this contains:
-     * - isUpload: true
-     * - file: File | Blob being uploaded
-     * - onProgress: progress callback (if provided)
-     *
-     * Features can check `context.metadata?.isUpload` to detect uploads.
-     */
-    metadata?: Record<string, unknown>;
-};
-/**
- * Generic response wrapper
- */
-export type ResponseData<T = unknown> = {
-    /**
-     * Response data
-     */
-    data: T;
-    /**
-     * HTTP status code
-     */
-    status: number;
-    /**
-     * Response headers
-     */
-    headers: Record<string, string>;
-};

package/dist/types/upload.d.ts

@@ -1,92 +0,0 @@
-import type { RequestOptions } from './request';
-/**
- * Progress information for file uploads
- */
-export interface UploadProgress {
-    /** Bytes uploaded so far */
-    loaded: number;
-    /** Total bytes to upload */
-    total: number;
-    /** Progress as a decimal (0-1) */
-    progress: number;
-}
-/**
- * Base options for upload requests
- */
-interface BaseUploadRequestOptions extends Omit<RequestOptions, 'body' | 'method'> {
-    /** Callback for progress updates */
-    onProgress?: (progress: UploadProgress) => void;
-}
-/**
- * Options for single file upload requests
- */
-export interface FileUploadRequestOptions extends BaseUploadRequestOptions {
-    /** File or Blob to upload */
-    file: File | Blob;
-    formData?: never;
-}
-/**
- * Options for FormData upload requests
- *
- * Used for multipart uploads (e.g., version file uploads) that need
- * to send metadata alongside files.
- */
-export interface FormDataUploadRequestOptions extends BaseUploadRequestOptions {
-    /** FormData containing files and metadata */
-    formData: FormData;
-    file?: never;
-}
-/**
- * Options for upload requests - either a single file or FormData
- */
-export type UploadRequestOptions = FileUploadRequestOptions | FormDataUploadRequestOptions;
-/**
- * Metadata attached to file upload contexts
- *
- * Features can check `context.metadata?.isUpload` to detect uploads.
- */
-export interface FileUploadMetadata extends Record<string, unknown> {
-    isUpload: true;
-    file: File | Blob;
-    formData?: never;
-    onProgress?: (progress: UploadProgress) => void;
-}
-/**
- * Metadata attached to FormData upload contexts
- */
-export interface FormDataUploadMetadata extends Record<string, unknown> {
-    isUpload: true;
-    formData: FormData;
-    file?: never;
-    onProgress?: (progress: UploadProgress) => void;
-}
-/**
- * Metadata attached to upload contexts - either file or FormData
- */
-export type UploadMetadata = FileUploadMetadata | FormDataUploadMetadata;
-/**
- * Handle returned from upload operations
- *
- * Provides the upload promise, progress subscription, and cancellation.
- */
-export interface UploadHandle<T> {
-    /** Promise that resolves when upload completes */
-    promise: Promise<T>;
-    /** Subscribe to progress updates (chainable) */
-    onProgress: (callback: (progress: UploadProgress) => void) => UploadHandle<T>;
-    /** Cancel the upload */
-    cancel: () => void;
-}
-/**
- * State of a batch file upload operation
- */
-export interface UploadState {
-    isUploading: boolean;
-    currentFileName: string | null;
-    currentFileProgress: number;
-    uploadedBytes: number;
-    totalBytes: number;
-    completedFiles: number;
-    totalFiles: number;
-}
-export {};

package/dist/utils/fetch.d.ts

@@ -1,4 +0,0 @@
-import type { RequestOptions } from '../types/request';
-export declare function appendRequestParams(url: string, params?: RequestOptions['params']): string;
-export declare function toFetchBody(body: unknown): BodyInit | null | undefined;
-export declare function parseResponseErrorData(response: Response): Promise<unknown>;

package/dist/utils/jwt-retry.d.ts

@@ -1,5 +0,0 @@
-/**
- * Wrap a function with JWT retry logic.
- * On 401, calls refreshToken() and retries once.
- */
-export declare function withJWTRetry<T>(fn: () => Promise<T>, refreshToken: () => Promise<void>): Promise<T>;

package/dist/utils/node-url.d.ts

@@ -1,2 +0,0 @@
-export declare function getNodeBaseUrl(url: string): string;
-export declare function getNodeWebSocketUrl(url: string): string;

package/dist/utils/pingtest.d.ts

@@ -1,8 +0,0 @@
-export interface WebSocketPingOptions {
-    count?: number;
-    intervalMs?: number;
-    settleDelayMs?: number;
-    timeoutMs?: number;
-    signal?: AbortSignal;
-}
-export declare function pingWebSocketUrl(url: string, options?: WebSocketPingOptions): Promise<number>;

package/dist/utils/sse.d.ts

@@ -1,24 +0,0 @@
-import type { Archon } from '../modules/archon/types';
-export type ParsedSseEvent = {
-    kind: 'event';
-    id?: string;
-    event?: string;
-    data: string;
-};
-export type ParsedSseRetry = {
-    kind: 'retry';
-    retry: number;
-};
-export type ParsedSseItem = ParsedSseEvent | ParsedSseRetry;
-export declare class SseParser {
-    private buffer;
-    private eventName;
-    private data;
-    private id;
-    feed(chunk: string): ParsedSseItem[];
-    end(): ParsedSseItem[];
-    private findLineEnd;
-    private processLine;
-    private dispatch;
-}
-export declare function parseSyncEventData(data: string): Archon.Sync.v1.SyncEvent | null;

package/dist/utils/types.d.ts

@@ -1,2 +0,0 @@
-export type Override<T, R> = Omit<T, keyof R> & R;
-export type RawDecimal = string | number;