@modrinth/api-client 0.31.0 → 0.32.0

package/dist/modules/labrinth/users/v2.d.ts

@@ -1,101 +0,0 @@
-import { AbstractModule } from '../../../core/abstract-module';
-import type { Labrinth } from '../types';
-export declare class LabrinthUsersV2Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get a user by ID or username
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to the user data
-     *
-     * @example
-     * ```typescript
-     * const user = await client.labrinth.users_v2.get('my_user')
-     * ```
-     */
-    get(idOrUsername: string): Promise<Labrinth.Users.v2.User>;
-    /**
-     * Get multiple users by their IDs
-     *
-     * @param ids - Array of user IDs
-     * @returns Promise resolving to an array of users
-     *
-     * @example
-     * ```typescript
-     * const users = await client.labrinth.users_v2.getMultiple(['id1', 'id2'])
-     * ```
-     */
-    getMultiple(ids: string[]): Promise<Labrinth.Users.v2.User[]>;
-    /**
-     * Get a user's projects
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to an array of the user's projects
-     *
-     * @example
-     * ```typescript
-     * const projects = await client.labrinth.users_v2.getProjects('my_user')
-     * ```
-     */
-    getProjects(idOrUsername: string): Promise<Labrinth.Projects.v2.Project[]>;
-    /**
-     * Get a user's organizations
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to an array of the user's organizations
-     *
-     * @example
-     * ```typescript
-     * const orgs = await client.labrinth.users_v2.getOrganizations('my_user')
-     * ```
-     */
-    getOrganizations(idOrUsername: string): Promise<Labrinth.Organizations.v3.Organization[]>;
-    /**
-     * Get a user's collections
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to an array of the user's collections
-     *
-     * @example
-     * ```typescript
-     * const collections = await client.labrinth.users_v2.getCollections('my_user')
-     * ```
-     */
-    getCollections(idOrUsername: string): Promise<Labrinth.Collections.Collection[]>;
-    /**
-     * Get a user's notifications
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to an array of the user's notifications
-     *
-     * @example
-     * ```typescript
-     * const notifications = await client.labrinth.users_v2.getNotifications('my_user')
-     * ```
-     */
-    getNotifications(idOrUsername: string): Promise<Labrinth.Notifications.v2.Notification[]>;
-    /**
-     * Get projects a user follows
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to an array of followed projects
-     *
-     * @example
-     * ```typescript
-     * const projects = await client.labrinth.users_v2.getFollowedProjects('my_user')
-     * ```
-     */
-    getFollowedProjects(idOrUsername: string): Promise<Labrinth.Projects.v2.Project[]>;
-    /**
-     * Update a user
-     *
-     * @param idOrUsername - The user's ID or username
-     * @param data - Fields to update
-     *
-     * @example
-     * ```typescript
-     * await client.labrinth.users_v2.patch('my_user', { role: 'admin' })
-     * ```
-     */
-    patch(idOrUsername: string, data: Partial<Pick<Labrinth.Users.v2.User, 'badges' | 'role'>>): Promise<void>;
-}

package/dist/modules/labrinth/users/v3.d.ts

@@ -1,37 +0,0 @@
-import { AbstractModule } from '../../../core/abstract-module';
-import type { Labrinth } from '../types';
-export declare class LabrinthUsersV3Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get the authenticated user.
-     * GET /v3/user
-     */
-    getAuthenticated(): Promise<Labrinth.Users.v3.User>;
-    /**
-     * Get a user by ID or username
-     *
-     * @param idOrUsername - The user's ID or username
-     * @returns Promise resolving to the user data
-     *
-     * GET /v3/user/{id}
-     */
-    get(idOrUsername: string): Promise<Labrinth.Users.v3.User>;
-    /**
-     * Search users by username prefix.
-     *
-     * @param query - Username search query
-     * @returns Promise resolving to compact user search results
-     *
-     * GET /v3/users/search?query=:query
-     */
-    search(query: string): Promise<Labrinth.Users.v3.SearchUser[]>;
-    /**
-     * Get all projects the authenticated user can access directly or through
-     * their organizations.
-     *
-     * @param idOrUsername - User ID or username. Must be the authenticated user.
-     *
-     * GET /v3/user/{id}/all-projects
-     */
-    getAllProjects(idOrUsername: string): Promise<Labrinth.Users.v3.AllProjectsResponse>;
-}

