speedruncom.js 2.0.7 → 2.0.8

package/.github/workflows/publish.yml

@@ -1,8 +1,7 @@
 on:
   push:
-    branches:
-      - main
-  workflow_dispatch:
+    tags:
+      - 'v*'
 
 permissions:
   id-token: write

package/README.md

@@ -1,13 +1,5 @@
-# About
+# speedruncom.js
 
 Speedrun.com has two API versions. Version 1 is officially documented, REST, public and directly exposed to users. Version 2 is a pre-production RPC API designed only for internal use of site functions, and is much more complicated and less user-friendly, especially regarding authentication and browser CORS.
 
-Version 1 is mainly read-only, and when it isn't read only it may just be broken. If you want to use any of the modern features of the site now, you'll use version 2. This is a NodeJS wrapper for Speedrun API version 2, with parameters and responses all documented in TypeScript and JSDoc.
-
-This module isn't intended to give any helper functions to the user; it's more of an index of the params and responses of the site endpoints, to be used for type checking on a more user-friendly module.
-
-# Usage
-
-**`npm i speedruncom.js`**
-
-`Client` is the default export, and enums and interfaces are the named exports for TypeScript users.
+Version 1 is mainly read-only, and when it isn't read only it may just be broken. If you want to use any of the modern features of the site now, you'll use version 2. This package consists of types that make up this undocumented api, and a small utility for calling GET and POST.

package/bun.lock

