speedruncom.js 1.2.1 → 1.2.3

package/dist/BaseClient.d.ts

@@ -1,8 +1,12 @@
 import { AxiosInstance } from 'axios';
-interface config {
+export interface config {
     PHPSESSID?: string;
     userAgent?: string;
 }
+export declare class APIError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}
 export default class Client {
     /**
      * `AxiosInstance` used on instance-called methods (called with `POST`).
@@ -19,19 +23,8 @@ export default class Client {
     config(config: config): void;
     request<T>(endpoint: string, params?: object): Promise<T>;
     static request<T>(endpoint: string, params?: object): Promise<T>;
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise.
-     * If the account has two factor authentication, you have to use `setToken` with the token sent to the account's email address.
-     */
-    login(username: string, password: string): Promise<unknown>;
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise, with the token that `login()` sent to the account's email address.
-     * @param token The 5-digit code sent to your email after a successful `login()`.
-     */
-    setToken(token: string): Promise<unknown>;
     /**
      * Attempts to remove the PHPSESSID cookie if using a browser, otherwise removes your Client's authentication.
      */
     logout(): Promise<unknown>;
 }
-export {};

package/dist/BaseClient.js

@@ -10,7 +10,7 @@ const objectToBase64 = (obj) => {
     const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
     return Buffer.from(jsonString).toString('base64');
 };