package/dist/modules/labrinth/versions/v2.d.ts

@@ -1,75 +0,0 @@
-import { AbstractModule } from '../../../core/abstract-module';
-import type { Labrinth } from '../types';
-export declare class LabrinthVersionsV2Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get versions for a project (v2)
-     *
-     * @param id - Project ID or slug (e.g., 'sodium' or 'AANobbMI')
-     * @param options - Optional query parameters to filter versions
-     * @returns Promise resolving to an array of v2 versions
-     *
-     * @example
-     * ```typescript
-     * const versions = await client.labrinth.versions_v2.getProjectVersions('sodium')
-     * const filteredVersions = await client.labrinth.versions_v2.getProjectVersions('sodium', {
-     *   game_versions: ['1.20.1'],
-     *   loaders: ['fabric'],
-     *   include_changelog: false
-     * })
-     * console.log(versions[0].version_number)
-     * ```
-     */
-    getProjectVersions(id: string, options?: Labrinth.Versions.v2.GetProjectVersionsParams): Promise<Labrinth.Versions.v2.Version[]>;
-    /**
-     * Get a specific version by ID (v2)
-     *
-     * @param id - Version ID
-     * @returns Promise resolving to the v2 version data
-     *
-     * @example
-     * ```typescript
-     * const version = await client.labrinth.versions_v2.getVersion('DXtmvS8i')
-     * console.log(version.version_number)
-     * ```
-     */
-    getVersion(id: string): Promise<Labrinth.Versions.v2.Version>;
-    /**
-     * Get multiple versions by IDs (v2)
-     *
-     * @param ids - Array of version IDs
-     * @returns Promise resolving to an array of v2 versions
-     *
-     * @example
-     * ```typescript
-     * const versions = await client.labrinth.versions_v2.getVersions(['DXtmvS8i', 'abc123'])
-     * console.log(versions[0].version_number)
-     * ```
-     */
-    getVersions(ids: string[]): Promise<Labrinth.Versions.v2.Version[]>;
-    /**
-     * Get a version from a project by version ID or number (v2)
-     *
-     * @param projectId - Project ID or slug
-     * @param versionId - Version ID or version number
-     * @returns Promise resolving to the v2 version data
-     *
-     * @example
-     * ```typescript
-     * const version = await client.labrinth.versions_v2.getVersionFromIdOrNumber('sodium', 'DXtmvS8i')
-     * const versionByNumber = await client.labrinth.versions_v2.getVersionFromIdOrNumber('sodium', '0.4.12')
-     * ```
-     */
-    getVersionFromIdOrNumber(projectId: string, versionId: string): Promise<Labrinth.Versions.v2.Version>;
-    /**
-     * Delete a version by ID (v2)
-     *
-     * @param versionId - Version ID
-     *
-     * @example
-     * ```typescript
-     * await client.labrinth.versions_v2.deleteVersion('DXtmvS8i')
-     * ```
-     */
-    deleteVersion(versionId: string): Promise<void>;
-}

package/dist/modules/labrinth/versions/v3.d.ts

