curseforge-js 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from './base.js';
+export * from './categories.js';
+export * from './files.js';
+export * from './fingerprints.js';
+export * from './games.js';
+export * from './minecraft.js';
+export * from './mods.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,8 @@
+export * from './base.js';
+export * from './categories.js';
+export * from './files.js';
+export * from './fingerprints.js';
+export * from './games.js';
+export * from './minecraft.js';
+export * from './mods.js';
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/types/minecraft.d.ts

@@ -0,0 +1,84 @@
+import type { GameVersionStatus, GameVersionTypeStatus } from './games.js';
+/** A Minecraft mod loader kind. */
+export declare enum ModLoaderType {
+    Any = 0,
+    Forge = 1,
+    Cauldron = 2,
+    LiteLoader = 3,
+    Fabric = 4,
+    Quilt = 5,
+    NeoForge = 6
+}
+/** Install method used by a Minecraft mod loader version. */
+export declare enum ModLoaderInstallMethod {
+    ForgeInstaller = 1,
+    ForgeJarInstall = 2,
+    ForgeInstaller_v2 = 3,
+    FabricInstaller = 4,
+    QuiltInstaller = 5,
+    NeoForgeInstaller = 6
+}
+/** A single Minecraft game version. */
+export interface MinecraftGameVersion {
+    id: number;
+    gameVersionId: number;
+    versionString: string;
+    jarDownloadUrl: string;
+    jsonDownloadUrl: string;
+    approved: boolean;
+    dateModified: string;
+    gameVersionTypeId: number;
+    gameVersionStatus: GameVersionStatus;
+    gameVersionTypeStatus: GameVersionTypeStatus;
+}
+/** A condensed entry describing the latest/recommended version of a Minecraft mod loader. */
+export interface MinecraftModLoaderIndex {
+    name: string;
+    gameVersion: string;
+    latest: boolean;
+    recommended: boolean;
+    dateModified: string;
+    type: ModLoaderType;
+}
+/** Full details for a specific Minecraft mod loader version. */
+export interface MinecraftModLoaderVersion {
+    id: number;
+    gameVersionId: number;
+    minecraftGameVersionId: number;
+    forgeVersion: string;
+    name: string;
+    type: ModLoaderType;
+    downloadUrl: string;
+    filename: string;
+    installMethod: ModLoaderInstallMethod;
+    latest: boolean;
+    recommended: boolean;
+    approved: boolean;
+    dateModified: string;
+    mavenVersionString: string;
+    versionJson: string;
+    librariesInstallLocation: string;
+    minecraftVersion: string;
+    additionalFilesJson: string;
+    modLoaderGameVersionId: number;
+    modLoaderGameVersionTypeId: number;
+    modLoaderGameVersionStatus: GameVersionStatus;
+    modLoaderGameVersionTypeStatus: GameVersionTypeStatus;
+    mcGameVersionId: number;
+    mcGameVersionTypeId: number;
+    mcGameVersionStatus: GameVersionStatus;
+    mcGameVersionTypeStatus: GameVersionTypeStatus;
+    installProfileJson: string;
+}
+/** Query parameters for {@link MinecraftApi.getVersions}. */
+export interface GetMinecraftVersionsOptions {
+    sortDescending?: boolean;
+}
+/** Query parameters for {@link MinecraftApi.getModLoaders}. */
+export interface GetMinecraftModLoadersOptions {
+    /** Filter mod loaders by Minecraft game version. */
+    version?: string;
+    /** Include all mod loaders, not just the latest/recommended ones. */
+    includeAll?: boolean;
+}
+//# sourceMappingURL=minecraft.d.ts.map