-class APIError extends Error {
+export class APIError extends Error {
     constructor(message, status) {
         super(message);
         this.message = message;
@@ -58,30 +58,6 @@ class Client {
     static async request(endpoint, params = {}) {
         return (await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`)).data;
     }
-    //Built-in endpoints for auth
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise.
-     * If the account has two factor authentication, you have to use `setToken` with the token sent to the account's email address.
-     */
-    async login(username, password) {
-        this.username = username;
-        this.password = password;
-        return await this.request('PutAuthLogin', {
-            name: username,
-            password
-        });
-    }
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise, with the token that `login()` sent to the account's email address.
-     * @param token The 5-digit code sent to your email after a successful `login()`.
-     */
-    async setToken(token) {
-        return await this.request('PutAuthLogin', {
-            name: this.username,
-            password: this.password,
-            token
-        });
-    }
     /**
      * Attempts to remove the PHPSESSID cookie if using a browser, otherwise removes your Client's authentication.
      */

package/dist/Client.d.ts

@@ -2,10 +2,14 @@ import { AxiosInstance } from 'axios';
 import * as GetEndpoints from './endpoints/endpoints.get.js';
 import * as PostEndpoints from './endpoints/endpoints.post.js';
 import * as Responses from './responses.js';
-interface config {
+export interface config {
     PHPSESSID?: string;
     userAgent?: string;
 }
+export declare class APIError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}
 export default class Client {
     /**
      * `AxiosInstance` used on instance-called methods (called with `POST`).
@@ -22,16 +26,6 @@ export default class Client {
     config(config: config): void;
     request<T>(endpoint: string, params?: object): Promise<T>;
     static request<T>(endpoint: string, params?: object): Promise<T>;
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise.
-     * If the account has two factor authentication, you have to use `setToken` with the token sent to the account's email address.
-     */
-    login(username: string, password: string): Promise<unknown>;
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise, with the token that `login()` sent to the account's email address.
-     * @param token The 5-digit code sent to your email after a successful `login()`.
-     */
-    setToken(token: string): Promise<unknown>;
     /**
      * Attempts to remove the PHPSESSID cookie if using a browser, otherwise removes your Client's authentication.
      */
@@ -224,4 +218,3 @@ export default class Client {
     PutThreadSticky(params?: PostEndpoints.PutThreadSticky): Promise<void>;
     PutThreadDelete(params?: PostEndpoints.PutThreadDelete): Promise<void>;
 }
-export {};

package/dist/Client.js

@@ -10,7 +10,7 @@ const objectToBase64 = (obj) => {
     const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
     return Buffer.from(jsonString).toString('base64');
 };
-class APIError extends Error {
+export class APIError extends Error {
     constructor(message, status) {
         super(message);
         this.message = message;
@@ -58,30 +58,6 @@ class Client {
     static async request(endpoint, params = {}) {
         return (await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`)).data;
     }
-    //Built-in endpoints for auth
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise.
-     * If the account has two factor authentication, you have to use `setToken` with the token sent to the account's email address.
-     */
-    async login(username, password) {
-        this.username = username;
-        this.password = password;
-        return await this.request('PutAuthLogin', {
-            name: username,
-            password
-        });
-    }
-    /**
-     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise, with the token that `login()` sent to the account's email address.
-     * @param token The 5-digit code sent to your email after a successful `login()`.
-     */
-    async setToken(token) {
-        return await this.request('PutAuthLogin', {
-            name: this.username,
-            password: this.password,
-            token
-        });
-    }
     /**
      * Attempts to remove the PHPSESSID cookie if using a browser, otherwise removes your Client's authentication.
      */

package/dist/endpoints/endpoints.get.d.ts

@@ -531,14 +531,28 @@ export interface GetUserModeration {
     userId: string;
 }
 /**
- * Get a list of comments on an item.
+ * Get a list of comments on an item, and data of the parent.
  */
 export interface GetCommentList {
+    /**
+     * ID of the parent item to fetch.
+     */
     itemId: string;
     /**
      * `ItemType` of the item referenced in `itemId`.
      */
     itemType: Enums.ItemType;
+    /**
+     * The maximum amount of `Comment`s per page.
+     *
+     * @max 100
+     * @default 100
+     */
+    limit?: number;
+    /**
+     * The comment page, in relation to `limit`.
+     */
+    page?: number;
 }
 /**
  * Get a specific thread.

package/dist/responses.d.ts

@@ -260,30 +260,6 @@ export interface GetRun {
     values: Interfaces.Value[];
     variables: Interfaces.Variable[];
 }
-export interface GetSearch {
-    gameList: Interfaces.Game[];
-    newsList: Interfaces.GameNews[];
-    pageList: Interfaces.Article[];
-    seriesList: Interfaces.Series[];
-    userList: Interfaces.User[];
-    challengeList: Interfaces.Challenge[];
-}
-export interface GetSeriesList {
-    seriesList: Interfaces.Series[];
-    pagination: Interfaces.Pagination;
-}
-export interface GetSeriesSummary {
-    series: Interfaces.Series;
-    forum: Interfaces.Forum;
-    gameList: Interfaces.Game[];
-    moderatorList: Interfaces.SeriesModerator[];
-    theme: Interfaces.Theme;
-    threadList: Interfaces.Thread[];
-    userList: Interfaces.User[];
-    gameCount: number;
-    streamCount: number;
-    threadCount: number;
-}
 export interface GetStreamList {
     gameList: Interfaces.Game[];
     streamList: Interfaces.Stream[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speedruncom.js",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "WIP NodeJS module for Speedrun's version 2 API.",
   "type": "module",
   "author": {
@@ -16,8 +16,8 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "rimraf dist src/Client.ts",
-    "prepare": "tsx src/build-client.ts",
-    "build": "tsc"
+    "build": "tsc",
+    "prepare": "tsx src/build-client.ts && npm run build"
   },
   "devDependencies": {
     "@types/node": "^22.15.24",

package/src/responses.ts

@@ -61,7 +61,7 @@ export interface GetGameRecordHistory {
     runList: Interfaces.GameRun[];
 }
 
-export interface GetSearch { //TODO add platform, TODO this is probably inacurate i think the users are much less detailed + more
+export interface GetSearch {
     gameList: Interfaces.Game[];
     newsList: Interfaces.GameNews[];
     pageList: Interfaces.Article[];
@@ -302,33 +302,6 @@ export interface GetRun {
     variables: Interfaces.Variable[];
 }
 
-export interface GetSearch {
-    gameList: Interfaces.Game[];
-    newsList: Interfaces.GameNews[];
-    pageList: Interfaces.Article[];
-    seriesList: Interfaces.Series[];
-    userList: Interfaces.User[];
-    challengeList: Interfaces.Challenge[];
-}
-
-export interface GetSeriesList {
-    seriesList: Interfaces.Series[];
-    pagination: Interfaces.Pagination;
-}
-
-export interface GetSeriesSummary {
-    series: Interfaces.Series;
-    forum: Interfaces.Forum;
-    gameList: Interfaces.Game[];
-    moderatorList: Interfaces.SeriesModerator[];
-    theme: Interfaces.Theme;
-    threadList: Interfaces.Thread[];
-    userList: Interfaces.User[];
-    gameCount: number;
-    streamCount: number;
-    threadCount: number;
-}
-
 export interface GetStreamList {
     gameList: Interfaces.Game[];
     streamList: Interfaces.Stream[];