@@ -1,123 +0,0 @@
-import { AbstractModule } from '../../../core/abstract-module';
-import type { UploadHandle } from '../../../types/upload';
-import type { Labrinth } from '../types';
-export declare class LabrinthVersionsV3Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get versions for a project (v3)
-     *
-     * @param id - Project ID or slug (e.g., 'sodium' or 'AANobbMI')
-     * @param options - Optional query parameters to filter versions
-     * @returns Promise resolving to an array of v3 versions
-     *
-     * @example
-     * ```typescript
-     * const versions = await client.labrinth.versions_v3.getProjectVersions('sodium')
-     * const filteredVersions = await client.labrinth.versions_v3.getProjectVersions('sodium', {
-     *   game_versions: ['1.20.1'],
-     *   loaders: ['fabric']
-     * })
-     * console.log(versions[0].version_number)
-     * ```
-     */
-    getProjectVersions(id: string, options?: Labrinth.Versions.v3.GetProjectVersionsParams): Promise<Labrinth.Versions.v3.Version[]>;
-    /**
-     * Get a specific version by ID (v3)
-     *
-     * @param id - Version ID
-     * @returns Promise resolving to the v3 version data
-     *
-     * @example
-     * ```typescript
-     * const version = await client.labrinth.versions_v3.getVersion('DXtmvS8i')
-     * console.log(version.version_number)
-     * ```
-     */
-    getVersion(id: string): Promise<Labrinth.Versions.v3.Version>;
-    /**
-     * Get multiple versions by IDs (v3)
-     *
-     * @param ids - Array of version IDs
-     * @returns Promise resolving to an array of v3 versions
-     *
-     * @example
-     * ```typescript
-     * const versions = await client.labrinth.versions_v3.getVersions(['DXtmvS8i', 'abc123'])
-     * console.log(versions[0].version_number)
-     * ```
-     */
-    getVersions(ids: string[]): Promise<Labrinth.Versions.v3.Version[]>;
-    /**
-     * Get a version from a project by version ID or number (v3)
-     *
-     * @param projectId - Project ID or slug
-     * @param versionId - Version ID or version number
-     * @returns Promise resolving to the v3 version data
-     *
-     * @example
-     * ```typescript
-     * const version = await client.labrinth.versions_v3.getVersionFromIdOrNumber('sodium', 'DXtmvS8i')
-     * const versionByNumber = await client.labrinth.versions_v3.getVersionFromIdOrNumber('sodium', '0.4.12')
-     * ```
-     */
-    getVersionFromIdOrNumber(projectId: string, versionId: string): Promise<Labrinth.Versions.v3.Version>;
-    /**
-     * Create a new version for a project (v3)
-     *
-     * Creates a new version on an existing project. At least one file must be
-     * attached unless the version is created as a draft.
-     *
-     * @param data - JSON metadata payload for the version (must include file_parts)
-     * @param files - Array of uploaded files, in the same order as `data.file_parts`
-     *
-     * @returns A promise resolving to the newly created version data
-     *
-     * @example
-     * ```ts
-     * const version = await client.labrinth.versions_v3.createVersion('sodium', {
-     *   name: 'v0.5.0',
-     *   version_number: '0.5.0',
-     *   version_type: 'release',
-     *   loaders: ['fabric'],
-     *   game_versions: ['1.20.1'],
-     *   project_id: 'sodium',
-     *   file_parts: ['primary']
-     * }, [fileObject])
-     * ```
-     */
-    createVersion(draftVersion: Labrinth.Versions.v3.DraftVersion, versionFiles: Labrinth.Versions.v3.DraftVersionFile[], projectType?: Labrinth.Projects.v2.ProjectType | null): UploadHandle<Labrinth.Versions.v3.Version>;
-    /**
-     * Modify an existing version by ID (v3)
-     *
-     * Partially updates a version’s metadata. Only JSON fields may be modified.
-     * To update files, use the separate "Add files to version" endpoint.
-     *
-     * @param versionId - The version ID to update
-     * @param data - PATCH metadata for this version (all fields optional)
-     *
-     * @returns A promise resolving to the updated version data
-     *
-     * @example
-     * ```ts
-     * const updated = await client.labrinth.versions_v3.modifyVersion('DXtmvS8i', {
-     *   name: 'v1.0.1',
-     *   changelog: 'Updated changelog',
-     *   featured: true,
-     *   status: 'listed'
-     * })
-     * ```
-     */
-    modifyVersion(versionId: string, data: Labrinth.Versions.v3.ModifyVersionRequest): Promise<Labrinth.Versions.v3.Version>;
-    /**
-     * Delete a version by ID (v3)
-     *
-     * @param versionId - Version ID
-     *
-     * @example
-     * ```typescript
-     * await client.labrinth.versions_v3.deleteVersion('DXtmvS8i')
-     * ```
-     */
-    deleteVersion(versionId: string): Promise<void>;
-    addFilesToVersion(versionId: string, versionFiles: Labrinth.Versions.v3.DraftVersionFile[]): UploadHandle<Labrinth.Versions.v3.Version>;
-}

