speedruncom.js 2.0.6 → 2.0.8

package/.github/workflows/publish.yml

@@ -1,30 +1,26 @@
-name: Publish
-
 on:
   push:
-    branches:
-      - main
-  workflow_dispatch:
+    tags:
+      - 'v*'
 
+permissions:
+  id-token: write
+  contents: read
+  
 jobs:
   publish:
-    name: Publish Package
     runs-on: ubuntu-latest
-
+    permissions:
+      contents: read
+      id-token: write
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
         with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          bun-version: latest
+      - run: bun i --frozen-lockfile
+      - run: bun run build
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+      - uses: JS-DevTools/npm-publish@v4

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

@@ -0,0 +1,20 @@
+{
+  "lockfileVersion": 1,
+  "configVersion": 0,
+  "workspaces": {
+    "": {
+      "name": "speedruncom.js",
+      "devDependencies": {
+        "@types/node": "^25.9.3",
+        "typescript": "^6.0.3",
+      },
+    },
+  },
+  "packages": {
+    "@types/node": ["@types/node@25.9.3", "", { "dependencies": { "undici-types": ">=7.24.0 <7.24.7" } }, "sha512-603BddQMv3pUcr4U2dhujk83N2tTDVr/34wII2B6bJy6g+8WD6yUb11jszNs0gdi4PesVWl7ABt8nYMVpnLUcg=="],
+
+    "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
+
+    "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';