@@ -1,68 +1,20 @@
 {
   "lockfileVersion": 1,
+  "configVersion": 0,
   "workspaces": {
     "": {
       "name": "speedruncom.js",
-      "dependencies": {
-        "axios": "^1.9.0",
-      },
       "devDependencies": {
-        "@types/node": "^25.5.0",
-        "typescript": "^5.8.3",
+        "@types/node": "^25.9.3",
+        "typescript": "^6.0.3",
       },
     },
   },
   "packages": {
-    "@types/node": ["@types/node@25.5.0", "", { "dependencies": { "undici-types": "~7.18.0" } }, "sha512-jp2P3tQMSxWugkCUKLRPVUpGaL5MVFwF8RDuSRztfwgN1wmqJeMSbKlnEtQqU8UrhTmzEmZdu2I6v2dpp7XIxw=="],
-
-    "asynckit": ["asynckit@0.4.0", "", {}, "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="],
-
-    "axios": ["axios@1.13.5", "", { "dependencies": { "follow-redirects": "^1.15.11", "form-data": "^4.0.5", "proxy-from-env": "^1.1.0" } }, "sha512-cz4ur7Vb0xS4/KUN0tPWe44eqxrIu31me+fbang3ijiNscE129POzipJJA6zniq2C/Z6sJCjMimjS8Lc/GAs8Q=="],
-
-    "call-bind-apply-helpers": ["call-bind-apply-helpers@1.0.2", "", { "dependencies": { "es-errors": "^1.3.0", "function-bind": "^1.1.2" } }, "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ=="],
-
-    "combined-stream": ["combined-stream@1.0.8", "", { "dependencies": { "delayed-stream": "~1.0.0" } }, "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg=="],
-
-    "delayed-stream": ["delayed-stream@1.0.0", "", {}, "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ=="],
-
-    "dunder-proto": ["dunder-proto@1.0.1", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-errors": "^1.3.0", "gopd": "^1.2.0" } }, "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A=="],
-
-    "es-define-property": ["es-define-property@1.0.1", "", {}, "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g=="],
-
-    "es-errors": ["es-errors@1.3.0", "", {}, "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw=="],
-
-    "es-object-atoms": ["es-object-atoms@1.1.1", "", { "dependencies": { "es-errors": "^1.3.0" } }, "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA=="],
-
-    "es-set-tostringtag": ["es-set-tostringtag@2.1.0", "", { "dependencies": { "es-errors": "^1.3.0", "get-intrinsic": "^1.2.6", "has-tostringtag": "^1.0.2", "hasown": "^2.0.2" } }, "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA=="],
-
-    "follow-redirects": ["follow-redirects@1.15.11", "", {}, "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ=="],
-
-    "form-data": ["form-data@4.0.5", "", { "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", "es-set-tostringtag": "^2.1.0", "hasown": "^2.0.2", "mime-types": "^2.1.12" } }, "sha512-8RipRLol37bNs2bhoV67fiTEvdTrbMUYcFTiy3+wuuOnUog2QBHCZWXDRijWQfAkhBj2Uf5UnVaiWwA5vdd82w=="],
-
-    "function-bind": ["function-bind@1.1.2", "", {}, "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA=="],
-
-    "get-intrinsic": ["get-intrinsic@1.3.0", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.2", "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.1.1", "function-bind": "^1.1.2", "get-proto": "^1.0.1", "gopd": "^1.2.0", "has-symbols": "^1.1.0", "hasown": "^2.0.2", "math-intrinsics": "^1.1.0" } }, "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ=="],
-
-    "get-proto": ["get-proto@1.0.1", "", { "dependencies": { "dunder-proto": "^1.0.1", "es-object-atoms": "^1.0.0" } }, "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g=="],
-
-    "gopd": ["gopd@1.2.0", "", {}, "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg=="],
-
-    "has-symbols": ["has-symbols@1.1.0", "", {}, "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ=="],
-
-    "has-tostringtag": ["has-tostringtag@1.0.2", "", { "dependencies": { "has-symbols": "^1.0.3" } }, "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw=="],
-
-    "hasown": ["hasown@2.0.2", "", { "dependencies": { "function-bind": "^1.1.2" } }, "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ=="],
-
-    "math-intrinsics": ["math-intrinsics@1.1.0", "", {}, "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g=="],
-
-    "mime-db": ["mime-db@1.52.0", "", {}, "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg=="],
-
-    "mime-types": ["mime-types@2.1.35", "", { "dependencies": { "mime-db": "1.52.0" } }, "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw=="],
-
-    "proxy-from-env": ["proxy-from-env@1.1.0", "", {}, "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg=="],
+    "@types/node": ["@types/node@25.9.3", "", { "dependencies": { "undici-types": ">=7.24.0 <7.24.7" } }, "sha512-603BddQMv3pUcr4U2dhujk83N2tTDVr/34wII2B6bJy6g+8WD6yUb11jszNs0gdi4PesVWl7ABt8nYMVpnLUcg=="],
 
-    "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
+    "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
 
-    "undici-types": ["undici-types@7.18.2", "", {}, "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w=="],
+    "undici-types": ["undici-types@7.24.6", "", {}, "sha512-WRNW+sJgj5OBN4/0JpHFqtqzhpbnV0GuB+OozA9gCL7a993SmU+1JBZCzLNxYsbMfIeDL+lTsphD5jN5N+n0zg=="],
   }
 }

package/lib/{endpoints → src/endpoints}/endpoints.post.d.ts

@@ -391,6 +391,11 @@ export default interface POSTEndpoints {
         verified?: Enums.RunStatus;
         verifiedById?: string;
         videoState?: Enums.VideoState;
+        /**
+         * The maximum amount of moderation runs per page.
+         *
+         * @max 100
+        */
         limit: number;
         page: number;
     };

package/lib/{index.d.ts → src/index.d.ts}

@@ -1,4 +1,3 @@
 export * from './enums.js';
 export * from './interfaces.js';
-import Client from './Client.js';
-export default Client;
+export * from './requests.js';

package/lib/{index.js → src/index.js}

@@ -1,4 +1,3 @@
 export * from './enums.js';
 export * from './interfaces.js';
-import Client from './Client.js';
-export default Client;
+export * from './requests.js';

package/lib/{interfaces.d.ts → src/interfaces.d.ts}

@@ -716,7 +716,7 @@ export interface Game {
     addedDate: number;
     touchDate: number;
     baseGameId?: string;
-    coverPath: string;
+    coverPath?: string;
     trophy1stPath?: string;
     trophy2ndPath?: string;
     trophy3rdPath?: string;

package/lib/src/requests.d.ts

@@ -0,0 +1,7 @@
+import GETEndpoints from './endpoints/endpoints.get.js';
+import POSTEndpoints from './endpoints/endpoints.post.js';
+import Responses from './responses.js';
+type Endpoints = GETEndpoints & POSTEndpoints;
+export declare function get<E extends keyof GETEndpoints, P extends GETEndpoints[E]>(endpoint: E, params: P): Promise<Responses[E]>;
+export declare function post<E extends keyof Endpoints, P extends Endpoints[E]>(endpoint: E, params: P): Promise<E extends keyof Responses ? Responses[E] : void>;
+export {};

package/lib/src/requests.js

@@ -0,0 +1,17 @@
+const objectToBase64 = (obj) => {
+    const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
+    return Buffer.from(jsonString).toString('base64').replace(/=+$/, '');
+};
+const baseUrl = 'https://www.speedrun.com/api/v2';
+export async function get(endpoint, params) {
+    const res = await fetch(`${baseUrl}/${endpoint}?_r=${objectToBase64(params)}`);
+    return await res.json();
+}
+export async function post(endpoint, params) {
+    const res = await fetch(`${baseUrl}/${endpoint}`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(params)
+    });
+    return await res.json();
+}

package/package.json

@@ -1,23 +1,21 @@
 {
   "name": "speedruncom.js",
-  "version": "2.0.7",
-  "description": "WIP NodeJS module for Speedrun's version 2 API.",
-  "type": "module",
-  "license": "MIT",
+  "version": "2.0.8",
   "author": "retrozy",
-  "dependencies": {
-    "axios": "^1.9.0"
-  },
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "build": "tsc"
+  "repository": {
+    "url": "https://github.com/retrozy1/speedruncom.js"
   },
+  "main": "lib/index.js",
   "devDependencies": {
-    "@types/node": "^25.5.0",
-    "typescript": "^5.8.3"
+    "@types/node": "^25.9.3",
+    "typescript": "^6.0.3"
   },
-  "main": "lib/index.js",
-  "repository": {
-    "url": "https://github.com/retrozy1/speedruncom.js"
-  }
+  "description": "WIP NodeJS module for Speedrun's version 2 API.",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "check": "tsc --noEmit"
+  },
+  "type": "module",
+  "types": "lib/index.d.ts"
 }