package/dist/modules/launcher-meta/types.d.ts

@@ -1,25 +0,0 @@
-export declare namespace LauncherMeta {
-    namespace Manifest {
-        namespace v0 {
-            type LoaderVersion = {
-                id: string;
-                url: string;
-                stable: boolean;
-            };
-            type GameVersionEntry = {
-                id: string;
-                stable: boolean;
-                versionGroup?: string;
-                loaders: LoaderVersion[];
-            };
-            type VersionGroup = {
-                id: string;
-                loaders: LoaderVersion[];
-            };
-            type Manifest = {
-                gameVersions: GameVersionEntry[];
-                versionGroups?: VersionGroup[];
-            };
-        }
-    }
-}

package/dist/modules/launcher-meta/v0.d.ts

@@ -1,17 +0,0 @@
-import { AbstractModule } from '../../core/abstract-module';
-import type { LauncherMeta } from './types';
-export type { LauncherMeta } from './types';
-export declare class LauncherMetaManifestV0Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get the loader manifest for a given loader platform.
-     *
-     * launcher-meta refuses CORS preflights that ask for the `Content-Type`
-     * header (returns 403), so we strip the default `Content-Type: application/json`
-     * the abstract client sets — these are body-less GETs and don't need it.
-     * Without this the browser preflight is rejected and the GET never fires.
-     *
-     * @param loader - Loader platform (fabric, forge, quilt, neo)
-     */
-    getManifest(loader: string, formatVersion?: number): Promise<LauncherMeta.Manifest.v0.Manifest>;
-}

package/dist/modules/mclogs/insights/v1.d.ts

@@ -1,6 +0,0 @@
-import { AbstractModule } from '../../../core/abstract-module';
-import type { Mclogs } from '../types';
-export declare class MclogsInsightsV1Module extends AbstractModule {
-    getModuleID(): string;
-    analyse(content: string): Promise<Mclogs.Insights.v1.InsightsResponse>;
-}

package/dist/modules/mclogs/logs/v1.d.ts

@@ -1,6 +0,0 @@
-import { AbstractModule } from '../../../core/abstract-module';
-import type { Mclogs } from '../types';
-export declare class MclogsLogsV1Module extends AbstractModule {
-    getModuleID(): string;
-    create(content: string): Promise<Mclogs.Logs.v1.CreateResponse>;
-}

package/dist/modules/mclogs/types.d.ts

@@ -1,60 +0,0 @@
-export declare namespace Mclogs {
-    namespace Insights {
-        namespace v1 {
-            type LogEntry = {
-                level: number;
-                time: string | null;
-                prefix: string;
-                lines: Array<{
-                    number: number;
-                    content: string;
-                }>;
-            };
-            type Solution = {
-                message: string;
-            };
-            type Problem = {
-                message: string;
-                counter: number;
-                entry: LogEntry;
-                solutions: Solution[];
-            };
-            type Information = {
-                message: string;
-                counter: number;
-                label: string;
-                value: string;
-                entry: LogEntry;
-            };
-            type Analysis = {
-                problems: Problem[];
-                information: Information[];
-            };
-            type InsightsResponse = {
-                id: string;
-                name: string;
-                type: string;
-                version: string;
-                title: string;
-                analysis: Analysis;
-            };
-        }
-    }
-    namespace Logs {
-        namespace v1 {
-            type CreateResponse = {
-                success: boolean;
-                id: string;
-                source: string | null;
-                created: number;
-                expires: number;
-                size: number;
-                lines: number;
-                errors: number;
-                url: string;
-                raw: string;
-                token: string;
-            };
-        }
-    }
-}

