dmclc/lib/mods/download/ContentService.d.ts

Dolphin Minecraft Launcher Core

import { MinecraftVersion } from "../../version.js";
/**
 * A content version.
 */
export interface ContentVersion {
    getVersionFileURL(): Promise<string>;
    getVersionFileSHA1(): Promise<string>;
    getVersionFileName(): Promise<string>;
    /**
     * @throws RequestError
     */
    getVersionChangelog(): Promise<string>;
    getVersionNumber(): Promise<string>;
    /**
     * @throws RequestError
     */
    getContent(): Promise<Content>;
    /**
     * @throws RequestError
     */
    listDependencies(): Promise<(Content | ContentVersion)[]>;
    isVersion: true;
}
export type Screenshot = {
    url: string;
    title?: string;
    description?: string;
};
export declare enum ContentType {
    MODPACK = 0,
    SHADER = 1,
    MOD = 2,
    RESOURCE_PACK = 3,
    DATA_PACK = 4,
    WORLD = 5
}
/**
 * A Content posting service. For example: Modrinth, CurseForge.
 */
export interface ContentService<SortField> {
    /**
     * @param name Searching string.
     * @param skip The number of results to skip.
     * @param limit The number of results will return.
     * @param forVersion The Minecraft version you download for.
     * @throws RequestError
     */
    searchContent(name: string, skip: number, limit: number, type: ContentType, sortField: SortField, forVersion?: MinecraftVersion): Promise<Content[]>;
    getUnsupportedContentTypes(): ContentType[];
    getSortFields(): Record<string, SortField>;
    getDefaultSortField(): SortField;
    /**
     * @throws RequestError
     * @param path The mod file path
     */
    getVersionFromFile(path: string): Promise<ContentVersion | null>;
}
export interface Content {
    /**
     * List versions.
     * @param forVersion The Minecraft version you download for.
     * @throws RequestError
     */
    listVersions(forVersion?: MinecraftVersion): Promise<ContentVersion[]>;
    getTitle(): Promise<string>;
    getDescription(): Promise<string>;
    /**
     * @throws RequestError
     */
    getBody(): Promise<string>;
    getIconURL(): Promise<string>;
    getURLs(): Promise<Map<string, string>>;
    getScreenshots(): Promise<Screenshot[]>;
    getOtherInformation(): Promise<Map<string, string>>;
    isLibrary(): Promise<boolean>;
    getType(): ContentType;
    isVersion: false;
}