package/dist/types/minecraft.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"minecraft.d.ts","sourceRoot":"","sources":["../../src/types/minecraft.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAE3E,mCAAmC;AACnC,oBAAY,aAAa;IACvB,GAAG,IAAI;IACP,KAAK,IAAI;IACT,QAAQ,IAAI;IACZ,UAAU,IAAI;IACd,MAAM,IAAI;IACV,KAAK,IAAI;IACT,QAAQ,IAAI;CACb;AAED,6DAA6D;AAC7D,oBAAY,sBAAsB;IAChC,cAAc,IAAI;IAClB,eAAe,IAAI;IACnB,iBAAiB,IAAI;IACrB,eAAe,IAAI;IACnB,cAAc,IAAI;IAClB,iBAAiB,IAAI;CACtB;AAED,uCAAuC;AACvC,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,qBAAqB,EAAE,qBAAqB,CAAC;CAC9C;AAED,6FAA6F;AAC7F,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,gEAAgE;AAChE,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,sBAAsB,CAAC;IACtC,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,wBAAwB,EAAE,MAAM,CAAC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,0BAA0B,EAAE,MAAM,CAAC;IACnC,0BAA0B,EAAE,iBAAiB,CAAC;IAC9C,8BAA8B,EAAE,qBAAqB,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,iBAAiB,CAAC;IACvC,uBAAuB,EAAE,qBAAqB,CAAC;IAC/C,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,6DAA6D;AAC7D,MAAM,WAAW,2BAA2B;IAC1C,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,+DAA+D;AAC/D,MAAM,WAAW,6BAA6B;IAC5C,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/types/minecraft.js

@@ -0,0 +1,22 @@
+/** A Minecraft mod loader kind. */
+export var ModLoaderType;
+(function (ModLoaderType) {
+    ModLoaderType[ModLoaderType["Any"] = 0] = "Any";
+    ModLoaderType[ModLoaderType["Forge"] = 1] = "Forge";
+    ModLoaderType[ModLoaderType["Cauldron"] = 2] = "Cauldron";
+    ModLoaderType[ModLoaderType["LiteLoader"] = 3] = "LiteLoader";
+    ModLoaderType[ModLoaderType["Fabric"] = 4] = "Fabric";
+    ModLoaderType[ModLoaderType["Quilt"] = 5] = "Quilt";
+    ModLoaderType[ModLoaderType["NeoForge"] = 6] = "NeoForge";
+})(ModLoaderType || (ModLoaderType = {}));
+/** Install method used by a Minecraft mod loader version. */
+export var ModLoaderInstallMethod;
+(function (ModLoaderInstallMethod) {
+    ModLoaderInstallMethod[ModLoaderInstallMethod["ForgeInstaller"] = 1] = "ForgeInstaller";
+    ModLoaderInstallMethod[ModLoaderInstallMethod["ForgeJarInstall"] = 2] = "ForgeJarInstall";
+    ModLoaderInstallMethod[ModLoaderInstallMethod["ForgeInstaller_v2"] = 3] = "ForgeInstaller_v2";
+    ModLoaderInstallMethod[ModLoaderInstallMethod["FabricInstaller"] = 4] = "FabricInstaller";
+    ModLoaderInstallMethod[ModLoaderInstallMethod["QuiltInstaller"] = 5] = "QuiltInstaller";
+    ModLoaderInstallMethod[ModLoaderInstallMethod["NeoForgeInstaller"] = 6] = "NeoForgeInstaller";
+})(ModLoaderInstallMethod || (ModLoaderInstallMethod = {}));
+//# sourceMappingURL=minecraft.js.map

package/dist/types/minecraft.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minecraft.js","sourceRoot":"","sources":["../../src/types/minecraft.ts"],"names":[],"mappings":"AAEA,mCAAmC;AACnC,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,+CAAO,CAAA;IACP,mDAAS,CAAA;IACT,yDAAY,CAAA;IACZ,6DAAc,CAAA;IACd,qDAAU,CAAA;IACV,mDAAS,CAAA;IACT,yDAAY,CAAA;AACd,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAED,6DAA6D;AAC7D,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,uFAAkB,CAAA;IAClB,yFAAmB,CAAA;IACnB,6FAAqB,CAAA;IACrB,yFAAmB,CAAA;IACnB,uFAAkB,CAAA;IAClB,6FAAqB,CAAA;AACvB,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC"}

package/dist/types/mods.d.ts

@@ -0,0 +1,171 @@
+import type { Category } from './categories.js';
+import type { File, FileIndex } from './files.js';
+import type { ModLoaderType } from './minecraft.js';
+import type { PaginationOptions } from './base.js';
+/** The approval status of a mod. */
+export declare enum ModStatus {
+    New = 1,
+    ChangesRequired = 2,
+    UnderSoftReview = 3,
+    Approved = 4,
+    Rejected = 5,
+    ChangesMade = 6,
+    Inactive = 7,
+    Abandoned = 8,
+    Deleted = 9,
+    UnderReview = 10
+}
+/** Field to sort mod search results by. */
+export declare enum ModsSearchSortField {
+    Featured = 1,
+    Popularity = 2,
+    LastUpdated = 3,
+    Name = 4,
+    Author = 5,
+    TotalDownloads = 6,
+    Category = 7,
+    GameVersion = 8,
+    EarlyAccess = 9,
+    FeaturedReleased = 10,
+    ReleasedDate = 11,
+    Rating = 12
+}
+/** Sort direction for mod search results. */
+export type SortOrder = 'asc' | 'desc';
+/** Relevant external links for a mod. */
+export interface ModLinks {
+    websiteUrl: string;
+    wikiUrl: string;
+    issuesUrl: string;
+    sourceUrl: string;
+}
+/** An author of a mod. */
+export interface ModAuthor {
+    id: number;
+    name: string;
+    url: string;
+}
+/** An image asset (logo or screenshot) belonging to a mod. */
+export interface ModAsset {
+    id: number;
+    modId: number;
+    title: string;
+    description: string;
+    thumbnailUrl: string;
+    url: string;
+}
+/** A mod (project) on CurseForge. */
+export interface Mod {
+    /** The mod id. */
+    id: number;
+    /** The game id this mod is for. */
+    gameId: number;
+    /** The name of the mod. */
+    name: string;
+    /** The mod slug that would appear in the URL. */
+    slug: string;
+    /** Relevant links for the mod, such as issue tracker and wiki. */
+    links: ModLinks;
+    /** Mod summary. */
+    summary: string;
+    /** Current mod status. */
+    status: ModStatus;
+    /** Number of downloads for the mod. */
+    downloadCount: number;
+    /** Whether the mod is included in the featured mods list. */
+    isFeatured: boolean;
+    /** The main category of the mod as chosen by its author. */
+    primaryCategoryId: number;
+    /** List of the mod's categories. */
+    categories: Category[];
+    /** The class id this mod belongs to. */
+    classId: number | null;
+    /** List of the mod's authors. */
+    authors: ModAuthor[];
+    /** The mod's logo asset. */
+    logo: ModAsset;
+    /** List of screenshot assets. */
+    screenshots: ModAsset[];
+    /** The id of the mod's main file. */
+    mainFileId: number;
+    /** List of the mod's latest files. */
+    latestFiles: File[];
+    /** File related details for the latest files of the mod. */
+    latestFilesIndexes: FileIndex[];
+    /** File related details for the latest early access files of the mod. */
+    latestEarlyAccessFilesIndexes: FileIndex[];
+    /** The creation date of the mod. */
+    dateCreated: string;
+    /** The last time the mod was modified. */
+    dateModified: string;
+    /** The release date of the mod. */
+    dateReleased: string;
+    /** Whether the mod is allowed to be distributed. */
+    allowModDistribution: boolean | null;
+    /** The mod's popularity rank for its game. */
+    gamePopularityRank: number;
+    /** Whether the mod is available for search (false if experimental, deleted, or alpha-only). */
+    isAvailable: boolean;
+    /** The mod's thumbs up count. */
+    thumbsUpCount: number;
+    /** The mod's rating. */
+    rating: number | null;
+}
+/** Featured, popular, and recently updated mods. */
+export interface FeaturedModsResponse {
+    featured: Mod[];
+    popular: Mod[];
+    recentlyUpdated: Mod[];
+}
+/** Query parameters for {@link ModsApi.search}. */
+export interface SearchModsOptions extends PaginationOptions {
+    /** Filter by game id. */
+    gameId: number;
+    /** Filter by section id, discoverable via {@link CategoriesApi.list} with `classesOnly`. */
+    classId?: number;
+    /** Filter by category id. */
+    categoryId?: number;
+    /** Filter by a list of category ids. Overrides `categoryId`. Maximum of 10 ids. */
+    categoryIds?: number[];
+    /** Filter by game version string. */
+    gameVersion?: string;
+    /** Filter by a list of game version strings. Overrides `gameVersion`. Maximum of 4. */
+    gameVersions?: string[];
+    /** Filter by free text search in mod name and author. */
+    searchFilter?: string;
+    /** Field to sort results by. */
+    sortField?: ModsSearchSortField;
+    /** Sort direction. */
+    sortOrder?: SortOrder;
+    /** Filter mods associated with the given mod loader. Must be used with `gameVersion`. */
+    modLoaderType?: ModLoaderType;
+    /** Filter by a list of mod loader types. Overrides `modLoaderType`. Maximum of 5. */
+    modLoaderTypes?: ModLoaderType[];
+    /** Filter mods with files tagged with versions of the given game version type id. */
+    gameVersionTypeId?: number;
+    /** Filter mods where the given author id is a member. */
+    authorId?: number;
+    /** Filter mods where the given author id is the primary/owning author. */
+    primaryAuthorId?: number;
+    /** Filter by slug. Combined with `classId`, this results in a unique result. */
+    slug?: string;
+}
+/** Query parameters for {@link ModsApi.getDescription}. */
+export interface GetModDescriptionOptions {
+    raw?: boolean;
+    stripped?: boolean;
+    markup?: boolean;
+}
+/** Request body for {@link ModsApi.getMods}. */
+export interface GetModsByIdsListRequestBody {
+    /** List of mod ids. All mods must belong to the same game. */
+    modIds: number[];
+    filterPcOnly?: boolean | null;
+}
+/** Request body for {@link ModsApi.getFeatured}. */
+export interface GetFeaturedModsRequestBody {
+    gameId: number;
+    excludedModIds?: number[];
+    gameVersionTypeId?: number | null;
+}
+//# sourceMappingURL=mods.d.ts.map

package/dist/types/mods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mods.d.ts","sourceRoot":"","sources":["../../src/types/mods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEnD,oCAAoC;AACpC,oBAAY,SAAS;IACnB,GAAG,IAAI;IACP,eAAe,IAAI;IACnB,eAAe,IAAI;IACnB,QAAQ,IAAI;IACZ,QAAQ,IAAI;IACZ,WAAW,IAAI;IACf,QAAQ,IAAI;IACZ,SAAS,IAAI;IACb,OAAO,IAAI;IACX,WAAW,KAAK;CACjB;AAED,2CAA2C;AAC3C,oBAAY,mBAAmB;IAC7B,QAAQ,IAAI;IACZ,UAAU,IAAI;IACd,WAAW,IAAI;IACf,IAAI,IAAI;IACR,MAAM,IAAI;IACV,cAAc,IAAI;IAClB,QAAQ,IAAI;IACZ,WAAW,IAAI;IACf,WAAW,IAAI;IACf,gBAAgB,KAAK;IACrB,YAAY,KAAK;IACjB,MAAM,KAAK;CACZ;AAED,6CAA6C;AAC7C,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;AAEvC,yCAAyC;AACzC,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,0BAA0B;AAC1B,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,8DAA8D;AAC9D,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,qCAAqC;AACrC,MAAM,WAAW,GAAG;IAClB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,KAAK,EAAE,QAAQ,CAAC;IAChB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,MAAM,EAAE,SAAS,CAAC;IAClB,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,6DAA6D;IAC7D,UAAU,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oCAAoC;IACpC,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,wCAAwC;IACxC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iCAAiC;IACjC,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,4BAA4B;IAC5B,IAAI,EAAE,QAAQ,CAAC;IACf,iCAAiC;IACjC,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,WAAW,EAAE,IAAI,EAAE,CAAC;IACpB,4DAA4D;IAC5D,kBAAkB,EAAE,SAAS,EAAE,CAAC;IAChC,yEAAyE;IACzE,6BAA6B,EAAE,SAAS,EAAE,CAAC;IAC3C,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,8CAA8C;IAC9C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,+FAA+F;IAC/F,WAAW,EAAE,OAAO,CAAC;IACrB,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,oDAAoD;AACpD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChB,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,eAAe,EAAE,GAAG,EAAE,CAAC;CACxB;AAED,mDAAmD;AACnD,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,4FAA4F;IAC5F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uFAAuF;IACvF,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,sBAAsB;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,yFAAyF;IACzF,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,qFAAqF;IACrF,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,qFAAqF;IACrF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,2DAA2D;AAC3D,MAAM,WAAW,wBAAwB;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,gDAAgD;AAChD,MAAM,WAAW,2BAA2B;IAC1C,8DAA8D;IAC9D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAED,oDAAoD;AACpD,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC"}

package/dist/types/mods.js

@@ -0,0 +1,31 @@
+/** The approval status of a mod. */
+export var ModStatus;
+(function (ModStatus) {
+    ModStatus[ModStatus["New"] = 1] = "New";
+    ModStatus[ModStatus["ChangesRequired"] = 2] = "ChangesRequired";
+    ModStatus[ModStatus["UnderSoftReview"] = 3] = "UnderSoftReview";
+    ModStatus[ModStatus["Approved"] = 4] = "Approved";
+    ModStatus[ModStatus["Rejected"] = 5] = "Rejected";
+    ModStatus[ModStatus["ChangesMade"] = 6] = "ChangesMade";
+    ModStatus[ModStatus["Inactive"] = 7] = "Inactive";
+    ModStatus[ModStatus["Abandoned"] = 8] = "Abandoned";
+    ModStatus[ModStatus["Deleted"] = 9] = "Deleted";
+    ModStatus[ModStatus["UnderReview"] = 10] = "UnderReview";
+})(ModStatus || (ModStatus = {}));
+/** Field to sort mod search results by. */
+export var ModsSearchSortField;
+(function (ModsSearchSortField) {
+    ModsSearchSortField[ModsSearchSortField["Featured"] = 1] = "Featured";
+    ModsSearchSortField[ModsSearchSortField["Popularity"] = 2] = "Popularity";
+    ModsSearchSortField[ModsSearchSortField["LastUpdated"] = 3] = "LastUpdated";
+    ModsSearchSortField[ModsSearchSortField["Name"] = 4] = "Name";
+    ModsSearchSortField[ModsSearchSortField["Author"] = 5] = "Author";
+    ModsSearchSortField[ModsSearchSortField["TotalDownloads"] = 6] = "TotalDownloads";
+    ModsSearchSortField[ModsSearchSortField["Category"] = 7] = "Category";
+    ModsSearchSortField[ModsSearchSortField["GameVersion"] = 8] = "GameVersion";
+    ModsSearchSortField[ModsSearchSortField["EarlyAccess"] = 9] = "EarlyAccess";
+    ModsSearchSortField[ModsSearchSortField["FeaturedReleased"] = 10] = "FeaturedReleased";
+    ModsSearchSortField[ModsSearchSortField["ReleasedDate"] = 11] = "ReleasedDate";
+    ModsSearchSortField[ModsSearchSortField["Rating"] = 12] = "Rating";
+})(ModsSearchSortField || (ModsSearchSortField = {}));
+//# sourceMappingURL=mods.js.map

package/dist/types/mods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mods.js","sourceRoot":"","sources":["../../src/types/mods.ts"],"names":[],"mappings":"AAKA,oCAAoC;AACpC,MAAM,CAAN,IAAY,SAWX;AAXD,WAAY,SAAS;IACnB,uCAAO,CAAA;IACP,+DAAmB,CAAA;IACnB,+DAAmB,CAAA;IACnB,iDAAY,CAAA;IACZ,iDAAY,CAAA;IACZ,uDAAe,CAAA;IACf,iDAAY,CAAA;IACZ,mDAAa,CAAA;IACb,+CAAW,CAAA;IACX,wDAAgB,CAAA;AAClB,CAAC,EAXW,SAAS,KAAT,SAAS,QAWpB;AAED,2CAA2C;AAC3C,MAAM,CAAN,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC7B,qEAAY,CAAA;IACZ,yEAAc,CAAA;IACd,2EAAe,CAAA;IACf,6DAAQ,CAAA;IACR,iEAAU,CAAA;IACV,iFAAkB,CAAA;IAClB,qEAAY,CAAA;IACZ,2EAAe,CAAA;IACf,2EAAe,CAAA;IACf,sFAAqB,CAAA;IACrB,8EAAiB,CAAA;IACjB,kEAAW,CAAA;AACb,CAAC,EAbW,mBAAmB,KAAnB,mBAAmB,QAa9B"}

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export * from './types/index.js';
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export * from './types/index.js';
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/utils/request.d.ts

@@ -0,0 +1,21 @@
+/** Strips trailing slashes from a base URL. */
+export declare function normalizeBaseUrl(baseUrl: string): string;
+/** Appends query parameters to a URL, skipping null and undefined values. */
+export declare function appendQuery(url: URL, query?: object): URL;
+/** Constructs the full API URL for a given path and optional query parameters. */
+export declare function buildApiUrl(baseUrl: string, path: string, query?: object): string;
+/** Serializes an array as a JSON-bracket-encoded string, e.g. `[1,2,3]`, as expected by CurseForge list query parameters such as `categoryIds`, `gameVersions`, and `modLoaderTypes`. */
+export declare function toArrayParam<T>(values: T[] | undefined): string | undefined;
+/** Returns true if the value is a plain object (not an array, FormData, or Blob). */
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+/** Returns true if the value can be used directly as a fetch request body. */
+export declare function isRawBody(value: unknown): value is BodyInit;
+/** Serializes a plain object body as JSON and sets Content-Type if not already set. */
+export declare function withJsonBody(init: Omit<RequestInit, 'body'> & {
+    body?: BodyInit | object | object[] | null;
+}): RequestInit;
+/** Extracts a human-readable message from an API error response body. */
+export declare function extractErrorMessage(body: unknown, status: number): string;
+/** Attempts to parse the error response body as JSON, falling back to text. */
+export declare function parseErrorBody(response: Response): Promise<unknown>;
+//# sourceMappingURL=request.d.ts.map

package/dist/utils/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/utils/request.ts"],"names":[],"mappings":"AAEA,+CAA+C;AAC/C,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAMxD;AAED,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAczD;AAED,kFAAkF;AAClF,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAIjF;AAED,yLAAyL;AACzL,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAG3E;AAED,qFAAqF;AACrF,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQ9E;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAS3D;AAED,uFAAuF;AACvF,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;CAAE,GAC/E,WAAW,CAqBb;AAED,yEAAyE;AACzE,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAazE;AAED,+EAA+E;AAC/E,wBAAsB,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAMzE"}

package/dist/utils/request.js

@@ -0,0 +1,96 @@
+/** Strips trailing slashes from a base URL. */
+export function normalizeBaseUrl(baseUrl) {
+    if (!baseUrl || typeof baseUrl !== 'string') {
+        throw new TypeError('baseUrl must be a non-empty string');
+    }
+    return baseUrl.replace(/\/+$/, '');
+}
+/** Appends query parameters to a URL, skipping null and undefined values. */
+export function appendQuery(url, query) {
+    if (!query)
+        return url;
+    for (const [key, rawValue] of Object.entries(query)) {
+        if (rawValue == null)
+            continue;
+        const values = Array.isArray(rawValue) ? rawValue : [rawValue];
+        for (const value of values) {
+            if (value == null)
+                continue;
+            url.searchParams.append(key, String(value));
+        }
+    }
+    return url;
+}
+/** Constructs the full API URL for a given path and optional query parameters. */
+export function buildApiUrl(baseUrl, path, query) {
+    const trimmedPath = path.replace(/^\/+/, '');
+    const url = new URL(`${normalizeBaseUrl(baseUrl)}/${trimmedPath}`);
+    return appendQuery(url, query).toString();
+}
+/** Serializes an array as a JSON-bracket-encoded string, e.g. `[1,2,3]`, as expected by CurseForge list query parameters such as `categoryIds`, `gameVersions`, and `modLoaderTypes`. */
+export function toArrayParam(values) {
+    if (values == null)
+        return undefined;
+    return `[${values.map((value) => JSON.stringify(value)).join(',')}]`;
+}
+/** Returns true if the value is a plain object (not an array, FormData, or Blob). */
+export function isPlainObject(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        !Array.isArray(value) &&
+        !(value instanceof FormData) &&
+        !(value instanceof Blob));
+}
+/** Returns true if the value can be used directly as a fetch request body. */
+export function isRawBody(value) {
+    return (typeof value === 'string' ||
+        value instanceof FormData ||
+        value instanceof URLSearchParams ||
+        value instanceof Blob ||
+        value instanceof ArrayBuffer ||
+        ArrayBuffer.isView(value));
+}
+/** Serializes a plain object body as JSON and sets Content-Type if not already set. */
+export function withJsonBody(init) {
+    const { body, headers, ...rest } = init;
+    const resolvedHeaders = new Headers(headers);
+    if (body == null) {
+        return { ...rest, headers: resolvedHeaders };
+    }
+    if (isRawBody(body)) {
+        return { ...rest, headers: resolvedHeaders, body };
+    }
+    if (!resolvedHeaders.has('Content-Type')) {
+        resolvedHeaders.set('Content-Type', 'application/json');
+    }
+    return {
+        ...rest,
+        headers: resolvedHeaders,
+        body: JSON.stringify(body),
+    };
+}
+/** Extracts a human-readable message from an API error response body. */
+export function extractErrorMessage(body, status) {
+    if (body && typeof body === 'object') {
+        const record = body;
+        const error = record['error'];
+        if (error && typeof error === 'object') {
+            const message = error['message'];
+            if (typeof message === 'string' && message.length > 0)
+                return message;
+        }
+        const message = record['message'];
+        if (typeof message === 'string' && message.length > 0)
+            return message;
+    }
+    return `HTTP ${status}`;
+}
+/** Attempts to parse the error response body as JSON, falling back to text. */
+export async function parseErrorBody(response) {
+    const contentType = response.headers.get('content-type') ?? '';
+    if (contentType.includes('application/json')) {
+        return response.json().catch(() => null);
+    }
+    return response.text().catch(() => null);
+}
+//# sourceMappingURL=request.js.map

