speedruncom.js 1.1.0 → 1.2.1

package/dist/BaseClient.d.ts

@@ -1,15 +1,24 @@
 import { AxiosInstance } from 'axios';
+interface config {
+    PHPSESSID?: string;
+    userAgent?: string;
+}
 export default class Client {
+    /**
+     * `AxiosInstance` used on instance-called methods (called with `POST`).
+     */
     axiosClient: AxiosInstance;
+    /**
+     * `AxiosInstance` used on Client-called methods (called with `GET`).
+     */
     static axiosClient: AxiosInstance;
-    user: string;
-    pass: string;
-    constructor({ PHPSESSID, userAgent }: {
-        PHPSESSID?: string;
-        userAgent?: string;
-    });
-    request<T>(endpoint: string, params?: object, method?: string): Promise<T>;
-    static request<T>(endpoint: string, params?: object, method?: string): Promise<T>;
+    private username;
+    private password;
+    private headers;
+    constructor(config?: config);
+    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.
@@ -25,3 +34,4 @@ export default class Client {
      */
     logout(): Promise<unknown>;
 }
+export {};

package/dist/BaseClient.js

@@ -1,7 +1,10 @@
 import axios from 'axios';
-const LANG = 'en';
-const ACCEPT = 'application/json';
-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',
+    'Accept': 'application/json'
+};
 const isBrowser = typeof window !== 'undefined';
 const objectToBase64 = (obj) => {
     const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
@@ -15,57 +18,45 @@ class APIError extends Error {
     }
 }
 class Client {
-    constructor({ PHPSESSID, userAgent }) {
+    constructor(config) {
+        /**
+         * `AxiosInstance` used on instance-called methods (called with `POST`).
+         */
         this.axiosClient = axios.create({
-            baseURL: 'https://www.speedrun.com/api/v2/',
+            baseURL: BASE_URL,
+            method: 'POST',
             withCredentials: true,
-            headers: {
-                'Accept-Language': LANG,
-                'Accept': ACCEPT,
-            }
+            headers: HEADERS
+        });
+        this.headers = this.axiosClient.defaults.headers.common;
+        if (config)
+            this.config(config);
+        this.axiosClient.interceptors.response.use((response) => response, (error) => {
+            const data = error.response.data;
+            throw new APIError(data.error || 'Unknown error', error.response.status);
         });
+    }
+    config(config) {
         if (!isBrowser)
-            this.axiosClient.defaults.headers.common['User-Agent'] = BASE_USER_AGENT + (userAgent ? `/${userAgent}` : '');
-        if (PHPSESSID) {
+            this.headers['User-Agent'] = BASE_USER_AGENT + (config.userAgent ? `/${config.userAgent}` : '');
+        if (config.PHPSESSID) {
             if (isBrowser) {
                 console.error('You cannot use a PHPSESSID to authenticate in a browser environment.');
             }
             else {
-                this.axiosClient.defaults.headers.common['Cookie'] = `PHPSESSID=${PHPSESSID}`;
+                this.headers['Cookie'] = `PHPSESSID=${config.PHPSESSID}`;
             }
         }
-        this.axiosClient.interceptors.response.use((response) => response, (error) => {
-            if (error.response) {
-                const data = error.response?.data;
-                throw new APIError(data?.error || 'Unknown error', error.response.status);
-            }
-        });
     }
-    async request(endpoint, params = {}, method = 'post') {
-        let response;
-        if (method === 'post') {
-            response = await this.axiosClient.post(endpoint, params);
-        }
-        else {
-            response = await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`);
-        }
+    async request(endpoint, params = {}) {
+        const response = await this.axiosClient.post(endpoint, params);
         const cookie = response.headers['set-cookie'];
         if (cookie && !isBrowser)
-            this.axiosClient.defaults.headers.common['Cookie'] = `PHPSESSID=${cookie[0].split('=')[1].split(';')[0]}`;
+            this.headers['Cookie'] = cookie[0].split(';')[0];
         return response.data;
     }
-    static async request(endpoint, params = {}, method = 'post') {
-        let response;
-        if (method === 'post') {
-            response = await this.axiosClient.post(endpoint, params);
-        }
-        else {
-            response = await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`);
-        }
-        const cookie = response.headers['set-cookie'];
-        if (cookie && !isBrowser)
-            this.axiosClient.defaults.headers.common['Cookie'] = `PHPSESSID=${cookie[0].split('=')[1].split(';')[0]}`;
-        return response.data;
+    static async request(endpoint, params = {}) {
+        return (await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`)).data;
     }
     //Built-in endpoints for auth
     /**
@@ -73,8 +64,8 @@ class Client {
      * 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.user = username;
-        this.pass = password;
+        this.username = username;
+        this.password = password;
         return await this.request('PutAuthLogin', {
             name: username,
             password
@@ -86,8 +77,8 @@ class Client {
      */
     async setToken(token) {
         return await this.request('PutAuthLogin', {
-            name: this.user,
-            password: this.pass,
+            name: this.username,
+            password: this.password,
             token
         });
     }
@@ -97,14 +88,15 @@ class Client {
     async logout() {
         if (isBrowser)
             return await this.request('PutAuthLogout');
-        delete this.axiosClient.defaults.headers.common['Cookie'];
+        delete this.headers['Cookie'];
     }
 }
+/**
+ * `AxiosInstance` used on Client-called methods (called with `GET`).
+ */
 Client.axiosClient = axios.create({
-    baseURL: 'https://www.speedrun.com/api/v2/',
-    headers: {
-        'Accept-Language': LANG,
-        'Accept': ACCEPT,
-    }
+    baseURL: BASE_URL,
+    method: 'GET',
+    headers: HEADERS
 });
 export default Client;