curseforge-js 1.0.0 → 1.1.1

package/README.md

@@ -1,6 +1,6 @@
 # curseforge-js
 
-A framework-agnostic JavaScript client for the [CurseForge API](https://docs.curseforge.com).
+A framework-agnostic fully typed JavaScript client for the [CurseForge API](https://docs.curseforge.com/rest-api/).
 
 [![NPM Version](https://img.shields.io/npm/v/curseforge-js)](https://www.npmjs.com/package/curseforge-js)
 [![NPM Downloads](https://img.shields.io/npm/dt/curseforge-js)](https://www.npmjs.com/package/curseforge-js)
@@ -10,6 +10,9 @@ A framework-agnostic JavaScript client for the [CurseForge API](https://docs.cur
 [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/creeperkatze/curseforge-js)](https://github.com/creeperkatze/curseforge-js/pulls)
 [![GitHub Repo stars](https://img.shields.io/github/stars/creeperkatze/curseforge-js?style=flat)](https://github.com/creeperkatze/curseforge-js/stargazers)
 
+[📚 Docs](https://curseforge-js.creeperkatze.dev/) •
+[🚀 Getting Started](https://curseforge-js.creeperkatze.dev/guide/getting-started) •
+[📖 API Reference](https://curseforge-js.creeperkatze.dev/api) •
 [📝 Changelog](https://github.com/creeperkatze/curseforge-js/releases)
 
 ## 📦 Installation
@@ -99,6 +102,9 @@ Fingerprints:
 - `client.fingerprints.getMatches(fingerprints, gameId?)`
 - `client.fingerprints.getFuzzyMatches(fingerprints, gameId?)`
 
+Users:
+- `client.users.get(userId)`
+
 ## 🔐 Authentication
 
 Get an API key from [console.curseforge.com](https://console.curseforge.com/), then pass it at client creation time. It is sent as the `x-api-key` header on every request.

package/dist/client/curseforge.d.ts

@@ -4,6 +4,7 @@ import { FingerprintsApi } from './fingerprints.js';
 import { GamesApi } from './games.js';
 import { MinecraftApi } from './minecraft.js';
 import { ModsApi } from './mods.js';
+import { UsersApi } from './users.js';
 import type { CurseForgeClientOptions } from '../types/base.js';
 /**
  * Client for the CurseForge API.
@@ -22,6 +23,7 @@ export declare class CurseForgeClient {
     readonly games: GamesApi;
     readonly minecraft: MinecraftApi;
     readonly mods: ModsApi;
+    readonly users: UsersApi;
     constructor(options?: CurseForgeClientOptions);
 }
 //# sourceMappingURL=curseforge.d.ts.map

package/dist/client/curseforge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"curseforge.d.ts","sourceRoot":"","sources":["../../src/client/curseforge.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE;;;;;;;;GAQG;AACH,qBAAa,gBAAgB;;IAG3B,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEX,OAAO,GAAE,uBAA4B;CAUlD"}
+{"version":3,"file":"curseforge.d.ts","sourceRoot":"","sources":["../../src/client/curseforge.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE;;;;;;;;GAQG;AACH,qBAAa,gBAAgB;;IAG3B,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAEb,OAAO,GAAE,uBAA4B;CAWlD"}

package/dist/client/curseforge.js

@@ -5,6 +5,7 @@ import { FingerprintsApi } from './fingerprints.js';
 import { GamesApi } from './games.js';
 import { MinecraftApi } from './minecraft.js';
 import { ModsApi } from './mods.js';
+import { UsersApi } from './users.js';
 /**
  * Client for the CurseForge API.
  * @example
@@ -22,6 +23,7 @@ export class CurseForgeClient {
     games;
     minecraft;
     mods;
+    users;
     constructor(options = {}) {
         this.#core = new CurseForgeClientCore(options);
         this.categories = new CategoriesApi(this.#core);
@@ -30,6 +32,7 @@ export class CurseForgeClient {
         this.games = new GamesApi(this.#core);
         this.minecraft = new MinecraftApi(this.#core);
         this.mods = new ModsApi(this.#core);
+        this.users = new UsersApi(this.#core);
     }
 }
 //# sourceMappingURL=curseforge.js.map

package/dist/client/curseforge.js.map

@@ -1 +1 @@
-{"version":3,"file":"curseforge.js","sourceRoot":"","sources":["../../src/client/curseforge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC;;;;;;;;GAQG;AACH,MAAM,OAAO,gBAAgB;IAClB,KAAK,CAAuB;IAE5B,UAAU,CAAgB;IAC1B,KAAK,CAAW;IAChB,YAAY,CAAkB;IAC9B,KAAK,CAAW;IAChB,SAAS,CAAe;IACxB,IAAI,CAAU;IAEvB,YAAY,UAAmC,EAAE;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF"}
+{"version":3,"file":"curseforge.js","sourceRoot":"","sources":["../../src/client/curseforge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;;;;;;;GAQG;AACH,MAAM,OAAO,gBAAgB;IAClB,KAAK,CAAuB;IAE5B,UAAU,CAAgB;IAC1B,KAAK,CAAW;IAChB,YAAY,CAAkB;IAC9B,KAAK,CAAW;IAChB,SAAS,CAAe;IACxB,IAAI,CAAU;IACd,KAAK,CAAW;IAEzB,YAAY,UAAmC,EAAE;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;CACF"}

package/dist/client/index.d.ts

@@ -5,5 +5,6 @@ export { FingerprintsApi } from './fingerprints.js';
 export { GamesApi } from './games.js';
 export { MinecraftApi } from './minecraft.js';
 export { ModsApi } from './mods.js';
+export { UsersApi } from './users.js';
 export { CurseForgeClient } from './curseforge.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/client/index.js

@@ -5,5 +5,6 @@ export { FingerprintsApi } from './fingerprints.js';
 export { GamesApi } from './games.js';
 export { MinecraftApi } from './minecraft.js';
 export { ModsApi } from './mods.js';
+export { UsersApi } from './users.js';
 export { CurseForgeClient } from './curseforge.js';
 //# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/client/users.d.ts

@@ -0,0 +1,13 @@
+import type { CurseForgeClientCore } from './core.js';
+import type { User } from '../types/index.js';
+/**
+ * API namespace for users.
+ * @remarks This endpoint is not part of CurseForge's published API reference, see {@link User}.
+ */
+export declare class UsersApi {
+    private readonly core;
+    constructor(core: CurseForgeClientCore);
+    /** Returns a single user by id. */
+    get(userId: number): Promise<User>;
+}
+//# sourceMappingURL=users.d.ts.map

package/dist/client/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/client/users.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAG9C;;;GAGG;AACH,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,oBAAoB;IAEvD,mCAAmC;IAC7B,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAIzC"}

package/dist/client/users.js

@@ -0,0 +1,16 @@
+/**
+ * API namespace for users.
+ * @remarks This endpoint is not part of CurseForge's published API reference, see {@link User}.
+ */
+export class UsersApi {
+    core;
+    constructor(core) {
+        this.core = core;
+    }
+    /** Returns a single user by id. */
+    async get(userId) {
+        const response = await this.core.requestJson(`v1/users/${userId}`);
+        return response.data;
+    }
+}
+//# sourceMappingURL=users.js.map

package/dist/client/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/client/users.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACU;IAA7B,YAA6B,IAA0B;QAA1B,SAAI,GAAJ,IAAI,CAAsB;IAAG,CAAC;IAE3D,mCAAmC;IACnC,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAA2B,YAAY,MAAM,EAAE,CAAC,CAAC;QAC7F,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './types.js';
 export * from './errors.js';
 export * from './client.js';
+export { resolveAvatarUrl } from './utils/avatar.js';
 export { CurseForgeClient as default } from './client/curseforge.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './types.js';
 export * from './errors.js';
 export * from './client.js';
+export { resolveAvatarUrl } from './utils/avatar.js';
 export { CurseForgeClient as default } from './client/curseforge.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/types/games.d.ts

@@ -26,9 +26,13 @@ export declare enum GameVersionTypeStatus {
 }
 /** Icon, tile and cover art for a game. */
 export interface GameAssets {
-    iconUrl: string;
-    tileUrl: string;
-    coverUrl: string;
+    iconUrl: string | null;
+    tileUrl: string | null;
+    coverUrl: string | null;
+}
+/** Feature flags describing what a game supports. */
+export interface GameSupportedFeatures {
+    supportModSubscriptions: boolean;
 }
 /** A game available on CurseForge. */
 export interface Game {
@@ -39,6 +43,7 @@ export interface Game {
     assets: GameAssets;
     status: CoreStatus;
     apiStatus: CoreApiStatus;
+    supportedFeatures: GameSupportedFeatures;
 }
 /** A single named/sluggable version of a game (used by the v2 versions endpoint). */
 export interface GameVersion {
@@ -46,12 +51,12 @@ export interface GameVersion {
     slug: string;
     name: string;
 }
-/** Game versions grouped by version type (v1 form — plain version strings). */
+/** Game versions grouped by version type (v1 form, plain version strings). */
 export interface GameVersionsByType {
     type: number;
     versions: string[];
 }
-/** Game versions grouped by version type (v2 form — full version objects). */
+/** Game versions grouped by version type (v2 form, full version objects). */
 export interface GameVersionsByType2 {
     type: number;
     versions: GameVersion[];
@@ -67,4 +72,48 @@ export interface GameVersionType {
 }
 /** Query parameters for {@link GamesApi.list}. */
 export type GetGamesOptions = PaginationOptions;
+/**
+ * Game ids on CurseForge, as returned by {@link GamesApi.list}.
+ * @remarks Not part of the CurseForge API contract, games are added over time and this list can go stale. Use {@link GamesApi.list} for the authoritative, current list.
+ */
+export declare enum GameId {
+    WorldOfWarcraft = 1,
+    TheSecretWorld = 64,
+    StarCraftII = 65,
+    RunesOfMagic = 335,
+    WorldOfTanks = 423,
+    Rift = 424,
+    Terraria = 431,
+    Minecraft = 432,
+    WildStar = 454,
+    TheElderScrollsOnline = 455,
+    DarkestDungeon = 608,
+    StardewValley = 669,
+    SidMeiersCivilizationVI = 727,
+    KerbalSpaceProgram = 4401,
+    SecretWorldLegends = 4455,
+    FinalFantasyIV = 4741,
+    FinalFantasyVI = 4773,
+    FinalFantasyII = 5001,
+    FinalFantasyV = 5021,
+    FinalFantasyIII = 5026,
+    FinalFantasyI = 5230,
+    SurvivingMars = 61489,
+    MinecraftDungeons = 69271,
+    AmongUs = 69761,
+    Hytale = 70216,
+    ChroniclesOfArcadia = 70667,
+    MinecraftBedrock = 78022,
+    TheSims4 = 78062,
+    Demeo = 78135,
+    ArkSurvivalAscended = 83374,
+    RushdownRevolt = 84062,
+    TennisElbow4 = 84137,
+    Palworld = 85196,
+    Helldivers2 = 85440,
+    HogwartsLegacy = 87986,
+    InZoi = 88849,
+    Windrose = 99078,
+    Subnautica2 = 99704
+}
 //# sourceMappingURL=games.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"games.d.ts","sourceRoot":"","sources":["../../src/types/games.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEnD,2EAA2E;AAC3E,oBAAY,UAAU;IACpB,KAAK,IAAI;IACT,IAAI,IAAI;IACR,aAAa,IAAI;IACjB,QAAQ,IAAI;IACZ,QAAQ,IAAI;IACZ,IAAI,IAAI;CACT;AAED,kCAAkC;AAClC,oBAAY,aAAa;IACvB,OAAO,IAAI;IACX,MAAM,IAAI;CACX;AAED,yCAAyC;AACzC,oBAAY,iBAAiB;IAC3B,QAAQ,IAAI;IACZ,OAAO,IAAI;IACX,GAAG,IAAI;CACR;AAED,qCAAqC;AACrC,oBAAY,qBAAqB;IAC/B,MAAM,IAAI;IACV,OAAO,IAAI;CACZ;AAED,2CAA2C;AAC3C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,sCAAsC;AACtC,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,qFAAqF;AACrF,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+EAA+E;AAC/E,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,8EAA8E;AAC9E,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,mGAAmG;AACnG,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,kDAAkD;AAClD,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"games.d.ts","sourceRoot":"","sources":["../../src/types/games.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEnD,2EAA2E;AAC3E,oBAAY,UAAU;IACpB,KAAK,IAAI;IACT,IAAI,IAAI;IACR,aAAa,IAAI;IACjB,QAAQ,IAAI;IACZ,QAAQ,IAAI;IACZ,IAAI,IAAI;CACT;AAED,kCAAkC;AAClC,oBAAY,aAAa;IACvB,OAAO,IAAI;IACX,MAAM,IAAI;CACX;AAED,yCAAyC;AACzC,oBAAY,iBAAiB;IAC3B,QAAQ,IAAI;IACZ,OAAO,IAAI;IACX,GAAG,IAAI;CACR;AAED,qCAAqC;AACrC,oBAAY,qBAAqB;IAC/B,MAAM,IAAI;IACV,OAAO,IAAI;CACZ;AAED,2CAA2C;AAC3C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,qDAAqD;AACrD,MAAM,WAAW,qBAAqB;IACpC,uBAAuB,EAAE,OAAO,CAAC;CAClC;AAED,sCAAsC;AACtC,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,aAAa,CAAC;IACzB,iBAAiB,EAAE,qBAAqB,CAAC;CAC1C;AAED,qFAAqF;AACrF,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8EAA8E;AAC9E,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,6EAA6E;AAC7E,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,mGAAmG;AACnG,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,kDAAkD;AAClD,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,oBAAY,MAAM;IAChB,eAAe,IAAI;IACnB,cAAc,KAAK;IACnB,WAAW,KAAK;IAChB,YAAY,MAAM;IAClB,YAAY,MAAM;IAClB,IAAI,MAAM;IACV,QAAQ,MAAM;IACd,SAAS,MAAM;IACf,QAAQ,MAAM;IACd,qBAAqB,MAAM;IAC3B,cAAc,MAAM;IACpB,aAAa,MAAM;IACnB,uBAAuB,MAAM;IAC7B,kBAAkB,OAAO;IACzB,kBAAkB,OAAO;IACzB,cAAc,OAAO;IACrB,cAAc,OAAO;IACrB,cAAc,OAAO;IACrB,aAAa,OAAO;IACpB,eAAe,OAAO;IACtB,aAAa,OAAO;IACpB,aAAa,QAAQ;IACrB,iBAAiB,QAAQ;IACzB,OAAO,QAAQ;IACf,MAAM,QAAQ;IACd,mBAAmB,QAAQ;IAC3B,gBAAgB,QAAQ;IACxB,QAAQ,QAAQ;IAChB,KAAK,QAAQ;IACb,mBAAmB,QAAQ;IAC3B,cAAc,QAAQ;IACtB,YAAY,QAAQ;IACpB,QAAQ,QAAQ;IAChB,WAAW,QAAQ;IACnB,cAAc,QAAQ;IACtB,KAAK,QAAQ;IACb,QAAQ,QAAQ;IAChB,WAAW,QAAQ;CACpB"}

package/dist/types/games.js

@@ -27,4 +27,49 @@ export var GameVersionTypeStatus;
     GameVersionTypeStatus[GameVersionTypeStatus["Normal"] = 1] = "Normal";
     GameVersionTypeStatus[GameVersionTypeStatus["Deleted"] = 2] = "Deleted";
 })(GameVersionTypeStatus || (GameVersionTypeStatus = {}));
+/**
+ * Game ids on CurseForge, as returned by {@link GamesApi.list}.
+ * @remarks Not part of the CurseForge API contract, games are added over time and this list can go stale. Use {@link GamesApi.list} for the authoritative, current list.
+ */
+export var GameId;
+(function (GameId) {
+    GameId[GameId["WorldOfWarcraft"] = 1] = "WorldOfWarcraft";
+    GameId[GameId["TheSecretWorld"] = 64] = "TheSecretWorld";
+    GameId[GameId["StarCraftII"] = 65] = "StarCraftII";
+    GameId[GameId["RunesOfMagic"] = 335] = "RunesOfMagic";
+    GameId[GameId["WorldOfTanks"] = 423] = "WorldOfTanks";
+    GameId[GameId["Rift"] = 424] = "Rift";
+    GameId[GameId["Terraria"] = 431] = "Terraria";
+    GameId[GameId["Minecraft"] = 432] = "Minecraft";
+    GameId[GameId["WildStar"] = 454] = "WildStar";
+    GameId[GameId["TheElderScrollsOnline"] = 455] = "TheElderScrollsOnline";
+    GameId[GameId["DarkestDungeon"] = 608] = "DarkestDungeon";
+    GameId[GameId["StardewValley"] = 669] = "StardewValley";
+    GameId[GameId["SidMeiersCivilizationVI"] = 727] = "SidMeiersCivilizationVI";
+    GameId[GameId["KerbalSpaceProgram"] = 4401] = "KerbalSpaceProgram";
+    GameId[GameId["SecretWorldLegends"] = 4455] = "SecretWorldLegends";
+    GameId[GameId["FinalFantasyIV"] = 4741] = "FinalFantasyIV";
+    GameId[GameId["FinalFantasyVI"] = 4773] = "FinalFantasyVI";
+    GameId[GameId["FinalFantasyII"] = 5001] = "FinalFantasyII";
+    GameId[GameId["FinalFantasyV"] = 5021] = "FinalFantasyV";
+    GameId[GameId["FinalFantasyIII"] = 5026] = "FinalFantasyIII";
+    GameId[GameId["FinalFantasyI"] = 5230] = "FinalFantasyI";
+    GameId[GameId["SurvivingMars"] = 61489] = "SurvivingMars";
+    GameId[GameId["MinecraftDungeons"] = 69271] = "MinecraftDungeons";
+    GameId[GameId["AmongUs"] = 69761] = "AmongUs";
+    GameId[GameId["Hytale"] = 70216] = "Hytale";
+    GameId[GameId["ChroniclesOfArcadia"] = 70667] = "ChroniclesOfArcadia";
+    GameId[GameId["MinecraftBedrock"] = 78022] = "MinecraftBedrock";
+    GameId[GameId["TheSims4"] = 78062] = "TheSims4";
+    GameId[GameId["Demeo"] = 78135] = "Demeo";
+    GameId[GameId["ArkSurvivalAscended"] = 83374] = "ArkSurvivalAscended";
+    GameId[GameId["RushdownRevolt"] = 84062] = "RushdownRevolt";
+    GameId[GameId["TennisElbow4"] = 84137] = "TennisElbow4";
+    GameId[GameId["Palworld"] = 85196] = "Palworld";
+    GameId[GameId["Helldivers2"] = 85440] = "Helldivers2";
+    GameId[GameId["HogwartsLegacy"] = 87986] = "HogwartsLegacy";
+    GameId[GameId["InZoi"] = 88849] = "InZoi";
+    GameId[GameId["Windrose"] = 99078] = "Windrose";
+    GameId[GameId["Subnautica2"] = 99704] = "Subnautica2";
+})(GameId || (GameId = {}));
 //# sourceMappingURL=games.js.map

package/dist/types/games.js.map

@@ -1 +1 @@
-{"version":3,"file":"games.js","sourceRoot":"","sources":["../../src/types/games.ts"],"names":[],"mappings":"AAEA,2EAA2E;AAC3E,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,2CAAQ,CAAA;IACR,6DAAiB,CAAA;IACjB,mDAAY,CAAA;IACZ,mDAAY,CAAA;IACZ,2CAAQ,CAAA;AACV,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAED,kCAAkC;AAClC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,uDAAW,CAAA;IACX,qDAAU,CAAA;AACZ,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED,yCAAyC;AACzC,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,iEAAY,CAAA;IACZ,+DAAW,CAAA;IACX,uDAAO,CAAA;AACT,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAED,qCAAqC;AACrC,MAAM,CAAN,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,qEAAU,CAAA;IACV,uEAAW,CAAA;AACb,CAAC,EAHW,qBAAqB,KAArB,qBAAqB,QAGhC"}
+{"version":3,"file":"games.js","sourceRoot":"","sources":["../../src/types/games.ts"],"names":[],"mappings":"AAEA,2EAA2E;AAC3E,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,2CAAQ,CAAA;IACR,6DAAiB,CAAA;IACjB,mDAAY,CAAA;IACZ,mDAAY,CAAA;IACZ,2CAAQ,CAAA;AACV,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAED,kCAAkC;AAClC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,uDAAW,CAAA;IACX,qDAAU,CAAA;AACZ,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED,yCAAyC;AACzC,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,iEAAY,CAAA;IACZ,+DAAW,CAAA;IACX,uDAAO,CAAA;AACT,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAED,qCAAqC;AACrC,MAAM,CAAN,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,qEAAU,CAAA;IACV,uEAAW,CAAA;AACb,CAAC,EAHW,qBAAqB,KAArB,qBAAqB,QAGhC;AA0DD;;;GAGG;AACH,MAAM,CAAN,IAAY,MAuCX;AAvCD,WAAY,MAAM;IAChB,yDAAmB,CAAA;IACnB,wDAAmB,CAAA;IACnB,kDAAgB,CAAA;IAChB,qDAAkB,CAAA;IAClB,qDAAkB,CAAA;IAClB,qCAAU,CAAA;IACV,6CAAc,CAAA;IACd,+CAAe,CAAA;IACf,6CAAc,CAAA;IACd,uEAA2B,CAAA;IAC3B,yDAAoB,CAAA;IACpB,uDAAmB,CAAA;IACnB,2EAA6B,CAAA;IAC7B,kEAAyB,CAAA;IACzB,kEAAyB,CAAA;IACzB,0DAAqB,CAAA;IACrB,0DAAqB,CAAA;IACrB,0DAAqB,CAAA;IACrB,wDAAoB,CAAA;IACpB,4DAAsB,CAAA;IACtB,wDAAoB,CAAA;IACpB,yDAAqB,CAAA;IACrB,iEAAyB,CAAA;IACzB,6CAAe,CAAA;IACf,2CAAc,CAAA;IACd,qEAA2B,CAAA;IAC3B,+DAAwB,CAAA;IACxB,+CAAgB,CAAA;IAChB,yCAAa,CAAA;IACb,qEAA2B,CAAA;IAC3B,2DAAsB,CAAA;IACtB,uDAAoB,CAAA;IACpB,+CAAgB,CAAA;IAChB,qDAAmB,CAAA;IACnB,2DAAsB,CAAA;IACtB,yCAAa,CAAA;IACb,+CAAgB,CAAA;IAChB,qDAAmB,CAAA;AACrB,CAAC,EAvCW,MAAM,KAAN,MAAM,QAuCjB"}

package/dist/types/index.d.ts

@@ -5,4 +5,5 @@ export * from './fingerprints.js';
 export * from './games.js';
 export * from './minecraft.js';
 export * from './mods.js';
+export * from './users.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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"}
+{"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;AAC1B,cAAc,YAAY,CAAC"}

package/dist/types/index.js

@@ -5,4 +5,5 @@ export * from './fingerprints.js';
 export * from './games.js';
 export * from './minecraft.js';
 export * from './mods.js';
+export * from './users.js';
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +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"}
+{"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;AAC1B,cAAc,YAAY,CAAC"}

package/dist/types/users.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A CurseForge user.
+ *
+ * @remarks
+ * Undocumented; fields reflect observed usage, not a confirmed schema.
+ * `avatarUrl` is templated,  pass it through {@link resolveAvatarUrl} before use.
+ */
+export interface User {
+    id: number;
+    displayName: string;
+    avatarUrl: string;
+    dateCreated: string;
+}
+//# sourceMappingURL=users.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/types/users.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/dist/types/users.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=users.js.map

package/dist/types/users.js.map

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

package/dist/utils/avatar.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Resolves a {@link User.avatarUrl} template into a fetchable image URL by substituting its
+ * `{0}` size placeholder, a legacy artifact of CurseForge's Twitch-based avatar system.
+ * @param avatarUrl - The templated `avatarUrl` value from a {@link User}.
+ * @param size - Size token to substitute, e.g. `50x50`, `70x70`, `150x150`.
+ * @defaultValue size "300x300"
+ */
+export declare function resolveAvatarUrl(avatarUrl: string, size?: string): string;
+//# sourceMappingURL=avatar.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"avatar.d.ts","sourceRoot":"","sources":["../../src/utils/avatar.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,GAAE,MAA4B,GAAG,MAAM,CAE9F"}

package/dist/utils/avatar.js

@@ -0,0 +1,12 @@
+const DEFAULT_AVATAR_SIZE = '300x300';
+/**
+ * Resolves a {@link User.avatarUrl} template into a fetchable image URL by substituting its
+ * `{0}` size placeholder, a legacy artifact of CurseForge's Twitch-based avatar system.
+ * @param avatarUrl - The templated `avatarUrl` value from a {@link User}.
+ * @param size - Size token to substitute, e.g. `50x50`, `70x70`, `150x150`.
+ * @defaultValue size "300x300"
+ */
+export function resolveAvatarUrl(avatarUrl, size = DEFAULT_AVATAR_SIZE) {
+    return avatarUrl.replace('{0}', size);
+}
+//# sourceMappingURL=avatar.js.map

package/dist/utils/avatar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avatar.js","sourceRoot":"","sources":["../../src/utils/avatar.ts"],"names":[],"mappings":"AAAA,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAiB,EAAE,OAAe,mBAAmB;IACpF,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "curseforge-js",
-  "version": "1.0.0",
-  "description": "Framework-agnostic JavaScript API client for the CurseForge API",
+  "version": "1.1.1",
+  "description": "A framework-agnostic fully typed JavaScript client for the CurseForge API",
   "type": "module",
   "exports": {
     ".": {