Modrinth-plus/packages/api-client/src/core/abstract-upload-client.ts

import type { UploadHandle, UploadRequestOptions } from '../types/upload'

/**
 * Abstract base class defining upload capability
 *
 * All clients that support file uploads must extend this class.
 * Platform-specific implementations should provide the actual upload mechanism
 * (e.g., XHR for browser environments).
 *
 * Upload goes through the feature chain (auth, retry, circuit-breaker, etc.)
 * just like regular requests.
 */
export abstract class AbstractUploadClient {
	/**
	 * Upload a file or FormData with progress tracking
	 * @param path - API path (e.g., '/fs/create')
	 * @param options - Upload options including file or formData, api, version
	 * @returns UploadHandle with promise, onProgress chain, and cancel method
	 */
	abstract upload<T = void>(path: string, options: UploadRequestOptions): UploadHandle<T>
}