package/dist/utils/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../src/utils/request.ts"],"names":[],"mappings":"AAEA,+CAA+C;AAC/C,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC5C,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,WAAW,CAAC,GAAQ,EAAE,KAAc;IAClD,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,CAAC;IAEvB,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAmC,CAAC,EAAE,CAAC;QAClF,IAAI,QAAQ,IAAI,IAAI;YAAE,SAAS;QAE/B,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC/D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,IAAI,IAAI;gBAAE,SAAS;YAC5B,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,WAAW,CAAC,OAAe,EAAE,IAAY,EAAE,KAAc;IACvE,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;IACnE,OAAO,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC5C,CAAC;AAED,yLAAyL;AACzL,MAAM,UAAU,YAAY,CAAI,MAAuB;IACrD,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACvE,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,KAAK,YAAY,QAAQ,CAAC;QAC5B,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,YAAY,QAAQ;QACzB,KAAK,YAAY,eAAe;QAChC,KAAK,YAAY,IAAI;QACrB,KAAK,YAAY,WAAW;QAC5B,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,YAAY,CAC1B,IAAgF;IAEhF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IACxC,MAAM,eAAe,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IAC/C,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;QACzC,eAAe,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,OAAO,EAAE,eAAe;QACxB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC3B,CAAC;AACJ,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,mBAAmB,CAAC,IAAa,EAAE,MAAc;IAC/D,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,IAA+B,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,OAAO,GAAI,KAAiC,CAAC,SAAS,CAAC,CAAC;YAC9D,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO,OAAO,CAAC;QACxE,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,OAAO,CAAC;IACxE,CAAC;IAED,OAAO,QAAQ,MAAM,EAAE,CAAC;AAC1B,CAAC;AAED,+EAA+E;AAC/E,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,QAAkB;IACrD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC7C,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AAC3C,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "curseforge-js",
+  "version": "1.0.0",
+  "description": "Framework-agnostic JavaScript API client for the CurseForge API",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/"
+  ],
+  "keywords": [
+    "curseforge",
+    "minecraft",
+    "mods",
+    "api"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/creeperkatze/curseforge-js"
+  },
+  "author": "Creeperkatze",
+  "license": "AGPL-3.0-only",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@lucide/vue": "^1.20.0",
+    "@tailwindcss/vite": "^4.3.1",
+    "@types/node": "^25.9.3",
+    "@vitest/coverage-v8": "^2.1.9",
+    "concurrently": "^10.0.3",
+    "eslint": "^10.5.0",
+    "globals": "^17.6.0",
+    "tailwindcss": "^4.3.1",
+    "typedoc": "^0.28.19",
+    "typedoc-plugin-markdown": "^4.12.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.61.1",
+    "vite-svg-loader": "^5.1.1",
+    "vitepress": "^1.6.4",
+    "vitest": "^2.1.9"
+  },
+  "scripts": {
+    "build": "tsc",
+    "docs:api": "typedoc --options typedoc.json",
+    "docs:dev": "concurrently -n typedoc,vitepress -c yellow,cyan \"typedoc --options typedoc.json --watch\" \"vitepress dev docs\"",
+    "docs:build": "pnpm docs:api && vitepress build docs",
+    "docs:preview": "vitepress preview docs",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "release:patch": "pnpm version patch && git push && git push --tags",
+    "release:minor": "pnpm version minor && git push && git push --tags",
+    "release:major": "pnpm version major && git push && git push --tags"
+  }
+}