package/dist/modules/paper/types.d.ts

@@ -1,22 +0,0 @@
-export declare namespace Paper {
-    namespace Versions {
-        namespace v3 {
-            type Project = {
-                project: {
-                    id: string;
-                    name: string;
-                };
-                versions: Record<string, string[]>;
-            };
-            type BuildChannel = 'STABLE' | 'BETA' | 'ALPHA';
-            type Build = {
-                id: number;
-                time: string;
-                channel: BuildChannel | string;
-            };
-            type VersionBuilds = {
-                builds: Build[];
-            };
-        }
-    }
-}

package/dist/modules/paper/v3.d.ts

@@ -1,19 +0,0 @@
-import { AbstractModule } from '../../core/abstract-module';
-import type { Paper } from './types';
-export type { Paper } from './types';
-export declare class PaperVersionsV3Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get the Paper project info including all supported Minecraft versions.
-     */
-    getProject(): Promise<Paper.Versions.v3.Project>;
-    /**
-     * Get available Paper builds for a Minecraft version (includes channel per build).
-     *
-     * Fill (`fill.papermc.io`) returns a JSON array of builds at this path — not a `{ builds }`
-     * wrapper like some other Paper API shapes — so we normalize to `VersionBuilds`.
-     *
-     * @param mcVersion - Minecraft version (e.g. "1.21.4")
-     */
-    getBuilds(mcVersion: string): Promise<Paper.Versions.v3.VersionBuilds>;
-}

package/dist/modules/purpur/types.d.ts

@@ -1,15 +0,0 @@
-export declare namespace Purpur {
-    namespace Versions {
-        namespace v2 {
-            type Project = {
-                project: string;
-                versions: string[];
-            };
-            type VersionBuilds = {
-                builds: {
-                    all: string[];
-                };
-            };
-        }
-    }
-}

package/dist/modules/purpur/v2.d.ts

@@ -1,16 +0,0 @@
-import { AbstractModule } from '../../core/abstract-module';
-import type { Purpur } from './types';
-export type { Purpur } from './types';
-export declare class PurpurVersionsV2Module extends AbstractModule {
-    getModuleID(): string;
-    /**
-     * Get the Purpur project info including all supported Minecraft versions.
-     */
-    getProject(): Promise<Purpur.Versions.v2.Project>;
-    /**
-     * Get available Purpur builds for a Minecraft version.
-     *
-     * @param mcVersion - Minecraft version (e.g. "1.21.4")
-     */
-    getBuilds(mcVersion: string): Promise<Purpur.Versions.v2.VersionBuilds>;
-}

package/dist/modules/types.d.ts

@@ -1,8 +0,0 @@
-export * from './archon/types';
-export * from './iso3166/types';
-export * from './kyros/types';
-export * from './labrinth/types';
-export * from './launcher-meta/types';
-export * from './mclogs/types';
-export * from './paper/types';
-export * from './purpur/types';

package/dist/platform/generic.d.ts