package/src/endpoints/endpoints.post.ts

@@ -474,6 +474,12 @@ export default interface POSTEndpoints {
         verified?: Enums.RunStatus;
         verifiedById?: string;
         videoState?: Enums.VideoState;
+
+        /**
+         * The maximum amount of moderation runs per page.
+         * 
+         * @max 100
+        */
         limit: number;
         page: number;
     };

package/src/index.ts

@@ -1,6 +1,3 @@
 export * from './enums.js';
 export * from './interfaces.js';
-
-import Client from './Client.js';
-
-export default Client;
+export * from './requests.js'

package/src/interfaces.ts

@@ -853,7 +853,7 @@ export interface Game {
     addedDate: number;
     touchDate: number;
     baseGameId?: string;
-    coverPath: string; //check if opt
+    coverPath?: string;
     trophy1stPath?: string;
     trophy2ndPath?: string;
     trophy3rdPath?: string;

package/src/requests.ts

@@ -0,0 +1,26 @@
+import GETEndpoints from './endpoints/endpoints.get.js';
+import POSTEndpoints from './endpoints/endpoints.post.js'
+import Responses from './responses.js';
+
+type Endpoints = GETEndpoints & POSTEndpoints;
+
+const objectToBase64 = (obj: object) => {
+    const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
+    return Buffer.from(jsonString).toString('base64').replace(/=+$/, '');
+};
+
+const baseUrl = 'https://www.speedrun.com/api/v2';
+
+export async function get<E extends keyof GETEndpoints, P extends GETEndpoints[E]>(endpoint: E, params: P): Promise<Responses[E]> {
+    const res = await fetch(`${baseUrl}/${endpoint}?_r=${objectToBase64(params)}`);
+    return await res.json();
+}
+
+export async function post<E extends keyof Endpoints, P extends Endpoints[E]>(endpoint: E, params: P): Promise<E extends keyof Responses ? Responses[E] : void> {
+    const res = await fetch(`${baseUrl}/${endpoint}`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(params)
+    });
+    return await res.json();
+}

package/tsconfig.json

@@ -1,16 +1,16 @@
 {
   "compilerOptions": {
     "outDir": "./lib",
+    "rootDir": "./",
     "allowJs": true,
     "checkJs": false,
     "strict": false,
     "target": "ES2020",
     "module": "ESNext",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true,
-    "declaration": true
+    "declaration": true,
+    "types": ["node"]
   },
   "include": ["src/**/*"]
 }

package/lib/Client.d.ts

@@ -1,11 +0,0 @@
-import { AxiosRequestConfig } 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, {}>>;
-}
-export {};

package/lib/Client.js

@@ -1,25 +0,0 @@
-import axios from 'axios';
-const objectToBase64 = (obj) => {
-    const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
-    return Buffer.from(jsonString).toString('base64');
-};
-export default class Client {
-    constructor() {
-        this.axiosClient = axios.create({
-            baseURL: 'https://www.speedrun.com/api/v2/',
-            headers: {
-                'Accept-Language': 'en',
-                '_': '',
-                'User-Agent': null
-            },
-            withCredentials: true,
-            transformRequest: [data => typeof data === 'string' ? data : JSON.stringify(data)]
-        });
-    }
-    async get(endpoint, params, axiosConfig) {
-        return await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`, axiosConfig);
-    }
-    async post(endpoint, params, axiosConfig) {
-        return await this.axiosClient.post(endpoint, params, axiosConfig);
-    }
-}

package/src/Client.ts

@@ -1,33 +0,0 @@
-import axios, { AxiosRequestConfig } 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;
-
-const objectToBase64 = (obj: object) => {
-    const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
-    return Buffer.from(jsonString).toString('base64');
-};
-
-export default class Client {
-    axiosClient = axios.create({
-        baseURL: 'https://www.speedrun.com/api/v2/',
-        headers: {
-            'Accept-Language': 'en',
-            '_': '',
-            'User-Agent': null
-        },
-        withCredentials: true,
-        transformRequest: [data => typeof data === 'string' ? data : JSON.stringify(data)]
-    });
-
-
-    async get<E extends keyof GETEndpoints, P extends GETEndpoints[E]>(endpoint: E, params: P, axiosConfig?: AxiosRequestConfig) {
-        return await this.axiosClient.get<Responses[E]>(`${endpoint}?_r=${objectToBase64(params)}`, axiosConfig);
-    }
-
-    async post<E extends keyof Endpoints, P extends Endpoints[E]>(endpoint: E, params: P, axiosConfig?: AxiosRequestConfig) {
-        return await this.axiosClient.post<E extends keyof Responses ? Responses[E] : void>(endpoint, params, axiosConfig);
-    }
-}