speedruncom.js 2.0.3 → 2.0.5

package/lib/Client.d.ts

@@ -1,11 +1,11 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import GETEndpoints from './endpoints/endpoints.get.js';
 import POSTEndpoints from './endpoints/endpoints.post.js';
 import Responses from './responses.js';
 type Endpoints = GETEndpoints & POSTEndpoints;
 export default class Client {
     axiosClient: import("axios").AxiosInstance;
-    get<E extends keyof GETEndpoints, P extends GETEndpoints[E]>(endpoint: E, params: P, axiosConfig?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Responses[E], any>>;
-    post<E extends keyof Endpoints, P extends Endpoints[E]>(endpoint: E, params: P, axiosConfig?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<E extends keyof Responses ? Responses[E] : void, any>>;
+    get<E extends keyof GETEndpoints, P extends GETEndpoints[E]>(endpoint: E, params: P, axiosConfig?: AxiosRequestConfig): Promise<AxiosResponse<Responses[E], any>>;
+    post<E extends keyof Endpoints, P extends Endpoints[E]>(endpoint: E, params: P, axiosConfig?: AxiosRequestConfig): Promise<AxiosResponse<E extends keyof Responses ? Responses[E] : void, any>>;
 }
 export {};

package/lib/endpoints/endpoints.get.d.ts

@@ -23,6 +23,17 @@ export default interface GETEndpoints {
          */
         page?: number;
     };
+    GetGameData: {
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    } | {
+        /**
+         * Game page URL.
+         */
+        gameUrl: string;
+    };
     /**
      * Gets a specific site article.
      */
@@ -508,6 +519,17 @@ export default interface GETEndpoints {
          * ID of the forum.
          */
         forumId: string;
+        /**
+         * The thread page, in relation to `limit`.
+         */
+        page: number;
+        /**
+         * The maximum amount of `Thread`s to fetch.
+         *
+         * @default 30
+         * @max 100
+         */
+        limit: number;
     };
     /**
      * Gets a comment post's Thread and Forum by `commentId`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speedruncom.js",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "WIP NodeJS module for Speedrun's version 2 API.",
   "type": "module",
   "author": {

package/src/Client.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosRequestConfig } from 'axios';
+import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
 import GETEndpoints from './endpoints/endpoints.get.js';
 import POSTEndpoints from './endpoints/endpoints.post.js'
 import Responses from './responses.js';

package/src/endpoints/endpoints.get.ts

@@ -31,6 +31,20 @@ export default interface GETEndpoints {
         page?: number;
     };
 
+    GetGameData: {
+        
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    } | {
+
+        /**
+         * Game page URL.
+         */
+        gameUrl: string;
+    }
+
     /**
      * Gets a specific site article.
      */
@@ -617,6 +631,19 @@ export default interface GETEndpoints {
          * ID of the forum.
          */
         forumId: string;
+
+        /**
+         * The thread page, in relation to `limit`.
+         */
+        page: number;
+
+        /**
+         * The maximum amount of `Thread`s to fetch.
+         * 
+         * @default 30
+         * @max 100
+         */
+        limit: number;
     };
 
     /**

package/src/responses.ts

@@ -2,6 +2,7 @@ import * as Interfaces from './interfaces.js';
 
 export default interface Responses {
     GetGameLeaderboard2: {
+        
         /**
          * Runs in the leaderboard.
          */