@@ -1,28 +0,0 @@
-import { ModrinthApiError } from '../core/errors';
-import type { ClientConfig } from '../types/client';
-import type { RequestOptions } from '../types/request';
-import { XHRUploadClient } from './xhr-upload-client';
-/**
- * Generic platform client using ofetch
- *
- * This client works in any JavaScript environment (Node.js, browser, workers, etc).
- *
- * @example
- * ```typescript
- * const client = new GenericModrinthClient({
- *   userAgent: 'my-app/1.0.0',
- *   features: [
- *     new AuthFeature({ token: async () => getOAuthToken() }),
- *     new RetryFeature({ maxAttempts: 3 })
- *   ]
- * })
- *
- * const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 })
- * ```
- */
-export declare class GenericModrinthClient extends XHRUploadClient {
-    constructor(config: ClientConfig);
-    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/nuxt.d.ts

@@ -1,88 +0,0 @@
-import { ModrinthApiError } from '../core/errors';
-import type { CircuitBreakerState, CircuitBreakerStorage } from '../features/circuit-breaker';
-import type { ClientConfig } from '../types/client';
-import type { RequestOptions } from '../types/request';
-import type { UploadHandle, UploadRequestOptions } from '../types/upload';
-import { XHRUploadClient } from './xhr-upload-client';
-/**
- * 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.
- *
- * Note: useState must be called during initialization (in setup context) and cached,
- * as it won't work during async operations when the Nuxt context may be lost.
- */
-export declare class NuxtCircuitBreakerStorage implements CircuitBreakerStorage {
-    private state;
-    constructor();
-    get(key: string): CircuitBreakerState | undefined;
-    set(key: string, state: CircuitBreakerState): void;
-    clear(key: string): void;
-}
-/**
- * Nuxt-specific configuration
- */
-export interface NuxtClientConfig extends ClientConfig {
-    /**
-     * Rate limit key for server-side requests.
-     * This is injected as x-ratelimit-key header on server-side.
-     * Can be a string (for env var) or async function (for CF Secrets Store).
-     */
-    rateLimitKey?: string | (() => Promise<string | undefined>);
-}
-/**
- * Nuxt platform client using Nuxt's $fetch
- *
- * This client is optimized for Nuxt applications and handles SSR/CSR automatically.
- *
- * Note: upload() is only available in browser context (CSR). It will throw during SSR.
- *
- * @example
- * ```typescript
- * // In a Nuxt composable
- * const config = useRuntimeConfig()
- *
- * const client = new NuxtModrinthClient({
- *   userAgent: 'my-nuxt-app/1.0.0',
- *   rateLimitKey: import.meta.server ? config.rateLimitKey : undefined,
- *   features: [
- *     new AuthFeature({
- *       token: async () => getOAuthToken()
- *     }),
- *     new CircuitBreakerFeature({
- *       storage: new NuxtCircuitBreakerStorage()
- *     })
- *   ]
- * })
- *
- * const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 })
- * ```
- */
-export declare class NuxtModrinthClient extends XHRUploadClient {
-    protected config: NuxtClientConfig;
-    private rateLimitKeyResolved;
-    private rateLimitKeyPromise;
-    constructor(config: NuxtClientConfig);
-    /**
-     * Resolve the rate limit key, handling both string and async function values.
-     * Results are cached for subsequent calls.
-     */
-    private resolveRateLimitKey;
-    /**
-     * Override request to resolve rate limit key before calling super.
-     * This allows async fetching of the key from CF Secrets Store.
-     */
-    request<T>(path: string, options: RequestOptions): Promise<T>;
-    /**
-     * Upload a file with progress tracking
-     *
-     * Note: This method is only available in browser context (CSR).
-     * Calling during SSR will throw an error.
-     */
-    upload<T = void>(path: string, options: UploadRequestOptions): UploadHandle<T>;
-    protected executeRequest<T>(url: string, options: RequestOptions): Promise<T>;
-    protected executeStreamRequest(url: string, options: RequestOptions): Promise<ReadableStream<Uint8Array>>;
-    protected normalizeError(error: unknown): ModrinthApiError;
-    protected buildDefaultHeaders(): Promise<Record<string, string>>;
-}

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

@@ -1,16 +0,0 @@
-import { AbstractSyncClient, type SyncConnectOptions, type SyncEmitterEvents } from '../core/abstract-sync';
-export declare class GenericSyncClient extends AbstractSyncClient {
-    protected emitter: import("mitt").Emitter<SyncEmitterEvents>;
-    safeConnectServer(serverId: string, options?: SyncConnectOptions): Promise<void>;
-    disconnect(serverId: string): void;
-    disconnectAll(): void;
-    private runConnection;
-    private consumeStream;
-    private processParsedItems;
-    private waitForReconnect;
-    private closeConnection;
-    private getReconnectDelay;
-    private updateLastEventId;
-    private intentToParam;
-    private isAbortError;
-}