speedruncom.js 1.1.0 → 1.2.1

package/dist/responses.d.ts

@@ -170,6 +170,9 @@ export interface GetGameList {
     gameList: Interfaces.Game[];
     userList: Interfaces.User[];
 }
+export interface GetPlatformList {
+    platformList: Interfaces.Platform[];
+}
 export interface GetCommentList {
     commentable: Interfaces.Commentable;
     commentList: Interfaces.Comment[];
@@ -187,13 +190,12 @@ export interface GetStaticData {
     colors: Interfaces.Color[];
     gameTypeList: Interfaces.GameTypeDetails[];
     notificationSettings: Interfaces.NotificationSettingStaticData[];
-    platformList: Interfaces.Platform[];
     regionList: Interfaces.Region[];
     socialNetworkList: Interfaces.SocialNetwork[];
     /**
      * Unknown type
      */
-    supporterPlanList?: any[] | null;
+    supporterPlanList?: null;
 }
 export interface GetHomeSummary {
     stream?: Interfaces.Stream;

package/package.json

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

package/src/BaseClient.ts

@@ -3,7 +3,7 @@ import * as GetEndpoints from './endpoints/endpoints.get.js';
 import * as PostEndpoints from './endpoints/endpoints.post.js'
 import * as Responses from './responses.js';
 
-const BASE_USER_AGENT = 'speedrun.js';
+const BASE_USER_AGENT = 'speedruncom.js';
 const BASE_URL = 'https://www.speedrun.com/api/v2/';
 const HEADERS = {
     'Accept-Language': 'en',
@@ -17,12 +17,12 @@ const objectToBase64 = (obj: object) => {
     return Buffer.from(jsonString).toString('base64');
 }
 
-interface config {
+export interface config {
     PHPSESSID?: string;
     userAgent?: string;
 }
 
-class APIError extends Error {
+export class APIError extends Error {
     status: number;
 
     constructor(message: string, status: number) {
@@ -91,38 +91,10 @@ export default class Client {
         return response.data;
     }
 
-    static async request<T>(endpoint: string, params: object): Promise<T> {
+    static async request<T>(endpoint: string, params: object = {}): Promise<T> {
         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: string, password: string) {
-        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: string) {
-        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/src/build-client.ts

@@ -1,4 +1,4 @@
-import { Project, SourceFile, InterfaceDeclaration, OptionalKind, MethodDeclarationStructure } from 'ts-morph';
+import { Project, SourceFile, InterfaceDeclaration, OptionalKind, MethodDeclarationStructure, SyntaxKind } from 'ts-morph';
 
 const project = new Project({
     tsConfigFilePath: "tsconfig.json",
@@ -15,9 +15,16 @@ const isInterfaceEmpty = (interfaceName: string, sourceFile: SourceFile) => {
     return props.length === 0;
 };
 
-const isInterfaceAllOptional = (interfaceName: string, sourceFile: SourceFile) => {
-    const interfaceDecl = sourceFile.getInterfaceOrThrow(interfaceName);
-    return interfaceDecl.getProperties().every(prop => prop.hasQuestionToken());
+const isInterfaceAllOptional = (name: string, sourceFile: SourceFile) => {
+    const iface = sourceFile.getInterface(name);
+    if (iface) {
+        return iface.getProperties().some(p => !p.hasQuestionToken());
+    }
+
+    const typeNode = sourceFile.getTypeAliasOrThrow(name).getType();
+    return typeNode
+        .getProperties()
+        .some(p => !p.isOptional());
 };
 
 const baseClient = project.getSourceFileOrThrow('src/BaseClient.ts');
@@ -39,7 +46,7 @@ const makeMethod = (name: string, isStatic: boolean, returnType: string, isEmpty
         isStatic,
         isAsync: true,
         returnType,
-        statements: [`return await this.request('${name}', params);`]
+        statements: [`return await this.request('${name}'${!isEmpty ? ', params' : ''});`]
     }
     if (!isEmpty) method.parameters = [{
         name: 'params',

package/src/endpoints/endpoints.get.ts

@@ -641,15 +641,32 @@ export interface GetUserModeration {
 }
 
 /**
- * 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;
 }
 
 /**